homesync/contentmanager/cmserver/cmstoremanager/inc/cmsmfilemngr.h
branchIOP_Improvements
changeset 40 08b5eae9f9ff
parent 39 6369bfd1b60d
child 41 b4d83ea1d6e2
equal deleted inserted replaced
39:6369bfd1b60d 40:08b5eae9f9ff
     1 /*
       
     2 * Copyright (c) 2008 Nokia Corporation and/or its subsidiary(-ies).
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:  store file manager
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 #ifndef __CMSMFILEMNGR_H
       
    21 #define __CMSMFILEMNGR_H
       
    22 
       
    23 #include <e32base.h>
       
    24 #include <badesca.h>
       
    25 #include "cmsmvideoandimagemngrobserver.h"
       
    26 #include "cmsmmusicmngrobserver.h"
       
    27 #include "cmsmcommon.h"
       
    28 #include "cmcommontypes.h"
       
    29 #include "cmcommon.h"
       
    30 
       
    31 // Forward declarations
       
    32 class CCmDmMain;
       
    33 class CMdESession;
       
    34 class CCmStoreRule;
       
    35 class CUpnpAVDevice;
       
    36 class MCmSmFileProcessingObserver;
       
    37 class CCmStoreListItem;
       
    38 class CCmFillListItem;
       
    39 class CUpnpAVDeviceList;
       
    40 class CCmSmVideoAndImageMngr;
       
    41 class CCmSmClfMngr;
       
    42 class CCmSmContentChangeObserver;
       
    43 class CCmSmItemInfo;
       
    44 class CCmSmMsInfo;
       
    45 
       
    46 
       
    47 // CLASS DECLARATION  
       
    48  /**
       
    49   *  Processes store files
       
    50   * 
       
    51   *  @lib cmstoremanager.lib
       
    52   *
       
    53   *  @since S60 v5.1
       
    54   */
       
    55 NONSHARABLE_CLASS( CCmSmFileMngr ): public CActive,
       
    56                       public MCmSmVideoAndImageMngrObserver,
       
    57                       public MCmSmMusicMngrObserver
       
    58     {         
       
    59 public:
       
    60 
       
    61     /**
       
    62      * Two-phased constructor.
       
    63      * Creates new CCmSmFileMngr class
       
    64      *
       
    65      * @since S60 5.1
       
    66      * @param aObserver, observer pointer
       
    67      * @param aSession, mde session
       
    68      * @param aDBMngr, database manager
       
    69      * @param aItems, store list items
       
    70      * @return pointer to CCmSmFileMngr class
       
    71      */
       
    72     static CCmSmFileMngr* NewL(
       
    73         MCmSmFileProcessingObserver* aObserver, CMdESession& aSession, 
       
    74         CCmDmMain* aDBMngr, RPointerArray<CCmStoreListItem>& aItems );
       
    75     
       
    76     /**
       
    77      * Two-phased constructor.
       
    78      * Creates new CCmSmFileMngr class
       
    79      *
       
    80      * @since S60 5.1
       
    81      * @param aObserver, observer pointer
       
    82      * @param aSession, mde session
       
    83      * @param aDBMngr, database manager
       
    84      * @param aItems, store list items
       
    85      * @return  pointer to CCmSmFileMngr class
       
    86      */
       
    87     static CCmSmFileMngr* NewLC(
       
    88         MCmSmFileProcessingObserver* aObserver, CMdESession& aSession, 
       
    89         CCmDmMain* aDBMngr, RPointerArray<CCmStoreListItem>& aItems );
       
    90 
       
    91     /**
       
    92      * Destructor.
       
    93      */
       
    94     virtual ~CCmSmFileMngr();
       
    95 
       
    96 public: 
       
    97 
       
    98     /**
       
    99      * Starts store list processing
       
   100      *
       
   101      * @since S60 5.1
       
   102      * @param None
       
   103      * @return None
       
   104      */
       
   105     void StartProcessing();
       
   106 
       
   107     /**
       
   108      * Provides album list
       
   109      * @param aMedia, media type
       
   110      * @param aArray, array of albums
       
   111      * @return  None
       
   112      */
       
   113     void ProcessAlbumList( TCmMediaType aMedia, 
       
   114     CDesCArray& aArray );
       
   115         
       
   116     /**
       
   117      * Canceling file processing
       
   118      *
       
   119      * @since S60 5.1
       
   120      * @param None
       
   121      * @return None
       
   122      */    
       
   123     void CancelOperation();
       
   124         
       
   125     /**
       
   126      * Returns amount of items to be stored
       
   127      *
       
   128      * @since S60 5.1
       
   129      * @param None
       
   130      * @return count
       
   131      */        
       
   132     TInt StoreItemCount();
       
   133 
       
   134     /**
       
   135      * Returns amount of items to be filled
       
   136      *
       
   137      * @since S60 5.1
       
   138      * @param None
       
   139      * @return count
       
   140      */      
       
   141     TInt FillItemCount();
       
   142  
       
   143     /**
       
   144      * Returns amount of items to be stored, no duplicates
       
   145      *
       
   146      * @since S60 5.1
       
   147      * @param aCount
       
   148      * @return None
       
   149      */    
       
   150     void GetStoreFileCountNoDuplicatesL( TInt& aCount );
       
   151     
       
   152     /**
       
   153      * Updating transfer history
       
   154      * @param aInterval, time stamp
       
   155      * @param aDataAmount, transfered data
       
   156      * @param aServerId, device id
       
   157      * @return  None
       
   158      */
       
   159     void UpdateTransferHistoryData(TInt64 aInterval,
       
   160                             TInt64 aDataAmount, TUint8 aServerId );    
       
   161 
       
   162     /**
       
   163      * Loading all selected Store rules
       
   164      *
       
   165      * @since S60 5.1
       
   166      * @param None
       
   167      * @return None
       
   168      */        
       
   169     void LoadSelectedStoreRulesL();
       
   170     
       
   171     /**
       
   172      * Processing Store rules 
       
   173      *
       
   174      * @since Series 60 5.1
       
   175      * @param None
       
   176      * @return None
       
   177      */        
       
   178     void ProcessStoreRules();
       
   179 
       
   180     /**
       
   181      * Loads filled and stored items
       
   182      *
       
   183      * @since S60 5.1
       
   184      * @param None
       
   185      * @return None
       
   186      */        
       
   187     void LoadFilledAndStoredL();
       
   188     
       
   189     /**
       
   190      * Loading all filled items
       
   191      *
       
   192      * @since S60 5.1
       
   193      * @param None
       
   194      * @return None
       
   195      */        
       
   196     void LoadFilledL();
       
   197     
       
   198     /**
       
   199      * Loading all stored items ( filled from UDN )
       
   200      *
       
   201      * @since S60 5.1
       
   202      * @param aUDN, server identifier
       
   203      * @return None
       
   204      */    
       
   205     void LoadStoredL( const TDesC8& aUDN );
       
   206 
       
   207     /**
       
   208      * Reseting filled array
       
   209      *
       
   210      * @since S60 5.1
       
   211      * @param None
       
   212      * @return None
       
   213      */        
       
   214     void ResetFilledArray();
       
   215 
       
   216     /**
       
   217      * Selects media types from store rules for CLF
       
   218      * Refresh. 
       
   219      *
       
   220      * @since S60 5.1
       
   221      * @param None     
       
   222      * @return None
       
   223      */    
       
   224     void SelectMediaTypes();
       
   225 
       
   226     /**
       
   227      * Checks if file is filled
       
   228      *
       
   229      * @since S60 5.1
       
   230      * @param aPathAndFileName, file to be chekced
       
   231      * @return ETrue if file is filled
       
   232      */  
       
   233     TBool CheckIsFilledFileL( const TDesC& aPathAndFileName );
       
   234     
       
   235     /**
       
   236      * Checks if file is already stored
       
   237      *
       
   238      * @since S60 5.1
       
   239      * @param aPathAndFileName, file to be chekced
       
   240      * @param aStoredIds, reference to stored servers array
       
   241      * @param aStoreIds, reference to store servers array
       
   242      * @return None
       
   243      */     
       
   244     void IsAlreadyStoreL( const TDesC& aPathAndFileName, 
       
   245         RArray<TInt>& aStoredIds, RArray<TInt>& aStoreIds );
       
   246 
       
   247     /**
       
   248      * Identifies media types used with aDeviceIndex server
       
   249      *
       
   250      * @since S60 5.1
       
   251      * @param aIds, media server ids
       
   252      * @param aType, media type
       
   253      * @return None
       
   254      */        
       
   255     void MediaTypesL( RArray<TInt>& aIds, TCmMediaType aType );    
       
   256     
       
   257     /**
       
   258      * Loads all media server id from the database
       
   259      *
       
   260      * @since S60 5.1
       
   261      * @param None
       
   262      * @return None
       
   263      */    
       
   264     void LoadMediaServerIdsL();
       
   265 
       
   266     /**
       
   267      * Returns devide id
       
   268      *
       
   269      * @since S60 5.1
       
   270      * @param aUuid, media server identifier
       
   271      * @return id, database id
       
   272      */    
       
   273     TInt64 GetDevId( const TDesC8& aUuid );
       
   274 
       
   275     /**
       
   276      * Select files which is needed to be stored to def. server
       
   277      *
       
   278      * @since S60 5.1
       
   279      * @param aItemIds, item id array
       
   280      * @param aUuid, server identifier
       
   281      * @param aId, server database id
       
   282      * @return None
       
   283      */    
       
   284     void GetItemsL( RArray<TInt>& aItemIds, 
       
   285         const TDesC8& aUuid, TInt64& aId );
       
   286 
       
   287     /**
       
   288      * Updates store file list up to date
       
   289      *
       
   290      * @since S60 5.1
       
   291      * @param None
       
   292      * @return None
       
   293      */        
       
   294     void UpdateStoreFileListL();
       
   295     
       
   296     /**
       
   297      * Loads store file list from the db
       
   298      *
       
   299      * @since S60 5.1
       
   300      * @param None
       
   301      * @return None
       
   302      */    
       
   303     void LoadStoreFileListL();
       
   304 
       
   305     /**
       
   306      * Get store rule id
       
   307      *
       
   308      * @since S60 5.1
       
   309      * @param aType, media type
       
   310      * @return rule id
       
   311      */        
       
   312     TInt64 RetrieveListId( TCmMediaType aType );
       
   313     
       
   314     /**
       
   315      * Get status values and server ids 
       
   316      *
       
   317      * @since S60 5.1
       
   318      * @param aType, media type
       
   319      * @param aStatus
       
   320      * @return None
       
   321      */        
       
   322     void RetrieveListStatusValues( TCmMediaType aType,
       
   323         TCmListItemStatus& aStatus );
       
   324         
       
   325     /**
       
   326      * Deletes items which need to be deleled
       
   327      *
       
   328      * @since S60 5.1
       
   329      * @param aIds, item id array
       
   330      * @return None
       
   331      */        
       
   332     void DeleteItems( RArray<TInt>& aIds );
       
   333     
       
   334    /**
       
   335      * Reseting arrays
       
   336      *
       
   337      * @since S60 5.1
       
   338      * @param None
       
   339      * @return None
       
   340      */    
       
   341     void ResetArrays();
       
   342 
       
   343    /**
       
   344      * Calculating transfer history time
       
   345      *
       
   346      * @since S60 5.1
       
   347      * @param None
       
   348      * @return None
       
   349      */        
       
   350     void CalculateAvgTransferTimeL();
       
   351     
       
   352    /**
       
   353      * Publishes transfer history time estimate
       
   354      *
       
   355      * @since S60 5.1
       
   356      * @param None
       
   357      * @return None
       
   358      */    
       
   359     void SendAvgTransferTime();
       
   360     
       
   361     /**
       
   362      * Sets processing status
       
   363      * @param aStatus, processing status
       
   364      * @return  None
       
   365      */        
       
   366     void SetProcessingStatus( TCmSmFileProcessingStatus aStatus );   
       
   367 
       
   368 protected:
       
   369 
       
   370 // From base class CActive
       
   371 
       
   372     /**
       
   373      * From CActive
       
   374      * See base class definition
       
   375      */
       
   376     void RunL();
       
   377 
       
   378     /**
       
   379      * From CActive
       
   380      * See base class definition
       
   381      */
       
   382     void DoCancel();    
       
   383  
       
   384      /**
       
   385       * From CActive
       
   386       * See base class definition
       
   387       */   
       
   388     TInt RunError( TInt aError );    
       
   389 
       
   390 // From base class MCmSmMediaTypeObserver
       
   391 
       
   392     /**
       
   393      * From MCmSmMediaTypeObserver
       
   394      * See base class definition
       
   395      */
       
   396     void ImagesAndVideosReady( const TInt aStatus );
       
   397 
       
   398 // From base class MCmSmMusicMngrObserver
       
   399 
       
   400     /**
       
   401      * From MCmSmMusicMngrObserver
       
   402      * See base class definition
       
   403      */
       
   404     void MusicReady( const TInt aStatus );        
       
   405             
       
   406 private:
       
   407 
       
   408     /**
       
   409      * Process media lists
       
   410      * 
       
   411      * @param aType, defined media type
       
   412      * @return None
       
   413      */
       
   414     void ProcessMedia( TCmMediaType aType );
       
   415     
       
   416     /**
       
   417      * Process music
       
   418      * 
       
   419      * @param None
       
   420      * @return None
       
   421      */    
       
   422     void ProcessMusics();
       
   423     
       
   424     /**
       
   425      * Completes request
       
   426      *
       
   427      * @since S60 5.1
       
   428      * @param aStatus, defined id for the completing 
       
   429      * @return None
       
   430      */     
       
   431     void CompleteRequest( TCmSmFileProcessingStatus aStatus );        
       
   432                     
       
   433 private:
       
   434 
       
   435     /**
       
   436      * Performs the first phase of two phase construction.
       
   437      *
       
   438      * @since S60 5.1
       
   439      * @param aObserver, process observer
       
   440      * @param aDBMngr, database manager
       
   441      * @param aItems, store items
       
   442      */
       
   443     CCmSmFileMngr(
       
   444         MCmSmFileProcessingObserver* aObserver, CCmDmMain* aDBMngr, 
       
   445         RPointerArray<CCmStoreListItem>& aItems );
       
   446 
       
   447     /**
       
   448      * Performs the second phase construction.
       
   449      *
       
   450      * @since S60 5.1
       
   451      * @param aSesstion, mde sesstion
       
   452      */
       
   453     void ConstructL( CMdESession& aSession );
       
   454 
       
   455 private:
       
   456 
       
   457     /**
       
   458      * Pointer to observer class
       
   459      */
       
   460     MCmSmFileProcessingObserver* iObserver;             // not owned    
       
   461     /**
       
   462      * Pointer to database manager
       
   463      */
       
   464     CCmDmMain* iDBManager;                              // not owned         
       
   465     /**
       
   466      * Rule array
       
   467      */
       
   468     RPointerArray<CCmStoreRule> iRuleArray;             // owned
       
   469     /**
       
   470      * Stored items array
       
   471      */
       
   472     RPointerArray<CCmSmItemInfo>iStoredArray;           // owned
       
   473     /**
       
   474      * Media server id array
       
   475      */
       
   476     RPointerArray<CCmSmMsInfo> iMsIds;                  // owned
       
   477     /**
       
   478      * Store file list items
       
   479      */
       
   480     RPointerArray<CCmStoreListItem>& iItems;            // not owned
       
   481     /**
       
   482      * Filled file list items
       
   483      */
       
   484     RPointerArray<CCmFillListItem>iFilledItems;         // owned
       
   485     /**
       
   486      * video and image process
       
   487      */
       
   488     CCmSmVideoAndImageMngr* iVideoAndImageMngr;         // owned      
       
   489     /**
       
   490      * music process temp
       
   491      */
       
   492     CCmSmClfMngr* iClfMusicMngr;                        // owned
       
   493     /**
       
   494      * observers content changes in local device
       
   495      */
       
   496     CCmSmContentChangeObserver* iCcObserver;            // owned  
       
   497     /**
       
   498      * Media type array
       
   499      */
       
   500     RArray<TCmMediaType>iMediaTypes;                    // owned
       
   501     /**
       
   502      * Used to select media to be refreshed
       
   503      */
       
   504     TInt iRefreshIndex;
       
   505     /**
       
   506      * Total transfer time estimate
       
   507      */
       
   508     TCmProgressInfo iTransferInfo;
       
   509     /**
       
   510      * Processing status
       
   511      */
       
   512     TCmSmFileProcessingStatus iProcessingStatus;
       
   513 
       
   514     };
       
   515 
       
   516 #endif //  __CMSMFILEMNGR_H
       
   517