1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/persistentdata/persistentstorage/sql/SRC/Client/SqlDbSession.cpp Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,867 @@
1.4 +// Copyright (c) 2005-2010 Nokia Corporation and/or its subsidiary(-ies).
1.5 +// All rights reserved.
1.6 +// This component and the accompanying materials are made available
1.7 +// under the terms of "Eclipse Public License v1.0"
1.8 +// which accompanies this distribution, and is available
1.9 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.10 +//
1.11 +// Initial Contributors:
1.12 +// Nokia Corporation - initial contribution.
1.13 +//
1.14 +// Contributors:
1.15 +//
1.16 +// Description:
1.17 +//
1.18 +
1.19 +#include <e32math.h>
1.20 +#include <f32file.h>
1.21 +#include <f32file64.h>
1.22 +#include <s32strm.h>
1.23 +#include <s32mem.h>
1.24 +#include "IPCBuf.h" //HIpcBuf
1.25 +#include "SqlDbSession.h" //RSqlDbSession
1.26 +#include "SqlSrvStartup.h" //StartSqlServer()
1.27 +#include "SqlResourceTest.h" //TSqlResourceTestData
1.28 +#include "SqlSecurityImpl.h" //CSqlSecurityPolicy
1.29 +#include "OstTraceDefinitions.h"
1.30 +#ifdef OST_TRACE_COMPILER_IN_USE
1.31 +#include "SqlDbSessionTraces.h"
1.32 +#endif
1.33 +#include "SqlTraceDef.h"
1.34 +
1.35 +///////////////////////////////////////////////////////////////////////////////////////////////////////////////
1.36 +////////////////////// TSqlFhCmdFunctor ///////////////////////////////////////////////
1.37 +///////////////////////////////////////////////////////////////////////////////////////////////////////////////
1.38 +
1.39 +/**
1.40 +TSqlFhCmdFunctor derived classes are used by RSqlDbSession for sending to SQL server localy created/opened
1.41 +file handles.
1.42 +
1.43 +@see RSqlDbSession
1.44 +@see RSqlDbSession::CreateAndSendFileHandle()
1.45 +
1.46 +@internalComponent
1.47 +*/
1.48 +NONSHARABLE_CLASS(TSqlFhCmdFunctor)
1.49 + {
1.50 +public:
1.51 + TSqlFhCmdFunctor(RSqlDbSession& aDbSession, const TDesC& aDbFileName, const TDesC8* aConfig=NULL) :
1.52 + iDbSession(aDbSession),
1.53 + iDbFileName(aDbFileName),
1.54 + iConfig(aConfig) // ownership not transferred
1.55 + {
1.56 + }
1.57 + virtual TInt operator()(RFile64& aFile, TBool aCreated, TBool aReadOnly) = 0;
1.58 +
1.59 +public:
1.60 + RSqlDbSession& iDbSession;
1.61 + const TDesC& iDbFileName;
1.62 + const TDesC8* iConfig;
1.63 + };
1.64 +
1.65 +///////////////////////////////////////////////////////////////////////////////////////////////////////////////
1.66 +////////////////////// TSqlFhOpenCmdFunctor //////////////////////////////////////////////
1.67 +///////////////////////////////////////////////////////////////////////////////////////////////////////////////
1.68 +
1.69 +/**
1.70 +Implements the sending of ESqlSrvDbOpenFromHandle command to the SQL server.
1.71 +
1.72 +@internalComponent
1.73 +*/
1.74 +NONSHARABLE_CLASS(TSqlFhOpenCmdFunctor) : public TSqlFhCmdFunctor
1.75 + {
1.76 +public:
1.77 + TSqlFhOpenCmdFunctor(RSqlDbSession& aDbSession, const TDesC& aDbFileName,const TDesC8* aConfig=NULL) :
1.78 + TSqlFhCmdFunctor(aDbSession, aDbFileName, aConfig)
1.79 + {
1.80 + }
1.81 + virtual TInt operator()(RFile64& aDbFile, TBool aCreated, TBool aReadOnly);
1.82 +
1.83 + };
1.84 +
1.85 +/**
1.86 +Sends a command to the SQL server to use the supplied file session and file handles for adopting,
1.87 +when opening/creating a database.
1.88 +
1.89 +Usage of the IPC call arguments:
1.90 + - Arg 0: [out] The 32 bits of the argument are used as follow:
1.91 + @code
1.92 + MSB LSB
1.93 + 31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
1.94 + Ro Cr C C C C C C C C C C C C C C F F F F F F F F F F F F F F F F
1.95 + @endcode
1.96 + Where:
1.97 + @code
1.98 + - "Ro" - read-only flag, true if the file is read-only;
1.99 + - "Cr" - create/open flag, true if the file was created, false if the file was opened;
1.100 + - "C" - config string length;
1.101 + - "F" - database file name length;
1.102 + @endcode
1.103 + - Arg 1: [out] database file name + configuration string (if there is a configuration string)
1.104 + - Arg 2: [out] file session handle
1.105 + - Arg 3: [out] database file handle
1.106 +*/
1.107 +TInt TSqlFhOpenCmdFunctor::operator()(RFile64& aDbFile, TBool aCreated, TBool aReadOnly)
1.108 + {
1.109 + const TInt KConfigStrLen = iConfig ? iConfig->Length() : 0;
1.110 + if(KConfigStrLen > KSqlSrvMaxConfigStrLen)
1.111 + {
1.112 + return KErrArgument;
1.113 + }
1.114 + TIpcArgs ipcArgs;
1.115 + HBufC* arg1Buf = HBufC::New(iDbFileName.Length() + KConfigStrLen);
1.116 + if(!arg1Buf)
1.117 + {
1.118 + return KErrNoMemory;
1.119 + }
1.120 + TPtr arg1 = arg1Buf->Des();
1.121 + arg1.Copy(iDbFileName);
1.122 + if(iConfig)
1.123 + {
1.124 + TBuf<KSqlSrvMaxConfigStrLen> cfgBuf;
1.125 + cfgBuf.Copy(*iConfig);
1.126 + arg1.Append(cfgBuf);
1.127 + }
1.128 + TUint32 arg0 = iDbFileName.Length() | (KConfigStrLen << 16);
1.129 + if(aReadOnly)
1.130 + {
1.131 + arg0 |= 0x80000000;
1.132 + }
1.133 + if(aCreated)
1.134 + {
1.135 + arg0 |= 0x40000000;
1.136 + }
1.137 + ipcArgs.Set(0, arg0);
1.138 + ipcArgs.Set(1, &arg1);
1.139 + TInt err = aDbFile.TransferToServer(ipcArgs, 2, 3);
1.140 + if(err == KErrNone)
1.141 + {
1.142 + err = iDbSession.SendReceive(ESqlSrvDbOpenFromHandle, ipcArgs);
1.143 + }
1.144 + delete arg1Buf;
1.145 + return err;
1.146 + }
1.147 +
1.148 +///////////////////////////////////////////////////////////////////////////////////////////////////////////////
1.149 +////////////////////// TSqlFhAttachCmdFunctor ////////////////////////////////////////////
1.150 +///////////////////////////////////////////////////////////////////////////////////////////////////////////////
1.151 +
1.152 +/**
1.153 +Implements the sending of ESqlSrvDbAttachFromHandle command to the SQL server.
1.154 +
1.155 +@internalComponent
1.156 +*/
1.157 +NONSHARABLE_CLASS(TSqlFhAttachCmdFunctor) : public TSqlFhCmdFunctor
1.158 + {
1.159 +public:
1.160 + TSqlFhAttachCmdFunctor(RSqlDbSession& aDbSession, const TDesC& aDbFileName,
1.161 + const TDesC& aDbName) :
1.162 + TSqlFhCmdFunctor(aDbSession, aDbFileName),
1.163 + iDbName(aDbName)
1.164 + {
1.165 + }
1.166 + virtual TInt operator()(RFile64& aDbFile, TBool aCreated, TBool aReadOnly);
1.167 +
1.168 +private:
1.169 + void SerializeToStreamL(RWriteStream& aStream);
1.170 +
1.171 +private:
1.172 + const TDesC& iDbName;
1.173 +
1.174 + };
1.175 +
1.176 +/**
1.177 +Sends a command to the SQL server to use the supplied file session and file handles for adopting,
1.178 +when attaching a database.
1.179 +
1.180 +Usage of the IPC call arguments:
1.181 + - Arg 0: [out] The 32 bits of the argument are used as follow:
1.182 + @code
1.183 + MSB LSB
1.184 + 31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
1.185 + Ro F F F F F F F F F F F F F F F F F F F F F F F F F F F F F F F
1.186 + @endcode
1.187 + Where:
1.188 + @code
1.189 + - "Ro" - read-only flag, true if the file is read-only;
1.190 + - "F" - database file name length;
1.191 + @endcode
1.192 + - Arg 1: [out] db names buffer
1.193 + - Arg 2: [out] file session handle
1.194 + - Arg 3: [out] database file handle
1.195 +*/
1.196 +TInt TSqlFhAttachCmdFunctor::operator()(RFile64& aDbFile, TBool /*aCreated*/, TBool aReadOnly)
1.197 + {
1.198 + const TInt KMaxBufLen = iDbFileName.Length() * sizeof(TText) + iDbName.Length() * sizeof(TText) + 32;//"32" should be enough for all additional data like name length, alignment, etc.
1.199 + HBufC8* buf = HBufC8::New(KMaxBufLen);
1.200 + if(!buf)
1.201 + {
1.202 + return KErrNoMemory;
1.203 + }
1.204 + TPtr8 bufPtr = buf->Des();
1.205 + RDesWriteStream out(bufPtr);
1.206 + TRAPD(err, SerializeToStreamL(out));
1.207 + __ASSERT_DEBUG(err == KErrNone, __SQLPANIC(ESqlPanicInternalError));//"Write to descriptor" streaming operatons can't fail
1.208 + TUint32 arg0 = (TUint32)bufPtr.Length() | (aReadOnly ? 0x80000000 : 0);
1.209 + TIpcArgs ipcArgs(arg0, &bufPtr);
1.210 + err = aDbFile.TransferToServer(ipcArgs, 2, 3);
1.211 + if(err == KErrNone)
1.212 + {
1.213 + err = iDbSession.SendReceive(ESqlSrvDbAttachFromHandle, ipcArgs);
1.214 + }
1.215 + delete buf;
1.216 + return err;
1.217 + }
1.218 +
1.219 +/**
1.220 +Serializes TSqlFhAttachCmdFunctor object content to a stream (aStream parameter).
1.221 +*/
1.222 +void TSqlFhAttachCmdFunctor::SerializeToStreamL(RWriteStream& aStream)
1.223 + {
1.224 + aStream << iDbFileName;
1.225 + aStream << iDbName;
1.226 + aStream.CommitL();
1.227 + }
1.228 +
1.229 +///////////////////////////////////////////////////////////////////////////////////////////////////////////////
1.230 +
1.231 +//Database type.
1.232 +enum TDbType
1.233 + {
1.234 + EDbTypeUnknown, //The database resides outside the client's private data cage
1.235 + EDbTypeClientPrivate //The database resides in the client's private data cage
1.236 + };
1.237 +
1.238 +/**
1.239 +Returns the database type.
1.240 +
1.241 +@param aDbFileName Database file name, including the path. If it is a request for creating/opening
1.242 + secure database, then the name format is <drive>:<[SID]database_file_name>.
1.243 +
1.244 +@return EDbTypeClientPrivate If the database resides in the client's private data cage;
1.245 + EDbTypeUnknown This may be a database in the SQL server private data cage or somewhere else;
1.246 + If the error code is less than 0, then the function cannot determine the database type
1.247 + (the function was unable to connect the local file session instance).
1.248 +
1.249 +@internalComponent
1.250 +*/
1.251 +static TInt GetDbType(const TDesC& aDbFileName)
1.252 + {
1.253 + RFs fs;
1.254 + TInt err = fs.Connect();
1.255 + if(err == KErrNone)
1.256 + {
1.257 + TFileName clientPrivatePath;
1.258 + err = fs.PrivatePath(clientPrivatePath);
1.259 + fs.Close();
1.260 + if(err == KErrNone)
1.261 + {
1.262 + TInt pos = aDbFileName.FindF(clientPrivatePath);
1.263 + return (TUint)pos <= (TUint)KMaxDriveName ? EDbTypeClientPrivate : EDbTypeUnknown;
1.264 + }
1.265 + }
1.266 + return err;
1.267 + }
1.268 +
1.269 +///////////////////////////////////////////////////////////////////////////////////////////////////////////////
1.270 +////////////////////// RSqlDbSession /////////////////////////////////////////////////
1.271 +///////////////////////////////////////////////////////////////////////////////////////////////////////////////
1.272 +
1.273 +/**
1.274 +Establishes a connection with the SQL server.
1.275 +
1.276 +The method initializes RSqlDbSession object establishing a connection with the SQL server.
1.277 +If the connection has established successfully, the method sends a message to the server to
1.278 +create or open (depending on aFunction parameter) a database file with aDbFileName name.
1.279 +
1.280 +@param aFunction Specifies which operation has to be performed:
1.281 + ESqlSrvDbCreate - Create a shared non-secure or private secure database;
1.282 + ESqlSrvDbCreateSecure - Create a shared secure database;
1.283 + ESqlSrvDbOpen - Open a shared non-secure, shared secure or private secure database;
1.284 +
1.285 +@param aDbFileName Database file name, including the path. If it is a request for creating/opening
1.286 + secure database, then the name format is <drive>:<[SID]database_file_name>.
1.287 +@param aSecurityPolicyData Security policy data. Non-empty descriptor only for secure databases
1.288 +@param aConfig the configuration string "PARAM=VALUE;...."
1.289 +
1.290 +@return KErrNone, the operation completed successfully;
1.291 + KErrNoMemory, an out of memory condition has occured;
1.292 + KErrBadName, bad database file name: zero length, directory name;
1.293 + KErrAlreadyExists, database file already exists;
1.294 + KErrNotReady, the drive does not exist or is not ready;
1.295 + KErrInUse, the file has been opened already;
1.296 + KErrNotFound, file not found;
1.297 + KErrGeneral, no or invalid security policies (if the database to be opened is a secure database with bad security data);
1.298 + KErrNotSupported, incompatible sql security version (if the database to be opened is a secure database with bad security data);
1.299 + KErrPermissionDenied, the caller does not satisfy the relevant database security policies.
1.300 + Note that database specific errors categorised as ESqlDbError, and
1.301 + other system-wide error codes may also be returned.
1.302 + KErrArgument invalid config string or config string length exceeds KSqlSrvMaxConfigStrLen.
1.303 +
1.304 +Usage of the IPC call arguments:
1.305 + - Arg 0: [out] database file name length
1.306 + - Arg 1: [out] database file name
1.307 + - Arg 2: [out] security policies buffer length if aFunction is ESqlSrvDbCreateSecure
1.308 + - Arg 3: [out] security policies buffer if aFunction is ESqlSrvDbCreateSecure
1.309 +*/
1.310 +TInt RSqlDbSession::Connect(TSqlSrvFunction aFunction, const TDesC& aDbFileName, const TDesC8& aSecurityPolicyData, const TDesC8* aConfig)
1.311 + {
1.312 + SQL_TRACE_SESSION(OstTraceExt2(TRACE_INTERNALS, RSQLDBSESSION_CONNECT_ENTRY, "Entry;0x%X;RSqlDbSession::Connect;aDbFileName=%S", (TUint)this, __SQLPRNSTR(aDbFileName)));
1.313 +#ifdef SYSLIBS_TEST
1.314 + const TInt KDefaultMsgBufLen = 4;
1.315 +#else
1.316 + const TInt KDefaultMsgBufLen = 128;
1.317 +#endif
1.318 + iLastErrorMessage = HBufC::New(KDefaultMsgBufLen);
1.319 + if(!iLastErrorMessage)
1.320 + {
1.321 + return KErrNoMemory;
1.322 + }
1.323 + TInt err = DoCreateSession();
1.324 + if(err == KErrNone)
1.325 + {
1.326 + err = InitResourceTestData();
1.327 + if(err == KErrNone)
1.328 + {
1.329 + err = ::GetDbType(aDbFileName);
1.330 + if(err >= 0)
1.331 + {
1.332 + if(err == EDbTypeClientPrivate)
1.333 + {//The database is in the client's private data cage. Set err = KErrPermissionDenied.
1.334 + err = KErrPermissionDenied;
1.335 + }
1.336 + else
1.337 + {//Unknown database type. Try to connect.
1.338 + err = DoConnect(aFunction, aDbFileName, aSecurityPolicyData, aConfig);
1.339 + }
1.340 + if(err == KErrPermissionDenied && aFunction != ESqlSrvDbCreateSecure)
1.341 + {
1.342 + //What do we have here now? - the operation is create/open non-secure, the error is KErrPermissionDenied.
1.343 + //So, the dll will try now to create/open the database in the application's private data cage.
1.344 + //What if the used database file name was "C:MyDb.db"!? - the dll will try to create/open
1.345 + //"C:MyDb.db" in the application's data cage and there
1.346 + //is a possibility that this operation my return a result, like KErrNotFound, which will hide the original
1.347 + //error code (KErrPermissionDenied).
1.348 + //The dll shall not try to create/open file in the application's data cage, if the format of the
1.349 + //database file name is secure.
1.350 + TParsePtrC parse(aDbFileName);//this call may panic if aDbFileName cannot be parsed, but it will panic the client
1.351 + if(parse.PathPresent())
1.352 + {
1.353 + //The caller or the SQL server has no enough rights to create or open the database with aDbFileName name.
1.354 + //One of the reasons may be that the database file is in the caller's private data cage where the SQL
1.355 + //server cannot create/open the database file.
1.356 + //The SQL dll will try to create/open the database file on the client side and pass the file handle to the
1.357 + //SQL server.
1.358 + TSqlFhOpenCmdFunctor fhOpenCmdSender(*this, aDbFileName, aConfig);
1.359 + err = CreateAndSendFileHandle(fhOpenCmdSender,
1.360 + aFunction == ESqlSrvDbCreate ? RSqlDbSession::EDbfCreate : RSqlDbSession::EDbfOpen);
1.361 + }
1.362 + }
1.363 + }
1.364 + }
1.365 + }
1.366 + if(err != KErrNone)
1.367 + {
1.368 + Close();
1.369 + }
1.370 + SQL_TRACE_SESSION(OstTraceExt3(TRACE_INTERNALS, RSQLDBSESSION_CONNECT_EXIT, "Exit;0x%X;RSqlDbSession::Connect;err=%d;handle=0x%X", (TUint)this, err, (TUint)Handle()));
1.371 + return err;
1.372 + }
1.373 +
1.374 +/**
1.375 +Sends a command to the server to attach an existing database to the current connection.
1.376 +
1.377 +The database can be:
1.378 +@code
1.379 + - shared secure database;
1.380 + - shared non-secure database;
1.381 + - private secure database;
1.382 +@endcode
1.383 +
1.384 +@param aDbFileName Database file name.
1.385 +@param aDbName Logical database name.
1.386 +
1.387 +@return KErrNone, the operation completed successfully;
1.388 + KErrNoMemory, an out of memory condition has occured;
1.389 + KErrBadName, bad database file name: zero length, directory name;
1.390 + KErrNotReady, the drive does not exist or is not ready;
1.391 + KErrInUse, the file has been opened already;
1.392 + KErrNotFound, file not found;
1.393 + KErrGeneral, no or invalid security policies (if the database to be opened is a secure database with bad security data);
1.394 + KErrNotSupported, incompatible sql security version (if the database to be opened is a secure database with bad security data);
1.395 + KErrPermissionDenied, the caller does not satisfy the relevant database security policies.
1.396 + Note that database specific errors categorised as ESqlDbError, and
1.397 + other system-wide error codes may also be returned.
1.398 +
1.399 +Usage of the IPC call arguments:
1.400 +Arg 0: [out] Database file name length.
1.401 +Arg 1: [out] Database file name.
1.402 +Arg 2: [out] Logical database name length.
1.403 +Arg 3: [out] Logical database name.
1.404 +*/
1.405 +TInt RSqlDbSession::Attach(const TDesC& aDbFileName, const TDesC& aDbName)
1.406 + {
1.407 + TInt err = ::GetDbType(aDbFileName);
1.408 + if(err >= 0)
1.409 + {
1.410 + if(err == EDbTypeClientPrivate)
1.411 + {//The database is in the client's private data cage. Set err = KErrPermissionDenied.
1.412 + err = KErrPermissionDenied;
1.413 + }
1.414 + else
1.415 + {//Unknown database type. Try to attach.
1.416 + err = SendReceive(ESqlSrvDbAttach, TIpcArgs(aDbFileName.Length(), &aDbFileName, aDbName.Length(), &aDbName));
1.417 + }
1.418 + if(err == KErrPermissionDenied)
1.419 + {
1.420 + //What do we have here now? - the operation is "attach", the error is KErrPermissionDenied.
1.421 + //Which means, it is (possibly) a secure database in the server private data cage and the caller
1.422 + //failed to pass the security checks.
1.423 + //So, the dll will try now to open the database assuming it is in the application's private data cage
1.424 + //and pass the file and session handles to the server which will try to attach the database using the handles.
1.425 + //What if the used database file name was "C:MyDb.db"!? (which means that the client's intention was
1.426 + //to attach a public shared secure database)
1.427 + //The dll will try to open "C:MyDb.db" in the application's data cage and there
1.428 + //is a possibility that this operation may return a result, like KErrNotFound, which will
1.429 + //hide the original error code (KErrPermissionDenied).
1.430 + //The dll shall not try to attach a database from the application's data cage, if the format of the
1.431 + //database file name is secure.
1.432 + TParsePtrC parse(aDbFileName);//this call may panic if aDbFileName cannot be parsed, but it will panic the client
1.433 + if(parse.PathPresent())
1.434 + {
1.435 + TSqlFhAttachCmdFunctor fhAttachCmdSender(*this, aDbFileName, aDbName);
1.436 + err = CreateAndSendFileHandle(fhAttachCmdSender, RSqlDbSession::EDbfOpen);
1.437 + }
1.438 + }
1.439 + }
1.440 + return err;
1.441 + }
1.442 +
1.443 +/**
1.444 +Copies a database.
1.445 +
1.446 +The method establishes a temporary connection with the SQL server and issues a request for copying
1.447 +aSrcDbFileName database file to aDestDbFileName file. After the server completes the request
1.448 +CopyDatabase() closes the connection.
1.449 +
1.450 +@param aSrcDbFileName Source database file name.
1.451 +@param aDestDbFileName Destination database file name.
1.452 +
1.453 +@return KErrNone, the operation completed successfully;
1.454 + KErrNoMemory, an out of memory condition has occured;
1.455 + KErrBadName, bad database file name: zero length, directory name;
1.456 + KErrAlreadyExists, target database file already exists;
1.457 + KErrNotReady, the drive does not exist or is not ready;
1.458 + KErrInUse, the file has been opened already;
1.459 + KErrNotFound, file not found;
1.460 + KErrPermissionDenied, the SID of the calling application does not match the SID of source or destination database.
1.461 + Note that other system-wide error codes may also be returned.
1.462 +
1.463 +Usage of the IPC call arguments:
1.464 +Arg 0: [out] source database file name length
1.465 +Arg 1: [out] source database file name
1.466 +Arg 2: [out] destination database file name length
1.467 +Arg 3: [out] destination database file name
1.468 +*/
1.469 +TInt RSqlDbSession::CopyDatabase(const TDesC& aSrcDbFileName, const TDesC& aDestDbFileName)
1.470 + {
1.471 + RSqlDbSession sess;
1.472 + TInt err = sess.DoCreateSession();
1.473 + if(err == KErrNone)
1.474 + {
1.475 + err = sess.InitResourceTestData();
1.476 + if(err == KErrNone)
1.477 + {
1.478 + err = sess.SendReceive(ESqlSrvDbCopy, TIpcArgs(aSrcDbFileName.Length(), &aSrcDbFileName, aDestDbFileName.Length(), &aDestDbFileName));
1.479 + }
1.480 + sess.Close();
1.481 + }
1.482 + return err;
1.483 + }
1.484 +
1.485 +/**
1.486 +Deletes a database.
1.487 +
1.488 +The database can be:
1.489 +@code
1.490 + - shared secure database;
1.491 + - shared non-secure database;
1.492 + - private secure database;
1.493 +@endcode
1.494 +
1.495 +The method establishes a temporary connection with the SQL server and issues a "delete" request regarding
1.496 +aDbFileName database file. After the server completes the request DeleteDatabase() closes the connection.
1.497 +
1.498 +@param aDbFileName Database file name. It must include the path if it is not a secure database.
1.499 +
1.500 +@return KErrNone, the operation completed successfully;
1.501 + KErrNoMemory, an out of memory condition has occured;
1.502 + KErrBadName, bad database file name: zero length, directory name;
1.503 + KErrNotReady, the drive does not exist or is not ready;
1.504 + KErrInUse, the file has been opened already;
1.505 + KErrNotFound, file not found;
1.506 + KErrAccessDenied, access to the database file is denied (it might be a read-only file);
1.507 + KErrPermissionDenied, the SID of the calling application does not match the SID of the database.
1.508 + Note that other system-wide error codes may also be returned.
1.509 +
1.510 +Usage of the IPC call arguments:
1.511 +Arg 0: [out] database file name length
1.512 +Arg 1: [out] database file name
1.513 +*/
1.514 +TInt RSqlDbSession::DeleteDatabase(const TDesC& aDbFileName)
1.515 + {
1.516 + RSqlDbSession sess;
1.517 + TInt err = sess.DoCreateSession();
1.518 + if(err == KErrNone)
1.519 + {
1.520 + err = sess.InitResourceTestData();
1.521 + if(err == KErrNone)
1.522 + {
1.523 + err = ::GetDbType(aDbFileName);
1.524 + if(err >= 0)
1.525 + {
1.526 + if(err == EDbTypeClientPrivate)
1.527 + {//The database is in the client's private data cage. Set err = KErrPermissionDenied.
1.528 + err = KErrPermissionDenied;
1.529 + }
1.530 + else
1.531 + {//Unknown database type. Try to delete.
1.532 + err = sess.SendReceive(ESqlSrvDbDelete, TIpcArgs(aDbFileName.Length(), &aDbFileName));
1.533 + }
1.534 + if(err == KErrPermissionDenied)
1.535 + {
1.536 + //What do we have here now? - the operation is "delete db", the error is KErrPermissionDenied.
1.537 + //So, the dll will try now to delete a database with the same name from the application's private data cage.
1.538 + //What if the used database file name was "C:MyDb.db" and there is a such file in server's private
1.539 + //data cage? - the dll will try to delete a file with name "C:MyDb.db" from the application's data cage
1.540 + //and there is a possibility that this operation my pass or may return strange result, like KErrNotFound.
1.541 + //Bith cases are not what the user would expect.
1.542 + //The dll shall not try to delete a file from the application's data cage, if the format of the
1.543 + //database file name is secure.
1.544 + TParsePtrC parse(aDbFileName);//this call may panic if aDbFileName cannot be parsed, but it will panic the client
1.545 + if(parse.PathPresent())
1.546 + {
1.547 + //The caller or the SQL server has no enough rights to delete the database with aDbFileName name.
1.548 + //One of the reasons may be that the database file is in the caller's private data cage where the SQL
1.549 + //server cannot delete the database file.
1.550 + //The SQL dll will try to delete the database file on the client side.
1.551 + RFs fs;
1.552 + err = fs.Connect();
1.553 + if(err == KErrNone)
1.554 + {
1.555 + err = fs.Delete(aDbFileName);
1.556 + fs.Close();
1.557 + }
1.558 + }
1.559 + }
1.560 + }
1.561 + }
1.562 + sess.Close();
1.563 + }
1.564 + return err;
1.565 + }
1.566 +
1.567 +/**
1.568 +Retrieves a reference to the textual description of the error returned by the
1.569 +most recent call to any of the functions:
1.570 +- RSqlDatabase::Exec()
1.571 +- RSqlStatement::Exec()
1.572 +- RSqlStatement::Next()
1.573 +- RSqlStatement::Reset()
1.574 +
1.575 +Note that the function can only return a reference to text for
1.576 +database-specific type errors, i.e. those errors that are categorised as of
1.577 +type ESqlDbError.
1.578 +
1.579 +If an error occurs during the retrieval of the last error message, the function silently ignores the error
1.580 +and returns a NULL descriptor.
1.581 +
1.582 +@return A non-modifiable pointer descriptor representing the most recent error
1.583 + message. Note that message may be NULL, i.e. the descriptor may have
1.584 + zero length.
1.585 +
1.586 +Usage of the IPC call arguments:
1.587 +Arg 0: [out] max length of the message buffer
1.588 +Arg 1: [in/out] buffer for the last error message
1.589 +*/
1.590 +TPtrC RSqlDbSession::LastErrorMessage()
1.591 + {
1.592 + TPtr msg(iLastErrorMessage->Des());
1.593 + msg.Zero();
1.594 + TInt size = 0;
1.595 + while((size = SendReceive(ESqlSrvLastErrorMsg, TIpcArgs(msg.MaxLength(), &msg))) > KSqlClientBufOverflowCode)
1.596 + {
1.597 + HBufC* newMsgBuf = iLastErrorMessage->ReAlloc(size - KSqlClientBufOverflowCode);
1.598 + if(!newMsgBuf)
1.599 + {
1.600 + break;
1.601 + }
1.602 + iLastErrorMessage = newMsgBuf;
1.603 + msg.Set(iLastErrorMessage->Des());
1.604 + }
1.605 + return msg;
1.606 + }
1.607 +
1.608 +/**
1.609 +Returns the ROWID of the most recent successful INSERT into the database
1.610 +from this database connection.
1.611 +
1.612 +@return >0, the ROWID of the most recent successful INSERT into the database
1.613 + from this database connection;
1.614 + 0, if no successful INSERTs have ever occurred from this database connection
1.615 + <0, if one of the system-wide error codes is returned
1.616 +
1.617 +Usage of the IPC call arguments:
1.618 +Arg 0: [in/out] the receiving buffer for the last inserted ROWID
1.619 +*/
1.620 +TInt64 RSqlDbSession::LastInsertedRowId()
1.621 + {
1.622 + TInt64 res;
1.623 + TPtr8 ptr(reinterpret_cast <TUint8*> (&res), sizeof(res));
1.624 + TInt err = SendReceive(ESqlSrvDbLastInsertedRowId, TIpcArgs(&ptr));
1.625 + return err == KErrNone ? res : err;
1.626 + }
1.627 +
1.628 +/**
1.629 +Retrieves the database security policies.
1.630 +
1.631 +@return A pointer to the created and internalized CSqlSecurityPolicy instance.
1.632 +
1.633 +@return KErrNone, the operation has completed successfully;
1.634 + KErrNoMemory, an out of memory condition has occurred;
1.635 + Note that the function may leave with some database specific errors categorised as
1.636 + ESqlDbError or other system-wide error codes.
1.637 +
1.638 +Usage of the IPC call arguments:
1.639 +Arg 0: [out] security policy buffer size
1.640 +Arg 1: [in/out] buffer for the database security policies
1.641 +*/
1.642 +TInt RSqlDbSession::GetSecurityPolicy(RSqlBufFlat& aSecurityPolicyBuf)
1.643 + {
1.644 + TPtr8 ptr(aSecurityPolicyBuf.BufPtr());
1.645 + TInt rc = KErrNone;
1.646 + while((rc = SendReceive(ESqlSrvDbGetSecurityPolicy, TIpcArgs(ptr.MaxLength(), &ptr))) > KSqlClientBufOverflowCode)
1.647 + {
1.648 + rc = aSecurityPolicyBuf.ReAlloc(rc - KSqlClientBufOverflowCode);
1.649 + if(rc != KErrNone)
1.650 + {
1.651 + break;
1.652 + }
1.653 + ptr.Set(aSecurityPolicyBuf.BufPtr());
1.654 + }
1.655 + return rc;
1.656 + }
1.657 +
1.658 +/**
1.659 +Closes the database and releases the connection with the database server.
1.660 +*/
1.661 +void RSqlDbSession::Close()
1.662 + {
1.663 + SQL_TRACE_SESSION(OstTraceExt2(TRACE_INTERNALS, RSQLDBSESSION_CLOSE, "0x%X;RSqlDbSession::Close;handle=0x%X", (TUint)this, (TUint)Handle()));
1.664 + if(Handle())
1.665 + {
1.666 + (void)SendReceive(ESqlSrvDbClose);
1.667 + }
1.668 + TSqlResourceTestData::Release();
1.669 + delete iLastErrorMessage;
1.670 + iLastErrorMessage = NULL;
1.671 + RSessionBase::Close();
1.672 + }
1.673 +
1.674 +/**
1.675 +The method establishes a connection with the SQL server.
1.676 +
1.677 +@return KErrNone, The connection was established successfully;
1.678 + KErrAlreadyExists, the connection already exists.
1.679 + The function may also return some other system-wide error codes.
1.680 +*/
1.681 +TInt RSqlDbSession::DoCreateSession()
1.682 + {
1.683 + const TInt KTimesToRetryConnection = 2;
1.684 + TInt retry = KTimesToRetryConnection;
1.685 + for(;;)
1.686 + {
1.687 + TInt err = CreateSession(KSqlSrvName, ::SqlSrvVersion());
1.688 + if(err != KErrNotFound && err != KErrServerTerminated)
1.689 + {
1.690 + return err;
1.691 + }
1.692 + if(--retry == 0)
1.693 + {
1.694 + return err;
1.695 + }
1.696 + err = ::StartSqlServer();
1.697 + if(err != KErrNone && err != KErrAlreadyExists)
1.698 + {
1.699 + return err;
1.700 + }
1.701 + }
1.702 + }
1.703 +
1.704 +/**
1.705 +The method gets called immediatelly after the establishing client-server connection but before the
1.706 +create/open database message.
1.707 +If a request was made by the client (using TSqlResourceTester methods) to test the server under out of memory
1.708 +conditions, InitResourceTestData() will send this request to the server, putting the just created connection
1.709 +in a "out of memory" test mode.
1.710 +*/
1.711 +TInt RSqlDbSession::InitResourceTestData()
1.712 + {
1.713 + TInt err = KErrNone;
1.714 +#ifdef _DEBUG
1.715 + TSqlResourceTestData* data = TSqlResourceTestData::Instance();
1.716 + if(data)
1.717 + {
1.718 + data->Init(*this);
1.719 + }
1.720 + else
1.721 + {
1.722 + err = KErrNoMemory;
1.723 + }
1.724 +#endif
1.725 + return err;
1.726 + }
1.727 +
1.728 +/**
1.729 +Creates/opens database file locally and sends the file handle to the SQL server.
1.730 +
1.731 +This function is used only when the SQL server fails to create/open/attach the requested database file with
1.732 +KErrPermissionDenied error. One of the reasons for that error may be that the database file is in the
1.733 +calling application's private data cage. In this case an attempt is made to create/open the database file locally
1.734 +and if the operation completes successfully, then the file handle is passed to the SQL server.
1.735 +
1.736 +@param aFhCmdSender A reference to a functor instance which is used for sending the file handles to the SQL server.
1.737 +@param aDbfAction It is set by the caller to RSqlDbSession::EDbfCreate if the database file has to be created or
1.738 + to RSqlDbSession::EDbfOpen if the database file already exists and has to be opened
1.739 +
1.740 +@return KErrNone, the operation completed successfully;
1.741 + KErrNoMemory, an out of memory condition has occured;
1.742 + KErrBadName, bad database file name: zero length, directory name, missing drive in the file name;
1.743 + KErrAlreadyExists, database file already exists;
1.744 + KErrNotReady, the drive does not exist or is not ready;
1.745 + KErrInUse, the file has been opened already;
1.746 + KErrNotFound, file not found;
1.747 + KErrPermissionDenied, the caller does not satisfy the relevant database security policies.
1.748 + Note that database specific errors categorised as ESqlDbError, and
1.749 + other system-wide error codes may also be returned.
1.750 +*/
1.751 +TInt RSqlDbSession::CreateAndSendFileHandle(TSqlFhCmdFunctor& aFhCmdSender, RSqlDbSession::TDbfAction aDbfAction)
1.752 + {
1.753 + //Create a file session
1.754 + RFs fs;
1.755 + TInt err = fs.Connect();
1.756 + if(err != KErrNone)
1.757 + {
1.758 + return err;
1.759 + }
1.760 + //Share the file session
1.761 + err = fs.ShareProtected();
1.762 + if(err != KErrNone)
1.763 + {
1.764 + fs.Close();
1.765 + return err;
1.766 + }
1.767 + //Create/open the database file locally
1.768 + TBool readOnly = EFalse;
1.769 + TBool fileCreated = EFalse;
1.770 + RFile64 dbFile;
1.771 + if(aDbfAction == RSqlDbSession::EDbfCreate)
1.772 + {//Create the database file in R/W mode
1.773 + err = dbFile.Create(fs, aFhCmdSender.iDbFileName, EFileShareAny | EFileWrite);
1.774 + if(err == KErrNone)
1.775 + {
1.776 + fileCreated = ETrue;
1.777 + }
1.778 + }
1.779 + else //aDbfAction == RSqlDbSession::EDbfOpen
1.780 + {//Open the database file in shared R/W mode
1.781 + err = dbFile.Open(fs, aFhCmdSender.iDbFileName, EFileShareAny | EFileWrite);
1.782 + if(err != KErrNone)
1.783 + {//If the the database open operation in R/W mode has failed - try to open the database in shared read-only mode.
1.784 + readOnly = ETrue;
1.785 + err = dbFile.Open(fs, aFhCmdSender.iDbFileName, EFileShareReadersOnly);
1.786 + }
1.787 + }
1.788 + if(err == KErrNone)
1.789 + {//Successful create/open database file operation. Send the database file and session handles to the server.
1.790 + err = aFhCmdSender(dbFile, fileCreated, readOnly);
1.791 + dbFile.Close();
1.792 + }
1.793 + if(err != KErrNone && fileCreated)
1.794 + {
1.795 + dbFile.Close();
1.796 + TInt err2 = fs.Delete(aFhCmdSender.iDbFileName);
1.797 + if(err2 != KErrNone)
1.798 + {//Sometimes it is not possible the file to be deleted, the reported error is - KErrInUse.
1.799 + fs.Close();
1.800 + User::After(100000);
1.801 + err2 = fs.Connect();
1.802 + if(err2 == KErrNone)
1.803 + {
1.804 + (void)fs.Delete(aFhCmdSender.iDbFileName);
1.805 + }
1.806 + }
1.807 + }
1.808 + fs.Close();
1.809 + return err;
1.810 + }
1.811 +
1.812 +/**
1.813 +Prepares the "security & configuration" string and sends the command to the SQL server.
1.814 +
1.815 +@param aFunction Specifies which operation has to be performed:
1.816 + ESqlSrvDbCreate - Create a shared non-secure or private secure database;
1.817 + ESqlSrvDbCreateSecure - Create a shared secure database;
1.818 + ESqlSrvDbOpen - Open a shared non-secure, shared secure or private secure database;
1.819 +
1.820 +@param aDbFileName Database file name, including the path. If it is a request for creating/opening
1.821 + secure database, then the name format is <drive>:<[SID]database_file_name>.
1.822 +@param aSecurityPolicyData Security policy data. Non-empty descriptor only for secure databases
1.823 +@param aConfig the configuration string "PARAM=VALUE;...."
1.824 +
1.825 +@return KErrNone, the operation completed successfully;
1.826 + KErrNoMemory, an out of memory condition has occured;
1.827 + KErrArgument invalid config string or config string length exceeds KSqlSrvMaxConfigStrLen.
1.828 + Other system-wide error codes may also be returned.
1.829 +
1.830 +*/
1.831 +TInt RSqlDbSession::DoConnect(TSqlSrvFunction aFunction, const TDesC& aDbFileName, const TDesC8& aSecurityPolicyData, const TDesC8* aConfig)
1.832 + {
1.833 + const TInt KConfigStrLen = aConfig ? aConfig->Length() : 0;
1.834 + if(KConfigStrLen > KSqlSrvMaxConfigStrLen)
1.835 + {
1.836 + return KErrArgument;
1.837 + }
1.838 + const TInt KSecPolicyLen = aFunction == ESqlSrvDbCreateSecure ? aSecurityPolicyData.Length() : 0;
1.839 + TIpcArgs ipcArgs(aDbFileName.Length(), &aDbFileName);
1.840 + // pack the length xxxxyyyy where xxxx is the policy length
1.841 + // and yyyy is the config length.
1.842 + ipcArgs.Set(2, (TUint)(KSecPolicyLen << 16) | (TUint)KConfigStrLen);
1.843 + const TInt KTotalLen = KConfigStrLen + KSecPolicyLen;
1.844 + ipcArgs.Set(3, 0);
1.845 + HBufC8* arg3Buf = NULL;
1.846 + if(KTotalLen > 0)
1.847 + {
1.848 + arg3Buf = HBufC8::New(KTotalLen);
1.849 + if(!arg3Buf)
1.850 + {
1.851 + return KErrNoMemory;
1.852 + }
1.853 + TPtr8 arg3Ptr = arg3Buf->Des();
1.854 + if(KSecPolicyLen > 0)
1.855 + {
1.856 + arg3Ptr.Copy(aSecurityPolicyData);
1.857 + }
1.858 + if(KConfigStrLen > 0)
1.859 + {
1.860 + //coverity[DEADCODE]
1.861 + //The ASSERT might be useful in catching future defect in this function
1.862 + __ASSERT_DEBUG(aConfig != NULL, __SQLPANIC(ESqlPanicInternalError));
1.863 + arg3Ptr.Append(*aConfig);
1.864 + }
1.865 + ipcArgs.Set(3, &arg3Ptr);
1.866 + }
1.867 + TInt err = SendReceive(aFunction, ipcArgs);
1.868 + delete arg3Buf;
1.869 + return err;
1.870 + }