path: root/src/net/java/sip/communicator/plugin/sipaccregwizz/FirstWizardPage.java

/*
 * SIP Communicator, the OpenSource Java VoIP and Instant Messaging client.
 *
 * Distributable under LGPL license. See terms of license at gnu.org.
 */
package net.java.sip.communicator.plugin.sipaccregwizz;

import java.awt.*;
import java.awt.event.*;
import javax.swing.*;
import javax.swing.event.*;

import net.java.sip.communicator.service.gui.*;
import net.java.sip.communicator.service.protocol.*;
import net.java.sip.communicator.util.swing.*;

/**
 * The <tt>FirstWizardPage</tt> is the page, where user could enter the uin
 * and the password of the account.
 *
 * @author Yana Stamcheva
 * @author Damian Minkov
 */
@SuppressWarnings("serial")
public class FirstWizardPage
    extends TransparentPanel
    implements WizardPage, DocumentListener, ItemListener
{
    public static final String FIRST_PAGE_IDENTIFIER = "FirstPageIdentifier";

    public static final String USER_NAME_EXAMPLE
        = "Ex: john@voiphone.net or simply \"john\" for no server";

    private JPanel firstTabPanel = new TransparentPanel(new BorderLayout());

    private JPanel uinPassPanel = new TransparentPanel(new BorderLayout(10, 10));

    private JPanel labelsPanel = new TransparentPanel();

    private JPanel valuesPanel = new TransparentPanel();
    
    private JLabel uinLabel
        = new JLabel(Resources.getString("plugin.sipaccregwizz.USERNAME"));

    private JLabel passLabel
        = new JLabel(Resources.getString("service.gui.PASSWORD"));

    private JPanel emptyPanel = new TransparentPanel();

    private JLabel uinExampleLabel = new JLabel(USER_NAME_EXAMPLE);

    private JLabel existingAccountLabel =
        new JLabel(Resources.getString("service.gui.EXISTING_ACCOUNT_ERROR"));

    private JTextField uinField = new JTextField();

    private JPasswordField passField = new JPasswordField();

    private JCheckBox rememberPassBox =
        new SIPCommCheckBox(
            Resources.getString("service.gui.REMEMBER_PASSWORD"));

    private JPanel advancedOpPanel
        = new TransparentPanel(new BorderLayout(10, 10));

    private JPanel labelsAdvOpPanel
        = new TransparentPanel(new GridLayout(0, 1, 10, 10));

    private JPanel valuesAdvOpPanel
        = new TransparentPanel(new GridLayout(0, 1, 10, 10));

    private JCheckBox enableAdvOpButton =
        new SIPCommCheckBox(Resources.getString(
            "plugin.sipaccregwizz.OVERRIDE_SERVER_DEFAULT_OPTIONS"), false);

    private JLabel serverLabel
        = new JLabel(Resources.getString("plugin.sipaccregwizz.REGISTRAR"));

    private JCheckBox enableDefaultEncryption =
        new SIPCommCheckBox(Resources
            .getString("plugin.sipaccregwizz.ENABLE_DEFAULT_ENCRYPTION"), true); 

    private JLabel proxyLabel
        = new JLabel(Resources.getString("plugin.sipaccregwizz.PROXY"));

    private JLabel serverPortLabel =
        new JLabel(Resources.getString("plugin.sipaccregwizz.SERVER_PORT"));

    private JLabel proxyPortLabel =
        new JLabel(Resources.getString("plugin.sipaccregwizz.PROXY_PORT"));

    private JLabel transportLabel =
        new JLabel(Resources.getString(
            "plugin.sipaccregwizz.PREFERRED_TRANSPORT"));

    private JTextField serverField = new JTextField();

    private JTextField proxyField = new JTextField();

    private JTextField serverPortField
        = new JTextField(SIPAccountRegistration.DEFAULT_PORT);

    private JTextField proxyPortField
        = new JTextField(SIPAccountRegistration.DEFAULT_PORT);

    private JComboBox transportCombo = new JComboBox(new Object[]
    { "UDP", "TCP", "TLS" });

    private JPanel presenceOpPanel = new TransparentPanel(new BorderLayout(10, 10));

    private JPanel buttonsPresOpPanel =
        new TransparentPanel(new GridLayout(0, 1, 10, 10));

    private JPanel labelsPresOpPanel = new TransparentPanel(new GridLayout(0, 1, 10, 10));

    private JPanel valuesPresOpPanel = new TransparentPanel(new GridLayout(0, 1, 10, 10));

    private JCheckBox enablePresOpButton =
        new SIPCommCheckBox(Resources
            .getString("plugin.sipaccregwizz.ENABLE_PRESENCE"), true);

    private JCheckBox forceP2PPresOpButton =
        new SIPCommCheckBox(Resources
            .getString("plugin.sipaccregwizz.FORCE_P2P_PRESENCE"), true);

    private JLabel pollPeriodLabel = new JLabel(
        Resources.getString("plugin.sipaccregwizz.OFFLINE_CONTACT_POLLING_PERIOD"));

    private JLabel subscribeExpiresLabel = new JLabel(
        Resources.getString("plugin.sipaccregwizz.SUBSCRIPTION_EXPIRATION"));

    private JTextField pollPeriodField
        = new JTextField(SIPAccountRegistration.DEFAULT_POLL_PERIOD);

    private JTextField subscribeExpiresField =
        new JTextField(SIPAccountRegistration.DEFAULT_SUBSCRIBE_EXPIRES);

    private JPanel keepAlivePanel = new TransparentPanel(new BorderLayout(10, 10));

    private JPanel keepAliveLabels = new TransparentPanel(new GridLayout(0, 1, 5, 5));

    private JPanel keepAliveValues = new TransparentPanel(new GridLayout(0, 1, 5, 5));

    private JLabel keepAliveMethodLabel = new JLabel(
        Resources.getString("plugin.sipaccregwizz.KEEP_ALIVE_METHOD"));

    private JLabel keepAliveIntervalLabel = new JLabel(
        Resources.getString("plugin.sipaccregwizz.KEEP_ALIVE_INTERVAL"));

    private JLabel keepAliveIntervalExampleLabel = new JLabel(
        Resources.getString("plugin.sipaccregwizz.KEEP_ALIVE_INTERVAL_INFO"));

    private JComboBox keepAliveMethodBox
        = new JComboBox(new Object []
                                    {
                                        "REGISTER",
                                        "OPTIONS"
                                    });

    private JTextField keepAliveIntervalValue = new JTextField();

    private JTabbedPane tabbedPane = new SIPCommTabbedPane(false, false);

    private JPanel advancedPanel = new TransparentPanel();

    private Object nextPageIdentifier = WizardPage.SUMMARY_PAGE_IDENTIFIER;

    private SIPAccountRegistrationWizard wizard;

    private boolean isCommitted = false;

    /**
     * Creates an instance of <tt>FirstWizardPage</tt>.
     *
     * @param wizard the parent wizard
     */
    public FirstWizardPage(SIPAccountRegistrationWizard wizard)
    {
        super(new BorderLayout());

        this.wizard = wizard;

        advancedPanel.setLayout(new BoxLayout(advancedPanel, BoxLayout.Y_AXIS));

        this.init();

        this.setBorder(BorderFactory.createEmptyBorder(10, 10, 10, 10));

        this.labelsPanel
            .setLayout(new BoxLayout(labelsPanel, BoxLayout.Y_AXIS));

        this.valuesPanel
            .setLayout(new BoxLayout(valuesPanel, BoxLayout.Y_AXIS));
    }

    /**
     * Initializes all panels, buttons, etc.
     */
    private void init()
    {
        this.labelsPanel.setOpaque(false);
        this.valuesPanel.setOpaque(false);
        this.uinPassPanel.setOpaque(false);
        this.emptyPanel.setOpaque(false);

        this.uinField.getDocument().addDocumentListener(this);
        this.transportCombo.addItemListener(this);
        this.rememberPassBox.setSelected(true);

        existingAccountLabel.setForeground(Color.RED);

        this.uinExampleLabel.setForeground(Color.GRAY);
        this.uinExampleLabel.setFont(uinExampleLabel.getFont().deriveFont(8));
        this.emptyPanel.setMaximumSize(new Dimension(40, 35));
        this.uinExampleLabel.setBorder(BorderFactory.createEmptyBorder(0, 0, 8,
            0));

        labelsPanel.add(uinLabel);
        labelsPanel.add(emptyPanel);
        labelsPanel.add(passLabel);

        valuesPanel.add(uinField);
        valuesPanel.add(uinExampleLabel);
        valuesPanel.add(passField);

        uinPassPanel.add(labelsPanel, BorderLayout.WEST);
        uinPassPanel.add(valuesPanel, BorderLayout.CENTER);
        uinPassPanel.add(rememberPassBox, BorderLayout.SOUTH);

        uinPassPanel.setBorder(BorderFactory.createTitledBorder(Resources
            .getString("plugin.sipaccregwizz.USERNAME_AND_PASSWORD")));

        firstTabPanel.add(uinPassPanel, BorderLayout.NORTH);

        tabbedPane.addTab(  Resources.getString("service.gui.SUMMARY"),
                            firstTabPanel);

        serverField.setEnabled(false);
        serverPortField.setEnabled(false);
        proxyField.setEnabled(false);
        proxyPortField.setEnabled(false);
        transportCombo.setEnabled(false);

        enableAdvOpButton.addActionListener(new ActionListener()
        {
            public void actionPerformed(ActionEvent evt)
            {
                // Perform action
                JCheckBox cb = (JCheckBox) evt.getSource();

                if (!wizard.isModification())
                    serverField.setEnabled(cb.isSelected());

                serverPortField.setEnabled(cb.isSelected());
                proxyField.setEnabled(cb.isSelected());
                proxyPortField.setEnabled(cb.isSelected());
                transportCombo.setEnabled(cb.isSelected());
                
                if(!cb.isSelected())
                {
                    setServerFieldAccordingToUIN();

                    serverPortField
                        .setText(SIPAccountRegistration.DEFAULT_PORT);
                    proxyPortField
                        .setText(SIPAccountRegistration.DEFAULT_PORT);
                    transportCombo
                        .setSelectedItem(SIPAccountRegistration.DEFAULT_TRANSPORT);
                }
            }
        });

        transportCombo
            .setSelectedItem(SIPAccountRegistration.DEFAULT_TRANSPORT);

        labelsAdvOpPanel.add(serverLabel);
        labelsAdvOpPanel.add(serverPortLabel);
        labelsAdvOpPanel.add(proxyLabel);
        labelsAdvOpPanel.add(proxyPortLabel);
        labelsAdvOpPanel.add(transportLabel);

        valuesAdvOpPanel.add(serverField);
        valuesAdvOpPanel.add(serverPortField);
        valuesAdvOpPanel.add(proxyField);
        valuesAdvOpPanel.add(proxyPortField);
        valuesAdvOpPanel.add(transportCombo);

        advancedOpPanel.add(enableAdvOpButton, BorderLayout.NORTH);
        advancedOpPanel.add(labelsAdvOpPanel, BorderLayout.WEST);
        advancedOpPanel.add(valuesAdvOpPanel, BorderLayout.CENTER);
        advancedOpPanel.add(enableDefaultEncryption, BorderLayout.SOUTH);
        
        advancedOpPanel.setBorder(BorderFactory.createTitledBorder(Resources
            .getString("plugin.aimaccregwizz.ADVANCED_OPTIONS")));

        advancedPanel.add(advancedOpPanel);

        enablePresOpButton.addActionListener(new ActionListener()
        {
            public void actionPerformed(ActionEvent evt)
            {
                // Perform action
                JCheckBox cb = (JCheckBox) evt.getSource();

                forceP2PPresOpButton.setEnabled(cb.isSelected());
                pollPeriodField.setEnabled(cb.isSelected());
                subscribeExpiresField.setEnabled(cb.isSelected());
            }
        });

        labelsPresOpPanel.add(pollPeriodLabel);
        labelsPresOpPanel.add(subscribeExpiresLabel);

        valuesPresOpPanel.add(pollPeriodField);
        valuesPresOpPanel.add(subscribeExpiresField);

        buttonsPresOpPanel.add(enablePresOpButton);
        buttonsPresOpPanel.add(forceP2PPresOpButton);

        presenceOpPanel.add(buttonsPresOpPanel, BorderLayout.NORTH);
        presenceOpPanel.add(labelsPresOpPanel, BorderLayout.WEST);
        presenceOpPanel.add(valuesPresOpPanel, BorderLayout.CENTER);

        presenceOpPanel.setBorder(BorderFactory.createTitledBorder(
            Resources.getString("plugin.sipaccregwizz.PRESENCE_OPTIONS")));

        advancedPanel.add(presenceOpPanel);

        JPanel emptyLabelPanel = new TransparentPanel();
        emptyLabelPanel.setMaximumSize(new Dimension(40, 35));

        keepAliveLabels.add(keepAliveMethodLabel);
        keepAliveLabels.add(keepAliveIntervalLabel);
        keepAliveLabels.add(emptyLabelPanel);

        this.keepAliveIntervalExampleLabel.setForeground(Color.GRAY);
        this.keepAliveIntervalExampleLabel
            .setFont(uinExampleLabel.getFont().deriveFont(8));
        this.keepAliveIntervalExampleLabel
            .setMaximumSize(new Dimension(40, 35));
        this.keepAliveIntervalExampleLabel
            .setBorder(BorderFactory.createEmptyBorder(0, 0, 8, 0));

        keepAliveIntervalValue
            .setText(SIPAccountRegistration.DEFAULT_KEEP_ALIVE_INTERVAL);

        keepAliveMethodBox.setSelectedItem(
            SIPAccountRegistration.DEFAULT_KEEP_ALIVE_METHOD);

        keepAliveValues.add(keepAliveMethodBox);
        keepAliveValues.add(keepAliveIntervalValue);
        keepAliveValues.add(keepAliveIntervalExampleLabel);

        keepAlivePanel.add(keepAliveLabels, BorderLayout.WEST);
        keepAlivePanel.add(keepAliveValues, BorderLayout.CENTER);

        keepAlivePanel.setBorder(BorderFactory.createTitledBorder(
            Resources.getString("plugin.sipaccregwizz.KEEP_ALIVE")));

        advancedPanel.add(keepAlivePanel);

        tabbedPane.addTab(
            Resources.getString("service.gui.ADVANCED"),
            advancedPanel);

        this.add(tabbedPane, BorderLayout.NORTH);
    }

    /**
     * Implements the <code>WizardPage.getIdentifier</code> to return this
     * page identifier.
     */
    public Object getIdentifier()
    {
        return FIRST_PAGE_IDENTIFIER;
    }

    /**
     * Implements the <code>WizardPage.getNextPageIdentifier</code> to return
     * the next page identifier - the summary page.
     */
    public Object getNextPageIdentifier()
    {
        return nextPageIdentifier;
    }

    /**
     * Implements the <code>WizardPage.getBackPageIdentifier</code> to return
     * the next back identifier - the default page.
     */
    public Object getBackPageIdentifier()
    {
        return WizardPage.DEFAULT_PAGE_IDENTIFIER;
    }

    /**
     * Implements the <code>WizardPage.getWizardForm</code> to return this
     * panel.
     */
    public Object getWizardForm()
    {
        return this;
    }

    /**
     * Before this page is displayed enables or disables the "Next" wizard
     * button according to whether the UIN field is empty.
     */
    public void pageShowing()
    {
        this.setNextButtonAccordingToUIN();
        wizard.getWizardContainer().setBackButtonEnabled(false);
    }

    /**
     * Saves the user input when the "Next" wizard buttons is clicked.
     */
    public void commitPage()
    {
        String uin = uinField.getText();
        int indexOfSeparator = uin.indexOf('@');
        if (indexOfSeparator > -1) {
            uin = uin.substring(0, indexOfSeparator);
        }

        String server = serverField.getText();

        if (!wizard.isModification() && isExistingAccount(uin, server))
        {
            nextPageIdentifier = FIRST_PAGE_IDENTIFIER;
            uinPassPanel.add(existingAccountLabel, BorderLayout.NORTH);
            this.revalidate();
        }
        else
        {
            nextPageIdentifier = SUMMARY_PAGE_IDENTIFIER;
            uinPassPanel.remove(existingAccountLabel);

            SIPAccountRegistration registration = wizard.getRegistration();

            registration.setId(uinField.getText());

            if (passField.getPassword() != null)
                registration.setPassword(new String(passField.getPassword()));

            registration.setRememberPassword(rememberPassBox.isSelected());

            registration.setServerAddress(serverField.getText());
            registration.setServerPort(serverPortField.getText());
            registration.setProxy(proxyField.getText());
            registration.setProxyPort(proxyPortField.getText());
            registration.setPreferredTransport(transportCombo.getSelectedItem()
                .toString());

            registration.setEnablePresence(enablePresOpButton.isSelected());
            registration.setForceP2PMode(forceP2PPresOpButton.isSelected());
            registration.setDefaultEncryption(enableDefaultEncryption.isSelected()); 
            registration.setPollingPeriod(pollPeriodField.getText());
            registration.setSubscriptionExpiration(subscribeExpiresField
                .getText());
            registration.setKeepAliveMethod(
                keepAliveMethodBox.getSelectedItem().toString());
            registration.setKeepAliveInterval(keepAliveIntervalValue.getText());
        }
        wizard.getWizardContainer().setBackButtonEnabled(true);

        this.isCommitted = true;
    }

    /**
     * Enables or disables the "Next" wizard button according to whether the UIN
     * field is empty.
     */
    private void setNextButtonAccordingToUIN()
    {
        if (uinField.getText() == null || uinField.getText().equals(""))
        {
            wizard.getWizardContainer().setNextFinishButtonEnabled(false);
        }
        else
        {
            wizard.getWizardContainer().setNextFinishButtonEnabled(true);
        }
    }

    /**
     * Handles the <tt>DocumentEvent</tt> triggered when user types in the UIN
     * field. Enables or disables the "Next" wizard button according to whether
     * the UIN field is empty.
     */
    public void insertUpdate(DocumentEvent e)
    {
        this.setNextButtonAccordingToUIN();
        this.setServerFieldAccordingToUIN();
    }

    /**
     * Handles the <tt>DocumentEvent</tt> triggered when user deletes letters
     * from the UIN field. Enables or disables the "Next" wizard button
     * according to whether the UIN field is empty.
     */
    public void removeUpdate(DocumentEvent e)
    {
        this.setNextButtonAccordingToUIN();
        this.setServerFieldAccordingToUIN();
    }

    public void changedUpdate(DocumentEvent e)
    {
    }

    public void pageHiding()
    {
    }

    public void pageShown()
    {
    }

    public void pageBack()
    {
    }

    /**
     * Fills the UIN and Password fields in this panel with the data coming from
     * the given protocolProvider.
     *
     * @param protocolProvider The <tt>ProtocolProviderService</tt> to load
     *            the data from.
     */
    public void loadAccount(ProtocolProviderService protocolProvider)
    {
        AccountID accountID = protocolProvider.getAccountID();
        String password =
            (String) accountID.getAccountProperties().get(
                ProtocolProviderFactory.PASSWORD);

        String serverAddress =
            (String) accountID.getAccountProperties().get(
                ProtocolProviderFactory.SERVER_ADDRESS);

        String serverPort =
            (String) accountID.getAccountProperties().get(
                ProtocolProviderFactory.SERVER_PORT);

        String proxyAddress =
            (String) accountID.getAccountProperties().get(
                ProtocolProviderFactory.PROXY_ADDRESS);

        String proxyPort =
            (String) accountID.getAccountProperties().get(
                ProtocolProviderFactory.PROXY_PORT);

        String preferredTransport =
            (String) accountID.getAccountProperties().get(
                ProtocolProviderFactory.PREFERRED_TRANSPORT);

        boolean enablePresence = new Boolean(
            (String) accountID.getAccountProperties().get(
                ProtocolProviderFactory.IS_PRESENCE_ENABLED)).booleanValue();

        boolean forceP2P = new Boolean(
            (String) accountID.getAccountProperties().get(
                ProtocolProviderFactory.FORCE_P2P_MODE)).booleanValue();
        
        boolean enabledDefaultEncryption = new Boolean(
        	(String) accountID.getAccountProperties().get(
        		ProtocolProviderFactory.DEFAULT_ENCRYPTION)).booleanValue(); 

        String pollingPeriod =
            (String) accountID.getAccountProperties().get(
                ProtocolProviderFactory.POLLING_PERIOD);

        String subscriptionPeriod =
            (String) accountID.getAccountProperties().get(
                ProtocolProviderFactory.SUBSCRIPTION_EXPIRATION);

        String keepAliveMethod
            = (String) accountID.getAccountProperties()
                .get("KEEP_ALIVE_METHOD");

        String keepAliveInterval
            = (String) accountID.getAccountProperties()
                .get("KEEP_ALIVE_INTERVAL");

        uinField.setEnabled(false);
        this.uinField.setText((serverAddress == null) ? accountID.getUserID()
            : (accountID.getUserID() + "@" + serverAddress));

        if (password != null)
        {
            this.passField.setText(password);
            this.rememberPassBox.setSelected(true);
        }

        serverField.setText(serverAddress);
        serverField.setEnabled(false);
        serverPortField.setText(serverPort);
        proxyField.setText(proxyAddress);

        // The order of the next two fields is important, as a changelister of
        // the transportCombo sets the proxyPortField to its default
        transportCombo.setSelectedItem(preferredTransport);
        proxyPortField.setText(proxyPort);

        if (!(SIPAccountRegistration.DEFAULT_PORT.equals(serverPort)
                || SIPAccountRegistration.DEFAULT_TLS_PORT.equals(serverPort))
            || !(SIPAccountRegistration.DEFAULT_PORT.equals(proxyPort)
                || SIPAccountRegistration.DEFAULT_TLS_PORT.equals(proxyPort))
            || !transportCombo.getSelectedItem()
                .equals(SIPAccountRegistration.DEFAULT_TRANSPORT))
        {
            enableAdvOpButton.setSelected(true);

            // The server field should stay disabled in modification mode,
            // because the user should not be able to change anything concerning
            // the account identifier and server name is part of it.
            serverField.setEnabled(false);

            serverPortField.setEnabled(true);
            proxyField.setEnabled(true);
            proxyPortField.setEnabled(true);
            transportCombo.setEnabled(true);
        }

        enablePresOpButton.setSelected(enablePresence);
        forceP2PPresOpButton.setSelected(forceP2P);
        enableDefaultEncryption.setSelected(enabledDefaultEncryption); 
        pollPeriodField.setText(pollingPeriod);
        subscribeExpiresField.setText(subscriptionPeriod);

        if (!enablePresence)
        {
            pollPeriodField.setEnabled(false);
            subscribeExpiresField.setEnabled(false);
        }

        keepAliveMethodBox.setSelectedItem(keepAliveMethod);
        keepAliveIntervalValue.setText(keepAliveInterval);
    }

    /**
     * Parse the server part from the sip id and set it to server as default
     * value. If Advanced option is enabled Do nothing.
     */
    private void setServerFieldAccordingToUIN()
    {
        if (!enableAdvOpButton.isSelected())
        {
            String serverAddress
                = wizard.getServerFromUserName(uinField.getText());

            serverField.setText(serverAddress);
            proxyField.setText(serverAddress);
        }
    }

    /**
     * Disables Next Button if Port field value is incorrect
     */
    private void setNextButtonAccordingToPort()
    {
        try
        {
            wizard.getWizardContainer().setNextFinishButtonEnabled(true);
        }
        catch (NumberFormatException ex)
        {
            wizard.getWizardContainer().setNextFinishButtonEnabled(false);
        }
    }

    public void itemStateChanged(ItemEvent e)
    {
        if (e.getStateChange() == ItemEvent.SELECTED
            && e.getItem().equals("TLS"))
        {
            serverPortField.setText(SIPAccountRegistration.DEFAULT_TLS_PORT);
            proxyPortField.setText(SIPAccountRegistration.DEFAULT_TLS_PORT);
        }
        else
        {
            serverPortField.setText(SIPAccountRegistration.DEFAULT_PORT);
            proxyPortField.setText(SIPAccountRegistration.DEFAULT_PORT);
        }
    }

    private boolean isExistingAccount(String accountName, String serverName)
    {
        ProtocolProviderFactory factory =
            SIPAccRegWizzActivator.getSIPProtocolProviderFactory();
        java.util.List<AccountID> registeredAccounts =
            factory.getRegisteredAccounts();

        for (AccountID accountID : registeredAccounts)
        {
            if (accountName.equalsIgnoreCase(accountID.getUserID())
                    && serverName.equalsIgnoreCase(accountID.getService()))
                return true;
        }
        return false;
    }

    public Object getSimpleForm()
    {
        return uinPassPanel;
    }

    public boolean isCommitted()
    {
        return isCommitted;
    }
}