~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/bzrdir.py

(vila) Revise legal option names to be less drastic. (Vincent Ladeuil)

Show diffs side-by-side

added added

removed removed

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