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
|
// Copyright (c) 2012 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_FAVICON_FAVICON_SERVICE_H_
#define CHROME_BROWSER_FAVICON_FAVICON_SERVICE_H_
#include <vector>
#include "base/callback.h"
#include "base/memory/ref_counted.h"
#include "chrome/browser/cancelable_request.h"
#include "chrome/browser/history/history_types.h"
#include "chrome/browser/profiles/profile_keyed_service.h"
#include "chrome/common/ref_counted_util.h"
class GURL;
class HistoryService;
class Profile;
// The favicon service provides methods to access favicons. It calls the history
// backend behind the scenes.
//
// This service is thread safe. Each request callback is invoked in the
// thread that made the request.
class FaviconService : public CancelableRequestProvider,
public ProfileKeyedService {
public:
explicit FaviconService(HistoryService* history_service);
virtual ~FaviconService();
// Callback for GetFavicon. If we have previously inquired about the favicon
// for this URL, |know_favicon| will be true, and the rest of the fields will
// be valid (otherwise they will be ignored).
//
// On |know_favicon| == true, |data| will either contain the PNG encoded
// favicon data, or it will be NULL to indicate that the site does not have
// a favicon (in other words, we know the site doesn't have a favicon, as
// opposed to not knowing anything). |expired| will be set to true if we
// refreshed the favicon "too long" ago and should be updated if the page
// is visited again.
typedef base::Callback<
void(Handle, // handle
history::FaviconData)> // the type of favicon
FaviconDataCallback;
typedef CancelableRequest<FaviconDataCallback> GetFaviconRequest;
// Requests the |icon_type| of favicon. |consumer| is notified when the bits
// have been fetched. |icon_url| is the URL of the icon itself, e.g.
// <http://www.google.com/favicon.ico>.
Handle GetFavicon(const GURL& icon_url,
history::IconType icon_type,
CancelableRequestConsumerBase* consumer,
const FaviconDataCallback& callback);
// Fetches the |icon_type| of favicon at |icon_url|, sending the results to
// the given |callback|. If the favicon has previously been set via
// SetFavicon(), then the favicon URL for |page_url| and all redirects is set
// to |icon_url|. If the favicon has not been set, the database is not
// updated.
Handle UpdateFaviconMappingAndFetch(const GURL& page_url,
const GURL& icon_url,
history::IconType icon_type,
CancelableRequestConsumerBase* consumer,
const FaviconDataCallback& callback);
// Requests any |icon_types| of favicon for a web page URL. |consumer| is
// notified when the bits have been fetched. |icon_types| can be any
// combination of IconType value, but only one icon will be returned in the
// priority of TOUCH_PRECOMPOSED_ICON, TOUCH_ICON and FAVICON.
//
// Note: this version is intended to be used to retrieve the favicon of a
// page that has been browsed in the past. |expired| in the callback is
// always false.
Handle GetFaviconForURL(Profile* profile,
const GURL& page_url,
int icon_types,
CancelableRequestConsumerBase* consumer,
const FaviconDataCallback& callback);
// Requests the favicon for |favicon_id|. The |consumer| is notified when the
// bits have been fetched.
Handle GetFaviconForID(history::FaviconID favicon_id,
CancelableRequestConsumerBase* consumer,
const FaviconDataCallback& callback);
// Marks all types of favicon for the page as being out of date.
void SetFaviconOutOfDateForPage(const GURL& page_url);
// Clones all icons from an existing page. This associates the icons from
// |old_page_url| with |new_page_url|, provided |new_page_url| has no
// recorded associations to any other icons.
// Needed if you want to declare favicons (tentatively) in advance, before a
// page is ever visited.
void CloneFavicon(const GURL& old_page_url, const GURL& new_page_url);
// Allows the importer to set many favicons for many pages at once. The pages
// must exist, any favicon sets for unknown pages will be discarded. Existing
// favicons will not be overwritten.
void SetImportedFavicons(
const std::vector<history::ImportedFaviconUsage>& favicon_usage);
// Sets the favicon for a page.
void SetFavicon(const GURL& page_url,
const GURL& icon_url,
const std::vector<unsigned char>& image_data,
history::IconType icon_type);
private:
HistoryService* history_service_;
// Helper to forward an empty result if we cannot get the history service.
void ForwardEmptyResultAsync(GetFaviconRequest* request);
DISALLOW_COPY_AND_ASSIGN(FaviconService);
};
#endif // CHROME_BROWSER_FAVICON_FAVICON_SERVICE_H_
|
