Create DeclarativeConditionSet, DeclarativeActionSet, and DeclarativeRule templates

chrome/browser/extensions/api/declarative_webrequest/webrequest_rules_registry.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_WEBREQUEST_WEBREQUEST_RULES_REGISTRY_H_
 #define CHROME_BROWSER_EXTENSIONS_API_DECLARATIVE_WEBREQUEST_WEBREQUEST_RULES_REGISTRY_H_
 
 #include <list>
 #include <map>
 #include <set>
 #include <vector>
 
 #include "base/time.h"
 #include "base/memory/linked_ptr.h"
 #include "base/memory/ref_counted.h"
+#include "chrome/browser/extensions/api/declarative/declarative_rule.h"
 #include "chrome/browser/extensions/api/declarative/rules_registry_with_cache.h"
 #include "chrome/browser/extensions/api/declarative_webrequest/request_stage.h"
-#include "chrome/browser/extensions/api/declarative_webrequest/webrequest_rule.h"
+#include "chrome/browser/extensions/api/declarative_webrequest/webrequest_action.h"
+#include "chrome/browser/extensions/api/declarative_webrequest/webrequest_condition.h"
 #include "chrome/browser/extensions/extension_info_map.h"
 #include "chrome/common/extensions/matcher/url_matcher.h"
 
 class Profile;
 class WebRequestPermissions;
 
 namespace extension_web_request_api_helpers {
 struct EventResponseDelta;
 }
 
 namespace net {
 class URLRequest;
 }
 
 namespace extensions {
 
 class RulesRegistryService;
 
+typedef linked_ptr<extension_web_request_api_helpers::EventResponseDelta>
+    LinkedPtrEventResponseDelta;
+typedef DeclarativeRule<WebRequestCondition, WebRequestAction> WebRequestRule;
+
 // The WebRequestRulesRegistry is responsible for managing
 // the internal representation of rules for the Declarative Web Request API.
 //
 // Here is the high level overview of this functionality:
 //
 // RulesRegistry::Rule consists of Conditions and Actions, these are
 // represented as a WebRequestRule with WebRequestConditions and
 // WebRequestRuleActions.
 //
 // WebRequestConditions represent JSON dictionaries as the following:
@@ skipping 15 matching lines @@
 // will respond with the URLMatcherConditionSet::ID. We can map this
 // to the WebRequestRule and check whether also the other conditions (in this
 // example 'scheme': 'http') are fulfilled.
 class WebRequestRulesRegistry : public RulesRegistryWithCache {
  public:
   WebRequestRulesRegistry(Profile* profile, Delegate* delegate);
 
   // TODO(battre): This will become an implementation detail, because we need
   // a way to also execute the actions of the rules.
   std::set<WebRequestRule::GlobalRuleId> GetMatches(
-      const WebRequestRule::RequestData& request_data);
+      const DeclarativeWebRequestData& request_data);
 
   // Returns which modifications should be executed on the network request
   // according to the rules registered in this registry.
   std::list<LinkedPtrEventResponseDelta> CreateDeltas(
       const ExtensionInfoMap* extension_info_map,
-      const WebRequestRule::RequestData& request_data,
+      const DeclarativeWebRequestData& request_data,
       bool crosses_incognito);
 
   // Implementation of RulesRegistryWithCache:
   virtual std::string AddRulesImpl(
       const std::string& extension_id,
       const std::vector<linked_ptr<RulesRegistry::Rule> >& rules) OVERRIDE;
   virtual std::string RemoveRulesImpl(
       const std::string& extension_id,
       const std::vector<std::string>& rule_identifiers) OVERRIDE;
   virtual std::string RemoveAllRulesImpl(
       const std::string& extension_id) OVERRIDE;
   virtual content::BrowserThread::ID GetOwnerThread() const OVERRIDE;
 
   // Returns true if this object retains no allocated data. Only for debugging.
   bool IsEmpty() const;
 
  protected:
   virtual ~WebRequestRulesRegistry();
 
   // Virtual for testing:
   virtual base::Time GetExtensionInstallationTime(
       const std::string& extension_id) const;
   virtual void ClearCacheOnNavigation();
 
  private:
+  // Checks whether the set of |conditions| and |actions| are consistent,
+  // meaning for example that we do not allow combining an |action| that needs
+  // to be executed before the |condition| can be fulfilled.
+  // Returns true in case of consistency and MUST set |error| otherwise.
+  static bool CheckConsistency(WebRequestConditionSet* conditions,
+                               WebRequestActionSet* actions,
+                               std::string* error);
+
   typedef std::map<URLMatcherConditionSet::ID, WebRequestRule*> RuleTriggers;
   typedef std::map<WebRequestRule::GlobalRuleId, linked_ptr<WebRequestRule> >
       RulesMap;
 
   // Map that tells us which WebRequestRule may match under the condition that
   // the URLMatcherConditionSet::ID was returned by the |url_matcher_|.
   RuleTriggers rule_triggers_;
 
   RulesMap webrequest_rules_;
 
   URLMatcher url_matcher_;
 
   scoped_refptr<ExtensionInfoMap> extension_info_map_;
 };
 
 }  // namespace extensions
 
 #endif  // CHROME_BROWSER_EXTENSIONS_API_DECLARATIVE_WEBREQUEST_WEBREQUEST_RULES_REGISTRY_H_