Add pyauto hook for getting and manipulating the data underneath the NTP....

chrome/browser/dom_ui/new_tab_ui.cc

 // Copyright (c) 2010 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 "build/build_config.h"
 
 #include "chrome/browser/dom_ui/new_tab_ui.h"
 
 #include <set>
 
 #include "app/l10n_util.h"
 #include "base/callback.h"
 #include "base/command_line.h"
 #include "base/histogram.h"
 #include "base/i18n/rtl.h"
 #include "base/singleton.h"
 #include "base/string_number_conversions.h"
 #include "base/thread.h"
 #include "base/utf_string_conversions.h"
 #include "chrome/browser/browser.h"
 #include "chrome/browser/chrome_thread.h"
 #include "chrome/browser/dom_ui/app_launcher_handler.h"
 #include "chrome/browser/dom_ui/dom_ui_theme_source.h"
 #include "chrome/browser/dom_ui/foreign_session_handler.h"
 #include "chrome/browser/dom_ui/most_visited_handler.h"
 #include "chrome/browser/dom_ui/new_tab_page_sync_handler.h"
 #include "chrome/browser/dom_ui/ntp_resource_cache.h"
 #include "chrome/browser/dom_ui/shown_sections_handler.h"
 #include "chrome/browser/dom_ui/tips_handler.h"
+#include "chrome/browser/dom_ui/value_helper.h"
 #include "chrome/browser/metrics/user_metrics.h"
 #include "chrome/browser/themes/browser_theme_provider.h"
 #include "chrome/browser/prefs/pref_service.h"
 #include "chrome/browser/profile.h"
 #include "chrome/browser/renderer_host/render_view_host.h"
 #include "chrome/browser/sessions/session_types.h"
 #include "chrome/browser/sessions/tab_restore_service.h"
 #include "chrome/browser/sessions/tab_restore_service_observer.h"
 #include "chrome/browser/sync/profile_sync_service.h"
 #include "chrome/browser/tab_contents/tab_contents.h"
@@ skipping 104 matching lines @@
   // Observer callback for TabRestoreServiceObserver. Sends data on
   // recently closed tabs to the javascript side of this page to
   // display to the user.
   virtual void TabRestoreServiceChanged(TabRestoreService* service);
 
   // Observer callback to notice when our associated TabRestoreService
   // is destroyed.
   virtual void TabRestoreServiceDestroyed(TabRestoreService* service);
 
  private:
-  // Converts a closed tab to the value sent down to the NTP. Returns true on
-  // success, false if the value shouldn't be sent down.
-  bool TabToValue(const TabRestoreService::Tab& tab,
-                  DictionaryValue* dictionary);
-
-  // Converts a closed window to the value sent down to the NTP. Returns true
-  // on success, false if the value shouldn't be sent down.
-  bool WindowToValue(const TabRestoreService::Window& window,
-                     DictionaryValue* dictionary);
-
-  // Adds tab to unique_items list if it is not present. Returns false if
-  // tab was already in the list, true if it was absent.  A tab is
-  // considered unique if no other tab shares both its title and its url.
-  bool EnsureTabIsUnique(const DictionaryValue* tab,
-                         std::set<std::string>* unique_items);
-
   // TabRestoreService that we are observing.
   TabRestoreService* tab_restore_service_;
 
   DISALLOW_COPY_AND_ASSIGN(RecentlyClosedTabsHandler);
 };
 
 void RecentlyClosedTabsHandler::RegisterMessages() {
   dom_ui_->RegisterMessageCallback("getRecentlyClosedTabs",
       NewCallback(this,
                   &RecentlyClosedTabsHandler::HandleGetRecentlyClosedTabs));
@@ skipping 34 matching lines @@
       tab_restore_service_->AddObserver(this);
     }
   }
 
   if (tab_restore_service_)
     TabRestoreServiceChanged(tab_restore_service_);
 }
 
 void RecentlyClosedTabsHandler::TabRestoreServiceChanged(
     TabRestoreService* service) {
-  const TabRestoreService::Entries& entries = service->entries();
   ListValue list_value;
-  std::set<std::string> unique_items;
-  int added_count = 0;
-  const int max_count = 10;
+  NewTabUI::AddRecentlyClosedEntries(service->entries(), &list_value);
 
-  // We filter the list of recently closed to only show 'interesting' entries,
-  // where an interesting entry is either a closed window or a closed tab
-  // whose selected navigation is not the new tab ui.
-  for (TabRestoreService::Entries::const_iterator it = entries.begin();
-       it != entries.end() && added_count < max_count; ++it) {
-    TabRestoreService::Entry* entry = *it;
-    DictionaryValue* value = new DictionaryValue();
-    if ((entry->type == TabRestoreService::TAB &&
-         TabToValue(*static_cast<TabRestoreService::Tab*>(entry), value) &&
-         EnsureTabIsUnique(value, &unique_items)) ||
-        (entry->type == TabRestoreService::WINDOW &&
-         WindowToValue(*static_cast<TabRestoreService::Window*>(entry),
-                       value))) {
-      value->SetInteger("sessionId", entry->id);
-      list_value.Append(value);
-      added_count++;
-    } else {
-      delete value;
-    }
-  }
   dom_ui_->CallJavascriptFunction(L"recentlyClosedTabs", list_value);
 }
 
 void RecentlyClosedTabsHandler::TabRestoreServiceDestroyed(
     TabRestoreService* service) {
   tab_restore_service_ = NULL;
 }
 
-bool RecentlyClosedTabsHandler::TabToValue(
-    const TabRestoreService::Tab& tab,
-    DictionaryValue* dictionary) {
-  if (tab.navigations.empty())
-    return false;
-
-  const TabNavigation& current_navigation =
-      tab.navigations.at(tab.current_navigation_index);
-  if (current_navigation.virtual_url() == GURL(chrome::kChromeUINewTabURL))
-    return false;
-
-  NewTabUI::SetURLTitleAndDirection(dictionary, current_navigation.title(),
-                                    current_navigation.virtual_url());
-  dictionary->SetString("type", "tab");
-  dictionary->SetReal("timestamp", tab.timestamp.ToDoubleT());
-  return true;
-}
-
-bool RecentlyClosedTabsHandler::WindowToValue(
-    const TabRestoreService::Window& window,
-    DictionaryValue* dictionary) {
-  if (window.tabs.empty()) {
-    NOTREACHED();
-    return false;
-  }
-
-  ListValue* tab_values = new ListValue();
-  for (size_t i = 0; i < window.tabs.size(); ++i) {
-    DictionaryValue* tab_value = new DictionaryValue();
-    if (TabToValue(window.tabs[i], tab_value))
-      tab_values->Append(tab_value);
-    else
-      delete tab_value;
-  }
-  if (tab_values->GetSize() == 0) {
-    delete tab_values;
-    return false;
-  }
-
-  dictionary->SetString("type", "window");
-  dictionary->SetReal("timestamp", window.timestamp.ToDoubleT());
-  dictionary->Set("tabs", tab_values);
-  return true;
-}
-
-bool RecentlyClosedTabsHandler::EnsureTabIsUnique(
-    const DictionaryValue* tab,
-    std::set<std::string>* unique_items) {
-  DCHECK(unique_items);
-  std::string title;
-  std::string url;
-  if (tab->GetString("title", &title) &&
-      tab->GetString("url", &url)) {
-    // TODO(viettrungluu): this isn't obviously reliable, since different
-    // combinations of titles/urls may conceivably yield the same string.
-    std::string unique_key = title + url;
-    if (unique_items->find(unique_key) != unique_items->end())
-      return false;
-    else
-      unique_items->insert(unique_key);
-  }
-  return true;
-}
-
 
 ///////////////////////////////////////////////////////////////////////////////
 // MetricsHandler
 
 // Let the page contents record UMA actions. Only use when you can't do it from
 // C++. For example, we currently use it to let the NTP log the postion of the
 // Most Visited or Bookmark the user clicked on, as we don't get that
 // information through RequestOpenURL. You will need to update the metrics
 // dashboard with the action names you use, as our processor won't catch that
 // information (treat it as RecordComputedMetrics)
@@ skipping 266 matching lines @@
         direction = kRTLHtmlTextDirection;
       } else {
         base::i18n::WrapStringWithLTRFormatting(&title_to_set);
       }
     }
   }
   dictionary->SetString("title", title_to_set);
   dictionary->SetString("direction", direction);
 }
 
+namespace {
+
+bool IsTabUnique(const DictionaryValue* tab,
+                 std::set<std::string>* unique_items) {
+  DCHECK(unique_items);
+  std::string title;
+  std::string url;
+  if (tab->GetString("title", &title) &&
+      tab->GetString("url", &url)) {
+    // TODO(viettrungluu): this isn't obviously reliable, since different
+    // combinations of titles/urls may conceivably yield the same string.
+    std::string unique_key = title + url;
+    if (unique_items->find(unique_key) != unique_items->end())
+      return false;
+    else
+      unique_items->insert(unique_key);
+  }
+  return true;
+}
+
+}  // namespace
+
+// static
+void NewTabUI::AddRecentlyClosedEntries(
+    const TabRestoreService::Entries& entries, ListValue* entry_list_value) {
+  const int max_count = 10;
+  int added_count = 0;
+  std::set<std::string> unique_items;
+  // We filter the list of recently closed to only show 'interesting' entries,
+  // where an interesting entry is either a closed window or a closed tab
+  // whose selected navigation is not the new tab ui.
+  for (TabRestoreService::Entries::const_iterator it = entries.begin();
+       it != entries.end() && added_count < max_count; ++it) {
+    TabRestoreService::Entry* entry = *it;
+    scoped_ptr<DictionaryValue> entry_dict(new DictionaryValue());
+    if ((entry->type == TabRestoreService::TAB &&
+         ValueHelper::TabToValue(
+             *static_cast<TabRestoreService::Tab*>(entry),
+             entry_dict.get()) &&
+         IsTabUnique(entry_dict.get(), &unique_items)) ||
+        (entry->type == TabRestoreService::WINDOW &&
+         ValueHelper::WindowToValue(
+             *static_cast<TabRestoreService::Window*>(entry),
+             entry_dict.get()))) {
+      entry_dict->SetInteger("sessionId", entry->id);
+      entry_list_value->Append(entry_dict.release());
+      added_count++;
+    }
+  }
+}
+
 ///////////////////////////////////////////////////////////////////////////////
 // NewTabHTMLSource
 
 bool NewTabUI::NewTabHTMLSource::first_run_ = true;
 
 NewTabUI::NewTabHTMLSource::NewTabHTMLSource(Profile* profile)
     : DataSource(chrome::kChromeUINewTabHost, MessageLoop::current()),
       profile_(profile) {
 }
 
@@ skipping 11 matching lines @@
 
   scoped_refptr<RefCountedBytes> html_bytes =
       profile_->GetNTPResourceCache()->GetNewTabHTML(is_off_the_record);
 
   SendResponse(request_id, html_bytes);
 }
 
 std::string NewTabUI::NewTabHTMLSource::GetMimeType(const std::string&) const {
   return "text/html";
 }