~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Vincent Ladeuil
  • Date: 2010-12-02 15:48:12 UTC
  • mto: This revision was merged to the branch mainline in revision 5556.
  • Revision ID: v.ladeuil+lp@free.fr-20101202154812-fxuav78fk7u24vh6
Tags: bzr-2.3b4
ReleaseĀ 2.3b4

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=None,
 
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
        if default_directory is None:
 
366
            default_directory = u'.'
 
367
        # recommended replacement for builtins.internal_tree_files
 
368
        if file_list is None or len(file_list) == 0:
 
369
            tree = WorkingTree.open_containing(default_directory)[0]
 
370
            # XXX: doesn't really belong here, and seems to have the strange
 
371
            # side effect of making it return a bunch of files, not the whole
 
372
            # tree -- mbp 20100716
 
373
            if tree.supports_views() and apply_view:
 
374
                view_files = tree.views.lookup_view()
 
375
                if view_files:
 
376
                    file_list = view_files
 
377
                    view_str = views.view_display_str(view_files)
 
378
                    note("Ignoring files outside view. View is %s" % view_str)
 
379
            return tree, file_list
 
380
        if default_directory == u'.':
 
381
            seed = file_list[0]
 
382
        else:
 
383
            seed = default_directory
 
384
            file_list = [osutils.pathjoin(default_directory, f)
 
385
                         for f in file_list]
 
386
        tree = WorkingTree.open_containing(seed)[0]
 
387
        return tree, tree.safe_relpath_files(file_list, canonicalize,
 
388
                                             apply_view=apply_view)
 
389
 
 
390
    def safe_relpath_files(self, file_list, canonicalize=True, apply_view=True):
 
391
        """Convert file_list into a list of relpaths in tree.
 
392
 
 
393
        :param self: A tree to operate on.
 
394
        :param file_list: A list of user provided paths or None.
 
395
        :param apply_view: if True and a view is set, apply it or check that
 
396
            specified files are within it
 
397
        :return: A list of relative paths.
 
398
        :raises errors.PathNotChild: When a provided path is in a different self
 
399
            than self.
 
400
        """
 
401
        if file_list is None:
 
402
            return None
 
403
        if self.supports_views() and apply_view:
 
404
            view_files = self.views.lookup_view()
 
405
        else:
 
406
            view_files = []
 
407
        new_list = []
 
408
        # self.relpath exists as a "thunk" to osutils, but canonical_relpath
 
409
        # doesn't - fix that up here before we enter the loop.
 
410
        if canonicalize:
 
411
            fixer = lambda p: osutils.canonical_relpath(self.basedir, p)
 
412
        else:
 
413
            fixer = self.relpath
 
414
        for filename in file_list:
 
415
            relpath = fixer(osutils.dereference_path(filename))
 
416
            if view_files and not osutils.is_inside_any(view_files, relpath):
 
417
                raise errors.FileOutsideView(filename, view_files)
 
418
            new_list.append(relpath)
 
419
        return new_list
 
420
 
 
421
    @staticmethod
351
422
    def open_downlevel(path=None):
352
423
        """Open an unsupported working tree.
353
424
 
366
437
                return True, None
367
438
            else:
368
439
                return True, tree
369
 
        transport = get_transport(location)
370
 
        iterator = bzrdir.BzrDir.find_bzrdirs(transport, evaluate=evaluate,
 
440
        t = transport.get_transport(location)
 
441
        iterator = bzrdir.BzrDir.find_bzrdirs(t, evaluate=evaluate,
371
442
                                              list_current=list_current)
372
 
        return [t for t in iterator if t is not None]
 
443
        return [tr for tr in iterator if tr is not None]
373
444
 
374
445
    # should be deprecated - this is slow and in any case treating them as a
375
446
    # container is (we now know) bad style -- mbp 20070302
460
531
        return (file_obj, stat_value)
461
532
 
462
533
    def get_file_text(self, file_id, path=None, filtered=True):
463
 
        return self.get_file(file_id, path=path, filtered=filtered).read()
 
534
        my_file = self.get_file(file_id, path=path, filtered=filtered)
 
535
        try:
 
536
            return my_file.read()
 
537
        finally:
 
538
            my_file.close()
464
539
 
465
540
    def get_file_byname(self, filename, filtered=True):
466
541
        path = self.abspath(filename)
520
595
 
521
596
        # Now we have the parents of this content
522
597
        annotator = self.branch.repository.texts.get_annotator()
523
 
        text = self.get_file(file_id).read()
 
598
        text = self.get_file_text(file_id)
524
599
        this_key =(file_id, default_revision)
525
600
        annotator.add_special_text(this_key, file_parent_keys, text)
526
601
        annotations = [(key[-1], line)
1139
1214
        This does not include files that have been deleted in this
1140
1215
        tree. Skips the control directory.
1141
1216
 
1142
 
        :param include_root: if True, do not return an entry for the root
 
1217
        :param include_root: if True, return an entry for the root
1143
1218
        :param from_dir: start from this directory or None for the root
1144
1219
        :param recursive: whether to recurse into subdirectories or not
1145
1220
        """
1200
1275
                # absolute path
1201
1276
                fap = from_dir_abspath + '/' + f
1202
1277
 
1203
 
                f_ie = inv.get_child(from_dir_id, f)
 
1278
                dir_ie = inv[from_dir_id]
 
1279
                if dir_ie.kind == 'directory':
 
1280
                    f_ie = dir_ie.children.get(f)
 
1281
                else:
 
1282
                    f_ie = None
1204
1283
                if f_ie:
1205
1284
                    c = 'V'
1206
1285
                elif self.is_ignored(fp[1:]):
1207
1286
                    c = 'I'
1208
1287
                else:
1209
 
                    # we may not have found this file, because of a unicode issue
 
1288
                    # we may not have found this file, because of a unicode
 
1289
                    # issue, or because the directory was actually a symlink.
1210
1290
                    f_norm, can_access = osutils.normalized_filename(f)
1211
1291
                    if f == f_norm or not can_access:
1212
1292
                        # No change, so treat this file normally
1255
1335
                stack.pop()
1256
1336
 
1257
1337
    @needs_tree_write_lock
1258
 
    def move(self, from_paths, to_dir=None, after=False, **kwargs):
 
1338
    def move(self, from_paths, to_dir=None, after=False):
1259
1339
        """Rename files.
1260
1340
 
1261
1341
        to_dir must exist in the inventory.
1295
1375
 
1296
1376
        # check for deprecated use of signature
1297
1377
        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
 
 
 
1378
            raise TypeError('You must supply a target directory')
1306
1379
        # check destination directory
1307
1380
        if isinstance(from_paths, basestring):
1308
1381
            raise ValueError()
1598
1671
 
1599
1672
    @needs_write_lock
1600
1673
    def pull(self, source, overwrite=False, stop_revision=None,
1601
 
             change_reporter=None, possible_transports=None, local=False):
 
1674
             change_reporter=None, possible_transports=None, local=False,
 
1675
             show_base=False):
1602
1676
        source.lock_read()
1603
1677
        try:
1604
1678
            old_revision_info = self.branch.last_revision_info()
1618
1692
                                basis_tree,
1619
1693
                                this_tree=self,
1620
1694
                                pb=None,
1621
 
                                change_reporter=change_reporter)
 
1695
                                change_reporter=change_reporter,
 
1696
                                show_base=show_base)
1622
1697
                    basis_root_id = basis_tree.get_root_id()
1623
1698
                    new_root_id = new_basis_tree.get_root_id()
1624
1699
                    if basis_root_id != new_root_id:
1796
1871
            raise errors.ObjectNotLocked(self)
1797
1872
 
1798
1873
    def lock_read(self):
1799
 
        """See Branch.lock_read, and WorkingTree.unlock."""
 
1874
        """Lock the tree for reading.
 
1875
 
 
1876
        This also locks the branch, and can be unlocked via self.unlock().
 
1877
 
 
1878
        :return: A bzrlib.lock.LogicalLockResult.
 
1879
        """
1800
1880
        if not self.is_locked():
1801
1881
            self._reset_data()
1802
1882
        self.branch.lock_read()
1803
1883
        try:
1804
 
            return self._control_files.lock_read()
 
1884
            self._control_files.lock_read()
 
1885
            return LogicalLockResult(self.unlock)
1805
1886
        except:
1806
1887
            self.branch.unlock()
1807
1888
            raise
1808
1889
 
1809
1890
    def lock_tree_write(self):
1810
 
        """See MutableTree.lock_tree_write, and WorkingTree.unlock."""
 
1891
        """See MutableTree.lock_tree_write, and WorkingTree.unlock.
 
1892
 
 
1893
        :return: A bzrlib.lock.LogicalLockResult.
 
1894
        """
1811
1895
        if not self.is_locked():
1812
1896
            self._reset_data()
1813
1897
        self.branch.lock_read()
1814
1898
        try:
1815
 
            return self._control_files.lock_write()
 
1899
            self._control_files.lock_write()
 
1900
            return LogicalLockResult(self.unlock)
1816
1901
        except:
1817
1902
            self.branch.unlock()
1818
1903
            raise
1819
1904
 
1820
1905
    def lock_write(self):
1821
 
        """See MutableTree.lock_write, and WorkingTree.unlock."""
 
1906
        """See MutableTree.lock_write, and WorkingTree.unlock.
 
1907
 
 
1908
        :return: A bzrlib.lock.LogicalLockResult.
 
1909
        """
1822
1910
        if not self.is_locked():
1823
1911
            self._reset_data()
1824
1912
        self.branch.lock_write()
1825
1913
        try:
1826
 
            return self._control_files.lock_write()
 
1914
            self._control_files.lock_write()
 
1915
            return LogicalLockResult(self.unlock)
1827
1916
        except:
1828
1917
            self.branch.unlock()
1829
1918
            raise
1946
2035
 
1947
2036
        inv_delta = []
1948
2037
 
1949
 
        new_files=set()
 
2038
        all_files = set() # specified and nested files 
1950
2039
        unknown_nested_files=set()
1951
2040
        if to_file is None:
1952
2041
            to_file = sys.stdout
1953
2042
 
 
2043
        files_to_backup = []
 
2044
 
1954
2045
        def recurse_directory_to_add_files(directory):
1955
2046
            # Recurse directory and add all files
1956
2047
            # so we can check if they have changed.
1957
 
            for parent_info, file_infos in\
1958
 
                self.walkdirs(directory):
 
2048
            for parent_info, file_infos in self.walkdirs(directory):
1959
2049
                for relpath, basename, kind, lstat, fileid, kind in file_infos:
1960
2050
                    # Is it versioned or ignored?
1961
 
                    if self.path2id(relpath) or self.is_ignored(relpath):
 
2051
                    if self.path2id(relpath):
1962
2052
                        # Add nested content for deletion.
1963
 
                        new_files.add(relpath)
 
2053
                        all_files.add(relpath)
1964
2054
                    else:
1965
 
                        # Files which are not versioned and not ignored
 
2055
                        # Files which are not versioned
1966
2056
                        # should be treated as unknown.
1967
 
                        unknown_nested_files.add((relpath, None, kind))
 
2057
                        files_to_backup.append(relpath)
1968
2058
 
1969
2059
        for filename in files:
1970
2060
            # Get file name into canonical form.
1971
2061
            abspath = self.abspath(filename)
1972
2062
            filename = self.relpath(abspath)
1973
2063
            if len(filename) > 0:
1974
 
                new_files.add(filename)
 
2064
                all_files.add(filename)
1975
2065
                recurse_directory_to_add_files(filename)
1976
2066
 
1977
 
        files = list(new_files)
 
2067
        files = list(all_files)
1978
2068
 
1979
2069
        if len(files) == 0:
1980
2070
            return # nothing to do
1984
2074
 
1985
2075
        # Bail out if we are going to delete files we shouldn't
1986
2076
        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
 
2077
            for (file_id, path, content_change, versioned, parent_id, name,
 
2078
                 kind, executable) in self.iter_changes(self.basis_tree(),
 
2079
                     include_unchanged=True, require_versioned=False,
 
2080
                     want_unversioned=True, specific_files=files):
 
2081
                if versioned[0] == False:
 
2082
                    # The record is unknown or newly added
 
2083
                    files_to_backup.append(path[1])
 
2084
                elif (content_change and (kind[1] is not None) and
 
2085
                        osutils.is_inside_any(files, path[1])):
 
2086
                    # Versioned and changed, but not deleted, and still
 
2087
                    # in one of the dirs to be deleted.
 
2088
                    files_to_backup.append(path[1])
2003
2089
 
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)
 
2090
        def backup(file_to_backup):
 
2091
            backup_name = self.bzrdir._available_backup_name(file_to_backup)
 
2092
            osutils.rename(abs_path, self.abspath(backup_name))
 
2093
            return "removed %s (but kept a copy: %s)" % (file_to_backup,
 
2094
                                                         backup_name)
2013
2095
 
2014
2096
        # Build inv_delta and delete files where applicable,
2015
2097
        # do this before any modifications to inventory.
2039
2121
                        len(os.listdir(abs_path)) > 0):
2040
2122
                        if force:
2041
2123
                            osutils.rmtree(abs_path)
 
2124
                            message = "deleted %s" % (f,)
2042
2125
                        else:
2043
 
                            message = "%s is not an empty directory "\
2044
 
                                "and won't be deleted." % (f,)
 
2126
                            message = backup(f)
2045
2127
                    else:
2046
 
                        osutils.delete_any(abs_path)
2047
 
                        message = "deleted %s" % (f,)
 
2128
                        if f in files_to_backup:
 
2129
                            message = backup(f)
 
2130
                        else:
 
2131
                            osutils.delete_any(abs_path)
 
2132
                            message = "deleted %s" % (f,)
2048
2133
                elif message is not None:
2049
2134
                    # Only care if we haven't done anything yet.
2050
2135
                    message = "%s does not exist." % (f,)
2187
2272
    _marker = object()
2188
2273
 
2189
2274
    def update(self, change_reporter=None, possible_transports=None,
2190
 
               revision=None, old_tip=_marker):
 
2275
               revision=None, old_tip=_marker, show_base=False):
2191
2276
        """Update a working tree along its branch.
2192
2277
 
2193
2278
        This will update the branch if its bound too, which means we have
2230
2315
            else:
2231
2316
                if old_tip is self._marker:
2232
2317
                    old_tip = None
2233
 
            return self._update_tree(old_tip, change_reporter, revision)
 
2318
            return self._update_tree(old_tip, change_reporter, revision, show_base)
2234
2319
        finally:
2235
2320
            self.unlock()
2236
2321
 
2237
2322
    @needs_tree_write_lock
2238
 
    def _update_tree(self, old_tip=None, change_reporter=None, revision=None):
 
2323
    def _update_tree(self, old_tip=None, change_reporter=None, revision=None,
 
2324
                     show_base=False):
2239
2325
        """Update a tree to the master branch.
2240
2326
 
2241
2327
        :param old_tip: if supplied, the previous tip revision the branch,
2258
2344
            last_rev = _mod_revision.NULL_REVISION
2259
2345
        if revision is None:
2260
2346
            revision = self.branch.last_revision()
2261
 
        else:
2262
 
            if revision not in self.branch.revision_history():
2263
 
                raise errors.NoSuchRevision(self.branch, revision)
2264
2347
 
2265
2348
        old_tip = old_tip or _mod_revision.NULL_REVISION
2266
2349
 
2271
2354
            other_tree = self.branch.repository.revision_tree(old_tip)
2272
2355
            nb_conflicts = merge.merge_inner(self.branch, other_tree,
2273
2356
                                             base_tree, this_tree=self,
2274
 
                                             change_reporter=change_reporter)
 
2357
                                             change_reporter=change_reporter,
 
2358
                                             show_base=show_base)
2275
2359
            if nb_conflicts:
2276
2360
                self.add_parent_tree((old_tip, other_tree))
2277
2361
                trace.note('Rerun update after fixing the conflicts.')
2301
2385
 
2302
2386
            nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
2303
2387
                                             this_tree=self,
2304
 
                                             change_reporter=change_reporter)
 
2388
                                             change_reporter=change_reporter,
 
2389
                                             show_base=show_base)
2305
2390
            self.set_last_revision(revision)
2306
2391
            # TODO - dedup parents list with things merged by pull ?
2307
2392
            # reuse the tree we've updated to to set the basis:
2637
2722
 
2638
2723
        In Format2 WorkingTrees we have a single lock for the branch and tree
2639
2724
        so lock_tree_write() degrades to lock_write().
 
2725
 
 
2726
        :return: An object with an unlock method which will release the lock
 
2727
            obtained.
2640
2728
        """
2641
2729
        self.branch.lock_write()
2642
2730
        try:
2643
 
            return self._control_files.lock_write()
 
2731
            self._control_files.lock_write()
 
2732
            return self
2644
2733
        except:
2645
2734
            self.branch.unlock()
2646
2735
            raise