menu_manager.h revision 2a99a7e74a7f215066514fe81d2bfa6639d9eddd
15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright (c) 2012 The Chromium Authors. All rights reserved. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file. 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifndef CHROME_BROWSER_EXTENSIONS_MENU_MANAGER_H_ 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define CHROME_BROWSER_EXTENSIONS_MENU_MANAGER_H_ 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <map> 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <set> 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <string> 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <vector> 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/basictypes.h" 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/compiler_specific.h" 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/gtest_prod_util.h" 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/memory/scoped_ptr.h" 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/memory/weak_ptr.h" 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/string16.h" 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/values.h" 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "chrome/browser/extensions/extension_icon_manager.h" 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "content/public/browser/notification_observer.h" 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "content/public/browser/notification_registrar.h" 232a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#include "extensions/common/url_pattern_set.h" 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class Profile; 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class SkBitmap; 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace content { 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class WebContents; 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)struct ContextMenuParams; 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace extensions { 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class Extension; 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Represents a menu item added by an extension. 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class MenuItem { 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // A list of MenuItems. 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) typedef std::vector<MenuItem*> List; 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // An Id uniquely identifies a context menu item registered by an extension. 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) struct Id { 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Id(); 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Since the unique ID (uid or string_uid) is parsed from API arguments, 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // the normal usage is to set the uid or string_uid immediately after 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // construction. 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Id(bool incognito, const std::string& extension_id); 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ~Id(); 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool operator==(const Id& other) const; 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool operator!=(const Id& other) const; 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool operator<(const Id& other) const; 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool incognito; 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::string extension_id; 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Only one of uid or string_uid will be defined. 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int uid; 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::string string_uid; 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) }; 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // For context menus, these are the contexts where an item can appear. 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) enum Context { 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ALL = 1, 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PAGE = 2, 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) SELECTION = 4, 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LINK = 8, 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) EDITABLE = 16, 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) IMAGE = 32, 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) VIDEO = 64, 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) AUDIO = 128, 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) FRAME = 256, 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LAUNCHER = 512 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) }; 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // An item can be only one of these types. 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) enum Type { 795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) NORMAL, 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) CHECKBOX, 815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) RADIO, 825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) SEPARATOR 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) }; 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // A list of Contexts for an item. 865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) class ContextList { 875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ContextList() : value_(0) {} 895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) explicit ContextList(Context context) : value_(context) {} 905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ContextList(const ContextList& other) : value_(other.value_) {} 915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void operator=(const ContextList& other) { 935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) value_ = other.value_; 945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool operator==(const ContextList& other) const { 975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return value_ == other.value_; 985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool operator!=(const ContextList& other) const { 1015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return !(*this == other); 1025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool Contains(Context context) const { 1055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return (value_ & context) > 0; 1065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void Add(Context context) { 1095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) value_ |= context; 1105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) scoped_ptr<Value> ToValue() const { 1135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return scoped_ptr<Value>(Value::CreateIntegerValue(value_)); 1145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool Populate(const Value& value) { 1175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int int_value; 1185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (!value.GetAsInteger(&int_value) || int_value < 0) 1195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return false; 1205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) value_ = int_value; 1215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return true; 1225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 1255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uint32 value_; // A bitmask of Context values. 1265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) }; 1275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) MenuItem(const Id& id, 1295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const std::string& title, 1305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool checked, 1315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool enabled, 1325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Type type, 1335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const ContextList& contexts); 1345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~MenuItem(); 1355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Simple accessor methods. 1375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool incognito() const { return id_.incognito; } 1385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const std::string& extension_id() const { return id_.extension_id; } 1395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const std::string& title() const { return title_; } 1405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const List& children() { return children_; } 1415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const Id& id() const { return id_; } 1425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Id* parent_id() const { return parent_id_.get(); } 1435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int child_count() const { return children_.size(); } 1445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ContextList contexts() const { return contexts_; } 1455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Type type() const { return type_; } 1465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool checked() const { return checked_; } 1475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool enabled() const { return enabled_; } 1485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const URLPatternSet& document_url_patterns() const { 1495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return document_url_patterns_; 1505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const URLPatternSet& target_url_patterns() const { 1525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return target_url_patterns_; 1535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Simple mutator methods. 1565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void set_title(const std::string& new_title) { title_ = new_title; } 1575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void set_contexts(ContextList contexts) { contexts_ = contexts; } 1585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void set_type(Type type) { type_ = type; } 1595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void set_enabled(bool enabled) { enabled_ = enabled; } 1605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void set_document_url_patterns(const URLPatternSet& patterns) { 1615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) document_url_patterns_ = patterns; 1625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void set_target_url_patterns(const URLPatternSet& patterns) { 1645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) target_url_patterns_ = patterns; 1655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the title with any instances of %s replaced by |selection|. The 1685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // result will be no longer than |max_length|. 1695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) string16 TitleWithReplacement(const string16& selection, 1705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t max_length) const; 1715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Sets the checked state to |checked|. Returns true if successful. 1735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool SetChecked(bool checked); 1745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Converts to Value for serialization to preferences. 1765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) scoped_ptr<base::DictionaryValue> ToValue() const; 1775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns a new MenuItem created from |value|, or NULL if there is 1795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // an error. The caller takes ownership of the MenuItem. 1805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static MenuItem* Populate(const std::string& extension_id, 1815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const DictionaryValue& value, 1825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::string* error); 1835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Sets any document and target URL patterns from |properties|. 1855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool PopulateURLPatterns(std::vector<std::string>* document_url_patterns, 1865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::vector<std::string>* target_url_patterns, 1875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::string* error); 1885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) protected: 1905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class MenuManager; 1915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Takes ownership of |item| and sets its parent_id_. 1935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void AddChild(MenuItem* item); 1945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Takes the child item from this parent. The item is returned and the caller 1965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // then owns the pointer. 1975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) MenuItem* ReleaseChild(const Id& child_id, bool recursive); 1985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Recursively appends all descendant items (children, grandchildren, etc.) 2005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // to the output |list|. 2015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void GetFlattenedSubtree(MenuItem::List* list); 2025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Recursively removes all descendant items (children, grandchildren, etc.), 2045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // returning the ids of the removed items. 2055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::set<Id> RemoveAllDescendants(); 2065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 2085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The unique id for this item. 2095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Id id_; 2105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // What gets shown in the menu for this item. 2125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::string title_; 2135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Type type_; 2155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // This should only be true for items of type CHECKBOX or RADIO. 2175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool checked_; 2185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // If the item is enabled or not. 2205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool enabled_; 2215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // In what contexts should the item be shown? 2235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ContextList contexts_; 2245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // If this item is a child of another item, the unique id of its parent. If 2265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // this is a top-level item with no parent, this will be NULL. 2275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) scoped_ptr<Id> parent_id_; 2285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Patterns for restricting what documents this item will appear for. This 2305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // applies to the frame where the click took place. 2315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) URLPatternSet document_url_patterns_; 2325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Patterns for restricting where items appear based on the src/href 2345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // attribute of IMAGE/AUDIO/VIDEO/LINK tags. 2355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) URLPatternSet target_url_patterns_; 2365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Any children this item may have. 2385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) List children_; 2395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DISALLOW_COPY_AND_ASSIGN(MenuItem); 2415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 2425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// This class keeps track of menu items added by extensions. 2445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class MenuManager : public content::NotificationObserver, 2455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public base::SupportsWeakPtr<MenuManager> { 2465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 2475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) explicit MenuManager(Profile* profile); 2485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~MenuManager(); 2495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the ids of extensions which have menu items registered. 2515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::set<std::string> ExtensionIds(); 2525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns a list of all the *top-level* menu items (added via AddContextItem) 2545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // for the given extension id, *not* including child items (added via 2555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // AddChildItem); although those can be reached via the top-level items' 2565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // children. A view can then decide how to display these, including whether to 2575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // put them into a submenu if there are more than 1. 2585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const MenuItem::List* MenuItems(const std::string& extension_id); 2595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Adds a top-level menu item for an extension, requiring the |extension| 2615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // pointer so it can load the icon for the extension. Takes ownership of 2625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // |item|. Returns a boolean indicating success or failure. 2635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool AddContextItem(const Extension* extension, MenuItem* item); 2645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Add an item as a child of another item which has been previously added, and 2665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // takes ownership of |item|. Returns a boolean indicating success or failure. 2675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool AddChildItem(const MenuItem::Id& parent_id, 2685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) MenuItem* child); 2695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Makes existing item with |child_id| a child of the item with |parent_id|. 2715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // If the child item was already a child of another parent, this will remove 2725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // it from that parent first. It is an error to try and move an item to be a 2735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // child of one of its own descendants. It is legal to pass NULL for 2745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // |parent_id|, which means the item should be moved to the top-level. 2755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool ChangeParent(const MenuItem::Id& child_id, 2765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const MenuItem::Id* parent_id); 2775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Removes a context menu item with the given id (whether it is a top-level 2795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // item or a child of some other item), returning true if the item was found 2805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // and removed or false otherwise. 2815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool RemoveContextMenuItem(const MenuItem::Id& id); 2825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Removes all items for the given extension id. 2845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void RemoveAllContextItems(const std::string& extension_id); 2855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the item with the given |id| or NULL. 2875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) MenuItem* GetItemById(const MenuItem::Id& id) const; 2885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Notify the MenuManager that an item has been updated not through 2905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // an explicit call into MenuManager. For example, if an item is 2915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // acquired by a call to GetItemById and changed, then this should be called. 2925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns true if the item was found or false otherwise. 2935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool ItemUpdated(const MenuItem::Id& id); 2945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called when a menu item is clicked on by the user. 2965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void ExecuteCommand(Profile* profile, 2975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) content::WebContents* web_contents, 2985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const content::ContextMenuParams& params, 2995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const MenuItem::Id& menu_item_id); 3005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // This returns a bitmap of width/height kFaviconSize, loaded either from an 3025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // entry specified in the extension's 'icon' section of the manifest, or a 3035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // default extension icon. 3045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const SkBitmap& GetIconForExtension(const std::string& extension_id); 3055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Implements the content::NotificationObserver interface. 3075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void Observe(int type, const content::NotificationSource& source, 3085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const content::NotificationDetails& details) OVERRIDE; 3095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Stores the menu items for the extension in the state storage. 3115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void WriteToStorage(const Extension* extension); 3125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Reads menu items for the extension from the state storage. Any invalid 3145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // items are ignored. 3155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void ReadFromStorage(const std::string& extension_id, 3165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) scoped_ptr<base::Value> value); 3175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Removes all "incognito" "split" mode context items. 3195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void RemoveAllIncognitoContextItems(); 3205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 3225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) FRIEND_TEST_ALL_PREFIXES(MenuManagerTest, DeleteParent); 3235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) FRIEND_TEST_ALL_PREFIXES(MenuManagerTest, RemoveOneByOne); 3245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // This is a helper function which takes care of de-selecting any other radio 3265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // items in the same group (i.e. that are adjacent in the list). 3275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void RadioItemSelected(MenuItem* item); 3285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Make sure that there is only one radio item selected at once in any run. 3305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // If there are no radio items selected, then the first item in the run 3315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // will get selected. If there are multiple radio items selected, then only 3325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // the last one will get selcted. 3335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void SanitizeRadioList(const MenuItem::List& item_list); 3345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns true if item is a descendant of an item with id |ancestor_id|. 3365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool DescendantOf(MenuItem* item, const MenuItem::Id& ancestor_id); 3375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // We keep items organized by mapping an extension id to a list of items. 3395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) typedef std::map<std::string, MenuItem::List> MenuItemMap; 3405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) MenuItemMap context_items_; 3415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // This lets us make lookup by id fast. It maps id to MenuItem* for 3435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // all items the menu manager knows about, including all children of top-level 3445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // items. 3455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::map<MenuItem::Id, MenuItem*> items_by_id_; 3465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) content::NotificationRegistrar registrar_; 3485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ExtensionIconManager icon_manager_; 3505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Profile* profile_; 3525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DISALLOW_COPY_AND_ASSIGN(MenuManager); 3545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 3555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace extensions 3575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // CHROME_BROWSER_EXTENSIONS_MENU_MANAGER_H_ 359