← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Andrew Bennetts
  • Date: 2009-04-02 05:53:12 UTC
  • mto: This revision was merged to the branch mainline in revision 4242.
  • Revision ID: andrew.bennetts@canonical.com-20090402055312-h7mvgumvm7e620mj
Fix nits in spelling and naming.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/workingtree.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008 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
29
29
WorkingTree.open(dir).
30
30
"""
31
31
 
 
32
# TODO: Give the workingtree sole responsibility for the working inventory;
 
33
# remove the variable and references to it from the branch.  This may require
 
34
# updating the commit code so as to update the inventory within the working
 
35
# copy, and making sure there's only one WorkingTree for any directory on disk.
 
36
# At the moment they may alias the inventory and have old copies of it in
 
37
# memory.  (Now done? -- mbp 20060309)
32
38
 
33
39
from cStringIO import StringIO
34
40
import os
42
48
import itertools
43
49
import operator
44
50
import stat
 
51
from time import time
 
52
import warnings
45
53
import re
46
54
 
47
55
import bzrlib
49
57
    branch,
50
58
    bzrdir,
51
59
    conflicts as _mod_conflicts,
 
60
    dirstate,
52
61
    errors,
53
62
    generate_ids,
54
63
    globbing,
55
 
    graph as _mod_graph,
56
64
    hashcache,
57
65
    ignores,
58
 
    inventory,
59
66
    merge,
60
67
    revision as _mod_revision,
61
68
    revisiontree,
 
69
    repository,
 
70
    textui,
62
71
    trace,
63
72
    transform,
64
73
    ui,
 
74
    urlutils,
65
75
    views,
66
76
    xml5,
 
77
    xml6,
67
78
    xml7,
68
79
    )
69
80
import bzrlib.branch
70
81
from bzrlib.transport import get_transport
71
 
from bzrlib.workingtree_4 import (
72
 
    WorkingTreeFormat4,
73
 
    WorkingTreeFormat5,
74
 
    WorkingTreeFormat6,
75
 
    )
 
82
import bzrlib.ui
 
83
from bzrlib.workingtree_4 import WorkingTreeFormat4, WorkingTreeFormat5
76
84
""")
77
85
 
78
86
from bzrlib import symbol_versioning
79
87
from bzrlib.decorators import needs_read_lock, needs_write_lock
 
88
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, TreeReference
80
89
from bzrlib.lockable_files import LockableFiles
81
90
from bzrlib.lockdir import LockDir
82
91
import bzrlib.mutabletree
83
92
from bzrlib.mutabletree import needs_tree_write_lock
84
93
from bzrlib import osutils
85
94
from bzrlib.osutils import (
 
95
    compact_date,
86
96
    file_kind,
87
97
    isdir,
88
98
    normpath,
89
99
    pathjoin,
 
100
    rand_chars,
90
101
    realpath,
91
102
    safe_unicode,
92
103
    splitpath,
95
106
from bzrlib.filters import filtered_input_file
96
107
from bzrlib.trace import mutter, note
97
108
from bzrlib.transport.local import LocalTransport
98
 
from bzrlib.revision import CURRENT_REVISION
 
109
from bzrlib.progress import DummyProgress, ProgressPhase
 
110
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
99
111
from bzrlib.rio import RioReader, rio_file, Stanza
100
 
from bzrlib.symbol_versioning import (
101
 
    deprecated_passed,
102
 
    DEPRECATED_PARAMETER,
103
 
    )
 
112
from bzrlib.symbol_versioning import (deprecated_passed,
 
113
        deprecated_method,
 
114
        deprecated_function,
 
115
        DEPRECATED_PARAMETER,
 
116
        )
104
117
 
105
118
 
106
119
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
107
 
# TODO: Modifying the conflict objects or their type is currently nearly
108
 
# impossible as there is no clear relationship between the working tree format
109
 
# and the conflict list file format.
110
120
CONFLICT_HEADER_1 = "BZR conflict list format 1"
111
121
 
112
122
ERROR_PATH_NOT_FOUND = 3    # WindowsError errno code, equivalent to ENOENT
167
177
        return ''
168
178
 
169
179
 
170
 
class WorkingTree(bzrlib.mutabletree.MutableTree,
171
 
    bzrdir.ControlComponent):
 
180
class WorkingTree(bzrlib.mutabletree.MutableTree):
172
181
    """Working copy tree.
173
182
 
174
183
    The inventory is held in the `Branch` working-inventory, and the
247
256
        self._rules_searcher = None
248
257
        self.views = self._make_views()
249
258
 
250
 
    @property
251
 
    def user_transport(self):
252
 
        return self.bzrdir.user_transport
253
 
 
254
 
    @property
255
 
    def control_transport(self):
256
 
        return self._transport
257
 
 
258
259
    def _detect_case_handling(self):
259
260
        wt_trans = self.bzrdir.get_workingtree_transport(None)
260
261
        try:
285
286
        self._control_files.break_lock()
286
287
        self.branch.break_lock()
287
288
 
288
 
    def _get_check_refs(self):
289
 
        """Return the references needed to perform a check of this tree.
290
 
        
291
 
        The default implementation returns no refs, and is only suitable for
292
 
        trees that have no local caching and can commit on ghosts at any time.
293
 
 
294
 
        :seealso: bzrlib.check for details about check_refs.
295
 
        """
296
 
        return []
297
 
 
298
289
    def requires_rich_root(self):
299
290
        return self._format.requires_rich_root
300
291
 
424
415
            return self.branch.repository.revision_tree(revision_id)
425
416
        except (errors.RevisionNotPresent, errors.NoSuchRevision):
426
417
            # the basis tree *may* be a ghost or a low level error may have
427
 
            # occurred. If the revision is present, its a problem, if its not
 
418
            # occured. If the revision is present, its a problem, if its not
428
419
            # its a ghost.
429
420
            if self.branch.repository.has_revision(revision_id):
430
421
                raise
451
442
 
452
443
    def get_file_with_stat(self, file_id, path=None, filtered=True,
453
444
        _fstat=os.fstat):
454
 
        """See Tree.get_file_with_stat."""
 
445
        """See MutableTree.get_file_with_stat."""
455
446
        if path is None:
456
447
            path = self.id2path(file_id)
457
448
        file_obj = self.get_file_byname(path, filtered=False)
458
449
        stat_value = _fstat(file_obj.fileno())
459
 
        if filtered and self.supports_content_filtering():
 
450
        if self.supports_content_filtering() and filtered:
460
451
            filters = self._content_filter_stack(path)
461
452
            file_obj = filtered_input_file(file_obj, filters)
462
453
        return (file_obj, stat_value)
467
458
    def get_file_byname(self, filename, filtered=True):
468
459
        path = self.abspath(filename)
469
460
        f = file(path, 'rb')
470
 
        if filtered and self.supports_content_filtering():
 
461
        if self.supports_content_filtering() and filtered:
471
462
            filters = self._content_filter_stack(filename)
472
463
            return filtered_input_file(f, filters)
473
464
        else:
492
483
        incorrectly attributed to CURRENT_REVISION (but after committing, the
493
484
        attribution will be correct).
494
485
        """
495
 
        maybe_file_parent_keys = []
496
 
        for parent_id in self.get_parent_ids():
497
 
            try:
498
 
                parent_tree = self.revision_tree(parent_id)
499
 
            except errors.NoSuchRevisionInTree:
500
 
                parent_tree = self.branch.repository.revision_tree(parent_id)
501
 
            parent_tree.lock_read()
502
 
            try:
503
 
                if file_id not in parent_tree:
504
 
                    continue
505
 
                ie = parent_tree.inventory[file_id]
506
 
                if ie.kind != 'file':
507
 
                    # Note: this is slightly unnecessary, because symlinks and
508
 
                    # directories have a "text" which is the empty text, and we
509
 
                    # know that won't mess up annotations. But it seems cleaner
510
 
                    continue
511
 
                parent_text_key = (file_id, ie.revision)
512
 
                if parent_text_key not in maybe_file_parent_keys:
513
 
                    maybe_file_parent_keys.append(parent_text_key)
514
 
            finally:
515
 
                parent_tree.unlock()
516
 
        graph = _mod_graph.Graph(self.branch.repository.texts)
517
 
        heads = graph.heads(maybe_file_parent_keys)
518
 
        file_parent_keys = []
519
 
        for key in maybe_file_parent_keys:
520
 
            if key in heads:
521
 
                file_parent_keys.append(key)
522
 
 
523
 
        # Now we have the parents of this content
524
 
        annotator = self.branch.repository.texts.get_annotator()
525
 
        text = self.get_file(file_id).read()
526
 
        this_key =(file_id, default_revision)
527
 
        annotator.add_special_text(this_key, file_parent_keys, text)
528
 
        annotations = [(key[-1], line)
529
 
                       for key, line in annotator.annotate_flat(this_key)]
530
 
        return annotations
 
486
        basis = self.basis_tree()
 
487
        basis.lock_read()
 
488
        try:
 
489
            changes = self.iter_changes(basis, True, [self.id2path(file_id)],
 
490
                require_versioned=True).next()
 
491
            changed_content, kind = changes[2], changes[6]
 
492
            if not changed_content:
 
493
                return basis.annotate_iter(file_id)
 
494
            if kind[1] is None:
 
495
                return None
 
496
            import annotate
 
497
            if kind[0] != 'file':
 
498
                old_lines = []
 
499
            else:
 
500
                old_lines = list(basis.annotate_iter(file_id))
 
501
            old = [old_lines]
 
502
            for tree in self.branch.repository.revision_trees(
 
503
                self.get_parent_ids()[1:]):
 
504
                if file_id not in tree:
 
505
                    continue
 
506
                old.append(list(tree.annotate_iter(file_id)))
 
507
            return annotate.reannotate(old, self.get_file(file_id).readlines(),
 
508
                                       default_revision)
 
509
        finally:
 
510
            basis.unlock()
531
511
 
532
512
    def _get_ancestors(self, default_revision):
533
513
        ancestors = set([default_revision])
548
528
        else:
549
529
            parents = [last_rev]
550
530
        try:
551
 
            merges_bytes = self._transport.get_bytes('pending-merges')
 
531
            merges_file = self._transport.get('pending-merges')
552
532
        except errors.NoSuchFile:
553
533
            pass
554
534
        else:
555
 
            for l in osutils.split_lines(merges_bytes):
 
535
            for l in merges_file.readlines():
556
536
                revision_id = l.rstrip('\n')
557
537
                parents.append(revision_id)
558
538
        return parents
577
557
 
578
558
        revision
579
559
            If not None, the cloned tree will have its last revision set to
580
 
            revision, and difference between the source trees last revision
 
560
            revision, and and difference between the source trees last revision
581
561
            and this one merged in.
582
562
        """
583
563
        # assumes the target bzr dir format is compatible.
617
597
 
618
598
    def get_file_size(self, file_id):
619
599
        """See Tree.get_file_size"""
620
 
        # XXX: this returns the on-disk size; it should probably return the
621
 
        # canonical size
622
600
        try:
623
601
            return os.path.getsize(self.id2abspath(file_id))
624
602
        except OSError, e:
640
618
 
641
619
    def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
642
620
        file_id = self.path2id(path)
643
 
        if file_id is None:
644
 
            # For unversioned files on win32, we just assume they are not
645
 
            # executable
646
 
            return False
647
621
        return self._inventory[file_id].executable
648
622
 
649
623
    def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
759
733
            raise
760
734
        kind = _mapper(stat_result.st_mode)
761
735
        if kind == 'file':
762
 
            return self._file_content_summary(path, stat_result)
 
736
            size = stat_result.st_size
 
737
            # try for a stat cache lookup
 
738
            executable = self._is_executable_from_path_and_stat(path, stat_result)
 
739
            return (kind, size, executable, self._sha_from_stat(
 
740
                path, stat_result))
763
741
        elif kind == 'directory':
764
742
            # perhaps it looks like a plain directory, but it's really a
765
743
            # reference.
767
745
                kind = 'tree-reference'
768
746
            return kind, None, None, None
769
747
        elif kind == 'symlink':
770
 
            target = osutils.readlink(abspath)
771
 
            return ('symlink', None, None, target)
 
748
            return ('symlink', None, None,
 
749
                    os.readlink(abspath.encode(osutils._fs_enc)
 
750
                                ).decode(osutils._fs_enc))
772
751
        else:
773
752
            return (kind, None, None, None)
774
753
 
775
 
    def _file_content_summary(self, path, stat_result):
776
 
        size = stat_result.st_size
777
 
        executable = self._is_executable_from_path_and_stat(path, stat_result)
778
 
        # try for a stat cache lookup
779
 
        return ('file', size, executable, self._sha_from_stat(
780
 
            path, stat_result))
781
 
 
782
754
    def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
783
755
        """Common ghost checking functionality from set_parent_*.
784
756
 
904
876
 
905
877
    @needs_write_lock # because merge pulls data into the branch.
906
878
    def merge_from_branch(self, branch, to_revision=None, from_revision=None,
907
 
                          merge_type=None, force=False):
 
879
        merge_type=None):
908
880
        """Merge from a branch into this working tree.
909
881
 
910
882
        :param branch: The branch to merge from.
914
886
            branch.last_revision().
915
887
        """
916
888
        from bzrlib.merge import Merger, Merge3Merger
917
 
        merger = Merger(self.branch, this_tree=self)
918
 
        # check that there are no local alterations
919
 
        if not force and self.has_changes():
920
 
            raise errors.UncommittedChanges(self)
921
 
        if to_revision is None:
922
 
            to_revision = _mod_revision.ensure_null(branch.last_revision())
923
 
        merger.other_rev_id = to_revision
924
 
        if _mod_revision.is_null(merger.other_rev_id):
925
 
            raise errors.NoCommits(branch)
926
 
        self.branch.fetch(branch, last_revision=merger.other_rev_id)
927
 
        merger.other_basis = merger.other_rev_id
928
 
        merger.other_tree = self.branch.repository.revision_tree(
929
 
            merger.other_rev_id)
930
 
        merger.other_branch = branch
931
 
        if from_revision is None:
932
 
            merger.find_base()
933
 
        else:
934
 
            merger.set_base_revision(from_revision, branch)
935
 
        if merger.base_rev_id == merger.other_rev_id:
936
 
            raise errors.PointlessMerge
937
 
        merger.backup_files = False
938
 
        if merge_type is None:
939
 
            merger.merge_type = Merge3Merger
940
 
        else:
941
 
            merger.merge_type = merge_type
942
 
        merger.set_interesting_files(None)
943
 
        merger.show_base = False
944
 
        merger.reprocess = False
945
 
        conflicts = merger.do_merge()
946
 
        merger.set_pending()
 
889
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
890
        try:
 
891
            merger = Merger(self.branch, this_tree=self, pb=pb)
 
892
            merger.pp = ProgressPhase("Merge phase", 5, pb)
 
893
            merger.pp.next_phase()
 
894
            # check that there are no
 
895
            # local alterations
 
896
            merger.check_basis(check_clean=True, require_commits=False)
 
897
            if to_revision is None:
 
898
                to_revision = _mod_revision.ensure_null(branch.last_revision())
 
899
            merger.other_rev_id = to_revision
 
900
            if _mod_revision.is_null(merger.other_rev_id):
 
901
                raise errors.NoCommits(branch)
 
902
            self.branch.fetch(branch, last_revision=merger.other_rev_id)
 
903
            merger.other_basis = merger.other_rev_id
 
904
            merger.other_tree = self.branch.repository.revision_tree(
 
905
                merger.other_rev_id)
 
906
            merger.other_branch = branch
 
907
            merger.pp.next_phase()
 
908
            if from_revision is None:
 
909
                merger.find_base()
 
910
            else:
 
911
                merger.set_base_revision(from_revision, branch)
 
912
            if merger.base_rev_id == merger.other_rev_id:
 
913
                raise errors.PointlessMerge
 
914
            merger.backup_files = False
 
915
            if merge_type is None:
 
916
                merger.merge_type = Merge3Merger
 
917
            else:
 
918
                merger.merge_type = merge_type
 
919
            merger.set_interesting_files(None)
 
920
            merger.show_base = False
 
921
            merger.reprocess = False
 
922
            conflicts = merger.do_merge()
 
923
            merger.set_pending()
 
924
        finally:
 
925
            pb.finished()
947
926
        return conflicts
948
927
 
949
928
    @needs_read_lock
990
969
        return file_id
991
970
 
992
971
    def get_symlink_target(self, file_id):
993
 
        abspath = self.id2abspath(file_id)
994
 
        target = osutils.readlink(abspath)
995
 
        return target
 
972
        return os.readlink(self.id2abspath(file_id).encode(osutils._fs_enc))
996
973
 
997
974
    @needs_write_lock
998
975
    def subsume(self, other_tree):
1096
1073
        tree_transport = self.bzrdir.root_transport.clone(sub_path)
1097
1074
        if tree_transport.base != branch_transport.base:
1098
1075
            tree_bzrdir = format.initialize_on_transport(tree_transport)
1099
 
            branch.BranchReferenceFormat().initialize(tree_bzrdir,
1100
 
                target_branch=new_branch)
 
1076
            branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1101
1077
        else:
1102
1078
            tree_bzrdir = branch_bzrdir
1103
 
        wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
 
1079
        wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1104
1080
        wt.set_parent_ids(self.get_parent_ids())
1105
1081
        my_inv = self.inventory
1106
 
        child_inv = inventory.Inventory(root_id=None)
 
1082
        child_inv = Inventory(root_id=None)
1107
1083
        new_root = my_inv[file_id]
1108
1084
        my_inv.remove_recursive_id(file_id)
1109
1085
        new_root.parent_id = None
1134
1110
    def _kind(self, relpath):
1135
1111
        return osutils.file_kind(self.abspath(relpath))
1136
1112
 
1137
 
    def list_files(self, include_root=False, from_dir=None, recursive=True):
1138
 
        """List all files as (path, class, kind, id, entry).
 
1113
    def list_files(self, include_root=False):
 
1114
        """Recursively list all files as (path, class, kind, id, entry).
1139
1115
 
1140
1116
        Lists, but does not descend into unversioned directories.
 
1117
 
1141
1118
        This does not include files that have been deleted in this
1142
 
        tree. Skips the control directory.
 
1119
        tree.
1143
1120
 
1144
 
        :param include_root: if True, return an entry for the root
1145
 
        :param from_dir: start from this directory or None for the root
1146
 
        :param recursive: whether to recurse into subdirectories or not
 
1121
        Skips the control directory.
1147
1122
        """
1148
1123
        # list_files is an iterator, so @needs_read_lock doesn't work properly
1149
1124
        # with it. So callers should be careful to always read_lock the tree.
1151
1126
            raise errors.ObjectNotLocked(self)
1152
1127
 
1153
1128
        inv = self.inventory
1154
 
        if from_dir is None and include_root is True:
 
1129
        if include_root is True:
1155
1130
            yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1156
1131
        # Convert these into local objects to save lookup times
1157
1132
        pathjoin = osutils.pathjoin
1164
1139
        fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1165
1140
 
1166
1141
        # directory file_id, relative path, absolute path, reverse sorted children
1167
 
        if from_dir is not None:
1168
 
            from_dir_id = inv.path2id(from_dir)
1169
 
            if from_dir_id is None:
1170
 
                # Directory not versioned
1171
 
                return
1172
 
            from_dir_abspath = pathjoin(self.basedir, from_dir)
1173
 
        else:
1174
 
            from_dir_id = inv.root.file_id
1175
 
            from_dir_abspath = self.basedir
1176
 
        children = os.listdir(from_dir_abspath)
 
1142
        children = os.listdir(self.basedir)
1177
1143
        children.sort()
1178
1144
        # jam 20060527 The kernel sized tree seems equivalent whether we
1179
1145
        # use a deque and popleft to keep them sorted, or if we use a plain
1180
1146
        # list and just reverse() them.
1181
1147
        children = collections.deque(children)
1182
 
        stack = [(from_dir_id, u'', from_dir_abspath, children)]
 
1148
        stack = [(inv.root.file_id, u'', self.basedir, children)]
1183
1149
        while stack:
1184
1150
            from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1185
1151
 
1243
1209
                if fk != 'directory':
1244
1210
                    continue
1245
1211
 
1246
 
                # But do this child first if recursing down
1247
 
                if recursive:
1248
 
                    new_children = os.listdir(fap)
1249
 
                    new_children.sort()
1250
 
                    new_children = collections.deque(new_children)
1251
 
                    stack.append((f_ie.file_id, fp, fap, new_children))
1252
 
                    # Break out of inner loop,
1253
 
                    # so that we start outer loop with child
1254
 
                    break
 
1212
                # But do this child first
 
1213
                new_children = os.listdir(fap)
 
1214
                new_children.sort()
 
1215
                new_children = collections.deque(new_children)
 
1216
                stack.append((f_ie.file_id, fp, fap, new_children))
 
1217
                # Break out of inner loop,
 
1218
                # so that we start outer loop with child
 
1219
                break
1255
1220
            else:
1256
1221
                # if we finished all children, pop it off the stack
1257
1222
                stack.pop()
1435
1400
        inv = self.inventory
1436
1401
        for entry in moved:
1437
1402
            try:
1438
 
                self._move_entry(WorkingTree._RenameEntry(
1439
 
                    entry.to_rel, entry.from_id,
 
1403
                self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1440
1404
                    entry.to_tail, entry.to_parent_id, entry.from_rel,
1441
1405
                    entry.from_tail, entry.from_parent_id,
1442
1406
                    entry.only_change_inv))
1493
1457
        from_tail = splitpath(from_rel)[-1]
1494
1458
        from_id = inv.path2id(from_rel)
1495
1459
        if from_id is None:
1496
 
            # if file is missing in the inventory maybe it's in the basis_tree
1497
 
            basis_tree = self.branch.basis_tree()
1498
 
            from_id = basis_tree.path2id(from_rel)
1499
 
            if from_id is None:
1500
 
                raise errors.BzrRenameFailedError(from_rel,to_rel,
1501
 
                    errors.NotVersionedError(path=str(from_rel)))
1502
 
            # put entry back in the inventory so we can rename it
1503
 
            from_entry = basis_tree.inventory[from_id].copy()
1504
 
            inv.add(from_entry)
1505
 
        else:
1506
 
            from_entry = inv[from_id]
 
1460
            raise errors.BzrRenameFailedError(from_rel,to_rel,
 
1461
                errors.NotVersionedError(path=str(from_rel)))
 
1462
        from_entry = inv[from_id]
1507
1463
        from_parent_id = from_entry.parent_id
1508
1464
        to_dir, to_tail = os.path.split(to_rel)
1509
1465
        to_dir_id = inv.path2id(to_dir)
1571
1527
        :raises: NoSuchId if any fileid is not currently versioned.
1572
1528
        """
1573
1529
        for file_id in file_ids:
1574
 
            if file_id not in self._inventory:
1575
 
                raise errors.NoSuchId(self, file_id)
1576
 
        for file_id in file_ids:
1577
1530
            if self._inventory.has_id(file_id):
1578
1531
                self._inventory.remove_recursive_id(file_id)
 
1532
            else:
 
1533
                raise errors.NoSuchId(self, file_id)
1579
1534
        if len(file_ids):
1580
1535
            # in the future this should just set a dirty bit to wait for the
1581
1536
            # final unlock. However, until all methods of workingtree start
1600
1555
 
1601
1556
    @needs_write_lock
1602
1557
    def pull(self, source, overwrite=False, stop_revision=None,
1603
 
             change_reporter=None, possible_transports=None, local=False):
 
1558
             change_reporter=None, possible_transports=None):
 
1559
        top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1604
1560
        source.lock_read()
1605
1561
        try:
 
1562
            pp = ProgressPhase("Pull phase", 2, top_pb)
 
1563
            pp.next_phase()
1606
1564
            old_revision_info = self.branch.last_revision_info()
1607
1565
            basis_tree = self.basis_tree()
1608
1566
            count = self.branch.pull(source, overwrite, stop_revision,
1609
 
                                     possible_transports=possible_transports,
1610
 
                                     local=local)
 
1567
                                     possible_transports=possible_transports)
1611
1568
            new_revision_info = self.branch.last_revision_info()
1612
1569
            if new_revision_info != old_revision_info:
 
1570
                pp.next_phase()
1613
1571
                repository = self.branch.repository
 
1572
                pb = bzrlib.ui.ui_factory.nested_progress_bar()
1614
1573
                basis_tree.lock_read()
1615
1574
                try:
1616
1575
                    new_basis_tree = self.branch.basis_tree()
1619
1578
                                new_basis_tree,
1620
1579
                                basis_tree,
1621
1580
                                this_tree=self,
1622
 
                                pb=None,
 
1581
                                pb=pb,
1623
1582
                                change_reporter=change_reporter)
1624
 
                    basis_root_id = basis_tree.get_root_id()
1625
 
                    new_root_id = new_basis_tree.get_root_id()
1626
 
                    if basis_root_id != new_root_id:
1627
 
                        self.set_root_id(new_root_id)
 
1583
                    if (basis_tree.inventory.root is None and
 
1584
                        new_basis_tree.inventory.root is not None):
 
1585
                        self.set_root_id(new_basis_tree.get_root_id())
1628
1586
                finally:
 
1587
                    pb.finished()
1629
1588
                    basis_tree.unlock()
1630
1589
                # TODO - dedup parents list with things merged by pull ?
1631
1590
                # reuse the revisiontree we merged against to set the new
1644
1603
            return count
1645
1604
        finally:
1646
1605
            source.unlock()
 
1606
            top_pb.finished()
1647
1607
 
1648
1608
    @needs_write_lock
1649
1609
    def put_file_bytes_non_atomic(self, file_id, bytes):
1675
1635
 
1676
1636
            fl = []
1677
1637
            for subf in os.listdir(dirabs):
1678
 
                if self.bzrdir.is_control_filename(subf):
 
1638
                if subf == '.bzr':
1679
1639
                    continue
1680
1640
                if subf not in dir_entry.children:
1681
1641
                    try:
1734
1694
        r"""Check whether the filename matches an ignore pattern.
1735
1695
 
1736
1696
        Patterns containing '/' or '\' need to match the whole path;
1737
 
        others match against only the last component.  Patterns starting
1738
 
        with '!' are ignore exceptions.  Exceptions take precedence
1739
 
        over regular patterns and cause the filename to not be ignored.
 
1697
        others match against only the last component.
1740
1698
 
1741
1699
        If the file is ignored, returns the pattern which caused it to
1742
1700
        be ignored, otherwise None.  So this can simply be used as a
1743
1701
        boolean if desired."""
1744
1702
        if getattr(self, '_ignoreglobster', None) is None:
1745
 
            self._ignoreglobster = globbing.ExceptionGlobster(self.get_ignore_list())
 
1703
            self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1746
1704
        return self._ignoreglobster.match(filename)
1747
1705
 
1748
1706
    def kind(self, file_id):
1798
1756
            raise errors.ObjectNotLocked(self)
1799
1757
 
1800
1758
    def lock_read(self):
1801
 
        """Lock the tree for reading.
1802
 
 
1803
 
        This also locks the branch, and can be unlocked via self.unlock().
1804
 
 
1805
 
        :return: An object with an unlock method which will release the lock
1806
 
            obtained.
1807
 
        """
 
1759
        """See Branch.lock_read, and WorkingTree.unlock."""
1808
1760
        if not self.is_locked():
1809
1761
            self._reset_data()
1810
1762
        self.branch.lock_read()
1811
1763
        try:
1812
 
            self._control_files.lock_read()
1813
 
            return self
 
1764
            return self._control_files.lock_read()
1814
1765
        except:
1815
1766
            self.branch.unlock()
1816
1767
            raise
1817
1768
 
1818
1769
    def lock_tree_write(self):
1819
 
        """See MutableTree.lock_tree_write, and WorkingTree.unlock.
1820
 
 
1821
 
        :return: An object with an unlock method which will release the lock
1822
 
            obtained.
1823
 
        """
 
1770
        """See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1824
1771
        if not self.is_locked():
1825
1772
            self._reset_data()
1826
1773
        self.branch.lock_read()
1827
1774
        try:
1828
 
            self._control_files.lock_write()
1829
 
            return self
 
1775
            return self._control_files.lock_write()
1830
1776
        except:
1831
1777
            self.branch.unlock()
1832
1778
            raise
1833
1779
 
1834
1780
    def lock_write(self):
1835
 
        """See MutableTree.lock_write, and WorkingTree.unlock.
1836
 
 
1837
 
        :return: An object with an unlock method which will release the lock
1838
 
            obtained.
1839
 
        """
 
1781
        """See MutableTree.lock_write, and WorkingTree.unlock."""
1840
1782
        if not self.is_locked():
1841
1783
            self._reset_data()
1842
1784
        self.branch.lock_write()
1843
1785
        try:
1844
 
            self._control_files.lock_write()
1845
 
            return self
 
1786
            return self._control_files.lock_write()
1846
1787
        except:
1847
1788
            self.branch.unlock()
1848
1789
            raise
1856
1797
    def _reset_data(self):
1857
1798
        """Reset transient data that cannot be revalidated."""
1858
1799
        self._inventory_is_modified = False
1859
 
        f = self._transport.get('inventory')
1860
 
        try:
1861
 
            result = self._deserialize(f)
1862
 
        finally:
1863
 
            f.close()
 
1800
        result = self._deserialize(self._transport.get('inventory'))
1864
1801
        self._set_inventory(result, dirty=False)
1865
1802
 
1866
1803
    @needs_tree_write_lock
1913
1850
            # revision_id is set. We must check for this full string, because a
1914
1851
            # root node id can legitimately look like 'revision_id' but cannot
1915
1852
            # contain a '"'.
1916
 
            xml = self.branch.repository._get_inventory_xml(new_revision)
 
1853
            xml = self.branch.repository.get_inventory_xml(new_revision)
1917
1854
            firstline = xml.split('\n', 1)[0]
1918
1855
            if (not 'revision_id="' in firstline or
1919
1856
                'format="7"' not in firstline):
1920
 
                inv = self.branch.repository._serializer.read_inventory_from_string(
1921
 
                    xml, new_revision)
 
1857
                inv = self.branch.repository.deserialise_inventory(
 
1858
                    new_revision, xml)
1922
1859
                xml = self._create_basis_xml_from_inventory(new_revision, inv)
1923
1860
            self._write_basis_inventory(xml)
1924
1861
        except (errors.NoSuchRevision, errors.RevisionNotPresent):
1942
1879
        # binary.
1943
1880
        if self._inventory_is_modified:
1944
1881
            raise errors.InventoryModified(self)
1945
 
        f = self._transport.get('inventory')
1946
 
        try:
1947
 
            result = self._deserialize(f)
1948
 
        finally:
1949
 
            f.close()
 
1882
        result = self._deserialize(self._transport.get('inventory'))
1950
1883
        self._set_inventory(result, dirty=False)
1951
1884
        return result
1952
1885
 
1967
1900
 
1968
1901
        new_files=set()
1969
1902
        unknown_nested_files=set()
1970
 
        if to_file is None:
1971
 
            to_file = sys.stdout
1972
1903
 
1973
1904
        def recurse_directory_to_add_files(directory):
1974
1905
            # Recurse directory and add all files
2030
1961
                        tree_delta.unversioned.extend((unknown_file,))
2031
1962
                raise errors.BzrRemoveChangedFilesError(tree_delta)
2032
1963
 
2033
 
        # Build inv_delta and delete files where applicable,
 
1964
        # Build inv_delta and delete files where applicaple,
2034
1965
        # do this before any modifications to inventory.
2035
1966
        for f in files:
2036
1967
            fid = self.path2id(f)
2044
1975
                        new_status = 'I'
2045
1976
                    else:
2046
1977
                        new_status = '?'
2047
 
                    # XXX: Really should be a more abstract reporter interface
2048
 
                    kind_ch = osutils.kind_marker(self.kind(fid))
2049
 
                    to_file.write(new_status + '       ' + f + kind_ch + '\n')
 
1978
                    textui.show_status(new_status, self.kind(fid), f,
 
1979
                                       to_file=to_file)
2050
1980
                # Unversion file
2051
1981
                inv_delta.append((f, None, fid, None))
2052
1982
                message = "removed %s" % (f,)
2075
2005
 
2076
2006
    @needs_tree_write_lock
2077
2007
    def revert(self, filenames=None, old_tree=None, backups=True,
2078
 
               pb=None, report_changes=False):
 
2008
               pb=DummyProgress(), report_changes=False):
2079
2009
        from bzrlib.conflicts import resolve
2080
2010
        if filenames == []:
2081
2011
            filenames = None
2094
2024
            if filenames is None and len(self.get_parent_ids()) > 1:
2095
2025
                parent_trees = []
2096
2026
                last_revision = self.last_revision()
2097
 
                if last_revision != _mod_revision.NULL_REVISION:
 
2027
                if last_revision != NULL_REVISION:
2098
2028
                    if basis_tree is None:
2099
2029
                        basis_tree = self.basis_tree()
2100
2030
                        basis_tree.lock_read()
2138
2068
    def set_inventory(self, new_inventory_list):
2139
2069
        from bzrlib.inventory import (Inventory,
2140
2070
                                      InventoryDirectory,
 
2071
                                      InventoryEntry,
2141
2072
                                      InventoryFile,
2142
2073
                                      InventoryLink)
2143
2074
        inv = Inventory(self.get_root_id())
2203
2134
        """
2204
2135
        raise NotImplementedError(self.unlock)
2205
2136
 
2206
 
    _marker = object()
2207
 
 
2208
 
    def update(self, change_reporter=None, possible_transports=None,
2209
 
               revision=None, old_tip=_marker):
 
2137
    def update(self, change_reporter=None, possible_transports=None):
2210
2138
        """Update a working tree along its branch.
2211
2139
 
2212
2140
        This will update the branch if its bound too, which means we have
2230
2158
        - Merge current state -> basis tree of the master w.r.t. the old tree
2231
2159
          basis.
2232
2160
        - Do a 'normal' merge of the old branch basis if it is relevant.
2233
 
 
2234
 
        :param revision: The target revision to update to. Must be in the
2235
 
            revision history.
2236
 
        :param old_tip: If branch.update() has already been run, the value it
2237
 
            returned (old tip of the branch or None). _marker is used
2238
 
            otherwise.
2239
2161
        """
2240
2162
        if self.branch.get_bound_location() is not None:
2241
2163
            self.lock_write()
2242
 
            update_branch = (old_tip is self._marker)
 
2164
            update_branch = True
2243
2165
        else:
2244
2166
            self.lock_tree_write()
2245
2167
            update_branch = False
2247
2169
            if update_branch:
2248
2170
                old_tip = self.branch.update(possible_transports)
2249
2171
            else:
2250
 
                if old_tip is self._marker:
2251
 
                    old_tip = None
2252
 
            return self._update_tree(old_tip, change_reporter, revision)
 
2172
                old_tip = None
 
2173
            return self._update_tree(old_tip, change_reporter)
2253
2174
        finally:
2254
2175
            self.unlock()
2255
2176
 
2256
2177
    @needs_tree_write_lock
2257
 
    def _update_tree(self, old_tip=None, change_reporter=None, revision=None):
 
2178
    def _update_tree(self, old_tip=None, change_reporter=None):
2258
2179
        """Update a tree to the master branch.
2259
2180
 
2260
2181
        :param old_tip: if supplied, the previous tip revision the branch,
2270
2191
        # We MUST save it even if an error occurs, because otherwise the users
2271
2192
        # local work is unreferenced and will appear to have been lost.
2272
2193
        #
2273
 
        nb_conflicts = 0
 
2194
        result = 0
2274
2195
        try:
2275
2196
            last_rev = self.get_parent_ids()[0]
2276
2197
        except IndexError:
2277
2198
            last_rev = _mod_revision.NULL_REVISION
2278
 
        if revision is None:
2279
 
            revision = self.branch.last_revision()
2280
 
 
2281
 
        old_tip = old_tip or _mod_revision.NULL_REVISION
2282
 
 
2283
 
        if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
2284
 
            # the branch we are bound to was updated
2285
 
            # merge those changes in first
2286
 
            base_tree  = self.basis_tree()
2287
 
            other_tree = self.branch.repository.revision_tree(old_tip)
2288
 
            nb_conflicts = merge.merge_inner(self.branch, other_tree,
2289
 
                                             base_tree, this_tree=self,
2290
 
                                             change_reporter=change_reporter)
2291
 
            if nb_conflicts:
2292
 
                self.add_parent_tree((old_tip, other_tree))
2293
 
                trace.note('Rerun update after fixing the conflicts.')
2294
 
                return nb_conflicts
2295
 
 
2296
 
        if last_rev != _mod_revision.ensure_null(revision):
2297
 
            # the working tree is up to date with the branch
2298
 
            # we can merge the specified revision from master
2299
 
            to_tree = self.branch.repository.revision_tree(revision)
2300
 
            to_root_id = to_tree.get_root_id()
2301
 
 
 
2199
        if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
 
2200
            # merge tree state up to new branch tip.
2302
2201
            basis = self.basis_tree()
2303
2202
            basis.lock_read()
2304
2203
            try:
2305
 
                if (basis.inventory.root is None
2306
 
                    or basis.inventory.root.file_id != to_root_id):
2307
 
                    self.set_root_id(to_root_id)
 
2204
                to_tree = self.branch.basis_tree()
 
2205
                if basis.inventory.root is None:
 
2206
                    self.set_root_id(to_tree.get_root_id())
2308
2207
                    self.flush()
 
2208
                result += merge.merge_inner(
 
2209
                                      self.branch,
 
2210
                                      to_tree,
 
2211
                                      basis,
 
2212
                                      this_tree=self,
 
2213
                                      change_reporter=change_reporter)
2309
2214
            finally:
2310
2215
                basis.unlock()
2311
 
 
2312
 
            # determine the branch point
2313
 
            graph = self.branch.repository.get_graph()
2314
 
            base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2315
 
                                                last_rev)
2316
 
            base_tree = self.branch.repository.revision_tree(base_rev_id)
2317
 
 
2318
 
            nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
2319
 
                                             this_tree=self,
2320
 
                                             change_reporter=change_reporter)
2321
 
            self.set_last_revision(revision)
2322
2216
            # TODO - dedup parents list with things merged by pull ?
2323
2217
            # reuse the tree we've updated to to set the basis:
2324
 
            parent_trees = [(revision, to_tree)]
 
2218
            parent_trees = [(self.branch.last_revision(), to_tree)]
2325
2219
            merges = self.get_parent_ids()[1:]
2326
2220
            # Ideally we ask the tree for the trees here, that way the working
2327
 
            # tree can decide whether to give us the entire tree or give us a
 
2221
            # tree can decide whether to give us teh entire tree or give us a
2328
2222
            # lazy initialised tree. dirstate for instance will have the trees
2329
2223
            # in ram already, whereas a last-revision + basis-inventory tree
2330
2224
            # will not, but also does not need them when setting parents.
2331
2225
            for parent in merges:
2332
2226
                parent_trees.append(
2333
2227
                    (parent, self.branch.repository.revision_tree(parent)))
2334
 
            if not _mod_revision.is_null(old_tip):
 
2228
            if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2335
2229
                parent_trees.append(
2336
2230
                    (old_tip, self.branch.repository.revision_tree(old_tip)))
2337
2231
            self.set_parent_trees(parent_trees)
2338
2232
            last_rev = parent_trees[0][0]
2339
 
        return nb_conflicts
 
2233
        else:
 
2234
            # the working tree had the same last-revision as the master
 
2235
            # branch did. We may still have pivot local work from the local
 
2236
            # branch into old_tip:
 
2237
            if (old_tip is not None and not _mod_revision.is_null(old_tip)):
 
2238
                self.add_parent_tree_id(old_tip)
 
2239
        if (old_tip is not None and not _mod_revision.is_null(old_tip)
 
2240
            and old_tip != last_rev):
 
2241
            # our last revision was not the prior branch last revision
 
2242
            # and we have converted that last revision to a pending merge.
 
2243
            # base is somewhere between the branch tip now
 
2244
            # and the now pending merge
 
2245
 
 
2246
            # Since we just modified the working tree and inventory, flush out
 
2247
            # the current state, before we modify it again.
 
2248
            # TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
 
2249
            #       requires it only because TreeTransform directly munges the
 
2250
            #       inventory and calls tree._write_inventory(). Ultimately we
 
2251
            #       should be able to remove this extra flush.
 
2252
            self.flush()
 
2253
            graph = self.branch.repository.get_graph()
 
2254
            base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
 
2255
                                                old_tip)
 
2256
            base_tree = self.branch.repository.revision_tree(base_rev_id)
 
2257
            other_tree = self.branch.repository.revision_tree(old_tip)
 
2258
            result += merge.merge_inner(
 
2259
                                  self.branch,
 
2260
                                  other_tree,
 
2261
                                  base_tree,
 
2262
                                  this_tree=self,
 
2263
                                  change_reporter=change_reporter)
 
2264
        return result
2340
2265
 
2341
2266
    def _write_hashcache_if_dirty(self):
2342
2267
        """Write out the hashcache if it is dirty."""
2442
2367
                    bzrdir_loc = bisect_left(cur_disk_dir_content,
2443
2368
                        ('.bzr', '.bzr'))
2444
2369
                    if (bzrdir_loc < len(cur_disk_dir_content)
2445
 
                        and self.bzrdir.is_control_filename(
2446
 
                            cur_disk_dir_content[bzrdir_loc][0])):
 
2370
                        and cur_disk_dir_content[bzrdir_loc][0] == '.bzr'):
2447
2371
                        # we dont yield the contents of, or, .bzr itself.
2448
2372
                        del cur_disk_dir_content[bzrdir_loc]
2449
2373
            if inv_finished:
2583
2507
        return un_resolved, resolved
2584
2508
 
2585
2509
    @needs_read_lock
2586
 
    def _check(self, references):
2587
 
        """Check the tree for consistency.
2588
 
 
2589
 
        :param references: A dict with keys matching the items returned by
2590
 
            self._get_check_refs(), and values from looking those keys up in
2591
 
            the repository.
2592
 
        """
 
2510
    def _check(self):
2593
2511
        tree_basis = self.basis_tree()
2594
2512
        tree_basis.lock_read()
2595
2513
        try:
2596
 
            repo_basis = references[('trees', self.last_revision())]
 
2514
            repo_basis = self.branch.repository.revision_tree(
 
2515
                self.last_revision())
2597
2516
            if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2598
2517
                raise errors.BzrCheckError(
2599
2518
                    "Mismatched basis inventory content.")
2612
2531
        """
2613
2532
        return
2614
2533
 
 
2534
    @needs_read_lock
2615
2535
    def _get_rules_searcher(self, default_searcher):
2616
2536
        """See Tree._get_rules_searcher."""
2617
2537
        if self._rules_searcher is None:
2644
2564
        if self._inventory is None:
2645
2565
            self.read_working_inventory()
2646
2566
 
2647
 
    def _get_check_refs(self):
2648
 
        """Return the references needed to perform a check of this tree."""
2649
 
        return [('trees', self.last_revision())]
2650
 
 
2651
2567
    def lock_tree_write(self):
2652
2568
        """See WorkingTree.lock_tree_write().
2653
2569
 
2654
2570
        In Format2 WorkingTrees we have a single lock for the branch and tree
2655
2571
        so lock_tree_write() degrades to lock_write().
2656
 
 
2657
 
        :return: An object with an unlock method which will release the lock
2658
 
            obtained.
2659
2572
        """
2660
2573
        self.branch.lock_write()
2661
2574
        try:
2662
 
            self._control_files.lock_write()
2663
 
            return self
 
2575
            return self._control_files.lock_write()
2664
2576
        except:
2665
2577
            self.branch.unlock()
2666
2578
            raise
2703
2615
 
2704
2616
    def _change_last_revision(self, revision_id):
2705
2617
        """See WorkingTree._change_last_revision."""
2706
 
        if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
 
2618
        if revision_id is None or revision_id == NULL_REVISION:
2707
2619
            try:
2708
2620
                self._transport.delete('last-revision')
2709
2621
            except errors.NoSuchFile:
2714
2626
                mode=self.bzrdir._get_file_mode())
2715
2627
            return True
2716
2628
 
2717
 
    def _get_check_refs(self):
2718
 
        """Return the references needed to perform a check of this tree."""
2719
 
        return [('trees', self.last_revision())]
2720
 
 
2721
2629
    @needs_tree_write_lock
2722
2630
    def set_conflicts(self, conflicts):
2723
2631
        self._put_rio('conflicts', conflicts.to_stanzas(),
2800
2708
        """Return the format for the working tree object in a_bzrdir."""
2801
2709
        try:
2802
2710
            transport = a_bzrdir.get_workingtree_transport(None)
2803
 
            format_string = transport.get_bytes("format")
 
2711
            format_string = transport.get("format").read()
2804
2712
            return klass._formats[format_string]
2805
2713
        except errors.NoSuchFile:
2806
2714
            raise errors.NoWorkingTree(base=transport.base)
2877
2785
        no working tree.  (See bug #43064).
2878
2786
        """
2879
2787
        sio = StringIO()
2880
 
        inv = inventory.Inventory()
 
2788
        inv = Inventory()
2881
2789
        xml5.serializer_v5.write_inventory(inv, sio, working=True)
2882
2790
        sio.seek(0)
2883
2791
        transport.put_file('inventory', sio, file_mode)
2899
2807
            branch.generate_revision_history(revision_id)
2900
2808
        finally:
2901
2809
            branch.unlock()
2902
 
        inv = inventory.Inventory()
 
2810
        inv = Inventory()
2903
2811
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2904
2812
                         branch,
2905
2813
                         inv,
3022
2930
            # only set an explicit root id if there is one to set.
3023
2931
            if basis_tree.inventory.root is not None:
3024
2932
                wt.set_root_id(basis_tree.get_root_id())
3025
 
            if revision_id == _mod_revision.NULL_REVISION:
 
2933
            if revision_id == NULL_REVISION:
3026
2934
                wt.set_parent_trees([])
3027
2935
            else:
3028
2936
                wt.set_parent_trees([(revision_id, basis_tree)])
3035
2943
        return wt
3036
2944
 
3037
2945
    def _initial_inventory(self):
3038
 
        return inventory.Inventory()
 
2946
        return Inventory()
3039
2947
 
3040
2948
    def __init__(self):
3041
2949
        super(WorkingTreeFormat3, self).__init__()
3070
2978
        return self.get_format_string()
3071
2979
 
3072
2980
 
3073
 
__default_format = WorkingTreeFormat6()
 
2981
__default_format = WorkingTreeFormat4()
3074
2982
WorkingTreeFormat.register_format(__default_format)
3075
2983
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3076
 
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3077
2984
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3078
2985
WorkingTreeFormat.set_default_format(__default_format)
3079
2986
# formats which have no format string are not discoverable