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 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264
|
// 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 CHROME_BROWSER_GLIC_GLIC_KEYED_SERVICE_H_
#define CHROME_BROWSER_GLIC_GLIC_KEYED_SERVICE_H_
#include <memory>
#include <optional>
#include <string>
#include <vector>
#include "base/callback_list.h"
#include "base/containers/flat_set.h"
#include "base/memory/memory_pressure_listener.h"
#include "base/memory/raw_ptr.h"
#include "chrome/browser/actor/task_id.h"
#include "chrome/browser/glic/glic_enabling.h"
#include "chrome/browser/glic/host/context/glic_sharing_manager.h"
#include "chrome/browser/glic/host/glic.mojom.h"
#include "chrome/browser/glic/widget/glic_window_controller.h"
#include "components/keyed_service/core/keyed_service.h"
#include "content/public/browser/web_contents.h"
class BrowserWindowInterface;
class Profile;
class ProfileManager;
namespace actor {
class ExecutionEngine;
} // namespace actor
namespace contextual_cueing {
class ContextualCueingService;
} // namespace contextual_cueing
namespace signin {
class IdentityManager;
} // namespace signin
namespace glic {
class AuthController;
class GlicActorController;
class GlicEnabling;
class GlicMetrics;
class GlicOcclusionNotifier;
class GlicProfileManager;
class GlicScreenshotCapturer;
class GlicSharingManagerImpl;
class GlicWindowController;
class GlicWindowControllerImpl;
class Host;
// The GlicKeyedService is created for each eligible (i.e. non-incognito,
// non-system, etc.) browser profile if Glic flags are enabled, regardless
// of whether the profile is enabled or disabled at runtime (currently
// possible via enterprise policy). This is required on disabled profiles
// since pieces of this service are the ones that monitor this runtime
// preference for changes and cause the UI to respond to it.
class GlicKeyedService : public KeyedService {
public:
explicit GlicKeyedService(
Profile* profile,
signin::IdentityManager* identity_manager,
ProfileManager* profile_manager,
GlicProfileManager* glic_profile_manager,
contextual_cueing::ContextualCueingService* contextual_cueing_service);
GlicKeyedService(const GlicKeyedService&) = delete;
GlicKeyedService& operator=(const GlicKeyedService&) = delete;
~GlicKeyedService() override;
// Convenience method, may return nullptr.
static GlicKeyedService* Get(content::BrowserContext* context);
// KeyedService
void Shutdown() override;
// Show, summon or activate the panel, or close it if it's already active and
// prevent_close is false. If glic_button_view is non-null, attach the panel
// to that view's Browser.
void ToggleUI(BrowserWindowInterface* bwi,
bool prevent_close,
mojom::InvocationSource source);
void OpenFreDialogInNewTab(BrowserWindowInterface* bwi,
mojom::InvocationSource source);
// Forcibly close the UI. This is similar to Shutdown in that it causes the
// window controller to shutdown (and clear cached state), but unlike
// Shutdown, it doesn't unregister as the "active glic" with the profile
// manager.
void CloseUI();
// The user has performed an action suggesting that they made open the UI
// soon.
void PrepareForOpen();
// Fetch zero state suggestions for the active web contents.
void FetchZeroStateSuggestions(
bool is_first_run,
std::optional<std::vector<std::string>> supported_tools,
glic::mojom::WebClientHandler::
GetZeroStateSuggestionsForFocusedTabCallback callback);
GlicEnabling& enabling() { return *enabling_.get(); }
GlicMetrics* metrics() { return metrics_.get(); }
GlicWindowController& window_controller();
GlicSharingManager& sharing_manager();
// Called when a webview guest is created within a chrome://glic WebUI.
void GuestAdded(content::WebContents* guest_contents);
// Virtual for testing.
virtual bool IsWindowShowing() const;
// Virtual for testing.
virtual bool IsWindowDetached() const;
bool IsWindowOrFreShowing() const;
// Private API for the glic WebUI.
// CreateTab is used by both the FRE page and the glic web client to open a
// URL in a new tab.
void CreateTab(const ::GURL& url,
bool open_in_background,
const std::optional<int32_t>& window_id,
glic::mojom::WebClientHandler::CreateTabCallback callback);
virtual void ClosePanel();
void AttachPanel();
void DetachPanel();
void ResizePanel(const gfx::Size& size,
base::TimeDelta duration,
base::OnceClosure callback);
void SetPanelDraggableAreas(const std::vector<gfx::Rect>& draggable_areas);
void SetContextAccessIndicator(bool show);
// Callback for changes to the context access indicator status.
using ContextAccessIndicatorChangedCallback =
base::RepeatingCallback<void(bool)>;
// Registers a callback to be called any time the context access indicator
// status changes. This is used to update UI effects on the focused tab
// depending on whether the client has requested the indicators or not.
base::CallbackListSubscription AddContextAccessIndicatorStatusChangedCallback(
ContextAccessIndicatorChangedCallback callback);
// Returns whether the context access indicator should be shown for the web
// contents. True iff the web contents is considered focused by
// GlicFocusedTabManager and the web client has enabled the context access
// indicator.
bool IsContextAccessIndicatorShown(const content::WebContents* contents);
bool is_context_access_indicator_enabled() const {
return is_context_access_indicator_enabled_;
}
void ActInFocusedTab(
const std::vector<uint8_t>& action_proto,
const mojom::GetTabContextOptions& options,
mojom::WebClientHandler::ActInFocusedTabCallback callback);
void StopActorTask(actor::TaskId task_id);
void PauseActorTask(actor::TaskId task_id);
void ResumeActorTask(
actor::TaskId task_id,
const mojom::GetTabContextOptions& context_options,
glic::mojom::WebClientHandler::ResumeActorTaskCallback callback);
void OnUserInputSubmitted(glic::mojom::WebClientMode mode);
void OnRequestStarted();
void OnResponseStarted();
void OnResponseStopped();
// Returns true if the associated ExecutionEngine is active on the given
// `tab`. This can be used by callers to customize certain behaviour that
// might interfere with the ExecutionEngine.
bool IsExecutionEngineActingOnTab(const content::WebContents* tab) const;
actor::ExecutionEngine& GetExecutionEngineForTesting(tabs::TabInterface* tab);
void CaptureScreenshot(
glic::mojom::WebClientHandler::CaptureScreenshotCallback callback);
AuthController& GetAuthController() { return *auth_controller_; }
bool IsActiveWebContents(content::WebContents* contents);
void AddPreloadCallback(base::OnceCallback<void()> callback);
virtual void TryPreload();
void TryPreloadAfterDelay();
virtual void TryPreloadFre();
void Reload();
Profile* profile() const { return profile_; }
// Used only for testing purposes.
void reset_profile_for_test() { profile_ = nullptr; }
base::WeakPtr<GlicKeyedService> GetWeakPtr();
void OnMemoryPressure(
base::MemoryPressureListener::MemoryPressureLevel level);
Host& host() { return *host_; }
// Returns whether this process host is either the Glic FRE WebUI or the Glic
// main WebUI.
bool IsProcessHostForGlic(content::RenderProcessHost* process_host);
// Returns whether this web contents contains the Chrome glic WebUI,
// chrome://glic.
bool IsGlicWebUi(content::WebContents* web_contents);
// Log a fake network request to NetLog with a Glic traffic annotation. This
// doesn't *send* a request, it just logs it for chrome://net-export.
//
// Unfortunately there's no way to pass `traffic_annotation` to
// LoadURLWithParams() or to tag the WebContents with an annotation, so we
// use this hacky workaround to capture the annotation at runtime.
void LogDummyNetworkRequestForTrafficAnnotation(const GURL& url);
private:
// A helper function to route GetZeroStateSuggestionsForFocusedTabCallback
// callbacks.
void OnZeroStateSuggestionsFetched(
glic::mojom::ZeroStateSuggestionsPtr suggestions,
glic::mojom::WebClientHandler::
GetZeroStateSuggestionsForFocusedTabCallback callback,
std::optional<std::vector<std::string>> returned_suggestions);
void FinishPreload(bool should_preload);
void FinishPreloadFre(bool should_preload);
// List of callbacks to be notified when the client requests a change to the
// context access indicator status.
base::RepeatingCallbackList<void(bool)>
context_access_indicator_callback_list_;
// The state of the context access indicator as set by the client.
bool is_context_access_indicator_enabled_ = false;
raw_ptr<Profile> profile_;
std::unique_ptr<GlicEnabling> enabling_;
std::unique_ptr<GlicMetrics> metrics_;
std::unique_ptr<Host> host_;
std::unique_ptr<GlicWindowControllerImpl> window_controller_;
std::unique_ptr<GlicSharingManagerImpl> sharing_manager_;
std::unique_ptr<GlicScreenshotCapturer> screenshot_capturer_;
std::unique_ptr<AuthController> auth_controller_;
std::unique_ptr<GlicActorController> actor_controller_;
std::unique_ptr<base::MemoryPressureListener> memory_pressure_listener_;
std::unique_ptr<GlicOcclusionNotifier> occlusion_notifier_;
base::OnceCallback<void()> preload_callback_;
// Unowned
raw_ptr<contextual_cueing::ContextualCueingService>
contextual_cueing_service_;
base::WeakPtrFactory<GlicKeyedService> weak_ptr_factory_{this};
};
} // namespace glic
#endif // CHROME_BROWSER_GLIC_GLIC_KEYED_SERVICE_H_
|