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 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406
|
// 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_BROWSER_EXTENSIONS_API_WEBSTORE_PRIVATE_WEBSTORE_PRIVATE_API_H_
#define CHROME_BROWSER_EXTENSIONS_API_WEBSTORE_PRIVATE_WEBSTORE_PRIVATE_API_H_
#include <memory>
#include <optional>
#include <string>
#include "base/auto_reset.h"
#include "base/memory/raw_ptr.h"
#include "base/memory/weak_ptr.h"
#include "base/values.h"
#include "chrome/browser/extensions/active_install_data.h"
#include "chrome/browser/extensions/extension_install_prompt.h"
#include "chrome/browser/extensions/webstore_install_helper.h"
#include "chrome/browser/extensions/webstore_installer.h"
#include "chrome/browser/supervised_user/supervised_user_extensions_metrics_recorder.h"
#include "chrome/common/buildflags.h"
#include "chrome/common/extensions/api/webstore_private.h"
#include "chrome/common/extensions/webstore_install_result.h"
#include "extensions/browser/extension_function.h"
#include "extensions/browser/supervised_user_extensions_delegate.h"
#include "third_party/skia/include/core/SkBitmap.h"
class Profile;
namespace content {
class GpuFeatureChecker;
class WebContents;
}
namespace extensions {
class Extension;
struct InstallApproval;
class ScopedActiveInstall;
class WebstorePrivateApi {
public:
class Delegate {
public:
virtual ~Delegate() = default;
virtual void OnExtensionInstallSuccess(const std::string& id) {}
virtual void OnExtensionInstallFailure(
const std::string& id,
const std::string& error,
WebstoreInstaller::FailureReason reason) {}
};
// Sets a delegate for testing.
static base::AutoReset<Delegate*> SetDelegateForTesting(Delegate* delegate);
// Gets the pending approval for the `extension_id` in `profile`. Pending
// approvals are held between the calls to beginInstallWithManifest and
// completeInstall. This should only be used for testing.
static std::unique_ptr<InstallApproval> PopApprovalForTesting(
Profile* profile,
const std::string& extension_id);
// Clear the pending approvals. This should only be used for testing.
static void ClearPendingApprovalsForTesting();
// Get the count of pending approvals. This should only be used for testing.
static int GetPendingApprovalsCountForTesting();
};
class WebstorePrivateBeginInstallWithManifest3Function
: public ExtensionFunction,
public WebstoreInstallHelper::Delegate {
public:
DECLARE_EXTENSION_FUNCTION("webstorePrivate.beginInstallWithManifest3",
WEBSTOREPRIVATE_BEGININSTALLWITHMANIFEST3)
WebstorePrivateBeginInstallWithManifest3Function();
std::u16string GetBlockedByPolicyErrorMessageForTesting() const;
bool GetFrictionDialogShownForTesting() const {
return friction_dialog_shown_;
}
private:
using Params = api::webstore_private::BeginInstallWithManifest3::Params;
~WebstorePrivateBeginInstallWithManifest3Function() override;
// ExtensionFunction:
ExtensionFunction::ResponseAction Run() override;
// WebstoreInstallHelper::Delegate:
void OnWebstoreParseSuccess(const std::string& id,
const SkBitmap& icon,
base::Value::Dict parsed_manifest) override;
void OnWebstoreParseFailure(const std::string& id,
InstallHelperResultCode result,
const std::string& error_message) override;
void RequestExtensionApproval(content::WebContents* web_contents);
// Handles the result of the extension approval flow.
void OnExtensionApprovalDone(
SupervisedUserExtensionsDelegate::ExtensionApprovalResult result);
void OnExtensionApprovalApproved();
void OnExtensionApprovalCanceled();
void OnExtensionApprovalFailed();
void OnExtensionApprovalBlocked();
// Returns true if the parental approval prompt was shown, false if there was
// an error showing it.
bool PromptForParentApproval();
void OnFrictionPromptDone(bool result);
void OnInstallPromptDone(ExtensionInstallPrompt::DoneCallbackPayload payload);
void OnRequestPromptDone(ExtensionInstallPrompt::DoneCallbackPayload payload);
void OnBlockByPolicyPromptDone();
// Permissions are granted by default.
void HandleInstallProceed(bool withhold_permissions = false);
void HandleInstallAbort(bool user_initiated);
ExtensionFunction::ResponseValue BuildResponse(
api::webstore_private::Result result,
const std::string& error);
bool ShouldShowFrictionDialog(Profile* profile);
void ShowInstallFrictionDialog(content::WebContents* contents);
void ShowInstallDialog(content::WebContents* contents);
// Shows block dialog when `extension` is blocked by policy on the Window that
// `contents` belongs to. `done_callback` will be invoked once the dialog is
// closed by user.
// Custom error message will be appended if it's set by the policy.
void ShowBlockedByPolicyDialog(const Extension* extension,
const SkBitmap& icon,
content::WebContents* contents,
base::OnceClosure done_callback);
// Adds friction accepted events to Safe Browsing metrics collector for
// further metrics logging. Called when a user decides to accept the friction
// prompt. Note that the extension may not be eventually installed.
void ReportFrictionAcceptedEvent();
const Params::Details& details() const { return params_->details; }
std::optional<Params> params_;
raw_ptr<Profile> profile_ = nullptr;
std::unique_ptr<ScopedActiveInstall> scoped_active_install_;
std::optional<base::Value::Dict> parsed_manifest_;
SkBitmap icon_;
// A dummy Extension object we create for the purposes of using
// ExtensionInstallPrompt to prompt for confirmation of the install.
scoped_refptr<Extension> dummy_extension_;
std::u16string blocked_by_policy_error_message_;
SupervisedUserExtensionsMetricsRecorder
supervised_user_extensions_metrics_recorder_;
std::unique_ptr<ExtensionInstallPrompt> install_prompt_;
bool friction_dialog_shown_ = false;
};
class WebstorePrivateCompleteInstallFunction : public ExtensionFunction {
public:
DECLARE_EXTENSION_FUNCTION("webstorePrivate.completeInstall",
WEBSTOREPRIVATE_COMPLETEINSTALL)
WebstorePrivateCompleteInstallFunction();
private:
~WebstorePrivateCompleteInstallFunction() override;
// ExtensionFunction:
ExtensionFunction::ResponseAction Run() override;
// WebstoreInstaller::Delegate callbacks
void OnExtensionInstallSuccess(const std::string& id);
void OnExtensionInstallFailure(const std::string& id,
const std::string& error,
WebstoreInstaller::FailureReason reason);
void OnInstallSuccess(const std::string& id);
std::unique_ptr<InstallApproval> approval_;
std::unique_ptr<ScopedActiveInstall> scoped_active_install_;
base::WeakPtrFactory<WebstorePrivateCompleteInstallFunction>
weak_ptr_factory_{this};
};
class WebstorePrivateEnableAppLauncherFunction : public ExtensionFunction {
public:
DECLARE_EXTENSION_FUNCTION("webstorePrivate.enableAppLauncher",
WEBSTOREPRIVATE_ENABLEAPPLAUNCHER)
WebstorePrivateEnableAppLauncherFunction();
private:
~WebstorePrivateEnableAppLauncherFunction() override;
// ExtensionFunction:
ExtensionFunction::ResponseAction Run() override;
};
class WebstorePrivateGetBrowserLoginFunction : public ExtensionFunction {
public:
DECLARE_EXTENSION_FUNCTION("webstorePrivate.getBrowserLogin",
WEBSTOREPRIVATE_GETBROWSERLOGIN)
WebstorePrivateGetBrowserLoginFunction();
private:
~WebstorePrivateGetBrowserLoginFunction() override;
// ExtensionFunction:
ExtensionFunction::ResponseAction Run() override;
};
class WebstorePrivateGetStoreLoginFunction : public ExtensionFunction {
public:
DECLARE_EXTENSION_FUNCTION("webstorePrivate.getStoreLogin",
WEBSTOREPRIVATE_GETSTORELOGIN)
WebstorePrivateGetStoreLoginFunction();
private:
~WebstorePrivateGetStoreLoginFunction() override;
// ExtensionFunction:
ExtensionFunction::ResponseAction Run() override;
};
class WebstorePrivateSetStoreLoginFunction : public ExtensionFunction {
public:
DECLARE_EXTENSION_FUNCTION("webstorePrivate.setStoreLogin",
WEBSTOREPRIVATE_SETSTORELOGIN)
WebstorePrivateSetStoreLoginFunction();
private:
~WebstorePrivateSetStoreLoginFunction() override;
// ExtensionFunction:
ExtensionFunction::ResponseAction Run() override;
};
class WebstorePrivateGetWebGLStatusFunction : public ExtensionFunction {
public:
DECLARE_EXTENSION_FUNCTION("webstorePrivate.getWebGLStatus",
WEBSTOREPRIVATE_GETWEBGLSTATUS)
WebstorePrivateGetWebGLStatusFunction();
private:
~WebstorePrivateGetWebGLStatusFunction() override;
// ExtensionFunction:
ExtensionFunction::ResponseAction Run() override;
void OnFeatureCheck(bool feature_allowed);
scoped_refptr<content::GpuFeatureChecker> feature_checker_;
};
class WebstorePrivateGetIsLauncherEnabledFunction : public ExtensionFunction {
public:
DECLARE_EXTENSION_FUNCTION("webstorePrivate.getIsLauncherEnabled",
WEBSTOREPRIVATE_GETISLAUNCHERENABLED)
WebstorePrivateGetIsLauncherEnabledFunction();
private:
~WebstorePrivateGetIsLauncherEnabledFunction() override;
// ExtensionFunction:
ExtensionFunction::ResponseAction Run() override;
void OnIsLauncherCheckCompleted(bool is_enabled);
};
class WebstorePrivateIsInIncognitoModeFunction : public ExtensionFunction {
public:
DECLARE_EXTENSION_FUNCTION("webstorePrivate.isInIncognitoMode",
WEBSTOREPRIVATE_ISININCOGNITOMODEFUNCTION)
WebstorePrivateIsInIncognitoModeFunction();
private:
~WebstorePrivateIsInIncognitoModeFunction() override;
// ExtensionFunction:
ExtensionFunction::ResponseAction Run() override;
};
class WebstorePrivateIsPendingCustodianApprovalFunction
: public ExtensionFunction {
public:
DECLARE_EXTENSION_FUNCTION("webstorePrivate.isPendingCustodianApproval",
WEBSTOREPRIVATE_ISPENDINGCUSTODIANAPPROVAL)
WebstorePrivateIsPendingCustodianApprovalFunction();
private:
~WebstorePrivateIsPendingCustodianApprovalFunction() override;
// ExtensionFunction:
ExtensionFunction::ResponseAction Run() override;
ExtensionFunction::ResponseValue BuildResponse(bool result);
};
class WebstorePrivateGetReferrerChainFunction : public ExtensionFunction {
public:
DECLARE_EXTENSION_FUNCTION("webstorePrivate.getReferrerChain",
WEBSTOREPRIVATE_GETREFERRERCHAIN)
WebstorePrivateGetReferrerChainFunction();
WebstorePrivateGetReferrerChainFunction(
const WebstorePrivateGetReferrerChainFunction&) = delete;
WebstorePrivateGetReferrerChainFunction& operator=(
const WebstorePrivateGetReferrerChainFunction&) = delete;
private:
~WebstorePrivateGetReferrerChainFunction() override;
// ExtensionFunction:
ExtensionFunction::ResponseAction Run() override;
};
class WebstorePrivateGetExtensionStatusFunction : public ExtensionFunction {
public:
DECLARE_EXTENSION_FUNCTION("webstorePrivate.getExtensionStatus",
WEBSTOREPRIVATE_GETEXTENSIONSTATUS)
WebstorePrivateGetExtensionStatusFunction();
WebstorePrivateGetExtensionStatusFunction(
const WebstorePrivateGetExtensionStatusFunction&) = delete;
WebstorePrivateGetExtensionStatusFunction& operator=(
const WebstorePrivateGetExtensionStatusFunction&) = delete;
private:
~WebstorePrivateGetExtensionStatusFunction() override;
ExtensionFunction::ResponseValue BuildResponseWithoutManifest(
const ExtensionId& extension_id);
void OnManifestParsed(const ExtensionId& extension_id,
data_decoder::DataDecoder::ValueOrError result);
// ExtensionFunction:
ExtensionFunction::ResponseAction Run() override;
};
class WebstorePrivateGetFullChromeVersionFunction : public ExtensionFunction {
public:
DECLARE_EXTENSION_FUNCTION("webstorePrivate.getFullChromeVersion",
WEBSTOREPRIVATE_GETFULLCHROMEVERSION)
WebstorePrivateGetFullChromeVersionFunction();
WebstorePrivateGetFullChromeVersionFunction(
const WebstorePrivateGetFullChromeVersionFunction&) = delete;
WebstorePrivateGetFullChromeVersionFunction& operator=(
const WebstorePrivateGetFullChromeVersionFunction&) = delete;
private:
~WebstorePrivateGetFullChromeVersionFunction() override;
// ExtensionFunction:
ExtensionFunction::ResponseAction Run() override;
};
class WebstorePrivateGetMV2DeprecationStatusFunction
: public ExtensionFunction {
public:
DECLARE_EXTENSION_FUNCTION("webstorePrivate.getMV2DeprecationStatus",
WEBSTOREPRIVATE_GETMV2DEPRECATIONSTATUS)
WebstorePrivateGetMV2DeprecationStatusFunction();
WebstorePrivateGetMV2DeprecationStatusFunction(
const WebstorePrivateGetMV2DeprecationStatusFunction&) = delete;
WebstorePrivateGetMV2DeprecationStatusFunction& operator=(
const WebstorePrivateGetMV2DeprecationStatusFunction&) = delete;
private:
~WebstorePrivateGetMV2DeprecationStatusFunction() override;
// ExtensionFunction:
ExtensionFunction::ResponseAction Run() override;
};
} // namespace extensions
#endif // CHROME_BROWSER_EXTENSIONS_API_WEBSTORE_PRIVATE_WEBSTORE_PRIVATE_API_H_
|