ImportProjectsWizardPage.java

/*******************************************************************************
 * Copyright (c) 2004, 2010 BREDEX GmbH.
 * 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:
 *     BREDEX GmbH - initial API and implementation and/or initial documentation
 *******************************************************************************/
package org.eclipse.jubula.client.ui.rcp.wizards.pages;

import java.io.File;
import java.io.IOException;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.ArrayList;
import java.util.Arrays;

import org.eclipse.jface.dialogs.Dialog;
import org.eclipse.jface.wizard.WizardPage;
import org.eclipse.jubula.client.ui.constants.ContextHelpIds;
import org.eclipse.jubula.client.ui.constants.IconConstants;
import org.eclipse.jubula.client.ui.rcp.Plugin;
import org.eclipse.jubula.client.ui.rcp.businessprocess.ImportFileBP.IProjectImportInfoProvider;
import org.eclipse.jubula.client.ui.rcp.handlers.project.ExportProjectHandler;
import org.eclipse.jubula.client.ui.rcp.i18n.Messages;
import org.eclipse.jubula.client.ui.rcp.provider.ControlDecorator;
import org.eclipse.jubula.client.ui.rcp.utils.Utils;
import org.eclipse.jubula.client.ui.utils.DialogUtils;
import org.eclipse.jubula.client.ui.utils.LayoutUtil;
import org.eclipse.jubula.tools.internal.constants.StringConstants;
import org.eclipse.jubula.tools.internal.i18n.I18n;
import org.eclipse.osgi.util.NLS;
import org.eclipse.swt.SWT;
import org.eclipse.swt.events.KeyAdapter;
import org.eclipse.swt.events.KeyEvent;
import org.eclipse.swt.events.ModifyEvent;
import org.eclipse.swt.events.ModifyListener;
import org.eclipse.swt.events.SelectionAdapter;
import org.eclipse.swt.events.SelectionEvent;
import org.eclipse.swt.events.SelectionListener;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Button;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Event;
import org.eclipse.swt.widgets.FileDialog;
import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.widgets.List;
import org.eclipse.swt.widgets.Listener;
import org.eclipse.swt.widgets.Text;
import org.eclipse.ui.PlatformUI;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;


/**
 * @author BREDEX GmbH
 * @created May 19, 2010
 */
public class ImportProjectsWizardPage extends WizardPage 
        implements IProjectImportInfoProvider {

    /** the logger */
    private static Logger log = 
        LoggerFactory.getLogger(ImportProjectsWizardPage.class);

    /** number of colums in GridLayout */
    private static final int NUM_COLUMS = 6; 

    /** TextField for FilePath */
    private Text m_fileToAdd;
    /** All files that will be imported */
    private List m_filesToImport;
    /** button to browse for file */
    private Button m_browseButton; 
    /** button to add the currently typed file to the import list */
    private Button m_addButton; 
    /** remove button */
    private Button m_removeButton;
    /** move up button */
    private Button m_moveUpButton;
    /** move down button */
    private Button m_moveDownButton;
    /** open project checkbox */
    private Button m_openProjectCheckbox;
    /** The status of m_openProjectCheckbox */
    private boolean m_isOpenProject;
    /** fileNames */
    private java.util.List<URL> m_fileURLs; 
    
    /**
     * Constructor
     * 
     * @param pageName The name of the page.
     */
    public ImportProjectsWizardPage(String pageName) {
        super(pageName);
    }

    /**
     * @param fileName the user defined filename
     */
    protected void handleFile(String fileName) {
        if (fileName != null && fileName.length() > 0) {
            File file = new File(fileName);
            if (file.exists() && file.isFile() && file.canRead()) {
                m_addButton.setEnabled(true);
                setErrorMessage(null);
            } else {
                setErrorMessage(NLS.bind(
                        Messages.ImportProjectDialogInvalidFile,
                        new Object[] { fileName }));
                m_addButton.setEnabled(false);
            }
        } else {
            setErrorMessage(null);
            m_addButton.setEnabled(false);
        }
    }

    /**
     * @param parent parent composite
     */
    private void addFileButtonComposite(Composite parent) {
        GridData gridData;
        GridLayout layout;
        Composite fileButtonComposite = new Composite(parent, SWT.NONE);
        layout = new GridLayout();
        layout.numColumns = 2;
        layout.makeColumnsEqualWidth = true;
        fileButtonComposite.setLayout(layout);
        gridData = new GridData(GridData.FILL_HORIZONTAL);
        gridData.horizontalSpan = 2;
        gridData.grabExcessHorizontalSpace = true;
        fileButtonComposite.setLayoutData(gridData);
        
        addBrowseButton(fileButtonComposite);
        addAddButton(fileButtonComposite);
    }

    /**
     * Adds all checkboxes and radio buttons at the bottom of the dialog.
     * 
     * @param parent parent composite
     */
    private void addButtons(Composite parent) {
        GridData gridData;
        m_openProjectCheckbox = new Button(parent, SWT.CHECK);
        m_openProjectCheckbox.setSelection(true);
        m_isOpenProject = true;
        m_openProjectCheckbox.addSelectionListener(new SelectionListener() {
            public void widgetSelected(SelectionEvent arg0) {
                m_isOpenProject = m_openProjectCheckbox.getSelection();
            }
            
            public void widgetDefaultSelected(SelectionEvent arg0) {
                m_isOpenProject = m_openProjectCheckbox.getSelection();
            }
        });
        gridData = new GridData(GridData.FILL_HORIZONTAL);
        gridData.horizontalSpan = NUM_COLUMS;
        gridData.grabExcessHorizontalSpace = true;
        m_openProjectCheckbox.setLayoutData(gridData);
        m_openProjectCheckbox.setText(Messages
                .ImportProjectDialogOpenProjectCheckbox);
        DialogUtils.setWidgetName(m_openProjectCheckbox, "openProjectCheckbox"); //$NON-NLS-1$

    }

    /**
     * adds the list of projects to import
     * 
     * @param parent parent composite
     */
    private void addImportList(Composite parent) {
        GridData gridData;
        m_filesToImport = new List(parent, 
            SWT.MULTI | SWT.BORDER | SWT.V_SCROLL | SWT.H_SCROLL);
        gridData = new GridData();
        gridData.horizontalSpan = 5;
        gridData.horizontalAlignment = GridData.FILL;
        gridData.verticalAlignment = GridData.FILL;
        gridData.grabExcessVerticalSpace = true;
        gridData.grabExcessHorizontalSpace = true;
        gridData.heightHint = Dialog.convertHeightInCharsToPixels(
            LayoutUtil.getFontMetrics(m_filesToImport), 6);

        m_filesToImport.setLayoutData(gridData);
        m_filesToImport.addSelectionListener(new SelectionAdapter() {

            public void widgetSelected(SelectionEvent e) {
                checkListButtonEnablement();
            }
            
        });
        m_filesToImport.addKeyListener(new KeyAdapter() {

            public void keyReleased(KeyEvent e) {
                if (e.character == SWT.DEL) {
                    removeIndicesFromList(
                        m_filesToImport.getSelectionIndices());
                }
            }
            
        });
        
        m_filesToImport.addListener(SWT.Show, new Listener() {

            public void handleEvent(Event event) {
                checkCompletness();
            }
            
        });
        
        DialogUtils.setWidgetName(m_filesToImport, "filesToImport"); //$NON-NLS-1$
    }

    /**
     * adds the buttons for the import projects list
     * 
     * @param parent parent composite
     */
    private void addListButtons(Composite parent) {
        Composite composite = new Composite(parent, SWT.NONE);
        GridData gridData;
        gridData = new GridData();
        gridData.horizontalSpan = 1;
        gridData.grabExcessHorizontalSpace = false;
        composite.setLayoutData(gridData);
        
        GridLayout layout = new GridLayout();
        layout.numColumns = 1;
        layout.makeColumnsEqualWidth = true;
        composite.setLayout(layout);
        
        addUpButton(composite);
        addDownButton(composite);
        addRemoveButton(composite);
        
    }

    /**
     * @param parent parent composite
     */
    private void addRemoveButton(Composite parent) {
        GridData gridData;
        m_removeButton = new Button(parent, SWT.PUSH);
        m_removeButton.setImage(IconConstants.DELETE_IMAGE_DISABLED);
        m_removeButton.setToolTipText(
            Messages.ImportProjectDialogRemoveToolTip);
        gridData = new GridData();
        gridData.horizontalSpan = 1;
        gridData.grabExcessHorizontalSpace = false;
        m_removeButton.setLayoutData(gridData);
        m_removeButton.setEnabled(false);
        m_removeButton.addSelectionListener(new SelectionAdapter() {

            public void widgetSelected(SelectionEvent e) {
                removeIndicesFromList(m_filesToImport.getSelectionIndices());
            }
            
        });

        DialogUtils.setWidgetName(m_removeButton, "removeButton"); //$NON-NLS-1$
    }

    /**
     * @param parent parent composite
     */
    private void addDownButton(Composite parent) {
        GridData gridData;
        m_moveDownButton = new Button(parent, SWT.PUSH);
        m_moveDownButton.setImage(IconConstants.DOWN_ARROW_DIS_IMAGE);
        m_moveDownButton.setToolTipText(
            Messages.ImportProjectDialogMoveDownToolTip);
        gridData = new GridData();
        gridData.horizontalSpan = 1;
        gridData.grabExcessHorizontalSpace = false;
        m_moveDownButton.setLayoutData(gridData);
        m_moveDownButton.setEnabled(false);
        m_moveDownButton.addSelectionListener(new SelectionAdapter() {

            public void widgetSelected(SelectionEvent e) {
                int [] selectedIndices = m_filesToImport.getSelectionIndices();
                Arrays.sort(selectedIndices);
                int [] newSelectedIndices = new int [selectedIndices.length];
                int greatestIndex = m_filesToImport.getItemCount() - 1;
                if (selectedIndices.length > 0 
                    && selectedIndices[selectedIndices.length - 1] 
                                       < greatestIndex) {
                    
                    for (int i = 0; i < selectedIndices.length; i++) {
                        int index = selectedIndices[i];
                        int newIndex = index + 1;
                        String item = m_filesToImport.getItem(index);
                        m_filesToImport.remove(index);
                        m_filesToImport.add(item, newIndex);
                        newSelectedIndices[i] = newIndex;
                    }
                    m_filesToImport.setSelection(newSelectedIndices);
                }
                updateModel();
            }
            
        });
        
        DialogUtils.setWidgetName(m_moveDownButton, "moveDownButton"); //$NON-NLS-1$
    }

    /**
     * @param parent parent composite
     */
    private void addUpButton(Composite parent) {
        GridData gridData;
        m_moveUpButton = new Button(parent, SWT.PUSH);
        m_moveUpButton.setImage(IconConstants.UP_ARROW_DIS_IMAGE);
        m_moveUpButton.setToolTipText(
            Messages.ImportProjectDialogMoveUpToolTip);
        gridData = new GridData();
        gridData.horizontalSpan = 1;
        gridData.grabExcessHorizontalSpace = false;
        m_moveUpButton.setLayoutData(gridData);
        m_moveUpButton.setEnabled(false);
        m_moveUpButton.addSelectionListener(new SelectionAdapter() {

            public void widgetSelected(SelectionEvent e) {
                int [] selectedIndices = m_filesToImport.getSelectionIndices();
                Arrays.sort(selectedIndices);
                int [] newSelectedIndices = new int [selectedIndices.length];
                if (selectedIndices.length > 0 && selectedIndices[0] > 0) {
                    for (int i = 0; i < selectedIndices.length; i++) {
                        int index = selectedIndices[i];
                        int newIndex = index - 1;
                        String item = m_filesToImport.getItem(index);
                        m_filesToImport.remove(index);
                        m_filesToImport.add(item, newIndex);
                        newSelectedIndices[i] = newIndex;
                    }
                    m_filesToImport.setSelection(newSelectedIndices);
                }
                updateModel();
            }
            
        });
        
        DialogUtils.setWidgetName(m_moveUpButton, "moveUpButton"); //$NON-NLS-1$
    }

    /**
     * Adds the given file names to the list of files to import.
     * 
     * @param fileNames The file names to add to the list.
     */
    private void addFilesToList(String [] fileNames) {
        String [] items = m_filesToImport.getItems();
        for (String selectedFile : fileNames) {
            boolean isAlreadyInList = false;
            for (String curItem : items) {
                if (curItem.equals(selectedFile)) {
                    isAlreadyInList = true;
                    break;
                }
            }
            
            if (!isAlreadyInList) {
                m_filesToImport.add(selectedFile);
            }
        }

        checkCompletness();
    }
    
    /**
     * Removes the items at the given indices from the list of files to import.
     * 
     * @param indices The indices of the items to remove from the list.
     */
    private void removeIndicesFromList(int [] indices) {
        m_filesToImport.remove(indices);
        Event selectionEvent = new Event();
        selectionEvent.type = SWT.Selection;
        selectionEvent.widget = m_filesToImport;
        selectionEvent.display = m_filesToImport.getDisplay();
        m_filesToImport.notifyListeners(SWT.Selection, selectionEvent);
        checkCompletness();
    }
    
    /**
     * checks if all is complete
     *
     */
    void checkCompletness() {
        updateModel();
        
        m_isOpenProject = m_openProjectCheckbox.getSelection();

        if (m_fileURLs.size() < 1) {
            setErrorMessage(Messages.ImportProjectDialogNoFilesToImport);
            setPageComplete(false);
        } else {
            setErrorMessage(null);
            setPageComplete(true);
        }
        
        m_openProjectCheckbox.setEnabled(m_filesToImport.getItemCount() <= 1);
        if (!m_openProjectCheckbox.isEnabled()) {
            m_openProjectCheckbox.setSelection(false);
            m_isOpenProject = false;
        }

        handleFile(m_fileToAdd.getText());
    }
    
    /**
     * adds the browse button
     * @param composite parent composite
     */
    private void addBrowseButton(Composite composite) {
        GridData gridData;
        m_browseButton = new Button(composite, SWT.NONE);
        gridData = new GridData();
        gridData.horizontalSpan = 1;
        gridData.grabExcessHorizontalSpace = false;
        m_browseButton.setLayoutData(gridData);
        m_browseButton.setText(Messages.ImportProjectDialogBrowse);
        m_browseButton.addSelectionListener(new SelectionAdapter() {
            public void widgetSelected(SelectionEvent e) {
                FileDialog fileDialog = new FileDialog(getShell(), 
                        SWT.OPEN | SWT.APPLICATION_MODAL | SWT.MULTI);
                String file;
                fileDialog.setText(Messages.ImportProjectDialogFileSelector);
                String[] extension = new String[]{
                    StringConstants.STAR + ExportProjectHandler.JUB,
                    StringConstants.STAR + ExportProjectHandler.XML};
                fileDialog.setFilterExtensions(extension);
                fileDialog.setFilterPath(Utils.getLastDirPath());
                file = fileDialog.open();
                getShell().setFocus();
                if (file != null) {
                    String path = fileDialog.getFilterPath();
                    String [] fileNames = fileDialog.getFileNames();
                    String [] absFileNames = new String [fileNames.length];
                    for (int i = 0; i < fileNames.length; i++) {
                        try {
                            absFileNames[i] = 
                                new File(path, fileNames[i]).getCanonicalPath();
                        } catch (IOException ioe) {
                            log.error(Messages.FailedToFindFile 
                                + StringConstants.COLON + StringConstants.SPACE
                                + path + File.pathSeparator + fileNames[i], 
                                ioe);
                        }
                    }
                    addFilesToList(absFileNames);
                    Utils.storeLastDirPath(path);
                }
            }
        });
        DialogUtils.setWidgetName(m_browseButton, "browseButton"); //$NON-NLS-1$
    }

    /**
     * adds the add button
     * @param parent parent composite
     */
    private void addAddButton(Composite parent) {
        GridData gridData;
        m_addButton = new Button(parent, SWT.NONE);
        gridData = new GridData();
        gridData.horizontalSpan = 1;
        gridData.grabExcessHorizontalSpace = false;
        m_addButton.setLayoutData(gridData);
        m_addButton.setText(Messages.ImportProjectDialogAdd);
        m_addButton.setEnabled(false);
        m_addButton.addSelectionListener(new SelectionAdapter() {

            public void widgetSelected(SelectionEvent e) {
                
                try {
                    addFilesToList(new String [] {
                        new File(m_fileToAdd.getText()).getCanonicalPath()
                    });
                } catch (IOException ioe) {
                    log.error(Messages.FailedToFindFile + StringConstants.COLON
                        + StringConstants.SPACE + m_fileToAdd.getText(), ioe);
                }
            }
            
        });
        DialogUtils.setWidgetName(m_addButton, "addButton"); //$NON-NLS-1$
    }

    /**
     * adds a blank Line 
     * @param composite parent composite
     */
    private void addBlankLine(Composite composite) {
        GridData gridData;
        gridData = new GridData(GridData.FILL_HORIZONTAL);
        gridData.horizontalSpan = NUM_COLUMS;
        gridData.grabExcessHorizontalSpace = true;
        Label label = new Label(composite, SWT.NONE);
        label.setLayoutData(gridData);
    }

    /**
     * 
     * {@inheritDoc}
     */
    public java.util.List<URL> getFileURLs() {
        return m_fileURLs;
    }

    /**
     * 
     * {@inheritDoc}
     */
    public boolean getIsOpenProject() {
        return m_isOpenProject;
    }

    /**
     * Sets the enablement for the button.
     * 
     * @param enabled <code>true</code> to enable the button, <code>false</code>
     *               to disable it.
     */
    private void enableUpButton(boolean enabled) {
        m_moveUpButton.setEnabled(enabled);
        if (enabled) {
            m_moveUpButton.setImage(IconConstants.UP_ARROW_IMAGE);
        } else {
            m_moveUpButton.setImage(IconConstants.UP_ARROW_DIS_IMAGE);
        }
    }

    /**
     * Sets the enablement for the button.
     * 
     * @param enabled <code>true</code> to enable the button, <code>false</code>
     *               to disable it.
     */
    private void enableDownButton(boolean enabled) {
        m_moveDownButton.setEnabled(enabled);
        if (enabled) {
            m_moveDownButton.setImage(IconConstants.DOWN_ARROW_IMAGE);
        } else {
            m_moveDownButton.setImage(IconConstants.DOWN_ARROW_DIS_IMAGE);
        }
    }
    
    /**
     * Sets the enablement for the button.
     * 
     * @param enabled <code>true</code> to enable the button, <code>false</code>
     *               to disable it.
     */
    private void enableRemoveButton(boolean enabled) {
        m_removeButton.setEnabled(enabled);
        if (enabled) {
            m_removeButton.setImage(IconConstants.DELETE_IMAGE);
        } else {
            m_removeButton.setImage(IconConstants.DELETE_IMAGE_DISABLED);
        }
    }
    
    /**
     * Checks the enablement criteria for list buttons and sets their 
     * enablement.
     *
     */
    private void checkListButtonEnablement() {
        if (m_filesToImport.getSelectionCount() > 0) {
            enableUpButton(true);
            enableDownButton(true);
            enableRemoveButton(true);
        } else {
            enableUpButton(false);
            enableDownButton(false);
            enableRemoveButton(false);
        }
    }

    /**
     * {@inheritDoc}
     */
    public void createControl(Composite parent) {
        final String title = Messages.ImportProjectDialogTitle;
        setTitle(title);
        setImageDescriptor(IconConstants.IMPORT_DIALOG_IMAGE_DESCRIPTOR);
        setMessage(Messages.ImportProjectDialogMessage); 
        
        Composite composite = new Composite(parent, SWT.NONE);
        GridData gridData;
        GridLayout layout = new GridLayout();
        layout.numColumns = NUM_COLUMS;
        layout.makeColumnsEqualWidth = true;
        composite.setLayout(layout);
        
        Label label = new Label(composite, SWT.NONE);
        gridData = new GridData(GridData.FILL_HORIZONTAL);
        gridData.horizontalSpan = NUM_COLUMS;
        gridData.grabExcessHorizontalSpace = true;
        label.setLayoutData(gridData);
        label.setText(Messages.ImportProjectDialogFileLabel);
        
        m_fileToAdd = new Text(composite, SWT.BORDER);
        gridData = new GridData(GridData.FILL_HORIZONTAL);
        gridData.horizontalSpan = 4;
        gridData.grabExcessHorizontalSpace = true;
        m_fileToAdd.setLayoutData(gridData);
        m_fileToAdd.addModifyListener(new ModifyListener() {
            public void modifyText(ModifyEvent e) {
                String fileName = m_fileToAdd.getText();
                handleFile(fileName);
            }
        });
        DialogUtils.setWidgetName(m_fileToAdd, "fileToAdd"); //$NON-NLS-1$

        addFileButtonComposite(composite);
        addBlankLine(composite);

        Label listLabel = new Label(composite, SWT.NONE);
        listLabel.setText(Messages.ImportProjectDialogListLabel);
        gridData = new GridData(GridData.FILL_HORIZONTAL);
        gridData.horizontalSpan = NUM_COLUMS;
        gridData.grabExcessHorizontalSpace = false;
        gridData.horizontalAlignment = SWT.LEFT;
        listLabel.setLayoutData(gridData);
        ControlDecorator.createInfo(listLabel, 
                I18n.getString("ControlDecorator.Import"), false); //$NON-NLS-1$
        
        addImportList(composite);
        addListButtons(composite);

        addBlankLine(composite);
        
        addButtons(composite);
        
        Plugin.getHelpSystem().setHelp(composite, ContextHelpIds
                .IMPORT_PROJECT_DIALOG);
        setPageComplete(false);
        setControl(composite);
    }
    
    /**
     * Updates the model so that m_fileURLs has the same data and same order as
     * the m_filesToImport SWT list
     */
    private void updateModel() {
        // Update model values
        String[] fileNames = m_filesToImport.getItems();
        m_fileURLs = new ArrayList<URL>(fileNames.length);

        for (String fileName : fileNames) {
            try {
                m_fileURLs.add(new File(fileName).toURI().toURL());
            } catch (MalformedURLException e) {
                log.error(e.getLocalizedMessage(), e);
            }
        }
    }
    
    /**
     * {@inheritDoc}
     */
    public void performHelp() {
        PlatformUI.getWorkbench().getHelpSystem().displayHelp(
                ContextHelpIds.IMPORT_PROJECT_DIALOG);
    }
}