| gvSIG desktop 1

/*

 *  $Id: InstallerBase.java,v 1.1 2006/06/14 07:29:07 cesar Exp $

 *  IzPack

 *  Copyright (C) 2001-2003 Jonathan Halliday, Julien Ponge

 *

 *  File :               InstallerBase.java

 *  Description :        Utility functions shared by the GUI and headless installers.

 *  Author's email :     julien@izforge.com

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

 *

 *  Portions are Copyright (C) 2002 Jan Blok (jblok@profdata.nl - PDM - www.profdata.nl)

 *

 *  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.io.File;

import java.io.InputStream;

import java.io.ObjectInputStream;

import java.util.ArrayList;

import java.util.Enumeration;

import java.util.Iterator;

import java.util.List;

import java.util.Locale;

import java.util.Properties;

import com.izforge.izpack.CustomData;

import com.izforge.izpack.Info;

import com.izforge.izpack.Pack;

import com.izforge.izpack.util.IoHelper;

import com.izforge.izpack.util.OsConstraint;

import com.izforge.izpack.util.OsVersion;

/**

 * Common utility functions for the GUI and text installers. (Do not import

 * swing/awt classes to this class.)

 * 

 * @author Jonathan Halliday

 * @author Julien Ponge

 */

public class InstallerBase

{

  /**

   *  Loads the installation data. Also sets environment variables to

   * <code>installdata</code>. All system properties are available as

   * $SYSTEM_<variable> where <variable> is the actual name _BUT_ with

   * all separators replaced by '_'. Properties with null values 

   * are never stored.

   * Example: $SYSTEM_java_version or $SYSTEM_os_name

   * 

   * @param installdata Where to store the installation data.

   * 

   * @exception Exception Description of the Exception

   */

  public void loadInstallData(AutomatedInstallData installdata)

      throws Exception

  {

    // Usefull variables

    InputStream in;

    ObjectInputStream objIn;

    int size;

    int i;

    // We load the variables

    Properties variables = null;

    in = InstallerBase.class.getResourceAsStream("/vars");

    if (null != in)

    {

      objIn = new ObjectInputStream(in);

      variables = (Properties) objIn.readObject();

      objIn.close();

    }

    // We load the Info data

    in = InstallerBase.class.getResourceAsStream("/info");

    objIn = new ObjectInputStream(in);

    Info inf = (Info) objIn.readObject();

    objIn.close();

    // We put the Info data as variables

    installdata.setVariable(ScriptParser.APP_NAME, inf.getAppName());

    installdata.setVariable(ScriptParser.APP_URL, inf.getAppURL());

    installdata.setVariable(ScriptParser.APP_VER, inf.getAppVersion());

    // We read the panels order data

    in = InstallerBase.class.getResourceAsStream("/panelsOrder");

    objIn = new ObjectInputStream(in);

    List panelsOrder = (List) objIn.readObject();

    objIn.close();

    // We read the packs data

    in = InstallerBase.class.getResourceAsStream("/packs.info");

    objIn = new ObjectInputStream(in);

    size = objIn.readInt();

    ArrayList availablePacks = new ArrayList();

    ArrayList allPacks = new ArrayList();

    for (i = 0; i < size; i++)

    {

      Pack pk = (Pack) objIn.readObject();

      allPacks.add(pk);

      if (OsConstraint.oneMatchesCurrentSystem(pk.osConstraints))

          availablePacks.add(pk);

    }

    objIn.close();

    // We determine the operating system and the initial installation path

    String dir;

    String installPath;

    if (OsVersion.IS_WINDOWS)

    {

      dir = buildWindowsDefaultPath();

    }

    else if (OsVersion.IS_OSX)

    {

      dir = "/Applications" + File.separator;

    }

    else

    {

      if (new File("/usr/local/").canWrite())

      {

        dir = "/usr/local" + File.separator;

      }

      else

      {

        dir = System.getProperty("user.home") + File.separator;

      }

    }

    installdata.setVariable(ScriptParser.JAVA_HOME, System

        .getProperty("java.home"));

    installdata.setVariable(ScriptParser.USER_HOME, System

        .getProperty("user.home"));

    installdata.setVariable(ScriptParser.USER_NAME, System

        .getProperty("user.name"));

    installdata.setVariable(ScriptParser.FILE_SEPARATOR, File.separator);

    Enumeration e = System.getProperties().keys();

    while (e.hasMoreElements())

    {

      String varName = (String) e.nextElement();

      String varValue = System.getProperty(varName);

      if (varValue != null) {

              varName = varName.replace('.', '_');

        installdata.setVariable("SYSTEM_" + varName, varValue);

      }

    }

    if (null != variables)

    {

      Enumeration enum = variables.keys();

      String varName;

      String varValue;

      while (enum.hasMoreElements())

      {

        varName = (String) enum.nextElement();

        varValue = variables.getProperty(varName);

        installdata.setVariable(varName, varValue);

      }

    }

    installdata.info = inf;

    installdata.panelsOrder = panelsOrder;

    installdata.availablePacks = availablePacks;

    installdata.allPacks = allPacks;

    // get list of preselected packs

    Iterator pack_it = availablePacks.iterator();

    while (pack_it.hasNext())

    {

      Pack pack = (Pack) pack_it.next();

      if (pack.preselected) installdata.selectedPacks.add(pack);

    }

    // Set the installation path in a default manner

    installPath = dir + inf.getAppName();

    if( inf.getInstallationSubPath() != null )

    { // A subpath was defined, use it.

      installPath = IoHelper.translatePath(dir + inf.getInstallationSubPath(), 

        new VariableSubstitutor(installdata.getVariables()));

    }

    installdata.setInstallPath(installPath);

    // Load custom action data.

    loadCustomData(installdata);

  }

  /**

   * Builds the default path for Windows (i.e Program Files/...).

   * 

   * @return The Windows default installation path.

   */

  private String buildWindowsDefaultPath()

  {

    StringBuffer dpath = new StringBuffer("");

    try

    {

      // We load the properties

      Properties props = new Properties();

      props

          .load(InstallerBase.class

              .getResourceAsStream("/com/izforge/izpack/installer/win32-defaultpaths.properties"));

      // We look for the drive mapping

      String drive = System.getProperty("user.home");

      if (drive.length() > 3) drive = drive.substring(0, 3);

      // Now we have it :-)

      dpath.append(drive);

      // Ensure that we have a trailing backslash (in case drive was something

      // like "C:")

      if (drive.length() == 2) dpath.append("\\");

      String language = Locale.getDefault().getLanguage();

      String country = Locale.getDefault().getCountry();

      String language_country = language + "_" + country;

      // Try the most specific combination first

      if (null != props.getProperty(language_country))

      {

        dpath.append(props.getProperty(language_country));

      }

      else if (null != props.getProperty(language))

      {

        dpath.append(props.getProperty(language));

      }

      else

      {

        dpath.append(props.getProperty(Locale.ENGLISH.getLanguage()));

      }

      dpath.append("\\");

    }

    catch (Exception err)

    {

      dpath = new StringBuffer("C:\\Program Files\\");

    }

    return dpath.toString();

  }

  /**

   * Loads custom data like listener and lib references if exist and

   * fills the installdata.

   * 

   * @param installdata installdata into which the custom action data should be

   * stored

   * @throws Exception

   */

  private void loadCustomData(AutomatedInstallData installdata)

      throws Exception

  {

    // Usefull variables

    InputStream in;

    ObjectInputStream objIn;

    int i;

    // Load listeners if exist.

    String[] streamNames = AutomatedInstallData.CUSTOM_ACTION_TYPES;

    List[] out = new List[streamNames.length];

    for (i = 0; i < streamNames.length; ++i)

      out[i] = new ArrayList();

    in = InstallerBase.class.getResourceAsStream("/customData");

    if (in != null)

    {

      objIn = new ObjectInputStream(in);

      Object listeners = objIn.readObject();

      objIn.close();

      Iterator keys = ((List) listeners).iterator();

      while (keys != null && keys.hasNext())

      {

        CustomData ca = (CustomData) keys.next();

        if (ca.osConstraints != null

            && !OsConstraint.oneMatchesCurrentSystem(ca.osConstraints))

        { // OS constraint defined, but not matched; therefore ignore it.

          continue;

        }

        switch (ca.type)

        {

        case CustomData.INSTALLER_LISTENER:

          Class clazz = Class.forName(ca.listenerName);

          if( clazz == null )

            throw new InstallerException("Custom action " + ca.listenerName + " not bound!");

          out[ca.type].add(clazz.newInstance());

          break;

        case CustomData.UNINSTALLER_LISTENER:

        case CustomData.UNINSTALLER_JAR:

          out[ca.type].add(ca);

          break;

        case CustomData.UNINSTALLER_LIB:

          out[ca.type].add(ca.contents);

          break;

        }

      }

      // Add the current custem action data to the installdata hash map.

      for (i = 0; i < streamNames.length; ++i)

        installdata.customData.put(streamNames[i], out[i]);

    }

    // uninstallerLib list if exist

  }

}