/*

* Copyright (c) 2006-2009 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: 

*

*/

#include <f32file.h>

#include "tPinAuthPlugin.h"

#include <e32svr.h>

#ifndef __INIPARSER_H__

	#include <cinidata.h>

#endif // __INIPARSER_H__

CTPinAuthPlugin::~CTPinAuthPlugin()

	{

	delete iClientMessage;

	}

CTPinAuthPlugin::CTPinAuthPlugin()

	{	

	// See ConstructL() for initialisation completion.

	}

/**

 Safely complete the initialization of the constructed object	

*/

void CTPinAuthPlugin::ConstructL()

	{

	iName.Set(KPluginNamePin);

	iDescription.Set(KPluginDescriptionPin);

	iMinEntropy = KEntropyPin;

	iFalsePositiveRate = KFalsePosPin;

  	iFalseNegativeRate = KFalseNegPin;

  	iClientMessage = HBufC::NewL(2048);

	ReloadAllFromIniFile();

	}

/**

  Sets information like iActiveState and iSupportsDefaultData from 

  the TEF ini file to the individual plugin database files

*/	

void CTPinAuthPlugin::ReloadAllFromIniFile()

	{

	// Set the file to be read, based on the Id of the plugin

	_LIT(KFileText, "\\tAuth\\tAuthSvr\\testdata\\Pin");

	_LIT(KFileSuffix, "Db.ini");					

	_LIT(KFormatFileName,"%S%x%S");

	TDriveUnit sysDrive (RFs::GetSystemDrive());

	TBuf<64> fileText(sysDrive.Name());

	fileText.Append(KFileText);

	iFileToRead.Format(KFormatFileName,&fileText, Id(), &KFileSuffix);

	//Read data from file to get initialisation information

	// Open and read in INI file

	// Default path to look for INI file is in 'c:\system\data' 

	// on target filesystem

	CIniData* file=NULL;

	TRAPD(r,file=CIniData::NewL(iFileToRead));

	//Put file on the cleanupstack if anything else in this function is going to leave, but nothing does.	

	if(r!=KErrNone)

		{

		RDebug::Print(_L("Unable to create CIniData object. Error = %d, File = %S"), r, &iFileToRead);

		}

	else

		{

		// Look for a key under a named section, retrieve text value	

		TPtrC result;		

		TBool ret;	//return value from FindVar functions

		ret=file->FindVar(_L("SectionOne"),_L("iSupportsDefaultData"),result);

		if(!ret)

			{

			RDebug::Print(_L("Key or section not found. iSupportsDefaultData default value used."));

			iSupportsDefaultData = ETrue;	// Default value

			}

		else

			{

			_LIT(KFalse,"false");

			// Create a lower case copy of the data that is read from the file

			TBuf<10> resultLowerCase;			

			resultLowerCase.Copy(result);

			resultLowerCase.LowerCase();

			iSupportsDefaultData = (resultLowerCase.FindF(KFalse) == KErrNotFound);

			}		

		// Set the active state of the plugin depending on the contents of the 

		// corresponding file, which has been set as a member variable

		ret =file->FindVar(_L("SectionOne"),_L("activeState"),result);

		if(!ret)

			{

			RDebug::Print(_L("Key or section not found. iActiveState default value of ETRUE used."));			

			iActiveState = ETrue;	// Default value

			}

		else

			{

			_LIT(KFalse,"false");

			// Create a lower case copy of the data that is read from the file

			TBuf<10> resultLowerCase;			

			resultLowerCase.Copy(result);

			resultLowerCase.LowerCase();

			// If the string 'false' was not found, we set the value to 'true' -the default value

			iActiveState = (resultLowerCase.FindF(KFalse) == KErrNotFound);

			}

		TRAPD(r,file->WriteToFileL());

		if (KErrNone != r)

			{

			RDebug::Print(_L("Error occurred while writing to the file."));

			TBuf<84> initInfoFile(sysDrive.Name());

			initInfoFile.Append(KInitInfoFile);

			RDebug::Print(_L("Filename = %S, KeyName = iSupportsDefaultData,"), &initInfoFile);

			RDebug::Print(_L("value = %S."), &result);

			}

		delete file;

		TRAP(r,file=CIniData::NewL(KAuthSvrPolicyFile));

		TPtrC displayMessage;

		ret=file->FindVar(_L("SectionOne"),_L("DisplayMessage"),displayMessage);

		if(displayMessage.Length() == 0)   //Value = 0

			{

			RDebug::Print(_L("DisplayMessage not passed."));

			iClientMessage = iClientMessage->ReAllocL(0);	// Default value

			TPtr ptr(iClientMessage->Des());

			ptr = KNullDesC();

			ret=file->SetValue(_L("SectionOne"),_L("DisplayMessage"),displayMessage);

			TRAP(r,file->WriteToFileL());

			}

		else

			{

			iClientMessage = iClientMessage->ReAllocL(displayMessage.Length());

			TPtr ptr(iClientMessage->Des());

			ptr = displayMessage;

			ret=file->SetValue(_L("SectionOne"),_L("DisplayMessage"),displayMessage);

			TRAP(r,file->WriteToFileL());

			}

		delete file;

		}

	}

void CTPinAuthPlugin::ReloadActiveStateFromIniFile() const

	{

	// Set the file to be read, based on the Id of the plugin

	_LIT(KFileText, "\\tAuth\\tAuthSvr\\testdata\\Pin");

	_LIT(KFileSuffix, "Db.ini");

	_LIT(KFormatFileName,"%S%x%S");

	TDriveUnit sysDrive (RFs::GetSystemDrive());

	TBuf<64> fileText(sysDrive.Name());

	fileText.Append(KFileText);

	iFileToRead.Format(KFormatFileName,&fileText, Id(), &KFileSuffix);

	//Read data from file to get initialisation information

	// Open and read in INI file

	// Default path to look for INI file is in 'c:\system\data' 

	// on target filesystem

	CIniData* file=NULL;

	TRAPD(r,file=CIniData::NewL(iFileToRead));

	//Put file on the cleanupstack if anything else in this function is going to leave, but nothing does.	

	if(r!=KErrNone)

		{

		RDebug::Print(_L("Unable to create CIniData object. Error = %d, File = %S"), r, &iFileToRead);

		}

	else

		{

		// Look for a key under a named section, retrieve text value	

		TPtrC result;		

		TBool ret=EFalse;	//return value from FindVar functions

		// Set the active state of the plugin depending on the contents of the 

		// corresponding file, which has been set as a member variable

		ret =file->FindVar(_L("SectionOne"),_L("activeState"),result);

		if(!ret)

			{

			RDebug::Print(_L("Key or section not found. iActiveState default value of ETRUE used."));			

			iActiveState = ETrue;	// Default value

			}

		else

			{

			_LIT(KFalse,"false");

			// Create a lower case copy of the data that is read from the file

			TBuf<10> resultLowerCase;

			resultLowerCase.Copy(result);

			resultLowerCase.LowerCase();

			if (resultLowerCase.FindF(KFalse) == KErrNotFound) 

				iActiveState = ETrue;	// The string 'false' was not found, so we set the value to 'true' -the default value

			else

				iActiveState = EFalse;

			}

		TRAPD(r,file->WriteToFileL());

		if (KErrNone != r)

			{

			RDebug::Print(_L("Error occurred while writing to the file."));

			TBuf<84> initInfoFile(sysDrive.Name());

			initInfoFile.Append(KInitInfoFile);

			RDebug::Print(_L("Filename = %S, KeyName = activeState,"), &initInfoFile);

			RDebug::Print(_L("value = %S."), &result);

			}

		delete file;

		}

	}

//Implement CAuthPluginInterface definitions

/**

 Normally, this would ask the user to input a 4-digit pin and then compare it to 

 the values that this plugin has been trained with. The result should be the 

 user that this PIN corresponds to.

 'aResult' should be the 'hash' of the stored PIN (which corresponds to the freshly entered PIN)

 but in this case, it's returned as it was 'unhashed'.

*/

void CTPinAuthPlugin::Identify(TIdentityId& aId, const TDesC& aClientMessage,

							   HBufC8*& aResult, TRequestStatus& aRequest)

	{

	ASSERT(IsActive());

	// We are simulating user input by reading from a file

	// (The data contained in this file has been freshly written by the 'client part in TestExecute')

	if(aClientMessage != *ClientMessage())

		{

		RDebug::Print(_L("Display String Mismatch !!!"));	

		}

	else

		{

		RDebug::Print(_L("Display String at the plugin matches the string sent !! "));

		}

	aRequest = KRequestPending;

	TBuf8<32> userInput;

	TRAPD(result1, IdReadUserInput(userInput));	//Get the data from the AuthSvrPolicy.ini file

	if (KErrNone != result1)

		{

		aRequest = result1;

		}

	else

		{

		// No errors, carry on					

		//Convert the 8-bit string to a 16-bit string for printing in RDebug

		HBufC* buf = 0;

		buf = HBufC::NewLC(32);

		buf->Des().Copy(userInput);

		_LIT(KMsgDebug1,"Identifying Userinput read from file = %S");    		

		RDebug::Print(KMsgDebug1, buf);

		CleanupStack::PopAndDestroy(buf);	//Memory cleanup. This string was only needed for the above Print function

		// Possibly, to allow for the cancellation or quitting, allow that to be the input string

		_LIT8(KCancelText, "Cancel");	

		_LIT8(KQuitText, "Quit");	

		if (userInput == KCancelText)

			{

			TRequestStatus* status  = &aRequest;

			User::RequestComplete(status, KErrAuthServPluginCancelled);

			//aResult will not be updated, as specified

			}

		else if (userInput == KQuitText)

			{

			TRequestStatus* status  = &aRequest;

			User::RequestComplete(status, KErrAuthServPluginQuit);

			//aResult will not be updated, as specified

			}

		else

			{

			//compare with the known set of inputs and see if this is one of them.	

			TInt result2 = CheckForStringPresence(aId, userInput, aRequest);

			if (KErrNone == result2)	//The above function did not leave

				{

				//See if the string was found.

				TInt length = userInput.Length();

				aResult = HBufC8::New(length);	

				aResult->Des().Format(_L8("%S"), &userInput);

				RDebug::Printf("aResult has been updated. aResult = %S, userInput = %S", 

									aResult, &userInput);

				TRequestStatus* status  = &aRequest;

				User::RequestComplete(status, result2);

				//Note: aRequest has been updated by the CheckForStringPresence function				

				}

			else if (KErrNotFound == result2)

				{

				RDebug::Printf("The data that the user input was not found (recognized)"

								"Error = %d", result2);

				TRequestStatus* status  = &aRequest;

				aId = KUnknownIdentity;

				User::RequestComplete(status, KErrNone);

				}			

			else

				{

				//Caters for file access errors etc

				RDebug::Printf("Error occurred while checking for the presence of the string"

								"in the list. Error = %d", result2);

				TRequestStatus* status  = &aRequest;

				aId = KUnknownIdentity;

				User::RequestComplete(status, KErrNone);

				}

			}

			//End of 'else' where the user did not cancel or quit the 'identify' process

		}		

	}

void CTPinAuthPlugin::Cancel()

	{		

	}

void CTPinAuthPlugin::Train(TIdentityId aId, HBufC8*& aResult, TRequestStatus& aRequest)

	{

	//Accept user input and update the list of inputs along with IDs.

ASSERT(IsActive());

	aRequest = KRequestPending;

	//TInt result = KErrNone;

	TBuf8<32> userInput;

	TRAPD(result1, TrainReadUserInput(userInput));

	if (KErrNone != result1)

		{

		_LIT(KMsgDebug2,"Training Userinput read Error: result = %d");    

		RDebug::Print(KMsgDebug2, result1);

		}

	else

		{

		// No errors, carry on		

		//Convert the 8-bit string to a 16-bit string for printing in RDebug

		HBufC* buf = 0;

		TRAPD(err, buf = HBufC::NewL(32));

		if(err == KErrNoMemory)

			{

			TRequestStatus* status  = &aRequest;

			User::RequestComplete(status, KErrNoMemory);

			return;

			}

		buf->Des().Copy(userInput);

		_LIT(KMsgDebug3, "--Training Userinput read from file = %S");

		RDebug::Print(KMsgDebug3, buf);

		delete buf;	//Memory cleanup. This string was only needed for the above Print function			

		// To allow for the cancellation or quitting, allow that to be the input string

		TRequestStatus aRequest2 = KRequestPending;

		_LIT8(KCancelText, "Cancel");

		_LIT8(KQuitText, "Quit");

		userInput.Trim();		

		if (userInput.CompareF(KCancelText) == 0)

			{ aRequest2 = KErrAuthServPluginCancelled; }		

		else if (userInput.CompareF(KQuitText) == 0)

			{ aRequest2 = KErrAuthServPluginQuit; }

		else

			{

			//compare with the present set of inputs and see if this is one of them.

			// update this list with this new user input, tagged to the aId

			TRAPD(result2, CheckForNewStringPresenceL(aId, userInput, aRequest2));			

			if (KErrNone != result2)

				{

				_LIT(KMsgDebug4, "Training Userinput read Error: results = %d");    

				RDebug::Print(KMsgDebug4, result2);

				}

			else if(KErrNone == aRequest2.Int())

				{

				// No errors, update aResult.

				// First allocate space for it since this variable will always be a 

				// null pointer coming into this function

				TRAPD(err1,aResult = HBufC8::NewL(userInput.Size()));	

				if(err1 == KErrNoMemory)

					{

					TRequestStatus* status  = &aRequest;

					RDebug::Printf("User::request complete with kerr no memory");

					User::RequestComplete(status, KErrNoMemory);	

					return;

					}

				*aResult = userInput;

				aRequest2 = KErrNone;

				}			

			else

				{

				_LIT(KMsgDebug5, "Error occurred during training. aRequest.Int() = %d");

				RDebug::Print(KMsgDebug5, aRequest2.Int());

				//aResult is not updated, nor is aId				

				}

			}

		// Complete the asynchronous function

		TRequestStatus* status  = &aRequest;

		User::RequestComplete(status, aRequest2.Int());

		}

	}

TBool CTPinAuthPlugin::IsActive () const

	{

	// There is never any user intervention required

	//return true;

	// As a future development note, this value may be read from a file (or a section in a file)

	ReloadActiveStateFromIniFile();

	return iActiveState;

	}

TInt CTPinAuthPlugin::Forget(TIdentityId aId)

	{

	// Open the list of userInputs that have been stored by this plugin

	// Then find the one that corresponds to this id

	// Then remove this string from the list and return the correct status value

	//Open the file

	TRAPD(result3, FindStringAndRemoveL(aId));

	return result3;

	}

TInt CTPinAuthPlugin::DefaultData(TIdentityId aId, HBufC8*& aOutputBuf)

	{

	// This implementation of the PIN plugin does support default data.

	// There will be cases where i don't want this available. Hence the addition of a 

	// new class member iSupportsDefaultData

	ReloadAllFromIniFile();

	TInt result = KErrNotSupported;

	TRequestStatus aRequest2 = KRequestPending;

	if (iSupportsDefaultData)	//Class member initialised in the constructor

		{

		TBufC8<16> defaultBuf(KDefaultData);

		//compare with the present set of inputs and see if this is one of them.

		// update this list with this new user input, tagged to the aId

		TRAPD(result2, CheckForNewStringPresenceL(aId, defaultBuf, aRequest2));			

		if (KErrNone != result2)

			{

			_LIT(KMsgDebug4, "Training Userinput read Error: results = %d");    

			RDebug::Print(KMsgDebug4, result2);

			}

		else if(KErrNone == aRequest2.Int())

			{

			// No errors, update aOutputBuf.

			// First allocate space for it since this variable will always be a 

			// null pointer coming into this function				

			TRAPD(resAlloc, (aOutputBuf = HBufC8::NewL(KDefaultData().Size())) );

			if (KErrNone != resAlloc)

				{

				_LIT(KMsgAllocFailed2,"Failed to allocate memory for updating aOutputBuf");

				RDebug::Print(KMsgAllocFailed2);

				result = resAlloc;

				}

			else

				{

				*aOutputBuf = KDefaultData;

				result = KErrNone;				

				}

			}			

		else

			{

			_LIT(KMsgDebug5, "Error occurred during training. aRequest2.Int() = %d");

			RDebug::Print(KMsgDebug5, aRequest2.Int());

			//aOutputBuf is not updated, nor is aId				

			}

		}

	return result;	

	}

TInt CTPinAuthPlugin::Reset(TIdentityId aId, const TDesC& aRegistrationData, HBufC8*& aResult)

	{

	// To enable testing return KErrNotSupported for one of the knowledge-based incarnations of this class

	if (Id() == 0x11113102)

		{

		return KErrNotSupported;

		}

	// If no registration data is supplied or if this plugin is configured as non-knowledge 

	// type plugin then reset is simply a forget operation else the registration data is 

	// used to retrain the plugin

	if ((aRegistrationData == KNullDesC) || (Id() == 0x11113101) || (Type() == EAuthBiometric) || (Type() == EAuthToken))

		{

		aResult = NULL;

		TRAPD(err, FindStringAndRemoveL(aId));

		return err;

		}

	// For EAuthKnowledge type

	// Convert the 16-bit string to a 8-bit string (pin)

	// Note that no unicode conversion is being done here since a pin cannot be in unicode

	RBuf8 pinBuf;

	TBuf8<32> newPin;

	TRAPD(err, pinBuf.CreateL(32);\

				CleanupClosePushL(pinBuf);\

				pinBuf.Copy(aRegistrationData.Left(32));\

				newPin = pinBuf;\

				CleanupStack::PopAndDestroy(&pinBuf));

	if (err != KErrNone)