~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/bzrdir.py

(jelmer) Use the absolute_import feature everywhere in bzrlib,
 and add a source test to make sure it's used everywhere. (Jelmer Vernooij)

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