Componentize Reading List

ios/chrome/browser/reading_list/reading_list_entry.cc

Index: ios/chrome/browser/reading_list/reading_list_entry.cc
diff --git a/ios/chrome/browser/reading_list/reading_list_entry.cc b/ios/chrome/browser/reading_list/reading_list_entry.cc
deleted file mode 100644
index b318f084df5c490077ca2cb1cc8e8b4d1f1f6de9..0000000000000000000000000000000000000000
--- a/ios/chrome/browser/reading_list/reading_list_entry.cc
+++ /dev/null
@@ -1,374 +0,0 @@
-// Copyright 2016 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 "ios/chrome/browser/reading_list/reading_list_entry.h"
-
-#include "base/json/json_string_value_serializer.h"
-#include "base/memory/ptr_util.h"
-#include "components/sync/protocol/reading_list_specifics.pb.h"
-#include "ios/chrome/browser/reading_list/offline_url_utils.h"
-#include "ios/chrome/browser/reading_list/proto/reading_list.pb.h"
-#include "net/base/backoff_entry_serializer.h"
-
-// The backoff time is the following: 10min, 10min, 1h, 2h, 2h..., starting
-// after the first failure.
-const net::BackoffEntry::Policy ReadingListEntry::kBackoffPolicy = {
-    // Number of initial errors (in sequence) to ignore before applying
-    // exponential back-off rules.
-    2,
-
-    // Initial delay for exponential back-off in ms.
-    10 * 60 * 1000,  // 10 minutes.
-
-    // Factor by which the waiting time will be multiplied.
-    6,
-
-    // Fuzzing percentage. ex: 10% will spread requests randomly
-    // between 90%-100% of the calculated time.
-    0.1,  // 10%.
-
-    // Maximum amount of time we are willing to delay our request in ms.
-    2 * 3600 * 1000,  // 2 hours.
-
-    // Time to keep an entry from being discarded even when it
-    // has no significant state, -1 to never discard.
-    -1,
-
-    true,  // Don't use initial delay unless the last request was an error.
-};
-
-ReadingListEntry::ReadingListEntry(const GURL& url, const std::string& title)
-    : ReadingListEntry(url, title, nullptr){};
-
-ReadingListEntry::ReadingListEntry(const GURL& url,
-                                   const std::string& title,
-                                   std::unique_ptr<net::BackoffEntry> backoff)
-    : ReadingListEntry(url,
-                       title,
-                       0,
-                       0,
-                       WAITING,
-                       base::FilePath(),
-                       0,
-                       std::move(backoff)) {}
-
-ReadingListEntry::ReadingListEntry(
-    const GURL& url,
-    const std::string& title,
-    int64_t creation_time,
-    int64_t update_time,
-    ReadingListEntry::DistillationState distilled_state,
-    const base::FilePath& distilled_path,
-    int failed_download_counter,
-    std::unique_ptr<net::BackoffEntry> backoff)
-    : url_(url),
-      title_(title),
-      distilled_path_(distilled_path),
-      distilled_state_(distilled_state),
-      failed_download_counter_(failed_download_counter),
-      creation_time_us_(creation_time),
-      update_time_us_(update_time) {
-  if (backoff) {
-    backoff_ = std::move(backoff);
-  } else {
-    backoff_ = base::MakeUnique<net::BackoffEntry>(&kBackoffPolicy);
-  }
-  if (creation_time_us_ == 0) {
-    DCHECK(update_time_us_ == 0);
-    creation_time_us_ =
-        (base::Time::Now() - base::Time::UnixEpoch()).InMicroseconds();
-    update_time_us_ = creation_time_us_;
-  }
-  DCHECK(!url.is_empty());
-  DCHECK(url.is_valid());
-}
-
-ReadingListEntry::ReadingListEntry(ReadingListEntry&& entry)
-    : url_(std::move(entry.url_)),
-      title_(std::move(entry.title_)),
-      distilled_path_(std::move(entry.distilled_path_)),
-      distilled_state_(std::move(entry.distilled_state_)),
-      backoff_(std::move(entry.backoff_)),
-      failed_download_counter_(std::move(entry.failed_download_counter_)),
-      creation_time_us_(std::move(entry.creation_time_us_)),
-      update_time_us_(std::move(entry.update_time_us_)) {}
-
-ReadingListEntry::~ReadingListEntry() {}
-
-const GURL& ReadingListEntry::URL() const {
-  return url_;
-}
-
-const std::string& ReadingListEntry::Title() const {
-  return title_;
-}
-
-ReadingListEntry::DistillationState ReadingListEntry::DistilledState() const {
-  return distilled_state_;
-}
-
-const base::FilePath& ReadingListEntry::DistilledPath() const {
-  return distilled_path_;
-}
-
-const GURL ReadingListEntry::DistilledURL() const {
-  return reading_list::DistilledURLForPath(distilled_path_);
-}
-
-base::TimeDelta ReadingListEntry::TimeUntilNextTry() const {
-  return backoff_->GetTimeUntilRelease();
-}
-
-int ReadingListEntry::FailedDownloadCounter() const {
-  return failed_download_counter_;
-}
-
-ReadingListEntry& ReadingListEntry::operator=(ReadingListEntry&& other) {
-  url_ = std::move(other.url_);
-  title_ = std::move(other.title_);
-  distilled_path_ = std::move(other.distilled_path_);
-  distilled_state_ = std::move(other.distilled_state_);
-  backoff_ = std::move(other.backoff_);
-  failed_download_counter_ = std::move(other.failed_download_counter_);
-  creation_time_us_ = std::move(other.creation_time_us_);
-  update_time_us_ = std::move(other.update_time_us_);
-  return *this;
-}
-
-bool ReadingListEntry::operator==(const ReadingListEntry& other) const {
-  return url_ == other.url_;
-}
-
-void ReadingListEntry::SetTitle(const std::string& title) {
-  title_ = title;
-}
-
-void ReadingListEntry::SetDistilledPath(const base::FilePath& path) {
-  DCHECK(!path.empty());
-  distilled_path_ = path;
-  distilled_state_ = PROCESSED;
-  backoff_->Reset();
-  failed_download_counter_ = 0;
-}
-
-void ReadingListEntry::SetDistilledState(DistillationState distilled_state) {
-  DCHECK(distilled_state != PROCESSED);  // use SetDistilledPath instead.
-  DCHECK(distilled_state != WAITING);
-  // Increase time until next retry exponentially if the state change from a
-  // non-error state to an error state.
-  if ((distilled_state == WILL_RETRY || distilled_state == ERROR) &&
-      distilled_state_ != WILL_RETRY && distilled_state_ != ERROR) {
-    backoff_->InformOfRequest(false);
-    failed_download_counter_++;
-  }
-
-  distilled_state_ = distilled_state;
-  distilled_path_ = base::FilePath();
-}
-
-int64_t ReadingListEntry::UpdateTime() const {
-  return update_time_us_;
-}
-
-int64_t ReadingListEntry::CreationTime() const {
-  return creation_time_us_;
-}
-
-void ReadingListEntry::MarkEntryUpdated() {
-  update_time_us_ =
-      (base::Time::Now() - base::Time::UnixEpoch()).InMicroseconds();
-}
-
-// static
-std::unique_ptr<ReadingListEntry> ReadingListEntry::FromReadingListLocal(
-    const reading_list::ReadingListLocal& pb_entry) {
-  if (!pb_entry.has_url()) {
-    return nullptr;
-  }
-  GURL url(pb_entry.url());
-  if (url.is_empty() || !url.is_valid()) {
-    return nullptr;
-  }
-  std::string title;
-  if (pb_entry.has_title()) {
-    title = pb_entry.title();
-  }
-
-  int64_t creation_time_us = 0;
-  if (pb_entry.has_creation_time_us()) {
-    creation_time_us = pb_entry.creation_time_us();
-  }
-
-  int64_t update_time_us = 0;
-  if (pb_entry.has_update_time_us()) {
-    update_time_us = pb_entry.update_time_us();
-  }
-
-  ReadingListEntry::DistillationState distillation_state =
-      ReadingListEntry::WAITING;
-  if (pb_entry.has_distillation_state()) {
-    switch (pb_entry.distillation_state()) {
-      case reading_list::ReadingListLocal::WAITING:
-        distillation_state = ReadingListEntry::WAITING;
-        break;
-      case reading_list::ReadingListLocal::PROCESSING:
-        distillation_state = ReadingListEntry::PROCESSING;
-        break;
-      case reading_list::ReadingListLocal::PROCESSED:
-        distillation_state = ReadingListEntry::PROCESSED;
-        break;
-      case reading_list::ReadingListLocal::WILL_RETRY:
-        distillation_state = ReadingListEntry::WILL_RETRY;
-        break;
-      case reading_list::ReadingListLocal::ERROR:
-        distillation_state = ReadingListEntry::ERROR;
-        break;
-    }
-  }
-
-  base::FilePath distilled_path;
-  if (pb_entry.has_distilled_path()) {
-    distilled_path = base::FilePath(pb_entry.distilled_path());
-  }
-
-  int64_t failed_download_counter = 0;
-  if (pb_entry.has_failed_download_counter()) {
-    failed_download_counter = pb_entry.failed_download_counter();
-  }
-
-  std::unique_ptr<net::BackoffEntry> backoff;
-  if (pb_entry.has_backoff()) {
-    JSONStringValueDeserializer deserializer(pb_entry.backoff());
-    std::unique_ptr<base::Value> value(
-        deserializer.Deserialize(nullptr, nullptr));
-    if (value) {
-      backoff = net::BackoffEntrySerializer::DeserializeFromValue(
-          *value, &kBackoffPolicy, nullptr, base::Time::Now());
-    }
-  }
-
-  return base::WrapUnique<ReadingListEntry>(new ReadingListEntry(
-      url, title, creation_time_us, update_time_us, distillation_state,
-      distilled_path, failed_download_counter, std::move(backoff)));
-}
-
-// static
-std::unique_ptr<ReadingListEntry> ReadingListEntry::FromReadingListSpecifics(
-    const sync_pb::ReadingListSpecifics& pb_entry) {
-  if (!pb_entry.has_url()) {
-    return nullptr;
-  }
-  GURL url(pb_entry.url());
-  if (url.is_empty() || !url.is_valid()) {
-    return nullptr;
-  }
-  std::string title;
-  if (pb_entry.has_title()) {
-    title = pb_entry.title();
-  }
-
-  int64_t creation_time_us = 0;
-  if (pb_entry.has_creation_time_us()) {
-    creation_time_us = pb_entry.creation_time_us();
-  }
-
-  int64_t update_time_us = 0;
-  if (pb_entry.has_update_time_us()) {
-    update_time_us = pb_entry.update_time_us();
-  }
-
-  return base::WrapUnique<ReadingListEntry>(
-      new ReadingListEntry(url, title, creation_time_us, update_time_us,
-                           WAITING, base::FilePath(), 0, nullptr));
-}
-
-void ReadingListEntry::MergeLocalStateFrom(ReadingListEntry& other) {
-  distilled_path_ = std::move(other.distilled_path_);
-  distilled_state_ = std::move(other.distilled_state_);
-  backoff_ = std::move(other.backoff_);
-  failed_download_counter_ = std::move(other.failed_download_counter_);
-}
-
-std::unique_ptr<reading_list::ReadingListLocal>
-ReadingListEntry::AsReadingListLocal(bool read) const {
-  std::unique_ptr<reading_list::ReadingListLocal> pb_entry =
-      base::MakeUnique<reading_list::ReadingListLocal>();
-
-  // URL is used as the key for the database and sync as there is only one entry
-  // per URL.
-  pb_entry->set_entry_id(URL().spec());
-  pb_entry->set_title(Title());
-  pb_entry->set_url(URL().spec());
-  pb_entry->set_creation_time_us(CreationTime());
-  pb_entry->set_update_time_us(UpdateTime());
-
-  if (read) {
-    pb_entry->set_status(reading_list::ReadingListLocal::READ);
-  } else {
-    pb_entry->set_status(reading_list::ReadingListLocal::UNREAD);
-  }
-
-  reading_list::ReadingListLocal::DistillationState distilation_state;
-  switch (DistilledState()) {
-    case ReadingListEntry::WAITING:
-      distilation_state = reading_list::ReadingListLocal::WAITING;
-      break;
-    case ReadingListEntry::PROCESSING:
-      distilation_state = reading_list::ReadingListLocal::PROCESSING;
-      break;
-    case ReadingListEntry::PROCESSED:
-      distilation_state = reading_list::ReadingListLocal::PROCESSED;
-      break;
-    case ReadingListEntry::WILL_RETRY:
-      distilation_state = reading_list::ReadingListLocal::WILL_RETRY;
-      break;
-    case ReadingListEntry::ERROR:
-      distilation_state = reading_list::ReadingListLocal::ERROR;
-      break;
-  }
-  pb_entry->set_distillation_state(distilation_state);
-  if (!DistilledPath().empty()) {
-    pb_entry->set_distilled_path(DistilledPath().value());
-  }
-  pb_entry->set_failed_download_counter(failed_download_counter_);
-
-  if (backoff_) {
-    std::unique_ptr<base::Value> backoff =
-        net::BackoffEntrySerializer::SerializeToValue(*backoff_,
-                                                      base::Time::Now());
-
-    std::string output;
-    JSONStringValueSerializer serializer(&output);
-    serializer.Serialize(*backoff);
-    pb_entry->set_backoff(output);
-  }
-  return pb_entry;
-}
-
-std::unique_ptr<sync_pb::ReadingListSpecifics>
-ReadingListEntry::AsReadingListSpecifics(bool read) const {
-  std::unique_ptr<sync_pb::ReadingListSpecifics> pb_entry =
-      base::MakeUnique<sync_pb::ReadingListSpecifics>();
-
-  // URL is used as the key for the database and sync as there is only one entry
-  // per URL.
-  pb_entry->set_entry_id(URL().spec());
-  pb_entry->set_title(Title());
-  pb_entry->set_url(URL().spec());
-  pb_entry->set_creation_time_us(CreationTime());
-  pb_entry->set_update_time_us(UpdateTime());
-
-  if (read) {
-    pb_entry->set_status(sync_pb::ReadingListSpecifics::READ);
-  } else {
-    pb_entry->set_status(sync_pb::ReadingListSpecifics::UNREAD);
-  }
-
-  return pb_entry;
-}
-
-bool ReadingListEntry::CompareEntryUpdateTime(const ReadingListEntry& lhs,
-                                              const ReadingListEntry& rhs) {
-  return lhs.UpdateTime() > rhs.UpdateTime();
-}