platform apps: use app name for WebRTC balloons

chrome/browser/media/media_stream_capture_indicator.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/media/media_stream_capture_indicator.h"
 
 #include "base/bind.h"
 #include "base/i18n/rtl.h"
 #include "base/utf_string_conversions.h"
 #include "chrome/app/chrome_command_ids.h"
 #include "chrome/browser/browser_process.h"
+#include "chrome/browser/extensions/extension_service.h"
+#include "chrome/browser/profiles/profile.h"
 #include "chrome/browser/status_icons/status_icon.h"
 #include "chrome/browser/status_icons/status_tray.h"
 #include "chrome/browser/tab_contents/tab_util.h"
 #include "content/public/browser/browser_thread.h"
 #include "content/public/browser/content_browser_client.h"
 #include "content/public/browser/render_view_host.h"
 #include "content/public/browser/web_contents.h"
 #include "content/public/browser/web_contents_delegate.h"
 #include "grit/chromium_strings.h"
 #include "grit/generated_resources.h"
 #include "grit/theme_resources.h"
 #include "net/base/net_util.h"
 #include "ui/base/l10n/l10n_util.h"
 #include "ui/base/resource/resource_bundle.h"
 
 using content::BrowserThread;
 using content::WebContents;
 
+namespace {
+
+const extensions::Extension* GetExtension(int render_process_id,
+                                          int render_view_id) {
+  DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
+
+  WebContents* web_contents = tab_util::GetWebContentsByID(
+      render_process_id, render_view_id);
+  if (!web_contents)
+    return NULL;
+
+  Profile* profile =
+      Profile::FromBrowserContext(web_contents->GetBrowserContext());
+  ExtensionService* extensions =
+      !profile ? NULL : profile->GetExtensionService();

[scherkus (not reviewing), 2012/07/31 02:14:12]

this tertiary-operator-ness is hurting my eyes -- how about a more conventional
early return approach?

if (!profile)
  return NULL;
ExtensionService* extensions = profile->GetExtensionService();
if (!extensions)
  return NULL;
return extensions->extensions()->GetXXX(...);

[Evan Stade, 2012/07/31 23:19:29]

Done.

+  return !extensions ? NULL :
+      extensions->extensions()->GetExtensionOrAppByURL(
+          ExtensionURLInfo(web_contents->GetURL()));
+}
+
+// Gets the security originator of the tab. It returns a string with no '/'
+// at the end to display in the UI.
+string16 GetSecurityOrigin(int render_process_id, int render_view_id) {
+  DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
+  WebContents* tab_content = tab_util::GetWebContentsByID(
+      render_process_id, render_view_id);
+  if (!tab_content)
+    return string16();
+
+  std::string security_origin = tab_content->GetURL().GetOrigin().spec();
+
+  // Remove the last character if it is a '/'.
+  if (!security_origin.empty()) {
+    std::string::iterator it = security_origin.end() - 1;
+    if (*it == '/')
+      security_origin.erase(it);
+  }
+
+  return UTF8ToUTF16(security_origin);
+}
+
+string16 GetTitle(int render_process_id, int render_view_id) {
+  DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
+
+  const extensions::Extension* extension =
+      GetExtension(render_process_id, render_view_id);
+  if (extension)
+    return UTF8ToUTF16(extension->name());
+
+  WebContents* tab_content = tab_util::GetWebContentsByID(
+      render_process_id, render_view_id);
+  if (!tab_content)
+    return string16();
+
+  string16 tab_title = tab_content->GetTitle();
+
+  if (tab_title.empty()) {
+    // If the page's title is empty use its security originator.
+    tab_title = GetSecurityOrigin(render_process_id, render_view_id);
+  } else {
+    // If the page's title matches its URL, use its security originator.
+    std::string languages =
+        content::GetContentClient()->browser()->GetAcceptLangs(
+            tab_content->GetBrowserContext());
+    if (tab_title == net::FormatUrl(tab_content->GetURL(), languages))
+      tab_title = GetSecurityOrigin(render_process_id, render_view_id);
+  }
+
+  return tab_title;
+}
+
+}  // namespace
+
 MediaStreamCaptureIndicator::TabEquals::TabEquals(int render_process_id,
                                                   int render_view_id)
     : render_process_id_(render_process_id),
       render_view_id_(render_view_id) {}
 
 bool MediaStreamCaptureIndicator::TabEquals::operator() (
     const MediaStreamCaptureIndicator::CaptureDeviceTab& tab) {
     return (render_process_id_ == tab.render_process_id &&
             render_view_id_ == tab.render_view_id);
 }
 
 MediaStreamCaptureIndicator::MediaStreamCaptureIndicator()
     : status_icon_(NULL),
       mic_image_(NULL),
       camera_image_(NULL),
-      balloon_image_(NULL) {
+      balloon_image_(NULL),
+      ALLOW_THIS_IN_INITIALIZER_LIST(tracker_(this)),
+      image_load_index_(-1),
+      pending_message_id_(0) {
 }
 
 MediaStreamCaptureIndicator::~MediaStreamCaptureIndicator() {
   // The user is responsible for cleaning up by closing all the opened devices.
   DCHECK(tabs_.empty());
 }
 
 bool MediaStreamCaptureIndicator::IsCommandIdChecked(
     int command_id) const {
   NOTIMPLEMENTED() << "There are no checked items in the MediaStream menu.";
@@ skipping 115 matching lines @@
   }
   DCHECK(mic_image_);
   DCHECK(camera_image_);
   DCHECK(balloon_image_);
 }
 
 void MediaStreamCaptureIndicator::ShowBalloon(
     int render_process_id,
     int render_view_id,
     bool audio,
-    bool video) const {
+    bool video) {
   DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
   DCHECK(audio || video);
-  string16 title = l10n_util::GetStringUTF16(IDS_PRODUCT_NAME);
 
   int message_id = IDS_MEDIA_STREAM_STATUS_TRAY_BALLOON_BODY_AUDIO_AND_VIDEO;
   if (audio && !video)
     message_id = IDS_MEDIA_STREAM_STATUS_TRAY_BALLOON_BODY_AUDIO_ONLY;
   else if (!audio && video)
     message_id = IDS_MEDIA_STREAM_STATUS_TRAY_BALLOON_BODY_VIDEO_ONLY;
 
-  string16 body = l10n_util::GetStringFUTF16(
-      message_id, GetSecurityOrigin(render_process_id, render_view_id));
+  const extensions::Extension* extension =
+      GetExtension(render_process_id, render_view_id);
+  if (extension) {
+    pending_message_id_ = message_id;
+    pending_extension_name_ = extension->name();

[no longer working on chromium, 2012/07/31 08:24:37]

can we simply store the 10n_util::GetStringFUTF16(message_id,        
UTF8ToUTF16(extension->name()))) ?

[Evan Stade, 2012/07/31 23:19:29]

Done.

+    return ShowBalloonForExtension(extension);
+  }
 
+  string16 title = l10n_util::GetStringUTF16(IDS_PRODUCT_NAME);
+  string16 body = l10n_util::GetStringFUTF16(message_id,
+      GetSecurityOrigin(render_process_id, render_view_id));
   status_icon_->DisplayBalloon(*balloon_image_, title, body);
 }
 
+void MediaStreamCaptureIndicator::ShowBalloonForExtension(
+    const extensions::Extension* extension) {
+  image_load_index_++;

[no longer working on chromium, 2012/07/31 08:24:37]

++image_load_index_;

[Evan Stade, 2012/07/31 23:19:29]

Done.

+  tracker_.LoadImage(
+      extension,
+      extension->GetIconResource(32, ExtensionIconSet::MATCH_BIGGER),
+      gfx::Size(32, 32),
+      ImageLoadingTracker::CACHE);
+}
+
+void MediaStreamCaptureIndicator::OnImageLoaded(
+    const gfx::Image& image,
+    const std::string& extension_id,

[no longer working on chromium, 2012/07/31 08:24:37]

What is the difference between extension_id and extension->name()?

[Evan Stade, 2012/07/31 23:19:29]

name is a display string, extension_id() is a hash

+    int index) {
+  if (index != image_load_index_)

[scherkus (not reviewing), 2012/07/31 02:14:12]

is this to prevent displaying older images that may have loaded?

[no longer working on chromium, 2012/07/31 08:24:37]

are we skipping showing the balloon when the new ShowBalloonForExtension comes
before OnImageLoaded?
Or shall we show the ballon anyway, can we use extension_id for this case?

[Evan Stade, 2012/07/31 23:19:29]

yes
well, we can't use extension id without knowing what type of message to show.
The same extension could request video, then audio. Instead I've created a
message map.

+    return;
+
+  status_icon_->DisplayBalloon(
+      !image.IsEmpty() ? *image.ToImageSkia() :
+          *ResourceBundle::GetSharedInstance().GetImageSkiaNamed(
+              IDR_APP_DEFAULT_ICON),
+      string16(),
+      l10n_util::GetStringFUTF16(pending_message_id_,
+                                 UTF8ToUTF16(pending_extension_name_)));
+}
+
 void MediaStreamCaptureIndicator::Hide() {
   DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
   if (!status_icon_)
     return;
 
   // If there is no browser process, we should not do anything.
   if (!g_browser_process)
     return;
 
   StatusTray* status_tray = g_browser_process->status_tray();
@@ skipping 120 matching lines @@
   // Remove the tab if all the devices have been closed.
   if (iter->audio_ref_count == 0 && iter->video_ref_count == 0)
     tabs_.erase(iter);
 
   if (tabs_.empty())
     Hide();
   else
     UpdateStatusTrayIconContextMenu();
 }
 
-string16 MediaStreamCaptureIndicator::GetTitle(int render_process_id,
-                                               int render_view_id) const {
-  DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
-  WebContents* tab_content = tab_util::GetWebContentsByID(
-      render_process_id, render_view_id);
-  if (!tab_content)
-    return string16();
-
-  string16 tab_title = tab_content->GetTitle();
-
-  if (tab_title.empty()) {
-    // If the page's title is empty use its security originator.
-    tab_title = GetSecurityOrigin(render_process_id, render_view_id);
-  } else {
-    // If the page's title matches its URL, use its security originator.
-    std::string languages =
-        content::GetContentClient()->browser()->GetAcceptLangs(
-            tab_content->GetBrowserContext());
-    if (tab_title == net::FormatUrl(tab_content->GetURL(), languages))
-      tab_title = GetSecurityOrigin(render_process_id, render_view_id);
-  }
-
-  return tab_title;
-}
-
-string16 MediaStreamCaptureIndicator::GetSecurityOrigin(
-    int render_process_id, int render_view_id) const {
-  DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
-  WebContents* tab_content = tab_util::GetWebContentsByID(
-      render_process_id, render_view_id);
-  if (!tab_content)
-    return string16();
-
-  std::string security_origin = tab_content->GetURL().GetOrigin().spec();
-
-  // Remove the last character if it is a '/'.
-  if (!security_origin.empty()) {
-    std::string::iterator it = security_origin.end() - 1;
-    if (*it == '/')
-      security_origin.erase(it);
-  }
-
-  return UTF8ToUTF16(security_origin);
-}