aboutsummaryrefslogtreecommitdiff
blob: ca4aa88ac91e8a2bf5e6363871326a4c46f0977e (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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
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, '', '')