/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

Put in place a structure for the admin-guide

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, 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
77
83
 
78
84
from bzrlib import symbol_versioning
79
85
from bzrlib.decorators import needs_read_lock, needs_write_lock
80
 
from bzrlib.lock import LogicalLockResult
81
86
from bzrlib.lockable_files import LockableFiles
82
87
from bzrlib.lockdir import LockDir
83
88
import bzrlib.mutabletree
96
101
from bzrlib.filters import filtered_input_file
97
102
from bzrlib.trace import mutter, note
98
103
from bzrlib.transport.local import LocalTransport
 
104
from bzrlib.progress import DummyProgress, ProgressPhase
99
105
from bzrlib.revision import CURRENT_REVISION
100
106
from bzrlib.rio import RioReader, rio_file, Stanza
101
107
from bzrlib.symbol_versioning import (
105
111
 
106
112
 
107
113
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
108
 
# TODO: Modifying the conflict objects or their type is currently nearly
109
 
# impossible as there is no clear relationship between the working tree format
110
 
# and the conflict list file format.
111
114
CONFLICT_HEADER_1 = "BZR conflict list format 1"
112
115
 
113
116
ERROR_PATH_NOT_FOUND = 3    # WindowsError errno code, equivalent to ENOENT
168
171
        return ''
169
172
 
170
173
 
171
 
class WorkingTree(bzrlib.mutabletree.MutableTree,
172
 
    bzrdir.ControlComponent):
 
174
class WorkingTree(bzrlib.mutabletree.MutableTree):
173
175
    """Working copy tree.
174
176
 
175
177
    The inventory is held in the `Branch` working-inventory, and the
248
250
        self._rules_searcher = None
249
251
        self.views = self._make_views()
250
252
 
251
 
    @property
252
 
    def user_transport(self):
253
 
        return self.bzrdir.user_transport
254
 
 
255
 
    @property
256
 
    def control_transport(self):
257
 
        return self._transport
258
 
 
259
253
    def _detect_case_handling(self):
260
254
        wt_trans = self.bzrdir.get_workingtree_transport(None)
261
255
        try:
463
457
        return (file_obj, stat_value)
464
458
 
465
459
    def get_file_text(self, file_id, path=None, filtered=True):
466
 
        my_file = self.get_file(file_id, path=path, filtered=filtered)
467
 
        try:
468
 
            return my_file.read()
469
 
        finally:
470
 
            my_file.close()
 
460
        return self.get_file(file_id, path=path, filtered=filtered).read()
471
461
 
472
462
    def get_file_byname(self, filename, filtered=True):
473
463
        path = self.abspath(filename)
527
517
 
528
518
        # Now we have the parents of this content
529
519
        annotator = self.branch.repository.texts.get_annotator()
530
 
        text = self.get_file_text(file_id)
 
520
        text = self.get_file(file_id).read()
531
521
        this_key =(file_id, default_revision)
532
522
        annotator.add_special_text(this_key, file_parent_keys, text)
533
523
        annotations = [(key[-1], line)
919
909
            branch.last_revision().
920
910
        """
921
911
        from bzrlib.merge import Merger, Merge3Merger
922
 
        merger = Merger(self.branch, this_tree=self)
923
 
        # check that there are no local alterations
924
 
        if not force and self.has_changes():
925
 
            raise errors.UncommittedChanges(self)
926
 
        if to_revision is None:
927
 
            to_revision = _mod_revision.ensure_null(branch.last_revision())
928
 
        merger.other_rev_id = to_revision
929
 
        if _mod_revision.is_null(merger.other_rev_id):
930
 
            raise errors.NoCommits(branch)
931
 
        self.branch.fetch(branch, last_revision=merger.other_rev_id)
932
 
        merger.other_basis = merger.other_rev_id
933
 
        merger.other_tree = self.branch.repository.revision_tree(
934
 
            merger.other_rev_id)
935
 
        merger.other_branch = branch
936
 
        if from_revision is None:
937
 
            merger.find_base()
938
 
        else:
939
 
            merger.set_base_revision(from_revision, branch)
940
 
        if merger.base_rev_id == merger.other_rev_id:
941
 
            raise errors.PointlessMerge
942
 
        merger.backup_files = False
943
 
        if merge_type is None:
944
 
            merger.merge_type = Merge3Merger
945
 
        else:
946
 
            merger.merge_type = merge_type
947
 
        merger.set_interesting_files(None)
948
 
        merger.show_base = False
949
 
        merger.reprocess = False
950
 
        conflicts = merger.do_merge()
951
 
        merger.set_pending()
 
912
        pb = ui.ui_factory.nested_progress_bar()
 
913
        try:
 
914
            merger = Merger(self.branch, this_tree=self, pb=pb)
 
915
            merger.pp = ProgressPhase("Merge phase", 5, pb)
 
916
            merger.pp.next_phase()
 
917
            # check that there are no local alterations
 
918
            if not force and self.has_changes():
 
919
                raise errors.UncommittedChanges(self)
 
920
            if to_revision is None:
 
921
                to_revision = _mod_revision.ensure_null(branch.last_revision())
 
922
            merger.other_rev_id = to_revision
 
923
            if _mod_revision.is_null(merger.other_rev_id):
 
924
                raise errors.NoCommits(branch)
 
925
            self.branch.fetch(branch, last_revision=merger.other_rev_id)
 
926
            merger.other_basis = merger.other_rev_id
 
927
            merger.other_tree = self.branch.repository.revision_tree(
 
928
                merger.other_rev_id)
 
929
            merger.other_branch = branch
 
930
            merger.pp.next_phase()
 
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()
 
947
        finally:
 
948
            pb.finished()
952
949
        return conflicts
953
950
 
954
951
    @needs_read_lock
1101
1098
        tree_transport = self.bzrdir.root_transport.clone(sub_path)
1102
1099
        if tree_transport.base != branch_transport.base:
1103
1100
            tree_bzrdir = format.initialize_on_transport(tree_transport)
1104
 
            branch.BranchReferenceFormat().initialize(tree_bzrdir,
1105
 
                target_branch=new_branch)
 
1101
            branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1106
1102
        else:
1107
1103
            tree_bzrdir = branch_bzrdir
1108
1104
        wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
1146
1142
        This does not include files that have been deleted in this
1147
1143
        tree. Skips the control directory.
1148
1144
 
1149
 
        :param include_root: if True, return an entry for the root
 
1145
        :param include_root: if True, do not return an entry for the root
1150
1146
        :param from_dir: start from this directory or None for the root
1151
1147
        :param recursive: whether to recurse into subdirectories or not
1152
1148
        """
1606
1602
    @needs_write_lock
1607
1603
    def pull(self, source, overwrite=False, stop_revision=None,
1608
1604
             change_reporter=None, possible_transports=None, local=False):
 
1605
        top_pb = ui.ui_factory.nested_progress_bar()
1609
1606
        source.lock_read()
1610
1607
        try:
 
1608
            pp = ProgressPhase("Pull phase", 2, top_pb)
 
1609
            pp.next_phase()
1611
1610
            old_revision_info = self.branch.last_revision_info()
1612
1611
            basis_tree = self.basis_tree()
1613
1612
            count = self.branch.pull(source, overwrite, stop_revision,
1615
1614
                                     local=local)
1616
1615
            new_revision_info = self.branch.last_revision_info()
1617
1616
            if new_revision_info != old_revision_info:
 
1617
                pp.next_phase()
1618
1618
                repository = self.branch.repository
 
1619
                pb = ui.ui_factory.nested_progress_bar()
1619
1620
                basis_tree.lock_read()
1620
1621
                try:
1621
1622
                    new_basis_tree = self.branch.basis_tree()
1624
1625
                                new_basis_tree,
1625
1626
                                basis_tree,
1626
1627
                                this_tree=self,
1627
 
                                pb=None,
 
1628
                                pb=pb,
1628
1629
                                change_reporter=change_reporter)
1629
 
                    basis_root_id = basis_tree.get_root_id()
1630
 
                    new_root_id = new_basis_tree.get_root_id()
1631
 
                    if basis_root_id != new_root_id:
1632
 
                        self.set_root_id(new_root_id)
 
1630
                    if (basis_tree.inventory.root is None and
 
1631
                        new_basis_tree.inventory.root is not None):
 
1632
                        self.set_root_id(new_basis_tree.get_root_id())
1633
1633
                finally:
 
1634
                    pb.finished()
1634
1635
                    basis_tree.unlock()
1635
1636
                # TODO - dedup parents list with things merged by pull ?
1636
1637
                # reuse the revisiontree we merged against to set the new
1649
1650
            return count
1650
1651
        finally:
1651
1652
            source.unlock()
 
1653
            top_pb.finished()
1652
1654
 
1653
1655
    @needs_write_lock
1654
1656
    def put_file_bytes_non_atomic(self, file_id, bytes):
1739
1741
        r"""Check whether the filename matches an ignore pattern.
1740
1742
 
1741
1743
        Patterns containing '/' or '\' need to match the whole path;
1742
 
        others match against only the last component.  Patterns starting
1743
 
        with '!' are ignore exceptions.  Exceptions take precedence
1744
 
        over regular patterns and cause the filename to not be ignored.
 
1744
        others match against only the last component.
1745
1745
 
1746
1746
        If the file is ignored, returns the pattern which caused it to
1747
1747
        be ignored, otherwise None.  So this can simply be used as a
1748
1748
        boolean if desired."""
1749
1749
        if getattr(self, '_ignoreglobster', None) is None:
1750
 
            self._ignoreglobster = globbing.ExceptionGlobster(self.get_ignore_list())
 
1750
            self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1751
1751
        return self._ignoreglobster.match(filename)
1752
1752
 
1753
1753
    def kind(self, file_id):
1803
1803
            raise errors.ObjectNotLocked(self)
1804
1804
 
1805
1805
    def lock_read(self):
1806
 
        """Lock the tree for reading.
1807
 
 
1808
 
        This also locks the branch, and can be unlocked via self.unlock().
1809
 
 
1810
 
        :return: A bzrlib.lock.LogicalLockResult.
1811
 
        """
 
1806
        """See Branch.lock_read, and WorkingTree.unlock."""
1812
1807
        if not self.is_locked():
1813
1808
            self._reset_data()
1814
1809
        self.branch.lock_read()
1815
1810
        try:
1816
 
            self._control_files.lock_read()
1817
 
            return LogicalLockResult(self.unlock)
 
1811
            return self._control_files.lock_read()
1818
1812
        except:
1819
1813
            self.branch.unlock()
1820
1814
            raise
1821
1815
 
1822
1816
    def lock_tree_write(self):
1823
 
        """See MutableTree.lock_tree_write, and WorkingTree.unlock.
1824
 
 
1825
 
        :return: A bzrlib.lock.LogicalLockResult.
1826
 
        """
 
1817
        """See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1827
1818
        if not self.is_locked():
1828
1819
            self._reset_data()
1829
1820
        self.branch.lock_read()
1830
1821
        try:
1831
 
            self._control_files.lock_write()
1832
 
            return LogicalLockResult(self.unlock)
 
1822
            return self._control_files.lock_write()
1833
1823
        except:
1834
1824
            self.branch.unlock()
1835
1825
            raise
1836
1826
 
1837
1827
    def lock_write(self):
1838
 
        """See MutableTree.lock_write, and WorkingTree.unlock.
1839
 
 
1840
 
        :return: A bzrlib.lock.LogicalLockResult.
1841
 
        """
 
1828
        """See MutableTree.lock_write, and WorkingTree.unlock."""
1842
1829
        if not self.is_locked():
1843
1830
            self._reset_data()
1844
1831
        self.branch.lock_write()
1845
1832
        try:
1846
 
            self._control_files.lock_write()
1847
 
            return LogicalLockResult(self.unlock)
 
1833
            return self._control_files.lock_write()
1848
1834
        except:
1849
1835
            self.branch.unlock()
1850
1836
            raise
1915
1901
            # revision_id is set. We must check for this full string, because a
1916
1902
            # root node id can legitimately look like 'revision_id' but cannot
1917
1903
            # contain a '"'.
1918
 
            xml = self.branch.repository._get_inventory_xml(new_revision)
 
1904
            xml = self.branch.repository.get_inventory_xml(new_revision)
1919
1905
            firstline = xml.split('\n', 1)[0]
1920
1906
            if (not 'revision_id="' in firstline or
1921
1907
                'format="7"' not in firstline):
1975
1961
        def recurse_directory_to_add_files(directory):
1976
1962
            # Recurse directory and add all files
1977
1963
            # so we can check if they have changed.
1978
 
            for parent_info, file_infos in self.walkdirs(directory):
 
1964
            for parent_info, file_infos in\
 
1965
                self.walkdirs(directory):
1979
1966
                for relpath, basename, kind, lstat, fileid, kind in file_infos:
1980
1967
                    # Is it versioned or ignored?
1981
1968
                    if self.path2id(relpath) or self.is_ignored(relpath):
2016
2003
                            # ... but not ignored
2017
2004
                            has_changed_files = True
2018
2005
                            break
2019
 
                    elif (content_change and (kind[1] is not None) and
2020
 
                            osutils.is_inside_any(files, path[1])):
2021
 
                        # Versioned and changed, but not deleted, and still
2022
 
                        # in one of the dirs to be deleted.
 
2006
                    elif content_change and (kind[1] is not None):
 
2007
                        # Versioned and changed, but not deleted
2023
2008
                        has_changed_files = True
2024
2009
                        break
2025
2010
 
2078
2063
 
2079
2064
    @needs_tree_write_lock
2080
2065
    def revert(self, filenames=None, old_tree=None, backups=True,
2081
 
               pb=None, report_changes=False):
 
2066
               pb=DummyProgress(), report_changes=False):
2082
2067
        from bzrlib.conflicts import resolve
2083
2068
        if filenames == []:
2084
2069
            filenames = None
2206
2191
        """
2207
2192
        raise NotImplementedError(self.unlock)
2208
2193
 
2209
 
    _marker = object()
2210
 
 
2211
 
    def update(self, change_reporter=None, possible_transports=None,
2212
 
               revision=None, old_tip=_marker):
 
2194
    def update(self, change_reporter=None, possible_transports=None):
2213
2195
        """Update a working tree along its branch.
2214
2196
 
2215
2197
        This will update the branch if its bound too, which means we have
2233
2215
        - Merge current state -> basis tree of the master w.r.t. the old tree
2234
2216
          basis.
2235
2217
        - Do a 'normal' merge of the old branch basis if it is relevant.
2236
 
 
2237
 
        :param revision: The target revision to update to. Must be in the
2238
 
            revision history.
2239
 
        :param old_tip: If branch.update() has already been run, the value it
2240
 
            returned (old tip of the branch or None). _marker is used
2241
 
            otherwise.
2242
2218
        """
2243
2219
        if self.branch.get_bound_location() is not None:
2244
2220
            self.lock_write()
2245
 
            update_branch = (old_tip is self._marker)
 
2221
            update_branch = True
2246
2222
        else:
2247
2223
            self.lock_tree_write()
2248
2224
            update_branch = False
2250
2226
            if update_branch:
2251
2227
                old_tip = self.branch.update(possible_transports)
2252
2228
            else:
2253
 
                if old_tip is self._marker:
2254
 
                    old_tip = None
2255
 
            return self._update_tree(old_tip, change_reporter, revision)
 
2229
                old_tip = None
 
2230
            return self._update_tree(old_tip, change_reporter)
2256
2231
        finally:
2257
2232
            self.unlock()
2258
2233
 
2259
2234
    @needs_tree_write_lock
2260
 
    def _update_tree(self, old_tip=None, change_reporter=None, revision=None):
 
2235
    def _update_tree(self, old_tip=None, change_reporter=None):
2261
2236
        """Update a tree to the master branch.
2262
2237
 
2263
2238
        :param old_tip: if supplied, the previous tip revision the branch,
2273
2248
        # We MUST save it even if an error occurs, because otherwise the users
2274
2249
        # local work is unreferenced and will appear to have been lost.
2275
2250
        #
2276
 
        nb_conflicts = 0
 
2251
        result = 0
2277
2252
        try:
2278
2253
            last_rev = self.get_parent_ids()[0]
2279
2254
        except IndexError:
2280
2255
            last_rev = _mod_revision.NULL_REVISION
2281
 
        if revision is None:
2282
 
            revision = self.branch.last_revision()
2283
 
 
2284
 
        old_tip = old_tip or _mod_revision.NULL_REVISION
2285
 
 
2286
 
        if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
2287
 
            # the branch we are bound to was updated
2288
 
            # merge those changes in first
2289
 
            base_tree  = self.basis_tree()
2290
 
            other_tree = self.branch.repository.revision_tree(old_tip)
2291
 
            nb_conflicts = merge.merge_inner(self.branch, other_tree,
2292
 
                                             base_tree, this_tree=self,
2293
 
                                             change_reporter=change_reporter)
2294
 
            if nb_conflicts:
2295
 
                self.add_parent_tree((old_tip, other_tree))
2296
 
                trace.note('Rerun update after fixing the conflicts.')
2297
 
                return nb_conflicts
2298
 
 
2299
 
        if last_rev != _mod_revision.ensure_null(revision):
2300
 
            # the working tree is up to date with the branch
2301
 
            # we can merge the specified revision from master
2302
 
            to_tree = self.branch.repository.revision_tree(revision)
2303
 
            to_root_id = to_tree.get_root_id()
2304
 
 
 
2256
        if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
 
2257
            # merge tree state up to new branch tip.
2305
2258
            basis = self.basis_tree()
2306
2259
            basis.lock_read()
2307
2260
            try:
2308
 
                if (basis.inventory.root is None
2309
 
                    or basis.inventory.root.file_id != to_root_id):
2310
 
                    self.set_root_id(to_root_id)
 
2261
                to_tree = self.branch.basis_tree()
 
2262
                if basis.inventory.root is None:
 
2263
                    self.set_root_id(to_tree.get_root_id())
2311
2264
                    self.flush()
 
2265
                result += merge.merge_inner(
 
2266
                                      self.branch,
 
2267
                                      to_tree,
 
2268
                                      basis,
 
2269
                                      this_tree=self,
 
2270
                                      change_reporter=change_reporter)
2312
2271
            finally:
2313
2272
                basis.unlock()
2314
 
 
2315
 
            # determine the branch point
2316
 
            graph = self.branch.repository.get_graph()
2317
 
            base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2318
 
                                                last_rev)
2319
 
            base_tree = self.branch.repository.revision_tree(base_rev_id)
2320
 
 
2321
 
            nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
2322
 
                                             this_tree=self,
2323
 
                                             change_reporter=change_reporter)
2324
 
            self.set_last_revision(revision)
2325
2273
            # TODO - dedup parents list with things merged by pull ?
2326
2274
            # reuse the tree we've updated to to set the basis:
2327
 
            parent_trees = [(revision, to_tree)]
 
2275
            parent_trees = [(self.branch.last_revision(), to_tree)]
2328
2276
            merges = self.get_parent_ids()[1:]
2329
2277
            # Ideally we ask the tree for the trees here, that way the working
2330
2278
            # tree can decide whether to give us the entire tree or give us a
2334
2282
            for parent in merges:
2335
2283
                parent_trees.append(
2336
2284
                    (parent, self.branch.repository.revision_tree(parent)))
2337
 
            if not _mod_revision.is_null(old_tip):
 
2285
            if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2338
2286
                parent_trees.append(
2339
2287
                    (old_tip, self.branch.repository.revision_tree(old_tip)))
2340
2288
            self.set_parent_trees(parent_trees)
2341
2289
            last_rev = parent_trees[0][0]
2342
 
        return nb_conflicts
 
2290
        else:
 
2291
            # the working tree had the same last-revision as the master
 
2292
            # branch did. We may still have pivot local work from the local
 
2293
            # branch into old_tip:
 
2294
            if (old_tip is not None and not _mod_revision.is_null(old_tip)):
 
2295
                self.add_parent_tree_id(old_tip)
 
2296
        if (old_tip is not None and not _mod_revision.is_null(old_tip)
 
2297
            and old_tip != last_rev):
 
2298
            # our last revision was not the prior branch last revision
 
2299
            # and we have converted that last revision to a pending merge.
 
2300
            # base is somewhere between the branch tip now
 
2301
            # and the now pending merge
 
2302
 
 
2303
            # Since we just modified the working tree and inventory, flush out
 
2304
            # the current state, before we modify it again.
 
2305
            # TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
 
2306
            #       requires it only because TreeTransform directly munges the
 
2307
            #       inventory and calls tree._write_inventory(). Ultimately we
 
2308
            #       should be able to remove this extra flush.
 
2309
            self.flush()
 
2310
            graph = self.branch.repository.get_graph()
 
2311
            base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
 
2312
                                                old_tip)
 
2313
            base_tree = self.branch.repository.revision_tree(base_rev_id)
 
2314
            other_tree = self.branch.repository.revision_tree(old_tip)
 
2315
            result += merge.merge_inner(
 
2316
                                  self.branch,
 
2317
                                  other_tree,
 
2318
                                  base_tree,
 
2319
                                  this_tree=self,
 
2320
                                  change_reporter=change_reporter)
 
2321
        return result
2343
2322
 
2344
2323
    def _write_hashcache_if_dirty(self):
2345
2324
        """Write out the hashcache if it is dirty."""
2656
2635
 
2657
2636
        In Format2 WorkingTrees we have a single lock for the branch and tree
2658
2637
        so lock_tree_write() degrades to lock_write().
2659
 
 
2660
 
        :return: An object with an unlock method which will release the lock
2661
 
            obtained.
2662
2638
        """
2663
2639
        self.branch.lock_write()
2664
2640
        try:
2665
 
            self._control_files.lock_write()
2666
 
            return self
 
2641
            return self._control_files.lock_write()
2667
2642
        except:
2668
2643
            self.branch.unlock()
2669
2644
            raise