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
|
// Copyright (c) 2010 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_THUMBNAIL_DATABASE_H_
#define CHROME_BROWSER_HISTORY_THUMBNAIL_DATABASE_H_
#pragma once
#include <vector>
#include "app/sql/connection.h"
#include "app/sql/init_status.h"
#include "app/sql/meta_table.h"
#include "base/ref_counted.h"
#include "chrome/browser/history/history_types.h"
class FilePath;
class RefCountedMemory;
struct ThumbnailScore;
class SkBitmap;
namespace base {
class Time;
}
namespace history {
class ExpireHistoryBackend;
class HistoryPublisher;
// This database interface is owned by the history backend and runs on the
// history thread. It is a totally separate component from history partially
// because we may want to move it to its own thread in the future. The
// operations we will do on this database will be slow, but we can tolerate
// higher latency (it's OK for thumbnails to come in slower than the rest
// of the data). Moving this to a separate thread would not block potentially
// higher priority history operations.
class ThumbnailDatabase {
public:
ThumbnailDatabase();
~ThumbnailDatabase();
// Must be called after creation but before any other methods are called.
// When not INIT_OK, no other functions should be called.
sql::InitStatus Init(const FilePath& db_name,
const HistoryPublisher* history_publisher);
// Open database on a given filename. If the file does not exist,
// it is created.
// |db| is the database to open.
// |db_name| is a path to the database file.
static sql::InitStatus OpenDatabase(sql::Connection* db,
const FilePath& db_name);
// Transactions on the database.
void BeginTransaction();
void CommitTransaction();
int transaction_nesting() const {
return db_.transaction_nesting();
}
// Vacuums the database. This will cause sqlite to defragment and collect
// unused space in the file. It can be VERY SLOW.
void Vacuum();
// Thumbnails ----------------------------------------------------------------
// Sets the given data to be the thumbnail for the given URL,
// overwriting any previous data. If the SkBitmap contains no pixel
// data, the thumbnail will be deleted.
void SetPageThumbnail(const GURL& url,
URLID id,
const SkBitmap& thumbnail,
const ThumbnailScore& score,
base::Time time);
// Retrieves thumbnail data for the given URL, returning true on success,
// false if there is no such thumbnail or there was some other error.
bool GetPageThumbnail(URLID id, std::vector<unsigned char>* data);
// Delete the thumbnail with the provided id. Returns false on failure
bool DeleteThumbnail(URLID id);
// If there is a thumbnail score for the id provided, retrieves the
// current thumbnail score and places it in |score| and returns
// true. Returns false otherwise.
bool ThumbnailScoreForId(URLID id, ThumbnailScore* score);
// Called by the to delete all old thumbnails and make a clean table.
// Returns true on success.
bool RecreateThumbnailTable();
// FavIcons ------------------------------------------------------------------
// Sets the bits for a favicon. This should be png encoded data.
// The time indicates the access time, and is used to detect when the favicon
// should be refreshed.
bool SetFavIcon(FavIconID icon_id,
scoped_refptr<RefCountedMemory> icon_data,
base::Time time);
// Sets the time the favicon was last updated.
bool SetFavIconLastUpdateTime(FavIconID icon_id, base::Time time);
// Returns the id of the entry in the favicon database with the specified url.
// Returns 0 if no entry exists for the specified url.
FavIconID GetFavIconIDForFavIconURL(const GURL& icon_url);
// Gets the png encoded favicon and last updated time for the specified
// favicon id.
bool GetFavIcon(FavIconID icon_id,
base::Time* last_updated,
std::vector<unsigned char>* png_icon_data,
GURL* icon_url);
// Adds the favicon URL to the favicon db, returning its id.
FavIconID AddFavIcon(const GURL& icon_url);
// Delete the favicon with the provided id. Returns false on failure
bool DeleteFavIcon(FavIconID id);
// Temporary FavIcons --------------------------------------------------------
// Create a temporary table to store favicons. Favicons will be copied to
// this table by CopyToTemporaryFavIconTable() and then the original table
// will be dropped, leaving only those copied favicons remaining. This is
// used to quickly delete most of the favicons when clearing history.
bool InitTemporaryFavIconsTable() {
return InitFavIconsTable(&db_, true);
}
// Copies the given favicon from the "main" favicon table to the temporary
// one. This is only valid in between calls to InitTemporaryFavIconsTable()
// and CommitTemporaryFavIconTable().
//
// The ID of the favicon will change when this copy takes place. The new ID
// is returned, or 0 on failure.
FavIconID CopyToTemporaryFavIconTable(FavIconID source);
// Replaces the main URL table with the temporary table created by
// InitTemporaryFavIconsTable(). This will mean all favicons not copied over
// will be deleted. Returns true on success.
bool CommitTemporaryFavIconTable();
// Returns true iff the thumbnails table exists.
// Migrating to TopSites is dropping the thumbnails table.
bool NeedsMigrationToTopSites();
// Renames the database file and drops the Thumbnails table.
bool RenameAndDropThumbnails(const FilePath& old_db_file,
const FilePath& new_db_file);
private:
friend class ExpireHistoryBackend;
// Creates the thumbnail table, returning true if the table already exists
// or was successfully created.
bool InitThumbnailTable();
// Creates the favicon table, returning true if the table already exists,
// or was successfully created. |is_temporary| will be false when generating
// the "regular" favicons table. The expirer sets this to true to generate the
// temporary table, which will have a different name but the same schema.
// |db| is the connection to use for initializing the table.
// A different connection is used in RenameAndDropThumbnails, when we
// need to copy the favicons between two database files.
bool InitFavIconsTable(sql::Connection* db, bool is_temporary);
// Adds support for the new metadata on web page thumbnails.
bool UpgradeToVersion3();
// Creates the index over the favicon table. This will be called during
// initialization after the table is created. This is a separate function
// because it is used by SwapFaviconTables to create an index over the
// newly-renamed favicons table (formerly the temporary table with no index).
void InitFavIconsIndex();
sql::Connection db_;
sql::MetaTable meta_table_;
// This object is created and managed by the history backend. We maintain an
// opaque pointer to the object for our use.
// This can be NULL if there are no indexers registered to receive indexing
// data from us.
const HistoryPublisher* history_publisher_;
// True if migration to TopSites has been done and the thumbnails
// table should not be used.
bool use_top_sites_;
};
} // namespace history
#endif // CHROME_BROWSER_HISTORY_THUMBNAIL_DATABASE_H_
|
