extensions/browser/api/declarative_net_request/request_params.h

// Copyright 2019 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef EXTENSIONS_BROWSER_API_DECLARATIVE_NET_REQUEST_REQUEST_PARAMS_H_
#define EXTENSIONS_BROWSER_API_DECLARATIVE_NET_REQUEST_REQUEST_PARAMS_H_

#include <optional>

#include "base/containers/flat_map.h"
#include "base/functional/callback.h"
#include "base/memory/raw_ptr.h"
#include "components/url_pattern_index/url_pattern_index.h"
#include "content/public/browser/global_routing_id.h"
#include "extensions/browser/api/declarative_net_request/regex_rules_matcher.h"
#include "net/http/http_response_headers.h"
#include "url/gurl.h"
#include "url/origin.h"

namespace content {
class RenderFrameHost;
}  // namespace content

namespace extensions {
struct WebRequestInfo;

namespace declarative_net_request {
class CompositeMatcher;

// Struct to hold parameters for a network request.
struct RequestParams {
  // `info` must outlive this instance.
  RequestParams(const WebRequestInfo& info,
                scoped_refptr<const net::HttpResponseHeaders> response_headers);
  // `host` must not undergo a navigation or get deleted for the duration of
  // this instance.
  RequestParams(content::RenderFrameHost* host,
                bool is_post_navigation,
                scoped_refptr<const net::HttpResponseHeaders> response_headers);
  RequestParams(
      const GURL& url,
      const url::Origin& initiator,
      const url::Origin& top_origin,
      const api::declarative_net_request::ResourceType request_type,
      const api::declarative_net_request::RequestMethod request_method,
      int tab_id,
      scoped_refptr<const net::HttpResponseHeaders> response_headers);
  RequestParams();
  RequestParams(const RequestParams&) = delete;
  RequestParams& operator=(const RequestParams&) = delete;
  ~RequestParams();

  // This is a pointer to a GURL. Hence the GURL must outlive this struct.
  raw_ptr<const GURL> url = nullptr;
  url::Origin first_party_origin;
  url_pattern_index::flat::ElementType element_type =
      url_pattern_index::flat::ElementType_OTHER;
  bool is_third_party = false;

  // The HTTP method used for the request.
  url_pattern_index::flat::RequestMethod method =
      url_pattern_index::flat::RequestMethod_NONE;

  // ID of the parent RenderFrameHost.
  content::GlobalRenderFrameHostId parent_routing_id;

  // Matcher for `flat::UrlRule::embedder_conditions`.
  url_pattern_index::UrlPatternIndexMatcher::EmbedderConditionsMatcher
      embedder_conditions_matcher;

  // A map from an extension ID to its CompositeMatcher's highest priority
  // matching allow or allowAllRequests rule (for the request associated with
  // this instance). Used as a cache to prevent additional calls to GetAction.
  // - If there is no entry for an extension ID: the extension's rulesets have
  // not matched against this request yet.
  // - If the entry for the extension ID is nullopt: the extension has no
  // matching allow/allowAllRequest rules for this request.
  mutable base::flat_map<ExtensionId, std::optional<RequestAction>>
      max_priority_allow_action;

  // Lower cased url, used for regex matching. Cached for performance.
  mutable std::optional<std::string> lower_cased_url_spec;

  // Map from a (RegexRulesMatcher, ruleset matching stage) pair to a vector of
  // potential matches for this request. Cached for performance.
  mutable base::flat_map<RegexRulesMatcher::RegexMatchKey,
                         std::vector<RegexRuleInfo>>
      potential_regex_matches;
};

}  // namespace declarative_net_request
}  // namespace extensions

#endif  // EXTENSIONS_BROWSER_API_DECLARATIVE_NET_REQUEST_REQUEST_PARAMS_H_