Declarative Web Request: firstPartyForCookiesUrl

chrome/browser/extensions/api/declarative_webrequest/webrequest_rules_registry.cc

 // 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.
 
 #include "chrome/browser/extensions/api/declarative_webrequest/webrequest_rules_registry.h"
 
 #include <algorithm>
 #include <limits>
 #include <utility>
 
@@ skipping 19 matching lines @@
     extension_info_map_ = ExtensionSystem::Get(profile)->info_map();
 }
 
 std::set<const WebRequestRule*>
 WebRequestRulesRegistry::GetMatches(
     const DeclarativeWebRequestData& request_data) {
   typedef std::set<const WebRequestRule*> RuleSet;
   typedef std::set<URLMatcherConditionSet::ID> URLMatches;
 
   RuleSet result;
+
   URLMatches url_matches = url_matcher_.MatchURL(request_data.request->url());
+  URLMatches first_party = first_party_url_matcher_.MatchURL(
+      request_data.request->first_party_for_cookies());
+  url_matches.insert(first_party.begin(), first_party.end());

[vabr (Chromium), 2013/01/21 10:57:48]

This means that we first check all conditions triggered through a matching 'url'
attribute, then all conditions triggered through a matching
'firstPartyForCookiesUrl' attribute. For conditions which have both, but also
some non-URL attribute which is not satisfied, this means those are being
checked twice.

Is this a bearable performance burden, or should I try to implement some result
caching Condition::IsFulfilled? Note that the cache would need to check that
request_data did not change, which might be comparably expensive to checking one
or a couple of non-URL attributes.

[battre, 2013/01/21 17:32:08]

I think we are good here with the current approach.

 
   // 1st phase -- add all rules with some conditions without UrlFilter
   // attributes.
   for (RuleSet::const_iterator it = rules_with_untriggered_conditions_.begin();
        it != rules_with_untriggered_conditions_.end(); ++it) {
     if ((*it)->conditions().IsFulfilled(-1, url_matches, request_data))
       result.insert(*it);
   }
 
   // 2nd phase -- add all rules with some conditions triggered by URL matches.
@@ skipping 78 matching lines @@
 
 std::string WebRequestRulesRegistry::AddRulesImpl(
     const std::string& extension_id,
     const std::vector<linked_ptr<RulesRegistry::Rule> >& rules) {
   base::Time extension_installation_time =
       GetExtensionInstallationTime(extension_id);
 
   std::string error;
   RulesMap new_webrequest_rules;
 
+  std::vector<URLMatcherConditionFactory*> factories;
+  factories.push_back(url_matcher_.condition_factory());
+  factories.push_back(first_party_url_matcher_.condition_factory());
+
   for (std::vector<linked_ptr<RulesRegistry::Rule> >::const_iterator rule =
        rules.begin(); rule != rules.end(); ++rule) {
     WebRequestRule::GlobalRuleId rule_id(extension_id, *(*rule)->id);
     DCHECK(webrequest_rules_.find(rule_id) == webrequest_rules_.end());
 
     scoped_ptr<WebRequestRule> webrequest_rule(
-        WebRequestRule::Create(url_matcher_.condition_factory(), extension_id,
-                               extension_installation_time, *rule,
-                               &CheckConsistency, &error));
+        WebRequestRule::Create(factories,
+                               extension_id, extension_installation_time,
+                               *rule, &CheckConsistency, &error));
     if (!error.empty()) {
       // We don't return here, because we want to clear temporary
-      // condition sets in the url_matcher_.
+      // condition sets in |url_matcher_| and |first_party_url_matcher_|.
       break;
     }
 
     new_webrequest_rules[rule_id] = make_linked_ptr(webrequest_rule.release());
   }
 
   if (!error.empty()) {
     // Clean up temporary condition sets created during rule creation.
     url_matcher_.ClearUnusedConditionSets();
+    first_party_url_matcher_.ClearUnusedConditionSets();
     return error;
   }
 
   // Wohoo, everything worked fine.
   webrequest_rules_.insert(new_webrequest_rules.begin(),
                            new_webrequest_rules.end());
 
   // Create the triggers.
   for (RulesMap::iterator i = new_webrequest_rules.begin();
        i != new_webrequest_rules.end(); ++i) {
     URLMatcherConditionSet::Vector url_condition_sets;
     const WebRequestConditionSet& conditions = i->second->conditions();
-    conditions.GetURLMatcherConditionSets(&url_condition_sets);
+    conditions.GetURLMatcherConditionSets(&url_condition_sets, 0);
+    conditions.GetURLMatcherConditionSets(&url_condition_sets, 1);
     for (URLMatcherConditionSet::Vector::iterator j =
          url_condition_sets.begin(); j != url_condition_sets.end(); ++j) {
       rule_triggers_[(*j)->id()] = i->second.get();
     }
   }
 
-  // Register url patterns in |url_matcher_| and
+  // Register url patterns with both URL matchers and
   // |rules_with_untriggered_conditions_|.
   URLMatcherConditionSet::Vector all_new_condition_sets;
+  URLMatcherConditionSet::Vector all_new_condition_sets_first_party;
   for (RulesMap::iterator i = new_webrequest_rules.begin();
        i != new_webrequest_rules.end(); ++i) {
-    i->second->conditions().GetURLMatcherConditionSets(&all_new_condition_sets);
+    i->second->conditions().GetURLMatcherConditionSets(
+        &all_new_condition_sets, 0);
+    i->second->conditions().GetURLMatcherConditionSets(
+        &all_new_condition_sets_first_party, 1);
     if (i->second->conditions().HasConditionsWithoutUrls())
       rules_with_untriggered_conditions_.insert(i->second.get());
   }
   url_matcher_.AddConditionSets(all_new_condition_sets);
+  first_party_url_matcher_.AddConditionSets(all_new_condition_sets_first_party);
 
   ClearCacheOnNavigation();
 
   return "";
 }
 
 std::string WebRequestRulesRegistry::RemoveRulesImpl(
     const std::string& extension_id,
     const std::vector<std::string>& rule_identifiers) {
-  // URLMatcherConditionSet IDs that can be removed from URLMatcher.
+  // URLMatcherConditionSet IDs that can be removed from URL matchers.
   std::vector<URLMatcherConditionSet::ID> remove_from_url_matcher;
+  std::vector<URLMatcherConditionSet::ID> remove_from_first_party_url_matcher;
 
   for (std::vector<std::string>::const_iterator i = rule_identifiers.begin();
        i != rule_identifiers.end(); ++i) {
     WebRequestRule::GlobalRuleId rule_id(extension_id, *i);
 
     // Skip unknown rules.
     RulesMap::iterator webrequest_rules_entry = webrequest_rules_.find(rule_id);
     if (webrequest_rules_entry == webrequest_rules_.end())
       continue;
 
     // Remove all triggers but collect their IDs.
     URLMatcherConditionSet::Vector condition_sets;
+    URLMatcherConditionSet::Vector condition_sets_first_party;
     WebRequestRule* rule = webrequest_rules_entry->second.get();
-    rule->conditions().GetURLMatcherConditionSets(&condition_sets);
+    rule->conditions().GetURLMatcherConditionSets(&condition_sets, 0);
+    rule->conditions().GetURLMatcherConditionSets(
+        &condition_sets_first_party, 1);
     for (URLMatcherConditionSet::Vector::iterator j = condition_sets.begin();
          j != condition_sets.end(); ++j) {
       remove_from_url_matcher.push_back((*j)->id());
       rule_triggers_.erase((*j)->id());
     }
+    for (URLMatcherConditionSet::Vector::iterator j =
+             condition_sets_first_party.begin();
+         j != condition_sets_first_party.end(); ++j) {
+      remove_from_first_party_url_matcher.push_back((*j)->id());
+      rule_triggers_.erase((*j)->id());
+    }
 
     rules_with_untriggered_conditions_.erase(rule);
 
     // Removes the owning references to (and thus deletes) the rule.
     webrequest_rules_.erase(webrequest_rules_entry);
   }
 
-  // Clear URLMatcher based on condition_set_ids that are not needed any more.
+  // Clear URL matchers based on condition_set_ids that are not needed any more.
   url_matcher_.RemoveConditionSets(remove_from_url_matcher);
+  first_party_url_matcher_.RemoveConditionSets(
+      remove_from_first_party_url_matcher);
 
   ClearCacheOnNavigation();
 
   return "";
 }
 
 std::string WebRequestRulesRegistry::RemoveAllRulesImpl(
     const std::string& extension_id) {
   // Search all identifiers of rules that belong to extension |extension_id|.
   std::vector<std::string> rule_identifiers;
   for (RulesMap::iterator i = webrequest_rules_.begin();
        i != webrequest_rules_.end(); ++i) {
     const WebRequestRule::GlobalRuleId& global_rule_id = i->first;
     if (global_rule_id.first == extension_id)
       rule_identifiers.push_back(global_rule_id.second);
   }
 
   // No need to call ClearCacheOnNavigation() here because RemoveRulesImpl
   // takes care of that.
   return RemoveRulesImpl(extension_id, rule_identifiers);
 }
 
 content::BrowserThread::ID WebRequestRulesRegistry::GetOwnerThread() const {
   return content::BrowserThread::IO;
 }
 
 bool WebRequestRulesRegistry::IsEmpty() const {
   return rule_triggers_.empty() && webrequest_rules_.empty() &&
-      url_matcher_.IsEmpty();
+      url_matcher_.IsEmpty() && first_party_url_matcher_.IsEmpty();
 }
 
 WebRequestRulesRegistry::~WebRequestRulesRegistry() {}
 
 base::Time WebRequestRulesRegistry::GetExtensionInstallationTime(
     const std::string& extension_id) const {
   if (!extension_info_map_.get())  // May be NULL during testing.
     return base::Time();
 
   return extension_info_map_->GetInstallTime(extension_id);
@@ skipping 27 matching lines @@
     }
     if (!found_matching_condition) {
       *error = kActionCannotBeExecuted;
       return false;
     }
   }
   return true;
 }
 
 }  // namespace extensions