content/child/permissions/permission_dispatcher.h

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

#ifndef CONTENT_CHILD_PERMISSIONS_PERMISSION_DISPATCHER_H_
#define CONTENT_CHILD_PERMISSIONS_PERMISSION_DISPATCHER_H_

#include <memory>
#include <string>

#include "base/callback_forward.h"
#include "base/containers/scoped_ptr_hash_map.h"
#include "base/macros.h"
#include "content/child/permissions/permission_observers_registry.h"
#include "third_party/WebKit/public/platform/modules/permissions/WebPermissionClient.h"
#include "third_party/WebKit/public/platform/modules/permissions/permission.mojom.h"

namespace content {

class ServiceRegistry;

// The PermissionDispatcher is a layer between Blink and the Mojo
// PermissionService. It implements blink::WebPermissionClient. It is being used
// from workers and frames independently. When called outside of the main
// thread, QueryPermissionForWorker is meant to be called. It will handle the
// thread jumping.
class PermissionDispatcher : public blink::WebPermissionClient,
                             public PermissionObserversRegistry {
 public:
  // Returns whether the given WebPermissionType is observable. Some types have
  // static values that never changes.
  static bool IsObservable(blink::WebPermissionType type);

  // The caller must guarantee that |service_registry| will have a lifetime
  // larger than this instance of PermissionDispatcher.
  explicit PermissionDispatcher(ServiceRegistry* service_registry);
  ~PermissionDispatcher() override;

  // blink::WebPermissionClient implementation.
  void queryPermission(blink::WebPermissionType type,
                       const blink::WebURL& origin,
                       blink::WebPermissionCallback* callback) override;
  void requestPermission(blink::WebPermissionType,
                         const blink::WebURL& origin,
                         blink::WebPermissionCallback* callback) override;
  void requestPermissions(
      const blink::WebVector<blink::WebPermissionType>& types,
      const blink::WebURL& origin,
      blink::WebPermissionsCallback* callback) override;
  void revokePermission(blink::WebPermissionType,
                        const blink::WebURL& origin,
                        blink::WebPermissionCallback* callback) override;
  void startListening(blink::WebPermissionType type,
                      const blink::WebURL& origin,
                      blink::WebPermissionObserver* observer) override;
  void stopListening(blink::WebPermissionObserver* observer) override;

  // The following methods must be called by workers on the main thread.
  void QueryPermissionForWorker(blink::WebPermissionType type,
                                const std::string& origin,
                                blink::WebPermissionCallback* callback,
                                int worker_thread_id);
  void RequestPermissionForWorker(blink::WebPermissionType type,
                                  const std::string& origin,
                                  blink::WebPermissionCallback* callback,
                                  int worker_thread_id);
  void RequestPermissionsForWorker(
      const blink::WebVector<blink::WebPermissionType>& types,
      const std::string& origin,
      blink::WebPermissionsCallback* callback,
      int worker_thread_id);
  void RevokePermissionForWorker(blink::WebPermissionType type,
                                 const std::string& origin,
                                 blink::WebPermissionCallback* callback,
                                 int worker_thread_id);
  void StartListeningForWorker(
      blink::WebPermissionType type,
      const std::string& origin,
      int worker_thread_id,
      const base::Callback<void(blink::WebPermissionStatus)>& callback);
  void GetNextPermissionChangeForWorker(
      blink::WebPermissionType type,
      const std::string& origin,
      blink::WebPermissionStatus status,
      int worker_thread_id,
      const base::Callback<void(blink::WebPermissionStatus)>& callback);

 private:
  using PermissionCallbackMap =
      base::ScopedPtrHashMap<uintptr_t,
                             std::unique_ptr<blink::WebPermissionCallback>>;
  using PermissionsCallbackMap =
      base::ScopedPtrHashMap<uintptr_t,
                             std::unique_ptr<blink::WebPermissionsCallback>>;

  // Runs the given |callback| with |status| as a parameter. It has to be run
  // on a worker thread.
  static void RunPermissionCallbackOnWorkerThread(
      std::unique_ptr<blink::WebPermissionCallback> callback,
      blink::WebPermissionStatus status);
  static void RunPermissionsCallbackOnWorkerThread(
      std::unique_ptr<blink::WebPermissionsCallback> callback,
      std::unique_ptr<blink::WebVector<blink::WebPermissionStatus>> statuses);

  // Helper method that returns an initialized PermissionServicePtr.
  blink::mojom::PermissionService* GetPermissionServicePtr();

  void QueryPermissionInternal(blink::WebPermissionType type,
                               const std::string& origin,
                               blink::WebPermissionCallback* callback,
                               int worker_thread_id);
  void RequestPermissionInternal(blink::WebPermissionType type,
                                const std::string& origin,
                                blink::WebPermissionCallback* callback,
                                int worker_thread_id);
  void RequestPermissionsInternal(
      const blink::WebVector<blink::WebPermissionType>& types,
      const std::string& origin,
      blink::WebPermissionsCallback* callback,
      int worker_thread_id);
  void RevokePermissionInternal(blink::WebPermissionType type,
                                const std::string& origin,
                                blink::WebPermissionCallback* callback,
                                int worker_thread_id);

  // This is the callback function used for query, request and revoke.
  void OnPermissionResponse(int worker_thread_id,
                            uintptr_t callback_key,
                            blink::mojom::PermissionStatus status);
  void OnRequestPermissionsResponse(
      int worker_thread_id,
      uintptr_t callback_key,
      const mojo::Array<blink::mojom::PermissionStatus>& status);
  void OnPermissionChanged(blink::WebPermissionType type,
                           const std::string& origin,
                           blink::WebPermissionObserver* observer,
                           blink::mojom::PermissionStatus status);
  void OnPermissionChangedForWorker(
      int worker_thread_id,
      const base::Callback<void(blink::WebPermissionStatus)>& callback,
      blink::mojom::PermissionStatus status);

  void GetNextPermissionChange(blink::WebPermissionType type,
                               const std::string& origin,
                               blink::WebPermissionObserver* observer,
                               blink::mojom::PermissionStatus current_status);

  // Pending callbacks for query(), revoke() and request() single permission.
  PermissionCallbackMap permission_callbacks_;

  // Pending callbacks for request() multiple permissions.
  PermissionsCallbackMap permissions_callbacks_;

  ServiceRegistry* service_registry_;
  blink::mojom::PermissionServicePtr permission_service_;

  DISALLOW_COPY_AND_ASSIGN(PermissionDispatcher);
};

}  // namespace content

#endif // CONTENT_CHILD_PERMISSIONS_PERMISSION_DISPATCHER_H_