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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
|
// 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 CHROME_BROWSER_NAVIGATION_PREDICTOR_NAVIGATION_PREDICTOR_KEYED_SERVICE_H_
#define CHROME_BROWSER_NAVIGATION_PREDICTOR_NAVIGATION_PREDICTOR_KEYED_SERVICE_H_
#include <memory>
#include <optional>
#include <unordered_set>
#include <vector>
#include "base/memory/raw_ptr.h"
#include "base/observer_list.h"
#include "base/task/single_thread_task_runner.h"
#include "base/time/time.h"
#include "chrome/browser/navigation_predictor/search_engine_preconnector.h"
#include "components/keyed_service/core/keyed_service.h"
#include "url/gurl.h"
namespace content {
class BrowserContext;
class WebContents;
} // namespace content
// Keyed service that can be used to receive notifications about the URLs for
// the next predicted navigation.
class NavigationPredictorKeyedService : public KeyedService {
public:
// Indicates how the set of next navigation URLs were predicted.
enum class PredictionSource {
// Next navigation URLs were predicted by navigation predictor by parsing
// the anchor element metrics on a webpage.
kAnchorElementsParsedFromWebPage = 0,
};
// Stores the next set of URLs that the user is expected to navigate to.
class Prediction {
public:
Prediction(content::WebContents* web_contents,
const std::optional<GURL>& source_document_url,
PredictionSource prediction_source,
const std::vector<GURL>& sorted_predicted_urls);
Prediction(const Prediction& other);
Prediction& operator=(const Prediction& other);
~Prediction();
const std::optional<GURL>& source_document_url() const;
PredictionSource prediction_source() const { return prediction_source_; }
const std::vector<GURL>& sorted_predicted_urls() const;
// Null if the prediction source is kExternalAndroidApp.
content::WebContents* web_contents() const;
private:
// The WebContents from where the navigation may happen. Do not use this
// pointer outside the observer's call stack unless its destruction is also
// observed.
raw_ptr<content::WebContents, DanglingUntriaged> web_contents_;
// TODO(spelchat): this no longer needs to be optional. Optionality was
// required because external app predictions didn't provide this field, but
// external predictions are no longer supported.
// Current URL of the document from where the navigtion may happen.
std::optional<GURL> source_document_url_;
// |prediction_source_| indicates how the prediction was generated and
// affects how the prediction should be consumed. If the
// |prediction_source_| is kAnchorElementsParsedFromWebPage, then
// |source_document_url_| is the webpage from where the predictions were
// generated.
PredictionSource prediction_source_;
// Ordered set of URLs that the user is expected to navigate to next. The
// URLs are in the decreasing order of click probability.
std::vector<GURL> sorted_predicted_urls_;
};
// Observer class can be implemented to receive notifications about the
// predicted URLs for the next navigation. OnPredictionUpdated() is called
// every time a new prediction is available. Prediction includes the source
// document as well as the ordered list of URLs that the user may navigate to
// next. OnPredictionUpdated() may be called multiple times for the same
// source document URL.
//
// Observers must follow relevant privacy guidelines when consuming the
// notifications.
class Observer {
public:
virtual void OnPredictionUpdated(const Prediction& prediction) = 0;
protected:
Observer() = default;
virtual ~Observer() = default;
};
explicit NavigationPredictorKeyedService(
content::BrowserContext* browser_context);
NavigationPredictorKeyedService(const NavigationPredictorKeyedService&) =
delete;
NavigationPredictorKeyedService& operator=(
const NavigationPredictorKeyedService&) = delete;
~NavigationPredictorKeyedService() override;
SearchEnginePreconnector* search_engine_preconnector();
// |document_url| may be invalid. Called by navigation predictor.
void OnPredictionUpdated(content::WebContents* web_contents,
const GURL& document_url,
PredictionSource prediction_source,
const std::vector<GURL>& sorted_predicted_urls);
// Adds |observer| as the observer for next predicted navigation. When
// |observer| is added via AddObserver, it's immediately notified of the last
// known prediction. Observers must follow relevant privacy guidelines when
// consuming the notifications.
void AddObserver(Observer* observer);
// Removes |observer| as the observer for next predicted navigation.
void RemoveObserver(Observer* observer);
private:
// List of observers are currently registered to receive notifications for the
// next predicted navigations.
base::ObserverList<Observer>::Unchecked observer_list_;
// Last known prediction.
std::optional<Prediction> last_prediction_;
// Manages preconnecting to the user's default search engine.
SearchEnginePreconnector search_engine_preconnector_;
};
#endif // CHROME_BROWSER_NAVIGATION_PREDICTOR_NAVIGATION_PREDICTOR_KEYED_SERVICE_H_
|
