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
|
// Copyright 2015 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef COMPONENTS_FAVICON_CORE_FAVICON_DRIVER_IMPL_H_
#define COMPONENTS_FAVICON_CORE_FAVICON_DRIVER_IMPL_H_
#include <memory>
#include <vector>
#include "base/memory/raw_ptr.h"
#include "components/favicon/core/favicon_driver.h"
#include "components/favicon/core/favicon_handler.h"
class GURL;
namespace favicon {
class CoreFaviconService;
struct FaviconURL;
// FaviconDriverImpl is a partial implementation of FaviconDriver that allow
// sharing implementation between different embedder.
//
// FaviconDriverImpl works with FaviconHandlers to fetch the favicons. It
// fetches the given page's icons, requesting them from history backend. If the
// icon is not available or expired, the icon will be downloaded and saved in
// the history backend.
class FaviconDriverImpl : public FaviconDriver,
public FaviconHandler::Delegate {
public:
FaviconDriverImpl(const FaviconDriverImpl&) = delete;
FaviconDriverImpl& operator=(const FaviconDriverImpl&) = delete;
// FaviconDriver implementation.
void FetchFavicon(const GURL& page_url, bool is_same_document) override;
// Returns whether the driver is waiting for a download to complete or for
// data from the CoreFaviconService. Reserved for testing.
bool HasPendingTasksForTest();
protected:
// `favicon_service` may be null, which means favicons are not saved.
explicit FaviconDriverImpl(CoreFaviconService* favicon_service);
~FaviconDriverImpl() override;
// Informs CoreFaviconService that the favicon for `url` is out of date. If
// `force_reload` is true, then discard information about favicon download
// failures.
void SetFaviconOutOfDateForPage(const GURL& url, bool force_reload);
// Broadcasts new favicon URL candidates to FaviconHandlers.
void OnUpdateCandidates(const GURL& page_url,
const std::vector<FaviconURL>& candidates,
const GURL& manifest_url);
CoreFaviconService* favicon_service() { return favicon_service_; }
private:
friend class FaviconDriverImplTestHelper;
// KeyedService used by FaviconDriverImpl. It may be null during testing,
// but if it is defined, it must outlive the FaviconDriverImpl.
raw_ptr<CoreFaviconService> favicon_service_;
// FaviconHandlers used to download the different kind of favicons.
std::vector<std::unique_ptr<FaviconHandler>> handlers_;
};
} // namespace favicon
#endif // COMPONENTS_FAVICON_CORE_FAVICON_DRIVER_IMPL_H_
|
