~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/transport/http.py

  • Committer: Martin Pool
  • Date: 2005-07-07 10:31:36 UTC
  • Revision ID: mbp@sourcefrog.net-20050707103135-9b4d911d8df6e880
- fix pwk help

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005 Canonical Ltd
2
 
 
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.
7
 
 
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.
12
 
 
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.
17
 
"""
18
 
 
19
 
from bzrlib.transport import Transport, register_transport
20
 
from bzrlib.errors import (TransportNotPossible, NoSuchFile, 
21
 
                           NonRelativePath, TransportError)
22
 
import os, errno
23
 
from cStringIO import StringIO
24
 
import urllib2
25
 
import urlparse
26
 
 
27
 
from bzrlib.errors import BzrError, BzrCheckError
28
 
from bzrlib.branch import Branch
29
 
from bzrlib.trace import mutter
30
 
 
31
 
# velocitynet.com.au transparently proxies connections and thereby
32
 
# breaks keep-alive -- sucks!
33
 
 
34
 
 
35
 
def get_url(url):
36
 
    import urllib2
37
 
    mutter("get_url %s" % url)
38
 
    url_f = urllib2.urlopen(url)
39
 
    return url_f
40
 
 
41
 
class HttpTransportError(TransportError):
42
 
    pass
43
 
 
44
 
class HttpTransport(Transport):
45
 
    """This is the transport agent for http:// access.
46
 
    
47
 
    TODO: Implement pipelined versions of all of the *_multi() functions.
48
 
    """
49
 
 
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)
60
 
 
61
 
    def should_cache(self):
62
 
        """Return True if the data pulled across should be cached locally.
63
 
        """
64
 
        return True
65
 
 
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.
70
 
        """
71
 
        if offset is None:
72
 
            return HttpTransport(self.base)
73
 
        else:
74
 
            return HttpTransport(self.abspath(offset))
75
 
 
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
79
 
        """
80
 
        if isinstance(relpath, basestring):
81
 
            relpath = [relpath]
82
 
        basepath = self._path.split('/')
83
 
        if len(basepath) > 0 and basepath[-1] == '':
84
 
            basepath = basepath[:-1]
85
 
 
86
 
        for p in relpath:
87
 
            if p == '..':
88
 
                if len(basepath) < 0:
89
 
                    # In most filesystems, a request for the parent
90
 
                    # of root, just returns root.
91
 
                    continue
92
 
                if len(basepath) > 0:
93
 
                    basepath.pop()
94
 
            elif p == '.':
95
 
                continue # No-op
96
 
            else:
97
 
                basepath.append(p)
98
 
 
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, '', '', ''))
105
 
 
106
 
    def has(self, relpath):
107
 
        """Does the target location exist?
108
 
 
109
 
        TODO: HttpTransport.has() should use a HEAD request,
110
 
        not a full GET request.
111
 
 
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
115
 
        the return code.
116
 
        """
117
 
        try:
118
 
            f = get_url(self.abspath(relpath))
119
 
            # Without the read and then close()
120
 
            # we tend to have busy sockets.
121
 
            f.read()
122
 
            f.close()
123
 
            return True
124
 
        except BzrError:
125
 
            return False
126
 
        except urllib2.URLError:
127
 
            return False
128
 
        except IOError, e:
129
 
            if e.errno == errno.ENOENT:
130
 
                return False
131
 
            raise HttpTransportError(orig_error=e)
132
 
 
133
 
    def get(self, relpath, decode=False):
134
 
        """Get the file at the given relative path.
135
 
 
136
 
        :param relpath: The relative path to the file
137
 
        """
138
 
        try:
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)),
143
 
                             orig_error=e)
144
 
 
145
 
    def put(self, relpath, f):
146
 
        """Copy the file-like or string object into the location.
147
 
 
148
 
        :param relpath: Location to put the contents, relative to base.
149
 
        :param f:       File-like or string object.
150
 
        """
151
 
        raise TransportNotPossible('http PUT not supported')
152
 
 
153
 
    def mkdir(self, relpath):
154
 
        """Create a directory at the given path."""
155
 
        raise TransportNotPossible('http does not support mkdir()')
156
 
 
157
 
    def append(self, relpath, f):
158
 
        """Append the text in the file-like object into the final
159
 
        location.
160
 
        """
161
 
        raise TransportNotPossible('http does not support append()')
162
 
 
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()')
166
 
 
167
 
    def copy_to(self, relpaths, other, pb=None):
168
 
        """Copy a set of entries from self into another Transport.
169
 
 
170
 
        :param relpaths: A list/generator of entries to be copied.
171
 
 
172
 
        TODO: if other is LocalTransport, is it possible to
173
 
              do better than put(get())?
174
 
        """
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()')
180
 
        else:
181
 
            return super(HttpTransport, self).copy_to(relpaths, other, pb=pb)
182
 
 
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()')
186
 
 
187
 
    def delete(self, relpath):
188
 
        """Delete the item at relpath"""
189
 
        raise TransportNotPossible('http does not support delete()')
190
 
 
191
 
    def listable(self):
192
 
        """See Transport.listable."""
193
 
        return False
194
 
 
195
 
    def stat(self, relpath):
196
 
        """Return the stat information for a file.
197
 
        """
198
 
        raise TransportNotPossible('http does not support stat()')
199
 
 
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()
203
 
        """
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):
208
 
                self.path = path
209
 
            def unlock(self):
210
 
                pass
211
 
        return BogusLock(relpath)
212
 
 
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
216
 
 
217
 
        :return: A lock object, which should be passed to Transport.unlock()
218
 
        """
219
 
        raise TransportNotPossible('http does not support lock_write()')
220
 
 
221
 
register_transport('http://', HttpTransport)
222
 
register_transport('https://', HttpTransport)