content/browser/permissions/permission_service_context.h

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

#ifndef CONTENT_BROWSER_PERMISSIONS_PERMISSION_SERVICE_CONTEXT_H_
#define CONTENT_BROWSER_PERMISSIONS_PERMISSION_SERVICE_CONTEXT_H_

#include <memory>
#include <optional>
#include <unordered_map>

#include "base/memory/raw_ptr.h"
#include "content/public/browser/document_user_data.h"
#include "content/public/browser/permission_controller.h"
#include "content/public/browser/render_process_host_observer.h"
#include "mojo/public/cpp/bindings/pending_receiver.h"
#include "mojo/public/cpp/bindings/pending_remote.h"
#include "mojo/public/cpp/bindings/unique_receiver_set.h"
#include "third_party/blink/public/mojom/permissions/permission.mojom.h"
#include "url/gurl.h"

namespace blink {
enum class PermissionType;
}

namespace url {
class Origin;
}

namespace content {

class BrowserContext;
class PermissionServiceContextTest;
class RenderFrameHost;
class RenderProcessHost;

// Provides information to a PermissionService. It is used by the
// PermissionServiceImpl to handle request permission UI.
// There is one PermissionServiceContext per RenderFrameHost/RenderProcessHost
// which owns it. It then owns all PermissionServiceImpl associated to their
// owner.
//
// PermissionServiceContext instances associated with a RenderFrameHost must be
// created via the DocumentUserData static factories, as these
// instances are deleted when a new document is committed.
class CONTENT_EXPORT PermissionServiceContext
    : public RenderProcessHostObserver {
 public:
  explicit PermissionServiceContext(RenderProcessHost* render_process_host);
  PermissionServiceContext(const PermissionServiceContext&) = delete;
  PermissionServiceContext& operator=(const PermissionServiceContext&) = delete;
  ~PermissionServiceContext() override;

  // Return PermissionServiceContext associated with the current document in the
  // given RenderFrameHost, lazily creating one, if needed.
  static PermissionServiceContext* GetOrCreateForCurrentDocument(
      RenderFrameHost* render_frame_host);

  // Return PermissionServiceContext associated with the current document.
  // Return null if there's no associated one.
  static PermissionServiceContext* GetForCurrentDocument(
      RenderFrameHost* render_frame_host);

  void CreateService(
      mojo::PendingReceiver<blink::mojom::PermissionService> receiver);
  void CreateServiceForWorker(
      const url::Origin& origin,
      mojo::PendingReceiver<blink::mojom::PermissionService> receiver);

  void CreateSubscription(
      const blink::mojom::PermissionDescriptorPtr& permission,
      const url::Origin& origin,
      PermissionStatus current_status,
      PermissionStatus last_known_status,
      bool should_include_device_status,
      mojo::PendingRemote<blink::mojom::PermissionObserver> observer);

  // Called when the connection to a PermissionObserver has an error.
  void ObserverHadConnectionError(
      PermissionController::SubscriptionId subscription_id);

  // May return nullptr during teardown, or when showing an interstitial.
  BrowserContext* GetBrowserContext() const;

  std::optional<GURL> GetEmbeddingOrigin() const;

  RenderFrameHost* render_frame_host() const { return render_frame_host_; }
  RenderProcessHost* render_process_host() const {
    return render_process_host_;
  }

  // RenderProcessHostObserver:
  void RenderProcessHostDestroyed(RenderProcessHost* host) override;

  void StoreStatusAtBFCacheEntry();
  void NotifyPermissionStatusChangedIfNeeded();

  std::set<blink::PermissionType>& GetOnchangeEventListeners() {
    return onchange_event_listeners_;
  }

 private:
  class PermissionSubscription;
  struct DocumentPermissionServiceContextHolder;
  friend class PermissionServiceContextTest;

  // Use DocumentUserData static methods to create instances attached
  // to a RenderFrameHost.
  explicit PermissionServiceContext(RenderFrameHost* render_frame_host);

  const raw_ptr<RenderFrameHost> render_frame_host_;
  const raw_ptr<RenderProcessHost> render_process_host_;
  mojo::UniqueReceiverSet<blink::mojom::PermissionService> services_;
  std::unordered_map<PermissionController::SubscriptionId,
                     std::unique_ptr<PermissionSubscription>>
      subscriptions_;

  std::set<blink::PermissionType> onchange_event_listeners_;
};

}  // namespace content

#endif  // CONTENT_BROWSER_PERMISSIONS_PERMISSION_SERVICE_CONTEXT_H_