com.izforge.izpack.util.OsConstraintHelper Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of izpack-util Show documentation
There is a newer version: 5.2.3
package com.izforge.izpack.util;

import com.izforge.izpack.api.adaptator.IXMLElement;
import com.izforge.izpack.api.data.binding.OsModel;

import java.util.ArrayList;
import java.util.List;

/**
 * Encapsulates OS constraints specified on creation time and allows to check them against the
 * current OS.
 * 
 * For example, this is used for <executable>s to check whether the executable is suitable for
 * the current OS.
 *
 * @author Olexij Tkatchenko 
 */
public class OsConstraintHelper
{
    /**
     * Matches OS specification in this class against current system properties.
     *
     * @param osModel
     * @return Description of the Return Value
     */
    public static boolean matchCurrentSystem(OsModel osModel)
    {
        boolean match = true;
        String osName = System.getProperty("os.name").toLowerCase();


        if ((osModel.getArch() != null) && (osModel.getArch().length() != 0))
        {
            match = System.getProperty("os.arch").toLowerCase().equals(osModel.getArch());
        }    // end if

        if (match && (osModel.getVersion() != null) && (osModel.getVersion().length() != 0))
        {
            match = System.getProperty("os.version").toLowerCase().equals(osModel.getVersion());
        }    // end if

        if (match && (osModel.getName() != null) && (osModel.getName().length() != 0))
        {
            match = osName.equals(osModel.getName());
        }    // end if

        if (match && (osModel.getFamily() != null))
        {
            if ("windows".equals(osModel.getFamily()))
            {
                match = OsVersion.IS_WINDOWS;
            }    // end if
            else if ("mac".equals(osModel.getFamily()) || "osx".equals(osModel.getFamily()))
            {
                match = OsVersion.IS_OSX;
            }    // end else if
            else if ("unix".equals(osModel.getFamily()))
            {
                match = OsVersion.IS_UNIX;
            }    // end else if
        }    // end if

        if (match && (osModel.getJre() != null) && (osModel.getJre().length() > 0))
        {
            match = System.getProperty("java.version").toLowerCase().startsWith(osModel.getJre());
        }

        return match
                && ((osModel.getFamily() != null) || (osModel.getName() != null) || (osModel.getVersion() != null) || (osModel.getArch() != null) || (osModel.getJre() != null));
    }

    /**
     * Extract a list of OS constraints from given element.
     *
     * @param element parent IXMLElement
     * @return List of OsModel (or empty List if no constraints found)
     */
    public static List getOsList(IXMLElement element)
    {
        // get os info on this executable
        ArrayList osList = new ArrayList();
        for (IXMLElement osElement : element.getChildrenNamed("os"))
        {
            osList.add(
                    new OsModel(
                            osElement.getAttribute("arch",
                                    null),
                            osElement.getAttribute("family",
                                    null),
                            osElement.getAttribute("jre",
                                    null),
                            osElement.getAttribute("name",
                                    null),
                            osElement.getAttribute("version",
                                    null))
            );
        }
        // backward compatibility: still support os attribute
        String osattr = element.getAttribute("os");
        if ((osattr != null) && (osattr.length() > 0))
        {
            // add the "os" attribute as a family constraint
            osList.add(
                    new OsModel(osattr,
                            null, null, null, null)
            );
        }

        return osList;
    }

    /**
     * Helper function: Scan a list of OsConstraints for a match.
     *
     * @param constraint_list List of OsModel to check
     * @return true if one of the OsConstraints matched the current system or constraint_list is
     *         null (no constraints), false if none of the OsConstraints matched
     */
    public static boolean oneMatchesCurrentSystem(List constraint_list)
    {
        if (constraint_list == null || constraint_list.isEmpty())
        {
            return true;
        }
        for (OsModel osModel : constraint_list)
        {
            Debug.trace("checking if os constraints " + osModel + " match current OS");
            // check for match
            if (matchCurrentSystem(osModel))
            {
                Debug.trace("matched current OS.");
                return true;    // bail out on first match
            }    // end if
        }    // end while

        Debug.trace("no match with current OS!");

        // no match found
        return false;
    }

    /**
     * Helper function: Check whether the given IXMLElement is "suitable" for the current OS.
     *
     * @param el The IXMLElement to check for OS constraints.
     * @return true if there were no OS constraints or the constraints matched the current OS.
     */
    public static boolean oneMatchesCurrentSystem(IXMLElement el)
    {
        return oneMatchesCurrentSystem(getOsList(el));
    }
}