/*

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

* All rights reserved.

* This component and the accompanying materials are made available

* under the terms of the License "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:  The feeds server database.

*

*/

#ifndef FEEDS_DATABASE_H

#define FEEDS_DATABASE_H

//  INCLUDES

#include <d32dbms.h>

#include <e32base.h>

#include <f32file.h>

// CONSTANTS

const TInt KUnassignedId = -1;

const TInt KMinFreebytes = 1024000;

// DATA TYPES

// FORWARD DECLARATIONS

class CDbKey;

class CDesC16ArraySeg;

class CPackedFeed;

class CPackedFolder;

class CFeedsServer;

struct TAttribute;

// CLASS DECLARATION

/**

*  The feeds server database.

*

*  \b Library: FeedsEngine.lib

*

*  @since 3.1

*/

NONSHARABLE_CLASS(CFeedsDatabase): public CBase

    {

    public:  // Constructors and destructor

        /**

        * Two-phased constructor.

        *

        * @since 3.1

        * @param aDatabaseCreated To to ETrue by this method if the database

        *        was newly created.

        * @return A new instance.

        */

        static CFeedsDatabase* NewL(CFeedsServer* aFeedsServer, TBool &aDatabaseCreated);

        /**

        * Destructor.

        */

        ~CFeedsDatabase();

    public:  // New methods

        /**

        * Returns the feed if of the feed with the given url.

        *

        * @since 3.1

        * @param aFeedUrl The feed's url

        * @param aFeedId The resulting FeedsTable feed id.

        * @return ETrue if the feed was resolved.

        */

        TBool FeedIdFromUrlL(const TDesC& aFeedUrl, TInt aFolderListId, TInt& aFeedId);

        /**

        * Returns the feed id of the feed with the given entry id.

        *

        * @since 7.1

        * @param aEntryId The feed's folder item id

        * @param aFolderListId The folder list ID of the feed.

        * @param aFeedId The resulting FolderListTable feed id.

        * @return ETrue if the feed was resolved.

        */

        TBool CFeedsDatabase::FeedIdFromEntryIdL(const TInt& aEntryId, TInt aFolderListId, TInt& aFeedId);

        /**

        * Returns the feed id of the entry id with the given feed.

        *

        * @since 7.1

        * @param aFeedId The resulting FolderListTable feed id.

        * @param aFolderListId The folder list ID of the feed.

        * @param aEntryId The feed's folder item id

        * @return ETrue if the feed was resolved.

        */

        TBool CFeedsDatabase::EntryIdFromFeedIdL(const TInt& aFeedId, TInt aFolderListId, TInt& aEntryId);

        /**

        * Return the folder list ID of the feed with the given feed-id.

        *

        * @since 3.2

        * @param aFeedId The FeedsTable feed's id 

        * @param aFolderListId The folder list ID of the feed

        * @return void.

        */

        void FolderListIdFromFeedIdL( TInt aFeedId, TInt& aFolderListId );

        /**

        * Return the feed-id of the given folder-item-id.

        *

        * @since 3.1

        * @param aFolderItemId The FolderListTable folder item's id 

        * @param aFeedId The feed's id

        * @return ETrue if the feed was resolved.

        */

        TBool FeedIdFromFolderItemIdL(TInt aFolderItemId, TInt& aFeedId);

        /**

        * Gets the folder item properties like IsFolder, Title and FeedURL

        *

        * @since 3.2

        * @param aFolderItemId The Folder item's id

        * @param aTitle Title of the folder item will be stored in this

        * @param aFeedUrl Feed URL of the folder item will be stored in this

        * @return void

        */

		void FolderItemInfoL(TInt aFolderItemId, TBool &aIsFolder, HBufC*& aTitle, HBufC*& aFeedUrl);

        /**

        * Return the url of the feed with the given feed-id.

        *

        * @since 3.1

        * @param aFeedId The FeedsTable feed's id 

        * @param aFeedUrl The feed's url

        * @return ETrue if the feed was resolved.

        */

        TBool UrlFromFeedIdL(TInt aFeedId, HBufC*& aFeedUrl);

        /**

        * Finds the item with the given item-id-str and returns its id.

        *

        * @since 3.1

        * @param aFeedId The FeedsTable feed id.

        * @param aItemIdStr The item's id string.

        * @param aItemId The resulting ItemsTable item id.

        * @return ETrue if the feed was resolved.

        */

        TBool FindItemL(TInt aFeedId, const TDesC& aItemIdStr, TInt& aItemId);

        /**

        * Finds the folder item with the given name.

        *

        * @since 3.1

        * @param aFolderListId The folder list id.

        * @param aName The name.

        * @param aFolderItemId The resulting folder-item-id, if found.

        * @return ETrue if a folder item with this name was found.

        */

        TBool CFeedsDatabase::FindFolderItemL(TInt& aFolderListId, const TDesC& aName, 

                TInt& aFolderItemId);

        /**

        * Extract all of the feed-ids.

        *

        * @since 3.1

        * @param aFeedIds The resulting feed ids.

        * @return Void.

        */

        void AllFeedIdsL( RArray<TInt>& aFeedIds, TInt aFolderListId = -1 );

        /**

        * Determines if the given feed is newly created (not ok to read from the database).

        *

        * @since 3.1

        * @param aFeedId The resulting feed id.

        * @return ETrue if the feed is newly created.

        */

        TBool IsNewlyCreatedL(TInt aFeedId);

        /**

        * Extracts the feed from the database.

        *

        * @since 3.1

        * @param aFeedId The feed's id.  Call ResolveFeedUrl to get the id.

        * @param aFeed The resulting packed feed.

        * @return void

        */

        void ExtractFeedL(TInt aFeedId, CPackedFeed& aFeed);

        /**

        * Extracts the folder from the database.

        *

        * @since 3.1

        * @param aFolderListId The folder list's id.

        * @param aPackedFolder The resulting packed folder.

        * @param aItemTitleNeed The flag indicates if the titles of items with new status will be returned.

        * @return void

        */

        void ExtractRootFolderL( TInt aFolderListId, CPackedFolder& aPackedFolder, TBool aItemTitleNeed = EFalse );

        /**

        * Update the database given the packed feed.

        *

        * @since 3.1

        * @param aFeed A packed feed.

        * @param aFeedUrl The feed's url.

        * @param aPurgeOldItems If ETrue all items in the db that are not in the 

        *                       packed feed are purged from the database.

        * @return Void.

        */

        void UpdateFeedL(const CPackedFeed& aPackedFeed, const TDesC& aFeedUrl,TInt aFeedId, TInt aFolderListId,

                TBool aPurgeOldItems = ETrue);

        /**

        * Update the database given the packed folder.

        *

        * @since 3.1

        * @param aFolderListId The folder list's id.

        * @param aFeed A packed folder.

        * @return Void.

        */

        void ImportFolderL(TInt aFolderListId, const CPackedFolder& aPackedFolder);

        /**

        * Add a new entry.

        *

        * @since 3.1

        * @param aFolderListId The folder-list id.

        * @param aTitle The title.

        * @param aUrl The url.

        * @param aIsFolder ETrue if this is a folder.

        * @param aParentEntryId The entry id of the parent.

        * @param aFreq auto update frequency

        * @return The entry-id of the new entry.

        */

        TInt FolderItemAddL(TInt aFolderListId, const TDesC& aTitle,

                const TDesC& aUrl, TBool aIsFolder, TInt aParentEntryId, TInt aFreq);

        /**

        * Update an entry.

        *

        * @since 3.1

        * @param aFolderItemId The folder-item's id.

        * @param aTitle The title.

        * @param aUrl The url.

        * @param aFreq auto update frequency

        * @return void

        */

        void FolderItemUpdateL(TInt aFolderItemId, const TDesC& aTitle, 

                const TDesC& aUrl, TInt aFreq);

        /**

        * Delete the given folder items.

        *

        * @since 3.1

        * @param aFolderItemIds The id of the folder items.

        * @param iSessionCalled This should be true if FeedServerSession calls this function

        * @return void

        */

        void FolderItemDeleteL(const RArray<TInt>& aFolderItemIds, TBool iSessionCalled = EFalse);

        /**

        * Delete anything under the folder list.

        *

        * @since 3.2

        * @param aFolderListId The folder list ID.

        * @return void

        */

        void FolderListDeleteL( TInt aFolderListId );

        /**

        * Move the folder items within their parent.

        *

        * @since 3.1

        * @param aFolderItemIds The id of the folder items.

        * @param aNewIndex The target index.

        * @return void.

        */

        void FolderItemMoveL(const RArray<TInt>& aFolderItemIds, 

                TInt aNewIndex);

        /**

        * Move the entries to another parent.

        *

        * @since 3.1

        * @param aFolderItemIds The id of the folder items.

        * @param aNewParent The id of the new parent.

        * @return void.

        */

        void FolderItemMoveToL(const RArray<TInt>& aFolderItemIds,             

                TInt aNewParent);

        /**

        * Update the status of each of the items in the given feed.

        *

        * @since 3.1

        * @param aFeedId The feed's id.

        * @param aItemIds The Id's of the items to update.

        * @param aItemStatus The corresponding status of items defined in aItemIdStr.

        * @return void

        */

        void FeedUpdateItemStatusL(TInt aFeedId, const RArray<TInt>& aItemIds,

                const RArray<TInt>& aItemStatus, TInt aUnreadCount);

        /**

        * Deletes the feed if the feedId isn't referenced in the folder-list table.

        *

        * @since 3.1

        * @param aFeedId The feed's id.

        * @return void.

        */

        void PurgeFeedIfNotReferencedL(TInt aFeedId);

        /**

        * Removes the feed's items also deletes the feed if aDeleteFeed is ETrue.

        * It is only safe to call this method with aDeleteFeed set to ETrue if

        * aFeedId is not found in the FolderListTable.

        *

        * @since 3.1

        * @param aFeedId The feed's id.

        * @param aDeleteFeed If ETrue the feed is also delete.

        * @return void.

        */

        void FeedPurgeL(TInt aFeedId, TBool aDeleteFeed = EFalse);

        /**

        * Purge all old items in the given feed.

        *

        * @since 3.1

        * @param aFeedId The feed's id.

        * @param aTimestamp The timestamp used to remove old items.

        * @return void.

        */

        void PurgeOldItemsL(TInt aFeedId, const TTime& aTimestamp);

        /**

        * Purge the associated enclosures

        *

        * @since 3.1

        * @param aFeedId The feed's id.

        * @param aItemId The item's id.

        * @return void.

        */

        void PurgeEnclosuresL(TInt aFeedId, TInt aItemId);

        /**

        * Purge all items not found in the given array.

        *

        * @since 3.1

        * @param aFeedId The feed's id.

        * @param aItemIds An array that holds the itemIds of the items to keep.

        * @return purged unread count.

        */

        TInt PurgeOtherItemsL(TInt aFeedId, const RArray<TInt>& aItemIds);

        /**

        * Get the settings from the database.

        *

        * @since 3.2

        * @param aFolderListIds The array holding folder list Ids in the settings table.

        * @return void.

        */

        void ExtractFolderListIdInSettingsL( RArray<TInt>& aFolderListIds );

        /**

        * Get the settings from the database.

        *

        * @since 3.2

        * @param aFolderListId The client to whom the settings belong to.

        * @param aAutoUpdate ETrue if auto update is enabled.

        * @param aAutoUpdateFreq The freq of auto updates.

        * @param aAutoUpdateAP The access point.

        * @param aAutoUpdateWhileRoaming ETrue if auto update is enabled while roaming.

	    * @return void.

        */

		void ExtractAutoUpdateSettingsL( TInt aFolderListId, TBool& aAutoUpdate, TInt& aAutoUpdateFreq,

        TUint32& aAutoUpdateAP, TBool &autoUpdateWhileRoaming  );        

        /**

        * Commit the settings to the database

        *

        * @since 3.2

        * @param aFolderListId The client to whom the settings belong to.

        * @param aAutoUpdate ETrue if auto update is enabled.

        * @param aAutoUpdateFreq The freq of auto updates.

        * @param aAutoUpdateAP The access point.

        * @param aAutoUpdateWhileRoaming ETrue if auto update is enabled.

        * @return Void.

        */

		void CommitAutoUpdateSettingsL( TInt aFolderListId, TBool aAutoUpdate, TInt aAutoUpdateFreq,

        TUint32 aAutoUpdateAP, TBool aAutoUpdateWhileRoaming );

        /**

        * Get the last auto update settings from the database.

        *

        * @since 3.2

        * @param aFolderListId The client to whom the settings belong to.

        * @param aLastAutoUpdate The timestamp of the last auto update.

        * @return void.

        */

        void ExtractLastAutoUpdateSettingsL(TInt aFolderListId, TTime& aLastAutoUpdate);

        /**

        * Commit the last auto update settings to the database

        *

        * @since 3.2

        * @param aFolderListId The client to whom the settings belong to.

        * @param aLastAutoUpdate The timestamp of the last auto update.

        * @return Void.

        */

        void CommitLastAutoUpdateSettingsL(TInt aFolderListId, TTime aLastAutoUpdate);

        /**

        * Compacts the database.

        *

        * @since 3.1

        * @return Void.

        */

        void Compact();

        /**

        * Print the tables from the database.

        *

        * @since 3.2

        * @return Void.

        */

        void DebugPrintTablesL();

        /**

        * Print the folder list table from the database.

        *

        * @since 3.2

        * @return Void.

        */

        void DebugPrintFolderListTableL();

        /**

        * Print the item table from the database.

        *

        * @since 3.2

        * @return Void.

        */

        void DebugPrintItemTableL();

        /**

        * Extract the folder-item-ids of the children of the given parent.

        *

        * @since 3.2

        * @param aFolderItemId The id of the parent folder item.

        * @param aChildren The ids of the children.

        * @return void.

        */

        void FolderItemGetChildrenL(TInt aFolderItemId, RArray<TInt>& aChildren);

        /**

        * Check for the duplicate folder names and feed URLs and suggest the next title.

        *

        * @since 3.2

        * @param aFolderListId The folder list id.

        * @param aParentEntryId The parent id

        * @param aTitle Folder/Feed title to be checked for duplicates

        * @param aIsFolder Flag which indicates folder/feed

        * @param aNewFeedTitle The new feed/folder title generated

        * @return TBool - ETrue if new folder/feed title is generated successfully and ready to add to the DB.

        */

		TBool ValidateFeedFolderTitleL(const TInt &aFolderListId, const TInt &aParentEntryId,

			 const TDesC& aTitle, const TBool aIsFolder, TDes& aNewFeedTitle);

        /**

         * Update Feed Status

         *

         * @since 5.0

         * @param aFeedId Feed Id.

         * @param aFeedStatus Feed status

         * @return void

         */

		void UpdateFeedStatusL(TInt aFeedId, TInt aFeedStatus);

        /**

         * Adds a new column AutoUpdateFreq to FeedTable in the case of versions less than 7.1.

         *

         * @since 7.1

         * @return void

         */

        void AlterFeedTableWithAutoFequencyL();

        /**

         * Fetchs Freqs for all feeds.

         *

         * @since 7.1

         * @return bool

         */        

        TBool FreqFromFeedIdL(TInt aFeedId, TInt& aFreq);

    private:  // New methods

        /**

        * C++ default constructor.

        */

        CFeedsDatabase(CFeedsServer* aFeedsServer);

        /**

        * Two-Phase constructor

        */

        void ConstructL(TBool &aDatabaseCreated);

        /**

        * Reset the database.

        *

        * @since 3.1

        * @return void.

        */

        void ResetDatabaseL();

        /**

        * Creates the version table.

        *

        * @since 3.1

        * @return void.

        */

        void CreateVersionTableL();