~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/bzrdir.py

  • Committer: Vincent Ladeuil
  • Date: 2013-08-09 15:09:23 UTC
  • mto: This revision was merged to the branch mainline in revision 6587.
  • Revision ID: v.ladeuil+lp@free.fr-20130809150923-y71dusyorep0hbkt
Fix various typos in docstrings. Rename 'buffer' to 'buf' since it's now a python builtin function.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2006-2011 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
"""BzrDir logic. The BzrDir is the basic control directory used by bzr.
 
18
 
 
19
At format 7 this was split out into Branch, Repository and Checkout control
 
20
directories.
 
21
 
 
22
Note: This module has a lot of ``open`` functions/methods that return
 
23
references to in-memory objects. As a rule, there are no matching ``close``
 
24
methods. To free any associated resources, simply stop referencing the
 
25
objects returned.
 
26
"""
 
27
 
 
28
from __future__ import absolute_import
 
29
 
 
30
import sys
 
31
 
 
32
from bzrlib.lazy_import import lazy_import
 
33
lazy_import(globals(), """
 
34
import bzrlib
 
35
from bzrlib import (
 
36
    branch as _mod_branch,
 
37
    cleanup,
 
38
    errors,
 
39
    fetch,
 
40
    graph,
 
41
    lockable_files,
 
42
    lockdir,
 
43
    osutils,
 
44
    pyutils,
 
45
    remote,
 
46
    repository,
 
47
    revision as _mod_revision,
 
48
    transport as _mod_transport,
 
49
    ui,
 
50
    urlutils,
 
51
    vf_search,
 
52
    win32utils,
 
53
    workingtree_3,
 
54
    workingtree_4,
 
55
    )
 
56
from bzrlib.branchfmt import fullhistory as fullhistorybranch
 
57
from bzrlib.repofmt import knitpack_repo
 
58
from bzrlib.transport import (
 
59
    do_catching_redirections,
 
60
    local,
 
61
    )
 
62
from bzrlib.i18n import gettext
 
63
""")
 
64
 
 
65
from bzrlib.trace import (
 
66
    mutter,
 
67
    note,
 
68
    )
 
69
 
 
70
from bzrlib import (
 
71
    config,
 
72
    controldir,
 
73
    registry,
 
74
    )
 
75
from bzrlib.symbol_versioning import (
 
76
    deprecated_in,
 
77
    deprecated_method,
 
78
    )
 
79
 
 
80
 
 
81
class BzrDir(controldir.ControlDir):
 
82
    """A .bzr control diretory.
 
83
 
 
84
    BzrDir instances let you create or open any of the things that can be
 
85
    found within .bzr - checkouts, branches and repositories.
 
86
 
 
87
    :ivar transport:
 
88
        the transport which this bzr dir is rooted at (i.e. file:///.../.bzr/)
 
89
    :ivar root_transport:
 
90
        a transport connected to the directory this bzr was opened from
 
91
        (i.e. the parent directory holding the .bzr directory).
 
92
 
 
93
    Everything in the bzrdir should have the same file permissions.
 
94
 
 
95
    :cvar hooks: An instance of BzrDirHooks.
 
96
    """
 
97
 
 
98
    def break_lock(self):
 
99
        """Invoke break_lock on the first object in the bzrdir.
 
100
 
 
101
        If there is a tree, the tree is opened and break_lock() called.
 
102
        Otherwise, branch is tried, and finally repository.
 
103
        """
 
104
        # XXX: This seems more like a UI function than something that really
 
105
        # belongs in this class.
 
106
        try:
 
107
            thing_to_unlock = self.open_workingtree()
 
108
        except (errors.NotLocalUrl, errors.NoWorkingTree):
 
109
            try:
 
110
                thing_to_unlock = self.open_branch()
 
111
            except errors.NotBranchError:
 
112
                try:
 
113
                    thing_to_unlock = self.open_repository()
 
114
                except errors.NoRepositoryPresent:
 
115
                    return
 
116
        thing_to_unlock.break_lock()
 
117
 
 
118
    def check_conversion_target(self, target_format):
 
119
        """Check that a bzrdir as a whole can be converted to a new format."""
 
120
        # The only current restriction is that the repository content can be 
 
121
        # fetched compatibly with the target.
 
122
        target_repo_format = target_format.repository_format
 
123
        try:
 
124
            self.open_repository()._format.check_conversion_target(
 
125
                target_repo_format)
 
126
        except errors.NoRepositoryPresent:
 
127
            # No repo, no problem.
 
128
            pass
 
129
 
 
130
    def clone_on_transport(self, transport, revision_id=None,
 
131
        force_new_repo=False, preserve_stacking=False, stacked_on=None,
 
132
        create_prefix=False, use_existing_dir=True, no_tree=False):
 
133
        """Clone this bzrdir and its contents to transport verbatim.
 
134
 
 
135
        :param transport: The transport for the location to produce the clone
 
136
            at.  If the target directory does not exist, it will be created.
 
137
        :param revision_id: The tip revision-id to use for any branch or
 
138
            working tree.  If not None, then the clone operation may tune
 
139
            itself to download less data.
 
140
        :param force_new_repo: Do not use a shared repository for the target,
 
141
                               even if one is available.
 
142
        :param preserve_stacking: When cloning a stacked branch, stack the
 
143
            new branch on top of the other branch's stacked-on branch.
 
144
        :param create_prefix: Create any missing directories leading up to
 
145
            to_transport.
 
146
        :param use_existing_dir: Use an existing directory if one exists.
 
147
        :param no_tree: If set to true prevents creation of a working tree.
 
148
        """
 
149
        # Overview: put together a broad description of what we want to end up
 
150
        # with; then make as few api calls as possible to do it.
 
151
 
 
152
        # We may want to create a repo/branch/tree, if we do so what format
 
153
        # would we want for each:
 
154
        require_stacking = (stacked_on is not None)
 
155
        format = self.cloning_metadir(require_stacking)
 
156
 
 
157
        # Figure out what objects we want:
 
158
        try:
 
159
            local_repo = self.find_repository()
 
160
        except errors.NoRepositoryPresent:
 
161
            local_repo = None
 
162
        try:
 
163
            local_branch = self.open_branch()
 
164
        except errors.NotBranchError:
 
165
            local_branch = None
 
166
        else:
 
167
            # enable fallbacks when branch is not a branch reference
 
168
            if local_branch.repository.has_same_location(local_repo):
 
169
                local_repo = local_branch.repository
 
170
            if preserve_stacking:
 
171
                try:
 
172
                    stacked_on = local_branch.get_stacked_on_url()
 
173
                except (errors.UnstackableBranchFormat,
 
174
                        errors.UnstackableRepositoryFormat,
 
175
                        errors.NotStacked):
 
176
                    pass
 
177
        # Bug: We create a metadir without knowing if it can support stacking,
 
178
        # we should look up the policy needs first, or just use it as a hint,
 
179
        # or something.
 
180
        if local_repo:
 
181
            make_working_trees = local_repo.make_working_trees() and not no_tree
 
182
            want_shared = local_repo.is_shared()
 
183
            repo_format_name = format.repository_format.network_name()
 
184
        else:
 
185
            make_working_trees = False
 
186
            want_shared = False
 
187
            repo_format_name = None
 
188
 
 
189
        result_repo, result, require_stacking, repository_policy = \
 
190
            format.initialize_on_transport_ex(transport,
 
191
            use_existing_dir=use_existing_dir, create_prefix=create_prefix,
 
192
            force_new_repo=force_new_repo, stacked_on=stacked_on,
 
193
            stack_on_pwd=self.root_transport.base,
 
194
            repo_format_name=repo_format_name,
 
195
            make_working_trees=make_working_trees, shared_repo=want_shared)
 
196
        if repo_format_name:
 
197
            try:
 
198
                # If the result repository is in the same place as the
 
199
                # resulting bzr dir, it will have no content, further if the
 
200
                # result is not stacked then we know all content should be
 
201
                # copied, and finally if we are copying up to a specific
 
202
                # revision_id then we can use the pending-ancestry-result which
 
203
                # 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
 
206
                    revision_id is not None):
 
207
                    fetch_spec = vf_search.PendingAncestryResult(
 
208
                        [revision_id], local_repo)
 
209
                    result_repo.fetch(local_repo, fetch_spec=fetch_spec)
 
210
                else:
 
211
                    result_repo.fetch(local_repo, revision_id=revision_id)
 
212
            finally:
 
213
                result_repo.unlock()
 
214
        else:
 
215
            if result_repo is not None:
 
216
                raise AssertionError('result_repo not None(%r)' % result_repo)
 
217
        # 1 if there is a branch present
 
218
        #   make sure its content is available in the target repository
 
219
        #   clone it.
 
220
        if local_branch is not None:
 
221
            result_branch = local_branch.clone(result, revision_id=revision_id,
 
222
                repository_policy=repository_policy)
 
223
        try:
 
224
            # Cheaper to check if the target is not local, than to try making
 
225
            # the tree and fail.
 
226
            result.root_transport.local_abspath('.')
 
227
            if result_repo is None or result_repo.make_working_trees():
 
228
                self.open_workingtree().clone(result, revision_id=revision_id)
 
229
        except (errors.NoWorkingTree, errors.NotLocalUrl):
 
230
            pass
 
231
        return result
 
232
 
 
233
    # TODO: This should be given a Transport, and should chdir up; otherwise
 
234
    # this will open a new connection.
 
235
    def _make_tail(self, url):
 
236
        t = _mod_transport.get_transport(url)
 
237
        t.ensure_base()
 
238
 
 
239
    def determine_repository_policy(self, force_new_repo=False, stack_on=None,
 
240
                                    stack_on_pwd=None, require_stacking=False):
 
241
        """Return an object representing a policy to use.
 
242
 
 
243
        This controls whether a new repository is created, and the format of
 
244
        that repository, or some existing shared repository used instead.
 
245
 
 
246
        If stack_on is supplied, will not seek a containing shared repo.
 
247
 
 
248
        :param force_new_repo: If True, require a new repository to be created.
 
249
        :param stack_on: If supplied, the location to stack on.  If not
 
250
            supplied, a default_stack_on location may be used.
 
251
        :param stack_on_pwd: If stack_on is relative, the location it is
 
252
            relative to.
 
253
        """
 
254
        def repository_policy(found_bzrdir):
 
255
            stack_on = None
 
256
            stack_on_pwd = None
 
257
            config = found_bzrdir.get_config()
 
258
            stop = False
 
259
            stack_on = config.get_default_stack_on()
 
260
            if stack_on is not None:
 
261
                stack_on_pwd = found_bzrdir.user_url
 
262
                stop = True
 
263
            # does it have a repository ?
 
264
            try:
 
265
                repository = found_bzrdir.open_repository()
 
266
            except errors.NoRepositoryPresent:
 
267
                repository = None
 
268
            else:
 
269
                if (found_bzrdir.user_url != self.user_url 
 
270
                    and not repository.is_shared()):
 
271
                    # Don't look higher, can't use a higher shared repo.
 
272
                    repository = None
 
273
                    stop = True
 
274
                else:
 
275
                    stop = True
 
276
            if not stop:
 
277
                return None, False
 
278
            if repository:
 
279
                return UseExistingRepository(repository, stack_on,
 
280
                    stack_on_pwd, require_stacking=require_stacking), True
 
281
            else:
 
282
                return CreateRepository(self, stack_on, stack_on_pwd,
 
283
                    require_stacking=require_stacking), True
 
284
 
 
285
        if not force_new_repo:
 
286
            if stack_on is None:
 
287
                policy = self._find_containing(repository_policy)
 
288
                if policy is not None:
 
289
                    return policy
 
290
            else:
 
291
                try:
 
292
                    return UseExistingRepository(self.open_repository(),
 
293
                        stack_on, stack_on_pwd,
 
294
                        require_stacking=require_stacking)
 
295
                except errors.NoRepositoryPresent:
 
296
                    pass
 
297
        return CreateRepository(self, stack_on, stack_on_pwd,
 
298
                                require_stacking=require_stacking)
 
299
 
 
300
    def _find_or_create_repository(self, force_new_repo):
 
301
        """Create a new repository if needed, returning the repository."""
 
302
        policy = self.determine_repository_policy(force_new_repo)
 
303
        return policy.acquire_repository()[0]
 
304
 
 
305
    def _find_source_repo(self, add_cleanup, source_branch):
 
306
        """Find the source branch and repo for a sprout operation.
 
307
        
 
308
        This is helper intended for use by _sprout.
 
309
 
 
310
        :returns: (source_branch, source_repository).  Either or both may be
 
311
            None.  If not None, they will be read-locked (and their unlock(s)
 
312
            scheduled via the add_cleanup param).
 
313
        """
 
314
        if source_branch is not None:
 
315
            add_cleanup(source_branch.lock_read().unlock)
 
316
            return source_branch, source_branch.repository
 
317
        try:
 
318
            source_branch = self.open_branch()
 
319
            source_repository = source_branch.repository
 
320
        except errors.NotBranchError:
 
321
            source_branch = None
 
322
            try:
 
323
                source_repository = self.open_repository()
 
324
            except errors.NoRepositoryPresent:
 
325
                source_repository = None
 
326
            else:
 
327
                add_cleanup(source_repository.lock_read().unlock)
 
328
        else:
 
329
            add_cleanup(source_branch.lock_read().unlock)
 
330
        return source_branch, source_repository
 
331
 
 
332
    def sprout(self, url, revision_id=None, force_new_repo=False,
 
333
               recurse='down', possible_transports=None,
 
334
               accelerator_tree=None, hardlink=False, stacked=False,
 
335
               source_branch=None, create_tree_if_local=True):
 
336
        """Create a copy of this controldir prepared for use as a new line of
 
337
        development.
 
338
 
 
339
        If url's last component does not exist, it will be created.
 
340
 
 
341
        Attributes related to the identity of the source branch like
 
342
        branch nickname will be cleaned, a working tree is created
 
343
        whether one existed before or not; and a local branch is always
 
344
        created.
 
345
 
 
346
        if revision_id is not None, then the clone operation may tune
 
347
            itself to download less data.
 
348
 
 
349
        :param accelerator_tree: A tree which can be used for retrieving file
 
350
            contents more quickly than the revision tree, i.e. a workingtree.
 
351
            The revision tree will be used for cases where accelerator_tree's
 
352
            content is different.
 
353
        :param hardlink: If true, hard-link files from accelerator_tree,
 
354
            where possible.
 
355
        :param stacked: If true, create a stacked branch referring to the
 
356
            location of this control directory.
 
357
        :param create_tree_if_local: If true, a working-tree will be created
 
358
            when working locally.
 
359
        :return: The created control directory
 
360
        """
 
361
        operation = cleanup.OperationWithCleanups(self._sprout)
 
362
        return operation.run(url, revision_id=revision_id,
 
363
            force_new_repo=force_new_repo, recurse=recurse,
 
364
            possible_transports=possible_transports,
 
365
            accelerator_tree=accelerator_tree, hardlink=hardlink,
 
366
            stacked=stacked, source_branch=source_branch,
 
367
            create_tree_if_local=create_tree_if_local)
 
368
 
 
369
    def _sprout(self, op, url, revision_id=None, force_new_repo=False,
 
370
               recurse='down', possible_transports=None,
 
371
               accelerator_tree=None, hardlink=False, stacked=False,
 
372
               source_branch=None, create_tree_if_local=True):
 
373
        add_cleanup = op.add_cleanup
 
374
        fetch_spec_factory = fetch.FetchSpecFactory()
 
375
        if revision_id is not None:
 
376
            fetch_spec_factory.add_revision_ids([revision_id])
 
377
            fetch_spec_factory.source_branch_stop_revision_id = revision_id
 
378
        if possible_transports is None:
 
379
            possible_transports = []
 
380
        else:
 
381
            possible_transports = list(possible_transports) + [
 
382
                self.root_transport]
 
383
        target_transport = _mod_transport.get_transport(url,
 
384
            possible_transports)
 
385
        target_transport.ensure_base()
 
386
        cloning_format = self.cloning_metadir(stacked)
 
387
        # Create/update the result branch
 
388
        try:
 
389
            result = controldir.ControlDir.open_from_transport(target_transport)
 
390
        except errors.NotBranchError:
 
391
            result = cloning_format.initialize_on_transport(target_transport)
 
392
        source_branch, source_repository = self._find_source_repo(
 
393
            add_cleanup, source_branch)
 
394
        fetch_spec_factory.source_branch = source_branch
 
395
        # if a stacked branch wasn't requested, we don't create one
 
396
        # even if the origin was stacked
 
397
        if stacked and source_branch is not None:
 
398
            stacked_branch_url = self.root_transport.base
 
399
        else:
 
400
            stacked_branch_url = None
 
401
        repository_policy = result.determine_repository_policy(
 
402
            force_new_repo, stacked_branch_url, require_stacking=stacked)
 
403
        result_repo, is_new_repo = repository_policy.acquire_repository(
 
404
            possible_transports=possible_transports)
 
405
        add_cleanup(result_repo.lock_write().unlock)
 
406
        fetch_spec_factory.source_repo = source_repository
 
407
        fetch_spec_factory.target_repo = result_repo
 
408
        if stacked or (len(result_repo._fallback_repositories) != 0):
 
409
            target_repo_kind = fetch.TargetRepoKinds.STACKED
 
410
        elif is_new_repo:
 
411
            target_repo_kind = fetch.TargetRepoKinds.EMPTY
 
412
        else:
 
413
            target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
 
414
        fetch_spec_factory.target_repo_kind = target_repo_kind
 
415
        if source_repository is not None:
 
416
            fetch_spec = fetch_spec_factory.make_fetch_spec()
 
417
            result_repo.fetch(source_repository, fetch_spec=fetch_spec)
 
418
 
 
419
        if source_branch is None:
 
420
            # this is for sprouting a controldir without a branch; is that
 
421
            # actually useful?
 
422
            # Not especially, but it's part of the contract.
 
423
            result_branch = result.create_branch()
 
424
        else:
 
425
            result_branch = source_branch.sprout(result,
 
426
                revision_id=revision_id, repository_policy=repository_policy,
 
427
                repository=result_repo)
 
428
        mutter("created new branch %r" % (result_branch,))
 
429
 
 
430
        # Create/update the result working tree
 
431
        if (create_tree_if_local and not result.has_workingtree() and
 
432
            isinstance(target_transport, local.LocalTransport) and
 
433
            (result_repo is None or result_repo.make_working_trees())):
 
434
            wt = result.create_workingtree(accelerator_tree=accelerator_tree,
 
435
                hardlink=hardlink, from_branch=result_branch)
 
436
            wt.lock_write()
 
437
            try:
 
438
                if wt.path2id('') is None:
 
439
                    try:
 
440
                        wt.set_root_id(self.open_workingtree.get_root_id())
 
441
                    except errors.NoWorkingTree:
 
442
                        pass
 
443
            finally:
 
444
                wt.unlock()
 
445
        else:
 
446
            wt = None
 
447
        if recurse == 'down':
 
448
            basis = None
 
449
            if wt is not None:
 
450
                basis = wt.basis_tree()
 
451
            elif result_branch is not None:
 
452
                basis = result_branch.basis_tree()
 
453
            elif source_branch is not None:
 
454
                basis = source_branch.basis_tree()
 
455
            if basis is not None:
 
456
                add_cleanup(basis.lock_read().unlock)
 
457
                subtrees = basis.iter_references()
 
458
            else:
 
459
                subtrees = []
 
460
            for path, file_id in subtrees:
 
461
                target = urlutils.join(url, urlutils.escape(path))
 
462
                sublocation = source_branch.reference_parent(file_id, path)
 
463
                sublocation.bzrdir.sprout(target,
 
464
                    basis.get_reference_revision(file_id, path),
 
465
                    force_new_repo=force_new_repo, recurse=recurse,
 
466
                    stacked=stacked)
 
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)
 
475
 
 
476
    def backup_bzrdir(self):
 
477
        """Backup this bzr control directory.
 
478
 
 
479
        :return: Tuple with old path name and new path name
 
480
        """
 
481
 
 
482
        pb = ui.ui_factory.nested_progress_bar()
 
483
        try:
 
484
            old_path = self.root_transport.abspath('.bzr')
 
485
            backup_dir = self._available_backup_name('backup.bzr')
 
486
            new_path = self.root_transport.abspath(backup_dir)
 
487
            ui.ui_factory.note(gettext('making backup of {0}\n  to {1}').format(
 
488
                urlutils.unescape_for_display(old_path, 'utf-8'),
 
489
                urlutils.unescape_for_display(new_path, 'utf-8')))
 
490
            self.root_transport.copy_tree('.bzr', backup_dir)
 
491
            return (old_path, new_path)
 
492
        finally:
 
493
            pb.finished()
 
494
 
 
495
    def retire_bzrdir(self, limit=10000):
 
496
        """Permanently disable the bzrdir.
 
497
 
 
498
        This is done by renaming it to give the user some ability to recover
 
499
        if there was a problem.
 
500
 
 
501
        This will have horrible consequences if anyone has anything locked or
 
502
        in use.
 
503
        :param limit: number of times to retry
 
504
        """
 
505
        i  = 0
 
506
        while True:
 
507
            try:
 
508
                to_path = '.bzr.retired.%d' % i
 
509
                self.root_transport.rename('.bzr', to_path)
 
510
                note(gettext("renamed {0} to {1}").format(
 
511
                    self.root_transport.abspath('.bzr'), to_path))
 
512
                return
 
513
            except (errors.TransportError, IOError, errors.PathError):
 
514
                i += 1
 
515
                if i > limit:
 
516
                    raise
 
517
                else:
 
518
                    pass
 
519
 
 
520
    def _find_containing(self, evaluate):
 
521
        """Find something in a containing control directory.
 
522
 
 
523
        This method will scan containing control dirs, until it finds what
 
524
        it is looking for, decides that it will never find it, or runs out
 
525
        of containing control directories to check.
 
526
 
 
527
        It is used to implement find_repository and
 
528
        determine_repository_policy.
 
529
 
 
530
        :param evaluate: A function returning (value, stop).  If stop is True,
 
531
            the value will be returned.
 
532
        """
 
533
        found_bzrdir = self
 
534
        while True:
 
535
            result, stop = evaluate(found_bzrdir)
 
536
            if stop:
 
537
                return result
 
538
            next_transport = found_bzrdir.root_transport.clone('..')
 
539
            if (found_bzrdir.user_url == next_transport.base):
 
540
                # top of the file system
 
541
                return None
 
542
            # find the next containing bzrdir
 
543
            try:
 
544
                found_bzrdir = self.open_containing_from_transport(
 
545
                    next_transport)[0]
 
546
            except errors.NotBranchError:
 
547
                return None
 
548
 
 
549
    def find_repository(self):
 
550
        """Find the repository that should be used.
 
551
 
 
552
        This does not require a branch as we use it to find the repo for
 
553
        new branches as well as to hook existing branches up to their
 
554
        repository.
 
555
        """
 
556
        def usable_repository(found_bzrdir):
 
557
            # does it have a repository ?
 
558
            try:
 
559
                repository = found_bzrdir.open_repository()
 
560
            except errors.NoRepositoryPresent:
 
561
                return None, False
 
562
            if found_bzrdir.user_url == self.user_url:
 
563
                return repository, True
 
564
            elif repository.is_shared():
 
565
                return repository, True
 
566
            else:
 
567
                return None, True
 
568
 
 
569
        found_repo = self._find_containing(usable_repository)
 
570
        if found_repo is None:
 
571
            raise errors.NoRepositoryPresent(self)
 
572
        return found_repo
 
573
 
 
574
    def _find_creation_modes(self):
 
575
        """Determine the appropriate modes for files and directories.
 
576
 
 
577
        They're always set to be consistent with the base directory,
 
578
        assuming that this transport allows setting modes.
 
579
        """
 
580
        # TODO: Do we need or want an option (maybe a config setting) to turn
 
581
        # this off or override it for particular locations? -- mbp 20080512
 
582
        if self._mode_check_done:
 
583
            return
 
584
        self._mode_check_done = True
 
585
        try:
 
586
            st = self.transport.stat('.')
 
587
        except errors.TransportNotPossible:
 
588
            self._dir_mode = None
 
589
            self._file_mode = None
 
590
        else:
 
591
            # Check the directory mode, but also make sure the created
 
592
            # directories and files are read-write for this user. This is
 
593
            # mostly a workaround for filesystems which lie about being able to
 
594
            # write to a directory (cygwin & win32)
 
595
            if (st.st_mode & 07777 == 00000):
 
596
                # FTP allows stat but does not return dir/file modes
 
597
                self._dir_mode = None
 
598
                self._file_mode = None
 
599
            else:
 
600
                self._dir_mode = (st.st_mode & 07777) | 00700
 
601
                # Remove the sticky and execute bits for files
 
602
                self._file_mode = self._dir_mode & ~07111
 
603
 
 
604
    def _get_file_mode(self):
 
605
        """Return Unix mode for newly created files, or None.
 
606
        """
 
607
        if not self._mode_check_done:
 
608
            self._find_creation_modes()
 
609
        return self._file_mode
 
610
 
 
611
    def _get_dir_mode(self):
 
612
        """Return Unix mode for newly created directories, or None.
 
613
        """
 
614
        if not self._mode_check_done:
 
615
            self._find_creation_modes()
 
616
        return self._dir_mode
 
617
 
 
618
    def get_config(self):
 
619
        """Get configuration for this BzrDir."""
 
620
        return config.BzrDirConfig(self)
 
621
 
 
622
    def _get_config(self):
 
623
        """By default, no configuration is available."""
 
624
        return None
 
625
 
 
626
    def __init__(self, _transport, _format):
 
627
        """Initialize a Bzr control dir object.
 
628
 
 
629
        Only really common logic should reside here, concrete classes should be
 
630
        made with varying behaviours.
 
631
 
 
632
        :param _format: the format that is creating this BzrDir instance.
 
633
        :param _transport: the transport this dir is based at.
 
634
        """
 
635
        self._format = _format
 
636
        # these are also under the more standard names of 
 
637
        # control_transport and user_transport
 
638
        self.transport = _transport.clone('.bzr')
 
639
        self.root_transport = _transport
 
640
        self._mode_check_done = False
 
641
 
 
642
    @property 
 
643
    def user_transport(self):
 
644
        return self.root_transport
 
645
 
 
646
    @property
 
647
    def control_transport(self):
 
648
        return self.transport
 
649
 
 
650
    def is_control_filename(self, filename):
 
651
        """True if filename is the name of a path which is reserved for bzrdir's.
 
652
 
 
653
        :param filename: A filename within the root transport of this bzrdir.
 
654
 
 
655
        This is true IF and ONLY IF the filename is part of the namespace reserved
 
656
        for bzr control dirs. Currently this is the '.bzr' directory in the root
 
657
        of the root_transport. 
 
658
        """
 
659
        # this might be better on the BzrDirFormat class because it refers to
 
660
        # all the possible bzrdir disk formats.
 
661
        # This method is tested via the workingtree is_control_filename tests-
 
662
        # it was extracted from WorkingTree.is_control_filename. If the method's
 
663
        # contract is extended beyond the current trivial implementation, please
 
664
        # add new tests for it to the appropriate place.
 
665
        return filename == '.bzr' or filename.startswith('.bzr/')
 
666
 
 
667
    def _cloning_metadir(self):
 
668
        """Produce a metadir suitable for cloning with.
 
669
 
 
670
        :returns: (destination_bzrdir_format, source_repository)
 
671
        """
 
672
        result_format = self._format.__class__()
 
673
        try:
 
674
            try:
 
675
                branch = self.open_branch(ignore_fallbacks=True)
 
676
                source_repository = branch.repository
 
677
                result_format._branch_format = branch._format
 
678
            except errors.NotBranchError:
 
679
                source_branch = None
 
680
                source_repository = self.open_repository()
 
681
        except errors.NoRepositoryPresent:
 
682
            source_repository = None
 
683
        else:
 
684
            # XXX TODO: This isinstance is here because we have not implemented
 
685
            # the fix recommended in bug # 103195 - to delegate this choice the
 
686
            # repository itself.
 
687
            repo_format = source_repository._format
 
688
            if isinstance(repo_format, remote.RemoteRepositoryFormat):
 
689
                source_repository._ensure_real()
 
690
                repo_format = source_repository._real_repository._format
 
691
            result_format.repository_format = repo_format
 
692
        try:
 
693
            # TODO: Couldn't we just probe for the format in these cases,
 
694
            # rather than opening the whole tree?  It would be a little
 
695
            # faster. mbp 20070401
 
696
            tree = self.open_workingtree(recommend_upgrade=False)
 
697
        except (errors.NoWorkingTree, errors.NotLocalUrl):
 
698
            result_format.workingtree_format = None
 
699
        else:
 
700
            result_format.workingtree_format = tree._format.__class__()
 
701
        return result_format, source_repository
 
702
 
 
703
    def cloning_metadir(self, require_stacking=False):
 
704
        """Produce a metadir suitable for cloning or sprouting with.
 
705
 
 
706
        These operations may produce workingtrees (yes, even though they're
 
707
        "cloning" something that doesn't have a tree), so a viable workingtree
 
708
        format must be selected.
 
709
 
 
710
        :require_stacking: If True, non-stackable formats will be upgraded
 
711
            to similar stackable formats.
 
712
        :returns: a ControlDirFormat with all component formats either set
 
713
            appropriately or set to None if that component should not be
 
714
            created.
 
715
        """
 
716
        format, repository = self._cloning_metadir()
 
717
        if format._workingtree_format is None:
 
718
            # No tree in self.
 
719
            if repository is None:
 
720
                # No repository either
 
721
                return format
 
722
            # We have a repository, so set a working tree? (Why? This seems to
 
723
            # contradict the stated return value in the docstring).
 
724
            tree_format = repository._format._matchingbzrdir.workingtree_format
 
725
            format.workingtree_format = tree_format.__class__()
 
726
        if require_stacking:
 
727
            format.require_stacking()
 
728
        return format
 
729
 
 
730
    def get_branch_transport(self, branch_format, name=None):
 
731
        """Get the transport for use by branch format in this BzrDir.
 
732
 
 
733
        Note that bzr dirs that do not support format strings will raise
 
734
        IncompatibleFormat if the branch format they are given has
 
735
        a format string, and vice versa.
 
736
 
 
737
        If branch_format is None, the transport is returned with no
 
738
        checking. If it is not None, then the returned transport is
 
739
        guaranteed to point to an existing directory ready for use.
 
740
        """
 
741
        raise NotImplementedError(self.get_branch_transport)
 
742
 
 
743
    def get_repository_transport(self, repository_format):
 
744
        """Get the transport for use by repository format in this BzrDir.
 
745
 
 
746
        Note that bzr dirs that do not support format strings will raise
 
747
        IncompatibleFormat if the repository format they are given has
 
748
        a format string, and vice versa.
 
749
 
 
750
        If repository_format is None, the transport is returned with no
 
751
        checking. If it is not None, then the returned transport is
 
752
        guaranteed to point to an existing directory ready for use.
 
753
        """
 
754
        raise NotImplementedError(self.get_repository_transport)
 
755
 
 
756
    def get_workingtree_transport(self, tree_format):
 
757
        """Get the transport for use by workingtree format in this BzrDir.
 
758
 
 
759
        Note that bzr dirs that do not support format strings will raise
 
760
        IncompatibleFormat if the workingtree format they are given has a
 
761
        format string, and vice versa.
 
762
 
 
763
        If workingtree_format is None, the transport is returned with no
 
764
        checking. If it is not None, then the returned transport is
 
765
        guaranteed to point to an existing directory ready for use.
 
766
        """
 
767
        raise NotImplementedError(self.get_workingtree_transport)
 
768
 
 
769
    @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()
 
799
 
 
800
 
 
801
class BzrDirMeta1(BzrDir):
 
802
    """A .bzr meta version 1 control object.
 
803
 
 
804
    This is the first control object where the
 
805
    individual aspects are really split out: there are separate repository,
 
806
    workingtree and branch subdirectories and any subset of the three can be
 
807
    present within a BzrDir.
 
808
    """
 
809
 
 
810
    def _get_branch_path(self, name):
 
811
        """Obtain the branch path to use.
 
812
 
 
813
        This uses the API specified branch name first, and then falls back to
 
814
        the branch name specified in the URL. If neither of those is specified,
 
815
        it uses the default branch.
 
816
 
 
817
        :param name: Optional branch name to use
 
818
        :return: Relative path to branch
 
819
        """
 
820
        if name == "":
 
821
            return 'branch'
 
822
        return urlutils.join('branches', name.encode("utf-8"))
 
823
 
 
824
    def _read_branch_list(self):
 
825
        """Read the branch list.
 
826
 
 
827
        :return: List of utf-8 encoded branch names.
 
828
        """
 
829
        try:
 
830
            f = self.control_transport.get('branch-list')
 
831
        except errors.NoSuchFile:
 
832
            return []
 
833
 
 
834
        ret = []
 
835
        try:
 
836
            for name in f:
 
837
                ret.append(name.rstrip("\n"))
 
838
        finally:
 
839
            f.close()
 
840
        return ret
 
841
 
 
842
    def _write_branch_list(self, branches):
 
843
        """Write out the branch list.
 
844
 
 
845
        :param branches: List of utf-8 branch names to write
 
846
        """
 
847
        self.transport.put_bytes('branch-list',
 
848
            "".join([name+"\n" for name in branches]))
 
849
 
 
850
    def __init__(self, _transport, _format):
 
851
        super(BzrDirMeta1, self).__init__(_transport, _format)
 
852
        self.control_files = lockable_files.LockableFiles(
 
853
            self.control_transport, self._format._lock_file_name,
 
854
            self._format._lock_class)
 
855
 
 
856
    def can_convert_format(self):
 
857
        """See BzrDir.can_convert_format()."""
 
858
        return True
 
859
 
 
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)
 
868
 
 
869
    def destroy_branch(self, name=None):
 
870
        """See ControlDir.destroy_branch."""
 
871
        if name is None:
 
872
            name = self._get_selected_branch()
 
873
        path = self._get_branch_path(name)
 
874
        if name != "":
 
875
            self.control_files.lock_write()
 
876
            try:
 
877
                branches = self._read_branch_list()
 
878
                try:
 
879
                    branches.remove(name.encode("utf-8"))
 
880
                except ValueError:
 
881
                    raise errors.NotBranchError(name)
 
882
                self._write_branch_list(branches)
 
883
            finally:
 
884
                self.control_files.unlock()
 
885
        try:
 
886
            self.transport.delete_tree(path)
 
887
        except errors.NoSuchFile:
 
888
            raise errors.NotBranchError(path=urlutils.join(self.transport.base,
 
889
                path), bzrdir=self)
 
890
 
 
891
    def create_repository(self, shared=False):
 
892
        """See BzrDir.create_repository."""
 
893
        return self._format.repository_format.initialize(self, shared)
 
894
 
 
895
    def destroy_repository(self):
 
896
        """See BzrDir.destroy_repository."""
 
897
        try:
 
898
            self.transport.delete_tree('repository')
 
899
        except errors.NoSuchFile:
 
900
            raise errors.NoRepositoryPresent(self)
 
901
 
 
902
    def create_workingtree(self, revision_id=None, from_branch=None,
 
903
                           accelerator_tree=None, hardlink=False):
 
904
        """See BzrDir.create_workingtree."""
 
905
        return self._format.workingtree_format.initialize(
 
906
            self, revision_id, from_branch=from_branch,
 
907
            accelerator_tree=accelerator_tree, hardlink=hardlink)
 
908
 
 
909
    def destroy_workingtree(self):
 
910
        """See BzrDir.destroy_workingtree."""
 
911
        wt = self.open_workingtree(recommend_upgrade=False)
 
912
        repository = wt.branch.repository
 
913
        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)
 
918
        self.destroy_workingtree_metadata()
 
919
 
 
920
    def destroy_workingtree_metadata(self):
 
921
        self.transport.delete_tree('checkout')
 
922
 
 
923
    def find_branch_format(self, name=None):
 
924
        """Find the branch 'format' for this bzrdir.
 
925
 
 
926
        This might be a synthetic object for e.g. RemoteBranch and SVN.
 
927
        """
 
928
        from bzrlib.branch import BranchFormatMetadir
 
929
        return BranchFormatMetadir.find_format(self, name=name)
 
930
 
 
931
    def _get_mkdir_mode(self):
 
932
        """Figure out the mode to use when creating a bzrdir subdir."""
 
933
        temp_control = lockable_files.LockableFiles(self.transport, '',
 
934
                                     lockable_files.TransportLock)
 
935
        return temp_control._dir_mode
 
936
 
 
937
    def get_branch_reference(self, name=None):
 
938
        """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):
 
948
        """See BzrDir.get_branch_transport()."""
 
949
        if name is None:
 
950
            name = self._get_selected_branch()
 
951
        path = self._get_branch_path(name)
 
952
        # XXX: this shouldn't implicitly create the directory if it's just
 
953
        # promising to get a transport -- mbp 20090727
 
954
        if branch_format is None:
 
955
            return self.transport.clone(path)
 
956
        try:
 
957
            branch_format.get_format_string()
 
958
        except NotImplementedError:
 
959
            raise errors.IncompatibleFormat(branch_format, self._format)
 
960
        if name != "":
 
961
            branches = self._read_branch_list()
 
962
            utf8_name = name.encode("utf-8")
 
963
            if not utf8_name in branches:
 
964
                self.control_files.lock_write()
 
965
                try:
 
966
                    branches = self._read_branch_list()
 
967
                    dirname = urlutils.dirname(utf8_name)
 
968
                    if dirname != "" and dirname in branches:
 
969
                        raise errors.ParentBranchExists(name)
 
970
                    child_branches = [
 
971
                        b.startswith(utf8_name+"/") for b in branches]
 
972
                    if any(child_branches):
 
973
                        raise errors.AlreadyBranchError(name)
 
974
                    branches.append(utf8_name)
 
975
                    self._write_branch_list(branches)
 
976
                finally:
 
977
                    self.control_files.unlock()
 
978
        branch_transport = self.transport.clone(path)
 
979
        mode = self._get_mkdir_mode()
 
980
        branch_transport.create_prefix(mode=mode)
 
981
        try:
 
982
            self.transport.mkdir(path, mode=mode)
 
983
        except errors.FileExists:
 
984
            pass
 
985
        return self.transport.clone(path)
 
986
 
 
987
    def get_repository_transport(self, repository_format):
 
988
        """See BzrDir.get_repository_transport()."""
 
989
        if repository_format is None:
 
990
            return self.transport.clone('repository')
 
991
        try:
 
992
            repository_format.get_format_string()
 
993
        except NotImplementedError:
 
994
            raise errors.IncompatibleFormat(repository_format, self._format)
 
995
        try:
 
996
            self.transport.mkdir('repository', mode=self._get_mkdir_mode())
 
997
        except errors.FileExists:
 
998
            pass
 
999
        return self.transport.clone('repository')
 
1000
 
 
1001
    def get_workingtree_transport(self, workingtree_format):
 
1002
        """See BzrDir.get_workingtree_transport()."""
 
1003
        if workingtree_format is None:
 
1004
            return self.transport.clone('checkout')
 
1005
        try:
 
1006
            workingtree_format.get_format_string()
 
1007
        except NotImplementedError:
 
1008
            raise errors.IncompatibleFormat(workingtree_format, self._format)
 
1009
        try:
 
1010
            self.transport.mkdir('checkout', mode=self._get_mkdir_mode())
 
1011
        except errors.FileExists:
 
1012
            pass
 
1013
        return self.transport.clone('checkout')
 
1014
 
 
1015
    def get_branches(self):
 
1016
        """See ControlDir.get_branches."""
 
1017
        ret = {}
 
1018
        try:
 
1019
            ret[""] = self.open_branch(name="")
 
1020
        except (errors.NotBranchError, errors.NoRepositoryPresent):
 
1021
            pass
 
1022
 
 
1023
        for name in self._read_branch_list():
 
1024
            ret[name] = self.open_branch(name=name.decode('utf-8'))
 
1025
 
 
1026
        return ret
 
1027
 
 
1028
    def has_workingtree(self):
 
1029
        """Tell if this bzrdir contains a working tree.
 
1030
 
 
1031
        Note: if you're going to open the working tree, you should just go
 
1032
        ahead and try, and not ask permission first.
 
1033
        """
 
1034
        from bzrlib.workingtree import WorkingTreeFormatMetaDir
 
1035
        try:
 
1036
            WorkingTreeFormatMetaDir.find_format_string(self)
 
1037
        except errors.NoWorkingTree:
 
1038
            return False
 
1039
        return True
 
1040
 
 
1041
    def needs_format_conversion(self, format):
 
1042
        """See BzrDir.needs_format_conversion()."""
 
1043
        if (not isinstance(self._format, format.__class__) or
 
1044
            self._format.get_format_string() != format.get_format_string()):
 
1045
            # it is not a meta dir format, conversion is needed.
 
1046
            return True
 
1047
        # we might want to push this down to the repository?
 
1048
        try:
 
1049
            if not isinstance(self.open_repository()._format,
 
1050
                              format.repository_format.__class__):
 
1051
                # the repository needs an upgrade.
 
1052
                return True
 
1053
        except errors.NoRepositoryPresent:
 
1054
            pass
 
1055
        for branch in self.list_branches():
 
1056
            if not isinstance(branch._format,
 
1057
                              format.get_branch_format().__class__):
 
1058
                # the branch needs an upgrade.
 
1059
                return True
 
1060
        try:
 
1061
            my_wt = self.open_workingtree(recommend_upgrade=False)
 
1062
            if not isinstance(my_wt._format,
 
1063
                              format.workingtree_format.__class__):
 
1064
                # the workingtree needs an upgrade.
 
1065
                return True
 
1066
        except (errors.NoWorkingTree, errors.NotLocalUrl):
 
1067
            pass
 
1068
        return False
 
1069
 
 
1070
    def open_branch(self, name=None, unsupported=False,
 
1071
                    ignore_fallbacks=False, possible_transports=None):
 
1072
        """See ControlDir.open_branch."""
 
1073
        if name is None:
 
1074
            name = self._get_selected_branch()
 
1075
        format = self.find_branch_format(name=name)
 
1076
        format.check_support_status(unsupported)
 
1077
        return format.open(self, name=name,
 
1078
            _found=True, ignore_fallbacks=ignore_fallbacks,
 
1079
            possible_transports=possible_transports)
 
1080
 
 
1081
    def open_repository(self, unsupported=False):
 
1082
        """See BzrDir.open_repository."""
 
1083
        from bzrlib.repository import RepositoryFormatMetaDir
 
1084
        format = RepositoryFormatMetaDir.find_format(self)
 
1085
        format.check_support_status(unsupported)
 
1086
        return format.open(self, _found=True)
 
1087
 
 
1088
    def open_workingtree(self, unsupported=False,
 
1089
            recommend_upgrade=True):
 
1090
        """See BzrDir.open_workingtree."""
 
1091
        from bzrlib.workingtree import WorkingTreeFormatMetaDir
 
1092
        format = WorkingTreeFormatMetaDir.find_format(self)
 
1093
        format.check_support_status(unsupported, recommend_upgrade,
 
1094
            basedir=self.root_transport.base)
 
1095
        return format.open(self, _found=True)
 
1096
 
 
1097
    def _get_config(self):
 
1098
        return config.TransportConfig(self.transport, 'control.conf')
 
1099
 
 
1100
 
 
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.
 
1299
 
 
1300
    Formats are placed in a dict by their format string for reference
 
1301
    during bzrdir opening. These should be subclasses of BzrDirFormat
 
1302
    for consistency.
 
1303
 
 
1304
    Once a format is deprecated, just deprecate the initialize and open
 
1305
    methods on the format class. Do not deprecate the object, as the
 
1306
    object will be created every system load.
 
1307
    """
 
1308
 
 
1309
    _lock_file_name = 'branch-lock'
 
1310
 
 
1311
    # _lock_class must be set in subclasses to the lock type, typ.
 
1312
    # TransportLock or LockDir
 
1313
 
 
1314
    def initialize_on_transport(self, transport):
 
1315
        """Initialize a new bzrdir in the base directory of a Transport."""
 
1316
        try:
 
1317
            # can we hand off the request to the smart server rather than using
 
1318
            # vfs calls?
 
1319
            client_medium = transport.get_smart_medium()
 
1320
        except errors.NoSmartMedium:
 
1321
            return self._initialize_on_transport_vfs(transport)
 
1322
        else:
 
1323
            # Current RPC's only know how to create bzr metadir1 instances, so
 
1324
            # we still delegate to vfs methods if the requested format is not a
 
1325
            # metadir1
 
1326
            if type(self) != BzrDirMetaFormat1:
 
1327
                return self._initialize_on_transport_vfs(transport)
 
1328
            from bzrlib.remote import RemoteBzrDirFormat
 
1329
            remote_format = RemoteBzrDirFormat()
 
1330
            self._supply_sub_formats_to(remote_format)
 
1331
            return remote_format.initialize_on_transport(transport)
 
1332
 
 
1333
    def initialize_on_transport_ex(self, transport, use_existing_dir=False,
 
1334
        create_prefix=False, force_new_repo=False, stacked_on=None,
 
1335
        stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
 
1336
        shared_repo=False, vfs_only=False):
 
1337
        """Create this format on transport.
 
1338
 
 
1339
        The directory to initialize will be created.
 
1340
 
 
1341
        :param force_new_repo: Do not use a shared repository for the target,
 
1342
                               even if one is available.
 
1343
        :param create_prefix: Create any missing directories leading up to
 
1344
            to_transport.
 
1345
        :param use_existing_dir: Use an existing directory if one exists.
 
1346
        :param stacked_on: A url to stack any created branch on, None to follow
 
1347
            any target stacking policy.
 
1348
        :param stack_on_pwd: If stack_on is relative, the location it is
 
1349
            relative to.
 
1350
        :param repo_format_name: If non-None, a repository will be
 
1351
            made-or-found. Should none be found, or if force_new_repo is True
 
1352
            the repo_format_name is used to select the format of repository to
 
1353
            create.
 
1354
        :param make_working_trees: Control the setting of make_working_trees
 
1355
            for a new shared repository when one is made. None to use whatever
 
1356
            default the format has.
 
1357
        :param shared_repo: Control whether made repositories are shared or
 
1358
            not.
 
1359
        :param vfs_only: If True do not attempt to use a smart server
 
1360
        :return: repo, controldir, require_stacking, repository_policy. repo is
 
1361
            None if none was created or found, bzrdir is always valid.
 
1362
            require_stacking is the result of examining the stacked_on
 
1363
            parameter and any stacking policy found for the target.
 
1364
        """
 
1365
        if not vfs_only:
 
1366
            # Try to hand off to a smart server 
 
1367
            try:
 
1368
                client_medium = transport.get_smart_medium()
 
1369
            except errors.NoSmartMedium:
 
1370
                pass
 
1371
            else:
 
1372
                from bzrlib.remote import RemoteBzrDirFormat
 
1373
                # TODO: lookup the local format from a server hint.
 
1374
                remote_dir_format = RemoteBzrDirFormat()
 
1375
                remote_dir_format._network_name = self.network_name()
 
1376
                self._supply_sub_formats_to(remote_dir_format)
 
1377
                return remote_dir_format.initialize_on_transport_ex(transport,
 
1378
                    use_existing_dir=use_existing_dir, create_prefix=create_prefix,
 
1379
                    force_new_repo=force_new_repo, stacked_on=stacked_on,
 
1380
                    stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
 
1381
                    make_working_trees=make_working_trees, shared_repo=shared_repo)
 
1382
        # XXX: Refactor the create_prefix/no_create_prefix code into a
 
1383
        #      common helper function
 
1384
        # The destination may not exist - if so make it according to policy.
 
1385
        def make_directory(transport):
 
1386
            transport.mkdir('.')
 
1387
            return transport
 
1388
        def redirected(transport, e, redirection_notice):
 
1389
            note(redirection_notice)
 
1390
            return transport._redirected_to(e.source, e.target)
 
1391
        try:
 
1392
            transport = do_catching_redirections(make_directory, transport,
 
1393
                redirected)
 
1394
        except errors.FileExists:
 
1395
            if not use_existing_dir:
 
1396
                raise
 
1397
        except errors.NoSuchFile:
 
1398
            if not create_prefix:
 
1399
                raise
 
1400
            transport.create_prefix()
 
1401
 
 
1402
        require_stacking = (stacked_on is not None)
 
1403
        # Now the target directory exists, but doesn't have a .bzr
 
1404
        # directory. So we need to create it, along with any work to create
 
1405
        # all of the dependent branches, etc.
 
1406
 
 
1407
        result = self.initialize_on_transport(transport)
 
1408
        if repo_format_name:
 
1409
            try:
 
1410
                # use a custom format
 
1411
                result._format.repository_format = \
 
1412
                    repository.network_format_registry.get(repo_format_name)
 
1413
            except AttributeError:
 
1414
                # The format didn't permit it to be set.
 
1415
                pass
 
1416
            # A repository is desired, either in-place or shared.
 
1417
            repository_policy = result.determine_repository_policy(
 
1418
                force_new_repo, stacked_on, stack_on_pwd,
 
1419
                require_stacking=require_stacking)
 
1420
            result_repo, is_new_repo = repository_policy.acquire_repository(
 
1421
                make_working_trees, shared_repo)
 
1422
            if not require_stacking and repository_policy._require_stacking:
 
1423
                require_stacking = True
 
1424
                result._format.require_stacking()
 
1425
            result_repo.lock_write()
 
1426
        else:
 
1427
            result_repo = None
 
1428
            repository_policy = None
 
1429
        return result_repo, result, require_stacking, repository_policy
 
1430
 
 
1431
    def _initialize_on_transport_vfs(self, transport):
 
1432
        """Initialize a new bzrdir using VFS calls.
 
1433
 
 
1434
        :param transport: The transport to create the .bzr directory in.
 
1435
        :return: A
 
1436
        """
 
1437
        # Since we are creating a .bzr directory, inherit the
 
1438
        # mode from the root directory
 
1439
        temp_control = lockable_files.LockableFiles(transport,
 
1440
                            '', 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)
 
1448
        if sys.platform == 'win32' and isinstance(transport, local.LocalTransport):
 
1449
            win32utils.set_file_attr_hidden(transport._abspath('.bzr'))
 
1450
        file_mode = temp_control._file_mode
 
1451
        del temp_control
 
1452
        bzrdir_transport = transport.clone('.bzr')
 
1453
        utf8_files = [('README',
 
1454
                       "This is a Bazaar control directory.\n"
 
1455
                       "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()),
 
1458
                      ]
 
1459
        # NB: no need to escape relative paths that are url safe.
 
1460
        control_files = lockable_files.LockableFiles(bzrdir_transport,
 
1461
            self._lock_file_name, self._lock_class)
 
1462
        control_files.create_lock()
 
1463
        control_files.lock_write()
 
1464
        try:
 
1465
            for (filename, content) in utf8_files:
 
1466
                bzrdir_transport.put_bytes(filename, content,
 
1467
                    mode=file_mode)
 
1468
        finally:
 
1469
            control_files.unlock()
 
1470
        return self.open(transport, _found=True)
 
1471
 
 
1472
    def open(self, transport, _found=False):
 
1473
        """Return an instance of this format for the dir transport points at.
 
1474
 
 
1475
        _found is a private parameter, do not use it.
 
1476
        """
 
1477
        if not _found:
 
1478
            found_format = controldir.ControlDirFormat.find_format(transport)
 
1479
            if not isinstance(found_format, self.__class__):
 
1480
                raise AssertionError("%s was asked to open %s, but it seems to need "
 
1481
                        "format %s"
 
1482
                        % (self, transport, found_format))
 
1483
            # Allow subclasses - use the found format.
 
1484
            self._supply_sub_formats_to(found_format)
 
1485
            return found_format._open(transport)
 
1486
        return self._open(transport)
 
1487
 
 
1488
    def _open(self, transport):
 
1489
        """Template method helper for opening BzrDirectories.
 
1490
 
 
1491
        This performs the actual open and any additional logic or parameter
 
1492
        passing.
 
1493
        """
 
1494
        raise NotImplementedError(self._open)
 
1495
 
 
1496
    def _supply_sub_formats_to(self, other_format):
 
1497
        """Give other_format the same values for sub formats as this has.
 
1498
 
 
1499
        This method is expected to be used when parameterising a
 
1500
        RemoteBzrDirFormat instance with the parameters from a
 
1501
        BzrDirMetaFormat1 instance.
 
1502
 
 
1503
        :param other_format: other_format is a format which should be
 
1504
            compatible with whatever sub formats are supported by self.
 
1505
        :return: None.
 
1506
        """
 
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)
 
1520
 
 
1521
 
 
1522
class BzrDirMetaFormat1(BzrDirFormat):
 
1523
    """Bzr meta control format 1
 
1524
 
 
1525
    This is the first format with split out working tree, branch and repository
 
1526
    disk storage.
 
1527
 
 
1528
    It has:
 
1529
 
 
1530
    - Format 3 working trees [optional]
 
1531
    - Format 5 branches [optional]
 
1532
    - Format 7 repositories [optional]
 
1533
    """
 
1534
 
 
1535
    _lock_class = lockdir.LockDir
 
1536
 
 
1537
    fixed_components = False
 
1538
 
 
1539
    colocated_branches = True
 
1540
 
 
1541
    def __init__(self):
 
1542
        BzrDirFormat.__init__(self)
 
1543
        self._workingtree_format = None
 
1544
        self._branch_format = None
 
1545
        self._repository_format = None
 
1546
 
 
1547
    def __eq__(self, other):
 
1548
        if other.__class__ is not self.__class__:
 
1549
            return False
 
1550
        if other.repository_format != self.repository_format:
 
1551
            return False
 
1552
        if other.workingtree_format != self.workingtree_format:
 
1553
            return False
 
1554
        if other.features != self.features:
 
1555
            return False
 
1556
        return True
 
1557
 
 
1558
    def __ne__(self, other):
 
1559
        return not self == other
 
1560
 
 
1561
    def get_branch_format(self):
 
1562
        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()
 
1565
        return self._branch_format
 
1566
 
 
1567
    def set_branch_format(self, format):
 
1568
        self._branch_format = format
 
1569
 
 
1570
    def require_stacking(self, stack_on=None, possible_transports=None,
 
1571
            _skip_repo=False):
 
1572
        """We have a request to stack, try to ensure the formats support it.
 
1573
 
 
1574
        :param stack_on: If supplied, it is the URL to a branch that we want to
 
1575
            stack on. Check to see if that format supports stacking before
 
1576
            forcing an upgrade.
 
1577
        """
 
1578
        # Stacking is desired. requested by the target, but does the place it
 
1579
        # points at support stacking? If it doesn't then we should
 
1580
        # not implicitly upgrade. We check this here.
 
1581
        new_repo_format = None
 
1582
        new_branch_format = None
 
1583
 
 
1584
        # a bit of state for get_target_branch so that we don't try to open it
 
1585
        # 2 times, for both repo *and* branch
 
1586
        target = [None, False, None] # target_branch, checked, upgrade anyway
 
1587
        def get_target_branch():
 
1588
            if target[1]:
 
1589
                # We've checked, don't check again
 
1590
                return target
 
1591
            if stack_on is None:
 
1592
                # No target format, that means we want to force upgrading
 
1593
                target[:] = [None, True, True]
 
1594
                return target
 
1595
            try:
 
1596
                target_dir = BzrDir.open(stack_on,
 
1597
                    possible_transports=possible_transports)
 
1598
            except errors.NotBranchError:
 
1599
                # Nothing there, don't change formats
 
1600
                target[:] = [None, True, False]
 
1601
                return target
 
1602
            except errors.JailBreak:
 
1603
                # JailBreak, JFDI and upgrade anyway
 
1604
                target[:] = [None, True, True]
 
1605
                return target
 
1606
            try:
 
1607
                target_branch = target_dir.open_branch()
 
1608
            except errors.NotBranchError:
 
1609
                # No branch, don't upgrade formats
 
1610
                target[:] = [None, True, False]
 
1611
                return target
 
1612
            target[:] = [target_branch, True, False]
 
1613
            return target
 
1614
 
 
1615
        if (not _skip_repo and
 
1616
                 not self.repository_format.supports_external_lookups):
 
1617
            # We need to upgrade the Repository.
 
1618
            target_branch, _, do_upgrade = get_target_branch()
 
1619
            if target_branch is None:
 
1620
                # We don't have a target branch, should we upgrade anyway?
 
1621
                if do_upgrade:
 
1622
                    # stack_on is inaccessible, JFDI.
 
1623
                    # TODO: bad monkey, hard-coded formats...
 
1624
                    if self.repository_format.rich_root_data:
 
1625
                        new_repo_format = knitpack_repo.RepositoryFormatKnitPack5RichRoot()
 
1626
                    else:
 
1627
                        new_repo_format = knitpack_repo.RepositoryFormatKnitPack5()
 
1628
            else:
 
1629
                # If the target already supports stacking, then we know the
 
1630
                # project is already able to use stacking, so auto-upgrade
 
1631
                # for them
 
1632
                new_repo_format = target_branch.repository._format
 
1633
                if not new_repo_format.supports_external_lookups:
 
1634
                    # target doesn't, source doesn't, so don't auto upgrade
 
1635
                    # repo
 
1636
                    new_repo_format = None
 
1637
            if new_repo_format is not None:
 
1638
                self.repository_format = new_repo_format
 
1639
                note(gettext('Source repository format does not support stacking,'
 
1640
                     ' using format:\n  %s'),
 
1641
                     new_repo_format.get_format_description())
 
1642
 
 
1643
        if not self.get_branch_format().supports_stacking():
 
1644
            # We just checked the repo, now lets check if we need to
 
1645
            # upgrade the branch format
 
1646
            target_branch, _, do_upgrade = get_target_branch()
 
1647
            if target_branch is None:
 
1648
                if do_upgrade:
 
1649
                    # TODO: bad monkey, hard-coded formats...
 
1650
                    from bzrlib.branch import BzrBranchFormat7
 
1651
                    new_branch_format = BzrBranchFormat7()
 
1652
            else:
 
1653
                new_branch_format = target_branch._format
 
1654
                if not new_branch_format.supports_stacking():
 
1655
                    new_branch_format = None
 
1656
            if new_branch_format is not None:
 
1657
                # Does support stacking, use its format.
 
1658
                self.set_branch_format(new_branch_format)
 
1659
                note(gettext('Source branch format does not support stacking,'
 
1660
                     ' using format:\n  %s'),
 
1661
                     new_branch_format.get_format_description())
 
1662
 
 
1663
    def get_converter(self, format=None):
 
1664
        """See BzrDirFormat.get_converter()."""
 
1665
        if format is None:
 
1666
            format = BzrDirFormat.get_default_format()
 
1667
        if (type(self) is BzrDirMetaFormat1 and
 
1668
            type(format) is BzrDirMetaFormat1Colo):
 
1669
            return ConvertMetaToColo(format)
 
1670
        if (type(self) is BzrDirMetaFormat1Colo and
 
1671
            type(format) is BzrDirMetaFormat1):
 
1672
            return ConvertMetaToColo(format)
 
1673
        if not isinstance(self, format.__class__):
 
1674
            # converting away from metadir is not implemented
 
1675
            raise NotImplementedError(self.get_converter)
 
1676
        return ConvertMetaToMeta(format)
 
1677
 
 
1678
    @classmethod
 
1679
    def get_format_string(cls):
 
1680
        """See BzrDirFormat.get_format_string()."""
 
1681
        return "Bazaar-NG meta directory, format 1\n"
 
1682
 
 
1683
    def get_format_description(self):
 
1684
        """See BzrDirFormat.get_format_description()."""
 
1685
        return "Meta directory format 1"
 
1686
 
 
1687
    def _open(self, transport):
 
1688
        """See BzrDirFormat._open."""
 
1689
        # Create a new format instance because otherwise initialisation of new
 
1690
        # metadirs share the global default format object leading to alias
 
1691
        # problems.
 
1692
        format = BzrDirMetaFormat1()
 
1693
        self._supply_sub_formats_to(format)
 
1694
        return BzrDirMeta1(transport, format)
 
1695
 
 
1696
    def __return_repository_format(self):
 
1697
        """Circular import protection."""
 
1698
        if self._repository_format:
 
1699
            return self._repository_format
 
1700
        from bzrlib.repository import format_registry
 
1701
        return format_registry.get_default()
 
1702
 
 
1703
    def _set_repository_format(self, value):
 
1704
        """Allow changing the repository format for metadir formats."""
 
1705
        self._repository_format = value
 
1706
 
 
1707
    repository_format = property(__return_repository_format,
 
1708
        _set_repository_format)
 
1709
 
 
1710
    def _supply_sub_formats_to(self, other_format):
 
1711
        """Give other_format the same values for sub formats as this has.
 
1712
 
 
1713
        This method is expected to be used when parameterising a
 
1714
        RemoteBzrDirFormat instance with the parameters from a
 
1715
        BzrDirMetaFormat1 instance.
 
1716
 
 
1717
        :param other_format: other_format is a format which should be
 
1718
            compatible with whatever sub formats are supported by self.
 
1719
        :return: None.
 
1720
        """
 
1721
        super(BzrDirMetaFormat1, self)._supply_sub_formats_to(other_format)
 
1722
        if getattr(self, '_repository_format', None) is not None:
 
1723
            other_format.repository_format = self.repository_format
 
1724
        if self._branch_format is not None:
 
1725
            other_format._branch_format = self._branch_format
 
1726
        if self._workingtree_format is not None:
 
1727
            other_format.workingtree_format = self.workingtree_format
 
1728
 
 
1729
    def __get_workingtree_format(self):
 
1730
        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()
 
1735
        return self._workingtree_format
 
1736
 
 
1737
    def __set_workingtree_format(self, wt_format):
 
1738
        self._workingtree_format = wt_format
 
1739
 
 
1740
    def __repr__(self):
 
1741
        return "<%r>" % (self.__class__.__name__,)
 
1742
 
 
1743
    workingtree_format = property(__get_workingtree_format,
 
1744
                                  __set_workingtree_format)
 
1745
 
 
1746
 
 
1747
# 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):
 
1782
    """Converts the components of metadirs."""
 
1783
 
 
1784
    def __init__(self, target_format):
 
1785
        """Create a metadir to metadir converter.
 
1786
 
 
1787
        :param target_format: The final metadir format that is desired.
 
1788
        """
 
1789
        self.target_format = target_format
 
1790
 
 
1791
    def convert(self, to_convert, pb):
 
1792
        """See Converter.convert()."""
 
1793
        self.bzrdir = to_convert
 
1794
        self.pb = ui.ui_factory.nested_progress_bar()
 
1795
        self.count = 0
 
1796
        self.total = 1
 
1797
        self.step('checking repository format')
 
1798
        try:
 
1799
            repo = self.bzrdir.open_repository()
 
1800
        except errors.NoRepositoryPresent:
 
1801
            pass
 
1802
        else:
 
1803
            if not isinstance(repo._format, self.target_format.repository_format.__class__):
 
1804
                from bzrlib.repository import CopyConverter
 
1805
                ui.ui_factory.note(gettext('starting repository conversion'))
 
1806
                converter = CopyConverter(self.target_format.repository_format)
 
1807
                converter.convert(repo, pb)
 
1808
        for branch in self.bzrdir.list_branches():
 
1809
            # TODO: conversions of Branch and Tree should be done by
 
1810
            # InterXFormat lookups/some sort of registry.
 
1811
            # Avoid circular imports
 
1812
            old = branch._format.__class__
 
1813
            new = self.target_format.get_branch_format().__class__
 
1814
            while old != new:
 
1815
                if (old == fullhistorybranch.BzrBranchFormat5 and
 
1816
                    new in (_mod_branch.BzrBranchFormat6,
 
1817
                        _mod_branch.BzrBranchFormat7,
 
1818
                        _mod_branch.BzrBranchFormat8)):
 
1819
                    branch_converter = _mod_branch.Converter5to6()
 
1820
                elif (old == _mod_branch.BzrBranchFormat6 and
 
1821
                    new in (_mod_branch.BzrBranchFormat7,
 
1822
                            _mod_branch.BzrBranchFormat8)):
 
1823
                    branch_converter = _mod_branch.Converter6to7()
 
1824
                elif (old == _mod_branch.BzrBranchFormat7 and
 
1825
                      new is _mod_branch.BzrBranchFormat8):
 
1826
                    branch_converter = _mod_branch.Converter7to8()
 
1827
                else:
 
1828
                    raise errors.BadConversionTarget("No converter", new,
 
1829
                        branch._format)
 
1830
                branch_converter.convert(branch)
 
1831
                branch = self.bzrdir.open_branch()
 
1832
                old = branch._format.__class__
 
1833
        try:
 
1834
            tree = self.bzrdir.open_workingtree(recommend_upgrade=False)
 
1835
        except (errors.NoWorkingTree, errors.NotLocalUrl):
 
1836
            pass
 
1837
        else:
 
1838
            # TODO: conversions of Branch and Tree should be done by
 
1839
            # InterXFormat lookups
 
1840
            if (isinstance(tree, workingtree_3.WorkingTree3) and
 
1841
                not isinstance(tree, workingtree_4.DirStateWorkingTree) and
 
1842
                isinstance(self.target_format.workingtree_format,
 
1843
                    workingtree_4.DirStateWorkingTreeFormat)):
 
1844
                workingtree_4.Converter3to4().convert(tree)
 
1845
            if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
 
1846
                not isinstance(tree, workingtree_4.WorkingTree5) and
 
1847
                isinstance(self.target_format.workingtree_format,
 
1848
                    workingtree_4.WorkingTreeFormat5)):
 
1849
                workingtree_4.Converter4to5().convert(tree)
 
1850
            if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
 
1851
                not isinstance(tree, workingtree_4.WorkingTree6) and
 
1852
                isinstance(self.target_format.workingtree_format,
 
1853
                    workingtree_4.WorkingTreeFormat6)):
 
1854
                workingtree_4.Converter4or5to6().convert(tree)
 
1855
        self.pb.finished()
 
1856
        return to_convert
 
1857
 
 
1858
 
 
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)
 
1895
 
 
1896
 
 
1897
class RepositoryAcquisitionPolicy(object):
 
1898
    """Abstract base class for repository acquisition policies.
 
1899
 
 
1900
    A repository acquisition policy decides how a BzrDir acquires a repository
 
1901
    for a branch that is being created.  The most basic policy decision is
 
1902
    whether to create a new repository or use an existing one.
 
1903
    """
 
1904
    def __init__(self, stack_on, stack_on_pwd, require_stacking):
 
1905
        """Constructor.
 
1906
 
 
1907
        :param stack_on: A location to stack on
 
1908
        :param stack_on_pwd: If stack_on is relative, the location it is
 
1909
            relative to.
 
1910
        :param require_stacking: If True, it is a failure to not stack.
 
1911
        """
 
1912
        self._stack_on = stack_on
 
1913
        self._stack_on_pwd = stack_on_pwd
 
1914
        self._require_stacking = require_stacking
 
1915
 
 
1916
    def configure_branch(self, branch):
 
1917
        """Apply any configuration data from this policy to the branch.
 
1918
 
 
1919
        Default implementation sets repository stacking.
 
1920
        """
 
1921
        if self._stack_on is None:
 
1922
            return
 
1923
        if self._stack_on_pwd is None:
 
1924
            stack_on = self._stack_on
 
1925
        else:
 
1926
            try:
 
1927
                stack_on = urlutils.rebase_url(self._stack_on,
 
1928
                    self._stack_on_pwd,
 
1929
                    branch.user_url)
 
1930
            except errors.InvalidRebaseURLs:
 
1931
                stack_on = self._get_full_stack_on()
 
1932
        try:
 
1933
            branch.set_stacked_on_url(stack_on)
 
1934
        except (errors.UnstackableBranchFormat,
 
1935
                errors.UnstackableRepositoryFormat):
 
1936
            if self._require_stacking:
 
1937
                raise
 
1938
 
 
1939
    def requires_stacking(self):
 
1940
        """Return True if this policy requires stacking."""
 
1941
        return self._stack_on is not None and self._require_stacking
 
1942
 
 
1943
    def _get_full_stack_on(self):
 
1944
        """Get a fully-qualified URL for the stack_on location."""
 
1945
        if self._stack_on is None:
 
1946
            return None
 
1947
        if self._stack_on_pwd is None:
 
1948
            return self._stack_on
 
1949
        else:
 
1950
            return urlutils.join(self._stack_on_pwd, self._stack_on)
 
1951
 
 
1952
    def _add_fallback(self, repository, possible_transports=None):
 
1953
        """Add a fallback to the supplied repository, if stacking is set."""
 
1954
        stack_on = self._get_full_stack_on()
 
1955
        if stack_on is None:
 
1956
            return
 
1957
        try:
 
1958
            stacked_dir = BzrDir.open(stack_on,
 
1959
                                      possible_transports=possible_transports)
 
1960
        except errors.JailBreak:
 
1961
            # We keep the stacking details, but we are in the server code so
 
1962
            # actually stacking is not needed.
 
1963
            return
 
1964
        try:
 
1965
            stacked_repo = stacked_dir.open_branch().repository
 
1966
        except errors.NotBranchError:
 
1967
            stacked_repo = stacked_dir.open_repository()
 
1968
        try:
 
1969
            repository.add_fallback_repository(stacked_repo)
 
1970
        except errors.UnstackableRepositoryFormat:
 
1971
            if self._require_stacking:
 
1972
                raise
 
1973
        else:
 
1974
            self._require_stacking = True
 
1975
 
 
1976
    def acquire_repository(self, make_working_trees=None, shared=False,
 
1977
            possible_transports=None):
 
1978
        """Acquire a repository for this bzrdir.
 
1979
 
 
1980
        Implementations may create a new repository or use a pre-exising
 
1981
        repository.
 
1982
 
 
1983
        :param make_working_trees: If creating a repository, set
 
1984
            make_working_trees to this value (if non-None)
 
1985
        :param shared: If creating a repository, make it shared if True
 
1986
        :return: A repository, is_new_flag (True if the repository was
 
1987
            created).
 
1988
        """
 
1989
        raise NotImplementedError(RepositoryAcquisitionPolicy.acquire_repository)
 
1990
 
 
1991
 
 
1992
class CreateRepository(RepositoryAcquisitionPolicy):
 
1993
    """A policy of creating a new repository"""
 
1994
 
 
1995
    def __init__(self, bzrdir, stack_on=None, stack_on_pwd=None,
 
1996
                 require_stacking=False):
 
1997
        """Constructor.
 
1998
 
 
1999
        :param bzrdir: The bzrdir to create the repository on.
 
2000
        :param stack_on: A location to stack on
 
2001
        :param stack_on_pwd: If stack_on is relative, the location it is
 
2002
            relative to.
 
2003
        """
 
2004
        RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
 
2005
                                             require_stacking)
 
2006
        self._bzrdir = bzrdir
 
2007
 
 
2008
    def acquire_repository(self, make_working_trees=None, shared=False,
 
2009
            possible_transports=None):
 
2010
        """Implementation of RepositoryAcquisitionPolicy.acquire_repository
 
2011
 
 
2012
        Creates the desired repository in the bzrdir we already have.
 
2013
        """
 
2014
        if possible_transports is None:
 
2015
            possible_transports = []
 
2016
        else:
 
2017
            possible_transports = list(possible_transports)
 
2018
        possible_transports.append(self._bzrdir.root_transport)
 
2019
        stack_on = self._get_full_stack_on()
 
2020
        if stack_on:
 
2021
            format = self._bzrdir._format
 
2022
            format.require_stacking(stack_on=stack_on,
 
2023
                                    possible_transports=possible_transports)
 
2024
            if not self._require_stacking:
 
2025
                # 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))
 
2028
        repository = self._bzrdir.create_repository(shared=shared)
 
2029
        self._add_fallback(repository,
 
2030
                           possible_transports=possible_transports)
 
2031
        if make_working_trees is not None:
 
2032
            repository.set_make_working_trees(make_working_trees)
 
2033
        return repository, True
 
2034
 
 
2035
 
 
2036
class UseExistingRepository(RepositoryAcquisitionPolicy):
 
2037
    """A policy of reusing an existing repository"""
 
2038
 
 
2039
    def __init__(self, repository, stack_on=None, stack_on_pwd=None,
 
2040
                 require_stacking=False):
 
2041
        """Constructor.
 
2042
 
 
2043
        :param repository: The repository to use.
 
2044
        :param stack_on: A location to stack on
 
2045
        :param stack_on_pwd: If stack_on is relative, the location it is
 
2046
            relative to.
 
2047
        """
 
2048
        RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
 
2049
                                             require_stacking)
 
2050
        self._repository = repository
 
2051
 
 
2052
    def acquire_repository(self, make_working_trees=None, shared=False,
 
2053
            possible_transports=None):
 
2054
        """Implementation of RepositoryAcquisitionPolicy.acquire_repository
 
2055
 
 
2056
        Returns an existing repository to use.
 
2057
        """
 
2058
        if possible_transports is None:
 
2059
            possible_transports = []
 
2060
        else:
 
2061
            possible_transports = list(possible_transports)
 
2062
        possible_transports.append(self._repository.bzrdir.transport)
 
2063
        self._add_fallback(self._repository,
 
2064
                       possible_transports=possible_transports)
 
2065
        return self._repository, False
 
2066
 
 
2067
 
 
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',
 
2115
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
 
2116
    '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.',
 
2134
    branch_format='bzrlib.branch.BzrBranchFormat6',
 
2135
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
2136
    hidden=True,
 
2137
    deprecated=True)
 
2138
register_metadir(controldir.format_registry, 'rich-root',
 
2139
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
 
2140
    help='Variant of dirstate with better handling of tree roots. '
 
2141
        'Introduced in bzr 1.0',
 
2142
    branch_format='bzrlib.branch.BzrBranchFormat6',
 
2143
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
2144
    hidden=True,
 
2145
    deprecated=True)
 
2146
register_metadir(controldir.format_registry, 'dirstate-with-subtree',
 
2147
    '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',
 
2188
    help='A format that allows a branch to indicate that there is another '
 
2189
         '(stacked) repository that should be used to access data that is '
 
2190
         'not present locally.',
 
2191
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
2192
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
2193
    hidden=True,
 
2194
    deprecated=True,
 
2195
    )
 
2196
register_metadir(controldir.format_registry, '1.6.1-rich-root',
 
2197
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack5RichRoot',
 
2198
    help='A variant of 1.6 that supports rich-root data '
 
2199
         '(needed for bzr-svn and bzr-git).',
 
2200
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
2201
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
2202
    hidden=True,
 
2203
    deprecated=True,
 
2204
    )
 
2205
register_metadir(controldir.format_registry, '1.9',
 
2206
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6',
 
2207
    help='A repository format using B+tree indexes. These indexes '
 
2208
         'are smaller in size, have smarter caching and provide faster '
 
2209
         'performance for most operations.',
 
2210
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
2211
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
2212
    hidden=True,
 
2213
    deprecated=True,
 
2214
    )
 
2215
register_metadir(controldir.format_registry, '1.9-rich-root',
 
2216
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6RichRoot',
 
2217
    help='A variant of 1.9 that supports rich-root data '
 
2218
         '(needed for bzr-svn and bzr-git).',
 
2219
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
2220
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
2221
    hidden=True,
 
2222
    deprecated=True,
 
2223
    )
 
2224
register_metadir(controldir.format_registry, '1.14',
 
2225
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6',
 
2226
    help='A working-tree format that supports content filtering.',
 
2227
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
2228
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat5',
 
2229
    hidden=True,
 
2230
    deprecated=True,
 
2231
    )
 
2232
register_metadir(controldir.format_registry, '1.14-rich-root',
 
2233
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6RichRoot',
 
2234
    help='A variant of 1.14 that supports rich-root data '
 
2235
         '(needed for bzr-svn and bzr-git).',
 
2236
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
2237
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat5',
 
2238
    hidden=True,
 
2239
    deprecated=True,
 
2240
    )
 
2241
# 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',
 
2244
    help='Current development format, subtree variant. Can convert data to and '
 
2245
        'from pack-0.92-subtree (and anything compatible with '
 
2246
        'pack-0.92-subtree) format repositories. Repositories and branches in '
 
2247
        'this format can only be read by bzr.dev. Please read '
 
2248
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
 
2249
        'before use.',
 
2250
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
2251
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
 
2252
    experimental=True,
 
2253
    hidden=True,
 
2254
    alias=False, # Restore to being an alias when an actual development subtree format is added
 
2255
                 # This current non-alias status is simply because we did not introduce a
 
2256
                 # chk based subtree format.
 
2257
    )
 
2258
register_metadir(controldir.format_registry, 'development5-subtree',
 
2259
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatPackDevelopment2Subtree',
 
2260
    help='Development format, subtree variant. Can convert data to and '
 
2261
        'from pack-0.92-subtree (and anything compatible with '
 
2262
        'pack-0.92-subtree) format repositories. Repositories and branches in '
 
2263
        'this format can only be read by bzr.dev. Please read '
 
2264
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
 
2265
        'before use.',
 
2266
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
2267
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
 
2268
    experimental=True,
 
2269
    hidden=True,
 
2270
    alias=False,
 
2271
    )
 
2272
 
 
2273
register_metadir(controldir.format_registry, 'development-colo',
 
2274
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
 
2275
    help='The 2a format with experimental support for colocated branches.\n',
 
2276
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
2277
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
 
2278
    experimental=True,
 
2279
    bzrdir_format=BzrDirMetaFormat1Colo,
 
2280
    )
 
2281
 
 
2282
 
 
2283
# 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',
 
2287
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
 
2288
    help='Format for the bzr 2.0 series.\n'
 
2289
        'Uses group-compress storage.\n'
 
2290
        'Provides rich roots which are a one-way transition.\n',
 
2291
        # 'storage in packs, 255-way hashed CHK inventory, bencode revision, group compress, '
 
2292
        # 'rich roots. Supported by bzr 1.16 and later.',
 
2293
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
2294
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
 
2295
    experimental=False,
 
2296
    )
 
2297
 
 
2298
# The following format should be an alias for the rich root equivalent 
 
2299
# of the default format
 
2300
register_metadir(controldir.format_registry, 'default-rich-root',
 
2301
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
 
2302
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
2303
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
 
2304
    alias=True,
 
2305
    hidden=True,
 
2306
    help='Same as 2a.')
 
2307
 
 
2308
# 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