[Android] Persist ordering of NTP suggestions.

chrome/browser/android/most_visited_sites.h

 // Copyright 2013 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_ANDROID_MOST_VISITED_SITES_H_
 #define CHROME_BROWSER_ANDROID_MOST_VISITED_SITES_H_
 
 #include <jni.h>
 
 #include <string>
 #include <vector>
 
 #include "base/android/scoped_java_ref.h"
 #include "base/compiler_specific.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/memory/weak_ptr.h"
 #include "base/scoped_observer.h"
-#include "chrome/browser/profiles/profile.h"
 #include "components/history/core/browser/history_types.h"
 #include "components/history/core/browser/top_sites_observer.h"
 #include "components/suggestions/proto/suggestions.pb.h"
 #include "components/sync_driver/sync_service_observer.h"
 
 namespace suggestions {
 class SuggestionsService;
 }
 
+namespace user_prefs {
+class PrefRegistrySyncable;
+}
+
 class GURL;
 class PopularSites;
+class Profile;
 
 // Provides the list of most visited sites and their thumbnails to Java.
 class MostVisitedSites : public sync_driver::SyncServiceObserver,
                          public history::TopSitesObserver {
  public:
   explicit MostVisitedSites(Profile* profile);
   void Destroy(JNIEnv* env, jobject obj);
   void OnLoadingComplete(JNIEnv* env, jobject obj);
   void SetMostVisitedURLsObserver(JNIEnv* env,
                                   jobject obj,
                                   jobject j_observer,
                                   jint num_sites);
   void GetURLThumbnail(JNIEnv* env,
                        jobject obj,
                        jstring url,
                        jobject j_callback);
 
   void BlacklistUrl(JNIEnv* env, jobject obj, jstring j_url);
   void RecordOpenedMostVisitedItem(JNIEnv* env, jobject obj, jint index);
 
   // sync_driver::SyncServiceObserver implementation.
   void OnStateChanged() override;
 
   // Registers JNI methods.
   static bool Register(JNIEnv* env);
 
+  static void RegisterProfilePrefs(user_prefs::PrefRegistrySyncable* registry);
+
  private:
   friend class MostVisitedSitesTest;
 
   // The source of the Most Visited sites.
-  enum MostVisitedSource {
-    TOP_SITES,
-    SUGGESTIONS_SERVICE
+  enum MostVisitedSource { TOP_SITES, SUGGESTIONS_SERVICE, POPULAR };
+
+  struct Suggestion {
+    base::string16 title;
+    std::string url;
+    std::string host;

[Marc Treib, 2015/09/09 12:15:01]

I think it'd make sense to combine |url| and |host| into a single GURL.

[knn, 2015/09/09 13:54:31]

Yeah, I though GURL parses the host on fly, I stand corrected, will do.

+    MostVisitedSource source;
+    // Only valid for source == SUGGESTIONS_SERVICE (-1 otherwise).
+    int provider_index;
+
+    Suggestion(const base::string16& title,
+               const std::string& url,
+               MostVisitedSource source);
+    Suggestion(const base::string16& title,
+               const std::string& url,
+               const std::string& host,
+               MostVisitedSource source);
+    Suggestion(const base::string16& title,
+               const std::string& url,
+               MostVisitedSource source,
+               int provider_index);
+    ~Suggestion();
+
+    // Get the Histogram name associated with the source.
+    std::string GetSourceHistogramName() const;
+
+   private:
+    DISALLOW_COPY_AND_ASSIGN(Suggestion);
   };
 
   ~MostVisitedSites() override;
   void QueryMostVisitedURLs();
 
   // Initialize the query to Top Sites. Called if the SuggestionsService is not
   // enabled, or if it returns no data.
   void InitiateTopSitesQuery();
 
   // Callback for when data is available from TopSites.
   void OnMostVisitedURLsAvailable(
       const history::MostVisitedURLList& visited_list);
 
   // Callback for when data is available from the SuggestionsService.
   void OnSuggestionsProfileAvailable(
       const suggestions::SuggestionsProfile& suggestions_profile);
 
-  // Adds the suggestions from |popular_sites_| into |titles| and |urls|. This
-  // might reorder |titles| and |urls| to retain the absolute positions of the
-  // popular suggestions. Also updates |tile_sources_| accordingly.
-  void AddPopularSites(std::vector<base::string16>* titles,
-                       std::vector<std::string>* urls);
+  // Takes the personal suggestions and adds popular suggestions if necessary
+  // and reorders the suggestions based on the previously displayed order.
+  void AddPopularSites(ScopedVector<Suggestion>* suggestions);
 
   // Workhorse for AddPopularSites above. Implemented as a separate static
   // method for ease of testing.
-  static void AddPopularSitesImpl(
-      int num_sites,
-      const std::vector<base::string16>& popular_titles,
-      const std::vector<std::string>& popular_urls,
-      std::vector<base::string16>* titles,
-      std::vector<std::string>* urls,
-      std::vector<std::string>* tile_sources);
+  static ScopedVector<Suggestion> MergeSuggestions(
+      ScopedVector<Suggestion>* personal_suggestions,
+      ScopedVector<Suggestion>* popular_suggestions,
+      const std::vector<std::string>& old_sites_url,
+      const std::vector<bool>& old_sites_is_personal);
+
+  void GetPreviousNTPSites(size_t num_tiles,
+                           std::vector<std::string>* old_sites_url,
+                           std::vector<bool>* old_sites_source);

[Marc Treib, 2015/09/09 12:15:01]

nit: const

[knn, 2015/09/09 13:54:31]

Done.

[Marc Treib, 2015/09/09 14:00:47]

I meant the method itself should be const. Making the pointers const doesn't
actually do anything :)

+
+  void SaveCurrentNTPSites();
+
+  // Takes suggestions from |src_suggestions| and moves them to
+  // |dst_suggestions| if the suggestion's url/host matches
+  // |match_urls|/|match_hosts| respectively. Unmatched suggestion indices from
+  // |src_suggestions| are returned for ease of insertion later.
+  static std::vector<size_t> InsertMatchingSuggestions(

[Marc Treib, 2015/09/09 12:15:01]

nit: I think you could move this and also InsertAllSuggestions out of the class,
into a namespace in the .cc file.

[knn, 2015/09/09 13:54:31]

Except Suggestions can't be private anymore which is why I moved it here.

[Marc Treib, 2015/09/09 14:00:47]

Ah, right, missed that, sorry.

+      ScopedVector<MostVisitedSites::Suggestion>* src_suggestions,

[Marc Treib, 2015/09/09 14:00:47]

nit: "MostVisitedSites::" is not necessary anymore then; also below.

+      ScopedVector<MostVisitedSites::Suggestion>* dst_suggestions,
+      const std::vector<std::string>& match_urls,
+      const std::vector<std::string>& match_hosts);
+
+  // Inserts suggestions from |src_suggestions| at positions |insert_positions|
+  // into |dst_suggestions| where ever empty starting from |start_position|.
+  // Returns the last filled position so that future insertions can start from
+  // there.
+  static size_t InsertAllSuggestions(
+      size_t start_position,
+      const std::vector<size_t>& insert_positions,
+      ScopedVector<MostVisitedSites::Suggestion>* src_suggestions,
+      ScopedVector<MostVisitedSites::Suggestion>* dst_suggestions);
 
   // Notify the Java side observer about the availability of Most Visited Urls.
-  void NotifyMostVisitedURLsObserver(const std::vector<base::string16>& titles,
-                                     const std::vector<std::string>& urls);
+  void NotifyMostVisitedURLsObserver();
 
   void OnPopularSitesAvailable(bool success);
 
   // Runs on the UI Thread.
   void OnLocalThumbnailFetched(
       const GURL& url,
       scoped_ptr<base::android::ScopedJavaGlobalRef<jobject>> j_callback,
       scoped_ptr<SkBitmap> bitmap);
 
   // Callback for when the thumbnail lookup is complete.
@@ skipping 39 matching lines @@
   // Counters for UMA metrics.
 
   // Number of tiles using a local thumbnail image for this NTP session.
   int num_local_thumbs_;
   // Number of tiles for which a server thumbnail is provided.
   int num_server_thumbs_;
   // Number of tiles for which no thumbnail is found/specified.
   // In this case a gray tile is used as the main tile.
   int num_empty_thumbs_;
 
-  // Identifier for where each tile came from (client, server, popular). Used
-  // for logging.
-  std::vector<std::string> tile_sources_;
-
   ScopedObserver<history::TopSites, history::TopSitesObserver> scoped_observer_;
 
   MostVisitedSource mv_source_;
 
   scoped_ptr<PopularSites> popular_sites_;
 
+  ScopedVector<Suggestion> current_suggestions_;
+
   // For callbacks may be run after destruction.
   base::WeakPtrFactory<MostVisitedSites> weak_ptr_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(MostVisitedSites);
 };
 
 #endif  // CHROME_BROWSER_ANDROID_MOST_VISITED_SITES_H_