/*

* Copyright (c) 2002-2007 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:    header file for CIptvEpgDb class. Engine version 1.1.*

*/

#ifndef CIPTVEPGDB_H

#define CIPTVEPGDB_H

#include <e32std.h>

#include <badesca.h>    // CDesCArrayFlat (cannot be forward declarated)

#include <d32dbms.h>    // RDbStoreDatabase

#include <f32file.h>    // RFs

#include "CIptvUtil.h"

#include "MIptvEpgVodCallback.h"

#include <cenrepnotifyhandler.h>

const int KCustomSqlMaxLength( 256 );

const TInt KIptvDbNameMaxLength( 50 );

// Category table

_LIT( KIptvEpgCategoryTable, "Cat" );

_LIT( KIptvEpgCategoryDbKeyCol, "Key" );

_LIT( KIptvEpgCategoryDbParentKeyCol, "PKey" );

_LIT( KIptvEpgCategoryDbIdCol, "Id" );

_LIT( KIptvEpgCategoryDbNameCol, "Name" );

_LIT( KIptvEpgCategoryDbIconFileIdCol, "IconId" ); // Obsolete field

_LIT( KIptvEpgCategoryDbIsIconFilePathUrlCol, "IsIconPathUrl" ); // Obsolete

_LIT( KIptvEpgCategoryDbIconFilePathCol, "IconPath" );

_LIT( KIptvEpgCategoryDbDescriptionCol, "Desc" );

_LIT( KIptvEpgCategoryDbPubDateCol, "PD" ); // Obsolete field

_LIT( KIptvEpgCategoryDbContentCountCol, "ContentCount" );

// Content table

_LIT( KIptvEpgContentTable, "Con" );

_LIT( KIptvEpgContentDbKeyCol, "Key" );

_LIT( KIptvEpgContentDbIdCol, "Id" );

_LIT( KIptvEpgContentDbNameCol, "Name" );

_LIT( KIptvEpgContentDbFileIdCol, "FID" );

_LIT( KIptvEpgContentDbDriveIdCol, "Dr" );

_LIT( KIptvEpgContentDbPreviewFileIdCol, "PFID" );

_LIT( KIptvEpgContentDbPreviewDriveIdCol, "PDr" );

_LIT( KIptvEpgContentDbContentProtectionCol, "CP" );

_LIT( KIptvEpgContentDbIconFileIdCol, "IconId" );

_LIT( KIptvEpgContentDbIsIconFilePathUrlCol, "IsIconPathUrl" );

_LIT( KIptvEpgContentDbIconFilePathCol, "IconPath" );

_LIT( KIptvEpgContentDbContentFileIdCol, "ConId" );

_LIT( KIptvEpgContentDbDescriptionCol, "Desc" );

_LIT( KIptvEpgContentDbPubDateCol, "PD" );

_LIT( KIptvEpgContentDbBrowserUrlCol, "BU" );

_LIT( KIptvEpgContentDbOrderCol, "Ord" );

_LIT( KIptvEpgContentDbAuthorCol, "Aut" );

_LIT( KIptvEpgContentDbCopyrightCol, "Cop" );

_LIT( KIptvEpgContentDbSizeCol, "Siz" );

_LIT( KIptvEpgContentDbDurationCol, "Dur" );

_LIT( KIptvEpgContentDbLanguageCol, "Lan" );

_LIT( KIptvEpgContentDbRatingAgeCol, "RatingAge" );

// Category_Content table

_LIT( KIptvEpgCategoryContentTable, "CategoryContent" );

_LIT( KIptvEpgCategoryContentCategoryKeyCol, "CategoryKey" );

_LIT( KIptvEpgCategoryContentContentKeyCol, "ContentKey" );

// Service table

_LIT( KIptvEpgServiceTable, "Service" );

_LIT( KIptvEpgServiceLastUpdate, "LastUpdate" );

_LIT( KIptvEpgServiceNextUpdate, "NextUpdate" );

_LIT( KIptvEpgServiceETag, "ETag" );

_LIT( KIptvEpgServiceLastModifiedSince, "LastModifiedSince" );

_LIT( KIptvEpgServiceXmlFileHash, "EXmlFileHash" );

_LIT( KIptvEpgServiceVersion, "Version" );

// ContentAccess

_LIT( KIptvCATable, "ContentAccess" );

_LIT( KIptvCAContentKey, "ContentKey" );

_LIT( KIptvCAContentUrl, "ContentUrl" );

_LIT( KIptvCADlType, "DlType" );

_LIT( KIptvCALanguage, "Language" );

_LIT( KIptvCAPrice, "Price" );

_LIT( KIptvCAPurchaseType, "PurchaseType" );

_LIT( KIptvCAPurchaseUrl, "PurchaseUrl" );

_LIT( KIptvCALastPlayPosition, "LastPlayPosition" );

_LIT( KIptvCAMimeType, "MimeType" );

_LIT( KIptvCAFileSize, "FileSize" );

_LIT( KIptvCADuration, "Duration" );

_LIT( KIptvCAFileId, "FileId" );

_LIT( KIptvCADriveId, "DriveId" );

_LIT( KIptvCAIndex, "Index" );

_LIT( KIptvCAExpression, "Expression" );

// Name of the category Key index

_LIT( KIptvEpgCategoryDbIndexName, "CategoryIndex" );

// Name of the content Key index

_LIT( KIptvEpgContentDbIndexName, "ContentIndex" );

// Name of the CategoryContent Key index

_LIT( KIptvEpgCategoryContentDbIndexName, "CatConIndex" );

class CIptvEpgCategory;

class CIptvEpgContent;

class CIptvVodContentCategoryBriefDetails;

class CIptvVodContentContentBriefDetails;

class CIptvVodContentContentFullDetails;

class CIptvMyVideosGlobalFileId;

class CIptvServer;

class CIptvEpgSession;

/**

 *

 * An instance of class CIptvEpgDb provides Epg database access creating and

 * manipulating Epg database files and database entries (categories and

 * contents.

 *

 * Database definition:

 *

 *   The Epg database contains one table as follows:

 *

 *   Table name: Category

 *     Column:            Type:          Length (bytes):

 *     ------             -----          ---------------

 *     Key                EDbColUint32   4

 *     ParentKey          EDbColUint32   4

 *     Id                 EDbColText     KIptvIdMaxLength * 2

 *     Name               EDbColText     KIptvEpgCategoryNameMaxLength * 2

 *     IconFileId         EDbColUint32   4

 *     IsIconFilePathUrl  EDbColUint32   4

 *     IconFilePath       EDbColText     KIptvEpgCategoryIconFilePathMaxLength * 2

 *     PubDate            EDbColDateTime 8

 *     Description        EDbColText     KIptvEpgCategoryDescriptionMaxLength * 2

 *     contentCount       EDbColUint32   4

 *

 *   There is also index for Category table with name "CategoryIndex". It

 *   consists of Key column.

 *

 *   Index provides quick find.

 *

 *

 * Database definition:

 *

 *   The Epg database contains one table as follows:

 *

 *   Table name: Content

 *     Column:              Type:          Length (bytes):

 *     ------               -----          ---------------

 *     Key                  EDbColUint32   4

 *     Id                   EDbColText     KIptvIdMaxLength * 2

 *     Name                 EDbColText     KIptvEpgContentNameMaxLength * 2

 *     FileId               EDbColUint32   4

 *     Drive                EDbColUint32   4

 *     PFileId              EDbColUint32   4

 *     PDrive               EDbColUint32   4

 *     ContentProtection    EDbColUint32   4 (NOT USED)

 *     IconFileId           EDbColUint32   4

 *     IsIconFilePathUrl    EDbColUint32   4

 *     IconFilePath         EDbColText     KIptvEpgContentIconFilePathMaxLength * 2

 *     ContentFileId        EDbColUint32   4

 *     Description          EDbColText     KIptvEpgContentDescriptionMaxLength * 2

 *     PubDate              EDbColDateTime 8

 *     BrowserUrl           EDbColText     KIptvEpgContentBrowserUrlMaxLength * 2

 *     Order                EDbColUint32   4

 *     Author               EDbColText     KIptvEpgContentAuthorLength * 2

 *     Copyright            EDbColText     KIptvEpgContentCopyrightLength * 2

 *     Size                 EDbColUint32   4

 *     Duration             EDbColUint32   4

 *     Language             EDbColText     KIptvCALanguageLength * 2

 *     RatingAge            EDbColUint16   2

 *

 *   Missing from content table, not implemented in increment 1:

 *

 *   - Next postponed download time

 *   - Next scheduled download time

 *

 *   There is also index for Content table with name "ContentIndex". It

 *   consists of Key column.

 *

 *   Index provides quick find.

 *

 * Database definition:

 *

 *   The Epg database contains one table as follows:

 *

 *   Table name: CategoryContent

 *     Column:              Type:          Length (bytes):

 *     ------               -----          --------------

 *     CategoryKey          EDbColUint32   4

 *     ContentKey           EDbColUint32   4

 *

 *

 *

 * Database definition:

 *

 *   The Epg database contains one table as follows:

 *

 *   Table name: Service

 *     Column:              Type:          Length (bytes):

 *     ------               -----          ---------------

 *     LastUpdate           EDbColDateTime   8

 *     NextUpdate           EDbColDateTime   8

 *     ETag                 EDbColText       64

 *     LastModifiedSince    EDbColText       64

 *     EXmlFileHash         EDbColText       20

 *     Version              EDbColUint32     4

 *

 * Database definition:

 *

 *   The Epg database contains one table as follows:

 *

 *   Table name: ContentAccess

 *     Column:              Type:          Length (bytes):

 *     ------               -----          ---------------

 *     ContentKey           EDbColUint32     4

 *     ContentUrl           EDbColLongText   KIptvCAContentUrlLength * 2

 *     DlType               EDbColUint32     4

 *     Language             EDbColText       KIptvCALanguageLength * 2

 *     Price                EDbColText       KIptvCAPriceLength * 2

 *     PurchaseType         EDbColUint32     4

 *     PurchaseURL          EDbColLongText   KIptvCAPurchaseUrlLength * 2

 *     LastPlayPosition     EDbColUint32     4

 *     MimeType             EDbColText       KIptvCAMimeTypeLength * 2

 *     FileSize             EDbColUint32     4

 *     Duration             EDbColUint32     4

 *     FileId               EDbColUint32     4

 *     DriveId              EDbColUint32     4

 *     Index                EDbColUint32     4

 *     Expression           EDbColUint32     4

 *

 *  @lib IptvServer.exe

 *  @since Engine 1.0

 */

class CIptvEpgDb : public CBase,

                   public MCenRepNotifyHandlerCallback

    {

public:

    /**

     * Two-phased constructor.

     *

     * @param aEpgFile Database file name.

     * @param aServiceId Service id.

     * @param aServer Server.

     */

    static CIptvEpgDb* NewL(

        const TFileName& aEpgFile,

        const TUint32& aServiceId,

        CIptvServer& aServer );

    /**

     * Destructor.

     */

    ~CIptvEpgDb();

    // Query methods for EpgMsgHandler from VodContentClient interface

    /**

     * Get list of ECG categories.

     * The ownership of the returned list is transferred to caller.

     * The order of categories is defined by database originated from

     * service provider.

     *

     * @param aParentCategoryId Points to category ID which sub-categories

     *                          should be listed. If NULL, the root is

     *                          referenced.

     * @param aCategoryList Reference to a storage where pointer to

     *                      created category list is returned.

     * @return Error code, KErrNone if no errors,

     *                     KErrCouldNotConnect if server is needs

     *                       permission for connection,

     *                     otherwise one of the system wide error codes.

     */

    TInt GetEcgCategoryListL(

        TIptvCategoryId aParentCategoryId,

        RPointerArray<CIptvVodContentCategoryBriefDetails>& aCategoryList );

    /**

     * Get detais of one category item.

     *

     * @since                Engine 1.1

     * @param aCategoryId    Selected category ID identifier.

     * @param aCategory      Reference to a full details data returned.

     * @return               Error code, KErrNone if no errors.

     */

    TInt GetCategoryDetailsL(

        TIptvCategoryId aCategoryId,

        CIptvVodContentCategoryBriefDetails& aCategory );

    /**

     * Get parent category ID identifier.

     * This method allows application to browse toward root category,

     * then two consecutive calls are needed.

     *

     * @param aCategoryId Points to category ID which parent category is

     *                    requested.

     * @param aParentId Reference to a storage where parent ID is returned.

     * @return Error code, KErrNone if no errors,

     *                     KErrCouldNotConnect if server is needs permission

     *                                         for connection,

     *                     otherwise one of the system wide error codes.

     */

    TInt GetParentCategoryL(

        TIptvCategoryId aCategoryId,

        TIptvCategoryId& aParentId );

    /**

     * Get list of ECG contents in the specified category in order defined

     * by database originated from service provider.

     * The ownership of the returned list is transferred to caller.

     *

     * @param aCategoryId Selected category ID identifier

     * @param aSearchString A search string used to filter contents search.

     *                      If NULL, no filtering issued.

     * @param aFrom The start index for listed contents. If NULL, start from

     *              the first one.

     * @param aAmount Amount of content elementes to be listes. If NULL,

     *                all starting from aFrom.

     * @param aTotalAmount Pointer to a variable where total amount of

     *                     content is returned.

     * @param aEcgList Reference to returned ECG list items.

     * @return Error code, KErrNone if no errors,

     *                     KErrCouldNotConnect if server is needs permission

     *                                         for connection,

     *                     otherwise one of the system wide error codes.

     */

    TInt GetEcgListL(

        TIptvCategoryId aCategoryId,

        const TDesC& aSearchString,

        TUint32 aFrom,

        TUint32 aAmount,

        TUint32& aTotalAmount,

        RPointerArray<CIptvVodContentContentBriefDetails>& aEcgList );

    /**

     * Get list of all ECG contents in alphabetical order.

     * The ownership of the returned list is transferred to caller.

     *

     * @param aSearchString A search string used to filter contents search.

     *                      If NULL, no filtering issued.

     * @param aFrom The start index for listed contents.

     *              If NULL, start from the first one.

     * @param aAmount Amount of content elementes to be listes.

     *                If NULL, all starting from aFrom.

     * @param aTotalAmount Pointer to a variable where total amount of

     *                     content is returned.

     * @param aEcgList Reference to returned ECG list items.

     * @return Error code, KErrNone if no errors,

     *                     KErrCouldNotConnect if server is needs permission

     *                                         for connection,

     *                     otherwise one of the system wide error codes.

     */

    TInt GetEcgAllListL(

        const TDesC& aSearchString,

        TUint32 aFrom,

        TUint32 aAmount,

        TUint32& aTotalAmount,

        RPointerArray<CIptvVodContentContentBriefDetails>& aEcgList );

    /**

     * Get full detais of one content item.

     * The ownership of the returned data is transferred to caller.

     *

     * @param aContentId Selected content ID identifier.

     * @param aContentFullDetails Reference to returned full details data.

     * @return Error code, KErrNone if no errors,

     *                     KErrCouldNotConnect if server is needs permission

     *                                         for connection,

     *                     otherwise one of the system wide error codes.

     */

    TInt GetContentDetailsL(

        TIptvContentId aContentId,

        CIptvVodContentContentFullDetails& aContentFullDetails );

    /**

     * Marks the database files to be deleted after database has been closed.

     * @param aDelete ETrue to delete the files (default value), EFalse to clear this flag.

     */

    void DeleteDatabaseFiles( TBool aDelete = ETrue );

// from MIptvEpgPluginManager interface

    /**

     * Add new category to database.

     *

     * @param aCategory     Reference to CIptvEpgCategory object.

     * @param aCategoryKey  New category key value is inserted to

     *                      aCategoryKey

     * @return              KErrNone if successful, otherwise another of the

     *                      system-wide error codes.

     */

    TInt AddCategoryL(

        CIptvEpgCategory& aCategory,

        TUint32& aCategoryKey );

    /**

     * Add relation between category and content.

     *

     * @param aCategoryKey  Category key.

     * @param aContentKey   Content key.

     */

    TInt AddRelationL( TUint32& aCategoryKey, TUint32& aContentKey );

    /**

     * Add new content to given category.

     *

     * @param aContent        Reference to CIptvEpgContent object.

     * @param aMediaContents  Pointer array containing media content objects.

     *                        There can be n media content's for one content.

     * @param aContentKey     New content key value is inserted to

     *                        aContentKey

     * @return                KErrNone if successful, otherwise another of

     *                        the system-wide error codes.

     */

    TInt AddContentL(

        CIptvEpgContent& aContent,

        RPointerArray<CIptvMediaContent> aMediaContents,

        TUint32& aContentKey );

    /**

     * Update category icon.

     *

     * @param aCategoryKey      Category key.

     * @param aIconFileId       Icon file id to search from the database.

     * @param aIconFilePath     Full path to icon file or URL + filename.

     * @param aIsUrl            If aIconFilePath is URL aIsUrl == ETrue,

     *                          if aIconFilePath is path

     *                          to local filesystem aIsUrl == EFalse.

     * @return                  KErrNone if successful, otherwise another of

     *                          the system-wide error codes.

     */

    TInt UpdateCategoryIconL(

        TUint32& aCategoryKey,

        TUint32& aIconFileId,

        const TDesC& aIconFilePath,

        TBool aIsUrl );

    /**

     * Update content icon.

     *

     * @param aCategoryKey      Content key.

     * @param aIconFileId       Icon file id to search from the database.

     * @param aIconFilePath     Full path to icon file or URL + filename.

     * @param aIsUrl            If aIconFilePath is URL aIsUrl == ETrue,

     *                          if aIconFilePath is path

     *                          to local filesystem aIsUrl == EFalse.

     * @return                  KErrNone if successful, otherwise another of

     *                          the system-wide error codes.

     */

    TInt UpdateContentIconL(

        TUint32& aContentKey,

        TUint32& aIconFileId,

        const TDesC& aIconFilePath,

        TBool aIsUrl );

    /**

     * Get service update information.

     *

     * @param aLastUpdate   Last update time.

     * @param aInterval     Update interval.

     */

    TInt GetServiceInformationL(

        TTime& aLastUpdate,

        TTime& aInterval);

    /**

     * Update service update information.

     *

     * @param aLastUpdate   Last update time.

     * @param aInterval     Update interval.

     */

    TInt UpdateServiceInformationL(

        const TTime& aLastUpdate,

        const TTime& aInterval );

    /**

     * Get service update information for HTTP headers.

     *

     * @param aETag                 ETag

     * @param aLastModifiedSince    LastModifiedSince

     */

    TInt GetServiceETagAndLastmodifiedSinceL(

        TDes& aETag,

        TDes& aLastModifiedSince );

    /**

     * Update service update information for HTTP headers.

     *

     * @param aETag                 ETag

     * @param aLastModifiedSince    LastModifiedSince

     */

    TInt UpdateServiceETagAndLastModifiedSinceL(

        const TDesC& aETag,

        const TDesC& aLastModifiedSince );

    /**

     * Get hash for service XML file.

     *

     * @param aHash    Hash string

     */

    TInt GetServiceXmlFileHashL(

        TDes& aHash);

    /**

     * Update hash for service XML file.

     *

     * @param aHash    Hash string

     */

    TInt UpdateServiceXmlFileHashL(

        const TDesC& aHash);

    /**

     * Reset global Id.

     *

     * @param aId           Global file id to be reset.

     */

    TInt ResetGlobalId( CIptvMyVideosGlobalFileId& aId );