/*

* Copyright (c) 2003, 2004 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:  Class to show miscellaneous DRM related error notes and 

*                details about rights 

*

*/

#ifndef __DRMHELPER_H__

#define __DRMHELPER_H__

//  INCLUDES

#include <e32base.h>

#include <ConeResLoader.h>

#include <apparc.h>

#include <rdrmhelper.h>

#include <AknServerApp.h>

#include <caf/caf.h>

#include <caf/content.h>

#include <caf/data.h>

#include <eikdialg.h>

using namespace ContentAccess;

// CONSTANTS

const TInt KDRMHelperDefaultCountThreshold = 3;

const TInt KDRMHelperDefaultTimeThreshold = 7;

const TInt KDRMHelperDefaultPercentageThreshold = 10;

const TInt KDRMHelperNoteMaxSize ( 256 );  

// MACROS

// DATA TYPES

enum TDRMHelperPreviewMediaType

        {

        EPreviewTypeAudio,

        EPreviewTypeVideo

        };

// FUNCTION PROTOTYPES

// FORWARD DECLARATIONS

class DRMCommon;

class CDRMRightsConstraints;

class CDRMRights;

class CStringResourceReader;

class TDataType;

class CCoeEnv;

class CConsumeData;

class CDRMPermission;

class CDRMConstraint;

class CAknGlobalNote;

class CAknWaitDialog;

class CDRMHelperInfoNoteWrapper;

class CMediatorEventProvider;

// CLASS DECLARATION

/**

*  Helper class for wrapping CDRMRightsConstraints.

*

*  @lib drmhelper.lib

*  @since Series 60 2.1

*/

class CDRMHelperRightsConstraints : public CBase

    {

    public:  // Constructors and destructor

        /**

        * Two-phased constructor.

        */

        static CDRMHelperRightsConstraints* NewL( 

            CDRMRightsConstraints* aConstraints );

        static CDRMHelperRightsConstraints* NewLC( 

            CDRMRightsConstraints* aConstraints );

        /**

        * Destructor.

        */

        IMPORT_C ~CDRMHelperRightsConstraints();

    public: // New functions

        /**

        * checks if the object contains any restrictions 

        * or if usage is unconstrained.        

        * @return ETrue if usage is unconstrained

        */

        IMPORT_C TBool FullRights();

        /**

        * checks if the object contains only preview rights 

        * @return ETrue if object contains only preview rights

        */

        IMPORT_C TBool IsPreview();

        /**

        * Gets number of counts left and number of original counts.

        * Leaves with KErrNotFound if object doesn't have count based rights.

        * @param aCounter: (out) counts left

        * @param aOriginalCounter: (out) number of counts when stored to 

        *                          rights db

        * @return -

        */

        IMPORT_C void GetCountersL( TUint32& aCounter, 

            TUint32& aOriginalCounter );

        /**

        * Gets start time of time based rights.

        * Leaves with KErrNotFound if object doesn't have time based rights.

        * @param aStartTime: (out) start time

        * @return -

        */

        IMPORT_C void GetStartTimeL( TTime& aStartTime );

        /**

        * Gets end time of time based rights.

        * Leaves with KErrNotFound if object doesn't have time based rights.

        * @param aEndTime: (out) start time

        * @return -

        */

        IMPORT_C void GetEndTimeL( TTime& aEndTime );

        /**

        * Gets interval time constraint.

        * Leaves with KErrNotFound if object doesn't have interval constraint.

        * @param aInterval: (out) interval

        * @return -

        */

        IMPORT_C void GetIntervalL( TTimeIntervalSeconds& aInterval );

        /**

        * Gets start time of activated interval constraint.

        * Leaves with KErrNotFound if interval has not been started yet.

        * @param aStartTime: (out) start time of activated interval

        * @return -

        */

        IMPORT_C void GetIntervalStartL( TTime& aStartTime );

        /**

        * Gets number of counts left, number of original counts and timer 

        * value for timed-count constraint.

        * Leaves with KErrNotFound if object doesn't have timed-count 

        * constraint.

        * @param aCounter: (out) counts left

        * @param aOriginalCounter: Invalid, value returned same as aCounter

        * @param aTimer: (out) timer value

        * @return -

        * @since Series 60 3.0

        */

        IMPORT_C void GetTimedCountL( TUint32& aCounter, 

            TUint32& aOriginalCounter, TTimeIntervalSeconds& aTimer );

        /**

        * Gets accumulated time left.

        * Leaves with KErrNotFound if object doesn't have accumulated time 

        * constraint.

        * @param aAccumulatedTime: (out) accumulated time left

        * @return -

        * @since Series 60 3.0

        */

        IMPORT_C void GetAccumulatedTimeL( TTimeIntervalSeconds& aAccumulatedTime );

    private:

        /**

        * C++ default constructor.

        */

        CDRMHelperRightsConstraints( CDRMRightsConstraints* aConstrains );

        /**

        * By default Symbian 2nd phase constructor is private.

        */

        void ConstructL();

    private:    // Data

        // pointer to CDRMRightsConstraints object

        CDRMRightsConstraints* iConstraints;

    };

/**

*  Handles some error situations DRM-aware applications may encounter.

*

*  @lib drmhelper.lib

*  @since Series 60 2.1

*/

class CDRMHelper : public CBase, public MAknServerAppExitObserver

    {

    public:     // Data

    enum TDRMHelperNotificationID

        {

        ETActivateTextId = 1,

        ETCountBasedErrorTextId = 2 ,

        ETCountUsageReduceId = 3,

        ETCountUsageReduceMediaId = 4

        };

    enum TDRMHelperConsumeAction

        {

        EStart,

        EFinish,

        EPause, 

        EContinue

        };

    enum TDRMHelperOMALevel

        {

        EOMA_None, 

        EOMA_1_0,

        EOMA_2_0

        };

	enum TDRMHelperPreviewType 

		{

		ENoPreview, 

		EEmbeddedPreview,

		EPreviewRights

		};

    enum TDRMHelperAutomatedType

        {

        EAutomatedTypeRingingTone,

        EAutomatedTypeMessageAlert,

        EAutomatedTypeEmailAlert,

        EAutomatedTypeIMAlert,

        EAutomatedTypeCalendarAlarm,

        EAutomatedTypeScreenSaver,

        EAutomatedTypeWallpaper, 

        EAutomatedTypeTheme,

        EAutomatedTypeClockAlarm, 

        EAutomatedTypeOther = KMaxTUint8

        };

    enum TDRMHelperDRMMethods

        {

        EForwardLock = 0x0001, 

        ECombinedDelivery = 0x0002, 

        ESeparateDelivery = 0x0004, 

        ESuperDistribution = 0x0008

        };

    public:  // Constructors and destructor

        /**

        * Two-phased constructor.

        */

        IMPORT_C static CDRMHelper* NewL( CCoeEnv& aCoeEnv );

        IMPORT_C static CDRMHelper* NewLC( CCoeEnv& aCoeEnv );

        /**

        * Two-phased constructor.

        * @since Series 60 2.6

        */

        IMPORT_C static CDRMHelper* NewL();

        IMPORT_C static CDRMHelper* NewLC();

        /**

        * Two-phased constructor.

        * @since Series 60 3.0

        */

        IMPORT_C static CDRMHelper* NewL( CCoeEnv& aCoeEnv, RFs& aFs );

        IMPORT_C static CDRMHelper* NewLC( CCoeEnv& aCoeEnv, RFs& aFs );

        /**

        * Two-phased constructor.

        * @since Series 60 3.0

        */

        IMPORT_C static CDRMHelper* NewL( RFs& aFs );

        IMPORT_C static CDRMHelper* NewLC( RFs& aFs );

        /**

        * Destructor.

        */

        IMPORT_C ~CDRMHelper();

    public: 

        /**

        * Displays appropriate error note depending on error code.

        * @param aError: error code returned by DRM engine

        * @param aURI: URI of the file

        * @return 

        * - Button code, if user selected "buy rights" or "launch rights 

        *   manager" in query.

        * - 0 if user selected "No", "Back" or "Cancel" (or whatever which 

        *   just dismiss the query)

        * - 0 if just a simple error note is displayed

        */

        IMPORT_C TInt HandleErrorL( TInt aError, 

            const TDesC8& aURI );

        /**

        * Displays:

        * Handles error situations 'rights expired', 'no rights' and

        * 'rights database corrupted'.

        * @param aError: error code returned by DRM engine

        * @param aFileName: full path to file

        * @return 

        * - Button code, if user selected "buy rights" or "launch rights 

        *   manager" in query.

        * - 0 if user selected "No", "Back" or "Cancel" (or whatever which 

        *   just dismiss the query)

        * - 0 if just a simple error note is displayed

        */

        IMPORT_C TInt HandleErrorL( TInt aError, 

            const TDesC& aFileName );

        /**

        * Displays:

        * Handles error situations 'rights expired', 'no rights' and

        * 'rights database corrupted'.

        * @param aError: error code returned by DRM engine

        * @param aFileHandle: file handle to the file

        * @return 

        * - Button code, if user selected "buy rights" or "launch rights 

        *   manager" in query.

        * - 0 if user selected "No", "Back" or "Cancel" (or anything that 

        *   just dismisses the query)

        * - 0 if just a simple error note is displayed

        * @since  3.0

        */

        IMPORT_C TInt HandleErrorL( TInt aError, 

            RFile& aFileHandle );

       /**

        * Handles DRM-specific error situations. Should be called instead of 

        * HandleErrorL if user should be asked to play embedded preview or get 

        * preview/silent rights if there is no valid rights and either embedded preview or

        * preview rights are available.

        * @param aError: error code to be handled.

        * @param aFile: handle of file for which error was received.

        * @param aEmbeddedPreviewUri: contain URI of embedded preview part 

        * upon return if caller should play the embedded preview. If embedded

        * preview should not be played this is NULL. Must be freed by caller.

        * @return KErrNone if the content is now usable (e.g. silent rights or preview rights were gotten). If

        *                  the return code is KErrNone and the aEmbeddedPreviewUri parameter is not NULL,

        *                  the player should use embedded preview

        *         KErrCancel if the user cancelled any of the actions within the function

        *         KErrCANoRights and KErrCANoPermission if after the function call, still no rights exist

        *         KErrCompletion if the user did launch the browser, but it is not clear whether the content

        *                  was activated

        * @since S60 3.1

        */

        IMPORT_C TInt HandleErrorOrPreviewL( 

            TInt aError, 

            RFile& aFile, 

            HBufC8*& aEmbeddedPreviewUri );

       /**

        * Handles DRM specific error situations. Should be called instead of 

        * HandleErrorL if user should be asked to play embedded preview or get 

        * preview/silent rights if there is no valid rights and either embedded preview or

        * preview rights are available.

        * @param aError: error code to be handled.

        * @param aFileName: name of file for which error was received.

        * @param aEmbeddedPreviewUri: contain URI of embedded preview part 

        * upon return if caller should play the embedded preview. If embedded

        * preview should not be played this is NULL. Must be freed by caller.

        * @return KErrNone if the content is now usable (e.g. silent rights or preview rights were gotten). If

        *                  the return code is KErrNone and the aEmbeddedPreviewUri parameter is not NULL,

        *                  the player should use embedded preview

        *         KErrCancel if the user cancelled any of the actions within the function

        *         KErrCANoRights and KErrCANoPermission if after the function call, still no rights exist

        *         KErrCompletion if the user did launch the browser, but it is not clear whether the content

        *                  was activated

        * @since S60 3.1

        */

        IMPORT_C TInt HandleErrorOrPreviewL( 

            TInt aError, 

            const TDesC& aFileName, 

            HBufC8*& aEmbeddedPreviewUri );

        /**

        * Check rights for the content. If there is less than given amount 

        * of usage time/count left, appropriate note is displayed

        * depending on situation.

        * @param  aURI: URI of the file

        * @return Button code

        */

        // causes conflict with other CheckRightsAmount method, removed for now...

//        IMPORT_C TInt CheckRightsAmountL( const TDesC8& aURI );

        /**

        * Check rights for the file. If there is less than given amount 

        * of usage time/count/percentage left, appropriate note is displayed

        * depending on situation.

        * @param  aFileName: Full path to file

        * @return Button code

        */

        // causes conflict with other CheckRightsAmount method, removed for now...

//        IMPORT_C TInt CheckRightsAmountL( const TDesC& aFileName );

        /**

        * Check rights for the file. If there is less than given amount 

        * of usage time/count/percentage left, appropriate note is displayed

        * depending on situation.

        * @param  aFileHandle: file handle to the file

        * @return Button code

        * @since  3.0

        */

        // causes conflict with other CheckRightsAmount method, removed for now...

//        IMPORT_C TInt CheckRightsAmountL( RFile& aFileHandle );

        /**

        * Check rights for the file. If there is less than given amount 

        * of usage time/count left, one of the following note is displayed

        * depending on situation:

        * 'Usage rights about to expire. View details?'

        * 'Usage rights about to expire. %N days left. View details?'

        * 'Usage rights about to expire. 1 day left. View details?'

        * 'Usage rights about to expire. %N counts left. View details?'

        * 'Usage rights about to expire. 1 count left. View details?'

        * It also checks that rights are valid and displays appropriate note,

        * if they are not.

        * @param  aFileName: Full path to file

        * @param  aCount: Threshold value for count limit

        * @param  aDays: Threshold value for time limit in days

        * @return Button code

        */

        IMPORT_C TInt CheckRightsAmountL( const TDesC& aFileName, 

            TInt aCount = KDRMHelperDefaultCountThreshold, 

            TInt aDays = KDRMHelperDefaultTimeThreshold );

        /**

        * Check rights for the file. If there is less than given amount 

        * of usage time/count left, one of the following note is displayed

        * depending on situation:

        * 'Usage rights about to expire. View details?'

        * 'Usage rights about to expire. %N days left. View details?'

        * 'Usage rights about to expire. 1 day left. View details?'

        * 'Usage rights about to expire. %N counts left. View details?'

        * 'Usage rights about to expire. 1 count left. View details?'

        * It also checks that rights are valid and displays appropriate note,

        * if they are not.

        * @param  aFileHandle: file handle to the file

        * @param  aCount: Threshold value for count limit

        * @param  aDays: Threshold value for time limit in days

        * @return Button code

        * @since  3.0

        */

        IMPORT_C TInt CheckRightsAmountL( RFile& aFileHandle, 

            TInt aCount = KDRMHelperDefaultCountThreshold, 

            TInt aDays = KDRMHelperDefaultTimeThreshold );

        /**

        * Check rights for the file. If there is less than given amount 

        * of usage time/count left, one of the following note is displayed

        * depending on situation:

        * 'Usage rights about to expire. View details?'

        * 'Usage rights about to expire. %N days left. View details?'

        * 'Usage rights about to expire. 1 day left. View details?'

        * 'Usage rights about to expire. %N counts left. View details?'

        * 'Usage rights about to expire. 1 count left. View details?'

        * It also checks that rights are valid and displays appropriate note,

        * if they are not.

        * @param  aUri: Content URI

        * @param  aCount: Threshold value for count limit

        * @param  aDays: Threshold value for time limit in days

        * @return Button code

        */

        IMPORT_C TInt CheckRightsAmountL( const TDesC8& aUri, 

            TInt aCount = KDRMHelperDefaultCountThreshold, 

            TInt aDays = KDRMHelperDefaultTimeThreshold );

        /**

        * Check rights for the file. If there is less than aThreshold percent 

        * of usage time/count left, one of the following note is displayed

        * depending on situation:

        * 'Usage rights about to expire. View details?'

        * 'Usage rights about to expire. %N days left. View details?'

        * 'Usage rights about to expire. 1 day left. View details?'

        * 'Usage rights about to expire. %N counts left. View details?'

        * 'Usage rights about to expire. 1 count left. View details?'

        * It also checks that rights are valid and displays appropriate note,

        * if they are not.

        * @param  aFileName: Full path to file

        * @param  aThreshold: Threshold value in percents for displaying the note

        * @return Button code

        */

        IMPORT_C TInt CheckRightsPercentL( const TDesC& aFileName, 

            TInt aThreshold = KDRMHelperDefaultPercentageThreshold );

        /**

        * Check rights for the file. If there is less than aThreshold percent 

        * of usage time/count left, one of the following note is displayed

        * depending on situation:

        * 'Usage rights about to expire. View details?'

        * 'Usage rights about to expire. %N days left. View details?'

        * 'Usage rights about to expire. 1 day left. View details?'

        * 'Usage rights about to expire. %N counts left. View details?'

        * 'Usage rights about to expire. 1 count left. View details?'

        * It also checks that rights are valid and displays appropriate note,

        * if they are not.

        * @param  aFileHandle: file handle to the file

        * @param  aThreshold: Threshold value in percents for displaying the note

        * @return Button code

        * @since  3.0

        */

        IMPORT_C TInt CheckRightsPercentL( RFile& aFileHandle, 

            TInt aThreshold = KDRMHelperDefaultPercentageThreshold );

        /**

        * Launches DRM Rights Manager UI embedded with details view related 

        * to given content.