Limit the amount the Location Settings Dialog will be shown to users.

chrome/browser/geolocation/geolocation_permission_context_android.h

 // Copyright 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_GEOLOCATION_GEOLOCATION_PERMISSION_CONTEXT_ANDROID_H_
 #define CHROME_BROWSER_GEOLOCATION_GEOLOCATION_PERMISSION_CONTEXT_ANDROID_H_
 
 // The flow for geolocation permissions on Android needs to take into account
 // the global geolocation settings so it differs from the desktop one. It
 // works as follows.
 // GeolocationPermissionContextAndroid::RequestPermission intercepts the flow
 // and proceeds to check the system location.
 // This will in fact check several possible settings
 //     - The global system geolocation setting
 //     - The Google location settings on pre KK devices
 //     - An old internal Chrome setting on pre-JB MR1 devices
 // With all that information it will decide if system location is enabled.
 // If enabled, it proceeds with the per site flow via
 // GeolocationPermissionContext (which will check per site permissions, create
 // infobars, etc.).
 //
 // Otherwise the permission is already decided.
 #include <memory>
 
 #include "base/macros.h"
 #include "base/memory/weak_ptr.h"
+#include "base/time/time.h"
 #include "chrome/browser/android/location_settings.h"
 #include "chrome/browser/geolocation/geolocation_permission_context.h"
 #include "components/location/android/location_settings_dialog_context.h"
 #include "components/location/android/location_settings_dialog_outcome.h"
 
 namespace content {
 class WebContents;
 }
 
 namespace infobars {
 class InfoBar;
 }
 
 class GURL;
 class PermissionRequestID;
+class PrefRegistrySimple;
 
 class GeolocationPermissionContextAndroid
     : public GeolocationPermissionContext {
  public:
+  static void RegisterProfilePrefs(PrefRegistrySimple* registry);
+
   explicit GeolocationPermissionContextAndroid(Profile* profile);
   ~GeolocationPermissionContextAndroid() override;
 
  protected:
   // GeolocationPermissionContext:
   ContentSetting GetPermissionStatusInternal(
       content::RenderFrameHost* render_frame_host,
       const GURL& requesting_origin,
       const GURL& embedding_origin) const override;
 
  private:
   friend class GeolocationPermissionContextTests;
 
+  static void AddDayOffsetForTesting(int days);
+  static void SetDSEOriginForTesting(const char* dse_origin);
+
   // GeolocationPermissionContext:
   void RequestPermission(
       content::WebContents* web_contents,
       const PermissionRequestID& id,
       const GURL& requesting_frame_origin,
       bool user_gesture,
       const BrowserPermissionCallback& callback) override;
   void CancelPermissionRequest(content::WebContents* web_contents,
                                const PermissionRequestID& id) override;
+  void UserMadePermissionDecision(const PermissionRequestID& id,
+                                  const GURL& requesting_origin,
+                                  const GURL& embedding_origin,
+                                  ContentSetting content_setting) override;
   void NotifyPermissionSet(const PermissionRequestID& id,
                            const GURL& requesting_origin,
                            const GURL& embedding_origin,
                            const BrowserPermissionCallback& callback,
                            bool persist,
                            ContentSetting content_setting) override;
   PermissionResult UpdatePermissionStatusWithDeviceStatus(
       PermissionResult result,
       const GURL& requesting_origin,
       const GURL& embedding_origin) const override;
 
+  // Functions to handle back off for showing the Location Settings Dialog.
+  std::string GetLocationSettingsBackOffLevelPref(
+      const GURL& requesting_origin) const;
+  std::string GetLocationSettingsNextShowPref(
+      const GURL& requesting_origin) const;
+  bool IsInLocationSettingsBackOff(const GURL& requesting_origin) const;
+  void ResetLocationSettingsBackOff(const GURL& requesting_origin);
+  void UpdateLocationSettingsBackOff(const GURL& requesting_origin);
+
+  // Returns whether location access is possible for the given origin. Ignores
+  // Location Settings Dialog backoff, as the backoff is ignored if the user
+  // will be prompted for permission.
   bool IsLocationAccessPossible(content::WebContents* web_contents,
                                 const GURL& requesting_origin,
                                 bool user_gesture);
 
-  LocationSettingsDialogContext GetLocationSettingsDialogContext(
-      const GURL& requesting_origin) const;
+  bool IsRequestingOriginDSE(const GURL& requesting_origin) const;
 
   void HandleUpdateAndroidPermissions(const PermissionRequestID& id,
                                       const GURL& requesting_frame_origin,
                                       const GURL& embedding_origin,
                                       const BrowserPermissionCallback& callback,
                                       bool permissions_updated);
 
   // Will return true if the location settings dialog will be shown for the
   // given origins. This is true if the location setting is off, the dialog can
   // be shown, any gesture requirements for the origin are met, and the dialog
   // is not being suppressed for backoff.
   bool CanShowLocationSettingsDialog(const GURL& requesting_origin,
-                                     bool user_gesture) const;
+                                     bool user_gesture,
+                                     bool ignore_backoff) const;
 
   void OnLocationSettingsDialogShown(
       const PermissionRequestID& id,
       const GURL& requesting_origin,
       const GURL& embedding_origin,
       const BrowserPermissionCallback& callback,
       bool persist,
       ContentSetting content_setting,
       LocationSettingsDialogOutcome prompt_outcome);
 
@@ skipping 15 matching lines @@
   infobars::InfoBar* permission_update_infobar_;
 
   // Must be the last member, to ensure that it will be destroyed first, which
   // will invalidate weak pointers.
   base::WeakPtrFactory<GeolocationPermissionContextAndroid> weak_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(GeolocationPermissionContextAndroid);
 };
 
 #endif  // CHROME_BROWSER_GEOLOCATION_GEOLOCATION_PERMISSION_CONTEXT_ANDROID_H_