blob: f220ac21fbd163ec9e4b651c040ba5e605381bb5 [file] [log] [blame]
// 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.
#include <map>
#include <string>
#include "base/compiler_specific.h"
#include "extensions/browser/extension_registry_observer.h"
namespace extensions {
class ExtensionRegistry;
// Contains per-extension data that can change during the life of the process,
// but does not persist across restarts. Shared between incognito and regular
// browser contexts. Lives on the UI thread. Must be destroyed before
// ExtensionRegistry.
// If we start putting to much into this, we should expose the generic
// "[G|S]etRuntimeProperty(const std::string& extension_id, RuntimeFlag flag)"
// instead of all these.
class RuntimeData : public ExtensionRegistryObserver {
// Observes |registry| to clean itself up when extensions change state.
// |registry| must not be NULL.
explicit RuntimeData(ExtensionRegistry* registry);
~RuntimeData() override;
// Whether the persistent background page, if any, is ready. We don't load
// other components until then. If there is no background page, or if it is
// non-persistent (lazy), we consider it to be ready.
bool IsBackgroundPageReady(const Extension* extension) const;
void SetBackgroundPageReady(const std::string& extension_id, bool value);
// Getter and setter for the flag that specifies whether the extension is
// being upgraded.
// For these purposes, a reload counts as an upgrade.
bool IsBeingUpgraded(const std::string& extension_id) const;
void SetBeingUpgraded(const std::string& extension_id, bool value);
// Returns true if the extension is being tracked. Used only for testing.
bool HasExtensionForTesting(const std::string& extension_id) const;
// Erase runtime data for all extensions. Used only for testing. Cannot be
// named ClearAllForTesting due to false-positive presubmit errors.
void ClearAll();
// ExtensionRegistryObserver overrides. Public for testing.
void OnExtensionUnloaded(content::BrowserContext* browser_context,
const Extension* extension,
UnloadedExtensionReason reason) override;
// Bitmasks for runtime states.
enum RuntimeFlag {
// Set if the background page is ready.
// Set while the extension is being upgraded.
// The mask of any data that should persist across the extension being
// unloaded.
static const int kPersistAcrossUnloadMask = BEING_UPGRADED;
// Returns the setting for the flag or false if the extension isn't found.
bool HasFlag(const std::string& extension_id, RuntimeFlag flag) const;
// Sets |flag| for |extension| to |value|. Adds |extension| to the list of
// extensions if it isn't present.
void SetFlag(const std::string& extension_id, RuntimeFlag flag, bool value);
// Map from extension ID to the RuntimeFlags bits.
typedef std::map<std::string, int> ExtensionFlagsMap;
ExtensionFlagsMap extension_flags_;
ExtensionRegistry* registry_; // Not owned.
} // namespace extensions