/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/tree.py

  • Committer: Aaron Bentley
  • Date: 2007-12-31 16:10:05 UTC
  • mto: This revision was merged to the branch mainline in revision 3241.
  • Revision ID: aaron.bentley@utoronto.ca-20071231161005-3l7s9521wm9zbjxg
Get apply_inventory_delta kinda working, but not children

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