cef/libcef/browser/extensions/extension_system.h

// Copyright 2015 The Chromium Embedded Framework Authors.
// Portions copyright 2014 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 CEF_LIBCEF_BROWSER_EXTENSIONS_EXTENSION_SYSTEM_H_
#define CEF_LIBCEF_BROWSER_EXTENSIONS_EXTENSION_SYSTEM_H_

#include <map>
#include <memory>

#include "include/cef_extension_handler.h"
#include "include/cef_request_context.h"

#include "base/compiler_specific.h"
#include "base/memory/weak_ptr.h"
#include "base/one_shot_event.h"
#include "extensions/browser/extension_system.h"

class BrowserContextKeyedServiceFactory;

namespace base {
class DictionaryValue;
class FilePath;
}  // namespace base

namespace content {
class BrowserContext;
}

namespace extensions {

class ExtensionRegistry;
class InfoMap;
class ProcessManager;
class RendererStartupHelper;
class SharedUserScriptMaster;
class ValueStoreFactory;

// Used to manage extensions.
class CefExtensionSystem : public ExtensionSystem {
 public:
  explicit CefExtensionSystem(content::BrowserContext* browser_context);
  ~CefExtensionSystem() override;

  // Initializes the extension system.
  void Init();

  // Load an extension. For internal (built-in) extensions set |internal| to
  // true and |loader_context| and |handler| to NULL. For external extensions
  // set |internal| to false and |loader_context| must be the request context
  // that loaded the extension. |handler| is optional for internal extensions
  // and, if specified, will receive extension-related callbacks.
  void LoadExtension(const base::FilePath& root_directory,
                     bool internal,
                     CefRefPtr<CefRequestContext> loader_context,
                     CefRefPtr<CefExtensionHandler> handler);
  void LoadExtension(const std::string& manifest_contents,
                     const base::FilePath& root_directory,
                     bool internal,
                     CefRefPtr<CefRequestContext> loader_context,
                     CefRefPtr<CefExtensionHandler> handler);
  void LoadExtension(std::unique_ptr<base::DictionaryValue> manifest,
                     const base::FilePath& root_directory,
                     bool internal,
                     CefRefPtr<CefRequestContext> loader_context,
                     CefRefPtr<CefExtensionHandler> handler);

  // Unload the external extension identified by |extension_id|.
  bool UnloadExtension(const std::string& extension_id);

  // Returns true if an extension matching |extension_id| is loaded.
  bool HasExtension(const std::string& extension_id) const;

  // Returns the loaded extention matching |extension_id| or NULL if not found.
  CefRefPtr<CefExtension> GetExtension(const std::string& extension_id) const;

  using ExtensionMap = std::map<std::string, CefRefPtr<CefExtension>>;

  // Returns the map of all loaded extensions.
  ExtensionMap GetExtensions() const;

  // Called when a request context is deleted. Unregisters any external
  // extensions that were registered with this context.
  void OnRequestContextDeleted(CefRequestContext* context);

  // KeyedService implementation:
  void Shutdown() override;

  // ExtensionSystem implementation:
  void InitForRegularProfile(bool extensions_enabled) override;
  ExtensionService* extension_service() override;
  RuntimeData* runtime_data() override;
  ManagementPolicy* management_policy() override;
  ServiceWorkerManager* service_worker_manager() override;
  SharedUserScriptMaster* shared_user_script_master() override;
  StateStore* state_store() override;
  StateStore* rules_store() override;
  scoped_refptr<ValueStoreFactory> store_factory() override;
  InfoMap* info_map() override;
  QuotaService* quota_service() override;
  AppSorting* app_sorting() override;
  void RegisterExtensionWithRequestContexts(
      const Extension* extension,
      base::OnceClosure callback) override;
  void UnregisterExtensionWithRequestContexts(
      const std::string& extension_id,
      const UnloadedExtensionReason reason) override;
  const base::OneShotEvent& ready() const override;
  ContentVerifier* content_verifier() override;
  std::unique_ptr<ExtensionSet> GetDependentExtensions(
      const Extension* extension) override;
  void InstallUpdate(const std::string& extension_id,
                     const std::string& public_key,
                     const base::FilePath& temp_dir,
                     bool install_immediately,
                     InstallUpdateCallback install_update_callback) override;
  bool FinishDelayedInstallationIfReady(const std::string& extension_id,
                                        bool install_immediately) override;

  bool initialized() const { return initialized_; }

 private:
  virtual void InitPrefs();

  // Information about a registered component extension.
  struct ComponentExtensionInfo {
    ComponentExtensionInfo(const base::DictionaryValue* manifest,
                           const base::FilePath& root_directory,
                           bool internal);

    // The parsed contents of the extensions's manifest file.
    const base::DictionaryValue* manifest;

    // Directory where the extension is stored.
    base::FilePath root_directory;

    // True if the extension is an internal (built-in) component.
    bool internal;
  };

  scoped_refptr<const Extension> CreateExtension(
      const ComponentExtensionInfo& info,
      std::string* utf8_error);

  // Loads a registered component extension.
  const Extension* LoadExtension(const ComponentExtensionInfo& info,
                                 CefRefPtr<CefRequestContext> loader_context,
                                 CefRefPtr<CefExtensionHandler> handler);

  // Unload the specified extension.
  void UnloadExtension(const std::string& extension_id,
                       extensions::UnloadedExtensionReason reason);

  // Handles sending notification that |extension| was loaded.
  void NotifyExtensionLoaded(const Extension* extension);

  // Handles sending notification that |extension| was unloaded.
  void NotifyExtensionUnloaded(const Extension* extension,
                               UnloadedExtensionReason reason);

  // Completes extension loading after URLRequestContexts have been updated
  // on the IO thread.
  void OnExtensionRegisteredWithRequestContexts(
      scoped_refptr<const extensions::Extension> extension);

  content::BrowserContext* browser_context_;  // Not owned.

  bool initialized_;

  // Data to be accessed on the IO thread. Must outlive process_manager_.
  scoped_refptr<InfoMap> info_map_;

  std::unique_ptr<ServiceWorkerManager> service_worker_manager_;
  std::unique_ptr<RuntimeData> runtime_data_;
  std::unique_ptr<QuotaService> quota_service_;
  std::unique_ptr<AppSorting> app_sorting_;

  std::unique_ptr<StateStore> state_store_;
  std::unique_ptr<StateStore> rules_store_;
  scoped_refptr<ValueStoreFactory> store_factory_;

  // Signaled when the extension system has completed its startup tasks.
  base::OneShotEvent ready_;

  // Sets of enabled/disabled/terminated/blacklisted extensions. Not owned.
  ExtensionRegistry* registry_;

  // The associated RendererStartupHelper. Guaranteed to outlive the
  // ExtensionSystem, and thus us.
  extensions::RendererStartupHelper* renderer_helper_;

  // Map of extension ID to CEF extension object.
  ExtensionMap extension_map_;

  // Must be the last member.
  base::WeakPtrFactory<CefExtensionSystem> weak_ptr_factory_;

  DISALLOW_COPY_AND_ASSIGN(CefExtensionSystem);
};

}  // namespace extensions

#endif  // CEF_LIBCEF_BROWSER_EXTENSIONS_EXTENSION_SYSTEM_H_