blob: 7b34826eefe08039a2117e8cac986ecd668e2ed1 [file] [log] [blame]
// 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_TAB_UTIL_H_
#define CHROME_BROWSER_EXTENSIONS_EXTENSION_TAB_UTIL_H_
#include <memory>
#include <string>
#include "base/callback.h"
#include "chrome/common/extensions/api/tabs.h"
#include "ui/base/window_open_disposition.h"
class Browser;
class ChromeExtensionFunctionDetails;
class ChromeUIThreadExtensionFunction;
class ExtensionFunction;
class GURL;
class Profile;
class TabStripModel;
namespace base {
class DictionaryValue;
class ListValue;
}
namespace content {
class BrowserContext;
class WebContents;
}
namespace gfx {
class Rect;
}
namespace extensions {
class Extension;
class WindowController;
// Provides various utility functions that help manipulate tabs.
class ExtensionTabUtil {
public:
struct OpenTabParams {
OpenTabParams();
~OpenTabParams();
bool create_browser_if_needed;
std::unique_ptr<int> window_id;
std::unique_ptr<int> opener_tab_id;
std::unique_ptr<std::string> url;
std::unique_ptr<bool> active;
std::unique_ptr<bool> pinned;
std::unique_ptr<int> index;
};
// Opens a new tab given an extension function |function| and creation
// parameters |params|. Returns a Tab object if successful, or NULL and
// optionally sets |error| if an error occurs.
static base::DictionaryValue* OpenTab(
ChromeUIThreadExtensionFunction* function,
const OpenTabParams& params,
std::string* error);
static int GetWindowId(const Browser* browser);
static int GetWindowIdOfTabStripModel(const TabStripModel* tab_strip_model);
static int GetTabId(const content::WebContents* web_contents);
static std::string GetTabStatusText(bool is_loading);
static int GetWindowIdOfTab(const content::WebContents* web_contents);
static std::unique_ptr<base::ListValue> CreateTabList(
const Browser* browser,
const Extension* extension);
// DEPRECATED: Please consider using ChromeExtensionFunctionDetails instead
// of the deprecated ChromeUIThreadExtensionFunction and use the overload
// below
static Browser* GetBrowserFromWindowID(
ChromeUIThreadExtensionFunction* function,
int window_id,
std::string* error_message);
static Browser* GetBrowserFromWindowID(
const ChromeExtensionFunctionDetails& details,
int window_id,
std::string* error_message);
// Creates a Tab object (see chrome/common/extensions/api/tabs.json) with
// information about the state of a browser tab. Depending on the
// permissions of the extension, the object may or may not include sensitive
// data such as the tab's URL.
static std::unique_ptr<api::tabs::Tab> CreateTabObject(
content::WebContents* web_contents,
const Extension* extension) {
return CreateTabObject(web_contents, nullptr, -1, extension);
}
static std::unique_ptr<api::tabs::Tab> CreateTabObject(
content::WebContents* web_contents,
TabStripModel* tab_strip,
int tab_index,
const Extension* extension);
// Creates a Tab object but performs no extension permissions checks; the
// returned object will contain privacy-sensitive data.
static std::unique_ptr<api::tabs::Tab> CreateTabObject(
content::WebContents* web_contents) {
return CreateTabObject(web_contents, nullptr, -1);
}
static std::unique_ptr<api::tabs::Tab> CreateTabObject(
content::WebContents* web_contents,
TabStripModel* tab_strip,
int tab_index);
// Creates a tab MutedInfo object (see chrome/common/extensions/api/tabs.json)
// with information about the mute state of a browser tab.
static std::unique_ptr<api::tabs::MutedInfo> CreateMutedInfo(
content::WebContents* contents);
// Removes any privacy-sensitive fields from a Tab object if appropriate,
// given the permissions of the extension and the tab in question. The
// tab object is modified in place.
static void ScrubTabForExtension(const Extension* extension,
content::WebContents* contents,
api::tabs::Tab* tab);
// Gets the |tab_strip_model| and |tab_index| for the given |web_contents|.
static bool GetTabStripModel(const content::WebContents* web_contents,
TabStripModel** tab_strip_model,
int* tab_index);
static bool GetDefaultTab(Browser* browser,
content::WebContents** contents,
int* tab_id);
// Any out parameter (|browser|, |tab_strip|, |contents|, & |tab_index|) may
// be NULL and will not be set within the function.
static bool GetTabById(int tab_id,
content::BrowserContext* browser_context,
bool incognito_enabled,
Browser** browser,
TabStripModel** tab_strip,
content::WebContents** contents,
int* tab_index);
// Takes |url_string| and returns a GURL which is either valid and absolute
// or invalid. If |url_string| is not directly interpretable as a valid (it is
// likely a relative URL) an attempt is made to resolve it. |extension| is
// provided so it can be resolved relative to its extension base
// (chrome-extension://<id>/). Using the source frame url would be more
// correct, but because the api shipped with urls resolved relative to their
// extension base, we decided it wasn't worth breaking existing extensions to
// fix.
static GURL ResolvePossiblyRelativeURL(const std::string& url_string,
const Extension* extension);
// Returns true if navigating to |url| would kill a page or the browser
// itself, whether by simulating a crash, browser quit, thread hang, or
// equivalent. Extensions should be prevented from navigating to such URLs.
static bool IsKillURL(const GURL& url);
// Opens a tab for the specified |web_contents|.
static void CreateTab(content::WebContents* web_contents,
const std::string& extension_id,
WindowOpenDisposition disposition,
const gfx::Rect& initial_rect,
bool user_gesture);
// Executes the specified callback for all tabs in all browser windows.
static void ForEachTab(
const base::Callback<void(content::WebContents*)>& callback);
static WindowController* GetWindowControllerOfTab(
const content::WebContents* web_contents);
// Open the extension's options page. Returns true if an options page was
// successfully opened (though it may not necessarily *load*, e.g. if the
// URL does not exist).
static bool OpenOptionsPage(const Extension* extension, Browser* browser);
// Returns true if the given Browser can report tabs to extensions.
// Example of Browsers which don't support tabs include apps and devtools.
static bool BrowserSupportsTabs(Browser* browser);
};
} // namespace extensions
#endif // CHROME_BROWSER_EXTENSIONS_EXTENSION_TAB_UTIL_H_