/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/bzrdir.py

  • Committer: Johan Dahlberg
  • Date: 2007-03-03 05:47:31 UTC
  • mto: (2312.1.1 jam-integration)
  • mto: This revision was merged to the branch mainline in revision 2314.
  • Revision ID: johan_d@lysator.liu.se-20070303054731-8n4xac0g02tq3hkt
Fix bzrtools shelve command for removed lines beginning with "--"
 (Johan Dahlberg, bug #75577)

Show diffs side-by-side

added added

removed removed

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