~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tree.py

  • Committer: Martin Pool
  • Date: 2005-07-29 19:53:21 UTC
  • Revision ID: mbp@sourcefrog.net-20050729195321-6d9eef1a43dd6c81
- notes from discussion on splitting and joining files

Show diffs side-by-side

added added

removed removed

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