Initial implementation of chrome.browser.openTab.

chrome/browser/extensions/extension_tab_util.cc

 // 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.
 
 #include "chrome/browser/extensions/extension_tab_util.h"
 
 #include "apps/app_window.h"
 #include "apps/app_window_registry.h"
+#include "base/strings/string_number_conversions.h"
 #include "chrome/browser/extensions/api/tabs/tabs_constants.h"
+#include "chrome/browser/extensions/chrome_extension_function.h"
 #include "chrome/browser/extensions/tab_helper.h"
 #include "chrome/browser/extensions/window_controller.h"
 #include "chrome/browser/extensions/window_controller_list.h"
 #include "chrome/browser/profiles/profile.h"
 #include "chrome/browser/sessions/session_id.h"
 #include "chrome/browser/ui/browser.h"
 #include "chrome/browser/ui/browser_finder.h"
 #include "chrome/browser/ui/browser_iterator.h"
 #include "chrome/browser/ui/browser_window.h"
 #include "chrome/browser/ui/scoped_tabbed_browser_displayer.h"
 #include "chrome/browser/ui/tab_contents/tab_contents_iterator.h"
 #include "chrome/browser/ui/tabs/tab_strip_model.h"
 #include "chrome/common/extensions/manifest_url_handler.h"
 #include "chrome/common/net/url_fixer_upper.h"
 #include "chrome/common/url_constants.h"
 #include "content/public/browser/favicon_status.h"
 #include "content/public/browser/navigation_entry.h"
 #include "content/public/browser/web_contents.h"
 #include "content/public/browser/web_contents_view.h"
+#include "extensions/common/constants.h"
+#include "extensions/common/error_utils.h"
 #include "extensions/common/extension.h"
 #include "extensions/common/manifest_constants.h"
+#include "extensions/common/manifest_handlers/incognito_info.h"
 #include "extensions/common/permissions/api_permission.h"
 #include "extensions/common/permissions/permissions_data.h"
 #include "url/gurl.h"
 
 using apps::AppWindow;
 using content::NavigationEntry;
 using content::WebContents;
 
 namespace extensions {
 
 namespace {
 
 namespace keys = tabs_constants;
 
 WindowController* GetAppWindowController(const WebContents* contents) {
   Profile* profile = Profile::FromBrowserContext(contents->GetBrowserContext());
   apps::AppWindowRegistry* registry = apps::AppWindowRegistry::Get(profile);
   if (!registry)
     return NULL;
   AppWindow* app_window =
       registry->GetAppWindowForRenderViewHost(contents->GetRenderViewHost());
   if (!app_window)
     return NULL;
   return WindowControllerList::GetInstance()->FindWindowById(
       app_window->session_id().id());
 }
 
+// |error_message| can optionally be passed in a will be set with an appropriate

[miket_OOO, 2014/04/28 18:24:35]

a => and?

[rpaquay, 2014/04/28 19:44:12]

Done.

+// message if the window cannot be found by id.
+Browser* GetBrowserInProfileWithId(Profile* profile,
+                                   const int window_id,
+                                   bool include_incognito,
+                                   std::string* error_message) {
+  Profile* incognito_profile =
+      include_incognito && profile->HasOffTheRecordProfile()
+          ? profile->GetOffTheRecordProfile()
+          : NULL;
+  for (chrome::BrowserIterator it; !it.done(); it.Next()) {
+    Browser* browser = *it;
+    if ((browser->profile() == profile ||
+         browser->profile() == incognito_profile) &&
+        ExtensionTabUtil::GetWindowId(browser) == window_id &&
+        browser->window()) {
+      return browser;
+    }
+  }
+
+  if (error_message)
+    *error_message = ErrorUtils::FormatErrorMessage(
+        keys::kWindowNotFoundError, base::IntToString(window_id));
+
+  return NULL;
+}
+
+Browser* CreateBrowser(ChromeAsyncExtensionFunction* function,
+                       int window_id,
+                       std::string* error) {
+  content::WebContents* web_contents = function->GetAssociatedWebContents();
+  DCHECK(web_contents);

[miket_OOO, 2014/04/28 18:24:35]

I don't know whether these should be DCHECKs or CHECKs. Could they fail in
production code?

[rpaquay, 2014/04/28 19:44:12]

AFAIK, looking the the implementations, the first three DCHECKs should always be
verified.

The last DCHECK is more of an pre-condition check: the "CreateBrower" function
should be called only in this specific case (no browser opened for the profile).

+  DCHECK(web_contents->GetView());
+  DCHECK(web_contents->GetView()->GetNativeView());
+  DCHECK(!chrome::FindBrowserWithWebContents(web_contents));
+
+  chrome::HostDesktopType desktop_type =
+      chrome::GetHostDesktopTypeForNativeView(
+          web_contents->GetView()->GetNativeView());
+  Browser::CreateParams params(
+      Browser::TYPE_TABBED, function->GetProfile(), desktop_type);
+  Browser* browser = new Browser(params);
+  browser->window()->Show();
+  return browser;
+}
+
 }  // namespace
 
+ExtensionTabUtil::OpenTabParams::OpenTabParams()
+    : create_browser_if_needed(false) {
+}
+
+ExtensionTabUtil::OpenTabParams::~OpenTabParams() {
+}
+
+// Opens a new tab for a given extension. Returns NULL and sets |error| if an
+// error occurs.
+base::DictionaryValue* ExtensionTabUtil::OpenTab(
+    ChromeAsyncExtensionFunction* function,
+    const OpenTabParams& params,
+    std::string* error) {
+  // windowId defaults to "current" window.
+  int window_id = extension_misc::kCurrentWindowId;
+  if (params.window_id.get())
+    window_id = *params.window_id;
+
+  Browser* browser = GetBrowserFromWindowID(function, window_id, error);
+  if (!browser) {
+    if (!params.create_browser_if_needed) {
+      return NULL;
+    }
+    browser = CreateBrowser(function, window_id, error);
+    if (!browser)
+      return NULL;
+  }
+
+  // Ensure the selected browser is tabbed.
+  if (!browser->is_type_tabbed() && browser->IsAttemptingToCloseBrowser())
+    browser = chrome::FindTabbedBrowser(function->GetProfile(),
+                                        function->include_incognito(),
+                                        browser->host_desktop_type());
+
+  if (!browser || !browser->window()) {
+    // TODO(rpaquay): Error message?
+    return NULL;
+  }
+
+  // TODO(jstritar): Add a constant, chrome.tabs.TAB_ID_ACTIVE, that
+  // represents the active tab.
+  WebContents* opener = NULL;
+  if (params.opener_tab_id.get()) {
+    int opener_id = *params.opener_tab_id;
+
+    if (!ExtensionTabUtil::GetTabById(opener_id,
+                                      function->GetProfile(),
+                                      function->include_incognito(),
+                                      NULL,
+                                      NULL,
+                                      &opener,
+                                      NULL)) {
+      // TODO(rpaquay): Error message?
+      return NULL;
+    }
+  }
+
+  // TODO(rafaelw): handle setting remaining tab properties:
+  // -title
+  // -favIconUrl
+
+  std::string url_string;
+  GURL url;
+  if (params.url.get()) {
+    url_string = *params.url;
+    url = ExtensionTabUtil::ResolvePossiblyRelativeURL(
+        url_string, function->GetExtension());
+    if (!url.is_valid()) {
+      *error =
+          ErrorUtils::FormatErrorMessage(keys::kInvalidUrlError, url_string);
+      return NULL;
+    }
+  }
+
+  // Don't let extensions crash the browser or renderers.
+  if (ExtensionTabUtil::IsCrashURL(url)) {
+    *error = keys::kNoCrashBrowserError;
+    return NULL;
+  }
+
+  // Default to foreground for the new tab. The presence of 'active' property
+  // will override this default.
+  bool active = true;
+  if (params.active.get())
+    active = *params.active;
+
+  // Default to not pinning the tab. Setting the 'pinned' property to true
+  // will override this default.
+  bool pinned = false;
+  if (params.pinned.get())
+    pinned = *params.pinned;
+
+  // We can't load extension URLs into incognito windows unless the extension
+  // uses split mode. Special case to fall back to a tabbed window.
+  if (url.SchemeIs(kExtensionScheme) &&
+      !IncognitoInfo::IsSplitMode(function->GetExtension()) &&
+      browser->profile()->IsOffTheRecord()) {
+    Profile* profile = browser->profile()->GetOriginalProfile();
+    chrome::HostDesktopType desktop_type = browser->host_desktop_type();
+
+    browser = chrome::FindTabbedBrowser(profile, false, desktop_type);
+    if (!browser) {
+      browser = new Browser(
+          Browser::CreateParams(Browser::TYPE_TABBED, profile, desktop_type));
+      browser->window()->Show();
+    }
+  }
+
+  // If index is specified, honor the value, but keep it bound to
+  // -1 <= index <= tab_strip->count() where -1 invokes the default behavior.
+  int index = -1;
+  if (params.index.get())
+    index = *params.index;
+
+  TabStripModel* tab_strip = browser->tab_strip_model();
+
+  index = std::min(std::max(index, -1), tab_strip->count());
+
+  int add_types = active ? TabStripModel::ADD_ACTIVE : TabStripModel::ADD_NONE;
+  add_types |= TabStripModel::ADD_FORCE_INDEX;
+  if (pinned)
+    add_types |= TabStripModel::ADD_PINNED;
+  chrome::NavigateParams navigate_params(
+      browser, url, content::PAGE_TRANSITION_LINK);
+  navigate_params.disposition =
+      active ? NEW_FOREGROUND_TAB : NEW_BACKGROUND_TAB;
+  navigate_params.tabstrip_index = index;
+  navigate_params.tabstrip_add_types = add_types;
+  chrome::Navigate(&navigate_params);
+
+  // The tab may have been created in a different window, so make sure we look
+  // at the right tab strip.
+  tab_strip = navigate_params.browser->tab_strip_model();
+  int new_index =
+      tab_strip->GetIndexOfWebContents(navigate_params.target_contents);
+  if (opener)
+    tab_strip->SetOpenerOfWebContentsAt(new_index, opener);
+
+  if (active)
+    navigate_params.target_contents->GetView()->SetInitialFocus();
+
+  // Return data about the newly created tab.
+  return ExtensionTabUtil::CreateTabValue(navigate_params.target_contents,
+                                          tab_strip,
+                                          new_index,
+                                          function->GetExtension());
+}
+
+Browser* ExtensionTabUtil::GetBrowserFromWindowID(
+    ChromeAsyncExtensionFunction* function,
+    int window_id,
+    std::string* error) {
+  if (window_id == extension_misc::kCurrentWindowId) {
+    Browser* result = function->GetCurrentBrowser();
+    if (!result || !result->window()) {
+      if (error)
+        *error = keys::kNoCurrentWindowError;
+      return NULL;
+    }
+    return result;
+  } else {
+    return GetBrowserInProfileWithId(function->GetProfile(),
+                                     window_id,
+                                     function->include_incognito(),
+                                     error);
+  }
+}
+
 int ExtensionTabUtil::GetWindowId(const Browser* browser) {
   return browser->session_id().id();
 }
 
 int ExtensionTabUtil::GetWindowIdOfTabStripModel(
     const TabStripModel* tab_strip_model) {
   for (chrome::BrowserIterator it; !it.done(); it.Next()) {
     if (it->tab_strip_model() == tab_strip_model)
       return GetWindowId(*it);
   }
@@ skipping 284 matching lines @@
                                 content::PAGE_TRANSITION_LINK,
                                 false);
   browser->OpenURL(params);
   browser->window()->Show();
   WebContents* web_contents =
       browser->tab_strip_model()->GetActiveWebContents();
   web_contents->GetDelegate()->ActivateContents(web_contents);
 }
 
 }  // namespace extensions