~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-10-01 22:33:10 UTC
  • mfrom: (5452.3.1 doc-fix)
  • Revision ID: pqm@pqm.ubuntu.com-20101001223310-t8adqw9m9ogrvnlc
(jameinel) fixed link to main smart server doc from http smart server doc
 (dmuir)

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)
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,
67
62
    revisiontree,
68
63
    trace,
69
64
    transform,
 
65
    transport,
70
66
    ui,
71
67
    views,
72
68
    xml5,
73
69
    xml7,
74
70
    )
75
 
import bzrlib.branch
76
 
from bzrlib.transport import get_transport
77
71
from bzrlib.workingtree_4 import (
78
72
    WorkingTreeFormat4,
79
73
    WorkingTreeFormat5,
83
77
 
84
78
from bzrlib import symbol_versioning
85
79
from bzrlib.decorators import needs_read_lock, needs_write_lock
 
80
from bzrlib.lock import LogicalLockResult
86
81
from bzrlib.lockable_files import LockableFiles
87
82
from bzrlib.lockdir import LockDir
88
83
import bzrlib.mutabletree
101
96
from bzrlib.filters import filtered_input_file
102
97
from bzrlib.trace import mutter, note
103
98
from bzrlib.transport.local import LocalTransport
104
 
from bzrlib.progress import ProgressPhase
105
99
from bzrlib.revision import CURRENT_REVISION
106
100
from bzrlib.rio import RioReader, rio_file, Stanza
107
101
from bzrlib.symbol_versioning import (
174
168
        return ''
175
169
 
176
170
 
177
 
class WorkingTree(bzrlib.mutabletree.MutableTree):
 
171
class WorkingTree(bzrlib.mutabletree.MutableTree,
 
172
    controldir.ControlComponent):
178
173
    """Working copy tree.
179
174
 
180
175
    The inventory is held in the `Branch` working-inventory, and the
182
177
 
183
178
    It is possible for a `WorkingTree` to have a filename which is
184
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).
185
183
    """
186
184
 
187
185
    # override this to set the strategy for storing views
253
251
        self._rules_searcher = None
254
252
        self.views = self._make_views()
255
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
 
256
262
    def _detect_case_handling(self):
257
263
        wt_trans = self.bzrdir.get_workingtree_transport(None)
258
264
        try:
344
350
        if path is None:
345
351
            path = osutils.getcwd()
346
352
        control, relpath = bzrdir.BzrDir.open_containing(path)
347
 
 
348
353
        return control.open_workingtree(), relpath
349
354
 
350
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
351
414
    def open_downlevel(path=None):
352
415
        """Open an unsupported working tree.
353
416
 
366
429
                return True, None
367
430
            else:
368
431
                return True, tree
369
 
        transport = get_transport(location)
370
 
        iterator = bzrdir.BzrDir.find_bzrdirs(transport, evaluate=evaluate,
 
432
        t = transport.get_transport(location)
 
433
        iterator = bzrdir.BzrDir.find_bzrdirs(t, evaluate=evaluate,
371
434
                                              list_current=list_current)
372
 
        return [t for t in iterator if t is not None]
 
435
        return [tr for tr in iterator if tr is not None]
373
436
 
374
437
    # should be deprecated - this is slow and in any case treating them as a
375
438
    # container is (we now know) bad style -- mbp 20070302
460
523
        return (file_obj, stat_value)
461
524
 
462
525
    def get_file_text(self, file_id, path=None, filtered=True):
463
 
        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()
464
531
 
465
532
    def get_file_byname(self, filename, filtered=True):
466
533
        path = self.abspath(filename)
520
587
 
521
588
        # Now we have the parents of this content
522
589
        annotator = self.branch.repository.texts.get_annotator()
523
 
        text = self.get_file(file_id).read()
 
590
        text = self.get_file_text(file_id)
524
591
        this_key =(file_id, default_revision)
525
592
        annotator.add_special_text(this_key, file_parent_keys, text)
526
593
        annotations = [(key[-1], line)
1200
1267
                # absolute path
1201
1268
                fap = from_dir_abspath + '/' + f
1202
1269
 
1203
 
                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
1204
1275
                if f_ie:
1205
1276
                    c = 'V'
1206
1277
                elif self.is_ignored(fp[1:]):
1207
1278
                    c = 'I'
1208
1279
                else:
1209
 
                    # 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.
1210
1282
                    f_norm, can_access = osutils.normalized_filename(f)
1211
1283
                    if f == f_norm or not can_access:
1212
1284
                        # No change, so treat this file normally
1255
1327
                stack.pop()
1256
1328
 
1257
1329
    @needs_tree_write_lock
1258
 
    def move(self, from_paths, to_dir=None, after=False, **kwargs):
 
1330
    def move(self, from_paths, to_dir=None, after=False):
1259
1331
        """Rename files.
1260
1332
 
1261
1333
        to_dir must exist in the inventory.
1295
1367
 
1296
1368
        # check for deprecated use of signature
1297
1369
        if to_dir is None:
1298
 
            to_dir = kwargs.get('to_name', None)
1299
 
            if to_dir is None:
1300
 
                raise TypeError('You must supply a target directory')
1301
 
            else:
1302
 
                symbol_versioning.warn('The parameter to_name was deprecated'
1303
 
                                       ' in version 0.13. Use to_dir instead',
1304
 
                                       DeprecationWarning)
1305
 
 
 
1370
            raise TypeError('You must supply a target directory')
1306
1371
        # check destination directory
1307
1372
        if isinstance(from_paths, basestring):
1308
1373
            raise ValueError()
1598
1663
 
1599
1664
    @needs_write_lock
1600
1665
    def pull(self, source, overwrite=False, stop_revision=None,
1601
 
             change_reporter=None, possible_transports=None, local=False):
 
1666
             change_reporter=None, possible_transports=None, local=False,
 
1667
             show_base=False):
1602
1668
        source.lock_read()
1603
1669
        try:
1604
1670
            old_revision_info = self.branch.last_revision_info()
1618
1684
                                basis_tree,
1619
1685
                                this_tree=self,
1620
1686
                                pb=None,
1621
 
                                change_reporter=change_reporter)
 
1687
                                change_reporter=change_reporter,
 
1688
                                show_base=show_base)
1622
1689
                    basis_root_id = basis_tree.get_root_id()
1623
1690
                    new_root_id = new_basis_tree.get_root_id()
1624
1691
                    if basis_root_id != new_root_id:
1796
1863
            raise errors.ObjectNotLocked(self)
1797
1864
 
1798
1865
    def lock_read(self):
1799
 
        """See Branch.lock_read, and WorkingTree.unlock."""
 
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
        """
1800
1872
        if not self.is_locked():
1801
1873
            self._reset_data()
1802
1874
        self.branch.lock_read()
1803
1875
        try:
1804
 
            return self._control_files.lock_read()
 
1876
            self._control_files.lock_read()
 
1877
            return LogicalLockResult(self.unlock)
1805
1878
        except:
1806
1879
            self.branch.unlock()
1807
1880
            raise
1808
1881
 
1809
1882
    def lock_tree_write(self):
1810
 
        """See MutableTree.lock_tree_write, and WorkingTree.unlock."""
 
1883
        """See MutableTree.lock_tree_write, and WorkingTree.unlock.
 
1884
 
 
1885
        :return: A bzrlib.lock.LogicalLockResult.
 
1886
        """
1811
1887
        if not self.is_locked():
1812
1888
            self._reset_data()
1813
1889
        self.branch.lock_read()
1814
1890
        try:
1815
 
            return self._control_files.lock_write()
 
1891
            self._control_files.lock_write()
 
1892
            return LogicalLockResult(self.unlock)
1816
1893
        except:
1817
1894
            self.branch.unlock()
1818
1895
            raise
1819
1896
 
1820
1897
    def lock_write(self):
1821
 
        """See MutableTree.lock_write, and WorkingTree.unlock."""
 
1898
        """See MutableTree.lock_write, and WorkingTree.unlock.
 
1899
 
 
1900
        :return: A bzrlib.lock.LogicalLockResult.
 
1901
        """
1822
1902
        if not self.is_locked():
1823
1903
            self._reset_data()
1824
1904
        self.branch.lock_write()
1825
1905
        try:
1826
 
            return self._control_files.lock_write()
 
1906
            self._control_files.lock_write()
 
1907
            return LogicalLockResult(self.unlock)
1827
1908
        except:
1828
1909
            self.branch.unlock()
1829
1910
            raise
1946
2027
 
1947
2028
        inv_delta = []
1948
2029
 
1949
 
        new_files=set()
 
2030
        all_files = set() # specified and nested files 
1950
2031
        unknown_nested_files=set()
1951
2032
        if to_file is None:
1952
2033
            to_file = sys.stdout
1953
2034
 
 
2035
        files_to_backup = []
 
2036
 
1954
2037
        def recurse_directory_to_add_files(directory):
1955
2038
            # Recurse directory and add all files
1956
2039
            # so we can check if they have changed.
1957
 
            for parent_info, file_infos in\
1958
 
                self.walkdirs(directory):
 
2040
            for parent_info, file_infos in self.walkdirs(directory):
1959
2041
                for relpath, basename, kind, lstat, fileid, kind in file_infos:
1960
2042
                    # Is it versioned or ignored?
1961
 
                    if self.path2id(relpath) or self.is_ignored(relpath):
 
2043
                    if self.path2id(relpath):
1962
2044
                        # Add nested content for deletion.
1963
 
                        new_files.add(relpath)
 
2045
                        all_files.add(relpath)
1964
2046
                    else:
1965
 
                        # Files which are not versioned and not ignored
 
2047
                        # Files which are not versioned
1966
2048
                        # should be treated as unknown.
1967
 
                        unknown_nested_files.add((relpath, None, kind))
 
2049
                        files_to_backup.append(relpath)
1968
2050
 
1969
2051
        for filename in files:
1970
2052
            # Get file name into canonical form.
1971
2053
            abspath = self.abspath(filename)
1972
2054
            filename = self.relpath(abspath)
1973
2055
            if len(filename) > 0:
1974
 
                new_files.add(filename)
 
2056
                all_files.add(filename)
1975
2057
                recurse_directory_to_add_files(filename)
1976
2058
 
1977
 
        files = list(new_files)
 
2059
        files = list(all_files)
1978
2060
 
1979
2061
        if len(files) == 0:
1980
2062
            return # nothing to do
1984
2066
 
1985
2067
        # Bail out if we are going to delete files we shouldn't
1986
2068
        if not keep_files and not force:
1987
 
            has_changed_files = len(unknown_nested_files) > 0
1988
 
            if not has_changed_files:
1989
 
                for (file_id, path, content_change, versioned, parent_id, name,
1990
 
                     kind, executable) in self.iter_changes(self.basis_tree(),
1991
 
                         include_unchanged=True, require_versioned=False,
1992
 
                         want_unversioned=True, specific_files=files):
1993
 
                    if versioned == (False, False):
1994
 
                        # The record is unknown ...
1995
 
                        if not self.is_ignored(path[1]):
1996
 
                            # ... but not ignored
1997
 
                            has_changed_files = True
1998
 
                            break
1999
 
                    elif content_change and (kind[1] is not None):
2000
 
                        # Versioned and changed, but not deleted
2001
 
                        has_changed_files = True
2002
 
                        break
 
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])
2003
2081
 
2004
 
            if has_changed_files:
2005
 
                # Make delta show ALL applicable changes in error message.
2006
 
                tree_delta = self.changes_from(self.basis_tree(),
2007
 
                    require_versioned=False, want_unversioned=True,
2008
 
                    specific_files=files)
2009
 
                for unknown_file in unknown_nested_files:
2010
 
                    if unknown_file not in tree_delta.unversioned:
2011
 
                        tree_delta.unversioned.extend((unknown_file,))
2012
 
                raise errors.BzrRemoveChangedFilesError(tree_delta)
 
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)
2013
2086
 
2014
2087
        # Build inv_delta and delete files where applicable,
2015
2088
        # do this before any modifications to inventory.
2039
2112
                        len(os.listdir(abs_path)) > 0):
2040
2113
                        if force:
2041
2114
                            osutils.rmtree(abs_path)
 
2115
                            message = "deleted %s" % (f,)
2042
2116
                        else:
2043
 
                            message = "%s is not an empty directory "\
2044
 
                                "and won't be deleted." % (f,)
 
2117
                            message = backup(f)
2045
2118
                    else:
2046
 
                        osutils.delete_any(abs_path)
2047
 
                        message = "deleted %s" % (f,)
 
2119
                        if f in files_to_backup:
 
2120
                            message = backup(f)
 
2121
                        else:
 
2122
                            osutils.delete_any(abs_path)
 
2123
                            message = "deleted %s" % (f,)
2048
2124
                elif message is not None:
2049
2125
                    # Only care if we haven't done anything yet.
2050
2126
                    message = "%s does not exist." % (f,)
2187
2263
    _marker = object()
2188
2264
 
2189
2265
    def update(self, change_reporter=None, possible_transports=None,
2190
 
               revision=None, old_tip=_marker):
 
2266
               revision=None, old_tip=_marker, show_base=False):
2191
2267
        """Update a working tree along its branch.
2192
2268
 
2193
2269
        This will update the branch if its bound too, which means we have
2230
2306
            else:
2231
2307
                if old_tip is self._marker:
2232
2308
                    old_tip = None
2233
 
            return self._update_tree(old_tip, change_reporter, revision)
 
2309
            return self._update_tree(old_tip, change_reporter, revision, show_base)
2234
2310
        finally:
2235
2311
            self.unlock()
2236
2312
 
2237
2313
    @needs_tree_write_lock
2238
 
    def _update_tree(self, old_tip=None, change_reporter=None, revision=None):
 
2314
    def _update_tree(self, old_tip=None, change_reporter=None, revision=None,
 
2315
                     show_base=False):
2239
2316
        """Update a tree to the master branch.
2240
2317
 
2241
2318
        :param old_tip: if supplied, the previous tip revision the branch,
2258
2335
            last_rev = _mod_revision.NULL_REVISION
2259
2336
        if revision is None:
2260
2337
            revision = self.branch.last_revision()
2261
 
        else:
2262
 
            if revision not in self.branch.revision_history():
2263
 
                raise errors.NoSuchRevision(self.branch, revision)
2264
2338
 
2265
2339
        old_tip = old_tip or _mod_revision.NULL_REVISION
2266
2340
 
2271
2345
            other_tree = self.branch.repository.revision_tree(old_tip)
2272
2346
            nb_conflicts = merge.merge_inner(self.branch, other_tree,
2273
2347
                                             base_tree, this_tree=self,
2274
 
                                             change_reporter=change_reporter)
 
2348
                                             change_reporter=change_reporter,
 
2349
                                             show_base=show_base)
2275
2350
            if nb_conflicts:
2276
2351
                self.add_parent_tree((old_tip, other_tree))
2277
2352
                trace.note('Rerun update after fixing the conflicts.')
2301
2376
 
2302
2377
            nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
2303
2378
                                             this_tree=self,
2304
 
                                             change_reporter=change_reporter)
 
2379
                                             change_reporter=change_reporter,
 
2380
                                             show_base=show_base)
2305
2381
            self.set_last_revision(revision)
2306
2382
            # TODO - dedup parents list with things merged by pull ?
2307
2383
            # reuse the tree we've updated to to set the basis:
2637
2713
 
2638
2714
        In Format2 WorkingTrees we have a single lock for the branch and tree
2639
2715
        so lock_tree_write() degrades to lock_write().
 
2716
 
 
2717
        :return: An object with an unlock method which will release the lock
 
2718
            obtained.
2640
2719
        """
2641
2720
        self.branch.lock_write()
2642
2721
        try:
2643
 
            return self._control_files.lock_write()
 
2722
            self._control_files.lock_write()
 
2723
            return self
2644
2724
        except:
2645
2725
            self.branch.unlock()
2646
2726
            raise