~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/bzrdir.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2010-10-05 21:15:13 UTC
  • mfrom: (5448.3.5 374700-Add-gnu-lsh-support)
  • Revision ID: pqm@pqm.ubuntu.com-20101005211513-whouyj5t7oo92gmq
(gz) Add support for GNU lsh as a secure shell client (Matthew Gordon)

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2006-2011 Canonical Ltd
 
1
# Copyright (C) 2006-2010 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
25
25
objects returned.
26
26
"""
27
27
 
28
 
from __future__ import absolute_import
 
28
# TODO: Move old formats into a plugin to make this file smaller.
29
29
 
 
30
import os
30
31
import sys
 
32
import warnings
31
33
 
32
34
from bzrlib.lazy_import import lazy_import
33
35
lazy_import(globals(), """
 
36
from stat import S_ISDIR
 
37
 
34
38
import bzrlib
35
39
from bzrlib import (
36
 
    branch as _mod_branch,
37
 
    cleanup,
 
40
    branch,
 
41
    config,
 
42
    controldir,
38
43
    errors,
39
 
    fetch,
40
44
    graph,
41
45
    lockable_files,
42
46
    lockdir,
43
47
    osutils,
44
 
    pyutils,
45
48
    remote,
46
49
    repository,
47
50
    revision as _mod_revision,
48
 
    transport as _mod_transport,
49
51
    ui,
50
52
    urlutils,
51
 
    vf_search,
 
53
    versionedfile,
52
54
    win32utils,
53
 
    workingtree_3,
 
55
    workingtree,
54
56
    workingtree_4,
55
 
    )
56
 
from bzrlib.branchfmt import fullhistory as fullhistorybranch
57
 
from bzrlib.repofmt import knitpack_repo
 
57
    xml4,
 
58
    xml5,
 
59
    )
 
60
from bzrlib.osutils import (
 
61
    sha_string,
 
62
    )
 
63
from bzrlib.push import (
 
64
    PushResult,
 
65
    )
 
66
from bzrlib.repofmt import pack_repo
 
67
from bzrlib.smart.client import _SmartClient
 
68
from bzrlib.store.versioned import WeaveStore
 
69
from bzrlib.transactions import WriteTransaction
58
70
from bzrlib.transport import (
59
71
    do_catching_redirections,
 
72
    get_transport,
60
73
    local,
61
74
    )
62
 
from bzrlib.i18n import gettext
 
75
from bzrlib.weave import Weave
63
76
""")
64
77
 
65
78
from bzrlib.trace import (
66
79
    mutter,
67
80
    note,
 
81
    warning,
68
82
    )
69
83
 
70
84
from bzrlib import (
71
 
    config,
72
 
    controldir,
 
85
    hooks,
73
86
    registry,
74
 
    )
75
 
from bzrlib.symbol_versioning import (
76
 
    deprecated_in,
77
 
    deprecated_method,
 
87
    symbol_versioning,
78
88
    )
79
89
 
80
90
 
127
137
            # No repo, no problem.
128
138
            pass
129
139
 
 
140
    @staticmethod
 
141
    def _check_supported(format, allow_unsupported,
 
142
        recommend_upgrade=True,
 
143
        basedir=None):
 
144
        """Give an error or warning on old formats.
 
145
 
 
146
        :param format: may be any kind of format - workingtree, branch,
 
147
        or repository.
 
148
 
 
149
        :param allow_unsupported: If true, allow opening
 
150
        formats that are strongly deprecated, and which may
 
151
        have limited functionality.
 
152
 
 
153
        :param recommend_upgrade: If true (default), warn
 
154
        the user through the ui object that they may wish
 
155
        to upgrade the object.
 
156
        """
 
157
        # TODO: perhaps move this into a base Format class; it's not BzrDir
 
158
        # specific. mbp 20070323
 
159
        if not allow_unsupported and not format.is_supported():
 
160
            # see open_downlevel to open legacy branches.
 
161
            raise errors.UnsupportedFormatError(format=format)
 
162
        if recommend_upgrade \
 
163
            and getattr(format, 'upgrade_recommended', False):
 
164
            ui.ui_factory.recommend_upgrade(
 
165
                format.get_format_description(),
 
166
                basedir)
 
167
 
130
168
    def clone_on_transport(self, transport, revision_id=None,
131
169
        force_new_repo=False, preserve_stacking=False, stacked_on=None,
132
 
        create_prefix=False, use_existing_dir=True, no_tree=False):
 
170
        create_prefix=False, use_existing_dir=True):
133
171
        """Clone this bzrdir and its contents to transport verbatim.
134
172
 
135
173
        :param transport: The transport for the location to produce the clone
144
182
        :param create_prefix: Create any missing directories leading up to
145
183
            to_transport.
146
184
        :param use_existing_dir: Use an existing directory if one exists.
147
 
        :param no_tree: If set to true prevents creation of a working tree.
148
185
        """
149
186
        # Overview: put together a broad description of what we want to end up
150
187
        # with; then make as few api calls as possible to do it.
178
215
        # we should look up the policy needs first, or just use it as a hint,
179
216
        # or something.
180
217
        if local_repo:
181
 
            make_working_trees = local_repo.make_working_trees() and not no_tree
 
218
            make_working_trees = local_repo.make_working_trees()
182
219
            want_shared = local_repo.is_shared()
183
220
            repo_format_name = format.repository_format.network_name()
184
221
        else:
204
241
                if (result_repo.user_url == result.user_url
205
242
                    and not require_stacking and
206
243
                    revision_id is not None):
207
 
                    fetch_spec = vf_search.PendingAncestryResult(
 
244
                    fetch_spec = graph.PendingAncestryResult(
208
245
                        [revision_id], local_repo)
209
246
                    result_repo.fetch(local_repo, fetch_spec=fetch_spec)
210
247
                else:
225
262
            # the tree and fail.
226
263
            result.root_transport.local_abspath('.')
227
264
            if result_repo is None or result_repo.make_working_trees():
228
 
                self.open_workingtree().clone(result, revision_id=revision_id)
 
265
                self.open_workingtree().clone(result)
229
266
        except (errors.NoWorkingTree, errors.NotLocalUrl):
230
267
            pass
231
268
        return result
233
270
    # TODO: This should be given a Transport, and should chdir up; otherwise
234
271
    # this will open a new connection.
235
272
    def _make_tail(self, url):
236
 
        t = _mod_transport.get_transport(url)
 
273
        t = get_transport(url)
237
274
        t.ensure_base()
238
275
 
 
276
    @staticmethod
 
277
    def find_bzrdirs(transport, evaluate=None, list_current=None):
 
278
        """Find bzrdirs recursively from current location.
 
279
 
 
280
        This is intended primarily as a building block for more sophisticated
 
281
        functionality, like finding trees under a directory, or finding
 
282
        branches that use a given repository.
 
283
        :param evaluate: An optional callable that yields recurse, value,
 
284
            where recurse controls whether this bzrdir is recursed into
 
285
            and value is the value to yield.  By default, all bzrdirs
 
286
            are recursed into, and the return value is the bzrdir.
 
287
        :param list_current: if supplied, use this function to list the current
 
288
            directory, instead of Transport.list_dir
 
289
        :return: a generator of found bzrdirs, or whatever evaluate returns.
 
290
        """
 
291
        if list_current is None:
 
292
            def list_current(transport):
 
293
                return transport.list_dir('')
 
294
        if evaluate is None:
 
295
            def evaluate(bzrdir):
 
296
                return True, bzrdir
 
297
 
 
298
        pending = [transport]
 
299
        while len(pending) > 0:
 
300
            current_transport = pending.pop()
 
301
            recurse = True
 
302
            try:
 
303
                bzrdir = BzrDir.open_from_transport(current_transport)
 
304
            except (errors.NotBranchError, errors.PermissionDenied):
 
305
                pass
 
306
            else:
 
307
                recurse, value = evaluate(bzrdir)
 
308
                yield value
 
309
            try:
 
310
                subdirs = list_current(current_transport)
 
311
            except (errors.NoSuchFile, errors.PermissionDenied):
 
312
                continue
 
313
            if recurse:
 
314
                for subdir in sorted(subdirs, reverse=True):
 
315
                    pending.append(current_transport.clone(subdir))
 
316
 
 
317
    @staticmethod
 
318
    def find_branches(transport):
 
319
        """Find all branches under a transport.
 
320
 
 
321
        This will find all branches below the transport, including branches
 
322
        inside other branches.  Where possible, it will use
 
323
        Repository.find_branches.
 
324
 
 
325
        To list all the branches that use a particular Repository, see
 
326
        Repository.find_branches
 
327
        """
 
328
        def evaluate(bzrdir):
 
329
            try:
 
330
                repository = bzrdir.open_repository()
 
331
            except errors.NoRepositoryPresent:
 
332
                pass
 
333
            else:
 
334
                return False, ([], repository)
 
335
            return True, (bzrdir.list_branches(), None)
 
336
        ret = []
 
337
        for branches, repo in BzrDir.find_bzrdirs(transport,
 
338
                                                  evaluate=evaluate):
 
339
            if repo is not None:
 
340
                ret.extend(repo.find_branches())
 
341
            if branches is not None:
 
342
                ret.extend(branches)
 
343
        return ret
 
344
 
 
345
    @staticmethod
 
346
    def create_branch_and_repo(base, force_new_repo=False, format=None):
 
347
        """Create a new BzrDir, Branch and Repository at the url 'base'.
 
348
 
 
349
        This will use the current default BzrDirFormat unless one is
 
350
        specified, and use whatever
 
351
        repository format that that uses via bzrdir.create_branch and
 
352
        create_repository. If a shared repository is available that is used
 
353
        preferentially.
 
354
 
 
355
        The created Branch object is returned.
 
356
 
 
357
        :param base: The URL to create the branch at.
 
358
        :param force_new_repo: If True a new repository is always created.
 
359
        :param format: If supplied, the format of branch to create.  If not
 
360
            supplied, the default is used.
 
361
        """
 
362
        bzrdir = BzrDir.create(base, format)
 
363
        bzrdir._find_or_create_repository(force_new_repo)
 
364
        return bzrdir.create_branch()
 
365
 
239
366
    def determine_repository_policy(self, force_new_repo=False, stack_on=None,
240
367
                                    stack_on_pwd=None, require_stacking=False):
241
368
        """Return an object representing a policy to use.
302
429
        policy = self.determine_repository_policy(force_new_repo)
303
430
        return policy.acquire_repository()[0]
304
431
 
305
 
    def _find_source_repo(self, add_cleanup, source_branch):
306
 
        """Find the source branch and repo for a sprout operation.
307
 
        
308
 
        This is helper intended for use by _sprout.
309
 
 
310
 
        :returns: (source_branch, source_repository).  Either or both may be
311
 
            None.  If not None, they will be read-locked (and their unlock(s)
312
 
            scheduled via the add_cleanup param).
313
 
        """
314
 
        if source_branch is not None:
315
 
            add_cleanup(source_branch.lock_read().unlock)
316
 
            return source_branch, source_branch.repository
317
 
        try:
318
 
            source_branch = self.open_branch()
319
 
            source_repository = source_branch.repository
320
 
        except errors.NotBranchError:
321
 
            source_branch = None
322
 
            try:
323
 
                source_repository = self.open_repository()
324
 
            except errors.NoRepositoryPresent:
325
 
                source_repository = None
326
 
            else:
327
 
                add_cleanup(source_repository.lock_read().unlock)
328
 
        else:
329
 
            add_cleanup(source_branch.lock_read().unlock)
330
 
        return source_branch, source_repository
331
 
 
332
 
    def sprout(self, url, revision_id=None, force_new_repo=False,
333
 
               recurse='down', possible_transports=None,
334
 
               accelerator_tree=None, hardlink=False, stacked=False,
335
 
               source_branch=None, create_tree_if_local=True):
336
 
        """Create a copy of this controldir prepared for use as a new line of
337
 
        development.
338
 
 
339
 
        If url's last component does not exist, it will be created.
340
 
 
341
 
        Attributes related to the identity of the source branch like
342
 
        branch nickname will be cleaned, a working tree is created
343
 
        whether one existed before or not; and a local branch is always
344
 
        created.
345
 
 
346
 
        if revision_id is not None, then the clone operation may tune
347
 
            itself to download less data.
348
 
 
349
 
        :param accelerator_tree: A tree which can be used for retrieving file
350
 
            contents more quickly than the revision tree, i.e. a workingtree.
351
 
            The revision tree will be used for cases where accelerator_tree's
352
 
            content is different.
353
 
        :param hardlink: If true, hard-link files from accelerator_tree,
354
 
            where possible.
355
 
        :param stacked: If true, create a stacked branch referring to the
356
 
            location of this control directory.
357
 
        :param create_tree_if_local: If true, a working-tree will be created
358
 
            when working locally.
359
 
        :return: The created control directory
360
 
        """
361
 
        operation = cleanup.OperationWithCleanups(self._sprout)
362
 
        return operation.run(url, revision_id=revision_id,
363
 
            force_new_repo=force_new_repo, recurse=recurse,
364
 
            possible_transports=possible_transports,
365
 
            accelerator_tree=accelerator_tree, hardlink=hardlink,
366
 
            stacked=stacked, source_branch=source_branch,
367
 
            create_tree_if_local=create_tree_if_local)
368
 
 
369
 
    def _sprout(self, op, url, revision_id=None, force_new_repo=False,
370
 
               recurse='down', possible_transports=None,
371
 
               accelerator_tree=None, hardlink=False, stacked=False,
372
 
               source_branch=None, create_tree_if_local=True):
373
 
        add_cleanup = op.add_cleanup
374
 
        fetch_spec_factory = fetch.FetchSpecFactory()
375
 
        if revision_id is not None:
376
 
            fetch_spec_factory.add_revision_ids([revision_id])
377
 
            fetch_spec_factory.source_branch_stop_revision_id = revision_id
378
 
        if possible_transports is None:
379
 
            possible_transports = []
380
 
        else:
381
 
            possible_transports = list(possible_transports) + [
382
 
                self.root_transport]
383
 
        target_transport = _mod_transport.get_transport(url,
384
 
            possible_transports)
385
 
        target_transport.ensure_base()
386
 
        cloning_format = self.cloning_metadir(stacked)
387
 
        # Create/update the result branch
388
 
        try:
389
 
            result = controldir.ControlDir.open_from_transport(target_transport)
390
 
        except errors.NotBranchError:
391
 
            result = cloning_format.initialize_on_transport(target_transport)
392
 
        source_branch, source_repository = self._find_source_repo(
393
 
            add_cleanup, source_branch)
394
 
        fetch_spec_factory.source_branch = source_branch
395
 
        # if a stacked branch wasn't requested, we don't create one
396
 
        # even if the origin was stacked
397
 
        if stacked and source_branch is not None:
398
 
            stacked_branch_url = self.root_transport.base
399
 
        else:
400
 
            stacked_branch_url = None
401
 
        repository_policy = result.determine_repository_policy(
402
 
            force_new_repo, stacked_branch_url, require_stacking=stacked)
403
 
        result_repo, is_new_repo = repository_policy.acquire_repository(
404
 
            possible_transports=possible_transports)
405
 
        add_cleanup(result_repo.lock_write().unlock)
406
 
        fetch_spec_factory.source_repo = source_repository
407
 
        fetch_spec_factory.target_repo = result_repo
408
 
        if stacked or (len(result_repo._fallback_repositories) != 0):
409
 
            target_repo_kind = fetch.TargetRepoKinds.STACKED
410
 
        elif is_new_repo:
411
 
            target_repo_kind = fetch.TargetRepoKinds.EMPTY
412
 
        else:
413
 
            target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
414
 
        fetch_spec_factory.target_repo_kind = target_repo_kind
415
 
        if source_repository is not None:
416
 
            fetch_spec = fetch_spec_factory.make_fetch_spec()
417
 
            result_repo.fetch(source_repository, fetch_spec=fetch_spec)
418
 
 
419
 
        if source_branch is None:
420
 
            # this is for sprouting a controldir without a branch; is that
421
 
            # actually useful?
422
 
            # Not especially, but it's part of the contract.
423
 
            result_branch = result.create_branch()
424
 
        else:
425
 
            result_branch = source_branch.sprout(result,
426
 
                revision_id=revision_id, repository_policy=repository_policy,
427
 
                repository=result_repo)
428
 
        mutter("created new branch %r" % (result_branch,))
429
 
 
430
 
        # Create/update the result working tree
431
 
        if (create_tree_if_local and not result.has_workingtree() and
432
 
            isinstance(target_transport, local.LocalTransport) and
433
 
            (result_repo is None or result_repo.make_working_trees())):
434
 
            wt = result.create_workingtree(accelerator_tree=accelerator_tree,
435
 
                hardlink=hardlink, from_branch=result_branch)
436
 
            wt.lock_write()
437
 
            try:
438
 
                if wt.path2id('') is None:
439
 
                    try:
440
 
                        wt.set_root_id(self.open_workingtree.get_root_id())
441
 
                    except errors.NoWorkingTree:
442
 
                        pass
443
 
            finally:
444
 
                wt.unlock()
445
 
        else:
446
 
            wt = None
447
 
        if recurse == 'down':
448
 
            basis = None
449
 
            if wt is not None:
450
 
                basis = wt.basis_tree()
451
 
            elif result_branch is not None:
452
 
                basis = result_branch.basis_tree()
453
 
            elif source_branch is not None:
454
 
                basis = source_branch.basis_tree()
455
 
            if basis is not None:
456
 
                add_cleanup(basis.lock_read().unlock)
457
 
                subtrees = basis.iter_references()
458
 
            else:
459
 
                subtrees = []
460
 
            for path, file_id in subtrees:
461
 
                target = urlutils.join(url, urlutils.escape(path))
462
 
                sublocation = source_branch.reference_parent(file_id, path)
463
 
                sublocation.bzrdir.sprout(target,
464
 
                    basis.get_reference_revision(file_id, path),
465
 
                    force_new_repo=force_new_repo, recurse=recurse,
466
 
                    stacked=stacked)
 
432
    @staticmethod
 
433
    def create_branch_convenience(base, force_new_repo=False,
 
434
                                  force_new_tree=None, format=None,
 
435
                                  possible_transports=None):
 
436
        """Create a new BzrDir, Branch and Repository at the url 'base'.
 
437
 
 
438
        This is a convenience function - it will use an existing repository
 
439
        if possible, can be told explicitly whether to create a working tree or
 
440
        not.
 
441
 
 
442
        This will use the current default BzrDirFormat unless one is
 
443
        specified, and use whatever
 
444
        repository format that that uses via bzrdir.create_branch and
 
445
        create_repository. If a shared repository is available that is used
 
446
        preferentially. Whatever repository is used, its tree creation policy
 
447
        is followed.
 
448
 
 
449
        The created Branch object is returned.
 
450
        If a working tree cannot be made due to base not being a file:// url,
 
451
        no error is raised unless force_new_tree is True, in which case no
 
452
        data is created on disk and NotLocalUrl is raised.
 
453
 
 
454
        :param base: The URL to create the branch at.
 
455
        :param force_new_repo: If True a new repository is always created.
 
456
        :param force_new_tree: If True or False force creation of a tree or
 
457
                               prevent such creation respectively.
 
458
        :param format: Override for the bzrdir format to create.
 
459
        :param possible_transports: An optional reusable transports list.
 
460
        """
 
461
        if force_new_tree:
 
462
            # check for non local urls
 
463
            t = get_transport(base, possible_transports)
 
464
            if not isinstance(t, local.LocalTransport):
 
465
                raise errors.NotLocalUrl(base)
 
466
        bzrdir = BzrDir.create(base, format, possible_transports)
 
467
        repo = bzrdir._find_or_create_repository(force_new_repo)
 
468
        result = bzrdir.create_branch()
 
469
        if force_new_tree or (repo.make_working_trees() and
 
470
                              force_new_tree is None):
 
471
            try:
 
472
                bzrdir.create_workingtree()
 
473
            except errors.NotLocalUrl:
 
474
                pass
467
475
        return result
468
476
 
469
 
    def _available_backup_name(self, base):
470
 
        """Find a non-existing backup file name based on base.
471
 
 
472
 
        See bzrlib.osutils.available_backup_name about race conditions.
 
477
    @staticmethod
 
478
    def create_standalone_workingtree(base, format=None):
 
479
        """Create a new BzrDir, WorkingTree, Branch and Repository at 'base'.
 
480
 
 
481
        'base' must be a local path or a file:// url.
 
482
 
 
483
        This will use the current default BzrDirFormat unless one is
 
484
        specified, and use whatever
 
485
        repository format that that uses for bzrdirformat.create_workingtree,
 
486
        create_branch and create_repository.
 
487
 
 
488
        :param format: Override for the bzrdir format to create.
 
489
        :return: The WorkingTree object.
473
490
        """
474
 
        return osutils.available_backup_name(base, self.root_transport.has)
 
491
        t = get_transport(base)
 
492
        if not isinstance(t, local.LocalTransport):
 
493
            raise errors.NotLocalUrl(base)
 
494
        bzrdir = BzrDir.create_branch_and_repo(base,
 
495
                                               force_new_repo=True,
 
496
                                               format=format).bzrdir
 
497
        return bzrdir.create_workingtree()
 
498
 
 
499
    def generate_backup_name(self, base):
 
500
        """Generate a non-existing backup file name based on base."""
 
501
        counter = 1
 
502
        name = "%s.~%d~" % (base, counter)
 
503
        while self.root_transport.has(name):
 
504
            counter += 1
 
505
            name = "%s.~%d~" % (base, counter)
 
506
        return name
475
507
 
476
508
    def backup_bzrdir(self):
477
509
        """Backup this bzr control directory.
479
511
        :return: Tuple with old path name and new path name
480
512
        """
481
513
 
 
514
        backup_dir=self.generate_backup_name('backup.bzr')
482
515
        pb = ui.ui_factory.nested_progress_bar()
483
516
        try:
 
517
            # FIXME: bug 300001 -- the backup fails if the backup directory
 
518
            # already exists, but it should instead either remove it or make
 
519
            # a new backup directory.
 
520
            #
484
521
            old_path = self.root_transport.abspath('.bzr')
485
 
            backup_dir = self._available_backup_name('backup.bzr')
486
522
            new_path = self.root_transport.abspath(backup_dir)
487
 
            ui.ui_factory.note(gettext('making backup of {0}\n  to {1}').format(
488
 
                urlutils.unescape_for_display(old_path, 'utf-8'),
489
 
                urlutils.unescape_for_display(new_path, 'utf-8')))
 
523
            ui.ui_factory.note('making backup of %s\n  to %s' % (old_path, new_path,))
490
524
            self.root_transport.copy_tree('.bzr', backup_dir)
491
525
            return (old_path, new_path)
492
526
        finally:
507
541
            try:
508
542
                to_path = '.bzr.retired.%d' % i
509
543
                self.root_transport.rename('.bzr', to_path)
510
 
                note(gettext("renamed {0} to {1}").format(
511
 
                    self.root_transport.abspath('.bzr'), to_path))
 
544
                note("renamed %s to %s"
 
545
                    % (self.root_transport.abspath('.bzr'), to_path))
512
546
                return
513
547
            except (errors.TransportError, IOError, errors.PathError):
514
548
                i += 1
541
575
                return None
542
576
            # find the next containing bzrdir
543
577
            try:
544
 
                found_bzrdir = self.open_containing_from_transport(
 
578
                found_bzrdir = BzrDir.open_containing_from_transport(
545
579
                    next_transport)[0]
546
580
            except errors.NotBranchError:
547
581
                return None
664
698
        # add new tests for it to the appropriate place.
665
699
        return filename == '.bzr' or filename.startswith('.bzr/')
666
700
 
 
701
    @staticmethod
 
702
    def open_unsupported(base):
 
703
        """Open a branch which is not supported."""
 
704
        return BzrDir.open(base, _unsupported=True)
 
705
 
 
706
    @staticmethod
 
707
    def open(base, _unsupported=False, possible_transports=None):
 
708
        """Open an existing bzrdir, rooted at 'base' (url).
 
709
 
 
710
        :param _unsupported: a private parameter to the BzrDir class.
 
711
        """
 
712
        t = get_transport(base, possible_transports=possible_transports)
 
713
        return BzrDir.open_from_transport(t, _unsupported=_unsupported)
 
714
 
 
715
    @staticmethod
 
716
    def open_from_transport(transport, _unsupported=False,
 
717
                            _server_formats=True):
 
718
        """Open a bzrdir within a particular directory.
 
719
 
 
720
        :param transport: Transport containing the bzrdir.
 
721
        :param _unsupported: private.
 
722
        """
 
723
        for hook in BzrDir.hooks['pre_open']:
 
724
            hook(transport)
 
725
        # Keep initial base since 'transport' may be modified while following
 
726
        # the redirections.
 
727
        base = transport.base
 
728
        def find_format(transport):
 
729
            return transport, controldir.ControlDirFormat.find_format(
 
730
                transport, _server_formats=_server_formats)
 
731
 
 
732
        def redirected(transport, e, redirection_notice):
 
733
            redirected_transport = transport._redirected_to(e.source, e.target)
 
734
            if redirected_transport is None:
 
735
                raise errors.NotBranchError(base)
 
736
            note('%s is%s redirected to %s',
 
737
                 transport.base, e.permanently, redirected_transport.base)
 
738
            return redirected_transport
 
739
 
 
740
        try:
 
741
            transport, format = do_catching_redirections(find_format,
 
742
                                                         transport,
 
743
                                                         redirected)
 
744
        except errors.TooManyRedirections:
 
745
            raise errors.NotBranchError(base)
 
746
 
 
747
        BzrDir._check_supported(format, _unsupported)
 
748
        return format.open(transport, _found=True)
 
749
 
 
750
    @staticmethod
 
751
    def open_containing(url, possible_transports=None):
 
752
        """Open an existing branch which contains url.
 
753
 
 
754
        :param url: url to search from.
 
755
        See open_containing_from_transport for more detail.
 
756
        """
 
757
        transport = get_transport(url, possible_transports)
 
758
        return BzrDir.open_containing_from_transport(transport)
 
759
 
 
760
    @staticmethod
 
761
    def open_containing_from_transport(a_transport):
 
762
        """Open an existing branch which contains a_transport.base.
 
763
 
 
764
        This probes for a branch at a_transport, and searches upwards from there.
 
765
 
 
766
        Basically we keep looking up until we find the control directory or
 
767
        run into the root.  If there isn't one, raises NotBranchError.
 
768
        If there is one and it is either an unrecognised format or an unsupported
 
769
        format, UnknownFormatError or UnsupportedFormatError are raised.
 
770
        If there is one, it is returned, along with the unused portion of url.
 
771
 
 
772
        :return: The BzrDir that contains the path, and a Unicode path
 
773
                for the rest of the URL.
 
774
        """
 
775
        # this gets the normalised url back. I.e. '.' -> the full path.
 
776
        url = a_transport.base
 
777
        while True:
 
778
            try:
 
779
                result = BzrDir.open_from_transport(a_transport)
 
780
                return result, urlutils.unescape(a_transport.relpath(url))
 
781
            except errors.NotBranchError, e:
 
782
                pass
 
783
            try:
 
784
                new_t = a_transport.clone('..')
 
785
            except errors.InvalidURLJoin:
 
786
                # reached the root, whatever that may be
 
787
                raise errors.NotBranchError(path=url)
 
788
            if new_t.base == a_transport.base:
 
789
                # reached the root, whatever that may be
 
790
                raise errors.NotBranchError(path=url)
 
791
            a_transport = new_t
 
792
 
 
793
    @classmethod
 
794
    def open_tree_or_branch(klass, location):
 
795
        """Return the branch and working tree at a location.
 
796
 
 
797
        If there is no tree at the location, tree will be None.
 
798
        If there is no branch at the location, an exception will be
 
799
        raised
 
800
        :return: (tree, branch)
 
801
        """
 
802
        bzrdir = klass.open(location)
 
803
        return bzrdir._get_tree_branch()
 
804
 
 
805
    @classmethod
 
806
    def open_containing_tree_or_branch(klass, location):
 
807
        """Return the branch and working tree contained by a location.
 
808
 
 
809
        Returns (tree, branch, relpath).
 
810
        If there is no tree at containing the location, tree will be None.
 
811
        If there is no branch containing the location, an exception will be
 
812
        raised
 
813
        relpath is the portion of the path that is contained by the branch.
 
814
        """
 
815
        bzrdir, relpath = klass.open_containing(location)
 
816
        tree, branch = bzrdir._get_tree_branch()
 
817
        return tree, branch, relpath
 
818
 
 
819
    @classmethod
 
820
    def open_containing_tree_branch_or_repository(klass, location):
 
821
        """Return the working tree, branch and repo contained by a location.
 
822
 
 
823
        Returns (tree, branch, repository, relpath).
 
824
        If there is no tree containing the location, tree will be None.
 
825
        If there is no branch containing the location, branch will be None.
 
826
        If there is no repository containing the location, repository will be
 
827
        None.
 
828
        relpath is the portion of the path that is contained by the innermost
 
829
        BzrDir.
 
830
 
 
831
        If no tree, branch or repository is found, a NotBranchError is raised.
 
832
        """
 
833
        bzrdir, relpath = klass.open_containing(location)
 
834
        try:
 
835
            tree, branch = bzrdir._get_tree_branch()
 
836
        except errors.NotBranchError:
 
837
            try:
 
838
                repo = bzrdir.find_repository()
 
839
                return None, None, repo, relpath
 
840
            except (errors.NoRepositoryPresent):
 
841
                raise errors.NotBranchError(location)
 
842
        return tree, branch, branch.repository, relpath
 
843
 
667
844
    def _cloning_metadir(self):
668
845
        """Produce a metadir suitable for cloning with.
669
846
 
709
886
 
710
887
        :require_stacking: If True, non-stackable formats will be upgraded
711
888
            to similar stackable formats.
712
 
        :returns: a ControlDirFormat with all component formats either set
 
889
        :returns: a BzrDirFormat with all component formats either set
713
890
            appropriately or set to None if that component should not be
714
891
            created.
715
892
        """
727
904
            format.require_stacking()
728
905
        return format
729
906
 
730
 
    def get_branch_transport(self, branch_format, name=None):
731
 
        """Get the transport for use by branch format in this BzrDir.
732
 
 
733
 
        Note that bzr dirs that do not support format strings will raise
734
 
        IncompatibleFormat if the branch format they are given has
735
 
        a format string, and vice versa.
736
 
 
737
 
        If branch_format is None, the transport is returned with no
738
 
        checking. If it is not None, then the returned transport is
739
 
        guaranteed to point to an existing directory ready for use.
740
 
        """
741
 
        raise NotImplementedError(self.get_branch_transport)
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
 
 
769
907
    @classmethod
770
908
    def create(cls, base, format=None, possible_transports=None):
771
909
        """Create a new BzrDir at the url 'base'.
776
914
            can be reused to share a remote connection.
777
915
        """
778
916
        if cls is not BzrDir:
779
 
            raise AssertionError("BzrDir.create always creates the "
 
917
            raise AssertionError("BzrDir.create always creates the"
780
918
                "default format, not one of %r" % cls)
781
 
        return controldir.ControlDir.create(base, format=format,
782
 
                possible_transports=possible_transports)
 
919
        t = get_transport(base, possible_transports)
 
920
        t.ensure_base()
 
921
        if format is None:
 
922
            format = controldir.ControlDirFormat.get_default_format()
 
923
        return format.initialize_on_transport(t)
 
924
 
 
925
 
 
926
 
 
927
class BzrDirHooks(hooks.Hooks):
 
928
    """Hooks for BzrDir operations."""
 
929
 
 
930
    def __init__(self):
 
931
        """Create the default hooks."""
 
932
        hooks.Hooks.__init__(self)
 
933
        self.create_hook(hooks.HookPoint('pre_open',
 
934
            "Invoked before attempting to open a BzrDir with the transport "
 
935
            "that the open will use.", (1, 14), None))
 
936
        self.create_hook(hooks.HookPoint('post_repo_init',
 
937
            "Invoked after a repository has been initialized. "
 
938
            "post_repo_init is called with a "
 
939
            "bzrlib.bzrdir.RepoInitHookParams.",
 
940
            (2, 2), None))
 
941
 
 
942
# install the default hooks
 
943
BzrDir.hooks = BzrDirHooks()
 
944
 
 
945
 
 
946
class RepoInitHookParams(object):
 
947
    """Object holding parameters passed to *_repo_init hooks.
 
948
 
 
949
    There are 4 fields that hooks may wish to access:
 
950
 
 
951
    :ivar repository: Repository created
 
952
    :ivar format: Repository format
 
953
    :ivar bzrdir: The bzrdir for the repository
 
954
    :ivar shared: The repository is shared
 
955
    """
 
956
 
 
957
    def __init__(self, repository, format, a_bzrdir, shared):
 
958
        """Create a group of RepoInitHook parameters.
 
959
 
 
960
        :param repository: Repository created
 
961
        :param format: Repository format
 
962
        :param bzrdir: The bzrdir for the repository
 
963
        :param shared: The repository is shared
 
964
        """
 
965
        self.repository = repository
 
966
        self.format = format
 
967
        self.bzrdir = a_bzrdir
 
968
        self.shared = shared
 
969
 
 
970
    def __eq__(self, other):
 
971
        return self.__dict__ == other.__dict__
783
972
 
784
973
    def __repr__(self):
785
 
        return "<%s at %r>" % (self.__class__.__name__, self.user_url)
786
 
 
787
 
    def update_feature_flags(self, updated_flags):
788
 
        """Update the features required by this bzrdir.
789
 
 
790
 
        :param updated_flags: Dictionary mapping feature names to necessities
791
 
            A necessity can be None to indicate the feature should be removed
 
974
        if self.repository:
 
975
            return "<%s for %s>" % (self.__class__.__name__,
 
976
                self.repository)
 
977
        else:
 
978
            return "<%s for %s>" % (self.__class__.__name__,
 
979
                self.bzrdir)
 
980
 
 
981
 
 
982
class BzrDirPreSplitOut(BzrDir):
 
983
    """A common class for the all-in-one formats."""
 
984
 
 
985
    def __init__(self, _transport, _format):
 
986
        """See BzrDir.__init__."""
 
987
        super(BzrDirPreSplitOut, self).__init__(_transport, _format)
 
988
        self._control_files = lockable_files.LockableFiles(
 
989
                                            self.get_branch_transport(None),
 
990
                                            self._format._lock_file_name,
 
991
                                            self._format._lock_class)
 
992
 
 
993
    def break_lock(self):
 
994
        """Pre-splitout bzrdirs do not suffer from stale locks."""
 
995
        raise NotImplementedError(self.break_lock)
 
996
 
 
997
    def cloning_metadir(self, require_stacking=False):
 
998
        """Produce a metadir suitable for cloning with."""
 
999
        if require_stacking:
 
1000
            return controldir.format_registry.make_bzrdir('1.6')
 
1001
        return self._format.__class__()
 
1002
 
 
1003
    def clone(self, url, revision_id=None, force_new_repo=False,
 
1004
              preserve_stacking=False):
 
1005
        """See BzrDir.clone().
 
1006
 
 
1007
        force_new_repo has no effect, since this family of formats always
 
1008
        require a new repository.
 
1009
        preserve_stacking has no effect, since no source branch using this
 
1010
        family of formats can be stacked, so there is no stacking to preserve.
792
1011
        """
793
 
        self.control_files.lock_write()
794
 
        try:
795
 
            self._format._update_feature_flags(updated_flags)
796
 
            self.transport.put_bytes('branch-format', self._format.as_string())
797
 
        finally:
798
 
            self.control_files.unlock()
 
1012
        self._make_tail(url)
 
1013
        result = self._format._initialize_for_clone(url)
 
1014
        self.open_repository().clone(result, revision_id=revision_id)
 
1015
        from_branch = self.open_branch()
 
1016
        from_branch.clone(result, revision_id=revision_id)
 
1017
        try:
 
1018
            tree = self.open_workingtree()
 
1019
        except errors.NotLocalUrl:
 
1020
            # make a new one, this format always has to have one.
 
1021
            result._init_workingtree()
 
1022
        else:
 
1023
            tree.clone(result)
 
1024
        return result
 
1025
 
 
1026
    def create_branch(self, name=None):
 
1027
        """See BzrDir.create_branch."""
 
1028
        return self._format.get_branch_format().initialize(self, name=name)
 
1029
 
 
1030
    def destroy_branch(self, name=None):
 
1031
        """See BzrDir.destroy_branch."""
 
1032
        raise errors.UnsupportedOperation(self.destroy_branch, self)
 
1033
 
 
1034
    def create_repository(self, shared=False):
 
1035
        """See BzrDir.create_repository."""
 
1036
        if shared:
 
1037
            raise errors.IncompatibleFormat('shared repository', self._format)
 
1038
        return self.open_repository()
 
1039
 
 
1040
    def destroy_repository(self):
 
1041
        """See BzrDir.destroy_repository."""
 
1042
        raise errors.UnsupportedOperation(self.destroy_repository, self)
 
1043
 
 
1044
    def create_workingtree(self, revision_id=None, from_branch=None,
 
1045
                           accelerator_tree=None, hardlink=False):
 
1046
        """See BzrDir.create_workingtree."""
 
1047
        # The workingtree is sometimes created when the bzrdir is created,
 
1048
        # but not when cloning.
 
1049
 
 
1050
        # this looks buggy but is not -really-
 
1051
        # because this format creates the workingtree when the bzrdir is
 
1052
        # created
 
1053
        # clone and sprout will have set the revision_id
 
1054
        # and that will have set it for us, its only
 
1055
        # specific uses of create_workingtree in isolation
 
1056
        # that can do wonky stuff here, and that only
 
1057
        # happens for creating checkouts, which cannot be
 
1058
        # done on this format anyway. So - acceptable wart.
 
1059
        if hardlink:
 
1060
            warning("can't support hardlinked working trees in %r"
 
1061
                % (self,))
 
1062
        try:
 
1063
            result = self.open_workingtree(recommend_upgrade=False)
 
1064
        except errors.NoSuchFile:
 
1065
            result = self._init_workingtree()
 
1066
        if revision_id is not None:
 
1067
            if revision_id == _mod_revision.NULL_REVISION:
 
1068
                result.set_parent_ids([])
 
1069
            else:
 
1070
                result.set_parent_ids([revision_id])
 
1071
        return result
 
1072
 
 
1073
    def _init_workingtree(self):
 
1074
        from bzrlib.workingtree import WorkingTreeFormat2
 
1075
        try:
 
1076
            return WorkingTreeFormat2().initialize(self)
 
1077
        except errors.NotLocalUrl:
 
1078
            # Even though we can't access the working tree, we need to
 
1079
            # create its control files.
 
1080
            return WorkingTreeFormat2()._stub_initialize_on_transport(
 
1081
                self.transport, self._control_files._file_mode)
 
1082
 
 
1083
    def destroy_workingtree(self):
 
1084
        """See BzrDir.destroy_workingtree."""
 
1085
        raise errors.UnsupportedOperation(self.destroy_workingtree, self)
 
1086
 
 
1087
    def destroy_workingtree_metadata(self):
 
1088
        """See BzrDir.destroy_workingtree_metadata."""
 
1089
        raise errors.UnsupportedOperation(self.destroy_workingtree_metadata,
 
1090
                                          self)
 
1091
 
 
1092
    def get_branch_transport(self, branch_format, name=None):
 
1093
        """See BzrDir.get_branch_transport()."""
 
1094
        if name is not None:
 
1095
            raise errors.NoColocatedBranchSupport(self)
 
1096
        if branch_format is None:
 
1097
            return self.transport
 
1098
        try:
 
1099
            branch_format.get_format_string()
 
1100
        except NotImplementedError:
 
1101
            return self.transport
 
1102
        raise errors.IncompatibleFormat(branch_format, self._format)
 
1103
 
 
1104
    def get_repository_transport(self, repository_format):
 
1105
        """See BzrDir.get_repository_transport()."""
 
1106
        if repository_format is None:
 
1107
            return self.transport
 
1108
        try:
 
1109
            repository_format.get_format_string()
 
1110
        except NotImplementedError:
 
1111
            return self.transport
 
1112
        raise errors.IncompatibleFormat(repository_format, self._format)
 
1113
 
 
1114
    def get_workingtree_transport(self, workingtree_format):
 
1115
        """See BzrDir.get_workingtree_transport()."""
 
1116
        if workingtree_format is None:
 
1117
            return self.transport
 
1118
        try:
 
1119
            workingtree_format.get_format_string()
 
1120
        except NotImplementedError:
 
1121
            return self.transport
 
1122
        raise errors.IncompatibleFormat(workingtree_format, self._format)
 
1123
 
 
1124
    def needs_format_conversion(self, format=None):
 
1125
        """See BzrDir.needs_format_conversion()."""
 
1126
        # if the format is not the same as the system default,
 
1127
        # an upgrade is needed.
 
1128
        if format is None:
 
1129
            symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
 
1130
                % 'needs_format_conversion(format=None)')
 
1131
            format = BzrDirFormat.get_default_format()
 
1132
        return not isinstance(self._format, format.__class__)
 
1133
 
 
1134
    def open_branch(self, name=None, unsupported=False,
 
1135
                    ignore_fallbacks=False):
 
1136
        """See BzrDir.open_branch."""
 
1137
        from bzrlib.branch import BzrBranchFormat4
 
1138
        format = BzrBranchFormat4()
 
1139
        self._check_supported(format, unsupported)
 
1140
        return format.open(self, name, _found=True)
 
1141
 
 
1142
    def sprout(self, url, revision_id=None, force_new_repo=False,
 
1143
               possible_transports=None, accelerator_tree=None,
 
1144
               hardlink=False, stacked=False, create_tree_if_local=True,
 
1145
               source_branch=None):
 
1146
        """See BzrDir.sprout()."""
 
1147
        if source_branch is not None:
 
1148
            my_branch = self.open_branch()
 
1149
            if source_branch.base != my_branch.base:
 
1150
                raise AssertionError(
 
1151
                    "source branch %r is not within %r with branch %r" %
 
1152
                    (source_branch, self, my_branch))
 
1153
        if stacked:
 
1154
            raise errors.UnstackableBranchFormat(
 
1155
                self._format, self.root_transport.base)
 
1156
        if not create_tree_if_local:
 
1157
            raise errors.MustHaveWorkingTree(
 
1158
                self._format, self.root_transport.base)
 
1159
        from bzrlib.workingtree import WorkingTreeFormat2
 
1160
        self._make_tail(url)
 
1161
        result = self._format._initialize_for_clone(url)
 
1162
        try:
 
1163
            self.open_repository().clone(result, revision_id=revision_id)
 
1164
        except errors.NoRepositoryPresent:
 
1165
            pass
 
1166
        try:
 
1167
            self.open_branch().sprout(result, revision_id=revision_id)
 
1168
        except errors.NotBranchError:
 
1169
            pass
 
1170
 
 
1171
        # we always want a working tree
 
1172
        WorkingTreeFormat2().initialize(result,
 
1173
                                        accelerator_tree=accelerator_tree,
 
1174
                                        hardlink=hardlink)
 
1175
        return result
 
1176
 
 
1177
 
 
1178
class BzrDir4(BzrDirPreSplitOut):
 
1179
    """A .bzr version 4 control object.
 
1180
 
 
1181
    This is a deprecated format and may be removed after sept 2006.
 
1182
    """
 
1183
 
 
1184
    def create_repository(self, shared=False):
 
1185
        """See BzrDir.create_repository."""
 
1186
        return self._format.repository_format.initialize(self, shared)
 
1187
 
 
1188
    def needs_format_conversion(self, format=None):
 
1189
        """Format 4 dirs are always in need of conversion."""
 
1190
        if format is None:
 
1191
            symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
 
1192
                % 'needs_format_conversion(format=None)')
 
1193
        return True
 
1194
 
 
1195
    def open_repository(self):
 
1196
        """See BzrDir.open_repository."""
 
1197
        from bzrlib.repofmt.weaverepo import RepositoryFormat4
 
1198
        return RepositoryFormat4().open(self, _found=True)
 
1199
 
 
1200
 
 
1201
class BzrDir5(BzrDirPreSplitOut):
 
1202
    """A .bzr version 5 control object.
 
1203
 
 
1204
    This is a deprecated format and may be removed after sept 2006.
 
1205
    """
 
1206
 
 
1207
    def has_workingtree(self):
 
1208
        """See BzrDir.has_workingtree."""
 
1209
        return True
 
1210
    
 
1211
    def open_repository(self):
 
1212
        """See BzrDir.open_repository."""
 
1213
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
 
1214
        return RepositoryFormat5().open(self, _found=True)
 
1215
 
 
1216
    def open_workingtree(self, _unsupported=False,
 
1217
            recommend_upgrade=True):
 
1218
        """See BzrDir.create_workingtree."""
 
1219
        from bzrlib.workingtree import WorkingTreeFormat2
 
1220
        wt_format = WorkingTreeFormat2()
 
1221
        # we don't warn here about upgrades; that ought to be handled for the
 
1222
        # bzrdir as a whole
 
1223
        return wt_format.open(self, _found=True)
 
1224
 
 
1225
 
 
1226
class BzrDir6(BzrDirPreSplitOut):
 
1227
    """A .bzr version 6 control object.
 
1228
 
 
1229
    This is a deprecated format and may be removed after sept 2006.
 
1230
    """
 
1231
 
 
1232
    def has_workingtree(self):
 
1233
        """See BzrDir.has_workingtree."""
 
1234
        return True
 
1235
    
 
1236
    def open_repository(self):
 
1237
        """See BzrDir.open_repository."""
 
1238
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
 
1239
        return RepositoryFormat6().open(self, _found=True)
 
1240
 
 
1241
    def open_workingtree(self, _unsupported=False,
 
1242
        recommend_upgrade=True):
 
1243
        """See BzrDir.create_workingtree."""
 
1244
        # we don't warn here about upgrades; that ought to be handled for the
 
1245
        # bzrdir as a whole
 
1246
        from bzrlib.workingtree import WorkingTreeFormat2
 
1247
        return WorkingTreeFormat2().open(self, _found=True)
799
1248
 
800
1249
 
801
1250
class BzrDirMeta1(BzrDir):
807
1256
    present within a BzrDir.
808
1257
    """
809
1258
 
810
 
    def _get_branch_path(self, name):
811
 
        """Obtain the branch path to use.
812
 
 
813
 
        This uses the API specified branch name first, and then falls back to
814
 
        the branch name specified in the URL. If neither of those is specified,
815
 
        it uses the default branch.
816
 
 
817
 
        :param name: Optional branch name to use
818
 
        :return: Relative path to branch
819
 
        """
820
 
        if name == "":
821
 
            return 'branch'
822
 
        return urlutils.join('branches', name.encode("utf-8"))
823
 
 
824
 
    def _read_branch_list(self):
825
 
        """Read the branch list.
826
 
 
827
 
        :return: List of utf-8 encoded branch names.
828
 
        """
829
 
        try:
830
 
            f = self.control_transport.get('branch-list')
831
 
        except errors.NoSuchFile:
832
 
            return []
833
 
 
834
 
        ret = []
835
 
        try:
836
 
            for name in f:
837
 
                ret.append(name.rstrip("\n"))
838
 
        finally:
839
 
            f.close()
840
 
        return ret
841
 
 
842
 
    def _write_branch_list(self, branches):
843
 
        """Write out the branch list.
844
 
 
845
 
        :param branches: List of utf-8 branch names to write
846
 
        """
847
 
        self.transport.put_bytes('branch-list',
848
 
            "".join([name+"\n" for name in branches]))
849
 
 
850
 
    def __init__(self, _transport, _format):
851
 
        super(BzrDirMeta1, self).__init__(_transport, _format)
852
 
        self.control_files = lockable_files.LockableFiles(
853
 
            self.control_transport, self._format._lock_file_name,
854
 
            self._format._lock_class)
855
 
 
856
1259
    def can_convert_format(self):
857
1260
        """See BzrDir.can_convert_format()."""
858
1261
        return True
859
1262
 
860
 
    def create_branch(self, name=None, repository=None,
861
 
            append_revisions_only=None):
862
 
        """See ControlDir.create_branch."""
863
 
        if name is None:
864
 
            name = self._get_selected_branch()
865
 
        return self._format.get_branch_format().initialize(self, name=name,
866
 
                repository=repository,
867
 
                append_revisions_only=append_revisions_only)
 
1263
    def create_branch(self, name=None):
 
1264
        """See BzrDir.create_branch."""
 
1265
        return self._format.get_branch_format().initialize(self, name=name)
868
1266
 
869
1267
    def destroy_branch(self, name=None):
870
 
        """See ControlDir.destroy_branch."""
871
 
        if name is None:
872
 
            name = self._get_selected_branch()
873
 
        path = self._get_branch_path(name)
874
 
        if name != "":
875
 
            self.control_files.lock_write()
876
 
            try:
877
 
                branches = self._read_branch_list()
878
 
                try:
879
 
                    branches.remove(name.encode("utf-8"))
880
 
                except ValueError:
881
 
                    raise errors.NotBranchError(name)
882
 
                self._write_branch_list(branches)
883
 
            finally:
884
 
                self.control_files.unlock()
885
 
        try:
886
 
            self.transport.delete_tree(path)
887
 
        except errors.NoSuchFile:
888
 
            raise errors.NotBranchError(path=urlutils.join(self.transport.base,
889
 
                path), bzrdir=self)
 
1268
        """See BzrDir.create_branch."""
 
1269
        if name is not None:
 
1270
            raise errors.NoColocatedBranchSupport(self)
 
1271
        self.transport.delete_tree('branch')
890
1272
 
891
1273
    def create_repository(self, shared=False):
892
1274
        """See BzrDir.create_repository."""
894
1276
 
895
1277
    def destroy_repository(self):
896
1278
        """See BzrDir.destroy_repository."""
897
 
        try:
898
 
            self.transport.delete_tree('repository')
899
 
        except errors.NoSuchFile:
900
 
            raise errors.NoRepositoryPresent(self)
 
1279
        self.transport.delete_tree('repository')
901
1280
 
902
1281
    def create_workingtree(self, revision_id=None, from_branch=None,
903
1282
                           accelerator_tree=None, hardlink=False):
911
1290
        wt = self.open_workingtree(recommend_upgrade=False)
912
1291
        repository = wt.branch.repository
913
1292
        empty = repository.revision_tree(_mod_revision.NULL_REVISION)
914
 
        # We ignore the conflicts returned by wt.revert since we're about to
915
 
        # delete the wt metadata anyway, all that should be left here are
916
 
        # detritus. But see bug #634470 about subtree .bzr dirs.
917
 
        conflicts = wt.revert(old_tree=empty)
 
1293
        wt.revert(old_tree=empty)
918
1294
        self.destroy_workingtree_metadata()
919
1295
 
920
1296
    def destroy_workingtree_metadata(self):
925
1301
 
926
1302
        This might be a synthetic object for e.g. RemoteBranch and SVN.
927
1303
        """
928
 
        from bzrlib.branch import BranchFormatMetadir
929
 
        return BranchFormatMetadir.find_format(self, name=name)
 
1304
        from bzrlib.branch import BranchFormat
 
1305
        return BranchFormat.find_format(self, name=name)
930
1306
 
931
1307
    def _get_mkdir_mode(self):
932
1308
        """Figure out the mode to use when creating a bzrdir subdir."""
936
1312
 
937
1313
    def get_branch_reference(self, name=None):
938
1314
        """See BzrDir.get_branch_reference()."""
939
 
        from bzrlib.branch import BranchFormatMetadir
940
 
        format = BranchFormatMetadir.find_format(self, name=name)
 
1315
        from bzrlib.branch import BranchFormat
 
1316
        format = BranchFormat.find_format(self, name=name)
941
1317
        return format.get_reference(self, name=name)
942
1318
 
943
 
    def set_branch_reference(self, target_branch, name=None):
944
 
        format = _mod_branch.BranchReferenceFormat()
945
 
        return format.initialize(self, target_branch=target_branch, name=name)
946
 
 
947
1319
    def get_branch_transport(self, branch_format, name=None):
948
1320
        """See BzrDir.get_branch_transport()."""
949
 
        if name is None:
950
 
            name = self._get_selected_branch()
951
 
        path = self._get_branch_path(name)
 
1321
        if name is not None:
 
1322
            raise errors.NoColocatedBranchSupport(self)
952
1323
        # XXX: this shouldn't implicitly create the directory if it's just
953
1324
        # promising to get a transport -- mbp 20090727
954
1325
        if branch_format is None:
955
 
            return self.transport.clone(path)
 
1326
            return self.transport.clone('branch')
956
1327
        try:
957
1328
            branch_format.get_format_string()
958
1329
        except NotImplementedError:
959
1330
            raise errors.IncompatibleFormat(branch_format, self._format)
960
 
        if name != "":
961
 
            branches = self._read_branch_list()
962
 
            utf8_name = name.encode("utf-8")
963
 
            if not utf8_name in branches:
964
 
                self.control_files.lock_write()
965
 
                try:
966
 
                    branches = self._read_branch_list()
967
 
                    dirname = urlutils.dirname(utf8_name)
968
 
                    if dirname != "" and dirname in branches:
969
 
                        raise errors.ParentBranchExists(name)
970
 
                    child_branches = [
971
 
                        b.startswith(utf8_name+"/") for b in branches]
972
 
                    if any(child_branches):
973
 
                        raise errors.AlreadyBranchError(name)
974
 
                    branches.append(utf8_name)
975
 
                    self._write_branch_list(branches)
976
 
                finally:
977
 
                    self.control_files.unlock()
978
 
        branch_transport = self.transport.clone(path)
979
 
        mode = self._get_mkdir_mode()
980
 
        branch_transport.create_prefix(mode=mode)
981
1331
        try:
982
 
            self.transport.mkdir(path, mode=mode)
 
1332
            self.transport.mkdir('branch', mode=self._get_mkdir_mode())
983
1333
        except errors.FileExists:
984
1334
            pass
985
 
        return self.transport.clone(path)
 
1335
        return self.transport.clone('branch')
986
1336
 
987
1337
    def get_repository_transport(self, repository_format):
988
1338
        """See BzrDir.get_repository_transport()."""
1012
1362
            pass
1013
1363
        return self.transport.clone('checkout')
1014
1364
 
1015
 
    def get_branches(self):
1016
 
        """See ControlDir.get_branches."""
1017
 
        ret = {}
1018
 
        try:
1019
 
            ret[""] = self.open_branch(name="")
1020
 
        except (errors.NotBranchError, errors.NoRepositoryPresent):
1021
 
            pass
1022
 
 
1023
 
        for name in self._read_branch_list():
1024
 
            ret[name] = self.open_branch(name=name.decode('utf-8'))
1025
 
 
1026
 
        return ret
1027
 
 
1028
1365
    def has_workingtree(self):
1029
1366
        """Tell if this bzrdir contains a working tree.
1030
1367
 
 
1368
        This will still raise an exception if the bzrdir has a workingtree that
 
1369
        is remote & inaccessible.
 
1370
 
1031
1371
        Note: if you're going to open the working tree, you should just go
1032
1372
        ahead and try, and not ask permission first.
1033
1373
        """
1034
 
        from bzrlib.workingtree import WorkingTreeFormatMetaDir
 
1374
        from bzrlib.workingtree import WorkingTreeFormat
1035
1375
        try:
1036
 
            WorkingTreeFormatMetaDir.find_format_string(self)
 
1376
            WorkingTreeFormat.find_format(self)
1037
1377
        except errors.NoWorkingTree:
1038
1378
            return False
1039
1379
        return True
1040
1380
 
1041
 
    def needs_format_conversion(self, format):
 
1381
    def needs_format_conversion(self, format=None):
1042
1382
        """See BzrDir.needs_format_conversion()."""
1043
 
        if (not isinstance(self._format, format.__class__) or
1044
 
            self._format.get_format_string() != format.get_format_string()):
 
1383
        if format is None:
 
1384
            symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
 
1385
                % 'needs_format_conversion(format=None)')
 
1386
        if format is None:
 
1387
            format = BzrDirFormat.get_default_format()
 
1388
        if not isinstance(self._format, format.__class__):
1045
1389
            # it is not a meta dir format, conversion is needed.
1046
1390
            return True
1047
1391
        # we might want to push this down to the repository?
1068
1412
        return False
1069
1413
 
1070
1414
    def open_branch(self, name=None, unsupported=False,
1071
 
                    ignore_fallbacks=False, possible_transports=None):
1072
 
        """See ControlDir.open_branch."""
1073
 
        if name is None:
1074
 
            name = self._get_selected_branch()
 
1415
                    ignore_fallbacks=False):
 
1416
        """See BzrDir.open_branch."""
1075
1417
        format = self.find_branch_format(name=name)
1076
 
        format.check_support_status(unsupported)
 
1418
        self._check_supported(format, unsupported)
1077
1419
        return format.open(self, name=name,
1078
 
            _found=True, ignore_fallbacks=ignore_fallbacks,
1079
 
            possible_transports=possible_transports)
 
1420
            _found=True, ignore_fallbacks=ignore_fallbacks)
1080
1421
 
1081
1422
    def open_repository(self, unsupported=False):
1082
1423
        """See BzrDir.open_repository."""
1083
 
        from bzrlib.repository import RepositoryFormatMetaDir
1084
 
        format = RepositoryFormatMetaDir.find_format(self)
1085
 
        format.check_support_status(unsupported)
 
1424
        from bzrlib.repository import RepositoryFormat
 
1425
        format = RepositoryFormat.find_format(self)
 
1426
        self._check_supported(format, unsupported)
1086
1427
        return format.open(self, _found=True)
1087
1428
 
1088
1429
    def open_workingtree(self, unsupported=False,
1089
1430
            recommend_upgrade=True):
1090
1431
        """See BzrDir.open_workingtree."""
1091
 
        from bzrlib.workingtree import WorkingTreeFormatMetaDir
1092
 
        format = WorkingTreeFormatMetaDir.find_format(self)
1093
 
        format.check_support_status(unsupported, recommend_upgrade,
 
1432
        from bzrlib.workingtree import WorkingTreeFormat
 
1433
        format = WorkingTreeFormat.find_format(self)
 
1434
        self._check_supported(format, unsupported,
 
1435
            recommend_upgrade,
1094
1436
            basedir=self.root_transport.base)
1095
1437
        return format.open(self, _found=True)
1096
1438
 
1098
1440
        return config.TransportConfig(self.transport, 'control.conf')
1099
1441
 
1100
1442
 
1101
 
class BzrFormat(object):
1102
 
    """Base class for all formats of things living in metadirs.
1103
 
 
1104
 
    This class manages the format string that is stored in the 'format'
1105
 
    or 'branch-format' file.
1106
 
 
1107
 
    All classes for (branch-, repository-, workingtree-) formats that
1108
 
    live in meta directories and have their own 'format' file
1109
 
    (i.e. different from .bzr/branch-format) derive from this class,
1110
 
    as well as the relevant base class for their kind
1111
 
    (BranchFormat, WorkingTreeFormat, RepositoryFormat).
1112
 
 
1113
 
    Each format is identified by a "format" or "branch-format" file with a
1114
 
    single line containing the base format name and then an optional list of
1115
 
    feature flags.
1116
 
 
1117
 
    Feature flags are supported as of bzr 2.5. Setting feature flags on formats
1118
 
    will render them inaccessible to older versions of bzr.
1119
 
 
1120
 
    :ivar features: Dictionary mapping feature names to their necessity
1121
 
    """
1122
 
 
1123
 
    _present_features = set()
1124
 
 
1125
 
    def __init__(self):
1126
 
        self.features = {}
1127
 
 
1128
 
    @classmethod
1129
 
    def register_feature(cls, name):
1130
 
        """Register a feature as being present.
1131
 
 
1132
 
        :param name: Name of the feature
1133
 
        """
1134
 
        if " " in name:
1135
 
            raise ValueError("spaces are not allowed in feature names")
1136
 
        if name in cls._present_features:
1137
 
            raise errors.FeatureAlreadyRegistered(name)
1138
 
        cls._present_features.add(name)
1139
 
 
1140
 
    @classmethod
1141
 
    def unregister_feature(cls, name):
1142
 
        """Unregister a feature."""
1143
 
        cls._present_features.remove(name)
1144
 
 
1145
 
    def check_support_status(self, allow_unsupported, recommend_upgrade=True,
1146
 
            basedir=None):
1147
 
        for name, necessity in self.features.iteritems():
1148
 
            if name in self._present_features:
1149
 
                continue
1150
 
            if necessity == "optional":
1151
 
                mutter("ignoring optional missing feature %s", name)
1152
 
                continue
1153
 
            elif necessity == "required":
1154
 
                raise errors.MissingFeature(name)
1155
 
            else:
1156
 
                mutter("treating unknown necessity as require for %s",
1157
 
                       name)
1158
 
                raise errors.MissingFeature(name)
1159
 
 
1160
 
    @classmethod
1161
 
    def get_format_string(cls):
1162
 
        """Return the ASCII format string that identifies this format."""
1163
 
        raise NotImplementedError(cls.get_format_string)
1164
 
 
1165
 
    @classmethod
1166
 
    def from_string(cls, text):
1167
 
        format_string = cls.get_format_string()
1168
 
        if not text.startswith(format_string):
1169
 
            raise AssertionError("Invalid format header %r for %r" % (text, cls))
1170
 
        lines = text[len(format_string):].splitlines()
1171
 
        ret = cls()
1172
 
        for lineno, line in enumerate(lines):
1173
 
            try:
1174
 
                (necessity, feature) = line.split(" ", 1)
1175
 
            except ValueError:
1176
 
                raise errors.ParseFormatError(format=cls, lineno=lineno+2,
1177
 
                    line=line, text=text)
1178
 
            ret.features[feature] = necessity
1179
 
        return ret
1180
 
 
1181
 
    def as_string(self):
1182
 
        """Return the string representation of this format.
1183
 
        """
1184
 
        lines = [self.get_format_string()]
1185
 
        lines.extend([("%s %s\n" % (item[1], item[0])) for item in
1186
 
            self.features.iteritems()])
1187
 
        return "".join(lines)
1188
 
 
1189
 
    @classmethod
1190
 
    def _find_format(klass, registry, kind, format_string):
1191
 
        try:
1192
 
            first_line = format_string[:format_string.index("\n")+1]
1193
 
        except ValueError:
1194
 
            first_line = format_string
1195
 
        try:
1196
 
            cls = registry.get(first_line)
1197
 
        except KeyError:
1198
 
            raise errors.UnknownFormatError(format=first_line, kind=kind)
1199
 
        return cls.from_string(format_string)
1200
 
 
1201
 
    def network_name(self):
1202
 
        """A simple byte string uniquely identifying this format for RPC calls.
1203
 
 
1204
 
        Metadir branch formats use their format string.
1205
 
        """
1206
 
        return self.as_string()
1207
 
 
1208
 
    def __eq__(self, other):
1209
 
        return (self.__class__ is other.__class__ and
1210
 
                self.features == other.features)
1211
 
 
1212
 
    def _update_feature_flags(self, updated_flags):
1213
 
        """Update the feature flags in this format.
1214
 
 
1215
 
        :param updated_flags: Updated feature flags
1216
 
        """
1217
 
        for name, necessity in updated_flags.iteritems():
1218
 
            if necessity is None:
1219
 
                try:
1220
 
                    del self.features[name]
1221
 
                except KeyError:
1222
 
                    pass
1223
 
            else:
1224
 
                self.features[name] = necessity
1225
 
 
1226
 
 
1227
1443
class BzrProber(controldir.Prober):
1228
1444
    """Prober for formats that use a .bzr/ control directory."""
1229
1445
 
1230
 
    formats = registry.FormatRegistry(controldir.network_format_registry)
 
1446
    _formats = {}
1231
1447
    """The known .bzr formats."""
1232
1448
 
1233
1449
    @classmethod
 
1450
    def register_bzrdir_format(klass, format):
 
1451
        klass._formats[format.get_format_string()] = format
 
1452
 
 
1453
    @classmethod
 
1454
    def unregister_bzrdir_format(klass, format):
 
1455
        del klass._formats[format.get_format_string()]
 
1456
 
 
1457
    @classmethod
1234
1458
    def probe_transport(klass, transport):
1235
1459
        """Return the .bzrdir style format present in a directory."""
1236
1460
        try:
1238
1462
        except errors.NoSuchFile:
1239
1463
            raise errors.NotBranchError(path=transport.base)
1240
1464
        try:
1241
 
            first_line = format_string[:format_string.index("\n")+1]
1242
 
        except ValueError:
1243
 
            first_line = format_string
1244
 
        try:
1245
 
            cls = klass.formats.get(first_line)
 
1465
            return klass._formats[format_string]
1246
1466
        except KeyError:
1247
 
            raise errors.UnknownFormatError(format=first_line, kind='bzrdir')
1248
 
        return cls.from_string(format_string)
1249
 
 
1250
 
    @classmethod
1251
 
    def known_formats(cls):
1252
 
        result = set()
1253
 
        for name, format in cls.formats.iteritems():
1254
 
            if callable(format):
1255
 
                format = format()
1256
 
            result.add(format)
1257
 
        return result
 
1467
            raise errors.UnknownFormatError(format=format_string, kind='bzrdir')
1258
1468
 
1259
1469
 
1260
1470
controldir.ControlDirFormat.register_prober(BzrProber)
1285
1495
                    raise errors.NotBranchError(path=transport.base)
1286
1496
                if server_version != '2':
1287
1497
                    raise errors.NotBranchError(path=transport.base)
1288
 
            from bzrlib.remote import RemoteBzrDirFormat
1289
1498
            return RemoteBzrDirFormat()
1290
1499
 
1291
 
    @classmethod
1292
 
    def known_formats(cls):
1293
 
        from bzrlib.remote import RemoteBzrDirFormat
1294
 
        return set([RemoteBzrDirFormat()])
1295
 
 
1296
 
 
1297
 
class BzrDirFormat(BzrFormat, controldir.ControlDirFormat):
 
1500
 
 
1501
class BzrDirFormat(controldir.ControlDirFormat):
1298
1502
    """ControlDirFormat base class for .bzr/ directories.
1299
1503
 
1300
1504
    Formats are placed in a dict by their format string for reference
1311
1515
    # _lock_class must be set in subclasses to the lock type, typ.
1312
1516
    # TransportLock or LockDir
1313
1517
 
 
1518
    def get_format_string(self):
 
1519
        """Return the ASCII format string that identifies this format."""
 
1520
        raise NotImplementedError(self.get_format_string)
 
1521
 
1314
1522
    def initialize_on_transport(self, transport):
1315
1523
        """Initialize a new bzrdir in the base directory of a Transport."""
1316
1524
        try:
1325
1533
            # metadir1
1326
1534
            if type(self) != BzrDirMetaFormat1:
1327
1535
                return self._initialize_on_transport_vfs(transport)
1328
 
            from bzrlib.remote import RemoteBzrDirFormat
1329
1536
            remote_format = RemoteBzrDirFormat()
1330
1537
            self._supply_sub_formats_to(remote_format)
1331
1538
            return remote_format.initialize_on_transport(transport)
1357
1564
        :param shared_repo: Control whether made repositories are shared or
1358
1565
            not.
1359
1566
        :param vfs_only: If True do not attempt to use a smart server
1360
 
        :return: repo, controldir, require_stacking, repository_policy. repo is
 
1567
        :return: repo, bzrdir, require_stacking, repository_policy. repo is
1361
1568
            None if none was created or found, bzrdir is always valid.
1362
1569
            require_stacking is the result of examining the stacked_on
1363
1570
            parameter and any stacking policy found for the target.
1369
1576
            except errors.NoSmartMedium:
1370
1577
                pass
1371
1578
            else:
1372
 
                from bzrlib.remote import RemoteBzrDirFormat
1373
1579
                # TODO: lookup the local format from a server hint.
1374
1580
                remote_dir_format = RemoteBzrDirFormat()
1375
1581
                remote_dir_format._network_name = self.network_name()
1438
1644
        # mode from the root directory
1439
1645
        temp_control = lockable_files.LockableFiles(transport,
1440
1646
                            '', lockable_files.TransportLock)
1441
 
        try:
1442
 
            temp_control._transport.mkdir('.bzr',
1443
 
                # FIXME: RBC 20060121 don't peek under
1444
 
                # the covers
1445
 
                mode=temp_control._dir_mode)
1446
 
        except errors.FileExists:
1447
 
            raise errors.AlreadyControlDirError(transport.base)
 
1647
        temp_control._transport.mkdir('.bzr',
 
1648
                                      # FIXME: RBC 20060121 don't peek under
 
1649
                                      # the covers
 
1650
                                      mode=temp_control._dir_mode)
1448
1651
        if sys.platform == 'win32' and isinstance(transport, local.LocalTransport):
1449
1652
            win32utils.set_file_attr_hidden(transport._abspath('.bzr'))
1450
1653
        file_mode = temp_control._file_mode
1453
1656
        utf8_files = [('README',
1454
1657
                       "This is a Bazaar control directory.\n"
1455
1658
                       "Do not change any files in this directory.\n"
1456
 
                       "See http://bazaar.canonical.com/ for more information about Bazaar.\n"),
1457
 
                      ('branch-format', self.as_string()),
 
1659
                       "See http://bazaar-vcs.org/ for more information about Bazaar.\n"),
 
1660
                      ('branch-format', self.get_format_string()),
1458
1661
                      ]
1459
1662
        # NB: no need to escape relative paths that are url safe.
1460
1663
        control_files = lockable_files.LockableFiles(bzrdir_transport,
1493
1696
        """
1494
1697
        raise NotImplementedError(self._open)
1495
1698
 
 
1699
    @classmethod
 
1700
    def register_format(klass, format):
 
1701
        BzrProber.register_bzrdir_format(format)
 
1702
        # bzr native formats have a network name of their format string.
 
1703
        controldir.network_format_registry.register(format.get_format_string(), format.__class__)
 
1704
        controldir.ControlDirFormat.register_format(format)
 
1705
 
1496
1706
    def _supply_sub_formats_to(self, other_format):
1497
1707
        """Give other_format the same values for sub formats as this has.
1498
1708
 
1504
1714
            compatible with whatever sub formats are supported by self.
1505
1715
        :return: None.
1506
1716
        """
1507
 
        other_format.features = dict(self.features)
1508
 
 
1509
 
    def supports_transport(self, transport):
1510
 
        # bzr formats can be opened over all known transports
1511
 
        return True
1512
 
 
1513
 
    def check_support_status(self, allow_unsupported, recommend_upgrade=True,
1514
 
            basedir=None):
1515
 
        controldir.ControlDirFormat.check_support_status(self,
1516
 
            allow_unsupported=allow_unsupported, recommend_upgrade=recommend_upgrade,
1517
 
            basedir=basedir)
1518
 
        BzrFormat.check_support_status(self, allow_unsupported=allow_unsupported,
1519
 
            recommend_upgrade=recommend_upgrade, basedir=basedir)
 
1717
 
 
1718
    @classmethod
 
1719
    def unregister_format(klass, format):
 
1720
        BzrProber.unregister_bzrdir_format(format)
 
1721
        controldir.ControlDirFormat.unregister_format(format)
 
1722
        controldir.network_format_registry.remove(format.get_format_string())
 
1723
 
 
1724
 
 
1725
class BzrDirFormat4(BzrDirFormat):
 
1726
    """Bzr dir format 4.
 
1727
 
 
1728
    This format is a combined format for working tree, branch and repository.
 
1729
    It has:
 
1730
     - Format 1 working trees [always]
 
1731
     - Format 4 branches [always]
 
1732
     - Format 4 repositories [always]
 
1733
 
 
1734
    This format is deprecated: it indexes texts using a text it which is
 
1735
    removed in format 5; write support for this format has been removed.
 
1736
    """
 
1737
 
 
1738
    _lock_class = lockable_files.TransportLock
 
1739
 
 
1740
    def get_format_string(self):
 
1741
        """See BzrDirFormat.get_format_string()."""
 
1742
        return "Bazaar-NG branch, format 0.0.4\n"
 
1743
 
 
1744
    def get_format_description(self):
 
1745
        """See BzrDirFormat.get_format_description()."""
 
1746
        return "All-in-one format 4"
 
1747
 
 
1748
    def get_converter(self, format=None):
 
1749
        """See BzrDirFormat.get_converter()."""
 
1750
        # there is one and only one upgrade path here.
 
1751
        return ConvertBzrDir4To5()
 
1752
 
 
1753
    def initialize_on_transport(self, transport):
 
1754
        """Format 4 branches cannot be created."""
 
1755
        raise errors.UninitializableFormat(self)
 
1756
 
 
1757
    def is_supported(self):
 
1758
        """Format 4 is not supported.
 
1759
 
 
1760
        It is not supported because the model changed from 4 to 5 and the
 
1761
        conversion logic is expensive - so doing it on the fly was not
 
1762
        feasible.
 
1763
        """
 
1764
        return False
 
1765
 
 
1766
    def network_name(self):
 
1767
        return self.get_format_string()
 
1768
 
 
1769
    def _open(self, transport):
 
1770
        """See BzrDirFormat._open."""
 
1771
        return BzrDir4(transport, self)
 
1772
 
 
1773
    def __return_repository_format(self):
 
1774
        """Circular import protection."""
 
1775
        from bzrlib.repofmt.weaverepo import RepositoryFormat4
 
1776
        return RepositoryFormat4()
 
1777
    repository_format = property(__return_repository_format)
 
1778
 
 
1779
 
 
1780
class BzrDirFormatAllInOne(BzrDirFormat):
 
1781
    """Common class for formats before meta-dirs."""
 
1782
 
 
1783
    def initialize_on_transport_ex(self, transport, use_existing_dir=False,
 
1784
        create_prefix=False, force_new_repo=False, stacked_on=None,
 
1785
        stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
 
1786
        shared_repo=False):
 
1787
        """See BzrDirFormat.initialize_on_transport_ex."""
 
1788
        require_stacking = (stacked_on is not None)
 
1789
        # Format 5 cannot stack, but we've been asked to - actually init
 
1790
        # a Meta1Dir
 
1791
        if require_stacking:
 
1792
            format = BzrDirMetaFormat1()
 
1793
            return format.initialize_on_transport_ex(transport,
 
1794
                use_existing_dir=use_existing_dir, create_prefix=create_prefix,
 
1795
                force_new_repo=force_new_repo, stacked_on=stacked_on,
 
1796
                stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
 
1797
                make_working_trees=make_working_trees, shared_repo=shared_repo)
 
1798
        return BzrDirFormat.initialize_on_transport_ex(self, transport,
 
1799
            use_existing_dir=use_existing_dir, create_prefix=create_prefix,
 
1800
            force_new_repo=force_new_repo, stacked_on=stacked_on,
 
1801
            stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
 
1802
            make_working_trees=make_working_trees, shared_repo=shared_repo)
 
1803
 
 
1804
 
 
1805
class BzrDirFormat5(BzrDirFormatAllInOne):
 
1806
    """Bzr control format 5.
 
1807
 
 
1808
    This format is a combined format for working tree, branch and repository.
 
1809
    It has:
 
1810
     - Format 2 working trees [always]
 
1811
     - Format 4 branches [always]
 
1812
     - Format 5 repositories [always]
 
1813
       Unhashed stores in the repository.
 
1814
    """
 
1815
 
 
1816
    _lock_class = lockable_files.TransportLock
 
1817
 
 
1818
    def get_format_string(self):
 
1819
        """See BzrDirFormat.get_format_string()."""
 
1820
        return "Bazaar-NG branch, format 5\n"
 
1821
 
 
1822
    def get_branch_format(self):
 
1823
        from bzrlib import branch
 
1824
        return branch.BzrBranchFormat4()
 
1825
 
 
1826
    def get_format_description(self):
 
1827
        """See BzrDirFormat.get_format_description()."""
 
1828
        return "All-in-one format 5"
 
1829
 
 
1830
    def get_converter(self, format=None):
 
1831
        """See BzrDirFormat.get_converter()."""
 
1832
        # there is one and only one upgrade path here.
 
1833
        return ConvertBzrDir5To6()
 
1834
 
 
1835
    def _initialize_for_clone(self, url):
 
1836
        return self.initialize_on_transport(get_transport(url), _cloning=True)
 
1837
 
 
1838
    def initialize_on_transport(self, transport, _cloning=False):
 
1839
        """Format 5 dirs always have working tree, branch and repository.
 
1840
 
 
1841
        Except when they are being cloned.
 
1842
        """
 
1843
        from bzrlib.branch import BzrBranchFormat4
 
1844
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
 
1845
        result = (super(BzrDirFormat5, self).initialize_on_transport(transport))
 
1846
        RepositoryFormat5().initialize(result, _internal=True)
 
1847
        if not _cloning:
 
1848
            branch = BzrBranchFormat4().initialize(result)
 
1849
            result._init_workingtree()
 
1850
        return result
 
1851
 
 
1852
    def network_name(self):
 
1853
        return self.get_format_string()
 
1854
 
 
1855
    def _open(self, transport):
 
1856
        """See BzrDirFormat._open."""
 
1857
        return BzrDir5(transport, self)
 
1858
 
 
1859
    def __return_repository_format(self):
 
1860
        """Circular import protection."""
 
1861
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
 
1862
        return RepositoryFormat5()
 
1863
    repository_format = property(__return_repository_format)
 
1864
 
 
1865
 
 
1866
class BzrDirFormat6(BzrDirFormatAllInOne):
 
1867
    """Bzr control format 6.
 
1868
 
 
1869
    This format is a combined format for working tree, branch and repository.
 
1870
    It has:
 
1871
     - Format 2 working trees [always]
 
1872
     - Format 4 branches [always]
 
1873
     - Format 6 repositories [always]
 
1874
    """
 
1875
 
 
1876
    _lock_class = lockable_files.TransportLock
 
1877
 
 
1878
    def get_format_string(self):
 
1879
        """See BzrDirFormat.get_format_string()."""
 
1880
        return "Bazaar-NG branch, format 6\n"
 
1881
 
 
1882
    def get_format_description(self):
 
1883
        """See BzrDirFormat.get_format_description()."""
 
1884
        return "All-in-one format 6"
 
1885
 
 
1886
    def get_branch_format(self):
 
1887
        from bzrlib import branch
 
1888
        return branch.BzrBranchFormat4()
 
1889
 
 
1890
    def get_converter(self, format=None):
 
1891
        """See BzrDirFormat.get_converter()."""
 
1892
        # there is one and only one upgrade path here.
 
1893
        return ConvertBzrDir6ToMeta()
 
1894
 
 
1895
    def _initialize_for_clone(self, url):
 
1896
        return self.initialize_on_transport(get_transport(url), _cloning=True)
 
1897
 
 
1898
    def initialize_on_transport(self, transport, _cloning=False):
 
1899
        """Format 6 dirs always have working tree, branch and repository.
 
1900
 
 
1901
        Except when they are being cloned.
 
1902
        """
 
1903
        from bzrlib.branch import BzrBranchFormat4
 
1904
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
 
1905
        result = super(BzrDirFormat6, self).initialize_on_transport(transport)
 
1906
        RepositoryFormat6().initialize(result, _internal=True)
 
1907
        if not _cloning:
 
1908
            branch = BzrBranchFormat4().initialize(result)
 
1909
            result._init_workingtree()
 
1910
        return result
 
1911
 
 
1912
    def network_name(self):
 
1913
        return self.get_format_string()
 
1914
 
 
1915
    def _open(self, transport):
 
1916
        """See BzrDirFormat._open."""
 
1917
        return BzrDir6(transport, self)
 
1918
 
 
1919
    def __return_repository_format(self):
 
1920
        """Circular import protection."""
 
1921
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
 
1922
        return RepositoryFormat6()
 
1923
    repository_format = property(__return_repository_format)
1520
1924
 
1521
1925
 
1522
1926
class BzrDirMetaFormat1(BzrDirFormat):
1524
1928
 
1525
1929
    This is the first format with split out working tree, branch and repository
1526
1930
    disk storage.
1527
 
 
1528
1931
    It has:
1529
 
 
1530
 
    - Format 3 working trees [optional]
1531
 
    - Format 5 branches [optional]
1532
 
    - Format 7 repositories [optional]
 
1932
     - Format 3 working trees [optional]
 
1933
     - Format 5 branches [optional]
 
1934
     - Format 7 repositories [optional]
1533
1935
    """
1534
1936
 
1535
1937
    _lock_class = lockdir.LockDir
1536
1938
 
1537
 
    fixed_components = False
1538
 
 
1539
 
    colocated_branches = True
1540
 
 
1541
1939
    def __init__(self):
1542
 
        BzrDirFormat.__init__(self)
1543
1940
        self._workingtree_format = None
1544
1941
        self._branch_format = None
1545
1942
        self._repository_format = None
1551
1948
            return False
1552
1949
        if other.workingtree_format != self.workingtree_format:
1553
1950
            return False
1554
 
        if other.features != self.features:
1555
 
            return False
1556
1951
        return True
1557
1952
 
1558
1953
    def __ne__(self, other):
1560
1955
 
1561
1956
    def get_branch_format(self):
1562
1957
        if self._branch_format is None:
1563
 
            from bzrlib.branch import format_registry as branch_format_registry
1564
 
            self._branch_format = branch_format_registry.get_default()
 
1958
            from bzrlib.branch import BranchFormat
 
1959
            self._branch_format = BranchFormat.get_default_format()
1565
1960
        return self._branch_format
1566
1961
 
1567
1962
    def set_branch_format(self, format):
1622
2017
                    # stack_on is inaccessible, JFDI.
1623
2018
                    # TODO: bad monkey, hard-coded formats...
1624
2019
                    if self.repository_format.rich_root_data:
1625
 
                        new_repo_format = knitpack_repo.RepositoryFormatKnitPack5RichRoot()
 
2020
                        new_repo_format = pack_repo.RepositoryFormatKnitPack5RichRoot()
1626
2021
                    else:
1627
 
                        new_repo_format = knitpack_repo.RepositoryFormatKnitPack5()
 
2022
                        new_repo_format = pack_repo.RepositoryFormatKnitPack5()
1628
2023
            else:
1629
2024
                # If the target already supports stacking, then we know the
1630
2025
                # project is already able to use stacking, so auto-upgrade
1636
2031
                    new_repo_format = None
1637
2032
            if new_repo_format is not None:
1638
2033
                self.repository_format = new_repo_format
1639
 
                note(gettext('Source repository format does not support stacking,'
1640
 
                     ' using format:\n  %s'),
 
2034
                note('Source repository format does not support stacking,'
 
2035
                     ' using format:\n  %s',
1641
2036
                     new_repo_format.get_format_description())
1642
2037
 
1643
2038
        if not self.get_branch_format().supports_stacking():
1647
2042
            if target_branch is None:
1648
2043
                if do_upgrade:
1649
2044
                    # TODO: bad monkey, hard-coded formats...
1650
 
                    from bzrlib.branch import BzrBranchFormat7
1651
 
                    new_branch_format = BzrBranchFormat7()
 
2045
                    new_branch_format = branch.BzrBranchFormat7()
1652
2046
            else:
1653
2047
                new_branch_format = target_branch._format
1654
2048
                if not new_branch_format.supports_stacking():
1656
2050
            if new_branch_format is not None:
1657
2051
                # Does support stacking, use its format.
1658
2052
                self.set_branch_format(new_branch_format)
1659
 
                note(gettext('Source branch format does not support stacking,'
1660
 
                     ' using format:\n  %s'),
 
2053
                note('Source branch format does not support stacking,'
 
2054
                     ' using format:\n  %s',
1661
2055
                     new_branch_format.get_format_description())
1662
2056
 
1663
2057
    def get_converter(self, format=None):
1664
2058
        """See BzrDirFormat.get_converter()."""
1665
2059
        if format is None:
1666
2060
            format = BzrDirFormat.get_default_format()
1667
 
        if (type(self) is BzrDirMetaFormat1 and
1668
 
            type(format) is BzrDirMetaFormat1Colo):
1669
 
            return ConvertMetaToColo(format)
1670
 
        if (type(self) is BzrDirMetaFormat1Colo and
1671
 
            type(format) is BzrDirMetaFormat1):
1672
 
            return ConvertMetaToColo(format)
1673
2061
        if not isinstance(self, format.__class__):
1674
2062
            # converting away from metadir is not implemented
1675
2063
            raise NotImplementedError(self.get_converter)
1676
2064
        return ConvertMetaToMeta(format)
1677
2065
 
1678
 
    @classmethod
1679
 
    def get_format_string(cls):
 
2066
    def get_format_string(self):
1680
2067
        """See BzrDirFormat.get_format_string()."""
1681
2068
        return "Bazaar-NG meta directory, format 1\n"
1682
2069
 
1684
2071
        """See BzrDirFormat.get_format_description()."""
1685
2072
        return "Meta directory format 1"
1686
2073
 
 
2074
    def network_name(self):
 
2075
        return self.get_format_string()
 
2076
 
1687
2077
    def _open(self, transport):
1688
2078
        """See BzrDirFormat._open."""
1689
2079
        # Create a new format instance because otherwise initialisation of new
1697
2087
        """Circular import protection."""
1698
2088
        if self._repository_format:
1699
2089
            return self._repository_format
1700
 
        from bzrlib.repository import format_registry
1701
 
        return format_registry.get_default()
 
2090
        from bzrlib.repository import RepositoryFormat
 
2091
        return RepositoryFormat.get_default_format()
1702
2092
 
1703
2093
    def _set_repository_format(self, value):
1704
2094
        """Allow changing the repository format for metadir formats."""
1718
2108
            compatible with whatever sub formats are supported by self.
1719
2109
        :return: None.
1720
2110
        """
1721
 
        super(BzrDirMetaFormat1, self)._supply_sub_formats_to(other_format)
1722
2111
        if getattr(self, '_repository_format', None) is not None:
1723
2112
            other_format.repository_format = self.repository_format
1724
2113
        if self._branch_format is not None:
1728
2117
 
1729
2118
    def __get_workingtree_format(self):
1730
2119
        if self._workingtree_format is None:
1731
 
            from bzrlib.workingtree import (
1732
 
                format_registry as wt_format_registry,
1733
 
                )
1734
 
            self._workingtree_format = wt_format_registry.get_default()
 
2120
            from bzrlib.workingtree import WorkingTreeFormat
 
2121
            self._workingtree_format = WorkingTreeFormat.get_default_format()
1735
2122
        return self._workingtree_format
1736
2123
 
1737
2124
    def __set_workingtree_format(self, wt_format):
1738
2125
        self._workingtree_format = wt_format
1739
2126
 
1740
 
    def __repr__(self):
1741
 
        return "<%r>" % (self.__class__.__name__,)
1742
 
 
1743
2127
    workingtree_format = property(__get_workingtree_format,
1744
2128
                                  __set_workingtree_format)
1745
2129
 
1746
2130
 
1747
2131
# Register bzr formats
1748
 
BzrProber.formats.register(BzrDirMetaFormat1.get_format_string(),
1749
 
    BzrDirMetaFormat1)
1750
 
controldir.ControlDirFormat._default_format = BzrDirMetaFormat1()
1751
 
 
1752
 
 
1753
 
class BzrDirMetaFormat1Colo(BzrDirMetaFormat1):
1754
 
    """BzrDirMeta1 format with support for colocated branches."""
1755
 
 
1756
 
    colocated_branches = True
1757
 
 
1758
 
    @classmethod
1759
 
    def get_format_string(cls):
1760
 
        """See BzrDirFormat.get_format_string()."""
1761
 
        return "Bazaar meta directory, format 1 (with colocated branches)\n"
1762
 
 
1763
 
    def get_format_description(self):
1764
 
        """See BzrDirFormat.get_format_description()."""
1765
 
        return "Meta directory format 1 with support for colocated branches"
1766
 
 
1767
 
    def _open(self, transport):
1768
 
        """See BzrDirFormat._open."""
1769
 
        # Create a new format instance because otherwise initialisation of new
1770
 
        # metadirs share the global default format object leading to alias
1771
 
        # problems.
1772
 
        format = BzrDirMetaFormat1Colo()
1773
 
        self._supply_sub_formats_to(format)
1774
 
        return BzrDirMeta1(transport, format)
1775
 
 
1776
 
 
1777
 
BzrProber.formats.register(BzrDirMetaFormat1Colo.get_format_string(),
1778
 
    BzrDirMetaFormat1Colo)
1779
 
 
1780
 
 
1781
 
class ConvertMetaToMeta(controldir.Converter):
 
2132
BzrDirFormat.register_format(BzrDirFormat4())
 
2133
BzrDirFormat.register_format(BzrDirFormat5())
 
2134
BzrDirFormat.register_format(BzrDirFormat6())
 
2135
__default_format = BzrDirMetaFormat1()
 
2136
BzrDirFormat.register_format(__default_format)
 
2137
controldir.ControlDirFormat._default_format = __default_format
 
2138
 
 
2139
 
 
2140
class Converter(object):
 
2141
    """Converts a disk format object from one format to another."""
 
2142
 
 
2143
    def convert(self, to_convert, pb):
 
2144
        """Perform the conversion of to_convert, giving feedback via pb.
 
2145
 
 
2146
        :param to_convert: The disk object to convert.
 
2147
        :param pb: a progress bar to use for progress information.
 
2148
        """
 
2149
 
 
2150
    def step(self, message):
 
2151
        """Update the pb by a step."""
 
2152
        self.count +=1
 
2153
        self.pb.update(message, self.count, self.total)
 
2154
 
 
2155
 
 
2156
class ConvertBzrDir4To5(Converter):
 
2157
    """Converts format 4 bzr dirs to format 5."""
 
2158
 
 
2159
    def __init__(self):
 
2160
        super(ConvertBzrDir4To5, self).__init__()
 
2161
        self.converted_revs = set()
 
2162
        self.absent_revisions = set()
 
2163
        self.text_count = 0
 
2164
        self.revisions = {}
 
2165
 
 
2166
    def convert(self, to_convert, pb):
 
2167
        """See Converter.convert()."""
 
2168
        self.bzrdir = to_convert
 
2169
        if pb is not None:
 
2170
            warnings.warn("pb parameter to convert() is deprecated")
 
2171
        self.pb = ui.ui_factory.nested_progress_bar()
 
2172
        try:
 
2173
            ui.ui_factory.note('starting upgrade from format 4 to 5')
 
2174
            if isinstance(self.bzrdir.transport, local.LocalTransport):
 
2175
                self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
 
2176
            self._convert_to_weaves()
 
2177
            return BzrDir.open(self.bzrdir.user_url)
 
2178
        finally:
 
2179
            self.pb.finished()
 
2180
 
 
2181
    def _convert_to_weaves(self):
 
2182
        ui.ui_factory.note('note: upgrade may be faster if all store files are ungzipped first')
 
2183
        try:
 
2184
            # TODO permissions
 
2185
            stat = self.bzrdir.transport.stat('weaves')
 
2186
            if not S_ISDIR(stat.st_mode):
 
2187
                self.bzrdir.transport.delete('weaves')
 
2188
                self.bzrdir.transport.mkdir('weaves')
 
2189
        except errors.NoSuchFile:
 
2190
            self.bzrdir.transport.mkdir('weaves')
 
2191
        # deliberately not a WeaveFile as we want to build it up slowly.
 
2192
        self.inv_weave = Weave('inventory')
 
2193
        # holds in-memory weaves for all files
 
2194
        self.text_weaves = {}
 
2195
        self.bzrdir.transport.delete('branch-format')
 
2196
        self.branch = self.bzrdir.open_branch()
 
2197
        self._convert_working_inv()
 
2198
        rev_history = self.branch.revision_history()
 
2199
        # to_read is a stack holding the revisions we still need to process;
 
2200
        # appending to it adds new highest-priority revisions
 
2201
        self.known_revisions = set(rev_history)
 
2202
        self.to_read = rev_history[-1:]
 
2203
        while self.to_read:
 
2204
            rev_id = self.to_read.pop()
 
2205
            if (rev_id not in self.revisions
 
2206
                and rev_id not in self.absent_revisions):
 
2207
                self._load_one_rev(rev_id)
 
2208
        self.pb.clear()
 
2209
        to_import = self._make_order()
 
2210
        for i, rev_id in enumerate(to_import):
 
2211
            self.pb.update('converting revision', i, len(to_import))
 
2212
            self._convert_one_rev(rev_id)
 
2213
        self.pb.clear()
 
2214
        self._write_all_weaves()
 
2215
        self._write_all_revs()
 
2216
        ui.ui_factory.note('upgraded to weaves:')
 
2217
        ui.ui_factory.note('  %6d revisions and inventories' % len(self.revisions))
 
2218
        ui.ui_factory.note('  %6d revisions not present' % len(self.absent_revisions))
 
2219
        ui.ui_factory.note('  %6d texts' % self.text_count)
 
2220
        self._cleanup_spare_files_after_format4()
 
2221
        self.branch._transport.put_bytes(
 
2222
            'branch-format',
 
2223
            BzrDirFormat5().get_format_string(),
 
2224
            mode=self.bzrdir._get_file_mode())
 
2225
 
 
2226
    def _cleanup_spare_files_after_format4(self):
 
2227
        # FIXME working tree upgrade foo.
 
2228
        for n in 'merged-patches', 'pending-merged-patches':
 
2229
            try:
 
2230
                ## assert os.path.getsize(p) == 0
 
2231
                self.bzrdir.transport.delete(n)
 
2232
            except errors.NoSuchFile:
 
2233
                pass
 
2234
        self.bzrdir.transport.delete_tree('inventory-store')
 
2235
        self.bzrdir.transport.delete_tree('text-store')
 
2236
 
 
2237
    def _convert_working_inv(self):
 
2238
        inv = xml4.serializer_v4.read_inventory(
 
2239
                self.branch._transport.get('inventory'))
 
2240
        new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv, working=True)
 
2241
        self.branch._transport.put_bytes('inventory', new_inv_xml,
 
2242
            mode=self.bzrdir._get_file_mode())
 
2243
 
 
2244
    def _write_all_weaves(self):
 
2245
        controlweaves = WeaveStore(self.bzrdir.transport, prefixed=False)
 
2246
        weave_transport = self.bzrdir.transport.clone('weaves')
 
2247
        weaves = WeaveStore(weave_transport, prefixed=False)
 
2248
        transaction = WriteTransaction()
 
2249
 
 
2250
        try:
 
2251
            i = 0
 
2252
            for file_id, file_weave in self.text_weaves.items():
 
2253
                self.pb.update('writing weave', i, len(self.text_weaves))
 
2254
                weaves._put_weave(file_id, file_weave, transaction)
 
2255
                i += 1
 
2256
            self.pb.update('inventory', 0, 1)
 
2257
            controlweaves._put_weave('inventory', self.inv_weave, transaction)
 
2258
            self.pb.update('inventory', 1, 1)
 
2259
        finally:
 
2260
            self.pb.clear()
 
2261
 
 
2262
    def _write_all_revs(self):
 
2263
        """Write all revisions out in new form."""
 
2264
        self.bzrdir.transport.delete_tree('revision-store')
 
2265
        self.bzrdir.transport.mkdir('revision-store')
 
2266
        revision_transport = self.bzrdir.transport.clone('revision-store')
 
2267
        # TODO permissions
 
2268
        from bzrlib.xml5 import serializer_v5
 
2269
        from bzrlib.repofmt.weaverepo import RevisionTextStore
 
2270
        revision_store = RevisionTextStore(revision_transport,
 
2271
            serializer_v5, False, versionedfile.PrefixMapper(),
 
2272
            lambda:True, lambda:True)
 
2273
        try:
 
2274
            for i, rev_id in enumerate(self.converted_revs):
 
2275
                self.pb.update('write revision', i, len(self.converted_revs))
 
2276
                text = serializer_v5.write_revision_to_string(
 
2277
                    self.revisions[rev_id])
 
2278
                key = (rev_id,)
 
2279
                revision_store.add_lines(key, None, osutils.split_lines(text))
 
2280
        finally:
 
2281
            self.pb.clear()
 
2282
 
 
2283
    def _load_one_rev(self, rev_id):
 
2284
        """Load a revision object into memory.
 
2285
 
 
2286
        Any parents not either loaded or abandoned get queued to be
 
2287
        loaded."""
 
2288
        self.pb.update('loading revision',
 
2289
                       len(self.revisions),
 
2290
                       len(self.known_revisions))
 
2291
        if not self.branch.repository.has_revision(rev_id):
 
2292
            self.pb.clear()
 
2293
            ui.ui_factory.note('revision {%s} not present in branch; '
 
2294
                         'will be converted as a ghost' %
 
2295
                         rev_id)
 
2296
            self.absent_revisions.add(rev_id)
 
2297
        else:
 
2298
            rev = self.branch.repository.get_revision(rev_id)
 
2299
            for parent_id in rev.parent_ids:
 
2300
                self.known_revisions.add(parent_id)
 
2301
                self.to_read.append(parent_id)
 
2302
            self.revisions[rev_id] = rev
 
2303
 
 
2304
    def _load_old_inventory(self, rev_id):
 
2305
        f = self.branch.repository.inventory_store.get(rev_id)
 
2306
        try:
 
2307
            old_inv_xml = f.read()
 
2308
        finally:
 
2309
            f.close()
 
2310
        inv = xml4.serializer_v4.read_inventory_from_string(old_inv_xml)
 
2311
        inv.revision_id = rev_id
 
2312
        rev = self.revisions[rev_id]
 
2313
        return inv
 
2314
 
 
2315
    def _load_updated_inventory(self, rev_id):
 
2316
        inv_xml = self.inv_weave.get_text(rev_id)
 
2317
        inv = xml5.serializer_v5.read_inventory_from_string(inv_xml, rev_id)
 
2318
        return inv
 
2319
 
 
2320
    def _convert_one_rev(self, rev_id):
 
2321
        """Convert revision and all referenced objects to new format."""
 
2322
        rev = self.revisions[rev_id]
 
2323
        inv = self._load_old_inventory(rev_id)
 
2324
        present_parents = [p for p in rev.parent_ids
 
2325
                           if p not in self.absent_revisions]
 
2326
        self._convert_revision_contents(rev, inv, present_parents)
 
2327
        self._store_new_inv(rev, inv, present_parents)
 
2328
        self.converted_revs.add(rev_id)
 
2329
 
 
2330
    def _store_new_inv(self, rev, inv, present_parents):
 
2331
        new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
 
2332
        new_inv_sha1 = sha_string(new_inv_xml)
 
2333
        self.inv_weave.add_lines(rev.revision_id,
 
2334
                                 present_parents,
 
2335
                                 new_inv_xml.splitlines(True))
 
2336
        rev.inventory_sha1 = new_inv_sha1
 
2337
 
 
2338
    def _convert_revision_contents(self, rev, inv, present_parents):
 
2339
        """Convert all the files within a revision.
 
2340
 
 
2341
        Also upgrade the inventory to refer to the text revision ids."""
 
2342
        rev_id = rev.revision_id
 
2343
        mutter('converting texts of revision {%s}',
 
2344
               rev_id)
 
2345
        parent_invs = map(self._load_updated_inventory, present_parents)
 
2346
        entries = inv.iter_entries()
 
2347
        entries.next()
 
2348
        for path, ie in entries:
 
2349
            self._convert_file_version(rev, ie, parent_invs)
 
2350
 
 
2351
    def _convert_file_version(self, rev, ie, parent_invs):
 
2352
        """Convert one version of one file.
 
2353
 
 
2354
        The file needs to be added into the weave if it is a merge
 
2355
        of >=2 parents or if it's changed from its parent.
 
2356
        """
 
2357
        file_id = ie.file_id
 
2358
        rev_id = rev.revision_id
 
2359
        w = self.text_weaves.get(file_id)
 
2360
        if w is None:
 
2361
            w = Weave(file_id)
 
2362
            self.text_weaves[file_id] = w
 
2363
        text_changed = False
 
2364
        parent_candiate_entries = ie.parent_candidates(parent_invs)
 
2365
        heads = graph.Graph(self).heads(parent_candiate_entries.keys())
 
2366
        # XXX: Note that this is unordered - and this is tolerable because
 
2367
        # the previous code was also unordered.
 
2368
        previous_entries = dict((head, parent_candiate_entries[head]) for head
 
2369
            in heads)
 
2370
        self.snapshot_ie(previous_entries, ie, w, rev_id)
 
2371
 
 
2372
    def get_parent_map(self, revision_ids):
 
2373
        """See graph.StackedParentsProvider.get_parent_map"""
 
2374
        return dict((revision_id, self.revisions[revision_id])
 
2375
                    for revision_id in revision_ids
 
2376
                     if revision_id in self.revisions)
 
2377
 
 
2378
    def snapshot_ie(self, previous_revisions, ie, w, rev_id):
 
2379
        # TODO: convert this logic, which is ~= snapshot to
 
2380
        # a call to:. This needs the path figured out. rather than a work_tree
 
2381
        # a v4 revision_tree can be given, or something that looks enough like
 
2382
        # one to give the file content to the entry if it needs it.
 
2383
        # and we need something that looks like a weave store for snapshot to
 
2384
        # save against.
 
2385
        #ie.snapshot(rev, PATH, previous_revisions, REVISION_TREE, InMemoryWeaveStore(self.text_weaves))
 
2386
        if len(previous_revisions) == 1:
 
2387
            previous_ie = previous_revisions.values()[0]
 
2388
            if ie._unchanged(previous_ie):
 
2389
                ie.revision = previous_ie.revision
 
2390
                return
 
2391
        if ie.has_text():
 
2392
            f = self.branch.repository._text_store.get(ie.text_id)
 
2393
            try:
 
2394
                file_lines = f.readlines()
 
2395
            finally:
 
2396
                f.close()
 
2397
            w.add_lines(rev_id, previous_revisions, file_lines)
 
2398
            self.text_count += 1
 
2399
        else:
 
2400
            w.add_lines(rev_id, previous_revisions, [])
 
2401
        ie.revision = rev_id
 
2402
 
 
2403
    def _make_order(self):
 
2404
        """Return a suitable order for importing revisions.
 
2405
 
 
2406
        The order must be such that an revision is imported after all
 
2407
        its (present) parents.
 
2408
        """
 
2409
        todo = set(self.revisions.keys())
 
2410
        done = self.absent_revisions.copy()
 
2411
        order = []
 
2412
        while todo:
 
2413
            # scan through looking for a revision whose parents
 
2414
            # are all done
 
2415
            for rev_id in sorted(list(todo)):
 
2416
                rev = self.revisions[rev_id]
 
2417
                parent_ids = set(rev.parent_ids)
 
2418
                if parent_ids.issubset(done):
 
2419
                    # can take this one now
 
2420
                    order.append(rev_id)
 
2421
                    todo.remove(rev_id)
 
2422
                    done.add(rev_id)
 
2423
        return order
 
2424
 
 
2425
 
 
2426
class ConvertBzrDir5To6(Converter):
 
2427
    """Converts format 5 bzr dirs to format 6."""
 
2428
 
 
2429
    def convert(self, to_convert, pb):
 
2430
        """See Converter.convert()."""
 
2431
        self.bzrdir = to_convert
 
2432
        pb = ui.ui_factory.nested_progress_bar()
 
2433
        try:
 
2434
            ui.ui_factory.note('starting upgrade from format 5 to 6')
 
2435
            self._convert_to_prefixed()
 
2436
            return BzrDir.open(self.bzrdir.user_url)
 
2437
        finally:
 
2438
            pb.finished()
 
2439
 
 
2440
    def _convert_to_prefixed(self):
 
2441
        from bzrlib.store import TransportStore
 
2442
        self.bzrdir.transport.delete('branch-format')
 
2443
        for store_name in ["weaves", "revision-store"]:
 
2444
            ui.ui_factory.note("adding prefixes to %s" % store_name)
 
2445
            store_transport = self.bzrdir.transport.clone(store_name)
 
2446
            store = TransportStore(store_transport, prefixed=True)
 
2447
            for urlfilename in store_transport.list_dir('.'):
 
2448
                filename = urlutils.unescape(urlfilename)
 
2449
                if (filename.endswith(".weave") or
 
2450
                    filename.endswith(".gz") or
 
2451
                    filename.endswith(".sig")):
 
2452
                    file_id, suffix = os.path.splitext(filename)
 
2453
                else:
 
2454
                    file_id = filename
 
2455
                    suffix = ''
 
2456
                new_name = store._mapper.map((file_id,)) + suffix
 
2457
                # FIXME keep track of the dirs made RBC 20060121
 
2458
                try:
 
2459
                    store_transport.move(filename, new_name)
 
2460
                except errors.NoSuchFile: # catches missing dirs strangely enough
 
2461
                    store_transport.mkdir(osutils.dirname(new_name))
 
2462
                    store_transport.move(filename, new_name)
 
2463
        self.bzrdir.transport.put_bytes(
 
2464
            'branch-format',
 
2465
            BzrDirFormat6().get_format_string(),
 
2466
            mode=self.bzrdir._get_file_mode())
 
2467
 
 
2468
 
 
2469
class ConvertBzrDir6ToMeta(Converter):
 
2470
    """Converts format 6 bzr dirs to metadirs."""
 
2471
 
 
2472
    def convert(self, to_convert, pb):
 
2473
        """See Converter.convert()."""
 
2474
        from bzrlib.repofmt.weaverepo import RepositoryFormat7
 
2475
        from bzrlib.branch import BzrBranchFormat5
 
2476
        self.bzrdir = to_convert
 
2477
        self.pb = ui.ui_factory.nested_progress_bar()
 
2478
        self.count = 0
 
2479
        self.total = 20 # the steps we know about
 
2480
        self.garbage_inventories = []
 
2481
        self.dir_mode = self.bzrdir._get_dir_mode()
 
2482
        self.file_mode = self.bzrdir._get_file_mode()
 
2483
 
 
2484
        ui.ui_factory.note('starting upgrade from format 6 to metadir')
 
2485
        self.bzrdir.transport.put_bytes(
 
2486
                'branch-format',
 
2487
                "Converting to format 6",
 
2488
                mode=self.file_mode)
 
2489
        # its faster to move specific files around than to open and use the apis...
 
2490
        # first off, nuke ancestry.weave, it was never used.
 
2491
        try:
 
2492
            self.step('Removing ancestry.weave')
 
2493
            self.bzrdir.transport.delete('ancestry.weave')
 
2494
        except errors.NoSuchFile:
 
2495
            pass
 
2496
        # find out whats there
 
2497
        self.step('Finding branch files')
 
2498
        last_revision = self.bzrdir.open_branch().last_revision()
 
2499
        bzrcontents = self.bzrdir.transport.list_dir('.')
 
2500
        for name in bzrcontents:
 
2501
            if name.startswith('basis-inventory.'):
 
2502
                self.garbage_inventories.append(name)
 
2503
        # create new directories for repository, working tree and branch
 
2504
        repository_names = [('inventory.weave', True),
 
2505
                            ('revision-store', True),
 
2506
                            ('weaves', True)]
 
2507
        self.step('Upgrading repository  ')
 
2508
        self.bzrdir.transport.mkdir('repository', mode=self.dir_mode)
 
2509
        self.make_lock('repository')
 
2510
        # we hard code the formats here because we are converting into
 
2511
        # the meta format. The meta format upgrader can take this to a
 
2512
        # future format within each component.
 
2513
        self.put_format('repository', RepositoryFormat7())
 
2514
        for entry in repository_names:
 
2515
            self.move_entry('repository', entry)
 
2516
 
 
2517
        self.step('Upgrading branch      ')
 
2518
        self.bzrdir.transport.mkdir('branch', mode=self.dir_mode)
 
2519
        self.make_lock('branch')
 
2520
        self.put_format('branch', BzrBranchFormat5())
 
2521
        branch_files = [('revision-history', True),
 
2522
                        ('branch-name', True),
 
2523
                        ('parent', False)]
 
2524
        for entry in branch_files:
 
2525
            self.move_entry('branch', entry)
 
2526
 
 
2527
        checkout_files = [('pending-merges', True),
 
2528
                          ('inventory', True),
 
2529
                          ('stat-cache', False)]
 
2530
        # If a mandatory checkout file is not present, the branch does not have
 
2531
        # a functional checkout. Do not create a checkout in the converted
 
2532
        # branch.
 
2533
        for name, mandatory in checkout_files:
 
2534
            if mandatory and name not in bzrcontents:
 
2535
                has_checkout = False
 
2536
                break
 
2537
        else:
 
2538
            has_checkout = True
 
2539
        if not has_checkout:
 
2540
            ui.ui_factory.note('No working tree.')
 
2541
            # If some checkout files are there, we may as well get rid of them.
 
2542
            for name, mandatory in checkout_files:
 
2543
                if name in bzrcontents:
 
2544
                    self.bzrdir.transport.delete(name)
 
2545
        else:
 
2546
            from bzrlib.workingtree import WorkingTreeFormat3
 
2547
            self.step('Upgrading working tree')
 
2548
            self.bzrdir.transport.mkdir('checkout', mode=self.dir_mode)
 
2549
            self.make_lock('checkout')
 
2550
            self.put_format(
 
2551
                'checkout', WorkingTreeFormat3())
 
2552
            self.bzrdir.transport.delete_multi(
 
2553
                self.garbage_inventories, self.pb)
 
2554
            for entry in checkout_files:
 
2555
                self.move_entry('checkout', entry)
 
2556
            if last_revision is not None:
 
2557
                self.bzrdir.transport.put_bytes(
 
2558
                    'checkout/last-revision', last_revision)
 
2559
        self.bzrdir.transport.put_bytes(
 
2560
            'branch-format',
 
2561
            BzrDirMetaFormat1().get_format_string(),
 
2562
            mode=self.file_mode)
 
2563
        self.pb.finished()
 
2564
        return BzrDir.open(self.bzrdir.user_url)
 
2565
 
 
2566
    def make_lock(self, name):
 
2567
        """Make a lock for the new control dir name."""
 
2568
        self.step('Make %s lock' % name)
 
2569
        ld = lockdir.LockDir(self.bzrdir.transport,
 
2570
                             '%s/lock' % name,
 
2571
                             file_modebits=self.file_mode,
 
2572
                             dir_modebits=self.dir_mode)
 
2573
        ld.create()
 
2574
 
 
2575
    def move_entry(self, new_dir, entry):
 
2576
        """Move then entry name into new_dir."""
 
2577
        name = entry[0]
 
2578
        mandatory = entry[1]
 
2579
        self.step('Moving %s' % name)
 
2580
        try:
 
2581
            self.bzrdir.transport.move(name, '%s/%s' % (new_dir, name))
 
2582
        except errors.NoSuchFile:
 
2583
            if mandatory:
 
2584
                raise
 
2585
 
 
2586
    def put_format(self, dirname, format):
 
2587
        self.bzrdir.transport.put_bytes('%s/format' % dirname,
 
2588
            format.get_format_string(),
 
2589
            self.file_mode)
 
2590
 
 
2591
 
 
2592
class ConvertMetaToMeta(Converter):
1782
2593
    """Converts the components of metadirs."""
1783
2594
 
1784
2595
    def __init__(self, target_format):
1802
2613
        else:
1803
2614
            if not isinstance(repo._format, self.target_format.repository_format.__class__):
1804
2615
                from bzrlib.repository import CopyConverter
1805
 
                ui.ui_factory.note(gettext('starting repository conversion'))
 
2616
                ui.ui_factory.note('starting repository conversion')
1806
2617
                converter = CopyConverter(self.target_format.repository_format)
1807
2618
                converter.convert(repo, pb)
1808
2619
        for branch in self.bzrdir.list_branches():
1809
2620
            # TODO: conversions of Branch and Tree should be done by
1810
2621
            # InterXFormat lookups/some sort of registry.
1811
2622
            # Avoid circular imports
 
2623
            from bzrlib import branch as _mod_branch
1812
2624
            old = branch._format.__class__
1813
2625
            new = self.target_format.get_branch_format().__class__
1814
2626
            while old != new:
1815
 
                if (old == fullhistorybranch.BzrBranchFormat5 and
 
2627
                if (old == _mod_branch.BzrBranchFormat5 and
1816
2628
                    new in (_mod_branch.BzrBranchFormat6,
1817
2629
                        _mod_branch.BzrBranchFormat7,
1818
2630
                        _mod_branch.BzrBranchFormat8)):
1837
2649
        else:
1838
2650
            # TODO: conversions of Branch and Tree should be done by
1839
2651
            # InterXFormat lookups
1840
 
            if (isinstance(tree, workingtree_3.WorkingTree3) and
 
2652
            if (isinstance(tree, workingtree.WorkingTree3) and
1841
2653
                not isinstance(tree, workingtree_4.DirStateWorkingTree) and
1842
2654
                isinstance(self.target_format.workingtree_format,
1843
2655
                    workingtree_4.DirStateWorkingTreeFormat)):
1856
2668
        return to_convert
1857
2669
 
1858
2670
 
1859
 
class ConvertMetaToColo(controldir.Converter):
1860
 
    """Add colocated branch support."""
1861
 
 
1862
 
    def __init__(self, target_format):
1863
 
        """Create a converter.that upgrades a metadir to the colo format.
1864
 
 
1865
 
        :param target_format: The final metadir format that is desired.
1866
 
        """
1867
 
        self.target_format = target_format
1868
 
 
1869
 
    def convert(self, to_convert, pb):
1870
 
        """See Converter.convert()."""
1871
 
        to_convert.transport.put_bytes('branch-format',
1872
 
            self.target_format.as_string())
1873
 
        return BzrDir.open_from_transport(to_convert.root_transport)
1874
 
 
1875
 
 
1876
 
class ConvertMetaToColo(controldir.Converter):
1877
 
    """Convert a 'development-colo' bzrdir to a '2a' bzrdir."""
1878
 
 
1879
 
    def __init__(self, target_format):
1880
 
        """Create a converter that converts a 'development-colo' metadir
1881
 
        to a '2a' metadir.
1882
 
 
1883
 
        :param target_format: The final metadir format that is desired.
1884
 
        """
1885
 
        self.target_format = target_format
1886
 
 
1887
 
    def convert(self, to_convert, pb):
1888
 
        """See Converter.convert()."""
1889
 
        to_convert.transport.put_bytes('branch-format',
1890
 
            self.target_format.as_string())
1891
 
        return BzrDir.open_from_transport(to_convert.root_transport)
 
2671
# This is not in remote.py because it's relatively small, and needs to be
 
2672
# registered. Putting it in remote.py creates a circular import problem.
 
2673
# we can make it a lazy object if the control formats is turned into something
 
2674
# like a registry.
 
2675
class RemoteBzrDirFormat(BzrDirMetaFormat1):
 
2676
    """Format representing bzrdirs accessed via a smart server"""
 
2677
 
 
2678
    supports_workingtrees = False
 
2679
 
 
2680
    def __init__(self):
 
2681
        BzrDirMetaFormat1.__init__(self)
 
2682
        # XXX: It's a bit ugly that the network name is here, because we'd
 
2683
        # like to believe that format objects are stateless or at least
 
2684
        # immutable,  However, we do at least avoid mutating the name after
 
2685
        # it's returned.  See <https://bugs.launchpad.net/bzr/+bug/504102>
 
2686
        self._network_name = None
 
2687
 
 
2688
    def __repr__(self):
 
2689
        return "%s(_network_name=%r)" % (self.__class__.__name__,
 
2690
            self._network_name)
 
2691
 
 
2692
    def get_format_description(self):
 
2693
        if self._network_name:
 
2694
            real_format = controldir.network_format_registry.get(self._network_name)
 
2695
            return 'Remote: ' + real_format.get_format_description()
 
2696
        return 'bzr remote bzrdir'
 
2697
 
 
2698
    def get_format_string(self):
 
2699
        raise NotImplementedError(self.get_format_string)
 
2700
 
 
2701
    def network_name(self):
 
2702
        if self._network_name:
 
2703
            return self._network_name
 
2704
        else:
 
2705
            raise AssertionError("No network name set.")
 
2706
 
 
2707
    def initialize_on_transport(self, transport):
 
2708
        try:
 
2709
            # hand off the request to the smart server
 
2710
            client_medium = transport.get_smart_medium()
 
2711
        except errors.NoSmartMedium:
 
2712
            # TODO: lookup the local format from a server hint.
 
2713
            local_dir_format = BzrDirMetaFormat1()
 
2714
            return local_dir_format.initialize_on_transport(transport)
 
2715
        client = _SmartClient(client_medium)
 
2716
        path = client.remote_path_from_transport(transport)
 
2717
        try:
 
2718
            response = client.call('BzrDirFormat.initialize', path)
 
2719
        except errors.ErrorFromSmartServer, err:
 
2720
            remote._translate_error(err, path=path)
 
2721
        if response[0] != 'ok':
 
2722
            raise errors.SmartProtocolError('unexpected response code %s' % (response,))
 
2723
        format = RemoteBzrDirFormat()
 
2724
        self._supply_sub_formats_to(format)
 
2725
        return remote.RemoteBzrDir(transport, format)
 
2726
 
 
2727
    def parse_NoneTrueFalse(self, arg):
 
2728
        if not arg:
 
2729
            return None
 
2730
        if arg == 'False':
 
2731
            return False
 
2732
        if arg == 'True':
 
2733
            return True
 
2734
        raise AssertionError("invalid arg %r" % arg)
 
2735
 
 
2736
    def _serialize_NoneTrueFalse(self, arg):
 
2737
        if arg is False:
 
2738
            return 'False'
 
2739
        if arg:
 
2740
            return 'True'
 
2741
        return ''
 
2742
 
 
2743
    def _serialize_NoneString(self, arg):
 
2744
        return arg or ''
 
2745
 
 
2746
    def initialize_on_transport_ex(self, transport, use_existing_dir=False,
 
2747
        create_prefix=False, force_new_repo=False, stacked_on=None,
 
2748
        stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
 
2749
        shared_repo=False):
 
2750
        try:
 
2751
            # hand off the request to the smart server
 
2752
            client_medium = transport.get_smart_medium()
 
2753
        except errors.NoSmartMedium:
 
2754
            do_vfs = True
 
2755
        else:
 
2756
            # Decline to open it if the server doesn't support our required
 
2757
            # version (3) so that the VFS-based transport will do it.
 
2758
            if client_medium.should_probe():
 
2759
                try:
 
2760
                    server_version = client_medium.protocol_version()
 
2761
                    if server_version != '2':
 
2762
                        do_vfs = True
 
2763
                    else:
 
2764
                        do_vfs = False
 
2765
                except errors.SmartProtocolError:
 
2766
                    # Apparently there's no usable smart server there, even though
 
2767
                    # the medium supports the smart protocol.
 
2768
                    do_vfs = True
 
2769
            else:
 
2770
                do_vfs = False
 
2771
        if not do_vfs:
 
2772
            client = _SmartClient(client_medium)
 
2773
            path = client.remote_path_from_transport(transport)
 
2774
            if client_medium._is_remote_before((1, 16)):
 
2775
                do_vfs = True
 
2776
        if do_vfs:
 
2777
            # TODO: lookup the local format from a server hint.
 
2778
            local_dir_format = BzrDirMetaFormat1()
 
2779
            self._supply_sub_formats_to(local_dir_format)
 
2780
            return local_dir_format.initialize_on_transport_ex(transport,
 
2781
                use_existing_dir=use_existing_dir, create_prefix=create_prefix,
 
2782
                force_new_repo=force_new_repo, stacked_on=stacked_on,
 
2783
                stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
 
2784
                make_working_trees=make_working_trees, shared_repo=shared_repo,
 
2785
                vfs_only=True)
 
2786
        return self._initialize_on_transport_ex_rpc(client, path, transport,
 
2787
            use_existing_dir, create_prefix, force_new_repo, stacked_on,
 
2788
            stack_on_pwd, repo_format_name, make_working_trees, shared_repo)
 
2789
 
 
2790
    def _initialize_on_transport_ex_rpc(self, client, path, transport,
 
2791
        use_existing_dir, create_prefix, force_new_repo, stacked_on,
 
2792
        stack_on_pwd, repo_format_name, make_working_trees, shared_repo):
 
2793
        args = []
 
2794
        args.append(self._serialize_NoneTrueFalse(use_existing_dir))
 
2795
        args.append(self._serialize_NoneTrueFalse(create_prefix))
 
2796
        args.append(self._serialize_NoneTrueFalse(force_new_repo))
 
2797
        args.append(self._serialize_NoneString(stacked_on))
 
2798
        # stack_on_pwd is often/usually our transport
 
2799
        if stack_on_pwd:
 
2800
            try:
 
2801
                stack_on_pwd = transport.relpath(stack_on_pwd)
 
2802
                if not stack_on_pwd:
 
2803
                    stack_on_pwd = '.'
 
2804
            except errors.PathNotChild:
 
2805
                pass
 
2806
        args.append(self._serialize_NoneString(stack_on_pwd))
 
2807
        args.append(self._serialize_NoneString(repo_format_name))
 
2808
        args.append(self._serialize_NoneTrueFalse(make_working_trees))
 
2809
        args.append(self._serialize_NoneTrueFalse(shared_repo))
 
2810
        request_network_name = self._network_name or \
 
2811
            BzrDirFormat.get_default_format().network_name()
 
2812
        try:
 
2813
            response = client.call('BzrDirFormat.initialize_ex_1.16',
 
2814
                request_network_name, path, *args)
 
2815
        except errors.UnknownSmartMethod:
 
2816
            client._medium._remember_remote_is_before((1,16))
 
2817
            local_dir_format = BzrDirMetaFormat1()
 
2818
            self._supply_sub_formats_to(local_dir_format)
 
2819
            return local_dir_format.initialize_on_transport_ex(transport,
 
2820
                use_existing_dir=use_existing_dir, create_prefix=create_prefix,
 
2821
                force_new_repo=force_new_repo, stacked_on=stacked_on,
 
2822
                stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
 
2823
                make_working_trees=make_working_trees, shared_repo=shared_repo,
 
2824
                vfs_only=True)
 
2825
        except errors.ErrorFromSmartServer, err:
 
2826
            remote._translate_error(err, path=path)
 
2827
        repo_path = response[0]
 
2828
        bzrdir_name = response[6]
 
2829
        require_stacking = response[7]
 
2830
        require_stacking = self.parse_NoneTrueFalse(require_stacking)
 
2831
        format = RemoteBzrDirFormat()
 
2832
        format._network_name = bzrdir_name
 
2833
        self._supply_sub_formats_to(format)
 
2834
        bzrdir = remote.RemoteBzrDir(transport, format, _client=client)
 
2835
        if repo_path:
 
2836
            repo_format = remote.response_tuple_to_repo_format(response[1:])
 
2837
            if repo_path == '.':
 
2838
                repo_path = ''
 
2839
            if repo_path:
 
2840
                repo_bzrdir_format = RemoteBzrDirFormat()
 
2841
                repo_bzrdir_format._network_name = response[5]
 
2842
                repo_bzr = remote.RemoteBzrDir(transport.clone(repo_path),
 
2843
                    repo_bzrdir_format)
 
2844
            else:
 
2845
                repo_bzr = bzrdir
 
2846
            final_stack = response[8] or None
 
2847
            final_stack_pwd = response[9] or None
 
2848
            if final_stack_pwd:
 
2849
                final_stack_pwd = urlutils.join(
 
2850
                    transport.base, final_stack_pwd)
 
2851
            remote_repo = remote.RemoteRepository(repo_bzr, repo_format)
 
2852
            if len(response) > 10:
 
2853
                # Updated server verb that locks remotely.
 
2854
                repo_lock_token = response[10] or None
 
2855
                remote_repo.lock_write(repo_lock_token, _skip_rpc=True)
 
2856
                if repo_lock_token:
 
2857
                    remote_repo.dont_leave_lock_in_place()
 
2858
            else:
 
2859
                remote_repo.lock_write()
 
2860
            policy = UseExistingRepository(remote_repo, final_stack,
 
2861
                final_stack_pwd, require_stacking)
 
2862
            policy.acquire_repository()
 
2863
        else:
 
2864
            remote_repo = None
 
2865
            policy = None
 
2866
        bzrdir._format.set_branch_format(self.get_branch_format())
 
2867
        if require_stacking:
 
2868
            # The repo has already been created, but we need to make sure that
 
2869
            # we'll make a stackable branch.
 
2870
            bzrdir._format.require_stacking(_skip_repo=True)
 
2871
        return remote_repo, bzrdir, require_stacking, policy
 
2872
 
 
2873
    def _open(self, transport):
 
2874
        return remote.RemoteBzrDir(transport, self)
 
2875
 
 
2876
    def __eq__(self, other):
 
2877
        if not isinstance(other, RemoteBzrDirFormat):
 
2878
            return False
 
2879
        return self.get_format_description() == other.get_format_description()
 
2880
 
 
2881
    def __return_repository_format(self):
 
2882
        # Always return a RemoteRepositoryFormat object, but if a specific bzr
 
2883
        # repository format has been asked for, tell the RemoteRepositoryFormat
 
2884
        # that it should use that for init() etc.
 
2885
        result = remote.RemoteRepositoryFormat()
 
2886
        custom_format = getattr(self, '_repository_format', None)
 
2887
        if custom_format:
 
2888
            if isinstance(custom_format, remote.RemoteRepositoryFormat):
 
2889
                return custom_format
 
2890
            else:
 
2891
                # We will use the custom format to create repositories over the
 
2892
                # wire; expose its details like rich_root_data for code to
 
2893
                # query
 
2894
                result._custom_format = custom_format
 
2895
        return result
 
2896
 
 
2897
    def get_branch_format(self):
 
2898
        result = BzrDirMetaFormat1.get_branch_format(self)
 
2899
        if not isinstance(result, remote.RemoteBranchFormat):
 
2900
            new_result = remote.RemoteBranchFormat()
 
2901
            new_result._custom_format = result
 
2902
            # cache the result
 
2903
            self.set_branch_format(new_result)
 
2904
            result = new_result
 
2905
        return result
 
2906
 
 
2907
    repository_format = property(__return_repository_format,
 
2908
        BzrDirMetaFormat1._set_repository_format) #.im_func)
1892
2909
 
1893
2910
 
1894
2911
controldir.ControlDirFormat.register_server_prober(RemoteBzrProber)
1973
2990
        else:
1974
2991
            self._require_stacking = True
1975
2992
 
1976
 
    def acquire_repository(self, make_working_trees=None, shared=False,
1977
 
            possible_transports=None):
 
2993
    def acquire_repository(self, make_working_trees=None, shared=False):
1978
2994
        """Acquire a repository for this bzrdir.
1979
2995
 
1980
2996
        Implementations may create a new repository or use a pre-exising
1981
2997
        repository.
1982
 
 
1983
2998
        :param make_working_trees: If creating a repository, set
1984
2999
            make_working_trees to this value (if non-None)
1985
3000
        :param shared: If creating a repository, make it shared if True
1986
3001
        :return: A repository, is_new_flag (True if the repository was
1987
3002
            created).
1988
3003
        """
1989
 
        raise NotImplementedError(RepositoryAcquisitionPolicy.acquire_repository)
 
3004
        raise NotImplemented(RepositoryAcquisitionPolicy.acquire_repository)
1990
3005
 
1991
3006
 
1992
3007
class CreateRepository(RepositoryAcquisitionPolicy):
1994
3009
 
1995
3010
    def __init__(self, bzrdir, stack_on=None, stack_on_pwd=None,
1996
3011
                 require_stacking=False):
1997
 
        """Constructor.
1998
 
 
 
3012
        """
 
3013
        Constructor.
1999
3014
        :param bzrdir: The bzrdir to create the repository on.
2000
3015
        :param stack_on: A location to stack on
2001
3016
        :param stack_on_pwd: If stack_on is relative, the location it is
2005
3020
                                             require_stacking)
2006
3021
        self._bzrdir = bzrdir
2007
3022
 
2008
 
    def acquire_repository(self, make_working_trees=None, shared=False,
2009
 
            possible_transports=None):
 
3023
    def acquire_repository(self, make_working_trees=None, shared=False):
2010
3024
        """Implementation of RepositoryAcquisitionPolicy.acquire_repository
2011
3025
 
2012
3026
        Creates the desired repository in the bzrdir we already have.
2013
3027
        """
2014
 
        if possible_transports is None:
2015
 
            possible_transports = []
2016
 
        else:
2017
 
            possible_transports = list(possible_transports)
2018
 
        possible_transports.append(self._bzrdir.root_transport)
2019
3028
        stack_on = self._get_full_stack_on()
2020
3029
        if stack_on:
2021
3030
            format = self._bzrdir._format
2022
3031
            format.require_stacking(stack_on=stack_on,
2023
 
                                    possible_transports=possible_transports)
 
3032
                                    possible_transports=[self._bzrdir.root_transport])
2024
3033
            if not self._require_stacking:
2025
3034
                # We have picked up automatic stacking somewhere.
2026
 
                note(gettext('Using default stacking branch {0} at {1}').format(
2027
 
                    self._stack_on, self._stack_on_pwd))
 
3035
                note('Using default stacking branch %s at %s', self._stack_on,
 
3036
                    self._stack_on_pwd)
2028
3037
        repository = self._bzrdir.create_repository(shared=shared)
2029
3038
        self._add_fallback(repository,
2030
 
                           possible_transports=possible_transports)
 
3039
                           possible_transports=[self._bzrdir.transport])
2031
3040
        if make_working_trees is not None:
2032
3041
            repository.set_make_working_trees(make_working_trees)
2033
3042
        return repository, True
2049
3058
                                             require_stacking)
2050
3059
        self._repository = repository
2051
3060
 
2052
 
    def acquire_repository(self, make_working_trees=None, shared=False,
2053
 
            possible_transports=None):
 
3061
    def acquire_repository(self, make_working_trees=None, shared=False):
2054
3062
        """Implementation of RepositoryAcquisitionPolicy.acquire_repository
2055
3063
 
2056
3064
        Returns an existing repository to use.
2057
3065
        """
2058
 
        if possible_transports is None:
2059
 
            possible_transports = []
2060
 
        else:
2061
 
            possible_transports = list(possible_transports)
2062
 
        possible_transports.append(self._repository.bzrdir.transport)
2063
3066
        self._add_fallback(self._repository,
2064
 
                       possible_transports=possible_transports)
 
3067
                       possible_transports=[self._repository.bzrdir.transport])
2065
3068
        return self._repository, False
2066
3069
 
2067
3070
 
2071
3074
         tree_format=None,
2072
3075
         hidden=False,
2073
3076
         experimental=False,
2074
 
         alias=False, bzrdir_format=None):
 
3077
         alias=False):
2075
3078
    """Register a metadir subformat.
2076
3079
 
2077
 
    These all use a meta bzrdir, but can be parameterized by the
2078
 
    Repository/Branch/WorkingTreeformats.
 
3080
    These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
 
3081
    by the Repository/Branch/WorkingTreeformats.
2079
3082
 
2080
3083
    :param repository_format: The fully-qualified repository format class
2081
3084
        name as a string.
2084
3087
    :param tree_format: Fully-qualified tree format class name as
2085
3088
        a string.
2086
3089
    """
2087
 
    if bzrdir_format is None:
2088
 
        bzrdir_format = BzrDirMetaFormat1
2089
3090
    # This should be expanded to support setting WorkingTree and Branch
2090
 
    # formats, once the API supports that.
 
3091
    # formats, once BzrDirMetaFormat1 supports that.
2091
3092
    def _load(full_name):
2092
3093
        mod_name, factory_name = full_name.rsplit('.', 1)
2093
3094
        try:
2094
 
            factory = pyutils.get_named_object(mod_name, factory_name)
 
3095
            mod = __import__(mod_name, globals(), locals(),
 
3096
                    [factory_name])
2095
3097
        except ImportError, e:
2096
3098
            raise ImportError('failed to load %s: %s' % (full_name, e))
 
3099
        try:
 
3100
            factory = getattr(mod, factory_name)
2097
3101
        except AttributeError:
2098
3102
            raise AttributeError('no factory %s in module %r'
2099
 
                % (full_name, sys.modules[mod_name]))
 
3103
                % (full_name, mod))
2100
3104
        return factory()
2101
3105
 
2102
3106
    def helper():
2103
 
        bd = bzrdir_format()
 
3107
        bd = BzrDirMetaFormat1()
2104
3108
        if branch_format is not None:
2105
3109
            bd.set_branch_format(_load(branch_format))
2106
3110
        if tree_format is not None:
2111
3115
    registry.register(key, helper, help, native, deprecated, hidden,
2112
3116
        experimental, alias)
2113
3117
 
 
3118
# The pre-0.8 formats have their repository format network name registered in
 
3119
# repository.py. MetaDir formats have their repository format network name
 
3120
# inferred from their disk format string.
 
3121
controldir.format_registry.register('weave', BzrDirFormat6,
 
3122
    'Pre-0.8 format.  Slower than knit and does not'
 
3123
    ' support checkouts or shared repositories.',
 
3124
    hidden=True,
 
3125
    deprecated=True)
 
3126
register_metadir(controldir.format_registry, 'metaweave',
 
3127
    'bzrlib.repofmt.weaverepo.RepositoryFormat7',
 
3128
    'Transitional format in 0.8.  Slower than knit.',
 
3129
    branch_format='bzrlib.branch.BzrBranchFormat5',
 
3130
    tree_format='bzrlib.workingtree.WorkingTreeFormat3',
 
3131
    hidden=True,
 
3132
    deprecated=True)
2114
3133
register_metadir(controldir.format_registry, 'knit',
2115
3134
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2116
3135
    'Format using knits.  Recommended for interoperation with bzr <= 0.14.',
2117
 
    branch_format='bzrlib.branchfmt.fullhistory.BzrBranchFormat5',
2118
 
    tree_format='bzrlib.workingtree_3.WorkingTreeFormat3',
 
3136
    branch_format='bzrlib.branch.BzrBranchFormat5',
 
3137
    tree_format='bzrlib.workingtree.WorkingTreeFormat3',
2119
3138
    hidden=True,
2120
3139
    deprecated=True)
2121
3140
register_metadir(controldir.format_registry, 'dirstate',
2122
3141
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2123
 
    help='Format using dirstate for working trees. '
2124
 
        'Compatible with bzr 0.8 and '
2125
 
        'above when accessed over the network. Introduced in bzr 0.15.',
2126
 
    branch_format='bzrlib.branchfmt.fullhistory.BzrBranchFormat5',
2127
 
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
3142
    help='New in 0.15: Fast local operations. Compatible with bzr 0.8 and '
 
3143
        'above when accessed over the network.',
 
3144
    branch_format='bzrlib.branch.BzrBranchFormat5',
 
3145
    # this uses bzrlib.workingtree.WorkingTreeFormat4 because importing
 
3146
    # directly from workingtree_4 triggers a circular import.
 
3147
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2128
3148
    hidden=True,
2129
3149
    deprecated=True)
2130
3150
register_metadir(controldir.format_registry, 'dirstate-tags',
2131
3151
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2132
 
    help='Variant of dirstate with support for tags. '
2133
 
        'Introduced in bzr 0.15.',
 
3152
    help='New in 0.15: Fast local operations and improved scaling for '
 
3153
        'network operations. Additionally adds support for tags.'
 
3154
        ' Incompatible with bzr < 0.15.',
2134
3155
    branch_format='bzrlib.branch.BzrBranchFormat6',
2135
 
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
3156
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2136
3157
    hidden=True,
2137
3158
    deprecated=True)
2138
3159
register_metadir(controldir.format_registry, 'rich-root',
2139
3160
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
2140
 
    help='Variant of dirstate with better handling of tree roots. '
2141
 
        'Introduced in bzr 1.0',
 
3161
    help='New in 1.0.  Better handling of tree roots.  Incompatible with'
 
3162
        ' bzr < 1.0.',
2142
3163
    branch_format='bzrlib.branch.BzrBranchFormat6',
2143
 
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
3164
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2144
3165
    hidden=True,
2145
3166
    deprecated=True)
2146
3167
register_metadir(controldir.format_registry, 'dirstate-with-subtree',
2147
3168
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
2148
 
    help='Variant of dirstate with support for nested trees. '
2149
 
         'Introduced in 0.15.',
 
3169
    help='New in 0.15: Fast local operations and improved scaling for '
 
3170
        'network operations. Additionally adds support for versioning nested '
 
3171
        'bzr branches. Incompatible with bzr < 0.15.',
2150
3172
    branch_format='bzrlib.branch.BzrBranchFormat6',
2151
 
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
3173
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2152
3174
    experimental=True,
2153
3175
    hidden=True,
2154
3176
    )
2155
3177
register_metadir(controldir.format_registry, 'pack-0.92',
2156
 
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack1',
2157
 
    help='Pack-based format used in 1.x series. Introduced in 0.92. '
2158
 
        'Interoperates with bzr repositories before 0.92 but cannot be '
2159
 
        'read by bzr < 0.92. '
 
3178
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack1',
 
3179
    help='New in 0.92: Pack-based format with data compatible with '
 
3180
        'dirstate-tags format repositories. Interoperates with '
 
3181
        'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
2160
3182
        ,
2161
3183
    branch_format='bzrlib.branch.BzrBranchFormat6',
2162
 
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2163
 
    deprecated=True,
 
3184
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2164
3185
    )
2165
3186
register_metadir(controldir.format_registry, 'pack-0.92-subtree',
2166
 
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack3',
2167
 
    help='Pack-based format used in 1.x series, with subtree support. '
2168
 
        'Introduced in 0.92. Interoperates with '
 
3187
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack3',
 
3188
    help='New in 0.92: Pack-based format with data compatible with '
 
3189
        'dirstate-with-subtree format repositories. Interoperates with '
2169
3190
        'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
2170
3191
        ,
2171
3192
    branch_format='bzrlib.branch.BzrBranchFormat6',
2172
 
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
3193
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2173
3194
    hidden=True,
2174
 
    deprecated=True,
2175
3195
    experimental=True,
2176
3196
    )
2177
3197
register_metadir(controldir.format_registry, 'rich-root-pack',
2178
 
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack4',
2179
 
    help='A variant of pack-0.92 that supports rich-root data '
2180
 
         '(needed for bzr-svn and bzr-git). Introduced in 1.0.',
 
3198
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
 
3199
    help='New in 1.0: A variant of pack-0.92 that supports rich-root data '
 
3200
         '(needed for bzr-svn and bzr-git).',
2181
3201
    branch_format='bzrlib.branch.BzrBranchFormat6',
2182
 
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
3202
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2183
3203
    hidden=True,
2184
 
    deprecated=True,
2185
3204
    )
2186
3205
register_metadir(controldir.format_registry, '1.6',
2187
 
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack5',
 
3206
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5',
2188
3207
    help='A format that allows a branch to indicate that there is another '
2189
3208
         '(stacked) repository that should be used to access data that is '
2190
3209
         'not present locally.',
2191
3210
    branch_format='bzrlib.branch.BzrBranchFormat7',
2192
 
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
3211
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2193
3212
    hidden=True,
2194
 
    deprecated=True,
2195
3213
    )
2196
3214
register_metadir(controldir.format_registry, '1.6.1-rich-root',
2197
 
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack5RichRoot',
 
3215
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5RichRoot',
2198
3216
    help='A variant of 1.6 that supports rich-root data '
2199
3217
         '(needed for bzr-svn and bzr-git).',
2200
3218
    branch_format='bzrlib.branch.BzrBranchFormat7',
2201
 
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
3219
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2202
3220
    hidden=True,
2203
 
    deprecated=True,
2204
3221
    )
2205
3222
register_metadir(controldir.format_registry, '1.9',
2206
 
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6',
 
3223
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
2207
3224
    help='A repository format using B+tree indexes. These indexes '
2208
3225
         'are smaller in size, have smarter caching and provide faster '
2209
3226
         'performance for most operations.',
2210
3227
    branch_format='bzrlib.branch.BzrBranchFormat7',
2211
 
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
3228
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2212
3229
    hidden=True,
2213
 
    deprecated=True,
2214
3230
    )
2215
3231
register_metadir(controldir.format_registry, '1.9-rich-root',
2216
 
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6RichRoot',
 
3232
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
2217
3233
    help='A variant of 1.9 that supports rich-root data '
2218
3234
         '(needed for bzr-svn and bzr-git).',
2219
3235
    branch_format='bzrlib.branch.BzrBranchFormat7',
2220
 
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
3236
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2221
3237
    hidden=True,
2222
 
    deprecated=True,
2223
3238
    )
2224
3239
register_metadir(controldir.format_registry, '1.14',
2225
 
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6',
 
3240
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
2226
3241
    help='A working-tree format that supports content filtering.',
2227
3242
    branch_format='bzrlib.branch.BzrBranchFormat7',
2228
 
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat5',
2229
 
    hidden=True,
2230
 
    deprecated=True,
 
3243
    tree_format='bzrlib.workingtree.WorkingTreeFormat5',
2231
3244
    )
2232
3245
register_metadir(controldir.format_registry, '1.14-rich-root',
2233
 
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6RichRoot',
 
3246
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
2234
3247
    help='A variant of 1.14 that supports rich-root data '
2235
3248
         '(needed for bzr-svn and bzr-git).',
2236
3249
    branch_format='bzrlib.branch.BzrBranchFormat7',
2237
 
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat5',
2238
 
    hidden=True,
2239
 
    deprecated=True,
 
3250
    tree_format='bzrlib.workingtree.WorkingTreeFormat5',
2240
3251
    )
2241
3252
# The following un-numbered 'development' formats should always just be aliases.
 
3253
register_metadir(controldir.format_registry, 'development-rich-root',
 
3254
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
 
3255
    help='Current development format. Supports rich roots. Can convert data '
 
3256
        'to and from rich-root-pack (and anything compatible with '
 
3257
        'rich-root-pack) format repositories. Repositories and branches in '
 
3258
        'this format can only be read by bzr.dev. Please read '
 
3259
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
 
3260
        'before use.',
 
3261
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
3262
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
 
3263
    experimental=True,
 
3264
    alias=True,
 
3265
    hidden=True,
 
3266
    )
 
3267
register_metadir(controldir.format_registry, 'development5-subtree',
 
3268
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment2Subtree',
 
3269
    help='Development format, subtree variant. Can convert data to and '
 
3270
        'from pack-0.92-subtree (and anything compatible with '
 
3271
        'pack-0.92-subtree) format repositories. Repositories and branches in '
 
3272
        'this format can only be read by bzr.dev. Please read '
 
3273
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
 
3274
        'before use.',
 
3275
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
3276
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
 
3277
    experimental=True,
 
3278
    hidden=True,
 
3279
    alias=False,
 
3280
    )
 
3281
 
 
3282
 
2242
3283
register_metadir(controldir.format_registry, 'development-subtree',
2243
3284
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2aSubtree',
2244
3285
    help='Current development format, subtree variant. Can convert data to and '
2248
3289
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
2249
3290
        'before use.',
2250
3291
    branch_format='bzrlib.branch.BzrBranchFormat7',
2251
 
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
 
3292
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
2252
3293
    experimental=True,
2253
3294
    hidden=True,
2254
3295
    alias=False, # Restore to being an alias when an actual development subtree format is added
2255
3296
                 # This current non-alias status is simply because we did not introduce a
2256
3297
                 # chk based subtree format.
2257
3298
    )
2258
 
register_metadir(controldir.format_registry, 'development5-subtree',
2259
 
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatPackDevelopment2Subtree',
2260
 
    help='Development format, subtree variant. Can convert data to and '
2261
 
        'from pack-0.92-subtree (and anything compatible with '
2262
 
        'pack-0.92-subtree) format repositories. Repositories and branches in '
2263
 
        'this format can only be read by bzr.dev. Please read '
2264
 
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
2265
 
        'before use.',
2266
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
2267
 
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
2268
 
    experimental=True,
2269
 
    hidden=True,
2270
 
    alias=False,
2271
 
    )
2272
 
 
2273
 
register_metadir(controldir.format_registry, 'development-colo',
2274
 
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
2275
 
    help='The 2a format with experimental support for colocated branches.\n',
2276
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
2277
 
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
2278
 
    experimental=True,
2279
 
    bzrdir_format=BzrDirMetaFormat1Colo,
2280
 
    )
2281
 
 
2282
3299
 
2283
3300
# And the development formats above will have aliased one of the following:
2284
 
 
2285
 
# Finally, the current format.
 
3301
register_metadir(controldir.format_registry, 'development6-rich-root',
 
3302
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
 
3303
    help='pack-1.9 with 255-way hashed CHK inv, group compress, rich roots '
 
3304
        'Please read '
 
3305
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
 
3306
        'before use.',
 
3307
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
3308
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
 
3309
    hidden=True,
 
3310
    experimental=True,
 
3311
    )
 
3312
 
 
3313
register_metadir(controldir.format_registry, 'development7-rich-root',
 
3314
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK2',
 
3315
    help='pack-1.9 with 255-way hashed CHK inv, bencode revision, group compress, '
 
3316
        'rich roots. Please read '
 
3317
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
 
3318
        'before use.',
 
3319
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
3320
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
 
3321
    hidden=True,
 
3322
    experimental=True,
 
3323
    )
 
3324
 
2286
3325
register_metadir(controldir.format_registry, '2a',
2287
3326
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
2288
 
    help='Format for the bzr 2.0 series.\n'
 
3327
    help='First format for bzr 2.0 series.\n'
2289
3328
        'Uses group-compress storage.\n'
2290
3329
        'Provides rich roots which are a one-way transition.\n',
2291
3330
        # 'storage in packs, 255-way hashed CHK inventory, bencode revision, group compress, '
2292
3331
        # 'rich roots. Supported by bzr 1.16 and later.',
2293
3332
    branch_format='bzrlib.branch.BzrBranchFormat7',
2294
 
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
 
3333
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
2295
3334
    experimental=False,
2296
3335
    )
2297
3336
 
2300
3339
register_metadir(controldir.format_registry, 'default-rich-root',
2301
3340
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
2302
3341
    branch_format='bzrlib.branch.BzrBranchFormat7',
2303
 
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
 
3342
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
2304
3343
    alias=True,
2305
3344
    hidden=True,
2306
3345
    help='Same as 2a.')
2307
3346
 
2308
3347
# The current format that is made on 'bzr init'.
2309
 
format_name = config.GlobalStack().get('default_format')
2310
 
controldir.format_registry.set_default(format_name)
 
3348
controldir.format_registry.set_default('2a')
2311
3349
 
2312
3350
# XXX 2010-08-20 JRV: There is still a lot of code relying on
2313
3351
# bzrlib.bzrdir.format_registry existing. When BzrDir.create/BzrDir.open/etc