Support manual (white|black)list, previewing and allowing after interstitial

chrome/browser/managed_mode/managed_mode.h

 // Copyright (c) 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_MANAGED_MODE_MANAGED_MODE_H_
 #define CHROME_BROWSER_MANAGED_MODE_MANAGED_MODE_H_
 
 #include <set>
 #include <string>
 #include <vector>
 
 #include "base/callback.h"
 #include "base/compiler_specific.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/memory/singleton.h"
 #include "chrome/browser/extensions/management_policy.h"
 #include "chrome/browser/ui/browser_list_observer.h"
 #include "content/public/browser/notification_observer.h"
 #include "content/public/browser/notification_registrar.h"
 
 class Browser;
 template<typename T>
 struct DefaultSingletonTraits;
 class ManagedModeSiteList;
 class ManagedModeURLFilter;
 class PrefChangeRegistrar;
 class PrefService;
 class Profile;
+
 namespace policy{
 class URLBlacklist;
 }
 
 // Managed mode allows one person to manage the Chrome experience for another
 // person by pre-configuring and then locking a managed User profile.
 // The ManagedMode class provides methods to check whether the browser is in
 // managed mode, and to attempt to enter or leave managed mode.
 // Except where otherwise noted, this class should be used on the UI thread.
 class ManagedMode : public chrome::BrowserListObserver,
@@ skipping 24 matching lines @@
   // classifying sites in the history view.
   // This method should only be called on the UI thread.
   static const ManagedModeURLFilter* GetURLFilterForUIThread();
 
   // Returns the URL's category.
   static int GetCategory(const GURL& url);
 
   // Called in the critical path of drawing the history UI, so needs to be fast.
   static void GetCategoryNames(CategoryList* list);
 
-  // Returns the profile whitelist.
-  static scoped_ptr<base::ListValue> GetWhitelist();
+  // Checks if the url pattern is in the manual whitelist.
+  static bool IsInManualWhitelist(const std::string& url_pattern);
 
-  // Sets the profile whitelist to |whitelist|.
-  static void SetWhitelist(base::ListValue* whitelist);
+  // Appends |whitelist| to the manual whitelist (both in URL filter and in
+  // preferences).

[Pam (message me for reviews), 2012/12/06 15:11:56]

Please describe what |whitelist| is (presumably, a list of URL patterns).

Also, the separation between the whitelist in the prefs and the whitelist in the
URL filter (which is really just a parsed/cached copy of the one in the prefs)
is pretty hard to follow. I'd suggest requiring that the two are always in sync
(that is, not having public AddURLPatternToManual*List methods that only do one
part). Am I missing a use case for that?

[Sergiu, 2013/01/04 15:44:07]

Added a paragraph describing whitelists and url_patterns and made
AddURLPatternToManualList a private function.

+  static void AddToManualWhitelist(const base::ListValue& whitelist);
 
-  // Adds the |url| to the manual lists.
-  static void AddStringToManualWhitelist(const std::string& url);
-  static void AddStringToManualBlacklist(const std::string& url);
+  // Adds the |url_pattern| to the manual lists in the URL filter.
+  static void AddURLPatternToManualWhitelist(const std::string& url_pattern);
+  static void AddURLPatternToManualBlacklist(const std::string& url_pattern);
 
   // Returns the profile blacklist.
   static scoped_ptr<base::ListValue> GetBlacklist();
 
   // ExtensionManagementPolicy::Provider implementation:
   virtual std::string GetDebugPolicyProviderName() const OVERRIDE;
   virtual bool UserMayLoad(const extensions::Extension* extension,
                            string16* error) const OVERRIDE;
   virtual bool UserMayModifySettings(const extensions::Extension* extension,
                                      string16* error) const OVERRIDE;
@@ skipping 58 matching lines @@
 
   // Returns a list of all installed and enabled site lists in the current
   // managed profile.
   // This method should only be called if managed mode is active.
   ScopedVector<ManagedModeSiteList> GetActiveSiteLists();
 
   void OnFamilyPackOptionsChanged();
 
   void UpdateWhitelist();
 
+  // Returns a copy of the manual whitelist which is stored in each profile.

[Pam (message me for reviews), 2012/12/06 15:11:56]

Meaning the one from the prefs? Also, what format is the list in (again, I
suppose it's a list of std::string URL patterns)? If possible, define a type for
the list, so it's self-evident what to expect.

[Sergiu, 2013/01/04 15:44:07]

I've typedefed base::ListValue to URLPatternList, hopefully it is clearer now.

[Bernhard Bauer, 2013/01/07 12:34:19]

I'm sorry, but I disagree. When I see a base::ListValue type, I at least know
the class, just not the type of the list contents. With URLPatternList I have to
look up the definition of the type (and how do I know where it's defined?), and
you don't even gain anything in type safety. The comment is great, but I don't
think we should have the typedef.

+  scoped_ptr<base::ListValue> GetWhitelist();
+
+  void AddToManualWhitelistImpl(const base::ListValue& whitelist);
+
+  bool IsInManualWhitelistImpl(const std::string& url_pattern);
+
   content::NotificationRegistrar registrar_;
   scoped_ptr<PrefChangeRegistrar> pref_change_registrar_;
 
   scoped_ptr<URLFilterContext> io_url_filter_context_;
   scoped_ptr<URLFilterContext> ui_url_filter_context_;
 
   std::set<Browser*> browsers_to_close_;
   std::vector<EnterCallback> callbacks_;
 
   DISALLOW_COPY_AND_ASSIGN(ManagedMode);
 };
 
 #endif  // CHROME_BROWSER_MANAGED_MODE_MANAGED_MODE_H_