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/prefs/pref_change_registrar.h"
+#include "chrome/browser/profiles/profile_keyed_service.h"
+#include "chrome/common/content_settings.h"
+#include "content/common/notification_observer.h"
+
+class ContentSettingsPattern;
+class GURL;
+class HostContentSettingsMap;
+
+// A frontend to the cookie-specific settings of HostContentSettingsMap. Handles
+// cookie-specific logic such as blocking third-party cookies.
+class CookieSettings
+    : public NotificationObserver,
+      public ProfileKeyedService {
+ public:
+  CookieSettings(
+      HostContentSettingsMap* host_content_settings_map,
+      PrefService* prefs,
+      bool incognito);
+
+  // 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 GetDefaultSetting() 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;
+
+  // 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 SetDefaultSetting(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);
+
+  // This setting trumps any host-specific settings.
+  //
+  // These may be called on any thread.
+  bool BlockThirdPartyCookies() const { return block_third_party_cookies_; }

[Bernhard Bauer, 2011/09/01 11:41:54]

Nit: We could call this method |ShouldBlockThirdPartyCookies| or something, to
make it not appear as an action.

[marja, 2011/09/01 13:34:48]

I renamed this, and left SetBlockThirdPartyCookies as is, since
BlockThirdPartyCookies(false) didn't make much sense.

+
+  // Sets whether we block all third-party cookies. This method must not be
+  // invoked on an incognito map.
+  //
+  // This should only be called on the UI thread.
+  void SetBlockThirdPartyCookies(bool block);
+
+  // NotificationObserver implementation.
+  virtual void Observe(int type,
+                       const NotificationSource& source,
+                       const NotificationDetails& details);
+
+  // 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 Shutdown();

[Bernhard Bauer, 2011/09/01 11:41:54]

This is a ProfileKeyedService method, right? In that case you should add a
comment, and mark it as virtual.

[marja, 2011/09/01 13:34:48]

It was, but is not any more. I changed it back to ShutDownOnUIThread. The
Shutdown in CookieSettingsWrapper is now marked as virtual and OVERRIDE.

+
+ private:
+  // 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;
+
+  // Weak pointer to the data backend (which also owns this object).

[Bernhard Bauer, 2011/09/01 11:41:54]

HostContentSettingsMap doesn't own this object anymore, so can you update the
comment? And maybe keep a scoped_refptr to it?

[marja, 2011/09/01 13:34:48]

Done.

+  HostContentSettingsMap* host_content_settings_map_;
+
+  // Weak; owned by the profile.
+  PrefService* prefs_;
+  PrefChangeRegistrar pref_change_registrar_;
+
+  bool is_off_the_record_;
+
+  // Used around accesses to the following objects to guarantee thread safety.
+  mutable base::Lock lock_;
+
+  bool block_third_party_cookies_;
+};
+
+#endif  // CHROME_BROWSER_CONTENT_SETTINGS_COOKIE_SETTINGS_H_