| Index: chrome/browser/chromeos/contacts/gdata_contacts_service.cc
|
| diff --git a/chrome/browser/chromeos/contacts/gdata_contacts_service.cc b/chrome/browser/chromeos/contacts/gdata_contacts_service.cc
|
| deleted file mode 100644
|
| index 16ce208f557d065cd0a900aca988334c695d56db..0000000000000000000000000000000000000000
|
| --- a/chrome/browser/chromeos/contacts/gdata_contacts_service.cc
|
| +++ /dev/null
|
| @@ -1,894 +0,0 @@
|
| -// 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/contacts/gdata_contacts_service.h"
|
| -
|
| -#include <cstring>
|
| -#include <map>
|
| -#include <string>
|
| -#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/metrics/histogram.h"
|
| -#include "base/stl_util.h"
|
| -#include "base/strings/string_util.h"
|
| -#include "base/threading/sequenced_worker_pool.h"
|
| -#include "base/time/time.h"
|
| -#include "base/timer/timer.h"
|
| -#include "base/values.h"
|
| -#include "chrome/browser/chromeos/contacts/contact.pb.h"
|
| -#include "content/public/browser/browser_thread.h"
|
| -#include "google_apis/drive/gdata_contacts_requests.h"
|
| -#include "google_apis/drive/gdata_errorcode.h"
|
| -#include "google_apis/drive/request_sender.h"
|
| -#include "google_apis/drive/time_util.h"
|
| -
|
| -using content::BrowserThread;
|
| -
|
| -namespace contacts {
|
| -
|
| -namespace {
|
| -
|
| -// Download outcomes reported via the "Contacts.FullUpdateResult" and
|
| -// "Contacts.IncrementalUpdateResult" histograms.
|
| -enum HistogramResult {
|
| - HISTOGRAM_RESULT_SUCCESS = 0,
|
| - HISTOGRAM_RESULT_GROUPS_DOWNLOAD_FAILURE = 1,
|
| - HISTOGRAM_RESULT_GROUPS_PARSE_FAILURE = 2,
|
| - HISTOGRAM_RESULT_MY_CONTACTS_GROUP_NOT_FOUND = 3,
|
| - HISTOGRAM_RESULT_CONTACTS_DOWNLOAD_FAILURE = 4,
|
| - HISTOGRAM_RESULT_CONTACTS_PARSE_FAILURE = 5,
|
| - HISTOGRAM_RESULT_PHOTO_DOWNLOAD_FAILURE = 6,
|
| - HISTOGRAM_RESULT_MAX_VALUE = 7,
|
| -};
|
| -
|
| -// Maximum number of profile photos that we'll download per second.
|
| -// At values above 10, Google starts returning 503 errors.
|
| -const int kMaxPhotoDownloadsPerSecond = 10;
|
| -
|
| -// Give up after seeing more than this many transient errors while trying to
|
| -// download a photo for a single contact.
|
| -const int kMaxTransientPhotoDownloadErrorsPerContact = 2;
|
| -
|
| -// 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 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";
|
| -const char kInstantMessagingField[] = "gd$im";
|
| -const char kLinkField[] = "link";
|
| -const char kUpdatedField[] = "updated.$t";
|
| -
|
| -// Fields in entries in the |kEmailField| list.
|
| -const char kEmailAddressField[] = "address";
|
| -
|
| -// Fields in entries in the |kPhoneField| list.
|
| -const char kPhoneNumberField[] = "$t";
|
| -
|
| -// Fields in entries in the |kPostalAddressField| list.
|
| -const char kPostalAddressFormattedField[] = "gd$formattedAddress.$t";
|
| -
|
| -// Fields in entries in the |kInstantMessagingField| list.
|
| -const char kInstantMessagingAddressField[] = "address";
|
| -const char kInstantMessagingProtocolField[] = "protocol";
|
| -const char kInstantMessagingProtocolAimValue[] =
|
| - "http://schemas.google.com/g/2005#AIM";
|
| -const char kInstantMessagingProtocolMsnValue[] =
|
| - "http://schemas.google.com/g/2005#MSN";
|
| -const char kInstantMessagingProtocolYahooValue[] =
|
| - "http://schemas.google.com/g/2005#YAHOO";
|
| -const char kInstantMessagingProtocolSkypeValue[] =
|
| - "http://schemas.google.com/g/2005#SKYPE";
|
| -const char kInstantMessagingProtocolQqValue[] =
|
| - "http://schemas.google.com/g/2005#QQ";
|
| -const char kInstantMessagingProtocolGoogleTalkValue[] =
|
| - "http://schemas.google.com/g/2005#GOOGLE_TALK";
|
| -const char kInstantMessagingProtocolIcqValue[] =
|
| - "http://schemas.google.com/g/2005#ICQ";
|
| -const char kInstantMessagingProtocolJabberValue[] =
|
| - "http://schemas.google.com/g/2005#JABBER";
|
| -
|
| -// Generic fields shared between address-like items (email, postal, etc.).
|
| -const char kAddressPrimaryField[] = "primary";
|
| -const char kAddressPrimaryTrueValue[] = "true";
|
| -const char kAddressRelField[] = "rel";
|
| -const char kAddressRelHomeValue[] = "http://schemas.google.com/g/2005#home";
|
| -const char kAddressRelWorkValue[] = "http://schemas.google.com/g/2005#work";
|
| -const char kAddressRelMobileValue[] = "http://schemas.google.com/g/2005#mobile";
|
| -const char kAddressLabelField[] = "label";
|
| -
|
| -// Fields in entries in the |kLinkField| list.
|
| -const char kLinkHrefField[] = "href";
|
| -const char kLinkRelField[] = "rel";
|
| -const char kLinkETagField[] = "gd$etag";
|
| -const char kLinkRelPhotoValue[] =
|
| - "http://schemas.google.com/contacts/2008/rel#photo";
|
| -
|
| -// Returns a string containing a pretty-printed JSON representation of |value|.
|
| -std::string PrettyPrintValue(const base::Value& value) {
|
| - std::string out;
|
| - base::JSONWriter::WriteWithOptions(
|
| - &value, base::JSONWriter::OPTIONS_PRETTY_PRINT, &out);
|
| - return out;
|
| -}
|
| -
|
| -// Assigns the value at |path| within |dict| to |out|, returning false if the
|
| -// path wasn't present. Unicode byte order marks are removed from the string.
|
| -bool GetCleanedString(const base::DictionaryValue& dict,
|
| - const std::string& path,
|
| - std::string* out) {
|
| - if (!dict.GetString(path, out))
|
| - return false;
|
| -
|
| - // The Unicode byte order mark, U+FEFF, is useless in UTF-8 strings (which are
|
| - // interpreted one byte at a time).
|
| - ReplaceSubstringsAfterOffset(out, 0, "\xEF\xBB\xBF", "");
|
| - return true;
|
| -}
|
| -
|
| -// Returns whether an address is primary, given a dictionary representing a
|
| -// single address.
|
| -bool IsAddressPrimary(const base::DictionaryValue& address_dict) {
|
| - std::string primary;
|
| - address_dict.GetString(kAddressPrimaryField, &primary);
|
| - return primary == kAddressPrimaryTrueValue;
|
| -}
|
| -
|
| -// Initializes an AddressType message given a dictionary representing a single
|
| -// address.
|
| -void InitAddressType(const base::DictionaryValue& address_dict,
|
| - Contact_AddressType* type) {
|
| - DCHECK(type);
|
| - type->Clear();
|
| -
|
| - std::string rel;
|
| - address_dict.GetString(kAddressRelField, &rel);
|
| - if (rel == kAddressRelHomeValue)
|
| - type->set_relation(Contact_AddressType_Relation_HOME);
|
| - else if (rel == kAddressRelWorkValue)
|
| - type->set_relation(Contact_AddressType_Relation_WORK);
|
| - else if (rel == kAddressRelMobileValue)
|
| - type->set_relation(Contact_AddressType_Relation_MOBILE);
|
| - else
|
| - type->set_relation(Contact_AddressType_Relation_OTHER);
|
| -
|
| - GetCleanedString(address_dict, kAddressLabelField, type->mutable_label());
|
| -}
|
| -
|
| -// Maps the protocol from a dictionary representing a contact's IM address to a
|
| -// contacts::Contact_InstantMessagingAddress_Protocol value.
|
| -contacts::Contact_InstantMessagingAddress_Protocol
|
| -GetInstantMessagingProtocol(const base::DictionaryValue& im_dict) {
|
| - std::string protocol;
|
| - im_dict.GetString(kInstantMessagingProtocolField, &protocol);
|
| - if (protocol == kInstantMessagingProtocolAimValue)
|
| - return contacts::Contact_InstantMessagingAddress_Protocol_AIM;
|
| - else if (protocol == kInstantMessagingProtocolMsnValue)
|
| - return contacts::Contact_InstantMessagingAddress_Protocol_MSN;
|
| - else if (protocol == kInstantMessagingProtocolYahooValue)
|
| - return contacts::Contact_InstantMessagingAddress_Protocol_YAHOO;
|
| - else if (protocol == kInstantMessagingProtocolSkypeValue)
|
| - return contacts::Contact_InstantMessagingAddress_Protocol_SKYPE;
|
| - else if (protocol == kInstantMessagingProtocolQqValue)
|
| - return contacts::Contact_InstantMessagingAddress_Protocol_QQ;
|
| - else if (protocol == kInstantMessagingProtocolGoogleTalkValue)
|
| - return contacts::Contact_InstantMessagingAddress_Protocol_GOOGLE_TALK;
|
| - else if (protocol == kInstantMessagingProtocolIcqValue)
|
| - return contacts::Contact_InstantMessagingAddress_Protocol_ICQ;
|
| - else if (protocol == kInstantMessagingProtocolJabberValue)
|
| - return contacts::Contact_InstantMessagingAddress_Protocol_JABBER;
|
| - else
|
| - return contacts::Contact_InstantMessagingAddress_Protocol_OTHER;
|
| -}
|
| -
|
| -// Gets the photo URL from a contact's dictionary (within the "entry" list).
|
| -// Returns an empty string if no photo was found.
|
| -std::string GetPhotoUrl(const base::DictionaryValue& dict) {
|
| - const base::ListValue* link_list = NULL;
|
| - if (!dict.GetList(kLinkField, &link_list))
|
| - return std::string();
|
| -
|
| - for (size_t i = 0; i < link_list->GetSize(); ++i) {
|
| - const base::DictionaryValue* link_dict = NULL;
|
| - if (!link_list->GetDictionary(i, &link_dict))
|
| - continue;
|
| -
|
| - std::string rel;
|
| - if (!link_dict->GetString(kLinkRelField, &rel))
|
| - continue;
|
| - if (rel != kLinkRelPhotoValue)
|
| - continue;
|
| -
|
| - // From https://goo.gl/7T6Od: "If a contact does not have a photo, then the
|
| - // photo link element has no gd:etag attribute."
|
| - std::string etag;
|
| - if (!link_dict->GetString(kLinkETagField, &etag))
|
| - continue;
|
| -
|
| - std::string url;
|
| - if (link_dict->GetString(kLinkHrefField, &url))
|
| - return url;
|
| - }
|
| - return std::string();
|
| -}
|
| -
|
| -// Fills a Contact's fields using an entry from a GData feed.
|
| -bool FillContactFromDictionary(const base::DictionaryValue& dict,
|
| - contacts::Contact* contact) {
|
| - DCHECK(contact);
|
| - contact->Clear();
|
| -
|
| - if (!dict.GetString(kIdField, contact->mutable_contact_id()))
|
| - return false;
|
| -
|
| - std::string updated;
|
| - if (dict.GetString(kUpdatedField, &updated)) {
|
| - base::Time update_time;
|
| - if (!google_apis::util::GetTimeFromString(updated, &update_time)) {
|
| - LOG(WARNING) << "Unable to parse time \"" << updated << "\"";
|
| - return false;
|
| - }
|
| - contact->set_update_time(update_time.ToInternalValue());
|
| - }
|
| -
|
| - const base::Value* deleted_value = NULL;
|
| - contact->set_deleted(dict.Get(kDeletedField, &deleted_value));
|
| - if (contact->deleted())
|
| - return true;
|
| -
|
| - GetCleanedString(dict, kFullNameField, contact->mutable_full_name());
|
| - GetCleanedString(dict, kGivenNameField, contact->mutable_given_name());
|
| - GetCleanedString(
|
| - dict, kAdditionalNameField, contact->mutable_additional_name());
|
| - GetCleanedString(dict, kFamilyNameField, contact->mutable_family_name());
|
| - GetCleanedString(dict, kNamePrefixField, contact->mutable_name_prefix());
|
| - GetCleanedString(dict, kNameSuffixField, contact->mutable_name_suffix());
|
| -
|
| - const base::ListValue* email_list = NULL;
|
| - if (dict.GetList(kEmailField, &email_list)) {
|
| - for (size_t i = 0; i < email_list->GetSize(); ++i) {
|
| - const base::DictionaryValue* email_dict = NULL;
|
| - if (!email_list->GetDictionary(i, &email_dict))
|
| - return false;
|
| -
|
| - contacts::Contact_EmailAddress* email = contact->add_email_addresses();
|
| - if (!GetCleanedString(*email_dict,
|
| - kEmailAddressField,
|
| - email->mutable_address())) {
|
| - return false;
|
| - }
|
| - email->set_primary(IsAddressPrimary(*email_dict));
|
| - InitAddressType(*email_dict, email->mutable_type());
|
| - }
|
| - }
|
| -
|
| - const base::ListValue* phone_list = NULL;
|
| - if (dict.GetList(kPhoneField, &phone_list)) {
|
| - for (size_t i = 0; i < phone_list->GetSize(); ++i) {
|
| - const base::DictionaryValue* phone_dict = NULL;
|
| - if (!phone_list->GetDictionary(i, &phone_dict))
|
| - return false;
|
| -
|
| - contacts::Contact_PhoneNumber* phone = contact->add_phone_numbers();
|
| - if (!GetCleanedString(*phone_dict,
|
| - kPhoneNumberField,
|
| - phone->mutable_number())) {
|
| - return false;
|
| - }
|
| - phone->set_primary(IsAddressPrimary(*phone_dict));
|
| - InitAddressType(*phone_dict, phone->mutable_type());
|
| - }
|
| - }
|
| -
|
| - const base::ListValue* address_list = NULL;
|
| - if (dict.GetList(kPostalAddressField, &address_list)) {
|
| - for (size_t i = 0; i < address_list->GetSize(); ++i) {
|
| - const base::DictionaryValue* address_dict = NULL;
|
| - if (!address_list->GetDictionary(i, &address_dict))
|
| - return false;
|
| -
|
| - contacts::Contact_PostalAddress* address =
|
| - contact->add_postal_addresses();
|
| - if (!GetCleanedString(*address_dict,
|
| - kPostalAddressFormattedField,
|
| - address->mutable_address())) {
|
| - return false;
|
| - }
|
| - address->set_primary(IsAddressPrimary(*address_dict));
|
| - InitAddressType(*address_dict, address->mutable_type());
|
| - }
|
| - }
|
| -
|
| - const base::ListValue* im_list = NULL;
|
| - if (dict.GetList(kInstantMessagingField, &im_list)) {
|
| - for (size_t i = 0; i < im_list->GetSize(); ++i) {
|
| - const base::DictionaryValue* im_dict = NULL;
|
| - if (!im_list->GetDictionary(i, &im_dict))
|
| - return false;
|
| -
|
| - contacts::Contact_InstantMessagingAddress* im =
|
| - contact->add_instant_messaging_addresses();
|
| - if (!GetCleanedString(*im_dict,
|
| - kInstantMessagingAddressField,
|
| - im->mutable_address())) {
|
| - return false;
|
| - }
|
| - 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 {
|
| - // Group ID, e.g.
|
| - // "http://www.google.com/m8/feeds/groups/user%40gmail.com/base/6".
|
| - std::string group_id;
|
| -
|
| - // System group ID (e.g. "Contacts" for the "My Contacts" system group) if
|
| - // this is a system group, and empty otherwise. See http://goo.gl/oWVnN
|
| - // for more details.
|
| - std::string system_group_id;
|
| - };
|
| -
|
| - // Given a system group ID, returns the corresponding group ID or an empty
|
| - // string if the requested system group wasn't present.
|
| - std::string GetGroupIdForSystemGroup(const std::string& system_group_id) {
|
| - 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 feed containing the user's contact groups is downloaded via
|
| -// GetContactGroupsRequest 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 GetContactsRequest and parsed.
|
| -// Individual contacts::Contact objects are created using the data from the
|
| -// feed.
|
| -//
|
| -// Finally, GetContactPhotoRequests 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,
|
| - google_apis::RequestSender* sender,
|
| - SuccessCallback success_callback,
|
| - FailureCallback failure_callback,
|
| - const base::Time& min_update_time)
|
| - : service_(service),
|
| - sender_(sender),
|
| - 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),
|
| - num_photo_download_404_errors_(0),
|
| - total_photo_bytes_(0),
|
| - weak_ptr_factory_(this) {
|
| - DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
|
| - DCHECK(service_);
|
| - DCHECK(sender_);
|
| - }
|
| -
|
| - ~DownloadContactsRequest() {
|
| - DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
|
| - service_ = NULL;
|
| - sender_ = NULL;
|
| - }
|
| -
|
| - 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));
|
| - download_start_time_ = base::TimeTicks::Now();
|
| - if (!my_contacts_group_id_.empty()) {
|
| - StartContactsDownload();
|
| - } else {
|
| - google_apis::GetContactGroupsRequest* operation =
|
| - new google_apis::GetContactGroupsRequest(
|
| - sender_,
|
| - 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_);
|
| - }
|
| - sender_->StartRequestWithRetry(operation);
|
| - }
|
| - }
|
| -
|
| - private:
|
| - // Invokes the failure callback and notifies GDataContactsService that the
|
| - // request is done.
|
| - void ReportFailure(HistogramResult histogram_result) {
|
| - DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
|
| - SendHistograms(histogram_result);
|
| - failure_callback_.Run();
|
| - service_->OnRequestComplete(this);
|
| - }
|
| -
|
| - // Reports UMA stats after the request has completed.
|
| - void SendHistograms(HistogramResult result) {
|
| - DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
|
| - DCHECK_GE(result, 0);
|
| - DCHECK_LT(result, HISTOGRAM_RESULT_MAX_VALUE);
|
| -
|
| - bool success = (result == HISTOGRAM_RESULT_SUCCESS);
|
| - base::TimeDelta elapsed_time =
|
| - base::TimeTicks::Now() - download_start_time_;
|
| - int photo_error_percent = static_cast<int>(
|
| - 100.0 * transient_photo_download_errors_per_contact_.size() /
|
| - contact_photo_urls_.size() + 0.5);
|
| -
|
| - if (min_update_time_.is_null()) {
|
| - UMA_HISTOGRAM_ENUMERATION("Contacts.FullUpdateResult",
|
| - result, HISTOGRAM_RESULT_MAX_VALUE);
|
| - if (success) {
|
| - UMA_HISTOGRAM_MEDIUM_TIMES("Contacts.FullUpdateDuration",
|
| - elapsed_time);
|
| - UMA_HISTOGRAM_COUNTS_10000("Contacts.FullUpdateContacts",
|
| - contacts_->size());
|
| - UMA_HISTOGRAM_COUNTS_10000("Contacts.FullUpdatePhotos",
|
| - contact_photo_urls_.size());
|
| - UMA_HISTOGRAM_MEMORY_KB("Contacts.FullUpdatePhotoBytes",
|
| - total_photo_bytes_);
|
| - UMA_HISTOGRAM_COUNTS_10000("Contacts.FullUpdatePhoto404Errors",
|
| - num_photo_download_404_errors_);
|
| - UMA_HISTOGRAM_PERCENTAGE("Contacts.FullUpdatePhotoErrorPercent",
|
| - photo_error_percent);
|
| - }
|
| - } else {
|
| - UMA_HISTOGRAM_ENUMERATION("Contacts.IncrementalUpdateResult",
|
| - result, HISTOGRAM_RESULT_MAX_VALUE);
|
| - if (success) {
|
| - UMA_HISTOGRAM_MEDIUM_TIMES("Contacts.IncrementalUpdateDuration",
|
| - elapsed_time);
|
| - UMA_HISTOGRAM_COUNTS_10000("Contacts.IncrementalUpdateContacts",
|
| - contacts_->size());
|
| - UMA_HISTOGRAM_COUNTS_10000("Contacts.IncrementalUpdatePhotos",
|
| - contact_photo_urls_.size());
|
| - UMA_HISTOGRAM_MEMORY_KB("Contacts.IncrementalUpdatePhotoBytes",
|
| - total_photo_bytes_);
|
| - UMA_HISTOGRAM_COUNTS_10000("Contacts.IncrementalUpdatePhoto404Errors",
|
| - num_photo_download_404_errors_);
|
| - UMA_HISTOGRAM_PERCENTAGE("Contacts.IncrementalUpdatePhotoErrorPercent",
|
| - photo_error_percent);
|
| - }
|
| - }
|
| - }
|
| -
|
| - // Callback for GetContactGroupsRequest calls. Starts downloading the
|
| - // actual contacts after finding the "My Contacts" group ID.
|
| - void HandleGroupsFeedData(google_apis::GDataErrorCode error,
|
| - scoped_ptr<base::Value> feed_data) {
|
| - DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
|
| - if (error != google_apis::HTTP_SUCCESS) {
|
| - LOG(WARNING) << "Got error " << error << " while downloading groups";
|
| - ReportFailure(HISTOGRAM_RESULT_GROUPS_DOWNLOAD_FAILURE);
|
| - 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(HISTOGRAM_RESULT_GROUPS_PARSE_FAILURE);
|
| - return;
|
| - }
|
| -
|
| - my_contacts_group_id_ =
|
| - groups.GetGroupIdForSystemGroup(kMyContactsSystemGroupId);
|
| - if (!my_contacts_group_id_.empty()) {
|
| - StartContactsDownload();
|
| - } else {
|
| - LOG(WARNING) << "Unable to find ID for \"My Contacts\" group";
|
| - ReportFailure(HISTOGRAM_RESULT_MY_CONTACTS_GROUP_NOT_FOUND);
|
| - }
|
| - }
|
| -
|
| - // Starts a download of the contacts from the "My Contacts" group.
|
| - void StartContactsDownload() {
|
| - DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
|
| - google_apis::GetContactsRequest* operation =
|
| - new google_apis::GetContactsRequest(
|
| - sender_,
|
| - my_contacts_group_id_,
|
| - min_update_time_,
|
| - 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_);
|
| - }
|
| - sender_->StartRequestWithRetry(operation);
|
| - }
|
| -
|
| - // Callback for GetContactsRequest calls.
|
| - void HandleContactsFeedData(google_apis::GDataErrorCode error,
|
| - scoped_ptr<base::Value> feed_data) {
|
| - DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
|
| - if (error != google_apis::HTTP_SUCCESS) {
|
| - LOG(WARNING) << "Got error " << error << " while downloading contacts";
|
| - ReportFailure(HISTOGRAM_RESULT_CONTACTS_DOWNLOAD_FAILURE);
|
| - return;
|
| - }
|
| -
|
| - 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(HISTOGRAM_RESULT_CONTACTS_PARSE_FAILURE);
|
| - 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 ProcessContactsFeedData(const base::Value& feed_data) {
|
| - DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
|
| - const base::DictionaryValue* toplevel_dict = NULL;
|
| - if (!feed_data.GetAsDictionary(&toplevel_dict)) {
|
| - LOG(WARNING) << "Top-level object is not a dictionary";
|
| - return false;
|
| - }
|
| -
|
| - const base::DictionaryValue* feed_dict = NULL;
|
| - if (!toplevel_dict->GetDictionary(kFeedField, &feed_dict)) {
|
| - LOG(WARNING) << "Feed dictionary missing";
|
| - return false;
|
| - }
|
| -
|
| - // Check the category field to confirm that this is actually a contact feed.
|
| - const base::ListValue* category_list = NULL;
|
| - if (!feed_dict->GetList(kCategoryField, &category_list)) {
|
| - LOG(WARNING) << "Category list missing";
|
| - return false;
|
| - }
|
| - const base::DictionaryValue* category_dict = NULL;
|
| - if (category_list->GetSize() != 1 ||
|
| - !category_list->GetDictionary(0, &category_dict)) {
|
| - LOG(WARNING) << "Unable to get dictionary from category list of size "
|
| - << category_list->GetSize();
|
| - return false;
|
| - }
|
| - std::string category_scheme, category_term;
|
| - if (!category_dict->GetString(kCategorySchemeField, &category_scheme) ||
|
| - !category_dict->GetString(kCategoryTermField, &category_term) ||
|
| - category_scheme != kCategorySchemeValue ||
|
| - category_term != kCategoryTermValue) {
|
| - LOG(WARNING) << "Unexpected category (scheme was \"" << category_scheme
|
| - << "\", term was \"" << category_term << "\")";
|
| - return false;
|
| - }
|
| -
|
| - // A missing entry list means no entries (maybe we're doing an incremental
|
| - // update and nothing has changed).
|
| - const base::ListValue* entry_list = NULL;
|
| - if (!feed_dict->GetList(kEntryField, &entry_list))
|
| - return true;
|
| -
|
| - contacts_needing_photo_downloads_.reserve(entry_list->GetSize());
|
| -
|
| - for (base::ListValue::const_iterator entry_it = entry_list->begin();
|
| - entry_it != entry_list->end(); ++entry_it) {
|
| - const size_t index = (entry_it - entry_list->begin());
|
| - const base::DictionaryValue* contact_dict = NULL;
|
| - if (!(*entry_it)->GetAsDictionary(&contact_dict)) {
|
| - LOG(WARNING) << "Entry " << index << " isn't a dictionary";
|
| - return false;
|
| - }
|
| -
|
| - scoped_ptr<contacts::Contact> contact(new contacts::Contact);
|
| - if (!FillContactFromDictionary(*contact_dict, contact.get())) {
|
| - LOG(WARNING) << "Unable to fill entry " << index;
|
| - return false;
|
| - }
|
| -
|
| - VLOG(1) << "Got contact " << index << ":"
|
| - << " id=" << contact->contact_id()
|
| - << " full_name=\"" << contact->full_name() << "\""
|
| - << " update_time=" << contact->update_time();
|
| -
|
| - std::string photo_url = GetPhotoUrl(*contact_dict);
|
| - if (!photo_url.empty()) {
|
| - if (!service_->rewrite_photo_url_callback_for_testing_.is_null()) {
|
| - photo_url =
|
| - service_->rewrite_photo_url_callback_for_testing_.Run(photo_url);
|
| - }
|
| - contact_photo_urls_[contact.get()] = photo_url;
|
| - contacts_needing_photo_downloads_.push_back(contact.get());
|
| - }
|
| -
|
| - contacts_->push_back(contact.release());
|
| - }
|
| -
|
| - return true;
|
| - }
|
| -
|
| - // 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_) {
|
| - ReportFailure(HISTOGRAM_RESULT_PHOTO_DOWNLOAD_FAILURE );
|
| - } else {
|
| - SendHistograms(HISTOGRAM_RESULT_SUCCESS);
|
| - success_callback_.Run(contacts_.Pass());
|
| - 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->contact_id();
|
| - sender_->StartRequestWithRetry(
|
| - new google_apis::GetContactPhotoRequest(
|
| - sender_,
|
| - GURL(url),
|
| - base::Bind(&DownloadContactsRequest::HandlePhotoData,
|
| - weak_ptr_factory_.GetWeakPtr(),
|
| - contact)));
|
| - num_in_progress_photo_downloads_++;
|
| - }
|
| - }
|
| -
|
| - // Callback for GetContactPhotoRequest calls. Updates the associated
|
| - // Contact and checks for completion.
|
| - void HandlePhotoData(contacts::Contact* contact,
|
| - google_apis::GDataErrorCode error,
|
| - scoped_ptr<std::string> download_data) {
|
| - DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
|
| - VLOG(1) << "Got photo data for " << contact->contact_id()
|
| - << " (error=" << error << " size=" << download_data->size() << ")";
|
| - num_in_progress_photo_downloads_--;
|
| -
|
| - if (error == google_apis::HTTP_INTERNAL_SERVER_ERROR ||
|
| - error == google_apis::HTTP_SERVICE_UNAVAILABLE) {
|
| - int num_errors = ++transient_photo_download_errors_per_contact_[contact];
|
| - if (num_errors <= kMaxTransientPhotoDownloadErrorsPerContact) {
|
| - LOG(WARNING) << "Got error " << error << " while downloading photo "
|
| - << "for " << contact->contact_id() << "; retrying";
|
| - contacts_needing_photo_downloads_.push_back(contact);
|
| - return;
|
| - }
|
| - }
|
| -
|
| - if (error == google_apis::HTTP_NOT_FOUND) {
|
| - LOG(WARNING) << "Got error " << error << " while downloading photo "
|
| - << "for " << contact->contact_id() << "; skipping";
|
| - num_photo_download_404_errors_++;
|
| - CheckCompletion();
|
| - return;
|
| - }
|
| -
|
| - if (error != google_apis::HTTP_SUCCESS) {
|
| - LOG(WARNING) << "Got error " << error << " while downloading photo "
|
| - << "for " << contact->contact_id() << "; giving up";
|
| - photo_download_failed_ = true;
|
| - // Make sure we don't start any more downloads.
|
| - contacts_needing_photo_downloads_.clear();
|
| - CheckCompletion();
|
| - return;
|
| - }
|
| -
|
| - total_photo_bytes_ += download_data->size();
|
| - contact->set_raw_untrusted_photo(*download_data);
|
| - CheckCompletion();
|
| - }
|
| -
|
| - typedef std::map<contacts::Contact*, std::string> ContactPhotoUrls;
|
| -
|
| - GDataContactsService* service_; // not owned
|
| - google_apis::RequestSender* sender_; // 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_;
|
| -
|
| - // Map from a contact to the number of transient errors that we've encountered
|
| - // while trying to download its photo. Contacts for which no errors have been
|
| - // encountered aren't represented in the map.
|
| - std::map<contacts::Contact*, int>
|
| - transient_photo_download_errors_per_contact_;
|
| -
|
| - // Did we encounter a fatal error while downloading a photo?
|
| - bool photo_download_failed_;
|
| -
|
| - // How many photos did we skip due to 404 errors?
|
| - int num_photo_download_404_errors_;
|
| -
|
| - // Total size of all photos that were downloaded.
|
| - size_t total_photo_bytes_;
|
| -
|
| - // Time at which Run() was called.
|
| - base::TimeTicks download_start_time_;
|
| -
|
| - // 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(
|
| - net::URLRequestContextGetter* url_request_context_getter,
|
| - google_apis::AuthServiceInterface* auth_service)
|
| - : max_photo_downloads_per_second_(kMaxPhotoDownloadsPerSecond),
|
| - photo_download_timer_interval_(base::TimeDelta::FromSeconds(1)) {
|
| - DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
|
| - sender_.reset(new google_apis::RequestSender(
|
| - auth_service,
|
| - url_request_context_getter,
|
| - BrowserThread::GetBlockingPool()->GetSequencedTaskRunner(
|
| - BrowserThread::GetBlockingPool()->GetSequenceToken()).get(),
|
| - "" /* custom_user_agent */));
|
| -}
|
| -
|
| -GDataContactsService::~GDataContactsService() {
|
| - DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
|
| - STLDeleteContainerPointers(requests_.begin(), requests_.end());
|
| - requests_.clear();
|
| -}
|
| -
|
| -void GDataContactsService::DownloadContacts(SuccessCallback success_callback,
|
| - FailureCallback failure_callback,
|
| - const base::Time& min_update_time) {
|
| - DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
|
| - DownloadContactsRequest* request =
|
| - new DownloadContactsRequest(this,
|
| - sender_.get(),
|
| - success_callback,
|
| - failure_callback,
|
| - 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
|
|
|