summaryrefslogtreecommitdiff
path: root/pgweb/util/misc.py
blob: 2698031e247e92129ab1162863c59d88bf8cda9e (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
from django.db import connection
from django.conf import settings

from Cryptodome.Hash import SHA256
from Cryptodome import Random

from pgweb.mailqueue.util import send_simple_mail
from pgweb.util.helpers import template_to_string
import re


def send_template_mail(sender, receiver, subject, templatename, templateattr={}, usergenerated=False, cc=None, replyto=None, receivername=None, sendername=None, messageid=None, suppress_auto_replies=True, is_auto_reply=False):
    d = {
        'link_root': settings.SITE_ROOT,
    }
    d.update(templateattr)
    send_simple_mail(
        sender, receiver, subject,
        template_to_string(templatename, d),
        usergenerated=usergenerated, cc=cc, replyto=replyto,
        receivername=receivername, sendername=sendername,
        messageid=messageid,
        suppress_auto_replies=suppress_auto_replies,
        is_auto_reply=is_auto_reply,
    )


def get_client_ip(request):
    """
    Get the IP of the client. If the client is served through our Varnish caches,
    or behind one of our SSL proxies, make sure to get the *actual* client IP,
    and not the IP of the cache/proxy.
    """
    if 'HTTP_X_FORWARDED_FOR' in request.META:
        # There is a x-forwarded-for header, so trust it but only if the actual connection
        # is coming in from one of our frontends.
        if request.META['REMOTE_ADDR'] in settings.FRONTEND_SERVERS:
            return request.META['HTTP_X_FORWARDED_FOR']

    # Else fall back and return the actual IP of the connection
    return request.META['REMOTE_ADDR']


def varnish_purge_xkey(xkey):
    """
    Purge the specified xkey from Varnish.
    """
    connection.cursor().execute("SELECT varnish_purge_xkey(%s)", (xkey, ))


def varnish_purge(url):
    """
    Purge the specified URL from Varnish. Will add initial anchor to the URL,
    but no trailing one, so by default a wildcard match is done.
    """
    url = '^%s' % url
    connection.cursor().execute("SELECT varnish_purge(%s)", (url, ))


def varnish_purge_expr(expr):
    """
    Purge the specified expression from Varnish. Does not modify the expression
    at all, so be very careful!
    """
    connection.cursor().execute("SELECT varnish_purge_expr(%s)", (expr, ))


def version_sort(l):
    """
    map a directory name to a format that will show up sensibly in an ascii sort
    We specifically detect entries that look like versions. Weird things may happen
    if there is a mix of versions and non-versions in the same directory, but we
    generally don't have that.
    """
    mkey = l['link']
    m = re.match(r'v?([0-9]+)\.([0-9]+)\.([0-9]+)$', l['url'])
    if m:
        mkey = m.group(1) + '%02d' % int(m.group(2)) + '%02d' % int(m.group(3))
    m = re.match(r'v?([0-9]+)\.([0-9]+)$', l['url'])
    if m:
        mkey = m.group(1) + '%02d' % int(m.group(2))
        # SOOO ugly. But if it's v10 and up, just prefix it to get it higher
        if int(m.group(1)) >= 10:
            mkey = 'a' + mkey
    m = re.match('v?([0-9]+)$', l['url'])
    if m:
        # This can only happen on 10+, so...
        mkey = 'a' + m.group(1) + '0'

    return mkey


def generate_random_token():
    """
    Generate a random token of 64 characters. This token will be
    generated using a strong random number, and then hex encoded to make
    sure all characters are safe to put in emails and URLs.
    """
    s = SHA256.new()
    r = Random.new()
    s.update(r.read(250))
    return s.hexdigest()