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
|
// Copyright (c) 2011 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.
#ifndef CHROME_BROWSER_HISTORY_VISIT_DATABASE_H_
#define CHROME_BROWSER_HISTORY_VISIT_DATABASE_H_
#pragma once
#include "chrome/browser/history/history_types.h"
namespace sql {
class Connection;
class Statement;
}
namespace history {
// A visit database is one which stores visits for URLs, that is, times and
// linking information. A visit database must also be a URLDatabase, as this
// modifies tables used by URLs directly and could be thought of as inheriting
// from URLDatabase. However, this inheritance is not explicit as things would
// get too complicated and have multiple inheritance.
class VisitDatabase {
public:
// Must call InitVisitTable() before using to make sure the database is
// initialized.
VisitDatabase();
virtual ~VisitDatabase();
// Deletes the visit table. Used for rapidly clearing all visits. In this
// case, InitVisitTable would be called immediately afterward to re-create it.
// Returns true on success.
bool DropVisitTable();
// Adds a line to the visit database with the given information, returning
// the added row ID on success, 0 on failure. The given visit is updated with
// the new row ID on success. In addition, adds its source into visit_source
// table.
VisitID AddVisit(VisitRow* visit, VisitSource source);
// Deletes the given visit from the database. If a visit with the given ID
// doesn't exist, it will not do anything.
void DeleteVisit(const VisitRow& visit);
// Query a VisitInfo giving an visit id, filling the given VisitRow.
// Returns true on success.
bool GetRowForVisit(VisitID visit_id, VisitRow* out_visit);
// Updates an existing row. The new information is set on the row, using the
// VisitID as the key. The visit must exist. Returns true on success.
bool UpdateVisitRow(const VisitRow& visit);
// Fills in the given vector with all of the visits for the given page ID,
// sorted in ascending order of date. Returns true on success (although there
// may still be no matches).
bool GetVisitsForURL(URLID url_id, VisitVector* visits);
// Fills in the given vector with all of the visits for the given page ID that
// have the |is_indexed| field set to true, in no particular order.
// Returns true on success (although there may still be no matches).
bool GetIndexedVisitsForURL(URLID url_id, VisitVector* visits);
// Fills all visits in the time range [begin, end) to the given vector. Either
// time can be is_null(), in which case the times in that direction are
// unbounded.
//
// If |max_results| is non-zero, up to that many results will be returned. If
// there are more results than that, the oldest ones will be returned. (This
// is used for history expiration.)
//
// The results will be in increasing order of date.
void GetAllVisitsInRange(base::Time begin_time, base::Time end_time,
int max_results, VisitVector* visits);
// Fills all visits with specified transition in the time range [begin, end)
// to the given vector. Either time can be is_null(), in which case the times
// in that direction are unbounded.
//
// If |max_results| is non-zero, up to that many results will be returned. If
// there are more results than that, the oldest ones will be returned. (This
// is used for history expiration.)
//
// The results will be in increasing order of date.
void GetVisitsInRangeForTransition(base::Time begin_time,
base::Time end_time,
int max_results,
content::PageTransition transition,
VisitVector* visits);
// Fills all visits in the given time range into the given vector that should
// be user-visible, which excludes things like redirects and subframes. The
// begin time is inclusive, the end time is exclusive. Either time can be
// is_null(), in which case the times in that direction are unbounded.
//
// Up to |max_count| visits will be returned. If there are more visits than
// that, the most recent |max_count| will be returned. If 0, all visits in the
// range will be computed.
//
// Only one visit for each URL will be returned, and it will be the most
// recent one in the time range.
void GetVisibleVisitsInRange(base::Time begin_time, base::Time end_time,
int max_count,
VisitVector* visits);
// Returns the visit ID for the most recent visit of the given URL ID, or 0
// if there is no visit for the URL.
//
// If non-NULL, the given visit row will be filled with the information of
// the found visit. When no visit is found, the row will be unchanged.
VisitID GetMostRecentVisitForURL(URLID url_id,
VisitRow* visit_row);
// Returns the |max_results| most recent visit sessions for |url_id|.
//
// Returns false if there's a failure preparing the statement. True
// otherwise. (No results are indicated with an empty |visits|
// vector.)
bool GetMostRecentVisitsForURL(URLID url_id,
int max_results,
VisitVector* visits);
// Finds a redirect coming from the given |from_visit|. If a redirect is
// found, it fills the visit ID and URL into the out variables and returns
// true. If there is no redirect from the given visit, returns false.
//
// If there is more than one redirect, this will compute a random one. But
// duplicates should be very rare, and we don't actually care which one we
// get in most cases. These will occur when the user goes back and gets
// redirected again.
//
// to_visit and to_url can be NULL in which case they are ignored.
bool GetRedirectFromVisit(VisitID from_visit,
VisitID* to_visit,
GURL* to_url);
// Similar to the above function except finds a redirect going to a given
// |to_visit|.
bool GetRedirectToVisit(VisitID to_visit,
VisitID* from_visit,
GURL* from_url);
// Gets the number of user-visible visits to all URLs on the same
// scheme/host/port as |url|, as well as the time of the earliest visit.
// "User-visible" is defined as in GetVisibleVisitsInRange() above, i.e.
// excluding redirects and subframes.
// This function is only valid for HTTP and HTTPS URLs; all other schemes
// cause the function to return false.
bool GetVisibleVisitCountToHost(const GURL& url,
int* count,
base::Time* first_visit);
// Get the time of the first item in our database.
bool GetStartDate(base::Time* first_visit);
// Get the source information about the given visits.
void GetVisitsSource(const VisitVector& visits,
VisitSourceMap* sources);
protected:
// Returns the database for the functions in this interface.
virtual sql::Connection& GetDB() = 0;
// Called by the derived classes on initialization to make sure the tables
// and indices are properly set up. Must be called before anything else.
bool InitVisitTable();
// Convenience to fill a VisitRow. Assumes the visit values are bound starting
// at index 0.
static void FillVisitRow(sql::Statement& statement, VisitRow* visit);
// Convenience to fill a VisitVector. Assumes that statement.step()
// hasn't happened yet.
static void FillVisitVector(sql::Statement& statement, VisitVector* visits);
private:
DISALLOW_COPY_AND_ASSIGN(VisitDatabase);
};
} // history
#endif // CHROME_BROWSER_HISTORY_VISIT_DATABASE_H_
|
