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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
|
// Copyright 2012 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_RENDERER_SEARCHBOX_SEARCHBOX_H_
#define CHROME_RENDERER_SEARCHBOX_SEARCHBOX_H_
#include <optional>
#include <string>
#include <vector>
#include "base/memory/weak_ptr.h"
#include "chrome/common/search/instant_types.h"
#include "chrome/common/search/ntp_logging_events.h"
#include "chrome/common/search/search.mojom.h"
#include "chrome/renderer/instant_restricted_id_cache.h"
#include "components/ntp_tiles/ntp_tile_impression.h"
#include "components/omnibox/common/omnibox_focus_state.h"
#include "content/public/renderer/render_frame_observer.h"
#include "content/public/renderer/render_frame_observer_tracker.h"
#include "mojo/public/cpp/bindings/associated_receiver.h"
#include "mojo/public/cpp/bindings/associated_remote.h"
#include "url/gurl.h"
// The renderer-side implementation of the embeddedSearch API (see
// https://www.chromium.org/embeddedsearch).
class SearchBox : public content::RenderFrameObserver,
public content::RenderFrameObserverTracker<SearchBox>,
public search::mojom::EmbeddedSearchClient {
public:
// Helper class for GenerateImageURLFromTransientURL() to adapt SearchBox's
// instance, thereby allow mocking for unit tests.
class IconURLHelper {
public:
IconURLHelper();
virtual ~IconURLHelper();
// Returns main frame id for validating icon URL.
virtual std::string GetMainFrameToken() const = 0;
// Returns the page URL string for |rid|, or empty string for invalid |rid|.
virtual std::string GetURLStringFromRestrictedID(InstantRestrictedID rid)
const = 0;
};
explicit SearchBox(content::RenderFrame* render_frame);
SearchBox(const SearchBox&) = delete;
SearchBox& operator=(const SearchBox&) = delete;
~SearchBox() override;
// Sends DeleteMostVisitedItem to the browser.
void DeleteMostVisitedItem(InstantRestrictedID most_visited_item_id);
// Generates the image URL of the most visited item favicon specified by
// |transient_url|. If |transient_url| is valid, |url| is set with a
// translated URL. Otherwise, |url| is set the the default favicon
// ("chrome-search://favicon/").
//
// Valid forms of |transient_url|:
// chrome-search://favicon/<view_id>/<restricted_id>
// chrome-search://favicon/<favicon_parameters>/<view_id>/<restricted_id>
//
// We do this to prevent search providers from abusing image URLs and deduce
// whether the user has visited a particular page. For example, if
// "chrome-search://favicon/http://www.secretsite.com" is accessible, then
// the search provider can use its return code to determine whether the user
// has visited "http://www.secretsite.com". Therefore we require search
// providers to specify URL by "<view_id>/<restricted_id>". We then translate
// this to the original |url|, and pass the request to the proper endpoint.
void GenerateImageURLFromTransientURL(const GURL& transient_url,
GURL* url) const;
// Returns the latest most visited items sent by the browser.
void GetMostVisitedItems(
std::vector<InstantMostVisitedItemIDPair>* items) const;
bool AreMostVisitedItemsAvailable() const;
// If the |most_visited_item_id| is found in the cache, sets |item| to it
// and returns true.
bool GetMostVisitedItemWithID(InstantRestrictedID most_visited_item_id,
InstantMostVisitedItem* item) const;
// Will return null if the theme info hasn't been set yet.
const NtpTheme* GetNtpTheme() const;
// Sends FocusOmnibox(OMNIBOX_FOCUS_INVISIBLE) to the browser.
void StartCapturingKeyStrokes();
// Sends FocusOmnibox(OMNIBOX_FOCUS_NONE) to the browser.
void StopCapturingKeyStrokes();
// Sends UndoAllMostVisitedDeletions to the browser.
void UndoAllMostVisitedDeletions();
// Sends UndoMostVisitedDeletion to the browser.
void UndoMostVisitedDeletion(InstantRestrictedID most_visited_item_id);
// Sends ToggleShortcutsVisibility to the browser.
void ToggleShortcutsVisibility(bool do_notify);
bool is_focused() const { return is_focused_; }
bool is_input_in_progress() const { return is_input_in_progress_; }
bool is_key_capture_enabled() const { return is_key_capture_enabled_; }
private:
// Overridden from content::RenderFrameObserver:
void DidCommitProvisionalLoad(ui::PageTransition transition) override;
void OnDestruct() override;
// Overridden from search::mojom::EmbeddedSearchClient:
void SetPageSequenceNumber(int page_seq_no) override;
void FocusChanged(OmniboxFocusState new_focus_state,
OmniboxFocusChangeReason reason) override;
void MostVisitedInfoChanged(
const InstantMostVisitedInfo& most_visited_info) override;
void SetInputInProgress(bool input_in_progress) override;
void ThemeChanged(const NtpTheme& theme) override;
void AddCustomLinkResult(bool success);
void UpdateCustomLinkResult(bool success);
void DeleteCustomLinkResult(bool success);
// Returns the URL of the Most Visited item specified by the |item_id|.
GURL GetURLForMostVisitedItem(InstantRestrictedID item_id) const;
// The connection to the EmbeddedSearch service in the browser process.
mojo::AssociatedRemote<search::mojom::EmbeddedSearch>
embedded_search_service_;
mojo::AssociatedReceiver<search::mojom::EmbeddedSearchClient> receiver_{this};
// Whether it's legal to execute JavaScript in |render_frame()|.
// This class may want to execute JS in response to IPCs (via the
// SearchBoxExtension::Dispatch* methods). However, for cross-process
// navigations, a "provisional frame" is created at first, and it's illegal
// to execute any JS in it before it is actually swapped in, i.e. before the
// navigation has committed. So this only gets set to true in
// RenderFrameObserver::DidCommitProvisionalLoad. See crbug.com/765101.
// Note: If crbug.com/794942 ever gets resolved, then it might be possible to
// move the mojo connection code from the ctor to DidCommitProvisionalLoad and
// avoid this bool.
bool can_run_js_in_renderframe_;
// The Instant state.
int page_seq_no_;
bool is_focused_;
bool is_input_in_progress_;
bool is_key_capture_enabled_;
InstantRestrictedIDCache<InstantMostVisitedItem> most_visited_items_cache_;
// Use |most_visited_items_cache_| instead of |most_visited_info_.items| when
// comparing most visited items.
InstantMostVisitedInfo most_visited_info_;
bool has_received_most_visited_;
std::optional<NtpTheme> theme_;
base::WeakPtrFactory<SearchBox> weak_ptr_factory_{this};
};
#endif // CHROME_RENDERER_SEARCHBOX_SEARCHBOX_H_
|
