Add chrome.debugger.getTargets method to discover available debug targets.

chrome/browser/extensions/api/debugger/debugger_api.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.
 
 // Implements the Chrome Extensions Debugger API.
 
 #include "chrome/browser/extensions/api/debugger/debugger_api.h"
 
 #include <map>
 #include <set>
@@ skipping 16 matching lines @@
 #include "chrome/browser/extensions/extension_tab_util.h"
 #include "chrome/browser/infobars/infobar.h"
 #include "chrome/browser/profiles/profile.h"
 #include "chrome/browser/ui/webui/chrome_web_ui_controller_factory.h"
 #include "chrome/common/chrome_notification_types.h"
 #include "chrome/common/chrome_switches.h"
 #include "chrome/common/extensions/extension.h"
 #include "content/public/browser/devtools_agent_host.h"
 #include "content/public/browser/devtools_client_host.h"
 #include "content/public/browser/devtools_manager.h"
+#include "content/public/browser/favicon_status.h"
+#include "content/public/browser/navigation_entry.h"
 #include "content/public/browser/notification_service.h"
 #include "content/public/browser/notification_source.h"
 #include "content/public/browser/render_process_host.h"
 #include "content/public/browser/render_view_host.h"
 #include "content/public/browser/render_widget_host.h"
 #include "content/public/browser/web_contents.h"
 #include "content/public/common/content_client.h"
 #include "content/public/common/url_constants.h"
 #include "extensions/common/error_utils.h"
 #include "grit/generated_resources.h"
@@ skipping 129 matching lines @@
       if (rvh && WebContents::FromRenderViewHost(rvh) == contents)
         return static_cast<ExtensionDevToolsClientHost*>(*it);
     }
     return NULL;
   }
 
  private:
   std::set<DevToolsClientHost*> client_hosts_;
 };
 
+static extensions::ExtensionHost* GetExtensionBackgroundHost(
+    WebContents* web_contents) {
+  Profile* profile =
+      Profile::FromBrowserContext(web_contents->GetBrowserContext());
+  if (!profile)
+    return NULL;
+
+  extensions::ExtensionHost* extension_host =
+      extensions::ExtensionSystem::Get(profile)->process_manager()->
+          GetBackgroundHostForExtension(web_contents->GetURL().host());
+
+  if (extension_host && extension_host->host_contents() == web_contents)
+    return extension_host;
+
+  return NULL;
+}
+
+static const char kTargetIdField[]  = "id";
+static const char kTargetTypeField[]  = "type";
+static const char kTargetTitleField[]  = "title";
+static const char kTargetAttachedField[]  = "attached";
+static const char kTargetUrlField[]  = "url";
+static const char kTargetFaviconUrlField[] = "favicon_url";
+
+static const char kTargetTypePage[]  = "page";
+static const char kTargetTypeExtension[]  = "extension";
+
+static base::DictionaryValue* SerializePageInfo(RenderViewHost* rvh) {
+  DevToolsAgentHost* agent_host = DevToolsAgentHost::GetOrCreateFor(rvh);
+
+  base::DictionaryValue* dictionary = new base::DictionaryValue();
+
+  dictionary->SetString(kTargetIdField, agent_host->GetId());
+
+  WebContents* web_contents = WebContents::FromRenderViewHost(rvh);
+  extensions::ExtensionHost* extension_host =
+      GetExtensionBackgroundHost(web_contents);

[Matt Perry, 2013/03/18 19:53:44]

This is a very roundabout way to get the extension's name. It also won't work
for popups or other views. If you just want the name, use
ExtensionService::extensions()->GetExtensionOrAppByURL(url).

[Vladislav Kaznacheev, 2013/03/19 05:56:23]

It is not only only about the name. I need to know if the RenderViewHost belongs
to an extension background page. If so I use the extension name as a title (and
also set "extension" as a type). Otherwise I use the page title as a title (and
set "page" as a type). Added comments to both if branches.

Do you think that "background" would be a better name for a non-page debug
target than "extension"?



On 2013/03/18 19:53:44, Matt Perry wrote:

[Matt Perry, 2013/03/19 18:02:01]

OK, so you really do only want this to apply to background pages. In that case,
"background_page" would be a better name.

On 2013/03/19 05:56:23, Vladislav Kaznacheev wrote:

[Vladislav Kaznacheev, 2013/03/20 07:20:49]

Done.

+  if (extension_host) {
+    dictionary->SetString(kTargetTypeField, kTargetTypeExtension);
+    dictionary->SetString(kTargetTitleField,
+        extension_host->extension()->name());
+  } else {
+    dictionary->SetString(kTargetTypeField, kTargetTypePage);
+    if (web_contents)
+      dictionary->SetString(kTargetTitleField,
+          UTF16ToUTF8(net::EscapeForHTML(web_contents->GetTitle())));
+  }
+
+  dictionary->SetBoolean(kTargetAttachedField,
+      !!DevToolsManager::GetInstance()->GetDevToolsClientHostFor(agent_host));
+  if (web_contents) {

[Matt Perry, 2013/03/18 19:53:44]

Can web_contents actually be NULL? You use it in GetExtensionBackgroundHost
without NULL-checking it.

[Vladislav Kaznacheev, 2013/03/19 05:56:23]

You are right. This came from inspect_ui.cc where similar code exists. The
comment for WebContents::FromRenderViewHost says the return value can be NULL.
This would make the entire function useless, so I moved the check to the top of
the function.

On 2013/03/18 19:53:44, Matt Perry wrote:

+    dictionary->SetString(kTargetUrlField, web_contents->GetURL().spec());
+    content::NavigationController& controller = web_contents->GetController();
+    content::NavigationEntry* entry = controller.GetActiveEntry();
+    if (entry != NULL && entry->GetURL().is_valid()) {
+      dictionary->SetString(kTargetFaviconUrlField,
+          entry->GetFavicon().url.spec());
+    }
+  }
+
+  return dictionary;
+}
+
 }  // namespace
 
 static void CopyDebuggee(Debuggee & dst, const Debuggee& src) {
   if (src.tab_id)
     dst.tab_id.reset(new int(*src.tab_id));
   if (src.extension_id)
     dst.extension_id.reset(new std::string(*src.extension_id));
+  if (src.target_id)
+    dst.target_id.reset(new std::string(*src.target_id));
 }
 
 ExtensionDevToolsClientHost::ExtensionDevToolsClientHost(
     WebContents* web_contents,
     const std::string& extension_id,
     const std::string& extension_name,
     const Debuggee& debuggee)
     : web_contents_(web_contents),
       extension_id_(extension_id),
       last_request_id_(0),
@@ skipping 217 matching lines @@
     client_host_->MarkAsDismissed();
   return true;
 }
 
 DebuggerFunction::DebuggerFunction()
     : contents_(0),
       client_host_(0) {
 }
 
 void DebuggerFunction::FormatErrorMessage(const std::string& format) {
-  error_ = ErrorUtils::FormatErrorMessage(
-      format,
-      debuggee_.tab_id ?
-          keys::kTabTargetType :
-          keys::kExtensionTargetType,
-      debuggee_.tab_id ?
-          base::IntToString(*debuggee_.tab_id) :
-          *debuggee_.extension_id);
+  if (debuggee_.tab_id)
+    error_ = ErrorUtils::FormatErrorMessage(
+      format, keys::kTabTargetType, base::IntToString(*debuggee_.tab_id));
+  else if (debuggee_.extension_id)
+    error_ = ErrorUtils::FormatErrorMessage(
+      format, keys::kExtensionTargetType, *debuggee_.extension_id);
+  else
+    error_ = ErrorUtils::FormatErrorMessage(
+      format, keys::kOpaqueTargetType, *debuggee_.target_id);
 }
 
 bool DebuggerFunction::InitWebContents() {
   // Find the WebContents that contains this tab id.
   contents_ = NULL;
   if (debuggee_.tab_id) {
     WebContents* web_contents = NULL;
     bool result = ExtensionTabUtil::GetTabById(
         *debuggee_.tab_id, profile(), include_incognito(), NULL, NULL,
         &web_contents, NULL);
@@ skipping 28 matching lines @@
     if (host) {
       contents_ = WebContents::FromRenderViewHost(host->render_view_host());
       if (contents_)
         return true;
     }
 
     FormatErrorMessage(keys::kNoTargetError);
     return false;
   }
 
+  if (debuggee_.target_id) {
+    DevToolsAgentHost* agent_host =
+        DevToolsAgentHost::GetForId(*debuggee_.target_id);
+    if (agent_host) {
+      contents_ = WebContents::FromRenderViewHost(
+          agent_host->GetRenderViewHost());
+
+      if (!CommandLine::ForCurrentProcess()->
+           HasSwitch(switches::kSilentDebuggerExtensionAPI)) {
+        // Allow only tabs, reject background pages.

[Matt Perry, 2013/03/18 19:53:44]

Why? And what about popups or extension pages within a tab?

[Vladislav Kaznacheev, 2013/03/19 05:56:23]

When an extension attaches to the page using chrome.debugger API we must show a
warning infobar (for security reasons). 

When attaching to a background page there is nowhere we can show an infobar, so
when this feature was first supportd
(https://chromiumcodereview.appspot.com/12304021) in a decision has been made to
allow this only if the infobar is explicitly suppressed using
--silent-debugger-extension-api flag.

I agree that the comment is too cryptic, rewrote it for clarity.

On 2013/03/18 19:53:44, Matt Perry wrote:

[Matt Perry, 2013/03/19 18:02:01]

Might this apply to extension popups as well? If not, where would you show the
infobar in that case?

On 2013/03/19 05:56:23, Vladislav Kaznacheev wrote:

[Vladislav Kaznacheev, 2013/03/20 07:20:49]

Yes, I missed that. I have refactored the infobar handling. Instead of guessing
if it is OK to create the infobar I actually attempt to create the infobar
before attaching to the target. If the infobar cannot be created for any reason
I return an error.

On 2013/03/19 18:02:01, Matt Perry wrote:

+        if (GetExtensionBackgroundHost(contents_)) {
+          error_ = ErrorUtils::FormatErrorMessage(
+              keys::kSilentDebuggingRequired,
+              switches::kSilentDebuggerExtensionAPI);
+          return false;
+        }
+      }
+      return true;
+    }
+    FormatErrorMessage(keys::kNoTargetError);
+    return false;
+  }
+
   error_ = keys::kInvalidTargetError;
   return false;
 }
 
 bool DebuggerFunction::InitClientHost() {
   if (!InitWebContents())
     return false;
 
   // Don't fetch rvh from the contents since it'll be wrong upon navigation.
   client_host_ = AttachedClientHosts::GetInstance()->Lookup(contents_);
@@ skipping 89 matching lines @@
   }
 
   DictionaryValue* result_body;
   SendCommand::Results::Result result;
   if (response->GetDictionary("result", &result_body))
     result.additional_properties.Swap(result_body);
 
   results_ = SendCommand::Results::Create(result);
   SendResponse(true);
 }
+
+DebuggerGetTargetsFunction::DebuggerGetTargetsFunction() {}
+
+DebuggerGetTargetsFunction::~DebuggerGetTargetsFunction() {}
+
+bool DebuggerGetTargetsFunction::RunImpl() {
+  base::ListValue* results_list = new ListValue();
+
+  std::vector<RenderViewHost*> rvh_list =
+      DevToolsAgentHost::GetValidRenderViewHosts();
+  for (std::vector<RenderViewHost*>::iterator it = rvh_list.begin();
+       it != rvh_list.end(); ++it)
+    results_list->Append(SerializePageInfo(*it));
+
+  SetResult(results_list);
+  SendResponse(true);
+  return true;
+}