← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2010-09-01 08:02:42 UTC
  • mfrom: (5390.3.3 faster-revert-593560)
  • Revision ID: pqm@pqm.ubuntu.com-20100901080242-esg62ody4frwmy66
(spiv) Avoid repeatedly calling self.target.all_file_ids() in
 InterTree.iter_changes. (Andrew Bennetts)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/workingtree.py
1
 
# Copyright (C) 2005, 2006, 2007, 2008, 2009 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
55
49
    branch,
56
50
    bzrdir,
57
51
    conflicts as _mod_conflicts,
 
52
    controldir,
58
53
    errors,
59
54
    generate_ids,
60
55
    globbing,
65
60
    merge,
66
61
    revision as _mod_revision,
67
62
    revisiontree,
68
 
    textui,
69
63
    trace,
70
64
    transform,
 
65
    transport,
71
66
    ui,
72
67
    views,
73
68
    xml5,
74
69
    xml7,
75
70
    )
76
 
import bzrlib.branch
77
 
from bzrlib.transport import get_transport
78
71
from bzrlib.workingtree_4 import (
79
72
    WorkingTreeFormat4,
80
73
    WorkingTreeFormat5,
84
77
 
85
78
from bzrlib import symbol_versioning
86
79
from bzrlib.decorators import needs_read_lock, needs_write_lock
 
80
from bzrlib.lock import LogicalLockResult
87
81
from bzrlib.lockable_files import LockableFiles
88
82
from bzrlib.lockdir import LockDir
89
83
import bzrlib.mutabletree
102
96
from bzrlib.filters import filtered_input_file
103
97
from bzrlib.trace import mutter, note
104
98
from bzrlib.transport.local import LocalTransport
105
 
from bzrlib.progress import DummyProgress, ProgressPhase
106
99
from bzrlib.revision import CURRENT_REVISION
107
100
from bzrlib.rio import RioReader, rio_file, Stanza
108
101
from bzrlib.symbol_versioning import (
112
105
 
113
106
 
114
107
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.
115
111
CONFLICT_HEADER_1 = "BZR conflict list format 1"
116
112
 
117
113
ERROR_PATH_NOT_FOUND = 3    # WindowsError errno code, equivalent to ENOENT
172
168
        return ''
173
169
 
174
170
 
175
 
class WorkingTree(bzrlib.mutabletree.MutableTree):
 
171
class WorkingTree(bzrlib.mutabletree.MutableTree,
 
172
    controldir.ControlComponent):
176
173
    """Working copy tree.
177
174
 
178
175
    The inventory is held in the `Branch` working-inventory, and the
180
177
 
181
178
    It is possible for a `WorkingTree` to have a filename which is
182
179
    not listed in the Inventory and vice versa.
 
180
 
 
181
    :ivar basedir: The root of the tree on disk. This is a unicode path object
 
182
        (as opposed to a URL).
183
183
    """
184
184
 
185
185
    # override this to set the strategy for storing views
251
251
        self._rules_searcher = None
252
252
        self.views = self._make_views()
253
253
 
 
254
    @property
 
255
    def user_transport(self):
 
256
        return self.bzrdir.user_transport
 
257
 
 
258
    @property
 
259
    def control_transport(self):
 
260
        return self._transport
 
261
 
254
262
    def _detect_case_handling(self):
255
263
        wt_trans = self.bzrdir.get_workingtree_transport(None)
256
264
        try:
342
350
        if path is None:
343
351
            path = osutils.getcwd()
344
352
        control, relpath = bzrdir.BzrDir.open_containing(path)
345
 
 
346
353
        return control.open_workingtree(), relpath
347
354
 
348
355
    @staticmethod
 
356
    def open_containing_paths(file_list, default_directory='.',
 
357
        canonicalize=True, apply_view=True):
 
358
        """Open the WorkingTree that contains a set of paths.
 
359
 
 
360
        Fail if the paths given are not all in a single tree.
 
361
 
 
362
        This is used for the many command-line interfaces that take a list of
 
363
        any number of files and that require they all be in the same tree.
 
364
        """
 
365
        # recommended replacement for builtins.internal_tree_files
 
366
        if file_list is None or len(file_list) == 0:
 
367
            tree = WorkingTree.open_containing(default_directory)[0]
 
368
            # XXX: doesn't really belong here, and seems to have the strange
 
369
            # side effect of making it return a bunch of files, not the whole
 
370
            # tree -- mbp 20100716
 
371
            if tree.supports_views() and apply_view:
 
372
                view_files = tree.views.lookup_view()
 
373
                if view_files:
 
374
                    file_list = view_files
 
375
                    view_str = views.view_display_str(view_files)
 
376
                    note("Ignoring files outside view. View is %s" % view_str)
 
377
            return tree, file_list
 
378
        tree = WorkingTree.open_containing(file_list[0])[0]
 
379
        return tree, tree.safe_relpath_files(file_list, canonicalize,
 
380
            apply_view=apply_view)
 
381
 
 
382
    def safe_relpath_files(self, file_list, canonicalize=True, apply_view=True):
 
383
        """Convert file_list into a list of relpaths in tree.
 
384
 
 
385
        :param self: A tree to operate on.
 
386
        :param file_list: A list of user provided paths or None.
 
387
        :param apply_view: if True and a view is set, apply it or check that
 
388
            specified files are within it
 
389
        :return: A list of relative paths.
 
390
        :raises errors.PathNotChild: When a provided path is in a different self
 
391
            than self.
 
392
        """
 
393
        if file_list is None:
 
394
            return None
 
395
        if self.supports_views() and apply_view:
 
396
            view_files = self.views.lookup_view()
 
397
        else:
 
398
            view_files = []
 
399
        new_list = []
 
400
        # self.relpath exists as a "thunk" to osutils, but canonical_relpath
 
401
        # doesn't - fix that up here before we enter the loop.
 
402
        if canonicalize:
 
403
            fixer = lambda p: osutils.canonical_relpath(self.basedir, p)
 
404
        else:
 
405
            fixer = self.relpath
 
406
        for filename in file_list:
 
407
            relpath = fixer(osutils.dereference_path(filename))
 
408
            if view_files and not osutils.is_inside_any(view_files, relpath):
 
409
                raise errors.FileOutsideView(filename, view_files)
 
410
            new_list.append(relpath)
 
411
        return new_list
 
412
 
 
413
    @staticmethod
349
414
    def open_downlevel(path=None):
350
415
        """Open an unsupported working tree.
351
416
 
364
429
                return True, None
365
430
            else:
366
431
                return True, tree
367
 
        transport = get_transport(location)
368
 
        iterator = bzrdir.BzrDir.find_bzrdirs(transport, evaluate=evaluate,
 
432
        t = transport.get_transport(location)
 
433
        iterator = bzrdir.BzrDir.find_bzrdirs(t, evaluate=evaluate,
369
434
                                              list_current=list_current)
370
 
        return [t for t in iterator if t is not None]
 
435
        return [tr for tr in iterator if tr is not None]
371
436
 
372
437
    # should be deprecated - this is slow and in any case treating them as a
373
438
    # container is (we now know) bad style -- mbp 20070302
458
523
        return (file_obj, stat_value)
459
524
 
460
525
    def get_file_text(self, file_id, path=None, filtered=True):
461
 
        return self.get_file(file_id, path=path, filtered=filtered).read()
 
526
        my_file = self.get_file(file_id, path=path, filtered=filtered)
 
527
        try:
 
528
            return my_file.read()
 
529
        finally:
 
530
            my_file.close()
462
531
 
463
532
    def get_file_byname(self, filename, filtered=True):
464
533
        path = self.abspath(filename)
518
587
 
519
588
        # Now we have the parents of this content
520
589
        annotator = self.branch.repository.texts.get_annotator()
521
 
        text = self.get_file(file_id).read()
 
590
        text = self.get_file_text(file_id)
522
591
        this_key =(file_id, default_revision)
523
592
        annotator.add_special_text(this_key, file_parent_keys, text)
524
593
        annotations = [(key[-1], line)
544
613
        else:
545
614
            parents = [last_rev]
546
615
        try:
547
 
            merges_file = self._transport.get('pending-merges')
 
616
            merges_bytes = self._transport.get_bytes('pending-merges')
548
617
        except errors.NoSuchFile:
549
618
            pass
550
619
        else:
551
 
            for l in merges_file.readlines():
 
620
            for l in osutils.split_lines(merges_bytes):
552
621
                revision_id = l.rstrip('\n')
553
622
                parents.append(revision_id)
554
623
        return parents
613
682
 
614
683
    def get_file_size(self, file_id):
615
684
        """See Tree.get_file_size"""
 
685
        # XXX: this returns the on-disk size; it should probably return the
 
686
        # canonical size
616
687
        try:
617
688
            return os.path.getsize(self.id2abspath(file_id))
618
689
        except OSError, e:
634
705
 
635
706
    def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
636
707
        file_id = self.path2id(path)
 
708
        if file_id is None:
 
709
            # For unversioned files on win32, we just assume they are not
 
710
            # executable
 
711
            return False
637
712
        return self._inventory[file_id].executable
638
713
 
639
714
    def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
749
824
            raise
750
825
        kind = _mapper(stat_result.st_mode)
751
826
        if kind == 'file':
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))
 
827
            return self._file_content_summary(path, stat_result)
757
828
        elif kind == 'directory':
758
829
            # perhaps it looks like a plain directory, but it's really a
759
830
            # reference.
766
837
        else:
767
838
            return (kind, None, None, None)
768
839
 
 
840
    def _file_content_summary(self, path, stat_result):
 
841
        size = stat_result.st_size
 
842
        executable = self._is_executable_from_path_and_stat(path, stat_result)
 
843
        # try for a stat cache lookup
 
844
        return ('file', size, executable, self._sha_from_stat(
 
845
            path, stat_result))
 
846
 
769
847
    def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
770
848
        """Common ghost checking functionality from set_parent_*.
771
849
 
891
969
 
892
970
    @needs_write_lock # because merge pulls data into the branch.
893
971
    def merge_from_branch(self, branch, to_revision=None, from_revision=None,
894
 
        merge_type=None):
 
972
                          merge_type=None, force=False):
895
973
        """Merge from a branch into this working tree.
896
974
 
897
975
        :param branch: The branch to merge from.
901
979
            branch.last_revision().
902
980
        """
903
981
        from bzrlib.merge import Merger, Merge3Merger
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()
 
982
        merger = Merger(self.branch, this_tree=self)
 
983
        # check that there are no local alterations
 
984
        if not force and self.has_changes():
 
985
            raise errors.UncommittedChanges(self)
 
986
        if to_revision is None:
 
987
            to_revision = _mod_revision.ensure_null(branch.last_revision())
 
988
        merger.other_rev_id = to_revision
 
989
        if _mod_revision.is_null(merger.other_rev_id):
 
990
            raise errors.NoCommits(branch)
 
991
        self.branch.fetch(branch, last_revision=merger.other_rev_id)
 
992
        merger.other_basis = merger.other_rev_id
 
993
        merger.other_tree = self.branch.repository.revision_tree(
 
994
            merger.other_rev_id)
 
995
        merger.other_branch = branch
 
996
        if from_revision is None:
 
997
            merger.find_base()
 
998
        else:
 
999
            merger.set_base_revision(from_revision, branch)
 
1000
        if merger.base_rev_id == merger.other_rev_id:
 
1001
            raise errors.PointlessMerge
 
1002
        merger.backup_files = False
 
1003
        if merge_type is None:
 
1004
            merger.merge_type = Merge3Merger
 
1005
        else:
 
1006
            merger.merge_type = merge_type
 
1007
        merger.set_interesting_files(None)
 
1008
        merger.show_base = False
 
1009
        merger.reprocess = False
 
1010
        conflicts = merger.do_merge()
 
1011
        merger.set_pending()
941
1012
        return conflicts
942
1013
 
943
1014
    @needs_read_lock
1090
1161
        tree_transport = self.bzrdir.root_transport.clone(sub_path)
1091
1162
        if tree_transport.base != branch_transport.base:
1092
1163
            tree_bzrdir = format.initialize_on_transport(tree_transport)
1093
 
            branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
 
1164
            branch.BranchReferenceFormat().initialize(tree_bzrdir,
 
1165
                target_branch=new_branch)
1094
1166
        else:
1095
1167
            tree_bzrdir = branch_bzrdir
1096
1168
        wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
1134
1206
        This does not include files that have been deleted in this
1135
1207
        tree. Skips the control directory.
1136
1208
 
1137
 
        :param include_root: if True, do not return an entry for the root
 
1209
        :param include_root: if True, return an entry for the root
1138
1210
        :param from_dir: start from this directory or None for the root
1139
1211
        :param recursive: whether to recurse into subdirectories or not
1140
1212
        """
1195
1267
                # absolute path
1196
1268
                fap = from_dir_abspath + '/' + f
1197
1269
 
1198
 
                f_ie = inv.get_child(from_dir_id, f)
 
1270
                dir_ie = inv[from_dir_id]
 
1271
                if dir_ie.kind == 'directory':
 
1272
                    f_ie = dir_ie.children.get(f)
 
1273
                else:
 
1274
                    f_ie = None
1199
1275
                if f_ie:
1200
1276
                    c = 'V'
1201
1277
                elif self.is_ignored(fp[1:]):
1202
1278
                    c = 'I'
1203
1279
                else:
1204
 
                    # we may not have found this file, because of a unicode issue
 
1280
                    # we may not have found this file, because of a unicode
 
1281
                    # issue, or because the directory was actually a symlink.
1205
1282
                    f_norm, can_access = osutils.normalized_filename(f)
1206
1283
                    if f == f_norm or not can_access:
1207
1284
                        # No change, so treat this file normally
1250
1327
                stack.pop()
1251
1328
 
1252
1329
    @needs_tree_write_lock
1253
 
    def move(self, from_paths, to_dir=None, after=False, **kwargs):
 
1330
    def move(self, from_paths, to_dir=None, after=False):
1254
1331
        """Rename files.
1255
1332
 
1256
1333
        to_dir must exist in the inventory.
1290
1367
 
1291
1368
        # check for deprecated use of signature
1292
1369
        if to_dir is None:
1293
 
            to_dir = kwargs.get('to_name', None)
1294
 
            if to_dir is None:
1295
 
                raise TypeError('You must supply a target directory')
1296
 
            else:
1297
 
                symbol_versioning.warn('The parameter to_name was deprecated'
1298
 
                                       ' in version 0.13. Use to_dir instead',
1299
 
                                       DeprecationWarning)
1300
 
 
 
1370
            raise TypeError('You must supply a target directory')
1301
1371
        # check destination directory
1302
1372
        if isinstance(from_paths, basestring):
1303
1373
            raise ValueError()
1594
1664
    @needs_write_lock
1595
1665
    def pull(self, source, overwrite=False, stop_revision=None,
1596
1666
             change_reporter=None, possible_transports=None, local=False):
1597
 
        top_pb = ui.ui_factory.nested_progress_bar()
1598
1667
        source.lock_read()
1599
1668
        try:
1600
 
            pp = ProgressPhase("Pull phase", 2, top_pb)
1601
 
            pp.next_phase()
1602
1669
            old_revision_info = self.branch.last_revision_info()
1603
1670
            basis_tree = self.basis_tree()
1604
1671
            count = self.branch.pull(source, overwrite, stop_revision,
1606
1673
                                     local=local)
1607
1674
            new_revision_info = self.branch.last_revision_info()
1608
1675
            if new_revision_info != old_revision_info:
1609
 
                pp.next_phase()
1610
1676
                repository = self.branch.repository
1611
 
                pb = ui.ui_factory.nested_progress_bar()
1612
1677
                basis_tree.lock_read()
1613
1678
                try:
1614
1679
                    new_basis_tree = self.branch.basis_tree()
1617
1682
                                new_basis_tree,
1618
1683
                                basis_tree,
1619
1684
                                this_tree=self,
1620
 
                                pb=pb,
 
1685
                                pb=None,
1621
1686
                                change_reporter=change_reporter)
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())
 
1687
                    basis_root_id = basis_tree.get_root_id()
 
1688
                    new_root_id = new_basis_tree.get_root_id()
 
1689
                    if basis_root_id != new_root_id:
 
1690
                        self.set_root_id(new_root_id)
1625
1691
                finally:
1626
 
                    pb.finished()
1627
1692
                    basis_tree.unlock()
1628
1693
                # TODO - dedup parents list with things merged by pull ?
1629
1694
                # reuse the revisiontree we merged against to set the new
1642
1707
            return count
1643
1708
        finally:
1644
1709
            source.unlock()
1645
 
            top_pb.finished()
1646
1710
 
1647
1711
    @needs_write_lock
1648
1712
    def put_file_bytes_non_atomic(self, file_id, bytes):
1733
1797
        r"""Check whether the filename matches an ignore pattern.
1734
1798
 
1735
1799
        Patterns containing '/' or '\' need to match the whole path;
1736
 
        others match against only the last component.
 
1800
        others match against only the last component.  Patterns starting
 
1801
        with '!' are ignore exceptions.  Exceptions take precedence
 
1802
        over regular patterns and cause the filename to not be ignored.
1737
1803
 
1738
1804
        If the file is ignored, returns the pattern which caused it to
1739
1805
        be ignored, otherwise None.  So this can simply be used as a
1740
1806
        boolean if desired."""
1741
1807
        if getattr(self, '_ignoreglobster', None) is None:
1742
 
            self._ignoreglobster = globbing.Globster(self.get_ignore_list())
 
1808
            self._ignoreglobster = globbing.ExceptionGlobster(self.get_ignore_list())
1743
1809
        return self._ignoreglobster.match(filename)
1744
1810
 
1745
1811
    def kind(self, file_id):
1795
1861
            raise errors.ObjectNotLocked(self)
1796
1862
 
1797
1863
    def lock_read(self):
1798
 
        """See Branch.lock_read, and WorkingTree.unlock."""
 
1864
        """Lock the tree for reading.
 
1865
 
 
1866
        This also locks the branch, and can be unlocked via self.unlock().
 
1867
 
 
1868
        :return: A bzrlib.lock.LogicalLockResult.
 
1869
        """
1799
1870
        if not self.is_locked():
1800
1871
            self._reset_data()
1801
1872
        self.branch.lock_read()
1802
1873
        try:
1803
 
            return self._control_files.lock_read()
 
1874
            self._control_files.lock_read()
 
1875
            return LogicalLockResult(self.unlock)
1804
1876
        except:
1805
1877
            self.branch.unlock()
1806
1878
            raise
1807
1879
 
1808
1880
    def lock_tree_write(self):
1809
 
        """See MutableTree.lock_tree_write, and WorkingTree.unlock."""
 
1881
        """See MutableTree.lock_tree_write, and WorkingTree.unlock.
 
1882
 
 
1883
        :return: A bzrlib.lock.LogicalLockResult.
 
1884
        """
1810
1885
        if not self.is_locked():
1811
1886
            self._reset_data()
1812
1887
        self.branch.lock_read()
1813
1888
        try:
1814
 
            return self._control_files.lock_write()
 
1889
            self._control_files.lock_write()
 
1890
            return LogicalLockResult(self.unlock)
1815
1891
        except:
1816
1892
            self.branch.unlock()
1817
1893
            raise
1818
1894
 
1819
1895
    def lock_write(self):
1820
 
        """See MutableTree.lock_write, and WorkingTree.unlock."""
 
1896
        """See MutableTree.lock_write, and WorkingTree.unlock.
 
1897
 
 
1898
        :return: A bzrlib.lock.LogicalLockResult.
 
1899
        """
1821
1900
        if not self.is_locked():
1822
1901
            self._reset_data()
1823
1902
        self.branch.lock_write()
1824
1903
        try:
1825
 
            return self._control_files.lock_write()
 
1904
            self._control_files.lock_write()
 
1905
            return LogicalLockResult(self.unlock)
1826
1906
        except:
1827
1907
            self.branch.unlock()
1828
1908
            raise
1836
1916
    def _reset_data(self):
1837
1917
        """Reset transient data that cannot be revalidated."""
1838
1918
        self._inventory_is_modified = False
1839
 
        result = self._deserialize(self._transport.get('inventory'))
 
1919
        f = self._transport.get('inventory')
 
1920
        try:
 
1921
            result = self._deserialize(f)
 
1922
        finally:
 
1923
            f.close()
1840
1924
        self._set_inventory(result, dirty=False)
1841
1925
 
1842
1926
    @needs_tree_write_lock
1889
1973
            # revision_id is set. We must check for this full string, because a
1890
1974
            # root node id can legitimately look like 'revision_id' but cannot
1891
1975
            # contain a '"'.
1892
 
            xml = self.branch.repository.get_inventory_xml(new_revision)
 
1976
            xml = self.branch.repository._get_inventory_xml(new_revision)
1893
1977
            firstline = xml.split('\n', 1)[0]
1894
1978
            if (not 'revision_id="' in firstline or
1895
1979
                'format="7"' not in firstline):
1896
 
                inv = self.branch.repository.deserialise_inventory(
1897
 
                    new_revision, xml)
 
1980
                inv = self.branch.repository._serializer.read_inventory_from_string(
 
1981
                    xml, new_revision)
1898
1982
                xml = self._create_basis_xml_from_inventory(new_revision, inv)
1899
1983
            self._write_basis_inventory(xml)
1900
1984
        except (errors.NoSuchRevision, errors.RevisionNotPresent):
1918
2002
        # binary.
1919
2003
        if self._inventory_is_modified:
1920
2004
            raise errors.InventoryModified(self)
1921
 
        result = self._deserialize(self._transport.get('inventory'))
 
2005
        f = self._transport.get('inventory')
 
2006
        try:
 
2007
            result = self._deserialize(f)
 
2008
        finally:
 
2009
            f.close()
1922
2010
        self._set_inventory(result, dirty=False)
1923
2011
        return result
1924
2012
 
1937
2025
 
1938
2026
        inv_delta = []
1939
2027
 
1940
 
        new_files=set()
 
2028
        all_files = set() # specified and nested files 
1941
2029
        unknown_nested_files=set()
 
2030
        if to_file is None:
 
2031
            to_file = sys.stdout
 
2032
 
 
2033
        files_to_backup = []
1942
2034
 
1943
2035
        def recurse_directory_to_add_files(directory):
1944
2036
            # Recurse directory and add all files
1945
2037
            # so we can check if they have changed.
1946
 
            for parent_info, file_infos in\
1947
 
                self.walkdirs(directory):
 
2038
            for parent_info, file_infos in self.walkdirs(directory):
1948
2039
                for relpath, basename, kind, lstat, fileid, kind in file_infos:
1949
2040
                    # Is it versioned or ignored?
1950
 
                    if self.path2id(relpath) or self.is_ignored(relpath):
 
2041
                    if self.path2id(relpath):
1951
2042
                        # Add nested content for deletion.
1952
 
                        new_files.add(relpath)
 
2043
                        all_files.add(relpath)
1953
2044
                    else:
1954
 
                        # Files which are not versioned and not ignored
 
2045
                        # Files which are not versioned
1955
2046
                        # should be treated as unknown.
1956
 
                        unknown_nested_files.add((relpath, None, kind))
 
2047
                        files_to_backup.append(relpath)
1957
2048
 
1958
2049
        for filename in files:
1959
2050
            # Get file name into canonical form.
1960
2051
            abspath = self.abspath(filename)
1961
2052
            filename = self.relpath(abspath)
1962
2053
            if len(filename) > 0:
1963
 
                new_files.add(filename)
 
2054
                all_files.add(filename)
1964
2055
                recurse_directory_to_add_files(filename)
1965
2056
 
1966
 
        files = list(new_files)
 
2057
        files = list(all_files)
1967
2058
 
1968
2059
        if len(files) == 0:
1969
2060
            return # nothing to do
1973
2064
 
1974
2065
        # Bail out if we are going to delete files we shouldn't
1975
2066
        if not keep_files and not force:
1976
 
            has_changed_files = len(unknown_nested_files) > 0
1977
 
            if not has_changed_files:
1978
 
                for (file_id, path, content_change, versioned, parent_id, name,
1979
 
                     kind, executable) in self.iter_changes(self.basis_tree(),
1980
 
                         include_unchanged=True, require_versioned=False,
1981
 
                         want_unversioned=True, specific_files=files):
1982
 
                    if versioned == (False, False):
1983
 
                        # The record is unknown ...
1984
 
                        if not self.is_ignored(path[1]):
1985
 
                            # ... but not ignored
1986
 
                            has_changed_files = True
1987
 
                            break
1988
 
                    elif content_change and (kind[1] is not None):
1989
 
                        # Versioned and changed, but not deleted
1990
 
                        has_changed_files = True
1991
 
                        break
 
2067
            for (file_id, path, content_change, versioned, parent_id, name,
 
2068
                 kind, executable) in self.iter_changes(self.basis_tree(),
 
2069
                     include_unchanged=True, require_versioned=False,
 
2070
                     want_unversioned=True, specific_files=files):
 
2071
                if versioned[0] == False:
 
2072
                    # The record is unknown or newly added
 
2073
                    files_to_backup.append(path[1])
 
2074
                elif (content_change and (kind[1] is not None) and
 
2075
                        osutils.is_inside_any(files, path[1])):
 
2076
                    # Versioned and changed, but not deleted, and still
 
2077
                    # in one of the dirs to be deleted.
 
2078
                    files_to_backup.append(path[1])
1992
2079
 
1993
 
            if has_changed_files:
1994
 
                # Make delta show ALL applicable changes in error message.
1995
 
                tree_delta = self.changes_from(self.basis_tree(),
1996
 
                    require_versioned=False, want_unversioned=True,
1997
 
                    specific_files=files)
1998
 
                for unknown_file in unknown_nested_files:
1999
 
                    if unknown_file not in tree_delta.unversioned:
2000
 
                        tree_delta.unversioned.extend((unknown_file,))
2001
 
                raise errors.BzrRemoveChangedFilesError(tree_delta)
 
2080
        def backup(file_to_backup):
 
2081
            backup_name = self.bzrdir.generate_backup_name(file_to_backup)
 
2082
            osutils.rename(abs_path, self.abspath(backup_name))
 
2083
            return "removed %s (but kept a copy: %s)" % (file_to_backup, backup_name)
2002
2084
 
2003
2085
        # Build inv_delta and delete files where applicable,
2004
2086
        # do this before any modifications to inventory.
2014
2096
                        new_status = 'I'
2015
2097
                    else:
2016
2098
                        new_status = '?'
2017
 
                    textui.show_status(new_status, self.kind(fid), f,
2018
 
                                       to_file=to_file)
 
2099
                    # XXX: Really should be a more abstract reporter interface
 
2100
                    kind_ch = osutils.kind_marker(self.kind(fid))
 
2101
                    to_file.write(new_status + '       ' + f + kind_ch + '\n')
2019
2102
                # Unversion file
2020
2103
                inv_delta.append((f, None, fid, None))
2021
2104
                message = "removed %s" % (f,)
2027
2110
                        len(os.listdir(abs_path)) > 0):
2028
2111
                        if force:
2029
2112
                            osutils.rmtree(abs_path)
 
2113
                            message = "deleted %s" % (f,)
2030
2114
                        else:
2031
 
                            message = "%s is not an empty directory "\
2032
 
                                "and won't be deleted." % (f,)
 
2115
                            message = backup(f)
2033
2116
                    else:
2034
 
                        osutils.delete_any(abs_path)
2035
 
                        message = "deleted %s" % (f,)
 
2117
                        if f in files_to_backup:
 
2118
                            message = backup(f)
 
2119
                        else:
 
2120
                            osutils.delete_any(abs_path)
 
2121
                            message = "deleted %s" % (f,)
2036
2122
                elif message is not None:
2037
2123
                    # Only care if we haven't done anything yet.
2038
2124
                    message = "%s does not exist." % (f,)
2044
2130
 
2045
2131
    @needs_tree_write_lock
2046
2132
    def revert(self, filenames=None, old_tree=None, backups=True,
2047
 
               pb=DummyProgress(), report_changes=False):
 
2133
               pb=None, report_changes=False):
2048
2134
        from bzrlib.conflicts import resolve
2049
2135
        if filenames == []:
2050
2136
            filenames = None
2172
2258
        """
2173
2259
        raise NotImplementedError(self.unlock)
2174
2260
 
2175
 
    def update(self, change_reporter=None, possible_transports=None):
 
2261
    _marker = object()
 
2262
 
 
2263
    def update(self, change_reporter=None, possible_transports=None,
 
2264
               revision=None, old_tip=_marker):
2176
2265
        """Update a working tree along its branch.
2177
2266
 
2178
2267
        This will update the branch if its bound too, which means we have
2196
2285
        - Merge current state -> basis tree of the master w.r.t. the old tree
2197
2286
          basis.
2198
2287
        - Do a 'normal' merge of the old branch basis if it is relevant.
 
2288
 
 
2289
        :param revision: The target revision to update to. Must be in the
 
2290
            revision history.
 
2291
        :param old_tip: If branch.update() has already been run, the value it
 
2292
            returned (old tip of the branch or None). _marker is used
 
2293
            otherwise.
2199
2294
        """
2200
2295
        if self.branch.get_bound_location() is not None:
2201
2296
            self.lock_write()
2202
 
            update_branch = True
 
2297
            update_branch = (old_tip is self._marker)
2203
2298
        else:
2204
2299
            self.lock_tree_write()
2205
2300
            update_branch = False
2207
2302
            if update_branch:
2208
2303
                old_tip = self.branch.update(possible_transports)
2209
2304
            else:
2210
 
                old_tip = None
2211
 
            return self._update_tree(old_tip, change_reporter)
 
2305
                if old_tip is self._marker:
 
2306
                    old_tip = None
 
2307
            return self._update_tree(old_tip, change_reporter, revision)
2212
2308
        finally:
2213
2309
            self.unlock()
2214
2310
 
2215
2311
    @needs_tree_write_lock
2216
 
    def _update_tree(self, old_tip=None, change_reporter=None):
 
2312
    def _update_tree(self, old_tip=None, change_reporter=None, revision=None):
2217
2313
        """Update a tree to the master branch.
2218
2314
 
2219
2315
        :param old_tip: if supplied, the previous tip revision the branch,
2229
2325
        # We MUST save it even if an error occurs, because otherwise the users
2230
2326
        # local work is unreferenced and will appear to have been lost.
2231
2327
        #
2232
 
        result = 0
 
2328
        nb_conflicts = 0
2233
2329
        try:
2234
2330
            last_rev = self.get_parent_ids()[0]
2235
2331
        except IndexError:
2236
2332
            last_rev = _mod_revision.NULL_REVISION
2237
 
        if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
2238
 
            # merge tree state up to new branch tip.
 
2333
        if revision is None:
 
2334
            revision = self.branch.last_revision()
 
2335
 
 
2336
        old_tip = old_tip or _mod_revision.NULL_REVISION
 
2337
 
 
2338
        if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
 
2339
            # the branch we are bound to was updated
 
2340
            # merge those changes in first
 
2341
            base_tree  = self.basis_tree()
 
2342
            other_tree = self.branch.repository.revision_tree(old_tip)
 
2343
            nb_conflicts = merge.merge_inner(self.branch, other_tree,
 
2344
                                             base_tree, this_tree=self,
 
2345
                                             change_reporter=change_reporter)
 
2346
            if nb_conflicts:
 
2347
                self.add_parent_tree((old_tip, other_tree))
 
2348
                trace.note('Rerun update after fixing the conflicts.')
 
2349
                return nb_conflicts
 
2350
 
 
2351
        if last_rev != _mod_revision.ensure_null(revision):
 
2352
            # the working tree is up to date with the branch
 
2353
            # we can merge the specified revision from master
 
2354
            to_tree = self.branch.repository.revision_tree(revision)
 
2355
            to_root_id = to_tree.get_root_id()
 
2356
 
2239
2357
            basis = self.basis_tree()
2240
2358
            basis.lock_read()
2241
2359
            try:
2242
 
                to_tree = self.branch.basis_tree()
2243
 
                if basis.inventory.root is None:
2244
 
                    self.set_root_id(to_tree.get_root_id())
 
2360
                if (basis.inventory.root is None
 
2361
                    or basis.inventory.root.file_id != to_root_id):
 
2362
                    self.set_root_id(to_root_id)
2245
2363
                    self.flush()
2246
 
                result += merge.merge_inner(
2247
 
                                      self.branch,
2248
 
                                      to_tree,
2249
 
                                      basis,
2250
 
                                      this_tree=self,
2251
 
                                      change_reporter=change_reporter)
2252
2364
            finally:
2253
2365
                basis.unlock()
 
2366
 
 
2367
            # determine the branch point
 
2368
            graph = self.branch.repository.get_graph()
 
2369
            base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
 
2370
                                                last_rev)
 
2371
            base_tree = self.branch.repository.revision_tree(base_rev_id)
 
2372
 
 
2373
            nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
 
2374
                                             this_tree=self,
 
2375
                                             change_reporter=change_reporter)
 
2376
            self.set_last_revision(revision)
2254
2377
            # TODO - dedup parents list with things merged by pull ?
2255
2378
            # reuse the tree we've updated to to set the basis:
2256
 
            parent_trees = [(self.branch.last_revision(), to_tree)]
 
2379
            parent_trees = [(revision, to_tree)]
2257
2380
            merges = self.get_parent_ids()[1:]
2258
2381
            # Ideally we ask the tree for the trees here, that way the working
2259
2382
            # tree can decide whether to give us the entire tree or give us a
2263
2386
            for parent in merges:
2264
2387
                parent_trees.append(
2265
2388
                    (parent, self.branch.repository.revision_tree(parent)))
2266
 
            if (old_tip is not None and not _mod_revision.is_null(old_tip)):
 
2389
            if not _mod_revision.is_null(old_tip):
2267
2390
                parent_trees.append(
2268
2391
                    (old_tip, self.branch.repository.revision_tree(old_tip)))
2269
2392
            self.set_parent_trees(parent_trees)
2270
2393
            last_rev = parent_trees[0][0]
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
 
2394
        return nb_conflicts
2303
2395
 
2304
2396
    def _write_hashcache_if_dirty(self):
2305
2397
        """Write out the hashcache if it is dirty."""
2575
2667
        """
2576
2668
        return
2577
2669
 
2578
 
    @needs_read_lock
2579
2670
    def _get_rules_searcher(self, default_searcher):
2580
2671
        """See Tree._get_rules_searcher."""
2581
2672
        if self._rules_searcher is None:
2617
2708
 
2618
2709
        In Format2 WorkingTrees we have a single lock for the branch and tree
2619
2710
        so lock_tree_write() degrades to lock_write().
 
2711
 
 
2712
        :return: An object with an unlock method which will release the lock
 
2713
            obtained.
2620
2714
        """
2621
2715
        self.branch.lock_write()
2622
2716
        try:
2623
 
            return self._control_files.lock_write()
 
2717
            self._control_files.lock_write()
 
2718
            return self
2624
2719
        except:
2625
2720
            self.branch.unlock()
2626
2721
            raise
2760
2855
        """Return the format for the working tree object in a_bzrdir."""
2761
2856
        try:
2762
2857
            transport = a_bzrdir.get_workingtree_transport(None)
2763
 
            format_string = transport.get("format").read()
 
2858
            format_string = transport.get_bytes("format")
2764
2859
            return klass._formats[format_string]
2765
2860
        except errors.NoSuchFile:
2766
2861
            raise errors.NoWorkingTree(base=transport.base)
3030
3125
        return self.get_format_string()
3031
3126
 
3032
3127
 
3033
 
__default_format = WorkingTreeFormat4()
 
3128
__default_format = WorkingTreeFormat6()
3034
3129
WorkingTreeFormat.register_format(__default_format)
3035
 
WorkingTreeFormat.register_format(WorkingTreeFormat6())
3036
3130
WorkingTreeFormat.register_format(WorkingTreeFormat5())
 
3131
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3037
3132
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3038
3133
WorkingTreeFormat.set_default_format(__default_format)
3039
3134
# formats which have no format string are not discoverable