/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/bzrdir.py

  • Committer: Vincent Ladeuil
  • Date: 2010-07-07 11:21:19 UTC
  • mto: (5193.7.1 unify-confs)
  • mto: This revision was merged to the branch mainline in revision 5349.
  • Revision ID: v.ladeuil+lp@free.fr-20100707112119-jwyh312df41w6l0o
Revert previous change as I can't reproduce the related problem anymore.

Show diffs side-by-side

added added

removed removed

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