// Copyright (c) 1997-2009 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:

//

/**

 @file

 @internalComponent

*/

#include <obex.h>

#include <obexpanics.h>

#include "logger.h"

#include "OBEXUTIL.H"

#include "obexasyncfilewriter.h"

#include "obexsyncfilewriter.h"

#include "obexfaults.h"

#ifdef __FLOG_ACTIVE

_LIT8(KLogComponent, "OBEX");

#endif

/** Creates a new CObexFileObject object.

Static file object factory. returns a new CObexFileObject, set up to use a 

temporary file  to store received data into "on the fly". If used for 

sourcing an object to send a "NULL" object(body length 0) will be sent.

@return Instance of CObexFileObject 

@publishedAll

@released

*/

EXPORT_C CObexFileObject* CObexFileObject::NewL()

	{

	LOG_LINE

	LOG_STATIC_FUNC_ENTRY

	CObexFileObject* self = new(ELeave) CObexFileObject;

	CleanupStack::PushL(self);

	self->ConstructL(TPtrC(NULL, 0));

	CleanupStack::Pop();

	return(self);

	}

/** Creates a new CObexFileObject object.

Static file object factory. returns a new CObexFileObject, set up to use

aDataFile as its data file, or will create a temp file if aDataFile is not

a valid file name. If used for sourcing an object to send, and no valid data

file is set, a "NULL" object(body length 0) will be sent.

@param aDataFile Filename to configure this object to use

@return Instance of CObexFileObject 

@publishedAll

@released

*/

EXPORT_C CObexFileObject* CObexFileObject::NewL(const TDesC &aDataFile)

	{

	LOG_LINE

	LOG_STATIC_FUNC_ENTRY

	CObexFileObject* self = new(ELeave) CObexFileObject;

	CleanupStack::PushL(self);

	self->ConstructL(aDataFile);

	CleanupStack::Pop();

	return(self);

	}

/** Destructor. 

@publishedAll

@released

*/

EXPORT_C CObexFileObject::~CObexFileObject()

	{

	LOG_LINE

	LOG_FUNC

	ResetData();

	iFs.Close();

	}

/**

Sets the name of a file which holds the data to be used as the objects body.

Leaves if the file does not exist, or can not be opened for writing.

@param aDesc Filename to configure this object to use

*/

void CObexFileObject::SetDataFileL(const TDesC& aDesc)// does this need to be exported????

	{

	ResetData();

	if(aDesc.Length() == 0)

		return;

	TInt err = iDataFile.SetNoWild(aDesc, NULL, NULL);

	if(err == KErrNone) //try and open for read/write

 		err = iFile.Open(iFs, iDataFile.FullName(), EFileWrite  | EFileShareExclusive);

 	if(err != KErrNone)

		{			//can't open it for write so open it for read

		err = iFile.Open(iFs, iDataFile.FullName(), EFileRead  | EFileShareReadersOnly);

		if(err != KErrNone)

			{

			iDataFile.SetNoWild(KNullDesC, NULL, NULL);

			iFile.Close();	// Manually close file

			User::Leave(err);

			}

		}

	}

/** 

Get the name of the file representing the object body.

@return	the full path and name of the file representing the object body.

		Null descriptor	if no valid data file has been set, or if Reset()

		has been called on the object since a file was last set.

*/

const TDesC& CObexFileObject::DataFile()

	{

	return iDataFile.FullName();

	}

TInt CObexFileObject::RenameFile(const TDesC& aDesC)

	{

	iFile.SetAtt(0,KEntryAttHidden);// - dont check return code - if it fails it fails

	return(iFile.Rename(aDesC));

	}

void CObexFileObject::SetTempFilePath(const TDesC& aPath)

	{

	iTempFilePath = aPath;

	}

void CObexFileObject::QueryTempFilePath(TDes& aPath)

	{

	aPath = iTempFilePath;

	}

/**

Constructs this object.

@param aDataFile The file to use for the object's data part.

*/

void CObexFileObject::ConstructL(const TDesC &aDataFile)

	{

	CreateHeaderStorageDataL();

	LEAVEIFERRORL(iFs.Connect());

	SetDataFileL(aDataFile);

	iTempFilePath = KNullDesC; 

	}

/** Initialises this object from the specified file. 

The function attempts to set attribute values for the object as follows:

Length:set to the length of the file

Name:taken from the name portion of the path in aFile

Time:taken from the modification time of the file

Type:set appropriately if the file extension is .vcf (VCard), .vcs (Vcalendar), 

or .txt.

@param aFile Body data file 	

@publishedAll

@released

*/

EXPORT_C void CObexFileObject::InitFromFileL(const TDesC& aFile)

	{

	LOG_LINE

	LOG_FUNC

	Reset();

	SetDataFileL(aFile);

	SetNameL(iDataFile.NameAndExt());

	GuessTypeFromExtL(iDataFile.Ext());

	TInt length;

	if(iFile.Size(length) == KErrNone)

		{

		SetLengthL(length);

		}

	TTime time;

	if(iFile.Modified(time) == KErrNone)

		{

		SetUtcTimeL(time);

		}

	}

/**

Virtual pure function form the base object. Tries to fill aDes with data 

starting from aPos byte offset. returns null descriptor if no data file is 

set. 

@param aPos Position (reliative to start of object) to start extracting data from

@param aDes Descriptor to fill

*/

void CObexFileObject::GetData(TInt aPos, TDes8& aDes)

	{

	if(iDataFile.NameOrExtPresent() && iFile.Read(aPos, aDes) == KErrNone)

		return;

	aDes.SetLength(0);

	}

/**

Virtual pure function overload. inserts aDes into the data file at location 

aPos 

@param aPos Position (reliative to start of object) to start inserting data from

@param aDes Descriptor to insert

*/

void CObexFileObject::NewData(TInt aPos, TDes8& aDes)

	{

//	iTempFilePath.SetLength(0);

	if(!iDataFile.NameOrExtPresent())

		{

		ResetData();

		TFileName fname;

		TInt err = iFile.Temp(iFs, iTempFilePath, fname, EFileWrite | EFileShareExclusive);

		if(err == KErrNone)

			err = iFs.Parse(fname, iDataFile.Path(), iDataFile);

		if(err != KErrNone)

			{

			ResetData();

			iFs.Delete(fname);

			aDes.SetLength(0);

			return;

			}

		iFile.SetAtt(KEntryAttHidden,0);// dont check return code - if it fails it fails

		}

	if(iFile.Write(aPos, aDes) != KErrNone)

		aDes.SetLength(0);

	}

/**

@return number of bytes in the data file (0 if no file is set)

*/

TInt CObexFileObject::DataSize()

	{

	if(!iDataFile.NameOrExtPresent())

		return(0);

	TInt size = 0;

	iFile.Size(size);

	return(size);

	}

/**

Set object back to a null file.

*/

void CObexFileObject::ResetData()

	{

	iFile.Close();

	iDataFile.Set(KNullDesC, NULL, NULL);

	}

//

// class CObexBufObject

//

/**

Allocates and constructs a new OBEX dynamic buffer object, specifying a buffer.

@param aDataBuf The buffer for the body of the object. This must be set either

	   by this constructor or by calling SetDataBufL() before using the object.

@return New OBEX dynamic buffer object 

@publishedAll

@released

*/

EXPORT_C CObexBufObject* CObexBufObject::NewL(CBufBase* aDataBuf)

	{

	LOG_LINE

	LOG_STATIC_FUNC_ENTRY

	CObexBufObject* self = new(ELeave) CObexBufObject;

	CleanupStack::PushL(self);

	self->ConstructL(aDataBuf);

	CleanupStack::Pop();

	return(self);

	}

/** Destructor. 

@publishedAll

@released

*/

EXPORT_C CObexBufObject::~CObexBufObject()

	{

	LOG_LINE

	LOG_FUNC

	delete iWriter;

	CloseDataFile();

	CloseFileServer();

	delete iFilename;

	delete iDoubleBuf;

	}

/** Writes contents of object to a file

@param aFileName Target file

@return a Symbian OS error code if file write fails. 

@publishedAll

@released

*/

EXPORT_C TInt CObexBufObject::WriteToFile(const TPtrC& aFileName)

	{

	LOG_LINE

	LOG_FUNC

	TInt ret = KErrNone;

	TRAP(ret, CopyFileL(aFileName));

	return ret;

	}

NONSHARABLE_CLASS(TFileDetails)

	{

public:

	TFileDetails(RFile& aFile, RFs& aFs, const TDesC& aFilename);

	inline RFile* File();

	inline RFs* FileServ();

	inline const TDesC* Filename();

private:

	RFile* iFile;

	RFs* iFileServ;

	const TDesC* iFilename;

	};

TFileDetails::TFileDetails(RFile& aFile, RFs& aFs, const TDesC& aFilename)

	: iFile(&aFile), iFileServ(&aFs), iFilename(&aFilename)

	{}

RFile* TFileDetails::File()

	{ return iFile; }

RFs* TFileDetails::FileServ()

	{ return iFileServ; }

const TDesC* TFileDetails::Filename()

	{ return iFilename; }

void DoCloseDeleteFile(TAny* aAny)

// This function does not check for errors. Since we're closing down, not much

// that we could do!

	{

	TFileDetails* fileDetails = reinterpret_cast<TFileDetails*>(aAny);

	if (fileDetails)

		{

		fileDetails->File()->Close();

		fileDetails->FileServ()->Delete(*(fileDetails->Filename()));

		}

	}

// Writes object data to specified file.  Called from WriteToFile, exists to simplify

// error handling as this function can leave.  Leaves are trapped in the caller.

void CObexBufObject::CopyFileL(const TDesC& aFilename)

	{

	// Open persistent connection to fileserver if don't currently

	// have one

	LEAVEIFERRORL(OpenFileServer());

	RFile writeFile;

	LEAVEIFERRORL(writeFile.Create(*iFileServ, aFilename, EFileWrite  | EFileShareExclusive));

	TFileDetails writeFileDetails(writeFile, *iFileServ, aFilename);

	CleanupStack::PushL(TCleanupItem(DoCloseDeleteFile, &writeFileDetails));

	// Now have three situations to worry about.  May have a file, in which

	// case we need to copy data to the target file.  If there's a buffer for

	// writes to this file, need to flush it first.

	// Then may be using a memory buffer, in which case we just need to save

	// the data.

	if (iFile)

		{

		if (iBuf)

			{

			LEAVEIFERRORL(WriteBufferToFile(ETrue));

			iBufOffset += iBuffered;

			}

		TInt dataSize = DataSize();

		TInt bufSize = Min<TInt>(dataSize, 1024);

			// Expands to TInt bufSize = (dataSize > 1024) ? 1024 : dataSize;

		HBufC8* buffer = HBufC8::NewMaxLC(bufSize);

		TInt written = 0;

		TPtr8 ptr = buffer->Des();

		while (written < dataSize)

			{

			LEAVEIFERRORL(iFile->Read(written, ptr));

			LEAVEIFERRORL(writeFile.Write(written, ptr));

			written += ptr.Length();

			}

		CleanupStack::PopAndDestroy(buffer); 

		}

	else

		{

		TInt segmentSize = iBuf->Ptr(0).Size();

		TInt written = 0;

		while (written < BytesReceived())

			{

			LEAVEIFERRORL(writeFile.Write(written, iBuf->Ptr(written)));

		    written += segmentSize;

			}

		}

	CleanupStack::Pop(); // file

	writeFile.Close();

	}

/**

Build a TObexBufferingDetails object.

@param aBuffer The CBufBase derived object for Obex to use as a data store.

	   This object will be resized as appropriate to hold the entire Obex object.

@publishedAll

@released

*/

EXPORT_C TObexBufferingDetails::TObexBufferingDetails(CBufBase& aBuffer)

	: iVersion(EBasicBuffer), iBuffer(&aBuffer) 

	{

	LOG_LINE

	LOG_FUNC

	}

/**

Build a TObexBufferingDetails object, setting the version appropriately.

@param aVersion Version number to insert.

@param aBuffer The buffer object to use.

@internalComponent

*/

TObexBufferingDetails::TObexBufferingDetails(TVersion aVersion, CBufBase* aBuffer)

	: iVersion(aVersion), iBuffer(aBuffer)

	{

	__ASSERT_DEBUG(aVersion < ELastVersion, IrOBEXUtil::Fault(EBadBufferDetailsVersion));

	}

/**

Return the version of this object

@internalComponent

*/

TObexBufferingDetails::TVersion TObexBufferingDetails::Version()

 	{

 	return iVersion;

 	}

/**

Basic getter.

@internalComponent

*/

CBufBase* TObexBufferingDetails::Buffer()

	{

	return iBuffer;

	}

/**

Build a variant of TObexBufferingDetails which instructs the CObexBufObject

to use a file as the only data store.  This is a special case option provided

to cater for the MObexServerNotify interface which requires the use of

CObexBufObject objects.  It is generally better to use a buffered variant.

If the file cannot be opened for read/write access it will be opened in read

only mode.  In this situation, attempts to store data in this object will cause

an Obex error to be signalled in response to the Obex packet which carried the

body data.

@param aFilename The file to link the object to.

@publishedAll

@released

*/

EXPORT_C TObexPureFileBuffer::TObexPureFileBuffer(const TPtrC& aFilename)

	: TObexBufferingDetails(EPureFile, NULL), iFilename(aFilename)

	{

	LOG_LINE

	LOG_FUNC

	}

/**

Basic getter.

@internalComponent

*/

const TPtrC& TObexPureFileBuffer::Filename()

	{

	return iFilename;

	}

/**

Build a variant of TObexBufferingDetails which instructs the CObexBufObject

to use a file as the main data store, buffering writes to this in chunks.

Writes are buffered into the supplied CBufBase derived object, which is not

resized.  Once it is full, the data contained is written to file.

Double buffering can be specified by setting aBufferingStrategy appropriately.

If the file cannot be opened for read/write access it will be opened in read

only mode.  In this situation, attempts to store data in this object will cause

an Obex error to be signalled in response to the Obex packet which carried the

body data.

@param aBuffer The buffer to use as a temporary store.  This is ignored when

	   reading from the file.

@param aFilename The filename to use to permanently store the object.

@param aBufferingStrategy Use double or single buffering.

@publishedAll