summaryrefslogtreecommitdiff
path: root/qutebrowser/browser/webengine/cookies.py
blob: 3a5a621cc5560dee3fe0ba9d6f2060bdfee3eae6 (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
# vim: ft=python fileencoding=utf-8 sts=4 sw=4 et:

# Copyright 2018-2021 Florian Bruhin (The Compiler) <mail@qutebrowser.org>
#
# This file is part of qutebrowser.
#
# qutebrowser is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# qutebrowser is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with qutebrowser.  If not, see <https://www.gnu.org/licenses/>.

"""Filter for QtWebEngine cookies."""

from qutebrowser.config import config
from qutebrowser.utils import utils, log
from qutebrowser.misc import objects


@utils.prevent_exceptions(False)  # Runs in I/O thread
def _accept_cookie(request):
    """Check whether the given cookie should be accepted."""
    url = request.firstPartyUrl
    if not url.isValid():
        url = None

    accept = config.instance.get('content.cookies.accept',
                                 url=url)

    if 'log-cookies' in objects.debug_flags:
        first_party_str = ("<unknown>" if not request.firstPartyUrl.isValid()
                           else request.firstPartyUrl.toDisplayString())
        origin_str = ("<unknown>" if not request.origin.isValid()
                      else request.origin.toDisplayString())
        log.network.debug('Cookie from origin {} on {} (third party: {}) '
                          '-> applying setting {}'
                          .format(origin_str, first_party_str, request.thirdParty,
                                  accept))

    if accept == 'all':
        return True
    elif accept in ['no-3rdparty', 'no-unknown-3rdparty']:
        return not request.thirdParty
    elif accept == 'never':
        return False
    else:
        raise utils.Unreachable


def install_filter(profile):
    """Install the cookie filter on the given profile."""
    profile.cookieStore().setCookieFilter(_accept_cookie)