<webview>: Implement declarativeWebRequest API

chrome/browser/extensions/api/declarative/rules_registry_service.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_EXTENSIONS_API_DECLARATIVE_RULES_REGISTRY_SERVICE_H__
 #define CHROME_BROWSER_EXTENSIONS_API_DECLARATIVE_RULES_REGISTRY_SERVICE_H__
 
 #include <map>
 #include <string>
 #include <vector>
@@ skipping 20 matching lines @@
 class RulesRegistryStorageDelegate;
 }
 
 namespace extensions {
 
 // This class owns all RulesRegistries implementations of an ExtensionService.
 // This class lives on the UI thread.
 class RulesRegistryService : public ProfileKeyedAPI,
                              public content::NotificationObserver {
  public:
+  typedef RulesRegistry::WebViewKey WebViewKey;
+  typedef std::pair<std::string, WebViewKey> RulesRegistryKey;

[Jeffrey Yasskin, 2013/11/09 02:47:22]

Similarly, this should at the very least have a comment about what the string
means, and probably be a struct with a named field.

[Fady Samuel, 2013/11/10 03:39:56]

Made it a struct. I agree, this is far more readable. Thanks!

+
   explicit RulesRegistryService(Profile* profile);
   virtual ~RulesRegistryService();
 
   // Unregisters refptrs to concrete RulesRegistries at other objects that were
   // created by us so that the RulesRegistries can be released.
   virtual void Shutdown() OVERRIDE;
 
   // ProfileKeyedAPI implementation.
   static ProfileKeyedAPIFactory<RulesRegistryService>* GetFactoryInstance();
 
   // Convenience method to get the RulesRegistryService for a profile.
   static RulesRegistryService* Get(Profile* profile);
 
   // Registers the default RulesRegistries used in Chromium.
-  void RegisterDefaultRulesRegistries();
+  void RegisterDefaultRulesRegistriesIfNotAvailable(

[Jeffrey Yasskin, 2013/11/09 02:47:22]

If what aren't available? If this is a "do it the first time" thing, I'd name it
"EnsureDefaultRulesRegistriesRegistered" or just leave the original name and
comment that it's idempotent.

[Fady Samuel, 2013/11/10 03:39:56]

Done.

+      const WebViewKey& webview_key);
 
   // Registers a RulesRegistry and wraps it in an InitializingRulesRegistry.
   void RegisterRulesRegistry(scoped_refptr<RulesRegistry> rule_registry);
 
-  // Returns the RulesRegistry for |event_name| or NULL if no such registry
-  // has been registered.
+  // Returns the RulesRegistry for |event_name| and |webview_key| or NULL if no
+  // such registry has been registered. Default rules registries (such as the

[Jeffrey Yasskin, 2013/11/09 02:47:22]

Can this return NULL anymore, since it auto-registers the registries we know
about? If a NULL return is a programming error, DCHECK it.

[Fady Samuel, 2013/11/10 03:39:56]

Yes, it's possible for this to return NULL if there's some rules registry that
was registered that isn't the default.

+  // WebRequest rules registry) will be created on first access.
   scoped_refptr<RulesRegistry> GetRulesRegistry(
-      const std::string& event_name) const;
+      const WebViewKey& webview_key,
+      const std::string& event_name);
 
-  // Accessors for each type of rules registry.
+  // Accessors for each type of rules registry. This method will install default
+  // rules registries if they haven't been installed yet.

[Jeffrey Yasskin, 2013/11/09 02:47:22]

No it won't. :)

[Fady Samuel, 2013/11/10 03:39:56]

Doh. Stale comment. Removed!

   ContentRulesRegistry* content_rules_registry() const {
+    CHECK(content_rules_registry_);
     return content_rules_registry_;
   }
 
+  // Removes all rules registries of a given webview embedder process ID.
+  void RemoveWebViewRulesRegistries(int process_id);
+
   // For testing.
   void SimulateExtensionUnloaded(const std::string& extension_id);
  private:
   friend class ProfileKeyedAPIFactory<RulesRegistryService>;
 
-  // Maps event names to RuleRegistries that handle these events.
-  typedef std::map<std::string, scoped_refptr<RulesRegistry> >
+  // Maps <event name, webview key> to RuleRegistries that handle these
+  // events.
+  typedef std::map<RulesRegistryKey, scoped_refptr<RulesRegistry> >
       RulesRegistryMap;
 
+  typedef std::set<WebViewKey> WebViewKeySet;

[Jeffrey Yasskin, 2013/11/09 02:47:22]

FWIW, I'm not a fan of typedefs that save 7 characters since they make readers
look up the definition to be sure it's as expected.

[Fady Samuel, 2013/11/10 03:39:56]

Removed.

+  typedef std::set<RulesRegistryKey> RulesRegistryKeySet;

[Jeffrey Yasskin, 2013/11/09 02:47:22]

This doesn't look used.

[Fady Samuel, 2013/11/10 03:39:56]

Removed.

+
   // Notifies all RulesRegistries that |extension_id| was unloaded.
   // It is not guaranteed that this notification is processed synchronously.
   // If extensions live on another thread, the notification is posted.
   void OnExtensionUnloaded(const std::string& extension_id);
 
+  // Removes a rules registry associated with a given |key|.
+  void RemoveRulesRegistry(const RulesRegistryKey& key);
+
   // Implementation of content::NotificationObserver.
   virtual void Observe(int type,
                        const content::NotificationSource& source,
                        const content::NotificationDetails& details) OVERRIDE;
 
   // ProfileKeyedAPI implementation.
   static const char* service_name() {
     return "RulesRegistryService";
   }
   static const bool kServiceHasOwnInstanceInIncognito = true;
   static const bool kServiceIsNULLWhileTesting = true;
 
   RulesRegistryMap rule_registries_;
 
+  // Indicates the set of <webview>s that have default rule registries
+  // installed.
+  WebViewKeySet installed_rules_registries_;
+
   // We own the parts of the registries which need to run on the UI thread.
   ScopedVector<RulesCacheDelegate> cache_delegates_;
 
   // Weak pointer into rule_registries_ to make it easier to handle content rule
   // conditions.
   ContentRulesRegistry* content_rules_registry_;
 
   content::NotificationRegistrar registrar_;
 
   Profile* profile_;
 
   DISALLOW_COPY_AND_ASSIGN(RulesRegistryService);
 };
 
 }  // namespace extensions
 
 #endif  // CHROME_BROWSER_EXTENSIONS_API_DECLARATIVE_RULES_REGISTRY_SERVICE_H__