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" 112a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#include "chrome/common/extensions/manifest_url_handler.h" 12cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)#include "components/favicon_base/favicon_callback.h" 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "content/public/browser/web_ui_controller.h" 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 15c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)class Profile; 16c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace content { 182a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)class BrowserContext; 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class WebContents; 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 222a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)namespace extensions { 23a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles)class BookmarkManagerPrivateDragEventRouter; 242a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)} 252a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 26c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)namespace user_prefs { 272a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)class PrefRegistrySyncable; 28c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)} 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// This class implements WebUI for extensions and allows extensions to put UI in 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// the main tab contents area. For example, each extension can specify an 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// "options_page", and that page is displayed in the tab contents area and is 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// hosted by this class. 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class ExtensionWebUI : public content::WebUIController { 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static const char kExtensionURLOverrides[]; 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ExtensionWebUI(content::WebUI* web_ui, const GURL& url); 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~ExtensionWebUI(); 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 42a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) virtual extensions::BookmarkManagerPrivateDragEventRouter* 43a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) bookmark_manager_private_drag_event_router(); 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // BrowserURLHandler 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static bool HandleChromeURLOverride(GURL* url, 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) content::BrowserContext* browser_context); 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static bool HandleChromeURLOverrideReverse( 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) GURL* url, content::BrowserContext* browser_context); 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Register and unregister a dictionary of one or more overrides. 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Page names are the keys, and chrome-extension: URLs are the values. 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // (e.g. { "newtab": "chrome-extension://<id>/my_new_tab.html" } 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static void RegisterChromeURLOverrides(Profile* profile, 552a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) const extensions::URLOverrides::URLOverrideMap& overrides); 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static void UnregisterChromeURLOverrides(Profile* profile, 572a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) const extensions::URLOverrides::URLOverrideMap& overrides); 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static void UnregisterChromeURLOverride(const std::string& page, 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Profile* profile, 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const base::Value* override); 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called from BrowserPrefs 637dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch static void RegisterProfilePrefs(user_prefs::PrefRegistrySyncable* registry); 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Get the favicon for the extension by getting an icon from the manifest. 662a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Note. |callback| is always run asynchronously. 672a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) static void GetFaviconForURL( 682a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) Profile* profile, 692a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) const GURL& page_url, 70cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) const favicon_base::FaviconResultsCallback& callback); 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Unregister the specified override, and if it's the currently active one, 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // ensure that something takes its place. 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static void UnregisterAndReplaceOverride(const std::string& page, 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Profile* profile, 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::ListValue* list, 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const base::Value* override); 795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // TODO(aa): This seems out of place. Why is it not with the event routers for 815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // the other extension APIs? 82a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) scoped_ptr<extensions::BookmarkManagerPrivateDragEventRouter> 83a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) bookmark_manager_private_drag_event_router_; 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The URL this WebUI was created for. 865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) GURL url_; 875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // CHROME_BROWSER_EXTENSIONS_EXTENSION_WEB_UI_H_ 90