/build/distribution/IzPack/src/lib/com/izforge/izpack/installer/WebAccessor.java

/*

 *  $Id: WebAccessor.java 5819 2006-06-14 07:29:09Z cesar $

 *  IzPack

 *  Copyright (C) 2002 Johannes Lehtinen

 *

 *  File :               WebAccessor.java

 *  Description :        Prompt user for proxies and passwords

 *  Author's email :     mchenryc@acm.org

 *  Author's Website :   http://www.izforge.com

 *

 *  This program is free software; you can redistribute it and/or

 *  modify it under the terms of the GNU General Public License

 *  as published by the Free Software Foundation; either version 2

 *  of the License, or any later version.

 *

 *  This program is distributed in the hope that it will be useful,

 *  but WITHOUT ANY WARRANTY; without even the implied warranty of

 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 *  GNU General Public License for more details.

 *

 *  You should have received a copy of the GNU General Public License

 *  along with this program; if not, write to the Free Software

 *  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.

 */

package com.izforge.izpack.installer;



import java.awt.BorderLayout;

import java.awt.Component;

import java.awt.Cursor;

import java.awt.GridLayout;

import java.awt.Toolkit;

import java.io.InputStream;

import java.net.Authenticator;

import java.net.ConnectException;

import java.net.InetAddress;

import java.net.PasswordAuthentication;

import java.net.URL;

import java.net.URLConnection;

import java.util.Locale;



import javax.swing.JDialog;

import javax.swing.JLabel;

import javax.swing.JOptionPane;

import javax.swing.JPanel;

import javax.swing.JPasswordField;

import javax.swing.JTextField;

import javax.swing.UIManager;





/**

 * Dialogs for password authentication and firewall specification, when needed,

 * during web installation.

 *

 * @author  Chadwick McHenry

 * @version 1.0

 */

public class WebAccessor

{

  private Thread openerThread = null;

  private InputStream iStream = null;

  private Exception exception = null;

  

  private Object soloCancelOption = null;

  private Component parent = null;

  private JDialog dialog = null;

  private boolean tryProxy = false;



  private JPanel passwordPanel = null;

  private JLabel promptLabel;

  private JTextField nameField;

  private JPasswordField passField;



  private JPanel proxyPanel = null;

  private JLabel errorLabel;

  private JTextField hostField;

  private JTextField portField;



  /**

   * Not yet Implemented: placeholder for headless installs.

   *

   * @throws UnsupportedOperationException

   */

  public WebAccessor()

  {

    // the class should probably be rearranged to do this.

    throw new UnsupportedOperationException();

  }



  /**

   * Create a WebAccessor that prompts for proxies and passwords using a

   * JDialog.

   *

   * @param parent determines the frame in which the dialog is displayed; if

   * the parentComponent has no Frame, a default Frame is used

   */

  public WebAccessor(Component parent)

  {

    this.parent = parent;

    Locale l = null;

    if (parent != null)

      parent.getLocale();

    soloCancelOption = UIManager.get("OptionPane.cancelButtonText",l);// TODO: i18n?

    Authenticator.setDefault(new MyDialogAuthenticator());

  }



  /**

   * Opens a URL connection and returns it's InputStream for the specified URL.

   *

   * @param url the url to open the stream to.

   * @return an input stream ready to read, or null on failure

   */

  public InputStream openInputStream(URL url)

  {

    // TODO: i18n everything

    Object[] options = {soloCancelOption};

    JOptionPane pane = new JOptionPane("Connecting to the Internet",

                                       JOptionPane.INFORMATION_MESSAGE,

                                       JOptionPane.DEFAULT_OPTION,

                                       null, options, options[0]);

    dialog = pane.createDialog(parent, "Accessing Install Files");

    pane.setCursor(Cursor.getPredefinedCursor(Cursor.WAIT_CURSOR));



    Object value = null;

  OPEN_URL:

    while (true)

    {

      startOpening(url); // this starts a thread that may dismiss the dialog before user

      dialog.setVisible(true);

      value = pane.getValue();

      

      // dialog closed or canceled (by widget)

      if (value == null || value == soloCancelOption)

      {

        try {

          openerThread.interrupt();// stop the connection

        } catch (Exception e) {

        }

        iStream = null; // even if connection was made just after cancel

        break;

      }

      

      // dialog closed by thread so either a connection error or success!

      else if (value == JOptionPane.UNINITIALIZED_VALUE)

      {

        // success!

        if (iStream != null)

          break;



        //System.err.println(exception);



        // an exception we don't expect setting a proxy to fix

        if (! tryProxy)

          break;



        // else (exception != null)

        // show proxy dialog until valid values or cancel

        JPanel panel = getProxyPanel();

        errorLabel.setText("Unable to connect: " +exception.getMessage());

        while (true)

        {

          int result = JOptionPane.showConfirmDialog(parent, panel,

                                                     "Proxy Configuration",

                                                     JOptionPane.OK_CANCEL_OPTION,

                                                     JOptionPane.QUESTION_MESSAGE);

          if (result != JOptionPane.OK_OPTION) // canceled

            break OPEN_URL;



          String host = null;

          String port = null;

          

          try {

            InetAddress addr = InetAddress.getByName(hostField.getText());

            host = addr.getHostName();

          } catch (Exception x) {

            errorLabel.setText("Unable to resolve Host");

            Toolkit.getDefaultToolkit().beep();

          }

          

          try {

            if (host != null)

              port = Integer.valueOf(portField.getText()).toString();

          } catch (NumberFormatException x) {

            errorLabel.setText("Invalid Port");

            Toolkit.getDefaultToolkit().beep();

          }

          

          if (host != null && port != null) {

            //System.err.println ("Setting http proxy: "+ host +":"+ port);

            System.getProperties().put ("proxySet", "true");

            System.getProperties().put ("proxyHost", host);

            System.getProperties().put ("proxyPort", port);

            break;

          }

        }

      }

    }

    return iStream;

  }

  

  private void startOpening(final URL url)

  {

    openerThread = new Thread()

      {

        public void run() {

          iStream = null;

          try {

            tryProxy = false;

            URLConnection connection = url.openConnection();

            iStream = connection.getInputStream(); // just to make connection

            

          } catch (ConnectException x) { // could be an incorrect proxy

            tryProxy = true;

            exception = x;

            

          } catch (Exception x) {

            // Exceptions that get here are considered cancels or missing

            // pages, eg 401 if user finally cancels auth

            exception = x;

            

          } finally {

            // if dialog is in use, allow it to become visible /before/ closing

            // it, else on /fast/ connectinos, it may open later and hang!

            if (dialog != null)

            {

              Thread.yield();

              dialog.setVisible(false);

            }

          }

        }

      };

    openerThread.start();

  }



  /**

   * Only to be called after an initial error has indicated a connection problem

   */

  private JPanel getProxyPanel()

  {

    if (proxyPanel == null)

    {

      proxyPanel = new JPanel(new BorderLayout(5,5));



      errorLabel = new JLabel();

      

      JPanel fields = new JPanel(new GridLayout(2,2));

      String h = (String)System.getProperties().get ("proxyHost");

      String p = (String)System.getProperties().get ("proxyPort");

      hostField = new JTextField(h != null ? h : "");

      portField = new JTextField(p != null ? p : "");

      JLabel host = new JLabel("Host: "); // TODO: i18n

      JLabel port = new JLabel("Port: "); // TODO: i18n

      fields.add(host);

      fields.add(hostField);

      fields.add(port);

      fields.add(portField);



      JLabel exampleLabel =

        new JLabel("e.g. host=\"gatekeeper.example.com\" port=\"80\"");



      proxyPanel.add(errorLabel, BorderLayout.NORTH);

      proxyPanel.add(fields, BorderLayout.CENTER);

      proxyPanel.add(exampleLabel, BorderLayout.SOUTH);

    }

    proxyPanel.validate();

    

    return proxyPanel;

  }

  

  private JPanel getPasswordPanel()

  {

    if (passwordPanel == null)

    {

      passwordPanel = new JPanel(new BorderLayout(5,5));



      promptLabel = new JLabel();

      

      JPanel fields = new JPanel(new GridLayout(2,2));

      nameField = new JTextField();

      passField = new JPasswordField();

      JLabel name = new JLabel("Name: "); // TODO: i18n

      JLabel pass = new JLabel("Password: "); // TODO: i18n

      fields.add(name);

      fields.add(nameField);

      fields.add(pass);

      fields.add(passField);



      passwordPanel.add(promptLabel, BorderLayout.NORTH);

      passwordPanel.add(fields, BorderLayout.CENTER);

    }

    passField.setText("");



    return passwordPanel;

  }



  /**

   * Authenticates via dialog when needed.

   */

  private class MyDialogAuthenticator extends Authenticator

  {

    public PasswordAuthentication getPasswordAuthentication()

    {

      // TODO: i18n

      JPanel p = getPasswordPanel();

      String prompt = getRequestingPrompt();

      InetAddress addr = getRequestingSite();

      if (addr != null)

        prompt += " (" + addr.getHostName() + ")";

      promptLabel.setText(prompt);

      int result = JOptionPane.showConfirmDialog(parent, p, "Enter Password",

                                                 JOptionPane.OK_CANCEL_OPTION,

                                                 JOptionPane.QUESTION_MESSAGE);

      if (result != JOptionPane.OK_OPTION)

        return null;



      return new PasswordAuthentication(nameField.getText(),

                                        passField.getPassword());

    }

  };

}