| // Copyright (c) 2012 The Chromium Authors. All rights reserved. |
| // Use of this source code is governed by a BSD-style license that can be |
| // found in the LICENSE file. |
| |
| #ifndef CHROME_BROWSER_EXTENSIONS_EXTENSION_WEB_UI_H_ |
| #define CHROME_BROWSER_EXTENSIONS_EXTENSION_WEB_UI_H_ |
| |
| #include <memory> |
| #include <string> |
| |
| #include "base/macros.h" |
| #include "chrome/common/extensions/chrome_manifest_url_handlers.h" |
| #include "components/favicon_base/favicon_callback.h" |
| #include "content/public/browser/web_ui_controller.h" |
| |
| class Profile; |
| |
| namespace content { |
| class BrowserContext; |
| class WebContents; |
| } |
| |
| namespace extensions { |
| class BookmarkManagerPrivateDragEventRouter; |
| } |
| |
| namespace user_prefs { |
| class PrefRegistrySyncable; |
| } |
| |
| // This class implements WebUI for extensions and allows extensions to put UI in |
| // the main tab contents area. For example, each extension can specify an |
| // "options_page", and that page is displayed in the tab contents area and is |
| // hosted by this class. |
| // TODO(devlin): The above description has nothing to do with this class as far |
| // as I can tell. |
| class ExtensionWebUI : public content::WebUIController { |
| public: |
| static const char kExtensionURLOverrides[]; |
| |
| ExtensionWebUI(content::WebUI* web_ui, const GURL& url); |
| |
| ~ExtensionWebUI() override; |
| |
| // Returns true if the given url requires WebUI bindings. |
| static bool NeedsExtensionWebUI(content::BrowserContext* browser_context, |
| const GURL& url); |
| |
| // TODO(devlin): The rest of this class is static methods dealing with |
| // chrome url overrides (e.g. changing chrome://newtab to go to an extension- |
| // provided new tab page). This should be in a separate class from the WebUI |
| // controller for the bookmark manager, and the WebUI controller should be |
| // renamed. |
| // BrowserURLHandler |
| static bool HandleChromeURLOverride(GURL* url, |
| content::BrowserContext* browser_context); |
| static bool HandleChromeURLOverrideReverse( |
| GURL* url, content::BrowserContext* browser_context); |
| |
| // Initialize the Chrome URL overrides. This must happen *before* any further |
| // calls for URL overrides! |
| static void InitializeChromeURLOverrides(Profile* profile); |
| |
| // Validate the Chrome URL overrides, ensuring that each is valid and points |
| // to an existing extension. To be called once all extensions are loaded. |
| static void ValidateChromeURLOverrides(Profile* profile); |
| |
| // Add new Chrome URL overrides. If an entry exists, it is marked as active. |
| // If one doesn't exist, it is added at the beginning of the list of |
| // overrides (meaning it has priority). |
| static void RegisterOrActivateChromeURLOverrides( |
| Profile* profile, |
| const extensions::URLOverrides::URLOverrideMap& overrides); |
| |
| // Deactivate overrides without removing them from the list or modifying their |
| // positions in the list. |
| static void DeactivateChromeURLOverrides( |
| Profile* profile, |
| const extensions::URLOverrides::URLOverrideMap& overrides); |
| |
| // Completely unregister overrides, removing them from the list. |
| static void UnregisterChromeURLOverrides( |
| Profile* profile, |
| const extensions::URLOverrides::URLOverrideMap& overrides); |
| |
| // Called from BrowserPrefs |
| static void RegisterProfilePrefs(user_prefs::PrefRegistrySyncable* registry); |
| |
| // Get the favicon for the extension by getting an icon from the manifest. |
| // Note. |callback| is always run asynchronously. |
| static void GetFaviconForURL( |
| Profile* profile, |
| const GURL& page_url, |
| const favicon_base::FaviconResultsCallback& callback); |
| |
| extensions::BookmarkManagerPrivateDragEventRouter* |
| bookmark_manager_private_drag_event_router() { |
| return bookmark_manager_private_drag_event_router_.get(); |
| } |
| |
| private: |
| // Unregister the specified override, and if it's the currently active one, |
| // ensure that something takes its place. |
| static void UnregisterAndReplaceOverride(const std::string& page, |
| Profile* profile, |
| base::ListValue* list, |
| const base::Value* override); |
| |
| // TODO(aa): This seems out of place. Why is it not with the event routers for |
| // the other extension APIs? |
| std::unique_ptr<extensions::BookmarkManagerPrivateDragEventRouter> |
| bookmark_manager_private_drag_event_router_; |
| |
| DISALLOW_COPY_AND_ASSIGN(ExtensionWebUI); |
| }; |
| |
| #endif // CHROME_BROWSER_EXTENSIONS_EXTENSION_WEB_UI_H_ |