/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

merge bzr.dev.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005-2011 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
49
49
    branch,
50
50
    bzrdir,
51
51
    conflicts as _mod_conflicts,
 
52
    controldir,
52
53
    errors,
53
54
    generate_ids,
54
55
    globbing,
57
58
    ignores,
58
59
    inventory,
59
60
    merge,
 
61
    registry,
60
62
    revision as _mod_revision,
61
63
    revisiontree,
62
64
    trace,
63
65
    transform,
 
66
    transport,
64
67
    ui,
65
68
    views,
66
69
    xml5,
67
70
    xml7,
68
71
    )
69
 
import bzrlib.branch
70
 
from bzrlib.transport import get_transport
71
72
from bzrlib.workingtree_4 import (
72
 
    WorkingTreeFormat4,
73
 
    WorkingTreeFormat5,
74
73
    WorkingTreeFormat6,
75
74
    )
76
75
""")
77
76
 
78
77
from bzrlib import symbol_versioning
79
78
from bzrlib.decorators import needs_read_lock, needs_write_lock
 
79
from bzrlib.lock import LogicalLockResult
80
80
from bzrlib.lockable_files import LockableFiles
81
81
from bzrlib.lockdir import LockDir
82
82
import bzrlib.mutabletree
168
168
 
169
169
 
170
170
class WorkingTree(bzrlib.mutabletree.MutableTree,
171
 
    bzrdir.ControlComponent):
 
171
    controldir.ControlComponent):
172
172
    """Working copy tree.
173
173
 
174
174
    The inventory is held in the `Branch` working-inventory, and the
176
176
 
177
177
    It is possible for a `WorkingTree` to have a filename which is
178
178
    not listed in the Inventory and vice versa.
 
179
 
 
180
    :ivar basedir: The root of the tree on disk. This is a unicode path object
 
181
        (as opposed to a URL).
179
182
    """
180
183
 
181
184
    # override this to set the strategy for storing views
205
208
        else:
206
209
            self._branch = self.bzrdir.open_branch()
207
210
        self.basedir = realpath(basedir)
208
 
        # if branch is at our basedir and is a format 6 or less
209
 
        if isinstance(self._format, WorkingTreeFormat2):
210
 
            # share control object
211
 
            self._control_files = self.branch.control_files
212
 
        else:
213
 
            # assume all other formats have their own control files.
214
 
            self._control_files = _control_files
 
211
        self._control_files = _control_files
215
212
        self._transport = self._control_files._transport
216
213
        # update the whole cache up front and write to disk if anything changed;
217
214
        # in the future we might want to do this more selectively
258
255
    def _detect_case_handling(self):
259
256
        wt_trans = self.bzrdir.get_workingtree_transport(None)
260
257
        try:
261
 
            wt_trans.stat("FoRMaT")
 
258
            wt_trans.stat(self._format.case_sensitive_filename)
262
259
        except errors.NoSuchFile:
263
260
            self.case_sensitive = True
264
261
        else:
346
343
        if path is None:
347
344
            path = osutils.getcwd()
348
345
        control, relpath = bzrdir.BzrDir.open_containing(path)
349
 
 
350
346
        return control.open_workingtree(), relpath
351
347
 
352
348
    @staticmethod
 
349
    def open_containing_paths(file_list, default_directory=None,
 
350
                              canonicalize=True, apply_view=True):
 
351
        """Open the WorkingTree that contains a set of paths.
 
352
 
 
353
        Fail if the paths given are not all in a single tree.
 
354
 
 
355
        This is used for the many command-line interfaces that take a list of
 
356
        any number of files and that require they all be in the same tree.
 
357
        """
 
358
        if default_directory is None:
 
359
            default_directory = u'.'
 
360
        # recommended replacement for builtins.internal_tree_files
 
361
        if file_list is None or len(file_list) == 0:
 
362
            tree = WorkingTree.open_containing(default_directory)[0]
 
363
            # XXX: doesn't really belong here, and seems to have the strange
 
364
            # side effect of making it return a bunch of files, not the whole
 
365
            # tree -- mbp 20100716
 
366
            if tree.supports_views() and apply_view:
 
367
                view_files = tree.views.lookup_view()
 
368
                if view_files:
 
369
                    file_list = view_files
 
370
                    view_str = views.view_display_str(view_files)
 
371
                    note("Ignoring files outside view. View is %s" % view_str)
 
372
            return tree, file_list
 
373
        if default_directory == u'.':
 
374
            seed = file_list[0]
 
375
        else:
 
376
            seed = default_directory
 
377
            file_list = [osutils.pathjoin(default_directory, f)
 
378
                         for f in file_list]
 
379
        tree = WorkingTree.open_containing(seed)[0]
 
380
        return tree, tree.safe_relpath_files(file_list, canonicalize,
 
381
                                             apply_view=apply_view)
 
382
 
 
383
    def safe_relpath_files(self, file_list, canonicalize=True, apply_view=True):
 
384
        """Convert file_list into a list of relpaths in tree.
 
385
 
 
386
        :param self: A tree to operate on.
 
387
        :param file_list: A list of user provided paths or None.
 
388
        :param apply_view: if True and a view is set, apply it or check that
 
389
            specified files are within it
 
390
        :return: A list of relative paths.
 
391
        :raises errors.PathNotChild: When a provided path is in a different self
 
392
            than self.
 
393
        """
 
394
        if file_list is None:
 
395
            return None
 
396
        if self.supports_views() and apply_view:
 
397
            view_files = self.views.lookup_view()
 
398
        else:
 
399
            view_files = []
 
400
        new_list = []
 
401
        # self.relpath exists as a "thunk" to osutils, but canonical_relpath
 
402
        # doesn't - fix that up here before we enter the loop.
 
403
        if canonicalize:
 
404
            fixer = lambda p: osutils.canonical_relpath(self.basedir, p)
 
405
        else:
 
406
            fixer = self.relpath
 
407
        for filename in file_list:
 
408
            relpath = fixer(osutils.dereference_path(filename))
 
409
            if view_files and not osutils.is_inside_any(view_files, relpath):
 
410
                raise errors.FileOutsideView(filename, view_files)
 
411
            new_list.append(relpath)
 
412
        return new_list
 
413
 
 
414
    @staticmethod
353
415
    def open_downlevel(path=None):
354
416
        """Open an unsupported working tree.
355
417
 
368
430
                return True, None
369
431
            else:
370
432
                return True, tree
371
 
        transport = get_transport(location)
372
 
        iterator = bzrdir.BzrDir.find_bzrdirs(transport, evaluate=evaluate,
 
433
        t = transport.get_transport(location)
 
434
        iterator = bzrdir.BzrDir.find_bzrdirs(t, evaluate=evaluate,
373
435
                                              list_current=list_current)
374
 
        return [t for t in iterator if t is not None]
 
436
        return [tr for tr in iterator if tr is not None]
375
437
 
376
438
    # should be deprecated - this is slow and in any case treating them as a
377
439
    # container is (we now know) bad style -- mbp 20070302
462
524
        return (file_obj, stat_value)
463
525
 
464
526
    def get_file_text(self, file_id, path=None, filtered=True):
465
 
        return self.get_file(file_id, path=path, filtered=filtered).read()
 
527
        my_file = self.get_file(file_id, path=path, filtered=filtered)
 
528
        try:
 
529
            return my_file.read()
 
530
        finally:
 
531
            my_file.close()
466
532
 
467
533
    def get_file_byname(self, filename, filtered=True):
468
534
        path = self.abspath(filename)
522
588
 
523
589
        # Now we have the parents of this content
524
590
        annotator = self.branch.repository.texts.get_annotator()
525
 
        text = self.get_file(file_id).read()
 
591
        text = self.get_file_text(file_id)
526
592
        this_key =(file_id, default_revision)
527
593
        annotator.add_special_text(this_key, file_parent_keys, text)
528
594
        annotations = [(key[-1], line)
1202
1268
                # absolute path
1203
1269
                fap = from_dir_abspath + '/' + f
1204
1270
 
1205
 
                f_ie = inv.get_child(from_dir_id, f)
 
1271
                dir_ie = inv[from_dir_id]
 
1272
                if dir_ie.kind == 'directory':
 
1273
                    f_ie = dir_ie.children.get(f)
 
1274
                else:
 
1275
                    f_ie = None
1206
1276
                if f_ie:
1207
1277
                    c = 'V'
1208
1278
                elif self.is_ignored(fp[1:]):
1209
1279
                    c = 'I'
1210
1280
                else:
1211
 
                    # we may not have found this file, because of a unicode issue
 
1281
                    # we may not have found this file, because of a unicode
 
1282
                    # issue, or because the directory was actually a symlink.
1212
1283
                    f_norm, can_access = osutils.normalized_filename(f)
1213
1284
                    if f == f_norm or not can_access:
1214
1285
                        # No change, so treat this file normally
1257
1328
                stack.pop()
1258
1329
 
1259
1330
    @needs_tree_write_lock
1260
 
    def move(self, from_paths, to_dir=None, after=False, **kwargs):
 
1331
    def move(self, from_paths, to_dir=None, after=False):
1261
1332
        """Rename files.
1262
1333
 
1263
1334
        to_dir must exist in the inventory.
1297
1368
 
1298
1369
        # check for deprecated use of signature
1299
1370
        if to_dir is None:
1300
 
            to_dir = kwargs.get('to_name', None)
1301
 
            if to_dir is None:
1302
 
                raise TypeError('You must supply a target directory')
1303
 
            else:
1304
 
                symbol_versioning.warn('The parameter to_name was deprecated'
1305
 
                                       ' in version 0.13. Use to_dir instead',
1306
 
                                       DeprecationWarning)
1307
 
 
 
1371
            raise TypeError('You must supply a target directory')
1308
1372
        # check destination directory
1309
1373
        if isinstance(from_paths, basestring):
1310
1374
            raise ValueError()
1319
1383
        to_dir_id = inv.path2id(to_dir)
1320
1384
        if to_dir_id is None:
1321
1385
            raise errors.BzrMoveFailedError('',to_dir,
1322
 
                errors.NotVersionedError(path=str(to_dir)))
 
1386
                errors.NotVersionedError(path=to_dir))
1323
1387
 
1324
1388
        to_dir_ie = inv[to_dir_id]
1325
1389
        if to_dir_ie.kind != 'directory':
1332
1396
            from_id = inv.path2id(from_rel)
1333
1397
            if from_id is None:
1334
1398
                raise errors.BzrMoveFailedError(from_rel,to_dir,
1335
 
                    errors.NotVersionedError(path=str(from_rel)))
 
1399
                    errors.NotVersionedError(path=from_rel))
1336
1400
 
1337
1401
            from_entry = inv[from_id]
1338
1402
            from_parent_id = from_entry.parent_id
1380
1444
            # check the inventory for source and destination
1381
1445
            if from_id is None:
1382
1446
                raise errors.BzrMoveFailedError(from_rel,to_rel,
1383
 
                    errors.NotVersionedError(path=str(from_rel)))
 
1447
                    errors.NotVersionedError(path=from_rel))
1384
1448
            if to_id is not None:
1385
1449
                raise errors.BzrMoveFailedError(from_rel,to_rel,
1386
 
                    errors.AlreadyVersionedError(path=str(to_rel)))
 
1450
                    errors.AlreadyVersionedError(path=to_rel))
1387
1451
 
1388
1452
            # try to determine the mode for rename (only change inv or change
1389
1453
            # inv and file system)
1390
1454
            if after:
1391
1455
                if not self.has_filename(to_rel):
1392
1456
                    raise errors.BzrMoveFailedError(from_id,to_rel,
1393
 
                        errors.NoSuchFile(path=str(to_rel),
 
1457
                        errors.NoSuchFile(path=to_rel,
1394
1458
                        extra="New file has not been created yet"))
1395
1459
                only_change_inv = True
1396
1460
            elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1498
1562
            from_id = basis_tree.path2id(from_rel)
1499
1563
            if from_id is None:
1500
1564
                raise errors.BzrRenameFailedError(from_rel,to_rel,
1501
 
                    errors.NotVersionedError(path=str(from_rel)))
 
1565
                    errors.NotVersionedError(path=from_rel))
1502
1566
            # put entry back in the inventory so we can rename it
1503
1567
            from_entry = basis_tree.inventory[from_id].copy()
1504
1568
            inv.add(from_entry)
1522
1586
        # versioned
1523
1587
        if to_dir_id is None:
1524
1588
            raise errors.BzrMoveFailedError(from_rel,to_rel,
1525
 
                errors.NotVersionedError(path=str(to_dir)))
 
1589
                errors.NotVersionedError(path=to_dir))
1526
1590
 
1527
1591
        # all checks done. now we can continue with our actual work
1528
1592
        mutter('rename_one:\n'
1587
1651
            # - RBC 20060907
1588
1652
            self._write_inventory(self._inventory)
1589
1653
 
1590
 
    def _iter_conflicts(self):
1591
 
        conflicted = set()
1592
 
        for info in self.list_files():
1593
 
            path = info[0]
1594
 
            stem = get_conflicted_stem(path)
1595
 
            if stem is None:
1596
 
                continue
1597
 
            if stem not in conflicted:
1598
 
                conflicted.add(stem)
1599
 
                yield stem
1600
 
 
1601
1654
    @needs_write_lock
1602
1655
    def pull(self, source, overwrite=False, stop_revision=None,
1603
 
             change_reporter=None, possible_transports=None, local=False):
 
1656
             change_reporter=None, possible_transports=None, local=False,
 
1657
             show_base=False):
1604
1658
        source.lock_read()
1605
1659
        try:
1606
1660
            old_revision_info = self.branch.last_revision_info()
1620
1674
                                basis_tree,
1621
1675
                                this_tree=self,
1622
1676
                                pb=None,
1623
 
                                change_reporter=change_reporter)
 
1677
                                change_reporter=change_reporter,
 
1678
                                show_base=show_base)
1624
1679
                    basis_root_id = basis_tree.get_root_id()
1625
1680
                    new_root_id = new_basis_tree.get_root_id()
1626
1681
                    if basis_root_id != new_root_id:
1798
1853
            raise errors.ObjectNotLocked(self)
1799
1854
 
1800
1855
    def lock_read(self):
1801
 
        """See Branch.lock_read, and WorkingTree.unlock."""
 
1856
        """Lock the tree for reading.
 
1857
 
 
1858
        This also locks the branch, and can be unlocked via self.unlock().
 
1859
 
 
1860
        :return: A bzrlib.lock.LogicalLockResult.
 
1861
        """
1802
1862
        if not self.is_locked():
1803
1863
            self._reset_data()
1804
1864
        self.branch.lock_read()
1805
1865
        try:
1806
 
            return self._control_files.lock_read()
 
1866
            self._control_files.lock_read()
 
1867
            return LogicalLockResult(self.unlock)
1807
1868
        except:
1808
1869
            self.branch.unlock()
1809
1870
            raise
1810
1871
 
1811
1872
    def lock_tree_write(self):
1812
 
        """See MutableTree.lock_tree_write, and WorkingTree.unlock."""
 
1873
        """See MutableTree.lock_tree_write, and WorkingTree.unlock.
 
1874
 
 
1875
        :return: A bzrlib.lock.LogicalLockResult.
 
1876
        """
1813
1877
        if not self.is_locked():
1814
1878
            self._reset_data()
1815
1879
        self.branch.lock_read()
1816
1880
        try:
1817
 
            return self._control_files.lock_write()
 
1881
            self._control_files.lock_write()
 
1882
            return LogicalLockResult(self.unlock)
1818
1883
        except:
1819
1884
            self.branch.unlock()
1820
1885
            raise
1821
1886
 
1822
1887
    def lock_write(self):
1823
 
        """See MutableTree.lock_write, and WorkingTree.unlock."""
 
1888
        """See MutableTree.lock_write, and WorkingTree.unlock.
 
1889
 
 
1890
        :return: A bzrlib.lock.LogicalLockResult.
 
1891
        """
1824
1892
        if not self.is_locked():
1825
1893
            self._reset_data()
1826
1894
        self.branch.lock_write()
1827
1895
        try:
1828
 
            return self._control_files.lock_write()
 
1896
            self._control_files.lock_write()
 
1897
            return LogicalLockResult(self.unlock)
1829
1898
        except:
1830
1899
            self.branch.unlock()
1831
1900
            raise
1948
2017
 
1949
2018
        inv_delta = []
1950
2019
 
1951
 
        new_files=set()
 
2020
        all_files = set() # specified and nested files 
1952
2021
        unknown_nested_files=set()
1953
2022
        if to_file is None:
1954
2023
            to_file = sys.stdout
1955
2024
 
 
2025
        files_to_backup = []
 
2026
 
1956
2027
        def recurse_directory_to_add_files(directory):
1957
2028
            # Recurse directory and add all files
1958
2029
            # so we can check if they have changed.
1959
 
            for parent_info, file_infos in\
1960
 
                self.walkdirs(directory):
 
2030
            for parent_info, file_infos in self.walkdirs(directory):
1961
2031
                for relpath, basename, kind, lstat, fileid, kind in file_infos:
1962
2032
                    # Is it versioned or ignored?
1963
 
                    if self.path2id(relpath) or self.is_ignored(relpath):
 
2033
                    if self.path2id(relpath):
1964
2034
                        # Add nested content for deletion.
1965
 
                        new_files.add(relpath)
 
2035
                        all_files.add(relpath)
1966
2036
                    else:
1967
 
                        # Files which are not versioned and not ignored
 
2037
                        # Files which are not versioned
1968
2038
                        # should be treated as unknown.
1969
 
                        unknown_nested_files.add((relpath, None, kind))
 
2039
                        files_to_backup.append(relpath)
1970
2040
 
1971
2041
        for filename in files:
1972
2042
            # Get file name into canonical form.
1973
2043
            abspath = self.abspath(filename)
1974
2044
            filename = self.relpath(abspath)
1975
2045
            if len(filename) > 0:
1976
 
                new_files.add(filename)
 
2046
                all_files.add(filename)
1977
2047
                recurse_directory_to_add_files(filename)
1978
2048
 
1979
 
        files = list(new_files)
 
2049
        files = list(all_files)
1980
2050
 
1981
2051
        if len(files) == 0:
1982
2052
            return # nothing to do
1986
2056
 
1987
2057
        # Bail out if we are going to delete files we shouldn't
1988
2058
        if not keep_files and not force:
1989
 
            has_changed_files = len(unknown_nested_files) > 0
1990
 
            if not has_changed_files:
1991
 
                for (file_id, path, content_change, versioned, parent_id, name,
1992
 
                     kind, executable) in self.iter_changes(self.basis_tree(),
1993
 
                         include_unchanged=True, require_versioned=False,
1994
 
                         want_unversioned=True, specific_files=files):
1995
 
                    if versioned == (False, False):
1996
 
                        # The record is unknown ...
1997
 
                        if not self.is_ignored(path[1]):
1998
 
                            # ... but not ignored
1999
 
                            has_changed_files = True
2000
 
                            break
2001
 
                    elif content_change and (kind[1] is not None):
2002
 
                        # Versioned and changed, but not deleted
2003
 
                        has_changed_files = True
2004
 
                        break
 
2059
            for (file_id, path, content_change, versioned, parent_id, name,
 
2060
                 kind, executable) in self.iter_changes(self.basis_tree(),
 
2061
                     include_unchanged=True, require_versioned=False,
 
2062
                     want_unversioned=True, specific_files=files):
 
2063
                if versioned[0] == False:
 
2064
                    # The record is unknown or newly added
 
2065
                    files_to_backup.append(path[1])
 
2066
                elif (content_change and (kind[1] is not None) and
 
2067
                        osutils.is_inside_any(files, path[1])):
 
2068
                    # Versioned and changed, but not deleted, and still
 
2069
                    # in one of the dirs to be deleted.
 
2070
                    files_to_backup.append(path[1])
2005
2071
 
2006
 
            if has_changed_files:
2007
 
                # Make delta show ALL applicable changes in error message.
2008
 
                tree_delta = self.changes_from(self.basis_tree(),
2009
 
                    require_versioned=False, want_unversioned=True,
2010
 
                    specific_files=files)
2011
 
                for unknown_file in unknown_nested_files:
2012
 
                    if unknown_file not in tree_delta.unversioned:
2013
 
                        tree_delta.unversioned.extend((unknown_file,))
2014
 
                raise errors.BzrRemoveChangedFilesError(tree_delta)
 
2072
        def backup(file_to_backup):
 
2073
            backup_name = self.bzrdir._available_backup_name(file_to_backup)
 
2074
            osutils.rename(abs_path, self.abspath(backup_name))
 
2075
            return "removed %s (but kept a copy: %s)" % (file_to_backup,
 
2076
                                                         backup_name)
2015
2077
 
2016
2078
        # Build inv_delta and delete files where applicable,
2017
2079
        # do this before any modifications to inventory.
2041
2103
                        len(os.listdir(abs_path)) > 0):
2042
2104
                        if force:
2043
2105
                            osutils.rmtree(abs_path)
 
2106
                            message = "deleted %s" % (f,)
2044
2107
                        else:
2045
 
                            message = "%s is not an empty directory "\
2046
 
                                "and won't be deleted." % (f,)
 
2108
                            message = backup(f)
2047
2109
                    else:
2048
 
                        osutils.delete_any(abs_path)
2049
 
                        message = "deleted %s" % (f,)
 
2110
                        if f in files_to_backup:
 
2111
                            message = backup(f)
 
2112
                        else:
 
2113
                            osutils.delete_any(abs_path)
 
2114
                            message = "deleted %s" % (f,)
2050
2115
                elif message is not None:
2051
2116
                    # Only care if we haven't done anything yet.
2052
2117
                    message = "%s does not exist." % (f,)
2189
2254
    _marker = object()
2190
2255
 
2191
2256
    def update(self, change_reporter=None, possible_transports=None,
2192
 
               revision=None, old_tip=_marker):
 
2257
               revision=None, old_tip=_marker, show_base=False):
2193
2258
        """Update a working tree along its branch.
2194
2259
 
2195
2260
        This will update the branch if its bound too, which means we have
2232
2297
            else:
2233
2298
                if old_tip is self._marker:
2234
2299
                    old_tip = None
2235
 
            return self._update_tree(old_tip, change_reporter, revision)
 
2300
            return self._update_tree(old_tip, change_reporter, revision, show_base)
2236
2301
        finally:
2237
2302
            self.unlock()
2238
2303
 
2239
2304
    @needs_tree_write_lock
2240
 
    def _update_tree(self, old_tip=None, change_reporter=None, revision=None):
 
2305
    def _update_tree(self, old_tip=None, change_reporter=None, revision=None,
 
2306
                     show_base=False):
2241
2307
        """Update a tree to the master branch.
2242
2308
 
2243
2309
        :param old_tip: if supplied, the previous tip revision the branch,
2270
2336
            other_tree = self.branch.repository.revision_tree(old_tip)
2271
2337
            nb_conflicts = merge.merge_inner(self.branch, other_tree,
2272
2338
                                             base_tree, this_tree=self,
2273
 
                                             change_reporter=change_reporter)
 
2339
                                             change_reporter=change_reporter,
 
2340
                                             show_base=show_base)
2274
2341
            if nb_conflicts:
2275
2342
                self.add_parent_tree((old_tip, other_tree))
2276
2343
                trace.note('Rerun update after fixing the conflicts.')
2300
2367
 
2301
2368
            nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
2302
2369
                                             this_tree=self,
2303
 
                                             change_reporter=change_reporter)
 
2370
                                             change_reporter=change_reporter,
 
2371
                                             show_base=show_base)
2304
2372
            self.set_last_revision(revision)
2305
2373
            # TODO - dedup parents list with things merged by pull ?
2306
2374
            # reuse the tree we've updated to to set the basis:
2347
2415
    def add_conflicts(self, arg):
2348
2416
        raise errors.UnsupportedOperation(self.add_conflicts, self)
2349
2417
 
2350
 
    @needs_read_lock
2351
2418
    def conflicts(self):
2352
 
        conflicts = _mod_conflicts.ConflictList()
2353
 
        for conflicted in self._iter_conflicts():
2354
 
            text = True
2355
 
            try:
2356
 
                if file_kind(self.abspath(conflicted)) != "file":
2357
 
                    text = False
2358
 
            except errors.NoSuchFile:
2359
 
                text = False
2360
 
            if text is True:
2361
 
                for suffix in ('.THIS', '.OTHER'):
2362
 
                    try:
2363
 
                        kind = file_kind(self.abspath(conflicted+suffix))
2364
 
                        if kind != "file":
2365
 
                            text = False
2366
 
                    except errors.NoSuchFile:
2367
 
                        text = False
2368
 
                    if text == False:
2369
 
                        break
2370
 
            ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2371
 
            conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2372
 
                             path=conflicted,
2373
 
                             file_id=self.path2id(conflicted)))
2374
 
        return conflicts
 
2419
        raise NotImplementedError(self.conflicts)
2375
2420
 
2376
2421
    def walkdirs(self, prefix=""):
2377
2422
        """Walk the directories of this tree.
2595
2640
        """
2596
2641
        return
2597
2642
 
 
2643
    @needs_read_lock
 
2644
    def check_state(self):
 
2645
        """Check that the working state is/isn't valid."""
 
2646
        check_refs = self._get_check_refs()
 
2647
        refs = {}
 
2648
        for ref in check_refs:
 
2649
            kind, value = ref
 
2650
            if kind == 'trees':
 
2651
                refs[ref] = self.branch.repository.revision_tree(value)
 
2652
        self._check(refs)
 
2653
 
 
2654
    @needs_tree_write_lock
 
2655
    def reset_state(self, revision_ids=None):
 
2656
        """Reset the state of the working tree.
 
2657
 
 
2658
        This does a hard-reset to a last-known-good state. This is a way to
 
2659
        fix if something got corrupted (like the .bzr/checkout/dirstate file)
 
2660
        """
 
2661
        if revision_ids is None:
 
2662
            revision_ids = self.get_parent_ids()
 
2663
        if not revision_ids:
 
2664
            rt = self.branch.repository.revision_tree(
 
2665
                _mod_revision.NULL_REVISION)
 
2666
        else:
 
2667
            rt = self.branch.repository.revision_tree(revision_ids[0])
 
2668
        self._write_inventory(rt.inventory)
 
2669
        self.set_parent_ids(revision_ids)
 
2670
 
2598
2671
    def _get_rules_searcher(self, default_searcher):
2599
2672
        """See Tree._get_rules_searcher."""
2600
2673
        if self._rules_searcher is None:
2608
2681
        return ShelfManager(self, self._transport)
2609
2682
 
2610
2683
 
2611
 
class WorkingTree2(WorkingTree):
2612
 
    """This is the Format 2 working tree.
2613
 
 
2614
 
    This was the first weave based working tree.
2615
 
     - uses os locks for locking.
2616
 
     - uses the branch last-revision.
2617
 
    """
2618
 
 
2619
 
    def __init__(self, *args, **kwargs):
2620
 
        super(WorkingTree2, self).__init__(*args, **kwargs)
2621
 
        # WorkingTree2 has more of a constraint that self._inventory must
2622
 
        # exist. Because this is an older format, we don't mind the overhead
2623
 
        # caused by the extra computation here.
2624
 
 
2625
 
        # Newer WorkingTree's should only have self._inventory set when they
2626
 
        # have a read lock.
2627
 
        if self._inventory is None:
2628
 
            self.read_working_inventory()
2629
 
 
2630
 
    def _get_check_refs(self):
2631
 
        """Return the references needed to perform a check of this tree."""
2632
 
        return [('trees', self.last_revision())]
2633
 
 
2634
 
    def lock_tree_write(self):
2635
 
        """See WorkingTree.lock_tree_write().
2636
 
 
2637
 
        In Format2 WorkingTrees we have a single lock for the branch and tree
2638
 
        so lock_tree_write() degrades to lock_write().
2639
 
        """
2640
 
        self.branch.lock_write()
2641
 
        try:
2642
 
            return self._control_files.lock_write()
2643
 
        except:
2644
 
            self.branch.unlock()
2645
 
            raise
2646
 
 
2647
 
    def unlock(self):
2648
 
        # do non-implementation specific cleanup
2649
 
        self._cleanup()
2650
 
 
2651
 
        # we share control files:
2652
 
        if self._control_files._lock_count == 3:
2653
 
            # _inventory_is_modified is always False during a read lock.
2654
 
            if self._inventory_is_modified:
2655
 
                self.flush()
2656
 
            self._write_hashcache_if_dirty()
2657
 
 
2658
 
        # reverse order of locking.
2659
 
        try:
2660
 
            return self._control_files.unlock()
2661
 
        finally:
2662
 
            self.branch.unlock()
2663
 
 
2664
 
 
2665
2684
class WorkingTree3(WorkingTree):
2666
2685
    """This is the Format 3 working tree.
2667
2686
 
2740
2759
            self.branch.unlock()
2741
2760
 
2742
2761
 
2743
 
def get_conflicted_stem(path):
2744
 
    for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2745
 
        if path.endswith(suffix):
2746
 
            return path[:-len(suffix)]
2747
 
 
2748
 
 
2749
 
class WorkingTreeFormat(object):
 
2762
class WorkingTreeFormatRegistry(controldir.ControlComponentFormatRegistry):
 
2763
    """Registry for working tree formats."""
 
2764
 
 
2765
    def __init__(self, other_registry=None):
 
2766
        super(WorkingTreeFormatRegistry, self).__init__(other_registry)
 
2767
        self._default_format = None
 
2768
 
 
2769
    def get_default(self):
 
2770
        """Return the current default format."""
 
2771
        return self._default_format
 
2772
 
 
2773
    def set_default(self, format):
 
2774
        self._default_format = format
 
2775
 
 
2776
 
 
2777
format_registry = WorkingTreeFormatRegistry()
 
2778
 
 
2779
 
 
2780
class WorkingTreeFormat(controldir.ControlComponentFormat):
2750
2781
    """An encapsulation of the initialization and open routines for a format.
2751
2782
 
2752
2783
    Formats provide three things:
2764
2795
    object will be created every time regardless.
2765
2796
    """
2766
2797
 
2767
 
    _default_format = None
2768
 
    """The default format used for new trees."""
2769
 
 
2770
 
    _formats = {}
2771
 
    """The known formats."""
2772
 
 
2773
2798
    requires_rich_root = False
2774
2799
 
2775
2800
    upgrade_recommended = False
2776
2801
 
 
2802
    requires_normalized_unicode_filenames = False
 
2803
 
 
2804
    case_sensitive_filename = "FoRMaT"
 
2805
 
 
2806
    missing_parent_conflicts = False
 
2807
    """If this format supports missing parent conflicts."""
 
2808
 
2777
2809
    @classmethod
2778
2810
    def find_format(klass, a_bzrdir):
2779
2811
        """Return the format for the working tree object in a_bzrdir."""
2780
2812
        try:
2781
2813
            transport = a_bzrdir.get_workingtree_transport(None)
2782
2814
            format_string = transport.get_bytes("format")
2783
 
            return klass._formats[format_string]
 
2815
            return format_registry.get(format_string)
2784
2816
        except errors.NoSuchFile:
2785
2817
            raise errors.NoWorkingTree(base=transport.base)
2786
2818
        except KeyError:
2787
2819
            raise errors.UnknownFormatError(format=format_string,
2788
2820
                                            kind="working tree")
2789
2821
 
 
2822
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
 
2823
                   accelerator_tree=None, hardlink=False):
 
2824
        """Initialize a new working tree in a_bzrdir.
 
2825
 
 
2826
        :param a_bzrdir: BzrDir to initialize the working tree in.
 
2827
        :param revision_id: allows creating a working tree at a different
 
2828
            revision than the branch is at.
 
2829
        :param from_branch: Branch to checkout
 
2830
        :param accelerator_tree: A tree which can be used for retrieving file
 
2831
            contents more quickly than the revision tree, i.e. a workingtree.
 
2832
            The revision tree will be used for cases where accelerator_tree's
 
2833
            content is different.
 
2834
        :param hardlink: If true, hard-link files from accelerator_tree,
 
2835
            where possible.
 
2836
        """
 
2837
        raise NotImplementedError(self.initialize)
 
2838
 
2790
2839
    def __eq__(self, other):
2791
2840
        return self.__class__ is other.__class__
2792
2841
 
2794
2843
        return not (self == other)
2795
2844
 
2796
2845
    @classmethod
 
2846
    @symbol_versioning.deprecated_method(
 
2847
        symbol_versioning.deprecated_in((2, 4, 0)))
2797
2848
    def get_default_format(klass):
2798
2849
        """Return the current default format."""
2799
 
        return klass._default_format
 
2850
        return format_registry.get_default()
2800
2851
 
2801
2852
    def get_format_string(self):
2802
2853
        """Return the ASCII format string that identifies this format."""
2824
2875
        return False
2825
2876
 
2826
2877
    @classmethod
 
2878
    @symbol_versioning.deprecated_method(
 
2879
        symbol_versioning.deprecated_in((2, 4, 0)))
2827
2880
    def register_format(klass, format):
2828
 
        klass._formats[format.get_format_string()] = format
2829
 
 
2830
 
    @classmethod
 
2881
        format_registry.register(format)
 
2882
 
 
2883
    @classmethod
 
2884
    @symbol_versioning.deprecated_method(
 
2885
        symbol_versioning.deprecated_in((2, 4, 0)))
 
2886
    def register_extra_format(klass, format):
 
2887
        format_registry.register_extra(format)
 
2888
 
 
2889
    @classmethod
 
2890
    @symbol_versioning.deprecated_method(
 
2891
        symbol_versioning.deprecated_in((2, 4, 0)))
 
2892
    def unregister_extra_format(klass, format):
 
2893
        format_registry.unregister_extra(format)
 
2894
 
 
2895
    @classmethod
 
2896
    @symbol_versioning.deprecated_method(
 
2897
        symbol_versioning.deprecated_in((2, 4, 0)))
 
2898
    def get_formats(klass):
 
2899
        return format_registry._get_all()
 
2900
 
 
2901
    @classmethod
 
2902
    @symbol_versioning.deprecated_method(
 
2903
        symbol_versioning.deprecated_in((2, 4, 0)))
2831
2904
    def set_default_format(klass, format):
2832
 
        klass._default_format = format
 
2905
        format_registry.set_default(format)
2833
2906
 
2834
2907
    @classmethod
 
2908
    @symbol_versioning.deprecated_method(
 
2909
        symbol_versioning.deprecated_in((2, 4, 0)))
2835
2910
    def unregister_format(klass, format):
2836
 
        del klass._formats[format.get_format_string()]
2837
 
 
2838
 
 
2839
 
class WorkingTreeFormat2(WorkingTreeFormat):
2840
 
    """The second working tree format.
2841
 
 
2842
 
    This format modified the hash cache from the format 1 hash cache.
2843
 
    """
2844
 
 
2845
 
    upgrade_recommended = True
2846
 
 
2847
 
    def get_format_description(self):
2848
 
        """See WorkingTreeFormat.get_format_description()."""
2849
 
        return "Working tree format 2"
2850
 
 
2851
 
    def _stub_initialize_on_transport(self, transport, file_mode):
2852
 
        """Workaround: create control files for a remote working tree.
2853
 
 
2854
 
        This ensures that it can later be updated and dealt with locally,
2855
 
        since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2856
 
        no working tree.  (See bug #43064).
2857
 
        """
2858
 
        sio = StringIO()
2859
 
        inv = inventory.Inventory()
2860
 
        xml5.serializer_v5.write_inventory(inv, sio, working=True)
2861
 
        sio.seek(0)
2862
 
        transport.put_file('inventory', sio, file_mode)
2863
 
        transport.put_bytes('pending-merges', '', file_mode)
2864
 
 
2865
 
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2866
 
                   accelerator_tree=None, hardlink=False):
2867
 
        """See WorkingTreeFormat.initialize()."""
2868
 
        if not isinstance(a_bzrdir.transport, LocalTransport):
2869
 
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
2870
 
        if from_branch is not None:
2871
 
            branch = from_branch
2872
 
        else:
2873
 
            branch = a_bzrdir.open_branch()
2874
 
        if revision_id is None:
2875
 
            revision_id = _mod_revision.ensure_null(branch.last_revision())
2876
 
        branch.lock_write()
2877
 
        try:
2878
 
            branch.generate_revision_history(revision_id)
2879
 
        finally:
2880
 
            branch.unlock()
2881
 
        inv = inventory.Inventory()
2882
 
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2883
 
                         branch,
2884
 
                         inv,
2885
 
                         _internal=True,
2886
 
                         _format=self,
2887
 
                         _bzrdir=a_bzrdir)
2888
 
        basis_tree = branch.repository.revision_tree(revision_id)
2889
 
        if basis_tree.inventory.root is not None:
2890
 
            wt.set_root_id(basis_tree.get_root_id())
2891
 
        # set the parent list and cache the basis tree.
2892
 
        if _mod_revision.is_null(revision_id):
2893
 
            parent_trees = []
2894
 
        else:
2895
 
            parent_trees = [(revision_id, basis_tree)]
2896
 
        wt.set_parent_trees(parent_trees)
2897
 
        transform.build_tree(basis_tree, wt)
2898
 
        return wt
2899
 
 
2900
 
    def __init__(self):
2901
 
        super(WorkingTreeFormat2, self).__init__()
2902
 
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
2903
 
 
2904
 
    def open(self, a_bzrdir, _found=False):
2905
 
        """Return the WorkingTree object for a_bzrdir
2906
 
 
2907
 
        _found is a private parameter, do not use it. It is used to indicate
2908
 
               if format probing has already been done.
2909
 
        """
2910
 
        if not _found:
2911
 
            # we are being called directly and must probe.
2912
 
            raise NotImplementedError
2913
 
        if not isinstance(a_bzrdir.transport, LocalTransport):
2914
 
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
2915
 
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2916
 
                           _internal=True,
2917
 
                           _format=self,
2918
 
                           _bzrdir=a_bzrdir)
2919
 
        return wt
 
2911
        format_registry.remove(format)
 
2912
 
2920
2913
 
2921
2914
class WorkingTreeFormat3(WorkingTreeFormat):
2922
2915
    """The second working tree format updated to record a format marker.
2932
2925
 
2933
2926
    upgrade_recommended = True
2934
2927
 
 
2928
    missing_parent_conflicts = True
 
2929
 
2935
2930
    def get_format_string(self):
2936
2931
        """See WorkingTreeFormat.get_format_string()."""
2937
2932
        return "Bazaar-NG Working Tree format 3"
3050
3045
 
3051
3046
 
3052
3047
__default_format = WorkingTreeFormat6()
3053
 
WorkingTreeFormat.register_format(__default_format)
3054
 
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3055
 
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3056
 
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3057
 
WorkingTreeFormat.set_default_format(__default_format)
3058
 
# formats which have no format string are not discoverable
3059
 
# and not independently creatable, so are not registered.
3060
 
_legacy_formats = [WorkingTreeFormat2(),
3061
 
                   ]
 
3048
format_registry.register_lazy("Bazaar Working Tree Format 4 (bzr 0.15)\n",
 
3049
    "bzrlib.workingtree_4", "WorkingTreeFormat4")
 
3050
format_registry.register_lazy("Bazaar Working Tree Format 5 (bzr 1.11)\n",
 
3051
    "bzrlib.workingtree_4", "WorkingTreeFormat5")
 
3052
format_registry.register_lazy("Bazaar Working Tree Format 6 (bzr 1.14)\n",
 
3053
    "bzrlib.workingtree_4", "WorkingTreeFormat6")
 
3054
format_registry.register(WorkingTreeFormat3())
 
3055
format_registry.set_default(__default_format)