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 has(self, relpath):
107
"""Does the target location exist?
109
TODO: HttpTransport.has() should use a HEAD request,
110
not a full GET request.
112
TODO: This should be changed so that we don't use
113
urllib2 and get an exception, the code path would be
114
cleaner if we just do an http HEAD request, and parse
118
f = get_url(self.abspath(relpath))
119
# Without the read and then close()
120
# we tend to have busy sockets.
126
except urllib2.URLError:
129
if e.errno == errno.ENOENT:
131
raise HttpTransportError(orig_error=e)
133
def get(self, relpath, decode=False):
134
"""Get the file at the given relative path.
136
:param relpath: The relative path to the file
139
return get_url(self.abspath(relpath))
140
except (BzrError, urllib2.URLError, IOError), e:
141
raise NoSuchFile(msg = "Error retrieving %s: %s"
142
% (self.abspath(relpath), str(e)),
145
def put(self, relpath, f):
146
"""Copy the file-like or string object into the location.
148
:param relpath: Location to put the contents, relative to base.
149
:param f: File-like or string object.
151
raise TransportNotPossible('http PUT not supported')
153
def mkdir(self, relpath):
154
"""Create a directory at the given path."""
155
raise TransportNotPossible('http does not support mkdir()')
157
def append(self, relpath, f):
158
"""Append the text in the file-like object into the final
161
raise TransportNotPossible('http does not support append()')
163
def copy(self, rel_from, rel_to):
164
"""Copy the item at rel_from to the location at rel_to"""
165
raise TransportNotPossible('http does not support copy()')
167
def copy_to(self, relpaths, other, pb=None):
168
"""Copy a set of entries from self into another Transport.
170
:param relpaths: A list/generator of entries to be copied.
172
TODO: if other is LocalTransport, is it possible to
173
do better than put(get())?
175
# At this point HttpTransport might be able to check and see if
176
# the remote location is the same, and rather than download, and
177
# then upload, it could just issue a remote copy_this command.
178
if isinstance(other, HttpTransport):
179
raise TransportNotPossible('http cannot be the target of copy_to()')
181
return super(HttpTransport, self).copy_to(relpaths, other, pb=pb)
183
def move(self, rel_from, rel_to):
184
"""Move the item at rel_from to the location at rel_to"""
185
raise TransportNotPossible('http does not support move()')
187
def delete(self, relpath):
188
"""Delete the item at relpath"""
189
raise TransportNotPossible('http does not support delete()')
192
"""See Transport.listable."""
195
def stat(self, relpath):
196
"""Return the stat information for a file.
198
raise TransportNotPossible('http does not support stat()')
200
def lock_read(self, relpath):
201
"""Lock the given file for shared (read) access.
202
:return: A lock object, which should be passed to Transport.unlock()
204
# The old RemoteBranch ignore lock for reading, so we will
205
# continue that tradition and return a bogus lock object.
206
class BogusLock(object):
207
def __init__(self, path):
211
return BogusLock(relpath)
213
def lock_write(self, relpath):
214
"""Lock the given file for exclusive (write) access.
215
WARNING: many transports do not support this, so trying avoid using it
217
:return: A lock object, which should be passed to Transport.unlock()
219
raise TransportNotPossible('http does not support lock_write()')
221
register_transport('http://', HttpTransport)
222
register_transport('https://', HttpTransport)