1
# Copyright (C) 2005 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
16
"""Implementation of Transport over http.
19
from bzrlib.transport import Transport, register_transport
20
from bzrlib.errors import (TransportNotPossible, NoSuchFile,
21
NonRelativePath, TransportError)
23
from cStringIO import StringIO
27
from bzrlib.errors import BzrError, BzrCheckError
28
from bzrlib.branch import Branch
29
from bzrlib.trace import mutter
31
# velocitynet.com.au transparently proxies connections and thereby
32
# breaks keep-alive -- sucks!
37
mutter("get_url %s" % url)
38
url_f = urllib2.urlopen(url)
41
class HttpTransportError(TransportError):
44
class HttpTransport(Transport):
45
"""This is the transport agent for http:// access.
47
TODO: Implement pipelined versions of all of the *_multi() functions.
50
def __init__(self, base):
51
"""Set the base path where files will be stored."""
52
assert base.startswith('http://') or base.startswith('https://')
53
super(HttpTransport, self).__init__(base)
54
# In the future we might actually connect to the remote host
55
# rather than using get_url
56
# self._connection = None
57
(self._proto, self._host,
58
self._path, self._parameters,
59
self._query, self._fragment) = urlparse.urlparse(self.base)
61
def should_cache(self):
62
"""Return True if the data pulled across should be cached locally.
66
def clone(self, offset=None):
67
"""Return a new HttpTransport with root at self.base + offset
68
For now HttpTransport does not actually connect, so just return
69
a new HttpTransport object.
72
return HttpTransport(self.base)
74
return HttpTransport(self.abspath(offset))
76
def abspath(self, relpath):
77
"""Return the full url to the given relative path.
78
This can be supplied with a string or a list
80
if isinstance(relpath, basestring):
82
basepath = self._path.split('/')
83
if len(basepath) > 0 and basepath[-1] == '':
84
basepath = basepath[:-1]
89
# In most filesystems, a request for the parent
90
# of root, just returns root.
99
# Possibly, we could use urlparse.urljoin() here, but
100
# I'm concerned about when it chooses to strip the last
101
# portion of the path, and when it doesn't.
102
path = '/'.join(basepath)
103
return urlparse.urlunparse((self._proto,
104
self._host, path, '', '', ''))
106
def relpath(self, abspath):
107
if not abspath.startswith(self.base):
108
raise NonRelativePath('path %r is not under base URL %r'
109
% (abspath, self.base))
111
return abspath[pl:].lstrip('/')
113
def has(self, relpath):
114
"""Does the target location exist?
116
TODO: HttpTransport.has() should use a HEAD request,
117
not a full GET request.
119
TODO: This should be changed so that we don't use
120
urllib2 and get an exception, the code path would be
121
cleaner if we just do an http HEAD request, and parse
125
f = get_url(self.abspath(relpath))
126
# Without the read and then close()
127
# we tend to have busy sockets.
133
except urllib2.URLError:
136
if e.errno == errno.ENOENT:
138
raise HttpTransportError(orig_error=e)
140
def get(self, relpath, decode=False):
141
"""Get the file at the given relative path.
143
:param relpath: The relative path to the file
146
return get_url(self.abspath(relpath))
147
except (BzrError, urllib2.URLError, IOError), e:
148
raise NoSuchFile(msg = "Error retrieving %s: %s"
149
% (self.abspath(relpath), str(e)),
152
def get_partial(self, relpath, start, length=None):
153
"""Get just part of a file.
155
:param relpath: Path to the file, relative to base
156
:param start: The starting position to read from
157
:param length: The length to read. A length of None indicates
158
read to the end of the file.
159
:return: A file-like object containing at least the specified bytes.
160
Some implementations may return objects which can be read
161
past this length, but this is not guaranteed.
163
# TODO: You can make specialized http requests for just
164
# a portion of the file. Figure out how to do that.
165
# For now, urllib2 returns files that cannot seek() so
166
# we just read bytes off the beginning, until we
167
# get to the point that we care about.
168
f = self.get(relpath)
169
# TODO: read in smaller chunks, in case things are
170
# buffered internally.
174
def put(self, relpath, f):
175
"""Copy the file-like or string object into the location.
177
:param relpath: Location to put the contents, relative to base.
178
:param f: File-like or string object.
180
raise TransportNotPossible('http PUT not supported')
182
def mkdir(self, relpath):
183
"""Create a directory at the given path."""
184
raise TransportNotPossible('http does not support mkdir()')
186
def append(self, relpath, f):
187
"""Append the text in the file-like object into the final
190
raise TransportNotPossible('http does not support append()')
192
def copy(self, rel_from, rel_to):
193
"""Copy the item at rel_from to the location at rel_to"""
194
raise TransportNotPossible('http does not support copy()')
196
def copy_to(self, relpaths, other, pb=None):
197
"""Copy a set of entries from self into another Transport.
199
:param relpaths: A list/generator of entries to be copied.
201
TODO: if other is LocalTransport, is it possible to
202
do better than put(get())?
204
# At this point HttpTransport might be able to check and see if
205
# the remote location is the same, and rather than download, and
206
# then upload, it could just issue a remote copy_this command.
207
if isinstance(other, HttpTransport):
208
raise TransportNotPossible('http cannot be the target of copy_to()')
210
return super(HttpTransport, self).copy_to(relpaths, other, pb=pb)
212
def move(self, rel_from, rel_to):
213
"""Move the item at rel_from to the location at rel_to"""
214
raise TransportNotPossible('http does not support move()')
216
def delete(self, relpath):
217
"""Delete the item at relpath"""
218
raise TransportNotPossible('http does not support delete()')
221
"""See Transport.listable."""
224
def stat(self, relpath):
225
"""Return the stat information for a file.
227
raise TransportNotPossible('http does not support stat()')
229
def lock_read(self, relpath):
230
"""Lock the given file for shared (read) access.
231
:return: A lock object, which should be passed to Transport.unlock()
233
# The old RemoteBranch ignore lock for reading, so we will
234
# continue that tradition and return a bogus lock object.
235
class BogusLock(object):
236
def __init__(self, path):
240
return BogusLock(relpath)
242
def lock_write(self, relpath):
243
"""Lock the given file for exclusive (write) access.
244
WARNING: many transports do not support this, so trying avoid using it
246
:return: A lock object, which should be passed to Transport.unlock()
248
raise TransportNotPossible('http does not support lock_write()')
250
register_transport('http://', HttpTransport)
251
register_transport('https://', HttpTransport)
added
removed
bzrlib/transport/http.py
