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

// f32\estart\estart.cpp

// Generic startup code run by the fileserver on boot

// 

//

#include <e32std.h>

#include <e32std_private.h>

#include <e32def_private.h>

#include <hal.h>

#include <f32file.h>

#include <f32file_private.h>

#include <f32fsys.h>

#ifndef SYMBIAN_EXCLUDE_ESTART_DOMAIN_MANAGER

#include <domainmanager.h>

#endif

#include <e32uid.h>

#include <e32property.h>

//#ifndef _DEBUG

//	#define _DEBUG

//#endif

//#define TRACING_ON

#include "estart.h"

#include <u32exec.h>

//-- define this macro in order to have system start time measurement (SYSSTATEMGR.EXE process life time)

//#define SYMBIAN_ESTART_OUTPUT_BOOT_TIME

TInt LoadCodePageDll();

/** Maximum Codepage Dll name length. */

const TInt KMaxCodepageDllName=16;

#ifdef _DEBUG

TBool DebugTraceEnabled()

	{

#ifdef TRACING_ON

	return ETrue;

#else

	return UserSvr::DebugMask() & 2;

#endif

	}

#endif

_LIT(KEStartPanicCatagory, "ESTART");

enum TEStartPanic

    {

    ELitNoDM = 1,                           // No Domain Manager

    ELitDMInitFail,                         // Domain Manager init fail

    ELitHALFail,                            // HAL init fail

    ELitConnectFsFail1,                     // Connect fs 1 fail

    ELitInitLocalPwStoreFail,               // Init PwStore fail

    ELitLocaleInitialisationFail,           // Initialisation of locale properties failed

    ELitFSInitDriveInfoFail,                // FS Init DriveInfo fail

    ELitCreateTrapHandlerFail,              // Create trap handler fail

    ELitLoadSysLddsFail,                    // Load sys ldds fail

    ELitLocalDriveMappingFail,              // Local drive mapping fail

    ELitDriveMappingFileFail,               // Drive mapping file not found

    ELitSwapMappingFailArrayInconsistent,   // Swap mappings fail - array inconsistent

    ELitFsSwapMappingFail,                  // Swap mappings fail - Fs request failed

    EPropertyError,                         // RProperty return error

    ECompMountFsFail,                       // Failed comp fs mount

    EFsNameFail,                            // File system name on Z: failed

    ELitNoWS,                               // No WSERV

    EStartupModeFail,                       // Get startup mode failed

    ESysAgentFail,                          // Fail to launch system agent

    ESetSystemDriveFail                     // Fail to set System Drive

    };

inline void Panic(TEStartPanic aPanic, TInt aReason)

    {

    TBuf<10> panic(KEStartPanicCatagory);

    panic.AppendFormat(_L("_%d"), aPanic);

    User::Panic(panic, aReason);

    }

_LIT(KRofs,"erofs.fsy");

_LIT(KCompfs,"ecomp.fsy");

_LIT(KEcomp,"ECOMP");

_LIT(KServerPathSysBin, "0:\\Sys\\Bin\\");

_LIT(KSystemAgentName, "z:\\sys\\bin\\SysAgt2Svr.exe");

_LIT(KLitLocaleData,"?:\\System\\Data\\LOCALE.D");

_LIT(KLocaleDllNameBase, "ELOCL");

_LIT(KLocalDriveMappingFile,"Z:\\SYS\\DATA\\ESTART.TXT");

_LIT(KWindowServerRootName1,"EWSRV.EXE");

_LIT(KSystemStarterName, "z:\\sys\\bin\\SYSSTART.EXE");

_LIT(KSystemStateManager, "z:\\sys\\bin\\SYSSTATEMGR.EXE");

//const TInt KPatchLddUidValue=0x100000cc;	// patch ldds should specify this as their third uid

GLDEF_D TBool gMountRofsAlone=ETrue;

GLDEF_D TBool gMountComposite=EFalse;

enum TCompositeMountSate

	{

	ENoMounts,

	EHasMounts,

	ESwapped

	};

LOCAL_D TCompositeMountSate gCompositeMountState=ENoMounts;

#if !defined(AUTODETECT_DISABLE)

LOCAL_D TInt gNCompositeMounts=0;

#endif

#if defined(__EPOC32__) && defined(__X86__)

LOCAL_D TInt gNFloppies=0;

#endif		

/**

ASCII text file reader constructor

*/

TText8FileReader::TText8FileReader()

	{

	iBufPos=-1;

	iFileDataBuf=NULL;

	iFileSize=0;	

	}

/**

ASCII text file reader desctructor

*/

TText8FileReader::~TText8FileReader()

	{

	delete[] iFileDataBuf;

	}	

/**	

Supply an ASCII text file for the file reader. 

This function reads the entire contents of this file into a buffer, converting to

unicode / folding each character. Subsequent parsing of the file data is all done from this

buffer.

@param aFile The file to be read. Must already be opened for read access in EFileStreamText mode.  

@return	KErrNone if no error.

*/

TInt TText8FileReader::Set(RFile& aFile)

	{

	iFile=aFile;

	iBuf.Zero();

	iBufPos=0;

	// Read the size of the file

	TInt r=iFile.Size(iFileSize);

	if (r!=KErrNone || !iFileSize)

		return(KErrGeneral);

	// Allocate a buffer to read in the file

	iFileDataBuf=new TText[iFileSize+1];	// +1 in case need to NULL terminate the end of the last string

	if (iFileDataBuf==NULL)

		return(KErrNoMemory);

	// Read the entire contents of the file into the buffer

	TPtr fdata(NULL,0);	

	TInt pos=0;

	r=iFile.Seek(ESeekStart,pos);

	while (pos<iFileSize)

		{

		if ((r=iFile.Read(iBuf))!=KErrNone)

			return(r);

		fdata.Set((iFileDataBuf+pos),0,iBuf.Length());	

		fdata.Copy(iBuf);

		fdata.Fold();

		pos+=iBuf.Length();	

		}

	return(KErrNone);	

	}

/**

Return the next record from the text file.

@param aPtr A TPtr which is setup with the address and length of the next record, referencing

the data in the reader's buffer.

@return	KErrNone if a record is successfully loaded into the buffer, KErrEof if the end of the

file is encountered, KErrGeneral if a file hasn't been set.

*/

TInt TText8FileReader::Read(TPtr& aPtr)

	{

	// Check that Set() has been called.

	if (iBufPos<0)

		return(KErrGeneral);

	// Check if we have run into the end of the file	

	TInt bufRemainder=(iFileSize-iBufPos);

	if (!bufRemainder)

		return(KErrEof);

	// Setup the descriptor passed with the next record - don't include the record terminator

	// The line terminators are CR + LF for DOS

	// whereas only LF for Unix line endings

	aPtr.Set((iFileDataBuf+iBufPos),bufRemainder,bufRemainder);

	TInt len=aPtr.Locate('\n');

	if (len != KErrNotFound)

		{

		iBufPos += len;

		// Check for DOS line ending to support both DOS and Unix formats

		if ((len != 0) && (iFileDataBuf[iBufPos-1] == '\r'))

			{

			len--;

			}

		aPtr.SetLength(len);

		}

	else

		iBufPos=iFileSize;

	// Point iBufPos to the next non-empty line

	while (iBufPos<iFileSize && (iFileDataBuf[iBufPos]=='\n' || iFileDataBuf[iBufPos]=='\r'))

		iBufPos++;

	return(KErrNone);

	}

const TInt DefaultLocalDrives[KMaxLocalDrives]=

			{

			EDriveC,               	//0

			EDriveD,                //1

			EDriveE,                //2

			EDriveF,                //3

			EDriveG,                //4

			EDriveH,                //5

			EDriveI,                //6

			EDriveJ,                //7

			EDriveK,				//8

			EDriveL,				//9

			EDriveM,				//10

			EDriveN,				//11

			EDriveO,				//12

			EDriveP,				//13

			EDriveQ,				//14

			EDriveR					//15 

			};

/**

Return the default drive letter for the specified local drive.

To alter the default mapping scheme on auto-configuration, override this function.

@param aLocalDrive The number of the local drive (0-15).

@return	The default drive number associated with this local drive.

*/			

TInt TFSStartup::DefaultLocalDrive(TInt aLocalDrive)

	{

	return(DefaultLocalDrives[aLocalDrive]);

	}

//typedef TInt TLocalDriveList[KMaxLocalDrives];

/**

Write the local drive mapping data to the file server. If there is no potential of a drive swap then also commit it.

Once committed, the setting cannot be changed.

@panic ESTART_10 Error_Code; If unable to set local drive mapping in the file server.

				 Error_Code is the error code returned by RFs::SetLocalDriveMapping()	

*/

void TFSStartup::SetFServLocalDriveMapping()

	{

	DEBUGPRINT("SetFServLocalDriveMapping");

	TLocalDriveMappingInfoBuf mBuf;

	TLocalDriveMappingInfo& ldmi=mBuf();

	Mem::Copy(&ldmi.iDriveMapping[0],&iLocalDriveList[0],(KMaxLocalDrives*sizeof(TInt)));

	// Can't set the mapping yet - if there is the potential of a drive swap .

	ldmi.iOperation = (iDriveSwapCount) ? TLocalDriveMappingInfo::EWriteMappingsNoSet : TLocalDriveMappingInfo::EWriteMappingsAndSet;

	TInt r=iFs.SetLocalDriveMapping(mBuf);

    __ASSERT_ALWAYS(r==KErrNone,Panic(ELitLocalDriveMappingFail, r));

	}

/**

Swap and commit the file server's local drive mapping data. Change the local drive mapping info already set with the file server.

@param  aFirstDrive		First Drive number to be swapped.

@param  aSecondDrive	Second Drive number to be swapped.

@panic  ESTART_13 Error_Code; if unable to set the local drive mapping to file server.

				  Error_Code is the error code returned by RFs::SetLocalDriveMapping()	

*/

void TFSStartup::SwapFServLocalDriveMapping(TInt aFirstDrive,TInt aSecondDrive)

	{

	DEBUGPRINT("SwapFServLocalDriveMapping");

	TLocalDriveMappingInfoBuf mBuf;

	TLocalDriveMappingInfo& ldmi=mBuf();

	ldmi.iDriveMapping[0]=aFirstDrive;

	ldmi.iDriveMapping[1]=aSecondDrive;

	ldmi.iOperation=TLocalDriveMappingInfo::ESwapIntMappingAndSet;

	TInt r=iFs.SetLocalDriveMapping(mBuf);

	__ASSERT_ALWAYS(r==KErrNone,Panic(ELitFsSwapMappingFail,r));

	}

// Warning - File format changes must be replicated in EikSrv.

struct TLocData

	{

	TLocale iLocale;

	TCurrencySymbol iCurrency;

	};

/**

Attempt to open the locale data file from system drive. If found, read the 

locale and currency symbol data from this file and transfer it to 'the system'.

@return KErrNone if successful.

*/

TInt TFSStartup::LoadLocale()

	{

	// Append the language index to the standard locale filename.

	TFileName filename(KLitLocaleData);

	filename[0] = (TUint8) RFs::GetSystemDriveChar();

	TInt lang;

	if (HAL::Get(HAL::ELanguageIndex,lang) == KErrNone)

		{

		filename.AppendNumFixedWidth(lang,EDecimal,2);

		HAL::Set(HAL::ELocaleLoaded, lang);

		}

	// Attempt to open the file, read/set the data. 

	RFile file;

	if (file.Open(iFs,filename,EFileRead) == KErrNone)

		{

		TPckgBuf<TLocData> data;

		if( file.Read(data) == KErrNone && data.Size()==sizeof(TLocData))

			{

			data().iLocale.Set();

			TInt offset = data().iLocale.UniversalTimeOffset().Int();

			if (data().iLocale.QueryHomeHasDaylightSavingOn())

				offset += 3600;

			User::SetUTCOffset(offset);

			User::SetCurrencySymbol(data().iCurrency);

			}

		file.Close();

		}

	return(KErrNone);	

	}

/**

Load the Locale DLL

@return KErrNone if successful.

	    KErrNotFound if locale DLL not found.

		Or other system wide error code.

*/

TInt LoadLocaleDll()

    {

    TBuf<16> localeDllName;

    TInt languageIndex;

    TInt error=HAL::Get(HALData::ELanguageIndex,languageIndex);

    if (error!=KErrNone)

        error = KErrNotFound;

    else

        {

        TBuf<6> extension; // Dot plus five digit locale

        _LIT(KExtension,".%u");

        extension.Format(KExtension, languageIndex);

        if (extension.Length()<3) // Padd ".1" to ".01" for compatibility.

            {

            _LIT(KPadding,"0");

            extension.Insert(1,KPadding);

            }

        localeDllName=KLocaleDllNameBase;

        localeDllName.Append(extension);

		error = UserSvr::ChangeLocale(localeDllName);

        }

    if (error==KErrNotFound)

        {

		// Try default locale

        _LIT(KLocaleDllNameExtension, ".LOC");

        localeDllName=KLocaleDllNameBase;

        localeDllName.Append(KLocaleDllNameExtension);

		error = UserSvr::ChangeLocale(localeDllName);

        }

    if (error == KErrNone)

        TLocale().Set();

	return error;

    }

/**

Initialise the HAL.

Search for a saved HAL file - containing a series of saved HAL attributes. 

If found, initialise each attribute saved.

@return KErrNone if successful; KErrGeneral if the exe panicked.

*/

TInt TFSStartup::InitialiseHAL()

	{

	RProcess process;

	TInt result = process.Create(_L("HALSettings.exe"), _L("INITIALISE"));

	if(result != KErrNone)

		return result;

	TRequestStatus status;

	process.Logon(status);

	if (status != KRequestPending)

		process.Kill(0);	// abort 

	else

		process.Resume();	// logon OK

	User::WaitForRequest(status);

	// Special case to ensure the nonsecure clock offset set function gets called

	TInt nsc_offset = 0;

	result = HAL::Get(HAL::ETimeNonSecureOffset,nsc_offset);

	if (result == KErrNone) 

		{

		HAL::Set(HAL::ETimeNonSecureOffset,nsc_offset); // this will only succeed when hal.dat is missing and the function wasnt called by halsettings.exe

		}

	// we can't use the 'exit reason' if the exe panicked as this

	// is the panic 'reason' and may be '0' which cannot be distinguished

	// from KErrNone

	result = process.ExitType() == EExitPanic ? KErrGeneral : status.Int();

	process.Close();

	return result;

	}

/**

Create and resume a server. Start without specifying a path. 

If this fails, then systematically try to start it from 

each valid drive in turn (Y: - A:, then Z:). 

The second phase is to handle the sitation where a version 

of the executable is found on a drive early in the search order

(e.g. C:) - that fails to load. Rather than failing the load 

on the 1st error, this function keeps going through all the valid drives.

@param aDrives		The drive list, to determine which are valid.

@param aRootName	The root name of the executable.

@return	ETrue if the server was eventually created successfully, EFalse if not.

*/

TBool TFSStartup::CreateServer(const TDriveList& aDrives, const TDesC& aRootName)

	{

	RProcess ws;

	TInt r=ws.Create(aRootName, KNullDesC);

	if (r!=KErrNone)

		{

		TFileName name;

		name = KServerPathSysBin();

		name+=aRootName;

		TInt i=EDriveZ;

		FOREVER

			{

			i= (i==0) ? EDriveZ : i-1;

			if (aDrives[i]!=KDriveAbsent) // Got a valid drive

				{

				name[0]=(TText)('A'+i); // Set the drive letter

				r=ws.Create(name,KNullDesC);

				if (r==KErrNone)

					break;

				}

			if (i==EDriveZ)

				return EFalse;

			}

		}

	ws.Resume();

	ws.Close();

	return ETrue;

	}

#ifdef AUTO_PROFILE

_LIT(KProfilerName,"profiler.exe");

_LIT(KProfilerCmd,"start");

/**

Start the profiler

*/

void TFSStartup::StartProfiler()

	{

	RProcess p;

	TInt r=p.Create(KProfilerName,KProfilerCmd);

	if (r==KErrNone)

		{

		p.Resume();

		p.Close();

		}

	}

#endif

#if !defined(AUTODETECT_DISABLE)

/**

FSY detection function for the local FSY (assumed to be FAT). This will return success for MMC,

ATA, Floppy and IRAM devices that are FAT formatted. Will also return success for any drive

(other than those designated for CD ROMs) which isn't ready - assuming these to be removable FAT

formatted devices. For floppy devices detected on the X86 build, we need to change the drive

mapping so that these are mounted on drives A: or B:.

*/

GLDEF_C TInt DetectELocal(RLocalDrive ld, TInt cr, TLocalDriveCapsV2& caps)

	{

	(void)ld;

	(void)cr;

	TInt socknum;

	if (cr==KErrNotReady && caps.iType != EMediaCdRom)

		{

#if defined(__EPOC32__) && defined(__X86__)

		// For FDD iEraseBlockSize top 16 bits is sectors per track

		if (caps.iType==EMediaFloppy && (caps.iEraseBlockSize>>16))

			{

pc_floppy:

			if (gNFloppies < 2)

				{

				// Change the default mapping to A: or B:

				TInt ret = gNFloppies ? EDriveB : EDriveA;

				++gNFloppies;

				return KFsDetectMappingChangeReturnOffset + ret;

				}

			return KErrNone;

			}

#endif

		return KErrNone;	// Removable and not ready - assume fat

		}