~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tree.py

Review comments.

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