History: Add range navigation control for grouped visits

chrome/browser/ui/webui/history_ui.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/ui/webui/history_ui.h"
 
 #include <set>
 
 #include "base/bind.h"
 #include "base/bind_helpers.h"
@@ skipping 126 matching lines @@
                              IDS_HISTORY_ACTION_MENU_DESCRIPTION);
   source->AddLocalizedString("removeFromHistory", IDS_HISTORY_REMOVE_PAGE);
   source->AddLocalizedString("moreFromSite", IDS_HISTORY_MORE_FROM_SITE);
   source->SetJsonPath(kStringsJsFile);
   source->AddResourcePath(kHistoryJsFile, IDR_HISTORY_JS);
   source->SetDefaultResource(IDR_HISTORY_HTML);
   source->SetUseJsonJSFormatV2();
   source->AddLocalizedString("displayfiltersites", IDS_GROUP_BY_DOMAIN_LABEL);
   source->AddLocalizedString("rangeweek", IDS_HISTORY_RANGE_WEEK);
   source->AddLocalizedString("rangemonth", IDS_HISTORY_RANGE_MONTH);
-  source->AddLocalizedString("displayfiltersites", IDS_GROUP_BY_DOMAIN_LABEL);
+  source->AddLocalizedString("rangetoday", IDS_HISTORY_RANGE_TODAY);
   source->AddLocalizedString("numbervisits", IDS_HISTORY_NUMBER_VISITS);
   source->AddBoolean("groupByDomain",
       CommandLine::ForCurrentProcess()->HasSwitch(
           switches::kHistoryEnableGroupByDomain));
 
   return source;
 }
 
 string16 getRelativeDateLocalized(const base::Time& visit_time) {
   base::Time midnight_today = base::Time::Now().LocalMidnight();
@@ skipping 97 matching lines @@
         FROM_HERE, base::TimeDelta::FromSeconds(kWebHistoryTimeoutSeconds),
         this, &BrowsingHistoryHandler::WebHistoryTimeout);
   }
 }
 
 void BrowsingHistoryHandler::HandleQueryHistory(const ListValue* args) {
   history::QueryOptions options;
 
   // Parse the arguments from JavaScript. There are six required arguments:
   // - the text to search for (may be empty)
+  // - the offset from which the search should start in multiple of the range.
   // - the range (number) of days to search for, used only for grouped
   //   searches.
   // - the end time of the range to search (see QueryOptions.end_time)
   // - the search cursor, an opaque value from a previous query result, which
   //   allows this query to pick up where the previous one left off. May be
   //   null or undefined.
   // - the maximum number of results to return (may be 0, meaning that there
   //   is no maximum).
   string16 search_text = ExtractStringValue(args);
-  int range;
-  if (!args->GetInteger(1, &range)) {
+  int offset;
+  if (!args->GetInteger(1, &offset)) {
     NOTREACHED() << "Failed to convert argument 1. ";
     return;
   }
+  int range;
+  if (!args->GetInteger(2, &range)) {
+    NOTREACHED() << "Failed to convert argument 2. ";
+    return;
+  }
+
+  double end_time;
+  if (!args->GetDouble(3, &end_time)) {
+    NOTREACHED() << "Failed to convert argument 3. ";
+    return;
+  }
+  if (end_time)
+    options.end_time = base::Time::FromJsTime(end_time);
 
   switch (range) {
     case BrowsingHistoryHandler::MONTH:
-      SetQueryTimeInMonths(&options);
+      SetQueryTimeInMonths(offset, &options);
       break;
     case BrowsingHistoryHandler::WEEK:
-      SetQueryTimeInWeeks(&options);
+      SetQueryTimeInWeeks(offset, &options);
       break;
     case BrowsingHistoryHandler::NOT_GROUPED:
       break;
   }
 
-  double end_time;
-  if (!args->GetDouble(2, &end_time)) {
-    NOTREACHED() << "Failed to convert argument 2. ";
-    return;
-  }
-  if (end_time)
-    options.end_time = base::Time::FromJsTime(end_time);
-
   const Value* cursor_value;
 
   // Get the cursor. It must be either null, or a list.
-  if (!args->Get(3, &cursor_value) ||
+  if (!args->Get(4, &cursor_value) ||
       (!cursor_value->IsType(Value::TYPE_NULL) &&
       !history::QueryCursor::FromValue(cursor_value, &options.cursor))) {
-    NOTREACHED() << "Failed to convert argument 3. ";
+    NOTREACHED() << "Failed to convert argument 4. ";
     return;
   }
 
-  if (!ExtractIntegerValueAtIndex(args, 4, &options.max_count)) {
-    NOTREACHED() << "Failed to convert argument 4.";
+  if (!ExtractIntegerValueAtIndex(args, 5, &options.max_count)) {
+    NOTREACHED() << "Failed to convert argument 5.";
     return;
   }
 
   options.duplicate_policy = history::QueryOptions::REMOVE_DUPLICATES_PER_DAY;
   QueryHistory(search_text, options);
 }
 
 void BrowsingHistoryHandler::HandleRemoveURLsOnOneDay(const ListValue* args) {
   if (delete_task_tracker_.HasTrackedTasks()) {
     web_ui()->CallJavascriptFunction("deleteFailed");
@@ skipping 202 matching lines @@
 }
 
 void BrowsingHistoryHandler::RemoveComplete() {
   urls_to_be_deleted_.clear();
 
   // Notify the page that the deletion request succeeded.
   web_ui()->CallJavascriptFunction("deleteComplete");
 }
 
 void BrowsingHistoryHandler::SetQueryTimeInWeeks(
-    history::QueryOptions* options) {
+    int offset, history::QueryOptions* options) {
   // LocalMidnight returns the beginning of the current day so get the
   // beginning of the next one.
   base::Time midnight_today = base::Time::Now().LocalMidnight() +
                               base::TimeDelta::FromDays(1);
-  options->end_time = midnight_today;
-  options->begin_time = midnight_today - base::TimeDelta::FromDays(7);
+  options->end_time = midnight_today -
+      base::TimeDelta::FromDays(7 * offset);
+  options->begin_time = midnight_today -
+      base::TimeDelta::FromDays(7 * (offset + 1));
 }
 
 void BrowsingHistoryHandler::SetQueryTimeInMonths(
-    history::QueryOptions* options) {
+    int offset, history::QueryOptions* options) {
   // Configure the begin point of the search to the start of the
   // current month.
   base::Time::Exploded exploded;
   base::Time::Now().LocalMidnight().LocalExplode(&exploded);
   exploded.day_of_month = 1;
-  options->begin_time = base::Time::FromLocalExploded(exploded);
 
-  // Set the end time of this first search to null (which will
-  // show results from the future, should the user's clock have
-  // been set incorrectly).
-  options->end_time = base::Time();
+  if (offset == 0) {
+    options->begin_time = base::Time::FromLocalExploded(exploded);
+
+    // Set the end time of this first search to null (which will
+    // show results from the future, should the user's clock have
+    // been set incorrectly).
+    options->end_time = base::Time();

[James Hawkins, 2013/01/28 17:48:15]

This block of code (all the green) is somewhat hairy wrt calculations and
whatnot.  I suggest refactoring to pull out into one more more well-named
functions.

[Sergiu, 2013/01/30 16:09:39]

I've refactored this making it simple, hopefully it is clearer now.

+  } else {
+    // Set the end-time of this search to the end of the month that is
+    // |offset| months before the search end point. The end time is not
+    // inclusive, so we should set it to midnight on the first day of the
+    // following month.
+    exploded.month -= offset - 1;
+    while (exploded.month < 1) {
+      exploded.month += 12;
+      exploded.year--;
+    }
+    options->end_time = base::Time::FromLocalExploded(exploded);
+
+    // Set the begin-time of the search to the start of the month
+    // that is |offset| months prior to search_start_.
+    if (exploded.month > 1) {
+      exploded.month--;
+    } else {
+      exploded.month = 12;
+      exploded.year--;
+    }
+    options->begin_time = base::Time::FromLocalExploded(exploded);
+  }
 }
 
 // Helper function for Observe that determines if there are any differences
 // between the URLs noticed for deletion and the ones we are expecting.
 static bool DeletionsDiffer(const history::URLRows& deleted_rows,
                             const std::set<GURL>& urls_to_be_deleted) {
   if (deleted_rows.size() != urls_to_be_deleted.size())
     return true;
   for (history::URLRows::const_iterator i = deleted_rows.begin();
        i != deleted_rows.end(); ++i) {
@@ skipping 37 matching lines @@
   return GURL(std::string(chrome::kChromeUIHistoryURL) + "#q=" +
               net::EscapeQueryParamValue(UTF16ToUTF8(text), true));
 }
 
 // static
 base::RefCountedMemory* HistoryUI::GetFaviconResourceBytes(
       ui::ScaleFactor scale_factor) {
   return ResourceBundle::GetSharedInstance().
       LoadDataResourceBytesForScale(IDR_HISTORY_FAVICON, scale_factor);
 }