~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tree.py

  • Committer: Ian Clatworthy
  • Date: 2007-12-07 04:21:59 UTC
  • mto: This revision was merged to the branch mainline in revision 3092.
  • Revision ID: ian.clatworthy@internode.on.net-20071207042159-n9rmhanqid1l7olh
Better PDF for Qiock Start Card (Ian Clatworthy)

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