Add a source to the result of PermissionContextBase::GetPermissionStatus

chrome/browser/permissions/permission_context_base.h

 // Copyright 2014 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_PERMISSIONS_PERMISSION_CONTEXT_BASE_H_
 #define CHROME_BROWSER_PERMISSIONS_PERMISSION_CONTEXT_BASE_H_
 
 #include <memory>
 #include <unordered_map>
 
@@ skipping 12 matching lines @@
 class GURL;
 class PermissionRequestID;
 class Profile;
 
 namespace content {
 class WebContents;
 }
 
 using BrowserPermissionCallback = base::Callback<void(ContentSetting)>;
 
+// Identifies the source or reason for a permission status being returned.
+enum class PermissionStatusSource {

[kcarattini, 2017/02/07 22:53:33]

Should we have a USER_DECISION value as well?

[raymes, 2017/02/08 04:08:40]

Yes eventually. I didn't want to add it right now because it will be unused and
it will take care to add it in a correct way. I only want to add ones that will
get used right now so we don't have dead code. In fact for that reason I'm going
to remove the INSECURE_ORIGIN and KILL_SWITCH check for now. I'll add
KILL_SWITCH back and use it for media_permission.cc in a followup CL. The other
two should be directly used by Meredith.

That makes this CL look a little bit weird, because the reasons aren't currently
used anywhere. So if it makes more sense, Meredith could merge this into her CL
which will use it. WDYT?

+  // The status is the result of being blocked because the requesting origin is
+  // not https.
+  INSECURE_ORIGIN,
+
+  // The status is the result of being blocked by the permissions kill switch.
+  KILL_SWITCH,
+
+  // The status is the result of being blocked due to the user dismissing a
+  // permission prompt multiple times.
+  MULTIPLE_DISMISSALS,
+
+  // The status is the resultof being blocked because the permission is on the
+  // safe browsing blacklist.
+  SAFE_BROWSING_BLACKLIST,
+
+  // The reason for the status is not specified. Avoid returning this value. It
+  // only exists until code has been added to correctly return a source in all
+  // cases.
+  UNSPECIFIED
+};
+
+struct PermissionResult {
+  PermissionResult(ContentSetting content_setting,
+                   PermissionStatusSource source);
+  ~PermissionResult();
+
+  ContentSetting content_setting;
+  PermissionStatusSource source;
+};
+
 // This base class contains common operations for granting permissions.
 // It offers the following functionality:
 //   - Creates a permission request when needed.
 //   - If accepted/denied the permission is saved in content settings for
 //     future uses (for the domain that requested it).
 //   - If dismissed the permission is not saved but it's considered denied for
 //     this one request
 //   - In any case the BrowserPermissionCallback is executed once a decision
 //     about the permission is made by the user.
 // The bare minimum you need to create a new permission request is
@@ skipping 33 matching lines @@
   // should be called with the result.
   virtual void RequestPermission(content::WebContents* web_contents,
                                  const PermissionRequestID& id,
                                  const GURL& requesting_frame,
                                  bool user_gesture,
                                  const BrowserPermissionCallback& callback);
 
   // Returns whether the permission has been granted, denied etc.
   // TODO(meredithl): Ensure that the result accurately reflects whether the
   // origin is blacklisted for this permission.
-  ContentSetting GetPermissionStatus(const GURL& requesting_origin,
-                                     const GURL& embedding_origin) const;
+  PermissionResult GetPermissionStatus(const GURL& requesting_origin,
+                                       const GURL& embedding_origin) const;
 
   // Resets the permission to its default value.
   virtual void ResetPermission(const GURL& requesting_origin,
                                const GURL& embedding_origin);
 
   // Withdraw an existing permission request, no op if the permission request
   // was already cancelled by some other means.
   virtual void CancelPermissionRequest(content::WebContents* web_contents,
                                        const PermissionRequestID& id);
 
@@ skipping 87 matching lines @@
 #endif
   std::unordered_map<std::string, std::unique_ptr<PermissionRequest>>
       pending_requests_;
 
   // Must be the last member, to ensure that it will be
   // destroyed first, which will invalidate weak pointers
   base::WeakPtrFactory<PermissionContextBase> weak_factory_;
 };
 
 #endif  // CHROME_BROWSER_PERMISSIONS_PERMISSION_CONTEXT_BASE_H_