Add GeolocationContentSettingsMap, a geolocation-specific variant of HostCont...

chrome/browser/geolocation/geolocation_content_settings_map.h

+// Copyright (c) 2010 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.
+
+// Maps [requesting_origin, embedder] to content settings.  Written on the UI
+// thread and read on any thread.  One instance per profile. This is based on
+// HostContentSettingsMap but differs significantly in two aspects:
+// - It maps [requesting_origin.GetOrigin(), embedder.GetOrigin()] => setting
+//   rather than host => setting.
+// - It manages only Geolocation.
+
+#ifndef CHROME_BROWSER_GEOLOCATION_GEOLOCATION_CONTENT_SETTINGS_MAP_H_
+#define CHROME_BROWSER_GEOLOCATION_GEOLOCATION_CONTENT_SETTINGS_MAP_H_
+
+#include <map>
+#include <string>
+#include <utility>
+#include <vector>
+
+#include "base/basictypes.h"
+#include "base/lock.h"
+#include "base/ref_counted.h"
+#include "chrome/common/content_settings.h"
+#include "googleurl/src/gurl.h"
+
+class DictionaryValue;
+class PrefService;
+class Profile;
+
+class GeolocationContentSettingsMap
+    : public base::RefCountedThreadSafe<GeolocationContentSettingsMap> {
+ public:
+
+  typedef std::map<GURL, ContentSetting> OneOriginSettings;
+  typedef std::map<GURL, OneOriginSettings> AllOriginsSettings;
+
+  explicit GeolocationContentSettingsMap(Profile* profile);
+
+  static void RegisterUserPrefs(PrefService* prefs);
+
+  // Returns the default setting.
+  //
+  // This may be called on any thread.
+  ContentSetting GetDefaultContentSetting() const;
+
+  // Returns a single ContentSetting which applies to the given |requesting_url|
+  // when embedded in a top-level page from |embedding_url|.  To determine the
+  // setting for a top-level page, as opposed to a frame embedded in a page,
+  // pass the page's URL for both arguments.
+  //
+  // This may be called on any thread.  Both arguments should be valid GURLs.
+  ContentSetting GetContentSetting(const GURL& requesting_url,
+                                   const GURL& embedding_url) const;
+
+  // Returns the settings for all origins with any non-default settings.
+  //
+  // This may be called on any thread.
+  AllOriginsSettings GetAllOriginsSettings() const;

[bulach, 2010/03/19 10:53:01]

hmm, I the relationship between "requesting_url" and "embedding_url" as used by
Get/SetContentSettings does not have a direct relationship to
"AllOriginsSettings==>OneOriginSettings" without inspecting the
implementation...

I don't feel strongly about it but would like to suggest two options:
1. expand the comments here to explain the cardinality, something like
[requesting_url:[embedding_url:content_setting]]

2. more drastic, use something like the previous names for the types
(RequestingSettings and EmbeddingSettings) and rename this to
GetAllRequestingSettings() ?

let me know if you agree with any of these, and I'll do this change.

+
+  // Sets the default setting.
+  //
+  // This should only be called on the UI thread.
+  void SetDefaultContentSetting(ContentSetting setting);
+
+  // Sets the content setting for a particular (requesting origin, embedding
+  // origin) pair.  If the embedding origin is the same as the requesting
+  // origin, this represents the setting used when the requesting origin is
+  // itself the top-level page.  If |embedder| is the empty GURL, |setting|
+  // becomes the default setting for the requesting origin when embedded on any
+  // page that does not have an explicit setting.  Passing
+  // CONTENT_SETTING_DEFAULT for |setting| effectively removes that setting and
+  // allows future requests to return the all-embedders or global defaults (as
+  // applicable).
+  //
+  // This should only be called on the UI thread.  |requesting_url| should be
+  // a valid GURL, and |embedding_url| should be valid or empty.
+  void SetContentSetting(const GURL& requesting_url,
+                         const GURL& embedding_url,
+                         ContentSetting setting);
+
+  // Clears all settings for |requesting_origin|.  Note: Unlike in the functions
+  // above, this is expected to be an origin, not some URL of which we'll take
+  // the origin; this is to prevent ambiguity where callers could think they're
+  // clearing something wider or narrower than they really are.
+  //
+  // This should only be called on the UI thread.  |requesting_origin| should be
+  // a valid GURL.
+  void ClearOneRequestingOrigin(const GURL& requesting_origin);
+
+  // Resets all settings.
+  //
+  // This should only be called on the UI thread.
+  void ResetToDefault();
+
+ private:
+  friend class base::RefCountedThreadSafe<GeolocationContentSettingsMap>;
+
+  // The default setting.
+  static const ContentSetting kDefaultSetting;
+
+  ~GeolocationContentSettingsMap();
+
+  // Sets the fields of |one_origin_settings| based on the values in
+  // |dictionary|.
+  static void GetOneOriginSettingsFromDictionary(
+      const DictionaryValue* dictionary,
+      OneOriginSettings* one_origin_settings);
+
+  // The profile we're associated with.
+  Profile* profile_;
+
+  // Copies of the pref data, so that we can read it on the IO thread.
+  ContentSetting default_content_setting_;
+  AllOriginsSettings content_settings_;
+
+  // Used around accesses to the settings objects to guarantee thread safety.
+  mutable Lock lock_;
+
+  DISALLOW_COPY_AND_ASSIGN(GeolocationContentSettingsMap);
+};
+
+#endif  // CHROME_BROWSER_GEOLOCATION_GEOLOCATION_CONTENT_SETTINGS_MAP_H_