blob: 821f4c68b3a89fe3243af81f8ff44ba276fa112c [file] [log] [blame]
// Copyright (c) 2012 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 "chrome/browser/extensions/extension_action.h"
#include <algorithm>
#include <utility>
#include "base/base64.h"
#include "base/logging.h"
#include "base/strings/string_number_conversions.h"
#include "base/values.h"
#include "chrome/grit/theme_resources.h"
#include "extensions/browser/extension_icon_image.h"
#include "extensions/browser/extension_icon_placeholder.h"
#include "extensions/common/constants.h"
#include "extensions/common/extension_icon_set.h"
#include "extensions/common/manifest_handlers/icons_handler.h"
#include "ipc/ipc_message.h"
#include "ipc/ipc_message_utils.h"
#include "third_party/skia/include/core/SkBitmap.h"
#include "third_party/skia/include/core/SkCanvas.h"
#include "third_party/skia/include/core/SkPaint.h"
#include "third_party/skia/include/effects/SkGradientShader.h"
#include "ui/base/resource/resource_bundle.h"
#include "ui/gfx/animation/animation_delegate.h"
#include "ui/gfx/canvas.h"
#include "ui/gfx/color_utils.h"
#include "ui/gfx/geometry/rect.h"
#include "ui/gfx/geometry/size.h"
#include "ui/gfx/image/image.h"
#include "ui/gfx/image/image_skia.h"
#include "ui/gfx/image/image_skia_source.h"
#include "ui/gfx/ipc/skia/gfx_skia_param_traits.h"
#include "ui/gfx/skbitmap_operations.h"
#include "url/gurl.h"
namespace {
class GetAttentionImageSource : public gfx::ImageSkiaSource {
explicit GetAttentionImageSource(const gfx::ImageSkia& icon)
: icon_(icon) {}
// gfx::ImageSkiaSource overrides:
gfx::ImageSkiaRep GetImageForScale(float scale) override {
gfx::ImageSkiaRep icon_rep = icon_.GetRepresentation(scale);
color_utils::HSL shift = {-1, 0, 0.5};
return gfx::ImageSkiaRep(
SkBitmapOperations::CreateHSLShiftedBitmap(icon_rep.GetBitmap(), shift),
const gfx::ImageSkia icon_;
struct IconRepresentationInfo {
// Size as a string that will be used to retrieve a representation value from
// SetIcon function arguments.
const char* size_string;
// Scale factor for which the represantion should be used.
ui::ScaleFactor scale;
template <class T>
bool HasValue(const std::map<int, T>& map, int tab_id) {
return map.find(tab_id) != map.end();
} // namespace
// static
extension_misc::ExtensionIcons ExtensionAction::ActionIconSize() {
return extension_misc::EXTENSION_ICON_BITTY;
// static
gfx::Image ExtensionAction::FallbackIcon() {
return ui::ResourceBundle::GetSharedInstance().GetImageNamed(
const int ExtensionAction::kDefaultTabId = -1;
ExtensionAction::ExtensionAction(const extensions::Extension& extension,
extensions::ActionInfo::Type action_type,
const extensions::ActionInfo& manifest_data)
: extension_id_(,
action_type_(action_type) {
// Page/script actions are hidden/disabled by default, and browser actions are
// visible/enabled by default.
action_type == extensions::ActionInfo::TYPE_BROWSER);
Populate(extension, manifest_data);
ExtensionAction::~ExtensionAction() {
void ExtensionAction::SetPopupUrl(int tab_id, const GURL& url) {
// We store |url| even if it is empty, rather than removing a URL from the
// map. If an extension has a default popup, and removes it for a tab via
// the API, we must remember that there is no popup for that specific tab.
// If we removed the tab's URL, GetPopupURL would incorrectly return the
// default URL.
SetValue(&popup_url_, tab_id, url);
bool ExtensionAction::HasPopup(int tab_id) const {
return !GetPopupUrl(tab_id).is_empty();
GURL ExtensionAction::GetPopupUrl(int tab_id) const {
return GetValue(&popup_url_, tab_id);
void ExtensionAction::SetIcon(int tab_id, const gfx::Image& image) {
SetValue(&icon_, tab_id, image);
bool ExtensionAction::ParseIconFromCanvasDictionary(
const base::DictionaryValue& dict,
gfx::ImageSkia* icon) {
for (base::DictionaryValue::Iterator iter(dict); !iter.IsAtEnd();
iter.Advance()) {
std::string binary_string64;
IPC::Message pickle;
if (iter.value().is_blob()) {
pickle = IPC::Message(
reinterpret_cast<const char*>(iter.value().GetBlob().data()),
} else if (iter.value().GetAsString(&binary_string64)) {
std::string binary_string;
if (!base::Base64Decode(binary_string64, &binary_string))
return false;
pickle = IPC::Message(binary_string.c_str(), binary_string.length());
} else {
base::PickleIterator pickle_iter(pickle);
SkBitmap bitmap;
if (!IPC::ReadParam(&pickle, &pickle_iter, &bitmap))
return false;
// Chrome helpfully scales the provided icon(s), but let's not go overboard.
const int kActionIconMaxSize = 10 * ActionIconSize();
if (bitmap.drawsNothing() || bitmap.width() > kActionIconMaxSize)
float scale = static_cast<float>(bitmap.width()) / ActionIconSize();
icon->AddRepresentation(gfx::ImageSkiaRep(bitmap, scale));
return true;
gfx::Image ExtensionAction::GetExplicitlySetIcon(int tab_id) const {
return GetValue(&icon_, tab_id);
bool ExtensionAction::SetIsVisible(int tab_id, bool new_visibility) {
const bool old_visibility = GetValue(&is_visible_, tab_id);
if (old_visibility == new_visibility)
return false;
SetValue(&is_visible_, tab_id, new_visibility);
return true;
void ExtensionAction::DeclarativeShow(int tab_id) {
DCHECK_NE(tab_id, kDefaultTabId);
++declarative_show_count_[tab_id]; // Use default initialization to 0.
void ExtensionAction::UndoDeclarativeShow(int tab_id) {
int& show_count = declarative_show_count_[tab_id];
DCHECK_GT(show_count, 0);
if (--show_count == 0)
void ExtensionAction::DeclarativeSetIcon(int tab_id,
int priority,
const gfx::Image& icon) {
DCHECK_NE(tab_id, kDefaultTabId);
void ExtensionAction::UndoDeclarativeSetIcon(int tab_id,
int priority,
const gfx::Image& icon) {
std::vector<gfx::Image>& icons = declarative_icon_[tab_id][priority];
for (auto it = icons.begin(); it != icons.end(); ++it) {
if (it->AsImageSkia().BackedBySameObjectAs(icon.AsImageSkia())) {
const gfx::Image ExtensionAction::GetDeclarativeIcon(int tab_id) const {
if (declarative_icon_.find(tab_id) != declarative_icon_.end() &&
!declarative_icon_.find(tab_id)->second.rbegin()->second.empty()) {
return declarative_icon_.find(tab_id)->second.rbegin()->second.back();
return gfx::Image();
void ExtensionAction::ClearAllValuesForTab(int tab_id) {
// TODO(jyasskin): Erase the element from declarative_show_count_
// when the tab's closed. There's a race between the
// LocationBarController and the ContentRulesRegistry on navigation,
// which prevents me from cleaning everything up now.
void ExtensionAction::SetDefaultIconImage(
std::unique_ptr<extensions::IconImage> icon_image) {
default_icon_image_ = std::move(icon_image);
gfx::Image ExtensionAction::GetDefaultIconImage() const {
// If we have a default icon, it should be loaded before trying to use it.
DCHECK(!default_icon_image_ == !default_icon_);
if (default_icon_image_)
return default_icon_image_->image();
return GetPlaceholderIconImage();
gfx::Image ExtensionAction::GetPlaceholderIconImage() const {
if (placeholder_icon_image_.IsEmpty()) {
// For extension actions, we use a special placeholder icon (with the first
// letter of the extension name) rather than the default (puzzle piece).
// Note that this is only if we can't find any better image (e.g. a product
// icon).
placeholder_icon_image_ =
return placeholder_icon_image_;
bool ExtensionAction::HasPopupUrl(int tab_id) const {
return HasValue(popup_url_, tab_id);
bool ExtensionAction::HasTitle(int tab_id) const {
return HasValue(title_, tab_id);
bool ExtensionAction::HasBadgeText(int tab_id) const {
return HasValue(badge_text_, tab_id);
bool ExtensionAction::HasBadgeBackgroundColor(int tab_id) const {
return HasValue(badge_background_color_, tab_id);
bool ExtensionAction::HasBadgeTextColor(int tab_id) const {
return HasValue(badge_text_color_, tab_id);
bool ExtensionAction::HasIsVisible(int tab_id) const {
return HasValue(is_visible_, tab_id);
bool ExtensionAction::HasIcon(int tab_id) const {
return HasValue(icon_, tab_id);
void ExtensionAction::SetDefaultIconForTest(
std::unique_ptr<ExtensionIconSet> default_icon) {
default_icon_ = std::move(default_icon);
void ExtensionAction::Populate(const extensions::Extension& extension,
const extensions::ActionInfo& manifest_data) {
// If the manifest doesn't specify a title, set it to |extension|'s name.
const std::string& title =
!manifest_data.default_title.empty() ? manifest_data.default_title :;
SetTitle(kDefaultTabId, title);
SetPopupUrl(kDefaultTabId, manifest_data.default_popup_url);
// Initialize the specified icon set.
if (!manifest_data.default_icon.empty()) {
default_icon_.reset(new ExtensionIconSet(manifest_data.default_icon));
} else {
// Fall back to the product icons if no action icon exists.
const ExtensionIconSet& product_icons =
if (!product_icons.empty())
default_icon_.reset(new ExtensionIconSet(product_icons));
// Determines which icon would be returned by |GetIcon|, and returns its width.
int ExtensionAction::GetIconWidth(int tab_id) const {
// If icon has been set, return its width.
gfx::Image icon = GetValue(&icon_, tab_id);
if (!icon.IsEmpty())
return icon.Width();
// If there is a default icon, the icon width will be set depending on our
// action type.
if (default_icon_)
return ActionIconSize();
// If no icon has been set and there is no default icon, we need favicon
// width.
return FallbackIcon().Width();