Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(341)

Side by Side Diff: components/reading_list/reading_list_entry.h

Issue 2511723002: Enable RL sync by default on iOS (Closed)
Patch Set: rebase Created 4 years ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
OLDNEW
(Empty)
1 // Copyright 2016 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
4
5 #ifndef COMPONENTS_READING_LIST_READING_LIST_ENTRY_H_
6 #define COMPONENTS_READING_LIST_READING_LIST_ENTRY_H_
7
8 #include <string>
9
10 #include "base/files/file_path.h"
11 #include "base/macros.h"
12 #include "base/time/time.h"
13 #include "net/base/backoff_entry.h"
14 #include "url/gurl.h"
15
16 namespace reading_list {
17 class ReadingListLocal;
18 }
19
20 namespace sync_pb {
21 class ReadingListSpecifics;
22 }
23
24 class ReadingListEntry;
25 using ReadingListEntries = std::vector<ReadingListEntry>;
26
27 // An entry in the reading list. The URL is a unique identifier for an entry, as
28 // such it should not be empty and is the only thing considered when comparing
29 // entries.
30 class ReadingListEntry {
31 public:
32 ReadingListEntry(const GURL& url, const std::string& title);
33 ReadingListEntry(const GURL& url,
34 const std::string& title,
35 std::unique_ptr<net::BackoffEntry> backoff);
36 ReadingListEntry(ReadingListEntry&& entry);
37 ~ReadingListEntry();
38
39 // Entries are created in WAITING state. At some point they will be PROCESSING
40 // into one of the three state: PROCESSED, the only state a distilled URL
41 // would be set, WILL_RETRY, similar to wait, but with exponential delays or
42 // ERROR where the system will not retry at all.
43 enum DistillationState { WAITING, PROCESSING, PROCESSED, WILL_RETRY, ERROR };
44
45 static const net::BackoffEntry::Policy kBackoffPolicy;
46
47 // The URL of the page the user would like to read later.
48 const GURL& URL() const;
49 // The title of the entry. Might be empty.
50 const std::string& Title() const;
51 // What state this entry is in.
52 DistillationState DistilledState() const;
53 // The local file path for the distilled version of the page. This should only
54 // be called if the state is "PROCESSED".
55 const base::FilePath& DistilledPath() const;
56 // The time before the next try. This is automatically increased when the
57 // state is set to WILL_RETRY or ERROR from a non-error state.
58 base::TimeDelta TimeUntilNextTry() const;
59 // The number of time chrome failed to download this entry. This is
60 // automatically increased when the state is set to WILL_RETRY or ERROR from a
61 // non-error state.
62 int FailedDownloadCounter() const;
63
64 // The last update time of the entry. This value may be used to sort the
65 // entries. The value is in microseconds since Jan 1st 1970.
66 int64_t UpdateTime() const;
67
68 // The creation update time of the entry. The value is in microseconds since
69 // Jan 1st 1970.
70 int64_t CreationTime() const;
71
72 // Set the update time to now.
73 void MarkEntryUpdated();
74
75 // Returns a protobuf encoding the content of this ReadingListEntry for local
76 // storage.
77 std::unique_ptr<reading_list::ReadingListLocal> AsReadingListLocal(
78 bool read) const;
79
80 // Returns a protobuf encoding the content of this ReadingListEntry for sync.
81 std::unique_ptr<sync_pb::ReadingListSpecifics> AsReadingListSpecifics(
82 bool read) const;
83
84 // Created a ReadingListEntry from the protobuf format.
85 static std::unique_ptr<ReadingListEntry> FromReadingListLocal(
86 const reading_list::ReadingListLocal& pb_entry);
87
88 // Created a ReadingListEntry from the protobuf format.
89 static std::unique_ptr<ReadingListEntry> FromReadingListSpecifics(
90 const sync_pb::ReadingListSpecifics& pb_entry);
91
92 // Merge the local data from |other| to this.
93 // The local fields (distilled_state_, distilled_url_, backoff_,
94 // failed_download_counter_) of |other| are moved to |this| and must not be
95 // used after this call.
96 void MergeLocalStateFrom(ReadingListEntry& other);
97
98 ReadingListEntry& operator=(ReadingListEntry&& other);
99
100 bool operator==(const ReadingListEntry& other) const;
101
102 // Returns whether |lhs| is more recent than |rhs|.
103 static bool CompareEntryUpdateTime(const ReadingListEntry& lhs,
104 const ReadingListEntry& rhs);
105
106 // Sets the title.
107 void SetTitle(const std::string& title);
108 // Sets the distilled URL and switch the state to PROCESSED and reset the time
109 // until the next try.
110 void SetDistilledPath(const base::FilePath& path);
111 // Sets the state to one of PROCESSING, WILL_RETRY or ERROR.
112 void SetDistilledState(DistillationState distilled_state);
113
114 private:
115 ReadingListEntry(const GURL& url,
116 const std::string& title,
117 int64_t creation_time,
118 int64_t update_time,
119 ReadingListEntry::DistillationState distilled_state,
120 const base::FilePath& distilled_path,
121 int failed_download_counter,
122 std::unique_ptr<net::BackoffEntry> backoff);
123 GURL url_;
124 std::string title_;
125 base::FilePath distilled_path_;
126 DistillationState distilled_state_;
127
128 std::unique_ptr<net::BackoffEntry> backoff_;
129 int failed_download_counter_;
130
131 // These value are in microseconds since Jan 1st 1970. They are used for
132 // sorting the entries from the database. They are kept in int64_t to avoid
133 // conversion on each save/read event.
134 int64_t creation_time_us_;
135 int64_t update_time_us_;
136
137 DISALLOW_COPY_AND_ASSIGN(ReadingListEntry);
138 };
139
140 #endif // COMPONENTS_READING_LIST_READING_LIST_ENTRY_H_
OLDNEW
« no previous file with comments | « components/reading_list/proto/reading_list.proto ('k') | components/reading_list/reading_list_entry.cc » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698