/*

* Copyright (c) 2002-2004 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:  Implements one download in DownloadManager

*

*/

#ifndef HTTPDOWNLOAD_H

#define HTTPDOWNLOAD_H

//  INCLUDES

#include "HttpClientAppInstance.h"

#include "HttpConnHandler.h"

#include "DownloadDataServ.h"

#include <httpdownloadmgrcommon.h>

#include <e32base.h>

#include <es_sock.h>

#include <http.h>

// CONSTANTS

const TInt KDownloadNameMaxSize = 256;

// MACROS

//#define ?macro ?macro_def

// DATA TYPES

//enum ?declaration

//typedef ?declaration

//extern ?data_type;

// FUNCTION PROTOTYPES

//?type ?function_name(?arg_list);

// FORWARD DECLARATIONS

// CLASS DECLARATION

class RFs;

class RFile;

class CFileMan;

class CHeaderField;

class CHttpStorage;

/**

*  ?one_line_short_description.

*  ?other_description_lines

*

*  @lib ?library

*  @since Series 60 v2.8

*/

NONSHARABLE_CLASS( CHttpDownload ): public CActive

                                  , public MConnectionCallback

                                  , public MHTTPTransactionCallback

    {

    public:  // Constructors and destructor

        /**

        * Two-phased constructor.

        */

        static CHttpDownload* NewL( const TDesC8& aUrl,

                                    CHttpClientApp *aClientApp,

                                    TInt32 aId,

                                    CHttpClientAppInstance* aClientAppInstance = NULL );

        /**

        * Destructor.

        */

        virtual ~CHttpDownload();

    public: // New functions

        /**

        * Starts download process.

        * @since Series 60 v3.2

        * @return none.

        */

        IMPORT_C void Attach( CHttpClientAppInstance* aClientAppInstance );

        /**

        * Starts download process.

        * @since Series 60 v2.8

        * @return none. Leaves on error.

        */

        IMPORT_C void StartL();

        /**

        * Pauses the download process.

        * @since Series 60 v2.8

        * @param bStore if ETrue download state is stored into file

        * @return none. Leaves on error.

        */

        IMPORT_C void PauseL( TBool bStore = EFalse );

        /**

        * Resets to the download.

        * @since Series 60 v2.8

        * @return none.

        */

        IMPORT_C void Reset();

        /**

        * Deletes the download. Every reference to this object 

        * becomes invalid after this function returns.

        * @since Series 60 v2.8

        * @return none.

        */

        IMPORT_C void Delete( CHttpClientAppInstance* aClAppInstance );

        /**

        * Deletes the info file associated with the download.

        * This can be called only after the download is completed, 

        *  since deletion of the file is illegal when the download is not yet complete.

        * @since Series 60 v3.2

        * @return none.

        */

		IMPORT_C void DeleteInfoFile( CHttpClientAppInstance* aClAppInstance );

        /**

        * Moves/renames download content file. Destination can be

        * specified with EDlAttrDestFilename

        * @since Series 60 v2.8

        * @param none

        * @return none. Leaves on error:

        * KErrNotReady - if download is not completed yet

        * KErrInUse - if move is in progress

        */

        IMPORT_C void MoveL();

        /**

		* Gets the value for a TInt attribute.

		* @param aAttribute Identifies the attribute to be retrived.

		* @param aValue On completion, contains the requested TInt attribute.

        * @return void. Leaves on error:

        * - KErrArgument if requested attribute is unknown or not integer

		*/

		IMPORT_C void GetIntAttributeL( THttpDownloadAttrib aAttribute, 

									    TInt32& aValue );

        /**

		* Gets the value for a TBool attribute.

		* @param aAttribute Identifies the attribute to be retrived.

		* @param aValue On completion, contains the requested TBool attribute.

        * @return void. Leaves on error:

        * - KErrArgument if requested attribute is unknown or not boolean

		*/

		IMPORT_C void GetBoolAttributeL( THttpDownloadAttrib aAttribute, 

                                         TBool& aValue );

		/**

		* Gets the value for a string attribute.

		* @param aAttribute Identifies the attribute to be retrived.

		* @param aValue On completion, contains the requested string. Use a 16-bit descriptor!

        * @return void. Leaves on error:

        * - KErrArgument if requested attribute is unknown or not string

        * - KErrNotFound if requested attribute is not initialized. This can make

        * easier to differentiate between that string is zero length or not allocated yet.

		*/

		IMPORT_C HBufC* GetStringAttributeL( THttpDownloadAttrib aAttribute, 

                                             TBool& aDelete );

		/**

		* Gets the value for a string attribute.

		* @param aAttribute Identifies the attribute to be retrived.

		* @param aValue On completion, contains the requested string. Use a 16-bit descriptor!

        * @return void. Leaves on error:

        * - KErrArgument if requested attribute is unknown or not string

        * - KErrNotFound if requested attribute is not initialized. This can make it

        * easier to differentiate between that string is zero length or not allocated yet.

		*/

		IMPORT_C HBufC8* GetString8AttributeL( THttpDownloadAttrib aAttribute, 

                                               TBool& aDelete );

        /**

        * 

        */

        IMPORT_C RFile* GetFileHandleAttributeL();

        /**

		* Sets the value for a TInt attribute.

		* @param aAttribute Identifies the attribute to be set.

		* @param aValue The value to be set.

        * @return void. Leaves on error:

        * - KErrArgument if requested attribute is unknown or not integer

		*/

		IMPORT_C void SetIntAttributeL( THttpDownloadAttrib aAttribute, 

                                        const TInt32 aValue );

		/**

		* Sets the value for a TBool attribute.

		* This method can be used to stop a connection (KConnectionStop).

		* @param aAttribute Identifies the attribute to be set.

		* @param aValue The value to be set.

        * @return void. Leaves on error:

        * - KErrArgument if requested attribute is unknown or not boolean

		*/

		IMPORT_C void SetBoolAttributeL( THttpDownloadAttrib aAttribute, 

                                         const TBool aValue );

		/**

		* Sets the value for a string attribute.

		* @param aAttribute Identifies the attribute to be set.

		* @param aValue The string value to be set. Must be a 16-bit descriptor!.

        * @return void. Leaves on error:

        * - KErrArgument if requested attribute is unknown or not string

		*/

		IMPORT_C void SetStringAttributeL( THttpDownloadAttrib aAttribute, 

                                           const TDesC16& aValue );

		/**

		* Sets the value for a string attribute.

		* @param aAttribute Identifies the attribute to be set.

		* @param aValue The string value to be set. Must be a 16-bit descriptor!.

        * @return void. Leaves on error:

        * - KErrArgument if requested attribute is unknown or not string

		*/

		IMPORT_C void SetStringAttributeL( THttpDownloadAttrib aAttribute, 

                                           const TDesC8& aValue );

        /**

        * 

        */

        IMPORT_C void SetFileHandleAttributeL( RFile* aFile );

        /**

        * Returns the associated client application instance.

        * @since Series 60 v2.8

        * @return associated client application instance

        */

        IMPORT_C CHttpClientAppInstance* ClientAppInstance() const;

        /**

        * Called only from the server when a leave trapped.

        * This is the place where client app can be informed

        * about this error if not done before.

        * @since Series 60 v2.8

        * @param aError Error code from a previous leave

        * @return none

        */

        IMPORT_C void OnError( TInt aError,

                               THttpDownloadMgrError aDlError = EGeneral );

        /**

		* Gets the value for a TInt attribute.

		* @param aAttribute Identifies the attribute to be retrived.

		* @param aMoIndex Identifies the media object index.

		* @param aValue On completion, contains the requested TInt attribute.

        * @return void. Leaves on error:

        * - KErrArgument if requested attribute is unknown or not integer

		*/

		IMPORT_C void GetIntAttributeL( THttpDownloadAttrib aAttribute, 

									    TInt32& aMoIndex,

									    TInt32& aValue );

        /**

		* Gets the value for a TBool attribute.

		* @param aAttribute Identifies the attribute to be retrived.

		* @param aMoIndex Identifies the media object index.

		* @param aValue On completion, contains the requested TBool attribute.

        * @return void. Leaves on error:

        * - KErrArgument if requested attribute is unknown or not boolean

		*/

		IMPORT_C void GetBoolAttributeL( THttpDownloadAttrib aAttribute, 

		                                 TInt32& aMoIndex,

                                         TBool& aValue );

        /**

		* Gets the value for a string attribute.

		* @param aAttribute Identifies the attribute to be retrived.

		* @param aMoIndex Identifies the media object index.

		* @param aValue On completion, contains the requested string. Use a 16-bit descriptor!

        * @return void. Leaves on error:

        * - KErrArgument if requested attribute is unknown or not string

        * - KErrNotFound if requested attribute is not initialized. This can make

        * easier to differentiate between that string is zero length or not allocated yet.

		*/

		IMPORT_C HBufC* GetStringAttributeL( THttpDownloadAttrib aAttribute, 

		                                     TInt32& aMoIndex,

                                             TBool& aDelete );

        /**

		* Gets the value for a string attribute.

		* @param aAttribute Identifies the attribute to be retrived.

		* @param aMoIndex Identifies the media object index.

		* @param aValue On completion, contains the requested string. Use a 16-bit descriptor!

        * @return void. Leaves on error:

        * - KErrArgument if requested attribute is unknown or not string

        * - KErrNotFound if requested attribute is not initialized. This can make it

        * easier to differentiate between that string is zero length or not allocated yet.

		*/

		IMPORT_C HBufC8* GetString8AttributeL( THttpDownloadAttrib aAttribute, 

		                                       TInt32& aMoIndex,

                                               TBool& aDelete );

		/**

		* Sets the value for a string attribute.

		* @param aAttribute Identifies the attribute to be set.

		* @param aMOIndex - media object index.

		* @param aValue The string value to be set. Must be a 16-bit descriptor!.

        * @return void. Leaves on error:

        * - KErrArgument if requested attribute is unknown or not string

		*/

        IMPORT_C void SetStringAttributeL( THttpDownloadAttrib aAttribute, const TInt32 aMOIndex,

								                  const TDesC16& aValue );

        /**

		* Sets the Download data (media info).

		*/

        IMPORT_C void SetDownloadDataAttributeL(HBufC8* dlData);

        /**

        * Sets the media object data (track info).

        */

        IMPORT_C void SetTrackDataAttributeL(TInt aIndex, HBufC8* dlData);

        /**

        * Detach the given client instance from the download.

        * @param aInstance client app instance to be detached

        * @return ETrue if download is still attached to another instance

        */                                

        IMPORT_C TBool DetachClientInstance( CHttpClientAppInstance* aInstance );

        /**

        * Return the client application where this download is created.

        * @since Series 60 v2.8

        * @return client application where this download is created

        */

        CHttpClientApp* ClientApp() const;

        /**

        * Returns the associated PD client application instance.

        * @since Series 60 v3.2

        * @return associated PD client application instance

        */

        CHttpClientAppInstance* PDClientAppInstance() const;

        /**

        * Returns the unique download id.

        * @since Series 60 v2.8

        * @return unique id of this download

        */

        TInt Id() const;

        /**

        * Returns the state of this download. 

        * @since Series 60 v2.8

        * @return state of this download

        */

        THttpDownloadState State() const;

        /**

        * Returns the progress state of the download.

        * @since Series 60 v2.8

        * @return progress state of this download

        */

        THttpProgressState ProgState() const;

        /**

        * Returns associated connection handler.

        * @since Series 60 v2.8

        * @return associated connection handler

        */

        CHttpConnHandler* ConnHandler() const;

        /**

        * Return EDlAttrNoMedia

        * @since Series 60 v2.8

        * @return ETrue if media is removed

        */

        TBool NoMedia() const;

        /**

        * Called when media card removed.

        * @since Series 60 v2.8

        * @return none.

        */

        void MediaRemoved( TUint aUid, TBool aDontCheckMediaUid = EFalse );

        /**

        * Called when media card inserted.

        * @since Series 60 v2.8

        * @return none.

        */

        void MediaInserted( TUint aUid );

        /**

        * Returns the current download destination drive id.

        * @since Series 60 v2.8

        * @return none.

        */

        TInt GetDestinationDriveID() const;

        /**

        * Associates download with the given client instance.

        * @since Series 60 v2.8

        * @param aInstance client instance this download to be associated with

        * @param aNoMoveEvent if ETrue move event disabled

        * @return none.

        */

        void SetClientInstance( CHttpClientAppInstance* aInstance,

                                TBool aNoMoveEvent = EFalse );

        /**

        * Associates download with the given connection handler

        * @since Series 60 v2.8

        * @param aConnHandler connection handler this download to be associated with

        * @return ?description

        */

        void SetConnHandler( CHttpConnHandler* aConnHandler );

        /**

        * Returns pausable state of the download

        */

        TBool Pausable() const;

        /**

        * Sets a new download name. Triggers EHttpProgDlNameChanged event.

        * @param aNewName new download name

        * @return none. Leaves on error.

        */

        void SetDownloadNameL( const TDesC& aNewName );

        void Ref() { ++iRefCount; }

        void Deref() { if( --iRefCount == 0 ) delete this; }

    public: // Functions from base classes

        /**

        * methods from MHTTPTransactionCallback

        */

        virtual void MHFRunL(RHTTPTransaction aTransaction, const THTTPEvent& aEvent);

        virtual TInt MHFRunError(TInt aError, RHTTPTransaction aTransaction, const THTTPEvent& aEvent);

        /**

        * methods from CActive

        */

	    virtual void DoCancel();

	    virtual void RunL();

        virtual TInt RunError(TInt aError);

        /**

        * methods from MConnectionCallback

        */

        void Connected();

        void Suspended();

        void Disconnected();

        void ConnectionFailed( TInt aError );

    protected:  // New functions

        /**

        * Does real reset on download

        * @since Series 60 v2.8

        * @param aOnDelete if ETrue function called on delete

        * @return none.

        */

        void DoReset( TBool aOnDelete = EFalse );

        /**

        * Stores download info into file.

        * @since Series 60 v2.8

        * @return none. Leave on error.

        */

        void StoreDownloadInfoL();

        /**

        * Loads download info from file.

        * @since Series 60 v2.8

        * @return none. Leaves on failure.

        */

        void LoadDownloadInfoL();

        /**

        * Checks that (if known) that content

        * is still valid or expired.

        * @since Series Series60

        * @return ETrue if content is expired

        */

        TBool IsExpired();

        /**

        * Called if download completed.

        * @since Series 60 v2.8

        * @param ?arg1 ?description

        * @return ?description

        */

        void OnCompletedL();

       /**

        * Checks that if content type is of file storage type 

        * @return ETrue if content is of file storage type

        */

        TBool IsContentFileStorageType();

        /**

        * Reinitialize download. 

        * @since Series 60 v2.8

        */

        void ReInitializeDownload();

        /**

        * Cancels transaction.

        * @since Series 60 v2.8

        * @return none.

        */

        void CancelTransaction();

        /**

        * Pauses the download process.