/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Robert Collins
  • Date: 2010-05-06 11:08:10 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506110810-h3j07fh5gmw54s25
Cleaner matcher matching revised unlocking protocol.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
 
1
# Copyright (C) 2005-2010 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)
38
32
 
39
33
from cStringIO import StringIO
40
34
import os
48
42
import itertools
49
43
import operator
50
44
import stat
51
 
from time import time
52
 
import warnings
53
45
import re
54
46
 
55
47
import bzrlib
57
49
    branch,
58
50
    bzrdir,
59
51
    conflicts as _mod_conflicts,
60
 
    dirstate,
61
52
    errors,
62
53
    generate_ids,
63
54
    globbing,
 
55
    graph as _mod_graph,
64
56
    hashcache,
65
57
    ignores,
 
58
    inventory,
66
59
    merge,
67
60
    revision as _mod_revision,
68
61
    revisiontree,
69
 
    repository,
70
 
    textui,
71
62
    trace,
72
63
    transform,
73
64
    ui,
74
 
    urlutils,
75
65
    views,
76
66
    xml5,
77
 
    xml6,
78
67
    xml7,
79
68
    )
80
69
import bzrlib.branch
81
70
from bzrlib.transport import get_transport
82
 
import bzrlib.ui
83
71
from bzrlib.workingtree_4 import (
84
72
    WorkingTreeFormat4,
85
73
    WorkingTreeFormat5,
89
77
 
90
78
from bzrlib import symbol_versioning
91
79
from bzrlib.decorators import needs_read_lock, needs_write_lock
92
 
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, TreeReference
93
80
from bzrlib.lockable_files import LockableFiles
94
81
from bzrlib.lockdir import LockDir
95
82
import bzrlib.mutabletree
96
83
from bzrlib.mutabletree import needs_tree_write_lock
97
84
from bzrlib import osutils
98
85
from bzrlib.osutils import (
99
 
    compact_date,
100
86
    file_kind,
101
87
    isdir,
102
88
    normpath,
103
89
    pathjoin,
104
 
    rand_chars,
105
90
    realpath,
106
91
    safe_unicode,
107
92
    splitpath,
110
95
from bzrlib.filters import filtered_input_file
111
96
from bzrlib.trace import mutter, note
112
97
from bzrlib.transport.local import LocalTransport
113
 
from bzrlib.progress import DummyProgress, ProgressPhase
114
 
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
 
98
from bzrlib.revision import CURRENT_REVISION
115
99
from bzrlib.rio import RioReader, rio_file, Stanza
116
 
from bzrlib.symbol_versioning import (deprecated_passed,
117
 
        deprecated_method,
118
 
        deprecated_function,
119
 
        DEPRECATED_PARAMETER,
120
 
        )
 
100
from bzrlib.symbol_versioning import (
 
101
    deprecated_passed,
 
102
    DEPRECATED_PARAMETER,
 
103
    )
121
104
 
122
105
 
123
106
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.
124
110
CONFLICT_HEADER_1 = "BZR conflict list format 1"
125
111
 
126
112
ERROR_PATH_NOT_FOUND = 3    # WindowsError errno code, equivalent to ENOENT
181
167
        return ''
182
168
 
183
169
 
184
 
class WorkingTree(bzrlib.mutabletree.MutableTree):
 
170
class WorkingTree(bzrlib.mutabletree.MutableTree,
 
171
    bzrdir.ControlComponent):
185
172
    """Working copy tree.
186
173
 
187
174
    The inventory is held in the `Branch` working-inventory, and the
260
247
        self._rules_searcher = None
261
248
        self.views = self._make_views()
262
249
 
 
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
 
263
258
    def _detect_case_handling(self):
264
259
        wt_trans = self.bzrdir.get_workingtree_transport(None)
265
260
        try:
290
285
        self._control_files.break_lock()
291
286
        self.branch.break_lock()
292
287
 
 
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
 
293
298
    def requires_rich_root(self):
294
299
        return self._format.requires_rich_root
295
300
 
487
492
        incorrectly attributed to CURRENT_REVISION (but after committing, the
488
493
        attribution will be correct).
489
494
        """
490
 
        basis = self.basis_tree()
491
 
        basis.lock_read()
492
 
        try:
493
 
            changes = self.iter_changes(basis, True, [self.id2path(file_id)],
494
 
                require_versioned=True).next()
495
 
            changed_content, kind = changes[2], changes[6]
496
 
            if not changed_content:
497
 
                return basis.annotate_iter(file_id)
498
 
            if kind[1] is None:
499
 
                return None
500
 
            import annotate
501
 
            if kind[0] != 'file':
502
 
                old_lines = []
503
 
            else:
504
 
                old_lines = list(basis.annotate_iter(file_id))
505
 
            old = [old_lines]
506
 
            for tree in self.branch.repository.revision_trees(
507
 
                self.get_parent_ids()[1:]):
508
 
                if file_id not in tree:
509
 
                    continue
510
 
                old.append(list(tree.annotate_iter(file_id)))
511
 
            return annotate.reannotate(old, self.get_file(file_id).readlines(),
512
 
                                       default_revision)
513
 
        finally:
514
 
            basis.unlock()
 
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
515
531
 
516
532
    def _get_ancestors(self, default_revision):
517
533
        ancestors = set([default_revision])
532
548
        else:
533
549
            parents = [last_rev]
534
550
        try:
535
 
            merges_file = self._transport.get('pending-merges')
 
551
            merges_bytes = self._transport.get_bytes('pending-merges')
536
552
        except errors.NoSuchFile:
537
553
            pass
538
554
        else:
539
 
            for l in merges_file.readlines():
 
555
            for l in osutils.split_lines(merges_bytes):
540
556
                revision_id = l.rstrip('\n')
541
557
                parents.append(revision_id)
542
558
        return parents
601
617
 
602
618
    def get_file_size(self, file_id):
603
619
        """See Tree.get_file_size"""
 
620
        # XXX: this returns the on-disk size; it should probably return the
 
621
        # canonical size
604
622
        try:
605
623
            return os.path.getsize(self.id2abspath(file_id))
606
624
        except OSError, e:
622
640
 
623
641
    def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
624
642
        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
625
647
        return self._inventory[file_id].executable
626
648
 
627
649
    def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
737
759
            raise
738
760
        kind = _mapper(stat_result.st_mode)
739
761
        if kind == 'file':
740
 
            size = stat_result.st_size
741
 
            # try for a stat cache lookup
742
 
            executable = self._is_executable_from_path_and_stat(path, stat_result)
743
 
            return (kind, size, executable, self._sha_from_stat(
744
 
                path, stat_result))
 
762
            return self._file_content_summary(path, stat_result)
745
763
        elif kind == 'directory':
746
764
            # perhaps it looks like a plain directory, but it's really a
747
765
            # reference.
754
772
        else:
755
773
            return (kind, None, None, None)
756
774
 
 
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
 
757
782
    def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
758
783
        """Common ghost checking functionality from set_parent_*.
759
784
 
879
904
 
880
905
    @needs_write_lock # because merge pulls data into the branch.
881
906
    def merge_from_branch(self, branch, to_revision=None, from_revision=None,
882
 
        merge_type=None):
 
907
                          merge_type=None, force=False):
883
908
        """Merge from a branch into this working tree.
884
909
 
885
910
        :param branch: The branch to merge from.
889
914
            branch.last_revision().
890
915
        """
891
916
        from bzrlib.merge import Merger, Merge3Merger
892
 
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
893
 
        try:
894
 
            merger = Merger(self.branch, this_tree=self, pb=pb)
895
 
            merger.pp = ProgressPhase("Merge phase", 5, pb)
896
 
            merger.pp.next_phase()
897
 
            # check that there are no
898
 
            # local alterations
899
 
            merger.check_basis(check_clean=True, require_commits=False)
900
 
            if to_revision is None:
901
 
                to_revision = _mod_revision.ensure_null(branch.last_revision())
902
 
            merger.other_rev_id = to_revision
903
 
            if _mod_revision.is_null(merger.other_rev_id):
904
 
                raise errors.NoCommits(branch)
905
 
            self.branch.fetch(branch, last_revision=merger.other_rev_id)
906
 
            merger.other_basis = merger.other_rev_id
907
 
            merger.other_tree = self.branch.repository.revision_tree(
908
 
                merger.other_rev_id)
909
 
            merger.other_branch = branch
910
 
            merger.pp.next_phase()
911
 
            if from_revision is None:
912
 
                merger.find_base()
913
 
            else:
914
 
                merger.set_base_revision(from_revision, branch)
915
 
            if merger.base_rev_id == merger.other_rev_id:
916
 
                raise errors.PointlessMerge
917
 
            merger.backup_files = False
918
 
            if merge_type is None:
919
 
                merger.merge_type = Merge3Merger
920
 
            else:
921
 
                merger.merge_type = merge_type
922
 
            merger.set_interesting_files(None)
923
 
            merger.show_base = False
924
 
            merger.reprocess = False
925
 
            conflicts = merger.do_merge()
926
 
            merger.set_pending()
927
 
        finally:
928
 
            pb.finished()
 
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()
929
947
        return conflicts
930
948
 
931
949
    @needs_read_lock
1078
1096
        tree_transport = self.bzrdir.root_transport.clone(sub_path)
1079
1097
        if tree_transport.base != branch_transport.base:
1080
1098
            tree_bzrdir = format.initialize_on_transport(tree_transport)
1081
 
            branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
 
1099
            branch.BranchReferenceFormat().initialize(tree_bzrdir,
 
1100
                target_branch=new_branch)
1082
1101
        else:
1083
1102
            tree_bzrdir = branch_bzrdir
1084
 
        wt = tree_bzrdir.create_workingtree(NULL_REVISION)
 
1103
        wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
1085
1104
        wt.set_parent_ids(self.get_parent_ids())
1086
1105
        my_inv = self.inventory
1087
 
        child_inv = Inventory(root_id=None)
 
1106
        child_inv = inventory.Inventory(root_id=None)
1088
1107
        new_root = my_inv[file_id]
1089
1108
        my_inv.remove_recursive_id(file_id)
1090
1109
        new_root.parent_id = None
1122
1141
        This does not include files that have been deleted in this
1123
1142
        tree. Skips the control directory.
1124
1143
 
1125
 
        :param include_root: if True, do not return an entry for the root
 
1144
        :param include_root: if True, return an entry for the root
1126
1145
        :param from_dir: start from this directory or None for the root
1127
1146
        :param recursive: whether to recurse into subdirectories or not
1128
1147
        """
1416
1435
        inv = self.inventory
1417
1436
        for entry in moved:
1418
1437
            try:
1419
 
                self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
 
1438
                self._move_entry(WorkingTree._RenameEntry(
 
1439
                    entry.to_rel, entry.from_id,
1420
1440
                    entry.to_tail, entry.to_parent_id, entry.from_rel,
1421
1441
                    entry.from_tail, entry.from_parent_id,
1422
1442
                    entry.only_change_inv))
1473
1493
        from_tail = splitpath(from_rel)[-1]
1474
1494
        from_id = inv.path2id(from_rel)
1475
1495
        if from_id is None:
1476
 
            raise errors.BzrRenameFailedError(from_rel,to_rel,
1477
 
                errors.NotVersionedError(path=str(from_rel)))
1478
 
        from_entry = inv[from_id]
 
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]
1479
1507
        from_parent_id = from_entry.parent_id
1480
1508
        to_dir, to_tail = os.path.split(to_rel)
1481
1509
        to_dir_id = inv.path2id(to_dir)
1573
1601
    @needs_write_lock
1574
1602
    def pull(self, source, overwrite=False, stop_revision=None,
1575
1603
             change_reporter=None, possible_transports=None, local=False):
1576
 
        top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1577
1604
        source.lock_read()
1578
1605
        try:
1579
 
            pp = ProgressPhase("Pull phase", 2, top_pb)
1580
 
            pp.next_phase()
1581
1606
            old_revision_info = self.branch.last_revision_info()
1582
1607
            basis_tree = self.basis_tree()
1583
1608
            count = self.branch.pull(source, overwrite, stop_revision,
1585
1610
                                     local=local)
1586
1611
            new_revision_info = self.branch.last_revision_info()
1587
1612
            if new_revision_info != old_revision_info:
1588
 
                pp.next_phase()
1589
1613
                repository = self.branch.repository
1590
 
                pb = bzrlib.ui.ui_factory.nested_progress_bar()
1591
1614
                basis_tree.lock_read()
1592
1615
                try:
1593
1616
                    new_basis_tree = self.branch.basis_tree()
1596
1619
                                new_basis_tree,
1597
1620
                                basis_tree,
1598
1621
                                this_tree=self,
1599
 
                                pb=pb,
 
1622
                                pb=None,
1600
1623
                                change_reporter=change_reporter)
1601
 
                    if (basis_tree.inventory.root is None and
1602
 
                        new_basis_tree.inventory.root is not None):
1603
 
                        self.set_root_id(new_basis_tree.get_root_id())
 
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)
1604
1628
                finally:
1605
 
                    pb.finished()
1606
1629
                    basis_tree.unlock()
1607
1630
                # TODO - dedup parents list with things merged by pull ?
1608
1631
                # reuse the revisiontree we merged against to set the new
1621
1644
            return count
1622
1645
        finally:
1623
1646
            source.unlock()
1624
 
            top_pb.finished()
1625
1647
 
1626
1648
    @needs_write_lock
1627
1649
    def put_file_bytes_non_atomic(self, file_id, bytes):
1712
1734
        r"""Check whether the filename matches an ignore pattern.
1713
1735
 
1714
1736
        Patterns containing '/' or '\' need to match the whole path;
1715
 
        others match against only the last component.
 
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.
1716
1740
 
1717
1741
        If the file is ignored, returns the pattern which caused it to
1718
1742
        be ignored, otherwise None.  So this can simply be used as a
1719
1743
        boolean if desired."""
1720
1744
        if getattr(self, '_ignoreglobster', None) is None:
1721
 
            self._ignoreglobster = globbing.Globster(self.get_ignore_list())
 
1745
            self._ignoreglobster = globbing.ExceptionGlobster(self.get_ignore_list())
1722
1746
        return self._ignoreglobster.match(filename)
1723
1747
 
1724
1748
    def kind(self, file_id):
1815
1839
    def _reset_data(self):
1816
1840
        """Reset transient data that cannot be revalidated."""
1817
1841
        self._inventory_is_modified = False
1818
 
        result = self._deserialize(self._transport.get('inventory'))
 
1842
        f = self._transport.get('inventory')
 
1843
        try:
 
1844
            result = self._deserialize(f)
 
1845
        finally:
 
1846
            f.close()
1819
1847
        self._set_inventory(result, dirty=False)
1820
1848
 
1821
1849
    @needs_tree_write_lock
1868
1896
            # revision_id is set. We must check for this full string, because a
1869
1897
            # root node id can legitimately look like 'revision_id' but cannot
1870
1898
            # contain a '"'.
1871
 
            xml = self.branch.repository.get_inventory_xml(new_revision)
 
1899
            xml = self.branch.repository._get_inventory_xml(new_revision)
1872
1900
            firstline = xml.split('\n', 1)[0]
1873
1901
            if (not 'revision_id="' in firstline or
1874
1902
                'format="7"' not in firstline):
1875
 
                inv = self.branch.repository.deserialise_inventory(
1876
 
                    new_revision, xml)
 
1903
                inv = self.branch.repository._serializer.read_inventory_from_string(
 
1904
                    xml, new_revision)
1877
1905
                xml = self._create_basis_xml_from_inventory(new_revision, inv)
1878
1906
            self._write_basis_inventory(xml)
1879
1907
        except (errors.NoSuchRevision, errors.RevisionNotPresent):
1897
1925
        # binary.
1898
1926
        if self._inventory_is_modified:
1899
1927
            raise errors.InventoryModified(self)
1900
 
        result = self._deserialize(self._transport.get('inventory'))
 
1928
        f = self._transport.get('inventory')
 
1929
        try:
 
1930
            result = self._deserialize(f)
 
1931
        finally:
 
1932
            f.close()
1901
1933
        self._set_inventory(result, dirty=False)
1902
1934
        return result
1903
1935
 
1918
1950
 
1919
1951
        new_files=set()
1920
1952
        unknown_nested_files=set()
 
1953
        if to_file is None:
 
1954
            to_file = sys.stdout
1921
1955
 
1922
1956
        def recurse_directory_to_add_files(directory):
1923
1957
            # Recurse directory and add all files
1993
2027
                        new_status = 'I'
1994
2028
                    else:
1995
2029
                        new_status = '?'
1996
 
                    textui.show_status(new_status, self.kind(fid), f,
1997
 
                                       to_file=to_file)
 
2030
                    # XXX: Really should be a more abstract reporter interface
 
2031
                    kind_ch = osutils.kind_marker(self.kind(fid))
 
2032
                    to_file.write(new_status + '       ' + f + kind_ch + '\n')
1998
2033
                # Unversion file
1999
2034
                inv_delta.append((f, None, fid, None))
2000
2035
                message = "removed %s" % (f,)
2023
2058
 
2024
2059
    @needs_tree_write_lock
2025
2060
    def revert(self, filenames=None, old_tree=None, backups=True,
2026
 
               pb=DummyProgress(), report_changes=False):
 
2061
               pb=None, report_changes=False):
2027
2062
        from bzrlib.conflicts import resolve
2028
2063
        if filenames == []:
2029
2064
            filenames = None
2042
2077
            if filenames is None and len(self.get_parent_ids()) > 1:
2043
2078
                parent_trees = []
2044
2079
                last_revision = self.last_revision()
2045
 
                if last_revision != NULL_REVISION:
 
2080
                if last_revision != _mod_revision.NULL_REVISION:
2046
2081
                    if basis_tree is None:
2047
2082
                        basis_tree = self.basis_tree()
2048
2083
                        basis_tree.lock_read()
2086
2121
    def set_inventory(self, new_inventory_list):
2087
2122
        from bzrlib.inventory import (Inventory,
2088
2123
                                      InventoryDirectory,
2089
 
                                      InventoryEntry,
2090
2124
                                      InventoryFile,
2091
2125
                                      InventoryLink)
2092
2126
        inv = Inventory(self.get_root_id())
2152
2186
        """
2153
2187
        raise NotImplementedError(self.unlock)
2154
2188
 
2155
 
    def update(self, change_reporter=None, possible_transports=None):
 
2189
    _marker = object()
 
2190
 
 
2191
    def update(self, change_reporter=None, possible_transports=None,
 
2192
               revision=None, old_tip=_marker):
2156
2193
        """Update a working tree along its branch.
2157
2194
 
2158
2195
        This will update the branch if its bound too, which means we have
2176
2213
        - Merge current state -> basis tree of the master w.r.t. the old tree
2177
2214
          basis.
2178
2215
        - Do a 'normal' merge of the old branch basis if it is relevant.
 
2216
 
 
2217
        :param revision: The target revision to update to. Must be in the
 
2218
            revision history.
 
2219
        :param old_tip: If branch.update() has already been run, the value it
 
2220
            returned (old tip of the branch or None). _marker is used
 
2221
            otherwise.
2179
2222
        """
2180
2223
        if self.branch.get_bound_location() is not None:
2181
2224
            self.lock_write()
2182
 
            update_branch = True
 
2225
            update_branch = (old_tip is self._marker)
2183
2226
        else:
2184
2227
            self.lock_tree_write()
2185
2228
            update_branch = False
2187
2230
            if update_branch:
2188
2231
                old_tip = self.branch.update(possible_transports)
2189
2232
            else:
2190
 
                old_tip = None
2191
 
            return self._update_tree(old_tip, change_reporter)
 
2233
                if old_tip is self._marker:
 
2234
                    old_tip = None
 
2235
            return self._update_tree(old_tip, change_reporter, revision)
2192
2236
        finally:
2193
2237
            self.unlock()
2194
2238
 
2195
2239
    @needs_tree_write_lock
2196
 
    def _update_tree(self, old_tip=None, change_reporter=None):
 
2240
    def _update_tree(self, old_tip=None, change_reporter=None, revision=None):
2197
2241
        """Update a tree to the master branch.
2198
2242
 
2199
2243
        :param old_tip: if supplied, the previous tip revision the branch,
2209
2253
        # We MUST save it even if an error occurs, because otherwise the users
2210
2254
        # local work is unreferenced and will appear to have been lost.
2211
2255
        #
2212
 
        result = 0
 
2256
        nb_conflicts = 0
2213
2257
        try:
2214
2258
            last_rev = self.get_parent_ids()[0]
2215
2259
        except IndexError:
2216
2260
            last_rev = _mod_revision.NULL_REVISION
2217
 
        if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
2218
 
            # merge tree state up to new branch tip.
 
2261
        if revision is None:
 
2262
            revision = self.branch.last_revision()
 
2263
 
 
2264
        old_tip = old_tip or _mod_revision.NULL_REVISION
 
2265
 
 
2266
        if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
 
2267
            # the branch we are bound to was updated
 
2268
            # merge those changes in first
 
2269
            base_tree  = self.basis_tree()
 
2270
            other_tree = self.branch.repository.revision_tree(old_tip)
 
2271
            nb_conflicts = merge.merge_inner(self.branch, other_tree,
 
2272
                                             base_tree, this_tree=self,
 
2273
                                             change_reporter=change_reporter)
 
2274
            if nb_conflicts:
 
2275
                self.add_parent_tree((old_tip, other_tree))
 
2276
                trace.note('Rerun update after fixing the conflicts.')
 
2277
                return nb_conflicts
 
2278
 
 
2279
        if last_rev != _mod_revision.ensure_null(revision):
 
2280
            # the working tree is up to date with the branch
 
2281
            # we can merge the specified revision from master
 
2282
            to_tree = self.branch.repository.revision_tree(revision)
 
2283
            to_root_id = to_tree.get_root_id()
 
2284
 
2219
2285
            basis = self.basis_tree()
2220
2286
            basis.lock_read()
2221
2287
            try:
2222
 
                to_tree = self.branch.basis_tree()
2223
 
                if basis.inventory.root is None:
2224
 
                    self.set_root_id(to_tree.get_root_id())
 
2288
                if (basis.inventory.root is None
 
2289
                    or basis.inventory.root.file_id != to_root_id):
 
2290
                    self.set_root_id(to_root_id)
2225
2291
                    self.flush()
2226
 
                result += merge.merge_inner(
2227
 
                                      self.branch,
2228
 
                                      to_tree,
2229
 
                                      basis,
2230
 
                                      this_tree=self,
2231
 
                                      change_reporter=change_reporter)
2232
2292
            finally:
2233
2293
                basis.unlock()
 
2294
 
 
2295
            # determine the branch point
 
2296
            graph = self.branch.repository.get_graph()
 
2297
            base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
 
2298
                                                last_rev)
 
2299
            base_tree = self.branch.repository.revision_tree(base_rev_id)
 
2300
 
 
2301
            nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
 
2302
                                             this_tree=self,
 
2303
                                             change_reporter=change_reporter)
 
2304
            self.set_last_revision(revision)
2234
2305
            # TODO - dedup parents list with things merged by pull ?
2235
2306
            # reuse the tree we've updated to to set the basis:
2236
 
            parent_trees = [(self.branch.last_revision(), to_tree)]
 
2307
            parent_trees = [(revision, to_tree)]
2237
2308
            merges = self.get_parent_ids()[1:]
2238
2309
            # Ideally we ask the tree for the trees here, that way the working
2239
2310
            # tree can decide whether to give us the entire tree or give us a
2243
2314
            for parent in merges:
2244
2315
                parent_trees.append(
2245
2316
                    (parent, self.branch.repository.revision_tree(parent)))
2246
 
            if (old_tip is not None and not _mod_revision.is_null(old_tip)):
 
2317
            if not _mod_revision.is_null(old_tip):
2247
2318
                parent_trees.append(
2248
2319
                    (old_tip, self.branch.repository.revision_tree(old_tip)))
2249
2320
            self.set_parent_trees(parent_trees)
2250
2321
            last_rev = parent_trees[0][0]
2251
 
        else:
2252
 
            # the working tree had the same last-revision as the master
2253
 
            # branch did. We may still have pivot local work from the local
2254
 
            # branch into old_tip:
2255
 
            if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2256
 
                self.add_parent_tree_id(old_tip)
2257
 
        if (old_tip is not None and not _mod_revision.is_null(old_tip)
2258
 
            and old_tip != last_rev):
2259
 
            # our last revision was not the prior branch last revision
2260
 
            # and we have converted that last revision to a pending merge.
2261
 
            # base is somewhere between the branch tip now
2262
 
            # and the now pending merge
2263
 
 
2264
 
            # Since we just modified the working tree and inventory, flush out
2265
 
            # the current state, before we modify it again.
2266
 
            # TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2267
 
            #       requires it only because TreeTransform directly munges the
2268
 
            #       inventory and calls tree._write_inventory(). Ultimately we
2269
 
            #       should be able to remove this extra flush.
2270
 
            self.flush()
2271
 
            graph = self.branch.repository.get_graph()
2272
 
            base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2273
 
                                                old_tip)
2274
 
            base_tree = self.branch.repository.revision_tree(base_rev_id)
2275
 
            other_tree = self.branch.repository.revision_tree(old_tip)
2276
 
            result += merge.merge_inner(
2277
 
                                  self.branch,
2278
 
                                  other_tree,
2279
 
                                  base_tree,
2280
 
                                  this_tree=self,
2281
 
                                  change_reporter=change_reporter)
2282
 
        return result
 
2322
        return nb_conflicts
2283
2323
 
2284
2324
    def _write_hashcache_if_dirty(self):
2285
2325
        """Write out the hashcache if it is dirty."""
2526
2566
        return un_resolved, resolved
2527
2567
 
2528
2568
    @needs_read_lock
2529
 
    def _check(self):
 
2569
    def _check(self, references):
 
2570
        """Check the tree for consistency.
 
2571
 
 
2572
        :param references: A dict with keys matching the items returned by
 
2573
            self._get_check_refs(), and values from looking those keys up in
 
2574
            the repository.
 
2575
        """
2530
2576
        tree_basis = self.basis_tree()
2531
2577
        tree_basis.lock_read()
2532
2578
        try:
2533
 
            repo_basis = self.branch.repository.revision_tree(
2534
 
                self.last_revision())
 
2579
            repo_basis = references[('trees', self.last_revision())]
2535
2580
            if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2536
2581
                raise errors.BzrCheckError(
2537
2582
                    "Mismatched basis inventory content.")
2550
2595
        """
2551
2596
        return
2552
2597
 
2553
 
    @needs_read_lock
2554
2598
    def _get_rules_searcher(self, default_searcher):
2555
2599
        """See Tree._get_rules_searcher."""
2556
2600
        if self._rules_searcher is None:
2583
2627
        if self._inventory is None:
2584
2628
            self.read_working_inventory()
2585
2629
 
 
2630
    def _get_check_refs(self):
 
2631
        """Return the references needed to perform a check of this tree."""
 
2632
        return [('trees', self.last_revision())]
 
2633
 
2586
2634
    def lock_tree_write(self):
2587
2635
        """See WorkingTree.lock_tree_write().
2588
2636
 
2634
2682
 
2635
2683
    def _change_last_revision(self, revision_id):
2636
2684
        """See WorkingTree._change_last_revision."""
2637
 
        if revision_id is None or revision_id == NULL_REVISION:
 
2685
        if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
2638
2686
            try:
2639
2687
                self._transport.delete('last-revision')
2640
2688
            except errors.NoSuchFile:
2645
2693
                mode=self.bzrdir._get_file_mode())
2646
2694
            return True
2647
2695
 
 
2696
    def _get_check_refs(self):
 
2697
        """Return the references needed to perform a check of this tree."""
 
2698
        return [('trees', self.last_revision())]
 
2699
 
2648
2700
    @needs_tree_write_lock
2649
2701
    def set_conflicts(self, conflicts):
2650
2702
        self._put_rio('conflicts', conflicts.to_stanzas(),
2727
2779
        """Return the format for the working tree object in a_bzrdir."""
2728
2780
        try:
2729
2781
            transport = a_bzrdir.get_workingtree_transport(None)
2730
 
            format_string = transport.get("format").read()
 
2782
            format_string = transport.get_bytes("format")
2731
2783
            return klass._formats[format_string]
2732
2784
        except errors.NoSuchFile:
2733
2785
            raise errors.NoWorkingTree(base=transport.base)
2804
2856
        no working tree.  (See bug #43064).
2805
2857
        """
2806
2858
        sio = StringIO()
2807
 
        inv = Inventory()
 
2859
        inv = inventory.Inventory()
2808
2860
        xml5.serializer_v5.write_inventory(inv, sio, working=True)
2809
2861
        sio.seek(0)
2810
2862
        transport.put_file('inventory', sio, file_mode)
2826
2878
            branch.generate_revision_history(revision_id)
2827
2879
        finally:
2828
2880
            branch.unlock()
2829
 
        inv = Inventory()
 
2881
        inv = inventory.Inventory()
2830
2882
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2831
2883
                         branch,
2832
2884
                         inv,
2949
3001
            # only set an explicit root id if there is one to set.
2950
3002
            if basis_tree.inventory.root is not None:
2951
3003
                wt.set_root_id(basis_tree.get_root_id())
2952
 
            if revision_id == NULL_REVISION:
 
3004
            if revision_id == _mod_revision.NULL_REVISION:
2953
3005
                wt.set_parent_trees([])
2954
3006
            else:
2955
3007
                wt.set_parent_trees([(revision_id, basis_tree)])
2962
3014
        return wt
2963
3015
 
2964
3016
    def _initial_inventory(self):
2965
 
        return Inventory()
 
3017
        return inventory.Inventory()
2966
3018
 
2967
3019
    def __init__(self):
2968
3020
        super(WorkingTreeFormat3, self).__init__()
2997
3049
        return self.get_format_string()
2998
3050
 
2999
3051
 
3000
 
__default_format = WorkingTreeFormat4()
 
3052
__default_format = WorkingTreeFormat6()
3001
3053
WorkingTreeFormat.register_format(__default_format)
3002
 
WorkingTreeFormat.register_format(WorkingTreeFormat6())
3003
3054
WorkingTreeFormat.register_format(WorkingTreeFormat5())
 
3055
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3004
3056
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3005
3057
WorkingTreeFormat.set_default_format(__default_format)
3006
3058
# formats which have no format string are not discoverable