~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/bzrdir.py

(vila) Fix test failures blocking package builds. (Vincent Ladeuil)

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007, 2008, 2009 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
31
 
33
32
from bzrlib.lazy_import import lazy_import
34
33
lazy_import(globals(), """
35
 
from stat import S_ISDIR
36
 
import textwrap
37
 
 
38
34
import bzrlib
39
35
from bzrlib import (
40
 
    branch,
41
 
    config,
 
36
    branch as _mod_branch,
 
37
    cleanup,
42
38
    errors,
 
39
    fetch,
43
40
    graph,
44
41
    lockable_files,
45
42
    lockdir,
46
43
    osutils,
 
44
    pyutils,
47
45
    remote,
48
46
    repository,
49
47
    revision as _mod_revision,
 
48
    transport as _mod_transport,
50
49
    ui,
51
50
    urlutils,
52
 
    versionedfile,
 
51
    vf_search,
53
52
    win32utils,
54
 
    workingtree,
 
53
    workingtree_3,
55
54
    workingtree_4,
56
 
    xml4,
57
 
    xml5,
58
 
    )
59
 
from bzrlib.osutils import (
60
 
    sha_string,
61
 
    )
62
 
from bzrlib.push import (
63
 
    PushResult,
64
 
    )
65
 
from bzrlib.repofmt import pack_repo
66
 
from bzrlib.smart.client import _SmartClient
67
 
from bzrlib.store.versioned import WeaveStore
68
 
from bzrlib.transactions import WriteTransaction
 
55
    )
 
56
from bzrlib.branchfmt import fullhistory as fullhistorybranch
 
57
from bzrlib.repofmt import knitpack_repo
69
58
from bzrlib.transport import (
70
59
    do_catching_redirections,
71
 
    get_transport,
72
60
    local,
73
61
    )
74
 
from bzrlib.weave import Weave
 
62
from bzrlib.i18n import gettext
75
63
""")
76
64
 
77
65
from bzrlib.trace import (
78
66
    mutter,
79
67
    note,
80
 
    warning,
81
68
    )
82
69
 
83
70
from bzrlib import (
84
 
    hooks,
 
71
    config,
 
72
    controldir,
85
73
    registry,
86
 
    symbol_versioning,
87
 
    )
88
 
 
89
 
 
90
 
class BzrDir(object):
 
74
    )
 
75
from bzrlib.symbol_versioning import (
 
76
    deprecated_in,
 
77
    deprecated_method,
 
78
    )
 
79
 
 
80
 
 
81
class BzrDir(controldir.ControlDir):
91
82
    """A .bzr control diretory.
92
83
 
93
84
    BzrDir instances let you create or open any of the things that can be
124
115
                    return
125
116
        thing_to_unlock.break_lock()
126
117
 
127
 
    def can_convert_format(self):
128
 
        """Return true if this bzrdir is one whose format we can convert from."""
129
 
        return True
130
 
 
131
118
    def check_conversion_target(self, target_format):
 
119
        """Check that a bzrdir as a whole can be converted to a new format."""
 
120
        # The only current restriction is that the repository content can be 
 
121
        # fetched compatibly with the target.
132
122
        target_repo_format = target_format.repository_format
133
 
        self.open_repository()._format.check_conversion_target(target_repo_format)
134
 
 
135
 
    @staticmethod
136
 
    def _check_supported(format, allow_unsupported,
137
 
        recommend_upgrade=True,
138
 
        basedir=None):
139
 
        """Give an error or warning on old formats.
140
 
 
141
 
        :param format: may be any kind of format - workingtree, branch,
142
 
        or repository.
143
 
 
144
 
        :param allow_unsupported: If true, allow opening
145
 
        formats that are strongly deprecated, and which may
146
 
        have limited functionality.
147
 
 
148
 
        :param recommend_upgrade: If true (default), warn
149
 
        the user through the ui object that they may wish
150
 
        to upgrade the object.
151
 
        """
152
 
        # TODO: perhaps move this into a base Format class; it's not BzrDir
153
 
        # specific. mbp 20070323
154
 
        if not allow_unsupported and not format.is_supported():
155
 
            # see open_downlevel to open legacy branches.
156
 
            raise errors.UnsupportedFormatError(format=format)
157
 
        if recommend_upgrade \
158
 
            and getattr(format, 'upgrade_recommended', False):
159
 
            ui.ui_factory.recommend_upgrade(
160
 
                format.get_format_description(),
161
 
                basedir)
162
 
 
163
 
    def clone(self, url, revision_id=None, force_new_repo=False,
164
 
              preserve_stacking=False):
165
 
        """Clone this bzrdir and its contents to url verbatim.
166
 
 
167
 
        :param url: The url create the clone at.  If url's last component does
168
 
            not exist, it will be created.
169
 
        :param revision_id: The tip revision-id to use for any branch or
170
 
            working tree.  If not None, then the clone operation may tune
171
 
            itself to download less data.
172
 
        :param force_new_repo: Do not use a shared repository for the target
173
 
                               even if one is available.
174
 
        :param preserve_stacking: When cloning a stacked branch, stack the
175
 
            new branch on top of the other branch's stacked-on branch.
176
 
        """
177
 
        return self.clone_on_transport(get_transport(url),
178
 
                                       revision_id=revision_id,
179
 
                                       force_new_repo=force_new_repo,
180
 
                                       preserve_stacking=preserve_stacking)
 
123
        try:
 
124
            self.open_repository()._format.check_conversion_target(
 
125
                target_repo_format)
 
126
        except errors.NoRepositoryPresent:
 
127
            # No repo, no problem.
 
128
            pass
181
129
 
182
130
    def clone_on_transport(self, transport, revision_id=None,
183
131
        force_new_repo=False, preserve_stacking=False, stacked_on=None,
184
 
        create_prefix=False, use_existing_dir=True):
 
132
        create_prefix=False, use_existing_dir=True, no_tree=False):
185
133
        """Clone this bzrdir and its contents to transport verbatim.
186
134
 
187
135
        :param transport: The transport for the location to produce the clone
196
144
        :param create_prefix: Create any missing directories leading up to
197
145
            to_transport.
198
146
        :param use_existing_dir: Use an existing directory if one exists.
 
147
        :param no_tree: If set to true prevents creation of a working tree.
199
148
        """
200
149
        # Overview: put together a broad description of what we want to end up
201
150
        # with; then make as few api calls as possible to do it.
202
 
        
 
151
 
203
152
        # We may want to create a repo/branch/tree, if we do so what format
204
153
        # would we want for each:
205
154
        require_stacking = (stacked_on is not None)
206
155
        format = self.cloning_metadir(require_stacking)
207
 
        
 
156
 
208
157
        # Figure out what objects we want:
209
158
        try:
210
159
            local_repo = self.find_repository()
229
178
        # we should look up the policy needs first, or just use it as a hint,
230
179
        # or something.
231
180
        if local_repo:
232
 
            make_working_trees = local_repo.make_working_trees()
 
181
            make_working_trees = local_repo.make_working_trees() and not no_tree
233
182
            want_shared = local_repo.is_shared()
234
183
            repo_format_name = format.repository_format.network_name()
235
184
        else:
252
201
                # copied, and finally if we are copying up to a specific
253
202
                # revision_id then we can use the pending-ancestry-result which
254
203
                # does not require traversing all of history to describe it.
255
 
                if (result_repo.bzrdir.root_transport.base ==
256
 
                    result.root_transport.base and not require_stacking and
 
204
                if (result_repo.user_url == result.user_url
 
205
                    and not require_stacking and
257
206
                    revision_id is not None):
258
 
                    fetch_spec = graph.PendingAncestryResult(
 
207
                    fetch_spec = vf_search.PendingAncestryResult(
259
208
                        [revision_id], local_repo)
260
209
                    result_repo.fetch(local_repo, fetch_spec=fetch_spec)
261
210
                else:
276
225
            # the tree and fail.
277
226
            result.root_transport.local_abspath('.')
278
227
            if result_repo is None or result_repo.make_working_trees():
279
 
                self.open_workingtree().clone(result)
 
228
                self.open_workingtree().clone(result, revision_id=revision_id)
280
229
        except (errors.NoWorkingTree, errors.NotLocalUrl):
281
230
            pass
282
231
        return result
284
233
    # TODO: This should be given a Transport, and should chdir up; otherwise
285
234
    # this will open a new connection.
286
235
    def _make_tail(self, url):
287
 
        t = get_transport(url)
288
 
        t.ensure_base()
289
 
 
290
 
    @classmethod
291
 
    def create(cls, base, format=None, possible_transports=None):
292
 
        """Create a new BzrDir at the url 'base'.
293
 
 
294
 
        :param format: If supplied, the format of branch to create.  If not
295
 
            supplied, the default is used.
296
 
        :param possible_transports: If supplied, a list of transports that
297
 
            can be reused to share a remote connection.
298
 
        """
299
 
        if cls is not BzrDir:
300
 
            raise AssertionError("BzrDir.create always creates the default"
301
 
                " format, not one of %r" % cls)
302
 
        t = get_transport(base, possible_transports)
303
 
        t.ensure_base()
304
 
        if format is None:
305
 
            format = BzrDirFormat.get_default_format()
306
 
        return format.initialize_on_transport(t)
307
 
 
308
 
    @staticmethod
309
 
    def find_bzrdirs(transport, evaluate=None, list_current=None):
310
 
        """Find bzrdirs recursively from current location.
311
 
 
312
 
        This is intended primarily as a building block for more sophisticated
313
 
        functionality, like finding trees under a directory, or finding
314
 
        branches that use a given repository.
315
 
        :param evaluate: An optional callable that yields recurse, value,
316
 
            where recurse controls whether this bzrdir is recursed into
317
 
            and value is the value to yield.  By default, all bzrdirs
318
 
            are recursed into, and the return value is the bzrdir.
319
 
        :param list_current: if supplied, use this function to list the current
320
 
            directory, instead of Transport.list_dir
321
 
        :return: a generator of found bzrdirs, or whatever evaluate returns.
322
 
        """
323
 
        if list_current is None:
324
 
            def list_current(transport):
325
 
                return transport.list_dir('')
326
 
        if evaluate is None:
327
 
            def evaluate(bzrdir):
328
 
                return True, bzrdir
329
 
 
330
 
        pending = [transport]
331
 
        while len(pending) > 0:
332
 
            current_transport = pending.pop()
333
 
            recurse = True
334
 
            try:
335
 
                bzrdir = BzrDir.open_from_transport(current_transport)
336
 
            except errors.NotBranchError:
337
 
                pass
338
 
            else:
339
 
                recurse, value = evaluate(bzrdir)
340
 
                yield value
341
 
            try:
342
 
                subdirs = list_current(current_transport)
343
 
            except errors.NoSuchFile:
344
 
                continue
345
 
            if recurse:
346
 
                for subdir in sorted(subdirs, reverse=True):
347
 
                    pending.append(current_transport.clone(subdir))
348
 
 
349
 
    @staticmethod
350
 
    def find_branches(transport):
351
 
        """Find all branches under a transport.
352
 
 
353
 
        This will find all branches below the transport, including branches
354
 
        inside other branches.  Where possible, it will use
355
 
        Repository.find_branches.
356
 
 
357
 
        To list all the branches that use a particular Repository, see
358
 
        Repository.find_branches
359
 
        """
360
 
        def evaluate(bzrdir):
361
 
            try:
362
 
                repository = bzrdir.open_repository()
363
 
            except errors.NoRepositoryPresent:
364
 
                pass
365
 
            else:
366
 
                return False, (None, repository)
367
 
            try:
368
 
                branch = bzrdir.open_branch()
369
 
            except errors.NotBranchError:
370
 
                return True, (None, None)
371
 
            else:
372
 
                return True, (branch, None)
373
 
        branches = []
374
 
        for branch, repo in BzrDir.find_bzrdirs(transport, evaluate=evaluate):
375
 
            if repo is not None:
376
 
                branches.extend(repo.find_branches())
377
 
            if branch is not None:
378
 
                branches.append(branch)
379
 
        return branches
380
 
 
381
 
    def destroy_repository(self):
382
 
        """Destroy the repository in this BzrDir"""
383
 
        raise NotImplementedError(self.destroy_repository)
384
 
 
385
 
    def create_branch(self):
386
 
        """Create a branch in this BzrDir.
387
 
 
388
 
        The bzrdir's format will control what branch format is created.
389
 
        For more control see BranchFormatXX.create(a_bzrdir).
390
 
        """
391
 
        raise NotImplementedError(self.create_branch)
392
 
 
393
 
    def destroy_branch(self):
394
 
        """Destroy the branch in this BzrDir"""
395
 
        raise NotImplementedError(self.destroy_branch)
396
 
 
397
 
    @staticmethod
398
 
    def create_branch_and_repo(base, force_new_repo=False, format=None):
399
 
        """Create a new BzrDir, Branch and Repository at the url 'base'.
400
 
 
401
 
        This will use the current default BzrDirFormat unless one is
402
 
        specified, and use whatever
403
 
        repository format that that uses via bzrdir.create_branch and
404
 
        create_repository. If a shared repository is available that is used
405
 
        preferentially.
406
 
 
407
 
        The created Branch object is returned.
408
 
 
409
 
        :param base: The URL to create the branch at.
410
 
        :param force_new_repo: If True a new repository is always created.
411
 
        :param format: If supplied, the format of branch to create.  If not
412
 
            supplied, the default is used.
413
 
        """
414
 
        bzrdir = BzrDir.create(base, format)
415
 
        bzrdir._find_or_create_repository(force_new_repo)
416
 
        return bzrdir.create_branch()
 
236
        t = _mod_transport.get_transport(url)
 
237
        t.ensure_base()
417
238
 
418
239
    def determine_repository_policy(self, force_new_repo=False, stack_on=None,
419
240
                                    stack_on_pwd=None, require_stacking=False):
437
258
            stop = False
438
259
            stack_on = config.get_default_stack_on()
439
260
            if stack_on is not None:
440
 
                stack_on_pwd = found_bzrdir.root_transport.base
 
261
                stack_on_pwd = found_bzrdir.user_url
441
262
                stop = True
442
263
            # does it have a repository ?
443
264
            try:
445
266
            except errors.NoRepositoryPresent:
446
267
                repository = None
447
268
            else:
448
 
                if ((found_bzrdir.root_transport.base !=
449
 
                     self.root_transport.base) and not repository.is_shared()):
 
269
                if (found_bzrdir.user_url != self.user_url 
 
270
                    and not repository.is_shared()):
450
271
                    # Don't look higher, can't use a higher shared repo.
451
272
                    repository = None
452
273
                    stop = True
481
302
        policy = self.determine_repository_policy(force_new_repo)
482
303
        return policy.acquire_repository()[0]
483
304
 
484
 
    @staticmethod
485
 
    def create_branch_convenience(base, force_new_repo=False,
486
 
                                  force_new_tree=None, format=None,
487
 
                                  possible_transports=None):
488
 
        """Create a new BzrDir, Branch and Repository at the url 'base'.
489
 
 
490
 
        This is a convenience function - it will use an existing repository
491
 
        if possible, can be told explicitly whether to create a working tree or
492
 
        not.
493
 
 
494
 
        This will use the current default BzrDirFormat unless one is
495
 
        specified, and use whatever
496
 
        repository format that that uses via bzrdir.create_branch and
497
 
        create_repository. If a shared repository is available that is used
498
 
        preferentially. Whatever repository is used, its tree creation policy
499
 
        is followed.
500
 
 
501
 
        The created Branch object is returned.
502
 
        If a working tree cannot be made due to base not being a file:// url,
503
 
        no error is raised unless force_new_tree is True, in which case no
504
 
        data is created on disk and NotLocalUrl is raised.
505
 
 
506
 
        :param base: The URL to create the branch at.
507
 
        :param force_new_repo: If True a new repository is always created.
508
 
        :param force_new_tree: If True or False force creation of a tree or
509
 
                               prevent such creation respectively.
510
 
        :param format: Override for the bzrdir format to create.
511
 
        :param possible_transports: An optional reusable transports list.
 
305
    def _find_source_repo(self, add_cleanup, source_branch):
 
306
        """Find the source branch and repo for a sprout operation.
 
307
        
 
308
        This is helper intended for use by _sprout.
 
309
 
 
310
        :returns: (source_branch, source_repository).  Either or both may be
 
311
            None.  If not None, they will be read-locked (and their unlock(s)
 
312
            scheduled via the add_cleanup param).
512
313
        """
513
 
        if force_new_tree:
514
 
            # check for non local urls
515
 
            t = get_transport(base, possible_transports)
516
 
            if not isinstance(t, local.LocalTransport):
517
 
                raise errors.NotLocalUrl(base)
518
 
        bzrdir = BzrDir.create(base, format, possible_transports)
519
 
        repo = bzrdir._find_or_create_repository(force_new_repo)
520
 
        result = bzrdir.create_branch()
521
 
        if force_new_tree or (repo.make_working_trees() and
522
 
                              force_new_tree is None):
 
314
        if source_branch is not None:
 
315
            add_cleanup(source_branch.lock_read().unlock)
 
316
            return source_branch, source_branch.repository
 
317
        try:
 
318
            source_branch = self.open_branch()
 
319
            source_repository = source_branch.repository
 
320
        except errors.NotBranchError:
 
321
            source_branch = None
523
322
            try:
524
 
                bzrdir.create_workingtree()
525
 
            except errors.NotLocalUrl:
526
 
                pass
527
 
        return result
528
 
 
529
 
    @staticmethod
530
 
    def create_standalone_workingtree(base, format=None):
531
 
        """Create a new BzrDir, WorkingTree, Branch and Repository at 'base'.
532
 
 
533
 
        'base' must be a local path or a file:// url.
534
 
 
535
 
        This will use the current default BzrDirFormat unless one is
536
 
        specified, and use whatever
537
 
        repository format that that uses for bzrdirformat.create_workingtree,
538
 
        create_branch and create_repository.
539
 
 
540
 
        :param format: Override for the bzrdir format to create.
541
 
        :return: The WorkingTree object.
542
 
        """
543
 
        t = get_transport(base)
544
 
        if not isinstance(t, local.LocalTransport):
545
 
            raise errors.NotLocalUrl(base)
546
 
        bzrdir = BzrDir.create_branch_and_repo(base,
547
 
                                               force_new_repo=True,
548
 
                                               format=format).bzrdir
549
 
        return bzrdir.create_workingtree()
550
 
 
551
 
    def create_workingtree(self, revision_id=None, from_branch=None,
552
 
        accelerator_tree=None, hardlink=False):
553
 
        """Create a working tree at this BzrDir.
554
 
 
555
 
        :param revision_id: create it as of this revision id.
556
 
        :param from_branch: override bzrdir branch (for lightweight checkouts)
 
323
                source_repository = self.open_repository()
 
324
            except errors.NoRepositoryPresent:
 
325
                source_repository = None
 
326
            else:
 
327
                add_cleanup(source_repository.lock_read().unlock)
 
328
        else:
 
329
            add_cleanup(source_branch.lock_read().unlock)
 
330
        return source_branch, source_repository
 
331
 
 
332
    def sprout(self, url, revision_id=None, force_new_repo=False,
 
333
               recurse='down', possible_transports=None,
 
334
               accelerator_tree=None, hardlink=False, stacked=False,
 
335
               source_branch=None, create_tree_if_local=True):
 
336
        """Create a copy of this controldir prepared for use as a new line of
 
337
        development.
 
338
 
 
339
        If url's last component does not exist, it will be created.
 
340
 
 
341
        Attributes related to the identity of the source branch like
 
342
        branch nickname will be cleaned, a working tree is created
 
343
        whether one existed before or not; and a local branch is always
 
344
        created.
 
345
 
 
346
        if revision_id is not None, then the clone operation may tune
 
347
            itself to download less data.
 
348
 
557
349
        :param accelerator_tree: A tree which can be used for retrieving file
558
350
            contents more quickly than the revision tree, i.e. a workingtree.
559
351
            The revision tree will be used for cases where accelerator_tree's
560
352
            content is different.
561
 
        """
562
 
        raise NotImplementedError(self.create_workingtree)
 
353
        :param hardlink: If true, hard-link files from accelerator_tree,
 
354
            where possible.
 
355
        :param stacked: If true, create a stacked branch referring to the
 
356
            location of this control directory.
 
357
        :param create_tree_if_local: If true, a working-tree will be created
 
358
            when working locally.
 
359
        :return: The created control directory
 
360
        """
 
361
        operation = cleanup.OperationWithCleanups(self._sprout)
 
362
        return operation.run(url, revision_id=revision_id,
 
363
            force_new_repo=force_new_repo, recurse=recurse,
 
364
            possible_transports=possible_transports,
 
365
            accelerator_tree=accelerator_tree, hardlink=hardlink,
 
366
            stacked=stacked, source_branch=source_branch,
 
367
            create_tree_if_local=create_tree_if_local)
 
368
 
 
369
    def _sprout(self, op, url, revision_id=None, force_new_repo=False,
 
370
               recurse='down', possible_transports=None,
 
371
               accelerator_tree=None, hardlink=False, stacked=False,
 
372
               source_branch=None, create_tree_if_local=True):
 
373
        add_cleanup = op.add_cleanup
 
374
        fetch_spec_factory = fetch.FetchSpecFactory()
 
375
        if revision_id is not None:
 
376
            fetch_spec_factory.add_revision_ids([revision_id])
 
377
            fetch_spec_factory.source_branch_stop_revision_id = revision_id
 
378
        if possible_transports is None:
 
379
            possible_transports = []
 
380
        else:
 
381
            possible_transports = list(possible_transports) + [
 
382
                self.root_transport]
 
383
        target_transport = _mod_transport.get_transport(url,
 
384
            possible_transports)
 
385
        target_transport.ensure_base()
 
386
        cloning_format = self.cloning_metadir(stacked)
 
387
        # Create/update the result branch
 
388
        try:
 
389
            result = controldir.ControlDir.open_from_transport(target_transport)
 
390
        except errors.NotBranchError:
 
391
            result = cloning_format.initialize_on_transport(target_transport)
 
392
        source_branch, source_repository = self._find_source_repo(
 
393
            add_cleanup, source_branch)
 
394
        fetch_spec_factory.source_branch = source_branch
 
395
        # if a stacked branch wasn't requested, we don't create one
 
396
        # even if the origin was stacked
 
397
        if stacked and source_branch is not None:
 
398
            stacked_branch_url = self.root_transport.base
 
399
        else:
 
400
            stacked_branch_url = None
 
401
        repository_policy = result.determine_repository_policy(
 
402
            force_new_repo, stacked_branch_url, require_stacking=stacked)
 
403
        result_repo, is_new_repo = repository_policy.acquire_repository(
 
404
            possible_transports=possible_transports)
 
405
        add_cleanup(result_repo.lock_write().unlock)
 
406
        fetch_spec_factory.source_repo = source_repository
 
407
        fetch_spec_factory.target_repo = result_repo
 
408
        if stacked or (len(result_repo._fallback_repositories) != 0):
 
409
            target_repo_kind = fetch.TargetRepoKinds.STACKED
 
410
        elif is_new_repo:
 
411
            target_repo_kind = fetch.TargetRepoKinds.EMPTY
 
412
        else:
 
413
            target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
 
414
        fetch_spec_factory.target_repo_kind = target_repo_kind
 
415
        if source_repository is not None:
 
416
            fetch_spec = fetch_spec_factory.make_fetch_spec()
 
417
            result_repo.fetch(source_repository, fetch_spec=fetch_spec)
 
418
 
 
419
        if source_branch is None:
 
420
            # this is for sprouting a controldir without a branch; is that
 
421
            # actually useful?
 
422
            # Not especially, but it's part of the contract.
 
423
            result_branch = result.create_branch()
 
424
        else:
 
425
            result_branch = source_branch.sprout(result,
 
426
                revision_id=revision_id, repository_policy=repository_policy,
 
427
                repository=result_repo)
 
428
        mutter("created new branch %r" % (result_branch,))
 
429
 
 
430
        # Create/update the result working tree
 
431
        if (create_tree_if_local and not result.has_workingtree() and
 
432
            isinstance(target_transport, local.LocalTransport) and
 
433
            (result_repo is None or result_repo.make_working_trees())):
 
434
            wt = result.create_workingtree(accelerator_tree=accelerator_tree,
 
435
                hardlink=hardlink, from_branch=result_branch)
 
436
            wt.lock_write()
 
437
            try:
 
438
                if wt.path2id('') is None:
 
439
                    try:
 
440
                        wt.set_root_id(self.open_workingtree.get_root_id())
 
441
                    except errors.NoWorkingTree:
 
442
                        pass
 
443
            finally:
 
444
                wt.unlock()
 
445
        else:
 
446
            wt = None
 
447
        if recurse == 'down':
 
448
            basis = None
 
449
            if wt is not None:
 
450
                basis = wt.basis_tree()
 
451
            elif result_branch is not None:
 
452
                basis = result_branch.basis_tree()
 
453
            elif source_branch is not None:
 
454
                basis = source_branch.basis_tree()
 
455
            if basis is not None:
 
456
                add_cleanup(basis.lock_read().unlock)
 
457
                subtrees = basis.iter_references()
 
458
            else:
 
459
                subtrees = []
 
460
            for path, file_id in subtrees:
 
461
                target = urlutils.join(url, urlutils.escape(path))
 
462
                sublocation = source_branch.reference_parent(file_id, path)
 
463
                sublocation.bzrdir.sprout(target,
 
464
                    basis.get_reference_revision(file_id, path),
 
465
                    force_new_repo=force_new_repo, recurse=recurse,
 
466
                    stacked=stacked)
 
467
        return result
 
468
 
 
469
    def _available_backup_name(self, base):
 
470
        """Find a non-existing backup file name based on base.
 
471
 
 
472
        See bzrlib.osutils.available_backup_name about race conditions.
 
473
        """
 
474
        return osutils.available_backup_name(base, self.root_transport.has)
563
475
 
564
476
    def backup_bzrdir(self):
565
477
        """Backup this bzr control directory.
566
478
 
567
479
        :return: Tuple with old path name and new path name
568
480
        """
 
481
 
569
482
        pb = ui.ui_factory.nested_progress_bar()
570
483
        try:
571
 
            # FIXME: bug 300001 -- the backup fails if the backup directory
572
 
            # already exists, but it should instead either remove it or make
573
 
            # a new backup directory.
574
 
            #
575
 
            # FIXME: bug 262450 -- the backup directory should have the same
576
 
            # permissions as the .bzr directory (probably a bug in copy_tree)
577
484
            old_path = self.root_transport.abspath('.bzr')
578
 
            new_path = self.root_transport.abspath('backup.bzr')
579
 
            pb.note('making backup of %s' % (old_path,))
580
 
            pb.note('  to %s' % (new_path,))
581
 
            self.root_transport.copy_tree('.bzr', 'backup.bzr')
 
485
            backup_dir = self._available_backup_name('backup.bzr')
 
486
            new_path = self.root_transport.abspath(backup_dir)
 
487
            ui.ui_factory.note(gettext('making backup of {0}\n  to {1}').format(
 
488
                urlutils.unescape_for_display(old_path, 'utf-8'),
 
489
                urlutils.unescape_for_display(new_path, 'utf-8')))
 
490
            self.root_transport.copy_tree('.bzr', backup_dir)
582
491
            return (old_path, new_path)
583
492
        finally:
584
493
            pb.finished()
598
507
            try:
599
508
                to_path = '.bzr.retired.%d' % i
600
509
                self.root_transport.rename('.bzr', to_path)
601
 
                note("renamed %s to %s"
602
 
                    % (self.root_transport.abspath('.bzr'), to_path))
 
510
                note(gettext("renamed {0} to {1}").format(
 
511
                    self.root_transport.abspath('.bzr'), to_path))
603
512
                return
604
513
            except (errors.TransportError, IOError, errors.PathError):
605
514
                i += 1
608
517
                else:
609
518
                    pass
610
519
 
611
 
    def destroy_workingtree(self):
612
 
        """Destroy the working tree at this BzrDir.
613
 
 
614
 
        Formats that do not support this may raise UnsupportedOperation.
615
 
        """
616
 
        raise NotImplementedError(self.destroy_workingtree)
617
 
 
618
 
    def destroy_workingtree_metadata(self):
619
 
        """Destroy the control files for the working tree at this BzrDir.
620
 
 
621
 
        The contents of working tree files are not affected.
622
 
        Formats that do not support this may raise UnsupportedOperation.
623
 
        """
624
 
        raise NotImplementedError(self.destroy_workingtree_metadata)
625
 
 
626
520
    def _find_containing(self, evaluate):
627
521
        """Find something in a containing control directory.
628
522
 
642
536
            if stop:
643
537
                return result
644
538
            next_transport = found_bzrdir.root_transport.clone('..')
645
 
            if (found_bzrdir.root_transport.base == next_transport.base):
 
539
            if (found_bzrdir.user_url == next_transport.base):
646
540
                # top of the file system
647
541
                return None
648
542
            # find the next containing bzrdir
649
543
            try:
650
 
                found_bzrdir = BzrDir.open_containing_from_transport(
 
544
                found_bzrdir = self.open_containing_from_transport(
651
545
                    next_transport)[0]
652
546
            except errors.NotBranchError:
653
547
                return None
665
559
                repository = found_bzrdir.open_repository()
666
560
            except errors.NoRepositoryPresent:
667
561
                return None, False
668
 
            if found_bzrdir.root_transport.base == self.root_transport.base:
 
562
            if found_bzrdir.user_url == self.user_url:
669
563
                return repository, True
670
564
            elif repository.is_shared():
671
565
                return repository, True
677
571
            raise errors.NoRepositoryPresent(self)
678
572
        return found_repo
679
573
 
680
 
    def get_branch_reference(self):
681
 
        """Return the referenced URL for the branch in this bzrdir.
682
 
 
683
 
        :raises NotBranchError: If there is no Branch.
684
 
        :return: The URL the branch in this bzrdir references if it is a
685
 
            reference branch, or None for regular branches.
686
 
        """
687
 
        return None
688
 
 
689
 
    def get_branch_transport(self, branch_format):
690
 
        """Get the transport for use by branch format in this BzrDir.
691
 
 
692
 
        Note that bzr dirs that do not support format strings will raise
693
 
        IncompatibleFormat if the branch format they are given has
694
 
        a format string, and vice versa.
695
 
 
696
 
        If branch_format is None, the transport is returned with no
697
 
        checking. If it is not None, then the returned transport is
698
 
        guaranteed to point to an existing directory ready for use.
699
 
        """
700
 
        raise NotImplementedError(self.get_branch_transport)
701
 
 
702
574
    def _find_creation_modes(self):
703
575
        """Determine the appropriate modes for files and directories.
704
576
 
743
615
            self._find_creation_modes()
744
616
        return self._dir_mode
745
617
 
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
 
 
772
618
    def get_config(self):
773
619
        """Get configuration for this BzrDir."""
774
620
        return config.BzrDirConfig(self)
787
633
        :param _transport: the transport this dir is based at.
788
634
        """
789
635
        self._format = _format
 
636
        # these are also under the more standard names of 
 
637
        # control_transport and user_transport
790
638
        self.transport = _transport.clone('.bzr')
791
639
        self.root_transport = _transport
792
640
        self._mode_check_done = False
793
641
 
 
642
    @property 
 
643
    def user_transport(self):
 
644
        return self.root_transport
 
645
 
 
646
    @property
 
647
    def control_transport(self):
 
648
        return self.transport
 
649
 
794
650
    def is_control_filename(self, filename):
795
651
        """True if filename is the name of a path which is reserved for bzrdir's.
796
652
 
798
654
 
799
655
        This is true IF and ONLY IF the filename is part of the namespace reserved
800
656
        for bzr control dirs. Currently this is the '.bzr' directory in the root
801
 
        of the root_transport. it is expected that plugins will need to extend
802
 
        this in the future - for instance to make bzr talk with svn working
803
 
        trees.
 
657
        of the root_transport. 
804
658
        """
805
659
        # this might be better on the BzrDirFormat class because it refers to
806
660
        # all the possible bzrdir disk formats.
810
664
        # add new tests for it to the appropriate place.
811
665
        return filename == '.bzr' or filename.startswith('.bzr/')
812
666
 
813
 
    def needs_format_conversion(self, format=None):
814
 
        """Return true if this bzrdir needs convert_format run on it.
815
 
 
816
 
        For instance, if the repository format is out of date but the
817
 
        branch and working tree are not, this should return True.
818
 
 
819
 
        :param format: Optional parameter indicating a specific desired
820
 
                       format we plan to arrive at.
821
 
        """
822
 
        raise NotImplementedError(self.needs_format_conversion)
823
 
 
824
 
    @staticmethod
825
 
    def open_unsupported(base):
826
 
        """Open a branch which is not supported."""
827
 
        return BzrDir.open(base, _unsupported=True)
828
 
 
829
 
    @staticmethod
830
 
    def open(base, _unsupported=False, possible_transports=None):
831
 
        """Open an existing bzrdir, rooted at 'base' (url).
832
 
 
833
 
        :param _unsupported: a private parameter to the BzrDir class.
834
 
        """
835
 
        t = get_transport(base, possible_transports=possible_transports)
836
 
        return BzrDir.open_from_transport(t, _unsupported=_unsupported)
837
 
 
838
 
    @staticmethod
839
 
    def open_from_transport(transport, _unsupported=False,
840
 
                            _server_formats=True):
841
 
        """Open a bzrdir within a particular directory.
842
 
 
843
 
        :param transport: Transport containing the bzrdir.
844
 
        :param _unsupported: private.
845
 
        """
846
 
        for hook in BzrDir.hooks['pre_open']:
847
 
            hook(transport)
848
 
        # Keep initial base since 'transport' may be modified while following
849
 
        # the redirections.
850
 
        base = transport.base
851
 
        def find_format(transport):
852
 
            return transport, BzrDirFormat.find_format(
853
 
                transport, _server_formats=_server_formats)
854
 
 
855
 
        def redirected(transport, e, redirection_notice):
856
 
            redirected_transport = transport._redirected_to(e.source, e.target)
857
 
            if redirected_transport is None:
858
 
                raise errors.NotBranchError(base)
859
 
            note('%s is%s redirected to %s',
860
 
                 transport.base, e.permanently, redirected_transport.base)
861
 
            return redirected_transport
862
 
 
863
 
        try:
864
 
            transport, format = do_catching_redirections(find_format,
865
 
                                                         transport,
866
 
                                                         redirected)
867
 
        except errors.TooManyRedirections:
868
 
            raise errors.NotBranchError(base)
869
 
 
870
 
        BzrDir._check_supported(format, _unsupported)
871
 
        return format.open(transport, _found=True)
872
 
 
873
 
    def open_branch(self, unsupported=False, ignore_fallbacks=False):
874
 
        """Open the branch object at this BzrDir if one is present.
875
 
 
876
 
        If unsupported is True, then no longer supported branch formats can
877
 
        still be opened.
878
 
 
879
 
        TODO: static convenience version of this?
880
 
        """
881
 
        raise NotImplementedError(self.open_branch)
882
 
 
883
 
    @staticmethod
884
 
    def open_containing(url, possible_transports=None):
885
 
        """Open an existing branch which contains url.
886
 
 
887
 
        :param url: url to search from.
888
 
        See open_containing_from_transport for more detail.
889
 
        """
890
 
        transport = get_transport(url, possible_transports)
891
 
        return BzrDir.open_containing_from_transport(transport)
892
 
 
893
 
    @staticmethod
894
 
    def open_containing_from_transport(a_transport):
895
 
        """Open an existing branch which contains a_transport.base.
896
 
 
897
 
        This probes for a branch at a_transport, and searches upwards from there.
898
 
 
899
 
        Basically we keep looking up until we find the control directory or
900
 
        run into the root.  If there isn't one, raises NotBranchError.
901
 
        If there is one and it is either an unrecognised format or an unsupported
902
 
        format, UnknownFormatError or UnsupportedFormatError are raised.
903
 
        If there is one, it is returned, along with the unused portion of url.
904
 
 
905
 
        :return: The BzrDir that contains the path, and a Unicode path
906
 
                for the rest of the URL.
907
 
        """
908
 
        # this gets the normalised url back. I.e. '.' -> the full path.
909
 
        url = a_transport.base
910
 
        while True:
911
 
            try:
912
 
                result = BzrDir.open_from_transport(a_transport)
913
 
                return result, urlutils.unescape(a_transport.relpath(url))
914
 
            except errors.NotBranchError, e:
915
 
                pass
916
 
            try:
917
 
                new_t = a_transport.clone('..')
918
 
            except errors.InvalidURLJoin:
919
 
                # reached the root, whatever that may be
920
 
                raise errors.NotBranchError(path=url)
921
 
            if new_t.base == a_transport.base:
922
 
                # reached the root, whatever that may be
923
 
                raise errors.NotBranchError(path=url)
924
 
            a_transport = new_t
925
 
 
926
 
    def _get_tree_branch(self):
927
 
        """Return the branch and tree, if any, for this bzrdir.
928
 
 
929
 
        Return None for tree if not present or inaccessible.
930
 
        Raise NotBranchError if no branch is present.
931
 
        :return: (tree, branch)
932
 
        """
933
 
        try:
934
 
            tree = self.open_workingtree()
935
 
        except (errors.NoWorkingTree, errors.NotLocalUrl):
936
 
            tree = None
937
 
            branch = self.open_branch()
938
 
        else:
939
 
            branch = tree.branch
940
 
        return tree, branch
941
 
 
942
 
    @classmethod
943
 
    def open_tree_or_branch(klass, location):
944
 
        """Return the branch and working tree at a location.
945
 
 
946
 
        If there is no tree at the location, tree will be None.
947
 
        If there is no branch at the location, an exception will be
948
 
        raised
949
 
        :return: (tree, branch)
950
 
        """
951
 
        bzrdir = klass.open(location)
952
 
        return bzrdir._get_tree_branch()
953
 
 
954
 
    @classmethod
955
 
    def open_containing_tree_or_branch(klass, location):
956
 
        """Return the branch and working tree contained by a location.
957
 
 
958
 
        Returns (tree, branch, relpath).
959
 
        If there is no tree at containing the location, tree will be None.
960
 
        If there is no branch containing the location, an exception will be
961
 
        raised
962
 
        relpath is the portion of the path that is contained by the branch.
963
 
        """
964
 
        bzrdir, relpath = klass.open_containing(location)
965
 
        tree, branch = bzrdir._get_tree_branch()
966
 
        return tree, branch, relpath
967
 
 
968
 
    @classmethod
969
 
    def open_containing_tree_branch_or_repository(klass, location):
970
 
        """Return the working tree, branch and repo contained by a location.
971
 
 
972
 
        Returns (tree, branch, repository, relpath).
973
 
        If there is no tree containing the location, tree will be None.
974
 
        If there is no branch containing the location, branch will be None.
975
 
        If there is no repository containing the location, repository will be
976
 
        None.
977
 
        relpath is the portion of the path that is contained by the innermost
978
 
        BzrDir.
979
 
 
980
 
        If no tree, branch or repository is found, a NotBranchError is raised.
981
 
        """
982
 
        bzrdir, relpath = klass.open_containing(location)
983
 
        try:
984
 
            tree, branch = bzrdir._get_tree_branch()
985
 
        except errors.NotBranchError:
986
 
            try:
987
 
                repo = bzrdir.find_repository()
988
 
                return None, None, repo, relpath
989
 
            except (errors.NoRepositoryPresent):
990
 
                raise errors.NotBranchError(location)
991
 
        return tree, branch, branch.repository, relpath
992
 
 
993
 
    def open_repository(self, _unsupported=False):
994
 
        """Open the repository object at this BzrDir if one is present.
995
 
 
996
 
        This will not follow the Branch object pointer - it's strictly a direct
997
 
        open facility. Most client code should use open_branch().repository to
998
 
        get at a repository.
999
 
 
1000
 
        :param _unsupported: a private parameter, not part of the api.
1001
 
        TODO: static convenience version of this?
1002
 
        """
1003
 
        raise NotImplementedError(self.open_repository)
1004
 
 
1005
 
    def open_workingtree(self, _unsupported=False,
1006
 
                         recommend_upgrade=True, from_branch=None):
1007
 
        """Open the workingtree object at this BzrDir if one is present.
1008
 
 
1009
 
        :param recommend_upgrade: Optional keyword parameter, when True (the
1010
 
            default), emit through the ui module a recommendation that the user
1011
 
            upgrade the working tree when the workingtree being opened is old
1012
 
            (but still fully supported).
1013
 
        :param from_branch: override bzrdir branch (for lightweight checkouts)
1014
 
        """
1015
 
        raise NotImplementedError(self.open_workingtree)
1016
 
 
1017
 
    def has_branch(self):
1018
 
        """Tell if this bzrdir contains a branch.
1019
 
 
1020
 
        Note: if you're going to open the branch, you should just go ahead
1021
 
        and try, and not ask permission first.  (This method just opens the
1022
 
        branch and discards it, and that's somewhat expensive.)
1023
 
        """
1024
 
        try:
1025
 
            self.open_branch()
1026
 
            return True
1027
 
        except errors.NotBranchError:
1028
 
            return False
1029
 
 
1030
 
    def has_workingtree(self):
1031
 
        """Tell if this bzrdir contains a working tree.
1032
 
 
1033
 
        This will still raise an exception if the bzrdir has a workingtree that
1034
 
        is remote & inaccessible.
1035
 
 
1036
 
        Note: if you're going to open the working tree, you should just go ahead
1037
 
        and try, and not ask permission first.  (This method just opens the
1038
 
        workingtree and discards it, and that's somewhat expensive.)
1039
 
        """
1040
 
        try:
1041
 
            self.open_workingtree(recommend_upgrade=False)
1042
 
            return True
1043
 
        except errors.NoWorkingTree:
1044
 
            return False
1045
 
 
1046
667
    def _cloning_metadir(self):
1047
668
        """Produce a metadir suitable for cloning with.
1048
669
 
1088
709
 
1089
710
        :require_stacking: If True, non-stackable formats will be upgraded
1090
711
            to similar stackable formats.
1091
 
        :returns: a BzrDirFormat with all component formats either set
 
712
        :returns: a ControlDirFormat with all component formats either set
1092
713
            appropriately or set to None if that component should not be
1093
714
            created.
1094
715
        """
1106
727
            format.require_stacking()
1107
728
        return format
1108
729
 
1109
 
    def checkout_metadir(self):
1110
 
        return self.cloning_metadir()
1111
 
 
1112
 
    def sprout(self, url, revision_id=None, force_new_repo=False,
1113
 
               recurse='down', possible_transports=None,
1114
 
               accelerator_tree=None, hardlink=False, stacked=False,
1115
 
               source_branch=None, create_tree_if_local=True):
1116
 
        """Create a copy of this bzrdir prepared for use as a new line of
1117
 
        development.
1118
 
 
1119
 
        If url's last component does not exist, it will be created.
1120
 
 
1121
 
        Attributes related to the identity of the source branch like
1122
 
        branch nickname will be cleaned, a working tree is created
1123
 
        whether one existed before or not; and a local branch is always
1124
 
        created.
1125
 
 
1126
 
        if revision_id is not None, then the clone operation may tune
1127
 
            itself to download less data.
1128
 
        :param accelerator_tree: A tree which can be used for retrieving file
1129
 
            contents more quickly than the revision tree, i.e. a workingtree.
1130
 
            The revision tree will be used for cases where accelerator_tree's
1131
 
            content is different.
1132
 
        :param hardlink: If true, hard-link files from accelerator_tree,
1133
 
            where possible.
1134
 
        :param stacked: If true, create a stacked branch referring to the
1135
 
            location of this control directory.
1136
 
        :param create_tree_if_local: If true, a working-tree will be created
1137
 
            when working locally.
1138
 
        """
1139
 
        target_transport = get_transport(url, possible_transports)
1140
 
        target_transport.ensure_base()
1141
 
        cloning_format = self.cloning_metadir(stacked)
1142
 
        # Create/update the result branch
1143
 
        result = cloning_format.initialize_on_transport(target_transport)
1144
 
        # if a stacked branch wasn't requested, we don't create one
1145
 
        # even if the origin was stacked
1146
 
        stacked_branch_url = None
1147
 
        if source_branch is not None:
1148
 
            if stacked:
1149
 
                stacked_branch_url = self.root_transport.base
1150
 
            source_repository = source_branch.repository
1151
 
        else:
1152
 
            try:
1153
 
                source_branch = self.open_branch()
1154
 
                source_repository = source_branch.repository
1155
 
                if stacked:
1156
 
                    stacked_branch_url = self.root_transport.base
1157
 
            except errors.NotBranchError:
1158
 
                source_branch = None
1159
 
                try:
1160
 
                    source_repository = self.open_repository()
1161
 
                except errors.NoRepositoryPresent:
1162
 
                    source_repository = None
1163
 
        repository_policy = result.determine_repository_policy(
1164
 
            force_new_repo, stacked_branch_url, require_stacking=stacked)
1165
 
        result_repo, is_new_repo = repository_policy.acquire_repository()
1166
 
        if is_new_repo and revision_id is not None and not stacked:
1167
 
            fetch_spec = graph.PendingAncestryResult(
1168
 
                [revision_id], source_repository)
1169
 
        else:
1170
 
            fetch_spec = None
1171
 
        if source_repository is not None:
1172
 
            # Fetch while stacked to prevent unstacked fetch from
1173
 
            # Branch.sprout.
1174
 
            if fetch_spec is None:
1175
 
                result_repo.fetch(source_repository, revision_id=revision_id)
1176
 
            else:
1177
 
                result_repo.fetch(source_repository, fetch_spec=fetch_spec)
1178
 
 
1179
 
        if source_branch is None:
1180
 
            # this is for sprouting a bzrdir without a branch; is that
1181
 
            # actually useful?
1182
 
            # Not especially, but it's part of the contract.
1183
 
            result_branch = result.create_branch()
1184
 
        else:
1185
 
            result_branch = source_branch.sprout(result,
1186
 
                revision_id=revision_id, repository_policy=repository_policy)
1187
 
        mutter("created new branch %r" % (result_branch,))
1188
 
 
1189
 
        # Create/update the result working tree
1190
 
        if (create_tree_if_local and
1191
 
            isinstance(target_transport, local.LocalTransport) and
1192
 
            (result_repo is None or result_repo.make_working_trees())):
1193
 
            wt = result.create_workingtree(accelerator_tree=accelerator_tree,
1194
 
                hardlink=hardlink)
1195
 
            wt.lock_write()
1196
 
            try:
1197
 
                if wt.path2id('') is None:
1198
 
                    try:
1199
 
                        wt.set_root_id(self.open_workingtree.get_root_id())
1200
 
                    except errors.NoWorkingTree:
1201
 
                        pass
1202
 
            finally:
1203
 
                wt.unlock()
1204
 
        else:
1205
 
            wt = None
1206
 
        if recurse == 'down':
1207
 
            if wt is not None:
1208
 
                basis = wt.basis_tree()
1209
 
                basis.lock_read()
1210
 
                subtrees = basis.iter_references()
1211
 
            elif result_branch is not None:
1212
 
                basis = result_branch.basis_tree()
1213
 
                basis.lock_read()
1214
 
                subtrees = basis.iter_references()
1215
 
            elif source_branch is not None:
1216
 
                basis = source_branch.basis_tree()
1217
 
                basis.lock_read()
1218
 
                subtrees = basis.iter_references()
1219
 
            else:
1220
 
                subtrees = []
1221
 
                basis = None
1222
 
            try:
1223
 
                for path, file_id in subtrees:
1224
 
                    target = urlutils.join(url, urlutils.escape(path))
1225
 
                    sublocation = source_branch.reference_parent(file_id, path)
1226
 
                    sublocation.bzrdir.sprout(target,
1227
 
                        basis.get_reference_revision(file_id, path),
1228
 
                        force_new_repo=force_new_repo, recurse=recurse,
1229
 
                        stacked=stacked)
1230
 
            finally:
1231
 
                if basis is not None:
1232
 
                    basis.unlock()
1233
 
        return result
1234
 
 
1235
 
    def push_branch(self, source, revision_id=None, overwrite=False, 
1236
 
        remember=False, create_prefix=False):
1237
 
        """Push the source branch into this BzrDir."""
1238
 
        br_to = None
1239
 
        # If we can open a branch, use its direct repository, otherwise see
1240
 
        # if there is a repository without a branch.
1241
 
        try:
1242
 
            br_to = self.open_branch()
1243
 
        except errors.NotBranchError:
1244
 
            # Didn't find a branch, can we find a repository?
1245
 
            repository_to = self.find_repository()
1246
 
        else:
1247
 
            # Found a branch, so we must have found a repository
1248
 
            repository_to = br_to.repository
1249
 
 
1250
 
        push_result = PushResult()
1251
 
        push_result.source_branch = source
1252
 
        if br_to is None:
1253
 
            # We have a repository but no branch, copy the revisions, and then
1254
 
            # create a branch.
1255
 
            repository_to.fetch(source.repository, revision_id=revision_id)
1256
 
            br_to = source.clone(self, revision_id=revision_id)
1257
 
            if source.get_push_location() is None or remember:
1258
 
                source.set_push_location(br_to.base)
1259
 
            push_result.stacked_on = None
1260
 
            push_result.branch_push_result = None
1261
 
            push_result.old_revno = None
1262
 
            push_result.old_revid = _mod_revision.NULL_REVISION
1263
 
            push_result.target_branch = br_to
1264
 
            push_result.master_branch = None
1265
 
            push_result.workingtree_updated = False
1266
 
        else:
1267
 
            # We have successfully opened the branch, remember if necessary:
1268
 
            if source.get_push_location() is None or remember:
1269
 
                source.set_push_location(br_to.base)
1270
 
            try:
1271
 
                tree_to = self.open_workingtree()
1272
 
            except errors.NotLocalUrl:
1273
 
                push_result.branch_push_result = source.push(br_to, 
1274
 
                    overwrite, stop_revision=revision_id)
1275
 
                push_result.workingtree_updated = False
1276
 
            except errors.NoWorkingTree:
1277
 
                push_result.branch_push_result = source.push(br_to,
1278
 
                    overwrite, stop_revision=revision_id)
1279
 
                push_result.workingtree_updated = None # Not applicable
1280
 
            else:
1281
 
                tree_to.lock_write()
1282
 
                try:
1283
 
                    push_result.branch_push_result = source.push(
1284
 
                        tree_to.branch, overwrite, stop_revision=revision_id)
1285
 
                    tree_to.update()
1286
 
                finally:
1287
 
                    tree_to.unlock()
1288
 
                push_result.workingtree_updated = True
1289
 
            push_result.old_revno = push_result.branch_push_result.old_revno
1290
 
            push_result.old_revid = push_result.branch_push_result.old_revid
1291
 
            push_result.target_branch = \
1292
 
                push_result.branch_push_result.target_branch
1293
 
        return push_result
1294
 
 
1295
 
 
1296
 
class BzrDirHooks(hooks.Hooks):
1297
 
    """Hooks for BzrDir operations."""
1298
 
 
1299
 
    def __init__(self):
1300
 
        """Create the default hooks."""
1301
 
        hooks.Hooks.__init__(self)
1302
 
        self.create_hook(hooks.HookPoint('pre_open',
1303
 
            "Invoked before attempting to open a BzrDir with the transport "
1304
 
            "that the open will use.", (1, 14), None))
1305
 
 
1306
 
# install the default hooks
1307
 
BzrDir.hooks = BzrDirHooks()
1308
 
 
1309
 
 
1310
 
class BzrDirPreSplitOut(BzrDir):
1311
 
    """A common class for the all-in-one formats."""
1312
 
 
1313
 
    def __init__(self, _transport, _format):
1314
 
        """See BzrDir.__init__."""
1315
 
        super(BzrDirPreSplitOut, self).__init__(_transport, _format)
1316
 
        self._control_files = lockable_files.LockableFiles(
1317
 
                                            self.get_branch_transport(None),
1318
 
                                            self._format._lock_file_name,
1319
 
                                            self._format._lock_class)
1320
 
 
1321
 
    def break_lock(self):
1322
 
        """Pre-splitout bzrdirs do not suffer from stale locks."""
1323
 
        raise NotImplementedError(self.break_lock)
1324
 
 
1325
 
    def cloning_metadir(self, require_stacking=False):
1326
 
        """Produce a metadir suitable for cloning with."""
1327
 
        if require_stacking:
1328
 
            return format_registry.make_bzrdir('1.6')
1329
 
        return self._format.__class__()
1330
 
 
1331
 
    def clone(self, url, revision_id=None, force_new_repo=False,
1332
 
              preserve_stacking=False):
1333
 
        """See BzrDir.clone().
1334
 
 
1335
 
        force_new_repo has no effect, since this family of formats always
1336
 
        require a new repository.
1337
 
        preserve_stacking has no effect, since no source branch using this
1338
 
        family of formats can be stacked, so there is no stacking to preserve.
1339
 
        """
1340
 
        self._make_tail(url)
1341
 
        result = self._format._initialize_for_clone(url)
1342
 
        self.open_repository().clone(result, revision_id=revision_id)
1343
 
        from_branch = self.open_branch()
1344
 
        from_branch.clone(result, revision_id=revision_id)
1345
 
        try:
1346
 
            tree = self.open_workingtree()
1347
 
        except errors.NotLocalUrl:
1348
 
            # make a new one, this format always has to have one.
1349
 
            result._init_workingtree()
1350
 
        else:
1351
 
            tree.clone(result)
1352
 
        return result
1353
 
 
1354
 
    def create_branch(self):
1355
 
        """See BzrDir.create_branch."""
1356
 
        return self._format.get_branch_format().initialize(self)
1357
 
 
1358
 
    def destroy_branch(self):
1359
 
        """See BzrDir.destroy_branch."""
1360
 
        raise errors.UnsupportedOperation(self.destroy_branch, self)
1361
 
 
1362
 
    def create_repository(self, shared=False):
1363
 
        """See BzrDir.create_repository."""
1364
 
        if shared:
1365
 
            raise errors.IncompatibleFormat('shared repository', self._format)
1366
 
        return self.open_repository()
1367
 
 
1368
 
    def destroy_repository(self):
1369
 
        """See BzrDir.destroy_repository."""
1370
 
        raise errors.UnsupportedOperation(self.destroy_repository, self)
1371
 
 
1372
 
    def create_workingtree(self, revision_id=None, from_branch=None,
1373
 
                           accelerator_tree=None, hardlink=False):
1374
 
        """See BzrDir.create_workingtree."""
1375
 
        # The workingtree is sometimes created when the bzrdir is created,
1376
 
        # but not when cloning.
1377
 
 
1378
 
        # this looks buggy but is not -really-
1379
 
        # because this format creates the workingtree when the bzrdir is
1380
 
        # created
1381
 
        # clone and sprout will have set the revision_id
1382
 
        # and that will have set it for us, its only
1383
 
        # specific uses of create_workingtree in isolation
1384
 
        # that can do wonky stuff here, and that only
1385
 
        # happens for creating checkouts, which cannot be
1386
 
        # done on this format anyway. So - acceptable wart.
1387
 
        if hardlink:
1388
 
            warning("can't support hardlinked working trees in %r"
1389
 
                % (self,))
1390
 
        try:
1391
 
            result = self.open_workingtree(recommend_upgrade=False)
1392
 
        except errors.NoSuchFile:
1393
 
            result = self._init_workingtree()
1394
 
        if revision_id is not None:
1395
 
            if revision_id == _mod_revision.NULL_REVISION:
1396
 
                result.set_parent_ids([])
1397
 
            else:
1398
 
                result.set_parent_ids([revision_id])
1399
 
        return result
1400
 
 
1401
 
    def _init_workingtree(self):
1402
 
        from bzrlib.workingtree import WorkingTreeFormat2
1403
 
        try:
1404
 
            return WorkingTreeFormat2().initialize(self)
1405
 
        except errors.NotLocalUrl:
1406
 
            # Even though we can't access the working tree, we need to
1407
 
            # create its control files.
1408
 
            return WorkingTreeFormat2()._stub_initialize_on_transport(
1409
 
                self.transport, self._control_files._file_mode)
1410
 
 
1411
 
    def destroy_workingtree(self):
1412
 
        """See BzrDir.destroy_workingtree."""
1413
 
        raise errors.UnsupportedOperation(self.destroy_workingtree, self)
1414
 
 
1415
 
    def destroy_workingtree_metadata(self):
1416
 
        """See BzrDir.destroy_workingtree_metadata."""
1417
 
        raise errors.UnsupportedOperation(self.destroy_workingtree_metadata,
1418
 
                                          self)
1419
 
 
1420
 
    def get_branch_transport(self, branch_format):
1421
 
        """See BzrDir.get_branch_transport()."""
1422
 
        if branch_format is None:
1423
 
            return self.transport
1424
 
        try:
1425
 
            branch_format.get_format_string()
1426
 
        except NotImplementedError:
1427
 
            return self.transport
1428
 
        raise errors.IncompatibleFormat(branch_format, self._format)
 
730
    def get_branch_transport(self, branch_format, name=None):
 
731
        """Get the transport for use by branch format in this BzrDir.
 
732
 
 
733
        Note that bzr dirs that do not support format strings will raise
 
734
        IncompatibleFormat if the branch format they are given has
 
735
        a format string, and vice versa.
 
736
 
 
737
        If branch_format is None, the transport is returned with no
 
738
        checking. If it is not None, then the returned transport is
 
739
        guaranteed to point to an existing directory ready for use.
 
740
        """
 
741
        raise NotImplementedError(self.get_branch_transport)
1429
742
 
1430
743
    def get_repository_transport(self, repository_format):
1431
 
        """See BzrDir.get_repository_transport()."""
1432
 
        if repository_format is None:
1433
 
            return self.transport
1434
 
        try:
1435
 
            repository_format.get_format_string()
1436
 
        except NotImplementedError:
1437
 
            return self.transport
1438
 
        raise errors.IncompatibleFormat(repository_format, self._format)
1439
 
 
1440
 
    def get_workingtree_transport(self, workingtree_format):
1441
 
        """See BzrDir.get_workingtree_transport()."""
1442
 
        if workingtree_format is None:
1443
 
            return self.transport
1444
 
        try:
1445
 
            workingtree_format.get_format_string()
1446
 
        except NotImplementedError:
1447
 
            return self.transport
1448
 
        raise errors.IncompatibleFormat(workingtree_format, self._format)
1449
 
 
1450
 
    def needs_format_conversion(self, format=None):
1451
 
        """See BzrDir.needs_format_conversion()."""
1452
 
        # if the format is not the same as the system default,
1453
 
        # an upgrade is needed.
1454
 
        if format is None:
1455
 
            symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1456
 
                % 'needs_format_conversion(format=None)')
1457
 
            format = BzrDirFormat.get_default_format()
1458
 
        return not isinstance(self._format, format.__class__)
1459
 
 
1460
 
    def open_branch(self, unsupported=False, ignore_fallbacks=False):
1461
 
        """See BzrDir.open_branch."""
1462
 
        from bzrlib.branch import BzrBranchFormat4
1463
 
        format = BzrBranchFormat4()
1464
 
        self._check_supported(format, unsupported)
1465
 
        return format.open(self, _found=True)
1466
 
 
1467
 
    def sprout(self, url, revision_id=None, force_new_repo=False,
1468
 
               possible_transports=None, accelerator_tree=None,
1469
 
               hardlink=False, stacked=False, create_tree_if_local=True,
1470
 
               source_branch=None):
1471
 
        """See BzrDir.sprout()."""
1472
 
        if source_branch is not None:
1473
 
            my_branch = self.open_branch()
1474
 
            if source_branch.base != my_branch.base:
1475
 
                raise AssertionError(
1476
 
                    "source branch %r is not within %r with branch %r" %
1477
 
                    (source_branch, self, my_branch))
1478
 
        if stacked:
1479
 
            raise errors.UnstackableBranchFormat(
1480
 
                self._format, self.root_transport.base)
1481
 
        if not create_tree_if_local:
1482
 
            raise errors.MustHaveWorkingTree(
1483
 
                self._format, self.root_transport.base)
1484
 
        from bzrlib.workingtree import WorkingTreeFormat2
1485
 
        self._make_tail(url)
1486
 
        result = self._format._initialize_for_clone(url)
1487
 
        try:
1488
 
            self.open_repository().clone(result, revision_id=revision_id)
1489
 
        except errors.NoRepositoryPresent:
1490
 
            pass
1491
 
        try:
1492
 
            self.open_branch().sprout(result, revision_id=revision_id)
1493
 
        except errors.NotBranchError:
1494
 
            pass
1495
 
 
1496
 
        # we always want a working tree
1497
 
        WorkingTreeFormat2().initialize(result,
1498
 
                                        accelerator_tree=accelerator_tree,
1499
 
                                        hardlink=hardlink)
1500
 
        return result
1501
 
 
1502
 
 
1503
 
class BzrDir4(BzrDirPreSplitOut):
1504
 
    """A .bzr version 4 control object.
1505
 
 
1506
 
    This is a deprecated format and may be removed after sept 2006.
1507
 
    """
1508
 
 
1509
 
    def create_repository(self, shared=False):
1510
 
        """See BzrDir.create_repository."""
1511
 
        return self._format.repository_format.initialize(self, shared)
1512
 
 
1513
 
    def needs_format_conversion(self, format=None):
1514
 
        """Format 4 dirs are always in need of conversion."""
1515
 
        if format is None:
1516
 
            symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1517
 
                % 'needs_format_conversion(format=None)')
1518
 
        return True
1519
 
 
1520
 
    def open_repository(self):
1521
 
        """See BzrDir.open_repository."""
1522
 
        from bzrlib.repofmt.weaverepo import RepositoryFormat4
1523
 
        return RepositoryFormat4().open(self, _found=True)
1524
 
 
1525
 
 
1526
 
class BzrDir5(BzrDirPreSplitOut):
1527
 
    """A .bzr version 5 control object.
1528
 
 
1529
 
    This is a deprecated format and may be removed after sept 2006.
1530
 
    """
1531
 
 
1532
 
    def open_repository(self):
1533
 
        """See BzrDir.open_repository."""
1534
 
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
1535
 
        return RepositoryFormat5().open(self, _found=True)
1536
 
 
1537
 
    def open_workingtree(self, _unsupported=False,
1538
 
            recommend_upgrade=True):
1539
 
        """See BzrDir.create_workingtree."""
1540
 
        from bzrlib.workingtree import WorkingTreeFormat2
1541
 
        wt_format = WorkingTreeFormat2()
1542
 
        # we don't warn here about upgrades; that ought to be handled for the
1543
 
        # bzrdir as a whole
1544
 
        return wt_format.open(self, _found=True)
1545
 
 
1546
 
 
1547
 
class BzrDir6(BzrDirPreSplitOut):
1548
 
    """A .bzr version 6 control object.
1549
 
 
1550
 
    This is a deprecated format and may be removed after sept 2006.
1551
 
    """
1552
 
 
1553
 
    def open_repository(self):
1554
 
        """See BzrDir.open_repository."""
1555
 
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
1556
 
        return RepositoryFormat6().open(self, _found=True)
1557
 
 
1558
 
    def open_workingtree(self, _unsupported=False,
1559
 
        recommend_upgrade=True):
1560
 
        """See BzrDir.create_workingtree."""
1561
 
        # we don't warn here about upgrades; that ought to be handled for the
1562
 
        # bzrdir as a whole
1563
 
        from bzrlib.workingtree import WorkingTreeFormat2
1564
 
        return WorkingTreeFormat2().open(self, _found=True)
 
744
        """Get the transport for use by repository format in this BzrDir.
 
745
 
 
746
        Note that bzr dirs that do not support format strings will raise
 
747
        IncompatibleFormat if the repository format they are given has
 
748
        a format string, and vice versa.
 
749
 
 
750
        If repository_format is None, the transport is returned with no
 
751
        checking. If it is not None, then the returned transport is
 
752
        guaranteed to point to an existing directory ready for use.
 
753
        """
 
754
        raise NotImplementedError(self.get_repository_transport)
 
755
 
 
756
    def get_workingtree_transport(self, tree_format):
 
757
        """Get the transport for use by workingtree format in this BzrDir.
 
758
 
 
759
        Note that bzr dirs that do not support format strings will raise
 
760
        IncompatibleFormat if the workingtree format they are given has a
 
761
        format string, and vice versa.
 
762
 
 
763
        If workingtree_format is None, the transport is returned with no
 
764
        checking. If it is not None, then the returned transport is
 
765
        guaranteed to point to an existing directory ready for use.
 
766
        """
 
767
        raise NotImplementedError(self.get_workingtree_transport)
 
768
 
 
769
    @classmethod
 
770
    def create(cls, base, format=None, possible_transports=None):
 
771
        """Create a new BzrDir at the url 'base'.
 
772
 
 
773
        :param format: If supplied, the format of branch to create.  If not
 
774
            supplied, the default is used.
 
775
        :param possible_transports: If supplied, a list of transports that
 
776
            can be reused to share a remote connection.
 
777
        """
 
778
        if cls is not BzrDir:
 
779
            raise AssertionError("BzrDir.create always creates the "
 
780
                "default format, not one of %r" % cls)
 
781
        return controldir.ControlDir.create(base, format=format,
 
782
                possible_transports=possible_transports)
 
783
 
 
784
    def __repr__(self):
 
785
        return "<%s at %r>" % (self.__class__.__name__, self.user_url)
 
786
 
 
787
    def update_feature_flags(self, updated_flags):
 
788
        """Update the features required by this bzrdir.
 
789
 
 
790
        :param updated_flags: Dictionary mapping feature names to necessities
 
791
            A necessity can be None to indicate the feature should be removed
 
792
        """
 
793
        self.control_files.lock_write()
 
794
        try:
 
795
            self._format._update_feature_flags(updated_flags)
 
796
            self.transport.put_bytes('branch-format', self._format.as_string())
 
797
        finally:
 
798
            self.control_files.unlock()
1565
799
 
1566
800
 
1567
801
class BzrDirMeta1(BzrDir):
1573
807
    present within a BzrDir.
1574
808
    """
1575
809
 
 
810
    def _get_branch_path(self, name):
 
811
        """Obtain the branch path to use.
 
812
 
 
813
        This uses the API specified branch name first, and then falls back to
 
814
        the branch name specified in the URL. If neither of those is specified,
 
815
        it uses the default branch.
 
816
 
 
817
        :param name: Optional branch name to use
 
818
        :return: Relative path to branch
 
819
        """
 
820
        if name == "":
 
821
            return 'branch'
 
822
        return urlutils.join('branches', name.encode("utf-8"))
 
823
 
 
824
    def _read_branch_list(self):
 
825
        """Read the branch list.
 
826
 
 
827
        :return: List of utf-8 encoded branch names.
 
828
        """
 
829
        try:
 
830
            f = self.control_transport.get('branch-list')
 
831
        except errors.NoSuchFile:
 
832
            return []
 
833
 
 
834
        ret = []
 
835
        try:
 
836
            for name in f:
 
837
                ret.append(name.rstrip("\n"))
 
838
        finally:
 
839
            f.close()
 
840
        return ret
 
841
 
 
842
    def _write_branch_list(self, branches):
 
843
        """Write out the branch list.
 
844
 
 
845
        :param branches: List of utf-8 branch names to write
 
846
        """
 
847
        self.transport.put_bytes('branch-list',
 
848
            "".join([name+"\n" for name in branches]))
 
849
 
 
850
    def __init__(self, _transport, _format):
 
851
        super(BzrDirMeta1, self).__init__(_transport, _format)
 
852
        self.control_files = lockable_files.LockableFiles(
 
853
            self.control_transport, self._format._lock_file_name,
 
854
            self._format._lock_class)
 
855
 
1576
856
    def can_convert_format(self):
1577
857
        """See BzrDir.can_convert_format()."""
1578
858
        return True
1579
859
 
1580
 
    def create_branch(self):
1581
 
        """See BzrDir.create_branch."""
1582
 
        return self._format.get_branch_format().initialize(self)
 
860
    def create_branch(self, name=None, repository=None,
 
861
            append_revisions_only=None):
 
862
        """See ControlDir.create_branch."""
 
863
        if name is None:
 
864
            name = self._get_selected_branch()
 
865
        return self._format.get_branch_format().initialize(self, name=name,
 
866
                repository=repository,
 
867
                append_revisions_only=append_revisions_only)
1583
868
 
1584
 
    def destroy_branch(self):
1585
 
        """See BzrDir.create_branch."""
1586
 
        self.transport.delete_tree('branch')
 
869
    def destroy_branch(self, name=None):
 
870
        """See ControlDir.destroy_branch."""
 
871
        if name is None:
 
872
            name = self._get_selected_branch()
 
873
        path = self._get_branch_path(name)
 
874
        if name != "":
 
875
            self.control_files.lock_write()
 
876
            try:
 
877
                branches = self._read_branch_list()
 
878
                try:
 
879
                    branches.remove(name.encode("utf-8"))
 
880
                except ValueError:
 
881
                    raise errors.NotBranchError(name)
 
882
                self._write_branch_list(branches)
 
883
            finally:
 
884
                self.control_files.unlock()
 
885
        try:
 
886
            self.transport.delete_tree(path)
 
887
        except errors.NoSuchFile:
 
888
            raise errors.NotBranchError(path=urlutils.join(self.transport.base,
 
889
                path), bzrdir=self)
1587
890
 
1588
891
    def create_repository(self, shared=False):
1589
892
        """See BzrDir.create_repository."""
1591
894
 
1592
895
    def destroy_repository(self):
1593
896
        """See BzrDir.destroy_repository."""
1594
 
        self.transport.delete_tree('repository')
 
897
        try:
 
898
            self.transport.delete_tree('repository')
 
899
        except errors.NoSuchFile:
 
900
            raise errors.NoRepositoryPresent(self)
1595
901
 
1596
902
    def create_workingtree(self, revision_id=None, from_branch=None,
1597
903
                           accelerator_tree=None, hardlink=False):
1605
911
        wt = self.open_workingtree(recommend_upgrade=False)
1606
912
        repository = wt.branch.repository
1607
913
        empty = repository.revision_tree(_mod_revision.NULL_REVISION)
1608
 
        wt.revert(old_tree=empty)
 
914
        # We ignore the conflicts returned by wt.revert since we're about to
 
915
        # delete the wt metadata anyway, all that should be left here are
 
916
        # detritus. But see bug #634470 about subtree .bzr dirs.
 
917
        conflicts = wt.revert(old_tree=empty)
1609
918
        self.destroy_workingtree_metadata()
1610
919
 
1611
920
    def destroy_workingtree_metadata(self):
1612
921
        self.transport.delete_tree('checkout')
1613
922
 
1614
 
    def find_branch_format(self):
 
923
    def find_branch_format(self, name=None):
1615
924
        """Find the branch 'format' for this bzrdir.
1616
925
 
1617
926
        This might be a synthetic object for e.g. RemoteBranch and SVN.
1618
927
        """
1619
 
        from bzrlib.branch import BranchFormat
1620
 
        return BranchFormat.find_format(self)
 
928
        from bzrlib.branch import BranchFormatMetadir
 
929
        return BranchFormatMetadir.find_format(self, name=name)
1621
930
 
1622
931
    def _get_mkdir_mode(self):
1623
932
        """Figure out the mode to use when creating a bzrdir subdir."""
1625
934
                                     lockable_files.TransportLock)
1626
935
        return temp_control._dir_mode
1627
936
 
1628
 
    def get_branch_reference(self):
 
937
    def get_branch_reference(self, name=None):
1629
938
        """See BzrDir.get_branch_reference()."""
1630
 
        from bzrlib.branch import BranchFormat
1631
 
        format = BranchFormat.find_format(self)
1632
 
        return format.get_reference(self)
1633
 
 
1634
 
    def get_branch_transport(self, branch_format):
 
939
        from bzrlib.branch import BranchFormatMetadir
 
940
        format = BranchFormatMetadir.find_format(self, name=name)
 
941
        return format.get_reference(self, name=name)
 
942
 
 
943
    def set_branch_reference(self, target_branch, name=None):
 
944
        format = _mod_branch.BranchReferenceFormat()
 
945
        return format.initialize(self, target_branch=target_branch, name=name)
 
946
 
 
947
    def get_branch_transport(self, branch_format, name=None):
1635
948
        """See BzrDir.get_branch_transport()."""
 
949
        if name is None:
 
950
            name = self._get_selected_branch()
 
951
        path = self._get_branch_path(name)
1636
952
        # XXX: this shouldn't implicitly create the directory if it's just
1637
953
        # promising to get a transport -- mbp 20090727
1638
954
        if branch_format is None:
1639
 
            return self.transport.clone('branch')
 
955
            return self.transport.clone(path)
1640
956
        try:
1641
957
            branch_format.get_format_string()
1642
958
        except NotImplementedError:
1643
959
            raise errors.IncompatibleFormat(branch_format, self._format)
 
960
        if name != "":
 
961
            branches = self._read_branch_list()
 
962
            utf8_name = name.encode("utf-8")
 
963
            if not utf8_name in branches:
 
964
                self.control_files.lock_write()
 
965
                try:
 
966
                    branches = self._read_branch_list()
 
967
                    dirname = urlutils.dirname(utf8_name)
 
968
                    if dirname != "" and dirname in branches:
 
969
                        raise errors.ParentBranchExists(name)
 
970
                    child_branches = [
 
971
                        b.startswith(utf8_name+"/") for b in branches]
 
972
                    if any(child_branches):
 
973
                        raise errors.AlreadyBranchError(name)
 
974
                    branches.append(utf8_name)
 
975
                    self._write_branch_list(branches)
 
976
                finally:
 
977
                    self.control_files.unlock()
 
978
        branch_transport = self.transport.clone(path)
 
979
        mode = self._get_mkdir_mode()
 
980
        branch_transport.create_prefix(mode=mode)
1644
981
        try:
1645
 
            self.transport.mkdir('branch', mode=self._get_mkdir_mode())
 
982
            self.transport.mkdir(path, mode=mode)
1646
983
        except errors.FileExists:
1647
984
            pass
1648
 
        return self.transport.clone('branch')
 
985
        return self.transport.clone(path)
1649
986
 
1650
987
    def get_repository_transport(self, repository_format):
1651
988
        """See BzrDir.get_repository_transport()."""
1675
1012
            pass
1676
1013
        return self.transport.clone('checkout')
1677
1014
 
1678
 
    def needs_format_conversion(self, format=None):
 
1015
    def get_branches(self):
 
1016
        """See ControlDir.get_branches."""
 
1017
        ret = {}
 
1018
        try:
 
1019
            ret[""] = self.open_branch(name="")
 
1020
        except (errors.NotBranchError, errors.NoRepositoryPresent):
 
1021
            pass
 
1022
 
 
1023
        for name in self._read_branch_list():
 
1024
            ret[name] = self.open_branch(name=name.decode('utf-8'))
 
1025
 
 
1026
        return ret
 
1027
 
 
1028
    def has_workingtree(self):
 
1029
        """Tell if this bzrdir contains a working tree.
 
1030
 
 
1031
        Note: if you're going to open the working tree, you should just go
 
1032
        ahead and try, and not ask permission first.
 
1033
        """
 
1034
        from bzrlib.workingtree import WorkingTreeFormatMetaDir
 
1035
        try:
 
1036
            WorkingTreeFormatMetaDir.find_format_string(self)
 
1037
        except errors.NoWorkingTree:
 
1038
            return False
 
1039
        return True
 
1040
 
 
1041
    def needs_format_conversion(self, format):
1679
1042
        """See BzrDir.needs_format_conversion()."""
1680
 
        if format is None:
1681
 
            symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1682
 
                % 'needs_format_conversion(format=None)')
1683
 
        if format is None:
1684
 
            format = BzrDirFormat.get_default_format()
1685
 
        if not isinstance(self._format, format.__class__):
 
1043
        if (not isinstance(self._format, format.__class__) or
 
1044
            self._format.get_format_string() != format.get_format_string()):
1686
1045
            # it is not a meta dir format, conversion is needed.
1687
1046
            return True
1688
1047
        # we might want to push this down to the repository?
1693
1052
                return True
1694
1053
        except errors.NoRepositoryPresent:
1695
1054
            pass
1696
 
        try:
1697
 
            if not isinstance(self.open_branch()._format,
 
1055
        for branch in self.list_branches():
 
1056
            if not isinstance(branch._format,
1698
1057
                              format.get_branch_format().__class__):
1699
1058
                # the branch needs an upgrade.
1700
1059
                return True
1701
 
        except errors.NotBranchError:
1702
 
            pass
1703
1060
        try:
1704
1061
            my_wt = self.open_workingtree(recommend_upgrade=False)
1705
1062
            if not isinstance(my_wt._format,
1710
1067
            pass
1711
1068
        return False
1712
1069
 
1713
 
    def open_branch(self, unsupported=False, ignore_fallbacks=False):
1714
 
        """See BzrDir.open_branch."""
1715
 
        format = self.find_branch_format()
1716
 
        self._check_supported(format, unsupported)
1717
 
        return format.open(self, _found=True, ignore_fallbacks=ignore_fallbacks)
 
1070
    def open_branch(self, name=None, unsupported=False,
 
1071
                    ignore_fallbacks=False, possible_transports=None):
 
1072
        """See ControlDir.open_branch."""
 
1073
        if name is None:
 
1074
            name = self._get_selected_branch()
 
1075
        format = self.find_branch_format(name=name)
 
1076
        format.check_support_status(unsupported)
 
1077
        return format.open(self, name=name,
 
1078
            _found=True, ignore_fallbacks=ignore_fallbacks,
 
1079
            possible_transports=possible_transports)
1718
1080
 
1719
1081
    def open_repository(self, unsupported=False):
1720
1082
        """See BzrDir.open_repository."""
1721
 
        from bzrlib.repository import RepositoryFormat
1722
 
        format = RepositoryFormat.find_format(self)
1723
 
        self._check_supported(format, unsupported)
 
1083
        from bzrlib.repository import RepositoryFormatMetaDir
 
1084
        format = RepositoryFormatMetaDir.find_format(self)
 
1085
        format.check_support_status(unsupported)
1724
1086
        return format.open(self, _found=True)
1725
1087
 
1726
1088
    def open_workingtree(self, unsupported=False,
1727
1089
            recommend_upgrade=True):
1728
1090
        """See BzrDir.open_workingtree."""
1729
 
        from bzrlib.workingtree import WorkingTreeFormat
1730
 
        format = WorkingTreeFormat.find_format(self)
1731
 
        self._check_supported(format, unsupported,
1732
 
            recommend_upgrade,
 
1091
        from bzrlib.workingtree import WorkingTreeFormatMetaDir
 
1092
        format = WorkingTreeFormatMetaDir.find_format(self)
 
1093
        format.check_support_status(unsupported, recommend_upgrade,
1733
1094
            basedir=self.root_transport.base)
1734
1095
        return format.open(self, _found=True)
1735
1096
 
1737
1098
        return config.TransportConfig(self.transport, 'control.conf')
1738
1099
 
1739
1100
 
1740
 
class BzrDirFormat(object):
1741
 
    """An encapsulation of the initialization and open routines for a format.
1742
 
 
1743
 
    Formats provide three things:
1744
 
     * An initialization routine,
1745
 
     * a format string,
1746
 
     * an open routine.
 
1101
class BzrFormat(object):
 
1102
    """Base class for all formats of things living in metadirs.
 
1103
 
 
1104
    This class manages the format string that is stored in the 'format'
 
1105
    or 'branch-format' file.
 
1106
 
 
1107
    All classes for (branch-, repository-, workingtree-) formats that
 
1108
    live in meta directories and have their own 'format' file
 
1109
    (i.e. different from .bzr/branch-format) derive from this class,
 
1110
    as well as the relevant base class for their kind
 
1111
    (BranchFormat, WorkingTreeFormat, RepositoryFormat).
 
1112
 
 
1113
    Each format is identified by a "format" or "branch-format" file with a
 
1114
    single line containing the base format name and then an optional list of
 
1115
    feature flags.
 
1116
 
 
1117
    Feature flags are supported as of bzr 2.5. Setting feature flags on formats
 
1118
    will render them inaccessible to older versions of bzr.
 
1119
 
 
1120
    :ivar features: Dictionary mapping feature names to their necessity
 
1121
    """
 
1122
 
 
1123
    _present_features = set()
 
1124
 
 
1125
    def __init__(self):
 
1126
        self.features = {}
 
1127
 
 
1128
    @classmethod
 
1129
    def register_feature(cls, name):
 
1130
        """Register a feature as being present.
 
1131
 
 
1132
        :param name: Name of the feature
 
1133
        """
 
1134
        if " " in name:
 
1135
            raise ValueError("spaces are not allowed in feature names")
 
1136
        if name in cls._present_features:
 
1137
            raise errors.FeatureAlreadyRegistered(name)
 
1138
        cls._present_features.add(name)
 
1139
 
 
1140
    @classmethod
 
1141
    def unregister_feature(cls, name):
 
1142
        """Unregister a feature."""
 
1143
        cls._present_features.remove(name)
 
1144
 
 
1145
    def check_support_status(self, allow_unsupported, recommend_upgrade=True,
 
1146
            basedir=None):
 
1147
        for name, necessity in self.features.iteritems():
 
1148
            if name in self._present_features:
 
1149
                continue
 
1150
            if necessity == "optional":
 
1151
                mutter("ignoring optional missing feature %s", name)
 
1152
                continue
 
1153
            elif necessity == "required":
 
1154
                raise errors.MissingFeature(name)
 
1155
            else:
 
1156
                mutter("treating unknown necessity as require for %s",
 
1157
                       name)
 
1158
                raise errors.MissingFeature(name)
 
1159
 
 
1160
    @classmethod
 
1161
    def get_format_string(cls):
 
1162
        """Return the ASCII format string that identifies this format."""
 
1163
        raise NotImplementedError(cls.get_format_string)
 
1164
 
 
1165
    @classmethod
 
1166
    def from_string(cls, text):
 
1167
        format_string = cls.get_format_string()
 
1168
        if not text.startswith(format_string):
 
1169
            raise AssertionError("Invalid format header %r for %r" % (text, cls))
 
1170
        lines = text[len(format_string):].splitlines()
 
1171
        ret = cls()
 
1172
        for lineno, line in enumerate(lines):
 
1173
            try:
 
1174
                (necessity, feature) = line.split(" ", 1)
 
1175
            except ValueError:
 
1176
                raise errors.ParseFormatError(format=cls, lineno=lineno+2,
 
1177
                    line=line, text=text)
 
1178
            ret.features[feature] = necessity
 
1179
        return ret
 
1180
 
 
1181
    def as_string(self):
 
1182
        """Return the string representation of this format.
 
1183
        """
 
1184
        lines = [self.get_format_string()]
 
1185
        lines.extend([("%s %s\n" % (item[1], item[0])) for item in
 
1186
            self.features.iteritems()])
 
1187
        return "".join(lines)
 
1188
 
 
1189
    @classmethod
 
1190
    def _find_format(klass, registry, kind, format_string):
 
1191
        try:
 
1192
            first_line = format_string[:format_string.index("\n")+1]
 
1193
        except ValueError:
 
1194
            first_line = format_string
 
1195
        try:
 
1196
            cls = registry.get(first_line)
 
1197
        except KeyError:
 
1198
            raise errors.UnknownFormatError(format=first_line, kind=kind)
 
1199
        return cls.from_string(format_string)
 
1200
 
 
1201
    def network_name(self):
 
1202
        """A simple byte string uniquely identifying this format for RPC calls.
 
1203
 
 
1204
        Metadir branch formats use their format string.
 
1205
        """
 
1206
        return self.as_string()
 
1207
 
 
1208
    def __eq__(self, other):
 
1209
        return (self.__class__ is other.__class__ and
 
1210
                self.features == other.features)
 
1211
 
 
1212
    def _update_feature_flags(self, updated_flags):
 
1213
        """Update the feature flags in this format.
 
1214
 
 
1215
        :param updated_flags: Updated feature flags
 
1216
        """
 
1217
        for name, necessity in updated_flags.iteritems():
 
1218
            if necessity is None:
 
1219
                try:
 
1220
                    del self.features[name]
 
1221
                except KeyError:
 
1222
                    pass
 
1223
            else:
 
1224
                self.features[name] = necessity
 
1225
 
 
1226
 
 
1227
class BzrProber(controldir.Prober):
 
1228
    """Prober for formats that use a .bzr/ control directory."""
 
1229
 
 
1230
    formats = registry.FormatRegistry(controldir.network_format_registry)
 
1231
    """The known .bzr formats."""
 
1232
 
 
1233
    @classmethod
 
1234
    def probe_transport(klass, transport):
 
1235
        """Return the .bzrdir style format present in a directory."""
 
1236
        try:
 
1237
            format_string = transport.get_bytes(".bzr/branch-format")
 
1238
        except errors.NoSuchFile:
 
1239
            raise errors.NotBranchError(path=transport.base)
 
1240
        try:
 
1241
            first_line = format_string[:format_string.index("\n")+1]
 
1242
        except ValueError:
 
1243
            first_line = format_string
 
1244
        try:
 
1245
            cls = klass.formats.get(first_line)
 
1246
        except KeyError:
 
1247
            raise errors.UnknownFormatError(format=first_line, kind='bzrdir')
 
1248
        return cls.from_string(format_string)
 
1249
 
 
1250
    @classmethod
 
1251
    def known_formats(cls):
 
1252
        result = set()
 
1253
        for name, format in cls.formats.iteritems():
 
1254
            if callable(format):
 
1255
                format = format()
 
1256
            result.add(format)
 
1257
        return result
 
1258
 
 
1259
 
 
1260
controldir.ControlDirFormat.register_prober(BzrProber)
 
1261
 
 
1262
 
 
1263
class RemoteBzrProber(controldir.Prober):
 
1264
    """Prober for remote servers that provide a Bazaar smart server."""
 
1265
 
 
1266
    @classmethod
 
1267
    def probe_transport(klass, transport):
 
1268
        """Return a RemoteBzrDirFormat object if it looks possible."""
 
1269
        try:
 
1270
            medium = transport.get_smart_medium()
 
1271
        except (NotImplementedError, AttributeError,
 
1272
                errors.TransportNotPossible, errors.NoSmartMedium,
 
1273
                errors.SmartProtocolError):
 
1274
            # no smart server, so not a branch for this format type.
 
1275
            raise errors.NotBranchError(path=transport.base)
 
1276
        else:
 
1277
            # Decline to open it if the server doesn't support our required
 
1278
            # version (3) so that the VFS-based transport will do it.
 
1279
            if medium.should_probe():
 
1280
                try:
 
1281
                    server_version = medium.protocol_version()
 
1282
                except errors.SmartProtocolError:
 
1283
                    # Apparently there's no usable smart server there, even though
 
1284
                    # the medium supports the smart protocol.
 
1285
                    raise errors.NotBranchError(path=transport.base)
 
1286
                if server_version != '2':
 
1287
                    raise errors.NotBranchError(path=transport.base)
 
1288
            from bzrlib.remote import RemoteBzrDirFormat
 
1289
            return RemoteBzrDirFormat()
 
1290
 
 
1291
    @classmethod
 
1292
    def known_formats(cls):
 
1293
        from bzrlib.remote import RemoteBzrDirFormat
 
1294
        return set([RemoteBzrDirFormat()])
 
1295
 
 
1296
 
 
1297
class BzrDirFormat(BzrFormat, controldir.ControlDirFormat):
 
1298
    """ControlDirFormat base class for .bzr/ directories.
1747
1299
 
1748
1300
    Formats are placed in a dict by their format string for reference
1749
1301
    during bzrdir opening. These should be subclasses of BzrDirFormat
1754
1306
    object will be created every system load.
1755
1307
    """
1756
1308
 
1757
 
    _default_format = None
1758
 
    """The default format used for new .bzr dirs."""
1759
 
 
1760
 
    _formats = {}
1761
 
    """The known formats."""
1762
 
 
1763
 
    _control_formats = []
1764
 
    """The registered control formats - .bzr, ....
1765
 
 
1766
 
    This is a list of BzrDirFormat objects.
1767
 
    """
1768
 
 
1769
 
    _control_server_formats = []
1770
 
    """The registered control server formats, e.g. RemoteBzrDirs.
1771
 
 
1772
 
    This is a list of BzrDirFormat objects.
1773
 
    """
1774
 
 
1775
1309
    _lock_file_name = 'branch-lock'
1776
1310
 
1777
1311
    # _lock_class must be set in subclasses to the lock type, typ.
1778
1312
    # TransportLock or LockDir
1779
1313
 
1780
 
    @classmethod
1781
 
    def find_format(klass, transport, _server_formats=True):
1782
 
        """Return the format present at transport."""
1783
 
        if _server_formats:
1784
 
            formats = klass._control_server_formats + klass._control_formats
1785
 
        else:
1786
 
            formats = klass._control_formats
1787
 
        for format in formats:
1788
 
            try:
1789
 
                return format.probe_transport(transport)
1790
 
            except errors.NotBranchError:
1791
 
                # this format does not find a control dir here.
1792
 
                pass
1793
 
        raise errors.NotBranchError(path=transport.base)
1794
 
 
1795
 
    @classmethod
1796
 
    def probe_transport(klass, transport):
1797
 
        """Return the .bzrdir style format present in a directory."""
1798
 
        try:
1799
 
            format_string = transport.get(".bzr/branch-format").read()
1800
 
        except errors.NoSuchFile:
1801
 
            raise errors.NotBranchError(path=transport.base)
1802
 
 
1803
 
        try:
1804
 
            return klass._formats[format_string]
1805
 
        except KeyError:
1806
 
            raise errors.UnknownFormatError(format=format_string, kind='bzrdir')
1807
 
 
1808
 
    @classmethod
1809
 
    def get_default_format(klass):
1810
 
        """Return the current default format."""
1811
 
        return klass._default_format
1812
 
 
1813
 
    def get_format_string(self):
1814
 
        """Return the ASCII format string that identifies this format."""
1815
 
        raise NotImplementedError(self.get_format_string)
1816
 
 
1817
 
    def get_format_description(self):
1818
 
        """Return the short description for this format."""
1819
 
        raise NotImplementedError(self.get_format_description)
1820
 
 
1821
 
    def get_converter(self, format=None):
1822
 
        """Return the converter to use to convert bzrdirs needing converts.
1823
 
 
1824
 
        This returns a bzrlib.bzrdir.Converter object.
1825
 
 
1826
 
        This should return the best upgrader to step this format towards the
1827
 
        current default format. In the case of plugins we can/should provide
1828
 
        some means for them to extend the range of returnable converters.
1829
 
 
1830
 
        :param format: Optional format to override the default format of the
1831
 
                       library.
1832
 
        """
1833
 
        raise NotImplementedError(self.get_converter)
1834
 
 
1835
 
    def initialize(self, url, possible_transports=None):
1836
 
        """Create a bzr control dir at this url and return an opened copy.
1837
 
 
1838
 
        While not deprecated, this method is very specific and its use will
1839
 
        lead to many round trips to setup a working environment. See
1840
 
        initialize_on_transport_ex for a [nearly] all-in-one method.
1841
 
 
1842
 
        Subclasses should typically override initialize_on_transport
1843
 
        instead of this method.
1844
 
        """
1845
 
        return self.initialize_on_transport(get_transport(url,
1846
 
                                                          possible_transports))
1847
 
 
1848
1314
    def initialize_on_transport(self, transport):
1849
1315
        """Initialize a new bzrdir in the base directory of a Transport."""
1850
1316
        try:
1859
1325
            # metadir1
1860
1326
            if type(self) != BzrDirMetaFormat1:
1861
1327
                return self._initialize_on_transport_vfs(transport)
 
1328
            from bzrlib.remote import RemoteBzrDirFormat
1862
1329
            remote_format = RemoteBzrDirFormat()
1863
1330
            self._supply_sub_formats_to(remote_format)
1864
1331
            return remote_format.initialize_on_transport(transport)
1890
1357
        :param shared_repo: Control whether made repositories are shared or
1891
1358
            not.
1892
1359
        :param vfs_only: If True do not attempt to use a smart server
1893
 
        :return: repo, bzrdir, require_stacking, repository_policy. repo is
 
1360
        :return: repo, controldir, require_stacking, repository_policy. repo is
1894
1361
            None if none was created or found, bzrdir is always valid.
1895
1362
            require_stacking is the result of examining the stacked_on
1896
1363
            parameter and any stacking policy found for the target.
1902
1369
            except errors.NoSmartMedium:
1903
1370
                pass
1904
1371
            else:
 
1372
                from bzrlib.remote import RemoteBzrDirFormat
1905
1373
                # TODO: lookup the local format from a server hint.
1906
1374
                remote_dir_format = RemoteBzrDirFormat()
1907
1375
                remote_dir_format._network_name = self.network_name()
1970
1438
        # mode from the root directory
1971
1439
        temp_control = lockable_files.LockableFiles(transport,
1972
1440
                            '', lockable_files.TransportLock)
1973
 
        temp_control._transport.mkdir('.bzr',
1974
 
                                      # FIXME: RBC 20060121 don't peek under
1975
 
                                      # the covers
1976
 
                                      mode=temp_control._dir_mode)
 
1441
        try:
 
1442
            temp_control._transport.mkdir('.bzr',
 
1443
                # FIXME: RBC 20060121 don't peek under
 
1444
                # the covers
 
1445
                mode=temp_control._dir_mode)
 
1446
        except errors.FileExists:
 
1447
            raise errors.AlreadyControlDirError(transport.base)
1977
1448
        if sys.platform == 'win32' and isinstance(transport, local.LocalTransport):
1978
1449
            win32utils.set_file_attr_hidden(transport._abspath('.bzr'))
1979
1450
        file_mode = temp_control._file_mode
1982
1453
        utf8_files = [('README',
1983
1454
                       "This is a Bazaar control directory.\n"
1984
1455
                       "Do not change any files in this directory.\n"
1985
 
                       "See http://bazaar-vcs.org/ for more information about Bazaar.\n"),
1986
 
                      ('branch-format', self.get_format_string()),
 
1456
                       "See http://bazaar.canonical.com/ for more information about Bazaar.\n"),
 
1457
                      ('branch-format', self.as_string()),
1987
1458
                      ]
1988
1459
        # NB: no need to escape relative paths that are url safe.
1989
1460
        control_files = lockable_files.LockableFiles(bzrdir_transport,
1998
1469
            control_files.unlock()
1999
1470
        return self.open(transport, _found=True)
2000
1471
 
2001
 
    def is_supported(self):
2002
 
        """Is this format supported?
2003
 
 
2004
 
        Supported formats must be initializable and openable.
2005
 
        Unsupported formats may not support initialization or committing or
2006
 
        some other features depending on the reason for not being supported.
2007
 
        """
2008
 
        return True
2009
 
 
2010
 
    def network_name(self):
2011
 
        """A simple byte string uniquely identifying this format for RPC calls.
2012
 
 
2013
 
        Bzr control formats use thir disk format string to identify the format
2014
 
        over the wire. Its possible that other control formats have more
2015
 
        complex detection requirements, so we permit them to use any unique and
2016
 
        immutable string they desire.
2017
 
        """
2018
 
        raise NotImplementedError(self.network_name)
2019
 
 
2020
 
    def same_model(self, target_format):
2021
 
        return (self.repository_format.rich_root_data ==
2022
 
            target_format.rich_root_data)
2023
 
 
2024
 
    @classmethod
2025
 
    def known_formats(klass):
2026
 
        """Return all the known formats.
2027
 
 
2028
 
        Concrete formats should override _known_formats.
2029
 
        """
2030
 
        # There is double indirection here to make sure that control
2031
 
        # formats used by more than one dir format will only be probed
2032
 
        # once. This can otherwise be quite expensive for remote connections.
2033
 
        result = set()
2034
 
        for format in klass._control_formats:
2035
 
            result.update(format._known_formats())
2036
 
        return result
2037
 
 
2038
 
    @classmethod
2039
 
    def _known_formats(klass):
2040
 
        """Return the known format instances for this control format."""
2041
 
        return set(klass._formats.values())
2042
 
 
2043
1472
    def open(self, transport, _found=False):
2044
1473
        """Return an instance of this format for the dir transport points at.
2045
1474
 
2046
1475
        _found is a private parameter, do not use it.
2047
1476
        """
2048
1477
        if not _found:
2049
 
            found_format = BzrDirFormat.find_format(transport)
 
1478
            found_format = controldir.ControlDirFormat.find_format(transport)
2050
1479
            if not isinstance(found_format, self.__class__):
2051
1480
                raise AssertionError("%s was asked to open %s, but it seems to need "
2052
1481
                        "format %s"
2064
1493
        """
2065
1494
        raise NotImplementedError(self._open)
2066
1495
 
2067
 
    @classmethod
2068
 
    def register_format(klass, format):
2069
 
        klass._formats[format.get_format_string()] = format
2070
 
        # bzr native formats have a network name of their format string.
2071
 
        network_format_registry.register(format.get_format_string(), format.__class__)
2072
 
 
2073
 
    @classmethod
2074
 
    def register_control_format(klass, format):
2075
 
        """Register a format that does not use '.bzr' for its control dir.
2076
 
 
2077
 
        TODO: This should be pulled up into a 'ControlDirFormat' base class
2078
 
        which BzrDirFormat can inherit from, and renamed to register_format
2079
 
        there. It has been done without that for now for simplicity of
2080
 
        implementation.
2081
 
        """
2082
 
        klass._control_formats.append(format)
2083
 
 
2084
 
    @classmethod
2085
 
    def register_control_server_format(klass, format):
2086
 
        """Register a control format for client-server environments.
2087
 
 
2088
 
        These formats will be tried before ones registered with
2089
 
        register_control_format.  This gives implementations that decide to the
2090
 
        chance to grab it before anything looks at the contents of the format
2091
 
        file.
2092
 
        """
2093
 
        klass._control_server_formats.append(format)
2094
 
 
2095
 
    @classmethod
2096
 
    def _set_default_format(klass, format):
2097
 
        """Set default format (for testing behavior of defaults only)"""
2098
 
        klass._default_format = format
2099
 
 
2100
 
    def __str__(self):
2101
 
        # Trim the newline
2102
 
        return self.get_format_description().rstrip()
2103
 
 
2104
1496
    def _supply_sub_formats_to(self, other_format):
2105
1497
        """Give other_format the same values for sub formats as this has.
2106
1498
 
2112
1504
            compatible with whatever sub formats are supported by self.
2113
1505
        :return: None.
2114
1506
        """
2115
 
 
2116
 
    @classmethod
2117
 
    def unregister_format(klass, format):
2118
 
        del klass._formats[format.get_format_string()]
2119
 
 
2120
 
    @classmethod
2121
 
    def unregister_control_format(klass, format):
2122
 
        klass._control_formats.remove(format)
2123
 
 
2124
 
 
2125
 
class BzrDirFormat4(BzrDirFormat):
2126
 
    """Bzr dir format 4.
2127
 
 
2128
 
    This format is a combined format for working tree, branch and repository.
2129
 
    It has:
2130
 
     - Format 1 working trees [always]
2131
 
     - Format 4 branches [always]
2132
 
     - Format 4 repositories [always]
2133
 
 
2134
 
    This format is deprecated: it indexes texts using a text it which is
2135
 
    removed in format 5; write support for this format has been removed.
2136
 
    """
2137
 
 
2138
 
    _lock_class = lockable_files.TransportLock
2139
 
 
2140
 
    def get_format_string(self):
2141
 
        """See BzrDirFormat.get_format_string()."""
2142
 
        return "Bazaar-NG branch, format 0.0.4\n"
2143
 
 
2144
 
    def get_format_description(self):
2145
 
        """See BzrDirFormat.get_format_description()."""
2146
 
        return "All-in-one format 4"
2147
 
 
2148
 
    def get_converter(self, format=None):
2149
 
        """See BzrDirFormat.get_converter()."""
2150
 
        # there is one and only one upgrade path here.
2151
 
        return ConvertBzrDir4To5()
2152
 
 
2153
 
    def initialize_on_transport(self, transport):
2154
 
        """Format 4 branches cannot be created."""
2155
 
        raise errors.UninitializableFormat(self)
2156
 
 
2157
 
    def is_supported(self):
2158
 
        """Format 4 is not supported.
2159
 
 
2160
 
        It is not supported because the model changed from 4 to 5 and the
2161
 
        conversion logic is expensive - so doing it on the fly was not
2162
 
        feasible.
2163
 
        """
2164
 
        return False
2165
 
 
2166
 
    def network_name(self):
2167
 
        return self.get_format_string()
2168
 
 
2169
 
    def _open(self, transport):
2170
 
        """See BzrDirFormat._open."""
2171
 
        return BzrDir4(transport, self)
2172
 
 
2173
 
    def __return_repository_format(self):
2174
 
        """Circular import protection."""
2175
 
        from bzrlib.repofmt.weaverepo import RepositoryFormat4
2176
 
        return RepositoryFormat4()
2177
 
    repository_format = property(__return_repository_format)
2178
 
 
2179
 
 
2180
 
class BzrDirFormatAllInOne(BzrDirFormat):
2181
 
    """Common class for formats before meta-dirs."""
2182
 
 
2183
 
    def initialize_on_transport_ex(self, transport, use_existing_dir=False,
2184
 
        create_prefix=False, force_new_repo=False, stacked_on=None,
2185
 
        stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
2186
 
        shared_repo=False):
2187
 
        """See BzrDirFormat.initialize_on_transport_ex."""
2188
 
        require_stacking = (stacked_on is not None)
2189
 
        # Format 5 cannot stack, but we've been asked to - actually init
2190
 
        # a Meta1Dir
2191
 
        if require_stacking:
2192
 
            format = BzrDirMetaFormat1()
2193
 
            return format.initialize_on_transport_ex(transport,
2194
 
                use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2195
 
                force_new_repo=force_new_repo, stacked_on=stacked_on,
2196
 
                stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2197
 
                make_working_trees=make_working_trees, shared_repo=shared_repo)
2198
 
        return BzrDirFormat.initialize_on_transport_ex(self, transport,
2199
 
            use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2200
 
            force_new_repo=force_new_repo, stacked_on=stacked_on,
2201
 
            stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2202
 
            make_working_trees=make_working_trees, shared_repo=shared_repo)
2203
 
 
2204
 
 
2205
 
class BzrDirFormat5(BzrDirFormatAllInOne):
2206
 
    """Bzr control format 5.
2207
 
 
2208
 
    This format is a combined format for working tree, branch and repository.
2209
 
    It has:
2210
 
     - Format 2 working trees [always]
2211
 
     - Format 4 branches [always]
2212
 
     - Format 5 repositories [always]
2213
 
       Unhashed stores in the repository.
2214
 
    """
2215
 
 
2216
 
    _lock_class = lockable_files.TransportLock
2217
 
 
2218
 
    def get_format_string(self):
2219
 
        """See BzrDirFormat.get_format_string()."""
2220
 
        return "Bazaar-NG branch, format 5\n"
2221
 
 
2222
 
    def get_branch_format(self):
2223
 
        from bzrlib import branch
2224
 
        return branch.BzrBranchFormat4()
2225
 
 
2226
 
    def get_format_description(self):
2227
 
        """See BzrDirFormat.get_format_description()."""
2228
 
        return "All-in-one format 5"
2229
 
 
2230
 
    def get_converter(self, format=None):
2231
 
        """See BzrDirFormat.get_converter()."""
2232
 
        # there is one and only one upgrade path here.
2233
 
        return ConvertBzrDir5To6()
2234
 
 
2235
 
    def _initialize_for_clone(self, url):
2236
 
        return self.initialize_on_transport(get_transport(url), _cloning=True)
2237
 
 
2238
 
    def initialize_on_transport(self, transport, _cloning=False):
2239
 
        """Format 5 dirs always have working tree, branch and repository.
2240
 
 
2241
 
        Except when they are being cloned.
2242
 
        """
2243
 
        from bzrlib.branch import BzrBranchFormat4
2244
 
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
2245
 
        result = (super(BzrDirFormat5, self).initialize_on_transport(transport))
2246
 
        RepositoryFormat5().initialize(result, _internal=True)
2247
 
        if not _cloning:
2248
 
            branch = BzrBranchFormat4().initialize(result)
2249
 
            result._init_workingtree()
2250
 
        return result
2251
 
 
2252
 
    def network_name(self):
2253
 
        return self.get_format_string()
2254
 
 
2255
 
    def _open(self, transport):
2256
 
        """See BzrDirFormat._open."""
2257
 
        return BzrDir5(transport, self)
2258
 
 
2259
 
    def __return_repository_format(self):
2260
 
        """Circular import protection."""
2261
 
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
2262
 
        return RepositoryFormat5()
2263
 
    repository_format = property(__return_repository_format)
2264
 
 
2265
 
 
2266
 
class BzrDirFormat6(BzrDirFormatAllInOne):
2267
 
    """Bzr control format 6.
2268
 
 
2269
 
    This format is a combined format for working tree, branch and repository.
2270
 
    It has:
2271
 
     - Format 2 working trees [always]
2272
 
     - Format 4 branches [always]
2273
 
     - Format 6 repositories [always]
2274
 
    """
2275
 
 
2276
 
    _lock_class = lockable_files.TransportLock
2277
 
 
2278
 
    def get_format_string(self):
2279
 
        """See BzrDirFormat.get_format_string()."""
2280
 
        return "Bazaar-NG branch, format 6\n"
2281
 
 
2282
 
    def get_format_description(self):
2283
 
        """See BzrDirFormat.get_format_description()."""
2284
 
        return "All-in-one format 6"
2285
 
 
2286
 
    def get_branch_format(self):
2287
 
        from bzrlib import branch
2288
 
        return branch.BzrBranchFormat4()
2289
 
 
2290
 
    def get_converter(self, format=None):
2291
 
        """See BzrDirFormat.get_converter()."""
2292
 
        # there is one and only one upgrade path here.
2293
 
        return ConvertBzrDir6ToMeta()
2294
 
 
2295
 
    def _initialize_for_clone(self, url):
2296
 
        return self.initialize_on_transport(get_transport(url), _cloning=True)
2297
 
 
2298
 
    def initialize_on_transport(self, transport, _cloning=False):
2299
 
        """Format 6 dirs always have working tree, branch and repository.
2300
 
 
2301
 
        Except when they are being cloned.
2302
 
        """
2303
 
        from bzrlib.branch import BzrBranchFormat4
2304
 
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
2305
 
        result = super(BzrDirFormat6, self).initialize_on_transport(transport)
2306
 
        RepositoryFormat6().initialize(result, _internal=True)
2307
 
        if not _cloning:
2308
 
            branch = BzrBranchFormat4().initialize(result)
2309
 
            result._init_workingtree()
2310
 
        return result
2311
 
 
2312
 
    def network_name(self):
2313
 
        return self.get_format_string()
2314
 
 
2315
 
    def _open(self, transport):
2316
 
        """See BzrDirFormat._open."""
2317
 
        return BzrDir6(transport, self)
2318
 
 
2319
 
    def __return_repository_format(self):
2320
 
        """Circular import protection."""
2321
 
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
2322
 
        return RepositoryFormat6()
2323
 
    repository_format = property(__return_repository_format)
 
1507
        other_format.features = dict(self.features)
 
1508
 
 
1509
    def supports_transport(self, transport):
 
1510
        # bzr formats can be opened over all known transports
 
1511
        return True
 
1512
 
 
1513
    def check_support_status(self, allow_unsupported, recommend_upgrade=True,
 
1514
            basedir=None):
 
1515
        controldir.ControlDirFormat.check_support_status(self,
 
1516
            allow_unsupported=allow_unsupported, recommend_upgrade=recommend_upgrade,
 
1517
            basedir=basedir)
 
1518
        BzrFormat.check_support_status(self, allow_unsupported=allow_unsupported,
 
1519
            recommend_upgrade=recommend_upgrade, basedir=basedir)
2324
1520
 
2325
1521
 
2326
1522
class BzrDirMetaFormat1(BzrDirFormat):
2328
1524
 
2329
1525
    This is the first format with split out working tree, branch and repository
2330
1526
    disk storage.
 
1527
 
2331
1528
    It has:
2332
 
     - Format 3 working trees [optional]
2333
 
     - Format 5 branches [optional]
2334
 
     - Format 7 repositories [optional]
 
1529
 
 
1530
    - Format 3 working trees [optional]
 
1531
    - Format 5 branches [optional]
 
1532
    - Format 7 repositories [optional]
2335
1533
    """
2336
1534
 
2337
1535
    _lock_class = lockdir.LockDir
2338
1536
 
 
1537
    fixed_components = False
 
1538
 
 
1539
    colocated_branches = True
 
1540
 
2339
1541
    def __init__(self):
 
1542
        BzrDirFormat.__init__(self)
2340
1543
        self._workingtree_format = None
2341
1544
        self._branch_format = None
2342
1545
        self._repository_format = None
2348
1551
            return False
2349
1552
        if other.workingtree_format != self.workingtree_format:
2350
1553
            return False
 
1554
        if other.features != self.features:
 
1555
            return False
2351
1556
        return True
2352
1557
 
2353
1558
    def __ne__(self, other):
2355
1560
 
2356
1561
    def get_branch_format(self):
2357
1562
        if self._branch_format is None:
2358
 
            from bzrlib.branch import BranchFormat
2359
 
            self._branch_format = BranchFormat.get_default_format()
 
1563
            from bzrlib.branch import format_registry as branch_format_registry
 
1564
            self._branch_format = branch_format_registry.get_default()
2360
1565
        return self._branch_format
2361
1566
 
2362
1567
    def set_branch_format(self, format):
2417
1622
                    # stack_on is inaccessible, JFDI.
2418
1623
                    # TODO: bad monkey, hard-coded formats...
2419
1624
                    if self.repository_format.rich_root_data:
2420
 
                        new_repo_format = pack_repo.RepositoryFormatKnitPack5RichRoot()
 
1625
                        new_repo_format = knitpack_repo.RepositoryFormatKnitPack5RichRoot()
2421
1626
                    else:
2422
 
                        new_repo_format = pack_repo.RepositoryFormatKnitPack5()
 
1627
                        new_repo_format = knitpack_repo.RepositoryFormatKnitPack5()
2423
1628
            else:
2424
1629
                # If the target already supports stacking, then we know the
2425
1630
                # project is already able to use stacking, so auto-upgrade
2431
1636
                    new_repo_format = None
2432
1637
            if new_repo_format is not None:
2433
1638
                self.repository_format = new_repo_format
2434
 
                note('Source repository format does not support stacking,'
2435
 
                     ' using format:\n  %s',
 
1639
                note(gettext('Source repository format does not support stacking,'
 
1640
                     ' using format:\n  %s'),
2436
1641
                     new_repo_format.get_format_description())
2437
1642
 
2438
1643
        if not self.get_branch_format().supports_stacking():
2442
1647
            if target_branch is None:
2443
1648
                if do_upgrade:
2444
1649
                    # TODO: bad monkey, hard-coded formats...
2445
 
                    new_branch_format = branch.BzrBranchFormat7()
 
1650
                    from bzrlib.branch import BzrBranchFormat7
 
1651
                    new_branch_format = BzrBranchFormat7()
2446
1652
            else:
2447
1653
                new_branch_format = target_branch._format
2448
1654
                if not new_branch_format.supports_stacking():
2450
1656
            if new_branch_format is not None:
2451
1657
                # Does support stacking, use its format.
2452
1658
                self.set_branch_format(new_branch_format)
2453
 
                note('Source branch format does not support stacking,'
2454
 
                     ' using format:\n  %s',
 
1659
                note(gettext('Source branch format does not support stacking,'
 
1660
                     ' using format:\n  %s'),
2455
1661
                     new_branch_format.get_format_description())
2456
1662
 
2457
1663
    def get_converter(self, format=None):
2458
1664
        """See BzrDirFormat.get_converter()."""
2459
1665
        if format is None:
2460
1666
            format = BzrDirFormat.get_default_format()
 
1667
        if (type(self) is BzrDirMetaFormat1 and
 
1668
            type(format) is BzrDirMetaFormat1Colo):
 
1669
            return ConvertMetaToColo(format)
 
1670
        if (type(self) is BzrDirMetaFormat1Colo and
 
1671
            type(format) is BzrDirMetaFormat1):
 
1672
            return ConvertMetaToColo(format)
2461
1673
        if not isinstance(self, format.__class__):
2462
1674
            # converting away from metadir is not implemented
2463
1675
            raise NotImplementedError(self.get_converter)
2464
1676
        return ConvertMetaToMeta(format)
2465
1677
 
2466
 
    def get_format_string(self):
 
1678
    @classmethod
 
1679
    def get_format_string(cls):
2467
1680
        """See BzrDirFormat.get_format_string()."""
2468
1681
        return "Bazaar-NG meta directory, format 1\n"
2469
1682
 
2471
1684
        """See BzrDirFormat.get_format_description()."""
2472
1685
        return "Meta directory format 1"
2473
1686
 
2474
 
    def network_name(self):
2475
 
        return self.get_format_string()
2476
 
 
2477
1687
    def _open(self, transport):
2478
1688
        """See BzrDirFormat._open."""
2479
1689
        # Create a new format instance because otherwise initialisation of new
2487
1697
        """Circular import protection."""
2488
1698
        if self._repository_format:
2489
1699
            return self._repository_format
2490
 
        from bzrlib.repository import RepositoryFormat
2491
 
        return RepositoryFormat.get_default_format()
 
1700
        from bzrlib.repository import format_registry
 
1701
        return format_registry.get_default()
2492
1702
 
2493
1703
    def _set_repository_format(self, value):
2494
1704
        """Allow changing the repository format for metadir formats."""
2508
1718
            compatible with whatever sub formats are supported by self.
2509
1719
        :return: None.
2510
1720
        """
 
1721
        super(BzrDirMetaFormat1, self)._supply_sub_formats_to(other_format)
2511
1722
        if getattr(self, '_repository_format', None) is not None:
2512
1723
            other_format.repository_format = self.repository_format
2513
1724
        if self._branch_format is not None:
2517
1728
 
2518
1729
    def __get_workingtree_format(self):
2519
1730
        if self._workingtree_format is None:
2520
 
            from bzrlib.workingtree import WorkingTreeFormat
2521
 
            self._workingtree_format = WorkingTreeFormat.get_default_format()
 
1731
            from bzrlib.workingtree import (
 
1732
                format_registry as wt_format_registry,
 
1733
                )
 
1734
            self._workingtree_format = wt_format_registry.get_default()
2522
1735
        return self._workingtree_format
2523
1736
 
2524
1737
    def __set_workingtree_format(self, wt_format):
2525
1738
        self._workingtree_format = wt_format
2526
1739
 
 
1740
    def __repr__(self):
 
1741
        return "<%r>" % (self.__class__.__name__,)
 
1742
 
2527
1743
    workingtree_format = property(__get_workingtree_format,
2528
1744
                                  __set_workingtree_format)
2529
1745
 
2530
1746
 
2531
 
network_format_registry = registry.FormatRegistry()
2532
 
"""Registry of formats indexed by their network name.
2533
 
 
2534
 
The network name for a BzrDirFormat is an identifier that can be used when
2535
 
referring to formats with smart server operations. See
2536
 
BzrDirFormat.network_name() for more detail.
2537
 
"""
2538
 
 
2539
 
 
2540
 
# Register bzr control format
2541
 
BzrDirFormat.register_control_format(BzrDirFormat)
2542
 
 
2543
1747
# Register bzr formats
2544
 
BzrDirFormat.register_format(BzrDirFormat4())
2545
 
BzrDirFormat.register_format(BzrDirFormat5())
2546
 
BzrDirFormat.register_format(BzrDirFormat6())
2547
 
__default_format = BzrDirMetaFormat1()
2548
 
BzrDirFormat.register_format(__default_format)
2549
 
BzrDirFormat._default_format = __default_format
2550
 
 
2551
 
 
2552
 
class Converter(object):
2553
 
    """Converts a disk format object from one format to another."""
2554
 
 
2555
 
    def convert(self, to_convert, pb):
2556
 
        """Perform the conversion of to_convert, giving feedback via pb.
2557
 
 
2558
 
        :param to_convert: The disk object to convert.
2559
 
        :param pb: a progress bar to use for progress information.
2560
 
        """
2561
 
 
2562
 
    def step(self, message):
2563
 
        """Update the pb by a step."""
2564
 
        self.count +=1
2565
 
        self.pb.update(message, self.count, self.total)
2566
 
 
2567
 
 
2568
 
class ConvertBzrDir4To5(Converter):
2569
 
    """Converts format 4 bzr dirs to format 5."""
2570
 
 
2571
 
    def __init__(self):
2572
 
        super(ConvertBzrDir4To5, self).__init__()
2573
 
        self.converted_revs = set()
2574
 
        self.absent_revisions = set()
2575
 
        self.text_count = 0
2576
 
        self.revisions = {}
2577
 
 
2578
 
    def convert(self, to_convert, pb):
2579
 
        """See Converter.convert()."""
2580
 
        self.bzrdir = to_convert
2581
 
        self.pb = pb
2582
 
        self.pb.note('starting upgrade from format 4 to 5')
2583
 
        if isinstance(self.bzrdir.transport, local.LocalTransport):
2584
 
            self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
2585
 
        self._convert_to_weaves()
2586
 
        return BzrDir.open(self.bzrdir.root_transport.base)
2587
 
 
2588
 
    def _convert_to_weaves(self):
2589
 
        self.pb.note('note: upgrade may be faster if all store files are ungzipped first')
2590
 
        try:
2591
 
            # TODO permissions
2592
 
            stat = self.bzrdir.transport.stat('weaves')
2593
 
            if not S_ISDIR(stat.st_mode):
2594
 
                self.bzrdir.transport.delete('weaves')
2595
 
                self.bzrdir.transport.mkdir('weaves')
2596
 
        except errors.NoSuchFile:
2597
 
            self.bzrdir.transport.mkdir('weaves')
2598
 
        # deliberately not a WeaveFile as we want to build it up slowly.
2599
 
        self.inv_weave = Weave('inventory')
2600
 
        # holds in-memory weaves for all files
2601
 
        self.text_weaves = {}
2602
 
        self.bzrdir.transport.delete('branch-format')
2603
 
        self.branch = self.bzrdir.open_branch()
2604
 
        self._convert_working_inv()
2605
 
        rev_history = self.branch.revision_history()
2606
 
        # to_read is a stack holding the revisions we still need to process;
2607
 
        # appending to it adds new highest-priority revisions
2608
 
        self.known_revisions = set(rev_history)
2609
 
        self.to_read = rev_history[-1:]
2610
 
        while self.to_read:
2611
 
            rev_id = self.to_read.pop()
2612
 
            if (rev_id not in self.revisions
2613
 
                and rev_id not in self.absent_revisions):
2614
 
                self._load_one_rev(rev_id)
2615
 
        self.pb.clear()
2616
 
        to_import = self._make_order()
2617
 
        for i, rev_id in enumerate(to_import):
2618
 
            self.pb.update('converting revision', i, len(to_import))
2619
 
            self._convert_one_rev(rev_id)
2620
 
        self.pb.clear()
2621
 
        self._write_all_weaves()
2622
 
        self._write_all_revs()
2623
 
        self.pb.note('upgraded to weaves:')
2624
 
        self.pb.note('  %6d revisions and inventories', len(self.revisions))
2625
 
        self.pb.note('  %6d revisions not present', len(self.absent_revisions))
2626
 
        self.pb.note('  %6d texts', self.text_count)
2627
 
        self._cleanup_spare_files_after_format4()
2628
 
        self.branch._transport.put_bytes(
2629
 
            'branch-format',
2630
 
            BzrDirFormat5().get_format_string(),
2631
 
            mode=self.bzrdir._get_file_mode())
2632
 
 
2633
 
    def _cleanup_spare_files_after_format4(self):
2634
 
        # FIXME working tree upgrade foo.
2635
 
        for n in 'merged-patches', 'pending-merged-patches':
2636
 
            try:
2637
 
                ## assert os.path.getsize(p) == 0
2638
 
                self.bzrdir.transport.delete(n)
2639
 
            except errors.NoSuchFile:
2640
 
                pass
2641
 
        self.bzrdir.transport.delete_tree('inventory-store')
2642
 
        self.bzrdir.transport.delete_tree('text-store')
2643
 
 
2644
 
    def _convert_working_inv(self):
2645
 
        inv = xml4.serializer_v4.read_inventory(
2646
 
                self.branch._transport.get('inventory'))
2647
 
        new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv, working=True)
2648
 
        self.branch._transport.put_bytes('inventory', new_inv_xml,
2649
 
            mode=self.bzrdir._get_file_mode())
2650
 
 
2651
 
    def _write_all_weaves(self):
2652
 
        controlweaves = WeaveStore(self.bzrdir.transport, prefixed=False)
2653
 
        weave_transport = self.bzrdir.transport.clone('weaves')
2654
 
        weaves = WeaveStore(weave_transport, prefixed=False)
2655
 
        transaction = WriteTransaction()
2656
 
 
2657
 
        try:
2658
 
            i = 0
2659
 
            for file_id, file_weave in self.text_weaves.items():
2660
 
                self.pb.update('writing weave', i, len(self.text_weaves))
2661
 
                weaves._put_weave(file_id, file_weave, transaction)
2662
 
                i += 1
2663
 
            self.pb.update('inventory', 0, 1)
2664
 
            controlweaves._put_weave('inventory', self.inv_weave, transaction)
2665
 
            self.pb.update('inventory', 1, 1)
2666
 
        finally:
2667
 
            self.pb.clear()
2668
 
 
2669
 
    def _write_all_revs(self):
2670
 
        """Write all revisions out in new form."""
2671
 
        self.bzrdir.transport.delete_tree('revision-store')
2672
 
        self.bzrdir.transport.mkdir('revision-store')
2673
 
        revision_transport = self.bzrdir.transport.clone('revision-store')
2674
 
        # TODO permissions
2675
 
        from bzrlib.xml5 import serializer_v5
2676
 
        from bzrlib.repofmt.weaverepo import RevisionTextStore
2677
 
        revision_store = RevisionTextStore(revision_transport,
2678
 
            serializer_v5, False, versionedfile.PrefixMapper(),
2679
 
            lambda:True, lambda:True)
2680
 
        try:
2681
 
            for i, rev_id in enumerate(self.converted_revs):
2682
 
                self.pb.update('write revision', i, len(self.converted_revs))
2683
 
                text = serializer_v5.write_revision_to_string(
2684
 
                    self.revisions[rev_id])
2685
 
                key = (rev_id,)
2686
 
                revision_store.add_lines(key, None, osutils.split_lines(text))
2687
 
        finally:
2688
 
            self.pb.clear()
2689
 
 
2690
 
    def _load_one_rev(self, rev_id):
2691
 
        """Load a revision object into memory.
2692
 
 
2693
 
        Any parents not either loaded or abandoned get queued to be
2694
 
        loaded."""
2695
 
        self.pb.update('loading revision',
2696
 
                       len(self.revisions),
2697
 
                       len(self.known_revisions))
2698
 
        if not self.branch.repository.has_revision(rev_id):
2699
 
            self.pb.clear()
2700
 
            self.pb.note('revision {%s} not present in branch; '
2701
 
                         'will be converted as a ghost',
2702
 
                         rev_id)
2703
 
            self.absent_revisions.add(rev_id)
2704
 
        else:
2705
 
            rev = self.branch.repository.get_revision(rev_id)
2706
 
            for parent_id in rev.parent_ids:
2707
 
                self.known_revisions.add(parent_id)
2708
 
                self.to_read.append(parent_id)
2709
 
            self.revisions[rev_id] = rev
2710
 
 
2711
 
    def _load_old_inventory(self, rev_id):
2712
 
        old_inv_xml = self.branch.repository.inventory_store.get(rev_id).read()
2713
 
        inv = xml4.serializer_v4.read_inventory_from_string(old_inv_xml)
2714
 
        inv.revision_id = rev_id
2715
 
        rev = self.revisions[rev_id]
2716
 
        return inv
2717
 
 
2718
 
    def _load_updated_inventory(self, rev_id):
2719
 
        inv_xml = self.inv_weave.get_text(rev_id)
2720
 
        inv = xml5.serializer_v5.read_inventory_from_string(inv_xml, rev_id)
2721
 
        return inv
2722
 
 
2723
 
    def _convert_one_rev(self, rev_id):
2724
 
        """Convert revision and all referenced objects to new format."""
2725
 
        rev = self.revisions[rev_id]
2726
 
        inv = self._load_old_inventory(rev_id)
2727
 
        present_parents = [p for p in rev.parent_ids
2728
 
                           if p not in self.absent_revisions]
2729
 
        self._convert_revision_contents(rev, inv, present_parents)
2730
 
        self._store_new_inv(rev, inv, present_parents)
2731
 
        self.converted_revs.add(rev_id)
2732
 
 
2733
 
    def _store_new_inv(self, rev, inv, present_parents):
2734
 
        new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
2735
 
        new_inv_sha1 = sha_string(new_inv_xml)
2736
 
        self.inv_weave.add_lines(rev.revision_id,
2737
 
                                 present_parents,
2738
 
                                 new_inv_xml.splitlines(True))
2739
 
        rev.inventory_sha1 = new_inv_sha1
2740
 
 
2741
 
    def _convert_revision_contents(self, rev, inv, present_parents):
2742
 
        """Convert all the files within a revision.
2743
 
 
2744
 
        Also upgrade the inventory to refer to the text revision ids."""
2745
 
        rev_id = rev.revision_id
2746
 
        mutter('converting texts of revision {%s}',
2747
 
               rev_id)
2748
 
        parent_invs = map(self._load_updated_inventory, present_parents)
2749
 
        entries = inv.iter_entries()
2750
 
        entries.next()
2751
 
        for path, ie in entries:
2752
 
            self._convert_file_version(rev, ie, parent_invs)
2753
 
 
2754
 
    def _convert_file_version(self, rev, ie, parent_invs):
2755
 
        """Convert one version of one file.
2756
 
 
2757
 
        The file needs to be added into the weave if it is a merge
2758
 
        of >=2 parents or if it's changed from its parent.
2759
 
        """
2760
 
        file_id = ie.file_id
2761
 
        rev_id = rev.revision_id
2762
 
        w = self.text_weaves.get(file_id)
2763
 
        if w is None:
2764
 
            w = Weave(file_id)
2765
 
            self.text_weaves[file_id] = w
2766
 
        text_changed = False
2767
 
        parent_candiate_entries = ie.parent_candidates(parent_invs)
2768
 
        heads = graph.Graph(self).heads(parent_candiate_entries.keys())
2769
 
        # XXX: Note that this is unordered - and this is tolerable because
2770
 
        # the previous code was also unordered.
2771
 
        previous_entries = dict((head, parent_candiate_entries[head]) for head
2772
 
            in heads)
2773
 
        self.snapshot_ie(previous_entries, ie, w, rev_id)
2774
 
        del ie.text_id
2775
 
 
2776
 
    def get_parent_map(self, revision_ids):
2777
 
        """See graph.StackedParentsProvider.get_parent_map"""
2778
 
        return dict((revision_id, self.revisions[revision_id])
2779
 
                    for revision_id in revision_ids
2780
 
                     if revision_id in self.revisions)
2781
 
 
2782
 
    def snapshot_ie(self, previous_revisions, ie, w, rev_id):
2783
 
        # TODO: convert this logic, which is ~= snapshot to
2784
 
        # a call to:. This needs the path figured out. rather than a work_tree
2785
 
        # a v4 revision_tree can be given, or something that looks enough like
2786
 
        # one to give the file content to the entry if it needs it.
2787
 
        # and we need something that looks like a weave store for snapshot to
2788
 
        # save against.
2789
 
        #ie.snapshot(rev, PATH, previous_revisions, REVISION_TREE, InMemoryWeaveStore(self.text_weaves))
2790
 
        if len(previous_revisions) == 1:
2791
 
            previous_ie = previous_revisions.values()[0]
2792
 
            if ie._unchanged(previous_ie):
2793
 
                ie.revision = previous_ie.revision
2794
 
                return
2795
 
        if ie.has_text():
2796
 
            text = self.branch.repository._text_store.get(ie.text_id)
2797
 
            file_lines = text.readlines()
2798
 
            w.add_lines(rev_id, previous_revisions, file_lines)
2799
 
            self.text_count += 1
2800
 
        else:
2801
 
            w.add_lines(rev_id, previous_revisions, [])
2802
 
        ie.revision = rev_id
2803
 
 
2804
 
    def _make_order(self):
2805
 
        """Return a suitable order for importing revisions.
2806
 
 
2807
 
        The order must be such that an revision is imported after all
2808
 
        its (present) parents.
2809
 
        """
2810
 
        todo = set(self.revisions.keys())
2811
 
        done = self.absent_revisions.copy()
2812
 
        order = []
2813
 
        while todo:
2814
 
            # scan through looking for a revision whose parents
2815
 
            # are all done
2816
 
            for rev_id in sorted(list(todo)):
2817
 
                rev = self.revisions[rev_id]
2818
 
                parent_ids = set(rev.parent_ids)
2819
 
                if parent_ids.issubset(done):
2820
 
                    # can take this one now
2821
 
                    order.append(rev_id)
2822
 
                    todo.remove(rev_id)
2823
 
                    done.add(rev_id)
2824
 
        return order
2825
 
 
2826
 
 
2827
 
class ConvertBzrDir5To6(Converter):
2828
 
    """Converts format 5 bzr dirs to format 6."""
2829
 
 
2830
 
    def convert(self, to_convert, pb):
2831
 
        """See Converter.convert()."""
2832
 
        self.bzrdir = to_convert
2833
 
        self.pb = pb
2834
 
        self.pb.note('starting upgrade from format 5 to 6')
2835
 
        self._convert_to_prefixed()
2836
 
        return BzrDir.open(self.bzrdir.root_transport.base)
2837
 
 
2838
 
    def _convert_to_prefixed(self):
2839
 
        from bzrlib.store import TransportStore
2840
 
        self.bzrdir.transport.delete('branch-format')
2841
 
        for store_name in ["weaves", "revision-store"]:
2842
 
            self.pb.note("adding prefixes to %s" % store_name)
2843
 
            store_transport = self.bzrdir.transport.clone(store_name)
2844
 
            store = TransportStore(store_transport, prefixed=True)
2845
 
            for urlfilename in store_transport.list_dir('.'):
2846
 
                filename = urlutils.unescape(urlfilename)
2847
 
                if (filename.endswith(".weave") or
2848
 
                    filename.endswith(".gz") or
2849
 
                    filename.endswith(".sig")):
2850
 
                    file_id, suffix = os.path.splitext(filename)
2851
 
                else:
2852
 
                    file_id = filename
2853
 
                    suffix = ''
2854
 
                new_name = store._mapper.map((file_id,)) + suffix
2855
 
                # FIXME keep track of the dirs made RBC 20060121
2856
 
                try:
2857
 
                    store_transport.move(filename, new_name)
2858
 
                except errors.NoSuchFile: # catches missing dirs strangely enough
2859
 
                    store_transport.mkdir(osutils.dirname(new_name))
2860
 
                    store_transport.move(filename, new_name)
2861
 
        self.bzrdir.transport.put_bytes(
2862
 
            'branch-format',
2863
 
            BzrDirFormat6().get_format_string(),
2864
 
            mode=self.bzrdir._get_file_mode())
2865
 
 
2866
 
 
2867
 
class ConvertBzrDir6ToMeta(Converter):
2868
 
    """Converts format 6 bzr dirs to metadirs."""
2869
 
 
2870
 
    def convert(self, to_convert, pb):
2871
 
        """See Converter.convert()."""
2872
 
        from bzrlib.repofmt.weaverepo import RepositoryFormat7
2873
 
        from bzrlib.branch import BzrBranchFormat5
2874
 
        self.bzrdir = to_convert
2875
 
        self.pb = pb
2876
 
        self.count = 0
2877
 
        self.total = 20 # the steps we know about
2878
 
        self.garbage_inventories = []
2879
 
        self.dir_mode = self.bzrdir._get_dir_mode()
2880
 
        self.file_mode = self.bzrdir._get_file_mode()
2881
 
 
2882
 
        self.pb.note('starting upgrade from format 6 to metadir')
2883
 
        self.bzrdir.transport.put_bytes(
2884
 
                'branch-format',
2885
 
                "Converting to format 6",
2886
 
                mode=self.file_mode)
2887
 
        # its faster to move specific files around than to open and use the apis...
2888
 
        # first off, nuke ancestry.weave, it was never used.
2889
 
        try:
2890
 
            self.step('Removing ancestry.weave')
2891
 
            self.bzrdir.transport.delete('ancestry.weave')
2892
 
        except errors.NoSuchFile:
2893
 
            pass
2894
 
        # find out whats there
2895
 
        self.step('Finding branch files')
2896
 
        last_revision = self.bzrdir.open_branch().last_revision()
2897
 
        bzrcontents = self.bzrdir.transport.list_dir('.')
2898
 
        for name in bzrcontents:
2899
 
            if name.startswith('basis-inventory.'):
2900
 
                self.garbage_inventories.append(name)
2901
 
        # create new directories for repository, working tree and branch
2902
 
        repository_names = [('inventory.weave', True),
2903
 
                            ('revision-store', True),
2904
 
                            ('weaves', True)]
2905
 
        self.step('Upgrading repository  ')
2906
 
        self.bzrdir.transport.mkdir('repository', mode=self.dir_mode)
2907
 
        self.make_lock('repository')
2908
 
        # we hard code the formats here because we are converting into
2909
 
        # the meta format. The meta format upgrader can take this to a
2910
 
        # future format within each component.
2911
 
        self.put_format('repository', RepositoryFormat7())
2912
 
        for entry in repository_names:
2913
 
            self.move_entry('repository', entry)
2914
 
 
2915
 
        self.step('Upgrading branch      ')
2916
 
        self.bzrdir.transport.mkdir('branch', mode=self.dir_mode)
2917
 
        self.make_lock('branch')
2918
 
        self.put_format('branch', BzrBranchFormat5())
2919
 
        branch_files = [('revision-history', True),
2920
 
                        ('branch-name', True),
2921
 
                        ('parent', False)]
2922
 
        for entry in branch_files:
2923
 
            self.move_entry('branch', entry)
2924
 
 
2925
 
        checkout_files = [('pending-merges', True),
2926
 
                          ('inventory', True),
2927
 
                          ('stat-cache', False)]
2928
 
        # If a mandatory checkout file is not present, the branch does not have
2929
 
        # a functional checkout. Do not create a checkout in the converted
2930
 
        # branch.
2931
 
        for name, mandatory in checkout_files:
2932
 
            if mandatory and name not in bzrcontents:
2933
 
                has_checkout = False
2934
 
                break
2935
 
        else:
2936
 
            has_checkout = True
2937
 
        if not has_checkout:
2938
 
            self.pb.note('No working tree.')
2939
 
            # If some checkout files are there, we may as well get rid of them.
2940
 
            for name, mandatory in checkout_files:
2941
 
                if name in bzrcontents:
2942
 
                    self.bzrdir.transport.delete(name)
2943
 
        else:
2944
 
            from bzrlib.workingtree import WorkingTreeFormat3
2945
 
            self.step('Upgrading working tree')
2946
 
            self.bzrdir.transport.mkdir('checkout', mode=self.dir_mode)
2947
 
            self.make_lock('checkout')
2948
 
            self.put_format(
2949
 
                'checkout', WorkingTreeFormat3())
2950
 
            self.bzrdir.transport.delete_multi(
2951
 
                self.garbage_inventories, self.pb)
2952
 
            for entry in checkout_files:
2953
 
                self.move_entry('checkout', entry)
2954
 
            if last_revision is not None:
2955
 
                self.bzrdir.transport.put_bytes(
2956
 
                    'checkout/last-revision', last_revision)
2957
 
        self.bzrdir.transport.put_bytes(
2958
 
            'branch-format',
2959
 
            BzrDirMetaFormat1().get_format_string(),
2960
 
            mode=self.file_mode)
2961
 
        return BzrDir.open(self.bzrdir.root_transport.base)
2962
 
 
2963
 
    def make_lock(self, name):
2964
 
        """Make a lock for the new control dir name."""
2965
 
        self.step('Make %s lock' % name)
2966
 
        ld = lockdir.LockDir(self.bzrdir.transport,
2967
 
                             '%s/lock' % name,
2968
 
                             file_modebits=self.file_mode,
2969
 
                             dir_modebits=self.dir_mode)
2970
 
        ld.create()
2971
 
 
2972
 
    def move_entry(self, new_dir, entry):
2973
 
        """Move then entry name into new_dir."""
2974
 
        name = entry[0]
2975
 
        mandatory = entry[1]
2976
 
        self.step('Moving %s' % name)
2977
 
        try:
2978
 
            self.bzrdir.transport.move(name, '%s/%s' % (new_dir, name))
2979
 
        except errors.NoSuchFile:
2980
 
            if mandatory:
2981
 
                raise
2982
 
 
2983
 
    def put_format(self, dirname, format):
2984
 
        self.bzrdir.transport.put_bytes('%s/format' % dirname,
2985
 
            format.get_format_string(),
2986
 
            self.file_mode)
2987
 
 
2988
 
 
2989
 
class ConvertMetaToMeta(Converter):
 
1748
BzrProber.formats.register(BzrDirMetaFormat1.get_format_string(),
 
1749
    BzrDirMetaFormat1)
 
1750
controldir.ControlDirFormat._default_format = BzrDirMetaFormat1()
 
1751
 
 
1752
 
 
1753
class BzrDirMetaFormat1Colo(BzrDirMetaFormat1):
 
1754
    """BzrDirMeta1 format with support for colocated branches."""
 
1755
 
 
1756
    colocated_branches = True
 
1757
 
 
1758
    @classmethod
 
1759
    def get_format_string(cls):
 
1760
        """See BzrDirFormat.get_format_string()."""
 
1761
        return "Bazaar meta directory, format 1 (with colocated branches)\n"
 
1762
 
 
1763
    def get_format_description(self):
 
1764
        """See BzrDirFormat.get_format_description()."""
 
1765
        return "Meta directory format 1 with support for colocated branches"
 
1766
 
 
1767
    def _open(self, transport):
 
1768
        """See BzrDirFormat._open."""
 
1769
        # Create a new format instance because otherwise initialisation of new
 
1770
        # metadirs share the global default format object leading to alias
 
1771
        # problems.
 
1772
        format = BzrDirMetaFormat1Colo()
 
1773
        self._supply_sub_formats_to(format)
 
1774
        return BzrDirMeta1(transport, format)
 
1775
 
 
1776
 
 
1777
BzrProber.formats.register(BzrDirMetaFormat1Colo.get_format_string(),
 
1778
    BzrDirMetaFormat1Colo)
 
1779
 
 
1780
 
 
1781
class ConvertMetaToMeta(controldir.Converter):
2990
1782
    """Converts the components of metadirs."""
2991
1783
 
2992
1784
    def __init__(self, target_format):
2999
1791
    def convert(self, to_convert, pb):
3000
1792
        """See Converter.convert()."""
3001
1793
        self.bzrdir = to_convert
3002
 
        self.pb = pb
 
1794
        self.pb = ui.ui_factory.nested_progress_bar()
3003
1795
        self.count = 0
3004
1796
        self.total = 1
3005
1797
        self.step('checking repository format')
3010
1802
        else:
3011
1803
            if not isinstance(repo._format, self.target_format.repository_format.__class__):
3012
1804
                from bzrlib.repository import CopyConverter
3013
 
                self.pb.note('starting repository conversion')
 
1805
                ui.ui_factory.note(gettext('starting repository conversion'))
3014
1806
                converter = CopyConverter(self.target_format.repository_format)
3015
1807
                converter.convert(repo, pb)
3016
 
        try:
3017
 
            branch = self.bzrdir.open_branch()
3018
 
        except errors.NotBranchError:
3019
 
            pass
3020
 
        else:
 
1808
        for branch in self.bzrdir.list_branches():
3021
1809
            # TODO: conversions of Branch and Tree should be done by
3022
1810
            # InterXFormat lookups/some sort of registry.
3023
1811
            # Avoid circular imports
3024
 
            from bzrlib import branch as _mod_branch
3025
1812
            old = branch._format.__class__
3026
1813
            new = self.target_format.get_branch_format().__class__
3027
1814
            while old != new:
3028
 
                if (old == _mod_branch.BzrBranchFormat5 and
 
1815
                if (old == fullhistorybranch.BzrBranchFormat5 and
3029
1816
                    new in (_mod_branch.BzrBranchFormat6,
3030
1817
                        _mod_branch.BzrBranchFormat7,
3031
1818
                        _mod_branch.BzrBranchFormat8)):
3050
1837
        else:
3051
1838
            # TODO: conversions of Branch and Tree should be done by
3052
1839
            # InterXFormat lookups
3053
 
            if (isinstance(tree, workingtree.WorkingTree3) and
 
1840
            if (isinstance(tree, workingtree_3.WorkingTree3) and
3054
1841
                not isinstance(tree, workingtree_4.DirStateWorkingTree) and
3055
1842
                isinstance(self.target_format.workingtree_format,
3056
1843
                    workingtree_4.DirStateWorkingTreeFormat)):
3065
1852
                isinstance(self.target_format.workingtree_format,
3066
1853
                    workingtree_4.WorkingTreeFormat6)):
3067
1854
                workingtree_4.Converter4or5to6().convert(tree)
 
1855
        self.pb.finished()
3068
1856
        return to_convert
3069
1857
 
3070
1858
 
3071
 
# This is not in remote.py because it's relatively small, and needs to be
3072
 
# registered. Putting it in remote.py creates a circular import problem.
3073
 
# we can make it a lazy object if the control formats is turned into something
3074
 
# like a registry.
3075
 
class RemoteBzrDirFormat(BzrDirMetaFormat1):
3076
 
    """Format representing bzrdirs accessed via a smart server"""
3077
 
 
3078
 
    def __init__(self):
3079
 
        BzrDirMetaFormat1.__init__(self)
3080
 
        self._network_name = None
3081
 
 
3082
 
    def get_format_description(self):
3083
 
        return 'bzr remote bzrdir'
3084
 
 
3085
 
    def get_format_string(self):
3086
 
        raise NotImplementedError(self.get_format_string)
3087
 
 
3088
 
    def network_name(self):
3089
 
        if self._network_name:
3090
 
            return self._network_name
3091
 
        else:
3092
 
            raise AssertionError("No network name set.")
3093
 
 
3094
 
    @classmethod
3095
 
    def probe_transport(klass, transport):
3096
 
        """Return a RemoteBzrDirFormat object if it looks possible."""
3097
 
        try:
3098
 
            medium = transport.get_smart_medium()
3099
 
        except (NotImplementedError, AttributeError,
3100
 
                errors.TransportNotPossible, errors.NoSmartMedium,
3101
 
                errors.SmartProtocolError):
3102
 
            # no smart server, so not a branch for this format type.
3103
 
            raise errors.NotBranchError(path=transport.base)
3104
 
        else:
3105
 
            # Decline to open it if the server doesn't support our required
3106
 
            # version (3) so that the VFS-based transport will do it.
3107
 
            if medium.should_probe():
3108
 
                try:
3109
 
                    server_version = medium.protocol_version()
3110
 
                except errors.SmartProtocolError:
3111
 
                    # Apparently there's no usable smart server there, even though
3112
 
                    # the medium supports the smart protocol.
3113
 
                    raise errors.NotBranchError(path=transport.base)
3114
 
                if server_version != '2':
3115
 
                    raise errors.NotBranchError(path=transport.base)
3116
 
            return klass()
3117
 
 
3118
 
    def initialize_on_transport(self, transport):
3119
 
        try:
3120
 
            # hand off the request to the smart server
3121
 
            client_medium = transport.get_smart_medium()
3122
 
        except errors.NoSmartMedium:
3123
 
            # TODO: lookup the local format from a server hint.
3124
 
            local_dir_format = BzrDirMetaFormat1()
3125
 
            return local_dir_format.initialize_on_transport(transport)
3126
 
        client = _SmartClient(client_medium)
3127
 
        path = client.remote_path_from_transport(transport)
3128
 
        try:
3129
 
            response = client.call('BzrDirFormat.initialize', path)
3130
 
        except errors.ErrorFromSmartServer, err:
3131
 
            remote._translate_error(err, path=path)
3132
 
        if response[0] != 'ok':
3133
 
            raise errors.SmartProtocolError('unexpected response code %s' % (response,))
3134
 
        format = RemoteBzrDirFormat()
3135
 
        self._supply_sub_formats_to(format)
3136
 
        return remote.RemoteBzrDir(transport, format)
3137
 
 
3138
 
    def parse_NoneTrueFalse(self, arg):
3139
 
        if not arg:
3140
 
            return None
3141
 
        if arg == 'False':
3142
 
            return False
3143
 
        if arg == 'True':
3144
 
            return True
3145
 
        raise AssertionError("invalid arg %r" % arg)
3146
 
 
3147
 
    def _serialize_NoneTrueFalse(self, arg):
3148
 
        if arg is False:
3149
 
            return 'False'
3150
 
        if arg:
3151
 
            return 'True'
3152
 
        return ''
3153
 
 
3154
 
    def _serialize_NoneString(self, arg):
3155
 
        return arg or ''
3156
 
 
3157
 
    def initialize_on_transport_ex(self, transport, use_existing_dir=False,
3158
 
        create_prefix=False, force_new_repo=False, stacked_on=None,
3159
 
        stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
3160
 
        shared_repo=False):
3161
 
        try:
3162
 
            # hand off the request to the smart server
3163
 
            client_medium = transport.get_smart_medium()
3164
 
        except errors.NoSmartMedium:
3165
 
            do_vfs = True
3166
 
        else:
3167
 
            # Decline to open it if the server doesn't support our required
3168
 
            # version (3) so that the VFS-based transport will do it.
3169
 
            if client_medium.should_probe():
3170
 
                try:
3171
 
                    server_version = client_medium.protocol_version()
3172
 
                    if server_version != '2':
3173
 
                        do_vfs = True
3174
 
                    else:
3175
 
                        do_vfs = False
3176
 
                except errors.SmartProtocolError:
3177
 
                    # Apparently there's no usable smart server there, even though
3178
 
                    # the medium supports the smart protocol.
3179
 
                    do_vfs = True
3180
 
            else:
3181
 
                do_vfs = False
3182
 
        if not do_vfs:
3183
 
            client = _SmartClient(client_medium)
3184
 
            path = client.remote_path_from_transport(transport)
3185
 
            if client_medium._is_remote_before((1, 16)):
3186
 
                do_vfs = True
3187
 
        if do_vfs:
3188
 
            # TODO: lookup the local format from a server hint.
3189
 
            local_dir_format = BzrDirMetaFormat1()
3190
 
            self._supply_sub_formats_to(local_dir_format)
3191
 
            return local_dir_format.initialize_on_transport_ex(transport,
3192
 
                use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3193
 
                force_new_repo=force_new_repo, stacked_on=stacked_on,
3194
 
                stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3195
 
                make_working_trees=make_working_trees, shared_repo=shared_repo,
3196
 
                vfs_only=True)
3197
 
        return self._initialize_on_transport_ex_rpc(client, path, transport,
3198
 
            use_existing_dir, create_prefix, force_new_repo, stacked_on,
3199
 
            stack_on_pwd, repo_format_name, make_working_trees, shared_repo)
3200
 
 
3201
 
    def _initialize_on_transport_ex_rpc(self, client, path, transport,
3202
 
        use_existing_dir, create_prefix, force_new_repo, stacked_on,
3203
 
        stack_on_pwd, repo_format_name, make_working_trees, shared_repo):
3204
 
        args = []
3205
 
        args.append(self._serialize_NoneTrueFalse(use_existing_dir))
3206
 
        args.append(self._serialize_NoneTrueFalse(create_prefix))
3207
 
        args.append(self._serialize_NoneTrueFalse(force_new_repo))
3208
 
        args.append(self._serialize_NoneString(stacked_on))
3209
 
        # stack_on_pwd is often/usually our transport
3210
 
        if stack_on_pwd:
3211
 
            try:
3212
 
                stack_on_pwd = transport.relpath(stack_on_pwd)
3213
 
                if not stack_on_pwd:
3214
 
                    stack_on_pwd = '.'
3215
 
            except errors.PathNotChild:
3216
 
                pass
3217
 
        args.append(self._serialize_NoneString(stack_on_pwd))
3218
 
        args.append(self._serialize_NoneString(repo_format_name))
3219
 
        args.append(self._serialize_NoneTrueFalse(make_working_trees))
3220
 
        args.append(self._serialize_NoneTrueFalse(shared_repo))
3221
 
        if self._network_name is None:
3222
 
            self._network_name = \
3223
 
            BzrDirFormat.get_default_format().network_name()
3224
 
        try:
3225
 
            response = client.call('BzrDirFormat.initialize_ex_1.16',
3226
 
                self.network_name(), path, *args)
3227
 
        except errors.UnknownSmartMethod:
3228
 
            client._medium._remember_remote_is_before((1,16))
3229
 
            local_dir_format = BzrDirMetaFormat1()
3230
 
            self._supply_sub_formats_to(local_dir_format)
3231
 
            return local_dir_format.initialize_on_transport_ex(transport,
3232
 
                use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3233
 
                force_new_repo=force_new_repo, stacked_on=stacked_on,
3234
 
                stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3235
 
                make_working_trees=make_working_trees, shared_repo=shared_repo,
3236
 
                vfs_only=True)
3237
 
        except errors.ErrorFromSmartServer, err:
3238
 
            remote._translate_error(err, path=path)
3239
 
        repo_path = response[0]
3240
 
        bzrdir_name = response[6]
3241
 
        require_stacking = response[7]
3242
 
        require_stacking = self.parse_NoneTrueFalse(require_stacking)
3243
 
        format = RemoteBzrDirFormat()
3244
 
        format._network_name = bzrdir_name
3245
 
        self._supply_sub_formats_to(format)
3246
 
        bzrdir = remote.RemoteBzrDir(transport, format, _client=client)
3247
 
        if repo_path:
3248
 
            repo_format = remote.response_tuple_to_repo_format(response[1:])
3249
 
            if repo_path == '.':
3250
 
                repo_path = ''
3251
 
            if repo_path:
3252
 
                repo_bzrdir_format = RemoteBzrDirFormat()
3253
 
                repo_bzrdir_format._network_name = response[5]
3254
 
                repo_bzr = remote.RemoteBzrDir(transport.clone(repo_path),
3255
 
                    repo_bzrdir_format)
3256
 
            else:
3257
 
                repo_bzr = bzrdir
3258
 
            final_stack = response[8] or None
3259
 
            final_stack_pwd = response[9] or None
3260
 
            if final_stack_pwd:
3261
 
                final_stack_pwd = urlutils.join(
3262
 
                    transport.base, final_stack_pwd)
3263
 
            remote_repo = remote.RemoteRepository(repo_bzr, repo_format)
3264
 
            if len(response) > 10:
3265
 
                # Updated server verb that locks remotely.
3266
 
                repo_lock_token = response[10] or None
3267
 
                remote_repo.lock_write(repo_lock_token, _skip_rpc=True)
3268
 
                if repo_lock_token:
3269
 
                    remote_repo.dont_leave_lock_in_place()
3270
 
            else:
3271
 
                remote_repo.lock_write()
3272
 
            policy = UseExistingRepository(remote_repo, final_stack,
3273
 
                final_stack_pwd, require_stacking)
3274
 
            policy.acquire_repository()
3275
 
        else:
3276
 
            remote_repo = None
3277
 
            policy = None
3278
 
        bzrdir._format.set_branch_format(self.get_branch_format())
3279
 
        if require_stacking:
3280
 
            # The repo has already been created, but we need to make sure that
3281
 
            # we'll make a stackable branch.
3282
 
            bzrdir._format.require_stacking(_skip_repo=True)
3283
 
        return remote_repo, bzrdir, require_stacking, policy
3284
 
 
3285
 
    def _open(self, transport):
3286
 
        return remote.RemoteBzrDir(transport, self)
3287
 
 
3288
 
    def __eq__(self, other):
3289
 
        if not isinstance(other, RemoteBzrDirFormat):
3290
 
            return False
3291
 
        return self.get_format_description() == other.get_format_description()
3292
 
 
3293
 
    def __return_repository_format(self):
3294
 
        # Always return a RemoteRepositoryFormat object, but if a specific bzr
3295
 
        # repository format has been asked for, tell the RemoteRepositoryFormat
3296
 
        # that it should use that for init() etc.
3297
 
        result = remote.RemoteRepositoryFormat()
3298
 
        custom_format = getattr(self, '_repository_format', None)
3299
 
        if custom_format:
3300
 
            if isinstance(custom_format, remote.RemoteRepositoryFormat):
3301
 
                return custom_format
3302
 
            else:
3303
 
                # We will use the custom format to create repositories over the
3304
 
                # wire; expose its details like rich_root_data for code to
3305
 
                # query
3306
 
                result._custom_format = custom_format
3307
 
        return result
3308
 
 
3309
 
    def get_branch_format(self):
3310
 
        result = BzrDirMetaFormat1.get_branch_format(self)
3311
 
        if not isinstance(result, remote.RemoteBranchFormat):
3312
 
            new_result = remote.RemoteBranchFormat()
3313
 
            new_result._custom_format = result
3314
 
            # cache the result
3315
 
            self.set_branch_format(new_result)
3316
 
            result = new_result
3317
 
        return result
3318
 
 
3319
 
    repository_format = property(__return_repository_format,
3320
 
        BzrDirMetaFormat1._set_repository_format) #.im_func)
3321
 
 
3322
 
 
3323
 
BzrDirFormat.register_control_server_format(RemoteBzrDirFormat)
3324
 
 
3325
 
 
3326
 
class BzrDirFormatInfo(object):
3327
 
 
3328
 
    def __init__(self, native, deprecated, hidden, experimental):
3329
 
        self.deprecated = deprecated
3330
 
        self.native = native
3331
 
        self.hidden = hidden
3332
 
        self.experimental = experimental
3333
 
 
3334
 
 
3335
 
class BzrDirFormatRegistry(registry.Registry):
3336
 
    """Registry of user-selectable BzrDir subformats.
3337
 
 
3338
 
    Differs from BzrDirFormat._control_formats in that it provides sub-formats,
3339
 
    e.g. BzrDirMeta1 with weave repository.  Also, it's more user-oriented.
3340
 
    """
3341
 
 
3342
 
    def __init__(self):
3343
 
        """Create a BzrDirFormatRegistry."""
3344
 
        self._aliases = set()
3345
 
        self._registration_order = list()
3346
 
        super(BzrDirFormatRegistry, self).__init__()
3347
 
 
3348
 
    def aliases(self):
3349
 
        """Return a set of the format names which are aliases."""
3350
 
        return frozenset(self._aliases)
3351
 
 
3352
 
    def register_metadir(self, key,
3353
 
             repository_format, help, native=True, deprecated=False,
3354
 
             branch_format=None,
3355
 
             tree_format=None,
3356
 
             hidden=False,
3357
 
             experimental=False,
3358
 
             alias=False):
3359
 
        """Register a metadir subformat.
3360
 
 
3361
 
        These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
3362
 
        by the Repository/Branch/WorkingTreeformats.
3363
 
 
3364
 
        :param repository_format: The fully-qualified repository format class
3365
 
            name as a string.
3366
 
        :param branch_format: Fully-qualified branch format class name as
3367
 
            a string.
3368
 
        :param tree_format: Fully-qualified tree format class name as
3369
 
            a string.
3370
 
        """
3371
 
        # This should be expanded to support setting WorkingTree and Branch
3372
 
        # formats, once BzrDirMetaFormat1 supports that.
3373
 
        def _load(full_name):
3374
 
            mod_name, factory_name = full_name.rsplit('.', 1)
3375
 
            try:
3376
 
                mod = __import__(mod_name, globals(), locals(),
3377
 
                        [factory_name])
3378
 
            except ImportError, e:
3379
 
                raise ImportError('failed to load %s: %s' % (full_name, e))
3380
 
            try:
3381
 
                factory = getattr(mod, factory_name)
3382
 
            except AttributeError:
3383
 
                raise AttributeError('no factory %s in module %r'
3384
 
                    % (full_name, mod))
3385
 
            return factory()
3386
 
 
3387
 
        def helper():
3388
 
            bd = BzrDirMetaFormat1()
3389
 
            if branch_format is not None:
3390
 
                bd.set_branch_format(_load(branch_format))
3391
 
            if tree_format is not None:
3392
 
                bd.workingtree_format = _load(tree_format)
3393
 
            if repository_format is not None:
3394
 
                bd.repository_format = _load(repository_format)
3395
 
            return bd
3396
 
        self.register(key, helper, help, native, deprecated, hidden,
3397
 
            experimental, alias)
3398
 
 
3399
 
    def register(self, key, factory, help, native=True, deprecated=False,
3400
 
                 hidden=False, experimental=False, alias=False):
3401
 
        """Register a BzrDirFormat factory.
3402
 
 
3403
 
        The factory must be a callable that takes one parameter: the key.
3404
 
        It must produce an instance of the BzrDirFormat when called.
3405
 
 
3406
 
        This function mainly exists to prevent the info object from being
3407
 
        supplied directly.
3408
 
        """
3409
 
        registry.Registry.register(self, key, factory, help,
3410
 
            BzrDirFormatInfo(native, deprecated, hidden, experimental))
3411
 
        if alias:
3412
 
            self._aliases.add(key)
3413
 
        self._registration_order.append(key)
3414
 
 
3415
 
    def register_lazy(self, key, module_name, member_name, help, native=True,
3416
 
        deprecated=False, hidden=False, experimental=False, alias=False):
3417
 
        registry.Registry.register_lazy(self, key, module_name, member_name,
3418
 
            help, BzrDirFormatInfo(native, deprecated, hidden, experimental))
3419
 
        if alias:
3420
 
            self._aliases.add(key)
3421
 
        self._registration_order.append(key)
3422
 
 
3423
 
    def set_default(self, key):
3424
 
        """Set the 'default' key to be a clone of the supplied key.
3425
 
 
3426
 
        This method must be called once and only once.
3427
 
        """
3428
 
        registry.Registry.register(self, 'default', self.get(key),
3429
 
            self.get_help(key), info=self.get_info(key))
3430
 
        self._aliases.add('default')
3431
 
 
3432
 
    def set_default_repository(self, key):
3433
 
        """Set the FormatRegistry default and Repository default.
3434
 
 
3435
 
        This is a transitional method while Repository.set_default_format
3436
 
        is deprecated.
3437
 
        """
3438
 
        if 'default' in self:
3439
 
            self.remove('default')
3440
 
        self.set_default(key)
3441
 
        format = self.get('default')()
3442
 
 
3443
 
    def make_bzrdir(self, key):
3444
 
        return self.get(key)()
3445
 
 
3446
 
    def help_topic(self, topic):
3447
 
        output = ""
3448
 
        default_realkey = None
3449
 
        default_help = self.get_help('default')
3450
 
        help_pairs = []
3451
 
        for key in self._registration_order:
3452
 
            if key == 'default':
3453
 
                continue
3454
 
            help = self.get_help(key)
3455
 
            if help == default_help:
3456
 
                default_realkey = key
3457
 
            else:
3458
 
                help_pairs.append((key, help))
3459
 
 
3460
 
        def wrapped(key, help, info):
3461
 
            if info.native:
3462
 
                help = '(native) ' + help
3463
 
            return ':%s:\n%s\n\n' % (key,
3464
 
                textwrap.fill(help, initial_indent='    ',
3465
 
                    subsequent_indent='    ',
3466
 
                    break_long_words=False))
3467
 
        if default_realkey is not None:
3468
 
            output += wrapped(default_realkey, '(default) %s' % default_help,
3469
 
                              self.get_info('default'))
3470
 
        deprecated_pairs = []
3471
 
        experimental_pairs = []
3472
 
        for key, help in help_pairs:
3473
 
            info = self.get_info(key)
3474
 
            if info.hidden:
3475
 
                continue
3476
 
            elif info.deprecated:
3477
 
                deprecated_pairs.append((key, help))
3478
 
            elif info.experimental:
3479
 
                experimental_pairs.append((key, help))
3480
 
            else:
3481
 
                output += wrapped(key, help, info)
3482
 
        output += "\nSee ``bzr help formats`` for more about storage formats."
3483
 
        other_output = ""
3484
 
        if len(experimental_pairs) > 0:
3485
 
            other_output += "Experimental formats are shown below.\n\n"
3486
 
            for key, help in experimental_pairs:
3487
 
                info = self.get_info(key)
3488
 
                other_output += wrapped(key, help, info)
3489
 
        else:
3490
 
            other_output += \
3491
 
                "No experimental formats are available.\n\n"
3492
 
        if len(deprecated_pairs) > 0:
3493
 
            other_output += "\nDeprecated formats are shown below.\n\n"
3494
 
            for key, help in deprecated_pairs:
3495
 
                info = self.get_info(key)
3496
 
                other_output += wrapped(key, help, info)
3497
 
        else:
3498
 
            other_output += \
3499
 
                "\nNo deprecated formats are available.\n\n"
3500
 
        other_output += \
3501
 
            "\nSee ``bzr help formats`` for more about storage formats."
3502
 
 
3503
 
        if topic == 'other-formats':
3504
 
            return other_output
3505
 
        else:
3506
 
            return output
 
1859
class ConvertMetaToColo(controldir.Converter):
 
1860
    """Add colocated branch support."""
 
1861
 
 
1862
    def __init__(self, target_format):
 
1863
        """Create a converter.that upgrades a metadir to the colo format.
 
1864
 
 
1865
        :param target_format: The final metadir format that is desired.
 
1866
        """
 
1867
        self.target_format = target_format
 
1868
 
 
1869
    def convert(self, to_convert, pb):
 
1870
        """See Converter.convert()."""
 
1871
        to_convert.transport.put_bytes('branch-format',
 
1872
            self.target_format.as_string())
 
1873
        return BzrDir.open_from_transport(to_convert.root_transport)
 
1874
 
 
1875
 
 
1876
class ConvertMetaToColo(controldir.Converter):
 
1877
    """Convert a 'development-colo' bzrdir to a '2a' bzrdir."""
 
1878
 
 
1879
    def __init__(self, target_format):
 
1880
        """Create a converter that converts a 'development-colo' metadir
 
1881
        to a '2a' metadir.
 
1882
 
 
1883
        :param target_format: The final metadir format that is desired.
 
1884
        """
 
1885
        self.target_format = target_format
 
1886
 
 
1887
    def convert(self, to_convert, pb):
 
1888
        """See Converter.convert()."""
 
1889
        to_convert.transport.put_bytes('branch-format',
 
1890
            self.target_format.as_string())
 
1891
        return BzrDir.open_from_transport(to_convert.root_transport)
 
1892
 
 
1893
 
 
1894
controldir.ControlDirFormat.register_server_prober(RemoteBzrProber)
3507
1895
 
3508
1896
 
3509
1897
class RepositoryAcquisitionPolicy(object):
3538
1926
            try:
3539
1927
                stack_on = urlutils.rebase_url(self._stack_on,
3540
1928
                    self._stack_on_pwd,
3541
 
                    branch.bzrdir.root_transport.base)
 
1929
                    branch.user_url)
3542
1930
            except errors.InvalidRebaseURLs:
3543
1931
                stack_on = self._get_full_stack_on()
3544
1932
        try:
3585
1973
        else:
3586
1974
            self._require_stacking = True
3587
1975
 
3588
 
    def acquire_repository(self, make_working_trees=None, shared=False):
 
1976
    def acquire_repository(self, make_working_trees=None, shared=False,
 
1977
            possible_transports=None):
3589
1978
        """Acquire a repository for this bzrdir.
3590
1979
 
3591
1980
        Implementations may create a new repository or use a pre-exising
3592
1981
        repository.
 
1982
 
3593
1983
        :param make_working_trees: If creating a repository, set
3594
1984
            make_working_trees to this value (if non-None)
3595
1985
        :param shared: If creating a repository, make it shared if True
3596
1986
        :return: A repository, is_new_flag (True if the repository was
3597
1987
            created).
3598
1988
        """
3599
 
        raise NotImplemented(RepositoryAcquisitionPolicy.acquire_repository)
 
1989
        raise NotImplementedError(RepositoryAcquisitionPolicy.acquire_repository)
3600
1990
 
3601
1991
 
3602
1992
class CreateRepository(RepositoryAcquisitionPolicy):
3604
1994
 
3605
1995
    def __init__(self, bzrdir, stack_on=None, stack_on_pwd=None,
3606
1996
                 require_stacking=False):
3607
 
        """
3608
 
        Constructor.
 
1997
        """Constructor.
 
1998
 
3609
1999
        :param bzrdir: The bzrdir to create the repository on.
3610
2000
        :param stack_on: A location to stack on
3611
2001
        :param stack_on_pwd: If stack_on is relative, the location it is
3615
2005
                                             require_stacking)
3616
2006
        self._bzrdir = bzrdir
3617
2007
 
3618
 
    def acquire_repository(self, make_working_trees=None, shared=False):
 
2008
    def acquire_repository(self, make_working_trees=None, shared=False,
 
2009
            possible_transports=None):
3619
2010
        """Implementation of RepositoryAcquisitionPolicy.acquire_repository
3620
2011
 
3621
2012
        Creates the desired repository in the bzrdir we already have.
3622
2013
        """
 
2014
        if possible_transports is None:
 
2015
            possible_transports = []
 
2016
        else:
 
2017
            possible_transports = list(possible_transports)
 
2018
        possible_transports.append(self._bzrdir.root_transport)
3623
2019
        stack_on = self._get_full_stack_on()
3624
2020
        if stack_on:
3625
2021
            format = self._bzrdir._format
3626
2022
            format.require_stacking(stack_on=stack_on,
3627
 
                                    possible_transports=[self._bzrdir.root_transport])
 
2023
                                    possible_transports=possible_transports)
3628
2024
            if not self._require_stacking:
3629
2025
                # We have picked up automatic stacking somewhere.
3630
 
                note('Using default stacking branch %s at %s', self._stack_on,
3631
 
                    self._stack_on_pwd)
 
2026
                note(gettext('Using default stacking branch {0} at {1}').format(
 
2027
                    self._stack_on, self._stack_on_pwd))
3632
2028
        repository = self._bzrdir.create_repository(shared=shared)
3633
2029
        self._add_fallback(repository,
3634
 
                           possible_transports=[self._bzrdir.transport])
 
2030
                           possible_transports=possible_transports)
3635
2031
        if make_working_trees is not None:
3636
2032
            repository.set_make_working_trees(make_working_trees)
3637
2033
        return repository, True
3653
2049
                                             require_stacking)
3654
2050
        self._repository = repository
3655
2051
 
3656
 
    def acquire_repository(self, make_working_trees=None, shared=False):
 
2052
    def acquire_repository(self, make_working_trees=None, shared=False,
 
2053
            possible_transports=None):
3657
2054
        """Implementation of RepositoryAcquisitionPolicy.acquire_repository
3658
2055
 
3659
2056
        Returns an existing repository to use.
3660
2057
        """
 
2058
        if possible_transports is None:
 
2059
            possible_transports = []
 
2060
        else:
 
2061
            possible_transports = list(possible_transports)
 
2062
        possible_transports.append(self._repository.bzrdir.transport)
3661
2063
        self._add_fallback(self._repository,
3662
 
                       possible_transports=[self._repository.bzrdir.transport])
 
2064
                       possible_transports=possible_transports)
3663
2065
        return self._repository, False
3664
2066
 
3665
2067
 
3666
 
# Please register new formats after old formats so that formats
3667
 
# appear in chronological order and format descriptions can build
3668
 
# on previous ones.
3669
 
format_registry = BzrDirFormatRegistry()
3670
 
# The pre-0.8 formats have their repository format network name registered in
3671
 
# repository.py. MetaDir formats have their repository format network name
3672
 
# inferred from their disk format string.
3673
 
format_registry.register('weave', BzrDirFormat6,
3674
 
    'Pre-0.8 format.  Slower than knit and does not'
3675
 
    ' support checkouts or shared repositories.',
3676
 
    deprecated=True)
3677
 
format_registry.register_metadir('metaweave',
3678
 
    'bzrlib.repofmt.weaverepo.RepositoryFormat7',
3679
 
    'Transitional format in 0.8.  Slower than knit.',
3680
 
    branch_format='bzrlib.branch.BzrBranchFormat5',
3681
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3682
 
    deprecated=True)
3683
 
format_registry.register_metadir('knit',
 
2068
def register_metadir(registry, key,
 
2069
         repository_format, help, native=True, deprecated=False,
 
2070
         branch_format=None,
 
2071
         tree_format=None,
 
2072
         hidden=False,
 
2073
         experimental=False,
 
2074
         alias=False, bzrdir_format=None):
 
2075
    """Register a metadir subformat.
 
2076
 
 
2077
    These all use a meta bzrdir, but can be parameterized by the
 
2078
    Repository/Branch/WorkingTreeformats.
 
2079
 
 
2080
    :param repository_format: The fully-qualified repository format class
 
2081
        name as a string.
 
2082
    :param branch_format: Fully-qualified branch format class name as
 
2083
        a string.
 
2084
    :param tree_format: Fully-qualified tree format class name as
 
2085
        a string.
 
2086
    """
 
2087
    if bzrdir_format is None:
 
2088
        bzrdir_format = BzrDirMetaFormat1
 
2089
    # This should be expanded to support setting WorkingTree and Branch
 
2090
    # formats, once the API supports that.
 
2091
    def _load(full_name):
 
2092
        mod_name, factory_name = full_name.rsplit('.', 1)
 
2093
        try:
 
2094
            factory = pyutils.get_named_object(mod_name, factory_name)
 
2095
        except ImportError, e:
 
2096
            raise ImportError('failed to load %s: %s' % (full_name, e))
 
2097
        except AttributeError:
 
2098
            raise AttributeError('no factory %s in module %r'
 
2099
                % (full_name, sys.modules[mod_name]))
 
2100
        return factory()
 
2101
 
 
2102
    def helper():
 
2103
        bd = bzrdir_format()
 
2104
        if branch_format is not None:
 
2105
            bd.set_branch_format(_load(branch_format))
 
2106
        if tree_format is not None:
 
2107
            bd.workingtree_format = _load(tree_format)
 
2108
        if repository_format is not None:
 
2109
            bd.repository_format = _load(repository_format)
 
2110
        return bd
 
2111
    registry.register(key, helper, help, native, deprecated, hidden,
 
2112
        experimental, alias)
 
2113
 
 
2114
register_metadir(controldir.format_registry, 'knit',
3684
2115
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3685
2116
    'Format using knits.  Recommended for interoperation with bzr <= 0.14.',
3686
 
    branch_format='bzrlib.branch.BzrBranchFormat5',
3687
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3688
 
    deprecated=True)
3689
 
format_registry.register_metadir('dirstate',
3690
 
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3691
 
    help='New in 0.15: Fast local operations. Compatible with bzr 0.8 and '
3692
 
        'above when accessed over the network.',
3693
 
    branch_format='bzrlib.branch.BzrBranchFormat5',
3694
 
    # this uses bzrlib.workingtree.WorkingTreeFormat4 because importing
3695
 
    # directly from workingtree_4 triggers a circular import.
3696
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3697
 
    deprecated=True)
3698
 
format_registry.register_metadir('dirstate-tags',
3699
 
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3700
 
    help='New in 0.15: Fast local operations and improved scaling for '
3701
 
        'network operations. Additionally adds support for tags.'
3702
 
        ' Incompatible with bzr < 0.15.',
 
2117
    branch_format='bzrlib.branchfmt.fullhistory.BzrBranchFormat5',
 
2118
    tree_format='bzrlib.workingtree_3.WorkingTreeFormat3',
 
2119
    hidden=True,
 
2120
    deprecated=True)
 
2121
register_metadir(controldir.format_registry, 'dirstate',
 
2122
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
 
2123
    help='Format using dirstate for working trees. '
 
2124
        'Compatible with bzr 0.8 and '
 
2125
        'above when accessed over the network. Introduced in bzr 0.15.',
 
2126
    branch_format='bzrlib.branchfmt.fullhistory.BzrBranchFormat5',
 
2127
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
2128
    hidden=True,
 
2129
    deprecated=True)
 
2130
register_metadir(controldir.format_registry, 'dirstate-tags',
 
2131
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
 
2132
    help='Variant of dirstate with support for tags. '
 
2133
        'Introduced in bzr 0.15.',
3703
2134
    branch_format='bzrlib.branch.BzrBranchFormat6',
3704
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
2135
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
2136
    hidden=True,
3705
2137
    deprecated=True)
3706
 
format_registry.register_metadir('rich-root',
 
2138
register_metadir(controldir.format_registry, 'rich-root',
3707
2139
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
3708
 
    help='New in 1.0.  Better handling of tree roots.  Incompatible with'
3709
 
        ' bzr < 1.0.',
 
2140
    help='Variant of dirstate with better handling of tree roots. '
 
2141
        'Introduced in bzr 1.0',
3710
2142
    branch_format='bzrlib.branch.BzrBranchFormat6',
3711
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
2143
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
2144
    hidden=True,
3712
2145
    deprecated=True)
3713
 
format_registry.register_metadir('dirstate-with-subtree',
 
2146
register_metadir(controldir.format_registry, 'dirstate-with-subtree',
3714
2147
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
3715
 
    help='New in 0.15: Fast local operations and improved scaling for '
3716
 
        'network operations. Additionally adds support for versioning nested '
3717
 
        'bzr branches. Incompatible with bzr < 0.15.',
3718
 
    branch_format='bzrlib.branch.BzrBranchFormat6',
3719
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3720
 
    experimental=True,
3721
 
    hidden=True,
3722
 
    )
3723
 
format_registry.register_metadir('pack-0.92',
3724
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack1',
3725
 
    help='New in 0.92: Pack-based format with data compatible with '
3726
 
        'dirstate-tags format repositories. Interoperates with '
3727
 
        'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3728
 
        'Previously called knitpack-experimental.  '
3729
 
        'For more information, see '
3730
 
        'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
3731
 
    branch_format='bzrlib.branch.BzrBranchFormat6',
3732
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3733
 
    )
3734
 
format_registry.register_metadir('pack-0.92-subtree',
3735
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack3',
3736
 
    help='New in 0.92: Pack-based format with data compatible with '
3737
 
        'dirstate-with-subtree format repositories. Interoperates with '
3738
 
        'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3739
 
        'Previously called knitpack-experimental.  '
3740
 
        'For more information, see '
3741
 
        'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
3742
 
    branch_format='bzrlib.branch.BzrBranchFormat6',
3743
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3744
 
    hidden=True,
3745
 
    experimental=True,
3746
 
    )
3747
 
format_registry.register_metadir('rich-root-pack',
3748
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
3749
 
    help='New in 1.0: A variant of pack-0.92 that supports rich-root data '
3750
 
         '(needed for bzr-svn and bzr-git).',
3751
 
    branch_format='bzrlib.branch.BzrBranchFormat6',
3752
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3753
 
    )
3754
 
format_registry.register_metadir('1.6',
3755
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5',
 
2148
    help='Variant of dirstate with support for nested trees. '
 
2149
         'Introduced in 0.15.',
 
2150
    branch_format='bzrlib.branch.BzrBranchFormat6',
 
2151
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
2152
    experimental=True,
 
2153
    hidden=True,
 
2154
    )
 
2155
register_metadir(controldir.format_registry, 'pack-0.92',
 
2156
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack1',
 
2157
    help='Pack-based format used in 1.x series. Introduced in 0.92. '
 
2158
        'Interoperates with bzr repositories before 0.92 but cannot be '
 
2159
        'read by bzr < 0.92. '
 
2160
        ,
 
2161
    branch_format='bzrlib.branch.BzrBranchFormat6',
 
2162
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
2163
    deprecated=True,
 
2164
    )
 
2165
register_metadir(controldir.format_registry, 'pack-0.92-subtree',
 
2166
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack3',
 
2167
    help='Pack-based format used in 1.x series, with subtree support. '
 
2168
        'Introduced in 0.92. Interoperates with '
 
2169
        'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
 
2170
        ,
 
2171
    branch_format='bzrlib.branch.BzrBranchFormat6',
 
2172
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
2173
    hidden=True,
 
2174
    deprecated=True,
 
2175
    experimental=True,
 
2176
    )
 
2177
register_metadir(controldir.format_registry, 'rich-root-pack',
 
2178
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack4',
 
2179
    help='A variant of pack-0.92 that supports rich-root data '
 
2180
         '(needed for bzr-svn and bzr-git). Introduced in 1.0.',
 
2181
    branch_format='bzrlib.branch.BzrBranchFormat6',
 
2182
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
2183
    hidden=True,
 
2184
    deprecated=True,
 
2185
    )
 
2186
register_metadir(controldir.format_registry, '1.6',
 
2187
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack5',
3756
2188
    help='A format that allows a branch to indicate that there is another '
3757
2189
         '(stacked) repository that should be used to access data that is '
3758
2190
         'not present locally.',
3759
2191
    branch_format='bzrlib.branch.BzrBranchFormat7',
3760
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
2192
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
2193
    hidden=True,
 
2194
    deprecated=True,
3761
2195
    )
3762
 
format_registry.register_metadir('1.6.1-rich-root',
3763
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5RichRoot',
 
2196
register_metadir(controldir.format_registry, '1.6.1-rich-root',
 
2197
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack5RichRoot',
3764
2198
    help='A variant of 1.6 that supports rich-root data '
3765
2199
         '(needed for bzr-svn and bzr-git).',
3766
2200
    branch_format='bzrlib.branch.BzrBranchFormat7',
3767
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
2201
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
2202
    hidden=True,
 
2203
    deprecated=True,
3768
2204
    )
3769
 
format_registry.register_metadir('1.9',
3770
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
 
2205
register_metadir(controldir.format_registry, '1.9',
 
2206
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6',
3771
2207
    help='A repository format using B+tree indexes. These indexes '
3772
2208
         'are smaller in size, have smarter caching and provide faster '
3773
2209
         'performance for most operations.',
3774
2210
    branch_format='bzrlib.branch.BzrBranchFormat7',
3775
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
2211
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
2212
    hidden=True,
 
2213
    deprecated=True,
3776
2214
    )
3777
 
format_registry.register_metadir('1.9-rich-root',
3778
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
 
2215
register_metadir(controldir.format_registry, '1.9-rich-root',
 
2216
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6RichRoot',
3779
2217
    help='A variant of 1.9 that supports rich-root data '
3780
2218
         '(needed for bzr-svn and bzr-git).',
3781
2219
    branch_format='bzrlib.branch.BzrBranchFormat7',
3782
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
2220
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
2221
    hidden=True,
 
2222
    deprecated=True,
3783
2223
    )
3784
 
format_registry.register_metadir('1.14',
3785
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
 
2224
register_metadir(controldir.format_registry, '1.14',
 
2225
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6',
3786
2226
    help='A working-tree format that supports content filtering.',
3787
2227
    branch_format='bzrlib.branch.BzrBranchFormat7',
3788
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat5',
 
2228
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat5',
 
2229
    hidden=True,
 
2230
    deprecated=True,
3789
2231
    )
3790
 
format_registry.register_metadir('1.14-rich-root',
3791
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
 
2232
register_metadir(controldir.format_registry, '1.14-rich-root',
 
2233
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6RichRoot',
3792
2234
    help='A variant of 1.14 that supports rich-root data '
3793
2235
         '(needed for bzr-svn and bzr-git).',
3794
2236
    branch_format='bzrlib.branch.BzrBranchFormat7',
3795
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat5',
 
2237
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat5',
 
2238
    hidden=True,
 
2239
    deprecated=True,
3796
2240
    )
3797
2241
# The following un-numbered 'development' formats should always just be aliases.
3798
 
format_registry.register_metadir('development-rich-root',
3799
 
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
3800
 
    help='Current development format. Supports rich roots. Can convert data '
3801
 
        'to and from rich-root-pack (and anything compatible with '
3802
 
        'rich-root-pack) format repositories. Repositories and branches in '
3803
 
        'this format can only be read by bzr.dev. Please read '
3804
 
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3805
 
        'before use.',
3806
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3807
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3808
 
    experimental=True,
3809
 
    alias=True,
3810
 
    )
3811
 
format_registry.register_metadir('development-subtree',
3812
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment2Subtree',
 
2242
register_metadir(controldir.format_registry, 'development-subtree',
 
2243
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2aSubtree',
3813
2244
    help='Current development format, subtree variant. Can convert data to and '
3814
2245
        'from pack-0.92-subtree (and anything compatible with '
3815
2246
        'pack-0.92-subtree) format repositories. Repositories and branches in '
3816
2247
        'this format can only be read by bzr.dev. Please read '
3817
 
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
 
2248
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
3818
2249
        'before use.',
3819
2250
    branch_format='bzrlib.branch.BzrBranchFormat7',
3820
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
 
2251
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
3821
2252
    experimental=True,
 
2253
    hidden=True,
3822
2254
    alias=False, # Restore to being an alias when an actual development subtree format is added
3823
2255
                 # This current non-alias status is simply because we did not introduce a
3824
2256
                 # chk based subtree format.
3825
2257
    )
 
2258
register_metadir(controldir.format_registry, 'development5-subtree',
 
2259
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatPackDevelopment2Subtree',
 
2260
    help='Development format, subtree variant. Can convert data to and '
 
2261
        'from pack-0.92-subtree (and anything compatible with '
 
2262
        'pack-0.92-subtree) format repositories. Repositories and branches in '
 
2263
        'this format can only be read by bzr.dev. Please read '
 
2264
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
 
2265
        'before use.',
 
2266
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
2267
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
 
2268
    experimental=True,
 
2269
    hidden=True,
 
2270
    alias=False,
 
2271
    )
 
2272
 
 
2273
register_metadir(controldir.format_registry, 'development-colo',
 
2274
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
 
2275
    help='The 2a format with experimental support for colocated branches.\n',
 
2276
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
2277
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
 
2278
    experimental=True,
 
2279
    bzrdir_format=BzrDirMetaFormat1Colo,
 
2280
    )
 
2281
 
3826
2282
 
3827
2283
# And the development formats above will have aliased one of the following:
3828
 
format_registry.register_metadir('development6-rich-root',
3829
 
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
3830
 
    help='pack-1.9 with 255-way hashed CHK inv, group compress, rich roots '
3831
 
        'Please read '
3832
 
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3833
 
        'before use.',
3834
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3835
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3836
 
    hidden=True,
3837
 
    experimental=True,
3838
 
    )
3839
 
 
3840
 
format_registry.register_metadir('development7-rich-root',
3841
 
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK2',
3842
 
    help='pack-1.9 with 255-way hashed CHK inv, bencode revision, group compress, '
3843
 
        'rich roots. Please read '
3844
 
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3845
 
        'before use.',
3846
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3847
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3848
 
    hidden=True,
3849
 
    experimental=True,
3850
 
    )
3851
 
 
3852
 
format_registry.register_metadir('2a',
 
2284
 
 
2285
# Finally, the current format.
 
2286
register_metadir(controldir.format_registry, '2a',
3853
2287
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
3854
 
    help='First format for bzr 2.0 series.\n'
 
2288
    help='Format for the bzr 2.0 series.\n'
3855
2289
        'Uses group-compress storage.\n'
3856
2290
        'Provides rich roots which are a one-way transition.\n',
3857
2291
        # 'storage in packs, 255-way hashed CHK inventory, bencode revision, group compress, '
3858
2292
        # 'rich roots. Supported by bzr 1.16 and later.',
3859
2293
    branch_format='bzrlib.branch.BzrBranchFormat7',
3860
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3861
 
    experimental=True,
 
2294
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
 
2295
    experimental=False,
3862
2296
    )
3863
2297
 
3864
2298
# The following format should be an alias for the rich root equivalent 
3865
2299
# of the default format
3866
 
format_registry.register_metadir('default-rich-root',
 
2300
register_metadir(controldir.format_registry, 'default-rich-root',
3867
2301
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
3868
2302
    branch_format='bzrlib.branch.BzrBranchFormat7',
3869
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
 
2303
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
3870
2304
    alias=True,
 
2305
    hidden=True,
3871
2306
    help='Same as 2a.')
3872
2307
 
3873
2308
# The current format that is made on 'bzr init'.
3874
 
format_registry.set_default('2a')
 
2309
format_name = config.GlobalStack().get('default_format')
 
2310
controldir.format_registry.set_default(format_name)
 
2311
 
 
2312
# XXX 2010-08-20 JRV: There is still a lot of code relying on
 
2313
# bzrlib.bzrdir.format_registry existing. When BzrDir.create/BzrDir.open/etc
 
2314
# get changed to ControlDir.create/ControlDir.open/etc this should be removed.
 
2315
format_registry = controldir.format_registry