DownloadMgrClient.h

00001 /*
00002 * ==============================================================================
00003 *  Name        : DownloadMgrClient.h
00004 *  Part of     : DownloadMgrClntSrv / DownloadMgr
00005 *  Interface   : ?Interface_category, ?Interface_name
00006 *  Description : This file contains the definition of the Client interface of Download Mgr Server.
00007 *  Version     : ?Version
00008 *
00009 *  Copyright © 2002-2004 Nokia. All rights reserved.
00010 *  This material, including documentation and any related 
00011 *  computer programs, is protected by copyright controlled by 
00012 *  Nokia. All rights are reserved. Copying, including 
00013 *  reproducing, storing, adapting or translating, any 
00014 *  or all of this material requires the prior written consent of 
00015 *  Nokia. This material also contains confidential 
00016 *  information which may not be disclosed to others without the 
00017 *  prior written consent of Nokia.
00018 * ==============================================================================
00019 */
00021 #ifndef __DOWNLOADMGR_CLIENT_H__
00022 #define __DOWNLOADMGR_CLIENT_H__
00023 
00024 //  INCLUDES
00025 #include <e32base.h>
00026 #include <f32file.h>
00027 #include <HttpDownloadMgrCommon.h>
00028 #include <http.h>
00030 // FORWARD DECLARATIONS
00031 class CDownloadMgrHandler;
00032 class RHttpDownload;
00033 class MHttpDownloadMgrObserver;
00034 class CDefaultAttrib;
00035 class CRHttpDownloadExtension;
00036 class CRHttpDownloadMgrExtension;
00037 class CRHttpDlExtension;
00038 class CEikonEnv;
00039 class CTransactionObserver;
00040 class THttpTransactionCallback;
00041 class CCodDownload;
00042 class CCodObserver;
00050 void HashL( const TDesC8& aMessage, TDes8& aHash );
00052 // TYPEDEFS
00053 typedef CArrayPtrFlat< RHttpDownload > CDownloadArray;
00054 typedef CArrayPtrFlat< MHttpDownloadMgrObserver >  CDownloadMgrObserver;
00056 // CLASS DECLARATION
00064 NONSHARABLE_CLASS( THttpDownloadEvent )
00065     {
00066     public: // Data
00067         // download state
00068         THttpDownloadState iDownloadState;
00069         // download progress state
00070         THttpProgressState iProgressState;
00071     };
00080 class MHttpDownloadMgrObserver
00081     {
00083     public:
00091         virtual void HandleDMgrEventL( RHttpDownload& aDownload, THttpDownloadEvent aEvent ) = 0;
00092     };
00101 class MHttpDownloadMgrNextUriObserver
00102     {
00104     public:
00112         virtual void NextUriL( RHttpDownload& aDownload, const TDesC8& aUri ) = 0;
00113     };
00121 NONSHARABLE_CLASS( RHttpDownloadMgr ) : public RSessionBase,
00122                                         public MHttpDownloadMgrObserver
00123         {
00124     public:
00128         IMPORT_C RHttpDownloadMgr();
00130     public:  // New functions
00140         IMPORT_C void ConnectL( TUid aAppUid,
MHttpDownloadMgrObserver& aObserver,
00142                                 TBool aMaster );
00149         IMPORT_C TVersion Version() const;
00156         IMPORT_C void Close();
00163         IMPORT_C const CDownloadArray& CurrentDownloads() const;
00172         IMPORT_C RHttpDownload& CreateDownloadL( const TDesC8& aUrl, TBool& aResult );
00181         IMPORT_C RHttpDownload& CreateDownloadL( const TDesC8& aUrl );
00189         IMPORT_C RHttpDownload& CreateClientSideDownloadL( TInt aHttpTransaction,TBool& aResult );
00202         IMPORT_C RHttpDownload& CreateCodDownloadL( const TDesC8& aUrl,
00203                                                     const TDesC8& aBuf,
00204                                                     const TDesC8& aMimeType,
00205                                                     CEikonEnv* aEikEnv,
00206                                                     TBool& aResult );
00216         IMPORT_C RHttpDownload* FindDownload( const TDesC8& aUrl, const TDesC8& aMsgBody );
00223         IMPORT_C TInt PauseAll();
00230         IMPORT_C TInt StartAll();
00237         IMPORT_C TInt ResetAll();
00244         IMPORT_C TInt DeleteAll();
00251         IMPORT_C TInt Disconnect();
00259                 IMPORT_C TInt GetIntAttribute( const TUint aAttribute, TInt32& aValue );
00267                 IMPORT_C TInt GetBoolAttribute( const TUint aAttribute, TBool& aValue );
00275                 IMPORT_C TInt GetStringAttribute( const TUint aAttribute, TDes16& aValue  );
00283         IMPORT_C TInt GetStringAttribute( const TUint aAttribute, TDes8& aValue  );
00291                 IMPORT_C TInt SetIntAttribute( const TUint aAttribute, TInt32 aValue );
00299                 IMPORT_C TInt SetBoolAttribute( const TUint aAttribute, TBool aValue );
00307                 IMPORT_C TInt SetStringAttribute( const TUint aAttribute, const TDesC16& aValue );
00315         IMPORT_C TInt SetStringAttribute( const TUint aAttribute, const TDesC8& aValue );
00323                 IMPORT_C TInt SetDefaultIntAttribute( const TUint aAttribute, TInt32 aValue );
00331                 IMPORT_C TInt SetDefaultBoolAttribute( const TUint aAttribute, TBool aValue );
00339                 IMPORT_C TInt SetDefaultStringAttribute( const TUint aAttribute, const TDesC16& aValue );
00347         IMPORT_C TInt SetDefaultStringAttribute( const TUint aAttribute, const TDesC8& aValue );
00354         IMPORT_C void AddObserverL( MHttpDownloadMgrObserver& aObserver );
00361         IMPORT_C void RemoveObserver( MHttpDownloadMgrObserver& aObserver );
00368         IMPORT_C void SetNextUriObserver( MHttpDownloadMgrNextUriObserver* aObserver );
00370     protected: // from MHttpDownloadMgrObserver
00378         void HandleDMgrEventL( RHttpDownload& aDownload, THttpDownloadEvent aEvent );
00380     private:
00388         void HandleSessionEventL( TInt aHandle, THttpDownloadEvent aEvent );
00390     private:  // New functions
00400         void DoConnectL( TUid aAppUid,
MHttpDownloadMgrObserver& aObserver,
00402                          TBool aMaster );
00412         void InitializeL( TUid aAppUid,
MHttpDownloadMgrObserver& aObserver,
00414                           TBool aMaster );
00416     protected: // New functions
RHttpDownload& AddToArrayL( RHttpDownload* aElement );
00426     private:  // New functions
00433         void RemoveFromArray( RHttpDownload* aElement );
00441         TInt FindInArray( RHttpDownload* aElement, TInt& aIndex ) const;
RHttpDownload& DownloadFromHandleL( TUint aHandle );
00456         TInt FindObserver( MHttpDownloadMgrObserver& aObserver, TInt& aIndex ) const;
00463         void AttachL( TDes8& aBuf );
00470         void CloseDownload( RHttpDownload* aElement );
00477         HBufC8* PackedDefaultAttributesLC();
00485         void DoSetDefaultAttributeL( const TUint aAttribute, TInt32 aValue );
00493         void DoSetDefaultAttributeL( const TUint aAttribute, TBool aValue );
00501         void DoSetDefaultAttributeL( const TUint aAttribute, const TDesC8& aValue );
00509         void DoSetDefaultAttributeL( const TUint aAttribute, const TDesC16& aValue );
00516         void StartSessionEventNotification( const TDesC8& aDownloadState,
00517                                             const TDesC8& aProgressState,
00518                                             const TDesC8& aHandle,
00519                                             TRequestStatus& aStatus );
00526         void CancelSessionEventNotification();
RHttpDownload* DoFindDownloadL( const TDesC8& aUrl, const TDesC8& aMsgBody );
00538         TInt NumberOfClientSideDownload( TInt32& aValue );
00545         TBool IsEventBroadcasting();
00553         void DoHandleSessionEventL( TInt aHandle, THttpDownloadEvent aEvent );
00561         void BroadcastEvent( RHttpDownload& aDownload, 
THttpDownloadEvent aEvent );
MHttpDownloadMgrNextUriObserver* NextUriObserver() const;
00574         TInt SessionId() const;
00581 //        void BroadcastDeleting( RHttpDownload& aDownload );
00587         TInt EventPriorityFlag() const;
00593         void IncrementEventPriorityFlag();
00599         void DecrementEventPriorityFlag();        
00601     private:     // Data
00602         // The client application UID.
00603         TUid                             iAppUid;
00604         // List of downloads.
CDownloadArray*                  iDownloadArray;  
00606         // List of observers.
CDownloadMgrObserver*            iObservers;      
00608         // Default attributes.
00609         CArrayPtrFlat< CDefaultAttrib >* iDefaultAttribs; 
00610         // Moved event handler
00611         CDownloadMgrHandler*             iManagerHandler; 
00612         // Extension class
00613         CRHttpDownloadMgrExtension*      iExtension;      
00615     public:     // Friend classes
00617         friend class RHttpDownload;
00618         friend class CDownloadMgrHandler;
00619         friend class CTransactionObserver;
00620         friend class CCodObserver;        
00621         };
00629 NONSHARABLE_CLASS( RHttpDownload ): public RSubSessionBase
00630         {
00631     public:
00635         enum TCodProgressState
00636             {
00637             ENotActive,
00638             EPaused,
00639             EInProgress
00640             };
00641     private:
RHttpDownload( RHttpDownloadMgr* aServer );
00648     public:  // New functions
00655         IMPORT_C TInt Start();
00662         IMPORT_C TInt Pause();
00669         IMPORT_C TInt Reset();
00676         IMPORT_C TInt Delete();
00683         IMPORT_C TInt Move();
00691                 IMPORT_C TInt GetIntAttribute( const TUint aAttribute, TInt32& aValue );
00699                 IMPORT_C TInt GetBoolAttribute( const TUint aAttribute, TBool& aValue );
00707                 IMPORT_C TInt GetStringAttribute( const TUint aAttribute, TDes16& aValue  );
00715         IMPORT_C TInt GetStringAttribute( const TUint aAttribute, TDes8& aValue  );
00721         IMPORT_C TInt GetFileHandleAttribute( RFile& aFile );
00729                 IMPORT_C TInt SetIntAttribute( const TUint aAttribute, TInt32 aValue );
00737                 IMPORT_C TInt SetBoolAttribute( const TUint aAttribute, TBool aValue );
00745                 IMPORT_C TInt SetStringAttribute( const TUint aAttribute, const TDesC16& aValue );
00753         IMPORT_C TInt SetStringAttribute( const TUint aAttribute, const TDesC8& aValue );
00761         IMPORT_C TInt SetFileHandleAttribute( RFile& aFile );
00769                 IMPORT_C TInt GetIntAttribute( const TUint aAttribute, const TInt32& aMoIndex, TInt32& aValue );
00778                 IMPORT_C TInt GetBoolAttribute( const TUint aAttribute, const TInt32& aMoIndex, TBool& aValue );
00787                 IMPORT_C TInt GetStringAttribute( const TUint aAttribute, const TInt32& aMoIndex, TDes16& aValue );
00796         IMPORT_C TInt GetStringAttribute( const TUint aAttribute, const TInt32& aMoIndex, TDes8& aValue );
00805                 IMPORT_C TInt SetStringAttribute(const TUint aAttribute, const TInt32& aMoIndex, const TDesC16& aValue );
00813         IMPORT_C TInt SetDownloadDataAttribute( const TDesC8& aValue );
00821         IMPORT_C TInt SetTrackDataAttribute( const TInt aIndex, const TDesC8& aValue );
00823     public: // New functions
00830         void Close();
00838         TBool IsClosed()
00839         {
00840             return iClosed;
00841         }
00848                 void ResumeCodDownloadL()  ;
00855                 TInt GetProductDownloadedSize();        
00857      private: // New functions
00864         void CloseSubSession();
00871         void SaveDownloadInfoL();
00878         void CreateL( const TDesC8& aUrl, const TPtr8 aPackedAttribs );
00885         void AttachL( TInt aHandle );
00895         void StartEventNotification( TDes8& aDownloadState,
00896                                      TDes8& aProgressState,
00897                                      TDes8& aEventAttrib,                                     
00898                                      TRequestStatus& aStatus );
00905         void CancelEventNotification();
00912         TBool IsDownload( TInt aHandle );
00921         TBool IsDownloadL( const TUriParser8& aParsedReqUrl, 
00922                            const TDesC8& aMsgBody );
00929         void SetDefaultAttributesL( const TDesC8& aPackedAttribs );
00936         void BufferAttributesL();
00943         void SetEventType( THttpDownloadState aEventType );
00950         void SetHttpTransactionL( TInt aHttpTransaction );
00957         void DeleteTransaction();
00968         void InitCodDownloadL( const TDesC8& aBuf, 
00969                                const TDesC8& aMimeType,
00970                                CEikonEnv* aEikEnv );
00977        void InitPausedCodDownloadL( const TUid aAppUid );
00983         void DoStartCodL();
00992         TBool CheckContentTypeAndCreateCodDownloadL();
01000         TInt SetOnError( TInt aError,
THttpDownloadMgrError aDlError = EGeneral ); 
01003 #ifdef DEAD_CODE
01004 
01008         HBufC8* AllocEventAttribBufL();
01009 #endif
01010         
01016         void UnpackEventAttribL( const TDesC8& aPack );
01023         TBool IsClientSideDownload() const;
01030         TBool IsToBeDeleted();
01037         void DoStartL(); 
01043         TInt EventPriorityFlag() const;
01049         TBool IsDeleteCodWhenDone() const;
01055         void SetCodInProgress( TCodProgressState aVal ); 
01062         void AttachToDownloadL( const TInt32 aDlId );
01068         TInt32 ActiveMoIndex() const;
01074         void StopWaitingAS();
01076     private:    // Data
01077         // Event notification handler.
01078         CDownloadMgrHandler*     iDownloadHandler;  
01079         // Download manager session.
RHttpDownloadMgr*        iDownloadMgr;      
01081         // Unique identifier of server side subsession.
01082         TInt                     iHandle;
01083         // Extension class
01084         CRHttpDownloadExtension* iExtension;        
01086         CTransactionObserver*    iTransactionObserver;
01087         RHTTPTransaction*        iHttpTransaction;
01088         // Descriptor Based download COD/DD
01089         CCodDownload*            iCodDownload;      
01090         // Cod observer
01091         CCodObserver*            iCodObserver;    
01092         // Client Side Download
01093         TBool                    iClientSideDownload;
01094         // Boolean flag which indicates download closure
01095         TBool                    iClosed;
01096         // Boolean flag which indicates download subsession closure
01097         TBool                    iClosedSubSession;
01098         // Extension class to cache the cloased subsession
01099         CRHttpDlExtension*               iDlExtension;        
01101         CActiveSchedulerWait*    iWait;
01103         // Boolean flag which indicates Active Scheduler is Ready
01104         TBool                    iASReady;
01106     public:     // Friend classes
01108         friend class CDownloadMgrHandler;
01109         friend class RHttpDownloadMgr;
01110         friend class RHttpDownloadMgrApiExt;
01111         friend class CTransactionObserver;
01112         friend class CCodObserver;
01113         friend class CDownloadMgrHandler;
01115         };
01117 #endif /* __DOWNLOADMGR_CLIENT_H__ */