HostContentSettingsMap refactoring.

chrome/browser/content_settings/cookie_settings.h

+// Copyright (c) 2011 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 hostnames to cookie settings. Written on the UI thread and read on any
+// thread. One instance per profile.
+
+#ifndef CHROME_BROWSER_CONTENT_SETTINGS_COOKIE_SETTINGS_H_
+#define CHROME_BROWSER_CONTENT_SETTINGS_COOKIE_SETTINGS_H_
+#pragma once
+
+#include "base/memory/ref_counted.h"
+#include "base/synchronization/lock.h"
+#include "chrome/browser/content_settings/host_content_settings_map.h"
+#include "chrome/browser/prefs/pref_change_registrar.h"
+#include "chrome/common/content_settings.h"
+#include "content/common/notification_observer.h"
+
+class ContentSettingsPattern;
+class GURL;
+class Profile;
+
+// A frontend to the cookie-specific settings of HostContentSettingsMap. Handles
+// cookie-specific logic such as blocking third-party cookies.
+class CookieSettings
+    : public NotificationObserver,
+      public base::RefCountedThreadSafe<CookieSettings> {
+ public:
+  CookieSettings(
+      HostContentSettingsMap* host_content_settings_map,
+      PrefService* prefs);
+
+  virtual ~CookieSettings();
+
+  // Returns the CookieSettings associated with the profile.
+  //
+  // This should only be called on the UI thread.
+  static CookieSettings* GetForProfile(Profile* profile);
+
+  // Returns the default content setting (CONTENT_SETTING_ALLOW,
+  // CONTENT_SETTING_BLOCK, or CONTENT_SETTING_SESSION_ONLY) for cookies.
+  //
+  // This may be called on any thread.
+  ContentSetting GetDefaultCookieSetting() const;
+
+  // Returns true if the page identified by (url, first_party_url) is allowed to
+  // read cookies.
+  //
+  // This may be called on any thread.
+  bool IsReadingCookieAllowed(const GURL& url,
+                              const GURL& first_party_url) const;
+
+  // Returns true if the page identified by (url, first_party_url) is allowed to
+  // set a cookie (permanent or session only).
+  //
+  // This may be called on any thread.
+  bool IsSettingCookieAllowed(const GURL& url,
+                              const GURL& first_party_url) const;
+
+  // Returns true if the cookie set by a page identified by url should be
+  // session only. Querying this only makes sense if IsSettingCookieAllowed has
+  // returned true.
+  //
+  // This may be called on any thread.
+  bool IsCookieSessionOnly(const GURL& url) const;
+
+  // For returns all patterns with a non-default cookie setting, mapped to their
+  // actual settings, in lexicographical order. |settings| must be a non-NULL
+  // outparam. If this CookieSettings was created for the incognito profile, it
+  // will only return those settings differing from the main
+  // CookieSettings. Returns false if the cookie settings are in an inconsistent
+  // state between setting the two content setting types, true otherwise.
+  //
+  // This may be called on any thread.
+  void GetCookieSettings(
+      HostContentSettingsMap::SettingsForOneType* settings) const;
+
+  // Sets the default content setting (CONTENT_SETTING_ALLOW,
+  // CONTENT_SETTING_BLOCK, or CONTENT_SETTING_SESSION_ONLY) for cookies.
+  //
+  // This should only be called on the UI thread.
+  void SetDefaultCookieSetting(ContentSetting setting);
+
+  // Sets the cookie setting to CONTENT_SETTING_ALLOW, CONTENT_SETTING_BLOCK or
+  // CONTENT_SETTING_SESSION_ONLY for (url, first_party_url) pairs where url
+  // matches primary_pattern.
+  //
+  // This should only be called on the UI thread.
+  void SetCookieSetting(const ContentSettingsPattern& primary_pattern,
+                        ContentSetting setting);
+
+  // Resets the cookie setting for (url, first_party_url) pais where url matches
+  // primary_pattern.
+  //
+  // This should only be called on the UI thread.
+  void ResetCookieSetting(const ContentSettingsPattern& primary_pattern);
+
+  // NotificationObserver implementation.
+  virtual void Observe(int type,
+                       const NotificationSource& source,
+                       const NotificationDetails& details);

[Bernhard Bauer, 2011/09/14 16:01:36]

Could you add OVERRIDE here?

+
+  // Detaches the CookieSettings from all Profile-related objects like
+  // PrefService. This methods needs to be called before destroying the Profile.
+  // Afterwards, none of the methods above that should only be called on the UI
+  // thread should be called anymore.
+  void ShutdownOnUIThread();
+
+ private:
+  class Factory;
+
+  // A helper for retrieving data for CONTENT_TYPE_COOKIES and
+  // CONTENT_TYPE_COOKIES_SESSION_ONLY.
+  ContentSetting GetCookieContentSetting(const GURL& url,
+                                         const GURL& first_party_url,
+                                         ContentSettingsType content_type,
+                                         bool setting_cookie) const;
+
+  // This setting trumps any host-specific settings.
+  //
+  // This method may be called on any thread.
+  bool ShouldBlockThirdPartyCookies() const;
+
+  scoped_refptr<HostContentSettingsMap> host_content_settings_map_;
+  PrefChangeRegistrar pref_change_registrar_;
+
+  // Used around accesses to block_third_party_cookies_ to guarantee thread
+  // safety.
+  mutable base::Lock lock_;
+
+  bool block_third_party_cookies_;
+};
+
+#endif  // CHROME_BROWSER_CONTENT_SETTINGS_COOKIE_SETTINGS_H_