~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tree.py

  • Committer: Robert Collins
  • Date: 2005-10-11 07:00:25 UTC
  • mto: This revision was merged to the branch mainline in revision 1443.
  • Revision ID: robertc@robertcollins.net-20051011070025-bac6b53cb6186dfd
create a config module - there is enough config logic to make this worthwhile, and start testing config processing.

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
        # FIXME: RevisionTree should be given a branch
 
132
        # not a store, or the store should know the branch.
 
133
        import bzrlib.transactions as transactions
 
134
        return self._weave_store.get_weave(file_id,
 
135
            transactions.PassThroughTransaction())
 
136
 
 
137
 
 
138
    def get_file_lines(self, file_id):
 
139
        ie = self._inventory[file_id]
 
140
        weave = self.get_weave(file_id)
 
141
        return weave.get(ie.revision)
 
142
        
 
143
 
 
144
    def get_file_text(self, file_id):
 
145
        return ''.join(self.get_file_lines(file_id))
 
146
 
 
147
 
 
148
    def get_file(self, file_id):
 
149
        return StringIO(self.get_file_text(file_id))
 
150
 
 
151
    def get_file_size(self, file_id):
 
152
        return self._inventory[file_id].text_size
 
153
 
 
154
    def get_file_sha1(self, file_id):
 
155
        ie = self._inventory[file_id]
 
156
        if ie.kind == "file":
 
157
            return ie.text_sha1
 
158
 
 
159
    def is_executable(self, file_id):
 
160
        return self._inventory[file_id].executable
 
161
 
 
162
    def has_filename(self, filename):
 
163
        return bool(self.inventory.path2id(filename))
 
164
 
 
165
    def list_files(self):
 
166
        # The only files returned by this are those from the version
 
167
        for path, entry in self.inventory.iter_entries():
 
168
            yield path, 'V', entry.kind, entry.file_id, entry
 
169
 
 
170
    def get_symlink_target(self, file_id):
 
171
        ie = self._inventory[file_id]
 
172
        return ie.symlink_target;
 
173
 
197
174
 
198
175
class EmptyTree(Tree):
199
 
 
200
176
    def __init__(self):
201
177
        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
178
 
209
179
    def get_symlink_target(self, file_id):
210
180
        return None
212
182
    def has_filename(self, filename):
213
183
        return False
214
184
 
215
 
    def kind(self, file_id):
216
 
        assert self._inventory[file_id].kind == "root_directory"
217
 
        return "root_directory"
218
 
 
219
185
    def list_files(self):
220
186
        return iter([])
221
187
    
222
188
    def __contains__(self, file_id):
223
189
        return file_id in self._inventory
224
190
 
225
 
    def get_file_sha1(self, file_id, path=None):
 
191
    def get_file_sha1(self, file_id):
226
192
        assert self._inventory[file_id].kind == "root_directory"
227
193
        return None
228
194
 
292
258
            yield (old_name, new_name)
293
259
            
294
260
 
295
 
def find_ids_across_trees(filenames, trees, require_versioned=True):
296
 
    """Find the ids corresponding to specified filenames.
297
 
    
298
 
    All matches in all trees will be used, and all children of matched
299
 
    directories will be used.
300
 
 
301
 
    :param filenames: The filenames to find file_ids for
302
 
    :param trees: The trees to find file_ids within
303
 
    :param require_versioned: if true, all specified filenames must occur in
304
 
    at least one tree.
305
 
    :return: a set of file ids for the specified filenames and their children.
306
 
    """
307
 
    if not filenames:
308
 
        return None
309
 
    specified_ids = _find_filename_ids_across_trees(filenames, trees, 
310
 
                                                    require_versioned)
311
 
    return _find_children_across_trees(specified_ids, trees)
312
 
 
313
 
 
314
 
def _find_filename_ids_across_trees(filenames, trees, require_versioned):
315
 
    """Find the ids corresponding to specified filenames.
316
 
    
317
 
    All matches in all trees will be used.
318
 
 
319
 
    :param filenames: The filenames to find file_ids for
320
 
    :param trees: The trees to find file_ids within
321
 
    :param require_versioned: if true, all specified filenames must occur in
322
 
    at least one tree.
323
 
    :return: a set of file ids for the specified filenames
324
 
    """
325
 
    not_versioned = []
326
 
    interesting_ids = set()
327
 
    for tree_path in filenames:
328
 
        not_found = True
329
 
        for tree in trees:
330
 
            file_id = tree.inventory.path2id(tree_path)
331
 
            if file_id is not None:
332
 
                interesting_ids.add(file_id)
333
 
                not_found = False
334
 
        if not_found:
335
 
            not_versioned.append(tree_path)
336
 
    if len(not_versioned) > 0 and require_versioned:
337
 
        raise errors.PathsNotVersionedError(not_versioned)
338
 
    return interesting_ids
339
 
 
340
 
 
341
 
def _find_children_across_trees(specified_ids, trees):
342
 
    """Return a set including specified ids and their children
343
 
    
344
 
    All matches in all trees will be used.
345
 
 
346
 
    :param trees: The trees to find file_ids within
347
 
    :return: a set containing all specified ids and their children 
348
 
    """
349
 
    interesting_ids = set(specified_ids)
350
 
    pending = interesting_ids
351
 
    # now handle children of interesting ids
352
 
    # we loop so that we handle all children of each id in both trees
353
 
    while len(pending) > 0:
354
 
        new_pending = set()
355
 
        for file_id in pending:
356
 
            for tree in trees:
357
 
                if file_id not in tree:
358
 
                    continue
359
 
                entry = tree.inventory[file_id]
360
 
                for child in getattr(entry, 'children', {}).itervalues():
361
 
                    if child.file_id not in interesting_ids:
362
 
                        new_pending.add(child.file_id)
363
 
        interesting_ids.update(new_pending)
364
 
        pending = new_pending
365
 
    return interesting_ids
366
 
 
367
 
 
368
 
class InterTree(InterObject):
369
 
    """This class represents operations taking place between two Trees.
370
 
 
371
 
    Its instances have methods like 'compare' and contain references to the
372
 
    source and target trees these operations are to be carried out on.
373
 
 
374
 
    clients of bzrlib should not need to use InterTree directly, rather they
375
 
    should use the convenience methods on Tree such as 'Tree.compare()' which
376
 
    will pass through to InterTree as appropriate.
377
 
    """
378
 
 
379
 
    _optimisers = set()
380
 
 
381
 
    @needs_read_lock
382
 
    def compare(self, want_unchanged=False, specific_files=None,
383
 
        extra_trees=None, require_versioned=False):
384
 
        """Return the changes from source to target.
385
 
 
386
 
        :return: A TreeDelta.
387
 
        :param specific_files: An optional list of file paths to restrict the
388
 
            comparison to. When mapping filenames to ids, all matches in all
389
 
            trees (including optional extra_trees) are used, and all children of
390
 
            matched directories are included.
391
 
        :param want_unchanged: An optional boolean requesting the inclusion of
392
 
            unchanged entries in the result.
393
 
        :param extra_trees: An optional list of additional trees to use when
394
 
            mapping the contents of specific_files (paths) to file_ids.
395
 
        :param require_versioned: An optional boolean (defaults to False). When
396
 
            supplied and True all the 'specific_files' must be versioned, or
397
 
            a PathsNotVersionedError will be thrown.
398
 
        """
399
 
        # NB: show_status depends on being able to pass in non-versioned files and
400
 
        # report them as unknown
401
 
        trees = (self.source, self.target)
402
 
        if extra_trees is not None:
403
 
            trees = trees + tuple(extra_trees)
404
 
        specific_file_ids = find_ids_across_trees(specific_files,
405
 
            trees, require_versioned=require_versioned)
406
 
        if specific_files and not specific_file_ids:
407
 
            # All files are unversioned, so just return an empty delta
408
 
            # _compare_trees would think we want a complete delta
409
 
            return delta.TreeDelta()
410
 
        return delta._compare_trees(self.source, self.target, want_unchanged,
411
 
            specific_file_ids)
 
261
 
 
262
######################################################################
 
263
# export
 
264
 
 
265
def dir_exporter(tree, dest, root):
 
266
    """Export this tree to a new directory.
 
267
 
 
268
    `dest` should not exist, and will be created holding the
 
269
    contents of this tree.
 
270
 
 
271
    TODO: To handle subdirectories we need to create the
 
272
           directories first.
 
273
 
 
274
    :note: If the export fails, the destination directory will be
 
275
           left in a half-assed state.
 
276
    """
 
277
    import os
 
278
    os.mkdir(dest)
 
279
    mutter('export version %r' % tree)
 
280
    inv = tree.inventory
 
281
    for dp, ie in inv.iter_entries():
 
282
        ie.put_on_disk(dest, dp, tree)
 
283
 
 
284
exporters['dir'] = dir_exporter
 
285
 
 
286
try:
 
287
    import tarfile
 
288
except ImportError:
 
289
    pass
 
290
else:
 
291
    def get_root_name(dest):
 
292
        """Get just the root name for a tarball.
 
293
 
 
294
        >>> get_root_name('mytar.tar')
 
295
        'mytar'
 
296
        >>> get_root_name('mytar.tar.bz2')
 
297
        'mytar'
 
298
        >>> get_root_name('tar.tar.tar.tgz')
 
299
        'tar.tar.tar'
 
300
        >>> get_root_name('bzr-0.0.5.tar.gz')
 
301
        'bzr-0.0.5'
 
302
        >>> get_root_name('a/long/path/mytar.tgz')
 
303
        'mytar'
 
304
        >>> get_root_name('../parent/../dir/other.tbz2')
 
305
        'other'
 
306
        """
 
307
        endings = ['.tar', '.tar.gz', '.tgz', '.tar.bz2', '.tbz2']
 
308
        dest = os.path.basename(dest)
 
309
        for end in endings:
 
310
            if dest.endswith(end):
 
311
                return dest[:-len(end)]
 
312
 
 
313
    def tar_exporter(tree, dest, root, compression=None):
 
314
        """Export this tree to a new tar file.
 
315
 
 
316
        `dest` will be created holding the contents of this tree; if it
 
317
        already exists, it will be clobbered, like with "tar -c".
 
318
        """
 
319
        from time import time
 
320
        now = time()
 
321
        compression = str(compression or '')
 
322
        if root is None:
 
323
            root = get_root_name(dest)
 
324
        try:
 
325
            ball = tarfile.open(dest, 'w:' + compression)
 
326
        except tarfile.CompressionError, e:
 
327
            raise BzrError(str(e))
 
328
        mutter('export version %r' % tree)
 
329
        inv = tree.inventory
 
330
        for dp, ie in inv.iter_entries():
 
331
            mutter("  export {%s} kind %s to %s" % (ie.file_id, ie.kind, dest))
 
332
            item, fileobj = ie.get_tar_item(root, dp, now, tree)
 
333
            ball.addfile(item, fileobj)
 
334
        ball.close()
 
335
 
 
336
    exporters['tar'] = tar_exporter
 
337
 
 
338
    def tgz_exporter(tree, dest, root):
 
339
        tar_exporter(tree, dest, root, compression='gz')
 
340
    exporters['tgz'] = tgz_exporter
 
341
 
 
342
    def tbz_exporter(tree, dest, root):
 
343
        tar_exporter(tree, dest, root, compression='bz2')
 
344
    exporters['tbz2'] = tbz_exporter