/*

* 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 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:  Implementation of CHttpCacheEntry

*

*/

// INCLUDE FILES

#include "HttpCacheEntry.h"

#include "HttpCacheEvictionHandler.h"

#include "HttpCacheStreamHandler.h"

#include "HttpCacheUtil.h"

#include <s32file.h>

// EXTERNAL DATA STRUCTURES

// EXTERNAL FUNCTION PROTOTYPES

// CONSTANTS

const TInt CHttpCacheEntry::iOffset = _FOFF( CHttpCacheEntry, iSqlQueLink );

// MACROS

// LOCAL CONSTANTS AND MACROS

// MODULE DATA STRUCTURES

// LOCAL FUNCTION PROTOTYPES

// FORWARD DECLARATIONS

// ============================= LOCAL FUNCTIONS ===============================

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

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

// CHttpCacheEntry::CHttpCacheEntry

// C++ default constructor can NOT contain any code, that

// might leave.

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

//

CHttpCacheEntry::CHttpCacheEntry( CHttpCacheEvictionHandler& aEvictionHandler )

    : iState( ECacheUninitialized ),

      iEvictionHandler( &aEvictionHandler )

    {

    }

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

// CHttpCacheEntry::ConstructL

// Symbian 2nd phase constructor can leave.

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

//

void CHttpCacheEntry::ConstructL( const TDesC8& aUrl )

    {

    iUrl = aUrl.AllocL();

    }

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

// CHttpCacheEntry::NewL

// Two-phased constructor.

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

//

CHttpCacheEntry* CHttpCacheEntry::NewL(

    const TDesC8& aUrl,

    CHttpCacheEvictionHandler& aEvictionHandler )

    {

    CHttpCacheEntry* self = new( ELeave ) CHttpCacheEntry( aEvictionHandler );

    CleanupStack::PushL( self );

    self->ConstructL( aUrl );

    CleanupStack::Pop();

    return self;

    }

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

// CHttpCacheEntry::NewLC

// Two-phased constructor.

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

//

CHttpCacheEntry* CHttpCacheEntry::NewLC(

    const TDesC8& aUrl,

    CHttpCacheEvictionHandler& aEvictionHandler )

    {

    CHttpCacheEntry* self = CHttpCacheEntry::NewL( aUrl, aEvictionHandler );

    CleanupStack::PushL( self );

    return self;

    }

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

// Destructor

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

//

CHttpCacheEntry::~CHttpCacheEntry()

    {

    // Clean up eviction handler

    if ( iEvictionCandidate && iEvictionHandler )

        {

        iEvictionHandler->Remove( *this );

        }

    // Close files, this will commit changes

    // Clean up our memory

    delete iUrl;

    delete iFileName;

    delete iCacheBuffer;

    }

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

// CHttpCacheEntry::SetState

//

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

//

void CHttpCacheEntry::SetState( TCacheEntryState aState )

    {

    // Add entry to the eviction table once it gets completed

    if ( aState == ECacheComplete && !iEvictionCandidate )

        {

        // don't add it twice

        iEvictionHandler->Insert( *this );

        iEvictionCandidate = ETrue;

        }

    iState = aState;

    }

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

// CHttpCacheEntry::SetFileNameL

//

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

//

void CHttpCacheEntry::SetFileNameL( const TFileName& aFileName )

    {

    delete iFileName;

    iFileName = NULL;

    iFileName = aFileName.AllocL();

    }

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

// CHttpCacheEntry::Accessed

//

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

//

void CHttpCacheEntry::Accessed()

    {

    TTime now;

    now.HomeTime();

    iLastAccessed = now.Int64();

    iRef++;

    if ( iEvictionCandidate )

        {

        iEvictionHandler->Accessed( *this );

        }

#ifdef __CACHELOG__

    _LIT( KAccessFormat, "entry accessed: %d" );

    TBuf<100> buf;

    buf.Format( KAccessFormat, iRef );

    HttpCacheUtil::WriteUrlToLog( 0, buf, iUrl->Des() );

#endif // __CACHELOG__

    }

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

// CHttpCacheEntry::SetBodySize

//

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

//

void CHttpCacheEntry::SetBodySize( TUint aBodySize )

    {

    if ( iBodySize && !aBodySize )

        {

        // Remove from the eviction table, this is no longer a candidate

        if ( iEvictionCandidate )

            {

            iEvictionHandler->Remove( *this );

            iEvictionCandidate = EFalse;

            }

        }

    iBodySize = aBodySize;

    }

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

// CHttpCacheEntry::SetProtected

//

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

//

void CHttpCacheEntry::SetProtected()

    {

    iProtected = ETrue;

    iRef = 50;

#ifdef __CACHELOG__

    HttpCacheUtil::WriteLog( 0, _L( "CHttpCacheEntry::SetProtected - protected item" ) );

#endif

    }

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

// CHttpCacheEntry::Internalize

//

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

//

    {

    // url length

    return err;

    }

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

// CHttpCacheEntry::Externalize

//

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

//

    {

    }

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

// CHttpCacheEntry::Accessed

//

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

//

void CHttpCacheEntry::Accessed( TInt64 aLastAccessed, TUint16 aRef )

    {

    iLastAccessed = aLastAccessed;

    iRef = aRef;

    if ( iEvictionCandidate )

        {

        iEvictionHandler->Accessed( *this );

        }

#ifdef __CACHELOG__

    _LIT( KAccessFormat, "entry accessed: %d" );

    TBuf<100> buf;

    buf.Format( KAccessFormat, iRef );

    HttpCacheUtil::WriteUrlToLog( 0, buf, iUrl->Des() );

#endif // __CACHELOG__

    }

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

// NOTE: Cache buffer is created on:

// 1. Normal content entrypoint into CacheManager

//    CacheManager::ReceivedResponseHeadersL -> CacheHandler::ReceivedResponseHeadersL ->

//    CacheHandler::HandleResponseOkL (calls method - SetCacheBuffer, needed to

//    accumulate body content on multiple CacheHandler::ReceivedBodyDataL calls)

// 2. Multipart content entrypoint into CacheManager

//    CacheManager::SaveL -> CacheHandler::SaveL -> CacheHandler::SaveBuffer ->

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

//

void CHttpCacheEntry::SetCacheBufferL( TInt aCacheBufferSize )

    {

        {

        }

    }

//  End of File