Permission Action Reporting: Bundle report data.

chrome/browser/safe_browsing/permission_reporter.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_SAFE_BROWSING_PERMISSION_REPORTER_H_
 #define CHROME_BROWSER_SAFE_BROWSING_PERMISSION_REPORTER_H_
 
 #include <queue>
 #include <string>
 #include <unordered_map>
 
 #include "base/time/time.h"
-#include "chrome/browser/permissions/permission_request.h"
 #include "chrome/browser/permissions/permission_uma_util.h"
 #include "url/gurl.h"
 
 namespace base {
 class Clock;
 }  // namespace base
 
 namespace net {
 class ReportSender;
 class URLRequestContext;
@@ skipping 18 matching lines @@
 class PermissionReporter {
  public:
   // Creates a permission reporter that will send permission reports to
   // the SafeBrowsing permission action server, using |request_context| as the
   // context for the reports.
   explicit PermissionReporter(net::URLRequestContext* request_context);
 
   ~PermissionReporter();
 
   // Sends a serialized permission report to the report collection server.
-  // The permission report includes |origin| as the origin of
-  // the site requesting permission, |permission| as the type of permission
-  // requested, |action| as the action taken, and |gesture_type| as to whether
-  // the action occurred after a user gesture. It also includes
-  // |num_prior_dismissals| and |num_prior_ignores| the number of dismissals
-  // and ignores for this permission and origin that occurred prior to this
-  // report. The report will be serialized using protobuf defined in
+  // The permission report includes the origin of the site requesting the
+  // permission and other information about the permission action included in
+  // |report_info|. The report will be serialized using protobuf defined in
   // //src/chrome/common/safe_browsing/permission_report.proto
-  //
-  // TODO(kcarattini): Move these params to a PermissionReportInfo struct.
-  void SendReport(const GURL& origin,
-                  content::PermissionType permission,
-                  PermissionAction action,
-                  PermissionSourceUI source_ui,
-                  PermissionRequestGestureType gesture_type,
-                  int num_prior_dismissals,
-                  int num_prior_ignores);
+  void SendReport(const PermissionReportInfo& report_info);
 
  private:
   friend class PermissionReporterBrowserTest;
   friend class PermissionReporterTest;
 
   // Used by tests. This constructor allows tests to have access to the
   // ReportSender and use a test Clock.
   PermissionReporter(std::unique_ptr<net::ReportSender> report_sender,
                      std::unique_ptr<base::Clock> clock);
 
-  // Builds and serializes a permission report with |origin| as the origin of
-  // the site requesting permission, |permission| as the type of permission
-  // requested, and |action| as the action taken. The serialized report is
-  // written into |output|. Returns true if the serialization was successful and
-  // false otherwise.
-  static bool BuildReport(const GURL& origin,
-                          content::PermissionType permission,
-                          PermissionAction action,
-                          PermissionSourceUI source_ui,
-                          PermissionRequestGestureType gesture_type,
-                          int num_prior_dismissals,
-                          int num_prior_ignores,
+  // Builds and serializes a permission report with |report_info| included.
+  // The serialized report is written into |output|. Returns true if the
+  // serialization was successful and false otherwise.
+  static bool BuildReport(const PermissionReportInfo& report_info,
                           std::string* output);
 
   // Returns false if the number of reports sent in the last one minute per
   // origin per permission is under a threshold, otherwise true.
   bool IsReportThresholdExceeded(content::PermissionType permission,
                                  const GURL& origin);
 
   std::unique_ptr<net::ReportSender> permission_report_sender_;
 
   // TODO(stefanocs): This might introduce a memory issue since older entries
   // are not removed until a new report with the corresponding key is added. We
   // should address this issue if that becomes a problem in the future.
   std::unordered_map<PermissionAndOrigin,
                      std::queue<base::Time>,
                      PermissionAndOriginHash>
       report_logs_;
 
   std::unique_ptr<base::Clock> clock_;
 
   DISALLOW_COPY_AND_ASSIGN(PermissionReporter);
 };
 
 }  // namespace safe_browsing
 
 #endif  // CHROME_BROWSER_SAFE_BROWSING_PERMISSION_REPORTER_H_