/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: Robert Collins
  • Date: 2006-07-24 02:05:29 UTC
  • mto: (1852.8.1 InterTree)
  • mto: This revision was merged to the branch mainline in revision 1891.
  • Revision ID: robertc@robertcollins.net-20060724020529-b10a2193bd191d78
Move RevisionTree out of tree.py.

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
 
22
from warnings import warn
21
23
 
22
24
import bzrlib
 
25
from bzrlib.errors import BzrError, BzrCheckError
 
26
from bzrlib import errors
 
27
from bzrlib.inventory import Inventory
 
28
from bzrlib.osutils import fingerprint_file
 
29
import bzrlib.revision
23
30
from bzrlib.trace import mutter, note
24
 
from bzrlib.errors import BzrError
25
 
from bzrlib.inventory import Inventory
26
 
from bzrlib.osutils import pumpfile, appendpath, fingerprint_file
27
 
 
28
 
 
29
 
exporters = {}
 
31
 
30
32
 
31
33
class Tree(object):
32
34
    """Abstract file tree.
37
39
 
38
40
    * `RevisionTree` is a tree as recorded at some point in the past.
39
41
 
40
 
    * `EmptyTree`
41
 
 
42
42
    Trees contain an `Inventory` object, and also know how to retrieve
43
43
    file texts mentioned in the inventory, either from a working
44
44
    directory or from a store.
50
50
    trees or versioned trees.
51
51
    """
52
52
    
 
53
    def conflicts(self):
 
54
        """Get a list of the conflicts in the tree.
 
55
 
 
56
        Each conflict is an instance of bzrlib.conflicts.Conflict.
 
57
        """
 
58
        return []
 
59
 
 
60
    def get_parent_ids(self):
 
61
        """Get the parent ids for this tree. 
 
62
 
 
63
        :return: a list of parent ids. [] is returned to indicate
 
64
        a tree with no parents.
 
65
        :raises: BzrError if the parents are not known.
 
66
        """
 
67
        raise NotImplementedError(self.get_parent_ids)
 
68
    
53
69
    def has_filename(self, filename):
54
70
        """True if the tree has given filename."""
55
71
        raise NotImplementedError()
57
73
    def has_id(self, file_id):
58
74
        return self.inventory.has_id(file_id)
59
75
 
 
76
    def has_or_had_id(self, file_id):
 
77
        if file_id == self.inventory.root.file_id:
 
78
            return True
 
79
        return self.inventory.has_id(file_id)
 
80
 
60
81
    __contains__ = has_id
61
82
 
62
83
    def __iter__(self):
65
86
    def id2path(self, file_id):
66
87
        return self.inventory.id2path(file_id)
67
88
 
 
89
    def kind(self, file_id):
 
90
        raise NotImplementedError("subclasses must implement kind")
 
91
 
68
92
    def _get_inventory(self):
69
93
        return self._inventory
70
94
    
75
99
                         doc="Inventory of this Tree")
76
100
 
77
101
    def _check_retrieved(self, ie, f):
 
102
        if not __debug__:
 
103
            return  
78
104
        fp = fingerprint_file(f)
79
105
        f.seek(0)
80
106
        
92
118
                     "store is probably damaged/corrupt"])
93
119
 
94
120
 
95
 
    def print_file(self, fileid):
96
 
        """Print file with id `fileid` to stdout."""
 
121
    def print_file(self, file_id):
 
122
        """Print file with id `file_id` to stdout."""
97
123
        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
 
 
112
 
class RevisionTree(Tree):
113
 
    """Tree viewing a previous revision.
114
 
 
115
 
    File text can be retrieved from the text store.
116
 
 
117
 
    TODO: Some kind of `__repr__` method, but a good one
118
 
           probably means knowing the branch and revision number,
119
 
           or at least passing a description to the constructor.
120
 
    """
121
 
    
122
 
    def __init__(self, store, inv):
123
 
        self._store = store
124
 
        self._inventory = inv
125
 
 
126
 
    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
132
 
 
133
 
    def get_file_size(self, file_id):
134
 
        return self._inventory[file_id].text_size
135
 
 
136
 
    def get_file_sha1(self, file_id):
137
 
        ie = self._inventory[file_id]
138
 
        return ie.text_sha1
139
 
 
140
 
    def has_filename(self, filename):
141
 
        return bool(self.inventory.path2id(filename))
142
 
 
143
 
    def list_files(self):
144
 
        # The only files returned by this are those from the version
145
 
        for path, entry in self.inventory.iter_entries():
146
 
            yield path, 'V', entry.kind, entry.file_id
147
 
 
 
124
        sys.stdout.write(self.get_file_text(file_id))
 
125
 
 
126
    def lock_read(self):
 
127
        pass
 
128
 
 
129
    def unknowns(self):
 
130
        """What files are present in this tree and unknown.
 
131
        
 
132
        :return: an iterator over the unknown files.
 
133
        """
 
134
        return iter([])
 
135
 
 
136
    def unlock(self):
 
137
        pass
 
138
 
 
139
    def filter_unversioned_files(self, paths):
 
140
        """Filter out paths that are not versioned.
 
141
 
 
142
        :return: set of paths.
 
143
        """
 
144
        # NB: we specifically *don't* call self.has_filename, because for
 
145
        # WorkingTrees that can indicate files that exist on disk but that 
 
146
        # are not versioned.
 
147
        pred = self.inventory.has_filename
 
148
        return set((p for p in paths if not pred(p)))
 
149
 
 
150
 
 
151
# for compatibility
 
152
from bzrlib.revisiontree import RevisionTree
 
153
 
148
154
 
149
155
class EmptyTree(Tree):
 
156
 
150
157
    def __init__(self):
151
158
        self._inventory = Inventory()
 
159
        warn('EmptyTree is deprecated as of bzr 0.9 please use '
 
160
            'repository.revision_tree instead.',
 
161
            DeprecationWarning, stacklevel=2)
 
162
 
 
163
    def get_parent_ids(self):
 
164
        return []
 
165
 
 
166
    def get_symlink_target(self, file_id):
 
167
        return None
152
168
 
153
169
    def has_filename(self, filename):
154
170
        return False
155
171
 
 
172
    def kind(self, file_id):
 
173
        assert self._inventory[file_id].kind == "root_directory"
 
174
        return "root_directory"
 
175
 
156
176
    def list_files(self):
157
 
        if False:  # just to make it a generator
158
 
            yield None
 
177
        return iter([])
159
178
    
 
179
    def __contains__(self, file_id):
 
180
        return file_id in self._inventory
 
181
 
 
182
    def get_file_sha1(self, file_id, path=None):
 
183
        assert self._inventory[file_id].kind == "root_directory"
 
184
        return None
160
185
 
161
186
 
162
187
######################################################################
224
249
            yield (old_name, new_name)
225
250
            
226
251
 
227
 
 
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
 
252
def find_ids_across_trees(filenames, trees, require_versioned=True):
 
253
    """Find the ids corresponding to specified filenames.
 
254
    
 
255
    All matches in all trees will be used, and all children of matched
 
256
    directories will be used.
 
257
 
 
258
    :param filenames: The filenames to find file_ids for
 
259
    :param trees: The trees to find file_ids within
 
260
    :param require_versioned: if true, all specified filenames must occur in
 
261
    at least one tree.
 
262
    :return: a set of file ids for the specified filenames and their children.
 
263
    """
 
264
    if not filenames:
 
265
        return None
 
266
    specified_ids = _find_filename_ids_across_trees(filenames, trees, 
 
267
                                                    require_versioned)
 
268
    return _find_children_across_trees(specified_ids, trees)
 
269
 
 
270
 
 
271
def _find_filename_ids_across_trees(filenames, trees, require_versioned):
 
272
    """Find the ids corresponding to specified filenames.
 
273
    
 
274
    All matches in all trees will be used.
 
275
 
 
276
    :param filenames: The filenames to find file_ids for
 
277
    :param trees: The trees to find file_ids within
 
278
    :param require_versioned: if true, all specified filenames must occur in
 
279
    at least one tree.
 
280
    :return: a set of file ids for the specified filenames
 
281
    """
 
282
    not_versioned = []
 
283
    interesting_ids = set()
 
284
    for tree_path in filenames:
 
285
        not_found = True
 
286
        for tree in trees:
 
287
            file_id = tree.inventory.path2id(tree_path)
 
288
            if file_id is not None:
 
289
                interesting_ids.add(file_id)
 
290
                not_found = False
 
291
        if not_found:
 
292
            not_versioned.append(tree_path)
 
293
    if len(not_versioned) > 0 and require_versioned:
 
294
        raise errors.PathsNotVersionedError(not_versioned)
 
295
    return interesting_ids
 
296
 
 
297
 
 
298
def _find_children_across_trees(specified_ids, trees):
 
299
    """Return a set including specified ids and their children
 
300
    
 
301
    All matches in all trees will be used.
 
302
 
 
303
    :param trees: The trees to find file_ids within
 
304
    :return: a set containing all specified ids and their children 
 
305
    """
 
306
    interesting_ids = set(specified_ids)
 
307
    pending = interesting_ids
 
308
    # now handle children of interesting ids
 
309
    # we loop so that we handle all children of each id in both trees
 
310
    while len(pending) > 0:
 
311
        new_pending = set()
 
312
        for file_id in pending:
 
313
            for tree in trees:
 
314
                if file_id not in tree:
 
315
                    continue
 
316
                entry = tree.inventory[file_id]
 
317
                for child in getattr(entry, 'children', {}).itervalues():
 
318
                    if child.file_id not in interesting_ids:
 
319
                        new_pending.add(child.file_id)
 
320
        interesting_ids.update(new_pending)
 
321
        pending = new_pending
 
322
    return interesting_ids