summaryrefslogtreecommitdiff
path: root/lorrycontroller/proxy.py
blob: 53d0667b4bb399ea9f3a0125624c2610c9c45581 (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
# Copyright (C) 2014  Codethink Limited
#
# This program 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; version 2 of the License.
#
# This program 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 this program; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.


import json
import os
import urllib
import urllib2


def build_proxy_url(protocol, proxy_config):
    """Build a proxy URL from data in our proxy configuration format."""

    hostname = urllib.quote(proxy_config['hostname'])
    url = '%s:%s' % (hostname, proxy_config['port'])

    if 'username' not in proxy_config:
        return '%s://%s/' % (protocol, url)
    elif 'password' not in proxy_config:
        return '%s://%s@%s/' % (protocol, proxy_config['username'], url)
    else:
        return '%s://%s:%s@%s/' % (protocol, proxy_config['username'],
                                   proxy_config['password'], url)


def setup_proxy(config_filename):
    """Tell urllib2 to use a proxy for http action by lorry-controller.
    
    Load the proxy information from the JSON file given by proxy_def, then
    set urllib2's url opener to open urls via an authenticated proxy.
    
    """
    
    if not os.path.exists(config_filename):
        return
    
    with open(config_filename, 'r') as f:
        proxy_config = json.load(f)

    http_proxy_url = build_proxy_url('http', proxy_config)
    https_proxy_url = build_proxy_url('https', proxy_config)

    # set the required environment variables
    os.environ['http_proxy'] = http_proxy_url
    os.environ['https_proxy'] = https_proxy_url

    # create a ProxyHandler
    proxies = {'http_proxy': http_proxy_url,
               'https_proxy': https_proxy_url}
    proxy_handler = urllib2.ProxyHandler(proxies)
    
    # install an opener to use the proxy
    opener = urllib2.build_opener(proxy_handler)
    urllib2.install_opener(opener)