/*

* Copyright (c) 2008 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:   MPX My Videos collection plugins' MDS database class*

*/

#ifndef VCXMYVIDEOSMDSDB_H

#define VCXMYVIDEOSMDSDB_H

#include <mdesession.h>

#include <mdequery.h>

#include <harvesterclient.h>

#include <mpxcollectionmessagedefs.h>

#include <vcxmyvideosdefs.h>

#include "vcxmyvideosalbum.h"

class CVcxMyVideosMdsAlbums;

class CMPXMedia;

class CVcxMyVideosMdsCmdQueue;

/**

 *  MPX My Videos collection MDS database observer class.

 *  Part of ECOM Plugin.

 */

NONSHARABLE_CLASS(MVcxMyVideosMdsDbObserver)

    {        

    public:

        /* 

        Defined in mpxcollectionmessagedefs.h:  

        enum TMPXChangeEventType

            {

            EMPXItemDeleted,      // item/playlist deleted

            EMPXItemInserted,     // item/playlist added

            EMPXItemModified      // item/playlist/artist/album/genre/composer modified

            };

        */

        /**

        * Handler function for database events.

        *

        * @param aEvent Event type.

        * @param aId    Array of IDs in database.

        */

        virtual void HandleMyVideosDbEvent( TMPXChangeEventType aEvent, RArray<TUint32>& aId ) = 0;

        /**

        * Handler function for video list fetching events. This callback is called as a response

        * to CreateVideoList( aSync = EFalse ).

        *

        * @param aVideoList          List of videos fetched from MDS.

        * @param aNewItemsStartIndex Start position for the new items added. If -1, then no new

        *                            items were added.

        * @param aComplete           ETrue if list is complete and no more items are expected,

        *                            EFalse if there are more to come.

        */

        virtual void HandleCreateVideoListResp( CMPXMedia* aVideoList,

                TInt aNewItemsStartIndex, TBool aComplete ) = 0;

        /**

        * Handler function for media remove/insert events. This is called every time

        * media is removed or inserted (objects become present or non present).

        */

        virtual void HandleObjectPresentNotification() = 0;

    };

/**

 *  MPX My Videos collection MDS albums related functionality observer class.

 *  Part of ECOM Plugin.

 */

NONSHARABLE_CLASS(MVcxMyVideosMdsAlbumsObserver)

    {        

    public:

        /**

        * This callback is called as a response to GetAlbumsL.

        *

        * @param aAlbumList List of albums fetched from MDS.

        */

        virtual void HandleGetAlbumsResp( CMPXMedia* aAlbumList ) = 0;

        /**

        * This callback is called as a response to GetAlbumContentIdsL.

        *

        * @param aAlbumId      Album ID which was fetched.

        * @param aContentArray Array containing MDS object IDs. This array is the same which

        *                      was given in GetAlbumContentIdsL call.

        */

        virtual void HandleGetAlbumContentIdsResp( TUint32 aAlbumId,

                RArray<TVcxMyVideosAlbumVideo>& aContentArray ) = 0;

        /**

         * Called as a response to GetAlbumContentVideosL.

         * 

         * @param aAlbumId           ID of the album containing the result videos.

         * @param aVideoList         Media containing array of videos.

         * @param aError             Error code in case of failure.

         * @param aFirstNewItemIndex Index of the first new item.

         * @param aNewItemCount      How many new items in the query since the last results.

         * @param aComplete          ETrue if query is complete, EFalse if there is more to come.

         */

        virtual void HandleGetAlbumContentVideosResp( TUint32 aAlbumId, CMPXMedia& aVideoList,

                TInt aError, TInt aFirstNewItemIndex, TInt aNewItemCount, TBool aComplete ) = 0;

        /**

         * Called as a response to AddVideosToAlbumL. Results are written from aItemArray

         * to aCmd (KVcxMediaMyVideosInt32Value attribute). KErrNone if operation was successful,

         * KErrGeneral otherwise.

         * 

         * @param aCmd        Pointer to same object which was given in AddVideosToAlbumL function call.

         * @param aItemArray  Array of relation items that were added to MDS.

         */

        virtual void HandleAddVideosToAlbumResp( CMPXMedia* aCmd,

                RPointerArray<CMdEInstanceItem>& aItemArray ) = 0;

        /**

         * Called as a response to RemoveRelationsL.

         * 

         * @param aRelationIds  Relations which were tried to be removed.

         * @param aResults      Result codes, in sync with aRelationIds. KErrNone if successful,

         *                      KErrGeneral if failed.

         */

        virtual void HandleRemoveRelationsResp( RArray<TUint32>& aRelationIds,

                RArray<TUint32>& aResults ) = 0;

        /**

         * Called as a response to RemoveAlbumsL.

         * 

         * @param aCmd      Cmd which was given in RemoveAlbumsL call.

         * @param aResults  Result IDs.

         */

        virtual void HandleRemoveAlbumsResp( CMPXMedia* aCmd,

                RArray<TUint32>& aResultIds ) = 0;

        /**

         * Event handler function for relation delete events.

         * 

         * @param aType           Event type

         * @param aRelationArray  Array containing relations.

         */

        virtual void HandleRelationEvent( TObserverNotificationType aType,

                const RArray<TMdERelation>& aRelationArray ) = 0;

    };

/**

 *  MPX My Videos collection ECOM plugin's MDS database class.

 */

NONSHARABLE_CLASS(CVcxMyVideosMdsDb) :

                                public CBase,

                                public MMdESessionObserver,

                                public MMdEQueryObserver,

                                public MMdEObjectObserver,

                                public MMdEObjectPresentObserver

    {

public:

    friend class CVcxMyVideosMdsAlbums;

    friend class CVcxMyVideosMdsCmdQueue;

    enum TRequestType

        {

        EAll,

        EGetVideoList,

        EGetAlbums,

        EGetAlbumContentIds,

        EGetAlbumContentVideos,

        EAddVideosToAlbum,

        ERemoveRelations,

        ERemoveAlbums

        };

    /**

     * Two-phased constructor.

     * @param aObserver The db change observer.

     */

    static CVcxMyVideosMdsDb* NewL( MVcxMyVideosMdsDbObserver* aObserver,

            MVcxMyVideosMdsAlbumsObserver* aAlbumsObserver, RFs& aFs );

    /**

     * Two-phased constructor.

     * @param aObserver The db change observer.

     */

    static CVcxMyVideosMdsDb* NewLC( MVcxMyVideosMdsDbObserver* aObserver,

            MVcxMyVideosMdsAlbumsObserver* aAlbumsObserver, RFs& aFs );

    /**

    * Destructor.

    */

    virtual ~CVcxMyVideosMdsDb();

    /**

    * Cancels possible ongoing asynchronous operations.

    * 

    * @param aType What kind of requests are cancelled. 

    */

    void Cancel( TRequestType aType = EAll );

    /**

     * Creates list of videos from MDS. This function utilizes CVcxMyVideosMdsQueue, ie

     * commands are put in queue if there are other commands pending.

     *

     * @param aSortingOrder Sorting order, see values from TSortingOrder.

     * @param aAscending    Sort direction, if ETrue then ascending, else descending.

     * @param aFullDetails  If ETrue, then all details will be filled to media objects,

     *                      if EFalse, then only subset.

     * @param aVideoList    Reference to pointer variable. Container type CMPXMedia class, contains

     *                      CMPXMediaArray filled with CMPXMedia objects. If aVideoList

     *                      pointer variable is NULL, then new medialist is created.

     *                      If pointer variable already contains value, then the given medialist

     *                      should have empty media array. New items are appended to it.

     *                      Caller naturally owns the data.

     *                      

     */

    void CreateVideoListL( TVcxMyVideosSortingOrder aSortingOrder,

            TBool aAscending, TBool aFullDetails, CMPXMedia*& aVideoList );

    /**

     * Add new video.

     *

     * @param aVideo    Reference to CMPXMedia object.

     * @param aMdsId    New mds id is inserted to aMdsId

     */

    void AddVideoL( CMPXMedia& aVideo, TUint32& aMdsId );

    /**

     * Remove video.

     *

     * @param aMdsId ID of the item to be removed.

     * @return       KErrNotFound if video was not found, KErrNone if found and deleted.

     *               If failed, system-wide error code.

     */

    TInt RemoveVideo( TUint32 aMdsId );

    /**

     * Update video.

     *

     * @param aVideo Video to update in MDS database.

     */

    void UpdateVideoL( CMPXMedia& aVideo );

    /**

     * Get one video item from MDS and create a new media

     * object from it.

     *

     * @param aId          Video identifier in MDS database.

     * @param aFullDetails If ETrue, then all details are fetched, othewise only subset.

     * @return             Pointer to media object, ownership moves. NULL if

     *                     not found.

     */

    CMPXMedia* CreateVideoL( TUint32 aId, TBool aFullDetails = ETrue );

// from MMdESessionObserver

	/**

	 * Called to notify the observer that opening the session has been

	 * completed and, if the opening succeeded, the session is ready for use.

	 *

	 * @param aSession  session

	 * @param aError    <code>KErrNone</code>, if opening the session succeeded

	 *     or one of the system-wide error codes, if opening the session failed

	 */

	void HandleSessionOpened(CMdESession& aSession, TInt aError);

	/**

	 * Called to notify the observer about errors, which are not a direct

	 * consequence of the operations initiated by the client but caused by some

	 * external source (e.g., other clients). The error cannot be recovered and

	 * all on-going operations initiated by the client have been aborted.

	 * Any attempts to continue using the session will cause a panic. The

	 * client should close the session immediately and try to open a new

	 * session if it needs to continue using the metadata engine.

	 *

	 * @param aSession  session

	 * @param aError    one of the system-wide error codes

	 */

	void HandleSessionError(CMdESession& aSession, TInt aError);

//  from MMdEQueryObserver

    /**

     * Called to notify the observer that new results have been received 

     * in the query.

     *

     * @param aQuery              Query instance that received new results.

     * @param aFirstNewItemIndex  Index of the first new item that was added

     *                            to the result item array.

     * @param aNewItemCount       Number of items added to the result item 

     *                            array.

     */

    void HandleQueryNewResults(CMdEQuery& aQuery,

                                       TInt aFirstNewItemIndex,

                                       TInt aNewItemCount);

    /**

     * Called to notify the observer that the query has been completed,

     * or that an error has occured.

     *

     * @param aQuery  Query instance.

     * @param aError  <code>KErrNone</code>, if the query was completed

     *                successfully. Otherwise one of the system-wide error 

     *                codes.

     */

    void HandleQueryCompleted(CMdEQuery& aQuery, TInt aError);

// from MMdEObjectObserver

    void HandleObjectNotification( CMdESession& aSession,

            TObserverNotificationType aType,

            const RArray<TItemId>& aObjectIdArray);

// from MMdEObjectPresentObserver

    void HandleObjectPresentNotification(CMdESession& aSession, 

			TBool aPresent, const RArray<TItemId>& aObjectIdArray);

private:

    /**

     * Constructor.

     * @param aObserver The db change observer.

     * @param aFs      Session to file server.

     */

    CVcxMyVideosMdsDb( MVcxMyVideosMdsDbObserver* aObserver,

            MVcxMyVideosMdsAlbumsObserver* aAlbumsObserver, RFs& aFs );

    void ConstructL();

    /**

     * Gets object from MDS.

     *

     * @param aId      The ID of the object to get.

     * @param aIsVideo Set to ETrue if the object to be fetched is video. If set to

     *                 EFalse, then the object is assumed to be album.

     * @return         The object if found, NULL otherwise.

     */

    CMdEObject* ObjectL( const TItemId aId, TBool aIsVideo = ETrue );

    /**

     * Read the video details from the given object to the media class.

     *

     * @param aObject       The object to read from.

     * @param aVideo        The media object to write to.

     * @param aFullDetails  If ETrue, then all parameters are copied, if

     *                      EFalse, then only subset which is (usually) needed when

     *                      showing videolist on UI.

     */

    void Object2MediaL(

            CMdEObject& aObject,

            CMPXMedia& aVideo,

            TBool aFullDetails = EFalse );

    /**

     * Fill the object from media.

     *

     * @param aMedia  The media class to read from.

     * @param aObject The object to modify.

     */

    void Media2ObjectL( CMPXMedia& aVideo, CMdEObject& aObject );

    /*

     * Get the schema definitions needed.

     */

    void GetSchemaDefinitionsL();

    /**

    * Handles MDS object changes.

    *

    * @param aType           Type of the event.

    * @param aObjectIdArray  MDS IDs.

    */

    void DoHandleObjectNotificationL(

            TObserverNotificationType aType,

            const RArray<TItemId>& aObjectIdArray );

    /**

     * Leaving version of HandleQueryNewResults.

     * Called to notify the observer that new results have been received 

     * in the query.

     *

     * @param aQuery              Query instance that received new results.

     * @param aFirstNewItemIndex  Index of the first new item that was added

     *                            to the result item array.

     * @param aNewItemCount       Number of items added to the result item 

     *                            array.

     */

    void DoHandleQueryNewResultsL(CMdEQuery& aQuery,

            TInt aFirstNewItemIndex, TInt aNewItemCount);

    /**

     * Creates list of videos from MDS.

     *

     * @param aSortingOrder Sorting order, see values from TSortingOrder.

     * @param aAscending    Sort direction, if ETrue then ascending, else descending.

     * @param aFullDetails  If ETrue, then all details will be filled to media objects,

     *                      if EFalse, then only subset.

     * @param aVideoList    Reference to pointer variable. Container type CMPXMedia class, contains

     *                      CMPXMediaArray filled with CMPXMedia objects. If aVideoList

     *                      pointer variable is NULL, then new medialist is created.

     *                      If pointer variable already contains value, then the given medialist

     *                      should have empty media array. New items are appended to it.

     *                      Caller naturally owns the data.

     *                      

     */

    void DoCreateVideoListL( TVcxMyVideosSortingOrder aSortingOrder,

            TBool aAscending, TBool aFullDetails, CMPXMedia*& aVideoList );

    /**

     * Handles query complete events asynchronously.

     */

    static TInt AsyncHandleQueryCompleted( TAny* aPtr );

    /**

     * Sets Creation Date and Modified properties to object. Uses current date

     * value.

     * 

     * @param aObject  Object to modify.

     */

    void SetCreationAndModifiedDatesL( CMdEObject& aObject );

    /**

     * Sets creation date to aObject from aVideo.

     * 

     * @param aVideo  Creation date is copied from here.

     * @param aObject Creation date is written here.

     */

    void SetCreationDateToObjectL( const CMPXMedia& aVideo, CMdEObject& aObject );

public:

    /**

    * Set to ETrue when starting to fetch media list from MDS.

    * Set to EFalse when fetching is finished.

    */

    TBool iVideoListFetchingIsOngoing;

    /**

    * Album related functionality.

    */

    CVcxMyVideosMdsAlbums* iAlbums;

private: // data

    /**

    * Command queue. Own.

    */

    CVcxMyVideosMdsCmdQueue* iCmdQueue;

    /**

     * The MDS session object. Own.

     */

    CMdESession* iMdsSession;

    /**

     * The error code saved from the callbacks.

     */

    TInt iMdsError;

    /**

    * Asynchronous video list fetching query is stored here.

    */

    CMdEObjectQuery* iVideoQuery;

    /**

    * Pointer to video list which is being fetched from the MDS.

    * Not own.

    */

    CMPXMedia* iVideoList;

    /**

     * Requested detail level is stored here during the asynchronous video list fetching.

     */

    TBool iFullDetails;

    /**

    * The default namespace definition. Not own.

    */