File: btm_page_visit_observer.h

package info (click to toggle)
chromium 138.0.7204.183-1~deb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm-proposed-updates
  • size: 6,080,960 kB
  • sloc: cpp: 34,937,079; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,954; asm: 946,768; xml: 739,971; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,811; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (108 lines) | stat: -rw-r--r-- 3,959 bytes parent folder | download | duplicates (5)
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
// Copyright 2025 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_BTM_BTM_PAGE_VISIT_OBSERVER_H_
#define CONTENT_BROWSER_BTM_BTM_PAGE_VISIT_OBSERVER_H_

#include <deque>
#include <vector>

#include "base/check_deref.h"
#include "base/functional/callback_forward.h"
#include "base/memory/weak_ptr.h"
#include "base/time/clock.h"
#include "base/time/default_clock.h"
#include "base/time/time.h"
#include "content/common/content_export.h"
#include "content/public/browser/btm_redirect_info.h"
#include "content/public/browser/web_contents_observer.h"
#include "url/gurl.h"

namespace content {

struct CONTENT_EXPORT BtmPageVisitInfo {
  GURL url;
  ukm::SourceId source_id;
  bool had_active_storage_access = false;
  bool received_user_activation = false;
  bool had_successful_web_authn_assertion = false;
  // Computed based on wall-clock times, so the usual caveat for working with
  // wall-clock times applies: the system clock may have been changed during the
  // page visit and so the duration may not be positive.
  base::TimeDelta visit_duration;
};

struct CONTENT_EXPORT BtmServerRedirectInfo {
  GURL url;
  ukm::SourceId source_id;
  bool did_write_cookies = false;
};

struct CONTENT_EXPORT BtmNavigationInfo {
  // Precondition: `navigation_handle.HasCommitted()` must be `true`.
  explicit BtmNavigationInfo(NavigationHandle& navigation_handle);
  BtmNavigationInfo(BtmNavigationInfo&&);
  BtmNavigationInfo& operator=(BtmNavigationInfo&&);
  ~BtmNavigationInfo();

  std::vector<BtmServerRedirectInfo> server_redirects;
  bool was_user_initiated;
  bool was_renderer_initiated;
  ui::PageTransition page_transition;
  // The page where the navigation ultimately committed.
  UrlAndSourceId destination;
};

class CONTENT_EXPORT BtmPageVisitObserver : public WebContentsObserver {
 public:
  using VisitCallback =
      base::RepeatingCallback<void(BtmPageVisitInfo, BtmNavigationInfo)>;

  // The arguments to `VisitCallback`.
  struct VisitTuple {
    BtmPageVisitInfo prev_page;
    BtmNavigationInfo navigation;
  };

  BtmPageVisitObserver(WebContents* web_contents,
                       VisitCallback callback,
                       base::Clock* clock = base::DefaultClock::GetInstance());
  ~BtmPageVisitObserver() override;

  // WebContentsObserver overrides:
  void DidStartNavigation(NavigationHandle* navigation_handle) override;
  void DidRedirectNavigation(NavigationHandle* navigation_handle) override;
  void DidFinishNavigation(NavigationHandle* navigation_handle) override;
  void NotifyStorageAccessed(RenderFrameHost* render_frame_host,
                             blink::mojom::StorageTypeAccessed storage_type,
                             bool blocked) override;
  void OnCookiesAccessed(RenderFrameHost* render_frame_host,
                         const CookieAccessDetails& details) override;
  void OnCookiesAccessed(NavigationHandle* navigation_handle,
                         const CookieAccessDetails& details) override;
  void FrameReceivedUserActivation(RenderFrameHost* render_frame_host) override;
  void WebAuthnAssertionRequestSucceeded(
      RenderFrameHost* render_frame_host) override;

  void SetClockForTesting(base::Clock* clock) { clock_ = CHECK_DEREF(clock); }

 private:
  // Execute the visit callback with a tuple from the pending queue.
  void ReportVisit();

  // The callback to execute for each page visit.
  VisitCallback callback_;
  // Metadata on the currently committed page.
  BtmPageVisitInfo current_page_;
  raw_ref<base::Clock> clock_;
  base::Time last_page_change_time_;
  // Past page visits that we are still waiting to see if late cookie accesses
  // are reported for them.
  std::deque<VisitTuple> pending_visits_;
  base::WeakPtrFactory<BtmPageVisitObserver> weak_factory_{this};
};

}  // namespace content

#endif  // CONTENT_BROWSER_BTM_BTM_PAGE_VISIT_OBSERVER_H_