blob: db37d903318d8ad213f001bf62c5896698dbe604 [file] [log] [blame]
// Copyright 2018 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 CONTENT_BROWSER_LOADER_PREFETCH_URL_LOADER_H_
#define CONTENT_BROWSER_LOADER_PREFETCH_URL_LOADER_H_
#include <memory>
#include "base/callback.h"
#include "base/macros.h"
#include "base/optional.h"
#include "base/unguessable_token.h"
#include "content/common/content_export.h"
#include "mojo/public/cpp/bindings/binding.h"
#include "mojo/public/cpp/system/data_pipe_drainer.h"
#include "net/traffic_annotation/network_traffic_annotation.h"
#include "services/network/public/mojom/url_loader_factory.mojom.h"
#include "url/gurl.h"
namespace net {
class URLRequestContextGetter;
}
namespace network {
class SharedURLLoaderFactory;
}
namespace content {
class ResourceContext;
class URLLoaderThrottle;
class SignedExchangePrefetchHandler;
class SignedExchangePrefetchMetricRecorder;
// PrefetchURLLoader which basically just keeps draining the data.
class CONTENT_EXPORT PrefetchURLLoader : public network::mojom::URLLoader,
public network::mojom::URLLoaderClient,
public mojo::DataPipeDrainer::Client {
public:
using URLLoaderThrottlesGetter = base::RepeatingCallback<
std::vector<std::unique_ptr<content::URLLoaderThrottle>>()>;
// |url_loader_throttles_getter|, |resource_context| and
// |request_context_getter| may be used when a prefetch handler
// needs to additionally create a request (e.g. for fetching certificate
// if the prefetch was for a signed exchange).
// |frame_tree_node_id_getter| is called only on UI thread when NetworkService
// is not enabled, but can be also called on IO thread otherwise.
PrefetchURLLoader(
int32_t routing_id,
int32_t request_id,
uint32_t options,
base::RepeatingCallback<int(void)> frame_tree_node_id_getter,
const network::ResourceRequest& resource_request,
network::mojom::URLLoaderClientPtr client,
const net::MutableNetworkTrafficAnnotationTag& traffic_annotation,
scoped_refptr<network::SharedURLLoaderFactory> network_loader_factory,
URLLoaderThrottlesGetter url_loader_throttles_getter,
ResourceContext* resource_context,
scoped_refptr<net::URLRequestContextGetter> request_context_getter,
scoped_refptr<SignedExchangePrefetchMetricRecorder>
signed_exchange_prefetch_metric_recorder);
~PrefetchURLLoader() override;
private:
// network::mojom::URLLoader overrides:
void FollowRedirect(
const base::Optional<std::vector<std::string>>&
to_be_removed_request_headers,
const base::Optional<net::HttpRequestHeaders>& modified_request_headers,
const base::Optional<GURL>& new_url) override;
void ProceedWithResponse() override;
void SetPriority(net::RequestPriority priority,
int intra_priority_value) override;
void PauseReadingBodyFromNet() override;
void ResumeReadingBodyFromNet() override;
// network::mojom::URLLoaderClient overrides:
void OnReceiveResponse(const network::ResourceResponseHead& head) override;
void OnReceiveRedirect(const net::RedirectInfo& redirect_info,
const network::ResourceResponseHead& head) override;
void OnUploadProgress(int64_t current_position,
int64_t total_size,
base::OnceCallback<void()> callback) override;
void OnReceiveCachedMetadata(const std::vector<uint8_t>& data) override;
void OnTransferSizeUpdated(int32_t transfer_size_diff) override;
void OnStartLoadingResponseBody(
mojo::ScopedDataPipeConsumerHandle body) override;
void OnComplete(const network::URLLoaderCompletionStatus& status) override;
// mojo::DataPipeDrainer::Client overrides:
// This just does nothing but keep reading.
void OnDataAvailable(const void* data, size_t num_bytes) override {}
void OnDataComplete() override {}
void OnNetworkConnectionError();
const base::RepeatingCallback<int(void)> frame_tree_node_id_getter_;
const GURL url_;
const bool report_raw_headers_;
const int load_flags_;
const base::Optional<base::UnguessableToken> throttling_profile_id_;
scoped_refptr<network::SharedURLLoaderFactory> network_loader_factory_;
// For the actual request.
network::mojom::URLLoaderPtr loader_;
mojo::Binding<network::mojom::URLLoaderClient> client_binding_;
// To be a URLLoader for the client.
network::mojom::URLLoaderClientPtr forwarding_client_;
url::Origin request_initiator_;
// |url_loader_throttles_getter_| and |resource_context_| should be
// valid as far as |request_context_getter_| returns non-null value.
URLLoaderThrottlesGetter url_loader_throttles_getter_;
ResourceContext* resource_context_;
scoped_refptr<net::URLRequestContextGetter> request_context_getter_;
std::unique_ptr<mojo::DataPipeDrainer> pipe_drainer_;
std::unique_ptr<SignedExchangePrefetchHandler>
signed_exchange_prefetch_handler_;
GURL new_url_for_redirect_;
scoped_refptr<SignedExchangePrefetchMetricRecorder>
signed_exchange_prefetch_metric_recorder_;
DISALLOW_COPY_AND_ASSIGN(PrefetchURLLoader);
};
} // namespace content
#endif // CONTENT_BROWSER_LOADER_PREFETCH_URL_LOADER_H_