← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/bzrdir.py

  • Committer: Robert Collins
  • Date: 2010-05-06 23:54:05 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506235405-wii4elupfhzl3jvy
Add __str__ to the new helper classes.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/bzrdir.py
1
 
# Copyright (C) 2006-2011 Canonical Ltd
 
1
# Copyright (C) 2006-2010 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
25
25
objects returned.
26
26
"""
27
27
 
 
28
# TODO: Move old formats into a plugin to make this file smaller.
 
29
 
 
30
import os
28
31
import sys
 
32
import warnings
29
33
 
30
34
from bzrlib.lazy_import import lazy_import
31
35
lazy_import(globals(), """
 
36
from stat import S_ISDIR
 
37
import textwrap
 
38
 
32
39
import bzrlib
33
40
from bzrlib import (
34
 
    branch as _mod_branch,
35
 
    cleanup,
 
41
    branch,
 
42
    config,
36
43
    errors,
37
 
    fetch,
38
44
    graph,
39
45
    lockable_files,
40
46
    lockdir,
41
47
    osutils,
42
 
    pyutils,
43
48
    remote,
44
49
    repository,
45
50
    revision as _mod_revision,
46
 
    transport as _mod_transport,
47
51
    ui,
48
52
    urlutils,
 
53
    versionedfile,
49
54
    win32utils,
50
 
    workingtree_3,
 
55
    workingtree,
51
56
    workingtree_4,
52
 
    )
53
 
from bzrlib.repofmt import knitpack_repo
 
57
    xml4,
 
58
    xml5,
 
59
    )
 
60
from bzrlib.osutils import (
 
61
    sha_string,
 
62
    )
 
63
from bzrlib.push import (
 
64
    PushResult,
 
65
    )
 
66
from bzrlib.repofmt import pack_repo
 
67
from bzrlib.smart.client import _SmartClient
 
68
from bzrlib.store.versioned import WeaveStore
 
69
from bzrlib.transactions import WriteTransaction
54
70
from bzrlib.transport import (
55
71
    do_catching_redirections,
 
72
    get_transport,
56
73
    local,
57
74
    )
 
75
from bzrlib.weave import Weave
58
76
""")
59
77
 
60
78
from bzrlib.trace import (
61
79
    mutter,
62
80
    note,
 
81
    warning,
63
82
    )
64
83
 
65
84
from bzrlib import (
66
 
    config,
67
 
    controldir,
68
85
    hooks,
69
86
    registry,
70
 
    )
71
 
from bzrlib.symbol_versioning import (
72
 
    deprecated_in,
73
 
    deprecated_method,
74
 
    )
75
 
 
76
 
 
77
 
class BzrDir(controldir.ControlDir):
 
87
    symbol_versioning,
 
88
    )
 
89
    
 
90
    
 
91
class ControlComponent(object):
 
92
    """Abstract base class for control directory components.
 
93
    
 
94
    This provides interfaces that are common across bzrdirs, 
 
95
    repositories, branches, and workingtree control directories.
 
96
    
 
97
    They all expose two urls and transports: the *user* URL is the 
 
98
    one that stops above the control directory (eg .bzr) and that 
 
99
    should normally be used in messages, and the *control* URL is
 
100
    under that in eg .bzr/checkout and is used to read the control
 
101
    files.
 
102
    
 
103
    This can be used as a mixin and is intended to fit with 
 
104
    foreign formats.
 
105
    """
 
106
    
 
107
    @property
 
108
    def control_transport(self):
 
109
        raise NotImplementedError
 
110
   
 
111
    @property
 
112
    def control_url(self):
 
113
        return self.control_transport.base
 
114
    
 
115
    @property
 
116
    def user_transport(self):
 
117
        raise NotImplementedError
 
118
        
 
119
    @property
 
120
    def user_url(self):
 
121
        return self.user_transport.base
 
122
    
 
123
 
 
124
class BzrDir(ControlComponent):
78
125
    """A .bzr control diretory.
79
126
 
80
127
    BzrDir instances let you create or open any of the things that can be
111
158
                    return
112
159
        thing_to_unlock.break_lock()
113
160
 
 
161
    def can_convert_format(self):
 
162
        """Return true if this bzrdir is one whose format we can convert from."""
 
163
        return True
 
164
 
114
165
    def check_conversion_target(self, target_format):
115
166
        """Check that a bzrdir as a whole can be converted to a new format."""
116
167
        # The only current restriction is that the repository content can be 
123
174
            # No repo, no problem.
124
175
            pass
125
176
 
 
177
    @staticmethod
 
178
    def _check_supported(format, allow_unsupported,
 
179
        recommend_upgrade=True,
 
180
        basedir=None):
 
181
        """Give an error or warning on old formats.
 
182
 
 
183
        :param format: may be any kind of format - workingtree, branch,
 
184
        or repository.
 
185
 
 
186
        :param allow_unsupported: If true, allow opening
 
187
        formats that are strongly deprecated, and which may
 
188
        have limited functionality.
 
189
 
 
190
        :param recommend_upgrade: If true (default), warn
 
191
        the user through the ui object that they may wish
 
192
        to upgrade the object.
 
193
        """
 
194
        # TODO: perhaps move this into a base Format class; it's not BzrDir
 
195
        # specific. mbp 20070323
 
196
        if not allow_unsupported and not format.is_supported():
 
197
            # see open_downlevel to open legacy branches.
 
198
            raise errors.UnsupportedFormatError(format=format)
 
199
        if recommend_upgrade \
 
200
            and getattr(format, 'upgrade_recommended', False):
 
201
            ui.ui_factory.recommend_upgrade(
 
202
                format.get_format_description(),
 
203
                basedir)
 
204
 
 
205
    def clone(self, url, revision_id=None, force_new_repo=False,
 
206
              preserve_stacking=False):
 
207
        """Clone this bzrdir and its contents to url verbatim.
 
208
 
 
209
        :param url: The url create the clone at.  If url's last component does
 
210
            not exist, it will be created.
 
211
        :param revision_id: The tip revision-id to use for any branch or
 
212
            working tree.  If not None, then the clone operation may tune
 
213
            itself to download less data.
 
214
        :param force_new_repo: Do not use a shared repository for the target
 
215
                               even if one is available.
 
216
        :param preserve_stacking: When cloning a stacked branch, stack the
 
217
            new branch on top of the other branch's stacked-on branch.
 
218
        """
 
219
        return self.clone_on_transport(get_transport(url),
 
220
                                       revision_id=revision_id,
 
221
                                       force_new_repo=force_new_repo,
 
222
                                       preserve_stacking=preserve_stacking)
 
223
 
126
224
    def clone_on_transport(self, transport, revision_id=None,
127
225
        force_new_repo=False, preserve_stacking=False, stacked_on=None,
128
 
        create_prefix=False, use_existing_dir=True, no_tree=False):
 
226
        create_prefix=False, use_existing_dir=True):
129
227
        """Clone this bzrdir and its contents to transport verbatim.
130
228
 
131
229
        :param transport: The transport for the location to produce the clone
140
238
        :param create_prefix: Create any missing directories leading up to
141
239
            to_transport.
142
240
        :param use_existing_dir: Use an existing directory if one exists.
143
 
        :param no_tree: If set to true prevents creation of a working tree.
144
241
        """
145
242
        # Overview: put together a broad description of what we want to end up
146
243
        # with; then make as few api calls as possible to do it.
147
 
 
 
244
        
148
245
        # We may want to create a repo/branch/tree, if we do so what format
149
246
        # would we want for each:
150
247
        require_stacking = (stacked_on is not None)
151
248
        format = self.cloning_metadir(require_stacking)
152
 
 
 
249
        
153
250
        # Figure out what objects we want:
154
251
        try:
155
252
            local_repo = self.find_repository()
174
271
        # we should look up the policy needs first, or just use it as a hint,
175
272
        # or something.
176
273
        if local_repo:
177
 
            make_working_trees = local_repo.make_working_trees() and not no_tree
 
274
            make_working_trees = local_repo.make_working_trees()
178
275
            want_shared = local_repo.is_shared()
179
276
            repo_format_name = format.repository_format.network_name()
180
277
        else:
229
326
    # TODO: This should be given a Transport, and should chdir up; otherwise
230
327
    # this will open a new connection.
231
328
    def _make_tail(self, url):
232
 
        t = _mod_transport.get_transport(url)
233
 
        t.ensure_base()
 
329
        t = get_transport(url)
 
330
        t.ensure_base()
 
331
 
 
332
    @classmethod
 
333
    def create(cls, base, format=None, possible_transports=None):
 
334
        """Create a new BzrDir at the url 'base'.
 
335
 
 
336
        :param format: If supplied, the format of branch to create.  If not
 
337
            supplied, the default is used.
 
338
        :param possible_transports: If supplied, a list of transports that
 
339
            can be reused to share a remote connection.
 
340
        """
 
341
        if cls is not BzrDir:
 
342
            raise AssertionError("BzrDir.create always creates the default"
 
343
                " format, not one of %r" % cls)
 
344
        t = get_transport(base, possible_transports)
 
345
        t.ensure_base()
 
346
        if format is None:
 
347
            format = BzrDirFormat.get_default_format()
 
348
        return format.initialize_on_transport(t)
234
349
 
235
350
    @staticmethod
236
351
    def find_bzrdirs(transport, evaluate=None, list_current=None):
239
354
        This is intended primarily as a building block for more sophisticated
240
355
        functionality, like finding trees under a directory, or finding
241
356
        branches that use a given repository.
242
 
 
243
357
        :param evaluate: An optional callable that yields recurse, value,
244
358
            where recurse controls whether this bzrdir is recursed into
245
359
            and value is the value to yield.  By default, all bzrdirs
261
375
            recurse = True
262
376
            try:
263
377
                bzrdir = BzrDir.open_from_transport(current_transport)
264
 
            except (errors.NotBranchError, errors.PermissionDenied):
 
378
            except errors.NotBranchError:
265
379
                pass
266
380
            else:
267
381
                recurse, value = evaluate(bzrdir)
268
382
                yield value
269
383
            try:
270
384
                subdirs = list_current(current_transport)
271
 
            except (errors.NoSuchFile, errors.PermissionDenied):
 
385
            except errors.NoSuchFile:
272
386
                continue
273
387
            if recurse:
274
388
                for subdir in sorted(subdirs, reverse=True):
275
389
                    pending.append(current_transport.clone(subdir))
276
390
 
 
391
    def list_branches(self):
 
392
        """Return a sequence of all branches local to this control directory.
 
393
 
 
394
        """
 
395
        try:
 
396
            return [self.open_branch()]
 
397
        except errors.NotBranchError:
 
398
            return []
 
399
 
277
400
    @staticmethod
278
401
    def find_branches(transport):
279
402
        """Find all branches under a transport.
302
425
                ret.extend(branches)
303
426
        return ret
304
427
 
 
428
    def destroy_repository(self):
 
429
        """Destroy the repository in this BzrDir"""
 
430
        raise NotImplementedError(self.destroy_repository)
 
431
 
 
432
    def create_branch(self, name=None):
 
433
        """Create a branch in this BzrDir.
 
434
 
 
435
        :param name: Name of the colocated branch to create, None for
 
436
            the default branch.
 
437
 
 
438
        The bzrdir's format will control what branch format is created.
 
439
        For more control see BranchFormatXX.create(a_bzrdir).
 
440
        """
 
441
        raise NotImplementedError(self.create_branch)
 
442
 
 
443
    def destroy_branch(self, name=None):
 
444
        """Destroy a branch in this BzrDir.
 
445
        
 
446
        :param name: Name of the branch to destroy, None for the default 
 
447
            branch.
 
448
        """
 
449
        raise NotImplementedError(self.destroy_branch)
 
450
 
305
451
    @staticmethod
306
452
    def create_branch_and_repo(base, force_new_repo=False, format=None):
307
453
        """Create a new BzrDir, Branch and Repository at the url 'base'.
389
535
        policy = self.determine_repository_policy(force_new_repo)
390
536
        return policy.acquire_repository()[0]
391
537
 
392
 
    def _find_source_repo(self, add_cleanup, source_branch):
393
 
        """Find the source branch and repo for a sprout operation.
394
 
        
395
 
        This is helper intended for use by _sprout.
396
 
 
397
 
        :returns: (source_branch, source_repository).  Either or both may be
398
 
            None.  If not None, they will be read-locked (and their unlock(s)
399
 
            scheduled via the add_cleanup param).
400
 
        """
401
 
        if source_branch is not None:
402
 
            add_cleanup(source_branch.lock_read().unlock)
403
 
            return source_branch, source_branch.repository
404
 
        try:
405
 
            source_branch = self.open_branch()
406
 
            source_repository = source_branch.repository
407
 
        except errors.NotBranchError:
408
 
            source_branch = None
409
 
            try:
410
 
                source_repository = self.open_repository()
411
 
            except errors.NoRepositoryPresent:
412
 
                source_repository = None
413
 
            else:
414
 
                add_cleanup(source_repository.lock_read().unlock)
415
 
        else:
416
 
            add_cleanup(source_branch.lock_read().unlock)
417
 
        return source_branch, source_repository
418
 
 
419
 
    def sprout(self, url, revision_id=None, force_new_repo=False,
420
 
               recurse='down', possible_transports=None,
421
 
               accelerator_tree=None, hardlink=False, stacked=False,
422
 
               source_branch=None, create_tree_if_local=True):
423
 
        """Create a copy of this controldir prepared for use as a new line of
424
 
        development.
425
 
 
426
 
        If url's last component does not exist, it will be created.
427
 
 
428
 
        Attributes related to the identity of the source branch like
429
 
        branch nickname will be cleaned, a working tree is created
430
 
        whether one existed before or not; and a local branch is always
431
 
        created.
432
 
 
433
 
        if revision_id is not None, then the clone operation may tune
434
 
            itself to download less data.
435
 
 
436
 
        :param accelerator_tree: A tree which can be used for retrieving file
437
 
            contents more quickly than the revision tree, i.e. a workingtree.
438
 
            The revision tree will be used for cases where accelerator_tree's
439
 
            content is different.
440
 
        :param hardlink: If true, hard-link files from accelerator_tree,
441
 
            where possible.
442
 
        :param stacked: If true, create a stacked branch referring to the
443
 
            location of this control directory.
444
 
        :param create_tree_if_local: If true, a working-tree will be created
445
 
            when working locally.
446
 
        """
447
 
        operation = cleanup.OperationWithCleanups(self._sprout)
448
 
        return operation.run(url, revision_id=revision_id,
449
 
            force_new_repo=force_new_repo, recurse=recurse,
450
 
            possible_transports=possible_transports,
451
 
            accelerator_tree=accelerator_tree, hardlink=hardlink,
452
 
            stacked=stacked, source_branch=source_branch,
453
 
            create_tree_if_local=create_tree_if_local)
454
 
 
455
 
    def _sprout(self, op, url, revision_id=None, force_new_repo=False,
456
 
               recurse='down', possible_transports=None,
457
 
               accelerator_tree=None, hardlink=False, stacked=False,
458
 
               source_branch=None, create_tree_if_local=True):
459
 
        add_cleanup = op.add_cleanup
460
 
        fetch_spec_factory = fetch.FetchSpecFactory()
461
 
        if revision_id is not None:
462
 
            fetch_spec_factory.add_revision_ids([revision_id])
463
 
            fetch_spec_factory.source_branch_stop_revision_id = revision_id
464
 
        target_transport = _mod_transport.get_transport(url,
465
 
            possible_transports)
466
 
        target_transport.ensure_base()
467
 
        cloning_format = self.cloning_metadir(stacked)
468
 
        # Create/update the result branch
469
 
        result = cloning_format.initialize_on_transport(target_transport)
470
 
        source_branch, source_repository = self._find_source_repo(
471
 
            add_cleanup, source_branch)
472
 
        fetch_spec_factory.source_branch = source_branch
473
 
        # if a stacked branch wasn't requested, we don't create one
474
 
        # even if the origin was stacked
475
 
        if stacked and source_branch is not None:
476
 
            stacked_branch_url = self.root_transport.base
477
 
        else:
478
 
            stacked_branch_url = None
479
 
        repository_policy = result.determine_repository_policy(
480
 
            force_new_repo, stacked_branch_url, require_stacking=stacked)
481
 
        result_repo, is_new_repo = repository_policy.acquire_repository()
482
 
        add_cleanup(result_repo.lock_write().unlock)
483
 
        fetch_spec_factory.source_repo = source_repository
484
 
        fetch_spec_factory.target_repo = result_repo
485
 
        if stacked or (len(result_repo._fallback_repositories) != 0):
486
 
            target_repo_kind = fetch.TargetRepoKinds.STACKED
487
 
        elif is_new_repo:
488
 
            target_repo_kind = fetch.TargetRepoKinds.EMPTY
489
 
        else:
490
 
            target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
491
 
        fetch_spec_factory.target_repo_kind = target_repo_kind
492
 
        if source_repository is not None:
493
 
            fetch_spec = fetch_spec_factory.make_fetch_spec()
494
 
            result_repo.fetch(source_repository, fetch_spec=fetch_spec)
495
 
 
496
 
        if source_branch is None:
497
 
            # this is for sprouting a controldir without a branch; is that
498
 
            # actually useful?
499
 
            # Not especially, but it's part of the contract.
500
 
            result_branch = result.create_branch()
501
 
        else:
502
 
            result_branch = source_branch.sprout(result,
503
 
                revision_id=revision_id, repository_policy=repository_policy,
504
 
                repository=result_repo)
505
 
        mutter("created new branch %r" % (result_branch,))
506
 
 
507
 
        # Create/update the result working tree
508
 
        if (create_tree_if_local and
509
 
            isinstance(target_transport, local.LocalTransport) and
510
 
            (result_repo is None or result_repo.make_working_trees())):
511
 
            wt = result.create_workingtree(accelerator_tree=accelerator_tree,
512
 
                hardlink=hardlink, from_branch=result_branch)
513
 
            wt.lock_write()
514
 
            try:
515
 
                if wt.path2id('') is None:
516
 
                    try:
517
 
                        wt.set_root_id(self.open_workingtree.get_root_id())
518
 
                    except errors.NoWorkingTree:
519
 
                        pass
520
 
            finally:
521
 
                wt.unlock()
522
 
        else:
523
 
            wt = None
524
 
        if recurse == 'down':
525
 
            basis = None
526
 
            if wt is not None:
527
 
                basis = wt.basis_tree()
528
 
            elif result_branch is not None:
529
 
                basis = result_branch.basis_tree()
530
 
            elif source_branch is not None:
531
 
                basis = source_branch.basis_tree()
532
 
            if basis is not None:
533
 
                add_cleanup(basis.lock_read().unlock)
534
 
                subtrees = basis.iter_references()
535
 
            else:
536
 
                subtrees = []
537
 
            for path, file_id in subtrees:
538
 
                target = urlutils.join(url, urlutils.escape(path))
539
 
                sublocation = source_branch.reference_parent(file_id, path)
540
 
                sublocation.bzrdir.sprout(target,
541
 
                    basis.get_reference_revision(file_id, path),
542
 
                    force_new_repo=force_new_repo, recurse=recurse,
543
 
                    stacked=stacked)
544
 
        return result
545
 
 
546
 
 
547
 
 
548
538
    @staticmethod
549
539
    def create_branch_convenience(base, force_new_repo=False,
550
540
                                  force_new_tree=None, format=None,
576
566
        """
577
567
        if force_new_tree:
578
568
            # check for non local urls
579
 
            t = _mod_transport.get_transport(base, possible_transports)
 
569
            t = get_transport(base, possible_transports)
580
570
            if not isinstance(t, local.LocalTransport):
581
571
                raise errors.NotLocalUrl(base)
582
572
        bzrdir = BzrDir.create(base, format, possible_transports)
604
594
        :param format: Override for the bzrdir format to create.
605
595
        :return: The WorkingTree object.
606
596
        """
607
 
        t = _mod_transport.get_transport(base)
 
597
        t = get_transport(base)
608
598
        if not isinstance(t, local.LocalTransport):
609
599
            raise errors.NotLocalUrl(base)
610
600
        bzrdir = BzrDir.create_branch_and_repo(base,
612
602
                                               format=format).bzrdir
613
603
        return bzrdir.create_workingtree()
614
604
 
615
 
    @deprecated_method(deprecated_in((2, 3, 0)))
616
 
    def generate_backup_name(self, base):
617
 
        return self._available_backup_name(base)
618
 
 
619
 
    def _available_backup_name(self, base):
620
 
        """Find a non-existing backup file name based on base.
621
 
 
622
 
        See bzrlib.osutils.available_backup_name about race conditions.
 
605
    def create_workingtree(self, revision_id=None, from_branch=None,
 
606
        accelerator_tree=None, hardlink=False):
 
607
        """Create a working tree at this BzrDir.
 
608
 
 
609
        :param revision_id: create it as of this revision id.
 
610
        :param from_branch: override bzrdir branch (for lightweight checkouts)
 
611
        :param accelerator_tree: A tree which can be used for retrieving file
 
612
            contents more quickly than the revision tree, i.e. a workingtree.
 
613
            The revision tree will be used for cases where accelerator_tree's
 
614
            content is different.
623
615
        """
624
 
        return osutils.available_backup_name(base, self.root_transport.has)
 
616
        raise NotImplementedError(self.create_workingtree)
625
617
 
626
618
    def backup_bzrdir(self):
627
619
        """Backup this bzr control directory.
628
620
 
629
621
        :return: Tuple with old path name and new path name
630
622
        """
 
623
        def name_gen(base='backup.bzr'):
 
624
            counter = 1
 
625
            name = "%s.~%d~" % (base, counter)
 
626
            while self.root_transport.has(name):
 
627
                counter += 1
 
628
                name = "%s.~%d~" % (base, counter)
 
629
            return name
631
630
 
 
631
        backup_dir=name_gen()
632
632
        pb = ui.ui_factory.nested_progress_bar()
633
633
        try:
 
634
            # FIXME: bug 300001 -- the backup fails if the backup directory
 
635
            # already exists, but it should instead either remove it or make
 
636
            # a new backup directory.
 
637
            #
634
638
            old_path = self.root_transport.abspath('.bzr')
635
 
            backup_dir = self._available_backup_name('backup.bzr')
636
639
            new_path = self.root_transport.abspath(backup_dir)
637
 
            ui.ui_factory.note('making backup of %s\n  to %s'
638
 
                               % (old_path, new_path,))
 
640
            ui.ui_factory.note('making backup of %s\n  to %s' % (old_path, new_path,))
639
641
            self.root_transport.copy_tree('.bzr', backup_dir)
640
642
            return (old_path, new_path)
641
643
        finally:
666
668
                else:
667
669
                    pass
668
670
 
 
671
    def destroy_workingtree(self):
 
672
        """Destroy the working tree at this BzrDir.
 
673
 
 
674
        Formats that do not support this may raise UnsupportedOperation.
 
675
        """
 
676
        raise NotImplementedError(self.destroy_workingtree)
 
677
 
 
678
    def destroy_workingtree_metadata(self):
 
679
        """Destroy the control files for the working tree at this BzrDir.
 
680
 
 
681
        The contents of working tree files are not affected.
 
682
        Formats that do not support this may raise UnsupportedOperation.
 
683
        """
 
684
        raise NotImplementedError(self.destroy_workingtree_metadata)
 
685
 
669
686
    def _find_containing(self, evaluate):
670
687
        """Find something in a containing control directory.
671
688
 
720
737
            raise errors.NoRepositoryPresent(self)
721
738
        return found_repo
722
739
 
 
740
    def get_branch_reference(self):
 
741
        """Return the referenced URL for the branch in this bzrdir.
 
742
 
 
743
        :raises NotBranchError: If there is no Branch.
 
744
        :return: The URL the branch in this bzrdir references if it is a
 
745
            reference branch, or None for regular branches.
 
746
        """
 
747
        return None
 
748
 
 
749
    def get_branch_transport(self, branch_format, name=None):
 
750
        """Get the transport for use by branch format in this BzrDir.
 
751
 
 
752
        Note that bzr dirs that do not support format strings will raise
 
753
        IncompatibleFormat if the branch format they are given has
 
754
        a format string, and vice versa.
 
755
 
 
756
        If branch_format is None, the transport is returned with no
 
757
        checking. If it is not None, then the returned transport is
 
758
        guaranteed to point to an existing directory ready for use.
 
759
        """
 
760
        raise NotImplementedError(self.get_branch_transport)
 
761
 
723
762
    def _find_creation_modes(self):
724
763
        """Determine the appropriate modes for files and directories.
725
764
 
764
803
            self._find_creation_modes()
765
804
        return self._dir_mode
766
805
 
 
806
    def get_repository_transport(self, repository_format):
 
807
        """Get the transport for use by repository format in this BzrDir.
 
808
 
 
809
        Note that bzr dirs that do not support format strings will raise
 
810
        IncompatibleFormat if the repository format they are given has
 
811
        a format string, and vice versa.
 
812
 
 
813
        If repository_format is None, the transport is returned with no
 
814
        checking. If it is not None, then the returned transport is
 
815
        guaranteed to point to an existing directory ready for use.
 
816
        """
 
817
        raise NotImplementedError(self.get_repository_transport)
 
818
 
 
819
    def get_workingtree_transport(self, tree_format):
 
820
        """Get the transport for use by workingtree format in this BzrDir.
 
821
 
 
822
        Note that bzr dirs that do not support format strings will raise
 
823
        IncompatibleFormat if the workingtree format they are given has a
 
824
        format string, and vice versa.
 
825
 
 
826
        If workingtree_format is None, the transport is returned with no
 
827
        checking. If it is not None, then the returned transport is
 
828
        guaranteed to point to an existing directory ready for use.
 
829
        """
 
830
        raise NotImplementedError(self.get_workingtree_transport)
 
831
 
767
832
    def get_config(self):
768
833
        """Get configuration for this BzrDir."""
769
834
        return config.BzrDirConfig(self)
787
852
        self.transport = _transport.clone('.bzr')
788
853
        self.root_transport = _transport
789
854
        self._mode_check_done = False
790
 
 
 
855
        
791
856
    @property 
792
857
    def user_transport(self):
793
858
        return self.root_transport
794
 
 
 
859
        
795
860
    @property
796
861
    def control_transport(self):
797
862
        return self.transport
803
868
 
804
869
        This is true IF and ONLY IF the filename is part of the namespace reserved
805
870
        for bzr control dirs. Currently this is the '.bzr' directory in the root
806
 
        of the root_transport. 
 
871
        of the root_transport. it is expected that plugins will need to extend
 
872
        this in the future - for instance to make bzr talk with svn working
 
873
        trees.
807
874
        """
808
875
        # this might be better on the BzrDirFormat class because it refers to
809
876
        # all the possible bzrdir disk formats.
813
880
        # add new tests for it to the appropriate place.
814
881
        return filename == '.bzr' or filename.startswith('.bzr/')
815
882
 
 
883
    def needs_format_conversion(self, format=None):
 
884
        """Return true if this bzrdir needs convert_format run on it.
 
885
 
 
886
        For instance, if the repository format is out of date but the
 
887
        branch and working tree are not, this should return True.
 
888
 
 
889
        :param format: Optional parameter indicating a specific desired
 
890
                       format we plan to arrive at.
 
891
        """
 
892
        raise NotImplementedError(self.needs_format_conversion)
 
893
 
816
894
    @staticmethod
817
895
    def open_unsupported(base):
818
896
        """Open a branch which is not supported."""
824
902
 
825
903
        :param _unsupported: a private parameter to the BzrDir class.
826
904
        """
827
 
        t = _mod_transport.get_transport(base, possible_transports)
 
905
        t = get_transport(base, possible_transports=possible_transports)
828
906
        return BzrDir.open_from_transport(t, _unsupported=_unsupported)
829
907
 
830
908
    @staticmethod
841
919
        # the redirections.
842
920
        base = transport.base
843
921
        def find_format(transport):
844
 
            return transport, controldir.ControlDirFormat.find_format(
 
922
            return transport, BzrDirFormat.find_format(
845
923
                transport, _server_formats=_server_formats)
846
924
 
847
925
        def redirected(transport, e, redirection_notice):
859
937
        except errors.TooManyRedirections:
860
938
            raise errors.NotBranchError(base)
861
939
 
862
 
        format.check_support_status(_unsupported)
 
940
        BzrDir._check_supported(format, _unsupported)
863
941
        return format.open(transport, _found=True)
864
942
 
 
943
    def open_branch(self, name=None, unsupported=False,
 
944
                    ignore_fallbacks=False):
 
945
        """Open the branch object at this BzrDir if one is present.
 
946
 
 
947
        If unsupported is True, then no longer supported branch formats can
 
948
        still be opened.
 
949
 
 
950
        TODO: static convenience version of this?
 
951
        """
 
952
        raise NotImplementedError(self.open_branch)
 
953
 
865
954
    @staticmethod
866
955
    def open_containing(url, possible_transports=None):
867
956
        """Open an existing branch which contains url.
868
957
 
869
958
        :param url: url to search from.
870
 
 
871
959
        See open_containing_from_transport for more detail.
872
960
        """
873
 
        transport = _mod_transport.get_transport(url, possible_transports)
 
961
        transport = get_transport(url, possible_transports)
874
962
        return BzrDir.open_containing_from_transport(transport)
875
963
 
876
964
    @staticmethod
906
994
                raise errors.NotBranchError(path=url)
907
995
            a_transport = new_t
908
996
 
 
997
    def _get_tree_branch(self):
 
998
        """Return the branch and tree, if any, for this bzrdir.
 
999
 
 
1000
        Return None for tree if not present or inaccessible.
 
1001
        Raise NotBranchError if no branch is present.
 
1002
        :return: (tree, branch)
 
1003
        """
 
1004
        try:
 
1005
            tree = self.open_workingtree()
 
1006
        except (errors.NoWorkingTree, errors.NotLocalUrl):
 
1007
            tree = None
 
1008
            branch = self.open_branch()
 
1009
        else:
 
1010
            branch = tree.branch
 
1011
        return tree, branch
 
1012
 
909
1013
    @classmethod
910
1014
    def open_tree_or_branch(klass, location):
911
1015
        """Return the branch and working tree at a location.
957
1061
                raise errors.NotBranchError(location)
958
1062
        return tree, branch, branch.repository, relpath
959
1063
 
 
1064
    def open_repository(self, _unsupported=False):
 
1065
        """Open the repository object at this BzrDir if one is present.
 
1066
 
 
1067
        This will not follow the Branch object pointer - it's strictly a direct
 
1068
        open facility. Most client code should use open_branch().repository to
 
1069
        get at a repository.
 
1070
 
 
1071
        :param _unsupported: a private parameter, not part of the api.
 
1072
        TODO: static convenience version of this?
 
1073
        """
 
1074
        raise NotImplementedError(self.open_repository)
 
1075
 
 
1076
    def open_workingtree(self, _unsupported=False,
 
1077
                         recommend_upgrade=True, from_branch=None):
 
1078
        """Open the workingtree object at this BzrDir if one is present.
 
1079
 
 
1080
        :param recommend_upgrade: Optional keyword parameter, when True (the
 
1081
            default), emit through the ui module a recommendation that the user
 
1082
            upgrade the working tree when the workingtree being opened is old
 
1083
            (but still fully supported).
 
1084
        :param from_branch: override bzrdir branch (for lightweight checkouts)
 
1085
        """
 
1086
        raise NotImplementedError(self.open_workingtree)
 
1087
 
 
1088
    def has_branch(self, name=None):
 
1089
        """Tell if this bzrdir contains a branch.
 
1090
 
 
1091
        Note: if you're going to open the branch, you should just go ahead
 
1092
        and try, and not ask permission first.  (This method just opens the
 
1093
        branch and discards it, and that's somewhat expensive.)
 
1094
        """
 
1095
        try:
 
1096
            self.open_branch(name)
 
1097
            return True
 
1098
        except errors.NotBranchError:
 
1099
            return False
 
1100
 
 
1101
    def has_workingtree(self):
 
1102
        """Tell if this bzrdir contains a working tree.
 
1103
 
 
1104
        This will still raise an exception if the bzrdir has a workingtree that
 
1105
        is remote & inaccessible.
 
1106
 
 
1107
        Note: if you're going to open the working tree, you should just go ahead
 
1108
        and try, and not ask permission first.  (This method just opens the
 
1109
        workingtree and discards it, and that's somewhat expensive.)
 
1110
        """
 
1111
        try:
 
1112
            self.open_workingtree(recommend_upgrade=False)
 
1113
            return True
 
1114
        except errors.NoWorkingTree:
 
1115
            return False
 
1116
 
960
1117
    def _cloning_metadir(self):
961
1118
        """Produce a metadir suitable for cloning with.
962
1119
 
1020
1177
            format.require_stacking()
1021
1178
        return format
1022
1179
 
1023
 
    @classmethod
1024
 
    def create(cls, base, format=None, possible_transports=None):
1025
 
        """Create a new BzrDir at the url 'base'.
1026
 
 
1027
 
        :param format: If supplied, the format of branch to create.  If not
1028
 
            supplied, the default is used.
1029
 
        :param possible_transports: If supplied, a list of transports that
1030
 
            can be reused to share a remote connection.
1031
 
        """
1032
 
        if cls is not BzrDir:
1033
 
            raise AssertionError("BzrDir.create always creates the"
1034
 
                "default format, not one of %r" % cls)
1035
 
        t = _mod_transport.get_transport(base, possible_transports)
1036
 
        t.ensure_base()
1037
 
        if format is None:
1038
 
            format = controldir.ControlDirFormat.get_default_format()
1039
 
        return format.initialize_on_transport(t)
1040
 
 
1041
 
    def get_branch_transport(self, branch_format, name=None):
1042
 
        """Get the transport for use by branch format in this BzrDir.
1043
 
 
1044
 
        Note that bzr dirs that do not support format strings will raise
1045
 
        IncompatibleFormat if the branch format they are given has
1046
 
        a format string, and vice versa.
1047
 
 
1048
 
        If branch_format is None, the transport is returned with no
1049
 
        checking. If it is not None, then the returned transport is
1050
 
        guaranteed to point to an existing directory ready for use.
1051
 
        """
1052
 
        raise NotImplementedError(self.get_branch_transport)
1053
 
 
1054
 
    def get_repository_transport(self, repository_format):
1055
 
        """Get the transport for use by repository format in this BzrDir.
1056
 
 
1057
 
        Note that bzr dirs that do not support format strings will raise
1058
 
        IncompatibleFormat if the repository format they are given has
1059
 
        a format string, and vice versa.
1060
 
 
1061
 
        If repository_format is None, the transport is returned with no
1062
 
        checking. If it is not None, then the returned transport is
1063
 
        guaranteed to point to an existing directory ready for use.
1064
 
        """
1065
 
        raise NotImplementedError(self.get_repository_transport)
1066
 
 
1067
 
    def get_workingtree_transport(self, tree_format):
1068
 
        """Get the transport for use by workingtree format in this BzrDir.
1069
 
 
1070
 
        Note that bzr dirs that do not support format strings will raise
1071
 
        IncompatibleFormat if the workingtree format they are given has a
1072
 
        format string, and vice versa.
1073
 
 
1074
 
        If workingtree_format is None, the transport is returned with no
1075
 
        checking. If it is not None, then the returned transport is
1076
 
        guaranteed to point to an existing directory ready for use.
1077
 
        """
1078
 
        raise NotImplementedError(self.get_workingtree_transport)
 
1180
    def checkout_metadir(self):
 
1181
        return self.cloning_metadir()
 
1182
 
 
1183
    def sprout(self, url, revision_id=None, force_new_repo=False,
 
1184
               recurse='down', possible_transports=None,
 
1185
               accelerator_tree=None, hardlink=False, stacked=False,
 
1186
               source_branch=None, create_tree_if_local=True):
 
1187
        """Create a copy of this bzrdir prepared for use as a new line of
 
1188
        development.
 
1189
 
 
1190
        If url's last component does not exist, it will be created.
 
1191
 
 
1192
        Attributes related to the identity of the source branch like
 
1193
        branch nickname will be cleaned, a working tree is created
 
1194
        whether one existed before or not; and a local branch is always
 
1195
        created.
 
1196
 
 
1197
        if revision_id is not None, then the clone operation may tune
 
1198
            itself to download less data.
 
1199
        :param accelerator_tree: A tree which can be used for retrieving file
 
1200
            contents more quickly than the revision tree, i.e. a workingtree.
 
1201
            The revision tree will be used for cases where accelerator_tree's
 
1202
            content is different.
 
1203
        :param hardlink: If true, hard-link files from accelerator_tree,
 
1204
            where possible.
 
1205
        :param stacked: If true, create a stacked branch referring to the
 
1206
            location of this control directory.
 
1207
        :param create_tree_if_local: If true, a working-tree will be created
 
1208
            when working locally.
 
1209
        """
 
1210
        target_transport = get_transport(url, possible_transports)
 
1211
        target_transport.ensure_base()
 
1212
        cloning_format = self.cloning_metadir(stacked)
 
1213
        # Create/update the result branch
 
1214
        result = cloning_format.initialize_on_transport(target_transport)
 
1215
        # if a stacked branch wasn't requested, we don't create one
 
1216
        # even if the origin was stacked
 
1217
        stacked_branch_url = None
 
1218
        if source_branch is not None:
 
1219
            if stacked:
 
1220
                stacked_branch_url = self.root_transport.base
 
1221
            source_repository = source_branch.repository
 
1222
        else:
 
1223
            try:
 
1224
                source_branch = self.open_branch()
 
1225
                source_repository = source_branch.repository
 
1226
                if stacked:
 
1227
                    stacked_branch_url = self.root_transport.base
 
1228
            except errors.NotBranchError:
 
1229
                source_branch = None
 
1230
                try:
 
1231
                    source_repository = self.open_repository()
 
1232
                except errors.NoRepositoryPresent:
 
1233
                    source_repository = None
 
1234
        repository_policy = result.determine_repository_policy(
 
1235
            force_new_repo, stacked_branch_url, require_stacking=stacked)
 
1236
        result_repo, is_new_repo = repository_policy.acquire_repository()
 
1237
        if is_new_repo and revision_id is not None and not stacked:
 
1238
            fetch_spec = graph.PendingAncestryResult(
 
1239
                [revision_id], source_repository)
 
1240
        else:
 
1241
            fetch_spec = None
 
1242
        if source_repository is not None:
 
1243
            # Fetch while stacked to prevent unstacked fetch from
 
1244
            # Branch.sprout.
 
1245
            if fetch_spec is None:
 
1246
                result_repo.fetch(source_repository, revision_id=revision_id)
 
1247
            else:
 
1248
                result_repo.fetch(source_repository, fetch_spec=fetch_spec)
 
1249
 
 
1250
        if source_branch is None:
 
1251
            # this is for sprouting a bzrdir without a branch; is that
 
1252
            # actually useful?
 
1253
            # Not especially, but it's part of the contract.
 
1254
            result_branch = result.create_branch()
 
1255
        else:
 
1256
            result_branch = source_branch.sprout(result,
 
1257
                revision_id=revision_id, repository_policy=repository_policy)
 
1258
        mutter("created new branch %r" % (result_branch,))
 
1259
 
 
1260
        # Create/update the result working tree
 
1261
        if (create_tree_if_local and
 
1262
            isinstance(target_transport, local.LocalTransport) and
 
1263
            (result_repo is None or result_repo.make_working_trees())):
 
1264
            wt = result.create_workingtree(accelerator_tree=accelerator_tree,
 
1265
                hardlink=hardlink)
 
1266
            wt.lock_write()
 
1267
            try:
 
1268
                if wt.path2id('') is None:
 
1269
                    try:
 
1270
                        wt.set_root_id(self.open_workingtree.get_root_id())
 
1271
                    except errors.NoWorkingTree:
 
1272
                        pass
 
1273
            finally:
 
1274
                wt.unlock()
 
1275
        else:
 
1276
            wt = None
 
1277
        if recurse == 'down':
 
1278
            if wt is not None:
 
1279
                basis = wt.basis_tree()
 
1280
                basis.lock_read()
 
1281
                subtrees = basis.iter_references()
 
1282
            elif result_branch is not None:
 
1283
                basis = result_branch.basis_tree()
 
1284
                basis.lock_read()
 
1285
                subtrees = basis.iter_references()
 
1286
            elif source_branch is not None:
 
1287
                basis = source_branch.basis_tree()
 
1288
                basis.lock_read()
 
1289
                subtrees = basis.iter_references()
 
1290
            else:
 
1291
                subtrees = []
 
1292
                basis = None
 
1293
            try:
 
1294
                for path, file_id in subtrees:
 
1295
                    target = urlutils.join(url, urlutils.escape(path))
 
1296
                    sublocation = source_branch.reference_parent(file_id, path)
 
1297
                    sublocation.bzrdir.sprout(target,
 
1298
                        basis.get_reference_revision(file_id, path),
 
1299
                        force_new_repo=force_new_repo, recurse=recurse,
 
1300
                        stacked=stacked)
 
1301
            finally:
 
1302
                if basis is not None:
 
1303
                    basis.unlock()
 
1304
        return result
 
1305
 
 
1306
    def push_branch(self, source, revision_id=None, overwrite=False, 
 
1307
        remember=False, create_prefix=False):
 
1308
        """Push the source branch into this BzrDir."""
 
1309
        br_to = None
 
1310
        # If we can open a branch, use its direct repository, otherwise see
 
1311
        # if there is a repository without a branch.
 
1312
        try:
 
1313
            br_to = self.open_branch()
 
1314
        except errors.NotBranchError:
 
1315
            # Didn't find a branch, can we find a repository?
 
1316
            repository_to = self.find_repository()
 
1317
        else:
 
1318
            # Found a branch, so we must have found a repository
 
1319
            repository_to = br_to.repository
 
1320
 
 
1321
        push_result = PushResult()
 
1322
        push_result.source_branch = source
 
1323
        if br_to is None:
 
1324
            # We have a repository but no branch, copy the revisions, and then
 
1325
            # create a branch.
 
1326
            repository_to.fetch(source.repository, revision_id=revision_id)
 
1327
            br_to = source.clone(self, revision_id=revision_id)
 
1328
            if source.get_push_location() is None or remember:
 
1329
                source.set_push_location(br_to.base)
 
1330
            push_result.stacked_on = None
 
1331
            push_result.branch_push_result = None
 
1332
            push_result.old_revno = None
 
1333
            push_result.old_revid = _mod_revision.NULL_REVISION
 
1334
            push_result.target_branch = br_to
 
1335
            push_result.master_branch = None
 
1336
            push_result.workingtree_updated = False
 
1337
        else:
 
1338
            # We have successfully opened the branch, remember if necessary:
 
1339
            if source.get_push_location() is None or remember:
 
1340
                source.set_push_location(br_to.base)
 
1341
            try:
 
1342
                tree_to = self.open_workingtree()
 
1343
            except errors.NotLocalUrl:
 
1344
                push_result.branch_push_result = source.push(br_to, 
 
1345
                    overwrite, stop_revision=revision_id)
 
1346
                push_result.workingtree_updated = False
 
1347
            except errors.NoWorkingTree:
 
1348
                push_result.branch_push_result = source.push(br_to,
 
1349
                    overwrite, stop_revision=revision_id)
 
1350
                push_result.workingtree_updated = None # Not applicable
 
1351
            else:
 
1352
                tree_to.lock_write()
 
1353
                try:
 
1354
                    push_result.branch_push_result = source.push(
 
1355
                        tree_to.branch, overwrite, stop_revision=revision_id)
 
1356
                    tree_to.update()
 
1357
                finally:
 
1358
                    tree_to.unlock()
 
1359
                push_result.workingtree_updated = True
 
1360
            push_result.old_revno = push_result.branch_push_result.old_revno
 
1361
            push_result.old_revid = push_result.branch_push_result.old_revid
 
1362
            push_result.target_branch = \
 
1363
                push_result.branch_push_result.target_branch
 
1364
        return push_result
1079
1365
 
1080
1366
 
1081
1367
class BzrDirHooks(hooks.Hooks):
1083
1369
 
1084
1370
    def __init__(self):
1085
1371
        """Create the default hooks."""
1086
 
        hooks.Hooks.__init__(self, "bzrlib.bzrdir", "BzrDir.hooks")
1087
 
        self.add_hook('pre_open',
 
1372
        hooks.Hooks.__init__(self)
 
1373
        self.create_hook(hooks.HookPoint('pre_open',
1088
1374
            "Invoked before attempting to open a BzrDir with the transport "
1089
 
            "that the open will use.", (1, 14))
1090
 
        self.add_hook('post_repo_init',
 
1375
            "that the open will use.", (1, 14), None))
 
1376
        self.create_hook(hooks.HookPoint('post_repo_init',
1091
1377
            "Invoked after a repository has been initialized. "
1092
1378
            "post_repo_init is called with a "
1093
1379
            "bzrlib.bzrdir.RepoInitHookParams.",
1094
 
            (2, 2))
 
1380
            (2, 2), None))
1095
1381
 
1096
1382
# install the default hooks
1097
1383
BzrDir.hooks = BzrDirHooks()
1098
1384
 
1099
1385
 
1100
1386
class RepoInitHookParams(object):
1101
 
    """Object holding parameters passed to `*_repo_init` hooks.
 
1387
    """Object holding parameters passed to *_repo_init hooks.
1102
1388
 
1103
1389
    There are 4 fields that hooks may wish to access:
1104
1390
 
1133
1419
                self.bzrdir)
1134
1420
 
1135
1421
 
 
1422
class BzrDirPreSplitOut(BzrDir):
 
1423
    """A common class for the all-in-one formats."""
 
1424
 
 
1425
    def __init__(self, _transport, _format):
 
1426
        """See BzrDir.__init__."""
 
1427
        super(BzrDirPreSplitOut, self).__init__(_transport, _format)
 
1428
        self._control_files = lockable_files.LockableFiles(
 
1429
                                            self.get_branch_transport(None),
 
1430
                                            self._format._lock_file_name,
 
1431
                                            self._format._lock_class)
 
1432
 
 
1433
    def break_lock(self):
 
1434
        """Pre-splitout bzrdirs do not suffer from stale locks."""
 
1435
        raise NotImplementedError(self.break_lock)
 
1436
 
 
1437
    def cloning_metadir(self, require_stacking=False):
 
1438
        """Produce a metadir suitable for cloning with."""
 
1439
        if require_stacking:
 
1440
            return format_registry.make_bzrdir('1.6')
 
1441
        return self._format.__class__()
 
1442
 
 
1443
    def clone(self, url, revision_id=None, force_new_repo=False,
 
1444
              preserve_stacking=False):
 
1445
        """See BzrDir.clone().
 
1446
 
 
1447
        force_new_repo has no effect, since this family of formats always
 
1448
        require a new repository.
 
1449
        preserve_stacking has no effect, since no source branch using this
 
1450
        family of formats can be stacked, so there is no stacking to preserve.
 
1451
        """
 
1452
        self._make_tail(url)
 
1453
        result = self._format._initialize_for_clone(url)
 
1454
        self.open_repository().clone(result, revision_id=revision_id)
 
1455
        from_branch = self.open_branch()
 
1456
        from_branch.clone(result, revision_id=revision_id)
 
1457
        try:
 
1458
            tree = self.open_workingtree()
 
1459
        except errors.NotLocalUrl:
 
1460
            # make a new one, this format always has to have one.
 
1461
            result._init_workingtree()
 
1462
        else:
 
1463
            tree.clone(result)
 
1464
        return result
 
1465
 
 
1466
    def create_branch(self, name=None):
 
1467
        """See BzrDir.create_branch."""
 
1468
        return self._format.get_branch_format().initialize(self, name=name)
 
1469
 
 
1470
    def destroy_branch(self, name=None):
 
1471
        """See BzrDir.destroy_branch."""
 
1472
        raise errors.UnsupportedOperation(self.destroy_branch, self)
 
1473
 
 
1474
    def create_repository(self, shared=False):
 
1475
        """See BzrDir.create_repository."""
 
1476
        if shared:
 
1477
            raise errors.IncompatibleFormat('shared repository', self._format)
 
1478
        return self.open_repository()
 
1479
 
 
1480
    def destroy_repository(self):
 
1481
        """See BzrDir.destroy_repository."""
 
1482
        raise errors.UnsupportedOperation(self.destroy_repository, self)
 
1483
 
 
1484
    def create_workingtree(self, revision_id=None, from_branch=None,
 
1485
                           accelerator_tree=None, hardlink=False):
 
1486
        """See BzrDir.create_workingtree."""
 
1487
        # The workingtree is sometimes created when the bzrdir is created,
 
1488
        # but not when cloning.
 
1489
 
 
1490
        # this looks buggy but is not -really-
 
1491
        # because this format creates the workingtree when the bzrdir is
 
1492
        # created
 
1493
        # clone and sprout will have set the revision_id
 
1494
        # and that will have set it for us, its only
 
1495
        # specific uses of create_workingtree in isolation
 
1496
        # that can do wonky stuff here, and that only
 
1497
        # happens for creating checkouts, which cannot be
 
1498
        # done on this format anyway. So - acceptable wart.
 
1499
        if hardlink:
 
1500
            warning("can't support hardlinked working trees in %r"
 
1501
                % (self,))
 
1502
        try:
 
1503
            result = self.open_workingtree(recommend_upgrade=False)
 
1504
        except errors.NoSuchFile:
 
1505
            result = self._init_workingtree()
 
1506
        if revision_id is not None:
 
1507
            if revision_id == _mod_revision.NULL_REVISION:
 
1508
                result.set_parent_ids([])
 
1509
            else:
 
1510
                result.set_parent_ids([revision_id])
 
1511
        return result
 
1512
 
 
1513
    def _init_workingtree(self):
 
1514
        from bzrlib.workingtree import WorkingTreeFormat2
 
1515
        try:
 
1516
            return WorkingTreeFormat2().initialize(self)
 
1517
        except errors.NotLocalUrl:
 
1518
            # Even though we can't access the working tree, we need to
 
1519
            # create its control files.
 
1520
            return WorkingTreeFormat2()._stub_initialize_on_transport(
 
1521
                self.transport, self._control_files._file_mode)
 
1522
 
 
1523
    def destroy_workingtree(self):
 
1524
        """See BzrDir.destroy_workingtree."""
 
1525
        raise errors.UnsupportedOperation(self.destroy_workingtree, self)
 
1526
 
 
1527
    def destroy_workingtree_metadata(self):
 
1528
        """See BzrDir.destroy_workingtree_metadata."""
 
1529
        raise errors.UnsupportedOperation(self.destroy_workingtree_metadata,
 
1530
                                          self)
 
1531
 
 
1532
    def get_branch_transport(self, branch_format, name=None):
 
1533
        """See BzrDir.get_branch_transport()."""
 
1534
        if name is not None:
 
1535
            raise errors.NoColocatedBranchSupport(self)
 
1536
        if branch_format is None:
 
1537
            return self.transport
 
1538
        try:
 
1539
            branch_format.get_format_string()
 
1540
        except NotImplementedError:
 
1541
            return self.transport
 
1542
        raise errors.IncompatibleFormat(branch_format, self._format)
 
1543
 
 
1544
    def get_repository_transport(self, repository_format):
 
1545
        """See BzrDir.get_repository_transport()."""
 
1546
        if repository_format is None:
 
1547
            return self.transport
 
1548
        try:
 
1549
            repository_format.get_format_string()
 
1550
        except NotImplementedError:
 
1551
            return self.transport
 
1552
        raise errors.IncompatibleFormat(repository_format, self._format)
 
1553
 
 
1554
    def get_workingtree_transport(self, workingtree_format):
 
1555
        """See BzrDir.get_workingtree_transport()."""
 
1556
        if workingtree_format is None:
 
1557
            return self.transport
 
1558
        try:
 
1559
            workingtree_format.get_format_string()
 
1560
        except NotImplementedError:
 
1561
            return self.transport
 
1562
        raise errors.IncompatibleFormat(workingtree_format, self._format)
 
1563
 
 
1564
    def needs_format_conversion(self, format=None):
 
1565
        """See BzrDir.needs_format_conversion()."""
 
1566
        # if the format is not the same as the system default,
 
1567
        # an upgrade is needed.
 
1568
        if format is None:
 
1569
            symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
 
1570
                % 'needs_format_conversion(format=None)')
 
1571
            format = BzrDirFormat.get_default_format()
 
1572
        return not isinstance(self._format, format.__class__)
 
1573
 
 
1574
    def open_branch(self, name=None, unsupported=False,
 
1575
                    ignore_fallbacks=False):
 
1576
        """See BzrDir.open_branch."""
 
1577
        from bzrlib.branch import BzrBranchFormat4
 
1578
        format = BzrBranchFormat4()
 
1579
        self._check_supported(format, unsupported)
 
1580
        return format.open(self, name, _found=True)
 
1581
 
 
1582
    def sprout(self, url, revision_id=None, force_new_repo=False,
 
1583
               possible_transports=None, accelerator_tree=None,
 
1584
               hardlink=False, stacked=False, create_tree_if_local=True,
 
1585
               source_branch=None):
 
1586
        """See BzrDir.sprout()."""
 
1587
        if source_branch is not None:
 
1588
            my_branch = self.open_branch()
 
1589
            if source_branch.base != my_branch.base:
 
1590
                raise AssertionError(
 
1591
                    "source branch %r is not within %r with branch %r" %
 
1592
                    (source_branch, self, my_branch))
 
1593
        if stacked:
 
1594
            raise errors.UnstackableBranchFormat(
 
1595
                self._format, self.root_transport.base)
 
1596
        if not create_tree_if_local:
 
1597
            raise errors.MustHaveWorkingTree(
 
1598
                self._format, self.root_transport.base)
 
1599
        from bzrlib.workingtree import WorkingTreeFormat2
 
1600
        self._make_tail(url)
 
1601
        result = self._format._initialize_for_clone(url)
 
1602
        try:
 
1603
            self.open_repository().clone(result, revision_id=revision_id)
 
1604
        except errors.NoRepositoryPresent:
 
1605
            pass
 
1606
        try:
 
1607
            self.open_branch().sprout(result, revision_id=revision_id)
 
1608
        except errors.NotBranchError:
 
1609
            pass
 
1610
 
 
1611
        # we always want a working tree
 
1612
        WorkingTreeFormat2().initialize(result,
 
1613
                                        accelerator_tree=accelerator_tree,
 
1614
                                        hardlink=hardlink)
 
1615
        return result
 
1616
 
 
1617
 
 
1618
class BzrDir4(BzrDirPreSplitOut):
 
1619
    """A .bzr version 4 control object.
 
1620
 
 
1621
    This is a deprecated format and may be removed after sept 2006.
 
1622
    """
 
1623
 
 
1624
    def create_repository(self, shared=False):
 
1625
        """See BzrDir.create_repository."""
 
1626
        return self._format.repository_format.initialize(self, shared)
 
1627
 
 
1628
    def needs_format_conversion(self, format=None):
 
1629
        """Format 4 dirs are always in need of conversion."""
 
1630
        if format is None:
 
1631
            symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
 
1632
                % 'needs_format_conversion(format=None)')
 
1633
        return True
 
1634
 
 
1635
    def open_repository(self):
 
1636
        """See BzrDir.open_repository."""
 
1637
        from bzrlib.repofmt.weaverepo import RepositoryFormat4
 
1638
        return RepositoryFormat4().open(self, _found=True)
 
1639
 
 
1640
 
 
1641
class BzrDir5(BzrDirPreSplitOut):
 
1642
    """A .bzr version 5 control object.
 
1643
 
 
1644
    This is a deprecated format and may be removed after sept 2006.
 
1645
    """
 
1646
 
 
1647
    def has_workingtree(self):
 
1648
        """See BzrDir.has_workingtree."""
 
1649
        return True
 
1650
    
 
1651
    def open_repository(self):
 
1652
        """See BzrDir.open_repository."""
 
1653
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
 
1654
        return RepositoryFormat5().open(self, _found=True)
 
1655
 
 
1656
    def open_workingtree(self, _unsupported=False,
 
1657
            recommend_upgrade=True):
 
1658
        """See BzrDir.create_workingtree."""
 
1659
        from bzrlib.workingtree import WorkingTreeFormat2
 
1660
        wt_format = WorkingTreeFormat2()
 
1661
        # we don't warn here about upgrades; that ought to be handled for the
 
1662
        # bzrdir as a whole
 
1663
        return wt_format.open(self, _found=True)
 
1664
 
 
1665
 
 
1666
class BzrDir6(BzrDirPreSplitOut):
 
1667
    """A .bzr version 6 control object.
 
1668
 
 
1669
    This is a deprecated format and may be removed after sept 2006.
 
1670
    """
 
1671
 
 
1672
    def has_workingtree(self):
 
1673
        """See BzrDir.has_workingtree."""
 
1674
        return True
 
1675
    
 
1676
    def open_repository(self):
 
1677
        """See BzrDir.open_repository."""
 
1678
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
 
1679
        return RepositoryFormat6().open(self, _found=True)
 
1680
 
 
1681
    def open_workingtree(self, _unsupported=False,
 
1682
        recommend_upgrade=True):
 
1683
        """See BzrDir.create_workingtree."""
 
1684
        # we don't warn here about upgrades; that ought to be handled for the
 
1685
        # bzrdir as a whole
 
1686
        from bzrlib.workingtree import WorkingTreeFormat2
 
1687
        return WorkingTreeFormat2().open(self, _found=True)
 
1688
 
 
1689
 
1136
1690
class BzrDirMeta1(BzrDir):
1137
1691
    """A .bzr meta version 1 control object.
1138
1692
 
1146
1700
        """See BzrDir.can_convert_format()."""
1147
1701
        return True
1148
1702
 
1149
 
    def create_branch(self, name=None, repository=None):
 
1703
    def create_branch(self, name=None):
1150
1704
        """See BzrDir.create_branch."""
1151
 
        return self._format.get_branch_format().initialize(self, name=name,
1152
 
                repository=repository)
 
1705
        return self._format.get_branch_format().initialize(self, name=name)
1153
1706
 
1154
1707
    def destroy_branch(self, name=None):
1155
1708
        """See BzrDir.create_branch."""
1177
1730
        wt = self.open_workingtree(recommend_upgrade=False)
1178
1731
        repository = wt.branch.repository
1179
1732
        empty = repository.revision_tree(_mod_revision.NULL_REVISION)
1180
 
        # We ignore the conflicts returned by wt.revert since we're about to
1181
 
        # delete the wt metadata anyway, all that should be left here are
1182
 
        # detritus. But see bug #634470 about subtree .bzr dirs.
1183
 
        conflicts = wt.revert(old_tree=empty)
 
1733
        wt.revert(old_tree=empty)
1184
1734
        self.destroy_workingtree_metadata()
1185
1735
 
1186
1736
    def destroy_workingtree_metadata(self):
1187
1737
        self.transport.delete_tree('checkout')
1188
1738
 
1189
 
    def find_branch_format(self, name=None):
 
1739
    def find_branch_format(self):
1190
1740
        """Find the branch 'format' for this bzrdir.
1191
1741
 
1192
1742
        This might be a synthetic object for e.g. RemoteBranch and SVN.
1193
1743
        """
1194
1744
        from bzrlib.branch import BranchFormat
1195
 
        return BranchFormat.find_format(self, name=name)
 
1745
        return BranchFormat.find_format(self)
1196
1746
 
1197
1747
    def _get_mkdir_mode(self):
1198
1748
        """Figure out the mode to use when creating a bzrdir subdir."""
1200
1750
                                     lockable_files.TransportLock)
1201
1751
        return temp_control._dir_mode
1202
1752
 
1203
 
    def get_branch_reference(self, name=None):
 
1753
    def get_branch_reference(self):
1204
1754
        """See BzrDir.get_branch_reference()."""
1205
1755
        from bzrlib.branch import BranchFormat
1206
 
        format = BranchFormat.find_format(self, name=name)
1207
 
        return format.get_reference(self, name=name)
 
1756
        format = BranchFormat.find_format(self)
 
1757
        return format.get_reference(self)
1208
1758
 
1209
1759
    def get_branch_transport(self, branch_format, name=None):
1210
1760
        """See BzrDir.get_branch_transport()."""
1255
1805
    def has_workingtree(self):
1256
1806
        """Tell if this bzrdir contains a working tree.
1257
1807
 
 
1808
        This will still raise an exception if the bzrdir has a workingtree that
 
1809
        is remote & inaccessible.
 
1810
 
1258
1811
        Note: if you're going to open the working tree, you should just go
1259
1812
        ahead and try, and not ask permission first.
1260
1813
        """
1261
1814
        from bzrlib.workingtree import WorkingTreeFormat
1262
1815
        try:
1263
 
            WorkingTreeFormat.find_format_string(self)
 
1816
            WorkingTreeFormat.find_format(self)
1264
1817
        except errors.NoWorkingTree:
1265
1818
            return False
1266
1819
        return True
1267
1820
 
1268
 
    def needs_format_conversion(self, format):
 
1821
    def needs_format_conversion(self, format=None):
1269
1822
        """See BzrDir.needs_format_conversion()."""
 
1823
        if format is None:
 
1824
            symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
 
1825
                % 'needs_format_conversion(format=None)')
 
1826
        if format is None:
 
1827
            format = BzrDirFormat.get_default_format()
1270
1828
        if not isinstance(self._format, format.__class__):
1271
1829
            # it is not a meta dir format, conversion is needed.
1272
1830
            return True
1296
1854
    def open_branch(self, name=None, unsupported=False,
1297
1855
                    ignore_fallbacks=False):
1298
1856
        """See BzrDir.open_branch."""
1299
 
        format = self.find_branch_format(name=name)
1300
 
        format.check_support_status(unsupported)
 
1857
        format = self.find_branch_format()
 
1858
        self._check_supported(format, unsupported)
1301
1859
        return format.open(self, name=name,
1302
1860
            _found=True, ignore_fallbacks=ignore_fallbacks)
1303
1861
 
1305
1863
        """See BzrDir.open_repository."""
1306
1864
        from bzrlib.repository import RepositoryFormat
1307
1865
        format = RepositoryFormat.find_format(self)
1308
 
        format.check_support_status(unsupported)
 
1866
        self._check_supported(format, unsupported)
1309
1867
        return format.open(self, _found=True)
1310
1868
 
1311
1869
    def open_workingtree(self, unsupported=False,
1313
1871
        """See BzrDir.open_workingtree."""
1314
1872
        from bzrlib.workingtree import WorkingTreeFormat
1315
1873
        format = WorkingTreeFormat.find_format(self)
1316
 
        format.check_support_status(unsupported, recommend_upgrade,
 
1874
        self._check_supported(format, unsupported,
 
1875
            recommend_upgrade,
1317
1876
            basedir=self.root_transport.base)
1318
1877
        return format.open(self, _found=True)
1319
1878
 
1321
1880
        return config.TransportConfig(self.transport, 'control.conf')
1322
1881
 
1323
1882
 
1324
 
class BzrProber(controldir.Prober):
1325
 
    """Prober for formats that use a .bzr/ control directory."""
1326
 
 
1327
 
    formats = registry.FormatRegistry(controldir.network_format_registry)
1328
 
    """The known .bzr formats."""
1329
 
 
1330
 
    @classmethod
1331
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1332
 
    def register_bzrdir_format(klass, format):
1333
 
        klass.formats.register(format.get_format_string(), format)
1334
 
 
1335
 
    @classmethod
1336
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1337
 
    def unregister_bzrdir_format(klass, format):
1338
 
        klass.formats.remove(format.get_format_string())
1339
 
 
1340
 
    @classmethod
1341
 
    def probe_transport(klass, transport):
1342
 
        """Return the .bzrdir style format present in a directory."""
1343
 
        try:
1344
 
            format_string = transport.get_bytes(".bzr/branch-format")
1345
 
        except errors.NoSuchFile:
1346
 
            raise errors.NotBranchError(path=transport.base)
1347
 
        try:
1348
 
            return klass.formats.get(format_string)
1349
 
        except KeyError:
1350
 
            raise errors.UnknownFormatError(format=format_string, kind='bzrdir')
1351
 
 
1352
 
    @classmethod
1353
 
    def known_formats(cls):
1354
 
        result = set()
1355
 
        for name, format in cls.formats.iteritems():
1356
 
            if callable(format):
1357
 
                format = format()
1358
 
            result.add(format)
1359
 
        return result
1360
 
 
1361
 
 
1362
 
controldir.ControlDirFormat.register_prober(BzrProber)
1363
 
 
1364
 
 
1365
 
class RemoteBzrProber(controldir.Prober):
1366
 
    """Prober for remote servers that provide a Bazaar smart server."""
1367
 
 
1368
 
    @classmethod
1369
 
    def probe_transport(klass, transport):
1370
 
        """Return a RemoteBzrDirFormat object if it looks possible."""
1371
 
        try:
1372
 
            medium = transport.get_smart_medium()
1373
 
        except (NotImplementedError, AttributeError,
1374
 
                errors.TransportNotPossible, errors.NoSmartMedium,
1375
 
                errors.SmartProtocolError):
1376
 
            # no smart server, so not a branch for this format type.
1377
 
            raise errors.NotBranchError(path=transport.base)
1378
 
        else:
1379
 
            # Decline to open it if the server doesn't support our required
1380
 
            # version (3) so that the VFS-based transport will do it.
1381
 
            if medium.should_probe():
1382
 
                try:
1383
 
                    server_version = medium.protocol_version()
1384
 
                except errors.SmartProtocolError:
1385
 
                    # Apparently there's no usable smart server there, even though
1386
 
                    # the medium supports the smart protocol.
1387
 
                    raise errors.NotBranchError(path=transport.base)
1388
 
                if server_version != '2':
1389
 
                    raise errors.NotBranchError(path=transport.base)
1390
 
            from bzrlib.remote import RemoteBzrDirFormat
1391
 
            return RemoteBzrDirFormat()
1392
 
 
1393
 
    @classmethod
1394
 
    def known_formats(cls):
1395
 
        from bzrlib.remote import RemoteBzrDirFormat
1396
 
        return set([RemoteBzrDirFormat()])
1397
 
 
1398
 
 
1399
 
class BzrDirFormat(controldir.ControlDirFormat):
1400
 
    """ControlDirFormat base class for .bzr/ directories.
 
1883
class BzrDirFormat(object):
 
1884
    """An encapsulation of the initialization and open routines for a format.
 
1885
 
 
1886
    Formats provide three things:
 
1887
     * An initialization routine,
 
1888
     * a format string,
 
1889
     * an open routine.
1401
1890
 
1402
1891
    Formats are placed in a dict by their format string for reference
1403
1892
    during bzrdir opening. These should be subclasses of BzrDirFormat
1406
1895
    Once a format is deprecated, just deprecate the initialize and open
1407
1896
    methods on the format class. Do not deprecate the object, as the
1408
1897
    object will be created every system load.
 
1898
 
 
1899
    :cvar colocated_branches: Whether this formats supports colocated branches.
 
1900
    """
 
1901
 
 
1902
    _default_format = None
 
1903
    """The default format used for new .bzr dirs."""
 
1904
 
 
1905
    _formats = {}
 
1906
    """The known formats."""
 
1907
 
 
1908
    _control_formats = []
 
1909
    """The registered control formats - .bzr, ....
 
1910
 
 
1911
    This is a list of BzrDirFormat objects.
 
1912
    """
 
1913
 
 
1914
    _control_server_formats = []
 
1915
    """The registered control server formats, e.g. RemoteBzrDirs.
 
1916
 
 
1917
    This is a list of BzrDirFormat objects.
1409
1918
    """
1410
1919
 
1411
1920
    _lock_file_name = 'branch-lock'
1412
1921
 
 
1922
    colocated_branches = False
 
1923
    """Whether co-located branches are supported for this control dir format.
 
1924
    """
 
1925
 
1413
1926
    # _lock_class must be set in subclasses to the lock type, typ.
1414
1927
    # TransportLock or LockDir
1415
1928
 
1416
1929
    @classmethod
1417
 
    def get_format_string(cls):
 
1930
    def find_format(klass, transport, _server_formats=True):
 
1931
        """Return the format present at transport."""
 
1932
        if _server_formats:
 
1933
            formats = klass._control_server_formats + klass._control_formats
 
1934
        else:
 
1935
            formats = klass._control_formats
 
1936
        for format in formats:
 
1937
            try:
 
1938
                return format.probe_transport(transport)
 
1939
            except errors.NotBranchError:
 
1940
                # this format does not find a control dir here.
 
1941
                pass
 
1942
        raise errors.NotBranchError(path=transport.base)
 
1943
 
 
1944
    @classmethod
 
1945
    def probe_transport(klass, transport):
 
1946
        """Return the .bzrdir style format present in a directory."""
 
1947
        try:
 
1948
            format_string = transport.get_bytes(".bzr/branch-format")
 
1949
        except errors.NoSuchFile:
 
1950
            raise errors.NotBranchError(path=transport.base)
 
1951
 
 
1952
        try:
 
1953
            return klass._formats[format_string]
 
1954
        except KeyError:
 
1955
            raise errors.UnknownFormatError(format=format_string, kind='bzrdir')
 
1956
 
 
1957
    @classmethod
 
1958
    def get_default_format(klass):
 
1959
        """Return the current default format."""
 
1960
        return klass._default_format
 
1961
 
 
1962
    def get_format_string(self):
1418
1963
        """Return the ASCII format string that identifies this format."""
1419
 
        raise NotImplementedError(cls.get_format_string)
 
1964
        raise NotImplementedError(self.get_format_string)
 
1965
 
 
1966
    def get_format_description(self):
 
1967
        """Return the short description for this format."""
 
1968
        raise NotImplementedError(self.get_format_description)
 
1969
 
 
1970
    def get_converter(self, format=None):
 
1971
        """Return the converter to use to convert bzrdirs needing converts.
 
1972
 
 
1973
        This returns a bzrlib.bzrdir.Converter object.
 
1974
 
 
1975
        This should return the best upgrader to step this format towards the
 
1976
        current default format. In the case of plugins we can/should provide
 
1977
        some means for them to extend the range of returnable converters.
 
1978
 
 
1979
        :param format: Optional format to override the default format of the
 
1980
                       library.
 
1981
        """
 
1982
        raise NotImplementedError(self.get_converter)
 
1983
 
 
1984
    def initialize(self, url, possible_transports=None):
 
1985
        """Create a bzr control dir at this url and return an opened copy.
 
1986
 
 
1987
        While not deprecated, this method is very specific and its use will
 
1988
        lead to many round trips to setup a working environment. See
 
1989
        initialize_on_transport_ex for a [nearly] all-in-one method.
 
1990
 
 
1991
        Subclasses should typically override initialize_on_transport
 
1992
        instead of this method.
 
1993
        """
 
1994
        return self.initialize_on_transport(get_transport(url,
 
1995
                                                          possible_transports))
1420
1996
 
1421
1997
    def initialize_on_transport(self, transport):
1422
1998
        """Initialize a new bzrdir in the base directory of a Transport."""
1432
2008
            # metadir1
1433
2009
            if type(self) != BzrDirMetaFormat1:
1434
2010
                return self._initialize_on_transport_vfs(transport)
1435
 
            from bzrlib.remote import RemoteBzrDirFormat
1436
2011
            remote_format = RemoteBzrDirFormat()
1437
2012
            self._supply_sub_formats_to(remote_format)
1438
2013
            return remote_format.initialize_on_transport(transport)
1476
2051
            except errors.NoSmartMedium:
1477
2052
                pass
1478
2053
            else:
1479
 
                from bzrlib.remote import RemoteBzrDirFormat
1480
2054
                # TODO: lookup the local format from a server hint.
1481
2055
                remote_dir_format = RemoteBzrDirFormat()
1482
2056
                remote_dir_format._network_name = self.network_name()
1557
2131
        utf8_files = [('README',
1558
2132
                       "This is a Bazaar control directory.\n"
1559
2133
                       "Do not change any files in this directory.\n"
1560
 
                       "See http://bazaar.canonical.com/ for more information about Bazaar.\n"),
 
2134
                       "See http://bazaar-vcs.org/ for more information about Bazaar.\n"),
1561
2135
                      ('branch-format', self.get_format_string()),
1562
2136
                      ]
1563
2137
        # NB: no need to escape relative paths that are url safe.
1573
2147
            control_files.unlock()
1574
2148
        return self.open(transport, _found=True)
1575
2149
 
 
2150
    def is_supported(self):
 
2151
        """Is this format supported?
 
2152
 
 
2153
        Supported formats must be initializable and openable.
 
2154
        Unsupported formats may not support initialization or committing or
 
2155
        some other features depending on the reason for not being supported.
 
2156
        """
 
2157
        return True
 
2158
 
 
2159
    def network_name(self):
 
2160
        """A simple byte string uniquely identifying this format for RPC calls.
 
2161
 
 
2162
        Bzr control formats use thir disk format string to identify the format
 
2163
        over the wire. Its possible that other control formats have more
 
2164
        complex detection requirements, so we permit them to use any unique and
 
2165
        immutable string they desire.
 
2166
        """
 
2167
        raise NotImplementedError(self.network_name)
 
2168
 
 
2169
    def same_model(self, target_format):
 
2170
        return (self.repository_format.rich_root_data ==
 
2171
            target_format.rich_root_data)
 
2172
 
 
2173
    @classmethod
 
2174
    def known_formats(klass):
 
2175
        """Return all the known formats.
 
2176
 
 
2177
        Concrete formats should override _known_formats.
 
2178
        """
 
2179
        # There is double indirection here to make sure that control
 
2180
        # formats used by more than one dir format will only be probed
 
2181
        # once. This can otherwise be quite expensive for remote connections.
 
2182
        result = set()
 
2183
        for format in klass._control_formats:
 
2184
            result.update(format._known_formats())
 
2185
        return result
 
2186
 
 
2187
    @classmethod
 
2188
    def _known_formats(klass):
 
2189
        """Return the known format instances for this control format."""
 
2190
        return set(klass._formats.values())
 
2191
 
1576
2192
    def open(self, transport, _found=False):
1577
2193
        """Return an instance of this format for the dir transport points at.
1578
2194
 
1579
2195
        _found is a private parameter, do not use it.
1580
2196
        """
1581
2197
        if not _found:
1582
 
            found_format = controldir.ControlDirFormat.find_format(transport)
 
2198
            found_format = BzrDirFormat.find_format(transport)
1583
2199
            if not isinstance(found_format, self.__class__):
1584
2200
                raise AssertionError("%s was asked to open %s, but it seems to need "
1585
2201
                        "format %s"
1597
2213
        """
1598
2214
        raise NotImplementedError(self._open)
1599
2215
 
 
2216
    @classmethod
 
2217
    def register_format(klass, format):
 
2218
        klass._formats[format.get_format_string()] = format
 
2219
        # bzr native formats have a network name of their format string.
 
2220
        network_format_registry.register(format.get_format_string(), format.__class__)
 
2221
 
 
2222
    @classmethod
 
2223
    def register_control_format(klass, format):
 
2224
        """Register a format that does not use '.bzr' for its control dir.
 
2225
 
 
2226
        TODO: This should be pulled up into a 'ControlDirFormat' base class
 
2227
        which BzrDirFormat can inherit from, and renamed to register_format
 
2228
        there. It has been done without that for now for simplicity of
 
2229
        implementation.
 
2230
        """
 
2231
        klass._control_formats.append(format)
 
2232
 
 
2233
    @classmethod
 
2234
    def register_control_server_format(klass, format):
 
2235
        """Register a control format for client-server environments.
 
2236
 
 
2237
        These formats will be tried before ones registered with
 
2238
        register_control_format.  This gives implementations that decide to the
 
2239
        chance to grab it before anything looks at the contents of the format
 
2240
        file.
 
2241
        """
 
2242
        klass._control_server_formats.append(format)
 
2243
 
 
2244
    @classmethod
 
2245
    def _set_default_format(klass, format):
 
2246
        """Set default format (for testing behavior of defaults only)"""
 
2247
        klass._default_format = format
 
2248
 
 
2249
    def __str__(self):
 
2250
        # Trim the newline
 
2251
        return self.get_format_description().rstrip()
 
2252
 
1600
2253
    def _supply_sub_formats_to(self, other_format):
1601
2254
        """Give other_format the same values for sub formats as this has.
1602
2255
 
1609
2262
        :return: None.
1610
2263
        """
1611
2264
 
 
2265
    @classmethod
 
2266
    def unregister_format(klass, format):
 
2267
        del klass._formats[format.get_format_string()]
 
2268
 
 
2269
    @classmethod
 
2270
    def unregister_control_format(klass, format):
 
2271
        klass._control_formats.remove(format)
 
2272
 
 
2273
 
 
2274
class BzrDirFormat4(BzrDirFormat):
 
2275
    """Bzr dir format 4.
 
2276
 
 
2277
    This format is a combined format for working tree, branch and repository.
 
2278
    It has:
 
2279
     - Format 1 working trees [always]
 
2280
     - Format 4 branches [always]
 
2281
     - Format 4 repositories [always]
 
2282
 
 
2283
    This format is deprecated: it indexes texts using a text it which is
 
2284
    removed in format 5; write support for this format has been removed.
 
2285
    """
 
2286
 
 
2287
    _lock_class = lockable_files.TransportLock
 
2288
 
 
2289
    def get_format_string(self):
 
2290
        """See BzrDirFormat.get_format_string()."""
 
2291
        return "Bazaar-NG branch, format 0.0.4\n"
 
2292
 
 
2293
    def get_format_description(self):
 
2294
        """See BzrDirFormat.get_format_description()."""
 
2295
        return "All-in-one format 4"
 
2296
 
 
2297
    def get_converter(self, format=None):
 
2298
        """See BzrDirFormat.get_converter()."""
 
2299
        # there is one and only one upgrade path here.
 
2300
        return ConvertBzrDir4To5()
 
2301
 
 
2302
    def initialize_on_transport(self, transport):
 
2303
        """Format 4 branches cannot be created."""
 
2304
        raise errors.UninitializableFormat(self)
 
2305
 
 
2306
    def is_supported(self):
 
2307
        """Format 4 is not supported.
 
2308
 
 
2309
        It is not supported because the model changed from 4 to 5 and the
 
2310
        conversion logic is expensive - so doing it on the fly was not
 
2311
        feasible.
 
2312
        """
 
2313
        return False
 
2314
 
 
2315
    def network_name(self):
 
2316
        return self.get_format_string()
 
2317
 
 
2318
    def _open(self, transport):
 
2319
        """See BzrDirFormat._open."""
 
2320
        return BzrDir4(transport, self)
 
2321
 
 
2322
    def __return_repository_format(self):
 
2323
        """Circular import protection."""
 
2324
        from bzrlib.repofmt.weaverepo import RepositoryFormat4
 
2325
        return RepositoryFormat4()
 
2326
    repository_format = property(__return_repository_format)
 
2327
 
 
2328
 
 
2329
class BzrDirFormatAllInOne(BzrDirFormat):
 
2330
    """Common class for formats before meta-dirs."""
 
2331
 
 
2332
    def initialize_on_transport_ex(self, transport, use_existing_dir=False,
 
2333
        create_prefix=False, force_new_repo=False, stacked_on=None,
 
2334
        stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
 
2335
        shared_repo=False):
 
2336
        """See BzrDirFormat.initialize_on_transport_ex."""
 
2337
        require_stacking = (stacked_on is not None)
 
2338
        # Format 5 cannot stack, but we've been asked to - actually init
 
2339
        # a Meta1Dir
 
2340
        if require_stacking:
 
2341
            format = BzrDirMetaFormat1()
 
2342
            return format.initialize_on_transport_ex(transport,
 
2343
                use_existing_dir=use_existing_dir, create_prefix=create_prefix,
 
2344
                force_new_repo=force_new_repo, stacked_on=stacked_on,
 
2345
                stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
 
2346
                make_working_trees=make_working_trees, shared_repo=shared_repo)
 
2347
        return BzrDirFormat.initialize_on_transport_ex(self, transport,
 
2348
            use_existing_dir=use_existing_dir, create_prefix=create_prefix,
 
2349
            force_new_repo=force_new_repo, stacked_on=stacked_on,
 
2350
            stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
 
2351
            make_working_trees=make_working_trees, shared_repo=shared_repo)
 
2352
 
 
2353
 
 
2354
class BzrDirFormat5(BzrDirFormatAllInOne):
 
2355
    """Bzr control format 5.
 
2356
 
 
2357
    This format is a combined format for working tree, branch and repository.
 
2358
    It has:
 
2359
     - Format 2 working trees [always]
 
2360
     - Format 4 branches [always]
 
2361
     - Format 5 repositories [always]
 
2362
       Unhashed stores in the repository.
 
2363
    """
 
2364
 
 
2365
    _lock_class = lockable_files.TransportLock
 
2366
 
 
2367
    def get_format_string(self):
 
2368
        """See BzrDirFormat.get_format_string()."""
 
2369
        return "Bazaar-NG branch, format 5\n"
 
2370
 
 
2371
    def get_branch_format(self):
 
2372
        from bzrlib import branch
 
2373
        return branch.BzrBranchFormat4()
 
2374
 
 
2375
    def get_format_description(self):
 
2376
        """See BzrDirFormat.get_format_description()."""
 
2377
        return "All-in-one format 5"
 
2378
 
 
2379
    def get_converter(self, format=None):
 
2380
        """See BzrDirFormat.get_converter()."""
 
2381
        # there is one and only one upgrade path here.
 
2382
        return ConvertBzrDir5To6()
 
2383
 
 
2384
    def _initialize_for_clone(self, url):
 
2385
        return self.initialize_on_transport(get_transport(url), _cloning=True)
 
2386
 
 
2387
    def initialize_on_transport(self, transport, _cloning=False):
 
2388
        """Format 5 dirs always have working tree, branch and repository.
 
2389
 
 
2390
        Except when they are being cloned.
 
2391
        """
 
2392
        from bzrlib.branch import BzrBranchFormat4
 
2393
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
 
2394
        result = (super(BzrDirFormat5, self).initialize_on_transport(transport))
 
2395
        RepositoryFormat5().initialize(result, _internal=True)
 
2396
        if not _cloning:
 
2397
            branch = BzrBranchFormat4().initialize(result)
 
2398
            result._init_workingtree()
 
2399
        return result
 
2400
 
 
2401
    def network_name(self):
 
2402
        return self.get_format_string()
 
2403
 
 
2404
    def _open(self, transport):
 
2405
        """See BzrDirFormat._open."""
 
2406
        return BzrDir5(transport, self)
 
2407
 
 
2408
    def __return_repository_format(self):
 
2409
        """Circular import protection."""
 
2410
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
 
2411
        return RepositoryFormat5()
 
2412
    repository_format = property(__return_repository_format)
 
2413
 
 
2414
 
 
2415
class BzrDirFormat6(BzrDirFormatAllInOne):
 
2416
    """Bzr control format 6.
 
2417
 
 
2418
    This format is a combined format for working tree, branch and repository.
 
2419
    It has:
 
2420
     - Format 2 working trees [always]
 
2421
     - Format 4 branches [always]
 
2422
     - Format 6 repositories [always]
 
2423
    """
 
2424
 
 
2425
    _lock_class = lockable_files.TransportLock
 
2426
 
 
2427
    def get_format_string(self):
 
2428
        """See BzrDirFormat.get_format_string()."""
 
2429
        return "Bazaar-NG branch, format 6\n"
 
2430
 
 
2431
    def get_format_description(self):
 
2432
        """See BzrDirFormat.get_format_description()."""
 
2433
        return "All-in-one format 6"
 
2434
 
 
2435
    def get_branch_format(self):
 
2436
        from bzrlib import branch
 
2437
        return branch.BzrBranchFormat4()
 
2438
 
 
2439
    def get_converter(self, format=None):
 
2440
        """See BzrDirFormat.get_converter()."""
 
2441
        # there is one and only one upgrade path here.
 
2442
        return ConvertBzrDir6ToMeta()
 
2443
 
 
2444
    def _initialize_for_clone(self, url):
 
2445
        return self.initialize_on_transport(get_transport(url), _cloning=True)
 
2446
 
 
2447
    def initialize_on_transport(self, transport, _cloning=False):
 
2448
        """Format 6 dirs always have working tree, branch and repository.
 
2449
 
 
2450
        Except when they are being cloned.
 
2451
        """
 
2452
        from bzrlib.branch import BzrBranchFormat4
 
2453
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
 
2454
        result = super(BzrDirFormat6, self).initialize_on_transport(transport)
 
2455
        RepositoryFormat6().initialize(result, _internal=True)
 
2456
        if not _cloning:
 
2457
            branch = BzrBranchFormat4().initialize(result)
 
2458
            result._init_workingtree()
 
2459
        return result
 
2460
 
 
2461
    def network_name(self):
 
2462
        return self.get_format_string()
 
2463
 
 
2464
    def _open(self, transport):
 
2465
        """See BzrDirFormat._open."""
 
2466
        return BzrDir6(transport, self)
 
2467
 
 
2468
    def __return_repository_format(self):
 
2469
        """Circular import protection."""
 
2470
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
 
2471
        return RepositoryFormat6()
 
2472
    repository_format = property(__return_repository_format)
 
2473
 
1612
2474
 
1613
2475
class BzrDirMetaFormat1(BzrDirFormat):
1614
2476
    """Bzr meta control format 1
1615
2477
 
1616
2478
    This is the first format with split out working tree, branch and repository
1617
2479
    disk storage.
1618
 
 
1619
2480
    It has:
1620
 
 
1621
 
    - Format 3 working trees [optional]
1622
 
    - Format 5 branches [optional]
1623
 
    - Format 7 repositories [optional]
 
2481
     - Format 3 working trees [optional]
 
2482
     - Format 5 branches [optional]
 
2483
     - Format 7 repositories [optional]
1624
2484
    """
1625
2485
 
1626
2486
    _lock_class = lockdir.LockDir
1627
2487
 
1628
 
    fixed_components = False
1629
 
 
1630
2488
    def __init__(self):
1631
2489
        self._workingtree_format = None
1632
2490
        self._branch_format = None
1646
2504
 
1647
2505
    def get_branch_format(self):
1648
2506
        if self._branch_format is None:
1649
 
            from bzrlib.branch import format_registry as branch_format_registry
1650
 
            self._branch_format = branch_format_registry.get_default()
 
2507
            from bzrlib.branch import BranchFormat
 
2508
            self._branch_format = BranchFormat.get_default_format()
1651
2509
        return self._branch_format
1652
2510
 
1653
2511
    def set_branch_format(self, format):
1708
2566
                    # stack_on is inaccessible, JFDI.
1709
2567
                    # TODO: bad monkey, hard-coded formats...
1710
2568
                    if self.repository_format.rich_root_data:
1711
 
                        new_repo_format = knitpack_repo.RepositoryFormatKnitPack5RichRoot()
 
2569
                        new_repo_format = pack_repo.RepositoryFormatKnitPack5RichRoot()
1712
2570
                    else:
1713
 
                        new_repo_format = knitpack_repo.RepositoryFormatKnitPack5()
 
2571
                        new_repo_format = pack_repo.RepositoryFormatKnitPack5()
1714
2572
            else:
1715
2573
                # If the target already supports stacking, then we know the
1716
2574
                # project is already able to use stacking, so auto-upgrade
1733
2591
            if target_branch is None:
1734
2592
                if do_upgrade:
1735
2593
                    # TODO: bad monkey, hard-coded formats...
1736
 
                    from bzrlib.branch import BzrBranchFormat7
1737
 
                    new_branch_format = BzrBranchFormat7()
 
2594
                    new_branch_format = branch.BzrBranchFormat7()
1738
2595
            else:
1739
2596
                new_branch_format = target_branch._format
1740
2597
                if not new_branch_format.supports_stacking():
1755
2612
            raise NotImplementedError(self.get_converter)
1756
2613
        return ConvertMetaToMeta(format)
1757
2614
 
1758
 
    @classmethod
1759
 
    def get_format_string(cls):
 
2615
    def get_format_string(self):
1760
2616
        """See BzrDirFormat.get_format_string()."""
1761
2617
        return "Bazaar-NG meta directory, format 1\n"
1762
2618
 
1780
2636
        """Circular import protection."""
1781
2637
        if self._repository_format:
1782
2638
            return self._repository_format
1783
 
        from bzrlib.repository import format_registry
1784
 
        return format_registry.get_default()
 
2639
        from bzrlib.repository import RepositoryFormat
 
2640
        return RepositoryFormat.get_default_format()
1785
2641
 
1786
2642
    def _set_repository_format(self, value):
1787
2643
        """Allow changing the repository format for metadir formats."""
1810
2666
 
1811
2667
    def __get_workingtree_format(self):
1812
2668
        if self._workingtree_format is None:
1813
 
            from bzrlib.workingtree import (
1814
 
                format_registry as wt_format_registry,
1815
 
                )
1816
 
            self._workingtree_format = wt_format_registry.get_default()
 
2669
            from bzrlib.workingtree import WorkingTreeFormat
 
2670
            self._workingtree_format = WorkingTreeFormat.get_default_format()
1817
2671
        return self._workingtree_format
1818
2672
 
1819
2673
    def __set_workingtree_format(self, wt_format):
1823
2677
                                  __set_workingtree_format)
1824
2678
 
1825
2679
 
 
2680
network_format_registry = registry.FormatRegistry()
 
2681
"""Registry of formats indexed by their network name.
 
2682
 
 
2683
The network name for a BzrDirFormat is an identifier that can be used when
 
2684
referring to formats with smart server operations. See
 
2685
BzrDirFormat.network_name() for more detail.
 
2686
"""
 
2687
 
 
2688
 
 
2689
# Register bzr control format
 
2690
BzrDirFormat.register_control_format(BzrDirFormat)
 
2691
 
1826
2692
# Register bzr formats
1827
 
BzrProber.formats.register(BzrDirMetaFormat1.get_format_string(),
1828
 
    BzrDirMetaFormat1)
1829
 
controldir.ControlDirFormat._default_format = BzrDirMetaFormat1()
1830
 
 
1831
 
 
1832
 
class ConvertMetaToMeta(controldir.Converter):
 
2693
BzrDirFormat.register_format(BzrDirFormat4())
 
2694
BzrDirFormat.register_format(BzrDirFormat5())
 
2695
BzrDirFormat.register_format(BzrDirFormat6())
 
2696
__default_format = BzrDirMetaFormat1()
 
2697
BzrDirFormat.register_format(__default_format)
 
2698
BzrDirFormat._default_format = __default_format
 
2699
 
 
2700
 
 
2701
class Converter(object):
 
2702
    """Converts a disk format object from one format to another."""
 
2703
 
 
2704
    def convert(self, to_convert, pb):
 
2705
        """Perform the conversion of to_convert, giving feedback via pb.
 
2706
 
 
2707
        :param to_convert: The disk object to convert.
 
2708
        :param pb: a progress bar to use for progress information.
 
2709
        """
 
2710
 
 
2711
    def step(self, message):
 
2712
        """Update the pb by a step."""
 
2713
        self.count +=1
 
2714
        self.pb.update(message, self.count, self.total)
 
2715
 
 
2716
 
 
2717
class ConvertBzrDir4To5(Converter):
 
2718
    """Converts format 4 bzr dirs to format 5."""
 
2719
 
 
2720
    def __init__(self):
 
2721
        super(ConvertBzrDir4To5, self).__init__()
 
2722
        self.converted_revs = set()
 
2723
        self.absent_revisions = set()
 
2724
        self.text_count = 0
 
2725
        self.revisions = {}
 
2726
 
 
2727
    def convert(self, to_convert, pb):
 
2728
        """See Converter.convert()."""
 
2729
        self.bzrdir = to_convert
 
2730
        if pb is not None:
 
2731
            warnings.warn("pb parameter to convert() is deprecated")
 
2732
        self.pb = ui.ui_factory.nested_progress_bar()
 
2733
        try:
 
2734
            ui.ui_factory.note('starting upgrade from format 4 to 5')
 
2735
            if isinstance(self.bzrdir.transport, local.LocalTransport):
 
2736
                self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
 
2737
            self._convert_to_weaves()
 
2738
            return BzrDir.open(self.bzrdir.user_url)
 
2739
        finally:
 
2740
            self.pb.finished()
 
2741
 
 
2742
    def _convert_to_weaves(self):
 
2743
        ui.ui_factory.note('note: upgrade may be faster if all store files are ungzipped first')
 
2744
        try:
 
2745
            # TODO permissions
 
2746
            stat = self.bzrdir.transport.stat('weaves')
 
2747
            if not S_ISDIR(stat.st_mode):
 
2748
                self.bzrdir.transport.delete('weaves')
 
2749
                self.bzrdir.transport.mkdir('weaves')
 
2750
        except errors.NoSuchFile:
 
2751
            self.bzrdir.transport.mkdir('weaves')
 
2752
        # deliberately not a WeaveFile as we want to build it up slowly.
 
2753
        self.inv_weave = Weave('inventory')
 
2754
        # holds in-memory weaves for all files
 
2755
        self.text_weaves = {}
 
2756
        self.bzrdir.transport.delete('branch-format')
 
2757
        self.branch = self.bzrdir.open_branch()
 
2758
        self._convert_working_inv()
 
2759
        rev_history = self.branch.revision_history()
 
2760
        # to_read is a stack holding the revisions we still need to process;
 
2761
        # appending to it adds new highest-priority revisions
 
2762
        self.known_revisions = set(rev_history)
 
2763
        self.to_read = rev_history[-1:]
 
2764
        while self.to_read:
 
2765
            rev_id = self.to_read.pop()
 
2766
            if (rev_id not in self.revisions
 
2767
                and rev_id not in self.absent_revisions):
 
2768
                self._load_one_rev(rev_id)
 
2769
        self.pb.clear()
 
2770
        to_import = self._make_order()
 
2771
        for i, rev_id in enumerate(to_import):
 
2772
            self.pb.update('converting revision', i, len(to_import))
 
2773
            self._convert_one_rev(rev_id)
 
2774
        self.pb.clear()
 
2775
        self._write_all_weaves()
 
2776
        self._write_all_revs()
 
2777
        ui.ui_factory.note('upgraded to weaves:')
 
2778
        ui.ui_factory.note('  %6d revisions and inventories' % len(self.revisions))
 
2779
        ui.ui_factory.note('  %6d revisions not present' % len(self.absent_revisions))
 
2780
        ui.ui_factory.note('  %6d texts' % self.text_count)
 
2781
        self._cleanup_spare_files_after_format4()
 
2782
        self.branch._transport.put_bytes(
 
2783
            'branch-format',
 
2784
            BzrDirFormat5().get_format_string(),
 
2785
            mode=self.bzrdir._get_file_mode())
 
2786
 
 
2787
    def _cleanup_spare_files_after_format4(self):
 
2788
        # FIXME working tree upgrade foo.
 
2789
        for n in 'merged-patches', 'pending-merged-patches':
 
2790
            try:
 
2791
                ## assert os.path.getsize(p) == 0
 
2792
                self.bzrdir.transport.delete(n)
 
2793
            except errors.NoSuchFile:
 
2794
                pass
 
2795
        self.bzrdir.transport.delete_tree('inventory-store')
 
2796
        self.bzrdir.transport.delete_tree('text-store')
 
2797
 
 
2798
    def _convert_working_inv(self):
 
2799
        inv = xml4.serializer_v4.read_inventory(
 
2800
                self.branch._transport.get('inventory'))
 
2801
        new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv, working=True)
 
2802
        self.branch._transport.put_bytes('inventory', new_inv_xml,
 
2803
            mode=self.bzrdir._get_file_mode())
 
2804
 
 
2805
    def _write_all_weaves(self):
 
2806
        controlweaves = WeaveStore(self.bzrdir.transport, prefixed=False)
 
2807
        weave_transport = self.bzrdir.transport.clone('weaves')
 
2808
        weaves = WeaveStore(weave_transport, prefixed=False)
 
2809
        transaction = WriteTransaction()
 
2810
 
 
2811
        try:
 
2812
            i = 0
 
2813
            for file_id, file_weave in self.text_weaves.items():
 
2814
                self.pb.update('writing weave', i, len(self.text_weaves))
 
2815
                weaves._put_weave(file_id, file_weave, transaction)
 
2816
                i += 1
 
2817
            self.pb.update('inventory', 0, 1)
 
2818
            controlweaves._put_weave('inventory', self.inv_weave, transaction)
 
2819
            self.pb.update('inventory', 1, 1)
 
2820
        finally:
 
2821
            self.pb.clear()
 
2822
 
 
2823
    def _write_all_revs(self):
 
2824
        """Write all revisions out in new form."""
 
2825
        self.bzrdir.transport.delete_tree('revision-store')
 
2826
        self.bzrdir.transport.mkdir('revision-store')
 
2827
        revision_transport = self.bzrdir.transport.clone('revision-store')
 
2828
        # TODO permissions
 
2829
        from bzrlib.xml5 import serializer_v5
 
2830
        from bzrlib.repofmt.weaverepo import RevisionTextStore
 
2831
        revision_store = RevisionTextStore(revision_transport,
 
2832
            serializer_v5, False, versionedfile.PrefixMapper(),
 
2833
            lambda:True, lambda:True)
 
2834
        try:
 
2835
            for i, rev_id in enumerate(self.converted_revs):
 
2836
                self.pb.update('write revision', i, len(self.converted_revs))
 
2837
                text = serializer_v5.write_revision_to_string(
 
2838
                    self.revisions[rev_id])
 
2839
                key = (rev_id,)
 
2840
                revision_store.add_lines(key, None, osutils.split_lines(text))
 
2841
        finally:
 
2842
            self.pb.clear()
 
2843
 
 
2844
    def _load_one_rev(self, rev_id):
 
2845
        """Load a revision object into memory.
 
2846
 
 
2847
        Any parents not either loaded or abandoned get queued to be
 
2848
        loaded."""
 
2849
        self.pb.update('loading revision',
 
2850
                       len(self.revisions),
 
2851
                       len(self.known_revisions))
 
2852
        if not self.branch.repository.has_revision(rev_id):
 
2853
            self.pb.clear()
 
2854
            ui.ui_factory.note('revision {%s} not present in branch; '
 
2855
                         'will be converted as a ghost' %
 
2856
                         rev_id)
 
2857
            self.absent_revisions.add(rev_id)
 
2858
        else:
 
2859
            rev = self.branch.repository.get_revision(rev_id)
 
2860
            for parent_id in rev.parent_ids:
 
2861
                self.known_revisions.add(parent_id)
 
2862
                self.to_read.append(parent_id)
 
2863
            self.revisions[rev_id] = rev
 
2864
 
 
2865
    def _load_old_inventory(self, rev_id):
 
2866
        old_inv_xml = self.branch.repository.inventory_store.get(rev_id).read()
 
2867
        inv = xml4.serializer_v4.read_inventory_from_string(old_inv_xml)
 
2868
        inv.revision_id = rev_id
 
2869
        rev = self.revisions[rev_id]
 
2870
        return inv
 
2871
 
 
2872
    def _load_updated_inventory(self, rev_id):
 
2873
        inv_xml = self.inv_weave.get_text(rev_id)
 
2874
        inv = xml5.serializer_v5.read_inventory_from_string(inv_xml, rev_id)
 
2875
        return inv
 
2876
 
 
2877
    def _convert_one_rev(self, rev_id):
 
2878
        """Convert revision and all referenced objects to new format."""
 
2879
        rev = self.revisions[rev_id]
 
2880
        inv = self._load_old_inventory(rev_id)
 
2881
        present_parents = [p for p in rev.parent_ids
 
2882
                           if p not in self.absent_revisions]
 
2883
        self._convert_revision_contents(rev, inv, present_parents)
 
2884
        self._store_new_inv(rev, inv, present_parents)
 
2885
        self.converted_revs.add(rev_id)
 
2886
 
 
2887
    def _store_new_inv(self, rev, inv, present_parents):
 
2888
        new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
 
2889
        new_inv_sha1 = sha_string(new_inv_xml)
 
2890
        self.inv_weave.add_lines(rev.revision_id,
 
2891
                                 present_parents,
 
2892
                                 new_inv_xml.splitlines(True))
 
2893
        rev.inventory_sha1 = new_inv_sha1
 
2894
 
 
2895
    def _convert_revision_contents(self, rev, inv, present_parents):
 
2896
        """Convert all the files within a revision.
 
2897
 
 
2898
        Also upgrade the inventory to refer to the text revision ids."""
 
2899
        rev_id = rev.revision_id
 
2900
        mutter('converting texts of revision {%s}',
 
2901
               rev_id)
 
2902
        parent_invs = map(self._load_updated_inventory, present_parents)
 
2903
        entries = inv.iter_entries()
 
2904
        entries.next()
 
2905
        for path, ie in entries:
 
2906
            self._convert_file_version(rev, ie, parent_invs)
 
2907
 
 
2908
    def _convert_file_version(self, rev, ie, parent_invs):
 
2909
        """Convert one version of one file.
 
2910
 
 
2911
        The file needs to be added into the weave if it is a merge
 
2912
        of >=2 parents or if it's changed from its parent.
 
2913
        """
 
2914
        file_id = ie.file_id
 
2915
        rev_id = rev.revision_id
 
2916
        w = self.text_weaves.get(file_id)
 
2917
        if w is None:
 
2918
            w = Weave(file_id)
 
2919
            self.text_weaves[file_id] = w
 
2920
        text_changed = False
 
2921
        parent_candiate_entries = ie.parent_candidates(parent_invs)
 
2922
        heads = graph.Graph(self).heads(parent_candiate_entries.keys())
 
2923
        # XXX: Note that this is unordered - and this is tolerable because
 
2924
        # the previous code was also unordered.
 
2925
        previous_entries = dict((head, parent_candiate_entries[head]) for head
 
2926
            in heads)
 
2927
        self.snapshot_ie(previous_entries, ie, w, rev_id)
 
2928
        del ie.text_id
 
2929
 
 
2930
    def get_parent_map(self, revision_ids):
 
2931
        """See graph.StackedParentsProvider.get_parent_map"""
 
2932
        return dict((revision_id, self.revisions[revision_id])
 
2933
                    for revision_id in revision_ids
 
2934
                     if revision_id in self.revisions)
 
2935
 
 
2936
    def snapshot_ie(self, previous_revisions, ie, w, rev_id):
 
2937
        # TODO: convert this logic, which is ~= snapshot to
 
2938
        # a call to:. This needs the path figured out. rather than a work_tree
 
2939
        # a v4 revision_tree can be given, or something that looks enough like
 
2940
        # one to give the file content to the entry if it needs it.
 
2941
        # and we need something that looks like a weave store for snapshot to
 
2942
        # save against.
 
2943
        #ie.snapshot(rev, PATH, previous_revisions, REVISION_TREE, InMemoryWeaveStore(self.text_weaves))
 
2944
        if len(previous_revisions) == 1:
 
2945
            previous_ie = previous_revisions.values()[0]
 
2946
            if ie._unchanged(previous_ie):
 
2947
                ie.revision = previous_ie.revision
 
2948
                return
 
2949
        if ie.has_text():
 
2950
            text = self.branch.repository._text_store.get(ie.text_id)
 
2951
            file_lines = text.readlines()
 
2952
            w.add_lines(rev_id, previous_revisions, file_lines)
 
2953
            self.text_count += 1
 
2954
        else:
 
2955
            w.add_lines(rev_id, previous_revisions, [])
 
2956
        ie.revision = rev_id
 
2957
 
 
2958
    def _make_order(self):
 
2959
        """Return a suitable order for importing revisions.
 
2960
 
 
2961
        The order must be such that an revision is imported after all
 
2962
        its (present) parents.
 
2963
        """
 
2964
        todo = set(self.revisions.keys())
 
2965
        done = self.absent_revisions.copy()
 
2966
        order = []
 
2967
        while todo:
 
2968
            # scan through looking for a revision whose parents
 
2969
            # are all done
 
2970
            for rev_id in sorted(list(todo)):
 
2971
                rev = self.revisions[rev_id]
 
2972
                parent_ids = set(rev.parent_ids)
 
2973
                if parent_ids.issubset(done):
 
2974
                    # can take this one now
 
2975
                    order.append(rev_id)
 
2976
                    todo.remove(rev_id)
 
2977
                    done.add(rev_id)
 
2978
        return order
 
2979
 
 
2980
 
 
2981
class ConvertBzrDir5To6(Converter):
 
2982
    """Converts format 5 bzr dirs to format 6."""
 
2983
 
 
2984
    def convert(self, to_convert, pb):
 
2985
        """See Converter.convert()."""
 
2986
        self.bzrdir = to_convert
 
2987
        pb = ui.ui_factory.nested_progress_bar()
 
2988
        try:
 
2989
            ui.ui_factory.note('starting upgrade from format 5 to 6')
 
2990
            self._convert_to_prefixed()
 
2991
            return BzrDir.open(self.bzrdir.user_url)
 
2992
        finally:
 
2993
            pb.finished()
 
2994
 
 
2995
    def _convert_to_prefixed(self):
 
2996
        from bzrlib.store import TransportStore
 
2997
        self.bzrdir.transport.delete('branch-format')
 
2998
        for store_name in ["weaves", "revision-store"]:
 
2999
            ui.ui_factory.note("adding prefixes to %s" % store_name)
 
3000
            store_transport = self.bzrdir.transport.clone(store_name)
 
3001
            store = TransportStore(store_transport, prefixed=True)
 
3002
            for urlfilename in store_transport.list_dir('.'):
 
3003
                filename = urlutils.unescape(urlfilename)
 
3004
                if (filename.endswith(".weave") or
 
3005
                    filename.endswith(".gz") or
 
3006
                    filename.endswith(".sig")):
 
3007
                    file_id, suffix = os.path.splitext(filename)
 
3008
                else:
 
3009
                    file_id = filename
 
3010
                    suffix = ''
 
3011
                new_name = store._mapper.map((file_id,)) + suffix
 
3012
                # FIXME keep track of the dirs made RBC 20060121
 
3013
                try:
 
3014
                    store_transport.move(filename, new_name)
 
3015
                except errors.NoSuchFile: # catches missing dirs strangely enough
 
3016
                    store_transport.mkdir(osutils.dirname(new_name))
 
3017
                    store_transport.move(filename, new_name)
 
3018
        self.bzrdir.transport.put_bytes(
 
3019
            'branch-format',
 
3020
            BzrDirFormat6().get_format_string(),
 
3021
            mode=self.bzrdir._get_file_mode())
 
3022
 
 
3023
 
 
3024
class ConvertBzrDir6ToMeta(Converter):
 
3025
    """Converts format 6 bzr dirs to metadirs."""
 
3026
 
 
3027
    def convert(self, to_convert, pb):
 
3028
        """See Converter.convert()."""
 
3029
        from bzrlib.repofmt.weaverepo import RepositoryFormat7
 
3030
        from bzrlib.branch import BzrBranchFormat5
 
3031
        self.bzrdir = to_convert
 
3032
        self.pb = ui.ui_factory.nested_progress_bar()
 
3033
        self.count = 0
 
3034
        self.total = 20 # the steps we know about
 
3035
        self.garbage_inventories = []
 
3036
        self.dir_mode = self.bzrdir._get_dir_mode()
 
3037
        self.file_mode = self.bzrdir._get_file_mode()
 
3038
 
 
3039
        ui.ui_factory.note('starting upgrade from format 6 to metadir')
 
3040
        self.bzrdir.transport.put_bytes(
 
3041
                'branch-format',
 
3042
                "Converting to format 6",
 
3043
                mode=self.file_mode)
 
3044
        # its faster to move specific files around than to open and use the apis...
 
3045
        # first off, nuke ancestry.weave, it was never used.
 
3046
        try:
 
3047
            self.step('Removing ancestry.weave')
 
3048
            self.bzrdir.transport.delete('ancestry.weave')
 
3049
        except errors.NoSuchFile:
 
3050
            pass
 
3051
        # find out whats there
 
3052
        self.step('Finding branch files')
 
3053
        last_revision = self.bzrdir.open_branch().last_revision()
 
3054
        bzrcontents = self.bzrdir.transport.list_dir('.')
 
3055
        for name in bzrcontents:
 
3056
            if name.startswith('basis-inventory.'):
 
3057
                self.garbage_inventories.append(name)
 
3058
        # create new directories for repository, working tree and branch
 
3059
        repository_names = [('inventory.weave', True),
 
3060
                            ('revision-store', True),
 
3061
                            ('weaves', True)]
 
3062
        self.step('Upgrading repository  ')
 
3063
        self.bzrdir.transport.mkdir('repository', mode=self.dir_mode)
 
3064
        self.make_lock('repository')
 
3065
        # we hard code the formats here because we are converting into
 
3066
        # the meta format. The meta format upgrader can take this to a
 
3067
        # future format within each component.
 
3068
        self.put_format('repository', RepositoryFormat7())
 
3069
        for entry in repository_names:
 
3070
            self.move_entry('repository', entry)
 
3071
 
 
3072
        self.step('Upgrading branch      ')
 
3073
        self.bzrdir.transport.mkdir('branch', mode=self.dir_mode)
 
3074
        self.make_lock('branch')
 
3075
        self.put_format('branch', BzrBranchFormat5())
 
3076
        branch_files = [('revision-history', True),
 
3077
                        ('branch-name', True),
 
3078
                        ('parent', False)]
 
3079
        for entry in branch_files:
 
3080
            self.move_entry('branch', entry)
 
3081
 
 
3082
        checkout_files = [('pending-merges', True),
 
3083
                          ('inventory', True),
 
3084
                          ('stat-cache', False)]
 
3085
        # If a mandatory checkout file is not present, the branch does not have
 
3086
        # a functional checkout. Do not create a checkout in the converted
 
3087
        # branch.
 
3088
        for name, mandatory in checkout_files:
 
3089
            if mandatory and name not in bzrcontents:
 
3090
                has_checkout = False
 
3091
                break
 
3092
        else:
 
3093
            has_checkout = True
 
3094
        if not has_checkout:
 
3095
            ui.ui_factory.note('No working tree.')
 
3096
            # If some checkout files are there, we may as well get rid of them.
 
3097
            for name, mandatory in checkout_files:
 
3098
                if name in bzrcontents:
 
3099
                    self.bzrdir.transport.delete(name)
 
3100
        else:
 
3101
            from bzrlib.workingtree import WorkingTreeFormat3
 
3102
            self.step('Upgrading working tree')
 
3103
            self.bzrdir.transport.mkdir('checkout', mode=self.dir_mode)
 
3104
            self.make_lock('checkout')
 
3105
            self.put_format(
 
3106
                'checkout', WorkingTreeFormat3())
 
3107
            self.bzrdir.transport.delete_multi(
 
3108
                self.garbage_inventories, self.pb)
 
3109
            for entry in checkout_files:
 
3110
                self.move_entry('checkout', entry)
 
3111
            if last_revision is not None:
 
3112
                self.bzrdir.transport.put_bytes(
 
3113
                    'checkout/last-revision', last_revision)
 
3114
        self.bzrdir.transport.put_bytes(
 
3115
            'branch-format',
 
3116
            BzrDirMetaFormat1().get_format_string(),
 
3117
            mode=self.file_mode)
 
3118
        self.pb.finished()
 
3119
        return BzrDir.open(self.bzrdir.user_url)
 
3120
 
 
3121
    def make_lock(self, name):
 
3122
        """Make a lock for the new control dir name."""
 
3123
        self.step('Make %s lock' % name)
 
3124
        ld = lockdir.LockDir(self.bzrdir.transport,
 
3125
                             '%s/lock' % name,
 
3126
                             file_modebits=self.file_mode,
 
3127
                             dir_modebits=self.dir_mode)
 
3128
        ld.create()
 
3129
 
 
3130
    def move_entry(self, new_dir, entry):
 
3131
        """Move then entry name into new_dir."""
 
3132
        name = entry[0]
 
3133
        mandatory = entry[1]
 
3134
        self.step('Moving %s' % name)
 
3135
        try:
 
3136
            self.bzrdir.transport.move(name, '%s/%s' % (new_dir, name))
 
3137
        except errors.NoSuchFile:
 
3138
            if mandatory:
 
3139
                raise
 
3140
 
 
3141
    def put_format(self, dirname, format):
 
3142
        self.bzrdir.transport.put_bytes('%s/format' % dirname,
 
3143
            format.get_format_string(),
 
3144
            self.file_mode)
 
3145
 
 
3146
 
 
3147
class ConvertMetaToMeta(Converter):
1833
3148
    """Converts the components of metadirs."""
1834
3149
 
1835
3150
    def __init__(self, target_format):
1860
3175
            # TODO: conversions of Branch and Tree should be done by
1861
3176
            # InterXFormat lookups/some sort of registry.
1862
3177
            # Avoid circular imports
 
3178
            from bzrlib import branch as _mod_branch
1863
3179
            old = branch._format.__class__
1864
3180
            new = self.target_format.get_branch_format().__class__
1865
3181
            while old != new:
1888
3204
        else:
1889
3205
            # TODO: conversions of Branch and Tree should be done by
1890
3206
            # InterXFormat lookups
1891
 
            if (isinstance(tree, workingtree_3.WorkingTree3) and
 
3207
            if (isinstance(tree, workingtree.WorkingTree3) and
1892
3208
                not isinstance(tree, workingtree_4.DirStateWorkingTree) and
1893
3209
                isinstance(self.target_format.workingtree_format,
1894
3210
                    workingtree_4.DirStateWorkingTreeFormat)):
1907
3223
        return to_convert
1908
3224
 
1909
3225
 
1910
 
controldir.ControlDirFormat.register_server_prober(RemoteBzrProber)
 
3226
# This is not in remote.py because it's relatively small, and needs to be
 
3227
# registered. Putting it in remote.py creates a circular import problem.
 
3228
# we can make it a lazy object if the control formats is turned into something
 
3229
# like a registry.
 
3230
class RemoteBzrDirFormat(BzrDirMetaFormat1):
 
3231
    """Format representing bzrdirs accessed via a smart server"""
 
3232
 
 
3233
    def __init__(self):
 
3234
        BzrDirMetaFormat1.__init__(self)
 
3235
        # XXX: It's a bit ugly that the network name is here, because we'd
 
3236
        # like to believe that format objects are stateless or at least
 
3237
        # immutable,  However, we do at least avoid mutating the name after
 
3238
        # it's returned.  See <https://bugs.edge.launchpad.net/bzr/+bug/504102>
 
3239
        self._network_name = None
 
3240
 
 
3241
    def __repr__(self):
 
3242
        return "%s(_network_name=%r)" % (self.__class__.__name__,
 
3243
            self._network_name)
 
3244
 
 
3245
    def get_format_description(self):
 
3246
        if self._network_name:
 
3247
            real_format = network_format_registry.get(self._network_name)
 
3248
            return 'Remote: ' + real_format.get_format_description()
 
3249
        return 'bzr remote bzrdir'
 
3250
 
 
3251
    def get_format_string(self):
 
3252
        raise NotImplementedError(self.get_format_string)
 
3253
 
 
3254
    def network_name(self):
 
3255
        if self._network_name:
 
3256
            return self._network_name
 
3257
        else:
 
3258
            raise AssertionError("No network name set.")
 
3259
 
 
3260
    @classmethod
 
3261
    def probe_transport(klass, transport):
 
3262
        """Return a RemoteBzrDirFormat object if it looks possible."""
 
3263
        try:
 
3264
            medium = transport.get_smart_medium()
 
3265
        except (NotImplementedError, AttributeError,
 
3266
                errors.TransportNotPossible, errors.NoSmartMedium,
 
3267
                errors.SmartProtocolError):
 
3268
            # no smart server, so not a branch for this format type.
 
3269
            raise errors.NotBranchError(path=transport.base)
 
3270
        else:
 
3271
            # Decline to open it if the server doesn't support our required
 
3272
            # version (3) so that the VFS-based transport will do it.
 
3273
            if medium.should_probe():
 
3274
                try:
 
3275
                    server_version = medium.protocol_version()
 
3276
                except errors.SmartProtocolError:
 
3277
                    # Apparently there's no usable smart server there, even though
 
3278
                    # the medium supports the smart protocol.
 
3279
                    raise errors.NotBranchError(path=transport.base)
 
3280
                if server_version != '2':
 
3281
                    raise errors.NotBranchError(path=transport.base)
 
3282
            return klass()
 
3283
 
 
3284
    def initialize_on_transport(self, transport):
 
3285
        try:
 
3286
            # hand off the request to the smart server
 
3287
            client_medium = transport.get_smart_medium()
 
3288
        except errors.NoSmartMedium:
 
3289
            # TODO: lookup the local format from a server hint.
 
3290
            local_dir_format = BzrDirMetaFormat1()
 
3291
            return local_dir_format.initialize_on_transport(transport)
 
3292
        client = _SmartClient(client_medium)
 
3293
        path = client.remote_path_from_transport(transport)
 
3294
        try:
 
3295
            response = client.call('BzrDirFormat.initialize', path)
 
3296
        except errors.ErrorFromSmartServer, err:
 
3297
            remote._translate_error(err, path=path)
 
3298
        if response[0] != 'ok':
 
3299
            raise errors.SmartProtocolError('unexpected response code %s' % (response,))
 
3300
        format = RemoteBzrDirFormat()
 
3301
        self._supply_sub_formats_to(format)
 
3302
        return remote.RemoteBzrDir(transport, format)
 
3303
 
 
3304
    def parse_NoneTrueFalse(self, arg):
 
3305
        if not arg:
 
3306
            return None
 
3307
        if arg == 'False':
 
3308
            return False
 
3309
        if arg == 'True':
 
3310
            return True
 
3311
        raise AssertionError("invalid arg %r" % arg)
 
3312
 
 
3313
    def _serialize_NoneTrueFalse(self, arg):
 
3314
        if arg is False:
 
3315
            return 'False'
 
3316
        if arg:
 
3317
            return 'True'
 
3318
        return ''
 
3319
 
 
3320
    def _serialize_NoneString(self, arg):
 
3321
        return arg or ''
 
3322
 
 
3323
    def initialize_on_transport_ex(self, transport, use_existing_dir=False,
 
3324
        create_prefix=False, force_new_repo=False, stacked_on=None,
 
3325
        stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
 
3326
        shared_repo=False):
 
3327
        try:
 
3328
            # hand off the request to the smart server
 
3329
            client_medium = transport.get_smart_medium()
 
3330
        except errors.NoSmartMedium:
 
3331
            do_vfs = True
 
3332
        else:
 
3333
            # Decline to open it if the server doesn't support our required
 
3334
            # version (3) so that the VFS-based transport will do it.
 
3335
            if client_medium.should_probe():
 
3336
                try:
 
3337
                    server_version = client_medium.protocol_version()
 
3338
                    if server_version != '2':
 
3339
                        do_vfs = True
 
3340
                    else:
 
3341
                        do_vfs = False
 
3342
                except errors.SmartProtocolError:
 
3343
                    # Apparently there's no usable smart server there, even though
 
3344
                    # the medium supports the smart protocol.
 
3345
                    do_vfs = True
 
3346
            else:
 
3347
                do_vfs = False
 
3348
        if not do_vfs:
 
3349
            client = _SmartClient(client_medium)
 
3350
            path = client.remote_path_from_transport(transport)
 
3351
            if client_medium._is_remote_before((1, 16)):
 
3352
                do_vfs = True
 
3353
        if do_vfs:
 
3354
            # TODO: lookup the local format from a server hint.
 
3355
            local_dir_format = BzrDirMetaFormat1()
 
3356
            self._supply_sub_formats_to(local_dir_format)
 
3357
            return local_dir_format.initialize_on_transport_ex(transport,
 
3358
                use_existing_dir=use_existing_dir, create_prefix=create_prefix,
 
3359
                force_new_repo=force_new_repo, stacked_on=stacked_on,
 
3360
                stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
 
3361
                make_working_trees=make_working_trees, shared_repo=shared_repo,
 
3362
                vfs_only=True)
 
3363
        return self._initialize_on_transport_ex_rpc(client, path, transport,
 
3364
            use_existing_dir, create_prefix, force_new_repo, stacked_on,
 
3365
            stack_on_pwd, repo_format_name, make_working_trees, shared_repo)
 
3366
 
 
3367
    def _initialize_on_transport_ex_rpc(self, client, path, transport,
 
3368
        use_existing_dir, create_prefix, force_new_repo, stacked_on,
 
3369
        stack_on_pwd, repo_format_name, make_working_trees, shared_repo):
 
3370
        args = []
 
3371
        args.append(self._serialize_NoneTrueFalse(use_existing_dir))
 
3372
        args.append(self._serialize_NoneTrueFalse(create_prefix))
 
3373
        args.append(self._serialize_NoneTrueFalse(force_new_repo))
 
3374
        args.append(self._serialize_NoneString(stacked_on))
 
3375
        # stack_on_pwd is often/usually our transport
 
3376
        if stack_on_pwd:
 
3377
            try:
 
3378
                stack_on_pwd = transport.relpath(stack_on_pwd)
 
3379
                if not stack_on_pwd:
 
3380
                    stack_on_pwd = '.'
 
3381
            except errors.PathNotChild:
 
3382
                pass
 
3383
        args.append(self._serialize_NoneString(stack_on_pwd))
 
3384
        args.append(self._serialize_NoneString(repo_format_name))
 
3385
        args.append(self._serialize_NoneTrueFalse(make_working_trees))
 
3386
        args.append(self._serialize_NoneTrueFalse(shared_repo))
 
3387
        request_network_name = self._network_name or \
 
3388
            BzrDirFormat.get_default_format().network_name()
 
3389
        try:
 
3390
            response = client.call('BzrDirFormat.initialize_ex_1.16',
 
3391
                request_network_name, path, *args)
 
3392
        except errors.UnknownSmartMethod:
 
3393
            client._medium._remember_remote_is_before((1,16))
 
3394
            local_dir_format = BzrDirMetaFormat1()
 
3395
            self._supply_sub_formats_to(local_dir_format)
 
3396
            return local_dir_format.initialize_on_transport_ex(transport,
 
3397
                use_existing_dir=use_existing_dir, create_prefix=create_prefix,
 
3398
                force_new_repo=force_new_repo, stacked_on=stacked_on,
 
3399
                stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
 
3400
                make_working_trees=make_working_trees, shared_repo=shared_repo,
 
3401
                vfs_only=True)
 
3402
        except errors.ErrorFromSmartServer, err:
 
3403
            remote._translate_error(err, path=path)
 
3404
        repo_path = response[0]
 
3405
        bzrdir_name = response[6]
 
3406
        require_stacking = response[7]
 
3407
        require_stacking = self.parse_NoneTrueFalse(require_stacking)
 
3408
        format = RemoteBzrDirFormat()
 
3409
        format._network_name = bzrdir_name
 
3410
        self._supply_sub_formats_to(format)
 
3411
        bzrdir = remote.RemoteBzrDir(transport, format, _client=client)
 
3412
        if repo_path:
 
3413
            repo_format = remote.response_tuple_to_repo_format(response[1:])
 
3414
            if repo_path == '.':
 
3415
                repo_path = ''
 
3416
            if repo_path:
 
3417
                repo_bzrdir_format = RemoteBzrDirFormat()
 
3418
                repo_bzrdir_format._network_name = response[5]
 
3419
                repo_bzr = remote.RemoteBzrDir(transport.clone(repo_path),
 
3420
                    repo_bzrdir_format)
 
3421
            else:
 
3422
                repo_bzr = bzrdir
 
3423
            final_stack = response[8] or None
 
3424
            final_stack_pwd = response[9] or None
 
3425
            if final_stack_pwd:
 
3426
                final_stack_pwd = urlutils.join(
 
3427
                    transport.base, final_stack_pwd)
 
3428
            remote_repo = remote.RemoteRepository(repo_bzr, repo_format)
 
3429
            if len(response) > 10:
 
3430
                # Updated server verb that locks remotely.
 
3431
                repo_lock_token = response[10] or None
 
3432
                remote_repo.lock_write(repo_lock_token, _skip_rpc=True)
 
3433
                if repo_lock_token:
 
3434
                    remote_repo.dont_leave_lock_in_place()
 
3435
            else:
 
3436
                remote_repo.lock_write()
 
3437
            policy = UseExistingRepository(remote_repo, final_stack,
 
3438
                final_stack_pwd, require_stacking)
 
3439
            policy.acquire_repository()
 
3440
        else:
 
3441
            remote_repo = None
 
3442
            policy = None
 
3443
        bzrdir._format.set_branch_format(self.get_branch_format())
 
3444
        if require_stacking:
 
3445
            # The repo has already been created, but we need to make sure that
 
3446
            # we'll make a stackable branch.
 
3447
            bzrdir._format.require_stacking(_skip_repo=True)
 
3448
        return remote_repo, bzrdir, require_stacking, policy
 
3449
 
 
3450
    def _open(self, transport):
 
3451
        return remote.RemoteBzrDir(transport, self)
 
3452
 
 
3453
    def __eq__(self, other):
 
3454
        if not isinstance(other, RemoteBzrDirFormat):
 
3455
            return False
 
3456
        return self.get_format_description() == other.get_format_description()
 
3457
 
 
3458
    def __return_repository_format(self):
 
3459
        # Always return a RemoteRepositoryFormat object, but if a specific bzr
 
3460
        # repository format has been asked for, tell the RemoteRepositoryFormat
 
3461
        # that it should use that for init() etc.
 
3462
        result = remote.RemoteRepositoryFormat()
 
3463
        custom_format = getattr(self, '_repository_format', None)
 
3464
        if custom_format:
 
3465
            if isinstance(custom_format, remote.RemoteRepositoryFormat):
 
3466
                return custom_format
 
3467
            else:
 
3468
                # We will use the custom format to create repositories over the
 
3469
                # wire; expose its details like rich_root_data for code to
 
3470
                # query
 
3471
                result._custom_format = custom_format
 
3472
        return result
 
3473
 
 
3474
    def get_branch_format(self):
 
3475
        result = BzrDirMetaFormat1.get_branch_format(self)
 
3476
        if not isinstance(result, remote.RemoteBranchFormat):
 
3477
            new_result = remote.RemoteBranchFormat()
 
3478
            new_result._custom_format = result
 
3479
            # cache the result
 
3480
            self.set_branch_format(new_result)
 
3481
            result = new_result
 
3482
        return result
 
3483
 
 
3484
    repository_format = property(__return_repository_format,
 
3485
        BzrDirMetaFormat1._set_repository_format) #.im_func)
 
3486
 
 
3487
 
 
3488
BzrDirFormat.register_control_server_format(RemoteBzrDirFormat)
 
3489
 
 
3490
 
 
3491
class BzrDirFormatInfo(object):
 
3492
 
 
3493
    def __init__(self, native, deprecated, hidden, experimental):
 
3494
        self.deprecated = deprecated
 
3495
        self.native = native
 
3496
        self.hidden = hidden
 
3497
        self.experimental = experimental
 
3498
 
 
3499
 
 
3500
class BzrDirFormatRegistry(registry.Registry):
 
3501
    """Registry of user-selectable BzrDir subformats.
 
3502
 
 
3503
    Differs from BzrDirFormat._control_formats in that it provides sub-formats,
 
3504
    e.g. BzrDirMeta1 with weave repository.  Also, it's more user-oriented.
 
3505
    """
 
3506
 
 
3507
    def __init__(self):
 
3508
        """Create a BzrDirFormatRegistry."""
 
3509
        self._aliases = set()
 
3510
        self._registration_order = list()
 
3511
        super(BzrDirFormatRegistry, self).__init__()
 
3512
 
 
3513
    def aliases(self):
 
3514
        """Return a set of the format names which are aliases."""
 
3515
        return frozenset(self._aliases)
 
3516
 
 
3517
    def register_metadir(self, key,
 
3518
             repository_format, help, native=True, deprecated=False,
 
3519
             branch_format=None,
 
3520
             tree_format=None,
 
3521
             hidden=False,
 
3522
             experimental=False,
 
3523
             alias=False):
 
3524
        """Register a metadir subformat.
 
3525
 
 
3526
        These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
 
3527
        by the Repository/Branch/WorkingTreeformats.
 
3528
 
 
3529
        :param repository_format: The fully-qualified repository format class
 
3530
            name as a string.
 
3531
        :param branch_format: Fully-qualified branch format class name as
 
3532
            a string.
 
3533
        :param tree_format: Fully-qualified tree format class name as
 
3534
            a string.
 
3535
        """
 
3536
        # This should be expanded to support setting WorkingTree and Branch
 
3537
        # formats, once BzrDirMetaFormat1 supports that.
 
3538
        def _load(full_name):
 
3539
            mod_name, factory_name = full_name.rsplit('.', 1)
 
3540
            try:
 
3541
                mod = __import__(mod_name, globals(), locals(),
 
3542
                        [factory_name])
 
3543
            except ImportError, e:
 
3544
                raise ImportError('failed to load %s: %s' % (full_name, e))
 
3545
            try:
 
3546
                factory = getattr(mod, factory_name)
 
3547
            except AttributeError:
 
3548
                raise AttributeError('no factory %s in module %r'
 
3549
                    % (full_name, mod))
 
3550
            return factory()
 
3551
 
 
3552
        def helper():
 
3553
            bd = BzrDirMetaFormat1()
 
3554
            if branch_format is not None:
 
3555
                bd.set_branch_format(_load(branch_format))
 
3556
            if tree_format is not None:
 
3557
                bd.workingtree_format = _load(tree_format)
 
3558
            if repository_format is not None:
 
3559
                bd.repository_format = _load(repository_format)
 
3560
            return bd
 
3561
        self.register(key, helper, help, native, deprecated, hidden,
 
3562
            experimental, alias)
 
3563
 
 
3564
    def register(self, key, factory, help, native=True, deprecated=False,
 
3565
                 hidden=False, experimental=False, alias=False):
 
3566
        """Register a BzrDirFormat factory.
 
3567
 
 
3568
        The factory must be a callable that takes one parameter: the key.
 
3569
        It must produce an instance of the BzrDirFormat when called.
 
3570
 
 
3571
        This function mainly exists to prevent the info object from being
 
3572
        supplied directly.
 
3573
        """
 
3574
        registry.Registry.register(self, key, factory, help,
 
3575
            BzrDirFormatInfo(native, deprecated, hidden, experimental))
 
3576
        if alias:
 
3577
            self._aliases.add(key)
 
3578
        self._registration_order.append(key)
 
3579
 
 
3580
    def register_lazy(self, key, module_name, member_name, help, native=True,
 
3581
        deprecated=False, hidden=False, experimental=False, alias=False):
 
3582
        registry.Registry.register_lazy(self, key, module_name, member_name,
 
3583
            help, BzrDirFormatInfo(native, deprecated, hidden, experimental))
 
3584
        if alias:
 
3585
            self._aliases.add(key)
 
3586
        self._registration_order.append(key)
 
3587
 
 
3588
    def set_default(self, key):
 
3589
        """Set the 'default' key to be a clone of the supplied key.
 
3590
 
 
3591
        This method must be called once and only once.
 
3592
        """
 
3593
        registry.Registry.register(self, 'default', self.get(key),
 
3594
            self.get_help(key), info=self.get_info(key))
 
3595
        self._aliases.add('default')
 
3596
 
 
3597
    def set_default_repository(self, key):
 
3598
        """Set the FormatRegistry default and Repository default.
 
3599
 
 
3600
        This is a transitional method while Repository.set_default_format
 
3601
        is deprecated.
 
3602
        """
 
3603
        if 'default' in self:
 
3604
            self.remove('default')
 
3605
        self.set_default(key)
 
3606
        format = self.get('default')()
 
3607
 
 
3608
    def make_bzrdir(self, key):
 
3609
        return self.get(key)()
 
3610
 
 
3611
    def help_topic(self, topic):
 
3612
        output = ""
 
3613
        default_realkey = None
 
3614
        default_help = self.get_help('default')
 
3615
        help_pairs = []
 
3616
        for key in self._registration_order:
 
3617
            if key == 'default':
 
3618
                continue
 
3619
            help = self.get_help(key)
 
3620
            if help == default_help:
 
3621
                default_realkey = key
 
3622
            else:
 
3623
                help_pairs.append((key, help))
 
3624
 
 
3625
        def wrapped(key, help, info):
 
3626
            if info.native:
 
3627
                help = '(native) ' + help
 
3628
            return ':%s:\n%s\n\n' % (key,
 
3629
                textwrap.fill(help, initial_indent='    ',
 
3630
                    subsequent_indent='    ',
 
3631
                    break_long_words=False))
 
3632
        if default_realkey is not None:
 
3633
            output += wrapped(default_realkey, '(default) %s' % default_help,
 
3634
                              self.get_info('default'))
 
3635
        deprecated_pairs = []
 
3636
        experimental_pairs = []
 
3637
        for key, help in help_pairs:
 
3638
            info = self.get_info(key)
 
3639
            if info.hidden:
 
3640
                continue
 
3641
            elif info.deprecated:
 
3642
                deprecated_pairs.append((key, help))
 
3643
            elif info.experimental:
 
3644
                experimental_pairs.append((key, help))
 
3645
            else:
 
3646
                output += wrapped(key, help, info)
 
3647
        output += "\nSee :doc:`formats-help` for more about storage formats."
 
3648
        other_output = ""
 
3649
        if len(experimental_pairs) > 0:
 
3650
            other_output += "Experimental formats are shown below.\n\n"
 
3651
            for key, help in experimental_pairs:
 
3652
                info = self.get_info(key)
 
3653
                other_output += wrapped(key, help, info)
 
3654
        else:
 
3655
            other_output += \
 
3656
                "No experimental formats are available.\n\n"
 
3657
        if len(deprecated_pairs) > 0:
 
3658
            other_output += "\nDeprecated formats are shown below.\n\n"
 
3659
            for key, help in deprecated_pairs:
 
3660
                info = self.get_info(key)
 
3661
                other_output += wrapped(key, help, info)
 
3662
        else:
 
3663
            other_output += \
 
3664
                "\nNo deprecated formats are available.\n\n"
 
3665
        other_output += \
 
3666
                "\nSee :doc:`formats-help` for more about storage formats."
 
3667
 
 
3668
        if topic == 'other-formats':
 
3669
            return other_output
 
3670
        else:
 
3671
            return output
1911
3672
 
1912
3673
 
1913
3674
class RepositoryAcquisitionPolicy(object):
1994
3755
 
1995
3756
        Implementations may create a new repository or use a pre-exising
1996
3757
        repository.
1997
 
 
1998
3758
        :param make_working_trees: If creating a repository, set
1999
3759
            make_working_trees to this value (if non-None)
2000
3760
        :param shared: If creating a repository, make it shared if True
2009
3769
 
2010
3770
    def __init__(self, bzrdir, stack_on=None, stack_on_pwd=None,
2011
3771
                 require_stacking=False):
2012
 
        """Constructor.
2013
 
 
 
3772
        """
 
3773
        Constructor.
2014
3774
        :param bzrdir: The bzrdir to create the repository on.
2015
3775
        :param stack_on: A location to stack on
2016
3776
        :param stack_on_pwd: If stack_on is relative, the location it is
2068
3828
        return self._repository, False
2069
3829
 
2070
3830
 
2071
 
def register_metadir(registry, key,
2072
 
         repository_format, help, native=True, deprecated=False,
2073
 
         branch_format=None,
2074
 
         tree_format=None,
2075
 
         hidden=False,
2076
 
         experimental=False,
2077
 
         alias=False):
2078
 
    """Register a metadir subformat.
2079
 
 
2080
 
    These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
2081
 
    by the Repository/Branch/WorkingTreeformats.
2082
 
 
2083
 
    :param repository_format: The fully-qualified repository format class
2084
 
        name as a string.
2085
 
    :param branch_format: Fully-qualified branch format class name as
2086
 
        a string.
2087
 
    :param tree_format: Fully-qualified tree format class name as
2088
 
        a string.
2089
 
    """
2090
 
    # This should be expanded to support setting WorkingTree and Branch
2091
 
    # formats, once BzrDirMetaFormat1 supports that.
2092
 
    def _load(full_name):
2093
 
        mod_name, factory_name = full_name.rsplit('.', 1)
2094
 
        try:
2095
 
            factory = pyutils.get_named_object(mod_name, factory_name)
2096
 
        except ImportError, e:
2097
 
            raise ImportError('failed to load %s: %s' % (full_name, e))
2098
 
        except AttributeError:
2099
 
            raise AttributeError('no factory %s in module %r'
2100
 
                % (full_name, sys.modules[mod_name]))
2101
 
        return factory()
2102
 
 
2103
 
    def helper():
2104
 
        bd = BzrDirMetaFormat1()
2105
 
        if branch_format is not None:
2106
 
            bd.set_branch_format(_load(branch_format))
2107
 
        if tree_format is not None:
2108
 
            bd.workingtree_format = _load(tree_format)
2109
 
        if repository_format is not None:
2110
 
            bd.repository_format = _load(repository_format)
2111
 
        return bd
2112
 
    registry.register(key, helper, help, native, deprecated, hidden,
2113
 
        experimental, alias)
2114
 
 
2115
 
register_metadir(controldir.format_registry, 'knit',
 
3831
# Please register new formats after old formats so that formats
 
3832
# appear in chronological order and format descriptions can build
 
3833
# on previous ones.
 
3834
format_registry = BzrDirFormatRegistry()
 
3835
# The pre-0.8 formats have their repository format network name registered in
 
3836
# repository.py. MetaDir formats have their repository format network name
 
3837
# inferred from their disk format string.
 
3838
format_registry.register('weave', BzrDirFormat6,
 
3839
    'Pre-0.8 format.  Slower than knit and does not'
 
3840
    ' support checkouts or shared repositories.',
 
3841
    hidden=True,
 
3842
    deprecated=True)
 
3843
format_registry.register_metadir('metaweave',
 
3844
    'bzrlib.repofmt.weaverepo.RepositoryFormat7',
 
3845
    'Transitional format in 0.8.  Slower than knit.',
 
3846
    branch_format='bzrlib.branch.BzrBranchFormat5',
 
3847
    tree_format='bzrlib.workingtree.WorkingTreeFormat3',
 
3848
    hidden=True,
 
3849
    deprecated=True)
 
3850
format_registry.register_metadir('knit',
2116
3851
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2117
3852
    'Format using knits.  Recommended for interoperation with bzr <= 0.14.',
2118
3853
    branch_format='bzrlib.branch.BzrBranchFormat5',
2119
 
    tree_format='bzrlib.workingtree_3.WorkingTreeFormat3',
 
3854
    tree_format='bzrlib.workingtree.WorkingTreeFormat3',
2120
3855
    hidden=True,
2121
3856
    deprecated=True)
2122
 
register_metadir(controldir.format_registry, 'dirstate',
 
3857
format_registry.register_metadir('dirstate',
2123
3858
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2124
3859
    help='New in 0.15: Fast local operations. Compatible with bzr 0.8 and '
2125
3860
        'above when accessed over the network.',
2126
3861
    branch_format='bzrlib.branch.BzrBranchFormat5',
2127
 
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
3862
    # this uses bzrlib.workingtree.WorkingTreeFormat4 because importing
 
3863
    # directly from workingtree_4 triggers a circular import.
 
3864
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2128
3865
    hidden=True,
2129
3866
    deprecated=True)
2130
 
register_metadir(controldir.format_registry, 'dirstate-tags',
 
3867
format_registry.register_metadir('dirstate-tags',
2131
3868
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2132
3869
    help='New in 0.15: Fast local operations and improved scaling for '
2133
3870
        'network operations. Additionally adds support for tags.'
2134
3871
        ' Incompatible with bzr < 0.15.',
2135
3872
    branch_format='bzrlib.branch.BzrBranchFormat6',
2136
 
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
3873
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2137
3874
    hidden=True,
2138
3875
    deprecated=True)
2139
 
register_metadir(controldir.format_registry, 'rich-root',
 
3876
format_registry.register_metadir('rich-root',
2140
3877
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
2141
3878
    help='New in 1.0.  Better handling of tree roots.  Incompatible with'
2142
3879
        ' bzr < 1.0.',
2143
3880
    branch_format='bzrlib.branch.BzrBranchFormat6',
2144
 
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
3881
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2145
3882
    hidden=True,
2146
3883
    deprecated=True)
2147
 
register_metadir(controldir.format_registry, 'dirstate-with-subtree',
 
3884
format_registry.register_metadir('dirstate-with-subtree',
2148
3885
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
2149
3886
    help='New in 0.15: Fast local operations and improved scaling for '
2150
3887
        'network operations. Additionally adds support for versioning nested '
2151
3888
        'bzr branches. Incompatible with bzr < 0.15.',
2152
3889
    branch_format='bzrlib.branch.BzrBranchFormat6',
2153
 
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
3890
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2154
3891
    experimental=True,
2155
3892
    hidden=True,
2156
3893
    )
2157
 
register_metadir(controldir.format_registry, 'pack-0.92',
2158
 
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack1',
 
3894
format_registry.register_metadir('pack-0.92',
 
3895
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack1',
2159
3896
    help='New in 0.92: Pack-based format with data compatible with '
2160
3897
        'dirstate-tags format repositories. Interoperates with '
2161
3898
        'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
2162
3899
        ,
2163
3900
    branch_format='bzrlib.branch.BzrBranchFormat6',
2164
 
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
3901
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2165
3902
    )
2166
 
register_metadir(controldir.format_registry, 'pack-0.92-subtree',
2167
 
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack3',
 
3903
format_registry.register_metadir('pack-0.92-subtree',
 
3904
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack3',
2168
3905
    help='New in 0.92: Pack-based format with data compatible with '
2169
3906
        'dirstate-with-subtree format repositories. Interoperates with '
2170
3907
        'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
2171
3908
        ,
2172
3909
    branch_format='bzrlib.branch.BzrBranchFormat6',
2173
 
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
3910
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2174
3911
    hidden=True,
2175
3912
    experimental=True,
2176
3913
    )
2177
 
register_metadir(controldir.format_registry, 'rich-root-pack',
2178
 
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack4',
 
3914
format_registry.register_metadir('rich-root-pack',
 
3915
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
2179
3916
    help='New in 1.0: A variant of pack-0.92 that supports rich-root data '
2180
3917
         '(needed for bzr-svn and bzr-git).',
2181
3918
    branch_format='bzrlib.branch.BzrBranchFormat6',
2182
 
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
3919
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2183
3920
    hidden=True,
2184
3921
    )
2185
 
register_metadir(controldir.format_registry, '1.6',
2186
 
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack5',
 
3922
format_registry.register_metadir('1.6',
 
3923
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5',
2187
3924
    help='A format that allows a branch to indicate that there is another '
2188
3925
         '(stacked) repository that should be used to access data that is '
2189
3926
         'not present locally.',
2190
3927
    branch_format='bzrlib.branch.BzrBranchFormat7',
2191
 
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
3928
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2192
3929
    hidden=True,
2193
3930
    )
2194
 
register_metadir(controldir.format_registry, '1.6.1-rich-root',
2195
 
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack5RichRoot',
 
3931
format_registry.register_metadir('1.6.1-rich-root',
 
3932
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5RichRoot',
2196
3933
    help='A variant of 1.6 that supports rich-root data '
2197
3934
         '(needed for bzr-svn and bzr-git).',
2198
3935
    branch_format='bzrlib.branch.BzrBranchFormat7',
2199
 
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
3936
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2200
3937
    hidden=True,
2201
3938
    )
2202
 
register_metadir(controldir.format_registry, '1.9',
2203
 
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6',
 
3939
format_registry.register_metadir('1.9',
 
3940
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
2204
3941
    help='A repository format using B+tree indexes. These indexes '
2205
3942
         'are smaller in size, have smarter caching and provide faster '
2206
3943
         'performance for most operations.',
2207
3944
    branch_format='bzrlib.branch.BzrBranchFormat7',
2208
 
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
3945
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2209
3946
    hidden=True,
2210
3947
    )
2211
 
register_metadir(controldir.format_registry, '1.9-rich-root',
2212
 
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6RichRoot',
 
3948
format_registry.register_metadir('1.9-rich-root',
 
3949
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
2213
3950
    help='A variant of 1.9 that supports rich-root data '
2214
3951
         '(needed for bzr-svn and bzr-git).',
2215
3952
    branch_format='bzrlib.branch.BzrBranchFormat7',
2216
 
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
3953
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2217
3954
    hidden=True,
2218
3955
    )
2219
 
register_metadir(controldir.format_registry, '1.14',
2220
 
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6',
 
3956
format_registry.register_metadir('1.14',
 
3957
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
2221
3958
    help='A working-tree format that supports content filtering.',
2222
3959
    branch_format='bzrlib.branch.BzrBranchFormat7',
2223
 
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat5',
 
3960
    tree_format='bzrlib.workingtree.WorkingTreeFormat5',
2224
3961
    )
2225
 
register_metadir(controldir.format_registry, '1.14-rich-root',
2226
 
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6RichRoot',
 
3962
format_registry.register_metadir('1.14-rich-root',
 
3963
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
2227
3964
    help='A variant of 1.14 that supports rich-root data '
2228
3965
         '(needed for bzr-svn and bzr-git).',
2229
3966
    branch_format='bzrlib.branch.BzrBranchFormat7',
2230
 
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat5',
 
3967
    tree_format='bzrlib.workingtree.WorkingTreeFormat5',
2231
3968
    )
2232
3969
# The following un-numbered 'development' formats should always just be aliases.
2233
 
register_metadir(controldir.format_registry, 'development-subtree',
2234
 
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2aSubtree',
 
3970
format_registry.register_metadir('development-rich-root',
 
3971
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
 
3972
    help='Current development format. Supports rich roots. Can convert data '
 
3973
        'to and from rich-root-pack (and anything compatible with '
 
3974
        'rich-root-pack) format repositories. Repositories and branches in '
 
3975
        'this format can only be read by bzr.dev. Please read '
 
3976
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
 
3977
        'before use.',
 
3978
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
3979
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
 
3980
    experimental=True,
 
3981
    alias=True,
 
3982
    hidden=True,
 
3983
    )
 
3984
format_registry.register_metadir('development-subtree',
 
3985
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment2Subtree',
2235
3986
    help='Current development format, subtree variant. Can convert data to and '
2236
3987
        'from pack-0.92-subtree (and anything compatible with '
2237
3988
        'pack-0.92-subtree) format repositories. Repositories and branches in '
2239
3990
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
2240
3991
        'before use.',
2241
3992
    branch_format='bzrlib.branch.BzrBranchFormat7',
2242
 
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
 
3993
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
2243
3994
    experimental=True,
2244
3995
    hidden=True,
2245
3996
    alias=False, # Restore to being an alias when an actual development subtree format is added
2246
3997
                 # This current non-alias status is simply because we did not introduce a
2247
3998
                 # chk based subtree format.
2248
3999
    )
2249
 
register_metadir(controldir.format_registry, 'development5-subtree',
2250
 
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatPackDevelopment2Subtree',
2251
 
    help='Development format, subtree variant. Can convert data to and '
2252
 
        'from pack-0.92-subtree (and anything compatible with '
2253
 
        'pack-0.92-subtree) format repositories. Repositories and branches in '
2254
 
        'this format can only be read by bzr.dev. Please read '
2255
 
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
2256
 
        'before use.',
2257
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
2258
 
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
2259
 
    experimental=True,
2260
 
    hidden=True,
2261
 
    alias=False,
2262
 
    )
2263
4000
 
2264
4001
# And the development formats above will have aliased one of the following:
2265
 
 
2266
 
# Finally, the current format.
2267
 
register_metadir(controldir.format_registry, '2a',
 
4002
format_registry.register_metadir('development6-rich-root',
 
4003
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
 
4004
    help='pack-1.9 with 255-way hashed CHK inv, group compress, rich roots '
 
4005
        'Please read '
 
4006
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
 
4007
        'before use.',
 
4008
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
4009
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
 
4010
    hidden=True,
 
4011
    experimental=True,
 
4012
    )
 
4013
 
 
4014
format_registry.register_metadir('development7-rich-root',
 
4015
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK2',
 
4016
    help='pack-1.9 with 255-way hashed CHK inv, bencode revision, group compress, '
 
4017
        'rich roots. Please read '
 
4018
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
 
4019
        'before use.',
 
4020
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
4021
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
 
4022
    hidden=True,
 
4023
    experimental=True,
 
4024
    )
 
4025
 
 
4026
format_registry.register_metadir('2a',
2268
4027
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
2269
4028
    help='First format for bzr 2.0 series.\n'
2270
4029
        'Uses group-compress storage.\n'
2272
4031
        # 'storage in packs, 255-way hashed CHK inventory, bencode revision, group compress, '
2273
4032
        # 'rich roots. Supported by bzr 1.16 and later.',
2274
4033
    branch_format='bzrlib.branch.BzrBranchFormat7',
2275
 
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
2276
 
    experimental=False,
 
4034
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
 
4035
    experimental=True,
2277
4036
    )
2278
4037
 
2279
4038
# The following format should be an alias for the rich root equivalent 
2280
4039
# of the default format
2281
 
register_metadir(controldir.format_registry, 'default-rich-root',
 
4040
format_registry.register_metadir('default-rich-root',
2282
4041
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
2283
4042
    branch_format='bzrlib.branch.BzrBranchFormat7',
2284
 
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
 
4043
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
2285
4044
    alias=True,
2286
4045
    hidden=True,
2287
4046
    help='Same as 2a.')
2288
4047
 
2289
4048
# The current format that is made on 'bzr init'.
2290
 
format_name = config.GlobalConfig().get_user_option('default_format')
2291
 
if format_name is None:
2292
 
    controldir.format_registry.set_default('2a')
2293
 
else:
2294
 
    controldir.format_registry.set_default(format_name)
2295
 
 
2296
 
# XXX 2010-08-20 JRV: There is still a lot of code relying on
2297
 
# bzrlib.bzrdir.format_registry existing. When BzrDir.create/BzrDir.open/etc
2298
 
# get changed to ControlDir.create/ControlDir.open/etc this should be removed.
2299
 
format_registry = controldir.format_registry
 
4049
format_registry.set_default('2a')