Libraries for Subliminal
This commit is contained in:
Ruud
@@ -0,0 +1,130 @@
|
||||
# This program is free software; you can redistribute it and/or modify
|
||||
# it under the terms of the (LGPL) GNU Lesser General Public License as
|
||||
# published by the Free Software Foundation; either version 3 of the
|
||||
# License, or (at your option) any later version.
|
||||
#
|
||||
# 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 Library Lesser General Public License for more details at
|
||||
# ( http://www.gnu.org/licenses/lgpl.html ).
|
||||
#
|
||||
# You should have received a copy of the GNU Lesser General Public License
|
||||
# along with this program; if not, write to the Free Software
|
||||
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
|
||||
# written by: Jeff Ortel ( jortel@redhat.com )
|
||||
|
||||
"""
|
||||
Contains transport interface (classes).
|
||||
"""
|
||||
|
||||
|
||||
class TransportError(Exception):
|
||||
def __init__(self, reason, httpcode, fp=None):
|
||||
Exception.__init__(self, reason)
|
||||
self.httpcode = httpcode
|
||||
self.fp = fp
|
||||
|
||||
class Request:
|
||||
"""
|
||||
A transport request
|
||||
@ivar url: The url for the request.
|
||||
@type url: str
|
||||
@ivar message: The message to be sent in a POST request.
|
||||
@type message: str
|
||||
@ivar headers: The http headers to be used for the request.
|
||||
@type headers: dict
|
||||
"""
|
||||
|
||||
def __init__(self, url, message=None):
|
||||
"""
|
||||
@param url: The url for the request.
|
||||
@type url: str
|
||||
@param message: The (optional) message to be send in the request.
|
||||
@type message: str
|
||||
"""
|
||||
self.url = url
|
||||
self.headers = {}
|
||||
self.message = message
|
||||
|
||||
def __str__(self):
|
||||
s = []
|
||||
s.append('URL:%s' % self.url)
|
||||
s.append('HEADERS: %s' % self.headers)
|
||||
s.append('MESSAGE:')
|
||||
s.append(self.message)
|
||||
return '\n'.join(s)
|
||||
|
||||
|
||||
class Reply:
|
||||
"""
|
||||
A transport reply
|
||||
@ivar code: The http code returned.
|
||||
@type code: int
|
||||
@ivar message: The message to be sent in a POST request.
|
||||
@type message: str
|
||||
@ivar headers: The http headers to be used for the request.
|
||||
@type headers: dict
|
||||
"""
|
||||
|
||||
def __init__(self, code, headers, message):
|
||||
"""
|
||||
@param code: The http code returned.
|
||||
@type code: int
|
||||
@param headers: The http returned headers.
|
||||
@type headers: dict
|
||||
@param message: The (optional) reply message received.
|
||||
@type message: str
|
||||
"""
|
||||
self.code = code
|
||||
self.headers = headers
|
||||
self.message = message
|
||||
|
||||
def __str__(self):
|
||||
s = []
|
||||
s.append('CODE: %s' % self.code)
|
||||
s.append('HEADERS: %s' % self.headers)
|
||||
s.append('MESSAGE:')
|
||||
s.append(self.message)
|
||||
return '\n'.join(s)
|
||||
|
||||
|
||||
class Transport:
|
||||
"""
|
||||
The transport I{interface}.
|
||||
"""
|
||||
|
||||
def __init__(self):
|
||||
"""
|
||||
Constructor.
|
||||
"""
|
||||
from suds.transport.options import Options
|
||||
self.options = Options()
|
||||
del Options
|
||||
|
||||
def open(self, request):
|
||||
"""
|
||||
Open the url in the specified request.
|
||||
@param request: A transport request.
|
||||
@type request: L{Request}
|
||||
@return: An input stream.
|
||||
@rtype: stream
|
||||
@raise TransportError: On all transport errors.
|
||||
"""
|
||||
raise Exception('not-implemented')
|
||||
|
||||
def send(self, request):
|
||||
"""
|
||||
Send soap message. Implementations are expected to handle:
|
||||
- proxies
|
||||
- I{http} headers
|
||||
- cookies
|
||||
- sending message
|
||||
- brokering exceptions into L{TransportError}
|
||||
@param request: A transport request.
|
||||
@type request: L{Request}
|
||||
@return: The reply
|
||||
@rtype: L{Reply}
|
||||
@raise TransportError: On all transport errors.
|
||||
"""
|
||||
raise Exception('not-implemented')
|
||||
@@ -0,0 +1,187 @@
|
||||
# This program is free software; you can redistribute it and/or modify
|
||||
# it under the terms of the (LGPL) GNU Lesser General Public License as
|
||||
# published by the Free Software Foundation; either version 3 of the
|
||||
# License, or (at your option) any later version.
|
||||
#
|
||||
# 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 Library Lesser General Public License for more details at
|
||||
# ( http://www.gnu.org/licenses/lgpl.html ).
|
||||
#
|
||||
# You should have received a copy of the GNU Lesser General Public License
|
||||
# along with this program; if not, write to the Free Software
|
||||
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
|
||||
# written by: Jeff Ortel ( jortel@redhat.com )
|
||||
|
||||
"""
|
||||
Contains classes for basic HTTP transport implementations.
|
||||
"""
|
||||
|
||||
import urllib2 as u2
|
||||
import base64
|
||||
import socket
|
||||
from suds.transport import *
|
||||
from suds.properties import Unskin
|
||||
from urlparse import urlparse
|
||||
from cookielib import CookieJar
|
||||
from logging import getLogger
|
||||
|
||||
log = getLogger(__name__)
|
||||
|
||||
|
||||
class HttpTransport(Transport):
|
||||
"""
|
||||
HTTP transport using urllib2. Provided basic http transport
|
||||
that provides for cookies, proxies but no authentication.
|
||||
"""
|
||||
|
||||
def __init__(self, **kwargs):
|
||||
"""
|
||||
@param kwargs: Keyword arguments.
|
||||
- B{proxy} - An http proxy to be specified on requests.
|
||||
The proxy is defined as {protocol:proxy,}
|
||||
- type: I{dict}
|
||||
- default: {}
|
||||
- B{timeout} - Set the url open timeout (seconds).
|
||||
- type: I{float}
|
||||
- default: 90
|
||||
"""
|
||||
Transport.__init__(self)
|
||||
Unskin(self.options).update(kwargs)
|
||||
self.cookiejar = CookieJar()
|
||||
self.proxy = {}
|
||||
self.urlopener = None
|
||||
|
||||
def open(self, request):
|
||||
try:
|
||||
url = request.url
|
||||
log.debug('opening (%s)', url)
|
||||
u2request = u2.Request(url)
|
||||
self.proxy = self.options.proxy
|
||||
return self.u2open(u2request)
|
||||
except u2.HTTPError, e:
|
||||
raise TransportError(str(e), e.code, e.fp)
|
||||
|
||||
def send(self, request):
|
||||
result = None
|
||||
url = request.url
|
||||
msg = request.message
|
||||
headers = request.headers
|
||||
try:
|
||||
u2request = u2.Request(url, msg, headers)
|
||||
self.addcookies(u2request)
|
||||
self.proxy = self.options.proxy
|
||||
request.headers.update(u2request.headers)
|
||||
log.debug('sending:\n%s', request)
|
||||
fp = self.u2open(u2request)
|
||||
self.getcookies(fp, u2request)
|
||||
result = Reply(200, fp.headers.dict, fp.read())
|
||||
log.debug('received:\n%s', result)
|
||||
except u2.HTTPError, e:
|
||||
if e.code in (202,204):
|
||||
result = None
|
||||
else:
|
||||
raise TransportError(e.msg, e.code, e.fp)
|
||||
return result
|
||||
|
||||
def addcookies(self, u2request):
|
||||
"""
|
||||
Add cookies in the cookiejar to the request.
|
||||
@param u2request: A urllib2 request.
|
||||
@rtype: u2request: urllib2.Requet.
|
||||
"""
|
||||
self.cookiejar.add_cookie_header(u2request)
|
||||
|
||||
def getcookies(self, fp, u2request):
|
||||
"""
|
||||
Add cookies in the request to the cookiejar.
|
||||
@param u2request: A urllib2 request.
|
||||
@rtype: u2request: urllib2.Requet.
|
||||
"""
|
||||
self.cookiejar.extract_cookies(fp, u2request)
|
||||
|
||||
def u2open(self, u2request):
|
||||
"""
|
||||
Open a connection.
|
||||
@param u2request: A urllib2 request.
|
||||
@type u2request: urllib2.Requet.
|
||||
@return: The opened file-like urllib2 object.
|
||||
@rtype: fp
|
||||
"""
|
||||
tm = self.options.timeout
|
||||
url = self.u2opener()
|
||||
if self.u2ver() < 2.6:
|
||||
socket.setdefaulttimeout(tm)
|
||||
return url.open(u2request)
|
||||
else:
|
||||
return url.open(u2request, timeout=tm)
|
||||
|
||||
def u2opener(self):
|
||||
"""
|
||||
Create a urllib opener.
|
||||
@return: An opener.
|
||||
@rtype: I{OpenerDirector}
|
||||
"""
|
||||
if self.urlopener is None:
|
||||
return u2.build_opener(*self.u2handlers())
|
||||
else:
|
||||
return self.urlopener
|
||||
|
||||
def u2handlers(self):
|
||||
"""
|
||||
Get a collection of urllib handlers.
|
||||
@return: A list of handlers to be installed in the opener.
|
||||
@rtype: [Handler,...]
|
||||
"""
|
||||
handlers = []
|
||||
handlers.append(u2.ProxyHandler(self.proxy))
|
||||
return handlers
|
||||
|
||||
def u2ver(self):
|
||||
"""
|
||||
Get the major/minor version of the urllib2 lib.
|
||||
@return: The urllib2 version.
|
||||
@rtype: float
|
||||
"""
|
||||
try:
|
||||
part = u2.__version__.split('.', 1)
|
||||
n = float('.'.join(part))
|
||||
return n
|
||||
except Exception, e:
|
||||
log.exception(e)
|
||||
return 0
|
||||
|
||||
def __deepcopy__(self, memo={}):
|
||||
clone = self.__class__()
|
||||
p = Unskin(self.options)
|
||||
cp = Unskin(clone.options)
|
||||
cp.update(p)
|
||||
return clone
|
||||
|
||||
|
||||
class HttpAuthenticated(HttpTransport):
|
||||
"""
|
||||
Provides basic http authentication for servers that don't follow
|
||||
the specified challenge / response model. This implementation
|
||||
appends the I{Authorization} http header with base64 encoded
|
||||
credentials on every http request.
|
||||
"""
|
||||
|
||||
def open(self, request):
|
||||
self.addcredentials(request)
|
||||
return HttpTransport.open(self, request)
|
||||
|
||||
def send(self, request):
|
||||
self.addcredentials(request)
|
||||
return HttpTransport.send(self, request)
|
||||
|
||||
def addcredentials(self, request):
|
||||
credentials = self.credentials()
|
||||
if not (None in credentials):
|
||||
encoded = base64.encodestring(':'.join(credentials))
|
||||
basic = 'Basic %s' % encoded[:-1]
|
||||
request.headers['Authorization'] = basic
|
||||
|
||||
def credentials(self):
|
||||
return (self.options.username, self.options.password)
|
||||
@@ -0,0 +1,98 @@
|
||||
# This program is free software; you can redistribute it and/or modify
|
||||
# it under the terms of the (LGPL) GNU Lesser General Public License as
|
||||
# published by the Free Software Foundation; either version 3 of the
|
||||
# License, or (at your option) any later version.
|
||||
#
|
||||
# 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 Library Lesser General Public License for more details at
|
||||
# ( http://www.gnu.org/licenses/lgpl.html ).
|
||||
#
|
||||
# You should have received a copy of the GNU Lesser General Public License
|
||||
# along with this program; if not, write to the Free Software
|
||||
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
|
||||
# written by: Jeff Ortel ( jortel@redhat.com )
|
||||
|
||||
"""
|
||||
Contains classes for basic HTTP (authenticated) transport implementations.
|
||||
"""
|
||||
|
||||
import urllib2 as u2
|
||||
from suds.transport import *
|
||||
from suds.transport.http import HttpTransport
|
||||
from logging import getLogger
|
||||
|
||||
log = getLogger(__name__)
|
||||
|
||||
|
||||
class HttpAuthenticated(HttpTransport):
|
||||
"""
|
||||
Provides basic http authentication that follows the RFC-2617 specification.
|
||||
As defined by specifications, credentials are provided to the server
|
||||
upon request (HTTP/1.0 401 Authorization Required) by the server only.
|
||||
@ivar pm: The password manager.
|
||||
@ivar handler: The authentication handler.
|
||||
"""
|
||||
|
||||
def __init__(self, **kwargs):
|
||||
"""
|
||||
@param kwargs: Keyword arguments.
|
||||
- B{proxy} - An http proxy to be specified on requests.
|
||||
The proxy is defined as {protocol:proxy,}
|
||||
- type: I{dict}
|
||||
- default: {}
|
||||
- B{timeout} - Set the url open timeout (seconds).
|
||||
- type: I{float}
|
||||
- default: 90
|
||||
- B{username} - The username used for http authentication.
|
||||
- type: I{str}
|
||||
- default: None
|
||||
- B{password} - The password used for http authentication.
|
||||
- type: I{str}
|
||||
- default: None
|
||||
"""
|
||||
HttpTransport.__init__(self, **kwargs)
|
||||
self.pm = u2.HTTPPasswordMgrWithDefaultRealm()
|
||||
|
||||
def open(self, request):
|
||||
self.addcredentials(request)
|
||||
return HttpTransport.open(self, request)
|
||||
|
||||
def send(self, request):
|
||||
self.addcredentials(request)
|
||||
return HttpTransport.send(self, request)
|
||||
|
||||
def addcredentials(self, request):
|
||||
credentials = self.credentials()
|
||||
if not (None in credentials):
|
||||
u = credentials[0]
|
||||
p = credentials[1]
|
||||
self.pm.add_password(None, request.url, u, p)
|
||||
|
||||
def credentials(self):
|
||||
return (self.options.username, self.options.password)
|
||||
|
||||
def u2handlers(self):
|
||||
handlers = HttpTransport.u2handlers(self)
|
||||
handlers.append(u2.HTTPBasicAuthHandler(self.pm))
|
||||
return handlers
|
||||
|
||||
|
||||
class WindowsHttpAuthenticated(HttpAuthenticated):
|
||||
"""
|
||||
Provides Windows (NTLM) http authentication.
|
||||
@ivar pm: The password manager.
|
||||
@ivar handler: The authentication handler.
|
||||
@author: Christopher Bess
|
||||
"""
|
||||
|
||||
def u2handlers(self):
|
||||
# try to import ntlm support
|
||||
try:
|
||||
from ntlm import HTTPNtlmAuthHandler
|
||||
except ImportError:
|
||||
raise Exception("Cannot import python-ntlm module")
|
||||
handlers = HttpTransport.u2handlers(self)
|
||||
handlers.append(HTTPNtlmAuthHandler.HTTPNtlmAuthHandler(self.pm))
|
||||
return handlers
|
||||
@@ -0,0 +1,57 @@
|
||||
# This program is free software; you can redistribute it and/or modify
|
||||
# it under the terms of the (LGPL) GNU Lesser General Public License as
|
||||
# published by the Free Software Foundation; either version 3 of the
|
||||
# License, or (at your option) any later version.
|
||||
#
|
||||
# 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 Library Lesser General Public License for more details at
|
||||
# ( http://www.gnu.org/licenses/lgpl.html ).
|
||||
#
|
||||
# You should have received a copy of the GNU Lesser General Public License
|
||||
# along with this program; if not, write to the Free Software
|
||||
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
|
||||
# written by: Jeff Ortel ( jortel@redhat.com )
|
||||
|
||||
"""
|
||||
Contains classes for transport options.
|
||||
"""
|
||||
|
||||
|
||||
from suds.transport import *
|
||||
from suds.properties import *
|
||||
|
||||
|
||||
class Options(Skin):
|
||||
"""
|
||||
Options:
|
||||
- B{proxy} - An http proxy to be specified on requests.
|
||||
The proxy is defined as {protocol:proxy,}
|
||||
- type: I{dict}
|
||||
- default: {}
|
||||
- B{timeout} - Set the url open timeout (seconds).
|
||||
- type: I{float}
|
||||
- default: 90
|
||||
- B{headers} - Extra HTTP headers.
|
||||
- type: I{dict}
|
||||
- I{str} B{http} - The I{http} protocol proxy URL.
|
||||
- I{str} B{https} - The I{https} protocol proxy URL.
|
||||
- default: {}
|
||||
- B{username} - The username used for http authentication.
|
||||
- type: I{str}
|
||||
- default: None
|
||||
- B{password} - The password used for http authentication.
|
||||
- type: I{str}
|
||||
- default: None
|
||||
"""
|
||||
def __init__(self, **kwargs):
|
||||
domain = __name__
|
||||
definitions = [
|
||||
Definition('proxy', dict, {}),
|
||||
Definition('timeout', (int,float), 90),
|
||||
Definition('headers', dict, {}),
|
||||
Definition('username', basestring, None),
|
||||
Definition('password', basestring, None),
|
||||
]
|
||||
Skin.__init__(self, domain, definitions, kwargs)
|
||||
Reference in New Issue
Block a user