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
|
// Copyright (c) 2009 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_THUMBNAIL_STORE_H_
#define CHROME_BROWSER_THUMBNAIL_STORE_H_
#include <map>
#include <string>
#include <vector>
#include "base/file_path.h"
#include "base/message_loop.h"
#include "base/ref_counted.h"
#include "base/timer.h"
#include "chrome/browser/cancelable_request.h"
#include "chrome/browser/history/history.h"
#include "chrome/common/pref_names.h"
#include "chrome/common/ref_counted_util.h"
#include "testing/gtest/include/gtest/gtest_prod.h"
class DictionaryValue;
class GURL;
class HistoryService;
class Pickle;
class Profile;
class SkBitmap;
struct ThumbnailScore;
namespace base {
class Time;
}
// This storage interface provides storage for the thumbnails used
// by the new_tab_ui.
class ThumbnailStore : public base::RefCountedThreadSafe<ThumbnailStore> {
public:
ThumbnailStore();
~ThumbnailStore();
// Must be called after creation but before other methods are called.
// file_path is a directory where a new database should be created
// or the location of an existing databse.
void Init(const FilePath& file_path, Profile* profile);
// Stores the given thumbnail and score with the associated url in the cache.
// If write_to_disk is true, the thumbnail data is written to disk on the
// file_thread.
bool SetPageThumbnail(const GURL& url,
const SkBitmap& thumbnail,
const ThumbnailScore& score,
bool write_to_disk);
// Sets *data to point to the thumbnail for the given url.
// Returns false if no thumbnail available.
bool GetPageThumbnail(const GURL& url, RefCountedBytes** data);
private:
FRIEND_TEST(ThumbnailStoreTest, RetrieveFromCache);
FRIEND_TEST(ThumbnailStoreTest, RetrieveFromDisk);
FRIEND_TEST(ThumbnailStoreTest, UpdateThumbnail);
FRIEND_TEST(ThumbnailStoreTest, FollowRedirects);
friend class ThumbnailStoreTest;
// Data structure used to store thumbnail data in memory.
typedef std::map<GURL, std::pair<scoped_refptr<RefCountedBytes>,
ThumbnailScore> > Cache;
// Most visited URLs and their redirect lists -------------------------------
// Query the HistoryService for the most visited URLs and the most recent
// redirect lists for those URLs. This happens in the background and the
// callback is OnURLDataAvailable.
void UpdateURLData();
// The callback for UpdateURLData. The ThumbnailStore takes ownership of
// the most visited urls list and redirect lists passed in.
void OnURLDataAvailable(std::vector<GURL>* urls,
history::RedirectMap* redirects);
// Remove stale data --------------------------------------------------------
// Remove entries from the in memory thumbnail cache and redirect lists
// cache that have been blacklisted or are not in the top kMaxCacheSize
// visited sites.
void CleanCacheData();
// Deletes thumbnail data from disk for the given list of urls.
void DeleteThumbnails(
scoped_refptr<RefCountedVector<GURL> > thumbnail_urls) const;
// Disk operations ----------------------------------------------------------
// Read all thumbnail data from the specified FilePath into a Cache object.
// Done on the file_thread and returns to OnDiskDataAvailable on the thread
// owning the specified MessageLoop.
void GetAllThumbnailsFromDisk(FilePath filepath, MessageLoop* cb_loop);
// Read the thumbnail data from the given file and stores it in the
// out parameters GURL, SkBitmap, and ThumbnailScore.
bool GetPageThumbnailFromDisk(const FilePath& file,
GURL* url,
RefCountedBytes* data,
ThumbnailScore* score) const;
// Once thumbnail data from the disk is available from the file_thread,
// this function is invoked on the main thread. It takes ownership of the
// Cache* passed in and retains this Cache* for the lifetime of the object.
void OnDiskDataAvailable(Cache* cache);
// Write thumbnail data to disk for a given url.
bool WriteThumbnailToDisk(const GURL& url,
scoped_refptr<RefCountedBytes> data,
const ThumbnailScore& score) const;
// Pack the given ThumbnailScore into the given Pickle.
void PackScore(const ThumbnailScore& score, Pickle* packed) const;
// Unpack a ThumbnailScore from a given Pickle and associated iterator.
// Returns false is a ThumbnailScore could not be unpacked.
bool UnpackScore(ThumbnailScore* score,
const Pickle& packed,
void*& iter) const;
// Decide whether to store data ---------------------------------------------
bool ShouldStoreThumbnailForURL(const GURL& url) const;
bool IsURLBlacklisted(const GURL& url) const;
std::wstring GetDictionaryKeyForURL(const std::string& url) const;
// Returns true if url is in most_visited_urls_.
bool IsPopular(const GURL& url) const;
// Member variables ---------------------------------------------------------
// The Cache maintained by the object.
scoped_ptr<Cache> cache_;
bool cache_initialized_;
// The location of the thumbnail store.
FilePath file_path_;
// We hold a reference to the history service to query for most visited URLs
// and redirect information.
scoped_refptr<HistoryService> hs_;
// A list of the most_visited_urls_ refreshed every 30mins from the
// HistoryService.
scoped_ptr<std::vector<GURL> > most_visited_urls_;
// A pointer to the persistent URL blacklist for this profile.
const DictionaryValue* url_blacklist_;
// A map pairing the URL that a user typed to a list of URLs it was
// redirected to. Ex:
// google.com => { http://www.google.com/ }
scoped_ptr<history::RedirectMap> redirect_urls_;
// Timer on which UpdateURLData runs.
base::RepeatingTimer<ThumbnailStore> timer_;
// Consumer for queries to the HistoryService.
CancelableRequestConsumer consumer_;
static const unsigned int kMaxCacheSize = 45;
DISALLOW_COPY_AND_ASSIGN(ThumbnailStore);
};
#endif // CHROME_BROWSER_THUMBNAIL_STORE_H_
|
