~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/bzrdir.py

  • Committer: Ian Clatworthy
  • Date: 2009-09-09 15:30:59 UTC
  • mto: (4634.37.2 prepare-2.0)
  • mto: This revision was merged to the branch mainline in revision 4689.
  • Revision ID: ian.clatworthy@canonical.com-20090909153059-sb038agvd38ci2q8
more link fixes in the User Guide

Show diffs side-by-side

added added

removed removed

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