← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/bzrdir.py

  • Committer: Martin Pool
  • Date: 2009-01-13 03:11:04 UTC
  • mto: This revision was merged to the branch mainline in revision 3937.
  • Revision ID: mbp@sourcefrog.net-20090113031104-03my054s02i9l2pe
Bump version to 1.12 and add news template

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
 
29
29
 
30
30
import os
31
31
import sys
32
 
import warnings
33
32
 
34
33
from bzrlib.lazy_import import lazy_import
35
34
lazy_import(globals(), """
38
37
 
39
38
import bzrlib
40
39
from bzrlib import (
41
 
    branch,
42
40
    config,
43
41
    errors,
44
42
    graph,
46
44
    lockdir,
47
45
    osutils,
48
46
    remote,
49
 
    repository,
50
47
    revision as _mod_revision,
51
48
    ui,
52
49
    urlutils,
60
57
from bzrlib.osutils import (
61
58
    sha_string,
62
59
    )
63
 
from bzrlib.push import (
64
 
    PushResult,
65
 
    )
66
 
from bzrlib.repofmt import pack_repo
67
60
from bzrlib.smart.client import _SmartClient
68
61
from bzrlib.store.versioned import WeaveStore
69
62
from bzrlib.transactions import WriteTransaction
78
71
from bzrlib.trace import (
79
72
    mutter,
80
73
    note,
81
 
    warning,
82
74
    )
83
75
 
84
76
from bzrlib import (
85
 
    hooks,
86
77
    registry,
87
78
    symbol_versioning,
88
79
    )
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
 
 
82
class BzrDir(object):
125
83
    """A .bzr control diretory.
126
 
 
 
84
    
127
85
    BzrDir instances let you create or open any of the things that can be
128
86
    found within .bzr - checkouts, branches and repositories.
129
 
 
 
87
    
130
88
    :ivar transport:
131
89
        the transport which this bzr dir is rooted at (i.e. file:///.../.bzr/)
132
90
    :ivar root_transport:
134
92
        (i.e. the parent directory holding the .bzr directory).
135
93
 
136
94
    Everything in the bzrdir should have the same file permissions.
137
 
 
138
 
    :cvar hooks: An instance of BzrDirHooks.
139
95
    """
140
96
 
141
97
    def break_lock(self):
163
119
        return True
164
120
 
165
121
    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
122
        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
 
123
        source_repo_format = self._format.repository_format
 
124
        source_repo_format.check_conversion_target(target_repo_format)
176
125
 
177
126
    @staticmethod
178
127
    def _check_supported(format, allow_unsupported,
180
129
        basedir=None):
181
130
        """Give an error or warning on old formats.
182
131
 
183
 
        :param format: may be any kind of format - workingtree, branch,
 
132
        :param format: may be any kind of format - workingtree, branch, 
184
133
        or repository.
185
134
 
186
 
        :param allow_unsupported: If true, allow opening
187
 
        formats that are strongly deprecated, and which may
 
135
        :param allow_unsupported: If true, allow opening 
 
136
        formats that are strongly deprecated, and which may 
188
137
        have limited functionality.
189
138
 
190
139
        :param recommend_upgrade: If true (default), warn
222
171
                                       preserve_stacking=preserve_stacking)
223
172
 
224
173
    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):
 
174
                           force_new_repo=False, preserve_stacking=False,
 
175
                           stacked_on=None):
227
176
        """Clone this bzrdir and its contents to transport verbatim.
228
177
 
229
178
        :param transport: The transport for the location to produce the clone
235
184
                               even if one is available.
236
185
        :param preserve_stacking: When cloning a stacked branch, stack the
237
186
            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
187
        """
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:
 
188
        transport.ensure_base()
247
189
        require_stacking = (stacked_on is not None)
248
 
        format = self.cloning_metadir(require_stacking)
249
 
        
250
 
        # Figure out what objects we want:
 
190
        metadir = self.cloning_metadir(require_stacking)
 
191
        result = metadir.initialize_on_transport(transport)
 
192
        repository_policy = None
251
193
        try:
252
194
            local_repo = self.find_repository()
253
195
        except errors.NoRepositoryPresent:
267
209
                        errors.UnstackableRepositoryFormat,
268
210
                        errors.NotStacked):
269
211
                    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.
 
212
 
273
213
        if local_repo:
 
214
            # may need to copy content in
 
215
            repository_policy = result.determine_repository_policy(
 
216
                force_new_repo, stacked_on, self.root_transport.base,
 
217
                require_stacking=require_stacking)
274
218
            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)
 
219
            result_repo = repository_policy.acquire_repository(
 
220
                make_working_trees, local_repo.is_shared())
 
221
            if not require_stacking and repository_policy._require_stacking:
 
222
                require_stacking = True
 
223
                result._format.require_stacking()
 
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
383
 
489
392
            stack_on_pwd = None
490
393
            config = found_bzrdir.get_config()
491
394
            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
 
395
            if config is not None:
 
396
                stack_on = config.get_default_stack_on()
 
397
                if stack_on is not None:
 
398
                    stack_on_pwd = found_bzrdir.root_transport.base
 
399
                    stop = True
 
400
                    note('Using default stacking branch %s at %s', stack_on,
 
401
                         stack_on_pwd)
496
402
            # does it have a repository ?
497
403
            try:
498
404
                repository = found_bzrdir.open_repository()
499
405
            except errors.NoRepositoryPresent:
500
406
                repository = None
501
407
            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.
 
408
                if ((found_bzrdir.root_transport.base !=
 
409
                     self.root_transport.base) and not repository.is_shared()):
505
410
                    repository = None
506
 
                    stop = True
507
411
                else:
508
412
                    stop = True
509
413
            if not stop:
533
437
    def _find_or_create_repository(self, force_new_repo):
534
438
        """Create a new repository if needed, returning the repository."""
535
439
        policy = self.determine_repository_policy(force_new_repo)
536
 
        return policy.acquire_repository()[0]
 
440
        return policy.acquire_repository()
537
441
 
538
442
    @staticmethod
539
443
    def create_branch_convenience(base, force_new_repo=False,
546
450
        not.
547
451
 
548
452
        This will use the current default BzrDirFormat unless one is
549
 
        specified, and use whatever
 
453
        specified, and use whatever 
550
454
        repository format that that uses via bzrdir.create_branch and
551
455
        create_repository. If a shared repository is available that is used
552
456
        preferentially. Whatever repository is used, its tree creation policy
554
458
 
555
459
        The created Branch object is returned.
556
460
        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
 
461
        no error is raised unless force_new_tree is True, in which case no 
558
462
        data is created on disk and NotLocalUrl is raised.
559
463
 
560
464
        :param base: The URL to create the branch at.
561
465
        :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
 
466
        :param force_new_tree: If True or False force creation of a tree or 
563
467
                               prevent such creation respectively.
564
468
        :param format: Override for the bzrdir format to create.
565
469
        :param possible_transports: An optional reusable transports list.
587
491
        'base' must be a local path or a file:// url.
588
492
 
589
493
        This will use the current default BzrDirFormat unless one is
590
 
        specified, and use whatever
 
494
        specified, and use whatever 
591
495
        repository format that that uses for bzrdirformat.create_workingtree,
592
496
        create_branch and create_repository.
593
497
 
605
509
    def create_workingtree(self, revision_id=None, from_branch=None,
606
510
        accelerator_tree=None, hardlink=False):
607
511
        """Create a working tree at this BzrDir.
608
 
 
 
512
        
609
513
        :param revision_id: create it as of this revision id.
610
514
        :param from_branch: override bzrdir branch (for lightweight checkouts)
611
515
        :param accelerator_tree: A tree which can be used for retrieving file
617
521
 
618
522
    def backup_bzrdir(self):
619
523
        """Backup this bzr control directory.
620
 
 
 
524
        
621
525
        :return: Tuple with old path name and new path name
622
526
        """
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()
 
527
        self.root_transport.copy_tree('.bzr', 'backup.bzr')
 
528
        return (self.root_transport.abspath('.bzr'),
 
529
                self.root_transport.abspath('backup.bzr'))
645
530
 
646
531
    def retire_bzrdir(self, limit=10000):
647
532
        """Permanently disable the bzrdir.
702
587
            if stop:
703
588
                return result
704
589
            next_transport = found_bzrdir.root_transport.clone('..')
705
 
            if (found_bzrdir.user_url == next_transport.base):
 
590
            if (found_bzrdir.root_transport.base == next_transport.base):
706
591
                # top of the file system
707
592
                return None
708
593
            # find the next containing bzrdir
725
610
                repository = found_bzrdir.open_repository()
726
611
            except errors.NoRepositoryPresent:
727
612
                return None, False
728
 
            if found_bzrdir.user_url == self.user_url:
 
613
            if found_bzrdir.root_transport.base == self.root_transport.base:
729
614
                return repository, True
730
615
            elif repository.is_shared():
731
616
                return repository, True
746
631
        """
747
632
        return None
748
633
 
749
 
    def get_branch_transport(self, branch_format, name=None):
 
634
    def get_branch_transport(self, branch_format):
750
635
        """Get the transport for use by branch format in this BzrDir.
751
636
 
752
637
        Note that bzr dirs that do not support format strings will raise
753
638
        IncompatibleFormat if the branch format they are given has
754
639
        a format string, and vice versa.
755
640
 
756
 
        If branch_format is None, the transport is returned with no
 
641
        If branch_format is None, the transport is returned with no 
757
642
        checking. If it is not None, then the returned transport is
758
643
        guaranteed to point to an existing directory ready for use.
759
644
        """
802
687
        if not self._mode_check_done:
803
688
            self._find_creation_modes()
804
689
        return self._dir_mode
805
 
 
 
690
        
806
691
    def get_repository_transport(self, repository_format):
807
692
        """Get the transport for use by repository format in this BzrDir.
808
693
 
810
695
        IncompatibleFormat if the repository format they are given has
811
696
        a format string, and vice versa.
812
697
 
813
 
        If repository_format is None, the transport is returned with no
 
698
        If repository_format is None, the transport is returned with no 
814
699
        checking. If it is not None, then the returned transport is
815
700
        guaranteed to point to an existing directory ready for use.
816
701
        """
817
702
        raise NotImplementedError(self.get_repository_transport)
818
 
 
 
703
        
819
704
    def get_workingtree_transport(self, tree_format):
820
705
        """Get the transport for use by workingtree format in this BzrDir.
821
706
 
823
708
        IncompatibleFormat if the workingtree format they are given has a
824
709
        format string, and vice versa.
825
710
 
826
 
        If workingtree_format is None, the transport is returned with no
 
711
        If workingtree_format is None, the transport is returned with no 
827
712
        checking. If it is not None, then the returned transport is
828
713
        guaranteed to point to an existing directory ready for use.
829
714
        """
830
715
        raise NotImplementedError(self.get_workingtree_transport)
831
716
 
832
717
    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
 
718
        if getattr(self, '_get_config', None) is None:
 
719
            return None
 
720
        return self._get_config()
839
721
 
840
722
    def __init__(self, _transport, _format):
841
723
        """Initialize a Bzr control dir object.
842
 
 
 
724
        
843
725
        Only really common logic should reside here, concrete classes should be
844
726
        made with varying behaviours.
845
727
 
847
729
        :param _transport: the transport this dir is based at.
848
730
        """
849
731
        self._format = _format
850
 
        # these are also under the more standard names of 
851
 
        # control_transport and user_transport
852
732
        self.transport = _transport.clone('.bzr')
853
733
        self.root_transport = _transport
854
734
        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
735
 
864
736
    def is_control_filename(self, filename):
865
737
        """True if filename is the name of a path which is reserved for bzrdir's.
866
 
 
 
738
        
867
739
        :param filename: A filename within the root transport of this bzrdir.
868
740
 
869
741
        This is true IF and ONLY IF the filename is part of the namespace reserved
872
744
        this in the future - for instance to make bzr talk with svn working
873
745
        trees.
874
746
        """
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-
 
747
        # this might be better on the BzrDirFormat class because it refers to 
 
748
        # all the possible bzrdir disk formats. 
 
749
        # This method is tested via the workingtree is_control_filename tests- 
878
750
        # it was extracted from WorkingTree.is_control_filename. If the method's
879
751
        # contract is extended beyond the current trivial implementation, please
880
752
        # add new tests for it to the appropriate place.
882
754
 
883
755
    def needs_format_conversion(self, format=None):
884
756
        """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
 
757
        
 
758
        For instance, if the repository format is out of date but the 
887
759
        branch and working tree are not, this should return True.
888
760
 
889
761
        :param format: Optional parameter indicating a specific desired
895
767
    def open_unsupported(base):
896
768
        """Open a branch which is not supported."""
897
769
        return BzrDir.open(base, _unsupported=True)
898
 
 
 
770
        
899
771
    @staticmethod
900
772
    def open(base, _unsupported=False, possible_transports=None):
901
773
        """Open an existing bzrdir, rooted at 'base' (url).
902
 
 
 
774
        
903
775
        :param _unsupported: a private parameter to the BzrDir class.
904
776
        """
905
777
        t = get_transport(base, possible_transports=possible_transports)
913
785
        :param transport: Transport containing the bzrdir.
914
786
        :param _unsupported: private.
915
787
        """
916
 
        for hook in BzrDir.hooks['pre_open']:
917
 
            hook(transport)
918
788
        # Keep initial base since 'transport' may be modified while following
919
789
        # the redirections.
920
790
        base = transport.base
940
810
        BzrDir._check_supported(format, _unsupported)
941
811
        return format.open(transport, _found=True)
942
812
 
943
 
    def open_branch(self, name=None, unsupported=False,
944
 
                    ignore_fallbacks=False):
 
813
    def open_branch(self, unsupported=False):
945
814
        """Open the branch object at this BzrDir if one is present.
946
815
 
947
816
        If unsupported is True, then no longer supported branch formats can
948
817
        still be opened.
949
 
 
 
818
        
950
819
        TODO: static convenience version of this?
951
820
        """
952
821
        raise NotImplementedError(self.open_branch)
954
823
    @staticmethod
955
824
    def open_containing(url, possible_transports=None):
956
825
        """Open an existing branch which contains url.
957
 
 
 
826
        
958
827
        :param url: url to search from.
959
828
        See open_containing_from_transport for more detail.
960
829
        """
961
830
        transport = get_transport(url, possible_transports)
962
831
        return BzrDir.open_containing_from_transport(transport)
963
 
 
 
832
    
964
833
    @staticmethod
965
834
    def open_containing_from_transport(a_transport):
966
835
        """Open an existing branch which contains a_transport.base.
969
838
 
970
839
        Basically we keep looking up until we find the control directory or
971
840
        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
 
841
        If there is one and it is either an unrecognised format or an unsupported 
973
842
        format, UnknownFormatError or UnsupportedFormatError are raised.
974
843
        If there is one, it is returned, along with the unused portion of url.
975
844
 
976
 
        :return: The BzrDir that contains the path, and a Unicode path
 
845
        :return: The BzrDir that contains the path, and a Unicode path 
977
846
                for the rest of the URL.
978
847
        """
979
848
        # this gets the normalised url back. I.e. '.' -> the full path.
1085
954
        """
1086
955
        raise NotImplementedError(self.open_workingtree)
1087
956
 
1088
 
    def has_branch(self, name=None):
 
957
    def has_branch(self):
1089
958
        """Tell if this bzrdir contains a branch.
1090
 
 
 
959
        
1091
960
        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.)
 
961
        and try, and not ask permission first.  (This method just opens the 
 
962
        branch and discards it, and that's somewhat expensive.) 
1094
963
        """
1095
964
        try:
1096
 
            self.open_branch(name)
 
965
            self.open_branch()
1097
966
            return True
1098
967
        except errors.NotBranchError:
1099
968
            return False
1103
972
 
1104
973
        This will still raise an exception if the bzrdir has a workingtree that
1105
974
        is remote & inaccessible.
1106
 
 
 
975
        
1107
976
        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.)
 
977
        and try, and not ask permission first.  (This method just opens the 
 
978
        workingtree and discards it, and that's somewhat expensive.) 
1110
979
        """
1111
980
        try:
1112
981
            self.open_workingtree(recommend_upgrade=False)
1116
985
 
1117
986
    def _cloning_metadir(self):
1118
987
        """Produce a metadir suitable for cloning with.
1119
 
 
 
988
        
1120
989
        :returns: (destination_bzrdir_format, source_repository)
1121
990
        """
1122
991
        result_format = self._format.__class__()
1123
992
        try:
1124
993
            try:
1125
 
                branch = self.open_branch(ignore_fallbacks=True)
 
994
                branch = self.open_branch()
1126
995
                source_repository = branch.repository
1127
996
                result_format._branch_format = branch._format
1128
997
            except errors.NotBranchError:
1165
1034
        """
1166
1035
        format, repository = self._cloning_metadir()
1167
1036
        if format._workingtree_format is None:
1168
 
            # No tree in self.
1169
1037
            if repository is None:
1170
 
                # No repository either
1171
1038
                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
1039
            tree_format = repository._format._matchingbzrdir.workingtree_format
1175
1040
            format.workingtree_format = tree_format.__class__()
1176
1041
        if require_stacking:
1183
1048
    def sprout(self, url, revision_id=None, force_new_repo=False,
1184
1049
               recurse='down', possible_transports=None,
1185
1050
               accelerator_tree=None, hardlink=False, stacked=False,
1186
 
               source_branch=None, create_tree_if_local=True):
 
1051
               source_branch=None):
1187
1052
        """Create a copy of this bzrdir prepared for use as a new line of
1188
1053
        development.
1189
1054
 
1204
1069
            where possible.
1205
1070
        :param stacked: If true, create a stacked branch referring to the
1206
1071
            location of this control directory.
1207
 
        :param create_tree_if_local: If true, a working-tree will be created
1208
 
            when working locally.
1209
1072
        """
1210
1073
        target_transport = get_transport(url, possible_transports)
1211
1074
        target_transport.ensure_base()
1233
1096
                    source_repository = None
1234
1097
        repository_policy = result.determine_repository_policy(
1235
1098
            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
 
1099
        result_repo = repository_policy.acquire_repository()
1242
1100
        if source_repository is not None:
1243
1101
            # Fetch while stacked to prevent unstacked fetch from
1244
1102
            # 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)
 
1103
            result_repo.fetch(source_repository, revision_id=revision_id)
1249
1104
 
1250
1105
        if source_branch is None:
1251
1106
            # this is for sprouting a bzrdir without a branch; is that
1253
1108
            # Not especially, but it's part of the contract.
1254
1109
            result_branch = result.create_branch()
1255
1110
        else:
1256
 
            result_branch = source_branch.sprout(result,
1257
 
                revision_id=revision_id, repository_policy=repository_policy)
 
1111
            # Force NULL revision to avoid using repository before stacking
 
1112
            # is configured.
 
1113
            result_branch = source_branch.sprout(
 
1114
                result, revision_id=_mod_revision.NULL_REVISION)
 
1115
            parent_location = result_branch.get_parent()
1258
1116
        mutter("created new branch %r" % (result_branch,))
 
1117
        repository_policy.configure_branch(result_branch)
 
1118
        if source_branch is not None:
 
1119
            source_branch.copy_content_into(result_branch, revision_id)
 
1120
            # Override copy_content_into
 
1121
            result_branch.set_parent(parent_location)
1259
1122
 
1260
1123
        # 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())):
 
1124
        if isinstance(target_transport, local.LocalTransport) and (
 
1125
            result_repo is None or result_repo.make_working_trees()):
1264
1126
            wt = result.create_workingtree(accelerator_tree=accelerator_tree,
1265
1127
                hardlink=hardlink)
1266
1128
            wt.lock_write()
1303
1165
                    basis.unlock()
1304
1166
        return result
1305
1167
 
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
1168
 
1422
1169
class BzrDirPreSplitOut(BzrDir):
1423
1170
    """A common class for the all-in-one formats."""
1463
1210
            tree.clone(result)
1464
1211
        return result
1465
1212
 
1466
 
    def create_branch(self, name=None):
 
1213
    def create_branch(self):
1467
1214
        """See BzrDir.create_branch."""
1468
 
        return self._format.get_branch_format().initialize(self, name=name)
 
1215
        return self._format.get_branch_format().initialize(self)
1469
1216
 
1470
 
    def destroy_branch(self, name=None):
 
1217
    def destroy_branch(self):
1471
1218
        """See BzrDir.destroy_branch."""
1472
1219
        raise errors.UnsupportedOperation(self.destroy_branch, self)
1473
1220
 
1494
1241
        # and that will have set it for us, its only
1495
1242
        # specific uses of create_workingtree in isolation
1496
1243
        # that can do wonky stuff here, and that only
1497
 
        # happens for creating checkouts, which cannot be
 
1244
        # happens for creating checkouts, which cannot be 
1498
1245
        # done on this format anyway. So - acceptable wart.
1499
 
        if hardlink:
1500
 
            warning("can't support hardlinked working trees in %r"
1501
 
                % (self,))
1502
1246
        try:
1503
1247
            result = self.open_workingtree(recommend_upgrade=False)
1504
1248
        except errors.NoSuchFile:
1526
1270
 
1527
1271
    def destroy_workingtree_metadata(self):
1528
1272
        """See BzrDir.destroy_workingtree_metadata."""
1529
 
        raise errors.UnsupportedOperation(self.destroy_workingtree_metadata,
 
1273
        raise errors.UnsupportedOperation(self.destroy_workingtree_metadata, 
1530
1274
                                          self)
1531
1275
 
1532
 
    def get_branch_transport(self, branch_format, name=None):
 
1276
    def get_branch_transport(self, branch_format):
1533
1277
        """See BzrDir.get_branch_transport()."""
1534
 
        if name is not None:
1535
 
            raise errors.NoColocatedBranchSupport(self)
1536
1278
        if branch_format is None:
1537
1279
            return self.transport
1538
1280
        try:
1566
1308
        # if the format is not the same as the system default,
1567
1309
        # an upgrade is needed.
1568
1310
        if format is None:
1569
 
            symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1570
 
                % 'needs_format_conversion(format=None)')
1571
1311
            format = BzrDirFormat.get_default_format()
1572
1312
        return not isinstance(self._format, format.__class__)
1573
1313
 
1574
 
    def open_branch(self, name=None, unsupported=False,
1575
 
                    ignore_fallbacks=False):
 
1314
    def open_branch(self, unsupported=False):
1576
1315
        """See BzrDir.open_branch."""
1577
1316
        from bzrlib.branch import BzrBranchFormat4
1578
1317
        format = BzrBranchFormat4()
1579
1318
        self._check_supported(format, unsupported)
1580
 
        return format.open(self, name, _found=True)
 
1319
        return format.open(self, _found=True)
1581
1320
 
1582
1321
    def sprout(self, url, revision_id=None, force_new_repo=False,
1583
1322
               possible_transports=None, accelerator_tree=None,
1584
 
               hardlink=False, stacked=False, create_tree_if_local=True,
1585
 
               source_branch=None):
 
1323
               hardlink=False, stacked=False):
1586
1324
        """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
1325
        if stacked:
1594
1326
            raise errors.UnstackableBranchFormat(
1595
1327
                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
1328
        from bzrlib.workingtree import WorkingTreeFormat2
1600
1329
        self._make_tail(url)
1601
1330
        result = self._format._initialize_for_clone(url)
1607
1336
            self.open_branch().sprout(result, revision_id=revision_id)
1608
1337
        except errors.NotBranchError:
1609
1338
            pass
1610
 
 
1611
1339
        # we always want a working tree
1612
1340
        WorkingTreeFormat2().initialize(result,
1613
1341
                                        accelerator_tree=accelerator_tree,
1617
1345
 
1618
1346
class BzrDir4(BzrDirPreSplitOut):
1619
1347
    """A .bzr version 4 control object.
1620
 
 
 
1348
    
1621
1349
    This is a deprecated format and may be removed after sept 2006.
1622
1350
    """
1623
1351
 
1627
1355
 
1628
1356
    def needs_format_conversion(self, format=None):
1629
1357
        """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
1358
        return True
1634
1359
 
1635
1360
    def open_repository(self):
1644
1369
    This is a deprecated format and may be removed after sept 2006.
1645
1370
    """
1646
1371
 
1647
 
    def has_workingtree(self):
1648
 
        """See BzrDir.has_workingtree."""
1649
 
        return True
1650
 
    
1651
1372
    def open_repository(self):
1652
1373
        """See BzrDir.open_repository."""
1653
1374
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
1669
1390
    This is a deprecated format and may be removed after sept 2006.
1670
1391
    """
1671
1392
 
1672
 
    def has_workingtree(self):
1673
 
        """See BzrDir.has_workingtree."""
1674
 
        return True
1675
 
    
1676
1393
    def open_repository(self):
1677
1394
        """See BzrDir.open_repository."""
1678
1395
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
1689
1406
 
1690
1407
class BzrDirMeta1(BzrDir):
1691
1408
    """A .bzr meta version 1 control object.
1692
 
 
1693
 
    This is the first control object where the
 
1409
    
 
1410
    This is the first control object where the 
1694
1411
    individual aspects are really split out: there are separate repository,
1695
1412
    workingtree and branch subdirectories and any subset of the three can be
1696
1413
    present within a BzrDir.
1700
1417
        """See BzrDir.can_convert_format()."""
1701
1418
        return True
1702
1419
 
1703
 
    def create_branch(self, name=None):
 
1420
    def create_branch(self):
1704
1421
        """See BzrDir.create_branch."""
1705
 
        return self._format.get_branch_format().initialize(self, name=name)
 
1422
        return self._format.get_branch_format().initialize(self)
1706
1423
 
1707
 
    def destroy_branch(self, name=None):
 
1424
    def destroy_branch(self):
1708
1425
        """See BzrDir.create_branch."""
1709
 
        if name is not None:
1710
 
            raise errors.NoColocatedBranchSupport(self)
1711
1426
        self.transport.delete_tree('branch')
1712
1427
 
1713
1428
    def create_repository(self, shared=False):
1756
1471
        format = BranchFormat.find_format(self)
1757
1472
        return format.get_reference(self)
1758
1473
 
1759
 
    def get_branch_transport(self, branch_format, name=None):
 
1474
    def get_branch_transport(self, branch_format):
1760
1475
        """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
1476
        if branch_format is None:
1766
1477
            return self.transport.clone('branch')
1767
1478
        try:
1802
1513
            pass
1803
1514
        return self.transport.clone('checkout')
1804
1515
 
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
1516
    def needs_format_conversion(self, format=None):
1822
1517
        """See BzrDir.needs_format_conversion()."""
1823
1518
        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
1519
            format = BzrDirFormat.get_default_format()
1828
1520
        if not isinstance(self._format, format.__class__):
1829
1521
            # it is not a meta dir format, conversion is needed.
1836
1528
                return True
1837
1529
        except errors.NoRepositoryPresent:
1838
1530
            pass
1839
 
        for branch in self.list_branches():
1840
 
            if not isinstance(branch._format,
 
1531
        try:
 
1532
            if not isinstance(self.open_branch()._format,
1841
1533
                              format.get_branch_format().__class__):
1842
1534
                # the branch needs an upgrade.
1843
1535
                return True
 
1536
        except errors.NotBranchError:
 
1537
            pass
1844
1538
        try:
1845
1539
            my_wt = self.open_workingtree(recommend_upgrade=False)
1846
1540
            if not isinstance(my_wt._format,
1851
1545
            pass
1852
1546
        return False
1853
1547
 
1854
 
    def open_branch(self, name=None, unsupported=False,
1855
 
                    ignore_fallbacks=False):
 
1548
    def open_branch(self, unsupported=False):
1856
1549
        """See BzrDir.open_branch."""
1857
1550
        format = self.find_branch_format()
1858
1551
        self._check_supported(format, unsupported)
1859
 
        return format.open(self, name=name,
1860
 
            _found=True, ignore_fallbacks=ignore_fallbacks)
 
1552
        return format.open(self, _found=True)
1861
1553
 
1862
1554
    def open_repository(self, unsupported=False):
1863
1555
        """See BzrDir.open_repository."""
1877
1569
        return format.open(self, _found=True)
1878
1570
 
1879
1571
    def _get_config(self):
1880
 
        return config.TransportConfig(self.transport, 'control.conf')
 
1572
        return config.BzrDirConfig(self.transport)
1881
1573
 
1882
1574
 
1883
1575
class BzrDirFormat(object):
1888
1580
     * a format string,
1889
1581
     * an open routine.
1890
1582
 
1891
 
    Formats are placed in a dict by their format string for reference
 
1583
    Formats are placed in a dict by their format string for reference 
1892
1584
    during bzrdir opening. These should be subclasses of BzrDirFormat
1893
1585
    for consistency.
1894
1586
 
1895
1587
    Once a format is deprecated, just deprecate the initialize and open
1896
 
    methods on the format class. Do not deprecate the object, as the
 
1588
    methods on the format class. Do not deprecate the object, as the 
1897
1589
    object will be created every system load.
1898
 
 
1899
 
    :cvar colocated_branches: Whether this formats supports colocated branches.
1900
1590
    """
1901
1591
 
1902
1592
    _default_format = None
1907
1597
 
1908
1598
    _control_formats = []
1909
1599
    """The registered control formats - .bzr, ....
1910
 
 
 
1600
    
1911
1601
    This is a list of BzrDirFormat objects.
1912
1602
    """
1913
1603
 
1919
1609
 
1920
1610
    _lock_file_name = 'branch-lock'
1921
1611
 
1922
 
    colocated_branches = False
1923
 
    """Whether co-located branches are supported for this control dir format.
1924
 
    """
1925
 
 
1926
1612
    # _lock_class must be set in subclasses to the lock type, typ.
1927
1613
    # TransportLock or LockDir
1928
1614
 
1945
1631
    def probe_transport(klass, transport):
1946
1632
        """Return the .bzrdir style format present in a directory."""
1947
1633
        try:
1948
 
            format_string = transport.get_bytes(".bzr/branch-format")
 
1634
            format_string = transport.get(".bzr/branch-format").read()
1949
1635
        except errors.NoSuchFile:
1950
1636
            raise errors.NotBranchError(path=transport.base)
1951
1637
 
1976
1662
        current default format. In the case of plugins we can/should provide
1977
1663
        some means for them to extend the range of returnable converters.
1978
1664
 
1979
 
        :param format: Optional format to override the default format of the
 
1665
        :param format: Optional format to override the default format of the 
1980
1666
                       library.
1981
1667
        """
1982
1668
        raise NotImplementedError(self.get_converter)
1983
1669
 
1984
1670
    def initialize(self, url, possible_transports=None):
1985
1671
        """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
 
 
 
1672
        
1991
1673
        Subclasses should typically override initialize_on_transport
1992
1674
        instead of this method.
1993
1675
        """
1996
1678
 
1997
1679
    def initialize_on_transport(self, transport):
1998
1680
        """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
 
1681
        # Since we don't have a .bzr directory, inherit the
2119
1682
        # mode from the root directory
2120
1683
        temp_control = lockable_files.LockableFiles(transport,
2121
1684
                            '', lockable_files.TransportLock)
2151
1714
        """Is this format supported?
2152
1715
 
2153
1716
        Supported formats must be initializable and openable.
2154
 
        Unsupported formats may not support initialization or committing or
 
1717
        Unsupported formats may not support initialization or committing or 
2155
1718
        some other features depending on the reason for not being supported.
2156
1719
        """
2157
1720
        return True
2158
1721
 
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
1722
    def same_model(self, target_format):
2170
 
        return (self.repository_format.rich_root_data ==
 
1723
        return (self.repository_format.rich_root_data == 
2171
1724
            target_format.rich_root_data)
2172
1725
 
2173
1726
    @classmethod
2174
1727
    def known_formats(klass):
2175
1728
        """Return all the known formats.
2176
 
 
 
1729
        
2177
1730
        Concrete formats should override _known_formats.
2178
1731
        """
2179
 
        # There is double indirection here to make sure that control
2180
 
        # formats used by more than one dir format will only be probed
 
1732
        # There is double indirection here to make sure that control 
 
1733
        # formats used by more than one dir format will only be probed 
2181
1734
        # once. This can otherwise be quite expensive for remote connections.
2182
1735
        result = set()
2183
1736
        for format in klass._control_formats:
2184
1737
            result.update(format._known_formats())
2185
1738
        return result
2186
 
 
 
1739
    
2187
1740
    @classmethod
2188
1741
    def _known_formats(klass):
2189
1742
        """Return the known format instances for this control format."""
2191
1744
 
2192
1745
    def open(self, transport, _found=False):
2193
1746
        """Return an instance of this format for the dir transport points at.
2194
 
 
 
1747
        
2195
1748
        _found is a private parameter, do not use it.
2196
1749
        """
2197
1750
        if not _found:
2198
1751
            found_format = BzrDirFormat.find_format(transport)
2199
1752
            if not isinstance(found_format, self.__class__):
2200
1753
                raise AssertionError("%s was asked to open %s, but it seems to need "
2201
 
                        "format %s"
 
1754
                        "format %s" 
2202
1755
                        % (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
1756
        return self._open(transport)
2207
1757
 
2208
1758
    def _open(self, transport):
2216
1766
    @classmethod
2217
1767
    def register_format(klass, format):
2218
1768
        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
1769
 
2222
1770
    @classmethod
2223
1771
    def register_control_format(klass, format):
2224
1772
        """Register a format that does not use '.bzr' for its control dir.
2225
1773
 
2226
1774
        TODO: This should be pulled up into a 'ControlDirFormat' base class
2227
 
        which BzrDirFormat can inherit from, and renamed to register_format
 
1775
        which BzrDirFormat can inherit from, and renamed to register_format 
2228
1776
        there. It has been done without that for now for simplicity of
2229
1777
        implementation.
2230
1778
        """
2248
1796
 
2249
1797
    def __str__(self):
2250
1798
        # 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
 
        """
 
1799
        return self.get_format_string().rstrip()
2264
1800
 
2265
1801
    @classmethod
2266
1802
    def unregister_format(klass, format):
2298
1834
        """See BzrDirFormat.get_converter()."""
2299
1835
        # there is one and only one upgrade path here.
2300
1836
        return ConvertBzrDir4To5()
2301
 
 
 
1837
        
2302
1838
    def initialize_on_transport(self, transport):
2303
1839
        """Format 4 branches cannot be created."""
2304
1840
        raise errors.UninitializableFormat(self)
2307
1843
        """Format 4 is not supported.
2308
1844
 
2309
1845
        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
 
1846
        conversion logic is expensive - so doing it on the fly was not 
2311
1847
        feasible.
2312
1848
        """
2313
1849
        return False
2314
1850
 
2315
 
    def network_name(self):
2316
 
        return self.get_format_string()
2317
 
 
2318
1851
    def _open(self, transport):
2319
1852
        """See BzrDirFormat._open."""
2320
1853
        return BzrDir4(transport, self)
2326
1859
    repository_format = property(__return_repository_format)
2327
1860
 
2328
1861
 
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):
 
1862
class BzrDirFormat5(BzrDirFormat):
2355
1863
    """Bzr control format 5.
2356
1864
 
2357
1865
    This format is a combined format for working tree, branch and repository.
2358
1866
    It has:
2359
 
     - Format 2 working trees [always]
2360
 
     - Format 4 branches [always]
 
1867
     - Format 2 working trees [always] 
 
1868
     - Format 4 branches [always] 
2361
1869
     - Format 5 repositories [always]
2362
1870
       Unhashed stores in the repository.
2363
1871
    """
2383
1891
 
2384
1892
    def _initialize_for_clone(self, url):
2385
1893
        return self.initialize_on_transport(get_transport(url), _cloning=True)
2386
 
 
 
1894
        
2387
1895
    def initialize_on_transport(self, transport, _cloning=False):
2388
1896
        """Format 5 dirs always have working tree, branch and repository.
2389
 
 
 
1897
        
2390
1898
        Except when they are being cloned.
2391
1899
        """
2392
1900
        from bzrlib.branch import BzrBranchFormat4
2398
1906
            result._init_workingtree()
2399
1907
        return result
2400
1908
 
2401
 
    def network_name(self):
2402
 
        return self.get_format_string()
2403
 
 
2404
1909
    def _open(self, transport):
2405
1910
        """See BzrDirFormat._open."""
2406
1911
        return BzrDir5(transport, self)
2412
1917
    repository_format = property(__return_repository_format)
2413
1918
 
2414
1919
 
2415
 
class BzrDirFormat6(BzrDirFormatAllInOne):
 
1920
class BzrDirFormat6(BzrDirFormat):
2416
1921
    """Bzr control format 6.
2417
1922
 
2418
1923
    This format is a combined format for working tree, branch and repository.
2419
1924
    It has:
2420
 
     - Format 2 working trees [always]
2421
 
     - Format 4 branches [always]
 
1925
     - Format 2 working trees [always] 
 
1926
     - Format 4 branches [always] 
2422
1927
     - Format 6 repositories [always]
2423
1928
    """
2424
1929
 
2440
1945
        """See BzrDirFormat.get_converter()."""
2441
1946
        # there is one and only one upgrade path here.
2442
1947
        return ConvertBzrDir6ToMeta()
2443
 
 
 
1948
        
2444
1949
    def _initialize_for_clone(self, url):
2445
1950
        return self.initialize_on_transport(get_transport(url), _cloning=True)
2446
1951
 
2447
1952
    def initialize_on_transport(self, transport, _cloning=False):
2448
1953
        """Format 6 dirs always have working tree, branch and repository.
2449
 
 
 
1954
        
2450
1955
        Except when they are being cloned.
2451
1956
        """
2452
1957
        from bzrlib.branch import BzrBranchFormat4
2458
1963
            result._init_workingtree()
2459
1964
        return result
2460
1965
 
2461
 
    def network_name(self):
2462
 
        return self.get_format_string()
2463
 
 
2464
1966
    def _open(self, transport):
2465
1967
        """See BzrDirFormat._open."""
2466
1968
        return BzrDir6(transport, self)
2488
1990
    def __init__(self):
2489
1991
        self._workingtree_format = None
2490
1992
        self._branch_format = None
2491
 
        self._repository_format = None
2492
1993
 
2493
1994
    def __eq__(self, other):
2494
1995
        if other.__class__ is not self.__class__:
2511
2012
    def set_branch_format(self, format):
2512
2013
        self._branch_format = format
2513
2014
 
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
 
 
 
2015
    def require_stacking(self):
2587
2016
        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()
 
2017
            # We need to make a stacked branch, but the default format for the
 
2018
            # target doesn't support stacking.  So force a branch that *can*
 
2019
            # support stacking.
 
2020
            from bzrlib.branch import BzrBranchFormat7
 
2021
            self._branch_format = BzrBranchFormat7()
 
2022
            mutter("using %r for stacking" % (self._branch_format,))
 
2023
            from bzrlib.repofmt import pack_repo
 
2024
            if self.repository_format.rich_root_data:
 
2025
                bzrdir_format_name = '1.6.1-rich-root'
 
2026
                repo_format = pack_repo.RepositoryFormatKnitPack5RichRoot()
2595
2027
            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())
 
2028
                bzrdir_format_name = '1.6'
 
2029
                repo_format = pack_repo.RepositoryFormatKnitPack5()
 
2030
            note('Source format does not support stacking, using format:'
 
2031
                 ' \'%s\'\n  %s\n',
 
2032
                 bzrdir_format_name, repo_format.get_format_description())
 
2033
            self.repository_format = repo_format
2605
2034
 
2606
2035
    def get_converter(self, format=None):
2607
2036
        """See BzrDirFormat.get_converter()."""
2620
2049
        """See BzrDirFormat.get_format_description()."""
2621
2050
        return "Meta directory format 1"
2622
2051
 
2623
 
    def network_name(self):
2624
 
        return self.get_format_string()
2625
 
 
2626
2052
    def _open(self, transport):
2627
2053
        """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)
 
2054
        return BzrDirMeta1(transport, self)
2634
2055
 
2635
2056
    def __return_repository_format(self):
2636
2057
        """Circular import protection."""
2637
 
        if self._repository_format:
 
2058
        if getattr(self, '_repository_format', None):
2638
2059
            return self._repository_format
2639
2060
        from bzrlib.repository import RepositoryFormat
2640
2061
        return RepositoryFormat.get_default_format()
2641
2062
 
2642
 
    def _set_repository_format(self, value):
 
2063
    def __set_repository_format(self, value):
2643
2064
        """Allow changing the repository format for metadir formats."""
2644
2065
        self._repository_format = value
2645
2066
 
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
 
2067
    repository_format = property(__return_repository_format, __set_repository_format)
2666
2068
 
2667
2069
    def __get_workingtree_format(self):
2668
2070
        if self._workingtree_format is None:
2677
2079
                                  __set_workingtree_format)
2678
2080
 
2679
2081
 
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
2082
# Register bzr control format
2690
2083
BzrDirFormat.register_control_format(BzrDirFormat)
2691
2084
 
2723
2116
        self.absent_revisions = set()
2724
2117
        self.text_count = 0
2725
2118
        self.revisions = {}
2726
 
 
 
2119
        
2727
2120
    def convert(self, to_convert, pb):
2728
2121
        """See Converter.convert()."""
2729
2122
        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()
 
2123
        self.pb = pb
 
2124
        self.pb.note('starting upgrade from format 4 to 5')
 
2125
        if isinstance(self.bzrdir.transport, local.LocalTransport):
 
2126
            self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
 
2127
        self._convert_to_weaves()
 
2128
        return BzrDir.open(self.bzrdir.root_transport.base)
2741
2129
 
2742
2130
    def _convert_to_weaves(self):
2743
 
        ui.ui_factory.note('note: upgrade may be faster if all store files are ungzipped first')
 
2131
        self.pb.note('note: upgrade may be faster if all store files are ungzipped first')
2744
2132
        try:
2745
2133
            # TODO permissions
2746
2134
            stat = self.bzrdir.transport.stat('weaves')
2774
2162
        self.pb.clear()
2775
2163
        self._write_all_weaves()
2776
2164
        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)
 
2165
        self.pb.note('upgraded to weaves:')
 
2166
        self.pb.note('  %6d revisions and inventories', len(self.revisions))
 
2167
        self.pb.note('  %6d revisions not present', len(self.absent_revisions))
 
2168
        self.pb.note('  %6d texts', self.text_count)
2781
2169
        self._cleanup_spare_files_after_format4()
2782
2170
        self.branch._transport.put_bytes(
2783
2171
            'branch-format',
2840
2228
                revision_store.add_lines(key, None, osutils.split_lines(text))
2841
2229
        finally:
2842
2230
            self.pb.clear()
2843
 
 
 
2231
            
2844
2232
    def _load_one_rev(self, rev_id):
2845
2233
        """Load a revision object into memory.
2846
2234
 
2851
2239
                       len(self.known_revisions))
2852
2240
        if not self.branch.repository.has_revision(rev_id):
2853
2241
            self.pb.clear()
2854
 
            ui.ui_factory.note('revision {%s} not present in branch; '
2855
 
                         'will be converted as a ghost' %
 
2242
            self.pb.note('revision {%s} not present in branch; '
 
2243
                         'will be converted as a ghost',
2856
2244
                         rev_id)
2857
2245
            self.absent_revisions.add(rev_id)
2858
2246
        else:
2920
2308
        text_changed = False
2921
2309
        parent_candiate_entries = ie.parent_candidates(parent_invs)
2922
2310
        heads = graph.Graph(self).heads(parent_candiate_entries.keys())
2923
 
        # XXX: Note that this is unordered - and this is tolerable because
 
2311
        # XXX: Note that this is unordered - and this is tolerable because 
2924
2312
        # the previous code was also unordered.
2925
2313
        previous_entries = dict((head, parent_candiate_entries[head]) for head
2926
2314
            in heads)
2927
2315
        self.snapshot_ie(previous_entries, ie, w, rev_id)
2928
2316
        del ie.text_id
2929
2317
 
 
2318
    @symbol_versioning.deprecated_method(symbol_versioning.one_one)
 
2319
    def get_parents(self, revision_ids):
 
2320
        for revision_id in revision_ids:
 
2321
            yield self.revisions[revision_id].parent_ids
 
2322
 
2930
2323
    def get_parent_map(self, revision_ids):
2931
 
        """See graph.StackedParentsProvider.get_parent_map"""
 
2324
        """See graph._StackedParentsProvider.get_parent_map"""
2932
2325
        return dict((revision_id, self.revisions[revision_id])
2933
2326
                    for revision_id in revision_ids
2934
2327
                     if revision_id in self.revisions)
2938
2331
        # a call to:. This needs the path figured out. rather than a work_tree
2939
2332
        # a v4 revision_tree can be given, or something that looks enough like
2940
2333
        # 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
 
2334
        # and we need something that looks like a weave store for snapshot to 
2942
2335
        # save against.
2943
2336
        #ie.snapshot(rev, PATH, previous_revisions, REVISION_TREE, InMemoryWeaveStore(self.text_weaves))
2944
2337
        if len(previous_revisions) == 1:
2984
2377
    def convert(self, to_convert, pb):
2985
2378
        """See Converter.convert()."""
2986
2379
        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()
 
2380
        self.pb = pb
 
2381
        self.pb.note('starting upgrade from format 5 to 6')
 
2382
        self._convert_to_prefixed()
 
2383
        return BzrDir.open(self.bzrdir.root_transport.base)
2994
2384
 
2995
2385
    def _convert_to_prefixed(self):
2996
2386
        from bzrlib.store import TransportStore
2997
2387
        self.bzrdir.transport.delete('branch-format')
2998
2388
        for store_name in ["weaves", "revision-store"]:
2999
 
            ui.ui_factory.note("adding prefixes to %s" % store_name)
 
2389
            self.pb.note("adding prefixes to %s" % store_name)
3000
2390
            store_transport = self.bzrdir.transport.clone(store_name)
3001
2391
            store = TransportStore(store_transport, prefixed=True)
3002
2392
            for urlfilename in store_transport.list_dir('.'):
3029
2419
        from bzrlib.repofmt.weaverepo import RepositoryFormat7
3030
2420
        from bzrlib.branch import BzrBranchFormat5
3031
2421
        self.bzrdir = to_convert
3032
 
        self.pb = ui.ui_factory.nested_progress_bar()
 
2422
        self.pb = pb
3033
2423
        self.count = 0
3034
2424
        self.total = 20 # the steps we know about
3035
2425
        self.garbage_inventories = []
3036
2426
        self.dir_mode = self.bzrdir._get_dir_mode()
3037
2427
        self.file_mode = self.bzrdir._get_file_mode()
3038
2428
 
3039
 
        ui.ui_factory.note('starting upgrade from format 6 to metadir')
 
2429
        self.pb.note('starting upgrade from format 6 to metadir')
3040
2430
        self.bzrdir.transport.put_bytes(
3041
2431
                'branch-format',
3042
2432
                "Converting to format 6",
3063
2453
        self.bzrdir.transport.mkdir('repository', mode=self.dir_mode)
3064
2454
        self.make_lock('repository')
3065
2455
        # we hard code the formats here because we are converting into
3066
 
        # the meta format. The meta format upgrader can take this to a
 
2456
        # the meta format. The meta format upgrader can take this to a 
3067
2457
        # future format within each component.
3068
2458
        self.put_format('repository', RepositoryFormat7())
3069
2459
        for entry in repository_names:
3092
2482
        else:
3093
2483
            has_checkout = True
3094
2484
        if not has_checkout:
3095
 
            ui.ui_factory.note('No working tree.')
 
2485
            self.pb.note('No working tree.')
3096
2486
            # If some checkout files are there, we may as well get rid of them.
3097
2487
            for name, mandatory in checkout_files:
3098
2488
                if name in bzrcontents:
3115
2505
            'branch-format',
3116
2506
            BzrDirMetaFormat1().get_format_string(),
3117
2507
            mode=self.file_mode)
3118
 
        self.pb.finished()
3119
 
        return BzrDir.open(self.bzrdir.user_url)
 
2508
        return BzrDir.open(self.bzrdir.root_transport.base)
3120
2509
 
3121
2510
    def make_lock(self, name):
3122
2511
        """Make a lock for the new control dir name."""
3157
2546
    def convert(self, to_convert, pb):
3158
2547
        """See Converter.convert()."""
3159
2548
        self.bzrdir = to_convert
3160
 
        self.pb = ui.ui_factory.nested_progress_bar()
 
2549
        self.pb = pb
3161
2550
        self.count = 0
3162
2551
        self.total = 1
3163
2552
        self.step('checking repository format')
3168
2557
        else:
3169
2558
            if not isinstance(repo._format, self.target_format.repository_format.__class__):
3170
2559
                from bzrlib.repository import CopyConverter
3171
 
                ui.ui_factory.note('starting repository conversion')
 
2560
                self.pb.note('starting repository conversion')
3172
2561
                converter = CopyConverter(self.target_format.repository_format)
3173
2562
                converter.convert(repo, pb)
3174
 
        for branch in self.bzrdir.list_branches():
 
2563
        try:
 
2564
            branch = self.bzrdir.open_branch()
 
2565
        except errors.NotBranchError:
 
2566
            pass
 
2567
        else:
3175
2568
            # TODO: conversions of Branch and Tree should be done by
3176
2569
            # InterXFormat lookups/some sort of registry.
3177
2570
            # Avoid circular imports
3181
2574
            while old != new:
3182
2575
                if (old == _mod_branch.BzrBranchFormat5 and
3183
2576
                    new in (_mod_branch.BzrBranchFormat6,
3184
 
                        _mod_branch.BzrBranchFormat7,
3185
 
                        _mod_branch.BzrBranchFormat8)):
 
2577
                        _mod_branch.BzrBranchFormat7)):
3186
2578
                    branch_converter = _mod_branch.Converter5to6()
3187
2579
                elif (old == _mod_branch.BzrBranchFormat6 and
3188
 
                    new in (_mod_branch.BzrBranchFormat7,
3189
 
                            _mod_branch.BzrBranchFormat8)):
 
2580
                    new == _mod_branch.BzrBranchFormat7):
3190
2581
                    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
2582
                else:
3195
 
                    raise errors.BadConversionTarget("No converter", new,
3196
 
                        branch._format)
 
2583
                    raise errors.BadConversionTarget("No converter", new)
3197
2584
                branch_converter.convert(branch)
3198
2585
                branch = self.bzrdir.open_branch()
3199
2586
                old = branch._format.__class__
3214
2601
                isinstance(self.target_format.workingtree_format,
3215
2602
                    workingtree_4.WorkingTreeFormat5)):
3216
2603
                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
2604
        return to_convert
3224
2605
 
3225
2606
 
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.
 
2607
# This is not in remote.py because it's small, and needs to be registered.
 
2608
# Putting it in remote.py creates a circular import problem.
3228
2609
# we can make it a lazy object if the control formats is turned into something
3229
2610
# like a registry.
3230
2611
class RemoteBzrDirFormat(BzrDirMetaFormat1):
3231
2612
    """Format representing bzrdirs accessed via a smart server"""
3232
2613
 
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
2614
    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
2615
        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
 
 
 
2616
    
3260
2617
    @classmethod
3261
2618
    def probe_transport(klass, transport):
3262
2619
        """Return a RemoteBzrDirFormat object if it looks possible."""
3291
2648
            return local_dir_format.initialize_on_transport(transport)
3292
2649
        client = _SmartClient(client_medium)
3293
2650
        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)
 
2651
        response = client.call('BzrDirFormat.initialize', path)
3298
2652
        if response[0] != 'ok':
3299
2653
            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
 
2654
        return remote.RemoteBzrDir(transport)
3449
2655
 
3450
2656
    def _open(self, transport):
3451
 
        return remote.RemoteBzrDir(transport, self)
 
2657
        return remote.RemoteBzrDir(transport)
3452
2658
 
3453
2659
    def __eq__(self, other):
3454
2660
        if not isinstance(other, RemoteBzrDirFormat):
3455
2661
            return False
3456
2662
        return self.get_format_description() == other.get_format_description()
3457
2663
 
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)
 
2664
    @property
 
2665
    def repository_format(self):
 
2666
        # Using a property to avoid early loading of remote
 
2667
        return remote.RemoteRepositoryFormat()
3486
2668
 
3487
2669
 
3488
2670
BzrDirFormat.register_control_server_format(RemoteBzrDirFormat)
3499
2681
 
3500
2682
class BzrDirFormatRegistry(registry.Registry):
3501
2683
    """Registry of user-selectable BzrDir subformats.
3502
 
 
 
2684
    
3503
2685
    Differs from BzrDirFormat._control_formats in that it provides sub-formats,
3504
2686
    e.g. BzrDirMeta1 with weave repository.  Also, it's more user-oriented.
3505
2687
    """
3524
2706
        """Register a metadir subformat.
3525
2707
 
3526
2708
        These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
3527
 
        by the Repository/Branch/WorkingTreeformats.
 
2709
        by the Repository format.
3528
2710
 
3529
2711
        :param repository_format: The fully-qualified repository format class
3530
2712
            name as a string.
3564
2746
    def register(self, key, factory, help, native=True, deprecated=False,
3565
2747
                 hidden=False, experimental=False, alias=False):
3566
2748
        """Register a BzrDirFormat factory.
3567
 
 
 
2749
        
3568
2750
        The factory must be a callable that takes one parameter: the key.
3569
2751
        It must produce an instance of the BzrDirFormat when called.
3570
2752
 
3587
2769
 
3588
2770
    def set_default(self, key):
3589
2771
        """Set the 'default' key to be a clone of the supplied key.
3590
 
 
 
2772
        
3591
2773
        This method must be called once and only once.
3592
2774
        """
3593
2775
        registry.Registry.register(self, 'default', self.get(key),
3596
2778
 
3597
2779
    def set_default_repository(self, key):
3598
2780
        """Set the FormatRegistry default and Repository default.
3599
 
 
 
2781
        
3600
2782
        This is a transitional method while Repository.set_default_format
3601
2783
        is deprecated.
3602
2784
        """
3625
2807
        def wrapped(key, help, info):
3626
2808
            if info.native:
3627
2809
                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))
 
2810
            return ':%s:\n%s\n\n' % (key, 
 
2811
                    textwrap.fill(help, initial_indent='    ', 
 
2812
                    subsequent_indent='    '))
3632
2813
        if default_realkey is not None:
3633
2814
            output += wrapped(default_realkey, '(default) %s' % default_help,
3634
2815
                              self.get_info('default'))
3644
2825
                experimental_pairs.append((key, help))
3645
2826
            else:
3646
2827
                output += wrapped(key, help, info)
3647
 
        output += "\nSee :doc:`formats-help` for more about storage formats."
 
2828
        output += "\nSee ``bzr help formats`` for more about storage formats."
3648
2829
        other_output = ""
3649
2830
        if len(experimental_pairs) > 0:
3650
2831
            other_output += "Experimental formats are shown below.\n\n"
3663
2844
            other_output += \
3664
2845
                "\nNo deprecated formats are available.\n\n"
3665
2846
        other_output += \
3666
 
                "\nSee :doc:`formats-help` for more about storage formats."
 
2847
            "\nSee ``bzr help formats`` for more about storage formats."
3667
2848
 
3668
2849
        if topic == 'other-formats':
3669
2850
            return other_output
3703
2884
            try:
3704
2885
                stack_on = urlutils.rebase_url(self._stack_on,
3705
2886
                    self._stack_on_pwd,
3706
 
                    branch.user_url)
 
2887
                    branch.bzrdir.root_transport.base)
3707
2888
            except errors.InvalidRebaseURLs:
3708
2889
                stack_on = self._get_full_stack_on()
3709
2890
        try:
3710
2891
            branch.set_stacked_on_url(stack_on)
3711
 
        except (errors.UnstackableBranchFormat,
3712
 
                errors.UnstackableRepositoryFormat):
 
2892
        except errors.UnstackableBranchFormat:
3713
2893
            if self._require_stacking:
3714
2894
                raise
3715
2895
 
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
2896
    def _get_full_stack_on(self):
3721
2897
        """Get a fully-qualified URL for the stack_on location."""
3722
2898
        if self._stack_on is None:
3731
2907
        stack_on = self._get_full_stack_on()
3732
2908
        if stack_on is None:
3733
2909
            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
 
2910
        stacked_dir = BzrDir.open(stack_on,
 
2911
                                  possible_transports=possible_transports)
3741
2912
        try:
3742
2913
            stacked_repo = stacked_dir.open_branch().repository
3743
2914
        except errors.NotBranchError:
3758
2929
        :param make_working_trees: If creating a repository, set
3759
2930
            make_working_trees to this value (if non-None)
3760
2931
        :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).
 
2932
        :return: A repository
3763
2933
        """
3764
2934
        raise NotImplemented(RepositoryAcquisitionPolicy.acquire_repository)
3765
2935
 
3785
2955
 
3786
2956
        Creates the desired repository in the bzrdir we already have.
3787
2957
        """
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
2958
        repository = self._bzrdir.create_repository(shared=shared)
3798
2959
        self._add_fallback(repository,
3799
2960
                           possible_transports=[self._bzrdir.transport])
3800
2961
        if make_working_trees is not None:
3801
2962
            repository.set_make_working_trees(make_working_trees)
3802
 
        return repository, True
 
2963
        return repository
3803
2964
 
3804
2965
 
3805
2966
class UseExistingRepository(RepositoryAcquisitionPolicy):
3821
2982
    def acquire_repository(self, make_working_trees=None, shared=False):
3822
2983
        """Implementation of RepositoryAcquisitionPolicy.acquire_repository
3823
2984
 
3824
 
        Returns an existing repository to use.
 
2985
        Returns an existing repository to use
3825
2986
        """
3826
2987
        self._add_fallback(self._repository,
3827
2988
                       possible_transports=[self._repository.bzrdir.transport])
3828
 
        return self._repository, False
 
2989
        return self._repository
3829
2990
 
3830
2991
 
3831
2992
# Please register new formats after old formats so that formats
3832
2993
# appear in chronological order and format descriptions can build
3833
2994
# on previous ones.
3834
2995
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
2996
format_registry.register('weave', BzrDirFormat6,
3839
2997
    'Pre-0.8 format.  Slower than knit and does not'
3840
2998
    ' support checkouts or shared repositories.',
3841
 
    hidden=True,
3842
2999
    deprecated=True)
3843
3000
format_registry.register_metadir('metaweave',
3844
3001
    'bzrlib.repofmt.weaverepo.RepositoryFormat7',
3845
3002
    'Transitional format in 0.8.  Slower than knit.',
3846
3003
    branch_format='bzrlib.branch.BzrBranchFormat5',
3847
3004
    tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3848
 
    hidden=True,
3849
3005
    deprecated=True)
3850
3006
format_registry.register_metadir('knit',
3851
3007
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3852
3008
    'Format using knits.  Recommended for interoperation with bzr <= 0.14.',
3853
3009
    branch_format='bzrlib.branch.BzrBranchFormat5',
3854
3010
    tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3855
 
    hidden=True,
3856
3011
    deprecated=True)
3857
3012
format_registry.register_metadir('dirstate',
3858
3013
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3862
3017
    # this uses bzrlib.workingtree.WorkingTreeFormat4 because importing
3863
3018
    # directly from workingtree_4 triggers a circular import.
3864
3019
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3865
 
    hidden=True,
3866
3020
    deprecated=True)
3867
3021
format_registry.register_metadir('dirstate-tags',
3868
3022
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3871
3025
        ' Incompatible with bzr < 0.15.',
3872
3026
    branch_format='bzrlib.branch.BzrBranchFormat6',
3873
3027
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3874
 
    hidden=True,
3875
3028
    deprecated=True)
3876
3029
format_registry.register_metadir('rich-root',
3877
3030
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
3879
3032
        ' bzr < 1.0.',
3880
3033
    branch_format='bzrlib.branch.BzrBranchFormat6',
3881
3034
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3882
 
    hidden=True,
3883
3035
    deprecated=True)
3884
3036
format_registry.register_metadir('dirstate-with-subtree',
3885
3037
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
3896
3048
    help='New in 0.92: Pack-based format with data compatible with '
3897
3049
        'dirstate-tags format repositories. Interoperates with '
3898
3050
        'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3899
 
        ,
 
3051
        'Previously called knitpack-experimental.  '
 
3052
        'For more information, see '
 
3053
        'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
3900
3054
    branch_format='bzrlib.branch.BzrBranchFormat6',
3901
3055
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3902
3056
    )
3905
3059
    help='New in 0.92: Pack-based format with data compatible with '
3906
3060
        'dirstate-with-subtree format repositories. Interoperates with '
3907
3061
        'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3908
 
        ,
 
3062
        'Previously called knitpack-experimental.  '
 
3063
        'For more information, see '
 
3064
        'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
3909
3065
    branch_format='bzrlib.branch.BzrBranchFormat6',
3910
3066
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3911
3067
    hidden=True,
3914
3070
format_registry.register_metadir('rich-root-pack',
3915
3071
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
3916
3072
    help='New in 1.0: A variant of pack-0.92 that supports rich-root data '
3917
 
         '(needed for bzr-svn and bzr-git).',
 
3073
         '(needed for bzr-svn).',
3918
3074
    branch_format='bzrlib.branch.BzrBranchFormat6',
3919
3075
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3920
 
    hidden=True,
3921
3076
    )
3922
3077
format_registry.register_metadir('1.6',
3923
3078
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5',
3926
3081
         'not present locally.',
3927
3082
    branch_format='bzrlib.branch.BzrBranchFormat7',
3928
3083
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3929
 
    hidden=True,
3930
3084
    )
3931
3085
format_registry.register_metadir('1.6.1-rich-root',
3932
3086
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5RichRoot',
3933
3087
    help='A variant of 1.6 that supports rich-root data '
3934
 
         '(needed for bzr-svn and bzr-git).',
 
3088
         '(needed for bzr-svn).',
3935
3089
    branch_format='bzrlib.branch.BzrBranchFormat7',
3936
3090
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3937
 
    hidden=True,
3938
3091
    )
3939
3092
format_registry.register_metadir('1.9',
3940
3093
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3943
3096
         'performance for most operations.',
3944
3097
    branch_format='bzrlib.branch.BzrBranchFormat7',
3945
3098
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3946
 
    hidden=True,
3947
3099
    )
3948
3100
format_registry.register_metadir('1.9-rich-root',
3949
3101
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
3950
3102
    help='A variant of 1.9 that supports rich-root data '
3951
 
         '(needed for bzr-svn and bzr-git).',
 
3103
         '(needed for bzr-svn).',
3952
3104
    branch_format='bzrlib.branch.BzrBranchFormat7',
3953
3105
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3954
 
    hidden=True,
3955
3106
    )
3956
 
format_registry.register_metadir('1.14',
 
3107
format_registry.register_metadir('1.12-preview',
3957
3108
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3958
 
    help='A working-tree format that supports content filtering.',
 
3109
    help='A working-tree format that supports views and content filtering.',
3959
3110
    branch_format='bzrlib.branch.BzrBranchFormat7',
3960
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat5',
 
3111
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat5',
 
3112
    experimental=True,
3961
3113
    )
3962
 
format_registry.register_metadir('1.14-rich-root',
 
3114
format_registry.register_metadir('1.12-preview-rich-root',
3963
3115
    '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).',
 
3116
    help='A variant of 1.12-preview that supports rich-root data '
 
3117
         '(needed for bzr-svn).',
3966
3118
    branch_format='bzrlib.branch.BzrBranchFormat7',
3967
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat5',
 
3119
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat5',
 
3120
    experimental=True,
3968
3121
    )
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 '
 
3122
# The following two formats should always just be aliases.
 
3123
format_registry.register_metadir('development',
 
3124
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment2',
 
3125
    help='Current development format. Can convert data to and from pack-0.92 '
 
3126
        '(and anything compatible with pack-0.92) format repositories. '
 
3127
        'Repositories and branches in this format can only be read by bzr.dev. '
 
3128
        'Please read '
 
3129
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3977
3130
        'before use.',
3978
3131
    branch_format='bzrlib.branch.BzrBranchFormat7',
3979
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
 
3132
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3980
3133
    experimental=True,
3981
3134
    alias=True,
3982
 
    hidden=True,
3983
3135
    )
3984
3136
format_registry.register_metadir('development-subtree',
3985
3137
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment2Subtree',
3987
3139
        'from pack-0.92-subtree (and anything compatible with '
3988
3140
        'pack-0.92-subtree) format repositories. Repositories and branches in '
3989
3141
        'this format can only be read by bzr.dev. Please read '
3990
 
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
 
3142
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3991
3143
        'before use.',
3992
3144
    branch_format='bzrlib.branch.BzrBranchFormat7',
3993
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
 
3145
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3994
3146
    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.
 
3147
    alias=True,
3999
3148
    )
4000
 
 
4001
3149
# 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',
4044
 
    alias=True,
4045
 
    hidden=True,
4046
 
    help='Same as 2a.')
4047
 
 
 
3150
format_registry.register_metadir('development2',
 
3151
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment2',
 
3152
    help='1.6.1 with B+Tree based index. '
 
3153
        'Please read '
 
3154
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
 
3155
        'before use.',
 
3156
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
3157
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
3158
    hidden=True,
 
3159
    experimental=True,
 
3160
    )
 
3161
format_registry.register_metadir('development2-subtree',
 
3162
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment2Subtree',
 
3163
    help='1.6.1-subtree with B+Tree based index. '
 
3164
        'Please read '
 
3165
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
 
3166
        'before use.',
 
3167
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
3168
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
3169
    hidden=True,
 
3170
    experimental=True,
 
3171
    )
4048
3172
# The current format that is made on 'bzr init'.
4049
 
format_registry.set_default('2a')
 
3173
format_registry.set_default('pack-0.92')