/*

* Copyright (c) 2008-2010 Nokia Corporation and/or its subsidiary(-ies).

* All rights reserved.

* This component and the accompanying materials are made available

* under the terms of "Eclipse Public License v1.0"

* which accompanies this distribution, and is available

* at the URL "http://www.eclipse.org/legal/epl-v10.html".

*

* Initial Contributors:

* Nokia Corporation - initial contribution.

*

* Contributors:

*

* Description:

*

*/

package com.nokia.mj.impl.installer.applicationregistrator;

import com.nokia.mj.impl.installer.storagehandler.ApplicationInfo;

import com.nokia.mj.impl.installer.storagehandler.SuiteInfo;

import com.nokia.mj.impl.installer.utils.ComponentId;

import com.nokia.mj.impl.installer.utils.InstallerException;

import com.nokia.mj.impl.installer.utils.FileUtils;

import com.nokia.mj.impl.installer.utils.Log;

import com.nokia.mj.impl.installer.utils.PlatformUid;

import com.nokia.mj.impl.utils.Attribute;

import com.nokia.mj.impl.utils.Uid;

import java.util.Enumeration;

import java.util.Hashtable;

import java.util.Vector;

/**

 * Registers (and unregisters) Java application to S60 platform's

 * software installation framework (USIF).

 */

public final class SifRegistrator

{

    /** Added application. Used with notifyAppChange() method. */

    public static final int APP_ADDED = 0;

    /** Removed application. Used with notifyAppChange() method. */

    public static final int APP_REMOVED = 1;

    /** Updated application. Used with notifyAppChange() method. */

    public static final int APP_UPDATED = 2;

    /** Native session handle. */

    private int iSessionHandle = 0;

    /*** ----------------------------- PUBLIC ------------------------------ */

    /**

     * Returns greater than zero if application registration to

     * software installation framework is enabled.

     */

    public static int getSifMode()

    {

        return _getUsifMode();

    }

    /**

     * Launches the application view. If launching application view

     * fails this method does not throw exception but produces an

     * error log entry.

     */

    public static void launchAppView()

    {

        int err = _launchAppView();

        if (err < 0)

        {

            Log.logError("Launching AppLib failed with code " + err);

        }

    }

    /**

     * Notifies system about added/updated/removed applications.

     * This method should be called only after the changes have been

     * committed.

     *

     * @param aAppUids application uids

     * @param aAppChange change type: APP_ADDED, APP_UPDATED, or APP_REMOVED

     * @throws InstallerException if notification fails

     */

    public static void notifyAppChange(Uid[] aAppUids, int aAppChange)

    {

        if (aAppUids == null || aAppUids.length == 0)

        {

            return;

        }

        int[] appUids = new int[aAppUids.length];

        for (int i = 0; i < appUids.length; i++)

        {

            appUids[i] = ((PlatformUid)aAppUids[i]).getIntValue();

        }

        int err = _notifyAppChange(appUids, aAppChange);

        if (err < 0)

        {

            InstallerException.internalError(

                "Notifying app changes failed with code " + err);

        }

    }

    /**

     * Get component uid basing on component id.

     * This method can be called before session is created.

     *

     * @param aCid component id

     * @return uid for the component, or null if component is not found

     * @throws InstallerException if an error occurs

     */

    public static Uid getUid(int aCid)

    {

        // Use ComponentId to return int type value from native to java.

        ComponentId id = new ComponentId();

        int err = _getUid(aCid, id);

        if (err < 0)

        {

            InstallerException.internalError(

                "Getting uid for cid " + aCid + " failed with code " + err);

        }

        Uid uid = null;

        if (id.getId() != 0)

        {

            uid = PlatformUid.createUid(id.getId());

        }

        return uid;

    }

    /**

     * Starts application registration session.

     * The registrations and unregistrations are done only

     * when commitSession is called.

     * If you want to discard the registrations and unregistrations

     * call rollbackSession.

     * Does nothing if session has already been successfully started

     * from this SifRegistrator instance.

     *

     * @param aTransaction true if also transaction for this session should

     * be opened, false otherwise

     * @throws InstallerException if the session cannot created

     * @see commitSession

     * @see rollbackSession

     */

    public void startSession(boolean aTransaction)

    {

        if (0 != iSessionHandle)

        {

            // Session has already been created, do nothing.

            Log.logWarning("SifRegistrator.startSession called although session is already open.");

            return;

        }

        // Native method writes error log and returns

        // negative Symbian error code if it fails.

        int ret = _startSession(aTransaction);

        if (ret < 0)

        {

            InstallerException.internalError(

                "Creating session failed with code " + ret);

        }

        //Log.log("SifRegistrator session started");

        iSessionHandle = ret;

    }

    /**

     * Registers Java application suite to S60 USIF.

     *

     * @param aSuiteInfo Information needed to register the application

     * @param aIsUpdate true in case of an update, false in case of a new

     * installation

     * @throws InstallerException if registration cannot done or

     *  startSession has not been called successfully

     * @see startSession

     * @see SuiteInfo

     */

    public void registerSuite(SuiteInfo aSuiteInfo, boolean aIsUpdate)

    {

        if (0 == iSessionHandle)

        {

            InstallerException.internalError("No valid SIF session.");

        }

        Log.log("SifRegistrator registering application suite " +

                aSuiteInfo.getGlobalId());

        if (_getUsifMode() > 0)

        {

            // USIF Phase 2 registration.

            // Register suite as a component.

            registerComponent(aSuiteInfo, aIsUpdate);

            registerLocalizedComponentName(aSuiteInfo, -1);

            // Register applications within the component.

            Vector apps = aSuiteInfo.getApplications();

            for (int i = 0; i < apps.size(); i++)

            {

                registerApplication(aSuiteInfo, i);

            }

        }

        else

        {

            // USIF Phase 1 registration.

            // Register each application in the suite.

            Vector apps = aSuiteInfo.getApplications();

            for (int i = 0; i < apps.size(); i++)

            {

                registerComponent(aSuiteInfo, i, aIsUpdate);

                registerLocalizedComponentName(aSuiteInfo, i);

            }

        }

        registerLocalizedProperties(aSuiteInfo);

    }

    /**

     * Unregisters Java application suite from S60 USIF.

     *

     * @param aSuiteInfo Information needed to unregister the application,

     * @throws InstallerException if unregistration cannot done or

     *  startSession has not been called successfully

     * @see startSession

     * @see SuiteInfo

     */

    public void unregisterSuite(SuiteInfo aSuiteInfo)

    {

        if (0 == iSessionHandle)

        {

            InstallerException.internalError("No valid SIF session.");

        }

        Log.log("SifRegistrator unregistering application suite " +

                aSuiteInfo.getGlobalId());

        if (_getUsifMode() > 0)

        {

            // USIF Phase 2 unregistration.

            // Unregister suite as a component.

            unregisterComponent(aSuiteInfo);

        }

        else

        {

            // USIF Phase 1 unregistration.

            // Unregister each application in the suite.

            Vector apps = aSuiteInfo.getApplications();

            for (int i = 0; i < apps.size(); i++)

            {

                unregisterComponent(aSuiteInfo, i);

            }

        }

    }

    /**

     * Commits the registrations and unregistrations.

     * Ends the current session if commit is successfull.

     * If commit fails the session is kept open so that

     * rollbackSession can be called.

     *

     * @throws InstallerException if session cannot be committed

     */

    public void commitSession()

    {

        if (0 == iSessionHandle)

        {

            InstallerException.internalError("No valid SIF session.");

        }

        int err = _commitSession(iSessionHandle);

        if (err < 0)

        {

            InstallerException.internalError("Commiting session failed with code " + err);

        }

        // Current session has been closed

        iSessionHandle = 0;

        //Log.log("SifRegistrator session committed");

    }

    /**

     * Rolls back the registrations and unregistrations.

     * Ends the current session.

     *

     * @throws InstallerException if session cannot be rolled back.

     */

    public void rollbackSession()

    {

        if (0 == iSessionHandle)

        {

            InstallerException.internalError("No valid SIF session.");

        }

        int err = _rollbackSession(iSessionHandle);

        // Session is closed always when rollback is called

        iSessionHandle = 0;

        if (err < 0)

        {

            InstallerException.internalError("Rolling back the session failed with code " + err);

        }

        //Log.log("SifRegistrator session rolled back");

    }

    /**

     * Closes the current session if it still open.

     * If registerComponent or unregisterComponent has been called,

     * commitSession or rollbackSession must be called instead of this method.

     */

    public void closeSession()

    {

        if (0 == iSessionHandle)

        {

            return;

        }

        _closeSession(iSessionHandle);

        // Current session has been closed

        iSessionHandle = 0;

        //Log.log("SifRegistrator session closed");

    }

    /**

     * Returns the component id of the application.

     *

     * @param aGlobalId the global id for the application.

     * @return the component id for the application, or null if the

     * application with given global id cannot be found.

     * @throws InstallerException if an error occurs

     */

    public ComponentId getComponentId(String aGlobalId)

    {

        if (0 == iSessionHandle)

        {

            InstallerException.internalError("No valid SIF session.");

        }

        ComponentId result = new ComponentId();

        int ret = _getComponentId(iSessionHandle, aGlobalId, result);

        if (-1 == ret)

        {

            // Symbian error code KErrNotFound means that the

            // application with given global id does not exist.

            result = null;

        }

        else if (ret < -1)

        {

            InstallerException.internalError(

                "Getting component id for global id " + aGlobalId +

                " failed with code " + ret);

        }

        return result;

    }

    /**

     * Returns the component id of the application.

     *

     * @param aAppUid the uid for the application.

     * @return the component id for the application, or null if the

     * application with given uid cannot be found.

     * @throws InstallerException if an error occurs

     */

    public ComponentId getComponentId(Uid aAppUid)

    {

        if (0 == iSessionHandle)

        {

            InstallerException.internalError("No valid SIF session.");

        }

        ComponentId result = new ComponentId();

        int ret = _getComponentIdForApp(

                      iSessionHandle, ((PlatformUid)aAppUid).getIntValue(), result);

        if (-1 == ret)

        {

            // Symbian error code KErrNotFound means that the

            // application with given uid does not exist.

            result = null;

        }

        else if (ret < -1)

        {

            InstallerException.internalError(

                "Getting component id for uid " + aAppUid +

                " failed with code " + ret);

        }

        return result;

    }

    /**

     * Writes information of the given application to JavaInstaller log.

     *

     * @param aGlobalId the global id for the application.

     */

    public void logComponent(String aGlobalId)

    {

        if (0 == iSessionHandle)

        {

            InstallerException.internalError("No valid SIF session.");

        }

        int ret = _logComponent(iSessionHandle, aGlobalId);

        if (ret < -1)

        {

            Log.logError("SifRegistrator logComponent failed with code " + ret);

        }

    }

    /*** ----------------------------- PACKAGE ---------------------------- */

    /*** ----------------------------- PRIVATE ---------------------------- */

    /**

     * Registers one Java application to S60 USIF as a component.

     * Used with USIF Phase 1.

     *

     * @param aSuiteInfo Information needed to register the application

     * @param aIndex index of the application in the suite

     * @param aIsUpdate true in case of an update, false in case of a new

     * installation

     * @throws InstallerException if registration cannot done or

     *  startSession has not been called successfully

     * @see startSession

     * @see SuiteInfo

     */

    private void registerComponent(

        SuiteInfo aSuiteInfo, int aIndex, boolean aIsUpdate)

    {

        String globalId = aSuiteInfo.getGlobalId(aIndex);

        if (globalId == null)

        {

            Log.logWarning("SifRegistrator: Application with index " + aIndex +

                           " not found from " + aSuiteInfo.getGlobalId());

            return;

        }

        ApplicationInfo appInfo =

            (ApplicationInfo)aSuiteInfo.getApplications().elementAt(aIndex);

        String suiteName = aSuiteInfo.getName();

        String vendor = aSuiteInfo.getVendor();

        String version = aSuiteInfo.getVersion().toString();

        String name = appInfo.getName();

        int uid = ((PlatformUid)appInfo.getUid()).getIntValue();

        String[] componentFiles = getComponentFiles(aSuiteInfo);

        long componentSize = aSuiteInfo.getInitialSize();

        String attrValue = aSuiteInfo.getAttributeValue("Nokia-MIDlet-Block-Uninstall");

        boolean isRemovable = !(attrValue != null && attrValue.equalsIgnoreCase("true"));

        boolean isDrmProtected = (aSuiteInfo.getContentInfo() == aSuiteInfo.CONTENT_INFO_DRM);

        boolean isOriginVerified = aSuiteInfo.isTrusted();

        String midletInfoUrl = aSuiteInfo.getAttributeValue("MIDlet-Info-URL");

        String midletDescription = aSuiteInfo.getAttributeValue("MIDlet-Description");

        String downloadUrl = aSuiteInfo.getAttributeValue("Nokia-MIDlet-Download-URL");

        ComponentId componentId = new ComponentId();

        int err = _registerComponent(

                      iSessionHandle, uid,

                      getScrString(suiteName), getScrString(vendor),

                      getScrString(version), getScrString(name),

                      getScrString(globalId), componentFiles,

                      componentSize, isRemovable, isDrmProtected,

                      isOriginVerified, aIsUpdate, aSuiteInfo.getMediaId(),

                      getScrString(midletInfoUrl),

                      getScrString(midletDescription),

                      getScrString(downloadUrl),

                      componentId);

        if (err < 0)

        {

            InstallerException.internalError(

                "Registering component " + globalId +

                " failed with code " + err);

        }

        else

        {

            appInfo.setComponentId(componentId);

            Log.log("SifRegistrator registered component " + globalId +

                    " with id " + componentId.getId());

        }

    }

    /**

     * Unregisters one Java application from being S60 USIF component.

     * Used with USIF Phase 1.

     *

     * @param aSuiteInfo Information needed to unregister the application,

     * @param aIndex index of the application in the suite

     * @throws InstallerException if unregistration cannot done or

     *  startSession has not been called successfully

     * @see startSession

     * @see SuiteInfo

     */

    private void unregisterComponent(SuiteInfo aSuiteInfo, int aIndex)

    {

        String globalId = aSuiteInfo.getGlobalId(aIndex);

        if (globalId == null)

        {

            Log.logWarning("SifRegistrator: Application with index " + aIndex +

                           " not found from " + aSuiteInfo.getGlobalId());

            return;

        }

        ComponentId componentId = getComponentId(globalId);

        if (componentId == null)

        {

            Log.logWarning(

                "SifRegistrator unregistration failed, application " +

                globalId + " does not exist");

            return;

        }

        // Save component id to ApplicationInfo.

        ApplicationInfo appInfo =

            (ApplicationInfo)aSuiteInfo.getApplications().elementAt(aIndex);

        appInfo.setComponentId(componentId);

        // Unregister application.

        int err = _unregisterComponent(iSessionHandle, componentId.getId());

        if (err < 0)

        {

            InstallerException.internalError(

                "Unregistering component " + globalId +

                " failed with code " + err);

        }

        else

        {

            Log.log("SifRegistrator unregistered component " + globalId +

                    " with id " + componentId.getId());

        }

    }

    /**

     * Registers Java application suite to S60 USIF as a component.

     * Used with USIF Phase 2.

     *

     * @param aSuiteInfo Suite information

     * @param aIsUpdate true in case of an update, false in case of a new

     * installation

     * @throws InstallerException if registration cannot done or

     *  startSession has not been called successfully

     * @see startSession

     * @see SuiteInfo

     */

    private void registerComponent(SuiteInfo aSuiteInfo, boolean aIsUpdate)

    {

        String globalId = aSuiteInfo.getGlobalId();