1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
|
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
package org.mozilla.gecko.sync.repositories.domain;
import java.util.HashMap;
import org.json.simple.JSONArray;
import org.json.simple.JSONObject;
import org.mozilla.gecko.background.common.log.Logger;
import org.mozilla.gecko.sync.ExtendedJSONObject;
import org.mozilla.gecko.sync.NonArrayJSONException;
import org.mozilla.gecko.sync.Utils;
import org.mozilla.gecko.sync.repositories.android.RepoUtils;
/**
* Visits are in microsecond precision.
*
* @author rnewman
*
*/
public class HistoryRecord extends Record {
private static final String LOG_TAG = "HistoryRecord";
public static final String COLLECTION_NAME = "history";
public static final long HISTORY_TTL = 60 * 24 * 60 * 60; // 60 days in seconds.
public HistoryRecord(String guid, String collection, long lastModified, boolean deleted) {
super(guid, collection, lastModified, deleted);
this.ttl = HISTORY_TTL;
}
public HistoryRecord(String guid, String collection, long lastModified) {
this(guid, collection, lastModified, false);
}
public HistoryRecord(String guid, String collection) {
this(guid, collection, 0, false);
}
public HistoryRecord(String guid) {
this(guid, COLLECTION_NAME, 0, false);
}
public HistoryRecord() {
this(Utils.generateGuid(), COLLECTION_NAME, 0, false);
}
public String title;
public String histURI;
public JSONArray visits;
public long fennecDateVisited;
public long fennecVisitCount;
@SuppressWarnings("unchecked")
private JSONArray copyVisits() {
if (this.visits == null) {
return null;
}
JSONArray out = new JSONArray();
out.addAll(this.visits);
return out;
}
@Override
public Record copyWithIDs(String guid, long androidID) {
HistoryRecord out = new HistoryRecord(guid, this.collection, this.lastModified, this.deleted);
out.androidID = androidID;
out.sortIndex = this.sortIndex;
out.ttl = this.ttl;
// Copy HistoryRecord fields.
out.title = this.title;
out.histURI = this.histURI;
out.fennecDateVisited = this.fennecDateVisited;
out.fennecVisitCount = this.fennecVisitCount;
out.visits = this.copyVisits();
return out;
}
@Override
protected void populatePayload(ExtendedJSONObject payload) {
putPayload(payload, "id", this.guid);
putPayload(payload, "title", this.title);
putPayload(payload, "histUri", this.histURI); // TODO: encoding?
payload.put("visits", this.visits);
}
@Override
protected void initFromPayload(ExtendedJSONObject payload) {
this.histURI = (String) payload.get("histUri");
this.title = (String) payload.get("title");
try {
this.visits = payload.getArray("visits");
} catch (NonArrayJSONException e) {
Logger.error(LOG_TAG, "Got non-array visits in history record " + this.guid, e);
this.visits = new JSONArray();
}
}
/**
* We consider two history records to be congruent if they represent the
* same history record regardless of visits. Titles are allowed to differ,
* but the URI must be the same.
*/
@Override
public boolean congruentWith(Object o) {
if (!(o instanceof HistoryRecord)) {
return false;
}
HistoryRecord other = (HistoryRecord) o;
if (!super.congruentWith(other)) {
return false;
}
return RepoUtils.stringsEqual(this.histURI, other.histURI);
}
@Override
public boolean equalPayloads(Object o) {
if (!(o instanceof HistoryRecord)) {
Logger.debug(LOG_TAG, "Not a HistoryRecord: " + o.getClass());
return false;
}
HistoryRecord other = (HistoryRecord) o;
if (!super.equalPayloads(other)) {
Logger.debug(LOG_TAG, "super.equalPayloads returned false.");
return false;
}
return RepoUtils.stringsEqual(this.title, other.title) &&
RepoUtils.stringsEqual(this.histURI, other.histURI) &&
checkVisitsEquals(other);
}
@Override
public boolean equalAndroidIDs(Record other) {
return super.equalAndroidIDs(other) &&
this.equalFennecVisits(other);
}
private boolean equalFennecVisits(Record other) {
if (!(other instanceof HistoryRecord)) {
return false;
}
HistoryRecord h = (HistoryRecord) other;
return this.fennecDateVisited == h.fennecDateVisited &&
this.fennecVisitCount == h.fennecVisitCount;
}
private boolean checkVisitsEquals(HistoryRecord other) {
Logger.debug(LOG_TAG, "Checking visits.");
if (Logger.LOG_PERSONAL_INFORMATION) {
// Don't JSON-encode unless we're logging.
Logger.pii(LOG_TAG, ">> Mine: " + ((this.visits == null) ? "null" : this.visits.toJSONString()));
Logger.pii(LOG_TAG, ">> Theirs: " + ((other.visits == null) ? "null" : other.visits.toJSONString()));
}
// Handle nulls.
if (this.visits == other.visits) {
return true;
}
// Now they can't both be null.
int aSize = this.visits == null ? 0 : this.visits.size();
int bSize = other.visits == null ? 0 : other.visits.size();
if (aSize != bSize) {
return false;
}
// Now neither of them can be null.
// TODO: do this by maintaining visits as a sorted array.
HashMap<Long, Long> otherVisits = new HashMap<Long, Long>();
for (int i = 0; i < bSize; i++) {
JSONObject visit = (JSONObject) other.visits.get(i);
otherVisits.put((Long) visit.get("date"), (Long) visit.get("type"));
}
for (int i = 0; i < aSize; i++) {
JSONObject visit = (JSONObject) this.visits.get(i);
if (!otherVisits.containsKey(visit.get("date"))) {
return false;
}
Long otherDate = (Long) visit.get("date");
Long otherType = otherVisits.get(otherDate);
if (otherType == null) {
return false;
}
if (!otherType.equals((Long) visit.get("type"))) {
return false;
}
}
return true;
}
//
// Example record (note microsecond resolution):
//
// {id:"--DUvUomABNq",
// histUri:"https://bugzilla.mozilla.org/show_bug.cgi?id=697634",
// title:"697634 \u2013 xpcshell test failures on 10.7",
// visits:[{date:1320087601465600, type:2},
// {date:1320084970724990, type:1},
// {date:1320084847035717, type:1},
// {date:1319764134412287, type:1},
// {date:1319757917982518, type:1},
// {date:1319751664627351, type:1},
// {date:1319681421072326, type:1},
// {date:1319681306455594, type:1},
// {date:1319678117125234, type:1},
// {date:1319677508862901, type:1}]
// }
//
//"type" is a transition type:
//
//https://developer.mozilla.org/en/XPCOM_Interface_Reference/nsINavHistoryService#Transition_type_constants
}
|
