← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/bzrdir.py

  • Committer: Andrew Bennetts
  • Date: 2009-07-01 10:53:08 UTC
  • mto: This revision was merged to the branch mainline in revision 4504.
  • Revision ID: andrew.bennetts@canonical.com-20090701105308-8892qpe3lhikhe3g
Remove unused import.

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