/*

* Copyright (c) 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.utils.InstallerException;

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

/**

 * Sends installation and uninstallation progress notifications

 * to platform's software installation framework.

 */

public final class SifNotifier

{

    /** Install operation. */

    /** Uninstall operation. */

    /** Update operation. */

        specific suboperation. */

    /** OCSP phase during installation. */

    /** Download phase during installation. */

    /** Maximum progress notification value. */

    private static final int MAX_PROGRESS = 100;

    /** Operation being notified. */

    private int iOperation = 0;

    /** Global component id for the application. */

    private String iGlobalComponentId = null;

    /** Component name (i.e. suite name). */

    private String iComponentName = null;

    /** Application names. */

    private String[] iApplicationNames = null;

    /** Applications icons. */

    private String[] iApplicationIcons = null;

    /** Component initial size. */

    private int iComponentSize = 0;

    /** Icon dir. */

    private String iIconDir = null;

    /** Component icon. */

    private String iComponentIcon = null;

    /** Sending progress notifications is only allowed between start

     *  and end notifications. */

    private boolean iNotifyProgressAllowed = false;

    private int iLastProgressSent = 0;

    private int iHandle = 0;

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

    /**

     * Constructor.

     */

    public SifNotifier()

    {

        init();

    }

    /**

     * Returns true if SIF progress notifications are enabled, false otherwise.

     */

    public static boolean enabled()

    {

        return _sifNotifierEnabled();

    }

    /*

     * Notifies SIF that installation or uninstallation has started.

     *

     * @throws InstallerException in case an error occurs

     */

    public void notifyStart(

        int aOperation, String aGlobalComponentId, String aComponentName,

        String[] aApplicationNames, String[] aApplicationIcons,

        int aComponentSize, String aIconDir, String aComponentIcon)

    {

        iOperation = aOperation;

        iGlobalComponentId = aGlobalComponentId;

        iComponentName = aComponentName;

        iApplicationNames = aApplicationNames;

        iApplicationIcons = aApplicationIcons;

        iComponentSize = aComponentSize;

        iIconDir = aIconDir;

        iComponentIcon = aComponentIcon;

        checkHandle();

        int ret = _notifyStart(

                      aApplicationNames, aApplicationIcons,

                      aComponentSize, aIconDir, aComponentIcon);

        if (ret < 0)

        {

            Log.log("Notifying SIF start failed with code " + ret +

                    ", " + getInfoString());

            InstallerException.internalError(

                "Notifying SIF start failed with code " + ret);

        }

        else

        {

            Log.log("SifNotifier.notifyStart: " + getInfoString());

        }

        iNotifyProgressAllowed = true;

    }

    /**

     * Notifies SIF that installation or uinstallation has ended.

     *

     * @throws InstallerException in case an error occurs

     */

    public void notifyEnd(

        int aErrCategory, int aErrCode, String aErrMsg, String aErrMsgDetails)

    {

        checkHandle();

        if (aErrCategory == 0 && iLastProgressSent < MAX_PROGRESS)

        {

            // Before sending end notification, update progress to max if

            // operation was successful and max progress notification has

            // not yet been sent.

            notifyProgress(SUB_OP_NO, MAX_PROGRESS, MAX_PROGRESS);

        }

        // No more progress notifications allowed.

        iNotifyProgressAllowed = false;

        int ret = _notifyEnd(

                      iHandle, iGlobalComponentId, aErrCategory, aErrCode,

                      aErrMsg, aErrMsgDetails);

        String logMsg =

            "ErrCategory: " + aErrCategory +

            ", ErrCode: " + aErrCode +

            ", ErrMsg: " + aErrMsg +

            ", ErrMsgDetails: " + aErrMsgDetails;

        if (ret < 0)

        {

            Log.log("Notifying SIF end failed with code " + ret +

                    ", " + getInfoString() + ", " + logMsg);

            InstallerException.internalError(

                "Notifying SIF end failed with code " + ret);

        }

        else

        {

            Log.log("SifNotifier.notifyEnd: " + logMsg);

        }

    }

    /**

     * Notifies SIF about installation or uninstallation progress.

     *

     * @throws InstallerException in case an error occurs

     */

    public void notifyProgress(int aSubOperation, int aCurrent, int aTotal)

    {

        if (!iNotifyProgressAllowed)

        {

            return;

        }

        checkHandle();

        if (aSubOperation == SUB_OP_NO)

        {

            iLastProgressSent = aCurrent;

        }

        int ret = _notifyProgress(

                      iHandle, iGlobalComponentId, iOperation, aSubOperation,

                      aCurrent, aTotal);

        String logMsg =

            "SubOp: " + aSubOperation +

            ", Current: " + aCurrent +

            ", Total: " + aTotal;

        if (ret < 0)

        {

            Log.log("Notifying SIF progress failed with code " + ret +

                    ", " + getInfoString() + ", " + logMsg);

            InstallerException.internalError(

                "Notifying SIF progress failed with code " + ret);

        }

        else

        {

            Log.log("SifNotifier.notifyProgress: " + logMsg);

        }

    }

    /**

     * Destroys SifNotifier. This method releawse native resources and

     * must be called after SifNotifier is no longer used.

     *

     * @throws InstallerException in case an error occurs

     */

    public void destroy()

    {

        checkHandle();

        int ret = _destroy(iHandle);

        if (ret < 0)

        {

            InstallerException.internalError(

                "Destroying SIF notifier failed with code " + ret);

        }

        else

        {

            Log.log("SifNotifier destroyed");

        }

        iHandle = 0;

    }

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

    /**

     * Initializes SifNotifier. This method must be called before any

     * other methods are called.

     *

     * @throws InstallerException if the notifier cannot be initialized

     */

    void init()

    {

        int ret = _init();

        if (ret < 0)

        {

            InstallerException.internalError(

                "Initializing SifNotifier failed with code " + ret);

        }

        else

        {

            Log.log("SifNotifier created");

        }

        iHandle = ret;

    }

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

    /**

     * Checks if notifier instance has been initialized.

     * @throws InstallerException if notifier has not been initialized

     */

    private void checkHandle()

    {

        if (iHandle == 0)

        {

            InstallerException.internalError(

                "SifNotifier.destroy: notifier has not been initialized");

        }

    }

    /**

     * Returns notification info string used in logging.

     */

    private String getInfoString()

    {

        StringBuffer buf = new StringBuffer();

        buf.append("Operation: ").append(iOperation);

        buf.append(", GlobalComponentId: ").append(iGlobalComponentId);

        buf.append(", ComponentName: ").append(iComponentName);

        if (iApplicationNames != null)

        {

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

            {

                buf.append(", ApplicationName[").append(i).append("]: ")

                    .append(iApplicationNames[i]);

            }

        }

        if (iApplicationIcons != null)

        {

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

            {

                buf.append(", ApplicationIcon[").append(i).append("]: ")

                    .append(iApplicationIcons[i]);

            }

        }

        buf.append(", ComponentSize: ").append(iComponentSize);

        if (iIconDir != null)

        {

            buf.append(", IconDir: ").append(iIconDir);

        }

        if (iComponentIcon != null)

        {

            buf.append(", ComponentIcon: ").append(iComponentIcon);

        }

        return buf.toString();

    }

    /*** ----------------------------- NATIVE ----------------------------- */

    /**

     * Returns true if SIF progress notifications are enabled, false otherwise.

     */

    private static native boolean _sifNotifierEnabled();

    /**

     * Notifies SIF about installation/uinstallation start.

     *

     * @param aHandle

     * @param aGlobalComponentId