Migrate old Shortcuts DB data to conform to new type values

chrome/browser/history/shortcuts_database.cc

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "chrome/browser/history/shortcuts_database.h"
 
 #include <string>
 #include <vector>
 
 #include "base/guid.h"
 #include "base/logging.h"
 #include "base/strings/stringprintf.h"
 #include "base/time/time.h"
+#include "sql/meta_table.h"
 #include "sql/statement.h"
 #include "sql/transaction.h"
 
 namespace {
 
+// Current version number. We write databases at the "current" version number,
+// but any previous version that can read the "compatible" one can make do with
+// or database without *too* many bad effects.
+const int kCurrentVersionNumber = 28;

[Anuj, 2014/02/10 22:18:44]

Not sure what version numbers I should use here.

[Peter Kasting, 2014/02/10 22:29:47]

If you didn't have a table before, use version 1 (for both).

+const int kCompatibleVersionNumber = 16;
+
 void BindShortcutToStatement(
     const history::ShortcutsBackend::Shortcut& shortcut,
     sql::Statement* s) {
   DCHECK(base::IsValidGUID(shortcut.id));
   s->BindString(0, shortcut.id);
   s->BindString16(1, shortcut.text);
   s->BindString16(2, shortcut.match_core.fill_into_edit);
   s->BindString(3, shortcut.match_core.destination_url.spec());
   s->BindString16(4, shortcut.match_core.contents);
   s->BindString(5, AutocompleteMatch::ClassificationsToString(
@@ skipping 121 matching lines @@
                                           // transition
                 static_cast<AutocompleteMatch::Type>(s.ColumnInt(9)),
                                           // type
                 s.ColumnString16(10)),    // keyword
             base::Time::FromInternalValue(s.ColumnInt64(11)),
                                           // last_access_time
             s.ColumnInt(12))));           // number_of_hits
   }
 }
 
+//static
+int ShortcutsDatabase::GetCurrentVersion() {

[Peter Kasting, 2014/02/10 22:29:47]

It doesn't seem like we need this as its own function, at least as this patch is
coded?

[Anuj, 2014/02/11 07:20:04]

Done.

+  return kCurrentVersionNumber;
+}
+
 ShortcutsDatabase::~ShortcutsDatabase() {
 }
 
 bool ShortcutsDatabase::EnsureTable() {
   if (!db_.DoesTableExist("omni_box_shortcuts")) {
     return db_.Execute(
         "CREATE TABLE omni_box_shortcuts (id VARCHAR PRIMARY KEY, "
             "text VARCHAR, fill_into_edit VARCHAR, url VARCHAR, "
             "contents VARCHAR, contents_class VARCHAR, description VARCHAR, "
             "description_class VARCHAR, transition INTEGER, type INTEGER, "
@@ skipping 19 matching lines @@
             static_cast<int>(content::PAGE_TRANSITION_TYPED)).c_str()) &&
         db_.Execute("ALTER TABLE omni_box_shortcuts ADD COLUMN type INTEGER") &&
         db_.Execute(base::StringPrintf(
             "UPDATE omni_box_shortcuts SET type = %d",
             static_cast<int>(AutocompleteMatchType::HISTORY_TITLE)).c_str()) &&
         db_.Execute("ALTER TABLE omni_box_shortcuts "
             "ADD COLUMN keyword VARCHAR") &&
         transaction.Commit();
   }
 
+  if (sql::MetaTable::DoesTableExist(&db_)) {

[Peter Kasting, 2014/02/10 22:29:47]

Don't you mean !exist?

[Anuj, 2014/02/11 07:20:04]

Done.

+    meta_table_.Init(&db_, GetCurrentVersion(), kCompatibleVersionNumber);
+    // With new suggestion types being added, following values have changed:

[Peter Kasting, 2014/02/10 22:29:47]

This comment is more confusing than helpful.  We didn't change the meaning of
SEARCH_OTHER_ENGINE to SEARCH_SUGGEST_ENTITY, we just renumbered the enum
values.  If you want to write a comment saying things like "SEARCH_OTHER_ENGINE
changed from 9 to 13", that'd be OK, but I think if we make the migration steps
simple, they'll become self-documenting so such a comment won't be necessary.

[Anuj, 2014/02/11 07:20:04]

Done.

+    // SEARCH_OTHER_ENGINE -> SEARCH_SUGGEST_ENTITY
+    // EXTENSION_APP -> SEARCH_SUGGEST_INFINITE
+    // CONTACT -> SEARCH_SUGGEST_PERSONALIZED
+    // BOOKMARK_TITLE -> SEARCH_SUGGEST_PROFILE
+    sql::Transaction transaction(&db_);
+    transaction.Begin();
+    // Migrate old SEARCH_OTHER_ENGINE values to the new type value.
+    // The ENTITY suggestion values always have a description and always have a
+    // https google search url with gs_ssp parameter.  The old
+    // SEARCH_OTHER_ENGINE entries will definitely fail the url check, but empty
+    // description test is also sufficient and faster.
+    db_.Execute(base::StringPrintf("UPDATE omni_box_shortcuts "
+          "SET type = 13 " // New SEARCH_OTHER_ENGINE
+          "where type = 9 AND " // Old SEARCH_OTHER_ENGINE
+          "(description = '' OR "
+          "url NOT REGEXP '^https://www\\.google\\..*/search\\?.*&?gs_ssp=.*')")
+        .c_str()) &&
+      // Migrate old EXTENSION_APP values to the new type value.
+      // The INFINITE suggestions are not launched. So it is safe to update all
+      // of them to EXTENSION_APP type wherever the url is not a google search.
+      db_.Execute(base::StringPrintf("UPDATE omni_box_shortcuts "
+            "SET type = 14 " // New EXTENSION_APP
+            "where type = 10 AND " // Old EXTENSION_APP
+            "url NOT REGEXP '^https://www\\.google\\..*/search\\?.*xssi=t.*')")
+          .c_str()) &&
+      // Migrate old CONTACT values to the new type value.
+      // The PERSONALIZED suggestions are a https google search url.
+      db_.Execute(base::StringPrintf("UPDATE omni_box_shortcuts "
+            "SET type = 15 " // New CONTACT
+            "where type = 11 AND " // Old CONTACT
+            "url NOT REGEXP '^https://www\\.google\\..*/search\\?.*xssi=t.*')")
+          .c_str()) &&
+      // Migrate old BOOKMARK_TITLE values to the new type value.
+      // The PROFILE suggestion values always have a description and always have
+      // a https google search url with tbs parameter.  The old BOOKMARK_TITLE
+      // entries will definitely fail the url check, but empty description test
+      // is also sufficient and faster.
+      db_.Execute(base::StringPrintf("UPDATE omni_box_shortcuts "
+            "SET type = 16 " // New BOOKMARK_TITLE
+            "where type = 12 AND " // Old BOOKMARK_TITLE
+            "(description = '' OR "
+            "url NOT REGEXP '^https://www\\.google\\..*/search\\?.*&?tbs=.*')")
+          .c_str()) &&
+      transaction.Commit();
+  }
   return true;
 }
 
 }  // namespace history