1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/persistentdata/persistentstorage/sql/SRC/Server/SqlSrvUtil.cpp Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,233 @@
1.4 +// Copyright (c) 2006-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 <stdlib.h> //wchar_t
1.20 +#include "SqlAssert.h"
1.21 +#include "SqlSrvUtil.h"
1.22 +#include "OstTraceDefinitions.h"
1.23 +#ifdef OST_TRACE_COMPILER_IN_USE
1.24 +#include "SqlSrvUtilTraces.h"
1.25 +#endif
1.26 +#include "SqlTraceDef.h"
1.27 +
1.28 +#ifdef _SQL_AUTHORIZER_TRACE_ENABLED
1.29 +
1.30 +//Used in PrintAuthorizerArguments()
1.31 +_LIT8(KCreateIndex, "Create index"); //SQLITE_CREATE_INDEX
1.32 +_LIT8(KCreateTable, "Create table"); //SQLITE_CREATE_TABLE
1.33 +_LIT8(KCreateTempIndex, "Create temp index"); //SQLITE_CREATE_TEMP_INDEX
1.34 +_LIT8(KCreateTempTable, "Create temp table"); //SQLITE_CREATE_TEMP_TABLE
1.35 +_LIT8(KCreateTempTrigger, "Create temp trigger"); //SQLITE_CREATE_TEMP_TRIGGER
1.36 +_LIT8(KCreateTempView, "Create temp view"); //SQLITE_CREATE_TEMP_VIEW
1.37 +_LIT8(KCreateTrigger, "Create trigger"); //SQLITE_CREATE_TRIGGER
1.38 +_LIT8(KCreateView, "Create view"); //SQLITE_CREATE_VIEW
1.39 +_LIT8(KDelete, "DELETE"); //SQLITE_DELETE
1.40 +_LIT8(KDropIndex, "Drop index"); //SQLITE_DROP_INDEX
1.41 +_LIT8(KDropTable, "Drop table"); //SQLITE_DROP_TABLE
1.42 +_LIT8(KDropTempIndex, "Drop temp index"); //SQLITE_DROP_TEMP_INDEX
1.43 +_LIT8(KDropTempTable, "Drop temp table"); //SQLITE_DROP_TEMP_TABLE
1.44 +_LIT8(KDropTempTrigger, "Drop temp trigger"); //SQLITE_DROP_TEMP_TRIGGER
1.45 +_LIT8(KDropTempView, "Drop temp view"); //SQLITE_DROP_TEMP_VIEW
1.46 +_LIT8(KDropTrigger, "Drop trigger"); //SQLITE_DROP_TRIGGER
1.47 +_LIT8(KDropView, "Drop view"); //SQLITE_DROP_VIEW
1.48 +_LIT8(KInsert, "INSERT"); //SQLITE_INSERT
1.49 +_LIT8(KPragma, "PRAGMA"); //SQLITE_PRAGMA
1.50 +_LIT8(KRead, "Read"); //SQLITE_READ
1.51 +_LIT8(KSelect, "SELECT"); //SQLITE_SELECT
1.52 +_LIT8(KTransaction, "TRANSACTION"); //SQLITE_TRANSACTION
1.53 +_LIT8(KUpdate, "UPDATE"); //SQLITE_UPDATE
1.54 +_LIT8(KAttach, "ATTACH"); //SQLITE_ATTACH
1.55 +_LIT8(KDetach, "DETACH"); //SQLITE_DETACH
1.56 +_LIT8(KAlterTable, "Alter table"); //SQLITE_ALTER_TABLE
1.57 +_LIT8(KReindex, "Reindex"); //SQLITE_REINDEX
1.58 +_LIT8(KAnalyze, "Analyze"); //SQLITE_ANALYZE
1.59 +_LIT8(KCreateVTable, "Create virt.table"); //SQLITE_CREATE_VTABLE
1.60 +_LIT8(KDropVTable, "Drop virt.table"); //SQLITE_DROP_VTABLE
1.61 +_LIT8(KFunctionCall, "Function call"); //SQLITE_FUNCTION
1.62 +
1.63 +_LIT8(KNull, "NULL");
1.64 +_LIT8(KInvalid, "INVALID");
1.65 +
1.66 +//Used in PrintAuthorizerArguments()
1.67 +const TPtrC8 KDbOpNames[] =
1.68 + {
1.69 + KCreateIndex(), KCreateTable(), KCreateTempIndex(), KCreateTempTable(), KCreateTempTrigger(),
1.70 + KCreateTempView(), KCreateTrigger(), KCreateView(), KDelete(), KDropIndex(),
1.71 + KDropTable(), KDropTempIndex(), KDropTempTable(), KDropTempTrigger(), KDropTempView(),
1.72 + KDropTrigger(), KDropView(), KInsert(), KPragma(), KRead(),
1.73 + KSelect(), KTransaction(), KUpdate(), KAttach(), KDetach(), KAlterTable(), KReindex(), KAnalyze(),
1.74 + KCreateVTable(), KDropVTable(), KFunctionCall()
1.75 + };
1.76 +
1.77 +#ifdef _DEBUG
1.78 +const TInt KMaxOpCodes = sizeof(KDbOpNames) / sizeof(KDbOpNames[0]);
1.79 +#endif
1.80 +
1.81 +/**
1.82 +This function has a defined implementaion only in _DEBUG mode and is used to print the authorizer arguments.
1.83 +
1.84 +@internalComponent
1.85 +*/
1.86 +void PrintAuthorizerArguments(TInt aDbOpType, const char* aDbObjName1, const char* aDbObjName2,
1.87 + const char* aDbName, const char* aTrgOrViewName)
1.88 + {
1.89 + __ASSERT_DEBUG(aDbOpType > 0 && aDbOpType <= KMaxOpCodes, __SQLPANIC2(ESqlPanicInternalError));
1.90 +
1.91 + //TPtrC8 objects cannot be used for the function arguments, because the arguments may not be 16-bit aligned!!!
1.92 +
1.93 + TBuf<20> opName;
1.94 + opName.Copy(KDbOpNames[aDbOpType - 1]);
1.95 +
1.96 + TBuf<64> dbObjName1;
1.97 + dbObjName1.Copy(KNull);
1.98 + if(aDbObjName1)
1.99 + {
1.100 + dbObjName1.Copy(KInvalid);
1.101 + if(User::StringLength((const TUint8*)aDbObjName1) <= dbObjName1.MaxLength())
1.102 + {
1.103 + dbObjName1.Copy(TPtrC8(reinterpret_cast <const TUint8*> (aDbObjName1)));
1.104 + }
1.105 + }
1.106 + TBuf<64> dbObjName2;
1.107 + dbObjName2.Copy(KNull);
1.108 + if(aDbObjName2)
1.109 + {
1.110 + dbObjName2.Copy(KInvalid);
1.111 + if(User::StringLength((const TUint8*)aDbObjName2) <= dbObjName2.MaxLength())
1.112 + {
1.113 + dbObjName2.Copy(TPtrC8(reinterpret_cast <const TUint8*> (aDbObjName2)));
1.114 + }
1.115 + }
1.116 + TBuf<64> dbName;
1.117 + dbName.Copy(KNull);
1.118 + if(aDbName)
1.119 + {
1.120 + dbName.Copy(KInvalid);
1.121 + if(User::StringLength((const TUint8*)aDbName) <= dbName.MaxLength())
1.122 + {
1.123 + dbName.Copy(TPtrC8(reinterpret_cast <const TUint8*> (aDbName)));
1.124 + }
1.125 + }
1.126 + TBuf<64> trgOrViewName;
1.127 + trgOrViewName.Copy(KNull);
1.128 + if(aTrgOrViewName)
1.129 + {
1.130 + trgOrViewName.Copy(KInvalid);
1.131 + if(User::StringLength((const TUint8*)aTrgOrViewName) <= trgOrViewName.MaxLength())
1.132 + {
1.133 + trgOrViewName.Copy(TPtrC8(reinterpret_cast <const TUint8*> (aTrgOrViewName)));
1.134 + }
1.135 + }
1.136 +
1.137 + SQL_TRACE_AUTHORIZER(OstTraceExt5(TRACE_INTERNALS, SQLAUTHORIZER, "0;PrintAuthorizerArguments;%20.20S;%40.40S;%10.10S;%10.10S;%10.10S", __SQLPRNSTR(opName), __SQLPRNSTR(dbObjName1), __SQLPRNSTR(dbObjName2), __SQLPRNSTR(dbName), __SQLPRNSTR(trgOrViewName)));
1.138 + }
1.139 +#endif//_SQL_AUTHORIZER_TRACE_ENABLED
1.140 +
1.141 +/**
1.142 +Converts a UTF16 encoded descriptor to a UTF8 encoded descriptor.
1.143 +Note: the function works only for input descriptors with length less or equal than KMaxFileName.
1.144 +
1.145 +@param aIn The input UTF16 encoded descriptor,
1.146 +@param aOut The output buffer where the converted input descriptor will be stored.
1.147 +@return True if the conversion was successful, false otherwise.
1.148 +
1.149 +@panic SqlDb 4 In _DEBUG mode if aIn length is bigger than KMaxFileName.
1.150 +@panic SqlDb 4 In _DEBUG mode if aOut max length is less than KMaxFileName.
1.151 +
1.152 +@internalComponent
1.153 +*/
1.154 +TBool UTF16ToUTF8(const TDesC& aIn, TDes8& aOut)
1.155 + {
1.156 + __ASSERT_DEBUG(aIn.Length() <= KMaxFileName, __SQLPANIC2(ESqlPanicBadArgument));
1.157 + __ASSERT_DEBUG(aOut.MaxLength() >= KMaxFileName, __SQLPANIC2(ESqlPanicBadArgument));
1.158 + TBuf16<KMaxFileName + 1> des;
1.159 + des.Copy(aIn);
1.160 + des.Append(TChar(0));
1.161 + TInt len = wcstombs((char*)aOut.Ptr(), (const wchar_t*)des.Ptr(), KMaxFileName);
1.162 + //Check the file name length. If it is longer than KMaxFileName characters, then the file name is not valid.
1.163 + if((TUint)len <= KMaxFileName)
1.164 + {
1.165 + aOut.SetLength(len);
1.166 + return ETrue;
1.167 + }
1.168 + return EFalse;
1.169 + }
1.170 +
1.171 +/**
1.172 +Converts a zero-terminated, UTF16 encoded file name to a zero-terminated, UTF8 encoded file name.
1.173 +@param aFileName The input file name buffer. aFileName argument is expected to point to UTF16 encoded,
1.174 + zero terminated string,
1.175 +@param aFileNameDestBuf The output file name buffer where the converted input file name will be stored.
1.176 + The output file name buffer max length should be at least KMaxFileName + 1.
1.177 +@return True if the conversion was successful, false otherwise.
1.178 +
1.179 +@panic SqlDb 4 In _DEBUG mode if aFileName length is bigger than KMaxFileName + 1.
1.180 +@panic SqlDb 4 In _DEBUG mode if aFileName is not zero-terminated or if aFileNameDestBuf max length is less than KMaxFileName + 1.
1.181 +
1.182 +@internalComponent
1.183 +*/
1.184 +TBool UTF16ZToUTF8Z(const TDesC& aFileName, TDes8& aFileNameDestBuf)
1.185 + {
1.186 + __ASSERT_DEBUG(aFileName.Length() <= (KMaxFileName + 1), __SQLPANIC2(ESqlPanicBadArgument));
1.187 + __ASSERT_DEBUG(aFileName[aFileName.Length() - 1] == 0, __SQLPANIC2(ESqlPanicBadArgument));
1.188 + __ASSERT_DEBUG(aFileNameDestBuf.MaxLength() >= (KMaxFileName + 1), __SQLPANIC2(ESqlPanicBadArgument));
1.189 + const wchar_t* src = reinterpret_cast <const wchar_t*> (aFileName.Ptr());
1.190 + TInt len = wcstombs((char*)aFileNameDestBuf.Ptr(), src, KMaxFileName);
1.191 + //Check the file name length. If it is longer than KMaxFileName characters, then the file name is not valid.
1.192 + if((TUint)len <= KMaxFileName)
1.193 + {
1.194 + aFileNameDestBuf.SetLength(len + 1);
1.195 + aFileNameDestBuf[len] = 0;
1.196 + return ETrue;
1.197 + }
1.198 + return EFalse;
1.199 + }
1.200 +
1.201 +/**
1.202 +Converts a UTF16 encoded file name to a zero-terminated, UTF8 encoded file name.
1.203 +@param aFileName The input file name buffer. aFileName argument is expected to point to UTF16 encoded string,
1.204 +@param aFileNameDestBuf The output file name buffer where the converted input file name will be stored.
1.205 + The output file name buffer max length should be at least KMaxFileName + 1.
1.206 +@return True if the conversion was successful, false otherwise.
1.207 +
1.208 +@panic SqlDb 4 In _DEBUG mode if aFileName length is bigger than KMaxFileName.
1.209 +@panic SqlDb 4 In _DEBUG mode if aFileNameDestBuf max length is less than KMaxFileName + 1.
1.210 +
1.211 +@internalComponent
1.212 +*/
1.213 +TBool UTF16ToUTF8Z(const TDesC& aFileName, TDes8& aFileNameDestBuf)
1.214 + {
1.215 + __ASSERT_DEBUG(aFileName.Length() <= KMaxFileName, __SQLPANIC2(ESqlPanicBadArgument));
1.216 + __ASSERT_DEBUG(aFileNameDestBuf.MaxLength() >= (KMaxFileName + 1), __SQLPANIC2(ESqlPanicBadArgument));
1.217 + TBool rc = ::UTF16ToUTF8(aFileName, aFileNameDestBuf);
1.218 + if(rc)
1.219 + {
1.220 + aFileNameDestBuf.Append(0);
1.221 + }
1.222 + return rc;
1.223 + }
1.224 +
1.225 +//Returns true if aDbFileName is a read-only file
1.226 +TBool IsReadOnlyFileL(RFs& aFs, const TDesC& aDbFileName)
1.227 + {
1.228 + TEntry entry;
1.229 + TInt err = aFs.Entry(aDbFileName, entry);
1.230 + if(err == KErrNotFound)
1.231 + {//Non-existing file
1.232 + return EFalse;
1.233 + }
1.234 + __SQLLEAVE_IF_ERROR2(err);
1.235 + return entry.IsReadOnly();
1.236 + }