1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276
|
// 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.
#include "chrome/browser/extensions/extension_action_storage_manager.h"
#include <stdint.h>
#include <memory>
#include <utility>
#include "base/base64.h"
#include "base/functional/bind.h"
#include "base/strings/string_number_conversions.h"
#include "base/values.h"
#include "extensions/browser/extension_action_manager.h"
#include "extensions/browser/extension_registry.h"
#include "extensions/browser/extension_system.h"
#include "extensions/browser/state_store.h"
#include "extensions/common/constants.h"
#include "extensions/common/extension_id.h"
#include "ui/gfx/codec/png_codec.h"
#include "ui/gfx/image/image.h"
#include "ui/gfx/image/image_skia.h"
#include "ui/gfx/image/image_skia_rep.h"
namespace extensions {
namespace {
const char kBrowserActionStorageKey[] = "browser_action";
const char kPopupUrlStorageKey[] = "poupup_url";
const char kTitleStorageKey[] = "title";
const char kIconStorageKey[] = "icon";
const char kBadgeTextStorageKey[] = "badge_text";
const char kBadgeBackgroundColorStorageKey[] = "badge_background_color";
const char kBadgeTextColorStorageKey[] = "badge_text_color";
const char kAppearanceStorageKey[] = "appearance";
// Only add values to the end of this enum, since it's stored in the user's
// Extension State, under the kAppearanceStorageKey. It represents the
// ExtensionAction's default visibility.
enum StoredAppearance {
// The action icon is hidden.
INVISIBLE = 0,
// The action is trying to get the user's attention but isn't yet
// running on the page. Was only used for script badges.
OBSOLETE_WANTS_ATTENTION = 1,
// The action icon is visible with its normal appearance.
ACTIVE = 2,
};
// Conversion function for reading/writing to storage.
SkColor RawStringToSkColor(const std::string& str) {
uint64_t value = 0;
base::StringToUint64(str, &value);
SkColor color = static_cast<SkColor>(value);
DCHECK(value == color); // ensure value fits into color's 32 bits
return color;
}
// Conversion function for reading/writing to storage.
std::string SkColorToRawString(SkColor color) {
return base::NumberToString(color);
}
// Conversion function for reading/writing to storage.
SkBitmap StringToSkBitmap(const std::string& str) {
std::optional<std::vector<uint8_t>> decoded = base::Base64Decode(str);
if (!decoded) {
return SkBitmap();
}
return gfx::PNGCodec::Decode(decoded.value());
}
// Conversion function for reading/writing to storage.
std::string BitmapToString(const SkBitmap& bitmap) {
std::optional<std::vector<uint8_t>> data =
gfx::PNGCodec::EncodeBGRASkBitmap(bitmap, /*discard_transparency=*/false);
if (!data) {
return std::string();
}
return base::Base64Encode(data.value());
}
// Set |action|'s default values to those specified in |dict|.
void SetDefaultsFromValue(const base::Value::Dict& dict,
ExtensionAction* action) {
const int kDefaultTabId = ExtensionAction::kDefaultTabId;
// For each value, don't set it if it has been modified already.
const std::string* popup_url = dict.FindString(kPopupUrlStorageKey);
if (popup_url && !action->HasPopupUrl(kDefaultTabId)) {
action->SetPopupUrl(kDefaultTabId, GURL(*popup_url));
}
const std::string* title = dict.FindString(kTitleStorageKey);
if (title && !action->HasTitle(kDefaultTabId)) {
action->SetTitle(kDefaultTabId, *title);
}
const std::string* badge_text = dict.FindString(kBadgeTextStorageKey);
if (badge_text && !action->HasBadgeText(kDefaultTabId)) {
action->SetBadgeText(kDefaultTabId, *badge_text);
}
const std::string* badge_background_color =
dict.FindString(kBadgeBackgroundColorStorageKey);
if (badge_background_color &&
!action->HasBadgeBackgroundColor(kDefaultTabId)) {
action->SetBadgeBackgroundColor(
kDefaultTabId, RawStringToSkColor(*badge_background_color));
}
const std::string* badge_text_color =
dict.FindString(kBadgeTextColorStorageKey);
if (badge_text_color && !action->HasBadgeTextColor(kDefaultTabId)) {
action->SetBadgeTextColor(kDefaultTabId,
RawStringToSkColor(*badge_text_color));
}
std::optional<int> appearance_storage = dict.FindInt(kAppearanceStorageKey);
if (appearance_storage && !action->HasIsVisible(kDefaultTabId)) {
switch (*appearance_storage) {
case INVISIBLE:
case OBSOLETE_WANTS_ATTENTION:
action->SetIsVisible(kDefaultTabId, false);
break;
case ACTIVE:
action->SetIsVisible(kDefaultTabId, true);
break;
}
}
const base::Value::Dict* icon_dict = dict.FindDict(kIconStorageKey);
if (icon_dict && !action->HasIcon(kDefaultTabId)) {
gfx::ImageSkia icon;
for (const auto iter : *icon_dict) {
int icon_size = 0;
if (base::StringToInt(iter.first, &icon_size) &&
iter.second.is_string()) {
SkBitmap bitmap = StringToSkBitmap(iter.second.GetString());
if (!bitmap.isNull()) {
float scale =
static_cast<float>(icon_size) / ExtensionAction::ActionIconSize();
icon.AddRepresentation(gfx::ImageSkiaRep(bitmap, scale));
}
}
}
action->SetIcon(kDefaultTabId, gfx::Image(icon));
}
}
// Store |action|'s default values in a base::Value::Dict for use in storing to
// disk.
base::Value::Dict DefaultsToValue(ExtensionAction* action) {
const int kDefaultTabId = ExtensionAction::kDefaultTabId;
base::Value::Dict dict;
dict.Set(kPopupUrlStorageKey, action->GetPopupUrl(kDefaultTabId).spec());
dict.Set(kTitleStorageKey, action->GetTitle(kDefaultTabId));
dict.Set(kBadgeTextStorageKey,
action->GetExplicitlySetBadgeText(kDefaultTabId));
dict.Set(kBadgeBackgroundColorStorageKey,
SkColorToRawString(action->GetBadgeBackgroundColor(kDefaultTabId)));
dict.Set(kBadgeTextColorStorageKey,
SkColorToRawString(action->GetBadgeTextColor(kDefaultTabId)));
dict.Set(kAppearanceStorageKey,
action->GetIsVisible(kDefaultTabId) ? ACTIVE : INVISIBLE);
gfx::ImageSkia icon =
action->GetExplicitlySetIcon(kDefaultTabId).AsImageSkia();
if (!icon.isNull()) {
base::Value::Dict icon_value;
std::vector<gfx::ImageSkiaRep> image_reps = icon.image_reps();
for (const gfx::ImageSkiaRep& rep : image_reps) {
int size = static_cast<int>(rep.scale() * icon.width());
std::string size_string = base::NumberToString(size);
icon_value.Set(size_string, BitmapToString(rep.GetBitmap()));
}
dict.Set(kIconStorageKey, std::move(icon_value));
}
return dict;
}
} // namespace
ExtensionActionStorageManager::ExtensionActionStorageManager(
content::BrowserContext* context)
: browser_context_(context) {
extension_action_dispatcher_observation_.Observe(
ExtensionActionDispatcher::Get(browser_context_));
extension_registry_observation_.Observe(
ExtensionRegistry::Get(browser_context_));
StateStore* store = GetStateStore();
if (store)
store->RegisterKey(kBrowserActionStorageKey);
}
ExtensionActionStorageManager::~ExtensionActionStorageManager() = default;
void ExtensionActionStorageManager::OnExtensionLoaded(
content::BrowserContext* browser_context,
const Extension* extension) {
ExtensionAction* action = ExtensionActionManager::Get(browser_context_)
->GetExtensionAction(*extension);
if (!action || action->action_type() != ActionInfo::Type::kBrowser) {
return;
}
StateStore* store = GetStateStore();
if (store) {
store->GetExtensionValue(
extension->id(), kBrowserActionStorageKey,
base::BindOnce(&ExtensionActionStorageManager::ReadFromStorage,
weak_factory_.GetWeakPtr(), extension->id()));
}
}
void ExtensionActionStorageManager::OnExtensionActionUpdated(
ExtensionAction* extension_action,
content::WebContents* web_contents,
content::BrowserContext* browser_context) {
// This is an update to the default settings of the action iff |web_contents|
// is null. We only persist the default settings to disk, since per-tab
// settings can't be persisted across browser sessions.
bool for_default_tab = !web_contents;
if (browser_context_ == browser_context &&
extension_action->action_type() == ActionInfo::Type::kBrowser &&
for_default_tab) {
WriteToStorage(extension_action);
}
}
void ExtensionActionStorageManager::OnShuttingDown() {
extension_action_dispatcher_observation_.Reset();
}
void ExtensionActionStorageManager::WriteToStorage(
ExtensionAction* extension_action) {
StateStore* store = GetStateStore();
if (store) {
base::Value::Dict defaults = DefaultsToValue(extension_action);
store->SetExtensionValue(extension_action->extension_id(),
kBrowserActionStorageKey,
base::Value(std::move(defaults)));
}
}
void ExtensionActionStorageManager::ReadFromStorage(
const ExtensionId& extension_id,
std::optional<base::Value> value) {
const Extension* extension = ExtensionRegistry::Get(browser_context_)->
enabled_extensions().GetByID(extension_id);
if (!extension)
return;
ExtensionAction* action = ExtensionActionManager::Get(browser_context_)
->GetExtensionAction(*extension);
if (!action || action->action_type() != ActionInfo::Type::kBrowser) {
// This can happen if the extension is updated between startup and when the
// storage read comes back, and the update removes the browser action.
// http://crbug.com/349371
return;
}
if (!value || !value->is_dict())
return;
SetDefaultsFromValue(value->GetDict(), action);
}
StateStore* ExtensionActionStorageManager::GetStateStore() {
return ExtensionSystem::Get(browser_context_)->state_store();
}
} // namespace extensions
|