/*

* Copyright (c) 2009-2010 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: Class to manage Bluetooth hardware and stack settings.

*

*/

#include "btengsrvsettingsmgr.h"

#include <bthci.h>

#include <bt_subscribe_partner.h>

#include <btnotif.h>

#include <btengdomainpskeys.h>

#include <centralrepository.h>

#include <featmgr.h>

#include "btengserver.h"

#include "btengsrvpluginmgr.h"

#include "btengsrvbbconnectionmgr.h"

#include "btengsrvstate.h"

#include "debug.h"

#include <btindicatorconstants.h>

#include <hbindicatorsymbian.h>

#include <hbsymbianvariant.h>

/** ID of active object helper */

const TInt KBTEngSettingsActive = 30;

/** Constant for converting minutes to microseconds */

//const TInt64 KMinutesInMicroSecs = 60000000;

const TInt64 KMinutesInMicroSecs = MAKE_TINT64( 0, 60000000 );

/**  Timeout for disabling Simple Pairing debug mode. The value is 30 minutes. */

//const TInt KBTEngSspDebugModeTimeout = 1800000000;

const TInt64 KBTEngSspDebugModeTimeout = MAKE_TINT64( 0, 1800000000 );

/**  Timeout for turning BT off automatically. The value is 10.5 seconds. */

const TInt KBTEngBtAutoOffTimeout = 10500000;

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

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

// C++ default constructor

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

//

CBTEngSrvSettingsMgr::CBTEngSrvSettingsMgr( CBTEngServer* aServer )

:   iServer( aServer ),iIndicatorState(-1)

    {

    }

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

// Symbian second-phase constructor

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

//

void CBTEngSrvSettingsMgr::ConstructL()

    {

    TRACE_FUNC_ENTRY

    iActive = CBTEngActive::NewL( *this, KBTEngSettingsActive );

    iBTIndicator = CHbIndicatorSymbian::NewL(); 

    LoadBTPowerManagerL();

    iEnterpriseEnablementMode = BluetoothFeatures::EnterpriseEnablementL();

    TRACE_INFO( ( _L( "iEnterpriseEnablementMode = %d" ), iEnterpriseEnablementMode) )

    if ( iEnterpriseEnablementMode == BluetoothFeatures::EDisabled )

        {

        SetVisibilityModeL( EBTVisibilityModeNoScans, 0 );

        }

    TRACE_FUNC_EXIT

    }

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

// NewL

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

//

CBTEngSrvSettingsMgr* CBTEngSrvSettingsMgr::NewL( CBTEngServer* aServer )

    {

    CBTEngSrvSettingsMgr* self = new( ELeave ) CBTEngSrvSettingsMgr( aServer );

    CleanupStack::PushL( self );

    self->ConstructL();

    CleanupStack::Pop( self );

    return self;

    }

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

// Destructor

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

//

CBTEngSrvSettingsMgr::~CBTEngSrvSettingsMgr()

    {

    delete iActive;  

    delete iBTIndicator;

    iPowerMgr.Close();

    }

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

// Power Bluetooth hardware on or off.

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

//

TInt CBTEngSrvSettingsMgr::SetHwPowerState( TBTPowerState aState )

    {

    TRACE_FUNC_ENTRY

    TInt err = KErrNone;

#ifndef __WINS__

    if( iActive->IsActive() )

        {

        // Cancel the outstanding request.

        iPowerMgr.Cancel();

        iActive->Cancel();

        }

    iPowerMgr.SetPower( aState, NULL, iActive->RequestStatus() );

    iActive->GoActive();

#else   //__WINS__

    iPowerState = aState;

#endif  //__WINS__

   if( !err && aState == EBTOn )

        {

        TInt dutMode = EBTDutOff;

        err = RProperty::Get( KPSUidBluetoothTestingMode, KBTDutEnabled, dutMode );

        if( !err && dutMode == EBTDutOn )

            {

            // Set the DUT mode key to OFF since DUT mode is disabled at this point

            err = RProperty::Set( KPSUidBluetoothTestingMode, KBTDutEnabled, EBTDutOff );

            }

        }

    if( err )

        {

        // Power off if an error occurred during power on sequence.

#ifndef __WINS__

            // This cannot happen in emulator environment.

        iPowerMgr.Cancel();

        iActive->Cancel();

        iPowerMgr.SetPower( EBTOff, NULL, iActive->RequestStatus() );

        User::WaitForRequest( iActive->RequestStatus() );

        // Result will be communicated through the caller of this function (by leaving).

#else   //__WINS__

        iPowerState = EBTOff;

#endif  //__WINS__

        } 

#ifdef __WINS__

    TRequestStatus* status = &(iActive->RequestStatus());

    iActive->GoActive();

    User::RequestComplete(status,KErrNone);

#endif  //__WINS__

    TRACE_FUNC_RES( ( _L( "result: %d" ), err ) )

    return err;

    }

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

// Turn BT on or off.

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

//

void CBTEngSrvSettingsMgr::SetPowerStateL( TBTPowerState aState, TBool aTemporary )

    {

    TRACE_FUNC_ARG( ( _L( "%d (temporary=%d" ), aState, aTemporary ) )

    if ( aState == EBTOn && iEnterpriseEnablementMode == BluetoothFeatures::EDisabled )

        {

        TRACE_INFO( ( _L( "no we're not... Bluetooth is enterprise-IT-disabled" ) ) )

        User::Leave(KErrNotSupported);

        }

    TBool idle = ( iServer->StateMachine()->CurrentOperation() == CBTEngSrvState::ESrvOpIdle );

    TBTPowerState currentState = EBTOff;

    CheckTemporaryPowerStateL( currentState, aState, aTemporary );

    if ( ( currentState == aState || ( aTemporary && aState == EBTOff ) ) && idle )

        {

        // The requested power state is already active, ignore silently.

        // We don't return an error here, as there is no error situation.

        TRACE_INFO( ( _L( "SetPowerStateL: nothing to do" ) ) )

        if ( currentState == aState )

            {

            // Make sure that the CenRep key is in sync.

            // During boot-up, the power is set from the CenRep key, so we could 

            // end up out-of-sync.

            TRACE_INFO( ( _L( "SetPowerStateL: currentState == aState" ) ) )

            HandleHwPowerChangeL( aState );

            }

        return;

        }

    if ( aState == EBTOn )

        {

        // Hardware power on is the first step.

        User::LeaveIfError( SetHwPowerState( aState ) );

        }

    else

        {

        //Prevent BT visibility in the situation when we turn OFF BT Engine 

        //but FM Radio is still alive

        SetVisibilityModeL( EBTVisibilityModeNoScans, 0 );

        // Hardware power off is the last step.

        // First disconnect all plug-ins.

        iServer->PluginManager()->DisconnectAllPlugins();

        }

    // We only signal that BT is on after everything has completed (through 

    // the CenRep power state key), so that all services are initialized.

    // We signal that BT is off immediately though, so that our clients will 

    // not try to use BT during power down.

    iServer->StateMachine()->StartStateMachineL( aState );

    TRACE_FUNC_EXIT

    }

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

// Turn BT on or off.

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

//

void CBTEngSrvSettingsMgr::SetPowerStateL(const RMessage2 aMessage )

    {

    TRACE_FUNC_ENTRY

    __ASSERT_ALWAYS( aMessage.Function() == EBTEngSetPowerState, 

            PanicServer( EBTEngPanicExpectSetPowerOpcode ) );

    if ( !iMessage.IsNull() )

        {

        // A power management request from a client is outstanding.

        User::Leave( KErrAlreadyExists );

        }

    TBTPowerStateValue arg = (TBTPowerStateValue) aMessage.Int0();

    // TBTPowerState power state type is inverted from TBTPowerStateValue,

    // which is used by the client to pass the parameter...

    TBTPowerState reqedPowerState( EBTOff );

    if ( arg == EBTPowerOn )

        {

        reqedPowerState = EBTOn;

        }

    TBool tempPowerOn = (TBool) aMessage.Int1();

    SetPowerStateL( reqedPowerState, tempPowerOn );

    if ( iServer->StateMachine()->CurrentOperation() == CBTEngSrvState::ESrvOpIdle )

        {

        // The request is accepted but the state machine is not running. This means the

        // requested power state is already active. Request is done.

        aMessage.Complete( KErrNone );

        }

    else

        {

        iMessage = RMessage2( aMessage );

        }

    TRACE_FUNC_EXIT

    }

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

// Initialize Bluetooth stack settings.

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

//

void CBTEngSrvSettingsMgr::InitBTStackL()

    {

    TRACE_FUNC_ENTRY

    iServer->BasebandConnectionManager()->Subscribe();

    TBTVisibilityMode visibility = EBTVisibilityModeHidden;

    CRepository* cenRep = CRepository::NewL( KCRUidBTEngPrivateSettings );

    TInt err = cenRep->Get( KBTDiscoverable, (TInt&) visibility );

    delete cenRep;

    if (iRestoreVisibility == EFalse)

        {

        if( err || visibility == EBTVisibilityModeTemporary &&

            !( iServer->IsTimerQueued( CBTEngServer::EScanModeTimer ) ) )

            {

            visibility = EBTVisibilityModeHidden;

            }

        SetVisibilityModeL( visibility, 0 );

        }

    TBool sspDebugMode = EFalse;

    (void) RProperty::Get( KPropertyUidBluetoothCategory,

                KPropertyKeyBluetoothGetSimplePairingDebugMode, (TInt&) sspDebugMode );

        // Only set debug mode to off if it is on, to prevent a loop notifications.

    if( sspDebugMode )

        {

        sspDebugMode = EFalse;

        // Add LeaveIfError if unsuccessful

        (void) RProperty::Set(KPropertyUidBluetoothCategory,

                    KPropertyKeyBluetoothSetSimplePairingDebugMode, (TInt) sspDebugMode );

        }

    TRACE_FUNC_EXIT

    }

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

// Reset settings and disconnect all links.

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

//

void CBTEngSrvSettingsMgr::StopBTStackL()

    {

    TRACE_FUNC_ENTRY

    TBTVisibilityMode visibility = EBTVisibilityModeHidden;

    CRepository* cenRep = CRepository::NewL( KCRUidBTEngPrivateSettings );

          // Ignore error here; if we can't read it, likely we can't set it either.

    (void) cenRep->Get( KBTDiscoverable, (TInt&) visibility );

    delete cenRep;

    if( visibility == EBTVisibilityModeTemporary )

        {

        visibility = EBTVisibilityModeHidden;

        SetVisibilityModeL( visibility, 0 );    // Also cancels scan mode timer.

        }

        // Stop listening to events

    iServer->BasebandConnectionManager()->Unsubscribe();

        // Disconnect all links

    TCallBack cb( CBTEngServer::DisconnectAllCallBack, iServer );

    iServer->BasebandConnectionManager()->DisconnectAllLinksL( cb );

        // Results in a callback (which is called directly when there are no links).

    TRACE_FUNC_EXIT

    }

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

// Update the power state CenRep key, and start BTNotif server if BT is on.

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

//

void CBTEngSrvSettingsMgr::HandleHwPowerChangeL( TBTPowerState aState )

    {

    TRACE_FUNC_ENTRY

    CRepository* cenrep = CRepository::NewLC( KCRUidBluetoothPowerState );

    // TBTPowerState power state type is inverted from TBTPowerStateValue...

    TBTPowerStateValue power = ( aState == EBTOn ) ? EBTPowerOn : EBTPowerOff;

    User::LeaveIfError( cenrep->Set( KBTPowerState, (TInt) power ) );

    CleanupStack::PopAndDestroy( cenrep );

    TRACE_FUNC_EXIT

    }

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

// ?implementation_description

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

//

void CBTEngSrvSettingsMgr::SetVisibilityModeL( TBTVisibilityMode aMode, TInt aTime )

    {

    TRACE_FUNC_ARG( ( _L( "[aMode: %d" ), aMode ) )

    if ( aMode != EBTVisibilityModeNoScans && iEnterpriseEnablementMode == BluetoothFeatures::EDisabled )

        {

        TRACE_INFO( ( _L( "\tnot changing anything... Bluetooth is enterprise-IT-disabled" ) ) )

        User::Leave( KErrNotSupported );

        }

    TInt err = KErrNone;

    iServer->RemoveTimer( CBTEngServer::EScanModeTimer );

    if( aMode != EBTVisibilityModeNoScans )

        {

        CRepository* cenRep = CRepository::NewL( KCRUidBTEngPrivateSettings );

        err = cenRep->Set( KBTDiscoverable, aMode );

        delete cenRep;

        }

    if( !err && aMode == EBTVisibilityModeTemporary )

        {

            // We need TInt64 here, as the max. time in microseconds for the 

            // max. value (1 hour) is larger than KMaxTInt32.

        TInt64 timeMicroSec = MAKE_TINT64( 0, aTime );

        timeMicroSec = timeMicroSec * KMinutesInMicroSecs;

            // Queue callback to set the visibility back to hidden.

        iServer->QueueTimer( CBTEngServer::EScanModeTimer, (TInt64) timeMicroSec );

        aMode = EBTVisibilityModeGeneral;

        }

    else if( !err && iRestoreVisibility )

        {

            // The user overrides, do not restore visibility mode anymore.

        iRestoreVisibility = EFalse;

        }

    if( !err )

        {

        err = RProperty::Set( KUidSystemCategory, 

                               KPropertyKeyBluetoothSetScanningStatus, aMode );

        }

    TBool hiddenMode = ( aMode == EBTVisibilityModeHidden );

    if( !err && aMode != EBTVisibilityModeNoScans )

        {

            // In hidden mode, we only accept connections from paired devices.

        err = RProperty::Set( KUidSystemCategory, 

                               KPropertyKeyBluetoothSetAcceptPairedOnlyMode, 

                               hiddenMode );

        }

    User::LeaveIfError( err );  // To communicate the result to the client.

    TRACE_FUNC_EXIT

    }

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

// Timed visible mode has expired.

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

//

void CBTEngSrvSettingsMgr::ScanModeTimerCompletedL()

    {

    TRACE_FUNC_ENTRY

    SetVisibilityModeL( EBTVisibilityModeHidden, 0 );

    TBTPowerState power = EBTOff;

    TInt err = GetHwPowerState( power );

    // See p2.1.2.1.2 of the UI spec

    // NB:  Please distinguish between TBTPowerState::EBTOff (defined in hcitypes.h)

    //      and TBTPowerStateValue::EBTPowerOff (defined in btserversdkcrkeys.h)

    //      because they have the opposite values

    if( !err && (power != EBTOff))

        {

        // Show a notification to the user

        TBTGenericInfoNotiferParamsPckg pckg;

        pckg().iMessageType = EBTVisibilityTimeout;

        RNotifier notifier;

        TInt err = notifier.Connect();

        if( !err )

            {

            err = notifier.StartNotifier( KBTGenericInfoNotifierUid, pckg );

            notifier.Close();

            }

        }

    TRACE_FUNC_RES( ( _L( "result: %d" ), err ) )

    }

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

// Check the secure simple pairing debug mode and turn it off if needed.

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

//

void CBTEngSrvSettingsMgr::CheckSspDebugModeL( TBool aDebugMode )

    {

    TRACE_FUNC_ARG( ( _L( "SSP debug mode state %d" ), (TInt) aDebugMode ) )

    TBTPowerState pwr = EBTOff;

    TBool currentMode = EFalse;

    TInt err = RProperty::Get( KPropertyUidBluetoothCategory, 

                                KPropertyKeyBluetoothGetSimplePairingDebugMode, 

                                (TInt&) currentMode );

#ifndef __WINS__

    err = iPowerMgr.GetPower( pwr, NULL ); // Treat error as power off.

#else   //__WINS__

    pwr = iPowerState;

#endif  //__WINS__

    if( err || pwr == EBTOff )

        {

        iServer->RemoveTimer( CBTEngServer::ESspDebugModeTimer );

            // Only set debug mode to off if it is on, to prevent a loop notifications.

        if( currentMode )

            {

            (void) RProperty::Set( KPropertyUidBluetoothCategory, 

                                    KPropertyKeyBluetoothSetSimplePairingDebugMode,

                                    (TInt) aDebugMode );

            }

            // In case of an error in getting the power state, turn BT off. 

            // If BT is already off, this call will be ignored.

        SetPowerStateL( EBTOff, EFalse );

        }

    else if( aDebugMode )

        {

            // Ignore if there already is a timer queued.

        if( !( iServer->IsTimerQueued( CBTEngServer::ESspDebugModeTimer ) ) )

            {

            iServer->QueueTimer( CBTEngServer::ESspDebugModeTimer, (TInt64) KBTEngSspDebugModeTimeout );

            err =  RProperty::Set(KPropertyUidBluetoothCategory, 

                                   KPropertyKeyBluetoothSetSimplePairingDebugMode, 

                                   (TInt) aDebugMode );

            }

        }

    else

        {

            // Power is on, and debug mode is set to off.

        TInt linkCount = 0;

        err = RProperty::Get( KPropertyUidBluetoothCategory, 

                               KPropertyKeyBluetoothGetPHYCount, linkCount );

        if( err || !linkCount )

            {

            (void) RProperty::Set(KPropertyUidBluetoothCategory, 

                                   KPropertyKeyBluetoothSetSimplePairingDebugMode,

                                   (TInt) aDebugMode );

            SetPowerStateL( EBTOff, EFalse );

            }

        else

            {

            // There are still existing connections, queue the

            // timer again for half the period.

            TInt64 interval = KBTEngSspDebugModeTimeout / 2;

            iServer->QueueTimer( CBTEngServer::ESspDebugModeTimer, interval );

            }

        }

    TRACE_FUNC_EXIT

    }

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

// A session will be ended, completes the pending request for this session.

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

//

void CBTEngSrvSettingsMgr::SessionClosed( CSession2* aSession )

    {

    TRACE_FUNC_ARG( ( _L( " session %x"), aSession ) )

    if ( !iMessage.IsNull() && iMessage.Session() == aSession )

        {

        iMessage.Complete( KErrCancel );

        }

    TRACE_FUNC_EXIT

    }

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

// Check the power state and if BT gets turned off automatically.

// This method is invoked either when the timer has expired, or

// if there are no more connections while the timer was running.

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

//

void CBTEngSrvSettingsMgr::CheckAutoPowerOffL()

    {

    TRACE_FUNC_ENTRY

    if ( iAutoOffClients > 0 )

        {

        TRACE_INFO( ( _L( "[CBTEngServer]\t iAutoOffClients %d"), iAutoOffClients ) )

        return;

        }

    TInt linkCount = 0;

    TInt err = RProperty::Get( KPropertyUidBluetoothCategory, 

                                KPropertyKeyBluetoothGetPHYCount, linkCount );

    if( !err && !linkCount )

        {

        TRACE_INFO( ( _L( "[CBTEngServer]\t SetPowerStateL( EBTOff, EFalse );")))

        SetPowerStateL( EBTOff, EFalse );

        }

    else

        {

        if( iRestoreVisibility )

            {

                // Set visibility mode back to the value selected by the user.