/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: v.ladeuil+lp at free
  • Date: 2006-11-08 07:44:30 UTC
  • mfrom: (2123 +trunk)
  • mto: (2145.1.1 keepalive)
  • mto: This revision was merged to the branch mainline in revision 2146.
  • Revision ID: v.ladeuil+lp@free.fr-20061108074430-a9c08d4a475bd97f
Merge bzr.dev

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2006-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006 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
33
 
34
34
from bzrlib.lazy_import import lazy_import
35
35
lazy_import(globals(), """
 
36
from copy import deepcopy
36
37
from stat import S_ISDIR
37
 
import textwrap
 
38
import unittest
38
39
 
39
40
import bzrlib
40
41
from bzrlib import (
41
 
    branch,
42
 
    config,
43
42
    errors,
44
 
    graph,
45
43
    lockable_files,
46
44
    lockdir,
47
 
    osutils,
48
 
    remote,
49
 
    repository,
50
45
    revision as _mod_revision,
51
 
    ui,
52
46
    urlutils,
53
 
    versionedfile,
54
 
    win32utils,
55
 
    workingtree,
56
 
    workingtree_4,
57
47
    xml4,
58
48
    xml5,
59
49
    )
60
50
from bzrlib.osutils import (
 
51
    safe_unicode,
 
52
    sha_strings,
61
53
    sha_string,
62
54
    )
63
 
from bzrlib.push import (
64
 
    PushResult,
65
 
    )
66
 
from bzrlib.repofmt import pack_repo
67
 
from bzrlib.smart.client import _SmartClient
 
55
from bzrlib.store.revision.text import TextRevisionStore
 
56
from bzrlib.store.text import TextStore
68
57
from bzrlib.store.versioned import WeaveStore
69
58
from bzrlib.transactions import WriteTransaction
70
 
from bzrlib.transport import (
71
 
    do_catching_redirections,
72
 
    get_transport,
73
 
    local,
74
 
    )
 
59
from bzrlib.transport import get_transport
75
60
from bzrlib.weave import Weave
76
61
""")
77
62
 
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):
 
63
from bzrlib.trace import mutter
 
64
from bzrlib.transport.local import LocalTransport
 
65
 
 
66
 
 
67
class BzrDir(object):
125
68
    """A .bzr control diretory.
126
 
 
 
69
    
127
70
    BzrDir instances let you create or open any of the things that can be
128
71
    found within .bzr - checkouts, branches and repositories.
129
 
 
130
 
    :ivar transport:
 
72
    
 
73
    transport
131
74
        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.
 
75
    root_transport
 
76
        a transport connected to the directory this bzr was opened from.
139
77
    """
140
78
 
141
79
    def break_lock(self):
144
82
        If there is a tree, the tree is opened and break_lock() called.
145
83
        Otherwise, branch is tried, and finally repository.
146
84
        """
147
 
        # XXX: This seems more like a UI function than something that really
148
 
        # belongs in this class.
149
85
        try:
150
86
            thing_to_unlock = self.open_workingtree()
151
87
        except (errors.NotLocalUrl, errors.NoWorkingTree):
163
99
        return True
164
100
 
165
101
    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
102
        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
 
103
        source_repo_format = self._format.repository_format
 
104
        source_repo_format.check_conversion_target(target_repo_format)
176
105
 
177
106
    @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.
 
107
    def _check_supported(format, allow_unsupported):
 
108
        """Check whether format is a supported format.
 
109
 
 
110
        If allow_unsupported is True, this is a no-op.
193
111
        """
194
 
        # TODO: perhaps move this into a base Format class; it's not BzrDir
195
 
        # specific. mbp 20070323
196
112
        if not allow_unsupported and not format.is_supported():
197
113
            # see open_downlevel to open legacy branches.
198
114
            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
115
 
205
 
    def clone(self, url, revision_id=None, force_new_repo=False,
206
 
              preserve_stacking=False):
 
116
    def clone(self, url, revision_id=None, basis=None, force_new_repo=False):
207
117
        """Clone this bzrdir and its contents to url verbatim.
208
118
 
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:
 
119
        If urls last component does not exist, it will be created.
 
120
 
 
121
        if revision_id is not None, then the clone operation may tune
 
122
            itself to download less data.
 
123
        :param force_new_repo: Do not use a shared repository for the target 
 
124
                               even if one is available.
 
125
        """
 
126
        self._make_tail(url)
 
127
        basis_repo, basis_branch, basis_tree = self._get_basis_components(basis)
 
128
        result = self._format.initialize(url)
251
129
        try:
252
130
            local_repo = self.find_repository()
253
131
        except errors.NoRepositoryPresent:
254
132
            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
133
        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:
 
134
            # may need to copy content in
 
135
            if force_new_repo:
 
136
                result_repo = local_repo.clone(
 
137
                    result,
 
138
                    revision_id=revision_id,
 
139
                    basis=basis_repo)
 
140
                result_repo.set_make_working_trees(local_repo.make_working_trees())
 
141
            else:
 
142
                try:
 
143
                    result_repo = result.find_repository()
 
144
                    # fetch content this dir needs.
 
145
                    if basis_repo:
 
146
                        # XXX FIXME RBC 20060214 need tests for this when the basis
 
147
                        # is incomplete
 
148
                        result_repo.fetch(basis_repo, revision_id=revision_id)
304
149
                    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)
 
150
                except errors.NoRepositoryPresent:
 
151
                    # needed to make one anyway.
 
152
                    result_repo = local_repo.clone(
 
153
                        result,
 
154
                        revision_id=revision_id,
 
155
                        basis=basis_repo)
 
156
                    result_repo.set_make_working_trees(local_repo.make_working_trees())
310
157
        # 1 if there is a branch present
311
158
        #   make sure its content is available in the target repository
312
159
        #   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)
 
160
        try:
 
161
            self.open_branch().clone(result, revision_id=revision_id)
 
162
        except errors.NotBranchError:
 
163
            pass
 
164
        try:
 
165
            self.open_workingtree().clone(result, basis=basis_tree)
322
166
        except (errors.NoWorkingTree, errors.NotLocalUrl):
323
167
            pass
324
168
        return result
325
169
 
 
170
    def _get_basis_components(self, basis):
 
171
        """Retrieve the basis components that are available at basis."""
 
172
        if basis is None:
 
173
            return None, None, None
 
174
        try:
 
175
            basis_tree = basis.open_workingtree()
 
176
            basis_branch = basis_tree.branch
 
177
            basis_repo = basis_branch.repository
 
178
        except (errors.NoWorkingTree, errors.NotLocalUrl):
 
179
            basis_tree = None
 
180
            try:
 
181
                basis_branch = basis.open_branch()
 
182
                basis_repo = basis_branch.repository
 
183
            except errors.NotBranchError:
 
184
                basis_branch = None
 
185
                try:
 
186
                    basis_repo = basis.open_repository()
 
187
                except errors.NoRepositoryPresent:
 
188
                    basis_repo = None
 
189
        return basis_repo, basis_branch, basis_tree
 
190
 
326
191
    # TODO: This should be given a Transport, and should chdir up; otherwise
327
192
    # this will open a new connection.
328
193
    def _make_tail(self, url):
329
 
        t = get_transport(url)
330
 
        t.ensure_base()
 
194
        head, tail = urlutils.split(url)
 
195
        if tail and tail != '.':
 
196
            t = get_transport(head)
 
197
            try:
 
198
                t.mkdir(tail)
 
199
            except errors.FileExists:
 
200
                pass
331
201
 
 
202
    # TODO: Should take a Transport
332
203
    @classmethod
333
 
    def create(cls, base, format=None, possible_transports=None):
 
204
    def create(cls, base):
334
205
        """Create a new BzrDir at the url 'base'.
 
206
        
 
207
        This will call the current default formats initialize with base
 
208
        as the only parameter.
335
209
 
336
 
        :param format: If supplied, the format of branch to create.  If not
337
 
            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.
 
210
        If you need a specific format, consider creating an instance
 
211
        of that and calling initialize().
340
212
        """
341
213
        if cls is not BzrDir:
342
 
            raise AssertionError("BzrDir.create always creates the default"
343
 
                " format, not one of %r" % cls)
344
 
        t = get_transport(base, possible_transports)
345
 
        t.ensure_base()
346
 
        if format is None:
347
 
            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):
 
214
            raise AssertionError("BzrDir.create always creates the default format, "
 
215
                    "not one of %r" % cls)
 
216
        head, tail = urlutils.split(base)
 
217
        if tail and tail != '.':
 
218
            t = get_transport(head)
 
219
            try:
 
220
                t.mkdir(tail)
 
221
            except errors.FileExists:
 
222
                pass
 
223
        return BzrDirFormat.get_default_format().initialize(safe_unicode(base))
 
224
 
 
225
    def create_branch(self):
433
226
        """Create a branch in this BzrDir.
434
227
 
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.
 
228
        The bzrdirs format will control what branch format is created.
439
229
        For more control see BranchFormatXX.create(a_bzrdir).
440
230
        """
441
231
        raise NotImplementedError(self.create_branch)
442
232
 
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
233
    @staticmethod
452
 
    def create_branch_and_repo(base, force_new_repo=False, format=None):
 
234
    def create_branch_and_repo(base, force_new_repo=False):
453
235
        """Create a new BzrDir, Branch and Repository at the url 'base'.
454
236
 
455
 
        This will use the current default BzrDirFormat unless one is
456
 
        specified, and use whatever
 
237
        This will use the current default BzrDirFormat, and use whatever 
457
238
        repository format that that uses via bzrdir.create_branch and
458
239
        create_repository. If a shared repository is available that is used
459
240
        preferentially.
462
243
 
463
244
        :param base: The URL to create the branch at.
464
245
        :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
246
        """
468
 
        bzrdir = BzrDir.create(base, format)
 
247
        bzrdir = BzrDir.create(base)
469
248
        bzrdir._find_or_create_repository(force_new_repo)
470
249
        return bzrdir.create_branch()
471
250
 
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
251
    def _find_or_create_repository(self, force_new_repo):
534
252
        """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
 
 
 
253
        if force_new_repo:
 
254
            return self.create_repository()
 
255
        try:
 
256
            return self.find_repository()
 
257
        except errors.NoRepositoryPresent:
 
258
            return self.create_repository()
 
259
        
538
260
    @staticmethod
539
261
    def create_branch_convenience(base, force_new_repo=False,
540
 
                                  force_new_tree=None, format=None,
541
 
                                  possible_transports=None):
 
262
                                  force_new_tree=None, format=None):
542
263
        """Create a new BzrDir, Branch and Repository at the url 'base'.
543
264
 
544
265
        This is a convenience function - it will use an existing repository
545
266
        if possible, can be told explicitly whether to create a working tree or
546
267
        not.
547
268
 
548
 
        This will use the current default BzrDirFormat unless one is
549
 
        specified, and use whatever
 
269
        This will use the current default BzrDirFormat, and use whatever 
550
270
        repository format that that uses via bzrdir.create_branch and
551
271
        create_repository. If a shared repository is available that is used
552
272
        preferentially. Whatever repository is used, its tree creation policy
554
274
 
555
275
        The created Branch object is returned.
556
276
        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
 
277
        no error is raised unless force_new_tree is True, in which case no 
558
278
        data is created on disk and NotLocalUrl is raised.
559
279
 
560
280
        :param base: The URL to create the branch at.
561
281
        :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
 
282
        :param force_new_tree: If True or False force creation of a tree or 
563
283
                               prevent such creation respectively.
564
 
        :param format: Override for the bzrdir format to create.
565
 
        :param possible_transports: An optional reusable transports list.
 
284
        :param format: Override for the for the bzrdir format to create
566
285
        """
567
286
        if force_new_tree:
568
287
            # check for non local urls
569
 
            t = get_transport(base, possible_transports)
570
 
            if not isinstance(t, local.LocalTransport):
 
288
            t = get_transport(safe_unicode(base))
 
289
            if not isinstance(t, LocalTransport):
571
290
                raise errors.NotLocalUrl(base)
572
 
        bzrdir = BzrDir.create(base, format, possible_transports)
 
291
        if format is None:
 
292
            bzrdir = BzrDir.create(base)
 
293
        else:
 
294
            bzrdir = format.initialize(base)
573
295
        repo = bzrdir._find_or_create_repository(force_new_repo)
574
296
        result = bzrdir.create_branch()
575
 
        if force_new_tree or (repo.make_working_trees() and
 
297
        if force_new_tree or (repo.make_working_trees() and 
576
298
                              force_new_tree is None):
577
299
            try:
578
300
                bzrdir.create_workingtree()
579
301
            except errors.NotLocalUrl:
580
302
                pass
581
303
        return result
582
 
 
583
 
    @staticmethod
584
 
    def create_standalone_workingtree(base, format=None):
 
304
        
 
305
    @staticmethod
 
306
    def create_repository(base, shared=False):
 
307
        """Create a new BzrDir and Repository at the url 'base'.
 
308
 
 
309
        This will use the current default BzrDirFormat, and use whatever 
 
310
        repository format that that uses for bzrdirformat.create_repository.
 
311
 
 
312
        :param shared: Create a shared repository rather than a standalone
 
313
                       repository.
 
314
        The Repository object is returned.
 
315
 
 
316
        This must be overridden as an instance method in child classes, where
 
317
        it should take no parameters and construct whatever repository format
 
318
        that child class desires.
 
319
        """
 
320
        bzrdir = BzrDir.create(base)
 
321
        return bzrdir.create_repository(shared)
 
322
 
 
323
    @staticmethod
 
324
    def create_standalone_workingtree(base):
585
325
        """Create a new BzrDir, WorkingTree, Branch and Repository at 'base'.
586
326
 
587
327
        'base' must be a local path or a file:// url.
588
328
 
589
 
        This will use the current default BzrDirFormat unless one is
590
 
        specified, and use whatever
 
329
        This will use the current default BzrDirFormat, and use whatever 
591
330
        repository format that that uses for bzrdirformat.create_workingtree,
592
331
        create_branch and create_repository.
593
332
 
594
 
        :param format: Override for the bzrdir format to create.
595
333
        :return: The WorkingTree object.
596
334
        """
597
 
        t = get_transport(base)
598
 
        if not isinstance(t, local.LocalTransport):
 
335
        t = get_transport(safe_unicode(base))
 
336
        if not isinstance(t, LocalTransport):
599
337
            raise errors.NotLocalUrl(base)
600
 
        bzrdir = BzrDir.create_branch_and_repo(base,
601
 
                                               force_new_repo=True,
602
 
                                               format=format).bzrdir
 
338
        bzrdir = BzrDir.create_branch_and_repo(safe_unicode(base),
 
339
                                               force_new_repo=True).bzrdir
603
340
        return bzrdir.create_workingtree()
604
341
 
605
 
    def create_workingtree(self, revision_id=None, from_branch=None,
606
 
        accelerator_tree=None, hardlink=False):
 
342
    def create_workingtree(self, revision_id=None):
607
343
        """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.
 
344
        
 
345
        revision_id: create it as of this revision id.
615
346
        """
616
347
        raise NotImplementedError(self.create_workingtree)
617
348
 
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
349
    def destroy_workingtree(self):
672
350
        """Destroy the working tree at this BzrDir.
673
351
 
683
361
        """
684
362
        raise NotImplementedError(self.destroy_workingtree_metadata)
685
363
 
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.
 
364
    def find_repository(self):
 
365
        """Find the repository that should be used for a_bzrdir.
 
366
 
 
367
        This does not require a branch as we use it to find the repo for
 
368
        new branches as well as to hook existing branches up to their
 
369
        repository.
698
370
        """
699
 
        found_bzrdir = self
 
371
        try:
 
372
            return self.open_repository()
 
373
        except errors.NoRepositoryPresent:
 
374
            pass
 
375
        next_transport = self.root_transport.clone('..')
700
376
        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
377
            # find the next containing bzrdir
709
378
            try:
710
379
                found_bzrdir = BzrDir.open_containing_from_transport(
711
380
                    next_transport)[0]
712
381
            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):
 
382
                # none found
 
383
                raise errors.NoRepositoryPresent(self)
723
384
            # does it have a repository ?
724
385
            try:
725
386
                repository = found_bzrdir.open_repository()
726
387
            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
 
388
                next_transport = found_bzrdir.root_transport.clone('..')
 
389
                if (found_bzrdir.root_transport.base == next_transport.base):
 
390
                    # top of the file system
 
391
                    break
 
392
                else:
 
393
                    continue
 
394
            if ((found_bzrdir.root_transport.base == 
 
395
                 self.root_transport.base) or repository.is_shared()):
 
396
                return repository
732
397
            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):
 
398
                raise errors.NoRepositoryPresent(self)
 
399
        raise errors.NoRepositoryPresent(self)
 
400
 
 
401
    def get_branch_transport(self, branch_format):
755
402
        """Get the transport for use by branch format in this BzrDir.
756
403
 
757
404
        Note that bzr dirs that do not support format strings will raise
758
405
        IncompatibleFormat if the branch format they are given has
759
406
        a format string, and vice versa.
760
407
 
761
 
        If branch_format is None, the transport is returned with no
762
 
        checking. If it is not None, then the returned transport is
 
408
        If branch_format is None, the transport is returned with no 
 
409
        checking. if it is not None, then the returned transport is
763
410
        guaranteed to point to an existing directory ready for use.
764
411
        """
765
412
        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
 
 
 
413
        
811
414
    def get_repository_transport(self, repository_format):
812
415
        """Get the transport for use by repository format in this BzrDir.
813
416
 
815
418
        IncompatibleFormat if the repository format they are given has
816
419
        a format string, and vice versa.
817
420
 
818
 
        If repository_format is None, the transport is returned with no
819
 
        checking. If it is not None, then the returned transport is
 
421
        If repository_format is None, the transport is returned with no 
 
422
        checking. if it is not None, then the returned transport is
820
423
        guaranteed to point to an existing directory ready for use.
821
424
        """
822
425
        raise NotImplementedError(self.get_repository_transport)
823
 
 
 
426
        
824
427
    def get_workingtree_transport(self, tree_format):
825
428
        """Get the transport for use by workingtree format in this BzrDir.
826
429
 
827
430
        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.
 
431
        IncompatibleFormat if the workingtree format they are given has
 
432
        a format string, and vice versa.
830
433
 
831
 
        If workingtree_format is None, the transport is returned with no
832
 
        checking. If it is not None, then the returned transport is
 
434
        If workingtree_format is None, the transport is returned with no 
 
435
        checking. if it is not None, then the returned transport is
833
436
        guaranteed to point to an existing directory ready for use.
834
437
        """
835
438
        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
 
 
 
439
        
845
440
    def __init__(self, _transport, _format):
846
441
        """Initialize a Bzr control dir object.
847
 
 
 
442
        
848
443
        Only really common logic should reside here, concrete classes should be
849
444
        made with varying behaviours.
850
445
 
852
447
        :param _transport: the transport this dir is based at.
853
448
        """
854
449
        self._format = _format
855
 
        # these are also under the more standard names of 
856
 
        # control_transport and user_transport
857
450
        self.transport = _transport.clone('.bzr')
858
451
        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
452
 
869
453
    def is_control_filename(self, filename):
870
454
        """True if filename is the name of a path which is reserved for bzrdir's.
871
 
 
 
455
        
872
456
        :param filename: A filename within the root transport of this bzrdir.
873
457
 
874
458
        This is true IF and ONLY IF the filename is part of the namespace reserved
877
461
        this in the future - for instance to make bzr talk with svn working
878
462
        trees.
879
463
        """
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
 
464
        # this might be better on the BzrDirFormat class because it refers to 
 
465
        # all the possible bzrdir disk formats. 
 
466
        # This method is tested via the workingtree is_control_filename tests- 
 
467
        # it was extracted from WorkingTree.is_control_filename. If the methods
 
468
        # contract is extended beyond the current trivial  implementation please
885
469
        # add new tests for it to the appropriate place.
886
470
        return filename == '.bzr' or filename.startswith('.bzr/')
887
471
 
888
472
    def needs_format_conversion(self, format=None):
889
473
        """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
 
474
        
 
475
        For instance, if the repository format is out of date but the 
892
476
        branch and working tree are not, this should return True.
893
477
 
894
478
        :param format: Optional parameter indicating a specific desired
900
484
    def open_unsupported(base):
901
485
        """Open a branch which is not supported."""
902
486
        return BzrDir.open(base, _unsupported=True)
903
 
 
 
487
        
904
488
    @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.
 
489
    def open(base, _unsupported=False):
 
490
        """Open an existing bzrdir, rooted at 'base' (url)
 
491
        
 
492
        _unsupported is a private parameter to the BzrDir class.
909
493
        """
910
 
        t = get_transport(base, possible_transports=possible_transports)
 
494
        t = get_transport(base)
911
495
        return BzrDir.open_from_transport(t, _unsupported=_unsupported)
912
496
 
913
497
    @staticmethod
914
 
    def open_from_transport(transport, _unsupported=False,
915
 
                            _server_formats=True):
 
498
    def open_from_transport(transport, _unsupported=False):
916
499
        """Open a bzrdir within a particular directory.
917
500
 
918
501
        :param transport: Transport containing the bzrdir.
919
502
        :param _unsupported: private.
920
503
        """
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
 
 
 
504
        format = BzrDirFormat.find_format(transport)
945
505
        BzrDir._check_supported(format, _unsupported)
946
506
        return format.open(transport, _found=True)
947
507
 
948
 
    def open_branch(self, name=None, unsupported=False,
949
 
                    ignore_fallbacks=False):
 
508
    def open_branch(self, unsupported=False):
950
509
        """Open the branch object at this BzrDir if one is present.
951
510
 
952
511
        If unsupported is True, then no longer supported branch formats can
953
512
        still be opened.
954
 
 
 
513
        
955
514
        TODO: static convenience version of this?
956
515
        """
957
516
        raise NotImplementedError(self.open_branch)
958
517
 
959
518
    @staticmethod
960
 
    def open_containing(url, possible_transports=None):
 
519
    def open_containing(url):
961
520
        """Open an existing branch which contains url.
962
 
 
 
521
        
963
522
        :param url: url to search from.
964
523
        See open_containing_from_transport for more detail.
965
524
        """
966
 
        transport = get_transport(url, possible_transports)
967
 
        return BzrDir.open_containing_from_transport(transport)
968
 
 
 
525
        return BzrDir.open_containing_from_transport(get_transport(url))
 
526
    
969
527
    @staticmethod
970
528
    def open_containing_from_transport(a_transport):
971
 
        """Open an existing branch which contains a_transport.base.
 
529
        """Open an existing branch which contains a_transport.base
972
530
 
973
531
        This probes for a branch at a_transport, and searches upwards from there.
974
532
 
975
533
        Basically we keep looking up until we find the control directory or
976
534
        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
 
535
        If there is one and it is either an unrecognised format or an unsupported 
978
536
        format, UnknownFormatError or UnsupportedFormatError are raised.
979
537
        If there is one, it is returned, along with the unused portion of url.
980
538
 
981
 
        :return: The BzrDir that contains the path, and a Unicode path
 
539
        :return: The BzrDir that contains the path, and a Unicode path 
982
540
                for the rest of the URL.
983
541
        """
984
542
        # this gets the normalised url back. I.e. '.' -> the full path.
989
547
                return result, urlutils.unescape(a_transport.relpath(url))
990
548
            except errors.NotBranchError, e:
991
549
                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)
 
550
            new_t = a_transport.clone('..')
997
551
            if new_t.base == a_transport.base:
998
552
                # reached the root, whatever that may be
999
553
                raise errors.NotBranchError(path=url)
1000
554
            a_transport = new_t
1001
555
 
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
 
    @classmethod
1036
 
    def open_containing_tree_or_branch(klass, location):
1037
 
        """Return the branch and working tree contained by a location.
1038
 
 
1039
 
        Returns (tree, branch, relpath).
1040
 
        If there is no tree at containing the location, tree will be None.
1041
 
        If there is no branch containing the location, an exception will be
1042
 
        raised
1043
 
        relpath is the portion of the path that is contained by the branch.
1044
 
        """
1045
 
        bzrdir, relpath = klass.open_containing(location)
1046
 
        tree, branch = bzrdir._get_tree_branch()
1047
 
        return tree, branch, relpath
1048
 
 
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
556
    def open_repository(self, _unsupported=False):
1075
557
        """Open the repository object at this BzrDir if one is present.
1076
558
 
1077
 
        This will not follow the Branch object pointer - it's strictly a direct
 
559
        This will not follow the Branch object pointer - its strictly a direct
1078
560
        open facility. Most client code should use open_branch().repository to
1079
561
        get at a repository.
1080
562
 
1081
 
        :param _unsupported: a private parameter, not part of the api.
 
563
        _unsupported is a private parameter, not part of the api.
1082
564
        TODO: static convenience version of this?
1083
565
        """
1084
566
        raise NotImplementedError(self.open_repository)
1085
567
 
1086
 
    def open_workingtree(self, _unsupported=False,
1087
 
                         recommend_upgrade=True, from_branch=None):
 
568
    def open_workingtree(self, _unsupported=False):
1088
569
        """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)
 
570
        
 
571
        TODO: static convenience version of this?
1095
572
        """
1096
573
        raise NotImplementedError(self.open_workingtree)
1097
574
 
1098
 
    def has_branch(self, name=None):
 
575
    def has_branch(self):
1099
576
        """Tell if this bzrdir contains a branch.
1100
 
 
 
577
        
1101
578
        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.)
 
579
        and try, and not ask permission first.  (This method just opens the 
 
580
        branch and discards it, and that's somewhat expensive.) 
1104
581
        """
1105
582
        try:
1106
 
            self.open_branch(name)
 
583
            self.open_branch()
1107
584
            return True
1108
585
        except errors.NotBranchError:
1109
586
            return False
1113
590
 
1114
591
        This will still raise an exception if the bzrdir has a workingtree that
1115
592
        is remote & inaccessible.
1116
 
 
 
593
        
1117
594
        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.)
 
595
        and try, and not ask permission first.  (This method just opens the 
 
596
        workingtree and discards it, and that's somewhat expensive.) 
1120
597
        """
1121
598
        try:
1122
 
            self.open_workingtree(recommend_upgrade=False)
 
599
            self.open_workingtree()
1123
600
            return True
1124
601
        except errors.NoWorkingTree:
1125
602
            return False
1126
603
 
1127
 
    def _cloning_metadir(self):
1128
 
        """Produce a metadir suitable for cloning with.
1129
 
 
1130
 
        :returns: (destination_bzrdir_format, source_repository)
1131
 
        """
 
604
    def cloning_metadir(self, basis=None):
 
605
        """Produce a metadir suitable for cloning with"""
 
606
        def related_repository(bzrdir):
 
607
            try:
 
608
                branch = bzrdir.open_branch()
 
609
                return branch.repository
 
610
            except errors.NotBranchError:
 
611
                source_branch = None
 
612
                return bzrdir.open_repository()
1132
613
        result_format = self._format.__class__()
1133
614
        try:
1134
615
            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()
 
616
                source_repository = related_repository(self)
 
617
            except errors.NoRepositoryPresent:
 
618
                if basis is None:
 
619
                    raise
 
620
                source_repository = related_repository(self)
 
621
            result_format.repository_format = source_repository._format
1141
622
        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):
 
623
            pass
 
624
        return result_format
 
625
 
 
626
    def sprout(self, url, revision_id=None, basis=None, force_new_repo=False):
1197
627
        """Create a copy of this bzrdir prepared for use as a new line of
1198
628
        development.
1199
629
 
1200
 
        If url's last component does not exist, it will be created.
 
630
        If urls last component does not exist, it will be created.
1201
631
 
1202
632
        Attributes related to the identity of the source branch like
1203
633
        branch nickname will be cleaned, a working tree is created
1206
636
 
1207
637
        if revision_id is not None, then the clone operation may tune
1208
638
            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
639
        """
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
 
640
        self._make_tail(url)
 
641
        cloning_format = self.cloning_metadir(basis)
 
642
        result = cloning_format.initialize(url)
 
643
        basis_repo, basis_branch, basis_tree = self._get_basis_components(basis)
 
644
        try:
 
645
            source_branch = self.open_branch()
1231
646
            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:
 
647
        except errors.NotBranchError:
 
648
            source_branch = None
 
649
            try:
 
650
                source_repository = self.open_repository()
 
651
            except errors.NoRepositoryPresent:
 
652
                # copy the entire basis one if there is one
 
653
                # but there is no repository.
 
654
                source_repository = basis_repo
 
655
        if force_new_repo:
 
656
            result_repo = None
 
657
        else:
 
658
            try:
 
659
                result_repo = result.find_repository()
 
660
            except errors.NoRepositoryPresent:
 
661
                result_repo = None
 
662
        if source_repository is None and result_repo is not None:
 
663
            pass
 
664
        elif source_repository is None and result_repo is None:
 
665
            # no repo available, make a new one
 
666
            result.create_repository()
 
667
        elif source_repository is not None and result_repo is None:
 
668
            # have source, and want to make a new target repo
 
669
            # we don't clone the repo because that preserves attributes
 
670
            # like is_shared(), and we have not yet implemented a 
 
671
            # repository sprout().
 
672
            result_repo = result.create_repository()
 
673
        if result_repo is not None:
 
674
            # fetch needed content into target.
 
675
            if basis_repo:
 
676
                # XXX FIXME RBC 20060214 need tests for this when the basis
 
677
                # is incomplete
 
678
                result_repo.fetch(basis_repo, revision_id=revision_id)
 
679
            if source_repository is not None:
1256
680
                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()
 
681
        if source_branch is not None:
 
682
            source_branch.sprout(result, revision_id=revision_id)
 
683
        else:
 
684
            result.create_branch()
 
685
        # TODO: jam 20060426 we probably need a test in here in the
 
686
        #       case that the newly sprouted branch is a remote one
 
687
        if result_repo is None or result_repo.make_working_trees():
 
688
            wt = result.create_workingtree()
 
689
            if wt.inventory.root is None:
 
690
                try:
 
691
                    wt.set_root_id(self.open_workingtree.get_root_id())
 
692
                except errors.NoWorkingTree:
 
693
                    pass
1314
694
        return result
1315
695
 
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
696
 
1432
697
class BzrDirPreSplitOut(BzrDir):
1433
698
    """A common class for the all-in-one formats."""
1435
700
    def __init__(self, _transport, _format):
1436
701
        """See BzrDir.__init__."""
1437
702
        super(BzrDirPreSplitOut, self).__init__(_transport, _format)
 
703
        assert self._format._lock_class == lockable_files.TransportLock
 
704
        assert self._format._lock_file_name == 'branch-lock'
1438
705
        self._control_files = lockable_files.LockableFiles(
1439
706
                                            self.get_branch_transport(None),
1440
707
                                            self._format._lock_file_name,
1444
711
        """Pre-splitout bzrdirs do not suffer from stale locks."""
1445
712
        raise NotImplementedError(self.break_lock)
1446
713
 
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
 
        """
 
714
    def clone(self, url, revision_id=None, basis=None, force_new_repo=False):
 
715
        """See BzrDir.clone()."""
 
716
        from bzrlib.workingtree import WorkingTreeFormat2
1462
717
        self._make_tail(url)
1463
718
        result = self._format._initialize_for_clone(url)
1464
 
        self.open_repository().clone(result, revision_id=revision_id)
 
719
        basis_repo, basis_branch, basis_tree = self._get_basis_components(basis)
 
720
        self.open_repository().clone(result, revision_id=revision_id, basis=basis_repo)
1465
721
        from_branch = self.open_branch()
1466
722
        from_branch.clone(result, revision_id=revision_id)
1467
723
        try:
1468
 
            tree = self.open_workingtree()
 
724
            self.open_workingtree().clone(result, basis=basis_tree)
1469
725
        except errors.NotLocalUrl:
1470
726
            # make a new one, this format always has to have one.
1471
 
            result._init_workingtree()
1472
 
        else:
1473
 
            tree.clone(result)
 
727
            try:
 
728
                WorkingTreeFormat2().initialize(result)
 
729
            except errors.NotLocalUrl:
 
730
                # but we cannot do it for remote trees.
 
731
                to_branch = result.open_branch()
 
732
                WorkingTreeFormat2().stub_initialize_remote(to_branch.control_files)
1474
733
        return result
1475
734
 
1476
 
    def create_branch(self, name=None):
 
735
    def create_branch(self):
1477
736
        """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)
 
737
        return self.open_branch()
1483
738
 
1484
739
    def create_repository(self, shared=False):
1485
740
        """See BzrDir.create_repository."""
1487
742
            raise errors.IncompatibleFormat('shared repository', self._format)
1488
743
        return self.open_repository()
1489
744
 
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):
 
745
    def create_workingtree(self, revision_id=None):
1496
746
        """See BzrDir.create_workingtree."""
1497
 
        # The workingtree is sometimes created when the bzrdir is created,
1498
 
        # but not when cloning.
1499
 
 
1500
747
        # this looks buggy but is not -really-
1501
 
        # because this format creates the workingtree when the bzrdir is
1502
 
        # created
1503
748
        # clone and sprout will have set the revision_id
1504
749
        # and that will have set it for us, its only
1505
750
        # specific uses of create_workingtree in isolation
1506
751
        # that can do wonky stuff here, and that only
1507
 
        # happens for creating checkouts, which cannot be
 
752
        # happens for creating checkouts, which cannot be 
1508
753
        # 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()
 
754
        result = self.open_workingtree()
1516
755
        if revision_id is not None:
1517
756
            if revision_id == _mod_revision.NULL_REVISION:
1518
757
                result.set_parent_ids([])
1520
759
                result.set_parent_ids([revision_id])
1521
760
        return result
1522
761
 
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
762
    def destroy_workingtree(self):
1534
763
        """See BzrDir.destroy_workingtree."""
1535
764
        raise errors.UnsupportedOperation(self.destroy_workingtree, self)
1536
765
 
1537
766
    def destroy_workingtree_metadata(self):
1538
767
        """See BzrDir.destroy_workingtree_metadata."""
1539
 
        raise errors.UnsupportedOperation(self.destroy_workingtree_metadata,
 
768
        raise errors.UnsupportedOperation(self.destroy_workingtree_metadata, 
1540
769
                                          self)
1541
770
 
1542
 
    def get_branch_transport(self, branch_format, name=None):
 
771
    def get_branch_transport(self, branch_format):
1543
772
        """See BzrDir.get_branch_transport()."""
1544
 
        if name is not None:
1545
 
            raise errors.NoColocatedBranchSupport(self)
1546
773
        if branch_format is None:
1547
774
            return self.transport
1548
775
        try:
1576
803
        # if the format is not the same as the system default,
1577
804
        # an upgrade is needed.
1578
805
        if format is None:
1579
 
            symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1580
 
                % 'needs_format_conversion(format=None)')
1581
806
            format = BzrDirFormat.get_default_format()
1582
807
        return not isinstance(self._format, format.__class__)
1583
808
 
1584
 
    def open_branch(self, name=None, unsupported=False,
1585
 
                    ignore_fallbacks=False):
 
809
    def open_branch(self, unsupported=False):
1586
810
        """See BzrDir.open_branch."""
1587
811
        from bzrlib.branch import BzrBranchFormat4
1588
812
        format = BzrBranchFormat4()
1589
813
        self._check_supported(format, unsupported)
1590
 
        return format.open(self, name, _found=True)
 
814
        return format.open(self, _found=True)
1591
815
 
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):
 
816
    def sprout(self, url, revision_id=None, basis=None, force_new_repo=False):
1596
817
        """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
818
        from bzrlib.workingtree import WorkingTreeFormat2
1610
819
        self._make_tail(url)
1611
820
        result = self._format._initialize_for_clone(url)
 
821
        basis_repo, basis_branch, basis_tree = self._get_basis_components(basis)
1612
822
        try:
1613
 
            self.open_repository().clone(result, revision_id=revision_id)
 
823
            self.open_repository().clone(result, revision_id=revision_id, basis=basis_repo)
1614
824
        except errors.NoRepositoryPresent:
1615
825
            pass
1616
826
        try:
1617
827
            self.open_branch().sprout(result, revision_id=revision_id)
1618
828
        except errors.NotBranchError:
1619
829
            pass
1620
 
 
1621
830
        # we always want a working tree
1622
 
        WorkingTreeFormat2().initialize(result,
1623
 
                                        accelerator_tree=accelerator_tree,
1624
 
                                        hardlink=hardlink)
 
831
        WorkingTreeFormat2().initialize(result)
1625
832
        return result
1626
833
 
1627
834
 
1628
835
class BzrDir4(BzrDirPreSplitOut):
1629
836
    """A .bzr version 4 control object.
1630
 
 
 
837
    
1631
838
    This is a deprecated format and may be removed after sept 2006.
1632
839
    """
1633
840
 
1637
844
 
1638
845
    def needs_format_conversion(self, format=None):
1639
846
        """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
847
        return True
1644
848
 
1645
849
    def open_repository(self):
1646
850
        """See BzrDir.open_repository."""
1647
 
        from bzrlib.repofmt.weaverepo import RepositoryFormat4
 
851
        from bzrlib.repository import RepositoryFormat4
1648
852
        return RepositoryFormat4().open(self, _found=True)
1649
853
 
1650
854
 
1654
858
    This is a deprecated format and may be removed after sept 2006.
1655
859
    """
1656
860
 
1657
 
    def has_workingtree(self):
1658
 
        """See BzrDir.has_workingtree."""
1659
 
        return True
1660
 
    
1661
861
    def open_repository(self):
1662
862
        """See BzrDir.open_repository."""
1663
 
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
 
863
        from bzrlib.repository import RepositoryFormat5
1664
864
        return RepositoryFormat5().open(self, _found=True)
1665
865
 
1666
 
    def open_workingtree(self, _unsupported=False,
1667
 
            recommend_upgrade=True):
 
866
    def open_workingtree(self, _unsupported=False):
1668
867
        """See BzrDir.create_workingtree."""
1669
868
        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)
 
869
        return WorkingTreeFormat2().open(self, _found=True)
1674
870
 
1675
871
 
1676
872
class BzrDir6(BzrDirPreSplitOut):
1679
875
    This is a deprecated format and may be removed after sept 2006.
1680
876
    """
1681
877
 
1682
 
    def has_workingtree(self):
1683
 
        """See BzrDir.has_workingtree."""
1684
 
        return True
1685
 
    
1686
878
    def open_repository(self):
1687
879
        """See BzrDir.open_repository."""
1688
 
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
 
880
        from bzrlib.repository import RepositoryFormat6
1689
881
        return RepositoryFormat6().open(self, _found=True)
1690
882
 
1691
 
    def open_workingtree(self, _unsupported=False,
1692
 
        recommend_upgrade=True):
 
883
    def open_workingtree(self, _unsupported=False):
1693
884
        """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
885
        from bzrlib.workingtree import WorkingTreeFormat2
1697
886
        return WorkingTreeFormat2().open(self, _found=True)
1698
887
 
1699
888
 
1700
889
class BzrDirMeta1(BzrDir):
1701
890
    """A .bzr meta version 1 control object.
1702
 
 
1703
 
    This is the first control object where the
 
891
    
 
892
    This is the first control object where the 
1704
893
    individual aspects are really split out: there are separate repository,
1705
894
    workingtree and branch subdirectories and any subset of the three can be
1706
895
    present within a BzrDir.
1710
899
        """See BzrDir.can_convert_format()."""
1711
900
        return True
1712
901
 
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')
 
902
    def create_branch(self):
 
903
        """See BzrDir.create_branch."""
 
904
        from bzrlib.branch import BranchFormat
 
905
        return BranchFormat.get_default_format().initialize(self)
1722
906
 
1723
907
    def create_repository(self, shared=False):
1724
908
        """See BzrDir.create_repository."""
1725
909
        return self._format.repository_format.initialize(self, shared)
1726
910
 
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):
 
911
    def create_workingtree(self, revision_id=None):
1733
912
        """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)
 
913
        from bzrlib.workingtree import WorkingTreeFormat
 
914
        return WorkingTreeFormat.get_default_format().initialize(self, revision_id)
1737
915
 
1738
916
    def destroy_workingtree(self):
1739
917
        """See BzrDir.destroy_workingtree."""
1740
 
        wt = self.open_workingtree(recommend_upgrade=False)
 
918
        wt = self.open_workingtree()
1741
919
        repository = wt.branch.repository
1742
 
        empty = repository.revision_tree(_mod_revision.NULL_REVISION)
1743
 
        wt.revert(old_tree=empty)
 
920
        empty = repository.revision_tree(bzrlib.revision.NULL_REVISION)
 
921
        wt.revert([], old_tree=empty)
1744
922
        self.destroy_workingtree_metadata()
1745
923
 
1746
924
    def destroy_workingtree_metadata(self):
1747
925
        self.transport.delete_tree('checkout')
1748
926
 
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
927
    def _get_mkdir_mode(self):
1758
928
        """Figure out the mode to use when creating a bzrdir subdir."""
1759
929
        temp_control = lockable_files.LockableFiles(self.transport, '',
1760
930
                                     lockable_files.TransportLock)
1761
931
        return temp_control._dir_mode
1762
932
 
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):
 
933
    def get_branch_transport(self, branch_format):
1770
934
        """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
935
        if branch_format is None:
1776
936
            return self.transport.clone('branch')
1777
937
        try:
1812
972
            pass
1813
973
        return self.transport.clone('checkout')
1814
974
 
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
975
    def needs_format_conversion(self, format=None):
1832
976
        """See BzrDir.needs_format_conversion()."""
1833
977
        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
978
            format = BzrDirFormat.get_default_format()
1838
979
        if not isinstance(self._format, format.__class__):
1839
980
            # it is not a meta dir format, conversion is needed.
1846
987
                return True
1847
988
        except errors.NoRepositoryPresent:
1848
989
            pass
1849
 
        for branch in self.list_branches():
1850
 
            if not isinstance(branch._format,
1851
 
                              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):
1861
 
            pass
 
990
        # currently there are no other possible conversions for meta1 formats.
1862
991
        return False
1863
992
 
1864
 
    def open_branch(self, name=None, unsupported=False,
1865
 
                    ignore_fallbacks=False):
 
993
    def open_branch(self, unsupported=False):
1866
994
        """See BzrDir.open_branch."""
1867
 
        format = self.find_branch_format(name=name)
 
995
        from bzrlib.branch import BranchFormat
 
996
        format = BranchFormat.find_format(self)
1868
997
        self._check_supported(format, unsupported)
1869
 
        return format.open(self, name=name,
1870
 
            _found=True, ignore_fallbacks=ignore_fallbacks)
 
998
        return format.open(self, _found=True)
1871
999
 
1872
1000
    def open_repository(self, unsupported=False):
1873
1001
        """See BzrDir.open_repository."""
1876
1004
        self._check_supported(format, unsupported)
1877
1005
        return format.open(self, _found=True)
1878
1006
 
1879
 
    def open_workingtree(self, unsupported=False,
1880
 
            recommend_upgrade=True):
 
1007
    def open_workingtree(self, unsupported=False):
1881
1008
        """See BzrDir.open_workingtree."""
1882
1009
        from bzrlib.workingtree import WorkingTreeFormat
1883
1010
        format = WorkingTreeFormat.find_format(self)
1884
 
        self._check_supported(format, unsupported,
1885
 
            recommend_upgrade,
1886
 
            basedir=self.root_transport.base)
 
1011
        self._check_supported(format, unsupported)
1887
1012
        return format.open(self, _found=True)
1888
1013
 
1889
 
    def _get_config(self):
1890
 
        return config.TransportConfig(self.transport, 'control.conf')
1891
 
 
1892
1014
 
1893
1015
class BzrDirFormat(object):
1894
1016
    """An encapsulation of the initialization and open routines for a format.
1898
1020
     * a format string,
1899
1021
     * an open routine.
1900
1022
 
1901
 
    Formats are placed in a dict by their format string for reference
 
1023
    Formats are placed in an dict by their format string for reference 
1902
1024
    during bzrdir opening. These should be subclasses of BzrDirFormat
1903
1025
    for consistency.
1904
1026
 
1905
1027
    Once a format is deprecated, just deprecate the initialize and open
1906
 
    methods on the format class. Do not deprecate the object, as the
 
1028
    methods on the format class. Do not deprecate the object, as the 
1907
1029
    object will be created every system load.
1908
 
 
1909
 
    :cvar colocated_branches: Whether this formats supports colocated branches.
1910
1030
    """
1911
1031
 
1912
1032
    _default_format = None
1917
1037
 
1918
1038
    _control_formats = []
1919
1039
    """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
 
 
 
1040
    
1927
1041
    This is a list of BzrDirFormat objects.
1928
1042
    """
1929
1043
 
1930
1044
    _lock_file_name = 'branch-lock'
1931
1045
 
1932
 
    colocated_branches = False
1933
 
    """Whether co-located branches are supported for this control dir format.
1934
 
    """
1935
 
 
1936
1046
    # _lock_class must be set in subclasses to the lock type, typ.
1937
1047
    # TransportLock or LockDir
1938
1048
 
1939
1049
    @classmethod
1940
 
    def find_format(klass, transport, _server_formats=True):
 
1050
    def find_format(klass, transport):
1941
1051
        """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:
 
1052
        for format in klass._control_formats:
1947
1053
            try:
1948
1054
                return format.probe_transport(transport)
1949
1055
            except errors.NotBranchError:
1953
1059
 
1954
1060
    @classmethod
1955
1061
    def probe_transport(klass, transport):
1956
 
        """Return the .bzrdir style format present in a directory."""
 
1062
        """Return the .bzrdir style transport present at URL."""
1957
1063
        try:
1958
 
            format_string = transport.get_bytes(".bzr/branch-format")
 
1064
            format_string = transport.get(".bzr/branch-format").read()
1959
1065
        except errors.NoSuchFile:
1960
1066
            raise errors.NotBranchError(path=transport.base)
1961
1067
 
1962
1068
        try:
1963
1069
            return klass._formats[format_string]
1964
1070
        except KeyError:
1965
 
            raise errors.UnknownFormatError(format=format_string, kind='bzrdir')
 
1071
            raise errors.UnknownFormatError(format=format_string)
1966
1072
 
1967
1073
    @classmethod
1968
1074
    def get_default_format(klass):
1986
1092
        current default format. In the case of plugins we can/should provide
1987
1093
        some means for them to extend the range of returnable converters.
1988
1094
 
1989
 
        :param format: Optional format to override the default format of the
 
1095
        :param format: Optional format to override the default format of the 
1990
1096
                       library.
1991
1097
        """
1992
1098
        raise NotImplementedError(self.get_converter)
1993
1099
 
1994
 
    def initialize(self, url, possible_transports=None):
 
1100
    def initialize(self, url):
1995
1101
        """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
 
 
 
1102
        
2001
1103
        Subclasses should typically override initialize_on_transport
2002
1104
        instead of this method.
2003
1105
        """
2004
 
        return self.initialize_on_transport(get_transport(url,
2005
 
                                                          possible_transports))
 
1106
        return self.initialize_on_transport(get_transport(url))
2006
1107
 
2007
1108
    def initialize_on_transport(self, transport):
2008
1109
        """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
 
1110
        # Since we don't have a .bzr directory, inherit the
2129
1111
        # mode from the root directory
2130
1112
        temp_control = lockable_files.LockableFiles(transport,
2131
1113
                            '', lockable_files.TransportLock)
2133
1115
                                      # FIXME: RBC 20060121 don't peek under
2134
1116
                                      # the covers
2135
1117
                                      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
1118
        file_mode = temp_control._file_mode
2139
1119
        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"),
 
1120
        mutter('created control directory in ' + transport.base)
 
1121
        control = transport.clone('.bzr')
 
1122
        utf8_files = [('README', 
 
1123
                       "This is a Bazaar-NG control directory.\n"
 
1124
                       "Do not change any files in this directory.\n"),
2145
1125
                      ('branch-format', self.get_format_string()),
2146
1126
                      ]
2147
1127
        # 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)
 
1128
        control_files = lockable_files.LockableFiles(control,
 
1129
                            self._lock_file_name, self._lock_class)
2150
1130
        control_files.create_lock()
2151
1131
        control_files.lock_write()
2152
1132
        try:
2153
 
            for (filename, content) in utf8_files:
2154
 
                bzrdir_transport.put_bytes(filename, content,
2155
 
                    mode=file_mode)
 
1133
            for file, content in utf8_files:
 
1134
                control_files.put_utf8(file, content)
2156
1135
        finally:
2157
1136
            control_files.unlock()
2158
1137
        return self.open(transport, _found=True)
2161
1140
        """Is this format supported?
2162
1141
 
2163
1142
        Supported formats must be initializable and openable.
2164
 
        Unsupported formats may not support initialization or committing or
 
1143
        Unsupported formats may not support initialization or committing or 
2165
1144
        some other features depending on the reason for not being supported.
2166
1145
        """
2167
1146
        return True
2168
1147
 
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
1148
    def same_model(self, target_format):
2180
 
        return (self.repository_format.rich_root_data ==
 
1149
        return (self.repository_format.rich_root_data == 
2181
1150
            target_format.rich_root_data)
2182
1151
 
2183
1152
    @classmethod
2184
1153
    def known_formats(klass):
2185
1154
        """Return all the known formats.
2186
 
 
 
1155
        
2187
1156
        Concrete formats should override _known_formats.
2188
1157
        """
2189
 
        # There is double indirection here to make sure that control
2190
 
        # formats used by more than one dir format will only be probed
 
1158
        # There is double indirection here to make sure that control 
 
1159
        # formats used by more than one dir format will only be probed 
2191
1160
        # once. This can otherwise be quite expensive for remote connections.
2192
1161
        result = set()
2193
1162
        for format in klass._control_formats:
2194
1163
            result.update(format._known_formats())
2195
1164
        return result
2196
 
 
 
1165
    
2197
1166
    @classmethod
2198
1167
    def _known_formats(klass):
2199
1168
        """Return the known format instances for this control format."""
2201
1170
 
2202
1171
    def open(self, transport, _found=False):
2203
1172
        """Return an instance of this format for the dir transport points at.
2204
 
 
 
1173
        
2205
1174
        _found is a private parameter, do not use it.
2206
1175
        """
2207
1176
        if not _found:
2208
1177
            found_format = BzrDirFormat.find_format(transport)
2209
1178
            if not isinstance(found_format, self.__class__):
2210
1179
                raise AssertionError("%s was asked to open %s, but it seems to need "
2211
 
                        "format %s"
 
1180
                        "format %s" 
2212
1181
                        % (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
1182
        return self._open(transport)
2217
1183
 
2218
1184
    def _open(self, transport):
2226
1192
    @classmethod
2227
1193
    def register_format(klass, format):
2228
1194
        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
1195
 
2232
1196
    @classmethod
2233
1197
    def register_control_format(klass, format):
2234
 
        """Register a format that does not use '.bzr' for its control dir.
 
1198
        """Register a format that does not use '.bzrdir' for its control dir.
2235
1199
 
2236
1200
        TODO: This should be pulled up into a 'ControlDirFormat' base class
2237
 
        which BzrDirFormat can inherit from, and renamed to register_format
 
1201
        which BzrDirFormat can inherit from, and renamed to register_format 
2238
1202
        there. It has been done without that for now for simplicity of
2239
1203
        implementation.
2240
1204
        """
2241
1205
        klass._control_formats.append(format)
2242
1206
 
2243
1207
    @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)
2253
 
 
2254
 
    @classmethod
2255
 
    def _set_default_format(klass, format):
2256
 
        """Set default format (for testing behavior of defaults only)"""
 
1208
    def set_default_format(klass, format):
2257
1209
        klass._default_format = format
2258
1210
 
2259
1211
    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
 
        """
 
1212
        return self.get_format_string()[:-1]
2274
1213
 
2275
1214
    @classmethod
2276
1215
    def unregister_format(klass, format):
 
1216
        assert klass._formats[format.get_format_string()] is format
2277
1217
        del klass._formats[format.get_format_string()]
2278
1218
 
2279
1219
    @classmethod
2281
1221
        klass._control_formats.remove(format)
2282
1222
 
2283
1223
 
 
1224
# register BzrDirFormat as a control format
 
1225
BzrDirFormat.register_control_format(BzrDirFormat)
 
1226
 
 
1227
 
2284
1228
class BzrDirFormat4(BzrDirFormat):
2285
1229
    """Bzr dir format 4.
2286
1230
 
2308
1252
        """See BzrDirFormat.get_converter()."""
2309
1253
        # there is one and only one upgrade path here.
2310
1254
        return ConvertBzrDir4To5()
2311
 
 
 
1255
        
2312
1256
    def initialize_on_transport(self, transport):
2313
1257
        """Format 4 branches cannot be created."""
2314
1258
        raise errors.UninitializableFormat(self)
2317
1261
        """Format 4 is not supported.
2318
1262
 
2319
1263
        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
 
1264
        conversion logic is expensive - so doing it on the fly was not 
2321
1265
        feasible.
2322
1266
        """
2323
1267
        return False
2324
1268
 
2325
 
    def network_name(self):
2326
 
        return self.get_format_string()
2327
 
 
2328
1269
    def _open(self, transport):
2329
1270
        """See BzrDirFormat._open."""
2330
1271
        return BzrDir4(transport, self)
2331
1272
 
2332
1273
    def __return_repository_format(self):
2333
1274
        """Circular import protection."""
2334
 
        from bzrlib.repofmt.weaverepo import RepositoryFormat4
 
1275
        from bzrlib.repository import RepositoryFormat4
2335
1276
        return RepositoryFormat4()
2336
1277
    repository_format = property(__return_repository_format)
2337
1278
 
2338
1279
 
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):
 
1280
class BzrDirFormat5(BzrDirFormat):
2365
1281
    """Bzr control format 5.
2366
1282
 
2367
1283
    This format is a combined format for working tree, branch and repository.
2368
1284
    It has:
2369
 
     - Format 2 working trees [always]
2370
 
     - Format 4 branches [always]
 
1285
     - Format 2 working trees [always] 
 
1286
     - Format 4 branches [always] 
2371
1287
     - Format 5 repositories [always]
2372
1288
       Unhashed stores in the repository.
2373
1289
    """
2378
1294
        """See BzrDirFormat.get_format_string()."""
2379
1295
        return "Bazaar-NG branch, format 5\n"
2380
1296
 
2381
 
    def get_branch_format(self):
2382
 
        from bzrlib import branch
2383
 
        return branch.BzrBranchFormat4()
2384
 
 
2385
1297
    def get_format_description(self):
2386
1298
        """See BzrDirFormat.get_format_description()."""
2387
1299
        return "All-in-one format 5"
2393
1305
 
2394
1306
    def _initialize_for_clone(self, url):
2395
1307
        return self.initialize_on_transport(get_transport(url), _cloning=True)
2396
 
 
 
1308
        
2397
1309
    def initialize_on_transport(self, transport, _cloning=False):
2398
1310
        """Format 5 dirs always have working tree, branch and repository.
2399
 
 
 
1311
        
2400
1312
        Except when they are being cloned.
2401
1313
        """
2402
1314
        from bzrlib.branch import BzrBranchFormat4
2403
 
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
 
1315
        from bzrlib.repository import RepositoryFormat5
 
1316
        from bzrlib.workingtree import WorkingTreeFormat2
2404
1317
        result = (super(BzrDirFormat5, self).initialize_on_transport(transport))
2405
1318
        RepositoryFormat5().initialize(result, _internal=True)
2406
1319
        if not _cloning:
2407
1320
            branch = BzrBranchFormat4().initialize(result)
2408
 
            result._init_workingtree()
 
1321
            try:
 
1322
                WorkingTreeFormat2().initialize(result)
 
1323
            except errors.NotLocalUrl:
 
1324
                # Even though we can't access the working tree, we need to
 
1325
                # create its control files.
 
1326
                WorkingTreeFormat2().stub_initialize_remote(branch.control_files)
2409
1327
        return result
2410
1328
 
2411
 
    def network_name(self):
2412
 
        return self.get_format_string()
2413
 
 
2414
1329
    def _open(self, transport):
2415
1330
        """See BzrDirFormat._open."""
2416
1331
        return BzrDir5(transport, self)
2417
1332
 
2418
1333
    def __return_repository_format(self):
2419
1334
        """Circular import protection."""
2420
 
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
 
1335
        from bzrlib.repository import RepositoryFormat5
2421
1336
        return RepositoryFormat5()
2422
1337
    repository_format = property(__return_repository_format)
2423
1338
 
2424
1339
 
2425
 
class BzrDirFormat6(BzrDirFormatAllInOne):
 
1340
class BzrDirFormat6(BzrDirFormat):
2426
1341
    """Bzr control format 6.
2427
1342
 
2428
1343
    This format is a combined format for working tree, branch and repository.
2429
1344
    It has:
2430
 
     - Format 2 working trees [always]
2431
 
     - Format 4 branches [always]
 
1345
     - Format 2 working trees [always] 
 
1346
     - Format 4 branches [always] 
2432
1347
     - Format 6 repositories [always]
2433
1348
    """
2434
1349
 
2442
1357
        """See BzrDirFormat.get_format_description()."""
2443
1358
        return "All-in-one format 6"
2444
1359
 
2445
 
    def get_branch_format(self):
2446
 
        from bzrlib import branch
2447
 
        return branch.BzrBranchFormat4()
2448
 
 
2449
1360
    def get_converter(self, format=None):
2450
1361
        """See BzrDirFormat.get_converter()."""
2451
1362
        # there is one and only one upgrade path here.
2452
1363
        return ConvertBzrDir6ToMeta()
2453
 
 
 
1364
        
2454
1365
    def _initialize_for_clone(self, url):
2455
1366
        return self.initialize_on_transport(get_transport(url), _cloning=True)
2456
1367
 
2457
1368
    def initialize_on_transport(self, transport, _cloning=False):
2458
1369
        """Format 6 dirs always have working tree, branch and repository.
2459
 
 
 
1370
        
2460
1371
        Except when they are being cloned.
2461
1372
        """
2462
1373
        from bzrlib.branch import BzrBranchFormat4
2463
 
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
 
1374
        from bzrlib.repository import RepositoryFormat6
 
1375
        from bzrlib.workingtree import WorkingTreeFormat2
2464
1376
        result = super(BzrDirFormat6, self).initialize_on_transport(transport)
2465
1377
        RepositoryFormat6().initialize(result, _internal=True)
2466
1378
        if not _cloning:
2467
1379
            branch = BzrBranchFormat4().initialize(result)
2468
 
            result._init_workingtree()
 
1380
            try:
 
1381
                WorkingTreeFormat2().initialize(result)
 
1382
            except errors.NotLocalUrl:
 
1383
                # Even though we can't access the working tree, we need to
 
1384
                # create its control files.
 
1385
                WorkingTreeFormat2().stub_initialize_remote(branch.control_files)
2469
1386
        return result
2470
1387
 
2471
 
    def network_name(self):
2472
 
        return self.get_format_string()
2473
 
 
2474
1388
    def _open(self, transport):
2475
1389
        """See BzrDirFormat._open."""
2476
1390
        return BzrDir6(transport, self)
2477
1391
 
2478
1392
    def __return_repository_format(self):
2479
1393
        """Circular import protection."""
2480
 
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
 
1394
        from bzrlib.repository import RepositoryFormat6
2481
1395
        return RepositoryFormat6()
2482
1396
    repository_format = property(__return_repository_format)
2483
1397
 
2495
1409
 
2496
1410
    _lock_class = lockdir.LockDir
2497
1411
 
2498
 
    def __init__(self):
2499
 
        self._workingtree_format = None
2500
 
        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
 
 
2515
 
    def get_branch_format(self):
2516
 
        if self._branch_format is None:
2517
 
            from bzrlib.branch import BranchFormat
2518
 
            self._branch_format = BranchFormat.get_default_format()
2519
 
        return self._branch_format
2520
 
 
2521
 
    def set_branch_format(self, format):
2522
 
        self._branch_format = format
2523
 
 
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
1412
    def get_converter(self, format=None):
2617
1413
        """See BzrDirFormat.get_converter()."""
2618
1414
        if format is None:
2630
1426
        """See BzrDirFormat.get_format_description()."""
2631
1427
        return "Meta directory format 1"
2632
1428
 
2633
 
    def network_name(self):
2634
 
        return self.get_format_string()
2635
 
 
2636
1429
    def _open(self, transport):
2637
1430
        """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)
 
1431
        return BzrDirMeta1(transport, self)
2644
1432
 
2645
1433
    def __return_repository_format(self):
2646
1434
        """Circular import protection."""
2647
 
        if self._repository_format:
 
1435
        if getattr(self, '_repository_format', None):
2648
1436
            return self._repository_format
2649
1437
        from bzrlib.repository import RepositoryFormat
2650
1438
        return RepositoryFormat.get_default_format()
2651
1439
 
2652
 
    def _set_repository_format(self, value):
2653
 
        """Allow changing the repository format for metadir formats."""
 
1440
    def __set_repository_format(self, value):
 
1441
        """Allow changint the repository format for metadir formats."""
2654
1442
        self._repository_format = value
2655
1443
 
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
 
1444
    repository_format = property(__return_repository_format, __set_repository_format)
 
1445
 
 
1446
 
2703
1447
BzrDirFormat.register_format(BzrDirFormat4())
2704
1448
BzrDirFormat.register_format(BzrDirFormat5())
2705
1449
BzrDirFormat.register_format(BzrDirFormat6())
2706
1450
__default_format = BzrDirMetaFormat1()
2707
1451
BzrDirFormat.register_format(__default_format)
2708
 
BzrDirFormat._default_format = __default_format
 
1452
BzrDirFormat.set_default_format(__default_format)
 
1453
 
 
1454
 
 
1455
class BzrDirTestProviderAdapter(object):
 
1456
    """A tool to generate a suite testing multiple bzrdir formats at once.
 
1457
 
 
1458
    This is done by copying the test once for each transport and injecting
 
1459
    the transport_server, transport_readonly_server, and bzrdir_format
 
1460
    classes into each copy. Each copy is also given a new id() to make it
 
1461
    easy to identify.
 
1462
    """
 
1463
 
 
1464
    def __init__(self, transport_server, transport_readonly_server, formats):
 
1465
        self._transport_server = transport_server
 
1466
        self._transport_readonly_server = transport_readonly_server
 
1467
        self._formats = formats
 
1468
    
 
1469
    def adapt(self, test):
 
1470
        result = unittest.TestSuite()
 
1471
        for format in self._formats:
 
1472
            new_test = deepcopy(test)
 
1473
            new_test.transport_server = self._transport_server
 
1474
            new_test.transport_readonly_server = self._transport_readonly_server
 
1475
            new_test.bzrdir_format = format
 
1476
            def make_new_test_id():
 
1477
                new_id = "%s(%s)" % (new_test.id(), format.__class__.__name__)
 
1478
                return lambda: new_id
 
1479
            new_test.id = make_new_test_id()
 
1480
            result.addTest(new_test)
 
1481
        return result
2709
1482
 
2710
1483
 
2711
1484
class Converter(object):
2733
1506
        self.absent_revisions = set()
2734
1507
        self.text_count = 0
2735
1508
        self.revisions = {}
2736
 
 
 
1509
        
2737
1510
    def convert(self, to_convert, pb):
2738
1511
        """See Converter.convert()."""
2739
1512
        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()
 
1513
        self.pb = pb
 
1514
        self.pb.note('starting upgrade from format 4 to 5')
 
1515
        if isinstance(self.bzrdir.transport, LocalTransport):
 
1516
            self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
 
1517
        self._convert_to_weaves()
 
1518
        return BzrDir.open(self.bzrdir.root_transport.base)
2751
1519
 
2752
1520
    def _convert_to_weaves(self):
2753
 
        ui.ui_factory.note('note: upgrade may be faster if all store files are ungzipped first')
 
1521
        self.pb.note('note: upgrade may be faster if all store files are ungzipped first')
2754
1522
        try:
2755
1523
            # TODO permissions
2756
1524
            stat = self.bzrdir.transport.stat('weaves')
2784
1552
        self.pb.clear()
2785
1553
        self._write_all_weaves()
2786
1554
        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)
 
1555
        self.pb.note('upgraded to weaves:')
 
1556
        self.pb.note('  %6d revisions and inventories', len(self.revisions))
 
1557
        self.pb.note('  %6d revisions not present', len(self.absent_revisions))
 
1558
        self.pb.note('  %6d texts', self.text_count)
2791
1559
        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())
 
1560
        self.branch.control_files.put_utf8('branch-format', BzrDirFormat5().get_format_string())
2796
1561
 
2797
1562
    def _cleanup_spare_files_after_format4(self):
2798
1563
        # FIXME working tree upgrade foo.
2807
1572
 
2808
1573
    def _convert_working_inv(self):
2809
1574
        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())
 
1575
                    self.branch.control_files.get('inventory'))
 
1576
        new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
 
1577
        # FIXME inventory is a working tree change.
 
1578
        self.branch.control_files.put('inventory', StringIO(new_inv_xml))
2814
1579
 
2815
1580
    def _write_all_weaves(self):
2816
1581
        controlweaves = WeaveStore(self.bzrdir.transport, prefixed=False)
2836
1601
        self.bzrdir.transport.mkdir('revision-store')
2837
1602
        revision_transport = self.bzrdir.transport.clone('revision-store')
2838
1603
        # 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)
 
1604
        _revision_store = TextRevisionStore(TextStore(revision_transport,
 
1605
                                                      prefixed=False,
 
1606
                                                      compressed=True))
2844
1607
        try:
 
1608
            transaction = WriteTransaction()
2845
1609
            for i, rev_id in enumerate(self.converted_revs):
2846
1610
                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))
 
1611
                _revision_store.add_revision(self.revisions[rev_id], transaction)
2851
1612
        finally:
2852
1613
            self.pb.clear()
2853
 
 
 
1614
            
2854
1615
    def _load_one_rev(self, rev_id):
2855
1616
        """Load a revision object into memory.
2856
1617
 
2861
1622
                       len(self.known_revisions))
2862
1623
        if not self.branch.repository.has_revision(rev_id):
2863
1624
            self.pb.clear()
2864
 
            ui.ui_factory.note('revision {%s} not present in branch; '
2865
 
                         'will be converted as a ghost' %
 
1625
            self.pb.note('revision {%s} not present in branch; '
 
1626
                         'will be converted as a ghost',
2866
1627
                         rev_id)
2867
1628
            self.absent_revisions.add(rev_id)
2868
1629
        else:
2869
 
            rev = self.branch.repository.get_revision(rev_id)
 
1630
            rev = self.branch.repository._revision_store.get_revision(rev_id,
 
1631
                self.branch.repository.get_transaction())
2870
1632
            for parent_id in rev.parent_ids:
2871
1633
                self.known_revisions.add(parent_id)
2872
1634
                self.to_read.append(parent_id)
2873
1635
            self.revisions[rev_id] = rev
2874
1636
 
2875
1637
    def _load_old_inventory(self, rev_id):
 
1638
        assert rev_id not in self.converted_revs
2876
1639
        old_inv_xml = self.branch.repository.inventory_store.get(rev_id).read()
2877
1640
        inv = xml4.serializer_v4.read_inventory_from_string(old_inv_xml)
2878
1641
        inv.revision_id = rev_id
2879
1642
        rev = self.revisions[rev_id]
 
1643
        if rev.inventory_sha1:
 
1644
            assert rev.inventory_sha1 == sha_string(old_inv_xml), \
 
1645
                'inventory sha mismatch for {%s}' % rev_id
2880
1646
        return inv
2881
1647
 
2882
1648
    def _load_updated_inventory(self, rev_id):
 
1649
        assert rev_id in self.converted_revs
2883
1650
        inv_xml = self.inv_weave.get_text(rev_id)
2884
 
        inv = xml5.serializer_v5.read_inventory_from_string(inv_xml, rev_id)
 
1651
        inv = xml5.serializer_v5.read_inventory_from_string(inv_xml)
2885
1652
        return inv
2886
1653
 
2887
1654
    def _convert_one_rev(self, rev_id):
2891
1658
        present_parents = [p for p in rev.parent_ids
2892
1659
                           if p not in self.absent_revisions]
2893
1660
        self._convert_revision_contents(rev, inv, present_parents)
2894
 
        self._store_new_inv(rev, inv, present_parents)
 
1661
        self._store_new_weave(rev, inv, present_parents)
2895
1662
        self.converted_revs.add(rev_id)
2896
1663
 
2897
 
    def _store_new_inv(self, rev, inv, present_parents):
 
1664
    def _store_new_weave(self, rev, inv, present_parents):
 
1665
        # the XML is now updated with text versions
 
1666
        if __debug__:
 
1667
            entries = inv.iter_entries()
 
1668
            entries.next()
 
1669
            for path, ie in entries:
 
1670
                assert getattr(ie, 'revision', None) is not None, \
 
1671
                    'no revision on {%s} in {%s}' % \
 
1672
                    (file_id, rev.revision_id)
2898
1673
        new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
2899
1674
        new_inv_sha1 = sha_string(new_inv_xml)
2900
 
        self.inv_weave.add_lines(rev.revision_id,
 
1675
        self.inv_weave.add_lines(rev.revision_id, 
2901
1676
                                 present_parents,
2902
1677
                                 new_inv_xml.splitlines(True))
2903
1678
        rev.inventory_sha1 = new_inv_sha1
2928
1703
            w = Weave(file_id)
2929
1704
            self.text_weaves[file_id] = w
2930
1705
        text_changed = False
2931
 
        parent_candiate_entries = ie.parent_candidates(parent_invs)
2932
 
        heads = graph.Graph(self).heads(parent_candiate_entries.keys())
2933
 
        # XXX: Note that this is unordered - and this is tolerable because
2934
 
        # the previous code was also unordered.
2935
 
        previous_entries = dict((head, parent_candiate_entries[head]) for head
2936
 
            in heads)
 
1706
        previous_entries = ie.find_previous_heads(parent_invs,
 
1707
                                                  None,
 
1708
                                                  None,
 
1709
                                                  entry_vf=w)
 
1710
        for old_revision in previous_entries:
 
1711
                # if this fails, its a ghost ?
 
1712
                assert old_revision in self.converted_revs, \
 
1713
                    "Revision {%s} not in converted_revs" % old_revision
2937
1714
        self.snapshot_ie(previous_entries, ie, w, rev_id)
2938
1715
        del ie.text_id
2939
 
 
2940
 
    def get_parent_map(self, revision_ids):
2941
 
        """See graph.StackedParentsProvider.get_parent_map"""
2942
 
        return dict((revision_id, self.revisions[revision_id])
2943
 
                    for revision_id in revision_ids
2944
 
                     if revision_id in self.revisions)
 
1716
        assert getattr(ie, 'revision', None) is not None
2945
1717
 
2946
1718
    def snapshot_ie(self, previous_revisions, ie, w, rev_id):
2947
1719
        # TODO: convert this logic, which is ~= snapshot to
2948
1720
        # a call to:. This needs the path figured out. rather than a work_tree
2949
1721
        # a v4 revision_tree can be given, or something that looks enough like
2950
1722
        # one to give the file content to the entry if it needs it.
2951
 
        # and we need something that looks like a weave store for snapshot to
 
1723
        # and we need something that looks like a weave store for snapshot to 
2952
1724
        # save against.
2953
1725
        #ie.snapshot(rev, PATH, previous_revisions, REVISION_TREE, InMemoryWeaveStore(self.text_weaves))
2954
1726
        if len(previous_revisions) == 1:
2957
1729
                ie.revision = previous_ie.revision
2958
1730
                return
2959
1731
        if ie.has_text():
2960
 
            text = self.branch.repository._text_store.get(ie.text_id)
 
1732
            text = self.branch.repository.text_store.get(ie.text_id)
2961
1733
            file_lines = text.readlines()
 
1734
            assert sha_strings(file_lines) == ie.text_sha1
 
1735
            assert sum(map(len, file_lines)) == ie.text_size
2962
1736
            w.add_lines(rev_id, previous_revisions, file_lines)
2963
1737
            self.text_count += 1
2964
1738
        else:
2994
1768
    def convert(self, to_convert, pb):
2995
1769
        """See Converter.convert()."""
2996
1770
        self.bzrdir = to_convert
2997
 
        pb = ui.ui_factory.nested_progress_bar()
2998
 
        try:
2999
 
            ui.ui_factory.note('starting upgrade from format 5 to 6')
3000
 
            self._convert_to_prefixed()
3001
 
            return BzrDir.open(self.bzrdir.user_url)
3002
 
        finally:
3003
 
            pb.finished()
 
1771
        self.pb = pb
 
1772
        self.pb.note('starting upgrade from format 5 to 6')
 
1773
        self._convert_to_prefixed()
 
1774
        return BzrDir.open(self.bzrdir.root_transport.base)
3004
1775
 
3005
1776
    def _convert_to_prefixed(self):
3006
1777
        from bzrlib.store import TransportStore
3007
1778
        self.bzrdir.transport.delete('branch-format')
3008
1779
        for store_name in ["weaves", "revision-store"]:
3009
 
            ui.ui_factory.note("adding prefixes to %s" % store_name)
 
1780
            self.pb.note("adding prefixes to %s" % store_name)
3010
1781
            store_transport = self.bzrdir.transport.clone(store_name)
3011
1782
            store = TransportStore(store_transport, prefixed=True)
3012
1783
            for urlfilename in store_transport.list_dir('.'):
3014
1785
                if (filename.endswith(".weave") or
3015
1786
                    filename.endswith(".gz") or
3016
1787
                    filename.endswith(".sig")):
3017
 
                    file_id, suffix = os.path.splitext(filename)
 
1788
                    file_id = os.path.splitext(filename)[0]
3018
1789
                else:
3019
1790
                    file_id = filename
3020
 
                    suffix = ''
3021
 
                new_name = store._mapper.map((file_id,)) + suffix
 
1791
                prefix_dir = store.hash_prefix(file_id)
3022
1792
                # FIXME keep track of the dirs made RBC 20060121
3023
1793
                try:
3024
 
                    store_transport.move(filename, new_name)
 
1794
                    store_transport.move(filename, prefix_dir + '/' + filename)
3025
1795
                except errors.NoSuchFile: # catches missing dirs strangely enough
3026
 
                    store_transport.mkdir(osutils.dirname(new_name))
3027
 
                    store_transport.move(filename, new_name)
3028
 
        self.bzrdir.transport.put_bytes(
3029
 
            'branch-format',
3030
 
            BzrDirFormat6().get_format_string(),
3031
 
            mode=self.bzrdir._get_file_mode())
 
1796
                    store_transport.mkdir(prefix_dir)
 
1797
                    store_transport.move(filename, prefix_dir + '/' + filename)
 
1798
        self.bzrdir._control_files.put_utf8('branch-format', BzrDirFormat6().get_format_string())
3032
1799
 
3033
1800
 
3034
1801
class ConvertBzrDir6ToMeta(Converter):
3036
1803
 
3037
1804
    def convert(self, to_convert, pb):
3038
1805
        """See Converter.convert()."""
3039
 
        from bzrlib.repofmt.weaverepo import RepositoryFormat7
3040
 
        from bzrlib.branch import BzrBranchFormat5
3041
1806
        self.bzrdir = to_convert
3042
 
        self.pb = ui.ui_factory.nested_progress_bar()
 
1807
        self.pb = pb
3043
1808
        self.count = 0
3044
1809
        self.total = 20 # the steps we know about
3045
1810
        self.garbage_inventories = []
3046
 
        self.dir_mode = self.bzrdir._get_dir_mode()
3047
 
        self.file_mode = self.bzrdir._get_file_mode()
3048
1811
 
3049
 
        ui.ui_factory.note('starting upgrade from format 6 to metadir')
3050
 
        self.bzrdir.transport.put_bytes(
3051
 
                'branch-format',
3052
 
                "Converting to format 6",
3053
 
                mode=self.file_mode)
 
1812
        self.pb.note('starting upgrade from format 6 to metadir')
 
1813
        self.bzrdir._control_files.put_utf8('branch-format', "Converting to format 6")
3054
1814
        # its faster to move specific files around than to open and use the apis...
3055
1815
        # first off, nuke ancestry.weave, it was never used.
3056
1816
        try:
3066
1826
            if name.startswith('basis-inventory.'):
3067
1827
                self.garbage_inventories.append(name)
3068
1828
        # create new directories for repository, working tree and branch
 
1829
        self.dir_mode = self.bzrdir._control_files._dir_mode
 
1830
        self.file_mode = self.bzrdir._control_files._file_mode
3069
1831
        repository_names = [('inventory.weave', True),
3070
1832
                            ('revision-store', True),
3071
1833
                            ('weaves', True)]
3073
1835
        self.bzrdir.transport.mkdir('repository', mode=self.dir_mode)
3074
1836
        self.make_lock('repository')
3075
1837
        # we hard code the formats here because we are converting into
3076
 
        # the meta format. The meta format upgrader can take this to a
 
1838
        # the meta format. The meta format upgrader can take this to a 
3077
1839
        # future format within each component.
3078
 
        self.put_format('repository', RepositoryFormat7())
 
1840
        self.put_format('repository', bzrlib.repository.RepositoryFormat7())
3079
1841
        for entry in repository_names:
3080
1842
            self.move_entry('repository', entry)
3081
1843
 
3082
1844
        self.step('Upgrading branch      ')
3083
1845
        self.bzrdir.transport.mkdir('branch', mode=self.dir_mode)
3084
1846
        self.make_lock('branch')
3085
 
        self.put_format('branch', BzrBranchFormat5())
 
1847
        self.put_format('branch', bzrlib.branch.BzrBranchFormat5())
3086
1848
        branch_files = [('revision-history', True),
3087
1849
                        ('branch-name', True),
3088
1850
                        ('parent', False)]
3102
1864
        else:
3103
1865
            has_checkout = True
3104
1866
        if not has_checkout:
3105
 
            ui.ui_factory.note('No working tree.')
 
1867
            self.pb.note('No working tree.')
3106
1868
            # If some checkout files are there, we may as well get rid of them.
3107
1869
            for name, mandatory in checkout_files:
3108
1870
                if name in bzrcontents:
3109
1871
                    self.bzrdir.transport.delete(name)
3110
1872
        else:
3111
 
            from bzrlib.workingtree import WorkingTreeFormat3
3112
1873
            self.step('Upgrading working tree')
3113
1874
            self.bzrdir.transport.mkdir('checkout', mode=self.dir_mode)
3114
1875
            self.make_lock('checkout')
3115
1876
            self.put_format(
3116
 
                'checkout', WorkingTreeFormat3())
 
1877
                'checkout', bzrlib.workingtree.WorkingTreeFormat3())
3117
1878
            self.bzrdir.transport.delete_multi(
3118
1879
                self.garbage_inventories, self.pb)
3119
1880
            for entry in checkout_files:
3120
1881
                self.move_entry('checkout', entry)
3121
1882
            if last_revision is not None:
3122
 
                self.bzrdir.transport.put_bytes(
 
1883
                self.bzrdir._control_files.put_utf8(
3123
1884
                    'checkout/last-revision', last_revision)
3124
 
        self.bzrdir.transport.put_bytes(
3125
 
            'branch-format',
3126
 
            BzrDirMetaFormat1().get_format_string(),
3127
 
            mode=self.file_mode)
3128
 
        self.pb.finished()
3129
 
        return BzrDir.open(self.bzrdir.user_url)
 
1885
        self.bzrdir._control_files.put_utf8(
 
1886
            'branch-format', BzrDirMetaFormat1().get_format_string())
 
1887
        return BzrDir.open(self.bzrdir.root_transport.base)
3130
1888
 
3131
1889
    def make_lock(self, name):
3132
1890
        """Make a lock for the new control dir name."""
3149
1907
                raise
3150
1908
 
3151
1909
    def put_format(self, dirname, format):
3152
 
        self.bzrdir.transport.put_bytes('%s/format' % dirname,
3153
 
            format.get_format_string(),
3154
 
            self.file_mode)
 
1910
        self.bzrdir._control_files.put_utf8('%s/format' % dirname, format.get_format_string())
3155
1911
 
3156
1912
 
3157
1913
class ConvertMetaToMeta(Converter):
3167
1923
    def convert(self, to_convert, pb):
3168
1924
        """See Converter.convert()."""
3169
1925
        self.bzrdir = to_convert
3170
 
        self.pb = ui.ui_factory.nested_progress_bar()
 
1926
        self.pb = pb
3171
1927
        self.count = 0
3172
1928
        self.total = 1
3173
1929
        self.step('checking repository format')
3178
1934
        else:
3179
1935
            if not isinstance(repo._format, self.target_format.repository_format.__class__):
3180
1936
                from bzrlib.repository import CopyConverter
3181
 
                ui.ui_factory.note('starting repository conversion')
 
1937
                self.pb.note('starting repository conversion')
3182
1938
                converter = CopyConverter(self.target_format.repository_format)
3183
1939
                converter.convert(repo, pb)
3184
 
        for branch in self.bzrdir.list_branches():
3185
 
            # TODO: conversions of Branch and Tree should be done by
3186
 
            # InterXFormat lookups/some sort of registry.
3187
 
            # Avoid circular imports
3188
 
            from bzrlib import branch as _mod_branch
3189
 
            old = branch._format.__class__
3190
 
            new = self.target_format.get_branch_format().__class__
3191
 
            while old != new:
3192
 
                if (old == _mod_branch.BzrBranchFormat5 and
3193
 
                    new in (_mod_branch.BzrBranchFormat6,
3194
 
                        _mod_branch.BzrBranchFormat7,
3195
 
                        _mod_branch.BzrBranchFormat8)):
3196
 
                    branch_converter = _mod_branch.Converter5to6()
3197
 
                elif (old == _mod_branch.BzrBranchFormat6 and
3198
 
                    new in (_mod_branch.BzrBranchFormat7,
3199
 
                            _mod_branch.BzrBranchFormat8)):
3200
 
                    branch_converter = _mod_branch.Converter6to7()
3201
 
                elif (old == _mod_branch.BzrBranchFormat7 and
3202
 
                      new is _mod_branch.BzrBranchFormat8):
3203
 
                    branch_converter = _mod_branch.Converter7to8()
3204
 
                else:
3205
 
                    raise errors.BadConversionTarget("No converter", new,
3206
 
                        branch._format)
3207
 
                branch_converter.convert(branch)
3208
 
                branch = self.bzrdir.open_branch()
3209
 
                old = branch._format.__class__
3210
 
        try:
3211
 
            tree = self.bzrdir.open_workingtree(recommend_upgrade=False)
3212
 
        except (errors.NoWorkingTree, errors.NotLocalUrl):
3213
 
            pass
3214
 
        else:
3215
 
            # TODO: conversions of Branch and Tree should be done by
3216
 
            # InterXFormat lookups
3217
 
            if (isinstance(tree, workingtree.WorkingTree3) and
3218
 
                not isinstance(tree, workingtree_4.DirStateWorkingTree) and
3219
 
                isinstance(self.target_format.workingtree_format,
3220
 
                    workingtree_4.DirStateWorkingTreeFormat)):
3221
 
                workingtree_4.Converter3to4().convert(tree)
3222
 
            if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
3223
 
                not isinstance(tree, workingtree_4.WorkingTree5) and
3224
 
                isinstance(self.target_format.workingtree_format,
3225
 
                    workingtree_4.WorkingTreeFormat5)):
3226
 
                workingtree_4.Converter4to5().convert(tree)
3227
 
            if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
3228
 
                not isinstance(tree, workingtree_4.WorkingTree6) and
3229
 
                isinstance(self.target_format.workingtree_format,
3230
 
                    workingtree_4.WorkingTreeFormat6)):
3231
 
                workingtree_4.Converter4or5to6().convert(tree)
3232
 
        self.pb.finished()
3233
1940
        return to_convert
3234
 
 
3235
 
 
3236
 
# This is not in remote.py because it's relatively small, and needs to be
3237
 
# registered. Putting it in remote.py creates a circular import problem.
3238
 
# we can make it a lazy object if the control formats is turned into something
3239
 
# like a registry.
3240
 
class RemoteBzrDirFormat(BzrDirMetaFormat1):
3241
 
    """Format representing bzrdirs accessed via a smart server"""
3242
 
 
3243
 
    def __init__(self):
3244
 
        BzrDirMetaFormat1.__init__(self)
3245
 
        # XXX: It's a bit ugly that the network name is here, because we'd
3246
 
        # like to believe that format objects are stateless or at least
3247
 
        # immutable,  However, we do at least avoid mutating the name after
3248
 
        # it's returned.  See <https://bugs.edge.launchpad.net/bzr/+bug/504102>
3249
 
        self._network_name = None
3250
 
 
3251
 
    def __repr__(self):
3252
 
        return "%s(_network_name=%r)" % (self.__class__.__name__,
3253
 
            self._network_name)
3254
 
 
3255
 
    def get_format_description(self):
3256
 
        if self._network_name:
3257
 
            real_format = network_format_registry.get(self._network_name)
3258
 
            return 'Remote: ' + real_format.get_format_description()
3259
 
        return 'bzr remote bzrdir'
3260
 
 
3261
 
    def get_format_string(self):
3262
 
        raise NotImplementedError(self.get_format_string)
3263
 
 
3264
 
    def network_name(self):
3265
 
        if self._network_name:
3266
 
            return self._network_name
3267
 
        else:
3268
 
            raise AssertionError("No network name set.")
3269
 
 
3270
 
    @classmethod
3271
 
    def probe_transport(klass, transport):
3272
 
        """Return a RemoteBzrDirFormat object if it looks possible."""
3273
 
        try:
3274
 
            medium = transport.get_smart_medium()
3275
 
        except (NotImplementedError, AttributeError,
3276
 
                errors.TransportNotPossible, errors.NoSmartMedium,
3277
 
                errors.SmartProtocolError):
3278
 
            # no smart server, so not a branch for this format type.
3279
 
            raise errors.NotBranchError(path=transport.base)
3280
 
        else:
3281
 
            # Decline to open it if the server doesn't support our required
3282
 
            # version (3) so that the VFS-based transport will do it.
3283
 
            if medium.should_probe():
3284
 
                try:
3285
 
                    server_version = medium.protocol_version()
3286
 
                except errors.SmartProtocolError:
3287
 
                    # Apparently there's no usable smart server there, even though
3288
 
                    # the medium supports the smart protocol.
3289
 
                    raise errors.NotBranchError(path=transport.base)
3290
 
                if server_version != '2':
3291
 
                    raise errors.NotBranchError(path=transport.base)
3292
 
            return klass()
3293
 
 
3294
 
    def initialize_on_transport(self, transport):
3295
 
        try:
3296
 
            # hand off the request to the smart server
3297
 
            client_medium = transport.get_smart_medium()
3298
 
        except errors.NoSmartMedium:
3299
 
            # TODO: lookup the local format from a server hint.
3300
 
            local_dir_format = BzrDirMetaFormat1()
3301
 
            return local_dir_format.initialize_on_transport(transport)
3302
 
        client = _SmartClient(client_medium)
3303
 
        path = client.remote_path_from_transport(transport)
3304
 
        try:
3305
 
            response = client.call('BzrDirFormat.initialize', path)
3306
 
        except errors.ErrorFromSmartServer, err:
3307
 
            remote._translate_error(err, path=path)
3308
 
        if response[0] != 'ok':
3309
 
            raise errors.SmartProtocolError('unexpected response code %s' % (response,))
3310
 
        format = RemoteBzrDirFormat()
3311
 
        self._supply_sub_formats_to(format)
3312
 
        return remote.RemoteBzrDir(transport, format)
3313
 
 
3314
 
    def parse_NoneTrueFalse(self, arg):
3315
 
        if not arg:
3316
 
            return None
3317
 
        if arg == 'False':
3318
 
            return False
3319
 
        if arg == 'True':
3320
 
            return True
3321
 
        raise AssertionError("invalid arg %r" % arg)
3322
 
 
3323
 
    def _serialize_NoneTrueFalse(self, arg):
3324
 
        if arg is False:
3325
 
            return 'False'
3326
 
        if arg:
3327
 
            return 'True'
3328
 
        return ''
3329
 
 
3330
 
    def _serialize_NoneString(self, arg):
3331
 
        return arg or ''
3332
 
 
3333
 
    def initialize_on_transport_ex(self, transport, use_existing_dir=False,
3334
 
        create_prefix=False, force_new_repo=False, stacked_on=None,
3335
 
        stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
3336
 
        shared_repo=False):
3337
 
        try:
3338
 
            # hand off the request to the smart server
3339
 
            client_medium = transport.get_smart_medium()
3340
 
        except errors.NoSmartMedium:
3341
 
            do_vfs = True
3342
 
        else:
3343
 
            # Decline to open it if the server doesn't support our required
3344
 
            # version (3) so that the VFS-based transport will do it.
3345
 
            if client_medium.should_probe():
3346
 
                try:
3347
 
                    server_version = client_medium.protocol_version()
3348
 
                    if server_version != '2':
3349
 
                        do_vfs = True
3350
 
                    else:
3351
 
                        do_vfs = False
3352
 
                except errors.SmartProtocolError:
3353
 
                    # Apparently there's no usable smart server there, even though
3354
 
                    # the medium supports the smart protocol.
3355
 
                    do_vfs = True
3356
 
            else:
3357
 
                do_vfs = False
3358
 
        if not do_vfs:
3359
 
            client = _SmartClient(client_medium)
3360
 
            path = client.remote_path_from_transport(transport)
3361
 
            if client_medium._is_remote_before((1, 16)):
3362
 
                do_vfs = True
3363
 
        if do_vfs:
3364
 
            # TODO: lookup the local format from a server hint.
3365
 
            local_dir_format = BzrDirMetaFormat1()
3366
 
            self._supply_sub_formats_to(local_dir_format)
3367
 
            return local_dir_format.initialize_on_transport_ex(transport,
3368
 
                use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3369
 
                force_new_repo=force_new_repo, stacked_on=stacked_on,
3370
 
                stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3371
 
                make_working_trees=make_working_trees, shared_repo=shared_repo,
3372
 
                vfs_only=True)
3373
 
        return self._initialize_on_transport_ex_rpc(client, path, transport,
3374
 
            use_existing_dir, create_prefix, force_new_repo, stacked_on,
3375
 
            stack_on_pwd, repo_format_name, make_working_trees, shared_repo)
3376
 
 
3377
 
    def _initialize_on_transport_ex_rpc(self, client, path, transport,
3378
 
        use_existing_dir, create_prefix, force_new_repo, stacked_on,
3379
 
        stack_on_pwd, repo_format_name, make_working_trees, shared_repo):
3380
 
        args = []
3381
 
        args.append(self._serialize_NoneTrueFalse(use_existing_dir))
3382
 
        args.append(self._serialize_NoneTrueFalse(create_prefix))
3383
 
        args.append(self._serialize_NoneTrueFalse(force_new_repo))
3384
 
        args.append(self._serialize_NoneString(stacked_on))
3385
 
        # stack_on_pwd is often/usually our transport
3386
 
        if stack_on_pwd:
3387
 
            try:
3388
 
                stack_on_pwd = transport.relpath(stack_on_pwd)
3389
 
                if not stack_on_pwd:
3390
 
                    stack_on_pwd = '.'
3391
 
            except errors.PathNotChild:
3392
 
                pass
3393
 
        args.append(self._serialize_NoneString(stack_on_pwd))
3394
 
        args.append(self._serialize_NoneString(repo_format_name))
3395
 
        args.append(self._serialize_NoneTrueFalse(make_working_trees))
3396
 
        args.append(self._serialize_NoneTrueFalse(shared_repo))
3397
 
        request_network_name = self._network_name or \
3398
 
            BzrDirFormat.get_default_format().network_name()
3399
 
        try:
3400
 
            response = client.call('BzrDirFormat.initialize_ex_1.16',
3401
 
                request_network_name, path, *args)
3402
 
        except errors.UnknownSmartMethod:
3403
 
            client._medium._remember_remote_is_before((1,16))
3404
 
            local_dir_format = BzrDirMetaFormat1()
3405
 
            self._supply_sub_formats_to(local_dir_format)
3406
 
            return local_dir_format.initialize_on_transport_ex(transport,
3407
 
                use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3408
 
                force_new_repo=force_new_repo, stacked_on=stacked_on,
3409
 
                stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3410
 
                make_working_trees=make_working_trees, shared_repo=shared_repo,
3411
 
                vfs_only=True)
3412
 
        except errors.ErrorFromSmartServer, err:
3413
 
            remote._translate_error(err, path=path)
3414
 
        repo_path = response[0]
3415
 
        bzrdir_name = response[6]
3416
 
        require_stacking = response[7]
3417
 
        require_stacking = self.parse_NoneTrueFalse(require_stacking)
3418
 
        format = RemoteBzrDirFormat()
3419
 
        format._network_name = bzrdir_name
3420
 
        self._supply_sub_formats_to(format)
3421
 
        bzrdir = remote.RemoteBzrDir(transport, format, _client=client)
3422
 
        if repo_path:
3423
 
            repo_format = remote.response_tuple_to_repo_format(response[1:])
3424
 
            if repo_path == '.':
3425
 
                repo_path = ''
3426
 
            if repo_path:
3427
 
                repo_bzrdir_format = RemoteBzrDirFormat()
3428
 
                repo_bzrdir_format._network_name = response[5]
3429
 
                repo_bzr = remote.RemoteBzrDir(transport.clone(repo_path),
3430
 
                    repo_bzrdir_format)
3431
 
            else:
3432
 
                repo_bzr = bzrdir
3433
 
            final_stack = response[8] or None
3434
 
            final_stack_pwd = response[9] or None
3435
 
            if final_stack_pwd:
3436
 
                final_stack_pwd = urlutils.join(
3437
 
                    transport.base, final_stack_pwd)
3438
 
            remote_repo = remote.RemoteRepository(repo_bzr, repo_format)
3439
 
            if len(response) > 10:
3440
 
                # Updated server verb that locks remotely.
3441
 
                repo_lock_token = response[10] or None
3442
 
                remote_repo.lock_write(repo_lock_token, _skip_rpc=True)
3443
 
                if repo_lock_token:
3444
 
                    remote_repo.dont_leave_lock_in_place()
3445
 
            else:
3446
 
                remote_repo.lock_write()
3447
 
            policy = UseExistingRepository(remote_repo, final_stack,
3448
 
                final_stack_pwd, require_stacking)
3449
 
            policy.acquire_repository()
3450
 
        else:
3451
 
            remote_repo = None
3452
 
            policy = None
3453
 
        bzrdir._format.set_branch_format(self.get_branch_format())
3454
 
        if require_stacking:
3455
 
            # The repo has already been created, but we need to make sure that
3456
 
            # we'll make a stackable branch.
3457
 
            bzrdir._format.require_stacking(_skip_repo=True)
3458
 
        return remote_repo, bzrdir, require_stacking, policy
3459
 
 
3460
 
    def _open(self, transport):
3461
 
        return remote.RemoteBzrDir(transport, self)
3462
 
 
3463
 
    def __eq__(self, other):
3464
 
        if not isinstance(other, RemoteBzrDirFormat):
3465
 
            return False
3466
 
        return self.get_format_description() == other.get_format_description()
3467
 
 
3468
 
    def __return_repository_format(self):
3469
 
        # Always return a RemoteRepositoryFormat object, but if a specific bzr
3470
 
        # repository format has been asked for, tell the RemoteRepositoryFormat
3471
 
        # that it should use that for init() etc.
3472
 
        result = remote.RemoteRepositoryFormat()
3473
 
        custom_format = getattr(self, '_repository_format', None)
3474
 
        if custom_format:
3475
 
            if isinstance(custom_format, remote.RemoteRepositoryFormat):
3476
 
                return custom_format
3477
 
            else:
3478
 
                # We will use the custom format to create repositories over the
3479
 
                # wire; expose its details like rich_root_data for code to
3480
 
                # query
3481
 
                result._custom_format = custom_format
3482
 
        return result
3483
 
 
3484
 
    def get_branch_format(self):
3485
 
        result = BzrDirMetaFormat1.get_branch_format(self)
3486
 
        if not isinstance(result, remote.RemoteBranchFormat):
3487
 
            new_result = remote.RemoteBranchFormat()
3488
 
            new_result._custom_format = result
3489
 
            # cache the result
3490
 
            self.set_branch_format(new_result)
3491
 
            result = new_result
3492
 
        return result
3493
 
 
3494
 
    repository_format = property(__return_repository_format,
3495
 
        BzrDirMetaFormat1._set_repository_format) #.im_func)
3496
 
 
3497
 
 
3498
 
BzrDirFormat.register_control_server_format(RemoteBzrDirFormat)
3499
 
 
3500
 
 
3501
 
class BzrDirFormatInfo(object):
3502
 
 
3503
 
    def __init__(self, native, deprecated, hidden, experimental):
3504
 
        self.deprecated = deprecated
3505
 
        self.native = native
3506
 
        self.hidden = hidden
3507
 
        self.experimental = experimental
3508
 
 
3509
 
 
3510
 
class BzrDirFormatRegistry(registry.Registry):
3511
 
    """Registry of user-selectable BzrDir subformats.
3512
 
 
3513
 
    Differs from BzrDirFormat._control_formats in that it provides sub-formats,
3514
 
    e.g. BzrDirMeta1 with weave repository.  Also, it's more user-oriented.
3515
 
    """
3516
 
 
3517
 
    def __init__(self):
3518
 
        """Create a BzrDirFormatRegistry."""
3519
 
        self._aliases = set()
3520
 
        self._registration_order = list()
3521
 
        super(BzrDirFormatRegistry, self).__init__()
3522
 
 
3523
 
    def aliases(self):
3524
 
        """Return a set of the format names which are aliases."""
3525
 
        return frozenset(self._aliases)
3526
 
 
3527
 
    def register_metadir(self, key,
3528
 
             repository_format, help, native=True, deprecated=False,
3529
 
             branch_format=None,
3530
 
             tree_format=None,
3531
 
             hidden=False,
3532
 
             experimental=False,
3533
 
             alias=False):
3534
 
        """Register a metadir subformat.
3535
 
 
3536
 
        These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
3537
 
        by the Repository/Branch/WorkingTreeformats.
3538
 
 
3539
 
        :param repository_format: The fully-qualified repository format class
3540
 
            name as a string.
3541
 
        :param branch_format: Fully-qualified branch format class name as
3542
 
            a string.
3543
 
        :param tree_format: Fully-qualified tree format class name as
3544
 
            a string.
3545
 
        """
3546
 
        # This should be expanded to support setting WorkingTree and Branch
3547
 
        # formats, once BzrDirMetaFormat1 supports that.
3548
 
        def _load(full_name):
3549
 
            mod_name, factory_name = full_name.rsplit('.', 1)
3550
 
            try:
3551
 
                mod = __import__(mod_name, globals(), locals(),
3552
 
                        [factory_name])
3553
 
            except ImportError, e:
3554
 
                raise ImportError('failed to load %s: %s' % (full_name, e))
3555
 
            try:
3556
 
                factory = getattr(mod, factory_name)
3557
 
            except AttributeError:
3558
 
                raise AttributeError('no factory %s in module %r'
3559
 
                    % (full_name, mod))
3560
 
            return factory()
3561
 
 
3562
 
        def helper():
3563
 
            bd = BzrDirMetaFormat1()
3564
 
            if branch_format is not None:
3565
 
                bd.set_branch_format(_load(branch_format))
3566
 
            if tree_format is not None:
3567
 
                bd.workingtree_format = _load(tree_format)
3568
 
            if repository_format is not None:
3569
 
                bd.repository_format = _load(repository_format)
3570
 
            return bd
3571
 
        self.register(key, helper, help, native, deprecated, hidden,
3572
 
            experimental, alias)
3573
 
 
3574
 
    def register(self, key, factory, help, native=True, deprecated=False,
3575
 
                 hidden=False, experimental=False, alias=False):
3576
 
        """Register a BzrDirFormat factory.
3577
 
 
3578
 
        The factory must be a callable that takes one parameter: the key.
3579
 
        It must produce an instance of the BzrDirFormat when called.
3580
 
 
3581
 
        This function mainly exists to prevent the info object from being
3582
 
        supplied directly.
3583
 
        """
3584
 
        registry.Registry.register(self, key, factory, help,
3585
 
            BzrDirFormatInfo(native, deprecated, hidden, experimental))
3586
 
        if alias:
3587
 
            self._aliases.add(key)
3588
 
        self._registration_order.append(key)
3589
 
 
3590
 
    def register_lazy(self, key, module_name, member_name, help, native=True,
3591
 
        deprecated=False, hidden=False, experimental=False, alias=False):
3592
 
        registry.Registry.register_lazy(self, key, module_name, member_name,
3593
 
            help, BzrDirFormatInfo(native, deprecated, hidden, experimental))
3594
 
        if alias:
3595
 
            self._aliases.add(key)
3596
 
        self._registration_order.append(key)
3597
 
 
3598
 
    def set_default(self, key):
3599
 
        """Set the 'default' key to be a clone of the supplied key.
3600
 
 
3601
 
        This method must be called once and only once.
3602
 
        """
3603
 
        registry.Registry.register(self, 'default', self.get(key),
3604
 
            self.get_help(key), info=self.get_info(key))
3605
 
        self._aliases.add('default')
3606
 
 
3607
 
    def set_default_repository(self, key):
3608
 
        """Set the FormatRegistry default and Repository default.
3609
 
 
3610
 
        This is a transitional method while Repository.set_default_format
3611
 
        is deprecated.
3612
 
        """
3613
 
        if 'default' in self:
3614
 
            self.remove('default')
3615
 
        self.set_default(key)
3616
 
        format = self.get('default')()
3617
 
 
3618
 
    def make_bzrdir(self, key):
3619
 
        return self.get(key)()
3620
 
 
3621
 
    def help_topic(self, topic):
3622
 
        output = ""
3623
 
        default_realkey = None
3624
 
        default_help = self.get_help('default')
3625
 
        help_pairs = []
3626
 
        for key in self._registration_order:
3627
 
            if key == 'default':
3628
 
                continue
3629
 
            help = self.get_help(key)
3630
 
            if help == default_help:
3631
 
                default_realkey = key
3632
 
            else:
3633
 
                help_pairs.append((key, help))
3634
 
 
3635
 
        def wrapped(key, help, info):
3636
 
            if info.native:
3637
 
                help = '(native) ' + help
3638
 
            return ':%s:\n%s\n\n' % (key,
3639
 
                textwrap.fill(help, initial_indent='    ',
3640
 
                    subsequent_indent='    ',
3641
 
                    break_long_words=False))
3642
 
        if default_realkey is not None:
3643
 
            output += wrapped(default_realkey, '(default) %s' % default_help,
3644
 
                              self.get_info('default'))
3645
 
        deprecated_pairs = []
3646
 
        experimental_pairs = []
3647
 
        for key, help in help_pairs:
3648
 
            info = self.get_info(key)
3649
 
            if info.hidden:
3650
 
                continue
3651
 
            elif info.deprecated:
3652
 
                deprecated_pairs.append((key, help))
3653
 
            elif info.experimental:
3654
 
                experimental_pairs.append((key, help))
3655
 
            else:
3656
 
                output += wrapped(key, help, info)
3657
 
        output += "\nSee :doc:`formats-help` for more about storage formats."
3658
 
        other_output = ""
3659
 
        if len(experimental_pairs) > 0:
3660
 
            other_output += "Experimental formats are shown below.\n\n"
3661
 
            for key, help in experimental_pairs:
3662
 
                info = self.get_info(key)
3663
 
                other_output += wrapped(key, help, info)
3664
 
        else:
3665
 
            other_output += \
3666
 
                "No experimental formats are available.\n\n"
3667
 
        if len(deprecated_pairs) > 0:
3668
 
            other_output += "\nDeprecated formats are shown below.\n\n"
3669
 
            for key, help in deprecated_pairs:
3670
 
                info = self.get_info(key)
3671
 
                other_output += wrapped(key, help, info)
3672
 
        else:
3673
 
            other_output += \
3674
 
                "\nNo deprecated formats are available.\n\n"
3675
 
        other_output += \
3676
 
                "\nSee :doc:`formats-help` for more about storage formats."
3677
 
 
3678
 
        if topic == 'other-formats':
3679
 
            return other_output
3680
 
        else:
3681
 
            return output
3682
 
 
3683
 
 
3684
 
class RepositoryAcquisitionPolicy(object):
3685
 
    """Abstract base class for repository acquisition policies.
3686
 
 
3687
 
    A repository acquisition policy decides how a BzrDir acquires a repository
3688
 
    for a branch that is being created.  The most basic policy decision is
3689
 
    whether to create a new repository or use an existing one.
3690
 
    """
3691
 
    def __init__(self, stack_on, stack_on_pwd, require_stacking):
3692
 
        """Constructor.
3693
 
 
3694
 
        :param stack_on: A location to stack on
3695
 
        :param stack_on_pwd: If stack_on is relative, the location it is
3696
 
            relative to.
3697
 
        :param require_stacking: If True, it is a failure to not stack.
3698
 
        """
3699
 
        self._stack_on = stack_on
3700
 
        self._stack_on_pwd = stack_on_pwd
3701
 
        self._require_stacking = require_stacking
3702
 
 
3703
 
    def configure_branch(self, branch):
3704
 
        """Apply any configuration data from this policy to the branch.
3705
 
 
3706
 
        Default implementation sets repository stacking.
3707
 
        """
3708
 
        if self._stack_on is None:
3709
 
            return
3710
 
        if self._stack_on_pwd is None:
3711
 
            stack_on = self._stack_on
3712
 
        else:
3713
 
            try:
3714
 
                stack_on = urlutils.rebase_url(self._stack_on,
3715
 
                    self._stack_on_pwd,
3716
 
                    branch.user_url)
3717
 
            except errors.InvalidRebaseURLs:
3718
 
                stack_on = self._get_full_stack_on()
3719
 
        try:
3720
 
            branch.set_stacked_on_url(stack_on)
3721
 
        except (errors.UnstackableBranchFormat,
3722
 
                errors.UnstackableRepositoryFormat):
3723
 
            if self._require_stacking:
3724
 
                raise
3725
 
 
3726
 
    def requires_stacking(self):
3727
 
        """Return True if this policy requires stacking."""
3728
 
        return self._stack_on is not None and self._require_stacking
3729
 
 
3730
 
    def _get_full_stack_on(self):
3731
 
        """Get a fully-qualified URL for the stack_on location."""
3732
 
        if self._stack_on is None:
3733
 
            return None
3734
 
        if self._stack_on_pwd is None:
3735
 
            return self._stack_on
3736
 
        else:
3737
 
            return urlutils.join(self._stack_on_pwd, self._stack_on)
3738
 
 
3739
 
    def _add_fallback(self, repository, possible_transports=None):
3740
 
        """Add a fallback to the supplied repository, if stacking is set."""
3741
 
        stack_on = self._get_full_stack_on()
3742
 
        if stack_on is None:
3743
 
            return
3744
 
        try:
3745
 
            stacked_dir = BzrDir.open(stack_on,
3746
 
                                      possible_transports=possible_transports)
3747
 
        except errors.JailBreak:
3748
 
            # We keep the stacking details, but we are in the server code so
3749
 
            # actually stacking is not needed.
3750
 
            return
3751
 
        try:
3752
 
            stacked_repo = stacked_dir.open_branch().repository
3753
 
        except errors.NotBranchError:
3754
 
            stacked_repo = stacked_dir.open_repository()
3755
 
        try:
3756
 
            repository.add_fallback_repository(stacked_repo)
3757
 
        except errors.UnstackableRepositoryFormat:
3758
 
            if self._require_stacking:
3759
 
                raise
3760
 
        else:
3761
 
            self._require_stacking = True
3762
 
 
3763
 
    def acquire_repository(self, make_working_trees=None, shared=False):
3764
 
        """Acquire a repository for this bzrdir.
3765
 
 
3766
 
        Implementations may create a new repository or use a pre-exising
3767
 
        repository.
3768
 
        :param make_working_trees: If creating a repository, set
3769
 
            make_working_trees to this value (if non-None)
3770
 
        :param shared: If creating a repository, make it shared if True
3771
 
        :return: A repository, is_new_flag (True if the repository was
3772
 
            created).
3773
 
        """
3774
 
        raise NotImplemented(RepositoryAcquisitionPolicy.acquire_repository)
3775
 
 
3776
 
 
3777
 
class CreateRepository(RepositoryAcquisitionPolicy):
3778
 
    """A policy of creating a new repository"""
3779
 
 
3780
 
    def __init__(self, bzrdir, stack_on=None, stack_on_pwd=None,
3781
 
                 require_stacking=False):
3782
 
        """
3783
 
        Constructor.
3784
 
        :param bzrdir: The bzrdir to create the repository on.
3785
 
        :param stack_on: A location to stack on
3786
 
        :param stack_on_pwd: If stack_on is relative, the location it is
3787
 
            relative to.
3788
 
        """
3789
 
        RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
3790
 
                                             require_stacking)
3791
 
        self._bzrdir = bzrdir
3792
 
 
3793
 
    def acquire_repository(self, make_working_trees=None, shared=False):
3794
 
        """Implementation of RepositoryAcquisitionPolicy.acquire_repository
3795
 
 
3796
 
        Creates the desired repository in the bzrdir we already have.
3797
 
        """
3798
 
        stack_on = self._get_full_stack_on()
3799
 
        if stack_on:
3800
 
            format = self._bzrdir._format
3801
 
            format.require_stacking(stack_on=stack_on,
3802
 
                                    possible_transports=[self._bzrdir.root_transport])
3803
 
            if not self._require_stacking:
3804
 
                # We have picked up automatic stacking somewhere.
3805
 
                note('Using default stacking branch %s at %s', self._stack_on,
3806
 
                    self._stack_on_pwd)
3807
 
        repository = self._bzrdir.create_repository(shared=shared)
3808
 
        self._add_fallback(repository,
3809
 
                           possible_transports=[self._bzrdir.transport])
3810
 
        if make_working_trees is not None:
3811
 
            repository.set_make_working_trees(make_working_trees)
3812
 
        return repository, True
3813
 
 
3814
 
 
3815
 
class UseExistingRepository(RepositoryAcquisitionPolicy):
3816
 
    """A policy of reusing an existing repository"""
3817
 
 
3818
 
    def __init__(self, repository, stack_on=None, stack_on_pwd=None,
3819
 
                 require_stacking=False):
3820
 
        """Constructor.
3821
 
 
3822
 
        :param repository: The repository to use.
3823
 
        :param stack_on: A location to stack on
3824
 
        :param stack_on_pwd: If stack_on is relative, the location it is
3825
 
            relative to.
3826
 
        """
3827
 
        RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
3828
 
                                             require_stacking)
3829
 
        self._repository = repository
3830
 
 
3831
 
    def acquire_repository(self, make_working_trees=None, shared=False):
3832
 
        """Implementation of RepositoryAcquisitionPolicy.acquire_repository
3833
 
 
3834
 
        Returns an existing repository to use.
3835
 
        """
3836
 
        self._add_fallback(self._repository,
3837
 
                       possible_transports=[self._repository.bzrdir.transport])
3838
 
        return self._repository, False
3839
 
 
3840
 
 
3841
 
# Please register new formats after old formats so that formats
3842
 
# appear in chronological order and format descriptions can build
3843
 
# on previous ones.
3844
 
format_registry = BzrDirFormatRegistry()
3845
 
# The pre-0.8 formats have their repository format network name registered in
3846
 
# repository.py. MetaDir formats have their repository format network name
3847
 
# inferred from their disk format string.
3848
 
format_registry.register('weave', BzrDirFormat6,
3849
 
    'Pre-0.8 format.  Slower than knit and does not'
3850
 
    ' support checkouts or shared repositories.',
3851
 
    hidden=True,
3852
 
    deprecated=True)
3853
 
format_registry.register_metadir('metaweave',
3854
 
    'bzrlib.repofmt.weaverepo.RepositoryFormat7',
3855
 
    'Transitional format in 0.8.  Slower than knit.',
3856
 
    branch_format='bzrlib.branch.BzrBranchFormat5',
3857
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3858
 
    hidden=True,
3859
 
    deprecated=True)
3860
 
format_registry.register_metadir('knit',
3861
 
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3862
 
    'Format using knits.  Recommended for interoperation with bzr <= 0.14.',
3863
 
    branch_format='bzrlib.branch.BzrBranchFormat5',
3864
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3865
 
    hidden=True,
3866
 
    deprecated=True)
3867
 
format_registry.register_metadir('dirstate',
3868
 
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3869
 
    help='New in 0.15: Fast local operations. Compatible with bzr 0.8 and '
3870
 
        'above when accessed over the network.',
3871
 
    branch_format='bzrlib.branch.BzrBranchFormat5',
3872
 
    # this uses bzrlib.workingtree.WorkingTreeFormat4 because importing
3873
 
    # directly from workingtree_4 triggers a circular import.
3874
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3875
 
    hidden=True,
3876
 
    deprecated=True)
3877
 
format_registry.register_metadir('dirstate-tags',
3878
 
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3879
 
    help='New in 0.15: Fast local operations and improved scaling for '
3880
 
        'network operations. Additionally adds support for tags.'
3881
 
        ' Incompatible with bzr < 0.15.',
3882
 
    branch_format='bzrlib.branch.BzrBranchFormat6',
3883
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3884
 
    hidden=True,
3885
 
    deprecated=True)
3886
 
format_registry.register_metadir('rich-root',
3887
 
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
3888
 
    help='New in 1.0.  Better handling of tree roots.  Incompatible with'
3889
 
        ' bzr < 1.0.',
3890
 
    branch_format='bzrlib.branch.BzrBranchFormat6',
3891
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3892
 
    hidden=True,
3893
 
    deprecated=True)
3894
 
format_registry.register_metadir('dirstate-with-subtree',
3895
 
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
3896
 
    help='New in 0.15: Fast local operations and improved scaling for '
3897
 
        'network operations. Additionally adds support for versioning nested '
3898
 
        'bzr branches. Incompatible with bzr < 0.15.',
3899
 
    branch_format='bzrlib.branch.BzrBranchFormat6',
3900
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3901
 
    experimental=True,
3902
 
    hidden=True,
3903
 
    )
3904
 
format_registry.register_metadir('pack-0.92',
3905
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack1',
3906
 
    help='New in 0.92: Pack-based format with data compatible with '
3907
 
        'dirstate-tags format repositories. Interoperates with '
3908
 
        'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3909
 
        ,
3910
 
    branch_format='bzrlib.branch.BzrBranchFormat6',
3911
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3912
 
    )
3913
 
format_registry.register_metadir('pack-0.92-subtree',
3914
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack3',
3915
 
    help='New in 0.92: Pack-based format with data compatible with '
3916
 
        'dirstate-with-subtree format repositories. Interoperates with '
3917
 
        'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3918
 
        ,
3919
 
    branch_format='bzrlib.branch.BzrBranchFormat6',
3920
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3921
 
    hidden=True,
3922
 
    experimental=True,
3923
 
    )
3924
 
format_registry.register_metadir('rich-root-pack',
3925
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
3926
 
    help='New in 1.0: A variant of pack-0.92 that supports rich-root data '
3927
 
         '(needed for bzr-svn and bzr-git).',
3928
 
    branch_format='bzrlib.branch.BzrBranchFormat6',
3929
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3930
 
    hidden=True,
3931
 
    )
3932
 
format_registry.register_metadir('1.6',
3933
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5',
3934
 
    help='A format that allows a branch to indicate that there is another '
3935
 
         '(stacked) repository that should be used to access data that is '
3936
 
         'not present locally.',
3937
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3938
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3939
 
    hidden=True,
3940
 
    )
3941
 
format_registry.register_metadir('1.6.1-rich-root',
3942
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5RichRoot',
3943
 
    help='A variant of 1.6 that supports rich-root data '
3944
 
         '(needed for bzr-svn and bzr-git).',
3945
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3946
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3947
 
    hidden=True,
3948
 
    )
3949
 
format_registry.register_metadir('1.9',
3950
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3951
 
    help='A repository format using B+tree indexes. These indexes '
3952
 
         'are smaller in size, have smarter caching and provide faster '
3953
 
         'performance for most operations.',
3954
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3955
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3956
 
    hidden=True,
3957
 
    )
3958
 
format_registry.register_metadir('1.9-rich-root',
3959
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
3960
 
    help='A variant of 1.9 that supports rich-root data '
3961
 
         '(needed for bzr-svn and bzr-git).',
3962
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3963
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3964
 
    hidden=True,
3965
 
    )
3966
 
format_registry.register_metadir('1.14',
3967
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3968
 
    help='A working-tree format that supports content filtering.',
3969
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3970
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat5',
3971
 
    )
3972
 
format_registry.register_metadir('1.14-rich-root',
3973
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
3974
 
    help='A variant of 1.14 that supports rich-root data '
3975
 
         '(needed for bzr-svn and bzr-git).',
3976
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3977
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat5',
3978
 
    )
3979
 
# The following un-numbered 'development' formats should always just be aliases.
3980
 
format_registry.register_metadir('development-rich-root',
3981
 
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
3982
 
    help='Current development format. Supports rich roots. Can convert data '
3983
 
        'to and from rich-root-pack (and anything compatible with '
3984
 
        'rich-root-pack) format repositories. Repositories and branches in '
3985
 
        'this format can only be read by bzr.dev. Please read '
3986
 
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
3987
 
        'before use.',
3988
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3989
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3990
 
    experimental=True,
3991
 
    alias=True,
3992
 
    hidden=True,
3993
 
    )
3994
 
format_registry.register_metadir('development-subtree',
3995
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment2Subtree',
3996
 
    help='Current development format, subtree variant. Can convert data to and '
3997
 
        'from pack-0.92-subtree (and anything compatible with '
3998
 
        'pack-0.92-subtree) format repositories. Repositories and branches in '
3999
 
        'this format can only be read by bzr.dev. Please read '
4000
 
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
4001
 
        'before use.',
4002
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
4003
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4004
 
    experimental=True,
4005
 
    hidden=True,
4006
 
    alias=False, # Restore to being an alias when an actual development subtree format is added
4007
 
                 # This current non-alias status is simply because we did not introduce a
4008
 
                 # chk based subtree format.
4009
 
    )
4010
 
 
4011
 
# And the development formats above will have aliased one of the following:
4012
 
format_registry.register_metadir('development6-rich-root',
4013
 
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
4014
 
    help='pack-1.9 with 255-way hashed CHK inv, group compress, rich roots '
4015
 
        'Please read '
4016
 
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
4017
 
        'before use.',
4018
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
4019
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4020
 
    hidden=True,
4021
 
    experimental=True,
4022
 
    )
4023
 
 
4024
 
format_registry.register_metadir('development7-rich-root',
4025
 
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK2',
4026
 
    help='pack-1.9 with 255-way hashed CHK inv, bencode revision, group compress, '
4027
 
        'rich roots. Please read '
4028
 
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
4029
 
        'before use.',
4030
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
4031
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4032
 
    hidden=True,
4033
 
    experimental=True,
4034
 
    )
4035
 
 
4036
 
format_registry.register_metadir('2a',
4037
 
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
4038
 
    help='First format for bzr 2.0 series.\n'
4039
 
        'Uses group-compress storage.\n'
4040
 
        'Provides rich roots which are a one-way transition.\n',
4041
 
        # 'storage in packs, 255-way hashed CHK inventory, bencode revision, group compress, '
4042
 
        # 'rich roots. Supported by bzr 1.16 and later.',
4043
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
4044
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4045
 
    experimental=True,
4046
 
    )
4047
 
 
4048
 
# The following format should be an alias for the rich root equivalent 
4049
 
# of the default format
4050
 
format_registry.register_metadir('default-rich-root',
4051
 
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
4052
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
4053
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4054
 
    alias=True,
4055
 
    hidden=True,
4056
 
    help='Same as 2a.')
4057
 
 
4058
 
# The current format that is made on 'bzr init'.
4059
 
format_registry.set_default('2a')