/*

* Copyright (c) 2006 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:   Contains CCatalogsEngineImpl class implementation

*

*/

#include <e32base.h>

#include <e32property.h>

#include <e32msgqueue.h>

#include <s32mem.h>

#include "catalogspanics.h"

#include "catalogsengineimpl.h"

#include "ncdproviderproxy.h"

#include "catalogsdebug.h"

#include "catalogsengineobserver.h"

#include "catalogsconstants.h"

#include "catalogsuids.h"

#include "catalogsconnectionobserver.h"

class CCatalogsProviderCreator : public CActive

    {

public:

    static CCatalogsProviderCreator* NewL( 

        RCatalogsClientServerClientSession& aEngine, 

        TInt aUid, 

        MCatalogsBase*& aProvider, 

        TRequestStatus& aStatus,

        TUint32 aOptions );

    MCatalogsBase* Provider() const;

    ~CCatalogsProviderCreator();

protected:

    CCatalogsProviderCreator( 

        RCatalogsClientServerClientSession& aEngine, 

        MCatalogsBase*& aProvider, 

        TRequestStatus& aStatus );

    void ConstructL( TInt aUid, TUint32 aOptions );

    void RunL();

    void DoCancel();

    TInt RunError( TInt aError );

    /**

     * Provider handle

     */

    TInt iHandle;

    /**

     * Proxy provider.

     * Own.

     */

    CNcdProviderProxy* iProviderProxy;

    /**

     * Engine.

     */

    RCatalogsClientServerClientSession& iEngine;

    /**

     * Proxy provider result.

     */

    MCatalogsBase*& iResultProvider;

    /**

     * Proxy provider request status.

     */

    TRequestStatus* iResultStatus;

    };

CCatalogsProviderCreator* CCatalogsProviderCreator::NewL( 

    RCatalogsClientServerClientSession& aEngine, 

    TInt aUid, 

    MCatalogsBase*& aProvider, 

    TRequestStatus& aStatus,

    TUint32 aOptions )

    {

    DLTRACEIN(( "aEngine=%08x, aUid=%08x, aProvider=%08x, aStatus=%08x, aOptions=%u", 

        &aEngine, aUid, &aProvider, &aStatus, aOptions ));

    CCatalogsProviderCreator* self = new (ELeave) CCatalogsProviderCreator( 

        aEngine, aProvider, aStatus );

    CleanupStack::PushL( self );

    self->ConstructL( aUid, aOptions );

    CleanupStack::Pop( self );

    DLTRACEOUT(( "%08x", self ));

    return self;

    }

void CCatalogsProviderCreator::ConstructL( TInt aUid, TUint32 aOptions )

    {

    DLTRACEIN(("aUid=%08x", aUid ));

    switch( aUid )

        {

        // Instantiate a provider based on UID information

        case 0:

        default:

            {

            iEngine.CreateProvider( aUid, iStatus, iHandle, aOptions );

            SetActive();            

            DASSERT( iStatus.Int() == KRequestPending );

            }

            break;

        }

    DLTRACEOUT((""));

    }

CCatalogsProviderCreator::~CCatalogsProviderCreator()

    {

    DLTRACEIN((""));

    // Never hurts to call this in destructor of active objects

    Cancel();

    if( iProviderProxy )

        {

        DLTRACE(("Release providerproxy internally"));

        iProviderProxy->InternalRelease();

        }

    DLTRACEOUT((""));    

    }

MCatalogsBase* CCatalogsProviderCreator::Provider() const

    {

    return iProviderProxy;

    }

CCatalogsProviderCreator::CCatalogsProviderCreator(

    RCatalogsClientServerClientSession& aEngine, MCatalogsBase*& aProvider, TRequestStatus& aStatus )

    : CActive( EPriorityNormal ), iEngine( aEngine ), iResultProvider( aProvider ), iResultStatus( &aStatus )

    {

    CActiveScheduler::Add( this );

    *iResultStatus = KRequestPending;

    }

void CCatalogsProviderCreator::RunL()

    {

    DLTRACEIN(( "iStatus=%08x, iHandle=%08x", iStatus.Int(), iHandle ));

    // Provider creation can succeed with positive codes

    if ( iStatus.Int() >= KErrNone )

        {

        DLINFO(( "Creating provider proxy" ));

        // If the provider was successfully created, instantiate a 

        // client-side provider object

        iProviderProxy = CNcdProviderProxy::NewL( iEngine, iHandle );

        DLTRACE(("Provider proxy inc ref count"));

        // Increase both reference counters

        iProviderProxy->InternalAddRef();

        iProviderProxy->AddRef();

        DLINFO(( "Provider proxy %08x created", iProviderProxy ));

        // We will probably never end up here if the request has been

        // completed already, but checking just to be sure.

        if ( iResultStatus )

            {

            DLINFO(( "Completing CreateProvider request" ));            

            iResultProvider = iProviderProxy;

            // iResultStatus is nullified by the RequestComplete

            User::RequestComplete( iResultStatus, iStatus.Int() );

            }

        }

    else 

        {

        // We will probably never end up here if the request has been

        // completed already, but checking just to be sure.

        if ( iResultStatus )

            {        

            User::RequestComplete( iResultStatus, iStatus.Int() );             

            }

        }

    DLTRACEOUT((""));

    }

void CCatalogsProviderCreator::DoCancel()

    {

    DLTRACEIN((""));

    // Going down now, so pending message sent by provider creator

    // should be completed immediately by client server 

    //(or it is completed by the framework if the message is already

    // completed but creator is not yet notified of it)

    iEngine.AsyncMessageSenderDown( iStatus );

    // Pending request is completed.

    // We should never end up here if the request is already

    // completed, but just checking to be sure.

    if ( iResultStatus )

        {

        // iResultStatus is nullified by the RequestComplete

        User::RequestComplete( iResultStatus, KErrCancel );

        }

    DLTRACEOUT((""));

    }

TInt CCatalogsProviderCreator::RunError( TInt aError )

    {

    DLTRACEIN((""));

    User::RequestComplete( iResultStatus, aError );

    DLTRACEOUT((""));

    return KErrNone;

    }

/** Catalogs shutdown observer, subscribes to maintenance lock P&S */

class CCatalogsShutdownObserver : public CActive

    {

public:

    static CCatalogsShutdownObserver* NewL( MCatalogsEngineObserver& aObserver );

    virtual ~CCatalogsShutdownObserver();

protected:

    CCatalogsShutdownObserver( MCatalogsEngineObserver& aObserver );

    void ConstructL();

protected: // from CActive

    void RunL();

    void DoCancel();

private:

    RProperty                   iMaintenanceLockProperty;

    MCatalogsEngineObserver&    iObserver;

    };

CCatalogsShutdownObserver* CCatalogsShutdownObserver::NewL( MCatalogsEngineObserver& aObserver )

    {

    DLTRACEIN(( "aObserver=%08x", &aObserver ));

    CCatalogsShutdownObserver* self = new (ELeave) CCatalogsShutdownObserver( aObserver );

    CleanupStack::PushL( self );

    self->ConstructL();

    CleanupStack::Pop( self );

    return self;

    }

CCatalogsShutdownObserver::~CCatalogsShutdownObserver()

    {

    DLTRACEIN(("this=%08x", this));

    Cancel();

    iMaintenanceLockProperty.Close();

    DLTRACEOUT((""));

    }

CCatalogsShutdownObserver::CCatalogsShutdownObserver( MCatalogsEngineObserver& aObserver )

    : CActive( EPriorityNormal ), iObserver( aObserver )

    {

    CActiveScheduler::Add( this );

    }

void CCatalogsShutdownObserver::ConstructL()

    {

    DLTRACEIN((""));

    // Subscribe to maintenance notify property.

    User::LeaveIfError( iMaintenanceLockProperty.Attach( 

        KCatalogsEnginePropertyCategory, 

        KCatalogsEnginePropertyKeyMaintenanceLock ) );

    iMaintenanceLockProperty.Subscribe( iStatus );

    SetActive();

    DLTRACEOUT((""));

    }

void CCatalogsShutdownObserver::RunL()

    {

    DLTRACEIN(( "iStatus=%d", iStatus.Int() ));

    if( iStatus.Int() == KErrNone )

        {

        // Read the property value.

        TInt value;

        TInt err = iMaintenanceLockProperty.Get( value );

        if( err == KErrNone && value != 0 )

            {

            DLINFO(( "Calling shutdown observer %08x", &iObserver ));

            iObserver.CatalogsEngineShutdown();

            }

        if( err != KErrNone )

            {

            DLERROR(( "Failed to read maintenance lock property value, error %d", err ));

            }

        else

            {

            DLINFO(( "Maintenance lock value was %d", value ));

            }

        }

    DLTRACEOUT((""));

    }

void CCatalogsShutdownObserver::DoCancel()

    {

    DLTRACEIN((""));

    iMaintenanceLockProperty.Cancel();

    DLTRACEOUT((""));

    }

/** Catalogs OTA update observer, subscribes to update information P&S */

class CCatalogsUpdateObserver : public CActive

    {

public:

    static CCatalogsUpdateObserver* NewL( MCatalogsEngineObserver& aObserver );

    virtual ~CCatalogsUpdateObserver();

protected:

    CCatalogsUpdateObserver( MCatalogsEngineObserver& aObserver );

    void ConstructL();

protected: // from CActive

    void RunL();

    void DoCancel();

private:

    RMsgQueueBase               iUpdateMessageQueue;

    MCatalogsEngineObserver&    iObserver;

    };

CCatalogsUpdateObserver* CCatalogsUpdateObserver::NewL( MCatalogsEngineObserver& aObserver )

    {

    DLTRACEIN(( "aObserver=%08x", &aObserver ));

    CCatalogsUpdateObserver* self = new (ELeave) CCatalogsUpdateObserver( aObserver );

    CleanupStack::PushL( self );

    self->ConstructL();

    CleanupStack::Pop( self );

    return self;

    }

CCatalogsUpdateObserver::~CCatalogsUpdateObserver()

    {

    DLTRACEIN(("this=%08x", this));

    Cancel();

    iUpdateMessageQueue.Close();

    DLTRACEOUT((""));

    }

CCatalogsUpdateObserver::CCatalogsUpdateObserver( MCatalogsEngineObserver& aObserver )

    : CActive( EPriorityNormal ), iObserver( aObserver )

    {

    CActiveScheduler::Add( this );

    }

void CCatalogsUpdateObserver::ConstructL()

    {

    DLTRACEIN((""));

    // Create the update information message queue for receiving update messages.

    RProcess process;

    DLINFO(( "Client SSID %08x", process.SecureId().iId ));

	HBufC* msgQueueName = HBufC::NewLC( KCatalogsUpdateQueueNameFormat().Length() + 8 );

	msgQueueName->Des().Format( KCatalogsUpdateQueueNameFormat, process.SecureId().iId );

	DLINFO(( _L("Creating client's update message queue: %S"), msgQueueName ));

	TInt err = iUpdateMessageQueue.CreateGlobal( 

	    *msgQueueName, 

	    KCatalogsUpdateQueueSlotCount, 

	    KCatalogsUpdateQueueMessageSize, 

	    EOwnerProcess );

	if( err == KErrAlreadyExists )

	    {

        err = iUpdateMessageQueue.OpenGlobal( *msgQueueName );

	    }

	if( err != KErrNone )

	    {

	    DLERROR(( "Failed to create update message queue, error %d", err ));

	    }

	else

	    {

    	THandleInfo info;

    	iUpdateMessageQueue.HandleInfo( &info );

        DLINFO(( "Processes for notify data available: %d", info.iNumProcesses ));

        DLINFO(( "Threads for notify data available: %d", info.iNumThreads ));

        DLINFO(( "Open in process for notify data available: %d", info.iNumOpenInProcess ));

        DLINFO(( "Open in thread for notify data available: %d", info.iNumOpenInThread ));

        // Only one request allowed per messagequeue

        // This causes problem in STIF tests at least when they are executed

        // in the emulator because the handles of crashed processes are not

        // always freed so testers won't get notifications about the data

        // and engine will eventually freeze because the queue gets full

        if ( info.iNumProcesses == 1 )        

            {

            DLINFO(( "Requesting notification of update messages" ));

            // A thread can have only one data available notification request outstanding 

            // on the message queue. If a second request is made before the first request 

            // completes, then the calling thread is panicked (KERN-EXEC 47).

            iUpdateMessageQueue.NotifyDataAvailable( iStatus );

            SetActive();            

            }

	    }

	CleanupStack::PopAndDestroy( msgQueueName );

    DLTRACEOUT((""));

    }

void CCatalogsUpdateObserver::RunL()

    {

    DLTRACEIN(( "iStatus=%d", iStatus.Int() ));

    if( iStatus.Int() == KErrNone )

        {

        // Renew notification request.

        iUpdateMessageQueue.NotifyDataAvailable( iStatus );

        SetActive();

        CBufFlat* buffer = CBufFlat::NewL( KCatalogsUpdateInformationMaxSize + KCatalogsUpdateQueueMessageSize );

        CleanupStack::PushL( buffer );

        buffer->ResizeL( KCatalogsUpdateInformationMaxSize + KCatalogsUpdateQueueMessageSize );

        TUint8* msgPtr = const_cast< TUint8* >( buffer->Ptr( 0 ).Ptr() );

        while( iUpdateMessageQueue.Receive( msgPtr, KCatalogsUpdateQueueMessageSize ) == KErrNone )

            {

            msgPtr += KCatalogsUpdateQueueMessageSize;

            // Make a stream for reading the buffer.

            RBufReadStream stream( *buffer );

            CleanupClosePushL( stream );

            // Read total data size.

            TInt32 total;

            stream >> total;

            DLINFO(( "%d bytes of data incoming", total ));

            for( TInt bytesLeft = total + sizeof( TInt32 ) - KCatalogsUpdateQueueMessageSize;

                 bytesLeft > 0;

                 bytesLeft -= KCatalogsUpdateQueueMessageSize )

                {

                DLINFO(( "Reading more data, %d bytes to go", bytesLeft ));

                iUpdateMessageQueue.ReceiveBlocking( msgPtr, KCatalogsUpdateQueueMessageSize );

                msgPtr += KCatalogsUpdateQueueMessageSize;

                }

            // Read target string.

            HBufC* target = HBufC::NewLC( stream, KCatalogsUpdateTargetMaxSize );

            DLINFO(( _L("Update target: %S"), target ));

            // Read ID string.

            HBufC* id = HBufC::NewLC( stream, KCatalogsUpdateIdMaxSize );

            DLINFO(( _L("Update target ID: %S"), id ));

            // Read version string.

            HBufC* version = HBufC::NewLC( stream, KCatalogsUpdateVersionMaxSize );

            DLINFO(( _L("Update version: %S"), version ));

            // Read URI string.

            HBufC* uri = HBufC::NewLC( stream, KCatalogsUpdateUriMaxSize );

            DLINFO(( _L("Update URI: %S"), uri ));

            // Read force boolean

            TInt32 force;

            stream >> force;

            DLINFO(( "Update forced: %d", force ));

            DLINFO(( "Calling update observer %08x", &iObserver ));

            iObserver.CatalogsUpdateNotification( *target, *id, *version, *uri, force );

            CleanupStack::PopAndDestroy( 5 ); // uri, version, id, target, stream-close

            // Reset to start position for next round (if any).

            msgPtr = const_cast< TUint8* >( buffer->Ptr( 0 ).Ptr() );

            }

        CleanupStack::PopAndDestroy( buffer );

        }

    DLTRACEOUT((""));

    }

void CCatalogsUpdateObserver::DoCancel()

    {

    DLTRACEIN((""));

    iUpdateMessageQueue.CancelDataAvailable();

    DLTRACEOUT((""));

    }

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

TInt CCatalogsEngineImpl::AddRef() const

    {

    DLTRACEIN(( "" ));

    return ++iRefCount;

    }