Ensure that TEXT column is UTF-8 encoded before using sqlite3_column_blob()

If the database is in a different format (ie. UTF-16) the memory that
sqlite3_column_blob() will point to by default will be the native (UTF-16)
encoding. Calling sqlite3_column_bytes() will basically be a noop for
a BLOB or a TEXT already in UTF-8. Otherwise it'll convert to TEXT w/UTF-8.

Run the 'basis' tests against both a UTF-8 and a UTF-16 database.
Reset & rerun query between tests blocks to reset column types.
Reorder a few getText()/getString() operations to ensure we test both ordering.
Don't try to convert random blob to TEXT. Will fail encoding conversion.
This commit is contained in:
Doug Nazar 2022-12-02 14:03:03 -05:00
parent a32e884e8c
commit 77fc1f30b2
2 changed files with 33 additions and 6 deletions

View File

@ -92,6 +92,9 @@ std::string Column::getString() const
{ {
// Note: using sqlite3_column_blob and not sqlite3_column_text // Note: using sqlite3_column_blob and not sqlite3_column_text
// - no need for sqlite3_column_text to add a \0 on the end, as we're getting the bytes length directly // - no need for sqlite3_column_text to add a \0 on the end, as we're getting the bytes length directly
// however, we need to call sqlite3_column_bytes() to ensure correct format. It's a noop on a BLOB
// or a TEXT value with the correct encoding (UTF-8). Otherwise it'll do a conversion to TEXT (UTF-8).
(void)sqlite3_column_bytes(mStmtPtr.get(), mIndex);
auto data = static_cast<const char *>(sqlite3_column_blob(mStmtPtr.get(), mIndex)); auto data = static_cast<const char *>(sqlite3_column_blob(mStmtPtr.get(), mIndex));
// SQLite docs: "The safest policy is to invoke… sqlite3_column_blob() followed by sqlite3_column_bytes()" // SQLite docs: "The safest policy is to invoke… sqlite3_column_blob() followed by sqlite3_column_bytes()"

View File

@ -19,13 +19,18 @@
#include <stdint.h> #include <stdint.h>
TEST(Column, basis) static void test_column_basis(bool utf16)
{ {
// Create a new database // Create a new database
SQLite::Database db(":memory:", SQLite::OPEN_READWRITE|SQLite::OPEN_CREATE); SQLite::Database db(":memory:", SQLite::OPEN_READWRITE|SQLite::OPEN_CREATE);
EXPECT_EQ(SQLite::OK, db.getErrorCode()); EXPECT_EQ(SQLite::OK, db.getErrorCode());
EXPECT_EQ(SQLite::OK, db.getExtendedErrorCode()); EXPECT_EQ(SQLite::OK, db.getExtendedErrorCode());
if (utf16)
{
EXPECT_EQ(0, db.exec("PRAGMA encoding = 'UTF-16';"));
}
// Create a new table // Create a new table
EXPECT_EQ(0, db.exec("CREATE TABLE test (id INTEGER PRIMARY KEY, msg TEXT, int INTEGER, double REAL, binary BLOB, empty TEXT)")); EXPECT_EQ(0, db.exec("CREATE TABLE test (id INTEGER PRIMARY KEY, msg TEXT, int INTEGER, double REAL, binary BLOB, empty TEXT)"));
EXPECT_TRUE(db.tableExists("test")); EXPECT_TRUE(db.tableExists("test"));
@ -82,6 +87,10 @@ TEST(Column, basis)
EXPECT_EQ(1, id1); EXPECT_EQ(1, id1);
EXPECT_EQ(1, id2); EXPECT_EQ(1, id2);
EXPECT_EQ(1, id3); EXPECT_EQ(1, id3);
EXPECT_EQ(1, id4);
EXPECT_EQ(1, id5);
EXPECT_EQ(1, id6);
EXPECT_EQ(1, id7);
EXPECT_EQ(1U, uint1); EXPECT_EQ(1U, uint1);
EXPECT_EQ(1U, uint2); EXPECT_EQ(1U, uint2);
EXPECT_EQ(1U, uint3); EXPECT_EQ(1U, uint3);
@ -98,14 +107,17 @@ TEST(Column, basis)
EXPECT_EQ(NULL, pempty); EXPECT_EQ(NULL, pempty);
} }
query.reset();
query.executeStep();
// validates every variant of explicit getters // validates every variant of explicit getters
{ {
int64_t id = query.getColumn(0).getInt64(); int64_t id = query.getColumn(0).getInt64();
const unsigned int uint1 = query.getColumn(0).getUInt(); const unsigned int uint1 = query.getColumn(0).getUInt();
const uint32_t uint2 = query.getColumn(0).getUInt(); const uint32_t uint2 = query.getColumn(0).getUInt();
const std::string msg1 = query.getColumn(1).getString();
const char* ptxt = query.getColumn(1).getText(); const char* ptxt = query.getColumn(1).getText();
const std::string msg1 = query.getColumn(1).getText(); const std::string msg2 = query.getColumn(1).getText();
const std::string msg2 = query.getColumn(1).getString();
const int integer = query.getColumn(2).getInt(); const int integer = query.getColumn(2).getInt();
const double real = query.getColumn(3).getDouble(); const double real = query.getColumn(3).getDouble();
const void* pblob = query.getColumn(4).getBlob(); const void* pblob = query.getColumn(4).getBlob();
@ -129,7 +141,7 @@ TEST(Column, basis)
EXPECT_EQ(false, query.getColumn(0).isText()); EXPECT_EQ(false, query.getColumn(0).isText());
EXPECT_EQ(false, query.getColumn(0).isBlob()); EXPECT_EQ(false, query.getColumn(0).isBlob());
EXPECT_EQ(false, query.getColumn(0).isNull()); EXPECT_EQ(false, query.getColumn(0).isNull());
EXPECT_STREQ("1", query.getColumn(0).getText()); // convert to string EXPECT_STREQ("1", query.getColumn(0).getText()); // convert to TEXT via text func
EXPECT_EQ(1, query.getColumn(0).getBytes()); // size of the string "1" without the null terminator EXPECT_EQ(1, query.getColumn(0).getBytes()); // size of the string "1" without the null terminator
EXPECT_EQ(SQLite::TEXT, query.getColumn(1).getType()); EXPECT_EQ(SQLite::TEXT, query.getColumn(1).getType());
EXPECT_EQ(false, query.getColumn(1).isInteger()); EXPECT_EQ(false, query.getColumn(1).isInteger());
@ -137,7 +149,7 @@ TEST(Column, basis)
EXPECT_EQ(true, query.getColumn(1).isText()); EXPECT_EQ(true, query.getColumn(1).isText());
EXPECT_EQ(false, query.getColumn(1).isBlob()); EXPECT_EQ(false, query.getColumn(1).isBlob());
EXPECT_EQ(false, query.getColumn(1).isNull()); EXPECT_EQ(false, query.getColumn(1).isNull());
EXPECT_STREQ("first", query.getColumn(1).getText()); // convert to string EXPECT_STREQ("first", query.getColumn(1).getString().c_str()); // convert to TEXT via string func
EXPECT_EQ(5, query.getColumn(1).getBytes()); // size of the string "first" EXPECT_EQ(5, query.getColumn(1).getBytes()); // size of the string "first"
EXPECT_EQ(SQLite::INTEGER, query.getColumn(2).getType()); EXPECT_EQ(SQLite::INTEGER, query.getColumn(2).getType());
EXPECT_EQ(true, query.getColumn(2).isInteger()); EXPECT_EQ(true, query.getColumn(2).isInteger());
@ -161,7 +173,6 @@ TEST(Column, basis)
EXPECT_EQ(false, query.getColumn(4).isText()); EXPECT_EQ(false, query.getColumn(4).isText());
EXPECT_EQ(true, query.getColumn(4).isBlob()); EXPECT_EQ(true, query.getColumn(4).isBlob());
EXPECT_EQ(false, query.getColumn(4).isNull()); EXPECT_EQ(false, query.getColumn(4).isNull());
EXPECT_STREQ("bl\0b", query.getColumn(4).getText()); // convert to string
EXPECT_EQ(4, query.getColumn(4).getBytes()); // size of the blob "bl\0b" with the null char EXPECT_EQ(4, query.getColumn(4).getBytes()); // size of the blob "bl\0b" with the null char
EXPECT_EQ(SQLite::Null, query.getColumn(5).getType()); EXPECT_EQ(SQLite::Null, query.getColumn(5).getType());
EXPECT_EQ(false, query.getColumn(5).isInteger()); EXPECT_EQ(false, query.getColumn(5).isInteger());
@ -172,6 +183,9 @@ TEST(Column, basis)
EXPECT_STREQ("", query.getColumn(5).getText()); // convert to string EXPECT_STREQ("", query.getColumn(5).getText()); // convert to string
EXPECT_EQ(0, query.getColumn(5).getBytes()); // size of the string "" without the null terminator EXPECT_EQ(0, query.getColumn(5).getBytes()); // size of the string "" without the null terminator
query.reset();
query.executeStep();
// Use intermediate Column objects (this is not the recommended way to use the API) // Use intermediate Column objects (this is not the recommended way to use the API)
{ {
const SQLite::Column id = query.getColumn(0); const SQLite::Column id = query.getColumn(0);
@ -185,6 +199,16 @@ TEST(Column, basis)
} }
} }
TEST(Column, basis)
{
test_column_basis(false);
}
TEST(Column, basis16)
{
test_column_basis(true);
}
TEST(Column, getName) TEST(Column, getName)
{ {
// Create a new database // Create a new database