← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/bzrdir.py

  • Committer: Aaron Bentley
  • Date: 2007-06-21 23:43:17 UTC
  • mto: (2520.5.2 bzr.mpbundle)
  • mto: This revision was merged to the branch mainline in revision 2631.
  • Revision ID: abentley@panoramicfeedback.com-20070621234317-5w3h8h36oe90sups
Implement new merge directive format

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
 
19
19
At format 7 this was split out into Branch, Repository and Checkout control
20
20
directories.
21
 
 
22
 
Note: This module has a lot of ``open`` functions/methods that return
23
 
references to in-memory objects. As a rule, there are no matching ``close``
24
 
methods. To free any associated resources, simply stop referencing the
25
 
objects returned.
26
21
"""
27
22
 
28
 
# TODO: Move old formats into a plugin to make this file smaller.
29
 
 
 
23
# TODO: remove unittest dependency; put that stuff inside the test suite
 
24
 
 
25
# TODO: Can we move specific formats into separate modules to make this file
 
26
# smaller?
 
27
 
 
28
from cStringIO import StringIO
30
29
import os
31
 
import sys
32
 
import warnings
 
30
import textwrap
33
31
 
34
32
from bzrlib.lazy_import import lazy_import
35
33
lazy_import(globals(), """
 
34
from copy import deepcopy
36
35
from stat import S_ISDIR
37
 
import textwrap
 
36
import unittest
38
37
 
39
38
import bzrlib
40
39
from bzrlib import (
41
 
    branch,
42
 
    config,
43
40
    errors,
44
 
    graph,
45
41
    lockable_files,
46
42
    lockdir,
47
 
    osutils,
 
43
    registry,
48
44
    remote,
49
 
    repository,
50
45
    revision as _mod_revision,
 
46
    symbol_versioning,
51
47
    ui,
52
48
    urlutils,
53
 
    versionedfile,
54
 
    win32utils,
 
49
    xml4,
 
50
    xml5,
55
51
    workingtree,
56
52
    workingtree_4,
57
 
    xml4,
58
 
    xml5,
59
53
    )
60
54
from bzrlib.osutils import (
 
55
    safe_unicode,
 
56
    sha_strings,
61
57
    sha_string,
62
58
    )
63
 
from bzrlib.push import (
64
 
    PushResult,
65
 
    )
66
 
from bzrlib.repofmt import pack_repo
67
59
from bzrlib.smart.client import _SmartClient
 
60
from bzrlib.smart import protocol
 
61
from bzrlib.store.revision.text import TextRevisionStore
 
62
from bzrlib.store.text import TextStore
68
63
from bzrlib.store.versioned import WeaveStore
69
64
from bzrlib.transactions import WriteTransaction
70
65
from bzrlib.transport import (
71
66
    do_catching_redirections,
72
67
    get_transport,
73
 
    local,
74
68
    )
75
69
from bzrlib.weave import Weave
76
70
""")
78
72
from bzrlib.trace import (
79
73
    mutter,
80
74
    note,
81
 
    warning,
82
 
    )
83
 
 
84
 
from bzrlib import (
85
 
    hooks,
86
 
    registry,
87
 
    symbol_versioning,
88
 
    )
 
75
    )
 
76
from bzrlib.transport.local import LocalTransport
89
77
 
90
78
 
91
79
class BzrDir(object):
92
80
    """A .bzr control diretory.
93
 
 
 
81
    
94
82
    BzrDir instances let you create or open any of the things that can be
95
83
    found within .bzr - checkouts, branches and repositories.
96
 
 
97
 
    :ivar transport:
 
84
    
 
85
    transport
98
86
        the transport which this bzr dir is rooted at (i.e. file:///.../.bzr/)
99
 
    :ivar root_transport:
100
 
        a transport connected to the directory this bzr was opened from
101
 
        (i.e. the parent directory holding the .bzr directory).
102
 
 
103
 
    Everything in the bzrdir should have the same file permissions.
104
 
 
105
 
    :cvar hooks: An instance of BzrDirHooks.
 
87
    root_transport
 
88
        a transport connected to the directory this bzr was opened from.
106
89
    """
107
90
 
108
91
    def break_lock(self):
130
113
        return True
131
114
 
132
115
    def check_conversion_target(self, target_format):
133
 
        """Check that a bzrdir as a whole can be converted to a new format."""
134
 
        # The only current restriction is that the repository content can be 
135
 
        # fetched compatibly with the target.
136
116
        target_repo_format = target_format.repository_format
137
 
        try:
138
 
            self.open_repository()._format.check_conversion_target(
139
 
                target_repo_format)
140
 
        except errors.NoRepositoryPresent:
141
 
            # No repo, no problem.
142
 
            pass
 
117
        source_repo_format = self._format.repository_format
 
118
        source_repo_format.check_conversion_target(target_repo_format)
143
119
 
144
120
    @staticmethod
145
121
    def _check_supported(format, allow_unsupported,
147
123
        basedir=None):
148
124
        """Give an error or warning on old formats.
149
125
 
150
 
        :param format: may be any kind of format - workingtree, branch,
 
126
        :param format: may be any kind of format - workingtree, branch, 
151
127
        or repository.
152
128
 
153
 
        :param allow_unsupported: If true, allow opening
154
 
        formats that are strongly deprecated, and which may
 
129
        :param allow_unsupported: If true, allow opening 
 
130
        formats that are strongly deprecated, and which may 
155
131
        have limited functionality.
156
132
 
157
133
        :param recommend_upgrade: If true (default), warn
169
145
                format.get_format_description(),
170
146
                basedir)
171
147
 
172
 
    def clone(self, url, revision_id=None, force_new_repo=False,
173
 
              preserve_stacking=False):
 
148
    def clone(self, url, revision_id=None, force_new_repo=False):
174
149
        """Clone this bzrdir and its contents to url verbatim.
175
150
 
176
 
        :param url: The url create the clone at.  If url's last component does
177
 
            not exist, it will be created.
178
 
        :param revision_id: The tip revision-id to use for any branch or
179
 
            working tree.  If not None, then the clone operation may tune
 
151
        If urls last component does not exist, it will be created.
 
152
 
 
153
        if revision_id is not None, then the clone operation may tune
180
154
            itself to download less data.
181
 
        :param force_new_repo: Do not use a shared repository for the target
 
155
        :param force_new_repo: Do not use a shared repository for the target 
182
156
                               even if one is available.
183
 
        :param preserve_stacking: When cloning a stacked branch, stack the
184
 
            new branch on top of the other branch's stacked-on branch.
185
157
        """
186
158
        return self.clone_on_transport(get_transport(url),
187
159
                                       revision_id=revision_id,
188
 
                                       force_new_repo=force_new_repo,
189
 
                                       preserve_stacking=preserve_stacking)
 
160
                                       force_new_repo=force_new_repo)
190
161
 
191
162
    def clone_on_transport(self, transport, revision_id=None,
192
 
        force_new_repo=False, preserve_stacking=False, stacked_on=None,
193
 
        create_prefix=False, use_existing_dir=True):
 
163
                           force_new_repo=False):
194
164
        """Clone this bzrdir and its contents to transport verbatim.
195
165
 
196
 
        :param transport: The transport for the location to produce the clone
197
 
            at.  If the target directory does not exist, it will be created.
198
 
        :param revision_id: The tip revision-id to use for any branch or
199
 
            working tree.  If not None, then the clone operation may tune
 
166
        If the target directory does not exist, it will be created.
 
167
 
 
168
        if revision_id is not None, then the clone operation may tune
200
169
            itself to download less data.
201
 
        :param force_new_repo: Do not use a shared repository for the target,
 
170
        :param force_new_repo: Do not use a shared repository for the target 
202
171
                               even if one is available.
203
 
        :param preserve_stacking: When cloning a stacked branch, stack the
204
 
            new branch on top of the other branch's stacked-on branch.
205
 
        :param create_prefix: Create any missing directories leading up to
206
 
            to_transport.
207
 
        :param use_existing_dir: Use an existing directory if one exists.
208
172
        """
209
 
        # Overview: put together a broad description of what we want to end up
210
 
        # with; then make as few api calls as possible to do it.
211
 
        
212
 
        # We may want to create a repo/branch/tree, if we do so what format
213
 
        # would we want for each:
214
 
        require_stacking = (stacked_on is not None)
215
 
        format = self.cloning_metadir(require_stacking)
216
 
        
217
 
        # Figure out what objects we want:
 
173
        transport.ensure_base()
 
174
        result = self._format.initialize_on_transport(transport)
218
175
        try:
219
176
            local_repo = self.find_repository()
220
177
        except errors.NoRepositoryPresent:
221
178
            local_repo = None
222
 
        try:
223
 
            local_branch = self.open_branch()
224
 
        except errors.NotBranchError:
225
 
            local_branch = None
226
 
        else:
227
 
            # enable fallbacks when branch is not a branch reference
228
 
            if local_branch.repository.has_same_location(local_repo):
229
 
                local_repo = local_branch.repository
230
 
            if preserve_stacking:
231
 
                try:
232
 
                    stacked_on = local_branch.get_stacked_on_url()
233
 
                except (errors.UnstackableBranchFormat,
234
 
                        errors.UnstackableRepositoryFormat,
235
 
                        errors.NotStacked):
236
 
                    pass
237
 
        # Bug: We create a metadir without knowing if it can support stacking,
238
 
        # we should look up the policy needs first, or just use it as a hint,
239
 
        # or something.
240
179
        if local_repo:
241
 
            make_working_trees = local_repo.make_working_trees()
242
 
            want_shared = local_repo.is_shared()
243
 
            repo_format_name = format.repository_format.network_name()
244
 
        else:
245
 
            make_working_trees = False
246
 
            want_shared = False
247
 
            repo_format_name = None
248
 
 
249
 
        result_repo, result, require_stacking, repository_policy = \
250
 
            format.initialize_on_transport_ex(transport,
251
 
            use_existing_dir=use_existing_dir, create_prefix=create_prefix,
252
 
            force_new_repo=force_new_repo, stacked_on=stacked_on,
253
 
            stack_on_pwd=self.root_transport.base,
254
 
            repo_format_name=repo_format_name,
255
 
            make_working_trees=make_working_trees, shared_repo=want_shared)
256
 
        if repo_format_name:
257
 
            try:
258
 
                # If the result repository is in the same place as the
259
 
                # resulting bzr dir, it will have no content, further if the
260
 
                # result is not stacked then we know all content should be
261
 
                # copied, and finally if we are copying up to a specific
262
 
                # revision_id then we can use the pending-ancestry-result which
263
 
                # does not require traversing all of history to describe it.
264
 
                if (result_repo.bzrdir.root_transport.base ==
265
 
                    result.root_transport.base and not require_stacking and
266
 
                    revision_id is not None):
267
 
                    fetch_spec = graph.PendingAncestryResult(
268
 
                        [revision_id], local_repo)
269
 
                    result_repo.fetch(local_repo, fetch_spec=fetch_spec)
270
 
                else:
 
180
            # may need to copy content in
 
181
            if force_new_repo:
 
182
                result_repo = local_repo.clone(
 
183
                    result,
 
184
                    revision_id=revision_id)
 
185
                result_repo.set_make_working_trees(local_repo.make_working_trees())
 
186
            else:
 
187
                try:
 
188
                    result_repo = result.find_repository()
 
189
                    # fetch content this dir needs.
271
190
                    result_repo.fetch(local_repo, revision_id=revision_id)
272
 
            finally:
273
 
                result_repo.unlock()
274
 
        else:
275
 
            if result_repo is not None:
276
 
                raise AssertionError('result_repo not None(%r)' % result_repo)
 
191
                except errors.NoRepositoryPresent:
 
192
                    # needed to make one anyway.
 
193
                    result_repo = local_repo.clone(
 
194
                        result,
 
195
                        revision_id=revision_id)
 
196
                    result_repo.set_make_working_trees(local_repo.make_working_trees())
277
197
        # 1 if there is a branch present
278
198
        #   make sure its content is available in the target repository
279
199
        #   clone it.
280
 
        if local_branch is not None:
281
 
            result_branch = local_branch.clone(result, revision_id=revision_id,
282
 
                repository_policy=repository_policy)
283
 
        try:
284
 
            # Cheaper to check if the target is not local, than to try making
285
 
            # the tree and fail.
286
 
            result.root_transport.local_abspath('.')
287
 
            if result_repo is None or result_repo.make_working_trees():
288
 
                self.open_workingtree().clone(result)
 
200
        try:
 
201
            self.open_branch().clone(result, revision_id=revision_id)
 
202
        except errors.NotBranchError:
 
203
            pass
 
204
        try:
 
205
            self.open_workingtree().clone(result)
289
206
        except (errors.NoWorkingTree, errors.NotLocalUrl):
290
207
            pass
291
208
        return result
296
213
        t = get_transport(url)
297
214
        t.ensure_base()
298
215
 
 
216
    # TODO: Should take a Transport
299
217
    @classmethod
300
 
    def create(cls, base, format=None, possible_transports=None):
 
218
    def create(cls, base, format=None):
301
219
        """Create a new BzrDir at the url 'base'.
 
220
        
 
221
        This will call the current default formats initialize with base
 
222
        as the only parameter.
302
223
 
303
224
        :param format: If supplied, the format of branch to create.  If not
304
225
            supplied, the default is used.
305
 
        :param possible_transports: If supplied, a list of transports that
306
 
            can be reused to share a remote connection.
307
226
        """
308
227
        if cls is not BzrDir:
309
228
            raise AssertionError("BzrDir.create always creates the default"
310
229
                " format, not one of %r" % cls)
311
 
        t = get_transport(base, possible_transports)
 
230
        t = get_transport(base)
312
231
        t.ensure_base()
313
232
        if format is None:
314
233
            format = BzrDirFormat.get_default_format()
315
 
        return format.initialize_on_transport(t)
316
 
 
317
 
    @staticmethod
318
 
    def find_bzrdirs(transport, evaluate=None, list_current=None):
319
 
        """Find bzrdirs recursively from current location.
320
 
 
321
 
        This is intended primarily as a building block for more sophisticated
322
 
        functionality, like finding trees under a directory, or finding
323
 
        branches that use a given repository.
324
 
        :param evaluate: An optional callable that yields recurse, value,
325
 
            where recurse controls whether this bzrdir is recursed into
326
 
            and value is the value to yield.  By default, all bzrdirs
327
 
            are recursed into, and the return value is the bzrdir.
328
 
        :param list_current: if supplied, use this function to list the current
329
 
            directory, instead of Transport.list_dir
330
 
        :return: a generator of found bzrdirs, or whatever evaluate returns.
331
 
        """
332
 
        if list_current is None:
333
 
            def list_current(transport):
334
 
                return transport.list_dir('')
335
 
        if evaluate is None:
336
 
            def evaluate(bzrdir):
337
 
                return True, bzrdir
338
 
 
339
 
        pending = [transport]
340
 
        while len(pending) > 0:
341
 
            current_transport = pending.pop()
342
 
            recurse = True
343
 
            try:
344
 
                bzrdir = BzrDir.open_from_transport(current_transport)
345
 
            except errors.NotBranchError:
346
 
                pass
347
 
            else:
348
 
                recurse, value = evaluate(bzrdir)
349
 
                yield value
350
 
            try:
351
 
                subdirs = list_current(current_transport)
352
 
            except errors.NoSuchFile:
353
 
                continue
354
 
            if recurse:
355
 
                for subdir in sorted(subdirs, reverse=True):
356
 
                    pending.append(current_transport.clone(subdir))
357
 
 
358
 
    def list_branches(self):
359
 
        """Return a sequence of all branches local to this control directory.
360
 
 
361
 
        """
362
 
        try:
363
 
            return [self.open_branch()]
364
 
        except errors.NotBranchError:
365
 
            return []
366
 
 
367
 
    @staticmethod
368
 
    def find_branches(transport):
369
 
        """Find all branches under a transport.
370
 
 
371
 
        This will find all branches below the transport, including branches
372
 
        inside other branches.  Where possible, it will use
373
 
        Repository.find_branches.
374
 
 
375
 
        To list all the branches that use a particular Repository, see
376
 
        Repository.find_branches
377
 
        """
378
 
        def evaluate(bzrdir):
379
 
            try:
380
 
                repository = bzrdir.open_repository()
381
 
            except errors.NoRepositoryPresent:
382
 
                pass
383
 
            else:
384
 
                return False, ([], repository)
385
 
            return True, (bzrdir.list_branches(), None)
386
 
        ret = []
387
 
        for branches, repo in BzrDir.find_bzrdirs(transport,
388
 
                                                  evaluate=evaluate):
389
 
            if repo is not None:
390
 
                ret.extend(repo.find_branches())
391
 
            if branches is not None:
392
 
                ret.extend(branches)
393
 
        return ret
394
 
 
395
 
    def destroy_repository(self):
396
 
        """Destroy the repository in this BzrDir"""
397
 
        raise NotImplementedError(self.destroy_repository)
 
234
        return format.initialize(safe_unicode(base))
398
235
 
399
236
    def create_branch(self):
400
237
        """Create a branch in this BzrDir.
401
238
 
402
 
        The bzrdir's format will control what branch format is created.
 
239
        The bzrdirs format will control what branch format is created.
403
240
        For more control see BranchFormatXX.create(a_bzrdir).
404
241
        """
405
242
        raise NotImplementedError(self.create_branch)
406
243
 
407
 
    def destroy_branch(self):
408
 
        """Destroy the branch in this BzrDir"""
409
 
        raise NotImplementedError(self.destroy_branch)
410
 
 
411
244
    @staticmethod
412
245
    def create_branch_and_repo(base, force_new_repo=False, format=None):
413
246
        """Create a new BzrDir, Branch and Repository at the url 'base'.
414
247
 
415
 
        This will use the current default BzrDirFormat unless one is
416
 
        specified, and use whatever
 
248
        This will use the current default BzrDirFormat, and use whatever 
417
249
        repository format that that uses via bzrdir.create_branch and
418
250
        create_repository. If a shared repository is available that is used
419
251
        preferentially.
422
254
 
423
255
        :param base: The URL to create the branch at.
424
256
        :param force_new_repo: If True a new repository is always created.
425
 
        :param format: If supplied, the format of branch to create.  If not
426
 
            supplied, the default is used.
427
257
        """
428
258
        bzrdir = BzrDir.create(base, format)
429
259
        bzrdir._find_or_create_repository(force_new_repo)
430
260
        return bzrdir.create_branch()
431
261
 
432
 
    def determine_repository_policy(self, force_new_repo=False, stack_on=None,
433
 
                                    stack_on_pwd=None, require_stacking=False):
434
 
        """Return an object representing a policy to use.
435
 
 
436
 
        This controls whether a new repository is created, and the format of
437
 
        that repository, or some existing shared repository used instead.
438
 
 
439
 
        If stack_on is supplied, will not seek a containing shared repo.
440
 
 
441
 
        :param force_new_repo: If True, require a new repository to be created.
442
 
        :param stack_on: If supplied, the location to stack on.  If not
443
 
            supplied, a default_stack_on location may be used.
444
 
        :param stack_on_pwd: If stack_on is relative, the location it is
445
 
            relative to.
446
 
        """
447
 
        def repository_policy(found_bzrdir):
448
 
            stack_on = None
449
 
            stack_on_pwd = None
450
 
            config = found_bzrdir.get_config()
451
 
            stop = False
452
 
            stack_on = config.get_default_stack_on()
453
 
            if stack_on is not None:
454
 
                stack_on_pwd = found_bzrdir.root_transport.base
455
 
                stop = True
456
 
            # does it have a repository ?
457
 
            try:
458
 
                repository = found_bzrdir.open_repository()
459
 
            except errors.NoRepositoryPresent:
460
 
                repository = None
461
 
            else:
462
 
                if ((found_bzrdir.root_transport.base !=
463
 
                     self.root_transport.base) and not repository.is_shared()):
464
 
                    # Don't look higher, can't use a higher shared repo.
465
 
                    repository = None
466
 
                    stop = True
467
 
                else:
468
 
                    stop = True
469
 
            if not stop:
470
 
                return None, False
471
 
            if repository:
472
 
                return UseExistingRepository(repository, stack_on,
473
 
                    stack_on_pwd, require_stacking=require_stacking), True
474
 
            else:
475
 
                return CreateRepository(self, stack_on, stack_on_pwd,
476
 
                    require_stacking=require_stacking), True
477
 
 
478
 
        if not force_new_repo:
479
 
            if stack_on is None:
480
 
                policy = self._find_containing(repository_policy)
481
 
                if policy is not None:
482
 
                    return policy
483
 
            else:
484
 
                try:
485
 
                    return UseExistingRepository(self.open_repository(),
486
 
                        stack_on, stack_on_pwd,
487
 
                        require_stacking=require_stacking)
488
 
                except errors.NoRepositoryPresent:
489
 
                    pass
490
 
        return CreateRepository(self, stack_on, stack_on_pwd,
491
 
                                require_stacking=require_stacking)
492
 
 
493
262
    def _find_or_create_repository(self, force_new_repo):
494
263
        """Create a new repository if needed, returning the repository."""
495
 
        policy = self.determine_repository_policy(force_new_repo)
496
 
        return policy.acquire_repository()[0]
497
 
 
 
264
        if force_new_repo:
 
265
            return self.create_repository()
 
266
        try:
 
267
            return self.find_repository()
 
268
        except errors.NoRepositoryPresent:
 
269
            return self.create_repository()
 
270
        
498
271
    @staticmethod
499
272
    def create_branch_convenience(base, force_new_repo=False,
500
 
                                  force_new_tree=None, format=None,
501
 
                                  possible_transports=None):
 
273
                                  force_new_tree=None, format=None):
502
274
        """Create a new BzrDir, Branch and Repository at the url 'base'.
503
275
 
504
276
        This is a convenience function - it will use an existing repository
505
277
        if possible, can be told explicitly whether to create a working tree or
506
278
        not.
507
279
 
508
 
        This will use the current default BzrDirFormat unless one is
509
 
        specified, and use whatever
 
280
        This will use the current default BzrDirFormat, and use whatever 
510
281
        repository format that that uses via bzrdir.create_branch and
511
282
        create_repository. If a shared repository is available that is used
512
283
        preferentially. Whatever repository is used, its tree creation policy
514
285
 
515
286
        The created Branch object is returned.
516
287
        If a working tree cannot be made due to base not being a file:// url,
517
 
        no error is raised unless force_new_tree is True, in which case no
 
288
        no error is raised unless force_new_tree is True, in which case no 
518
289
        data is created on disk and NotLocalUrl is raised.
519
290
 
520
291
        :param base: The URL to create the branch at.
521
292
        :param force_new_repo: If True a new repository is always created.
522
 
        :param force_new_tree: If True or False force creation of a tree or
 
293
        :param force_new_tree: If True or False force creation of a tree or 
523
294
                               prevent such creation respectively.
524
 
        :param format: Override for the bzrdir format to create.
525
 
        :param possible_transports: An optional reusable transports list.
 
295
        :param format: Override for the for the bzrdir format to create
526
296
        """
527
297
        if force_new_tree:
528
298
            # check for non local urls
529
 
            t = get_transport(base, possible_transports)
530
 
            if not isinstance(t, local.LocalTransport):
 
299
            t = get_transport(safe_unicode(base))
 
300
            if not isinstance(t, LocalTransport):
531
301
                raise errors.NotLocalUrl(base)
532
 
        bzrdir = BzrDir.create(base, format, possible_transports)
 
302
        bzrdir = BzrDir.create(base, format)
533
303
        repo = bzrdir._find_or_create_repository(force_new_repo)
534
304
        result = bzrdir.create_branch()
535
 
        if force_new_tree or (repo.make_working_trees() and
 
305
        if force_new_tree or (repo.make_working_trees() and 
536
306
                              force_new_tree is None):
537
307
            try:
538
308
                bzrdir.create_workingtree()
539
309
            except errors.NotLocalUrl:
540
310
                pass
541
311
        return result
 
312
        
 
313
    @staticmethod
 
314
    def create_repository(base, shared=False, format=None):
 
315
        """Create a new BzrDir and Repository at the url 'base'.
 
316
 
 
317
        If no format is supplied, this will default to the current default
 
318
        BzrDirFormat by default, and use whatever repository format that that
 
319
        uses for bzrdirformat.create_repository.
 
320
 
 
321
        :param shared: Create a shared repository rather than a standalone
 
322
                       repository.
 
323
        The Repository object is returned.
 
324
 
 
325
        This must be overridden as an instance method in child classes, where
 
326
        it should take no parameters and construct whatever repository format
 
327
        that child class desires.
 
328
        """
 
329
        bzrdir = BzrDir.create(base, format)
 
330
        return bzrdir.create_repository(shared)
542
331
 
543
332
    @staticmethod
544
333
    def create_standalone_workingtree(base, format=None):
546
335
 
547
336
        'base' must be a local path or a file:// url.
548
337
 
549
 
        This will use the current default BzrDirFormat unless one is
550
 
        specified, and use whatever
 
338
        This will use the current default BzrDirFormat, and use whatever 
551
339
        repository format that that uses for bzrdirformat.create_workingtree,
552
340
        create_branch and create_repository.
553
341
 
554
 
        :param format: Override for the bzrdir format to create.
555
342
        :return: The WorkingTree object.
556
343
        """
557
 
        t = get_transport(base)
558
 
        if not isinstance(t, local.LocalTransport):
 
344
        t = get_transport(safe_unicode(base))
 
345
        if not isinstance(t, LocalTransport):
559
346
            raise errors.NotLocalUrl(base)
560
 
        bzrdir = BzrDir.create_branch_and_repo(base,
 
347
        bzrdir = BzrDir.create_branch_and_repo(safe_unicode(base),
561
348
                                               force_new_repo=True,
562
349
                                               format=format).bzrdir
563
350
        return bzrdir.create_workingtree()
564
351
 
565
 
    def create_workingtree(self, revision_id=None, from_branch=None,
566
 
        accelerator_tree=None, hardlink=False):
 
352
    def create_workingtree(self, revision_id=None):
567
353
        """Create a working tree at this BzrDir.
568
 
 
569
 
        :param revision_id: create it as of this revision id.
570
 
        :param from_branch: override bzrdir branch (for lightweight checkouts)
571
 
        :param accelerator_tree: A tree which can be used for retrieving file
572
 
            contents more quickly than the revision tree, i.e. a workingtree.
573
 
            The revision tree will be used for cases where accelerator_tree's
574
 
            content is different.
 
354
        
 
355
        revision_id: create it as of this revision id.
575
356
        """
576
357
        raise NotImplementedError(self.create_workingtree)
577
358
 
578
 
    def backup_bzrdir(self):
579
 
        """Backup this bzr control directory.
580
 
 
581
 
        :return: Tuple with old path name and new path name
582
 
        """
583
 
        def name_gen(base='backup.bzr'):
584
 
            counter = 1
585
 
            name = "%s.~%d~" % (base, counter)
586
 
            while self.root_transport.has(name):
587
 
                counter += 1
588
 
                name = "%s.~%d~" % (base, counter)
589
 
            return name
590
 
 
591
 
        backup_dir=name_gen()
592
 
        pb = ui.ui_factory.nested_progress_bar()
593
 
        try:
594
 
            # FIXME: bug 300001 -- the backup fails if the backup directory
595
 
            # already exists, but it should instead either remove it or make
596
 
            # a new backup directory.
597
 
            #
598
 
            # FIXME: bug 262450 -- the backup directory should have the same
599
 
            # permissions as the .bzr directory (probably a bug in copy_tree)
600
 
            old_path = self.root_transport.abspath('.bzr')
601
 
            new_path = self.root_transport.abspath(backup_dir)
602
 
            ui.ui_factory.note('making backup of %s\n  to %s' % (old_path, new_path,))
603
 
            self.root_transport.copy_tree('.bzr', backup_dir)
604
 
            return (old_path, new_path)
605
 
        finally:
606
 
            pb.finished()
607
 
 
608
 
    def retire_bzrdir(self, limit=10000):
 
359
    def retire_bzrdir(self):
609
360
        """Permanently disable the bzrdir.
610
361
 
611
362
        This is done by renaming it to give the user some ability to recover
613
364
 
614
365
        This will have horrible consequences if anyone has anything locked or
615
366
        in use.
616
 
        :param limit: number of times to retry
617
367
        """
618
 
        i  = 0
619
 
        while True:
 
368
        for i in xrange(10000):
620
369
            try:
621
370
                to_path = '.bzr.retired.%d' % i
622
371
                self.root_transport.rename('.bzr', to_path)
623
372
                note("renamed %s to %s"
624
373
                    % (self.root_transport.abspath('.bzr'), to_path))
625
 
                return
 
374
                break
626
375
            except (errors.TransportError, IOError, errors.PathError):
627
 
                i += 1
628
 
                if i > limit:
629
 
                    raise
630
 
                else:
631
 
                    pass
 
376
                pass
632
377
 
633
378
    def destroy_workingtree(self):
634
379
        """Destroy the working tree at this BzrDir.
645
390
        """
646
391
        raise NotImplementedError(self.destroy_workingtree_metadata)
647
392
 
648
 
    def _find_containing(self, evaluate):
649
 
        """Find something in a containing control directory.
650
 
 
651
 
        This method will scan containing control dirs, until it finds what
652
 
        it is looking for, decides that it will never find it, or runs out
653
 
        of containing control directories to check.
654
 
 
655
 
        It is used to implement find_repository and
656
 
        determine_repository_policy.
657
 
 
658
 
        :param evaluate: A function returning (value, stop).  If stop is True,
659
 
            the value will be returned.
 
393
    def find_repository(self):
 
394
        """Find the repository that should be used for a_bzrdir.
 
395
 
 
396
        This does not require a branch as we use it to find the repo for
 
397
        new branches as well as to hook existing branches up to their
 
398
        repository.
660
399
        """
661
 
        found_bzrdir = self
 
400
        try:
 
401
            return self.open_repository()
 
402
        except errors.NoRepositoryPresent:
 
403
            pass
 
404
        next_transport = self.root_transport.clone('..')
662
405
        while True:
663
 
            result, stop = evaluate(found_bzrdir)
664
 
            if stop:
665
 
                return result
666
 
            next_transport = found_bzrdir.root_transport.clone('..')
667
 
            if (found_bzrdir.root_transport.base == next_transport.base):
668
 
                # top of the file system
669
 
                return None
670
406
            # find the next containing bzrdir
671
407
            try:
672
408
                found_bzrdir = BzrDir.open_containing_from_transport(
673
409
                    next_transport)[0]
674
410
            except errors.NotBranchError:
675
 
                return None
676
 
 
677
 
    def find_repository(self):
678
 
        """Find the repository that should be used.
679
 
 
680
 
        This does not require a branch as we use it to find the repo for
681
 
        new branches as well as to hook existing branches up to their
682
 
        repository.
683
 
        """
684
 
        def usable_repository(found_bzrdir):
 
411
                # none found
 
412
                raise errors.NoRepositoryPresent(self)
685
413
            # does it have a repository ?
686
414
            try:
687
415
                repository = found_bzrdir.open_repository()
688
416
            except errors.NoRepositoryPresent:
689
 
                return None, False
690
 
            if found_bzrdir.root_transport.base == self.root_transport.base:
691
 
                return repository, True
692
 
            elif repository.is_shared():
693
 
                return repository, True
 
417
                next_transport = found_bzrdir.root_transport.clone('..')
 
418
                if (found_bzrdir.root_transport.base == next_transport.base):
 
419
                    # top of the file system
 
420
                    break
 
421
                else:
 
422
                    continue
 
423
            if ((found_bzrdir.root_transport.base ==
 
424
                 self.root_transport.base) or repository.is_shared()):
 
425
                return repository
694
426
            else:
695
 
                return None, True
696
 
 
697
 
        found_repo = self._find_containing(usable_repository)
698
 
        if found_repo is None:
699
 
            raise errors.NoRepositoryPresent(self)
700
 
        return found_repo
 
427
                raise errors.NoRepositoryPresent(self)
 
428
        raise errors.NoRepositoryPresent(self)
701
429
 
702
430
    def get_branch_reference(self):
703
431
        """Return the referenced URL for the branch in this bzrdir.
715
443
        IncompatibleFormat if the branch format they are given has
716
444
        a format string, and vice versa.
717
445
 
718
 
        If branch_format is None, the transport is returned with no
719
 
        checking. If it is not None, then the returned transport is
 
446
        If branch_format is None, the transport is returned with no 
 
447
        checking. if it is not None, then the returned transport is
720
448
        guaranteed to point to an existing directory ready for use.
721
449
        """
722
450
        raise NotImplementedError(self.get_branch_transport)
723
 
 
724
 
    def _find_creation_modes(self):
725
 
        """Determine the appropriate modes for files and directories.
726
 
 
727
 
        They're always set to be consistent with the base directory,
728
 
        assuming that this transport allows setting modes.
729
 
        """
730
 
        # TODO: Do we need or want an option (maybe a config setting) to turn
731
 
        # this off or override it for particular locations? -- mbp 20080512
732
 
        if self._mode_check_done:
733
 
            return
734
 
        self._mode_check_done = True
735
 
        try:
736
 
            st = self.transport.stat('.')
737
 
        except errors.TransportNotPossible:
738
 
            self._dir_mode = None
739
 
            self._file_mode = None
740
 
        else:
741
 
            # Check the directory mode, but also make sure the created
742
 
            # directories and files are read-write for this user. This is
743
 
            # mostly a workaround for filesystems which lie about being able to
744
 
            # write to a directory (cygwin & win32)
745
 
            if (st.st_mode & 07777 == 00000):
746
 
                # FTP allows stat but does not return dir/file modes
747
 
                self._dir_mode = None
748
 
                self._file_mode = None
749
 
            else:
750
 
                self._dir_mode = (st.st_mode & 07777) | 00700
751
 
                # Remove the sticky and execute bits for files
752
 
                self._file_mode = self._dir_mode & ~07111
753
 
 
754
 
    def _get_file_mode(self):
755
 
        """Return Unix mode for newly created files, or None.
756
 
        """
757
 
        if not self._mode_check_done:
758
 
            self._find_creation_modes()
759
 
        return self._file_mode
760
 
 
761
 
    def _get_dir_mode(self):
762
 
        """Return Unix mode for newly created directories, or None.
763
 
        """
764
 
        if not self._mode_check_done:
765
 
            self._find_creation_modes()
766
 
        return self._dir_mode
767
 
 
 
451
        
768
452
    def get_repository_transport(self, repository_format):
769
453
        """Get the transport for use by repository format in this BzrDir.
770
454
 
772
456
        IncompatibleFormat if the repository format they are given has
773
457
        a format string, and vice versa.
774
458
 
775
 
        If repository_format is None, the transport is returned with no
776
 
        checking. If it is not None, then the returned transport is
 
459
        If repository_format is None, the transport is returned with no 
 
460
        checking. if it is not None, then the returned transport is
777
461
        guaranteed to point to an existing directory ready for use.
778
462
        """
779
463
        raise NotImplementedError(self.get_repository_transport)
780
 
 
 
464
        
781
465
    def get_workingtree_transport(self, tree_format):
782
466
        """Get the transport for use by workingtree format in this BzrDir.
783
467
 
785
469
        IncompatibleFormat if the workingtree format they are given has a
786
470
        format string, and vice versa.
787
471
 
788
 
        If workingtree_format is None, the transport is returned with no
789
 
        checking. If it is not None, then the returned transport is
 
472
        If workingtree_format is None, the transport is returned with no 
 
473
        checking. if it is not None, then the returned transport is
790
474
        guaranteed to point to an existing directory ready for use.
791
475
        """
792
476
        raise NotImplementedError(self.get_workingtree_transport)
793
 
 
794
 
    def get_config(self):
795
 
        """Get configuration for this BzrDir."""
796
 
        return config.BzrDirConfig(self)
797
 
 
798
 
    def _get_config(self):
799
 
        """By default, no configuration is available."""
800
 
        return None
801
 
 
 
477
        
802
478
    def __init__(self, _transport, _format):
803
479
        """Initialize a Bzr control dir object.
804
 
 
 
480
        
805
481
        Only really common logic should reside here, concrete classes should be
806
482
        made with varying behaviours.
807
483
 
811
487
        self._format = _format
812
488
        self.transport = _transport.clone('.bzr')
813
489
        self.root_transport = _transport
814
 
        self._mode_check_done = False
815
490
 
816
491
    def is_control_filename(self, filename):
817
492
        """True if filename is the name of a path which is reserved for bzrdir's.
818
 
 
 
493
        
819
494
        :param filename: A filename within the root transport of this bzrdir.
820
495
 
821
496
        This is true IF and ONLY IF the filename is part of the namespace reserved
824
499
        this in the future - for instance to make bzr talk with svn working
825
500
        trees.
826
501
        """
827
 
        # this might be better on the BzrDirFormat class because it refers to
828
 
        # all the possible bzrdir disk formats.
829
 
        # This method is tested via the workingtree is_control_filename tests-
830
 
        # it was extracted from WorkingTree.is_control_filename. If the method's
831
 
        # contract is extended beyond the current trivial implementation, please
 
502
        # this might be better on the BzrDirFormat class because it refers to 
 
503
        # all the possible bzrdir disk formats. 
 
504
        # This method is tested via the workingtree is_control_filename tests- 
 
505
        # it was extracted from WorkingTree.is_control_filename. If the methods
 
506
        # contract is extended beyond the current trivial  implementation please
832
507
        # add new tests for it to the appropriate place.
833
508
        return filename == '.bzr' or filename.startswith('.bzr/')
834
509
 
835
510
    def needs_format_conversion(self, format=None):
836
511
        """Return true if this bzrdir needs convert_format run on it.
837
 
 
838
 
        For instance, if the repository format is out of date but the
 
512
        
 
513
        For instance, if the repository format is out of date but the 
839
514
        branch and working tree are not, this should return True.
840
515
 
841
516
        :param format: Optional parameter indicating a specific desired
847
522
    def open_unsupported(base):
848
523
        """Open a branch which is not supported."""
849
524
        return BzrDir.open(base, _unsupported=True)
850
 
 
 
525
        
851
526
    @staticmethod
852
 
    def open(base, _unsupported=False, possible_transports=None):
853
 
        """Open an existing bzrdir, rooted at 'base' (url).
854
 
 
855
 
        :param _unsupported: a private parameter to the BzrDir class.
 
527
    def open(base, _unsupported=False):
 
528
        """Open an existing bzrdir, rooted at 'base' (url)
 
529
        
 
530
        _unsupported is a private parameter to the BzrDir class.
856
531
        """
857
 
        t = get_transport(base, possible_transports=possible_transports)
 
532
        t = get_transport(base)
858
533
        return BzrDir.open_from_transport(t, _unsupported=_unsupported)
859
534
 
860
535
    @staticmethod
865
540
        :param transport: Transport containing the bzrdir.
866
541
        :param _unsupported: private.
867
542
        """
868
 
        for hook in BzrDir.hooks['pre_open']:
869
 
            hook(transport)
870
 
        # Keep initial base since 'transport' may be modified while following
871
 
        # the redirections.
872
543
        base = transport.base
 
544
 
873
545
        def find_format(transport):
874
546
            return transport, BzrDirFormat.find_format(
875
547
                transport, _server_formats=_server_formats)
876
548
 
877
549
        def redirected(transport, e, redirection_notice):
878
 
            redirected_transport = transport._redirected_to(e.source, e.target)
879
 
            if redirected_transport is None:
880
 
                raise errors.NotBranchError(base)
 
550
            qualified_source = e.get_source_url()
 
551
            relpath = transport.relpath(qualified_source)
 
552
            if not e.target.endswith(relpath):
 
553
                # Not redirected to a branch-format, not a branch
 
554
                raise errors.NotBranchError(path=e.target)
 
555
            target = e.target[:-len(relpath)]
881
556
            note('%s is%s redirected to %s',
882
 
                 transport.base, e.permanently, redirected_transport.base)
883
 
            return redirected_transport
 
557
                 transport.base, e.permanently, target)
 
558
            # Let's try with a new transport
 
559
            qualified_target = e.get_target_url()[:-len(relpath)]
 
560
            # FIXME: If 'transport' has a qualifier, this should
 
561
            # be applied again to the new transport *iff* the
 
562
            # schemes used are the same. It's a bit tricky to
 
563
            # verify, so I'll punt for now
 
564
            # -- vila20070212
 
565
            return get_transport(target)
884
566
 
885
567
        try:
886
568
            transport, format = do_catching_redirections(find_format,
892
574
        BzrDir._check_supported(format, _unsupported)
893
575
        return format.open(transport, _found=True)
894
576
 
895
 
    def open_branch(self, unsupported=False, ignore_fallbacks=False):
 
577
    def open_branch(self, unsupported=False):
896
578
        """Open the branch object at this BzrDir if one is present.
897
579
 
898
580
        If unsupported is True, then no longer supported branch formats can
899
581
        still be opened.
900
 
 
 
582
        
901
583
        TODO: static convenience version of this?
902
584
        """
903
585
        raise NotImplementedError(self.open_branch)
904
586
 
905
587
    @staticmethod
906
 
    def open_containing(url, possible_transports=None):
 
588
    def open_containing(url):
907
589
        """Open an existing branch which contains url.
908
 
 
 
590
        
909
591
        :param url: url to search from.
910
592
        See open_containing_from_transport for more detail.
911
593
        """
912
 
        transport = get_transport(url, possible_transports)
913
 
        return BzrDir.open_containing_from_transport(transport)
914
 
 
 
594
        return BzrDir.open_containing_from_transport(get_transport(url))
 
595
    
915
596
    @staticmethod
916
597
    def open_containing_from_transport(a_transport):
917
 
        """Open an existing branch which contains a_transport.base.
 
598
        """Open an existing branch which contains a_transport.base
918
599
 
919
600
        This probes for a branch at a_transport, and searches upwards from there.
920
601
 
921
602
        Basically we keep looking up until we find the control directory or
922
603
        run into the root.  If there isn't one, raises NotBranchError.
923
 
        If there is one and it is either an unrecognised format or an unsupported
 
604
        If there is one and it is either an unrecognised format or an unsupported 
924
605
        format, UnknownFormatError or UnsupportedFormatError are raised.
925
606
        If there is one, it is returned, along with the unused portion of url.
926
607
 
927
 
        :return: The BzrDir that contains the path, and a Unicode path
 
608
        :return: The BzrDir that contains the path, and a Unicode path 
928
609
                for the rest of the URL.
929
610
        """
930
611
        # this gets the normalised url back. I.e. '.' -> the full path.
945
626
                raise errors.NotBranchError(path=url)
946
627
            a_transport = new_t
947
628
 
948
 
    def _get_tree_branch(self):
949
 
        """Return the branch and tree, if any, for this bzrdir.
950
 
 
951
 
        Return None for tree if not present or inaccessible.
952
 
        Raise NotBranchError if no branch is present.
953
 
        :return: (tree, branch)
954
 
        """
955
 
        try:
956
 
            tree = self.open_workingtree()
957
 
        except (errors.NoWorkingTree, errors.NotLocalUrl):
958
 
            tree = None
959
 
            branch = self.open_branch()
960
 
        else:
961
 
            branch = tree.branch
962
 
        return tree, branch
963
 
 
964
 
    @classmethod
965
 
    def open_tree_or_branch(klass, location):
966
 
        """Return the branch and working tree at a location.
967
 
 
968
 
        If there is no tree at the location, tree will be None.
969
 
        If there is no branch at the location, an exception will be
970
 
        raised
971
 
        :return: (tree, branch)
972
 
        """
973
 
        bzrdir = klass.open(location)
974
 
        return bzrdir._get_tree_branch()
975
 
 
976
629
    @classmethod
977
630
    def open_containing_tree_or_branch(klass, location):
978
631
        """Return the branch and working tree contained by a location.
984
637
        relpath is the portion of the path that is contained by the branch.
985
638
        """
986
639
        bzrdir, relpath = klass.open_containing(location)
987
 
        tree, branch = bzrdir._get_tree_branch()
 
640
        try:
 
641
            tree = bzrdir.open_workingtree()
 
642
        except (errors.NoWorkingTree, errors.NotLocalUrl):
 
643
            tree = None
 
644
            branch = bzrdir.open_branch()
 
645
        else:
 
646
            branch = tree.branch
988
647
        return tree, branch, relpath
989
648
 
990
 
    @classmethod
991
 
    def open_containing_tree_branch_or_repository(klass, location):
992
 
        """Return the working tree, branch and repo contained by a location.
993
 
 
994
 
        Returns (tree, branch, repository, relpath).
995
 
        If there is no tree containing the location, tree will be None.
996
 
        If there is no branch containing the location, branch will be None.
997
 
        If there is no repository containing the location, repository will be
998
 
        None.
999
 
        relpath is the portion of the path that is contained by the innermost
1000
 
        BzrDir.
1001
 
 
1002
 
        If no tree, branch or repository is found, a NotBranchError is raised.
1003
 
        """
1004
 
        bzrdir, relpath = klass.open_containing(location)
1005
 
        try:
1006
 
            tree, branch = bzrdir._get_tree_branch()
1007
 
        except errors.NotBranchError:
1008
 
            try:
1009
 
                repo = bzrdir.find_repository()
1010
 
                return None, None, repo, relpath
1011
 
            except (errors.NoRepositoryPresent):
1012
 
                raise errors.NotBranchError(location)
1013
 
        return tree, branch, branch.repository, relpath
1014
 
 
1015
649
    def open_repository(self, _unsupported=False):
1016
650
        """Open the repository object at this BzrDir if one is present.
1017
651
 
1018
 
        This will not follow the Branch object pointer - it's strictly a direct
 
652
        This will not follow the Branch object pointer - its strictly a direct
1019
653
        open facility. Most client code should use open_branch().repository to
1020
654
        get at a repository.
1021
655
 
1022
 
        :param _unsupported: a private parameter, not part of the api.
 
656
        _unsupported is a private parameter, not part of the api.
1023
657
        TODO: static convenience version of this?
1024
658
        """
1025
659
        raise NotImplementedError(self.open_repository)
1026
660
 
1027
661
    def open_workingtree(self, _unsupported=False,
1028
 
                         recommend_upgrade=True, from_branch=None):
 
662
            recommend_upgrade=True):
1029
663
        """Open the workingtree object at this BzrDir if one is present.
1030
664
 
1031
665
        :param recommend_upgrade: Optional keyword parameter, when True (the
1032
666
            default), emit through the ui module a recommendation that the user
1033
667
            upgrade the working tree when the workingtree being opened is old
1034
668
            (but still fully supported).
1035
 
        :param from_branch: override bzrdir branch (for lightweight checkouts)
1036
669
        """
1037
670
        raise NotImplementedError(self.open_workingtree)
1038
671
 
1039
672
    def has_branch(self):
1040
673
        """Tell if this bzrdir contains a branch.
1041
 
 
 
674
        
1042
675
        Note: if you're going to open the branch, you should just go ahead
1043
 
        and try, and not ask permission first.  (This method just opens the
1044
 
        branch and discards it, and that's somewhat expensive.)
 
676
        and try, and not ask permission first.  (This method just opens the 
 
677
        branch and discards it, and that's somewhat expensive.) 
1045
678
        """
1046
679
        try:
1047
680
            self.open_branch()
1054
687
 
1055
688
        This will still raise an exception if the bzrdir has a workingtree that
1056
689
        is remote & inaccessible.
1057
 
 
 
690
        
1058
691
        Note: if you're going to open the working tree, you should just go ahead
1059
 
        and try, and not ask permission first.  (This method just opens the
1060
 
        workingtree and discards it, and that's somewhat expensive.)
 
692
        and try, and not ask permission first.  (This method just opens the 
 
693
        workingtree and discards it, and that's somewhat expensive.) 
1061
694
        """
1062
695
        try:
1063
696
            self.open_workingtree(recommend_upgrade=False)
1066
699
            return False
1067
700
 
1068
701
    def _cloning_metadir(self):
1069
 
        """Produce a metadir suitable for cloning with.
1070
 
 
1071
 
        :returns: (destination_bzrdir_format, source_repository)
1072
 
        """
 
702
        """Produce a metadir suitable for cloning with"""
1073
703
        result_format = self._format.__class__()
1074
704
        try:
1075
705
            try:
1076
 
                branch = self.open_branch(ignore_fallbacks=True)
 
706
                branch = self.open_branch()
1077
707
                source_repository = branch.repository
1078
 
                result_format._branch_format = branch._format
1079
708
            except errors.NotBranchError:
1080
709
                source_branch = None
1081
710
                source_repository = self.open_repository()
1086
715
            # the fix recommended in bug # 103195 - to delegate this choice the
1087
716
            # repository itself.
1088
717
            repo_format = source_repository._format
1089
 
            if isinstance(repo_format, remote.RemoteRepositoryFormat):
1090
 
                source_repository._ensure_real()
1091
 
                repo_format = source_repository._real_repository._format
1092
 
            result_format.repository_format = repo_format
 
718
            if not isinstance(repo_format, remote.RemoteRepositoryFormat):
 
719
                result_format.repository_format = repo_format
1093
720
        try:
1094
721
            # TODO: Couldn't we just probe for the format in these cases,
1095
722
            # rather than opening the whole tree?  It would be a little
1101
728
            result_format.workingtree_format = tree._format.__class__()
1102
729
        return result_format, source_repository
1103
730
 
1104
 
    def cloning_metadir(self, require_stacking=False):
 
731
    def cloning_metadir(self):
1105
732
        """Produce a metadir suitable for cloning or sprouting with.
1106
733
 
1107
734
        These operations may produce workingtrees (yes, even though they're
1108
 
        "cloning" something that doesn't have a tree), so a viable workingtree
 
735
        "cloning" something that doesn't have a tree, so a viable workingtree
1109
736
        format must be selected.
1110
 
 
1111
 
        :require_stacking: If True, non-stackable formats will be upgraded
1112
 
            to similar stackable formats.
1113
 
        :returns: a BzrDirFormat with all component formats either set
1114
 
            appropriately or set to None if that component should not be
1115
 
            created.
1116
737
        """
1117
738
        format, repository = self._cloning_metadir()
1118
739
        if format._workingtree_format is None:
1119
 
            # No tree in self.
1120
740
            if repository is None:
1121
 
                # No repository either
1122
741
                return format
1123
 
            # We have a repository, so set a working tree? (Why? This seems to
1124
 
            # contradict the stated return value in the docstring).
1125
742
            tree_format = repository._format._matchingbzrdir.workingtree_format
1126
743
            format.workingtree_format = tree_format.__class__()
1127
 
        if require_stacking:
1128
 
            format.require_stacking()
1129
744
        return format
1130
745
 
1131
746
    def checkout_metadir(self):
1132
747
        return self.cloning_metadir()
1133
748
 
1134
749
    def sprout(self, url, revision_id=None, force_new_repo=False,
1135
 
               recurse='down', possible_transports=None,
1136
 
               accelerator_tree=None, hardlink=False, stacked=False,
1137
 
               source_branch=None, create_tree_if_local=True):
 
750
               recurse='down'):
1138
751
        """Create a copy of this bzrdir prepared for use as a new line of
1139
752
        development.
1140
753
 
1141
 
        If url's last component does not exist, it will be created.
 
754
        If urls last component does not exist, it will be created.
1142
755
 
1143
756
        Attributes related to the identity of the source branch like
1144
757
        branch nickname will be cleaned, a working tree is created
1147
760
 
1148
761
        if revision_id is not None, then the clone operation may tune
1149
762
            itself to download less data.
1150
 
        :param accelerator_tree: A tree which can be used for retrieving file
1151
 
            contents more quickly than the revision tree, i.e. a workingtree.
1152
 
            The revision tree will be used for cases where accelerator_tree's
1153
 
            content is different.
1154
 
        :param hardlink: If true, hard-link files from accelerator_tree,
1155
 
            where possible.
1156
 
        :param stacked: If true, create a stacked branch referring to the
1157
 
            location of this control directory.
1158
 
        :param create_tree_if_local: If true, a working-tree will be created
1159
 
            when working locally.
1160
763
        """
1161
 
        target_transport = get_transport(url, possible_transports)
 
764
        target_transport = get_transport(url)
1162
765
        target_transport.ensure_base()
1163
 
        cloning_format = self.cloning_metadir(stacked)
1164
 
        # Create/update the result branch
 
766
        cloning_format = self.cloning_metadir()
1165
767
        result = cloning_format.initialize_on_transport(target_transport)
1166
 
        # if a stacked branch wasn't requested, we don't create one
1167
 
        # even if the origin was stacked
1168
 
        stacked_branch_url = None
1169
 
        if source_branch is not None:
1170
 
            if stacked:
1171
 
                stacked_branch_url = self.root_transport.base
 
768
        try:
 
769
            source_branch = self.open_branch()
1172
770
            source_repository = source_branch.repository
1173
 
        else:
1174
 
            try:
1175
 
                source_branch = self.open_branch()
1176
 
                source_repository = source_branch.repository
1177
 
                if stacked:
1178
 
                    stacked_branch_url = self.root_transport.base
1179
 
            except errors.NotBranchError:
1180
 
                source_branch = None
1181
 
                try:
1182
 
                    source_repository = self.open_repository()
1183
 
                except errors.NoRepositoryPresent:
1184
 
                    source_repository = None
1185
 
        repository_policy = result.determine_repository_policy(
1186
 
            force_new_repo, stacked_branch_url, require_stacking=stacked)
1187
 
        result_repo, is_new_repo = repository_policy.acquire_repository()
1188
 
        if is_new_repo and revision_id is not None and not stacked:
1189
 
            fetch_spec = graph.PendingAncestryResult(
1190
 
                [revision_id], source_repository)
1191
 
        else:
1192
 
            fetch_spec = None
1193
 
        if source_repository is not None:
1194
 
            # Fetch while stacked to prevent unstacked fetch from
1195
 
            # Branch.sprout.
1196
 
            if fetch_spec is None:
 
771
        except errors.NotBranchError:
 
772
            source_branch = None
 
773
            try:
 
774
                source_repository = self.open_repository()
 
775
            except errors.NoRepositoryPresent:
 
776
                source_repository = None
 
777
        if force_new_repo:
 
778
            result_repo = None
 
779
        else:
 
780
            try:
 
781
                result_repo = result.find_repository()
 
782
            except errors.NoRepositoryPresent:
 
783
                result_repo = None
 
784
        if source_repository is None and result_repo is not None:
 
785
            pass
 
786
        elif source_repository is None and result_repo is None:
 
787
            # no repo available, make a new one
 
788
            result.create_repository()
 
789
        elif source_repository is not None and result_repo is None:
 
790
            # have source, and want to make a new target repo
 
791
            result_repo = source_repository.sprout(result, revision_id=revision_id)
 
792
        else:
 
793
            # fetch needed content into target.
 
794
            if source_repository is not None:
 
795
                # would rather do 
 
796
                # source_repository.copy_content_into(result_repo, revision_id=revision_id)
 
797
                # so we can override the copy method
1197
798
                result_repo.fetch(source_repository, revision_id=revision_id)
1198
 
            else:
1199
 
                result_repo.fetch(source_repository, fetch_spec=fetch_spec)
1200
 
 
1201
 
        if source_branch is None:
1202
 
            # this is for sprouting a bzrdir without a branch; is that
1203
 
            # actually useful?
1204
 
            # Not especially, but it's part of the contract.
1205
 
            result_branch = result.create_branch()
 
799
        if source_branch is not None:
 
800
            source_branch.sprout(result, revision_id=revision_id)
1206
801
        else:
1207
 
            result_branch = source_branch.sprout(result,
1208
 
                revision_id=revision_id, repository_policy=repository_policy)
1209
 
        mutter("created new branch %r" % (result_branch,))
1210
 
 
1211
 
        # Create/update the result working tree
1212
 
        if (create_tree_if_local and
1213
 
            isinstance(target_transport, local.LocalTransport) and
1214
 
            (result_repo is None or result_repo.make_working_trees())):
1215
 
            wt = result.create_workingtree(accelerator_tree=accelerator_tree,
1216
 
                hardlink=hardlink)
 
802
            result.create_branch()
 
803
        # TODO: jam 20060426 we probably need a test in here in the
 
804
        #       case that the newly sprouted branch is a remote one
 
805
        if result_repo is None or result_repo.make_working_trees():
 
806
            wt = result.create_workingtree()
1217
807
            wt.lock_write()
1218
808
            try:
1219
809
                if wt.path2id('') is None:
1230
820
                basis = wt.basis_tree()
1231
821
                basis.lock_read()
1232
822
                subtrees = basis.iter_references()
1233
 
            elif result_branch is not None:
1234
 
                basis = result_branch.basis_tree()
1235
 
                basis.lock_read()
1236
 
                subtrees = basis.iter_references()
 
823
                recurse_branch = wt.branch
1237
824
            elif source_branch is not None:
1238
825
                basis = source_branch.basis_tree()
1239
826
                basis.lock_read()
1240
827
                subtrees = basis.iter_references()
 
828
                recurse_branch = source_branch
1241
829
            else:
1242
830
                subtrees = []
1243
831
                basis = None
1247
835
                    sublocation = source_branch.reference_parent(file_id, path)
1248
836
                    sublocation.bzrdir.sprout(target,
1249
837
                        basis.get_reference_revision(file_id, path),
1250
 
                        force_new_repo=force_new_repo, recurse=recurse,
1251
 
                        stacked=stacked)
 
838
                        force_new_repo=force_new_repo, recurse=recurse)
1252
839
            finally:
1253
840
                if basis is not None:
1254
841
                    basis.unlock()
1255
842
        return result
1256
843
 
1257
 
    def push_branch(self, source, revision_id=None, overwrite=False, 
1258
 
        remember=False, create_prefix=False):
1259
 
        """Push the source branch into this BzrDir."""
1260
 
        br_to = None
1261
 
        # If we can open a branch, use its direct repository, otherwise see
1262
 
        # if there is a repository without a branch.
1263
 
        try:
1264
 
            br_to = self.open_branch()
1265
 
        except errors.NotBranchError:
1266
 
            # Didn't find a branch, can we find a repository?
1267
 
            repository_to = self.find_repository()
1268
 
        else:
1269
 
            # Found a branch, so we must have found a repository
1270
 
            repository_to = br_to.repository
1271
 
 
1272
 
        push_result = PushResult()
1273
 
        push_result.source_branch = source
1274
 
        if br_to is None:
1275
 
            # We have a repository but no branch, copy the revisions, and then
1276
 
            # create a branch.
1277
 
            repository_to.fetch(source.repository, revision_id=revision_id)
1278
 
            br_to = source.clone(self, revision_id=revision_id)
1279
 
            if source.get_push_location() is None or remember:
1280
 
                source.set_push_location(br_to.base)
1281
 
            push_result.stacked_on = None
1282
 
            push_result.branch_push_result = None
1283
 
            push_result.old_revno = None
1284
 
            push_result.old_revid = _mod_revision.NULL_REVISION
1285
 
            push_result.target_branch = br_to
1286
 
            push_result.master_branch = None
1287
 
            push_result.workingtree_updated = False
1288
 
        else:
1289
 
            # We have successfully opened the branch, remember if necessary:
1290
 
            if source.get_push_location() is None or remember:
1291
 
                source.set_push_location(br_to.base)
1292
 
            try:
1293
 
                tree_to = self.open_workingtree()
1294
 
            except errors.NotLocalUrl:
1295
 
                push_result.branch_push_result = source.push(br_to, 
1296
 
                    overwrite, stop_revision=revision_id)
1297
 
                push_result.workingtree_updated = False
1298
 
            except errors.NoWorkingTree:
1299
 
                push_result.branch_push_result = source.push(br_to,
1300
 
                    overwrite, stop_revision=revision_id)
1301
 
                push_result.workingtree_updated = None # Not applicable
1302
 
            else:
1303
 
                tree_to.lock_write()
1304
 
                try:
1305
 
                    push_result.branch_push_result = source.push(
1306
 
                        tree_to.branch, overwrite, stop_revision=revision_id)
1307
 
                    tree_to.update()
1308
 
                finally:
1309
 
                    tree_to.unlock()
1310
 
                push_result.workingtree_updated = True
1311
 
            push_result.old_revno = push_result.branch_push_result.old_revno
1312
 
            push_result.old_revid = push_result.branch_push_result.old_revid
1313
 
            push_result.target_branch = \
1314
 
                push_result.branch_push_result.target_branch
1315
 
        return push_result
1316
 
 
1317
 
 
1318
 
class BzrDirHooks(hooks.Hooks):
1319
 
    """Hooks for BzrDir operations."""
1320
 
 
1321
 
    def __init__(self):
1322
 
        """Create the default hooks."""
1323
 
        hooks.Hooks.__init__(self)
1324
 
        self.create_hook(hooks.HookPoint('pre_open',
1325
 
            "Invoked before attempting to open a BzrDir with the transport "
1326
 
            "that the open will use.", (1, 14), None))
1327
 
 
1328
 
# install the default hooks
1329
 
BzrDir.hooks = BzrDirHooks()
1330
 
 
1331
844
 
1332
845
class BzrDirPreSplitOut(BzrDir):
1333
846
    """A common class for the all-in-one formats."""
1335
848
    def __init__(self, _transport, _format):
1336
849
        """See BzrDir.__init__."""
1337
850
        super(BzrDirPreSplitOut, self).__init__(_transport, _format)
 
851
        assert self._format._lock_class == lockable_files.TransportLock
 
852
        assert self._format._lock_file_name == 'branch-lock'
1338
853
        self._control_files = lockable_files.LockableFiles(
1339
854
                                            self.get_branch_transport(None),
1340
855
                                            self._format._lock_file_name,
1344
859
        """Pre-splitout bzrdirs do not suffer from stale locks."""
1345
860
        raise NotImplementedError(self.break_lock)
1346
861
 
1347
 
    def cloning_metadir(self, require_stacking=False):
1348
 
        """Produce a metadir suitable for cloning with."""
1349
 
        if require_stacking:
1350
 
            return format_registry.make_bzrdir('1.6')
1351
 
        return self._format.__class__()
1352
 
 
1353
 
    def clone(self, url, revision_id=None, force_new_repo=False,
1354
 
              preserve_stacking=False):
1355
 
        """See BzrDir.clone().
1356
 
 
1357
 
        force_new_repo has no effect, since this family of formats always
1358
 
        require a new repository.
1359
 
        preserve_stacking has no effect, since no source branch using this
1360
 
        family of formats can be stacked, so there is no stacking to preserve.
1361
 
        """
 
862
    def clone(self, url, revision_id=None, force_new_repo=False):
 
863
        """See BzrDir.clone()."""
 
864
        from bzrlib.workingtree import WorkingTreeFormat2
1362
865
        self._make_tail(url)
1363
866
        result = self._format._initialize_for_clone(url)
1364
867
        self.open_repository().clone(result, revision_id=revision_id)
1365
868
        from_branch = self.open_branch()
1366
869
        from_branch.clone(result, revision_id=revision_id)
1367
870
        try:
1368
 
            tree = self.open_workingtree()
 
871
            self.open_workingtree().clone(result)
1369
872
        except errors.NotLocalUrl:
1370
873
            # make a new one, this format always has to have one.
1371
 
            result._init_workingtree()
1372
 
        else:
1373
 
            tree.clone(result)
 
874
            try:
 
875
                WorkingTreeFormat2().initialize(result)
 
876
            except errors.NotLocalUrl:
 
877
                # but we cannot do it for remote trees.
 
878
                to_branch = result.open_branch()
 
879
                WorkingTreeFormat2().stub_initialize_remote(to_branch.control_files)
1374
880
        return result
1375
881
 
1376
882
    def create_branch(self):
1377
883
        """See BzrDir.create_branch."""
1378
 
        return self._format.get_branch_format().initialize(self)
1379
 
 
1380
 
    def destroy_branch(self):
1381
 
        """See BzrDir.destroy_branch."""
1382
 
        raise errors.UnsupportedOperation(self.destroy_branch, self)
 
884
        return self.open_branch()
1383
885
 
1384
886
    def create_repository(self, shared=False):
1385
887
        """See BzrDir.create_repository."""
1387
889
            raise errors.IncompatibleFormat('shared repository', self._format)
1388
890
        return self.open_repository()
1389
891
 
1390
 
    def destroy_repository(self):
1391
 
        """See BzrDir.destroy_repository."""
1392
 
        raise errors.UnsupportedOperation(self.destroy_repository, self)
1393
 
 
1394
 
    def create_workingtree(self, revision_id=None, from_branch=None,
1395
 
                           accelerator_tree=None, hardlink=False):
 
892
    def create_workingtree(self, revision_id=None):
1396
893
        """See BzrDir.create_workingtree."""
1397
 
        # The workingtree is sometimes created when the bzrdir is created,
1398
 
        # but not when cloning.
1399
 
 
1400
894
        # this looks buggy but is not -really-
1401
895
        # because this format creates the workingtree when the bzrdir is
1402
896
        # created
1404
898
        # and that will have set it for us, its only
1405
899
        # specific uses of create_workingtree in isolation
1406
900
        # that can do wonky stuff here, and that only
1407
 
        # happens for creating checkouts, which cannot be
 
901
        # happens for creating checkouts, which cannot be 
1408
902
        # done on this format anyway. So - acceptable wart.
1409
 
        if hardlink:
1410
 
            warning("can't support hardlinked working trees in %r"
1411
 
                % (self,))
1412
 
        try:
1413
 
            result = self.open_workingtree(recommend_upgrade=False)
1414
 
        except errors.NoSuchFile:
1415
 
            result = self._init_workingtree()
 
903
        result = self.open_workingtree(recommend_upgrade=False)
1416
904
        if revision_id is not None:
1417
905
            if revision_id == _mod_revision.NULL_REVISION:
1418
906
                result.set_parent_ids([])
1420
908
                result.set_parent_ids([revision_id])
1421
909
        return result
1422
910
 
1423
 
    def _init_workingtree(self):
1424
 
        from bzrlib.workingtree import WorkingTreeFormat2
1425
 
        try:
1426
 
            return WorkingTreeFormat2().initialize(self)
1427
 
        except errors.NotLocalUrl:
1428
 
            # Even though we can't access the working tree, we need to
1429
 
            # create its control files.
1430
 
            return WorkingTreeFormat2()._stub_initialize_on_transport(
1431
 
                self.transport, self._control_files._file_mode)
1432
 
 
1433
911
    def destroy_workingtree(self):
1434
912
        """See BzrDir.destroy_workingtree."""
1435
913
        raise errors.UnsupportedOperation(self.destroy_workingtree, self)
1436
914
 
1437
915
    def destroy_workingtree_metadata(self):
1438
916
        """See BzrDir.destroy_workingtree_metadata."""
1439
 
        raise errors.UnsupportedOperation(self.destroy_workingtree_metadata,
 
917
        raise errors.UnsupportedOperation(self.destroy_workingtree_metadata, 
1440
918
                                          self)
1441
919
 
1442
920
    def get_branch_transport(self, branch_format):
1474
952
        # if the format is not the same as the system default,
1475
953
        # an upgrade is needed.
1476
954
        if format is None:
1477
 
            symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1478
 
                % 'needs_format_conversion(format=None)')
1479
955
            format = BzrDirFormat.get_default_format()
1480
956
        return not isinstance(self._format, format.__class__)
1481
957
 
1482
 
    def open_branch(self, unsupported=False, ignore_fallbacks=False):
 
958
    def open_branch(self, unsupported=False):
1483
959
        """See BzrDir.open_branch."""
1484
960
        from bzrlib.branch import BzrBranchFormat4
1485
961
        format = BzrBranchFormat4()
1486
962
        self._check_supported(format, unsupported)
1487
963
        return format.open(self, _found=True)
1488
964
 
1489
 
    def sprout(self, url, revision_id=None, force_new_repo=False,
1490
 
               possible_transports=None, accelerator_tree=None,
1491
 
               hardlink=False, stacked=False, create_tree_if_local=True,
1492
 
               source_branch=None):
 
965
    def sprout(self, url, revision_id=None, force_new_repo=False):
1493
966
        """See BzrDir.sprout()."""
1494
 
        if source_branch is not None:
1495
 
            my_branch = self.open_branch()
1496
 
            if source_branch.base != my_branch.base:
1497
 
                raise AssertionError(
1498
 
                    "source branch %r is not within %r with branch %r" %
1499
 
                    (source_branch, self, my_branch))
1500
 
        if stacked:
1501
 
            raise errors.UnstackableBranchFormat(
1502
 
                self._format, self.root_transport.base)
1503
 
        if not create_tree_if_local:
1504
 
            raise errors.MustHaveWorkingTree(
1505
 
                self._format, self.root_transport.base)
1506
967
        from bzrlib.workingtree import WorkingTreeFormat2
1507
968
        self._make_tail(url)
1508
969
        result = self._format._initialize_for_clone(url)
1514
975
            self.open_branch().sprout(result, revision_id=revision_id)
1515
976
        except errors.NotBranchError:
1516
977
            pass
1517
 
 
1518
978
        # we always want a working tree
1519
 
        WorkingTreeFormat2().initialize(result,
1520
 
                                        accelerator_tree=accelerator_tree,
1521
 
                                        hardlink=hardlink)
 
979
        WorkingTreeFormat2().initialize(result)
1522
980
        return result
1523
981
 
1524
982
 
1525
983
class BzrDir4(BzrDirPreSplitOut):
1526
984
    """A .bzr version 4 control object.
1527
 
 
 
985
    
1528
986
    This is a deprecated format and may be removed after sept 2006.
1529
987
    """
1530
988
 
1534
992
 
1535
993
    def needs_format_conversion(self, format=None):
1536
994
        """Format 4 dirs are always in need of conversion."""
1537
 
        if format is None:
1538
 
            symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1539
 
                % 'needs_format_conversion(format=None)')
1540
995
        return True
1541
996
 
1542
997
    def open_repository(self):
1551
1006
    This is a deprecated format and may be removed after sept 2006.
1552
1007
    """
1553
1008
 
1554
 
    def has_workingtree(self):
1555
 
        """See BzrDir.has_workingtree."""
1556
 
        return True
1557
 
    
1558
1009
    def open_repository(self):
1559
1010
        """See BzrDir.open_repository."""
1560
1011
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
1576
1027
    This is a deprecated format and may be removed after sept 2006.
1577
1028
    """
1578
1029
 
1579
 
    def has_workingtree(self):
1580
 
        """See BzrDir.has_workingtree."""
1581
 
        return True
1582
 
    
1583
1030
    def open_repository(self):
1584
1031
        """See BzrDir.open_repository."""
1585
1032
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
1596
1043
 
1597
1044
class BzrDirMeta1(BzrDir):
1598
1045
    """A .bzr meta version 1 control object.
1599
 
 
1600
 
    This is the first control object where the
 
1046
    
 
1047
    This is the first control object where the 
1601
1048
    individual aspects are really split out: there are separate repository,
1602
1049
    workingtree and branch subdirectories and any subset of the three can be
1603
1050
    present within a BzrDir.
1611
1058
        """See BzrDir.create_branch."""
1612
1059
        return self._format.get_branch_format().initialize(self)
1613
1060
 
1614
 
    def destroy_branch(self):
1615
 
        """See BzrDir.create_branch."""
1616
 
        self.transport.delete_tree('branch')
1617
 
 
1618
1061
    def create_repository(self, shared=False):
1619
1062
        """See BzrDir.create_repository."""
1620
1063
        return self._format.repository_format.initialize(self, shared)
1621
1064
 
1622
 
    def destroy_repository(self):
1623
 
        """See BzrDir.destroy_repository."""
1624
 
        self.transport.delete_tree('repository')
1625
 
 
1626
 
    def create_workingtree(self, revision_id=None, from_branch=None,
1627
 
                           accelerator_tree=None, hardlink=False):
 
1065
    def create_workingtree(self, revision_id=None):
1628
1066
        """See BzrDir.create_workingtree."""
1629
 
        return self._format.workingtree_format.initialize(
1630
 
            self, revision_id, from_branch=from_branch,
1631
 
            accelerator_tree=accelerator_tree, hardlink=hardlink)
 
1067
        from bzrlib.workingtree import WorkingTreeFormat
 
1068
        return self._format.workingtree_format.initialize(self, revision_id)
1632
1069
 
1633
1070
    def destroy_workingtree(self):
1634
1071
        """See BzrDir.destroy_workingtree."""
1635
1072
        wt = self.open_workingtree(recommend_upgrade=False)
1636
1073
        repository = wt.branch.repository
1637
1074
        empty = repository.revision_tree(_mod_revision.NULL_REVISION)
1638
 
        wt.revert(old_tree=empty)
 
1075
        wt.revert([], old_tree=empty)
1639
1076
        self.destroy_workingtree_metadata()
1640
1077
 
1641
1078
    def destroy_workingtree_metadata(self):
1663
1100
 
1664
1101
    def get_branch_transport(self, branch_format):
1665
1102
        """See BzrDir.get_branch_transport()."""
1666
 
        # XXX: this shouldn't implicitly create the directory if it's just
1667
 
        # promising to get a transport -- mbp 20090727
1668
1103
        if branch_format is None:
1669
1104
            return self.transport.clone('branch')
1670
1105
        try:
1705
1140
            pass
1706
1141
        return self.transport.clone('checkout')
1707
1142
 
1708
 
    def has_workingtree(self):
1709
 
        """Tell if this bzrdir contains a working tree.
1710
 
 
1711
 
        This will still raise an exception if the bzrdir has a workingtree that
1712
 
        is remote & inaccessible.
1713
 
 
1714
 
        Note: if you're going to open the working tree, you should just go
1715
 
        ahead and try, and not ask permission first.
1716
 
        """
1717
 
        from bzrlib.workingtree import WorkingTreeFormat
1718
 
        try:
1719
 
            WorkingTreeFormat.find_format(self)
1720
 
        except errors.NoWorkingTree:
1721
 
            return False
1722
 
        return True
1723
 
 
1724
1143
    def needs_format_conversion(self, format=None):
1725
1144
        """See BzrDir.needs_format_conversion()."""
1726
1145
        if format is None:
1727
 
            symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1728
 
                % 'needs_format_conversion(format=None)')
1729
 
        if format is None:
1730
1146
            format = BzrDirFormat.get_default_format()
1731
1147
        if not isinstance(self._format, format.__class__):
1732
1148
            # it is not a meta dir format, conversion is needed.
1756
1172
            pass
1757
1173
        return False
1758
1174
 
1759
 
    def open_branch(self, unsupported=False, ignore_fallbacks=False):
 
1175
    def open_branch(self, unsupported=False):
1760
1176
        """See BzrDir.open_branch."""
1761
1177
        format = self.find_branch_format()
1762
1178
        self._check_supported(format, unsupported)
1763
 
        return format.open(self, _found=True, ignore_fallbacks=ignore_fallbacks)
 
1179
        return format.open(self, _found=True)
1764
1180
 
1765
1181
    def open_repository(self, unsupported=False):
1766
1182
        """See BzrDir.open_repository."""
1779
1195
            basedir=self.root_transport.base)
1780
1196
        return format.open(self, _found=True)
1781
1197
 
1782
 
    def _get_config(self):
1783
 
        return config.TransportConfig(self.transport, 'control.conf')
1784
 
 
1785
1198
 
1786
1199
class BzrDirFormat(object):
1787
1200
    """An encapsulation of the initialization and open routines for a format.
1791
1204
     * a format string,
1792
1205
     * an open routine.
1793
1206
 
1794
 
    Formats are placed in a dict by their format string for reference
 
1207
    Formats are placed in an dict by their format string for reference 
1795
1208
    during bzrdir opening. These should be subclasses of BzrDirFormat
1796
1209
    for consistency.
1797
1210
 
1798
1211
    Once a format is deprecated, just deprecate the initialize and open
1799
 
    methods on the format class. Do not deprecate the object, as the
 
1212
    methods on the format class. Do not deprecate the object, as the 
1800
1213
    object will be created every system load.
1801
1214
    """
1802
1215
 
1808
1221
 
1809
1222
    _control_formats = []
1810
1223
    """The registered control formats - .bzr, ....
1811
 
 
 
1224
    
1812
1225
    This is a list of BzrDirFormat objects.
1813
1226
    """
1814
1227
 
1842
1255
    def probe_transport(klass, transport):
1843
1256
        """Return the .bzrdir style format present in a directory."""
1844
1257
        try:
1845
 
            format_string = transport.get_bytes(".bzr/branch-format")
 
1258
            format_string = transport.get(".bzr/branch-format").read()
1846
1259
        except errors.NoSuchFile:
1847
1260
            raise errors.NotBranchError(path=transport.base)
1848
1261
 
1849
1262
        try:
1850
1263
            return klass._formats[format_string]
1851
1264
        except KeyError:
1852
 
            raise errors.UnknownFormatError(format=format_string, kind='bzrdir')
 
1265
            raise errors.UnknownFormatError(format=format_string)
1853
1266
 
1854
1267
    @classmethod
1855
1268
    def get_default_format(klass):
1873
1286
        current default format. In the case of plugins we can/should provide
1874
1287
        some means for them to extend the range of returnable converters.
1875
1288
 
1876
 
        :param format: Optional format to override the default format of the
 
1289
        :param format: Optional format to override the default format of the 
1877
1290
                       library.
1878
1291
        """
1879
1292
        raise NotImplementedError(self.get_converter)
1880
1293
 
1881
 
    def initialize(self, url, possible_transports=None):
 
1294
    def initialize(self, url):
1882
1295
        """Create a bzr control dir at this url and return an opened copy.
1883
 
 
1884
 
        While not deprecated, this method is very specific and its use will
1885
 
        lead to many round trips to setup a working environment. See
1886
 
        initialize_on_transport_ex for a [nearly] all-in-one method.
1887
 
 
 
1296
        
1888
1297
        Subclasses should typically override initialize_on_transport
1889
1298
        instead of this method.
1890
1299
        """
1891
 
        return self.initialize_on_transport(get_transport(url,
1892
 
                                                          possible_transports))
 
1300
        return self.initialize_on_transport(get_transport(url))
1893
1301
 
1894
1302
    def initialize_on_transport(self, transport):
1895
1303
        """Initialize a new bzrdir in the base directory of a Transport."""
1896
 
        try:
1897
 
            # can we hand off the request to the smart server rather than using
1898
 
            # vfs calls?
1899
 
            client_medium = transport.get_smart_medium()
1900
 
        except errors.NoSmartMedium:
1901
 
            return self._initialize_on_transport_vfs(transport)
1902
 
        else:
1903
 
            # Current RPC's only know how to create bzr metadir1 instances, so
1904
 
            # we still delegate to vfs methods if the requested format is not a
1905
 
            # metadir1
1906
 
            if type(self) != BzrDirMetaFormat1:
1907
 
                return self._initialize_on_transport_vfs(transport)
1908
 
            remote_format = RemoteBzrDirFormat()
1909
 
            self._supply_sub_formats_to(remote_format)
1910
 
            return remote_format.initialize_on_transport(transport)
1911
 
 
1912
 
    def initialize_on_transport_ex(self, transport, use_existing_dir=False,
1913
 
        create_prefix=False, force_new_repo=False, stacked_on=None,
1914
 
        stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
1915
 
        shared_repo=False, vfs_only=False):
1916
 
        """Create this format on transport.
1917
 
 
1918
 
        The directory to initialize will be created.
1919
 
 
1920
 
        :param force_new_repo: Do not use a shared repository for the target,
1921
 
                               even if one is available.
1922
 
        :param create_prefix: Create any missing directories leading up to
1923
 
            to_transport.
1924
 
        :param use_existing_dir: Use an existing directory if one exists.
1925
 
        :param stacked_on: A url to stack any created branch on, None to follow
1926
 
            any target stacking policy.
1927
 
        :param stack_on_pwd: If stack_on is relative, the location it is
1928
 
            relative to.
1929
 
        :param repo_format_name: If non-None, a repository will be
1930
 
            made-or-found. Should none be found, or if force_new_repo is True
1931
 
            the repo_format_name is used to select the format of repository to
1932
 
            create.
1933
 
        :param make_working_trees: Control the setting of make_working_trees
1934
 
            for a new shared repository when one is made. None to use whatever
1935
 
            default the format has.
1936
 
        :param shared_repo: Control whether made repositories are shared or
1937
 
            not.
1938
 
        :param vfs_only: If True do not attempt to use a smart server
1939
 
        :return: repo, bzrdir, require_stacking, repository_policy. repo is
1940
 
            None if none was created or found, bzrdir is always valid.
1941
 
            require_stacking is the result of examining the stacked_on
1942
 
            parameter and any stacking policy found for the target.
1943
 
        """
1944
 
        if not vfs_only:
1945
 
            # Try to hand off to a smart server 
1946
 
            try:
1947
 
                client_medium = transport.get_smart_medium()
1948
 
            except errors.NoSmartMedium:
1949
 
                pass
1950
 
            else:
1951
 
                # TODO: lookup the local format from a server hint.
1952
 
                remote_dir_format = RemoteBzrDirFormat()
1953
 
                remote_dir_format._network_name = self.network_name()
1954
 
                self._supply_sub_formats_to(remote_dir_format)
1955
 
                return remote_dir_format.initialize_on_transport_ex(transport,
1956
 
                    use_existing_dir=use_existing_dir, create_prefix=create_prefix,
1957
 
                    force_new_repo=force_new_repo, stacked_on=stacked_on,
1958
 
                    stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
1959
 
                    make_working_trees=make_working_trees, shared_repo=shared_repo)
1960
 
        # XXX: Refactor the create_prefix/no_create_prefix code into a
1961
 
        #      common helper function
1962
 
        # The destination may not exist - if so make it according to policy.
1963
 
        def make_directory(transport):
1964
 
            transport.mkdir('.')
1965
 
            return transport
1966
 
        def redirected(transport, e, redirection_notice):
1967
 
            note(redirection_notice)
1968
 
            return transport._redirected_to(e.source, e.target)
1969
 
        try:
1970
 
            transport = do_catching_redirections(make_directory, transport,
1971
 
                redirected)
1972
 
        except errors.FileExists:
1973
 
            if not use_existing_dir:
1974
 
                raise
1975
 
        except errors.NoSuchFile:
1976
 
            if not create_prefix:
1977
 
                raise
1978
 
            transport.create_prefix()
1979
 
 
1980
 
        require_stacking = (stacked_on is not None)
1981
 
        # Now the target directory exists, but doesn't have a .bzr
1982
 
        # directory. So we need to create it, along with any work to create
1983
 
        # all of the dependent branches, etc.
1984
 
 
1985
 
        result = self.initialize_on_transport(transport)
1986
 
        if repo_format_name:
1987
 
            try:
1988
 
                # use a custom format
1989
 
                result._format.repository_format = \
1990
 
                    repository.network_format_registry.get(repo_format_name)
1991
 
            except AttributeError:
1992
 
                # The format didn't permit it to be set.
1993
 
                pass
1994
 
            # A repository is desired, either in-place or shared.
1995
 
            repository_policy = result.determine_repository_policy(
1996
 
                force_new_repo, stacked_on, stack_on_pwd,
1997
 
                require_stacking=require_stacking)
1998
 
            result_repo, is_new_repo = repository_policy.acquire_repository(
1999
 
                make_working_trees, shared_repo)
2000
 
            if not require_stacking and repository_policy._require_stacking:
2001
 
                require_stacking = True
2002
 
                result._format.require_stacking()
2003
 
            result_repo.lock_write()
2004
 
        else:
2005
 
            result_repo = None
2006
 
            repository_policy = None
2007
 
        return result_repo, result, require_stacking, repository_policy
2008
 
 
2009
 
    def _initialize_on_transport_vfs(self, transport):
2010
 
        """Initialize a new bzrdir using VFS calls.
2011
 
 
2012
 
        :param transport: The transport to create the .bzr directory in.
2013
 
        :return: A
2014
 
        """
2015
 
        # Since we are creating a .bzr directory, inherit the
 
1304
        # Since we don't have a .bzr directory, inherit the
2016
1305
        # mode from the root directory
2017
1306
        temp_control = lockable_files.LockableFiles(transport,
2018
1307
                            '', lockable_files.TransportLock)
2020
1309
                                      # FIXME: RBC 20060121 don't peek under
2021
1310
                                      # the covers
2022
1311
                                      mode=temp_control._dir_mode)
2023
 
        if sys.platform == 'win32' and isinstance(transport, local.LocalTransport):
2024
 
            win32utils.set_file_attr_hidden(transport._abspath('.bzr'))
2025
1312
        file_mode = temp_control._file_mode
2026
1313
        del temp_control
2027
 
        bzrdir_transport = transport.clone('.bzr')
2028
 
        utf8_files = [('README',
2029
 
                       "This is a Bazaar control directory.\n"
2030
 
                       "Do not change any files in this directory.\n"
2031
 
                       "See http://bazaar-vcs.org/ for more information about Bazaar.\n"),
 
1314
        mutter('created control directory in ' + transport.base)
 
1315
        control = transport.clone('.bzr')
 
1316
        utf8_files = [('README', 
 
1317
                       "This is a Bazaar-NG control directory.\n"
 
1318
                       "Do not change any files in this directory.\n"),
2032
1319
                      ('branch-format', self.get_format_string()),
2033
1320
                      ]
2034
1321
        # NB: no need to escape relative paths that are url safe.
2035
 
        control_files = lockable_files.LockableFiles(bzrdir_transport,
2036
 
            self._lock_file_name, self._lock_class)
 
1322
        control_files = lockable_files.LockableFiles(control,
 
1323
                            self._lock_file_name, self._lock_class)
2037
1324
        control_files.create_lock()
2038
1325
        control_files.lock_write()
2039
1326
        try:
2040
 
            for (filename, content) in utf8_files:
2041
 
                bzrdir_transport.put_bytes(filename, content,
2042
 
                    mode=file_mode)
 
1327
            for file, content in utf8_files:
 
1328
                control_files.put_utf8(file, content)
2043
1329
        finally:
2044
1330
            control_files.unlock()
2045
1331
        return self.open(transport, _found=True)
2048
1334
        """Is this format supported?
2049
1335
 
2050
1336
        Supported formats must be initializable and openable.
2051
 
        Unsupported formats may not support initialization or committing or
 
1337
        Unsupported formats may not support initialization or committing or 
2052
1338
        some other features depending on the reason for not being supported.
2053
1339
        """
2054
1340
        return True
2055
1341
 
2056
 
    def network_name(self):
2057
 
        """A simple byte string uniquely identifying this format for RPC calls.
2058
 
 
2059
 
        Bzr control formats use thir disk format string to identify the format
2060
 
        over the wire. Its possible that other control formats have more
2061
 
        complex detection requirements, so we permit them to use any unique and
2062
 
        immutable string they desire.
2063
 
        """
2064
 
        raise NotImplementedError(self.network_name)
2065
 
 
2066
1342
    def same_model(self, target_format):
2067
 
        return (self.repository_format.rich_root_data ==
 
1343
        return (self.repository_format.rich_root_data == 
2068
1344
            target_format.rich_root_data)
2069
1345
 
2070
1346
    @classmethod
2071
1347
    def known_formats(klass):
2072
1348
        """Return all the known formats.
2073
 
 
 
1349
        
2074
1350
        Concrete formats should override _known_formats.
2075
1351
        """
2076
 
        # There is double indirection here to make sure that control
2077
 
        # formats used by more than one dir format will only be probed
 
1352
        # There is double indirection here to make sure that control 
 
1353
        # formats used by more than one dir format will only be probed 
2078
1354
        # once. This can otherwise be quite expensive for remote connections.
2079
1355
        result = set()
2080
1356
        for format in klass._control_formats:
2081
1357
            result.update(format._known_formats())
2082
1358
        return result
2083
 
 
 
1359
    
2084
1360
    @classmethod
2085
1361
    def _known_formats(klass):
2086
1362
        """Return the known format instances for this control format."""
2088
1364
 
2089
1365
    def open(self, transport, _found=False):
2090
1366
        """Return an instance of this format for the dir transport points at.
2091
 
 
 
1367
        
2092
1368
        _found is a private parameter, do not use it.
2093
1369
        """
2094
1370
        if not _found:
2095
1371
            found_format = BzrDirFormat.find_format(transport)
2096
1372
            if not isinstance(found_format, self.__class__):
2097
1373
                raise AssertionError("%s was asked to open %s, but it seems to need "
2098
 
                        "format %s"
 
1374
                        "format %s" 
2099
1375
                        % (self, transport, found_format))
2100
 
            # Allow subclasses - use the found format.
2101
 
            self._supply_sub_formats_to(found_format)
2102
 
            return found_format._open(transport)
2103
1376
        return self._open(transport)
2104
1377
 
2105
1378
    def _open(self, transport):
2113
1386
    @classmethod
2114
1387
    def register_format(klass, format):
2115
1388
        klass._formats[format.get_format_string()] = format
2116
 
        # bzr native formats have a network name of their format string.
2117
 
        network_format_registry.register(format.get_format_string(), format.__class__)
2118
1389
 
2119
1390
    @classmethod
2120
1391
    def register_control_format(klass, format):
2121
1392
        """Register a format that does not use '.bzr' for its control dir.
2122
1393
 
2123
1394
        TODO: This should be pulled up into a 'ControlDirFormat' base class
2124
 
        which BzrDirFormat can inherit from, and renamed to register_format
 
1395
        which BzrDirFormat can inherit from, and renamed to register_format 
2125
1396
        there. It has been done without that for now for simplicity of
2126
1397
        implementation.
2127
1398
        """
2139
1410
        klass._control_server_formats.append(format)
2140
1411
 
2141
1412
    @classmethod
 
1413
    @symbol_versioning.deprecated_method(symbol_versioning.zero_fourteen)
 
1414
    def set_default_format(klass, format):
 
1415
        klass._set_default_format(format)
 
1416
 
 
1417
    @classmethod
2142
1418
    def _set_default_format(klass, format):
2143
1419
        """Set default format (for testing behavior of defaults only)"""
2144
1420
        klass._default_format = format
2145
1421
 
2146
1422
    def __str__(self):
2147
 
        # Trim the newline
2148
 
        return self.get_format_description().rstrip()
2149
 
 
2150
 
    def _supply_sub_formats_to(self, other_format):
2151
 
        """Give other_format the same values for sub formats as this has.
2152
 
 
2153
 
        This method is expected to be used when parameterising a
2154
 
        RemoteBzrDirFormat instance with the parameters from a
2155
 
        BzrDirMetaFormat1 instance.
2156
 
 
2157
 
        :param other_format: other_format is a format which should be
2158
 
            compatible with whatever sub formats are supported by self.
2159
 
        :return: None.
2160
 
        """
 
1423
        return self.get_format_string()[:-1]
2161
1424
 
2162
1425
    @classmethod
2163
1426
    def unregister_format(klass, format):
 
1427
        assert klass._formats[format.get_format_string()] is format
2164
1428
        del klass._formats[format.get_format_string()]
2165
1429
 
2166
1430
    @classmethod
2195
1459
        """See BzrDirFormat.get_converter()."""
2196
1460
        # there is one and only one upgrade path here.
2197
1461
        return ConvertBzrDir4To5()
2198
 
 
 
1462
        
2199
1463
    def initialize_on_transport(self, transport):
2200
1464
        """Format 4 branches cannot be created."""
2201
1465
        raise errors.UninitializableFormat(self)
2204
1468
        """Format 4 is not supported.
2205
1469
 
2206
1470
        It is not supported because the model changed from 4 to 5 and the
2207
 
        conversion logic is expensive - so doing it on the fly was not
 
1471
        conversion logic is expensive - so doing it on the fly was not 
2208
1472
        feasible.
2209
1473
        """
2210
1474
        return False
2211
1475
 
2212
 
    def network_name(self):
2213
 
        return self.get_format_string()
2214
 
 
2215
1476
    def _open(self, transport):
2216
1477
        """See BzrDirFormat._open."""
2217
1478
        return BzrDir4(transport, self)
2223
1484
    repository_format = property(__return_repository_format)
2224
1485
 
2225
1486
 
2226
 
class BzrDirFormatAllInOne(BzrDirFormat):
2227
 
    """Common class for formats before meta-dirs."""
2228
 
 
2229
 
    def initialize_on_transport_ex(self, transport, use_existing_dir=False,
2230
 
        create_prefix=False, force_new_repo=False, stacked_on=None,
2231
 
        stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
2232
 
        shared_repo=False):
2233
 
        """See BzrDirFormat.initialize_on_transport_ex."""
2234
 
        require_stacking = (stacked_on is not None)
2235
 
        # Format 5 cannot stack, but we've been asked to - actually init
2236
 
        # a Meta1Dir
2237
 
        if require_stacking:
2238
 
            format = BzrDirMetaFormat1()
2239
 
            return format.initialize_on_transport_ex(transport,
2240
 
                use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2241
 
                force_new_repo=force_new_repo, stacked_on=stacked_on,
2242
 
                stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2243
 
                make_working_trees=make_working_trees, shared_repo=shared_repo)
2244
 
        return BzrDirFormat.initialize_on_transport_ex(self, transport,
2245
 
            use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2246
 
            force_new_repo=force_new_repo, stacked_on=stacked_on,
2247
 
            stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2248
 
            make_working_trees=make_working_trees, shared_repo=shared_repo)
2249
 
 
2250
 
 
2251
 
class BzrDirFormat5(BzrDirFormatAllInOne):
 
1487
class BzrDirFormat5(BzrDirFormat):
2252
1488
    """Bzr control format 5.
2253
1489
 
2254
1490
    This format is a combined format for working tree, branch and repository.
2255
1491
    It has:
2256
 
     - Format 2 working trees [always]
2257
 
     - Format 4 branches [always]
 
1492
     - Format 2 working trees [always] 
 
1493
     - Format 4 branches [always] 
2258
1494
     - Format 5 repositories [always]
2259
1495
       Unhashed stores in the repository.
2260
1496
    """
2265
1501
        """See BzrDirFormat.get_format_string()."""
2266
1502
        return "Bazaar-NG branch, format 5\n"
2267
1503
 
2268
 
    def get_branch_format(self):
2269
 
        from bzrlib import branch
2270
 
        return branch.BzrBranchFormat4()
2271
 
 
2272
1504
    def get_format_description(self):
2273
1505
        """See BzrDirFormat.get_format_description()."""
2274
1506
        return "All-in-one format 5"
2280
1512
 
2281
1513
    def _initialize_for_clone(self, url):
2282
1514
        return self.initialize_on_transport(get_transport(url), _cloning=True)
2283
 
 
 
1515
        
2284
1516
    def initialize_on_transport(self, transport, _cloning=False):
2285
1517
        """Format 5 dirs always have working tree, branch and repository.
2286
 
 
 
1518
        
2287
1519
        Except when they are being cloned.
2288
1520
        """
2289
1521
        from bzrlib.branch import BzrBranchFormat4
2290
1522
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
 
1523
        from bzrlib.workingtree import WorkingTreeFormat2
2291
1524
        result = (super(BzrDirFormat5, self).initialize_on_transport(transport))
2292
1525
        RepositoryFormat5().initialize(result, _internal=True)
2293
1526
        if not _cloning:
2294
1527
            branch = BzrBranchFormat4().initialize(result)
2295
 
            result._init_workingtree()
 
1528
            try:
 
1529
                WorkingTreeFormat2().initialize(result)
 
1530
            except errors.NotLocalUrl:
 
1531
                # Even though we can't access the working tree, we need to
 
1532
                # create its control files.
 
1533
                WorkingTreeFormat2().stub_initialize_remote(branch.control_files)
2296
1534
        return result
2297
1535
 
2298
 
    def network_name(self):
2299
 
        return self.get_format_string()
2300
 
 
2301
1536
    def _open(self, transport):
2302
1537
        """See BzrDirFormat._open."""
2303
1538
        return BzrDir5(transport, self)
2309
1544
    repository_format = property(__return_repository_format)
2310
1545
 
2311
1546
 
2312
 
class BzrDirFormat6(BzrDirFormatAllInOne):
 
1547
class BzrDirFormat6(BzrDirFormat):
2313
1548
    """Bzr control format 6.
2314
1549
 
2315
1550
    This format is a combined format for working tree, branch and repository.
2316
1551
    It has:
2317
 
     - Format 2 working trees [always]
2318
 
     - Format 4 branches [always]
 
1552
     - Format 2 working trees [always] 
 
1553
     - Format 4 branches [always] 
2319
1554
     - Format 6 repositories [always]
2320
1555
    """
2321
1556
 
2329
1564
        """See BzrDirFormat.get_format_description()."""
2330
1565
        return "All-in-one format 6"
2331
1566
 
2332
 
    def get_branch_format(self):
2333
 
        from bzrlib import branch
2334
 
        return branch.BzrBranchFormat4()
2335
 
 
2336
1567
    def get_converter(self, format=None):
2337
1568
        """See BzrDirFormat.get_converter()."""
2338
1569
        # there is one and only one upgrade path here.
2339
1570
        return ConvertBzrDir6ToMeta()
2340
 
 
 
1571
        
2341
1572
    def _initialize_for_clone(self, url):
2342
1573
        return self.initialize_on_transport(get_transport(url), _cloning=True)
2343
1574
 
2344
1575
    def initialize_on_transport(self, transport, _cloning=False):
2345
1576
        """Format 6 dirs always have working tree, branch and repository.
2346
 
 
 
1577
        
2347
1578
        Except when they are being cloned.
2348
1579
        """
2349
1580
        from bzrlib.branch import BzrBranchFormat4
2350
1581
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
 
1582
        from bzrlib.workingtree import WorkingTreeFormat2
2351
1583
        result = super(BzrDirFormat6, self).initialize_on_transport(transport)
2352
1584
        RepositoryFormat6().initialize(result, _internal=True)
2353
1585
        if not _cloning:
2354
1586
            branch = BzrBranchFormat4().initialize(result)
2355
 
            result._init_workingtree()
 
1587
            try:
 
1588
                WorkingTreeFormat2().initialize(result)
 
1589
            except errors.NotLocalUrl:
 
1590
                # Even though we can't access the working tree, we need to
 
1591
                # create its control files.
 
1592
                WorkingTreeFormat2().stub_initialize_remote(branch.control_files)
2356
1593
        return result
2357
1594
 
2358
 
    def network_name(self):
2359
 
        return self.get_format_string()
2360
 
 
2361
1595
    def _open(self, transport):
2362
1596
        """See BzrDirFormat._open."""
2363
1597
        return BzrDir6(transport, self)
2385
1619
    def __init__(self):
2386
1620
        self._workingtree_format = None
2387
1621
        self._branch_format = None
2388
 
        self._repository_format = None
2389
1622
 
2390
1623
    def __eq__(self, other):
2391
1624
        if other.__class__ is not self.__class__:
2408
1641
    def set_branch_format(self, format):
2409
1642
        self._branch_format = format
2410
1643
 
2411
 
    def require_stacking(self, stack_on=None, possible_transports=None,
2412
 
            _skip_repo=False):
2413
 
        """We have a request to stack, try to ensure the formats support it.
2414
 
 
2415
 
        :param stack_on: If supplied, it is the URL to a branch that we want to
2416
 
            stack on. Check to see if that format supports stacking before
2417
 
            forcing an upgrade.
2418
 
        """
2419
 
        # Stacking is desired. requested by the target, but does the place it
2420
 
        # points at support stacking? If it doesn't then we should
2421
 
        # not implicitly upgrade. We check this here.
2422
 
        new_repo_format = None
2423
 
        new_branch_format = None
2424
 
 
2425
 
        # a bit of state for get_target_branch so that we don't try to open it
2426
 
        # 2 times, for both repo *and* branch
2427
 
        target = [None, False, None] # target_branch, checked, upgrade anyway
2428
 
        def get_target_branch():
2429
 
            if target[1]:
2430
 
                # We've checked, don't check again
2431
 
                return target
2432
 
            if stack_on is None:
2433
 
                # No target format, that means we want to force upgrading
2434
 
                target[:] = [None, True, True]
2435
 
                return target
2436
 
            try:
2437
 
                target_dir = BzrDir.open(stack_on,
2438
 
                    possible_transports=possible_transports)
2439
 
            except errors.NotBranchError:
2440
 
                # Nothing there, don't change formats
2441
 
                target[:] = [None, True, False]
2442
 
                return target
2443
 
            except errors.JailBreak:
2444
 
                # JailBreak, JFDI and upgrade anyway
2445
 
                target[:] = [None, True, True]
2446
 
                return target
2447
 
            try:
2448
 
                target_branch = target_dir.open_branch()
2449
 
            except errors.NotBranchError:
2450
 
                # No branch, don't upgrade formats
2451
 
                target[:] = [None, True, False]
2452
 
                return target
2453
 
            target[:] = [target_branch, True, False]
2454
 
            return target
2455
 
 
2456
 
        if (not _skip_repo and
2457
 
                 not self.repository_format.supports_external_lookups):
2458
 
            # We need to upgrade the Repository.
2459
 
            target_branch, _, do_upgrade = get_target_branch()
2460
 
            if target_branch is None:
2461
 
                # We don't have a target branch, should we upgrade anyway?
2462
 
                if do_upgrade:
2463
 
                    # stack_on is inaccessible, JFDI.
2464
 
                    # TODO: bad monkey, hard-coded formats...
2465
 
                    if self.repository_format.rich_root_data:
2466
 
                        new_repo_format = pack_repo.RepositoryFormatKnitPack5RichRoot()
2467
 
                    else:
2468
 
                        new_repo_format = pack_repo.RepositoryFormatKnitPack5()
2469
 
            else:
2470
 
                # If the target already supports stacking, then we know the
2471
 
                # project is already able to use stacking, so auto-upgrade
2472
 
                # for them
2473
 
                new_repo_format = target_branch.repository._format
2474
 
                if not new_repo_format.supports_external_lookups:
2475
 
                    # target doesn't, source doesn't, so don't auto upgrade
2476
 
                    # repo
2477
 
                    new_repo_format = None
2478
 
            if new_repo_format is not None:
2479
 
                self.repository_format = new_repo_format
2480
 
                note('Source repository format does not support stacking,'
2481
 
                     ' using format:\n  %s',
2482
 
                     new_repo_format.get_format_description())
2483
 
 
2484
 
        if not self.get_branch_format().supports_stacking():
2485
 
            # We just checked the repo, now lets check if we need to
2486
 
            # upgrade the branch format
2487
 
            target_branch, _, do_upgrade = get_target_branch()
2488
 
            if target_branch is None:
2489
 
                if do_upgrade:
2490
 
                    # TODO: bad monkey, hard-coded formats...
2491
 
                    new_branch_format = branch.BzrBranchFormat7()
2492
 
            else:
2493
 
                new_branch_format = target_branch._format
2494
 
                if not new_branch_format.supports_stacking():
2495
 
                    new_branch_format = None
2496
 
            if new_branch_format is not None:
2497
 
                # Does support stacking, use its format.
2498
 
                self.set_branch_format(new_branch_format)
2499
 
                note('Source branch format does not support stacking,'
2500
 
                     ' using format:\n  %s',
2501
 
                     new_branch_format.get_format_description())
2502
 
 
2503
1644
    def get_converter(self, format=None):
2504
1645
        """See BzrDirFormat.get_converter()."""
2505
1646
        if format is None:
2517
1658
        """See BzrDirFormat.get_format_description()."""
2518
1659
        return "Meta directory format 1"
2519
1660
 
2520
 
    def network_name(self):
2521
 
        return self.get_format_string()
2522
 
 
2523
1661
    def _open(self, transport):
2524
1662
        """See BzrDirFormat._open."""
2525
 
        # Create a new format instance because otherwise initialisation of new
2526
 
        # metadirs share the global default format object leading to alias
2527
 
        # problems.
2528
 
        format = BzrDirMetaFormat1()
2529
 
        self._supply_sub_formats_to(format)
2530
 
        return BzrDirMeta1(transport, format)
 
1663
        return BzrDirMeta1(transport, self)
2531
1664
 
2532
1665
    def __return_repository_format(self):
2533
1666
        """Circular import protection."""
2534
 
        if self._repository_format:
 
1667
        if getattr(self, '_repository_format', None):
2535
1668
            return self._repository_format
2536
1669
        from bzrlib.repository import RepositoryFormat
2537
1670
        return RepositoryFormat.get_default_format()
2538
1671
 
2539
 
    def _set_repository_format(self, value):
2540
 
        """Allow changing the repository format for metadir formats."""
 
1672
    def __set_repository_format(self, value):
 
1673
        """Allow changint the repository format for metadir formats."""
2541
1674
        self._repository_format = value
2542
1675
 
2543
 
    repository_format = property(__return_repository_format,
2544
 
        _set_repository_format)
2545
 
 
2546
 
    def _supply_sub_formats_to(self, other_format):
2547
 
        """Give other_format the same values for sub formats as this has.
2548
 
 
2549
 
        This method is expected to be used when parameterising a
2550
 
        RemoteBzrDirFormat instance with the parameters from a
2551
 
        BzrDirMetaFormat1 instance.
2552
 
 
2553
 
        :param other_format: other_format is a format which should be
2554
 
            compatible with whatever sub formats are supported by self.
2555
 
        :return: None.
2556
 
        """
2557
 
        if getattr(self, '_repository_format', None) is not None:
2558
 
            other_format.repository_format = self.repository_format
2559
 
        if self._branch_format is not None:
2560
 
            other_format._branch_format = self._branch_format
2561
 
        if self._workingtree_format is not None:
2562
 
            other_format.workingtree_format = self.workingtree_format
 
1676
    repository_format = property(__return_repository_format, __set_repository_format)
2563
1677
 
2564
1678
    def __get_workingtree_format(self):
2565
1679
        if self._workingtree_format is None:
2574
1688
                                  __set_workingtree_format)
2575
1689
 
2576
1690
 
2577
 
network_format_registry = registry.FormatRegistry()
2578
 
"""Registry of formats indexed by their network name.
2579
 
 
2580
 
The network name for a BzrDirFormat is an identifier that can be used when
2581
 
referring to formats with smart server operations. See
2582
 
BzrDirFormat.network_name() for more detail.
2583
 
"""
2584
 
 
2585
 
 
2586
1691
# Register bzr control format
2587
1692
BzrDirFormat.register_control_format(BzrDirFormat)
2588
1693
 
2595
1700
BzrDirFormat._default_format = __default_format
2596
1701
 
2597
1702
 
 
1703
class BzrDirTestProviderAdapter(object):
 
1704
    """A tool to generate a suite testing multiple bzrdir formats at once.
 
1705
 
 
1706
    This is done by copying the test once for each transport and injecting
 
1707
    the transport_server, transport_readonly_server, and bzrdir_format
 
1708
    classes into each copy. Each copy is also given a new id() to make it
 
1709
    easy to identify.
 
1710
    """
 
1711
 
 
1712
    def __init__(self, vfs_factory, transport_server, transport_readonly_server,
 
1713
        formats):
 
1714
        """Create an object to adapt tests.
 
1715
 
 
1716
        :param vfs_server: A factory to create a Transport Server which has
 
1717
            all the VFS methods working, and is writable.
 
1718
        """
 
1719
        self._vfs_factory = vfs_factory
 
1720
        self._transport_server = transport_server
 
1721
        self._transport_readonly_server = transport_readonly_server
 
1722
        self._formats = formats
 
1723
    
 
1724
    def adapt(self, test):
 
1725
        result = unittest.TestSuite()
 
1726
        for format in self._formats:
 
1727
            new_test = deepcopy(test)
 
1728
            new_test.vfs_transport_factory = self._vfs_factory
 
1729
            new_test.transport_server = self._transport_server
 
1730
            new_test.transport_readonly_server = self._transport_readonly_server
 
1731
            new_test.bzrdir_format = format
 
1732
            def make_new_test_id():
 
1733
                new_id = "%s(%s)" % (new_test.id(), format.__class__.__name__)
 
1734
                return lambda: new_id
 
1735
            new_test.id = make_new_test_id()
 
1736
            result.addTest(new_test)
 
1737
        return result
 
1738
 
 
1739
 
2598
1740
class Converter(object):
2599
1741
    """Converts a disk format object from one format to another."""
2600
1742
 
2620
1762
        self.absent_revisions = set()
2621
1763
        self.text_count = 0
2622
1764
        self.revisions = {}
2623
 
 
 
1765
        
2624
1766
    def convert(self, to_convert, pb):
2625
1767
        """See Converter.convert()."""
2626
1768
        self.bzrdir = to_convert
2627
 
        if pb is not None:
2628
 
            warnings.warn("pb parameter to convert() is deprecated")
2629
 
        self.pb = ui.ui_factory.nested_progress_bar()
2630
 
        try:
2631
 
            ui.ui_factory.note('starting upgrade from format 4 to 5')
2632
 
            if isinstance(self.bzrdir.transport, local.LocalTransport):
2633
 
                self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
2634
 
            self._convert_to_weaves()
2635
 
            return BzrDir.open(self.bzrdir.root_transport.base)
2636
 
        finally:
2637
 
            self.pb.finished()
 
1769
        self.pb = pb
 
1770
        self.pb.note('starting upgrade from format 4 to 5')
 
1771
        if isinstance(self.bzrdir.transport, LocalTransport):
 
1772
            self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
 
1773
        self._convert_to_weaves()
 
1774
        return BzrDir.open(self.bzrdir.root_transport.base)
2638
1775
 
2639
1776
    def _convert_to_weaves(self):
2640
 
        ui.ui_factory.note('note: upgrade may be faster if all store files are ungzipped first')
 
1777
        self.pb.note('note: upgrade may be faster if all store files are ungzipped first')
2641
1778
        try:
2642
1779
            # TODO permissions
2643
1780
            stat = self.bzrdir.transport.stat('weaves')
2671
1808
        self.pb.clear()
2672
1809
        self._write_all_weaves()
2673
1810
        self._write_all_revs()
2674
 
        ui.ui_factory.note('upgraded to weaves:')
2675
 
        ui.ui_factory.note('  %6d revisions and inventories' % len(self.revisions))
2676
 
        ui.ui_factory.note('  %6d revisions not present' % len(self.absent_revisions))
2677
 
        ui.ui_factory.note('  %6d texts' % self.text_count)
 
1811
        self.pb.note('upgraded to weaves:')
 
1812
        self.pb.note('  %6d revisions and inventories', len(self.revisions))
 
1813
        self.pb.note('  %6d revisions not present', len(self.absent_revisions))
 
1814
        self.pb.note('  %6d texts', self.text_count)
2678
1815
        self._cleanup_spare_files_after_format4()
2679
 
        self.branch._transport.put_bytes(
2680
 
            'branch-format',
2681
 
            BzrDirFormat5().get_format_string(),
2682
 
            mode=self.bzrdir._get_file_mode())
 
1816
        self.branch.control_files.put_utf8('branch-format', BzrDirFormat5().get_format_string())
2683
1817
 
2684
1818
    def _cleanup_spare_files_after_format4(self):
2685
1819
        # FIXME working tree upgrade foo.
2694
1828
 
2695
1829
    def _convert_working_inv(self):
2696
1830
        inv = xml4.serializer_v4.read_inventory(
2697
 
                self.branch._transport.get('inventory'))
2698
 
        new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv, working=True)
2699
 
        self.branch._transport.put_bytes('inventory', new_inv_xml,
2700
 
            mode=self.bzrdir._get_file_mode())
 
1831
                    self.branch.control_files.get('inventory'))
 
1832
        new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
 
1833
        # FIXME inventory is a working tree change.
 
1834
        self.branch.control_files.put('inventory', StringIO(new_inv_xml))
2701
1835
 
2702
1836
    def _write_all_weaves(self):
2703
1837
        controlweaves = WeaveStore(self.bzrdir.transport, prefixed=False)
2723
1857
        self.bzrdir.transport.mkdir('revision-store')
2724
1858
        revision_transport = self.bzrdir.transport.clone('revision-store')
2725
1859
        # TODO permissions
2726
 
        from bzrlib.xml5 import serializer_v5
2727
 
        from bzrlib.repofmt.weaverepo import RevisionTextStore
2728
 
        revision_store = RevisionTextStore(revision_transport,
2729
 
            serializer_v5, False, versionedfile.PrefixMapper(),
2730
 
            lambda:True, lambda:True)
 
1860
        _revision_store = TextRevisionStore(TextStore(revision_transport,
 
1861
                                                      prefixed=False,
 
1862
                                                      compressed=True))
2731
1863
        try:
 
1864
            transaction = WriteTransaction()
2732
1865
            for i, rev_id in enumerate(self.converted_revs):
2733
1866
                self.pb.update('write revision', i, len(self.converted_revs))
2734
 
                text = serializer_v5.write_revision_to_string(
2735
 
                    self.revisions[rev_id])
2736
 
                key = (rev_id,)
2737
 
                revision_store.add_lines(key, None, osutils.split_lines(text))
 
1867
                _revision_store.add_revision(self.revisions[rev_id], transaction)
2738
1868
        finally:
2739
1869
            self.pb.clear()
2740
 
 
 
1870
            
2741
1871
    def _load_one_rev(self, rev_id):
2742
1872
        """Load a revision object into memory.
2743
1873
 
2748
1878
                       len(self.known_revisions))
2749
1879
        if not self.branch.repository.has_revision(rev_id):
2750
1880
            self.pb.clear()
2751
 
            ui.ui_factory.note('revision {%s} not present in branch; '
2752
 
                         'will be converted as a ghost' %
 
1881
            self.pb.note('revision {%s} not present in branch; '
 
1882
                         'will be converted as a ghost',
2753
1883
                         rev_id)
2754
1884
            self.absent_revisions.add(rev_id)
2755
1885
        else:
2756
 
            rev = self.branch.repository.get_revision(rev_id)
 
1886
            rev = self.branch.repository._revision_store.get_revision(rev_id,
 
1887
                self.branch.repository.get_transaction())
2757
1888
            for parent_id in rev.parent_ids:
2758
1889
                self.known_revisions.add(parent_id)
2759
1890
                self.to_read.append(parent_id)
2760
1891
            self.revisions[rev_id] = rev
2761
1892
 
2762
1893
    def _load_old_inventory(self, rev_id):
 
1894
        assert rev_id not in self.converted_revs
2763
1895
        old_inv_xml = self.branch.repository.inventory_store.get(rev_id).read()
2764
1896
        inv = xml4.serializer_v4.read_inventory_from_string(old_inv_xml)
2765
1897
        inv.revision_id = rev_id
2766
1898
        rev = self.revisions[rev_id]
 
1899
        if rev.inventory_sha1:
 
1900
            assert rev.inventory_sha1 == sha_string(old_inv_xml), \
 
1901
                'inventory sha mismatch for {%s}' % rev_id
2767
1902
        return inv
2768
1903
 
2769
1904
    def _load_updated_inventory(self, rev_id):
 
1905
        assert rev_id in self.converted_revs
2770
1906
        inv_xml = self.inv_weave.get_text(rev_id)
2771
 
        inv = xml5.serializer_v5.read_inventory_from_string(inv_xml, rev_id)
 
1907
        inv = xml5.serializer_v5.read_inventory_from_string(inv_xml)
2772
1908
        return inv
2773
1909
 
2774
1910
    def _convert_one_rev(self, rev_id):
2778
1914
        present_parents = [p for p in rev.parent_ids
2779
1915
                           if p not in self.absent_revisions]
2780
1916
        self._convert_revision_contents(rev, inv, present_parents)
2781
 
        self._store_new_inv(rev, inv, present_parents)
 
1917
        self._store_new_weave(rev, inv, present_parents)
2782
1918
        self.converted_revs.add(rev_id)
2783
1919
 
2784
 
    def _store_new_inv(self, rev, inv, present_parents):
 
1920
    def _store_new_weave(self, rev, inv, present_parents):
 
1921
        # the XML is now updated with text versions
 
1922
        if __debug__:
 
1923
            entries = inv.iter_entries()
 
1924
            entries.next()
 
1925
            for path, ie in entries:
 
1926
                assert getattr(ie, 'revision', None) is not None, \
 
1927
                    'no revision on {%s} in {%s}' % \
 
1928
                    (file_id, rev.revision_id)
2785
1929
        new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
2786
1930
        new_inv_sha1 = sha_string(new_inv_xml)
2787
 
        self.inv_weave.add_lines(rev.revision_id,
 
1931
        self.inv_weave.add_lines(rev.revision_id, 
2788
1932
                                 present_parents,
2789
1933
                                 new_inv_xml.splitlines(True))
2790
1934
        rev.inventory_sha1 = new_inv_sha1
2815
1959
            w = Weave(file_id)
2816
1960
            self.text_weaves[file_id] = w
2817
1961
        text_changed = False
2818
 
        parent_candiate_entries = ie.parent_candidates(parent_invs)
2819
 
        heads = graph.Graph(self).heads(parent_candiate_entries.keys())
2820
 
        # XXX: Note that this is unordered - and this is tolerable because
2821
 
        # the previous code was also unordered.
2822
 
        previous_entries = dict((head, parent_candiate_entries[head]) for head
2823
 
            in heads)
 
1962
        previous_entries = ie.find_previous_heads(parent_invs,
 
1963
                                                  None,
 
1964
                                                  None,
 
1965
                                                  entry_vf=w)
 
1966
        for old_revision in previous_entries:
 
1967
                # if this fails, its a ghost ?
 
1968
                assert old_revision in self.converted_revs, \
 
1969
                    "Revision {%s} not in converted_revs" % old_revision
2824
1970
        self.snapshot_ie(previous_entries, ie, w, rev_id)
2825
1971
        del ie.text_id
2826
 
 
2827
 
    def get_parent_map(self, revision_ids):
2828
 
        """See graph.StackedParentsProvider.get_parent_map"""
2829
 
        return dict((revision_id, self.revisions[revision_id])
2830
 
                    for revision_id in revision_ids
2831
 
                     if revision_id in self.revisions)
 
1972
        assert getattr(ie, 'revision', None) is not None
2832
1973
 
2833
1974
    def snapshot_ie(self, previous_revisions, ie, w, rev_id):
2834
1975
        # TODO: convert this logic, which is ~= snapshot to
2835
1976
        # a call to:. This needs the path figured out. rather than a work_tree
2836
1977
        # a v4 revision_tree can be given, or something that looks enough like
2837
1978
        # one to give the file content to the entry if it needs it.
2838
 
        # and we need something that looks like a weave store for snapshot to
 
1979
        # and we need something that looks like a weave store for snapshot to 
2839
1980
        # save against.
2840
1981
        #ie.snapshot(rev, PATH, previous_revisions, REVISION_TREE, InMemoryWeaveStore(self.text_weaves))
2841
1982
        if len(previous_revisions) == 1:
2844
1985
                ie.revision = previous_ie.revision
2845
1986
                return
2846
1987
        if ie.has_text():
2847
 
            text = self.branch.repository._text_store.get(ie.text_id)
 
1988
            text = self.branch.repository.text_store.get(ie.text_id)
2848
1989
            file_lines = text.readlines()
 
1990
            assert sha_strings(file_lines) == ie.text_sha1
 
1991
            assert sum(map(len, file_lines)) == ie.text_size
2849
1992
            w.add_lines(rev_id, previous_revisions, file_lines)
2850
1993
            self.text_count += 1
2851
1994
        else:
2881
2024
    def convert(self, to_convert, pb):
2882
2025
        """See Converter.convert()."""
2883
2026
        self.bzrdir = to_convert
2884
 
        pb = ui.ui_factory.nested_progress_bar()
2885
 
        try:
2886
 
            ui.ui_factory.note('starting upgrade from format 5 to 6')
2887
 
            self._convert_to_prefixed()
2888
 
            return BzrDir.open(self.bzrdir.root_transport.base)
2889
 
        finally:
2890
 
            pb.finished()
 
2027
        self.pb = pb
 
2028
        self.pb.note('starting upgrade from format 5 to 6')
 
2029
        self._convert_to_prefixed()
 
2030
        return BzrDir.open(self.bzrdir.root_transport.base)
2891
2031
 
2892
2032
    def _convert_to_prefixed(self):
2893
2033
        from bzrlib.store import TransportStore
2894
2034
        self.bzrdir.transport.delete('branch-format')
2895
2035
        for store_name in ["weaves", "revision-store"]:
2896
 
            ui.ui_factory.note("adding prefixes to %s" % store_name)
 
2036
            self.pb.note("adding prefixes to %s" % store_name)
2897
2037
            store_transport = self.bzrdir.transport.clone(store_name)
2898
2038
            store = TransportStore(store_transport, prefixed=True)
2899
2039
            for urlfilename in store_transport.list_dir('.'):
2901
2041
                if (filename.endswith(".weave") or
2902
2042
                    filename.endswith(".gz") or
2903
2043
                    filename.endswith(".sig")):
2904
 
                    file_id, suffix = os.path.splitext(filename)
 
2044
                    file_id = os.path.splitext(filename)[0]
2905
2045
                else:
2906
2046
                    file_id = filename
2907
 
                    suffix = ''
2908
 
                new_name = store._mapper.map((file_id,)) + suffix
 
2047
                prefix_dir = store.hash_prefix(file_id)
2909
2048
                # FIXME keep track of the dirs made RBC 20060121
2910
2049
                try:
2911
 
                    store_transport.move(filename, new_name)
 
2050
                    store_transport.move(filename, prefix_dir + '/' + filename)
2912
2051
                except errors.NoSuchFile: # catches missing dirs strangely enough
2913
 
                    store_transport.mkdir(osutils.dirname(new_name))
2914
 
                    store_transport.move(filename, new_name)
2915
 
        self.bzrdir.transport.put_bytes(
2916
 
            'branch-format',
2917
 
            BzrDirFormat6().get_format_string(),
2918
 
            mode=self.bzrdir._get_file_mode())
 
2052
                    store_transport.mkdir(prefix_dir)
 
2053
                    store_transport.move(filename, prefix_dir + '/' + filename)
 
2054
        self.bzrdir._control_files.put_utf8('branch-format', BzrDirFormat6().get_format_string())
2919
2055
 
2920
2056
 
2921
2057
class ConvertBzrDir6ToMeta(Converter):
2926
2062
        from bzrlib.repofmt.weaverepo import RepositoryFormat7
2927
2063
        from bzrlib.branch import BzrBranchFormat5
2928
2064
        self.bzrdir = to_convert
2929
 
        self.pb = ui.ui_factory.nested_progress_bar()
 
2065
        self.pb = pb
2930
2066
        self.count = 0
2931
2067
        self.total = 20 # the steps we know about
2932
2068
        self.garbage_inventories = []
2933
 
        self.dir_mode = self.bzrdir._get_dir_mode()
2934
 
        self.file_mode = self.bzrdir._get_file_mode()
2935
2069
 
2936
 
        ui.ui_factory.note('starting upgrade from format 6 to metadir')
2937
 
        self.bzrdir.transport.put_bytes(
2938
 
                'branch-format',
2939
 
                "Converting to format 6",
2940
 
                mode=self.file_mode)
 
2070
        self.pb.note('starting upgrade from format 6 to metadir')
 
2071
        self.bzrdir._control_files.put_utf8('branch-format', "Converting to format 6")
2941
2072
        # its faster to move specific files around than to open and use the apis...
2942
2073
        # first off, nuke ancestry.weave, it was never used.
2943
2074
        try:
2953
2084
            if name.startswith('basis-inventory.'):
2954
2085
                self.garbage_inventories.append(name)
2955
2086
        # create new directories for repository, working tree and branch
 
2087
        self.dir_mode = self.bzrdir._control_files._dir_mode
 
2088
        self.file_mode = self.bzrdir._control_files._file_mode
2956
2089
        repository_names = [('inventory.weave', True),
2957
2090
                            ('revision-store', True),
2958
2091
                            ('weaves', True)]
2960
2093
        self.bzrdir.transport.mkdir('repository', mode=self.dir_mode)
2961
2094
        self.make_lock('repository')
2962
2095
        # we hard code the formats here because we are converting into
2963
 
        # the meta format. The meta format upgrader can take this to a
 
2096
        # the meta format. The meta format upgrader can take this to a 
2964
2097
        # future format within each component.
2965
2098
        self.put_format('repository', RepositoryFormat7())
2966
2099
        for entry in repository_names:
2989
2122
        else:
2990
2123
            has_checkout = True
2991
2124
        if not has_checkout:
2992
 
            ui.ui_factory.note('No working tree.')
 
2125
            self.pb.note('No working tree.')
2993
2126
            # If some checkout files are there, we may as well get rid of them.
2994
2127
            for name, mandatory in checkout_files:
2995
2128
                if name in bzrcontents:
3006
2139
            for entry in checkout_files:
3007
2140
                self.move_entry('checkout', entry)
3008
2141
            if last_revision is not None:
3009
 
                self.bzrdir.transport.put_bytes(
 
2142
                self.bzrdir._control_files.put_utf8(
3010
2143
                    'checkout/last-revision', last_revision)
3011
 
        self.bzrdir.transport.put_bytes(
3012
 
            'branch-format',
3013
 
            BzrDirMetaFormat1().get_format_string(),
3014
 
            mode=self.file_mode)
3015
 
        self.pb.finished()
 
2144
        self.bzrdir._control_files.put_utf8(
 
2145
            'branch-format', BzrDirMetaFormat1().get_format_string())
3016
2146
        return BzrDir.open(self.bzrdir.root_transport.base)
3017
2147
 
3018
2148
    def make_lock(self, name):
3036
2166
                raise
3037
2167
 
3038
2168
    def put_format(self, dirname, format):
3039
 
        self.bzrdir.transport.put_bytes('%s/format' % dirname,
3040
 
            format.get_format_string(),
3041
 
            self.file_mode)
 
2169
        self.bzrdir._control_files.put_utf8('%s/format' % dirname, format.get_format_string())
3042
2170
 
3043
2171
 
3044
2172
class ConvertMetaToMeta(Converter):
3054
2182
    def convert(self, to_convert, pb):
3055
2183
        """See Converter.convert()."""
3056
2184
        self.bzrdir = to_convert
3057
 
        self.pb = ui.ui_factory.nested_progress_bar()
 
2185
        self.pb = pb
3058
2186
        self.count = 0
3059
2187
        self.total = 1
3060
2188
        self.step('checking repository format')
3065
2193
        else:
3066
2194
            if not isinstance(repo._format, self.target_format.repository_format.__class__):
3067
2195
                from bzrlib.repository import CopyConverter
3068
 
                ui.ui_factory.note('starting repository conversion')
 
2196
                self.pb.note('starting repository conversion')
3069
2197
                converter = CopyConverter(self.target_format.repository_format)
3070
2198
                converter.convert(repo, pb)
3071
 
        for branch in self.bzrdir.list_branches():
 
2199
        try:
 
2200
            branch = self.bzrdir.open_branch()
 
2201
        except errors.NotBranchError:
 
2202
            pass
 
2203
        else:
3072
2204
            # TODO: conversions of Branch and Tree should be done by
3073
 
            # InterXFormat lookups/some sort of registry.
 
2205
            # InterXFormat lookups
3074
2206
            # Avoid circular imports
3075
2207
            from bzrlib import branch as _mod_branch
3076
 
            old = branch._format.__class__
3077
 
            new = self.target_format.get_branch_format().__class__
3078
 
            while old != new:
3079
 
                if (old == _mod_branch.BzrBranchFormat5 and
3080
 
                    new in (_mod_branch.BzrBranchFormat6,
3081
 
                        _mod_branch.BzrBranchFormat7,
3082
 
                        _mod_branch.BzrBranchFormat8)):
3083
 
                    branch_converter = _mod_branch.Converter5to6()
3084
 
                elif (old == _mod_branch.BzrBranchFormat6 and
3085
 
                    new in (_mod_branch.BzrBranchFormat7,
3086
 
                            _mod_branch.BzrBranchFormat8)):
3087
 
                    branch_converter = _mod_branch.Converter6to7()
3088
 
                elif (old == _mod_branch.BzrBranchFormat7 and
3089
 
                      new is _mod_branch.BzrBranchFormat8):
3090
 
                    branch_converter = _mod_branch.Converter7to8()
3091
 
                else:
3092
 
                    raise errors.BadConversionTarget("No converter", new,
3093
 
                        branch._format)
 
2208
            if (branch._format.__class__ is _mod_branch.BzrBranchFormat5 and
 
2209
                self.target_format.get_branch_format().__class__ is
 
2210
                _mod_branch.BzrBranchFormat6):
 
2211
                branch_converter = _mod_branch.Converter5to6()
3094
2212
                branch_converter.convert(branch)
3095
 
                branch = self.bzrdir.open_branch()
3096
 
                old = branch._format.__class__
3097
2213
        try:
3098
2214
            tree = self.bzrdir.open_workingtree(recommend_upgrade=False)
3099
2215
        except (errors.NoWorkingTree, errors.NotLocalUrl):
3102
2218
            # TODO: conversions of Branch and Tree should be done by
3103
2219
            # InterXFormat lookups
3104
2220
            if (isinstance(tree, workingtree.WorkingTree3) and
3105
 
                not isinstance(tree, workingtree_4.DirStateWorkingTree) and
 
2221
                not isinstance(tree, workingtree_4.WorkingTree4) and
3106
2222
                isinstance(self.target_format.workingtree_format,
3107
 
                    workingtree_4.DirStateWorkingTreeFormat)):
 
2223
                    workingtree_4.WorkingTreeFormat4)):
3108
2224
                workingtree_4.Converter3to4().convert(tree)
3109
 
            if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
3110
 
                not isinstance(tree, workingtree_4.WorkingTree5) and
3111
 
                isinstance(self.target_format.workingtree_format,
3112
 
                    workingtree_4.WorkingTreeFormat5)):
3113
 
                workingtree_4.Converter4to5().convert(tree)
3114
 
            if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
3115
 
                not isinstance(tree, workingtree_4.WorkingTree6) and
3116
 
                isinstance(self.target_format.workingtree_format,
3117
 
                    workingtree_4.WorkingTreeFormat6)):
3118
 
                workingtree_4.Converter4or5to6().convert(tree)
3119
 
        self.pb.finished()
3120
2225
        return to_convert
3121
2226
 
3122
2227
 
3123
 
# This is not in remote.py because it's relatively small, and needs to be
3124
 
# registered. Putting it in remote.py creates a circular import problem.
 
2228
# This is not in remote.py because it's small, and needs to be registered.
 
2229
# Putting it in remote.py creates a circular import problem.
3125
2230
# we can make it a lazy object if the control formats is turned into something
3126
2231
# like a registry.
3127
2232
class RemoteBzrDirFormat(BzrDirMetaFormat1):
3128
2233
    """Format representing bzrdirs accessed via a smart server"""
3129
2234
 
3130
 
    def __init__(self):
3131
 
        BzrDirMetaFormat1.__init__(self)
3132
 
        # XXX: It's a bit ugly that the network name is here, because we'd
3133
 
        # like to believe that format objects are stateless or at least
3134
 
        # immutable,  However, we do at least avoid mutating the name after
3135
 
        # it's returned.  See <https://bugs.edge.launchpad.net/bzr/+bug/504102>
3136
 
        self._network_name = None
3137
 
 
3138
 
    def __repr__(self):
3139
 
        return "%s(_network_name=%r)" % (self.__class__.__name__,
3140
 
            self._network_name)
3141
 
 
3142
2235
    def get_format_description(self):
3143
 
        if self._network_name:
3144
 
            real_format = network_format_registry.get(self._network_name)
3145
 
            return 'Remote: ' + real_format.get_format_description()
3146
2236
        return 'bzr remote bzrdir'
3147
 
 
3148
 
    def get_format_string(self):
3149
 
        raise NotImplementedError(self.get_format_string)
3150
 
 
3151
 
    def network_name(self):
3152
 
        if self._network_name:
3153
 
            return self._network_name
3154
 
        else:
3155
 
            raise AssertionError("No network name set.")
3156
 
 
 
2237
    
3157
2238
    @classmethod
3158
2239
    def probe_transport(klass, transport):
3159
2240
        """Return a RemoteBzrDirFormat object if it looks possible."""
3160
2241
        try:
3161
 
            medium = transport.get_smart_medium()
 
2242
            client = transport.get_smart_client()
3162
2243
        except (NotImplementedError, AttributeError,
3163
 
                errors.TransportNotPossible, errors.NoSmartMedium,
3164
 
                errors.SmartProtocolError):
 
2244
                errors.TransportNotPossible):
3165
2245
            # no smart server, so not a branch for this format type.
3166
2246
            raise errors.NotBranchError(path=transport.base)
3167
2247
        else:
3168
 
            # Decline to open it if the server doesn't support our required
3169
 
            # version (3) so that the VFS-based transport will do it.
3170
 
            if medium.should_probe():
3171
 
                try:
3172
 
                    server_version = medium.protocol_version()
3173
 
                except errors.SmartProtocolError:
3174
 
                    # Apparently there's no usable smart server there, even though
3175
 
                    # the medium supports the smart protocol.
3176
 
                    raise errors.NotBranchError(path=transport.base)
3177
 
                if server_version != '2':
3178
 
                    raise errors.NotBranchError(path=transport.base)
 
2248
            # Send a 'hello' request in protocol version one, and decline to
 
2249
            # open it if the server doesn't support our required version (2) so
 
2250
            # that the VFS-based transport will do it.
 
2251
            request = client.get_request()
 
2252
            smart_protocol = protocol.SmartClientRequestProtocolOne(request)
 
2253
            server_version = smart_protocol.query_version()
 
2254
            if server_version != 2:
 
2255
                raise errors.NotBranchError(path=transport.base)
3179
2256
            return klass()
3180
2257
 
3181
2258
    def initialize_on_transport(self, transport):
3182
2259
        try:
3183
2260
            # hand off the request to the smart server
3184
 
            client_medium = transport.get_smart_medium()
 
2261
            medium = transport.get_smart_medium()
3185
2262
        except errors.NoSmartMedium:
3186
2263
            # TODO: lookup the local format from a server hint.
3187
2264
            local_dir_format = BzrDirMetaFormat1()
3188
2265
            return local_dir_format.initialize_on_transport(transport)
3189
 
        client = _SmartClient(client_medium)
 
2266
        client = _SmartClient(medium)
3190
2267
        path = client.remote_path_from_transport(transport)
3191
 
        try:
3192
 
            response = client.call('BzrDirFormat.initialize', path)
3193
 
        except errors.ErrorFromSmartServer, err:
3194
 
            remote._translate_error(err, path=path)
3195
 
        if response[0] != 'ok':
3196
 
            raise errors.SmartProtocolError('unexpected response code %s' % (response,))
3197
 
        format = RemoteBzrDirFormat()
3198
 
        self._supply_sub_formats_to(format)
3199
 
        return remote.RemoteBzrDir(transport, format)
3200
 
 
3201
 
    def parse_NoneTrueFalse(self, arg):
3202
 
        if not arg:
3203
 
            return None
3204
 
        if arg == 'False':
3205
 
            return False
3206
 
        if arg == 'True':
3207
 
            return True
3208
 
        raise AssertionError("invalid arg %r" % arg)
3209
 
 
3210
 
    def _serialize_NoneTrueFalse(self, arg):
3211
 
        if arg is False:
3212
 
            return 'False'
3213
 
        if arg:
3214
 
            return 'True'
3215
 
        return ''
3216
 
 
3217
 
    def _serialize_NoneString(self, arg):
3218
 
        return arg or ''
3219
 
 
3220
 
    def initialize_on_transport_ex(self, transport, use_existing_dir=False,
3221
 
        create_prefix=False, force_new_repo=False, stacked_on=None,
3222
 
        stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
3223
 
        shared_repo=False):
3224
 
        try:
3225
 
            # hand off the request to the smart server
3226
 
            client_medium = transport.get_smart_medium()
3227
 
        except errors.NoSmartMedium:
3228
 
            do_vfs = True
3229
 
        else:
3230
 
            # Decline to open it if the server doesn't support our required
3231
 
            # version (3) so that the VFS-based transport will do it.
3232
 
            if client_medium.should_probe():
3233
 
                try:
3234
 
                    server_version = client_medium.protocol_version()
3235
 
                    if server_version != '2':
3236
 
                        do_vfs = True
3237
 
                    else:
3238
 
                        do_vfs = False
3239
 
                except errors.SmartProtocolError:
3240
 
                    # Apparently there's no usable smart server there, even though
3241
 
                    # the medium supports the smart protocol.
3242
 
                    do_vfs = True
3243
 
            else:
3244
 
                do_vfs = False
3245
 
        if not do_vfs:
3246
 
            client = _SmartClient(client_medium)
3247
 
            path = client.remote_path_from_transport(transport)
3248
 
            if client_medium._is_remote_before((1, 16)):
3249
 
                do_vfs = True
3250
 
        if do_vfs:
3251
 
            # TODO: lookup the local format from a server hint.
3252
 
            local_dir_format = BzrDirMetaFormat1()
3253
 
            self._supply_sub_formats_to(local_dir_format)
3254
 
            return local_dir_format.initialize_on_transport_ex(transport,
3255
 
                use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3256
 
                force_new_repo=force_new_repo, stacked_on=stacked_on,
3257
 
                stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3258
 
                make_working_trees=make_working_trees, shared_repo=shared_repo,
3259
 
                vfs_only=True)
3260
 
        return self._initialize_on_transport_ex_rpc(client, path, transport,
3261
 
            use_existing_dir, create_prefix, force_new_repo, stacked_on,
3262
 
            stack_on_pwd, repo_format_name, make_working_trees, shared_repo)
3263
 
 
3264
 
    def _initialize_on_transport_ex_rpc(self, client, path, transport,
3265
 
        use_existing_dir, create_prefix, force_new_repo, stacked_on,
3266
 
        stack_on_pwd, repo_format_name, make_working_trees, shared_repo):
3267
 
        args = []
3268
 
        args.append(self._serialize_NoneTrueFalse(use_existing_dir))
3269
 
        args.append(self._serialize_NoneTrueFalse(create_prefix))
3270
 
        args.append(self._serialize_NoneTrueFalse(force_new_repo))
3271
 
        args.append(self._serialize_NoneString(stacked_on))
3272
 
        # stack_on_pwd is often/usually our transport
3273
 
        if stack_on_pwd:
3274
 
            try:
3275
 
                stack_on_pwd = transport.relpath(stack_on_pwd)
3276
 
                if not stack_on_pwd:
3277
 
                    stack_on_pwd = '.'
3278
 
            except errors.PathNotChild:
3279
 
                pass
3280
 
        args.append(self._serialize_NoneString(stack_on_pwd))
3281
 
        args.append(self._serialize_NoneString(repo_format_name))
3282
 
        args.append(self._serialize_NoneTrueFalse(make_working_trees))
3283
 
        args.append(self._serialize_NoneTrueFalse(shared_repo))
3284
 
        request_network_name = self._network_name or \
3285
 
            BzrDirFormat.get_default_format().network_name()
3286
 
        try:
3287
 
            response = client.call('BzrDirFormat.initialize_ex_1.16',
3288
 
                request_network_name, path, *args)
3289
 
        except errors.UnknownSmartMethod:
3290
 
            client._medium._remember_remote_is_before((1,16))
3291
 
            local_dir_format = BzrDirMetaFormat1()
3292
 
            self._supply_sub_formats_to(local_dir_format)
3293
 
            return local_dir_format.initialize_on_transport_ex(transport,
3294
 
                use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3295
 
                force_new_repo=force_new_repo, stacked_on=stacked_on,
3296
 
                stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3297
 
                make_working_trees=make_working_trees, shared_repo=shared_repo,
3298
 
                vfs_only=True)
3299
 
        except errors.ErrorFromSmartServer, err:
3300
 
            remote._translate_error(err, path=path)
3301
 
        repo_path = response[0]
3302
 
        bzrdir_name = response[6]
3303
 
        require_stacking = response[7]
3304
 
        require_stacking = self.parse_NoneTrueFalse(require_stacking)
3305
 
        format = RemoteBzrDirFormat()
3306
 
        format._network_name = bzrdir_name
3307
 
        self._supply_sub_formats_to(format)
3308
 
        bzrdir = remote.RemoteBzrDir(transport, format, _client=client)
3309
 
        if repo_path:
3310
 
            repo_format = remote.response_tuple_to_repo_format(response[1:])
3311
 
            if repo_path == '.':
3312
 
                repo_path = ''
3313
 
            if repo_path:
3314
 
                repo_bzrdir_format = RemoteBzrDirFormat()
3315
 
                repo_bzrdir_format._network_name = response[5]
3316
 
                repo_bzr = remote.RemoteBzrDir(transport.clone(repo_path),
3317
 
                    repo_bzrdir_format)
3318
 
            else:
3319
 
                repo_bzr = bzrdir
3320
 
            final_stack = response[8] or None
3321
 
            final_stack_pwd = response[9] or None
3322
 
            if final_stack_pwd:
3323
 
                final_stack_pwd = urlutils.join(
3324
 
                    transport.base, final_stack_pwd)
3325
 
            remote_repo = remote.RemoteRepository(repo_bzr, repo_format)
3326
 
            if len(response) > 10:
3327
 
                # Updated server verb that locks remotely.
3328
 
                repo_lock_token = response[10] or None
3329
 
                remote_repo.lock_write(repo_lock_token, _skip_rpc=True)
3330
 
                if repo_lock_token:
3331
 
                    remote_repo.dont_leave_lock_in_place()
3332
 
            else:
3333
 
                remote_repo.lock_write()
3334
 
            policy = UseExistingRepository(remote_repo, final_stack,
3335
 
                final_stack_pwd, require_stacking)
3336
 
            policy.acquire_repository()
3337
 
        else:
3338
 
            remote_repo = None
3339
 
            policy = None
3340
 
        bzrdir._format.set_branch_format(self.get_branch_format())
3341
 
        if require_stacking:
3342
 
            # The repo has already been created, but we need to make sure that
3343
 
            # we'll make a stackable branch.
3344
 
            bzrdir._format.require_stacking(_skip_repo=True)
3345
 
        return remote_repo, bzrdir, require_stacking, policy
 
2268
        response = _SmartClient(medium).call('BzrDirFormat.initialize', path)
 
2269
        assert response[0] in ('ok', ), 'unexpected response code %s' % (response,)
 
2270
        return remote.RemoteBzrDir(transport)
3346
2271
 
3347
2272
    def _open(self, transport):
3348
 
        return remote.RemoteBzrDir(transport, self)
 
2273
        return remote.RemoteBzrDir(transport)
3349
2274
 
3350
2275
    def __eq__(self, other):
3351
2276
        if not isinstance(other, RemoteBzrDirFormat):
3352
2277
            return False
3353
2278
        return self.get_format_description() == other.get_format_description()
3354
2279
 
3355
 
    def __return_repository_format(self):
3356
 
        # Always return a RemoteRepositoryFormat object, but if a specific bzr
3357
 
        # repository format has been asked for, tell the RemoteRepositoryFormat
3358
 
        # that it should use that for init() etc.
3359
 
        result = remote.RemoteRepositoryFormat()
3360
 
        custom_format = getattr(self, '_repository_format', None)
3361
 
        if custom_format:
3362
 
            if isinstance(custom_format, remote.RemoteRepositoryFormat):
3363
 
                return custom_format
3364
 
            else:
3365
 
                # We will use the custom format to create repositories over the
3366
 
                # wire; expose its details like rich_root_data for code to
3367
 
                # query
3368
 
                result._custom_format = custom_format
3369
 
        return result
3370
 
 
3371
 
    def get_branch_format(self):
3372
 
        result = BzrDirMetaFormat1.get_branch_format(self)
3373
 
        if not isinstance(result, remote.RemoteBranchFormat):
3374
 
            new_result = remote.RemoteBranchFormat()
3375
 
            new_result._custom_format = result
3376
 
            # cache the result
3377
 
            self.set_branch_format(new_result)
3378
 
            result = new_result
3379
 
        return result
3380
 
 
3381
 
    repository_format = property(__return_repository_format,
3382
 
        BzrDirMetaFormat1._set_repository_format) #.im_func)
3383
 
 
3384
2280
 
3385
2281
BzrDirFormat.register_control_server_format(RemoteBzrDirFormat)
3386
2282
 
3387
2283
 
3388
2284
class BzrDirFormatInfo(object):
3389
2285
 
3390
 
    def __init__(self, native, deprecated, hidden, experimental):
 
2286
    def __init__(self, native, deprecated, hidden):
3391
2287
        self.deprecated = deprecated
3392
2288
        self.native = native
3393
2289
        self.hidden = hidden
3394
 
        self.experimental = experimental
3395
2290
 
3396
2291
 
3397
2292
class BzrDirFormatRegistry(registry.Registry):
3398
2293
    """Registry of user-selectable BzrDir subformats.
3399
 
 
 
2294
    
3400
2295
    Differs from BzrDirFormat._control_formats in that it provides sub-formats,
3401
2296
    e.g. BzrDirMeta1 with weave repository.  Also, it's more user-oriented.
3402
2297
    """
3403
2298
 
3404
 
    def __init__(self):
3405
 
        """Create a BzrDirFormatRegistry."""
3406
 
        self._aliases = set()
3407
 
        self._registration_order = list()
3408
 
        super(BzrDirFormatRegistry, self).__init__()
3409
 
 
3410
 
    def aliases(self):
3411
 
        """Return a set of the format names which are aliases."""
3412
 
        return frozenset(self._aliases)
3413
 
 
3414
2299
    def register_metadir(self, key,
3415
2300
             repository_format, help, native=True, deprecated=False,
3416
2301
             branch_format=None,
3417
2302
             tree_format=None,
3418
 
             hidden=False,
3419
 
             experimental=False,
3420
 
             alias=False):
 
2303
             hidden=False):
3421
2304
        """Register a metadir subformat.
3422
2305
 
3423
2306
        These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
3424
 
        by the Repository/Branch/WorkingTreeformats.
 
2307
        by the Repository format.
3425
2308
 
3426
2309
        :param repository_format: The fully-qualified repository format class
3427
2310
            name as a string.
3455
2338
            if repository_format is not None:
3456
2339
                bd.repository_format = _load(repository_format)
3457
2340
            return bd
3458
 
        self.register(key, helper, help, native, deprecated, hidden,
3459
 
            experimental, alias)
 
2341
        self.register(key, helper, help, native, deprecated, hidden)
3460
2342
 
3461
2343
    def register(self, key, factory, help, native=True, deprecated=False,
3462
 
                 hidden=False, experimental=False, alias=False):
 
2344
                 hidden=False):
3463
2345
        """Register a BzrDirFormat factory.
3464
 
 
 
2346
        
3465
2347
        The factory must be a callable that takes one parameter: the key.
3466
2348
        It must produce an instance of the BzrDirFormat when called.
3467
2349
 
3468
2350
        This function mainly exists to prevent the info object from being
3469
2351
        supplied directly.
3470
2352
        """
3471
 
        registry.Registry.register(self, key, factory, help,
3472
 
            BzrDirFormatInfo(native, deprecated, hidden, experimental))
3473
 
        if alias:
3474
 
            self._aliases.add(key)
3475
 
        self._registration_order.append(key)
 
2353
        registry.Registry.register(self, key, factory, help, 
 
2354
            BzrDirFormatInfo(native, deprecated, hidden))
3476
2355
 
3477
2356
    def register_lazy(self, key, module_name, member_name, help, native=True,
3478
 
        deprecated=False, hidden=False, experimental=False, alias=False):
3479
 
        registry.Registry.register_lazy(self, key, module_name, member_name,
3480
 
            help, BzrDirFormatInfo(native, deprecated, hidden, experimental))
3481
 
        if alias:
3482
 
            self._aliases.add(key)
3483
 
        self._registration_order.append(key)
 
2357
                      deprecated=False, hidden=False):
 
2358
        registry.Registry.register_lazy(self, key, module_name, member_name, 
 
2359
            help, BzrDirFormatInfo(native, deprecated, hidden))
3484
2360
 
3485
2361
    def set_default(self, key):
3486
2362
        """Set the 'default' key to be a clone of the supplied key.
3487
 
 
 
2363
        
3488
2364
        This method must be called once and only once.
3489
2365
        """
3490
 
        registry.Registry.register(self, 'default', self.get(key),
 
2366
        registry.Registry.register(self, 'default', self.get(key), 
3491
2367
            self.get_help(key), info=self.get_info(key))
3492
 
        self._aliases.add('default')
3493
2368
 
3494
2369
    def set_default_repository(self, key):
3495
2370
        """Set the FormatRegistry default and Repository default.
3496
 
 
 
2371
        
3497
2372
        This is a transitional method while Repository.set_default_format
3498
2373
        is deprecated.
3499
2374
        """
3501
2376
            self.remove('default')
3502
2377
        self.set_default(key)
3503
2378
        format = self.get('default')()
 
2379
        assert isinstance(format, BzrDirMetaFormat1)
3504
2380
 
3505
2381
    def make_bzrdir(self, key):
3506
2382
        return self.get(key)()
3507
2383
 
3508
2384
    def help_topic(self, topic):
3509
 
        output = ""
3510
 
        default_realkey = None
 
2385
        output = textwrap.dedent("""\
 
2386
            Bazaar directory formats
 
2387
            ------------------------
 
2388
 
 
2389
            These formats can be used for creating branches, working trees, and
 
2390
            repositories.
 
2391
 
 
2392
            """)
3511
2393
        default_help = self.get_help('default')
3512
2394
        help_pairs = []
3513
 
        for key in self._registration_order:
 
2395
        for key in self.keys():
3514
2396
            if key == 'default':
3515
2397
                continue
3516
2398
            help = self.get_help(key)
3522
2404
        def wrapped(key, help, info):
3523
2405
            if info.native:
3524
2406
                help = '(native) ' + help
3525
 
            return ':%s:\n%s\n\n' % (key,
3526
 
                textwrap.fill(help, initial_indent='    ',
3527
 
                    subsequent_indent='    ',
3528
 
                    break_long_words=False))
3529
 
        if default_realkey is not None:
3530
 
            output += wrapped(default_realkey, '(default) %s' % default_help,
3531
 
                              self.get_info('default'))
 
2407
            return '  %s:\n%s\n\n' % (key, 
 
2408
                    textwrap.fill(help, initial_indent='    ', 
 
2409
                    subsequent_indent='    '))
 
2410
        output += wrapped('%s/default' % default_realkey, default_help,
 
2411
                          self.get_info('default'))
3532
2412
        deprecated_pairs = []
3533
 
        experimental_pairs = []
3534
2413
        for key, help in help_pairs:
3535
2414
            info = self.get_info(key)
3536
2415
            if info.hidden:
3537
2416
                continue
3538
2417
            elif info.deprecated:
3539
2418
                deprecated_pairs.append((key, help))
3540
 
            elif info.experimental:
3541
 
                experimental_pairs.append((key, help))
3542
2419
            else:
3543
2420
                output += wrapped(key, help, info)
3544
 
        output += "\nSee :doc:`formats-help` for more about storage formats."
3545
 
        other_output = ""
3546
 
        if len(experimental_pairs) > 0:
3547
 
            other_output += "Experimental formats are shown below.\n\n"
3548
 
            for key, help in experimental_pairs:
3549
 
                info = self.get_info(key)
3550
 
                other_output += wrapped(key, help, info)
3551
 
        else:
3552
 
            other_output += \
3553
 
                "No experimental formats are available.\n\n"
3554
2421
        if len(deprecated_pairs) > 0:
3555
 
            other_output += "\nDeprecated formats are shown below.\n\n"
 
2422
            output += "Deprecated formats\n------------------\n\n"
3556
2423
            for key, help in deprecated_pairs:
3557
2424
                info = self.get_info(key)
3558
 
                other_output += wrapped(key, help, info)
3559
 
        else:
3560
 
            other_output += \
3561
 
                "\nNo deprecated formats are available.\n\n"
3562
 
        other_output += \
3563
 
                "\nSee :doc:`formats-help` for more about storage formats."
3564
 
 
3565
 
        if topic == 'other-formats':
3566
 
            return other_output
3567
 
        else:
3568
 
            return output
3569
 
 
3570
 
 
3571
 
class RepositoryAcquisitionPolicy(object):
3572
 
    """Abstract base class for repository acquisition policies.
3573
 
 
3574
 
    A repository acquisition policy decides how a BzrDir acquires a repository
3575
 
    for a branch that is being created.  The most basic policy decision is
3576
 
    whether to create a new repository or use an existing one.
3577
 
    """
3578
 
    def __init__(self, stack_on, stack_on_pwd, require_stacking):
3579
 
        """Constructor.
3580
 
 
3581
 
        :param stack_on: A location to stack on
3582
 
        :param stack_on_pwd: If stack_on is relative, the location it is
3583
 
            relative to.
3584
 
        :param require_stacking: If True, it is a failure to not stack.
3585
 
        """
3586
 
        self._stack_on = stack_on
3587
 
        self._stack_on_pwd = stack_on_pwd
3588
 
        self._require_stacking = require_stacking
3589
 
 
3590
 
    def configure_branch(self, branch):
3591
 
        """Apply any configuration data from this policy to the branch.
3592
 
 
3593
 
        Default implementation sets repository stacking.
3594
 
        """
3595
 
        if self._stack_on is None:
3596
 
            return
3597
 
        if self._stack_on_pwd is None:
3598
 
            stack_on = self._stack_on
3599
 
        else:
3600
 
            try:
3601
 
                stack_on = urlutils.rebase_url(self._stack_on,
3602
 
                    self._stack_on_pwd,
3603
 
                    branch.bzrdir.root_transport.base)
3604
 
            except errors.InvalidRebaseURLs:
3605
 
                stack_on = self._get_full_stack_on()
3606
 
        try:
3607
 
            branch.set_stacked_on_url(stack_on)
3608
 
        except (errors.UnstackableBranchFormat,
3609
 
                errors.UnstackableRepositoryFormat):
3610
 
            if self._require_stacking:
3611
 
                raise
3612
 
 
3613
 
    def requires_stacking(self):
3614
 
        """Return True if this policy requires stacking."""
3615
 
        return self._stack_on is not None and self._require_stacking
3616
 
 
3617
 
    def _get_full_stack_on(self):
3618
 
        """Get a fully-qualified URL for the stack_on location."""
3619
 
        if self._stack_on is None:
3620
 
            return None
3621
 
        if self._stack_on_pwd is None:
3622
 
            return self._stack_on
3623
 
        else:
3624
 
            return urlutils.join(self._stack_on_pwd, self._stack_on)
3625
 
 
3626
 
    def _add_fallback(self, repository, possible_transports=None):
3627
 
        """Add a fallback to the supplied repository, if stacking is set."""
3628
 
        stack_on = self._get_full_stack_on()
3629
 
        if stack_on is None:
3630
 
            return
3631
 
        try:
3632
 
            stacked_dir = BzrDir.open(stack_on,
3633
 
                                      possible_transports=possible_transports)
3634
 
        except errors.JailBreak:
3635
 
            # We keep the stacking details, but we are in the server code so
3636
 
            # actually stacking is not needed.
3637
 
            return
3638
 
        try:
3639
 
            stacked_repo = stacked_dir.open_branch().repository
3640
 
        except errors.NotBranchError:
3641
 
            stacked_repo = stacked_dir.open_repository()
3642
 
        try:
3643
 
            repository.add_fallback_repository(stacked_repo)
3644
 
        except errors.UnstackableRepositoryFormat:
3645
 
            if self._require_stacking:
3646
 
                raise
3647
 
        else:
3648
 
            self._require_stacking = True
3649
 
 
3650
 
    def acquire_repository(self, make_working_trees=None, shared=False):
3651
 
        """Acquire a repository for this bzrdir.
3652
 
 
3653
 
        Implementations may create a new repository or use a pre-exising
3654
 
        repository.
3655
 
        :param make_working_trees: If creating a repository, set
3656
 
            make_working_trees to this value (if non-None)
3657
 
        :param shared: If creating a repository, make it shared if True
3658
 
        :return: A repository, is_new_flag (True if the repository was
3659
 
            created).
3660
 
        """
3661
 
        raise NotImplemented(RepositoryAcquisitionPolicy.acquire_repository)
3662
 
 
3663
 
 
3664
 
class CreateRepository(RepositoryAcquisitionPolicy):
3665
 
    """A policy of creating a new repository"""
3666
 
 
3667
 
    def __init__(self, bzrdir, stack_on=None, stack_on_pwd=None,
3668
 
                 require_stacking=False):
3669
 
        """
3670
 
        Constructor.
3671
 
        :param bzrdir: The bzrdir to create the repository on.
3672
 
        :param stack_on: A location to stack on
3673
 
        :param stack_on_pwd: If stack_on is relative, the location it is
3674
 
            relative to.
3675
 
        """
3676
 
        RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
3677
 
                                             require_stacking)
3678
 
        self._bzrdir = bzrdir
3679
 
 
3680
 
    def acquire_repository(self, make_working_trees=None, shared=False):
3681
 
        """Implementation of RepositoryAcquisitionPolicy.acquire_repository
3682
 
 
3683
 
        Creates the desired repository in the bzrdir we already have.
3684
 
        """
3685
 
        stack_on = self._get_full_stack_on()
3686
 
        if stack_on:
3687
 
            format = self._bzrdir._format
3688
 
            format.require_stacking(stack_on=stack_on,
3689
 
                                    possible_transports=[self._bzrdir.root_transport])
3690
 
            if not self._require_stacking:
3691
 
                # We have picked up automatic stacking somewhere.
3692
 
                note('Using default stacking branch %s at %s', self._stack_on,
3693
 
                    self._stack_on_pwd)
3694
 
        repository = self._bzrdir.create_repository(shared=shared)
3695
 
        self._add_fallback(repository,
3696
 
                           possible_transports=[self._bzrdir.transport])
3697
 
        if make_working_trees is not None:
3698
 
            repository.set_make_working_trees(make_working_trees)
3699
 
        return repository, True
3700
 
 
3701
 
 
3702
 
class UseExistingRepository(RepositoryAcquisitionPolicy):
3703
 
    """A policy of reusing an existing repository"""
3704
 
 
3705
 
    def __init__(self, repository, stack_on=None, stack_on_pwd=None,
3706
 
                 require_stacking=False):
3707
 
        """Constructor.
3708
 
 
3709
 
        :param repository: The repository to use.
3710
 
        :param stack_on: A location to stack on
3711
 
        :param stack_on_pwd: If stack_on is relative, the location it is
3712
 
            relative to.
3713
 
        """
3714
 
        RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
3715
 
                                             require_stacking)
3716
 
        self._repository = repository
3717
 
 
3718
 
    def acquire_repository(self, make_working_trees=None, shared=False):
3719
 
        """Implementation of RepositoryAcquisitionPolicy.acquire_repository
3720
 
 
3721
 
        Returns an existing repository to use.
3722
 
        """
3723
 
        self._add_fallback(self._repository,
3724
 
                       possible_transports=[self._repository.bzrdir.transport])
3725
 
        return self._repository, False
3726
 
 
3727
 
 
3728
 
# Please register new formats after old formats so that formats
3729
 
# appear in chronological order and format descriptions can build
3730
 
# on previous ones.
 
2425
                output += wrapped(key, help, info)
 
2426
 
 
2427
        return output
 
2428
 
 
2429
 
3731
2430
format_registry = BzrDirFormatRegistry()
3732
 
# The pre-0.8 formats have their repository format network name registered in
3733
 
# repository.py. MetaDir formats have their repository format network name
3734
 
# inferred from their disk format string.
3735
2431
format_registry.register('weave', BzrDirFormat6,
3736
2432
    'Pre-0.8 format.  Slower than knit and does not'
3737
2433
    ' support checkouts or shared repositories.',
3738
 
    hidden=True,
3739
2434
    deprecated=True)
 
2435
format_registry.register_metadir('knit',
 
2436
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
 
2437
    'Format using knits.  Recommended for interoperation with bzr <= 0.14.',
 
2438
    branch_format='bzrlib.branch.BzrBranchFormat5',
 
2439
    tree_format='bzrlib.workingtree.WorkingTreeFormat3')
3740
2440
format_registry.register_metadir('metaweave',
3741
2441
    'bzrlib.repofmt.weaverepo.RepositoryFormat7',
3742
2442
    'Transitional format in 0.8.  Slower than knit.',
3743
2443
    branch_format='bzrlib.branch.BzrBranchFormat5',
3744
2444
    tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3745
 
    hidden=True,
3746
 
    deprecated=True)
3747
 
format_registry.register_metadir('knit',
3748
 
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3749
 
    'Format using knits.  Recommended for interoperation with bzr <= 0.14.',
3750
 
    branch_format='bzrlib.branch.BzrBranchFormat5',
3751
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3752
 
    hidden=True,
3753
2445
    deprecated=True)
3754
2446
format_registry.register_metadir('dirstate',
3755
2447
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3759
2451
    # this uses bzrlib.workingtree.WorkingTreeFormat4 because importing
3760
2452
    # directly from workingtree_4 triggers a circular import.
3761
2453
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3762
 
    hidden=True,
3763
 
    deprecated=True)
 
2454
    )
3764
2455
format_registry.register_metadir('dirstate-tags',
3765
2456
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3766
2457
    help='New in 0.15: Fast local operations and improved scaling for '
3768
2459
        ' Incompatible with bzr < 0.15.',
3769
2460
    branch_format='bzrlib.branch.BzrBranchFormat6',
3770
2461
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3771
 
    hidden=True,
3772
 
    deprecated=True)
3773
 
format_registry.register_metadir('rich-root',
3774
 
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
3775
 
    help='New in 1.0.  Better handling of tree roots.  Incompatible with'
3776
 
        ' bzr < 1.0.',
3777
 
    branch_format='bzrlib.branch.BzrBranchFormat6',
3778
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3779
 
    hidden=True,
3780
 
    deprecated=True)
 
2462
    )
3781
2463
format_registry.register_metadir('dirstate-with-subtree',
3782
2464
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
3783
2465
    help='New in 0.15: Fast local operations and improved scaling for '
3785
2467
        'bzr branches. Incompatible with bzr < 0.15.',
3786
2468
    branch_format='bzrlib.branch.BzrBranchFormat6',
3787
2469
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3788
 
    experimental=True,
3789
 
    hidden=True,
3790
 
    )
3791
 
format_registry.register_metadir('pack-0.92',
3792
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack1',
3793
 
    help='New in 0.92: Pack-based format with data compatible with '
3794
 
        'dirstate-tags format repositories. Interoperates with '
3795
 
        'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3796
 
        ,
3797
 
    branch_format='bzrlib.branch.BzrBranchFormat6',
3798
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3799
 
    )
3800
 
format_registry.register_metadir('pack-0.92-subtree',
3801
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack3',
3802
 
    help='New in 0.92: Pack-based format with data compatible with '
3803
 
        'dirstate-with-subtree format repositories. Interoperates with '
3804
 
        'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3805
 
        ,
3806
 
    branch_format='bzrlib.branch.BzrBranchFormat6',
3807
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3808
 
    hidden=True,
3809
 
    experimental=True,
3810
 
    )
3811
 
format_registry.register_metadir('rich-root-pack',
3812
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
3813
 
    help='New in 1.0: A variant of pack-0.92 that supports rich-root data '
3814
 
         '(needed for bzr-svn and bzr-git).',
3815
 
    branch_format='bzrlib.branch.BzrBranchFormat6',
3816
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3817
 
    hidden=True,
3818
 
    )
3819
 
format_registry.register_metadir('1.6',
3820
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5',
3821
 
    help='A format that allows a branch to indicate that there is another '
3822
 
         '(stacked) repository that should be used to access data that is '
3823
 
         'not present locally.',
3824
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3825
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3826
 
    hidden=True,
3827
 
    )
3828
 
format_registry.register_metadir('1.6.1-rich-root',
3829
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5RichRoot',
3830
 
    help='A variant of 1.6 that supports rich-root data '
3831
 
         '(needed for bzr-svn and bzr-git).',
3832
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3833
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3834
 
    hidden=True,
3835
 
    )
3836
 
format_registry.register_metadir('1.9',
3837
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3838
 
    help='A repository format using B+tree indexes. These indexes '
3839
 
         'are smaller in size, have smarter caching and provide faster '
3840
 
         'performance for most operations.',
3841
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3842
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3843
 
    hidden=True,
3844
 
    )
3845
 
format_registry.register_metadir('1.9-rich-root',
3846
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
3847
 
    help='A variant of 1.9 that supports rich-root data '
3848
 
         '(needed for bzr-svn and bzr-git).',
3849
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3850
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3851
 
    hidden=True,
3852
 
    )
3853
 
format_registry.register_metadir('1.14',
3854
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3855
 
    help='A working-tree format that supports content filtering.',
3856
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3857
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat5',
3858
 
    )
3859
 
format_registry.register_metadir('1.14-rich-root',
3860
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
3861
 
    help='A variant of 1.14 that supports rich-root data '
3862
 
         '(needed for bzr-svn and bzr-git).',
3863
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3864
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat5',
3865
 
    )
3866
 
# The following un-numbered 'development' formats should always just be aliases.
3867
 
format_registry.register_metadir('development-rich-root',
3868
 
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
3869
 
    help='Current development format. Supports rich roots. Can convert data '
3870
 
        'to and from rich-root-pack (and anything compatible with '
3871
 
        'rich-root-pack) format repositories. Repositories and branches in '
3872
 
        'this format can only be read by bzr.dev. Please read '
3873
 
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
3874
 
        'before use.',
3875
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3876
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3877
 
    experimental=True,
3878
 
    alias=True,
3879
 
    hidden=True,
3880
 
    )
3881
 
format_registry.register_metadir('development-subtree',
3882
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment2Subtree',
3883
 
    help='Current development format, subtree variant. Can convert data to and '
3884
 
        'from pack-0.92-subtree (and anything compatible with '
3885
 
        'pack-0.92-subtree) format repositories. Repositories and branches in '
3886
 
        'this format can only be read by bzr.dev. Please read '
3887
 
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
3888
 
        'before use.',
3889
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3890
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3891
 
    experimental=True,
3892
 
    hidden=True,
3893
 
    alias=False, # Restore to being an alias when an actual development subtree format is added
3894
 
                 # This current non-alias status is simply because we did not introduce a
3895
 
                 # chk based subtree format.
3896
 
    )
3897
 
 
3898
 
# And the development formats above will have aliased one of the following:
3899
 
format_registry.register_metadir('development6-rich-root',
3900
 
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
3901
 
    help='pack-1.9 with 255-way hashed CHK inv, group compress, rich roots '
3902
 
        'Please read '
3903
 
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
3904
 
        'before use.',
3905
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3906
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3907
 
    hidden=True,
3908
 
    experimental=True,
3909
 
    )
3910
 
 
3911
 
format_registry.register_metadir('development7-rich-root',
3912
 
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK2',
3913
 
    help='pack-1.9 with 255-way hashed CHK inv, bencode revision, group compress, '
3914
 
        'rich roots. Please read '
3915
 
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
3916
 
        'before use.',
3917
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3918
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3919
 
    hidden=True,
3920
 
    experimental=True,
3921
 
    )
3922
 
 
3923
 
format_registry.register_metadir('2a',
3924
 
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
3925
 
    help='First format for bzr 2.0 series.\n'
3926
 
        'Uses group-compress storage.\n'
3927
 
        'Provides rich roots which are a one-way transition.\n',
3928
 
        # 'storage in packs, 255-way hashed CHK inventory, bencode revision, group compress, '
3929
 
        # 'rich roots. Supported by bzr 1.16 and later.',
3930
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3931
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3932
 
    experimental=True,
3933
 
    )
3934
 
 
3935
 
# The following format should be an alias for the rich root equivalent 
3936
 
# of the default format
3937
 
format_registry.register_metadir('default-rich-root',
3938
 
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
3939
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3940
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3941
 
    alias=True,
3942
 
    hidden=True,
3943
 
    help='Same as 2a.')
3944
 
 
3945
 
# The current format that is made on 'bzr init'.
3946
 
format_registry.set_default('2a')
 
2470
    hidden=True,
 
2471
    )
 
2472
format_registry.set_default('dirstate')