chrome/common/extensions/api/extension_action/action_info.cc

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #include "chrome/common/extensions/api/extension_action/action_info.h"
   6
   7 #include "base/memory/scoped_ptr.h"
   8 #include "base/strings/utf_string_conversions.h"
   9 #include "chrome/common/extensions/api/commands/commands_handler.h"
  10 #include "extensions/common/constants.h"
  11 #include "extensions/common/error_utils.h"
  12 #include "extensions/common/extension.h"
  13 #include "extensions/common/manifest_constants.h"
  14 #include "extensions/common/manifest_handler_helpers.h"
  15
  16 namespace extensions {
  17
  18 namespace errors = manifest_errors;
  19 namespace keys = manifest_keys;
  20
  21 namespace {
  22
  23 // The manifest data container for the ActionInfos for BrowserActions,
  24 // PageActions and SystemIndicators.
  25 struct ActionInfoData : public Extension::ManifestData {
  26   explicit ActionInfoData(ActionInfo* action_info);
  27   virtual ~ActionInfoData();
  28
  29   // The action associated with the BrowserAction.
  30   scoped_ptr<ActionInfo> action_info;
  31 };
  32
  33 ActionInfoData::ActionInfoData(ActionInfo* info) : action_info(info) {
  34 }
  35
  36 ActionInfoData::~ActionInfoData() {
  37 }
  38
  39 static const ActionInfo* GetActionInfo(const Extension* extension,
  40                                        const std::string& key) {
  41   ActionInfoData* data = static_cast<ActionInfoData*>(
  42       extension->GetManifestData(key));
  43   return data ? data->action_info.get() : NULL;
  44 }
  45
  46 }  // namespace
  47
  48 ActionInfo::ActionInfo() {
  49 }
  50
  51 ActionInfo::~ActionInfo() {
  52 }
  53
  54 // static
  55 scoped_ptr<ActionInfo> ActionInfo::Load(const Extension* extension,
  56                                         const base::DictionaryValue* dict,
  57                                         base::string16* error) {
  58   scoped_ptr<ActionInfo> result(new ActionInfo());
  59
  60   if (extension->manifest_version() == 1) {
  61     // kPageActionIcons is obsolete, and used by very few extensions. Continue
  62     // loading it, but only take the first icon as the default_icon path.
  63     const base::ListValue* icons = NULL;
  64     if (dict->HasKey(keys::kPageActionIcons) &&
  65         dict->GetList(keys::kPageActionIcons, &icons)) {
  66       base::ListValue::const_iterator iter = icons->begin();
  67       std::string path;
  68       if (iter == icons->end() ||
  69           !(*iter)->GetAsString(&path) ||
  70           !manifest_handler_helpers::NormalizeAndValidatePath(&path)) {
  71         *error = base::ASCIIToUTF16(errors::kInvalidPageActionIconPath);
  72         return scoped_ptr<ActionInfo>();
  73       }
  74       result->default_icon.Add(extension_misc::EXTENSION_ICON_ACTION, path);
  75     }
  76
  77     std::string id;
  78     if (dict->HasKey(keys::kPageActionId)) {
  79       if (!dict->GetString(keys::kPageActionId, &id)) {
  80         *error = base::ASCIIToUTF16(errors::kInvalidPageActionId);
  81         return scoped_ptr<ActionInfo>();
  82       }
  83       result->id = id;
  84     }
  85   }
  86
  87   // Read the page action |default_icon| (optional).
  88   // The |default_icon| value can be either dictionary {icon size -> icon path}
  89   // or non empty string value.
  90   if (dict->HasKey(keys::kPageActionDefaultIcon)) {
  91     const base::DictionaryValue* icons_value = NULL;
  92     std::string default_icon;
  93     if (dict->GetDictionary(keys::kPageActionDefaultIcon, &icons_value)) {
  94       int icon_sizes[extension_misc::kNumExtensionActionIconSizes];
  95       for (size_t i = 0u; i < extension_misc::kNumExtensionActionIconSizes; ++i)
  96         icon_sizes[i] = extension_misc::kExtensionActionIconSizes[i].size;
  97       if (!manifest_handler_helpers::LoadIconsFromDictionary(
  98               icons_value,
  99               icon_sizes,
 100               extension_misc::kNumExtensionActionIconSizes,
 101               &result->default_icon,
 102               error)) {
 103         return scoped_ptr<ActionInfo>();
 104       }
 105     } else if (dict->GetString(keys::kPageActionDefaultIcon, &default_icon) &&
 106                manifest_handler_helpers::NormalizeAndValidatePath(
 107                    &default_icon)) {
 108       result->default_icon.Add(extension_misc::EXTENSION_ICON_ACTION,
 109                                default_icon);
 110     } else {
 111       *error = base::ASCIIToUTF16(errors::kInvalidPageActionIconPath);
 112       return scoped_ptr<ActionInfo>();
 113     }
 114   }
 115
 116   // Read the page action title from |default_title| if present, |name| if not
 117   // (both optional).
 118   if (dict->HasKey(keys::kPageActionDefaultTitle)) {
 119     if (!dict->GetString(keys::kPageActionDefaultTitle,
 120                          &result->default_title)) {
 121       *error = base::ASCIIToUTF16(errors::kInvalidPageActionDefaultTitle);
 122       return scoped_ptr<ActionInfo>();
 123     }
 124   } else if (extension->manifest_version() == 1 && dict->HasKey(keys::kName)) {
 125     if (!dict->GetString(keys::kName, &result->default_title)) {
 126       *error = base::ASCIIToUTF16(errors::kInvalidPageActionName);
 127       return scoped_ptr<ActionInfo>();
 128     }
 129   }
 130
 131   // Read the action's |popup| (optional).
 132   const char* popup_key = NULL;
 133   if (dict->HasKey(keys::kPageActionDefaultPopup))
 134     popup_key = keys::kPageActionDefaultPopup;
 135
 136   if (extension->manifest_version() == 1 &&
 137       dict->HasKey(keys::kPageActionPopup)) {
 138     if (popup_key) {
 139       *error = ErrorUtils::FormatErrorMessageUTF16(
 140           errors::kInvalidPageActionOldAndNewKeys,
 141           keys::kPageActionDefaultPopup,
 142           keys::kPageActionPopup);
 143       return scoped_ptr<ActionInfo>();
 144     }
 145     popup_key = keys::kPageActionPopup;
 146   }
 147
 148   if (popup_key) {
 149     const base::DictionaryValue* popup = NULL;
 150     std::string url_str;
 151
 152     if (dict->GetString(popup_key, &url_str)) {
 153       // On success, |url_str| is set.  Nothing else to do.
 154     } else if (extension->manifest_version() == 1 &&
 155                dict->GetDictionary(popup_key, &popup)) {
 156       if (!popup->GetString(keys::kPageActionPopupPath, &url_str)) {
 157         *error = ErrorUtils::FormatErrorMessageUTF16(
 158             errors::kInvalidPageActionPopupPath, "<missing>");
 159         return scoped_ptr<ActionInfo>();
 160       }
 161     } else {
 162       *error = base::ASCIIToUTF16(errors::kInvalidPageActionPopup);
 163       return scoped_ptr<ActionInfo>();
 164     }
 165
 166     if (!url_str.empty()) {
 167       // An empty string is treated as having no popup.
 168       result->default_popup_url = Extension::GetResourceURL(extension->url(),
 169                                                             url_str);
 170       if (!result->default_popup_url.is_valid()) {
 171         *error = ErrorUtils::FormatErrorMessageUTF16(
 172             errors::kInvalidPageActionPopupPath, url_str);
 173         return scoped_ptr<ActionInfo>();
 174       }
 175     } else {
 176       DCHECK(result->default_popup_url.is_empty())
 177           << "Shouldn't be possible for the popup to be set.";
 178     }
 179   }
 180
 181   return result.Pass();
 182 }
 183
 184 // static
 185 const ActionInfo* ActionInfo::GetBrowserActionInfo(const Extension* extension) {
 186   return GetActionInfo(extension, keys::kBrowserAction);
 187 }
 188
 189 const ActionInfo* ActionInfo::GetPageActionInfo(const Extension* extension) {
 190   return GetActionInfo(extension, keys::kPageAction);
 191 }
 192
 193 // static
 194 const ActionInfo* ActionInfo::GetSystemIndicatorInfo(
 195     const Extension* extension) {
 196   return GetActionInfo(extension, keys::kSystemIndicator);
 197 }
 198
 199 // static
 200 void ActionInfo::SetBrowserActionInfo(Extension* extension, ActionInfo* info) {
 201   extension->SetManifestData(keys::kBrowserAction,
 202                              new ActionInfoData(info));
 203 }
 204
 205 // static
 206 void ActionInfo::SetPageActionInfo(Extension* extension, ActionInfo* info) {
 207   extension->SetManifestData(keys::kPageAction,
 208                              new ActionInfoData(info));
 209 }
 210
 211 // static
 212 void ActionInfo::SetSystemIndicatorInfo(Extension* extension,
 213                                         ActionInfo* info) {
 214   extension->SetManifestData(keys::kSystemIndicator, new ActionInfoData(info));
 215 }
 216
 217 // static
 218 bool ActionInfo::IsVerboseInstallMessage(const Extension* extension) {
 219   const ActionInfo* page_action_info = GetPageActionInfo(extension);
 220   return page_action_info &&
 221       (CommandsInfo::GetPageActionCommand(extension) ||
 222        !page_action_info->default_icon.empty());
 223 }
 224
 225 }  // namespace extensions