/*

* Copyright (c) 2007 Nokia Corporation and/or its subsidiary(-ies).

* All rights reserved.

* This component and the accompanying materials are made available

* under the terms of "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:  Responsible for interation with the category tables:

*                Artist, Album, Genre and Composer

*

*/

// INCLUDE FILES

#include <sqldb.h>

#include <mpxlog.h>

#include "mpxdbcommonutil.h"

#include "mpxdbcommondef.h"

#include "mpxdbmanager.h"

#include "mpxcollectiondbdef.h"

#include "mpxdbpluginqueries.h"

#include "mpxdbutil.h"

#include "mpxdbcategory.h"

// CONSTANTS

// maximum number of table name entries per query

const TInt KMaxTableNameCount = 2;

// ============================ MEMBER FUNCTIONS ==============================

// ----------------------------------------------------------------------------

// Destructor

// ----------------------------------------------------------------------------

//

CMPXDbCategory::~CMPXDbCategory()

    {

    MPX_FUNC("CMPXDbCategory::~CMPXDbCategory");

    delete iTableName;

    }

// ----------------------------------------------------------------------------

// Constructor

// ----------------------------------------------------------------------------

//

CMPXDbCategory::CMPXDbCategory(

    CMPXDbManager& aDbManager,

    TMPXGeneralCategory aCategory) :

    CMPXDbTable(aDbManager),

    iCategory(aCategory)

    {

    MPX_FUNC("CMPXDbCategory::CMPXDbCategory");

    }

// ----------------------------------------------------------------------------

// Second phase constructor.

// ----------------------------------------------------------------------------

//

void CMPXDbCategory::BaseConstructL()

    {

    MPX_FUNC("CMPXDbCategory::BaseConstructL");

    CMPXDbTable::BaseConstructL();

    iTableName = MPXDbUtil::TableNameForCategoryL(iCategory).AllocL();

    }

// ----------------------------------------------------------------------------

// CMPXDbCategory::AddItemL

// ----------------------------------------------------------------------------

//

TUint32 CMPXDbCategory::AddItemL(

    TInt aDriveId,

    TBool& aNewRecord,

    TBool aCaseSensitive)

    {

    MPX_FUNC("CMPXDbCategory::AddItemL");

    // try to find the item first

    TUint32 rowId(MPXDbCommonUtil::GenerateUniqueIdL(iDbManager.Fs(), iCategory,

    aNewRecord = !CategoryItemExistsL(aDriveId, rowId);

    if (aNewRecord)

        {

        // insert new

        HBufC* query = PreProcessStringLC(KQueryCategoryInsert);

        iDbManager.ExecuteQueryL(aDriveId, *query, rowId, name, 1);

        CleanupStack::PopAndDestroy(name);

        CleanupStack::PopAndDestroy(query);

        }

    else

        {

        // increment the number of songs for the category

        HBufC* query = PreProcessStringLC(KQueryCategoryIncrementSongCount);

        iDbManager.ExecuteQueryL(aDriveId, *query, rowId);

        CleanupStack::PopAndDestroy(query);

        }

    return rowId;

    }

// ----------------------------------------------------------------------------

// CMPXDbCategory::GetNameL

// ----------------------------------------------------------------------------

//

HBufC* CMPXDbCategory::GetNameL(

    TUint32 aId)

    {

    MPX_FUNC("CMPXDbCategory::GetNameL");

    RSqlStatement recordset(GetCategoryRecordL(aId));

    CleanupClosePushL(recordset);

    if (recordset.Next() != KSqlAtRow)

        {

        User::LeaveIfError(KErrNotFound);

        }

    HBufC* name = MPXDbCommonUtil::GetColumnTextL(recordset, ECategoryName).AllocL();

    CleanupStack::PopAndDestroy(&recordset);

    return name;

    }

// ----------------------------------------------------------------------------

// CMPXDbCategory::CountL

// ----------------------------------------------------------------------------

//

TInt CMPXDbCategory::CountL()

    {

    MPX_FUNC("CMPXDbCategory::CountL");

    HBufC* query = PreProcessStringLC(KQueryCategoryCount);

    TInt count(ExecuteSumQueryL(*query));

    CleanupStack::PopAndDestroy(query);

    return count;

    }

// ----------------------------------------------------------------------------

// CMPXDbCategory::FindAllL

// ----------------------------------------------------------------------------

//

void CMPXDbCategory::FindAllL(

    const CMPXMedia& aCriteria,

    const TArray<TMPXAttribute>& aAttrs,

    CMPXMediaArray& aMediaArray)

    {

    MPX_FUNC("CMPXDbCategory::FindAllL");

    TMPXGeneralType type = aCriteria.ValueTObjectL<TMPXGeneralType>(KMPXMediaGeneralType);

    const TArray<TMPXAttribute> criteria = aCriteria.Attributes();

    TInt criteriaCount(criteria.Count());

    // process the criteria and construct the criteria string

    CDesCArrayFlat* criteriaArray = new (ELeave) CDesCArrayFlat(criteriaCount + 1);

    CleanupStack::PushL(criteriaArray);

    for (TInt i = 0; i < criteriaCount; ++i)

        {

        const TMPXAttribute& criterion = criteria[i];

        if ((type == EMPXItem) && (criterion == KMPXMediaGeneralId))

            {

            TUint32 itemId = (aCriteria.ValueTObjectL<TMPXItemId>(KMPXMediaGeneralId)).iId2;

            if (MPX_ITEM_CATEGORY(itemId) != iCategory)

                {

                User::Leave(KErrNotSupported);

                }

            HBufC* critStr = PreProcessStringLC(KCriterionCategoryUniqueId);

            MPXDbCommonUtil::AddSqlCriterionL(*criteriaArray, *critStr, itemId);

            CleanupStack::PopAndDestroy(critStr);

            }

        else if (criterion == KMPXMediaGeneralTitle)

            {

#ifdef RD_MPX_COLLECTION_CACHE

            if (aCriteria.ValueText(KMPXMediaGeneralTitle).Length() <= 0)

                {

                TUint32 itemId = MPXDbCommonUtil::GenerateUniqueIdL(

                                    iDbManager.Fs(), iCategory, KNullDesC, EFalse);

                HBufC* critStr = PreProcessStringLC(KCriterionCategoryUniqueId);

                MPXDbCommonUtil::AddSqlCriterionL(*criteriaArray, *critStr, itemId);

                CleanupStack::PopAndDestroy(critStr);

                }

            else

                {

#endif //RD_MPX_COLLECTION_CACHE

                HBufC* critStr = PreProcessStringLC(KCriterionCategoryName);

                HBufC* title = MPXDbCommonUtil::ProcessPatternCharsLC(

                    aCriteria.ValueText(KMPXMediaGeneralTitle));

                MPXDbCommonUtil::AddSqlCriterionL(*criteriaArray, *critStr, *title);

                CleanupStack::PopAndDestroy(2, critStr); // title & critStr

#ifdef RD_MPX_COLLECTION_CACHE

                }

#endif //RD_MPX_COLLECTION_CACHE

            }

#ifdef ABSTRACTAUDIOALBUM_INCLUDED

        else if (criterion == KMPXMediaGeneralUri)

            {

            //only Genre and  AbstractAlbum are not case sensitive

            TBool caseSensitive = ETrue;            

            if ((iCategory == EMPXGenre) || (iCategory == EMPXAbstractAlbum))

                 caseSensitive = EFalse;

            TUint32 itemId(MPXDbCommonUtil::GenerateUniqueIdL(iDbManager.Fs(), iCategory,

                 aCriteria.ValueText(KMPXMediaGeneralUri), caseSensitive));   

            HBufC* critStr = PreProcessStringLC(KCriterionCategoryUniqueId);

            MPXDbCommonUtil::AddSqlCriterionL(*criteriaArray, *critStr, itemId);

            CleanupStack::PopAndDestroy(critStr);

            }

        else if (criterion == KMPXMediaGeneralDrive)

            {

            const TDesC& drive(aCriteria.ValueText(KMPXMediaGeneralDrive));

            TDriveUnit driveUnit(drive);

            MPXDbCommonUtil::AddSqlCriterionL(*criteriaArray, KCriterionAbstractAlbumVolumeId,

                MPXDbCommonUtil::GetVolIdMatchDriveIdL(iDbManager.Fs(), driveUnit));

            }

#endif // ABSTRACTAUDIOALBUM_INCLUDED

        else

            {

            // ignore attribute

            }

        }

    // construct criteria string

    CleanupClosePushL(recordset);

    // process the results

    ProcessRecordsetL(aAttrs, recordset, aMediaArray);

    CleanupStack::PopAndDestroy(&recordset);

    }

// ----------------------------------------------------------------------------

// CMPXDbCategory::DecrementSongsForCategoryL

// ----------------------------------------------------------------------------

//

void CMPXDbCategory::DecrementSongsForCategoryL(

    const TUint32 aId,

    TInt aDriveId,

    CMPXMessageArray* aItemChangedMessages,

    TBool& aItemExist

#ifdef ABSTRACTAUDIOALBUM_INCLUDED

    ,

    TBool /*aMTPInUse*/

#endif //ABSTRACTAUDIOALBUM_INCLUDED

)

    {

    MPX_FUNC("CMPXDbCategory::DecrementSongsForCategoryL");

    // if just one song uses this category. Use <= just in case

    if (GetSongsCountL(aDriveId, aId) <= 1)

        {

        aItemExist = EFalse;

        // delete the category

        DeleteCategoryL(aId, aDriveId);

        if (aItemChangedMessages)

            {

            // add the item changed message

            MPXDbCommonUtil::AddItemChangedMessageL(*aItemChangedMessages, aId, EMPXItemDeleted,

                iCategory, KDBPluginUid);

            }

        }

    else

        {

        aItemExist = ETrue;

        // decrement the number of songs for the category

        HBufC* query = PreProcessStringLC(KQueryCategoryDecrementSongCount);

        iDbManager.ExecuteQueryL(aDriveId, *query, aId);

        CleanupStack::PopAndDestroy(query);

        }

    }

// ----------------------------------------------------------------------------

// CMPXDbCategory::DeleteCategoryL

// ----------------------------------------------------------------------------

//

void CMPXDbCategory::DeleteCategoryL(

    TUint32 aId,

    TInt aDriveId)

    {

    MPX_FUNC("CMPXDbCategory::DeleteCategoryL");

    HBufC* query = PreProcessStringLC(KQueryCategoryDelete);

    iDbManager.ExecuteQueryL(aDriveId, *query, aId);

    CleanupStack::PopAndDestroy(query);

    }

// ----------------------------------------------------------------------------

// CMPXDbCategory::GetCategoryItemsL

// ----------------------------------------------------------------------------

//

void CMPXDbCategory::GetCategoryItemsL(

    const TArray<TMPXAttribute>& aAttrs,

    CMPXMediaArray& aMediaArray)

    {

    MPX_FUNC("CMPXDbCategory::GetCategoryItemsL");

    // have to run one query to get all items as opposed to individual queries

    // because of the sorting

    // construct the unique ID criteria string

    // (UniqueId = %u OR UniqueId = %u ...)

    TInt count(aMediaArray.Count());

    HBufC* criteria = HBufC::NewLC((2 * KCriterionCategoryUniqueId().Length() +

        KMCIntegerLen + KMCOrKeyword().Length() + 2) * count);

    TPtr ptr(criteria->Des());

    ptr.Append(KMCOpenBracket);

    for (TInt index = 0; index < count; ++index)

        {

        CMPXMedia* media = aMediaArray[index];

        HBufC* critStr = PreProcessStringLC(KCriterionCategoryUniqueId);

        HBufC* criterion = MPXDbCommonUtil::SqlCriterionLC(*critStr,

            (media->ValueTObjectL<TMPXItemId>(KMPXMediaGeneralId)).iId1);

        ptr.Append(*criterion);

        CleanupStack::PopAndDestroy(criterion);

        CleanupStack::PopAndDestroy(critStr);

        if (index < (count - 1))

            {

            ptr.Append(KMCOrKeyword);

            }

        }

    ptr.Append(KMCCloseBracket);

    // the array has to be reset as the items have to be returned in a different sort order

    aMediaArray.Reset();

    HBufC* query = PreProcessStringLC(KQueryCategoryItems);

    RSqlStatement recordset(iDbManager.ExecuteSelectQueryL(*query, criteria));

    CleanupStack::PopAndDestroy(query);

    CleanupStack::PopAndDestroy(criteria);

    CleanupClosePushL(recordset);

    ProcessRecordsetL(aAttrs, recordset, aMediaArray);

    CleanupStack::PopAndDestroy(&recordset);

    }

// ----------------------------------------------------------------------------

// CMPXDbCategory::GetAllCategoryItemsL

// ----------------------------------------------------------------------------

//

void CMPXDbCategory::GetAllCategoryItemsL(

    const TArray<TMPXAttribute>& aAttrs,

    CMPXMediaArray& aMediaArray)

    {

    MPX_FUNC("CMPXDbCategory::GetAllCategoryItemsL");

    HBufC* query = PreProcessStringLC(KQueryCategoryAll);

    RSqlStatement recordset(iDbManager.ExecuteSelectQueryL(*query));

    CleanupStack::PopAndDestroy(query);

    CleanupClosePushL(recordset);

    ProcessRecordsetL(aAttrs, recordset, aMediaArray);

    CleanupStack::PopAndDestroy(&recordset);

    }

// ----------------------------------------------------------------------------

// CMPXDbCategory::GetCategoryItemL

// ----------------------------------------------------------------------------

//

void CMPXDbCategory::GetCategoryItemL(

    TUint32 aId,

    const TArray<TMPXAttribute>& aAttrs,

    CMPXMedia& aMedia)

    {

    MPX_FUNC("CMPXDbCategory::GetCategoryItemL");

    HBufC* query = PreProcessStringLC(KQueryCategoryItem);

    ExecuteMediaQueryL(aAttrs, aMedia, *query, aId);

    CleanupStack::PopAndDestroy(query);

    }

// ----------------------------------------------------------------------------

// CMPXDbCategory::GetSubCategoryItemsL

// ----------------------------------------------------------------------------

//

void CMPXDbCategory::GetSubCategoryItemsL(

    TMPXGeneralCategory aParentCategory,

    TUint32 aParentId,

    const TArray<TMPXAttribute>& aAttrs,

    CMPXMediaArray& aMediaArray)

    {

    MPX_FUNC("CMPXDbCategory::GetSubCategoryItemsL");

    // this is only valid for albums belonging to an artist

    ASSERT((iCategory == EMPXAlbum) && (aParentCategory == EMPXArtist));

    // to handle the UREL warning

    (void)aParentCategory;

    RSqlStatement recordset(iDbManager.ExecuteSelectQueryL(KQueryCategorySubcategoryItems, aParentId));

    CleanupClosePushL(recordset);

    ProcessRecordsetL(aAttrs, recordset, aMediaArray);

    CleanupStack::PopAndDestroy(&recordset);

    }

// ----------------------------------------------------------------------------

// CMPXDbCategory::CategoryItemExistsL

// The category records must be in the same database as the corresponding

// Music record, otherwise when adding a duplicate of a song on a

// different drive this method will return true and the category record won't

// be created.

// ----------------------------------------------------------------------------

//

TBool CMPXDbCategory::CategoryItemExistsL(

    TInt aDriveId,

    TUint32 aId)

    {

    MPX_FUNC("CMPXDbCategory::CategoryItemExistsL");

    HBufC* query = PreProcessStringLC(KQueryCategoryItem);

    RSqlStatement recordset(

        iDbManager.ExecuteSelectQueryL(aDriveId, *query, aId));

    TBool exists(recordset.Next() == KSqlAtRow);

    recordset.Close();

    CleanupStack::PopAndDestroy(query);

    return exists;

    }

// ----------------------------------------------------------------------------

// CMPXDbCategory::GetSongsCountL

// ----------------------------------------------------------------------------

//

TInt CMPXDbCategory::GetSongsCountL(

    TInt aDriveId,

    TUint32 aId)

    {

    MPX_FUNC("CMPXDbCategory::GetSongsCountL");

    HBufC* query = PreProcessStringLC(KQueryCategoryGetSongCount);

    RSqlStatement recordset(

        iDbManager.ExecuteSelectQueryL(aDriveId, *query, aId));

    CleanupClosePushL(recordset);

    TInt err(KErrNone);

    TInt ret(0);

    while ((err = recordset.Next()) == KSqlAtRow)

        {

        ret += recordset.ColumnInt(KMPXTableDefaultIndex);

        }

    if (err != KSqlAtEnd)

        {

        User::Leave(err);

        }

    CleanupStack::PopAndDestroy(&recordset);

    CleanupStack::PopAndDestroy(query);

    return ret;

    }

void CMPXDbCategory::UpdateItemL(

    TUint32 /*aId*/,

    const CMPXMedia& /*aMedia*/,

    TInt /*aDriveId*/,

    CMPXMessageArray* /*aItemChangedMessages*/)

	{

	}

// ----------------------------------------------------------------------------

// CMPXDbCategory::UpdateMediaL

// ----------------------------------------------------------------------------

//

void CMPXDbCategory::UpdateMediaL(

    RSqlStatement& aRecord,

    const TArray<TMPXAttribute>& aAttrs,

    CMPXMedia& aMedia)

    {

    MPX_FUNC("CMPXDbCategory::UpdateMediaL");