~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/bzrdir.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2010-05-21 13:36:51 UTC
  • mfrom: (5243.2.1 readdir_cleanup)
  • Revision ID: pqm@pqm.ubuntu.com-20100521133651-p62dndo2giy5ls21
(lifeless) Some cleanups to the readdir pyrex code for a little efficiency
 and to avoid compile warnings. (John A Meinel)

Show diffs side-by-side

added added

removed removed

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