/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/tree.py

  • Committer: Martin Pool
  • Date: 2006-06-20 03:57:11 UTC
  • mto: This revision was merged to the branch mainline in revision 1798.
  • Revision ID: mbp@sourcefrog.net-20060620035711-400bb6b6bc6ff95b
Add pyflakes makefile target; fix many warnings

Show diffs side-by-side

added added

removed removed

Lines of Context:
18
18
"""
19
19
 
20
20
import os
 
21
from cStringIO import StringIO
21
22
 
22
23
import bzrlib
23
24
from bzrlib.trace import mutter, note
24
 
from bzrlib.errors import BzrError
 
25
from bzrlib.errors import BzrError, BzrCheckError
25
26
from bzrlib.inventory import Inventory
26
 
from bzrlib.osutils import pumpfile, appendpath, fingerprint_file
27
 
 
28
 
 
29
 
exporters = {}
 
27
from bzrlib.osutils import fingerprint_file
30
28
 
31
29
class Tree(object):
32
30
    """Abstract file tree.
57
55
    def has_id(self, file_id):
58
56
        return self.inventory.has_id(file_id)
59
57
 
 
58
    def has_or_had_id(self, file_id):
 
59
        if file_id == self.inventory.root.file_id:
 
60
            return True
 
61
        return self.inventory.has_id(file_id)
 
62
 
60
63
    __contains__ = has_id
61
64
 
62
65
    def __iter__(self):
65
68
    def id2path(self, file_id):
66
69
        return self.inventory.id2path(file_id)
67
70
 
 
71
    def kind(self, file_id):
 
72
        raise NotImplementedError("subclasses must implement kind")
 
73
 
68
74
    def _get_inventory(self):
69
75
        return self._inventory
70
76
    
75
81
                         doc="Inventory of this Tree")
76
82
 
77
83
    def _check_retrieved(self, ie, f):
 
84
        if not __debug__:
 
85
            return  
78
86
        fp = fingerprint_file(f)
79
87
        f.seek(0)
80
88
        
92
100
                     "store is probably damaged/corrupt"])
93
101
 
94
102
 
95
 
    def print_file(self, fileid):
96
 
        """Print file with id `fileid` to stdout."""
 
103
    def print_file(self, file_id):
 
104
        """Print file with id `file_id` to stdout."""
97
105
        import sys
98
 
        pumpfile(self.get_file(fileid), sys.stdout)
99
 
        
100
 
        
101
 
    def export(self, dest, format='dir', root=None):
102
 
        """Export this tree."""
103
 
        try:
104
 
            exporter = exporters[format]
105
 
        except KeyError:
106
 
            from bzrlib.errors import BzrCommandError
107
 
            raise BzrCommandError("export format %r not supported" % format)
108
 
        exporter(self, dest, root)
109
 
 
110
 
 
111
 
 
 
106
        sys.stdout.write(self.get_file_text(file_id))
 
107
 
 
108
    def lock_read(self):
 
109
        pass
 
110
 
 
111
    def unlock(self):
 
112
        pass
 
113
 
 
114
    def filter_unversioned_files(self, paths):
 
115
        """Filter out paths that are not versioned.
 
116
 
 
117
        :return: set of paths.
 
118
        """
 
119
        # NB: we specifically *don't* call self.has_filename, because for
 
120
        # WorkingTrees that can indicate files that exist on disk but that 
 
121
        # are not versioned.
 
122
        pred = self.inventory.has_filename
 
123
        return set((p for p in paths if not pred(p)))
 
124
        
 
125
        
112
126
class RevisionTree(Tree):
113
127
    """Tree viewing a previous revision.
114
128
 
119
133
           or at least passing a description to the constructor.
120
134
    """
121
135
    
122
 
    def __init__(self, store, inv):
123
 
        self._store = store
 
136
    def __init__(self, branch, inv, revision_id):
 
137
        self._branch = branch
 
138
        self._weave_store = branch.weave_store
124
139
        self._inventory = inv
 
140
        self._revision_id = revision_id
 
141
 
 
142
    def get_revision_id(self):
 
143
        """Return the revision id associated with this tree."""
 
144
        return self._revision_id
 
145
 
 
146
    def get_weave(self, file_id):
 
147
        return self._weave_store.get_weave(file_id,
 
148
                self._branch.get_transaction())
 
149
 
 
150
    def get_file_lines(self, file_id):
 
151
        ie = self._inventory[file_id]
 
152
        weave = self.get_weave(file_id)
 
153
        return weave.get_lines(ie.revision)
 
154
 
 
155
    def get_file_text(self, file_id):
 
156
        return ''.join(self.get_file_lines(file_id))
125
157
 
126
158
    def get_file(self, file_id):
127
 
        ie = self._inventory[file_id]
128
 
        f = self._store[ie.text_id]
129
 
        mutter("  get fileid{%s} from %r" % (file_id, self))
130
 
        self._check_retrieved(ie, f)
131
 
        return f
 
159
        return StringIO(self.get_file_text(file_id))
132
160
 
133
161
    def get_file_size(self, file_id):
134
162
        return self._inventory[file_id].text_size
135
163
 
136
 
    def get_file_sha1(self, file_id):
137
 
        ie = self._inventory[file_id]
138
 
        return ie.text_sha1
 
164
    def get_file_sha1(self, file_id, path=None):
 
165
        ie = self._inventory[file_id]
 
166
        if ie.kind == "file":
 
167
            return ie.text_sha1
 
168
        return None
 
169
 
 
170
    def get_file_mtime(self, file_id, path=None):
 
171
        ie = self._inventory[file_id]
 
172
        revision = self._branch.get_revision(ie.revision)
 
173
        return revision.timestamp
 
174
 
 
175
    def is_executable(self, file_id, path=None):
 
176
        ie = self._inventory[file_id]
 
177
        if ie.kind != "file":
 
178
            return None 
 
179
        return self._inventory[file_id].executable
139
180
 
140
181
    def has_filename(self, filename):
141
182
        return bool(self.inventory.path2id(filename))
143
184
    def list_files(self):
144
185
        # The only files returned by this are those from the version
145
186
        for path, entry in self.inventory.iter_entries():
146
 
            yield path, 'V', entry.kind, entry.file_id
 
187
            yield path, 'V', entry.kind, entry.file_id, entry
 
188
 
 
189
    def get_symlink_target(self, file_id):
 
190
        ie = self._inventory[file_id]
 
191
        return ie.symlink_target;
 
192
 
 
193
    def kind(self, file_id):
 
194
        return self._inventory[file_id].kind
 
195
 
 
196
    def lock_read(self):
 
197
        self._branch.lock_read()
 
198
 
 
199
    def unlock(self):
 
200
        self._branch.unlock()
147
201
 
148
202
 
149
203
class EmptyTree(Tree):
150
204
    def __init__(self):
151
205
        self._inventory = Inventory()
152
206
 
 
207
    def get_symlink_target(self, file_id):
 
208
        return None
 
209
 
153
210
    def has_filename(self, filename):
154
211
        return False
155
212
 
 
213
    def kind(self, file_id):
 
214
        assert self._inventory[file_id].kind == "root_directory"
 
215
        return "root_directory"
 
216
 
156
217
    def list_files(self):
157
 
        if False:  # just to make it a generator
158
 
            yield None
 
218
        return iter([])
159
219
    
 
220
    def __contains__(self, file_id):
 
221
        return file_id in self._inventory
 
222
 
 
223
    def get_file_sha1(self, file_id, path=None):
 
224
        assert self._inventory[file_id].kind == "root_directory"
 
225
        return None
160
226
 
161
227
 
162
228
######################################################################
225
291
            
226
292
 
227
293
 
228
 
######################################################################
229
 
# export
230
 
 
231
 
def dir_exporter(tree, dest, root):
232
 
    """Export this tree to a new directory.
233
 
 
234
 
    `dest` should not exist, and will be created holding the
235
 
    contents of this tree.
236
 
 
237
 
    TODO: To handle subdirectories we need to create the
238
 
           directories first.
239
 
 
240
 
    :note: If the export fails, the destination directory will be
241
 
           left in a half-assed state.
242
 
    """
243
 
    import os
244
 
    os.mkdir(dest)
245
 
    mutter('export version %r' % tree)
246
 
    inv = tree.inventory
247
 
    for dp, ie in inv.iter_entries():
248
 
        kind = ie.kind
249
 
        fullpath = appendpath(dest, dp)
250
 
        if kind == 'directory':
251
 
            os.mkdir(fullpath)
252
 
        elif kind == 'file':
253
 
            pumpfile(tree.get_file(ie.file_id), file(fullpath, 'wb'))
254
 
        else:
255
 
            raise BzrError("don't know how to export {%s} of kind %r" % (ie.file_id, kind))
256
 
        mutter("  export {%s} kind %s to %s" % (ie.file_id, kind, fullpath))
257
 
exporters['dir'] = dir_exporter
258
 
 
259
 
try:
260
 
    import tarfile
261
 
except ImportError:
262
 
    pass
263
 
else:
264
 
    def get_root_name(dest):
265
 
        """Get just the root name for a tarball.
266
 
 
267
 
        >>> get_root_name('mytar.tar')
268
 
        'mytar'
269
 
        >>> get_root_name('mytar.tar.bz2')
270
 
        'mytar'
271
 
        >>> get_root_name('tar.tar.tar.tgz')
272
 
        'tar.tar.tar'
273
 
        >>> get_root_name('bzr-0.0.5.tar.gz')
274
 
        'bzr-0.0.5'
275
 
        >>> get_root_name('a/long/path/mytar.tgz')
276
 
        'mytar'
277
 
        >>> get_root_name('../parent/../dir/other.tbz2')
278
 
        'other'
279
 
        """
280
 
        endings = ['.tar', '.tar.gz', '.tgz', '.tar.bz2', '.tbz2']
281
 
        dest = os.path.basename(dest)
282
 
        for end in endings:
283
 
            if dest.endswith(end):
284
 
                return dest[:-len(end)]
285
 
 
286
 
    def tar_exporter(tree, dest, root, compression=None):
287
 
        """Export this tree to a new tar file.
288
 
 
289
 
        `dest` will be created holding the contents of this tree; if it
290
 
        already exists, it will be clobbered, like with "tar -c".
291
 
        """
292
 
        from time import time
293
 
        now = time()
294
 
        compression = str(compression or '')
295
 
        if root is None:
296
 
            root = get_root_name(dest)
297
 
        try:
298
 
            ball = tarfile.open(dest, 'w:' + compression)
299
 
        except tarfile.CompressionError, e:
300
 
            raise BzrError(str(e))
301
 
        mutter('export version %r' % tree)
302
 
        inv = tree.inventory
303
 
        for dp, ie in inv.iter_entries():
304
 
            mutter("  export {%s} kind %s to %s" % (ie.file_id, ie.kind, dest))
305
 
            item = tarfile.TarInfo(os.path.join(root, dp))
306
 
            # TODO: would be cool to actually set it to the timestamp of the
307
 
            # revision it was last changed
308
 
            item.mtime = now
309
 
            if ie.kind == 'directory':
310
 
                item.type = tarfile.DIRTYPE
311
 
                fileobj = None
312
 
                item.name += '/'
313
 
                item.size = 0
314
 
                item.mode = 0755
315
 
            elif ie.kind == 'file':
316
 
                item.type = tarfile.REGTYPE
317
 
                fileobj = tree.get_file(ie.file_id)
318
 
                item.size = _find_file_size(fileobj)
319
 
                item.mode = 0644
320
 
            else:
321
 
                raise BzrError("don't know how to export {%s} of kind %r" %
322
 
                        (ie.file_id, ie.kind))
323
 
 
324
 
            ball.addfile(item, fileobj)
325
 
        ball.close()
326
 
    exporters['tar'] = tar_exporter
327
 
 
328
 
    def tgz_exporter(tree, dest, root):
329
 
        tar_exporter(tree, dest, root, compression='gz')
330
 
    exporters['tgz'] = tgz_exporter
331
 
 
332
 
    def tbz_exporter(tree, dest, root):
333
 
        tar_exporter(tree, dest, root, compression='bz2')
334
 
    exporters['tbz2'] = tbz_exporter
335
 
 
336
 
 
337
 
def _find_file_size(fileobj):
338
 
    offset = fileobj.tell()
339
 
    try:
340
 
        fileobj.seek(0, 2)
341
 
        size = fileobj.tell()
342
 
    except TypeError:
343
 
        # gzip doesn't accept second argument to seek()
344
 
        fileobj.seek(0)
345
 
        size = 0
346
 
        while True:
347
 
            nread = len(fileobj.read())
348
 
            if nread == 0:
349
 
                break
350
 
            size += nread
351
 
    fileobj.seek(offset)
352
 
    return size