← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/bzrdir.py

  • Committer: Vincent Ladeuil
  • Date: 2010-01-26 10:17:22 UTC
  • mfrom: (4985.1.5 add-attr-cleanup)
  • mto: This revision was merged to the branch mainline in revision 4988.
  • Revision ID: v.ladeuil+lp@free.fr-20100126101722-y213sv39buw3dgi2
Implement TestCase.overrideAttr to simplify tests setUp/cleanup

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) 2005-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
29
32
 
30
33
from bzrlib.lazy_import import lazy_import
31
34
lazy_import(globals(), """
 
35
from stat import S_ISDIR
 
36
import textwrap
 
37
 
32
38
import bzrlib
33
39
from bzrlib import (
34
 
    branch as _mod_branch,
35
 
    cleanup,
 
40
    branch,
 
41
    config,
36
42
    errors,
37
 
    fetch,
38
43
    graph,
39
44
    lockable_files,
40
45
    lockdir,
41
46
    osutils,
42
 
    pyutils,
43
47
    remote,
44
48
    repository,
45
49
    revision as _mod_revision,
46
 
    transport as _mod_transport,
47
50
    ui,
48
51
    urlutils,
 
52
    versionedfile,
49
53
    win32utils,
50
 
    workingtree_3,
 
54
    workingtree,
51
55
    workingtree_4,
52
 
    )
53
 
from bzrlib.repofmt import knitpack_repo
 
56
    xml4,
 
57
    xml5,
 
58
    )
 
59
from bzrlib.osutils import (
 
60
    sha_string,
 
61
    )
 
62
from bzrlib.push import (
 
63
    PushResult,
 
64
    )
 
65
from bzrlib.repofmt import pack_repo
 
66
from bzrlib.smart.client import _SmartClient
 
67
from bzrlib.store.versioned import WeaveStore
 
68
from bzrlib.transactions import WriteTransaction
54
69
from bzrlib.transport import (
55
70
    do_catching_redirections,
 
71
    get_transport,
56
72
    local,
57
73
    )
 
74
from bzrlib.weave import Weave
58
75
""")
59
76
 
60
77
from bzrlib.trace import (
61
78
    mutter,
62
79
    note,
 
80
    warning,
63
81
    )
64
82
 
65
83
from bzrlib import (
66
 
    config,
67
 
    controldir,
68
84
    hooks,
69
85
    registry,
70
 
    )
71
 
from bzrlib.symbol_versioning import (
72
 
    deprecated_in,
73
 
    deprecated_method,
74
 
    )
75
 
 
76
 
 
77
 
class BzrDir(controldir.ControlDir):
 
86
    symbol_versioning,
 
87
    )
 
88
 
 
89
 
 
90
class BzrDir(object):
78
91
    """A .bzr control diretory.
79
92
 
80
93
    BzrDir instances let you create or open any of the things that can be
111
124
                    return
112
125
        thing_to_unlock.break_lock()
113
126
 
 
127
    def can_convert_format(self):
 
128
        """Return true if this bzrdir is one whose format we can convert from."""
 
129
        return True
 
130
 
114
131
    def check_conversion_target(self, target_format):
115
132
        """Check that a bzrdir as a whole can be converted to a new format."""
116
133
        # The only current restriction is that the repository content can be 
123
140
            # No repo, no problem.
124
141
            pass
125
142
 
 
143
    @staticmethod
 
144
    def _check_supported(format, allow_unsupported,
 
145
        recommend_upgrade=True,
 
146
        basedir=None):
 
147
        """Give an error or warning on old formats.
 
148
 
 
149
        :param format: may be any kind of format - workingtree, branch,
 
150
        or repository.
 
151
 
 
152
        :param allow_unsupported: If true, allow opening
 
153
        formats that are strongly deprecated, and which may
 
154
        have limited functionality.
 
155
 
 
156
        :param recommend_upgrade: If true (default), warn
 
157
        the user through the ui object that they may wish
 
158
        to upgrade the object.
 
159
        """
 
160
        # TODO: perhaps move this into a base Format class; it's not BzrDir
 
161
        # specific. mbp 20070323
 
162
        if not allow_unsupported and not format.is_supported():
 
163
            # see open_downlevel to open legacy branches.
 
164
            raise errors.UnsupportedFormatError(format=format)
 
165
        if recommend_upgrade \
 
166
            and getattr(format, 'upgrade_recommended', False):
 
167
            ui.ui_factory.recommend_upgrade(
 
168
                format.get_format_description(),
 
169
                basedir)
 
170
 
 
171
    def clone(self, url, revision_id=None, force_new_repo=False,
 
172
              preserve_stacking=False):
 
173
        """Clone this bzrdir and its contents to url verbatim.
 
174
 
 
175
        :param url: The url create the clone at.  If url's last component does
 
176
            not exist, it will be created.
 
177
        :param revision_id: The tip revision-id to use for any branch or
 
178
            working tree.  If not None, then the clone operation may tune
 
179
            itself to download less data.
 
180
        :param force_new_repo: Do not use a shared repository for the target
 
181
                               even if one is available.
 
182
        :param preserve_stacking: When cloning a stacked branch, stack the
 
183
            new branch on top of the other branch's stacked-on branch.
 
184
        """
 
185
        return self.clone_on_transport(get_transport(url),
 
186
                                       revision_id=revision_id,
 
187
                                       force_new_repo=force_new_repo,
 
188
                                       preserve_stacking=preserve_stacking)
 
189
 
126
190
    def clone_on_transport(self, transport, revision_id=None,
127
191
        force_new_repo=False, preserve_stacking=False, stacked_on=None,
128
 
        create_prefix=False, use_existing_dir=True, no_tree=False):
 
192
        create_prefix=False, use_existing_dir=True):
129
193
        """Clone this bzrdir and its contents to transport verbatim.
130
194
 
131
195
        :param transport: The transport for the location to produce the clone
140
204
        :param create_prefix: Create any missing directories leading up to
141
205
            to_transport.
142
206
        :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
207
        """
145
208
        # Overview: put together a broad description of what we want to end up
146
209
        # with; then make as few api calls as possible to do it.
147
 
 
 
210
        
148
211
        # We may want to create a repo/branch/tree, if we do so what format
149
212
        # would we want for each:
150
213
        require_stacking = (stacked_on is not None)
151
214
        format = self.cloning_metadir(require_stacking)
152
 
 
 
215
        
153
216
        # Figure out what objects we want:
154
217
        try:
155
218
            local_repo = self.find_repository()
174
237
        # we should look up the policy needs first, or just use it as a hint,
175
238
        # or something.
176
239
        if local_repo:
177
 
            make_working_trees = local_repo.make_working_trees() and not no_tree
 
240
            make_working_trees = local_repo.make_working_trees()
178
241
            want_shared = local_repo.is_shared()
179
242
            repo_format_name = format.repository_format.network_name()
180
243
        else:
197
260
                # copied, and finally if we are copying up to a specific
198
261
                # revision_id then we can use the pending-ancestry-result which
199
262
                # does not require traversing all of history to describe it.
200
 
                if (result_repo.user_url == result.user_url
201
 
                    and not require_stacking and
 
263
                if (result_repo.bzrdir.root_transport.base ==
 
264
                    result.root_transport.base and not require_stacking and
202
265
                    revision_id is not None):
203
266
                    fetch_spec = graph.PendingAncestryResult(
204
267
                        [revision_id], local_repo)
229
292
    # TODO: This should be given a Transport, and should chdir up; otherwise
230
293
    # this will open a new connection.
231
294
    def _make_tail(self, url):
232
 
        t = _mod_transport.get_transport(url)
233
 
        t.ensure_base()
 
295
        t = get_transport(url)
 
296
        t.ensure_base()
 
297
 
 
298
    @classmethod
 
299
    def create(cls, base, format=None, possible_transports=None):
 
300
        """Create a new BzrDir at the url 'base'.
 
301
 
 
302
        :param format: If supplied, the format of branch to create.  If not
 
303
            supplied, the default is used.
 
304
        :param possible_transports: If supplied, a list of transports that
 
305
            can be reused to share a remote connection.
 
306
        """
 
307
        if cls is not BzrDir:
 
308
            raise AssertionError("BzrDir.create always creates the default"
 
309
                " format, not one of %r" % cls)
 
310
        t = get_transport(base, possible_transports)
 
311
        t.ensure_base()
 
312
        if format is None:
 
313
            format = BzrDirFormat.get_default_format()
 
314
        return format.initialize_on_transport(t)
234
315
 
235
316
    @staticmethod
236
317
    def find_bzrdirs(transport, evaluate=None, list_current=None):
239
320
        This is intended primarily as a building block for more sophisticated
240
321
        functionality, like finding trees under a directory, or finding
241
322
        branches that use a given repository.
242
 
 
243
323
        :param evaluate: An optional callable that yields recurse, value,
244
324
            where recurse controls whether this bzrdir is recursed into
245
325
            and value is the value to yield.  By default, all bzrdirs
261
341
            recurse = True
262
342
            try:
263
343
                bzrdir = BzrDir.open_from_transport(current_transport)
264
 
            except (errors.NotBranchError, errors.PermissionDenied):
 
344
            except errors.NotBranchError:
265
345
                pass
266
346
            else:
267
347
                recurse, value = evaluate(bzrdir)
268
348
                yield value
269
349
            try:
270
350
                subdirs = list_current(current_transport)
271
 
            except (errors.NoSuchFile, errors.PermissionDenied):
 
351
            except errors.NoSuchFile:
272
352
                continue
273
353
            if recurse:
274
354
                for subdir in sorted(subdirs, reverse=True):
291
371
            except errors.NoRepositoryPresent:
292
372
                pass
293
373
            else:
294
 
                return False, ([], repository)
295
 
            return True, (bzrdir.list_branches(), None)
296
 
        ret = []
297
 
        for branches, repo in BzrDir.find_bzrdirs(transport,
298
 
                                                  evaluate=evaluate):
 
374
                return False, (None, repository)
 
375
            try:
 
376
                branch = bzrdir.open_branch()
 
377
            except errors.NotBranchError:
 
378
                return True, (None, None)
 
379
            else:
 
380
                return True, (branch, None)
 
381
        branches = []
 
382
        for branch, repo in BzrDir.find_bzrdirs(transport, evaluate=evaluate):
299
383
            if repo is not None:
300
 
                ret.extend(repo.find_branches())
301
 
            if branches is not None:
302
 
                ret.extend(branches)
303
 
        return ret
 
384
                branches.extend(repo.find_branches())
 
385
            if branch is not None:
 
386
                branches.append(branch)
 
387
        return branches
 
388
 
 
389
    def destroy_repository(self):
 
390
        """Destroy the repository in this BzrDir"""
 
391
        raise NotImplementedError(self.destroy_repository)
 
392
 
 
393
    def create_branch(self):
 
394
        """Create a branch in this BzrDir.
 
395
 
 
396
        The bzrdir's format will control what branch format is created.
 
397
        For more control see BranchFormatXX.create(a_bzrdir).
 
398
        """
 
399
        raise NotImplementedError(self.create_branch)
 
400
 
 
401
    def destroy_branch(self):
 
402
        """Destroy the branch in this BzrDir"""
 
403
        raise NotImplementedError(self.destroy_branch)
304
404
 
305
405
    @staticmethod
306
406
    def create_branch_and_repo(base, force_new_repo=False, format=None):
345
445
            stop = False
346
446
            stack_on = config.get_default_stack_on()
347
447
            if stack_on is not None:
348
 
                stack_on_pwd = found_bzrdir.user_url
 
448
                stack_on_pwd = found_bzrdir.root_transport.base
349
449
                stop = True
350
450
            # does it have a repository ?
351
451
            try:
353
453
            except errors.NoRepositoryPresent:
354
454
                repository = None
355
455
            else:
356
 
                if (found_bzrdir.user_url != self.user_url 
357
 
                    and not repository.is_shared()):
 
456
                if ((found_bzrdir.root_transport.base !=
 
457
                     self.root_transport.base) and not repository.is_shared()):
358
458
                    # Don't look higher, can't use a higher shared repo.
359
459
                    repository = None
360
460
                    stop = True
389
489
        policy = self.determine_repository_policy(force_new_repo)
390
490
        return policy.acquire_repository()[0]
391
491
 
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
492
    @staticmethod
549
493
    def create_branch_convenience(base, force_new_repo=False,
550
494
                                  force_new_tree=None, format=None,
576
520
        """
577
521
        if force_new_tree:
578
522
            # check for non local urls
579
 
            t = _mod_transport.get_transport(base, possible_transports)
 
523
            t = get_transport(base, possible_transports)
580
524
            if not isinstance(t, local.LocalTransport):
581
525
                raise errors.NotLocalUrl(base)
582
526
        bzrdir = BzrDir.create(base, format, possible_transports)
604
548
        :param format: Override for the bzrdir format to create.
605
549
        :return: The WorkingTree object.
606
550
        """
607
 
        t = _mod_transport.get_transport(base)
 
551
        t = get_transport(base)
608
552
        if not isinstance(t, local.LocalTransport):
609
553
            raise errors.NotLocalUrl(base)
610
554
        bzrdir = BzrDir.create_branch_and_repo(base,
612
556
                                               format=format).bzrdir
613
557
        return bzrdir.create_workingtree()
614
558
 
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.
 
559
    def create_workingtree(self, revision_id=None, from_branch=None,
 
560
        accelerator_tree=None, hardlink=False):
 
561
        """Create a working tree at this BzrDir.
 
562
 
 
563
        :param revision_id: create it as of this revision id.
 
564
        :param from_branch: override bzrdir branch (for lightweight checkouts)
 
565
        :param accelerator_tree: A tree which can be used for retrieving file
 
566
            contents more quickly than the revision tree, i.e. a workingtree.
 
567
            The revision tree will be used for cases where accelerator_tree's
 
568
            content is different.
623
569
        """
624
 
        return osutils.available_backup_name(base, self.root_transport.has)
 
570
        raise NotImplementedError(self.create_workingtree)
625
571
 
626
572
    def backup_bzrdir(self):
627
573
        """Backup this bzr control directory.
628
574
 
629
575
        :return: Tuple with old path name and new path name
630
576
        """
631
 
 
632
577
        pb = ui.ui_factory.nested_progress_bar()
633
578
        try:
 
579
            # FIXME: bug 300001 -- the backup fails if the backup directory
 
580
            # already exists, but it should instead either remove it or make
 
581
            # a new backup directory.
 
582
            #
 
583
            # FIXME: bug 262450 -- the backup directory should have the same
 
584
            # permissions as the .bzr directory (probably a bug in copy_tree)
634
585
            old_path = self.root_transport.abspath('.bzr')
635
 
            backup_dir = self._available_backup_name('backup.bzr')
636
 
            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,))
639
 
            self.root_transport.copy_tree('.bzr', backup_dir)
 
586
            new_path = self.root_transport.abspath('backup.bzr')
 
587
            ui.ui_factory.note('making backup of %s\n  to %s' % (old_path, new_path,))
 
588
            self.root_transport.copy_tree('.bzr', 'backup.bzr')
640
589
            return (old_path, new_path)
641
590
        finally:
642
591
            pb.finished()
666
615
                else:
667
616
                    pass
668
617
 
 
618
    def destroy_workingtree(self):
 
619
        """Destroy the working tree at this BzrDir.
 
620
 
 
621
        Formats that do not support this may raise UnsupportedOperation.
 
622
        """
 
623
        raise NotImplementedError(self.destroy_workingtree)
 
624
 
 
625
    def destroy_workingtree_metadata(self):
 
626
        """Destroy the control files for the working tree at this BzrDir.
 
627
 
 
628
        The contents of working tree files are not affected.
 
629
        Formats that do not support this may raise UnsupportedOperation.
 
630
        """
 
631
        raise NotImplementedError(self.destroy_workingtree_metadata)
 
632
 
669
633
    def _find_containing(self, evaluate):
670
634
        """Find something in a containing control directory.
671
635
 
685
649
            if stop:
686
650
                return result
687
651
            next_transport = found_bzrdir.root_transport.clone('..')
688
 
            if (found_bzrdir.user_url == next_transport.base):
 
652
            if (found_bzrdir.root_transport.base == next_transport.base):
689
653
                # top of the file system
690
654
                return None
691
655
            # find the next containing bzrdir
708
672
                repository = found_bzrdir.open_repository()
709
673
            except errors.NoRepositoryPresent:
710
674
                return None, False
711
 
            if found_bzrdir.user_url == self.user_url:
 
675
            if found_bzrdir.root_transport.base == self.root_transport.base:
712
676
                return repository, True
713
677
            elif repository.is_shared():
714
678
                return repository, True
720
684
            raise errors.NoRepositoryPresent(self)
721
685
        return found_repo
722
686
 
 
687
    def get_branch_reference(self):
 
688
        """Return the referenced URL for the branch in this bzrdir.
 
689
 
 
690
        :raises NotBranchError: If there is no Branch.
 
691
        :return: The URL the branch in this bzrdir references if it is a
 
692
            reference branch, or None for regular branches.
 
693
        """
 
694
        return None
 
695
 
 
696
    def get_branch_transport(self, branch_format):
 
697
        """Get the transport for use by branch format in this BzrDir.
 
698
 
 
699
        Note that bzr dirs that do not support format strings will raise
 
700
        IncompatibleFormat if the branch format they are given has
 
701
        a format string, and vice versa.
 
702
 
 
703
        If branch_format is None, the transport is returned with no
 
704
        checking. If it is not None, then the returned transport is
 
705
        guaranteed to point to an existing directory ready for use.
 
706
        """
 
707
        raise NotImplementedError(self.get_branch_transport)
 
708
 
723
709
    def _find_creation_modes(self):
724
710
        """Determine the appropriate modes for files and directories.
725
711
 
764
750
            self._find_creation_modes()
765
751
        return self._dir_mode
766
752
 
 
753
    def get_repository_transport(self, repository_format):
 
754
        """Get the transport for use by repository format in this BzrDir.
 
755
 
 
756
        Note that bzr dirs that do not support format strings will raise
 
757
        IncompatibleFormat if the repository format they are given has
 
758
        a format string, and vice versa.
 
759
 
 
760
        If repository_format is None, the transport is returned with no
 
761
        checking. If it is not None, then the returned transport is
 
762
        guaranteed to point to an existing directory ready for use.
 
763
        """
 
764
        raise NotImplementedError(self.get_repository_transport)
 
765
 
 
766
    def get_workingtree_transport(self, tree_format):
 
767
        """Get the transport for use by workingtree format in this BzrDir.
 
768
 
 
769
        Note that bzr dirs that do not support format strings will raise
 
770
        IncompatibleFormat if the workingtree format they are given has a
 
771
        format string, and vice versa.
 
772
 
 
773
        If workingtree_format is None, the transport is returned with no
 
774
        checking. If it is not None, then the returned transport is
 
775
        guaranteed to point to an existing directory ready for use.
 
776
        """
 
777
        raise NotImplementedError(self.get_workingtree_transport)
 
778
 
767
779
    def get_config(self):
768
780
        """Get configuration for this BzrDir."""
769
781
        return config.BzrDirConfig(self)
782
794
        :param _transport: the transport this dir is based at.
783
795
        """
784
796
        self._format = _format
785
 
        # these are also under the more standard names of 
786
 
        # control_transport and user_transport
787
797
        self.transport = _transport.clone('.bzr')
788
798
        self.root_transport = _transport
789
799
        self._mode_check_done = False
790
800
 
791
 
    @property 
792
 
    def user_transport(self):
793
 
        return self.root_transport
794
 
 
795
 
    @property
796
 
    def control_transport(self):
797
 
        return self.transport
798
 
 
799
801
    def is_control_filename(self, filename):
800
802
        """True if filename is the name of a path which is reserved for bzrdir's.
801
803
 
803
805
 
804
806
        This is true IF and ONLY IF the filename is part of the namespace reserved
805
807
        for bzr control dirs. Currently this is the '.bzr' directory in the root
806
 
        of the root_transport. 
 
808
        of the root_transport. it is expected that plugins will need to extend
 
809
        this in the future - for instance to make bzr talk with svn working
 
810
        trees.
807
811
        """
808
812
        # this might be better on the BzrDirFormat class because it refers to
809
813
        # all the possible bzrdir disk formats.
813
817
        # add new tests for it to the appropriate place.
814
818
        return filename == '.bzr' or filename.startswith('.bzr/')
815
819
 
 
820
    def needs_format_conversion(self, format=None):
 
821
        """Return true if this bzrdir needs convert_format run on it.
 
822
 
 
823
        For instance, if the repository format is out of date but the
 
824
        branch and working tree are not, this should return True.
 
825
 
 
826
        :param format: Optional parameter indicating a specific desired
 
827
                       format we plan to arrive at.
 
828
        """
 
829
        raise NotImplementedError(self.needs_format_conversion)
 
830
 
816
831
    @staticmethod
817
832
    def open_unsupported(base):
818
833
        """Open a branch which is not supported."""
824
839
 
825
840
        :param _unsupported: a private parameter to the BzrDir class.
826
841
        """
827
 
        t = _mod_transport.get_transport(base, possible_transports)
 
842
        t = get_transport(base, possible_transports=possible_transports)
828
843
        return BzrDir.open_from_transport(t, _unsupported=_unsupported)
829
844
 
830
845
    @staticmethod
841
856
        # the redirections.
842
857
        base = transport.base
843
858
        def find_format(transport):
844
 
            return transport, controldir.ControlDirFormat.find_format(
 
859
            return transport, BzrDirFormat.find_format(
845
860
                transport, _server_formats=_server_formats)
846
861
 
847
862
        def redirected(transport, e, redirection_notice):
859
874
        except errors.TooManyRedirections:
860
875
            raise errors.NotBranchError(base)
861
876
 
862
 
        format.check_support_status(_unsupported)
 
877
        BzrDir._check_supported(format, _unsupported)
863
878
        return format.open(transport, _found=True)
864
879
 
 
880
    def open_branch(self, unsupported=False, ignore_fallbacks=False):
 
881
        """Open the branch object at this BzrDir if one is present.
 
882
 
 
883
        If unsupported is True, then no longer supported branch formats can
 
884
        still be opened.
 
885
 
 
886
        TODO: static convenience version of this?
 
887
        """
 
888
        raise NotImplementedError(self.open_branch)
 
889
 
865
890
    @staticmethod
866
891
    def open_containing(url, possible_transports=None):
867
892
        """Open an existing branch which contains url.
868
893
 
869
894
        :param url: url to search from.
870
 
 
871
895
        See open_containing_from_transport for more detail.
872
896
        """
873
 
        transport = _mod_transport.get_transport(url, possible_transports)
 
897
        transport = get_transport(url, possible_transports)
874
898
        return BzrDir.open_containing_from_transport(transport)
875
899
 
876
900
    @staticmethod
906
930
                raise errors.NotBranchError(path=url)
907
931
            a_transport = new_t
908
932
 
 
933
    def _get_tree_branch(self):
 
934
        """Return the branch and tree, if any, for this bzrdir.
 
935
 
 
936
        Return None for tree if not present or inaccessible.
 
937
        Raise NotBranchError if no branch is present.
 
938
        :return: (tree, branch)
 
939
        """
 
940
        try:
 
941
            tree = self.open_workingtree()
 
942
        except (errors.NoWorkingTree, errors.NotLocalUrl):
 
943
            tree = None
 
944
            branch = self.open_branch()
 
945
        else:
 
946
            branch = tree.branch
 
947
        return tree, branch
 
948
 
909
949
    @classmethod
910
950
    def open_tree_or_branch(klass, location):
911
951
        """Return the branch and working tree at a location.
957
997
                raise errors.NotBranchError(location)
958
998
        return tree, branch, branch.repository, relpath
959
999
 
 
1000
    def open_repository(self, _unsupported=False):
 
1001
        """Open the repository object at this BzrDir if one is present.
 
1002
 
 
1003
        This will not follow the Branch object pointer - it's strictly a direct
 
1004
        open facility. Most client code should use open_branch().repository to
 
1005
        get at a repository.
 
1006
 
 
1007
        :param _unsupported: a private parameter, not part of the api.
 
1008
        TODO: static convenience version of this?
 
1009
        """
 
1010
        raise NotImplementedError(self.open_repository)
 
1011
 
 
1012
    def open_workingtree(self, _unsupported=False,
 
1013
                         recommend_upgrade=True, from_branch=None):
 
1014
        """Open the workingtree object at this BzrDir if one is present.
 
1015
 
 
1016
        :param recommend_upgrade: Optional keyword parameter, when True (the
 
1017
            default), emit through the ui module a recommendation that the user
 
1018
            upgrade the working tree when the workingtree being opened is old
 
1019
            (but still fully supported).
 
1020
        :param from_branch: override bzrdir branch (for lightweight checkouts)
 
1021
        """
 
1022
        raise NotImplementedError(self.open_workingtree)
 
1023
 
 
1024
    def has_branch(self):
 
1025
        """Tell if this bzrdir contains a branch.
 
1026
 
 
1027
        Note: if you're going to open the branch, you should just go ahead
 
1028
        and try, and not ask permission first.  (This method just opens the
 
1029
        branch and discards it, and that's somewhat expensive.)
 
1030
        """
 
1031
        try:
 
1032
            self.open_branch()
 
1033
            return True
 
1034
        except errors.NotBranchError:
 
1035
            return False
 
1036
 
 
1037
    def has_workingtree(self):
 
1038
        """Tell if this bzrdir contains a working tree.
 
1039
 
 
1040
        This will still raise an exception if the bzrdir has a workingtree that
 
1041
        is remote & inaccessible.
 
1042
 
 
1043
        Note: if you're going to open the working tree, you should just go ahead
 
1044
        and try, and not ask permission first.  (This method just opens the
 
1045
        workingtree and discards it, and that's somewhat expensive.)
 
1046
        """
 
1047
        try:
 
1048
            self.open_workingtree(recommend_upgrade=False)
 
1049
            return True
 
1050
        except errors.NoWorkingTree:
 
1051
            return False
 
1052
 
960
1053
    def _cloning_metadir(self):
961
1054
        """Produce a metadir suitable for cloning with.
962
1055
 
1020
1113
            format.require_stacking()
1021
1114
        return format
1022
1115
 
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)
 
1116
    def checkout_metadir(self):
 
1117
        return self.cloning_metadir()
 
1118
 
 
1119
    def sprout(self, url, revision_id=None, force_new_repo=False,
 
1120
               recurse='down', possible_transports=None,
 
1121
               accelerator_tree=None, hardlink=False, stacked=False,
 
1122
               source_branch=None, create_tree_if_local=True):
 
1123
        """Create a copy of this bzrdir prepared for use as a new line of
 
1124
        development.
 
1125
 
 
1126
        If url's last component does not exist, it will be created.
 
1127
 
 
1128
        Attributes related to the identity of the source branch like
 
1129
        branch nickname will be cleaned, a working tree is created
 
1130
        whether one existed before or not; and a local branch is always
 
1131
        created.
 
1132
 
 
1133
        if revision_id is not None, then the clone operation may tune
 
1134
            itself to download less data.
 
1135
        :param accelerator_tree: A tree which can be used for retrieving file
 
1136
            contents more quickly than the revision tree, i.e. a workingtree.
 
1137
            The revision tree will be used for cases where accelerator_tree's
 
1138
            content is different.
 
1139
        :param hardlink: If true, hard-link files from accelerator_tree,
 
1140
            where possible.
 
1141
        :param stacked: If true, create a stacked branch referring to the
 
1142
            location of this control directory.
 
1143
        :param create_tree_if_local: If true, a working-tree will be created
 
1144
            when working locally.
 
1145
        """
 
1146
        target_transport = get_transport(url, possible_transports)
 
1147
        target_transport.ensure_base()
 
1148
        cloning_format = self.cloning_metadir(stacked)
 
1149
        # Create/update the result branch
 
1150
        result = cloning_format.initialize_on_transport(target_transport)
 
1151
        # if a stacked branch wasn't requested, we don't create one
 
1152
        # even if the origin was stacked
 
1153
        stacked_branch_url = None
 
1154
        if source_branch is not None:
 
1155
            if stacked:
 
1156
                stacked_branch_url = self.root_transport.base
 
1157
            source_repository = source_branch.repository
 
1158
        else:
 
1159
            try:
 
1160
                source_branch = self.open_branch()
 
1161
                source_repository = source_branch.repository
 
1162
                if stacked:
 
1163
                    stacked_branch_url = self.root_transport.base
 
1164
            except errors.NotBranchError:
 
1165
                source_branch = None
 
1166
                try:
 
1167
                    source_repository = self.open_repository()
 
1168
                except errors.NoRepositoryPresent:
 
1169
                    source_repository = None
 
1170
        repository_policy = result.determine_repository_policy(
 
1171
            force_new_repo, stacked_branch_url, require_stacking=stacked)
 
1172
        result_repo, is_new_repo = repository_policy.acquire_repository()
 
1173
        if is_new_repo and revision_id is not None and not stacked:
 
1174
            fetch_spec = graph.PendingAncestryResult(
 
1175
                [revision_id], source_repository)
 
1176
        else:
 
1177
            fetch_spec = None
 
1178
        if source_repository is not None:
 
1179
            # Fetch while stacked to prevent unstacked fetch from
 
1180
            # Branch.sprout.
 
1181
            if fetch_spec is None:
 
1182
                result_repo.fetch(source_repository, revision_id=revision_id)
 
1183
            else:
 
1184
                result_repo.fetch(source_repository, fetch_spec=fetch_spec)
 
1185
 
 
1186
        if source_branch is None:
 
1187
            # this is for sprouting a bzrdir without a branch; is that
 
1188
            # actually useful?
 
1189
            # Not especially, but it's part of the contract.
 
1190
            result_branch = result.create_branch()
 
1191
        else:
 
1192
            result_branch = source_branch.sprout(result,
 
1193
                revision_id=revision_id, repository_policy=repository_policy)
 
1194
        mutter("created new branch %r" % (result_branch,))
 
1195
 
 
1196
        # Create/update the result working tree
 
1197
        if (create_tree_if_local and
 
1198
            isinstance(target_transport, local.LocalTransport) and
 
1199
            (result_repo is None or result_repo.make_working_trees())):
 
1200
            wt = result.create_workingtree(accelerator_tree=accelerator_tree,
 
1201
                hardlink=hardlink)
 
1202
            wt.lock_write()
 
1203
            try:
 
1204
                if wt.path2id('') is None:
 
1205
                    try:
 
1206
                        wt.set_root_id(self.open_workingtree.get_root_id())
 
1207
                    except errors.NoWorkingTree:
 
1208
                        pass
 
1209
            finally:
 
1210
                wt.unlock()
 
1211
        else:
 
1212
            wt = None
 
1213
        if recurse == 'down':
 
1214
            if wt is not None:
 
1215
                basis = wt.basis_tree()
 
1216
                basis.lock_read()
 
1217
                subtrees = basis.iter_references()
 
1218
            elif result_branch is not None:
 
1219
                basis = result_branch.basis_tree()
 
1220
                basis.lock_read()
 
1221
                subtrees = basis.iter_references()
 
1222
            elif source_branch is not None:
 
1223
                basis = source_branch.basis_tree()
 
1224
                basis.lock_read()
 
1225
                subtrees = basis.iter_references()
 
1226
            else:
 
1227
                subtrees = []
 
1228
                basis = None
 
1229
            try:
 
1230
                for path, file_id in subtrees:
 
1231
                    target = urlutils.join(url, urlutils.escape(path))
 
1232
                    sublocation = source_branch.reference_parent(file_id, path)
 
1233
                    sublocation.bzrdir.sprout(target,
 
1234
                        basis.get_reference_revision(file_id, path),
 
1235
                        force_new_repo=force_new_repo, recurse=recurse,
 
1236
                        stacked=stacked)
 
1237
            finally:
 
1238
                if basis is not None:
 
1239
                    basis.unlock()
 
1240
        return result
 
1241
 
 
1242
    def push_branch(self, source, revision_id=None, overwrite=False, 
 
1243
        remember=False, create_prefix=False):
 
1244
        """Push the source branch into this BzrDir."""
 
1245
        br_to = None
 
1246
        # If we can open a branch, use its direct repository, otherwise see
 
1247
        # if there is a repository without a branch.
 
1248
        try:
 
1249
            br_to = self.open_branch()
 
1250
        except errors.NotBranchError:
 
1251
            # Didn't find a branch, can we find a repository?
 
1252
            repository_to = self.find_repository()
 
1253
        else:
 
1254
            # Found a branch, so we must have found a repository
 
1255
            repository_to = br_to.repository
 
1256
 
 
1257
        push_result = PushResult()
 
1258
        push_result.source_branch = source
 
1259
        if br_to is None:
 
1260
            # We have a repository but no branch, copy the revisions, and then
 
1261
            # create a branch.
 
1262
            repository_to.fetch(source.repository, revision_id=revision_id)
 
1263
            br_to = source.clone(self, revision_id=revision_id)
 
1264
            if source.get_push_location() is None or remember:
 
1265
                source.set_push_location(br_to.base)
 
1266
            push_result.stacked_on = None
 
1267
            push_result.branch_push_result = None
 
1268
            push_result.old_revno = None
 
1269
            push_result.old_revid = _mod_revision.NULL_REVISION
 
1270
            push_result.target_branch = br_to
 
1271
            push_result.master_branch = None
 
1272
            push_result.workingtree_updated = False
 
1273
        else:
 
1274
            # We have successfully opened the branch, remember if necessary:
 
1275
            if source.get_push_location() is None or remember:
 
1276
                source.set_push_location(br_to.base)
 
1277
            try:
 
1278
                tree_to = self.open_workingtree()
 
1279
            except errors.NotLocalUrl:
 
1280
                push_result.branch_push_result = source.push(br_to, 
 
1281
                    overwrite, stop_revision=revision_id)
 
1282
                push_result.workingtree_updated = False
 
1283
            except errors.NoWorkingTree:
 
1284
                push_result.branch_push_result = source.push(br_to,
 
1285
                    overwrite, stop_revision=revision_id)
 
1286
                push_result.workingtree_updated = None # Not applicable
 
1287
            else:
 
1288
                tree_to.lock_write()
 
1289
                try:
 
1290
                    push_result.branch_push_result = source.push(
 
1291
                        tree_to.branch, overwrite, stop_revision=revision_id)
 
1292
                    tree_to.update()
 
1293
                finally:
 
1294
                    tree_to.unlock()
 
1295
                push_result.workingtree_updated = True
 
1296
            push_result.old_revno = push_result.branch_push_result.old_revno
 
1297
            push_result.old_revid = push_result.branch_push_result.old_revid
 
1298
            push_result.target_branch = \
 
1299
                push_result.branch_push_result.target_branch
 
1300
        return push_result
1079
1301
 
1080
1302
 
1081
1303
class BzrDirHooks(hooks.Hooks):
1083
1305
 
1084
1306
    def __init__(self):
1085
1307
        """Create the default hooks."""
1086
 
        hooks.Hooks.__init__(self, "bzrlib.bzrdir", "BzrDir.hooks")
1087
 
        self.add_hook('pre_open',
 
1308
        hooks.Hooks.__init__(self)
 
1309
        self.create_hook(hooks.HookPoint('pre_open',
1088
1310
            "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',
1091
 
            "Invoked after a repository has been initialized. "
1092
 
            "post_repo_init is called with a "
1093
 
            "bzrlib.bzrdir.RepoInitHookParams.",
1094
 
            (2, 2))
 
1311
            "that the open will use.", (1, 14), None))
1095
1312
 
1096
1313
# install the default hooks
1097
1314
BzrDir.hooks = BzrDirHooks()
1098
1315
 
1099
1316
 
1100
 
class RepoInitHookParams(object):
1101
 
    """Object holding parameters passed to `*_repo_init` hooks.
1102
 
 
1103
 
    There are 4 fields that hooks may wish to access:
1104
 
 
1105
 
    :ivar repository: Repository created
1106
 
    :ivar format: Repository format
1107
 
    :ivar bzrdir: The bzrdir for the repository
1108
 
    :ivar shared: The repository is shared
1109
 
    """
1110
 
 
1111
 
    def __init__(self, repository, format, a_bzrdir, shared):
1112
 
        """Create a group of RepoInitHook parameters.
1113
 
 
1114
 
        :param repository: Repository created
1115
 
        :param format: Repository format
1116
 
        :param bzrdir: The bzrdir for the repository
1117
 
        :param shared: The repository is shared
 
1317
class BzrDirPreSplitOut(BzrDir):
 
1318
    """A common class for the all-in-one formats."""
 
1319
 
 
1320
    def __init__(self, _transport, _format):
 
1321
        """See BzrDir.__init__."""
 
1322
        super(BzrDirPreSplitOut, self).__init__(_transport, _format)
 
1323
        self._control_files = lockable_files.LockableFiles(
 
1324
                                            self.get_branch_transport(None),
 
1325
                                            self._format._lock_file_name,
 
1326
                                            self._format._lock_class)
 
1327
 
 
1328
    def break_lock(self):
 
1329
        """Pre-splitout bzrdirs do not suffer from stale locks."""
 
1330
        raise NotImplementedError(self.break_lock)
 
1331
 
 
1332
    def cloning_metadir(self, require_stacking=False):
 
1333
        """Produce a metadir suitable for cloning with."""
 
1334
        if require_stacking:
 
1335
            return format_registry.make_bzrdir('1.6')
 
1336
        return self._format.__class__()
 
1337
 
 
1338
    def clone(self, url, revision_id=None, force_new_repo=False,
 
1339
              preserve_stacking=False):
 
1340
        """See BzrDir.clone().
 
1341
 
 
1342
        force_new_repo has no effect, since this family of formats always
 
1343
        require a new repository.
 
1344
        preserve_stacking has no effect, since no source branch using this
 
1345
        family of formats can be stacked, so there is no stacking to preserve.
1118
1346
        """
1119
 
        self.repository = repository
1120
 
        self.format = format
1121
 
        self.bzrdir = a_bzrdir
1122
 
        self.shared = shared
1123
 
 
1124
 
    def __eq__(self, other):
1125
 
        return self.__dict__ == other.__dict__
1126
 
 
1127
 
    def __repr__(self):
1128
 
        if self.repository:
1129
 
            return "<%s for %s>" % (self.__class__.__name__,
1130
 
                self.repository)
 
1347
        self._make_tail(url)
 
1348
        result = self._format._initialize_for_clone(url)
 
1349
        self.open_repository().clone(result, revision_id=revision_id)
 
1350
        from_branch = self.open_branch()
 
1351
        from_branch.clone(result, revision_id=revision_id)
 
1352
        try:
 
1353
            tree = self.open_workingtree()
 
1354
        except errors.NotLocalUrl:
 
1355
            # make a new one, this format always has to have one.
 
1356
            result._init_workingtree()
1131
1357
        else:
1132
 
            return "<%s for %s>" % (self.__class__.__name__,
1133
 
                self.bzrdir)
 
1358
            tree.clone(result)
 
1359
        return result
 
1360
 
 
1361
    def create_branch(self):
 
1362
        """See BzrDir.create_branch."""
 
1363
        return self._format.get_branch_format().initialize(self)
 
1364
 
 
1365
    def destroy_branch(self):
 
1366
        """See BzrDir.destroy_branch."""
 
1367
        raise errors.UnsupportedOperation(self.destroy_branch, self)
 
1368
 
 
1369
    def create_repository(self, shared=False):
 
1370
        """See BzrDir.create_repository."""
 
1371
        if shared:
 
1372
            raise errors.IncompatibleFormat('shared repository', self._format)
 
1373
        return self.open_repository()
 
1374
 
 
1375
    def destroy_repository(self):
 
1376
        """See BzrDir.destroy_repository."""
 
1377
        raise errors.UnsupportedOperation(self.destroy_repository, self)
 
1378
 
 
1379
    def create_workingtree(self, revision_id=None, from_branch=None,
 
1380
                           accelerator_tree=None, hardlink=False):
 
1381
        """See BzrDir.create_workingtree."""
 
1382
        # The workingtree is sometimes created when the bzrdir is created,
 
1383
        # but not when cloning.
 
1384
 
 
1385
        # this looks buggy but is not -really-
 
1386
        # because this format creates the workingtree when the bzrdir is
 
1387
        # created
 
1388
        # clone and sprout will have set the revision_id
 
1389
        # and that will have set it for us, its only
 
1390
        # specific uses of create_workingtree in isolation
 
1391
        # that can do wonky stuff here, and that only
 
1392
        # happens for creating checkouts, which cannot be
 
1393
        # done on this format anyway. So - acceptable wart.
 
1394
        if hardlink:
 
1395
            warning("can't support hardlinked working trees in %r"
 
1396
                % (self,))
 
1397
        try:
 
1398
            result = self.open_workingtree(recommend_upgrade=False)
 
1399
        except errors.NoSuchFile:
 
1400
            result = self._init_workingtree()
 
1401
        if revision_id is not None:
 
1402
            if revision_id == _mod_revision.NULL_REVISION:
 
1403
                result.set_parent_ids([])
 
1404
            else:
 
1405
                result.set_parent_ids([revision_id])
 
1406
        return result
 
1407
 
 
1408
    def _init_workingtree(self):
 
1409
        from bzrlib.workingtree import WorkingTreeFormat2
 
1410
        try:
 
1411
            return WorkingTreeFormat2().initialize(self)
 
1412
        except errors.NotLocalUrl:
 
1413
            # Even though we can't access the working tree, we need to
 
1414
            # create its control files.
 
1415
            return WorkingTreeFormat2()._stub_initialize_on_transport(
 
1416
                self.transport, self._control_files._file_mode)
 
1417
 
 
1418
    def destroy_workingtree(self):
 
1419
        """See BzrDir.destroy_workingtree."""
 
1420
        raise errors.UnsupportedOperation(self.destroy_workingtree, self)
 
1421
 
 
1422
    def destroy_workingtree_metadata(self):
 
1423
        """See BzrDir.destroy_workingtree_metadata."""
 
1424
        raise errors.UnsupportedOperation(self.destroy_workingtree_metadata,
 
1425
                                          self)
 
1426
 
 
1427
    def get_branch_transport(self, branch_format):
 
1428
        """See BzrDir.get_branch_transport()."""
 
1429
        if branch_format is None:
 
1430
            return self.transport
 
1431
        try:
 
1432
            branch_format.get_format_string()
 
1433
        except NotImplementedError:
 
1434
            return self.transport
 
1435
        raise errors.IncompatibleFormat(branch_format, self._format)
 
1436
 
 
1437
    def get_repository_transport(self, repository_format):
 
1438
        """See BzrDir.get_repository_transport()."""
 
1439
        if repository_format is None:
 
1440
            return self.transport
 
1441
        try:
 
1442
            repository_format.get_format_string()
 
1443
        except NotImplementedError:
 
1444
            return self.transport
 
1445
        raise errors.IncompatibleFormat(repository_format, self._format)
 
1446
 
 
1447
    def get_workingtree_transport(self, workingtree_format):
 
1448
        """See BzrDir.get_workingtree_transport()."""
 
1449
        if workingtree_format is None:
 
1450
            return self.transport
 
1451
        try:
 
1452
            workingtree_format.get_format_string()
 
1453
        except NotImplementedError:
 
1454
            return self.transport
 
1455
        raise errors.IncompatibleFormat(workingtree_format, self._format)
 
1456
 
 
1457
    def needs_format_conversion(self, format=None):
 
1458
        """See BzrDir.needs_format_conversion()."""
 
1459
        # if the format is not the same as the system default,
 
1460
        # an upgrade is needed.
 
1461
        if format is None:
 
1462
            symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
 
1463
                % 'needs_format_conversion(format=None)')
 
1464
            format = BzrDirFormat.get_default_format()
 
1465
        return not isinstance(self._format, format.__class__)
 
1466
 
 
1467
    def open_branch(self, unsupported=False, ignore_fallbacks=False):
 
1468
        """See BzrDir.open_branch."""
 
1469
        from bzrlib.branch import BzrBranchFormat4
 
1470
        format = BzrBranchFormat4()
 
1471
        self._check_supported(format, unsupported)
 
1472
        return format.open(self, _found=True)
 
1473
 
 
1474
    def sprout(self, url, revision_id=None, force_new_repo=False,
 
1475
               possible_transports=None, accelerator_tree=None,
 
1476
               hardlink=False, stacked=False, create_tree_if_local=True,
 
1477
               source_branch=None):
 
1478
        """See BzrDir.sprout()."""
 
1479
        if source_branch is not None:
 
1480
            my_branch = self.open_branch()
 
1481
            if source_branch.base != my_branch.base:
 
1482
                raise AssertionError(
 
1483
                    "source branch %r is not within %r with branch %r" %
 
1484
                    (source_branch, self, my_branch))
 
1485
        if stacked:
 
1486
            raise errors.UnstackableBranchFormat(
 
1487
                self._format, self.root_transport.base)
 
1488
        if not create_tree_if_local:
 
1489
            raise errors.MustHaveWorkingTree(
 
1490
                self._format, self.root_transport.base)
 
1491
        from bzrlib.workingtree import WorkingTreeFormat2
 
1492
        self._make_tail(url)
 
1493
        result = self._format._initialize_for_clone(url)
 
1494
        try:
 
1495
            self.open_repository().clone(result, revision_id=revision_id)
 
1496
        except errors.NoRepositoryPresent:
 
1497
            pass
 
1498
        try:
 
1499
            self.open_branch().sprout(result, revision_id=revision_id)
 
1500
        except errors.NotBranchError:
 
1501
            pass
 
1502
 
 
1503
        # we always want a working tree
 
1504
        WorkingTreeFormat2().initialize(result,
 
1505
                                        accelerator_tree=accelerator_tree,
 
1506
                                        hardlink=hardlink)
 
1507
        return result
 
1508
 
 
1509
 
 
1510
class BzrDir4(BzrDirPreSplitOut):
 
1511
    """A .bzr version 4 control object.
 
1512
 
 
1513
    This is a deprecated format and may be removed after sept 2006.
 
1514
    """
 
1515
 
 
1516
    def create_repository(self, shared=False):
 
1517
        """See BzrDir.create_repository."""
 
1518
        return self._format.repository_format.initialize(self, shared)
 
1519
 
 
1520
    def needs_format_conversion(self, format=None):
 
1521
        """Format 4 dirs are always in need of conversion."""
 
1522
        if format is None:
 
1523
            symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
 
1524
                % 'needs_format_conversion(format=None)')
 
1525
        return True
 
1526
 
 
1527
    def open_repository(self):
 
1528
        """See BzrDir.open_repository."""
 
1529
        from bzrlib.repofmt.weaverepo import RepositoryFormat4
 
1530
        return RepositoryFormat4().open(self, _found=True)
 
1531
 
 
1532
 
 
1533
class BzrDir5(BzrDirPreSplitOut):
 
1534
    """A .bzr version 5 control object.
 
1535
 
 
1536
    This is a deprecated format and may be removed after sept 2006.
 
1537
    """
 
1538
 
 
1539
    def has_workingtree(self):
 
1540
        """See BzrDir.has_workingtree."""
 
1541
        return True
 
1542
    
 
1543
    def open_repository(self):
 
1544
        """See BzrDir.open_repository."""
 
1545
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
 
1546
        return RepositoryFormat5().open(self, _found=True)
 
1547
 
 
1548
    def open_workingtree(self, _unsupported=False,
 
1549
            recommend_upgrade=True):
 
1550
        """See BzrDir.create_workingtree."""
 
1551
        from bzrlib.workingtree import WorkingTreeFormat2
 
1552
        wt_format = WorkingTreeFormat2()
 
1553
        # we don't warn here about upgrades; that ought to be handled for the
 
1554
        # bzrdir as a whole
 
1555
        return wt_format.open(self, _found=True)
 
1556
 
 
1557
 
 
1558
class BzrDir6(BzrDirPreSplitOut):
 
1559
    """A .bzr version 6 control object.
 
1560
 
 
1561
    This is a deprecated format and may be removed after sept 2006.
 
1562
    """
 
1563
 
 
1564
    def has_workingtree(self):
 
1565
        """See BzrDir.has_workingtree."""
 
1566
        return True
 
1567
    
 
1568
    def open_repository(self):
 
1569
        """See BzrDir.open_repository."""
 
1570
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
 
1571
        return RepositoryFormat6().open(self, _found=True)
 
1572
 
 
1573
    def open_workingtree(self, _unsupported=False,
 
1574
        recommend_upgrade=True):
 
1575
        """See BzrDir.create_workingtree."""
 
1576
        # we don't warn here about upgrades; that ought to be handled for the
 
1577
        # bzrdir as a whole
 
1578
        from bzrlib.workingtree import WorkingTreeFormat2
 
1579
        return WorkingTreeFormat2().open(self, _found=True)
1134
1580
 
1135
1581
 
1136
1582
class BzrDirMeta1(BzrDir):
1146
1592
        """See BzrDir.can_convert_format()."""
1147
1593
        return True
1148
1594
 
1149
 
    def create_branch(self, name=None, repository=None):
 
1595
    def create_branch(self):
1150
1596
        """See BzrDir.create_branch."""
1151
 
        return self._format.get_branch_format().initialize(self, name=name,
1152
 
                repository=repository)
 
1597
        return self._format.get_branch_format().initialize(self)
1153
1598
 
1154
 
    def destroy_branch(self, name=None):
 
1599
    def destroy_branch(self):
1155
1600
        """See BzrDir.create_branch."""
1156
 
        if name is not None:
1157
 
            raise errors.NoColocatedBranchSupport(self)
1158
1601
        self.transport.delete_tree('branch')
1159
1602
 
1160
1603
    def create_repository(self, shared=False):
1177
1620
        wt = self.open_workingtree(recommend_upgrade=False)
1178
1621
        repository = wt.branch.repository
1179
1622
        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)
 
1623
        wt.revert(old_tree=empty)
1184
1624
        self.destroy_workingtree_metadata()
1185
1625
 
1186
1626
    def destroy_workingtree_metadata(self):
1187
1627
        self.transport.delete_tree('checkout')
1188
1628
 
1189
 
    def find_branch_format(self, name=None):
 
1629
    def find_branch_format(self):
1190
1630
        """Find the branch 'format' for this bzrdir.
1191
1631
 
1192
1632
        This might be a synthetic object for e.g. RemoteBranch and SVN.
1193
1633
        """
1194
1634
        from bzrlib.branch import BranchFormat
1195
 
        return BranchFormat.find_format(self, name=name)
 
1635
        return BranchFormat.find_format(self)
1196
1636
 
1197
1637
    def _get_mkdir_mode(self):
1198
1638
        """Figure out the mode to use when creating a bzrdir subdir."""
1200
1640
                                     lockable_files.TransportLock)
1201
1641
        return temp_control._dir_mode
1202
1642
 
1203
 
    def get_branch_reference(self, name=None):
 
1643
    def get_branch_reference(self):
1204
1644
        """See BzrDir.get_branch_reference()."""
1205
1645
        from bzrlib.branch import BranchFormat
1206
 
        format = BranchFormat.find_format(self, name=name)
1207
 
        return format.get_reference(self, name=name)
 
1646
        format = BranchFormat.find_format(self)
 
1647
        return format.get_reference(self)
1208
1648
 
1209
 
    def get_branch_transport(self, branch_format, name=None):
 
1649
    def get_branch_transport(self, branch_format):
1210
1650
        """See BzrDir.get_branch_transport()."""
1211
 
        if name is not None:
1212
 
            raise errors.NoColocatedBranchSupport(self)
1213
1651
        # XXX: this shouldn't implicitly create the directory if it's just
1214
1652
        # promising to get a transport -- mbp 20090727
1215
1653
        if branch_format is None:
1255
1693
    def has_workingtree(self):
1256
1694
        """Tell if this bzrdir contains a working tree.
1257
1695
 
 
1696
        This will still raise an exception if the bzrdir has a workingtree that
 
1697
        is remote & inaccessible.
 
1698
 
1258
1699
        Note: if you're going to open the working tree, you should just go
1259
1700
        ahead and try, and not ask permission first.
1260
1701
        """
1261
1702
        from bzrlib.workingtree import WorkingTreeFormat
1262
1703
        try:
1263
 
            WorkingTreeFormat.find_format_string(self)
 
1704
            WorkingTreeFormat.find_format(self)
1264
1705
        except errors.NoWorkingTree:
1265
1706
            return False
1266
1707
        return True
1267
1708
 
1268
 
    def needs_format_conversion(self, format):
 
1709
    def needs_format_conversion(self, format=None):
1269
1710
        """See BzrDir.needs_format_conversion()."""
 
1711
        if format is None:
 
1712
            symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
 
1713
                % 'needs_format_conversion(format=None)')
 
1714
        if format is None:
 
1715
            format = BzrDirFormat.get_default_format()
1270
1716
        if not isinstance(self._format, format.__class__):
1271
1717
            # it is not a meta dir format, conversion is needed.
1272
1718
            return True
1278
1724
                return True
1279
1725
        except errors.NoRepositoryPresent:
1280
1726
            pass
1281
 
        for branch in self.list_branches():
1282
 
            if not isinstance(branch._format,
 
1727
        try:
 
1728
            if not isinstance(self.open_branch()._format,
1283
1729
                              format.get_branch_format().__class__):
1284
1730
                # the branch needs an upgrade.
1285
1731
                return True
 
1732
        except errors.NotBranchError:
 
1733
            pass
1286
1734
        try:
1287
1735
            my_wt = self.open_workingtree(recommend_upgrade=False)
1288
1736
            if not isinstance(my_wt._format,
1293
1741
            pass
1294
1742
        return False
1295
1743
 
1296
 
    def open_branch(self, name=None, unsupported=False,
1297
 
                    ignore_fallbacks=False):
 
1744
    def open_branch(self, unsupported=False, ignore_fallbacks=False):
1298
1745
        """See BzrDir.open_branch."""
1299
 
        format = self.find_branch_format(name=name)
1300
 
        format.check_support_status(unsupported)
1301
 
        return format.open(self, name=name,
1302
 
            _found=True, ignore_fallbacks=ignore_fallbacks)
 
1746
        format = self.find_branch_format()
 
1747
        self._check_supported(format, unsupported)
 
1748
        return format.open(self, _found=True, ignore_fallbacks=ignore_fallbacks)
1303
1749
 
1304
1750
    def open_repository(self, unsupported=False):
1305
1751
        """See BzrDir.open_repository."""
1306
1752
        from bzrlib.repository import RepositoryFormat
1307
1753
        format = RepositoryFormat.find_format(self)
1308
 
        format.check_support_status(unsupported)
 
1754
        self._check_supported(format, unsupported)
1309
1755
        return format.open(self, _found=True)
1310
1756
 
1311
1757
    def open_workingtree(self, unsupported=False,
1313
1759
        """See BzrDir.open_workingtree."""
1314
1760
        from bzrlib.workingtree import WorkingTreeFormat
1315
1761
        format = WorkingTreeFormat.find_format(self)
1316
 
        format.check_support_status(unsupported, recommend_upgrade,
 
1762
        self._check_supported(format, unsupported,
 
1763
            recommend_upgrade,
1317
1764
            basedir=self.root_transport.base)
1318
1765
        return format.open(self, _found=True)
1319
1766
 
1321
1768
        return config.TransportConfig(self.transport, 'control.conf')
1322
1769
 
1323
1770
 
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.
 
1771
class BzrDirFormat(object):
 
1772
    """An encapsulation of the initialization and open routines for a format.
 
1773
 
 
1774
    Formats provide three things:
 
1775
     * An initialization routine,
 
1776
     * a format string,
 
1777
     * an open routine.
1401
1778
 
1402
1779
    Formats are placed in a dict by their format string for reference
1403
1780
    during bzrdir opening. These should be subclasses of BzrDirFormat
1408
1785
    object will be created every system load.
1409
1786
    """
1410
1787
 
 
1788
    _default_format = None
 
1789
    """The default format used for new .bzr dirs."""
 
1790
 
 
1791
    _formats = {}
 
1792
    """The known formats."""
 
1793
 
 
1794
    _control_formats = []
 
1795
    """The registered control formats - .bzr, ....
 
1796
 
 
1797
    This is a list of BzrDirFormat objects.
 
1798
    """
 
1799
 
 
1800
    _control_server_formats = []
 
1801
    """The registered control server formats, e.g. RemoteBzrDirs.
 
1802
 
 
1803
    This is a list of BzrDirFormat objects.
 
1804
    """
 
1805
 
1411
1806
    _lock_file_name = 'branch-lock'
1412
1807
 
1413
1808
    # _lock_class must be set in subclasses to the lock type, typ.
1414
1809
    # TransportLock or LockDir
1415
1810
 
1416
1811
    @classmethod
1417
 
    def get_format_string(cls):
 
1812
    def find_format(klass, transport, _server_formats=True):
 
1813
        """Return the format present at transport."""
 
1814
        if _server_formats:
 
1815
            formats = klass._control_server_formats + klass._control_formats
 
1816
        else:
 
1817
            formats = klass._control_formats
 
1818
        for format in formats:
 
1819
            try:
 
1820
                return format.probe_transport(transport)
 
1821
            except errors.NotBranchError:
 
1822
                # this format does not find a control dir here.
 
1823
                pass
 
1824
        raise errors.NotBranchError(path=transport.base)
 
1825
 
 
1826
    @classmethod
 
1827
    def probe_transport(klass, transport):
 
1828
        """Return the .bzrdir style format present in a directory."""
 
1829
        try:
 
1830
            format_string = transport.get_bytes(".bzr/branch-format")
 
1831
        except errors.NoSuchFile:
 
1832
            raise errors.NotBranchError(path=transport.base)
 
1833
 
 
1834
        try:
 
1835
            return klass._formats[format_string]
 
1836
        except KeyError:
 
1837
            raise errors.UnknownFormatError(format=format_string, kind='bzrdir')
 
1838
 
 
1839
    @classmethod
 
1840
    def get_default_format(klass):
 
1841
        """Return the current default format."""
 
1842
        return klass._default_format
 
1843
 
 
1844
    def get_format_string(self):
1418
1845
        """Return the ASCII format string that identifies this format."""
1419
 
        raise NotImplementedError(cls.get_format_string)
 
1846
        raise NotImplementedError(self.get_format_string)
 
1847
 
 
1848
    def get_format_description(self):
 
1849
        """Return the short description for this format."""
 
1850
        raise NotImplementedError(self.get_format_description)
 
1851
 
 
1852
    def get_converter(self, format=None):
 
1853
        """Return the converter to use to convert bzrdirs needing converts.
 
1854
 
 
1855
        This returns a bzrlib.bzrdir.Converter object.
 
1856
 
 
1857
        This should return the best upgrader to step this format towards the
 
1858
        current default format. In the case of plugins we can/should provide
 
1859
        some means for them to extend the range of returnable converters.
 
1860
 
 
1861
        :param format: Optional format to override the default format of the
 
1862
                       library.
 
1863
        """
 
1864
        raise NotImplementedError(self.get_converter)
 
1865
 
 
1866
    def initialize(self, url, possible_transports=None):
 
1867
        """Create a bzr control dir at this url and return an opened copy.
 
1868
 
 
1869
        While not deprecated, this method is very specific and its use will
 
1870
        lead to many round trips to setup a working environment. See
 
1871
        initialize_on_transport_ex for a [nearly] all-in-one method.
 
1872
 
 
1873
        Subclasses should typically override initialize_on_transport
 
1874
        instead of this method.
 
1875
        """
 
1876
        return self.initialize_on_transport(get_transport(url,
 
1877
                                                          possible_transports))
1420
1878
 
1421
1879
    def initialize_on_transport(self, transport):
1422
1880
        """Initialize a new bzrdir in the base directory of a Transport."""
1432
1890
            # metadir1
1433
1891
            if type(self) != BzrDirMetaFormat1:
1434
1892
                return self._initialize_on_transport_vfs(transport)
1435
 
            from bzrlib.remote import RemoteBzrDirFormat
1436
1893
            remote_format = RemoteBzrDirFormat()
1437
1894
            self._supply_sub_formats_to(remote_format)
1438
1895
            return remote_format.initialize_on_transport(transport)
1476
1933
            except errors.NoSmartMedium:
1477
1934
                pass
1478
1935
            else:
1479
 
                from bzrlib.remote import RemoteBzrDirFormat
1480
1936
                # TODO: lookup the local format from a server hint.
1481
1937
                remote_dir_format = RemoteBzrDirFormat()
1482
1938
                remote_dir_format._network_name = self.network_name()
1557
2013
        utf8_files = [('README',
1558
2014
                       "This is a Bazaar control directory.\n"
1559
2015
                       "Do not change any files in this directory.\n"
1560
 
                       "See http://bazaar.canonical.com/ for more information about Bazaar.\n"),
 
2016
                       "See http://bazaar-vcs.org/ for more information about Bazaar.\n"),
1561
2017
                      ('branch-format', self.get_format_string()),
1562
2018
                      ]
1563
2019
        # NB: no need to escape relative paths that are url safe.
1573
2029
            control_files.unlock()
1574
2030
        return self.open(transport, _found=True)
1575
2031
 
 
2032
    def is_supported(self):
 
2033
        """Is this format supported?
 
2034
 
 
2035
        Supported formats must be initializable and openable.
 
2036
        Unsupported formats may not support initialization or committing or
 
2037
        some other features depending on the reason for not being supported.
 
2038
        """
 
2039
        return True
 
2040
 
 
2041
    def network_name(self):
 
2042
        """A simple byte string uniquely identifying this format for RPC calls.
 
2043
 
 
2044
        Bzr control formats use thir disk format string to identify the format
 
2045
        over the wire. Its possible that other control formats have more
 
2046
        complex detection requirements, so we permit them to use any unique and
 
2047
        immutable string they desire.
 
2048
        """
 
2049
        raise NotImplementedError(self.network_name)
 
2050
 
 
2051
    def same_model(self, target_format):
 
2052
        return (self.repository_format.rich_root_data ==
 
2053
            target_format.rich_root_data)
 
2054
 
 
2055
    @classmethod
 
2056
    def known_formats(klass):
 
2057
        """Return all the known formats.
 
2058
 
 
2059
        Concrete formats should override _known_formats.
 
2060
        """
 
2061
        # There is double indirection here to make sure that control
 
2062
        # formats used by more than one dir format will only be probed
 
2063
        # once. This can otherwise be quite expensive for remote connections.
 
2064
        result = set()
 
2065
        for format in klass._control_formats:
 
2066
            result.update(format._known_formats())
 
2067
        return result
 
2068
 
 
2069
    @classmethod
 
2070
    def _known_formats(klass):
 
2071
        """Return the known format instances for this control format."""
 
2072
        return set(klass._formats.values())
 
2073
 
1576
2074
    def open(self, transport, _found=False):
1577
2075
        """Return an instance of this format for the dir transport points at.
1578
2076
 
1579
2077
        _found is a private parameter, do not use it.
1580
2078
        """
1581
2079
        if not _found:
1582
 
            found_format = controldir.ControlDirFormat.find_format(transport)
 
2080
            found_format = BzrDirFormat.find_format(transport)
1583
2081
            if not isinstance(found_format, self.__class__):
1584
2082
                raise AssertionError("%s was asked to open %s, but it seems to need "
1585
2083
                        "format %s"
1597
2095
        """
1598
2096
        raise NotImplementedError(self._open)
1599
2097
 
 
2098
    @classmethod
 
2099
    def register_format(klass, format):
 
2100
        klass._formats[format.get_format_string()] = format
 
2101
        # bzr native formats have a network name of their format string.
 
2102
        network_format_registry.register(format.get_format_string(), format.__class__)
 
2103
 
 
2104
    @classmethod
 
2105
    def register_control_format(klass, format):
 
2106
        """Register a format that does not use '.bzr' for its control dir.
 
2107
 
 
2108
        TODO: This should be pulled up into a 'ControlDirFormat' base class
 
2109
        which BzrDirFormat can inherit from, and renamed to register_format
 
2110
        there. It has been done without that for now for simplicity of
 
2111
        implementation.
 
2112
        """
 
2113
        klass._control_formats.append(format)
 
2114
 
 
2115
    @classmethod
 
2116
    def register_control_server_format(klass, format):
 
2117
        """Register a control format for client-server environments.
 
2118
 
 
2119
        These formats will be tried before ones registered with
 
2120
        register_control_format.  This gives implementations that decide to the
 
2121
        chance to grab it before anything looks at the contents of the format
 
2122
        file.
 
2123
        """
 
2124
        klass._control_server_formats.append(format)
 
2125
 
 
2126
    @classmethod
 
2127
    def _set_default_format(klass, format):
 
2128
        """Set default format (for testing behavior of defaults only)"""
 
2129
        klass._default_format = format
 
2130
 
 
2131
    def __str__(self):
 
2132
        # Trim the newline
 
2133
        return self.get_format_description().rstrip()
 
2134
 
1600
2135
    def _supply_sub_formats_to(self, other_format):
1601
2136
        """Give other_format the same values for sub formats as this has.
1602
2137
 
1609
2144
        :return: None.
1610
2145
        """
1611
2146
 
 
2147
    @classmethod
 
2148
    def unregister_format(klass, format):
 
2149
        del klass._formats[format.get_format_string()]
 
2150
 
 
2151
    @classmethod
 
2152
    def unregister_control_format(klass, format):
 
2153
        klass._control_formats.remove(format)
 
2154
 
 
2155
 
 
2156
class BzrDirFormat4(BzrDirFormat):
 
2157
    """Bzr dir format 4.
 
2158
 
 
2159
    This format is a combined format for working tree, branch and repository.
 
2160
    It has:
 
2161
     - Format 1 working trees [always]
 
2162
     - Format 4 branches [always]
 
2163
     - Format 4 repositories [always]
 
2164
 
 
2165
    This format is deprecated: it indexes texts using a text it which is
 
2166
    removed in format 5; write support for this format has been removed.
 
2167
    """
 
2168
 
 
2169
    _lock_class = lockable_files.TransportLock
 
2170
 
 
2171
    def get_format_string(self):
 
2172
        """See BzrDirFormat.get_format_string()."""
 
2173
        return "Bazaar-NG branch, format 0.0.4\n"
 
2174
 
 
2175
    def get_format_description(self):
 
2176
        """See BzrDirFormat.get_format_description()."""
 
2177
        return "All-in-one format 4"
 
2178
 
 
2179
    def get_converter(self, format=None):
 
2180
        """See BzrDirFormat.get_converter()."""
 
2181
        # there is one and only one upgrade path here.
 
2182
        return ConvertBzrDir4To5()
 
2183
 
 
2184
    def initialize_on_transport(self, transport):
 
2185
        """Format 4 branches cannot be created."""
 
2186
        raise errors.UninitializableFormat(self)
 
2187
 
 
2188
    def is_supported(self):
 
2189
        """Format 4 is not supported.
 
2190
 
 
2191
        It is not supported because the model changed from 4 to 5 and the
 
2192
        conversion logic is expensive - so doing it on the fly was not
 
2193
        feasible.
 
2194
        """
 
2195
        return False
 
2196
 
 
2197
    def network_name(self):
 
2198
        return self.get_format_string()
 
2199
 
 
2200
    def _open(self, transport):
 
2201
        """See BzrDirFormat._open."""
 
2202
        return BzrDir4(transport, self)
 
2203
 
 
2204
    def __return_repository_format(self):
 
2205
        """Circular import protection."""
 
2206
        from bzrlib.repofmt.weaverepo import RepositoryFormat4
 
2207
        return RepositoryFormat4()
 
2208
    repository_format = property(__return_repository_format)
 
2209
 
 
2210
 
 
2211
class BzrDirFormatAllInOne(BzrDirFormat):
 
2212
    """Common class for formats before meta-dirs."""
 
2213
 
 
2214
    def initialize_on_transport_ex(self, transport, use_existing_dir=False,
 
2215
        create_prefix=False, force_new_repo=False, stacked_on=None,
 
2216
        stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
 
2217
        shared_repo=False):
 
2218
        """See BzrDirFormat.initialize_on_transport_ex."""
 
2219
        require_stacking = (stacked_on is not None)
 
2220
        # Format 5 cannot stack, but we've been asked to - actually init
 
2221
        # a Meta1Dir
 
2222
        if require_stacking:
 
2223
            format = BzrDirMetaFormat1()
 
2224
            return format.initialize_on_transport_ex(transport,
 
2225
                use_existing_dir=use_existing_dir, create_prefix=create_prefix,
 
2226
                force_new_repo=force_new_repo, stacked_on=stacked_on,
 
2227
                stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
 
2228
                make_working_trees=make_working_trees, shared_repo=shared_repo)
 
2229
        return BzrDirFormat.initialize_on_transport_ex(self, transport,
 
2230
            use_existing_dir=use_existing_dir, create_prefix=create_prefix,
 
2231
            force_new_repo=force_new_repo, stacked_on=stacked_on,
 
2232
            stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
 
2233
            make_working_trees=make_working_trees, shared_repo=shared_repo)
 
2234
 
 
2235
 
 
2236
class BzrDirFormat5(BzrDirFormatAllInOne):
 
2237
    """Bzr control format 5.
 
2238
 
 
2239
    This format is a combined format for working tree, branch and repository.
 
2240
    It has:
 
2241
     - Format 2 working trees [always]
 
2242
     - Format 4 branches [always]
 
2243
     - Format 5 repositories [always]
 
2244
       Unhashed stores in the repository.
 
2245
    """
 
2246
 
 
2247
    _lock_class = lockable_files.TransportLock
 
2248
 
 
2249
    def get_format_string(self):
 
2250
        """See BzrDirFormat.get_format_string()."""
 
2251
        return "Bazaar-NG branch, format 5\n"
 
2252
 
 
2253
    def get_branch_format(self):
 
2254
        from bzrlib import branch
 
2255
        return branch.BzrBranchFormat4()
 
2256
 
 
2257
    def get_format_description(self):
 
2258
        """See BzrDirFormat.get_format_description()."""
 
2259
        return "All-in-one format 5"
 
2260
 
 
2261
    def get_converter(self, format=None):
 
2262
        """See BzrDirFormat.get_converter()."""
 
2263
        # there is one and only one upgrade path here.
 
2264
        return ConvertBzrDir5To6()
 
2265
 
 
2266
    def _initialize_for_clone(self, url):
 
2267
        return self.initialize_on_transport(get_transport(url), _cloning=True)
 
2268
 
 
2269
    def initialize_on_transport(self, transport, _cloning=False):
 
2270
        """Format 5 dirs always have working tree, branch and repository.
 
2271
 
 
2272
        Except when they are being cloned.
 
2273
        """
 
2274
        from bzrlib.branch import BzrBranchFormat4
 
2275
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
 
2276
        result = (super(BzrDirFormat5, self).initialize_on_transport(transport))
 
2277
        RepositoryFormat5().initialize(result, _internal=True)
 
2278
        if not _cloning:
 
2279
            branch = BzrBranchFormat4().initialize(result)
 
2280
            result._init_workingtree()
 
2281
        return result
 
2282
 
 
2283
    def network_name(self):
 
2284
        return self.get_format_string()
 
2285
 
 
2286
    def _open(self, transport):
 
2287
        """See BzrDirFormat._open."""
 
2288
        return BzrDir5(transport, self)
 
2289
 
 
2290
    def __return_repository_format(self):
 
2291
        """Circular import protection."""
 
2292
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
 
2293
        return RepositoryFormat5()
 
2294
    repository_format = property(__return_repository_format)
 
2295
 
 
2296
 
 
2297
class BzrDirFormat6(BzrDirFormatAllInOne):
 
2298
    """Bzr control format 6.
 
2299
 
 
2300
    This format is a combined format for working tree, branch and repository.
 
2301
    It has:
 
2302
     - Format 2 working trees [always]
 
2303
     - Format 4 branches [always]
 
2304
     - Format 6 repositories [always]
 
2305
    """
 
2306
 
 
2307
    _lock_class = lockable_files.TransportLock
 
2308
 
 
2309
    def get_format_string(self):
 
2310
        """See BzrDirFormat.get_format_string()."""
 
2311
        return "Bazaar-NG branch, format 6\n"
 
2312
 
 
2313
    def get_format_description(self):
 
2314
        """See BzrDirFormat.get_format_description()."""
 
2315
        return "All-in-one format 6"
 
2316
 
 
2317
    def get_branch_format(self):
 
2318
        from bzrlib import branch
 
2319
        return branch.BzrBranchFormat4()
 
2320
 
 
2321
    def get_converter(self, format=None):
 
2322
        """See BzrDirFormat.get_converter()."""
 
2323
        # there is one and only one upgrade path here.
 
2324
        return ConvertBzrDir6ToMeta()
 
2325
 
 
2326
    def _initialize_for_clone(self, url):
 
2327
        return self.initialize_on_transport(get_transport(url), _cloning=True)
 
2328
 
 
2329
    def initialize_on_transport(self, transport, _cloning=False):
 
2330
        """Format 6 dirs always have working tree, branch and repository.
 
2331
 
 
2332
        Except when they are being cloned.
 
2333
        """
 
2334
        from bzrlib.branch import BzrBranchFormat4
 
2335
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
 
2336
        result = super(BzrDirFormat6, self).initialize_on_transport(transport)
 
2337
        RepositoryFormat6().initialize(result, _internal=True)
 
2338
        if not _cloning:
 
2339
            branch = BzrBranchFormat4().initialize(result)
 
2340
            result._init_workingtree()
 
2341
        return result
 
2342
 
 
2343
    def network_name(self):
 
2344
        return self.get_format_string()
 
2345
 
 
2346
    def _open(self, transport):
 
2347
        """See BzrDirFormat._open."""
 
2348
        return BzrDir6(transport, self)
 
2349
 
 
2350
    def __return_repository_format(self):
 
2351
        """Circular import protection."""
 
2352
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
 
2353
        return RepositoryFormat6()
 
2354
    repository_format = property(__return_repository_format)
 
2355
 
1612
2356
 
1613
2357
class BzrDirMetaFormat1(BzrDirFormat):
1614
2358
    """Bzr meta control format 1
1615
2359
 
1616
2360
    This is the first format with split out working tree, branch and repository
1617
2361
    disk storage.
1618
 
 
1619
2362
    It has:
1620
 
 
1621
 
    - Format 3 working trees [optional]
1622
 
    - Format 5 branches [optional]
1623
 
    - Format 7 repositories [optional]
 
2363
     - Format 3 working trees [optional]
 
2364
     - Format 5 branches [optional]
 
2365
     - Format 7 repositories [optional]
1624
2366
    """
1625
2367
 
1626
2368
    _lock_class = lockdir.LockDir
1627
2369
 
1628
 
    fixed_components = False
1629
 
 
1630
2370
    def __init__(self):
1631
2371
        self._workingtree_format = None
1632
2372
        self._branch_format = None
1646
2386
 
1647
2387
    def get_branch_format(self):
1648
2388
        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()
 
2389
            from bzrlib.branch import BranchFormat
 
2390
            self._branch_format = BranchFormat.get_default_format()
1651
2391
        return self._branch_format
1652
2392
 
1653
2393
    def set_branch_format(self, format):
1708
2448
                    # stack_on is inaccessible, JFDI.
1709
2449
                    # TODO: bad monkey, hard-coded formats...
1710
2450
                    if self.repository_format.rich_root_data:
1711
 
                        new_repo_format = knitpack_repo.RepositoryFormatKnitPack5RichRoot()
 
2451
                        new_repo_format = pack_repo.RepositoryFormatKnitPack5RichRoot()
1712
2452
                    else:
1713
 
                        new_repo_format = knitpack_repo.RepositoryFormatKnitPack5()
 
2453
                        new_repo_format = pack_repo.RepositoryFormatKnitPack5()
1714
2454
            else:
1715
2455
                # If the target already supports stacking, then we know the
1716
2456
                # project is already able to use stacking, so auto-upgrade
1733
2473
            if target_branch is None:
1734
2474
                if do_upgrade:
1735
2475
                    # TODO: bad monkey, hard-coded formats...
1736
 
                    from bzrlib.branch import BzrBranchFormat7
1737
 
                    new_branch_format = BzrBranchFormat7()
 
2476
                    new_branch_format = branch.BzrBranchFormat7()
1738
2477
            else:
1739
2478
                new_branch_format = target_branch._format
1740
2479
                if not new_branch_format.supports_stacking():
1755
2494
            raise NotImplementedError(self.get_converter)
1756
2495
        return ConvertMetaToMeta(format)
1757
2496
 
1758
 
    @classmethod
1759
 
    def get_format_string(cls):
 
2497
    def get_format_string(self):
1760
2498
        """See BzrDirFormat.get_format_string()."""
1761
2499
        return "Bazaar-NG meta directory, format 1\n"
1762
2500
 
1780
2518
        """Circular import protection."""
1781
2519
        if self._repository_format:
1782
2520
            return self._repository_format
1783
 
        from bzrlib.repository import format_registry
1784
 
        return format_registry.get_default()
 
2521
        from bzrlib.repository import RepositoryFormat
 
2522
        return RepositoryFormat.get_default_format()
1785
2523
 
1786
2524
    def _set_repository_format(self, value):
1787
2525
        """Allow changing the repository format for metadir formats."""
1810
2548
 
1811
2549
    def __get_workingtree_format(self):
1812
2550
        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()
 
2551
            from bzrlib.workingtree import WorkingTreeFormat
 
2552
            self._workingtree_format = WorkingTreeFormat.get_default_format()
1817
2553
        return self._workingtree_format
1818
2554
 
1819
2555
    def __set_workingtree_format(self, wt_format):
1823
2559
                                  __set_workingtree_format)
1824
2560
 
1825
2561
 
 
2562
network_format_registry = registry.FormatRegistry()
 
2563
"""Registry of formats indexed by their network name.
 
2564
 
 
2565
The network name for a BzrDirFormat is an identifier that can be used when
 
2566
referring to formats with smart server operations. See
 
2567
BzrDirFormat.network_name() for more detail.
 
2568
"""
 
2569
 
 
2570
 
 
2571
# Register bzr control format
 
2572
BzrDirFormat.register_control_format(BzrDirFormat)
 
2573
 
1826
2574
# 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):
 
2575
BzrDirFormat.register_format(BzrDirFormat4())
 
2576
BzrDirFormat.register_format(BzrDirFormat5())
 
2577
BzrDirFormat.register_format(BzrDirFormat6())
 
2578
__default_format = BzrDirMetaFormat1()
 
2579
BzrDirFormat.register_format(__default_format)
 
2580
BzrDirFormat._default_format = __default_format
 
2581
 
 
2582
 
 
2583
class Converter(object):
 
2584
    """Converts a disk format object from one format to another."""
 
2585
 
 
2586
    def convert(self, to_convert, pb):
 
2587
        """Perform the conversion of to_convert, giving feedback via pb.
 
2588
 
 
2589
        :param to_convert: The disk object to convert.
 
2590
        :param pb: a progress bar to use for progress information.
 
2591
        """
 
2592
 
 
2593
    def step(self, message):
 
2594
        """Update the pb by a step."""
 
2595
        self.count +=1
 
2596
        self.pb.update(message, self.count, self.total)
 
2597
 
 
2598
 
 
2599
class ConvertBzrDir4To5(Converter):
 
2600
    """Converts format 4 bzr dirs to format 5."""
 
2601
 
 
2602
    def __init__(self):
 
2603
        super(ConvertBzrDir4To5, self).__init__()
 
2604
        self.converted_revs = set()
 
2605
        self.absent_revisions = set()
 
2606
        self.text_count = 0
 
2607
        self.revisions = {}
 
2608
 
 
2609
    def convert(self, to_convert, pb):
 
2610
        """See Converter.convert()."""
 
2611
        self.bzrdir = to_convert
 
2612
        self.pb = pb
 
2613
        ui.ui_factory.note('starting upgrade from format 4 to 5')
 
2614
        if isinstance(self.bzrdir.transport, local.LocalTransport):
 
2615
            self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
 
2616
        self._convert_to_weaves()
 
2617
        return BzrDir.open(self.bzrdir.root_transport.base)
 
2618
 
 
2619
    def _convert_to_weaves(self):
 
2620
        ui.ui_factory.note('note: upgrade may be faster if all store files are ungzipped first')
 
2621
        try:
 
2622
            # TODO permissions
 
2623
            stat = self.bzrdir.transport.stat('weaves')
 
2624
            if not S_ISDIR(stat.st_mode):
 
2625
                self.bzrdir.transport.delete('weaves')
 
2626
                self.bzrdir.transport.mkdir('weaves')
 
2627
        except errors.NoSuchFile:
 
2628
            self.bzrdir.transport.mkdir('weaves')
 
2629
        # deliberately not a WeaveFile as we want to build it up slowly.
 
2630
        self.inv_weave = Weave('inventory')
 
2631
        # holds in-memory weaves for all files
 
2632
        self.text_weaves = {}
 
2633
        self.bzrdir.transport.delete('branch-format')
 
2634
        self.branch = self.bzrdir.open_branch()
 
2635
        self._convert_working_inv()
 
2636
        rev_history = self.branch.revision_history()
 
2637
        # to_read is a stack holding the revisions we still need to process;
 
2638
        # appending to it adds new highest-priority revisions
 
2639
        self.known_revisions = set(rev_history)
 
2640
        self.to_read = rev_history[-1:]
 
2641
        while self.to_read:
 
2642
            rev_id = self.to_read.pop()
 
2643
            if (rev_id not in self.revisions
 
2644
                and rev_id not in self.absent_revisions):
 
2645
                self._load_one_rev(rev_id)
 
2646
        self.pb.clear()
 
2647
        to_import = self._make_order()
 
2648
        for i, rev_id in enumerate(to_import):
 
2649
            self.pb.update('converting revision', i, len(to_import))
 
2650
            self._convert_one_rev(rev_id)
 
2651
        self.pb.clear()
 
2652
        self._write_all_weaves()
 
2653
        self._write_all_revs()
 
2654
        ui.ui_factory.note('upgraded to weaves:')
 
2655
        ui.ui_factory.note('  %6d revisions and inventories' % len(self.revisions))
 
2656
        ui.ui_factory.note('  %6d revisions not present' % len(self.absent_revisions))
 
2657
        ui.ui_factory.note('  %6d texts' % self.text_count)
 
2658
        self._cleanup_spare_files_after_format4()
 
2659
        self.branch._transport.put_bytes(
 
2660
            'branch-format',
 
2661
            BzrDirFormat5().get_format_string(),
 
2662
            mode=self.bzrdir._get_file_mode())
 
2663
 
 
2664
    def _cleanup_spare_files_after_format4(self):
 
2665
        # FIXME working tree upgrade foo.
 
2666
        for n in 'merged-patches', 'pending-merged-patches':
 
2667
            try:
 
2668
                ## assert os.path.getsize(p) == 0
 
2669
                self.bzrdir.transport.delete(n)
 
2670
            except errors.NoSuchFile:
 
2671
                pass
 
2672
        self.bzrdir.transport.delete_tree('inventory-store')
 
2673
        self.bzrdir.transport.delete_tree('text-store')
 
2674
 
 
2675
    def _convert_working_inv(self):
 
2676
        inv = xml4.serializer_v4.read_inventory(
 
2677
                self.branch._transport.get('inventory'))
 
2678
        new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv, working=True)
 
2679
        self.branch._transport.put_bytes('inventory', new_inv_xml,
 
2680
            mode=self.bzrdir._get_file_mode())
 
2681
 
 
2682
    def _write_all_weaves(self):
 
2683
        controlweaves = WeaveStore(self.bzrdir.transport, prefixed=False)
 
2684
        weave_transport = self.bzrdir.transport.clone('weaves')
 
2685
        weaves = WeaveStore(weave_transport, prefixed=False)
 
2686
        transaction = WriteTransaction()
 
2687
 
 
2688
        try:
 
2689
            i = 0
 
2690
            for file_id, file_weave in self.text_weaves.items():
 
2691
                self.pb.update('writing weave', i, len(self.text_weaves))
 
2692
                weaves._put_weave(file_id, file_weave, transaction)
 
2693
                i += 1
 
2694
            self.pb.update('inventory', 0, 1)
 
2695
            controlweaves._put_weave('inventory', self.inv_weave, transaction)
 
2696
            self.pb.update('inventory', 1, 1)
 
2697
        finally:
 
2698
            self.pb.clear()
 
2699
 
 
2700
    def _write_all_revs(self):
 
2701
        """Write all revisions out in new form."""
 
2702
        self.bzrdir.transport.delete_tree('revision-store')
 
2703
        self.bzrdir.transport.mkdir('revision-store')
 
2704
        revision_transport = self.bzrdir.transport.clone('revision-store')
 
2705
        # TODO permissions
 
2706
        from bzrlib.xml5 import serializer_v5
 
2707
        from bzrlib.repofmt.weaverepo import RevisionTextStore
 
2708
        revision_store = RevisionTextStore(revision_transport,
 
2709
            serializer_v5, False, versionedfile.PrefixMapper(),
 
2710
            lambda:True, lambda:True)
 
2711
        try:
 
2712
            for i, rev_id in enumerate(self.converted_revs):
 
2713
                self.pb.update('write revision', i, len(self.converted_revs))
 
2714
                text = serializer_v5.write_revision_to_string(
 
2715
                    self.revisions[rev_id])
 
2716
                key = (rev_id,)
 
2717
                revision_store.add_lines(key, None, osutils.split_lines(text))
 
2718
        finally:
 
2719
            self.pb.clear()
 
2720
 
 
2721
    def _load_one_rev(self, rev_id):
 
2722
        """Load a revision object into memory.
 
2723
 
 
2724
        Any parents not either loaded or abandoned get queued to be
 
2725
        loaded."""
 
2726
        self.pb.update('loading revision',
 
2727
                       len(self.revisions),
 
2728
                       len(self.known_revisions))
 
2729
        if not self.branch.repository.has_revision(rev_id):
 
2730
            self.pb.clear()
 
2731
            ui.ui_factory.note('revision {%s} not present in branch; '
 
2732
                         'will be converted as a ghost' %
 
2733
                         rev_id)
 
2734
            self.absent_revisions.add(rev_id)
 
2735
        else:
 
2736
            rev = self.branch.repository.get_revision(rev_id)
 
2737
            for parent_id in rev.parent_ids:
 
2738
                self.known_revisions.add(parent_id)
 
2739
                self.to_read.append(parent_id)
 
2740
            self.revisions[rev_id] = rev
 
2741
 
 
2742
    def _load_old_inventory(self, rev_id):
 
2743
        old_inv_xml = self.branch.repository.inventory_store.get(rev_id).read()
 
2744
        inv = xml4.serializer_v4.read_inventory_from_string(old_inv_xml)
 
2745
        inv.revision_id = rev_id
 
2746
        rev = self.revisions[rev_id]
 
2747
        return inv
 
2748
 
 
2749
    def _load_updated_inventory(self, rev_id):
 
2750
        inv_xml = self.inv_weave.get_text(rev_id)
 
2751
        inv = xml5.serializer_v5.read_inventory_from_string(inv_xml, rev_id)
 
2752
        return inv
 
2753
 
 
2754
    def _convert_one_rev(self, rev_id):
 
2755
        """Convert revision and all referenced objects to new format."""
 
2756
        rev = self.revisions[rev_id]
 
2757
        inv = self._load_old_inventory(rev_id)
 
2758
        present_parents = [p for p in rev.parent_ids
 
2759
                           if p not in self.absent_revisions]
 
2760
        self._convert_revision_contents(rev, inv, present_parents)
 
2761
        self._store_new_inv(rev, inv, present_parents)
 
2762
        self.converted_revs.add(rev_id)
 
2763
 
 
2764
    def _store_new_inv(self, rev, inv, present_parents):
 
2765
        new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
 
2766
        new_inv_sha1 = sha_string(new_inv_xml)
 
2767
        self.inv_weave.add_lines(rev.revision_id,
 
2768
                                 present_parents,
 
2769
                                 new_inv_xml.splitlines(True))
 
2770
        rev.inventory_sha1 = new_inv_sha1
 
2771
 
 
2772
    def _convert_revision_contents(self, rev, inv, present_parents):
 
2773
        """Convert all the files within a revision.
 
2774
 
 
2775
        Also upgrade the inventory to refer to the text revision ids."""
 
2776
        rev_id = rev.revision_id
 
2777
        mutter('converting texts of revision {%s}',
 
2778
               rev_id)
 
2779
        parent_invs = map(self._load_updated_inventory, present_parents)
 
2780
        entries = inv.iter_entries()
 
2781
        entries.next()
 
2782
        for path, ie in entries:
 
2783
            self._convert_file_version(rev, ie, parent_invs)
 
2784
 
 
2785
    def _convert_file_version(self, rev, ie, parent_invs):
 
2786
        """Convert one version of one file.
 
2787
 
 
2788
        The file needs to be added into the weave if it is a merge
 
2789
        of >=2 parents or if it's changed from its parent.
 
2790
        """
 
2791
        file_id = ie.file_id
 
2792
        rev_id = rev.revision_id
 
2793
        w = self.text_weaves.get(file_id)
 
2794
        if w is None:
 
2795
            w = Weave(file_id)
 
2796
            self.text_weaves[file_id] = w
 
2797
        text_changed = False
 
2798
        parent_candiate_entries = ie.parent_candidates(parent_invs)
 
2799
        heads = graph.Graph(self).heads(parent_candiate_entries.keys())
 
2800
        # XXX: Note that this is unordered - and this is tolerable because
 
2801
        # the previous code was also unordered.
 
2802
        previous_entries = dict((head, parent_candiate_entries[head]) for head
 
2803
            in heads)
 
2804
        self.snapshot_ie(previous_entries, ie, w, rev_id)
 
2805
        del ie.text_id
 
2806
 
 
2807
    def get_parent_map(self, revision_ids):
 
2808
        """See graph.StackedParentsProvider.get_parent_map"""
 
2809
        return dict((revision_id, self.revisions[revision_id])
 
2810
                    for revision_id in revision_ids
 
2811
                     if revision_id in self.revisions)
 
2812
 
 
2813
    def snapshot_ie(self, previous_revisions, ie, w, rev_id):
 
2814
        # TODO: convert this logic, which is ~= snapshot to
 
2815
        # a call to:. This needs the path figured out. rather than a work_tree
 
2816
        # a v4 revision_tree can be given, or something that looks enough like
 
2817
        # one to give the file content to the entry if it needs it.
 
2818
        # and we need something that looks like a weave store for snapshot to
 
2819
        # save against.
 
2820
        #ie.snapshot(rev, PATH, previous_revisions, REVISION_TREE, InMemoryWeaveStore(self.text_weaves))
 
2821
        if len(previous_revisions) == 1:
 
2822
            previous_ie = previous_revisions.values()[0]
 
2823
            if ie._unchanged(previous_ie):
 
2824
                ie.revision = previous_ie.revision
 
2825
                return
 
2826
        if ie.has_text():
 
2827
            text = self.branch.repository._text_store.get(ie.text_id)
 
2828
            file_lines = text.readlines()
 
2829
            w.add_lines(rev_id, previous_revisions, file_lines)
 
2830
            self.text_count += 1
 
2831
        else:
 
2832
            w.add_lines(rev_id, previous_revisions, [])
 
2833
        ie.revision = rev_id
 
2834
 
 
2835
    def _make_order(self):
 
2836
        """Return a suitable order for importing revisions.
 
2837
 
 
2838
        The order must be such that an revision is imported after all
 
2839
        its (present) parents.
 
2840
        """
 
2841
        todo = set(self.revisions.keys())
 
2842
        done = self.absent_revisions.copy()
 
2843
        order = []
 
2844
        while todo:
 
2845
            # scan through looking for a revision whose parents
 
2846
            # are all done
 
2847
            for rev_id in sorted(list(todo)):
 
2848
                rev = self.revisions[rev_id]
 
2849
                parent_ids = set(rev.parent_ids)
 
2850
                if parent_ids.issubset(done):
 
2851
                    # can take this one now
 
2852
                    order.append(rev_id)
 
2853
                    todo.remove(rev_id)
 
2854
                    done.add(rev_id)
 
2855
        return order
 
2856
 
 
2857
 
 
2858
class ConvertBzrDir5To6(Converter):
 
2859
    """Converts format 5 bzr dirs to format 6."""
 
2860
 
 
2861
    def convert(self, to_convert, pb):
 
2862
        """See Converter.convert()."""
 
2863
        self.bzrdir = to_convert
 
2864
        self.pb = pb
 
2865
        ui.ui_factory.note('starting upgrade from format 5 to 6')
 
2866
        self._convert_to_prefixed()
 
2867
        return BzrDir.open(self.bzrdir.root_transport.base)
 
2868
 
 
2869
    def _convert_to_prefixed(self):
 
2870
        from bzrlib.store import TransportStore
 
2871
        self.bzrdir.transport.delete('branch-format')
 
2872
        for store_name in ["weaves", "revision-store"]:
 
2873
            ui.ui_factory.note("adding prefixes to %s" % store_name)
 
2874
            store_transport = self.bzrdir.transport.clone(store_name)
 
2875
            store = TransportStore(store_transport, prefixed=True)
 
2876
            for urlfilename in store_transport.list_dir('.'):
 
2877
                filename = urlutils.unescape(urlfilename)
 
2878
                if (filename.endswith(".weave") or
 
2879
                    filename.endswith(".gz") or
 
2880
                    filename.endswith(".sig")):
 
2881
                    file_id, suffix = os.path.splitext(filename)
 
2882
                else:
 
2883
                    file_id = filename
 
2884
                    suffix = ''
 
2885
                new_name = store._mapper.map((file_id,)) + suffix
 
2886
                # FIXME keep track of the dirs made RBC 20060121
 
2887
                try:
 
2888
                    store_transport.move(filename, new_name)
 
2889
                except errors.NoSuchFile: # catches missing dirs strangely enough
 
2890
                    store_transport.mkdir(osutils.dirname(new_name))
 
2891
                    store_transport.move(filename, new_name)
 
2892
        self.bzrdir.transport.put_bytes(
 
2893
            'branch-format',
 
2894
            BzrDirFormat6().get_format_string(),
 
2895
            mode=self.bzrdir._get_file_mode())
 
2896
 
 
2897
 
 
2898
class ConvertBzrDir6ToMeta(Converter):
 
2899
    """Converts format 6 bzr dirs to metadirs."""
 
2900
 
 
2901
    def convert(self, to_convert, pb):
 
2902
        """See Converter.convert()."""
 
2903
        from bzrlib.repofmt.weaverepo import RepositoryFormat7
 
2904
        from bzrlib.branch import BzrBranchFormat5
 
2905
        self.bzrdir = to_convert
 
2906
        self.pb = pb
 
2907
        self.count = 0
 
2908
        self.total = 20 # the steps we know about
 
2909
        self.garbage_inventories = []
 
2910
        self.dir_mode = self.bzrdir._get_dir_mode()
 
2911
        self.file_mode = self.bzrdir._get_file_mode()
 
2912
 
 
2913
        ui.ui_factory.note('starting upgrade from format 6 to metadir')
 
2914
        self.bzrdir.transport.put_bytes(
 
2915
                'branch-format',
 
2916
                "Converting to format 6",
 
2917
                mode=self.file_mode)
 
2918
        # its faster to move specific files around than to open and use the apis...
 
2919
        # first off, nuke ancestry.weave, it was never used.
 
2920
        try:
 
2921
            self.step('Removing ancestry.weave')
 
2922
            self.bzrdir.transport.delete('ancestry.weave')
 
2923
        except errors.NoSuchFile:
 
2924
            pass
 
2925
        # find out whats there
 
2926
        self.step('Finding branch files')
 
2927
        last_revision = self.bzrdir.open_branch().last_revision()
 
2928
        bzrcontents = self.bzrdir.transport.list_dir('.')
 
2929
        for name in bzrcontents:
 
2930
            if name.startswith('basis-inventory.'):
 
2931
                self.garbage_inventories.append(name)
 
2932
        # create new directories for repository, working tree and branch
 
2933
        repository_names = [('inventory.weave', True),
 
2934
                            ('revision-store', True),
 
2935
                            ('weaves', True)]
 
2936
        self.step('Upgrading repository  ')
 
2937
        self.bzrdir.transport.mkdir('repository', mode=self.dir_mode)
 
2938
        self.make_lock('repository')
 
2939
        # we hard code the formats here because we are converting into
 
2940
        # the meta format. The meta format upgrader can take this to a
 
2941
        # future format within each component.
 
2942
        self.put_format('repository', RepositoryFormat7())
 
2943
        for entry in repository_names:
 
2944
            self.move_entry('repository', entry)
 
2945
 
 
2946
        self.step('Upgrading branch      ')
 
2947
        self.bzrdir.transport.mkdir('branch', mode=self.dir_mode)
 
2948
        self.make_lock('branch')
 
2949
        self.put_format('branch', BzrBranchFormat5())
 
2950
        branch_files = [('revision-history', True),
 
2951
                        ('branch-name', True),
 
2952
                        ('parent', False)]
 
2953
        for entry in branch_files:
 
2954
            self.move_entry('branch', entry)
 
2955
 
 
2956
        checkout_files = [('pending-merges', True),
 
2957
                          ('inventory', True),
 
2958
                          ('stat-cache', False)]
 
2959
        # If a mandatory checkout file is not present, the branch does not have
 
2960
        # a functional checkout. Do not create a checkout in the converted
 
2961
        # branch.
 
2962
        for name, mandatory in checkout_files:
 
2963
            if mandatory and name not in bzrcontents:
 
2964
                has_checkout = False
 
2965
                break
 
2966
        else:
 
2967
            has_checkout = True
 
2968
        if not has_checkout:
 
2969
            ui.ui_factory.note('No working tree.')
 
2970
            # If some checkout files are there, we may as well get rid of them.
 
2971
            for name, mandatory in checkout_files:
 
2972
                if name in bzrcontents:
 
2973
                    self.bzrdir.transport.delete(name)
 
2974
        else:
 
2975
            from bzrlib.workingtree import WorkingTreeFormat3
 
2976
            self.step('Upgrading working tree')
 
2977
            self.bzrdir.transport.mkdir('checkout', mode=self.dir_mode)
 
2978
            self.make_lock('checkout')
 
2979
            self.put_format(
 
2980
                'checkout', WorkingTreeFormat3())
 
2981
            self.bzrdir.transport.delete_multi(
 
2982
                self.garbage_inventories, self.pb)
 
2983
            for entry in checkout_files:
 
2984
                self.move_entry('checkout', entry)
 
2985
            if last_revision is not None:
 
2986
                self.bzrdir.transport.put_bytes(
 
2987
                    'checkout/last-revision', last_revision)
 
2988
        self.bzrdir.transport.put_bytes(
 
2989
            'branch-format',
 
2990
            BzrDirMetaFormat1().get_format_string(),
 
2991
            mode=self.file_mode)
 
2992
        return BzrDir.open(self.bzrdir.root_transport.base)
 
2993
 
 
2994
    def make_lock(self, name):
 
2995
        """Make a lock for the new control dir name."""
 
2996
        self.step('Make %s lock' % name)
 
2997
        ld = lockdir.LockDir(self.bzrdir.transport,
 
2998
                             '%s/lock' % name,
 
2999
                             file_modebits=self.file_mode,
 
3000
                             dir_modebits=self.dir_mode)
 
3001
        ld.create()
 
3002
 
 
3003
    def move_entry(self, new_dir, entry):
 
3004
        """Move then entry name into new_dir."""
 
3005
        name = entry[0]
 
3006
        mandatory = entry[1]
 
3007
        self.step('Moving %s' % name)
 
3008
        try:
 
3009
            self.bzrdir.transport.move(name, '%s/%s' % (new_dir, name))
 
3010
        except errors.NoSuchFile:
 
3011
            if mandatory:
 
3012
                raise
 
3013
 
 
3014
    def put_format(self, dirname, format):
 
3015
        self.bzrdir.transport.put_bytes('%s/format' % dirname,
 
3016
            format.get_format_string(),
 
3017
            self.file_mode)
 
3018
 
 
3019
 
 
3020
class ConvertMetaToMeta(Converter):
1833
3021
    """Converts the components of metadirs."""
1834
3022
 
1835
3023
    def __init__(self, target_format):
1842
3030
    def convert(self, to_convert, pb):
1843
3031
        """See Converter.convert()."""
1844
3032
        self.bzrdir = to_convert
1845
 
        self.pb = ui.ui_factory.nested_progress_bar()
 
3033
        self.pb = pb
1846
3034
        self.count = 0
1847
3035
        self.total = 1
1848
3036
        self.step('checking repository format')
1856
3044
                ui.ui_factory.note('starting repository conversion')
1857
3045
                converter = CopyConverter(self.target_format.repository_format)
1858
3046
                converter.convert(repo, pb)
1859
 
        for branch in self.bzrdir.list_branches():
 
3047
        try:
 
3048
            branch = self.bzrdir.open_branch()
 
3049
        except errors.NotBranchError:
 
3050
            pass
 
3051
        else:
1860
3052
            # TODO: conversions of Branch and Tree should be done by
1861
3053
            # InterXFormat lookups/some sort of registry.
1862
3054
            # Avoid circular imports
 
3055
            from bzrlib import branch as _mod_branch
1863
3056
            old = branch._format.__class__
1864
3057
            new = self.target_format.get_branch_format().__class__
1865
3058
            while old != new:
1888
3081
        else:
1889
3082
            # TODO: conversions of Branch and Tree should be done by
1890
3083
            # InterXFormat lookups
1891
 
            if (isinstance(tree, workingtree_3.WorkingTree3) and
 
3084
            if (isinstance(tree, workingtree.WorkingTree3) and
1892
3085
                not isinstance(tree, workingtree_4.DirStateWorkingTree) and
1893
3086
                isinstance(self.target_format.workingtree_format,
1894
3087
                    workingtree_4.DirStateWorkingTreeFormat)):
1903
3096
                isinstance(self.target_format.workingtree_format,
1904
3097
                    workingtree_4.WorkingTreeFormat6)):
1905
3098
                workingtree_4.Converter4or5to6().convert(tree)
1906
 
        self.pb.finished()
1907
3099
        return to_convert
1908
3100
 
1909
3101
 
1910
 
controldir.ControlDirFormat.register_server_prober(RemoteBzrProber)
 
3102
# This is not in remote.py because it's relatively small, and needs to be
 
3103
# registered. Putting it in remote.py creates a circular import problem.
 
3104
# we can make it a lazy object if the control formats is turned into something
 
3105
# like a registry.
 
3106
class RemoteBzrDirFormat(BzrDirMetaFormat1):
 
3107
    """Format representing bzrdirs accessed via a smart server"""
 
3108
 
 
3109
    def __init__(self):
 
3110
        BzrDirMetaFormat1.__init__(self)
 
3111
        # XXX: It's a bit ugly that the network name is here, because we'd
 
3112
        # like to believe that format objects are stateless or at least
 
3113
        # immutable,  However, we do at least avoid mutating the name after
 
3114
        # it's returned.  See <https://bugs.edge.launchpad.net/bzr/+bug/504102>
 
3115
        self._network_name = None
 
3116
 
 
3117
    def __repr__(self):
 
3118
        return "%s(_network_name=%r)" % (self.__class__.__name__,
 
3119
            self._network_name)
 
3120
 
 
3121
    def get_format_description(self):
 
3122
        if self._network_name:
 
3123
            real_format = network_format_registry.get(self._network_name)
 
3124
            return 'Remote: ' + real_format.get_format_description()
 
3125
        return 'bzr remote bzrdir'
 
3126
 
 
3127
    def get_format_string(self):
 
3128
        raise NotImplementedError(self.get_format_string)
 
3129
 
 
3130
    def network_name(self):
 
3131
        if self._network_name:
 
3132
            return self._network_name
 
3133
        else:
 
3134
            raise AssertionError("No network name set.")
 
3135
 
 
3136
    @classmethod
 
3137
    def probe_transport(klass, transport):
 
3138
        """Return a RemoteBzrDirFormat object if it looks possible."""
 
3139
        try:
 
3140
            medium = transport.get_smart_medium()
 
3141
        except (NotImplementedError, AttributeError,
 
3142
                errors.TransportNotPossible, errors.NoSmartMedium,
 
3143
                errors.SmartProtocolError):
 
3144
            # no smart server, so not a branch for this format type.
 
3145
            raise errors.NotBranchError(path=transport.base)
 
3146
        else:
 
3147
            # Decline to open it if the server doesn't support our required
 
3148
            # version (3) so that the VFS-based transport will do it.
 
3149
            if medium.should_probe():
 
3150
                try:
 
3151
                    server_version = medium.protocol_version()
 
3152
                except errors.SmartProtocolError:
 
3153
                    # Apparently there's no usable smart server there, even though
 
3154
                    # the medium supports the smart protocol.
 
3155
                    raise errors.NotBranchError(path=transport.base)
 
3156
                if server_version != '2':
 
3157
                    raise errors.NotBranchError(path=transport.base)
 
3158
            return klass()
 
3159
 
 
3160
    def initialize_on_transport(self, transport):
 
3161
        try:
 
3162
            # hand off the request to the smart server
 
3163
            client_medium = transport.get_smart_medium()
 
3164
        except errors.NoSmartMedium:
 
3165
            # TODO: lookup the local format from a server hint.
 
3166
            local_dir_format = BzrDirMetaFormat1()
 
3167
            return local_dir_format.initialize_on_transport(transport)
 
3168
        client = _SmartClient(client_medium)
 
3169
        path = client.remote_path_from_transport(transport)
 
3170
        try:
 
3171
            response = client.call('BzrDirFormat.initialize', path)
 
3172
        except errors.ErrorFromSmartServer, err:
 
3173
            remote._translate_error(err, path=path)
 
3174
        if response[0] != 'ok':
 
3175
            raise errors.SmartProtocolError('unexpected response code %s' % (response,))
 
3176
        format = RemoteBzrDirFormat()
 
3177
        self._supply_sub_formats_to(format)
 
3178
        return remote.RemoteBzrDir(transport, format)
 
3179
 
 
3180
    def parse_NoneTrueFalse(self, arg):
 
3181
        if not arg:
 
3182
            return None
 
3183
        if arg == 'False':
 
3184
            return False
 
3185
        if arg == 'True':
 
3186
            return True
 
3187
        raise AssertionError("invalid arg %r" % arg)
 
3188
 
 
3189
    def _serialize_NoneTrueFalse(self, arg):
 
3190
        if arg is False:
 
3191
            return 'False'
 
3192
        if arg:
 
3193
            return 'True'
 
3194
        return ''
 
3195
 
 
3196
    def _serialize_NoneString(self, arg):
 
3197
        return arg or ''
 
3198
 
 
3199
    def initialize_on_transport_ex(self, transport, use_existing_dir=False,
 
3200
        create_prefix=False, force_new_repo=False, stacked_on=None,
 
3201
        stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
 
3202
        shared_repo=False):
 
3203
        try:
 
3204
            # hand off the request to the smart server
 
3205
            client_medium = transport.get_smart_medium()
 
3206
        except errors.NoSmartMedium:
 
3207
            do_vfs = True
 
3208
        else:
 
3209
            # Decline to open it if the server doesn't support our required
 
3210
            # version (3) so that the VFS-based transport will do it.
 
3211
            if client_medium.should_probe():
 
3212
                try:
 
3213
                    server_version = client_medium.protocol_version()
 
3214
                    if server_version != '2':
 
3215
                        do_vfs = True
 
3216
                    else:
 
3217
                        do_vfs = False
 
3218
                except errors.SmartProtocolError:
 
3219
                    # Apparently there's no usable smart server there, even though
 
3220
                    # the medium supports the smart protocol.
 
3221
                    do_vfs = True
 
3222
            else:
 
3223
                do_vfs = False
 
3224
        if not do_vfs:
 
3225
            client = _SmartClient(client_medium)
 
3226
            path = client.remote_path_from_transport(transport)
 
3227
            if client_medium._is_remote_before((1, 16)):
 
3228
                do_vfs = True
 
3229
        if do_vfs:
 
3230
            # TODO: lookup the local format from a server hint.
 
3231
            local_dir_format = BzrDirMetaFormat1()
 
3232
            self._supply_sub_formats_to(local_dir_format)
 
3233
            return local_dir_format.initialize_on_transport_ex(transport,
 
3234
                use_existing_dir=use_existing_dir, create_prefix=create_prefix,
 
3235
                force_new_repo=force_new_repo, stacked_on=stacked_on,
 
3236
                stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
 
3237
                make_working_trees=make_working_trees, shared_repo=shared_repo,
 
3238
                vfs_only=True)
 
3239
        return self._initialize_on_transport_ex_rpc(client, path, transport,
 
3240
            use_existing_dir, create_prefix, force_new_repo, stacked_on,
 
3241
            stack_on_pwd, repo_format_name, make_working_trees, shared_repo)
 
3242
 
 
3243
    def _initialize_on_transport_ex_rpc(self, client, path, transport,
 
3244
        use_existing_dir, create_prefix, force_new_repo, stacked_on,
 
3245
        stack_on_pwd, repo_format_name, make_working_trees, shared_repo):
 
3246
        args = []
 
3247
        args.append(self._serialize_NoneTrueFalse(use_existing_dir))
 
3248
        args.append(self._serialize_NoneTrueFalse(create_prefix))
 
3249
        args.append(self._serialize_NoneTrueFalse(force_new_repo))
 
3250
        args.append(self._serialize_NoneString(stacked_on))
 
3251
        # stack_on_pwd is often/usually our transport
 
3252
        if stack_on_pwd:
 
3253
            try:
 
3254
                stack_on_pwd = transport.relpath(stack_on_pwd)
 
3255
                if not stack_on_pwd:
 
3256
                    stack_on_pwd = '.'
 
3257
            except errors.PathNotChild:
 
3258
                pass
 
3259
        args.append(self._serialize_NoneString(stack_on_pwd))
 
3260
        args.append(self._serialize_NoneString(repo_format_name))
 
3261
        args.append(self._serialize_NoneTrueFalse(make_working_trees))
 
3262
        args.append(self._serialize_NoneTrueFalse(shared_repo))
 
3263
        request_network_name = self._network_name or \
 
3264
            BzrDirFormat.get_default_format().network_name()
 
3265
        try:
 
3266
            response = client.call('BzrDirFormat.initialize_ex_1.16',
 
3267
                request_network_name, path, *args)
 
3268
        except errors.UnknownSmartMethod:
 
3269
            client._medium._remember_remote_is_before((1,16))
 
3270
            local_dir_format = BzrDirMetaFormat1()
 
3271
            self._supply_sub_formats_to(local_dir_format)
 
3272
            return local_dir_format.initialize_on_transport_ex(transport,
 
3273
                use_existing_dir=use_existing_dir, create_prefix=create_prefix,
 
3274
                force_new_repo=force_new_repo, stacked_on=stacked_on,
 
3275
                stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
 
3276
                make_working_trees=make_working_trees, shared_repo=shared_repo,
 
3277
                vfs_only=True)
 
3278
        except errors.ErrorFromSmartServer, err:
 
3279
            remote._translate_error(err, path=path)
 
3280
        repo_path = response[0]
 
3281
        bzrdir_name = response[6]
 
3282
        require_stacking = response[7]
 
3283
        require_stacking = self.parse_NoneTrueFalse(require_stacking)
 
3284
        format = RemoteBzrDirFormat()
 
3285
        format._network_name = bzrdir_name
 
3286
        self._supply_sub_formats_to(format)
 
3287
        bzrdir = remote.RemoteBzrDir(transport, format, _client=client)
 
3288
        if repo_path:
 
3289
            repo_format = remote.response_tuple_to_repo_format(response[1:])
 
3290
            if repo_path == '.':
 
3291
                repo_path = ''
 
3292
            if repo_path:
 
3293
                repo_bzrdir_format = RemoteBzrDirFormat()
 
3294
                repo_bzrdir_format._network_name = response[5]
 
3295
                repo_bzr = remote.RemoteBzrDir(transport.clone(repo_path),
 
3296
                    repo_bzrdir_format)
 
3297
            else:
 
3298
                repo_bzr = bzrdir
 
3299
            final_stack = response[8] or None
 
3300
            final_stack_pwd = response[9] or None
 
3301
            if final_stack_pwd:
 
3302
                final_stack_pwd = urlutils.join(
 
3303
                    transport.base, final_stack_pwd)
 
3304
            remote_repo = remote.RemoteRepository(repo_bzr, repo_format)
 
3305
            if len(response) > 10:
 
3306
                # Updated server verb that locks remotely.
 
3307
                repo_lock_token = response[10] or None
 
3308
                remote_repo.lock_write(repo_lock_token, _skip_rpc=True)
 
3309
                if repo_lock_token:
 
3310
                    remote_repo.dont_leave_lock_in_place()
 
3311
            else:
 
3312
                remote_repo.lock_write()
 
3313
            policy = UseExistingRepository(remote_repo, final_stack,
 
3314
                final_stack_pwd, require_stacking)
 
3315
            policy.acquire_repository()
 
3316
        else:
 
3317
            remote_repo = None
 
3318
            policy = None
 
3319
        bzrdir._format.set_branch_format(self.get_branch_format())
 
3320
        if require_stacking:
 
3321
            # The repo has already been created, but we need to make sure that
 
3322
            # we'll make a stackable branch.
 
3323
            bzrdir._format.require_stacking(_skip_repo=True)
 
3324
        return remote_repo, bzrdir, require_stacking, policy
 
3325
 
 
3326
    def _open(self, transport):
 
3327
        return remote.RemoteBzrDir(transport, self)
 
3328
 
 
3329
    def __eq__(self, other):
 
3330
        if not isinstance(other, RemoteBzrDirFormat):
 
3331
            return False
 
3332
        return self.get_format_description() == other.get_format_description()
 
3333
 
 
3334
    def __return_repository_format(self):
 
3335
        # Always return a RemoteRepositoryFormat object, but if a specific bzr
 
3336
        # repository format has been asked for, tell the RemoteRepositoryFormat
 
3337
        # that it should use that for init() etc.
 
3338
        result = remote.RemoteRepositoryFormat()
 
3339
        custom_format = getattr(self, '_repository_format', None)
 
3340
        if custom_format:
 
3341
            if isinstance(custom_format, remote.RemoteRepositoryFormat):
 
3342
                return custom_format
 
3343
            else:
 
3344
                # We will use the custom format to create repositories over the
 
3345
                # wire; expose its details like rich_root_data for code to
 
3346
                # query
 
3347
                result._custom_format = custom_format
 
3348
        return result
 
3349
 
 
3350
    def get_branch_format(self):
 
3351
        result = BzrDirMetaFormat1.get_branch_format(self)
 
3352
        if not isinstance(result, remote.RemoteBranchFormat):
 
3353
            new_result = remote.RemoteBranchFormat()
 
3354
            new_result._custom_format = result
 
3355
            # cache the result
 
3356
            self.set_branch_format(new_result)
 
3357
            result = new_result
 
3358
        return result
 
3359
 
 
3360
    repository_format = property(__return_repository_format,
 
3361
        BzrDirMetaFormat1._set_repository_format) #.im_func)
 
3362
 
 
3363
 
 
3364
BzrDirFormat.register_control_server_format(RemoteBzrDirFormat)
 
3365
 
 
3366
 
 
3367
class BzrDirFormatInfo(object):
 
3368
 
 
3369
    def __init__(self, native, deprecated, hidden, experimental):
 
3370
        self.deprecated = deprecated
 
3371
        self.native = native
 
3372
        self.hidden = hidden
 
3373
        self.experimental = experimental
 
3374
 
 
3375
 
 
3376
class BzrDirFormatRegistry(registry.Registry):
 
3377
    """Registry of user-selectable BzrDir subformats.
 
3378
 
 
3379
    Differs from BzrDirFormat._control_formats in that it provides sub-formats,
 
3380
    e.g. BzrDirMeta1 with weave repository.  Also, it's more user-oriented.
 
3381
    """
 
3382
 
 
3383
    def __init__(self):
 
3384
        """Create a BzrDirFormatRegistry."""
 
3385
        self._aliases = set()
 
3386
        self._registration_order = list()
 
3387
        super(BzrDirFormatRegistry, self).__init__()
 
3388
 
 
3389
    def aliases(self):
 
3390
        """Return a set of the format names which are aliases."""
 
3391
        return frozenset(self._aliases)
 
3392
 
 
3393
    def register_metadir(self, key,
 
3394
             repository_format, help, native=True, deprecated=False,
 
3395
             branch_format=None,
 
3396
             tree_format=None,
 
3397
             hidden=False,
 
3398
             experimental=False,
 
3399
             alias=False):
 
3400
        """Register a metadir subformat.
 
3401
 
 
3402
        These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
 
3403
        by the Repository/Branch/WorkingTreeformats.
 
3404
 
 
3405
        :param repository_format: The fully-qualified repository format class
 
3406
            name as a string.
 
3407
        :param branch_format: Fully-qualified branch format class name as
 
3408
            a string.
 
3409
        :param tree_format: Fully-qualified tree format class name as
 
3410
            a string.
 
3411
        """
 
3412
        # This should be expanded to support setting WorkingTree and Branch
 
3413
        # formats, once BzrDirMetaFormat1 supports that.
 
3414
        def _load(full_name):
 
3415
            mod_name, factory_name = full_name.rsplit('.', 1)
 
3416
            try:
 
3417
                mod = __import__(mod_name, globals(), locals(),
 
3418
                        [factory_name])
 
3419
            except ImportError, e:
 
3420
                raise ImportError('failed to load %s: %s' % (full_name, e))
 
3421
            try:
 
3422
                factory = getattr(mod, factory_name)
 
3423
            except AttributeError:
 
3424
                raise AttributeError('no factory %s in module %r'
 
3425
                    % (full_name, mod))
 
3426
            return factory()
 
3427
 
 
3428
        def helper():
 
3429
            bd = BzrDirMetaFormat1()
 
3430
            if branch_format is not None:
 
3431
                bd.set_branch_format(_load(branch_format))
 
3432
            if tree_format is not None:
 
3433
                bd.workingtree_format = _load(tree_format)
 
3434
            if repository_format is not None:
 
3435
                bd.repository_format = _load(repository_format)
 
3436
            return bd
 
3437
        self.register(key, helper, help, native, deprecated, hidden,
 
3438
            experimental, alias)
 
3439
 
 
3440
    def register(self, key, factory, help, native=True, deprecated=False,
 
3441
                 hidden=False, experimental=False, alias=False):
 
3442
        """Register a BzrDirFormat factory.
 
3443
 
 
3444
        The factory must be a callable that takes one parameter: the key.
 
3445
        It must produce an instance of the BzrDirFormat when called.
 
3446
 
 
3447
        This function mainly exists to prevent the info object from being
 
3448
        supplied directly.
 
3449
        """
 
3450
        registry.Registry.register(self, key, factory, help,
 
3451
            BzrDirFormatInfo(native, deprecated, hidden, experimental))
 
3452
        if alias:
 
3453
            self._aliases.add(key)
 
3454
        self._registration_order.append(key)
 
3455
 
 
3456
    def register_lazy(self, key, module_name, member_name, help, native=True,
 
3457
        deprecated=False, hidden=False, experimental=False, alias=False):
 
3458
        registry.Registry.register_lazy(self, key, module_name, member_name,
 
3459
            help, BzrDirFormatInfo(native, deprecated, hidden, experimental))
 
3460
        if alias:
 
3461
            self._aliases.add(key)
 
3462
        self._registration_order.append(key)
 
3463
 
 
3464
    def set_default(self, key):
 
3465
        """Set the 'default' key to be a clone of the supplied key.
 
3466
 
 
3467
        This method must be called once and only once.
 
3468
        """
 
3469
        registry.Registry.register(self, 'default', self.get(key),
 
3470
            self.get_help(key), info=self.get_info(key))
 
3471
        self._aliases.add('default')
 
3472
 
 
3473
    def set_default_repository(self, key):
 
3474
        """Set the FormatRegistry default and Repository default.
 
3475
 
 
3476
        This is a transitional method while Repository.set_default_format
 
3477
        is deprecated.
 
3478
        """
 
3479
        if 'default' in self:
 
3480
            self.remove('default')
 
3481
        self.set_default(key)
 
3482
        format = self.get('default')()
 
3483
 
 
3484
    def make_bzrdir(self, key):
 
3485
        return self.get(key)()
 
3486
 
 
3487
    def help_topic(self, topic):
 
3488
        output = ""
 
3489
        default_realkey = None
 
3490
        default_help = self.get_help('default')
 
3491
        help_pairs = []
 
3492
        for key in self._registration_order:
 
3493
            if key == 'default':
 
3494
                continue
 
3495
            help = self.get_help(key)
 
3496
            if help == default_help:
 
3497
                default_realkey = key
 
3498
            else:
 
3499
                help_pairs.append((key, help))
 
3500
 
 
3501
        def wrapped(key, help, info):
 
3502
            if info.native:
 
3503
                help = '(native) ' + help
 
3504
            return ':%s:\n%s\n\n' % (key,
 
3505
                textwrap.fill(help, initial_indent='    ',
 
3506
                    subsequent_indent='    ',
 
3507
                    break_long_words=False))
 
3508
        if default_realkey is not None:
 
3509
            output += wrapped(default_realkey, '(default) %s' % default_help,
 
3510
                              self.get_info('default'))
 
3511
        deprecated_pairs = []
 
3512
        experimental_pairs = []
 
3513
        for key, help in help_pairs:
 
3514
            info = self.get_info(key)
 
3515
            if info.hidden:
 
3516
                continue
 
3517
            elif info.deprecated:
 
3518
                deprecated_pairs.append((key, help))
 
3519
            elif info.experimental:
 
3520
                experimental_pairs.append((key, help))
 
3521
            else:
 
3522
                output += wrapped(key, help, info)
 
3523
        output += "\nSee :doc:`formats-help` for more about storage formats."
 
3524
        other_output = ""
 
3525
        if len(experimental_pairs) > 0:
 
3526
            other_output += "Experimental formats are shown below.\n\n"
 
3527
            for key, help in experimental_pairs:
 
3528
                info = self.get_info(key)
 
3529
                other_output += wrapped(key, help, info)
 
3530
        else:
 
3531
            other_output += \
 
3532
                "No experimental formats are available.\n\n"
 
3533
        if len(deprecated_pairs) > 0:
 
3534
            other_output += "\nDeprecated formats are shown below.\n\n"
 
3535
            for key, help in deprecated_pairs:
 
3536
                info = self.get_info(key)
 
3537
                other_output += wrapped(key, help, info)
 
3538
        else:
 
3539
            other_output += \
 
3540
                "\nNo deprecated formats are available.\n\n"
 
3541
        other_output += \
 
3542
                "\nSee :doc:`formats-help` for more about storage formats."
 
3543
 
 
3544
        if topic == 'other-formats':
 
3545
            return other_output
 
3546
        else:
 
3547
            return output
1911
3548
 
1912
3549
 
1913
3550
class RepositoryAcquisitionPolicy(object):
1942
3579
            try:
1943
3580
                stack_on = urlutils.rebase_url(self._stack_on,
1944
3581
                    self._stack_on_pwd,
1945
 
                    branch.user_url)
 
3582
                    branch.bzrdir.root_transport.base)
1946
3583
            except errors.InvalidRebaseURLs:
1947
3584
                stack_on = self._get_full_stack_on()
1948
3585
        try:
1994
3631
 
1995
3632
        Implementations may create a new repository or use a pre-exising
1996
3633
        repository.
1997
 
 
1998
3634
        :param make_working_trees: If creating a repository, set
1999
3635
            make_working_trees to this value (if non-None)
2000
3636
        :param shared: If creating a repository, make it shared if True
2009
3645
 
2010
3646
    def __init__(self, bzrdir, stack_on=None, stack_on_pwd=None,
2011
3647
                 require_stacking=False):
2012
 
        """Constructor.
2013
 
 
 
3648
        """
 
3649
        Constructor.
2014
3650
        :param bzrdir: The bzrdir to create the repository on.
2015
3651
        :param stack_on: A location to stack on
2016
3652
        :param stack_on_pwd: If stack_on is relative, the location it is
2068
3704
        return self._repository, False
2069
3705
 
2070
3706
 
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',
 
3707
# Please register new formats after old formats so that formats
 
3708
# appear in chronological order and format descriptions can build
 
3709
# on previous ones.
 
3710
format_registry = BzrDirFormatRegistry()
 
3711
# The pre-0.8 formats have their repository format network name registered in
 
3712
# repository.py. MetaDir formats have their repository format network name
 
3713
# inferred from their disk format string.
 
3714
format_registry.register('weave', BzrDirFormat6,
 
3715
    'Pre-0.8 format.  Slower than knit and does not'
 
3716
    ' support checkouts or shared repositories.',
 
3717
    hidden=True,
 
3718
    deprecated=True)
 
3719
format_registry.register_metadir('metaweave',
 
3720
    'bzrlib.repofmt.weaverepo.RepositoryFormat7',
 
3721
    'Transitional format in 0.8.  Slower than knit.',
 
3722
    branch_format='bzrlib.branch.BzrBranchFormat5',
 
3723
    tree_format='bzrlib.workingtree.WorkingTreeFormat3',
 
3724
    hidden=True,
 
3725
    deprecated=True)
 
3726
format_registry.register_metadir('knit',
2116
3727
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2117
3728
    'Format using knits.  Recommended for interoperation with bzr <= 0.14.',
2118
3729
    branch_format='bzrlib.branch.BzrBranchFormat5',
2119
 
    tree_format='bzrlib.workingtree_3.WorkingTreeFormat3',
 
3730
    tree_format='bzrlib.workingtree.WorkingTreeFormat3',
2120
3731
    hidden=True,
2121
3732
    deprecated=True)
2122
 
register_metadir(controldir.format_registry, 'dirstate',
 
3733
format_registry.register_metadir('dirstate',
2123
3734
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2124
3735
    help='New in 0.15: Fast local operations. Compatible with bzr 0.8 and '
2125
3736
        'above when accessed over the network.',
2126
3737
    branch_format='bzrlib.branch.BzrBranchFormat5',
2127
 
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
3738
    # this uses bzrlib.workingtree.WorkingTreeFormat4 because importing
 
3739
    # directly from workingtree_4 triggers a circular import.
 
3740
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2128
3741
    hidden=True,
2129
3742
    deprecated=True)
2130
 
register_metadir(controldir.format_registry, 'dirstate-tags',
 
3743
format_registry.register_metadir('dirstate-tags',
2131
3744
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2132
3745
    help='New in 0.15: Fast local operations and improved scaling for '
2133
3746
        'network operations. Additionally adds support for tags.'
2134
3747
        ' Incompatible with bzr < 0.15.',
2135
3748
    branch_format='bzrlib.branch.BzrBranchFormat6',
2136
 
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
3749
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2137
3750
    hidden=True,
2138
3751
    deprecated=True)
2139
 
register_metadir(controldir.format_registry, 'rich-root',
 
3752
format_registry.register_metadir('rich-root',
2140
3753
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
2141
3754
    help='New in 1.0.  Better handling of tree roots.  Incompatible with'
2142
3755
        ' bzr < 1.0.',
2143
3756
    branch_format='bzrlib.branch.BzrBranchFormat6',
2144
 
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
3757
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2145
3758
    hidden=True,
2146
3759
    deprecated=True)
2147
 
register_metadir(controldir.format_registry, 'dirstate-with-subtree',
 
3760
format_registry.register_metadir('dirstate-with-subtree',
2148
3761
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
2149
3762
    help='New in 0.15: Fast local operations and improved scaling for '
2150
3763
        'network operations. Additionally adds support for versioning nested '
2151
3764
        'bzr branches. Incompatible with bzr < 0.15.',
2152
3765
    branch_format='bzrlib.branch.BzrBranchFormat6',
2153
 
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
3766
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2154
3767
    experimental=True,
2155
3768
    hidden=True,
2156
3769
    )
2157
 
register_metadir(controldir.format_registry, 'pack-0.92',
2158
 
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack1',
 
3770
format_registry.register_metadir('pack-0.92',
 
3771
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack1',
2159
3772
    help='New in 0.92: Pack-based format with data compatible with '
2160
3773
        'dirstate-tags format repositories. Interoperates with '
2161
3774
        'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
2162
 
        ,
 
3775
        'Previously called knitpack-experimental.  '
 
3776
        'For more information, see '
 
3777
        'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
2163
3778
    branch_format='bzrlib.branch.BzrBranchFormat6',
2164
 
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
3779
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2165
3780
    )
2166
 
register_metadir(controldir.format_registry, 'pack-0.92-subtree',
2167
 
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack3',
 
3781
format_registry.register_metadir('pack-0.92-subtree',
 
3782
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack3',
2168
3783
    help='New in 0.92: Pack-based format with data compatible with '
2169
3784
        'dirstate-with-subtree format repositories. Interoperates with '
2170
3785
        'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
2171
 
        ,
 
3786
        'Previously called knitpack-experimental.  '
 
3787
        'For more information, see '
 
3788
        'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
2172
3789
    branch_format='bzrlib.branch.BzrBranchFormat6',
2173
 
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
3790
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2174
3791
    hidden=True,
2175
3792
    experimental=True,
2176
3793
    )
2177
 
register_metadir(controldir.format_registry, 'rich-root-pack',
2178
 
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack4',
 
3794
format_registry.register_metadir('rich-root-pack',
 
3795
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
2179
3796
    help='New in 1.0: A variant of pack-0.92 that supports rich-root data '
2180
3797
         '(needed for bzr-svn and bzr-git).',
2181
3798
    branch_format='bzrlib.branch.BzrBranchFormat6',
2182
 
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
3799
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2183
3800
    hidden=True,
2184
3801
    )
2185
 
register_metadir(controldir.format_registry, '1.6',
2186
 
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack5',
 
3802
format_registry.register_metadir('1.6',
 
3803
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5',
2187
3804
    help='A format that allows a branch to indicate that there is another '
2188
3805
         '(stacked) repository that should be used to access data that is '
2189
3806
         'not present locally.',
2190
3807
    branch_format='bzrlib.branch.BzrBranchFormat7',
2191
 
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
3808
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2192
3809
    hidden=True,
2193
3810
    )
2194
 
register_metadir(controldir.format_registry, '1.6.1-rich-root',
2195
 
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack5RichRoot',
 
3811
format_registry.register_metadir('1.6.1-rich-root',
 
3812
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5RichRoot',
2196
3813
    help='A variant of 1.6 that supports rich-root data '
2197
3814
         '(needed for bzr-svn and bzr-git).',
2198
3815
    branch_format='bzrlib.branch.BzrBranchFormat7',
2199
 
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
3816
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2200
3817
    hidden=True,
2201
3818
    )
2202
 
register_metadir(controldir.format_registry, '1.9',
2203
 
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6',
 
3819
format_registry.register_metadir('1.9',
 
3820
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
2204
3821
    help='A repository format using B+tree indexes. These indexes '
2205
3822
         'are smaller in size, have smarter caching and provide faster '
2206
3823
         'performance for most operations.',
2207
3824
    branch_format='bzrlib.branch.BzrBranchFormat7',
2208
 
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
3825
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2209
3826
    hidden=True,
2210
3827
    )
2211
 
register_metadir(controldir.format_registry, '1.9-rich-root',
2212
 
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6RichRoot',
 
3828
format_registry.register_metadir('1.9-rich-root',
 
3829
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
2213
3830
    help='A variant of 1.9 that supports rich-root data '
2214
3831
         '(needed for bzr-svn and bzr-git).',
2215
3832
    branch_format='bzrlib.branch.BzrBranchFormat7',
2216
 
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
3833
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2217
3834
    hidden=True,
2218
3835
    )
2219
 
register_metadir(controldir.format_registry, '1.14',
2220
 
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6',
 
3836
format_registry.register_metadir('1.14',
 
3837
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
2221
3838
    help='A working-tree format that supports content filtering.',
2222
3839
    branch_format='bzrlib.branch.BzrBranchFormat7',
2223
 
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat5',
 
3840
    tree_format='bzrlib.workingtree.WorkingTreeFormat5',
2224
3841
    )
2225
 
register_metadir(controldir.format_registry, '1.14-rich-root',
2226
 
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6RichRoot',
 
3842
format_registry.register_metadir('1.14-rich-root',
 
3843
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
2227
3844
    help='A variant of 1.14 that supports rich-root data '
2228
3845
         '(needed for bzr-svn and bzr-git).',
2229
3846
    branch_format='bzrlib.branch.BzrBranchFormat7',
2230
 
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat5',
 
3847
    tree_format='bzrlib.workingtree.WorkingTreeFormat5',
2231
3848
    )
2232
3849
# 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',
 
3850
format_registry.register_metadir('development-rich-root',
 
3851
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
 
3852
    help='Current development format. Supports rich roots. Can convert data '
 
3853
        'to and from rich-root-pack (and anything compatible with '
 
3854
        'rich-root-pack) format repositories. Repositories and branches in '
 
3855
        'this format can only be read by bzr.dev. Please read '
 
3856
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
 
3857
        'before use.',
 
3858
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
3859
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
 
3860
    experimental=True,
 
3861
    alias=True,
 
3862
    hidden=True,
 
3863
    )
 
3864
format_registry.register_metadir('development-subtree',
 
3865
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment2Subtree',
2235
3866
    help='Current development format, subtree variant. Can convert data to and '
2236
3867
        'from pack-0.92-subtree (and anything compatible with '
2237
3868
        'pack-0.92-subtree) format repositories. Repositories and branches in '
2238
3869
        'this format can only be read by bzr.dev. Please read '
2239
 
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
 
3870
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
2240
3871
        'before use.',
2241
3872
    branch_format='bzrlib.branch.BzrBranchFormat7',
2242
 
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
 
3873
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
2243
3874
    experimental=True,
2244
3875
    hidden=True,
2245
3876
    alias=False, # Restore to being an alias when an actual development subtree format is added
2246
3877
                 # This current non-alias status is simply because we did not introduce a
2247
3878
                 # chk based subtree format.
2248
3879
    )
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
3880
 
2264
3881
# 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',
 
3882
format_registry.register_metadir('development6-rich-root',
 
3883
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
 
3884
    help='pack-1.9 with 255-way hashed CHK inv, group compress, rich roots '
 
3885
        'Please read '
 
3886
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
 
3887
        'before use.',
 
3888
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
3889
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
 
3890
    hidden=True,
 
3891
    experimental=True,
 
3892
    )
 
3893
 
 
3894
format_registry.register_metadir('development7-rich-root',
 
3895
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK2',
 
3896
    help='pack-1.9 with 255-way hashed CHK inv, bencode revision, group compress, '
 
3897
        'rich roots. Please read '
 
3898
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
 
3899
        'before use.',
 
3900
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
3901
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
 
3902
    hidden=True,
 
3903
    experimental=True,
 
3904
    )
 
3905
 
 
3906
format_registry.register_metadir('2a',
2268
3907
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
2269
3908
    help='First format for bzr 2.0 series.\n'
2270
3909
        'Uses group-compress storage.\n'
2272
3911
        # 'storage in packs, 255-way hashed CHK inventory, bencode revision, group compress, '
2273
3912
        # 'rich roots. Supported by bzr 1.16 and later.',
2274
3913
    branch_format='bzrlib.branch.BzrBranchFormat7',
2275
 
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
2276
 
    experimental=False,
 
3914
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
 
3915
    experimental=True,
2277
3916
    )
2278
3917
 
2279
3918
# The following format should be an alias for the rich root equivalent 
2280
3919
# of the default format
2281
 
register_metadir(controldir.format_registry, 'default-rich-root',
 
3920
format_registry.register_metadir('default-rich-root',
2282
3921
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
2283
3922
    branch_format='bzrlib.branch.BzrBranchFormat7',
2284
 
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
 
3923
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
2285
3924
    alias=True,
2286
3925
    hidden=True,
2287
3926
    help='Same as 2a.')
2288
3927
 
2289
3928
# The current format that is made on 'bzr init'.
2290
 
format_name = config.GlobalStack().get('default_format')
2291
 
controldir.format_registry.set_default(format_name)
2292
 
 
2293
 
# XXX 2010-08-20 JRV: There is still a lot of code relying on
2294
 
# bzrlib.bzrdir.format_registry existing. When BzrDir.create/BzrDir.open/etc
2295
 
# get changed to ControlDir.create/ControlDir.open/etc this should be removed.
2296
 
format_registry = controldir.format_registry
 
3929
format_registry.set_default('2a')