/*

* 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:  This file contains the definition of the Client interface of Download Mgr Server.

*

*/

#ifndef __DOWNLOADMGR_CLIENT_H__

#define __DOWNLOADMGR_CLIENT_H__

//  INCLUDES

#include <e32base.h>

#include <f32file.h>

#include <HttpDownloadMgrCommon.h>

#include <http.h>

// FORWARD DECLARATIONS

class CDownloadMgrHandler;

class RHttpDownload;

class MHttpDownloadMgrObserver;

class CDefaultAttrib;

class CRHttpDownloadExtension;

class CRHttpDownloadMgrExtension;

class CRHttpDlExtension;

class CEikonEnv;

class CTransactionObserver;

class THttpTransactionCallback;

class CCodDownload;

class CCodObserver;

/**

* Calculate a hash and in the form of a 32 character hex result.

* @param aMessage Source.

* @param aHash Hash value.

* @return None.        

*/

void HashL( const TDesC8& aMessage, TDes8& aHash );

// TYPEDEFS

typedef CArrayPtrFlat< RHttpDownload > CDownloadArray;

typedef CArrayPtrFlat< MHttpDownloadMgrObserver >  CDownloadMgrObserver;

// CLASS DECLARATION

/**

*  Contains download states

*

*  @lib -

*  @since Series 60 2.8

*/

NONSHARABLE_CLASS( THttpDownloadEvent )

    {

    public: // Data

        // download state

        THttpDownloadState iDownloadState;

        // download progress state

        THttpProgressState iProgressState;

    };

/**

*  Provides the interface for notification of events from a Download Manager 

*  session and its subsessions.

*

*  @lib -

*  @since Series 60 2.8

*/

class MHttpDownloadMgrObserver

    {

    public:

        /**

        * Indicates an event.

        * @param aDownload The download with which the event occured.

        * @param aEvent Event type.

        * @return None.

        */

        virtual void HandleDMgrEventL( RHttpDownload& aDownload, THttpDownloadEvent aEvent ) = 0;

    };

/**

*  Provides the interface for sending next uri to 

*  the client when downloading OMA or COD.

*

*  @lib -

*  @since Series 60 3.0

*/

class MHttpDownloadMgrNextUriObserver

    {

    public:

        /**

        * Send next uri to the client. The client can then handle it.

        * @param aDownload Reference to the download.

        * @param aUri Next URI of the OMA or COD download.

        * @return None.

        */

        virtual void NextUriL( RHttpDownload& aDownload, const TDesC8& aUri ) = 0;

    };

/**

*  Creates a download manager session and performs operations on it 

*

*  @lib -

*  @since Series 60 2.8

*/

NONSHARABLE_CLASS( RHttpDownloadMgr ) : public RSessionBase,

                                        public MHttpDownloadMgrObserver

	{

    public:

        /**

        * C++ default constructor.

        */

        IMPORT_C RHttpDownloadMgr();

    public:  // New functions

        /**

        * Creates a download manager session.

        * @param aAppUid Client application's UID.

        * @param aObserver Observer

        * @param aMaster Indicates whether (if ETrue) this instance 

        * inherints all downloads of other instances. (stand-alone app flag).

        * @return None.

        */

        IMPORT_C void ConnectL( TUid aAppUid,

                                MHttpDownloadMgrObserver& aObserver,

                                TBool aMaster );

        /**

        * Gives version information.

        * @param -

        * @return TVersion Contains version information.

        */

        IMPORT_C TVersion Version() const;

        /**

        * Closes download manager session.

        * @param -

        * @return None.

        */

        IMPORT_C void Close();

        /**

        * Returns a list of the current downloads.

        * @param -

        * @return CDownloadArray

        */

        IMPORT_C const CDownloadArray& CurrentDownloads() const;

        /**

        * Creates a new download subsession.

        * @param aUrl The url to be downloaded.

        * @param aResult The result is true if the download is created.

        * If the URL is already being downloaded the seult is false.

        * @return RHttpDownload&

        */

        IMPORT_C RHttpDownload& CreateDownloadL( const TDesC8& aUrl, TBool& aResult );

        /**

        * Creates a new download subsession. It creates a new one even

        * if the URL is already beeing downloaded.

        * @param aUrl The url to be downloaded.

        * If the URL is already being downloaded the seult is false.

        * @return RHttpDownload&

        */

        IMPORT_C RHttpDownload& CreateDownloadL( const TDesC8& aUrl );

        /**

        * Creates a new download in client side.

        * @param aHttpTransaction http transaction.

        * @param aResult The result is true if the download is created.

        * If the URL is already being downloaded the seult is false.        

        */

        IMPORT_C RHttpDownload& CreateClientSideDownloadL( TInt aHttpTransaction,TBool& aResult );

        /**

        * Creates a new download subsession for COD.

        * @param aUrl The url from the COD is downloaded.

        * @param aBuf The COD descriptor.

        * @param aMimeType The mimetype.

        * @param aEikEnv Eikon environment or NULL. Can be NULL if download

        * does not require UI functionality.        

        * @param aResult The result is true if the download is created.       

        * If the URL is already being downloaded the seult is false.

        * @return RHttpDownload&

        */

        IMPORT_C RHttpDownload& CreateCodDownloadL( const TDesC8& aUrl,

                                                    const TDesC8& aBuf,

                                                    const TDesC8& aMimeType,

                                                    CEikonEnv* aEikEnv,

                                                    TBool& aResult );

        /**

        * Finds if the download is already created

        * @since 2.8

        * @param aUrl given URL

        * @param aMsgBody Message body from post operation

        * @return Returns a pointer to the found download or null.

        *         This pointer is NOT owned by the client!

        */        

        IMPORT_C RHttpDownload* FindDownload( const TDesC8& aUrl, const TDesC8& aMsgBody );

        /**

        * Pauses all downloads.

        * @param -

        * @return None.

        */

        IMPORT_C TInt PauseAll();

        /**

        * Resumes all downloads.

        * @param -

        * @return None.

        */

        IMPORT_C TInt StartAll();

        /**

        * Resets all downloads.

        * @param -

        * @return None.

        */

        IMPORT_C TInt ResetAll();

        /**

        * Deletes all downloads.

        * @param -

        * @return None.

        */

        IMPORT_C TInt DeleteAll();

        /**

        * Disconnect the http connection and pauses all downloads.

        * @param -

        * @return None.

        */

        IMPORT_C TInt Disconnect();

		/**

		* 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 None.

		*/

		IMPORT_C TInt GetIntAttribute( const TUint 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 None.

		*/

		IMPORT_C TInt GetBoolAttribute( const TUint aAttribute, TBool& aValue );

		/**

		* Gets the value for a TDes16 attribute.

		* @param aAttribute Identifies the attribute to be retrived.

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

        * @return None.

		*/

		IMPORT_C TInt GetStringAttribute( const TUint aAttribute, TDes16& aValue  );

		/**

		* Gets the value for a TDes8 attribute.

		* @param aAttribute Identifies the attribute to be retrived.

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

        * @return None.

		*/

        IMPORT_C TInt GetStringAttribute( const TUint aAttribute, TDes8& aValue  );

		/**

		* Sets the value for a TInt attribute.

		* @param aAttribute Identifies the attribute to be set.

		* @param aValue The value to be set.

        * @return None.

		*/

		IMPORT_C TInt SetIntAttribute( const TUint aAttribute, TInt32 aValue );

		/**

		* Sets the value for a TBool attribute.

		* @param aAttribute Identifies the attribute to be set.

		* @param aValue The value to be set.

        * @return None.

		*/

		IMPORT_C TInt SetBoolAttribute( const TUint aAttribute, TBool aValue );

		/**

		* Sets the value for a TDesC attribute.

		* @param aAttribute Identifies the attribute to be set.

		* @param aValue The value to be set.

        * @return None.

		*/

		IMPORT_C TInt SetStringAttribute( const TUint aAttribute, const TDesC16& aValue );

		/**

		* Sets the value for a TDesC8 attribute.

		* @param aAttribute Identifies the attribute to be set.

		* @param aValue The value to be set.

        * @return None.

		*/

        IMPORT_C TInt SetStringAttribute( const TUint aAttribute, const TDesC8& aValue );

		/**

		* Sets the value for the default TInt attribute.

		* @param aAttribute Identifies the attribute to be set.

		* @param aValue The value to be set.

        * @return None.

		*/

		IMPORT_C TInt SetDefaultIntAttribute( const TUint aAttribute, TInt32 aValue );

		/**

		* Sets the value for the default TBool attribute.

		* @param aAttribute Identifies the attribute to be set.

		* @param aValue The value to be set.

        * @return None.

		*/

		IMPORT_C TInt SetDefaultBoolAttribute( const TUint aAttribute, TBool aValue );

		/**

		* Sets the value for the default TDesC attribute.

		* @param aAttribute Identifies the attribute to be set.

		* @param aValue The value to be set.

        * @return None.

		*/

		IMPORT_C TInt SetDefaultStringAttribute( const TUint aAttribute, const TDesC16& aValue );

		/**

		* Sets the value for the default TDesC8 attribute.

		* @param aAttribute Identifies the attribute to be set.

		* @param aValue The value to be set.

        * @return None.

		*/

        IMPORT_C TInt SetDefaultStringAttribute( const TUint aAttribute, const TDesC8& aValue );

		/**

		* Adds client to the observer list.

		* @param aObserver Observer.

        * @return None.

		*/

        IMPORT_C void AddObserverL( MHttpDownloadMgrObserver& aObserver );

		/**

		* Removes client from the observer list.

		* @param aObserver Observer.

        * @return None.

		*/

        IMPORT_C void RemoveObserver( MHttpDownloadMgrObserver& aObserver );

		/**

		* Set next uri observer.

		* @param aObserver Observer.

        * @return None.

		*/        

        IMPORT_C void SetNextUriObserver( MHttpDownloadMgrNextUriObserver* aObserver );

    protected: // from MHttpDownloadMgrObserver

        /**

        * Indicates an event.

        * @param aDownload The download with which the event occured.

        * @param aEvent Event type.

        * @return None.

        */

        void HandleDMgrEventL( RHttpDownload& aDownload, THttpDownloadEvent aEvent );

    private:

        /**

        * Indicates the session's event.

        * @param aHandle Unique identifier of server side subsession.

        * @param aEvent Event type.

        * @return None.

        */

        void HandleSessionEventL( TInt aHandle, THttpDownloadEvent aEvent );

    private:  // New functions

        /**

        * Creates a download manager session.

        * @param aAppUid Client application's UID.

        * @param aObserver Observer

        * @param aMaster Indicates whether (if ETrue) this instance 

        * inherints all downloads of other instances. (stand-alone app flag).

        * @return None.

        */

        void DoConnectL( TUid aAppUid,

                         MHttpDownloadMgrObserver& aObserver,

                         TBool aMaster );

        /**

        * Initializes the download manager session.

        * @param aAppUid Client app's UID.

        * @param aObserver Observer to add to the observer list.

        * @param aMaster Indicates whether (if ETrue) this instance 

        * inherints all downloads of other instances. (stand-alone app flag).

        * @return None.

        */

        void InitializeL( TUid aAppUid,

                          MHttpDownloadMgrObserver& aObserver,

                          TBool aMaster );

    protected: // New functions

        /**

        * Adds the created download to the list. If it is already added, 

        * then it will do nothing.

        * @param aElement Download subsession.

        * @return RHttpDownload& reference to the added item in the list.

        */

        RHttpDownload& AddToArrayL( RHttpDownload* aElement );

    private:  // New functions

        /**

        * Removes the download from the list.

        * @param aElement Download subsession.

        * @return None.

        */

        void RemoveFromArray( RHttpDownload* aElement );

        /**

        * Finds the download in the list.

        * @param aElement Download subsession.

        * @param aIndex Index of the element found.

        * @return KErrNone if found, KErrNotFound otherwise..

        */

        TInt FindInArray( RHttpDownload* aElement, TInt& aIndex ) const;

        /**

        * Returns a reference to the download identified by a handle.

        * @param aHandle Handle identifier.

        * @return RHttpDownload&

        */

        RHttpDownload& DownloadFromHandleL( TUint aHandle );

        /**

        * Finds observer based on index.

        * @param aObserver Observer found.

        * @param aIndex Index.

        * @return TInt

        */

        TInt FindObserver( MHttpDownloadMgrObserver& aObserver, TInt& aIndex ) const;

        /**

        * Attach client to the session.

        * @param aBuf Buffer to the subsession IDs.

        * @return None.

        */

        void AttachL( TDes8& aBuf );

        /**

        * Close a download subsession.

        * @param aElement Download subsession.

        * @return None.

        */

        void CloseDownload( RHttpDownload* aElement );

		/**

		* Packes the default values of the attributes.

		* @param -

        * @return bbuffer of the packed attribs.

		*/

        HBufC8* PackedDefaultAttributesLC();

		/**

		* Sets the default value for the TInt32 attribute.

		* @param aAttribute Identifies the attribute to be set.

		* @param aValue The value to be set.

        * @return None.

		*/

        void DoSetDefaultAttributeL( const TUint aAttribute, TInt32 aValue );

		/**

		* Sets the default value for the TBool attribute.

		* @param aAttribute Identifies the attribute to be set.

		* @param aValue The value to be set.

        * @return None.

		*/

        void DoSetDefaultAttributeL( const TUint aAttribute, TBool aValue );

		/**

		* Sets the default value for the TDesC8 attribute.

		* @param aAttribute Identifies the attribute to be set.