diff options
Diffstat (limited to 'mirrorselect/connections.py')
| -rw-r--r-- | mirrorselect/connections.py | 182 |
1 files changed, 182 insertions, 0 deletions
diff --git a/mirrorselect/connections.py b/mirrorselect/connections.py new file mode 100644 index 0000000..ca4aa88 --- /dev/null +++ b/mirrorselect/connections.py @@ -0,0 +1,182 @@ +#-*- coding:utf-8 -*- + +"""Mirrorselect 2.x + Tool for selecting Gentoo source and rsync mirrors. + +Copyright 2005-2012 Gentoo Foundation + + Copyright (C) 2005 Colin Kingsley <tercel@gentoo.org> + Copyright (C) 2008 Zac Medico <zmedico@gentoo.org> + Copyright (C) 2009 Sebastian Pipping <sebastian@pipping.org> + Copyright (C) 2009 Christian Ruppert <idl0r@gentoo.org> + Copyright (C) 2012 Brian Dolbec <dolsen@gentoo.org> + +Distributed under the terms of the GNU General Public License v2 + 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 St, Fifth Floor, Boston, MA 02110-1301, USA. + +""" + +import sys +import os + +VERIFY_SSL = False +VERIFY_MSGS = [] + +import requests +from requests.exceptions import SSLError + +# py3.2 +if sys.hexversion >= 0x30200f0: + VERIFY_SSL = True +else: + try: # import and enable SNI support for py2 + from requests.packages.urllib3.contrib import pyopenssl + pyopenssl.inject_into_urllib3() + VERIFY_SSL = True + VERIFY_MSGS = ["Successfully enabled ssl certificate verification."] + except ImportError as e: + VERIFY_MSGS = [ + "Failed to import and inject pyopenssl/SNI support into urllib3", + "Disabling certificate verification", + "Error was:" + e + ] + VERIFY_SSL = False + + +from mirrorselect.version import version + + +class Connector(object): + """Primary connection interface using the dev-python/requests package + """ + + def __init__(self, output, proxies): + self.output = output + self.proxies = proxies + self.headers = {'Accept-Charset': 'utf-8', + 'User-Agent': 'Mirrorselect-' + version} + + if VERIFY_MSGS: + for msg in VERIFY_MSGS: + self.output.write(msg + '\n', 2) + + + def add_timestamp(self, headers, tpath=None, timestamp=None): + """for possilble future caching of the list""" + if tpath and os.path.exists(tpath): + # fileopen is a layman comaptibility function not yet implemented here + with fileopen(tpath,'r') as previous: + timestamp = previous.read() + if timestamp: + headers['If-Modified-Since'] = timestamp + self.output.write('Current-modified: %s\n' % timestamp, 2) + return headers + + + def fetch_url(self, url, headers=None, timestamp=None): + """Fetches the url + + @param url: string + @param headers: dictionary, optional headers to use + @param tpath: string, optional filepath to a timestamp file + to use in the headers + @param timestamp: string, optional timestamp to use in the headers + + """ + + if not headers: + headers = self.headers + + if timestamp: + self.add_timestamp(headers, timestamp=timestamp) + + verify = 'https' in url and VERIFY_SSL + self.output.write("Enabled ssl certificate verification: %s, for: %s\n" + %(str(verify), url), 3) + + self.output.write('Connector.fetch_url(); headers = %s\n' %str(headers), 4) + self.output.write('Connector.fetch_url(); connecting to opener\n', 2) + + try: + connection = requests.get( + url, + headers=headers, + verify=verify, + proxies=self.proxies, + ) + except SSLError as error: + self.output.print_err('Connector.fetch_url(); Failed to update the ' + 'mirror list from: %s\nSSLError was:%s\n' + % (url, str(error))) + except Exception as error: + self.output.print_err('Connector.fetch_url(); Failed to retrieve ' + 'the content from: %s\nError was: %s\n' + % (url, str(error))) + + self.output.write('Connector.fetch_url() HEADERS = %s\n' %str(connection.headers), 4) + self.output.write('Connector.fetch_url() Status_code = %i\n' % connection.status_code, 2) + return connection + + + @staticmethod + def normalize_headers(headers, to_lower=True): + """ py2, py3 compatibility function, since only py2 returns keys as lower() + """ + if to_lower: + return dict((x.lower(), x) for x in list(headers)) + return dict((x.upper(), x) for x in list(headers)) + + + def fetch_content(self, url, tpath=None): + """Fetch the mirror list + + @param url: string of the content to fetch + @param headers: dictionary, optional headers to use + @param tpath: string, optional filepath to a timestamp file + to use in the headers + @returns (success bool, content fetched , timestamp of fetched content, + content headers returned) + """ + + fheaders = self.headers + + if tpath: + fheaders = self.add_timestamp(fheaders, tpath) + + connection = self.fetch_url(url, fheaders) + + headers = self.normalize_headers(connection.headers) + + if 'last-modified' in headers: + timestamp = headers['last-modified'] + elif 'date' in headers: + timestamp = headers['date'] + else: + timestamp = None + + if connection.status_code in [304]: + self.output.write('Content already up to date: %s\n' + % url, 4) + self.output.write('Last-modified: %s\n' % timestamp, 4) + elif connection.status_code not in [200]: + self.output.print_err('Connector.fetch_content(); HTTP Status-Code was:\n' + 'url: %s\n%s' + % (url, str(connection.status_code))) + + if connection.status_code in [200]: + self.output.write('New content downloaded for: %s\n' + % url, 4) + return (True, connection.content, timestamp) + return (False, '', '') + |