← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/bzrdir.py

  • Committer: Martin Pool
  • Date: 2010-02-11 04:20:19 UTC
  • mto: This revision was merged to the branch mainline in revision 5029.
  • Revision ID: mbp@sourcefrog.net-20100211042019-o7e4sgd2z5b82mw3
Add vim modeline

Show diffs side-by-side

added added

removed removed

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