Cleanup history favicon code

chrome/browser/history/history_backend.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_HISTORY_BACKEND_H_
 #define CHROME_BROWSER_HISTORY_HISTORY_BACKEND_H_
 
 #include <set>
 #include <string>
 #include <utility>
@@ skipping 240 matching lines @@
   //
   // Exposed for testing reasons.
   void GetPageThumbnailDirectly(
       const GURL& page_url,
       scoped_refptr<base::RefCountedBytes>* data);
 
   void MigrateThumbnailsDatabase();
 
   // Favicon -------------------------------------------------------------------
 
-  struct FaviconResults {
-    FaviconResults();
-    ~FaviconResults();
-    void Clear();
-
-    std::vector<history::FaviconBitmapResult> bitmap_results;
-    IconURLSizesMap size_map;
-  };
-
   void GetFavicons(const std::vector<GURL>& icon_urls,
                     int icon_types,
                     int desired_size_in_dip,
                     const std::vector<ui::ScaleFactor>& desired_scale_factors,
-                    FaviconResults* results);
+                    std::vector<FaviconBitmapResult>* bitmap_results);
 
   void GetFaviconsForURL(
       const GURL& page_url,
       int icon_types,
       int desired_size_in_dip,
       const std::vector<ui::ScaleFactor>& desired_scale_factors,
-      FaviconResults* results);
+      std::vector<FaviconBitmapResult>* bitmap_results);
 
   void GetFaviconForID(
       FaviconID favicon_id,
       int desired_size_in_dip,
       ui::ScaleFactor desired_scale_factor,
-      FaviconResults* results);
+      std::vector<FaviconBitmapResult>* bitmap_results);
 
   void UpdateFaviconMappingsAndFetch(
       const GURL& page_url,
       const std::vector<GURL>& icon_urls,
       int icon_types,
       int desired_size_in_dip,
       const std::vector<ui::ScaleFactor>& desired_scale_factors,
-      FaviconResults* results);
+      std::vector<FaviconBitmapResult>* bitmap_results);
 
   void MergeFavicon(const GURL& page_url,
                     const GURL& icon_url,
                     IconType icon_type,
                     scoped_refptr<base::RefCountedMemory> bitmap_data,
                     const gfx::Size& pixel_size);
 
   void SetFavicons(
       const GURL& page_url,
       IconType icon_type,
-      const std::vector<FaviconBitmapData>& favicon_bitmap_data,
-      const IconURLSizesMap& icon_url_sizes);
+      const std::vector<FaviconBitmapData>& favicon_bitmap_data);
 
   void SetFaviconsOutOfDateForPage(const GURL& page_url);
 
   void CloneFavicons(const GURL& old_page_url, const GURL& new_page_url);
 
   void SetImportedFavicons(
       const std::vector<ImportedFaviconUsage>& favicon_usage);
 
   // Downloads -----------------------------------------------------------------
 
@@ skipping 191 matching lines @@
   FRIEND_TEST_ALL_PREFIXES(HistoryBackendTest, AddVisitsSource);
   FRIEND_TEST_ALL_PREFIXES(HistoryBackendTest, GetMostRecentVisits);
   FRIEND_TEST_ALL_PREFIXES(HistoryBackendTest, RemoveVisitsSource);
   FRIEND_TEST_ALL_PREFIXES(HistoryBackendTest, RemoveVisitsTransitions);
   FRIEND_TEST_ALL_PREFIXES(HistoryBackendTest, MigrationVisitSource);
   FRIEND_TEST_ALL_PREFIXES(HistoryBackendTest, MigrationIconMapping);
   FRIEND_TEST_ALL_PREFIXES(HistoryBackendTest,
                            SetFaviconMappingsForPageAndRedirects);
   FRIEND_TEST_ALL_PREFIXES(HistoryBackendTest,
                            SetFaviconMappingsForPageDuplicates);
-  FRIEND_TEST_ALL_PREFIXES(HistoryBackendTest, SetFavicons);
   FRIEND_TEST_ALL_PREFIXES(HistoryBackendTest, SetFaviconsDeleteBitmaps);
   FRIEND_TEST_ALL_PREFIXES(HistoryBackendTest, SetFaviconsReplaceBitmapData);
   FRIEND_TEST_ALL_PREFIXES(HistoryBackendTest,
                            SetFaviconsSameFaviconURLForTwoPages);
   FRIEND_TEST_ALL_PREFIXES(HistoryBackendTest,
                            UpdateFaviconMappingsAndFetchNoChange);
   FRIEND_TEST_ALL_PREFIXES(HistoryBackendTest, MergeFaviconPageURLNotInDB);
   FRIEND_TEST_ALL_PREFIXES(HistoryBackendTest, MergeFaviconPageURLInDB);
   FRIEND_TEST_ALL_PREFIXES(HistoryBackendTest, MergeFaviconMaxFaviconsPerPage);
   FRIEND_TEST_ALL_PREFIXES(HistoryBackendTest,
@@ skipping 134 matching lines @@
   // If |page_url| is non-null, |icon_types| can be multiple icon types
   // only if |icon_types| == TOUCH_ICON | TOUCH_PRECOMPOSED_ICON.
   // If multiple icon types are specified, |page_url| will be mapped to the
   // icon URLs of the largest type available in the database.
   void UpdateFaviconMappingsAndFetchImpl(
       const GURL* page_url,
       const std::vector<GURL>& icon_urls,
       int icon_types,
       int desired_size_in_dip,
       const std::vector<ui::ScaleFactor>& desired_scale_factors,
-      FaviconResults* results);
+      std::vector<FaviconBitmapResult>* results);
 
   // Set the favicon bitmaps for |icon_id|.
   // For each entry in |favicon_bitmap_data|, if a favicon bitmap already
   // exists at the entry's pixel size, replace the favicon bitmap's data with
   // the entry's bitmap data. Otherwise add a new favicon bitmap.
+  // Any favicon bitmaps already mapped to |icon_id| whose pixel sizes are not
+  // in |favicon_bitmap_data| are deleted.
   // If not NULL, |favicon_bitmaps_changed| is set to whether any of the bitmap
   // data at |icon_id| is changed as a result of calling this method.
   // Computing |favicon_bitmaps_changed| requires additional database queries
   // so should be avoided if unnecessary.
   void SetFaviconBitmaps(
       FaviconID icon_id,
       const std::vector<FaviconBitmapData>& favicon_bitmap_data,
       bool* favicon_bitmaps_changed);
 
-  // Returns true if |favicon_bitmap_data| and |icon_url_sizes| passed to
-  // SetFavicons() are valid.
+  // Returns true if |favicon_bitmap_data| passed to SetFavicons() is valid.
   // Criteria:
-  // 1) |icon_url_sizes| contains no more than
-  //      kMaxFaviconsPerPage icon URLs.
-  //      kMaxFaviconBitmapsPerIconURL favicon sizes for each icon URL.
-  // 2) The icon URLs and favicon sizes of |favicon_bitmap_data| are a subset
-  //    of |icon_url_sizes|.
-  // 3) The favicon sizes for entries in |icon_url_sizes| which have associated
-  //    data in |favicon_bitmap_data| is not history::GetDefaultFaviconSizes().
-  // 4) FaviconBitmapData::bitmap_data contains non NULL bitmap data.
+  // 1) |favicon_bitmap_data| contains no more than
+  //      kMaxFaviconsPerPage unique icon URLs.
+  //      kMaxFaviconBitmapsPerIconURL favicon bitmaps for each icon URL.
+  // 2) FaviconBitmapData::bitmap_data contains non NULL bitmap data.
   bool ValidateSetFaviconsParams(
-      const std::vector<FaviconBitmapData>& favicon_bitmap_data,
-      const IconURLSizesMap& icon_url_sizes) const;
-
-  // Sets the sizes that the thumbnail database knows that the favicon at
-  // |icon_id| is available from the web. See history_types.h for a more
-  // detailed description of FaviconSizes.
-  // Deletes any favicon bitmaps currently mapped to |icon_id| whose pixel
-  // sizes are not contained in |favicon_sizes|.
-  // |favicon_bitmaps_deleted| is set to true if at least one favicon bitmap
-  // is deleted.
-  void SetFaviconSizes(FaviconID icon_id,
-                       const FaviconSizes& favicon_sizes,
-                       bool* favicon_bitmaps_deleted);
+      const std::vector<FaviconBitmapData>& favicon_bitmap_data) const;
 
   // Returns true if the bitmap data at |bitmap_id| equals |new_bitmap_data|.
   bool IsFaviconBitmapDataEqual(
       FaviconBitmapID bitmap_id,
       const scoped_refptr<base::RefCountedMemory>& new_bitmap_data);
 
   // Returns true if there are favicons for |page_url| and one of the types in
   // |icon_types|.
   // |favicon_bitmap_results| is set to the favicon bitmaps which most closely
   // match |desired_size_in_dip| and |desired_scale_factors|. If
   // |desired_size_in_dip| is 0, the largest favicon bitmap with one of the icon
   // types in |icon_types| is returned. If |icon_types| contains multiple icon
   // types and there are several matched icon types in the database, results
   // will only be returned for a single icon type in the priority of
   // TOUCH_PRECOMPOSED_ICON, TOUCH_ICON, and FAVICON. See the comment for
   // GetFaviconResultsForBestMatch() for more details on how
   // |favicon_bitmap_results| is constructed.
-  // |icon_url_sizes| is set to a mapping of all the icon URLs which are mapped
-  // to |page_url| to the sizes of the favicon bitmaps available at each icon
-  // URL on the web.
   bool GetFaviconsFromDB(
       const GURL& page_url,
       int icon_types,
       const int desired_size_in_dip,
       const std::vector<ui::ScaleFactor>& desired_scale_factors,
-      std::vector<FaviconBitmapResult>* favicon_bitmap_results,
-      IconURLSizesMap* icon_url_sizes);
+      std::vector<FaviconBitmapResult>* favicon_bitmap_results);
 
   // Returns the favicon bitmaps which most closely match |desired_size_in_dip|
   // and |desired_scale_factors| in |favicon_bitmap_results|. If
   // |desired_size_in_dip| is 0, only the largest favicon bitmap is returned.
   // Goodness is computed via SelectFaviconBitmapIDs(). It is computed on a
   // per favicon id basis, thus all |favicon_bitmap_results| are guaranteed to
   // be for the same FaviconID. |favicon_bitmap_results| will have at most one
   // entry for each desired scale factor. There will be less entries if the same
   // favicon bitmap is the best result for multiple scale factors.
   // Returns true if there were no errors.
   bool GetFaviconBitmapResultsForBestMatch(
       const std::vector<FaviconID>& candidate_favicon_ids,
       int desired_size_in_dip,
       const std::vector<ui::ScaleFactor>& desired_scale_factors,
       std::vector<FaviconBitmapResult>* favicon_bitmap_results);
 
-  // Build mapping of the icon URLs for |favicon_ids| to the sizes of the
-  // favicon bitmaps available at each icon URL on the web. Favicon bitmaps
-  // might not be cached in the thumbnail database for any of the sizes in the
-  // returned map. See history_types.h for a more detailed description of
-  // IconURLSizesMap.
-  // Returns true if map was successfully built.
-  bool BuildIconURLSizesMap(const std::vector<FaviconID>& favicon_ids,
-                            IconURLSizesMap* icon_url_sizes);
-
   // Maps the favicon ids in |icon_ids| to |page_url| (and all redirects)
   // for |icon_type|.
   // Returns true if the mappings for the page or any of its redirects were
   // changed.
   bool SetFaviconMappingsForPageAndRedirects(
       const GURL& page_url,
       IconType icon_type,
       const std::vector<FaviconID>& icon_ids);
 
   // Maps the favicon ids in |icon_ids| to |page_url| for |icon_type|.
@@ skipping 139 matching lines @@
   // Used to provide the Android ContentProvider APIs.
   scoped_ptr<AndroidProviderBackend> android_provider_backend_;
 #endif
 
   DISALLOW_COPY_AND_ASSIGN(HistoryBackend);
 };
 
 }  // namespace history
 
 #endif  // CHROME_BROWSER_HISTORY_HISTORY_BACKEND_H_