e1fc5c83ba
Per conversations in the WECG [1], it's agreed that we should rename permissions.addSiteAccessRequest and permissions.removeSiteAccessRequest to permissions.addHostAccessRequest and permissions.removeHostAccessRequest, since the "host" term is more commonly used in other APIs and extension surfaces (such as "host_permissions" in the manifest). This CL renames the API function and corresponding C++ classes and methods. Since the API was only released in M133 (which is still pre-stable), this shouldn't be a breaking change for any published extensions. [1] https://github.com/w3c/webextensions/pull/529#issuecomment-2492042845 Fixed: 380291902 Change-Id: I38f118caba94526336ddbbfe89bea34ce42fd500 Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/6039497 Reviewed-by: Oliver Dunk <oliverdunk@chromium.org> Commit-Queue: Devlin Cronin <rdevlin.cronin@chromium.org> Reviewed-by: Kelvin Jiang <kelvinjiang@chromium.org> Cr-Commit-Position: refs/heads/main@{#1387925}
113 lines
4.6 KiB
C++
113 lines
4.6 KiB
C++
// 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 EXTENSIONS_BROWSER_HOST_ACCESS_REQUEST_HELPER_H_
|
|
#define EXTENSIONS_BROWSER_HOST_ACCESS_REQUEST_HELPER_H_
|
|
|
|
#include "base/scoped_observation.h"
|
|
#include "content/public/browser/web_contents_observer.h"
|
|
#include "extensions/browser/extension_registry_observer.h"
|
|
#include "extensions/common/extension.h"
|
|
#include "extensions/common/extension_id.h"
|
|
#include "extensions/common/url_pattern.h"
|
|
|
|
namespace content {
|
|
class WebContents;
|
|
} // namespace content
|
|
|
|
namespace extensions {
|
|
|
|
class PermissionsManager;
|
|
|
|
// Per-tab helper that stores extension's site access requests and restores
|
|
// them on cross-origin navigations.
|
|
// This class should only be used by PermissionsManager since it's an
|
|
// implementation detail that was pulled out for legibility.
|
|
class HostAccessRequestsHelper : public ExtensionRegistryObserver,
|
|
public content::WebContentsObserver {
|
|
public:
|
|
using PassKey = base::PassKey<PermissionsManager>;
|
|
|
|
HostAccessRequestsHelper(PassKey pass_key,
|
|
PermissionsManager* permissions_manager,
|
|
content::WebContents* web_contents,
|
|
int tab_id);
|
|
HostAccessRequestsHelper(const HostAccessRequestsHelper&) = delete;
|
|
const HostAccessRequestsHelper& operator=(const HostAccessRequestsHelper&) =
|
|
delete;
|
|
~HostAccessRequestsHelper() override;
|
|
|
|
// Adds `extension` to the set of extensions with site access requests.
|
|
// Request will be matched to `filter`, if existent. Extension must not have
|
|
// granted access to the current site.
|
|
void AddRequest(const Extension& extension,
|
|
const std::optional<URLPattern>& filter);
|
|
|
|
// Updates the site access request entry for `extension`. Request will be
|
|
// matched to `filter, if existent.
|
|
void UpdateRequest(const Extension& extension,
|
|
const std::optional<URLPattern>& filter);
|
|
|
|
// Removes `extension_id` from the set of extensions with site access
|
|
// requests. Request will be matches to `filter`, if existent. Returns whether
|
|
// request was removed.
|
|
bool RemoveRequest(const ExtensionId& extension_id,
|
|
const std::optional<URLPattern>& filter);
|
|
|
|
// Removes `extension` from the set of extensions with site access requests
|
|
// iff extension has granted access to the current site. Returns whether
|
|
// request was removed.
|
|
bool RemoveRequestIfGrantedAccess(const Extension& extension);
|
|
|
|
// Adds `extension_id` to the set of extension with site access requests that
|
|
// have been dismissed by the user. Request must be existent in
|
|
// `extensions_with_requests_` for user to be able to dismiss it.
|
|
// An extension's request cannot be undismissed by the user. Requests will be
|
|
// reset on cross-origin navigation, along with their dismissals if existent.
|
|
void UserDismissedRequest(const ExtensionId& extension_id);
|
|
|
|
// Returns whether `extension_id` has a site access request for this tab.
|
|
bool HasRequest(const ExtensionId& extension_id) const;
|
|
|
|
// Returns whether `extension_id` has a site access request that has not been
|
|
// dismissed by the user and matches the URLPattern filter, if existent.
|
|
bool HasActiveRequest(const ExtensionId& extension_id) const;
|
|
|
|
// Returns whether helper has any site access requests.
|
|
bool HasRequests();
|
|
|
|
private:
|
|
// ExtensionRegistryObserver:
|
|
void OnExtensionUnloaded(content::BrowserContext* browser_context,
|
|
const Extension* extension,
|
|
UnloadedExtensionReason reason) override;
|
|
|
|
// content::WebContentsObserver:
|
|
void DidFinishNavigation(
|
|
content::NavigationHandle* navigation_handle) override;
|
|
void WebContentsDestroyed() override;
|
|
|
|
// PermissionsManager owns this object, thus `permissions_manager_` will
|
|
// always be valid.
|
|
raw_ptr<PermissionsManager> permissions_manager_;
|
|
raw_ptr<content::WebContents> web_contents_;
|
|
int tab_id_;
|
|
|
|
// Extensions that have a site access request on this tab's origin. If pattern
|
|
// is provided, request will only be shown for URLs that match it.
|
|
std::map<ExtensionId, std::optional<URLPattern>> extensions_with_requests_;
|
|
|
|
// Extensions that have a site access request for this tab's origin which was
|
|
// dismissed by the user.
|
|
std::set<ExtensionId> extensions_with_requests_dismissed_;
|
|
|
|
base::ScopedObservation<extensions::ExtensionRegistry,
|
|
extensions::ExtensionRegistryObserver>
|
|
extension_registry_observation_{this};
|
|
};
|
|
|
|
} // namespace extensions
|
|
|
|
#endif // EXTENSIONS_BROWSER_HOST_ACCESS_REQUEST_HELPER_H_
|