~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Robert Collins
  • Date: 2009-08-24 21:05:09 UTC
  • mto: This revision was merged to the branch mainline in revision 4645.
  • Revision ID: robertc@robertcollins.net-20090824210509-pproia2q9evq1nsl
lsprof support.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 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
59
65
    merge,
60
66
    revision as _mod_revision,
61
67
    revisiontree,
 
68
    textui,
62
69
    trace,
63
70
    transform,
64
71
    ui,
95
102
from bzrlib.filters import filtered_input_file
96
103
from bzrlib.trace import mutter, note
97
104
from bzrlib.transport.local import LocalTransport
 
105
from bzrlib.progress import DummyProgress, ProgressPhase
98
106
from bzrlib.revision import CURRENT_REVISION
99
107
from bzrlib.rio import RioReader, rio_file, Stanza
100
108
from bzrlib.symbol_versioning import (
104
112
 
105
113
 
106
114
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
115
CONFLICT_HEADER_1 = "BZR conflict list format 1"
111
116
 
112
117
ERROR_PATH_NOT_FOUND = 3    # WindowsError errno code, equivalent to ENOENT
167
172
        return ''
168
173
 
169
174
 
170
 
class WorkingTree(bzrlib.mutabletree.MutableTree,
171
 
    bzrdir.ControlComponent):
 
175
class WorkingTree(bzrlib.mutabletree.MutableTree):
172
176
    """Working copy tree.
173
177
 
174
178
    The inventory is held in the `Branch` working-inventory, and the
247
251
        self._rules_searcher = None
248
252
        self.views = self._make_views()
249
253
 
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
254
    def _detect_case_handling(self):
259
255
        wt_trans = self.bzrdir.get_workingtree_transport(None)
260
256
        try:
548
544
        else:
549
545
            parents = [last_rev]
550
546
        try:
551
 
            merges_bytes = self._transport.get_bytes('pending-merges')
 
547
            merges_file = self._transport.get('pending-merges')
552
548
        except errors.NoSuchFile:
553
549
            pass
554
550
        else:
555
 
            for l in osutils.split_lines(merges_bytes):
 
551
            for l in merges_file.readlines():
556
552
                revision_id = l.rstrip('\n')
557
553
                parents.append(revision_id)
558
554
        return parents
617
613
 
618
614
    def get_file_size(self, file_id):
619
615
        """See Tree.get_file_size"""
620
 
        # XXX: this returns the on-disk size; it should probably return the
621
 
        # canonical size
622
616
        try:
623
617
            return os.path.getsize(self.id2abspath(file_id))
624
618
        except OSError, e:
640
634
 
641
635
    def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
642
636
        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
637
        return self._inventory[file_id].executable
648
638
 
649
639
    def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
759
749
            raise
760
750
        kind = _mapper(stat_result.st_mode)
761
751
        if kind == 'file':
762
 
            return self._file_content_summary(path, stat_result)
 
752
            size = stat_result.st_size
 
753
            # try for a stat cache lookup
 
754
            executable = self._is_executable_from_path_and_stat(path, stat_result)
 
755
            return (kind, size, executable, self._sha_from_stat(
 
756
                path, stat_result))
763
757
        elif kind == 'directory':
764
758
            # perhaps it looks like a plain directory, but it's really a
765
759
            # reference.
772
766
        else:
773
767
            return (kind, None, None, None)
774
768
 
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
769
    def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
783
770
        """Common ghost checking functionality from set_parent_*.
784
771
 
904
891
 
905
892
    @needs_write_lock # because merge pulls data into the branch.
906
893
    def merge_from_branch(self, branch, to_revision=None, from_revision=None,
907
 
                          merge_type=None, force=False):
 
894
        merge_type=None):
908
895
        """Merge from a branch into this working tree.
909
896
 
910
897
        :param branch: The branch to merge from.
914
901
            branch.last_revision().
915
902
        """
916
903
        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()
 
904
        pb = ui.ui_factory.nested_progress_bar()
 
905
        try:
 
906
            merger = Merger(self.branch, this_tree=self, pb=pb)
 
907
            merger.pp = ProgressPhase("Merge phase", 5, pb)
 
908
            merger.pp.next_phase()
 
909
            # check that there are no
 
910
            # local alterations
 
911
            merger.check_basis(check_clean=True, require_commits=False)
 
912
            if to_revision is None:
 
913
                to_revision = _mod_revision.ensure_null(branch.last_revision())
 
914
            merger.other_rev_id = to_revision
 
915
            if _mod_revision.is_null(merger.other_rev_id):
 
916
                raise errors.NoCommits(branch)
 
917
            self.branch.fetch(branch, last_revision=merger.other_rev_id)
 
918
            merger.other_basis = merger.other_rev_id
 
919
            merger.other_tree = self.branch.repository.revision_tree(
 
920
                merger.other_rev_id)
 
921
            merger.other_branch = branch
 
922
            merger.pp.next_phase()
 
923
            if from_revision is None:
 
924
                merger.find_base()
 
925
            else:
 
926
                merger.set_base_revision(from_revision, branch)
 
927
            if merger.base_rev_id == merger.other_rev_id:
 
928
                raise errors.PointlessMerge
 
929
            merger.backup_files = False
 
930
            if merge_type is None:
 
931
                merger.merge_type = Merge3Merger
 
932
            else:
 
933
                merger.merge_type = merge_type
 
934
            merger.set_interesting_files(None)
 
935
            merger.show_base = False
 
936
            merger.reprocess = False
 
937
            conflicts = merger.do_merge()
 
938
            merger.set_pending()
 
939
        finally:
 
940
            pb.finished()
947
941
        return conflicts
948
942
 
949
943
    @needs_read_lock
1096
1090
        tree_transport = self.bzrdir.root_transport.clone(sub_path)
1097
1091
        if tree_transport.base != branch_transport.base:
1098
1092
            tree_bzrdir = format.initialize_on_transport(tree_transport)
1099
 
            branch.BranchReferenceFormat().initialize(tree_bzrdir,
1100
 
                target_branch=new_branch)
 
1093
            branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1101
1094
        else:
1102
1095
            tree_bzrdir = branch_bzrdir
1103
1096
        wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
1141
1134
        This does not include files that have been deleted in this
1142
1135
        tree. Skips the control directory.
1143
1136
 
1144
 
        :param include_root: if True, return an entry for the root
 
1137
        :param include_root: if True, do not return an entry for the root
1145
1138
        :param from_dir: start from this directory or None for the root
1146
1139
        :param recursive: whether to recurse into subdirectories or not
1147
1140
        """
1601
1594
    @needs_write_lock
1602
1595
    def pull(self, source, overwrite=False, stop_revision=None,
1603
1596
             change_reporter=None, possible_transports=None, local=False):
 
1597
        top_pb = ui.ui_factory.nested_progress_bar()
1604
1598
        source.lock_read()
1605
1599
        try:
 
1600
            pp = ProgressPhase("Pull phase", 2, top_pb)
 
1601
            pp.next_phase()
1606
1602
            old_revision_info = self.branch.last_revision_info()
1607
1603
            basis_tree = self.basis_tree()
1608
1604
            count = self.branch.pull(source, overwrite, stop_revision,
1610
1606
                                     local=local)
1611
1607
            new_revision_info = self.branch.last_revision_info()
1612
1608
            if new_revision_info != old_revision_info:
 
1609
                pp.next_phase()
1613
1610
                repository = self.branch.repository
 
1611
                pb = ui.ui_factory.nested_progress_bar()
1614
1612
                basis_tree.lock_read()
1615
1613
                try:
1616
1614
                    new_basis_tree = self.branch.basis_tree()
1619
1617
                                new_basis_tree,
1620
1618
                                basis_tree,
1621
1619
                                this_tree=self,
1622
 
                                pb=None,
 
1620
                                pb=pb,
1623
1621
                                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)
 
1622
                    if (basis_tree.inventory.root is None and
 
1623
                        new_basis_tree.inventory.root is not None):
 
1624
                        self.set_root_id(new_basis_tree.get_root_id())
1628
1625
                finally:
 
1626
                    pb.finished()
1629
1627
                    basis_tree.unlock()
1630
1628
                # TODO - dedup parents list with things merged by pull ?
1631
1629
                # reuse the revisiontree we merged against to set the new
1644
1642
            return count
1645
1643
        finally:
1646
1644
            source.unlock()
 
1645
            top_pb.finished()
1647
1646
 
1648
1647
    @needs_write_lock
1649
1648
    def put_file_bytes_non_atomic(self, file_id, bytes):
1734
1733
        r"""Check whether the filename matches an ignore pattern.
1735
1734
 
1736
1735
        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.
 
1736
        others match against only the last component.
1740
1737
 
1741
1738
        If the file is ignored, returns the pattern which caused it to
1742
1739
        be ignored, otherwise None.  So this can simply be used as a
1743
1740
        boolean if desired."""
1744
1741
        if getattr(self, '_ignoreglobster', None) is None:
1745
 
            self._ignoreglobster = globbing.ExceptionGlobster(self.get_ignore_list())
 
1742
            self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1746
1743
        return self._ignoreglobster.match(filename)
1747
1744
 
1748
1745
    def kind(self, file_id):
1839
1836
    def _reset_data(self):
1840
1837
        """Reset transient data that cannot be revalidated."""
1841
1838
        self._inventory_is_modified = False
1842
 
        f = self._transport.get('inventory')
1843
 
        try:
1844
 
            result = self._deserialize(f)
1845
 
        finally:
1846
 
            f.close()
 
1839
        result = self._deserialize(self._transport.get('inventory'))
1847
1840
        self._set_inventory(result, dirty=False)
1848
1841
 
1849
1842
    @needs_tree_write_lock
1896
1889
            # revision_id is set. We must check for this full string, because a
1897
1890
            # root node id can legitimately look like 'revision_id' but cannot
1898
1891
            # contain a '"'.
1899
 
            xml = self.branch.repository._get_inventory_xml(new_revision)
 
1892
            xml = self.branch.repository.get_inventory_xml(new_revision)
1900
1893
            firstline = xml.split('\n', 1)[0]
1901
1894
            if (not 'revision_id="' in firstline or
1902
1895
                'format="7"' not in firstline):
1925
1918
        # binary.
1926
1919
        if self._inventory_is_modified:
1927
1920
            raise errors.InventoryModified(self)
1928
 
        f = self._transport.get('inventory')
1929
 
        try:
1930
 
            result = self._deserialize(f)
1931
 
        finally:
1932
 
            f.close()
 
1921
        result = self._deserialize(self._transport.get('inventory'))
1933
1922
        self._set_inventory(result, dirty=False)
1934
1923
        return result
1935
1924
 
1950
1939
 
1951
1940
        new_files=set()
1952
1941
        unknown_nested_files=set()
1953
 
        if to_file is None:
1954
 
            to_file = sys.stdout
1955
1942
 
1956
1943
        def recurse_directory_to_add_files(directory):
1957
1944
            # Recurse directory and add all files
2027
2014
                        new_status = 'I'
2028
2015
                    else:
2029
2016
                        new_status = '?'
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')
 
2017
                    textui.show_status(new_status, self.kind(fid), f,
 
2018
                                       to_file=to_file)
2033
2019
                # Unversion file
2034
2020
                inv_delta.append((f, None, fid, None))
2035
2021
                message = "removed %s" % (f,)
2058
2044
 
2059
2045
    @needs_tree_write_lock
2060
2046
    def revert(self, filenames=None, old_tree=None, backups=True,
2061
 
               pb=None, report_changes=False):
 
2047
               pb=DummyProgress(), report_changes=False):
2062
2048
        from bzrlib.conflicts import resolve
2063
2049
        if filenames == []:
2064
2050
            filenames = None
2186
2172
        """
2187
2173
        raise NotImplementedError(self.unlock)
2188
2174
 
2189
 
    _marker = object()
2190
 
 
2191
 
    def update(self, change_reporter=None, possible_transports=None,
2192
 
               revision=None, old_tip=_marker):
 
2175
    def update(self, change_reporter=None, possible_transports=None):
2193
2176
        """Update a working tree along its branch.
2194
2177
 
2195
2178
        This will update the branch if its bound too, which means we have
2213
2196
        - Merge current state -> basis tree of the master w.r.t. the old tree
2214
2197
          basis.
2215
2198
        - 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.
2222
2199
        """
2223
2200
        if self.branch.get_bound_location() is not None:
2224
2201
            self.lock_write()
2225
 
            update_branch = (old_tip is self._marker)
 
2202
            update_branch = True
2226
2203
        else:
2227
2204
            self.lock_tree_write()
2228
2205
            update_branch = False
2230
2207
            if update_branch:
2231
2208
                old_tip = self.branch.update(possible_transports)
2232
2209
            else:
2233
 
                if old_tip is self._marker:
2234
 
                    old_tip = None
2235
 
            return self._update_tree(old_tip, change_reporter, revision)
 
2210
                old_tip = None
 
2211
            return self._update_tree(old_tip, change_reporter)
2236
2212
        finally:
2237
2213
            self.unlock()
2238
2214
 
2239
2215
    @needs_tree_write_lock
2240
 
    def _update_tree(self, old_tip=None, change_reporter=None, revision=None):
 
2216
    def _update_tree(self, old_tip=None, change_reporter=None):
2241
2217
        """Update a tree to the master branch.
2242
2218
 
2243
2219
        :param old_tip: if supplied, the previous tip revision the branch,
2253
2229
        # We MUST save it even if an error occurs, because otherwise the users
2254
2230
        # local work is unreferenced and will appear to have been lost.
2255
2231
        #
2256
 
        nb_conflicts = 0
 
2232
        result = 0
2257
2233
        try:
2258
2234
            last_rev = self.get_parent_ids()[0]
2259
2235
        except IndexError:
2260
2236
            last_rev = _mod_revision.NULL_REVISION
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
 
 
 
2237
        if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
 
2238
            # merge tree state up to new branch tip.
2285
2239
            basis = self.basis_tree()
2286
2240
            basis.lock_read()
2287
2241
            try:
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)
 
2242
                to_tree = self.branch.basis_tree()
 
2243
                if basis.inventory.root is None:
 
2244
                    self.set_root_id(to_tree.get_root_id())
2291
2245
                    self.flush()
 
2246
                result += merge.merge_inner(
 
2247
                                      self.branch,
 
2248
                                      to_tree,
 
2249
                                      basis,
 
2250
                                      this_tree=self,
 
2251
                                      change_reporter=change_reporter)
2292
2252
            finally:
2293
2253
                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)
2305
2254
            # TODO - dedup parents list with things merged by pull ?
2306
2255
            # reuse the tree we've updated to to set the basis:
2307
 
            parent_trees = [(revision, to_tree)]
 
2256
            parent_trees = [(self.branch.last_revision(), to_tree)]
2308
2257
            merges = self.get_parent_ids()[1:]
2309
2258
            # Ideally we ask the tree for the trees here, that way the working
2310
2259
            # tree can decide whether to give us the entire tree or give us a
2314
2263
            for parent in merges:
2315
2264
                parent_trees.append(
2316
2265
                    (parent, self.branch.repository.revision_tree(parent)))
2317
 
            if not _mod_revision.is_null(old_tip):
 
2266
            if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2318
2267
                parent_trees.append(
2319
2268
                    (old_tip, self.branch.repository.revision_tree(old_tip)))
2320
2269
            self.set_parent_trees(parent_trees)
2321
2270
            last_rev = parent_trees[0][0]
2322
 
        return nb_conflicts
 
2271
        else:
 
2272
            # the working tree had the same last-revision as the master
 
2273
            # branch did. We may still have pivot local work from the local
 
2274
            # branch into old_tip:
 
2275
            if (old_tip is not None and not _mod_revision.is_null(old_tip)):
 
2276
                self.add_parent_tree_id(old_tip)
 
2277
        if (old_tip is not None and not _mod_revision.is_null(old_tip)
 
2278
            and old_tip != last_rev):
 
2279
            # our last revision was not the prior branch last revision
 
2280
            # and we have converted that last revision to a pending merge.
 
2281
            # base is somewhere between the branch tip now
 
2282
            # and the now pending merge
 
2283
 
 
2284
            # Since we just modified the working tree and inventory, flush out
 
2285
            # the current state, before we modify it again.
 
2286
            # TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
 
2287
            #       requires it only because TreeTransform directly munges the
 
2288
            #       inventory and calls tree._write_inventory(). Ultimately we
 
2289
            #       should be able to remove this extra flush.
 
2290
            self.flush()
 
2291
            graph = self.branch.repository.get_graph()
 
2292
            base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
 
2293
                                                old_tip)
 
2294
            base_tree = self.branch.repository.revision_tree(base_rev_id)
 
2295
            other_tree = self.branch.repository.revision_tree(old_tip)
 
2296
            result += merge.merge_inner(
 
2297
                                  self.branch,
 
2298
                                  other_tree,
 
2299
                                  base_tree,
 
2300
                                  this_tree=self,
 
2301
                                  change_reporter=change_reporter)
 
2302
        return result
2323
2303
 
2324
2304
    def _write_hashcache_if_dirty(self):
2325
2305
        """Write out the hashcache if it is dirty."""
2595
2575
        """
2596
2576
        return
2597
2577
 
 
2578
    @needs_read_lock
2598
2579
    def _get_rules_searcher(self, default_searcher):
2599
2580
        """See Tree._get_rules_searcher."""
2600
2581
        if self._rules_searcher is None:
2779
2760
        """Return the format for the working tree object in a_bzrdir."""
2780
2761
        try:
2781
2762
            transport = a_bzrdir.get_workingtree_transport(None)
2782
 
            format_string = transport.get_bytes("format")
 
2763
            format_string = transport.get("format").read()
2783
2764
            return klass._formats[format_string]
2784
2765
        except errors.NoSuchFile:
2785
2766
            raise errors.NoWorkingTree(base=transport.base)