contacts: Only download contacts from "My Contacts" group.

chrome/browser/chromeos/gdata/gdata_contacts_service.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/chromeos/gdata/gdata_contacts_service.h"
 
 #include <cstring>
 #include <string>
 #include <map>
 #include <utility>
 
+#include "base/json/json_value_converter.h"
 #include "base/json/json_writer.h"
 #include "base/logging.h"
 #include "base/memory/weak_ptr.h"
 #include "base/stl_util.h"
 #include "base/time.h"
 #include "base/timer.h"
 #include "base/values.h"
 #include "chrome/browser/chromeos/contacts/contact.pb.h"
 #include "chrome/browser/chromeos/gdata/gdata_operation_registry.h"
 #include "chrome/browser/chromeos/gdata/gdata_operation_runner.h"
 #include "chrome/browser/chromeos/gdata/gdata_operations.h"
 #include "chrome/browser/chromeos/gdata/gdata_params.h"
 #include "chrome/browser/chromeos/gdata/gdata_util.h"
 #include "content/public/browser/browser_thread.h"
 
 using content::BrowserThread;
 
 namespace gdata {
 
 namespace {
 
 // Maximum number of profile photos that we'll download per second.
 // At values above 10, Google starts returning 503 errors.
 const int kMaxPhotoDownloadsPerSecond = 10;
 
+// Hardcoded system group ID for the "My Contacts" group, per
+// https://developers.google.com/google-apps/contacts/v3/#contact_group_entry.
+const char kMyContactsSystemGroupId[] = "Contacts";
+
+// Top-level field in a contact groups feed containing the list of entries.
+const char kGroupEntryField[] = "feed.entry";
+
+// Field in group entries containing the system group ID (e.g. ID "Contacts"
+// for the "My Contacts" system group).  See
+// https://developers.google.com/google-apps/contacts/v3/#contact_group_entry
+// for more details.
+const char kSystemGroupIdField[] = "gContact$systemGroup.id";
+
 // Field in the top-level object containing the contacts feed.
 const char kFeedField[] = "feed";
 
 // Field in the contacts feed containing a list of category information, along
 // with fields within the dictionaries contained in the list and expected
 // values.
 const char kCategoryField[] = "category";
 const char kCategorySchemeField[] = "scheme";
 const char kCategorySchemeValue[] = "http://schemas.google.com/g/2005#kind";
 const char kCategoryTermField[] = "term";
 const char kCategoryTermValue[] =
     "http://schemas.google.com/contact/2008#contact";
 
 // Field in the contacts feed containing a list of contact entries.
 const char kEntryField[] = "entry";
 
+// Field in group and contact entries containing the item's ID.
+const char kIdField[] = "id.$t";
+
 // Top-level fields in contact entries.
-const char kIdField[] = "id.$t";
 const char kDeletedField[] = "gd$deleted";
 const char kFullNameField[] = "gd$name.gd$fullName.$t";
 const char kGivenNameField[] = "gd$name.gd$givenName.$t";
 const char kAdditionalNameField[] = "gd$name.gd$additionalName.$t";
 const char kFamilyNameField[] = "gd$name.gd$familyName.$t";
 const char kNamePrefixField[] = "gd$name.gd$namePrefix.$t";
 const char kNameSuffixField[] = "gd$name.gd$nameSuffix.$t";
 const char kEmailField[] = "gd$email";
 const char kPhoneField[] = "gd$phoneNumber";
 const char kPostalAddressField[] = "gd$structuredPostalAddress";
@@ skipping 234 matching lines @@
       }
       im->set_primary(IsAddressPrimary(*im_dict));
       InitAddressType(*im_dict, im->mutable_type());
       im->set_protocol(GetInstantMessagingProtocol(*im_dict));
     }
   }
 
   return true;
 }
 
+// Structure into which we parse the contact groups feed using
+// JSONValueConverter.
+struct ContactGroups {
+  struct ContactGroup {
+    std::string group_id;
+    std::string system_group_id;

[satorux1, 2012/08/08 13:37:16]

What are the difference between the two IDs? Examples would be helpful here.

[Daniel Erat, 2012/08/08 14:30:50]

Described just below in GetGroupIdForSystemGroup()'s comment, which I'll move up
here.

+  };
+
+  // Given a system group ID (e.g. "Contacts" for the "My Contacts" group),
+  // returns the corresponding group ID (e.g.
+  // "http://www.google.com/m8/feeds/groups/user%40gmail.com/base/6"), or an
+  // empty string if the requested system group wasn't present.
+  std::string GetGroupIdForSystemGroup(const std::string& system_group_id) {

[satorux1, 2012/08/08 13:37:16]

Is this used?

[Daniel Erat, 2012/08/08 14:30:50]

Whoops, I added this but somehow didn't call it later (this change went through
a refactoring before I uploaded it).  Fixed; thanks for catching this.

+    for (size_t i = 0; i < groups.size(); ++i) {
+      const ContactGroup& group = *groups[i];
+      if (group.system_group_id == system_group_id)
+        return group.group_id;
+    }
+    return std::string();
+  }
+
+  // Given |value| corresponding to a dictionary in a contact group feed's
+  // "entry" list, fills |result| with information about the group.
+  static bool GetContactGroup(const base::Value* value, ContactGroup* result) {
+    DCHECK(value);
+    DCHECK(result);
+    const base::DictionaryValue* dict = NULL;
+    if (!value->GetAsDictionary(&dict))
+      return false;
+
+    dict->GetString(kIdField, &result->group_id);
+    dict->GetString(kSystemGroupIdField, &result->system_group_id);
+    return true;
+  }
+
+  static void RegisterJSONConverter(
+      base::JSONValueConverter<ContactGroups>* converter) {
+    DCHECK(converter);
+    converter->RegisterRepeatedCustomValue<ContactGroup>(
+        kGroupEntryField, &ContactGroups::groups, &GetContactGroup);
+  }
+
+  ScopedVector<ContactGroup> groups;
+};
+
 }  // namespace
 
 // This class handles a single request to download all of a user's contacts.
 //
-// First, the contacts feed is downloaded via GetContactsOperation and parsed.
+// First, the feed containing the user's contact groups is downloaded via
+// GetContactGroupsOperation and examined to find the ID for the "My Contacts"
+// group (by default, the contacts API also returns suggested contacts).  The
+// group ID is cached in GDataContactsService so that this step can be skipped
+// by later DownloadContactRequests.
+//
+// Next, the contacts feed is downloaded via GetContactsOperation and parsed.
 // Individual contacts::Contact objects are created using the data from the
-// feed.  Next, GetContactPhotoOperations are created and used to start
-// downloading contacts' photos in parallel.  When all photos have been
-// downloaded, the contacts are passed to the passed-in callback.
-class GDataContactsService::DownloadContactsRequest
-    : public base::SupportsWeakPtr<DownloadContactsRequest> {
+// feed.
+//
+// Finally, GetContactPhotoOperations are created and used to start downloading
+// contacts' photos in parallel.  When all photos have been downloaded, the
+// contacts are passed to the passed-in callback.
+class GDataContactsService::DownloadContactsRequest {
  public:
   DownloadContactsRequest(GDataContactsService* service,
                           GDataOperationRunner* runner,
                           SuccessCallback success_callback,
                           FailureCallback failure_callback,
                           const base::Time& min_update_time)
       : service_(service),
         runner_(runner),
         success_callback_(success_callback),
         failure_callback_(failure_callback),
         min_update_time_(min_update_time),
         contacts_(new ScopedVector<contacts::Contact>),
+        my_contacts_group_id_(service->cached_my_contacts_group_id_),
         num_in_progress_photo_downloads_(0),
-        photo_download_failed_(false) {
+        photo_download_failed_(false),
+        ALLOW_THIS_IN_INITIALIZER_LIST(weak_ptr_factory_(this)) {
+    DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
     DCHECK(service_);
     DCHECK(runner_);
   }
 
   ~DownloadContactsRequest() {
     DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
     service_ = NULL;
     runner_ = NULL;
   }
 
-  // Issues the initial request to download the contact feed.
+  const std::string my_contacts_group_id() const {
+    return my_contacts_group_id_;
+  }
+
+  // Begins the contacts-downloading process.  If the ID for the "My Contacts"
+  // group has previously been cached, then the contacts download is started.
+  // Otherwise, the contact groups download is started.
   void Run() {
+    DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
+    if (!my_contacts_group_id_.empty()) {
+      StartContactsDownload();
+    } else {
+      GetContactGroupsOperation* operation =
+          new GetContactGroupsOperation(
+              runner_->operation_registry(),
+              base::Bind(&DownloadContactsRequest::HandleGroupsFeedData,
+                         weak_ptr_factory_.GetWeakPtr()));
+      if (!service_->groups_feed_url_for_testing_.is_empty()) {
+        operation->set_feed_url_for_testing(
+            service_->groups_feed_url_for_testing_);
+      }
+      runner_->StartOperationWithRetry(operation);
+    }
+  }
+
+ private:
+  // Invokes the failure callback and notifies GDataContactsService that the
+  // request is done.
+  void ReportFailure() {
+    DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
+    failure_callback_.Run();
+    service_->OnRequestComplete(this);
+  }
+
+  // Callback for GetContactGroupsOperation calls.  Starts downloading the
+  // actual contacts after finding the "My Contacts" group ID.
+  void HandleGroupsFeedData(GDataErrorCode error,
+                            scoped_ptr<base::Value> feed_data) {
+    DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
+    if (error != HTTP_SUCCESS) {
+      LOG(WARNING) << "Got error " << error << " while downloading groups";
+      ReportFailure();
+      return;
+    }
+
+    VLOG(2) << "Got groups feed data:\n"
+            << PrettyPrintValue(*(feed_data.get()));
+    ContactGroups groups;
+    base::JSONValueConverter<ContactGroups> converter;
+    if (!converter.Convert(*feed_data, &groups)) {
+      LOG(WARNING) << "Unable to parse groups feed";
+      ReportFailure();
+      return;
+    }
+
+    for (size_t i = 0; i < groups.groups.size(); ++i) {
+      const ContactGroups::ContactGroup& group = *groups.groups[i];
+      if (group.system_group_id == kMyContactsSystemGroupId &&
+          !group.group_id.empty()) {
+        my_contacts_group_id_ = group.group_id;
+        StartContactsDownload();
+        return;
+      }
+    }
+
+    LOG(WARNING) << "Unable to find ID for \"My Contacts\" group";
+    ReportFailure();
+  }
+
+  // Starts a download of the contacts from the "My Contacts" group.
+  void StartContactsDownload() {
+    DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
     GetContactsOperation* operation =
         new GetContactsOperation(
             runner_->operation_registry(),
+            my_contacts_group_id_,

[satorux1, 2012/08/08 13:37:16]

Since we know that this will always be "Contacts", I guess we don't have to
fetch the groups feed, which is adding complexity. I'd not to fetch the groups
feed, if unnecessary.

[Daniel Erat, 2012/08/08 14:30:50]

"Contacts" is the "My Contacts" group's system group ID, but we need its regular
group ID, which looks like a URL under "http://www.google.com/m8/feeds/groups".

I wish that there were a way to get only members of the "My Contacts" group
without looking up the group's ID first, but there doesn't appear to be from
e.g.
http://code.google.com/a/google.com/p/apps-api-issues/issues/detail?id=675#c89.

I also wish that the API used better names here. :-(

[satorux1, 2012/08/08 14:58:10]

Ah I see. That explains.

             min_update_time_,
-            base::Bind(&DownloadContactsRequest::HandleFeedData,
-                       base::Unretained(this)));
-    if (!service_->feed_url_for_testing_.is_empty())
-      operation->set_feed_url_for_testing(service_->feed_url_for_testing_);
-
+            base::Bind(&DownloadContactsRequest::HandleContactsFeedData,
+                       weak_ptr_factory_.GetWeakPtr()));
+    if (!service_->contacts_feed_url_for_testing_.is_empty()) {
+      operation->set_feed_url_for_testing(
+          service_->contacts_feed_url_for_testing_);
+    }
     runner_->StartOperationWithRetry(operation);
   }
 
- private:
   // Callback for GetContactsOperation calls.
-  void HandleFeedData(GDataErrorCode error,
-                      scoped_ptr<base::Value> feed_data) {
+  void HandleContactsFeedData(GDataErrorCode error,
+                              scoped_ptr<base::Value> feed_data) {
     DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
     if (error != HTTP_SUCCESS) {
       LOG(WARNING) << "Got error " << error << " while downloading contacts";
-      failure_callback_.Run();
-      service_->OnRequestComplete(this);
+      ReportFailure();
       return;
     }
 
-    VLOG(2) << "Got feed data:\n" << PrettyPrintValue(*(feed_data.get()));
-    if (!ProcessFeedData(*feed_data.get())) {
-      LOG(WARNING) << "Unable to process feed data";
-      failure_callback_.Run();
-      service_->OnRequestComplete(this);
+    VLOG(2) << "Got contacts feed data:\n"
+            << PrettyPrintValue(*(feed_data.get()));
+    if (!ProcessContactsFeedData(*feed_data.get())) {
+      LOG(WARNING) << "Unable to process contacts feed data";
+      ReportFailure();
       return;
     }
 
     StartPhotoDownloads();
     photo_download_timer_.Start(
         FROM_HERE, service_->photo_download_timer_interval_,
         this, &DownloadContactsRequest::StartPhotoDownloads);
     CheckCompletion();
   }
 
   // Processes the raw contacts feed from |feed_data| and fills |contacts_|.
   // Returns true on success.
-  bool ProcessFeedData(const base::Value& feed_data) {
+  bool ProcessContactsFeedData(const base::Value& feed_data) {
+    DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
     const DictionaryValue* toplevel_dict = NULL;
     if (!feed_data.GetAsDictionary(&toplevel_dict)) {
       LOG(WARNING) << "Top-level object is not a dictionary";
       return false;
     }
 
     const DictionaryValue* feed_dict = NULL;
     if (!toplevel_dict->GetDictionary(kFeedField, &feed_dict)) {
       LOG(WARNING) << "Feed dictionary missing";
       return false;
@@ skipping 68 matching lines @@
 
   // If we're done downloading photos, invokes a callback and deletes |this|.
   // Otherwise, starts one or more downloads of URLs from
   // |contacts_needing_photo_downloads_|.
   void CheckCompletion() {
     DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
     if (contacts_needing_photo_downloads_.empty() &&
         num_in_progress_photo_downloads_ == 0) {
       VLOG(1) << "Done downloading photos; invoking callback";
       photo_download_timer_.Stop();
-      if (photo_download_failed_)
-        failure_callback_.Run();
-      else
+      if (photo_download_failed_) {
+        ReportFailure();
+      } else {
         success_callback_.Run(contacts_.Pass());
-      service_->OnRequestComplete(this);
+        service_->OnRequestComplete(this);
+      }
       return;
     }
   }
 
   // Starts photo downloads for contacts in |contacts_needing_photo_downloads_|.
   // Should be invoked only once per second.
   void StartPhotoDownloads() {
+    DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
     while (!contacts_needing_photo_downloads_.empty() &&
            (num_in_progress_photo_downloads_ <
             service_->max_photo_downloads_per_second_)) {
       contacts::Contact* contact = contacts_needing_photo_downloads_.back();
       contacts_needing_photo_downloads_.pop_back();
       DCHECK(contact_photo_urls_.count(contact));
       std::string url = contact_photo_urls_[contact];
 
       VLOG(1) << "Starting download of photo " << url << " for "
               << contact->provider_id();
       runner_->StartOperationWithRetry(
           new GetContactPhotoOperation(
               runner_->operation_registry(),
               GURL(url),
               base::Bind(&DownloadContactsRequest::HandlePhotoData,
-                         AsWeakPtr(), contact)));
+                         weak_ptr_factory_.GetWeakPtr(),
+                         contact)));
       num_in_progress_photo_downloads_++;
     }
   }
 
   // Callback for GetContactPhotoOperation calls.  Updates the associated
   // Contact and checks for completion.
   void HandlePhotoData(contacts::Contact* contact,
                        GDataErrorCode error,
                        scoped_ptr<std::string> download_data) {
     DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
@@ skipping 23 matching lines @@
       // Make sure we don't start any more downloads.
       contacts_needing_photo_downloads_.clear();
       CheckCompletion();
       return;
     }
 
     contact->set_raw_untrusted_photo(*download_data);
     CheckCompletion();
   }
 
- private:
   typedef std::map<contacts::Contact*, std::string> ContactPhotoUrls;
 
   GDataContactsService* service_;  // not owned
   GDataOperationRunner* runner_;  // not owned
 
   SuccessCallback success_callback_;
   FailureCallback failure_callback_;
 
   base::Time min_update_time_;
 
   scoped_ptr<ScopedVector<contacts::Contact> > contacts_;
 
+  // ID of the "My Contacts" contacts group.
+  std::string my_contacts_group_id_;
+
   // Map from a contact to the URL at which its photo is located.
   // Contacts without photos do not appear in this map.
   ContactPhotoUrls contact_photo_urls_;
 
   // Invokes StartPhotoDownloads() once per second.
   base::RepeatingTimer<DownloadContactsRequest> photo_download_timer_;
 
   // Contacts that have photos that we still need to start downloading.
   // When we start a download, the contact is removed from this list.
   std::vector<contacts::Contact*> contacts_needing_photo_downloads_;
 
   // Number of in-progress photo downloads.
   int num_in_progress_photo_downloads_;
 
   // Did we encounter a fatal error while downloading a photo?
   bool photo_download_failed_;
 
+  // Note: This should remain the last member so it'll be destroyed and
+  // invalidate its weak pointers before any other members are destroyed.
+  base::WeakPtrFactory<DownloadContactsRequest> weak_ptr_factory_;
+
   DISALLOW_COPY_AND_ASSIGN(DownloadContactsRequest);
 };
 
 GDataContactsService::GDataContactsService(Profile* profile)
     : runner_(new GDataOperationRunner(profile)),
       max_photo_downloads_per_second_(kMaxPhotoDownloadsPerSecond),
       photo_download_timer_interval_(base::TimeDelta::FromSeconds(1)) {
   DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
 }
 
@@ skipping 25 matching lines @@
                                   min_update_time);
   VLOG(1) << "Starting contacts download with request " << request;
   requests_.insert(request);
   request->Run();
 }
 
 void GDataContactsService::OnRequestComplete(DownloadContactsRequest* request) {
   DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
   DCHECK(request);
   VLOG(1) << "Download request " << request << " complete";
+  if (!request->my_contacts_group_id().empty())
+    cached_my_contacts_group_id_ = request->my_contacts_group_id();
   requests_.erase(request);
   delete request;
 }
 
 }  // namespace contacts