~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/bzrdir.py

  • Committer: Vincent Ladeuil
  • Date: 2012-03-13 17:25:29 UTC
  • mfrom: (6499 +trunk)
  • mto: This revision was merged to the branch mainline in revision 6501.
  • Revision ID: v.ladeuil+lp@free.fr-20120313172529-i0suyjnepsor25i7
Merge trunk

Show diffs side-by-side

added added

removed removed

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