components/page_info/page_info_delegate.h

// Copyright 2020 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef COMPONENTS_PAGE_INFO_PAGE_INFO_DELEGATE_H_
#define COMPONENTS_PAGE_INFO_PAGE_INFO_DELEGATE_H_

#include <optional>
#include <string>

#include "build/build_config.h"
#include "components/content_settings/browser/page_specific_content_settings.h"
#include "components/content_settings/core/common/content_settings_types.h"
#include "components/page_info/page_info.h"
#include "components/permissions/permission_uma_util.h"
#include "components/safe_browsing/buildflags.h"
#include "components/safe_browsing/core/browser/password_protection/metrics_util.h"
#include "components/security_state/core/security_state.h"
#include "content/public/browser/permission_result.h"

namespace blink {
enum class PermissionType;
}

namespace permissions {
class ObjectPermissionContextBase;
class PermissionDecisionAutoBlocker;
}  // namespace permissions

namespace safe_browsing {
class PasswordProtectionService;
}  // namespace safe_browsing

namespace ui {
class Event;
}  // namespace ui

namespace url {
class Origin;
}

class HostContentSettingsMap;
class StatefulSSLHostStateDelegate;

// PageInfoDelegate allows an embedder to customize PageInfo logic.
class PageInfoDelegate {
 public:
  virtual ~PageInfoDelegate() = default;

  // Return the |ObjectPermissionContextBase| corresponding to the content
  // settings type, |type|. Returns a nullptr for content settings for which
  // there's no ObjectPermissionContextBase.
  virtual permissions::ObjectPermissionContextBase* GetChooserContext(
      ContentSettingsType type) = 0;

#if BUILDFLAG(FULL_SAFE_BROWSING)
  // Helper methods requiring access to PasswordProtectionService.
  virtual safe_browsing::PasswordProtectionService*
  GetPasswordProtectionService() const = 0;
  virtual void OnUserActionOnPasswordUi(
      safe_browsing::WarningAction action) = 0;
  virtual std::u16string GetWarningDetailText() = 0;
#endif
  // Get permission status for the permission associated with ContentSetting of
  // type |type|.
  virtual content::PermissionResult GetPermissionResult(
      blink::PermissionType permission,
      const url::Origin& origin,
      const std::optional<url::Origin>& requesting_origin) = 0;
#if !BUILDFLAG(IS_ANDROID)
  // Returns std::nullopt if `site_url` is not recognised as a member of any
  // RWS or if RWS functionality is not allowed .
  virtual std::optional<std::u16string> GetRwsOwner(const GURL& site_url) = 0;
  virtual bool IsRwsManaged(const GURL& site_url) = 0;

  // Creates an infobars::ContentInfoBarManager and an InfoBarDelegate using it,
  // if possible. Returns true if an InfoBarDelegate was created, false
  // otherwise.
  virtual bool CreateInfoBarDelegate() = 0;

  virtual std::unique_ptr<content_settings::CookieControlsController>
  CreateCookieControlsController() = 0;

  virtual bool IsIsolatedWebApp() = 0;
  virtual void ShowSiteSettings(const GURL& site_url) = 0;
  virtual void ShowCookiesSettings() = 0;
  virtual void ShowIncognitoSettings() = 0;
  virtual void ShowAllSitesSettingsFilteredByRwsOwner(
      const std::u16string& rws_owner) = 0;
  virtual void ShowSyncSettings() = 0;
  virtual void OpenCookiesDialog() = 0;
  virtual void OpenCertificateDialog(net::X509Certificate* certificate) = 0;
  virtual void OpenConnectionHelpCenterPage(const ui::Event& event) = 0;
  virtual void OpenSafetyTipHelpCenterPage() = 0;
  virtual void OpenSafeBrowsingHelpCenterPage(const ui::Event& event) = 0;
  virtual void OpenContentSettingsExceptions(
      ContentSettingsType content_settings_type) = 0;
  virtual void OnPageInfoActionOccurred(page_info::PageInfoAction action) = 0;
  virtual void OnUIClosing() = 0;
#endif

  virtual std::u16string GetSubjectName(const GURL& url) = 0;

  virtual permissions::PermissionDecisionAutoBlocker*
  GetPermissionDecisionAutoblocker() = 0;

  // Service for managing SSL error page bypasses. Used to revoke bypass
  // decisions by users.
  virtual StatefulSSLHostStateDelegate* GetStatefulSSLHostStateDelegate() = 0;

  // The |HostContentSettingsMap| is the service that provides and manages
  // content settings (aka. site permissions).
  virtual HostContentSettingsMap* GetContentSettings() = 0;

  // The subresource filter service determines whether ads should be blocked on
  // the site and relevant permission prompts should be shown respectively.
  virtual bool IsSubresourceFilterActivated(const GURL& site_url) = 0;

  // True if the site has registered for auto picture-in-picture.
  virtual bool HasAutoPictureInPictureBeenRegistered() = 0;

  virtual std::unique_ptr<
      content_settings::PageSpecificContentSettings::Delegate>
  GetPageSpecificContentSettingsDelegate() = 0;

  virtual bool IsContentDisplayedInVrHeadset() = 0;
  virtual security_state::SecurityLevel GetSecurityLevel() = 0;
  virtual security_state::VisibleSecurityState GetVisibleSecurityState() = 0;
  virtual void OnCookiesPageOpened() = 0;
#if BUILDFLAG(IS_ANDROID)
  // Gets the name of the embedder.
  virtual const std::u16string GetClientApplicationName() = 0;
#endif
  virtual bool IsHttpsFirstModeEnabled() = 0;
  virtual bool IsIncognitoProfile() = 0;
};

#endif  // COMPONENTS_PAGE_INFO_PAGE_INFO_DELEGATE_H_