Implement chrome.experimental.downloads.search()

chrome/browser/extensions/extension_downloads_api.cc

 // Copyright (c) 2011 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/extensions/extension_downloads_api.h"
 
 #include <algorithm>
 #include <cctype>
 #include <iterator>
 #include <set>
@@ skipping 22 matching lines @@
 #include "content/browser/download/download_item.h"
 #include "content/browser/download/download_types.h"
 #include "content/browser/renderer_host/render_process_host.h"
 #include "content/browser/renderer_host/render_view_host.h"
 #include "content/browser/renderer_host/resource_dispatcher_host.h"
 #include "net/http/http_util.h"
 #include "net/url_request/url_request.h"
 
 namespace constants = extension_downloads_api_constants;
 
+namespace {
+base::DictionaryValue* DownloadItemToJSON(DownloadItem* item) {
+  base::DictionaryValue* json = new base::DictionaryValue();
+  json->SetInteger(constants::kIdKey, item->id());
+  json->SetString(constants::kUrlKey, item->original_url().spec());
+  json->SetString(constants::kFilenameKey,
+                  item->full_path().LossyDisplayName());
+  json->SetString(constants::kDangerKey,
+                  constants::DangerString(item->GetDangerType()));
+  json->SetBoolean(constants::kDangerAcceptedKey,
+      item->safety_state() == DownloadItem::DANGEROUS_BUT_VALIDATED);
+  json->SetString(constants::kStateKey,
+                  constants::StateString(item->state()));
+  json->SetBoolean(constants::kPausedKey, item->is_paused());
+  json->SetString(constants::kMimeKey, item->mime_type());
+  json->SetInteger(constants::kStartTimeKey,
+      (item->start_time() - base::Time::UnixEpoch()).InMilliseconds());
+  json->SetInteger(constants::kBytesReceivedKey, item->received_bytes());
+  json->SetInteger(constants::kTotalBytesKey, item->total_bytes());
+  if (item->state() == DownloadItem::INTERRUPTED)
+    json->SetInteger(constants::kErrorKey,
+                     static_cast<int>(item->last_error()));
+  // TODO(benjhayden): Implement endTime and fileSize.
+  // json->SetInteger(constants::kEndTimeKey, -1);
+  json->SetInteger(constants::kFileSizeKey, item->total_bytes());
+  return json;
+}
+}  // anonymous namespace
+
 bool DownloadsFunctionInterface::RunImplImpl(
     DownloadsFunctionInterface* pimpl) {
   CHECK(pimpl);
   if (!pimpl->ParseArgs()) return false;
   UMA_HISTOGRAM_ENUMERATION(
       "Download.ApiFunctions", pimpl->function(), DOWNLOADS_FUNCTION_LAST);
   pimpl->RunInternal();
   return true;
 }
 
@@ skipping 161 matching lines @@
   VLOG(1) << __FUNCTION__;
   if (dl_id >= 0) {
     result_.reset(base::Value::CreateIntegerValue(dl_id));
   } else {
     error_ = net::ErrorToString(error);
   }
   SendResponse(error_.empty());
 }
 
 DownloadsSearchFunction::DownloadsSearchFunction()
-  : SyncDownloadsFunction(DOWNLOADS_FUNCTION_SEARCH) {
+  : SyncDownloadsFunction(DOWNLOADS_FUNCTION_SEARCH),
+    get_id_(-1) {
 }
 
 DownloadsSearchFunction::~DownloadsSearchFunction() {}
 
 bool DownloadsSearchFunction::ParseArgs() {
   base::DictionaryValue* query_json = NULL;
   EXTENSION_FUNCTION_VALIDATE(args_->GetDictionary(0, &query_json));
-  error_ = constants::kNotImplemented;
-  return false;
+  if (query_json->HasKey(constants::kIdKey)) {
+    EXTENSION_FUNCTION_VALIDATE(query_json->GetInteger(
+          constants::kIdKey, &get_id_));

[Randy Smith (Not in Mondays), 2011/10/10 18:09:42]

What is the behavior if we have both an id and other things in the query from
the extension?

[benjhayden, 2011/10/13 14:07:34]

search() will only return items that match the query. If the item whose id is
specified in the query fails another filter in the query, then no items will be
returned. If item 42 is complete, then search({id:42, state:"in_progress"})
returns [].

+  } else {
+#define CppInteger int
+#define CppString std::string
+#define CppBoolean bool
+#define FIELD(field_name, field_type) \
+    if (query_json->HasKey(#field_name)) { \
+      Cpp ## field_type value; \
+      EXTENSION_FUNCTION_VALIDATE(query_json->Get ## field_type( \
+          #field_name, &value)); \
+      query_.field_name(value); \
+    }
+#include "content/browser/download/download_query_fields.h"

[Aaron Boodman, 2011/10/12 08:26:08]

whoa.

[cbentzel, 2011/10/12 09:26:37]

Ben is reimplementing the code in a way that won't require this. 

[benjhayden, 2011/10/13 14:07:34]

Done.

[benjhayden, 2011/10/13 14:07:34]

Done.

+#undef FIELD
+#undef CppInteger
+#undef CppString
+#undef CppBoolean
+  }
+  return true;
 }
 
 void DownloadsSearchFunction::RunInternal() {
-  NOTIMPLEMENTED();
+  base::ListValue* results = new base::ListValue();
+  result_.reset(results);
+  if (get_id_ < 0) {
+    profile()->GetDownloadManager()->Search(
+        query_, &error_, NULL/*c++ results*/, results);

[Aaron Boodman, 2011/10/12 08:26:08]

We avoid /* ... */ style comments in Chrome. If you want a param comment like
this we typically do:

Search(foo,
       bar, // blah blah
       baz);

[benjhayden, 2011/10/13 14:07:34]

Done.

+  } else {
+    DownloadItem* item = profile()->GetDownloadManager()->GetDownloadItem(
+        get_id_);
+    if (item != NULL)
+      results->Append(DownloadItemToJSON(item));
+  }
 }
 
 DownloadsPauseFunction::DownloadsPauseFunction()
   : SyncDownloadsFunction(DOWNLOADS_FUNCTION_PAUSE) {
 }
 
 DownloadsPauseFunction::~DownloadsPauseFunction() {}
 
 bool DownloadsPauseFunction::ParseArgs() {
   int dl_id = 0;
@@ skipping 127 matching lines @@
   EXTENSION_FUNCTION_VALIDATE(args_->GetInteger(0, &dl_id));
   VLOG(1) << __FUNCTION__ << " " << dl_id;
   error_ = constants::kNotImplemented;
   return false;
 }
 
 void DownloadsDragFunction::RunInternal() {
   NOTIMPLEMENTED();
 }
 
-namespace {
-base::DictionaryValue* DownloadItemToJSON(DownloadItem* item) {
-  base::DictionaryValue* json = new base::DictionaryValue();
-  json->SetInteger(constants::kIdKey, item->id());
-  json->SetString(constants::kUrlKey, item->original_url().spec());
-  json->SetString(constants::kFilenameKey,
-                  item->full_path().LossyDisplayName());
-  json->SetString(constants::kDangerKey,
-                  constants::DangerString(item->GetDangerType()));
-  json->SetBoolean(constants::kDangerAcceptedKey,
-      item->safety_state() == DownloadItem::DANGEROUS_BUT_VALIDATED);
-  json->SetString(constants::kStateKey,
-                  constants::StateString(item->state()));
-  json->SetBoolean(constants::kPausedKey, item->is_paused());
-  json->SetString(constants::kMimeKey, item->mime_type());
-  json->SetInteger(constants::kStartTimeKey,
-      (item->start_time() - base::Time::UnixEpoch()).InMilliseconds());
-  json->SetInteger(constants::kBytesReceivedKey, item->received_bytes());
-  json->SetInteger(constants::kTotalBytesKey, item->total_bytes());
-  if (item->state() == DownloadItem::INTERRUPTED)
-    json->SetInteger(constants::kErrorKey,
-                     static_cast<int>(item->last_error()));
-  // TODO(benjhayden): Implement endTime and fileSize.
-  // json->SetInteger(constants::kEndTimeKey, -1);
-  json->SetInteger(constants::kFileSizeKey, item->total_bytes());
-  return json;
-}
-}  // anonymous namespace
-
 ExtensionDownloadsEventRouter::ExtensionDownloadsEventRouter(
     Profile* profile)
   : profile_(profile),
     manager_(profile ? profile->GetDownloadManager() : NULL) {
   DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
   DCHECK(profile_);
   DCHECK(manager_);
   manager_->AddObserver(this);
 }
 
@@ skipping 56 matching lines @@
   ListValue args;
   args.Append(arg);
   std::string json_args;
   base::JSONWriter::Write(&args, false, &json_args);
   profile_->GetExtensionEventRouter()->DispatchEventToRenderers(
       event_name,
       json_args,
       profile_,
       GURL());
 }