photosgallery/controllers/collectionmanager/src/glxcollectionmanagerimpl.cpp
changeset 0 4e91876724a2
equal deleted inserted replaced
-1:000000000000 0:4e91876724a2
       
     1 /*
       
     2 * Copyright (c) 2008-2009 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:    Implementation of collection manager API for external use
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 
       
    21 #include "glxcollectionmanagerimpl.h"
       
    22 
       
    23 #include <glxcommandfactory.h>
       
    24 #include <glxpanic.h>
       
    25 #include <mpxcollectionmessage.h>
       
    26 #include <mpxcollectionpath.h>
       
    27 #include <mpxcollectionutility.h>
       
    28 #include <mpxmediacontainerdefs.h>
       
    29 #include <mpxmediageneraldefs.h>
       
    30 #include <mpxmessagegeneraldefs.h>
       
    31 
       
    32 #include "glxcollectioninfo.h"
       
    33 
       
    34 #include <glxcollectionplugincamera.hrh>
       
    35 #include <glxcollectionpluginalbums.hrh>
       
    36 
       
    37 // -----------------------------------------------------------------------------
       
    38 // Constructor
       
    39 // -----------------------------------------------------------------------------
       
    40 //
       
    41 CGlxCollectionManagerImpl::CGlxCollectionManagerImpl()
       
    42     {
       
    43     }
       
    44 // -----------------------------------------------------------------------------
       
    45 // Destructor
       
    46 // -----------------------------------------------------------------------------
       
    47 //
       
    48 CGlxCollectionManagerImpl::~CGlxCollectionManagerImpl()
       
    49     {
       
    50     CloseCollection();
       
    51     delete iUri;
       
    52     }
       
    53 // -----------------------------------------------------------------------------
       
    54 // CGlxCollectionManagerImpl::AddToContainerL
       
    55 // -----------------------------------------------------------------------------
       
    56 //
       
    57 void CGlxCollectionManagerImpl::AddToContainerL(const TDesC& aUri, 
       
    58 		CGlxCollectionManager::TCollection aContainer, TRequestStatus& aRequestStatus)
       
    59     {
       
    60     __ASSERT_DEBUG(CGlxCollectionManager::ECollectionCameraAlbum == aContainer, Panic(EGlxPanicUnsupportedCollection));
       
    61     
       
    62     iCollectionId.iUid = KGlxCollectionPluginCameraImplementationUid;
       
    63     iContainerId = 0; // A zero container id indicates to the data source that we wish to the 
       
    64     // 'special album' related to the collection id. e.g. the camera album.
       
    65     
       
    66     AddToContainerL(aUri,aRequestStatus);
       
    67     }
       
    68     
       
    69 // -----------------------------------------------------------------------------
       
    70 // CGlxCollectionManagerImpl::AddToContainerL
       
    71 // -----------------------------------------------------------------------------
       
    72 //
       
    73 void CGlxCollectionManagerImpl::AddToContainerL(const TDesC& aUri, 
       
    74                         TUint32 aCollectionId, TRequestStatus& aRequestStatus)
       
    75     {
       
    76     iCollectionId.iUid = KGlxCollectionPluginAlbumsImplementationUid;
       
    77     iContainerId = aCollectionId;
       
    78     
       
    79     AddToContainerL(aUri,aRequestStatus);
       
    80     }
       
    81 
       
    82 // -----------------------------------------------------------------------------
       
    83 // CGlxCollectionManagerImpl::CollectionInfoL
       
    84 // -----------------------------------------------------------------------------
       
    85 //
       
    86 void CGlxCollectionManagerImpl::CollectionInfoL(CGlxCollectionInfo& aInfo,
       
    87                         TRequestStatus& aRequestStatus)
       
    88     {
       
    89     __ASSERT_DEBUG(iState == EClosed || iState == EOpen, Panic(EGlxPanicIllegalState));
       
    90     
       
    91     iCollectionInfo = &aInfo;
       
    92     InitializeRequest(aRequestStatus);
       
    93     
       
    94     if (iState == EOpen)
       
    95     	{
       
    96     	CloseCollection(); // Close and re-open the collection to ensure we have the
       
    97     	                   // latest changes.
       
    98     	}
       
    99 
       
   100     iState = EOpeningForCollectionInfo;
       
   101     OpenCollectionL();
       
   102     
       
   103     }
       
   104 
       
   105 // -----------------------------------------------------------------------------
       
   106 // CGlxCollectionManagerImpl::Cancel
       
   107 // -----------------------------------------------------------------------------
       
   108 //
       
   109 void CGlxCollectionManagerImpl::Cancel()
       
   110     {	
       
   111     ///@todo test canceling
       
   112     
       
   113     switch (iState)
       
   114     	{
       
   115     	case EClosed:
       
   116     	case EOpen:
       
   117     	case EOpening:
       
   118     		{
       
   119     		// no request outstanding
       
   120     		break;
       
   121     		}
       
   122     	case EOpeningForAdd:
       
   123     	case EOpeningForCollectionInfo:
       
   124     		{
       
   125     		iState = EOpening; // Complete open if we can.
       
   126     		break;		
       
   127     		}
       
   128     	case EAdding:
       
   129     	case ERequestingMedia:
       
   130     		{
       
   131     		iState = EOpen;
       
   132     		iCollectionUtility->Collection().CancelRequest();
       
   133     		}
       
   134     	}
       
   135     CompleteRequest(KErrCancel);
       
   136     }
       
   137 
       
   138 // -----------------------------------------------------------------------------
       
   139 // CGlxCollectionManagerImpl::HandleCollectionMessageL
       
   140 // -----------------------------------------------------------------------------
       
   141 //
       
   142 void CGlxCollectionManagerImpl::HandleCollectionMessageL(const TMPXCollectionMessage& /*aMessage*/)
       
   143     {
       
   144     // Don't do anything.
       
   145     }
       
   146 
       
   147 // -----------------------------------------------------------------------------
       
   148 // CGlxCollectionManagerImpl::HandleCollectionMessageL
       
   149 // -----------------------------------------------------------------------------
       
   150 //
       
   151 void CGlxCollectionManagerImpl::HandleCollectionMessageL(const CMPXMessage& aMsg)
       
   152     {
       
   153     if (aMsg.IsSupported(KMPXMessageGeneralEvent))
       
   154     	{
       
   155 	    switch (aMsg.ValueTObjectL<TInt>(KMPXMessageGeneralEvent))
       
   156 	    	{
       
   157 	    	case TMPXCollectionMessage::EPathChanged:
       
   158 	    		{
       
   159 	            __ASSERT_DEBUG(iState == EOpeningForAdd || iState == EOpeningForCollectionInfo || iState == EOpening || iState == EOpen, Panic(EGlxPanicIllegalState));
       
   160 	    		
       
   161 	            TState oldState = iState;
       
   162 	            iState = EOpen;
       
   163 	            
       
   164 	            switch(oldState)
       
   165 	            {
       
   166 	            case EOpeningForAdd:
       
   167 	            	{
       
   168 	            	iState = EOpen;
       
   169 	            	DoAddToContainerL();
       
   170 	            	break;
       
   171 	            	}
       
   172 	            case EOpeningForCollectionInfo:
       
   173 	            	{
       
   174 	        		iState = EOpen;
       
   175 	            	__ASSERT_DEBUG(iCollectionInfo, Panic(EGlxPanicNullPointer));
       
   176 		 
       
   177 	        		DoCollectionInfoL();
       
   178 	        		break;
       
   179 	            	}
       
   180 	            case EOpening:
       
   181 	            	{
       
   182 	            	// don't do anything
       
   183 	            	break;
       
   184 	            	}
       
   185 		    		}
       
   186 	    		}
       
   187 	    	break;
       
   188 	    	default:
       
   189 	    	break;
       
   190 	    	}
       
   191     	}
       
   192     }
       
   193 
       
   194 // -----------------------------------------------------------------------------
       
   195 // CGlxCollectionManagerImpl::HandleOpenL
       
   196 // -----------------------------------------------------------------------------
       
   197 //
       
   198 void CGlxCollectionManagerImpl::HandleOpenL(const CMPXMedia& /*aEntries*/,
       
   199                          TInt /*aIndex*/,TBool /*aComplete*/,TInt aError)
       
   200     { 
       
   201     // Handle open only gets called when an error occurs
       
   202     ///@todo check that this method works
       
   203     
       
   204     __ASSERT_DEBUG(iState == EOpening || iState == EOpeningForAdd || iState == EOpeningForCollectionInfo, Panic(EGlxPanicIllegalState));
       
   205     	
       
   206     if (aError != KErrNone)
       
   207     	{
       
   208     	CompleteRequest(aError);
       
   209     	iState = EClosed;
       
   210     	}  	
       
   211     }
       
   212 
       
   213 // -----------------------------------------------------------------------------
       
   214 // CGlxCollectionManagerImpl::HandleOpenL
       
   215 // -----------------------------------------------------------------------------
       
   216 //
       
   217 void CGlxCollectionManagerImpl::HandleOpenL(const CMPXCollectionPlaylist& /*aPlaylist*/ ,TInt /*aError*/)
       
   218     {
       
   219     // Don't do anything.
       
   220     }
       
   221 
       
   222 // -----------------------------------------------------------------------------
       
   223 // CGlxCollectionManagerImpl::HandleCollectionMediaL
       
   224 // -----------------------------------------------------------------------------
       
   225 //
       
   226 void CGlxCollectionManagerImpl::HandleCollectionMediaL(const CMPXMedia& aMedia, TInt aError)
       
   227     {
       
   228     iState = EOpen;    	
       
   229     
       
   230     if (aError == KErrNone && iCollectionInfo)
       
   231     	{
       
   232         iCollectionInfo->SetExists(ETrue);
       
   233         iCollectionInfo->SetTitleL(aMedia.ValueText(KMPXMediaGeneralTitle));
       
   234     	}
       
   235   
       
   236     CompleteRequest(aError);
       
   237     }
       
   238 
       
   239 // -----------------------------------------------------------------------------
       
   240 // CGlxCollectionManagerImpl::HandleCommandComplete
       
   241 // -----------------------------------------------------------------------------
       
   242 //
       
   243 void CGlxCollectionManagerImpl::HandleCommandComplete(CMPXCommand* /*aCommandResult*/, TInt aError)
       
   244     {
       
   245     CompleteRequest(aError);
       
   246     iState = EOpen;
       
   247     }
       
   248 
       
   249 // -----------------------------------------------------------------------------
       
   250 // CGlxCollectionManagerImpl::CompleteRequest
       
   251 // -----------------------------------------------------------------------------
       
   252 //
       
   253 void CGlxCollectionManagerImpl::CompleteRequest(TInt aError)
       
   254     {
       
   255     if (iRequestStatus)
       
   256         {
       
   257         User::RequestComplete(iRequestStatus, aError);
       
   258         iRequestStatus = NULL;
       
   259         }
       
   260     }
       
   261 
       
   262 // -----------------------------------------------------------------------------
       
   263 // CGlxCollectionManagerImpl::InitializeRequest
       
   264 // -----------------------------------------------------------------------------
       
   265 //
       
   266 void CGlxCollectionManagerImpl::InitializeRequest(TRequestStatus& aRequestStatus)
       
   267     {
       
   268     __ASSERT_DEBUG(!iRequestStatus, Panic(EGlxPanicCollectionManagerOutstandingRequest));
       
   269     iRequestStatus = &aRequestStatus;
       
   270     *iRequestStatus = KRequestPending;
       
   271     }
       
   272 
       
   273 /// -----------------------------------------------------------------------------
       
   274 // CGlxCollectionManagerImpl::OpenCollectionL
       
   275 // -----------------------------------------------------------------------------
       
   276 //
       
   277 void CGlxCollectionManagerImpl::OpenCollectionL()
       
   278     {
       
   279     if (iCollectionUtility)
       
   280     	{
       
   281     	iCollectionUtility->Close(); // deletes the collection utility's this pointer. 
       
   282     	}
       
   283     iCollectionUtility = NULL;
       
   284     iCollectionUtility = MMPXCollectionUtility::NewL(this);
       
   285 	CMPXCollectionPath* path = CMPXCollectionPath::NewL();
       
   286     CleanupStack::PushL(path);
       
   287 	path->AppendL(KGlxCollectionPluginAlbumsImplementationUid); //Open the albums collection plugin
       
   288 	// We can use this plugin to add things to the camera album.
       
   289 	iCollectionUtility->Collection().OpenL(*path);
       
   290 	CleanupStack::PopAndDestroy(path);
       
   291     }
       
   292 
       
   293 // -----------------------------------------------------------------------------
       
   294 // CGlxCollectionManagerImpl::CloseCollection
       
   295 // -----------------------------------------------------------------------------
       
   296 //
       
   297 void CGlxCollectionManagerImpl::CloseCollection()
       
   298 	{
       
   299 	if (iCollectionUtility)
       
   300 		{
       
   301 		iCollectionUtility->Close();
       
   302 		iCollectionUtility = NULL;
       
   303 		}
       
   304 	iState = EClosed;
       
   305 	}
       
   306 
       
   307 // -----------------------------------------------------------------------------
       
   308 // CGlxCollectionManagerImpl::DoAddToContainerL
       
   309 // -----------------------------------------------------------------------------
       
   310 //
       
   311 void CGlxCollectionManagerImpl::DoAddToContainerL()
       
   312 	{
       
   313 	__ASSERT_DEBUG(iState == EOpen, Panic(EGlxPanicIllegalState));
       
   314 	CMPXCollectionPath* targetContainerPath = CMPXCollectionPath::NewL();
       
   315     CleanupStack::PushL(targetContainerPath);
       
   316     targetContainerPath->AppendL(iCollectionId.iUid);
       
   317 
       
   318     targetContainerPath->AppendL(iContainerId);
       
   319     CMPXCommand* command = TGlxCommandFactory::AddToContainerCommandLC(*iUri, *targetContainerPath);
       
   320     CleanupStack::Pop(command);
       
   321     CleanupStack::PopAndDestroy(targetContainerPath);
       
   322     CleanupStack::PushL(command);
       
   323     iCollectionUtility->Collection().CommandL(*command);
       
   324     CleanupStack::PopAndDestroy(command);
       
   325     iState = EAdding;
       
   326 	}
       
   327 
       
   328 // -----------------------------------------------------------------------------
       
   329 // CGlxCollectionManagerImpl::AddToContainerL
       
   330 // -----------------------------------------------------------------------------
       
   331 //
       
   332 void CGlxCollectionManagerImpl::AddToContainerL(const TDesC& aUri, TRequestStatus& aRequestStatus)
       
   333 	{
       
   334     __ASSERT_DEBUG(iState == EClosed || iState == EOpen,  Panic(EGlxPanicIllegalState));
       
   335     
       
   336     InitializeRequest(aRequestStatus);
       
   337     
       
   338 	delete iUri;
       
   339     iUri = NULL;
       
   340     iUri = aUri.AllocL();
       
   341     
       
   342     if (iState == EClosed)
       
   343     	{
       
   344     	iState = EOpeningForAdd;
       
   345     	OpenCollectionL();
       
   346     	}
       
   347     else
       
   348     	{
       
   349     	DoAddToContainerL();
       
   350     	}
       
   351 	}
       
   352 
       
   353 // -----------------------------------------------------------------------------
       
   354 // CGlxCollectionManagerImpl::DoCollectionInfoL
       
   355 // -----------------------------------------------------------------------------
       
   356 //
       
   357 void CGlxCollectionManagerImpl::DoCollectionInfoL()
       
   358 	{
       
   359     __ASSERT_DEBUG(iState == EOpen,  Panic(EGlxPanicIllegalState));
       
   360 	CMPXCollectionPath* path = iCollectionUtility->Collection().PathL();
       
   361 	CleanupStack::PushL(path);
       
   362 	
       
   363 	TInt index = path->IndexOfId(iCollectionInfo->Id());
       
   364 	if (index == KErrNotFound)
       
   365 		{
       
   366 		iCollectionInfo->SetExists(EFalse);
       
   367 		CompleteRequest(KErrNone);
       
   368 		}
       
   369 	else if(index < 0) // Index is an error other than KErrNotFound
       
   370 		{
       
   371 		CompleteRequest(index);
       
   372 		}
       
   373 	else
       
   374 		{
       
   375 		// the index is good get the title
       
   376 		path->Set(index);
       
   377 		
       
   378 		RArray<TMPXAttribute> attributeArray;
       
   379 		CleanupClosePushL(attributeArray);
       
   380 		attributeArray.AppendL(KMPXMediaGeneralTitle);
       
   381 		iCollectionUtility->Collection().MediaL(*path, attributeArray.Array());
       
   382 		CleanupStack::PopAndDestroy(&attributeArray);
       
   383 		iState = ERequestingMedia;
       
   384 		}
       
   385 	CleanupStack::PopAndDestroy(path);
       
   386 	}
       
   387