~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Martin Pool
  • Date: 2010-04-21 10:13:50 UTC
  • mto: This revision was merged to the branch mainline in revision 5189.
  • Revision ID: mbp@canonical.com-20100421101350-6eq02ssg8kx1tmb3
Go back to opening branch using url, so it can use all possible transports

Show diffs side-by-side

added added

removed removed

Lines of Context:
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,
62
67
    revisiontree,
63
68
    trace,
64
69
    transform,
65
 
    transport,
66
70
    ui,
67
71
    views,
68
72
    xml5,
69
73
    xml7,
70
74
    )
 
75
import bzrlib.branch
 
76
from bzrlib.transport import get_transport
71
77
from bzrlib.workingtree_4 import (
72
78
    WorkingTreeFormat4,
73
79
    WorkingTreeFormat5,
77
83
 
78
84
from bzrlib import symbol_versioning
79
85
from bzrlib.decorators import needs_read_lock, needs_write_lock
80
 
from bzrlib.lock import LogicalLockResult
81
86
from bzrlib.lockable_files import LockableFiles
82
87
from bzrlib.lockdir import LockDir
83
88
import bzrlib.mutabletree
96
101
from bzrlib.filters import filtered_input_file
97
102
from bzrlib.trace import mutter, note
98
103
from bzrlib.transport.local import LocalTransport
 
104
from bzrlib.progress import ProgressPhase
99
105
from bzrlib.revision import CURRENT_REVISION
100
106
from bzrlib.rio import RioReader, rio_file, Stanza
101
107
from bzrlib.symbol_versioning import (
169
175
 
170
176
 
171
177
class WorkingTree(bzrlib.mutabletree.MutableTree,
172
 
    controldir.ControlComponent):
 
178
    bzrdir.ControlComponent):
173
179
    """Working copy tree.
174
180
 
175
181
    The inventory is held in the `Branch` working-inventory, and the
177
183
 
178
184
    It is possible for a `WorkingTree` to have a filename which is
179
185
    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
186
    """
184
187
 
185
188
    # override this to set the strategy for storing views
350
353
        if path is None:
351
354
            path = osutils.getcwd()
352
355
        control, relpath = bzrdir.BzrDir.open_containing(path)
 
356
 
353
357
        return control.open_workingtree(), relpath
354
358
 
355
359
    @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
360
    def open_downlevel(path=None):
415
361
        """Open an unsupported working tree.
416
362
 
429
375
                return True, None
430
376
            else:
431
377
                return True, tree
432
 
        t = transport.get_transport(location)
433
 
        iterator = bzrdir.BzrDir.find_bzrdirs(t, evaluate=evaluate,
 
378
        transport = get_transport(location)
 
379
        iterator = bzrdir.BzrDir.find_bzrdirs(transport, evaluate=evaluate,
434
380
                                              list_current=list_current)
435
 
        return [tr for tr in iterator if tr is not None]
 
381
        return [t for t in iterator if t is not None]
436
382
 
437
383
    # should be deprecated - this is slow and in any case treating them as a
438
384
    # container is (we now know) bad style -- mbp 20070302
523
469
        return (file_obj, stat_value)
524
470
 
525
471
    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()
 
472
        return self.get_file(file_id, path=path, filtered=filtered).read()
531
473
 
532
474
    def get_file_byname(self, filename, filtered=True):
533
475
        path = self.abspath(filename)
587
529
 
588
530
        # Now we have the parents of this content
589
531
        annotator = self.branch.repository.texts.get_annotator()
590
 
        text = self.get_file_text(file_id)
 
532
        text = self.get_file(file_id).read()
591
533
        this_key =(file_id, default_revision)
592
534
        annotator.add_special_text(this_key, file_parent_keys, text)
593
535
        annotations = [(key[-1], line)
1267
1209
                # absolute path
1268
1210
                fap = from_dir_abspath + '/' + f
1269
1211
 
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
 
1212
                f_ie = inv.get_child(from_dir_id, f)
1275
1213
                if f_ie:
1276
1214
                    c = 'V'
1277
1215
                elif self.is_ignored(fp[1:]):
1278
1216
                    c = 'I'
1279
1217
                else:
1280
 
                    # we may not have found this file, because of a unicode
1281
 
                    # issue, or because the directory was actually a symlink.
 
1218
                    # we may not have found this file, because of a unicode issue
1282
1219
                    f_norm, can_access = osutils.normalized_filename(f)
1283
1220
                    if f == f_norm or not can_access:
1284
1221
                        # No change, so treat this file normally
1327
1264
                stack.pop()
1328
1265
 
1329
1266
    @needs_tree_write_lock
1330
 
    def move(self, from_paths, to_dir=None, after=False):
 
1267
    def move(self, from_paths, to_dir=None, after=False, **kwargs):
1331
1268
        """Rename files.
1332
1269
 
1333
1270
        to_dir must exist in the inventory.
1367
1304
 
1368
1305
        # check for deprecated use of signature
1369
1306
        if to_dir is None:
1370
 
            raise TypeError('You must supply a target directory')
 
1307
            to_dir = kwargs.get('to_name', None)
 
1308
            if to_dir is None:
 
1309
                raise TypeError('You must supply a target directory')
 
1310
            else:
 
1311
                symbol_versioning.warn('The parameter to_name was deprecated'
 
1312
                                       ' in version 0.13. Use to_dir instead',
 
1313
                                       DeprecationWarning)
 
1314
 
1371
1315
        # check destination directory
1372
1316
        if isinstance(from_paths, basestring):
1373
1317
            raise ValueError()
1861
1805
            raise errors.ObjectNotLocked(self)
1862
1806
 
1863
1807
    def lock_read(self):
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
 
        """
 
1808
        """See Branch.lock_read, and WorkingTree.unlock."""
1870
1809
        if not self.is_locked():
1871
1810
            self._reset_data()
1872
1811
        self.branch.lock_read()
1873
1812
        try:
1874
 
            self._control_files.lock_read()
1875
 
            return LogicalLockResult(self.unlock)
 
1813
            return self._control_files.lock_read()
1876
1814
        except:
1877
1815
            self.branch.unlock()
1878
1816
            raise
1879
1817
 
1880
1818
    def lock_tree_write(self):
1881
 
        """See MutableTree.lock_tree_write, and WorkingTree.unlock.
1882
 
 
1883
 
        :return: A bzrlib.lock.LogicalLockResult.
1884
 
        """
 
1819
        """See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1885
1820
        if not self.is_locked():
1886
1821
            self._reset_data()
1887
1822
        self.branch.lock_read()
1888
1823
        try:
1889
 
            self._control_files.lock_write()
1890
 
            return LogicalLockResult(self.unlock)
 
1824
            return self._control_files.lock_write()
1891
1825
        except:
1892
1826
            self.branch.unlock()
1893
1827
            raise
1894
1828
 
1895
1829
    def lock_write(self):
1896
 
        """See MutableTree.lock_write, and WorkingTree.unlock.
1897
 
 
1898
 
        :return: A bzrlib.lock.LogicalLockResult.
1899
 
        """
 
1830
        """See MutableTree.lock_write, and WorkingTree.unlock."""
1900
1831
        if not self.is_locked():
1901
1832
            self._reset_data()
1902
1833
        self.branch.lock_write()
1903
1834
        try:
1904
 
            self._control_files.lock_write()
1905
 
            return LogicalLockResult(self.unlock)
 
1835
            return self._control_files.lock_write()
1906
1836
        except:
1907
1837
            self.branch.unlock()
1908
1838
            raise
2025
1955
 
2026
1956
        inv_delta = []
2027
1957
 
2028
 
        all_files = set() # specified and nested files 
 
1958
        new_files=set()
2029
1959
        unknown_nested_files=set()
2030
1960
        if to_file is None:
2031
1961
            to_file = sys.stdout
2032
1962
 
2033
 
        files_to_backup = []
2034
 
 
2035
1963
        def recurse_directory_to_add_files(directory):
2036
1964
            # Recurse directory and add all files
2037
1965
            # so we can check if they have changed.
2038
 
            for parent_info, file_infos in self.walkdirs(directory):
 
1966
            for parent_info, file_infos in\
 
1967
                self.walkdirs(directory):
2039
1968
                for relpath, basename, kind, lstat, fileid, kind in file_infos:
2040
1969
                    # Is it versioned or ignored?
2041
 
                    if self.path2id(relpath):
 
1970
                    if self.path2id(relpath) or self.is_ignored(relpath):
2042
1971
                        # Add nested content for deletion.
2043
 
                        all_files.add(relpath)
 
1972
                        new_files.add(relpath)
2044
1973
                    else:
2045
 
                        # Files which are not versioned
 
1974
                        # Files which are not versioned and not ignored
2046
1975
                        # should be treated as unknown.
2047
 
                        files_to_backup.append(relpath)
 
1976
                        unknown_nested_files.add((relpath, None, kind))
2048
1977
 
2049
1978
        for filename in files:
2050
1979
            # Get file name into canonical form.
2051
1980
            abspath = self.abspath(filename)
2052
1981
            filename = self.relpath(abspath)
2053
1982
            if len(filename) > 0:
2054
 
                all_files.add(filename)
 
1983
                new_files.add(filename)
2055
1984
                recurse_directory_to_add_files(filename)
2056
1985
 
2057
 
        files = list(all_files)
 
1986
        files = list(new_files)
2058
1987
 
2059
1988
        if len(files) == 0:
2060
1989
            return # nothing to do
2064
1993
 
2065
1994
        # Bail out if we are going to delete files we shouldn't
2066
1995
        if not keep_files and not force:
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])
 
1996
            has_changed_files = len(unknown_nested_files) > 0
 
1997
            if not has_changed_files:
 
1998
                for (file_id, path, content_change, versioned, parent_id, name,
 
1999
                     kind, executable) in self.iter_changes(self.basis_tree(),
 
2000
                         include_unchanged=True, require_versioned=False,
 
2001
                         want_unversioned=True, specific_files=files):
 
2002
                    if versioned == (False, False):
 
2003
                        # The record is unknown ...
 
2004
                        if not self.is_ignored(path[1]):
 
2005
                            # ... but not ignored
 
2006
                            has_changed_files = True
 
2007
                            break
 
2008
                    elif content_change and (kind[1] is not None):
 
2009
                        # Versioned and changed, but not deleted
 
2010
                        has_changed_files = True
 
2011
                        break
2079
2012
 
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)
 
2013
            if has_changed_files:
 
2014
                # Make delta show ALL applicable changes in error message.
 
2015
                tree_delta = self.changes_from(self.basis_tree(),
 
2016
                    require_versioned=False, want_unversioned=True,
 
2017
                    specific_files=files)
 
2018
                for unknown_file in unknown_nested_files:
 
2019
                    if unknown_file not in tree_delta.unversioned:
 
2020
                        tree_delta.unversioned.extend((unknown_file,))
 
2021
                raise errors.BzrRemoveChangedFilesError(tree_delta)
2084
2022
 
2085
2023
        # Build inv_delta and delete files where applicable,
2086
2024
        # do this before any modifications to inventory.
2110
2048
                        len(os.listdir(abs_path)) > 0):
2111
2049
                        if force:
2112
2050
                            osutils.rmtree(abs_path)
2113
 
                            message = "deleted %s" % (f,)
2114
2051
                        else:
2115
 
                            message = backup(f)
 
2052
                            message = "%s is not an empty directory "\
 
2053
                                "and won't be deleted." % (f,)
2116
2054
                    else:
2117
 
                        if f in files_to_backup:
2118
 
                            message = backup(f)
2119
 
                        else:
2120
 
                            osutils.delete_any(abs_path)
2121
 
                            message = "deleted %s" % (f,)
 
2055
                        osutils.delete_any(abs_path)
 
2056
                        message = "deleted %s" % (f,)
2122
2057
                elif message is not None:
2123
2058
                    # Only care if we haven't done anything yet.
2124
2059
                    message = "%s does not exist." % (f,)
2708
2643
 
2709
2644
        In Format2 WorkingTrees we have a single lock for the branch and tree
2710
2645
        so lock_tree_write() degrades to lock_write().
2711
 
 
2712
 
        :return: An object with an unlock method which will release the lock
2713
 
            obtained.
2714
2646
        """
2715
2647
        self.branch.lock_write()
2716
2648
        try:
2717
 
            self._control_files.lock_write()
2718
 
            return self
 
2649
            return self._control_files.lock_write()
2719
2650
        except:
2720
2651
            self.branch.unlock()
2721
2652
            raise