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

//

// INCLUDE FILES

#include "sysutil.h"

#include <f32file.h>

#include <bsul/ccacheddriveinfo.h>

#include "sysutildomaincrkeys.h"	// for disc space

#include "sysutilinternalpskeys.h"	// for disc space

#include "sysutildebug.h"			// debug helper

#include "sysutilpatchdata.h"		// patchable data defining the MMC drive integer identifer

#include <baflpan.h>

#include <e32property.h>

#include <e32capability.h>

#include <bsul/inifile.h>

#include <bautils.h>

#include "sysutilsetup.h"

#include "sysutilplugindef.h"

// File names of the files which store version and device type information.

_LIT( KSWVersionFileName,			"sw.txt" );

_LIT( KLangSWVersionFileName,		"langsw.txt" );

_LIT( KLangVersionFileName,			"lang.txt" );

_LIT( KDeviceAttributesFileName,	"deviceattributes.ini" );

_LIT( KPRInformationFileName,       "purpose.txt" );

// UID of sysutilsetup.exe.

const TUid KSysUtilSetupUid = {0x10285B3B};

// Publish and Subscribe keys.

const TUid KTestFilePathsUid = {0x10285B40};

const TUid KSWVersionUid = {0x10285B3C};

const TUid KLangSWVersionUid = {0x10285B3D};

const TUid KLangVersionUid = {0x10285B3E};

const TUid KDeviceTypeInfoUid = {0x10285B3F};

const TUid KPRInformationUid = {0x20027BC4};

// Device Type Information attribute UIDs.

const TUid KManufacturerNameUid = {0x10286358};

const TUid KModelNameUid = {0x10286359};

const TUid KModelCodeUid = {0x1028635A};

const TUid KRevisionIDUid = {0x1028635B};

const TUid KDefaultDeviceNameUid = {0x1028635C};

const TUid KUIPlatformNameUid = {0x1028635D};

const TUid KUIPlatformVersionMajorUid = {0x1028635E};

const TUid KUIPlatformVersionMinorUid = {0x1028635F};

const TUid KUIPlatformVersionUid = {0x10286360};

const TUid KOSVersionMajorUid = {0x10286361};

const TUid KOSVersionMinorUid = {0x10286362};

const TUid KOSVersionUid = {0x10286363};

// This is the maximum number of Device Type Information attributes that can be 

// stored in the Device Type Information Publish and Subscribe property.

const TUint16 KAttributeLimit = 450;

// Default values that will be used if no plugin is provided, the 

// deviceattributes.ini file is missing or if a device attribute is not 

// specified by a licensee.

_LIT16( KDefaultManufacturer, "Symbian" );

_LIT16( KDefaultModelName, "Symbian" );

_LIT16( KDefaultModelCode, "Symbian" );

_LIT16( KDefaultRevisionID, "00.00" );

_LIT16( KDefaultDeviceName, "Symbian" );

_LIT16( KDefaultUIPlatform, "Symbian" );

_LIT16( KDefaultUIPlatformVersionMajor, "0" );

_LIT16( KDefaultUIPlatformVersionMinor, "0" );

_LIT16( KDefaultUIPlatformVersion, "0.0" );

_LIT16( KDefaultOSVersionMajor, "0" );

_LIT16( KDefaultOSVersionMinor, "0" );

_LIT16( KDefaultOSVersion, "0.0" );

// Security policies for the Publish and Subscribe properties.

_LIT_SECURITY_POLICY_C1( KSecurityPolicyNone, ECapability_None );

_LIT_SECURITY_POLICY_S1( KSecurityPolicyWriteDeviceData, 0x10285B3B, ECapabilityWriteDeviceData );

_LIT( KNewLinePattern, "\\n" );

_LIT( KNewline, "\n" );

/**

Dummy sysutil implementation object - never instantiated.

@internalComponent

*/

class CDeviceTypeInformation::TImpl

	{

	TUint32 iDummy;

	};

/**

Stores a copy of the device type information attributes. For details of the 

memory layout see SGL.TS0017.201 BAFL Component Design Document.doc.

@internalComponent 

*/

typedef struct _SDeviceAttributes

	{

	TUint16 Length() const;

	TUint16 Count() const;

	TInt32 Uid( const TInt aAttributeIndex ) const;

	TInt16 Error( const TInt aAttributeIndex ) const;

	TInt AttributeLength( const TInt aAttributeIndex ) const;

	TUint16* AttributePtr( const TInt aAttributeIndex ) const;

	TUint16* iDeviceAttributes;

	} SDeviceAttributes;

/**

@return TInt16 The number of elements in the memory block.

*/

inline TUint16 SDeviceAttributes::Length() const

	{

	return iDeviceAttributes[0];

	}

/**

@return TInt16 The number of device type information attributes.

*/

inline TUint16 SDeviceAttributes::Count() const

	{

	return iDeviceAttributes[1];

	}

/**

Returns the UID which matches the attribute with the given index.

@param 	aAttribIndex	The index of the attribute in iDeviceAttributes.

@return TInt32 			The UID of the attribute with the given index.

*/

inline TInt32 SDeviceAttributes::Uid( const TInt aAttribIndex ) const

	{

	return (iDeviceAttributes[2 + (2 * aAttribIndex)] << 16) + iDeviceAttributes[2 + (2 * aAttribIndex) + 1];

	}

/**

Returns an error code associated with the device type information attribute with 

the given index. This error code is generated when the attribute is retrieved 

from a plugin/deviceattributes.ini. It indicates if a value was successfully 

read, no value was provided or if an error occured.

@param 	aAttribIndex	The index of the attribute in iDeviceAttributes.

@return TInt16 			The error of the attribute with the given index.

*/

inline TInt16 SDeviceAttributes::Error( const TInt aAttribIndex) const

	{

	return static_cast<TInt16>(iDeviceAttributes[2 + (3 * Count()) + 1 + aAttribIndex]);

	}

/**

Returns the length of the attribute with the given index.

@param 	aAttribIndex	The index of the attribute in iDeviceAttributes.

@return TInt			The length of the attribute with the given index.

*/

inline TInt SDeviceAttributes::AttributeLength( const TInt aAttribIndex ) const

	{

	return iDeviceAttributes[2 + (2 * Count()) + aAttribIndex + 1] - iDeviceAttributes[2 + (2 * Count()) + aAttribIndex];

	}

/**

Returns a pointer to the attribute value in iDeviceAttributes with the given 

index.

@param 	aAttribIndex	The index of the attribute in iDeviceAttributes.

@return TUint16*		A pointer to the attribute value with the given index.

*/

inline TUint16* SDeviceAttributes::AttributePtr( const TInt aAttribIndex ) const

	{

	return iDeviceAttributes + iDeviceAttributes[2 + (2 * Count()) + aAttribIndex];

	}

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

/**

Returns the total length of all the device type information attribute values stored 

in aValues.

@param	aKeys	An array which contains a list of device type information attribute

				UIDs. The UIDs corrospond to the values in aValues.

@param	aValues	An array which contains a list of device type information attribute

				values. The values corrospond to the UIDs in aKeys.

@return TInt	The total length of all the device type information attribute values 

				stored in aValues.

@internalComponent

*/

static TInt AttributesTotalLength( RArray<TInt32>&, CDesC16ArraySeg& aValues )

	{

	TUint attributesTotalLength = 0;

	TInt numAttributes = aValues.Count();

	for( TInt attributeIndex = 0; attributeIndex < numAttributes; attributeIndex++ )

		{

		TInt attributeLength = aValues[attributeIndex].Length();

		if( attributeLength < CDeviceTypeInformation::KMaxAttributeLength )

			{

			attributesTotalLength += attributeLength;

			}

		else

			{

			attributesTotalLength += CDeviceTypeInformation::KMaxAttributeLength;

			}

		}

	return attributesTotalLength;

	}

/**

Returns a pointer to some memory which contains the device type information attribute 

UIDs and values (these are contained in aKeys and aValues) in a compact format. The 

layout of the memory can be found in the Design Document 

(SGL.TS0017.201 BAFL Component Design Document.doc). 

@param	aKeys		An array which contains a list of device type information 

					attribute UIDs. The UIDs corrospond to the values in aValues.

@param	aValues		An array which contains a list of device type information 

					attribute values. The values corrospond to the UIDs in aKeys.

@leave	-			One of the system-wide error codes.

@return	TUint16*	A pointer to the memory which contains the device type 

					information attribute UIDs and values in a compact format.

@internalComponent

*/

static TUint16* CreateDeviceTypeInfoPSDataL( RArray<TInt32>& aKeys, CDesC16ArraySeg& aValues )

	{

	// See SGL.TS0017.201 BAFL Component Design Document.doc for more information on the

	// memory requirements and layout.

	TInt memoryElements = 3 + (4 * aKeys.Count()) + AttributesTotalLength( aKeys, aValues );

	// Allocate memory to store the device type information attribute keys and values

	TUint16* deviceAttributes = static_cast<TUint16*>( User::AllocL( sizeof(TUint16) * memoryElements ) );

	CleanupStack::PushL( deviceAttributes );

	// Store the attributes length and count

	deviceAttributes[0] = memoryElements;

	deviceAttributes[1] = aKeys.Count();

	// Store the attribute UIDs, offsets of the attributes in the memory, error codes and attribute values.

	if( deviceAttributes[1] > 0 )

		{

		// Set the first offset to point to the start of the attributes

		deviceAttributes[2 + (2 * deviceAttributes[1])] = 2 + 1 + (4 * deviceAttributes[1]);

		for( TInt attributeNumber = 0; attributeNumber < deviceAttributes[1]; attributeNumber++ )

			{

			// Store the UID as two TUint16s

			deviceAttributes[2 + (2 * attributeNumber)] = static_cast<TUint16>(aKeys[attributeNumber] >> 16); 

			deviceAttributes[2 + (2 * attributeNumber) + 1] = static_cast<TUint16>(aKeys[attributeNumber]); 

			if( KUIPlatformVersionMajorUid.iUid == aKeys[attributeNumber] || KUIPlatformVersionMinorUid.iUid == aKeys[attributeNumber] 

				|| KOSVersionMajorUid.iUid == aKeys[attributeNumber] || KOSVersionMinorUid.iUid == aKeys[attributeNumber] )

				{

				// If the values were present in the INI/plugin (as we have the attribute keys) and the values

				// are KNullDesC16 then the values were corrupt.

				if( aValues[attributeNumber].Compare( KNullDesC16 ) == 0 )

					{

					deviceAttributes[2 + (2 * deviceAttributes[1]) + 1 + attributeNumber] = deviceAttributes[2 + (2 * deviceAttributes[1]) + 1 + attributeNumber - 1];

					deviceAttributes[2 + (3 * deviceAttributes[1]) + 1 + attributeNumber] = static_cast<TUint16>(KErrCorrupt);

					continue;

					}

				}

			// If the attribute value is too long we need to truncate it and set the error as KErrOverflow.

			if( aValues[attributeNumber].Length() > CDeviceTypeInformation::KMaxAttributeLength )

				{

				deviceAttributes[2 + (2 * deviceAttributes[1]) + 1 + attributeNumber] = deviceAttributes[2 + (2 * deviceAttributes[1]) + attributeNumber] + CDeviceTypeInformation::KMaxAttributeLength;

				deviceAttributes[2 + (3 * deviceAttributes[1]) + 1 + attributeNumber] = static_cast<TUint16>(KErrOverflow);

				Mem::Copy( deviceAttributes + deviceAttributes[2 + (2 * deviceAttributes[1]) + attributeNumber], aValues[attributeNumber].Ptr(), CDeviceTypeInformation::KMaxAttributeLength * 2 );

				}

			else

				{

				deviceAttributes[2 + (2 * deviceAttributes[1]) + 1 + attributeNumber] = deviceAttributes[2 + (2 * deviceAttributes[1]) + attributeNumber] + aValues[attributeNumber].Length();

				deviceAttributes[2 + (3 * deviceAttributes[1]) + 1 + attributeNumber] = KErrNone;

				Mem::Copy( deviceAttributes + deviceAttributes[2 + (2 * deviceAttributes[1]) + attributeNumber], aValues[attributeNumber].Ptr(), aValues[attributeNumber].Size() );

				}

			}

		}

	CleanupStack::Pop( 1 );

	return deviceAttributes;

	}

/**

Helper function which deletes the Version and Device Type Information Publish and 

Subscribe properties. This is meant for testing purposes only and requires the 

KSysUtilTestModeEnabled constant to be patched to ETrue.

@leave	-			One of the system-wide error codes.

@internalComponent

*/

EXPORT_C void DeletePSPropertiesL()

	{

	if( KSysUtilTestModeEnabled )

		{

		TInt err = RProperty::Delete(KSWVersionUid.iUid);

		if(err != KErrNotFound)

			{

			User::LeaveIfError(err);

			}

		err = RProperty::Delete(KLangSWVersionUid.iUid);

		if(err != KErrNotFound)

			{

			User::LeaveIfError(err);

			}

		err = RProperty::Delete(KLangVersionUid.iUid);

		if(err != KErrNotFound)

			{

			User::LeaveIfError(err);

			}

		err = RProperty::Delete(KDeviceTypeInfoUid.iUid);

		if(err != KErrNotFound)

			{

			User::LeaveIfError(err);

			}

		err = RProperty::Delete(KPRInformationUid.iUid);

        if(err != KErrNotFound)

            {

            User::LeaveIfError(err);

            }

		}

	}

/**

Finds and returns the device type information attribute number in aAttr. This 

number is used as an index in a populated instance of SDeviceAttributes.

@param aAttr A reference to SDeviceAttributes which contains a copy of the device type information attributes.

@param aKey The UID of the device type information attribute which needs to be found.

@return The attribute index number (position) in aAttr.

@return KErrNotFound aKey is not present in aAttr.

@internalComponent

*/

static TInt FindAttributeNumber( const SDeviceAttributes& aAttr, const TUid& aKey )

	{

	TInt bottom = 0;

	TInt top = aAttr.Count() - 1;

	while( bottom <= top )

		{

		TUint middle = bottom + ( top - bottom ) / 2;

		if( static_cast<TUint32>(aKey.iUid) < aAttr.Uid( middle ) )

			{

			top = middle - 1;

			}

		else if( static_cast<TUint32>(aKey.iUid) > aAttr.Uid( middle ) )

			{

			bottom = middle + 1;

			}

		else

			{

			return middle;

			}

		}

	return KErrNotFound;

	}

/**

Find a value from the patchable data. If that fails try Publish&Subscribe,

or if that fails, from Central Repository.

@internalComponent

@param aPCKey identifies the value to get from P&S.

@param aCRKey identifies the value to get from Centrep

@param aPatchableData patchable data set at compile time, may have been patched via rom patching

@return Disk level threshold

*/

static TInt FindValueL(

    const TUint aPCKey,

    const TUint aCRKey,

    const TInt aPatchableData )

    {

    TInt val( 0 );

    if (aPatchableData != -1)

    	{

    	__SYSUTIL_TRACE1("SysUtil: CL treshold value found from patchable data %d",aPatchableData);	

    	return aPatchableData;

    	}

	// Patchable data not set, try to get it from P & S Keys.

	TInt errorCode = RProperty::Get( KPSUidDiskLevel, aPCKey, val );

    if ( errorCode != KErrNone )

        {

        __SYSUTIL_TRACE1("SysUtil: CL treshold value not found from PS: %d, trying CR",errorCode);

        CRepository* repository = CRepository::NewLC(KCRUidDiskLevel);

        User::LeaveIfError(repository->Get(aCRKey,val));

        CleanupStack::PopAndDestroy( repository );

        }	

	return val;

    }

/**

Find out the critical level treashold (in bytes) for disk drives of type

aMediaType. Different media types may have different tresholds. If adding

a non-default treshold for some media type, implementation should go here.

@internalComponent

@param aMediaType identifies the media type of the drive

@return Disk level threshold

*/

static TInt64 FindCriticalLevelTresholdL( const TMediaType aMediaType )

    {

    if ( aMediaType == EMediaRam ) // RAM drives have different critical level than others

        {

        return (TInt64) FindValueL(KRamDiskCriticalThreshold, KRamDiskCriticalLevel, KSysUtilRamDiskCriticalThreshold  );

        }

    else // Some other media type

        {

        return (TInt64) FindValueL(KOtherDiskCriticalThreshold, KDiskCriticalThreshold, KSysUtilOtherDiskCriticalThreshold );

        }

    }

/**

Retrieves a string containing the location of sysutilplugin.dll. The location  

which is retrieved is dependent upon two things. The first is a patchable constant 

KSysUtilTestModeEnabled. This must be set to ETrue in order to use the test location instead 

of the standard path. This is set to EFalse by default for hardware builds.

The second is a Publish and Subscribe property, which has a UID of

0x10285B40. If KSysUtilTestModeEnabled is set to ETrue then this property will be defined 

and set to ETrue. This means that the test location is being used instead of the 

standard location. If the client wishes to switch to the standard location they 

can set this property to EFalse.

It may be the case that the standard location needs to be used before the property 

is defined. If this is needed then the client can define and set the property. 

Alternatively, a call can be made to SysUtil::GetSWVersion, 

SysUtil::GetLangSWVersion, SysUtil::GetLangVersion or SysUtil::GetDeviceTypeInfoL. 

It can then call RProperty::Set with a value of EFalse.

@param aLocation	On return contains the location of sysutilplugin.dll.

@leave	-			One of the system-wide error codes.

@internalComponent

*/

static void GetDllLocationL( TDes& aLocation )

	{

	_LIT( KDeviceAttributeDll,	"Z:\\sys\\bin\\sysutilplugin.dll" );

	if( KSysUtilTestModeEnabled )

		{

		TBool testPaths = EFalse;

		TInt err = RProperty::Get( KUidSystemCategory, KTestFilePathsUid.iUid, testPaths );

		if( KErrNone != err )

            testPaths = EFalse;

		if( testPaths )

			{

			TDriveUnit systemDrive( static_cast<TUint>(RFs::GetSystemDrive()) );

			TParse path;

			path.Set( systemDrive.Name(), &KDeviceAttributeDll, NULL );

			aLocation = path.FullName();

			__SYSUTIL_TRACE1("DLL Location: %S", &aLocation);

			return;

			}

		}

	__SYSUTIL_TRACE1("DLL Location: %S", &KDeviceAttributeDll);

	aLocation = KDeviceAttributeDll;

	}

/**

Retrieves a string containing the path to deviceattributes.ini. The path which 

is retrieved is dependent upon two things. The first is a patchable constant 

KSysUtilTestModeEnabled. This must be set to ETrue in order to use the test path instead 

of the standard path. This is set to EFalse by default for hardware builds.

The second is a Publish and Subscribe property, which has a UID of

0x10285B40. If KSysUtilTestModeEnabled is set to ETrue then this property will be defined 

and set to ETrue. This means that the test path is being used instead of the 

standard path. If the client wishes to switch to the standard path they can set 

this property to EFalse.

It may be the case that the standard path needs to be used before the property 

is defined. If this is needed then the client can define and set the property. 

Alternatively, a call can be made to SysUtil::GetSWVersion, 

SysUtil::GetLangSWVersion, SysUtil::GetLangVersion SysUtil::GetDeviceTypeInfoL or SysUtil::GetPRInformation. 

It can then call RProperty::Set with a value of EFalse.

@param 	aPath	On return contains the path to deviceattributes.ini.

@return	-		One of the system-wide error codes.

@internalComponent

*/

static TInt GetFilePath( TDes& aPath )

	{

	_LIT( KDebugPath, "Z:\\versions\\" );

	_LIT( KPath, "Z:\\resource\\versions\\" );

	if( KSysUtilTestModeEnabled )

		{

		TBool testPaths = EFalse;

		TInt err = RProperty::Get( KUidSystemCategory, KTestFilePathsUid.iUid, testPaths );

		if( KErrNone != err )

            testPaths = EFalse;

		if( testPaths )

			{

			TDriveUnit systemDrive( static_cast<TUint>(RFs::GetSystemDrive()) );

			TParse path;

			path.Set( systemDrive.Name(), &KDebugPath, NULL );

			aPath = path.DriveAndPath();

			__SYSUTIL_TRACE1("File Location: %S", &aPath);

			return KErrNone;

			}

		}

	__SYSUTIL_TRACE1("File Location: %S", &KPath);

	aPath = KPath;

	return KErrNone;

	}