~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/bzrdir.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2009-10-13 06:08:53 UTC
  • mfrom: (4737.1.1 merge-2.0-into-devel)
  • Revision ID: pqm@pqm.ubuntu.com-20091013060853-erk2aaj80fnkrv25
(andrew) Merge lp:bzr/2.0 into lp:bzr, including fixes for #322807,
        #389413, #402623 and documentation improvements.

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