/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
73
    WorkingTreeFormat4,
73
74
    WorkingTreeFormat5,
169
170
 
170
171
 
171
172
class WorkingTree(bzrlib.mutabletree.MutableTree,
172
 
    bzrdir.ControlComponent):
 
173
    controldir.ControlComponent):
173
174
    """Working copy tree.
174
175
 
175
176
    The inventory is held in the `Branch` working-inventory, and the
177
178
 
178
179
    It is possible for a `WorkingTree` to have a filename which is
179
180
    not listed in the Inventory and vice versa.
 
181
 
 
182
    :ivar basedir: The root of the tree on disk. This is a unicode path object
 
183
        (as opposed to a URL).
180
184
    """
181
185
 
182
186
    # override this to set the strategy for storing views
206
210
        else:
207
211
            self._branch = self.bzrdir.open_branch()
208
212
        self.basedir = realpath(basedir)
209
 
        # if branch is at our basedir and is a format 6 or less
210
 
        if isinstance(self._format, WorkingTreeFormat2):
211
 
            # share control object
212
 
            self._control_files = self.branch.control_files
213
 
        else:
214
 
            # assume all other formats have their own control files.
215
 
            self._control_files = _control_files
 
213
        self._control_files = _control_files
216
214
        self._transport = self._control_files._transport
217
215
        # update the whole cache up front and write to disk if anything changed;
218
216
        # in the future we might want to do this more selectively
256
254
    def control_transport(self):
257
255
        return self._transport
258
256
 
 
257
    def is_control_filename(self, filename):
 
258
        """True if filename is the name of a control file in this tree.
 
259
 
 
260
        :param filename: A filename within the tree. This is a relative path
 
261
        from the root of this tree.
 
262
 
 
263
        This is true IF and ONLY IF the filename is part of the meta data
 
264
        that bzr controls in this tree. I.E. a random .bzr directory placed
 
265
        on disk will not be a control file for this tree.
 
266
        """
 
267
        return self.bzrdir.is_control_filename(filename)
 
268
 
259
269
    def _detect_case_handling(self):
260
270
        wt_trans = self.bzrdir.get_workingtree_transport(None)
261
271
        try:
262
 
            wt_trans.stat("FoRMaT")
 
272
            wt_trans.stat(self._format.case_sensitive_filename)
263
273
        except errors.NoSuchFile:
264
274
            self.case_sensitive = True
265
275
        else:
347
357
        if path is None:
348
358
            path = osutils.getcwd()
349
359
        control, relpath = bzrdir.BzrDir.open_containing(path)
350
 
 
351
360
        return control.open_workingtree(), relpath
352
361
 
353
362
    @staticmethod
 
363
    def open_containing_paths(file_list, default_directory=None,
 
364
                              canonicalize=True, apply_view=True):
 
365
        """Open the WorkingTree that contains a set of paths.
 
366
 
 
367
        Fail if the paths given are not all in a single tree.
 
368
 
 
369
        This is used for the many command-line interfaces that take a list of
 
370
        any number of files and that require they all be in the same tree.
 
371
        """
 
372
        if default_directory is None:
 
373
            default_directory = u'.'
 
374
        # recommended replacement for builtins.internal_tree_files
 
375
        if file_list is None or len(file_list) == 0:
 
376
            tree = WorkingTree.open_containing(default_directory)[0]
 
377
            # XXX: doesn't really belong here, and seems to have the strange
 
378
            # side effect of making it return a bunch of files, not the whole
 
379
            # tree -- mbp 20100716
 
380
            if tree.supports_views() and apply_view:
 
381
                view_files = tree.views.lookup_view()
 
382
                if view_files:
 
383
                    file_list = view_files
 
384
                    view_str = views.view_display_str(view_files)
 
385
                    note("Ignoring files outside view. View is %s" % view_str)
 
386
            return tree, file_list
 
387
        if default_directory == u'.':
 
388
            seed = file_list[0]
 
389
        else:
 
390
            seed = default_directory
 
391
            file_list = [osutils.pathjoin(default_directory, f)
 
392
                         for f in file_list]
 
393
        tree = WorkingTree.open_containing(seed)[0]
 
394
        return tree, tree.safe_relpath_files(file_list, canonicalize,
 
395
                                             apply_view=apply_view)
 
396
 
 
397
    def safe_relpath_files(self, file_list, canonicalize=True, apply_view=True):
 
398
        """Convert file_list into a list of relpaths in tree.
 
399
 
 
400
        :param self: A tree to operate on.
 
401
        :param file_list: A list of user provided paths or None.
 
402
        :param apply_view: if True and a view is set, apply it or check that
 
403
            specified files are within it
 
404
        :return: A list of relative paths.
 
405
        :raises errors.PathNotChild: When a provided path is in a different self
 
406
            than self.
 
407
        """
 
408
        if file_list is None:
 
409
            return None
 
410
        if self.supports_views() and apply_view:
 
411
            view_files = self.views.lookup_view()
 
412
        else:
 
413
            view_files = []
 
414
        new_list = []
 
415
        # self.relpath exists as a "thunk" to osutils, but canonical_relpath
 
416
        # doesn't - fix that up here before we enter the loop.
 
417
        if canonicalize:
 
418
            fixer = lambda p: osutils.canonical_relpath(self.basedir, p)
 
419
        else:
 
420
            fixer = self.relpath
 
421
        for filename in file_list:
 
422
            relpath = fixer(osutils.dereference_path(filename))
 
423
            if view_files and not osutils.is_inside_any(view_files, relpath):
 
424
                raise errors.FileOutsideView(filename, view_files)
 
425
            new_list.append(relpath)
 
426
        return new_list
 
427
 
 
428
    @staticmethod
354
429
    def open_downlevel(path=None):
355
430
        """Open an unsupported working tree.
356
431
 
369
444
                return True, None
370
445
            else:
371
446
                return True, tree
372
 
        transport = get_transport(location)
373
 
        iterator = bzrdir.BzrDir.find_bzrdirs(transport, evaluate=evaluate,
 
447
        t = transport.get_transport(location)
 
448
        iterator = bzrdir.BzrDir.find_bzrdirs(t, evaluate=evaluate,
374
449
                                              list_current=list_current)
375
 
        return [t for t in iterator if t is not None]
 
450
        return [tr for tr in iterator if tr is not None]
376
451
 
377
452
    # should be deprecated - this is slow and in any case treating them as a
378
453
    # container is (we now know) bad style -- mbp 20070302
1207
1282
                # absolute path
1208
1283
                fap = from_dir_abspath + '/' + f
1209
1284
 
1210
 
                f_ie = inv.get_child(from_dir_id, f)
 
1285
                dir_ie = inv[from_dir_id]
 
1286
                if dir_ie.kind == 'directory':
 
1287
                    f_ie = dir_ie.children.get(f)
 
1288
                else:
 
1289
                    f_ie = None
1211
1290
                if f_ie:
1212
1291
                    c = 'V'
1213
1292
                elif self.is_ignored(fp[1:]):
1214
1293
                    c = 'I'
1215
1294
                else:
1216
 
                    # we may not have found this file, because of a unicode issue
 
1295
                    # we may not have found this file, because of a unicode
 
1296
                    # issue, or because the directory was actually a symlink.
1217
1297
                    f_norm, can_access = osutils.normalized_filename(f)
1218
1298
                    if f == f_norm or not can_access:
1219
1299
                        # No change, so treat this file normally
1262
1342
                stack.pop()
1263
1343
 
1264
1344
    @needs_tree_write_lock
1265
 
    def move(self, from_paths, to_dir=None, after=False, **kwargs):
 
1345
    def move(self, from_paths, to_dir=None, after=False):
1266
1346
        """Rename files.
1267
1347
 
1268
1348
        to_dir must exist in the inventory.
1302
1382
 
1303
1383
        # check for deprecated use of signature
1304
1384
        if to_dir is None:
1305
 
            to_dir = kwargs.get('to_name', None)
1306
 
            if to_dir is None:
1307
 
                raise TypeError('You must supply a target directory')
1308
 
            else:
1309
 
                symbol_versioning.warn('The parameter to_name was deprecated'
1310
 
                                       ' in version 0.13. Use to_dir instead',
1311
 
                                       DeprecationWarning)
1312
 
 
 
1385
            raise TypeError('You must supply a target directory')
1313
1386
        # check destination directory
1314
1387
        if isinstance(from_paths, basestring):
1315
1388
            raise ValueError()
1324
1397
        to_dir_id = inv.path2id(to_dir)
1325
1398
        if to_dir_id is None:
1326
1399
            raise errors.BzrMoveFailedError('',to_dir,
1327
 
                errors.NotVersionedError(path=str(to_dir)))
 
1400
                errors.NotVersionedError(path=to_dir))
1328
1401
 
1329
1402
        to_dir_ie = inv[to_dir_id]
1330
1403
        if to_dir_ie.kind != 'directory':
1337
1410
            from_id = inv.path2id(from_rel)
1338
1411
            if from_id is None:
1339
1412
                raise errors.BzrMoveFailedError(from_rel,to_dir,
1340
 
                    errors.NotVersionedError(path=str(from_rel)))
 
1413
                    errors.NotVersionedError(path=from_rel))
1341
1414
 
1342
1415
            from_entry = inv[from_id]
1343
1416
            from_parent_id = from_entry.parent_id
1385
1458
            # check the inventory for source and destination
1386
1459
            if from_id is None:
1387
1460
                raise errors.BzrMoveFailedError(from_rel,to_rel,
1388
 
                    errors.NotVersionedError(path=str(from_rel)))
 
1461
                    errors.NotVersionedError(path=from_rel))
1389
1462
            if to_id is not None:
1390
1463
                raise errors.BzrMoveFailedError(from_rel,to_rel,
1391
 
                    errors.AlreadyVersionedError(path=str(to_rel)))
 
1464
                    errors.AlreadyVersionedError(path=to_rel))
1392
1465
 
1393
1466
            # try to determine the mode for rename (only change inv or change
1394
1467
            # inv and file system)
1395
1468
            if after:
1396
1469
                if not self.has_filename(to_rel):
1397
1470
                    raise errors.BzrMoveFailedError(from_id,to_rel,
1398
 
                        errors.NoSuchFile(path=str(to_rel),
 
1471
                        errors.NoSuchFile(path=to_rel,
1399
1472
                        extra="New file has not been created yet"))
1400
1473
                only_change_inv = True
1401
1474
            elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1503
1576
            from_id = basis_tree.path2id(from_rel)
1504
1577
            if from_id is None:
1505
1578
                raise errors.BzrRenameFailedError(from_rel,to_rel,
1506
 
                    errors.NotVersionedError(path=str(from_rel)))
 
1579
                    errors.NotVersionedError(path=from_rel))
1507
1580
            # put entry back in the inventory so we can rename it
1508
1581
            from_entry = basis_tree.inventory[from_id].copy()
1509
1582
            inv.add(from_entry)
1527
1600
        # versioned
1528
1601
        if to_dir_id is None:
1529
1602
            raise errors.BzrMoveFailedError(from_rel,to_rel,
1530
 
                errors.NotVersionedError(path=str(to_dir)))
 
1603
                errors.NotVersionedError(path=to_dir))
1531
1604
 
1532
1605
        # all checks done. now we can continue with our actual work
1533
1606
        mutter('rename_one:\n'
1592
1665
            # - RBC 20060907
1593
1666
            self._write_inventory(self._inventory)
1594
1667
 
1595
 
    def _iter_conflicts(self):
1596
 
        conflicted = set()
1597
 
        for info in self.list_files():
1598
 
            path = info[0]
1599
 
            stem = get_conflicted_stem(path)
1600
 
            if stem is None:
1601
 
                continue
1602
 
            if stem not in conflicted:
1603
 
                conflicted.add(stem)
1604
 
                yield stem
1605
 
 
1606
1668
    @needs_write_lock
1607
1669
    def pull(self, source, overwrite=False, stop_revision=None,
1608
 
             change_reporter=None, possible_transports=None, local=False):
 
1670
             change_reporter=None, possible_transports=None, local=False,
 
1671
             show_base=False):
1609
1672
        source.lock_read()
1610
1673
        try:
1611
1674
            old_revision_info = self.branch.last_revision_info()
1625
1688
                                basis_tree,
1626
1689
                                this_tree=self,
1627
1690
                                pb=None,
1628
 
                                change_reporter=change_reporter)
 
1691
                                change_reporter=change_reporter,
 
1692
                                show_base=show_base)
1629
1693
                    basis_root_id = basis_tree.get_root_id()
1630
1694
                    new_root_id = new_basis_tree.get_root_id()
1631
1695
                    if basis_root_id != new_root_id:
1967
2031
 
1968
2032
        inv_delta = []
1969
2033
 
1970
 
        new_files=set()
 
2034
        all_files = set() # specified and nested files 
1971
2035
        unknown_nested_files=set()
1972
2036
        if to_file is None:
1973
2037
            to_file = sys.stdout
1974
2038
 
 
2039
        files_to_backup = []
 
2040
 
1975
2041
        def recurse_directory_to_add_files(directory):
1976
2042
            # Recurse directory and add all files
1977
2043
            # so we can check if they have changed.
1978
2044
            for parent_info, file_infos in self.walkdirs(directory):
1979
2045
                for relpath, basename, kind, lstat, fileid, kind in file_infos:
1980
2046
                    # Is it versioned or ignored?
1981
 
                    if self.path2id(relpath) or self.is_ignored(relpath):
 
2047
                    if self.path2id(relpath):
1982
2048
                        # Add nested content for deletion.
1983
 
                        new_files.add(relpath)
 
2049
                        all_files.add(relpath)
1984
2050
                    else:
1985
 
                        # Files which are not versioned and not ignored
 
2051
                        # Files which are not versioned
1986
2052
                        # should be treated as unknown.
1987
 
                        unknown_nested_files.add((relpath, None, kind))
 
2053
                        files_to_backup.append(relpath)
1988
2054
 
1989
2055
        for filename in files:
1990
2056
            # Get file name into canonical form.
1991
2057
            abspath = self.abspath(filename)
1992
2058
            filename = self.relpath(abspath)
1993
2059
            if len(filename) > 0:
1994
 
                new_files.add(filename)
 
2060
                all_files.add(filename)
1995
2061
                recurse_directory_to_add_files(filename)
1996
2062
 
1997
 
        files = list(new_files)
 
2063
        files = list(all_files)
1998
2064
 
1999
2065
        if len(files) == 0:
2000
2066
            return # nothing to do
2004
2070
 
2005
2071
        # Bail out if we are going to delete files we shouldn't
2006
2072
        if not keep_files and not force:
2007
 
            has_changed_files = len(unknown_nested_files) > 0
2008
 
            if not has_changed_files:
2009
 
                for (file_id, path, content_change, versioned, parent_id, name,
2010
 
                     kind, executable) in self.iter_changes(self.basis_tree(),
2011
 
                         include_unchanged=True, require_versioned=False,
2012
 
                         want_unversioned=True, specific_files=files):
2013
 
                    if versioned == (False, False):
2014
 
                        # The record is unknown ...
2015
 
                        if not self.is_ignored(path[1]):
2016
 
                            # ... but not ignored
2017
 
                            has_changed_files = True
2018
 
                            break
2019
 
                    elif (content_change and (kind[1] is not None) and
2020
 
                            osutils.is_inside_any(files, path[1])):
2021
 
                        # Versioned and changed, but not deleted, and still
2022
 
                        # in one of the dirs to be deleted.
2023
 
                        has_changed_files = True
2024
 
                        break
 
2073
            for (file_id, path, content_change, versioned, parent_id, name,
 
2074
                 kind, executable) in self.iter_changes(self.basis_tree(),
 
2075
                     include_unchanged=True, require_versioned=False,
 
2076
                     want_unversioned=True, specific_files=files):
 
2077
                if versioned[0] == False:
 
2078
                    # The record is unknown or newly added
 
2079
                    files_to_backup.append(path[1])
 
2080
                elif (content_change and (kind[1] is not None) and
 
2081
                        osutils.is_inside_any(files, path[1])):
 
2082
                    # Versioned and changed, but not deleted, and still
 
2083
                    # in one of the dirs to be deleted.
 
2084
                    files_to_backup.append(path[1])
2025
2085
 
2026
 
            if has_changed_files:
2027
 
                # Make delta show ALL applicable changes in error message.
2028
 
                tree_delta = self.changes_from(self.basis_tree(),
2029
 
                    require_versioned=False, want_unversioned=True,
2030
 
                    specific_files=files)
2031
 
                for unknown_file in unknown_nested_files:
2032
 
                    if unknown_file not in tree_delta.unversioned:
2033
 
                        tree_delta.unversioned.extend((unknown_file,))
2034
 
                raise errors.BzrRemoveChangedFilesError(tree_delta)
 
2086
        def backup(file_to_backup):
 
2087
            backup_name = self.bzrdir._available_backup_name(file_to_backup)
 
2088
            osutils.rename(abs_path, self.abspath(backup_name))
 
2089
            return "removed %s (but kept a copy: %s)" % (file_to_backup,
 
2090
                                                         backup_name)
2035
2091
 
2036
2092
        # Build inv_delta and delete files where applicable,
2037
2093
        # do this before any modifications to inventory.
2061
2117
                        len(os.listdir(abs_path)) > 0):
2062
2118
                        if force:
2063
2119
                            osutils.rmtree(abs_path)
 
2120
                            message = "deleted %s" % (f,)
2064
2121
                        else:
2065
 
                            message = "%s is not an empty directory "\
2066
 
                                "and won't be deleted." % (f,)
 
2122
                            message = backup(f)
2067
2123
                    else:
2068
 
                        osutils.delete_any(abs_path)
2069
 
                        message = "deleted %s" % (f,)
 
2124
                        if f in files_to_backup:
 
2125
                            message = backup(f)
 
2126
                        else:
 
2127
                            osutils.delete_any(abs_path)
 
2128
                            message = "deleted %s" % (f,)
2070
2129
                elif message is not None:
2071
2130
                    # Only care if we haven't done anything yet.
2072
2131
                    message = "%s does not exist." % (f,)
2209
2268
    _marker = object()
2210
2269
 
2211
2270
    def update(self, change_reporter=None, possible_transports=None,
2212
 
               revision=None, old_tip=_marker):
 
2271
               revision=None, old_tip=_marker, show_base=False):
2213
2272
        """Update a working tree along its branch.
2214
2273
 
2215
2274
        This will update the branch if its bound too, which means we have
2252
2311
            else:
2253
2312
                if old_tip is self._marker:
2254
2313
                    old_tip = None
2255
 
            return self._update_tree(old_tip, change_reporter, revision)
 
2314
            return self._update_tree(old_tip, change_reporter, revision, show_base)
2256
2315
        finally:
2257
2316
            self.unlock()
2258
2317
 
2259
2318
    @needs_tree_write_lock
2260
 
    def _update_tree(self, old_tip=None, change_reporter=None, revision=None):
 
2319
    def _update_tree(self, old_tip=None, change_reporter=None, revision=None,
 
2320
                     show_base=False):
2261
2321
        """Update a tree to the master branch.
2262
2322
 
2263
2323
        :param old_tip: if supplied, the previous tip revision the branch,
2290
2350
            other_tree = self.branch.repository.revision_tree(old_tip)
2291
2351
            nb_conflicts = merge.merge_inner(self.branch, other_tree,
2292
2352
                                             base_tree, this_tree=self,
2293
 
                                             change_reporter=change_reporter)
 
2353
                                             change_reporter=change_reporter,
 
2354
                                             show_base=show_base)
2294
2355
            if nb_conflicts:
2295
2356
                self.add_parent_tree((old_tip, other_tree))
2296
2357
                trace.note('Rerun update after fixing the conflicts.')
2320
2381
 
2321
2382
            nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
2322
2383
                                             this_tree=self,
2323
 
                                             change_reporter=change_reporter)
 
2384
                                             change_reporter=change_reporter,
 
2385
                                             show_base=show_base)
2324
2386
            self.set_last_revision(revision)
2325
2387
            # TODO - dedup parents list with things merged by pull ?
2326
2388
            # reuse the tree we've updated to to set the basis:
2367
2429
    def add_conflicts(self, arg):
2368
2430
        raise errors.UnsupportedOperation(self.add_conflicts, self)
2369
2431
 
2370
 
    @needs_read_lock
2371
2432
    def conflicts(self):
2372
 
        conflicts = _mod_conflicts.ConflictList()
2373
 
        for conflicted in self._iter_conflicts():
2374
 
            text = True
2375
 
            try:
2376
 
                if file_kind(self.abspath(conflicted)) != "file":
2377
 
                    text = False
2378
 
            except errors.NoSuchFile:
2379
 
                text = False
2380
 
            if text is True:
2381
 
                for suffix in ('.THIS', '.OTHER'):
2382
 
                    try:
2383
 
                        kind = file_kind(self.abspath(conflicted+suffix))
2384
 
                        if kind != "file":
2385
 
                            text = False
2386
 
                    except errors.NoSuchFile:
2387
 
                        text = False
2388
 
                    if text == False:
2389
 
                        break
2390
 
            ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2391
 
            conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2392
 
                             path=conflicted,
2393
 
                             file_id=self.path2id(conflicted)))
2394
 
        return conflicts
 
2433
        raise NotImplementedError(self.conflicts)
2395
2434
 
2396
2435
    def walkdirs(self, prefix=""):
2397
2436
        """Walk the directories of this tree.
2615
2654
        """
2616
2655
        return
2617
2656
 
 
2657
    @needs_read_lock
 
2658
    def check_state(self):
 
2659
        """Check that the working state is/isn't valid."""
 
2660
        check_refs = self._get_check_refs()
 
2661
        refs = {}
 
2662
        for ref in check_refs:
 
2663
            kind, value = ref
 
2664
            if kind == 'trees':
 
2665
                refs[ref] = self.branch.repository.revision_tree(value)
 
2666
        self._check(refs)
 
2667
 
 
2668
    @needs_tree_write_lock
 
2669
    def reset_state(self, revision_ids=None):
 
2670
        """Reset the state of the working tree.
 
2671
 
 
2672
        This does a hard-reset to a last-known-good state. This is a way to
 
2673
        fix if something got corrupted (like the .bzr/checkout/dirstate file)
 
2674
        """
 
2675
        if revision_ids is None:
 
2676
            revision_ids = self.get_parent_ids()
 
2677
        if not revision_ids:
 
2678
            rt = self.branch.repository.revision_tree(
 
2679
                _mod_revision.NULL_REVISION)
 
2680
        else:
 
2681
            rt = self.branch.repository.revision_tree(revision_ids[0])
 
2682
        self._write_inventory(rt.inventory)
 
2683
        self.set_parent_ids(revision_ids)
 
2684
 
2618
2685
    def _get_rules_searcher(self, default_searcher):
2619
2686
        """See Tree._get_rules_searcher."""
2620
2687
        if self._rules_searcher is None:
2628
2695
        return ShelfManager(self, self._transport)
2629
2696
 
2630
2697
 
2631
 
class WorkingTree2(WorkingTree):
2632
 
    """This is the Format 2 working tree.
2633
 
 
2634
 
    This was the first weave based working tree.
2635
 
     - uses os locks for locking.
2636
 
     - uses the branch last-revision.
2637
 
    """
2638
 
 
2639
 
    def __init__(self, *args, **kwargs):
2640
 
        super(WorkingTree2, self).__init__(*args, **kwargs)
2641
 
        # WorkingTree2 has more of a constraint that self._inventory must
2642
 
        # exist. Because this is an older format, we don't mind the overhead
2643
 
        # caused by the extra computation here.
2644
 
 
2645
 
        # Newer WorkingTree's should only have self._inventory set when they
2646
 
        # have a read lock.
2647
 
        if self._inventory is None:
2648
 
            self.read_working_inventory()
2649
 
 
2650
 
    def _get_check_refs(self):
2651
 
        """Return the references needed to perform a check of this tree."""
2652
 
        return [('trees', self.last_revision())]
2653
 
 
2654
 
    def lock_tree_write(self):
2655
 
        """See WorkingTree.lock_tree_write().
2656
 
 
2657
 
        In Format2 WorkingTrees we have a single lock for the branch and tree
2658
 
        so lock_tree_write() degrades to lock_write().
2659
 
 
2660
 
        :return: An object with an unlock method which will release the lock
2661
 
            obtained.
2662
 
        """
2663
 
        self.branch.lock_write()
2664
 
        try:
2665
 
            self._control_files.lock_write()
2666
 
            return self
2667
 
        except:
2668
 
            self.branch.unlock()
2669
 
            raise
2670
 
 
2671
 
    def unlock(self):
2672
 
        # do non-implementation specific cleanup
2673
 
        self._cleanup()
2674
 
 
2675
 
        # we share control files:
2676
 
        if self._control_files._lock_count == 3:
2677
 
            # _inventory_is_modified is always False during a read lock.
2678
 
            if self._inventory_is_modified:
2679
 
                self.flush()
2680
 
            self._write_hashcache_if_dirty()
2681
 
 
2682
 
        # reverse order of locking.
2683
 
        try:
2684
 
            return self._control_files.unlock()
2685
 
        finally:
2686
 
            self.branch.unlock()
2687
 
 
2688
 
 
2689
2698
class WorkingTree3(WorkingTree):
2690
2699
    """This is the Format 3 working tree.
2691
2700
 
2764
2773
            self.branch.unlock()
2765
2774
 
2766
2775
 
2767
 
def get_conflicted_stem(path):
2768
 
    for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2769
 
        if path.endswith(suffix):
2770
 
            return path[:-len(suffix)]
2771
 
 
2772
 
 
2773
 
class WorkingTreeFormat(object):
 
2776
class WorkingTreeFormatRegistry(controldir.ControlComponentFormatRegistry):
 
2777
    """Registry for working tree formats."""
 
2778
 
 
2779
    def __init__(self, other_registry=None):
 
2780
        super(WorkingTreeFormatRegistry, self).__init__(other_registry)
 
2781
        self._default_format = None
 
2782
 
 
2783
    def get_default(self):
 
2784
        """Return the current default format."""
 
2785
        return self._default_format
 
2786
 
 
2787
    def set_default(self, format):
 
2788
        self._default_format = format
 
2789
 
 
2790
 
 
2791
format_registry = WorkingTreeFormatRegistry()
 
2792
 
 
2793
 
 
2794
class WorkingTreeFormat(controldir.ControlComponentFormat):
2774
2795
    """An encapsulation of the initialization and open routines for a format.
2775
2796
 
2776
2797
    Formats provide three things:
2788
2809
    object will be created every time regardless.
2789
2810
    """
2790
2811
 
2791
 
    _default_format = None
2792
 
    """The default format used for new trees."""
2793
 
 
2794
 
    _formats = {}
2795
 
    """The known formats."""
2796
 
 
2797
2812
    requires_rich_root = False
2798
2813
 
2799
2814
    upgrade_recommended = False
2800
2815
 
 
2816
    requires_normalized_unicode_filenames = False
 
2817
 
 
2818
    case_sensitive_filename = "FoRMaT"
 
2819
 
 
2820
    missing_parent_conflicts = False
 
2821
    """If this format supports missing parent conflicts."""
 
2822
 
2801
2823
    @classmethod
2802
2824
    def find_format(klass, a_bzrdir):
2803
2825
        """Return the format for the working tree object in a_bzrdir."""
2804
2826
        try:
2805
2827
            transport = a_bzrdir.get_workingtree_transport(None)
2806
2828
            format_string = transport.get_bytes("format")
2807
 
            return klass._formats[format_string]
 
2829
            return format_registry.get(format_string)
2808
2830
        except errors.NoSuchFile:
2809
2831
            raise errors.NoWorkingTree(base=transport.base)
2810
2832
        except KeyError:
2811
2833
            raise errors.UnknownFormatError(format=format_string,
2812
2834
                                            kind="working tree")
2813
2835
 
 
2836
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
 
2837
                   accelerator_tree=None, hardlink=False):
 
2838
        """Initialize a new working tree in a_bzrdir.
 
2839
 
 
2840
        :param a_bzrdir: BzrDir to initialize the working tree in.
 
2841
        :param revision_id: allows creating a working tree at a different
 
2842
            revision than the branch is at.
 
2843
        :param from_branch: Branch to checkout
 
2844
        :param accelerator_tree: A tree which can be used for retrieving file
 
2845
            contents more quickly than the revision tree, i.e. a workingtree.
 
2846
            The revision tree will be used for cases where accelerator_tree's
 
2847
            content is different.
 
2848
        :param hardlink: If true, hard-link files from accelerator_tree,
 
2849
            where possible.
 
2850
        """
 
2851
        raise NotImplementedError(self.initialize)
 
2852
 
2814
2853
    def __eq__(self, other):
2815
2854
        return self.__class__ is other.__class__
2816
2855
 
2818
2857
        return not (self == other)
2819
2858
 
2820
2859
    @classmethod
 
2860
    @symbol_versioning.deprecated_method(
 
2861
        symbol_versioning.deprecated_in((2, 4, 0)))
2821
2862
    def get_default_format(klass):
2822
2863
        """Return the current default format."""
2823
 
        return klass._default_format
 
2864
        return format_registry.get_default()
2824
2865
 
2825
2866
    def get_format_string(self):
2826
2867
        """Return the ASCII format string that identifies this format."""
2848
2889
        return False
2849
2890
 
2850
2891
    @classmethod
 
2892
    @symbol_versioning.deprecated_method(
 
2893
        symbol_versioning.deprecated_in((2, 4, 0)))
2851
2894
    def register_format(klass, format):
2852
 
        klass._formats[format.get_format_string()] = format
2853
 
 
2854
 
    @classmethod
 
2895
        format_registry.register(format)
 
2896
 
 
2897
    @classmethod
 
2898
    @symbol_versioning.deprecated_method(
 
2899
        symbol_versioning.deprecated_in((2, 4, 0)))
 
2900
    def register_extra_format(klass, format):
 
2901
        format_registry.register_extra(format)
 
2902
 
 
2903
    @classmethod
 
2904
    @symbol_versioning.deprecated_method(
 
2905
        symbol_versioning.deprecated_in((2, 4, 0)))
 
2906
    def unregister_extra_format(klass, format):
 
2907
        format_registry.unregister_extra(format)
 
2908
 
 
2909
    @classmethod
 
2910
    @symbol_versioning.deprecated_method(
 
2911
        symbol_versioning.deprecated_in((2, 4, 0)))
 
2912
    def get_formats(klass):
 
2913
        return format_registry._get_all()
 
2914
 
 
2915
    @classmethod
 
2916
    @symbol_versioning.deprecated_method(
 
2917
        symbol_versioning.deprecated_in((2, 4, 0)))
2855
2918
    def set_default_format(klass, format):
2856
 
        klass._default_format = format
 
2919
        format_registry.set_default(format)
2857
2920
 
2858
2921
    @classmethod
 
2922
    @symbol_versioning.deprecated_method(
 
2923
        symbol_versioning.deprecated_in((2, 4, 0)))
2859
2924
    def unregister_format(klass, format):
2860
 
        del klass._formats[format.get_format_string()]
2861
 
 
2862
 
 
2863
 
class WorkingTreeFormat2(WorkingTreeFormat):
2864
 
    """The second working tree format.
2865
 
 
2866
 
    This format modified the hash cache from the format 1 hash cache.
2867
 
    """
2868
 
 
2869
 
    upgrade_recommended = True
2870
 
 
2871
 
    def get_format_description(self):
2872
 
        """See WorkingTreeFormat.get_format_description()."""
2873
 
        return "Working tree format 2"
2874
 
 
2875
 
    def _stub_initialize_on_transport(self, transport, file_mode):
2876
 
        """Workaround: create control files for a remote working tree.
2877
 
 
2878
 
        This ensures that it can later be updated and dealt with locally,
2879
 
        since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2880
 
        no working tree.  (See bug #43064).
2881
 
        """
2882
 
        sio = StringIO()
2883
 
        inv = inventory.Inventory()
2884
 
        xml5.serializer_v5.write_inventory(inv, sio, working=True)
2885
 
        sio.seek(0)
2886
 
        transport.put_file('inventory', sio, file_mode)
2887
 
        transport.put_bytes('pending-merges', '', file_mode)
2888
 
 
2889
 
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2890
 
                   accelerator_tree=None, hardlink=False):
2891
 
        """See WorkingTreeFormat.initialize()."""
2892
 
        if not isinstance(a_bzrdir.transport, LocalTransport):
2893
 
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
2894
 
        if from_branch is not None:
2895
 
            branch = from_branch
2896
 
        else:
2897
 
            branch = a_bzrdir.open_branch()
2898
 
        if revision_id is None:
2899
 
            revision_id = _mod_revision.ensure_null(branch.last_revision())
2900
 
        branch.lock_write()
2901
 
        try:
2902
 
            branch.generate_revision_history(revision_id)
2903
 
        finally:
2904
 
            branch.unlock()
2905
 
        inv = inventory.Inventory()
2906
 
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2907
 
                         branch,
2908
 
                         inv,
2909
 
                         _internal=True,
2910
 
                         _format=self,
2911
 
                         _bzrdir=a_bzrdir)
2912
 
        basis_tree = branch.repository.revision_tree(revision_id)
2913
 
        if basis_tree.inventory.root is not None:
2914
 
            wt.set_root_id(basis_tree.get_root_id())
2915
 
        # set the parent list and cache the basis tree.
2916
 
        if _mod_revision.is_null(revision_id):
2917
 
            parent_trees = []
2918
 
        else:
2919
 
            parent_trees = [(revision_id, basis_tree)]
2920
 
        wt.set_parent_trees(parent_trees)
2921
 
        transform.build_tree(basis_tree, wt)
2922
 
        return wt
2923
 
 
2924
 
    def __init__(self):
2925
 
        super(WorkingTreeFormat2, self).__init__()
2926
 
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
2927
 
 
2928
 
    def open(self, a_bzrdir, _found=False):
2929
 
        """Return the WorkingTree object for a_bzrdir
2930
 
 
2931
 
        _found is a private parameter, do not use it. It is used to indicate
2932
 
               if format probing has already been done.
2933
 
        """
2934
 
        if not _found:
2935
 
            # we are being called directly and must probe.
2936
 
            raise NotImplementedError
2937
 
        if not isinstance(a_bzrdir.transport, LocalTransport):
2938
 
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
2939
 
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2940
 
                           _internal=True,
2941
 
                           _format=self,
2942
 
                           _bzrdir=a_bzrdir)
2943
 
        return wt
 
2925
        format_registry.remove(format)
 
2926
 
2944
2927
 
2945
2928
class WorkingTreeFormat3(WorkingTreeFormat):
2946
2929
    """The second working tree format updated to record a format marker.
2956
2939
 
2957
2940
    upgrade_recommended = True
2958
2941
 
 
2942
    missing_parent_conflicts = True
 
2943
 
2959
2944
    def get_format_string(self):
2960
2945
        """See WorkingTreeFormat.get_format_string()."""
2961
2946
        return "Bazaar-NG Working Tree format 3"
3074
3059
 
3075
3060
 
3076
3061
__default_format = WorkingTreeFormat6()
3077
 
WorkingTreeFormat.register_format(__default_format)
3078
 
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3079
 
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3080
 
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3081
 
WorkingTreeFormat.set_default_format(__default_format)
3082
 
# formats which have no format string are not discoverable
3083
 
# and not independently creatable, so are not registered.
3084
 
_legacy_formats = [WorkingTreeFormat2(),
3085
 
                   ]
 
3062
format_registry.register_lazy("Bazaar Working Tree Format 4 (bzr 0.15)\n",
 
3063
    "bzrlib.workingtree_4", "WorkingTreeFormat4")
 
3064
format_registry.register_lazy("Bazaar Working Tree Format 5 (bzr 1.11)\n",
 
3065
    "bzrlib.workingtree_4", "WorkingTreeFormat5")
 
3066
format_registry.register_lazy("Bazaar Working Tree Format 6 (bzr 1.14)\n",
 
3067
    "bzrlib.workingtree_4", "WorkingTreeFormat6")
 
3068
format_registry.register(WorkingTreeFormat3())
 
3069
format_registry.set_default(__default_format)