/*

* Copyright (c) 2002 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:  Implementation of the CProfileEngineImpl.

*

*/

// INCLUDE FILES

#include "CProfileEngineImpl.h"

#include <bautils.h> // BaflUtils

#include <barsc.h> // RResoureFile

#include <featmgr.h>

#include <bldvariant.hrh>

#include <DRMCommon.h>

#include <sysutil.h>

#include <TProfileToneSettings.h>

#include <MProfileTones.h>

#include "CProfilesNamesArrayImpl.h"

#include "CProfileImpl.h"

#include "CProfileNameImpl.h"

#include "ProfileEngUtils.h"

#include <MProfileSetName.h>

#include <ProfileEng.hrh>

#include <ProfileEngineConstants.h>

#include "ProfileEngPanic.h"

#include <MProfileSetTones.h>

#include <MProfileSetExtraTones.h>

#include "MProfileExtraSettings.h"

#include "MProfileFeedbackSettings.h"

#include <MProfilesLocalFeatures.h>

#include <MProfileUtilitySingleton.h>

#include "ProfilesVariant.hrh" // KProEngFeatureIdVTRingingTone

#include "CProfileTiming.h"

#include <centralrepository.h>

#include "ProfileEnginePrivateCRKeys.h"

#include <ProfileEnginePrivatePSKeys.h>

#include <hwrmvibrasdkcrkeys.h>

#include <data_caging_path_literals.hrh>

#include "ProfilesDebug.h"

#include <psmsettings.h>

#include <psmsrvdomaincrkeys.h>

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

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

// CProfileEngineImpl::NewL

// Two-phased constructor.

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

//

CProfileEngineImpl* CProfileEngineImpl::NewL()

    {

    CProfileEngineImpl* self = CProfileEngineImpl::NewLC();

    CleanupStack::Pop();

    return self;

    }

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

// CProfileEngineImpl::NewLC

// Two-phased constructor.

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

//

CProfileEngineImpl* CProfileEngineImpl::NewLC()

    {

    CProfileEngineImpl* self = new ( ELeave ) CProfileEngineImpl;

    CleanupStack::PushL( self );

    self->ConstructL();

    return self;

    }

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

// CProfileEngineImpl::NewL

// Two-phased constructor.

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

//

CProfileEngineImpl* CProfileEngineImpl::NewL( RFs* aFs )

    {

    CProfileEngineImpl* self = CProfileEngineImpl::NewLC( aFs );

    CleanupStack::Pop();

    return self;

    }

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

// CProfileEngineImpl::NewLC

// Two-phased constructor.

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

//

CProfileEngineImpl* CProfileEngineImpl::NewLC( RFs* aFs )

    {

    CProfileEngineImpl* self = new ( ELeave ) CProfileEngineImpl;

    CleanupStack::PushL( self );

    self->ConstructL( aFs );

    return self;

    }

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

// CProfileEngineImpl::ConstructL

// Symbian 2nd phase constructor can leave.

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

//

void CProfileEngineImpl::ConstructL()

    {

    iFs = new ( ELeave ) RFs;

    iFsOwned = ETrue;

    User::LeaveIfError( iFs->Connect() );

    CommonConstructL();

    }

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

// CProfileEngineImpl::ConstructL

// Symbian 2nd phase constructor can leave.

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

//

void CProfileEngineImpl::ConstructL( RFs* aFs )

    {

    iFs = aFs;

    CommonConstructL();

    }

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

// CProfileEngineImpl::CommonConstructL

// Symbian 2nd phase constructor can leave.

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

//

void CProfileEngineImpl::CommonConstructL()

    {

    PRODEBUG( "Profiles Engine CommonConstructL" );

    FeatureManager::InitializeLibL();

    iSideVolumeKeys = FeatureManager::FeatureSupported( KFeatureIdSideVolumeKeys );

    iCenRep = CRepository::NewL( KCRUidProfileEngine );

    iVibraCenRep = CRepository::NewL( KCRUidVibraCtrl );

    // Profile Utility must be released in destructor:

    iFeatures = &( ProfileUtilityInstanceL().ProfilesLocalFeatures() );

    iProfileLocalisedNames = CProfilesNamesArrayImpl::NewL();

    ReadProfilesNamesFromResourceL();

    iProfileTiming = CProfileTiming::NewL( *iCenRep, *iFeatures );

    // Open/Create mutex

    TInt error( KErrNotFound );

    while( error == KErrNotFound )

        {

        error = iMutex.CreateGlobal( KProfileMutexName );

        if( error != KErrAlreadyExists )

            {

            break;

            }

        error = iMutex.OpenGlobal( KProfileMutexName );

        }

    User::LeaveIfError( error );

    PRODEBUG( "Profiles Engine CommonConstructL end" );

    }

// Destructor

CProfileEngineImpl::~CProfileEngineImpl()

    {

    iMutex.Close();

    iProperty.Close();

    delete iProfileTiming;

    delete iProfileLocalisedNames;

    if ( iFeatures )

        {

        ReleaseProfileUtility();    

        }

    delete iCenRep;

    delete iVibraCenRep;

    if( iFsOwned )

        {

        iFs->Close();

        delete iFs;

        }

    FeatureManager::UnInitializeLib();

    }

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

// CProfileEngineImpl::ActiveProfileLC

//

// (other items were commented in a header).

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

//

MProfile* CProfileEngineImpl::ActiveProfileLC()

    {

    TInt id( User::LeaveIfError( ActiveProfileId() ) );

    MProfileExtended* profile = ProfileLC( id );

    return profile;

    }

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

// CProfileEngineImpl::ActiveProfileL

//

// (other items were commented in a header).

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

//

MProfile* CProfileEngineImpl::ActiveProfileL()

    {

    MProfile* profile = ActiveProfileLC();

    CleanupStack::Pop();    // profile

    return profile;

    }

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

// CProfileEngineImpl::ProfileLC

//

// (other items were commented in a header).

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

//

MProfileExtended* CProfileEngineImpl::ProfileLC(

    TInt aId )

    {

    CProfileImpl* profile = NULL;

    iMutex.Wait();

    TInt err( CheckProfileIdL( aId ) );

    if( !err )

        {

        TRAP( err, profile = GetProfileL( aId ) );

        }

    iMutex.Signal();

    User::LeaveIfError( err );

    CleanupStack::PushL( profile );

    if( iSideVolumeKeys )

        {

        // Because SetTemp*VolumeL() functions update only Shared Data those

        // values must be read from SD and set to the MProfile instance

        // returned to the caller:

        TInt activeId( User::LeaveIfError( ActiveProfileId() ) );

        if( activeId == aId )

            {

            TProfileToneSettings& settings =

                    profile->ProfileSetTones().SetToneSettings();

            settings.iRingingVolume = TempRingingVolumeL();

            settings.iMediaVolume = TempMediaVolumeL();

            }

        }

    if( !profile->IsProfileNameChanged() )

        {

        if( IsDefaultProfile( aId ) )

            {

            profile->SetLocalizedProfileNameL( *iProfileLocalisedNames );

            }

        else

            {

            SetLocalizedNameForDynamicProfileL( *profile );

            }

        }

    return profile;

    }

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

// CProfileEngineImpl::ProfileL

//

// (other items were commented in a header).

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

//

MProfileExtended* CProfileEngineImpl::ProfileL(

    TInt aId )

    {

    MProfileExtended* profile = ProfileLC( aId );

    CleanupStack::Pop();    // profile

    return profile;

    }

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

// CProfileEngineImpl::SetActiveProfileL

//

// (other items were commented in a header).

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

//

void CProfileEngineImpl::SetActiveProfileL( TInt aId )

    {

    PRODEBUG1( "SetActiveProfileL( %d )", aId );

    CreatePubSubKeysIfNeededL(); 

    iMutex.Wait();

    TInt err( CheckProfileIdL( aId ) );

    if( !err )

        {

        TRAP( err, DoSetActiveProfileL( aId ) );

        }

    else

        {

        // Timed profile was deleted while time expired

        // So pass event to ActiveIdle2 to deal with time icon.

        iProfileTiming->CancelTimedProfileL();

        PublishChangeL( KProEngActiveProfileModified );    

        }

    iMutex.Signal();

    PRODEBUG1( "SetActiveProfileL err=%d", err );

    User::LeaveIfError( err );

    PRODEBUG1( "SetActiveProfileL( %d ) end", aId );

    }

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

// CProfileEngineImpl::IsActiveProfileTimedL

//

// (other items were commented in a header).

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

//

TBool CProfileEngineImpl::IsActiveProfileTimedL()

    {

    return iProfileTiming->IsTimingActiveL();

    }

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

// CProfileEngineImpl::SetActiveProfileTimedL

//

// (other items were commented in a header).

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

//

void CProfileEngineImpl::SetActiveProfileTimedL( TInt aId, TTime aTime )

    {

    if( !iFeatures->IsFeatureSupported( KProEngFeatureIdTimedProfiles ) )

        {

        User::Leave( KErrNotSupported );

        }

    CreatePubSubKeysIfNeededL(); 

    iMutex.Wait();

    TInt err( CheckProfileIdL( aId ) );

    if( !err )

        {

        TRAP( err, DoSetActiveProfileL( aId, &aTime ) );

        }

    iMutex.Signal();

    User::LeaveIfError( err );

    }

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

// CProfileEngineImpl::ReadResourceInBufferLC

//

// (other items were commented in a header).

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

//

void CProfileEngineImpl::ReadResourceInBufferLC( TInt aResourceId,

        TResourceReader& aReader )

    {

    TParse* fp = new ( ELeave ) TParse();

    fp->Set( KProfileEngineResourceDriveAndDir, &KDC_RESOURCE_FILES_DIR, NULL );

    iFileName.Copy( fp->FullName() );

    delete fp;

    BaflUtils::NearestLanguageFile( *iFs, iFileName );

    RResourceFile resourceFile;

    resourceFile.OpenL( *iFs, iFileName );

    CleanupClosePushL( resourceFile );

    resourceFile.ConfirmSignatureL( PROFILES_ENGINE_RESOURCE_SIGNATURE );

    HBufC8* dataBuffer = resourceFile.AllocReadLC( aResourceId );

    CleanupStack::Pop(); // dataBuffer

    CleanupStack::PopAndDestroy(); // resourceFile.Close()

    CleanupStack::PushL( dataBuffer );

    aReader.SetBuffer( dataBuffer );

    }

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

// CProfileEngineImpl::ReadProfilesNamesFromResourceL

//

// (other items were commented in a header).

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

//

void CProfileEngineImpl::ReadProfilesNamesFromResourceL()

    {

    TResourceReader rsReader;

    ReadResourceInBufferLC( R_DEFAULT_PROFILES, rsReader );

    TInt numOfElements( rsReader.ReadInt16() );

    for( TInt i( 0 ) ; i < numOfElements ; ++i )

        {

        TInt profileId( rsReader.ReadInt32() );

        TPtrC profileName( rsReader.ReadTPtrC() );

        TPtrC shortName( rsReader.ReadTPtrC() );

        TPtrC naviName( rsReader.ReadTPtrC() );

        TPtrC titleName( rsReader.ReadTPtrC() );

        CProfileNameImpl* pn =

            CProfileNameImpl::NewLC( profileId, profileName, shortName,

                                     naviName, titleName );

        User::LeaveIfError( iProfileLocalisedNames->Append( pn ) );

        CleanupStack::Pop(); // pn

        }

    CleanupStack::PopAndDestroy(); // ReadResourceInBufferLC()

    }

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

// CProfileEngineImpl::Release

//

// (other items were commented in a header).

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

//

void CProfileEngineImpl::Release()

    {

    delete this;

    }

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

// CProfileEngineImpl::SendPresenceSettingsL

//

// (other items were commented in a header).

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

//

void CProfileEngineImpl::SendPresenceSettingsL(

    const MProfilePresence& /* aPresence */ )

    {

    }

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

// CProfileEngineImpl::IsDefaultProfile

//

// (other items were commented in a header).

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

//

TBool CProfileEngineImpl::IsDefaultProfile( TInt aId )

    {

    return ( iProfileLocalisedNames->FindById( aId ) != KErrNotFound );

    }

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

// CProfileEngineImpl::LocalFeaturesL

//

// (other items were commented in a header).

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

//

MProfilesLocalFeatures& CProfileEngineImpl::LocalFeatures()

    {

    return *iFeatures;

    }

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

// CProfileEngineImpl::IsFeatureSupported

//

// (other items were commented in a header).

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

//

TBool CProfileEngineImpl::IsFeatureSupported(

        TProfileFeatureId aFeatureId ) const

    {

    switch( aFeatureId )

        {

        case EProfileFeatureVTRingingTone:

            {

            return iFeatures->IsFeatureSupported(

                    KProEngFeatureIdVTRingingTone );

            // no break after return

            }

        default:

            {

            return EFalse;

            // no break after return

            }

        }

    }

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

// CProfileEngineImpl::ProfileUtilityObject

//

// (other items were commented in a header).

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

//

void CProfileEngineImpl::GetProfileUtilityObject(

        TProfileUtilityObjectType /* aType */, TAny*& /* aImpl */ )

    {

    }

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

// CProfileEngineImpl::LeaveIfReadOnlyL

//

// (other items were commented in a header).

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

//

void CProfileEngineImpl::LeaveIfReadOnlyL( TProfileFlags aFlag )

    {

    MProfileExtended* profile = ProfileLC( ActiveProfileId() );

    TUint32 flags = profile->ModifiableFlags();

    CleanupStack::PopAndDestroy(); // profile

    if( !( flags & aFlag ) )

        {

        User::Leave( KErrAccessDenied );

        }

    }

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