/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/bzrdir.py

  • Committer: Robert Collins
  • Date: 2008-08-21 04:12:02 UTC
  • mto: This revision was merged to the branch mainline in revision 3652.
  • Revision ID: robertc@robertcollins.net-20080821041202-typ3c7u8e67xlgst
Separate out batching of revisions.

Show diffs side-by-side

added added

removed removed

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