← 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: 2009-05-04 14:48:21 UTC
  • mto: (4349.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 4350.
  • Revision ID: v.ladeuil+lp@free.fr-20090504144821-39dvqkikmd3zqkdg
Handle servers proposing several authentication schemes.

* bzrlib/transport/http/_urllib2_wrappers.py:
(AbstractAuthHandler.auth_required): Several schemes can be
proposed by the server, try to match each one in turn.
(BasicAuthHandler.auth_match): Delete dead code.

* bzrlib/tests/test_http.py:
(load_tests): Separate proxy and http authentication tests as they
require different server setups.
(TestAuth.create_transport_readonly_server): Simplified by using
parameter provided by load_tests.
(TestAuth.test_changing_nonce): Adapt to new parametrization.
(TestProxyAuth.create_transport_readonly_server): Deleted.

* bzrlib/tests/http_utils.py:
(DigestAndBasicAuthRequestHandler, HTTPBasicAndDigestAuthServer,
ProxyBasicAndDigestAuthServer): Add a test server proposing both
basic and digest auth schemes but accepting only digest as valid.

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, 2006, 2007, 2008, 2009 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,
 
73
    remote as remote_transport,
57
74
    )
 
75
from bzrlib.weave import Weave
58
76
""")
59
77
 
60
78
from bzrlib.trace import (
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
 
        """Check that a bzrdir as a whole can be converted to a new format."""
116
 
        # The only current restriction is that the repository content can be 
117
 
        # fetched compatibly with the target.
118
132
        target_repo_format = target_format.repository_format
119
 
        try:
120
 
            self.open_repository()._format.check_conversion_target(
121
 
                target_repo_format)
122
 
        except errors.NoRepositoryPresent:
123
 
            # No repo, no problem.
124
 
            pass
 
133
        source_repo_format = self._format.repository_format
 
134
        source_repo_format.check_conversion_target(target_repo_format)
 
135
 
 
136
    @staticmethod
 
137
    def _check_supported(format, allow_unsupported,
 
138
        recommend_upgrade=True,
 
139
        basedir=None):
 
140
        """Give an error or warning on old formats.
 
141
 
 
142
        :param format: may be any kind of format - workingtree, branch,
 
143
        or repository.
 
144
 
 
145
        :param allow_unsupported: If true, allow opening
 
146
        formats that are strongly deprecated, and which may
 
147
        have limited functionality.
 
148
 
 
149
        :param recommend_upgrade: If true (default), warn
 
150
        the user through the ui object that they may wish
 
151
        to upgrade the object.
 
152
        """
 
153
        # TODO: perhaps move this into a base Format class; it's not BzrDir
 
154
        # specific. mbp 20070323
 
155
        if not allow_unsupported and not format.is_supported():
 
156
            # see open_downlevel to open legacy branches.
 
157
            raise errors.UnsupportedFormatError(format=format)
 
158
        if recommend_upgrade \
 
159
            and getattr(format, 'upgrade_recommended', False):
 
160
            ui.ui_factory.recommend_upgrade(
 
161
                format.get_format_description(),
 
162
                basedir)
 
163
 
 
164
    def clone(self, url, revision_id=None, force_new_repo=False,
 
165
              preserve_stacking=False):
 
166
        """Clone this bzrdir and its contents to url verbatim.
 
167
 
 
168
        :param url: The url create the clone at.  If url's last component does
 
169
            not exist, it will be created.
 
170
        :param revision_id: The tip revision-id to use for any branch or
 
171
            working tree.  If not None, then the clone operation may tune
 
172
            itself to download less data.
 
173
        :param force_new_repo: Do not use a shared repository for the target
 
174
                               even if one is available.
 
175
        :param preserve_stacking: When cloning a stacked branch, stack the
 
176
            new branch on top of the other branch's stacked-on branch.
 
177
        """
 
178
        return self.clone_on_transport(get_transport(url),
 
179
                                       revision_id=revision_id,
 
180
                                       force_new_repo=force_new_repo,
 
181
                                       preserve_stacking=preserve_stacking)
125
182
 
126
183
    def clone_on_transport(self, transport, revision_id=None,
127
184
        force_new_repo=False, preserve_stacking=False, stacked_on=None,
128
 
        create_prefix=False, use_existing_dir=True, no_tree=False):
 
185
        create_prefix=False, use_existing_dir=True):
129
186
        """Clone this bzrdir and its contents to transport verbatim.
130
187
 
131
188
        :param transport: The transport for the location to produce the clone
140
197
        :param create_prefix: Create any missing directories leading up to
141
198
            to_transport.
142
199
        :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
200
        """
145
201
        # Overview: put together a broad description of what we want to end up
146
202
        # with; then make as few api calls as possible to do it.
147
 
 
 
203
        
148
204
        # We may want to create a repo/branch/tree, if we do so what format
149
205
        # would we want for each:
150
206
        require_stacking = (stacked_on is not None)
151
207
        format = self.cloning_metadir(require_stacking)
152
 
 
 
208
        
153
209
        # Figure out what objects we want:
154
210
        try:
155
211
            local_repo = self.find_repository()
174
230
        # we should look up the policy needs first, or just use it as a hint,
175
231
        # or something.
176
232
        if local_repo:
177
 
            make_working_trees = local_repo.make_working_trees() and not no_tree
 
233
            make_working_trees = local_repo.make_working_trees()
178
234
            want_shared = local_repo.is_shared()
179
235
            repo_format_name = format.repository_format.network_name()
180
236
        else:
190
246
            repo_format_name=repo_format_name,
191
247
            make_working_trees=make_working_trees, shared_repo=want_shared)
192
248
        if repo_format_name:
193
 
            try:
194
 
                # If the result repository is in the same place as the
195
 
                # resulting bzr dir, it will have no content, further if the
196
 
                # result is not stacked then we know all content should be
197
 
                # copied, and finally if we are copying up to a specific
198
 
                # revision_id then we can use the pending-ancestry-result which
199
 
                # 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
202
 
                    revision_id is not None):
203
 
                    fetch_spec = graph.PendingAncestryResult(
204
 
                        [revision_id], local_repo)
205
 
                    result_repo.fetch(local_repo, fetch_spec=fetch_spec)
206
 
                else:
207
 
                    result_repo.fetch(local_repo, revision_id=revision_id)
208
 
            finally:
209
 
                result_repo.unlock()
 
249
            # If the result repository is in the same place as the resulting
 
250
            # bzr dir, it will have no content, further if the result is not stacked
 
251
            # then we know all content should be copied, and finally if we are
 
252
            # copying up to a specific revision_id then we can use the
 
253
            # pending-ancestry-result which does not require traversing all of
 
254
            # history to describe it.
 
255
            if (result_repo.bzrdir.root_transport.base ==
 
256
                result.root_transport.base and not require_stacking and
 
257
                revision_id is not None):
 
258
                fetch_spec = graph.PendingAncestryResult(
 
259
                    [revision_id], local_repo)
 
260
                result_repo.fetch(local_repo, fetch_spec=fetch_spec)
 
261
            else:
 
262
                result_repo.fetch(local_repo, revision_id=revision_id)
210
263
        else:
211
 
            if result_repo is not None:
212
 
                raise AssertionError('result_repo not None(%r)' % result_repo)
 
264
            result_repo = None
213
265
        # 1 if there is a branch present
214
266
        #   make sure its content is available in the target repository
215
267
        #   clone it.
229
281
    # TODO: This should be given a Transport, and should chdir up; otherwise
230
282
    # this will open a new connection.
231
283
    def _make_tail(self, url):
232
 
        t = _mod_transport.get_transport(url)
233
 
        t.ensure_base()
 
284
        t = get_transport(url)
 
285
        t.ensure_base()
 
286
 
 
287
    @classmethod
 
288
    def create(cls, base, format=None, possible_transports=None):
 
289
        """Create a new BzrDir at the url 'base'.
 
290
 
 
291
        :param format: If supplied, the format of branch to create.  If not
 
292
            supplied, the default is used.
 
293
        :param possible_transports: If supplied, a list of transports that
 
294
            can be reused to share a remote connection.
 
295
        """
 
296
        if cls is not BzrDir:
 
297
            raise AssertionError("BzrDir.create always creates the default"
 
298
                " format, not one of %r" % cls)
 
299
        t = get_transport(base, possible_transports)
 
300
        t.ensure_base()
 
301
        if format is None:
 
302
            format = BzrDirFormat.get_default_format()
 
303
        return format.initialize_on_transport(t)
234
304
 
235
305
    @staticmethod
236
306
    def find_bzrdirs(transport, evaluate=None, list_current=None):
239
309
        This is intended primarily as a building block for more sophisticated
240
310
        functionality, like finding trees under a directory, or finding
241
311
        branches that use a given repository.
242
 
 
243
312
        :param evaluate: An optional callable that yields recurse, value,
244
313
            where recurse controls whether this bzrdir is recursed into
245
314
            and value is the value to yield.  By default, all bzrdirs
261
330
            recurse = True
262
331
            try:
263
332
                bzrdir = BzrDir.open_from_transport(current_transport)
264
 
            except (errors.NotBranchError, errors.PermissionDenied):
 
333
            except errors.NotBranchError:
265
334
                pass
266
335
            else:
267
336
                recurse, value = evaluate(bzrdir)
268
337
                yield value
269
338
            try:
270
339
                subdirs = list_current(current_transport)
271
 
            except (errors.NoSuchFile, errors.PermissionDenied):
 
340
            except errors.NoSuchFile:
272
341
                continue
273
342
            if recurse:
274
343
                for subdir in sorted(subdirs, reverse=True):
291
360
            except errors.NoRepositoryPresent:
292
361
                pass
293
362
            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):
 
363
                return False, (None, repository)
 
364
            try:
 
365
                branch = bzrdir.open_branch()
 
366
            except errors.NotBranchError:
 
367
                return True, (None, None)
 
368
            else:
 
369
                return True, (branch, None)
 
370
        branches = []
 
371
        for branch, repo in BzrDir.find_bzrdirs(transport, evaluate=evaluate):
299
372
            if repo is not None:
300
 
                ret.extend(repo.find_branches())
301
 
            if branches is not None:
302
 
                ret.extend(branches)
303
 
        return ret
 
373
                branches.extend(repo.find_branches())
 
374
            if branch is not None:
 
375
                branches.append(branch)
 
376
        return branches
 
377
 
 
378
    def destroy_repository(self):
 
379
        """Destroy the repository in this BzrDir"""
 
380
        raise NotImplementedError(self.destroy_repository)
 
381
 
 
382
    def create_branch(self):
 
383
        """Create a branch in this BzrDir.
 
384
 
 
385
        The bzrdir's format will control what branch format is created.
 
386
        For more control see BranchFormatXX.create(a_bzrdir).
 
387
        """
 
388
        raise NotImplementedError(self.create_branch)
 
389
 
 
390
    def destroy_branch(self):
 
391
        """Destroy the branch in this BzrDir"""
 
392
        raise NotImplementedError(self.destroy_branch)
304
393
 
305
394
    @staticmethod
306
395
    def create_branch_and_repo(base, force_new_repo=False, format=None):
345
434
            stop = False
346
435
            stack_on = config.get_default_stack_on()
347
436
            if stack_on is not None:
348
 
                stack_on_pwd = found_bzrdir.user_url
 
437
                stack_on_pwd = found_bzrdir.root_transport.base
349
438
                stop = True
350
439
            # does it have a repository ?
351
440
            try:
353
442
            except errors.NoRepositoryPresent:
354
443
                repository = None
355
444
            else:
356
 
                if (found_bzrdir.user_url != self.user_url 
357
 
                    and not repository.is_shared()):
 
445
                if ((found_bzrdir.root_transport.base !=
 
446
                     self.root_transport.base) and not repository.is_shared()):
358
447
                    # Don't look higher, can't use a higher shared repo.
359
448
                    repository = None
360
449
                    stop = True
389
478
        policy = self.determine_repository_policy(force_new_repo)
390
479
        return policy.acquire_repository()[0]
391
480
 
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
481
    @staticmethod
549
482
    def create_branch_convenience(base, force_new_repo=False,
550
483
                                  force_new_tree=None, format=None,
576
509
        """
577
510
        if force_new_tree:
578
511
            # check for non local urls
579
 
            t = _mod_transport.get_transport(base, possible_transports)
 
512
            t = get_transport(base, possible_transports)
580
513
            if not isinstance(t, local.LocalTransport):
581
514
                raise errors.NotLocalUrl(base)
582
515
        bzrdir = BzrDir.create(base, format, possible_transports)
604
537
        :param format: Override for the bzrdir format to create.
605
538
        :return: The WorkingTree object.
606
539
        """
607
 
        t = _mod_transport.get_transport(base)
 
540
        t = get_transport(base)
608
541
        if not isinstance(t, local.LocalTransport):
609
542
            raise errors.NotLocalUrl(base)
610
543
        bzrdir = BzrDir.create_branch_and_repo(base,
612
545
                                               format=format).bzrdir
613
546
        return bzrdir.create_workingtree()
614
547
 
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.
 
548
    def create_workingtree(self, revision_id=None, from_branch=None,
 
549
        accelerator_tree=None, hardlink=False):
 
550
        """Create a working tree at this BzrDir.
 
551
 
 
552
        :param revision_id: create it as of this revision id.
 
553
        :param from_branch: override bzrdir branch (for lightweight checkouts)
 
554
        :param accelerator_tree: A tree which can be used for retrieving file
 
555
            contents more quickly than the revision tree, i.e. a workingtree.
 
556
            The revision tree will be used for cases where accelerator_tree's
 
557
            content is different.
623
558
        """
624
 
        return osutils.available_backup_name(base, self.root_transport.has)
 
559
        raise NotImplementedError(self.create_workingtree)
625
560
 
626
561
    def backup_bzrdir(self):
627
562
        """Backup this bzr control directory.
628
563
 
629
564
        :return: Tuple with old path name and new path name
630
565
        """
631
 
 
632
566
        pb = ui.ui_factory.nested_progress_bar()
633
567
        try:
 
568
            # FIXME: bug 300001 -- the backup fails if the backup directory
 
569
            # already exists, but it should instead either remove it or make
 
570
            # a new backup directory.
 
571
            #
 
572
            # FIXME: bug 262450 -- the backup directory should have the same
 
573
            # permissions as the .bzr directory (probably a bug in copy_tree)
634
574
            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)
 
575
            new_path = self.root_transport.abspath('backup.bzr')
 
576
            pb.note('making backup of %s' % (old_path,))
 
577
            pb.note('  to %s' % (new_path,))
 
578
            self.root_transport.copy_tree('.bzr', 'backup.bzr')
640
579
            return (old_path, new_path)
641
580
        finally:
642
581
            pb.finished()
666
605
                else:
667
606
                    pass
668
607
 
 
608
    def destroy_workingtree(self):
 
609
        """Destroy the working tree at this BzrDir.
 
610
 
 
611
        Formats that do not support this may raise UnsupportedOperation.
 
612
        """
 
613
        raise NotImplementedError(self.destroy_workingtree)
 
614
 
 
615
    def destroy_workingtree_metadata(self):
 
616
        """Destroy the control files for the working tree at this BzrDir.
 
617
 
 
618
        The contents of working tree files are not affected.
 
619
        Formats that do not support this may raise UnsupportedOperation.
 
620
        """
 
621
        raise NotImplementedError(self.destroy_workingtree_metadata)
 
622
 
669
623
    def _find_containing(self, evaluate):
670
624
        """Find something in a containing control directory.
671
625
 
685
639
            if stop:
686
640
                return result
687
641
            next_transport = found_bzrdir.root_transport.clone('..')
688
 
            if (found_bzrdir.user_url == next_transport.base):
 
642
            if (found_bzrdir.root_transport.base == next_transport.base):
689
643
                # top of the file system
690
644
                return None
691
645
            # find the next containing bzrdir
708
662
                repository = found_bzrdir.open_repository()
709
663
            except errors.NoRepositoryPresent:
710
664
                return None, False
711
 
            if found_bzrdir.user_url == self.user_url:
 
665
            if found_bzrdir.root_transport.base == self.root_transport.base:
712
666
                return repository, True
713
667
            elif repository.is_shared():
714
668
                return repository, True
720
674
            raise errors.NoRepositoryPresent(self)
721
675
        return found_repo
722
676
 
 
677
    def get_branch_reference(self):
 
678
        """Return the referenced URL for the branch in this bzrdir.
 
679
 
 
680
        :raises NotBranchError: If there is no Branch.
 
681
        :return: The URL the branch in this bzrdir references if it is a
 
682
            reference branch, or None for regular branches.
 
683
        """
 
684
        return None
 
685
 
 
686
    def get_branch_transport(self, branch_format):
 
687
        """Get the transport for use by branch format in this BzrDir.
 
688
 
 
689
        Note that bzr dirs that do not support format strings will raise
 
690
        IncompatibleFormat if the branch format they are given has
 
691
        a format string, and vice versa.
 
692
 
 
693
        If branch_format is None, the transport is returned with no
 
694
        checking. If it is not None, then the returned transport is
 
695
        guaranteed to point to an existing directory ready for use.
 
696
        """
 
697
        raise NotImplementedError(self.get_branch_transport)
 
698
 
723
699
    def _find_creation_modes(self):
724
700
        """Determine the appropriate modes for files and directories.
725
701
 
764
740
            self._find_creation_modes()
765
741
        return self._dir_mode
766
742
 
 
743
    def get_repository_transport(self, repository_format):
 
744
        """Get the transport for use by repository format in this BzrDir.
 
745
 
 
746
        Note that bzr dirs that do not support format strings will raise
 
747
        IncompatibleFormat if the repository format they are given has
 
748
        a format string, and vice versa.
 
749
 
 
750
        If repository_format is None, the transport is returned with no
 
751
        checking. If it is not None, then the returned transport is
 
752
        guaranteed to point to an existing directory ready for use.
 
753
        """
 
754
        raise NotImplementedError(self.get_repository_transport)
 
755
 
 
756
    def get_workingtree_transport(self, tree_format):
 
757
        """Get the transport for use by workingtree format in this BzrDir.
 
758
 
 
759
        Note that bzr dirs that do not support format strings will raise
 
760
        IncompatibleFormat if the workingtree format they are given has a
 
761
        format string, and vice versa.
 
762
 
 
763
        If workingtree_format is None, the transport is returned with no
 
764
        checking. If it is not None, then the returned transport is
 
765
        guaranteed to point to an existing directory ready for use.
 
766
        """
 
767
        raise NotImplementedError(self.get_workingtree_transport)
 
768
 
767
769
    def get_config(self):
768
770
        """Get configuration for this BzrDir."""
769
771
        return config.BzrDirConfig(self)
782
784
        :param _transport: the transport this dir is based at.
783
785
        """
784
786
        self._format = _format
785
 
        # these are also under the more standard names of 
786
 
        # control_transport and user_transport
787
787
        self.transport = _transport.clone('.bzr')
788
788
        self.root_transport = _transport
789
789
        self._mode_check_done = False
790
790
 
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
791
    def is_control_filename(self, filename):
800
792
        """True if filename is the name of a path which is reserved for bzrdir's.
801
793
 
803
795
 
804
796
        This is true IF and ONLY IF the filename is part of the namespace reserved
805
797
        for bzr control dirs. Currently this is the '.bzr' directory in the root
806
 
        of the root_transport. 
 
798
        of the root_transport. it is expected that plugins will need to extend
 
799
        this in the future - for instance to make bzr talk with svn working
 
800
        trees.
807
801
        """
808
802
        # this might be better on the BzrDirFormat class because it refers to
809
803
        # all the possible bzrdir disk formats.
813
807
        # add new tests for it to the appropriate place.
814
808
        return filename == '.bzr' or filename.startswith('.bzr/')
815
809
 
 
810
    def needs_format_conversion(self, format=None):
 
811
        """Return true if this bzrdir needs convert_format run on it.
 
812
 
 
813
        For instance, if the repository format is out of date but the
 
814
        branch and working tree are not, this should return True.
 
815
 
 
816
        :param format: Optional parameter indicating a specific desired
 
817
                       format we plan to arrive at.
 
818
        """
 
819
        raise NotImplementedError(self.needs_format_conversion)
 
820
 
816
821
    @staticmethod
817
822
    def open_unsupported(base):
818
823
        """Open a branch which is not supported."""
824
829
 
825
830
        :param _unsupported: a private parameter to the BzrDir class.
826
831
        """
827
 
        t = _mod_transport.get_transport(base, possible_transports)
 
832
        t = get_transport(base, possible_transports=possible_transports)
828
833
        return BzrDir.open_from_transport(t, _unsupported=_unsupported)
829
834
 
830
835
    @staticmethod
841
846
        # the redirections.
842
847
        base = transport.base
843
848
        def find_format(transport):
844
 
            return transport, controldir.ControlDirFormat.find_format(
 
849
            return transport, BzrDirFormat.find_format(
845
850
                transport, _server_formats=_server_formats)
846
851
 
847
852
        def redirected(transport, e, redirection_notice):
859
864
        except errors.TooManyRedirections:
860
865
            raise errors.NotBranchError(base)
861
866
 
862
 
        format.check_support_status(_unsupported)
 
867
        BzrDir._check_supported(format, _unsupported)
863
868
        return format.open(transport, _found=True)
864
869
 
 
870
    def open_branch(self, unsupported=False, ignore_fallbacks=False):
 
871
        """Open the branch object at this BzrDir if one is present.
 
872
 
 
873
        If unsupported is True, then no longer supported branch formats can
 
874
        still be opened.
 
875
 
 
876
        TODO: static convenience version of this?
 
877
        """
 
878
        raise NotImplementedError(self.open_branch)
 
879
 
865
880
    @staticmethod
866
881
    def open_containing(url, possible_transports=None):
867
882
        """Open an existing branch which contains url.
868
883
 
869
884
        :param url: url to search from.
870
 
 
871
885
        See open_containing_from_transport for more detail.
872
886
        """
873
 
        transport = _mod_transport.get_transport(url, possible_transports)
 
887
        transport = get_transport(url, possible_transports)
874
888
        return BzrDir.open_containing_from_transport(transport)
875
889
 
876
890
    @staticmethod
906
920
                raise errors.NotBranchError(path=url)
907
921
            a_transport = new_t
908
922
 
 
923
    def _get_tree_branch(self):
 
924
        """Return the branch and tree, if any, for this bzrdir.
 
925
 
 
926
        Return None for tree if not present or inaccessible.
 
927
        Raise NotBranchError if no branch is present.
 
928
        :return: (tree, branch)
 
929
        """
 
930
        try:
 
931
            tree = self.open_workingtree()
 
932
        except (errors.NoWorkingTree, errors.NotLocalUrl):
 
933
            tree = None
 
934
            branch = self.open_branch()
 
935
        else:
 
936
            branch = tree.branch
 
937
        return tree, branch
 
938
 
909
939
    @classmethod
910
940
    def open_tree_or_branch(klass, location):
911
941
        """Return the branch and working tree at a location.
957
987
                raise errors.NotBranchError(location)
958
988
        return tree, branch, branch.repository, relpath
959
989
 
 
990
    def open_repository(self, _unsupported=False):
 
991
        """Open the repository object at this BzrDir if one is present.
 
992
 
 
993
        This will not follow the Branch object pointer - it's strictly a direct
 
994
        open facility. Most client code should use open_branch().repository to
 
995
        get at a repository.
 
996
 
 
997
        :param _unsupported: a private parameter, not part of the api.
 
998
        TODO: static convenience version of this?
 
999
        """
 
1000
        raise NotImplementedError(self.open_repository)
 
1001
 
 
1002
    def open_workingtree(self, _unsupported=False,
 
1003
                         recommend_upgrade=True, from_branch=None):
 
1004
        """Open the workingtree object at this BzrDir if one is present.
 
1005
 
 
1006
        :param recommend_upgrade: Optional keyword parameter, when True (the
 
1007
            default), emit through the ui module a recommendation that the user
 
1008
            upgrade the working tree when the workingtree being opened is old
 
1009
            (but still fully supported).
 
1010
        :param from_branch: override bzrdir branch (for lightweight checkouts)
 
1011
        """
 
1012
        raise NotImplementedError(self.open_workingtree)
 
1013
 
 
1014
    def has_branch(self):
 
1015
        """Tell if this bzrdir contains a branch.
 
1016
 
 
1017
        Note: if you're going to open the branch, you should just go ahead
 
1018
        and try, and not ask permission first.  (This method just opens the
 
1019
        branch and discards it, and that's somewhat expensive.)
 
1020
        """
 
1021
        try:
 
1022
            self.open_branch()
 
1023
            return True
 
1024
        except errors.NotBranchError:
 
1025
            return False
 
1026
 
 
1027
    def has_workingtree(self):
 
1028
        """Tell if this bzrdir contains a working tree.
 
1029
 
 
1030
        This will still raise an exception if the bzrdir has a workingtree that
 
1031
        is remote & inaccessible.
 
1032
 
 
1033
        Note: if you're going to open the working tree, you should just go ahead
 
1034
        and try, and not ask permission first.  (This method just opens the
 
1035
        workingtree and discards it, and that's somewhat expensive.)
 
1036
        """
 
1037
        try:
 
1038
            self.open_workingtree(recommend_upgrade=False)
 
1039
            return True
 
1040
        except errors.NoWorkingTree:
 
1041
            return False
 
1042
 
960
1043
    def _cloning_metadir(self):
961
1044
        """Produce a metadir suitable for cloning with.
962
1045
 
1020
1103
            format.require_stacking()
1021
1104
        return format
1022
1105
 
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)
 
1106
    def checkout_metadir(self):
 
1107
        return self.cloning_metadir()
 
1108
 
 
1109
    def sprout(self, url, revision_id=None, force_new_repo=False,
 
1110
               recurse='down', possible_transports=None,
 
1111
               accelerator_tree=None, hardlink=False, stacked=False,
 
1112
               source_branch=None, create_tree_if_local=True):
 
1113
        """Create a copy of this bzrdir prepared for use as a new line of
 
1114
        development.
 
1115
 
 
1116
        If url's last component does not exist, it will be created.
 
1117
 
 
1118
        Attributes related to the identity of the source branch like
 
1119
        branch nickname will be cleaned, a working tree is created
 
1120
        whether one existed before or not; and a local branch is always
 
1121
        created.
 
1122
 
 
1123
        if revision_id is not None, then the clone operation may tune
 
1124
            itself to download less data.
 
1125
        :param accelerator_tree: A tree which can be used for retrieving file
 
1126
            contents more quickly than the revision tree, i.e. a workingtree.
 
1127
            The revision tree will be used for cases where accelerator_tree's
 
1128
            content is different.
 
1129
        :param hardlink: If true, hard-link files from accelerator_tree,
 
1130
            where possible.
 
1131
        :param stacked: If true, create a stacked branch referring to the
 
1132
            location of this control directory.
 
1133
        :param create_tree_if_local: If true, a working-tree will be created
 
1134
            when working locally.
 
1135
        """
 
1136
        target_transport = get_transport(url, possible_transports)
 
1137
        target_transport.ensure_base()
 
1138
        cloning_format = self.cloning_metadir(stacked)
 
1139
        # Create/update the result branch
 
1140
        result = cloning_format.initialize_on_transport(target_transport)
 
1141
        # if a stacked branch wasn't requested, we don't create one
 
1142
        # even if the origin was stacked
 
1143
        stacked_branch_url = None
 
1144
        if source_branch is not None:
 
1145
            if stacked:
 
1146
                stacked_branch_url = self.root_transport.base
 
1147
            source_repository = source_branch.repository
 
1148
        else:
 
1149
            try:
 
1150
                source_branch = self.open_branch()
 
1151
                source_repository = source_branch.repository
 
1152
                if stacked:
 
1153
                    stacked_branch_url = self.root_transport.base
 
1154
            except errors.NotBranchError:
 
1155
                source_branch = None
 
1156
                try:
 
1157
                    source_repository = self.open_repository()
 
1158
                except errors.NoRepositoryPresent:
 
1159
                    source_repository = None
 
1160
        repository_policy = result.determine_repository_policy(
 
1161
            force_new_repo, stacked_branch_url, require_stacking=stacked)
 
1162
        result_repo, is_new_repo = repository_policy.acquire_repository()
 
1163
        if is_new_repo and revision_id is not None and not stacked:
 
1164
            fetch_spec = graph.PendingAncestryResult(
 
1165
                [revision_id], source_repository)
 
1166
        else:
 
1167
            fetch_spec = None
 
1168
        if source_repository is not None:
 
1169
            # Fetch while stacked to prevent unstacked fetch from
 
1170
            # Branch.sprout.
 
1171
            if fetch_spec is None:
 
1172
                result_repo.fetch(source_repository, revision_id=revision_id)
 
1173
            else:
 
1174
                result_repo.fetch(source_repository, fetch_spec=fetch_spec)
 
1175
 
 
1176
        if source_branch is None:
 
1177
            # this is for sprouting a bzrdir without a branch; is that
 
1178
            # actually useful?
 
1179
            # Not especially, but it's part of the contract.
 
1180
            result_branch = result.create_branch()
 
1181
        else:
 
1182
            result_branch = source_branch.sprout(result,
 
1183
                revision_id=revision_id, repository_policy=repository_policy)
 
1184
        mutter("created new branch %r" % (result_branch,))
 
1185
 
 
1186
        # Create/update the result working tree
 
1187
        if (create_tree_if_local and
 
1188
            isinstance(target_transport, local.LocalTransport) and
 
1189
            (result_repo is None or result_repo.make_working_trees())):
 
1190
            wt = result.create_workingtree(accelerator_tree=accelerator_tree,
 
1191
                hardlink=hardlink)
 
1192
            wt.lock_write()
 
1193
            try:
 
1194
                if wt.path2id('') is None:
 
1195
                    try:
 
1196
                        wt.set_root_id(self.open_workingtree.get_root_id())
 
1197
                    except errors.NoWorkingTree:
 
1198
                        pass
 
1199
            finally:
 
1200
                wt.unlock()
 
1201
        else:
 
1202
            wt = None
 
1203
        if recurse == 'down':
 
1204
            if wt is not None:
 
1205
                basis = wt.basis_tree()
 
1206
                basis.lock_read()
 
1207
                subtrees = basis.iter_references()
 
1208
            elif result_branch is not None:
 
1209
                basis = result_branch.basis_tree()
 
1210
                basis.lock_read()
 
1211
                subtrees = basis.iter_references()
 
1212
            elif source_branch is not None:
 
1213
                basis = source_branch.basis_tree()
 
1214
                basis.lock_read()
 
1215
                subtrees = basis.iter_references()
 
1216
            else:
 
1217
                subtrees = []
 
1218
                basis = None
 
1219
            try:
 
1220
                for path, file_id in subtrees:
 
1221
                    target = urlutils.join(url, urlutils.escape(path))
 
1222
                    sublocation = source_branch.reference_parent(file_id, path)
 
1223
                    sublocation.bzrdir.sprout(target,
 
1224
                        basis.get_reference_revision(file_id, path),
 
1225
                        force_new_repo=force_new_repo, recurse=recurse,
 
1226
                        stacked=stacked)
 
1227
            finally:
 
1228
                if basis is not None:
 
1229
                    basis.unlock()
 
1230
        return result
 
1231
 
 
1232
    def push_branch(self, source, revision_id=None, overwrite=False, 
 
1233
        remember=False):
 
1234
        """Push the source branch into this BzrDir."""
 
1235
        br_to = None
 
1236
        # If we can open a branch, use its direct repository, otherwise see
 
1237
        # if there is a repository without a branch.
 
1238
        try:
 
1239
            br_to = self.open_branch()
 
1240
        except errors.NotBranchError:
 
1241
            # Didn't find a branch, can we find a repository?
 
1242
            repository_to = self.find_repository()
 
1243
        else:
 
1244
            # Found a branch, so we must have found a repository
 
1245
            repository_to = br_to.repository
 
1246
 
 
1247
        push_result = PushResult()
 
1248
        push_result.source_branch = source
 
1249
        if br_to is None:
 
1250
            # We have a repository but no branch, copy the revisions, and then
 
1251
            # create a branch.
 
1252
            repository_to.fetch(source.repository, revision_id=revision_id)
 
1253
            br_to = source.clone(self, revision_id=revision_id)
 
1254
            if source.get_push_location() is None or remember:
 
1255
                source.set_push_location(br_to.base)
 
1256
            push_result.stacked_on = None
 
1257
            push_result.branch_push_result = None
 
1258
            push_result.old_revno = None
 
1259
            push_result.old_revid = _mod_revision.NULL_REVISION
 
1260
            push_result.target_branch = br_to
 
1261
            push_result.master_branch = None
 
1262
            push_result.workingtree_updated = False
 
1263
        else:
 
1264
            # We have successfully opened the branch, remember if necessary:
 
1265
            if source.get_push_location() is None or remember:
 
1266
                source.set_push_location(br_to.base)
 
1267
            try:
 
1268
                tree_to = self.open_workingtree()
 
1269
            except errors.NotLocalUrl:
 
1270
                push_result.branch_push_result = source.push(br_to, 
 
1271
                    overwrite, stop_revision=revision_id)
 
1272
                push_result.workingtree_updated = False
 
1273
            except errors.NoWorkingTree:
 
1274
                push_result.branch_push_result = source.push(br_to,
 
1275
                    overwrite, stop_revision=revision_id)
 
1276
                push_result.workingtree_updated = None # Not applicable
 
1277
            else:
 
1278
                tree_to.lock_write()
 
1279
                try:
 
1280
                    push_result.branch_push_result = source.push(
 
1281
                        tree_to.branch, overwrite, stop_revision=revision_id)
 
1282
                    tree_to.update()
 
1283
                finally:
 
1284
                    tree_to.unlock()
 
1285
                push_result.workingtree_updated = True
 
1286
            push_result.old_revno = push_result.branch_push_result.old_revno
 
1287
            push_result.old_revid = push_result.branch_push_result.old_revid
 
1288
            push_result.target_branch = \
 
1289
                push_result.branch_push_result.target_branch
 
1290
        return push_result
1079
1291
 
1080
1292
 
1081
1293
class BzrDirHooks(hooks.Hooks):
1083
1295
 
1084
1296
    def __init__(self):
1085
1297
        """Create the default hooks."""
1086
 
        hooks.Hooks.__init__(self, "bzrlib.bzrdir", "BzrDir.hooks")
1087
 
        self.add_hook('pre_open',
 
1298
        hooks.Hooks.__init__(self)
 
1299
        self.create_hook(hooks.HookPoint('pre_open',
1088
1300
            "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))
 
1301
            "that the open will use.", (1, 14), None))
1095
1302
 
1096
1303
# install the default hooks
1097
1304
BzrDir.hooks = BzrDirHooks()
1098
1305
 
1099
1306
 
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
 
1307
class BzrDirPreSplitOut(BzrDir):
 
1308
    """A common class for the all-in-one formats."""
 
1309
 
 
1310
    def __init__(self, _transport, _format):
 
1311
        """See BzrDir.__init__."""
 
1312
        super(BzrDirPreSplitOut, self).__init__(_transport, _format)
 
1313
        self._control_files = lockable_files.LockableFiles(
 
1314
                                            self.get_branch_transport(None),
 
1315
                                            self._format._lock_file_name,
 
1316
                                            self._format._lock_class)
 
1317
 
 
1318
    def break_lock(self):
 
1319
        """Pre-splitout bzrdirs do not suffer from stale locks."""
 
1320
        raise NotImplementedError(self.break_lock)
 
1321
 
 
1322
    def cloning_metadir(self, require_stacking=False):
 
1323
        """Produce a metadir suitable for cloning with."""
 
1324
        if require_stacking:
 
1325
            return format_registry.make_bzrdir('1.6')
 
1326
        return self._format.__class__()
 
1327
 
 
1328
    def clone(self, url, revision_id=None, force_new_repo=False,
 
1329
              preserve_stacking=False):
 
1330
        """See BzrDir.clone().
 
1331
 
 
1332
        force_new_repo has no effect, since this family of formats always
 
1333
        require a new repository.
 
1334
        preserve_stacking has no effect, since no source branch using this
 
1335
        family of formats can be stacked, so there is no stacking to preserve.
1118
1336
        """
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)
 
1337
        self._make_tail(url)
 
1338
        result = self._format._initialize_for_clone(url)
 
1339
        self.open_repository().clone(result, revision_id=revision_id)
 
1340
        from_branch = self.open_branch()
 
1341
        from_branch.clone(result, revision_id=revision_id)
 
1342
        try:
 
1343
            tree = self.open_workingtree()
 
1344
        except errors.NotLocalUrl:
 
1345
            # make a new one, this format always has to have one.
 
1346
            result._init_workingtree()
1131
1347
        else:
1132
 
            return "<%s for %s>" % (self.__class__.__name__,
1133
 
                self.bzrdir)
 
1348
            tree.clone(result)
 
1349
        return result
 
1350
 
 
1351
    def create_branch(self):
 
1352
        """See BzrDir.create_branch."""
 
1353
        return self._format.get_branch_format().initialize(self)
 
1354
 
 
1355
    def destroy_branch(self):
 
1356
        """See BzrDir.destroy_branch."""
 
1357
        raise errors.UnsupportedOperation(self.destroy_branch, self)
 
1358
 
 
1359
    def create_repository(self, shared=False):
 
1360
        """See BzrDir.create_repository."""
 
1361
        if shared:
 
1362
            raise errors.IncompatibleFormat('shared repository', self._format)
 
1363
        return self.open_repository()
 
1364
 
 
1365
    def destroy_repository(self):
 
1366
        """See BzrDir.destroy_repository."""
 
1367
        raise errors.UnsupportedOperation(self.destroy_repository, self)
 
1368
 
 
1369
    def create_workingtree(self, revision_id=None, from_branch=None,
 
1370
                           accelerator_tree=None, hardlink=False):
 
1371
        """See BzrDir.create_workingtree."""
 
1372
        # The workingtree is sometimes created when the bzrdir is created,
 
1373
        # but not when cloning.
 
1374
 
 
1375
        # this looks buggy but is not -really-
 
1376
        # because this format creates the workingtree when the bzrdir is
 
1377
        # created
 
1378
        # clone and sprout will have set the revision_id
 
1379
        # and that will have set it for us, its only
 
1380
        # specific uses of create_workingtree in isolation
 
1381
        # that can do wonky stuff here, and that only
 
1382
        # happens for creating checkouts, which cannot be
 
1383
        # done on this format anyway. So - acceptable wart.
 
1384
        try:
 
1385
            result = self.open_workingtree(recommend_upgrade=False)
 
1386
        except errors.NoSuchFile:
 
1387
            result = self._init_workingtree()
 
1388
        if revision_id is not None:
 
1389
            if revision_id == _mod_revision.NULL_REVISION:
 
1390
                result.set_parent_ids([])
 
1391
            else:
 
1392
                result.set_parent_ids([revision_id])
 
1393
        return result
 
1394
 
 
1395
    def _init_workingtree(self):
 
1396
        from bzrlib.workingtree import WorkingTreeFormat2
 
1397
        try:
 
1398
            return WorkingTreeFormat2().initialize(self)
 
1399
        except errors.NotLocalUrl:
 
1400
            # Even though we can't access the working tree, we need to
 
1401
            # create its control files.
 
1402
            return WorkingTreeFormat2()._stub_initialize_on_transport(
 
1403
                self.transport, self._control_files._file_mode)
 
1404
 
 
1405
    def destroy_workingtree(self):
 
1406
        """See BzrDir.destroy_workingtree."""
 
1407
        raise errors.UnsupportedOperation(self.destroy_workingtree, self)
 
1408
 
 
1409
    def destroy_workingtree_metadata(self):
 
1410
        """See BzrDir.destroy_workingtree_metadata."""
 
1411
        raise errors.UnsupportedOperation(self.destroy_workingtree_metadata,
 
1412
                                          self)
 
1413
 
 
1414
    def get_branch_transport(self, branch_format):
 
1415
        """See BzrDir.get_branch_transport()."""
 
1416
        if branch_format is None:
 
1417
            return self.transport
 
1418
        try:
 
1419
            branch_format.get_format_string()
 
1420
        except NotImplementedError:
 
1421
            return self.transport
 
1422
        raise errors.IncompatibleFormat(branch_format, self._format)
 
1423
 
 
1424
    def get_repository_transport(self, repository_format):
 
1425
        """See BzrDir.get_repository_transport()."""
 
1426
        if repository_format is None:
 
1427
            return self.transport
 
1428
        try:
 
1429
            repository_format.get_format_string()
 
1430
        except NotImplementedError:
 
1431
            return self.transport
 
1432
        raise errors.IncompatibleFormat(repository_format, self._format)
 
1433
 
 
1434
    def get_workingtree_transport(self, workingtree_format):
 
1435
        """See BzrDir.get_workingtree_transport()."""
 
1436
        if workingtree_format is None:
 
1437
            return self.transport
 
1438
        try:
 
1439
            workingtree_format.get_format_string()
 
1440
        except NotImplementedError:
 
1441
            return self.transport
 
1442
        raise errors.IncompatibleFormat(workingtree_format, self._format)
 
1443
 
 
1444
    def needs_format_conversion(self, format=None):
 
1445
        """See BzrDir.needs_format_conversion()."""
 
1446
        # if the format is not the same as the system default,
 
1447
        # an upgrade is needed.
 
1448
        if format is None:
 
1449
            symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
 
1450
                % 'needs_format_conversion(format=None)')
 
1451
            format = BzrDirFormat.get_default_format()
 
1452
        return not isinstance(self._format, format.__class__)
 
1453
 
 
1454
    def open_branch(self, unsupported=False, ignore_fallbacks=False):
 
1455
        """See BzrDir.open_branch."""
 
1456
        from bzrlib.branch import BzrBranchFormat4
 
1457
        format = BzrBranchFormat4()
 
1458
        self._check_supported(format, unsupported)
 
1459
        return format.open(self, _found=True)
 
1460
 
 
1461
    def sprout(self, url, revision_id=None, force_new_repo=False,
 
1462
               possible_transports=None, accelerator_tree=None,
 
1463
               hardlink=False, stacked=False, create_tree_if_local=True,
 
1464
               source_branch=None):
 
1465
        """See BzrDir.sprout()."""
 
1466
        if source_branch is not None:
 
1467
            my_branch = self.open_branch()
 
1468
            if source_branch.base != my_branch.base:
 
1469
                raise AssertionError(
 
1470
                    "source branch %r is not within %r with branch %r" %
 
1471
                    (source_branch, self, my_branch))
 
1472
        if stacked:
 
1473
            raise errors.UnstackableBranchFormat(
 
1474
                self._format, self.root_transport.base)
 
1475
        if not create_tree_if_local:
 
1476
            raise errors.MustHaveWorkingTree(
 
1477
                self._format, self.root_transport.base)
 
1478
        from bzrlib.workingtree import WorkingTreeFormat2
 
1479
        self._make_tail(url)
 
1480
        result = self._format._initialize_for_clone(url)
 
1481
        try:
 
1482
            self.open_repository().clone(result, revision_id=revision_id)
 
1483
        except errors.NoRepositoryPresent:
 
1484
            pass
 
1485
        try:
 
1486
            self.open_branch().sprout(result, revision_id=revision_id)
 
1487
        except errors.NotBranchError:
 
1488
            pass
 
1489
 
 
1490
        # we always want a working tree
 
1491
        WorkingTreeFormat2().initialize(result,
 
1492
                                        accelerator_tree=accelerator_tree,
 
1493
                                        hardlink=hardlink)
 
1494
        return result
 
1495
 
 
1496
 
 
1497
class BzrDir4(BzrDirPreSplitOut):
 
1498
    """A .bzr version 4 control object.
 
1499
 
 
1500
    This is a deprecated format and may be removed after sept 2006.
 
1501
    """
 
1502
 
 
1503
    def create_repository(self, shared=False):
 
1504
        """See BzrDir.create_repository."""
 
1505
        return self._format.repository_format.initialize(self, shared)
 
1506
 
 
1507
    def needs_format_conversion(self, format=None):
 
1508
        """Format 4 dirs are always in need of conversion."""
 
1509
        if format is None:
 
1510
            symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
 
1511
                % 'needs_format_conversion(format=None)')
 
1512
        return True
 
1513
 
 
1514
    def open_repository(self):
 
1515
        """See BzrDir.open_repository."""
 
1516
        from bzrlib.repofmt.weaverepo import RepositoryFormat4
 
1517
        return RepositoryFormat4().open(self, _found=True)
 
1518
 
 
1519
 
 
1520
class BzrDir5(BzrDirPreSplitOut):
 
1521
    """A .bzr version 5 control object.
 
1522
 
 
1523
    This is a deprecated format and may be removed after sept 2006.
 
1524
    """
 
1525
 
 
1526
    def open_repository(self):
 
1527
        """See BzrDir.open_repository."""
 
1528
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
 
1529
        return RepositoryFormat5().open(self, _found=True)
 
1530
 
 
1531
    def open_workingtree(self, _unsupported=False,
 
1532
            recommend_upgrade=True):
 
1533
        """See BzrDir.create_workingtree."""
 
1534
        from bzrlib.workingtree import WorkingTreeFormat2
 
1535
        wt_format = WorkingTreeFormat2()
 
1536
        # we don't warn here about upgrades; that ought to be handled for the
 
1537
        # bzrdir as a whole
 
1538
        return wt_format.open(self, _found=True)
 
1539
 
 
1540
 
 
1541
class BzrDir6(BzrDirPreSplitOut):
 
1542
    """A .bzr version 6 control object.
 
1543
 
 
1544
    This is a deprecated format and may be removed after sept 2006.
 
1545
    """
 
1546
 
 
1547
    def open_repository(self):
 
1548
        """See BzrDir.open_repository."""
 
1549
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
 
1550
        return RepositoryFormat6().open(self, _found=True)
 
1551
 
 
1552
    def open_workingtree(self, _unsupported=False,
 
1553
        recommend_upgrade=True):
 
1554
        """See BzrDir.create_workingtree."""
 
1555
        # we don't warn here about upgrades; that ought to be handled for the
 
1556
        # bzrdir as a whole
 
1557
        from bzrlib.workingtree import WorkingTreeFormat2
 
1558
        return WorkingTreeFormat2().open(self, _found=True)
1134
1559
 
1135
1560
 
1136
1561
class BzrDirMeta1(BzrDir):
1146
1571
        """See BzrDir.can_convert_format()."""
1147
1572
        return True
1148
1573
 
1149
 
    def create_branch(self, name=None, repository=None):
 
1574
    def create_branch(self):
1150
1575
        """See BzrDir.create_branch."""
1151
 
        return self._format.get_branch_format().initialize(self, name=name,
1152
 
                repository=repository)
 
1576
        return self._format.get_branch_format().initialize(self)
1153
1577
 
1154
 
    def destroy_branch(self, name=None):
 
1578
    def destroy_branch(self):
1155
1579
        """See BzrDir.create_branch."""
1156
 
        if name is not None:
1157
 
            raise errors.NoColocatedBranchSupport(self)
1158
1580
        self.transport.delete_tree('branch')
1159
1581
 
1160
1582
    def create_repository(self, shared=False):
1177
1599
        wt = self.open_workingtree(recommend_upgrade=False)
1178
1600
        repository = wt.branch.repository
1179
1601
        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)
 
1602
        wt.revert(old_tree=empty)
1184
1603
        self.destroy_workingtree_metadata()
1185
1604
 
1186
1605
    def destroy_workingtree_metadata(self):
1187
1606
        self.transport.delete_tree('checkout')
1188
1607
 
1189
 
    def find_branch_format(self, name=None):
 
1608
    def find_branch_format(self):
1190
1609
        """Find the branch 'format' for this bzrdir.
1191
1610
 
1192
1611
        This might be a synthetic object for e.g. RemoteBranch and SVN.
1193
1612
        """
1194
1613
        from bzrlib.branch import BranchFormat
1195
 
        return BranchFormat.find_format(self, name=name)
 
1614
        return BranchFormat.find_format(self)
1196
1615
 
1197
1616
    def _get_mkdir_mode(self):
1198
1617
        """Figure out the mode to use when creating a bzrdir subdir."""
1200
1619
                                     lockable_files.TransportLock)
1201
1620
        return temp_control._dir_mode
1202
1621
 
1203
 
    def get_branch_reference(self, name=None):
 
1622
    def get_branch_reference(self):
1204
1623
        """See BzrDir.get_branch_reference()."""
1205
1624
        from bzrlib.branch import BranchFormat
1206
 
        format = BranchFormat.find_format(self, name=name)
1207
 
        return format.get_reference(self, name=name)
 
1625
        format = BranchFormat.find_format(self)
 
1626
        return format.get_reference(self)
1208
1627
 
1209
 
    def get_branch_transport(self, branch_format, name=None):
 
1628
    def get_branch_transport(self, branch_format):
1210
1629
        """See BzrDir.get_branch_transport()."""
1211
 
        if name is not None:
1212
 
            raise errors.NoColocatedBranchSupport(self)
1213
 
        # XXX: this shouldn't implicitly create the directory if it's just
1214
 
        # promising to get a transport -- mbp 20090727
1215
1630
        if branch_format is None:
1216
1631
            return self.transport.clone('branch')
1217
1632
        try:
1252
1667
            pass
1253
1668
        return self.transport.clone('checkout')
1254
1669
 
1255
 
    def has_workingtree(self):
1256
 
        """Tell if this bzrdir contains a working tree.
1257
 
 
1258
 
        Note: if you're going to open the working tree, you should just go
1259
 
        ahead and try, and not ask permission first.
1260
 
        """
1261
 
        from bzrlib.workingtree import WorkingTreeFormat
1262
 
        try:
1263
 
            WorkingTreeFormat.find_format_string(self)
1264
 
        except errors.NoWorkingTree:
1265
 
            return False
1266
 
        return True
1267
 
 
1268
 
    def needs_format_conversion(self, format):
 
1670
    def needs_format_conversion(self, format=None):
1269
1671
        """See BzrDir.needs_format_conversion()."""
 
1672
        if format is None:
 
1673
            symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
 
1674
                % 'needs_format_conversion(format=None)')
 
1675
        if format is None:
 
1676
            format = BzrDirFormat.get_default_format()
1270
1677
        if not isinstance(self._format, format.__class__):
1271
1678
            # it is not a meta dir format, conversion is needed.
1272
1679
            return True
1278
1685
                return True
1279
1686
        except errors.NoRepositoryPresent:
1280
1687
            pass
1281
 
        for branch in self.list_branches():
1282
 
            if not isinstance(branch._format,
 
1688
        try:
 
1689
            if not isinstance(self.open_branch()._format,
1283
1690
                              format.get_branch_format().__class__):
1284
1691
                # the branch needs an upgrade.
1285
1692
                return True
 
1693
        except errors.NotBranchError:
 
1694
            pass
1286
1695
        try:
1287
1696
            my_wt = self.open_workingtree(recommend_upgrade=False)
1288
1697
            if not isinstance(my_wt._format,
1293
1702
            pass
1294
1703
        return False
1295
1704
 
1296
 
    def open_branch(self, name=None, unsupported=False,
1297
 
                    ignore_fallbacks=False):
 
1705
    def open_branch(self, unsupported=False, ignore_fallbacks=False):
1298
1706
        """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)
 
1707
        format = self.find_branch_format()
 
1708
        self._check_supported(format, unsupported)
 
1709
        return format.open(self, _found=True, ignore_fallbacks=ignore_fallbacks)
1303
1710
 
1304
1711
    def open_repository(self, unsupported=False):
1305
1712
        """See BzrDir.open_repository."""
1306
1713
        from bzrlib.repository import RepositoryFormat
1307
1714
        format = RepositoryFormat.find_format(self)
1308
 
        format.check_support_status(unsupported)
 
1715
        self._check_supported(format, unsupported)
1309
1716
        return format.open(self, _found=True)
1310
1717
 
1311
1718
    def open_workingtree(self, unsupported=False,
1313
1720
        """See BzrDir.open_workingtree."""
1314
1721
        from bzrlib.workingtree import WorkingTreeFormat
1315
1722
        format = WorkingTreeFormat.find_format(self)
1316
 
        format.check_support_status(unsupported, recommend_upgrade,
 
1723
        self._check_supported(format, unsupported,
 
1724
            recommend_upgrade,
1317
1725
            basedir=self.root_transport.base)
1318
1726
        return format.open(self, _found=True)
1319
1727
 
1321
1729
        return config.TransportConfig(self.transport, 'control.conf')
1322
1730
 
1323
1731
 
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.
 
1732
class BzrDirFormat(object):
 
1733
    """An encapsulation of the initialization and open routines for a format.
 
1734
 
 
1735
    Formats provide three things:
 
1736
     * An initialization routine,
 
1737
     * a format string,
 
1738
     * an open routine.
1401
1739
 
1402
1740
    Formats are placed in a dict by their format string for reference
1403
1741
    during bzrdir opening. These should be subclasses of BzrDirFormat
1408
1746
    object will be created every system load.
1409
1747
    """
1410
1748
 
 
1749
    _default_format = None
 
1750
    """The default format used for new .bzr dirs."""
 
1751
 
 
1752
    _formats = {}
 
1753
    """The known formats."""
 
1754
 
 
1755
    _control_formats = []
 
1756
    """The registered control formats - .bzr, ....
 
1757
 
 
1758
    This is a list of BzrDirFormat objects.
 
1759
    """
 
1760
 
 
1761
    _control_server_formats = []
 
1762
    """The registered control server formats, e.g. RemoteBzrDirs.
 
1763
 
 
1764
    This is a list of BzrDirFormat objects.
 
1765
    """
 
1766
 
1411
1767
    _lock_file_name = 'branch-lock'
1412
1768
 
1413
1769
    # _lock_class must be set in subclasses to the lock type, typ.
1414
1770
    # TransportLock or LockDir
1415
1771
 
1416
1772
    @classmethod
1417
 
    def get_format_string(cls):
 
1773
    def find_format(klass, transport, _server_formats=True):
 
1774
        """Return the format present at transport."""
 
1775
        if _server_formats:
 
1776
            formats = klass._control_server_formats + klass._control_formats
 
1777
        else:
 
1778
            formats = klass._control_formats
 
1779
        for format in formats:
 
1780
            try:
 
1781
                return format.probe_transport(transport)
 
1782
            except errors.NotBranchError:
 
1783
                # this format does not find a control dir here.
 
1784
                pass
 
1785
        raise errors.NotBranchError(path=transport.base)
 
1786
 
 
1787
    @classmethod
 
1788
    def probe_transport(klass, transport):
 
1789
        """Return the .bzrdir style format present in a directory."""
 
1790
        try:
 
1791
            format_string = transport.get(".bzr/branch-format").read()
 
1792
        except errors.NoSuchFile:
 
1793
            raise errors.NotBranchError(path=transport.base)
 
1794
 
 
1795
        try:
 
1796
            return klass._formats[format_string]
 
1797
        except KeyError:
 
1798
            raise errors.UnknownFormatError(format=format_string, kind='bzrdir')
 
1799
 
 
1800
    @classmethod
 
1801
    def get_default_format(klass):
 
1802
        """Return the current default format."""
 
1803
        return klass._default_format
 
1804
 
 
1805
    def get_format_string(self):
1418
1806
        """Return the ASCII format string that identifies this format."""
1419
 
        raise NotImplementedError(cls.get_format_string)
 
1807
        raise NotImplementedError(self.get_format_string)
 
1808
 
 
1809
    def get_format_description(self):
 
1810
        """Return the short description for this format."""
 
1811
        raise NotImplementedError(self.get_format_description)
 
1812
 
 
1813
    def get_converter(self, format=None):
 
1814
        """Return the converter to use to convert bzrdirs needing converts.
 
1815
 
 
1816
        This returns a bzrlib.bzrdir.Converter object.
 
1817
 
 
1818
        This should return the best upgrader to step this format towards the
 
1819
        current default format. In the case of plugins we can/should provide
 
1820
        some means for them to extend the range of returnable converters.
 
1821
 
 
1822
        :param format: Optional format to override the default format of the
 
1823
                       library.
 
1824
        """
 
1825
        raise NotImplementedError(self.get_converter)
 
1826
 
 
1827
    def initialize(self, url, possible_transports=None):
 
1828
        """Create a bzr control dir at this url and return an opened copy.
 
1829
 
 
1830
        While not deprecated, this method is very specific and its use will
 
1831
        lead to many round trips to setup a working environment. See
 
1832
        initialize_on_transport_ex for a [nearly] all-in-one method.
 
1833
 
 
1834
        Subclasses should typically override initialize_on_transport
 
1835
        instead of this method.
 
1836
        """
 
1837
        return self.initialize_on_transport(get_transport(url,
 
1838
                                                          possible_transports))
1420
1839
 
1421
1840
    def initialize_on_transport(self, transport):
1422
1841
        """Initialize a new bzrdir in the base directory of a Transport."""
1432
1851
            # metadir1
1433
1852
            if type(self) != BzrDirMetaFormat1:
1434
1853
                return self._initialize_on_transport_vfs(transport)
1435
 
            from bzrlib.remote import RemoteBzrDirFormat
1436
1854
            remote_format = RemoteBzrDirFormat()
1437
1855
            self._supply_sub_formats_to(remote_format)
1438
1856
            return remote_format.initialize_on_transport(transport)
1476
1894
            except errors.NoSmartMedium:
1477
1895
                pass
1478
1896
            else:
1479
 
                from bzrlib.remote import RemoteBzrDirFormat
1480
1897
                # TODO: lookup the local format from a server hint.
1481
1898
                remote_dir_format = RemoteBzrDirFormat()
1482
1899
                remote_dir_format._network_name = self.network_name()
1529
1946
            if not require_stacking and repository_policy._require_stacking:
1530
1947
                require_stacking = True
1531
1948
                result._format.require_stacking()
1532
 
            result_repo.lock_write()
1533
1949
        else:
1534
1950
            result_repo = None
1535
1951
            repository_policy = None
1557
1973
        utf8_files = [('README',
1558
1974
                       "This is a Bazaar control directory.\n"
1559
1975
                       "Do not change any files in this directory.\n"
1560
 
                       "See http://bazaar.canonical.com/ for more information about Bazaar.\n"),
 
1976
                       "See http://bazaar-vcs.org/ for more information about Bazaar.\n"),
1561
1977
                      ('branch-format', self.get_format_string()),
1562
1978
                      ]
1563
1979
        # NB: no need to escape relative paths that are url safe.
1573
1989
            control_files.unlock()
1574
1990
        return self.open(transport, _found=True)
1575
1991
 
 
1992
    def is_supported(self):
 
1993
        """Is this format supported?
 
1994
 
 
1995
        Supported formats must be initializable and openable.
 
1996
        Unsupported formats may not support initialization or committing or
 
1997
        some other features depending on the reason for not being supported.
 
1998
        """
 
1999
        return True
 
2000
 
 
2001
    def network_name(self):
 
2002
        """A simple byte string uniquely identifying this format for RPC calls.
 
2003
 
 
2004
        Bzr control formats use thir disk format string to identify the format
 
2005
        over the wire. Its possible that other control formats have more
 
2006
        complex detection requirements, so we permit them to use any unique and
 
2007
        immutable string they desire.
 
2008
        """
 
2009
        raise NotImplementedError(self.network_name)
 
2010
 
 
2011
    def same_model(self, target_format):
 
2012
        return (self.repository_format.rich_root_data ==
 
2013
            target_format.rich_root_data)
 
2014
 
 
2015
    @classmethod
 
2016
    def known_formats(klass):
 
2017
        """Return all the known formats.
 
2018
 
 
2019
        Concrete formats should override _known_formats.
 
2020
        """
 
2021
        # There is double indirection here to make sure that control
 
2022
        # formats used by more than one dir format will only be probed
 
2023
        # once. This can otherwise be quite expensive for remote connections.
 
2024
        result = set()
 
2025
        for format in klass._control_formats:
 
2026
            result.update(format._known_formats())
 
2027
        return result
 
2028
 
 
2029
    @classmethod
 
2030
    def _known_formats(klass):
 
2031
        """Return the known format instances for this control format."""
 
2032
        return set(klass._formats.values())
 
2033
 
1576
2034
    def open(self, transport, _found=False):
1577
2035
        """Return an instance of this format for the dir transport points at.
1578
2036
 
1579
2037
        _found is a private parameter, do not use it.
1580
2038
        """
1581
2039
        if not _found:
1582
 
            found_format = controldir.ControlDirFormat.find_format(transport)
 
2040
            found_format = BzrDirFormat.find_format(transport)
1583
2041
            if not isinstance(found_format, self.__class__):
1584
2042
                raise AssertionError("%s was asked to open %s, but it seems to need "
1585
2043
                        "format %s"
1597
2055
        """
1598
2056
        raise NotImplementedError(self._open)
1599
2057
 
 
2058
    @classmethod
 
2059
    def register_format(klass, format):
 
2060
        klass._formats[format.get_format_string()] = format
 
2061
        # bzr native formats have a network name of their format string.
 
2062
        network_format_registry.register(format.get_format_string(), format.__class__)
 
2063
 
 
2064
    @classmethod
 
2065
    def register_control_format(klass, format):
 
2066
        """Register a format that does not use '.bzr' for its control dir.
 
2067
 
 
2068
        TODO: This should be pulled up into a 'ControlDirFormat' base class
 
2069
        which BzrDirFormat can inherit from, and renamed to register_format
 
2070
        there. It has been done without that for now for simplicity of
 
2071
        implementation.
 
2072
        """
 
2073
        klass._control_formats.append(format)
 
2074
 
 
2075
    @classmethod
 
2076
    def register_control_server_format(klass, format):
 
2077
        """Register a control format for client-server environments.
 
2078
 
 
2079
        These formats will be tried before ones registered with
 
2080
        register_control_format.  This gives implementations that decide to the
 
2081
        chance to grab it before anything looks at the contents of the format
 
2082
        file.
 
2083
        """
 
2084
        klass._control_server_formats.append(format)
 
2085
 
 
2086
    @classmethod
 
2087
    def _set_default_format(klass, format):
 
2088
        """Set default format (for testing behavior of defaults only)"""
 
2089
        klass._default_format = format
 
2090
 
 
2091
    def __str__(self):
 
2092
        # Trim the newline
 
2093
        return self.get_format_description().rstrip()
 
2094
 
1600
2095
    def _supply_sub_formats_to(self, other_format):
1601
2096
        """Give other_format the same values for sub formats as this has.
1602
2097
 
1609
2104
        :return: None.
1610
2105
        """
1611
2106
 
 
2107
    @classmethod
 
2108
    def unregister_format(klass, format):
 
2109
        del klass._formats[format.get_format_string()]
 
2110
 
 
2111
    @classmethod
 
2112
    def unregister_control_format(klass, format):
 
2113
        klass._control_formats.remove(format)
 
2114
 
 
2115
 
 
2116
class BzrDirFormat4(BzrDirFormat):
 
2117
    """Bzr dir format 4.
 
2118
 
 
2119
    This format is a combined format for working tree, branch and repository.
 
2120
    It has:
 
2121
     - Format 1 working trees [always]
 
2122
     - Format 4 branches [always]
 
2123
     - Format 4 repositories [always]
 
2124
 
 
2125
    This format is deprecated: it indexes texts using a text it which is
 
2126
    removed in format 5; write support for this format has been removed.
 
2127
    """
 
2128
 
 
2129
    _lock_class = lockable_files.TransportLock
 
2130
 
 
2131
    def get_format_string(self):
 
2132
        """See BzrDirFormat.get_format_string()."""
 
2133
        return "Bazaar-NG branch, format 0.0.4\n"
 
2134
 
 
2135
    def get_format_description(self):
 
2136
        """See BzrDirFormat.get_format_description()."""
 
2137
        return "All-in-one format 4"
 
2138
 
 
2139
    def get_converter(self, format=None):
 
2140
        """See BzrDirFormat.get_converter()."""
 
2141
        # there is one and only one upgrade path here.
 
2142
        return ConvertBzrDir4To5()
 
2143
 
 
2144
    def initialize_on_transport(self, transport):
 
2145
        """Format 4 branches cannot be created."""
 
2146
        raise errors.UninitializableFormat(self)
 
2147
 
 
2148
    def is_supported(self):
 
2149
        """Format 4 is not supported.
 
2150
 
 
2151
        It is not supported because the model changed from 4 to 5 and the
 
2152
        conversion logic is expensive - so doing it on the fly was not
 
2153
        feasible.
 
2154
        """
 
2155
        return False
 
2156
 
 
2157
    def network_name(self):
 
2158
        return self.get_format_string()
 
2159
 
 
2160
    def _open(self, transport):
 
2161
        """See BzrDirFormat._open."""
 
2162
        return BzrDir4(transport, self)
 
2163
 
 
2164
    def __return_repository_format(self):
 
2165
        """Circular import protection."""
 
2166
        from bzrlib.repofmt.weaverepo import RepositoryFormat4
 
2167
        return RepositoryFormat4()
 
2168
    repository_format = property(__return_repository_format)
 
2169
 
 
2170
 
 
2171
class BzrDirFormatAllInOne(BzrDirFormat):
 
2172
    """Common class for formats before meta-dirs."""
 
2173
 
 
2174
    def initialize_on_transport_ex(self, transport, use_existing_dir=False,
 
2175
        create_prefix=False, force_new_repo=False, stacked_on=None,
 
2176
        stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
 
2177
        shared_repo=False):
 
2178
        """See BzrDirFormat.initialize_on_transport_ex."""
 
2179
        require_stacking = (stacked_on is not None)
 
2180
        # Format 5 cannot stack, but we've been asked to - actually init
 
2181
        # a Meta1Dir
 
2182
        if require_stacking:
 
2183
            format = BzrDirMetaFormat1()
 
2184
            return format.initialize_on_transport_ex(transport,
 
2185
                use_existing_dir=use_existing_dir, create_prefix=create_prefix,
 
2186
                force_new_repo=force_new_repo, stacked_on=stacked_on,
 
2187
                stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
 
2188
                make_working_trees=make_working_trees, shared_repo=shared_repo)
 
2189
        return BzrDirFormat.initialize_on_transport_ex(self, transport,
 
2190
            use_existing_dir=use_existing_dir, create_prefix=create_prefix,
 
2191
            force_new_repo=force_new_repo, stacked_on=stacked_on,
 
2192
            stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
 
2193
            make_working_trees=make_working_trees, shared_repo=shared_repo)
 
2194
 
 
2195
 
 
2196
class BzrDirFormat5(BzrDirFormatAllInOne):
 
2197
    """Bzr control format 5.
 
2198
 
 
2199
    This format is a combined format for working tree, branch and repository.
 
2200
    It has:
 
2201
     - Format 2 working trees [always]
 
2202
     - Format 4 branches [always]
 
2203
     - Format 5 repositories [always]
 
2204
       Unhashed stores in the repository.
 
2205
    """
 
2206
 
 
2207
    _lock_class = lockable_files.TransportLock
 
2208
 
 
2209
    def get_format_string(self):
 
2210
        """See BzrDirFormat.get_format_string()."""
 
2211
        return "Bazaar-NG branch, format 5\n"
 
2212
 
 
2213
    def get_branch_format(self):
 
2214
        from bzrlib import branch
 
2215
        return branch.BzrBranchFormat4()
 
2216
 
 
2217
    def get_format_description(self):
 
2218
        """See BzrDirFormat.get_format_description()."""
 
2219
        return "All-in-one format 5"
 
2220
 
 
2221
    def get_converter(self, format=None):
 
2222
        """See BzrDirFormat.get_converter()."""
 
2223
        # there is one and only one upgrade path here.
 
2224
        return ConvertBzrDir5To6()
 
2225
 
 
2226
    def _initialize_for_clone(self, url):
 
2227
        return self.initialize_on_transport(get_transport(url), _cloning=True)
 
2228
 
 
2229
    def initialize_on_transport(self, transport, _cloning=False):
 
2230
        """Format 5 dirs always have working tree, branch and repository.
 
2231
 
 
2232
        Except when they are being cloned.
 
2233
        """
 
2234
        from bzrlib.branch import BzrBranchFormat4
 
2235
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
 
2236
        result = (super(BzrDirFormat5, self).initialize_on_transport(transport))
 
2237
        RepositoryFormat5().initialize(result, _internal=True)
 
2238
        if not _cloning:
 
2239
            branch = BzrBranchFormat4().initialize(result)
 
2240
            result._init_workingtree()
 
2241
        return result
 
2242
 
 
2243
    def network_name(self):
 
2244
        return self.get_format_string()
 
2245
 
 
2246
    def _open(self, transport):
 
2247
        """See BzrDirFormat._open."""
 
2248
        return BzrDir5(transport, self)
 
2249
 
 
2250
    def __return_repository_format(self):
 
2251
        """Circular import protection."""
 
2252
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
 
2253
        return RepositoryFormat5()
 
2254
    repository_format = property(__return_repository_format)
 
2255
 
 
2256
 
 
2257
class BzrDirFormat6(BzrDirFormatAllInOne):
 
2258
    """Bzr control format 6.
 
2259
 
 
2260
    This format is a combined format for working tree, branch and repository.
 
2261
    It has:
 
2262
     - Format 2 working trees [always]
 
2263
     - Format 4 branches [always]
 
2264
     - Format 6 repositories [always]
 
2265
    """
 
2266
 
 
2267
    _lock_class = lockable_files.TransportLock
 
2268
 
 
2269
    def get_format_string(self):
 
2270
        """See BzrDirFormat.get_format_string()."""
 
2271
        return "Bazaar-NG branch, format 6\n"
 
2272
 
 
2273
    def get_format_description(self):
 
2274
        """See BzrDirFormat.get_format_description()."""
 
2275
        return "All-in-one format 6"
 
2276
 
 
2277
    def get_branch_format(self):
 
2278
        from bzrlib import branch
 
2279
        return branch.BzrBranchFormat4()
 
2280
 
 
2281
    def get_converter(self, format=None):
 
2282
        """See BzrDirFormat.get_converter()."""
 
2283
        # there is one and only one upgrade path here.
 
2284
        return ConvertBzrDir6ToMeta()
 
2285
 
 
2286
    def _initialize_for_clone(self, url):
 
2287
        return self.initialize_on_transport(get_transport(url), _cloning=True)
 
2288
 
 
2289
    def initialize_on_transport(self, transport, _cloning=False):
 
2290
        """Format 6 dirs always have working tree, branch and repository.
 
2291
 
 
2292
        Except when they are being cloned.
 
2293
        """
 
2294
        from bzrlib.branch import BzrBranchFormat4
 
2295
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
 
2296
        result = super(BzrDirFormat6, self).initialize_on_transport(transport)
 
2297
        RepositoryFormat6().initialize(result, _internal=True)
 
2298
        if not _cloning:
 
2299
            branch = BzrBranchFormat4().initialize(result)
 
2300
            result._init_workingtree()
 
2301
        return result
 
2302
 
 
2303
    def network_name(self):
 
2304
        return self.get_format_string()
 
2305
 
 
2306
    def _open(self, transport):
 
2307
        """See BzrDirFormat._open."""
 
2308
        return BzrDir6(transport, self)
 
2309
 
 
2310
    def __return_repository_format(self):
 
2311
        """Circular import protection."""
 
2312
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
 
2313
        return RepositoryFormat6()
 
2314
    repository_format = property(__return_repository_format)
 
2315
 
1612
2316
 
1613
2317
class BzrDirMetaFormat1(BzrDirFormat):
1614
2318
    """Bzr meta control format 1
1615
2319
 
1616
2320
    This is the first format with split out working tree, branch and repository
1617
2321
    disk storage.
1618
 
 
1619
2322
    It has:
1620
 
 
1621
 
    - Format 3 working trees [optional]
1622
 
    - Format 5 branches [optional]
1623
 
    - Format 7 repositories [optional]
 
2323
     - Format 3 working trees [optional]
 
2324
     - Format 5 branches [optional]
 
2325
     - Format 7 repositories [optional]
1624
2326
    """
1625
2327
 
1626
2328
    _lock_class = lockdir.LockDir
1627
2329
 
1628
 
    fixed_components = False
1629
 
 
1630
2330
    def __init__(self):
1631
2331
        self._workingtree_format = None
1632
2332
        self._branch_format = None
1646
2346
 
1647
2347
    def get_branch_format(self):
1648
2348
        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()
 
2349
            from bzrlib.branch import BranchFormat
 
2350
            self._branch_format = BranchFormat.get_default_format()
1651
2351
        return self._branch_format
1652
2352
 
1653
2353
    def set_branch_format(self, format):
1654
2354
        self._branch_format = format
1655
2355
 
1656
 
    def require_stacking(self, stack_on=None, possible_transports=None,
1657
 
            _skip_repo=False):
1658
 
        """We have a request to stack, try to ensure the formats support it.
1659
 
 
1660
 
        :param stack_on: If supplied, it is the URL to a branch that we want to
1661
 
            stack on. Check to see if that format supports stacking before
1662
 
            forcing an upgrade.
1663
 
        """
1664
 
        # Stacking is desired. requested by the target, but does the place it
1665
 
        # points at support stacking? If it doesn't then we should
1666
 
        # not implicitly upgrade. We check this here.
1667
 
        new_repo_format = None
1668
 
        new_branch_format = None
1669
 
 
1670
 
        # a bit of state for get_target_branch so that we don't try to open it
1671
 
        # 2 times, for both repo *and* branch
1672
 
        target = [None, False, None] # target_branch, checked, upgrade anyway
1673
 
        def get_target_branch():
1674
 
            if target[1]:
1675
 
                # We've checked, don't check again
1676
 
                return target
1677
 
            if stack_on is None:
1678
 
                # No target format, that means we want to force upgrading
1679
 
                target[:] = [None, True, True]
1680
 
                return target
1681
 
            try:
1682
 
                target_dir = BzrDir.open(stack_on,
1683
 
                    possible_transports=possible_transports)
1684
 
            except errors.NotBranchError:
1685
 
                # Nothing there, don't change formats
1686
 
                target[:] = [None, True, False]
1687
 
                return target
1688
 
            except errors.JailBreak:
1689
 
                # JailBreak, JFDI and upgrade anyway
1690
 
                target[:] = [None, True, True]
1691
 
                return target
1692
 
            try:
1693
 
                target_branch = target_dir.open_branch()
1694
 
            except errors.NotBranchError:
1695
 
                # No branch, don't upgrade formats
1696
 
                target[:] = [None, True, False]
1697
 
                return target
1698
 
            target[:] = [target_branch, True, False]
1699
 
            return target
1700
 
 
1701
 
        if (not _skip_repo and
1702
 
                 not self.repository_format.supports_external_lookups):
1703
 
            # We need to upgrade the Repository.
1704
 
            target_branch, _, do_upgrade = get_target_branch()
1705
 
            if target_branch is None:
1706
 
                # We don't have a target branch, should we upgrade anyway?
1707
 
                if do_upgrade:
1708
 
                    # stack_on is inaccessible, JFDI.
1709
 
                    # TODO: bad monkey, hard-coded formats...
1710
 
                    if self.repository_format.rich_root_data:
1711
 
                        new_repo_format = knitpack_repo.RepositoryFormatKnitPack5RichRoot()
1712
 
                    else:
1713
 
                        new_repo_format = knitpack_repo.RepositoryFormatKnitPack5()
1714
 
            else:
1715
 
                # If the target already supports stacking, then we know the
1716
 
                # project is already able to use stacking, so auto-upgrade
1717
 
                # for them
1718
 
                new_repo_format = target_branch.repository._format
1719
 
                if not new_repo_format.supports_external_lookups:
1720
 
                    # target doesn't, source doesn't, so don't auto upgrade
1721
 
                    # repo
1722
 
                    new_repo_format = None
1723
 
            if new_repo_format is not None:
1724
 
                self.repository_format = new_repo_format
1725
 
                note('Source repository format does not support stacking,'
1726
 
                     ' using format:\n  %s',
1727
 
                     new_repo_format.get_format_description())
1728
 
 
 
2356
    def require_stacking(self):
1729
2357
        if not self.get_branch_format().supports_stacking():
1730
 
            # We just checked the repo, now lets check if we need to
1731
 
            # upgrade the branch format
1732
 
            target_branch, _, do_upgrade = get_target_branch()
1733
 
            if target_branch is None:
1734
 
                if do_upgrade:
1735
 
                    # TODO: bad monkey, hard-coded formats...
1736
 
                    from bzrlib.branch import BzrBranchFormat7
1737
 
                    new_branch_format = BzrBranchFormat7()
 
2358
            # We need to make a stacked branch, but the default format for the
 
2359
            # target doesn't support stacking.  So force a branch that *can*
 
2360
            # support stacking.
 
2361
            from bzrlib.branch import BzrBranchFormat7
 
2362
            branch_format = BzrBranchFormat7()
 
2363
            self.set_branch_format(branch_format)
 
2364
            mutter("using %r for stacking" % (branch_format,))
 
2365
            from bzrlib.repofmt import pack_repo
 
2366
            if self.repository_format.rich_root_data:
 
2367
                bzrdir_format_name = '1.6.1-rich-root'
 
2368
                repo_format = pack_repo.RepositoryFormatKnitPack5RichRoot()
1738
2369
            else:
1739
 
                new_branch_format = target_branch._format
1740
 
                if not new_branch_format.supports_stacking():
1741
 
                    new_branch_format = None
1742
 
            if new_branch_format is not None:
1743
 
                # Does support stacking, use its format.
1744
 
                self.set_branch_format(new_branch_format)
1745
 
                note('Source branch format does not support stacking,'
1746
 
                     ' using format:\n  %s',
1747
 
                     new_branch_format.get_format_description())
 
2370
                bzrdir_format_name = '1.6'
 
2371
                repo_format = pack_repo.RepositoryFormatKnitPack5()
 
2372
            note('Source format does not support stacking, using format:'
 
2373
                 ' \'%s\'\n  %s\n',
 
2374
                 bzrdir_format_name, repo_format.get_format_description())
 
2375
            self.repository_format = repo_format
1748
2376
 
1749
2377
    def get_converter(self, format=None):
1750
2378
        """See BzrDirFormat.get_converter()."""
1755
2383
            raise NotImplementedError(self.get_converter)
1756
2384
        return ConvertMetaToMeta(format)
1757
2385
 
1758
 
    @classmethod
1759
 
    def get_format_string(cls):
 
2386
    def get_format_string(self):
1760
2387
        """See BzrDirFormat.get_format_string()."""
1761
2388
        return "Bazaar-NG meta directory, format 1\n"
1762
2389
 
1780
2407
        """Circular import protection."""
1781
2408
        if self._repository_format:
1782
2409
            return self._repository_format
1783
 
        from bzrlib.repository import format_registry
1784
 
        return format_registry.get_default()
 
2410
        from bzrlib.repository import RepositoryFormat
 
2411
        return RepositoryFormat.get_default_format()
1785
2412
 
1786
2413
    def _set_repository_format(self, value):
1787
2414
        """Allow changing the repository format for metadir formats."""
1810
2437
 
1811
2438
    def __get_workingtree_format(self):
1812
2439
        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()
 
2440
            from bzrlib.workingtree import WorkingTreeFormat
 
2441
            self._workingtree_format = WorkingTreeFormat.get_default_format()
1817
2442
        return self._workingtree_format
1818
2443
 
1819
2444
    def __set_workingtree_format(self, wt_format):
1823
2448
                                  __set_workingtree_format)
1824
2449
 
1825
2450
 
 
2451
network_format_registry = registry.FormatRegistry()
 
2452
"""Registry of formats indexed by their network name.
 
2453
 
 
2454
The network name for a BzrDirFormat is an identifier that can be used when
 
2455
referring to formats with smart server operations. See
 
2456
BzrDirFormat.network_name() for more detail.
 
2457
"""
 
2458
 
 
2459
 
 
2460
# Register bzr control format
 
2461
BzrDirFormat.register_control_format(BzrDirFormat)
 
2462
 
1826
2463
# 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):
 
2464
BzrDirFormat.register_format(BzrDirFormat4())
 
2465
BzrDirFormat.register_format(BzrDirFormat5())
 
2466
BzrDirFormat.register_format(BzrDirFormat6())
 
2467
__default_format = BzrDirMetaFormat1()
 
2468
BzrDirFormat.register_format(__default_format)
 
2469
BzrDirFormat._default_format = __default_format
 
2470
 
 
2471
 
 
2472
class Converter(object):
 
2473
    """Converts a disk format object from one format to another."""
 
2474
 
 
2475
    def convert(self, to_convert, pb):
 
2476
        """Perform the conversion of to_convert, giving feedback via pb.
 
2477
 
 
2478
        :param to_convert: The disk object to convert.
 
2479
        :param pb: a progress bar to use for progress information.
 
2480
        """
 
2481
 
 
2482
    def step(self, message):
 
2483
        """Update the pb by a step."""
 
2484
        self.count +=1
 
2485
        self.pb.update(message, self.count, self.total)
 
2486
 
 
2487
 
 
2488
class ConvertBzrDir4To5(Converter):
 
2489
    """Converts format 4 bzr dirs to format 5."""
 
2490
 
 
2491
    def __init__(self):
 
2492
        super(ConvertBzrDir4To5, self).__init__()
 
2493
        self.converted_revs = set()
 
2494
        self.absent_revisions = set()
 
2495
        self.text_count = 0
 
2496
        self.revisions = {}
 
2497
 
 
2498
    def convert(self, to_convert, pb):
 
2499
        """See Converter.convert()."""
 
2500
        self.bzrdir = to_convert
 
2501
        self.pb = pb
 
2502
        self.pb.note('starting upgrade from format 4 to 5')
 
2503
        if isinstance(self.bzrdir.transport, local.LocalTransport):
 
2504
            self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
 
2505
        self._convert_to_weaves()
 
2506
        return BzrDir.open(self.bzrdir.root_transport.base)
 
2507
 
 
2508
    def _convert_to_weaves(self):
 
2509
        self.pb.note('note: upgrade may be faster if all store files are ungzipped first')
 
2510
        try:
 
2511
            # TODO permissions
 
2512
            stat = self.bzrdir.transport.stat('weaves')
 
2513
            if not S_ISDIR(stat.st_mode):
 
2514
                self.bzrdir.transport.delete('weaves')
 
2515
                self.bzrdir.transport.mkdir('weaves')
 
2516
        except errors.NoSuchFile:
 
2517
            self.bzrdir.transport.mkdir('weaves')
 
2518
        # deliberately not a WeaveFile as we want to build it up slowly.
 
2519
        self.inv_weave = Weave('inventory')
 
2520
        # holds in-memory weaves for all files
 
2521
        self.text_weaves = {}
 
2522
        self.bzrdir.transport.delete('branch-format')
 
2523
        self.branch = self.bzrdir.open_branch()
 
2524
        self._convert_working_inv()
 
2525
        rev_history = self.branch.revision_history()
 
2526
        # to_read is a stack holding the revisions we still need to process;
 
2527
        # appending to it adds new highest-priority revisions
 
2528
        self.known_revisions = set(rev_history)
 
2529
        self.to_read = rev_history[-1:]
 
2530
        while self.to_read:
 
2531
            rev_id = self.to_read.pop()
 
2532
            if (rev_id not in self.revisions
 
2533
                and rev_id not in self.absent_revisions):
 
2534
                self._load_one_rev(rev_id)
 
2535
        self.pb.clear()
 
2536
        to_import = self._make_order()
 
2537
        for i, rev_id in enumerate(to_import):
 
2538
            self.pb.update('converting revision', i, len(to_import))
 
2539
            self._convert_one_rev(rev_id)
 
2540
        self.pb.clear()
 
2541
        self._write_all_weaves()
 
2542
        self._write_all_revs()
 
2543
        self.pb.note('upgraded to weaves:')
 
2544
        self.pb.note('  %6d revisions and inventories', len(self.revisions))
 
2545
        self.pb.note('  %6d revisions not present', len(self.absent_revisions))
 
2546
        self.pb.note('  %6d texts', self.text_count)
 
2547
        self._cleanup_spare_files_after_format4()
 
2548
        self.branch._transport.put_bytes(
 
2549
            'branch-format',
 
2550
            BzrDirFormat5().get_format_string(),
 
2551
            mode=self.bzrdir._get_file_mode())
 
2552
 
 
2553
    def _cleanup_spare_files_after_format4(self):
 
2554
        # FIXME working tree upgrade foo.
 
2555
        for n in 'merged-patches', 'pending-merged-patches':
 
2556
            try:
 
2557
                ## assert os.path.getsize(p) == 0
 
2558
                self.bzrdir.transport.delete(n)
 
2559
            except errors.NoSuchFile:
 
2560
                pass
 
2561
        self.bzrdir.transport.delete_tree('inventory-store')
 
2562
        self.bzrdir.transport.delete_tree('text-store')
 
2563
 
 
2564
    def _convert_working_inv(self):
 
2565
        inv = xml4.serializer_v4.read_inventory(
 
2566
                self.branch._transport.get('inventory'))
 
2567
        new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv, working=True)
 
2568
        self.branch._transport.put_bytes('inventory', new_inv_xml,
 
2569
            mode=self.bzrdir._get_file_mode())
 
2570
 
 
2571
    def _write_all_weaves(self):
 
2572
        controlweaves = WeaveStore(self.bzrdir.transport, prefixed=False)
 
2573
        weave_transport = self.bzrdir.transport.clone('weaves')
 
2574
        weaves = WeaveStore(weave_transport, prefixed=False)
 
2575
        transaction = WriteTransaction()
 
2576
 
 
2577
        try:
 
2578
            i = 0
 
2579
            for file_id, file_weave in self.text_weaves.items():
 
2580
                self.pb.update('writing weave', i, len(self.text_weaves))
 
2581
                weaves._put_weave(file_id, file_weave, transaction)
 
2582
                i += 1
 
2583
            self.pb.update('inventory', 0, 1)
 
2584
            controlweaves._put_weave('inventory', self.inv_weave, transaction)
 
2585
            self.pb.update('inventory', 1, 1)
 
2586
        finally:
 
2587
            self.pb.clear()
 
2588
 
 
2589
    def _write_all_revs(self):
 
2590
        """Write all revisions out in new form."""
 
2591
        self.bzrdir.transport.delete_tree('revision-store')
 
2592
        self.bzrdir.transport.mkdir('revision-store')
 
2593
        revision_transport = self.bzrdir.transport.clone('revision-store')
 
2594
        # TODO permissions
 
2595
        from bzrlib.xml5 import serializer_v5
 
2596
        from bzrlib.repofmt.weaverepo import RevisionTextStore
 
2597
        revision_store = RevisionTextStore(revision_transport,
 
2598
            serializer_v5, False, versionedfile.PrefixMapper(),
 
2599
            lambda:True, lambda:True)
 
2600
        try:
 
2601
            for i, rev_id in enumerate(self.converted_revs):
 
2602
                self.pb.update('write revision', i, len(self.converted_revs))
 
2603
                text = serializer_v5.write_revision_to_string(
 
2604
                    self.revisions[rev_id])
 
2605
                key = (rev_id,)
 
2606
                revision_store.add_lines(key, None, osutils.split_lines(text))
 
2607
        finally:
 
2608
            self.pb.clear()
 
2609
 
 
2610
    def _load_one_rev(self, rev_id):
 
2611
        """Load a revision object into memory.
 
2612
 
 
2613
        Any parents not either loaded or abandoned get queued to be
 
2614
        loaded."""
 
2615
        self.pb.update('loading revision',
 
2616
                       len(self.revisions),
 
2617
                       len(self.known_revisions))
 
2618
        if not self.branch.repository.has_revision(rev_id):
 
2619
            self.pb.clear()
 
2620
            self.pb.note('revision {%s} not present in branch; '
 
2621
                         'will be converted as a ghost',
 
2622
                         rev_id)
 
2623
            self.absent_revisions.add(rev_id)
 
2624
        else:
 
2625
            rev = self.branch.repository.get_revision(rev_id)
 
2626
            for parent_id in rev.parent_ids:
 
2627
                self.known_revisions.add(parent_id)
 
2628
                self.to_read.append(parent_id)
 
2629
            self.revisions[rev_id] = rev
 
2630
 
 
2631
    def _load_old_inventory(self, rev_id):
 
2632
        old_inv_xml = self.branch.repository.inventory_store.get(rev_id).read()
 
2633
        inv = xml4.serializer_v4.read_inventory_from_string(old_inv_xml)
 
2634
        inv.revision_id = rev_id
 
2635
        rev = self.revisions[rev_id]
 
2636
        return inv
 
2637
 
 
2638
    def _load_updated_inventory(self, rev_id):
 
2639
        inv_xml = self.inv_weave.get_text(rev_id)
 
2640
        inv = xml5.serializer_v5.read_inventory_from_string(inv_xml, rev_id)
 
2641
        return inv
 
2642
 
 
2643
    def _convert_one_rev(self, rev_id):
 
2644
        """Convert revision and all referenced objects to new format."""
 
2645
        rev = self.revisions[rev_id]
 
2646
        inv = self._load_old_inventory(rev_id)
 
2647
        present_parents = [p for p in rev.parent_ids
 
2648
                           if p not in self.absent_revisions]
 
2649
        self._convert_revision_contents(rev, inv, present_parents)
 
2650
        self._store_new_inv(rev, inv, present_parents)
 
2651
        self.converted_revs.add(rev_id)
 
2652
 
 
2653
    def _store_new_inv(self, rev, inv, present_parents):
 
2654
        new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
 
2655
        new_inv_sha1 = sha_string(new_inv_xml)
 
2656
        self.inv_weave.add_lines(rev.revision_id,
 
2657
                                 present_parents,
 
2658
                                 new_inv_xml.splitlines(True))
 
2659
        rev.inventory_sha1 = new_inv_sha1
 
2660
 
 
2661
    def _convert_revision_contents(self, rev, inv, present_parents):
 
2662
        """Convert all the files within a revision.
 
2663
 
 
2664
        Also upgrade the inventory to refer to the text revision ids."""
 
2665
        rev_id = rev.revision_id
 
2666
        mutter('converting texts of revision {%s}',
 
2667
               rev_id)
 
2668
        parent_invs = map(self._load_updated_inventory, present_parents)
 
2669
        entries = inv.iter_entries()
 
2670
        entries.next()
 
2671
        for path, ie in entries:
 
2672
            self._convert_file_version(rev, ie, parent_invs)
 
2673
 
 
2674
    def _convert_file_version(self, rev, ie, parent_invs):
 
2675
        """Convert one version of one file.
 
2676
 
 
2677
        The file needs to be added into the weave if it is a merge
 
2678
        of >=2 parents or if it's changed from its parent.
 
2679
        """
 
2680
        file_id = ie.file_id
 
2681
        rev_id = rev.revision_id
 
2682
        w = self.text_weaves.get(file_id)
 
2683
        if w is None:
 
2684
            w = Weave(file_id)
 
2685
            self.text_weaves[file_id] = w
 
2686
        text_changed = False
 
2687
        parent_candiate_entries = ie.parent_candidates(parent_invs)
 
2688
        heads = graph.Graph(self).heads(parent_candiate_entries.keys())
 
2689
        # XXX: Note that this is unordered - and this is tolerable because
 
2690
        # the previous code was also unordered.
 
2691
        previous_entries = dict((head, parent_candiate_entries[head]) for head
 
2692
            in heads)
 
2693
        self.snapshot_ie(previous_entries, ie, w, rev_id)
 
2694
        del ie.text_id
 
2695
 
 
2696
    def get_parent_map(self, revision_ids):
 
2697
        """See graph._StackedParentsProvider.get_parent_map"""
 
2698
        return dict((revision_id, self.revisions[revision_id])
 
2699
                    for revision_id in revision_ids
 
2700
                     if revision_id in self.revisions)
 
2701
 
 
2702
    def snapshot_ie(self, previous_revisions, ie, w, rev_id):
 
2703
        # TODO: convert this logic, which is ~= snapshot to
 
2704
        # a call to:. This needs the path figured out. rather than a work_tree
 
2705
        # a v4 revision_tree can be given, or something that looks enough like
 
2706
        # one to give the file content to the entry if it needs it.
 
2707
        # and we need something that looks like a weave store for snapshot to
 
2708
        # save against.
 
2709
        #ie.snapshot(rev, PATH, previous_revisions, REVISION_TREE, InMemoryWeaveStore(self.text_weaves))
 
2710
        if len(previous_revisions) == 1:
 
2711
            previous_ie = previous_revisions.values()[0]
 
2712
            if ie._unchanged(previous_ie):
 
2713
                ie.revision = previous_ie.revision
 
2714
                return
 
2715
        if ie.has_text():
 
2716
            text = self.branch.repository._text_store.get(ie.text_id)
 
2717
            file_lines = text.readlines()
 
2718
            w.add_lines(rev_id, previous_revisions, file_lines)
 
2719
            self.text_count += 1
 
2720
        else:
 
2721
            w.add_lines(rev_id, previous_revisions, [])
 
2722
        ie.revision = rev_id
 
2723
 
 
2724
    def _make_order(self):
 
2725
        """Return a suitable order for importing revisions.
 
2726
 
 
2727
        The order must be such that an revision is imported after all
 
2728
        its (present) parents.
 
2729
        """
 
2730
        todo = set(self.revisions.keys())
 
2731
        done = self.absent_revisions.copy()
 
2732
        order = []
 
2733
        while todo:
 
2734
            # scan through looking for a revision whose parents
 
2735
            # are all done
 
2736
            for rev_id in sorted(list(todo)):
 
2737
                rev = self.revisions[rev_id]
 
2738
                parent_ids = set(rev.parent_ids)
 
2739
                if parent_ids.issubset(done):
 
2740
                    # can take this one now
 
2741
                    order.append(rev_id)
 
2742
                    todo.remove(rev_id)
 
2743
                    done.add(rev_id)
 
2744
        return order
 
2745
 
 
2746
 
 
2747
class ConvertBzrDir5To6(Converter):
 
2748
    """Converts format 5 bzr dirs to format 6."""
 
2749
 
 
2750
    def convert(self, to_convert, pb):
 
2751
        """See Converter.convert()."""
 
2752
        self.bzrdir = to_convert
 
2753
        self.pb = pb
 
2754
        self.pb.note('starting upgrade from format 5 to 6')
 
2755
        self._convert_to_prefixed()
 
2756
        return BzrDir.open(self.bzrdir.root_transport.base)
 
2757
 
 
2758
    def _convert_to_prefixed(self):
 
2759
        from bzrlib.store import TransportStore
 
2760
        self.bzrdir.transport.delete('branch-format')
 
2761
        for store_name in ["weaves", "revision-store"]:
 
2762
            self.pb.note("adding prefixes to %s" % store_name)
 
2763
            store_transport = self.bzrdir.transport.clone(store_name)
 
2764
            store = TransportStore(store_transport, prefixed=True)
 
2765
            for urlfilename in store_transport.list_dir('.'):
 
2766
                filename = urlutils.unescape(urlfilename)
 
2767
                if (filename.endswith(".weave") or
 
2768
                    filename.endswith(".gz") or
 
2769
                    filename.endswith(".sig")):
 
2770
                    file_id, suffix = os.path.splitext(filename)
 
2771
                else:
 
2772
                    file_id = filename
 
2773
                    suffix = ''
 
2774
                new_name = store._mapper.map((file_id,)) + suffix
 
2775
                # FIXME keep track of the dirs made RBC 20060121
 
2776
                try:
 
2777
                    store_transport.move(filename, new_name)
 
2778
                except errors.NoSuchFile: # catches missing dirs strangely enough
 
2779
                    store_transport.mkdir(osutils.dirname(new_name))
 
2780
                    store_transport.move(filename, new_name)
 
2781
        self.bzrdir.transport.put_bytes(
 
2782
            'branch-format',
 
2783
            BzrDirFormat6().get_format_string(),
 
2784
            mode=self.bzrdir._get_file_mode())
 
2785
 
 
2786
 
 
2787
class ConvertBzrDir6ToMeta(Converter):
 
2788
    """Converts format 6 bzr dirs to metadirs."""
 
2789
 
 
2790
    def convert(self, to_convert, pb):
 
2791
        """See Converter.convert()."""
 
2792
        from bzrlib.repofmt.weaverepo import RepositoryFormat7
 
2793
        from bzrlib.branch import BzrBranchFormat5
 
2794
        self.bzrdir = to_convert
 
2795
        self.pb = pb
 
2796
        self.count = 0
 
2797
        self.total = 20 # the steps we know about
 
2798
        self.garbage_inventories = []
 
2799
        self.dir_mode = self.bzrdir._get_dir_mode()
 
2800
        self.file_mode = self.bzrdir._get_file_mode()
 
2801
 
 
2802
        self.pb.note('starting upgrade from format 6 to metadir')
 
2803
        self.bzrdir.transport.put_bytes(
 
2804
                'branch-format',
 
2805
                "Converting to format 6",
 
2806
                mode=self.file_mode)
 
2807
        # its faster to move specific files around than to open and use the apis...
 
2808
        # first off, nuke ancestry.weave, it was never used.
 
2809
        try:
 
2810
            self.step('Removing ancestry.weave')
 
2811
            self.bzrdir.transport.delete('ancestry.weave')
 
2812
        except errors.NoSuchFile:
 
2813
            pass
 
2814
        # find out whats there
 
2815
        self.step('Finding branch files')
 
2816
        last_revision = self.bzrdir.open_branch().last_revision()
 
2817
        bzrcontents = self.bzrdir.transport.list_dir('.')
 
2818
        for name in bzrcontents:
 
2819
            if name.startswith('basis-inventory.'):
 
2820
                self.garbage_inventories.append(name)
 
2821
        # create new directories for repository, working tree and branch
 
2822
        repository_names = [('inventory.weave', True),
 
2823
                            ('revision-store', True),
 
2824
                            ('weaves', True)]
 
2825
        self.step('Upgrading repository  ')
 
2826
        self.bzrdir.transport.mkdir('repository', mode=self.dir_mode)
 
2827
        self.make_lock('repository')
 
2828
        # we hard code the formats here because we are converting into
 
2829
        # the meta format. The meta format upgrader can take this to a
 
2830
        # future format within each component.
 
2831
        self.put_format('repository', RepositoryFormat7())
 
2832
        for entry in repository_names:
 
2833
            self.move_entry('repository', entry)
 
2834
 
 
2835
        self.step('Upgrading branch      ')
 
2836
        self.bzrdir.transport.mkdir('branch', mode=self.dir_mode)
 
2837
        self.make_lock('branch')
 
2838
        self.put_format('branch', BzrBranchFormat5())
 
2839
        branch_files = [('revision-history', True),
 
2840
                        ('branch-name', True),
 
2841
                        ('parent', False)]
 
2842
        for entry in branch_files:
 
2843
            self.move_entry('branch', entry)
 
2844
 
 
2845
        checkout_files = [('pending-merges', True),
 
2846
                          ('inventory', True),
 
2847
                          ('stat-cache', False)]
 
2848
        # If a mandatory checkout file is not present, the branch does not have
 
2849
        # a functional checkout. Do not create a checkout in the converted
 
2850
        # branch.
 
2851
        for name, mandatory in checkout_files:
 
2852
            if mandatory and name not in bzrcontents:
 
2853
                has_checkout = False
 
2854
                break
 
2855
        else:
 
2856
            has_checkout = True
 
2857
        if not has_checkout:
 
2858
            self.pb.note('No working tree.')
 
2859
            # If some checkout files are there, we may as well get rid of them.
 
2860
            for name, mandatory in checkout_files:
 
2861
                if name in bzrcontents:
 
2862
                    self.bzrdir.transport.delete(name)
 
2863
        else:
 
2864
            from bzrlib.workingtree import WorkingTreeFormat3
 
2865
            self.step('Upgrading working tree')
 
2866
            self.bzrdir.transport.mkdir('checkout', mode=self.dir_mode)
 
2867
            self.make_lock('checkout')
 
2868
            self.put_format(
 
2869
                'checkout', WorkingTreeFormat3())
 
2870
            self.bzrdir.transport.delete_multi(
 
2871
                self.garbage_inventories, self.pb)
 
2872
            for entry in checkout_files:
 
2873
                self.move_entry('checkout', entry)
 
2874
            if last_revision is not None:
 
2875
                self.bzrdir.transport.put_bytes(
 
2876
                    'checkout/last-revision', last_revision)
 
2877
        self.bzrdir.transport.put_bytes(
 
2878
            'branch-format',
 
2879
            BzrDirMetaFormat1().get_format_string(),
 
2880
            mode=self.file_mode)
 
2881
        return BzrDir.open(self.bzrdir.root_transport.base)
 
2882
 
 
2883
    def make_lock(self, name):
 
2884
        """Make a lock for the new control dir name."""
 
2885
        self.step('Make %s lock' % name)
 
2886
        ld = lockdir.LockDir(self.bzrdir.transport,
 
2887
                             '%s/lock' % name,
 
2888
                             file_modebits=self.file_mode,
 
2889
                             dir_modebits=self.dir_mode)
 
2890
        ld.create()
 
2891
 
 
2892
    def move_entry(self, new_dir, entry):
 
2893
        """Move then entry name into new_dir."""
 
2894
        name = entry[0]
 
2895
        mandatory = entry[1]
 
2896
        self.step('Moving %s' % name)
 
2897
        try:
 
2898
            self.bzrdir.transport.move(name, '%s/%s' % (new_dir, name))
 
2899
        except errors.NoSuchFile:
 
2900
            if mandatory:
 
2901
                raise
 
2902
 
 
2903
    def put_format(self, dirname, format):
 
2904
        self.bzrdir.transport.put_bytes('%s/format' % dirname,
 
2905
            format.get_format_string(),
 
2906
            self.file_mode)
 
2907
 
 
2908
 
 
2909
class ConvertMetaToMeta(Converter):
1833
2910
    """Converts the components of metadirs."""
1834
2911
 
1835
2912
    def __init__(self, target_format):
1842
2919
    def convert(self, to_convert, pb):
1843
2920
        """See Converter.convert()."""
1844
2921
        self.bzrdir = to_convert
1845
 
        self.pb = ui.ui_factory.nested_progress_bar()
 
2922
        self.pb = pb
1846
2923
        self.count = 0
1847
2924
        self.total = 1
1848
2925
        self.step('checking repository format')
1853
2930
        else:
1854
2931
            if not isinstance(repo._format, self.target_format.repository_format.__class__):
1855
2932
                from bzrlib.repository import CopyConverter
1856
 
                ui.ui_factory.note('starting repository conversion')
 
2933
                self.pb.note('starting repository conversion')
1857
2934
                converter = CopyConverter(self.target_format.repository_format)
1858
2935
                converter.convert(repo, pb)
1859
 
        for branch in self.bzrdir.list_branches():
 
2936
        try:
 
2937
            branch = self.bzrdir.open_branch()
 
2938
        except errors.NotBranchError:
 
2939
            pass
 
2940
        else:
1860
2941
            # TODO: conversions of Branch and Tree should be done by
1861
2942
            # InterXFormat lookups/some sort of registry.
1862
2943
            # Avoid circular imports
 
2944
            from bzrlib import branch as _mod_branch
1863
2945
            old = branch._format.__class__
1864
2946
            new = self.target_format.get_branch_format().__class__
1865
2947
            while old != new:
1876
2958
                      new is _mod_branch.BzrBranchFormat8):
1877
2959
                    branch_converter = _mod_branch.Converter7to8()
1878
2960
                else:
1879
 
                    raise errors.BadConversionTarget("No converter", new,
1880
 
                        branch._format)
 
2961
                    raise errors.BadConversionTarget("No converter", new)
1881
2962
                branch_converter.convert(branch)
1882
2963
                branch = self.bzrdir.open_branch()
1883
2964
                old = branch._format.__class__
1888
2969
        else:
1889
2970
            # TODO: conversions of Branch and Tree should be done by
1890
2971
            # InterXFormat lookups
1891
 
            if (isinstance(tree, workingtree_3.WorkingTree3) and
 
2972
            if (isinstance(tree, workingtree.WorkingTree3) and
1892
2973
                not isinstance(tree, workingtree_4.DirStateWorkingTree) and
1893
2974
                isinstance(self.target_format.workingtree_format,
1894
2975
                    workingtree_4.DirStateWorkingTreeFormat)):
1903
2984
                isinstance(self.target_format.workingtree_format,
1904
2985
                    workingtree_4.WorkingTreeFormat6)):
1905
2986
                workingtree_4.Converter4or5to6().convert(tree)
1906
 
        self.pb.finished()
1907
2987
        return to_convert
1908
2988
 
1909
2989
 
1910
 
controldir.ControlDirFormat.register_server_prober(RemoteBzrProber)
 
2990
# This is not in remote.py because it's relatively small, and needs to be
 
2991
# registered. Putting it in remote.py creates a circular import problem.
 
2992
# we can make it a lazy object if the control formats is turned into something
 
2993
# like a registry.
 
2994
class RemoteBzrDirFormat(BzrDirMetaFormat1):
 
2995
    """Format representing bzrdirs accessed via a smart server"""
 
2996
 
 
2997
    def __init__(self):
 
2998
        BzrDirMetaFormat1.__init__(self)
 
2999
        self._network_name = None
 
3000
 
 
3001
    def get_format_description(self):
 
3002
        return 'bzr remote bzrdir'
 
3003
 
 
3004
    def get_format_string(self):
 
3005
        raise NotImplementedError(self.get_format_string)
 
3006
 
 
3007
    def network_name(self):
 
3008
        if self._network_name:
 
3009
            return self._network_name
 
3010
        else:
 
3011
            raise AssertionError("No network name set.")
 
3012
 
 
3013
    @classmethod
 
3014
    def probe_transport(klass, transport):
 
3015
        """Return a RemoteBzrDirFormat object if it looks possible."""
 
3016
        try:
 
3017
            medium = transport.get_smart_medium()
 
3018
        except (NotImplementedError, AttributeError,
 
3019
                errors.TransportNotPossible, errors.NoSmartMedium,
 
3020
                errors.SmartProtocolError):
 
3021
            # no smart server, so not a branch for this format type.
 
3022
            raise errors.NotBranchError(path=transport.base)
 
3023
        else:
 
3024
            # Decline to open it if the server doesn't support our required
 
3025
            # version (3) so that the VFS-based transport will do it.
 
3026
            if medium.should_probe():
 
3027
                try:
 
3028
                    server_version = medium.protocol_version()
 
3029
                except errors.SmartProtocolError:
 
3030
                    # Apparently there's no usable smart server there, even though
 
3031
                    # the medium supports the smart protocol.
 
3032
                    raise errors.NotBranchError(path=transport.base)
 
3033
                if server_version != '2':
 
3034
                    raise errors.NotBranchError(path=transport.base)
 
3035
            return klass()
 
3036
 
 
3037
    def initialize_on_transport(self, transport):
 
3038
        try:
 
3039
            # hand off the request to the smart server
 
3040
            client_medium = transport.get_smart_medium()
 
3041
        except errors.NoSmartMedium:
 
3042
            # TODO: lookup the local format from a server hint.
 
3043
            local_dir_format = BzrDirMetaFormat1()
 
3044
            return local_dir_format.initialize_on_transport(transport)
 
3045
        client = _SmartClient(client_medium)
 
3046
        path = client.remote_path_from_transport(transport)
 
3047
        response = client.call('BzrDirFormat.initialize', path)
 
3048
        if response[0] != 'ok':
 
3049
            raise errors.SmartProtocolError('unexpected response code %s' % (response,))
 
3050
        format = RemoteBzrDirFormat()
 
3051
        self._supply_sub_formats_to(format)
 
3052
        return remote.RemoteBzrDir(transport, format)
 
3053
 
 
3054
    def parse_NoneTrueFalse(self, arg):
 
3055
        if not arg:
 
3056
            return None
 
3057
        if arg == 'False':
 
3058
            return False
 
3059
        if arg == 'True':
 
3060
            return True
 
3061
        raise AssertionError("invalid arg %r" % arg)
 
3062
 
 
3063
    def _serialize_NoneTrueFalse(self, arg):
 
3064
        if arg is False:
 
3065
            return 'False'
 
3066
        if arg:
 
3067
            return 'True'
 
3068
        return ''
 
3069
 
 
3070
    def _serialize_NoneString(self, arg):
 
3071
        return arg or ''
 
3072
 
 
3073
    def initialize_on_transport_ex(self, transport, use_existing_dir=False,
 
3074
        create_prefix=False, force_new_repo=False, stacked_on=None,
 
3075
        stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
 
3076
        shared_repo=False):
 
3077
        try:
 
3078
            # hand off the request to the smart server
 
3079
            client_medium = transport.get_smart_medium()
 
3080
        except errors.NoSmartMedium:
 
3081
            do_vfs = True
 
3082
        else:
 
3083
            # Decline to open it if the server doesn't support our required
 
3084
            # version (3) so that the VFS-based transport will do it.
 
3085
            if client_medium.should_probe():
 
3086
                try:
 
3087
                    server_version = client_medium.protocol_version()
 
3088
                    if server_version != '2':
 
3089
                        do_vfs = True
 
3090
                    else:
 
3091
                        do_vfs = False
 
3092
                except errors.SmartProtocolError:
 
3093
                    # Apparently there's no usable smart server there, even though
 
3094
                    # the medium supports the smart protocol.
 
3095
                    do_vfs = True
 
3096
            else:
 
3097
                do_vfs = False
 
3098
        if not do_vfs:
 
3099
            client = _SmartClient(client_medium)
 
3100
            path = client.remote_path_from_transport(transport)
 
3101
            if client_medium._is_remote_before((1, 15)):
 
3102
                do_vfs = True
 
3103
        if do_vfs:
 
3104
            # TODO: lookup the local format from a server hint.
 
3105
            local_dir_format = BzrDirMetaFormat1()
 
3106
            self._supply_sub_formats_to(local_dir_format)
 
3107
            return local_dir_format.initialize_on_transport_ex(transport,
 
3108
                use_existing_dir=use_existing_dir, create_prefix=create_prefix,
 
3109
                force_new_repo=force_new_repo, stacked_on=stacked_on,
 
3110
                stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
 
3111
                make_working_trees=make_working_trees, shared_repo=shared_repo,
 
3112
                vfs_only=True)
 
3113
        args = []
 
3114
        args.append(self._serialize_NoneTrueFalse(use_existing_dir))
 
3115
        args.append(self._serialize_NoneTrueFalse(create_prefix))
 
3116
        args.append(self._serialize_NoneTrueFalse(force_new_repo))
 
3117
        args.append(self._serialize_NoneString(stacked_on))
 
3118
        # stack_on_pwd is often/usually our transport
 
3119
        if stack_on_pwd:
 
3120
            try:
 
3121
                stack_on_pwd = transport.relpath(stack_on_pwd)
 
3122
                if not stack_on_pwd:
 
3123
                    stack_on_pwd = '.'
 
3124
            except errors.PathNotChild:
 
3125
                pass
 
3126
        args.append(self._serialize_NoneString(stack_on_pwd))
 
3127
        args.append(self._serialize_NoneString(repo_format_name))
 
3128
        args.append(self._serialize_NoneTrueFalse(make_working_trees))
 
3129
        args.append(self._serialize_NoneTrueFalse(shared_repo))
 
3130
        if self._network_name is None:
 
3131
            self._network_name = \
 
3132
            BzrDirFormat.get_default_format().network_name()
 
3133
        try:
 
3134
            response = client.call('BzrDirFormat.initialize_ex',
 
3135
                self.network_name(), path, *args)
 
3136
        except errors.UnknownSmartMethod:
 
3137
            local_dir_format = BzrDirMetaFormat1()
 
3138
            self._supply_sub_formats_to(local_dir_format)
 
3139
            return local_dir_format.initialize_on_transport_ex(transport,
 
3140
                use_existing_dir=use_existing_dir, create_prefix=create_prefix,
 
3141
                force_new_repo=force_new_repo, stacked_on=stacked_on,
 
3142
                stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
 
3143
                make_working_trees=make_working_trees, shared_repo=shared_repo,
 
3144
                vfs_only=True)
 
3145
        repo_path = response[0]
 
3146
        bzrdir_name = response[6]
 
3147
        require_stacking = response[7]
 
3148
        require_stacking = self.parse_NoneTrueFalse(require_stacking)
 
3149
        format = RemoteBzrDirFormat()
 
3150
        format._network_name = bzrdir_name
 
3151
        self._supply_sub_formats_to(format)
 
3152
        bzrdir = remote.RemoteBzrDir(transport, format)
 
3153
        if repo_path:
 
3154
            repo_format = remote.response_tuple_to_repo_format(response[1:])
 
3155
            if repo_path == '.':
 
3156
                repo_path = ''
 
3157
            if repo_path:
 
3158
                repo_bzrdir_format = RemoteBzrDirFormat()
 
3159
                repo_bzrdir_format._network_name = response[5]
 
3160
                repo_bzr = remote.RemoteBzrDir(transport.clone(repo_path),
 
3161
                    repo_bzrdir_format)
 
3162
            else:
 
3163
                repo_bzr = bzrdir
 
3164
            final_stack = response[8] or None
 
3165
            final_stack_pwd = response[9] or None
 
3166
            remote_repo = remote.RemoteRepository(repo_bzr, repo_format)
 
3167
            policy = UseExistingRepository(remote_repo, final_stack,
 
3168
                final_stack_pwd, require_stacking)
 
3169
            policy.acquire_repository()
 
3170
        else:
 
3171
            remote_repo = None
 
3172
            policy = None
 
3173
        return remote_repo, bzrdir, require_stacking, policy
 
3174
 
 
3175
    def _open(self, transport):
 
3176
        return remote.RemoteBzrDir(transport, self)
 
3177
 
 
3178
    def __eq__(self, other):
 
3179
        if not isinstance(other, RemoteBzrDirFormat):
 
3180
            return False
 
3181
        return self.get_format_description() == other.get_format_description()
 
3182
 
 
3183
    def __return_repository_format(self):
 
3184
        # Always return a RemoteRepositoryFormat object, but if a specific bzr
 
3185
        # repository format has been asked for, tell the RemoteRepositoryFormat
 
3186
        # that it should use that for init() etc.
 
3187
        result = remote.RemoteRepositoryFormat()
 
3188
        custom_format = getattr(self, '_repository_format', None)
 
3189
        if custom_format:
 
3190
            if isinstance(custom_format, remote.RemoteRepositoryFormat):
 
3191
                return custom_format
 
3192
            else:
 
3193
                # We will use the custom format to create repositories over the
 
3194
                # wire; expose its details like rich_root_data for code to
 
3195
                # query
 
3196
                result._custom_format = custom_format
 
3197
        return result
 
3198
 
 
3199
    def get_branch_format(self):
 
3200
        result = BzrDirMetaFormat1.get_branch_format(self)
 
3201
        if not isinstance(result, remote.RemoteBranchFormat):
 
3202
            new_result = remote.RemoteBranchFormat()
 
3203
            new_result._custom_format = result
 
3204
            # cache the result
 
3205
            self.set_branch_format(new_result)
 
3206
            result = new_result
 
3207
        return result
 
3208
 
 
3209
    repository_format = property(__return_repository_format,
 
3210
        BzrDirMetaFormat1._set_repository_format) #.im_func)
 
3211
 
 
3212
 
 
3213
BzrDirFormat.register_control_server_format(RemoteBzrDirFormat)
 
3214
 
 
3215
 
 
3216
class BzrDirFormatInfo(object):
 
3217
 
 
3218
    def __init__(self, native, deprecated, hidden, experimental):
 
3219
        self.deprecated = deprecated
 
3220
        self.native = native
 
3221
        self.hidden = hidden
 
3222
        self.experimental = experimental
 
3223
 
 
3224
 
 
3225
class BzrDirFormatRegistry(registry.Registry):
 
3226
    """Registry of user-selectable BzrDir subformats.
 
3227
 
 
3228
    Differs from BzrDirFormat._control_formats in that it provides sub-formats,
 
3229
    e.g. BzrDirMeta1 with weave repository.  Also, it's more user-oriented.
 
3230
    """
 
3231
 
 
3232
    def __init__(self):
 
3233
        """Create a BzrDirFormatRegistry."""
 
3234
        self._aliases = set()
 
3235
        self._registration_order = list()
 
3236
        super(BzrDirFormatRegistry, self).__init__()
 
3237
 
 
3238
    def aliases(self):
 
3239
        """Return a set of the format names which are aliases."""
 
3240
        return frozenset(self._aliases)
 
3241
 
 
3242
    def register_metadir(self, key,
 
3243
             repository_format, help, native=True, deprecated=False,
 
3244
             branch_format=None,
 
3245
             tree_format=None,
 
3246
             hidden=False,
 
3247
             experimental=False,
 
3248
             alias=False):
 
3249
        """Register a metadir subformat.
 
3250
 
 
3251
        These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
 
3252
        by the Repository/Branch/WorkingTreeformats.
 
3253
 
 
3254
        :param repository_format: The fully-qualified repository format class
 
3255
            name as a string.
 
3256
        :param branch_format: Fully-qualified branch format class name as
 
3257
            a string.
 
3258
        :param tree_format: Fully-qualified tree format class name as
 
3259
            a string.
 
3260
        """
 
3261
        # This should be expanded to support setting WorkingTree and Branch
 
3262
        # formats, once BzrDirMetaFormat1 supports that.
 
3263
        def _load(full_name):
 
3264
            mod_name, factory_name = full_name.rsplit('.', 1)
 
3265
            try:
 
3266
                mod = __import__(mod_name, globals(), locals(),
 
3267
                        [factory_name])
 
3268
            except ImportError, e:
 
3269
                raise ImportError('failed to load %s: %s' % (full_name, e))
 
3270
            try:
 
3271
                factory = getattr(mod, factory_name)
 
3272
            except AttributeError:
 
3273
                raise AttributeError('no factory %s in module %r'
 
3274
                    % (full_name, mod))
 
3275
            return factory()
 
3276
 
 
3277
        def helper():
 
3278
            bd = BzrDirMetaFormat1()
 
3279
            if branch_format is not None:
 
3280
                bd.set_branch_format(_load(branch_format))
 
3281
            if tree_format is not None:
 
3282
                bd.workingtree_format = _load(tree_format)
 
3283
            if repository_format is not None:
 
3284
                bd.repository_format = _load(repository_format)
 
3285
            return bd
 
3286
        self.register(key, helper, help, native, deprecated, hidden,
 
3287
            experimental, alias)
 
3288
 
 
3289
    def register(self, key, factory, help, native=True, deprecated=False,
 
3290
                 hidden=False, experimental=False, alias=False):
 
3291
        """Register a BzrDirFormat factory.
 
3292
 
 
3293
        The factory must be a callable that takes one parameter: the key.
 
3294
        It must produce an instance of the BzrDirFormat when called.
 
3295
 
 
3296
        This function mainly exists to prevent the info object from being
 
3297
        supplied directly.
 
3298
        """
 
3299
        registry.Registry.register(self, key, factory, help,
 
3300
            BzrDirFormatInfo(native, deprecated, hidden, experimental))
 
3301
        if alias:
 
3302
            self._aliases.add(key)
 
3303
        self._registration_order.append(key)
 
3304
 
 
3305
    def register_lazy(self, key, module_name, member_name, help, native=True,
 
3306
        deprecated=False, hidden=False, experimental=False, alias=False):
 
3307
        registry.Registry.register_lazy(self, key, module_name, member_name,
 
3308
            help, BzrDirFormatInfo(native, deprecated, hidden, experimental))
 
3309
        if alias:
 
3310
            self._aliases.add(key)
 
3311
        self._registration_order.append(key)
 
3312
 
 
3313
    def set_default(self, key):
 
3314
        """Set the 'default' key to be a clone of the supplied key.
 
3315
 
 
3316
        This method must be called once and only once.
 
3317
        """
 
3318
        registry.Registry.register(self, 'default', self.get(key),
 
3319
            self.get_help(key), info=self.get_info(key))
 
3320
        self._aliases.add('default')
 
3321
 
 
3322
    def set_default_repository(self, key):
 
3323
        """Set the FormatRegistry default and Repository default.
 
3324
 
 
3325
        This is a transitional method while Repository.set_default_format
 
3326
        is deprecated.
 
3327
        """
 
3328
        if 'default' in self:
 
3329
            self.remove('default')
 
3330
        self.set_default(key)
 
3331
        format = self.get('default')()
 
3332
 
 
3333
    def make_bzrdir(self, key):
 
3334
        return self.get(key)()
 
3335
 
 
3336
    def help_topic(self, topic):
 
3337
        output = ""
 
3338
        default_realkey = None
 
3339
        default_help = self.get_help('default')
 
3340
        help_pairs = []
 
3341
        for key in self._registration_order:
 
3342
            if key == 'default':
 
3343
                continue
 
3344
            help = self.get_help(key)
 
3345
            if help == default_help:
 
3346
                default_realkey = key
 
3347
            else:
 
3348
                help_pairs.append((key, help))
 
3349
 
 
3350
        def wrapped(key, help, info):
 
3351
            if info.native:
 
3352
                help = '(native) ' + help
 
3353
            return ':%s:\n%s\n\n' % (key,
 
3354
                    textwrap.fill(help, initial_indent='    ',
 
3355
                    subsequent_indent='    '))
 
3356
        if default_realkey is not None:
 
3357
            output += wrapped(default_realkey, '(default) %s' % default_help,
 
3358
                              self.get_info('default'))
 
3359
        deprecated_pairs = []
 
3360
        experimental_pairs = []
 
3361
        for key, help in help_pairs:
 
3362
            info = self.get_info(key)
 
3363
            if info.hidden:
 
3364
                continue
 
3365
            elif info.deprecated:
 
3366
                deprecated_pairs.append((key, help))
 
3367
            elif info.experimental:
 
3368
                experimental_pairs.append((key, help))
 
3369
            else:
 
3370
                output += wrapped(key, help, info)
 
3371
        output += "\nSee ``bzr help formats`` for more about storage formats."
 
3372
        other_output = ""
 
3373
        if len(experimental_pairs) > 0:
 
3374
            other_output += "Experimental formats are shown below.\n\n"
 
3375
            for key, help in experimental_pairs:
 
3376
                info = self.get_info(key)
 
3377
                other_output += wrapped(key, help, info)
 
3378
        else:
 
3379
            other_output += \
 
3380
                "No experimental formats are available.\n\n"
 
3381
        if len(deprecated_pairs) > 0:
 
3382
            other_output += "\nDeprecated formats are shown below.\n\n"
 
3383
            for key, help in deprecated_pairs:
 
3384
                info = self.get_info(key)
 
3385
                other_output += wrapped(key, help, info)
 
3386
        else:
 
3387
            other_output += \
 
3388
                "\nNo deprecated formats are available.\n\n"
 
3389
        other_output += \
 
3390
            "\nSee ``bzr help formats`` for more about storage formats."
 
3391
 
 
3392
        if topic == 'other-formats':
 
3393
            return other_output
 
3394
        else:
 
3395
            return output
1911
3396
 
1912
3397
 
1913
3398
class RepositoryAcquisitionPolicy(object):
1942
3427
            try:
1943
3428
                stack_on = urlutils.rebase_url(self._stack_on,
1944
3429
                    self._stack_on_pwd,
1945
 
                    branch.user_url)
 
3430
                    branch.bzrdir.root_transport.base)
1946
3431
            except errors.InvalidRebaseURLs:
1947
3432
                stack_on = self._get_full_stack_on()
1948
3433
        try:
1952
3437
            if self._require_stacking:
1953
3438
                raise
1954
3439
 
1955
 
    def requires_stacking(self):
1956
 
        """Return True if this policy requires stacking."""
1957
 
        return self._stack_on is not None and self._require_stacking
1958
 
 
1959
3440
    def _get_full_stack_on(self):
1960
3441
        """Get a fully-qualified URL for the stack_on location."""
1961
3442
        if self._stack_on is None:
1994
3475
 
1995
3476
        Implementations may create a new repository or use a pre-exising
1996
3477
        repository.
1997
 
 
1998
3478
        :param make_working_trees: If creating a repository, set
1999
3479
            make_working_trees to this value (if non-None)
2000
3480
        :param shared: If creating a repository, make it shared if True
2009
3489
 
2010
3490
    def __init__(self, bzrdir, stack_on=None, stack_on_pwd=None,
2011
3491
                 require_stacking=False):
2012
 
        """Constructor.
2013
 
 
 
3492
        """
 
3493
        Constructor.
2014
3494
        :param bzrdir: The bzrdir to create the repository on.
2015
3495
        :param stack_on: A location to stack on
2016
3496
        :param stack_on_pwd: If stack_on is relative, the location it is
2027
3507
        """
2028
3508
        stack_on = self._get_full_stack_on()
2029
3509
        if stack_on:
 
3510
            # Stacking is desired. requested by the target, but does the place it
 
3511
            # points at support stacking? If it doesn't then we should
 
3512
            # not implicitly upgrade. We check this here.
2030
3513
            format = self._bzrdir._format
2031
 
            format.require_stacking(stack_on=stack_on,
2032
 
                                    possible_transports=[self._bzrdir.root_transport])
 
3514
            if not (format.repository_format.supports_external_lookups
 
3515
                and format.get_branch_format().supports_stacking()):
 
3516
                # May need to upgrade - but only do if the target also
 
3517
                # supports stacking. Note that this currently wastes
 
3518
                # network round trips to check - but we only do this
 
3519
                # when the source can't stack so it will fade away
 
3520
                # as people do upgrade.
 
3521
                branch_format = None
 
3522
                repo_format = None
 
3523
                try:
 
3524
                    target_dir = BzrDir.open(stack_on,
 
3525
                        possible_transports=[self._bzrdir.root_transport])
 
3526
                except errors.NotBranchError:
 
3527
                    # Nothing there, don't change formats
 
3528
                    pass
 
3529
                except errors.JailBreak:
 
3530
                    # stack_on is inaccessible, JFDI.
 
3531
                    if format.repository_format.rich_root_data:
 
3532
                        repo_format = pack_repo.RepositoryFormatKnitPack6RichRoot()
 
3533
                    else:
 
3534
                        repo_format = pack_repo.RepositoryFormatKnitPack6()
 
3535
                    branch_format = branch.BzrBranchFormat7()
 
3536
                else:
 
3537
                    try:
 
3538
                        target_branch = target_dir.open_branch()
 
3539
                    except errors.NotBranchError:
 
3540
                        # No branch, don't change formats
 
3541
                        pass
 
3542
                    else:
 
3543
                        branch_format = target_branch._format
 
3544
                        repo_format = target_branch.repository._format
 
3545
                        if not (branch_format.supports_stacking()
 
3546
                            and repo_format.supports_external_lookups):
 
3547
                            # Doesn't stack itself, don't force an upgrade
 
3548
                            branch_format = None
 
3549
                            repo_format = None
 
3550
                if branch_format and repo_format:
 
3551
                    # Does support stacking, use its format.
 
3552
                    format.repository_format = repo_format
 
3553
                    format.set_branch_format(branch_format)
 
3554
                    note('Source format does not support stacking, '
 
3555
                        'using format: \'%s\'\n  %s\n',
 
3556
                        branch_format.get_format_description(),
 
3557
                        repo_format.get_format_description())
2033
3558
            if not self._require_stacking:
2034
3559
                # We have picked up automatic stacking somewhere.
2035
3560
                note('Using default stacking branch %s at %s', self._stack_on,
2068
3593
        return self._repository, False
2069
3594
 
2070
3595
 
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',
 
3596
# Please register new formats after old formats so that formats
 
3597
# appear in chronological order and format descriptions can build
 
3598
# on previous ones.
 
3599
format_registry = BzrDirFormatRegistry()
 
3600
# The pre-0.8 formats have their repository format network name registered in
 
3601
# repository.py. MetaDir formats have their repository format network name
 
3602
# inferred from their disk format string.
 
3603
format_registry.register('weave', BzrDirFormat6,
 
3604
    'Pre-0.8 format.  Slower than knit and does not'
 
3605
    ' support checkouts or shared repositories.',
 
3606
    deprecated=True)
 
3607
format_registry.register_metadir('metaweave',
 
3608
    'bzrlib.repofmt.weaverepo.RepositoryFormat7',
 
3609
    'Transitional format in 0.8.  Slower than knit.',
 
3610
    branch_format='bzrlib.branch.BzrBranchFormat5',
 
3611
    tree_format='bzrlib.workingtree.WorkingTreeFormat3',
 
3612
    deprecated=True)
 
3613
format_registry.register_metadir('knit',
2116
3614
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2117
3615
    'Format using knits.  Recommended for interoperation with bzr <= 0.14.',
2118
3616
    branch_format='bzrlib.branch.BzrBranchFormat5',
2119
 
    tree_format='bzrlib.workingtree_3.WorkingTreeFormat3',
2120
 
    hidden=True,
 
3617
    tree_format='bzrlib.workingtree.WorkingTreeFormat3',
2121
3618
    deprecated=True)
2122
 
register_metadir(controldir.format_registry, 'dirstate',
 
3619
format_registry.register_metadir('dirstate',
2123
3620
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2124
3621
    help='New in 0.15: Fast local operations. Compatible with bzr 0.8 and '
2125
3622
        'above when accessed over the network.',
2126
3623
    branch_format='bzrlib.branch.BzrBranchFormat5',
2127
 
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2128
 
    hidden=True,
 
3624
    # this uses bzrlib.workingtree.WorkingTreeFormat4 because importing
 
3625
    # directly from workingtree_4 triggers a circular import.
 
3626
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2129
3627
    deprecated=True)
2130
 
register_metadir(controldir.format_registry, 'dirstate-tags',
 
3628
format_registry.register_metadir('dirstate-tags',
2131
3629
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2132
3630
    help='New in 0.15: Fast local operations and improved scaling for '
2133
3631
        'network operations. Additionally adds support for tags.'
2134
3632
        ' Incompatible with bzr < 0.15.',
2135
3633
    branch_format='bzrlib.branch.BzrBranchFormat6',
2136
 
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2137
 
    hidden=True,
 
3634
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2138
3635
    deprecated=True)
2139
 
register_metadir(controldir.format_registry, 'rich-root',
 
3636
format_registry.register_metadir('rich-root',
2140
3637
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
2141
3638
    help='New in 1.0.  Better handling of tree roots.  Incompatible with'
2142
3639
        ' bzr < 1.0.',
2143
3640
    branch_format='bzrlib.branch.BzrBranchFormat6',
2144
 
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2145
 
    hidden=True,
 
3641
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2146
3642
    deprecated=True)
2147
 
register_metadir(controldir.format_registry, 'dirstate-with-subtree',
 
3643
format_registry.register_metadir('dirstate-with-subtree',
2148
3644
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
2149
3645
    help='New in 0.15: Fast local operations and improved scaling for '
2150
3646
        'network operations. Additionally adds support for versioning nested '
2151
3647
        'bzr branches. Incompatible with bzr < 0.15.',
2152
3648
    branch_format='bzrlib.branch.BzrBranchFormat6',
2153
 
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
3649
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2154
3650
    experimental=True,
2155
3651
    hidden=True,
2156
3652
    )
2157
 
register_metadir(controldir.format_registry, 'pack-0.92',
2158
 
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack1',
 
3653
format_registry.register_metadir('pack-0.92',
 
3654
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack1',
2159
3655
    help='New in 0.92: Pack-based format with data compatible with '
2160
3656
        'dirstate-tags format repositories. Interoperates with '
2161
3657
        'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
2162
 
        ,
 
3658
        'Previously called knitpack-experimental.  '
 
3659
        'For more information, see '
 
3660
        'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
2163
3661
    branch_format='bzrlib.branch.BzrBranchFormat6',
2164
 
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
3662
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2165
3663
    )
2166
 
register_metadir(controldir.format_registry, 'pack-0.92-subtree',
2167
 
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack3',
 
3664
format_registry.register_metadir('pack-0.92-subtree',
 
3665
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack3',
2168
3666
    help='New in 0.92: Pack-based format with data compatible with '
2169
3667
        'dirstate-with-subtree format repositories. Interoperates with '
2170
3668
        'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
2171
 
        ,
 
3669
        'Previously called knitpack-experimental.  '
 
3670
        'For more information, see '
 
3671
        'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
2172
3672
    branch_format='bzrlib.branch.BzrBranchFormat6',
2173
 
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
3673
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2174
3674
    hidden=True,
2175
3675
    experimental=True,
2176
3676
    )
2177
 
register_metadir(controldir.format_registry, 'rich-root-pack',
2178
 
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack4',
 
3677
format_registry.register_metadir('rich-root-pack',
 
3678
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
2179
3679
    help='New in 1.0: A variant of pack-0.92 that supports rich-root data '
2180
3680
         '(needed for bzr-svn and bzr-git).',
2181
3681
    branch_format='bzrlib.branch.BzrBranchFormat6',
2182
 
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2183
 
    hidden=True,
 
3682
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2184
3683
    )
2185
 
register_metadir(controldir.format_registry, '1.6',
2186
 
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack5',
 
3684
format_registry.register_metadir('1.6',
 
3685
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5',
2187
3686
    help='A format that allows a branch to indicate that there is another '
2188
3687
         '(stacked) repository that should be used to access data that is '
2189
3688
         'not present locally.',
2190
3689
    branch_format='bzrlib.branch.BzrBranchFormat7',
2191
 
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2192
 
    hidden=True,
 
3690
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2193
3691
    )
2194
 
register_metadir(controldir.format_registry, '1.6.1-rich-root',
2195
 
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack5RichRoot',
 
3692
format_registry.register_metadir('1.6.1-rich-root',
 
3693
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5RichRoot',
2196
3694
    help='A variant of 1.6 that supports rich-root data '
2197
3695
         '(needed for bzr-svn and bzr-git).',
2198
3696
    branch_format='bzrlib.branch.BzrBranchFormat7',
2199
 
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2200
 
    hidden=True,
 
3697
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2201
3698
    )
2202
 
register_metadir(controldir.format_registry, '1.9',
2203
 
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6',
 
3699
format_registry.register_metadir('1.9',
 
3700
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
2204
3701
    help='A repository format using B+tree indexes. These indexes '
2205
3702
         'are smaller in size, have smarter caching and provide faster '
2206
3703
         'performance for most operations.',
2207
3704
    branch_format='bzrlib.branch.BzrBranchFormat7',
2208
 
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2209
 
    hidden=True,
 
3705
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2210
3706
    )
2211
 
register_metadir(controldir.format_registry, '1.9-rich-root',
2212
 
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6RichRoot',
 
3707
format_registry.register_metadir('1.9-rich-root',
 
3708
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
2213
3709
    help='A variant of 1.9 that supports rich-root data '
2214
3710
         '(needed for bzr-svn and bzr-git).',
2215
3711
    branch_format='bzrlib.branch.BzrBranchFormat7',
2216
 
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2217
 
    hidden=True,
 
3712
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2218
3713
    )
2219
 
register_metadir(controldir.format_registry, '1.14',
2220
 
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6',
 
3714
format_registry.register_metadir('1.14',
 
3715
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
2221
3716
    help='A working-tree format that supports content filtering.',
2222
3717
    branch_format='bzrlib.branch.BzrBranchFormat7',
2223
 
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat5',
 
3718
    tree_format='bzrlib.workingtree.WorkingTreeFormat5',
2224
3719
    )
2225
 
register_metadir(controldir.format_registry, '1.14-rich-root',
2226
 
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6RichRoot',
 
3720
format_registry.register_metadir('1.14-rich-root',
 
3721
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
2227
3722
    help='A variant of 1.14 that supports rich-root data '
2228
3723
         '(needed for bzr-svn and bzr-git).',
2229
3724
    branch_format='bzrlib.branch.BzrBranchFormat7',
2230
 
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat5',
 
3725
    tree_format='bzrlib.workingtree.WorkingTreeFormat5',
2231
3726
    )
2232
3727
# 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',
 
3728
format_registry.register_metadir('development-rich-root',
 
3729
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
 
3730
    help='Current development format. Supports rich roots. Can convert data '
 
3731
        'to and from rich-root-pack (and anything compatible with '
 
3732
        'rich-root-pack) format repositories. Repositories and branches in '
 
3733
        'this format can only be read by bzr.dev. Please read '
 
3734
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
 
3735
        'before use.',
 
3736
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
3737
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
 
3738
    experimental=True,
 
3739
    alias=True,
 
3740
    )
 
3741
format_registry.register_metadir('development-subtree',
 
3742
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment2Subtree',
2235
3743
    help='Current development format, subtree variant. Can convert data to and '
2236
3744
        'from pack-0.92-subtree (and anything compatible with '
2237
3745
        'pack-0.92-subtree) format repositories. Repositories and branches in '
2238
3746
        'this format can only be read by bzr.dev. Please read '
2239
 
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
 
3747
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
2240
3748
        'before use.',
2241
3749
    branch_format='bzrlib.branch.BzrBranchFormat7',
2242
 
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
 
3750
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
2243
3751
    experimental=True,
2244
 
    hidden=True,
2245
3752
    alias=False, # Restore to being an alias when an actual development subtree format is added
2246
3753
                 # This current non-alias status is simply because we did not introduce a
2247
3754
                 # chk based subtree format.
2248
3755
    )
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
3756
 
2264
3757
# 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',
2268
 
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
2269
 
    help='First format for bzr 2.0 series.\n'
2270
 
        'Uses group-compress storage.\n'
2271
 
        'Provides rich roots which are a one-way transition.\n',
2272
 
        # 'storage in packs, 255-way hashed CHK inventory, bencode revision, group compress, '
2273
 
        # 'rich roots. Supported by bzr 1.16 and later.',
 
3758
format_registry.register_metadir('development6-rich-root',
 
3759
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
 
3760
    help='pack-1.9 with 255-way hashed CHK inv, group compress, rich roots '
 
3761
        'Please read '
 
3762
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
 
3763
        'before use.',
2274
3764
    branch_format='bzrlib.branch.BzrBranchFormat7',
2275
 
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
2276
 
    experimental=False,
 
3765
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
 
3766
    hidden=True,
 
3767
    experimental=True,
2277
3768
    )
2278
3769
 
2279
3770
# The following format should be an alias for the rich root equivalent 
2280
3771
# of the default format
2281
 
register_metadir(controldir.format_registry, 'default-rich-root',
2282
 
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
2283
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
2284
 
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
 
3772
format_registry.register_metadir('default-rich-root',
 
3773
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
 
3774
    help='Default format, rich root variant. (needed for bzr-svn and bzr-git).',
 
3775
    branch_format='bzrlib.branch.BzrBranchFormat6',
 
3776
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2285
3777
    alias=True,
2286
 
    hidden=True,
2287
 
    help='Same as 2a.')
2288
 
 
 
3778
    )
2289
3779
# The current format that is made on 'bzr init'.
2290
 
format_name = config.GlobalConfig().get_user_option('default_format')
2291
 
if format_name is None:
2292
 
    controldir.format_registry.set_default('2a')
2293
 
else:
2294
 
    controldir.format_registry.set_default(format_name)
2295
 
 
2296
 
# XXX 2010-08-20 JRV: There is still a lot of code relying on
2297
 
# bzrlib.bzrdir.format_registry existing. When BzrDir.create/BzrDir.open/etc
2298
 
# get changed to ControlDir.create/ControlDir.open/etc this should be removed.
2299
 
format_registry = controldir.format_registry
 
3780
format_registry.set_default('pack-0.92')