Symaptic: os/persistentdata/persistentstorage/sql/SRC/Server/SqlSrvFileData.h@260cb5ec6c19

     1 // Copyright (c) 2005-2010 Nokia Corporation and/or its subsidiary(-ies).

     2 // All rights reserved.

     3 // This component and the accompanying materials are made available

     4 // under the terms of "Eclipse Public License v1.0"

     5 // which accompanies this distribution, and is available

     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".

     7 //

     8 // Initial Contributors:

     9 // Nokia Corporation - initial contribution.

    10 //

    11 // Contributors:

    12 //

    13 // Description:

    14 //

    16 #ifndef __SQLSRVFILEDATA_H__

    17 #define __SQLSRVFILEDATA_H__

    19 #include <f32file.h>				//TParse, RFs

    20 #include "SqlSrvStrings.h"			//KFileHandleSeparator

    21 #include "SqlSrvConfig.h"			//TSqlSrvConfig & TSqlSrvConfigParams

    24 /**

    25 TSqlSrvFileData class.

    27 TSqlSrvFileData class owns two sets of data:

    28 - data, which never changes during the life time of TSqlSrvFileData object - file session instance,

    29   system drive name, SQL server private data path, config file parameters, a store of names of existing

    30   database configuration files. These permanent TSqlSrvFileData properties are initialized by calling

    31   TSqlSrvFileData::InitL().

    32   The SQL server owns only one TSqlSrvFileData instance whose permanent properties are initialized during

    33   the server startup and that TSqlSrvFileData instance is available to the other SQL server classes

    34   via a call to CSqServer::FileData();

    35 - data, which changes with every call to TSqlSrvFileData::SetL(const RMessage2& aMessage, TInt aArgNum).

    36   The TSqlSrvFileData instance expects that argument aArgNum of aMessage object contains a file name.

    37   The file name will be parsed by the TSqlSrvFileData instance and then the full file name is made available

    38   through TSqlSrvFileData::FileName() and TSqlSrvFileData::FileNameZ() (zero-terminated file name);

    40 The TSqlSrvFileData instance also can be used for (after calling TSqlSrvFileData::SetL() or TSqlSrvFileData::SetFromHandleL()):

    41 - retrieving the full file name;

    42 - retrieving the system drive name;

    43 - retrieving the server private path;

    44 - checking the file name format type - secure or non-secure;

    45 - retrieving the SID of the file name, if that is a secure file name;

    47 With TSqlSrvFileData class we can:

    48 - Minimize the stack usage (there is only one, heap based TSqlSrvFileData instance, owned by the SQL server);

    49 - Keep in one place all data needed for opening/creating/attaching/copying/deleting a database file;

    51 @see CSqlServer

    52 @see CSqlServer::FileData()

    53 @see TSqlSrvFileData::SetL()

    54 @see TSqlSrvFileData::SetFromHandleL()

    55 @see TSqlSrvFileData::Fs()

    56 @see TSqlSrvFileData::PrivatePath()

    57 @see TSqlSrvFileData::Drive()

    58 @see TSqlSrvFileData::FileName()

    59 @see TSqlSrvFileData::FileNameZ()

    60 @see TSqlSrvFileData::IsSecureFileNameFmt()

    61 @see TSqlSrvFileData::SecureUid()

    62 @see TSqlSrvFileData::IsCreated()

    63 @see TSqlSrvFileData::IsReadOnly()

    64 @see TSqlSrvFileData::ContainHandles()

    65 @see TSqlSrvFileData::ConfigParams()

    66 @see TSqlSrvFileData::DbConfigFiles()

    68 @internalComponent

    69 */

    70 NONSHARABLE_CLASS(TSqlSrvFileData)

    71 	{

    72 public:

    73 	inline void InitL(RFs& aFs, const TDriveName& aSysDriveName, const TDesC& aServerPrivatePath,

    74 					  const TDesC& aConfigFileName, const CDbConfigFiles* aDbConfigFiles);

    75 	void SetL(const RMessage2& aMessage, TInt aFileNameLen, TInt aFileNameArgNum,

    76 #ifdef SQLSRV_STARTUP_TEST

    77 	          const TDesC& aDbFileName,

    78 #endif

    79 	          const TDesC8* aConfigStr = NULL);

    80   	void SetFromHandleL(const RMessage2& aMessage, const TDesC& aDbFileName, TBool aCreated, TBool aReadOnly, const TDesC8* aConfigStr = NULL);

    82 	inline RFs& Fs() const;

    83 	inline TPtrC PrivatePath() const;

    84 	inline TDriveNumber Drive() const;

    85 	inline TPtrC FileName() const;

    86 	inline TPtrC FileNameZ() const;

    87 	inline TBool IsSecureFileNameFmt() const;

    88 	inline TUid SecureUid() const;

    89 	inline TBool IsCreated() const;

    90 	inline TBool IsReadOnly() const;

    91 	inline TBool ContainHandles() const;

    92 	inline const TSqlSrvConfigParams& ConfigParams() const;

    93 	inline const CDbConfigFiles* DbConfigFiles() const;

    95 private:

    96 	RFs						iFs;

    97 	TParse					iSysDrivePrivatePath;// <System drive name> + <Private directory>

    98 	TSqlSrvConfig			iConfig;			 // Contains the config file parameters (not used directly. TSqlSrvConfig::GetConfigParamsL()

    99 												 // should be used to get the right set of configuration parameters)

   100 	TBuf<KMaxFileName + 1>	iFileName;

   101 	TDriveNumber 			iDrive;

   102 	TBool					iIsSecureFileNameFmt;

   103 	TUid					iSecureUid;

   104 	TBool					iCreated;			// If the file is a private database, iCreated is true if the file was created,

   105 												// false if the file was opened by the client side

   106 	TBool					iReadOnly;

   107 	TSqlSrvConfigParams		iConfigParams;		// Contains the configuration parameters, which shall be used

   108 												// for the database connection (when creating/openning)

   109 	const CDbConfigFiles*	iDbConfigFilesPtr;  // Pointer to server's store of existing database config file names, NULL if there are no config files

   110 	};

   112 /**

   113 Initializes the permanent data of TSqlSrvFileData instance.

   114 This type of initialization happens during the SQL server startup.

   115 Once initialized, the permanent set of data stays unchanged for the whole life time of TSqlSrvFileData instance.

   117 @code

   118 The permanent set of data includes:

   119 - a file session instance;

   120 - system drive name;

   121 - SQL server private data path;

   122 - config file parameters;

   123 - a store of names of existing database configuration files

   124 @endcode

   126 @param aFs A reference to a file session instance

   127 @param aSysDriveName A reference to the system drive name

   128 @param aServerPrivatePath A reference to SQL server private data path

   129 @param aConfigFileName SQL server configuration file name

   130 @param aDbConfigFiles A pointer to the server's store of existing database configuration file names

   131 */

   132 inline void TSqlSrvFileData::InitL(RFs& aFs, const TDriveName& aSysDriveName, const TDesC& aServerPrivatePath,

   133 								   const TDesC& aConfigFileName, const CDbConfigFiles* aDbConfigFiles)

   134 	{

   135 	iFs = aFs;

   136 	__SQLLEAVE_IF_ERROR(iSysDrivePrivatePath.Set(aSysDriveName, &aServerPrivatePath, 0));

   137 	iConfig.InitL(aFs, aConfigFileName);

   138 	iConfig.GetConfigParamsL(KNullDesC8, iConfigParams);//iConfigParams initialized with the config file params

   139 														//(because an empty configuration string is passed as an argument)

   140 	iDbConfigFilesPtr = aDbConfigFiles;

   141 	}

   143 /**

   144 @return A reference to the file session instance

   145 */

   146 inline RFs& TSqlSrvFileData::Fs() const

   147 	{

   148 	return const_cast <RFs&> (iFs);

   149 	}

   151 /**

   152 @return SQL server private path.

   153 */

   154 inline TPtrC TSqlSrvFileData::PrivatePath() const

   155 	{

   156 	return iSysDrivePrivatePath.Path();

   157 	}

   159 /**

   160 @return The file drive.

   161 */

   162 inline TDriveNumber TSqlSrvFileData::Drive() const

   163 	{

   164 	return iDrive;

   165 	}

   167 /**

   168 @return A read-only descriptor pointing to the file name.

   169 */

   170 inline TPtrC TSqlSrvFileData::FileName() const

   171 	{

   172 	return iFileName.Left(iFileName.Length() - 1);

   173 	}

   175 /**

   176 @return A read-only descriptor pointing to the file name, zero-terminated.

   177 */

   178 inline TPtrC TSqlSrvFileData::FileNameZ() const

   179 	{

   180 	return iFileName;

   181 	}

   183 /**

   184 @return True if the file name format refers to a secure file name.

   185 */

   186 inline TBool TSqlSrvFileData::IsSecureFileNameFmt() const

   187 	{

   188 	return iIsSecureFileNameFmt;

   189 	}

   191 /**

   192 @return The secure UID, if the file name is a secure file name, KNullUid otherwise.

   193 */

   194 inline TUid TSqlSrvFileData::SecureUid() const

   195 	{

   196 	return iSecureUid;

   197 	}

   199 /**

   200 Returns true if the file was created, false if the file was opened by the client side.

   201 This function should be used only for private databases, e.g. for which ContainHandles() returns true.

   202 @return True if the file was created, false if the file was opened by the client side.

   204 @see TSqlSrvFileData::ContainHandles()

   205 */

   206 inline TBool TSqlSrvFileData::IsCreated() const

   207 	{

   208 	return iCreated;

   209 	}

   211 /**

   212 @return True if the file is a read-only file.

   213 */

   214 inline TBool TSqlSrvFileData::IsReadOnly() const

   215 	{

   216 	return iReadOnly;

   217 	}

   219 /**

   220 @return True if the file name contains file and session handles

   221 */

   222 inline TBool TSqlSrvFileData::ContainHandles() const

   223 	{

   224 	return iFileName[0] == KFileHandleSeparator;

   225 	}

   227 /**

   228 @return A reference to the configuration parameters.

   229 */

   230 inline const TSqlSrvConfigParams& TSqlSrvFileData::ConfigParams() const

   231 	{

   232 	return iConfigParams;

   233 	}

   235 /**

   236 @return A pointer to the server's store of existing database configuration file names

   237         (will be NULL if there are no existing configuration files)

   238 */

   239 inline const CDbConfigFiles* TSqlSrvFileData::DbConfigFiles() const

   240 	{

   241 	return iDbConfigFilesPtr;

   242 	}

   244 #endif//__SQLSRVFILEDATA_H__

author	sl
	Tue, 10 Jun 2014 14:32:02 +0200
changeset 1	260cb5ec6c19
permissions	-rw-r--r--