summaryrefslogtreecommitdiff
path: root/chromium/components/favicon/core/favicon_driver_impl.h
blob: 7d33c3ef936cd5ef71c3cee4a1b2e21f6befe92f (plain)
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
// Copyright 2015 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 COMPONENTS_FAVICON_CORE_FAVICON_DRIVER_IMPL_H_
#define COMPONENTS_FAVICON_CORE_FAVICON_DRIVER_IMPL_H_

#include <memory>
#include <vector>

#include "base/macros.h"
#include "components/favicon/core/favicon_driver.h"
#include "components/favicon/core/favicon_handler.h"

class GURL;
namespace bookmarks {
class BookmarkModel;
}


namespace history {
class HistoryService;
}

namespace favicon {

class FaviconService;
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:
  // FaviconDriver implementation.
  void FetchFavicon(const GURL& url) override;

  // FaviconHandler::Delegate implementation.
  bool IsBookmarked(const GURL& url) override;

  // Returns whether the driver is waiting for a download to complete or for
  // data from the FaviconService. Reserved for testing.
  bool HasPendingTasksForTest();

 protected:
  FaviconDriverImpl(FaviconService* favicon_service,
                    history::HistoryService* history_service,
                    bookmarks::BookmarkModel* bookmark_model);
  ~FaviconDriverImpl() override;

  // Returns whether downloading favicon for |url| previously failed.
  bool WasUnableToDownloadFavicon(const GURL& url);

  // Informs FaviconService 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 OnUpdateFaviconURL(const GURL& page_url,
                          const std::vector<FaviconURL>& candidates);

 protected:
  history::HistoryService* history_service() { return history_service_; }

  FaviconService* favicon_service() { return favicon_service_; }

 private:
  // KeyedServices used by FaviconDriverImpl. They may be null during testing,
  // but if they are defined, they must outlive the FaviconDriverImpl.
  FaviconService* favicon_service_;
  history::HistoryService* history_service_;
  bookmarks::BookmarkModel* bookmark_model_;

  // FaviconHandlers used to download the different kind of favicons.
  // |touch_icon_handler_| may be null depending on the platform and variations.
  std::unique_ptr<FaviconHandler> favicon_handler_;
  std::unique_ptr<FaviconHandler> touch_icon_handler_;

  DISALLOW_COPY_AND_ASSIGN(FaviconDriverImpl);
};

}  // namespace favicon

#endif  // COMPONENTS_FAVICON_CORE_FAVICON_DRIVER_IMPL_H_