blob: 07d0c681cb2c405c3c82d674e37f59b801260a4d [file] [log] [blame]
// Copyright 2017 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 NET_REPORTING_REPORTING_SERVICE_H_
#define NET_REPORTING_REPORTING_SERVICE_H_
#include <memory>
#include <string>
#include "base/callback.h"
#include "base/containers/flat_map.h"
#include "base/macros.h"
#include "net/base/net_export.h"
#include "net/reporting/reporting_cache.h"
class GURL;
namespace base {
class Value;
} // namespace base
namespace net {
class NetworkIsolationKey;
class ReportingContext;
struct ReportingPolicy;
class URLRequestContext;
// The external interface to the Reporting system, used by the embedder of //net
// and also other parts of //net.
class NET_EXPORT ReportingService {
public:
virtual ~ReportingService();
// Creates a ReportingService. |policy| will be copied. |request_context| must
// outlive the ReportingService. |store| must outlive the ReportingService.
// If |store| is null, the ReportingCache will be in-memory only.
static std::unique_ptr<ReportingService> Create(
const ReportingPolicy& policy,
URLRequestContext* request_context,
ReportingCache::PersistentReportingStore* store);
// Creates a ReportingService for testing purposes using an
// already-constructed ReportingContext. The ReportingService will take
// ownership of |reporting_context| and destroy it when the service is
// destroyed.
static std::unique_ptr<ReportingService> CreateForTesting(
std::unique_ptr<ReportingContext> reporting_context);
// Queues a report for delivery. |url| is the URL that originated the report.
// |network_isolation_key| is used to restrict what reports can be merged, and
// for sending the report.
// |user_agent| is the User-Agent header that was used for the request.
// |group| is the endpoint group to which the report should be delivered.
// |type| is the type of the report. |body| is the body of the report.
//
// The Reporting system will take ownership of |body|; all other parameters
// will be copied.
virtual void QueueReport(const GURL& url,
const NetworkIsolationKey& network_isolation_key,
const std::string& user_agent,
const std::string& group,
const std::string& type,
std::unique_ptr<const base::Value> body,
int depth) = 0;
// Processes a Report-To header. |url| is the URL that originated the header;
// |header_value| is the normalized value of the Report-To header.
virtual void ProcessReportToHeader(
const GURL& url,
const NetworkIsolationKey& network_isolation_key,
const std::string& header_value) = 0;
// Configures reporting endpoints set by the Reporting-Endpoints header, once
// the associated document has been committed.
// |endpoints| is a mapping of endpoint names to URLs.
virtual void SetDocumentReportingEndpoints(
const url::Origin& origin,
const NetworkIsolationKey& network_isolation_key,
const base::flat_map<std::string, std::string>& endpoints) = 0;
// Removes browsing data from the Reporting system. See
// ReportingBrowsingDataRemover for more details.
virtual void RemoveBrowsingData(
uint64_t data_type_mask,
const base::RepeatingCallback<bool(const GURL&)>& origin_filter) = 0;
// Like RemoveBrowsingData except removes data for all origins without a
// filter.
virtual void RemoveAllBrowsingData(uint64_t data_type_mask) = 0;
// Shuts down the Reporting service so that no new headers or reports are
// processed, and pending uploads are cancelled.
virtual void OnShutdown() = 0;
virtual const ReportingPolicy& GetPolicy() const = 0;
virtual base::Value StatusAsValue() const;
virtual ReportingContext* GetContextForTesting() const = 0;
protected:
ReportingService() {}
private:
DISALLOW_COPY_AND_ASSIGN(ReportingService);
};
} // namespace net
#endif // NET_REPORTING_REPORTING_SERVICE_H_