~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tree.py

  • Committer: Andrew Bennetts
  • Date: 2007-09-28 04:40:46 UTC
  • mto: This revision was merged to the branch mainline in revision 2905.
  • Revision ID: andrew.bennetts@canonical.com-20070928044046-fyl5mq8gszi78g5y
Deprecate revision_ids arg to Repository.check and other tweaks.

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
17
17
"""Tree classes, representing directory at point in time.
18
18
"""
19
19
 
20
 
from osutils import pumpfile, appendpath, fingerprint_file
21
20
import os
 
21
from collections import deque
 
22
from cStringIO import StringIO
22
23
 
 
24
import bzrlib
 
25
from bzrlib import (
 
26
    delta,
 
27
    osutils,
 
28
    revision as _mod_revision,
 
29
    conflicts as _mod_conflicts,
 
30
    symbol_versioning,
 
31
    )
 
32
from bzrlib.decorators import needs_read_lock
 
33
from bzrlib.errors import BzrError, BzrCheckError
 
34
from bzrlib import errors
 
35
from bzrlib.inventory import Inventory, InventoryFile
 
36
from bzrlib.inter import InterObject
 
37
from bzrlib.osutils import fingerprint_file
 
38
import bzrlib.revision
23
39
from bzrlib.trace import mutter, note
24
 
from bzrlib.errors import BzrError
25
 
 
26
 
import bzrlib
27
 
 
28
 
exporters = {}
 
40
 
29
41
 
30
42
class Tree(object):
31
43
    """Abstract file tree.
36
48
 
37
49
    * `RevisionTree` is a tree as recorded at some point in the past.
38
50
 
39
 
    * `EmptyTree`
40
 
 
41
51
    Trees contain an `Inventory` object, and also know how to retrieve
42
52
    file texts mentioned in the inventory, either from a working
43
53
    directory or from a store.
49
59
    trees or versioned trees.
50
60
    """
51
61
    
 
62
    def changes_from(self, other, want_unchanged=False, specific_files=None,
 
63
        extra_trees=None, require_versioned=False, include_root=False,
 
64
        want_unversioned=False):
 
65
        """Return a TreeDelta of the changes from other to this tree.
 
66
 
 
67
        :param other: A tree to compare with.
 
68
        :param specific_files: An optional list of file paths to restrict the
 
69
            comparison to. When mapping filenames to ids, all matches in all
 
70
            trees (including optional extra_trees) are used, and all children of
 
71
            matched directories are included.
 
72
        :param want_unchanged: An optional boolean requesting the inclusion of
 
73
            unchanged entries in the result.
 
74
        :param extra_trees: An optional list of additional trees to use when
 
75
            mapping the contents of specific_files (paths) to file_ids.
 
76
        :param require_versioned: An optional boolean (defaults to False). When
 
77
            supplied and True all the 'specific_files' must be versioned, or
 
78
            a PathsNotVersionedError will be thrown.
 
79
        :param want_unversioned: Scan for unversioned paths.
 
80
 
 
81
        The comparison will be performed by an InterTree object looked up on 
 
82
        self and other.
 
83
        """
 
84
        # Martin observes that Tree.changes_from returns a TreeDelta and this
 
85
        # may confuse people, because the class name of the returned object is
 
86
        # a synonym of the object referenced in the method name.
 
87
        return InterTree.get(other, self).compare(
 
88
            want_unchanged=want_unchanged,
 
89
            specific_files=specific_files,
 
90
            extra_trees=extra_trees,
 
91
            require_versioned=require_versioned,
 
92
            include_root=include_root,
 
93
            want_unversioned=want_unversioned,
 
94
            )
 
95
 
 
96
    def _iter_changes(self, from_tree, include_unchanged=False,
 
97
                     specific_files=None, pb=None, extra_trees=None,
 
98
                     require_versioned=True, want_unversioned=False):
 
99
        intertree = InterTree.get(from_tree, self)
 
100
        return intertree._iter_changes(include_unchanged, specific_files, pb,
 
101
            extra_trees, require_versioned, want_unversioned=want_unversioned)
 
102
    
 
103
    def conflicts(self):
 
104
        """Get a list of the conflicts in the tree.
 
105
 
 
106
        Each conflict is an instance of bzrlib.conflicts.Conflict.
 
107
        """
 
108
        return _mod_conflicts.ConflictList()
 
109
 
 
110
    def extras(self):
 
111
        """For trees that can have unversioned files, return all such paths."""
 
112
        return []
 
113
 
 
114
    def get_parent_ids(self):
 
115
        """Get the parent ids for this tree. 
 
116
 
 
117
        :return: a list of parent ids. [] is returned to indicate
 
118
        a tree with no parents.
 
119
        :raises: BzrError if the parents are not known.
 
120
        """
 
121
        raise NotImplementedError(self.get_parent_ids)
 
122
    
52
123
    def has_filename(self, filename):
53
124
        """True if the tree has given filename."""
54
 
        raise NotImplementedError()
 
125
        raise NotImplementedError(self.has_filename)
55
126
 
56
127
    def has_id(self, file_id):
 
128
        file_id = osutils.safe_file_id(file_id)
57
129
        return self.inventory.has_id(file_id)
58
130
 
59
131
    __contains__ = has_id
60
132
 
 
133
    def has_or_had_id(self, file_id):
 
134
        file_id = osutils.safe_file_id(file_id)
 
135
        if file_id == self.inventory.root.file_id:
 
136
            return True
 
137
        return self.inventory.has_id(file_id)
 
138
 
 
139
    def is_ignored(self, filename):
 
140
        """Check whether the filename is ignored by this tree.
 
141
 
 
142
        :param filename: The relative filename within the tree.
 
143
        :return: True if the filename is ignored.
 
144
        """
 
145
        return False
 
146
 
61
147
    def __iter__(self):
62
148
        return iter(self.inventory)
63
149
 
64
150
    def id2path(self, file_id):
 
151
        """Return the path for a file id.
 
152
 
 
153
        :raises NoSuchId:
 
154
        """
 
155
        file_id = osutils.safe_file_id(file_id)
65
156
        return self.inventory.id2path(file_id)
66
157
 
 
158
    def is_control_filename(self, filename):
 
159
        """True if filename is the name of a control file in this tree.
 
160
        
 
161
        :param filename: A filename within the tree. This is a relative path
 
162
        from the root of this tree.
 
163
 
 
164
        This is true IF and ONLY IF the filename is part of the meta data
 
165
        that bzr controls in this tree. I.E. a random .bzr directory placed
 
166
        on disk will not be a control file for this tree.
 
167
        """
 
168
        return self.bzrdir.is_control_filename(filename)
 
169
 
 
170
    @needs_read_lock
 
171
    def iter_entries_by_dir(self, specific_file_ids=None):
 
172
        """Walk the tree in 'by_dir' order.
 
173
 
 
174
        This will yield each entry in the tree as a (path, entry) tuple. The
 
175
        order that they are yielded is: the contents of a directory are 
 
176
        preceeded by the parent of a directory, and all the contents of a 
 
177
        directory are grouped together.
 
178
        """
 
179
        return self.inventory.iter_entries_by_dir(
 
180
            specific_file_ids=specific_file_ids)
 
181
 
 
182
    def iter_references(self):
 
183
        for path, entry in self.iter_entries_by_dir():
 
184
            if entry.kind == 'tree-reference':
 
185
                yield path, entry.file_id
 
186
 
 
187
    def kind(self, file_id):
 
188
        raise NotImplementedError("Tree subclass %s must implement kind"
 
189
            % self.__class__.__name__)
 
190
 
 
191
    def get_reference_revision(self, file_id, path=None):
 
192
        raise NotImplementedError("Tree subclass %s must implement "
 
193
                                  "get_reference_revision"
 
194
            % self.__class__.__name__)
 
195
 
 
196
    def _comparison_data(self, entry, path):
 
197
        """Return a tuple of kind, executable, stat_value for a file.
 
198
 
 
199
        entry may be None if there is no inventory entry for the file, but
 
200
        path must always be supplied.
 
201
 
 
202
        kind is None if there is no file present (even if an inventory id is
 
203
        present).  executable is False for non-file entries.
 
204
        """
 
205
        raise NotImplementedError(self._comparison_data)
 
206
 
 
207
    def _file_size(self, entry, stat_value):
 
208
        raise NotImplementedError(self._file_size)
 
209
 
67
210
    def _get_inventory(self):
68
211
        return self._inventory
 
212
    
 
213
    def get_file(self, file_id, path=None):
 
214
        """Return a file object for the file file_id in the tree.
 
215
        
 
216
        If both file_id and path are defined, it is implementation defined as
 
217
        to which one is used.
 
218
        """
 
219
        raise NotImplementedError(self.get_file)
 
220
 
 
221
    def get_file_mtime(self, file_id, path=None):
 
222
        """Return the modification time for a file.
 
223
 
 
224
        :param file_id: The handle for this file.
 
225
        :param path: The path that this file can be found at.
 
226
            These must point to the same object.
 
227
        """
 
228
        raise NotImplementedError(self.get_file_mtime)
 
229
 
 
230
    def get_file_by_path(self, path):
 
231
        return self.get_file(self._inventory.path2id(path), path)
 
232
 
 
233
    def iter_files_bytes(self, desired_files):
 
234
        """Iterate through file contents.
 
235
 
 
236
        Files will not necessarily be returned in the order they occur in
 
237
        desired_files.  No specific order is guaranteed.
 
238
 
 
239
        Yields pairs of identifier, bytes_iterator.  identifier is an opaque
 
240
        value supplied by the caller as part of desired_files.  It should
 
241
        uniquely identify the file version in the caller's context.  (Examples:
 
242
        an index number or a TreeTransform trans_id.)
 
243
 
 
244
        bytes_iterator is an iterable of bytestrings for the file.  The
 
245
        kind of iterable and length of the bytestrings are unspecified, but for
 
246
        this implementation, it is a tuple containing a single bytestring with
 
247
        the complete text of the file.
 
248
 
 
249
        :param desired_files: a list of (file_id, identifier) pairs
 
250
        """
 
251
        for file_id, identifier in desired_files:
 
252
            # We wrap the string in a tuple so that we can return an iterable
 
253
            # of bytestrings.  (Technically, a bytestring is also an iterable
 
254
            # of bytestrings, but iterating through each character is not
 
255
            # performant.)
 
256
            cur_file = (self.get_file_text(file_id),)
 
257
            yield identifier, cur_file
 
258
 
 
259
    def get_symlink_target(self, file_id):
 
260
        """Get the target for a given file_id.
 
261
 
 
262
        It is assumed that the caller already knows that file_id is referencing
 
263
        a symlink.
 
264
        :param file_id: Handle for the symlink entry.
 
265
        :return: The path the symlink points to.
 
266
        """
 
267
        raise NotImplementedError(self.get_symlink_target)
 
268
 
 
269
    def annotate_iter(self, file_id):
 
270
        """Return an iterator of revision_id, line tuples.
 
271
 
 
272
        For working trees (and mutable trees in general), the special
 
273
        revision_id 'current:' will be used for lines that are new in this
 
274
        tree, e.g. uncommitted changes.
 
275
        :param file_id: The file to produce an annotated version from
 
276
        """
 
277
        raise NotImplementedError(self.annotate_iter)
 
278
 
 
279
    def plan_file_merge(self, file_id, other):
 
280
        """Generate a merge plan based on annotations.
 
281
 
 
282
        If the file contains uncommitted changes in this tree, they will be
 
283
        attributed to the 'current:' pseudo-revision.  If the file contains
 
284
        uncommitted changes in the other tree, they will be assigned to the
 
285
        'other:' pseudo-revision.
 
286
        """
 
287
        from bzrlib import merge
 
288
        annotated_a = list(self.annotate_iter(file_id,
 
289
                                              _mod_revision.CURRENT_REVISION))
 
290
        annotated_b = list(other.annotate_iter(file_id, 'other:'))
 
291
        ancestors_a = self._get_ancestors(_mod_revision.CURRENT_REVISION)
 
292
        ancestors_b = other._get_ancestors('other:')
 
293
        return merge._plan_annotate_merge(annotated_a, annotated_b,
 
294
                                          ancestors_a, ancestors_b)
69
295
 
70
296
    inventory = property(_get_inventory,
71
297
                         doc="Inventory of this Tree")
72
298
 
73
299
    def _check_retrieved(self, ie, f):
 
300
        if not __debug__:
 
301
            return  
74
302
        fp = fingerprint_file(f)
75
303
        f.seek(0)
76
304
        
77
 
        if ie.text_size != None:
 
305
        if ie.text_size is not None:
78
306
            if ie.text_size != fp['size']:
79
307
                raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
80
308
                        ["inventory expects %d bytes" % ie.text_size,
87
315
                     "file is actually %s" % fp['sha1'],
88
316
                     "store is probably damaged/corrupt"])
89
317
 
90
 
 
91
 
    def print_file(self, fileid):
92
 
        """Print file with id `fileid` to stdout."""
 
318
    @needs_read_lock
 
319
    def path2id(self, path):
 
320
        """Return the id for path in this tree."""
 
321
        return self._inventory.path2id(path)
 
322
 
 
323
    def paths2ids(self, paths, trees=[], require_versioned=True):
 
324
        """Return all the ids that can be reached by walking from paths.
 
325
        
 
326
        Each path is looked up in this tree and any extras provided in
 
327
        trees, and this is repeated recursively: the children in an extra tree
 
328
        of a directory that has been renamed under a provided path in this tree
 
329
        are all returned, even if none exist under a provided path in this
 
330
        tree, and vice versa.
 
331
 
 
332
        :param paths: An iterable of paths to start converting to ids from.
 
333
            Alternatively, if paths is None, no ids should be calculated and None
 
334
            will be returned. This is offered to make calling the api unconditional
 
335
            for code that *might* take a list of files.
 
336
        :param trees: Additional trees to consider.
 
337
        :param require_versioned: If False, do not raise NotVersionedError if
 
338
            an element of paths is not versioned in this tree and all of trees.
 
339
        """
 
340
        return find_ids_across_trees(paths, [self] + list(trees), require_versioned)
 
341
 
 
342
    def print_file(self, file_id):
 
343
        """Print file with id `file_id` to stdout."""
 
344
        file_id = osutils.safe_file_id(file_id)
93
345
        import sys
94
 
        pumpfile(self.get_file(fileid), sys.stdout)
95
 
        
96
 
        
97
 
    def export(self, dest, format='dir', root=None):
98
 
        """Export this tree."""
99
 
        try:
100
 
            exporter = exporters[format]
101
 
        except KeyError:
102
 
            from bzrlib.errors import BzrCommandError
103
 
            raise BzrCommandError("export format %r not supported" % format)
104
 
        exporter(self, dest, root)
105
 
 
106
 
 
107
 
 
108
 
class RevisionTree(Tree):
109
 
    """Tree viewing a previous revision.
110
 
 
111
 
    File text can be retrieved from the text store.
112
 
 
113
 
    TODO: Some kind of `__repr__` method, but a good one
114
 
           probably means knowing the branch and revision number,
115
 
           or at least passing a description to the constructor.
116
 
    """
117
 
    
118
 
    def __init__(self, store, inv):
119
 
        self._store = store
120
 
        self._inventory = inv
121
 
 
122
 
    def get_file(self, file_id):
123
 
        ie = self._inventory[file_id]
124
 
        f = self._store[ie.text_id]
125
 
        mutter("  get fileid{%s} from %r" % (file_id, self))
126
 
        self._check_retrieved(ie, f)
127
 
        return f
128
 
 
129
 
    def get_file_size(self, file_id):
130
 
        return self._inventory[file_id].text_size
131
 
 
132
 
    def get_file_sha1(self, file_id):
133
 
        ie = self._inventory[file_id]
134
 
        return ie.text_sha1
135
 
 
136
 
    def has_filename(self, filename):
137
 
        return bool(self.inventory.path2id(filename))
138
 
 
139
 
    def list_files(self):
140
 
        # The only files returned by this are those from the version
141
 
        for path, entry in self.inventory.iter_entries():
142
 
            yield path, 'V', entry.kind, entry.file_id
 
346
        sys.stdout.write(self.get_file_text(file_id))
 
347
 
 
348
    def lock_read(self):
 
349
        pass
 
350
 
 
351
    def revision_tree(self, revision_id):
 
352
        """Obtain a revision tree for the revision revision_id.
 
353
 
 
354
        The intention of this method is to allow access to possibly cached
 
355
        tree data. Implementors of this method should raise NoSuchRevision if
 
356
        the tree is not locally available, even if they could obtain the 
 
357
        tree via a repository or some other means. Callers are responsible 
 
358
        for finding the ultimate source for a revision tree.
 
359
 
 
360
        :param revision_id: The revision_id of the requested tree.
 
361
        :return: A Tree.
 
362
        :raises: NoSuchRevision if the tree cannot be obtained.
 
363
        """
 
364
        raise errors.NoSuchRevisionInTree(self, revision_id)
 
365
 
 
366
    def unknowns(self):
 
367
        """What files are present in this tree and unknown.
 
368
        
 
369
        :return: an iterator over the unknown files.
 
370
        """
 
371
        return iter([])
 
372
 
 
373
    def unlock(self):
 
374
        pass
 
375
 
 
376
    def filter_unversioned_files(self, paths):
 
377
        """Filter out paths that are versioned.
 
378
 
 
379
        :return: set of paths.
 
380
        """
 
381
        # NB: we specifically *don't* call self.has_filename, because for
 
382
        # WorkingTrees that can indicate files that exist on disk but that 
 
383
        # are not versioned.
 
384
        pred = self.inventory.has_filename
 
385
        return set((p for p in paths if not pred(p)))
 
386
 
 
387
    def walkdirs(self, prefix=""):
 
388
        """Walk the contents of this tree from path down.
 
389
 
 
390
        This yields all the data about the contents of a directory at a time.
 
391
        After each directory has been yielded, if the caller has mutated the
 
392
        list to exclude some directories, they are then not descended into.
 
393
        
 
394
        The data yielded is of the form:
 
395
        ((directory-relpath, directory-path-from-root, directory-fileid),
 
396
        [(relpath, basename, kind, lstat, path_from_tree_root, file_id, 
 
397
          versioned_kind), ...]),
 
398
         - directory-relpath is the containing dirs relpath from prefix
 
399
         - directory-path-from-root is the containing dirs path from /
 
400
         - directory-fileid is the id of the directory if it is versioned.
 
401
         - relpath is the relative path within the subtree being walked.
 
402
         - basename is the basename
 
403
         - kind is the kind of the file now. If unknonwn then the file is not
 
404
           present within the tree - but it may be recorded as versioned. See
 
405
           versioned_kind.
 
406
         - lstat is the stat data *if* the file was statted.
 
407
         - path_from_tree_root is the path from the root of the tree.
 
408
         - file_id is the file_id if the entry is versioned.
 
409
         - versioned_kind is the kind of the file as last recorded in the 
 
410
           versioning system. If 'unknown' the file is not versioned.
 
411
        One of 'kind' and 'versioned_kind' must not be 'unknown'.
 
412
 
 
413
        :param prefix: Start walking from prefix within the tree rather than
 
414
        at the root. This allows one to walk a subtree but get paths that are
 
415
        relative to a tree rooted higher up.
 
416
        :return: an iterator over the directory data.
 
417
        """
 
418
        raise NotImplementedError(self.walkdirs)
143
419
 
144
420
 
145
421
class EmptyTree(Tree):
146
 
    def __init__(self, root_id):
147
 
        from bzrlib.inventory import Inventory
148
 
        self._inventory = Inventory(root_id)
 
422
 
 
423
    def __init__(self):
 
424
        self._inventory = Inventory(root_id=None)
 
425
        symbol_versioning.warn('EmptyTree is deprecated as of bzr 0.9 please'
 
426
                               ' use repository.revision_tree instead.',
 
427
                               DeprecationWarning, stacklevel=2)
 
428
 
 
429
    def get_parent_ids(self):
 
430
        return []
 
431
 
 
432
    def get_symlink_target(self, file_id):
 
433
        return None
149
434
 
150
435
    def has_filename(self, filename):
151
436
        return False
152
437
 
153
 
    def list_files(self):
154
 
        if False:  # just to make it a generator
155
 
            yield None
 
438
    def kind(self, file_id):
 
439
        file_id = osutils.safe_file_id(file_id)
 
440
        assert self._inventory[file_id].kind == "directory"
 
441
        return "directory"
 
442
 
 
443
    def list_files(self, include_root=False):
 
444
        return iter([])
156
445
    
 
446
    def __contains__(self, file_id):
 
447
        file_id = osutils.safe_file_id(file_id)
 
448
        return (file_id in self._inventory)
 
449
 
 
450
    def get_file_sha1(self, file_id, path=None, stat_value=None):
 
451
        return None
157
452
 
158
453
 
159
454
######################################################################
221
516
            yield (old_name, new_name)
222
517
            
223
518
 
224
 
 
225
 
######################################################################
226
 
# export
227
 
 
228
 
def dir_exporter(tree, dest, root):
229
 
    """Export this tree to a new directory.
230
 
 
231
 
    `dest` should not exist, and will be created holding the
232
 
    contents of this tree.
233
 
 
234
 
    TODO: To handle subdirectories we need to create the
235
 
           directories first.
236
 
 
237
 
    :note: If the export fails, the destination directory will be
238
 
           left in a half-assed state.
239
 
    """
240
 
    import os
241
 
    os.mkdir(dest)
242
 
    mutter('export version %r' % tree)
243
 
    inv = tree.inventory
244
 
    for dp, ie in inv.iter_entries():
245
 
        kind = ie.kind
246
 
        fullpath = appendpath(dest, dp)
247
 
        if kind == 'directory':
248
 
            os.mkdir(fullpath)
249
 
        elif kind == 'file':
250
 
            pumpfile(tree.get_file(ie.file_id), file(fullpath, 'wb'))
251
 
        else:
252
 
            raise BzrError("don't know how to export {%s} of kind %r" % (ie.file_id, kind))
253
 
        mutter("  export {%s} kind %s to %s" % (ie.file_id, kind, fullpath))
254
 
exporters['dir'] = dir_exporter
255
 
 
256
 
try:
257
 
    import tarfile
258
 
except ImportError:
259
 
    pass
260
 
else:
261
 
    def get_root_name(dest):
262
 
        """Get just the root name for a tarball.
263
 
 
264
 
        >>> get_root_name('mytar.tar')
265
 
        'mytar'
266
 
        >>> get_root_name('mytar.tar.bz2')
267
 
        'mytar'
268
 
        >>> get_root_name('tar.tar.tar.tgz')
269
 
        'tar.tar.tar'
270
 
        >>> get_root_name('bzr-0.0.5.tar.gz')
271
 
        'bzr-0.0.5'
272
 
        >>> get_root_name('a/long/path/mytar.tgz')
273
 
        'mytar'
274
 
        >>> get_root_name('../parent/../dir/other.tbz2')
275
 
        'other'
276
 
        """
277
 
        endings = ['.tar', '.tar.gz', '.tgz', '.tar.bz2', '.tbz2']
278
 
        dest = os.path.basename(dest)
279
 
        for end in endings:
280
 
            if dest.endswith(end):
281
 
                return dest[:-len(end)]
282
 
 
283
 
    def tar_exporter(tree, dest, root, compression=None):
284
 
        """Export this tree to a new tar file.
285
 
 
286
 
        `dest` will be created holding the contents of this tree; if it
287
 
        already exists, it will be clobbered, like with "tar -c".
288
 
        """
289
 
        from time import time
290
 
        now = time()
291
 
        compression = str(compression or '')
292
 
        if root is None:
293
 
            root = get_root_name(dest)
294
 
        try:
295
 
            ball = tarfile.open(dest, 'w:' + compression)
296
 
        except tarfile.CompressionError, e:
297
 
            raise BzrError(str(e))
298
 
        mutter('export version %r' % tree)
299
 
        inv = tree.inventory
300
 
        for dp, ie in inv.iter_entries():
301
 
            mutter("  export {%s} kind %s to %s" % (ie.file_id, ie.kind, dest))
302
 
            item = tarfile.TarInfo(os.path.join(root, dp))
303
 
            # TODO: would be cool to actually set it to the timestamp of the
304
 
            # revision it was last changed
305
 
            item.mtime = now
306
 
            if ie.kind == 'directory':
307
 
                item.type = tarfile.DIRTYPE
308
 
                fileobj = None
309
 
                item.name += '/'
310
 
                item.size = 0
311
 
                item.mode = 0755
312
 
            elif ie.kind == 'file':
313
 
                item.type = tarfile.REGTYPE
314
 
                fileobj = tree.get_file(ie.file_id)
315
 
                item.size = _find_file_size(fileobj)
316
 
                item.mode = 0644
317
 
            else:
318
 
                raise BzrError("don't know how to export {%s} of kind %r" %
319
 
                        (ie.file_id, ie.kind))
320
 
 
321
 
            ball.addfile(item, fileobj)
322
 
        ball.close()
323
 
    exporters['tar'] = tar_exporter
324
 
 
325
 
    def tgz_exporter(tree, dest, root):
326
 
        tar_exporter(tree, dest, root, compression='gz')
327
 
    exporters['tgz'] = tgz_exporter
328
 
 
329
 
    def tbz_exporter(tree, dest, root):
330
 
        tar_exporter(tree, dest, root, compression='bz2')
331
 
    exporters['tbz2'] = tbz_exporter
332
 
 
333
 
 
334
 
def _find_file_size(fileobj):
335
 
    offset = fileobj.tell()
336
 
    try:
337
 
        fileobj.seek(0, 2)
338
 
        size = fileobj.tell()
339
 
    except TypeError:
340
 
        # gzip doesn't accept second argument to seek()
341
 
        fileobj.seek(0)
342
 
        size = 0
343
 
        while True:
344
 
            nread = len(fileobj.read())
345
 
            if nread == 0:
346
 
                break
347
 
            size += nread
348
 
    fileobj.seek(offset)
349
 
    return size
 
519
def find_ids_across_trees(filenames, trees, require_versioned=True):
 
520
    """Find the ids corresponding to specified filenames.
 
521
    
 
522
    All matches in all trees will be used, and all children of matched
 
523
    directories will be used.
 
524
 
 
525
    :param filenames: The filenames to find file_ids for (if None, returns
 
526
        None)
 
527
    :param trees: The trees to find file_ids within
 
528
    :param require_versioned: if true, all specified filenames must occur in
 
529
    at least one tree.
 
530
    :return: a set of file ids for the specified filenames and their children.
 
531
    """
 
532
    if not filenames:
 
533
        return None
 
534
    specified_path_ids = _find_ids_across_trees(filenames, trees,
 
535
        require_versioned)
 
536
    return _find_children_across_trees(specified_path_ids, trees)
 
537
 
 
538
 
 
539
def _find_ids_across_trees(filenames, trees, require_versioned):
 
540
    """Find the ids corresponding to specified filenames.
 
541
    
 
542
    All matches in all trees will be used, but subdirectories are not scanned.
 
543
 
 
544
    :param filenames: The filenames to find file_ids for
 
545
    :param trees: The trees to find file_ids within
 
546
    :param require_versioned: if true, all specified filenames must occur in
 
547
        at least one tree.
 
548
    :return: a set of file ids for the specified filenames
 
549
    """
 
550
    not_versioned = []
 
551
    interesting_ids = set()
 
552
    for tree_path in filenames:
 
553
        not_found = True
 
554
        for tree in trees:
 
555
            file_id = tree.path2id(tree_path)
 
556
            if file_id is not None:
 
557
                interesting_ids.add(file_id)
 
558
                not_found = False
 
559
        if not_found:
 
560
            not_versioned.append(tree_path)
 
561
    if len(not_versioned) > 0 and require_versioned:
 
562
        raise errors.PathsNotVersionedError(not_versioned)
 
563
    return interesting_ids
 
564
 
 
565
 
 
566
def _find_children_across_trees(specified_ids, trees):
 
567
    """Return a set including specified ids and their children.
 
568
    
 
569
    All matches in all trees will be used.
 
570
 
 
571
    :param trees: The trees to find file_ids within
 
572
    :return: a set containing all specified ids and their children 
 
573
    """
 
574
    interesting_ids = set(specified_ids)
 
575
    pending = interesting_ids
 
576
    # now handle children of interesting ids
 
577
    # we loop so that we handle all children of each id in both trees
 
578
    while len(pending) > 0:
 
579
        new_pending = set()
 
580
        for file_id in pending:
 
581
            for tree in trees:
 
582
                if not tree.has_id(file_id):
 
583
                    continue
 
584
                entry = tree.inventory[file_id]
 
585
                for child in getattr(entry, 'children', {}).itervalues():
 
586
                    if child.file_id not in interesting_ids:
 
587
                        new_pending.add(child.file_id)
 
588
        interesting_ids.update(new_pending)
 
589
        pending = new_pending
 
590
    return interesting_ids
 
591
 
 
592
 
 
593
class InterTree(InterObject):
 
594
    """This class represents operations taking place between two Trees.
 
595
 
 
596
    Its instances have methods like 'compare' and contain references to the
 
597
    source and target trees these operations are to be carried out on.
 
598
 
 
599
    Clients of bzrlib should not need to use InterTree directly, rather they
 
600
    should use the convenience methods on Tree such as 'Tree.compare()' which
 
601
    will pass through to InterTree as appropriate.
 
602
    """
 
603
 
 
604
    _optimisers = []
 
605
 
 
606
    @needs_read_lock
 
607
    def compare(self, want_unchanged=False, specific_files=None,
 
608
        extra_trees=None, require_versioned=False, include_root=False,
 
609
        want_unversioned=False):
 
610
        """Return the changes from source to target.
 
611
 
 
612
        :return: A TreeDelta.
 
613
        :param specific_files: An optional list of file paths to restrict the
 
614
            comparison to. When mapping filenames to ids, all matches in all
 
615
            trees (including optional extra_trees) are used, and all children of
 
616
            matched directories are included.
 
617
        :param want_unchanged: An optional boolean requesting the inclusion of
 
618
            unchanged entries in the result.
 
619
        :param extra_trees: An optional list of additional trees to use when
 
620
            mapping the contents of specific_files (paths) to file_ids.
 
621
        :param require_versioned: An optional boolean (defaults to False). When
 
622
            supplied and True all the 'specific_files' must be versioned, or
 
623
            a PathsNotVersionedError will be thrown.
 
624
        :param want_unversioned: Scan for unversioned paths.
 
625
        """
 
626
        # NB: show_status depends on being able to pass in non-versioned files
 
627
        # and report them as unknown
 
628
        trees = (self.source,)
 
629
        if extra_trees is not None:
 
630
            trees = trees + tuple(extra_trees)
 
631
        # target is usually the newer tree:
 
632
        specific_file_ids = self.target.paths2ids(specific_files, trees,
 
633
            require_versioned=require_versioned)
 
634
        if specific_files and not specific_file_ids:
 
635
            # All files are unversioned, so just return an empty delta
 
636
            # _compare_trees would think we want a complete delta
 
637
            result = delta.TreeDelta()
 
638
            fake_entry = InventoryFile('unused', 'unused', 'unused')
 
639
            result.unversioned = [(path, None,
 
640
                self.target._comparison_data(fake_entry, path)[0]) for path in
 
641
                specific_files]
 
642
            return result
 
643
        return delta._compare_trees(self.source, self.target, want_unchanged,
 
644
            specific_files, include_root, extra_trees=extra_trees,
 
645
            require_versioned=require_versioned,
 
646
            want_unversioned=want_unversioned)
 
647
 
 
648
    def _iter_changes(self, include_unchanged=False,
 
649
                      specific_files=None, pb=None, extra_trees=[],
 
650
                      require_versioned=True, want_unversioned=False):
 
651
        """Generate an iterator of changes between trees.
 
652
 
 
653
        A tuple is returned:
 
654
        (file_id, (path_in_source, path_in_target),
 
655
         changed_content, versioned, parent, name, kind,
 
656
         executable)
 
657
 
 
658
        Changed_content is True if the file's content has changed.  This
 
659
        includes changes to its kind, and to a symlink's target.
 
660
 
 
661
        versioned, parent, name, kind, executable are tuples of (from, to).
 
662
        If a file is missing in a tree, its kind is None.
 
663
 
 
664
        Iteration is done in parent-to-child order, relative to the target
 
665
        tree.
 
666
 
 
667
        There is no guarantee that all paths are in sorted order: the
 
668
        requirement to expand the search due to renames may result in children
 
669
        that should be found early being found late in the search, after
 
670
        lexically later results have been returned.
 
671
        :param require_versioned: Raise errors.PathsNotVersionedError if a
 
672
            path in the specific_files list is not versioned in one of
 
673
            source, target or extra_trees.
 
674
        :param want_unversioned: Should unversioned files be returned in the
 
675
            output. An unversioned file is defined as one with (False, False)
 
676
            for the versioned pair.
 
677
        """
 
678
        result = []
 
679
        lookup_trees = [self.source]
 
680
        if extra_trees:
 
681
             lookup_trees.extend(extra_trees)
 
682
        if specific_files == []:
 
683
            specific_file_ids = []
 
684
        else:
 
685
            specific_file_ids = self.target.paths2ids(specific_files,
 
686
                lookup_trees, require_versioned=require_versioned)
 
687
        if want_unversioned:
 
688
            all_unversioned = sorted([(p.split('/'), p) for p in
 
689
                                     self.target.extras()
 
690
                if specific_files is None or
 
691
                    osutils.is_inside_any(specific_files, p)])
 
692
            all_unversioned = deque(all_unversioned)
 
693
        else:
 
694
            all_unversioned = deque()
 
695
        to_paths = {}
 
696
        from_entries_by_dir = list(self.source.inventory.iter_entries_by_dir(
 
697
            specific_file_ids=specific_file_ids))
 
698
        from_data = dict((e.file_id, (p, e)) for p, e in from_entries_by_dir)
 
699
        to_entries_by_dir = list(self.target.inventory.iter_entries_by_dir(
 
700
            specific_file_ids=specific_file_ids))
 
701
        num_entries = len(from_entries_by_dir) + len(to_entries_by_dir)
 
702
        entry_count = 0
 
703
        # the unversioned path lookup only occurs on real trees - where there 
 
704
        # can be extras. So the fake_entry is solely used to look up
 
705
        # executable it values when execute is not supported.
 
706
        fake_entry = InventoryFile('unused', 'unused', 'unused')
 
707
        for to_path, to_entry in to_entries_by_dir:
 
708
            while all_unversioned and all_unversioned[0][0] < to_path.split('/'):
 
709
                unversioned_path = all_unversioned.popleft()
 
710
                to_kind, to_executable, to_stat = \
 
711
                    self.target._comparison_data(fake_entry, unversioned_path[1])
 
712
                yield (None, (None, unversioned_path[1]), True, (False, False),
 
713
                    (None, None),
 
714
                    (None, unversioned_path[0][-1]),
 
715
                    (None, to_kind),
 
716
                    (None, to_executable))
 
717
            file_id = to_entry.file_id
 
718
            to_paths[file_id] = to_path
 
719
            entry_count += 1
 
720
            changed_content = False
 
721
            from_path, from_entry = from_data.get(file_id, (None, None))
 
722
            from_versioned = (from_entry is not None)
 
723
            if from_entry is not None:
 
724
                from_versioned = True
 
725
                from_name = from_entry.name
 
726
                from_parent = from_entry.parent_id
 
727
                from_kind, from_executable, from_stat = \
 
728
                    self.source._comparison_data(from_entry, from_path)
 
729
                entry_count += 1
 
730
            else:
 
731
                from_versioned = False
 
732
                from_kind = None
 
733
                from_parent = None
 
734
                from_name = None
 
735
                from_executable = None
 
736
            versioned = (from_versioned, True)
 
737
            to_kind, to_executable, to_stat = \
 
738
                self.target._comparison_data(to_entry, to_path)
 
739
            kind = (from_kind, to_kind)
 
740
            if kind[0] != kind[1]:
 
741
                changed_content = True
 
742
            elif from_kind == 'file':
 
743
                from_size = self.source._file_size(from_entry, from_stat)
 
744
                to_size = self.target._file_size(to_entry, to_stat)
 
745
                if from_size != to_size:
 
746
                    changed_content = True
 
747
                elif (self.source.get_file_sha1(file_id, from_path, from_stat) !=
 
748
                    self.target.get_file_sha1(file_id, to_path, to_stat)):
 
749
                    changed_content = True
 
750
            elif from_kind == 'symlink':
 
751
                if (self.source.get_symlink_target(file_id) !=
 
752
                    self.target.get_symlink_target(file_id)):
 
753
                    changed_content = True
 
754
                elif from_kind == 'tree-reference':
 
755
                    if (self.source.get_reference_revision(file_id, from_path)
 
756
                        != self.target.get_reference_revision(file_id, to_path)):
 
757
                        changed_content = True 
 
758
            parent = (from_parent, to_entry.parent_id)
 
759
            name = (from_name, to_entry.name)
 
760
            executable = (from_executable, to_executable)
 
761
            if pb is not None:
 
762
                pb.update('comparing files', entry_count, num_entries)
 
763
            if (changed_content is not False or versioned[0] != versioned[1]
 
764
                or parent[0] != parent[1] or name[0] != name[1] or 
 
765
                executable[0] != executable[1] or include_unchanged):
 
766
                yield (file_id, (from_path, to_path), changed_content,
 
767
                    versioned, parent, name, kind, executable)
 
768
 
 
769
        while all_unversioned:
 
770
            # yield any trailing unversioned paths
 
771
            unversioned_path = all_unversioned.popleft()
 
772
            to_kind, to_executable, to_stat = \
 
773
                self.target._comparison_data(fake_entry, unversioned_path[1])
 
774
            yield (None, (None, unversioned_path[1]), True, (False, False),
 
775
                (None, None),
 
776
                (None, unversioned_path[0][-1]),
 
777
                (None, to_kind),
 
778
                (None, to_executable))
 
779
 
 
780
        def get_to_path(to_entry):
 
781
            if to_entry.parent_id is None:
 
782
                to_path = '' # the root
 
783
            else:
 
784
                if to_entry.parent_id not in to_paths:
 
785
                    # recurse up
 
786
                    return get_to_path(self.target.inventory[to_entry.parent_id])
 
787
                to_path = osutils.pathjoin(to_paths[to_entry.parent_id],
 
788
                                           to_entry.name)
 
789
            to_paths[to_entry.file_id] = to_path
 
790
            return to_path
 
791
 
 
792
        for path, from_entry in from_entries_by_dir:
 
793
            file_id = from_entry.file_id
 
794
            if file_id in to_paths:
 
795
                # already returned
 
796
                continue
 
797
            if not file_id in self.target.inventory:
 
798
                # common case - paths we have not emitted are not present in
 
799
                # target.
 
800
                to_path = None
 
801
            else:
 
802
                to_path = get_to_path(self.target.inventory[file_id])
 
803
            entry_count += 1
 
804
            if pb is not None:
 
805
                pb.update('comparing files', entry_count, num_entries)
 
806
            versioned = (True, False)
 
807
            parent = (from_entry.parent_id, None)
 
808
            name = (from_entry.name, None)
 
809
            from_kind, from_executable, stat_value = \
 
810
                self.source._comparison_data(from_entry, path)
 
811
            kind = (from_kind, None)
 
812
            executable = (from_executable, None)
 
813
            changed_content = True
 
814
            # the parent's path is necessarily known at this point.
 
815
            yield(file_id, (path, to_path), changed_content, versioned, parent,
 
816
                  name, kind, executable)
 
817
 
 
818
 
 
819
# This was deprecated before 0.12, but did not have an official warning
 
820
@symbol_versioning.deprecated_function(symbol_versioning.zero_twelve)
 
821
def RevisionTree(*args, **kwargs):
 
822
    """RevisionTree has moved to bzrlib.revisiontree.RevisionTree()
 
823
 
 
824
    Accessing it as bzrlib.tree.RevisionTree has been deprecated as of
 
825
    bzr 0.12.
 
826
    """
 
827
    from bzrlib.revisiontree import RevisionTree as _RevisionTree
 
828
    return _RevisionTree(*args, **kwargs)
 
829
 
 
830