← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/bzrdir.py

  • Committer: John Arbash Meinel
  • Date: 2008-08-13 16:07:10 UTC
  • mto: (3606.2.4 1.6)
  • mto: This revision was merged to the branch mainline in revision 3625.
  • Revision ID: john@arbash-meinel.com-20080813160710-ns4og8r4y6xcmp0b
Factor out the common exception handling looking for ENOTDIR and use it
for osutils.walkdirs() and tree transform code.

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
746
622
        """
747
623
        return None
748
624
 
749
 
    def get_branch_transport(self, branch_format, name=None):
 
625
    def get_branch_transport(self, branch_format):
750
626
        """Get the transport for use by branch format in this BzrDir.
751
627
 
752
628
        Note that bzr dirs that do not support format strings will raise
753
629
        IncompatibleFormat if the branch format they are given has
754
630
        a format string, and vice versa.
755
631
 
756
 
        If branch_format is None, the transport is returned with no
 
632
        If branch_format is None, the transport is returned with no 
757
633
        checking. If it is not None, then the returned transport is
758
634
        guaranteed to point to an existing directory ready for use.
759
635
        """
761
637
 
762
638
    def _find_creation_modes(self):
763
639
        """Determine the appropriate modes for files and directories.
764
 
 
 
640
        
765
641
        They're always set to be consistent with the base directory,
766
642
        assuming that this transport allows setting modes.
767
643
        """
780
656
            # directories and files are read-write for this user. This is
781
657
            # mostly a workaround for filesystems which lie about being able to
782
658
            # write to a directory (cygwin & win32)
783
 
            if (st.st_mode & 07777 == 00000):
784
 
                # FTP allows stat but does not return dir/file modes
785
 
                self._dir_mode = None
786
 
                self._file_mode = None
787
 
            else:
788
 
                self._dir_mode = (st.st_mode & 07777) | 00700
789
 
                # Remove the sticky and execute bits for files
790
 
                self._file_mode = self._dir_mode & ~07111
 
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
791
662
 
792
663
    def _get_file_mode(self):
793
664
        """Return Unix mode for newly created files, or None.
802
673
        if not self._mode_check_done:
803
674
            self._find_creation_modes()
804
675
        return self._dir_mode
805
 
 
 
676
        
806
677
    def get_repository_transport(self, repository_format):
807
678
        """Get the transport for use by repository format in this BzrDir.
808
679
 
810
681
        IncompatibleFormat if the repository format they are given has
811
682
        a format string, and vice versa.
812
683
 
813
 
        If repository_format is None, the transport is returned with no
 
684
        If repository_format is None, the transport is returned with no 
814
685
        checking. If it is not None, then the returned transport is
815
686
        guaranteed to point to an existing directory ready for use.
816
687
        """
817
688
        raise NotImplementedError(self.get_repository_transport)
818
 
 
 
689
        
819
690
    def get_workingtree_transport(self, tree_format):
820
691
        """Get the transport for use by workingtree format in this BzrDir.
821
692
 
823
694
        IncompatibleFormat if the workingtree format they are given has a
824
695
        format string, and vice versa.
825
696
 
826
 
        If workingtree_format is None, the transport is returned with no
 
697
        If workingtree_format is None, the transport is returned with no 
827
698
        checking. If it is not None, then the returned transport is
828
699
        guaranteed to point to an existing directory ready for use.
829
700
        """
830
701
        raise NotImplementedError(self.get_workingtree_transport)
831
702
 
832
703
    def get_config(self):
833
 
        """Get configuration for this BzrDir."""
834
 
        return config.BzrDirConfig(self)
835
 
 
836
 
    def _get_config(self):
837
 
        """By default, no configuration is available."""
838
 
        return None
 
704
        if getattr(self, '_get_config', None) is None:
 
705
            return None
 
706
        return self._get_config()
839
707
 
840
708
    def __init__(self, _transport, _format):
841
709
        """Initialize a Bzr control dir object.
842
 
 
 
710
        
843
711
        Only really common logic should reside here, concrete classes should be
844
712
        made with varying behaviours.
845
713
 
847
715
        :param _transport: the transport this dir is based at.
848
716
        """
849
717
        self._format = _format
850
 
        # these are also under the more standard names of 
851
 
        # control_transport and user_transport
852
718
        self.transport = _transport.clone('.bzr')
853
719
        self.root_transport = _transport
854
720
        self._mode_check_done = False
855
 
        
856
 
    @property 
857
 
    def user_transport(self):
858
 
        return self.root_transport
859
 
        
860
 
    @property
861
 
    def control_transport(self):
862
 
        return self.transport
863
721
 
864
722
    def is_control_filename(self, filename):
865
723
        """True if filename is the name of a path which is reserved for bzrdir's.
866
 
 
 
724
        
867
725
        :param filename: A filename within the root transport of this bzrdir.
868
726
 
869
727
        This is true IF and ONLY IF the filename is part of the namespace reserved
872
730
        this in the future - for instance to make bzr talk with svn working
873
731
        trees.
874
732
        """
875
 
        # this might be better on the BzrDirFormat class because it refers to
876
 
        # all the possible bzrdir disk formats.
877
 
        # This method is tested via the workingtree is_control_filename tests-
 
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- 
878
736
        # it was extracted from WorkingTree.is_control_filename. If the method's
879
737
        # contract is extended beyond the current trivial implementation, please
880
738
        # add new tests for it to the appropriate place.
882
740
 
883
741
    def needs_format_conversion(self, format=None):
884
742
        """Return true if this bzrdir needs convert_format run on it.
885
 
 
886
 
        For instance, if the repository format is out of date but the
 
743
        
 
744
        For instance, if the repository format is out of date but the 
887
745
        branch and working tree are not, this should return True.
888
746
 
889
747
        :param format: Optional parameter indicating a specific desired
895
753
    def open_unsupported(base):
896
754
        """Open a branch which is not supported."""
897
755
        return BzrDir.open(base, _unsupported=True)
898
 
 
 
756
        
899
757
    @staticmethod
900
758
    def open(base, _unsupported=False, possible_transports=None):
901
759
        """Open an existing bzrdir, rooted at 'base' (url).
902
 
 
 
760
        
903
761
        :param _unsupported: a private parameter to the BzrDir class.
904
762
        """
905
763
        t = get_transport(base, possible_transports=possible_transports)
913
771
        :param transport: Transport containing the bzrdir.
914
772
        :param _unsupported: private.
915
773
        """
916
 
        for hook in BzrDir.hooks['pre_open']:
917
 
            hook(transport)
918
 
        # Keep initial base since 'transport' may be modified while following
919
 
        # the redirections.
920
774
        base = transport.base
 
775
 
921
776
        def find_format(transport):
922
777
            return transport, BzrDirFormat.find_format(
923
778
                transport, _server_formats=_server_formats)
924
779
 
925
780
        def redirected(transport, e, redirection_notice):
926
 
            redirected_transport = transport._redirected_to(e.source, e.target)
927
 
            if redirected_transport is None:
928
 
                raise errors.NotBranchError(base)
 
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)]
929
787
            note('%s is%s redirected to %s',
930
 
                 transport.base, e.permanently, redirected_transport.base)
931
 
            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)
932
797
 
933
798
        try:
934
799
            transport, format = do_catching_redirections(find_format,
940
805
        BzrDir._check_supported(format, _unsupported)
941
806
        return format.open(transport, _found=True)
942
807
 
943
 
    def open_branch(self, name=None, unsupported=False,
944
 
                    ignore_fallbacks=False):
 
808
    def open_branch(self, unsupported=False):
945
809
        """Open the branch object at this BzrDir if one is present.
946
810
 
947
811
        If unsupported is True, then no longer supported branch formats can
948
812
        still be opened.
949
 
 
 
813
        
950
814
        TODO: static convenience version of this?
951
815
        """
952
816
        raise NotImplementedError(self.open_branch)
954
818
    @staticmethod
955
819
    def open_containing(url, possible_transports=None):
956
820
        """Open an existing branch which contains url.
957
 
 
 
821
        
958
822
        :param url: url to search from.
959
823
        See open_containing_from_transport for more detail.
960
824
        """
961
825
        transport = get_transport(url, possible_transports)
962
826
        return BzrDir.open_containing_from_transport(transport)
963
 
 
 
827
    
964
828
    @staticmethod
965
829
    def open_containing_from_transport(a_transport):
966
830
        """Open an existing branch which contains a_transport.base.
969
833
 
970
834
        Basically we keep looking up until we find the control directory or
971
835
        run into the root.  If there isn't one, raises NotBranchError.
972
 
        If there is one and it is either an unrecognised format or an unsupported
 
836
        If there is one and it is either an unrecognised format or an unsupported 
973
837
        format, UnknownFormatError or UnsupportedFormatError are raised.
974
838
        If there is one, it is returned, along with the unused portion of url.
975
839
 
976
 
        :return: The BzrDir that contains the path, and a Unicode path
 
840
        :return: The BzrDir that contains the path, and a Unicode path 
977
841
                for the rest of the URL.
978
842
        """
979
843
        # this gets the normalised url back. I.e. '.' -> the full path.
1085
949
        """
1086
950
        raise NotImplementedError(self.open_workingtree)
1087
951
 
1088
 
    def has_branch(self, name=None):
 
952
    def has_branch(self):
1089
953
        """Tell if this bzrdir contains a branch.
1090
 
 
 
954
        
1091
955
        Note: if you're going to open the branch, you should just go ahead
1092
 
        and try, and not ask permission first.  (This method just opens the
1093
 
        branch and discards it, and that's somewhat expensive.)
 
956
        and try, and not ask permission first.  (This method just opens the 
 
957
        branch and discards it, and that's somewhat expensive.) 
1094
958
        """
1095
959
        try:
1096
 
            self.open_branch(name)
 
960
            self.open_branch()
1097
961
            return True
1098
962
        except errors.NotBranchError:
1099
963
            return False
1103
967
 
1104
968
        This will still raise an exception if the bzrdir has a workingtree that
1105
969
        is remote & inaccessible.
1106
 
 
 
970
        
1107
971
        Note: if you're going to open the working tree, you should just go ahead
1108
 
        and try, and not ask permission first.  (This method just opens the
1109
 
        workingtree and discards it, and that's somewhat expensive.)
 
972
        and try, and not ask permission first.  (This method just opens the 
 
973
        workingtree and discards it, and that's somewhat expensive.) 
1110
974
        """
1111
975
        try:
1112
976
            self.open_workingtree(recommend_upgrade=False)
1116
980
 
1117
981
    def _cloning_metadir(self):
1118
982
        """Produce a metadir suitable for cloning with.
1119
 
 
 
983
        
1120
984
        :returns: (destination_bzrdir_format, source_repository)
1121
985
        """
1122
986
        result_format = self._format.__class__()
1123
987
        try:
1124
988
            try:
1125
 
                branch = self.open_branch(ignore_fallbacks=True)
 
989
                branch = self.open_branch()
1126
990
                source_repository = branch.repository
1127
 
                result_format._branch_format = branch._format
1128
991
            except errors.NotBranchError:
1129
992
                source_branch = None
1130
993
                source_repository = self.open_repository()
1135
998
            # the fix recommended in bug # 103195 - to delegate this choice the
1136
999
            # repository itself.
1137
1000
            repo_format = source_repository._format
1138
 
            if isinstance(repo_format, remote.RemoteRepositoryFormat):
1139
 
                source_repository._ensure_real()
1140
 
                repo_format = source_repository._real_repository._format
1141
 
            result_format.repository_format = repo_format
 
1001
            if not isinstance(repo_format, remote.RemoteRepositoryFormat):
 
1002
                result_format.repository_format = repo_format
1142
1003
        try:
1143
1004
            # TODO: Couldn't we just probe for the format in these cases,
1144
1005
            # rather than opening the whole tree?  It would be a little
1150
1011
            result_format.workingtree_format = tree._format.__class__()
1151
1012
        return result_format, source_repository
1152
1013
 
1153
 
    def cloning_metadir(self, require_stacking=False):
 
1014
    def cloning_metadir(self):
1154
1015
        """Produce a metadir suitable for cloning or sprouting with.
1155
1016
 
1156
1017
        These operations may produce workingtrees (yes, even though they're
1157
1018
        "cloning" something that doesn't have a tree), so a viable workingtree
1158
1019
        format must be selected.
1159
1020
 
1160
 
        :require_stacking: If True, non-stackable formats will be upgraded
1161
 
            to similar stackable formats.
1162
1021
        :returns: a BzrDirFormat with all component formats either set
1163
 
            appropriately or set to None if that component should not be
 
1022
            appropriately or set to None if that component should not be 
1164
1023
            created.
1165
1024
        """
1166
1025
        format, repository = self._cloning_metadir()
1167
1026
        if format._workingtree_format is None:
1168
 
            # No tree in self.
1169
1027
            if repository is None:
1170
 
                # No repository either
1171
1028
                return format
1172
 
            # We have a repository, so set a working tree? (Why? This seems to
1173
 
            # contradict the stated return value in the docstring).
1174
1029
            tree_format = repository._format._matchingbzrdir.workingtree_format
1175
1030
            format.workingtree_format = tree_format.__class__()
1176
 
        if require_stacking:
1177
 
            format.require_stacking()
1178
1031
        return format
1179
1032
 
1180
1033
    def checkout_metadir(self):
1182
1035
 
1183
1036
    def sprout(self, url, revision_id=None, force_new_repo=False,
1184
1037
               recurse='down', possible_transports=None,
1185
 
               accelerator_tree=None, hardlink=False, stacked=False,
1186
 
               source_branch=None, create_tree_if_local=True):
 
1038
               accelerator_tree=None, hardlink=False, stacked=False):
1187
1039
        """Create a copy of this bzrdir prepared for use as a new line of
1188
1040
        development.
1189
1041
 
1204
1056
            where possible.
1205
1057
        :param stacked: If true, create a stacked branch referring to the
1206
1058
            location of this control directory.
1207
 
        :param create_tree_if_local: If true, a working-tree will be created
1208
 
            when working locally.
1209
1059
        """
1210
1060
        target_transport = get_transport(url, possible_transports)
1211
1061
        target_transport.ensure_base()
1212
 
        cloning_format = self.cloning_metadir(stacked)
1213
 
        # Create/update the result branch
 
1062
        cloning_format = self.cloning_metadir()
1214
1063
        result = cloning_format.initialize_on_transport(target_transport)
1215
 
        # if a stacked branch wasn't requested, we don't create one
1216
 
        # even if the origin was stacked
1217
 
        stacked_branch_url = None
1218
 
        if source_branch is not None:
 
1064
        try:
 
1065
            source_branch = self.open_branch()
 
1066
            source_repository = source_branch.repository
1219
1067
            if stacked:
1220
1068
                stacked_branch_url = self.root_transport.base
1221
 
            source_repository = source_branch.repository
1222
 
        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
1223
1075
            try:
1224
 
                source_branch = self.open_branch()
1225
 
                source_repository = source_branch.repository
1226
 
                if stacked:
1227
 
                    stacked_branch_url = self.root_transport.base
1228
 
            except errors.NotBranchError:
1229
 
                source_branch = None
1230
 
                try:
1231
 
                    source_repository = self.open_repository()
1232
 
                except errors.NoRepositoryPresent:
1233
 
                    source_repository = None
 
1076
                source_repository = self.open_repository()
 
1077
            except errors.NoRepositoryPresent:
 
1078
                source_repository = None
 
1079
            stacked_branch_url = None
1234
1080
        repository_policy = result.determine_repository_policy(
1235
1081
            force_new_repo, stacked_branch_url, require_stacking=stacked)
1236
 
        result_repo, is_new_repo = repository_policy.acquire_repository()
1237
 
        if is_new_repo and revision_id is not None and not stacked:
1238
 
            fetch_spec = graph.PendingAncestryResult(
1239
 
                [revision_id], source_repository)
1240
 
        else:
1241
 
            fetch_spec = None
 
1082
        result_repo = repository_policy.acquire_repository()
1242
1083
        if source_repository is not None:
1243
 
            # Fetch while stacked to prevent unstacked fetch from
1244
 
            # Branch.sprout.
1245
 
            if fetch_spec is None:
1246
 
                result_repo.fetch(source_repository, revision_id=revision_id)
1247
 
            else:
1248
 
                result_repo.fetch(source_repository, fetch_spec=fetch_spec)
 
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)
1249
1087
 
1250
 
        if source_branch is None:
 
1088
        # Create/update the result branch
 
1089
        if ((stacked 
 
1090
             or repository_policy._require_stacking 
 
1091
             or repository_policy._stack_on)
 
1092
            and not result._format.get_branch_format().supports_stacking()):
 
1093
            # force a branch that can support stacking 
 
1094
            from bzrlib.branch import BzrBranchFormat7
 
1095
            format = BzrBranchFormat7()
 
1096
            result_branch = format.initialize(result)
 
1097
            mutter("using %r for stacking" % (format,))
 
1098
        elif source_branch is None:
1251
1099
            # this is for sprouting a bzrdir without a branch; is that
1252
1100
            # actually useful?
1253
 
            # Not especially, but it's part of the contract.
1254
1101
            result_branch = result.create_branch()
1255
1102
        else:
1256
 
            result_branch = source_branch.sprout(result,
1257
 
                revision_id=revision_id, repository_policy=repository_policy)
 
1103
            result_branch = source_branch._format.initialize(result)
1258
1104
        mutter("created new branch %r" % (result_branch,))
 
1105
        repository_policy.configure_branch(result_branch)
 
1106
        if source_branch is not None:
 
1107
            # XXX: this duplicates Branch.sprout(); it probably belongs on an
 
1108
            # InterBranch method? -- mbp 20080724
 
1109
            source_branch.copy_content_into(result_branch,
 
1110
                 revision_id=revision_id)
 
1111
            result_branch.set_parent(self.root_transport.base)
1259
1112
 
1260
1113
        # Create/update the result working tree
1261
 
        if (create_tree_if_local and
1262
 
            isinstance(target_transport, local.LocalTransport) and
1263
 
            (result_repo is None or result_repo.make_working_trees())):
 
1114
        if isinstance(target_transport, LocalTransport) and (
 
1115
            result_repo is None or result_repo.make_working_trees()):
1264
1116
            wt = result.create_workingtree(accelerator_tree=accelerator_tree,
1265
1117
                hardlink=hardlink)
1266
1118
            wt.lock_write()
1279
1131
                basis = wt.basis_tree()
1280
1132
                basis.lock_read()
1281
1133
                subtrees = basis.iter_references()
1282
 
            elif result_branch is not None:
1283
 
                basis = result_branch.basis_tree()
1284
 
                basis.lock_read()
1285
 
                subtrees = basis.iter_references()
1286
1134
            elif source_branch is not None:
1287
1135
                basis = source_branch.basis_tree()
1288
1136
                basis.lock_read()
1303
1151
                    basis.unlock()
1304
1152
        return result
1305
1153
 
1306
 
    def push_branch(self, source, revision_id=None, overwrite=False, 
1307
 
        remember=False, create_prefix=False):
1308
 
        """Push the source branch into this BzrDir."""
1309
 
        br_to = None
1310
 
        # If we can open a branch, use its direct repository, otherwise see
1311
 
        # if there is a repository without a branch.
1312
 
        try:
1313
 
            br_to = self.open_branch()
1314
 
        except errors.NotBranchError:
1315
 
            # Didn't find a branch, can we find a repository?
1316
 
            repository_to = self.find_repository()
1317
 
        else:
1318
 
            # Found a branch, so we must have found a repository
1319
 
            repository_to = br_to.repository
1320
 
 
1321
 
        push_result = PushResult()
1322
 
        push_result.source_branch = source
1323
 
        if br_to is None:
1324
 
            # We have a repository but no branch, copy the revisions, and then
1325
 
            # create a branch.
1326
 
            repository_to.fetch(source.repository, revision_id=revision_id)
1327
 
            br_to = source.clone(self, revision_id=revision_id)
1328
 
            if source.get_push_location() is None or remember:
1329
 
                source.set_push_location(br_to.base)
1330
 
            push_result.stacked_on = None
1331
 
            push_result.branch_push_result = None
1332
 
            push_result.old_revno = None
1333
 
            push_result.old_revid = _mod_revision.NULL_REVISION
1334
 
            push_result.target_branch = br_to
1335
 
            push_result.master_branch = None
1336
 
            push_result.workingtree_updated = False
1337
 
        else:
1338
 
            # We have successfully opened the branch, remember if necessary:
1339
 
            if source.get_push_location() is None or remember:
1340
 
                source.set_push_location(br_to.base)
1341
 
            try:
1342
 
                tree_to = self.open_workingtree()
1343
 
            except errors.NotLocalUrl:
1344
 
                push_result.branch_push_result = source.push(br_to, 
1345
 
                    overwrite, stop_revision=revision_id)
1346
 
                push_result.workingtree_updated = False
1347
 
            except errors.NoWorkingTree:
1348
 
                push_result.branch_push_result = source.push(br_to,
1349
 
                    overwrite, stop_revision=revision_id)
1350
 
                push_result.workingtree_updated = None # Not applicable
1351
 
            else:
1352
 
                tree_to.lock_write()
1353
 
                try:
1354
 
                    push_result.branch_push_result = source.push(
1355
 
                        tree_to.branch, overwrite, stop_revision=revision_id)
1356
 
                    tree_to.update()
1357
 
                finally:
1358
 
                    tree_to.unlock()
1359
 
                push_result.workingtree_updated = True
1360
 
            push_result.old_revno = push_result.branch_push_result.old_revno
1361
 
            push_result.old_revid = push_result.branch_push_result.old_revid
1362
 
            push_result.target_branch = \
1363
 
                push_result.branch_push_result.target_branch
1364
 
        return push_result
1365
 
 
1366
 
 
1367
 
class BzrDirHooks(hooks.Hooks):
1368
 
    """Hooks for BzrDir operations."""
1369
 
 
1370
 
    def __init__(self):
1371
 
        """Create the default hooks."""
1372
 
        hooks.Hooks.__init__(self)
1373
 
        self.create_hook(hooks.HookPoint('pre_open',
1374
 
            "Invoked before attempting to open a BzrDir with the transport "
1375
 
            "that the open will use.", (1, 14), None))
1376
 
        self.create_hook(hooks.HookPoint('post_repo_init',
1377
 
            "Invoked after a repository has been initialized. "
1378
 
            "post_repo_init is called with a "
1379
 
            "bzrlib.bzrdir.RepoInitHookParams.",
1380
 
            (2, 2), None))
1381
 
 
1382
 
# install the default hooks
1383
 
BzrDir.hooks = BzrDirHooks()
1384
 
 
1385
 
 
1386
 
class RepoInitHookParams(object):
1387
 
    """Object holding parameters passed to *_repo_init hooks.
1388
 
 
1389
 
    There are 4 fields that hooks may wish to access:
1390
 
 
1391
 
    :ivar repository: Repository created
1392
 
    :ivar format: Repository format
1393
 
    :ivar bzrdir: The bzrdir for the repository
1394
 
    :ivar shared: The repository is shared
1395
 
    """
1396
 
 
1397
 
    def __init__(self, repository, format, a_bzrdir, shared):
1398
 
        """Create a group of RepoInitHook parameters.
1399
 
 
1400
 
        :param repository: Repository created
1401
 
        :param format: Repository format
1402
 
        :param bzrdir: The bzrdir for the repository
1403
 
        :param shared: The repository is shared
1404
 
        """
1405
 
        self.repository = repository
1406
 
        self.format = format
1407
 
        self.bzrdir = a_bzrdir
1408
 
        self.shared = shared
1409
 
 
1410
 
    def __eq__(self, other):
1411
 
        return self.__dict__ == other.__dict__
1412
 
 
1413
 
    def __repr__(self):
1414
 
        if self.repository:
1415
 
            return "<%s for %s>" % (self.__class__.__name__,
1416
 
                self.repository)
1417
 
        else:
1418
 
            return "<%s for %s>" % (self.__class__.__name__,
1419
 
                self.bzrdir)
1420
 
 
1421
1154
 
1422
1155
class BzrDirPreSplitOut(BzrDir):
1423
1156
    """A common class for the all-in-one formats."""
1434
1167
        """Pre-splitout bzrdirs do not suffer from stale locks."""
1435
1168
        raise NotImplementedError(self.break_lock)
1436
1169
 
1437
 
    def cloning_metadir(self, require_stacking=False):
 
1170
    def cloning_metadir(self):
1438
1171
        """Produce a metadir suitable for cloning with."""
1439
 
        if require_stacking:
1440
 
            return format_registry.make_bzrdir('1.6')
1441
1172
        return self._format.__class__()
1442
1173
 
1443
1174
    def clone(self, url, revision_id=None, force_new_repo=False,
1449
1180
        preserve_stacking has no effect, since no source branch using this
1450
1181
        family of formats can be stacked, so there is no stacking to preserve.
1451
1182
        """
 
1183
        from bzrlib.workingtree import WorkingTreeFormat2
1452
1184
        self._make_tail(url)
1453
1185
        result = self._format._initialize_for_clone(url)
1454
1186
        self.open_repository().clone(result, revision_id=revision_id)
1455
1187
        from_branch = self.open_branch()
1456
1188
        from_branch.clone(result, revision_id=revision_id)
1457
1189
        try:
1458
 
            tree = self.open_workingtree()
 
1190
            self.open_workingtree().clone(result)
1459
1191
        except errors.NotLocalUrl:
1460
1192
            # make a new one, this format always has to have one.
1461
 
            result._init_workingtree()
1462
 
        else:
1463
 
            tree.clone(result)
 
1193
            try:
 
1194
                WorkingTreeFormat2().initialize(result)
 
1195
            except errors.NotLocalUrl:
 
1196
                # but we cannot do it for remote trees.
 
1197
                to_branch = result.open_branch()
 
1198
                WorkingTreeFormat2()._stub_initialize_remote(to_branch)
1464
1199
        return result
1465
1200
 
1466
 
    def create_branch(self, name=None):
 
1201
    def create_branch(self):
1467
1202
        """See BzrDir.create_branch."""
1468
 
        return self._format.get_branch_format().initialize(self, name=name)
 
1203
        return self.open_branch()
1469
1204
 
1470
 
    def destroy_branch(self, name=None):
 
1205
    def destroy_branch(self):
1471
1206
        """See BzrDir.destroy_branch."""
1472
1207
        raise errors.UnsupportedOperation(self.destroy_branch, self)
1473
1208
 
1484
1219
    def create_workingtree(self, revision_id=None, from_branch=None,
1485
1220
                           accelerator_tree=None, hardlink=False):
1486
1221
        """See BzrDir.create_workingtree."""
1487
 
        # The workingtree is sometimes created when the bzrdir is created,
1488
 
        # but not when cloning.
1489
 
 
1490
1222
        # this looks buggy but is not -really-
1491
1223
        # because this format creates the workingtree when the bzrdir is
1492
1224
        # created
1494
1226
        # and that will have set it for us, its only
1495
1227
        # specific uses of create_workingtree in isolation
1496
1228
        # that can do wonky stuff here, and that only
1497
 
        # happens for creating checkouts, which cannot be
 
1229
        # happens for creating checkouts, which cannot be 
1498
1230
        # done on this format anyway. So - acceptable wart.
1499
 
        if hardlink:
1500
 
            warning("can't support hardlinked working trees in %r"
1501
 
                % (self,))
1502
 
        try:
1503
 
            result = self.open_workingtree(recommend_upgrade=False)
1504
 
        except errors.NoSuchFile:
1505
 
            result = self._init_workingtree()
 
1231
        result = self.open_workingtree(recommend_upgrade=False)
1506
1232
        if revision_id is not None:
1507
1233
            if revision_id == _mod_revision.NULL_REVISION:
1508
1234
                result.set_parent_ids([])
1510
1236
                result.set_parent_ids([revision_id])
1511
1237
        return result
1512
1238
 
1513
 
    def _init_workingtree(self):
1514
 
        from bzrlib.workingtree import WorkingTreeFormat2
1515
 
        try:
1516
 
            return WorkingTreeFormat2().initialize(self)
1517
 
        except errors.NotLocalUrl:
1518
 
            # Even though we can't access the working tree, we need to
1519
 
            # create its control files.
1520
 
            return WorkingTreeFormat2()._stub_initialize_on_transport(
1521
 
                self.transport, self._control_files._file_mode)
1522
 
 
1523
1239
    def destroy_workingtree(self):
1524
1240
        """See BzrDir.destroy_workingtree."""
1525
1241
        raise errors.UnsupportedOperation(self.destroy_workingtree, self)
1526
1242
 
1527
1243
    def destroy_workingtree_metadata(self):
1528
1244
        """See BzrDir.destroy_workingtree_metadata."""
1529
 
        raise errors.UnsupportedOperation(self.destroy_workingtree_metadata,
 
1245
        raise errors.UnsupportedOperation(self.destroy_workingtree_metadata, 
1530
1246
                                          self)
1531
1247
 
1532
 
    def get_branch_transport(self, branch_format, name=None):
 
1248
    def get_branch_transport(self, branch_format):
1533
1249
        """See BzrDir.get_branch_transport()."""
1534
 
        if name is not None:
1535
 
            raise errors.NoColocatedBranchSupport(self)
1536
1250
        if branch_format is None:
1537
1251
            return self.transport
1538
1252
        try:
1566
1280
        # if the format is not the same as the system default,
1567
1281
        # an upgrade is needed.
1568
1282
        if format is None:
1569
 
            symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1570
 
                % 'needs_format_conversion(format=None)')
1571
1283
            format = BzrDirFormat.get_default_format()
1572
1284
        return not isinstance(self._format, format.__class__)
1573
1285
 
1574
 
    def open_branch(self, name=None, unsupported=False,
1575
 
                    ignore_fallbacks=False):
 
1286
    def open_branch(self, unsupported=False):
1576
1287
        """See BzrDir.open_branch."""
1577
1288
        from bzrlib.branch import BzrBranchFormat4
1578
1289
        format = BzrBranchFormat4()
1579
1290
        self._check_supported(format, unsupported)
1580
 
        return format.open(self, name, _found=True)
 
1291
        return format.open(self, _found=True)
1581
1292
 
1582
1293
    def sprout(self, url, revision_id=None, force_new_repo=False,
1583
1294
               possible_transports=None, accelerator_tree=None,
1584
 
               hardlink=False, stacked=False, create_tree_if_local=True,
1585
 
               source_branch=None):
 
1295
               hardlink=False, stacked=False):
1586
1296
        """See BzrDir.sprout()."""
1587
 
        if source_branch is not None:
1588
 
            my_branch = self.open_branch()
1589
 
            if source_branch.base != my_branch.base:
1590
 
                raise AssertionError(
1591
 
                    "source branch %r is not within %r with branch %r" %
1592
 
                    (source_branch, self, my_branch))
1593
1297
        if stacked:
1594
1298
            raise errors.UnstackableBranchFormat(
1595
1299
                self._format, self.root_transport.base)
1596
 
        if not create_tree_if_local:
1597
 
            raise errors.MustHaveWorkingTree(
1598
 
                self._format, self.root_transport.base)
1599
1300
        from bzrlib.workingtree import WorkingTreeFormat2
1600
1301
        self._make_tail(url)
1601
1302
        result = self._format._initialize_for_clone(url)
1607
1308
            self.open_branch().sprout(result, revision_id=revision_id)
1608
1309
        except errors.NotBranchError:
1609
1310
            pass
1610
 
 
1611
1311
        # we always want a working tree
1612
1312
        WorkingTreeFormat2().initialize(result,
1613
1313
                                        accelerator_tree=accelerator_tree,
1617
1317
 
1618
1318
class BzrDir4(BzrDirPreSplitOut):
1619
1319
    """A .bzr version 4 control object.
1620
 
 
 
1320
    
1621
1321
    This is a deprecated format and may be removed after sept 2006.
1622
1322
    """
1623
1323
 
1627
1327
 
1628
1328
    def needs_format_conversion(self, format=None):
1629
1329
        """Format 4 dirs are always in need of conversion."""
1630
 
        if format is None:
1631
 
            symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1632
 
                % 'needs_format_conversion(format=None)')
1633
1330
        return True
1634
1331
 
1635
1332
    def open_repository(self):
1644
1341
    This is a deprecated format and may be removed after sept 2006.
1645
1342
    """
1646
1343
 
1647
 
    def has_workingtree(self):
1648
 
        """See BzrDir.has_workingtree."""
1649
 
        return True
1650
 
    
1651
1344
    def open_repository(self):
1652
1345
        """See BzrDir.open_repository."""
1653
1346
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
1669
1362
    This is a deprecated format and may be removed after sept 2006.
1670
1363
    """
1671
1364
 
1672
 
    def has_workingtree(self):
1673
 
        """See BzrDir.has_workingtree."""
1674
 
        return True
1675
 
    
1676
1365
    def open_repository(self):
1677
1366
        """See BzrDir.open_repository."""
1678
1367
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
1689
1378
 
1690
1379
class BzrDirMeta1(BzrDir):
1691
1380
    """A .bzr meta version 1 control object.
1692
 
 
1693
 
    This is the first control object where the
 
1381
    
 
1382
    This is the first control object where the 
1694
1383
    individual aspects are really split out: there are separate repository,
1695
1384
    workingtree and branch subdirectories and any subset of the three can be
1696
1385
    present within a BzrDir.
1700
1389
        """See BzrDir.can_convert_format()."""
1701
1390
        return True
1702
1391
 
1703
 
    def create_branch(self, name=None):
 
1392
    def create_branch(self):
1704
1393
        """See BzrDir.create_branch."""
1705
 
        return self._format.get_branch_format().initialize(self, name=name)
 
1394
        return self._format.get_branch_format().initialize(self)
1706
1395
 
1707
 
    def destroy_branch(self, name=None):
 
1396
    def destroy_branch(self):
1708
1397
        """See BzrDir.create_branch."""
1709
 
        if name is not None:
1710
 
            raise errors.NoColocatedBranchSupport(self)
1711
1398
        self.transport.delete_tree('branch')
1712
1399
 
1713
1400
    def create_repository(self, shared=False):
1756
1443
        format = BranchFormat.find_format(self)
1757
1444
        return format.get_reference(self)
1758
1445
 
1759
 
    def get_branch_transport(self, branch_format, name=None):
 
1446
    def get_branch_transport(self, branch_format):
1760
1447
        """See BzrDir.get_branch_transport()."""
1761
 
        if name is not None:
1762
 
            raise errors.NoColocatedBranchSupport(self)
1763
 
        # XXX: this shouldn't implicitly create the directory if it's just
1764
 
        # promising to get a transport -- mbp 20090727
1765
1448
        if branch_format is None:
1766
1449
            return self.transport.clone('branch')
1767
1450
        try:
1802
1485
            pass
1803
1486
        return self.transport.clone('checkout')
1804
1487
 
1805
 
    def has_workingtree(self):
1806
 
        """Tell if this bzrdir contains a working tree.
1807
 
 
1808
 
        This will still raise an exception if the bzrdir has a workingtree that
1809
 
        is remote & inaccessible.
1810
 
 
1811
 
        Note: if you're going to open the working tree, you should just go
1812
 
        ahead and try, and not ask permission first.
1813
 
        """
1814
 
        from bzrlib.workingtree import WorkingTreeFormat
1815
 
        try:
1816
 
            WorkingTreeFormat.find_format(self)
1817
 
        except errors.NoWorkingTree:
1818
 
            return False
1819
 
        return True
1820
 
 
1821
1488
    def needs_format_conversion(self, format=None):
1822
1489
        """See BzrDir.needs_format_conversion()."""
1823
1490
        if format is None:
1824
 
            symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1825
 
                % 'needs_format_conversion(format=None)')
1826
 
        if format is None:
1827
1491
            format = BzrDirFormat.get_default_format()
1828
1492
        if not isinstance(self._format, format.__class__):
1829
1493
            # it is not a meta dir format, conversion is needed.
1836
1500
                return True
1837
1501
        except errors.NoRepositoryPresent:
1838
1502
            pass
1839
 
        for branch in self.list_branches():
1840
 
            if not isinstance(branch._format,
 
1503
        try:
 
1504
            if not isinstance(self.open_branch()._format,
1841
1505
                              format.get_branch_format().__class__):
1842
1506
                # the branch needs an upgrade.
1843
1507
                return True
 
1508
        except errors.NotBranchError:
 
1509
            pass
1844
1510
        try:
1845
1511
            my_wt = self.open_workingtree(recommend_upgrade=False)
1846
1512
            if not isinstance(my_wt._format,
1851
1517
            pass
1852
1518
        return False
1853
1519
 
1854
 
    def open_branch(self, name=None, unsupported=False,
1855
 
                    ignore_fallbacks=False):
 
1520
    def open_branch(self, unsupported=False):
1856
1521
        """See BzrDir.open_branch."""
1857
1522
        format = self.find_branch_format()
1858
1523
        self._check_supported(format, unsupported)
1859
 
        return format.open(self, name=name,
1860
 
            _found=True, ignore_fallbacks=ignore_fallbacks)
 
1524
        return format.open(self, _found=True)
1861
1525
 
1862
1526
    def open_repository(self, unsupported=False):
1863
1527
        """See BzrDir.open_repository."""
1877
1541
        return format.open(self, _found=True)
1878
1542
 
1879
1543
    def _get_config(self):
1880
 
        return config.TransportConfig(self.transport, 'control.conf')
 
1544
        return config.BzrDirConfig(self.transport)
1881
1545
 
1882
1546
 
1883
1547
class BzrDirFormat(object):
1888
1552
     * a format string,
1889
1553
     * an open routine.
1890
1554
 
1891
 
    Formats are placed in a dict by their format string for reference
 
1555
    Formats are placed in a dict by their format string for reference 
1892
1556
    during bzrdir opening. These should be subclasses of BzrDirFormat
1893
1557
    for consistency.
1894
1558
 
1895
1559
    Once a format is deprecated, just deprecate the initialize and open
1896
 
    methods on the format class. Do not deprecate the object, as the
 
1560
    methods on the format class. Do not deprecate the object, as the 
1897
1561
    object will be created every system load.
1898
 
 
1899
 
    :cvar colocated_branches: Whether this formats supports colocated branches.
1900
1562
    """
1901
1563
 
1902
1564
    _default_format = None
1907
1569
 
1908
1570
    _control_formats = []
1909
1571
    """The registered control formats - .bzr, ....
1910
 
 
 
1572
    
1911
1573
    This is a list of BzrDirFormat objects.
1912
1574
    """
1913
1575
 
1919
1581
 
1920
1582
    _lock_file_name = 'branch-lock'
1921
1583
 
1922
 
    colocated_branches = False
1923
 
    """Whether co-located branches are supported for this control dir format.
1924
 
    """
1925
 
 
1926
1584
    # _lock_class must be set in subclasses to the lock type, typ.
1927
1585
    # TransportLock or LockDir
1928
1586
 
1945
1603
    def probe_transport(klass, transport):
1946
1604
        """Return the .bzrdir style format present in a directory."""
1947
1605
        try:
1948
 
            format_string = transport.get_bytes(".bzr/branch-format")
 
1606
            format_string = transport.get(".bzr/branch-format").read()
1949
1607
        except errors.NoSuchFile:
1950
1608
            raise errors.NotBranchError(path=transport.base)
1951
1609
 
1976
1634
        current default format. In the case of plugins we can/should provide
1977
1635
        some means for them to extend the range of returnable converters.
1978
1636
 
1979
 
        :param format: Optional format to override the default format of the
 
1637
        :param format: Optional format to override the default format of the 
1980
1638
                       library.
1981
1639
        """
1982
1640
        raise NotImplementedError(self.get_converter)
1983
1641
 
1984
1642
    def initialize(self, url, possible_transports=None):
1985
1643
        """Create a bzr control dir at this url and return an opened copy.
1986
 
 
1987
 
        While not deprecated, this method is very specific and its use will
1988
 
        lead to many round trips to setup a working environment. See
1989
 
        initialize_on_transport_ex for a [nearly] all-in-one method.
1990
 
 
 
1644
        
1991
1645
        Subclasses should typically override initialize_on_transport
1992
1646
        instead of this method.
1993
1647
        """
1996
1650
 
1997
1651
    def initialize_on_transport(self, transport):
1998
1652
        """Initialize a new bzrdir in the base directory of a Transport."""
1999
 
        try:
2000
 
            # can we hand off the request to the smart server rather than using
2001
 
            # vfs calls?
2002
 
            client_medium = transport.get_smart_medium()
2003
 
        except errors.NoSmartMedium:
2004
 
            return self._initialize_on_transport_vfs(transport)
2005
 
        else:
2006
 
            # Current RPC's only know how to create bzr metadir1 instances, so
2007
 
            # we still delegate to vfs methods if the requested format is not a
2008
 
            # metadir1
2009
 
            if type(self) != BzrDirMetaFormat1:
2010
 
                return self._initialize_on_transport_vfs(transport)
2011
 
            remote_format = RemoteBzrDirFormat()
2012
 
            self._supply_sub_formats_to(remote_format)
2013
 
            return remote_format.initialize_on_transport(transport)
2014
 
 
2015
 
    def initialize_on_transport_ex(self, transport, use_existing_dir=False,
2016
 
        create_prefix=False, force_new_repo=False, stacked_on=None,
2017
 
        stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
2018
 
        shared_repo=False, vfs_only=False):
2019
 
        """Create this format on transport.
2020
 
 
2021
 
        The directory to initialize will be created.
2022
 
 
2023
 
        :param force_new_repo: Do not use a shared repository for the target,
2024
 
                               even if one is available.
2025
 
        :param create_prefix: Create any missing directories leading up to
2026
 
            to_transport.
2027
 
        :param use_existing_dir: Use an existing directory if one exists.
2028
 
        :param stacked_on: A url to stack any created branch on, None to follow
2029
 
            any target stacking policy.
2030
 
        :param stack_on_pwd: If stack_on is relative, the location it is
2031
 
            relative to.
2032
 
        :param repo_format_name: If non-None, a repository will be
2033
 
            made-or-found. Should none be found, or if force_new_repo is True
2034
 
            the repo_format_name is used to select the format of repository to
2035
 
            create.
2036
 
        :param make_working_trees: Control the setting of make_working_trees
2037
 
            for a new shared repository when one is made. None to use whatever
2038
 
            default the format has.
2039
 
        :param shared_repo: Control whether made repositories are shared or
2040
 
            not.
2041
 
        :param vfs_only: If True do not attempt to use a smart server
2042
 
        :return: repo, bzrdir, require_stacking, repository_policy. repo is
2043
 
            None if none was created or found, bzrdir is always valid.
2044
 
            require_stacking is the result of examining the stacked_on
2045
 
            parameter and any stacking policy found for the target.
2046
 
        """
2047
 
        if not vfs_only:
2048
 
            # Try to hand off to a smart server 
2049
 
            try:
2050
 
                client_medium = transport.get_smart_medium()
2051
 
            except errors.NoSmartMedium:
2052
 
                pass
2053
 
            else:
2054
 
                # TODO: lookup the local format from a server hint.
2055
 
                remote_dir_format = RemoteBzrDirFormat()
2056
 
                remote_dir_format._network_name = self.network_name()
2057
 
                self._supply_sub_formats_to(remote_dir_format)
2058
 
                return remote_dir_format.initialize_on_transport_ex(transport,
2059
 
                    use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2060
 
                    force_new_repo=force_new_repo, stacked_on=stacked_on,
2061
 
                    stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2062
 
                    make_working_trees=make_working_trees, shared_repo=shared_repo)
2063
 
        # XXX: Refactor the create_prefix/no_create_prefix code into a
2064
 
        #      common helper function
2065
 
        # The destination may not exist - if so make it according to policy.
2066
 
        def make_directory(transport):
2067
 
            transport.mkdir('.')
2068
 
            return transport
2069
 
        def redirected(transport, e, redirection_notice):
2070
 
            note(redirection_notice)
2071
 
            return transport._redirected_to(e.source, e.target)
2072
 
        try:
2073
 
            transport = do_catching_redirections(make_directory, transport,
2074
 
                redirected)
2075
 
        except errors.FileExists:
2076
 
            if not use_existing_dir:
2077
 
                raise
2078
 
        except errors.NoSuchFile:
2079
 
            if not create_prefix:
2080
 
                raise
2081
 
            transport.create_prefix()
2082
 
 
2083
 
        require_stacking = (stacked_on is not None)
2084
 
        # Now the target directory exists, but doesn't have a .bzr
2085
 
        # directory. So we need to create it, along with any work to create
2086
 
        # all of the dependent branches, etc.
2087
 
 
2088
 
        result = self.initialize_on_transport(transport)
2089
 
        if repo_format_name:
2090
 
            try:
2091
 
                # use a custom format
2092
 
                result._format.repository_format = \
2093
 
                    repository.network_format_registry.get(repo_format_name)
2094
 
            except AttributeError:
2095
 
                # The format didn't permit it to be set.
2096
 
                pass
2097
 
            # A repository is desired, either in-place or shared.
2098
 
            repository_policy = result.determine_repository_policy(
2099
 
                force_new_repo, stacked_on, stack_on_pwd,
2100
 
                require_stacking=require_stacking)
2101
 
            result_repo, is_new_repo = repository_policy.acquire_repository(
2102
 
                make_working_trees, shared_repo)
2103
 
            if not require_stacking and repository_policy._require_stacking:
2104
 
                require_stacking = True
2105
 
                result._format.require_stacking()
2106
 
            result_repo.lock_write()
2107
 
        else:
2108
 
            result_repo = None
2109
 
            repository_policy = None
2110
 
        return result_repo, result, require_stacking, repository_policy
2111
 
 
2112
 
    def _initialize_on_transport_vfs(self, transport):
2113
 
        """Initialize a new bzrdir using VFS calls.
2114
 
 
2115
 
        :param transport: The transport to create the .bzr directory in.
2116
 
        :return: A
2117
 
        """
2118
 
        # Since we are creating a .bzr directory, inherit the
 
1653
        # Since we don't have a .bzr directory, inherit the
2119
1654
        # mode from the root directory
2120
1655
        temp_control = lockable_files.LockableFiles(transport,
2121
1656
                            '', lockable_files.TransportLock)
2123
1658
                                      # FIXME: RBC 20060121 don't peek under
2124
1659
                                      # the covers
2125
1660
                                      mode=temp_control._dir_mode)
2126
 
        if sys.platform == 'win32' and isinstance(transport, local.LocalTransport):
 
1661
        if sys.platform == 'win32' and isinstance(transport, LocalTransport):
2127
1662
            win32utils.set_file_attr_hidden(transport._abspath('.bzr'))
2128
1663
        file_mode = temp_control._file_mode
2129
1664
        del temp_control
2151
1686
        """Is this format supported?
2152
1687
 
2153
1688
        Supported formats must be initializable and openable.
2154
 
        Unsupported formats may not support initialization or committing or
 
1689
        Unsupported formats may not support initialization or committing or 
2155
1690
        some other features depending on the reason for not being supported.
2156
1691
        """
2157
1692
        return True
2158
1693
 
2159
 
    def network_name(self):
2160
 
        """A simple byte string uniquely identifying this format for RPC calls.
2161
 
 
2162
 
        Bzr control formats use thir disk format string to identify the format
2163
 
        over the wire. Its possible that other control formats have more
2164
 
        complex detection requirements, so we permit them to use any unique and
2165
 
        immutable string they desire.
2166
 
        """
2167
 
        raise NotImplementedError(self.network_name)
2168
 
 
2169
1694
    def same_model(self, target_format):
2170
 
        return (self.repository_format.rich_root_data ==
 
1695
        return (self.repository_format.rich_root_data == 
2171
1696
            target_format.rich_root_data)
2172
1697
 
2173
1698
    @classmethod
2174
1699
    def known_formats(klass):
2175
1700
        """Return all the known formats.
2176
 
 
 
1701
        
2177
1702
        Concrete formats should override _known_formats.
2178
1703
        """
2179
 
        # There is double indirection here to make sure that control
2180
 
        # formats used by more than one dir format will only be probed
 
1704
        # There is double indirection here to make sure that control 
 
1705
        # formats used by more than one dir format will only be probed 
2181
1706
        # once. This can otherwise be quite expensive for remote connections.
2182
1707
        result = set()
2183
1708
        for format in klass._control_formats:
2184
1709
            result.update(format._known_formats())
2185
1710
        return result
2186
 
 
 
1711
    
2187
1712
    @classmethod
2188
1713
    def _known_formats(klass):
2189
1714
        """Return the known format instances for this control format."""
2191
1716
 
2192
1717
    def open(self, transport, _found=False):
2193
1718
        """Return an instance of this format for the dir transport points at.
2194
 
 
 
1719
        
2195
1720
        _found is a private parameter, do not use it.
2196
1721
        """
2197
1722
        if not _found:
2198
1723
            found_format = BzrDirFormat.find_format(transport)
2199
1724
            if not isinstance(found_format, self.__class__):
2200
1725
                raise AssertionError("%s was asked to open %s, but it seems to need "
2201
 
                        "format %s"
 
1726
                        "format %s" 
2202
1727
                        % (self, transport, found_format))
2203
 
            # Allow subclasses - use the found format.
2204
 
            self._supply_sub_formats_to(found_format)
2205
 
            return found_format._open(transport)
2206
1728
        return self._open(transport)
2207
1729
 
2208
1730
    def _open(self, transport):
2216
1738
    @classmethod
2217
1739
    def register_format(klass, format):
2218
1740
        klass._formats[format.get_format_string()] = format
2219
 
        # bzr native formats have a network name of their format string.
2220
 
        network_format_registry.register(format.get_format_string(), format.__class__)
2221
1741
 
2222
1742
    @classmethod
2223
1743
    def register_control_format(klass, format):
2224
1744
        """Register a format that does not use '.bzr' for its control dir.
2225
1745
 
2226
1746
        TODO: This should be pulled up into a 'ControlDirFormat' base class
2227
 
        which BzrDirFormat can inherit from, and renamed to register_format
 
1747
        which BzrDirFormat can inherit from, and renamed to register_format 
2228
1748
        there. It has been done without that for now for simplicity of
2229
1749
        implementation.
2230
1750
        """
2248
1768
 
2249
1769
    def __str__(self):
2250
1770
        # Trim the newline
2251
 
        return self.get_format_description().rstrip()
2252
 
 
2253
 
    def _supply_sub_formats_to(self, other_format):
2254
 
        """Give other_format the same values for sub formats as this has.
2255
 
 
2256
 
        This method is expected to be used when parameterising a
2257
 
        RemoteBzrDirFormat instance with the parameters from a
2258
 
        BzrDirMetaFormat1 instance.
2259
 
 
2260
 
        :param other_format: other_format is a format which should be
2261
 
            compatible with whatever sub formats are supported by self.
2262
 
        :return: None.
2263
 
        """
 
1771
        return self.get_format_string().rstrip()
2264
1772
 
2265
1773
    @classmethod
2266
1774
    def unregister_format(klass, format):
2298
1806
        """See BzrDirFormat.get_converter()."""
2299
1807
        # there is one and only one upgrade path here.
2300
1808
        return ConvertBzrDir4To5()
2301
 
 
 
1809
        
2302
1810
    def initialize_on_transport(self, transport):
2303
1811
        """Format 4 branches cannot be created."""
2304
1812
        raise errors.UninitializableFormat(self)
2307
1815
        """Format 4 is not supported.
2308
1816
 
2309
1817
        It is not supported because the model changed from 4 to 5 and the
2310
 
        conversion logic is expensive - so doing it on the fly was not
 
1818
        conversion logic is expensive - so doing it on the fly was not 
2311
1819
        feasible.
2312
1820
        """
2313
1821
        return False
2314
1822
 
2315
 
    def network_name(self):
2316
 
        return self.get_format_string()
2317
 
 
2318
1823
    def _open(self, transport):
2319
1824
        """See BzrDirFormat._open."""
2320
1825
        return BzrDir4(transport, self)
2326
1831
    repository_format = property(__return_repository_format)
2327
1832
 
2328
1833
 
2329
 
class BzrDirFormatAllInOne(BzrDirFormat):
2330
 
    """Common class for formats before meta-dirs."""
2331
 
 
2332
 
    def initialize_on_transport_ex(self, transport, use_existing_dir=False,
2333
 
        create_prefix=False, force_new_repo=False, stacked_on=None,
2334
 
        stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
2335
 
        shared_repo=False):
2336
 
        """See BzrDirFormat.initialize_on_transport_ex."""
2337
 
        require_stacking = (stacked_on is not None)
2338
 
        # Format 5 cannot stack, but we've been asked to - actually init
2339
 
        # a Meta1Dir
2340
 
        if require_stacking:
2341
 
            format = BzrDirMetaFormat1()
2342
 
            return format.initialize_on_transport_ex(transport,
2343
 
                use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2344
 
                force_new_repo=force_new_repo, stacked_on=stacked_on,
2345
 
                stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2346
 
                make_working_trees=make_working_trees, shared_repo=shared_repo)
2347
 
        return BzrDirFormat.initialize_on_transport_ex(self, transport,
2348
 
            use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2349
 
            force_new_repo=force_new_repo, stacked_on=stacked_on,
2350
 
            stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2351
 
            make_working_trees=make_working_trees, shared_repo=shared_repo)
2352
 
 
2353
 
 
2354
 
class BzrDirFormat5(BzrDirFormatAllInOne):
 
1834
class BzrDirFormat5(BzrDirFormat):
2355
1835
    """Bzr control format 5.
2356
1836
 
2357
1837
    This format is a combined format for working tree, branch and repository.
2358
1838
    It has:
2359
 
     - Format 2 working trees [always]
2360
 
     - Format 4 branches [always]
 
1839
     - Format 2 working trees [always] 
 
1840
     - Format 4 branches [always] 
2361
1841
     - Format 5 repositories [always]
2362
1842
       Unhashed stores in the repository.
2363
1843
    """
2368
1848
        """See BzrDirFormat.get_format_string()."""
2369
1849
        return "Bazaar-NG branch, format 5\n"
2370
1850
 
2371
 
    def get_branch_format(self):
2372
 
        from bzrlib import branch
2373
 
        return branch.BzrBranchFormat4()
2374
 
 
2375
1851
    def get_format_description(self):
2376
1852
        """See BzrDirFormat.get_format_description()."""
2377
1853
        return "All-in-one format 5"
2383
1859
 
2384
1860
    def _initialize_for_clone(self, url):
2385
1861
        return self.initialize_on_transport(get_transport(url), _cloning=True)
2386
 
 
 
1862
        
2387
1863
    def initialize_on_transport(self, transport, _cloning=False):
2388
1864
        """Format 5 dirs always have working tree, branch and repository.
2389
 
 
 
1865
        
2390
1866
        Except when they are being cloned.
2391
1867
        """
2392
1868
        from bzrlib.branch import BzrBranchFormat4
2393
1869
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
 
1870
        from bzrlib.workingtree import WorkingTreeFormat2
2394
1871
        result = (super(BzrDirFormat5, self).initialize_on_transport(transport))
2395
1872
        RepositoryFormat5().initialize(result, _internal=True)
2396
1873
        if not _cloning:
2397
1874
            branch = BzrBranchFormat4().initialize(result)
2398
 
            result._init_workingtree()
 
1875
            try:
 
1876
                WorkingTreeFormat2().initialize(result)
 
1877
            except errors.NotLocalUrl:
 
1878
                # Even though we can't access the working tree, we need to
 
1879
                # create its control files.
 
1880
                WorkingTreeFormat2()._stub_initialize_remote(branch)
2399
1881
        return result
2400
1882
 
2401
 
    def network_name(self):
2402
 
        return self.get_format_string()
2403
 
 
2404
1883
    def _open(self, transport):
2405
1884
        """See BzrDirFormat._open."""
2406
1885
        return BzrDir5(transport, self)
2412
1891
    repository_format = property(__return_repository_format)
2413
1892
 
2414
1893
 
2415
 
class BzrDirFormat6(BzrDirFormatAllInOne):
 
1894
class BzrDirFormat6(BzrDirFormat):
2416
1895
    """Bzr control format 6.
2417
1896
 
2418
1897
    This format is a combined format for working tree, branch and repository.
2419
1898
    It has:
2420
 
     - Format 2 working trees [always]
2421
 
     - Format 4 branches [always]
 
1899
     - Format 2 working trees [always] 
 
1900
     - Format 4 branches [always] 
2422
1901
     - Format 6 repositories [always]
2423
1902
    """
2424
1903
 
2432
1911
        """See BzrDirFormat.get_format_description()."""
2433
1912
        return "All-in-one format 6"
2434
1913
 
2435
 
    def get_branch_format(self):
2436
 
        from bzrlib import branch
2437
 
        return branch.BzrBranchFormat4()
2438
 
 
2439
1914
    def get_converter(self, format=None):
2440
1915
        """See BzrDirFormat.get_converter()."""
2441
1916
        # there is one and only one upgrade path here.
2442
1917
        return ConvertBzrDir6ToMeta()
2443
 
 
 
1918
        
2444
1919
    def _initialize_for_clone(self, url):
2445
1920
        return self.initialize_on_transport(get_transport(url), _cloning=True)
2446
1921
 
2447
1922
    def initialize_on_transport(self, transport, _cloning=False):
2448
1923
        """Format 6 dirs always have working tree, branch and repository.
2449
 
 
 
1924
        
2450
1925
        Except when they are being cloned.
2451
1926
        """
2452
1927
        from bzrlib.branch import BzrBranchFormat4
2453
1928
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
 
1929
        from bzrlib.workingtree import WorkingTreeFormat2
2454
1930
        result = super(BzrDirFormat6, self).initialize_on_transport(transport)
2455
1931
        RepositoryFormat6().initialize(result, _internal=True)
2456
1932
        if not _cloning:
2457
1933
            branch = BzrBranchFormat4().initialize(result)
2458
 
            result._init_workingtree()
 
1934
            try:
 
1935
                WorkingTreeFormat2().initialize(result)
 
1936
            except errors.NotLocalUrl:
 
1937
                # Even though we can't access the working tree, we need to
 
1938
                # create its control files.
 
1939
                WorkingTreeFormat2()._stub_initialize_remote(branch)
2459
1940
        return result
2460
1941
 
2461
 
    def network_name(self):
2462
 
        return self.get_format_string()
2463
 
 
2464
1942
    def _open(self, transport):
2465
1943
        """See BzrDirFormat._open."""
2466
1944
        return BzrDir6(transport, self)
2488
1966
    def __init__(self):
2489
1967
        self._workingtree_format = None
2490
1968
        self._branch_format = None
2491
 
        self._repository_format = None
2492
1969
 
2493
1970
    def __eq__(self, other):
2494
1971
        if other.__class__ is not self.__class__:
2511
1988
    def set_branch_format(self, format):
2512
1989
        self._branch_format = format
2513
1990
 
2514
 
    def require_stacking(self, stack_on=None, possible_transports=None,
2515
 
            _skip_repo=False):
2516
 
        """We have a request to stack, try to ensure the formats support it.
2517
 
 
2518
 
        :param stack_on: If supplied, it is the URL to a branch that we want to
2519
 
            stack on. Check to see if that format supports stacking before
2520
 
            forcing an upgrade.
2521
 
        """
2522
 
        # Stacking is desired. requested by the target, but does the place it
2523
 
        # points at support stacking? If it doesn't then we should
2524
 
        # not implicitly upgrade. We check this here.
2525
 
        new_repo_format = None
2526
 
        new_branch_format = None
2527
 
 
2528
 
        # a bit of state for get_target_branch so that we don't try to open it
2529
 
        # 2 times, for both repo *and* branch
2530
 
        target = [None, False, None] # target_branch, checked, upgrade anyway
2531
 
        def get_target_branch():
2532
 
            if target[1]:
2533
 
                # We've checked, don't check again
2534
 
                return target
2535
 
            if stack_on is None:
2536
 
                # No target format, that means we want to force upgrading
2537
 
                target[:] = [None, True, True]
2538
 
                return target
2539
 
            try:
2540
 
                target_dir = BzrDir.open(stack_on,
2541
 
                    possible_transports=possible_transports)
2542
 
            except errors.NotBranchError:
2543
 
                # Nothing there, don't change formats
2544
 
                target[:] = [None, True, False]
2545
 
                return target
2546
 
            except errors.JailBreak:
2547
 
                # JailBreak, JFDI and upgrade anyway
2548
 
                target[:] = [None, True, True]
2549
 
                return target
2550
 
            try:
2551
 
                target_branch = target_dir.open_branch()
2552
 
            except errors.NotBranchError:
2553
 
                # No branch, don't upgrade formats
2554
 
                target[:] = [None, True, False]
2555
 
                return target
2556
 
            target[:] = [target_branch, True, False]
2557
 
            return target
2558
 
 
2559
 
        if (not _skip_repo and
2560
 
                 not self.repository_format.supports_external_lookups):
2561
 
            # We need to upgrade the Repository.
2562
 
            target_branch, _, do_upgrade = get_target_branch()
2563
 
            if target_branch is None:
2564
 
                # We don't have a target branch, should we upgrade anyway?
2565
 
                if do_upgrade:
2566
 
                    # stack_on is inaccessible, JFDI.
2567
 
                    # TODO: bad monkey, hard-coded formats...
2568
 
                    if self.repository_format.rich_root_data:
2569
 
                        new_repo_format = pack_repo.RepositoryFormatKnitPack5RichRoot()
2570
 
                    else:
2571
 
                        new_repo_format = pack_repo.RepositoryFormatKnitPack5()
2572
 
            else:
2573
 
                # If the target already supports stacking, then we know the
2574
 
                # project is already able to use stacking, so auto-upgrade
2575
 
                # for them
2576
 
                new_repo_format = target_branch.repository._format
2577
 
                if not new_repo_format.supports_external_lookups:
2578
 
                    # target doesn't, source doesn't, so don't auto upgrade
2579
 
                    # repo
2580
 
                    new_repo_format = None
2581
 
            if new_repo_format is not None:
2582
 
                self.repository_format = new_repo_format
2583
 
                note('Source repository format does not support stacking,'
2584
 
                     ' using format:\n  %s',
2585
 
                     new_repo_format.get_format_description())
2586
 
 
2587
 
        if not self.get_branch_format().supports_stacking():
2588
 
            # We just checked the repo, now lets check if we need to
2589
 
            # upgrade the branch format
2590
 
            target_branch, _, do_upgrade = get_target_branch()
2591
 
            if target_branch is None:
2592
 
                if do_upgrade:
2593
 
                    # TODO: bad monkey, hard-coded formats...
2594
 
                    new_branch_format = branch.BzrBranchFormat7()
2595
 
            else:
2596
 
                new_branch_format = target_branch._format
2597
 
                if not new_branch_format.supports_stacking():
2598
 
                    new_branch_format = None
2599
 
            if new_branch_format is not None:
2600
 
                # Does support stacking, use its format.
2601
 
                self.set_branch_format(new_branch_format)
2602
 
                note('Source branch format does not support stacking,'
2603
 
                     ' using format:\n  %s',
2604
 
                     new_branch_format.get_format_description())
2605
 
 
2606
1991
    def get_converter(self, format=None):
2607
1992
        """See BzrDirFormat.get_converter()."""
2608
1993
        if format is None:
2620
2005
        """See BzrDirFormat.get_format_description()."""
2621
2006
        return "Meta directory format 1"
2622
2007
 
2623
 
    def network_name(self):
2624
 
        return self.get_format_string()
2625
 
 
2626
2008
    def _open(self, transport):
2627
2009
        """See BzrDirFormat._open."""
2628
 
        # Create a new format instance because otherwise initialisation of new
2629
 
        # metadirs share the global default format object leading to alias
2630
 
        # problems.
2631
 
        format = BzrDirMetaFormat1()
2632
 
        self._supply_sub_formats_to(format)
2633
 
        return BzrDirMeta1(transport, format)
 
2010
        return BzrDirMeta1(transport, self)
2634
2011
 
2635
2012
    def __return_repository_format(self):
2636
2013
        """Circular import protection."""
2637
 
        if self._repository_format:
 
2014
        if getattr(self, '_repository_format', None):
2638
2015
            return self._repository_format
2639
2016
        from bzrlib.repository import RepositoryFormat
2640
2017
        return RepositoryFormat.get_default_format()
2641
2018
 
2642
 
    def _set_repository_format(self, value):
 
2019
    def __set_repository_format(self, value):
2643
2020
        """Allow changing the repository format for metadir formats."""
2644
2021
        self._repository_format = value
2645
2022
 
2646
 
    repository_format = property(__return_repository_format,
2647
 
        _set_repository_format)
2648
 
 
2649
 
    def _supply_sub_formats_to(self, other_format):
2650
 
        """Give other_format the same values for sub formats as this has.
2651
 
 
2652
 
        This method is expected to be used when parameterising a
2653
 
        RemoteBzrDirFormat instance with the parameters from a
2654
 
        BzrDirMetaFormat1 instance.
2655
 
 
2656
 
        :param other_format: other_format is a format which should be
2657
 
            compatible with whatever sub formats are supported by self.
2658
 
        :return: None.
2659
 
        """
2660
 
        if getattr(self, '_repository_format', None) is not None:
2661
 
            other_format.repository_format = self.repository_format
2662
 
        if self._branch_format is not None:
2663
 
            other_format._branch_format = self._branch_format
2664
 
        if self._workingtree_format is not None:
2665
 
            other_format.workingtree_format = self.workingtree_format
 
2023
    repository_format = property(__return_repository_format, __set_repository_format)
2666
2024
 
2667
2025
    def __get_workingtree_format(self):
2668
2026
        if self._workingtree_format is None:
2677
2035
                                  __set_workingtree_format)
2678
2036
 
2679
2037
 
2680
 
network_format_registry = registry.FormatRegistry()
2681
 
"""Registry of formats indexed by their network name.
2682
 
 
2683
 
The network name for a BzrDirFormat is an identifier that can be used when
2684
 
referring to formats with smart server operations. See
2685
 
BzrDirFormat.network_name() for more detail.
2686
 
"""
2687
 
 
2688
 
 
2689
2038
# Register bzr control format
2690
2039
BzrDirFormat.register_control_format(BzrDirFormat)
2691
2040
 
2723
2072
        self.absent_revisions = set()
2724
2073
        self.text_count = 0
2725
2074
        self.revisions = {}
2726
 
 
 
2075
        
2727
2076
    def convert(self, to_convert, pb):
2728
2077
        """See Converter.convert()."""
2729
2078
        self.bzrdir = to_convert
2730
 
        if pb is not None:
2731
 
            warnings.warn("pb parameter to convert() is deprecated")
2732
 
        self.pb = ui.ui_factory.nested_progress_bar()
2733
 
        try:
2734
 
            ui.ui_factory.note('starting upgrade from format 4 to 5')
2735
 
            if isinstance(self.bzrdir.transport, local.LocalTransport):
2736
 
                self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
2737
 
            self._convert_to_weaves()
2738
 
            return BzrDir.open(self.bzrdir.user_url)
2739
 
        finally:
2740
 
            self.pb.finished()
 
2079
        self.pb = pb
 
2080
        self.pb.note('starting upgrade from format 4 to 5')
 
2081
        if isinstance(self.bzrdir.transport, LocalTransport):
 
2082
            self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
 
2083
        self._convert_to_weaves()
 
2084
        return BzrDir.open(self.bzrdir.root_transport.base)
2741
2085
 
2742
2086
    def _convert_to_weaves(self):
2743
 
        ui.ui_factory.note('note: upgrade may be faster if all store files are ungzipped first')
 
2087
        self.pb.note('note: upgrade may be faster if all store files are ungzipped first')
2744
2088
        try:
2745
2089
            # TODO permissions
2746
2090
            stat = self.bzrdir.transport.stat('weaves')
2774
2118
        self.pb.clear()
2775
2119
        self._write_all_weaves()
2776
2120
        self._write_all_revs()
2777
 
        ui.ui_factory.note('upgraded to weaves:')
2778
 
        ui.ui_factory.note('  %6d revisions and inventories' % len(self.revisions))
2779
 
        ui.ui_factory.note('  %6d revisions not present' % len(self.absent_revisions))
2780
 
        ui.ui_factory.note('  %6d texts' % self.text_count)
 
2121
        self.pb.note('upgraded to weaves:')
 
2122
        self.pb.note('  %6d revisions and inventories', len(self.revisions))
 
2123
        self.pb.note('  %6d revisions not present', len(self.absent_revisions))
 
2124
        self.pb.note('  %6d texts', self.text_count)
2781
2125
        self._cleanup_spare_files_after_format4()
2782
2126
        self.branch._transport.put_bytes(
2783
2127
            'branch-format',
2840
2184
                revision_store.add_lines(key, None, osutils.split_lines(text))
2841
2185
        finally:
2842
2186
            self.pb.clear()
2843
 
 
 
2187
            
2844
2188
    def _load_one_rev(self, rev_id):
2845
2189
        """Load a revision object into memory.
2846
2190
 
2851
2195
                       len(self.known_revisions))
2852
2196
        if not self.branch.repository.has_revision(rev_id):
2853
2197
            self.pb.clear()
2854
 
            ui.ui_factory.note('revision {%s} not present in branch; '
2855
 
                         'will be converted as a ghost' %
 
2198
            self.pb.note('revision {%s} not present in branch; '
 
2199
                         'will be converted as a ghost',
2856
2200
                         rev_id)
2857
2201
            self.absent_revisions.add(rev_id)
2858
2202
        else:
2920
2264
        text_changed = False
2921
2265
        parent_candiate_entries = ie.parent_candidates(parent_invs)
2922
2266
        heads = graph.Graph(self).heads(parent_candiate_entries.keys())
2923
 
        # XXX: Note that this is unordered - and this is tolerable because
 
2267
        # XXX: Note that this is unordered - and this is tolerable because 
2924
2268
        # the previous code was also unordered.
2925
2269
        previous_entries = dict((head, parent_candiate_entries[head]) for head
2926
2270
            in heads)
2927
2271
        self.snapshot_ie(previous_entries, ie, w, rev_id)
2928
2272
        del ie.text_id
2929
2273
 
 
2274
    @symbol_versioning.deprecated_method(symbol_versioning.one_one)
 
2275
    def get_parents(self, revision_ids):
 
2276
        for revision_id in revision_ids:
 
2277
            yield self.revisions[revision_id].parent_ids
 
2278
 
2930
2279
    def get_parent_map(self, revision_ids):
2931
 
        """See graph.StackedParentsProvider.get_parent_map"""
 
2280
        """See graph._StackedParentsProvider.get_parent_map"""
2932
2281
        return dict((revision_id, self.revisions[revision_id])
2933
2282
                    for revision_id in revision_ids
2934
2283
                     if revision_id in self.revisions)
2938
2287
        # a call to:. This needs the path figured out. rather than a work_tree
2939
2288
        # a v4 revision_tree can be given, or something that looks enough like
2940
2289
        # one to give the file content to the entry if it needs it.
2941
 
        # and we need something that looks like a weave store for snapshot to
 
2290
        # and we need something that looks like a weave store for snapshot to 
2942
2291
        # save against.
2943
2292
        #ie.snapshot(rev, PATH, previous_revisions, REVISION_TREE, InMemoryWeaveStore(self.text_weaves))
2944
2293
        if len(previous_revisions) == 1:
2984
2333
    def convert(self, to_convert, pb):
2985
2334
        """See Converter.convert()."""
2986
2335
        self.bzrdir = to_convert
2987
 
        pb = ui.ui_factory.nested_progress_bar()
2988
 
        try:
2989
 
            ui.ui_factory.note('starting upgrade from format 5 to 6')
2990
 
            self._convert_to_prefixed()
2991
 
            return BzrDir.open(self.bzrdir.user_url)
2992
 
        finally:
2993
 
            pb.finished()
 
2336
        self.pb = pb
 
2337
        self.pb.note('starting upgrade from format 5 to 6')
 
2338
        self._convert_to_prefixed()
 
2339
        return BzrDir.open(self.bzrdir.root_transport.base)
2994
2340
 
2995
2341
    def _convert_to_prefixed(self):
2996
2342
        from bzrlib.store import TransportStore
2997
2343
        self.bzrdir.transport.delete('branch-format')
2998
2344
        for store_name in ["weaves", "revision-store"]:
2999
 
            ui.ui_factory.note("adding prefixes to %s" % store_name)
 
2345
            self.pb.note("adding prefixes to %s" % store_name)
3000
2346
            store_transport = self.bzrdir.transport.clone(store_name)
3001
2347
            store = TransportStore(store_transport, prefixed=True)
3002
2348
            for urlfilename in store_transport.list_dir('.'):
3029
2375
        from bzrlib.repofmt.weaverepo import RepositoryFormat7
3030
2376
        from bzrlib.branch import BzrBranchFormat5
3031
2377
        self.bzrdir = to_convert
3032
 
        self.pb = ui.ui_factory.nested_progress_bar()
 
2378
        self.pb = pb
3033
2379
        self.count = 0
3034
2380
        self.total = 20 # the steps we know about
3035
2381
        self.garbage_inventories = []
3036
2382
        self.dir_mode = self.bzrdir._get_dir_mode()
3037
2383
        self.file_mode = self.bzrdir._get_file_mode()
3038
2384
 
3039
 
        ui.ui_factory.note('starting upgrade from format 6 to metadir')
 
2385
        self.pb.note('starting upgrade from format 6 to metadir')
3040
2386
        self.bzrdir.transport.put_bytes(
3041
2387
                'branch-format',
3042
2388
                "Converting to format 6",
3063
2409
        self.bzrdir.transport.mkdir('repository', mode=self.dir_mode)
3064
2410
        self.make_lock('repository')
3065
2411
        # we hard code the formats here because we are converting into
3066
 
        # the meta format. The meta format upgrader can take this to a
 
2412
        # the meta format. The meta format upgrader can take this to a 
3067
2413
        # future format within each component.
3068
2414
        self.put_format('repository', RepositoryFormat7())
3069
2415
        for entry in repository_names:
3092
2438
        else:
3093
2439
            has_checkout = True
3094
2440
        if not has_checkout:
3095
 
            ui.ui_factory.note('No working tree.')
 
2441
            self.pb.note('No working tree.')
3096
2442
            # If some checkout files are there, we may as well get rid of them.
3097
2443
            for name, mandatory in checkout_files:
3098
2444
                if name in bzrcontents:
3115
2461
            'branch-format',
3116
2462
            BzrDirMetaFormat1().get_format_string(),
3117
2463
            mode=self.file_mode)
3118
 
        self.pb.finished()
3119
 
        return BzrDir.open(self.bzrdir.user_url)
 
2464
        return BzrDir.open(self.bzrdir.root_transport.base)
3120
2465
 
3121
2466
    def make_lock(self, name):
3122
2467
        """Make a lock for the new control dir name."""
3157
2502
    def convert(self, to_convert, pb):
3158
2503
        """See Converter.convert()."""
3159
2504
        self.bzrdir = to_convert
3160
 
        self.pb = ui.ui_factory.nested_progress_bar()
 
2505
        self.pb = pb
3161
2506
        self.count = 0
3162
2507
        self.total = 1
3163
2508
        self.step('checking repository format')
3168
2513
        else:
3169
2514
            if not isinstance(repo._format, self.target_format.repository_format.__class__):
3170
2515
                from bzrlib.repository import CopyConverter
3171
 
                ui.ui_factory.note('starting repository conversion')
 
2516
                self.pb.note('starting repository conversion')
3172
2517
                converter = CopyConverter(self.target_format.repository_format)
3173
2518
                converter.convert(repo, pb)
3174
 
        for branch in self.bzrdir.list_branches():
 
2519
        try:
 
2520
            branch = self.bzrdir.open_branch()
 
2521
        except errors.NotBranchError:
 
2522
            pass
 
2523
        else:
3175
2524
            # TODO: conversions of Branch and Tree should be done by
3176
2525
            # InterXFormat lookups/some sort of registry.
3177
2526
            # Avoid circular imports
3181
2530
            while old != new:
3182
2531
                if (old == _mod_branch.BzrBranchFormat5 and
3183
2532
                    new in (_mod_branch.BzrBranchFormat6,
3184
 
                        _mod_branch.BzrBranchFormat7,
3185
 
                        _mod_branch.BzrBranchFormat8)):
 
2533
                        _mod_branch.BzrBranchFormat7)):
3186
2534
                    branch_converter = _mod_branch.Converter5to6()
3187
2535
                elif (old == _mod_branch.BzrBranchFormat6 and
3188
 
                    new in (_mod_branch.BzrBranchFormat7,
3189
 
                            _mod_branch.BzrBranchFormat8)):
 
2536
                    new == _mod_branch.BzrBranchFormat7):
3190
2537
                    branch_converter = _mod_branch.Converter6to7()
3191
 
                elif (old == _mod_branch.BzrBranchFormat7 and
3192
 
                      new is _mod_branch.BzrBranchFormat8):
3193
 
                    branch_converter = _mod_branch.Converter7to8()
3194
2538
                else:
3195
 
                    raise errors.BadConversionTarget("No converter", new,
3196
 
                        branch._format)
 
2539
                    raise errors.BadConversionTarget("No converter", new)
3197
2540
                branch_converter.convert(branch)
3198
2541
                branch = self.bzrdir.open_branch()
3199
2542
                old = branch._format.__class__
3205
2548
            # TODO: conversions of Branch and Tree should be done by
3206
2549
            # InterXFormat lookups
3207
2550
            if (isinstance(tree, workingtree.WorkingTree3) and
3208
 
                not isinstance(tree, workingtree_4.DirStateWorkingTree) and
 
2551
                not isinstance(tree, workingtree_4.WorkingTree4) and
3209
2552
                isinstance(self.target_format.workingtree_format,
3210
 
                    workingtree_4.DirStateWorkingTreeFormat)):
 
2553
                    workingtree_4.WorkingTreeFormat4)):
3211
2554
                workingtree_4.Converter3to4().convert(tree)
3212
 
            if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
3213
 
                not isinstance(tree, workingtree_4.WorkingTree5) and
3214
 
                isinstance(self.target_format.workingtree_format,
3215
 
                    workingtree_4.WorkingTreeFormat5)):
3216
 
                workingtree_4.Converter4to5().convert(tree)
3217
 
            if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
3218
 
                not isinstance(tree, workingtree_4.WorkingTree6) and
3219
 
                isinstance(self.target_format.workingtree_format,
3220
 
                    workingtree_4.WorkingTreeFormat6)):
3221
 
                workingtree_4.Converter4or5to6().convert(tree)
3222
 
        self.pb.finished()
3223
2555
        return to_convert
3224
2556
 
3225
2557
 
3226
 
# This is not in remote.py because it's relatively small, and needs to be
3227
 
# registered. Putting it in remote.py creates a circular import problem.
 
2558
# This is not in remote.py because it's small, and needs to be registered.
 
2559
# Putting it in remote.py creates a circular import problem.
3228
2560
# we can make it a lazy object if the control formats is turned into something
3229
2561
# like a registry.
3230
2562
class RemoteBzrDirFormat(BzrDirMetaFormat1):
3231
2563
    """Format representing bzrdirs accessed via a smart server"""
3232
2564
 
3233
 
    def __init__(self):
3234
 
        BzrDirMetaFormat1.__init__(self)
3235
 
        # XXX: It's a bit ugly that the network name is here, because we'd
3236
 
        # like to believe that format objects are stateless or at least
3237
 
        # immutable,  However, we do at least avoid mutating the name after
3238
 
        # it's returned.  See <https://bugs.edge.launchpad.net/bzr/+bug/504102>
3239
 
        self._network_name = None
3240
 
 
3241
 
    def __repr__(self):
3242
 
        return "%s(_network_name=%r)" % (self.__class__.__name__,
3243
 
            self._network_name)
3244
 
 
3245
2565
    def get_format_description(self):
3246
 
        if self._network_name:
3247
 
            real_format = network_format_registry.get(self._network_name)
3248
 
            return 'Remote: ' + real_format.get_format_description()
3249
2566
        return 'bzr remote bzrdir'
3250
 
 
3251
 
    def get_format_string(self):
3252
 
        raise NotImplementedError(self.get_format_string)
3253
 
 
3254
 
    def network_name(self):
3255
 
        if self._network_name:
3256
 
            return self._network_name
3257
 
        else:
3258
 
            raise AssertionError("No network name set.")
3259
 
 
 
2567
    
3260
2568
    @classmethod
3261
2569
    def probe_transport(klass, transport):
3262
2570
        """Return a RemoteBzrDirFormat object if it looks possible."""
3291
2599
            return local_dir_format.initialize_on_transport(transport)
3292
2600
        client = _SmartClient(client_medium)
3293
2601
        path = client.remote_path_from_transport(transport)
3294
 
        try:
3295
 
            response = client.call('BzrDirFormat.initialize', path)
3296
 
        except errors.ErrorFromSmartServer, err:
3297
 
            remote._translate_error(err, path=path)
 
2602
        response = client.call('BzrDirFormat.initialize', path)
3298
2603
        if response[0] != 'ok':
3299
2604
            raise errors.SmartProtocolError('unexpected response code %s' % (response,))
3300
 
        format = RemoteBzrDirFormat()
3301
 
        self._supply_sub_formats_to(format)
3302
 
        return remote.RemoteBzrDir(transport, format)
3303
 
 
3304
 
    def parse_NoneTrueFalse(self, arg):
3305
 
        if not arg:
3306
 
            return None
3307
 
        if arg == 'False':
3308
 
            return False
3309
 
        if arg == 'True':
3310
 
            return True
3311
 
        raise AssertionError("invalid arg %r" % arg)
3312
 
 
3313
 
    def _serialize_NoneTrueFalse(self, arg):
3314
 
        if arg is False:
3315
 
            return 'False'
3316
 
        if arg:
3317
 
            return 'True'
3318
 
        return ''
3319
 
 
3320
 
    def _serialize_NoneString(self, arg):
3321
 
        return arg or ''
3322
 
 
3323
 
    def initialize_on_transport_ex(self, transport, use_existing_dir=False,
3324
 
        create_prefix=False, force_new_repo=False, stacked_on=None,
3325
 
        stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
3326
 
        shared_repo=False):
3327
 
        try:
3328
 
            # hand off the request to the smart server
3329
 
            client_medium = transport.get_smart_medium()
3330
 
        except errors.NoSmartMedium:
3331
 
            do_vfs = True
3332
 
        else:
3333
 
            # Decline to open it if the server doesn't support our required
3334
 
            # version (3) so that the VFS-based transport will do it.
3335
 
            if client_medium.should_probe():
3336
 
                try:
3337
 
                    server_version = client_medium.protocol_version()
3338
 
                    if server_version != '2':
3339
 
                        do_vfs = True
3340
 
                    else:
3341
 
                        do_vfs = False
3342
 
                except errors.SmartProtocolError:
3343
 
                    # Apparently there's no usable smart server there, even though
3344
 
                    # the medium supports the smart protocol.
3345
 
                    do_vfs = True
3346
 
            else:
3347
 
                do_vfs = False
3348
 
        if not do_vfs:
3349
 
            client = _SmartClient(client_medium)
3350
 
            path = client.remote_path_from_transport(transport)
3351
 
            if client_medium._is_remote_before((1, 16)):
3352
 
                do_vfs = True
3353
 
        if do_vfs:
3354
 
            # TODO: lookup the local format from a server hint.
3355
 
            local_dir_format = BzrDirMetaFormat1()
3356
 
            self._supply_sub_formats_to(local_dir_format)
3357
 
            return local_dir_format.initialize_on_transport_ex(transport,
3358
 
                use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3359
 
                force_new_repo=force_new_repo, stacked_on=stacked_on,
3360
 
                stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3361
 
                make_working_trees=make_working_trees, shared_repo=shared_repo,
3362
 
                vfs_only=True)
3363
 
        return self._initialize_on_transport_ex_rpc(client, path, transport,
3364
 
            use_existing_dir, create_prefix, force_new_repo, stacked_on,
3365
 
            stack_on_pwd, repo_format_name, make_working_trees, shared_repo)
3366
 
 
3367
 
    def _initialize_on_transport_ex_rpc(self, client, path, transport,
3368
 
        use_existing_dir, create_prefix, force_new_repo, stacked_on,
3369
 
        stack_on_pwd, repo_format_name, make_working_trees, shared_repo):
3370
 
        args = []
3371
 
        args.append(self._serialize_NoneTrueFalse(use_existing_dir))
3372
 
        args.append(self._serialize_NoneTrueFalse(create_prefix))
3373
 
        args.append(self._serialize_NoneTrueFalse(force_new_repo))
3374
 
        args.append(self._serialize_NoneString(stacked_on))
3375
 
        # stack_on_pwd is often/usually our transport
3376
 
        if stack_on_pwd:
3377
 
            try:
3378
 
                stack_on_pwd = transport.relpath(stack_on_pwd)
3379
 
                if not stack_on_pwd:
3380
 
                    stack_on_pwd = '.'
3381
 
            except errors.PathNotChild:
3382
 
                pass
3383
 
        args.append(self._serialize_NoneString(stack_on_pwd))
3384
 
        args.append(self._serialize_NoneString(repo_format_name))
3385
 
        args.append(self._serialize_NoneTrueFalse(make_working_trees))
3386
 
        args.append(self._serialize_NoneTrueFalse(shared_repo))
3387
 
        request_network_name = self._network_name or \
3388
 
            BzrDirFormat.get_default_format().network_name()
3389
 
        try:
3390
 
            response = client.call('BzrDirFormat.initialize_ex_1.16',
3391
 
                request_network_name, path, *args)
3392
 
        except errors.UnknownSmartMethod:
3393
 
            client._medium._remember_remote_is_before((1,16))
3394
 
            local_dir_format = BzrDirMetaFormat1()
3395
 
            self._supply_sub_formats_to(local_dir_format)
3396
 
            return local_dir_format.initialize_on_transport_ex(transport,
3397
 
                use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3398
 
                force_new_repo=force_new_repo, stacked_on=stacked_on,
3399
 
                stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3400
 
                make_working_trees=make_working_trees, shared_repo=shared_repo,
3401
 
                vfs_only=True)
3402
 
        except errors.ErrorFromSmartServer, err:
3403
 
            remote._translate_error(err, path=path)
3404
 
        repo_path = response[0]
3405
 
        bzrdir_name = response[6]
3406
 
        require_stacking = response[7]
3407
 
        require_stacking = self.parse_NoneTrueFalse(require_stacking)
3408
 
        format = RemoteBzrDirFormat()
3409
 
        format._network_name = bzrdir_name
3410
 
        self._supply_sub_formats_to(format)
3411
 
        bzrdir = remote.RemoteBzrDir(transport, format, _client=client)
3412
 
        if repo_path:
3413
 
            repo_format = remote.response_tuple_to_repo_format(response[1:])
3414
 
            if repo_path == '.':
3415
 
                repo_path = ''
3416
 
            if repo_path:
3417
 
                repo_bzrdir_format = RemoteBzrDirFormat()
3418
 
                repo_bzrdir_format._network_name = response[5]
3419
 
                repo_bzr = remote.RemoteBzrDir(transport.clone(repo_path),
3420
 
                    repo_bzrdir_format)
3421
 
            else:
3422
 
                repo_bzr = bzrdir
3423
 
            final_stack = response[8] or None
3424
 
            final_stack_pwd = response[9] or None
3425
 
            if final_stack_pwd:
3426
 
                final_stack_pwd = urlutils.join(
3427
 
                    transport.base, final_stack_pwd)
3428
 
            remote_repo = remote.RemoteRepository(repo_bzr, repo_format)
3429
 
            if len(response) > 10:
3430
 
                # Updated server verb that locks remotely.
3431
 
                repo_lock_token = response[10] or None
3432
 
                remote_repo.lock_write(repo_lock_token, _skip_rpc=True)
3433
 
                if repo_lock_token:
3434
 
                    remote_repo.dont_leave_lock_in_place()
3435
 
            else:
3436
 
                remote_repo.lock_write()
3437
 
            policy = UseExistingRepository(remote_repo, final_stack,
3438
 
                final_stack_pwd, require_stacking)
3439
 
            policy.acquire_repository()
3440
 
        else:
3441
 
            remote_repo = None
3442
 
            policy = None
3443
 
        bzrdir._format.set_branch_format(self.get_branch_format())
3444
 
        if require_stacking:
3445
 
            # The repo has already been created, but we need to make sure that
3446
 
            # we'll make a stackable branch.
3447
 
            bzrdir._format.require_stacking(_skip_repo=True)
3448
 
        return remote_repo, bzrdir, require_stacking, policy
 
2605
        return remote.RemoteBzrDir(transport)
3449
2606
 
3450
2607
    def _open(self, transport):
3451
 
        return remote.RemoteBzrDir(transport, self)
 
2608
        return remote.RemoteBzrDir(transport)
3452
2609
 
3453
2610
    def __eq__(self, other):
3454
2611
        if not isinstance(other, RemoteBzrDirFormat):
3455
2612
            return False
3456
2613
        return self.get_format_description() == other.get_format_description()
3457
2614
 
3458
 
    def __return_repository_format(self):
3459
 
        # Always return a RemoteRepositoryFormat object, but if a specific bzr
3460
 
        # repository format has been asked for, tell the RemoteRepositoryFormat
3461
 
        # that it should use that for init() etc.
3462
 
        result = remote.RemoteRepositoryFormat()
3463
 
        custom_format = getattr(self, '_repository_format', None)
3464
 
        if custom_format:
3465
 
            if isinstance(custom_format, remote.RemoteRepositoryFormat):
3466
 
                return custom_format
3467
 
            else:
3468
 
                # We will use the custom format to create repositories over the
3469
 
                # wire; expose its details like rich_root_data for code to
3470
 
                # query
3471
 
                result._custom_format = custom_format
3472
 
        return result
3473
 
 
3474
 
    def get_branch_format(self):
3475
 
        result = BzrDirMetaFormat1.get_branch_format(self)
3476
 
        if not isinstance(result, remote.RemoteBranchFormat):
3477
 
            new_result = remote.RemoteBranchFormat()
3478
 
            new_result._custom_format = result
3479
 
            # cache the result
3480
 
            self.set_branch_format(new_result)
3481
 
            result = new_result
3482
 
        return result
3483
 
 
3484
 
    repository_format = property(__return_repository_format,
3485
 
        BzrDirMetaFormat1._set_repository_format) #.im_func)
3486
 
 
3487
2615
 
3488
2616
BzrDirFormat.register_control_server_format(RemoteBzrDirFormat)
3489
2617
 
3499
2627
 
3500
2628
class BzrDirFormatRegistry(registry.Registry):
3501
2629
    """Registry of user-selectable BzrDir subformats.
3502
 
 
 
2630
    
3503
2631
    Differs from BzrDirFormat._control_formats in that it provides sub-formats,
3504
2632
    e.g. BzrDirMeta1 with weave repository.  Also, it's more user-oriented.
3505
2633
    """
3507
2635
    def __init__(self):
3508
2636
        """Create a BzrDirFormatRegistry."""
3509
2637
        self._aliases = set()
3510
 
        self._registration_order = list()
3511
2638
        super(BzrDirFormatRegistry, self).__init__()
3512
2639
 
3513
2640
    def aliases(self):
3524
2651
        """Register a metadir subformat.
3525
2652
 
3526
2653
        These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
3527
 
        by the Repository/Branch/WorkingTreeformats.
 
2654
        by the Repository format.
3528
2655
 
3529
2656
        :param repository_format: The fully-qualified repository format class
3530
2657
            name as a string.
3564
2691
    def register(self, key, factory, help, native=True, deprecated=False,
3565
2692
                 hidden=False, experimental=False, alias=False):
3566
2693
        """Register a BzrDirFormat factory.
3567
 
 
 
2694
        
3568
2695
        The factory must be a callable that takes one parameter: the key.
3569
2696
        It must produce an instance of the BzrDirFormat when called.
3570
2697
 
3575
2702
            BzrDirFormatInfo(native, deprecated, hidden, experimental))
3576
2703
        if alias:
3577
2704
            self._aliases.add(key)
3578
 
        self._registration_order.append(key)
3579
2705
 
3580
2706
    def register_lazy(self, key, module_name, member_name, help, native=True,
3581
2707
        deprecated=False, hidden=False, experimental=False, alias=False):
3583
2709
            help, BzrDirFormatInfo(native, deprecated, hidden, experimental))
3584
2710
        if alias:
3585
2711
            self._aliases.add(key)
3586
 
        self._registration_order.append(key)
3587
2712
 
3588
2713
    def set_default(self, key):
3589
2714
        """Set the 'default' key to be a clone of the supplied key.
3590
 
 
 
2715
        
3591
2716
        This method must be called once and only once.
3592
2717
        """
3593
2718
        registry.Registry.register(self, 'default', self.get(key),
3596
2721
 
3597
2722
    def set_default_repository(self, key):
3598
2723
        """Set the FormatRegistry default and Repository default.
3599
 
 
 
2724
        
3600
2725
        This is a transitional method while Repository.set_default_format
3601
2726
        is deprecated.
3602
2727
        """
3609
2734
        return self.get(key)()
3610
2735
 
3611
2736
    def help_topic(self, topic):
3612
 
        output = ""
 
2737
        output = textwrap.dedent("""\
 
2738
            These formats can be used for creating branches, working trees, and
 
2739
            repositories.
 
2740
 
 
2741
            """)
3613
2742
        default_realkey = None
3614
2743
        default_help = self.get_help('default')
3615
2744
        help_pairs = []
3616
 
        for key in self._registration_order:
 
2745
        for key in self.keys():
3617
2746
            if key == 'default':
3618
2747
                continue
3619
2748
            help = self.get_help(key)
3625
2754
        def wrapped(key, help, info):
3626
2755
            if info.native:
3627
2756
                help = '(native) ' + help
3628
 
            return ':%s:\n%s\n\n' % (key,
3629
 
                textwrap.fill(help, initial_indent='    ',
3630
 
                    subsequent_indent='    ',
3631
 
                    break_long_words=False))
 
2757
            return ':%s:\n%s\n\n' % (key, 
 
2758
                    textwrap.fill(help, initial_indent='    ', 
 
2759
                    subsequent_indent='    '))
3632
2760
        if default_realkey is not None:
3633
2761
            output += wrapped(default_realkey, '(default) %s' % default_help,
3634
2762
                              self.get_info('default'))
3644
2772
                experimental_pairs.append((key, help))
3645
2773
            else:
3646
2774
                output += wrapped(key, help, info)
3647
 
        output += "\nSee :doc:`formats-help` for more about storage formats."
3648
 
        other_output = ""
3649
2775
        if len(experimental_pairs) > 0:
3650
 
            other_output += "Experimental formats are shown below.\n\n"
 
2776
            output += "Experimental formats are shown below.\n\n"
3651
2777
            for key, help in experimental_pairs:
3652
2778
                info = self.get_info(key)
3653
 
                other_output += wrapped(key, help, info)
3654
 
        else:
3655
 
            other_output += \
3656
 
                "No experimental formats are available.\n\n"
 
2779
                output += wrapped(key, help, info)
3657
2780
        if len(deprecated_pairs) > 0:
3658
 
            other_output += "\nDeprecated formats are shown below.\n\n"
 
2781
            output += "Deprecated formats are shown below.\n\n"
3659
2782
            for key, help in deprecated_pairs:
3660
2783
                info = self.get_info(key)
3661
 
                other_output += wrapped(key, help, info)
3662
 
        else:
3663
 
            other_output += \
3664
 
                "\nNo deprecated formats are available.\n\n"
3665
 
        other_output += \
3666
 
                "\nSee :doc:`formats-help` for more about storage formats."
 
2784
                output += wrapped(key, help, info)
3667
2785
 
3668
 
        if topic == 'other-formats':
3669
 
            return other_output
3670
 
        else:
3671
 
            return output
 
2786
        return output
3672
2787
 
3673
2788
 
3674
2789
class RepositoryAcquisitionPolicy(object):
3703
2818
            try:
3704
2819
                stack_on = urlutils.rebase_url(self._stack_on,
3705
2820
                    self._stack_on_pwd,
3706
 
                    branch.user_url)
 
2821
                    branch.bzrdir.root_transport.base)
3707
2822
            except errors.InvalidRebaseURLs:
3708
2823
                stack_on = self._get_full_stack_on()
3709
2824
        try:
3710
2825
            branch.set_stacked_on_url(stack_on)
3711
 
        except (errors.UnstackableBranchFormat,
3712
 
                errors.UnstackableRepositoryFormat):
 
2826
        except errors.UnstackableBranchFormat:
3713
2827
            if self._require_stacking:
3714
2828
                raise
3715
2829
 
3716
 
    def requires_stacking(self):
3717
 
        """Return True if this policy requires stacking."""
3718
 
        return self._stack_on is not None and self._require_stacking
3719
 
 
3720
2830
    def _get_full_stack_on(self):
3721
2831
        """Get a fully-qualified URL for the stack_on location."""
3722
2832
        if self._stack_on is None:
3726
2836
        else:
3727
2837
            return urlutils.join(self._stack_on_pwd, self._stack_on)
3728
2838
 
3729
 
    def _add_fallback(self, repository, possible_transports=None):
 
2839
    def _add_fallback(self, repository):
3730
2840
        """Add a fallback to the supplied repository, if stacking is set."""
3731
2841
        stack_on = self._get_full_stack_on()
3732
2842
        if stack_on is None:
3733
2843
            return
3734
 
        try:
3735
 
            stacked_dir = BzrDir.open(stack_on,
3736
 
                                      possible_transports=possible_transports)
3737
 
        except errors.JailBreak:
3738
 
            # We keep the stacking details, but we are in the server code so
3739
 
            # actually stacking is not needed.
3740
 
            return
 
2844
        stacked_dir = BzrDir.open(stack_on)
3741
2845
        try:
3742
2846
            stacked_repo = stacked_dir.open_branch().repository
3743
2847
        except errors.NotBranchError:
3747
2851
        except errors.UnstackableRepositoryFormat:
3748
2852
            if self._require_stacking:
3749
2853
                raise
3750
 
        else:
3751
 
            self._require_stacking = True
3752
2854
 
3753
2855
    def acquire_repository(self, make_working_trees=None, shared=False):
3754
2856
        """Acquire a repository for this bzrdir.
3758
2860
        :param make_working_trees: If creating a repository, set
3759
2861
            make_working_trees to this value (if non-None)
3760
2862
        :param shared: If creating a repository, make it shared if True
3761
 
        :return: A repository, is_new_flag (True if the repository was
3762
 
            created).
 
2863
        :return: A repository
3763
2864
        """
3764
2865
        raise NotImplemented(RepositoryAcquisitionPolicy.acquire_repository)
3765
2866
 
3785
2886
 
3786
2887
        Creates the desired repository in the bzrdir we already have.
3787
2888
        """
3788
 
        stack_on = self._get_full_stack_on()
3789
 
        if stack_on:
3790
 
            format = self._bzrdir._format
3791
 
            format.require_stacking(stack_on=stack_on,
3792
 
                                    possible_transports=[self._bzrdir.root_transport])
3793
 
            if not self._require_stacking:
3794
 
                # We have picked up automatic stacking somewhere.
3795
 
                note('Using default stacking branch %s at %s', self._stack_on,
3796
 
                    self._stack_on_pwd)
3797
 
        repository = self._bzrdir.create_repository(shared=shared)
3798
 
        self._add_fallback(repository,
3799
 
                           possible_transports=[self._bzrdir.transport])
 
2889
        if self._stack_on or self._require_stacking:
 
2890
            # we may be coming from a format that doesn't support stacking,
 
2891
            # but we require it in the destination, so force creation of a new
 
2892
            # one here.
 
2893
            #
 
2894
            # TODO: perhaps this should be treated as a distinct repository
 
2895
            # acquisition policy?
 
2896
            repository_format = self._bzrdir._format.repository_format
 
2897
            if not repository_format.supports_external_lookups:
 
2898
                # should possibly be controlled by the registry rather than
 
2899
                # hardcoded here.
 
2900
                from bzrlib.repofmt import pack_repo
 
2901
                if repository_format.rich_root_data:
 
2902
                    repository_format = \
 
2903
                        pack_repo.RepositoryFormatKnitPack5RichRoot()
 
2904
                else:
 
2905
                    repository_format = pack_repo.RepositoryFormatKnitPack5()
 
2906
                note("using %r for stacking" % (repository_format,))
 
2907
            repository = repository_format.initialize(self._bzrdir,
 
2908
                shared=shared)
 
2909
        else:
 
2910
            # let bzrdir choose
 
2911
            repository = self._bzrdir.create_repository(shared=shared)
 
2912
        self._add_fallback(repository)
3800
2913
        if make_working_trees is not None:
3801
2914
            repository.set_make_working_trees(make_working_trees)
3802
 
        return repository, True
 
2915
        return repository
3803
2916
 
3804
2917
 
3805
2918
class UseExistingRepository(RepositoryAcquisitionPolicy):
3821
2934
    def acquire_repository(self, make_working_trees=None, shared=False):
3822
2935
        """Implementation of RepositoryAcquisitionPolicy.acquire_repository
3823
2936
 
3824
 
        Returns an existing repository to use.
 
2937
        Returns an existing repository to use
3825
2938
        """
3826
 
        self._add_fallback(self._repository,
3827
 
                       possible_transports=[self._repository.bzrdir.transport])
3828
 
        return self._repository, False
3829
 
 
3830
 
 
3831
 
# Please register new formats after old formats so that formats
3832
 
# appear in chronological order and format descriptions can build
3833
 
# on previous ones.
 
2939
        self._add_fallback(self._repository)
 
2940
        return self._repository
 
2941
 
 
2942
 
3834
2943
format_registry = BzrDirFormatRegistry()
3835
 
# The pre-0.8 formats have their repository format network name registered in
3836
 
# repository.py. MetaDir formats have their repository format network name
3837
 
# inferred from their disk format string.
3838
2944
format_registry.register('weave', BzrDirFormat6,
3839
2945
    'Pre-0.8 format.  Slower than knit and does not'
3840
2946
    ' support checkouts or shared repositories.',
3841
 
    hidden=True,
3842
2947
    deprecated=True)
 
2948
format_registry.register_metadir('knit',
 
2949
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
 
2950
    'Format using knits.  Recommended for interoperation with bzr <= 0.14.',
 
2951
    branch_format='bzrlib.branch.BzrBranchFormat5',
 
2952
    tree_format='bzrlib.workingtree.WorkingTreeFormat3')
3843
2953
format_registry.register_metadir('metaweave',
3844
2954
    'bzrlib.repofmt.weaverepo.RepositoryFormat7',
3845
2955
    'Transitional format in 0.8.  Slower than knit.',
3846
2956
    branch_format='bzrlib.branch.BzrBranchFormat5',
3847
2957
    tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3848
 
    hidden=True,
3849
 
    deprecated=True)
3850
 
format_registry.register_metadir('knit',
3851
 
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3852
 
    'Format using knits.  Recommended for interoperation with bzr <= 0.14.',
3853
 
    branch_format='bzrlib.branch.BzrBranchFormat5',
3854
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3855
 
    hidden=True,
3856
2958
    deprecated=True)
3857
2959
format_registry.register_metadir('dirstate',
3858
2960
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3862
2964
    # this uses bzrlib.workingtree.WorkingTreeFormat4 because importing
3863
2965
    # directly from workingtree_4 triggers a circular import.
3864
2966
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3865
 
    hidden=True,
3866
 
    deprecated=True)
 
2967
    )
3867
2968
format_registry.register_metadir('dirstate-tags',
3868
2969
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3869
2970
    help='New in 0.15: Fast local operations and improved scaling for '
3871
2972
        ' Incompatible with bzr < 0.15.',
3872
2973
    branch_format='bzrlib.branch.BzrBranchFormat6',
3873
2974
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3874
 
    hidden=True,
3875
 
    deprecated=True)
 
2975
    )
3876
2976
format_registry.register_metadir('rich-root',
3877
2977
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
3878
2978
    help='New in 1.0.  Better handling of tree roots.  Incompatible with'
3879
 
        ' bzr < 1.0.',
 
2979
        ' bzr < 1.0',
3880
2980
    branch_format='bzrlib.branch.BzrBranchFormat6',
3881
2981
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3882
 
    hidden=True,
3883
 
    deprecated=True)
 
2982
    )
3884
2983
format_registry.register_metadir('dirstate-with-subtree',
3885
2984
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
3886
2985
    help='New in 0.15: Fast local operations and improved scaling for '
3896
2995
    help='New in 0.92: Pack-based format with data compatible with '
3897
2996
        'dirstate-tags format repositories. Interoperates with '
3898
2997
        'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3899
 
        ,
 
2998
        'Previously called knitpack-experimental.  '
 
2999
        'For more information, see '
 
3000
        'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
3900
3001
    branch_format='bzrlib.branch.BzrBranchFormat6',
3901
3002
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3902
3003
    )
3905
3006
    help='New in 0.92: Pack-based format with data compatible with '
3906
3007
        'dirstate-with-subtree format repositories. Interoperates with '
3907
3008
        'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3908
 
        ,
 
3009
        'Previously called knitpack-experimental.  '
 
3010
        'For more information, see '
 
3011
        'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
3909
3012
    branch_format='bzrlib.branch.BzrBranchFormat6',
3910
3013
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3911
3014
    hidden=True,
3913
3016
    )
3914
3017
format_registry.register_metadir('rich-root-pack',
3915
3018
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
3916
 
    help='New in 1.0: A variant of pack-0.92 that supports rich-root data '
3917
 
         '(needed for bzr-svn and bzr-git).',
 
3019
    help='New in 1.0: Pack-based format with data compatible with '
 
3020
        'rich-root format repositories. Incompatible with'
 
3021
        ' bzr < 1.0',
3918
3022
    branch_format='bzrlib.branch.BzrBranchFormat6',
3919
3023
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3920
 
    hidden=True,
3921
3024
    )
3922
3025
format_registry.register_metadir('1.6',
3923
3026
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5',
3924
 
    help='A format that allows a branch to indicate that there is another '
3925
 
         '(stacked) repository that should be used to access data that is '
3926
 
         'not present locally.',
 
3027
    help='A branch and pack based repository that supports stacking. ',
3927
3028
    branch_format='bzrlib.branch.BzrBranchFormat7',
3928
3029
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3929
 
    hidden=True,
3930
3030
    )
3931
 
format_registry.register_metadir('1.6.1-rich-root',
 
3031
format_registry.register_metadir('1.6-rich-root',
3932
3032
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5RichRoot',
3933
 
    help='A variant of 1.6 that supports rich-root data '
3934
 
         '(needed for bzr-svn and bzr-git).',
3935
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3936
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3937
 
    hidden=True,
3938
 
    )
3939
 
format_registry.register_metadir('1.9',
3940
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3941
 
    help='A repository format using B+tree indexes. These indexes '
3942
 
         'are smaller in size, have smarter caching and provide faster '
3943
 
         'performance for most operations.',
3944
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3945
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3946
 
    hidden=True,
3947
 
    )
3948
 
format_registry.register_metadir('1.9-rich-root',
3949
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
3950
 
    help='A variant of 1.9 that supports rich-root data '
3951
 
         '(needed for bzr-svn and bzr-git).',
3952
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3953
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3954
 
    hidden=True,
3955
 
    )
3956
 
format_registry.register_metadir('1.14',
3957
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3958
 
    help='A working-tree format that supports content filtering.',
3959
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3960
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat5',
3961
 
    )
3962
 
format_registry.register_metadir('1.14-rich-root',
3963
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
3964
 
    help='A variant of 1.14 that supports rich-root data '
3965
 
         '(needed for bzr-svn and bzr-git).',
3966
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3967
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat5',
3968
 
    )
3969
 
# The following un-numbered 'development' formats should always just be aliases.
3970
 
format_registry.register_metadir('development-rich-root',
3971
 
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
3972
 
    help='Current development format. Supports rich roots. Can convert data '
3973
 
        'to and from rich-root-pack (and anything compatible with '
3974
 
        'rich-root-pack) format repositories. Repositories and branches in '
3975
 
        'this format can only be read by bzr.dev. Please read '
3976
 
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
 
3033
    help='A branch and pack based repository that supports stacking '
 
3034
         'and rich root data (needed for bzr-svn). ',
 
3035
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
3036
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
3037
    )
 
3038
# The following two formats should always just be aliases.
 
3039
format_registry.register_metadir('development',
 
3040
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment1',
 
3041
    help='Current development format. Can convert data to and from pack-0.92 '
 
3042
        '(and anything compatible with pack-0.92) format repositories. '
 
3043
        'Repositories and branches in this format can only be read by bzr.dev. '
 
3044
        'Please read '
 
3045
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3977
3046
        'before use.',
3978
3047
    branch_format='bzrlib.branch.BzrBranchFormat7',
3979
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
 
3048
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3980
3049
    experimental=True,
3981
3050
    alias=True,
3982
 
    hidden=True,
3983
3051
    )
3984
3052
format_registry.register_metadir('development-subtree',
3985
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment2Subtree',
 
3053
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment1Subtree',
3986
3054
    help='Current development format, subtree variant. Can convert data to and '
3987
3055
        'from pack-0.92-subtree (and anything compatible with '
3988
3056
        'pack-0.92-subtree) format repositories. Repositories and branches in '
3989
3057
        'this format can only be read by bzr.dev. Please read '
3990
 
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
3991
 
        'before use.',
3992
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3993
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3994
 
    experimental=True,
3995
 
    hidden=True,
3996
 
    alias=False, # Restore to being an alias when an actual development subtree format is added
3997
 
                 # This current non-alias status is simply because we did not introduce a
3998
 
                 # chk based subtree format.
3999
 
    )
4000
 
 
4001
 
# And the development formats above will have aliased one of the following:
4002
 
format_registry.register_metadir('development6-rich-root',
4003
 
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
4004
 
    help='pack-1.9 with 255-way hashed CHK inv, group compress, rich roots '
4005
 
        'Please read '
4006
 
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
4007
 
        'before use.',
4008
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
4009
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4010
 
    hidden=True,
4011
 
    experimental=True,
4012
 
    )
4013
 
 
4014
 
format_registry.register_metadir('development7-rich-root',
4015
 
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK2',
4016
 
    help='pack-1.9 with 255-way hashed CHK inv, bencode revision, group compress, '
4017
 
        'rich roots. Please read '
4018
 
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
4019
 
        'before use.',
4020
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
4021
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4022
 
    hidden=True,
4023
 
    experimental=True,
4024
 
    )
4025
 
 
4026
 
format_registry.register_metadir('2a',
4027
 
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
4028
 
    help='First format for bzr 2.0 series.\n'
4029
 
        'Uses group-compress storage.\n'
4030
 
        'Provides rich roots which are a one-way transition.\n',
4031
 
        # 'storage in packs, 255-way hashed CHK inventory, bencode revision, group compress, '
4032
 
        # 'rich roots. Supported by bzr 1.16 and later.',
4033
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
4034
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4035
 
    experimental=True,
4036
 
    )
4037
 
 
4038
 
# The following format should be an alias for the rich root equivalent 
4039
 
# of the default format
4040
 
format_registry.register_metadir('default-rich-root',
4041
 
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
4042
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
4043
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
 
3058
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
 
3059
        'before use.',
 
3060
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
3061
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
3062
    experimental=True,
4044
3063
    alias=True,
4045
 
    hidden=True,
4046
 
    help='Same as 2a.')
4047
 
 
 
3064
    )
 
3065
# And the development formats which the will have aliased one of follow:
 
3066
format_registry.register_metadir('development0',
 
3067
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment0',
 
3068
    help='Trivial rename of pack-0.92 to provide a development format. '
 
3069
        'Please read '
 
3070
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
 
3071
        'before use.',
 
3072
    branch_format='bzrlib.branch.BzrBranchFormat6',
 
3073
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
3074
    hidden=True,
 
3075
    experimental=True,
 
3076
    )
 
3077
format_registry.register_metadir('development0-subtree',
 
3078
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment0Subtree',
 
3079
    help='Trivial rename of pack-0.92-subtree to provide a development format. '
 
3080
        'Please read '
 
3081
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
 
3082
        'before use.',
 
3083
    branch_format='bzrlib.branch.BzrBranchFormat6',
 
3084
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
3085
    hidden=True,
 
3086
    experimental=True,
 
3087
    )
 
3088
format_registry.register_metadir('development1',
 
3089
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment1',
 
3090
    help='A branch and pack based repository that supports stacking. '
 
3091
        'Please read '
 
3092
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
 
3093
        'before use.',
 
3094
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
3095
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
3096
    hidden=True,
 
3097
    experimental=True,
 
3098
    )
 
3099
format_registry.register_metadir('development1-subtree',
 
3100
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment1Subtree',
 
3101
    help='A branch and pack based repository that supports stacking. '
 
3102
        'Please read '
 
3103
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
 
3104
        'before use.',
 
3105
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
3106
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
3107
    hidden=True,
 
3108
    experimental=True,
 
3109
    )
4048
3110
# The current format that is made on 'bzr init'.
4049
 
format_registry.set_default('2a')
 
3111
format_registry.set_default('pack-0.92')