~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tree.py

  • Committer: Robert Collins
  • Date: 2005-10-06 11:40:12 UTC
  • mto: This revision was merged to the branch mainline in revision 1420.
  • Revision ID: robertc@robertcollins.net-20051006114012-c0acdb4146f9ea26
add sample test script

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
# Copyright (C) 2005 Canonical Ltd
2
 
#
 
2
 
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
#
 
7
 
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
12
 
#
 
12
 
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19
19
 
20
20
import os
21
21
from cStringIO import StringIO
22
 
from warnings import warn
23
22
 
24
23
import bzrlib
25
 
from bzrlib import delta
26
 
from bzrlib.decorators import needs_read_lock
 
24
from bzrlib.trace import mutter, note
27
25
from bzrlib.errors import BzrError, BzrCheckError
28
 
from bzrlib import errors
29
26
from bzrlib.inventory import Inventory
30
 
from bzrlib.inter import InterObject
31
 
from bzrlib.osutils import fingerprint_file
32
 
import bzrlib.revision
33
 
from bzrlib.trace import mutter, note
34
 
 
 
27
from bzrlib.osutils import appendpath, fingerprint_file
 
28
 
 
29
 
 
30
exporters = {}
35
31
 
36
32
class Tree(object):
37
33
    """Abstract file tree.
42
38
 
43
39
    * `RevisionTree` is a tree as recorded at some point in the past.
44
40
 
 
41
    * `EmptyTree`
 
42
 
45
43
    Trees contain an `Inventory` object, and also know how to retrieve
46
44
    file texts mentioned in the inventory, either from a working
47
45
    directory or from a store.
53
51
    trees or versioned trees.
54
52
    """
55
53
    
56
 
    def changes_from(self, other, want_unchanged=False, specific_files=None,
57
 
        extra_trees=None, require_versioned=False):
58
 
        """Return a TreeDelta of the changes from other to this tree.
59
 
 
60
 
        :param other: A tree to compare with.
61
 
        :param specific_files: An optional list of file paths to restrict the
62
 
            comparison to. When mapping filenames to ids, all matches in all
63
 
            trees (including optional extra_trees) are used, and all children of
64
 
            matched directories are included.
65
 
        :param want_unchanged: An optional boolean requesting the inclusion of
66
 
            unchanged entries in the result.
67
 
        :param extra_trees: An optional list of additional trees to use when
68
 
            mapping the contents of specific_files (paths) to file_ids.
69
 
        :param require_versioned: An optional boolean (defaults to False). When
70
 
            supplied and True all the 'specific_files' must be versioned, or
71
 
            a PathsNotVersionedError will be thrown.
72
 
 
73
 
        The comparison will be performed by an InterTree object looked up on 
74
 
        self and other.
75
 
        """
76
 
        # Martin observes that Tree.changes_from returns a TreeDelta and this
77
 
        # may confuse people, because the class name of the returned object is
78
 
        # a synonym of the object referenced in the method name.
79
 
        return InterTree.get(other, self).compare(
80
 
            want_unchanged=want_unchanged,
81
 
            specific_files=specific_files,
82
 
            extra_trees=extra_trees,
83
 
            require_versioned=require_versioned,
84
 
            )
85
 
    
86
 
    def conflicts(self):
87
 
        """Get a list of the conflicts in the tree.
88
 
 
89
 
        Each conflict is an instance of bzrlib.conflicts.Conflict.
90
 
        """
91
 
        return []
92
 
 
93
 
    def get_parent_ids(self):
94
 
        """Get the parent ids for this tree. 
95
 
 
96
 
        :return: a list of parent ids. [] is returned to indicate
97
 
        a tree with no parents.
98
 
        :raises: BzrError if the parents are not known.
99
 
        """
100
 
        raise NotImplementedError(self.get_parent_ids)
101
 
    
102
54
    def has_filename(self, filename):
103
55
        """True if the tree has given filename."""
104
56
        raise NotImplementedError()
108
60
 
109
61
    __contains__ = has_id
110
62
 
111
 
    def has_or_had_id(self, file_id):
112
 
        if file_id == self.inventory.root.file_id:
113
 
            return True
114
 
        return self.inventory.has_id(file_id)
115
 
 
116
63
    def __iter__(self):
117
64
        return iter(self.inventory)
118
65
 
119
66
    def id2path(self, file_id):
120
67
        return self.inventory.id2path(file_id)
121
68
 
122
 
    def iter_entries_by_dir(self):
123
 
        """Walk the tree in 'by_dir' order.
124
 
 
125
 
        This will yield each entry in the tree as a (path, entry) tuple. The
126
 
        order that they are yielded is: the contents of a directory are 
127
 
        preceeded by the parent of a directory, and all the contents of a 
128
 
        directory are grouped together.
129
 
        """
130
 
        return self.inventory.iter_entries_by_dir()
131
 
 
132
 
    def kind(self, file_id):
133
 
        raise NotImplementedError("subclasses must implement kind")
134
 
 
135
69
    def _get_inventory(self):
136
70
        return self._inventory
137
71
    
165
99
        """Print file with id `file_id` to stdout."""
166
100
        import sys
167
101
        sys.stdout.write(self.get_file_text(file_id))
168
 
 
169
 
    def lock_read(self):
170
 
        pass
171
 
 
172
 
    def unknowns(self):
173
 
        """What files are present in this tree and unknown.
174
 
        
175
 
        :return: an iterator over the unknown files.
176
 
        """
177
 
        return iter([])
178
 
 
179
 
    def unlock(self):
180
 
        pass
181
 
 
182
 
    def filter_unversioned_files(self, paths):
183
 
        """Filter out paths that are not versioned.
184
 
 
185
 
        :return: set of paths.
186
 
        """
187
 
        # NB: we specifically *don't* call self.has_filename, because for
188
 
        # WorkingTrees that can indicate files that exist on disk but that 
189
 
        # are not versioned.
190
 
        pred = self.inventory.has_filename
191
 
        return set((p for p in paths if not pred(p)))
192
 
 
193
 
 
194
 
# for compatibility
195
 
from bzrlib.revisiontree import RevisionTree
196
 
 
 
102
        
 
103
        
 
104
    def export(self, dest, format='dir', root=None):
 
105
        """Export this tree."""
 
106
        try:
 
107
            exporter = exporters[format]
 
108
        except KeyError:
 
109
            from bzrlib.errors import BzrCommandError
 
110
            raise BzrCommandError("export format %r not supported" % format)
 
111
        exporter(self, dest, root)
 
112
 
 
113
 
 
114
 
 
115
class RevisionTree(Tree):
 
116
    """Tree viewing a previous revision.
 
117
 
 
118
    File text can be retrieved from the text store.
 
119
 
 
120
    TODO: Some kind of `__repr__` method, but a good one
 
121
           probably means knowing the branch and revision number,
 
122
           or at least passing a description to the constructor.
 
123
    """
 
124
    
 
125
    def __init__(self, weave_store, inv, revision_id):
 
126
        self._weave_store = weave_store
 
127
        self._inventory = inv
 
128
        self._revision_id = revision_id
 
129
 
 
130
    def get_weave(self, file_id):
 
131
        return self._weave_store.get_weave(file_id)
 
132
 
 
133
 
 
134
    def get_file_lines(self, file_id):
 
135
        ie = self._inventory[file_id]
 
136
        weave = self.get_weave(file_id)
 
137
        return weave.get(ie.revision)
 
138
        
 
139
 
 
140
    def get_file_text(self, file_id):
 
141
        return ''.join(self.get_file_lines(file_id))
 
142
 
 
143
 
 
144
    def get_file(self, file_id):
 
145
        return StringIO(self.get_file_text(file_id))
 
146
 
 
147
    def get_file_size(self, file_id):
 
148
        return self._inventory[file_id].text_size
 
149
 
 
150
    def get_file_sha1(self, file_id):
 
151
        ie = self._inventory[file_id]
 
152
        if ie.kind == "file":
 
153
            return ie.text_sha1
 
154
 
 
155
    def is_executable(self, file_id):
 
156
        return self._inventory[file_id].executable
 
157
 
 
158
    def has_filename(self, filename):
 
159
        return bool(self.inventory.path2id(filename))
 
160
 
 
161
    def list_files(self):
 
162
        # The only files returned by this are those from the version
 
163
        for path, entry in self.inventory.iter_entries():
 
164
            yield path, 'V', entry.kind, entry.file_id, entry
 
165
 
 
166
    def get_symlink_target(self, file_id):
 
167
        ie = self._inventory[file_id]
 
168
        return ie.symlink_target;
 
169
 
197
170
 
198
171
class EmptyTree(Tree):
199
 
 
200
172
    def __init__(self):
201
173
        self._inventory = Inventory()
202
 
        warn('EmptyTree is deprecated as of bzr 0.9 please use '
203
 
            'repository.revision_tree instead.',
204
 
            DeprecationWarning, stacklevel=2)
205
 
 
206
 
    def get_parent_ids(self):
207
 
        return []
208
174
 
209
175
    def get_symlink_target(self, file_id):
210
176
        return None
212
178
    def has_filename(self, filename):
213
179
        return False
214
180
 
215
 
    def kind(self, file_id):
216
 
        assert self._inventory[file_id].kind == "directory"
217
 
        return "directory"
218
 
 
219
181
    def list_files(self):
220
182
        return iter([])
221
183
    
222
184
    def __contains__(self, file_id):
223
185
        return file_id in self._inventory
224
186
 
225
 
    def get_file_sha1(self, file_id, path=None):
 
187
    def get_file_sha1(self, file_id):
 
188
        assert self._inventory[file_id].kind == "root_directory"
226
189
        return None
227
190
 
228
191
 
291
254
            yield (old_name, new_name)
292
255
            
293
256
 
294
 
def find_ids_across_trees(filenames, trees, require_versioned=True):
295
 
    """Find the ids corresponding to specified filenames.
296
 
    
297
 
    All matches in all trees will be used, and all children of matched
298
 
    directories will be used.
299
 
 
300
 
    :param filenames: The filenames to find file_ids for
301
 
    :param trees: The trees to find file_ids within
302
 
    :param require_versioned: if true, all specified filenames must occur in
303
 
    at least one tree.
304
 
    :return: a set of file ids for the specified filenames and their children.
305
 
    """
306
 
    if not filenames:
307
 
        return None
308
 
    specified_ids = _find_filename_ids_across_trees(filenames, trees, 
309
 
                                                    require_versioned)
310
 
    return _find_children_across_trees(specified_ids, trees)
311
 
 
312
 
 
313
 
def _find_filename_ids_across_trees(filenames, trees, require_versioned):
314
 
    """Find the ids corresponding to specified filenames.
315
 
    
316
 
    All matches in all trees will be used.
317
 
 
318
 
    :param filenames: The filenames to find file_ids for
319
 
    :param trees: The trees to find file_ids within
320
 
    :param require_versioned: if true, all specified filenames must occur in
321
 
    at least one tree.
322
 
    :return: a set of file ids for the specified filenames
323
 
    """
324
 
    not_versioned = []
325
 
    interesting_ids = set()
326
 
    for tree_path in filenames:
327
 
        not_found = True
328
 
        for tree in trees:
329
 
            file_id = tree.inventory.path2id(tree_path)
330
 
            if file_id is not None:
331
 
                interesting_ids.add(file_id)
332
 
                not_found = False
333
 
        if not_found:
334
 
            not_versioned.append(tree_path)
335
 
    if len(not_versioned) > 0 and require_versioned:
336
 
        raise errors.PathsNotVersionedError(not_versioned)
337
 
    return interesting_ids
338
 
 
339
 
 
340
 
def _find_children_across_trees(specified_ids, trees):
341
 
    """Return a set including specified ids and their children
342
 
    
343
 
    All matches in all trees will be used.
344
 
 
345
 
    :param trees: The trees to find file_ids within
346
 
    :return: a set containing all specified ids and their children 
347
 
    """
348
 
    interesting_ids = set(specified_ids)
349
 
    pending = interesting_ids
350
 
    # now handle children of interesting ids
351
 
    # we loop so that we handle all children of each id in both trees
352
 
    while len(pending) > 0:
353
 
        new_pending = set()
354
 
        for file_id in pending:
355
 
            for tree in trees:
356
 
                if file_id not in tree:
357
 
                    continue
358
 
                entry = tree.inventory[file_id]
359
 
                for child in getattr(entry, 'children', {}).itervalues():
360
 
                    if child.file_id not in interesting_ids:
361
 
                        new_pending.add(child.file_id)
362
 
        interesting_ids.update(new_pending)
363
 
        pending = new_pending
364
 
    return interesting_ids
365
 
 
366
 
 
367
 
class InterTree(InterObject):
368
 
    """This class represents operations taking place between two Trees.
369
 
 
370
 
    Its instances have methods like 'compare' and contain references to the
371
 
    source and target trees these operations are to be carried out on.
372
 
 
373
 
    clients of bzrlib should not need to use InterTree directly, rather they
374
 
    should use the convenience methods on Tree such as 'Tree.compare()' which
375
 
    will pass through to InterTree as appropriate.
376
 
    """
377
 
 
378
 
    _optimisers = set()
379
 
 
380
 
    @needs_read_lock
381
 
    def compare(self, want_unchanged=False, specific_files=None,
382
 
        extra_trees=None, require_versioned=False):
383
 
        """Return the changes from source to target.
384
 
 
385
 
        :return: A TreeDelta.
386
 
        :param specific_files: An optional list of file paths to restrict the
387
 
            comparison to. When mapping filenames to ids, all matches in all
388
 
            trees (including optional extra_trees) are used, and all children of
389
 
            matched directories are included.
390
 
        :param want_unchanged: An optional boolean requesting the inclusion of
391
 
            unchanged entries in the result.
392
 
        :param extra_trees: An optional list of additional trees to use when
393
 
            mapping the contents of specific_files (paths) to file_ids.
394
 
        :param require_versioned: An optional boolean (defaults to False). When
395
 
            supplied and True all the 'specific_files' must be versioned, or
396
 
            a PathsNotVersionedError will be thrown.
397
 
        """
398
 
        # NB: show_status depends on being able to pass in non-versioned files and
399
 
        # report them as unknown
400
 
        trees = (self.source, self.target)
401
 
        if extra_trees is not None:
402
 
            trees = trees + tuple(extra_trees)
403
 
        specific_file_ids = find_ids_across_trees(specific_files,
404
 
            trees, require_versioned=require_versioned)
405
 
        if specific_files and not specific_file_ids:
406
 
            # All files are unversioned, so just return an empty delta
407
 
            # _compare_trees would think we want a complete delta
408
 
            return delta.TreeDelta()
409
 
        return delta._compare_trees(self.source, self.target, want_unchanged,
410
 
            specific_file_ids)
 
257
 
 
258
######################################################################
 
259
# export
 
260
 
 
261
def dir_exporter(tree, dest, root):
 
262
    """Export this tree to a new directory.
 
263
 
 
264
    `dest` should not exist, and will be created holding the
 
265
    contents of this tree.
 
266
 
 
267
    TODO: To handle subdirectories we need to create the
 
268
           directories first.
 
269
 
 
270
    :note: If the export fails, the destination directory will be
 
271
           left in a half-assed state.
 
272
    """
 
273
    import os
 
274
    os.mkdir(dest)
 
275
    mutter('export version %r' % tree)
 
276
    inv = tree.inventory
 
277
    for dp, ie in inv.iter_entries():
 
278
        ie.put_on_disk(dest, dp, tree)
 
279
 
 
280
exporters['dir'] = dir_exporter
 
281
 
 
282
try:
 
283
    import tarfile
 
284
except ImportError:
 
285
    pass
 
286
else:
 
287
    def get_root_name(dest):
 
288
        """Get just the root name for a tarball.
 
289
 
 
290
        >>> get_root_name('mytar.tar')
 
291
        'mytar'
 
292
        >>> get_root_name('mytar.tar.bz2')
 
293
        'mytar'
 
294
        >>> get_root_name('tar.tar.tar.tgz')
 
295
        'tar.tar.tar'
 
296
        >>> get_root_name('bzr-0.0.5.tar.gz')
 
297
        'bzr-0.0.5'
 
298
        >>> get_root_name('a/long/path/mytar.tgz')
 
299
        'mytar'
 
300
        >>> get_root_name('../parent/../dir/other.tbz2')
 
301
        'other'
 
302
        """
 
303
        endings = ['.tar', '.tar.gz', '.tgz', '.tar.bz2', '.tbz2']
 
304
        dest = os.path.basename(dest)
 
305
        for end in endings:
 
306
            if dest.endswith(end):
 
307
                return dest[:-len(end)]
 
308
 
 
309
    def tar_exporter(tree, dest, root, compression=None):
 
310
        """Export this tree to a new tar file.
 
311
 
 
312
        `dest` will be created holding the contents of this tree; if it
 
313
        already exists, it will be clobbered, like with "tar -c".
 
314
        """
 
315
        from time import time
 
316
        now = time()
 
317
        compression = str(compression or '')
 
318
        if root is None:
 
319
            root = get_root_name(dest)
 
320
        try:
 
321
            ball = tarfile.open(dest, 'w:' + compression)
 
322
        except tarfile.CompressionError, e:
 
323
            raise BzrError(str(e))
 
324
        mutter('export version %r' % tree)
 
325
        inv = tree.inventory
 
326
        for dp, ie in inv.iter_entries():
 
327
            mutter("  export {%s} kind %s to %s" % (ie.file_id, ie.kind, dest))
 
328
            item, fileobj = ie.get_tar_item(root, dp, now, tree)
 
329
            ball.addfile(item, fileobj)
 
330
        ball.close()
 
331
 
 
332
    exporters['tar'] = tar_exporter
 
333
 
 
334
    def tgz_exporter(tree, dest, root):
 
335
        tar_exporter(tree, dest, root, compression='gz')
 
336
    exporters['tgz'] = tgz_exporter
 
337
 
 
338
    def tbz_exporter(tree, dest, root):
 
339
        tar_exporter(tree, dest, root, compression='bz2')
 
340
    exporters['tbz2'] = tbz_exporter