extension_web_ui.h revision 5821806d5e7f356e8fa4b058a389a808ea183019
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_EXTENSION_WEB_UI_H_ 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define CHROME_BROWSER_EXTENSIONS_EXTENSION_WEB_UI_H_ 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <string> 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/memory/scoped_ptr.h" 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "chrome/browser/bookmarks/bookmark_manager_extension_api.h" 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "chrome/browser/favicon/favicon_service.h" 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "chrome/common/extensions/extension.h" 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "content/public/browser/web_ui_controller.h" 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace content { 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class WebContents; 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class PrefService; 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class Profile; 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// This class implements WebUI for extensions and allows extensions to put UI in 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// the main tab contents area. For example, each extension can specify an 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// "options_page", and that page is displayed in the tab contents area and is 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// hosted by this class. 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class ExtensionWebUI : public content::WebUIController { 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static const char kExtensionURLOverrides[]; 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ExtensionWebUI(content::WebUI* web_ui, const GURL& url); 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~ExtensionWebUI(); 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual BookmarkManagerExtensionEventRouter* 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bookmark_manager_extension_event_router(); 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // BrowserURLHandler 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static bool HandleChromeURLOverride(GURL* url, 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) content::BrowserContext* browser_context); 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static bool HandleChromeURLOverrideReverse( 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) GURL* url, content::BrowserContext* browser_context); 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Register and unregister a dictionary of one or more overrides. 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Page names are the keys, and chrome-extension: URLs are the values. 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // (e.g. { "newtab": "chrome-extension://<id>/my_new_tab.html" } 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static void RegisterChromeURLOverrides(Profile* profile, 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const extensions::Extension::URLOverrideMap& overrides); 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static void UnregisterChromeURLOverrides(Profile* profile, 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const extensions::Extension::URLOverrideMap& overrides); 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static void UnregisterChromeURLOverride(const std::string& page, 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Profile* profile, 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const base::Value* override); 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called from BrowserPrefs 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static void RegisterUserPrefs(PrefService* prefs); 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Get the favicon for the extension by getting an icon from the manifest. 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static void GetFaviconForURL(Profile* profile, 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) FaviconService::GetFaviconRequest* request, 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const GURL& page_url); 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Unregister the specified override, and if it's the currently active one, 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // ensure that something takes its place. 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static void UnregisterAndReplaceOverride(const std::string& page, 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Profile* profile, 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::ListValue* list, 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const base::Value* override); 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // TODO(aa): This seems out of place. Why is it not with the event routers for 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // the other extension APIs? 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) scoped_ptr<BookmarkManagerExtensionEventRouter> 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bookmark_manager_extension_event_router_; 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The URL this WebUI was created for. 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) GURL url_; 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // CHROME_BROWSER_EXTENSIONS_EXTENSION_WEB_UI_H_ 81