Changeset 236085 in webkit

Timestamp:

Sep 17, 2018 2:41:13 PM (6 years ago)

Author:

chris.reid@sony.com

Message:

[Curl] Add schema version and enable auto vacuum for cookie database.
​https://bugs.webkit.org/show_bug.cgi?id=189669

Reviewed by Alex Christensen.

Turning on auto incremental vacuuming and adding versioning to the database. Right now we
reset tables if there's an unknown schema or if the none is set. There is placeholder logic
in place to upgrade databases as the schema changes in the future.

Tested by checking the database manually after launching MiniBrowser.

• platform/network/curl/CookieJarDB.cpp:

(WebCore::CookieJarDB::openDatabase):
(WebCore::CookieJarDB::verifySchemaVersion):
(WebCore::CookieJarDB::deleteAllTables):
(WebCore::CookieJarDB::createPrepareStatement):
(WebCore::CookieJarDB::getPrepareStatement):
(WebCore::CookieJarDB::executeSimpleSql):

• platform/network/curl/CookieJarDB.h:
• platform/network/curl/NetworkStorageSessionCurl.cpp:

(WebCore::defaultSession):

• platform/sql/SQLiteDatabase.cpp:

(WebCore::SQLiteDatabase::turnOnIncrementalAutoVacuum): fixed a bug.

Location:

trunk/Source/WebCore

Files:

• ChangeLog (modified) (1 diff)
• platform/network/curl/CookieJarDB.cpp (modified) (6 diffs)
• platform/network/curl/CookieJarDB.h (modified) (1 diff)
• platform/network/curl/NetworkStorageSessionCurl.cpp (modified) (1 diff)
• platform/sql/SQLiteDatabase.cpp (modified) (1 diff)

trunk/Source/WebCore/ChangeLog

@@ +1 @@
+2018-09-17  Christopher Reid  <chris.reid@sony.com>
+
+        [Curl] Add schema version and enable auto vacuum for cookie database.
+        https://bugs.webkit.org/show_bug.cgi?id=189669
+
+        Reviewed by Alex Christensen.
+
+        Turning on auto incremental vacuuming and adding versioning to the database. Right now we
+        reset tables if there's an unknown schema or if the none is set. There is placeholder logic
+        in place to upgrade databases as the schema changes in the future.
+
+        Tested by checking the database manually after launching MiniBrowser.
+
+        * platform/network/curl/CookieJarDB.cpp:
+        (WebCore::CookieJarDB::openDatabase):
+        (WebCore::CookieJarDB::verifySchemaVersion):
+        (WebCore::CookieJarDB::deleteAllTables):
+        (WebCore::CookieJarDB::createPrepareStatement):
+        (WebCore::CookieJarDB::getPrepareStatement):
+        (WebCore::CookieJarDB::executeSimpleSql):
+        * platform/network/curl/CookieJarDB.h:
+        * platform/network/curl/NetworkStorageSessionCurl.cpp:
+        (WebCore::defaultSession):
+        * platform/sql/SQLiteDatabase.cpp:
+        (WebCore::SQLiteDatabase::turnOnIncrementalAutoVacuum): fixed a bug.
+
 2018-09-14  Ryosuke Niwa  <rniwa@webkit.org>
 

trunk/Source/WebCore/platform/network/curl/CookieJarDB.cpp

@@ -72 +72 @@
     "DELETE FROM Cookie;"
 
+
+// If the database schema is updated:
+// - Increment schemaVersion
+// - Add upgrade logic in verifySchemaVersion to migrate databases from the previous schema version
+static constexpr int schemaVersion = 1;
+
+
 void CookieJarDB::setEnabled(bool enable)
 {
@@ -126 +133 @@
             LOG_ERROR("Unable to create the Cookie Database path %s", m_databasePath.utf8().data());
 
-        if (m_database.open(m_databasePath, false)) {
-            bool databaseValidity = true;
-            databaseValidity &= (executeSimpleSql(CREATE_COOKIE_TABLE_SQL) == SQLITE_DONE);
-            databaseValidity &= (executeSimpleSql(CREATE_DOMAIN_INDEX_SQL) == SQLITE_DONE);
-            databaseValidity &= (executeSimpleSql(CREATE_PATH_INDEX_SQL) == SQLITE_DONE);
-            if (!databaseValidity) {
-                // give up create database at this time (all cookies on request/response are ignored)
-                m_database.close();
-                deleteAllDatabaseFiles();
-            }
-        }
+        m_database.open(m_databasePath, false);
     }
 
     if (!m_database.isOpen())
         return false;
+
+    if (!isOnMemory() && !m_database.turnOnIncrementalAutoVacuum())
+        LOG_ERROR("Unable to turn on incremental auto-vacuum (%d %s)", m_database.lastError(), m_database.lastErrorMsg());
+
+    verifySchemaVersion();
+
+    bool databaseValidity = true;
+    if (!existsDatabaseFile || !m_database.tableExists("Cookie")) {
+        databaseValidity &= (executeSimpleSql(CREATE_COOKIE_TABLE_SQL) == SQLITE_DONE);
+        databaseValidity &= (executeSimpleSql(CREATE_DOMAIN_INDEX_SQL) == SQLITE_DONE);
+        databaseValidity &= (executeSimpleSql(CREATE_PATH_INDEX_SQL) == SQLITE_DONE);
+    }
+
+    if (!databaseValidity) {
+        // give up create database at this time (all cookies on request/response are ignored)
+        m_database.close();
+        deleteAllDatabaseFiles();
+        return false;
+    }
 
     m_database.setSynchronous(SQLiteDatabase::SyncNormal);
@@ -161 +177 @@
         m_database.close();
     }
+}
+
+void CookieJarDB::verifySchemaVersion()
+{
+    if (isOnMemory())
+        return;
+
+    int version = SQLiteStatement(m_database, "PRAGMA user_version").getColumnInt(0);
+    if (version == schemaVersion)
+        return;
+
+    switch (version) {
+        // Placeholder for schema version upgrade logic
+        // Ensure cases fall through to the next version's upgrade logic
+
+    case 0:
+        deleteAllTables();
+        break;
+    default:
+        // This case can be reached when downgrading versions
+        LOG_ERROR("Unknown cookie database version: %d", version);
+        deleteAllTables();
+        break;
+    }
+
+    // Update version
+    executeSimpleSql(String::format("PRAGMA user_version=%d", schemaVersion));
+}
+
+void CookieJarDB::deleteAllTables()
+{
+    if (!m_database.isOpen())
+        return;
+
+    m_database.clearAllTables();
 }
 
@@ -485 +536 @@
 }
 
-void CookieJarDB::createPrepareStatement(const char* sql)
+void CookieJarDB::createPrepareStatement(const String& sql)
 {
     auto statement = std::make_unique<SQLiteStatement>(m_database, sql);
     int ret = statement->prepare();
     ASSERT(ret == SQLITE_OK);
-    m_statements.add(String(sql), WTFMove(statement));
-}
-
-SQLiteStatement* CookieJarDB::getPrepareStatement(const char* sql)
-{
-    const auto& statement = m_statements.get(String(sql));
+    m_statements.add(sql, WTFMove(statement));
+}
+
+SQLiteStatement* CookieJarDB::getPrepareStatement(const String& sql)
+{
+    const auto& statement = m_statements.get(sql);
     ASSERT(statement);
     statement->reset();
@@ -501 +552 @@
 }
 
-int CookieJarDB::executeSimpleSql(const char* sql, bool ignoreError)
+int CookieJarDB::executeSimpleSql(const String& sql, bool ignoreError)
 {
     SQLiteStatement statement(m_database, sql);
@@ -509 +560 @@
     checkSQLiteReturnCode(ret);
     if (ret != SQLITE_OK && ret != SQLITE_DONE && ret != SQLITE_ROW && !ignoreError)
-        LOG_ERROR("Failed to execute %s error: %s", sql, m_database.lastErrorMsg());
+        LOG_ERROR("Failed to execute %s error: %s", sql.ascii().data(), m_database.lastErrorMsg());
 
     return ret;

trunk/Source/WebCore/platform/network/curl/CookieJarDB.h

@@ -76 +76 @@
     void deleteAllDatabaseFiles();
 
-    void createPrepareStatement(const char* sql);
-    SQLiteStatement* getPrepareStatement(const char* sql);
-    int executeSimpleSql(const char* sql, bool ignoreError = false);
+    void verifySchemaVersion();
+    void deleteAllTables();
+
+    void createPrepareStatement(const String& sql);
+    SQLiteStatement* getPrepareStatement(const String& sql);
+    int executeSimpleSql(const String& sql, bool ignoreError = false);
 
     int deleteCookieInternal(const String& name, const String& domain, const String& path);

trunk/Source/WebCore/platform/network/curl/NetworkStorageSessionCurl.cpp

@@ -86 +86 @@
 {
     ASSERT(isMainThread());
-    static NeverDestroyed<std::unique_ptr<NetworkStorageSession>> session;
+    static std::unique_ptr<NetworkStorageSession> session;
     return session;
 }

trunk/Source/WebCore/platform/sql/SQLiteDatabase.cpp

@@ -489 +489 @@
     int autoVacuumMode = statement.getColumnInt(0);
     int error = lastError();
+    statement.finalize();
 
     // Check if we got an error while trying to get the value of the auto_vacuum flag.