~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/bzrdir.py

  • Committer: Patch Queue Manager
  • Date: 2015-09-30 16:43:21 UTC
  • mfrom: (6603.2.2 fix-keep-dirty)
  • Revision ID: pqm@pqm.ubuntu.com-20150930164321-ct2v2qnmvimqt8qf
(vila) Avoid associating dirty patch headers with the previous file in the
 patch. (Colin Watson)

Show diffs side-by-side

added added

removed removed

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