~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/bzrdir.py

  • Committer: Vincent Ladeuil
  • Date: 2010-03-10 09:33:04 UTC
  • mto: (5082.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 5083.
  • Revision ID: v.ladeuil+lp@free.fr-20100310093304-4245t4tazd4sxoav
Cleanup test from overly cautious checks.

Show diffs side-by-side

added added

removed removed

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