class HTTP(gobject.GObject):
"""HTTP protocol client class."""
__gsignals__ = {
"error" : (gobject.SIGNAL_RUN_FIRST,
gobject.TYPE_NONE,
(gobject.TYPE_ULONG,)),
"response-received": (gobject.SIGNAL_RUN_FIRST,
gobject.TYPE_NONE,
(object,)), # HTTPResponse
"request-sent": (gobject.SIGNAL_RUN_FIRST,
gobject.TYPE_NONE,
(object,)), # HTTPRequest
}
def __init__(self, host, port=80, proxy=None):
"""Connection initialization
@param host: the host to connect to.
@type host: string
@param port: the port number to connect to
@type port: integer
@param proxy: proxy that we can use to connect
@type proxy: L{gnet.proxy.ProxyInfos}"""
gobject.GObject.__init__(self)
assert(proxy is None or proxy.type == 'http') # TODO: add support for other proxies (socks4 and 5)
self._host = host
self._port = port
self.__proxy = proxy
self._transport = None
self._http_parser = None
self._outgoing_queue = []
self._waiting_response = False
def _setup_transport(self):
if self._transport is None:
if self.__proxy is not None:
self._transport = TCPClient(self.__proxy.host, self.__proxy.port)
else:
self._transport = TCPClient(self._host, self._port)
self._http_parser = HTTPParser(self._transport)
self._http_parser.connect("received", self._on_response_received)
self._transport.connect("notify::status", self._on_status_change)
self._transport.connect("error", self._on_error)
self._transport.connect("sent", self._on_request_sent)
if self._transport.get_property("status") != IoStatus.OPEN:
self._transport.open()
def _on_status_change(self, transport, param):
if transport.get_property("status") == IoStatus.OPEN:
self._process_queue()
elif transport.get_property("status") == IoStatus.CLOSED and\
(self._waiting_response or len(self._outgoing_queue) > 0):
self._waiting_response = False
self._setup_transport()
def _on_request_sent(self, transport, request, length):
assert(str(self._outgoing_queue[0]) == request)
self._waiting_response = True
self.emit("request-sent", self._outgoing_queue[0])
def _on_response_received(self, parser, response):
if response.status >= 100 and response.status < 200:
return
#if response.status in (301, 302): # UNTESTED: please test
# location = response.headers['Location']
# location = location.rsplit("://", 1)
# if len(location) == 2:
# scheme = location[0]
# location = location[1]
# if scheme == "http":
# location = location.rsplit(":", 1)
# self._host = location[0]
# if len(location) == 2:
# self._port = int(location[1])
# self._outgoing_queue[0].headers['Host'] = response.headers['Location']
# self._setup_transport()
# return
self._outgoing_queue.pop(0) # pop the request from the queue
self.emit("response-received", response)
self._waiting_response = False
self._process_queue() # next request ?
def _on_error(self, transport, error):
self.emit("error", error)
def _process_queue(self):
if len(self._outgoing_queue) == 0 or \
self._waiting_response: # no pipelining
return
if self._transport is None or \
self._transport.get_property("status") != IoStatus.OPEN:
self._setup_transport()
return
self._transport.send(str(self._outgoing_queue[0]))
def request(self, resource='/', headers=None, data='', method='GET'):
if headers is None:
headers = {}
headers['Host'] = self._host + ':' + str(self._port)
headers['Content-Length'] = str(len(data))
if 'User-Agent' not in headers:
user_agent = GNet.NAME, GNet.VERSION, platform.system(), platform.machine()
headers['User-Agent'] = "%s/%s (%s %s)" % user_agent
if self.__proxy is not None:
url = 'http://%s:%d%s' % (self._host, self._port, resource)
if self.__proxy.user:
auth = self.__proxy.user + ':' + self.__proxy.password
credentials = base64.encodestring(auth).strip()
headers['Proxy-Authorization'] = 'Basic ' + credentials
else:
url = resource
request = HTTPRequest(headers, data, method, url)
self._outgoing_queue.append(request)
self._process_queue()
class HTTPConnectProxy(AbstractProxy):
def __init__(self, client, proxy_infos):
assert(proxy_infos.type in ('http', 'https')), "HTTPConnectProxy expects an http(s) proxy description"
assert(client.domain == AF_INET), "HTTP CONNECT only handles INET address family"
assert(client.type == SOCK_STREAM), "HTTP CONNECT only handles SOCK_STREAM"
assert(client.status == IoStatus.CLOSED), "HTTPConnectProxy expects a closed client"
AbstractProxy.__init__(self, client, proxy_infos)
self._transport = TCPClient(self._proxy.host, self._proxy.port)
self._transport.connect("notify::status", self._on_transport_status)
self._transport.connect("error", self._on_transport_error)
self._http_parser = HTTPParser(self._transport)
self._http_parser.connect("received", self._on_proxy_response)
# opening state methods
def _pre_open(self, io_object=None):
AbstractProxy._pre_open(self)
def _post_open(self):
AbstractProxy._post_open(self)
host = self._client.get_property("host")
port = self._client.get_property("port")
proxy_protocol = 'CONNECT %s:%s HTTP/1.1\r\n' % (host, port)
proxy_protocol += 'Proxy-Connection: Keep-Alive\r\n'
proxy_protocol += 'Pragma: no-cache\r\n'
proxy_protocol += 'User-Agent: %s/%s\r\n' % (GNet.NAME, GNet.VERSION)
if self._proxy.user:
auth = base64.encodestring(self._proxy.user + ':' + self._proxy.password).strip()
proxy_protocol += 'Proxy-authorization: Basic ' + auth + '\r\n'
proxy_protocol += '\r\n'
self._transport.send(proxy_protocol)
# public API
def open(self):
"""Open the connection."""
if not self._configure():
return
self._pre_open()
try:
self._transport.open()
except:
pass
def close(self):
"""Close the connection."""
self._client._proxy_closed()
def send(self, buffer, callback=None, *args):
self._client.send(buffer, callback, *args)
# callbacks and signal handlers
def _on_transport_status(self, transport, param):
if transport.status == IoStatus.OPEN:
self._post_open()
elif transport.status == IoStatus.OPENING:
self._client._proxy_opening(self._transport._transport)
self._status = transport.status
else:
self._status = transport.status
def _on_transport_error(self, transport, error_code):
if error_code == IoError.CONNECTION_FAILED:
error_code = IoError.PROXY_CONNECTION_FAILED
self.close()
self.emit("error", error_code)
def _on_proxy_response(self, parser, response):
if self.status == IoStatus.OPENING:
if response.status == 200:
del self._http_parser
self._transport._watch_remove() # HACK: ok this is ugly !
self._client._proxy_open()
elif response.status == 100:
return True
elif response.status == 407:
self.close()
self.emit("error", IoError.PROXY_AUTHENTICATION_REQUIRED)
else:
raise NotImplementedError("Unknown Proxy response code")
return False
class SOCKS4Proxy(AbstractProxy):
PROTOCOL_VERSION = 4
CONNECT_COMMAND = 1
"""Proxy class used to communicate with SOCKS4 proxies."""
def __init__(self, client, proxy_infos):
assert(proxy_infos.type == 'socks4'), \
"SOCKS4Proxy expects a socks4 proxy description"
# TODO : implement version 4a of the protocol to allow proxy-side name resolution
assert(client.domain == AF_INET), \
"SOCKS4 CONNECT only handles INET address family"
assert(client.type == SOCK_STREAM), \
"SOCKS4 CONNECT only handles SOCK_STREAM"
assert(client.status == IoStatus.CLOSED), \
"SOCKS4Proxy expects a closed client"
AbstractProxy.__init__(self, client, proxy_infos)
self._transport = TCPClient(self._proxy.host, self._proxy.port)
self._transport.connect("notify::status", self._on_transport_status)
self._transport.connect("error", self._on_transport_error)
self._delimiter_parser = DelimiterParser(self._transport)
self._delimiter_parser.delimiter = 8
self._delimiter_parser.connect("received", self._on_proxy_response)
# Opening state methods
def _pre_open(self, io_object=None):
AbstractProxy._pre_open(self)
def _post_open(self):
AbstractProxy._post_open(self)
host = self._client.get_property("host")
port = self._client.get_property("port")
user = self._proxy.user
proxy_protocol = struct.pack('!BBH', SOCKS4Proxy.PROTOCOL_VERSION,
SOCKS4Proxy.CONNECT_COMMAND, port)
for part in host.split('.'):
proxy_protocol += struct.pack('B', int(part))
proxy_protocol += user
proxy_protocol += struct.pack('B', 0)
self._transport.send(proxy_protocol)
# Public API
def open(self):
"""Open the connection."""
if not self._configure():
return
self._pre_open()
try:
self._transport.open()
except:
pass
def close(self):
"""Close the connection."""
self._client._proxy_closed()
def send(self, buffer, callback=None, *args):
self._client.send(buffer, callback, *args)
# Callbacks
def _on_transport_status(self, transport, param):
if transport.status == IoStatus.OPEN:
self._post_open()
elif transport.status == IoStatus.OPENING:
self._client._proxy_opening(self._transport._transport)
self._status = transport.status
else:
self._status = transport.status
def _on_transport_error(self, transport, error_code):
if error_code == IoError.CONNECTION_FAILED:
error_code = IoError.PROXY_CONNECTION_FAILED
self.close()
self.emit("error", error_code)
def _on_proxy_response(self, parser, response):
version, response_code = struct.unpack('BB', response[0:2])
assert(version == 0)
if self.status == IoStatus.OPENING:
if response_code == 90:
del self._delimiter_parser
self._transport._watch_remove() # HACK: ok this is ugly !
self._client._proxy_open()
elif response_code == 91:
self.close()
self.emit("error", IoError.PROXY_CONNECTION_FAILED)
elif response_code == 92:
self.close()
self.emit("error", IoError.PROXY_AUTHENTICATION_REQUIRED)
elif response_code == 93:
self.close()
self.emit("error", IoError.PROXY_AUTHENTICATION_REQUIRED)
else:
raise NotImplementedError("Unknow Proxy response code")
return False