/*

* 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.storagehandler;

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

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

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

import com.nokia.mj.impl.storage.StorageAttribute;

import com.nokia.mj.impl.storage.StorageEntry;

import com.nokia.mj.impl.storage.StorageFactory;

import com.nokia.mj.impl.storage.StorageNames;

import com.nokia.mj.impl.storage.StorageSession;

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

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

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

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

import java.util.Enumeration;

import java.util.Hashtable;

import java.util.Vector;

/**

 * StorageHandler offers JavaStorage services for JavaInstaller.

 */

public class StorageHandler

{

    /** StorageSession instance. */

    private StorageSession iSession = null;

    private boolean iTransactionExists = false;

    /**

     * Default constructor.

     */

    public StorageHandler()

    {

        try

        {

            iSession = StorageFactory.createSession();

            iSession.open();

        }

        catch (Throwable t)

        {

            InstallerException.internalError

            ("Error while constructing StorageHandler", t);

        }

    }

    /**

     * Closes this object.

     */

    public void close()

    {

        if (iSession != null)

        {

            try

            {

                iSession.close();

                iSession.destroySession();

                iSession = null;

            }

            catch (Throwable t)

            {

                InstallerException.internalError

                ("Error while closing StorageHandler", t);

            }

        }

    }

    /**

     * Start a new Storage session for storage update.

     * This method creates a new JavaStorage transaction.

     * @throws InstallerException if session opening fails.

     */

    public void startSession()

    {

        try

        {

            checkSession();

            iSession.startTransaction();

            iTransactionExists = true;

        }

        catch (Throwable t)

        {

            InstallerException.internalError

            ("Error while starting Storage session", t);

        }

    }

    /**

     * Commit a successful session.

     * @throws InstallerException if committing session fails.

     */

    public void commitSession()

    {

        try

        {

            checkSession();

            checkTransaction();

            iSession.commitTransaction();

            iTransactionExists = false;

            close();

        }

        catch (Throwable t)

        {

            InstallerException.internalError

            ("Error while committing Storage session", t);

        }

    }

    /**

     * Rollback a session.

     * @throws InstallerException if session rollback fails.

     */

    public void rollbackSession()

    {

        try

        {

            checkSession();

            checkTransaction();

            iSession.rollbackTransaction();

            iTransactionExists = false;

            close();

        }

        catch (Throwable t)

        {

            InstallerException.internalError

            ("Error while rolling back Storage session", t);

        }

    }

    /**

     * Returns instance of StorageSession, or null if session

     * does not exist.

     */

    public StorageSession getSession()

    {

        return iSession;

    }

    /**

     * Get string which contains listing of all entries

     * from given storage table.

     */

    public String getStorageEntriesString(String aTableName)

    {

        StringBuffer result = new StringBuffer();

        try

        {

            result.append("Table ").append(aTableName).append("\n");

            StorageEntry query = new StorageEntry();

            StorageEntry[] entries = iSession.search(aTableName, query);

            if (entries == null)

            {

                return null;

            }

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

            {

                StorageEntry entry = entries[i];

                result.append(entry.toString()).append("\n");

            }

        }

        catch (Throwable t)

        {

            InstallerException.internalError

            ("Error while getting storage table " + aTableName, t);

        }

        return result.toString();

    }

    /**

     * Get uids for all existing suites.

     */

    public Uid[] getSuiteUids()

    {

        try

        {

            checkSession();

            StorageEntry query = new StorageEntry();

            query.addAttribute(new StorageAttribute(StorageNames.ID, ""));

            StorageEntry[] entries = iSession.search(

                                         StorageNames.APPLICATION_PACKAGE_TABLE, query);

            if (entries == null)

            {

                return null;

            }

            Uid[] uids = new Uid[entries.length];

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

            {

                StorageEntry entry = entries[i];

                uids[i] = PlatformUid.createUid

                          (entry.getAttribute(StorageNames.ID).getValue());

            }

            return uids;

        }

        catch (Throwable t)

        {

            InstallerException.internalError

            ("Error while getting suite uids", t);

        }

        return null;

    }

    /**

     * Get suite uid. Given uid parameter can either be an

     * application uid or suite uid. If it is a suite uid,

     * itself is returned. If no matching suite is found,

     * returns null.

     */

    public Uid getSuiteUid(Uid aUid)

    {

        try

        {

            checkSession();

            // Check if aUid is an application uid.

            StorageEntry query = new StorageEntry();

            query.addAttribute(new StorageAttribute

                               (StorageNames.ID, aUid.getStringValue()));

            query.addAttribute(new StorageAttribute(

                                   StorageNames.PACKAGE_ID, ""));

            StorageEntry[] entries = iSession.search(

                                         StorageNames.APPLICATION_TABLE, query);

            if (entries != null && entries.length > 0)

            {

                // Uid is an application uid, return suite uid column.

                return PlatformUid.createUid

                       (entries[0].getAttribute(StorageNames.PACKAGE_ID).getValue());

            }

            // Check if aUid is a suite uid.

            query = new StorageEntry();

            query.addAttribute(new StorageAttribute

                               (StorageNames.ID, aUid.getStringValue()));

            entries = iSession.search(

                          StorageNames.APPLICATION_PACKAGE_TABLE, query);

            if (entries != null && entries.length > 0)

            {

                // Uid is a suite uid, return itself.

                return aUid;

            }

        }

        catch (Throwable t)

        {

            InstallerException.internalError

            ("Error while getting suite uid", t);

        }

        return null;

    }

    /**

     * Get application uids that belong to given suite.

     * Note that this method does not guarantee the order in which

     * application uids are returned.

     * If no matching suite is found, returns null.

     */

    public Uid[] getAppUids(Uid aUid)

    {

        try

        {

            checkSession();

            Uid[] uids = null;

            StorageEntry query = new StorageEntry();

            query.addAttribute(new StorageAttribute

                               (StorageNames.PACKAGE_ID, aUid.getStringValue()));

            query.addAttribute(new StorageAttribute(StorageNames.ID, ""));

            StorageEntry[] entries = iSession.search(

                                         StorageNames.APPLICATION_TABLE, query);

            if (entries != null && entries.length > 0)

            {

                uids = new Uid[entries.length];

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

                {

                    uids[i] = PlatformUid.createUid

                              (entries[i].getAttribute(StorageNames.ID).getValue());

                }

            }

            return uids;

        }

        catch (Throwable t)

        {

            InstallerException.internalError

            ("Error while getting application uids", t);

        }

        return null;

    }

    /**

     * Reads suite info from JavaStorage. Retrieves info basing

     * on uid field in the given SuiteInfo. If uid field is not present,

     * then info is fetched using Name and Vendor fields.

     * If matching suite is not found from storage, returns false.

     */

    public boolean readSuiteInfo(SuiteInfo aSuiteInfo)

    {

        try

        {

            checkSession();

            if (aSuiteInfo == null)

            {

                return false;

            }

            boolean result = false;

            if (aSuiteInfo.getUid() == null)

            {

                // Fetch suite info basing on name and vendor.

                if (aSuiteInfo.getName() == null ||

                        aSuiteInfo.getVendor() == null)

                {

                    Log.logError

                    ("StorageHandler.readSuiteInfo: uid or name " +

                     "and vendor not found from SuiteInfo");

                    return result;

                }

                StorageEntry query = new StorageEntry();

                query.addAttribute(new StorageAttribute

                                   (StorageNames.PACKAGE_NAME,

                                    aSuiteInfo.getName()));

                query.addAttribute(new StorageAttribute

                                   (StorageNames.VENDOR,

                                    aSuiteInfo.getVendor()));

                query.addAttribute(new StorageAttribute(StorageNames.ID, ""));

                StorageEntry[] entries = iSession.search(

                                             StorageNames.APPLICATION_PACKAGE_TABLE, query);

                if (entries != null && entries.length > 0)

                {

                    // Found matching suite.

                    aSuiteInfo.setUid(PlatformUid.createUid

                                      (entries[0].getAttribute(

                                           StorageNames.ID).getValue()));

                }

            }

            if (aSuiteInfo.getUid() != null)

            {

                // Fetch suite info basing on uid.

                result = readSuiteInfoByUid(aSuiteInfo);

            }

            return result;

        }

        catch (Throwable t)

        {

            InstallerException.internalError

            ("Error while reading suite info", t);

        }

        return false;

    }

    /**

     * Writes suite info to JavaStorage.

     */

    public void writeSuiteInfo(SuiteInfo aSuiteInfo)

    {

        try

        {

            checkSession();

            checkTransaction();

            // Write StorageNames.APPLICATION_PACKAGE_TABLE table.

            StorageEntry entry = new StorageEntry();

            entry.addAttribute

            (new StorageAttribute

             (StorageNames.ID, aSuiteInfo.getUid().getStringValue()));

            entry.addAttribute

            (new StorageAttribute

             (StorageNames.PACKAGE_NAME, aSuiteInfo.getName()));

            entry.addAttribute

            (new StorageAttribute

             (StorageNames.VENDOR, aSuiteInfo.getVendor()));

            entry.addAttribute

            (new StorageAttribute

             (StorageNames.VERSION, aSuiteInfo.getVersion().toString()));

            entry.addAttribute

            (new StorageAttribute

             (StorageNames.ROOT_PATH, aSuiteInfo.getRootDir()));

            entry.addAttribute

            (new StorageAttribute

             (StorageNames.MEDIA_ID, Integer.toString(aSuiteInfo.getMediaId()),

              StorageAttribute.INT_TYPE));

            entry.addAttribute

            (new StorageAttribute

             (StorageNames.INITIAL_SIZE, Integer.toString(aSuiteInfo.getInitialSize()),

              StorageAttribute.INT_TYPE));

            entry.addAttribute

            (new StorageAttribute

             (StorageNames.JAD_PATH, aSuiteInfo.getJadPath()));

            entry.addAttribute

            (new StorageAttribute

             (StorageNames.JAR_PATH, aSuiteInfo.getJarPath()));

            entry.addAttribute

            (new StorageAttribute

             (StorageNames.JAD_URL, aSuiteInfo.getJadUrl()));

            entry.addAttribute

            (new StorageAttribute

             (StorageNames.JAR_URL, aSuiteInfo.getJarUrl()));

            entry.addAttribute

            (new StorageAttribute

             (StorageNames.ACCESS_POINT, aSuiteInfo.getAccessPoint()));

            entry.addAttribute

            (new StorageAttribute

             (StorageNames.CONTENT_INFO, Integer.toString(aSuiteInfo.getContentInfo()),

              StorageAttribute.INT_TYPE));

            entry.addAttribute

            (new StorageAttribute

             (StorageNames.CONTENT_ID, aSuiteInfo.getContentId()));

            iSession.write(StorageNames.APPLICATION_PACKAGE_TABLE, entry);

            // Write StorageNames.APPLICATION_PACKAGE_ATTRIBUTES_TABLE table.

            writeAttributes(aSuiteInfo.getUid(), aSuiteInfo.getAttributes());

            // Write StorageNames.APPLICATION_TABLE table.

            Vector apps = aSuiteInfo.getApplications();

            if (apps != null)

            {

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

                {

                    writeAppInfo(aSuiteInfo.getUid(),

                                 (ApplicationInfo)apps.elementAt(i));

                }

            }

            // Update StorageNames.MIDP_PACKAGE_TABLE table.

            // This table is shared with security framework

            // so we must have a special handling for it.

            // Create a new entry to be inserted or updated.

            entry = new StorageEntry();

            entry.addAttribute

            (new StorageAttribute

             (StorageNames.ID, aSuiteInfo.getUid().getStringValue()));

            entry.addAttribute

            (new StorageAttribute

             (StorageNames.ON_SCREEN_KEYPAD,

              Integer.toString(aSuiteInfo.getOnScreenKeypad()),

              StorageAttribute.INT_TYPE));

            // Check if an entry already exists.

            StorageEntry matchEntry = new StorageEntry();

            matchEntry.addAttribute(new StorageAttribute(StorageNames.ID,

                                    aSuiteInfo.getUid().getStringValue()));

            StorageEntry[] entries = iSession.search(

                                         StorageNames.MIDP_PACKAGE_TABLE, matchEntry);

            if (entries != null && entries.length > 0)

            {

                // Entry exists, update it.

                iSession.update(StorageNames.MIDP_PACKAGE_TABLE, entry, matchEntry);

            }

            else

            {

                // Entry does not exist, create it.

                iSession.write(StorageNames.MIDP_PACKAGE_TABLE, entry);

            }

            // Update StorageNames.PREINSTALL_TABLE table.

            writePreinstallState(aSuiteInfo);

        }

        catch (Throwable t)

        {

            InstallerException.internalError

            ("Error while writing suite info", t);

        }

    }

    /**

     * Updates changed parts of suite info to JavaStorage.

     */

    public void updateSuiteInfo(SuiteInfo aOldSuiteInfo, SuiteInfo aNewSuiteInfo)

    {

        try

        {

            checkSession();

            checkTransaction();

            removeSuiteInfo(aOldSuiteInfo, true);

            writeSuiteInfo(aNewSuiteInfo);

        }

        catch (Throwable t)

        {

            InstallerException.internalError

            ("Error while updating suite info", t);

        }

    }

    /**

     * Removes info from JavaStorage for given suite uid.

     */

    public void removeSuiteInfo(SuiteInfo aSuiteInfo)

    {

        try

        {

            removeSuiteInfo(aSuiteInfo, false);

        }

        catch (Throwable t)

        {

            InstallerException.internalError

            ("Error while removing suite info", t);

        }

    }

    /**

     * Allocates a free uid which is not in use in storage.

     *

     * @param aPreviousUid if null allocates a random uid,

     * if not null allocates next free uid

     * @return a free uid, or null if uid cannot be allocated

     */

    public Uid allocateUid(Uid aPreviousUid)

    {

        try

        {

            checkSession();

            Uid uid = PlatformUid.generateUid(aPreviousUid, null);

            if (uidInUse(uid))

            {

                Uid startUid = uid;

                do

                {

                    uid = PlatformUid.generateUid(uid, null);

                    if (uid.equals(startUid))

                    {

                        InstallerException.internalError

                        ("No more free uids.");

                    }