Adds GeolocationContentSettingsMap.

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> EmbedderSettings;
+  typedef std::map<GURL, EmbedderSettings> RequestingOriginSettings;
+
+  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_origin| when embedded in a page of |embedder|.
+  // Note: if |requesting_origin| is a top-level page, it's the same as

[Peter Kasting, 2010/03/18 20:59:20]

Nit: Better wording might be:
"Note: 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."

+  // |embedder|.
+  //
+  // This may be called on any thread.
+  ContentSetting GetContentSetting(const GURL& embedder,

[Peter Kasting, 2010/03/18 20:59:20]

Nit: I think it would make sense to swap these arguments.

+                                   const GURL& requesting_origin) const;
+
+  // Returns all origins with a non-default setting, mapped to their embedder
+  // settings.
+  //
+  // This may be called on any thread.
+  const RequestingOriginSettings& requesting_origin_settings() const;

[Peter Kasting, 2010/03/18 20:59:20]

I'm a bit uncomfortable with returning a const ref here.  It means that if
someone changes a setting, the caller's object will change, without any explicit
notification.

Furthermore, if you call this on a non-UI thread, then you have thread safety
problems, because the caller can now look into our state without holding a lock.

Because we don't need to worry about speed of execution on this function, I
think the old signature, while more clunky, was better.

[Peter Kasting, 2010/03/18 21:53:30]

Actually, since we have to perform a deep copy anyway... I'm just going to
return by value.  Simple and correct.

+
+  // Sets the default setting.
+  //
+  // This should only be called on the UI thread.
+  void SetDefaultContentSetting(ContentSetting setting);
+
+  // Sets the content setting for a particular |embedder| and
+  // |requesting_origin|.
+  // Setting the value to CONTENT_SETTING_DEFAULT causes the default setting
+  // to be used when loading pages from this |embedder| and |requesting_origin|.
+  // An empty |embedder| is considered a wildcard for any embedder, that is,

[Peter Kasting, 2010/03/18 20:59:20]

Nit: "any embedder except the origin itself"

+  // it will be used by GetContentSetting() when there's no specific setting for
+  // |requesting_origin| and |embedder|.

[Peter Kasting, 2010/03/18 20:59:20]

Nit: "when |embedder| != |requesting_origin| and there's no specific setting for
(|requesting_origin, |embedder|)."

+  // |requesting_origin| must be is_valid().

[Peter Kasting, 2010/03/18 20:59:20]

Nit: "must be a valid GURL."

+  //
+  //
+  // This should only be called on the UI thread.
+  void SetContentSetting(const GURL& embedder,

[Peter Kasting, 2010/03/18 20:59:20]

Nit: As above, I'd reverse these first two args.

+                         const GURL& requesting_origin,
+                         ContentSetting setting);
+
+  // Resets all settings levels.
+  //
+  // This should only be called on the UI thread.
+  void ResetToDefault();
+
+ private:
+  friend class base::RefCountedThreadSafe<GeolocationContentSettingsMap>;
+
+  // The name to use with dictionary prefs.
+  static const wchar_t* kTypeName;
+
+  // The default setting.
+  static const ContentSetting kDefaultSetting;
+
+  ~GeolocationContentSettingsMap();
+
+  // Sets the fields of |embedder_settings| based on the values in |dictionary|.
+  static void GetEmbedderSettingsFromDictionary(
+      const DictionaryValue* dictionary, EmbedderSettings* embedder_settings);
+
+  static ContentSetting ConvertToContentSetting(int content_setting);

[Peter Kasting, 2010/03/18 20:59:20]

If we want this, it should live in content_settings.h.

+
+  // 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_;
+  RequestingOriginSettings requesting_origin_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_