← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/bzrdir.py

  • Committer: Neil Martinsen-Burrell
  • Date: 2009-06-08 05:00:01 UTC
  • mto: (4441.1.1 bzr.ab.integration)
  • mto: This revision was merged to the branch mainline in revision 4443.
  • Revision ID: nmb@wartburg.edu-20090608050001-7znk3433urf3bf0p
Fix 269477 Add documentation about diverged branches and refer to it when pushing fails

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