← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/bzrdir.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2008-07-17 07:33:12 UTC
  • mfrom: (3530.3.3 btree-graphindex)
  • Revision ID: pqm@pqm.ubuntu.com-20080717073312-reglpowwyo671081
(robertc) Intern GraphIndex strings and handle frozenset inputs to
        make_mpdiffs in the case of errors. (Robert Collins, Andrew Bennetts)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/bzrdir.py
1
 
# Copyright (C) 2006-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008 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
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""BzrDir logic. The BzrDir is the basic control directory used by bzr.
18
18
 
27
27
 
28
28
# TODO: Move old formats into a plugin to make this file smaller.
29
29
 
 
30
from cStringIO import StringIO
30
31
import os
31
32
import sys
32
 
import warnings
33
33
 
34
34
from bzrlib.lazy_import import lazy_import
35
35
lazy_import(globals(), """
36
36
from stat import S_ISDIR
37
37
import textwrap
 
38
from warnings import warn
38
39
 
39
40
import bzrlib
40
41
from bzrlib import (
41
 
    branch,
42
42
    config,
43
43
    errors,
44
44
    graph,
45
45
    lockable_files,
46
46
    lockdir,
47
47
    osutils,
 
48
    registry,
48
49
    remote,
49
 
    repository,
50
50
    revision as _mod_revision,
 
51
    symbol_versioning,
51
52
    ui,
52
53
    urlutils,
53
54
    versionedfile,
58
59
    xml5,
59
60
    )
60
61
from bzrlib.osutils import (
 
62
    sha_strings,
61
63
    sha_string,
62
64
    )
63
 
from bzrlib.push import (
64
 
    PushResult,
65
 
    )
66
 
from bzrlib.repofmt import pack_repo
 
65
from bzrlib.repository import Repository
67
66
from bzrlib.smart.client import _SmartClient
 
67
from bzrlib.smart import protocol
68
68
from bzrlib.store.versioned import WeaveStore
69
69
from bzrlib.transactions import WriteTransaction
70
70
from bzrlib.transport import (
71
71
    do_catching_redirections,
72
72
    get_transport,
73
 
    local,
74
73
    )
75
74
from bzrlib.weave import Weave
76
75
""")
78
77
from bzrlib.trace import (
79
78
    mutter,
80
79
    note,
81
 
    warning,
82
 
    )
83
 
 
84
 
from bzrlib import (
85
 
    hooks,
86
 
    registry,
87
 
    symbol_versioning,
88
 
    )
89
 
    
90
 
    
91
 
class ControlComponent(object):
92
 
    """Abstract base class for control directory components.
93
 
    
94
 
    This provides interfaces that are common across bzrdirs, 
95
 
    repositories, branches, and workingtree control directories.
96
 
    
97
 
    They all expose two urls and transports: the *user* URL is the 
98
 
    one that stops above the control directory (eg .bzr) and that 
99
 
    should normally be used in messages, and the *control* URL is
100
 
    under that in eg .bzr/checkout and is used to read the control
101
 
    files.
102
 
    
103
 
    This can be used as a mixin and is intended to fit with 
104
 
    foreign formats.
105
 
    """
106
 
    
107
 
    @property
108
 
    def control_transport(self):
109
 
        raise NotImplementedError
110
 
   
111
 
    @property
112
 
    def control_url(self):
113
 
        return self.control_transport.base
114
 
    
115
 
    @property
116
 
    def user_transport(self):
117
 
        raise NotImplementedError
118
 
        
119
 
    @property
120
 
    def user_url(self):
121
 
        return self.user_transport.base
122
 
    
123
 
 
124
 
class BzrDir(ControlComponent):
 
80
    )
 
81
from bzrlib.transport.local import LocalTransport
 
82
from bzrlib.symbol_versioning import (
 
83
    deprecated_function,
 
84
    deprecated_method,
 
85
    )
 
86
 
 
87
 
 
88
class BzrDir(object):
125
89
    """A .bzr control diretory.
126
 
 
 
90
    
127
91
    BzrDir instances let you create or open any of the things that can be
128
92
    found within .bzr - checkouts, branches and repositories.
129
 
 
 
93
    
130
94
    :ivar transport:
131
95
        the transport which this bzr dir is rooted at (i.e. file:///.../.bzr/)
132
96
    :ivar root_transport:
134
98
        (i.e. the parent directory holding the .bzr directory).
135
99
 
136
100
    Everything in the bzrdir should have the same file permissions.
137
 
 
138
 
    :cvar hooks: An instance of BzrDirHooks.
139
101
    """
140
102
 
141
103
    def break_lock(self):
163
125
        return True
164
126
 
165
127
    def check_conversion_target(self, target_format):
166
 
        """Check that a bzrdir as a whole can be converted to a new format."""
167
 
        # The only current restriction is that the repository content can be 
168
 
        # fetched compatibly with the target.
169
128
        target_repo_format = target_format.repository_format
170
 
        try:
171
 
            self.open_repository()._format.check_conversion_target(
172
 
                target_repo_format)
173
 
        except errors.NoRepositoryPresent:
174
 
            # No repo, no problem.
175
 
            pass
 
129
        source_repo_format = self._format.repository_format
 
130
        source_repo_format.check_conversion_target(target_repo_format)
176
131
 
177
132
    @staticmethod
178
133
    def _check_supported(format, allow_unsupported,
180
135
        basedir=None):
181
136
        """Give an error or warning on old formats.
182
137
 
183
 
        :param format: may be any kind of format - workingtree, branch,
 
138
        :param format: may be any kind of format - workingtree, branch, 
184
139
        or repository.
185
140
 
186
 
        :param allow_unsupported: If true, allow opening
187
 
        formats that are strongly deprecated, and which may
 
141
        :param allow_unsupported: If true, allow opening 
 
142
        formats that are strongly deprecated, and which may 
188
143
        have limited functionality.
189
144
 
190
145
        :param recommend_upgrade: If true (default), warn
222
177
                                       preserve_stacking=preserve_stacking)
223
178
 
224
179
    def clone_on_transport(self, transport, revision_id=None,
225
 
        force_new_repo=False, preserve_stacking=False, stacked_on=None,
226
 
        create_prefix=False, use_existing_dir=True):
 
180
                           force_new_repo=False, preserve_stacking=False):
227
181
        """Clone this bzrdir and its contents to transport verbatim.
228
182
 
229
183
        :param transport: The transport for the location to produce the clone
235
189
                               even if one is available.
236
190
        :param preserve_stacking: When cloning a stacked branch, stack the
237
191
            new branch on top of the other branch's stacked-on branch.
238
 
        :param create_prefix: Create any missing directories leading up to
239
 
            to_transport.
240
 
        :param use_existing_dir: Use an existing directory if one exists.
241
192
        """
242
 
        # Overview: put together a broad description of what we want to end up
243
 
        # with; then make as few api calls as possible to do it.
244
 
        
245
 
        # We may want to create a repo/branch/tree, if we do so what format
246
 
        # would we want for each:
247
 
        require_stacking = (stacked_on is not None)
248
 
        format = self.cloning_metadir(require_stacking)
249
 
        
250
 
        # Figure out what objects we want:
 
193
        transport.ensure_base()
 
194
        result = self.cloning_metadir().initialize_on_transport(transport)
 
195
        repository_policy = None
 
196
        stack_on = None
251
197
        try:
252
198
            local_repo = self.find_repository()
253
199
        except errors.NoRepositoryPresent:
262
208
                local_repo = local_branch.repository
263
209
            if preserve_stacking:
264
210
                try:
265
 
                    stacked_on = local_branch.get_stacked_on_url()
 
211
                    stack_on = local_branch.get_stacked_on_url()
266
212
                except (errors.UnstackableBranchFormat,
267
213
                        errors.UnstackableRepositoryFormat,
268
214
                        errors.NotStacked):
269
215
                    pass
270
 
        # Bug: We create a metadir without knowing if it can support stacking,
271
 
        # we should look up the policy needs first, or just use it as a hint,
272
 
        # or something.
 
216
 
273
217
        if local_repo:
 
218
            # may need to copy content in
 
219
            repository_policy = result.determine_repository_policy(
 
220
                force_new_repo, stack_on)
274
221
            make_working_trees = local_repo.make_working_trees()
275
 
            want_shared = local_repo.is_shared()
276
 
            repo_format_name = format.repository_format.network_name()
277
 
        else:
278
 
            make_working_trees = False
279
 
            want_shared = False
280
 
            repo_format_name = None
281
 
 
282
 
        result_repo, result, require_stacking, repository_policy = \
283
 
            format.initialize_on_transport_ex(transport,
284
 
            use_existing_dir=use_existing_dir, create_prefix=create_prefix,
285
 
            force_new_repo=force_new_repo, stacked_on=stacked_on,
286
 
            stack_on_pwd=self.root_transport.base,
287
 
            repo_format_name=repo_format_name,
288
 
            make_working_trees=make_working_trees, shared_repo=want_shared)
289
 
        if repo_format_name:
290
 
            try:
291
 
                # If the result repository is in the same place as the
292
 
                # resulting bzr dir, it will have no content, further if the
293
 
                # result is not stacked then we know all content should be
294
 
                # copied, and finally if we are copying up to a specific
295
 
                # revision_id then we can use the pending-ancestry-result which
296
 
                # does not require traversing all of history to describe it.
297
 
                if (result_repo.user_url == result.user_url
298
 
                    and not require_stacking and
299
 
                    revision_id is not None):
300
 
                    fetch_spec = graph.PendingAncestryResult(
301
 
                        [revision_id], local_repo)
302
 
                    result_repo.fetch(local_repo, fetch_spec=fetch_spec)
303
 
                else:
304
 
                    result_repo.fetch(local_repo, revision_id=revision_id)
305
 
            finally:
306
 
                result_repo.unlock()
307
 
        else:
308
 
            if result_repo is not None:
309
 
                raise AssertionError('result_repo not None(%r)' % result_repo)
 
222
            result_repo = repository_policy.acquire_repository(
 
223
                make_working_trees, local_repo.is_shared())
 
224
            result_repo.fetch(local_repo, revision_id=revision_id)
 
225
        else:
 
226
            result_repo = None
310
227
        # 1 if there is a branch present
311
228
        #   make sure its content is available in the target repository
312
229
        #   clone it.
313
230
        if local_branch is not None:
314
 
            result_branch = local_branch.clone(result, revision_id=revision_id,
315
 
                repository_policy=repository_policy)
316
 
        try:
317
 
            # Cheaper to check if the target is not local, than to try making
318
 
            # the tree and fail.
319
 
            result.root_transport.local_abspath('.')
320
 
            if result_repo is None or result_repo.make_working_trees():
 
231
            result_branch = local_branch.clone(result, revision_id=revision_id)
 
232
            if repository_policy is not None:
 
233
                repository_policy.configure_branch(result_branch)
 
234
        if result_repo is None or result_repo.make_working_trees():
 
235
            try:
321
236
                self.open_workingtree().clone(result)
322
 
        except (errors.NoWorkingTree, errors.NotLocalUrl):
323
 
            pass
 
237
            except (errors.NoWorkingTree, errors.NotLocalUrl):
 
238
                pass
324
239
        return result
325
240
 
326
241
    # TODO: This should be given a Transport, and should chdir up; otherwise
332
247
    @classmethod
333
248
    def create(cls, base, format=None, possible_transports=None):
334
249
        """Create a new BzrDir at the url 'base'.
335
 
 
 
250
        
336
251
        :param format: If supplied, the format of branch to create.  If not
337
252
            supplied, the default is used.
338
 
        :param possible_transports: If supplied, a list of transports that
 
253
        :param possible_transports: If supplied, a list of transports that 
339
254
            can be reused to share a remote connection.
340
255
        """
341
256
        if cls is not BzrDir:
388
303
                for subdir in sorted(subdirs, reverse=True):
389
304
                    pending.append(current_transport.clone(subdir))
390
305
 
391
 
    def list_branches(self):
392
 
        """Return a sequence of all branches local to this control directory.
393
 
 
394
 
        """
395
 
        try:
396
 
            return [self.open_branch()]
397
 
        except errors.NotBranchError:
398
 
            return []
399
 
 
400
306
    @staticmethod
401
307
    def find_branches(transport):
402
308
        """Find all branches under a transport.
414
320
            except errors.NoRepositoryPresent:
415
321
                pass
416
322
            else:
417
 
                return False, ([], repository)
418
 
            return True, (bzrdir.list_branches(), None)
419
 
        ret = []
420
 
        for branches, repo in BzrDir.find_bzrdirs(transport,
421
 
                                                  evaluate=evaluate):
 
323
                return False, (None, repository)
 
324
            try:
 
325
                branch = bzrdir.open_branch()
 
326
            except errors.NotBranchError:
 
327
                return True, (None, None)
 
328
            else:
 
329
                return True, (branch, None)
 
330
        branches = []
 
331
        for branch, repo in BzrDir.find_bzrdirs(transport, evaluate=evaluate):
422
332
            if repo is not None:
423
 
                ret.extend(repo.find_branches())
424
 
            if branches is not None:
425
 
                ret.extend(branches)
426
 
        return ret
 
333
                branches.extend(repo.find_branches())
 
334
            if branch is not None:
 
335
                branches.append(branch)
 
336
        return branches
427
337
 
428
338
    def destroy_repository(self):
429
339
        """Destroy the repository in this BzrDir"""
430
340
        raise NotImplementedError(self.destroy_repository)
431
341
 
432
 
    def create_branch(self, name=None):
 
342
    def create_branch(self):
433
343
        """Create a branch in this BzrDir.
434
344
 
435
 
        :param name: Name of the colocated branch to create, None for
436
 
            the default branch.
437
 
 
438
345
        The bzrdir's format will control what branch format is created.
439
346
        For more control see BranchFormatXX.create(a_bzrdir).
440
347
        """
441
348
        raise NotImplementedError(self.create_branch)
442
349
 
443
 
    def destroy_branch(self, name=None):
444
 
        """Destroy a branch in this BzrDir.
445
 
        
446
 
        :param name: Name of the branch to destroy, None for the default 
447
 
            branch.
448
 
        """
 
350
    def destroy_branch(self):
 
351
        """Destroy the branch in this BzrDir"""
449
352
        raise NotImplementedError(self.destroy_branch)
450
353
 
451
354
    @staticmethod
453
356
        """Create a new BzrDir, Branch and Repository at the url 'base'.
454
357
 
455
358
        This will use the current default BzrDirFormat unless one is
456
 
        specified, and use whatever
 
359
        specified, and use whatever 
457
360
        repository format that that uses via bzrdir.create_branch and
458
361
        create_repository. If a shared repository is available that is used
459
362
        preferentially.
473
376
                                    stack_on_pwd=None, require_stacking=False):
474
377
        """Return an object representing a policy to use.
475
378
 
476
 
        This controls whether a new repository is created, and the format of
477
 
        that repository, or some existing shared repository used instead.
 
379
        This controls whether a new repository is created, or a shared
 
380
        repository used instead.
478
381
 
479
382
        If stack_on is supplied, will not seek a containing shared repo.
480
 
 
481
383
        :param force_new_repo: If True, require a new repository to be created.
482
384
        :param stack_on: If supplied, the location to stack on.  If not
483
385
            supplied, a default_stack_on location may be used.
489
391
            stack_on_pwd = None
490
392
            config = found_bzrdir.get_config()
491
393
            stop = False
492
 
            stack_on = config.get_default_stack_on()
493
 
            if stack_on is not None:
494
 
                stack_on_pwd = found_bzrdir.user_url
495
 
                stop = True
 
394
            if config is not None:
 
395
                stack_on = config.get_default_stack_on()
 
396
                if stack_on is not None:
 
397
                    stack_on_pwd = found_bzrdir.root_transport.base
 
398
                    stop = True
 
399
                    note('Using default stacking branch %s at %s', stack_on,
 
400
                         stack_on_pwd)
496
401
            # does it have a repository ?
497
402
            try:
498
403
                repository = found_bzrdir.open_repository()
499
404
            except errors.NoRepositoryPresent:
500
405
                repository = None
501
406
            else:
502
 
                if (found_bzrdir.user_url != self.user_url 
503
 
                    and not repository.is_shared()):
504
 
                    # Don't look higher, can't use a higher shared repo.
 
407
                if ((found_bzrdir.root_transport.base !=
 
408
                     self.root_transport.base) and not repository.is_shared()):
505
409
                    repository = None
506
 
                    stop = True
507
410
                else:
508
411
                    stop = True
509
412
            if not stop:
533
436
    def _find_or_create_repository(self, force_new_repo):
534
437
        """Create a new repository if needed, returning the repository."""
535
438
        policy = self.determine_repository_policy(force_new_repo)
536
 
        return policy.acquire_repository()[0]
 
439
        return policy.acquire_repository()
537
440
 
538
441
    @staticmethod
539
442
    def create_branch_convenience(base, force_new_repo=False,
546
449
        not.
547
450
 
548
451
        This will use the current default BzrDirFormat unless one is
549
 
        specified, and use whatever
 
452
        specified, and use whatever 
550
453
        repository format that that uses via bzrdir.create_branch and
551
454
        create_repository. If a shared repository is available that is used
552
455
        preferentially. Whatever repository is used, its tree creation policy
554
457
 
555
458
        The created Branch object is returned.
556
459
        If a working tree cannot be made due to base not being a file:// url,
557
 
        no error is raised unless force_new_tree is True, in which case no
 
460
        no error is raised unless force_new_tree is True, in which case no 
558
461
        data is created on disk and NotLocalUrl is raised.
559
462
 
560
463
        :param base: The URL to create the branch at.
561
464
        :param force_new_repo: If True a new repository is always created.
562
 
        :param force_new_tree: If True or False force creation of a tree or
 
465
        :param force_new_tree: If True or False force creation of a tree or 
563
466
                               prevent such creation respectively.
564
467
        :param format: Override for the bzrdir format to create.
565
468
        :param possible_transports: An optional reusable transports list.
567
470
        if force_new_tree:
568
471
            # check for non local urls
569
472
            t = get_transport(base, possible_transports)
570
 
            if not isinstance(t, local.LocalTransport):
 
473
            if not isinstance(t, LocalTransport):
571
474
                raise errors.NotLocalUrl(base)
572
475
        bzrdir = BzrDir.create(base, format, possible_transports)
573
476
        repo = bzrdir._find_or_create_repository(force_new_repo)
587
490
        'base' must be a local path or a file:// url.
588
491
 
589
492
        This will use the current default BzrDirFormat unless one is
590
 
        specified, and use whatever
 
493
        specified, and use whatever 
591
494
        repository format that that uses for bzrdirformat.create_workingtree,
592
495
        create_branch and create_repository.
593
496
 
595
498
        :return: The WorkingTree object.
596
499
        """
597
500
        t = get_transport(base)
598
 
        if not isinstance(t, local.LocalTransport):
 
501
        if not isinstance(t, LocalTransport):
599
502
            raise errors.NotLocalUrl(base)
600
503
        bzrdir = BzrDir.create_branch_and_repo(base,
601
504
                                               force_new_repo=True,
605
508
    def create_workingtree(self, revision_id=None, from_branch=None,
606
509
        accelerator_tree=None, hardlink=False):
607
510
        """Create a working tree at this BzrDir.
608
 
 
 
511
        
609
512
        :param revision_id: create it as of this revision id.
610
513
        :param from_branch: override bzrdir branch (for lightweight checkouts)
611
514
        :param accelerator_tree: A tree which can be used for retrieving file
615
518
        """
616
519
        raise NotImplementedError(self.create_workingtree)
617
520
 
618
 
    def backup_bzrdir(self):
619
 
        """Backup this bzr control directory.
620
 
 
621
 
        :return: Tuple with old path name and new path name
622
 
        """
623
 
        def name_gen(base='backup.bzr'):
624
 
            counter = 1
625
 
            name = "%s.~%d~" % (base, counter)
626
 
            while self.root_transport.has(name):
627
 
                counter += 1
628
 
                name = "%s.~%d~" % (base, counter)
629
 
            return name
630
 
 
631
 
        backup_dir=name_gen()
632
 
        pb = ui.ui_factory.nested_progress_bar()
633
 
        try:
634
 
            # FIXME: bug 300001 -- the backup fails if the backup directory
635
 
            # already exists, but it should instead either remove it or make
636
 
            # a new backup directory.
637
 
            #
638
 
            old_path = self.root_transport.abspath('.bzr')
639
 
            new_path = self.root_transport.abspath(backup_dir)
640
 
            ui.ui_factory.note('making backup of %s\n  to %s' % (old_path, new_path,))
641
 
            self.root_transport.copy_tree('.bzr', backup_dir)
642
 
            return (old_path, new_path)
643
 
        finally:
644
 
            pb.finished()
645
 
 
646
521
    def retire_bzrdir(self, limit=10000):
647
522
        """Permanently disable the bzrdir.
648
523
 
702
577
            if stop:
703
578
                return result
704
579
            next_transport = found_bzrdir.root_transport.clone('..')
705
 
            if (found_bzrdir.user_url == next_transport.base):
 
580
            if (found_bzrdir.root_transport.base == next_transport.base):
706
581
                # top of the file system
707
582
                return None
708
583
            # find the next containing bzrdir
725
600
                repository = found_bzrdir.open_repository()
726
601
            except errors.NoRepositoryPresent:
727
602
                return None, False
728
 
            if found_bzrdir.user_url == self.user_url:
 
603
            if found_bzrdir.root_transport.base == self.root_transport.base:
729
604
                return repository, True
730
605
            elif repository.is_shared():
731
606
                return repository, True
746
621
        """
747
622
        return None
748
623
 
749
 
    def get_branch_transport(self, branch_format, name=None):
 
624
    def get_branch_transport(self, branch_format):
750
625
        """Get the transport for use by branch format in this BzrDir.
751
626
 
752
627
        Note that bzr dirs that do not support format strings will raise
753
628
        IncompatibleFormat if the branch format they are given has
754
629
        a format string, and vice versa.
755
630
 
756
 
        If branch_format is None, the transport is returned with no
 
631
        If branch_format is None, the transport is returned with no 
757
632
        checking. If it is not None, then the returned transport is
758
633
        guaranteed to point to an existing directory ready for use.
759
634
        """
761
636
 
762
637
    def _find_creation_modes(self):
763
638
        """Determine the appropriate modes for files and directories.
764
 
 
 
639
        
765
640
        They're always set to be consistent with the base directory,
766
641
        assuming that this transport allows setting modes.
767
642
        """
780
655
            # directories and files are read-write for this user. This is
781
656
            # mostly a workaround for filesystems which lie about being able to
782
657
            # write to a directory (cygwin & win32)
783
 
            if (st.st_mode & 07777 == 00000):
784
 
                # FTP allows stat but does not return dir/file modes
785
 
                self._dir_mode = None
786
 
                self._file_mode = None
787
 
            else:
788
 
                self._dir_mode = (st.st_mode & 07777) | 00700
789
 
                # Remove the sticky and execute bits for files
790
 
                self._file_mode = self._dir_mode & ~07111
 
658
            self._dir_mode = (st.st_mode & 07777) | 00700
 
659
            # Remove the sticky and execute bits for files
 
660
            self._file_mode = self._dir_mode & ~07111
791
661
 
792
662
    def _get_file_mode(self):
793
663
        """Return Unix mode for newly created files, or None.
802
672
        if not self._mode_check_done:
803
673
            self._find_creation_modes()
804
674
        return self._dir_mode
805
 
 
 
675
        
806
676
    def get_repository_transport(self, repository_format):
807
677
        """Get the transport for use by repository format in this BzrDir.
808
678
 
810
680
        IncompatibleFormat if the repository format they are given has
811
681
        a format string, and vice versa.
812
682
 
813
 
        If repository_format is None, the transport is returned with no
 
683
        If repository_format is None, the transport is returned with no 
814
684
        checking. If it is not None, then the returned transport is
815
685
        guaranteed to point to an existing directory ready for use.
816
686
        """
817
687
        raise NotImplementedError(self.get_repository_transport)
818
 
 
 
688
        
819
689
    def get_workingtree_transport(self, tree_format):
820
690
        """Get the transport for use by workingtree format in this BzrDir.
821
691
 
823
693
        IncompatibleFormat if the workingtree format they are given has a
824
694
        format string, and vice versa.
825
695
 
826
 
        If workingtree_format is None, the transport is returned with no
 
696
        If workingtree_format is None, the transport is returned with no 
827
697
        checking. If it is not None, then the returned transport is
828
698
        guaranteed to point to an existing directory ready for use.
829
699
        """
830
700
        raise NotImplementedError(self.get_workingtree_transport)
831
701
 
832
702
    def get_config(self):
833
 
        """Get configuration for this BzrDir."""
834
 
        return config.BzrDirConfig(self)
835
 
 
836
 
    def _get_config(self):
837
 
        """By default, no configuration is available."""
838
 
        return None
 
703
        if getattr(self, '_get_config', None) is None:
 
704
            return None
 
705
        return self._get_config()
839
706
 
840
707
    def __init__(self, _transport, _format):
841
708
        """Initialize a Bzr control dir object.
842
 
 
 
709
        
843
710
        Only really common logic should reside here, concrete classes should be
844
711
        made with varying behaviours.
845
712
 
847
714
        :param _transport: the transport this dir is based at.
848
715
        """
849
716
        self._format = _format
850
 
        # these are also under the more standard names of 
851
 
        # control_transport and user_transport
852
717
        self.transport = _transport.clone('.bzr')
853
718
        self.root_transport = _transport
854
719
        self._mode_check_done = False
855
 
        
856
 
    @property 
857
 
    def user_transport(self):
858
 
        return self.root_transport
859
 
        
860
 
    @property
861
 
    def control_transport(self):
862
 
        return self.transport
863
720
 
864
721
    def is_control_filename(self, filename):
865
722
        """True if filename is the name of a path which is reserved for bzrdir's.
866
 
 
 
723
        
867
724
        :param filename: A filename within the root transport of this bzrdir.
868
725
 
869
726
        This is true IF and ONLY IF the filename is part of the namespace reserved
872
729
        this in the future - for instance to make bzr talk with svn working
873
730
        trees.
874
731
        """
875
 
        # this might be better on the BzrDirFormat class because it refers to
876
 
        # all the possible bzrdir disk formats.
877
 
        # This method is tested via the workingtree is_control_filename tests-
 
732
        # this might be better on the BzrDirFormat class because it refers to 
 
733
        # all the possible bzrdir disk formats. 
 
734
        # This method is tested via the workingtree is_control_filename tests- 
878
735
        # it was extracted from WorkingTree.is_control_filename. If the method's
879
736
        # contract is extended beyond the current trivial implementation, please
880
737
        # add new tests for it to the appropriate place.
882
739
 
883
740
    def needs_format_conversion(self, format=None):
884
741
        """Return true if this bzrdir needs convert_format run on it.
885
 
 
886
 
        For instance, if the repository format is out of date but the
 
742
        
 
743
        For instance, if the repository format is out of date but the 
887
744
        branch and working tree are not, this should return True.
888
745
 
889
746
        :param format: Optional parameter indicating a specific desired
895
752
    def open_unsupported(base):
896
753
        """Open a branch which is not supported."""
897
754
        return BzrDir.open(base, _unsupported=True)
898
 
 
 
755
        
899
756
    @staticmethod
900
757
    def open(base, _unsupported=False, possible_transports=None):
901
758
        """Open an existing bzrdir, rooted at 'base' (url).
902
 
 
 
759
        
903
760
        :param _unsupported: a private parameter to the BzrDir class.
904
761
        """
905
762
        t = get_transport(base, possible_transports=possible_transports)
913
770
        :param transport: Transport containing the bzrdir.
914
771
        :param _unsupported: private.
915
772
        """
916
 
        for hook in BzrDir.hooks['pre_open']:
917
 
            hook(transport)
918
 
        # Keep initial base since 'transport' may be modified while following
919
 
        # the redirections.
920
773
        base = transport.base
 
774
 
921
775
        def find_format(transport):
922
776
            return transport, BzrDirFormat.find_format(
923
777
                transport, _server_formats=_server_formats)
924
778
 
925
779
        def redirected(transport, e, redirection_notice):
926
 
            redirected_transport = transport._redirected_to(e.source, e.target)
927
 
            if redirected_transport is None:
928
 
                raise errors.NotBranchError(base)
 
780
            qualified_source = e.get_source_url()
 
781
            relpath = transport.relpath(qualified_source)
 
782
            if not e.target.endswith(relpath):
 
783
                # Not redirected to a branch-format, not a branch
 
784
                raise errors.NotBranchError(path=e.target)
 
785
            target = e.target[:-len(relpath)]
929
786
            note('%s is%s redirected to %s',
930
 
                 transport.base, e.permanently, redirected_transport.base)
931
 
            return redirected_transport
 
787
                 transport.base, e.permanently, target)
 
788
            # Let's try with a new transport
 
789
            # FIXME: If 'transport' has a qualifier, this should
 
790
            # be applied again to the new transport *iff* the
 
791
            # schemes used are the same. Uncomment this code
 
792
            # once the function (and tests) exist.
 
793
            # -- vila20070212
 
794
            #target = urlutils.copy_url_qualifiers(original, target)
 
795
            return get_transport(target)
932
796
 
933
797
        try:
934
798
            transport, format = do_catching_redirections(find_format,
940
804
        BzrDir._check_supported(format, _unsupported)
941
805
        return format.open(transport, _found=True)
942
806
 
943
 
    def open_branch(self, name=None, unsupported=False,
944
 
                    ignore_fallbacks=False):
 
807
    def open_branch(self, unsupported=False):
945
808
        """Open the branch object at this BzrDir if one is present.
946
809
 
947
810
        If unsupported is True, then no longer supported branch formats can
948
811
        still be opened.
949
 
 
 
812
        
950
813
        TODO: static convenience version of this?
951
814
        """
952
815
        raise NotImplementedError(self.open_branch)
954
817
    @staticmethod
955
818
    def open_containing(url, possible_transports=None):
956
819
        """Open an existing branch which contains url.
957
 
 
 
820
        
958
821
        :param url: url to search from.
959
822
        See open_containing_from_transport for more detail.
960
823
        """
961
824
        transport = get_transport(url, possible_transports)
962
825
        return BzrDir.open_containing_from_transport(transport)
963
 
 
 
826
    
964
827
    @staticmethod
965
828
    def open_containing_from_transport(a_transport):
966
829
        """Open an existing branch which contains a_transport.base.
969
832
 
970
833
        Basically we keep looking up until we find the control directory or
971
834
        run into the root.  If there isn't one, raises NotBranchError.
972
 
        If there is one and it is either an unrecognised format or an unsupported
 
835
        If there is one and it is either an unrecognised format or an unsupported 
973
836
        format, UnknownFormatError or UnsupportedFormatError are raised.
974
837
        If there is one, it is returned, along with the unused portion of url.
975
838
 
976
 
        :return: The BzrDir that contains the path, and a Unicode path
 
839
        :return: The BzrDir that contains the path, and a Unicode path 
977
840
                for the rest of the URL.
978
841
        """
979
842
        # this gets the normalised url back. I.e. '.' -> the full path.
1085
948
        """
1086
949
        raise NotImplementedError(self.open_workingtree)
1087
950
 
1088
 
    def has_branch(self, name=None):
 
951
    def has_branch(self):
1089
952
        """Tell if this bzrdir contains a branch.
1090
 
 
 
953
        
1091
954
        Note: if you're going to open the branch, you should just go ahead
1092
 
        and try, and not ask permission first.  (This method just opens the
1093
 
        branch and discards it, and that's somewhat expensive.)
 
955
        and try, and not ask permission first.  (This method just opens the 
 
956
        branch and discards it, and that's somewhat expensive.) 
1094
957
        """
1095
958
        try:
1096
 
            self.open_branch(name)
 
959
            self.open_branch()
1097
960
            return True
1098
961
        except errors.NotBranchError:
1099
962
            return False
1103
966
 
1104
967
        This will still raise an exception if the bzrdir has a workingtree that
1105
968
        is remote & inaccessible.
1106
 
 
 
969
        
1107
970
        Note: if you're going to open the working tree, you should just go ahead
1108
 
        and try, and not ask permission first.  (This method just opens the
1109
 
        workingtree and discards it, and that's somewhat expensive.)
 
971
        and try, and not ask permission first.  (This method just opens the 
 
972
        workingtree and discards it, and that's somewhat expensive.) 
1110
973
        """
1111
974
        try:
1112
975
            self.open_workingtree(recommend_upgrade=False)
1115
978
            return False
1116
979
 
1117
980
    def _cloning_metadir(self):
1118
 
        """Produce a metadir suitable for cloning with.
1119
 
 
1120
 
        :returns: (destination_bzrdir_format, source_repository)
1121
 
        """
 
981
        """Produce a metadir suitable for cloning with."""
1122
982
        result_format = self._format.__class__()
1123
983
        try:
1124
984
            try:
1125
 
                branch = self.open_branch(ignore_fallbacks=True)
 
985
                branch = self.open_branch()
1126
986
                source_repository = branch.repository
1127
 
                result_format._branch_format = branch._format
1128
987
            except errors.NotBranchError:
1129
988
                source_branch = None
1130
989
                source_repository = self.open_repository()
1135
994
            # the fix recommended in bug # 103195 - to delegate this choice the
1136
995
            # repository itself.
1137
996
            repo_format = source_repository._format
1138
 
            if isinstance(repo_format, remote.RemoteRepositoryFormat):
1139
 
                source_repository._ensure_real()
1140
 
                repo_format = source_repository._real_repository._format
1141
 
            result_format.repository_format = repo_format
 
997
            if not isinstance(repo_format, remote.RemoteRepositoryFormat):
 
998
                result_format.repository_format = repo_format
1142
999
        try:
1143
1000
            # TODO: Couldn't we just probe for the format in these cases,
1144
1001
            # rather than opening the whole tree?  It would be a little
1150
1007
            result_format.workingtree_format = tree._format.__class__()
1151
1008
        return result_format, source_repository
1152
1009
 
1153
 
    def cloning_metadir(self, require_stacking=False):
 
1010
    def cloning_metadir(self):
1154
1011
        """Produce a metadir suitable for cloning or sprouting with.
1155
1012
 
1156
1013
        These operations may produce workingtrees (yes, even though they're
1157
1014
        "cloning" something that doesn't have a tree), so a viable workingtree
1158
1015
        format must be selected.
1159
 
 
1160
 
        :require_stacking: If True, non-stackable formats will be upgraded
1161
 
            to similar stackable formats.
1162
 
        :returns: a BzrDirFormat with all component formats either set
1163
 
            appropriately or set to None if that component should not be
1164
 
            created.
1165
1016
        """
1166
1017
        format, repository = self._cloning_metadir()
1167
1018
        if format._workingtree_format is None:
1168
 
            # No tree in self.
1169
1019
            if repository is None:
1170
 
                # No repository either
1171
1020
                return format
1172
 
            # We have a repository, so set a working tree? (Why? This seems to
1173
 
            # contradict the stated return value in the docstring).
1174
1021
            tree_format = repository._format._matchingbzrdir.workingtree_format
1175
1022
            format.workingtree_format = tree_format.__class__()
1176
 
        if require_stacking:
1177
 
            format.require_stacking()
1178
1023
        return format
1179
1024
 
1180
1025
    def checkout_metadir(self):
1182
1027
 
1183
1028
    def sprout(self, url, revision_id=None, force_new_repo=False,
1184
1029
               recurse='down', possible_transports=None,
1185
 
               accelerator_tree=None, hardlink=False, stacked=False,
1186
 
               source_branch=None, create_tree_if_local=True):
 
1030
               accelerator_tree=None, hardlink=False, stacked=False):
1187
1031
        """Create a copy of this bzrdir prepared for use as a new line of
1188
1032
        development.
1189
1033
 
1204
1048
            where possible.
1205
1049
        :param stacked: If true, create a stacked branch referring to the
1206
1050
            location of this control directory.
1207
 
        :param create_tree_if_local: If true, a working-tree will be created
1208
 
            when working locally.
1209
1051
        """
1210
1052
        target_transport = get_transport(url, possible_transports)
1211
1053
        target_transport.ensure_base()
1212
 
        cloning_format = self.cloning_metadir(stacked)
1213
 
        # Create/update the result branch
 
1054
        cloning_format = self.cloning_metadir()
1214
1055
        result = cloning_format.initialize_on_transport(target_transport)
1215
 
        # if a stacked branch wasn't requested, we don't create one
1216
 
        # even if the origin was stacked
1217
 
        stacked_branch_url = None
1218
 
        if source_branch is not None:
 
1056
        try:
 
1057
            source_branch = self.open_branch()
 
1058
            source_repository = source_branch.repository
1219
1059
            if stacked:
1220
1060
                stacked_branch_url = self.root_transport.base
1221
 
            source_repository = source_branch.repository
1222
 
        else:
 
1061
            else:
 
1062
                try:
 
1063
                    stacked_branch_url = source_branch.get_stacked_on_url()
 
1064
                except (errors.NotStacked, errors.UnstackableBranchFormat,
 
1065
                    errors.UnstackableRepositoryFormat):
 
1066
                    stacked_branch_url = None
 
1067
        except errors.NotBranchError:
 
1068
            source_branch = None
1223
1069
            try:
1224
 
                source_branch = self.open_branch()
1225
 
                source_repository = source_branch.repository
1226
 
                if stacked:
1227
 
                    stacked_branch_url = self.root_transport.base
1228
 
            except errors.NotBranchError:
1229
 
                source_branch = None
1230
 
                try:
1231
 
                    source_repository = self.open_repository()
1232
 
                except errors.NoRepositoryPresent:
1233
 
                    source_repository = None
 
1070
                source_repository = self.open_repository()
 
1071
            except errors.NoRepositoryPresent:
 
1072
                source_repository = None
 
1073
            stacked_branch_url = None
1234
1074
        repository_policy = result.determine_repository_policy(
1235
1075
            force_new_repo, stacked_branch_url, require_stacking=stacked)
1236
 
        result_repo, is_new_repo = repository_policy.acquire_repository()
1237
 
        if is_new_repo and revision_id is not None and not stacked:
1238
 
            fetch_spec = graph.PendingAncestryResult(
1239
 
                [revision_id], source_repository)
1240
 
        else:
1241
 
            fetch_spec = None
 
1076
        result_repo = repository_policy.acquire_repository()
1242
1077
        if source_repository is not None:
1243
 
            # Fetch while stacked to prevent unstacked fetch from
1244
 
            # Branch.sprout.
1245
 
            if fetch_spec is None:
1246
 
                result_repo.fetch(source_repository, revision_id=revision_id)
1247
 
            else:
1248
 
                result_repo.fetch(source_repository, fetch_spec=fetch_spec)
 
1078
            result_repo.fetch(source_repository, revision_id=revision_id)
1249
1079
 
1250
 
        if source_branch is None:
1251
 
            # this is for sprouting a bzrdir without a branch; is that
1252
 
            # actually useful?
1253
 
            # Not especially, but it's part of the contract.
 
1080
        # Create/update the result branch
 
1081
        if source_branch is not None:
 
1082
            result_branch = source_branch.sprout(result,
 
1083
                revision_id=revision_id)
 
1084
        else:
1254
1085
            result_branch = result.create_branch()
1255
 
        else:
1256
 
            result_branch = source_branch.sprout(result,
1257
 
                revision_id=revision_id, repository_policy=repository_policy)
1258
 
        mutter("created new branch %r" % (result_branch,))
 
1086
        repository_policy.configure_branch(result_branch)
1259
1087
 
1260
1088
        # Create/update the result working tree
1261
 
        if (create_tree_if_local and
1262
 
            isinstance(target_transport, local.LocalTransport) and
1263
 
            (result_repo is None or result_repo.make_working_trees())):
 
1089
        if isinstance(target_transport, LocalTransport) and (
 
1090
            result_repo is None or result_repo.make_working_trees()):
1264
1091
            wt = result.create_workingtree(accelerator_tree=accelerator_tree,
1265
1092
                hardlink=hardlink)
1266
1093
            wt.lock_write()
1279
1106
                basis = wt.basis_tree()
1280
1107
                basis.lock_read()
1281
1108
                subtrees = basis.iter_references()
1282
 
            elif result_branch is not None:
1283
 
                basis = result_branch.basis_tree()
1284
 
                basis.lock_read()
1285
 
                subtrees = basis.iter_references()
1286
1109
            elif source_branch is not None:
1287
1110
                basis = source_branch.basis_tree()
1288
1111
                basis.lock_read()
1303
1126
                    basis.unlock()
1304
1127
        return result
1305
1128
 
1306
 
    def push_branch(self, source, revision_id=None, overwrite=False, 
1307
 
        remember=False, create_prefix=False):
1308
 
        """Push the source branch into this BzrDir."""
1309
 
        br_to = None
1310
 
        # If we can open a branch, use its direct repository, otherwise see
1311
 
        # if there is a repository without a branch.
1312
 
        try:
1313
 
            br_to = self.open_branch()
1314
 
        except errors.NotBranchError:
1315
 
            # Didn't find a branch, can we find a repository?
1316
 
            repository_to = self.find_repository()
1317
 
        else:
1318
 
            # Found a branch, so we must have found a repository
1319
 
            repository_to = br_to.repository
1320
 
 
1321
 
        push_result = PushResult()
1322
 
        push_result.source_branch = source
1323
 
        if br_to is None:
1324
 
            # We have a repository but no branch, copy the revisions, and then
1325
 
            # create a branch.
1326
 
            repository_to.fetch(source.repository, revision_id=revision_id)
1327
 
            br_to = source.clone(self, revision_id=revision_id)
1328
 
            if source.get_push_location() is None or remember:
1329
 
                source.set_push_location(br_to.base)
1330
 
            push_result.stacked_on = None
1331
 
            push_result.branch_push_result = None
1332
 
            push_result.old_revno = None
1333
 
            push_result.old_revid = _mod_revision.NULL_REVISION
1334
 
            push_result.target_branch = br_to
1335
 
            push_result.master_branch = None
1336
 
            push_result.workingtree_updated = False
1337
 
        else:
1338
 
            # We have successfully opened the branch, remember if necessary:
1339
 
            if source.get_push_location() is None or remember:
1340
 
                source.set_push_location(br_to.base)
1341
 
            try:
1342
 
                tree_to = self.open_workingtree()
1343
 
            except errors.NotLocalUrl:
1344
 
                push_result.branch_push_result = source.push(br_to, 
1345
 
                    overwrite, stop_revision=revision_id)
1346
 
                push_result.workingtree_updated = False
1347
 
            except errors.NoWorkingTree:
1348
 
                push_result.branch_push_result = source.push(br_to,
1349
 
                    overwrite, stop_revision=revision_id)
1350
 
                push_result.workingtree_updated = None # Not applicable
1351
 
            else:
1352
 
                tree_to.lock_write()
1353
 
                try:
1354
 
                    push_result.branch_push_result = source.push(
1355
 
                        tree_to.branch, overwrite, stop_revision=revision_id)
1356
 
                    tree_to.update()
1357
 
                finally:
1358
 
                    tree_to.unlock()
1359
 
                push_result.workingtree_updated = True
1360
 
            push_result.old_revno = push_result.branch_push_result.old_revno
1361
 
            push_result.old_revid = push_result.branch_push_result.old_revid
1362
 
            push_result.target_branch = \
1363
 
                push_result.branch_push_result.target_branch
1364
 
        return push_result
1365
 
 
1366
 
 
1367
 
class BzrDirHooks(hooks.Hooks):
1368
 
    """Hooks for BzrDir operations."""
1369
 
 
1370
 
    def __init__(self):
1371
 
        """Create the default hooks."""
1372
 
        hooks.Hooks.__init__(self)
1373
 
        self.create_hook(hooks.HookPoint('pre_open',
1374
 
            "Invoked before attempting to open a BzrDir with the transport "
1375
 
            "that the open will use.", (1, 14), None))
1376
 
        self.create_hook(hooks.HookPoint('post_repo_init',
1377
 
            "Invoked after a repository has been initialized. "
1378
 
            "post_repo_init is called with a "
1379
 
            "bzrlib.bzrdir.RepoInitHookParams.",
1380
 
            (2, 2), None))
1381
 
 
1382
 
# install the default hooks
1383
 
BzrDir.hooks = BzrDirHooks()
1384
 
 
1385
 
 
1386
 
class RepoInitHookParams(object):
1387
 
    """Object holding parameters passed to *_repo_init hooks.
1388
 
 
1389
 
    There are 4 fields that hooks may wish to access:
1390
 
 
1391
 
    :ivar repository: Repository created
1392
 
    :ivar format: Repository format
1393
 
    :ivar bzrdir: The bzrdir for the repository
1394
 
    :ivar shared: The repository is shared
1395
 
    """
1396
 
 
1397
 
    def __init__(self, repository, format, a_bzrdir, shared):
1398
 
        """Create a group of RepoInitHook parameters.
1399
 
 
1400
 
        :param repository: Repository created
1401
 
        :param format: Repository format
1402
 
        :param bzrdir: The bzrdir for the repository
1403
 
        :param shared: The repository is shared
1404
 
        """
1405
 
        self.repository = repository
1406
 
        self.format = format
1407
 
        self.bzrdir = a_bzrdir
1408
 
        self.shared = shared
1409
 
 
1410
 
    def __eq__(self, other):
1411
 
        return self.__dict__ == other.__dict__
1412
 
 
1413
 
    def __repr__(self):
1414
 
        if self.repository:
1415
 
            return "<%s for %s>" % (self.__class__.__name__,
1416
 
                self.repository)
1417
 
        else:
1418
 
            return "<%s for %s>" % (self.__class__.__name__,
1419
 
                self.bzrdir)
1420
 
 
1421
1129
 
1422
1130
class BzrDirPreSplitOut(BzrDir):
1423
1131
    """A common class for the all-in-one formats."""
1434
1142
        """Pre-splitout bzrdirs do not suffer from stale locks."""
1435
1143
        raise NotImplementedError(self.break_lock)
1436
1144
 
1437
 
    def cloning_metadir(self, require_stacking=False):
 
1145
    def cloning_metadir(self):
1438
1146
        """Produce a metadir suitable for cloning with."""
1439
 
        if require_stacking:
1440
 
            return format_registry.make_bzrdir('1.6')
1441
1147
        return self._format.__class__()
1442
1148
 
1443
1149
    def clone(self, url, revision_id=None, force_new_repo=False,
1449
1155
        preserve_stacking has no effect, since no source branch using this
1450
1156
        family of formats can be stacked, so there is no stacking to preserve.
1451
1157
        """
 
1158
        from bzrlib.workingtree import WorkingTreeFormat2
1452
1159
        self._make_tail(url)
1453
1160
        result = self._format._initialize_for_clone(url)
1454
1161
        self.open_repository().clone(result, revision_id=revision_id)
1455
1162
        from_branch = self.open_branch()
1456
1163
        from_branch.clone(result, revision_id=revision_id)
1457
1164
        try:
1458
 
            tree = self.open_workingtree()
 
1165
            self.open_workingtree().clone(result)
1459
1166
        except errors.NotLocalUrl:
1460
1167
            # make a new one, this format always has to have one.
1461
 
            result._init_workingtree()
1462
 
        else:
1463
 
            tree.clone(result)
 
1168
            try:
 
1169
                WorkingTreeFormat2().initialize(result)
 
1170
            except errors.NotLocalUrl:
 
1171
                # but we cannot do it for remote trees.
 
1172
                to_branch = result.open_branch()
 
1173
                WorkingTreeFormat2()._stub_initialize_remote(to_branch)
1464
1174
        return result
1465
1175
 
1466
 
    def create_branch(self, name=None):
 
1176
    def create_branch(self):
1467
1177
        """See BzrDir.create_branch."""
1468
 
        return self._format.get_branch_format().initialize(self, name=name)
 
1178
        return self.open_branch()
1469
1179
 
1470
 
    def destroy_branch(self, name=None):
 
1180
    def destroy_branch(self):
1471
1181
        """See BzrDir.destroy_branch."""
1472
1182
        raise errors.UnsupportedOperation(self.destroy_branch, self)
1473
1183
 
1484
1194
    def create_workingtree(self, revision_id=None, from_branch=None,
1485
1195
                           accelerator_tree=None, hardlink=False):
1486
1196
        """See BzrDir.create_workingtree."""
1487
 
        # The workingtree is sometimes created when the bzrdir is created,
1488
 
        # but not when cloning.
1489
 
 
1490
1197
        # this looks buggy but is not -really-
1491
1198
        # because this format creates the workingtree when the bzrdir is
1492
1199
        # created
1494
1201
        # and that will have set it for us, its only
1495
1202
        # specific uses of create_workingtree in isolation
1496
1203
        # that can do wonky stuff here, and that only
1497
 
        # happens for creating checkouts, which cannot be
 
1204
        # happens for creating checkouts, which cannot be 
1498
1205
        # done on this format anyway. So - acceptable wart.
1499
 
        if hardlink:
1500
 
            warning("can't support hardlinked working trees in %r"
1501
 
                % (self,))
1502
 
        try:
1503
 
            result = self.open_workingtree(recommend_upgrade=False)
1504
 
        except errors.NoSuchFile:
1505
 
            result = self._init_workingtree()
 
1206
        result = self.open_workingtree(recommend_upgrade=False)
1506
1207
        if revision_id is not None:
1507
1208
            if revision_id == _mod_revision.NULL_REVISION:
1508
1209
                result.set_parent_ids([])
1510
1211
                result.set_parent_ids([revision_id])
1511
1212
        return result
1512
1213
 
1513
 
    def _init_workingtree(self):
1514
 
        from bzrlib.workingtree import WorkingTreeFormat2
1515
 
        try:
1516
 
            return WorkingTreeFormat2().initialize(self)
1517
 
        except errors.NotLocalUrl:
1518
 
            # Even though we can't access the working tree, we need to
1519
 
            # create its control files.
1520
 
            return WorkingTreeFormat2()._stub_initialize_on_transport(
1521
 
                self.transport, self._control_files._file_mode)
1522
 
 
1523
1214
    def destroy_workingtree(self):
1524
1215
        """See BzrDir.destroy_workingtree."""
1525
1216
        raise errors.UnsupportedOperation(self.destroy_workingtree, self)
1526
1217
 
1527
1218
    def destroy_workingtree_metadata(self):
1528
1219
        """See BzrDir.destroy_workingtree_metadata."""
1529
 
        raise errors.UnsupportedOperation(self.destroy_workingtree_metadata,
 
1220
        raise errors.UnsupportedOperation(self.destroy_workingtree_metadata, 
1530
1221
                                          self)
1531
1222
 
1532
 
    def get_branch_transport(self, branch_format, name=None):
 
1223
    def get_branch_transport(self, branch_format):
1533
1224
        """See BzrDir.get_branch_transport()."""
1534
 
        if name is not None:
1535
 
            raise errors.NoColocatedBranchSupport(self)
1536
1225
        if branch_format is None:
1537
1226
            return self.transport
1538
1227
        try:
1566
1255
        # if the format is not the same as the system default,
1567
1256
        # an upgrade is needed.
1568
1257
        if format is None:
1569
 
            symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1570
 
                % 'needs_format_conversion(format=None)')
1571
1258
            format = BzrDirFormat.get_default_format()
1572
1259
        return not isinstance(self._format, format.__class__)
1573
1260
 
1574
 
    def open_branch(self, name=None, unsupported=False,
1575
 
                    ignore_fallbacks=False):
 
1261
    def open_branch(self, unsupported=False):
1576
1262
        """See BzrDir.open_branch."""
1577
1263
        from bzrlib.branch import BzrBranchFormat4
1578
1264
        format = BzrBranchFormat4()
1579
1265
        self._check_supported(format, unsupported)
1580
 
        return format.open(self, name, _found=True)
 
1266
        return format.open(self, _found=True)
1581
1267
 
1582
1268
    def sprout(self, url, revision_id=None, force_new_repo=False,
1583
1269
               possible_transports=None, accelerator_tree=None,
1584
 
               hardlink=False, stacked=False, create_tree_if_local=True,
1585
 
               source_branch=None):
 
1270
               hardlink=False, stacked=False):
1586
1271
        """See BzrDir.sprout()."""
1587
 
        if source_branch is not None:
1588
 
            my_branch = self.open_branch()
1589
 
            if source_branch.base != my_branch.base:
1590
 
                raise AssertionError(
1591
 
                    "source branch %r is not within %r with branch %r" %
1592
 
                    (source_branch, self, my_branch))
1593
1272
        if stacked:
1594
1273
            raise errors.UnstackableBranchFormat(
1595
1274
                self._format, self.root_transport.base)
1596
 
        if not create_tree_if_local:
1597
 
            raise errors.MustHaveWorkingTree(
1598
 
                self._format, self.root_transport.base)
1599
1275
        from bzrlib.workingtree import WorkingTreeFormat2
1600
1276
        self._make_tail(url)
1601
1277
        result = self._format._initialize_for_clone(url)
1607
1283
            self.open_branch().sprout(result, revision_id=revision_id)
1608
1284
        except errors.NotBranchError:
1609
1285
            pass
1610
 
 
1611
1286
        # we always want a working tree
1612
1287
        WorkingTreeFormat2().initialize(result,
1613
1288
                                        accelerator_tree=accelerator_tree,
1617
1292
 
1618
1293
class BzrDir4(BzrDirPreSplitOut):
1619
1294
    """A .bzr version 4 control object.
1620
 
 
 
1295
    
1621
1296
    This is a deprecated format and may be removed after sept 2006.
1622
1297
    """
1623
1298
 
1627
1302
 
1628
1303
    def needs_format_conversion(self, format=None):
1629
1304
        """Format 4 dirs are always in need of conversion."""
1630
 
        if format is None:
1631
 
            symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1632
 
                % 'needs_format_conversion(format=None)')
1633
1305
        return True
1634
1306
 
1635
1307
    def open_repository(self):
1644
1316
    This is a deprecated format and may be removed after sept 2006.
1645
1317
    """
1646
1318
 
1647
 
    def has_workingtree(self):
1648
 
        """See BzrDir.has_workingtree."""
1649
 
        return True
1650
 
    
1651
1319
    def open_repository(self):
1652
1320
        """See BzrDir.open_repository."""
1653
1321
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
1669
1337
    This is a deprecated format and may be removed after sept 2006.
1670
1338
    """
1671
1339
 
1672
 
    def has_workingtree(self):
1673
 
        """See BzrDir.has_workingtree."""
1674
 
        return True
1675
 
    
1676
1340
    def open_repository(self):
1677
1341
        """See BzrDir.open_repository."""
1678
1342
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
1689
1353
 
1690
1354
class BzrDirMeta1(BzrDir):
1691
1355
    """A .bzr meta version 1 control object.
1692
 
 
1693
 
    This is the first control object where the
 
1356
    
 
1357
    This is the first control object where the 
1694
1358
    individual aspects are really split out: there are separate repository,
1695
1359
    workingtree and branch subdirectories and any subset of the three can be
1696
1360
    present within a BzrDir.
1700
1364
        """See BzrDir.can_convert_format()."""
1701
1365
        return True
1702
1366
 
1703
 
    def create_branch(self, name=None):
 
1367
    def create_branch(self):
1704
1368
        """See BzrDir.create_branch."""
1705
 
        return self._format.get_branch_format().initialize(self, name=name)
 
1369
        return self._format.get_branch_format().initialize(self)
1706
1370
 
1707
 
    def destroy_branch(self, name=None):
 
1371
    def destroy_branch(self):
1708
1372
        """See BzrDir.create_branch."""
1709
 
        if name is not None:
1710
 
            raise errors.NoColocatedBranchSupport(self)
1711
1373
        self.transport.delete_tree('branch')
1712
1374
 
1713
1375
    def create_repository(self, shared=False):
1756
1418
        format = BranchFormat.find_format(self)
1757
1419
        return format.get_reference(self)
1758
1420
 
1759
 
    def get_branch_transport(self, branch_format, name=None):
 
1421
    def get_branch_transport(self, branch_format):
1760
1422
        """See BzrDir.get_branch_transport()."""
1761
 
        if name is not None:
1762
 
            raise errors.NoColocatedBranchSupport(self)
1763
 
        # XXX: this shouldn't implicitly create the directory if it's just
1764
 
        # promising to get a transport -- mbp 20090727
1765
1423
        if branch_format is None:
1766
1424
            return self.transport.clone('branch')
1767
1425
        try:
1802
1460
            pass
1803
1461
        return self.transport.clone('checkout')
1804
1462
 
1805
 
    def has_workingtree(self):
1806
 
        """Tell if this bzrdir contains a working tree.
1807
 
 
1808
 
        This will still raise an exception if the bzrdir has a workingtree that
1809
 
        is remote & inaccessible.
1810
 
 
1811
 
        Note: if you're going to open the working tree, you should just go
1812
 
        ahead and try, and not ask permission first.
1813
 
        """
1814
 
        from bzrlib.workingtree import WorkingTreeFormat
1815
 
        try:
1816
 
            WorkingTreeFormat.find_format(self)
1817
 
        except errors.NoWorkingTree:
1818
 
            return False
1819
 
        return True
1820
 
 
1821
1463
    def needs_format_conversion(self, format=None):
1822
1464
        """See BzrDir.needs_format_conversion()."""
1823
1465
        if format is None:
1824
 
            symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1825
 
                % 'needs_format_conversion(format=None)')
1826
 
        if format is None:
1827
1466
            format = BzrDirFormat.get_default_format()
1828
1467
        if not isinstance(self._format, format.__class__):
1829
1468
            # it is not a meta dir format, conversion is needed.
1836
1475
                return True
1837
1476
        except errors.NoRepositoryPresent:
1838
1477
            pass
1839
 
        for branch in self.list_branches():
1840
 
            if not isinstance(branch._format,
 
1478
        try:
 
1479
            if not isinstance(self.open_branch()._format,
1841
1480
                              format.get_branch_format().__class__):
1842
1481
                # the branch needs an upgrade.
1843
1482
                return True
 
1483
        except errors.NotBranchError:
 
1484
            pass
1844
1485
        try:
1845
1486
            my_wt = self.open_workingtree(recommend_upgrade=False)
1846
1487
            if not isinstance(my_wt._format,
1851
1492
            pass
1852
1493
        return False
1853
1494
 
1854
 
    def open_branch(self, name=None, unsupported=False,
1855
 
                    ignore_fallbacks=False):
 
1495
    def open_branch(self, unsupported=False):
1856
1496
        """See BzrDir.open_branch."""
1857
1497
        format = self.find_branch_format()
1858
1498
        self._check_supported(format, unsupported)
1859
 
        return format.open(self, name=name,
1860
 
            _found=True, ignore_fallbacks=ignore_fallbacks)
 
1499
        return format.open(self, _found=True)
1861
1500
 
1862
1501
    def open_repository(self, unsupported=False):
1863
1502
        """See BzrDir.open_repository."""
1877
1516
        return format.open(self, _found=True)
1878
1517
 
1879
1518
    def _get_config(self):
1880
 
        return config.TransportConfig(self.transport, 'control.conf')
 
1519
        return config.BzrDirConfig(self.transport)
1881
1520
 
1882
1521
 
1883
1522
class BzrDirFormat(object):
1888
1527
     * a format string,
1889
1528
     * an open routine.
1890
1529
 
1891
 
    Formats are placed in a dict by their format string for reference
 
1530
    Formats are placed in a dict by their format string for reference 
1892
1531
    during bzrdir opening. These should be subclasses of BzrDirFormat
1893
1532
    for consistency.
1894
1533
 
1895
1534
    Once a format is deprecated, just deprecate the initialize and open
1896
 
    methods on the format class. Do not deprecate the object, as the
 
1535
    methods on the format class. Do not deprecate the object, as the 
1897
1536
    object will be created every system load.
1898
 
 
1899
 
    :cvar colocated_branches: Whether this formats supports colocated branches.
1900
1537
    """
1901
1538
 
1902
1539
    _default_format = None
1907
1544
 
1908
1545
    _control_formats = []
1909
1546
    """The registered control formats - .bzr, ....
1910
 
 
 
1547
    
1911
1548
    This is a list of BzrDirFormat objects.
1912
1549
    """
1913
1550
 
1919
1556
 
1920
1557
    _lock_file_name = 'branch-lock'
1921
1558
 
1922
 
    colocated_branches = False
1923
 
    """Whether co-located branches are supported for this control dir format.
1924
 
    """
1925
 
 
1926
1559
    # _lock_class must be set in subclasses to the lock type, typ.
1927
1560
    # TransportLock or LockDir
1928
1561
 
1945
1578
    def probe_transport(klass, transport):
1946
1579
        """Return the .bzrdir style format present in a directory."""
1947
1580
        try:
1948
 
            format_string = transport.get_bytes(".bzr/branch-format")
 
1581
            format_string = transport.get(".bzr/branch-format").read()
1949
1582
        except errors.NoSuchFile:
1950
1583
            raise errors.NotBranchError(path=transport.base)
1951
1584
 
1976
1609
        current default format. In the case of plugins we can/should provide
1977
1610
        some means for them to extend the range of returnable converters.
1978
1611
 
1979
 
        :param format: Optional format to override the default format of the
 
1612
        :param format: Optional format to override the default format of the 
1980
1613
                       library.
1981
1614
        """
1982
1615
        raise NotImplementedError(self.get_converter)
1983
1616
 
1984
1617
    def initialize(self, url, possible_transports=None):
1985
1618
        """Create a bzr control dir at this url and return an opened copy.
1986
 
 
1987
 
        While not deprecated, this method is very specific and its use will
1988
 
        lead to many round trips to setup a working environment. See
1989
 
        initialize_on_transport_ex for a [nearly] all-in-one method.
1990
 
 
 
1619
        
1991
1620
        Subclasses should typically override initialize_on_transport
1992
1621
        instead of this method.
1993
1622
        """
1996
1625
 
1997
1626
    def initialize_on_transport(self, transport):
1998
1627
        """Initialize a new bzrdir in the base directory of a Transport."""
1999
 
        try:
2000
 
            # can we hand off the request to the smart server rather than using
2001
 
            # vfs calls?
2002
 
            client_medium = transport.get_smart_medium()
2003
 
        except errors.NoSmartMedium:
2004
 
            return self._initialize_on_transport_vfs(transport)
2005
 
        else:
2006
 
            # Current RPC's only know how to create bzr metadir1 instances, so
2007
 
            # we still delegate to vfs methods if the requested format is not a
2008
 
            # metadir1
2009
 
            if type(self) != BzrDirMetaFormat1:
2010
 
                return self._initialize_on_transport_vfs(transport)
2011
 
            remote_format = RemoteBzrDirFormat()
2012
 
            self._supply_sub_formats_to(remote_format)
2013
 
            return remote_format.initialize_on_transport(transport)
2014
 
 
2015
 
    def initialize_on_transport_ex(self, transport, use_existing_dir=False,
2016
 
        create_prefix=False, force_new_repo=False, stacked_on=None,
2017
 
        stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
2018
 
        shared_repo=False, vfs_only=False):
2019
 
        """Create this format on transport.
2020
 
 
2021
 
        The directory to initialize will be created.
2022
 
 
2023
 
        :param force_new_repo: Do not use a shared repository for the target,
2024
 
                               even if one is available.
2025
 
        :param create_prefix: Create any missing directories leading up to
2026
 
            to_transport.
2027
 
        :param use_existing_dir: Use an existing directory if one exists.
2028
 
        :param stacked_on: A url to stack any created branch on, None to follow
2029
 
            any target stacking policy.
2030
 
        :param stack_on_pwd: If stack_on is relative, the location it is
2031
 
            relative to.
2032
 
        :param repo_format_name: If non-None, a repository will be
2033
 
            made-or-found. Should none be found, or if force_new_repo is True
2034
 
            the repo_format_name is used to select the format of repository to
2035
 
            create.
2036
 
        :param make_working_trees: Control the setting of make_working_trees
2037
 
            for a new shared repository when one is made. None to use whatever
2038
 
            default the format has.
2039
 
        :param shared_repo: Control whether made repositories are shared or
2040
 
            not.
2041
 
        :param vfs_only: If True do not attempt to use a smart server
2042
 
        :return: repo, bzrdir, require_stacking, repository_policy. repo is
2043
 
            None if none was created or found, bzrdir is always valid.
2044
 
            require_stacking is the result of examining the stacked_on
2045
 
            parameter and any stacking policy found for the target.
2046
 
        """
2047
 
        if not vfs_only:
2048
 
            # Try to hand off to a smart server 
2049
 
            try:
2050
 
                client_medium = transport.get_smart_medium()
2051
 
            except errors.NoSmartMedium:
2052
 
                pass
2053
 
            else:
2054
 
                # TODO: lookup the local format from a server hint.
2055
 
                remote_dir_format = RemoteBzrDirFormat()
2056
 
                remote_dir_format._network_name = self.network_name()
2057
 
                self._supply_sub_formats_to(remote_dir_format)
2058
 
                return remote_dir_format.initialize_on_transport_ex(transport,
2059
 
                    use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2060
 
                    force_new_repo=force_new_repo, stacked_on=stacked_on,
2061
 
                    stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2062
 
                    make_working_trees=make_working_trees, shared_repo=shared_repo)
2063
 
        # XXX: Refactor the create_prefix/no_create_prefix code into a
2064
 
        #      common helper function
2065
 
        # The destination may not exist - if so make it according to policy.
2066
 
        def make_directory(transport):
2067
 
            transport.mkdir('.')
2068
 
            return transport
2069
 
        def redirected(transport, e, redirection_notice):
2070
 
            note(redirection_notice)
2071
 
            return transport._redirected_to(e.source, e.target)
2072
 
        try:
2073
 
            transport = do_catching_redirections(make_directory, transport,
2074
 
                redirected)
2075
 
        except errors.FileExists:
2076
 
            if not use_existing_dir:
2077
 
                raise
2078
 
        except errors.NoSuchFile:
2079
 
            if not create_prefix:
2080
 
                raise
2081
 
            transport.create_prefix()
2082
 
 
2083
 
        require_stacking = (stacked_on is not None)
2084
 
        # Now the target directory exists, but doesn't have a .bzr
2085
 
        # directory. So we need to create it, along with any work to create
2086
 
        # all of the dependent branches, etc.
2087
 
 
2088
 
        result = self.initialize_on_transport(transport)
2089
 
        if repo_format_name:
2090
 
            try:
2091
 
                # use a custom format
2092
 
                result._format.repository_format = \
2093
 
                    repository.network_format_registry.get(repo_format_name)
2094
 
            except AttributeError:
2095
 
                # The format didn't permit it to be set.
2096
 
                pass
2097
 
            # A repository is desired, either in-place or shared.
2098
 
            repository_policy = result.determine_repository_policy(
2099
 
                force_new_repo, stacked_on, stack_on_pwd,
2100
 
                require_stacking=require_stacking)
2101
 
            result_repo, is_new_repo = repository_policy.acquire_repository(
2102
 
                make_working_trees, shared_repo)
2103
 
            if not require_stacking and repository_policy._require_stacking:
2104
 
                require_stacking = True
2105
 
                result._format.require_stacking()
2106
 
            result_repo.lock_write()
2107
 
        else:
2108
 
            result_repo = None
2109
 
            repository_policy = None
2110
 
        return result_repo, result, require_stacking, repository_policy
2111
 
 
2112
 
    def _initialize_on_transport_vfs(self, transport):
2113
 
        """Initialize a new bzrdir using VFS calls.
2114
 
 
2115
 
        :param transport: The transport to create the .bzr directory in.
2116
 
        :return: A
2117
 
        """
2118
 
        # Since we are creating a .bzr directory, inherit the
 
1628
        # Since we don't have a .bzr directory, inherit the
2119
1629
        # mode from the root directory
2120
1630
        temp_control = lockable_files.LockableFiles(transport,
2121
1631
                            '', lockable_files.TransportLock)
2123
1633
                                      # FIXME: RBC 20060121 don't peek under
2124
1634
                                      # the covers
2125
1635
                                      mode=temp_control._dir_mode)
2126
 
        if sys.platform == 'win32' and isinstance(transport, local.LocalTransport):
 
1636
        if sys.platform == 'win32' and isinstance(transport, LocalTransport):
2127
1637
            win32utils.set_file_attr_hidden(transport._abspath('.bzr'))
2128
1638
        file_mode = temp_control._file_mode
2129
1639
        del temp_control
2151
1661
        """Is this format supported?
2152
1662
 
2153
1663
        Supported formats must be initializable and openable.
2154
 
        Unsupported formats may not support initialization or committing or
 
1664
        Unsupported formats may not support initialization or committing or 
2155
1665
        some other features depending on the reason for not being supported.
2156
1666
        """
2157
1667
        return True
2158
1668
 
2159
 
    def network_name(self):
2160
 
        """A simple byte string uniquely identifying this format for RPC calls.
2161
 
 
2162
 
        Bzr control formats use thir disk format string to identify the format
2163
 
        over the wire. Its possible that other control formats have more
2164
 
        complex detection requirements, so we permit them to use any unique and
2165
 
        immutable string they desire.
2166
 
        """
2167
 
        raise NotImplementedError(self.network_name)
2168
 
 
2169
1669
    def same_model(self, target_format):
2170
 
        return (self.repository_format.rich_root_data ==
 
1670
        return (self.repository_format.rich_root_data == 
2171
1671
            target_format.rich_root_data)
2172
1672
 
2173
1673
    @classmethod
2174
1674
    def known_formats(klass):
2175
1675
        """Return all the known formats.
2176
 
 
 
1676
        
2177
1677
        Concrete formats should override _known_formats.
2178
1678
        """
2179
 
        # There is double indirection here to make sure that control
2180
 
        # formats used by more than one dir format will only be probed
 
1679
        # There is double indirection here to make sure that control 
 
1680
        # formats used by more than one dir format will only be probed 
2181
1681
        # once. This can otherwise be quite expensive for remote connections.
2182
1682
        result = set()
2183
1683
        for format in klass._control_formats:
2184
1684
            result.update(format._known_formats())
2185
1685
        return result
2186
 
 
 
1686
    
2187
1687
    @classmethod
2188
1688
    def _known_formats(klass):
2189
1689
        """Return the known format instances for this control format."""
2191
1691
 
2192
1692
    def open(self, transport, _found=False):
2193
1693
        """Return an instance of this format for the dir transport points at.
2194
 
 
 
1694
        
2195
1695
        _found is a private parameter, do not use it.
2196
1696
        """
2197
1697
        if not _found:
2198
1698
            found_format = BzrDirFormat.find_format(transport)
2199
1699
            if not isinstance(found_format, self.__class__):
2200
1700
                raise AssertionError("%s was asked to open %s, but it seems to need "
2201
 
                        "format %s"
 
1701
                        "format %s" 
2202
1702
                        % (self, transport, found_format))
2203
 
            # Allow subclasses - use the found format.
2204
 
            self._supply_sub_formats_to(found_format)
2205
 
            return found_format._open(transport)
2206
1703
        return self._open(transport)
2207
1704
 
2208
1705
    def _open(self, transport):
2216
1713
    @classmethod
2217
1714
    def register_format(klass, format):
2218
1715
        klass._formats[format.get_format_string()] = format
2219
 
        # bzr native formats have a network name of their format string.
2220
 
        network_format_registry.register(format.get_format_string(), format.__class__)
2221
1716
 
2222
1717
    @classmethod
2223
1718
    def register_control_format(klass, format):
2224
1719
        """Register a format that does not use '.bzr' for its control dir.
2225
1720
 
2226
1721
        TODO: This should be pulled up into a 'ControlDirFormat' base class
2227
 
        which BzrDirFormat can inherit from, and renamed to register_format
 
1722
        which BzrDirFormat can inherit from, and renamed to register_format 
2228
1723
        there. It has been done without that for now for simplicity of
2229
1724
        implementation.
2230
1725
        """
2248
1743
 
2249
1744
    def __str__(self):
2250
1745
        # Trim the newline
2251
 
        return self.get_format_description().rstrip()
2252
 
 
2253
 
    def _supply_sub_formats_to(self, other_format):
2254
 
        """Give other_format the same values for sub formats as this has.
2255
 
 
2256
 
        This method is expected to be used when parameterising a
2257
 
        RemoteBzrDirFormat instance with the parameters from a
2258
 
        BzrDirMetaFormat1 instance.
2259
 
 
2260
 
        :param other_format: other_format is a format which should be
2261
 
            compatible with whatever sub formats are supported by self.
2262
 
        :return: None.
2263
 
        """
 
1746
        return self.get_format_string().rstrip()
2264
1747
 
2265
1748
    @classmethod
2266
1749
    def unregister_format(klass, format):
2298
1781
        """See BzrDirFormat.get_converter()."""
2299
1782
        # there is one and only one upgrade path here.
2300
1783
        return ConvertBzrDir4To5()
2301
 
 
 
1784
        
2302
1785
    def initialize_on_transport(self, transport):
2303
1786
        """Format 4 branches cannot be created."""
2304
1787
        raise errors.UninitializableFormat(self)
2307
1790
        """Format 4 is not supported.
2308
1791
 
2309
1792
        It is not supported because the model changed from 4 to 5 and the
2310
 
        conversion logic is expensive - so doing it on the fly was not
 
1793
        conversion logic is expensive - so doing it on the fly was not 
2311
1794
        feasible.
2312
1795
        """
2313
1796
        return False
2314
1797
 
2315
 
    def network_name(self):
2316
 
        return self.get_format_string()
2317
 
 
2318
1798
    def _open(self, transport):
2319
1799
        """See BzrDirFormat._open."""
2320
1800
        return BzrDir4(transport, self)
2326
1806
    repository_format = property(__return_repository_format)
2327
1807
 
2328
1808
 
2329
 
class BzrDirFormatAllInOne(BzrDirFormat):
2330
 
    """Common class for formats before meta-dirs."""
2331
 
 
2332
 
    def initialize_on_transport_ex(self, transport, use_existing_dir=False,
2333
 
        create_prefix=False, force_new_repo=False, stacked_on=None,
2334
 
        stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
2335
 
        shared_repo=False):
2336
 
        """See BzrDirFormat.initialize_on_transport_ex."""
2337
 
        require_stacking = (stacked_on is not None)
2338
 
        # Format 5 cannot stack, but we've been asked to - actually init
2339
 
        # a Meta1Dir
2340
 
        if require_stacking:
2341
 
            format = BzrDirMetaFormat1()
2342
 
            return format.initialize_on_transport_ex(transport,
2343
 
                use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2344
 
                force_new_repo=force_new_repo, stacked_on=stacked_on,
2345
 
                stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2346
 
                make_working_trees=make_working_trees, shared_repo=shared_repo)
2347
 
        return BzrDirFormat.initialize_on_transport_ex(self, transport,
2348
 
            use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2349
 
            force_new_repo=force_new_repo, stacked_on=stacked_on,
2350
 
            stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2351
 
            make_working_trees=make_working_trees, shared_repo=shared_repo)
2352
 
 
2353
 
 
2354
 
class BzrDirFormat5(BzrDirFormatAllInOne):
 
1809
class BzrDirFormat5(BzrDirFormat):
2355
1810
    """Bzr control format 5.
2356
1811
 
2357
1812
    This format is a combined format for working tree, branch and repository.
2358
1813
    It has:
2359
 
     - Format 2 working trees [always]
2360
 
     - Format 4 branches [always]
 
1814
     - Format 2 working trees [always] 
 
1815
     - Format 4 branches [always] 
2361
1816
     - Format 5 repositories [always]
2362
1817
       Unhashed stores in the repository.
2363
1818
    """
2368
1823
        """See BzrDirFormat.get_format_string()."""
2369
1824
        return "Bazaar-NG branch, format 5\n"
2370
1825
 
2371
 
    def get_branch_format(self):
2372
 
        from bzrlib import branch
2373
 
        return branch.BzrBranchFormat4()
2374
 
 
2375
1826
    def get_format_description(self):
2376
1827
        """See BzrDirFormat.get_format_description()."""
2377
1828
        return "All-in-one format 5"
2383
1834
 
2384
1835
    def _initialize_for_clone(self, url):
2385
1836
        return self.initialize_on_transport(get_transport(url), _cloning=True)
2386
 
 
 
1837
        
2387
1838
    def initialize_on_transport(self, transport, _cloning=False):
2388
1839
        """Format 5 dirs always have working tree, branch and repository.
2389
 
 
 
1840
        
2390
1841
        Except when they are being cloned.
2391
1842
        """
2392
1843
        from bzrlib.branch import BzrBranchFormat4
2393
1844
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
 
1845
        from bzrlib.workingtree import WorkingTreeFormat2
2394
1846
        result = (super(BzrDirFormat5, self).initialize_on_transport(transport))
2395
1847
        RepositoryFormat5().initialize(result, _internal=True)
2396
1848
        if not _cloning:
2397
1849
            branch = BzrBranchFormat4().initialize(result)
2398
 
            result._init_workingtree()
 
1850
            try:
 
1851
                WorkingTreeFormat2().initialize(result)
 
1852
            except errors.NotLocalUrl:
 
1853
                # Even though we can't access the working tree, we need to
 
1854
                # create its control files.
 
1855
                WorkingTreeFormat2()._stub_initialize_remote(branch)
2399
1856
        return result
2400
1857
 
2401
 
    def network_name(self):
2402
 
        return self.get_format_string()
2403
 
 
2404
1858
    def _open(self, transport):
2405
1859
        """See BzrDirFormat._open."""
2406
1860
        return BzrDir5(transport, self)
2412
1866
    repository_format = property(__return_repository_format)
2413
1867
 
2414
1868
 
2415
 
class BzrDirFormat6(BzrDirFormatAllInOne):
 
1869
class BzrDirFormat6(BzrDirFormat):
2416
1870
    """Bzr control format 6.
2417
1871
 
2418
1872
    This format is a combined format for working tree, branch and repository.
2419
1873
    It has:
2420
 
     - Format 2 working trees [always]
2421
 
     - Format 4 branches [always]
 
1874
     - Format 2 working trees [always] 
 
1875
     - Format 4 branches [always] 
2422
1876
     - Format 6 repositories [always]
2423
1877
    """
2424
1878
 
2432
1886
        """See BzrDirFormat.get_format_description()."""
2433
1887
        return "All-in-one format 6"
2434
1888
 
2435
 
    def get_branch_format(self):
2436
 
        from bzrlib import branch
2437
 
        return branch.BzrBranchFormat4()
2438
 
 
2439
1889
    def get_converter(self, format=None):
2440
1890
        """See BzrDirFormat.get_converter()."""
2441
1891
        # there is one and only one upgrade path here.
2442
1892
        return ConvertBzrDir6ToMeta()
2443
 
 
 
1893
        
2444
1894
    def _initialize_for_clone(self, url):
2445
1895
        return self.initialize_on_transport(get_transport(url), _cloning=True)
2446
1896
 
2447
1897
    def initialize_on_transport(self, transport, _cloning=False):
2448
1898
        """Format 6 dirs always have working tree, branch and repository.
2449
 
 
 
1899
        
2450
1900
        Except when they are being cloned.
2451
1901
        """
2452
1902
        from bzrlib.branch import BzrBranchFormat4
2453
1903
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
 
1904
        from bzrlib.workingtree import WorkingTreeFormat2
2454
1905
        result = super(BzrDirFormat6, self).initialize_on_transport(transport)
2455
1906
        RepositoryFormat6().initialize(result, _internal=True)
2456
1907
        if not _cloning:
2457
1908
            branch = BzrBranchFormat4().initialize(result)
2458
 
            result._init_workingtree()
 
1909
            try:
 
1910
                WorkingTreeFormat2().initialize(result)
 
1911
            except errors.NotLocalUrl:
 
1912
                # Even though we can't access the working tree, we need to
 
1913
                # create its control files.
 
1914
                WorkingTreeFormat2()._stub_initialize_remote(branch)
2459
1915
        return result
2460
1916
 
2461
 
    def network_name(self):
2462
 
        return self.get_format_string()
2463
 
 
2464
1917
    def _open(self, transport):
2465
1918
        """See BzrDirFormat._open."""
2466
1919
        return BzrDir6(transport, self)
2488
1941
    def __init__(self):
2489
1942
        self._workingtree_format = None
2490
1943
        self._branch_format = None
2491
 
        self._repository_format = None
2492
1944
 
2493
1945
    def __eq__(self, other):
2494
1946
        if other.__class__ is not self.__class__:
2511
1963
    def set_branch_format(self, format):
2512
1964
        self._branch_format = format
2513
1965
 
2514
 
    def require_stacking(self, stack_on=None, possible_transports=None,
2515
 
            _skip_repo=False):
2516
 
        """We have a request to stack, try to ensure the formats support it.
2517
 
 
2518
 
        :param stack_on: If supplied, it is the URL to a branch that we want to
2519
 
            stack on. Check to see if that format supports stacking before
2520
 
            forcing an upgrade.
2521
 
        """
2522
 
        # Stacking is desired. requested by the target, but does the place it
2523
 
        # points at support stacking? If it doesn't then we should
2524
 
        # not implicitly upgrade. We check this here.
2525
 
        new_repo_format = None
2526
 
        new_branch_format = None
2527
 
 
2528
 
        # a bit of state for get_target_branch so that we don't try to open it
2529
 
        # 2 times, for both repo *and* branch
2530
 
        target = [None, False, None] # target_branch, checked, upgrade anyway
2531
 
        def get_target_branch():
2532
 
            if target[1]:
2533
 
                # We've checked, don't check again
2534
 
                return target
2535
 
            if stack_on is None:
2536
 
                # No target format, that means we want to force upgrading
2537
 
                target[:] = [None, True, True]
2538
 
                return target
2539
 
            try:
2540
 
                target_dir = BzrDir.open(stack_on,
2541
 
                    possible_transports=possible_transports)
2542
 
            except errors.NotBranchError:
2543
 
                # Nothing there, don't change formats
2544
 
                target[:] = [None, True, False]
2545
 
                return target
2546
 
            except errors.JailBreak:
2547
 
                # JailBreak, JFDI and upgrade anyway
2548
 
                target[:] = [None, True, True]
2549
 
                return target
2550
 
            try:
2551
 
                target_branch = target_dir.open_branch()
2552
 
            except errors.NotBranchError:
2553
 
                # No branch, don't upgrade formats
2554
 
                target[:] = [None, True, False]
2555
 
                return target
2556
 
            target[:] = [target_branch, True, False]
2557
 
            return target
2558
 
 
2559
 
        if (not _skip_repo and
2560
 
                 not self.repository_format.supports_external_lookups):
2561
 
            # We need to upgrade the Repository.
2562
 
            target_branch, _, do_upgrade = get_target_branch()
2563
 
            if target_branch is None:
2564
 
                # We don't have a target branch, should we upgrade anyway?
2565
 
                if do_upgrade:
2566
 
                    # stack_on is inaccessible, JFDI.
2567
 
                    # TODO: bad monkey, hard-coded formats...
2568
 
                    if self.repository_format.rich_root_data:
2569
 
                        new_repo_format = pack_repo.RepositoryFormatKnitPack5RichRoot()
2570
 
                    else:
2571
 
                        new_repo_format = pack_repo.RepositoryFormatKnitPack5()
2572
 
            else:
2573
 
                # If the target already supports stacking, then we know the
2574
 
                # project is already able to use stacking, so auto-upgrade
2575
 
                # for them
2576
 
                new_repo_format = target_branch.repository._format
2577
 
                if not new_repo_format.supports_external_lookups:
2578
 
                    # target doesn't, source doesn't, so don't auto upgrade
2579
 
                    # repo
2580
 
                    new_repo_format = None
2581
 
            if new_repo_format is not None:
2582
 
                self.repository_format = new_repo_format
2583
 
                note('Source repository format does not support stacking,'
2584
 
                     ' using format:\n  %s',
2585
 
                     new_repo_format.get_format_description())
2586
 
 
2587
 
        if not self.get_branch_format().supports_stacking():
2588
 
            # We just checked the repo, now lets check if we need to
2589
 
            # upgrade the branch format
2590
 
            target_branch, _, do_upgrade = get_target_branch()
2591
 
            if target_branch is None:
2592
 
                if do_upgrade:
2593
 
                    # TODO: bad monkey, hard-coded formats...
2594
 
                    new_branch_format = branch.BzrBranchFormat7()
2595
 
            else:
2596
 
                new_branch_format = target_branch._format
2597
 
                if not new_branch_format.supports_stacking():
2598
 
                    new_branch_format = None
2599
 
            if new_branch_format is not None:
2600
 
                # Does support stacking, use its format.
2601
 
                self.set_branch_format(new_branch_format)
2602
 
                note('Source branch format does not support stacking,'
2603
 
                     ' using format:\n  %s',
2604
 
                     new_branch_format.get_format_description())
2605
 
 
2606
1966
    def get_converter(self, format=None):
2607
1967
        """See BzrDirFormat.get_converter()."""
2608
1968
        if format is None:
2620
1980
        """See BzrDirFormat.get_format_description()."""
2621
1981
        return "Meta directory format 1"
2622
1982
 
2623
 
    def network_name(self):
2624
 
        return self.get_format_string()
2625
 
 
2626
1983
    def _open(self, transport):
2627
1984
        """See BzrDirFormat._open."""
2628
 
        # Create a new format instance because otherwise initialisation of new
2629
 
        # metadirs share the global default format object leading to alias
2630
 
        # problems.
2631
 
        format = BzrDirMetaFormat1()
2632
 
        self._supply_sub_formats_to(format)
2633
 
        return BzrDirMeta1(transport, format)
 
1985
        return BzrDirMeta1(transport, self)
2634
1986
 
2635
1987
    def __return_repository_format(self):
2636
1988
        """Circular import protection."""
2637
 
        if self._repository_format:
 
1989
        if getattr(self, '_repository_format', None):
2638
1990
            return self._repository_format
2639
1991
        from bzrlib.repository import RepositoryFormat
2640
1992
        return RepositoryFormat.get_default_format()
2641
1993
 
2642
 
    def _set_repository_format(self, value):
 
1994
    def __set_repository_format(self, value):
2643
1995
        """Allow changing the repository format for metadir formats."""
2644
1996
        self._repository_format = value
2645
1997
 
2646
 
    repository_format = property(__return_repository_format,
2647
 
        _set_repository_format)
2648
 
 
2649
 
    def _supply_sub_formats_to(self, other_format):
2650
 
        """Give other_format the same values for sub formats as this has.
2651
 
 
2652
 
        This method is expected to be used when parameterising a
2653
 
        RemoteBzrDirFormat instance with the parameters from a
2654
 
        BzrDirMetaFormat1 instance.
2655
 
 
2656
 
        :param other_format: other_format is a format which should be
2657
 
            compatible with whatever sub formats are supported by self.
2658
 
        :return: None.
2659
 
        """
2660
 
        if getattr(self, '_repository_format', None) is not None:
2661
 
            other_format.repository_format = self.repository_format
2662
 
        if self._branch_format is not None:
2663
 
            other_format._branch_format = self._branch_format
2664
 
        if self._workingtree_format is not None:
2665
 
            other_format.workingtree_format = self.workingtree_format
 
1998
    repository_format = property(__return_repository_format, __set_repository_format)
2666
1999
 
2667
2000
    def __get_workingtree_format(self):
2668
2001
        if self._workingtree_format is None:
2677
2010
                                  __set_workingtree_format)
2678
2011
 
2679
2012
 
2680
 
network_format_registry = registry.FormatRegistry()
2681
 
"""Registry of formats indexed by their network name.
2682
 
 
2683
 
The network name for a BzrDirFormat is an identifier that can be used when
2684
 
referring to formats with smart server operations. See
2685
 
BzrDirFormat.network_name() for more detail.
2686
 
"""
2687
 
 
2688
 
 
2689
2013
# Register bzr control format
2690
2014
BzrDirFormat.register_control_format(BzrDirFormat)
2691
2015
 
2723
2047
        self.absent_revisions = set()
2724
2048
        self.text_count = 0
2725
2049
        self.revisions = {}
2726
 
 
 
2050
        
2727
2051
    def convert(self, to_convert, pb):
2728
2052
        """See Converter.convert()."""
2729
2053
        self.bzrdir = to_convert
2730
 
        if pb is not None:
2731
 
            warnings.warn("pb parameter to convert() is deprecated")
2732
 
        self.pb = ui.ui_factory.nested_progress_bar()
2733
 
        try:
2734
 
            ui.ui_factory.note('starting upgrade from format 4 to 5')
2735
 
            if isinstance(self.bzrdir.transport, local.LocalTransport):
2736
 
                self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
2737
 
            self._convert_to_weaves()
2738
 
            return BzrDir.open(self.bzrdir.user_url)
2739
 
        finally:
2740
 
            self.pb.finished()
 
2054
        self.pb = pb
 
2055
        self.pb.note('starting upgrade from format 4 to 5')
 
2056
        if isinstance(self.bzrdir.transport, LocalTransport):
 
2057
            self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
 
2058
        self._convert_to_weaves()
 
2059
        return BzrDir.open(self.bzrdir.root_transport.base)
2741
2060
 
2742
2061
    def _convert_to_weaves(self):
2743
 
        ui.ui_factory.note('note: upgrade may be faster if all store files are ungzipped first')
 
2062
        self.pb.note('note: upgrade may be faster if all store files are ungzipped first')
2744
2063
        try:
2745
2064
            # TODO permissions
2746
2065
            stat = self.bzrdir.transport.stat('weaves')
2774
2093
        self.pb.clear()
2775
2094
        self._write_all_weaves()
2776
2095
        self._write_all_revs()
2777
 
        ui.ui_factory.note('upgraded to weaves:')
2778
 
        ui.ui_factory.note('  %6d revisions and inventories' % len(self.revisions))
2779
 
        ui.ui_factory.note('  %6d revisions not present' % len(self.absent_revisions))
2780
 
        ui.ui_factory.note('  %6d texts' % self.text_count)
 
2096
        self.pb.note('upgraded to weaves:')
 
2097
        self.pb.note('  %6d revisions and inventories', len(self.revisions))
 
2098
        self.pb.note('  %6d revisions not present', len(self.absent_revisions))
 
2099
        self.pb.note('  %6d texts', self.text_count)
2781
2100
        self._cleanup_spare_files_after_format4()
2782
2101
        self.branch._transport.put_bytes(
2783
2102
            'branch-format',
2840
2159
                revision_store.add_lines(key, None, osutils.split_lines(text))
2841
2160
        finally:
2842
2161
            self.pb.clear()
2843
 
 
 
2162
            
2844
2163
    def _load_one_rev(self, rev_id):
2845
2164
        """Load a revision object into memory.
2846
2165
 
2851
2170
                       len(self.known_revisions))
2852
2171
        if not self.branch.repository.has_revision(rev_id):
2853
2172
            self.pb.clear()
2854
 
            ui.ui_factory.note('revision {%s} not present in branch; '
2855
 
                         'will be converted as a ghost' %
 
2173
            self.pb.note('revision {%s} not present in branch; '
 
2174
                         'will be converted as a ghost',
2856
2175
                         rev_id)
2857
2176
            self.absent_revisions.add(rev_id)
2858
2177
        else:
2920
2239
        text_changed = False
2921
2240
        parent_candiate_entries = ie.parent_candidates(parent_invs)
2922
2241
        heads = graph.Graph(self).heads(parent_candiate_entries.keys())
2923
 
        # XXX: Note that this is unordered - and this is tolerable because
 
2242
        # XXX: Note that this is unordered - and this is tolerable because 
2924
2243
        # the previous code was also unordered.
2925
2244
        previous_entries = dict((head, parent_candiate_entries[head]) for head
2926
2245
            in heads)
2927
2246
        self.snapshot_ie(previous_entries, ie, w, rev_id)
2928
2247
        del ie.text_id
2929
2248
 
 
2249
    @symbol_versioning.deprecated_method(symbol_versioning.one_one)
 
2250
    def get_parents(self, revision_ids):
 
2251
        for revision_id in revision_ids:
 
2252
            yield self.revisions[revision_id].parent_ids
 
2253
 
2930
2254
    def get_parent_map(self, revision_ids):
2931
 
        """See graph.StackedParentsProvider.get_parent_map"""
 
2255
        """See graph._StackedParentsProvider.get_parent_map"""
2932
2256
        return dict((revision_id, self.revisions[revision_id])
2933
2257
                    for revision_id in revision_ids
2934
2258
                     if revision_id in self.revisions)
2938
2262
        # a call to:. This needs the path figured out. rather than a work_tree
2939
2263
        # a v4 revision_tree can be given, or something that looks enough like
2940
2264
        # one to give the file content to the entry if it needs it.
2941
 
        # and we need something that looks like a weave store for snapshot to
 
2265
        # and we need something that looks like a weave store for snapshot to 
2942
2266
        # save against.
2943
2267
        #ie.snapshot(rev, PATH, previous_revisions, REVISION_TREE, InMemoryWeaveStore(self.text_weaves))
2944
2268
        if len(previous_revisions) == 1:
2984
2308
    def convert(self, to_convert, pb):
2985
2309
        """See Converter.convert()."""
2986
2310
        self.bzrdir = to_convert
2987
 
        pb = ui.ui_factory.nested_progress_bar()
2988
 
        try:
2989
 
            ui.ui_factory.note('starting upgrade from format 5 to 6')
2990
 
            self._convert_to_prefixed()
2991
 
            return BzrDir.open(self.bzrdir.user_url)
2992
 
        finally:
2993
 
            pb.finished()
 
2311
        self.pb = pb
 
2312
        self.pb.note('starting upgrade from format 5 to 6')
 
2313
        self._convert_to_prefixed()
 
2314
        return BzrDir.open(self.bzrdir.root_transport.base)
2994
2315
 
2995
2316
    def _convert_to_prefixed(self):
2996
2317
        from bzrlib.store import TransportStore
2997
2318
        self.bzrdir.transport.delete('branch-format')
2998
2319
        for store_name in ["weaves", "revision-store"]:
2999
 
            ui.ui_factory.note("adding prefixes to %s" % store_name)
 
2320
            self.pb.note("adding prefixes to %s" % store_name)
3000
2321
            store_transport = self.bzrdir.transport.clone(store_name)
3001
2322
            store = TransportStore(store_transport, prefixed=True)
3002
2323
            for urlfilename in store_transport.list_dir('.'):
3029
2350
        from bzrlib.repofmt.weaverepo import RepositoryFormat7
3030
2351
        from bzrlib.branch import BzrBranchFormat5
3031
2352
        self.bzrdir = to_convert
3032
 
        self.pb = ui.ui_factory.nested_progress_bar()
 
2353
        self.pb = pb
3033
2354
        self.count = 0
3034
2355
        self.total = 20 # the steps we know about
3035
2356
        self.garbage_inventories = []
3036
2357
        self.dir_mode = self.bzrdir._get_dir_mode()
3037
2358
        self.file_mode = self.bzrdir._get_file_mode()
3038
2359
 
3039
 
        ui.ui_factory.note('starting upgrade from format 6 to metadir')
 
2360
        self.pb.note('starting upgrade from format 6 to metadir')
3040
2361
        self.bzrdir.transport.put_bytes(
3041
2362
                'branch-format',
3042
2363
                "Converting to format 6",
3063
2384
        self.bzrdir.transport.mkdir('repository', mode=self.dir_mode)
3064
2385
        self.make_lock('repository')
3065
2386
        # we hard code the formats here because we are converting into
3066
 
        # the meta format. The meta format upgrader can take this to a
 
2387
        # the meta format. The meta format upgrader can take this to a 
3067
2388
        # future format within each component.
3068
2389
        self.put_format('repository', RepositoryFormat7())
3069
2390
        for entry in repository_names:
3092
2413
        else:
3093
2414
            has_checkout = True
3094
2415
        if not has_checkout:
3095
 
            ui.ui_factory.note('No working tree.')
 
2416
            self.pb.note('No working tree.')
3096
2417
            # If some checkout files are there, we may as well get rid of them.
3097
2418
            for name, mandatory in checkout_files:
3098
2419
                if name in bzrcontents:
3115
2436
            'branch-format',
3116
2437
            BzrDirMetaFormat1().get_format_string(),
3117
2438
            mode=self.file_mode)
3118
 
        self.pb.finished()
3119
 
        return BzrDir.open(self.bzrdir.user_url)
 
2439
        return BzrDir.open(self.bzrdir.root_transport.base)
3120
2440
 
3121
2441
    def make_lock(self, name):
3122
2442
        """Make a lock for the new control dir name."""
3157
2477
    def convert(self, to_convert, pb):
3158
2478
        """See Converter.convert()."""
3159
2479
        self.bzrdir = to_convert
3160
 
        self.pb = ui.ui_factory.nested_progress_bar()
 
2480
        self.pb = pb
3161
2481
        self.count = 0
3162
2482
        self.total = 1
3163
2483
        self.step('checking repository format')
3168
2488
        else:
3169
2489
            if not isinstance(repo._format, self.target_format.repository_format.__class__):
3170
2490
                from bzrlib.repository import CopyConverter
3171
 
                ui.ui_factory.note('starting repository conversion')
 
2491
                self.pb.note('starting repository conversion')
3172
2492
                converter = CopyConverter(self.target_format.repository_format)
3173
2493
                converter.convert(repo, pb)
3174
 
        for branch in self.bzrdir.list_branches():
 
2494
        try:
 
2495
            branch = self.bzrdir.open_branch()
 
2496
        except errors.NotBranchError:
 
2497
            pass
 
2498
        else:
3175
2499
            # TODO: conversions of Branch and Tree should be done by
3176
2500
            # InterXFormat lookups/some sort of registry.
3177
2501
            # Avoid circular imports
3181
2505
            while old != new:
3182
2506
                if (old == _mod_branch.BzrBranchFormat5 and
3183
2507
                    new in (_mod_branch.BzrBranchFormat6,
3184
 
                        _mod_branch.BzrBranchFormat7,
3185
 
                        _mod_branch.BzrBranchFormat8)):
 
2508
                        _mod_branch.BzrBranchFormat7)):
3186
2509
                    branch_converter = _mod_branch.Converter5to6()
3187
2510
                elif (old == _mod_branch.BzrBranchFormat6 and
3188
 
                    new in (_mod_branch.BzrBranchFormat7,
3189
 
                            _mod_branch.BzrBranchFormat8)):
 
2511
                    new == _mod_branch.BzrBranchFormat7):
3190
2512
                    branch_converter = _mod_branch.Converter6to7()
3191
 
                elif (old == _mod_branch.BzrBranchFormat7 and
3192
 
                      new is _mod_branch.BzrBranchFormat8):
3193
 
                    branch_converter = _mod_branch.Converter7to8()
3194
2513
                else:
3195
 
                    raise errors.BadConversionTarget("No converter", new,
3196
 
                        branch._format)
 
2514
                    raise errors.BadConversionTarget("No converter", new)
3197
2515
                branch_converter.convert(branch)
3198
2516
                branch = self.bzrdir.open_branch()
3199
2517
                old = branch._format.__class__
3205
2523
            # TODO: conversions of Branch and Tree should be done by
3206
2524
            # InterXFormat lookups
3207
2525
            if (isinstance(tree, workingtree.WorkingTree3) and
3208
 
                not isinstance(tree, workingtree_4.DirStateWorkingTree) and
 
2526
                not isinstance(tree, workingtree_4.WorkingTree4) and
3209
2527
                isinstance(self.target_format.workingtree_format,
3210
 
                    workingtree_4.DirStateWorkingTreeFormat)):
 
2528
                    workingtree_4.WorkingTreeFormat4)):
3211
2529
                workingtree_4.Converter3to4().convert(tree)
3212
 
            if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
3213
 
                not isinstance(tree, workingtree_4.WorkingTree5) and
3214
 
                isinstance(self.target_format.workingtree_format,
3215
 
                    workingtree_4.WorkingTreeFormat5)):
3216
 
                workingtree_4.Converter4to5().convert(tree)
3217
 
            if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
3218
 
                not isinstance(tree, workingtree_4.WorkingTree6) and
3219
 
                isinstance(self.target_format.workingtree_format,
3220
 
                    workingtree_4.WorkingTreeFormat6)):
3221
 
                workingtree_4.Converter4or5to6().convert(tree)
3222
 
        self.pb.finished()
3223
2530
        return to_convert
3224
2531
 
3225
2532
 
3226
 
# This is not in remote.py because it's relatively small, and needs to be
3227
 
# registered. Putting it in remote.py creates a circular import problem.
 
2533
# This is not in remote.py because it's small, and needs to be registered.
 
2534
# Putting it in remote.py creates a circular import problem.
3228
2535
# we can make it a lazy object if the control formats is turned into something
3229
2536
# like a registry.
3230
2537
class RemoteBzrDirFormat(BzrDirMetaFormat1):
3231
2538
    """Format representing bzrdirs accessed via a smart server"""
3232
2539
 
3233
 
    def __init__(self):
3234
 
        BzrDirMetaFormat1.__init__(self)
3235
 
        # XXX: It's a bit ugly that the network name is here, because we'd
3236
 
        # like to believe that format objects are stateless or at least
3237
 
        # immutable,  However, we do at least avoid mutating the name after
3238
 
        # it's returned.  See <https://bugs.edge.launchpad.net/bzr/+bug/504102>
3239
 
        self._network_name = None
3240
 
 
3241
 
    def __repr__(self):
3242
 
        return "%s(_network_name=%r)" % (self.__class__.__name__,
3243
 
            self._network_name)
3244
 
 
3245
2540
    def get_format_description(self):
3246
 
        if self._network_name:
3247
 
            real_format = network_format_registry.get(self._network_name)
3248
 
            return 'Remote: ' + real_format.get_format_description()
3249
2541
        return 'bzr remote bzrdir'
3250
 
 
3251
 
    def get_format_string(self):
3252
 
        raise NotImplementedError(self.get_format_string)
3253
 
 
3254
 
    def network_name(self):
3255
 
        if self._network_name:
3256
 
            return self._network_name
3257
 
        else:
3258
 
            raise AssertionError("No network name set.")
3259
 
 
 
2542
    
3260
2543
    @classmethod
3261
2544
    def probe_transport(klass, transport):
3262
2545
        """Return a RemoteBzrDirFormat object if it looks possible."""
3291
2574
            return local_dir_format.initialize_on_transport(transport)
3292
2575
        client = _SmartClient(client_medium)
3293
2576
        path = client.remote_path_from_transport(transport)
3294
 
        try:
3295
 
            response = client.call('BzrDirFormat.initialize', path)
3296
 
        except errors.ErrorFromSmartServer, err:
3297
 
            remote._translate_error(err, path=path)
 
2577
        response = client.call('BzrDirFormat.initialize', path)
3298
2578
        if response[0] != 'ok':
3299
2579
            raise errors.SmartProtocolError('unexpected response code %s' % (response,))
3300
 
        format = RemoteBzrDirFormat()
3301
 
        self._supply_sub_formats_to(format)
3302
 
        return remote.RemoteBzrDir(transport, format)
3303
 
 
3304
 
    def parse_NoneTrueFalse(self, arg):
3305
 
        if not arg:
3306
 
            return None
3307
 
        if arg == 'False':
3308
 
            return False
3309
 
        if arg == 'True':
3310
 
            return True
3311
 
        raise AssertionError("invalid arg %r" % arg)
3312
 
 
3313
 
    def _serialize_NoneTrueFalse(self, arg):
3314
 
        if arg is False:
3315
 
            return 'False'
3316
 
        if arg:
3317
 
            return 'True'
3318
 
        return ''
3319
 
 
3320
 
    def _serialize_NoneString(self, arg):
3321
 
        return arg or ''
3322
 
 
3323
 
    def initialize_on_transport_ex(self, transport, use_existing_dir=False,
3324
 
        create_prefix=False, force_new_repo=False, stacked_on=None,
3325
 
        stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
3326
 
        shared_repo=False):
3327
 
        try:
3328
 
            # hand off the request to the smart server
3329
 
            client_medium = transport.get_smart_medium()
3330
 
        except errors.NoSmartMedium:
3331
 
            do_vfs = True
3332
 
        else:
3333
 
            # Decline to open it if the server doesn't support our required
3334
 
            # version (3) so that the VFS-based transport will do it.
3335
 
            if client_medium.should_probe():
3336
 
                try:
3337
 
                    server_version = client_medium.protocol_version()
3338
 
                    if server_version != '2':
3339
 
                        do_vfs = True
3340
 
                    else:
3341
 
                        do_vfs = False
3342
 
                except errors.SmartProtocolError:
3343
 
                    # Apparently there's no usable smart server there, even though
3344
 
                    # the medium supports the smart protocol.
3345
 
                    do_vfs = True
3346
 
            else:
3347
 
                do_vfs = False
3348
 
        if not do_vfs:
3349
 
            client = _SmartClient(client_medium)
3350
 
            path = client.remote_path_from_transport(transport)
3351
 
            if client_medium._is_remote_before((1, 16)):
3352
 
                do_vfs = True
3353
 
        if do_vfs:
3354
 
            # TODO: lookup the local format from a server hint.
3355
 
            local_dir_format = BzrDirMetaFormat1()
3356
 
            self._supply_sub_formats_to(local_dir_format)
3357
 
            return local_dir_format.initialize_on_transport_ex(transport,
3358
 
                use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3359
 
                force_new_repo=force_new_repo, stacked_on=stacked_on,
3360
 
                stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3361
 
                make_working_trees=make_working_trees, shared_repo=shared_repo,
3362
 
                vfs_only=True)
3363
 
        return self._initialize_on_transport_ex_rpc(client, path, transport,
3364
 
            use_existing_dir, create_prefix, force_new_repo, stacked_on,
3365
 
            stack_on_pwd, repo_format_name, make_working_trees, shared_repo)
3366
 
 
3367
 
    def _initialize_on_transport_ex_rpc(self, client, path, transport,
3368
 
        use_existing_dir, create_prefix, force_new_repo, stacked_on,
3369
 
        stack_on_pwd, repo_format_name, make_working_trees, shared_repo):
3370
 
        args = []
3371
 
        args.append(self._serialize_NoneTrueFalse(use_existing_dir))
3372
 
        args.append(self._serialize_NoneTrueFalse(create_prefix))
3373
 
        args.append(self._serialize_NoneTrueFalse(force_new_repo))
3374
 
        args.append(self._serialize_NoneString(stacked_on))
3375
 
        # stack_on_pwd is often/usually our transport
3376
 
        if stack_on_pwd:
3377
 
            try:
3378
 
                stack_on_pwd = transport.relpath(stack_on_pwd)
3379
 
                if not stack_on_pwd:
3380
 
                    stack_on_pwd = '.'
3381
 
            except errors.PathNotChild:
3382
 
                pass
3383
 
        args.append(self._serialize_NoneString(stack_on_pwd))
3384
 
        args.append(self._serialize_NoneString(repo_format_name))
3385
 
        args.append(self._serialize_NoneTrueFalse(make_working_trees))
3386
 
        args.append(self._serialize_NoneTrueFalse(shared_repo))
3387
 
        request_network_name = self._network_name or \
3388
 
            BzrDirFormat.get_default_format().network_name()
3389
 
        try:
3390
 
            response = client.call('BzrDirFormat.initialize_ex_1.16',
3391
 
                request_network_name, path, *args)
3392
 
        except errors.UnknownSmartMethod:
3393
 
            client._medium._remember_remote_is_before((1,16))
3394
 
            local_dir_format = BzrDirMetaFormat1()
3395
 
            self._supply_sub_formats_to(local_dir_format)
3396
 
            return local_dir_format.initialize_on_transport_ex(transport,
3397
 
                use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3398
 
                force_new_repo=force_new_repo, stacked_on=stacked_on,
3399
 
                stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3400
 
                make_working_trees=make_working_trees, shared_repo=shared_repo,
3401
 
                vfs_only=True)
3402
 
        except errors.ErrorFromSmartServer, err:
3403
 
            remote._translate_error(err, path=path)
3404
 
        repo_path = response[0]
3405
 
        bzrdir_name = response[6]
3406
 
        require_stacking = response[7]
3407
 
        require_stacking = self.parse_NoneTrueFalse(require_stacking)
3408
 
        format = RemoteBzrDirFormat()
3409
 
        format._network_name = bzrdir_name
3410
 
        self._supply_sub_formats_to(format)
3411
 
        bzrdir = remote.RemoteBzrDir(transport, format, _client=client)
3412
 
        if repo_path:
3413
 
            repo_format = remote.response_tuple_to_repo_format(response[1:])
3414
 
            if repo_path == '.':
3415
 
                repo_path = ''
3416
 
            if repo_path:
3417
 
                repo_bzrdir_format = RemoteBzrDirFormat()
3418
 
                repo_bzrdir_format._network_name = response[5]
3419
 
                repo_bzr = remote.RemoteBzrDir(transport.clone(repo_path),
3420
 
                    repo_bzrdir_format)
3421
 
            else:
3422
 
                repo_bzr = bzrdir
3423
 
            final_stack = response[8] or None
3424
 
            final_stack_pwd = response[9] or None
3425
 
            if final_stack_pwd:
3426
 
                final_stack_pwd = urlutils.join(
3427
 
                    transport.base, final_stack_pwd)
3428
 
            remote_repo = remote.RemoteRepository(repo_bzr, repo_format)
3429
 
            if len(response) > 10:
3430
 
                # Updated server verb that locks remotely.
3431
 
                repo_lock_token = response[10] or None
3432
 
                remote_repo.lock_write(repo_lock_token, _skip_rpc=True)
3433
 
                if repo_lock_token:
3434
 
                    remote_repo.dont_leave_lock_in_place()
3435
 
            else:
3436
 
                remote_repo.lock_write()
3437
 
            policy = UseExistingRepository(remote_repo, final_stack,
3438
 
                final_stack_pwd, require_stacking)
3439
 
            policy.acquire_repository()
3440
 
        else:
3441
 
            remote_repo = None
3442
 
            policy = None
3443
 
        bzrdir._format.set_branch_format(self.get_branch_format())
3444
 
        if require_stacking:
3445
 
            # The repo has already been created, but we need to make sure that
3446
 
            # we'll make a stackable branch.
3447
 
            bzrdir._format.require_stacking(_skip_repo=True)
3448
 
        return remote_repo, bzrdir, require_stacking, policy
 
2580
        return remote.RemoteBzrDir(transport)
3449
2581
 
3450
2582
    def _open(self, transport):
3451
 
        return remote.RemoteBzrDir(transport, self)
 
2583
        return remote.RemoteBzrDir(transport)
3452
2584
 
3453
2585
    def __eq__(self, other):
3454
2586
        if not isinstance(other, RemoteBzrDirFormat):
3455
2587
            return False
3456
2588
        return self.get_format_description() == other.get_format_description()
3457
2589
 
3458
 
    def __return_repository_format(self):
3459
 
        # Always return a RemoteRepositoryFormat object, but if a specific bzr
3460
 
        # repository format has been asked for, tell the RemoteRepositoryFormat
3461
 
        # that it should use that for init() etc.
3462
 
        result = remote.RemoteRepositoryFormat()
3463
 
        custom_format = getattr(self, '_repository_format', None)
3464
 
        if custom_format:
3465
 
            if isinstance(custom_format, remote.RemoteRepositoryFormat):
3466
 
                return custom_format
3467
 
            else:
3468
 
                # We will use the custom format to create repositories over the
3469
 
                # wire; expose its details like rich_root_data for code to
3470
 
                # query
3471
 
                result._custom_format = custom_format
3472
 
        return result
3473
 
 
3474
 
    def get_branch_format(self):
3475
 
        result = BzrDirMetaFormat1.get_branch_format(self)
3476
 
        if not isinstance(result, remote.RemoteBranchFormat):
3477
 
            new_result = remote.RemoteBranchFormat()
3478
 
            new_result._custom_format = result
3479
 
            # cache the result
3480
 
            self.set_branch_format(new_result)
3481
 
            result = new_result
3482
 
        return result
3483
 
 
3484
 
    repository_format = property(__return_repository_format,
3485
 
        BzrDirMetaFormat1._set_repository_format) #.im_func)
3486
 
 
3487
2590
 
3488
2591
BzrDirFormat.register_control_server_format(RemoteBzrDirFormat)
3489
2592
 
3499
2602
 
3500
2603
class BzrDirFormatRegistry(registry.Registry):
3501
2604
    """Registry of user-selectable BzrDir subformats.
3502
 
 
 
2605
    
3503
2606
    Differs from BzrDirFormat._control_formats in that it provides sub-formats,
3504
2607
    e.g. BzrDirMeta1 with weave repository.  Also, it's more user-oriented.
3505
2608
    """
3507
2610
    def __init__(self):
3508
2611
        """Create a BzrDirFormatRegistry."""
3509
2612
        self._aliases = set()
3510
 
        self._registration_order = list()
3511
2613
        super(BzrDirFormatRegistry, self).__init__()
3512
2614
 
3513
2615
    def aliases(self):
3524
2626
        """Register a metadir subformat.
3525
2627
 
3526
2628
        These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
3527
 
        by the Repository/Branch/WorkingTreeformats.
 
2629
        by the Repository format.
3528
2630
 
3529
2631
        :param repository_format: The fully-qualified repository format class
3530
2632
            name as a string.
3564
2666
    def register(self, key, factory, help, native=True, deprecated=False,
3565
2667
                 hidden=False, experimental=False, alias=False):
3566
2668
        """Register a BzrDirFormat factory.
3567
 
 
 
2669
        
3568
2670
        The factory must be a callable that takes one parameter: the key.
3569
2671
        It must produce an instance of the BzrDirFormat when called.
3570
2672
 
3575
2677
            BzrDirFormatInfo(native, deprecated, hidden, experimental))
3576
2678
        if alias:
3577
2679
            self._aliases.add(key)
3578
 
        self._registration_order.append(key)
3579
2680
 
3580
2681
    def register_lazy(self, key, module_name, member_name, help, native=True,
3581
2682
        deprecated=False, hidden=False, experimental=False, alias=False):
3583
2684
            help, BzrDirFormatInfo(native, deprecated, hidden, experimental))
3584
2685
        if alias:
3585
2686
            self._aliases.add(key)
3586
 
        self._registration_order.append(key)
3587
2687
 
3588
2688
    def set_default(self, key):
3589
2689
        """Set the 'default' key to be a clone of the supplied key.
3590
 
 
 
2690
        
3591
2691
        This method must be called once and only once.
3592
2692
        """
3593
2693
        registry.Registry.register(self, 'default', self.get(key),
3596
2696
 
3597
2697
    def set_default_repository(self, key):
3598
2698
        """Set the FormatRegistry default and Repository default.
3599
 
 
 
2699
        
3600
2700
        This is a transitional method while Repository.set_default_format
3601
2701
        is deprecated.
3602
2702
        """
3609
2709
        return self.get(key)()
3610
2710
 
3611
2711
    def help_topic(self, topic):
3612
 
        output = ""
 
2712
        output = textwrap.dedent("""\
 
2713
            These formats can be used for creating branches, working trees, and
 
2714
            repositories.
 
2715
 
 
2716
            """)
3613
2717
        default_realkey = None
3614
2718
        default_help = self.get_help('default')
3615
2719
        help_pairs = []
3616
 
        for key in self._registration_order:
 
2720
        for key in self.keys():
3617
2721
            if key == 'default':
3618
2722
                continue
3619
2723
            help = self.get_help(key)
3625
2729
        def wrapped(key, help, info):
3626
2730
            if info.native:
3627
2731
                help = '(native) ' + help
3628
 
            return ':%s:\n%s\n\n' % (key,
3629
 
                textwrap.fill(help, initial_indent='    ',
3630
 
                    subsequent_indent='    ',
3631
 
                    break_long_words=False))
 
2732
            return ':%s:\n%s\n\n' % (key, 
 
2733
                    textwrap.fill(help, initial_indent='    ', 
 
2734
                    subsequent_indent='    '))
3632
2735
        if default_realkey is not None:
3633
2736
            output += wrapped(default_realkey, '(default) %s' % default_help,
3634
2737
                              self.get_info('default'))
3644
2747
                experimental_pairs.append((key, help))
3645
2748
            else:
3646
2749
                output += wrapped(key, help, info)
3647
 
        output += "\nSee :doc:`formats-help` for more about storage formats."
3648
 
        other_output = ""
3649
2750
        if len(experimental_pairs) > 0:
3650
 
            other_output += "Experimental formats are shown below.\n\n"
 
2751
            output += "Experimental formats are shown below.\n\n"
3651
2752
            for key, help in experimental_pairs:
3652
2753
                info = self.get_info(key)
3653
 
                other_output += wrapped(key, help, info)
3654
 
        else:
3655
 
            other_output += \
3656
 
                "No experimental formats are available.\n\n"
 
2754
                output += wrapped(key, help, info)
3657
2755
        if len(deprecated_pairs) > 0:
3658
 
            other_output += "\nDeprecated formats are shown below.\n\n"
 
2756
            output += "Deprecated formats are shown below.\n\n"
3659
2757
            for key, help in deprecated_pairs:
3660
2758
                info = self.get_info(key)
3661
 
                other_output += wrapped(key, help, info)
3662
 
        else:
3663
 
            other_output += \
3664
 
                "\nNo deprecated formats are available.\n\n"
3665
 
        other_output += \
3666
 
                "\nSee :doc:`formats-help` for more about storage formats."
 
2759
                output += wrapped(key, help, info)
3667
2760
 
3668
 
        if topic == 'other-formats':
3669
 
            return other_output
3670
 
        else:
3671
 
            return output
 
2761
        return output
3672
2762
 
3673
2763
 
3674
2764
class RepositoryAcquisitionPolicy(object):
3703
2793
            try:
3704
2794
                stack_on = urlutils.rebase_url(self._stack_on,
3705
2795
                    self._stack_on_pwd,
3706
 
                    branch.user_url)
 
2796
                    branch.bzrdir.root_transport.base)
3707
2797
            except errors.InvalidRebaseURLs:
3708
2798
                stack_on = self._get_full_stack_on()
3709
2799
        try:
3710
2800
            branch.set_stacked_on_url(stack_on)
3711
 
        except (errors.UnstackableBranchFormat,
3712
 
                errors.UnstackableRepositoryFormat):
 
2801
        except errors.UnstackableBranchFormat:
3713
2802
            if self._require_stacking:
3714
2803
                raise
3715
2804
 
3716
 
    def requires_stacking(self):
3717
 
        """Return True if this policy requires stacking."""
3718
 
        return self._stack_on is not None and self._require_stacking
3719
 
 
3720
2805
    def _get_full_stack_on(self):
3721
2806
        """Get a fully-qualified URL for the stack_on location."""
3722
2807
        if self._stack_on is None:
3726
2811
        else:
3727
2812
            return urlutils.join(self._stack_on_pwd, self._stack_on)
3728
2813
 
3729
 
    def _add_fallback(self, repository, possible_transports=None):
 
2814
    def _add_fallback(self, repository):
3730
2815
        """Add a fallback to the supplied repository, if stacking is set."""
3731
2816
        stack_on = self._get_full_stack_on()
3732
2817
        if stack_on is None:
3733
2818
            return
3734
 
        try:
3735
 
            stacked_dir = BzrDir.open(stack_on,
3736
 
                                      possible_transports=possible_transports)
3737
 
        except errors.JailBreak:
3738
 
            # We keep the stacking details, but we are in the server code so
3739
 
            # actually stacking is not needed.
3740
 
            return
 
2819
        stacked_dir = BzrDir.open(stack_on)
3741
2820
        try:
3742
2821
            stacked_repo = stacked_dir.open_branch().repository
3743
2822
        except errors.NotBranchError:
3747
2826
        except errors.UnstackableRepositoryFormat:
3748
2827
            if self._require_stacking:
3749
2828
                raise
3750
 
        else:
3751
 
            self._require_stacking = True
3752
2829
 
3753
2830
    def acquire_repository(self, make_working_trees=None, shared=False):
3754
2831
        """Acquire a repository for this bzrdir.
3758
2835
        :param make_working_trees: If creating a repository, set
3759
2836
            make_working_trees to this value (if non-None)
3760
2837
        :param shared: If creating a repository, make it shared if True
3761
 
        :return: A repository, is_new_flag (True if the repository was
3762
 
            created).
 
2838
        :return: A repository
3763
2839
        """
3764
2840
        raise NotImplemented(RepositoryAcquisitionPolicy.acquire_repository)
3765
2841
 
3785
2861
 
3786
2862
        Creates the desired repository in the bzrdir we already have.
3787
2863
        """
3788
 
        stack_on = self._get_full_stack_on()
3789
 
        if stack_on:
3790
 
            format = self._bzrdir._format
3791
 
            format.require_stacking(stack_on=stack_on,
3792
 
                                    possible_transports=[self._bzrdir.root_transport])
3793
 
            if not self._require_stacking:
3794
 
                # We have picked up automatic stacking somewhere.
3795
 
                note('Using default stacking branch %s at %s', self._stack_on,
3796
 
                    self._stack_on_pwd)
3797
2864
        repository = self._bzrdir.create_repository(shared=shared)
3798
 
        self._add_fallback(repository,
3799
 
                           possible_transports=[self._bzrdir.transport])
 
2865
        self._add_fallback(repository)
3800
2866
        if make_working_trees is not None:
3801
2867
            repository.set_make_working_trees(make_working_trees)
3802
 
        return repository, True
 
2868
        return repository
3803
2869
 
3804
2870
 
3805
2871
class UseExistingRepository(RepositoryAcquisitionPolicy):
3821
2887
    def acquire_repository(self, make_working_trees=None, shared=False):
3822
2888
        """Implementation of RepositoryAcquisitionPolicy.acquire_repository
3823
2889
 
3824
 
        Returns an existing repository to use.
 
2890
        Returns an existing repository to use
3825
2891
        """
3826
 
        self._add_fallback(self._repository,
3827
 
                       possible_transports=[self._repository.bzrdir.transport])
3828
 
        return self._repository, False
3829
 
 
3830
 
 
3831
 
# Please register new formats after old formats so that formats
3832
 
# appear in chronological order and format descriptions can build
3833
 
# on previous ones.
 
2892
        self._add_fallback(self._repository)
 
2893
        return self._repository
 
2894
 
 
2895
 
3834
2896
format_registry = BzrDirFormatRegistry()
3835
 
# The pre-0.8 formats have their repository format network name registered in
3836
 
# repository.py. MetaDir formats have their repository format network name
3837
 
# inferred from their disk format string.
3838
2897
format_registry.register('weave', BzrDirFormat6,
3839
2898
    'Pre-0.8 format.  Slower than knit and does not'
3840
2899
    ' support checkouts or shared repositories.',
3841
 
    hidden=True,
3842
2900
    deprecated=True)
 
2901
format_registry.register_metadir('knit',
 
2902
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
 
2903
    'Format using knits.  Recommended for interoperation with bzr <= 0.14.',
 
2904
    branch_format='bzrlib.branch.BzrBranchFormat5',
 
2905
    tree_format='bzrlib.workingtree.WorkingTreeFormat3')
3843
2906
format_registry.register_metadir('metaweave',
3844
2907
    'bzrlib.repofmt.weaverepo.RepositoryFormat7',
3845
2908
    'Transitional format in 0.8.  Slower than knit.',
3846
2909
    branch_format='bzrlib.branch.BzrBranchFormat5',
3847
2910
    tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3848
 
    hidden=True,
3849
 
    deprecated=True)
3850
 
format_registry.register_metadir('knit',
3851
 
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3852
 
    'Format using knits.  Recommended for interoperation with bzr <= 0.14.',
3853
 
    branch_format='bzrlib.branch.BzrBranchFormat5',
3854
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3855
 
    hidden=True,
3856
2911
    deprecated=True)
3857
2912
format_registry.register_metadir('dirstate',
3858
2913
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3862
2917
    # this uses bzrlib.workingtree.WorkingTreeFormat4 because importing
3863
2918
    # directly from workingtree_4 triggers a circular import.
3864
2919
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3865
 
    hidden=True,
3866
 
    deprecated=True)
 
2920
    )
3867
2921
format_registry.register_metadir('dirstate-tags',
3868
2922
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3869
2923
    help='New in 0.15: Fast local operations and improved scaling for '
3871
2925
        ' Incompatible with bzr < 0.15.',
3872
2926
    branch_format='bzrlib.branch.BzrBranchFormat6',
3873
2927
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3874
 
    hidden=True,
3875
 
    deprecated=True)
 
2928
    )
3876
2929
format_registry.register_metadir('rich-root',
3877
2930
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
3878
2931
    help='New in 1.0.  Better handling of tree roots.  Incompatible with'
3879
 
        ' bzr < 1.0.',
 
2932
        ' bzr < 1.0',
3880
2933
    branch_format='bzrlib.branch.BzrBranchFormat6',
3881
2934
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3882
 
    hidden=True,
3883
 
    deprecated=True)
 
2935
    )
3884
2936
format_registry.register_metadir('dirstate-with-subtree',
3885
2937
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
3886
2938
    help='New in 0.15: Fast local operations and improved scaling for '
3896
2948
    help='New in 0.92: Pack-based format with data compatible with '
3897
2949
        'dirstate-tags format repositories. Interoperates with '
3898
2950
        'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3899
 
        ,
 
2951
        'Previously called knitpack-experimental.  '
 
2952
        'For more information, see '
 
2953
        'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
3900
2954
    branch_format='bzrlib.branch.BzrBranchFormat6',
3901
2955
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3902
2956
    )
3905
2959
    help='New in 0.92: Pack-based format with data compatible with '
3906
2960
        'dirstate-with-subtree format repositories. Interoperates with '
3907
2961
        'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3908
 
        ,
 
2962
        'Previously called knitpack-experimental.  '
 
2963
        'For more information, see '
 
2964
        'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
3909
2965
    branch_format='bzrlib.branch.BzrBranchFormat6',
3910
2966
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3911
2967
    hidden=True,
3913
2969
    )
3914
2970
format_registry.register_metadir('rich-root-pack',
3915
2971
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
3916
 
    help='New in 1.0: A variant of pack-0.92 that supports rich-root data '
3917
 
         '(needed for bzr-svn and bzr-git).',
 
2972
    help='New in 1.0: Pack-based format with data compatible with '
 
2973
        'rich-root format repositories. Incompatible with'
 
2974
        ' bzr < 1.0',
3918
2975
    branch_format='bzrlib.branch.BzrBranchFormat6',
3919
2976
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3920
 
    hidden=True,
3921
 
    )
3922
 
format_registry.register_metadir('1.6',
3923
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5',
3924
 
    help='A format that allows a branch to indicate that there is another '
3925
 
         '(stacked) repository that should be used to access data that is '
3926
 
         'not present locally.',
3927
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3928
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3929
 
    hidden=True,
3930
 
    )
3931
 
format_registry.register_metadir('1.6.1-rich-root',
3932
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5RichRoot',
3933
 
    help='A variant of 1.6 that supports rich-root data '
3934
 
         '(needed for bzr-svn and bzr-git).',
3935
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3936
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3937
 
    hidden=True,
3938
 
    )
3939
 
format_registry.register_metadir('1.9',
3940
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3941
 
    help='A repository format using B+tree indexes. These indexes '
3942
 
         'are smaller in size, have smarter caching and provide faster '
3943
 
         'performance for most operations.',
3944
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3945
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3946
 
    hidden=True,
3947
 
    )
3948
 
format_registry.register_metadir('1.9-rich-root',
3949
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
3950
 
    help='A variant of 1.9 that supports rich-root data '
3951
 
         '(needed for bzr-svn and bzr-git).',
3952
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3953
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3954
 
    hidden=True,
3955
 
    )
3956
 
format_registry.register_metadir('1.14',
3957
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3958
 
    help='A working-tree format that supports content filtering.',
3959
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3960
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat5',
3961
 
    )
3962
 
format_registry.register_metadir('1.14-rich-root',
3963
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
3964
 
    help='A variant of 1.14 that supports rich-root data '
3965
 
         '(needed for bzr-svn and bzr-git).',
3966
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3967
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat5',
3968
 
    )
3969
 
# The following un-numbered 'development' formats should always just be aliases.
3970
 
format_registry.register_metadir('development-rich-root',
3971
 
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
3972
 
    help='Current development format. Supports rich roots. Can convert data '
3973
 
        'to and from rich-root-pack (and anything compatible with '
3974
 
        'rich-root-pack) format repositories. Repositories and branches in '
3975
 
        'this format can only be read by bzr.dev. Please read '
3976
 
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
 
2977
    )
 
2978
# The following two formats should always just be aliases.
 
2979
format_registry.register_metadir('development',
 
2980
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment1',
 
2981
    help='Current development format. Can convert data to and from pack-0.92 '
 
2982
        '(and anything compatible with pack-0.92) format repositories. '
 
2983
        'Repositories and branches in this format can only be read by bzr.dev. '
 
2984
        'Please read '
 
2985
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3977
2986
        'before use.',
3978
2987
    branch_format='bzrlib.branch.BzrBranchFormat7',
3979
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
 
2988
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3980
2989
    experimental=True,
3981
2990
    alias=True,
3982
 
    hidden=True,
3983
2991
    )
3984
2992
format_registry.register_metadir('development-subtree',
3985
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment2Subtree',
 
2993
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment1Subtree',
3986
2994
    help='Current development format, subtree variant. Can convert data to and '
3987
2995
        'from pack-0.92-subtree (and anything compatible with '
3988
2996
        'pack-0.92-subtree) format repositories. Repositories and branches in '
3989
2997
        'this format can only be read by bzr.dev. Please read '
3990
 
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
3991
 
        'before use.',
3992
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3993
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3994
 
    experimental=True,
3995
 
    hidden=True,
3996
 
    alias=False, # Restore to being an alias when an actual development subtree format is added
3997
 
                 # This current non-alias status is simply because we did not introduce a
3998
 
                 # chk based subtree format.
3999
 
    )
4000
 
 
4001
 
# And the development formats above will have aliased one of the following:
4002
 
format_registry.register_metadir('development6-rich-root',
4003
 
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
4004
 
    help='pack-1.9 with 255-way hashed CHK inv, group compress, rich roots '
4005
 
        'Please read '
4006
 
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
4007
 
        'before use.',
4008
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
4009
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4010
 
    hidden=True,
4011
 
    experimental=True,
4012
 
    )
4013
 
 
4014
 
format_registry.register_metadir('development7-rich-root',
4015
 
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK2',
4016
 
    help='pack-1.9 with 255-way hashed CHK inv, bencode revision, group compress, '
4017
 
        'rich roots. Please read '
4018
 
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
4019
 
        'before use.',
4020
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
4021
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4022
 
    hidden=True,
4023
 
    experimental=True,
4024
 
    )
4025
 
 
4026
 
format_registry.register_metadir('2a',
4027
 
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
4028
 
    help='First format for bzr 2.0 series.\n'
4029
 
        'Uses group-compress storage.\n'
4030
 
        'Provides rich roots which are a one-way transition.\n',
4031
 
        # 'storage in packs, 255-way hashed CHK inventory, bencode revision, group compress, '
4032
 
        # 'rich roots. Supported by bzr 1.16 and later.',
4033
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
4034
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4035
 
    experimental=True,
4036
 
    )
4037
 
 
4038
 
# The following format should be an alias for the rich root equivalent 
4039
 
# of the default format
4040
 
format_registry.register_metadir('default-rich-root',
4041
 
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
4042
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
4043
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
 
2998
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
 
2999
        'before use.',
 
3000
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
3001
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
3002
    experimental=True,
4044
3003
    alias=True,
4045
 
    hidden=True,
4046
 
    help='Same as 2a.')
4047
 
 
 
3004
    )
 
3005
# And the development formats which the will have aliased one of follow:
 
3006
format_registry.register_metadir('development0',
 
3007
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment0',
 
3008
    help='Trivial rename of pack-0.92 to provide a development format. '
 
3009
        'Please read '
 
3010
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
 
3011
        'before use.',
 
3012
    branch_format='bzrlib.branch.BzrBranchFormat6',
 
3013
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
3014
    hidden=True,
 
3015
    experimental=True,
 
3016
    )
 
3017
format_registry.register_metadir('development0-subtree',
 
3018
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment0Subtree',
 
3019
    help='Trivial rename of pack-0.92-subtree to provide a development format. '
 
3020
        'Please read '
 
3021
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
 
3022
        'before use.',
 
3023
    branch_format='bzrlib.branch.BzrBranchFormat6',
 
3024
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
3025
    hidden=True,
 
3026
    experimental=True,
 
3027
    )
 
3028
format_registry.register_metadir('development1',
 
3029
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment1',
 
3030
    help='A branch and pack based repository that supports stacking. '
 
3031
        'Please read '
 
3032
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
 
3033
        'before use.',
 
3034
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
3035
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
3036
    hidden=True,
 
3037
    experimental=True,
 
3038
    )
 
3039
format_registry.register_metadir('development1-subtree',
 
3040
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment1Subtree',
 
3041
    help='A branch and pack based repository that supports stacking. '
 
3042
        'Please read '
 
3043
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
 
3044
        'before use.',
 
3045
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
3046
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
3047
    hidden=True,
 
3048
    experimental=True,
 
3049
    )
4048
3050
# The current format that is made on 'bzr init'.
4049
 
format_registry.set_default('2a')
 
3051
format_registry.set_default('pack-0.92')