~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Martin Pool
  • Date: 2009-07-10 06:46:10 UTC
  • mto: (4525.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 4526.
  • Revision ID: mbp@sourcefrog.net-20090710064610-sqviksbqp5i34sw2
Rename to per_interrepository

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
49
55
    branch,
50
56
    bzrdir,
51
57
    conflicts as _mod_conflicts,
52
 
    controldir,
53
58
    errors,
54
59
    generate_ids,
55
60
    globbing,
60
65
    merge,
61
66
    revision as _mod_revision,
62
67
    revisiontree,
 
68
    textui,
63
69
    trace,
64
70
    transform,
65
 
    transport,
66
71
    ui,
67
72
    views,
68
73
    xml5,
69
74
    xml7,
70
75
    )
 
76
import bzrlib.branch
 
77
from bzrlib.transport import get_transport
71
78
from bzrlib.workingtree_4 import (
72
79
    WorkingTreeFormat4,
73
80
    WorkingTreeFormat5,
77
84
 
78
85
from bzrlib import symbol_versioning
79
86
from bzrlib.decorators import needs_read_lock, needs_write_lock
80
 
from bzrlib.lock import LogicalLockResult
81
87
from bzrlib.lockable_files import LockableFiles
82
88
from bzrlib.lockdir import LockDir
83
89
import bzrlib.mutabletree
96
102
from bzrlib.filters import filtered_input_file
97
103
from bzrlib.trace import mutter, note
98
104
from bzrlib.transport.local import LocalTransport
 
105
from bzrlib.progress import DummyProgress, ProgressPhase
99
106
from bzrlib.revision import CURRENT_REVISION
100
107
from bzrlib.rio import RioReader, rio_file, Stanza
101
108
from bzrlib.symbol_versioning import (
105
112
 
106
113
 
107
114
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
115
CONFLICT_HEADER_1 = "BZR conflict list format 1"
112
116
 
113
117
ERROR_PATH_NOT_FOUND = 3    # WindowsError errno code, equivalent to ENOENT
168
172
        return ''
169
173
 
170
174
 
171
 
class WorkingTree(bzrlib.mutabletree.MutableTree,
172
 
    controldir.ControlComponent):
 
175
class WorkingTree(bzrlib.mutabletree.MutableTree):
173
176
    """Working copy tree.
174
177
 
175
178
    The inventory is held in the `Branch` working-inventory, and the
177
180
 
178
181
    It is possible for a `WorkingTree` to have a filename which is
179
182
    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
 
 
262
254
    def _detect_case_handling(self):
263
255
        wt_trans = self.bzrdir.get_workingtree_transport(None)
264
256
        try:
289
281
        self._control_files.break_lock()
290
282
        self.branch.break_lock()
291
283
 
292
 
    def _get_check_refs(self):
293
 
        """Return the references needed to perform a check of this tree.
294
 
        
295
 
        The default implementation returns no refs, and is only suitable for
296
 
        trees that have no local caching and can commit on ghosts at any time.
297
 
 
298
 
        :seealso: bzrlib.check for details about check_refs.
299
 
        """
300
 
        return []
301
 
 
302
284
    def requires_rich_root(self):
303
285
        return self._format.requires_rich_root
304
286
 
350
332
        if path is None:
351
333
            path = osutils.getcwd()
352
334
        control, relpath = bzrdir.BzrDir.open_containing(path)
 
335
 
353
336
        return control.open_workingtree(), relpath
354
337
 
355
338
    @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
414
339
    def open_downlevel(path=None):
415
340
        """Open an unsupported working tree.
416
341
 
429
354
                return True, None
430
355
            else:
431
356
                return True, tree
432
 
        t = transport.get_transport(location)
433
 
        iterator = bzrdir.BzrDir.find_bzrdirs(t, evaluate=evaluate,
 
357
        transport = get_transport(location)
 
358
        iterator = bzrdir.BzrDir.find_bzrdirs(transport, evaluate=evaluate,
434
359
                                              list_current=list_current)
435
 
        return [tr for tr in iterator if tr is not None]
 
360
        return [t for t in iterator if t is not None]
436
361
 
437
362
    # should be deprecated - this is slow and in any case treating them as a
438
363
    # container is (we now know) bad style -- mbp 20070302
523
448
        return (file_obj, stat_value)
524
449
 
525
450
    def get_file_text(self, file_id, path=None, filtered=True):
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()
 
451
        return self.get_file(file_id, path=path, filtered=filtered).read()
531
452
 
532
453
    def get_file_byname(self, filename, filtered=True):
533
454
        path = self.abspath(filename)
587
508
 
588
509
        # Now we have the parents of this content
589
510
        annotator = self.branch.repository.texts.get_annotator()
590
 
        text = self.get_file_text(file_id)
 
511
        text = self.get_file(file_id).read()
591
512
        this_key =(file_id, default_revision)
592
513
        annotator.add_special_text(this_key, file_parent_keys, text)
593
514
        annotations = [(key[-1], line)
613
534
        else:
614
535
            parents = [last_rev]
615
536
        try:
616
 
            merges_bytes = self._transport.get_bytes('pending-merges')
 
537
            merges_file = self._transport.get('pending-merges')
617
538
        except errors.NoSuchFile:
618
539
            pass
619
540
        else:
620
 
            for l in osutils.split_lines(merges_bytes):
 
541
            for l in merges_file.readlines():
621
542
                revision_id = l.rstrip('\n')
622
543
                parents.append(revision_id)
623
544
        return parents
682
603
 
683
604
    def get_file_size(self, file_id):
684
605
        """See Tree.get_file_size"""
685
 
        # XXX: this returns the on-disk size; it should probably return the
686
 
        # canonical size
687
606
        try:
688
607
            return os.path.getsize(self.id2abspath(file_id))
689
608
        except OSError, e:
705
624
 
706
625
    def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
707
626
        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
712
627
        return self._inventory[file_id].executable
713
628
 
714
629
    def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
824
739
            raise
825
740
        kind = _mapper(stat_result.st_mode)
826
741
        if kind == 'file':
827
 
            return self._file_content_summary(path, stat_result)
 
742
            size = stat_result.st_size
 
743
            # try for a stat cache lookup
 
744
            executable = self._is_executable_from_path_and_stat(path, stat_result)
 
745
            return (kind, size, executable, self._sha_from_stat(
 
746
                path, stat_result))
828
747
        elif kind == 'directory':
829
748
            # perhaps it looks like a plain directory, but it's really a
830
749
            # reference.
837
756
        else:
838
757
            return (kind, None, None, None)
839
758
 
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
 
 
847
759
    def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
848
760
        """Common ghost checking functionality from set_parent_*.
849
761
 
969
881
 
970
882
    @needs_write_lock # because merge pulls data into the branch.
971
883
    def merge_from_branch(self, branch, to_revision=None, from_revision=None,
972
 
                          merge_type=None, force=False):
 
884
        merge_type=None):
973
885
        """Merge from a branch into this working tree.
974
886
 
975
887
        :param branch: The branch to merge from.
979
891
            branch.last_revision().
980
892
        """
981
893
        from bzrlib.merge import Merger, Merge3Merger
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()
 
894
        pb = ui.ui_factory.nested_progress_bar()
 
895
        try:
 
896
            merger = Merger(self.branch, this_tree=self, pb=pb)
 
897
            merger.pp = ProgressPhase("Merge phase", 5, pb)
 
898
            merger.pp.next_phase()
 
899
            # check that there are no
 
900
            # local alterations
 
901
            merger.check_basis(check_clean=True, require_commits=False)
 
902
            if to_revision is None:
 
903
                to_revision = _mod_revision.ensure_null(branch.last_revision())
 
904
            merger.other_rev_id = to_revision
 
905
            if _mod_revision.is_null(merger.other_rev_id):
 
906
                raise errors.NoCommits(branch)
 
907
            self.branch.fetch(branch, last_revision=merger.other_rev_id)
 
908
            merger.other_basis = merger.other_rev_id
 
909
            merger.other_tree = self.branch.repository.revision_tree(
 
910
                merger.other_rev_id)
 
911
            merger.other_branch = branch
 
912
            merger.pp.next_phase()
 
913
            if from_revision is None:
 
914
                merger.find_base()
 
915
            else:
 
916
                merger.set_base_revision(from_revision, branch)
 
917
            if merger.base_rev_id == merger.other_rev_id:
 
918
                raise errors.PointlessMerge
 
919
            merger.backup_files = False
 
920
            if merge_type is None:
 
921
                merger.merge_type = Merge3Merger
 
922
            else:
 
923
                merger.merge_type = merge_type
 
924
            merger.set_interesting_files(None)
 
925
            merger.show_base = False
 
926
            merger.reprocess = False
 
927
            conflicts = merger.do_merge()
 
928
            merger.set_pending()
 
929
        finally:
 
930
            pb.finished()
1012
931
        return conflicts
1013
932
 
1014
933
    @needs_read_lock
1161
1080
        tree_transport = self.bzrdir.root_transport.clone(sub_path)
1162
1081
        if tree_transport.base != branch_transport.base:
1163
1082
            tree_bzrdir = format.initialize_on_transport(tree_transport)
1164
 
            branch.BranchReferenceFormat().initialize(tree_bzrdir,
1165
 
                target_branch=new_branch)
 
1083
            branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1166
1084
        else:
1167
1085
            tree_bzrdir = branch_bzrdir
1168
1086
        wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
1206
1124
        This does not include files that have been deleted in this
1207
1125
        tree. Skips the control directory.
1208
1126
 
1209
 
        :param include_root: if True, return an entry for the root
 
1127
        :param include_root: if True, do not return an entry for the root
1210
1128
        :param from_dir: start from this directory or None for the root
1211
1129
        :param recursive: whether to recurse into subdirectories or not
1212
1130
        """
1267
1185
                # absolute path
1268
1186
                fap = from_dir_abspath + '/' + f
1269
1187
 
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
 
1188
                f_ie = inv.get_child(from_dir_id, f)
1275
1189
                if f_ie:
1276
1190
                    c = 'V'
1277
1191
                elif self.is_ignored(fp[1:]):
1278
1192
                    c = 'I'
1279
1193
                else:
1280
 
                    # we may not have found this file, because of a unicode
1281
 
                    # issue, or because the directory was actually a symlink.
 
1194
                    # we may not have found this file, because of a unicode issue
1282
1195
                    f_norm, can_access = osutils.normalized_filename(f)
1283
1196
                    if f == f_norm or not can_access:
1284
1197
                        # No change, so treat this file normally
1327
1240
                stack.pop()
1328
1241
 
1329
1242
    @needs_tree_write_lock
1330
 
    def move(self, from_paths, to_dir=None, after=False):
 
1243
    def move(self, from_paths, to_dir=None, after=False, **kwargs):
1331
1244
        """Rename files.
1332
1245
 
1333
1246
        to_dir must exist in the inventory.
1367
1280
 
1368
1281
        # check for deprecated use of signature
1369
1282
        if to_dir is None:
1370
 
            raise TypeError('You must supply a target directory')
 
1283
            to_dir = kwargs.get('to_name', None)
 
1284
            if to_dir is None:
 
1285
                raise TypeError('You must supply a target directory')
 
1286
            else:
 
1287
                symbol_versioning.warn('The parameter to_name was deprecated'
 
1288
                                       ' in version 0.13. Use to_dir instead',
 
1289
                                       DeprecationWarning)
 
1290
 
1371
1291
        # check destination directory
1372
1292
        if isinstance(from_paths, basestring):
1373
1293
            raise ValueError()
1556
1476
        from_tail = splitpath(from_rel)[-1]
1557
1477
        from_id = inv.path2id(from_rel)
1558
1478
        if from_id is None:
1559
 
            # if file is missing in the inventory maybe it's in the basis_tree
1560
 
            basis_tree = self.branch.basis_tree()
1561
 
            from_id = basis_tree.path2id(from_rel)
1562
 
            if from_id is None:
1563
 
                raise errors.BzrRenameFailedError(from_rel,to_rel,
1564
 
                    errors.NotVersionedError(path=str(from_rel)))
1565
 
            # put entry back in the inventory so we can rename it
1566
 
            from_entry = basis_tree.inventory[from_id].copy()
1567
 
            inv.add(from_entry)
1568
 
        else:
1569
 
            from_entry = inv[from_id]
 
1479
            raise errors.BzrRenameFailedError(from_rel,to_rel,
 
1480
                errors.NotVersionedError(path=str(from_rel)))
 
1481
        from_entry = inv[from_id]
1570
1482
        from_parent_id = from_entry.parent_id
1571
1483
        to_dir, to_tail = os.path.split(to_rel)
1572
1484
        to_dir_id = inv.path2id(to_dir)
1663
1575
 
1664
1576
    @needs_write_lock
1665
1577
    def pull(self, source, overwrite=False, stop_revision=None,
1666
 
             change_reporter=None, possible_transports=None, local=False,
1667
 
             show_base=False):
 
1578
             change_reporter=None, possible_transports=None, local=False):
 
1579
        top_pb = ui.ui_factory.nested_progress_bar()
1668
1580
        source.lock_read()
1669
1581
        try:
 
1582
            pp = ProgressPhase("Pull phase", 2, top_pb)
 
1583
            pp.next_phase()
1670
1584
            old_revision_info = self.branch.last_revision_info()
1671
1585
            basis_tree = self.basis_tree()
1672
1586
            count = self.branch.pull(source, overwrite, stop_revision,
1674
1588
                                     local=local)
1675
1589
            new_revision_info = self.branch.last_revision_info()
1676
1590
            if new_revision_info != old_revision_info:
 
1591
                pp.next_phase()
1677
1592
                repository = self.branch.repository
 
1593
                pb = ui.ui_factory.nested_progress_bar()
1678
1594
                basis_tree.lock_read()
1679
1595
                try:
1680
1596
                    new_basis_tree = self.branch.basis_tree()
1683
1599
                                new_basis_tree,
1684
1600
                                basis_tree,
1685
1601
                                this_tree=self,
1686
 
                                pb=None,
1687
 
                                change_reporter=change_reporter,
1688
 
                                show_base=show_base)
1689
 
                    basis_root_id = basis_tree.get_root_id()
1690
 
                    new_root_id = new_basis_tree.get_root_id()
1691
 
                    if basis_root_id != new_root_id:
1692
 
                        self.set_root_id(new_root_id)
 
1602
                                pb=pb,
 
1603
                                change_reporter=change_reporter)
 
1604
                    if (basis_tree.inventory.root is None and
 
1605
                        new_basis_tree.inventory.root is not None):
 
1606
                        self.set_root_id(new_basis_tree.get_root_id())
1693
1607
                finally:
 
1608
                    pb.finished()
1694
1609
                    basis_tree.unlock()
1695
1610
                # TODO - dedup parents list with things merged by pull ?
1696
1611
                # reuse the revisiontree we merged against to set the new
1709
1624
            return count
1710
1625
        finally:
1711
1626
            source.unlock()
 
1627
            top_pb.finished()
1712
1628
 
1713
1629
    @needs_write_lock
1714
1630
    def put_file_bytes_non_atomic(self, file_id, bytes):
1799
1715
        r"""Check whether the filename matches an ignore pattern.
1800
1716
 
1801
1717
        Patterns containing '/' or '\' need to match the whole path;
1802
 
        others match against only the last component.  Patterns starting
1803
 
        with '!' are ignore exceptions.  Exceptions take precedence
1804
 
        over regular patterns and cause the filename to not be ignored.
 
1718
        others match against only the last component.
1805
1719
 
1806
1720
        If the file is ignored, returns the pattern which caused it to
1807
1721
        be ignored, otherwise None.  So this can simply be used as a
1808
1722
        boolean if desired."""
1809
1723
        if getattr(self, '_ignoreglobster', None) is None:
1810
 
            self._ignoreglobster = globbing.ExceptionGlobster(self.get_ignore_list())
 
1724
            self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1811
1725
        return self._ignoreglobster.match(filename)
1812
1726
 
1813
1727
    def kind(self, file_id):
1863
1777
            raise errors.ObjectNotLocked(self)
1864
1778
 
1865
1779
    def lock_read(self):
1866
 
        """Lock the tree for reading.
1867
 
 
1868
 
        This also locks the branch, and can be unlocked via self.unlock().
1869
 
 
1870
 
        :return: A bzrlib.lock.LogicalLockResult.
1871
 
        """
 
1780
        """See Branch.lock_read, and WorkingTree.unlock."""
1872
1781
        if not self.is_locked():
1873
1782
            self._reset_data()
1874
1783
        self.branch.lock_read()
1875
1784
        try:
1876
 
            self._control_files.lock_read()
1877
 
            return LogicalLockResult(self.unlock)
 
1785
            return self._control_files.lock_read()
1878
1786
        except:
1879
1787
            self.branch.unlock()
1880
1788
            raise
1881
1789
 
1882
1790
    def lock_tree_write(self):
1883
 
        """See MutableTree.lock_tree_write, and WorkingTree.unlock.
1884
 
 
1885
 
        :return: A bzrlib.lock.LogicalLockResult.
1886
 
        """
 
1791
        """See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1887
1792
        if not self.is_locked():
1888
1793
            self._reset_data()
1889
1794
        self.branch.lock_read()
1890
1795
        try:
1891
 
            self._control_files.lock_write()
1892
 
            return LogicalLockResult(self.unlock)
 
1796
            return self._control_files.lock_write()
1893
1797
        except:
1894
1798
            self.branch.unlock()
1895
1799
            raise
1896
1800
 
1897
1801
    def lock_write(self):
1898
 
        """See MutableTree.lock_write, and WorkingTree.unlock.
1899
 
 
1900
 
        :return: A bzrlib.lock.LogicalLockResult.
1901
 
        """
 
1802
        """See MutableTree.lock_write, and WorkingTree.unlock."""
1902
1803
        if not self.is_locked():
1903
1804
            self._reset_data()
1904
1805
        self.branch.lock_write()
1905
1806
        try:
1906
 
            self._control_files.lock_write()
1907
 
            return LogicalLockResult(self.unlock)
 
1807
            return self._control_files.lock_write()
1908
1808
        except:
1909
1809
            self.branch.unlock()
1910
1810
            raise
1918
1818
    def _reset_data(self):
1919
1819
        """Reset transient data that cannot be revalidated."""
1920
1820
        self._inventory_is_modified = False
1921
 
        f = self._transport.get('inventory')
1922
 
        try:
1923
 
            result = self._deserialize(f)
1924
 
        finally:
1925
 
            f.close()
 
1821
        result = self._deserialize(self._transport.get('inventory'))
1926
1822
        self._set_inventory(result, dirty=False)
1927
1823
 
1928
1824
    @needs_tree_write_lock
1975
1871
            # revision_id is set. We must check for this full string, because a
1976
1872
            # root node id can legitimately look like 'revision_id' but cannot
1977
1873
            # contain a '"'.
1978
 
            xml = self.branch.repository._get_inventory_xml(new_revision)
 
1874
            xml = self.branch.repository.get_inventory_xml(new_revision)
1979
1875
            firstline = xml.split('\n', 1)[0]
1980
1876
            if (not 'revision_id="' in firstline or
1981
1877
                'format="7"' not in firstline):
1982
 
                inv = self.branch.repository._serializer.read_inventory_from_string(
1983
 
                    xml, new_revision)
 
1878
                inv = self.branch.repository.deserialise_inventory(
 
1879
                    new_revision, xml)
1984
1880
                xml = self._create_basis_xml_from_inventory(new_revision, inv)
1985
1881
            self._write_basis_inventory(xml)
1986
1882
        except (errors.NoSuchRevision, errors.RevisionNotPresent):
2004
1900
        # binary.
2005
1901
        if self._inventory_is_modified:
2006
1902
            raise errors.InventoryModified(self)
2007
 
        f = self._transport.get('inventory')
2008
 
        try:
2009
 
            result = self._deserialize(f)
2010
 
        finally:
2011
 
            f.close()
 
1903
        result = self._deserialize(self._transport.get('inventory'))
2012
1904
        self._set_inventory(result, dirty=False)
2013
1905
        return result
2014
1906
 
2027
1919
 
2028
1920
        inv_delta = []
2029
1921
 
2030
 
        all_files = set() # specified and nested files 
 
1922
        new_files=set()
2031
1923
        unknown_nested_files=set()
2032
 
        if to_file is None:
2033
 
            to_file = sys.stdout
2034
 
 
2035
 
        files_to_backup = []
2036
1924
 
2037
1925
        def recurse_directory_to_add_files(directory):
2038
1926
            # Recurse directory and add all files
2039
1927
            # so we can check if they have changed.
2040
 
            for parent_info, file_infos in self.walkdirs(directory):
 
1928
            for parent_info, file_infos in\
 
1929
                self.walkdirs(directory):
2041
1930
                for relpath, basename, kind, lstat, fileid, kind in file_infos:
2042
1931
                    # Is it versioned or ignored?
2043
 
                    if self.path2id(relpath):
 
1932
                    if self.path2id(relpath) or self.is_ignored(relpath):
2044
1933
                        # Add nested content for deletion.
2045
 
                        all_files.add(relpath)
 
1934
                        new_files.add(relpath)
2046
1935
                    else:
2047
 
                        # Files which are not versioned
 
1936
                        # Files which are not versioned and not ignored
2048
1937
                        # should be treated as unknown.
2049
 
                        files_to_backup.append(relpath)
 
1938
                        unknown_nested_files.add((relpath, None, kind))
2050
1939
 
2051
1940
        for filename in files:
2052
1941
            # Get file name into canonical form.
2053
1942
            abspath = self.abspath(filename)
2054
1943
            filename = self.relpath(abspath)
2055
1944
            if len(filename) > 0:
2056
 
                all_files.add(filename)
 
1945
                new_files.add(filename)
2057
1946
                recurse_directory_to_add_files(filename)
2058
1947
 
2059
 
        files = list(all_files)
 
1948
        files = list(new_files)
2060
1949
 
2061
1950
        if len(files) == 0:
2062
1951
            return # nothing to do
2066
1955
 
2067
1956
        # Bail out if we are going to delete files we shouldn't
2068
1957
        if not keep_files and not force:
2069
 
            for (file_id, path, content_change, versioned, parent_id, name,
2070
 
                 kind, executable) in self.iter_changes(self.basis_tree(),
2071
 
                     include_unchanged=True, require_versioned=False,
2072
 
                     want_unversioned=True, specific_files=files):
2073
 
                if versioned[0] == False:
2074
 
                    # The record is unknown or newly added
2075
 
                    files_to_backup.append(path[1])
2076
 
                elif (content_change and (kind[1] is not None) and
2077
 
                        osutils.is_inside_any(files, path[1])):
2078
 
                    # Versioned and changed, but not deleted, and still
2079
 
                    # in one of the dirs to be deleted.
2080
 
                    files_to_backup.append(path[1])
 
1958
            has_changed_files = len(unknown_nested_files) > 0
 
1959
            if not has_changed_files:
 
1960
                for (file_id, path, content_change, versioned, parent_id, name,
 
1961
                     kind, executable) in self.iter_changes(self.basis_tree(),
 
1962
                         include_unchanged=True, require_versioned=False,
 
1963
                         want_unversioned=True, specific_files=files):
 
1964
                    if versioned == (False, False):
 
1965
                        # The record is unknown ...
 
1966
                        if not self.is_ignored(path[1]):
 
1967
                            # ... but not ignored
 
1968
                            has_changed_files = True
 
1969
                            break
 
1970
                    elif content_change and (kind[1] is not None):
 
1971
                        # Versioned and changed, but not deleted
 
1972
                        has_changed_files = True
 
1973
                        break
2081
1974
 
2082
 
        def backup(file_to_backup):
2083
 
            backup_name = self.bzrdir.generate_backup_name(file_to_backup)
2084
 
            osutils.rename(abs_path, self.abspath(backup_name))
2085
 
            return "removed %s (but kept a copy: %s)" % (file_to_backup, backup_name)
 
1975
            if has_changed_files:
 
1976
                # Make delta show ALL applicable changes in error message.
 
1977
                tree_delta = self.changes_from(self.basis_tree(),
 
1978
                    require_versioned=False, want_unversioned=True,
 
1979
                    specific_files=files)
 
1980
                for unknown_file in unknown_nested_files:
 
1981
                    if unknown_file not in tree_delta.unversioned:
 
1982
                        tree_delta.unversioned.extend((unknown_file,))
 
1983
                raise errors.BzrRemoveChangedFilesError(tree_delta)
2086
1984
 
2087
1985
        # Build inv_delta and delete files where applicable,
2088
1986
        # do this before any modifications to inventory.
2098
1996
                        new_status = 'I'
2099
1997
                    else:
2100
1998
                        new_status = '?'
2101
 
                    # XXX: Really should be a more abstract reporter interface
2102
 
                    kind_ch = osutils.kind_marker(self.kind(fid))
2103
 
                    to_file.write(new_status + '       ' + f + kind_ch + '\n')
 
1999
                    textui.show_status(new_status, self.kind(fid), f,
 
2000
                                       to_file=to_file)
2104
2001
                # Unversion file
2105
2002
                inv_delta.append((f, None, fid, None))
2106
2003
                message = "removed %s" % (f,)
2112
2009
                        len(os.listdir(abs_path)) > 0):
2113
2010
                        if force:
2114
2011
                            osutils.rmtree(abs_path)
2115
 
                            message = "deleted %s" % (f,)
2116
2012
                        else:
2117
 
                            message = backup(f)
 
2013
                            message = "%s is not an empty directory "\
 
2014
                                "and won't be deleted." % (f,)
2118
2015
                    else:
2119
 
                        if f in files_to_backup:
2120
 
                            message = backup(f)
2121
 
                        else:
2122
 
                            osutils.delete_any(abs_path)
2123
 
                            message = "deleted %s" % (f,)
 
2016
                        osutils.delete_any(abs_path)
 
2017
                        message = "deleted %s" % (f,)
2124
2018
                elif message is not None:
2125
2019
                    # Only care if we haven't done anything yet.
2126
2020
                    message = "%s does not exist." % (f,)
2132
2026
 
2133
2027
    @needs_tree_write_lock
2134
2028
    def revert(self, filenames=None, old_tree=None, backups=True,
2135
 
               pb=None, report_changes=False):
 
2029
               pb=DummyProgress(), report_changes=False):
2136
2030
        from bzrlib.conflicts import resolve
2137
2031
        if filenames == []:
2138
2032
            filenames = None
2260
2154
        """
2261
2155
        raise NotImplementedError(self.unlock)
2262
2156
 
2263
 
    _marker = object()
2264
 
 
2265
 
    def update(self, change_reporter=None, possible_transports=None,
2266
 
               revision=None, old_tip=_marker, show_base=False):
 
2157
    def update(self, change_reporter=None, possible_transports=None):
2267
2158
        """Update a working tree along its branch.
2268
2159
 
2269
2160
        This will update the branch if its bound too, which means we have
2287
2178
        - Merge current state -> basis tree of the master w.r.t. the old tree
2288
2179
          basis.
2289
2180
        - Do a 'normal' merge of the old branch basis if it is relevant.
2290
 
 
2291
 
        :param revision: The target revision to update to. Must be in the
2292
 
            revision history.
2293
 
        :param old_tip: If branch.update() has already been run, the value it
2294
 
            returned (old tip of the branch or None). _marker is used
2295
 
            otherwise.
2296
2181
        """
2297
2182
        if self.branch.get_bound_location() is not None:
2298
2183
            self.lock_write()
2299
 
            update_branch = (old_tip is self._marker)
 
2184
            update_branch = True
2300
2185
        else:
2301
2186
            self.lock_tree_write()
2302
2187
            update_branch = False
2304
2189
            if update_branch:
2305
2190
                old_tip = self.branch.update(possible_transports)
2306
2191
            else:
2307
 
                if old_tip is self._marker:
2308
 
                    old_tip = None
2309
 
            return self._update_tree(old_tip, change_reporter, revision, show_base)
 
2192
                old_tip = None
 
2193
            return self._update_tree(old_tip, change_reporter)
2310
2194
        finally:
2311
2195
            self.unlock()
2312
2196
 
2313
2197
    @needs_tree_write_lock
2314
 
    def _update_tree(self, old_tip=None, change_reporter=None, revision=None,
2315
 
                     show_base=False):
 
2198
    def _update_tree(self, old_tip=None, change_reporter=None):
2316
2199
        """Update a tree to the master branch.
2317
2200
 
2318
2201
        :param old_tip: if supplied, the previous tip revision the branch,
2328
2211
        # We MUST save it even if an error occurs, because otherwise the users
2329
2212
        # local work is unreferenced and will appear to have been lost.
2330
2213
        #
2331
 
        nb_conflicts = 0
 
2214
        result = 0
2332
2215
        try:
2333
2216
            last_rev = self.get_parent_ids()[0]
2334
2217
        except IndexError:
2335
2218
            last_rev = _mod_revision.NULL_REVISION
2336
 
        if revision is None:
2337
 
            revision = self.branch.last_revision()
2338
 
 
2339
 
        old_tip = old_tip or _mod_revision.NULL_REVISION
2340
 
 
2341
 
        if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
2342
 
            # the branch we are bound to was updated
2343
 
            # merge those changes in first
2344
 
            base_tree  = self.basis_tree()
2345
 
            other_tree = self.branch.repository.revision_tree(old_tip)
2346
 
            nb_conflicts = merge.merge_inner(self.branch, other_tree,
2347
 
                                             base_tree, this_tree=self,
2348
 
                                             change_reporter=change_reporter,
2349
 
                                             show_base=show_base)
2350
 
            if nb_conflicts:
2351
 
                self.add_parent_tree((old_tip, other_tree))
2352
 
                trace.note('Rerun update after fixing the conflicts.')
2353
 
                return nb_conflicts
2354
 
 
2355
 
        if last_rev != _mod_revision.ensure_null(revision):
2356
 
            # the working tree is up to date with the branch
2357
 
            # we can merge the specified revision from master
2358
 
            to_tree = self.branch.repository.revision_tree(revision)
2359
 
            to_root_id = to_tree.get_root_id()
2360
 
 
 
2219
        if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
 
2220
            # merge tree state up to new branch tip.
2361
2221
            basis = self.basis_tree()
2362
2222
            basis.lock_read()
2363
2223
            try:
2364
 
                if (basis.inventory.root is None
2365
 
                    or basis.inventory.root.file_id != to_root_id):
2366
 
                    self.set_root_id(to_root_id)
 
2224
                to_tree = self.branch.basis_tree()
 
2225
                if basis.inventory.root is None:
 
2226
                    self.set_root_id(to_tree.get_root_id())
2367
2227
                    self.flush()
 
2228
                result += merge.merge_inner(
 
2229
                                      self.branch,
 
2230
                                      to_tree,
 
2231
                                      basis,
 
2232
                                      this_tree=self,
 
2233
                                      change_reporter=change_reporter)
2368
2234
            finally:
2369
2235
                basis.unlock()
2370
 
 
2371
 
            # determine the branch point
2372
 
            graph = self.branch.repository.get_graph()
2373
 
            base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2374
 
                                                last_rev)
2375
 
            base_tree = self.branch.repository.revision_tree(base_rev_id)
2376
 
 
2377
 
            nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
2378
 
                                             this_tree=self,
2379
 
                                             change_reporter=change_reporter,
2380
 
                                             show_base=show_base)
2381
 
            self.set_last_revision(revision)
2382
2236
            # TODO - dedup parents list with things merged by pull ?
2383
2237
            # reuse the tree we've updated to to set the basis:
2384
 
            parent_trees = [(revision, to_tree)]
 
2238
            parent_trees = [(self.branch.last_revision(), to_tree)]
2385
2239
            merges = self.get_parent_ids()[1:]
2386
2240
            # Ideally we ask the tree for the trees here, that way the working
2387
2241
            # tree can decide whether to give us the entire tree or give us a
2391
2245
            for parent in merges:
2392
2246
                parent_trees.append(
2393
2247
                    (parent, self.branch.repository.revision_tree(parent)))
2394
 
            if not _mod_revision.is_null(old_tip):
 
2248
            if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2395
2249
                parent_trees.append(
2396
2250
                    (old_tip, self.branch.repository.revision_tree(old_tip)))
2397
2251
            self.set_parent_trees(parent_trees)
2398
2252
            last_rev = parent_trees[0][0]
2399
 
        return nb_conflicts
 
2253
        else:
 
2254
            # the working tree had the same last-revision as the master
 
2255
            # branch did. We may still have pivot local work from the local
 
2256
            # branch into old_tip:
 
2257
            if (old_tip is not None and not _mod_revision.is_null(old_tip)):
 
2258
                self.add_parent_tree_id(old_tip)
 
2259
        if (old_tip is not None and not _mod_revision.is_null(old_tip)
 
2260
            and old_tip != last_rev):
 
2261
            # our last revision was not the prior branch last revision
 
2262
            # and we have converted that last revision to a pending merge.
 
2263
            # base is somewhere between the branch tip now
 
2264
            # and the now pending merge
 
2265
 
 
2266
            # Since we just modified the working tree and inventory, flush out
 
2267
            # the current state, before we modify it again.
 
2268
            # TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
 
2269
            #       requires it only because TreeTransform directly munges the
 
2270
            #       inventory and calls tree._write_inventory(). Ultimately we
 
2271
            #       should be able to remove this extra flush.
 
2272
            self.flush()
 
2273
            graph = self.branch.repository.get_graph()
 
2274
            base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
 
2275
                                                old_tip)
 
2276
            base_tree = self.branch.repository.revision_tree(base_rev_id)
 
2277
            other_tree = self.branch.repository.revision_tree(old_tip)
 
2278
            result += merge.merge_inner(
 
2279
                                  self.branch,
 
2280
                                  other_tree,
 
2281
                                  base_tree,
 
2282
                                  this_tree=self,
 
2283
                                  change_reporter=change_reporter)
 
2284
        return result
2400
2285
 
2401
2286
    def _write_hashcache_if_dirty(self):
2402
2287
        """Write out the hashcache if it is dirty."""
2643
2528
        return un_resolved, resolved
2644
2529
 
2645
2530
    @needs_read_lock
2646
 
    def _check(self, references):
2647
 
        """Check the tree for consistency.
2648
 
 
2649
 
        :param references: A dict with keys matching the items returned by
2650
 
            self._get_check_refs(), and values from looking those keys up in
2651
 
            the repository.
2652
 
        """
 
2531
    def _check(self):
2653
2532
        tree_basis = self.basis_tree()
2654
2533
        tree_basis.lock_read()
2655
2534
        try:
2656
 
            repo_basis = references[('trees', self.last_revision())]
 
2535
            repo_basis = self.branch.repository.revision_tree(
 
2536
                self.last_revision())
2657
2537
            if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2658
2538
                raise errors.BzrCheckError(
2659
2539
                    "Mismatched basis inventory content.")
2672
2552
        """
2673
2553
        return
2674
2554
 
 
2555
    @needs_read_lock
2675
2556
    def _get_rules_searcher(self, default_searcher):
2676
2557
        """See Tree._get_rules_searcher."""
2677
2558
        if self._rules_searcher is None:
2704
2585
        if self._inventory is None:
2705
2586
            self.read_working_inventory()
2706
2587
 
2707
 
    def _get_check_refs(self):
2708
 
        """Return the references needed to perform a check of this tree."""
2709
 
        return [('trees', self.last_revision())]
2710
 
 
2711
2588
    def lock_tree_write(self):
2712
2589
        """See WorkingTree.lock_tree_write().
2713
2590
 
2714
2591
        In Format2 WorkingTrees we have a single lock for the branch and tree
2715
2592
        so lock_tree_write() degrades to lock_write().
2716
 
 
2717
 
        :return: An object with an unlock method which will release the lock
2718
 
            obtained.
2719
2593
        """
2720
2594
        self.branch.lock_write()
2721
2595
        try:
2722
 
            self._control_files.lock_write()
2723
 
            return self
 
2596
            return self._control_files.lock_write()
2724
2597
        except:
2725
2598
            self.branch.unlock()
2726
2599
            raise
2774
2647
                mode=self.bzrdir._get_file_mode())
2775
2648
            return True
2776
2649
 
2777
 
    def _get_check_refs(self):
2778
 
        """Return the references needed to perform a check of this tree."""
2779
 
        return [('trees', self.last_revision())]
2780
 
 
2781
2650
    @needs_tree_write_lock
2782
2651
    def set_conflicts(self, conflicts):
2783
2652
        self._put_rio('conflicts', conflicts.to_stanzas(),
2860
2729
        """Return the format for the working tree object in a_bzrdir."""
2861
2730
        try:
2862
2731
            transport = a_bzrdir.get_workingtree_transport(None)
2863
 
            format_string = transport.get_bytes("format")
 
2732
            format_string = transport.get("format").read()
2864
2733
            return klass._formats[format_string]
2865
2734
        except errors.NoSuchFile:
2866
2735
            raise errors.NoWorkingTree(base=transport.base)
3130
2999
        return self.get_format_string()
3131
3000
 
3132
3001
 
3133
 
__default_format = WorkingTreeFormat6()
 
3002
__default_format = WorkingTreeFormat4()
3134
3003
WorkingTreeFormat.register_format(__default_format)
 
3004
WorkingTreeFormat.register_format(WorkingTreeFormat6())
3135
3005
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3136
 
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3137
3006
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3138
3007
WorkingTreeFormat.set_default_format(__default_format)
3139
3008
# formats which have no format string are not discoverable