[Top Sites] Encoding redirects field in TopSitesDatabase, and adding validations

chrome/browser/history/top_sites_database.h

 // 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.
 
 #ifndef CHROME_BROWSER_HISTORY_TOP_SITES_DATABASE_H_
 #define CHROME_BROWSER_HISTORY_TOP_SITES_DATABASE_H_
 
 #include <map>
 #include <string>
+#include <vector>
 
 #include "base/gtest_prod_util.h"
 #include "chrome/browser/history/history_types.h"
 #include "sql/meta_table.h"
 
 namespace base {
 class FilePath;
 }
 
 namespace sql {
@@ skipping 37 matching lines @@
   bool RemoveURL(const MostVisitedURL& url);
 
  private:
   FRIEND_TEST_ALL_PREFIXES(TopSitesDatabaseTest, Version1);
   FRIEND_TEST_ALL_PREFIXES(TopSitesDatabaseTest, Version2);
   FRIEND_TEST_ALL_PREFIXES(TopSitesDatabaseTest, Version3);
   FRIEND_TEST_ALL_PREFIXES(TopSitesDatabaseTest, Recovery1);
   FRIEND_TEST_ALL_PREFIXES(TopSitesDatabaseTest, Recovery2);
   FRIEND_TEST_ALL_PREFIXES(TopSitesDatabaseTest, Recovery3);
   FRIEND_TEST_ALL_PREFIXES(TopSitesDatabaseTest, AddRemoveEditThumbnails);
+  FRIEND_TEST_ALL_PREFIXES(TopSitesDatabaseTest, EncodeCSVString);
+  FRIEND_TEST_ALL_PREFIXES(TopSitesDatabaseTest, DecodeCSVStringSucceed);
+  FRIEND_TEST_ALL_PREFIXES(TopSitesDatabaseTest, DecodeCSVStringFail);
+  FRIEND_TEST_ALL_PREFIXES(TopSitesDatabaseTest, EncodeRedirects);
+  FRIEND_TEST_ALL_PREFIXES(TopSitesDatabaseTest, DecodeRedirects);
+  FRIEND_TEST_ALL_PREFIXES(TopSitesDatabaseTest, DecodeRedirectsFallback);
 
   // Rank of all URLs that are forced and therefore cannot be automatically
   // evicted.
   static const int kRankOfForcedURL;
 
   // Rank used to indicate that a URL is not stored in the database.
   static const int kRankOfNonExistingURL;
 
   // Upgrades the thumbnail table to version 3, returning true if the
   // upgrade was successful.
   bool UpgradeToVersion3();
 
   // Adds a new URL to the database.
   void AddPageThumbnail(const MostVisitedURL& url,
                         int new_rank,
                         const Images& thumbnail);
 
+  // Encodes a vector of strings as a single string, as a comma separated list

[beaudoin, 2014/09/09 21:32:27]

as a single string --> inside a single string

[huangs, 2014/09/11 01:58:13]

Done.

+  // of quoted strings. Existing quotation marks are escaped as "\"\"".

[beaudoin, 2014/09/09 21:32:27]

You mean existing quotation marks are escaped by prepending them with a
backslash? Are existing backslashes escaped?

[huangs, 2014/09/11 01:58:13]

Backslash is not involved; we substituted '"' to '""'.

+  static std::string EncodeCSVString(const std::vector<std::string> str_list);
+
+  // Decodes a string encoded by EncodeCSVString() as a vector of strings,
+  // On success returns true, otherwise returns false and ignores |str_list|.
+  static bool DecodeCSVString(const std::string csv,
+                              std::vector<std::string>* str_list);
+
+  // Encodes redirects in |url| as string.

[beaudoin, 2014/09/09 21:32:27]

|url|?

[huangs, 2014/09/11 01:58:14]

Done.

+  static std::string EncodeRedirects(const RedirectList& redirects);
+
+  // Decodes a redirects string, appends the result ot |redirects|.

[beaudoin, 2014/09/09 21:32:27]

ot -> to

[huangs, 2014/09/11 01:58:14]

Done.

+  static void DecodeRedirects(const std::string& encoded_redirects,
+                              RedirectList* redirects);
+
   // Sets the page rank. Should be called within an open transaction.
   void UpdatePageRankNoTransaction(const MostVisitedURL& url, int new_rank);
 
   // Updates thumbnail of a URL that's already in the database.
   // Returns true if the database query succeeds.
   bool UpdatePageThumbnail(const MostVisitedURL& url,
                            const Images& thumbnail);
 
   // Returns |url|'s current rank or kRankOfNonExistingURL if not present.
   int GetURLRank(const MostVisitedURL& url);
 
   // Helper function to implement internals of Init().  This allows
   // Init() to retry in case of failure, since some failures will
   // invoke recovery code.
   bool InitImpl(const base::FilePath& db_name);
 
   sql::Connection* CreateDB(const base::FilePath& db_name);
 
   scoped_ptr<sql::Connection> db_;
   sql::MetaTable meta_table_;
 
   DISALLOW_COPY_AND_ASSIGN(TopSitesDatabase);
 };
 
 }  // namespace history
 
 #endif  // CHROME_BROWSER_HISTORY_TOP_SITES_DATABASE_H_