~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Andrew Bennetts
  • Date: 2011-03-24 00:13:10 UTC
  • mto: This revision was merged to the branch mainline in revision 5739.
  • Revision ID: andrew.bennetts@canonical.com-20110324001310-5w56qjom53j091r3
Minor English tweaks.

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,
168
170
 
169
171
 
170
172
class WorkingTree(bzrlib.mutabletree.MutableTree,
171
 
    bzrdir.ControlComponent):
 
173
    controldir.ControlComponent):
172
174
    """Working copy tree.
173
175
 
174
176
    The inventory is held in the `Branch` working-inventory, and the
208
210
        else:
209
211
            self._branch = self.bzrdir.open_branch()
210
212
        self.basedir = realpath(basedir)
211
 
        # if branch is at our basedir and is a format 6 or less
212
 
        if isinstance(self._format, WorkingTreeFormat2):
213
 
            # share control object
214
 
            self._control_files = self.branch.control_files
215
 
        else:
216
 
            # assume all other formats have their own control files.
217
 
            self._control_files = _control_files
 
213
        self._control_files = _control_files
218
214
        self._transport = self._control_files._transport
219
215
        # update the whole cache up front and write to disk if anything changed;
220
216
        # in the future we might want to do this more selectively
258
254
    def control_transport(self):
259
255
        return self._transport
260
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
 
261
269
    def _detect_case_handling(self):
262
270
        wt_trans = self.bzrdir.get_workingtree_transport(None)
263
271
        try:
264
 
            wt_trans.stat("FoRMaT")
 
272
            wt_trans.stat(self._format.case_sensitive_filename)
265
273
        except errors.NoSuchFile:
266
274
            self.case_sensitive = True
267
275
        else:
352
360
        return control.open_workingtree(), relpath
353
361
 
354
362
    @staticmethod
355
 
    def open_containing_paths(file_list, default_directory='.',
356
 
        canonicalize=True, apply_view=True):
 
363
    def open_containing_paths(file_list, default_directory=None,
 
364
                              canonicalize=True, apply_view=True):
357
365
        """Open the WorkingTree that contains a set of paths.
358
366
 
359
367
        Fail if the paths given are not all in a single tree.
361
369
        This is used for the many command-line interfaces that take a list of
362
370
        any number of files and that require they all be in the same tree.
363
371
        """
 
372
        if default_directory is None:
 
373
            default_directory = u'.'
364
374
        # recommended replacement for builtins.internal_tree_files
365
375
        if file_list is None or len(file_list) == 0:
366
376
            tree = WorkingTree.open_containing(default_directory)[0]
374
384
                    view_str = views.view_display_str(view_files)
375
385
                    note("Ignoring files outside view. View is %s" % view_str)
376
386
            return tree, file_list
377
 
        tree = WorkingTree.open_containing(file_list[0])[0]
 
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]
378
394
        return tree, tree.safe_relpath_files(file_list, canonicalize,
379
 
            apply_view=apply_view)
 
395
                                             apply_view=apply_view)
380
396
 
381
397
    def safe_relpath_files(self, file_list, canonicalize=True, apply_view=True):
382
398
        """Convert file_list into a list of relpaths in tree.
1266
1282
                # absolute path
1267
1283
                fap = from_dir_abspath + '/' + f
1268
1284
 
1269
 
                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
1270
1290
                if f_ie:
1271
1291
                    c = 'V'
1272
1292
                elif self.is_ignored(fp[1:]):
1273
1293
                    c = 'I'
1274
1294
                else:
1275
 
                    # 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.
1276
1297
                    f_norm, can_access = osutils.normalized_filename(f)
1277
1298
                    if f == f_norm or not can_access:
1278
1299
                        # No change, so treat this file normally
1376
1397
        to_dir_id = inv.path2id(to_dir)
1377
1398
        if to_dir_id is None:
1378
1399
            raise errors.BzrMoveFailedError('',to_dir,
1379
 
                errors.NotVersionedError(path=str(to_dir)))
 
1400
                errors.NotVersionedError(path=to_dir))
1380
1401
 
1381
1402
        to_dir_ie = inv[to_dir_id]
1382
1403
        if to_dir_ie.kind != 'directory':
1389
1410
            from_id = inv.path2id(from_rel)
1390
1411
            if from_id is None:
1391
1412
                raise errors.BzrMoveFailedError(from_rel,to_dir,
1392
 
                    errors.NotVersionedError(path=str(from_rel)))
 
1413
                    errors.NotVersionedError(path=from_rel))
1393
1414
 
1394
1415
            from_entry = inv[from_id]
1395
1416
            from_parent_id = from_entry.parent_id
1437
1458
            # check the inventory for source and destination
1438
1459
            if from_id is None:
1439
1460
                raise errors.BzrMoveFailedError(from_rel,to_rel,
1440
 
                    errors.NotVersionedError(path=str(from_rel)))
 
1461
                    errors.NotVersionedError(path=from_rel))
1441
1462
            if to_id is not None:
1442
1463
                raise errors.BzrMoveFailedError(from_rel,to_rel,
1443
 
                    errors.AlreadyVersionedError(path=str(to_rel)))
 
1464
                    errors.AlreadyVersionedError(path=to_rel))
1444
1465
 
1445
1466
            # try to determine the mode for rename (only change inv or change
1446
1467
            # inv and file system)
1447
1468
            if after:
1448
1469
                if not self.has_filename(to_rel):
1449
1470
                    raise errors.BzrMoveFailedError(from_id,to_rel,
1450
 
                        errors.NoSuchFile(path=str(to_rel),
 
1471
                        errors.NoSuchFile(path=to_rel,
1451
1472
                        extra="New file has not been created yet"))
1452
1473
                only_change_inv = True
1453
1474
            elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1555
1576
            from_id = basis_tree.path2id(from_rel)
1556
1577
            if from_id is None:
1557
1578
                raise errors.BzrRenameFailedError(from_rel,to_rel,
1558
 
                    errors.NotVersionedError(path=str(from_rel)))
 
1579
                    errors.NotVersionedError(path=from_rel))
1559
1580
            # put entry back in the inventory so we can rename it
1560
1581
            from_entry = basis_tree.inventory[from_id].copy()
1561
1582
            inv.add(from_entry)
1579
1600
        # versioned
1580
1601
        if to_dir_id is None:
1581
1602
            raise errors.BzrMoveFailedError(from_rel,to_rel,
1582
 
                errors.NotVersionedError(path=str(to_dir)))
 
1603
                errors.NotVersionedError(path=to_dir))
1583
1604
 
1584
1605
        # all checks done. now we can continue with our actual work
1585
1606
        mutter('rename_one:\n'
1644
1665
            # - RBC 20060907
1645
1666
            self._write_inventory(self._inventory)
1646
1667
 
1647
 
    def _iter_conflicts(self):
1648
 
        conflicted = set()
1649
 
        for info in self.list_files():
1650
 
            path = info[0]
1651
 
            stem = get_conflicted_stem(path)
1652
 
            if stem is None:
1653
 
                continue
1654
 
            if stem not in conflicted:
1655
 
                conflicted.add(stem)
1656
 
                yield stem
1657
 
 
1658
1668
    @needs_write_lock
1659
1669
    def pull(self, source, overwrite=False, stop_revision=None,
1660
 
             change_reporter=None, possible_transports=None, local=False):
 
1670
             change_reporter=None, possible_transports=None, local=False,
 
1671
             show_base=False):
1661
1672
        source.lock_read()
1662
1673
        try:
1663
1674
            old_revision_info = self.branch.last_revision_info()
1677
1688
                                basis_tree,
1678
1689
                                this_tree=self,
1679
1690
                                pb=None,
1680
 
                                change_reporter=change_reporter)
 
1691
                                change_reporter=change_reporter,
 
1692
                                show_base=show_base)
1681
1693
                    basis_root_id = basis_tree.get_root_id()
1682
1694
                    new_root_id = new_basis_tree.get_root_id()
1683
1695
                    if basis_root_id != new_root_id:
2019
2031
 
2020
2032
        inv_delta = []
2021
2033
 
2022
 
        new_files=set()
 
2034
        all_files = set() # specified and nested files 
2023
2035
        unknown_nested_files=set()
2024
2036
        if to_file is None:
2025
2037
            to_file = sys.stdout
2026
2038
 
 
2039
        files_to_backup = []
 
2040
 
2027
2041
        def recurse_directory_to_add_files(directory):
2028
2042
            # Recurse directory and add all files
2029
2043
            # so we can check if they have changed.
2030
2044
            for parent_info, file_infos in self.walkdirs(directory):
2031
2045
                for relpath, basename, kind, lstat, fileid, kind in file_infos:
2032
2046
                    # Is it versioned or ignored?
2033
 
                    if self.path2id(relpath) or self.is_ignored(relpath):
 
2047
                    if self.path2id(relpath):
2034
2048
                        # Add nested content for deletion.
2035
 
                        new_files.add(relpath)
 
2049
                        all_files.add(relpath)
2036
2050
                    else:
2037
 
                        # Files which are not versioned and not ignored
 
2051
                        # Files which are not versioned
2038
2052
                        # should be treated as unknown.
2039
 
                        unknown_nested_files.add((relpath, None, kind))
 
2053
                        files_to_backup.append(relpath)
2040
2054
 
2041
2055
        for filename in files:
2042
2056
            # Get file name into canonical form.
2043
2057
            abspath = self.abspath(filename)
2044
2058
            filename = self.relpath(abspath)
2045
2059
            if len(filename) > 0:
2046
 
                new_files.add(filename)
 
2060
                all_files.add(filename)
2047
2061
                recurse_directory_to_add_files(filename)
2048
2062
 
2049
 
        files = list(new_files)
 
2063
        files = list(all_files)
2050
2064
 
2051
2065
        if len(files) == 0:
2052
2066
            return # nothing to do
2056
2070
 
2057
2071
        # Bail out if we are going to delete files we shouldn't
2058
2072
        if not keep_files and not force:
2059
 
            has_changed_files = len(unknown_nested_files) > 0
2060
 
            if not has_changed_files:
2061
 
                for (file_id, path, content_change, versioned, parent_id, name,
2062
 
                     kind, executable) in self.iter_changes(self.basis_tree(),
2063
 
                         include_unchanged=True, require_versioned=False,
2064
 
                         want_unversioned=True, specific_files=files):
2065
 
                    if versioned == (False, False):
2066
 
                        # The record is unknown ...
2067
 
                        if not self.is_ignored(path[1]):
2068
 
                            # ... but not ignored
2069
 
                            has_changed_files = True
2070
 
                            break
2071
 
                    elif (content_change and (kind[1] is not None) and
2072
 
                            osutils.is_inside_any(files, path[1])):
2073
 
                        # Versioned and changed, but not deleted, and still
2074
 
                        # in one of the dirs to be deleted.
2075
 
                        has_changed_files = True
2076
 
                        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])
2077
2085
 
2078
 
            if has_changed_files:
2079
 
                # Make delta show ALL applicable changes in error message.
2080
 
                tree_delta = self.changes_from(self.basis_tree(),
2081
 
                    require_versioned=False, want_unversioned=True,
2082
 
                    specific_files=files)
2083
 
                for unknown_file in unknown_nested_files:
2084
 
                    if unknown_file not in tree_delta.unversioned:
2085
 
                        tree_delta.unversioned.extend((unknown_file,))
2086
 
                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)
2087
2091
 
2088
2092
        # Build inv_delta and delete files where applicable,
2089
2093
        # do this before any modifications to inventory.
2113
2117
                        len(os.listdir(abs_path)) > 0):
2114
2118
                        if force:
2115
2119
                            osutils.rmtree(abs_path)
 
2120
                            message = "deleted %s" % (f,)
2116
2121
                        else:
2117
 
                            message = "%s is not an empty directory "\
2118
 
                                "and won't be deleted." % (f,)
 
2122
                            message = backup(f)
2119
2123
                    else:
2120
 
                        osutils.delete_any(abs_path)
2121
 
                        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,)
2122
2129
                elif message is not None:
2123
2130
                    # Only care if we haven't done anything yet.
2124
2131
                    message = "%s does not exist." % (f,)
2261
2268
    _marker = object()
2262
2269
 
2263
2270
    def update(self, change_reporter=None, possible_transports=None,
2264
 
               revision=None, old_tip=_marker):
 
2271
               revision=None, old_tip=_marker, show_base=False):
2265
2272
        """Update a working tree along its branch.
2266
2273
 
2267
2274
        This will update the branch if its bound too, which means we have
2304
2311
            else:
2305
2312
                if old_tip is self._marker:
2306
2313
                    old_tip = None
2307
 
            return self._update_tree(old_tip, change_reporter, revision)
 
2314
            return self._update_tree(old_tip, change_reporter, revision, show_base)
2308
2315
        finally:
2309
2316
            self.unlock()
2310
2317
 
2311
2318
    @needs_tree_write_lock
2312
 
    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):
2313
2321
        """Update a tree to the master branch.
2314
2322
 
2315
2323
        :param old_tip: if supplied, the previous tip revision the branch,
2342
2350
            other_tree = self.branch.repository.revision_tree(old_tip)
2343
2351
            nb_conflicts = merge.merge_inner(self.branch, other_tree,
2344
2352
                                             base_tree, this_tree=self,
2345
 
                                             change_reporter=change_reporter)
 
2353
                                             change_reporter=change_reporter,
 
2354
                                             show_base=show_base)
2346
2355
            if nb_conflicts:
2347
2356
                self.add_parent_tree((old_tip, other_tree))
2348
2357
                trace.note('Rerun update after fixing the conflicts.')
2372
2381
 
2373
2382
            nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
2374
2383
                                             this_tree=self,
2375
 
                                             change_reporter=change_reporter)
 
2384
                                             change_reporter=change_reporter,
 
2385
                                             show_base=show_base)
2376
2386
            self.set_last_revision(revision)
2377
2387
            # TODO - dedup parents list with things merged by pull ?
2378
2388
            # reuse the tree we've updated to to set the basis:
2419
2429
    def add_conflicts(self, arg):
2420
2430
        raise errors.UnsupportedOperation(self.add_conflicts, self)
2421
2431
 
2422
 
    @needs_read_lock
2423
2432
    def conflicts(self):
2424
 
        conflicts = _mod_conflicts.ConflictList()
2425
 
        for conflicted in self._iter_conflicts():
2426
 
            text = True
2427
 
            try:
2428
 
                if file_kind(self.abspath(conflicted)) != "file":
2429
 
                    text = False
2430
 
            except errors.NoSuchFile:
2431
 
                text = False
2432
 
            if text is True:
2433
 
                for suffix in ('.THIS', '.OTHER'):
2434
 
                    try:
2435
 
                        kind = file_kind(self.abspath(conflicted+suffix))
2436
 
                        if kind != "file":
2437
 
                            text = False
2438
 
                    except errors.NoSuchFile:
2439
 
                        text = False
2440
 
                    if text == False:
2441
 
                        break
2442
 
            ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2443
 
            conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2444
 
                             path=conflicted,
2445
 
                             file_id=self.path2id(conflicted)))
2446
 
        return conflicts
 
2433
        raise NotImplementedError(self.conflicts)
2447
2434
 
2448
2435
    def walkdirs(self, prefix=""):
2449
2436
        """Walk the directories of this tree.
2667
2654
        """
2668
2655
        return
2669
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
 
2670
2685
    def _get_rules_searcher(self, default_searcher):
2671
2686
        """See Tree._get_rules_searcher."""
2672
2687
        if self._rules_searcher is None:
2680
2695
        return ShelfManager(self, self._transport)
2681
2696
 
2682
2697
 
2683
 
class WorkingTree2(WorkingTree):
2684
 
    """This is the Format 2 working tree.
2685
 
 
2686
 
    This was the first weave based working tree.
2687
 
     - uses os locks for locking.
2688
 
     - uses the branch last-revision.
2689
 
    """
2690
 
 
2691
 
    def __init__(self, *args, **kwargs):
2692
 
        super(WorkingTree2, self).__init__(*args, **kwargs)
2693
 
        # WorkingTree2 has more of a constraint that self._inventory must
2694
 
        # exist. Because this is an older format, we don't mind the overhead
2695
 
        # caused by the extra computation here.
2696
 
 
2697
 
        # Newer WorkingTree's should only have self._inventory set when they
2698
 
        # have a read lock.
2699
 
        if self._inventory is None:
2700
 
            self.read_working_inventory()
2701
 
 
2702
 
    def _get_check_refs(self):
2703
 
        """Return the references needed to perform a check of this tree."""
2704
 
        return [('trees', self.last_revision())]
2705
 
 
2706
 
    def lock_tree_write(self):
2707
 
        """See WorkingTree.lock_tree_write().
2708
 
 
2709
 
        In Format2 WorkingTrees we have a single lock for the branch and tree
2710
 
        so lock_tree_write() degrades to lock_write().
2711
 
 
2712
 
        :return: An object with an unlock method which will release the lock
2713
 
            obtained.
2714
 
        """
2715
 
        self.branch.lock_write()
2716
 
        try:
2717
 
            self._control_files.lock_write()
2718
 
            return self
2719
 
        except:
2720
 
            self.branch.unlock()
2721
 
            raise
2722
 
 
2723
 
    def unlock(self):
2724
 
        # do non-implementation specific cleanup
2725
 
        self._cleanup()
2726
 
 
2727
 
        # we share control files:
2728
 
        if self._control_files._lock_count == 3:
2729
 
            # _inventory_is_modified is always False during a read lock.
2730
 
            if self._inventory_is_modified:
2731
 
                self.flush()
2732
 
            self._write_hashcache_if_dirty()
2733
 
 
2734
 
        # reverse order of locking.
2735
 
        try:
2736
 
            return self._control_files.unlock()
2737
 
        finally:
2738
 
            self.branch.unlock()
2739
 
 
2740
 
 
2741
2698
class WorkingTree3(WorkingTree):
2742
2699
    """This is the Format 3 working tree.
2743
2700
 
2816
2773
            self.branch.unlock()
2817
2774
 
2818
2775
 
2819
 
def get_conflicted_stem(path):
2820
 
    for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2821
 
        if path.endswith(suffix):
2822
 
            return path[:-len(suffix)]
2823
 
 
2824
 
 
2825
 
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):
2826
2795
    """An encapsulation of the initialization and open routines for a format.
2827
2796
 
2828
2797
    Formats provide three things:
2840
2809
    object will be created every time regardless.
2841
2810
    """
2842
2811
 
2843
 
    _default_format = None
2844
 
    """The default format used for new trees."""
2845
 
 
2846
 
    _formats = {}
2847
 
    """The known formats."""
2848
 
 
2849
2812
    requires_rich_root = False
2850
2813
 
2851
2814
    upgrade_recommended = False
2852
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
 
2853
2823
    @classmethod
2854
2824
    def find_format(klass, a_bzrdir):
2855
2825
        """Return the format for the working tree object in a_bzrdir."""
2856
2826
        try:
2857
2827
            transport = a_bzrdir.get_workingtree_transport(None)
2858
2828
            format_string = transport.get_bytes("format")
2859
 
            return klass._formats[format_string]
 
2829
            return format_registry.get(format_string)
2860
2830
        except errors.NoSuchFile:
2861
2831
            raise errors.NoWorkingTree(base=transport.base)
2862
2832
        except KeyError:
2863
2833
            raise errors.UnknownFormatError(format=format_string,
2864
2834
                                            kind="working tree")
2865
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
 
2866
2853
    def __eq__(self, other):
2867
2854
        return self.__class__ is other.__class__
2868
2855
 
2870
2857
        return not (self == other)
2871
2858
 
2872
2859
    @classmethod
 
2860
    @symbol_versioning.deprecated_method(
 
2861
        symbol_versioning.deprecated_in((2, 4, 0)))
2873
2862
    def get_default_format(klass):
2874
2863
        """Return the current default format."""
2875
 
        return klass._default_format
 
2864
        return format_registry.get_default()
2876
2865
 
2877
2866
    def get_format_string(self):
2878
2867
        """Return the ASCII format string that identifies this format."""
2900
2889
        return False
2901
2890
 
2902
2891
    @classmethod
 
2892
    @symbol_versioning.deprecated_method(
 
2893
        symbol_versioning.deprecated_in((2, 4, 0)))
2903
2894
    def register_format(klass, format):
2904
 
        klass._formats[format.get_format_string()] = format
2905
 
 
2906
 
    @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)))
2907
2918
    def set_default_format(klass, format):
2908
 
        klass._default_format = format
 
2919
        format_registry.set_default(format)
2909
2920
 
2910
2921
    @classmethod
 
2922
    @symbol_versioning.deprecated_method(
 
2923
        symbol_versioning.deprecated_in((2, 4, 0)))
2911
2924
    def unregister_format(klass, format):
2912
 
        del klass._formats[format.get_format_string()]
2913
 
 
2914
 
 
2915
 
class WorkingTreeFormat2(WorkingTreeFormat):
2916
 
    """The second working tree format.
2917
 
 
2918
 
    This format modified the hash cache from the format 1 hash cache.
2919
 
    """
2920
 
 
2921
 
    upgrade_recommended = True
2922
 
 
2923
 
    def get_format_description(self):
2924
 
        """See WorkingTreeFormat.get_format_description()."""
2925
 
        return "Working tree format 2"
2926
 
 
2927
 
    def _stub_initialize_on_transport(self, transport, file_mode):
2928
 
        """Workaround: create control files for a remote working tree.
2929
 
 
2930
 
        This ensures that it can later be updated and dealt with locally,
2931
 
        since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2932
 
        no working tree.  (See bug #43064).
2933
 
        """
2934
 
        sio = StringIO()
2935
 
        inv = inventory.Inventory()
2936
 
        xml5.serializer_v5.write_inventory(inv, sio, working=True)
2937
 
        sio.seek(0)
2938
 
        transport.put_file('inventory', sio, file_mode)
2939
 
        transport.put_bytes('pending-merges', '', file_mode)
2940
 
 
2941
 
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2942
 
                   accelerator_tree=None, hardlink=False):
2943
 
        """See WorkingTreeFormat.initialize()."""
2944
 
        if not isinstance(a_bzrdir.transport, LocalTransport):
2945
 
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
2946
 
        if from_branch is not None:
2947
 
            branch = from_branch
2948
 
        else:
2949
 
            branch = a_bzrdir.open_branch()
2950
 
        if revision_id is None:
2951
 
            revision_id = _mod_revision.ensure_null(branch.last_revision())
2952
 
        branch.lock_write()
2953
 
        try:
2954
 
            branch.generate_revision_history(revision_id)
2955
 
        finally:
2956
 
            branch.unlock()
2957
 
        inv = inventory.Inventory()
2958
 
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2959
 
                         branch,
2960
 
                         inv,
2961
 
                         _internal=True,
2962
 
                         _format=self,
2963
 
                         _bzrdir=a_bzrdir)
2964
 
        basis_tree = branch.repository.revision_tree(revision_id)
2965
 
        if basis_tree.inventory.root is not None:
2966
 
            wt.set_root_id(basis_tree.get_root_id())
2967
 
        # set the parent list and cache the basis tree.
2968
 
        if _mod_revision.is_null(revision_id):
2969
 
            parent_trees = []
2970
 
        else:
2971
 
            parent_trees = [(revision_id, basis_tree)]
2972
 
        wt.set_parent_trees(parent_trees)
2973
 
        transform.build_tree(basis_tree, wt)
2974
 
        return wt
2975
 
 
2976
 
    def __init__(self):
2977
 
        super(WorkingTreeFormat2, self).__init__()
2978
 
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
2979
 
 
2980
 
    def open(self, a_bzrdir, _found=False):
2981
 
        """Return the WorkingTree object for a_bzrdir
2982
 
 
2983
 
        _found is a private parameter, do not use it. It is used to indicate
2984
 
               if format probing has already been done.
2985
 
        """
2986
 
        if not _found:
2987
 
            # we are being called directly and must probe.
2988
 
            raise NotImplementedError
2989
 
        if not isinstance(a_bzrdir.transport, LocalTransport):
2990
 
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
2991
 
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2992
 
                           _internal=True,
2993
 
                           _format=self,
2994
 
                           _bzrdir=a_bzrdir)
2995
 
        return wt
 
2925
        format_registry.remove(format)
 
2926
 
2996
2927
 
2997
2928
class WorkingTreeFormat3(WorkingTreeFormat):
2998
2929
    """The second working tree format updated to record a format marker.
3008
2939
 
3009
2940
    upgrade_recommended = True
3010
2941
 
 
2942
    missing_parent_conflicts = True
 
2943
 
3011
2944
    def get_format_string(self):
3012
2945
        """See WorkingTreeFormat.get_format_string()."""
3013
2946
        return "Bazaar-NG Working Tree format 3"
3126
3059
 
3127
3060
 
3128
3061
__default_format = WorkingTreeFormat6()
3129
 
WorkingTreeFormat.register_format(__default_format)
3130
 
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3131
 
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3132
 
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3133
 
WorkingTreeFormat.set_default_format(__default_format)
3134
 
# formats which have no format string are not discoverable
3135
 
# and not independently creatable, so are not registered.
3136
 
_legacy_formats = [WorkingTreeFormat2(),
3137
 
                   ]
 
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)