extension_web_ui.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_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/favicon/favicon_service.h" 122a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#include "chrome/common/extensions/manifest_url_handler.h" 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "content/public/browser/web_ui_controller.h" 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace content { 162a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)class BrowserContext; 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class WebContents; 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 202a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)namespace extensions { 212a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)class BookmarkManagerPrivateEventRouter; 222a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)} 232a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 242a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)class PrefRegistrySyncable; 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class Profile; 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// This class implements WebUI for extensions and allows extensions to put UI in 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// the main tab contents area. For example, each extension can specify an 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// "options_page", and that page is displayed in the tab contents area and is 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// hosted by this class. 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class ExtensionWebUI : public content::WebUIController { 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static const char kExtensionURLOverrides[]; 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ExtensionWebUI(content::WebUI* web_ui, const GURL& url); 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~ExtensionWebUI(); 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 392a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) virtual extensions::BookmarkManagerPrivateEventRouter* 402a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) bookmark_manager_private_event_router(); 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // BrowserURLHandler 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static bool HandleChromeURLOverride(GURL* url, 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) content::BrowserContext* browser_context); 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static bool HandleChromeURLOverrideReverse( 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) GURL* url, content::BrowserContext* browser_context); 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Register and unregister a dictionary of one or more overrides. 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Page names are the keys, and chrome-extension: URLs are the values. 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // (e.g. { "newtab": "chrome-extension://<id>/my_new_tab.html" } 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static void RegisterChromeURLOverrides(Profile* profile, 522a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) const extensions::URLOverrides::URLOverrideMap& overrides); 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static void UnregisterChromeURLOverrides(Profile* profile, 542a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) const extensions::URLOverrides::URLOverrideMap& overrides); 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static void UnregisterChromeURLOverride(const std::string& page, 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Profile* profile, 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const base::Value* override); 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called from BrowserPrefs 602a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) static void RegisterUserPrefs(PrefRegistrySyncable* registry); 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Get the favicon for the extension by getting an icon from the manifest. 632a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Note. |callback| is always run asynchronously. 642a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) static void GetFaviconForURL( 652a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) Profile* profile, 662a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) const GURL& page_url, 672a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) const FaviconService::FaviconResultsCallback& callback); 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Unregister the specified override, and if it's the currently active one, 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // ensure that something takes its place. 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static void UnregisterAndReplaceOverride(const std::string& page, 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Profile* profile, 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::ListValue* list, 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const base::Value* override); 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // TODO(aa): This seems out of place. Why is it not with the event routers for 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // the other extension APIs? 792a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) scoped_ptr<extensions::BookmarkManagerPrivateEventRouter> 802a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) bookmark_manager_private_event_router_; 815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The URL this WebUI was created for. 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) GURL url_; 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // CHROME_BROWSER_EXTENSIONS_EXTENSION_WEB_UI_H_ 87