Notify DataUseTabModel of navigations and tab closures

chrome/browser/android/data_usage/data_use_ui_tab_model.cc

 // Copyright 2015 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/android/data_usage/data_use_ui_tab_model.h"
 
 #include <utility>
 
 #include "base/logging.h"
 #include "base/memory/ref_counted.h"
 #include "base/single_thread_task_runner.h"
 #include "content/public/browser/browser_thread.h"
 #include "url/gurl.h"
 
 namespace chrome {
 
 namespace android {
 
+// Notifies |data_use_tab_model| of navigation event on IO thread.
+void OnNavigationEventOnIOThread(

[sclittle, 2015/11/16 23:13:42]

Can these functions be moved to an anonymous namespace?

[tbansal1, 2015/11/17 21:12:33]

Done.

+    base::WeakPtr<DataUseTabModel> data_use_tab_model,
+    int32_t tab_id,
+    DataUseTabModel::TransitionType transition,
+    const GURL gurl) {
+  DCHECK(content::BrowserThread::CurrentlyOn(content::BrowserThread::IO));
+
+  if (!data_use_tab_model)
+    return;
+  data_use_tab_model->OnNavigationEvent(tab_id, transition, gurl);
+}
+
+// Notifies |data_use_tab_model| of tab closure on IO thread.
+void OnTabCloseEventOnIOThread(
+    base::WeakPtr<DataUseTabModel> data_use_tab_model,
+    int32_t tab_id) {
+  DCHECK(content::BrowserThread::CurrentlyOn(content::BrowserThread::IO));
+
+  if (!data_use_tab_model)
+    return;
+  data_use_tab_model->OnTabCloseEvent(tab_id);
+}
+
 DataUseUITabModel::DataUseUITabModel(
     scoped_refptr<base::SingleThreadTaskRunner> io_task_runner)
-    : io_task_runner_(io_task_runner) {
+    : registered_as_observer_(false), io_task_runner_(io_task_runner) {
   DCHECK(io_task_runner_);
 }
 
-DataUseUITabModel::~DataUseUITabModel() {}
+DataUseUITabModel::~DataUseUITabModel() {
+  if (registered_as_observer_ && ui_data_use_tab_model_) {
+    registered_as_observer_ = false;
+    ui_data_use_tab_model_->RemoveObserver(this);
+  }
+}
 
 void DataUseUITabModel::ReportBrowserNavigation(
     const GURL& gurl,
     ui::PageTransition page_transition,
     int32_t tab_id) const {
   DCHECK(content::BrowserThread::CurrentlyOn(content::BrowserThread::UI));
   DCHECK(thread_checker_.CalledOnValidThread());
 
-  // TODO(tbansal): Post to DataUseTabModel on IO thread.
+  DataUseTabModel::TransitionType transition_type;
+
+  if (ConvertTransitionType(page_transition, &transition_type)) {
+    io_task_runner_->PostTask(
+        FROM_HERE,
+        base::Bind(&OnNavigationEventOnIOThread, io_data_use_tab_model_, tab_id,
+                   transition_type, gurl));
+  }
 }
 
 void DataUseUITabModel::ReportTabClosure(int32_t tab_id) {
   DCHECK(content::BrowserThread::CurrentlyOn(content::BrowserThread::UI));
   DCHECK(thread_checker_.CalledOnValidThread());
 
-  // TODO(tbansal): Post to DataUseTabModel on IO thread.
+  io_task_runner_->PostTask(
+      FROM_HERE,
+      base::Bind(&OnTabCloseEventOnIOThread, io_data_use_tab_model_, tab_id));
 
   // Clear out local state.
   TabEvents::iterator it = tab_events_.find(tab_id);
   if (it == tab_events_.end())
     return;
   tab_events_.erase(it);
 }
 
-void DataUseUITabModel::OnTrackingStarted(int32_t tab_id) {
+void DataUseUITabModel::NotifyTrackingStarting(int32_t tab_id) {
   DCHECK(content::BrowserThread::CurrentlyOn(content::BrowserThread::UI));
   DCHECK(thread_checker_.CalledOnValidThread());
 
   if (MaybeCreateTabEvent(tab_id, DATA_USE_TRACKING_STARTED))
     return;
   // Since tracking started before the UI could indicate that it ended, it is
   // not useful for UI to show that it started again.
   RemoveTabEvent(tab_id, DATA_USE_TRACKING_ENDED);
 }
 
-void DataUseUITabModel::OnTrackingEnded(int32_t tab_id) {
+void DataUseUITabModel::NotifyTrackingEnding(int32_t tab_id) {
   DCHECK(content::BrowserThread::CurrentlyOn(content::BrowserThread::UI));
   DCHECK(thread_checker_.CalledOnValidThread());
 
   if (MaybeCreateTabEvent(tab_id, DATA_USE_TRACKING_ENDED))
     return;
   // Since tracking ended before the UI could indicate that it stated, it is not
   // useful for UI to show that it ended.
   RemoveTabEvent(tab_id, DATA_USE_TRACKING_STARTED);
 }
 
@@ skipping 12 matching lines @@
   DCHECK(content::BrowserThread::CurrentlyOn(content::BrowserThread::UI));
   DCHECK(thread_checker_.CalledOnValidThread());
 
   TabEvents::iterator it = tab_events_.find(tab_id);
   if (it == tab_events_.end())
     return false;
 
   return RemoveTabEvent(tab_id, DATA_USE_TRACKING_ENDED);
 }
 
+void DataUseUITabModel::SetIODataUseTabModel(
+    base::WeakPtr<DataUseTabModel> io_data_use_tab_model) {
+  DCHECK(content::BrowserThread::CurrentlyOn(content::BrowserThread::UI));
+  DCHECK(thread_checker_.CalledOnValidThread());
+
+  io_data_use_tab_model_ = io_data_use_tab_model;
+}
+
+void DataUseUITabModel::SetUIDataUseTabModel(
+    base::WeakPtr<DataUseTabModel> ui_data_use_tab_model) {
+  DCHECK(content::BrowserThread::CurrentlyOn(content::BrowserThread::UI));
+  DCHECK(thread_checker_.CalledOnValidThread());
+
+  ui_data_use_tab_model_ = ui_data_use_tab_model;
+  if (registered_as_observer_ || !ui_data_use_tab_model_)
+    return;
+  registered_as_observer_ = true;
+  ui_data_use_tab_model_->AddObserver(this);
+}
+
 bool DataUseUITabModel::MaybeCreateTabEvent(int32_t tab_id,
                                             DataUseTrackingEvent event) {
   TabEvents::iterator it = tab_events_.find(tab_id);
   if (it == tab_events_.end()) {
     tab_events_.insert(std::make_pair(tab_id, event));
     return true;
   }
   return false;
 }
 
 bool DataUseUITabModel::RemoveTabEvent(int32_t tab_id,
                                        DataUseTrackingEvent event) {
   TabEvents::iterator it = tab_events_.find(tab_id);
   DCHECK(it != tab_events_.end());
   if (it->second == event) {
     tab_events_.erase(it);
     return true;
   }
   return false;
 }
 
+bool DataUseUITabModel::ConvertTransitionType(
+    ui::PageTransition page_transition,
+    DataUseTabModel::TransitionType* transition_type) const {
+  if (!ui::PageTransitionIsValidType(page_transition) ||
+      !ui::PageTransitionIsMainFrame(page_transition) ||
+      !ui::PageTransitionIsNewNavigation(page_transition)) {
+    return false;
+  }
+
+  const int32_t mask = 0xFFFFFFFF ^ ui::PAGE_TRANSITION_QUALIFIER_MASK;
+
+  switch (page_transition & mask) {
+    case ui::PAGE_TRANSITION_LINK:
+      if ((page_transition & ui::PAGE_TRANSITION_FROM_API) != 0) {
+        // Clicking on bookmarks.
+        *transition_type = DataUseTabModel::TRANSITION_BOOKMARK;
+        return true;
+      }
+      return false;  // Newtab, clicking on a link.
+    case ui::PAGE_TRANSITION_TYPED:
+      *transition_type = DataUseTabModel::TRANSITION_OMNIBOX_NAVIGATION;
+      return true;
+    case ui::PAGE_TRANSITION_AUTO_BOOKMARK:
+      // Auto bookmark from newtab page.
+      *transition_type = DataUseTabModel::TRANSITION_BOOKMARK;
+      return true;
+    case ui::PAGE_TRANSITION_AUTO_TOPLEVEL:
+      // History menu.
+      *transition_type = DataUseTabModel::TRANSITION_HISTORY_ITEM;
+      return true;
+    case ui::PAGE_TRANSITION_GENERATED:
+      // Omnibox search (e.g., searching for "tacos").
+      *transition_type = DataUseTabModel::TRANSITION_OMNIBOX_SEARCH;
+      return true;
+    case ui::PAGE_TRANSITION_RELOAD:
+      // Restored tabs.
+      return false;
+    default:
+      return false;
+  }
+}
+
 }  // namespace android
 
 }  // namespace chrome