/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/bzrdir.py

  • Committer: Martin Albisetti
  • Date: 2008-05-06 00:21:18 UTC
  • mto: (3431.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 3432.
  • Revision ID: argentina@gmail.com-20080506002118-7w9ywklw4khddf3g
Added spanish index

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.cloning_metadir().initialize_on_transport(transport)
 
184
        repository_policy = None
251
185
        try:
252
186
            local_repo = self.find_repository()
253
187
        except errors.NoRepositoryPresent:
254
188
            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
189
        if local_repo:
 
190
            # may need to copy content in
 
191
            repository_policy = result.determine_repository_policy(
 
192
                force_new_repo)
274
193
            make_working_trees = local_repo.make_working_trees()
275
 
            want_shared = local_repo.is_shared()
276
 
            repo_format_name = format.repository_format.network_name()
277
 
        else:
278
 
            make_working_trees = False
279
 
            want_shared = False
280
 
            repo_format_name = None
281
 
 
282
 
        result_repo, result, require_stacking, repository_policy = \
283
 
            format.initialize_on_transport_ex(transport,
284
 
            use_existing_dir=use_existing_dir, create_prefix=create_prefix,
285
 
            force_new_repo=force_new_repo, stacked_on=stacked_on,
286
 
            stack_on_pwd=self.root_transport.base,
287
 
            repo_format_name=repo_format_name,
288
 
            make_working_trees=make_working_trees, shared_repo=want_shared)
289
 
        if repo_format_name:
290
 
            try:
291
 
                # If the result repository is in the same place as the
292
 
                # resulting bzr dir, it will have no content, further if the
293
 
                # result is not stacked then we know all content should be
294
 
                # copied, and finally if we are copying up to a specific
295
 
                # revision_id then we can use the pending-ancestry-result which
296
 
                # does not require traversing all of history to describe it.
297
 
                if (result_repo.user_url == result.user_url
298
 
                    and not require_stacking and
299
 
                    revision_id is not None):
300
 
                    fetch_spec = graph.PendingAncestryResult(
301
 
                        [revision_id], local_repo)
302
 
                    result_repo.fetch(local_repo, fetch_spec=fetch_spec)
303
 
                else:
304
 
                    result_repo.fetch(local_repo, revision_id=revision_id)
305
 
            finally:
306
 
                result_repo.unlock()
307
 
        else:
308
 
            if result_repo is not None:
309
 
                raise AssertionError('result_repo not None(%r)' % result_repo)
 
194
            result_repo = repository_policy.acquire_repository(
 
195
                make_working_trees, local_repo.is_shared())
 
196
            result_repo.fetch(local_repo, revision_id=revision_id)
310
197
        # 1 if there is a branch present
311
198
        #   make sure its content is available in the target repository
312
199
        #   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():
 
200
        try:
 
201
            local_branch = self.open_branch()
 
202
        except errors.NotBranchError:
 
203
            pass
 
204
        else:
 
205
            result_branch = local_branch.clone(result, revision_id=revision_id)
 
206
            if repository_policy is not None:
 
207
                repository_policy.configure_branch(result_branch)
 
208
        try:
 
209
            result_repo = result.find_repository()
 
210
        except errors.NoRepositoryPresent:
 
211
            result_repo = None
 
212
        if result_repo is None or result_repo.make_working_trees():
 
213
            try:
321
214
                self.open_workingtree().clone(result)
322
 
        except (errors.NoWorkingTree, errors.NotLocalUrl):
323
 
            pass
 
215
            except (errors.NoWorkingTree, errors.NotLocalUrl):
 
216
                pass
324
217
        return result
325
218
 
326
219
    # TODO: This should be given a Transport, and should chdir up; otherwise
332
225
    @classmethod
333
226
    def create(cls, base, format=None, possible_transports=None):
334
227
        """Create a new BzrDir at the url 'base'.
335
 
 
 
228
        
336
229
        :param format: If supplied, the format of branch to create.  If not
337
230
            supplied, the default is used.
338
 
        :param possible_transports: If supplied, a list of transports that
 
231
        :param possible_transports: If supplied, a list of transports that 
339
232
            can be reused to share a remote connection.
340
233
        """
341
234
        if cls is not BzrDir:
388
281
                for subdir in sorted(subdirs, reverse=True):
389
282
                    pending.append(current_transport.clone(subdir))
390
283
 
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
284
    @staticmethod
401
285
    def find_branches(transport):
402
286
        """Find all branches under a transport.
414
298
            except errors.NoRepositoryPresent:
415
299
                pass
416
300
            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):
 
301
                return False, (None, repository)
 
302
            try:
 
303
                branch = bzrdir.open_branch()
 
304
            except errors.NotBranchError:
 
305
                return True, (None, None)
 
306
            else:
 
307
                return True, (branch, None)
 
308
        branches = []
 
309
        for branch, repo in BzrDir.find_bzrdirs(transport, evaluate=evaluate):
422
310
            if repo is not None:
423
 
                ret.extend(repo.find_branches())
424
 
            if branches is not None:
425
 
                ret.extend(branches)
426
 
        return ret
 
311
                branches.extend(repo.find_branches())
 
312
            if branch is not None:
 
313
                branches.append(branch)
 
314
        return branches
 
315
 
427
316
 
428
317
    def destroy_repository(self):
429
318
        """Destroy the repository in this BzrDir"""
430
319
        raise NotImplementedError(self.destroy_repository)
431
320
 
432
 
    def create_branch(self, name=None):
 
321
    def create_branch(self):
433
322
        """Create a branch in this BzrDir.
434
323
 
435
 
        :param name: Name of the colocated branch to create, None for
436
 
            the default branch.
437
 
 
438
324
        The bzrdir's format will control what branch format is created.
439
325
        For more control see BranchFormatXX.create(a_bzrdir).
440
326
        """
441
327
        raise NotImplementedError(self.create_branch)
442
328
 
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
 
        """
 
329
    def destroy_branch(self):
 
330
        """Destroy the branch in this BzrDir"""
449
331
        raise NotImplementedError(self.destroy_branch)
450
332
 
451
333
    @staticmethod
453
335
        """Create a new BzrDir, Branch and Repository at the url 'base'.
454
336
 
455
337
        This will use the current default BzrDirFormat unless one is
456
 
        specified, and use whatever
 
338
        specified, and use whatever 
457
339
        repository format that that uses via bzrdir.create_branch and
458
340
        create_repository. If a shared repository is available that is used
459
341
        preferentially.
469
351
        bzrdir._find_or_create_repository(force_new_repo)
470
352
        return bzrdir.create_branch()
471
353
 
472
 
    def determine_repository_policy(self, force_new_repo=False, stack_on=None,
473
 
                                    stack_on_pwd=None, require_stacking=False):
 
354
    def determine_repository_policy(self, force_new_repo=False):
474
355
        """Return an object representing a policy to use.
475
356
 
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.
 
357
        This controls whether a new repository is created, or a shared
 
358
        repository used instead.
486
359
        """
487
360
        def repository_policy(found_bzrdir):
488
 
            stack_on = None
489
 
            stack_on_pwd = None
490
 
            config = found_bzrdir.get_config()
491
361
            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
362
            # does it have a repository ?
497
363
            try:
498
364
                repository = found_bzrdir.open_repository()
499
365
            except errors.NoRepositoryPresent:
500
366
                repository = None
501
367
            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.
 
368
                if ((found_bzrdir.root_transport.base !=
 
369
                     self.root_transport.base) and not repository.is_shared()):
505
370
                    repository = None
506
 
                    stop = True
507
371
                else:
508
372
                    stop = True
509
373
            if not stop:
510
374
                return None, False
511
375
            if repository:
512
 
                return UseExistingRepository(repository, stack_on,
513
 
                    stack_on_pwd, require_stacking=require_stacking), True
 
376
                return UseExistingRepository(repository), True
514
377
            else:
515
 
                return CreateRepository(self, stack_on, stack_on_pwd,
516
 
                    require_stacking=require_stacking), True
 
378
                return CreateRepository(self), True
517
379
 
518
380
        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)
 
381
            policy = self._find_containing(repository_policy)
 
382
            if policy is not None:
 
383
                return policy
 
384
        return CreateRepository(self)
532
385
 
533
386
    def _find_or_create_repository(self, force_new_repo):
534
387
        """Create a new repository if needed, returning the repository."""
535
388
        policy = self.determine_repository_policy(force_new_repo)
536
 
        return policy.acquire_repository()[0]
 
389
        return policy.acquire_repository()
537
390
 
538
391
    @staticmethod
539
392
    def create_branch_convenience(base, force_new_repo=False,
546
399
        not.
547
400
 
548
401
        This will use the current default BzrDirFormat unless one is
549
 
        specified, and use whatever
 
402
        specified, and use whatever 
550
403
        repository format that that uses via bzrdir.create_branch and
551
404
        create_repository. If a shared repository is available that is used
552
405
        preferentially. Whatever repository is used, its tree creation policy
554
407
 
555
408
        The created Branch object is returned.
556
409
        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
 
410
        no error is raised unless force_new_tree is True, in which case no 
558
411
        data is created on disk and NotLocalUrl is raised.
559
412
 
560
413
        :param base: The URL to create the branch at.
561
414
        :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
 
415
        :param force_new_tree: If True or False force creation of a tree or 
563
416
                               prevent such creation respectively.
564
417
        :param format: Override for the bzrdir format to create.
565
418
        :param possible_transports: An optional reusable transports list.
567
420
        if force_new_tree:
568
421
            # check for non local urls
569
422
            t = get_transport(base, possible_transports)
570
 
            if not isinstance(t, local.LocalTransport):
 
423
            if not isinstance(t, LocalTransport):
571
424
                raise errors.NotLocalUrl(base)
572
425
        bzrdir = BzrDir.create(base, format, possible_transports)
573
426
        repo = bzrdir._find_or_create_repository(force_new_repo)
581
434
        return result
582
435
 
583
436
    @staticmethod
 
437
    @deprecated_function(zero_ninetyone)
 
438
    def create_repository(base, shared=False, format=None):
 
439
        """Create a new BzrDir and Repository at the url 'base'.
 
440
 
 
441
        If no format is supplied, this will default to the current default
 
442
        BzrDirFormat by default, and use whatever repository format that that
 
443
        uses for bzrdirformat.create_repository.
 
444
 
 
445
        :param shared: Create a shared repository rather than a standalone
 
446
                       repository.
 
447
        The Repository object is returned.
 
448
 
 
449
        This must be overridden as an instance method in child classes, where
 
450
        it should take no parameters and construct whatever repository format
 
451
        that child class desires.
 
452
 
 
453
        This method is deprecated, please call create_repository on a bzrdir
 
454
        instance instead.
 
455
        """
 
456
        bzrdir = BzrDir.create(base, format)
 
457
        return bzrdir.create_repository(shared)
 
458
 
 
459
    @staticmethod
584
460
    def create_standalone_workingtree(base, format=None):
585
461
        """Create a new BzrDir, WorkingTree, Branch and Repository at 'base'.
586
462
 
587
463
        'base' must be a local path or a file:// url.
588
464
 
589
465
        This will use the current default BzrDirFormat unless one is
590
 
        specified, and use whatever
 
466
        specified, and use whatever 
591
467
        repository format that that uses for bzrdirformat.create_workingtree,
592
468
        create_branch and create_repository.
593
469
 
595
471
        :return: The WorkingTree object.
596
472
        """
597
473
        t = get_transport(base)
598
 
        if not isinstance(t, local.LocalTransport):
 
474
        if not isinstance(t, LocalTransport):
599
475
            raise errors.NotLocalUrl(base)
600
476
        bzrdir = BzrDir.create_branch_and_repo(base,
601
477
                                               force_new_repo=True,
605
481
    def create_workingtree(self, revision_id=None, from_branch=None,
606
482
        accelerator_tree=None, hardlink=False):
607
483
        """Create a working tree at this BzrDir.
608
 
 
 
484
        
609
485
        :param revision_id: create it as of this revision id.
610
486
        :param from_branch: override bzrdir branch (for lightweight checkouts)
611
487
        :param accelerator_tree: A tree which can be used for retrieving file
615
491
        """
616
492
        raise NotImplementedError(self.create_workingtree)
617
493
 
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
494
    def retire_bzrdir(self, limit=10000):
647
495
        """Permanently disable the bzrdir.
648
496
 
702
550
            if stop:
703
551
                return result
704
552
            next_transport = found_bzrdir.root_transport.clone('..')
705
 
            if (found_bzrdir.user_url == next_transport.base):
 
553
            if (found_bzrdir.root_transport.base == next_transport.base):
706
554
                # top of the file system
707
555
                return None
708
556
            # find the next containing bzrdir
725
573
                repository = found_bzrdir.open_repository()
726
574
            except errors.NoRepositoryPresent:
727
575
                return None, False
728
 
            if found_bzrdir.user_url == self.user_url:
 
576
            if found_bzrdir.root_transport.base == self.root_transport.base:
729
577
                return repository, True
730
578
            elif repository.is_shared():
731
579
                return repository, True
737
585
            raise errors.NoRepositoryPresent(self)
738
586
        return found_repo
739
587
 
740
 
    def get_branch_reference(self, name=None):
 
588
    def get_branch_reference(self):
741
589
        """Return the referenced URL for the branch in this bzrdir.
742
590
 
743
 
        :param name: Optional colocated branch name
744
591
        :raises NotBranchError: If there is no Branch.
745
 
        :raises NoColocatedBranchSupport: If a branch name was specified
746
 
            but colocated branches are not supported.
747
592
        :return: The URL the branch in this bzrdir references if it is a
748
593
            reference branch, or None for regular branches.
749
594
        """
750
 
        if name is not None:
751
 
            raise errors.NoColocatedBranchSupport(self)
752
595
        return None
753
596
 
754
 
    def get_branch_transport(self, branch_format, name=None):
 
597
    def get_branch_transport(self, branch_format):
755
598
        """Get the transport for use by branch format in this BzrDir.
756
599
 
757
600
        Note that bzr dirs that do not support format strings will raise
758
601
        IncompatibleFormat if the branch format they are given has
759
602
        a format string, and vice versa.
760
603
 
761
 
        If branch_format is None, the transport is returned with no
 
604
        If branch_format is None, the transport is returned with no 
762
605
        checking. If it is not None, then the returned transport is
763
606
        guaranteed to point to an existing directory ready for use.
764
607
        """
765
608
        raise NotImplementedError(self.get_branch_transport)
766
 
 
767
 
    def _find_creation_modes(self):
768
 
        """Determine the appropriate modes for files and directories.
769
 
 
770
 
        They're always set to be consistent with the base directory,
771
 
        assuming that this transport allows setting modes.
772
 
        """
773
 
        # TODO: Do we need or want an option (maybe a config setting) to turn
774
 
        # this off or override it for particular locations? -- mbp 20080512
775
 
        if self._mode_check_done:
776
 
            return
777
 
        self._mode_check_done = True
778
 
        try:
779
 
            st = self.transport.stat('.')
780
 
        except errors.TransportNotPossible:
781
 
            self._dir_mode = None
782
 
            self._file_mode = None
783
 
        else:
784
 
            # Check the directory mode, but also make sure the created
785
 
            # directories and files are read-write for this user. This is
786
 
            # mostly a workaround for filesystems which lie about being able to
787
 
            # write to a directory (cygwin & win32)
788
 
            if (st.st_mode & 07777 == 00000):
789
 
                # FTP allows stat but does not return dir/file modes
790
 
                self._dir_mode = None
791
 
                self._file_mode = None
792
 
            else:
793
 
                self._dir_mode = (st.st_mode & 07777) | 00700
794
 
                # Remove the sticky and execute bits for files
795
 
                self._file_mode = self._dir_mode & ~07111
796
 
 
797
 
    def _get_file_mode(self):
798
 
        """Return Unix mode for newly created files, or None.
799
 
        """
800
 
        if not self._mode_check_done:
801
 
            self._find_creation_modes()
802
 
        return self._file_mode
803
 
 
804
 
    def _get_dir_mode(self):
805
 
        """Return Unix mode for newly created directories, or None.
806
 
        """
807
 
        if not self._mode_check_done:
808
 
            self._find_creation_modes()
809
 
        return self._dir_mode
810
 
 
 
609
        
811
610
    def get_repository_transport(self, repository_format):
812
611
        """Get the transport for use by repository format in this BzrDir.
813
612
 
815
614
        IncompatibleFormat if the repository format they are given has
816
615
        a format string, and vice versa.
817
616
 
818
 
        If repository_format is None, the transport is returned with no
 
617
        If repository_format is None, the transport is returned with no 
819
618
        checking. If it is not None, then the returned transport is
820
619
        guaranteed to point to an existing directory ready for use.
821
620
        """
822
621
        raise NotImplementedError(self.get_repository_transport)
823
 
 
 
622
        
824
623
    def get_workingtree_transport(self, tree_format):
825
624
        """Get the transport for use by workingtree format in this BzrDir.
826
625
 
828
627
        IncompatibleFormat if the workingtree format they are given has a
829
628
        format string, and vice versa.
830
629
 
831
 
        If workingtree_format is None, the transport is returned with no
 
630
        If workingtree_format is None, the transport is returned with no 
832
631
        checking. If it is not None, then the returned transport is
833
632
        guaranteed to point to an existing directory ready for use.
834
633
        """
835
634
        raise NotImplementedError(self.get_workingtree_transport)
836
 
 
837
 
    def get_config(self):
838
 
        """Get configuration for this BzrDir."""
839
 
        return config.BzrDirConfig(self)
840
 
 
841
 
    def _get_config(self):
842
 
        """By default, no configuration is available."""
843
 
        return None
844
 
 
 
635
        
845
636
    def __init__(self, _transport, _format):
846
637
        """Initialize a Bzr control dir object.
847
 
 
 
638
        
848
639
        Only really common logic should reside here, concrete classes should be
849
640
        made with varying behaviours.
850
641
 
852
643
        :param _transport: the transport this dir is based at.
853
644
        """
854
645
        self._format = _format
855
 
        # these are also under the more standard names of 
856
 
        # control_transport and user_transport
857
646
        self.transport = _transport.clone('.bzr')
858
647
        self.root_transport = _transport
859
 
        self._mode_check_done = False
860
 
        
861
 
    @property 
862
 
    def user_transport(self):
863
 
        return self.root_transport
864
 
        
865
 
    @property
866
 
    def control_transport(self):
867
 
        return self.transport
868
648
 
869
649
    def is_control_filename(self, filename):
870
650
        """True if filename is the name of a path which is reserved for bzrdir's.
871
 
 
 
651
        
872
652
        :param filename: A filename within the root transport of this bzrdir.
873
653
 
874
654
        This is true IF and ONLY IF the filename is part of the namespace reserved
877
657
        this in the future - for instance to make bzr talk with svn working
878
658
        trees.
879
659
        """
880
 
        # this might be better on the BzrDirFormat class because it refers to
881
 
        # all the possible bzrdir disk formats.
882
 
        # This method is tested via the workingtree is_control_filename tests-
 
660
        # this might be better on the BzrDirFormat class because it refers to 
 
661
        # all the possible bzrdir disk formats. 
 
662
        # This method is tested via the workingtree is_control_filename tests- 
883
663
        # it was extracted from WorkingTree.is_control_filename. If the method's
884
664
        # contract is extended beyond the current trivial implementation, please
885
665
        # add new tests for it to the appropriate place.
887
667
 
888
668
    def needs_format_conversion(self, format=None):
889
669
        """Return true if this bzrdir needs convert_format run on it.
890
 
 
891
 
        For instance, if the repository format is out of date but the
 
670
        
 
671
        For instance, if the repository format is out of date but the 
892
672
        branch and working tree are not, this should return True.
893
673
 
894
674
        :param format: Optional parameter indicating a specific desired
900
680
    def open_unsupported(base):
901
681
        """Open a branch which is not supported."""
902
682
        return BzrDir.open(base, _unsupported=True)
903
 
 
 
683
        
904
684
    @staticmethod
905
685
    def open(base, _unsupported=False, possible_transports=None):
906
686
        """Open an existing bzrdir, rooted at 'base' (url).
907
 
 
 
687
        
908
688
        :param _unsupported: a private parameter to the BzrDir class.
909
689
        """
910
690
        t = get_transport(base, possible_transports=possible_transports)
918
698
        :param transport: Transport containing the bzrdir.
919
699
        :param _unsupported: private.
920
700
        """
921
 
        for hook in BzrDir.hooks['pre_open']:
922
 
            hook(transport)
923
 
        # Keep initial base since 'transport' may be modified while following
924
 
        # the redirections.
925
701
        base = transport.base
 
702
 
926
703
        def find_format(transport):
927
704
            return transport, BzrDirFormat.find_format(
928
705
                transport, _server_formats=_server_formats)
929
706
 
930
707
        def redirected(transport, e, redirection_notice):
931
 
            redirected_transport = transport._redirected_to(e.source, e.target)
932
 
            if redirected_transport is None:
933
 
                raise errors.NotBranchError(base)
 
708
            qualified_source = e.get_source_url()
 
709
            relpath = transport.relpath(qualified_source)
 
710
            if not e.target.endswith(relpath):
 
711
                # Not redirected to a branch-format, not a branch
 
712
                raise errors.NotBranchError(path=e.target)
 
713
            target = e.target[:-len(relpath)]
934
714
            note('%s is%s redirected to %s',
935
 
                 transport.base, e.permanently, redirected_transport.base)
936
 
            return redirected_transport
 
715
                 transport.base, e.permanently, target)
 
716
            # Let's try with a new transport
 
717
            # FIXME: If 'transport' has a qualifier, this should
 
718
            # be applied again to the new transport *iff* the
 
719
            # schemes used are the same. Uncomment this code
 
720
            # once the function (and tests) exist.
 
721
            # -- vila20070212
 
722
            #target = urlutils.copy_url_qualifiers(original, target)
 
723
            return get_transport(target)
937
724
 
938
725
        try:
939
726
            transport, format = do_catching_redirections(find_format,
945
732
        BzrDir._check_supported(format, _unsupported)
946
733
        return format.open(transport, _found=True)
947
734
 
948
 
    def open_branch(self, name=None, unsupported=False,
949
 
                    ignore_fallbacks=False):
 
735
    def open_branch(self, unsupported=False):
950
736
        """Open the branch object at this BzrDir if one is present.
951
737
 
952
738
        If unsupported is True, then no longer supported branch formats can
953
739
        still be opened.
954
 
 
 
740
        
955
741
        TODO: static convenience version of this?
956
742
        """
957
743
        raise NotImplementedError(self.open_branch)
959
745
    @staticmethod
960
746
    def open_containing(url, possible_transports=None):
961
747
        """Open an existing branch which contains url.
962
 
 
 
748
        
963
749
        :param url: url to search from.
964
750
        See open_containing_from_transport for more detail.
965
751
        """
966
752
        transport = get_transport(url, possible_transports)
967
753
        return BzrDir.open_containing_from_transport(transport)
968
 
 
 
754
    
969
755
    @staticmethod
970
756
    def open_containing_from_transport(a_transport):
971
757
        """Open an existing branch which contains a_transport.base.
974
760
 
975
761
        Basically we keep looking up until we find the control directory or
976
762
        run into the root.  If there isn't one, raises NotBranchError.
977
 
        If there is one and it is either an unrecognised format or an unsupported
 
763
        If there is one and it is either an unrecognised format or an unsupported 
978
764
        format, UnknownFormatError or UnsupportedFormatError are raised.
979
765
        If there is one, it is returned, along with the unused portion of url.
980
766
 
981
 
        :return: The BzrDir that contains the path, and a Unicode path
 
767
        :return: The BzrDir that contains the path, and a Unicode path 
982
768
                for the rest of the URL.
983
769
        """
984
770
        # this gets the normalised url back. I.e. '.' -> the full path.
999
785
                raise errors.NotBranchError(path=url)
1000
786
            a_transport = new_t
1001
787
 
1002
 
    def _get_tree_branch(self, name=None):
 
788
    def _get_tree_branch(self):
1003
789
        """Return the branch and tree, if any, for this bzrdir.
1004
790
 
1005
 
        :param name: Name of colocated branch to open.
1006
 
 
1007
791
        Return None for tree if not present or inaccessible.
1008
792
        Raise NotBranchError if no branch is present.
1009
793
        :return: (tree, branch)
1012
796
            tree = self.open_workingtree()
1013
797
        except (errors.NoWorkingTree, errors.NotLocalUrl):
1014
798
            tree = None
1015
 
            branch = self.open_branch(name=name)
 
799
            branch = self.open_branch()
1016
800
        else:
1017
 
            if name is not None:
1018
 
                branch = self.open_branch(name=name)
1019
 
            else:
1020
 
                branch = tree.branch
 
801
            branch = tree.branch
1021
802
        return tree, branch
1022
803
 
1023
804
    @classmethod
1046
827
        tree, branch = bzrdir._get_tree_branch()
1047
828
        return tree, branch, relpath
1048
829
 
1049
 
    @classmethod
1050
 
    def open_containing_tree_branch_or_repository(klass, location):
1051
 
        """Return the working tree, branch and repo contained by a location.
1052
 
 
1053
 
        Returns (tree, branch, repository, relpath).
1054
 
        If there is no tree containing the location, tree will be None.
1055
 
        If there is no branch containing the location, branch will be None.
1056
 
        If there is no repository containing the location, repository will be
1057
 
        None.
1058
 
        relpath is the portion of the path that is contained by the innermost
1059
 
        BzrDir.
1060
 
 
1061
 
        If no tree, branch or repository is found, a NotBranchError is raised.
1062
 
        """
1063
 
        bzrdir, relpath = klass.open_containing(location)
1064
 
        try:
1065
 
            tree, branch = bzrdir._get_tree_branch()
1066
 
        except errors.NotBranchError:
1067
 
            try:
1068
 
                repo = bzrdir.find_repository()
1069
 
                return None, None, repo, relpath
1070
 
            except (errors.NoRepositoryPresent):
1071
 
                raise errors.NotBranchError(location)
1072
 
        return tree, branch, branch.repository, relpath
1073
 
 
1074
830
    def open_repository(self, _unsupported=False):
1075
831
        """Open the repository object at this BzrDir if one is present.
1076
832
 
1095
851
        """
1096
852
        raise NotImplementedError(self.open_workingtree)
1097
853
 
1098
 
    def has_branch(self, name=None):
 
854
    def has_branch(self):
1099
855
        """Tell if this bzrdir contains a branch.
1100
 
 
 
856
        
1101
857
        Note: if you're going to open the branch, you should just go ahead
1102
 
        and try, and not ask permission first.  (This method just opens the
1103
 
        branch and discards it, and that's somewhat expensive.)
 
858
        and try, and not ask permission first.  (This method just opens the 
 
859
        branch and discards it, and that's somewhat expensive.) 
1104
860
        """
1105
861
        try:
1106
 
            self.open_branch(name)
 
862
            self.open_branch()
1107
863
            return True
1108
864
        except errors.NotBranchError:
1109
865
            return False
1113
869
 
1114
870
        This will still raise an exception if the bzrdir has a workingtree that
1115
871
        is remote & inaccessible.
1116
 
 
 
872
        
1117
873
        Note: if you're going to open the working tree, you should just go ahead
1118
 
        and try, and not ask permission first.  (This method just opens the
1119
 
        workingtree and discards it, and that's somewhat expensive.)
 
874
        and try, and not ask permission first.  (This method just opens the 
 
875
        workingtree and discards it, and that's somewhat expensive.) 
1120
876
        """
1121
877
        try:
1122
878
            self.open_workingtree(recommend_upgrade=False)
1125
881
            return False
1126
882
 
1127
883
    def _cloning_metadir(self):
1128
 
        """Produce a metadir suitable for cloning with.
1129
 
 
1130
 
        :returns: (destination_bzrdir_format, source_repository)
1131
 
        """
 
884
        """Produce a metadir suitable for cloning with."""
1132
885
        result_format = self._format.__class__()
1133
886
        try:
1134
887
            try:
1135
 
                branch = self.open_branch(ignore_fallbacks=True)
 
888
                branch = self.open_branch()
1136
889
                source_repository = branch.repository
1137
 
                result_format._branch_format = branch._format
1138
890
            except errors.NotBranchError:
1139
891
                source_branch = None
1140
892
                source_repository = self.open_repository()
1145
897
            # the fix recommended in bug # 103195 - to delegate this choice the
1146
898
            # repository itself.
1147
899
            repo_format = source_repository._format
1148
 
            if isinstance(repo_format, remote.RemoteRepositoryFormat):
1149
 
                source_repository._ensure_real()
1150
 
                repo_format = source_repository._real_repository._format
1151
 
            result_format.repository_format = repo_format
 
900
            if not isinstance(repo_format, remote.RemoteRepositoryFormat):
 
901
                result_format.repository_format = repo_format
1152
902
        try:
1153
903
            # TODO: Couldn't we just probe for the format in these cases,
1154
904
            # rather than opening the whole tree?  It would be a little
1160
910
            result_format.workingtree_format = tree._format.__class__()
1161
911
        return result_format, source_repository
1162
912
 
1163
 
    def cloning_metadir(self, require_stacking=False):
 
913
    def cloning_metadir(self):
1164
914
        """Produce a metadir suitable for cloning or sprouting with.
1165
915
 
1166
916
        These operations may produce workingtrees (yes, even though they're
1167
917
        "cloning" something that doesn't have a tree), so a viable workingtree
1168
918
        format must be selected.
1169
 
 
1170
 
        :require_stacking: If True, non-stackable formats will be upgraded
1171
 
            to similar stackable formats.
1172
 
        :returns: a BzrDirFormat with all component formats either set
1173
 
            appropriately or set to None if that component should not be
1174
 
            created.
1175
919
        """
1176
920
        format, repository = self._cloning_metadir()
1177
921
        if format._workingtree_format is None:
1178
 
            # No tree in self.
1179
922
            if repository is None:
1180
 
                # No repository either
1181
923
                return format
1182
 
            # We have a repository, so set a working tree? (Why? This seems to
1183
 
            # contradict the stated return value in the docstring).
1184
924
            tree_format = repository._format._matchingbzrdir.workingtree_format
1185
925
            format.workingtree_format = tree_format.__class__()
1186
 
        if require_stacking:
1187
 
            format.require_stacking()
1188
926
        return format
1189
927
 
1190
928
    def checkout_metadir(self):
1192
930
 
1193
931
    def sprout(self, url, revision_id=None, force_new_repo=False,
1194
932
               recurse='down', possible_transports=None,
1195
 
               accelerator_tree=None, hardlink=False, stacked=False,
1196
 
               source_branch=None, create_tree_if_local=True):
 
933
               accelerator_tree=None, hardlink=False):
1197
934
        """Create a copy of this bzrdir prepared for use as a new line of
1198
935
        development.
1199
936
 
1212
949
            content is different.
1213
950
        :param hardlink: If true, hard-link files from accelerator_tree,
1214
951
            where possible.
1215
 
        :param stacked: If true, create a stacked branch referring to the
1216
 
            location of this control directory.
1217
 
        :param create_tree_if_local: If true, a working-tree will be created
1218
 
            when working locally.
1219
952
        """
1220
953
        target_transport = get_transport(url, possible_transports)
1221
954
        target_transport.ensure_base()
1222
 
        cloning_format = self.cloning_metadir(stacked)
1223
 
        # Create/update the result branch
 
955
        cloning_format = self.cloning_metadir()
1224
956
        result = cloning_format.initialize_on_transport(target_transport)
1225
 
        # if a stacked branch wasn't requested, we don't create one
1226
 
        # even if the origin was stacked
1227
 
        stacked_branch_url = None
1228
 
        if source_branch is not None:
1229
 
            if stacked:
1230
 
                stacked_branch_url = self.root_transport.base
 
957
        try:
 
958
            source_branch = self.open_branch()
1231
959
            source_repository = source_branch.repository
1232
 
        else:
1233
 
            try:
1234
 
                source_branch = self.open_branch()
1235
 
                source_repository = source_branch.repository
1236
 
                if stacked:
1237
 
                    stacked_branch_url = self.root_transport.base
1238
 
            except errors.NotBranchError:
1239
 
                source_branch = None
1240
 
                try:
1241
 
                    source_repository = self.open_repository()
1242
 
                except errors.NoRepositoryPresent:
1243
 
                    source_repository = None
1244
 
        repository_policy = result.determine_repository_policy(
1245
 
            force_new_repo, stacked_branch_url, require_stacking=stacked)
1246
 
        result_repo, is_new_repo = repository_policy.acquire_repository()
1247
 
        if is_new_repo and revision_id is not None and not stacked:
1248
 
            fetch_spec = graph.PendingAncestryResult(
1249
 
                [revision_id], source_repository)
1250
 
        else:
1251
 
            fetch_spec = None
1252
 
        if source_repository is not None:
1253
 
            # Fetch while stacked to prevent unstacked fetch from
1254
 
            # Branch.sprout.
1255
 
            if fetch_spec is None:
 
960
        except errors.NotBranchError:
 
961
            source_branch = None
 
962
            try:
 
963
                source_repository = self.open_repository()
 
964
            except errors.NoRepositoryPresent:
 
965
                source_repository = None
 
966
        if force_new_repo:
 
967
            result_repo = None
 
968
        else:
 
969
            try:
 
970
                result_repo = result.find_repository()
 
971
            except errors.NoRepositoryPresent:
 
972
                result_repo = None
 
973
        if source_repository is None and result_repo is not None:
 
974
            pass
 
975
        elif source_repository is None and result_repo is None:
 
976
            # no repo available, make a new one
 
977
            result.create_repository()
 
978
        elif source_repository is not None and result_repo is None:
 
979
            # have source, and want to make a new target repo
 
980
            result_repo = source_repository.sprout(result,
 
981
                                                   revision_id=revision_id)
 
982
        else:
 
983
            # fetch needed content into target.
 
984
            if source_repository is not None:
 
985
                # would rather do 
 
986
                # source_repository.copy_content_into(result_repo,
 
987
                #                                     revision_id=revision_id)
 
988
                # so we can override the copy method
1256
989
                result_repo.fetch(source_repository, revision_id=revision_id)
1257
 
            else:
1258
 
                result_repo.fetch(source_repository, fetch_spec=fetch_spec)
1259
 
 
1260
 
        if source_branch is None:
1261
 
            # this is for sprouting a bzrdir without a branch; is that
1262
 
            # actually useful?
1263
 
            # Not especially, but it's part of the contract.
1264
 
            result_branch = result.create_branch()
 
990
        if source_branch is not None:
 
991
            source_branch.sprout(result, revision_id=revision_id)
1265
992
        else:
1266
 
            result_branch = source_branch.sprout(result,
1267
 
                revision_id=revision_id, repository_policy=repository_policy)
1268
 
        mutter("created new branch %r" % (result_branch,))
1269
 
 
1270
 
        # Create/update the result working tree
1271
 
        if (create_tree_if_local and
1272
 
            isinstance(target_transport, local.LocalTransport) and
1273
 
            (result_repo is None or result_repo.make_working_trees())):
 
993
            result.create_branch()
 
994
        if isinstance(target_transport, LocalTransport) and (
 
995
            result_repo is None or result_repo.make_working_trees()):
1274
996
            wt = result.create_workingtree(accelerator_tree=accelerator_tree,
1275
997
                hardlink=hardlink)
1276
998
            wt.lock_write()
1289
1011
                basis = wt.basis_tree()
1290
1012
                basis.lock_read()
1291
1013
                subtrees = basis.iter_references()
1292
 
            elif result_branch is not None:
1293
 
                basis = result_branch.basis_tree()
1294
 
                basis.lock_read()
1295
 
                subtrees = basis.iter_references()
 
1014
                recurse_branch = wt.branch
1296
1015
            elif source_branch is not None:
1297
1016
                basis = source_branch.basis_tree()
1298
1017
                basis.lock_read()
1299
1018
                subtrees = basis.iter_references()
 
1019
                recurse_branch = source_branch
1300
1020
            else:
1301
1021
                subtrees = []
1302
1022
                basis = None
1306
1026
                    sublocation = source_branch.reference_parent(file_id, path)
1307
1027
                    sublocation.bzrdir.sprout(target,
1308
1028
                        basis.get_reference_revision(file_id, path),
1309
 
                        force_new_repo=force_new_repo, recurse=recurse,
1310
 
                        stacked=stacked)
 
1029
                        force_new_repo=force_new_repo, recurse=recurse)
1311
1030
            finally:
1312
1031
                if basis is not None:
1313
1032
                    basis.unlock()
1314
1033
        return result
1315
1034
 
1316
 
    def push_branch(self, source, revision_id=None, overwrite=False, 
1317
 
        remember=False, create_prefix=False):
1318
 
        """Push the source branch into this BzrDir."""
1319
 
        br_to = None
1320
 
        # If we can open a branch, use its direct repository, otherwise see
1321
 
        # if there is a repository without a branch.
1322
 
        try:
1323
 
            br_to = self.open_branch()
1324
 
        except errors.NotBranchError:
1325
 
            # Didn't find a branch, can we find a repository?
1326
 
            repository_to = self.find_repository()
1327
 
        else:
1328
 
            # Found a branch, so we must have found a repository
1329
 
            repository_to = br_to.repository
1330
 
 
1331
 
        push_result = PushResult()
1332
 
        push_result.source_branch = source
1333
 
        if br_to is None:
1334
 
            # We have a repository but no branch, copy the revisions, and then
1335
 
            # create a branch.
1336
 
            repository_to.fetch(source.repository, revision_id=revision_id)
1337
 
            br_to = source.clone(self, revision_id=revision_id)
1338
 
            if source.get_push_location() is None or remember:
1339
 
                source.set_push_location(br_to.base)
1340
 
            push_result.stacked_on = None
1341
 
            push_result.branch_push_result = None
1342
 
            push_result.old_revno = None
1343
 
            push_result.old_revid = _mod_revision.NULL_REVISION
1344
 
            push_result.target_branch = br_to
1345
 
            push_result.master_branch = None
1346
 
            push_result.workingtree_updated = False
1347
 
        else:
1348
 
            # We have successfully opened the branch, remember if necessary:
1349
 
            if source.get_push_location() is None or remember:
1350
 
                source.set_push_location(br_to.base)
1351
 
            try:
1352
 
                tree_to = self.open_workingtree()
1353
 
            except errors.NotLocalUrl:
1354
 
                push_result.branch_push_result = source.push(br_to, 
1355
 
                    overwrite, stop_revision=revision_id)
1356
 
                push_result.workingtree_updated = False
1357
 
            except errors.NoWorkingTree:
1358
 
                push_result.branch_push_result = source.push(br_to,
1359
 
                    overwrite, stop_revision=revision_id)
1360
 
                push_result.workingtree_updated = None # Not applicable
1361
 
            else:
1362
 
                tree_to.lock_write()
1363
 
                try:
1364
 
                    push_result.branch_push_result = source.push(
1365
 
                        tree_to.branch, overwrite, stop_revision=revision_id)
1366
 
                    tree_to.update()
1367
 
                finally:
1368
 
                    tree_to.unlock()
1369
 
                push_result.workingtree_updated = True
1370
 
            push_result.old_revno = push_result.branch_push_result.old_revno
1371
 
            push_result.old_revid = push_result.branch_push_result.old_revid
1372
 
            push_result.target_branch = \
1373
 
                push_result.branch_push_result.target_branch
1374
 
        return push_result
1375
 
 
1376
 
 
1377
 
class BzrDirHooks(hooks.Hooks):
1378
 
    """Hooks for BzrDir operations."""
1379
 
 
1380
 
    def __init__(self):
1381
 
        """Create the default hooks."""
1382
 
        hooks.Hooks.__init__(self)
1383
 
        self.create_hook(hooks.HookPoint('pre_open',
1384
 
            "Invoked before attempting to open a BzrDir with the transport "
1385
 
            "that the open will use.", (1, 14), None))
1386
 
        self.create_hook(hooks.HookPoint('post_repo_init',
1387
 
            "Invoked after a repository has been initialized. "
1388
 
            "post_repo_init is called with a "
1389
 
            "bzrlib.bzrdir.RepoInitHookParams.",
1390
 
            (2, 2), None))
1391
 
 
1392
 
# install the default hooks
1393
 
BzrDir.hooks = BzrDirHooks()
1394
 
 
1395
 
 
1396
 
class RepoInitHookParams(object):
1397
 
    """Object holding parameters passed to *_repo_init hooks.
1398
 
 
1399
 
    There are 4 fields that hooks may wish to access:
1400
 
 
1401
 
    :ivar repository: Repository created
1402
 
    :ivar format: Repository format
1403
 
    :ivar bzrdir: The bzrdir for the repository
1404
 
    :ivar shared: The repository is shared
1405
 
    """
1406
 
 
1407
 
    def __init__(self, repository, format, a_bzrdir, shared):
1408
 
        """Create a group of RepoInitHook parameters.
1409
 
 
1410
 
        :param repository: Repository created
1411
 
        :param format: Repository format
1412
 
        :param bzrdir: The bzrdir for the repository
1413
 
        :param shared: The repository is shared
1414
 
        """
1415
 
        self.repository = repository
1416
 
        self.format = format
1417
 
        self.bzrdir = a_bzrdir
1418
 
        self.shared = shared
1419
 
 
1420
 
    def __eq__(self, other):
1421
 
        return self.__dict__ == other.__dict__
1422
 
 
1423
 
    def __repr__(self):
1424
 
        if self.repository:
1425
 
            return "<%s for %s>" % (self.__class__.__name__,
1426
 
                self.repository)
1427
 
        else:
1428
 
            return "<%s for %s>" % (self.__class__.__name__,
1429
 
                self.bzrdir)
1430
 
 
1431
1035
 
1432
1036
class BzrDirPreSplitOut(BzrDir):
1433
1037
    """A common class for the all-in-one formats."""
1435
1039
    def __init__(self, _transport, _format):
1436
1040
        """See BzrDir.__init__."""
1437
1041
        super(BzrDirPreSplitOut, self).__init__(_transport, _format)
 
1042
        assert self._format._lock_class == lockable_files.TransportLock
 
1043
        assert self._format._lock_file_name == 'branch-lock'
1438
1044
        self._control_files = lockable_files.LockableFiles(
1439
1045
                                            self.get_branch_transport(None),
1440
1046
                                            self._format._lock_file_name,
1444
1050
        """Pre-splitout bzrdirs do not suffer from stale locks."""
1445
1051
        raise NotImplementedError(self.break_lock)
1446
1052
 
1447
 
    def cloning_metadir(self, require_stacking=False):
 
1053
    def cloning_metadir(self):
1448
1054
        """Produce a metadir suitable for cloning with."""
1449
 
        if require_stacking:
1450
 
            return format_registry.make_bzrdir('1.6')
1451
1055
        return self._format.__class__()
1452
1056
 
1453
 
    def clone(self, url, revision_id=None, force_new_repo=False,
1454
 
              preserve_stacking=False):
1455
 
        """See BzrDir.clone().
1456
 
 
1457
 
        force_new_repo has no effect, since this family of formats always
1458
 
        require a new repository.
1459
 
        preserve_stacking has no effect, since no source branch using this
1460
 
        family of formats can be stacked, so there is no stacking to preserve.
1461
 
        """
 
1057
    def clone(self, url, revision_id=None, force_new_repo=False):
 
1058
        """See BzrDir.clone()."""
 
1059
        from bzrlib.workingtree import WorkingTreeFormat2
1462
1060
        self._make_tail(url)
1463
1061
        result = self._format._initialize_for_clone(url)
1464
1062
        self.open_repository().clone(result, revision_id=revision_id)
1465
1063
        from_branch = self.open_branch()
1466
1064
        from_branch.clone(result, revision_id=revision_id)
1467
1065
        try:
1468
 
            tree = self.open_workingtree()
 
1066
            self.open_workingtree().clone(result)
1469
1067
        except errors.NotLocalUrl:
1470
1068
            # make a new one, this format always has to have one.
1471
 
            result._init_workingtree()
1472
 
        else:
1473
 
            tree.clone(result)
 
1069
            try:
 
1070
                WorkingTreeFormat2().initialize(result)
 
1071
            except errors.NotLocalUrl:
 
1072
                # but we cannot do it for remote trees.
 
1073
                to_branch = result.open_branch()
 
1074
                WorkingTreeFormat2().stub_initialize_remote(to_branch.control_files)
1474
1075
        return result
1475
1076
 
1476
 
    def create_branch(self, name=None):
 
1077
    def create_branch(self):
1477
1078
        """See BzrDir.create_branch."""
1478
 
        return self._format.get_branch_format().initialize(self, name=name)
 
1079
        return self.open_branch()
1479
1080
 
1480
 
    def destroy_branch(self, name=None):
 
1081
    def destroy_branch(self):
1481
1082
        """See BzrDir.destroy_branch."""
1482
1083
        raise errors.UnsupportedOperation(self.destroy_branch, self)
1483
1084
 
1494
1095
    def create_workingtree(self, revision_id=None, from_branch=None,
1495
1096
                           accelerator_tree=None, hardlink=False):
1496
1097
        """See BzrDir.create_workingtree."""
1497
 
        # The workingtree is sometimes created when the bzrdir is created,
1498
 
        # but not when cloning.
1499
 
 
1500
1098
        # this looks buggy but is not -really-
1501
1099
        # because this format creates the workingtree when the bzrdir is
1502
1100
        # created
1504
1102
        # and that will have set it for us, its only
1505
1103
        # specific uses of create_workingtree in isolation
1506
1104
        # that can do wonky stuff here, and that only
1507
 
        # happens for creating checkouts, which cannot be
 
1105
        # happens for creating checkouts, which cannot be 
1508
1106
        # done on this format anyway. So - acceptable wart.
1509
 
        if hardlink:
1510
 
            warning("can't support hardlinked working trees in %r"
1511
 
                % (self,))
1512
 
        try:
1513
 
            result = self.open_workingtree(recommend_upgrade=False)
1514
 
        except errors.NoSuchFile:
1515
 
            result = self._init_workingtree()
 
1107
        result = self.open_workingtree(recommend_upgrade=False)
1516
1108
        if revision_id is not None:
1517
1109
            if revision_id == _mod_revision.NULL_REVISION:
1518
1110
                result.set_parent_ids([])
1520
1112
                result.set_parent_ids([revision_id])
1521
1113
        return result
1522
1114
 
1523
 
    def _init_workingtree(self):
1524
 
        from bzrlib.workingtree import WorkingTreeFormat2
1525
 
        try:
1526
 
            return WorkingTreeFormat2().initialize(self)
1527
 
        except errors.NotLocalUrl:
1528
 
            # Even though we can't access the working tree, we need to
1529
 
            # create its control files.
1530
 
            return WorkingTreeFormat2()._stub_initialize_on_transport(
1531
 
                self.transport, self._control_files._file_mode)
1532
 
 
1533
1115
    def destroy_workingtree(self):
1534
1116
        """See BzrDir.destroy_workingtree."""
1535
1117
        raise errors.UnsupportedOperation(self.destroy_workingtree, self)
1536
1118
 
1537
1119
    def destroy_workingtree_metadata(self):
1538
1120
        """See BzrDir.destroy_workingtree_metadata."""
1539
 
        raise errors.UnsupportedOperation(self.destroy_workingtree_metadata,
 
1121
        raise errors.UnsupportedOperation(self.destroy_workingtree_metadata, 
1540
1122
                                          self)
1541
1123
 
1542
 
    def get_branch_transport(self, branch_format, name=None):
 
1124
    def get_branch_transport(self, branch_format):
1543
1125
        """See BzrDir.get_branch_transport()."""
1544
 
        if name is not None:
1545
 
            raise errors.NoColocatedBranchSupport(self)
1546
1126
        if branch_format is None:
1547
1127
            return self.transport
1548
1128
        try:
1576
1156
        # if the format is not the same as the system default,
1577
1157
        # an upgrade is needed.
1578
1158
        if format is None:
1579
 
            symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1580
 
                % 'needs_format_conversion(format=None)')
1581
1159
            format = BzrDirFormat.get_default_format()
1582
1160
        return not isinstance(self._format, format.__class__)
1583
1161
 
1584
 
    def open_branch(self, name=None, unsupported=False,
1585
 
                    ignore_fallbacks=False):
 
1162
    def open_branch(self, unsupported=False):
1586
1163
        """See BzrDir.open_branch."""
1587
1164
        from bzrlib.branch import BzrBranchFormat4
1588
1165
        format = BzrBranchFormat4()
1589
1166
        self._check_supported(format, unsupported)
1590
 
        return format.open(self, name, _found=True)
 
1167
        return format.open(self, _found=True)
1591
1168
 
1592
1169
    def sprout(self, url, revision_id=None, force_new_repo=False,
1593
1170
               possible_transports=None, accelerator_tree=None,
1594
 
               hardlink=False, stacked=False, create_tree_if_local=True,
1595
 
               source_branch=None):
 
1171
               hardlink=False):
1596
1172
        """See BzrDir.sprout()."""
1597
 
        if source_branch is not None:
1598
 
            my_branch = self.open_branch()
1599
 
            if source_branch.base != my_branch.base:
1600
 
                raise AssertionError(
1601
 
                    "source branch %r is not within %r with branch %r" %
1602
 
                    (source_branch, self, my_branch))
1603
 
        if stacked:
1604
 
            raise errors.UnstackableBranchFormat(
1605
 
                self._format, self.root_transport.base)
1606
 
        if not create_tree_if_local:
1607
 
            raise errors.MustHaveWorkingTree(
1608
 
                self._format, self.root_transport.base)
1609
1173
        from bzrlib.workingtree import WorkingTreeFormat2
1610
1174
        self._make_tail(url)
1611
1175
        result = self._format._initialize_for_clone(url)
1617
1181
            self.open_branch().sprout(result, revision_id=revision_id)
1618
1182
        except errors.NotBranchError:
1619
1183
            pass
1620
 
 
1621
1184
        # we always want a working tree
1622
1185
        WorkingTreeFormat2().initialize(result,
1623
1186
                                        accelerator_tree=accelerator_tree,
1627
1190
 
1628
1191
class BzrDir4(BzrDirPreSplitOut):
1629
1192
    """A .bzr version 4 control object.
1630
 
 
 
1193
    
1631
1194
    This is a deprecated format and may be removed after sept 2006.
1632
1195
    """
1633
1196
 
1637
1200
 
1638
1201
    def needs_format_conversion(self, format=None):
1639
1202
        """Format 4 dirs are always in need of conversion."""
1640
 
        if format is None:
1641
 
            symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1642
 
                % 'needs_format_conversion(format=None)')
1643
1203
        return True
1644
1204
 
1645
1205
    def open_repository(self):
1654
1214
    This is a deprecated format and may be removed after sept 2006.
1655
1215
    """
1656
1216
 
1657
 
    def has_workingtree(self):
1658
 
        """See BzrDir.has_workingtree."""
1659
 
        return True
1660
 
    
1661
1217
    def open_repository(self):
1662
1218
        """See BzrDir.open_repository."""
1663
1219
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
1679
1235
    This is a deprecated format and may be removed after sept 2006.
1680
1236
    """
1681
1237
 
1682
 
    def has_workingtree(self):
1683
 
        """See BzrDir.has_workingtree."""
1684
 
        return True
1685
 
    
1686
1238
    def open_repository(self):
1687
1239
        """See BzrDir.open_repository."""
1688
1240
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
1699
1251
 
1700
1252
class BzrDirMeta1(BzrDir):
1701
1253
    """A .bzr meta version 1 control object.
1702
 
 
1703
 
    This is the first control object where the
 
1254
    
 
1255
    This is the first control object where the 
1704
1256
    individual aspects are really split out: there are separate repository,
1705
1257
    workingtree and branch subdirectories and any subset of the three can be
1706
1258
    present within a BzrDir.
1710
1262
        """See BzrDir.can_convert_format()."""
1711
1263
        return True
1712
1264
 
1713
 
    def create_branch(self, name=None):
 
1265
    def create_branch(self):
1714
1266
        """See BzrDir.create_branch."""
1715
 
        return self._format.get_branch_format().initialize(self, name=name)
 
1267
        return self._format.get_branch_format().initialize(self)
1716
1268
 
1717
 
    def destroy_branch(self, name=None):
 
1269
    def destroy_branch(self):
1718
1270
        """See BzrDir.create_branch."""
1719
 
        if name is not None:
1720
 
            raise errors.NoColocatedBranchSupport(self)
1721
1271
        self.transport.delete_tree('branch')
1722
1272
 
1723
1273
    def create_repository(self, shared=False):
1746
1296
    def destroy_workingtree_metadata(self):
1747
1297
        self.transport.delete_tree('checkout')
1748
1298
 
1749
 
    def find_branch_format(self, name=None):
 
1299
    def find_branch_format(self):
1750
1300
        """Find the branch 'format' for this bzrdir.
1751
1301
 
1752
1302
        This might be a synthetic object for e.g. RemoteBranch and SVN.
1753
1303
        """
1754
1304
        from bzrlib.branch import BranchFormat
1755
 
        return BranchFormat.find_format(self, name=name)
 
1305
        return BranchFormat.find_format(self)
1756
1306
 
1757
1307
    def _get_mkdir_mode(self):
1758
1308
        """Figure out the mode to use when creating a bzrdir subdir."""
1760
1310
                                     lockable_files.TransportLock)
1761
1311
        return temp_control._dir_mode
1762
1312
 
1763
 
    def get_branch_reference(self, name=None):
 
1313
    def get_branch_reference(self):
1764
1314
        """See BzrDir.get_branch_reference()."""
1765
1315
        from bzrlib.branch import BranchFormat
1766
 
        format = BranchFormat.find_format(self, name=name)
1767
 
        return format.get_reference(self, name=name)
 
1316
        format = BranchFormat.find_format(self)
 
1317
        return format.get_reference(self)
1768
1318
 
1769
 
    def get_branch_transport(self, branch_format, name=None):
 
1319
    def get_branch_transport(self, branch_format):
1770
1320
        """See BzrDir.get_branch_transport()."""
1771
 
        if name is not None:
1772
 
            raise errors.NoColocatedBranchSupport(self)
1773
 
        # XXX: this shouldn't implicitly create the directory if it's just
1774
 
        # promising to get a transport -- mbp 20090727
1775
1321
        if branch_format is None:
1776
1322
            return self.transport.clone('branch')
1777
1323
        try:
1812
1358
            pass
1813
1359
        return self.transport.clone('checkout')
1814
1360
 
1815
 
    def has_workingtree(self):
1816
 
        """Tell if this bzrdir contains a working tree.
1817
 
 
1818
 
        This will still raise an exception if the bzrdir has a workingtree that
1819
 
        is remote & inaccessible.
1820
 
 
1821
 
        Note: if you're going to open the working tree, you should just go
1822
 
        ahead and try, and not ask permission first.
1823
 
        """
1824
 
        from bzrlib.workingtree import WorkingTreeFormat
1825
 
        try:
1826
 
            WorkingTreeFormat.find_format(self)
1827
 
        except errors.NoWorkingTree:
1828
 
            return False
1829
 
        return True
1830
 
 
1831
1361
    def needs_format_conversion(self, format=None):
1832
1362
        """See BzrDir.needs_format_conversion()."""
1833
1363
        if format is None:
1834
 
            symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1835
 
                % 'needs_format_conversion(format=None)')
1836
 
        if format is None:
1837
1364
            format = BzrDirFormat.get_default_format()
1838
1365
        if not isinstance(self._format, format.__class__):
1839
1366
            # it is not a meta dir format, conversion is needed.
1846
1373
                return True
1847
1374
        except errors.NoRepositoryPresent:
1848
1375
            pass
1849
 
        for branch in self.list_branches():
1850
 
            if not isinstance(branch._format,
 
1376
        try:
 
1377
            if not isinstance(self.open_branch()._format,
1851
1378
                              format.get_branch_format().__class__):
1852
1379
                # the branch needs an upgrade.
1853
1380
                return True
 
1381
        except errors.NotBranchError:
 
1382
            pass
1854
1383
        try:
1855
1384
            my_wt = self.open_workingtree(recommend_upgrade=False)
1856
1385
            if not isinstance(my_wt._format,
1861
1390
            pass
1862
1391
        return False
1863
1392
 
1864
 
    def open_branch(self, name=None, unsupported=False,
1865
 
                    ignore_fallbacks=False):
 
1393
    def open_branch(self, unsupported=False):
1866
1394
        """See BzrDir.open_branch."""
1867
 
        format = self.find_branch_format(name=name)
 
1395
        format = self.find_branch_format()
1868
1396
        self._check_supported(format, unsupported)
1869
 
        return format.open(self, name=name,
1870
 
            _found=True, ignore_fallbacks=ignore_fallbacks)
 
1397
        return format.open(self, _found=True)
1871
1398
 
1872
1399
    def open_repository(self, unsupported=False):
1873
1400
        """See BzrDir.open_repository."""
1886
1413
            basedir=self.root_transport.base)
1887
1414
        return format.open(self, _found=True)
1888
1415
 
1889
 
    def _get_config(self):
1890
 
        return config.TransportConfig(self.transport, 'control.conf')
1891
 
 
1892
1416
 
1893
1417
class BzrDirFormat(object):
1894
1418
    """An encapsulation of the initialization and open routines for a format.
1898
1422
     * a format string,
1899
1423
     * an open routine.
1900
1424
 
1901
 
    Formats are placed in a dict by their format string for reference
 
1425
    Formats are placed in a dict by their format string for reference 
1902
1426
    during bzrdir opening. These should be subclasses of BzrDirFormat
1903
1427
    for consistency.
1904
1428
 
1905
1429
    Once a format is deprecated, just deprecate the initialize and open
1906
 
    methods on the format class. Do not deprecate the object, as the
 
1430
    methods on the format class. Do not deprecate the object, as the 
1907
1431
    object will be created every system load.
1908
 
 
1909
 
    :cvar colocated_branches: Whether this formats supports colocated branches.
1910
1432
    """
1911
1433
 
1912
1434
    _default_format = None
1917
1439
 
1918
1440
    _control_formats = []
1919
1441
    """The registered control formats - .bzr, ....
1920
 
 
 
1442
    
1921
1443
    This is a list of BzrDirFormat objects.
1922
1444
    """
1923
1445
 
1929
1451
 
1930
1452
    _lock_file_name = 'branch-lock'
1931
1453
 
1932
 
    colocated_branches = False
1933
 
    """Whether co-located branches are supported for this control dir format.
1934
 
    """
1935
 
 
1936
1454
    # _lock_class must be set in subclasses to the lock type, typ.
1937
1455
    # TransportLock or LockDir
1938
1456
 
1955
1473
    def probe_transport(klass, transport):
1956
1474
        """Return the .bzrdir style format present in a directory."""
1957
1475
        try:
1958
 
            format_string = transport.get_bytes(".bzr/branch-format")
 
1476
            format_string = transport.get(".bzr/branch-format").read()
1959
1477
        except errors.NoSuchFile:
1960
1478
            raise errors.NotBranchError(path=transport.base)
1961
1479
 
1986
1504
        current default format. In the case of plugins we can/should provide
1987
1505
        some means for them to extend the range of returnable converters.
1988
1506
 
1989
 
        :param format: Optional format to override the default format of the
 
1507
        :param format: Optional format to override the default format of the 
1990
1508
                       library.
1991
1509
        """
1992
1510
        raise NotImplementedError(self.get_converter)
1993
1511
 
1994
1512
    def initialize(self, url, possible_transports=None):
1995
1513
        """Create a bzr control dir at this url and return an opened copy.
1996
 
 
1997
 
        While not deprecated, this method is very specific and its use will
1998
 
        lead to many round trips to setup a working environment. See
1999
 
        initialize_on_transport_ex for a [nearly] all-in-one method.
2000
 
 
 
1514
        
2001
1515
        Subclasses should typically override initialize_on_transport
2002
1516
        instead of this method.
2003
1517
        """
2006
1520
 
2007
1521
    def initialize_on_transport(self, transport):
2008
1522
        """Initialize a new bzrdir in the base directory of a Transport."""
2009
 
        try:
2010
 
            # can we hand off the request to the smart server rather than using
2011
 
            # vfs calls?
2012
 
            client_medium = transport.get_smart_medium()
2013
 
        except errors.NoSmartMedium:
2014
 
            return self._initialize_on_transport_vfs(transport)
2015
 
        else:
2016
 
            # Current RPC's only know how to create bzr metadir1 instances, so
2017
 
            # we still delegate to vfs methods if the requested format is not a
2018
 
            # metadir1
2019
 
            if type(self) != BzrDirMetaFormat1:
2020
 
                return self._initialize_on_transport_vfs(transport)
2021
 
            remote_format = RemoteBzrDirFormat()
2022
 
            self._supply_sub_formats_to(remote_format)
2023
 
            return remote_format.initialize_on_transport(transport)
2024
 
 
2025
 
    def initialize_on_transport_ex(self, transport, use_existing_dir=False,
2026
 
        create_prefix=False, force_new_repo=False, stacked_on=None,
2027
 
        stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
2028
 
        shared_repo=False, vfs_only=False):
2029
 
        """Create this format on transport.
2030
 
 
2031
 
        The directory to initialize will be created.
2032
 
 
2033
 
        :param force_new_repo: Do not use a shared repository for the target,
2034
 
                               even if one is available.
2035
 
        :param create_prefix: Create any missing directories leading up to
2036
 
            to_transport.
2037
 
        :param use_existing_dir: Use an existing directory if one exists.
2038
 
        :param stacked_on: A url to stack any created branch on, None to follow
2039
 
            any target stacking policy.
2040
 
        :param stack_on_pwd: If stack_on is relative, the location it is
2041
 
            relative to.
2042
 
        :param repo_format_name: If non-None, a repository will be
2043
 
            made-or-found. Should none be found, or if force_new_repo is True
2044
 
            the repo_format_name is used to select the format of repository to
2045
 
            create.
2046
 
        :param make_working_trees: Control the setting of make_working_trees
2047
 
            for a new shared repository when one is made. None to use whatever
2048
 
            default the format has.
2049
 
        :param shared_repo: Control whether made repositories are shared or
2050
 
            not.
2051
 
        :param vfs_only: If True do not attempt to use a smart server
2052
 
        :return: repo, bzrdir, require_stacking, repository_policy. repo is
2053
 
            None if none was created or found, bzrdir is always valid.
2054
 
            require_stacking is the result of examining the stacked_on
2055
 
            parameter and any stacking policy found for the target.
2056
 
        """
2057
 
        if not vfs_only:
2058
 
            # Try to hand off to a smart server 
2059
 
            try:
2060
 
                client_medium = transport.get_smart_medium()
2061
 
            except errors.NoSmartMedium:
2062
 
                pass
2063
 
            else:
2064
 
                # TODO: lookup the local format from a server hint.
2065
 
                remote_dir_format = RemoteBzrDirFormat()
2066
 
                remote_dir_format._network_name = self.network_name()
2067
 
                self._supply_sub_formats_to(remote_dir_format)
2068
 
                return remote_dir_format.initialize_on_transport_ex(transport,
2069
 
                    use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2070
 
                    force_new_repo=force_new_repo, stacked_on=stacked_on,
2071
 
                    stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2072
 
                    make_working_trees=make_working_trees, shared_repo=shared_repo)
2073
 
        # XXX: Refactor the create_prefix/no_create_prefix code into a
2074
 
        #      common helper function
2075
 
        # The destination may not exist - if so make it according to policy.
2076
 
        def make_directory(transport):
2077
 
            transport.mkdir('.')
2078
 
            return transport
2079
 
        def redirected(transport, e, redirection_notice):
2080
 
            note(redirection_notice)
2081
 
            return transport._redirected_to(e.source, e.target)
2082
 
        try:
2083
 
            transport = do_catching_redirections(make_directory, transport,
2084
 
                redirected)
2085
 
        except errors.FileExists:
2086
 
            if not use_existing_dir:
2087
 
                raise
2088
 
        except errors.NoSuchFile:
2089
 
            if not create_prefix:
2090
 
                raise
2091
 
            transport.create_prefix()
2092
 
 
2093
 
        require_stacking = (stacked_on is not None)
2094
 
        # Now the target directory exists, but doesn't have a .bzr
2095
 
        # directory. So we need to create it, along with any work to create
2096
 
        # all of the dependent branches, etc.
2097
 
 
2098
 
        result = self.initialize_on_transport(transport)
2099
 
        if repo_format_name:
2100
 
            try:
2101
 
                # use a custom format
2102
 
                result._format.repository_format = \
2103
 
                    repository.network_format_registry.get(repo_format_name)
2104
 
            except AttributeError:
2105
 
                # The format didn't permit it to be set.
2106
 
                pass
2107
 
            # A repository is desired, either in-place or shared.
2108
 
            repository_policy = result.determine_repository_policy(
2109
 
                force_new_repo, stacked_on, stack_on_pwd,
2110
 
                require_stacking=require_stacking)
2111
 
            result_repo, is_new_repo = repository_policy.acquire_repository(
2112
 
                make_working_trees, shared_repo)
2113
 
            if not require_stacking and repository_policy._require_stacking:
2114
 
                require_stacking = True
2115
 
                result._format.require_stacking()
2116
 
            result_repo.lock_write()
2117
 
        else:
2118
 
            result_repo = None
2119
 
            repository_policy = None
2120
 
        return result_repo, result, require_stacking, repository_policy
2121
 
 
2122
 
    def _initialize_on_transport_vfs(self, transport):
2123
 
        """Initialize a new bzrdir using VFS calls.
2124
 
 
2125
 
        :param transport: The transport to create the .bzr directory in.
2126
 
        :return: A
2127
 
        """
2128
 
        # Since we are creating a .bzr directory, inherit the
 
1523
        # Since we don't have a .bzr directory, inherit the
2129
1524
        # mode from the root directory
2130
1525
        temp_control = lockable_files.LockableFiles(transport,
2131
1526
                            '', lockable_files.TransportLock)
2133
1528
                                      # FIXME: RBC 20060121 don't peek under
2134
1529
                                      # the covers
2135
1530
                                      mode=temp_control._dir_mode)
2136
 
        if sys.platform == 'win32' and isinstance(transport, local.LocalTransport):
 
1531
        if sys.platform == 'win32' and isinstance(transport, LocalTransport):
2137
1532
            win32utils.set_file_attr_hidden(transport._abspath('.bzr'))
2138
1533
        file_mode = temp_control._file_mode
2139
1534
        del temp_control
2140
 
        bzrdir_transport = transport.clone('.bzr')
2141
 
        utf8_files = [('README',
 
1535
        mutter('created control directory in ' + transport.base)
 
1536
        control = transport.clone('.bzr')
 
1537
        utf8_files = [('README', 
2142
1538
                       "This is a Bazaar control directory.\n"
2143
1539
                       "Do not change any files in this directory.\n"
2144
1540
                       "See http://bazaar-vcs.org/ for more information about Bazaar.\n"),
2145
1541
                      ('branch-format', self.get_format_string()),
2146
1542
                      ]
2147
1543
        # NB: no need to escape relative paths that are url safe.
2148
 
        control_files = lockable_files.LockableFiles(bzrdir_transport,
2149
 
            self._lock_file_name, self._lock_class)
 
1544
        control_files = lockable_files.LockableFiles(control,
 
1545
                            self._lock_file_name, self._lock_class)
2150
1546
        control_files.create_lock()
2151
1547
        control_files.lock_write()
2152
1548
        try:
2153
 
            for (filename, content) in utf8_files:
2154
 
                bzrdir_transport.put_bytes(filename, content,
2155
 
                    mode=file_mode)
 
1549
            for file, content in utf8_files:
 
1550
                control_files.put_utf8(file, content)
2156
1551
        finally:
2157
1552
            control_files.unlock()
2158
1553
        return self.open(transport, _found=True)
2161
1556
        """Is this format supported?
2162
1557
 
2163
1558
        Supported formats must be initializable and openable.
2164
 
        Unsupported formats may not support initialization or committing or
 
1559
        Unsupported formats may not support initialization or committing or 
2165
1560
        some other features depending on the reason for not being supported.
2166
1561
        """
2167
1562
        return True
2168
1563
 
2169
 
    def network_name(self):
2170
 
        """A simple byte string uniquely identifying this format for RPC calls.
2171
 
 
2172
 
        Bzr control formats use thir disk format string to identify the format
2173
 
        over the wire. Its possible that other control formats have more
2174
 
        complex detection requirements, so we permit them to use any unique and
2175
 
        immutable string they desire.
2176
 
        """
2177
 
        raise NotImplementedError(self.network_name)
2178
 
 
2179
1564
    def same_model(self, target_format):
2180
 
        return (self.repository_format.rich_root_data ==
 
1565
        return (self.repository_format.rich_root_data == 
2181
1566
            target_format.rich_root_data)
2182
1567
 
2183
1568
    @classmethod
2184
1569
    def known_formats(klass):
2185
1570
        """Return all the known formats.
2186
 
 
 
1571
        
2187
1572
        Concrete formats should override _known_formats.
2188
1573
        """
2189
 
        # There is double indirection here to make sure that control
2190
 
        # formats used by more than one dir format will only be probed
 
1574
        # There is double indirection here to make sure that control 
 
1575
        # formats used by more than one dir format will only be probed 
2191
1576
        # once. This can otherwise be quite expensive for remote connections.
2192
1577
        result = set()
2193
1578
        for format in klass._control_formats:
2194
1579
            result.update(format._known_formats())
2195
1580
        return result
2196
 
 
 
1581
    
2197
1582
    @classmethod
2198
1583
    def _known_formats(klass):
2199
1584
        """Return the known format instances for this control format."""
2201
1586
 
2202
1587
    def open(self, transport, _found=False):
2203
1588
        """Return an instance of this format for the dir transport points at.
2204
 
 
 
1589
        
2205
1590
        _found is a private parameter, do not use it.
2206
1591
        """
2207
1592
        if not _found:
2208
1593
            found_format = BzrDirFormat.find_format(transport)
2209
1594
            if not isinstance(found_format, self.__class__):
2210
1595
                raise AssertionError("%s was asked to open %s, but it seems to need "
2211
 
                        "format %s"
 
1596
                        "format %s" 
2212
1597
                        % (self, transport, found_format))
2213
 
            # Allow subclasses - use the found format.
2214
 
            self._supply_sub_formats_to(found_format)
2215
 
            return found_format._open(transport)
2216
1598
        return self._open(transport)
2217
1599
 
2218
1600
    def _open(self, transport):
2226
1608
    @classmethod
2227
1609
    def register_format(klass, format):
2228
1610
        klass._formats[format.get_format_string()] = format
2229
 
        # bzr native formats have a network name of their format string.
2230
 
        network_format_registry.register(format.get_format_string(), format.__class__)
2231
1611
 
2232
1612
    @classmethod
2233
1613
    def register_control_format(klass, format):
2234
1614
        """Register a format that does not use '.bzr' for its control dir.
2235
1615
 
2236
1616
        TODO: This should be pulled up into a 'ControlDirFormat' base class
2237
 
        which BzrDirFormat can inherit from, and renamed to register_format
 
1617
        which BzrDirFormat can inherit from, and renamed to register_format 
2238
1618
        there. It has been done without that for now for simplicity of
2239
1619
        implementation.
2240
1620
        """
2252
1632
        klass._control_server_formats.append(format)
2253
1633
 
2254
1634
    @classmethod
 
1635
    @symbol_versioning.deprecated_method(symbol_versioning.zero_fourteen)
 
1636
    def set_default_format(klass, format):
 
1637
        klass._set_default_format(format)
 
1638
 
 
1639
    @classmethod
2255
1640
    def _set_default_format(klass, format):
2256
1641
        """Set default format (for testing behavior of defaults only)"""
2257
1642
        klass._default_format = format
2258
1643
 
2259
1644
    def __str__(self):
2260
1645
        # Trim the newline
2261
 
        return self.get_format_description().rstrip()
2262
 
 
2263
 
    def _supply_sub_formats_to(self, other_format):
2264
 
        """Give other_format the same values for sub formats as this has.
2265
 
 
2266
 
        This method is expected to be used when parameterising a
2267
 
        RemoteBzrDirFormat instance with the parameters from a
2268
 
        BzrDirMetaFormat1 instance.
2269
 
 
2270
 
        :param other_format: other_format is a format which should be
2271
 
            compatible with whatever sub formats are supported by self.
2272
 
        :return: None.
2273
 
        """
 
1646
        return self.get_format_string().rstrip()
2274
1647
 
2275
1648
    @classmethod
2276
1649
    def unregister_format(klass, format):
 
1650
        assert klass._formats[format.get_format_string()] is format
2277
1651
        del klass._formats[format.get_format_string()]
2278
1652
 
2279
1653
    @classmethod
2308
1682
        """See BzrDirFormat.get_converter()."""
2309
1683
        # there is one and only one upgrade path here.
2310
1684
        return ConvertBzrDir4To5()
2311
 
 
 
1685
        
2312
1686
    def initialize_on_transport(self, transport):
2313
1687
        """Format 4 branches cannot be created."""
2314
1688
        raise errors.UninitializableFormat(self)
2317
1691
        """Format 4 is not supported.
2318
1692
 
2319
1693
        It is not supported because the model changed from 4 to 5 and the
2320
 
        conversion logic is expensive - so doing it on the fly was not
 
1694
        conversion logic is expensive - so doing it on the fly was not 
2321
1695
        feasible.
2322
1696
        """
2323
1697
        return False
2324
1698
 
2325
 
    def network_name(self):
2326
 
        return self.get_format_string()
2327
 
 
2328
1699
    def _open(self, transport):
2329
1700
        """See BzrDirFormat._open."""
2330
1701
        return BzrDir4(transport, self)
2336
1707
    repository_format = property(__return_repository_format)
2337
1708
 
2338
1709
 
2339
 
class BzrDirFormatAllInOne(BzrDirFormat):
2340
 
    """Common class for formats before meta-dirs."""
2341
 
 
2342
 
    def initialize_on_transport_ex(self, transport, use_existing_dir=False,
2343
 
        create_prefix=False, force_new_repo=False, stacked_on=None,
2344
 
        stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
2345
 
        shared_repo=False):
2346
 
        """See BzrDirFormat.initialize_on_transport_ex."""
2347
 
        require_stacking = (stacked_on is not None)
2348
 
        # Format 5 cannot stack, but we've been asked to - actually init
2349
 
        # a Meta1Dir
2350
 
        if require_stacking:
2351
 
            format = BzrDirMetaFormat1()
2352
 
            return format.initialize_on_transport_ex(transport,
2353
 
                use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2354
 
                force_new_repo=force_new_repo, stacked_on=stacked_on,
2355
 
                stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2356
 
                make_working_trees=make_working_trees, shared_repo=shared_repo)
2357
 
        return BzrDirFormat.initialize_on_transport_ex(self, transport,
2358
 
            use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2359
 
            force_new_repo=force_new_repo, stacked_on=stacked_on,
2360
 
            stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2361
 
            make_working_trees=make_working_trees, shared_repo=shared_repo)
2362
 
 
2363
 
 
2364
 
class BzrDirFormat5(BzrDirFormatAllInOne):
 
1710
class BzrDirFormat5(BzrDirFormat):
2365
1711
    """Bzr control format 5.
2366
1712
 
2367
1713
    This format is a combined format for working tree, branch and repository.
2368
1714
    It has:
2369
 
     - Format 2 working trees [always]
2370
 
     - Format 4 branches [always]
 
1715
     - Format 2 working trees [always] 
 
1716
     - Format 4 branches [always] 
2371
1717
     - Format 5 repositories [always]
2372
1718
       Unhashed stores in the repository.
2373
1719
    """
2378
1724
        """See BzrDirFormat.get_format_string()."""
2379
1725
        return "Bazaar-NG branch, format 5\n"
2380
1726
 
2381
 
    def get_branch_format(self):
2382
 
        from bzrlib import branch
2383
 
        return branch.BzrBranchFormat4()
2384
 
 
2385
1727
    def get_format_description(self):
2386
1728
        """See BzrDirFormat.get_format_description()."""
2387
1729
        return "All-in-one format 5"
2393
1735
 
2394
1736
    def _initialize_for_clone(self, url):
2395
1737
        return self.initialize_on_transport(get_transport(url), _cloning=True)
2396
 
 
 
1738
        
2397
1739
    def initialize_on_transport(self, transport, _cloning=False):
2398
1740
        """Format 5 dirs always have working tree, branch and repository.
2399
 
 
 
1741
        
2400
1742
        Except when they are being cloned.
2401
1743
        """
2402
1744
        from bzrlib.branch import BzrBranchFormat4
2403
1745
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
 
1746
        from bzrlib.workingtree import WorkingTreeFormat2
2404
1747
        result = (super(BzrDirFormat5, self).initialize_on_transport(transport))
2405
1748
        RepositoryFormat5().initialize(result, _internal=True)
2406
1749
        if not _cloning:
2407
1750
            branch = BzrBranchFormat4().initialize(result)
2408
 
            result._init_workingtree()
 
1751
            try:
 
1752
                WorkingTreeFormat2().initialize(result)
 
1753
            except errors.NotLocalUrl:
 
1754
                # Even though we can't access the working tree, we need to
 
1755
                # create its control files.
 
1756
                WorkingTreeFormat2().stub_initialize_remote(branch.control_files)
2409
1757
        return result
2410
1758
 
2411
 
    def network_name(self):
2412
 
        return self.get_format_string()
2413
 
 
2414
1759
    def _open(self, transport):
2415
1760
        """See BzrDirFormat._open."""
2416
1761
        return BzrDir5(transport, self)
2422
1767
    repository_format = property(__return_repository_format)
2423
1768
 
2424
1769
 
2425
 
class BzrDirFormat6(BzrDirFormatAllInOne):
 
1770
class BzrDirFormat6(BzrDirFormat):
2426
1771
    """Bzr control format 6.
2427
1772
 
2428
1773
    This format is a combined format for working tree, branch and repository.
2429
1774
    It has:
2430
 
     - Format 2 working trees [always]
2431
 
     - Format 4 branches [always]
 
1775
     - Format 2 working trees [always] 
 
1776
     - Format 4 branches [always] 
2432
1777
     - Format 6 repositories [always]
2433
1778
    """
2434
1779
 
2442
1787
        """See BzrDirFormat.get_format_description()."""
2443
1788
        return "All-in-one format 6"
2444
1789
 
2445
 
    def get_branch_format(self):
2446
 
        from bzrlib import branch
2447
 
        return branch.BzrBranchFormat4()
2448
 
 
2449
1790
    def get_converter(self, format=None):
2450
1791
        """See BzrDirFormat.get_converter()."""
2451
1792
        # there is one and only one upgrade path here.
2452
1793
        return ConvertBzrDir6ToMeta()
2453
 
 
 
1794
        
2454
1795
    def _initialize_for_clone(self, url):
2455
1796
        return self.initialize_on_transport(get_transport(url), _cloning=True)
2456
1797
 
2457
1798
    def initialize_on_transport(self, transport, _cloning=False):
2458
1799
        """Format 6 dirs always have working tree, branch and repository.
2459
 
 
 
1800
        
2460
1801
        Except when they are being cloned.
2461
1802
        """
2462
1803
        from bzrlib.branch import BzrBranchFormat4
2463
1804
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
 
1805
        from bzrlib.workingtree import WorkingTreeFormat2
2464
1806
        result = super(BzrDirFormat6, self).initialize_on_transport(transport)
2465
1807
        RepositoryFormat6().initialize(result, _internal=True)
2466
1808
        if not _cloning:
2467
1809
            branch = BzrBranchFormat4().initialize(result)
2468
 
            result._init_workingtree()
 
1810
            try:
 
1811
                WorkingTreeFormat2().initialize(result)
 
1812
            except errors.NotLocalUrl:
 
1813
                # Even though we can't access the working tree, we need to
 
1814
                # create its control files.
 
1815
                WorkingTreeFormat2().stub_initialize_remote(branch.control_files)
2469
1816
        return result
2470
1817
 
2471
 
    def network_name(self):
2472
 
        return self.get_format_string()
2473
 
 
2474
1818
    def _open(self, transport):
2475
1819
        """See BzrDirFormat._open."""
2476
1820
        return BzrDir6(transport, self)
2498
1842
    def __init__(self):
2499
1843
        self._workingtree_format = None
2500
1844
        self._branch_format = None
2501
 
        self._repository_format = None
2502
1845
 
2503
1846
    def __eq__(self, other):
2504
1847
        if other.__class__ is not self.__class__:
2521
1864
    def set_branch_format(self, format):
2522
1865
        self._branch_format = format
2523
1866
 
2524
 
    def require_stacking(self, stack_on=None, possible_transports=None,
2525
 
            _skip_repo=False):
2526
 
        """We have a request to stack, try to ensure the formats support it.
2527
 
 
2528
 
        :param stack_on: If supplied, it is the URL to a branch that we want to
2529
 
            stack on. Check to see if that format supports stacking before
2530
 
            forcing an upgrade.
2531
 
        """
2532
 
        # Stacking is desired. requested by the target, but does the place it
2533
 
        # points at support stacking? If it doesn't then we should
2534
 
        # not implicitly upgrade. We check this here.
2535
 
        new_repo_format = None
2536
 
        new_branch_format = None
2537
 
 
2538
 
        # a bit of state for get_target_branch so that we don't try to open it
2539
 
        # 2 times, for both repo *and* branch
2540
 
        target = [None, False, None] # target_branch, checked, upgrade anyway
2541
 
        def get_target_branch():
2542
 
            if target[1]:
2543
 
                # We've checked, don't check again
2544
 
                return target
2545
 
            if stack_on is None:
2546
 
                # No target format, that means we want to force upgrading
2547
 
                target[:] = [None, True, True]
2548
 
                return target
2549
 
            try:
2550
 
                target_dir = BzrDir.open(stack_on,
2551
 
                    possible_transports=possible_transports)
2552
 
            except errors.NotBranchError:
2553
 
                # Nothing there, don't change formats
2554
 
                target[:] = [None, True, False]
2555
 
                return target
2556
 
            except errors.JailBreak:
2557
 
                # JailBreak, JFDI and upgrade anyway
2558
 
                target[:] = [None, True, True]
2559
 
                return target
2560
 
            try:
2561
 
                target_branch = target_dir.open_branch()
2562
 
            except errors.NotBranchError:
2563
 
                # No branch, don't upgrade formats
2564
 
                target[:] = [None, True, False]
2565
 
                return target
2566
 
            target[:] = [target_branch, True, False]
2567
 
            return target
2568
 
 
2569
 
        if (not _skip_repo and
2570
 
                 not self.repository_format.supports_external_lookups):
2571
 
            # We need to upgrade the Repository.
2572
 
            target_branch, _, do_upgrade = get_target_branch()
2573
 
            if target_branch is None:
2574
 
                # We don't have a target branch, should we upgrade anyway?
2575
 
                if do_upgrade:
2576
 
                    # stack_on is inaccessible, JFDI.
2577
 
                    # TODO: bad monkey, hard-coded formats...
2578
 
                    if self.repository_format.rich_root_data:
2579
 
                        new_repo_format = pack_repo.RepositoryFormatKnitPack5RichRoot()
2580
 
                    else:
2581
 
                        new_repo_format = pack_repo.RepositoryFormatKnitPack5()
2582
 
            else:
2583
 
                # If the target already supports stacking, then we know the
2584
 
                # project is already able to use stacking, so auto-upgrade
2585
 
                # for them
2586
 
                new_repo_format = target_branch.repository._format
2587
 
                if not new_repo_format.supports_external_lookups:
2588
 
                    # target doesn't, source doesn't, so don't auto upgrade
2589
 
                    # repo
2590
 
                    new_repo_format = None
2591
 
            if new_repo_format is not None:
2592
 
                self.repository_format = new_repo_format
2593
 
                note('Source repository format does not support stacking,'
2594
 
                     ' using format:\n  %s',
2595
 
                     new_repo_format.get_format_description())
2596
 
 
2597
 
        if not self.get_branch_format().supports_stacking():
2598
 
            # We just checked the repo, now lets check if we need to
2599
 
            # upgrade the branch format
2600
 
            target_branch, _, do_upgrade = get_target_branch()
2601
 
            if target_branch is None:
2602
 
                if do_upgrade:
2603
 
                    # TODO: bad monkey, hard-coded formats...
2604
 
                    new_branch_format = branch.BzrBranchFormat7()
2605
 
            else:
2606
 
                new_branch_format = target_branch._format
2607
 
                if not new_branch_format.supports_stacking():
2608
 
                    new_branch_format = None
2609
 
            if new_branch_format is not None:
2610
 
                # Does support stacking, use its format.
2611
 
                self.set_branch_format(new_branch_format)
2612
 
                note('Source branch format does not support stacking,'
2613
 
                     ' using format:\n  %s',
2614
 
                     new_branch_format.get_format_description())
2615
 
 
2616
1867
    def get_converter(self, format=None):
2617
1868
        """See BzrDirFormat.get_converter()."""
2618
1869
        if format is None:
2630
1881
        """See BzrDirFormat.get_format_description()."""
2631
1882
        return "Meta directory format 1"
2632
1883
 
2633
 
    def network_name(self):
2634
 
        return self.get_format_string()
2635
 
 
2636
1884
    def _open(self, transport):
2637
1885
        """See BzrDirFormat._open."""
2638
 
        # Create a new format instance because otherwise initialisation of new
2639
 
        # metadirs share the global default format object leading to alias
2640
 
        # problems.
2641
 
        format = BzrDirMetaFormat1()
2642
 
        self._supply_sub_formats_to(format)
2643
 
        return BzrDirMeta1(transport, format)
 
1886
        return BzrDirMeta1(transport, self)
2644
1887
 
2645
1888
    def __return_repository_format(self):
2646
1889
        """Circular import protection."""
2647
 
        if self._repository_format:
 
1890
        if getattr(self, '_repository_format', None):
2648
1891
            return self._repository_format
2649
1892
        from bzrlib.repository import RepositoryFormat
2650
1893
        return RepositoryFormat.get_default_format()
2651
1894
 
2652
 
    def _set_repository_format(self, value):
 
1895
    def __set_repository_format(self, value):
2653
1896
        """Allow changing the repository format for metadir formats."""
2654
1897
        self._repository_format = value
2655
1898
 
2656
 
    repository_format = property(__return_repository_format,
2657
 
        _set_repository_format)
2658
 
 
2659
 
    def _supply_sub_formats_to(self, other_format):
2660
 
        """Give other_format the same values for sub formats as this has.
2661
 
 
2662
 
        This method is expected to be used when parameterising a
2663
 
        RemoteBzrDirFormat instance with the parameters from a
2664
 
        BzrDirMetaFormat1 instance.
2665
 
 
2666
 
        :param other_format: other_format is a format which should be
2667
 
            compatible with whatever sub formats are supported by self.
2668
 
        :return: None.
2669
 
        """
2670
 
        if getattr(self, '_repository_format', None) is not None:
2671
 
            other_format.repository_format = self.repository_format
2672
 
        if self._branch_format is not None:
2673
 
            other_format._branch_format = self._branch_format
2674
 
        if self._workingtree_format is not None:
2675
 
            other_format.workingtree_format = self.workingtree_format
 
1899
    repository_format = property(__return_repository_format, __set_repository_format)
2676
1900
 
2677
1901
    def __get_workingtree_format(self):
2678
1902
        if self._workingtree_format is None:
2687
1911
                                  __set_workingtree_format)
2688
1912
 
2689
1913
 
2690
 
network_format_registry = registry.FormatRegistry()
2691
 
"""Registry of formats indexed by their network name.
2692
 
 
2693
 
The network name for a BzrDirFormat is an identifier that can be used when
2694
 
referring to formats with smart server operations. See
2695
 
BzrDirFormat.network_name() for more detail.
2696
 
"""
2697
 
 
2698
 
 
2699
1914
# Register bzr control format
2700
1915
BzrDirFormat.register_control_format(BzrDirFormat)
2701
1916
 
2733
1948
        self.absent_revisions = set()
2734
1949
        self.text_count = 0
2735
1950
        self.revisions = {}
2736
 
 
 
1951
        
2737
1952
    def convert(self, to_convert, pb):
2738
1953
        """See Converter.convert()."""
2739
1954
        self.bzrdir = to_convert
2740
 
        if pb is not None:
2741
 
            warnings.warn("pb parameter to convert() is deprecated")
2742
 
        self.pb = ui.ui_factory.nested_progress_bar()
2743
 
        try:
2744
 
            ui.ui_factory.note('starting upgrade from format 4 to 5')
2745
 
            if isinstance(self.bzrdir.transport, local.LocalTransport):
2746
 
                self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
2747
 
            self._convert_to_weaves()
2748
 
            return BzrDir.open(self.bzrdir.user_url)
2749
 
        finally:
2750
 
            self.pb.finished()
 
1955
        self.pb = pb
 
1956
        self.pb.note('starting upgrade from format 4 to 5')
 
1957
        if isinstance(self.bzrdir.transport, LocalTransport):
 
1958
            self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
 
1959
        self._convert_to_weaves()
 
1960
        return BzrDir.open(self.bzrdir.root_transport.base)
2751
1961
 
2752
1962
    def _convert_to_weaves(self):
2753
 
        ui.ui_factory.note('note: upgrade may be faster if all store files are ungzipped first')
 
1963
        self.pb.note('note: upgrade may be faster if all store files are ungzipped first')
2754
1964
        try:
2755
1965
            # TODO permissions
2756
1966
            stat = self.bzrdir.transport.stat('weaves')
2784
1994
        self.pb.clear()
2785
1995
        self._write_all_weaves()
2786
1996
        self._write_all_revs()
2787
 
        ui.ui_factory.note('upgraded to weaves:')
2788
 
        ui.ui_factory.note('  %6d revisions and inventories' % len(self.revisions))
2789
 
        ui.ui_factory.note('  %6d revisions not present' % len(self.absent_revisions))
2790
 
        ui.ui_factory.note('  %6d texts' % self.text_count)
 
1997
        self.pb.note('upgraded to weaves:')
 
1998
        self.pb.note('  %6d revisions and inventories', len(self.revisions))
 
1999
        self.pb.note('  %6d revisions not present', len(self.absent_revisions))
 
2000
        self.pb.note('  %6d texts', self.text_count)
2791
2001
        self._cleanup_spare_files_after_format4()
2792
 
        self.branch._transport.put_bytes(
2793
 
            'branch-format',
2794
 
            BzrDirFormat5().get_format_string(),
2795
 
            mode=self.bzrdir._get_file_mode())
 
2002
        self.branch.control_files.put_utf8('branch-format', BzrDirFormat5().get_format_string())
2796
2003
 
2797
2004
    def _cleanup_spare_files_after_format4(self):
2798
2005
        # FIXME working tree upgrade foo.
2807
2014
 
2808
2015
    def _convert_working_inv(self):
2809
2016
        inv = xml4.serializer_v4.read_inventory(
2810
 
                self.branch._transport.get('inventory'))
 
2017
                    self.branch.control_files.get('inventory'))
2811
2018
        new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv, working=True)
2812
 
        self.branch._transport.put_bytes('inventory', new_inv_xml,
2813
 
            mode=self.bzrdir._get_file_mode())
 
2019
        # FIXME inventory is a working tree change.
 
2020
        self.branch.control_files.put('inventory', StringIO(new_inv_xml))
2814
2021
 
2815
2022
    def _write_all_weaves(self):
2816
2023
        controlweaves = WeaveStore(self.bzrdir.transport, prefixed=False)
2836
2043
        self.bzrdir.transport.mkdir('revision-store')
2837
2044
        revision_transport = self.bzrdir.transport.clone('revision-store')
2838
2045
        # TODO permissions
2839
 
        from bzrlib.xml5 import serializer_v5
2840
 
        from bzrlib.repofmt.weaverepo import RevisionTextStore
2841
 
        revision_store = RevisionTextStore(revision_transport,
2842
 
            serializer_v5, False, versionedfile.PrefixMapper(),
2843
 
            lambda:True, lambda:True)
 
2046
        _revision_store = TextRevisionStore(TextStore(revision_transport,
 
2047
                                                      prefixed=False,
 
2048
                                                      compressed=True))
2844
2049
        try:
 
2050
            transaction = WriteTransaction()
2845
2051
            for i, rev_id in enumerate(self.converted_revs):
2846
2052
                self.pb.update('write revision', i, len(self.converted_revs))
2847
 
                text = serializer_v5.write_revision_to_string(
2848
 
                    self.revisions[rev_id])
2849
 
                key = (rev_id,)
2850
 
                revision_store.add_lines(key, None, osutils.split_lines(text))
 
2053
                _revision_store.add_revision(self.revisions[rev_id], transaction)
2851
2054
        finally:
2852
2055
            self.pb.clear()
2853
 
 
 
2056
            
2854
2057
    def _load_one_rev(self, rev_id):
2855
2058
        """Load a revision object into memory.
2856
2059
 
2861
2064
                       len(self.known_revisions))
2862
2065
        if not self.branch.repository.has_revision(rev_id):
2863
2066
            self.pb.clear()
2864
 
            ui.ui_factory.note('revision {%s} not present in branch; '
2865
 
                         'will be converted as a ghost' %
 
2067
            self.pb.note('revision {%s} not present in branch; '
 
2068
                         'will be converted as a ghost',
2866
2069
                         rev_id)
2867
2070
            self.absent_revisions.add(rev_id)
2868
2071
        else:
2869
 
            rev = self.branch.repository.get_revision(rev_id)
 
2072
            rev = self.branch.repository._revision_store.get_revision(rev_id,
 
2073
                self.branch.repository.get_transaction())
2870
2074
            for parent_id in rev.parent_ids:
2871
2075
                self.known_revisions.add(parent_id)
2872
2076
                self.to_read.append(parent_id)
2873
2077
            self.revisions[rev_id] = rev
2874
2078
 
2875
2079
    def _load_old_inventory(self, rev_id):
 
2080
        assert rev_id not in self.converted_revs
2876
2081
        old_inv_xml = self.branch.repository.inventory_store.get(rev_id).read()
2877
2082
        inv = xml4.serializer_v4.read_inventory_from_string(old_inv_xml)
2878
2083
        inv.revision_id = rev_id
2879
2084
        rev = self.revisions[rev_id]
 
2085
        if rev.inventory_sha1:
 
2086
            assert rev.inventory_sha1 == sha_string(old_inv_xml), \
 
2087
                'inventory sha mismatch for {%s}' % rev_id
2880
2088
        return inv
2881
2089
 
2882
2090
    def _load_updated_inventory(self, rev_id):
 
2091
        assert rev_id in self.converted_revs
2883
2092
        inv_xml = self.inv_weave.get_text(rev_id)
2884
2093
        inv = xml5.serializer_v5.read_inventory_from_string(inv_xml, rev_id)
2885
2094
        return inv
2895
2104
        self.converted_revs.add(rev_id)
2896
2105
 
2897
2106
    def _store_new_inv(self, rev, inv, present_parents):
 
2107
        # the XML is now updated with text versions
 
2108
        if __debug__:
 
2109
            entries = inv.iter_entries()
 
2110
            entries.next()
 
2111
            for path, ie in entries:
 
2112
                assert getattr(ie, 'revision', None) is not None, \
 
2113
                    'no revision on {%s} in {%s}' % \
 
2114
                    (file_id, rev.revision_id)
2898
2115
        new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
2899
2116
        new_inv_sha1 = sha_string(new_inv_xml)
2900
2117
        self.inv_weave.add_lines(rev.revision_id,
2929
2146
            self.text_weaves[file_id] = w
2930
2147
        text_changed = False
2931
2148
        parent_candiate_entries = ie.parent_candidates(parent_invs)
 
2149
        for old_revision in parent_candiate_entries.keys():
 
2150
            # if this fails, its a ghost ?
 
2151
            assert old_revision in self.converted_revs, \
 
2152
                "Revision {%s} not in converted_revs" % old_revision
2932
2153
        heads = graph.Graph(self).heads(parent_candiate_entries.keys())
2933
 
        # XXX: Note that this is unordered - and this is tolerable because
 
2154
        # XXX: Note that this is unordered - and this is tolerable because 
2934
2155
        # the previous code was also unordered.
2935
2156
        previous_entries = dict((head, parent_candiate_entries[head]) for head
2936
2157
            in heads)
2937
2158
        self.snapshot_ie(previous_entries, ie, w, rev_id)
2938
2159
        del ie.text_id
 
2160
        assert getattr(ie, 'revision', None) is not None
 
2161
 
 
2162
    @symbol_versioning.deprecated_method(symbol_versioning.one_one)
 
2163
    def get_parents(self, revision_ids):
 
2164
        for revision_id in revision_ids:
 
2165
            yield self.revisions[revision_id].parent_ids
2939
2166
 
2940
2167
    def get_parent_map(self, revision_ids):
2941
 
        """See graph.StackedParentsProvider.get_parent_map"""
 
2168
        """See graph._StackedParentsProvider.get_parent_map"""
2942
2169
        return dict((revision_id, self.revisions[revision_id])
2943
2170
                    for revision_id in revision_ids
2944
2171
                     if revision_id in self.revisions)
2948
2175
        # a call to:. This needs the path figured out. rather than a work_tree
2949
2176
        # a v4 revision_tree can be given, or something that looks enough like
2950
2177
        # one to give the file content to the entry if it needs it.
2951
 
        # and we need something that looks like a weave store for snapshot to
 
2178
        # and we need something that looks like a weave store for snapshot to 
2952
2179
        # save against.
2953
2180
        #ie.snapshot(rev, PATH, previous_revisions, REVISION_TREE, InMemoryWeaveStore(self.text_weaves))
2954
2181
        if len(previous_revisions) == 1:
2957
2184
                ie.revision = previous_ie.revision
2958
2185
                return
2959
2186
        if ie.has_text():
2960
 
            text = self.branch.repository._text_store.get(ie.text_id)
 
2187
            text = self.branch.repository.weave_store.get(ie.text_id)
2961
2188
            file_lines = text.readlines()
 
2189
            assert sha_strings(file_lines) == ie.text_sha1
 
2190
            assert sum(map(len, file_lines)) == ie.text_size
2962
2191
            w.add_lines(rev_id, previous_revisions, file_lines)
2963
2192
            self.text_count += 1
2964
2193
        else:
2994
2223
    def convert(self, to_convert, pb):
2995
2224
        """See Converter.convert()."""
2996
2225
        self.bzrdir = to_convert
2997
 
        pb = ui.ui_factory.nested_progress_bar()
2998
 
        try:
2999
 
            ui.ui_factory.note('starting upgrade from format 5 to 6')
3000
 
            self._convert_to_prefixed()
3001
 
            return BzrDir.open(self.bzrdir.user_url)
3002
 
        finally:
3003
 
            pb.finished()
 
2226
        self.pb = pb
 
2227
        self.pb.note('starting upgrade from format 5 to 6')
 
2228
        self._convert_to_prefixed()
 
2229
        return BzrDir.open(self.bzrdir.root_transport.base)
3004
2230
 
3005
2231
    def _convert_to_prefixed(self):
3006
2232
        from bzrlib.store import TransportStore
3007
2233
        self.bzrdir.transport.delete('branch-format')
3008
2234
        for store_name in ["weaves", "revision-store"]:
3009
 
            ui.ui_factory.note("adding prefixes to %s" % store_name)
 
2235
            self.pb.note("adding prefixes to %s" % store_name)
3010
2236
            store_transport = self.bzrdir.transport.clone(store_name)
3011
2237
            store = TransportStore(store_transport, prefixed=True)
3012
2238
            for urlfilename in store_transport.list_dir('.'):
3014
2240
                if (filename.endswith(".weave") or
3015
2241
                    filename.endswith(".gz") or
3016
2242
                    filename.endswith(".sig")):
3017
 
                    file_id, suffix = os.path.splitext(filename)
 
2243
                    file_id = os.path.splitext(filename)[0]
3018
2244
                else:
3019
2245
                    file_id = filename
3020
 
                    suffix = ''
3021
 
                new_name = store._mapper.map((file_id,)) + suffix
 
2246
                prefix_dir = store.hash_prefix(file_id)
3022
2247
                # FIXME keep track of the dirs made RBC 20060121
3023
2248
                try:
3024
 
                    store_transport.move(filename, new_name)
 
2249
                    store_transport.move(filename, prefix_dir + '/' + filename)
3025
2250
                except errors.NoSuchFile: # catches missing dirs strangely enough
3026
 
                    store_transport.mkdir(osutils.dirname(new_name))
3027
 
                    store_transport.move(filename, new_name)
3028
 
        self.bzrdir.transport.put_bytes(
3029
 
            'branch-format',
3030
 
            BzrDirFormat6().get_format_string(),
3031
 
            mode=self.bzrdir._get_file_mode())
 
2251
                    store_transport.mkdir(prefix_dir)
 
2252
                    store_transport.move(filename, prefix_dir + '/' + filename)
 
2253
        self.bzrdir._control_files.put_utf8('branch-format', BzrDirFormat6().get_format_string())
3032
2254
 
3033
2255
 
3034
2256
class ConvertBzrDir6ToMeta(Converter):
3039
2261
        from bzrlib.repofmt.weaverepo import RepositoryFormat7
3040
2262
        from bzrlib.branch import BzrBranchFormat5
3041
2263
        self.bzrdir = to_convert
3042
 
        self.pb = ui.ui_factory.nested_progress_bar()
 
2264
        self.pb = pb
3043
2265
        self.count = 0
3044
2266
        self.total = 20 # the steps we know about
3045
2267
        self.garbage_inventories = []
3046
 
        self.dir_mode = self.bzrdir._get_dir_mode()
3047
 
        self.file_mode = self.bzrdir._get_file_mode()
3048
2268
 
3049
 
        ui.ui_factory.note('starting upgrade from format 6 to metadir')
3050
 
        self.bzrdir.transport.put_bytes(
3051
 
                'branch-format',
3052
 
                "Converting to format 6",
3053
 
                mode=self.file_mode)
 
2269
        self.pb.note('starting upgrade from format 6 to metadir')
 
2270
        self.bzrdir._control_files.put_utf8('branch-format', "Converting to format 6")
3054
2271
        # its faster to move specific files around than to open and use the apis...
3055
2272
        # first off, nuke ancestry.weave, it was never used.
3056
2273
        try:
3066
2283
            if name.startswith('basis-inventory.'):
3067
2284
                self.garbage_inventories.append(name)
3068
2285
        # create new directories for repository, working tree and branch
 
2286
        self.dir_mode = self.bzrdir._control_files._dir_mode
 
2287
        self.file_mode = self.bzrdir._control_files._file_mode
3069
2288
        repository_names = [('inventory.weave', True),
3070
2289
                            ('revision-store', True),
3071
2290
                            ('weaves', True)]
3073
2292
        self.bzrdir.transport.mkdir('repository', mode=self.dir_mode)
3074
2293
        self.make_lock('repository')
3075
2294
        # we hard code the formats here because we are converting into
3076
 
        # the meta format. The meta format upgrader can take this to a
 
2295
        # the meta format. The meta format upgrader can take this to a 
3077
2296
        # future format within each component.
3078
2297
        self.put_format('repository', RepositoryFormat7())
3079
2298
        for entry in repository_names:
3102
2321
        else:
3103
2322
            has_checkout = True
3104
2323
        if not has_checkout:
3105
 
            ui.ui_factory.note('No working tree.')
 
2324
            self.pb.note('No working tree.')
3106
2325
            # If some checkout files are there, we may as well get rid of them.
3107
2326
            for name, mandatory in checkout_files:
3108
2327
                if name in bzrcontents:
3119
2338
            for entry in checkout_files:
3120
2339
                self.move_entry('checkout', entry)
3121
2340
            if last_revision is not None:
3122
 
                self.bzrdir.transport.put_bytes(
 
2341
                self.bzrdir._control_files.put_utf8(
3123
2342
                    'checkout/last-revision', last_revision)
3124
 
        self.bzrdir.transport.put_bytes(
3125
 
            'branch-format',
3126
 
            BzrDirMetaFormat1().get_format_string(),
3127
 
            mode=self.file_mode)
3128
 
        self.pb.finished()
3129
 
        return BzrDir.open(self.bzrdir.user_url)
 
2343
        self.bzrdir._control_files.put_utf8(
 
2344
            'branch-format', BzrDirMetaFormat1().get_format_string())
 
2345
        return BzrDir.open(self.bzrdir.root_transport.base)
3130
2346
 
3131
2347
    def make_lock(self, name):
3132
2348
        """Make a lock for the new control dir name."""
3149
2365
                raise
3150
2366
 
3151
2367
    def put_format(self, dirname, format):
3152
 
        self.bzrdir.transport.put_bytes('%s/format' % dirname,
3153
 
            format.get_format_string(),
3154
 
            self.file_mode)
 
2368
        self.bzrdir._control_files.put_utf8('%s/format' % dirname, format.get_format_string())
3155
2369
 
3156
2370
 
3157
2371
class ConvertMetaToMeta(Converter):
3167
2381
    def convert(self, to_convert, pb):
3168
2382
        """See Converter.convert()."""
3169
2383
        self.bzrdir = to_convert
3170
 
        self.pb = ui.ui_factory.nested_progress_bar()
 
2384
        self.pb = pb
3171
2385
        self.count = 0
3172
2386
        self.total = 1
3173
2387
        self.step('checking repository format')
3178
2392
        else:
3179
2393
            if not isinstance(repo._format, self.target_format.repository_format.__class__):
3180
2394
                from bzrlib.repository import CopyConverter
3181
 
                ui.ui_factory.note('starting repository conversion')
 
2395
                self.pb.note('starting repository conversion')
3182
2396
                converter = CopyConverter(self.target_format.repository_format)
3183
2397
                converter.convert(repo, pb)
3184
 
        for branch in self.bzrdir.list_branches():
 
2398
        try:
 
2399
            branch = self.bzrdir.open_branch()
 
2400
        except errors.NotBranchError:
 
2401
            pass
 
2402
        else:
3185
2403
            # TODO: conversions of Branch and Tree should be done by
3186
 
            # InterXFormat lookups/some sort of registry.
 
2404
            # InterXFormat lookups
3187
2405
            # Avoid circular imports
3188
2406
            from bzrlib import branch as _mod_branch
3189
 
            old = branch._format.__class__
3190
 
            new = self.target_format.get_branch_format().__class__
3191
 
            while old != new:
3192
 
                if (old == _mod_branch.BzrBranchFormat5 and
3193
 
                    new in (_mod_branch.BzrBranchFormat6,
3194
 
                        _mod_branch.BzrBranchFormat7,
3195
 
                        _mod_branch.BzrBranchFormat8)):
3196
 
                    branch_converter = _mod_branch.Converter5to6()
3197
 
                elif (old == _mod_branch.BzrBranchFormat6 and
3198
 
                    new in (_mod_branch.BzrBranchFormat7,
3199
 
                            _mod_branch.BzrBranchFormat8)):
3200
 
                    branch_converter = _mod_branch.Converter6to7()
3201
 
                elif (old == _mod_branch.BzrBranchFormat7 and
3202
 
                      new is _mod_branch.BzrBranchFormat8):
3203
 
                    branch_converter = _mod_branch.Converter7to8()
3204
 
                else:
3205
 
                    raise errors.BadConversionTarget("No converter", new,
3206
 
                        branch._format)
 
2407
            if (branch._format.__class__ is _mod_branch.BzrBranchFormat5 and
 
2408
                self.target_format.get_branch_format().__class__ is
 
2409
                _mod_branch.BzrBranchFormat6):
 
2410
                branch_converter = _mod_branch.Converter5to6()
3207
2411
                branch_converter.convert(branch)
3208
 
                branch = self.bzrdir.open_branch()
3209
 
                old = branch._format.__class__
3210
2412
        try:
3211
2413
            tree = self.bzrdir.open_workingtree(recommend_upgrade=False)
3212
2414
        except (errors.NoWorkingTree, errors.NotLocalUrl):
3215
2417
            # TODO: conversions of Branch and Tree should be done by
3216
2418
            # InterXFormat lookups
3217
2419
            if (isinstance(tree, workingtree.WorkingTree3) and
3218
 
                not isinstance(tree, workingtree_4.DirStateWorkingTree) and
 
2420
                not isinstance(tree, workingtree_4.WorkingTree4) and
3219
2421
                isinstance(self.target_format.workingtree_format,
3220
 
                    workingtree_4.DirStateWorkingTreeFormat)):
 
2422
                    workingtree_4.WorkingTreeFormat4)):
3221
2423
                workingtree_4.Converter3to4().convert(tree)
3222
 
            if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
3223
 
                not isinstance(tree, workingtree_4.WorkingTree5) and
3224
 
                isinstance(self.target_format.workingtree_format,
3225
 
                    workingtree_4.WorkingTreeFormat5)):
3226
 
                workingtree_4.Converter4to5().convert(tree)
3227
 
            if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
3228
 
                not isinstance(tree, workingtree_4.WorkingTree6) and
3229
 
                isinstance(self.target_format.workingtree_format,
3230
 
                    workingtree_4.WorkingTreeFormat6)):
3231
 
                workingtree_4.Converter4or5to6().convert(tree)
3232
 
        self.pb.finished()
3233
2424
        return to_convert
3234
2425
 
3235
2426
 
3236
 
# This is not in remote.py because it's relatively small, and needs to be
3237
 
# registered. Putting it in remote.py creates a circular import problem.
 
2427
# This is not in remote.py because it's small, and needs to be registered.
 
2428
# Putting it in remote.py creates a circular import problem.
3238
2429
# we can make it a lazy object if the control formats is turned into something
3239
2430
# like a registry.
3240
2431
class RemoteBzrDirFormat(BzrDirMetaFormat1):
3241
2432
    """Format representing bzrdirs accessed via a smart server"""
3242
2433
 
3243
 
    def __init__(self):
3244
 
        BzrDirMetaFormat1.__init__(self)
3245
 
        # XXX: It's a bit ugly that the network name is here, because we'd
3246
 
        # like to believe that format objects are stateless or at least
3247
 
        # immutable,  However, we do at least avoid mutating the name after
3248
 
        # it's returned.  See <https://bugs.edge.launchpad.net/bzr/+bug/504102>
3249
 
        self._network_name = None
3250
 
 
3251
 
    def __repr__(self):
3252
 
        return "%s(_network_name=%r)" % (self.__class__.__name__,
3253
 
            self._network_name)
3254
 
 
3255
2434
    def get_format_description(self):
3256
 
        if self._network_name:
3257
 
            real_format = network_format_registry.get(self._network_name)
3258
 
            return 'Remote: ' + real_format.get_format_description()
3259
2435
        return 'bzr remote bzrdir'
3260
 
 
3261
 
    def get_format_string(self):
3262
 
        raise NotImplementedError(self.get_format_string)
3263
 
 
3264
 
    def network_name(self):
3265
 
        if self._network_name:
3266
 
            return self._network_name
3267
 
        else:
3268
 
            raise AssertionError("No network name set.")
3269
 
 
 
2436
    
3270
2437
    @classmethod
3271
2438
    def probe_transport(klass, transport):
3272
2439
        """Return a RemoteBzrDirFormat object if it looks possible."""
3273
2440
        try:
3274
2441
            medium = transport.get_smart_medium()
3275
2442
        except (NotImplementedError, AttributeError,
3276
 
                errors.TransportNotPossible, errors.NoSmartMedium,
3277
 
                errors.SmartProtocolError):
 
2443
                errors.TransportNotPossible, errors.NoSmartMedium):
3278
2444
            # no smart server, so not a branch for this format type.
3279
2445
            raise errors.NotBranchError(path=transport.base)
3280
2446
        else:
3281
2447
            # Decline to open it if the server doesn't support our required
3282
 
            # version (3) so that the VFS-based transport will do it.
3283
 
            if medium.should_probe():
3284
 
                try:
3285
 
                    server_version = medium.protocol_version()
3286
 
                except errors.SmartProtocolError:
3287
 
                    # Apparently there's no usable smart server there, even though
3288
 
                    # the medium supports the smart protocol.
3289
 
                    raise errors.NotBranchError(path=transport.base)
3290
 
                if server_version != '2':
3291
 
                    raise errors.NotBranchError(path=transport.base)
 
2448
            # version (2) so that the VFS-based transport will do it.
 
2449
            try:
 
2450
                server_version = medium.protocol_version()
 
2451
            except errors.SmartProtocolError:
 
2452
                # Apparently there's no usable smart server there, even though
 
2453
                # the medium supports the smart protocol.
 
2454
                raise errors.NotBranchError(path=transport.base)
 
2455
            if server_version != 2:
 
2456
                raise errors.NotBranchError(path=transport.base)
3292
2457
            return klass()
3293
2458
 
3294
2459
    def initialize_on_transport(self, transport):
3299
2464
            # TODO: lookup the local format from a server hint.
3300
2465
            local_dir_format = BzrDirMetaFormat1()
3301
2466
            return local_dir_format.initialize_on_transport(transport)
3302
 
        client = _SmartClient(client_medium)
 
2467
        client = _SmartClient(client_medium, transport.base)
3303
2468
        path = client.remote_path_from_transport(transport)
3304
 
        try:
3305
 
            response = client.call('BzrDirFormat.initialize', path)
3306
 
        except errors.ErrorFromSmartServer, err:
3307
 
            remote._translate_error(err, path=path)
3308
 
        if response[0] != 'ok':
3309
 
            raise errors.SmartProtocolError('unexpected response code %s' % (response,))
3310
 
        format = RemoteBzrDirFormat()
3311
 
        self._supply_sub_formats_to(format)
3312
 
        return remote.RemoteBzrDir(transport, format)
3313
 
 
3314
 
    def parse_NoneTrueFalse(self, arg):
3315
 
        if not arg:
3316
 
            return None
3317
 
        if arg == 'False':
3318
 
            return False
3319
 
        if arg == 'True':
3320
 
            return True
3321
 
        raise AssertionError("invalid arg %r" % arg)
3322
 
 
3323
 
    def _serialize_NoneTrueFalse(self, arg):
3324
 
        if arg is False:
3325
 
            return 'False'
3326
 
        if arg:
3327
 
            return 'True'
3328
 
        return ''
3329
 
 
3330
 
    def _serialize_NoneString(self, arg):
3331
 
        return arg or ''
3332
 
 
3333
 
    def initialize_on_transport_ex(self, transport, use_existing_dir=False,
3334
 
        create_prefix=False, force_new_repo=False, stacked_on=None,
3335
 
        stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
3336
 
        shared_repo=False):
3337
 
        try:
3338
 
            # hand off the request to the smart server
3339
 
            client_medium = transport.get_smart_medium()
3340
 
        except errors.NoSmartMedium:
3341
 
            do_vfs = True
3342
 
        else:
3343
 
            # Decline to open it if the server doesn't support our required
3344
 
            # version (3) so that the VFS-based transport will do it.
3345
 
            if client_medium.should_probe():
3346
 
                try:
3347
 
                    server_version = client_medium.protocol_version()
3348
 
                    if server_version != '2':
3349
 
                        do_vfs = True
3350
 
                    else:
3351
 
                        do_vfs = False
3352
 
                except errors.SmartProtocolError:
3353
 
                    # Apparently there's no usable smart server there, even though
3354
 
                    # the medium supports the smart protocol.
3355
 
                    do_vfs = True
3356
 
            else:
3357
 
                do_vfs = False
3358
 
        if not do_vfs:
3359
 
            client = _SmartClient(client_medium)
3360
 
            path = client.remote_path_from_transport(transport)
3361
 
            if client_medium._is_remote_before((1, 16)):
3362
 
                do_vfs = True
3363
 
        if do_vfs:
3364
 
            # TODO: lookup the local format from a server hint.
3365
 
            local_dir_format = BzrDirMetaFormat1()
3366
 
            self._supply_sub_formats_to(local_dir_format)
3367
 
            return local_dir_format.initialize_on_transport_ex(transport,
3368
 
                use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3369
 
                force_new_repo=force_new_repo, stacked_on=stacked_on,
3370
 
                stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3371
 
                make_working_trees=make_working_trees, shared_repo=shared_repo,
3372
 
                vfs_only=True)
3373
 
        return self._initialize_on_transport_ex_rpc(client, path, transport,
3374
 
            use_existing_dir, create_prefix, force_new_repo, stacked_on,
3375
 
            stack_on_pwd, repo_format_name, make_working_trees, shared_repo)
3376
 
 
3377
 
    def _initialize_on_transport_ex_rpc(self, client, path, transport,
3378
 
        use_existing_dir, create_prefix, force_new_repo, stacked_on,
3379
 
        stack_on_pwd, repo_format_name, make_working_trees, shared_repo):
3380
 
        args = []
3381
 
        args.append(self._serialize_NoneTrueFalse(use_existing_dir))
3382
 
        args.append(self._serialize_NoneTrueFalse(create_prefix))
3383
 
        args.append(self._serialize_NoneTrueFalse(force_new_repo))
3384
 
        args.append(self._serialize_NoneString(stacked_on))
3385
 
        # stack_on_pwd is often/usually our transport
3386
 
        if stack_on_pwd:
3387
 
            try:
3388
 
                stack_on_pwd = transport.relpath(stack_on_pwd)
3389
 
                if not stack_on_pwd:
3390
 
                    stack_on_pwd = '.'
3391
 
            except errors.PathNotChild:
3392
 
                pass
3393
 
        args.append(self._serialize_NoneString(stack_on_pwd))
3394
 
        args.append(self._serialize_NoneString(repo_format_name))
3395
 
        args.append(self._serialize_NoneTrueFalse(make_working_trees))
3396
 
        args.append(self._serialize_NoneTrueFalse(shared_repo))
3397
 
        request_network_name = self._network_name or \
3398
 
            BzrDirFormat.get_default_format().network_name()
3399
 
        try:
3400
 
            response = client.call('BzrDirFormat.initialize_ex_1.16',
3401
 
                request_network_name, path, *args)
3402
 
        except errors.UnknownSmartMethod:
3403
 
            client._medium._remember_remote_is_before((1,16))
3404
 
            local_dir_format = BzrDirMetaFormat1()
3405
 
            self._supply_sub_formats_to(local_dir_format)
3406
 
            return local_dir_format.initialize_on_transport_ex(transport,
3407
 
                use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3408
 
                force_new_repo=force_new_repo, stacked_on=stacked_on,
3409
 
                stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3410
 
                make_working_trees=make_working_trees, shared_repo=shared_repo,
3411
 
                vfs_only=True)
3412
 
        except errors.ErrorFromSmartServer, err:
3413
 
            remote._translate_error(err, path=path)
3414
 
        repo_path = response[0]
3415
 
        bzrdir_name = response[6]
3416
 
        require_stacking = response[7]
3417
 
        require_stacking = self.parse_NoneTrueFalse(require_stacking)
3418
 
        format = RemoteBzrDirFormat()
3419
 
        format._network_name = bzrdir_name
3420
 
        self._supply_sub_formats_to(format)
3421
 
        bzrdir = remote.RemoteBzrDir(transport, format, _client=client)
3422
 
        if repo_path:
3423
 
            repo_format = remote.response_tuple_to_repo_format(response[1:])
3424
 
            if repo_path == '.':
3425
 
                repo_path = ''
3426
 
            if repo_path:
3427
 
                repo_bzrdir_format = RemoteBzrDirFormat()
3428
 
                repo_bzrdir_format._network_name = response[5]
3429
 
                repo_bzr = remote.RemoteBzrDir(transport.clone(repo_path),
3430
 
                    repo_bzrdir_format)
3431
 
            else:
3432
 
                repo_bzr = bzrdir
3433
 
            final_stack = response[8] or None
3434
 
            final_stack_pwd = response[9] or None
3435
 
            if final_stack_pwd:
3436
 
                final_stack_pwd = urlutils.join(
3437
 
                    transport.base, final_stack_pwd)
3438
 
            remote_repo = remote.RemoteRepository(repo_bzr, repo_format)
3439
 
            if len(response) > 10:
3440
 
                # Updated server verb that locks remotely.
3441
 
                repo_lock_token = response[10] or None
3442
 
                remote_repo.lock_write(repo_lock_token, _skip_rpc=True)
3443
 
                if repo_lock_token:
3444
 
                    remote_repo.dont_leave_lock_in_place()
3445
 
            else:
3446
 
                remote_repo.lock_write()
3447
 
            policy = UseExistingRepository(remote_repo, final_stack,
3448
 
                final_stack_pwd, require_stacking)
3449
 
            policy.acquire_repository()
3450
 
        else:
3451
 
            remote_repo = None
3452
 
            policy = None
3453
 
        bzrdir._format.set_branch_format(self.get_branch_format())
3454
 
        if require_stacking:
3455
 
            # The repo has already been created, but we need to make sure that
3456
 
            # we'll make a stackable branch.
3457
 
            bzrdir._format.require_stacking(_skip_repo=True)
3458
 
        return remote_repo, bzrdir, require_stacking, policy
 
2469
        response = client.call('BzrDirFormat.initialize', path)
 
2470
        assert response[0] in ('ok', ), 'unexpected response code %s' % (response,)
 
2471
        return remote.RemoteBzrDir(transport)
3459
2472
 
3460
2473
    def _open(self, transport):
3461
 
        return remote.RemoteBzrDir(transport, self)
 
2474
        return remote.RemoteBzrDir(transport)
3462
2475
 
3463
2476
    def __eq__(self, other):
3464
2477
        if not isinstance(other, RemoteBzrDirFormat):
3465
2478
            return False
3466
2479
        return self.get_format_description() == other.get_format_description()
3467
2480
 
3468
 
    def __return_repository_format(self):
3469
 
        # Always return a RemoteRepositoryFormat object, but if a specific bzr
3470
 
        # repository format has been asked for, tell the RemoteRepositoryFormat
3471
 
        # that it should use that for init() etc.
3472
 
        result = remote.RemoteRepositoryFormat()
3473
 
        custom_format = getattr(self, '_repository_format', None)
3474
 
        if custom_format:
3475
 
            if isinstance(custom_format, remote.RemoteRepositoryFormat):
3476
 
                return custom_format
3477
 
            else:
3478
 
                # We will use the custom format to create repositories over the
3479
 
                # wire; expose its details like rich_root_data for code to
3480
 
                # query
3481
 
                result._custom_format = custom_format
3482
 
        return result
3483
 
 
3484
 
    def get_branch_format(self):
3485
 
        result = BzrDirMetaFormat1.get_branch_format(self)
3486
 
        if not isinstance(result, remote.RemoteBranchFormat):
3487
 
            new_result = remote.RemoteBranchFormat()
3488
 
            new_result._custom_format = result
3489
 
            # cache the result
3490
 
            self.set_branch_format(new_result)
3491
 
            result = new_result
3492
 
        return result
3493
 
 
3494
 
    repository_format = property(__return_repository_format,
3495
 
        BzrDirMetaFormat1._set_repository_format) #.im_func)
3496
 
 
3497
2481
 
3498
2482
BzrDirFormat.register_control_server_format(RemoteBzrDirFormat)
3499
2483
 
3509
2493
 
3510
2494
class BzrDirFormatRegistry(registry.Registry):
3511
2495
    """Registry of user-selectable BzrDir subformats.
3512
 
 
 
2496
    
3513
2497
    Differs from BzrDirFormat._control_formats in that it provides sub-formats,
3514
2498
    e.g. BzrDirMeta1 with weave repository.  Also, it's more user-oriented.
3515
2499
    """
3517
2501
    def __init__(self):
3518
2502
        """Create a BzrDirFormatRegistry."""
3519
2503
        self._aliases = set()
3520
 
        self._registration_order = list()
3521
2504
        super(BzrDirFormatRegistry, self).__init__()
3522
2505
 
3523
2506
    def aliases(self):
3534
2517
        """Register a metadir subformat.
3535
2518
 
3536
2519
        These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
3537
 
        by the Repository/Branch/WorkingTreeformats.
 
2520
        by the Repository format.
3538
2521
 
3539
2522
        :param repository_format: The fully-qualified repository format class
3540
2523
            name as a string.
3574
2557
    def register(self, key, factory, help, native=True, deprecated=False,
3575
2558
                 hidden=False, experimental=False, alias=False):
3576
2559
        """Register a BzrDirFormat factory.
3577
 
 
 
2560
        
3578
2561
        The factory must be a callable that takes one parameter: the key.
3579
2562
        It must produce an instance of the BzrDirFormat when called.
3580
2563
 
3585
2568
            BzrDirFormatInfo(native, deprecated, hidden, experimental))
3586
2569
        if alias:
3587
2570
            self._aliases.add(key)
3588
 
        self._registration_order.append(key)
3589
2571
 
3590
2572
    def register_lazy(self, key, module_name, member_name, help, native=True,
3591
2573
        deprecated=False, hidden=False, experimental=False, alias=False):
3593
2575
            help, BzrDirFormatInfo(native, deprecated, hidden, experimental))
3594
2576
        if alias:
3595
2577
            self._aliases.add(key)
3596
 
        self._registration_order.append(key)
3597
2578
 
3598
2579
    def set_default(self, key):
3599
2580
        """Set the 'default' key to be a clone of the supplied key.
3600
 
 
 
2581
        
3601
2582
        This method must be called once and only once.
3602
2583
        """
3603
2584
        registry.Registry.register(self, 'default', self.get(key),
3606
2587
 
3607
2588
    def set_default_repository(self, key):
3608
2589
        """Set the FormatRegistry default and Repository default.
3609
 
 
 
2590
        
3610
2591
        This is a transitional method while Repository.set_default_format
3611
2592
        is deprecated.
3612
2593
        """
3614
2595
            self.remove('default')
3615
2596
        self.set_default(key)
3616
2597
        format = self.get('default')()
 
2598
        assert isinstance(format, BzrDirMetaFormat1)
3617
2599
 
3618
2600
    def make_bzrdir(self, key):
3619
2601
        return self.get(key)()
3620
2602
 
3621
2603
    def help_topic(self, topic):
3622
 
        output = ""
 
2604
        output = textwrap.dedent("""\
 
2605
            These formats can be used for creating branches, working trees, and
 
2606
            repositories.
 
2607
 
 
2608
            """)
3623
2609
        default_realkey = None
3624
2610
        default_help = self.get_help('default')
3625
2611
        help_pairs = []
3626
 
        for key in self._registration_order:
 
2612
        for key in self.keys():
3627
2613
            if key == 'default':
3628
2614
                continue
3629
2615
            help = self.get_help(key)
3635
2621
        def wrapped(key, help, info):
3636
2622
            if info.native:
3637
2623
                help = '(native) ' + help
3638
 
            return ':%s:\n%s\n\n' % (key,
3639
 
                textwrap.fill(help, initial_indent='    ',
3640
 
                    subsequent_indent='    ',
3641
 
                    break_long_words=False))
 
2624
            return ':%s:\n%s\n\n' % (key, 
 
2625
                    textwrap.fill(help, initial_indent='    ', 
 
2626
                    subsequent_indent='    '))
3642
2627
        if default_realkey is not None:
3643
2628
            output += wrapped(default_realkey, '(default) %s' % default_help,
3644
2629
                              self.get_info('default'))
3654
2639
                experimental_pairs.append((key, help))
3655
2640
            else:
3656
2641
                output += wrapped(key, help, info)
3657
 
        output += "\nSee :doc:`formats-help` for more about storage formats."
3658
 
        other_output = ""
3659
2642
        if len(experimental_pairs) > 0:
3660
 
            other_output += "Experimental formats are shown below.\n\n"
 
2643
            output += "Experimental formats are shown below.\n\n"
3661
2644
            for key, help in experimental_pairs:
3662
2645
                info = self.get_info(key)
3663
 
                other_output += wrapped(key, help, info)
3664
 
        else:
3665
 
            other_output += \
3666
 
                "No experimental formats are available.\n\n"
 
2646
                output += wrapped(key, help, info)
3667
2647
        if len(deprecated_pairs) > 0:
3668
 
            other_output += "\nDeprecated formats are shown below.\n\n"
 
2648
            output += "Deprecated formats are shown below.\n\n"
3669
2649
            for key, help in deprecated_pairs:
3670
2650
                info = self.get_info(key)
3671
 
                other_output += wrapped(key, help, info)
3672
 
        else:
3673
 
            other_output += \
3674
 
                "\nNo deprecated formats are available.\n\n"
3675
 
        other_output += \
3676
 
                "\nSee :doc:`formats-help` for more about storage formats."
 
2651
                output += wrapped(key, help, info)
3677
2652
 
3678
 
        if topic == 'other-formats':
3679
 
            return other_output
3680
 
        else:
3681
 
            return output
 
2653
        return output
3682
2654
 
3683
2655
 
3684
2656
class RepositoryAcquisitionPolicy(object):
3688
2660
    for a branch that is being created.  The most basic policy decision is
3689
2661
    whether to create a new repository or use an existing one.
3690
2662
    """
3691
 
    def __init__(self, stack_on, stack_on_pwd, require_stacking):
3692
 
        """Constructor.
3693
 
 
3694
 
        :param stack_on: A location to stack on
3695
 
        :param stack_on_pwd: If stack_on is relative, the location it is
3696
 
            relative to.
3697
 
        :param require_stacking: If True, it is a failure to not stack.
3698
 
        """
3699
 
        self._stack_on = stack_on
3700
 
        self._stack_on_pwd = stack_on_pwd
3701
 
        self._require_stacking = require_stacking
3702
2663
 
3703
2664
    def configure_branch(self, branch):
3704
2665
        """Apply any configuration data from this policy to the branch.
3705
2666
 
3706
 
        Default implementation sets repository stacking.
 
2667
        Default implementation does nothing.
3707
2668
        """
3708
 
        if self._stack_on is None:
3709
 
            return
3710
 
        if self._stack_on_pwd is None:
3711
 
            stack_on = self._stack_on
3712
 
        else:
3713
 
            try:
3714
 
                stack_on = urlutils.rebase_url(self._stack_on,
3715
 
                    self._stack_on_pwd,
3716
 
                    branch.user_url)
3717
 
            except errors.InvalidRebaseURLs:
3718
 
                stack_on = self._get_full_stack_on()
3719
 
        try:
3720
 
            branch.set_stacked_on_url(stack_on)
3721
 
        except (errors.UnstackableBranchFormat,
3722
 
                errors.UnstackableRepositoryFormat):
3723
 
            if self._require_stacking:
3724
 
                raise
3725
 
 
3726
 
    def requires_stacking(self):
3727
 
        """Return True if this policy requires stacking."""
3728
 
        return self._stack_on is not None and self._require_stacking
3729
 
 
3730
 
    def _get_full_stack_on(self):
3731
 
        """Get a fully-qualified URL for the stack_on location."""
3732
 
        if self._stack_on is None:
3733
 
            return None
3734
 
        if self._stack_on_pwd is None:
3735
 
            return self._stack_on
3736
 
        else:
3737
 
            return urlutils.join(self._stack_on_pwd, self._stack_on)
3738
 
 
3739
 
    def _add_fallback(self, repository, possible_transports=None):
3740
 
        """Add a fallback to the supplied repository, if stacking is set."""
3741
 
        stack_on = self._get_full_stack_on()
3742
 
        if stack_on is None:
3743
 
            return
3744
 
        try:
3745
 
            stacked_dir = BzrDir.open(stack_on,
3746
 
                                      possible_transports=possible_transports)
3747
 
        except errors.JailBreak:
3748
 
            # We keep the stacking details, but we are in the server code so
3749
 
            # actually stacking is not needed.
3750
 
            return
3751
 
        try:
3752
 
            stacked_repo = stacked_dir.open_branch().repository
3753
 
        except errors.NotBranchError:
3754
 
            stacked_repo = stacked_dir.open_repository()
3755
 
        try:
3756
 
            repository.add_fallback_repository(stacked_repo)
3757
 
        except errors.UnstackableRepositoryFormat:
3758
 
            if self._require_stacking:
3759
 
                raise
3760
 
        else:
3761
 
            self._require_stacking = True
 
2669
        pass
3762
2670
 
3763
2671
    def acquire_repository(self, make_working_trees=None, shared=False):
3764
2672
        """Acquire a repository for this bzrdir.
3768
2676
        :param make_working_trees: If creating a repository, set
3769
2677
            make_working_trees to this value (if non-None)
3770
2678
        :param shared: If creating a repository, make it shared if True
3771
 
        :return: A repository, is_new_flag (True if the repository was
3772
 
            created).
 
2679
        :return: A repository
3773
2680
        """
3774
2681
        raise NotImplemented(RepositoryAcquisitionPolicy.acquire_repository)
3775
2682
 
3777
2684
class CreateRepository(RepositoryAcquisitionPolicy):
3778
2685
    """A policy of creating a new repository"""
3779
2686
 
3780
 
    def __init__(self, bzrdir, stack_on=None, stack_on_pwd=None,
3781
 
                 require_stacking=False):
3782
 
        """
3783
 
        Constructor.
3784
 
        :param bzrdir: The bzrdir to create the repository on.
3785
 
        :param stack_on: A location to stack on
3786
 
        :param stack_on_pwd: If stack_on is relative, the location it is
3787
 
            relative to.
3788
 
        """
3789
 
        RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
3790
 
                                             require_stacking)
 
2687
    def __init__(self, bzrdir):
 
2688
        RepositoryAcquisitionPolicy.__init__(self)
3791
2689
        self._bzrdir = bzrdir
3792
2690
 
3793
2691
    def acquire_repository(self, make_working_trees=None, shared=False):
3795
2693
 
3796
2694
        Creates the desired repository in the bzrdir we already have.
3797
2695
        """
3798
 
        stack_on = self._get_full_stack_on()
3799
 
        if stack_on:
3800
 
            format = self._bzrdir._format
3801
 
            format.require_stacking(stack_on=stack_on,
3802
 
                                    possible_transports=[self._bzrdir.root_transport])
3803
 
            if not self._require_stacking:
3804
 
                # We have picked up automatic stacking somewhere.
3805
 
                note('Using default stacking branch %s at %s', self._stack_on,
3806
 
                    self._stack_on_pwd)
3807
2696
        repository = self._bzrdir.create_repository(shared=shared)
3808
 
        self._add_fallback(repository,
3809
 
                           possible_transports=[self._bzrdir.transport])
3810
2697
        if make_working_trees is not None:
3811
2698
            repository.set_make_working_trees(make_working_trees)
3812
 
        return repository, True
 
2699
        return repository
3813
2700
 
3814
2701
 
3815
2702
class UseExistingRepository(RepositoryAcquisitionPolicy):
3816
2703
    """A policy of reusing an existing repository"""
3817
2704
 
3818
 
    def __init__(self, repository, stack_on=None, stack_on_pwd=None,
3819
 
                 require_stacking=False):
3820
 
        """Constructor.
3821
 
 
3822
 
        :param repository: The repository to use.
3823
 
        :param stack_on: A location to stack on
3824
 
        :param stack_on_pwd: If stack_on is relative, the location it is
3825
 
            relative to.
3826
 
        """
3827
 
        RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
3828
 
                                             require_stacking)
 
2705
    def __init__(self, repository):
 
2706
        RepositoryAcquisitionPolicy.__init__(self)
3829
2707
        self._repository = repository
3830
2708
 
3831
2709
    def acquire_repository(self, make_working_trees=None, shared=False):
3832
2710
        """Implementation of RepositoryAcquisitionPolicy.acquire_repository
3833
2711
 
3834
 
        Returns an existing repository to use.
 
2712
        Returns an existing repository to use
3835
2713
        """
3836
 
        self._add_fallback(self._repository,
3837
 
                       possible_transports=[self._repository.bzrdir.transport])
3838
 
        return self._repository, False
3839
 
 
3840
 
 
3841
 
# Please register new formats after old formats so that formats
3842
 
# appear in chronological order and format descriptions can build
3843
 
# on previous ones.
 
2714
        return self._repository
 
2715
 
 
2716
 
3844
2717
format_registry = BzrDirFormatRegistry()
3845
 
# The pre-0.8 formats have their repository format network name registered in
3846
 
# repository.py. MetaDir formats have their repository format network name
3847
 
# inferred from their disk format string.
3848
2718
format_registry.register('weave', BzrDirFormat6,
3849
2719
    'Pre-0.8 format.  Slower than knit and does not'
3850
2720
    ' support checkouts or shared repositories.',
3851
 
    hidden=True,
3852
2721
    deprecated=True)
 
2722
format_registry.register_metadir('knit',
 
2723
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
 
2724
    'Format using knits.  Recommended for interoperation with bzr <= 0.14.',
 
2725
    branch_format='bzrlib.branch.BzrBranchFormat5',
 
2726
    tree_format='bzrlib.workingtree.WorkingTreeFormat3')
3853
2727
format_registry.register_metadir('metaweave',
3854
2728
    'bzrlib.repofmt.weaverepo.RepositoryFormat7',
3855
2729
    'Transitional format in 0.8.  Slower than knit.',
3856
2730
    branch_format='bzrlib.branch.BzrBranchFormat5',
3857
2731
    tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3858
 
    hidden=True,
3859
 
    deprecated=True)
3860
 
format_registry.register_metadir('knit',
3861
 
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3862
 
    'Format using knits.  Recommended for interoperation with bzr <= 0.14.',
3863
 
    branch_format='bzrlib.branch.BzrBranchFormat5',
3864
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3865
 
    hidden=True,
3866
2732
    deprecated=True)
3867
2733
format_registry.register_metadir('dirstate',
3868
2734
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3872
2738
    # this uses bzrlib.workingtree.WorkingTreeFormat4 because importing
3873
2739
    # directly from workingtree_4 triggers a circular import.
3874
2740
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3875
 
    hidden=True,
3876
 
    deprecated=True)
 
2741
    )
3877
2742
format_registry.register_metadir('dirstate-tags',
3878
2743
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3879
2744
    help='New in 0.15: Fast local operations and improved scaling for '
3881
2746
        ' Incompatible with bzr < 0.15.',
3882
2747
    branch_format='bzrlib.branch.BzrBranchFormat6',
3883
2748
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3884
 
    hidden=True,
3885
 
    deprecated=True)
 
2749
    )
3886
2750
format_registry.register_metadir('rich-root',
3887
2751
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
3888
2752
    help='New in 1.0.  Better handling of tree roots.  Incompatible with'
3889
 
        ' bzr < 1.0.',
 
2753
        ' bzr < 1.0',
3890
2754
    branch_format='bzrlib.branch.BzrBranchFormat6',
3891
2755
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3892
 
    hidden=True,
3893
 
    deprecated=True)
 
2756
    )
3894
2757
format_registry.register_metadir('dirstate-with-subtree',
3895
2758
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
3896
2759
    help='New in 0.15: Fast local operations and improved scaling for '
3906
2769
    help='New in 0.92: Pack-based format with data compatible with '
3907
2770
        'dirstate-tags format repositories. Interoperates with '
3908
2771
        'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3909
 
        ,
 
2772
        'Previously called knitpack-experimental.  '
 
2773
        'For more information, see '
 
2774
        'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
3910
2775
    branch_format='bzrlib.branch.BzrBranchFormat6',
3911
2776
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3912
2777
    )
3915
2780
    help='New in 0.92: Pack-based format with data compatible with '
3916
2781
        'dirstate-with-subtree format repositories. Interoperates with '
3917
2782
        'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3918
 
        ,
 
2783
        'Previously called knitpack-experimental.  '
 
2784
        'For more information, see '
 
2785
        'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
3919
2786
    branch_format='bzrlib.branch.BzrBranchFormat6',
3920
2787
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3921
2788
    hidden=True,
3923
2790
    )
3924
2791
format_registry.register_metadir('rich-root-pack',
3925
2792
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
3926
 
    help='New in 1.0: A variant of pack-0.92 that supports rich-root data '
3927
 
         '(needed for bzr-svn and bzr-git).',
 
2793
    help='New in 1.0: Pack-based format with data compatible with '
 
2794
        'rich-root format repositories. Incompatible with'
 
2795
        ' bzr < 1.0',
3928
2796
    branch_format='bzrlib.branch.BzrBranchFormat6',
3929
2797
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3930
 
    hidden=True,
3931
 
    )
3932
 
format_registry.register_metadir('1.6',
3933
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5',
3934
 
    help='A format that allows a branch to indicate that there is another '
3935
 
         '(stacked) repository that should be used to access data that is '
3936
 
         'not present locally.',
3937
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3938
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3939
 
    hidden=True,
3940
 
    )
3941
 
format_registry.register_metadir('1.6.1-rich-root',
3942
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5RichRoot',
3943
 
    help='A variant of 1.6 that supports rich-root data '
3944
 
         '(needed for bzr-svn and bzr-git).',
3945
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3946
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3947
 
    hidden=True,
3948
 
    )
3949
 
format_registry.register_metadir('1.9',
3950
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3951
 
    help='A repository format using B+tree indexes. These indexes '
3952
 
         'are smaller in size, have smarter caching and provide faster '
3953
 
         'performance for most operations.',
3954
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3955
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3956
 
    hidden=True,
3957
 
    )
3958
 
format_registry.register_metadir('1.9-rich-root',
3959
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
3960
 
    help='A variant of 1.9 that supports rich-root data '
3961
 
         '(needed for bzr-svn and bzr-git).',
3962
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3963
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3964
 
    hidden=True,
3965
 
    )
3966
 
format_registry.register_metadir('1.14',
3967
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3968
 
    help='A working-tree format that supports content filtering.',
3969
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3970
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat5',
3971
 
    )
3972
 
format_registry.register_metadir('1.14-rich-root',
3973
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
3974
 
    help='A variant of 1.14 that supports rich-root data '
3975
 
         '(needed for bzr-svn and bzr-git).',
3976
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3977
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat5',
3978
 
    )
3979
 
# The following un-numbered 'development' formats should always just be aliases.
3980
 
format_registry.register_metadir('development-rich-root',
3981
 
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
3982
 
    help='Current development format. Supports rich roots. Can convert data '
3983
 
        'to and from rich-root-pack (and anything compatible with '
3984
 
        'rich-root-pack) format repositories. Repositories and branches in '
3985
 
        'this format can only be read by bzr.dev. Please read '
3986
 
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
 
2798
    )
 
2799
# The following two formats should always just be aliases.
 
2800
format_registry.register_metadir('development',
 
2801
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment0',
 
2802
    help='Current development format. Can convert data to and from pack-0.92 '
 
2803
        '(and anything compatible with pack-0.92) format repositories. '
 
2804
        'Repositories in this format can only be read by bzr.dev. '
 
2805
        'Please read '
 
2806
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3987
2807
        'before use.',
3988
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3989
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
 
2808
    branch_format='bzrlib.branch.BzrBranchFormat6',
 
2809
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3990
2810
    experimental=True,
3991
2811
    alias=True,
3992
 
    hidden=True,
3993
2812
    )
3994
2813
format_registry.register_metadir('development-subtree',
3995
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment2Subtree',
 
2814
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment0Subtree',
3996
2815
    help='Current development format, subtree variant. Can convert data to and '
3997
 
        'from pack-0.92-subtree (and anything compatible with '
3998
 
        'pack-0.92-subtree) format repositories. Repositories and branches in '
3999
 
        'this format can only be read by bzr.dev. Please read '
4000
 
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
4001
 
        'before use.',
4002
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
4003
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4004
 
    experimental=True,
4005
 
    hidden=True,
4006
 
    alias=False, # Restore to being an alias when an actual development subtree format is added
4007
 
                 # This current non-alias status is simply because we did not introduce a
4008
 
                 # chk based subtree format.
4009
 
    )
4010
 
 
4011
 
# And the development formats above will have aliased one of the following:
4012
 
format_registry.register_metadir('development6-rich-root',
4013
 
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
4014
 
    help='pack-1.9 with 255-way hashed CHK inv, group compress, rich roots '
4015
 
        'Please read '
4016
 
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
4017
 
        'before use.',
4018
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
4019
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4020
 
    hidden=True,
4021
 
    experimental=True,
4022
 
    )
4023
 
 
4024
 
format_registry.register_metadir('development7-rich-root',
4025
 
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK2',
4026
 
    help='pack-1.9 with 255-way hashed CHK inv, bencode revision, group compress, '
4027
 
        'rich roots. Please read '
4028
 
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
4029
 
        'before use.',
4030
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
4031
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4032
 
    hidden=True,
4033
 
    experimental=True,
4034
 
    )
4035
 
 
4036
 
format_registry.register_metadir('2a',
4037
 
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
4038
 
    help='First format for bzr 2.0 series.\n'
4039
 
        'Uses group-compress storage.\n'
4040
 
        'Provides rich roots which are a one-way transition.\n',
4041
 
        # 'storage in packs, 255-way hashed CHK inventory, bencode revision, group compress, '
4042
 
        # 'rich roots. Supported by bzr 1.16 and later.',
4043
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
4044
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4045
 
    experimental=True,
4046
 
    )
4047
 
 
4048
 
# The following format should be an alias for the rich root equivalent 
4049
 
# of the default format
4050
 
format_registry.register_metadir('default-rich-root',
4051
 
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
4052
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
4053
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
 
2816
        'from pack-0.92 (and anything compatible with pack-0.92) format '
 
2817
        'repositories. Repositories in this format can only be read by '
 
2818
        'bzr.dev. Please read '
 
2819
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
 
2820
        'before use.',
 
2821
    branch_format='bzrlib.branch.BzrBranchFormat6',
 
2822
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
2823
    experimental=True,
4054
2824
    alias=True,
4055
 
    hidden=True,
4056
 
    help='Same as 2a.')
4057
 
 
4058
 
# The current format that is made on 'bzr init'.
4059
 
format_registry.set_default('2a')
 
2825
    )
 
2826
# And the development formats which the will have aliased one of follow:
 
2827
format_registry.register_metadir('development0',
 
2828
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment0',
 
2829
    help='Trivial rename of pack-0.92 to provide a development format. '
 
2830
        'Please read '
 
2831
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
 
2832
        'before use.',
 
2833
    branch_format='bzrlib.branch.BzrBranchFormat6',
 
2834
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
2835
    hidden=True,
 
2836
    experimental=True,
 
2837
    )
 
2838
format_registry.register_metadir('development0-subtree',
 
2839
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment0Subtree',
 
2840
    help='Trivial rename of pack-0.92-subtree to provide a development format. '
 
2841
        'Please read '
 
2842
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
 
2843
        'before use.',
 
2844
    branch_format='bzrlib.branch.BzrBranchFormat6',
 
2845
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
2846
    hidden=True,
 
2847
    experimental=True,
 
2848
    )
 
2849
format_registry.set_default('pack-0.92')