1
# Copyright (C) 2005, 2006 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
import urllib, urllib2
19
import bzrlib # for the version
20
from bzrlib.errors import BzrError
21
from bzrlib.trace import mutter
22
from bzrlib.transport import register_urlparse_netloc_protocol
23
from bzrlib.transport.http import HttpTransportBase, extract_auth, HttpServer
24
from bzrlib.errors import (TransportNotPossible, NoSuchFile,
25
TransportError, ConnectionError)
28
register_urlparse_netloc_protocol('http+urllib')
31
class Request(urllib2.Request):
32
"""Request object for urllib2 that allows the method to be overridden."""
37
if self.method is not None:
40
return urllib2.Request.get_method(self)
43
class HttpTransport_urllib(HttpTransportBase):
44
"""Python urllib transport for http and https.
47
# TODO: Implement pipelined versions of all of the *_multi() functions.
49
def __init__(self, base):
50
"""Set the base path where files will be stored."""
51
super(HttpTransport_urllib, self).__init__(base)
53
def _get(self, relpath, ranges):
56
path = self._real_abspath(relpath)
57
response = self._get_url_impl(path, method='GET', ranges=ranges)
58
return response.code, response
59
except urllib2.HTTPError, e:
60
mutter('url error code: %s for has url: %r', e.code, path)
62
raise NoSuchFile(path, extra=e)
64
except (BzrError, IOError), e:
65
if hasattr(e, 'errno'):
66
mutter('io error: %s %s for has url: %r',
67
e.errno, errno.errorcode.get(e.errno), path)
68
if e.errno == errno.ENOENT:
69
raise NoSuchFile(path, extra=e)
70
raise ConnectionError(msg = "Error retrieving %s: %s"
71
% (self.abspath(relpath), str(e)),
74
def _get_url_impl(self, url, method, ranges):
75
"""Actually pass get request into urllib
77
:returns: urllib Response object
83
mutter("get_url %s [%s]" % (url, range_string))
84
manager = urllib2.HTTPPasswordMgrWithDefaultRealm()
85
url = extract_auth(url, manager)
86
auth_handler = urllib2.HTTPBasicAuthHandler(manager)
87
opener = urllib2.build_opener(auth_handler)
88
request = Request(url)
89
request.method = method
90
request.add_header('Pragma', 'no-cache')
91
request.add_header('Cache-control', 'max-age=0')
92
request.add_header('User-Agent', 'bzr/%s (urllib)' % bzrlib.__version__)
94
assert len(ranges) == 1
95
request.add_header('Range', 'bytes=%d-%d' % ranges[0])
96
response = opener.open(request)
99
def should_cache(self):
100
"""Return True if the data pulled across should be cached locally.
104
def has(self, relpath):
105
"""Does the target location exist?
107
abspath = self._real_abspath(relpath)
109
f = self._get_url_impl(abspath, 'HEAD', [])
110
# Without the read and then close()
111
# we tend to have busy sockets.
115
except urllib2.URLError, e:
116
mutter('url error code: %s for has url: %r', e.code, abspath)
121
mutter('io error: %s %s for has url: %r',
122
e.errno, errno.errorcode.get(e.errno), abspath)
123
if e.errno == errno.ENOENT:
125
raise TransportError(orig_error=e)
127
def copy_to(self, relpaths, other, mode=None, pb=None):
128
"""Copy a set of entries from self into another Transport.
130
:param relpaths: A list/generator of entries to be copied.
132
TODO: if other is LocalTransport, is it possible to
133
do better than put(get())?
135
# At this point HttpTransport_urllib might be able to check and see if
136
# the remote location is the same, and rather than download, and
137
# then upload, it could just issue a remote copy_this command.
138
if isinstance(other, HttpTransport_urllib):
139
raise TransportNotPossible('http cannot be the target of copy_to()')
141
return super(HttpTransport_urllib, self).copy_to(relpaths, other, mode=mode, pb=pb)
143
def move(self, rel_from, rel_to):
144
"""Move the item at rel_from to the location at rel_to"""
145
raise TransportNotPossible('http does not support move()')
147
def delete(self, relpath):
148
"""Delete the item at relpath"""
149
raise TransportNotPossible('http does not support delete()')
152
class HttpServer_urllib(HttpServer):
153
"""Subclass of HttpServer that gives http+urllib urls.
155
This is for use in testing: connections to this server will always go
156
through urllib where possible.
159
# urls returned by this server should require the urllib client impl
160
_url_protocol = 'http+urllib'
163
def get_test_permutations():
164
"""Return the permutations to be used in testing."""
165
return [(HttpTransport_urllib, HttpServer_urllib),