← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/bzrdir.py

  • Committer: Alexander Belchenko
  • Date: 2008-02-27 18:24:39 UTC
  • mto: (3234.2.2 bug.139318)
  • mto: This revision was merged to the branch mainline in revision 3267.
  • Revision ID: bialix@ukr.net-20080227182439-qltsi1rc2amf5kjr
ensure that local_path_to_url() always returns plain string, not unicode.

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 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
 
    config,
43
42
    errors,
44
43
    graph,
45
44
    lockable_files,
46
45
    lockdir,
47
 
    osutils,
 
46
    registry,
48
47
    remote,
49
 
    repository,
50
48
    revision as _mod_revision,
 
49
    symbol_versioning,
51
50
    ui,
52
51
    urlutils,
53
 
    versionedfile,
54
52
    win32utils,
55
53
    workingtree,
56
54
    workingtree_4,
58
56
    xml5,
59
57
    )
60
58
from bzrlib.osutils import (
 
59
    sha_strings,
61
60
    sha_string,
62
61
    )
63
 
from bzrlib.push import (
64
 
    PushResult,
65
 
    )
66
 
from bzrlib.repofmt import pack_repo
67
62
from bzrlib.smart.client import _SmartClient
 
63
from bzrlib.smart import protocol
 
64
from bzrlib.store.revision.text import TextRevisionStore
 
65
from bzrlib.store.text import TextStore
68
66
from bzrlib.store.versioned import WeaveStore
69
67
from bzrlib.transactions import WriteTransaction
70
68
from bzrlib.transport import (
71
69
    do_catching_redirections,
72
70
    get_transport,
73
 
    local,
74
71
    )
75
72
from bzrlib.weave import Weave
76
73
""")
78
75
from bzrlib.trace import (
79
76
    mutter,
80
77
    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):
 
78
    )
 
79
from bzrlib.transport.local import LocalTransport
 
80
from bzrlib.symbol_versioning import (
 
81
    deprecated_function,
 
82
    deprecated_method,
 
83
    zero_ninetyone,
 
84
    )
 
85
 
 
86
 
 
87
class BzrDir(object):
125
88
    """A .bzr control diretory.
126
 
 
 
89
    
127
90
    BzrDir instances let you create or open any of the things that can be
128
91
    found within .bzr - checkouts, branches and repositories.
129
 
 
130
 
    :ivar transport:
 
92
    
 
93
    transport
131
94
        the transport which this bzr dir is rooted at (i.e. file:///.../.bzr/)
132
 
    :ivar root_transport:
 
95
    root_transport
133
96
        a transport connected to the directory this bzr was opened from
134
97
        (i.e. the parent directory holding the .bzr directory).
135
 
 
136
 
    Everything in the bzrdir should have the same file permissions.
137
 
 
138
 
    :cvar hooks: An instance of BzrDirHooks.
139
98
    """
140
99
 
141
100
    def break_lock(self):
163
122
        return True
164
123
 
165
124
    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
125
        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
 
126
        source_repo_format = self._format.repository_format
 
127
        source_repo_format.check_conversion_target(target_repo_format)
176
128
 
177
129
    @staticmethod
178
130
    def _check_supported(format, allow_unsupported,
180
132
        basedir=None):
181
133
        """Give an error or warning on old formats.
182
134
 
183
 
        :param format: may be any kind of format - workingtree, branch,
 
135
        :param format: may be any kind of format - workingtree, branch, 
184
136
        or repository.
185
137
 
186
 
        :param allow_unsupported: If true, allow opening
187
 
        formats that are strongly deprecated, and which may
 
138
        :param allow_unsupported: If true, allow opening 
 
139
        formats that are strongly deprecated, and which may 
188
140
        have limited functionality.
189
141
 
190
142
        :param recommend_upgrade: If true (default), warn
202
154
                format.get_format_description(),
203
155
                basedir)
204
156
 
205
 
    def clone(self, url, revision_id=None, force_new_repo=False,
206
 
              preserve_stacking=False):
 
157
    def clone(self, url, revision_id=None, force_new_repo=False):
207
158
        """Clone this bzrdir and its contents to url verbatim.
208
159
 
209
 
        :param url: The url create the clone at.  If url's last component does
210
 
            not exist, it will be created.
211
 
        :param revision_id: The tip revision-id to use for any branch or
212
 
            working tree.  If not None, then the clone operation may tune
 
160
        If url's last component does not exist, it will be created.
 
161
 
 
162
        if revision_id is not None, then the clone operation may tune
213
163
            itself to download less data.
214
 
        :param force_new_repo: Do not use a shared repository for the target
 
164
        :param force_new_repo: Do not use a shared repository for the target 
215
165
                               even if one is available.
216
 
        :param preserve_stacking: When cloning a stacked branch, stack the
217
 
            new branch on top of the other branch's stacked-on branch.
218
166
        """
219
167
        return self.clone_on_transport(get_transport(url),
220
168
                                       revision_id=revision_id,
221
 
                                       force_new_repo=force_new_repo,
222
 
                                       preserve_stacking=preserve_stacking)
 
169
                                       force_new_repo=force_new_repo)
223
170
 
224
171
    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):
 
172
                           force_new_repo=False):
227
173
        """Clone this bzrdir and its contents to transport verbatim.
228
174
 
229
 
        :param transport: The transport for the location to produce the clone
230
 
            at.  If the target directory does not exist, it will be created.
231
 
        :param revision_id: The tip revision-id to use for any branch or
232
 
            working tree.  If not None, then the clone operation may tune
 
175
        If the target directory does not exist, it will be created.
 
176
 
 
177
        if revision_id is not None, then the clone operation may tune
233
178
            itself to download less data.
234
 
        :param force_new_repo: Do not use a shared repository for the target,
 
179
        :param force_new_repo: Do not use a shared repository for the target 
235
180
                               even if one is available.
236
 
        :param preserve_stacking: When cloning a stacked branch, stack the
237
 
            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
181
        """
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:
 
182
        transport.ensure_base()
 
183
        result = self._format.initialize_on_transport(transport)
251
184
        try:
252
185
            local_repo = self.find_repository()
253
186
        except errors.NoRepositoryPresent:
254
187
            local_repo = None
255
 
        try:
256
 
            local_branch = self.open_branch()
257
 
        except errors.NotBranchError:
258
 
            local_branch = None
259
 
        else:
260
 
            # enable fallbacks when branch is not a branch reference
261
 
            if local_branch.repository.has_same_location(local_repo):
262
 
                local_repo = local_branch.repository
263
 
            if preserve_stacking:
264
 
                try:
265
 
                    stacked_on = local_branch.get_stacked_on_url()
266
 
                except (errors.UnstackableBranchFormat,
267
 
                        errors.UnstackableRepositoryFormat,
268
 
                        errors.NotStacked):
269
 
                    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.
273
188
        if local_repo:
274
 
            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:
 
189
            # may need to copy content in
 
190
            if force_new_repo:
 
191
                result_repo = local_repo.clone(
 
192
                    result,
 
193
                    revision_id=revision_id)
 
194
                result_repo.set_make_working_trees(local_repo.make_working_trees())
 
195
            else:
 
196
                try:
 
197
                    result_repo = result.find_repository()
 
198
                    # fetch content this dir needs.
304
199
                    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)
 
200
                except errors.NoRepositoryPresent:
 
201
                    # needed to make one anyway.
 
202
                    result_repo = local_repo.clone(
 
203
                        result,
 
204
                        revision_id=revision_id)
 
205
                    result_repo.set_make_working_trees(local_repo.make_working_trees())
310
206
        # 1 if there is a branch present
311
207
        #   make sure its content is available in the target repository
312
208
        #   clone it.
313
 
        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():
 
209
        try:
 
210
            self.open_branch().clone(result, revision_id=revision_id)
 
211
        except errors.NotBranchError:
 
212
            pass
 
213
        try:
 
214
            result_repo = result.find_repository()
 
215
        except errors.NoRepositoryPresent:
 
216
            result_repo = None
 
217
        if result_repo is None or result_repo.make_working_trees():
 
218
            try:
321
219
                self.open_workingtree().clone(result)
322
 
        except (errors.NoWorkingTree, errors.NotLocalUrl):
323
 
            pass
 
220
            except (errors.NoWorkingTree, errors.NotLocalUrl):
 
221
                pass
324
222
        return result
325
223
 
326
224
    # TODO: This should be given a Transport, and should chdir up; otherwise
332
230
    @classmethod
333
231
    def create(cls, base, format=None, possible_transports=None):
334
232
        """Create a new BzrDir at the url 'base'.
335
 
 
 
233
        
336
234
        :param format: If supplied, the format of branch to create.  If not
337
235
            supplied, the default is used.
338
 
        :param possible_transports: If supplied, a list of transports that
 
236
        :param possible_transports: If supplied, a list of transports that 
339
237
            can be reused to share a remote connection.
340
238
        """
341
239
        if cls is not BzrDir:
388
286
                for subdir in sorted(subdirs, reverse=True):
389
287
                    pending.append(current_transport.clone(subdir))
390
288
 
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
289
    @staticmethod
401
290
    def find_branches(transport):
402
291
        """Find all branches under a transport.
414
303
            except errors.NoRepositoryPresent:
415
304
                pass
416
305
            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):
 
306
                return False, (None, repository)
 
307
            try:
 
308
                branch = bzrdir.open_branch()
 
309
            except errors.NotBranchError:
 
310
                return True, (None, None)
 
311
            else:
 
312
                return True, (branch, None)
 
313
        branches = []
 
314
        for branch, repo in BzrDir.find_bzrdirs(transport, evaluate=evaluate):
422
315
            if repo is not None:
423
 
                ret.extend(repo.find_branches())
424
 
            if branches is not None:
425
 
                ret.extend(branches)
426
 
        return ret
 
316
                branches.extend(repo.find_branches())
 
317
            if branch is not None:
 
318
                branches.append(branch)
 
319
        return branches
 
320
 
427
321
 
428
322
    def destroy_repository(self):
429
323
        """Destroy the repository in this BzrDir"""
430
324
        raise NotImplementedError(self.destroy_repository)
431
325
 
432
 
    def create_branch(self, name=None):
 
326
    def create_branch(self):
433
327
        """Create a branch in this BzrDir.
434
328
 
435
 
        :param name: Name of the colocated branch to create, None for
436
 
            the default branch.
437
 
 
438
329
        The bzrdir's format will control what branch format is created.
439
330
        For more control see BranchFormatXX.create(a_bzrdir).
440
331
        """
441
332
        raise NotImplementedError(self.create_branch)
442
333
 
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
 
        """
 
334
    def destroy_branch(self):
 
335
        """Destroy the branch in this BzrDir"""
449
336
        raise NotImplementedError(self.destroy_branch)
450
337
 
451
338
    @staticmethod
453
340
        """Create a new BzrDir, Branch and Repository at the url 'base'.
454
341
 
455
342
        This will use the current default BzrDirFormat unless one is
456
 
        specified, and use whatever
 
343
        specified, and use whatever 
457
344
        repository format that that uses via bzrdir.create_branch and
458
345
        create_repository. If a shared repository is available that is used
459
346
        preferentially.
469
356
        bzrdir._find_or_create_repository(force_new_repo)
470
357
        return bzrdir.create_branch()
471
358
 
472
 
    def determine_repository_policy(self, force_new_repo=False, stack_on=None,
473
 
                                    stack_on_pwd=None, require_stacking=False):
474
 
        """Return an object representing a policy to use.
475
 
 
476
 
        This controls whether a new repository is created, and the format of
477
 
        that repository, or some existing shared repository used instead.
478
 
 
479
 
        If stack_on is supplied, will not seek a containing shared repo.
480
 
 
481
 
        :param force_new_repo: If True, require a new repository to be created.
482
 
        :param stack_on: If supplied, the location to stack on.  If not
483
 
            supplied, a default_stack_on location may be used.
484
 
        :param stack_on_pwd: If stack_on is relative, the location it is
485
 
            relative to.
486
 
        """
487
 
        def repository_policy(found_bzrdir):
488
 
            stack_on = None
489
 
            stack_on_pwd = None
490
 
            config = found_bzrdir.get_config()
491
 
            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
496
 
            # does it have a repository ?
497
 
            try:
498
 
                repository = found_bzrdir.open_repository()
499
 
            except errors.NoRepositoryPresent:
500
 
                repository = None
501
 
            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.
505
 
                    repository = None
506
 
                    stop = True
507
 
                else:
508
 
                    stop = True
509
 
            if not stop:
510
 
                return None, False
511
 
            if repository:
512
 
                return UseExistingRepository(repository, stack_on,
513
 
                    stack_on_pwd, require_stacking=require_stacking), True
514
 
            else:
515
 
                return CreateRepository(self, stack_on, stack_on_pwd,
516
 
                    require_stacking=require_stacking), True
517
 
 
518
 
        if not force_new_repo:
519
 
            if stack_on is None:
520
 
                policy = self._find_containing(repository_policy)
521
 
                if policy is not None:
522
 
                    return policy
523
 
            else:
524
 
                try:
525
 
                    return UseExistingRepository(self.open_repository(),
526
 
                        stack_on, stack_on_pwd,
527
 
                        require_stacking=require_stacking)
528
 
                except errors.NoRepositoryPresent:
529
 
                    pass
530
 
        return CreateRepository(self, stack_on, stack_on_pwd,
531
 
                                require_stacking=require_stacking)
532
 
 
533
359
    def _find_or_create_repository(self, force_new_repo):
534
360
        """Create a new repository if needed, returning the repository."""
535
 
        policy = self.determine_repository_policy(force_new_repo)
536
 
        return policy.acquire_repository()[0]
537
 
 
 
361
        if force_new_repo:
 
362
            return self.create_repository()
 
363
        try:
 
364
            return self.find_repository()
 
365
        except errors.NoRepositoryPresent:
 
366
            return self.create_repository()
 
367
        
538
368
    @staticmethod
539
369
    def create_branch_convenience(base, force_new_repo=False,
540
370
                                  force_new_tree=None, format=None,
546
376
        not.
547
377
 
548
378
        This will use the current default BzrDirFormat unless one is
549
 
        specified, and use whatever
 
379
        specified, and use whatever 
550
380
        repository format that that uses via bzrdir.create_branch and
551
381
        create_repository. If a shared repository is available that is used
552
382
        preferentially. Whatever repository is used, its tree creation policy
554
384
 
555
385
        The created Branch object is returned.
556
386
        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
 
387
        no error is raised unless force_new_tree is True, in which case no 
558
388
        data is created on disk and NotLocalUrl is raised.
559
389
 
560
390
        :param base: The URL to create the branch at.
561
391
        :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
 
392
        :param force_new_tree: If True or False force creation of a tree or 
563
393
                               prevent such creation respectively.
564
394
        :param format: Override for the bzrdir format to create.
565
395
        :param possible_transports: An optional reusable transports list.
567
397
        if force_new_tree:
568
398
            # check for non local urls
569
399
            t = get_transport(base, possible_transports)
570
 
            if not isinstance(t, local.LocalTransport):
 
400
            if not isinstance(t, LocalTransport):
571
401
                raise errors.NotLocalUrl(base)
572
402
        bzrdir = BzrDir.create(base, format, possible_transports)
573
403
        repo = bzrdir._find_or_create_repository(force_new_repo)
581
411
        return result
582
412
 
583
413
    @staticmethod
 
414
    @deprecated_function(zero_ninetyone)
 
415
    def create_repository(base, shared=False, format=None):
 
416
        """Create a new BzrDir and Repository at the url 'base'.
 
417
 
 
418
        If no format is supplied, this will default to the current default
 
419
        BzrDirFormat by default, and use whatever repository format that that
 
420
        uses for bzrdirformat.create_repository.
 
421
 
 
422
        :param shared: Create a shared repository rather than a standalone
 
423
                       repository.
 
424
        The Repository object is returned.
 
425
 
 
426
        This must be overridden as an instance method in child classes, where
 
427
        it should take no parameters and construct whatever repository format
 
428
        that child class desires.
 
429
 
 
430
        This method is deprecated, please call create_repository on a bzrdir
 
431
        instance instead.
 
432
        """
 
433
        bzrdir = BzrDir.create(base, format)
 
434
        return bzrdir.create_repository(shared)
 
435
 
 
436
    @staticmethod
584
437
    def create_standalone_workingtree(base, format=None):
585
438
        """Create a new BzrDir, WorkingTree, Branch and Repository at 'base'.
586
439
 
587
440
        'base' must be a local path or a file:// url.
588
441
 
589
442
        This will use the current default BzrDirFormat unless one is
590
 
        specified, and use whatever
 
443
        specified, and use whatever 
591
444
        repository format that that uses for bzrdirformat.create_workingtree,
592
445
        create_branch and create_repository.
593
446
 
595
448
        :return: The WorkingTree object.
596
449
        """
597
450
        t = get_transport(base)
598
 
        if not isinstance(t, local.LocalTransport):
 
451
        if not isinstance(t, LocalTransport):
599
452
            raise errors.NotLocalUrl(base)
600
453
        bzrdir = BzrDir.create_branch_and_repo(base,
601
454
                                               force_new_repo=True,
603
456
        return bzrdir.create_workingtree()
604
457
 
605
458
    def create_workingtree(self, revision_id=None, from_branch=None,
606
 
        accelerator_tree=None, hardlink=False):
 
459
        accelerator_tree=None):
607
460
        """Create a working tree at this BzrDir.
608
 
 
 
461
        
609
462
        :param revision_id: create it as of this revision id.
610
463
        :param from_branch: override bzrdir branch (for lightweight checkouts)
611
464
        :param accelerator_tree: A tree which can be used for retrieving file
615
468
        """
616
469
        raise NotImplementedError(self.create_workingtree)
617
470
 
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
471
    def retire_bzrdir(self, limit=10000):
647
472
        """Permanently disable the bzrdir.
648
473
 
683
508
        """
684
509
        raise NotImplementedError(self.destroy_workingtree_metadata)
685
510
 
686
 
    def _find_containing(self, evaluate):
687
 
        """Find something in a containing control directory.
688
 
 
689
 
        This method will scan containing control dirs, until it finds what
690
 
        it is looking for, decides that it will never find it, or runs out
691
 
        of containing control directories to check.
692
 
 
693
 
        It is used to implement find_repository and
694
 
        determine_repository_policy.
695
 
 
696
 
        :param evaluate: A function returning (value, stop).  If stop is True,
697
 
            the value will be returned.
698
 
        """
699
 
        found_bzrdir = self
700
 
        while True:
701
 
            result, stop = evaluate(found_bzrdir)
702
 
            if stop:
703
 
                return result
704
 
            next_transport = found_bzrdir.root_transport.clone('..')
705
 
            if (found_bzrdir.user_url == next_transport.base):
706
 
                # top of the file system
707
 
                return None
708
 
            # find the next containing bzrdir
709
 
            try:
710
 
                found_bzrdir = BzrDir.open_containing_from_transport(
711
 
                    next_transport)[0]
712
 
            except errors.NotBranchError:
713
 
                return None
714
 
 
715
511
    def find_repository(self):
716
512
        """Find the repository that should be used.
717
513
 
719
515
        new branches as well as to hook existing branches up to their
720
516
        repository.
721
517
        """
722
 
        def usable_repository(found_bzrdir):
 
518
        try:
 
519
            return self.open_repository()
 
520
        except errors.NoRepositoryPresent:
 
521
            pass
 
522
        next_transport = self.root_transport.clone('..')
 
523
        while True:
 
524
            # find the next containing bzrdir
 
525
            try:
 
526
                found_bzrdir = BzrDir.open_containing_from_transport(
 
527
                    next_transport)[0]
 
528
            except errors.NotBranchError:
 
529
                # none found
 
530
                raise errors.NoRepositoryPresent(self)
723
531
            # does it have a repository ?
724
532
            try:
725
533
                repository = found_bzrdir.open_repository()
726
534
            except errors.NoRepositoryPresent:
727
 
                return None, False
728
 
            if found_bzrdir.user_url == self.user_url:
729
 
                return repository, True
730
 
            elif repository.is_shared():
731
 
                return repository, True
 
535
                next_transport = found_bzrdir.root_transport.clone('..')
 
536
                if (found_bzrdir.root_transport.base == next_transport.base):
 
537
                    # top of the file system
 
538
                    break
 
539
                else:
 
540
                    continue
 
541
            if ((found_bzrdir.root_transport.base ==
 
542
                 self.root_transport.base) or repository.is_shared()):
 
543
                return repository
732
544
            else:
733
 
                return None, True
734
 
 
735
 
        found_repo = self._find_containing(usable_repository)
736
 
        if found_repo is None:
737
 
            raise errors.NoRepositoryPresent(self)
738
 
        return found_repo
 
545
                raise errors.NoRepositoryPresent(self)
 
546
        raise errors.NoRepositoryPresent(self)
739
547
 
740
548
    def get_branch_reference(self):
741
549
        """Return the referenced URL for the branch in this bzrdir.
746
554
        """
747
555
        return None
748
556
 
749
 
    def get_branch_transport(self, branch_format, name=None):
 
557
    def get_branch_transport(self, branch_format):
750
558
        """Get the transport for use by branch format in this BzrDir.
751
559
 
752
560
        Note that bzr dirs that do not support format strings will raise
753
561
        IncompatibleFormat if the branch format they are given has
754
562
        a format string, and vice versa.
755
563
 
756
 
        If branch_format is None, the transport is returned with no
 
564
        If branch_format is None, the transport is returned with no 
757
565
        checking. If it is not None, then the returned transport is
758
566
        guaranteed to point to an existing directory ready for use.
759
567
        """
760
568
        raise NotImplementedError(self.get_branch_transport)
761
 
 
762
 
    def _find_creation_modes(self):
763
 
        """Determine the appropriate modes for files and directories.
764
 
 
765
 
        They're always set to be consistent with the base directory,
766
 
        assuming that this transport allows setting modes.
767
 
        """
768
 
        # TODO: Do we need or want an option (maybe a config setting) to turn
769
 
        # this off or override it for particular locations? -- mbp 20080512
770
 
        if self._mode_check_done:
771
 
            return
772
 
        self._mode_check_done = True
773
 
        try:
774
 
            st = self.transport.stat('.')
775
 
        except errors.TransportNotPossible:
776
 
            self._dir_mode = None
777
 
            self._file_mode = None
778
 
        else:
779
 
            # Check the directory mode, but also make sure the created
780
 
            # directories and files are read-write for this user. This is
781
 
            # mostly a workaround for filesystems which lie about being able to
782
 
            # 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
791
 
 
792
 
    def _get_file_mode(self):
793
 
        """Return Unix mode for newly created files, or None.
794
 
        """
795
 
        if not self._mode_check_done:
796
 
            self._find_creation_modes()
797
 
        return self._file_mode
798
 
 
799
 
    def _get_dir_mode(self):
800
 
        """Return Unix mode for newly created directories, or None.
801
 
        """
802
 
        if not self._mode_check_done:
803
 
            self._find_creation_modes()
804
 
        return self._dir_mode
805
 
 
 
569
        
806
570
    def get_repository_transport(self, repository_format):
807
571
        """Get the transport for use by repository format in this BzrDir.
808
572
 
810
574
        IncompatibleFormat if the repository format they are given has
811
575
        a format string, and vice versa.
812
576
 
813
 
        If repository_format is None, the transport is returned with no
 
577
        If repository_format is None, the transport is returned with no 
814
578
        checking. If it is not None, then the returned transport is
815
579
        guaranteed to point to an existing directory ready for use.
816
580
        """
817
581
        raise NotImplementedError(self.get_repository_transport)
818
 
 
 
582
        
819
583
    def get_workingtree_transport(self, tree_format):
820
584
        """Get the transport for use by workingtree format in this BzrDir.
821
585
 
823
587
        IncompatibleFormat if the workingtree format they are given has a
824
588
        format string, and vice versa.
825
589
 
826
 
        If workingtree_format is None, the transport is returned with no
 
590
        If workingtree_format is None, the transport is returned with no 
827
591
        checking. If it is not None, then the returned transport is
828
592
        guaranteed to point to an existing directory ready for use.
829
593
        """
830
594
        raise NotImplementedError(self.get_workingtree_transport)
831
 
 
832
 
    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
839
 
 
 
595
        
840
596
    def __init__(self, _transport, _format):
841
597
        """Initialize a Bzr control dir object.
842
 
 
 
598
        
843
599
        Only really common logic should reside here, concrete classes should be
844
600
        made with varying behaviours.
845
601
 
847
603
        :param _transport: the transport this dir is based at.
848
604
        """
849
605
        self._format = _format
850
 
        # these are also under the more standard names of 
851
 
        # control_transport and user_transport
852
606
        self.transport = _transport.clone('.bzr')
853
607
        self.root_transport = _transport
854
 
        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
608
 
864
609
    def is_control_filename(self, filename):
865
610
        """True if filename is the name of a path which is reserved for bzrdir's.
866
 
 
 
611
        
867
612
        :param filename: A filename within the root transport of this bzrdir.
868
613
 
869
614
        This is true IF and ONLY IF the filename is part of the namespace reserved
872
617
        this in the future - for instance to make bzr talk with svn working
873
618
        trees.
874
619
        """
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-
 
620
        # this might be better on the BzrDirFormat class because it refers to 
 
621
        # all the possible bzrdir disk formats. 
 
622
        # This method is tested via the workingtree is_control_filename tests- 
878
623
        # it was extracted from WorkingTree.is_control_filename. If the method's
879
624
        # contract is extended beyond the current trivial implementation, please
880
625
        # add new tests for it to the appropriate place.
882
627
 
883
628
    def needs_format_conversion(self, format=None):
884
629
        """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
 
630
        
 
631
        For instance, if the repository format is out of date but the 
887
632
        branch and working tree are not, this should return True.
888
633
 
889
634
        :param format: Optional parameter indicating a specific desired
895
640
    def open_unsupported(base):
896
641
        """Open a branch which is not supported."""
897
642
        return BzrDir.open(base, _unsupported=True)
898
 
 
 
643
        
899
644
    @staticmethod
900
645
    def open(base, _unsupported=False, possible_transports=None):
901
646
        """Open an existing bzrdir, rooted at 'base' (url).
902
 
 
 
647
        
903
648
        :param _unsupported: a private parameter to the BzrDir class.
904
649
        """
905
650
        t = get_transport(base, possible_transports=possible_transports)
913
658
        :param transport: Transport containing the bzrdir.
914
659
        :param _unsupported: private.
915
660
        """
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
661
        base = transport.base
 
662
 
921
663
        def find_format(transport):
922
664
            return transport, BzrDirFormat.find_format(
923
665
                transport, _server_formats=_server_formats)
924
666
 
925
667
        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)
 
668
            qualified_source = e.get_source_url()
 
669
            relpath = transport.relpath(qualified_source)
 
670
            if not e.target.endswith(relpath):
 
671
                # Not redirected to a branch-format, not a branch
 
672
                raise errors.NotBranchError(path=e.target)
 
673
            target = e.target[:-len(relpath)]
929
674
            note('%s is%s redirected to %s',
930
 
                 transport.base, e.permanently, redirected_transport.base)
931
 
            return redirected_transport
 
675
                 transport.base, e.permanently, target)
 
676
            # Let's try with a new transport
 
677
            # FIXME: If 'transport' has a qualifier, this should
 
678
            # be applied again to the new transport *iff* the
 
679
            # schemes used are the same. Uncomment this code
 
680
            # once the function (and tests) exist.
 
681
            # -- vila20070212
 
682
            #target = urlutils.copy_url_qualifiers(original, target)
 
683
            return get_transport(target)
932
684
 
933
685
        try:
934
686
            transport, format = do_catching_redirections(find_format,
940
692
        BzrDir._check_supported(format, _unsupported)
941
693
        return format.open(transport, _found=True)
942
694
 
943
 
    def open_branch(self, name=None, unsupported=False,
944
 
                    ignore_fallbacks=False):
 
695
    def open_branch(self, unsupported=False):
945
696
        """Open the branch object at this BzrDir if one is present.
946
697
 
947
698
        If unsupported is True, then no longer supported branch formats can
948
699
        still be opened.
949
 
 
 
700
        
950
701
        TODO: static convenience version of this?
951
702
        """
952
703
        raise NotImplementedError(self.open_branch)
954
705
    @staticmethod
955
706
    def open_containing(url, possible_transports=None):
956
707
        """Open an existing branch which contains url.
957
 
 
 
708
        
958
709
        :param url: url to search from.
959
710
        See open_containing_from_transport for more detail.
960
711
        """
961
712
        transport = get_transport(url, possible_transports)
962
713
        return BzrDir.open_containing_from_transport(transport)
963
 
 
 
714
    
964
715
    @staticmethod
965
716
    def open_containing_from_transport(a_transport):
966
717
        """Open an existing branch which contains a_transport.base.
969
720
 
970
721
        Basically we keep looking up until we find the control directory or
971
722
        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
 
723
        If there is one and it is either an unrecognised format or an unsupported 
973
724
        format, UnknownFormatError or UnsupportedFormatError are raised.
974
725
        If there is one, it is returned, along with the unused portion of url.
975
726
 
976
 
        :return: The BzrDir that contains the path, and a Unicode path
 
727
        :return: The BzrDir that contains the path, and a Unicode path 
977
728
                for the rest of the URL.
978
729
        """
979
730
        # this gets the normalised url back. I.e. '.' -> the full path.
1036
787
        tree, branch = bzrdir._get_tree_branch()
1037
788
        return tree, branch, relpath
1038
789
 
1039
 
    @classmethod
1040
 
    def open_containing_tree_branch_or_repository(klass, location):
1041
 
        """Return the working tree, branch and repo contained by a location.
1042
 
 
1043
 
        Returns (tree, branch, repository, relpath).
1044
 
        If there is no tree containing the location, tree will be None.
1045
 
        If there is no branch containing the location, branch will be None.
1046
 
        If there is no repository containing the location, repository will be
1047
 
        None.
1048
 
        relpath is the portion of the path that is contained by the innermost
1049
 
        BzrDir.
1050
 
 
1051
 
        If no tree, branch or repository is found, a NotBranchError is raised.
1052
 
        """
1053
 
        bzrdir, relpath = klass.open_containing(location)
1054
 
        try:
1055
 
            tree, branch = bzrdir._get_tree_branch()
1056
 
        except errors.NotBranchError:
1057
 
            try:
1058
 
                repo = bzrdir.find_repository()
1059
 
                return None, None, repo, relpath
1060
 
            except (errors.NoRepositoryPresent):
1061
 
                raise errors.NotBranchError(location)
1062
 
        return tree, branch, branch.repository, relpath
1063
 
 
1064
790
    def open_repository(self, _unsupported=False):
1065
791
        """Open the repository object at this BzrDir if one is present.
1066
792
 
1085
811
        """
1086
812
        raise NotImplementedError(self.open_workingtree)
1087
813
 
1088
 
    def has_branch(self, name=None):
 
814
    def has_branch(self):
1089
815
        """Tell if this bzrdir contains a branch.
1090
 
 
 
816
        
1091
817
        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.)
 
818
        and try, and not ask permission first.  (This method just opens the 
 
819
        branch and discards it, and that's somewhat expensive.) 
1094
820
        """
1095
821
        try:
1096
 
            self.open_branch(name)
 
822
            self.open_branch()
1097
823
            return True
1098
824
        except errors.NotBranchError:
1099
825
            return False
1103
829
 
1104
830
        This will still raise an exception if the bzrdir has a workingtree that
1105
831
        is remote & inaccessible.
1106
 
 
 
832
        
1107
833
        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.)
 
834
        and try, and not ask permission first.  (This method just opens the 
 
835
        workingtree and discards it, and that's somewhat expensive.) 
1110
836
        """
1111
837
        try:
1112
838
            self.open_workingtree(recommend_upgrade=False)
1115
841
            return False
1116
842
 
1117
843
    def _cloning_metadir(self):
1118
 
        """Produce a metadir suitable for cloning with.
1119
 
 
1120
 
        :returns: (destination_bzrdir_format, source_repository)
1121
 
        """
 
844
        """Produce a metadir suitable for cloning with."""
1122
845
        result_format = self._format.__class__()
1123
846
        try:
1124
847
            try:
1125
 
                branch = self.open_branch(ignore_fallbacks=True)
 
848
                branch = self.open_branch()
1126
849
                source_repository = branch.repository
1127
 
                result_format._branch_format = branch._format
1128
850
            except errors.NotBranchError:
1129
851
                source_branch = None
1130
852
                source_repository = self.open_repository()
1135
857
            # the fix recommended in bug # 103195 - to delegate this choice the
1136
858
            # repository itself.
1137
859
            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
 
860
            if not isinstance(repo_format, remote.RemoteRepositoryFormat):
 
861
                result_format.repository_format = repo_format
1142
862
        try:
1143
863
            # TODO: Couldn't we just probe for the format in these cases,
1144
864
            # rather than opening the whole tree?  It would be a little
1150
870
            result_format.workingtree_format = tree._format.__class__()
1151
871
        return result_format, source_repository
1152
872
 
1153
 
    def cloning_metadir(self, require_stacking=False):
 
873
    def cloning_metadir(self):
1154
874
        """Produce a metadir suitable for cloning or sprouting with.
1155
875
 
1156
876
        These operations may produce workingtrees (yes, even though they're
1157
877
        "cloning" something that doesn't have a tree), so a viable workingtree
1158
878
        format must be selected.
1159
 
 
1160
 
        :require_stacking: If True, non-stackable formats will be upgraded
1161
 
            to similar stackable formats.
1162
 
        :returns: a BzrDirFormat with all component formats either set
1163
 
            appropriately or set to None if that component should not be
1164
 
            created.
1165
879
        """
1166
880
        format, repository = self._cloning_metadir()
1167
881
        if format._workingtree_format is None:
1168
 
            # No tree in self.
1169
882
            if repository is None:
1170
 
                # No repository either
1171
883
                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
884
            tree_format = repository._format._matchingbzrdir.workingtree_format
1175
885
            format.workingtree_format = tree_format.__class__()
1176
 
        if require_stacking:
1177
 
            format.require_stacking()
1178
886
        return format
1179
887
 
1180
888
    def checkout_metadir(self):
1182
890
 
1183
891
    def sprout(self, url, revision_id=None, force_new_repo=False,
1184
892
               recurse='down', possible_transports=None,
1185
 
               accelerator_tree=None, hardlink=False, stacked=False,
1186
 
               source_branch=None, create_tree_if_local=True):
 
893
               accelerator_tree=None):
1187
894
        """Create a copy of this bzrdir prepared for use as a new line of
1188
895
        development.
1189
896
 
1200
907
            contents more quickly than the revision tree, i.e. a workingtree.
1201
908
            The revision tree will be used for cases where accelerator_tree's
1202
909
            content is different.
1203
 
        :param hardlink: If true, hard-link files from accelerator_tree,
1204
 
            where possible.
1205
 
        :param stacked: If true, create a stacked branch referring to the
1206
 
            location of this control directory.
1207
 
        :param create_tree_if_local: If true, a working-tree will be created
1208
 
            when working locally.
1209
910
        """
1210
911
        target_transport = get_transport(url, possible_transports)
1211
912
        target_transport.ensure_base()
1212
 
        cloning_format = self.cloning_metadir(stacked)
1213
 
        # Create/update the result branch
 
913
        cloning_format = self.cloning_metadir()
1214
914
        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:
1219
 
            if stacked:
1220
 
                stacked_branch_url = self.root_transport.base
 
915
        try:
 
916
            source_branch = self.open_branch()
1221
917
            source_repository = source_branch.repository
1222
 
        else:
1223
 
            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
1234
 
        repository_policy = result.determine_repository_policy(
1235
 
            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
1242
 
        if source_repository is not None:
1243
 
            # Fetch while stacked to prevent unstacked fetch from
1244
 
            # Branch.sprout.
1245
 
            if fetch_spec is None:
 
918
        except errors.NotBranchError:
 
919
            source_branch = None
 
920
            try:
 
921
                source_repository = self.open_repository()
 
922
            except errors.NoRepositoryPresent:
 
923
                source_repository = None
 
924
        if force_new_repo:
 
925
            result_repo = None
 
926
        else:
 
927
            try:
 
928
                result_repo = result.find_repository()
 
929
            except errors.NoRepositoryPresent:
 
930
                result_repo = None
 
931
        if source_repository is None and result_repo is not None:
 
932
            pass
 
933
        elif source_repository is None and result_repo is None:
 
934
            # no repo available, make a new one
 
935
            result.create_repository()
 
936
        elif source_repository is not None and result_repo is None:
 
937
            # have source, and want to make a new target repo
 
938
            result_repo = source_repository.sprout(result,
 
939
                                                   revision_id=revision_id)
 
940
        else:
 
941
            # fetch needed content into target.
 
942
            if source_repository is not None:
 
943
                # would rather do 
 
944
                # source_repository.copy_content_into(result_repo,
 
945
                #                                     revision_id=revision_id)
 
946
                # so we can override the copy method
1246
947
                result_repo.fetch(source_repository, revision_id=revision_id)
1247
 
            else:
1248
 
                result_repo.fetch(source_repository, fetch_spec=fetch_spec)
1249
 
 
1250
 
        if source_branch is None:
1251
 
            # this is for sprouting a bzrdir without a branch; is that
1252
 
            # actually useful?
1253
 
            # Not especially, but it's part of the contract.
1254
 
            result_branch = result.create_branch()
 
948
        if source_branch is not None:
 
949
            source_branch.sprout(result, revision_id=revision_id)
1255
950
        else:
1256
 
            result_branch = source_branch.sprout(result,
1257
 
                revision_id=revision_id, repository_policy=repository_policy)
1258
 
        mutter("created new branch %r" % (result_branch,))
1259
 
 
1260
 
        # 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())):
1264
 
            wt = result.create_workingtree(accelerator_tree=accelerator_tree,
1265
 
                hardlink=hardlink)
 
951
            result.create_branch()
 
952
        if isinstance(target_transport, LocalTransport) and (
 
953
            result_repo is None or result_repo.make_working_trees()):
 
954
            wt = result.create_workingtree(accelerator_tree=accelerator_tree)
1266
955
            wt.lock_write()
1267
956
            try:
1268
957
                if wt.path2id('') is None:
1279
968
                basis = wt.basis_tree()
1280
969
                basis.lock_read()
1281
970
                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()
 
971
                recurse_branch = wt.branch
1286
972
            elif source_branch is not None:
1287
973
                basis = source_branch.basis_tree()
1288
974
                basis.lock_read()
1289
975
                subtrees = basis.iter_references()
 
976
                recurse_branch = source_branch
1290
977
            else:
1291
978
                subtrees = []
1292
979
                basis = None
1296
983
                    sublocation = source_branch.reference_parent(file_id, path)
1297
984
                    sublocation.bzrdir.sprout(target,
1298
985
                        basis.get_reference_revision(file_id, path),
1299
 
                        force_new_repo=force_new_repo, recurse=recurse,
1300
 
                        stacked=stacked)
 
986
                        force_new_repo=force_new_repo, recurse=recurse)
1301
987
            finally:
1302
988
                if basis is not None:
1303
989
                    basis.unlock()
1304
990
        return result
1305
991
 
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
992
 
1422
993
class BzrDirPreSplitOut(BzrDir):
1423
994
    """A common class for the all-in-one formats."""
1425
996
    def __init__(self, _transport, _format):
1426
997
        """See BzrDir.__init__."""
1427
998
        super(BzrDirPreSplitOut, self).__init__(_transport, _format)
 
999
        assert self._format._lock_class == lockable_files.TransportLock
 
1000
        assert self._format._lock_file_name == 'branch-lock'
1428
1001
        self._control_files = lockable_files.LockableFiles(
1429
1002
                                            self.get_branch_transport(None),
1430
1003
                                            self._format._lock_file_name,
1434
1007
        """Pre-splitout bzrdirs do not suffer from stale locks."""
1435
1008
        raise NotImplementedError(self.break_lock)
1436
1009
 
1437
 
    def cloning_metadir(self, require_stacking=False):
1438
 
        """Produce a metadir suitable for cloning with."""
1439
 
        if require_stacking:
1440
 
            return format_registry.make_bzrdir('1.6')
1441
 
        return self._format.__class__()
1442
 
 
1443
 
    def clone(self, url, revision_id=None, force_new_repo=False,
1444
 
              preserve_stacking=False):
1445
 
        """See BzrDir.clone().
1446
 
 
1447
 
        force_new_repo has no effect, since this family of formats always
1448
 
        require a new repository.
1449
 
        preserve_stacking has no effect, since no source branch using this
1450
 
        family of formats can be stacked, so there is no stacking to preserve.
1451
 
        """
 
1010
    def clone(self, url, revision_id=None, force_new_repo=False):
 
1011
        """See BzrDir.clone()."""
 
1012
        from bzrlib.workingtree import WorkingTreeFormat2
1452
1013
        self._make_tail(url)
1453
1014
        result = self._format._initialize_for_clone(url)
1454
1015
        self.open_repository().clone(result, revision_id=revision_id)
1455
1016
        from_branch = self.open_branch()
1456
1017
        from_branch.clone(result, revision_id=revision_id)
1457
1018
        try:
1458
 
            tree = self.open_workingtree()
 
1019
            self.open_workingtree().clone(result)
1459
1020
        except errors.NotLocalUrl:
1460
1021
            # make a new one, this format always has to have one.
1461
 
            result._init_workingtree()
1462
 
        else:
1463
 
            tree.clone(result)
 
1022
            try:
 
1023
                WorkingTreeFormat2().initialize(result)
 
1024
            except errors.NotLocalUrl:
 
1025
                # but we cannot do it for remote trees.
 
1026
                to_branch = result.open_branch()
 
1027
                WorkingTreeFormat2().stub_initialize_remote(to_branch.control_files)
1464
1028
        return result
1465
1029
 
1466
 
    def create_branch(self, name=None):
 
1030
    def create_branch(self):
1467
1031
        """See BzrDir.create_branch."""
1468
 
        return self._format.get_branch_format().initialize(self, name=name)
 
1032
        return self.open_branch()
1469
1033
 
1470
 
    def destroy_branch(self, name=None):
 
1034
    def destroy_branch(self):
1471
1035
        """See BzrDir.destroy_branch."""
1472
1036
        raise errors.UnsupportedOperation(self.destroy_branch, self)
1473
1037
 
1482
1046
        raise errors.UnsupportedOperation(self.destroy_repository, self)
1483
1047
 
1484
1048
    def create_workingtree(self, revision_id=None, from_branch=None,
1485
 
                           accelerator_tree=None, hardlink=False):
 
1049
                           accelerator_tree=None):
1486
1050
        """See BzrDir.create_workingtree."""
1487
 
        # The workingtree is sometimes created when the bzrdir is created,
1488
 
        # but not when cloning.
1489
 
 
1490
1051
        # this looks buggy but is not -really-
1491
1052
        # because this format creates the workingtree when the bzrdir is
1492
1053
        # created
1494
1055
        # and that will have set it for us, its only
1495
1056
        # specific uses of create_workingtree in isolation
1496
1057
        # that can do wonky stuff here, and that only
1497
 
        # happens for creating checkouts, which cannot be
 
1058
        # happens for creating checkouts, which cannot be 
1498
1059
        # 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()
 
1060
        result = self.open_workingtree(recommend_upgrade=False)
1506
1061
        if revision_id is not None:
1507
1062
            if revision_id == _mod_revision.NULL_REVISION:
1508
1063
                result.set_parent_ids([])
1510
1065
                result.set_parent_ids([revision_id])
1511
1066
        return result
1512
1067
 
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
1068
    def destroy_workingtree(self):
1524
1069
        """See BzrDir.destroy_workingtree."""
1525
1070
        raise errors.UnsupportedOperation(self.destroy_workingtree, self)
1526
1071
 
1527
1072
    def destroy_workingtree_metadata(self):
1528
1073
        """See BzrDir.destroy_workingtree_metadata."""
1529
 
        raise errors.UnsupportedOperation(self.destroy_workingtree_metadata,
 
1074
        raise errors.UnsupportedOperation(self.destroy_workingtree_metadata, 
1530
1075
                                          self)
1531
1076
 
1532
 
    def get_branch_transport(self, branch_format, name=None):
 
1077
    def get_branch_transport(self, branch_format):
1533
1078
        """See BzrDir.get_branch_transport()."""
1534
 
        if name is not None:
1535
 
            raise errors.NoColocatedBranchSupport(self)
1536
1079
        if branch_format is None:
1537
1080
            return self.transport
1538
1081
        try:
1566
1109
        # if the format is not the same as the system default,
1567
1110
        # an upgrade is needed.
1568
1111
        if format is None:
1569
 
            symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1570
 
                % 'needs_format_conversion(format=None)')
1571
1112
            format = BzrDirFormat.get_default_format()
1572
1113
        return not isinstance(self._format, format.__class__)
1573
1114
 
1574
 
    def open_branch(self, name=None, unsupported=False,
1575
 
                    ignore_fallbacks=False):
 
1115
    def open_branch(self, unsupported=False):
1576
1116
        """See BzrDir.open_branch."""
1577
1117
        from bzrlib.branch import BzrBranchFormat4
1578
1118
        format = BzrBranchFormat4()
1579
1119
        self._check_supported(format, unsupported)
1580
 
        return format.open(self, name, _found=True)
 
1120
        return format.open(self, _found=True)
1581
1121
 
1582
1122
    def sprout(self, url, revision_id=None, force_new_repo=False,
1583
 
               possible_transports=None, accelerator_tree=None,
1584
 
               hardlink=False, stacked=False, create_tree_if_local=True,
1585
 
               source_branch=None):
 
1123
               possible_transports=None, accelerator_tree=None):
1586
1124
        """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
 
        if stacked:
1594
 
            raise errors.UnstackableBranchFormat(
1595
 
                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
1125
        from bzrlib.workingtree import WorkingTreeFormat2
1600
1126
        self._make_tail(url)
1601
1127
        result = self._format._initialize_for_clone(url)
1607
1133
            self.open_branch().sprout(result, revision_id=revision_id)
1608
1134
        except errors.NotBranchError:
1609
1135
            pass
1610
 
 
1611
1136
        # we always want a working tree
1612
1137
        WorkingTreeFormat2().initialize(result,
1613
 
                                        accelerator_tree=accelerator_tree,
1614
 
                                        hardlink=hardlink)
 
1138
                                        accelerator_tree=accelerator_tree)
1615
1139
        return result
1616
1140
 
1617
1141
 
1618
1142
class BzrDir4(BzrDirPreSplitOut):
1619
1143
    """A .bzr version 4 control object.
1620
 
 
 
1144
    
1621
1145
    This is a deprecated format and may be removed after sept 2006.
1622
1146
    """
1623
1147
 
1627
1151
 
1628
1152
    def needs_format_conversion(self, format=None):
1629
1153
        """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
1154
        return True
1634
1155
 
1635
1156
    def open_repository(self):
1644
1165
    This is a deprecated format and may be removed after sept 2006.
1645
1166
    """
1646
1167
 
1647
 
    def has_workingtree(self):
1648
 
        """See BzrDir.has_workingtree."""
1649
 
        return True
1650
 
    
1651
1168
    def open_repository(self):
1652
1169
        """See BzrDir.open_repository."""
1653
1170
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
1669
1186
    This is a deprecated format and may be removed after sept 2006.
1670
1187
    """
1671
1188
 
1672
 
    def has_workingtree(self):
1673
 
        """See BzrDir.has_workingtree."""
1674
 
        return True
1675
 
    
1676
1189
    def open_repository(self):
1677
1190
        """See BzrDir.open_repository."""
1678
1191
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
1689
1202
 
1690
1203
class BzrDirMeta1(BzrDir):
1691
1204
    """A .bzr meta version 1 control object.
1692
 
 
1693
 
    This is the first control object where the
 
1205
    
 
1206
    This is the first control object where the 
1694
1207
    individual aspects are really split out: there are separate repository,
1695
1208
    workingtree and branch subdirectories and any subset of the three can be
1696
1209
    present within a BzrDir.
1700
1213
        """See BzrDir.can_convert_format()."""
1701
1214
        return True
1702
1215
 
1703
 
    def create_branch(self, name=None):
 
1216
    def create_branch(self):
1704
1217
        """See BzrDir.create_branch."""
1705
 
        return self._format.get_branch_format().initialize(self, name=name)
 
1218
        return self._format.get_branch_format().initialize(self)
1706
1219
 
1707
 
    def destroy_branch(self, name=None):
 
1220
    def destroy_branch(self):
1708
1221
        """See BzrDir.create_branch."""
1709
 
        if name is not None:
1710
 
            raise errors.NoColocatedBranchSupport(self)
1711
1222
        self.transport.delete_tree('branch')
1712
1223
 
1713
1224
    def create_repository(self, shared=False):
1719
1230
        self.transport.delete_tree('repository')
1720
1231
 
1721
1232
    def create_workingtree(self, revision_id=None, from_branch=None,
1722
 
                           accelerator_tree=None, hardlink=False):
 
1233
                           accelerator_tree=None):
1723
1234
        """See BzrDir.create_workingtree."""
1724
1235
        return self._format.workingtree_format.initialize(
1725
1236
            self, revision_id, from_branch=from_branch,
1726
 
            accelerator_tree=accelerator_tree, hardlink=hardlink)
 
1237
            accelerator_tree=accelerator_tree)
1727
1238
 
1728
1239
    def destroy_workingtree(self):
1729
1240
        """See BzrDir.destroy_workingtree."""
1756
1267
        format = BranchFormat.find_format(self)
1757
1268
        return format.get_reference(self)
1758
1269
 
1759
 
    def get_branch_transport(self, branch_format, name=None):
 
1270
    def get_branch_transport(self, branch_format):
1760
1271
        """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
1272
        if branch_format is None:
1766
1273
            return self.transport.clone('branch')
1767
1274
        try:
1802
1309
            pass
1803
1310
        return self.transport.clone('checkout')
1804
1311
 
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
1312
    def needs_format_conversion(self, format=None):
1822
1313
        """See BzrDir.needs_format_conversion()."""
1823
1314
        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
1315
            format = BzrDirFormat.get_default_format()
1828
1316
        if not isinstance(self._format, format.__class__):
1829
1317
            # it is not a meta dir format, conversion is needed.
1836
1324
                return True
1837
1325
        except errors.NoRepositoryPresent:
1838
1326
            pass
1839
 
        for branch in self.list_branches():
1840
 
            if not isinstance(branch._format,
 
1327
        try:
 
1328
            if not isinstance(self.open_branch()._format,
1841
1329
                              format.get_branch_format().__class__):
1842
1330
                # the branch needs an upgrade.
1843
1331
                return True
 
1332
        except errors.NotBranchError:
 
1333
            pass
1844
1334
        try:
1845
1335
            my_wt = self.open_workingtree(recommend_upgrade=False)
1846
1336
            if not isinstance(my_wt._format,
1851
1341
            pass
1852
1342
        return False
1853
1343
 
1854
 
    def open_branch(self, name=None, unsupported=False,
1855
 
                    ignore_fallbacks=False):
 
1344
    def open_branch(self, unsupported=False):
1856
1345
        """See BzrDir.open_branch."""
1857
1346
        format = self.find_branch_format()
1858
1347
        self._check_supported(format, unsupported)
1859
 
        return format.open(self, name=name,
1860
 
            _found=True, ignore_fallbacks=ignore_fallbacks)
 
1348
        return format.open(self, _found=True)
1861
1349
 
1862
1350
    def open_repository(self, unsupported=False):
1863
1351
        """See BzrDir.open_repository."""
1876
1364
            basedir=self.root_transport.base)
1877
1365
        return format.open(self, _found=True)
1878
1366
 
1879
 
    def _get_config(self):
1880
 
        return config.TransportConfig(self.transport, 'control.conf')
1881
 
 
1882
1367
 
1883
1368
class BzrDirFormat(object):
1884
1369
    """An encapsulation of the initialization and open routines for a format.
1888
1373
     * a format string,
1889
1374
     * an open routine.
1890
1375
 
1891
 
    Formats are placed in a dict by their format string for reference
 
1376
    Formats are placed in a dict by their format string for reference 
1892
1377
    during bzrdir opening. These should be subclasses of BzrDirFormat
1893
1378
    for consistency.
1894
1379
 
1895
1380
    Once a format is deprecated, just deprecate the initialize and open
1896
 
    methods on the format class. Do not deprecate the object, as the
 
1381
    methods on the format class. Do not deprecate the object, as the 
1897
1382
    object will be created every system load.
1898
 
 
1899
 
    :cvar colocated_branches: Whether this formats supports colocated branches.
1900
1383
    """
1901
1384
 
1902
1385
    _default_format = None
1907
1390
 
1908
1391
    _control_formats = []
1909
1392
    """The registered control formats - .bzr, ....
1910
 
 
 
1393
    
1911
1394
    This is a list of BzrDirFormat objects.
1912
1395
    """
1913
1396
 
1919
1402
 
1920
1403
    _lock_file_name = 'branch-lock'
1921
1404
 
1922
 
    colocated_branches = False
1923
 
    """Whether co-located branches are supported for this control dir format.
1924
 
    """
1925
 
 
1926
1405
    # _lock_class must be set in subclasses to the lock type, typ.
1927
1406
    # TransportLock or LockDir
1928
1407
 
1945
1424
    def probe_transport(klass, transport):
1946
1425
        """Return the .bzrdir style format present in a directory."""
1947
1426
        try:
1948
 
            format_string = transport.get_bytes(".bzr/branch-format")
 
1427
            format_string = transport.get(".bzr/branch-format").read()
1949
1428
        except errors.NoSuchFile:
1950
1429
            raise errors.NotBranchError(path=transport.base)
1951
1430
 
1952
1431
        try:
1953
1432
            return klass._formats[format_string]
1954
1433
        except KeyError:
1955
 
            raise errors.UnknownFormatError(format=format_string, kind='bzrdir')
 
1434
            raise errors.UnknownFormatError(format=format_string)
1956
1435
 
1957
1436
    @classmethod
1958
1437
    def get_default_format(klass):
1976
1455
        current default format. In the case of plugins we can/should provide
1977
1456
        some means for them to extend the range of returnable converters.
1978
1457
 
1979
 
        :param format: Optional format to override the default format of the
 
1458
        :param format: Optional format to override the default format of the 
1980
1459
                       library.
1981
1460
        """
1982
1461
        raise NotImplementedError(self.get_converter)
1983
1462
 
1984
1463
    def initialize(self, url, possible_transports=None):
1985
1464
        """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
 
 
 
1465
        
1991
1466
        Subclasses should typically override initialize_on_transport
1992
1467
        instead of this method.
1993
1468
        """
1996
1471
 
1997
1472
    def initialize_on_transport(self, transport):
1998
1473
        """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
 
1474
        # Since we don't have a .bzr directory, inherit the
2119
1475
        # mode from the root directory
2120
1476
        temp_control = lockable_files.LockableFiles(transport,
2121
1477
                            '', lockable_files.TransportLock)
2123
1479
                                      # FIXME: RBC 20060121 don't peek under
2124
1480
                                      # the covers
2125
1481
                                      mode=temp_control._dir_mode)
2126
 
        if sys.platform == 'win32' and isinstance(transport, local.LocalTransport):
 
1482
        if sys.platform == 'win32' and isinstance(transport, LocalTransport):
2127
1483
            win32utils.set_file_attr_hidden(transport._abspath('.bzr'))
2128
1484
        file_mode = temp_control._file_mode
2129
1485
        del temp_control
2130
 
        bzrdir_transport = transport.clone('.bzr')
2131
 
        utf8_files = [('README',
2132
 
                       "This is a Bazaar control directory.\n"
2133
 
                       "Do not change any files in this directory.\n"
2134
 
                       "See http://bazaar-vcs.org/ for more information about Bazaar.\n"),
 
1486
        mutter('created control directory in ' + transport.base)
 
1487
        control = transport.clone('.bzr')
 
1488
        utf8_files = [('README', 
 
1489
                       "This is a Bazaar-NG control directory.\n"
 
1490
                       "Do not change any files in this directory.\n"),
2135
1491
                      ('branch-format', self.get_format_string()),
2136
1492
                      ]
2137
1493
        # NB: no need to escape relative paths that are url safe.
2138
 
        control_files = lockable_files.LockableFiles(bzrdir_transport,
2139
 
            self._lock_file_name, self._lock_class)
 
1494
        control_files = lockable_files.LockableFiles(control,
 
1495
                            self._lock_file_name, self._lock_class)
2140
1496
        control_files.create_lock()
2141
1497
        control_files.lock_write()
2142
1498
        try:
2143
 
            for (filename, content) in utf8_files:
2144
 
                bzrdir_transport.put_bytes(filename, content,
2145
 
                    mode=file_mode)
 
1499
            for file, content in utf8_files:
 
1500
                control_files.put_utf8(file, content)
2146
1501
        finally:
2147
1502
            control_files.unlock()
2148
1503
        return self.open(transport, _found=True)
2151
1506
        """Is this format supported?
2152
1507
 
2153
1508
        Supported formats must be initializable and openable.
2154
 
        Unsupported formats may not support initialization or committing or
 
1509
        Unsupported formats may not support initialization or committing or 
2155
1510
        some other features depending on the reason for not being supported.
2156
1511
        """
2157
1512
        return True
2158
1513
 
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
1514
    def same_model(self, target_format):
2170
 
        return (self.repository_format.rich_root_data ==
 
1515
        return (self.repository_format.rich_root_data == 
2171
1516
            target_format.rich_root_data)
2172
1517
 
2173
1518
    @classmethod
2174
1519
    def known_formats(klass):
2175
1520
        """Return all the known formats.
2176
 
 
 
1521
        
2177
1522
        Concrete formats should override _known_formats.
2178
1523
        """
2179
 
        # There is double indirection here to make sure that control
2180
 
        # formats used by more than one dir format will only be probed
 
1524
        # There is double indirection here to make sure that control 
 
1525
        # formats used by more than one dir format will only be probed 
2181
1526
        # once. This can otherwise be quite expensive for remote connections.
2182
1527
        result = set()
2183
1528
        for format in klass._control_formats:
2184
1529
            result.update(format._known_formats())
2185
1530
        return result
2186
 
 
 
1531
    
2187
1532
    @classmethod
2188
1533
    def _known_formats(klass):
2189
1534
        """Return the known format instances for this control format."""
2191
1536
 
2192
1537
    def open(self, transport, _found=False):
2193
1538
        """Return an instance of this format for the dir transport points at.
2194
 
 
 
1539
        
2195
1540
        _found is a private parameter, do not use it.
2196
1541
        """
2197
1542
        if not _found:
2198
1543
            found_format = BzrDirFormat.find_format(transport)
2199
1544
            if not isinstance(found_format, self.__class__):
2200
1545
                raise AssertionError("%s was asked to open %s, but it seems to need "
2201
 
                        "format %s"
 
1546
                        "format %s" 
2202
1547
                        % (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
1548
        return self._open(transport)
2207
1549
 
2208
1550
    def _open(self, transport):
2216
1558
    @classmethod
2217
1559
    def register_format(klass, format):
2218
1560
        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
1561
 
2222
1562
    @classmethod
2223
1563
    def register_control_format(klass, format):
2224
1564
        """Register a format that does not use '.bzr' for its control dir.
2225
1565
 
2226
1566
        TODO: This should be pulled up into a 'ControlDirFormat' base class
2227
 
        which BzrDirFormat can inherit from, and renamed to register_format
 
1567
        which BzrDirFormat can inherit from, and renamed to register_format 
2228
1568
        there. It has been done without that for now for simplicity of
2229
1569
        implementation.
2230
1570
        """
2242
1582
        klass._control_server_formats.append(format)
2243
1583
 
2244
1584
    @classmethod
 
1585
    @symbol_versioning.deprecated_method(symbol_versioning.zero_fourteen)
 
1586
    def set_default_format(klass, format):
 
1587
        klass._set_default_format(format)
 
1588
 
 
1589
    @classmethod
2245
1590
    def _set_default_format(klass, format):
2246
1591
        """Set default format (for testing behavior of defaults only)"""
2247
1592
        klass._default_format = format
2248
1593
 
2249
1594
    def __str__(self):
2250
1595
        # 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
 
        """
 
1596
        return self.get_format_string().rstrip()
2264
1597
 
2265
1598
    @classmethod
2266
1599
    def unregister_format(klass, format):
 
1600
        assert klass._formats[format.get_format_string()] is format
2267
1601
        del klass._formats[format.get_format_string()]
2268
1602
 
2269
1603
    @classmethod
2298
1632
        """See BzrDirFormat.get_converter()."""
2299
1633
        # there is one and only one upgrade path here.
2300
1634
        return ConvertBzrDir4To5()
2301
 
 
 
1635
        
2302
1636
    def initialize_on_transport(self, transport):
2303
1637
        """Format 4 branches cannot be created."""
2304
1638
        raise errors.UninitializableFormat(self)
2307
1641
        """Format 4 is not supported.
2308
1642
 
2309
1643
        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
 
1644
        conversion logic is expensive - so doing it on the fly was not 
2311
1645
        feasible.
2312
1646
        """
2313
1647
        return False
2314
1648
 
2315
 
    def network_name(self):
2316
 
        return self.get_format_string()
2317
 
 
2318
1649
    def _open(self, transport):
2319
1650
        """See BzrDirFormat._open."""
2320
1651
        return BzrDir4(transport, self)
2326
1657
    repository_format = property(__return_repository_format)
2327
1658
 
2328
1659
 
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):
 
1660
class BzrDirFormat5(BzrDirFormat):
2355
1661
    """Bzr control format 5.
2356
1662
 
2357
1663
    This format is a combined format for working tree, branch and repository.
2358
1664
    It has:
2359
 
     - Format 2 working trees [always]
2360
 
     - Format 4 branches [always]
 
1665
     - Format 2 working trees [always] 
 
1666
     - Format 4 branches [always] 
2361
1667
     - Format 5 repositories [always]
2362
1668
       Unhashed stores in the repository.
2363
1669
    """
2368
1674
        """See BzrDirFormat.get_format_string()."""
2369
1675
        return "Bazaar-NG branch, format 5\n"
2370
1676
 
2371
 
    def get_branch_format(self):
2372
 
        from bzrlib import branch
2373
 
        return branch.BzrBranchFormat4()
2374
 
 
2375
1677
    def get_format_description(self):
2376
1678
        """See BzrDirFormat.get_format_description()."""
2377
1679
        return "All-in-one format 5"
2383
1685
 
2384
1686
    def _initialize_for_clone(self, url):
2385
1687
        return self.initialize_on_transport(get_transport(url), _cloning=True)
2386
 
 
 
1688
        
2387
1689
    def initialize_on_transport(self, transport, _cloning=False):
2388
1690
        """Format 5 dirs always have working tree, branch and repository.
2389
 
 
 
1691
        
2390
1692
        Except when they are being cloned.
2391
1693
        """
2392
1694
        from bzrlib.branch import BzrBranchFormat4
2393
1695
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
 
1696
        from bzrlib.workingtree import WorkingTreeFormat2
2394
1697
        result = (super(BzrDirFormat5, self).initialize_on_transport(transport))
2395
1698
        RepositoryFormat5().initialize(result, _internal=True)
2396
1699
        if not _cloning:
2397
1700
            branch = BzrBranchFormat4().initialize(result)
2398
 
            result._init_workingtree()
 
1701
            try:
 
1702
                WorkingTreeFormat2().initialize(result)
 
1703
            except errors.NotLocalUrl:
 
1704
                # Even though we can't access the working tree, we need to
 
1705
                # create its control files.
 
1706
                WorkingTreeFormat2().stub_initialize_remote(branch.control_files)
2399
1707
        return result
2400
1708
 
2401
 
    def network_name(self):
2402
 
        return self.get_format_string()
2403
 
 
2404
1709
    def _open(self, transport):
2405
1710
        """See BzrDirFormat._open."""
2406
1711
        return BzrDir5(transport, self)
2412
1717
    repository_format = property(__return_repository_format)
2413
1718
 
2414
1719
 
2415
 
class BzrDirFormat6(BzrDirFormatAllInOne):
 
1720
class BzrDirFormat6(BzrDirFormat):
2416
1721
    """Bzr control format 6.
2417
1722
 
2418
1723
    This format is a combined format for working tree, branch and repository.
2419
1724
    It has:
2420
 
     - Format 2 working trees [always]
2421
 
     - Format 4 branches [always]
 
1725
     - Format 2 working trees [always] 
 
1726
     - Format 4 branches [always] 
2422
1727
     - Format 6 repositories [always]
2423
1728
    """
2424
1729
 
2432
1737
        """See BzrDirFormat.get_format_description()."""
2433
1738
        return "All-in-one format 6"
2434
1739
 
2435
 
    def get_branch_format(self):
2436
 
        from bzrlib import branch
2437
 
        return branch.BzrBranchFormat4()
2438
 
 
2439
1740
    def get_converter(self, format=None):
2440
1741
        """See BzrDirFormat.get_converter()."""
2441
1742
        # there is one and only one upgrade path here.
2442
1743
        return ConvertBzrDir6ToMeta()
2443
 
 
 
1744
        
2444
1745
    def _initialize_for_clone(self, url):
2445
1746
        return self.initialize_on_transport(get_transport(url), _cloning=True)
2446
1747
 
2447
1748
    def initialize_on_transport(self, transport, _cloning=False):
2448
1749
        """Format 6 dirs always have working tree, branch and repository.
2449
 
 
 
1750
        
2450
1751
        Except when they are being cloned.
2451
1752
        """
2452
1753
        from bzrlib.branch import BzrBranchFormat4
2453
1754
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
 
1755
        from bzrlib.workingtree import WorkingTreeFormat2
2454
1756
        result = super(BzrDirFormat6, self).initialize_on_transport(transport)
2455
1757
        RepositoryFormat6().initialize(result, _internal=True)
2456
1758
        if not _cloning:
2457
1759
            branch = BzrBranchFormat4().initialize(result)
2458
 
            result._init_workingtree()
 
1760
            try:
 
1761
                WorkingTreeFormat2().initialize(result)
 
1762
            except errors.NotLocalUrl:
 
1763
                # Even though we can't access the working tree, we need to
 
1764
                # create its control files.
 
1765
                WorkingTreeFormat2().stub_initialize_remote(branch.control_files)
2459
1766
        return result
2460
1767
 
2461
 
    def network_name(self):
2462
 
        return self.get_format_string()
2463
 
 
2464
1768
    def _open(self, transport):
2465
1769
        """See BzrDirFormat._open."""
2466
1770
        return BzrDir6(transport, self)
2488
1792
    def __init__(self):
2489
1793
        self._workingtree_format = None
2490
1794
        self._branch_format = None
2491
 
        self._repository_format = None
2492
1795
 
2493
1796
    def __eq__(self, other):
2494
1797
        if other.__class__ is not self.__class__:
2511
1814
    def set_branch_format(self, format):
2512
1815
        self._branch_format = format
2513
1816
 
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
1817
    def get_converter(self, format=None):
2607
1818
        """See BzrDirFormat.get_converter()."""
2608
1819
        if format is None:
2620
1831
        """See BzrDirFormat.get_format_description()."""
2621
1832
        return "Meta directory format 1"
2622
1833
 
2623
 
    def network_name(self):
2624
 
        return self.get_format_string()
2625
 
 
2626
1834
    def _open(self, transport):
2627
1835
        """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)
 
1836
        return BzrDirMeta1(transport, self)
2634
1837
 
2635
1838
    def __return_repository_format(self):
2636
1839
        """Circular import protection."""
2637
 
        if self._repository_format:
 
1840
        if getattr(self, '_repository_format', None):
2638
1841
            return self._repository_format
2639
1842
        from bzrlib.repository import RepositoryFormat
2640
1843
        return RepositoryFormat.get_default_format()
2641
1844
 
2642
 
    def _set_repository_format(self, value):
 
1845
    def __set_repository_format(self, value):
2643
1846
        """Allow changing the repository format for metadir formats."""
2644
1847
        self._repository_format = value
2645
1848
 
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
 
1849
    repository_format = property(__return_repository_format, __set_repository_format)
2666
1850
 
2667
1851
    def __get_workingtree_format(self):
2668
1852
        if self._workingtree_format is None:
2677
1861
                                  __set_workingtree_format)
2678
1862
 
2679
1863
 
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
1864
# Register bzr control format
2690
1865
BzrDirFormat.register_control_format(BzrDirFormat)
2691
1866
 
2723
1898
        self.absent_revisions = set()
2724
1899
        self.text_count = 0
2725
1900
        self.revisions = {}
2726
 
 
 
1901
        
2727
1902
    def convert(self, to_convert, pb):
2728
1903
        """See Converter.convert()."""
2729
1904
        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()
 
1905
        self.pb = pb
 
1906
        self.pb.note('starting upgrade from format 4 to 5')
 
1907
        if isinstance(self.bzrdir.transport, LocalTransport):
 
1908
            self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
 
1909
        self._convert_to_weaves()
 
1910
        return BzrDir.open(self.bzrdir.root_transport.base)
2741
1911
 
2742
1912
    def _convert_to_weaves(self):
2743
 
        ui.ui_factory.note('note: upgrade may be faster if all store files are ungzipped first')
 
1913
        self.pb.note('note: upgrade may be faster if all store files are ungzipped first')
2744
1914
        try:
2745
1915
            # TODO permissions
2746
1916
            stat = self.bzrdir.transport.stat('weaves')
2774
1944
        self.pb.clear()
2775
1945
        self._write_all_weaves()
2776
1946
        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)
 
1947
        self.pb.note('upgraded to weaves:')
 
1948
        self.pb.note('  %6d revisions and inventories', len(self.revisions))
 
1949
        self.pb.note('  %6d revisions not present', len(self.absent_revisions))
 
1950
        self.pb.note('  %6d texts', self.text_count)
2781
1951
        self._cleanup_spare_files_after_format4()
2782
 
        self.branch._transport.put_bytes(
2783
 
            'branch-format',
2784
 
            BzrDirFormat5().get_format_string(),
2785
 
            mode=self.bzrdir._get_file_mode())
 
1952
        self.branch.control_files.put_utf8('branch-format', BzrDirFormat5().get_format_string())
2786
1953
 
2787
1954
    def _cleanup_spare_files_after_format4(self):
2788
1955
        # FIXME working tree upgrade foo.
2797
1964
 
2798
1965
    def _convert_working_inv(self):
2799
1966
        inv = xml4.serializer_v4.read_inventory(
2800
 
                self.branch._transport.get('inventory'))
 
1967
                    self.branch.control_files.get('inventory'))
2801
1968
        new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv, working=True)
2802
 
        self.branch._transport.put_bytes('inventory', new_inv_xml,
2803
 
            mode=self.bzrdir._get_file_mode())
 
1969
        # FIXME inventory is a working tree change.
 
1970
        self.branch.control_files.put('inventory', StringIO(new_inv_xml))
2804
1971
 
2805
1972
    def _write_all_weaves(self):
2806
1973
        controlweaves = WeaveStore(self.bzrdir.transport, prefixed=False)
2826
1993
        self.bzrdir.transport.mkdir('revision-store')
2827
1994
        revision_transport = self.bzrdir.transport.clone('revision-store')
2828
1995
        # TODO permissions
2829
 
        from bzrlib.xml5 import serializer_v5
2830
 
        from bzrlib.repofmt.weaverepo import RevisionTextStore
2831
 
        revision_store = RevisionTextStore(revision_transport,
2832
 
            serializer_v5, False, versionedfile.PrefixMapper(),
2833
 
            lambda:True, lambda:True)
 
1996
        _revision_store = TextRevisionStore(TextStore(revision_transport,
 
1997
                                                      prefixed=False,
 
1998
                                                      compressed=True))
2834
1999
        try:
 
2000
            transaction = WriteTransaction()
2835
2001
            for i, rev_id in enumerate(self.converted_revs):
2836
2002
                self.pb.update('write revision', i, len(self.converted_revs))
2837
 
                text = serializer_v5.write_revision_to_string(
2838
 
                    self.revisions[rev_id])
2839
 
                key = (rev_id,)
2840
 
                revision_store.add_lines(key, None, osutils.split_lines(text))
 
2003
                _revision_store.add_revision(self.revisions[rev_id], transaction)
2841
2004
        finally:
2842
2005
            self.pb.clear()
2843
 
 
 
2006
            
2844
2007
    def _load_one_rev(self, rev_id):
2845
2008
        """Load a revision object into memory.
2846
2009
 
2851
2014
                       len(self.known_revisions))
2852
2015
        if not self.branch.repository.has_revision(rev_id):
2853
2016
            self.pb.clear()
2854
 
            ui.ui_factory.note('revision {%s} not present in branch; '
2855
 
                         'will be converted as a ghost' %
 
2017
            self.pb.note('revision {%s} not present in branch; '
 
2018
                         'will be converted as a ghost',
2856
2019
                         rev_id)
2857
2020
            self.absent_revisions.add(rev_id)
2858
2021
        else:
2859
 
            rev = self.branch.repository.get_revision(rev_id)
 
2022
            rev = self.branch.repository._revision_store.get_revision(rev_id,
 
2023
                self.branch.repository.get_transaction())
2860
2024
            for parent_id in rev.parent_ids:
2861
2025
                self.known_revisions.add(parent_id)
2862
2026
                self.to_read.append(parent_id)
2863
2027
            self.revisions[rev_id] = rev
2864
2028
 
2865
2029
    def _load_old_inventory(self, rev_id):
 
2030
        assert rev_id not in self.converted_revs
2866
2031
        old_inv_xml = self.branch.repository.inventory_store.get(rev_id).read()
2867
2032
        inv = xml4.serializer_v4.read_inventory_from_string(old_inv_xml)
2868
2033
        inv.revision_id = rev_id
2869
2034
        rev = self.revisions[rev_id]
 
2035
        if rev.inventory_sha1:
 
2036
            assert rev.inventory_sha1 == sha_string(old_inv_xml), \
 
2037
                'inventory sha mismatch for {%s}' % rev_id
2870
2038
        return inv
2871
2039
 
2872
2040
    def _load_updated_inventory(self, rev_id):
 
2041
        assert rev_id in self.converted_revs
2873
2042
        inv_xml = self.inv_weave.get_text(rev_id)
2874
2043
        inv = xml5.serializer_v5.read_inventory_from_string(inv_xml, rev_id)
2875
2044
        return inv
2885
2054
        self.converted_revs.add(rev_id)
2886
2055
 
2887
2056
    def _store_new_inv(self, rev, inv, present_parents):
 
2057
        # the XML is now updated with text versions
 
2058
        if __debug__:
 
2059
            entries = inv.iter_entries()
 
2060
            entries.next()
 
2061
            for path, ie in entries:
 
2062
                assert getattr(ie, 'revision', None) is not None, \
 
2063
                    'no revision on {%s} in {%s}' % \
 
2064
                    (file_id, rev.revision_id)
2888
2065
        new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
2889
2066
        new_inv_sha1 = sha_string(new_inv_xml)
2890
2067
        self.inv_weave.add_lines(rev.revision_id,
2919
2096
            self.text_weaves[file_id] = w
2920
2097
        text_changed = False
2921
2098
        parent_candiate_entries = ie.parent_candidates(parent_invs)
 
2099
        for old_revision in parent_candiate_entries.keys():
 
2100
            # if this fails, its a ghost ?
 
2101
            assert old_revision in self.converted_revs, \
 
2102
                "Revision {%s} not in converted_revs" % old_revision
2922
2103
        heads = graph.Graph(self).heads(parent_candiate_entries.keys())
2923
 
        # XXX: Note that this is unordered - and this is tolerable because
 
2104
        # XXX: Note that this is unordered - and this is tolerable because 
2924
2105
        # the previous code was also unordered.
2925
2106
        previous_entries = dict((head, parent_candiate_entries[head]) for head
2926
2107
            in heads)
2927
2108
        self.snapshot_ie(previous_entries, ie, w, rev_id)
2928
2109
        del ie.text_id
 
2110
        assert getattr(ie, 'revision', None) is not None
 
2111
 
 
2112
    @symbol_versioning.deprecated_method(symbol_versioning.one_one)
 
2113
    def get_parents(self, revision_ids):
 
2114
        for revision_id in revision_ids:
 
2115
            yield self.revisions[revision_id].parent_ids
2929
2116
 
2930
2117
    def get_parent_map(self, revision_ids):
2931
 
        """See graph.StackedParentsProvider.get_parent_map"""
 
2118
        """See graph._StackedParentsProvider.get_parent_map"""
2932
2119
        return dict((revision_id, self.revisions[revision_id])
2933
2120
                    for revision_id in revision_ids
2934
2121
                     if revision_id in self.revisions)
2938
2125
        # a call to:. This needs the path figured out. rather than a work_tree
2939
2126
        # a v4 revision_tree can be given, or something that looks enough like
2940
2127
        # 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
 
2128
        # and we need something that looks like a weave store for snapshot to 
2942
2129
        # save against.
2943
2130
        #ie.snapshot(rev, PATH, previous_revisions, REVISION_TREE, InMemoryWeaveStore(self.text_weaves))
2944
2131
        if len(previous_revisions) == 1:
2947
2134
                ie.revision = previous_ie.revision
2948
2135
                return
2949
2136
        if ie.has_text():
2950
 
            text = self.branch.repository._text_store.get(ie.text_id)
 
2137
            text = self.branch.repository.weave_store.get(ie.text_id)
2951
2138
            file_lines = text.readlines()
 
2139
            assert sha_strings(file_lines) == ie.text_sha1
 
2140
            assert sum(map(len, file_lines)) == ie.text_size
2952
2141
            w.add_lines(rev_id, previous_revisions, file_lines)
2953
2142
            self.text_count += 1
2954
2143
        else:
2984
2173
    def convert(self, to_convert, pb):
2985
2174
        """See Converter.convert()."""
2986
2175
        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()
 
2176
        self.pb = pb
 
2177
        self.pb.note('starting upgrade from format 5 to 6')
 
2178
        self._convert_to_prefixed()
 
2179
        return BzrDir.open(self.bzrdir.root_transport.base)
2994
2180
 
2995
2181
    def _convert_to_prefixed(self):
2996
2182
        from bzrlib.store import TransportStore
2997
2183
        self.bzrdir.transport.delete('branch-format')
2998
2184
        for store_name in ["weaves", "revision-store"]:
2999
 
            ui.ui_factory.note("adding prefixes to %s" % store_name)
 
2185
            self.pb.note("adding prefixes to %s" % store_name)
3000
2186
            store_transport = self.bzrdir.transport.clone(store_name)
3001
2187
            store = TransportStore(store_transport, prefixed=True)
3002
2188
            for urlfilename in store_transport.list_dir('.'):
3004
2190
                if (filename.endswith(".weave") or
3005
2191
                    filename.endswith(".gz") or
3006
2192
                    filename.endswith(".sig")):
3007
 
                    file_id, suffix = os.path.splitext(filename)
 
2193
                    file_id = os.path.splitext(filename)[0]
3008
2194
                else:
3009
2195
                    file_id = filename
3010
 
                    suffix = ''
3011
 
                new_name = store._mapper.map((file_id,)) + suffix
 
2196
                prefix_dir = store.hash_prefix(file_id)
3012
2197
                # FIXME keep track of the dirs made RBC 20060121
3013
2198
                try:
3014
 
                    store_transport.move(filename, new_name)
 
2199
                    store_transport.move(filename, prefix_dir + '/' + filename)
3015
2200
                except errors.NoSuchFile: # catches missing dirs strangely enough
3016
 
                    store_transport.mkdir(osutils.dirname(new_name))
3017
 
                    store_transport.move(filename, new_name)
3018
 
        self.bzrdir.transport.put_bytes(
3019
 
            'branch-format',
3020
 
            BzrDirFormat6().get_format_string(),
3021
 
            mode=self.bzrdir._get_file_mode())
 
2201
                    store_transport.mkdir(prefix_dir)
 
2202
                    store_transport.move(filename, prefix_dir + '/' + filename)
 
2203
        self.bzrdir._control_files.put_utf8('branch-format', BzrDirFormat6().get_format_string())
3022
2204
 
3023
2205
 
3024
2206
class ConvertBzrDir6ToMeta(Converter):
3029
2211
        from bzrlib.repofmt.weaverepo import RepositoryFormat7
3030
2212
        from bzrlib.branch import BzrBranchFormat5
3031
2213
        self.bzrdir = to_convert
3032
 
        self.pb = ui.ui_factory.nested_progress_bar()
 
2214
        self.pb = pb
3033
2215
        self.count = 0
3034
2216
        self.total = 20 # the steps we know about
3035
2217
        self.garbage_inventories = []
3036
 
        self.dir_mode = self.bzrdir._get_dir_mode()
3037
 
        self.file_mode = self.bzrdir._get_file_mode()
3038
2218
 
3039
 
        ui.ui_factory.note('starting upgrade from format 6 to metadir')
3040
 
        self.bzrdir.transport.put_bytes(
3041
 
                'branch-format',
3042
 
                "Converting to format 6",
3043
 
                mode=self.file_mode)
 
2219
        self.pb.note('starting upgrade from format 6 to metadir')
 
2220
        self.bzrdir._control_files.put_utf8('branch-format', "Converting to format 6")
3044
2221
        # its faster to move specific files around than to open and use the apis...
3045
2222
        # first off, nuke ancestry.weave, it was never used.
3046
2223
        try:
3056
2233
            if name.startswith('basis-inventory.'):
3057
2234
                self.garbage_inventories.append(name)
3058
2235
        # create new directories for repository, working tree and branch
 
2236
        self.dir_mode = self.bzrdir._control_files._dir_mode
 
2237
        self.file_mode = self.bzrdir._control_files._file_mode
3059
2238
        repository_names = [('inventory.weave', True),
3060
2239
                            ('revision-store', True),
3061
2240
                            ('weaves', True)]
3063
2242
        self.bzrdir.transport.mkdir('repository', mode=self.dir_mode)
3064
2243
        self.make_lock('repository')
3065
2244
        # we hard code the formats here because we are converting into
3066
 
        # the meta format. The meta format upgrader can take this to a
 
2245
        # the meta format. The meta format upgrader can take this to a 
3067
2246
        # future format within each component.
3068
2247
        self.put_format('repository', RepositoryFormat7())
3069
2248
        for entry in repository_names:
3092
2271
        else:
3093
2272
            has_checkout = True
3094
2273
        if not has_checkout:
3095
 
            ui.ui_factory.note('No working tree.')
 
2274
            self.pb.note('No working tree.')
3096
2275
            # If some checkout files are there, we may as well get rid of them.
3097
2276
            for name, mandatory in checkout_files:
3098
2277
                if name in bzrcontents:
3109
2288
            for entry in checkout_files:
3110
2289
                self.move_entry('checkout', entry)
3111
2290
            if last_revision is not None:
3112
 
                self.bzrdir.transport.put_bytes(
 
2291
                self.bzrdir._control_files.put_utf8(
3113
2292
                    'checkout/last-revision', last_revision)
3114
 
        self.bzrdir.transport.put_bytes(
3115
 
            'branch-format',
3116
 
            BzrDirMetaFormat1().get_format_string(),
3117
 
            mode=self.file_mode)
3118
 
        self.pb.finished()
3119
 
        return BzrDir.open(self.bzrdir.user_url)
 
2293
        self.bzrdir._control_files.put_utf8(
 
2294
            'branch-format', BzrDirMetaFormat1().get_format_string())
 
2295
        return BzrDir.open(self.bzrdir.root_transport.base)
3120
2296
 
3121
2297
    def make_lock(self, name):
3122
2298
        """Make a lock for the new control dir name."""
3139
2315
                raise
3140
2316
 
3141
2317
    def put_format(self, dirname, format):
3142
 
        self.bzrdir.transport.put_bytes('%s/format' % dirname,
3143
 
            format.get_format_string(),
3144
 
            self.file_mode)
 
2318
        self.bzrdir._control_files.put_utf8('%s/format' % dirname, format.get_format_string())
3145
2319
 
3146
2320
 
3147
2321
class ConvertMetaToMeta(Converter):
3157
2331
    def convert(self, to_convert, pb):
3158
2332
        """See Converter.convert()."""
3159
2333
        self.bzrdir = to_convert
3160
 
        self.pb = ui.ui_factory.nested_progress_bar()
 
2334
        self.pb = pb
3161
2335
        self.count = 0
3162
2336
        self.total = 1
3163
2337
        self.step('checking repository format')
3168
2342
        else:
3169
2343
            if not isinstance(repo._format, self.target_format.repository_format.__class__):
3170
2344
                from bzrlib.repository import CopyConverter
3171
 
                ui.ui_factory.note('starting repository conversion')
 
2345
                self.pb.note('starting repository conversion')
3172
2346
                converter = CopyConverter(self.target_format.repository_format)
3173
2347
                converter.convert(repo, pb)
3174
 
        for branch in self.bzrdir.list_branches():
 
2348
        try:
 
2349
            branch = self.bzrdir.open_branch()
 
2350
        except errors.NotBranchError:
 
2351
            pass
 
2352
        else:
3175
2353
            # TODO: conversions of Branch and Tree should be done by
3176
 
            # InterXFormat lookups/some sort of registry.
 
2354
            # InterXFormat lookups
3177
2355
            # Avoid circular imports
3178
2356
            from bzrlib import branch as _mod_branch
3179
 
            old = branch._format.__class__
3180
 
            new = self.target_format.get_branch_format().__class__
3181
 
            while old != new:
3182
 
                if (old == _mod_branch.BzrBranchFormat5 and
3183
 
                    new in (_mod_branch.BzrBranchFormat6,
3184
 
                        _mod_branch.BzrBranchFormat7,
3185
 
                        _mod_branch.BzrBranchFormat8)):
3186
 
                    branch_converter = _mod_branch.Converter5to6()
3187
 
                elif (old == _mod_branch.BzrBranchFormat6 and
3188
 
                    new in (_mod_branch.BzrBranchFormat7,
3189
 
                            _mod_branch.BzrBranchFormat8)):
3190
 
                    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
 
                else:
3195
 
                    raise errors.BadConversionTarget("No converter", new,
3196
 
                        branch._format)
 
2357
            if (branch._format.__class__ is _mod_branch.BzrBranchFormat5 and
 
2358
                self.target_format.get_branch_format().__class__ is
 
2359
                _mod_branch.BzrBranchFormat6):
 
2360
                branch_converter = _mod_branch.Converter5to6()
3197
2361
                branch_converter.convert(branch)
3198
 
                branch = self.bzrdir.open_branch()
3199
 
                old = branch._format.__class__
3200
2362
        try:
3201
2363
            tree = self.bzrdir.open_workingtree(recommend_upgrade=False)
3202
2364
        except (errors.NoWorkingTree, errors.NotLocalUrl):
3205
2367
            # TODO: conversions of Branch and Tree should be done by
3206
2368
            # InterXFormat lookups
3207
2369
            if (isinstance(tree, workingtree.WorkingTree3) and
3208
 
                not isinstance(tree, workingtree_4.DirStateWorkingTree) and
 
2370
                not isinstance(tree, workingtree_4.WorkingTree4) and
3209
2371
                isinstance(self.target_format.workingtree_format,
3210
 
                    workingtree_4.DirStateWorkingTreeFormat)):
 
2372
                    workingtree_4.WorkingTreeFormat4)):
3211
2373
                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
2374
        return to_convert
3224
2375
 
3225
2376
 
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.
 
2377
# This is not in remote.py because it's small, and needs to be registered.
 
2378
# Putting it in remote.py creates a circular import problem.
3228
2379
# we can make it a lazy object if the control formats is turned into something
3229
2380
# like a registry.
3230
2381
class RemoteBzrDirFormat(BzrDirMetaFormat1):
3231
2382
    """Format representing bzrdirs accessed via a smart server"""
3232
2383
 
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
2384
    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
2385
        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
 
 
 
2386
    
3260
2387
    @classmethod
3261
2388
    def probe_transport(klass, transport):
3262
2389
        """Return a RemoteBzrDirFormat object if it looks possible."""
3263
2390
        try:
3264
 
            medium = transport.get_smart_medium()
 
2391
            client = transport.get_smart_client()
3265
2392
        except (NotImplementedError, AttributeError,
3266
 
                errors.TransportNotPossible, errors.NoSmartMedium,
3267
 
                errors.SmartProtocolError):
 
2393
                errors.TransportNotPossible):
3268
2394
            # no smart server, so not a branch for this format type.
3269
2395
            raise errors.NotBranchError(path=transport.base)
3270
2396
        else:
3271
 
            # Decline to open it if the server doesn't support our required
3272
 
            # version (3) so that the VFS-based transport will do it.
3273
 
            if medium.should_probe():
3274
 
                try:
3275
 
                    server_version = medium.protocol_version()
3276
 
                except errors.SmartProtocolError:
3277
 
                    # Apparently there's no usable smart server there, even though
3278
 
                    # the medium supports the smart protocol.
3279
 
                    raise errors.NotBranchError(path=transport.base)
3280
 
                if server_version != '2':
3281
 
                    raise errors.NotBranchError(path=transport.base)
 
2397
            # Send a 'hello' request in protocol version one, and decline to
 
2398
            # open it if the server doesn't support our required version (2) so
 
2399
            # that the VFS-based transport will do it.
 
2400
            request = client.get_request()
 
2401
            smart_protocol = protocol.SmartClientRequestProtocolOne(request)
 
2402
            server_version = smart_protocol.query_version()
 
2403
            if server_version != 2:
 
2404
                raise errors.NotBranchError(path=transport.base)
3282
2405
            return klass()
3283
2406
 
3284
2407
    def initialize_on_transport(self, transport):
3285
2408
        try:
3286
2409
            # hand off the request to the smart server
3287
 
            client_medium = transport.get_smart_medium()
 
2410
            shared_medium = transport.get_shared_medium()
3288
2411
        except errors.NoSmartMedium:
3289
2412
            # TODO: lookup the local format from a server hint.
3290
2413
            local_dir_format = BzrDirMetaFormat1()
3291
2414
            return local_dir_format.initialize_on_transport(transport)
3292
 
        client = _SmartClient(client_medium)
 
2415
        client = _SmartClient(shared_medium)
3293
2416
        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)
3298
 
        if response[0] != 'ok':
3299
 
            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
 
2417
        response = _SmartClient(shared_medium).call('BzrDirFormat.initialize',
 
2418
                                                    path)
 
2419
        assert response[0] in ('ok', ), 'unexpected response code %s' % (response,)
 
2420
        return remote.RemoteBzrDir(transport)
3449
2421
 
3450
2422
    def _open(self, transport):
3451
 
        return remote.RemoteBzrDir(transport, self)
 
2423
        return remote.RemoteBzrDir(transport)
3452
2424
 
3453
2425
    def __eq__(self, other):
3454
2426
        if not isinstance(other, RemoteBzrDirFormat):
3455
2427
            return False
3456
2428
        return self.get_format_description() == other.get_format_description()
3457
2429
 
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
2430
 
3488
2431
BzrDirFormat.register_control_server_format(RemoteBzrDirFormat)
3489
2432
 
3499
2442
 
3500
2443
class BzrDirFormatRegistry(registry.Registry):
3501
2444
    """Registry of user-selectable BzrDir subformats.
3502
 
 
 
2445
    
3503
2446
    Differs from BzrDirFormat._control_formats in that it provides sub-formats,
3504
2447
    e.g. BzrDirMeta1 with weave repository.  Also, it's more user-oriented.
3505
2448
    """
3507
2450
    def __init__(self):
3508
2451
        """Create a BzrDirFormatRegistry."""
3509
2452
        self._aliases = set()
3510
 
        self._registration_order = list()
3511
2453
        super(BzrDirFormatRegistry, self).__init__()
3512
2454
 
3513
2455
    def aliases(self):
3524
2466
        """Register a metadir subformat.
3525
2467
 
3526
2468
        These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
3527
 
        by the Repository/Branch/WorkingTreeformats.
 
2469
        by the Repository format.
3528
2470
 
3529
2471
        :param repository_format: The fully-qualified repository format class
3530
2472
            name as a string.
3564
2506
    def register(self, key, factory, help, native=True, deprecated=False,
3565
2507
                 hidden=False, experimental=False, alias=False):
3566
2508
        """Register a BzrDirFormat factory.
3567
 
 
 
2509
        
3568
2510
        The factory must be a callable that takes one parameter: the key.
3569
2511
        It must produce an instance of the BzrDirFormat when called.
3570
2512
 
3575
2517
            BzrDirFormatInfo(native, deprecated, hidden, experimental))
3576
2518
        if alias:
3577
2519
            self._aliases.add(key)
3578
 
        self._registration_order.append(key)
3579
2520
 
3580
2521
    def register_lazy(self, key, module_name, member_name, help, native=True,
3581
2522
        deprecated=False, hidden=False, experimental=False, alias=False):
3583
2524
            help, BzrDirFormatInfo(native, deprecated, hidden, experimental))
3584
2525
        if alias:
3585
2526
            self._aliases.add(key)
3586
 
        self._registration_order.append(key)
3587
2527
 
3588
2528
    def set_default(self, key):
3589
2529
        """Set the 'default' key to be a clone of the supplied key.
3590
 
 
 
2530
        
3591
2531
        This method must be called once and only once.
3592
2532
        """
3593
2533
        registry.Registry.register(self, 'default', self.get(key),
3596
2536
 
3597
2537
    def set_default_repository(self, key):
3598
2538
        """Set the FormatRegistry default and Repository default.
3599
 
 
 
2539
        
3600
2540
        This is a transitional method while Repository.set_default_format
3601
2541
        is deprecated.
3602
2542
        """
3604
2544
            self.remove('default')
3605
2545
        self.set_default(key)
3606
2546
        format = self.get('default')()
 
2547
        assert isinstance(format, BzrDirMetaFormat1)
3607
2548
 
3608
2549
    def make_bzrdir(self, key):
3609
2550
        return self.get(key)()
3610
2551
 
3611
2552
    def help_topic(self, topic):
3612
 
        output = ""
 
2553
        output = textwrap.dedent("""\
 
2554
            These formats can be used for creating branches, working trees, and
 
2555
            repositories.
 
2556
 
 
2557
            """)
3613
2558
        default_realkey = None
3614
2559
        default_help = self.get_help('default')
3615
2560
        help_pairs = []
3616
 
        for key in self._registration_order:
 
2561
        for key in self.keys():
3617
2562
            if key == 'default':
3618
2563
                continue
3619
2564
            help = self.get_help(key)
3625
2570
        def wrapped(key, help, info):
3626
2571
            if info.native:
3627
2572
                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))
 
2573
            return ':%s:\n%s\n\n' % (key, 
 
2574
                    textwrap.fill(help, initial_indent='    ', 
 
2575
                    subsequent_indent='    '))
3632
2576
        if default_realkey is not None:
3633
2577
            output += wrapped(default_realkey, '(default) %s' % default_help,
3634
2578
                              self.get_info('default'))
3644
2588
                experimental_pairs.append((key, help))
3645
2589
            else:
3646
2590
                output += wrapped(key, help, info)
3647
 
        output += "\nSee :doc:`formats-help` for more about storage formats."
3648
 
        other_output = ""
3649
2591
        if len(experimental_pairs) > 0:
3650
 
            other_output += "Experimental formats are shown below.\n\n"
 
2592
            output += "Experimental formats are shown below.\n\n"
3651
2593
            for key, help in experimental_pairs:
3652
2594
                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"
 
2595
                output += wrapped(key, help, info)
3657
2596
        if len(deprecated_pairs) > 0:
3658
 
            other_output += "\nDeprecated formats are shown below.\n\n"
 
2597
            output += "Deprecated formats are shown below.\n\n"
3659
2598
            for key, help in deprecated_pairs:
3660
2599
                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."
3667
 
 
3668
 
        if topic == 'other-formats':
3669
 
            return other_output
3670
 
        else:
3671
 
            return output
3672
 
 
3673
 
 
3674
 
class RepositoryAcquisitionPolicy(object):
3675
 
    """Abstract base class for repository acquisition policies.
3676
 
 
3677
 
    A repository acquisition policy decides how a BzrDir acquires a repository
3678
 
    for a branch that is being created.  The most basic policy decision is
3679
 
    whether to create a new repository or use an existing one.
3680
 
    """
3681
 
    def __init__(self, stack_on, stack_on_pwd, require_stacking):
3682
 
        """Constructor.
3683
 
 
3684
 
        :param stack_on: A location to stack on
3685
 
        :param stack_on_pwd: If stack_on is relative, the location it is
3686
 
            relative to.
3687
 
        :param require_stacking: If True, it is a failure to not stack.
3688
 
        """
3689
 
        self._stack_on = stack_on
3690
 
        self._stack_on_pwd = stack_on_pwd
3691
 
        self._require_stacking = require_stacking
3692
 
 
3693
 
    def configure_branch(self, branch):
3694
 
        """Apply any configuration data from this policy to the branch.
3695
 
 
3696
 
        Default implementation sets repository stacking.
3697
 
        """
3698
 
        if self._stack_on is None:
3699
 
            return
3700
 
        if self._stack_on_pwd is None:
3701
 
            stack_on = self._stack_on
3702
 
        else:
3703
 
            try:
3704
 
                stack_on = urlutils.rebase_url(self._stack_on,
3705
 
                    self._stack_on_pwd,
3706
 
                    branch.user_url)
3707
 
            except errors.InvalidRebaseURLs:
3708
 
                stack_on = self._get_full_stack_on()
3709
 
        try:
3710
 
            branch.set_stacked_on_url(stack_on)
3711
 
        except (errors.UnstackableBranchFormat,
3712
 
                errors.UnstackableRepositoryFormat):
3713
 
            if self._require_stacking:
3714
 
                raise
3715
 
 
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
 
    def _get_full_stack_on(self):
3721
 
        """Get a fully-qualified URL for the stack_on location."""
3722
 
        if self._stack_on is None:
3723
 
            return None
3724
 
        if self._stack_on_pwd is None:
3725
 
            return self._stack_on
3726
 
        else:
3727
 
            return urlutils.join(self._stack_on_pwd, self._stack_on)
3728
 
 
3729
 
    def _add_fallback(self, repository, possible_transports=None):
3730
 
        """Add a fallback to the supplied repository, if stacking is set."""
3731
 
        stack_on = self._get_full_stack_on()
3732
 
        if stack_on is None:
3733
 
            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
3741
 
        try:
3742
 
            stacked_repo = stacked_dir.open_branch().repository
3743
 
        except errors.NotBranchError:
3744
 
            stacked_repo = stacked_dir.open_repository()
3745
 
        try:
3746
 
            repository.add_fallback_repository(stacked_repo)
3747
 
        except errors.UnstackableRepositoryFormat:
3748
 
            if self._require_stacking:
3749
 
                raise
3750
 
        else:
3751
 
            self._require_stacking = True
3752
 
 
3753
 
    def acquire_repository(self, make_working_trees=None, shared=False):
3754
 
        """Acquire a repository for this bzrdir.
3755
 
 
3756
 
        Implementations may create a new repository or use a pre-exising
3757
 
        repository.
3758
 
        :param make_working_trees: If creating a repository, set
3759
 
            make_working_trees to this value (if non-None)
3760
 
        :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).
3763
 
        """
3764
 
        raise NotImplemented(RepositoryAcquisitionPolicy.acquire_repository)
3765
 
 
3766
 
 
3767
 
class CreateRepository(RepositoryAcquisitionPolicy):
3768
 
    """A policy of creating a new repository"""
3769
 
 
3770
 
    def __init__(self, bzrdir, stack_on=None, stack_on_pwd=None,
3771
 
                 require_stacking=False):
3772
 
        """
3773
 
        Constructor.
3774
 
        :param bzrdir: The bzrdir to create the repository on.
3775
 
        :param stack_on: A location to stack on
3776
 
        :param stack_on_pwd: If stack_on is relative, the location it is
3777
 
            relative to.
3778
 
        """
3779
 
        RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
3780
 
                                             require_stacking)
3781
 
        self._bzrdir = bzrdir
3782
 
 
3783
 
    def acquire_repository(self, make_working_trees=None, shared=False):
3784
 
        """Implementation of RepositoryAcquisitionPolicy.acquire_repository
3785
 
 
3786
 
        Creates the desired repository in the bzrdir we already have.
3787
 
        """
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])
3800
 
        if make_working_trees is not None:
3801
 
            repository.set_make_working_trees(make_working_trees)
3802
 
        return repository, True
3803
 
 
3804
 
 
3805
 
class UseExistingRepository(RepositoryAcquisitionPolicy):
3806
 
    """A policy of reusing an existing repository"""
3807
 
 
3808
 
    def __init__(self, repository, stack_on=None, stack_on_pwd=None,
3809
 
                 require_stacking=False):
3810
 
        """Constructor.
3811
 
 
3812
 
        :param repository: The repository to use.
3813
 
        :param stack_on: A location to stack on
3814
 
        :param stack_on_pwd: If stack_on is relative, the location it is
3815
 
            relative to.
3816
 
        """
3817
 
        RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
3818
 
                                             require_stacking)
3819
 
        self._repository = repository
3820
 
 
3821
 
    def acquire_repository(self, make_working_trees=None, shared=False):
3822
 
        """Implementation of RepositoryAcquisitionPolicy.acquire_repository
3823
 
 
3824
 
        Returns an existing repository to use.
3825
 
        """
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.
 
2600
                output += wrapped(key, help, info)
 
2601
 
 
2602
        return output
 
2603
 
 
2604
 
3834
2605
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
2606
format_registry.register('weave', BzrDirFormat6,
3839
2607
    'Pre-0.8 format.  Slower than knit and does not'
3840
2608
    ' support checkouts or shared repositories.',
3841
 
    hidden=True,
3842
2609
    deprecated=True)
 
2610
format_registry.register_metadir('knit',
 
2611
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
 
2612
    'Format using knits.  Recommended for interoperation with bzr <= 0.14.',
 
2613
    branch_format='bzrlib.branch.BzrBranchFormat5',
 
2614
    tree_format='bzrlib.workingtree.WorkingTreeFormat3')
3843
2615
format_registry.register_metadir('metaweave',
3844
2616
    'bzrlib.repofmt.weaverepo.RepositoryFormat7',
3845
2617
    'Transitional format in 0.8.  Slower than knit.',
3846
2618
    branch_format='bzrlib.branch.BzrBranchFormat5',
3847
2619
    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
2620
    deprecated=True)
3857
2621
format_registry.register_metadir('dirstate',
3858
2622
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3862
2626
    # this uses bzrlib.workingtree.WorkingTreeFormat4 because importing
3863
2627
    # directly from workingtree_4 triggers a circular import.
3864
2628
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3865
 
    hidden=True,
3866
 
    deprecated=True)
 
2629
    )
3867
2630
format_registry.register_metadir('dirstate-tags',
3868
2631
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3869
2632
    help='New in 0.15: Fast local operations and improved scaling for '
3871
2634
        ' Incompatible with bzr < 0.15.',
3872
2635
    branch_format='bzrlib.branch.BzrBranchFormat6',
3873
2636
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3874
 
    hidden=True,
3875
 
    deprecated=True)
 
2637
    )
3876
2638
format_registry.register_metadir('rich-root',
3877
2639
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
3878
2640
    help='New in 1.0.  Better handling of tree roots.  Incompatible with'
3879
 
        ' bzr < 1.0.',
 
2641
        ' bzr < 1.0',
3880
2642
    branch_format='bzrlib.branch.BzrBranchFormat6',
3881
2643
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3882
 
    hidden=True,
3883
 
    deprecated=True)
 
2644
    )
3884
2645
format_registry.register_metadir('dirstate-with-subtree',
3885
2646
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
3886
2647
    help='New in 0.15: Fast local operations and improved scaling for '
3896
2657
    help='New in 0.92: Pack-based format with data compatible with '
3897
2658
        'dirstate-tags format repositories. Interoperates with '
3898
2659
        'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3899
 
        ,
 
2660
        'Previously called knitpack-experimental.  '
 
2661
        'For more information, see '
 
2662
        'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
3900
2663
    branch_format='bzrlib.branch.BzrBranchFormat6',
3901
2664
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3902
2665
    )
3905
2668
    help='New in 0.92: Pack-based format with data compatible with '
3906
2669
        'dirstate-with-subtree format repositories. Interoperates with '
3907
2670
        'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3908
 
        ,
 
2671
        'Previously called knitpack-experimental.  '
 
2672
        'For more information, see '
 
2673
        'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
3909
2674
    branch_format='bzrlib.branch.BzrBranchFormat6',
3910
2675
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3911
2676
    hidden=True,
3913
2678
    )
3914
2679
format_registry.register_metadir('rich-root-pack',
3915
2680
    '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).',
 
2681
    help='New in 1.0: Pack-based format with data compatible with '
 
2682
        'rich-root format repositories. Incompatible with'
 
2683
        ' bzr < 1.0',
3918
2684
    branch_format='bzrlib.branch.BzrBranchFormat6',
3919
2685
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3920
 
    hidden=True,
3921
 
    )
3922
 
format_registry.register_metadir('1.6',
3923
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5',
3924
 
    help='A format that allows a branch to indicate that there is another '
3925
 
         '(stacked) repository that should be used to access data that is '
3926
 
         'not present locally.',
3927
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3928
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3929
 
    hidden=True,
3930
 
    )
3931
 
format_registry.register_metadir('1.6.1-rich-root',
3932
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5RichRoot',
3933
 
    help='A variant of 1.6 that supports rich-root data '
3934
 
         '(needed for bzr-svn and bzr-git).',
3935
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3936
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3937
 
    hidden=True,
3938
 
    )
3939
 
format_registry.register_metadir('1.9',
3940
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3941
 
    help='A repository format using B+tree indexes. These indexes '
3942
 
         'are smaller in size, have smarter caching and provide faster '
3943
 
         'performance for most operations.',
3944
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3945
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3946
 
    hidden=True,
3947
 
    )
3948
 
format_registry.register_metadir('1.9-rich-root',
3949
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
3950
 
    help='A variant of 1.9 that supports rich-root data '
3951
 
         '(needed for bzr-svn and bzr-git).',
3952
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3953
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3954
 
    hidden=True,
3955
 
    )
3956
 
format_registry.register_metadir('1.14',
3957
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3958
 
    help='A working-tree format that supports content filtering.',
3959
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3960
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat5',
3961
 
    )
3962
 
format_registry.register_metadir('1.14-rich-root',
3963
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
3964
 
    help='A variant of 1.14 that supports rich-root data '
3965
 
         '(needed for bzr-svn and bzr-git).',
3966
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3967
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat5',
3968
 
    )
3969
 
# The following un-numbered 'development' formats should always just be aliases.
3970
 
format_registry.register_metadir('development-rich-root',
3971
 
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
3972
 
    help='Current development format. Supports rich roots. Can convert data '
3973
 
        'to and from rich-root-pack (and anything compatible with '
3974
 
        'rich-root-pack) format repositories. Repositories and branches in '
3975
 
        'this format can only be read by bzr.dev. Please read '
3976
 
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
 
2686
    )
 
2687
# The following two formats should always just be aliases.
 
2688
format_registry.register_metadir('development',
 
2689
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment0',
 
2690
    help='Current development format. Can convert data to and from pack-0.92 '
 
2691
        '(and anything compatible with pack-0.92) format repositories. '
 
2692
        'Repositories in this format can only be read by bzr.dev. '
 
2693
        'Please read '
 
2694
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3977
2695
        'before use.',
3978
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3979
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
 
2696
    branch_format='bzrlib.branch.BzrBranchFormat6',
 
2697
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3980
2698
    experimental=True,
3981
2699
    alias=True,
3982
 
    hidden=True,
3983
2700
    )
3984
2701
format_registry.register_metadir('development-subtree',
3985
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment2Subtree',
 
2702
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment0Subtree',
3986
2703
    help='Current development format, subtree variant. Can convert data to and '
3987
 
        'from pack-0.92-subtree (and anything compatible with '
3988
 
        'pack-0.92-subtree) format repositories. Repositories and branches in '
3989
 
        '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',
 
2704
        'from pack-0.92 (and anything compatible with pack-0.92) format '
 
2705
        'repositories. Repositories in this format can only be read by '
 
2706
        'bzr.dev. Please read '
 
2707
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
 
2708
        'before use.',
 
2709
    branch_format='bzrlib.branch.BzrBranchFormat6',
 
2710
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
2711
    experimental=True,
4044
2712
    alias=True,
4045
 
    hidden=True,
4046
 
    help='Same as 2a.')
4047
 
 
4048
 
# The current format that is made on 'bzr init'.
4049
 
format_registry.set_default('2a')
 
2713
    )
 
2714
# And the development formats which the will have aliased one of follow:
 
2715
format_registry.register_metadir('development0',
 
2716
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment0',
 
2717
    help='Trivial rename of pack-0.92 to provide a development format. '
 
2718
        'Please read '
 
2719
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
 
2720
        'before use.',
 
2721
    branch_format='bzrlib.branch.BzrBranchFormat6',
 
2722
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
2723
    hidden=True,
 
2724
    experimental=True,
 
2725
    )
 
2726
format_registry.register_metadir('development0-subtree',
 
2727
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment0Subtree',
 
2728
    help='Trivial rename of pack-0.92-subtree to provide a development format. '
 
2729
        'Please read '
 
2730
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
 
2731
        'before use.',
 
2732
    branch_format='bzrlib.branch.BzrBranchFormat6',
 
2733
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
2734
    hidden=True,
 
2735
    experimental=True,
 
2736
    )
 
2737
format_registry.set_default('pack-0.92')