/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: Aaron Bentley
  • Date: 2008-02-24 16:42:13 UTC
  • mfrom: (3234 +trunk)
  • mto: This revision was merged to the branch mainline in revision 3235.
  • Revision ID: aaron@aaronbentley.com-20080224164213-eza1lzru5bwuwmmj
Merge with bzr.dev

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/bzrdir.py
1
 
# Copyright (C) 2006-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""BzrDir logic. The BzrDir is the basic control directory used by bzr.
18
18
 
27
27
 
28
28
# TODO: Move old formats into a plugin to make this file smaller.
29
29
 
 
30
from cStringIO import StringIO
30
31
import os
31
32
import sys
32
 
import warnings
33
33
 
34
34
from bzrlib.lazy_import import lazy_import
35
35
lazy_import(globals(), """
36
36
from stat import S_ISDIR
37
37
import textwrap
 
38
from warnings import warn
38
39
 
39
40
import bzrlib
40
41
from bzrlib import (
41
 
    branch,
42
 
    config,
43
42
    errors,
44
43
    graph,
45
44
    lockable_files,
46
45
    lockdir,
47
 
    osutils,
 
46
    registry,
48
47
    remote,
49
 
    repository,
50
48
    revision as _mod_revision,
 
49
    symbol_versioning,
51
50
    ui,
52
51
    urlutils,
53
 
    versionedfile,
54
52
    win32utils,
55
53
    workingtree,
56
54
    workingtree_4,
58
56
    xml5,
59
57
    )
60
58
from bzrlib.osutils import (
 
59
    sha_strings,
61
60
    sha_string,
62
61
    )
63
 
from bzrlib.push import (
64
 
    PushResult,
65
 
    )
66
 
from bzrlib.repofmt import pack_repo
67
62
from bzrlib.smart.client import _SmartClient
 
63
from bzrlib.smart import protocol
 
64
from bzrlib.store.revision.text import TextRevisionStore
 
65
from bzrlib.store.text import TextStore
68
66
from bzrlib.store.versioned import WeaveStore
69
67
from bzrlib.transactions import WriteTransaction
70
68
from bzrlib.transport import (
71
69
    do_catching_redirections,
72
70
    get_transport,
73
 
    local,
74
71
    )
75
72
from bzrlib.weave import Weave
76
73
""")
78
75
from bzrlib.trace import (
79
76
    mutter,
80
77
    note,
81
 
    warning,
82
 
    )
83
 
 
84
 
from bzrlib import (
85
 
    hooks,
86
 
    registry,
87
 
    symbol_versioning,
88
 
    )
89
 
    
90
 
    
91
 
class ControlComponent(object):
92
 
    """Abstract base class for control directory components.
93
 
    
94
 
    This provides interfaces that are common across bzrdirs, 
95
 
    repositories, branches, and workingtree control directories.
96
 
    
97
 
    They all expose two urls and transports: the *user* URL is the 
98
 
    one that stops above the control directory (eg .bzr) and that 
99
 
    should normally be used in messages, and the *control* URL is
100
 
    under that in eg .bzr/checkout and is used to read the control
101
 
    files.
102
 
    
103
 
    This can be used as a mixin and is intended to fit with 
104
 
    foreign formats.
105
 
    """
106
 
    
107
 
    @property
108
 
    def control_transport(self):
109
 
        raise NotImplementedError
110
 
   
111
 
    @property
112
 
    def control_url(self):
113
 
        return self.control_transport.base
114
 
    
115
 
    @property
116
 
    def user_transport(self):
117
 
        raise NotImplementedError
118
 
        
119
 
    @property
120
 
    def user_url(self):
121
 
        return self.user_transport.base
122
 
    
123
 
 
124
 
class BzrDir(ControlComponent):
 
78
    )
 
79
from bzrlib.transport.local import LocalTransport
 
80
from bzrlib.symbol_versioning import (
 
81
    deprecated_function,
 
82
    deprecated_method,
 
83
    zero_ninetyone,
 
84
    )
 
85
 
 
86
 
 
87
class BzrDir(object):
125
88
    """A .bzr control diretory.
126
 
 
 
89
    
127
90
    BzrDir instances let you create or open any of the things that can be
128
91
    found within .bzr - checkouts, branches and repositories.
129
 
 
130
 
    :ivar transport:
 
92
    
 
93
    transport
131
94
        the transport which this bzr dir is rooted at (i.e. file:///.../.bzr/)
132
 
    :ivar root_transport:
 
95
    root_transport
133
96
        a transport connected to the directory this bzr was opened from
134
97
        (i.e. the parent directory holding the .bzr directory).
135
 
 
136
 
    Everything in the bzrdir should have the same file permissions.
137
 
 
138
 
    :cvar hooks: An instance of BzrDirHooks.
139
98
    """
140
99
 
141
100
    def break_lock(self):
163
122
        return True
164
123
 
165
124
    def check_conversion_target(self, target_format):
166
 
        """Check that a bzrdir as a whole can be converted to a new format."""
167
 
        # The only current restriction is that the repository content can be 
168
 
        # fetched compatibly with the target.
169
125
        target_repo_format = target_format.repository_format
170
 
        try:
171
 
            self.open_repository()._format.check_conversion_target(
172
 
                target_repo_format)
173
 
        except errors.NoRepositoryPresent:
174
 
            # No repo, no problem.
175
 
            pass
 
126
        source_repo_format = self._format.repository_format
 
127
        source_repo_format.check_conversion_target(target_repo_format)
176
128
 
177
129
    @staticmethod
178
130
    def _check_supported(format, allow_unsupported,
180
132
        basedir=None):
181
133
        """Give an error or warning on old formats.
182
134
 
183
 
        :param format: may be any kind of format - workingtree, branch,
 
135
        :param format: may be any kind of format - workingtree, branch, 
184
136
        or repository.
185
137
 
186
 
        :param allow_unsupported: If true, allow opening
187
 
        formats that are strongly deprecated, and which may
 
138
        :param allow_unsupported: If true, allow opening 
 
139
        formats that are strongly deprecated, and which may 
188
140
        have limited functionality.
189
141
 
190
142
        :param recommend_upgrade: If true (default), warn
202
154
                format.get_format_description(),
203
155
                basedir)
204
156
 
205
 
    def clone(self, url, revision_id=None, force_new_repo=False,
206
 
              preserve_stacking=False):
 
157
    def clone(self, url, revision_id=None, force_new_repo=False):
207
158
        """Clone this bzrdir and its contents to url verbatim.
208
159
 
209
 
        :param url: The url create the clone at.  If url's last component does
210
 
            not exist, it will be created.
211
 
        :param revision_id: The tip revision-id to use for any branch or
212
 
            working tree.  If not None, then the clone operation may tune
 
160
        If url's last component does not exist, it will be created.
 
161
 
 
162
        if revision_id is not None, then the clone operation may tune
213
163
            itself to download less data.
214
 
        :param force_new_repo: Do not use a shared repository for the target
 
164
        :param force_new_repo: Do not use a shared repository for the target 
215
165
                               even if one is available.
216
 
        :param preserve_stacking: When cloning a stacked branch, stack the
217
 
            new branch on top of the other branch's stacked-on branch.
218
166
        """
219
167
        return self.clone_on_transport(get_transport(url),
220
168
                                       revision_id=revision_id,
221
 
                                       force_new_repo=force_new_repo,
222
 
                                       preserve_stacking=preserve_stacking)
 
169
                                       force_new_repo=force_new_repo)
223
170
 
224
171
    def clone_on_transport(self, transport, revision_id=None,
225
 
        force_new_repo=False, preserve_stacking=False, stacked_on=None,
226
 
        create_prefix=False, use_existing_dir=True):
 
172
                           force_new_repo=False):
227
173
        """Clone this bzrdir and its contents to transport verbatim.
228
174
 
229
 
        :param transport: The transport for the location to produce the clone
230
 
            at.  If the target directory does not exist, it will be created.
231
 
        :param revision_id: The tip revision-id to use for any branch or
232
 
            working tree.  If not None, then the clone operation may tune
 
175
        If the target directory does not exist, it will be created.
 
176
 
 
177
        if revision_id is not None, then the clone operation may tune
233
178
            itself to download less data.
234
 
        :param force_new_repo: Do not use a shared repository for the target,
 
179
        :param force_new_repo: Do not use a shared repository for the target 
235
180
                               even if one is available.
236
 
        :param preserve_stacking: When cloning a stacked branch, stack the
237
 
            new branch on top of the other branch's stacked-on branch.
238
 
        :param create_prefix: Create any missing directories leading up to
239
 
            to_transport.
240
 
        :param use_existing_dir: Use an existing directory if one exists.
241
181
        """
242
 
        # Overview: put together a broad description of what we want to end up
243
 
        # with; then make as few api calls as possible to do it.
244
 
        
245
 
        # We may want to create a repo/branch/tree, if we do so what format
246
 
        # would we want for each:
247
 
        require_stacking = (stacked_on is not None)
248
 
        format = self.cloning_metadir(require_stacking)
249
 
        
250
 
        # Figure out what objects we want:
 
182
        transport.ensure_base()
 
183
        result = self._format.initialize_on_transport(transport)
251
184
        try:
252
185
            local_repo = self.find_repository()
253
186
        except errors.NoRepositoryPresent:
254
187
            local_repo = None
255
 
        try:
256
 
            local_branch = self.open_branch()
257
 
        except errors.NotBranchError:
258
 
            local_branch = None
259
 
        else:
260
 
            # enable fallbacks when branch is not a branch reference
261
 
            if local_branch.repository.has_same_location(local_repo):
262
 
                local_repo = local_branch.repository
263
 
            if preserve_stacking:
264
 
                try:
265
 
                    stacked_on = local_branch.get_stacked_on_url()
266
 
                except (errors.UnstackableBranchFormat,
267
 
                        errors.UnstackableRepositoryFormat,
268
 
                        errors.NotStacked):
269
 
                    pass
270
 
        # Bug: We create a metadir without knowing if it can support stacking,
271
 
        # we should look up the policy needs first, or just use it as a hint,
272
 
        # or something.
273
188
        if local_repo:
274
 
            make_working_trees = local_repo.make_working_trees()
275
 
            want_shared = local_repo.is_shared()
276
 
            repo_format_name = format.repository_format.network_name()
277
 
        else:
278
 
            make_working_trees = False
279
 
            want_shared = False
280
 
            repo_format_name = None
281
 
 
282
 
        result_repo, result, require_stacking, repository_policy = \
283
 
            format.initialize_on_transport_ex(transport,
284
 
            use_existing_dir=use_existing_dir, create_prefix=create_prefix,
285
 
            force_new_repo=force_new_repo, stacked_on=stacked_on,
286
 
            stack_on_pwd=self.root_transport.base,
287
 
            repo_format_name=repo_format_name,
288
 
            make_working_trees=make_working_trees, shared_repo=want_shared)
289
 
        if repo_format_name:
290
 
            try:
291
 
                # If the result repository is in the same place as the
292
 
                # resulting bzr dir, it will have no content, further if the
293
 
                # result is not stacked then we know all content should be
294
 
                # copied, and finally if we are copying up to a specific
295
 
                # revision_id then we can use the pending-ancestry-result which
296
 
                # does not require traversing all of history to describe it.
297
 
                if (result_repo.user_url == result.user_url
298
 
                    and not require_stacking and
299
 
                    revision_id is not None):
300
 
                    fetch_spec = graph.PendingAncestryResult(
301
 
                        [revision_id], local_repo)
302
 
                    result_repo.fetch(local_repo, fetch_spec=fetch_spec)
303
 
                else:
 
189
            # may need to copy content in
 
190
            if force_new_repo:
 
191
                result_repo = local_repo.clone(
 
192
                    result,
 
193
                    revision_id=revision_id)
 
194
                result_repo.set_make_working_trees(local_repo.make_working_trees())
 
195
            else:
 
196
                try:
 
197
                    result_repo = result.find_repository()
 
198
                    # fetch content this dir needs.
304
199
                    result_repo.fetch(local_repo, revision_id=revision_id)
305
 
            finally:
306
 
                result_repo.unlock()
307
 
        else:
308
 
            if result_repo is not None:
309
 
                raise AssertionError('result_repo not None(%r)' % result_repo)
 
200
                except errors.NoRepositoryPresent:
 
201
                    # needed to make one anyway.
 
202
                    result_repo = local_repo.clone(
 
203
                        result,
 
204
                        revision_id=revision_id)
 
205
                    result_repo.set_make_working_trees(local_repo.make_working_trees())
310
206
        # 1 if there is a branch present
311
207
        #   make sure its content is available in the target repository
312
208
        #   clone it.
313
 
        if local_branch is not None:
314
 
            result_branch = local_branch.clone(result, revision_id=revision_id,
315
 
                repository_policy=repository_policy)
316
 
        try:
317
 
            # Cheaper to check if the target is not local, than to try making
318
 
            # the tree and fail.
319
 
            result.root_transport.local_abspath('.')
320
 
            if result_repo is None or result_repo.make_working_trees():
 
209
        try:
 
210
            self.open_branch().clone(result, revision_id=revision_id)
 
211
        except errors.NotBranchError:
 
212
            pass
 
213
        try:
 
214
            result_repo = result.find_repository()
 
215
        except errors.NoRepositoryPresent:
 
216
            result_repo = None
 
217
        if result_repo is None or result_repo.make_working_trees():
 
218
            try:
321
219
                self.open_workingtree().clone(result)
322
 
        except (errors.NoWorkingTree, errors.NotLocalUrl):
323
 
            pass
 
220
            except (errors.NoWorkingTree, errors.NotLocalUrl):
 
221
                pass
324
222
        return result
325
223
 
326
224
    # TODO: This should be given a Transport, and should chdir up; otherwise
332
230
    @classmethod
333
231
    def create(cls, base, format=None, possible_transports=None):
334
232
        """Create a new BzrDir at the url 'base'.
335
 
 
 
233
        
336
234
        :param format: If supplied, the format of branch to create.  If not
337
235
            supplied, the default is used.
338
 
        :param possible_transports: If supplied, a list of transports that
 
236
        :param possible_transports: If supplied, a list of transports that 
339
237
            can be reused to share a remote connection.
340
238
        """
341
239
        if cls is not BzrDir:
388
286
                for subdir in sorted(subdirs, reverse=True):
389
287
                    pending.append(current_transport.clone(subdir))
390
288
 
391
 
    def list_branches(self):
392
 
        """Return a sequence of all branches local to this control directory.
393
 
 
394
 
        """
395
 
        try:
396
 
            return [self.open_branch()]
397
 
        except errors.NotBranchError:
398
 
            return []
399
 
 
400
289
    @staticmethod
401
290
    def find_branches(transport):
402
291
        """Find all branches under a transport.
414
303
            except errors.NoRepositoryPresent:
415
304
                pass
416
305
            else:
417
 
                return False, ([], repository)
418
 
            return True, (bzrdir.list_branches(), None)
419
 
        ret = []
420
 
        for branches, repo in BzrDir.find_bzrdirs(transport,
421
 
                                                  evaluate=evaluate):
 
306
                return False, (None, repository)
 
307
            try:
 
308
                branch = bzrdir.open_branch()
 
309
            except errors.NotBranchError:
 
310
                return True, (None, None)
 
311
            else:
 
312
                return True, (branch, None)
 
313
        branches = []
 
314
        for branch, repo in BzrDir.find_bzrdirs(transport, evaluate=evaluate):
422
315
            if repo is not None:
423
 
                ret.extend(repo.find_branches())
424
 
            if branches is not None:
425
 
                ret.extend(branches)
426
 
        return ret
 
316
                branches.extend(repo.find_branches())
 
317
            if branch is not None:
 
318
                branches.append(branch)
 
319
        return branches
 
320
 
427
321
 
428
322
    def destroy_repository(self):
429
323
        """Destroy the repository in this BzrDir"""
430
324
        raise NotImplementedError(self.destroy_repository)
431
325
 
432
 
    def create_branch(self, name=None):
 
326
    def create_branch(self):
433
327
        """Create a branch in this BzrDir.
434
328
 
435
 
        :param name: Name of the colocated branch to create, None for
436
 
            the default branch.
437
 
 
438
329
        The bzrdir's format will control what branch format is created.
439
330
        For more control see BranchFormatXX.create(a_bzrdir).
440
331
        """
441
332
        raise NotImplementedError(self.create_branch)
442
333
 
443
 
    def destroy_branch(self, name=None):
444
 
        """Destroy a branch in this BzrDir.
445
 
        
446
 
        :param name: Name of the branch to destroy, None for the default 
447
 
            branch.
448
 
        """
 
334
    def destroy_branch(self):
 
335
        """Destroy the branch in this BzrDir"""
449
336
        raise NotImplementedError(self.destroy_branch)
450
337
 
451
338
    @staticmethod
453
340
        """Create a new BzrDir, Branch and Repository at the url 'base'.
454
341
 
455
342
        This will use the current default BzrDirFormat unless one is
456
 
        specified, and use whatever
 
343
        specified, and use whatever 
457
344
        repository format that that uses via bzrdir.create_branch and
458
345
        create_repository. If a shared repository is available that is used
459
346
        preferentially.
469
356
        bzrdir._find_or_create_repository(force_new_repo)
470
357
        return bzrdir.create_branch()
471
358
 
472
 
    def determine_repository_policy(self, force_new_repo=False, stack_on=None,
473
 
                                    stack_on_pwd=None, require_stacking=False):
474
 
        """Return an object representing a policy to use.
475
 
 
476
 
        This controls whether a new repository is created, and the format of
477
 
        that repository, or some existing shared repository used instead.
478
 
 
479
 
        If stack_on is supplied, will not seek a containing shared repo.
480
 
 
481
 
        :param force_new_repo: If True, require a new repository to be created.
482
 
        :param stack_on: If supplied, the location to stack on.  If not
483
 
            supplied, a default_stack_on location may be used.
484
 
        :param stack_on_pwd: If stack_on is relative, the location it is
485
 
            relative to.
486
 
        """
487
 
        def repository_policy(found_bzrdir):
488
 
            stack_on = None
489
 
            stack_on_pwd = None
490
 
            config = found_bzrdir.get_config()
491
 
            stop = False
492
 
            stack_on = config.get_default_stack_on()
493
 
            if stack_on is not None:
494
 
                stack_on_pwd = found_bzrdir.user_url
495
 
                stop = True
496
 
            # does it have a repository ?
497
 
            try:
498
 
                repository = found_bzrdir.open_repository()
499
 
            except errors.NoRepositoryPresent:
500
 
                repository = None
501
 
            else:
502
 
                if (found_bzrdir.user_url != self.user_url 
503
 
                    and not repository.is_shared()):
504
 
                    # Don't look higher, can't use a higher shared repo.
505
 
                    repository = None
506
 
                    stop = True
507
 
                else:
508
 
                    stop = True
509
 
            if not stop:
510
 
                return None, False
511
 
            if repository:
512
 
                return UseExistingRepository(repository, stack_on,
513
 
                    stack_on_pwd, require_stacking=require_stacking), True
514
 
            else:
515
 
                return CreateRepository(self, stack_on, stack_on_pwd,
516
 
                    require_stacking=require_stacking), True
517
 
 
518
 
        if not force_new_repo:
519
 
            if stack_on is None:
520
 
                policy = self._find_containing(repository_policy)
521
 
                if policy is not None:
522
 
                    return policy
523
 
            else:
524
 
                try:
525
 
                    return UseExistingRepository(self.open_repository(),
526
 
                        stack_on, stack_on_pwd,
527
 
                        require_stacking=require_stacking)
528
 
                except errors.NoRepositoryPresent:
529
 
                    pass
530
 
        return CreateRepository(self, stack_on, stack_on_pwd,
531
 
                                require_stacking=require_stacking)
532
 
 
533
359
    def _find_or_create_repository(self, force_new_repo):
534
360
        """Create a new repository if needed, returning the repository."""
535
 
        policy = self.determine_repository_policy(force_new_repo)
536
 
        return policy.acquire_repository()[0]
537
 
 
 
361
        if force_new_repo:
 
362
            return self.create_repository()
 
363
        try:
 
364
            return self.find_repository()
 
365
        except errors.NoRepositoryPresent:
 
366
            return self.create_repository()
 
367
        
538
368
    @staticmethod
539
369
    def create_branch_convenience(base, force_new_repo=False,
540
370
                                  force_new_tree=None, format=None,
546
376
        not.
547
377
 
548
378
        This will use the current default BzrDirFormat unless one is
549
 
        specified, and use whatever
 
379
        specified, and use whatever 
550
380
        repository format that that uses via bzrdir.create_branch and
551
381
        create_repository. If a shared repository is available that is used
552
382
        preferentially. Whatever repository is used, its tree creation policy
554
384
 
555
385
        The created Branch object is returned.
556
386
        If a working tree cannot be made due to base not being a file:// url,
557
 
        no error is raised unless force_new_tree is True, in which case no
 
387
        no error is raised unless force_new_tree is True, in which case no 
558
388
        data is created on disk and NotLocalUrl is raised.
559
389
 
560
390
        :param base: The URL to create the branch at.
561
391
        :param force_new_repo: If True a new repository is always created.
562
 
        :param force_new_tree: If True or False force creation of a tree or
 
392
        :param force_new_tree: If True or False force creation of a tree or 
563
393
                               prevent such creation respectively.
564
394
        :param format: Override for the bzrdir format to create.
565
395
        :param possible_transports: An optional reusable transports list.
567
397
        if force_new_tree:
568
398
            # check for non local urls
569
399
            t = get_transport(base, possible_transports)
570
 
            if not isinstance(t, local.LocalTransport):
 
400
            if not isinstance(t, LocalTransport):
571
401
                raise errors.NotLocalUrl(base)
572
402
        bzrdir = BzrDir.create(base, format, possible_transports)
573
403
        repo = bzrdir._find_or_create_repository(force_new_repo)
581
411
        return result
582
412
 
583
413
    @staticmethod
 
414
    @deprecated_function(zero_ninetyone)
 
415
    def create_repository(base, shared=False, format=None):
 
416
        """Create a new BzrDir and Repository at the url 'base'.
 
417
 
 
418
        If no format is supplied, this will default to the current default
 
419
        BzrDirFormat by default, and use whatever repository format that that
 
420
        uses for bzrdirformat.create_repository.
 
421
 
 
422
        :param shared: Create a shared repository rather than a standalone
 
423
                       repository.
 
424
        The Repository object is returned.
 
425
 
 
426
        This must be overridden as an instance method in child classes, where
 
427
        it should take no parameters and construct whatever repository format
 
428
        that child class desires.
 
429
 
 
430
        This method is deprecated, please call create_repository on a bzrdir
 
431
        instance instead.
 
432
        """
 
433
        bzrdir = BzrDir.create(base, format)
 
434
        return bzrdir.create_repository(shared)
 
435
 
 
436
    @staticmethod
584
437
    def create_standalone_workingtree(base, format=None):
585
438
        """Create a new BzrDir, WorkingTree, Branch and Repository at 'base'.
586
439
 
587
440
        'base' must be a local path or a file:// url.
588
441
 
589
442
        This will use the current default BzrDirFormat unless one is
590
 
        specified, and use whatever
 
443
        specified, and use whatever 
591
444
        repository format that that uses for bzrdirformat.create_workingtree,
592
445
        create_branch and create_repository.
593
446
 
595
448
        :return: The WorkingTree object.
596
449
        """
597
450
        t = get_transport(base)
598
 
        if not isinstance(t, local.LocalTransport):
 
451
        if not isinstance(t, LocalTransport):
599
452
            raise errors.NotLocalUrl(base)
600
453
        bzrdir = BzrDir.create_branch_and_repo(base,
601
454
                                               force_new_repo=True,
605
458
    def create_workingtree(self, revision_id=None, from_branch=None,
606
459
        accelerator_tree=None, hardlink=False):
607
460
        """Create a working tree at this BzrDir.
608
 
 
 
461
        
609
462
        :param revision_id: create it as of this revision id.
610
463
        :param from_branch: override bzrdir branch (for lightweight checkouts)
611
464
        :param accelerator_tree: A tree which can be used for retrieving file
615
468
        """
616
469
        raise NotImplementedError(self.create_workingtree)
617
470
 
618
 
    def backup_bzrdir(self):
619
 
        """Backup this bzr control directory.
620
 
 
621
 
        :return: Tuple with old path name and new path name
622
 
        """
623
 
        def name_gen(base='backup.bzr'):
624
 
            counter = 1
625
 
            name = "%s.~%d~" % (base, counter)
626
 
            while self.root_transport.has(name):
627
 
                counter += 1
628
 
                name = "%s.~%d~" % (base, counter)
629
 
            return name
630
 
 
631
 
        backup_dir=name_gen()
632
 
        pb = ui.ui_factory.nested_progress_bar()
633
 
        try:
634
 
            # FIXME: bug 300001 -- the backup fails if the backup directory
635
 
            # already exists, but it should instead either remove it or make
636
 
            # a new backup directory.
637
 
            #
638
 
            old_path = self.root_transport.abspath('.bzr')
639
 
            new_path = self.root_transport.abspath(backup_dir)
640
 
            ui.ui_factory.note('making backup of %s\n  to %s' % (old_path, new_path,))
641
 
            self.root_transport.copy_tree('.bzr', backup_dir)
642
 
            return (old_path, new_path)
643
 
        finally:
644
 
            pb.finished()
645
 
 
646
471
    def retire_bzrdir(self, limit=10000):
647
472
        """Permanently disable the bzrdir.
648
473
 
683
508
        """
684
509
        raise NotImplementedError(self.destroy_workingtree_metadata)
685
510
 
686
 
    def _find_containing(self, evaluate):
687
 
        """Find something in a containing control directory.
688
 
 
689
 
        This method will scan containing control dirs, until it finds what
690
 
        it is looking for, decides that it will never find it, or runs out
691
 
        of containing control directories to check.
692
 
 
693
 
        It is used to implement find_repository and
694
 
        determine_repository_policy.
695
 
 
696
 
        :param evaluate: A function returning (value, stop).  If stop is True,
697
 
            the value will be returned.
698
 
        """
699
 
        found_bzrdir = self
700
 
        while True:
701
 
            result, stop = evaluate(found_bzrdir)
702
 
            if stop:
703
 
                return result
704
 
            next_transport = found_bzrdir.root_transport.clone('..')
705
 
            if (found_bzrdir.user_url == next_transport.base):
706
 
                # top of the file system
707
 
                return None
708
 
            # find the next containing bzrdir
709
 
            try:
710
 
                found_bzrdir = BzrDir.open_containing_from_transport(
711
 
                    next_transport)[0]
712
 
            except errors.NotBranchError:
713
 
                return None
714
 
 
715
511
    def find_repository(self):
716
512
        """Find the repository that should be used.
717
513
 
719
515
        new branches as well as to hook existing branches up to their
720
516
        repository.
721
517
        """
722
 
        def usable_repository(found_bzrdir):
 
518
        try:
 
519
            return self.open_repository()
 
520
        except errors.NoRepositoryPresent:
 
521
            pass
 
522
        next_transport = self.root_transport.clone('..')
 
523
        while True:
 
524
            # find the next containing bzrdir
 
525
            try:
 
526
                found_bzrdir = BzrDir.open_containing_from_transport(
 
527
                    next_transport)[0]
 
528
            except errors.NotBranchError:
 
529
                # none found
 
530
                raise errors.NoRepositoryPresent(self)
723
531
            # does it have a repository ?
724
532
            try:
725
533
                repository = found_bzrdir.open_repository()
726
534
            except errors.NoRepositoryPresent:
727
 
                return None, False
728
 
            if found_bzrdir.user_url == self.user_url:
729
 
                return repository, True
730
 
            elif repository.is_shared():
731
 
                return repository, True
 
535
                next_transport = found_bzrdir.root_transport.clone('..')
 
536
                if (found_bzrdir.root_transport.base == next_transport.base):
 
537
                    # top of the file system
 
538
                    break
 
539
                else:
 
540
                    continue
 
541
            if ((found_bzrdir.root_transport.base ==
 
542
                 self.root_transport.base) or repository.is_shared()):
 
543
                return repository
732
544
            else:
733
 
                return None, True
734
 
 
735
 
        found_repo = self._find_containing(usable_repository)
736
 
        if found_repo is None:
737
 
            raise errors.NoRepositoryPresent(self)
738
 
        return found_repo
739
 
 
740
 
    def get_branch_reference(self, name=None):
 
545
                raise errors.NoRepositoryPresent(self)
 
546
        raise errors.NoRepositoryPresent(self)
 
547
 
 
548
    def get_branch_reference(self):
741
549
        """Return the referenced URL for the branch in this bzrdir.
742
550
 
743
 
        :param name: Optional colocated branch name
744
551
        :raises NotBranchError: If there is no Branch.
745
 
        :raises NoColocatedBranchSupport: If a branch name was specified
746
 
            but colocated branches are not supported.
747
552
        :return: The URL the branch in this bzrdir references if it is a
748
553
            reference branch, or None for regular branches.
749
554
        """
750
 
        if name is not None:
751
 
            raise errors.NoColocatedBranchSupport(self)
752
555
        return None
753
556
 
754
 
    def get_branch_transport(self, branch_format, name=None):
 
557
    def get_branch_transport(self, branch_format):
755
558
        """Get the transport for use by branch format in this BzrDir.
756
559
 
757
560
        Note that bzr dirs that do not support format strings will raise
758
561
        IncompatibleFormat if the branch format they are given has
759
562
        a format string, and vice versa.
760
563
 
761
 
        If branch_format is None, the transport is returned with no
 
564
        If branch_format is None, the transport is returned with no 
762
565
        checking. If it is not None, then the returned transport is
763
566
        guaranteed to point to an existing directory ready for use.
764
567
        """
765
568
        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
 
 
 
569
        
811
570
    def get_repository_transport(self, repository_format):
812
571
        """Get the transport for use by repository format in this BzrDir.
813
572
 
815
574
        IncompatibleFormat if the repository format they are given has
816
575
        a format string, and vice versa.
817
576
 
818
 
        If repository_format is None, the transport is returned with no
 
577
        If repository_format is None, the transport is returned with no 
819
578
        checking. If it is not None, then the returned transport is
820
579
        guaranteed to point to an existing directory ready for use.
821
580
        """
822
581
        raise NotImplementedError(self.get_repository_transport)
823
 
 
 
582
        
824
583
    def get_workingtree_transport(self, tree_format):
825
584
        """Get the transport for use by workingtree format in this BzrDir.
826
585
 
828
587
        IncompatibleFormat if the workingtree format they are given has a
829
588
        format string, and vice versa.
830
589
 
831
 
        If workingtree_format is None, the transport is returned with no
 
590
        If workingtree_format is None, the transport is returned with no 
832
591
        checking. If it is not None, then the returned transport is
833
592
        guaranteed to point to an existing directory ready for use.
834
593
        """
835
594
        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
 
 
 
595
        
845
596
    def __init__(self, _transport, _format):
846
597
        """Initialize a Bzr control dir object.
847
 
 
 
598
        
848
599
        Only really common logic should reside here, concrete classes should be
849
600
        made with varying behaviours.
850
601
 
852
603
        :param _transport: the transport this dir is based at.
853
604
        """
854
605
        self._format = _format
855
 
        # these are also under the more standard names of 
856
 
        # control_transport and user_transport
857
606
        self.transport = _transport.clone('.bzr')
858
607
        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
608
 
869
609
    def is_control_filename(self, filename):
870
610
        """True if filename is the name of a path which is reserved for bzrdir's.
871
 
 
 
611
        
872
612
        :param filename: A filename within the root transport of this bzrdir.
873
613
 
874
614
        This is true IF and ONLY IF the filename is part of the namespace reserved
877
617
        this in the future - for instance to make bzr talk with svn working
878
618
        trees.
879
619
        """
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-
 
620
        # this might be better on the BzrDirFormat class because it refers to 
 
621
        # all the possible bzrdir disk formats. 
 
622
        # This method is tested via the workingtree is_control_filename tests- 
883
623
        # it was extracted from WorkingTree.is_control_filename. If the method's
884
624
        # contract is extended beyond the current trivial implementation, please
885
625
        # add new tests for it to the appropriate place.
887
627
 
888
628
    def needs_format_conversion(self, format=None):
889
629
        """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
 
630
        
 
631
        For instance, if the repository format is out of date but the 
892
632
        branch and working tree are not, this should return True.
893
633
 
894
634
        :param format: Optional parameter indicating a specific desired
900
640
    def open_unsupported(base):
901
641
        """Open a branch which is not supported."""
902
642
        return BzrDir.open(base, _unsupported=True)
903
 
 
 
643
        
904
644
    @staticmethod
905
645
    def open(base, _unsupported=False, possible_transports=None):
906
646
        """Open an existing bzrdir, rooted at 'base' (url).
907
 
 
 
647
        
908
648
        :param _unsupported: a private parameter to the BzrDir class.
909
649
        """
910
650
        t = get_transport(base, possible_transports=possible_transports)
918
658
        :param transport: Transport containing the bzrdir.
919
659
        :param _unsupported: private.
920
660
        """
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
661
        base = transport.base
 
662
 
926
663
        def find_format(transport):
927
664
            return transport, BzrDirFormat.find_format(
928
665
                transport, _server_formats=_server_formats)
929
666
 
930
667
        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)
 
668
            qualified_source = e.get_source_url()
 
669
            relpath = transport.relpath(qualified_source)
 
670
            if not e.target.endswith(relpath):
 
671
                # Not redirected to a branch-format, not a branch
 
672
                raise errors.NotBranchError(path=e.target)
 
673
            target = e.target[:-len(relpath)]
934
674
            note('%s is%s redirected to %s',
935
 
                 transport.base, e.permanently, redirected_transport.base)
936
 
            return redirected_transport
 
675
                 transport.base, e.permanently, target)
 
676
            # Let's try with a new transport
 
677
            # FIXME: If 'transport' has a qualifier, this should
 
678
            # be applied again to the new transport *iff* the
 
679
            # schemes used are the same. Uncomment this code
 
680
            # once the function (and tests) exist.
 
681
            # -- vila20070212
 
682
            #target = urlutils.copy_url_qualifiers(original, target)
 
683
            return get_transport(target)
937
684
 
938
685
        try:
939
686
            transport, format = do_catching_redirections(find_format,
945
692
        BzrDir._check_supported(format, _unsupported)
946
693
        return format.open(transport, _found=True)
947
694
 
948
 
    def open_branch(self, name=None, unsupported=False,
949
 
                    ignore_fallbacks=False):
 
695
    def open_branch(self, unsupported=False):
950
696
        """Open the branch object at this BzrDir if one is present.
951
697
 
952
698
        If unsupported is True, then no longer supported branch formats can
953
699
        still be opened.
954
 
 
 
700
        
955
701
        TODO: static convenience version of this?
956
702
        """
957
703
        raise NotImplementedError(self.open_branch)
959
705
    @staticmethod
960
706
    def open_containing(url, possible_transports=None):
961
707
        """Open an existing branch which contains url.
962
 
 
 
708
        
963
709
        :param url: url to search from.
964
710
        See open_containing_from_transport for more detail.
965
711
        """
966
712
        transport = get_transport(url, possible_transports)
967
713
        return BzrDir.open_containing_from_transport(transport)
968
 
 
 
714
    
969
715
    @staticmethod
970
716
    def open_containing_from_transport(a_transport):
971
717
        """Open an existing branch which contains a_transport.base.
974
720
 
975
721
        Basically we keep looking up until we find the control directory or
976
722
        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
 
723
        If there is one and it is either an unrecognised format or an unsupported 
978
724
        format, UnknownFormatError or UnsupportedFormatError are raised.
979
725
        If there is one, it is returned, along with the unused portion of url.
980
726
 
981
 
        :return: The BzrDir that contains the path, and a Unicode path
 
727
        :return: The BzrDir that contains the path, and a Unicode path 
982
728
                for the rest of the URL.
983
729
        """
984
730
        # this gets the normalised url back. I.e. '.' -> the full path.
999
745
                raise errors.NotBranchError(path=url)
1000
746
            a_transport = new_t
1001
747
 
1002
 
    def _get_tree_branch(self, name=None):
 
748
    def _get_tree_branch(self):
1003
749
        """Return the branch and tree, if any, for this bzrdir.
1004
750
 
1005
 
        :param name: Name of colocated branch to open.
1006
 
 
1007
751
        Return None for tree if not present or inaccessible.
1008
752
        Raise NotBranchError if no branch is present.
1009
753
        :return: (tree, branch)
1012
756
            tree = self.open_workingtree()
1013
757
        except (errors.NoWorkingTree, errors.NotLocalUrl):
1014
758
            tree = None
1015
 
            branch = self.open_branch(name=name)
 
759
            branch = self.open_branch()
1016
760
        else:
1017
 
            if name is not None:
1018
 
                branch = self.open_branch(name=name)
1019
 
            else:
1020
 
                branch = tree.branch
 
761
            branch = tree.branch
1021
762
        return tree, branch
1022
763
 
1023
764
    @classmethod
1046
787
        tree, branch = bzrdir._get_tree_branch()
1047
788
        return tree, branch, relpath
1048
789
 
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
790
    def open_repository(self, _unsupported=False):
1075
791
        """Open the repository object at this BzrDir if one is present.
1076
792
 
1095
811
        """
1096
812
        raise NotImplementedError(self.open_workingtree)
1097
813
 
1098
 
    def has_branch(self, name=None):
 
814
    def has_branch(self):
1099
815
        """Tell if this bzrdir contains a branch.
1100
 
 
 
816
        
1101
817
        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.)
 
818
        and try, and not ask permission first.  (This method just opens the 
 
819
        branch and discards it, and that's somewhat expensive.) 
1104
820
        """
1105
821
        try:
1106
 
            self.open_branch(name)
 
822
            self.open_branch()
1107
823
            return True
1108
824
        except errors.NotBranchError:
1109
825
            return False
1113
829
 
1114
830
        This will still raise an exception if the bzrdir has a workingtree that
1115
831
        is remote & inaccessible.
1116
 
 
 
832
        
1117
833
        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.)
 
834
        and try, and not ask permission first.  (This method just opens the 
 
835
        workingtree and discards it, and that's somewhat expensive.) 
1120
836
        """
1121
837
        try:
1122
838
            self.open_workingtree(recommend_upgrade=False)
1125
841
            return False
1126
842
 
1127
843
    def _cloning_metadir(self):
1128
 
        """Produce a metadir suitable for cloning with.
1129
 
 
1130
 
        :returns: (destination_bzrdir_format, source_repository)
1131
 
        """
 
844
        """Produce a metadir suitable for cloning with."""
1132
845
        result_format = self._format.__class__()
1133
846
        try:
1134
847
            try:
1135
 
                branch = self.open_branch(ignore_fallbacks=True)
 
848
                branch = self.open_branch()
1136
849
                source_repository = branch.repository
1137
 
                result_format._branch_format = branch._format
1138
850
            except errors.NotBranchError:
1139
851
                source_branch = None
1140
852
                source_repository = self.open_repository()
1145
857
            # the fix recommended in bug # 103195 - to delegate this choice the
1146
858
            # repository itself.
1147
859
            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
 
860
            if not isinstance(repo_format, remote.RemoteRepositoryFormat):
 
861
                result_format.repository_format = repo_format
1152
862
        try:
1153
863
            # TODO: Couldn't we just probe for the format in these cases,
1154
864
            # rather than opening the whole tree?  It would be a little
1160
870
            result_format.workingtree_format = tree._format.__class__()
1161
871
        return result_format, source_repository
1162
872
 
1163
 
    def cloning_metadir(self, require_stacking=False):
 
873
    def cloning_metadir(self):
1164
874
        """Produce a metadir suitable for cloning or sprouting with.
1165
875
 
1166
876
        These operations may produce workingtrees (yes, even though they're
1167
877
        "cloning" something that doesn't have a tree), so a viable workingtree
1168
878
        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
879
        """
1176
880
        format, repository = self._cloning_metadir()
1177
881
        if format._workingtree_format is None:
1178
 
            # No tree in self.
1179
882
            if repository is None:
1180
 
                # No repository either
1181
883
                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
884
            tree_format = repository._format._matchingbzrdir.workingtree_format
1185
885
            format.workingtree_format = tree_format.__class__()
1186
 
        if require_stacking:
1187
 
            format.require_stacking()
1188
886
        return format
1189
887
 
1190
888
    def checkout_metadir(self):
1192
890
 
1193
891
    def sprout(self, url, revision_id=None, force_new_repo=False,
1194
892
               recurse='down', possible_transports=None,
1195
 
               accelerator_tree=None, hardlink=False, stacked=False,
1196
 
               source_branch=None, create_tree_if_local=True):
 
893
               accelerator_tree=None, hardlink=False):
1197
894
        """Create a copy of this bzrdir prepared for use as a new line of
1198
895
        development.
1199
896
 
1212
909
            content is different.
1213
910
        :param hardlink: If true, hard-link files from accelerator_tree,
1214
911
            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
912
        """
1220
913
        target_transport = get_transport(url, possible_transports)
1221
914
        target_transport.ensure_base()
1222
 
        cloning_format = self.cloning_metadir(stacked)
1223
 
        # Create/update the result branch
 
915
        cloning_format = self.cloning_metadir()
1224
916
        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
 
917
        try:
 
918
            source_branch = self.open_branch()
1231
919
            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:
 
920
        except errors.NotBranchError:
 
921
            source_branch = None
 
922
            try:
 
923
                source_repository = self.open_repository()
 
924
            except errors.NoRepositoryPresent:
 
925
                source_repository = None
 
926
        if force_new_repo:
 
927
            result_repo = None
 
928
        else:
 
929
            try:
 
930
                result_repo = result.find_repository()
 
931
            except errors.NoRepositoryPresent:
 
932
                result_repo = None
 
933
        if source_repository is None and result_repo is not None:
 
934
            pass
 
935
        elif source_repository is None and result_repo is None:
 
936
            # no repo available, make a new one
 
937
            result.create_repository()
 
938
        elif source_repository is not None and result_repo is None:
 
939
            # have source, and want to make a new target repo
 
940
            result_repo = source_repository.sprout(result,
 
941
                                                   revision_id=revision_id)
 
942
        else:
 
943
            # fetch needed content into target.
 
944
            if source_repository is not None:
 
945
                # would rather do 
 
946
                # source_repository.copy_content_into(result_repo,
 
947
                #                                     revision_id=revision_id)
 
948
                # so we can override the copy method
1256
949
                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()
 
950
        if source_branch is not None:
 
951
            source_branch.sprout(result, revision_id=revision_id)
1265
952
        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())):
 
953
            result.create_branch()
 
954
        if isinstance(target_transport, LocalTransport) and (
 
955
            result_repo is None or result_repo.make_working_trees()):
1274
956
            wt = result.create_workingtree(accelerator_tree=accelerator_tree,
1275
957
                hardlink=hardlink)
1276
958
            wt.lock_write()
1289
971
                basis = wt.basis_tree()
1290
972
                basis.lock_read()
1291
973
                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()
 
974
                recurse_branch = wt.branch
1296
975
            elif source_branch is not None:
1297
976
                basis = source_branch.basis_tree()
1298
977
                basis.lock_read()
1299
978
                subtrees = basis.iter_references()
 
979
                recurse_branch = source_branch
1300
980
            else:
1301
981
                subtrees = []
1302
982
                basis = None
1306
986
                    sublocation = source_branch.reference_parent(file_id, path)
1307
987
                    sublocation.bzrdir.sprout(target,
1308
988
                        basis.get_reference_revision(file_id, path),
1309
 
                        force_new_repo=force_new_repo, recurse=recurse,
1310
 
                        stacked=stacked)
 
989
                        force_new_repo=force_new_repo, recurse=recurse)
1311
990
            finally:
1312
991
                if basis is not None:
1313
992
                    basis.unlock()
1314
993
        return result
1315
994
 
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
995
 
1432
996
class BzrDirPreSplitOut(BzrDir):
1433
997
    """A common class for the all-in-one formats."""
1435
999
    def __init__(self, _transport, _format):
1436
1000
        """See BzrDir.__init__."""
1437
1001
        super(BzrDirPreSplitOut, self).__init__(_transport, _format)
 
1002
        assert self._format._lock_class == lockable_files.TransportLock
 
1003
        assert self._format._lock_file_name == 'branch-lock'
1438
1004
        self._control_files = lockable_files.LockableFiles(
1439
1005
                                            self.get_branch_transport(None),
1440
1006
                                            self._format._lock_file_name,
1444
1010
        """Pre-splitout bzrdirs do not suffer from stale locks."""
1445
1011
        raise NotImplementedError(self.break_lock)
1446
1012
 
1447
 
    def cloning_metadir(self, require_stacking=False):
1448
 
        """Produce a metadir suitable for cloning with."""
1449
 
        if require_stacking:
1450
 
            return format_registry.make_bzrdir('1.6')
1451
 
        return self._format.__class__()
1452
 
 
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
 
        """
 
1013
    def clone(self, url, revision_id=None, force_new_repo=False):
 
1014
        """See BzrDir.clone()."""
 
1015
        from bzrlib.workingtree import WorkingTreeFormat2
1462
1016
        self._make_tail(url)
1463
1017
        result = self._format._initialize_for_clone(url)
1464
1018
        self.open_repository().clone(result, revision_id=revision_id)
1465
1019
        from_branch = self.open_branch()
1466
1020
        from_branch.clone(result, revision_id=revision_id)
1467
1021
        try:
1468
 
            tree = self.open_workingtree()
 
1022
            self.open_workingtree().clone(result)
1469
1023
        except errors.NotLocalUrl:
1470
1024
            # make a new one, this format always has to have one.
1471
 
            result._init_workingtree()
1472
 
        else:
1473
 
            tree.clone(result)
 
1025
            try:
 
1026
                WorkingTreeFormat2().initialize(result)
 
1027
            except errors.NotLocalUrl:
 
1028
                # but we cannot do it for remote trees.
 
1029
                to_branch = result.open_branch()
 
1030
                WorkingTreeFormat2().stub_initialize_remote(to_branch.control_files)
1474
1031
        return result
1475
1032
 
1476
 
    def create_branch(self, name=None):
 
1033
    def create_branch(self):
1477
1034
        """See BzrDir.create_branch."""
1478
 
        return self._format.get_branch_format().initialize(self, name=name)
 
1035
        return self.open_branch()
1479
1036
 
1480
 
    def destroy_branch(self, name=None):
 
1037
    def destroy_branch(self):
1481
1038
        """See BzrDir.destroy_branch."""
1482
1039
        raise errors.UnsupportedOperation(self.destroy_branch, self)
1483
1040
 
1494
1051
    def create_workingtree(self, revision_id=None, from_branch=None,
1495
1052
                           accelerator_tree=None, hardlink=False):
1496
1053
        """See BzrDir.create_workingtree."""
1497
 
        # The workingtree is sometimes created when the bzrdir is created,
1498
 
        # but not when cloning.
1499
 
 
1500
1054
        # this looks buggy but is not -really-
1501
1055
        # because this format creates the workingtree when the bzrdir is
1502
1056
        # created
1504
1058
        # and that will have set it for us, its only
1505
1059
        # specific uses of create_workingtree in isolation
1506
1060
        # that can do wonky stuff here, and that only
1507
 
        # happens for creating checkouts, which cannot be
 
1061
        # happens for creating checkouts, which cannot be 
1508
1062
        # 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()
 
1063
        result = self.open_workingtree(recommend_upgrade=False)
1516
1064
        if revision_id is not None:
1517
1065
            if revision_id == _mod_revision.NULL_REVISION:
1518
1066
                result.set_parent_ids([])
1520
1068
                result.set_parent_ids([revision_id])
1521
1069
        return result
1522
1070
 
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
1071
    def destroy_workingtree(self):
1534
1072
        """See BzrDir.destroy_workingtree."""
1535
1073
        raise errors.UnsupportedOperation(self.destroy_workingtree, self)
1536
1074
 
1537
1075
    def destroy_workingtree_metadata(self):
1538
1076
        """See BzrDir.destroy_workingtree_metadata."""
1539
 
        raise errors.UnsupportedOperation(self.destroy_workingtree_metadata,
 
1077
        raise errors.UnsupportedOperation(self.destroy_workingtree_metadata, 
1540
1078
                                          self)
1541
1079
 
1542
 
    def get_branch_transport(self, branch_format, name=None):
 
1080
    def get_branch_transport(self, branch_format):
1543
1081
        """See BzrDir.get_branch_transport()."""
1544
 
        if name is not None:
1545
 
            raise errors.NoColocatedBranchSupport(self)
1546
1082
        if branch_format is None:
1547
1083
            return self.transport
1548
1084
        try:
1576
1112
        # if the format is not the same as the system default,
1577
1113
        # an upgrade is needed.
1578
1114
        if format is None:
1579
 
            symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1580
 
                % 'needs_format_conversion(format=None)')
1581
1115
            format = BzrDirFormat.get_default_format()
1582
1116
        return not isinstance(self._format, format.__class__)
1583
1117
 
1584
 
    def open_branch(self, name=None, unsupported=False,
1585
 
                    ignore_fallbacks=False):
 
1118
    def open_branch(self, unsupported=False):
1586
1119
        """See BzrDir.open_branch."""
1587
1120
        from bzrlib.branch import BzrBranchFormat4
1588
1121
        format = BzrBranchFormat4()
1589
1122
        self._check_supported(format, unsupported)
1590
 
        return format.open(self, name, _found=True)
 
1123
        return format.open(self, _found=True)
1591
1124
 
1592
1125
    def sprout(self, url, revision_id=None, force_new_repo=False,
1593
1126
               possible_transports=None, accelerator_tree=None,
1594
 
               hardlink=False, stacked=False, create_tree_if_local=True,
1595
 
               source_branch=None):
 
1127
               hardlink=False):
1596
1128
        """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
1129
        from bzrlib.workingtree import WorkingTreeFormat2
1610
1130
        self._make_tail(url)
1611
1131
        result = self._format._initialize_for_clone(url)
1617
1137
            self.open_branch().sprout(result, revision_id=revision_id)
1618
1138
        except errors.NotBranchError:
1619
1139
            pass
1620
 
 
1621
1140
        # we always want a working tree
1622
1141
        WorkingTreeFormat2().initialize(result,
1623
1142
                                        accelerator_tree=accelerator_tree,
1627
1146
 
1628
1147
class BzrDir4(BzrDirPreSplitOut):
1629
1148
    """A .bzr version 4 control object.
1630
 
 
 
1149
    
1631
1150
    This is a deprecated format and may be removed after sept 2006.
1632
1151
    """
1633
1152
 
1637
1156
 
1638
1157
    def needs_format_conversion(self, format=None):
1639
1158
        """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
1159
        return True
1644
1160
 
1645
1161
    def open_repository(self):
1654
1170
    This is a deprecated format and may be removed after sept 2006.
1655
1171
    """
1656
1172
 
1657
 
    def has_workingtree(self):
1658
 
        """See BzrDir.has_workingtree."""
1659
 
        return True
1660
 
    
1661
1173
    def open_repository(self):
1662
1174
        """See BzrDir.open_repository."""
1663
1175
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
1679
1191
    This is a deprecated format and may be removed after sept 2006.
1680
1192
    """
1681
1193
 
1682
 
    def has_workingtree(self):
1683
 
        """See BzrDir.has_workingtree."""
1684
 
        return True
1685
 
    
1686
1194
    def open_repository(self):
1687
1195
        """See BzrDir.open_repository."""
1688
1196
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
1699
1207
 
1700
1208
class BzrDirMeta1(BzrDir):
1701
1209
    """A .bzr meta version 1 control object.
1702
 
 
1703
 
    This is the first control object where the
 
1210
    
 
1211
    This is the first control object where the 
1704
1212
    individual aspects are really split out: there are separate repository,
1705
1213
    workingtree and branch subdirectories and any subset of the three can be
1706
1214
    present within a BzrDir.
1710
1218
        """See BzrDir.can_convert_format()."""
1711
1219
        return True
1712
1220
 
1713
 
    def create_branch(self, name=None):
 
1221
    def create_branch(self):
1714
1222
        """See BzrDir.create_branch."""
1715
 
        return self._format.get_branch_format().initialize(self, name=name)
 
1223
        return self._format.get_branch_format().initialize(self)
1716
1224
 
1717
 
    def destroy_branch(self, name=None):
 
1225
    def destroy_branch(self):
1718
1226
        """See BzrDir.create_branch."""
1719
 
        if name is not None:
1720
 
            raise errors.NoColocatedBranchSupport(self)
1721
1227
        self.transport.delete_tree('branch')
1722
1228
 
1723
1229
    def create_repository(self, shared=False):
1746
1252
    def destroy_workingtree_metadata(self):
1747
1253
        self.transport.delete_tree('checkout')
1748
1254
 
1749
 
    def find_branch_format(self, name=None):
 
1255
    def find_branch_format(self):
1750
1256
        """Find the branch 'format' for this bzrdir.
1751
1257
 
1752
1258
        This might be a synthetic object for e.g. RemoteBranch and SVN.
1753
1259
        """
1754
1260
        from bzrlib.branch import BranchFormat
1755
 
        return BranchFormat.find_format(self, name=name)
 
1261
        return BranchFormat.find_format(self)
1756
1262
 
1757
1263
    def _get_mkdir_mode(self):
1758
1264
        """Figure out the mode to use when creating a bzrdir subdir."""
1760
1266
                                     lockable_files.TransportLock)
1761
1267
        return temp_control._dir_mode
1762
1268
 
1763
 
    def get_branch_reference(self, name=None):
 
1269
    def get_branch_reference(self):
1764
1270
        """See BzrDir.get_branch_reference()."""
1765
1271
        from bzrlib.branch import BranchFormat
1766
 
        format = BranchFormat.find_format(self, name=name)
1767
 
        return format.get_reference(self, name=name)
 
1272
        format = BranchFormat.find_format(self)
 
1273
        return format.get_reference(self)
1768
1274
 
1769
 
    def get_branch_transport(self, branch_format, name=None):
 
1275
    def get_branch_transport(self, branch_format):
1770
1276
        """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
1277
        if branch_format is None:
1776
1278
            return self.transport.clone('branch')
1777
1279
        try:
1812
1314
            pass
1813
1315
        return self.transport.clone('checkout')
1814
1316
 
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
1317
    def needs_format_conversion(self, format=None):
1832
1318
        """See BzrDir.needs_format_conversion()."""
1833
1319
        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
1320
            format = BzrDirFormat.get_default_format()
1838
1321
        if not isinstance(self._format, format.__class__):
1839
1322
            # it is not a meta dir format, conversion is needed.
1846
1329
                return True
1847
1330
        except errors.NoRepositoryPresent:
1848
1331
            pass
1849
 
        for branch in self.list_branches():
1850
 
            if not isinstance(branch._format,
 
1332
        try:
 
1333
            if not isinstance(self.open_branch()._format,
1851
1334
                              format.get_branch_format().__class__):
1852
1335
                # the branch needs an upgrade.
1853
1336
                return True
 
1337
        except errors.NotBranchError:
 
1338
            pass
1854
1339
        try:
1855
1340
            my_wt = self.open_workingtree(recommend_upgrade=False)
1856
1341
            if not isinstance(my_wt._format,
1861
1346
            pass
1862
1347
        return False
1863
1348
 
1864
 
    def open_branch(self, name=None, unsupported=False,
1865
 
                    ignore_fallbacks=False):
 
1349
    def open_branch(self, unsupported=False):
1866
1350
        """See BzrDir.open_branch."""
1867
 
        format = self.find_branch_format(name=name)
 
1351
        format = self.find_branch_format()
1868
1352
        self._check_supported(format, unsupported)
1869
 
        return format.open(self, name=name,
1870
 
            _found=True, ignore_fallbacks=ignore_fallbacks)
 
1353
        return format.open(self, _found=True)
1871
1354
 
1872
1355
    def open_repository(self, unsupported=False):
1873
1356
        """See BzrDir.open_repository."""
1886
1369
            basedir=self.root_transport.base)
1887
1370
        return format.open(self, _found=True)
1888
1371
 
1889
 
    def _get_config(self):
1890
 
        return config.TransportConfig(self.transport, 'control.conf')
1891
 
 
1892
1372
 
1893
1373
class BzrDirFormat(object):
1894
1374
    """An encapsulation of the initialization and open routines for a format.
1898
1378
     * a format string,
1899
1379
     * an open routine.
1900
1380
 
1901
 
    Formats are placed in a dict by their format string for reference
 
1381
    Formats are placed in a dict by their format string for reference 
1902
1382
    during bzrdir opening. These should be subclasses of BzrDirFormat
1903
1383
    for consistency.
1904
1384
 
1905
1385
    Once a format is deprecated, just deprecate the initialize and open
1906
 
    methods on the format class. Do not deprecate the object, as the
 
1386
    methods on the format class. Do not deprecate the object, as the 
1907
1387
    object will be created every system load.
1908
 
 
1909
 
    :cvar colocated_branches: Whether this formats supports colocated branches.
1910
1388
    """
1911
1389
 
1912
1390
    _default_format = None
1917
1395
 
1918
1396
    _control_formats = []
1919
1397
    """The registered control formats - .bzr, ....
1920
 
 
 
1398
    
1921
1399
    This is a list of BzrDirFormat objects.
1922
1400
    """
1923
1401
 
1929
1407
 
1930
1408
    _lock_file_name = 'branch-lock'
1931
1409
 
1932
 
    colocated_branches = False
1933
 
    """Whether co-located branches are supported for this control dir format.
1934
 
    """
1935
 
 
1936
1410
    # _lock_class must be set in subclasses to the lock type, typ.
1937
1411
    # TransportLock or LockDir
1938
1412
 
1955
1429
    def probe_transport(klass, transport):
1956
1430
        """Return the .bzrdir style format present in a directory."""
1957
1431
        try:
1958
 
            format_string = transport.get_bytes(".bzr/branch-format")
 
1432
            format_string = transport.get(".bzr/branch-format").read()
1959
1433
        except errors.NoSuchFile:
1960
1434
            raise errors.NotBranchError(path=transport.base)
1961
1435
 
1962
1436
        try:
1963
1437
            return klass._formats[format_string]
1964
1438
        except KeyError:
1965
 
            raise errors.UnknownFormatError(format=format_string, kind='bzrdir')
 
1439
            raise errors.UnknownFormatError(format=format_string)
1966
1440
 
1967
1441
    @classmethod
1968
1442
    def get_default_format(klass):
1986
1460
        current default format. In the case of plugins we can/should provide
1987
1461
        some means for them to extend the range of returnable converters.
1988
1462
 
1989
 
        :param format: Optional format to override the default format of the
 
1463
        :param format: Optional format to override the default format of the 
1990
1464
                       library.
1991
1465
        """
1992
1466
        raise NotImplementedError(self.get_converter)
1993
1467
 
1994
1468
    def initialize(self, url, possible_transports=None):
1995
1469
        """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
 
 
 
1470
        
2001
1471
        Subclasses should typically override initialize_on_transport
2002
1472
        instead of this method.
2003
1473
        """
2006
1476
 
2007
1477
    def initialize_on_transport(self, transport):
2008
1478
        """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
 
1479
        # Since we don't have a .bzr directory, inherit the
2129
1480
        # mode from the root directory
2130
1481
        temp_control = lockable_files.LockableFiles(transport,
2131
1482
                            '', lockable_files.TransportLock)
2133
1484
                                      # FIXME: RBC 20060121 don't peek under
2134
1485
                                      # the covers
2135
1486
                                      mode=temp_control._dir_mode)
2136
 
        if sys.platform == 'win32' and isinstance(transport, local.LocalTransport):
 
1487
        if sys.platform == 'win32' and isinstance(transport, LocalTransport):
2137
1488
            win32utils.set_file_attr_hidden(transport._abspath('.bzr'))
2138
1489
        file_mode = temp_control._file_mode
2139
1490
        del temp_control
2140
 
        bzrdir_transport = transport.clone('.bzr')
2141
 
        utf8_files = [('README',
2142
 
                       "This is a Bazaar control directory.\n"
2143
 
                       "Do not change any files in this directory.\n"
2144
 
                       "See http://bazaar-vcs.org/ for more information about Bazaar.\n"),
 
1491
        mutter('created control directory in ' + transport.base)
 
1492
        control = transport.clone('.bzr')
 
1493
        utf8_files = [('README', 
 
1494
                       "This is a Bazaar-NG control directory.\n"
 
1495
                       "Do not change any files in this directory.\n"),
2145
1496
                      ('branch-format', self.get_format_string()),
2146
1497
                      ]
2147
1498
        # 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)
 
1499
        control_files = lockable_files.LockableFiles(control,
 
1500
                            self._lock_file_name, self._lock_class)
2150
1501
        control_files.create_lock()
2151
1502
        control_files.lock_write()
2152
1503
        try:
2153
 
            for (filename, content) in utf8_files:
2154
 
                bzrdir_transport.put_bytes(filename, content,
2155
 
                    mode=file_mode)
 
1504
            for file, content in utf8_files:
 
1505
                control_files.put_utf8(file, content)
2156
1506
        finally:
2157
1507
            control_files.unlock()
2158
1508
        return self.open(transport, _found=True)
2161
1511
        """Is this format supported?
2162
1512
 
2163
1513
        Supported formats must be initializable and openable.
2164
 
        Unsupported formats may not support initialization or committing or
 
1514
        Unsupported formats may not support initialization or committing or 
2165
1515
        some other features depending on the reason for not being supported.
2166
1516
        """
2167
1517
        return True
2168
1518
 
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
1519
    def same_model(self, target_format):
2180
 
        return (self.repository_format.rich_root_data ==
 
1520
        return (self.repository_format.rich_root_data == 
2181
1521
            target_format.rich_root_data)
2182
1522
 
2183
1523
    @classmethod
2184
1524
    def known_formats(klass):
2185
1525
        """Return all the known formats.
2186
 
 
 
1526
        
2187
1527
        Concrete formats should override _known_formats.
2188
1528
        """
2189
 
        # There is double indirection here to make sure that control
2190
 
        # formats used by more than one dir format will only be probed
 
1529
        # There is double indirection here to make sure that control 
 
1530
        # formats used by more than one dir format will only be probed 
2191
1531
        # once. This can otherwise be quite expensive for remote connections.
2192
1532
        result = set()
2193
1533
        for format in klass._control_formats:
2194
1534
            result.update(format._known_formats())
2195
1535
        return result
2196
 
 
 
1536
    
2197
1537
    @classmethod
2198
1538
    def _known_formats(klass):
2199
1539
        """Return the known format instances for this control format."""
2201
1541
 
2202
1542
    def open(self, transport, _found=False):
2203
1543
        """Return an instance of this format for the dir transport points at.
2204
 
 
 
1544
        
2205
1545
        _found is a private parameter, do not use it.
2206
1546
        """
2207
1547
        if not _found:
2208
1548
            found_format = BzrDirFormat.find_format(transport)
2209
1549
            if not isinstance(found_format, self.__class__):
2210
1550
                raise AssertionError("%s was asked to open %s, but it seems to need "
2211
 
                        "format %s"
 
1551
                        "format %s" 
2212
1552
                        % (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
1553
        return self._open(transport)
2217
1554
 
2218
1555
    def _open(self, transport):
2226
1563
    @classmethod
2227
1564
    def register_format(klass, format):
2228
1565
        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
1566
 
2232
1567
    @classmethod
2233
1568
    def register_control_format(klass, format):
2234
1569
        """Register a format that does not use '.bzr' for its control dir.
2235
1570
 
2236
1571
        TODO: This should be pulled up into a 'ControlDirFormat' base class
2237
 
        which BzrDirFormat can inherit from, and renamed to register_format
 
1572
        which BzrDirFormat can inherit from, and renamed to register_format 
2238
1573
        there. It has been done without that for now for simplicity of
2239
1574
        implementation.
2240
1575
        """
2252
1587
        klass._control_server_formats.append(format)
2253
1588
 
2254
1589
    @classmethod
 
1590
    @symbol_versioning.deprecated_method(symbol_versioning.zero_fourteen)
 
1591
    def set_default_format(klass, format):
 
1592
        klass._set_default_format(format)
 
1593
 
 
1594
    @classmethod
2255
1595
    def _set_default_format(klass, format):
2256
1596
        """Set default format (for testing behavior of defaults only)"""
2257
1597
        klass._default_format = format
2258
1598
 
2259
1599
    def __str__(self):
2260
1600
        # 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
 
        """
 
1601
        return self.get_format_string().rstrip()
2274
1602
 
2275
1603
    @classmethod
2276
1604
    def unregister_format(klass, format):
 
1605
        assert klass._formats[format.get_format_string()] is format
2277
1606
        del klass._formats[format.get_format_string()]
2278
1607
 
2279
1608
    @classmethod
2308
1637
        """See BzrDirFormat.get_converter()."""
2309
1638
        # there is one and only one upgrade path here.
2310
1639
        return ConvertBzrDir4To5()
2311
 
 
 
1640
        
2312
1641
    def initialize_on_transport(self, transport):
2313
1642
        """Format 4 branches cannot be created."""
2314
1643
        raise errors.UninitializableFormat(self)
2317
1646
        """Format 4 is not supported.
2318
1647
 
2319
1648
        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
 
1649
        conversion logic is expensive - so doing it on the fly was not 
2321
1650
        feasible.
2322
1651
        """
2323
1652
        return False
2324
1653
 
2325
 
    def network_name(self):
2326
 
        return self.get_format_string()
2327
 
 
2328
1654
    def _open(self, transport):
2329
1655
        """See BzrDirFormat._open."""
2330
1656
        return BzrDir4(transport, self)
2336
1662
    repository_format = property(__return_repository_format)
2337
1663
 
2338
1664
 
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):
 
1665
class BzrDirFormat5(BzrDirFormat):
2365
1666
    """Bzr control format 5.
2366
1667
 
2367
1668
    This format is a combined format for working tree, branch and repository.
2368
1669
    It has:
2369
 
     - Format 2 working trees [always]
2370
 
     - Format 4 branches [always]
 
1670
     - Format 2 working trees [always] 
 
1671
     - Format 4 branches [always] 
2371
1672
     - Format 5 repositories [always]
2372
1673
       Unhashed stores in the repository.
2373
1674
    """
2378
1679
        """See BzrDirFormat.get_format_string()."""
2379
1680
        return "Bazaar-NG branch, format 5\n"
2380
1681
 
2381
 
    def get_branch_format(self):
2382
 
        from bzrlib import branch
2383
 
        return branch.BzrBranchFormat4()
2384
 
 
2385
1682
    def get_format_description(self):
2386
1683
        """See BzrDirFormat.get_format_description()."""
2387
1684
        return "All-in-one format 5"
2393
1690
 
2394
1691
    def _initialize_for_clone(self, url):
2395
1692
        return self.initialize_on_transport(get_transport(url), _cloning=True)
2396
 
 
 
1693
        
2397
1694
    def initialize_on_transport(self, transport, _cloning=False):
2398
1695
        """Format 5 dirs always have working tree, branch and repository.
2399
 
 
 
1696
        
2400
1697
        Except when they are being cloned.
2401
1698
        """
2402
1699
        from bzrlib.branch import BzrBranchFormat4
2403
1700
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
 
1701
        from bzrlib.workingtree import WorkingTreeFormat2
2404
1702
        result = (super(BzrDirFormat5, self).initialize_on_transport(transport))
2405
1703
        RepositoryFormat5().initialize(result, _internal=True)
2406
1704
        if not _cloning:
2407
1705
            branch = BzrBranchFormat4().initialize(result)
2408
 
            result._init_workingtree()
 
1706
            try:
 
1707
                WorkingTreeFormat2().initialize(result)
 
1708
            except errors.NotLocalUrl:
 
1709
                # Even though we can't access the working tree, we need to
 
1710
                # create its control files.
 
1711
                WorkingTreeFormat2().stub_initialize_remote(branch.control_files)
2409
1712
        return result
2410
1713
 
2411
 
    def network_name(self):
2412
 
        return self.get_format_string()
2413
 
 
2414
1714
    def _open(self, transport):
2415
1715
        """See BzrDirFormat._open."""
2416
1716
        return BzrDir5(transport, self)
2422
1722
    repository_format = property(__return_repository_format)
2423
1723
 
2424
1724
 
2425
 
class BzrDirFormat6(BzrDirFormatAllInOne):
 
1725
class BzrDirFormat6(BzrDirFormat):
2426
1726
    """Bzr control format 6.
2427
1727
 
2428
1728
    This format is a combined format for working tree, branch and repository.
2429
1729
    It has:
2430
 
     - Format 2 working trees [always]
2431
 
     - Format 4 branches [always]
 
1730
     - Format 2 working trees [always] 
 
1731
     - Format 4 branches [always] 
2432
1732
     - Format 6 repositories [always]
2433
1733
    """
2434
1734
 
2442
1742
        """See BzrDirFormat.get_format_description()."""
2443
1743
        return "All-in-one format 6"
2444
1744
 
2445
 
    def get_branch_format(self):
2446
 
        from bzrlib import branch
2447
 
        return branch.BzrBranchFormat4()
2448
 
 
2449
1745
    def get_converter(self, format=None):
2450
1746
        """See BzrDirFormat.get_converter()."""
2451
1747
        # there is one and only one upgrade path here.
2452
1748
        return ConvertBzrDir6ToMeta()
2453
 
 
 
1749
        
2454
1750
    def _initialize_for_clone(self, url):
2455
1751
        return self.initialize_on_transport(get_transport(url), _cloning=True)
2456
1752
 
2457
1753
    def initialize_on_transport(self, transport, _cloning=False):
2458
1754
        """Format 6 dirs always have working tree, branch and repository.
2459
 
 
 
1755
        
2460
1756
        Except when they are being cloned.
2461
1757
        """
2462
1758
        from bzrlib.branch import BzrBranchFormat4
2463
1759
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
 
1760
        from bzrlib.workingtree import WorkingTreeFormat2
2464
1761
        result = super(BzrDirFormat6, self).initialize_on_transport(transport)
2465
1762
        RepositoryFormat6().initialize(result, _internal=True)
2466
1763
        if not _cloning:
2467
1764
            branch = BzrBranchFormat4().initialize(result)
2468
 
            result._init_workingtree()
 
1765
            try:
 
1766
                WorkingTreeFormat2().initialize(result)
 
1767
            except errors.NotLocalUrl:
 
1768
                # Even though we can't access the working tree, we need to
 
1769
                # create its control files.
 
1770
                WorkingTreeFormat2().stub_initialize_remote(branch.control_files)
2469
1771
        return result
2470
1772
 
2471
 
    def network_name(self):
2472
 
        return self.get_format_string()
2473
 
 
2474
1773
    def _open(self, transport):
2475
1774
        """See BzrDirFormat._open."""
2476
1775
        return BzrDir6(transport, self)
2498
1797
    def __init__(self):
2499
1798
        self._workingtree_format = None
2500
1799
        self._branch_format = None
2501
 
        self._repository_format = None
2502
1800
 
2503
1801
    def __eq__(self, other):
2504
1802
        if other.__class__ is not self.__class__:
2521
1819
    def set_branch_format(self, format):
2522
1820
        self._branch_format = format
2523
1821
 
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
1822
    def get_converter(self, format=None):
2617
1823
        """See BzrDirFormat.get_converter()."""
2618
1824
        if format is None:
2630
1836
        """See BzrDirFormat.get_format_description()."""
2631
1837
        return "Meta directory format 1"
2632
1838
 
2633
 
    def network_name(self):
2634
 
        return self.get_format_string()
2635
 
 
2636
1839
    def _open(self, transport):
2637
1840
        """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)
 
1841
        return BzrDirMeta1(transport, self)
2644
1842
 
2645
1843
    def __return_repository_format(self):
2646
1844
        """Circular import protection."""
2647
 
        if self._repository_format:
 
1845
        if getattr(self, '_repository_format', None):
2648
1846
            return self._repository_format
2649
1847
        from bzrlib.repository import RepositoryFormat
2650
1848
        return RepositoryFormat.get_default_format()
2651
1849
 
2652
 
    def _set_repository_format(self, value):
 
1850
    def __set_repository_format(self, value):
2653
1851
        """Allow changing the repository format for metadir formats."""
2654
1852
        self._repository_format = value
2655
1853
 
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
 
1854
    repository_format = property(__return_repository_format, __set_repository_format)
2676
1855
 
2677
1856
    def __get_workingtree_format(self):
2678
1857
        if self._workingtree_format is None:
2687
1866
                                  __set_workingtree_format)
2688
1867
 
2689
1868
 
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
1869
# Register bzr control format
2700
1870
BzrDirFormat.register_control_format(BzrDirFormat)
2701
1871
 
2733
1903
        self.absent_revisions = set()
2734
1904
        self.text_count = 0
2735
1905
        self.revisions = {}
2736
 
 
 
1906
        
2737
1907
    def convert(self, to_convert, pb):
2738
1908
        """See Converter.convert()."""
2739
1909
        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()
 
1910
        self.pb = pb
 
1911
        self.pb.note('starting upgrade from format 4 to 5')
 
1912
        if isinstance(self.bzrdir.transport, LocalTransport):
 
1913
            self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
 
1914
        self._convert_to_weaves()
 
1915
        return BzrDir.open(self.bzrdir.root_transport.base)
2751
1916
 
2752
1917
    def _convert_to_weaves(self):
2753
 
        ui.ui_factory.note('note: upgrade may be faster if all store files are ungzipped first')
 
1918
        self.pb.note('note: upgrade may be faster if all store files are ungzipped first')
2754
1919
        try:
2755
1920
            # TODO permissions
2756
1921
            stat = self.bzrdir.transport.stat('weaves')
2784
1949
        self.pb.clear()
2785
1950
        self._write_all_weaves()
2786
1951
        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)
 
1952
        self.pb.note('upgraded to weaves:')
 
1953
        self.pb.note('  %6d revisions and inventories', len(self.revisions))
 
1954
        self.pb.note('  %6d revisions not present', len(self.absent_revisions))
 
1955
        self.pb.note('  %6d texts', self.text_count)
2791
1956
        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())
 
1957
        self.branch.control_files.put_utf8('branch-format', BzrDirFormat5().get_format_string())
2796
1958
 
2797
1959
    def _cleanup_spare_files_after_format4(self):
2798
1960
        # FIXME working tree upgrade foo.
2807
1969
 
2808
1970
    def _convert_working_inv(self):
2809
1971
        inv = xml4.serializer_v4.read_inventory(
2810
 
                self.branch._transport.get('inventory'))
 
1972
                    self.branch.control_files.get('inventory'))
2811
1973
        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())
 
1974
        # FIXME inventory is a working tree change.
 
1975
        self.branch.control_files.put('inventory', StringIO(new_inv_xml))
2814
1976
 
2815
1977
    def _write_all_weaves(self):
2816
1978
        controlweaves = WeaveStore(self.bzrdir.transport, prefixed=False)
2836
1998
        self.bzrdir.transport.mkdir('revision-store')
2837
1999
        revision_transport = self.bzrdir.transport.clone('revision-store')
2838
2000
        # 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)
 
2001
        _revision_store = TextRevisionStore(TextStore(revision_transport,
 
2002
                                                      prefixed=False,
 
2003
                                                      compressed=True))
2844
2004
        try:
 
2005
            transaction = WriteTransaction()
2845
2006
            for i, rev_id in enumerate(self.converted_revs):
2846
2007
                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))
 
2008
                _revision_store.add_revision(self.revisions[rev_id], transaction)
2851
2009
        finally:
2852
2010
            self.pb.clear()
2853
 
 
 
2011
            
2854
2012
    def _load_one_rev(self, rev_id):
2855
2013
        """Load a revision object into memory.
2856
2014
 
2861
2019
                       len(self.known_revisions))
2862
2020
        if not self.branch.repository.has_revision(rev_id):
2863
2021
            self.pb.clear()
2864
 
            ui.ui_factory.note('revision {%s} not present in branch; '
2865
 
                         'will be converted as a ghost' %
 
2022
            self.pb.note('revision {%s} not present in branch; '
 
2023
                         'will be converted as a ghost',
2866
2024
                         rev_id)
2867
2025
            self.absent_revisions.add(rev_id)
2868
2026
        else:
2869
 
            rev = self.branch.repository.get_revision(rev_id)
 
2027
            rev = self.branch.repository._revision_store.get_revision(rev_id,
 
2028
                self.branch.repository.get_transaction())
2870
2029
            for parent_id in rev.parent_ids:
2871
2030
                self.known_revisions.add(parent_id)
2872
2031
                self.to_read.append(parent_id)
2873
2032
            self.revisions[rev_id] = rev
2874
2033
 
2875
2034
    def _load_old_inventory(self, rev_id):
 
2035
        assert rev_id not in self.converted_revs
2876
2036
        old_inv_xml = self.branch.repository.inventory_store.get(rev_id).read()
2877
2037
        inv = xml4.serializer_v4.read_inventory_from_string(old_inv_xml)
2878
2038
        inv.revision_id = rev_id
2879
2039
        rev = self.revisions[rev_id]
 
2040
        if rev.inventory_sha1:
 
2041
            assert rev.inventory_sha1 == sha_string(old_inv_xml), \
 
2042
                'inventory sha mismatch for {%s}' % rev_id
2880
2043
        return inv
2881
2044
 
2882
2045
    def _load_updated_inventory(self, rev_id):
 
2046
        assert rev_id in self.converted_revs
2883
2047
        inv_xml = self.inv_weave.get_text(rev_id)
2884
2048
        inv = xml5.serializer_v5.read_inventory_from_string(inv_xml, rev_id)
2885
2049
        return inv
2895
2059
        self.converted_revs.add(rev_id)
2896
2060
 
2897
2061
    def _store_new_inv(self, rev, inv, present_parents):
 
2062
        # the XML is now updated with text versions
 
2063
        if __debug__:
 
2064
            entries = inv.iter_entries()
 
2065
            entries.next()
 
2066
            for path, ie in entries:
 
2067
                assert getattr(ie, 'revision', None) is not None, \
 
2068
                    'no revision on {%s} in {%s}' % \
 
2069
                    (file_id, rev.revision_id)
2898
2070
        new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
2899
2071
        new_inv_sha1 = sha_string(new_inv_xml)
2900
2072
        self.inv_weave.add_lines(rev.revision_id,
2929
2101
            self.text_weaves[file_id] = w
2930
2102
        text_changed = False
2931
2103
        parent_candiate_entries = ie.parent_candidates(parent_invs)
 
2104
        for old_revision in parent_candiate_entries.keys():
 
2105
            # if this fails, its a ghost ?
 
2106
            assert old_revision in self.converted_revs, \
 
2107
                "Revision {%s} not in converted_revs" % old_revision
2932
2108
        heads = graph.Graph(self).heads(parent_candiate_entries.keys())
2933
 
        # XXX: Note that this is unordered - and this is tolerable because
 
2109
        # XXX: Note that this is unordered - and this is tolerable because 
2934
2110
        # the previous code was also unordered.
2935
2111
        previous_entries = dict((head, parent_candiate_entries[head]) for head
2936
2112
            in heads)
2937
2113
        self.snapshot_ie(previous_entries, ie, w, rev_id)
2938
2114
        del ie.text_id
 
2115
        assert getattr(ie, 'revision', None) is not None
 
2116
 
 
2117
    @symbol_versioning.deprecated_method(symbol_versioning.one_one)
 
2118
    def get_parents(self, revision_ids):
 
2119
        for revision_id in revision_ids:
 
2120
            yield self.revisions[revision_id].parent_ids
2939
2121
 
2940
2122
    def get_parent_map(self, revision_ids):
2941
 
        """See graph.StackedParentsProvider.get_parent_map"""
 
2123
        """See graph._StackedParentsProvider.get_parent_map"""
2942
2124
        return dict((revision_id, self.revisions[revision_id])
2943
2125
                    for revision_id in revision_ids
2944
2126
                     if revision_id in self.revisions)
2948
2130
        # a call to:. This needs the path figured out. rather than a work_tree
2949
2131
        # a v4 revision_tree can be given, or something that looks enough like
2950
2132
        # 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
 
2133
        # and we need something that looks like a weave store for snapshot to 
2952
2134
        # save against.
2953
2135
        #ie.snapshot(rev, PATH, previous_revisions, REVISION_TREE, InMemoryWeaveStore(self.text_weaves))
2954
2136
        if len(previous_revisions) == 1:
2957
2139
                ie.revision = previous_ie.revision
2958
2140
                return
2959
2141
        if ie.has_text():
2960
 
            text = self.branch.repository._text_store.get(ie.text_id)
 
2142
            text = self.branch.repository.weave_store.get(ie.text_id)
2961
2143
            file_lines = text.readlines()
 
2144
            assert sha_strings(file_lines) == ie.text_sha1
 
2145
            assert sum(map(len, file_lines)) == ie.text_size
2962
2146
            w.add_lines(rev_id, previous_revisions, file_lines)
2963
2147
            self.text_count += 1
2964
2148
        else:
2994
2178
    def convert(self, to_convert, pb):
2995
2179
        """See Converter.convert()."""
2996
2180
        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()
 
2181
        self.pb = pb
 
2182
        self.pb.note('starting upgrade from format 5 to 6')
 
2183
        self._convert_to_prefixed()
 
2184
        return BzrDir.open(self.bzrdir.root_transport.base)
3004
2185
 
3005
2186
    def _convert_to_prefixed(self):
3006
2187
        from bzrlib.store import TransportStore
3007
2188
        self.bzrdir.transport.delete('branch-format')
3008
2189
        for store_name in ["weaves", "revision-store"]:
3009
 
            ui.ui_factory.note("adding prefixes to %s" % store_name)
 
2190
            self.pb.note("adding prefixes to %s" % store_name)
3010
2191
            store_transport = self.bzrdir.transport.clone(store_name)
3011
2192
            store = TransportStore(store_transport, prefixed=True)
3012
2193
            for urlfilename in store_transport.list_dir('.'):
3014
2195
                if (filename.endswith(".weave") or
3015
2196
                    filename.endswith(".gz") or
3016
2197
                    filename.endswith(".sig")):
3017
 
                    file_id, suffix = os.path.splitext(filename)
 
2198
                    file_id = os.path.splitext(filename)[0]
3018
2199
                else:
3019
2200
                    file_id = filename
3020
 
                    suffix = ''
3021
 
                new_name = store._mapper.map((file_id,)) + suffix
 
2201
                prefix_dir = store.hash_prefix(file_id)
3022
2202
                # FIXME keep track of the dirs made RBC 20060121
3023
2203
                try:
3024
 
                    store_transport.move(filename, new_name)
 
2204
                    store_transport.move(filename, prefix_dir + '/' + filename)
3025
2205
                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())
 
2206
                    store_transport.mkdir(prefix_dir)
 
2207
                    store_transport.move(filename, prefix_dir + '/' + filename)
 
2208
        self.bzrdir._control_files.put_utf8('branch-format', BzrDirFormat6().get_format_string())
3032
2209
 
3033
2210
 
3034
2211
class ConvertBzrDir6ToMeta(Converter):
3039
2216
        from bzrlib.repofmt.weaverepo import RepositoryFormat7
3040
2217
        from bzrlib.branch import BzrBranchFormat5
3041
2218
        self.bzrdir = to_convert
3042
 
        self.pb = ui.ui_factory.nested_progress_bar()
 
2219
        self.pb = pb
3043
2220
        self.count = 0
3044
2221
        self.total = 20 # the steps we know about
3045
2222
        self.garbage_inventories = []
3046
 
        self.dir_mode = self.bzrdir._get_dir_mode()
3047
 
        self.file_mode = self.bzrdir._get_file_mode()
3048
2223
 
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)
 
2224
        self.pb.note('starting upgrade from format 6 to metadir')
 
2225
        self.bzrdir._control_files.put_utf8('branch-format', "Converting to format 6")
3054
2226
        # its faster to move specific files around than to open and use the apis...
3055
2227
        # first off, nuke ancestry.weave, it was never used.
3056
2228
        try:
3066
2238
            if name.startswith('basis-inventory.'):
3067
2239
                self.garbage_inventories.append(name)
3068
2240
        # create new directories for repository, working tree and branch
 
2241
        self.dir_mode = self.bzrdir._control_files._dir_mode
 
2242
        self.file_mode = self.bzrdir._control_files._file_mode
3069
2243
        repository_names = [('inventory.weave', True),
3070
2244
                            ('revision-store', True),
3071
2245
                            ('weaves', True)]
3073
2247
        self.bzrdir.transport.mkdir('repository', mode=self.dir_mode)
3074
2248
        self.make_lock('repository')
3075
2249
        # we hard code the formats here because we are converting into
3076
 
        # the meta format. The meta format upgrader can take this to a
 
2250
        # the meta format. The meta format upgrader can take this to a 
3077
2251
        # future format within each component.
3078
2252
        self.put_format('repository', RepositoryFormat7())
3079
2253
        for entry in repository_names:
3102
2276
        else:
3103
2277
            has_checkout = True
3104
2278
        if not has_checkout:
3105
 
            ui.ui_factory.note('No working tree.')
 
2279
            self.pb.note('No working tree.')
3106
2280
            # If some checkout files are there, we may as well get rid of them.
3107
2281
            for name, mandatory in checkout_files:
3108
2282
                if name in bzrcontents:
3119
2293
            for entry in checkout_files:
3120
2294
                self.move_entry('checkout', entry)
3121
2295
            if last_revision is not None:
3122
 
                self.bzrdir.transport.put_bytes(
 
2296
                self.bzrdir._control_files.put_utf8(
3123
2297
                    '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)
 
2298
        self.bzrdir._control_files.put_utf8(
 
2299
            'branch-format', BzrDirMetaFormat1().get_format_string())
 
2300
        return BzrDir.open(self.bzrdir.root_transport.base)
3130
2301
 
3131
2302
    def make_lock(self, name):
3132
2303
        """Make a lock for the new control dir name."""
3149
2320
                raise
3150
2321
 
3151
2322
    def put_format(self, dirname, format):
3152
 
        self.bzrdir.transport.put_bytes('%s/format' % dirname,
3153
 
            format.get_format_string(),
3154
 
            self.file_mode)
 
2323
        self.bzrdir._control_files.put_utf8('%s/format' % dirname, format.get_format_string())
3155
2324
 
3156
2325
 
3157
2326
class ConvertMetaToMeta(Converter):
3167
2336
    def convert(self, to_convert, pb):
3168
2337
        """See Converter.convert()."""
3169
2338
        self.bzrdir = to_convert
3170
 
        self.pb = ui.ui_factory.nested_progress_bar()
 
2339
        self.pb = pb
3171
2340
        self.count = 0
3172
2341
        self.total = 1
3173
2342
        self.step('checking repository format')
3178
2347
        else:
3179
2348
            if not isinstance(repo._format, self.target_format.repository_format.__class__):
3180
2349
                from bzrlib.repository import CopyConverter
3181
 
                ui.ui_factory.note('starting repository conversion')
 
2350
                self.pb.note('starting repository conversion')
3182
2351
                converter = CopyConverter(self.target_format.repository_format)
3183
2352
                converter.convert(repo, pb)
3184
 
        for branch in self.bzrdir.list_branches():
 
2353
        try:
 
2354
            branch = self.bzrdir.open_branch()
 
2355
        except errors.NotBranchError:
 
2356
            pass
 
2357
        else:
3185
2358
            # TODO: conversions of Branch and Tree should be done by
3186
 
            # InterXFormat lookups/some sort of registry.
 
2359
            # InterXFormat lookups
3187
2360
            # Avoid circular imports
3188
2361
            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)
 
2362
            if (branch._format.__class__ is _mod_branch.BzrBranchFormat5 and
 
2363
                self.target_format.get_branch_format().__class__ is
 
2364
                _mod_branch.BzrBranchFormat6):
 
2365
                branch_converter = _mod_branch.Converter5to6()
3207
2366
                branch_converter.convert(branch)
3208
 
                branch = self.bzrdir.open_branch()
3209
 
                old = branch._format.__class__
3210
2367
        try:
3211
2368
            tree = self.bzrdir.open_workingtree(recommend_upgrade=False)
3212
2369
        except (errors.NoWorkingTree, errors.NotLocalUrl):
3215
2372
            # TODO: conversions of Branch and Tree should be done by
3216
2373
            # InterXFormat lookups
3217
2374
            if (isinstance(tree, workingtree.WorkingTree3) and
3218
 
                not isinstance(tree, workingtree_4.DirStateWorkingTree) and
 
2375
                not isinstance(tree, workingtree_4.WorkingTree4) and
3219
2376
                isinstance(self.target_format.workingtree_format,
3220
 
                    workingtree_4.DirStateWorkingTreeFormat)):
 
2377
                    workingtree_4.WorkingTreeFormat4)):
3221
2378
                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
2379
        return to_convert
3234
2380
 
3235
2381
 
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.
 
2382
# This is not in remote.py because it's small, and needs to be registered.
 
2383
# Putting it in remote.py creates a circular import problem.
3238
2384
# we can make it a lazy object if the control formats is turned into something
3239
2385
# like a registry.
3240
2386
class RemoteBzrDirFormat(BzrDirMetaFormat1):
3241
2387
    """Format representing bzrdirs accessed via a smart server"""
3242
2388
 
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
2389
    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
2390
        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
 
 
 
2391
    
3270
2392
    @classmethod
3271
2393
    def probe_transport(klass, transport):
3272
2394
        """Return a RemoteBzrDirFormat object if it looks possible."""
3273
2395
        try:
3274
 
            medium = transport.get_smart_medium()
 
2396
            client = transport.get_smart_client()
3275
2397
        except (NotImplementedError, AttributeError,
3276
 
                errors.TransportNotPossible, errors.NoSmartMedium,
3277
 
                errors.SmartProtocolError):
 
2398
                errors.TransportNotPossible):
3278
2399
            # no smart server, so not a branch for this format type.
3279
2400
            raise errors.NotBranchError(path=transport.base)
3280
2401
        else:
3281
 
            # 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)
 
2402
            # Send a 'hello' request in protocol version one, and decline to
 
2403
            # open it if the server doesn't support our required version (2) so
 
2404
            # that the VFS-based transport will do it.
 
2405
            request = client.get_request()
 
2406
            smart_protocol = protocol.SmartClientRequestProtocolOne(request)
 
2407
            server_version = smart_protocol.query_version()
 
2408
            if server_version != 2:
 
2409
                raise errors.NotBranchError(path=transport.base)
3292
2410
            return klass()
3293
2411
 
3294
2412
    def initialize_on_transport(self, transport):
3295
2413
        try:
3296
2414
            # hand off the request to the smart server
3297
 
            client_medium = transport.get_smart_medium()
 
2415
            shared_medium = transport.get_shared_medium()
3298
2416
        except errors.NoSmartMedium:
3299
2417
            # TODO: lookup the local format from a server hint.
3300
2418
            local_dir_format = BzrDirMetaFormat1()
3301
2419
            return local_dir_format.initialize_on_transport(transport)
3302
 
        client = _SmartClient(client_medium)
 
2420
        client = _SmartClient(shared_medium)
3303
2421
        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
 
2422
        response = _SmartClient(shared_medium).call('BzrDirFormat.initialize',
 
2423
                                                    path)
 
2424
        assert response[0] in ('ok', ), 'unexpected response code %s' % (response,)
 
2425
        return remote.RemoteBzrDir(transport)
3459
2426
 
3460
2427
    def _open(self, transport):
3461
 
        return remote.RemoteBzrDir(transport, self)
 
2428
        return remote.RemoteBzrDir(transport)
3462
2429
 
3463
2430
    def __eq__(self, other):
3464
2431
        if not isinstance(other, RemoteBzrDirFormat):
3465
2432
            return False
3466
2433
        return self.get_format_description() == other.get_format_description()
3467
2434
 
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
2435
 
3498
2436
BzrDirFormat.register_control_server_format(RemoteBzrDirFormat)
3499
2437
 
3509
2447
 
3510
2448
class BzrDirFormatRegistry(registry.Registry):
3511
2449
    """Registry of user-selectable BzrDir subformats.
3512
 
 
 
2450
    
3513
2451
    Differs from BzrDirFormat._control_formats in that it provides sub-formats,
3514
2452
    e.g. BzrDirMeta1 with weave repository.  Also, it's more user-oriented.
3515
2453
    """
3517
2455
    def __init__(self):
3518
2456
        """Create a BzrDirFormatRegistry."""
3519
2457
        self._aliases = set()
3520
 
        self._registration_order = list()
3521
2458
        super(BzrDirFormatRegistry, self).__init__()
3522
2459
 
3523
2460
    def aliases(self):
3534
2471
        """Register a metadir subformat.
3535
2472
 
3536
2473
        These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
3537
 
        by the Repository/Branch/WorkingTreeformats.
 
2474
        by the Repository format.
3538
2475
 
3539
2476
        :param repository_format: The fully-qualified repository format class
3540
2477
            name as a string.
3574
2511
    def register(self, key, factory, help, native=True, deprecated=False,
3575
2512
                 hidden=False, experimental=False, alias=False):
3576
2513
        """Register a BzrDirFormat factory.
3577
 
 
 
2514
        
3578
2515
        The factory must be a callable that takes one parameter: the key.
3579
2516
        It must produce an instance of the BzrDirFormat when called.
3580
2517
 
3585
2522
            BzrDirFormatInfo(native, deprecated, hidden, experimental))
3586
2523
        if alias:
3587
2524
            self._aliases.add(key)
3588
 
        self._registration_order.append(key)
3589
2525
 
3590
2526
    def register_lazy(self, key, module_name, member_name, help, native=True,
3591
2527
        deprecated=False, hidden=False, experimental=False, alias=False):
3593
2529
            help, BzrDirFormatInfo(native, deprecated, hidden, experimental))
3594
2530
        if alias:
3595
2531
            self._aliases.add(key)
3596
 
        self._registration_order.append(key)
3597
2532
 
3598
2533
    def set_default(self, key):
3599
2534
        """Set the 'default' key to be a clone of the supplied key.
3600
 
 
 
2535
        
3601
2536
        This method must be called once and only once.
3602
2537
        """
3603
2538
        registry.Registry.register(self, 'default', self.get(key),
3606
2541
 
3607
2542
    def set_default_repository(self, key):
3608
2543
        """Set the FormatRegistry default and Repository default.
3609
 
 
 
2544
        
3610
2545
        This is a transitional method while Repository.set_default_format
3611
2546
        is deprecated.
3612
2547
        """
3614
2549
            self.remove('default')
3615
2550
        self.set_default(key)
3616
2551
        format = self.get('default')()
 
2552
        assert isinstance(format, BzrDirMetaFormat1)
3617
2553
 
3618
2554
    def make_bzrdir(self, key):
3619
2555
        return self.get(key)()
3620
2556
 
3621
2557
    def help_topic(self, topic):
3622
 
        output = ""
 
2558
        output = textwrap.dedent("""\
 
2559
            These formats can be used for creating branches, working trees, and
 
2560
            repositories.
 
2561
 
 
2562
            """)
3623
2563
        default_realkey = None
3624
2564
        default_help = self.get_help('default')
3625
2565
        help_pairs = []
3626
 
        for key in self._registration_order:
 
2566
        for key in self.keys():
3627
2567
            if key == 'default':
3628
2568
                continue
3629
2569
            help = self.get_help(key)
3635
2575
        def wrapped(key, help, info):
3636
2576
            if info.native:
3637
2577
                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))
 
2578
            return ':%s:\n%s\n\n' % (key, 
 
2579
                    textwrap.fill(help, initial_indent='    ', 
 
2580
                    subsequent_indent='    '))
3642
2581
        if default_realkey is not None:
3643
2582
            output += wrapped(default_realkey, '(default) %s' % default_help,
3644
2583
                              self.get_info('default'))
3654
2593
                experimental_pairs.append((key, help))
3655
2594
            else:
3656
2595
                output += wrapped(key, help, info)
3657
 
        output += "\nSee :doc:`formats-help` for more about storage formats."
3658
 
        other_output = ""
3659
2596
        if len(experimental_pairs) > 0:
3660
 
            other_output += "Experimental formats are shown below.\n\n"
 
2597
            output += "Experimental formats are shown below.\n\n"
3661
2598
            for key, help in experimental_pairs:
3662
2599
                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"
 
2600
                output += wrapped(key, help, info)
3667
2601
        if len(deprecated_pairs) > 0:
3668
 
            other_output += "\nDeprecated formats are shown below.\n\n"
 
2602
            output += "Deprecated formats are shown below.\n\n"
3669
2603
            for key, help in deprecated_pairs:
3670
2604
                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."
3677
 
 
3678
 
        if topic == 'other-formats':
3679
 
            return other_output
3680
 
        else:
3681
 
            return output
3682
 
 
3683
 
 
3684
 
class RepositoryAcquisitionPolicy(object):
3685
 
    """Abstract base class for repository acquisition policies.
3686
 
 
3687
 
    A repository acquisition policy decides how a BzrDir acquires a repository
3688
 
    for a branch that is being created.  The most basic policy decision is
3689
 
    whether to create a new repository or use an existing one.
3690
 
    """
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
 
 
3703
 
    def configure_branch(self, branch):
3704
 
        """Apply any configuration data from this policy to the branch.
3705
 
 
3706
 
        Default implementation sets repository stacking.
3707
 
        """
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
3762
 
 
3763
 
    def acquire_repository(self, make_working_trees=None, shared=False):
3764
 
        """Acquire a repository for this bzrdir.
3765
 
 
3766
 
        Implementations may create a new repository or use a pre-exising
3767
 
        repository.
3768
 
        :param make_working_trees: If creating a repository, set
3769
 
            make_working_trees to this value (if non-None)
3770
 
        :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).
3773
 
        """
3774
 
        raise NotImplemented(RepositoryAcquisitionPolicy.acquire_repository)
3775
 
 
3776
 
 
3777
 
class CreateRepository(RepositoryAcquisitionPolicy):
3778
 
    """A policy of creating a new repository"""
3779
 
 
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)
3791
 
        self._bzrdir = bzrdir
3792
 
 
3793
 
    def acquire_repository(self, make_working_trees=None, shared=False):
3794
 
        """Implementation of RepositoryAcquisitionPolicy.acquire_repository
3795
 
 
3796
 
        Creates the desired repository in the bzrdir we already have.
3797
 
        """
3798
 
        stack_on = self._get_full_stack_on()
3799
 
        if stack_on:
3800
 
            format = self._bzrdir._format
3801
 
            format.require_stacking(stack_on=stack_on,
3802
 
                                    possible_transports=[self._bzrdir.root_transport])
3803
 
            if not self._require_stacking:
3804
 
                # We have picked up automatic stacking somewhere.
3805
 
                note('Using default stacking branch %s at %s', self._stack_on,
3806
 
                    self._stack_on_pwd)
3807
 
        repository = self._bzrdir.create_repository(shared=shared)
3808
 
        self._add_fallback(repository,
3809
 
                           possible_transports=[self._bzrdir.transport])
3810
 
        if make_working_trees is not None:
3811
 
            repository.set_make_working_trees(make_working_trees)
3812
 
        return repository, True
3813
 
 
3814
 
 
3815
 
class UseExistingRepository(RepositoryAcquisitionPolicy):
3816
 
    """A policy of reusing an existing repository"""
3817
 
 
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)
3829
 
        self._repository = repository
3830
 
 
3831
 
    def acquire_repository(self, make_working_trees=None, shared=False):
3832
 
        """Implementation of RepositoryAcquisitionPolicy.acquire_repository
3833
 
 
3834
 
        Returns an existing repository to use.
3835
 
        """
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.
 
2605
                output += wrapped(key, help, info)
 
2606
 
 
2607
        return output
 
2608
 
 
2609
 
3844
2610
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
2611
format_registry.register('weave', BzrDirFormat6,
3849
2612
    'Pre-0.8 format.  Slower than knit and does not'
3850
2613
    ' support checkouts or shared repositories.',
3851
 
    hidden=True,
3852
2614
    deprecated=True)
 
2615
format_registry.register_metadir('knit',
 
2616
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
 
2617
    'Format using knits.  Recommended for interoperation with bzr <= 0.14.',
 
2618
    branch_format='bzrlib.branch.BzrBranchFormat5',
 
2619
    tree_format='bzrlib.workingtree.WorkingTreeFormat3')
3853
2620
format_registry.register_metadir('metaweave',
3854
2621
    'bzrlib.repofmt.weaverepo.RepositoryFormat7',
3855
2622
    'Transitional format in 0.8.  Slower than knit.',
3856
2623
    branch_format='bzrlib.branch.BzrBranchFormat5',
3857
2624
    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
2625
    deprecated=True)
3867
2626
format_registry.register_metadir('dirstate',
3868
2627
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3872
2631
    # this uses bzrlib.workingtree.WorkingTreeFormat4 because importing
3873
2632
    # directly from workingtree_4 triggers a circular import.
3874
2633
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3875
 
    hidden=True,
3876
 
    deprecated=True)
 
2634
    )
3877
2635
format_registry.register_metadir('dirstate-tags',
3878
2636
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3879
2637
    help='New in 0.15: Fast local operations and improved scaling for '
3881
2639
        ' Incompatible with bzr < 0.15.',
3882
2640
    branch_format='bzrlib.branch.BzrBranchFormat6',
3883
2641
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3884
 
    hidden=True,
3885
 
    deprecated=True)
 
2642
    )
3886
2643
format_registry.register_metadir('rich-root',
3887
2644
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
3888
2645
    help='New in 1.0.  Better handling of tree roots.  Incompatible with'
3889
 
        ' bzr < 1.0.',
 
2646
        ' bzr < 1.0',
3890
2647
    branch_format='bzrlib.branch.BzrBranchFormat6',
3891
2648
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3892
 
    hidden=True,
3893
 
    deprecated=True)
 
2649
    )
3894
2650
format_registry.register_metadir('dirstate-with-subtree',
3895
2651
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
3896
2652
    help='New in 0.15: Fast local operations and improved scaling for '
3906
2662
    help='New in 0.92: Pack-based format with data compatible with '
3907
2663
        'dirstate-tags format repositories. Interoperates with '
3908
2664
        'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3909
 
        ,
 
2665
        'Previously called knitpack-experimental.  '
 
2666
        'For more information, see '
 
2667
        'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
3910
2668
    branch_format='bzrlib.branch.BzrBranchFormat6',
3911
2669
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3912
2670
    )
3915
2673
    help='New in 0.92: Pack-based format with data compatible with '
3916
2674
        'dirstate-with-subtree format repositories. Interoperates with '
3917
2675
        'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3918
 
        ,
 
2676
        'Previously called knitpack-experimental.  '
 
2677
        'For more information, see '
 
2678
        'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
3919
2679
    branch_format='bzrlib.branch.BzrBranchFormat6',
3920
2680
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3921
2681
    hidden=True,
3923
2683
    )
3924
2684
format_registry.register_metadir('rich-root-pack',
3925
2685
    '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).',
 
2686
    help='New in 1.0: Pack-based format with data compatible with '
 
2687
        'rich-root format repositories. Incompatible with'
 
2688
        ' bzr < 1.0',
3928
2689
    branch_format='bzrlib.branch.BzrBranchFormat6',
3929
2690
    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 '
 
2691
    )
 
2692
# The following two formats should always just be aliases.
 
2693
format_registry.register_metadir('development',
 
2694
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment0',
 
2695
    help='Current development format. Can convert data to and from pack-0.92 '
 
2696
        '(and anything compatible with pack-0.92) format repositories. '
 
2697
        'Repositories in this format can only be read by bzr.dev. '
 
2698
        'Please read '
 
2699
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3987
2700
        'before use.',
3988
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3989
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
 
2701
    branch_format='bzrlib.branch.BzrBranchFormat6',
 
2702
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3990
2703
    experimental=True,
3991
2704
    alias=True,
3992
 
    hidden=True,
3993
2705
    )
3994
2706
format_registry.register_metadir('development-subtree',
3995
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment2Subtree',
 
2707
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment0Subtree',
3996
2708
    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',
 
2709
        'from pack-0.92 (and anything compatible with pack-0.92) format '
 
2710
        'repositories. Repositories in this format can only be read by '
 
2711
        'bzr.dev. Please read '
 
2712
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
 
2713
        'before use.',
 
2714
    branch_format='bzrlib.branch.BzrBranchFormat6',
 
2715
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
2716
    experimental=True,
4054
2717
    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')
 
2718
    )
 
2719
# And the development formats which the will have aliased one of follow:
 
2720
format_registry.register_metadir('development0',
 
2721
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment0',
 
2722
    help='Trivial rename of pack-0.92 to provide a development format. '
 
2723
        'Please read '
 
2724
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
 
2725
        'before use.',
 
2726
    branch_format='bzrlib.branch.BzrBranchFormat6',
 
2727
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
2728
    hidden=True,
 
2729
    experimental=True,
 
2730
    )
 
2731
format_registry.register_metadir('development0-subtree',
 
2732
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment0Subtree',
 
2733
    help='Trivial rename of pack-0.92-subtree to provide a development format. '
 
2734
        'Please read '
 
2735
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
 
2736
        'before use.',
 
2737
    branch_format='bzrlib.branch.BzrBranchFormat6',
 
2738
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
2739
    hidden=True,
 
2740
    experimental=True,
 
2741
    )
 
2742
format_registry.set_default('pack-0.92')