1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
|
// Copyright 2024 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CONTENT_BROWSER_ATTRIBUTION_REPORTING_ATTRIBUTION_SUITABLE_CONTEXT_H_
#define CONTENT_BROWSER_ATTRIBUTION_REPORTING_ATTRIBUTION_SUITABLE_CONTEXT_H_
#include <stdint.h>
#include <optional>
#include "base/memory/weak_ptr.h"
#include "components/attribution_reporting/suitable_origin.h"
#include "content/browser/attribution_reporting/attribution_input_event.h"
#include "content/common/content_export.h"
#include "content/public/browser/content_browser_client.h"
#include "services/metrics/public/cpp/ukm_source_id.h"
namespace content {
class AttributionDataHostManager;
class NavigationHandle;
class RenderFrameHostImpl;
// The `AttributionSuitableContext` encapsulates the context necessary from a
// `RenderFrameHost` for a `KeepAliveAttributionRequestHelper` to be created.
class CONTENT_EXPORT AttributionSuitableContext {
public:
// Returns `AttributionSuitableContext` if the context is suitable to register
// attribution. The following two variants differ in the ways to get UKM
// source IDs.
//
// Called for a context associated with an ongoing navigation. Note that
// `AttributionHost::GetPageUkmSourceId()` returns the UKM source ID for the
// most recently navigated primary page, therefore we get UKM source ID from
// the associated ongoing navigation handle.
static std::optional<AttributionSuitableContext> Create(NavigationHandle*);
// Called for a context associated with a complete navigation.
static std::optional<AttributionSuitableContext> Create(RenderFrameHostImpl*);
// Allows to create a context with arbitrary properties for testing purposes.
static AttributionSuitableContext CreateForTesting(
attribution_reporting::SuitableOrigin context_origin,
bool is_nested_within_fenced_frame,
GlobalRenderFrameHostId root_render_frame_id,
int64_t last_navigation_id,
AttributionInputEvent last_input_event = AttributionInputEvent(),
ContentBrowserClient::AttributionReportingOsRegistrars os_registrars =
{ContentBrowserClient::AttributionReportingOsRegistrar::kWeb,
ContentBrowserClient::AttributionReportingOsRegistrar::kWeb},
AttributionDataHostManager* attribution_data_host_manager = nullptr,
bool is_context_google_amp_viewer = false,
ukm::SourceId ukm_source_id = ukm::kInvalidSourceId);
bool operator==(const AttributionSuitableContext& other) const;
AttributionSuitableContext(const AttributionSuitableContext&);
AttributionSuitableContext& operator=(const AttributionSuitableContext&);
AttributionSuitableContext(AttributionSuitableContext&&);
AttributionSuitableContext& operator=(AttributionSuitableContext&&);
~AttributionSuitableContext();
const attribution_reporting::SuitableOrigin& context_origin() const {
return context_origin_;
}
bool is_nested_within_fenced_frame() const {
return is_nested_within_fenced_frame_;
}
GlobalRenderFrameHostId root_render_frame_id() const {
return root_render_frame_id_;
}
int64_t last_navigation_id() const { return last_navigation_id_; }
const AttributionInputEvent& last_input_event() const {
return last_input_event_;
}
ContentBrowserClient::AttributionReportingOsRegistrars os_registrars() const {
return os_registrars_;
}
bool is_context_google_amp_viewer() const {
return is_context_google_amp_viewer_;
}
ukm::SourceId ukm_source_id() const { return ukm_source_id_; }
AttributionDataHostManager* data_host_manager() const {
return attribution_data_host_manager_.get();
}
private:
AttributionSuitableContext(
attribution_reporting::SuitableOrigin context_origin,
bool is_nested_within_fenced_frame,
GlobalRenderFrameHostId root_render_frame_id,
int64_t last_navigation_id,
AttributionInputEvent last_input_event,
ContentBrowserClient::AttributionReportingOsRegistrars,
bool is_context_google_amp_viewer,
ukm::SourceId,
base::WeakPtr<AttributionDataHostManager>);
attribution_reporting::SuitableOrigin context_origin_;
bool is_nested_within_fenced_frame_;
GlobalRenderFrameHostId root_render_frame_id_;
int64_t last_navigation_id_;
AttributionInputEvent last_input_event_;
ContentBrowserClient::AttributionReportingOsRegistrars os_registrars_;
bool is_context_google_amp_viewer_ = false;
ukm::SourceId ukm_source_id_;
base::WeakPtr<AttributionDataHostManager> attribution_data_host_manager_;
};
} // namespace content
#endif // CONTENT_BROWSER_ATTRIBUTION_REPORTING_ATTRIBUTION_SUITABLE_CONTEXT_H_
|
