/*

* Copyright (c) 2004-2008 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:    Utility class and constants used by Iptv application.*

*/

#ifndef CIPTVUTIL_H

#define CIPTVUTIL_H

#include <e32std.h>

#include <e32const.h>

#include <e32base.h>

#include <f32file.h>           // RFs

#include <e32property.h>

#include <bldvariant.hrh>      // for __SERIES60_30__ or similar

#include <commdb.h>

#include "IptvDebug.h"

#include "iptvcustommessageids.h"

class TDataType;

class TIptvExternalFolderInfo;

_LIT( KIptvEmptyDes, "" );

_LIT8( KIptvEmptyDes8, "" );

// Max thumbnail size for RSS plugin in bytes

const TInt KIptvRssMaxThumbnailSize                     = 512000;

// KMaxPath - 1 (256 - 1 = 255). This is maximun path length defined in DB.

const TInt KIptvMaxPath                                 = 255;

const TInt KIptvIdMaxLength                             = 255;

// VOD client API constants

const TInt KIptvVodContentMaxPath                       = KIptvMaxPath;

const TInt KIptvVodContentMaxCategoryNameLen            = 100;

const TInt KIptvVodContentMaxCategoryDescriptionLen     = 255;

const TInt KIptvVodContentMaxCategoryBrowserUrlLen      = KIptvMaxPath;

const TInt KIptvVodContentCategoryRootId                = 0;

// Fixed category id for "invalid" category.

const TUint32 KIptvRssInvalidCategoryId                 = KMaxTUint32 - 2;

const TInt KIptvVodContentMaxLanguageLen                = 10;

const TInt KIptvVodContentMaxContentNameLen             = 100;

const TInt KIptvVodContentMaxContentDescriptionLen      = 255;

const TInt KIptvVodContentMaxThumbnailPathLen           = KIptvMaxPath;

// EPG manager and plugin server side constants

// Category

const TInt KIptvEpgMaxCategoryCount                     = 20;

const TInt KIptvEpgMaxContentCountInCategory            = 200;

const TInt KIptvEpgCategoryStartIndex                   = 1;

const TInt KIptvEpgCategoryNameMaxLength                = 100;

const TInt KIptvEpgCategoryIconFilePathMaxLength        = KIptvMaxPath;

const TInt KIptvEpgCategoryDescriptionMaxLength         = 255;

const TInt KIptvEpgCategoryLongDescriptionMaxLength     = 500;

// Content

const TInt KIptvEpgMaxContentCount                      = 500;

const TInt KIptvEpgContentNameMaxLength                 = 100;

const TInt KIptvEpgContentIconFilePathMaxLength         = KIptvMaxPath;

const TInt KIptvEpgContentDescriptionMaxLength          = 255;

const TInt KIptvEpgContentLongDescriptionMaxLength      = 500;

const TInt KIptvEpgContentBrowserUrlMaxLength           = 2048;

const TInt KIptvEpgContentAuthorLength                  = 100;

const TInt KIptvEpgContentCopyrightLength               = 100;

const TUint32 KIptvEpgContentIdNone                     = KMaxTUint32 - 3;

// 'Search'

const TInt KIptvRssSearchMaxSearchStringLength          = 255;

// Fixed category id for search category.

const TUint32 KIptvRssSearchCategoryId                  = KMaxTUint32 - 1;

const TUint32 KIptvRssSearchInitialContentId            = 1000000;

// Content access

const TInt KIptvCAContentUrlLength                      = 2048;

const TInt KIptvCAPurchaseUrlLength                     = 2048;

const TInt KIptvCALanguageLength                        = 10;

const TInt KIptvCAPriceLength                           = 10;

const TInt KIptvCAMimeTypeLength                        = 64;

const TInt KIptvMyVideosNameMaxLength                   = 100;

const TInt KIptvMyVideosVideoMaxMimeTypeLength          = 64;

// MyVideos constants

const TInt  KIptvMyVideosFolderNameMaxLength            = 16;

const TInt  KIptvMyVideosFolderThumbnailPathMaxLength   =

                KIptvVodContentMaxThumbnailPathLen;

const TInt  KIptvMyVideosFolderDescriptionMaxLength     =

                KIptvVodContentMaxCategoryDescriptionLen;

const TInt  KIptvMyVideosFolderLongDescriptionMaxLength = 500;

const TInt  KIptvMyVideosFolderRootId                   =

                KIptvVodContentCategoryRootId;

const TUint KIptvMyVideosFolderInvalidId                = KMaxTUint32;

const TInt KIptvMyVideosVideoNameMaxLength              =

                KIptvVodContentMaxContentNameLen;

const TInt KIptvMyVideosVideoThumbnailPathMaxLength     =

                KIptvVodContentMaxThumbnailPathLen;

const TInt KIptvMyVideosVideoDescriptionMaxLength       =

                KIptvVodContentMaxContentDescriptionLen;

const TInt KIptvMyVideosVideoPathMaxLength              =

                KIptvMaxPath;

const TInt KIptvMyVideosVideoLongDescriptionMaxLength   =

                KIptvEpgContentLongDescriptionMaxLength;

const TInt KIptvMyVideosVideoMaxAudioLanguageLen        = 50;

const TInt KIptvMyVideosVideoMaxAuthorLength            = 255;

const TInt KIptvMyVideosVideoMaxCopyrightLength         = 255;

const TInt KIptvMyVideosVideoMaxFileSourceNameLength    = 128;

// Service manager

// in 16bit words

const TInt KIptvSmServicesDbNameMaxLength               = 80;

const TInt KIptvSmServicesDbAddressMaxLength            = 255;

const TInt KIptvSmServicesDbIconPathMaxLength           = KIptvMaxPath;

// Check which plugin has shortest and use it. Currently using

// KMaxDefAttrLength from HttpDownloadMgrCommon.h

const TInt KIptvSmPasswordsDbUserNameMaxLength          = 32;

// Currently using KMaxDefAttrLength from HttpDownloadMgrCommon.h

const TInt KIptvSmPasswordsDbPasswordMaxLength          = 32;

const TInt KIptvSmServicesDbDescMaxLength               = 200;

const TInt KIptvSmServicesDbTempIdMaxLength             = 127;

const TInt KIptvSmServicesDbMaxIaps                     = 10;

const TInt KIptvSmServicesDbProviderIdMaxLength         =

                KIptvSmServicesDbAddressMaxLength;

const TInt KIptvSmServicesDbAccountManagementUrlMaxLength =

                KIptvSmServicesDbAddressMaxLength;

const TInt KIptvSmServicesDbIapNameMaxLength            = 255;

const TInt KIptvSmServicesDbSearchUrlMaxLength          = 2048;

const TInt KIptvSmServicesDbRecordUrlMaxLength          = 2048;

// in 8-bit bytes

const int KIptvSmServicesDbIapListMaxLength             =

    1 /*TUint8 count*/ +

    KIptvSmServicesDbMaxIaps *

        ( 4 /*TUint32 iId*/ + 2 /*TUint16 priority*/ );

// CIptvEpgService constants

const TInt KIptvEpgServiceAddressMaxLength              =

                KIptvSmServicesDbAddressMaxLength;

const TInt KIptvEpgServiceUserNameMaxLength             =

                KIptvSmPasswordsDbUserNameMaxLength;

const TInt KIptvEpgServicePasswordMaxLength             =

                KIptvSmPasswordsDbPasswordMaxLength;

//Network Selection

const TInt KIptvNsIapNameMaxLength                      = 255;

//vod dl

const TInt KIptvVodDlUserNameMaxLength                  =

                KIptvSmPasswordsDbUserNameMaxLength;

const TInt KIptvVodDlPasswordMaxLength                  =

                KIptvSmPasswordsDbUserNameMaxLength;

// EPG manager server side error codes

const TInt KIptvErrorGetUpdateInformationLNotFound      = 123;

const TInt KIptvErrorNoService                          = 140;

// aInfo parameters for error codes. Notice these are not actual error codes!

const TInt KIptvRssParserError                          = 145;

// EPG manager messages sent to client!

const TInt KIptvErrorVodNoIap                   = 139; // aInfo is 0

const TInt KIptvVodUpdateStarted                = 136; // aInfo is 0

const TInt KIptvContentUpdateCompleted          = 146; // aInfo is 0

const TInt KIptvServiceThumbnailDownloaded      = 143; // aInfo parameter is

                                                       // service id

const TInt KIptvContentThumbnailDownloaded      = 144; // aInfo parameter is

                                                       // content id

const TInt KIptvErrorEpgUpdateFailed            = 133; // KIptvRssParserError

                                                       // or TIptvDlError

                                                       // (defined in this file)

const TInt KIptvErrorEpgUpdateSuccessed         = 134; // aInfo is 0

const TInt KIptvVodUpdateNotStarted             = 137; // aInfo is 0

const TInt KIptvErrorEpgUpdateStopped           = 138; // aInfo is 0

const TInt KIptvErrorRssSearchStarted           = 170;

const TInt KIptvErrorRssSearchFailed            = 171;

const TInt KIptvErrorRssSearchSucceed           = 172;

const TInt KIptvErrorRssSearchNoIap             = 173;

const TInt KIptvErrorRssSearchCancelled         = 174;  // Currently used only internally in VoD UI

const TInt KIptvRssSearchContentUpdateCompleted = 175;

const TInt KIptvRssSearchThumbnailCount         = 176; // aInfo is thumbnail count

const TInt KIptvRssSearchContentThumbnailDownloaded = 177; // aInfo is content id

const TInt KIptvThumbnailCount                  = 141; // aInfo is thumbnail count

// EPG manager messages sent to client (LIVE TV ONLY)

const TInt KIptvErrorFailedToLoadPlugin         = 135;

// Notification plugin

const TInt KIptvInstallService                  = 200;

const TInt KIptvDontInstallService              = 201;

const TInt KIptvAddVodService                   = 202;

const TInt KIptvDontAddVodService               = 203;

const TInt KIptvAddVodcastService               = 204;

const TInt KIptvDontAddVodcastService           = 205;

// Provisioning processor

const TInt KIptvSchemaMismatch                  = 301;

const TInt KIptvInvalidServiceType              = 302;

const TInt KIptvInvalidUrl                      = 303;

_LIT( KIptvEpgDbName, "epgdb." );

const TInt KIptvEpgDbLastModifiedMaxLength      = 64;

const TInt KIptvEpgDbXmlFileHashMaxLength       = 20;

const TInt KIptvServiceIdMaxLength              = 10;

// Time

const TInt64 KIptvMinuteAsMicrosecond           = 60000000;

enum                        /* Price list indexes */

    {

    EIptvPriceStream = 0,   /* Streamed */

    EIptvPriceImmediate,    /* Immediate download */

    EIptvPricePostponed,    /* Postponed download */

    EIptvPriceScheduled,    /* Scheduled download */

    EIptvPriceIdList        /* Amount of defined price indexes */

    };

// CenRep: UIDs

//

const TUid KIptvCenRepUid                            = { 0x102750E2 };

const TUid KIptvAlrCenRepUid                         = { 0x2000B438 };

// CenRep: Keys

//

const TInt KIptvCenRepPreferredMemoryKey             = 0x1;

const TInt KIptvCenRepConnectionsKey                 = 0x2;

const TInt KIptvCenRepCellularKey                    = 0x3;

const TInt KIptvCenRepVoDThumbnailsKey               = 0x4;

const TInt KIptvCenRepActiveServiceIdKey             = 0x5;

const TInt KIptvCenRepVideoPlayerVolumeKey           = 0x6;

const TInt KIptvCenRepMainAppServiceFocusKey         = 0x7;

const TInt KIptvCenRepFirstTimeKey                   = 0x8;

const TInt KIptvCenRepServiceUpdatedKey              = 0x9;

const TInt KIptvCenRepUpdatedServiceIdKey            = 0xA;

const TInt KIptvCenRepAPModeKey                      = 0xB;

const TInt KIptvCenRepParentControlKey               = 0xC;

const TInt KIptvCenRepLastPlaybackPositionFeatureKey = 0xD;

const TInt KIptvCenRepUsedSnapIdKey                  = 0x1;

const TInt KIptvCenRepAllowUseGprsKey                = 0x2;

const TInt KIptvCenRepAllowRoamingKey                = 0x3;

const TInt KIptvCenRepMaxUsedMemoryKey               = 0x4;

const TInt KIptvCenRepIadUpdateCheckTimeKey          = 0xA;

// CenRep: Key values

//

const TInt KIptvCenRepPreferredMemoryKeyPhone        = 0;

const TInt KIptvCenRepPreferredMemoryKeyMmc          = 1;

const TInt KIptvCenRepParentControlKeyOff            = 0;

const TInt KIptvCenRepAPModeAlwaysAsk                = 0;

const TInt KIptvCenRepAPModeUserDefined              = 1;

const TInt KIptvCenRepConnectionKeyValueYes          = 1;

const TInt KIptvCenRepConnectionKeyValueNo           = 0;

const TInt KIptvCenRepSnapAlwaysAsk                  = 0;

// CenRep: Default values

//

const TInt KIptvCenRepPreferredMemoryKeyDefault      = KIptvCenRepPreferredMemoryKeyMmc;

const TInt KIptvCenRepFirstTimeKeyDefault            = 8;

const TInt KIptvCenRepParentControlKeyDefault        = KIptvCenRepParentControlKeyOff;

const TInt KIptvCenRepAPModeKeyDefault               = KIptvCenRepAPModeUserDefined;

// DATA TYPES

typedef TUint32 TIptvServiceId;

typedef TUint32 TIptvGroupId;

typedef TUint32 TIptvFolderId;

typedef TUint32 TIptvCategoryId;

typedef TUint32 TIptvContentId;

typedef TUint32 TIptvFileId;

typedef TUint32 TIptvPlayTime;

typedef TReal32 TIptvPrice;

typedef TUint32 TIptvFileSize;

typedef TUint32 TIptvContentLanguage;

typedef enum            /* Content download choises */

    {

    EIptvDownloadTypeStream              = 0x1,

    EIptvDownloadTypeImmediate           = 0x2,

    EIptvDownloadTypePostponed           = 0x4,

    EIptvDownloadTypeScheduled           = 0x8

    } TIptvDownloadType;

// Publish & subscribe properties offered by Iptv Engine with

// IPTV_SERVER_UID category */

typedef enum

    {

    EIptvVodDownloadStateProperty //used by CIptvVodDlClient

    } TIptvServerProperty;

// Filepaths

typedef enum            /* File path choises */

    {

    EIptvPathWritableRoot       = 0x1,      // Root path

    EIptvPathTmp                = 0x2,      // temp folder

    EIptvPathMyVideosDb         = 0x3,      // My Videos DB root

    EIptvPathEcg                = 0x4,      // Content guide storage root

    EIptvPathService            = 0x5,      // Service thumbnails

    EIptvPathMyVideosVideo      = 0x6,      // My Videos video root

    EIptvPathEcgLive            = 0x7,

    EIptvPathTmpLive            = 0x8,

    EIptvPathRssThumbnail       = 0x9,      // vod rss thumbnail path

    EIptvPathRssSearchThumbnail = 0x10      // search thumbnail path

    } TIptvPathSelection;

typedef enum

    {

    EIptvDlNoError,

    EIptvDlOutOfMemory,

    EIptvDlOutOfMemoryInVodDlPluginCreate,

    EIptvDlVodDlPluginNotFound,

    EIptvDlGeneralErrorInVodDlPluginCreate,

    //errors before the download starts

    EIptvDlMessageAlreadyPending,

    EIptvDlTypeNotSupported,

    EIptvDlMaxDownloadsExceeded,

    EIptvDlAlreadyExists,

    KIptvDlCouldNotGetServiceData, //wrong service id?

    EIptvDlEpgManagerNotReady,

    EIptvDlCouldNotGetContentFullDetails,

    EIptvDlFailedToAddNewVideoToMyVideos,

    EIptvDlCouldNotConnectToS60DlMgr,

    EIptvDlCouldNotSetIapAttrToS60DlMgr,

    EIptvDlCouldNotCreateS60Download,

    EIptvDlCouldNotStartS60Download,

    //errors during & after download

    EIptvDlConnectionFailed,// IAP wrong or no network coverage

    EIptvDlAuthFailed,

    EIptvDlProxyAuthFailed,

    EIptvDlContentNotFound, // HTTP 402

    EIptvDlDiskFull,

    EIptvDlDestFileInUse,

    EIptvDlBadUrl,          // Syntax error in url

    EIptvDlMmcRemoved,

    EIptvDlGeneral,         // Wwrong url, content removed, network does not

                            // work, server side leaved with error, ...

    EIptvDlDisconnected,    // Connection to network lost

    EIptvDlContentUnchanged, // ETag or last modified data hasn't been changed

                            // so no need to download the file cause it's not

                            // changed

    EIptvDlInvalidIap,      // Invalid IAP

    EIptvDlNoErrorUpToDate, // No download needed, current content is valid

    EIptvResumingFromBeginning // Resume not possible, starting from beginning

    } TIptvDlError;

// This value is defined here because of the following explanation:

// When download manager does see an http error code (similar to the codes

// listed in TIptvHttpResponse enumeration below) it re-maps that error code

// with "magical" number -25000. This -25000 is defined in HttpDownload.cpp

// file located in \s60\mw\BrowserUtilities\DownloadMgr\DownloadMgrServEng\Src.

// Since the constant is defined in .cpp file we cannot include it in our code.

// This constant is used in TIptvHttpResponse enumeration to map those values

// to the one that is used by download manager -> If download manager ever

// changes the error base value we only modify this constant to make mapping

// correct again.

const TInt KIptvHttpErrorBase               = -25000;

// Url max length in iptv.

// As far as I know url specification allows url to be as big as 2048, but

// S60 (v3.1/w31) download manager crashes if url length goes somewhere around

// 1200-1400 so we need to limit it here. If someone finds out that

// download manager get fixed please feel free to change value to 2048 

const TInt KIptvUrlMaxLength                = 1024;

/**

* Enumeration containing all the supported http response messages.

* These enumerations can be use by the download operations to check

* necessary operations needed when receiving messages from S60

* download manager.

*/

typedef enum

  {

  EHttpResponseContinue                     = KIptvHttpErrorBase - 100,

  EHttpResponseSwitchingProtocols           = KIptvHttpErrorBase - 101,

  EHttpResponseOk                           = KIptvHttpErrorBase - 200,

  EHttpResponseCreated                      = KIptvHttpErrorBase - 201,

  EHttpResponseAccepted                     = KIptvHttpErrorBase - 202,

  EHttpResponseNonAuthoritativeInformation  = KIptvHttpErrorBase - 203,

  EHttpResponseNoContent                    = KIptvHttpErrorBase - 204,

  EHttpResponseResetContent                 = KIptvHttpErrorBase - 205,

  EHttpResponsePartialContent               = KIptvHttpErrorBase - 206,

  EHttpResponseMultipleChoices              = KIptvHttpErrorBase - 300,

  EHttpResponseMovedPermanently             = KIptvHttpErrorBase - 301,

  EHttpResponseFound                        = KIptvHttpErrorBase - 302,

  EHttpResponseSeeOther                     = KIptvHttpErrorBase - 303,

  EHttpResponseNotModified                  = KIptvHttpErrorBase - 304,

  EHttpResponseUseProxy                     = KIptvHttpErrorBase - 305,

  EHttpResponseUnused                       = KIptvHttpErrorBase - 306, // Not used by the protocol

  EHttpResponseTemporaryRedirect            = KIptvHttpErrorBase - 307,

  EHttpResponseBadRequest                   = KIptvHttpErrorBase - 400,

  EHttpResponseUnautorized                  = KIptvHttpErrorBase - 401,

  EHttpResponsePaymentRequired              = KIptvHttpErrorBase - 402,

  EHttpResponseForbidden                    = KIptvHttpErrorBase - 403,

  EHttpResponseNotFound                     = KIptvHttpErrorBase - 404,

  EHttpResponseMethodNotAllowed             = KIptvHttpErrorBase - 405,

  EHttpResponseNotAcceptable                = KIptvHttpErrorBase - 406,

  EHttpResponseProxyAuthenticationRequired  = KIptvHttpErrorBase - 407,

  EHttpResponseRequestTimeout               = KIptvHttpErrorBase - 408,

  EHttpResponseConflict                     = KIptvHttpErrorBase - 409,

  EHttpResponseGone                         = KIptvHttpErrorBase - 410,

  EHttpResponseLengthRequired               = KIptvHttpErrorBase - 411,

  EHttpResponsePreconditionFailed           = KIptvHttpErrorBase - 412,

  EHttpResponseRequestEntityTooLarge        = KIptvHttpErrorBase - 413,

  EHttpResponseRequestUriTooLong            = KIptvHttpErrorBase - 414,

  EHttpResponseUnsupportedMediaType         = KIptvHttpErrorBase - 415,

  EHttpResponseRequestedRangeNotSatisfiable = KIptvHttpErrorBase - 416,

  EHttpResponseExpectationFailed            = KIptvHttpErrorBase - 417,

  EHttpResponseInternalServerError          = KIptvHttpErrorBase - 500,

  EHttpResponseNotImplemented               = KIptvHttpErrorBase - 501,

  EHttpResponseBadGateway                   = KIptvHttpErrorBase - 502,

  EHttpResponseServiceUnavailable           = KIptvHttpErrorBase - 503,

  EHttpResponseGatewayTimeout               = KIptvHttpErrorBase - 504,

  EHttpResponseHttpVersionNotSupported      = KIptvHttpErrorBase - 505

  } TIptvHttpResponse;

/**

 * Vod download states, used in CIptvVodDlDownloadEvent::iState and

 * CIptvVodDownload::iState

 */

/**

 * Created. Event only, download does not stay in this state.

 */

const TUint32 KIptvVodDlDownloadCreated = 0;

/**

 * Not doing anything, does not exist in VOD DL Plugin.

 */

const TUint32 KIptvVodDlDownloadIdle = 1;

/**

 * VOD DL plugin is starting the download.

 */

const TUint32 KIptvVodDlDownloadStarting = 2;

/**

 * VOD DL plugin is downloading, deprecated, use KIptvVodDlDownloadRunning

 * instead.

 */

const TUint32 KIptvVodDlDownloadStarted = 3;

/**

 * VOD DL plugin is downloading.

 */

const TUint32 KIptvVodDlDownloadRunning = 3;

/**

 * Indicates that global file id won't change anymore,

 * ie client can start using it.

 * Event only, download does not stay in this state.

 */

const TUint32 KIptvVodDlDownloadGlobalFileIdIsValid = 4;

/**

 * In queue. Either not created in VOD DL plugin yet or in paused or failed

 * state in VOD DL plugin.

 */

const TUint32 KIptvVodDlDownloadInQueue = 5;

/**

 * VOD DL Manager is pauseing the download temporarily.

 * Paused state is entered when download is paused in VOD DL plugin.

 * This is currently not used, it could be used to pause download

 * temporarily when checking the available disk space for the download.

 */

const TUint32 KIptvVodDlDownloadPausing = 6;

/**

 * Paused, exists in VOD DL Plugin. This state is not published.

 * Idea is to hide short term pauses (less than 10 second) from client.

 */

const TUint32 KIptvVodDlDownloadPaused = 7;

/**

 * VOD DL Manager is pausing the download permanently. It's permanently

 * paused when vod dl plugin sends paused event.

 */

const TUint32 KIptvVodDlDownloadPermanentlyPausing = 8;

/**

 * If KIptvVodDlDownloadPaused state lasts more than

 * KIptvVodDlPermanentPauseDelay this state is entered.

 * This state is published to clients.

 */

const TUint32 KIptvVodDlDownloadPermanentlyPaused = 9;

/**

 * Download finished successfully. Event only, download does not stay in this

 * state.

 */

const TUint32 KIptvVodDlDownloadSucceeded  = 10;

/**

 * Event only, download does not stay in this state.

 */

const TUint32 KIptvVodDlDownloadFailed = 11;

/**

 * After receiving event with this state, no further events will arrive of

 * this download. Download is deleted from VOD DL Manager, file is not

 * deleted from MyVideos.

 * Event only.