Add SiteEngagementService::GetAllDetails(), to return detailed scores.

chrome/browser/engagement/site_engagement_score.h

 // Copyright 2016 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_ENGAGEMENT_SITE_ENGAGEMENT_SCORE_H_
 #define CHROME_BROWSER_ENGAGEMENT_SITE_ENGAGEMENT_SCORE_H_
 
 #include <array>
 #include <memory>
 
 #include "base/gtest_prod_util.h"
 #include "base/macros.h"
 #include "base/time/time.h"
 #include "base/values.h"
+#include "chrome/browser/engagement/site_engagement_details.mojom.h"
 #include "third_party/WebKit/public/platform/site_engagement.mojom.h"
 #include "url/gurl.h"
 
 namespace base {
 class Clock;
 }
 
 class HostContentSettingsMap;
 
 class SiteEngagementScore {
@@ skipping 105 matching lines @@
                       HostContentSettingsMap* settings);
   SiteEngagementScore(SiteEngagementScore&& other);
   ~SiteEngagementScore();
 
   SiteEngagementScore& operator=(SiteEngagementScore&& other);
 
   // Adds |points| to this score, respecting daily limits and the maximum
   // possible score. Decays the score if it has not been updated recently
   // enough.
   void AddPoints(double points);
-  double GetScore() const;
+
+  // Returns the total score, taking into account the base, bonus and maximum
+  // values.
+  double GetTotalScore() const;
+
+  // Returns a structure containing the origin URL and score, and details
+  // of the base and bonus scores. Note that the |score| is limited to
+  // kMaxPoints, while the detailed scores are returned raw.
+  mojom::SiteEngagementDetails GetDetails() const;
 
   // Writes the values in this score into |settings_map_|.
   void Commit();
 
   // Returns the discrete engagement level for this score.
   blink::mojom::EngagementLevel GetEngagementLevel() const;
 
   // Returns true if the maximum number of points today has been added.
   bool MaxPointsPerDayAdded() const;
 
   // Resets the score to |points| and resets the daily point limit. If
   // |updated_time| is non-null, sets the last engagement time to that value.
   void Reset(double points, const base::Time updated_time);
 
+  // Returns the raw, un-decayed score, without bonuses applied.
+  double raw_score() { return raw_score_; }
+
   // Get/set the last time this origin was launched from an installed shortcut.
   base::Time last_shortcut_launch_time() const {
     return last_shortcut_launch_time_;
   }
   void set_last_shortcut_launch_time(const base::Time& time) {
     last_shortcut_launch_time_ = time;
   }
 
   // Get/set the last time this origin recorded an engagement change.
   base::Time last_engagement_time() const {
@@ skipping 24 matching lines @@
   static const char* kLastShortcutLaunchTimeKey;
 
   // This version of the constructor is used in unit tests.
   SiteEngagementScore(base::Clock* clock,
                       const GURL& origin,
                       std::unique_ptr<base::DictionaryValue> score_dict);
 
   // Determine the score, accounting for any decay.
   double DecayedScore() const;
 
-  // Determine any score bonus from having installed shortcuts.
-  double BonusScore() const;
+  // Determine bonus from being installed, and having been launched recently..
+  double BonusIfShortcutLaunched() const;
+
+  // Determine bonus from having been granted notifications permission.
+  double BonusIfHasNotifications() const;
 
   // Updates the content settings dictionary |score_dict| with the current score
   // fields. Returns true if |score_dict| changed, otherwise return false.
   bool UpdateScoreDict(base::DictionaryValue* score_dict);
 
   // The clock used to vend times. Enables time travelling in tests. Owned by
   // the SiteEngagementService.
   base::Clock* clock_;
 
   // |raw_score_| is the score before any decay is applied.
@@ skipping 18 matching lines @@
   // The origin this score represents.
   GURL origin_;
 
   // The settings to write this score to when Commit() is called.
   HostContentSettingsMap* settings_map_;
 
   DISALLOW_COPY_AND_ASSIGN(SiteEngagementScore);
 };
 
 #endif  // CHROME_BROWSER_ENGAGEMENT_SITE_ENGAGEMENT_SCORE_H_