summaryrefslogtreecommitdiffstats
path: root/src/core/favicon_manager.h
blob: f9758d0f0658b7432efb52c52c7baefaec5694d5 (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
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
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtWebEngine module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/

//
//  W A R N I N G
//  -------------
//
// This file is not part of the Qt API.  It exists purely as an
// implementation detail.  This header file may change from version to
// version without notice, or even be removed.
//
// We mean it.
//

#ifndef FAVICON_MANAGER_H
#define FAVICON_MANAGER_H

#include "qtwebenginecoreglobal_p.h"
#include <memory>
#include <QtCore/QMap>
#include <QtCore/QObject>
#include <QtCore/QSize>
#include <QtCore/QUrl>
#include <QtGui/QIcon>

#include "web_engine_settings.h"

class GURL;
class SkBitmap;

namespace gfx {
class Size;
}

namespace content {
class WebContents;
}

namespace base {
template<class T>
class WeakPtrFactory;
}

namespace QtWebEngineCore {

class WebContentsAdapterClient;

// Based on src/3rdparty/chromium/content/public/common/favicon_url.h
class QWEBENGINECORE_PRIVATE_EXPORT FaviconInfo {
public:
    enum FaviconType {
        InvalidIcon,
        Favicon,
        TouchIcon,
        TouchPrecomposedIcon
    };

    FaviconInfo();
    FaviconInfo(const FaviconInfo &);
    FaviconInfo(const QUrl &, FaviconInfo::FaviconType);
    ~FaviconInfo();

    bool isValid() const;
    bool isDownloaded() const;

    QUrl url;
    FaviconType type;
    // Stores the largest size in case of multi-size icon
    QSize size;
    bool candidate;
    bool multiSize;
};


class QWEBENGINECORE_PRIVATE_EXPORT FaviconManager {

public:
    FaviconManager(content::WebContents *, WebContentsAdapterClient *);
    ~FaviconManager();

    QIcon getIcon(const QUrl &url = QUrl()) const;
    FaviconInfo getFaviconInfo(const QUrl &) const;
    QList<FaviconInfo> getFaviconInfoList(bool) const;

private:
    void update(const QList<FaviconInfo> &);
    void updateCandidates(const QList<FaviconInfo> &);
    void resetCandidates();
    bool hasCandidate() const;
    QUrl candidateIconUrl(bool touchIconsEnabled) const;
    void generateCandidateIcon(bool touchIconsEnabled);
    int downloadIcon(const QUrl &);
    void iconDownloadFinished(int, int, const GURL &, const std::vector<SkBitmap> &, const std::vector<gfx::Size> &);
    void storeIcon(int, const QIcon &);
    void downloadPendingRequests();
    void propagateIcon(const QUrl &) const;

private:
    content::WebContents *m_webContents;
    WebContentsAdapterClient *m_viewClient;
    QMap<QUrl, FaviconInfo> m_faviconInfoMap;
    int m_candidateCount;
    QIcon m_candidateIcon;
    QMap<QUrl, QIcon> m_icons;
    QMap<int, QUrl> m_inProgressRequests;
    QMap<int, QUrl> m_pendingRequests;
    std::unique_ptr<base::WeakPtrFactory<FaviconManager>> m_weakFactory;
    friend class WebContentsDelegateQt;
};

} // namespace QtWebEngineCore

#endif // FAVICON_MANAGER_H