~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/bzrdir.py

MergeĀ inĀ upstream.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
2
 
#
 
1
# Copyright (C) 2005 Canonical Ltd
 
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
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
#
 
7
 
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
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
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
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
from copy import deepcopy
 
24
import os
30
25
from cStringIO import StringIO
31
 
import os
32
 
import sys
33
 
 
34
 
from bzrlib.lazy_import import lazy_import
35
 
lazy_import(globals(), """
36
 
from stat import S_ISDIR
37
 
import textwrap
38
 
from warnings import warn
 
26
from unittest import TestSuite
39
27
 
40
28
import bzrlib
41
 
from bzrlib import (
42
 
    config,
43
 
    errors,
44
 
    graph,
45
 
    lockable_files,
46
 
    lockdir,
47
 
    osutils,
48
 
    registry,
49
 
    remote,
50
 
    revision as _mod_revision,
51
 
    symbol_versioning,
52
 
    ui,
53
 
    urlutils,
54
 
    versionedfile,
55
 
    win32utils,
56
 
    workingtree,
57
 
    workingtree_4,
58
 
    xml4,
59
 
    xml5,
60
 
    )
 
29
import bzrlib.errors as errors
 
30
from bzrlib.lockable_files import LockableFiles
 
31
from bzrlib.osutils import safe_unicode
61
32
from bzrlib.osutils import (
62
 
    sha_strings,
63
 
    sha_string,
64
 
    )
65
 
from bzrlib.repository import Repository
66
 
from bzrlib.smart.client import _SmartClient
67
 
from bzrlib.smart import protocol
 
33
                            abspath,
 
34
                            pathjoin,
 
35
                            safe_unicode,
 
36
                            sha_strings,
 
37
                            sha_string,
 
38
                            )
 
39
from bzrlib.store.text import TextStore
68
40
from bzrlib.store.versioned import WeaveStore
69
 
from bzrlib.transactions import WriteTransaction
70
 
from bzrlib.transport import (
71
 
    do_catching_redirections,
72
 
    get_transport,
73
 
    )
 
41
from bzrlib.symbol_versioning import *
 
42
from bzrlib.trace import mutter
 
43
from bzrlib.transactions import PassThroughTransaction
 
44
from bzrlib.transport import get_transport
 
45
from bzrlib.transport.local import LocalTransport
74
46
from bzrlib.weave import Weave
75
 
""")
76
 
 
77
 
from bzrlib.trace import (
78
 
    mutter,
79
 
    note,
80
 
    )
81
 
from bzrlib.transport.local import LocalTransport
82
 
from bzrlib.symbol_versioning import (
83
 
    deprecated_function,
84
 
    deprecated_method,
85
 
    )
 
47
from bzrlib.xml4 import serializer_v4
 
48
from bzrlib.xml5 import serializer_v5
86
49
 
87
50
 
88
51
class BzrDir(object):
91
54
    BzrDir instances let you create or open any of the things that can be
92
55
    found within .bzr - checkouts, branches and repositories.
93
56
    
94
 
    :ivar transport:
 
57
    transport
95
58
        the transport which this bzr dir is rooted at (i.e. file:///.../.bzr/)
96
 
    :ivar root_transport:
97
 
        a transport connected to the directory this bzr was opened from
98
 
        (i.e. the parent directory holding the .bzr directory).
99
 
 
100
 
    Everything in the bzrdir should have the same file permissions.
 
59
    root_transport
 
60
        a transport connected to the directory this bzr was opened from.
101
61
    """
102
62
 
103
 
    def break_lock(self):
104
 
        """Invoke break_lock on the first object in the bzrdir.
105
 
 
106
 
        If there is a tree, the tree is opened and break_lock() called.
107
 
        Otherwise, branch is tried, and finally repository.
108
 
        """
109
 
        # XXX: This seems more like a UI function than something that really
110
 
        # belongs in this class.
111
 
        try:
112
 
            thing_to_unlock = self.open_workingtree()
113
 
        except (errors.NotLocalUrl, errors.NoWorkingTree):
114
 
            try:
115
 
                thing_to_unlock = self.open_branch()
116
 
            except errors.NotBranchError:
117
 
                try:
118
 
                    thing_to_unlock = self.open_repository()
119
 
                except errors.NoRepositoryPresent:
120
 
                    return
121
 
        thing_to_unlock.break_lock()
122
 
 
123
63
    def can_convert_format(self):
124
64
        """Return true if this bzrdir is one whose format we can convert from."""
125
65
        return True
126
66
 
127
 
    def check_conversion_target(self, target_format):
128
 
        target_repo_format = target_format.repository_format
129
 
        source_repo_format = self._format.repository_format
130
 
        source_repo_format.check_conversion_target(target_repo_format)
131
 
 
132
 
    @staticmethod
133
 
    def _check_supported(format, allow_unsupported,
134
 
        recommend_upgrade=True,
135
 
        basedir=None):
136
 
        """Give an error or warning on old formats.
137
 
 
138
 
        :param format: may be any kind of format - workingtree, branch, 
139
 
        or repository.
140
 
 
141
 
        :param allow_unsupported: If true, allow opening 
142
 
        formats that are strongly deprecated, and which may 
143
 
        have limited functionality.
144
 
 
145
 
        :param recommend_upgrade: If true (default), warn
146
 
        the user through the ui object that they may wish
147
 
        to upgrade the object.
 
67
    def _check_supported(self, format, allow_unsupported):
 
68
        """Check whether format is a supported format.
 
69
 
 
70
        If allow_unsupported is True, this is a no-op.
148
71
        """
149
 
        # TODO: perhaps move this into a base Format class; it's not BzrDir
150
 
        # specific. mbp 20070323
151
72
        if not allow_unsupported and not format.is_supported():
152
 
            # see open_downlevel to open legacy branches.
153
 
            raise errors.UnsupportedFormatError(format=format)
154
 
        if recommend_upgrade \
155
 
            and getattr(format, 'upgrade_recommended', False):
156
 
            ui.ui_factory.recommend_upgrade(
157
 
                format.get_format_description(),
158
 
                basedir)
 
73
            raise errors.UnsupportedFormatError(format)
159
74
 
160
 
    def clone(self, url, revision_id=None, force_new_repo=False,
161
 
              preserve_stacking=False):
 
75
    def clone(self, url, revision_id=None, basis=None, force_new_repo=False):
162
76
        """Clone this bzrdir and its contents to url verbatim.
163
77
 
164
 
        :param url: The url create the clone at.  If url's last component does
165
 
            not exist, it will be created.
166
 
        :param revision_id: The tip revision-id to use for any branch or
167
 
            working tree.  If not None, then the clone operation may tune
168
 
            itself to download less data.
169
 
        :param force_new_repo: Do not use a shared repository for the target
170
 
                               even if one is available.
171
 
        :param preserve_stacking: When cloning a stacked branch, stack the
172
 
            new branch on top of the other branch's stacked-on branch.
173
 
        """
174
 
        return self.clone_on_transport(get_transport(url),
175
 
                                       revision_id=revision_id,
176
 
                                       force_new_repo=force_new_repo,
177
 
                                       preserve_stacking=preserve_stacking)
178
 
 
179
 
    def clone_on_transport(self, transport, revision_id=None,
180
 
                           force_new_repo=False, preserve_stacking=False,
181
 
                           stacked_on=None):
182
 
        """Clone this bzrdir and its contents to transport verbatim.
183
 
 
184
 
        :param transport: The transport for the location to produce the clone
185
 
            at.  If the target directory does not exist, it will be created.
186
 
        :param revision_id: The tip revision-id to use for any branch or
187
 
            working tree.  If not None, then the clone operation may tune
188
 
            itself to download less data.
189
 
        :param force_new_repo: Do not use a shared repository for the target,
190
 
                               even if one is available.
191
 
        :param preserve_stacking: When cloning a stacked branch, stack the
192
 
            new branch on top of the other branch's stacked-on branch.
193
 
        """
194
 
        transport.ensure_base()
195
 
        require_stacking = (stacked_on is not None)
196
 
        metadir = self.cloning_metadir(require_stacking)
197
 
        result = metadir.initialize_on_transport(transport)
198
 
        repository_policy = None
 
78
        If urls last component does not exist, it will be created.
 
79
 
 
80
        if revision_id is not None, then the clone operation may tune
 
81
            itself to download less data.
 
82
        :param force_new_repo: Do not use a shared repository for the target 
 
83
                               even if one is available.
 
84
        """
 
85
        self._make_tail(url)
 
86
        basis_repo, basis_branch, basis_tree = self._get_basis_components(basis)
 
87
        result = self._format.initialize(url)
199
88
        try:
200
89
            local_repo = self.find_repository()
201
90
        except errors.NoRepositoryPresent:
202
91
            local_repo = None
203
 
        try:
204
 
            local_branch = self.open_branch()
205
 
        except errors.NotBranchError:
206
 
            local_branch = None
207
 
        else:
208
 
            # enable fallbacks when branch is not a branch reference
209
 
            if local_branch.repository.has_same_location(local_repo):
210
 
                local_repo = local_branch.repository
211
 
            if preserve_stacking:
212
 
                try:
213
 
                    stacked_on = local_branch.get_stacked_on_url()
214
 
                except (errors.UnstackableBranchFormat,
215
 
                        errors.UnstackableRepositoryFormat,
216
 
                        errors.NotStacked):
217
 
                    pass
218
 
 
219
92
        if local_repo:
220
93
            # may need to copy content in
221
 
            repository_policy = result.determine_repository_policy(
222
 
                force_new_repo, stacked_on, self.root_transport.base,
223
 
                require_stacking=require_stacking)
224
 
            make_working_trees = local_repo.make_working_trees()
225
 
            result_repo = repository_policy.acquire_repository(
226
 
                make_working_trees, local_repo.is_shared())
227
 
            result_repo.fetch(local_repo, revision_id=revision_id)
228
 
        else:
229
 
            result_repo = None
 
94
            if force_new_repo:
 
95
                local_repo.clone(result, revision_id=revision_id, basis=basis_repo)
 
96
            else:
 
97
                try:
 
98
                    result_repo = result.find_repository()
 
99
                    # fetch content this dir needs.
 
100
                    if basis_repo:
 
101
                        # XXX FIXME RBC 20060214 need tests for this when the basis
 
102
                        # is incomplete
 
103
                        result_repo.fetch(basis_repo, revision_id=revision_id)
 
104
                    result_repo.fetch(local_repo, revision_id=revision_id)
 
105
                except errors.NoRepositoryPresent:
 
106
                    # needed to make one anyway.
 
107
                    local_repo.clone(result, revision_id=revision_id, basis=basis_repo)
230
108
        # 1 if there is a branch present
231
109
        #   make sure its content is available in the target repository
232
110
        #   clone it.
233
 
        if local_branch is not None:
234
 
            result_branch = local_branch.clone(result, revision_id=revision_id)
235
 
            if repository_policy is not None:
236
 
                repository_policy.configure_branch(result_branch)
237
 
        if result_repo is None or result_repo.make_working_trees():
 
111
        try:
 
112
            self.open_branch().clone(result, revision_id=revision_id)
 
113
        except errors.NotBranchError:
 
114
            pass
 
115
        try:
 
116
            self.open_workingtree().clone(result, basis=basis_tree)
 
117
        except (errors.NoWorkingTree, errors.NotLocalUrl):
 
118
            pass
 
119
        return result
 
120
 
 
121
    def _get_basis_components(self, basis):
 
122
        """Retrieve the basis components that are available at basis."""
 
123
        if basis is None:
 
124
            return None, None, None
 
125
        try:
 
126
            basis_tree = basis.open_workingtree()
 
127
            basis_branch = basis_tree.branch
 
128
            basis_repo = basis_branch.repository
 
129
        except (errors.NoWorkingTree, errors.NotLocalUrl):
 
130
            basis_tree = None
238
131
            try:
239
 
                self.open_workingtree().clone(result)
240
 
            except (errors.NoWorkingTree, errors.NotLocalUrl):
241
 
                pass
242
 
        return result
 
132
                basis_branch = basis.open_branch()
 
133
                basis_repo = basis_branch.repository
 
134
            except errors.NotBranchError:
 
135
                basis_branch = None
 
136
                try:
 
137
                    basis_repo = basis.open_repository()
 
138
                except errors.NoRepositoryPresent:
 
139
                    basis_repo = None
 
140
        return basis_repo, basis_branch, basis_tree
243
141
 
244
 
    # TODO: This should be given a Transport, and should chdir up; otherwise
245
 
    # this will open a new connection.
246
142
    def _make_tail(self, url):
247
 
        t = get_transport(url)
248
 
        t.ensure_base()
 
143
        segments = url.split('/')
 
144
        if segments and segments[-1] not in ('', '.'):
 
145
            parent = '/'.join(segments[:-1])
 
146
            t = bzrlib.transport.get_transport(parent)
 
147
            try:
 
148
                t.mkdir(segments[-1])
 
149
            except errors.FileExists:
 
150
                pass
249
151
 
250
 
    @classmethod
251
 
    def create(cls, base, format=None, possible_transports=None):
 
152
    @staticmethod
 
153
    def create(base):
252
154
        """Create a new BzrDir at the url 'base'.
253
155
        
254
 
        :param format: If supplied, the format of branch to create.  If not
255
 
            supplied, the default is used.
256
 
        :param possible_transports: If supplied, a list of transports that 
257
 
            can be reused to share a remote connection.
258
 
        """
259
 
        if cls is not BzrDir:
260
 
            raise AssertionError("BzrDir.create always creates the default"
261
 
                " format, not one of %r" % cls)
262
 
        t = get_transport(base, possible_transports)
263
 
        t.ensure_base()
264
 
        if format is None:
265
 
            format = BzrDirFormat.get_default_format()
266
 
        return format.initialize_on_transport(t)
267
 
 
268
 
    @staticmethod
269
 
    def find_bzrdirs(transport, evaluate=None, list_current=None):
270
 
        """Find bzrdirs recursively from current location.
271
 
 
272
 
        This is intended primarily as a building block for more sophisticated
273
 
        functionality, like finding trees under a directory, or finding
274
 
        branches that use a given repository.
275
 
        :param evaluate: An optional callable that yields recurse, value,
276
 
            where recurse controls whether this bzrdir is recursed into
277
 
            and value is the value to yield.  By default, all bzrdirs
278
 
            are recursed into, and the return value is the bzrdir.
279
 
        :param list_current: if supplied, use this function to list the current
280
 
            directory, instead of Transport.list_dir
281
 
        :return: a generator of found bzrdirs, or whatever evaluate returns.
282
 
        """
283
 
        if list_current is None:
284
 
            def list_current(transport):
285
 
                return transport.list_dir('')
286
 
        if evaluate is None:
287
 
            def evaluate(bzrdir):
288
 
                return True, bzrdir
289
 
 
290
 
        pending = [transport]
291
 
        while len(pending) > 0:
292
 
            current_transport = pending.pop()
293
 
            recurse = True
294
 
            try:
295
 
                bzrdir = BzrDir.open_from_transport(current_transport)
296
 
            except errors.NotBranchError:
297
 
                pass
298
 
            else:
299
 
                recurse, value = evaluate(bzrdir)
300
 
                yield value
301
 
            try:
302
 
                subdirs = list_current(current_transport)
303
 
            except errors.NoSuchFile:
304
 
                continue
305
 
            if recurse:
306
 
                for subdir in sorted(subdirs, reverse=True):
307
 
                    pending.append(current_transport.clone(subdir))
308
 
 
309
 
    @staticmethod
310
 
    def find_branches(transport):
311
 
        """Find all branches under a transport.
312
 
 
313
 
        This will find all branches below the transport, including branches
314
 
        inside other branches.  Where possible, it will use
315
 
        Repository.find_branches.
316
 
 
317
 
        To list all the branches that use a particular Repository, see
318
 
        Repository.find_branches
319
 
        """
320
 
        def evaluate(bzrdir):
321
 
            try:
322
 
                repository = bzrdir.open_repository()
323
 
            except errors.NoRepositoryPresent:
324
 
                pass
325
 
            else:
326
 
                return False, (None, repository)
327
 
            try:
328
 
                branch = bzrdir.open_branch()
329
 
            except errors.NotBranchError:
330
 
                return True, (None, None)
331
 
            else:
332
 
                return True, (branch, None)
333
 
        branches = []
334
 
        for branch, repo in BzrDir.find_bzrdirs(transport, evaluate=evaluate):
335
 
            if repo is not None:
336
 
                branches.extend(repo.find_branches())
337
 
            if branch is not None:
338
 
                branches.append(branch)
339
 
        return branches
340
 
 
341
 
    def destroy_repository(self):
342
 
        """Destroy the repository in this BzrDir"""
343
 
        raise NotImplementedError(self.destroy_repository)
 
156
        This will call the current default formats initialize with base
 
157
        as the only parameter.
 
158
 
 
159
        If you need a specific format, consider creating an instance
 
160
        of that and calling initialize().
 
161
        """
 
162
        segments = base.split('/')
 
163
        if segments and segments[-1] not in ('', '.'):
 
164
            parent = '/'.join(segments[:-1])
 
165
            t = bzrlib.transport.get_transport(parent)
 
166
            try:
 
167
                t.mkdir(segments[-1])
 
168
            except errors.FileExists:
 
169
                pass
 
170
        return BzrDirFormat.get_default_format().initialize(safe_unicode(base))
344
171
 
345
172
    def create_branch(self):
346
173
        """Create a branch in this BzrDir.
347
174
 
348
 
        The bzrdir's format will control what branch format is created.
 
175
        The bzrdirs format will control what branch format is created.
349
176
        For more control see BranchFormatXX.create(a_bzrdir).
350
177
        """
351
178
        raise NotImplementedError(self.create_branch)
352
179
 
353
 
    def destroy_branch(self):
354
 
        """Destroy the branch in this BzrDir"""
355
 
        raise NotImplementedError(self.destroy_branch)
356
 
 
357
180
    @staticmethod
358
 
    def create_branch_and_repo(base, force_new_repo=False, format=None):
 
181
    def create_branch_and_repo(base, force_new_repo=False):
359
182
        """Create a new BzrDir, Branch and Repository at the url 'base'.
360
183
 
361
 
        This will use the current default BzrDirFormat unless one is
362
 
        specified, and use whatever 
 
184
        This will use the current default BzrDirFormat, and use whatever 
363
185
        repository format that that uses via bzrdir.create_branch and
364
186
        create_repository. If a shared repository is available that is used
365
187
        preferentially.
368
190
 
369
191
        :param base: The URL to create the branch at.
370
192
        :param force_new_repo: If True a new repository is always created.
371
 
        :param format: If supplied, the format of branch to create.  If not
372
 
            supplied, the default is used.
373
193
        """
374
 
        bzrdir = BzrDir.create(base, format)
 
194
        bzrdir = BzrDir.create(base)
375
195
        bzrdir._find_or_create_repository(force_new_repo)
376
196
        return bzrdir.create_branch()
377
197
 
378
 
    def determine_repository_policy(self, force_new_repo=False, stack_on=None,
379
 
                                    stack_on_pwd=None, require_stacking=False):
380
 
        """Return an object representing a policy to use.
381
 
 
382
 
        This controls whether a new repository is created, or a shared
383
 
        repository used instead.
384
 
 
385
 
        If stack_on is supplied, will not seek a containing shared repo.
386
 
 
387
 
        :param force_new_repo: If True, require a new repository to be created.
388
 
        :param stack_on: If supplied, the location to stack on.  If not
389
 
            supplied, a default_stack_on location may be used.
390
 
        :param stack_on_pwd: If stack_on is relative, the location it is
391
 
            relative to.
392
 
        """
393
 
        def repository_policy(found_bzrdir):
394
 
            stack_on = None
395
 
            stack_on_pwd = None
396
 
            config = found_bzrdir.get_config()
397
 
            stop = False
398
 
            if config is not None:
399
 
                stack_on = config.get_default_stack_on()
400
 
                if stack_on is not None:
401
 
                    stack_on_pwd = found_bzrdir.root_transport.base
402
 
                    stop = True
403
 
                    note('Using default stacking branch %s at %s', stack_on,
404
 
                         stack_on_pwd)
405
 
            # does it have a repository ?
406
 
            try:
407
 
                repository = found_bzrdir.open_repository()
408
 
            except errors.NoRepositoryPresent:
409
 
                repository = None
410
 
            else:
411
 
                if ((found_bzrdir.root_transport.base !=
412
 
                     self.root_transport.base) and not repository.is_shared()):
413
 
                    repository = None
414
 
                else:
415
 
                    stop = True
416
 
            if not stop:
417
 
                return None, False
418
 
            if repository:
419
 
                return UseExistingRepository(repository, stack_on,
420
 
                    stack_on_pwd, require_stacking=require_stacking), True
421
 
            else:
422
 
                return CreateRepository(self, stack_on, stack_on_pwd,
423
 
                    require_stacking=require_stacking), True
424
 
 
425
 
        if not force_new_repo:
426
 
            if stack_on is None:
427
 
                policy = self._find_containing(repository_policy)
428
 
                if policy is not None:
429
 
                    return policy
430
 
            else:
431
 
                try:
432
 
                    return UseExistingRepository(self.open_repository(),
433
 
                        stack_on, stack_on_pwd,
434
 
                        require_stacking=require_stacking)
435
 
                except errors.NoRepositoryPresent:
436
 
                    pass
437
 
        return CreateRepository(self, stack_on, stack_on_pwd,
438
 
                                require_stacking=require_stacking)
439
 
 
440
198
    def _find_or_create_repository(self, force_new_repo):
441
199
        """Create a new repository if needed, returning the repository."""
442
 
        policy = self.determine_repository_policy(force_new_repo)
443
 
        return policy.acquire_repository()
444
 
 
 
200
        if force_new_repo:
 
201
            return self.create_repository()
 
202
        try:
 
203
            return self.find_repository()
 
204
        except errors.NoRepositoryPresent:
 
205
            return self.create_repository()
 
206
        
445
207
    @staticmethod
446
 
    def create_branch_convenience(base, force_new_repo=False,
447
 
                                  force_new_tree=None, format=None,
448
 
                                  possible_transports=None):
 
208
    def create_branch_convenience(base, force_new_repo=False, force_new_tree=None):
449
209
        """Create a new BzrDir, Branch and Repository at the url 'base'.
450
210
 
451
211
        This is a convenience function - it will use an existing repository
452
212
        if possible, can be told explicitly whether to create a working tree or
453
213
        not.
454
214
 
455
 
        This will use the current default BzrDirFormat unless one is
456
 
        specified, and use whatever 
 
215
        This will use the current default BzrDirFormat, and use whatever 
457
216
        repository format that that uses via bzrdir.create_branch and
458
217
        create_repository. If a shared repository is available that is used
459
218
        preferentially. Whatever repository is used, its tree creation policy
468
227
        :param force_new_repo: If True a new repository is always created.
469
228
        :param force_new_tree: If True or False force creation of a tree or 
470
229
                               prevent such creation respectively.
471
 
        :param format: Override for the bzrdir format to create.
472
 
        :param possible_transports: An optional reusable transports list.
473
230
        """
474
231
        if force_new_tree:
475
232
            # check for non local urls
476
 
            t = get_transport(base, possible_transports)
 
233
            t = get_transport(safe_unicode(base))
477
234
            if not isinstance(t, LocalTransport):
478
235
                raise errors.NotLocalUrl(base)
479
 
        bzrdir = BzrDir.create(base, format, possible_transports)
 
236
        bzrdir = BzrDir.create(base)
480
237
        repo = bzrdir._find_or_create_repository(force_new_repo)
481
238
        result = bzrdir.create_branch()
482
 
        if force_new_tree or (repo.make_working_trees() and
 
239
        if force_new_tree or (repo.make_working_trees() and 
483
240
                              force_new_tree is None):
484
241
            try:
485
242
                bzrdir.create_workingtree()
486
243
            except errors.NotLocalUrl:
487
244
                pass
488
245
        return result
489
 
 
490
 
    @staticmethod
491
 
    def create_standalone_workingtree(base, format=None):
 
246
        
 
247
    @staticmethod
 
248
    def create_repository(base, shared=False):
 
249
        """Create a new BzrDir and Repository at the url 'base'.
 
250
 
 
251
        This will use the current default BzrDirFormat, and use whatever 
 
252
        repository format that that uses for bzrdirformat.create_repository.
 
253
 
 
254
        ;param shared: Create a shared repository rather than a standalone
 
255
                       repository.
 
256
        The Repository object is returned.
 
257
 
 
258
        This must be overridden as an instance method in child classes, where
 
259
        it should take no parameters and construct whatever repository format
 
260
        that child class desires.
 
261
        """
 
262
        bzrdir = BzrDir.create(base)
 
263
        return bzrdir.create_repository()
 
264
 
 
265
    @staticmethod
 
266
    def create_standalone_workingtree(base):
492
267
        """Create a new BzrDir, WorkingTree, Branch and Repository at 'base'.
493
268
 
494
269
        'base' must be a local path or a file:// url.
495
270
 
496
 
        This will use the current default BzrDirFormat unless one is
497
 
        specified, and use whatever 
 
271
        This will use the current default BzrDirFormat, and use whatever 
498
272
        repository format that that uses for bzrdirformat.create_workingtree,
499
273
        create_branch and create_repository.
500
274
 
501
 
        :param format: Override for the bzrdir format to create.
502
 
        :return: The WorkingTree object.
 
275
        The WorkingTree object is returned.
503
276
        """
504
 
        t = get_transport(base)
 
277
        t = get_transport(safe_unicode(base))
505
278
        if not isinstance(t, LocalTransport):
506
279
            raise errors.NotLocalUrl(base)
507
 
        bzrdir = BzrDir.create_branch_and_repo(base,
508
 
                                               force_new_repo=True,
509
 
                                               format=format).bzrdir
 
280
        bzrdir = BzrDir.create_branch_and_repo(safe_unicode(base),
 
281
                                               force_new_repo=True).bzrdir
510
282
        return bzrdir.create_workingtree()
511
283
 
512
 
    def create_workingtree(self, revision_id=None, from_branch=None,
513
 
        accelerator_tree=None, hardlink=False):
 
284
    def create_workingtree(self, revision_id=None):
514
285
        """Create a working tree at this BzrDir.
515
286
        
516
 
        :param revision_id: create it as of this revision id.
517
 
        :param from_branch: override bzrdir branch (for lightweight checkouts)
518
 
        :param accelerator_tree: A tree which can be used for retrieving file
519
 
            contents more quickly than the revision tree, i.e. a workingtree.
520
 
            The revision tree will be used for cases where accelerator_tree's
521
 
            content is different.
 
287
        revision_id: create it as of this revision id.
522
288
        """
523
289
        raise NotImplementedError(self.create_workingtree)
524
290
 
525
 
    def retire_bzrdir(self, limit=10000):
526
 
        """Permanently disable the bzrdir.
527
 
 
528
 
        This is done by renaming it to give the user some ability to recover
529
 
        if there was a problem.
530
 
 
531
 
        This will have horrible consequences if anyone has anything locked or
532
 
        in use.
533
 
        :param limit: number of times to retry
534
 
        """
535
 
        i  = 0
536
 
        while True:
537
 
            try:
538
 
                to_path = '.bzr.retired.%d' % i
539
 
                self.root_transport.rename('.bzr', to_path)
540
 
                note("renamed %s to %s"
541
 
                    % (self.root_transport.abspath('.bzr'), to_path))
542
 
                return
543
 
            except (errors.TransportError, IOError, errors.PathError):
544
 
                i += 1
545
 
                if i > limit:
546
 
                    raise
547
 
                else:
548
 
                    pass
549
 
 
550
 
    def destroy_workingtree(self):
551
 
        """Destroy the working tree at this BzrDir.
552
 
 
553
 
        Formats that do not support this may raise UnsupportedOperation.
554
 
        """
555
 
        raise NotImplementedError(self.destroy_workingtree)
556
 
 
557
 
    def destroy_workingtree_metadata(self):
558
 
        """Destroy the control files for the working tree at this BzrDir.
559
 
 
560
 
        The contents of working tree files are not affected.
561
 
        Formats that do not support this may raise UnsupportedOperation.
562
 
        """
563
 
        raise NotImplementedError(self.destroy_workingtree_metadata)
564
 
 
565
 
    def _find_containing(self, evaluate):
566
 
        """Find something in a containing control directory.
567
 
 
568
 
        This method will scan containing control dirs, until it finds what
569
 
        it is looking for, decides that it will never find it, or runs out
570
 
        of containing control directories to check.
571
 
 
572
 
        It is used to implement find_repository and
573
 
        determine_repository_policy.
574
 
 
575
 
        :param evaluate: A function returning (value, stop).  If stop is True,
576
 
            the value will be returned.
577
 
        """
578
 
        found_bzrdir = self
579
 
        while True:
580
 
            result, stop = evaluate(found_bzrdir)
581
 
            if stop:
582
 
                return result
583
 
            next_transport = found_bzrdir.root_transport.clone('..')
584
 
            if (found_bzrdir.root_transport.base == next_transport.base):
585
 
                # top of the file system
586
 
                return None
587
 
            # find the next containing bzrdir
588
 
            try:
589
 
                found_bzrdir = BzrDir.open_containing_from_transport(
590
 
                    next_transport)[0]
591
 
            except errors.NotBranchError:
592
 
                return None
593
 
 
594
291
    def find_repository(self):
595
 
        """Find the repository that should be used.
 
292
        """Find the repository that should be used for a_bzrdir.
596
293
 
597
294
        This does not require a branch as we use it to find the repo for
598
295
        new branches as well as to hook existing branches up to their
599
296
        repository.
600
297
        """
601
 
        def usable_repository(found_bzrdir):
602
 
            # does it have a repository ?
 
298
        try:
 
299
            return self.open_repository()
 
300
        except errors.NoRepositoryPresent:
 
301
            pass
 
302
        next_transport = self.root_transport.clone('..')
 
303
        while True:
 
304
            try:
 
305
                found_bzrdir = BzrDir.open_containing_from_transport(
 
306
                    next_transport)[0]
 
307
            except errors.NotBranchError:
 
308
                raise errors.NoRepositoryPresent(self)
603
309
            try:
604
310
                repository = found_bzrdir.open_repository()
605
311
            except errors.NoRepositoryPresent:
606
 
                return None, False
607
 
            if found_bzrdir.root_transport.base == self.root_transport.base:
608
 
                return repository, True
609
 
            elif repository.is_shared():
610
 
                return repository, True
 
312
                next_transport = found_bzrdir.root_transport.clone('..')
 
313
                continue
 
314
            if ((found_bzrdir.root_transport.base == 
 
315
                 self.root_transport.base) or repository.is_shared()):
 
316
                return repository
611
317
            else:
612
 
                return None, True
613
 
 
614
 
        found_repo = self._find_containing(usable_repository)
615
 
        if found_repo is None:
616
 
            raise errors.NoRepositoryPresent(self)
617
 
        return found_repo
618
 
 
619
 
    def get_branch_reference(self):
620
 
        """Return the referenced URL for the branch in this bzrdir.
621
 
 
622
 
        :raises NotBranchError: If there is no Branch.
623
 
        :return: The URL the branch in this bzrdir references if it is a
624
 
            reference branch, or None for regular branches.
625
 
        """
626
 
        return None
 
318
                raise errors.NoRepositoryPresent(self)
 
319
        raise errors.NoRepositoryPresent(self)
627
320
 
628
321
    def get_branch_transport(self, branch_format):
629
322
        """Get the transport for use by branch format in this BzrDir.
630
323
 
631
324
        Note that bzr dirs that do not support format strings will raise
632
325
        IncompatibleFormat if the branch format they are given has
633
 
        a format string, and vice versa.
 
326
        a format string, and vice verca.
634
327
 
635
328
        If branch_format is None, the transport is returned with no 
636
 
        checking. If it is not None, then the returned transport is
 
329
        checking. if it is not None, then the returned transport is
637
330
        guaranteed to point to an existing directory ready for use.
638
331
        """
639
332
        raise NotImplementedError(self.get_branch_transport)
640
 
 
641
 
    def _find_creation_modes(self):
642
 
        """Determine the appropriate modes for files and directories.
643
 
 
644
 
        They're always set to be consistent with the base directory,
645
 
        assuming that this transport allows setting modes.
646
 
        """
647
 
        # TODO: Do we need or want an option (maybe a config setting) to turn
648
 
        # this off or override it for particular locations? -- mbp 20080512
649
 
        if self._mode_check_done:
650
 
            return
651
 
        self._mode_check_done = True
652
 
        try:
653
 
            st = self.transport.stat('.')
654
 
        except errors.TransportNotPossible:
655
 
            self._dir_mode = None
656
 
            self._file_mode = None
657
 
        else:
658
 
            # Check the directory mode, but also make sure the created
659
 
            # directories and files are read-write for this user. This is
660
 
            # mostly a workaround for filesystems which lie about being able to
661
 
            # write to a directory (cygwin & win32)
662
 
            if (st.st_mode & 07777 == 00000):
663
 
                # FTP allows stat but does not return dir/file modes
664
 
                self._dir_mode = None
665
 
                self._file_mode = None
666
 
            else:
667
 
                self._dir_mode = (st.st_mode & 07777) | 00700
668
 
                # Remove the sticky and execute bits for files
669
 
                self._file_mode = self._dir_mode & ~07111
670
 
 
671
 
    def _get_file_mode(self):
672
 
        """Return Unix mode for newly created files, or None.
673
 
        """
674
 
        if not self._mode_check_done:
675
 
            self._find_creation_modes()
676
 
        return self._file_mode
677
 
 
678
 
    def _get_dir_mode(self):
679
 
        """Return Unix mode for newly created directories, or None.
680
 
        """
681
 
        if not self._mode_check_done:
682
 
            self._find_creation_modes()
683
 
        return self._dir_mode
684
333
        
685
334
    def get_repository_transport(self, repository_format):
686
335
        """Get the transport for use by repository format in this BzrDir.
687
336
 
688
337
        Note that bzr dirs that do not support format strings will raise
689
338
        IncompatibleFormat if the repository format they are given has
690
 
        a format string, and vice versa.
 
339
        a format string, and vice verca.
691
340
 
692
341
        If repository_format is None, the transport is returned with no 
693
 
        checking. If it is not None, then the returned transport is
 
342
        checking. if it is not None, then the returned transport is
694
343
        guaranteed to point to an existing directory ready for use.
695
344
        """
696
345
        raise NotImplementedError(self.get_repository_transport)
699
348
        """Get the transport for use by workingtree format in this BzrDir.
700
349
 
701
350
        Note that bzr dirs that do not support format strings will raise
702
 
        IncompatibleFormat if the workingtree format they are given has a
703
 
        format string, and vice versa.
 
351
        IncompatibleFormat if the workingtree format they are given has
 
352
        a format string, and vice verca.
704
353
 
705
354
        If workingtree_format is None, the transport is returned with no 
706
 
        checking. If it is not None, then the returned transport is
 
355
        checking. if it is not None, then the returned transport is
707
356
        guaranteed to point to an existing directory ready for use.
708
357
        """
709
358
        raise NotImplementedError(self.get_workingtree_transport)
710
 
 
711
 
    def get_config(self):
712
 
        if getattr(self, '_get_config', None) is None:
713
 
            return None
714
 
        return self._get_config()
715
 
 
 
359
        
716
360
    def __init__(self, _transport, _format):
717
361
        """Initialize a Bzr control dir object.
718
362
        
725
369
        self._format = _format
726
370
        self.transport = _transport.clone('.bzr')
727
371
        self.root_transport = _transport
728
 
        self._mode_check_done = False
729
 
 
730
 
    def is_control_filename(self, filename):
731
 
        """True if filename is the name of a path which is reserved for bzrdir's.
732
 
        
733
 
        :param filename: A filename within the root transport of this bzrdir.
734
 
 
735
 
        This is true IF and ONLY IF the filename is part of the namespace reserved
736
 
        for bzr control dirs. Currently this is the '.bzr' directory in the root
737
 
        of the root_transport. it is expected that plugins will need to extend
738
 
        this in the future - for instance to make bzr talk with svn working
739
 
        trees.
740
 
        """
741
 
        # this might be better on the BzrDirFormat class because it refers to 
742
 
        # all the possible bzrdir disk formats. 
743
 
        # This method is tested via the workingtree is_control_filename tests- 
744
 
        # it was extracted from WorkingTree.is_control_filename. If the method's
745
 
        # contract is extended beyond the current trivial implementation, please
746
 
        # add new tests for it to the appropriate place.
747
 
        return filename == '.bzr' or filename.startswith('.bzr/')
748
372
 
749
373
    def needs_format_conversion(self, format=None):
750
374
        """Return true if this bzrdir needs convert_format run on it.
763
387
        return BzrDir.open(base, _unsupported=True)
764
388
        
765
389
    @staticmethod
766
 
    def open(base, _unsupported=False, possible_transports=None):
767
 
        """Open an existing bzrdir, rooted at 'base' (url).
 
390
    def open(base, _unsupported=False):
 
391
        """Open an existing bzrdir, rooted at 'base' (url)
768
392
        
769
 
        :param _unsupported: a private parameter to the BzrDir class.
770
 
        """
771
 
        t = get_transport(base, possible_transports=possible_transports)
772
 
        return BzrDir.open_from_transport(t, _unsupported=_unsupported)
773
 
 
774
 
    @staticmethod
775
 
    def open_from_transport(transport, _unsupported=False,
776
 
                            _server_formats=True):
777
 
        """Open a bzrdir within a particular directory.
778
 
 
779
 
        :param transport: Transport containing the bzrdir.
780
 
        :param _unsupported: private.
781
 
        """
782
 
        base = transport.base
783
 
 
784
 
        def find_format(transport):
785
 
            return transport, BzrDirFormat.find_format(
786
 
                transport, _server_formats=_server_formats)
787
 
 
788
 
        def redirected(transport, e, redirection_notice):
789
 
            qualified_source = e.get_source_url()
790
 
            relpath = transport.relpath(qualified_source)
791
 
            if not e.target.endswith(relpath):
792
 
                # Not redirected to a branch-format, not a branch
793
 
                raise errors.NotBranchError(path=e.target)
794
 
            target = e.target[:-len(relpath)]
795
 
            note('%s is%s redirected to %s',
796
 
                 transport.base, e.permanently, target)
797
 
            # Let's try with a new transport
798
 
            # FIXME: If 'transport' has a qualifier, this should
799
 
            # be applied again to the new transport *iff* the
800
 
            # schemes used are the same. Uncomment this code
801
 
            # once the function (and tests) exist.
802
 
            # -- vila20070212
803
 
            #target = urlutils.copy_url_qualifiers(original, target)
804
 
            return get_transport(target)
805
 
 
806
 
        try:
807
 
            transport, format = do_catching_redirections(find_format,
808
 
                                                         transport,
809
 
                                                         redirected)
810
 
        except errors.TooManyRedirections:
811
 
            raise errors.NotBranchError(base)
812
 
 
813
 
        BzrDir._check_supported(format, _unsupported)
814
 
        return format.open(transport, _found=True)
 
393
        _unsupported is a private parameter to the BzrDir class.
 
394
        """
 
395
        t = get_transport(base)
 
396
        mutter("trying to open %r with transport %r", base, t)
 
397
        format = BzrDirFormat.find_format(t)
 
398
        if not _unsupported and not format.is_supported():
 
399
            # see open_downlevel to open legacy branches.
 
400
            raise errors.UnsupportedFormatError(
 
401
                    'sorry, format %s not supported' % format,
 
402
                    ['use a different bzr version',
 
403
                     'or remove the .bzr directory'
 
404
                     ' and "bzr init" again'])
 
405
        return format.open(t, _found=True)
815
406
 
816
407
    def open_branch(self, unsupported=False):
817
408
        """Open the branch object at this BzrDir if one is present.
824
415
        raise NotImplementedError(self.open_branch)
825
416
 
826
417
    @staticmethod
827
 
    def open_containing(url, possible_transports=None):
 
418
    def open_containing(url):
828
419
        """Open an existing branch which contains url.
829
420
        
830
421
        :param url: url to search from.
831
422
        See open_containing_from_transport for more detail.
832
423
        """
833
 
        transport = get_transport(url, possible_transports)
834
 
        return BzrDir.open_containing_from_transport(transport)
 
424
        return BzrDir.open_containing_from_transport(get_transport(url))
835
425
    
836
426
    @staticmethod
837
427
    def open_containing_from_transport(a_transport):
838
 
        """Open an existing branch which contains a_transport.base.
 
428
        """Open an existing branch which contains a_transport.base
839
429
 
840
430
        This probes for a branch at a_transport, and searches upwards from there.
841
431
 
844
434
        If there is one and it is either an unrecognised format or an unsupported 
845
435
        format, UnknownFormatError or UnsupportedFormatError are raised.
846
436
        If there is one, it is returned, along with the unused portion of url.
847
 
 
848
 
        :return: The BzrDir that contains the path, and a Unicode path 
849
 
                for the rest of the URL.
850
437
        """
851
438
        # this gets the normalised url back. I.e. '.' -> the full path.
852
439
        url = a_transport.base
853
440
        while True:
854
441
            try:
855
 
                result = BzrDir.open_from_transport(a_transport)
856
 
                return result, urlutils.unescape(a_transport.relpath(url))
 
442
                format = BzrDirFormat.find_format(a_transport)
 
443
                return format.open(a_transport), a_transport.relpath(url)
857
444
            except errors.NotBranchError, e:
858
 
                pass
859
 
            try:
860
 
                new_t = a_transport.clone('..')
861
 
            except errors.InvalidURLJoin:
862
 
                # reached the root, whatever that may be
863
 
                raise errors.NotBranchError(path=url)
 
445
                mutter('not a branch in: %r %s', a_transport.base, e)
 
446
            new_t = a_transport.clone('..')
864
447
            if new_t.base == a_transport.base:
865
448
                # reached the root, whatever that may be
866
449
                raise errors.NotBranchError(path=url)
867
450
            a_transport = new_t
868
451
 
869
 
    def _get_tree_branch(self):
870
 
        """Return the branch and tree, if any, for this bzrdir.
871
 
 
872
 
        Return None for tree if not present or inaccessible.
873
 
        Raise NotBranchError if no branch is present.
874
 
        :return: (tree, branch)
875
 
        """
876
 
        try:
877
 
            tree = self.open_workingtree()
878
 
        except (errors.NoWorkingTree, errors.NotLocalUrl):
879
 
            tree = None
880
 
            branch = self.open_branch()
881
 
        else:
882
 
            branch = tree.branch
883
 
        return tree, branch
884
 
 
885
 
    @classmethod
886
 
    def open_tree_or_branch(klass, location):
887
 
        """Return the branch and working tree at a location.
888
 
 
889
 
        If there is no tree at the location, tree will be None.
890
 
        If there is no branch at the location, an exception will be
891
 
        raised
892
 
        :return: (tree, branch)
893
 
        """
894
 
        bzrdir = klass.open(location)
895
 
        return bzrdir._get_tree_branch()
896
 
 
897
 
    @classmethod
898
 
    def open_containing_tree_or_branch(klass, location):
899
 
        """Return the branch and working tree contained by a location.
900
 
 
901
 
        Returns (tree, branch, relpath).
902
 
        If there is no tree at containing the location, tree will be None.
903
 
        If there is no branch containing the location, an exception will be
904
 
        raised
905
 
        relpath is the portion of the path that is contained by the branch.
906
 
        """
907
 
        bzrdir, relpath = klass.open_containing(location)
908
 
        tree, branch = bzrdir._get_tree_branch()
909
 
        return tree, branch, relpath
910
 
 
911
 
    @classmethod
912
 
    def open_containing_tree_branch_or_repository(klass, location):
913
 
        """Return the working tree, branch and repo contained by a location.
914
 
 
915
 
        Returns (tree, branch, repository, relpath).
916
 
        If there is no tree containing the location, tree will be None.
917
 
        If there is no branch containing the location, branch will be None.
918
 
        If there is no repository containing the location, repository will be
919
 
        None.
920
 
        relpath is the portion of the path that is contained by the innermost
921
 
        BzrDir.
922
 
 
923
 
        If no tree, branch or repository is found, a NotBranchError is raised.
924
 
        """
925
 
        bzrdir, relpath = klass.open_containing(location)
926
 
        try:
927
 
            tree, branch = bzrdir._get_tree_branch()
928
 
        except errors.NotBranchError:
929
 
            try:
930
 
                repo = bzrdir.find_repository()
931
 
                return None, None, repo, relpath
932
 
            except (errors.NoRepositoryPresent):
933
 
                raise errors.NotBranchError(location)
934
 
        return tree, branch, branch.repository, relpath
935
 
 
936
452
    def open_repository(self, _unsupported=False):
937
453
        """Open the repository object at this BzrDir if one is present.
938
454
 
939
 
        This will not follow the Branch object pointer - it's strictly a direct
 
455
        This will not follow the Branch object pointer - its strictly a direct
940
456
        open facility. Most client code should use open_branch().repository to
941
457
        get at a repository.
942
458
 
943
 
        :param _unsupported: a private parameter, not part of the api.
 
459
        _unsupported is a private parameter, not part of the api.
944
460
        TODO: static convenience version of this?
945
461
        """
946
462
        raise NotImplementedError(self.open_repository)
947
463
 
948
 
    def open_workingtree(self, _unsupported=False,
949
 
                         recommend_upgrade=True, from_branch=None):
 
464
    def open_workingtree(self, _unsupported=False):
950
465
        """Open the workingtree object at this BzrDir if one is present.
951
 
 
952
 
        :param recommend_upgrade: Optional keyword parameter, when True (the
953
 
            default), emit through the ui module a recommendation that the user
954
 
            upgrade the working tree when the workingtree being opened is old
955
 
            (but still fully supported).
956
 
        :param from_branch: override bzrdir branch (for lightweight checkouts)
 
466
        
 
467
        TODO: static convenience version of this?
957
468
        """
958
469
        raise NotImplementedError(self.open_workingtree)
959
470
 
960
 
    def has_branch(self):
961
 
        """Tell if this bzrdir contains a branch.
962
 
        
963
 
        Note: if you're going to open the branch, you should just go ahead
964
 
        and try, and not ask permission first.  (This method just opens the 
965
 
        branch and discards it, and that's somewhat expensive.) 
966
 
        """
967
 
        try:
968
 
            self.open_branch()
969
 
            return True
970
 
        except errors.NotBranchError:
971
 
            return False
972
 
 
973
 
    def has_workingtree(self):
974
 
        """Tell if this bzrdir contains a working tree.
975
 
 
976
 
        This will still raise an exception if the bzrdir has a workingtree that
977
 
        is remote & inaccessible.
978
 
        
979
 
        Note: if you're going to open the working tree, you should just go ahead
980
 
        and try, and not ask permission first.  (This method just opens the 
981
 
        workingtree and discards it, and that's somewhat expensive.) 
982
 
        """
983
 
        try:
984
 
            self.open_workingtree(recommend_upgrade=False)
985
 
            return True
986
 
        except errors.NoWorkingTree:
987
 
            return False
988
 
 
989
 
    def _cloning_metadir(self):
990
 
        """Produce a metadir suitable for cloning with.
991
 
        
992
 
        :returns: (destination_bzrdir_format, source_repository)
993
 
        """
994
 
        result_format = self._format.__class__()
995
 
        try:
996
 
            try:
997
 
                branch = self.open_branch()
998
 
                source_repository = branch.repository
999
 
                result_format._branch_format = branch._format
1000
 
            except errors.NotBranchError:
1001
 
                source_branch = None
1002
 
                source_repository = self.open_repository()
1003
 
        except errors.NoRepositoryPresent:
1004
 
            source_repository = None
1005
 
        else:
1006
 
            # XXX TODO: This isinstance is here because we have not implemented
1007
 
            # the fix recommended in bug # 103195 - to delegate this choice the
1008
 
            # repository itself.
1009
 
            repo_format = source_repository._format
1010
 
            if not isinstance(repo_format, remote.RemoteRepositoryFormat):
1011
 
                result_format.repository_format = repo_format
1012
 
        try:
1013
 
            # TODO: Couldn't we just probe for the format in these cases,
1014
 
            # rather than opening the whole tree?  It would be a little
1015
 
            # faster. mbp 20070401
1016
 
            tree = self.open_workingtree(recommend_upgrade=False)
1017
 
        except (errors.NoWorkingTree, errors.NotLocalUrl):
1018
 
            result_format.workingtree_format = None
1019
 
        else:
1020
 
            result_format.workingtree_format = tree._format.__class__()
1021
 
        return result_format, source_repository
1022
 
 
1023
 
    def cloning_metadir(self, require_stacking=False):
1024
 
        """Produce a metadir suitable for cloning or sprouting with.
1025
 
 
1026
 
        These operations may produce workingtrees (yes, even though they're
1027
 
        "cloning" something that doesn't have a tree), so a viable workingtree
1028
 
        format must be selected.
1029
 
 
1030
 
        :require_stacking: If True, non-stackable formats will be upgraded
1031
 
            to similar stackable formats.
1032
 
        :returns: a BzrDirFormat with all component formats either set
1033
 
            appropriately or set to None if that component should not be
1034
 
            created.
1035
 
        """
1036
 
        format, repository = self._cloning_metadir()
1037
 
        if format._workingtree_format is None:
1038
 
            if repository is None:
1039
 
                return format
1040
 
            tree_format = repository._format._matchingbzrdir.workingtree_format
1041
 
            format.workingtree_format = tree_format.__class__()
1042
 
        if (require_stacking and not
1043
 
            format.get_branch_format().supports_stacking()):
1044
 
            # We need to make a stacked branch, but the default format for the
1045
 
            # target doesn't support stacking.  So force a branch that *can*
1046
 
            # support stacking.
1047
 
            from bzrlib.branch import BzrBranchFormat7
1048
 
            format._branch_format = BzrBranchFormat7()
1049
 
            mutter("using %r for stacking" % (format._branch_format,))
1050
 
            from bzrlib.repofmt import pack_repo
1051
 
            if format.repository_format.rich_root_data:
1052
 
                bzrdir_format_name = '1.6.1-rich-root'
1053
 
                repo_format = pack_repo.RepositoryFormatKnitPack5RichRoot()
1054
 
            else:
1055
 
                bzrdir_format_name = '1.6'
1056
 
                repo_format = pack_repo.RepositoryFormatKnitPack5()
1057
 
            note('Source format does not support stacking, using format:'
1058
 
                 ' \'%s\'\n  %s\n',
1059
 
                 bzrdir_format_name, repo_format.get_format_description())
1060
 
            format.repository_format = repo_format
1061
 
        return format
1062
 
 
1063
 
    def checkout_metadir(self):
1064
 
        return self.cloning_metadir()
1065
 
 
1066
 
    def sprout(self, url, revision_id=None, force_new_repo=False,
1067
 
               recurse='down', possible_transports=None,
1068
 
               accelerator_tree=None, hardlink=False, stacked=False):
 
471
    def sprout(self, url, revision_id=None, basis=None, force_new_repo=False):
1069
472
        """Create a copy of this bzrdir prepared for use as a new line of
1070
473
        development.
1071
474
 
1072
 
        If url's last component does not exist, it will be created.
 
475
        If urls last component does not exist, it will be created.
1073
476
 
1074
477
        Attributes related to the identity of the source branch like
1075
478
        branch nickname will be cleaned, a working tree is created
1078
481
 
1079
482
        if revision_id is not None, then the clone operation may tune
1080
483
            itself to download less data.
1081
 
        :param accelerator_tree: A tree which can be used for retrieving file
1082
 
            contents more quickly than the revision tree, i.e. a workingtree.
1083
 
            The revision tree will be used for cases where accelerator_tree's
1084
 
            content is different.
1085
 
        :param hardlink: If true, hard-link files from accelerator_tree,
1086
 
            where possible.
1087
 
        :param stacked: If true, create a stacked branch referring to the
1088
 
            location of this control directory.
1089
484
        """
1090
 
        target_transport = get_transport(url, possible_transports)
1091
 
        target_transport.ensure_base()
1092
 
        cloning_format = self.cloning_metadir(stacked)
1093
 
        # Create/update the result branch
1094
 
        result = cloning_format.initialize_on_transport(target_transport)
 
485
        self._make_tail(url)
 
486
        result = self._format.initialize(url)
 
487
        basis_repo, basis_branch, basis_tree = self._get_basis_components(basis)
1095
488
        try:
1096
489
            source_branch = self.open_branch()
1097
490
            source_repository = source_branch.repository
1098
 
            if stacked:
1099
 
                stacked_branch_url = self.root_transport.base
1100
 
            else:
1101
 
                # if a stacked branch wasn't requested, we don't create one
1102
 
                # even if the origin was stacked
1103
 
                stacked_branch_url = None
1104
491
        except errors.NotBranchError:
1105
492
            source_branch = None
1106
493
            try:
1107
494
                source_repository = self.open_repository()
1108
495
            except errors.NoRepositoryPresent:
1109
 
                source_repository = None
1110
 
            stacked_branch_url = None
1111
 
        repository_policy = result.determine_repository_policy(
1112
 
            force_new_repo, stacked_branch_url, require_stacking=stacked)
1113
 
        result_repo = repository_policy.acquire_repository()
1114
 
        if source_repository is not None:
1115
 
            # Fetch while stacked to prevent unstacked fetch from
1116
 
            # Branch.sprout.
 
496
                # copy the entire basis one if there is one
 
497
                # but there is no repository.
 
498
                source_repository = basis_repo
 
499
        if force_new_repo:
 
500
            result_repo = None
 
501
        else:
 
502
            try:
 
503
                result_repo = result.find_repository()
 
504
            except errors.NoRepositoryPresent:
 
505
                result_repo = None
 
506
        if source_repository is None and result_repo is not None:
 
507
            pass
 
508
        elif source_repository is None and result_repo is None:
 
509
            # no repo available, make a new one
 
510
            result.create_repository()
 
511
        elif source_repository is not None and result_repo is None:
 
512
            # have soure, and want to make a new target repo
 
513
            source_repository.clone(result,
 
514
                                    revision_id=revision_id,
 
515
                                    basis=basis_repo)
 
516
        else:
 
517
            # fetch needed content into target.
 
518
            if basis_repo:
 
519
                # XXX FIXME RBC 20060214 need tests for this when the basis
 
520
                # is incomplete
 
521
                result_repo.fetch(basis_repo, revision_id=revision_id)
1117
522
            result_repo.fetch(source_repository, revision_id=revision_id)
1118
 
 
1119
 
        if source_branch is None:
1120
 
            # this is for sprouting a bzrdir without a branch; is that
1121
 
            # actually useful?
1122
 
            # Not especially, but it's part of the contract.
1123
 
            result_branch = result.create_branch()
1124
 
        else:
1125
 
            # Force NULL revision to avoid using repository before stacking
1126
 
            # is configured.
1127
 
            result_branch = source_branch.sprout(
1128
 
                result, revision_id=_mod_revision.NULL_REVISION)
1129
 
            parent_location = result_branch.get_parent()
1130
 
        mutter("created new branch %r" % (result_branch,))
1131
 
        repository_policy.configure_branch(result_branch)
1132
523
        if source_branch is not None:
1133
 
            source_branch.copy_content_into(result_branch, revision_id)
1134
 
            # Override copy_content_into
1135
 
            result_branch.set_parent(parent_location)
1136
 
 
1137
 
        # Create/update the result working tree
1138
 
        if isinstance(target_transport, LocalTransport) and (
1139
 
            result_repo is None or result_repo.make_working_trees()):
1140
 
            wt = result.create_workingtree(accelerator_tree=accelerator_tree,
1141
 
                hardlink=hardlink)
1142
 
            wt.lock_write()
1143
 
            try:
1144
 
                if wt.path2id('') is None:
1145
 
                    try:
1146
 
                        wt.set_root_id(self.open_workingtree.get_root_id())
1147
 
                    except errors.NoWorkingTree:
1148
 
                        pass
1149
 
            finally:
1150
 
                wt.unlock()
 
524
            source_branch.sprout(result, revision_id=revision_id)
1151
525
        else:
1152
 
            wt = None
1153
 
        if recurse == 'down':
1154
 
            if wt is not None:
1155
 
                basis = wt.basis_tree()
1156
 
                basis.lock_read()
1157
 
                subtrees = basis.iter_references()
1158
 
            elif source_branch is not None:
1159
 
                basis = source_branch.basis_tree()
1160
 
                basis.lock_read()
1161
 
                subtrees = basis.iter_references()
1162
 
            else:
1163
 
                subtrees = []
1164
 
                basis = None
1165
 
            try:
1166
 
                for path, file_id in subtrees:
1167
 
                    target = urlutils.join(url, urlutils.escape(path))
1168
 
                    sublocation = source_branch.reference_parent(file_id, path)
1169
 
                    sublocation.bzrdir.sprout(target,
1170
 
                        basis.get_reference_revision(file_id, path),
1171
 
                        force_new_repo=force_new_repo, recurse=recurse,
1172
 
                        stacked=stacked)
1173
 
            finally:
1174
 
                if basis is not None:
1175
 
                    basis.unlock()
 
526
            result.create_branch()
 
527
        result.create_workingtree()
1176
528
        return result
1177
529
 
1178
530
 
1182
534
    def __init__(self, _transport, _format):
1183
535
        """See BzrDir.__init__."""
1184
536
        super(BzrDirPreSplitOut, self).__init__(_transport, _format)
1185
 
        self._control_files = lockable_files.LockableFiles(
1186
 
                                            self.get_branch_transport(None),
1187
 
                                            self._format._lock_file_name,
1188
 
                                            self._format._lock_class)
1189
 
 
1190
 
    def break_lock(self):
1191
 
        """Pre-splitout bzrdirs do not suffer from stale locks."""
1192
 
        raise NotImplementedError(self.break_lock)
1193
 
 
1194
 
    def cloning_metadir(self, require_stacking=False):
1195
 
        """Produce a metadir suitable for cloning with."""
1196
 
        if require_stacking:
1197
 
            return format_registry.make_bzrdir('1.6')
1198
 
        return self._format.__class__()
1199
 
 
1200
 
    def clone(self, url, revision_id=None, force_new_repo=False,
1201
 
              preserve_stacking=False):
1202
 
        """See BzrDir.clone().
1203
 
 
1204
 
        force_new_repo has no effect, since this family of formats always
1205
 
        require a new repository.
1206
 
        preserve_stacking has no effect, since no source branch using this
1207
 
        family of formats can be stacked, so there is no stacking to preserve.
1208
 
        """
 
537
        self._control_files = LockableFiles(self.get_branch_transport(None),
 
538
                                            'branch-lock')
 
539
 
 
540
    def clone(self, url, revision_id=None, basis=None, force_new_repo=False):
 
541
        """See BzrDir.clone()."""
 
542
        from bzrlib.workingtree import WorkingTreeFormat2
1209
543
        self._make_tail(url)
1210
 
        result = self._format._initialize_for_clone(url)
1211
 
        self.open_repository().clone(result, revision_id=revision_id)
1212
 
        from_branch = self.open_branch()
1213
 
        from_branch.clone(result, revision_id=revision_id)
 
544
        result = self._format.initialize(url, _cloning=True)
 
545
        basis_repo, basis_branch, basis_tree = self._get_basis_components(basis)
 
546
        self.open_repository().clone(result, revision_id=revision_id, basis=basis_repo)
 
547
        self.open_branch().clone(result, revision_id=revision_id)
1214
548
        try:
1215
 
            tree = self.open_workingtree()
 
549
            self.open_workingtree().clone(result, basis=basis_tree)
1216
550
        except errors.NotLocalUrl:
1217
551
            # make a new one, this format always has to have one.
1218
 
            result._init_workingtree()
1219
 
        else:
1220
 
            tree.clone(result)
 
552
            WorkingTreeFormat2().initialize(result)
1221
553
        return result
1222
554
 
1223
555
    def create_branch(self):
1224
556
        """See BzrDir.create_branch."""
1225
 
        return self._format.get_branch_format().initialize(self)
1226
 
 
1227
 
    def destroy_branch(self):
1228
 
        """See BzrDir.destroy_branch."""
1229
 
        raise errors.UnsupportedOperation(self.destroy_branch, self)
 
557
        return self.open_branch()
1230
558
 
1231
559
    def create_repository(self, shared=False):
1232
560
        """See BzrDir.create_repository."""
1234
562
            raise errors.IncompatibleFormat('shared repository', self._format)
1235
563
        return self.open_repository()
1236
564
 
1237
 
    def destroy_repository(self):
1238
 
        """See BzrDir.destroy_repository."""
1239
 
        raise errors.UnsupportedOperation(self.destroy_repository, self)
1240
 
 
1241
 
    def create_workingtree(self, revision_id=None, from_branch=None,
1242
 
                           accelerator_tree=None, hardlink=False):
 
565
    def create_workingtree(self, revision_id=None):
1243
566
        """See BzrDir.create_workingtree."""
1244
 
        # The workingtree is sometimes created when the bzrdir is created,
1245
 
        # but not when cloning.
1246
 
 
1247
567
        # this looks buggy but is not -really-
1248
 
        # because this format creates the workingtree when the bzrdir is
1249
 
        # created
1250
568
        # clone and sprout will have set the revision_id
1251
569
        # and that will have set it for us, its only
1252
570
        # specific uses of create_workingtree in isolation
1253
571
        # that can do wonky stuff here, and that only
1254
572
        # happens for creating checkouts, which cannot be 
1255
573
        # done on this format anyway. So - acceptable wart.
1256
 
        try:
1257
 
            result = self.open_workingtree(recommend_upgrade=False)
1258
 
        except errors.NoSuchFile:
1259
 
            result = self._init_workingtree()
 
574
        result = self.open_workingtree()
1260
575
        if revision_id is not None:
1261
 
            if revision_id == _mod_revision.NULL_REVISION:
1262
 
                result.set_parent_ids([])
1263
 
            else:
1264
 
                result.set_parent_ids([revision_id])
 
576
            result.set_last_revision(revision_id)
1265
577
        return result
1266
578
 
1267
 
    def _init_workingtree(self):
1268
 
        from bzrlib.workingtree import WorkingTreeFormat2
1269
 
        try:
1270
 
            return WorkingTreeFormat2().initialize(self)
1271
 
        except errors.NotLocalUrl:
1272
 
            # Even though we can't access the working tree, we need to
1273
 
            # create its control files.
1274
 
            return WorkingTreeFormat2()._stub_initialize_on_transport(
1275
 
                self.transport, self._control_files._file_mode)
1276
 
 
1277
 
    def destroy_workingtree(self):
1278
 
        """See BzrDir.destroy_workingtree."""
1279
 
        raise errors.UnsupportedOperation(self.destroy_workingtree, self)
1280
 
 
1281
 
    def destroy_workingtree_metadata(self):
1282
 
        """See BzrDir.destroy_workingtree_metadata."""
1283
 
        raise errors.UnsupportedOperation(self.destroy_workingtree_metadata, 
1284
 
                                          self)
1285
 
 
1286
579
    def get_branch_transport(self, branch_format):
1287
580
        """See BzrDir.get_branch_transport()."""
1288
581
        if branch_format is None:
1328
621
        self._check_supported(format, unsupported)
1329
622
        return format.open(self, _found=True)
1330
623
 
1331
 
    def sprout(self, url, revision_id=None, force_new_repo=False,
1332
 
               possible_transports=None, accelerator_tree=None,
1333
 
               hardlink=False, stacked=False):
 
624
    def sprout(self, url, revision_id=None, basis=None):
1334
625
        """See BzrDir.sprout()."""
1335
 
        if stacked:
1336
 
            raise errors.UnstackableBranchFormat(
1337
 
                self._format, self.root_transport.base)
1338
626
        from bzrlib.workingtree import WorkingTreeFormat2
1339
627
        self._make_tail(url)
1340
 
        result = self._format._initialize_for_clone(url)
 
628
        result = self._format.initialize(url, _cloning=True)
 
629
        basis_repo, basis_branch, basis_tree = self._get_basis_components(basis)
1341
630
        try:
1342
 
            self.open_repository().clone(result, revision_id=revision_id)
 
631
            self.open_repository().clone(result, revision_id=revision_id, basis=basis_repo)
1343
632
        except errors.NoRepositoryPresent:
1344
633
            pass
1345
634
        try:
1347
636
        except errors.NotBranchError:
1348
637
            pass
1349
638
        # we always want a working tree
1350
 
        WorkingTreeFormat2().initialize(result,
1351
 
                                        accelerator_tree=accelerator_tree,
1352
 
                                        hardlink=hardlink)
 
639
        WorkingTreeFormat2().initialize(result)
1353
640
        return result
1354
641
 
1355
642
 
1369
656
 
1370
657
    def open_repository(self):
1371
658
        """See BzrDir.open_repository."""
1372
 
        from bzrlib.repofmt.weaverepo import RepositoryFormat4
 
659
        from bzrlib.repository import RepositoryFormat4
1373
660
        return RepositoryFormat4().open(self, _found=True)
1374
661
 
1375
662
 
1381
668
 
1382
669
    def open_repository(self):
1383
670
        """See BzrDir.open_repository."""
1384
 
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
 
671
        from bzrlib.repository import RepositoryFormat5
1385
672
        return RepositoryFormat5().open(self, _found=True)
1386
673
 
1387
 
    def open_workingtree(self, _unsupported=False,
1388
 
            recommend_upgrade=True):
 
674
    def open_workingtree(self, _unsupported=False):
1389
675
        """See BzrDir.create_workingtree."""
1390
676
        from bzrlib.workingtree import WorkingTreeFormat2
1391
 
        wt_format = WorkingTreeFormat2()
1392
 
        # we don't warn here about upgrades; that ought to be handled for the
1393
 
        # bzrdir as a whole
1394
 
        return wt_format.open(self, _found=True)
 
677
        return WorkingTreeFormat2().open(self, _found=True)
1395
678
 
1396
679
 
1397
680
class BzrDir6(BzrDirPreSplitOut):
1402
685
 
1403
686
    def open_repository(self):
1404
687
        """See BzrDir.open_repository."""
1405
 
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
 
688
        from bzrlib.repository import RepositoryFormat6
1406
689
        return RepositoryFormat6().open(self, _found=True)
1407
690
 
1408
 
    def open_workingtree(self, _unsupported=False,
1409
 
        recommend_upgrade=True):
 
691
    def open_workingtree(self, _unsupported=False):
1410
692
        """See BzrDir.create_workingtree."""
1411
 
        # we don't warn here about upgrades; that ought to be handled for the
1412
 
        # bzrdir as a whole
1413
693
        from bzrlib.workingtree import WorkingTreeFormat2
1414
694
        return WorkingTreeFormat2().open(self, _found=True)
1415
695
 
1418
698
    """A .bzr meta version 1 control object.
1419
699
    
1420
700
    This is the first control object where the 
1421
 
    individual aspects are really split out: there are separate repository,
1422
 
    workingtree and branch subdirectories and any subset of the three can be
1423
 
    present within a BzrDir.
 
701
    individual formats are really split out.
1424
702
    """
1425
703
 
1426
704
    def can_convert_format(self):
1429
707
 
1430
708
    def create_branch(self):
1431
709
        """See BzrDir.create_branch."""
1432
 
        return self._format.get_branch_format().initialize(self)
1433
 
 
1434
 
    def destroy_branch(self):
1435
 
        """See BzrDir.create_branch."""
1436
 
        self.transport.delete_tree('branch')
 
710
        from bzrlib.branch import BranchFormat
 
711
        return BranchFormat.get_default_format().initialize(self)
1437
712
 
1438
713
    def create_repository(self, shared=False):
1439
714
        """See BzrDir.create_repository."""
1440
715
        return self._format.repository_format.initialize(self, shared)
1441
716
 
1442
 
    def destroy_repository(self):
1443
 
        """See BzrDir.destroy_repository."""
1444
 
        self.transport.delete_tree('repository')
1445
 
 
1446
 
    def create_workingtree(self, revision_id=None, from_branch=None,
1447
 
                           accelerator_tree=None, hardlink=False):
 
717
    def create_workingtree(self, revision_id=None):
1448
718
        """See BzrDir.create_workingtree."""
1449
 
        return self._format.workingtree_format.initialize(
1450
 
            self, revision_id, from_branch=from_branch,
1451
 
            accelerator_tree=accelerator_tree, hardlink=hardlink)
1452
 
 
1453
 
    def destroy_workingtree(self):
1454
 
        """See BzrDir.destroy_workingtree."""
1455
 
        wt = self.open_workingtree(recommend_upgrade=False)
1456
 
        repository = wt.branch.repository
1457
 
        empty = repository.revision_tree(_mod_revision.NULL_REVISION)
1458
 
        wt.revert(old_tree=empty)
1459
 
        self.destroy_workingtree_metadata()
1460
 
 
1461
 
    def destroy_workingtree_metadata(self):
1462
 
        self.transport.delete_tree('checkout')
1463
 
 
1464
 
    def find_branch_format(self):
1465
 
        """Find the branch 'format' for this bzrdir.
1466
 
 
1467
 
        This might be a synthetic object for e.g. RemoteBranch and SVN.
1468
 
        """
1469
 
        from bzrlib.branch import BranchFormat
1470
 
        return BranchFormat.find_format(self)
1471
 
 
1472
 
    def _get_mkdir_mode(self):
1473
 
        """Figure out the mode to use when creating a bzrdir subdir."""
1474
 
        temp_control = lockable_files.LockableFiles(self.transport, '',
1475
 
                                     lockable_files.TransportLock)
1476
 
        return temp_control._dir_mode
1477
 
 
1478
 
    def get_branch_reference(self):
1479
 
        """See BzrDir.get_branch_reference()."""
1480
 
        from bzrlib.branch import BranchFormat
1481
 
        format = BranchFormat.find_format(self)
1482
 
        return format.get_reference(self)
 
719
        from bzrlib.workingtree import WorkingTreeFormat
 
720
        return WorkingTreeFormat.get_default_format().initialize(self, revision_id)
1483
721
 
1484
722
    def get_branch_transport(self, branch_format):
1485
723
        """See BzrDir.get_branch_transport()."""
1490
728
        except NotImplementedError:
1491
729
            raise errors.IncompatibleFormat(branch_format, self._format)
1492
730
        try:
1493
 
            self.transport.mkdir('branch', mode=self._get_mkdir_mode())
 
731
            self.transport.mkdir('branch')
1494
732
        except errors.FileExists:
1495
733
            pass
1496
734
        return self.transport.clone('branch')
1504
742
        except NotImplementedError:
1505
743
            raise errors.IncompatibleFormat(repository_format, self._format)
1506
744
        try:
1507
 
            self.transport.mkdir('repository', mode=self._get_mkdir_mode())
 
745
            self.transport.mkdir('repository')
1508
746
        except errors.FileExists:
1509
747
            pass
1510
748
        return self.transport.clone('repository')
1518
756
        except NotImplementedError:
1519
757
            raise errors.IncompatibleFormat(workingtree_format, self._format)
1520
758
        try:
1521
 
            self.transport.mkdir('checkout', mode=self._get_mkdir_mode())
 
759
            self.transport.mkdir('checkout')
1522
760
        except errors.FileExists:
1523
761
            pass
1524
762
        return self.transport.clone('checkout')
1538
776
                return True
1539
777
        except errors.NoRepositoryPresent:
1540
778
            pass
1541
 
        try:
1542
 
            if not isinstance(self.open_branch()._format,
1543
 
                              format.get_branch_format().__class__):
1544
 
                # the branch needs an upgrade.
1545
 
                return True
1546
 
        except errors.NotBranchError:
1547
 
            pass
1548
 
        try:
1549
 
            my_wt = self.open_workingtree(recommend_upgrade=False)
1550
 
            if not isinstance(my_wt._format,
1551
 
                              format.workingtree_format.__class__):
1552
 
                # the workingtree needs an upgrade.
1553
 
                return True
1554
 
        except (errors.NoWorkingTree, errors.NotLocalUrl):
1555
 
            pass
 
779
        # currently there are no other possible conversions for meta1 formats.
1556
780
        return False
1557
781
 
1558
782
    def open_branch(self, unsupported=False):
1559
783
        """See BzrDir.open_branch."""
1560
 
        format = self.find_branch_format()
 
784
        from bzrlib.branch import BranchFormat
 
785
        format = BranchFormat.find_format(self)
1561
786
        self._check_supported(format, unsupported)
1562
787
        return format.open(self, _found=True)
1563
788
 
1568
793
        self._check_supported(format, unsupported)
1569
794
        return format.open(self, _found=True)
1570
795
 
1571
 
    def open_workingtree(self, unsupported=False,
1572
 
            recommend_upgrade=True):
 
796
    def open_workingtree(self, unsupported=False):
1573
797
        """See BzrDir.open_workingtree."""
1574
798
        from bzrlib.workingtree import WorkingTreeFormat
1575
799
        format = WorkingTreeFormat.find_format(self)
1576
 
        self._check_supported(format, unsupported,
1577
 
            recommend_upgrade,
1578
 
            basedir=self.root_transport.base)
 
800
        self._check_supported(format, unsupported)
1579
801
        return format.open(self, _found=True)
1580
802
 
1581
 
    def _get_config(self):
1582
 
        return config.BzrDirConfig(self.transport)
1583
 
 
1584
803
 
1585
804
class BzrDirFormat(object):
1586
805
    """An encapsulation of the initialization and open routines for a format.
1590
809
     * a format string,
1591
810
     * an open routine.
1592
811
 
1593
 
    Formats are placed in a dict by their format string for reference 
 
812
    Formats are placed in an dict by their format string for reference 
1594
813
    during bzrdir opening. These should be subclasses of BzrDirFormat
1595
814
    for consistency.
1596
815
 
1605
824
    _formats = {}
1606
825
    """The known formats."""
1607
826
 
1608
 
    _control_formats = []
1609
 
    """The registered control formats - .bzr, ....
1610
 
    
1611
 
    This is a list of BzrDirFormat objects.
1612
 
    """
1613
 
 
1614
 
    _control_server_formats = []
1615
 
    """The registered control server formats, e.g. RemoteBzrDirs.
1616
 
 
1617
 
    This is a list of BzrDirFormat objects.
1618
 
    """
1619
 
 
1620
 
    _lock_file_name = 'branch-lock'
1621
 
 
1622
 
    # _lock_class must be set in subclasses to the lock type, typ.
1623
 
    # TransportLock or LockDir
1624
 
 
1625
 
    @classmethod
1626
 
    def find_format(klass, transport, _server_formats=True):
1627
 
        """Return the format present at transport."""
1628
 
        if _server_formats:
1629
 
            formats = klass._control_server_formats + klass._control_formats
1630
 
        else:
1631
 
            formats = klass._control_formats
1632
 
        for format in formats:
1633
 
            try:
1634
 
                return format.probe_transport(transport)
1635
 
            except errors.NotBranchError:
1636
 
                # this format does not find a control dir here.
1637
 
                pass
1638
 
        raise errors.NotBranchError(path=transport.base)
1639
 
 
1640
 
    @classmethod
1641
 
    def probe_transport(klass, transport):
1642
 
        """Return the .bzrdir style format present in a directory."""
 
827
    @classmethod
 
828
    def find_format(klass, transport):
 
829
        """Return the format registered for URL."""
1643
830
        try:
1644
831
            format_string = transport.get(".bzr/branch-format").read()
1645
 
        except errors.NoSuchFile:
1646
 
            raise errors.NotBranchError(path=transport.base)
1647
 
 
1648
 
        try:
1649
832
            return klass._formats[format_string]
 
833
        except errors.NoSuchFile:
 
834
            raise errors.NotBranchError(path=transport.base)
1650
835
        except KeyError:
1651
 
            raise errors.UnknownFormatError(format=format_string, kind='bzrdir')
 
836
            raise errors.UnknownFormatError(format_string)
1652
837
 
1653
838
    @classmethod
1654
839
    def get_default_format(klass):
1659
844
        """Return the ASCII format string that identifies this format."""
1660
845
        raise NotImplementedError(self.get_format_string)
1661
846
 
1662
 
    def get_format_description(self):
1663
 
        """Return the short description for this format."""
1664
 
        raise NotImplementedError(self.get_format_description)
1665
 
 
1666
847
    def get_converter(self, format=None):
1667
848
        """Return the converter to use to convert bzrdirs needing converts.
1668
849
 
1669
850
        This returns a bzrlib.bzrdir.Converter object.
1670
851
 
1671
852
        This should return the best upgrader to step this format towards the
1672
 
        current default format. In the case of plugins we can/should provide
 
853
        current default format. In the case of plugins we can/shouold provide
1673
854
        some means for them to extend the range of returnable converters.
1674
855
 
1675
 
        :param format: Optional format to override the default format of the 
 
856
        :param format: Optional format to override the default foramt of the 
1676
857
                       library.
1677
858
        """
1678
859
        raise NotImplementedError(self.get_converter)
1679
860
 
1680
 
    def initialize(self, url, possible_transports=None):
1681
 
        """Create a bzr control dir at this url and return an opened copy.
1682
 
        
1683
 
        Subclasses should typically override initialize_on_transport
1684
 
        instead of this method.
1685
 
        """
1686
 
        return self.initialize_on_transport(get_transport(url,
1687
 
                                                          possible_transports))
1688
 
 
1689
 
    def initialize_on_transport(self, transport):
1690
 
        """Initialize a new bzrdir in the base directory of a Transport."""
 
861
    def initialize(self, url):
 
862
        """Create a bzr control dir at this url and return an opened copy."""
1691
863
        # Since we don't have a .bzr directory, inherit the
1692
864
        # mode from the root directory
1693
 
        temp_control = lockable_files.LockableFiles(transport,
1694
 
                            '', lockable_files.TransportLock)
 
865
        t = get_transport(url)
 
866
        temp_control = LockableFiles(t, '')
1695
867
        temp_control._transport.mkdir('.bzr',
1696
 
                                      # FIXME: RBC 20060121 don't peek under
 
868
                                      # FIXME: RBC 20060121 dont peek under
1697
869
                                      # the covers
1698
870
                                      mode=temp_control._dir_mode)
1699
 
        if sys.platform == 'win32' and isinstance(transport, LocalTransport):
1700
 
            win32utils.set_file_attr_hidden(transport._abspath('.bzr'))
1701
871
        file_mode = temp_control._file_mode
1702
872
        del temp_control
1703
 
        bzrdir_transport = transport.clone('.bzr')
1704
 
        utf8_files = [('README',
1705
 
                       "This is a Bazaar control directory.\n"
1706
 
                       "Do not change any files in this directory.\n"
1707
 
                       "See http://bazaar-vcs.org/ for more information about Bazaar.\n"),
 
873
        mutter('created control directory in ' + t.base)
 
874
        control = t.clone('.bzr')
 
875
        lock_file = 'branch-lock'
 
876
        utf8_files = [('README', 
 
877
                       "This is a Bazaar-NG control directory.\n"
 
878
                       "Do not change any files in this directory.\n"),
1708
879
                      ('branch-format', self.get_format_string()),
1709
880
                      ]
1710
881
        # NB: no need to escape relative paths that are url safe.
1711
 
        control_files = lockable_files.LockableFiles(bzrdir_transport,
1712
 
            self._lock_file_name, self._lock_class)
1713
 
        control_files.create_lock()
 
882
        control.put(lock_file, StringIO(), mode=file_mode)
 
883
        control_files = LockableFiles(control, lock_file)
1714
884
        control_files.lock_write()
1715
885
        try:
1716
 
            for (filename, content) in utf8_files:
1717
 
                bzrdir_transport.put_bytes(filename, content,
1718
 
                    mode=file_mode)
 
886
            for file, content in utf8_files:
 
887
                control_files.put_utf8(file, content)
1719
888
        finally:
1720
889
            control_files.unlock()
1721
 
        return self.open(transport, _found=True)
 
890
        return self.open(t, _found=True)
1722
891
 
1723
892
    def is_supported(self):
1724
893
        """Is this format supported?
1729
898
        """
1730
899
        return True
1731
900
 
1732
 
    def same_model(self, target_format):
1733
 
        return (self.repository_format.rich_root_data == 
1734
 
            target_format.rich_root_data)
1735
 
 
1736
 
    @classmethod
1737
 
    def known_formats(klass):
1738
 
        """Return all the known formats.
1739
 
        
1740
 
        Concrete formats should override _known_formats.
1741
 
        """
1742
 
        # There is double indirection here to make sure that control 
1743
 
        # formats used by more than one dir format will only be probed 
1744
 
        # once. This can otherwise be quite expensive for remote connections.
1745
 
        result = set()
1746
 
        for format in klass._control_formats:
1747
 
            result.update(format._known_formats())
1748
 
        return result
1749
 
    
1750
 
    @classmethod
1751
 
    def _known_formats(klass):
1752
 
        """Return the known format instances for this control format."""
1753
 
        return set(klass._formats.values())
1754
 
 
1755
901
    def open(self, transport, _found=False):
1756
902
        """Return an instance of this format for the dir transport points at.
1757
903
        
1758
904
        _found is a private parameter, do not use it.
1759
905
        """
1760
906
        if not _found:
1761
 
            found_format = BzrDirFormat.find_format(transport)
1762
 
            if not isinstance(found_format, self.__class__):
1763
 
                raise AssertionError("%s was asked to open %s, but it seems to need "
1764
 
                        "format %s" 
1765
 
                        % (self, transport, found_format))
 
907
            assert isinstance(BzrDirFormat.find_format(transport),
 
908
                              self.__class__)
1766
909
        return self._open(transport)
1767
910
 
1768
911
    def _open(self, transport):
1778
921
        klass._formats[format.get_format_string()] = format
1779
922
 
1780
923
    @classmethod
1781
 
    def register_control_format(klass, format):
1782
 
        """Register a format that does not use '.bzr' for its control dir.
1783
 
 
1784
 
        TODO: This should be pulled up into a 'ControlDirFormat' base class
1785
 
        which BzrDirFormat can inherit from, and renamed to register_format 
1786
 
        there. It has been done without that for now for simplicity of
1787
 
        implementation.
1788
 
        """
1789
 
        klass._control_formats.append(format)
1790
 
 
1791
 
    @classmethod
1792
 
    def register_control_server_format(klass, format):
1793
 
        """Register a control format for client-server environments.
1794
 
 
1795
 
        These formats will be tried before ones registered with
1796
 
        register_control_format.  This gives implementations that decide to the
1797
 
        chance to grab it before anything looks at the contents of the format
1798
 
        file.
1799
 
        """
1800
 
        klass._control_server_formats.append(format)
1801
 
 
1802
 
    @classmethod
1803
 
    def _set_default_format(klass, format):
1804
 
        """Set default format (for testing behavior of defaults only)"""
 
924
    def set_default_format(klass, format):
1805
925
        klass._default_format = format
1806
926
 
1807
927
    def __str__(self):
1808
 
        # Trim the newline
1809
 
        return self.get_format_string().rstrip()
 
928
        return self.get_format_string()[:-1]
1810
929
 
1811
930
    @classmethod
1812
931
    def unregister_format(klass, format):
 
932
        assert klass._formats[format.get_format_string()] is format
1813
933
        del klass._formats[format.get_format_string()]
1814
934
 
1815
 
    @classmethod
1816
 
    def unregister_control_format(klass, format):
1817
 
        klass._control_formats.remove(format)
1818
 
 
1819
935
 
1820
936
class BzrDirFormat4(BzrDirFormat):
1821
937
    """Bzr dir format 4.
1830
946
    removed in format 5; write support for this format has been removed.
1831
947
    """
1832
948
 
1833
 
    _lock_class = lockable_files.TransportLock
1834
 
 
1835
949
    def get_format_string(self):
1836
950
        """See BzrDirFormat.get_format_string()."""
1837
951
        return "Bazaar-NG branch, format 0.0.4\n"
1838
952
 
1839
 
    def get_format_description(self):
1840
 
        """See BzrDirFormat.get_format_description()."""
1841
 
        return "All-in-one format 4"
1842
 
 
1843
953
    def get_converter(self, format=None):
1844
954
        """See BzrDirFormat.get_converter()."""
1845
955
        # there is one and only one upgrade path here.
1846
956
        return ConvertBzrDir4To5()
1847
957
        
1848
 
    def initialize_on_transport(self, transport):
 
958
    def initialize(self, url):
1849
959
        """Format 4 branches cannot be created."""
1850
960
        raise errors.UninitializableFormat(self)
1851
961
 
1864
974
 
1865
975
    def __return_repository_format(self):
1866
976
        """Circular import protection."""
1867
 
        from bzrlib.repofmt.weaverepo import RepositoryFormat4
1868
 
        return RepositoryFormat4()
 
977
        from bzrlib.repository import RepositoryFormat4
 
978
        return RepositoryFormat4(self)
1869
979
    repository_format = property(__return_repository_format)
1870
980
 
1871
981
 
1880
990
       Unhashed stores in the repository.
1881
991
    """
1882
992
 
1883
 
    _lock_class = lockable_files.TransportLock
1884
 
 
1885
993
    def get_format_string(self):
1886
994
        """See BzrDirFormat.get_format_string()."""
1887
995
        return "Bazaar-NG branch, format 5\n"
1888
996
 
1889
 
    def get_branch_format(self):
1890
 
        from bzrlib import branch
1891
 
        return branch.BzrBranchFormat4()
1892
 
 
1893
 
    def get_format_description(self):
1894
 
        """See BzrDirFormat.get_format_description()."""
1895
 
        return "All-in-one format 5"
1896
 
 
1897
997
    def get_converter(self, format=None):
1898
998
        """See BzrDirFormat.get_converter()."""
1899
999
        # there is one and only one upgrade path here.
1900
1000
        return ConvertBzrDir5To6()
1901
 
 
1902
 
    def _initialize_for_clone(self, url):
1903
 
        return self.initialize_on_transport(get_transport(url), _cloning=True)
1904
1001
        
1905
 
    def initialize_on_transport(self, transport, _cloning=False):
 
1002
    def initialize(self, url, _cloning=False):
1906
1003
        """Format 5 dirs always have working tree, branch and repository.
1907
1004
        
1908
1005
        Except when they are being cloned.
1909
1006
        """
1910
1007
        from bzrlib.branch import BzrBranchFormat4
1911
 
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
1912
 
        result = (super(BzrDirFormat5, self).initialize_on_transport(transport))
 
1008
        from bzrlib.repository import RepositoryFormat5
 
1009
        from bzrlib.workingtree import WorkingTreeFormat2
 
1010
        result = super(BzrDirFormat5, self).initialize(url)
1913
1011
        RepositoryFormat5().initialize(result, _internal=True)
1914
1012
        if not _cloning:
1915
 
            branch = BzrBranchFormat4().initialize(result)
1916
 
            result._init_workingtree()
 
1013
            BzrBranchFormat4().initialize(result)
 
1014
            WorkingTreeFormat2().initialize(result)
1917
1015
        return result
1918
1016
 
1919
1017
    def _open(self, transport):
1922
1020
 
1923
1021
    def __return_repository_format(self):
1924
1022
        """Circular import protection."""
1925
 
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
1926
 
        return RepositoryFormat5()
 
1023
        from bzrlib.repository import RepositoryFormat5
 
1024
        return RepositoryFormat5(self)
1927
1025
    repository_format = property(__return_repository_format)
1928
1026
 
1929
1027
 
1937
1035
     - Format 6 repositories [always]
1938
1036
    """
1939
1037
 
1940
 
    _lock_class = lockable_files.TransportLock
1941
 
 
1942
1038
    def get_format_string(self):
1943
1039
        """See BzrDirFormat.get_format_string()."""
1944
1040
        return "Bazaar-NG branch, format 6\n"
1945
1041
 
1946
 
    def get_format_description(self):
1947
 
        """See BzrDirFormat.get_format_description()."""
1948
 
        return "All-in-one format 6"
1949
 
 
1950
 
    def get_branch_format(self):
1951
 
        from bzrlib import branch
1952
 
        return branch.BzrBranchFormat4()
1953
 
 
1954
1042
    def get_converter(self, format=None):
1955
1043
        """See BzrDirFormat.get_converter()."""
1956
1044
        # there is one and only one upgrade path here.
1957
1045
        return ConvertBzrDir6ToMeta()
1958
1046
        
1959
 
    def _initialize_for_clone(self, url):
1960
 
        return self.initialize_on_transport(get_transport(url), _cloning=True)
1961
 
 
1962
 
    def initialize_on_transport(self, transport, _cloning=False):
 
1047
    def initialize(self, url, _cloning=False):
1963
1048
        """Format 6 dirs always have working tree, branch and repository.
1964
1049
        
1965
1050
        Except when they are being cloned.
1966
1051
        """
1967
1052
        from bzrlib.branch import BzrBranchFormat4
1968
 
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
1969
 
        result = super(BzrDirFormat6, self).initialize_on_transport(transport)
 
1053
        from bzrlib.repository import RepositoryFormat6
 
1054
        from bzrlib.workingtree import WorkingTreeFormat2
 
1055
        result = super(BzrDirFormat6, self).initialize(url)
1970
1056
        RepositoryFormat6().initialize(result, _internal=True)
1971
1057
        if not _cloning:
1972
 
            branch = BzrBranchFormat4().initialize(result)
1973
 
            result._init_workingtree()
 
1058
            BzrBranchFormat4().initialize(result)
 
1059
            try:
 
1060
                WorkingTreeFormat2().initialize(result)
 
1061
            except errors.NotLocalUrl:
 
1062
                # emulate pre-check behaviour for working tree and silently 
 
1063
                # fail.
 
1064
                pass
1974
1065
        return result
1975
1066
 
1976
1067
    def _open(self, transport):
1979
1070
 
1980
1071
    def __return_repository_format(self):
1981
1072
        """Circular import protection."""
1982
 
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
1983
 
        return RepositoryFormat6()
 
1073
        from bzrlib.repository import RepositoryFormat6
 
1074
        return RepositoryFormat6(self)
1984
1075
    repository_format = property(__return_repository_format)
1985
1076
 
1986
1077
 
1995
1086
     - Format 7 repositories [optional]
1996
1087
    """
1997
1088
 
1998
 
    _lock_class = lockdir.LockDir
1999
 
 
2000
 
    def __init__(self):
2001
 
        self._workingtree_format = None
2002
 
        self._branch_format = None
2003
 
 
2004
 
    def __eq__(self, other):
2005
 
        if other.__class__ is not self.__class__:
2006
 
            return False
2007
 
        if other.repository_format != self.repository_format:
2008
 
            return False
2009
 
        if other.workingtree_format != self.workingtree_format:
2010
 
            return False
2011
 
        return True
2012
 
 
2013
 
    def __ne__(self, other):
2014
 
        return not self == other
2015
 
 
2016
 
    def get_branch_format(self):
2017
 
        if self._branch_format is None:
2018
 
            from bzrlib.branch import BranchFormat
2019
 
            self._branch_format = BranchFormat.get_default_format()
2020
 
        return self._branch_format
2021
 
 
2022
 
    def set_branch_format(self, format):
2023
 
        self._branch_format = format
2024
 
 
2025
1089
    def get_converter(self, format=None):
2026
1090
        """See BzrDirFormat.get_converter()."""
2027
1091
        if format is None:
2035
1099
        """See BzrDirFormat.get_format_string()."""
2036
1100
        return "Bazaar-NG meta directory, format 1\n"
2037
1101
 
2038
 
    def get_format_description(self):
2039
 
        """See BzrDirFormat.get_format_description()."""
2040
 
        return "Meta directory format 1"
2041
 
 
2042
1102
    def _open(self, transport):
2043
1103
        """See BzrDirFormat._open."""
2044
1104
        return BzrDirMeta1(transport, self)
2051
1111
        return RepositoryFormat.get_default_format()
2052
1112
 
2053
1113
    def __set_repository_format(self, value):
2054
 
        """Allow changing the repository format for metadir formats."""
 
1114
        """Allow changint the repository format for metadir formats."""
2055
1115
        self._repository_format = value
2056
 
 
2057
1116
    repository_format = property(__return_repository_format, __set_repository_format)
2058
1117
 
2059
 
    def __get_workingtree_format(self):
2060
 
        if self._workingtree_format is None:
2061
 
            from bzrlib.workingtree import WorkingTreeFormat
2062
 
            self._workingtree_format = WorkingTreeFormat.get_default_format()
2063
 
        return self._workingtree_format
2064
 
 
2065
 
    def __set_workingtree_format(self, wt_format):
2066
 
        self._workingtree_format = wt_format
2067
 
 
2068
 
    workingtree_format = property(__get_workingtree_format,
2069
 
                                  __set_workingtree_format)
2070
 
 
2071
 
 
2072
 
# Register bzr control format
2073
 
BzrDirFormat.register_control_format(BzrDirFormat)
2074
 
 
2075
 
# Register bzr formats
 
1118
 
2076
1119
BzrDirFormat.register_format(BzrDirFormat4())
2077
1120
BzrDirFormat.register_format(BzrDirFormat5())
2078
 
BzrDirFormat.register_format(BzrDirFormat6())
2079
 
__default_format = BzrDirMetaFormat1()
 
1121
BzrDirFormat.register_format(BzrDirMetaFormat1())
 
1122
__default_format = BzrDirFormat6()
2080
1123
BzrDirFormat.register_format(__default_format)
2081
 
BzrDirFormat._default_format = __default_format
 
1124
BzrDirFormat.set_default_format(__default_format)
 
1125
 
 
1126
 
 
1127
class BzrDirTestProviderAdapter(object):
 
1128
    """A tool to generate a suite testing multiple bzrdir formats at once.
 
1129
 
 
1130
    This is done by copying the test once for each transport and injecting
 
1131
    the transport_server, transport_readonly_server, and bzrdir_format
 
1132
    classes into each copy. Each copy is also given a new id() to make it
 
1133
    easy to identify.
 
1134
    """
 
1135
 
 
1136
    def __init__(self, transport_server, transport_readonly_server, formats):
 
1137
        self._transport_server = transport_server
 
1138
        self._transport_readonly_server = transport_readonly_server
 
1139
        self._formats = formats
 
1140
    
 
1141
    def adapt(self, test):
 
1142
        result = TestSuite()
 
1143
        for format in self._formats:
 
1144
            new_test = deepcopy(test)
 
1145
            new_test.transport_server = self._transport_server
 
1146
            new_test.transport_readonly_server = self._transport_readonly_server
 
1147
            new_test.bzrdir_format = format
 
1148
            def make_new_test_id():
 
1149
                new_id = "%s(%s)" % (new_test.id(), format.__class__.__name__)
 
1150
                return lambda: new_id
 
1151
            new_test.id = make_new_test_id()
 
1152
            result.addTest(new_test)
 
1153
        return result
 
1154
 
 
1155
 
 
1156
class ScratchDir(BzrDir6):
 
1157
    """Special test class: a bzrdir that cleans up itself..
 
1158
 
 
1159
    >>> d = ScratchDir()
 
1160
    >>> base = d.transport.base
 
1161
    >>> isdir(base)
 
1162
    True
 
1163
    >>> b.transport.__del__()
 
1164
    >>> isdir(base)
 
1165
    False
 
1166
    """
 
1167
 
 
1168
    def __init__(self, files=[], dirs=[], transport=None):
 
1169
        """Make a test branch.
 
1170
 
 
1171
        This creates a temporary directory and runs init-tree in it.
 
1172
 
 
1173
        If any files are listed, they are created in the working copy.
 
1174
        """
 
1175
        if transport is None:
 
1176
            transport = bzrlib.transport.local.ScratchTransport()
 
1177
            # local import for scope restriction
 
1178
            BzrDirFormat6().initialize(transport.base)
 
1179
            super(ScratchDir, self).__init__(transport, BzrDirFormat6())
 
1180
            self.create_repository()
 
1181
            self.create_branch()
 
1182
            self.create_workingtree()
 
1183
        else:
 
1184
            super(ScratchDir, self).__init__(transport, BzrDirFormat6())
 
1185
 
 
1186
        # BzrBranch creates a clone to .bzr and then forgets about the
 
1187
        # original transport. A ScratchTransport() deletes itself and
 
1188
        # everything underneath it when it goes away, so we need to
 
1189
        # grab a local copy to prevent that from happening
 
1190
        self._transport = transport
 
1191
 
 
1192
        for d in dirs:
 
1193
            self._transport.mkdir(d)
 
1194
            
 
1195
        for f in files:
 
1196
            self._transport.put(f, 'content of %s' % f)
 
1197
 
 
1198
    def clone(self):
 
1199
        """
 
1200
        >>> orig = ScratchDir(files=["file1", "file2"])
 
1201
        >>> os.listdir(orig.base)
 
1202
        [u'.bzr', u'file1', u'file2']
 
1203
        >>> clone = orig.clone()
 
1204
        >>> if os.name != 'nt':
 
1205
        ...   os.path.samefile(orig.base, clone.base)
 
1206
        ... else:
 
1207
        ...   orig.base == clone.base
 
1208
        ...
 
1209
        False
 
1210
        >>> os.listdir(clone.base)
 
1211
        [u'.bzr', u'file1', u'file2']
 
1212
        """
 
1213
        from shutil import copytree
 
1214
        from bzrlib.osutils import mkdtemp
 
1215
        base = mkdtemp()
 
1216
        os.rmdir(base)
 
1217
        copytree(self.base, base, symlinks=True)
 
1218
        return ScratchDir(
 
1219
            transport=bzrlib.transport.local.ScratchTransport(base))
2082
1220
 
2083
1221
 
2084
1222
class Converter(object):
2157
1295
        self.pb.note('  %6d revisions not present', len(self.absent_revisions))
2158
1296
        self.pb.note('  %6d texts', self.text_count)
2159
1297
        self._cleanup_spare_files_after_format4()
2160
 
        self.branch._transport.put_bytes(
2161
 
            'branch-format',
2162
 
            BzrDirFormat5().get_format_string(),
2163
 
            mode=self.bzrdir._get_file_mode())
 
1298
        self.branch.control_files.put_utf8('branch-format', BzrDirFormat5().get_format_string())
2164
1299
 
2165
1300
    def _cleanup_spare_files_after_format4(self):
2166
1301
        # FIXME working tree upgrade foo.
2174
1309
        self.bzrdir.transport.delete_tree('text-store')
2175
1310
 
2176
1311
    def _convert_working_inv(self):
2177
 
        inv = xml4.serializer_v4.read_inventory(
2178
 
                self.branch._transport.get('inventory'))
2179
 
        new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv, working=True)
2180
 
        self.branch._transport.put_bytes('inventory', new_inv_xml,
2181
 
            mode=self.bzrdir._get_file_mode())
 
1312
        inv = serializer_v4.read_inventory(self.branch.control_files.get('inventory'))
 
1313
        new_inv_xml = serializer_v5.write_inventory_to_string(inv)
 
1314
        # FIXME inventory is a working tree change.
 
1315
        self.branch.control_files.put('inventory', new_inv_xml)
2182
1316
 
2183
1317
    def _write_all_weaves(self):
2184
1318
        controlweaves = WeaveStore(self.bzrdir.transport, prefixed=False)
2185
1319
        weave_transport = self.bzrdir.transport.clone('weaves')
2186
1320
        weaves = WeaveStore(weave_transport, prefixed=False)
2187
 
        transaction = WriteTransaction()
 
1321
        transaction = PassThroughTransaction()
2188
1322
 
2189
1323
        try:
2190
1324
            i = 0
2204
1338
        self.bzrdir.transport.mkdir('revision-store')
2205
1339
        revision_transport = self.bzrdir.transport.clone('revision-store')
2206
1340
        # TODO permissions
2207
 
        from bzrlib.xml5 import serializer_v5
2208
 
        from bzrlib.repofmt.weaverepo import RevisionTextStore
2209
 
        revision_store = RevisionTextStore(revision_transport,
2210
 
            serializer_v5, False, versionedfile.PrefixMapper(),
2211
 
            lambda:True, lambda:True)
 
1341
        revision_store = TextStore(revision_transport,
 
1342
                                   prefixed=False,
 
1343
                                   compressed=True)
2212
1344
        try:
2213
1345
            for i, rev_id in enumerate(self.converted_revs):
2214
1346
                self.pb.update('write revision', i, len(self.converted_revs))
2215
 
                text = serializer_v5.write_revision_to_string(
2216
 
                    self.revisions[rev_id])
2217
 
                key = (rev_id,)
2218
 
                revision_store.add_lines(key, None, osutils.split_lines(text))
 
1347
                rev_tmp = StringIO()
 
1348
                serializer_v5.write_revision(self.revisions[rev_id], rev_tmp)
 
1349
                rev_tmp.seek(0)
 
1350
                revision_store.add(rev_tmp, rev_id)
2219
1351
        finally:
2220
1352
            self.pb.clear()
2221
1353
            
2234
1366
                         rev_id)
2235
1367
            self.absent_revisions.add(rev_id)
2236
1368
        else:
2237
 
            rev = self.branch.repository.get_revision(rev_id)
 
1369
            rev_xml = self.branch.repository.revision_store.get(rev_id).read()
 
1370
            rev = serializer_v4.read_revision_from_string(rev_xml)
2238
1371
            for parent_id in rev.parent_ids:
2239
1372
                self.known_revisions.add(parent_id)
2240
1373
                self.to_read.append(parent_id)
2241
1374
            self.revisions[rev_id] = rev
2242
1375
 
2243
1376
    def _load_old_inventory(self, rev_id):
 
1377
        assert rev_id not in self.converted_revs
2244
1378
        old_inv_xml = self.branch.repository.inventory_store.get(rev_id).read()
2245
 
        inv = xml4.serializer_v4.read_inventory_from_string(old_inv_xml)
2246
 
        inv.revision_id = rev_id
 
1379
        inv = serializer_v4.read_inventory_from_string(old_inv_xml)
2247
1380
        rev = self.revisions[rev_id]
 
1381
        if rev.inventory_sha1:
 
1382
            assert rev.inventory_sha1 == sha_string(old_inv_xml), \
 
1383
                'inventory sha mismatch for {%s}' % rev_id
2248
1384
        return inv
2249
1385
 
2250
1386
    def _load_updated_inventory(self, rev_id):
 
1387
        assert rev_id in self.converted_revs
2251
1388
        inv_xml = self.inv_weave.get_text(rev_id)
2252
 
        inv = xml5.serializer_v5.read_inventory_from_string(inv_xml, rev_id)
 
1389
        inv = serializer_v5.read_inventory_from_string(inv_xml)
2253
1390
        return inv
2254
1391
 
2255
1392
    def _convert_one_rev(self, rev_id):
2259
1396
        present_parents = [p for p in rev.parent_ids
2260
1397
                           if p not in self.absent_revisions]
2261
1398
        self._convert_revision_contents(rev, inv, present_parents)
2262
 
        self._store_new_inv(rev, inv, present_parents)
 
1399
        self._store_new_weave(rev, inv, present_parents)
2263
1400
        self.converted_revs.add(rev_id)
2264
1401
 
2265
 
    def _store_new_inv(self, rev, inv, present_parents):
2266
 
        new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
 
1402
    def _store_new_weave(self, rev, inv, present_parents):
 
1403
        # the XML is now updated with text versions
 
1404
        if __debug__:
 
1405
            for file_id in inv:
 
1406
                ie = inv[file_id]
 
1407
                if ie.kind == 'root_directory':
 
1408
                    continue
 
1409
                assert hasattr(ie, 'revision'), \
 
1410
                    'no revision on {%s} in {%s}' % \
 
1411
                    (file_id, rev.revision_id)
 
1412
        new_inv_xml = serializer_v5.write_inventory_to_string(inv)
2267
1413
        new_inv_sha1 = sha_string(new_inv_xml)
2268
 
        self.inv_weave.add_lines(rev.revision_id,
2269
 
                                 present_parents,
2270
 
                                 new_inv_xml.splitlines(True))
 
1414
        self.inv_weave.add(rev.revision_id, 
 
1415
                           present_parents,
 
1416
                           new_inv_xml.splitlines(True),
 
1417
                           new_inv_sha1)
2271
1418
        rev.inventory_sha1 = new_inv_sha1
2272
1419
 
2273
1420
    def _convert_revision_contents(self, rev, inv, present_parents):
2278
1425
        mutter('converting texts of revision {%s}',
2279
1426
               rev_id)
2280
1427
        parent_invs = map(self._load_updated_inventory, present_parents)
2281
 
        entries = inv.iter_entries()
2282
 
        entries.next()
2283
 
        for path, ie in entries:
 
1428
        for file_id in inv:
 
1429
            ie = inv[file_id]
2284
1430
            self._convert_file_version(rev, ie, parent_invs)
2285
1431
 
2286
1432
    def _convert_file_version(self, rev, ie, parent_invs):
2289
1435
        The file needs to be added into the weave if it is a merge
2290
1436
        of >=2 parents or if it's changed from its parent.
2291
1437
        """
 
1438
        if ie.kind == 'root_directory':
 
1439
            return
2292
1440
        file_id = ie.file_id
2293
1441
        rev_id = rev.revision_id
2294
1442
        w = self.text_weaves.get(file_id)
2296
1444
            w = Weave(file_id)
2297
1445
            self.text_weaves[file_id] = w
2298
1446
        text_changed = False
2299
 
        parent_candiate_entries = ie.parent_candidates(parent_invs)
2300
 
        heads = graph.Graph(self).heads(parent_candiate_entries.keys())
2301
 
        # XXX: Note that this is unordered - and this is tolerable because 
2302
 
        # the previous code was also unordered.
2303
 
        previous_entries = dict((head, parent_candiate_entries[head]) for head
2304
 
            in heads)
 
1447
        previous_entries = ie.find_previous_heads(parent_invs, w)
 
1448
        for old_revision in previous_entries:
 
1449
                # if this fails, its a ghost ?
 
1450
                assert old_revision in self.converted_revs 
2305
1451
        self.snapshot_ie(previous_entries, ie, w, rev_id)
2306
1452
        del ie.text_id
2307
 
 
2308
 
    @symbol_versioning.deprecated_method(symbol_versioning.one_one)
2309
 
    def get_parents(self, revision_ids):
2310
 
        for revision_id in revision_ids:
2311
 
            yield self.revisions[revision_id].parent_ids
2312
 
 
2313
 
    def get_parent_map(self, revision_ids):
2314
 
        """See graph._StackedParentsProvider.get_parent_map"""
2315
 
        return dict((revision_id, self.revisions[revision_id])
2316
 
                    for revision_id in revision_ids
2317
 
                     if revision_id in self.revisions)
 
1453
        assert getattr(ie, 'revision', None) is not None
2318
1454
 
2319
1455
    def snapshot_ie(self, previous_revisions, ie, w, rev_id):
2320
1456
        # TODO: convert this logic, which is ~= snapshot to
2330
1466
                ie.revision = previous_ie.revision
2331
1467
                return
2332
1468
        if ie.has_text():
2333
 
            text = self.branch.repository._text_store.get(ie.text_id)
 
1469
            text = self.branch.repository.text_store.get(ie.text_id)
2334
1470
            file_lines = text.readlines()
 
1471
            assert sha_strings(file_lines) == ie.text_sha1
 
1472
            assert sum(map(len, file_lines)) == ie.text_size
2335
1473
            w.add_lines(rev_id, previous_revisions, file_lines)
2336
1474
            self.text_count += 1
2337
1475
        else:
2373
1511
        return BzrDir.open(self.bzrdir.root_transport.base)
2374
1512
 
2375
1513
    def _convert_to_prefixed(self):
2376
 
        from bzrlib.store import TransportStore
 
1514
        from bzrlib.store import hash_prefix
2377
1515
        self.bzrdir.transport.delete('branch-format')
2378
1516
        for store_name in ["weaves", "revision-store"]:
2379
 
            self.pb.note("adding prefixes to %s" % store_name)
 
1517
            self.pb.note("adding prefixes to %s" % store_name) 
2380
1518
            store_transport = self.bzrdir.transport.clone(store_name)
2381
 
            store = TransportStore(store_transport, prefixed=True)
2382
 
            for urlfilename in store_transport.list_dir('.'):
2383
 
                filename = urlutils.unescape(urlfilename)
 
1519
            for filename in store_transport.list_dir('.'):
2384
1520
                if (filename.endswith(".weave") or
2385
1521
                    filename.endswith(".gz") or
2386
1522
                    filename.endswith(".sig")):
2387
 
                    file_id, suffix = os.path.splitext(filename)
 
1523
                    file_id = os.path.splitext(filename)[0]
2388
1524
                else:
2389
1525
                    file_id = filename
2390
 
                    suffix = ''
2391
 
                new_name = store._mapper.map((file_id,)) + suffix
 
1526
                prefix_dir = hash_prefix(file_id)
2392
1527
                # FIXME keep track of the dirs made RBC 20060121
2393
1528
                try:
2394
 
                    store_transport.move(filename, new_name)
 
1529
                    store_transport.move(filename, prefix_dir + '/' + filename)
2395
1530
                except errors.NoSuchFile: # catches missing dirs strangely enough
2396
 
                    store_transport.mkdir(osutils.dirname(new_name))
2397
 
                    store_transport.move(filename, new_name)
2398
 
        self.bzrdir.transport.put_bytes(
2399
 
            'branch-format',
2400
 
            BzrDirFormat6().get_format_string(),
2401
 
            mode=self.bzrdir._get_file_mode())
 
1531
                    store_transport.mkdir(prefix_dir)
 
1532
                    store_transport.move(filename, prefix_dir + '/' + filename)
 
1533
        self.bzrdir._control_files.put_utf8('branch-format', BzrDirFormat6().get_format_string())
2402
1534
 
2403
1535
 
2404
1536
class ConvertBzrDir6ToMeta(Converter):
2406
1538
 
2407
1539
    def convert(self, to_convert, pb):
2408
1540
        """See Converter.convert()."""
2409
 
        from bzrlib.repofmt.weaverepo import RepositoryFormat7
2410
 
        from bzrlib.branch import BzrBranchFormat5
2411
1541
        self.bzrdir = to_convert
2412
1542
        self.pb = pb
2413
1543
        self.count = 0
2414
1544
        self.total = 20 # the steps we know about
2415
1545
        self.garbage_inventories = []
2416
 
        self.dir_mode = self.bzrdir._get_dir_mode()
2417
 
        self.file_mode = self.bzrdir._get_file_mode()
2418
1546
 
2419
1547
        self.pb.note('starting upgrade from format 6 to metadir')
2420
 
        self.bzrdir.transport.put_bytes(
2421
 
                'branch-format',
2422
 
                "Converting to format 6",
2423
 
                mode=self.file_mode)
 
1548
        self.bzrdir._control_files.put_utf8('branch-format', "Converting to format 6")
2424
1549
        # its faster to move specific files around than to open and use the apis...
2425
1550
        # first off, nuke ancestry.weave, it was never used.
2426
1551
        try:
2430
1555
            pass
2431
1556
        # find out whats there
2432
1557
        self.step('Finding branch files')
2433
 
        last_revision = self.bzrdir.open_branch().last_revision()
 
1558
        last_revision = self.bzrdir.open_workingtree().last_revision()
2434
1559
        bzrcontents = self.bzrdir.transport.list_dir('.')
2435
1560
        for name in bzrcontents:
2436
1561
            if name.startswith('basis-inventory.'):
2437
1562
                self.garbage_inventories.append(name)
2438
1563
        # create new directories for repository, working tree and branch
 
1564
        dir_mode = self.bzrdir._control_files._dir_mode
 
1565
        self.file_mode = self.bzrdir._control_files._file_mode
2439
1566
        repository_names = [('inventory.weave', True),
2440
1567
                            ('revision-store', True),
2441
1568
                            ('weaves', True)]
2442
1569
        self.step('Upgrading repository  ')
2443
 
        self.bzrdir.transport.mkdir('repository', mode=self.dir_mode)
 
1570
        self.bzrdir.transport.mkdir('repository', mode=dir_mode)
2444
1571
        self.make_lock('repository')
2445
1572
        # we hard code the formats here because we are converting into
2446
1573
        # the meta format. The meta format upgrader can take this to a 
2447
1574
        # future format within each component.
2448
 
        self.put_format('repository', RepositoryFormat7())
 
1575
        self.put_format('repository', bzrlib.repository.RepositoryFormat7())
2449
1576
        for entry in repository_names:
2450
1577
            self.move_entry('repository', entry)
2451
1578
 
2452
1579
        self.step('Upgrading branch      ')
2453
 
        self.bzrdir.transport.mkdir('branch', mode=self.dir_mode)
 
1580
        self.bzrdir.transport.mkdir('branch', mode=dir_mode)
2454
1581
        self.make_lock('branch')
2455
 
        self.put_format('branch', BzrBranchFormat5())
 
1582
        self.put_format('branch', bzrlib.branch.BzrBranchFormat5())
2456
1583
        branch_files = [('revision-history', True),
2457
1584
                        ('branch-name', True),
2458
1585
                        ('parent', False)]
2459
1586
        for entry in branch_files:
2460
1587
            self.move_entry('branch', entry)
2461
1588
 
 
1589
        self.step('Upgrading working tree')
 
1590
        self.bzrdir.transport.mkdir('checkout', mode=dir_mode)
 
1591
        self.make_lock('checkout')
 
1592
        self.put_format('checkout', bzrlib.workingtree.WorkingTreeFormat3())
 
1593
        self.bzrdir.transport.delete_multi(self.garbage_inventories, self.pb)
2462
1594
        checkout_files = [('pending-merges', True),
2463
1595
                          ('inventory', True),
2464
1596
                          ('stat-cache', False)]
2465
 
        # If a mandatory checkout file is not present, the branch does not have
2466
 
        # a functional checkout. Do not create a checkout in the converted
2467
 
        # branch.
2468
 
        for name, mandatory in checkout_files:
2469
 
            if mandatory and name not in bzrcontents:
2470
 
                has_checkout = False
2471
 
                break
2472
 
        else:
2473
 
            has_checkout = True
2474
 
        if not has_checkout:
2475
 
            self.pb.note('No working tree.')
2476
 
            # If some checkout files are there, we may as well get rid of them.
2477
 
            for name, mandatory in checkout_files:
2478
 
                if name in bzrcontents:
2479
 
                    self.bzrdir.transport.delete(name)
2480
 
        else:
2481
 
            from bzrlib.workingtree import WorkingTreeFormat3
2482
 
            self.step('Upgrading working tree')
2483
 
            self.bzrdir.transport.mkdir('checkout', mode=self.dir_mode)
2484
 
            self.make_lock('checkout')
2485
 
            self.put_format(
2486
 
                'checkout', WorkingTreeFormat3())
2487
 
            self.bzrdir.transport.delete_multi(
2488
 
                self.garbage_inventories, self.pb)
2489
 
            for entry in checkout_files:
2490
 
                self.move_entry('checkout', entry)
2491
 
            if last_revision is not None:
2492
 
                self.bzrdir.transport.put_bytes(
2493
 
                    'checkout/last-revision', last_revision)
2494
 
        self.bzrdir.transport.put_bytes(
2495
 
            'branch-format',
2496
 
            BzrDirMetaFormat1().get_format_string(),
2497
 
            mode=self.file_mode)
 
1597
        for entry in checkout_files:
 
1598
            self.move_entry('checkout', entry)
 
1599
        if last_revision is not None:
 
1600
            self.bzrdir._control_files.put_utf8('checkout/last-revision',
 
1601
                                                last_revision)
 
1602
        self.bzrdir._control_files.put_utf8('branch-format', BzrDirMetaFormat1().get_format_string())
2498
1603
        return BzrDir.open(self.bzrdir.root_transport.base)
2499
1604
 
2500
1605
    def make_lock(self, name):
2501
1606
        """Make a lock for the new control dir name."""
2502
1607
        self.step('Make %s lock' % name)
2503
 
        ld = lockdir.LockDir(self.bzrdir.transport,
2504
 
                             '%s/lock' % name,
2505
 
                             file_modebits=self.file_mode,
2506
 
                             dir_modebits=self.dir_mode)
2507
 
        ld.create()
 
1608
        self.bzrdir.transport.put('%s/lock' % name, StringIO(), mode=self.file_mode)
2508
1609
 
2509
1610
    def move_entry(self, new_dir, entry):
2510
1611
        """Move then entry name into new_dir."""
2518
1619
                raise
2519
1620
 
2520
1621
    def put_format(self, dirname, format):
2521
 
        self.bzrdir.transport.put_bytes('%s/format' % dirname,
2522
 
            format.get_format_string(),
2523
 
            self.file_mode)
 
1622
        self.bzrdir._control_files.put_utf8('%s/format' % dirname, format.get_format_string())
2524
1623
 
2525
1624
 
2526
1625
class ConvertMetaToMeta(Converter):
2550
1649
                self.pb.note('starting repository conversion')
2551
1650
                converter = CopyConverter(self.target_format.repository_format)
2552
1651
                converter.convert(repo, pb)
2553
 
        try:
2554
 
            branch = self.bzrdir.open_branch()
2555
 
        except errors.NotBranchError:
2556
 
            pass
2557
 
        else:
2558
 
            # TODO: conversions of Branch and Tree should be done by
2559
 
            # InterXFormat lookups/some sort of registry.
2560
 
            # Avoid circular imports
2561
 
            from bzrlib import branch as _mod_branch
2562
 
            old = branch._format.__class__
2563
 
            new = self.target_format.get_branch_format().__class__
2564
 
            while old != new:
2565
 
                if (old == _mod_branch.BzrBranchFormat5 and
2566
 
                    new in (_mod_branch.BzrBranchFormat6,
2567
 
                        _mod_branch.BzrBranchFormat7)):
2568
 
                    branch_converter = _mod_branch.Converter5to6()
2569
 
                elif (old == _mod_branch.BzrBranchFormat6 and
2570
 
                    new == _mod_branch.BzrBranchFormat7):
2571
 
                    branch_converter = _mod_branch.Converter6to7()
2572
 
                else:
2573
 
                    raise errors.BadConversionTarget("No converter", new)
2574
 
                branch_converter.convert(branch)
2575
 
                branch = self.bzrdir.open_branch()
2576
 
                old = branch._format.__class__
2577
 
        try:
2578
 
            tree = self.bzrdir.open_workingtree(recommend_upgrade=False)
2579
 
        except (errors.NoWorkingTree, errors.NotLocalUrl):
2580
 
            pass
2581
 
        else:
2582
 
            # TODO: conversions of Branch and Tree should be done by
2583
 
            # InterXFormat lookups
2584
 
            if (isinstance(tree, workingtree.WorkingTree3) and
2585
 
                not isinstance(tree, workingtree_4.WorkingTree4) and
2586
 
                isinstance(self.target_format.workingtree_format,
2587
 
                    workingtree_4.WorkingTreeFormat4)):
2588
 
                workingtree_4.Converter3to4().convert(tree)
2589
1652
        return to_convert
2590
 
 
2591
 
 
2592
 
# This is not in remote.py because it's small, and needs to be registered.
2593
 
# Putting it in remote.py creates a circular import problem.
2594
 
# we can make it a lazy object if the control formats is turned into something
2595
 
# like a registry.
2596
 
class RemoteBzrDirFormat(BzrDirMetaFormat1):
2597
 
    """Format representing bzrdirs accessed via a smart server"""
2598
 
 
2599
 
    def get_format_description(self):
2600
 
        return 'bzr remote bzrdir'
2601
 
    
2602
 
    @classmethod
2603
 
    def probe_transport(klass, transport):
2604
 
        """Return a RemoteBzrDirFormat object if it looks possible."""
2605
 
        try:
2606
 
            medium = transport.get_smart_medium()
2607
 
        except (NotImplementedError, AttributeError,
2608
 
                errors.TransportNotPossible, errors.NoSmartMedium,
2609
 
                errors.SmartProtocolError):
2610
 
            # no smart server, so not a branch for this format type.
2611
 
            raise errors.NotBranchError(path=transport.base)
2612
 
        else:
2613
 
            # Decline to open it if the server doesn't support our required
2614
 
            # version (3) so that the VFS-based transport will do it.
2615
 
            if medium.should_probe():
2616
 
                try:
2617
 
                    server_version = medium.protocol_version()
2618
 
                except errors.SmartProtocolError:
2619
 
                    # Apparently there's no usable smart server there, even though
2620
 
                    # the medium supports the smart protocol.
2621
 
                    raise errors.NotBranchError(path=transport.base)
2622
 
                if server_version != '2':
2623
 
                    raise errors.NotBranchError(path=transport.base)
2624
 
            return klass()
2625
 
 
2626
 
    def initialize_on_transport(self, transport):
2627
 
        try:
2628
 
            # hand off the request to the smart server
2629
 
            client_medium = transport.get_smart_medium()
2630
 
        except errors.NoSmartMedium:
2631
 
            # TODO: lookup the local format from a server hint.
2632
 
            local_dir_format = BzrDirMetaFormat1()
2633
 
            return local_dir_format.initialize_on_transport(transport)
2634
 
        client = _SmartClient(client_medium)
2635
 
        path = client.remote_path_from_transport(transport)
2636
 
        response = client.call('BzrDirFormat.initialize', path)
2637
 
        if response[0] != 'ok':
2638
 
            raise errors.SmartProtocolError('unexpected response code %s' % (response,))
2639
 
        return remote.RemoteBzrDir(transport)
2640
 
 
2641
 
    def _open(self, transport):
2642
 
        return remote.RemoteBzrDir(transport)
2643
 
 
2644
 
    def __eq__(self, other):
2645
 
        if not isinstance(other, RemoteBzrDirFormat):
2646
 
            return False
2647
 
        return self.get_format_description() == other.get_format_description()
2648
 
 
2649
 
 
2650
 
BzrDirFormat.register_control_server_format(RemoteBzrDirFormat)
2651
 
 
2652
 
 
2653
 
class BzrDirFormatInfo(object):
2654
 
 
2655
 
    def __init__(self, native, deprecated, hidden, experimental):
2656
 
        self.deprecated = deprecated
2657
 
        self.native = native
2658
 
        self.hidden = hidden
2659
 
        self.experimental = experimental
2660
 
 
2661
 
 
2662
 
class BzrDirFormatRegistry(registry.Registry):
2663
 
    """Registry of user-selectable BzrDir subformats.
2664
 
    
2665
 
    Differs from BzrDirFormat._control_formats in that it provides sub-formats,
2666
 
    e.g. BzrDirMeta1 with weave repository.  Also, it's more user-oriented.
2667
 
    """
2668
 
 
2669
 
    def __init__(self):
2670
 
        """Create a BzrDirFormatRegistry."""
2671
 
        self._aliases = set()
2672
 
        super(BzrDirFormatRegistry, self).__init__()
2673
 
 
2674
 
    def aliases(self):
2675
 
        """Return a set of the format names which are aliases."""
2676
 
        return frozenset(self._aliases)
2677
 
 
2678
 
    def register_metadir(self, key,
2679
 
             repository_format, help, native=True, deprecated=False,
2680
 
             branch_format=None,
2681
 
             tree_format=None,
2682
 
             hidden=False,
2683
 
             experimental=False,
2684
 
             alias=False):
2685
 
        """Register a metadir subformat.
2686
 
 
2687
 
        These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
2688
 
        by the Repository format.
2689
 
 
2690
 
        :param repository_format: The fully-qualified repository format class
2691
 
            name as a string.
2692
 
        :param branch_format: Fully-qualified branch format class name as
2693
 
            a string.
2694
 
        :param tree_format: Fully-qualified tree format class name as
2695
 
            a string.
2696
 
        """
2697
 
        # This should be expanded to support setting WorkingTree and Branch
2698
 
        # formats, once BzrDirMetaFormat1 supports that.
2699
 
        def _load(full_name):
2700
 
            mod_name, factory_name = full_name.rsplit('.', 1)
2701
 
            try:
2702
 
                mod = __import__(mod_name, globals(), locals(),
2703
 
                        [factory_name])
2704
 
            except ImportError, e:
2705
 
                raise ImportError('failed to load %s: %s' % (full_name, e))
2706
 
            try:
2707
 
                factory = getattr(mod, factory_name)
2708
 
            except AttributeError:
2709
 
                raise AttributeError('no factory %s in module %r'
2710
 
                    % (full_name, mod))
2711
 
            return factory()
2712
 
 
2713
 
        def helper():
2714
 
            bd = BzrDirMetaFormat1()
2715
 
            if branch_format is not None:
2716
 
                bd.set_branch_format(_load(branch_format))
2717
 
            if tree_format is not None:
2718
 
                bd.workingtree_format = _load(tree_format)
2719
 
            if repository_format is not None:
2720
 
                bd.repository_format = _load(repository_format)
2721
 
            return bd
2722
 
        self.register(key, helper, help, native, deprecated, hidden,
2723
 
            experimental, alias)
2724
 
 
2725
 
    def register(self, key, factory, help, native=True, deprecated=False,
2726
 
                 hidden=False, experimental=False, alias=False):
2727
 
        """Register a BzrDirFormat factory.
2728
 
        
2729
 
        The factory must be a callable that takes one parameter: the key.
2730
 
        It must produce an instance of the BzrDirFormat when called.
2731
 
 
2732
 
        This function mainly exists to prevent the info object from being
2733
 
        supplied directly.
2734
 
        """
2735
 
        registry.Registry.register(self, key, factory, help,
2736
 
            BzrDirFormatInfo(native, deprecated, hidden, experimental))
2737
 
        if alias:
2738
 
            self._aliases.add(key)
2739
 
 
2740
 
    def register_lazy(self, key, module_name, member_name, help, native=True,
2741
 
        deprecated=False, hidden=False, experimental=False, alias=False):
2742
 
        registry.Registry.register_lazy(self, key, module_name, member_name,
2743
 
            help, BzrDirFormatInfo(native, deprecated, hidden, experimental))
2744
 
        if alias:
2745
 
            self._aliases.add(key)
2746
 
 
2747
 
    def set_default(self, key):
2748
 
        """Set the 'default' key to be a clone of the supplied key.
2749
 
        
2750
 
        This method must be called once and only once.
2751
 
        """
2752
 
        registry.Registry.register(self, 'default', self.get(key),
2753
 
            self.get_help(key), info=self.get_info(key))
2754
 
        self._aliases.add('default')
2755
 
 
2756
 
    def set_default_repository(self, key):
2757
 
        """Set the FormatRegistry default and Repository default.
2758
 
        
2759
 
        This is a transitional method while Repository.set_default_format
2760
 
        is deprecated.
2761
 
        """
2762
 
        if 'default' in self:
2763
 
            self.remove('default')
2764
 
        self.set_default(key)
2765
 
        format = self.get('default')()
2766
 
 
2767
 
    def make_bzrdir(self, key):
2768
 
        return self.get(key)()
2769
 
 
2770
 
    def help_topic(self, topic):
2771
 
        output = textwrap.dedent("""\
2772
 
            These formats can be used for creating branches, working trees, and
2773
 
            repositories.
2774
 
 
2775
 
            """)
2776
 
        default_realkey = None
2777
 
        default_help = self.get_help('default')
2778
 
        help_pairs = []
2779
 
        for key in self.keys():
2780
 
            if key == 'default':
2781
 
                continue
2782
 
            help = self.get_help(key)
2783
 
            if help == default_help:
2784
 
                default_realkey = key
2785
 
            else:
2786
 
                help_pairs.append((key, help))
2787
 
 
2788
 
        def wrapped(key, help, info):
2789
 
            if info.native:
2790
 
                help = '(native) ' + help
2791
 
            return ':%s:\n%s\n\n' % (key, 
2792
 
                    textwrap.fill(help, initial_indent='    ', 
2793
 
                    subsequent_indent='    '))
2794
 
        if default_realkey is not None:
2795
 
            output += wrapped(default_realkey, '(default) %s' % default_help,
2796
 
                              self.get_info('default'))
2797
 
        deprecated_pairs = []
2798
 
        experimental_pairs = []
2799
 
        for key, help in help_pairs:
2800
 
            info = self.get_info(key)
2801
 
            if info.hidden:
2802
 
                continue
2803
 
            elif info.deprecated:
2804
 
                deprecated_pairs.append((key, help))
2805
 
            elif info.experimental:
2806
 
                experimental_pairs.append((key, help))
2807
 
            else:
2808
 
                output += wrapped(key, help, info)
2809
 
        if len(experimental_pairs) > 0:
2810
 
            output += "Experimental formats are shown below.\n\n"
2811
 
            for key, help in experimental_pairs:
2812
 
                info = self.get_info(key)
2813
 
                output += wrapped(key, help, info)
2814
 
        if len(deprecated_pairs) > 0:
2815
 
            output += "Deprecated formats are shown below.\n\n"
2816
 
            for key, help in deprecated_pairs:
2817
 
                info = self.get_info(key)
2818
 
                output += wrapped(key, help, info)
2819
 
 
2820
 
        return output
2821
 
 
2822
 
 
2823
 
class RepositoryAcquisitionPolicy(object):
2824
 
    """Abstract base class for repository acquisition policies.
2825
 
 
2826
 
    A repository acquisition policy decides how a BzrDir acquires a repository
2827
 
    for a branch that is being created.  The most basic policy decision is
2828
 
    whether to create a new repository or use an existing one.
2829
 
    """
2830
 
    def __init__(self, stack_on, stack_on_pwd, require_stacking):
2831
 
        """Constructor.
2832
 
 
2833
 
        :param stack_on: A location to stack on
2834
 
        :param stack_on_pwd: If stack_on is relative, the location it is
2835
 
            relative to.
2836
 
        :param require_stacking: If True, it is a failure to not stack.
2837
 
        """
2838
 
        self._stack_on = stack_on
2839
 
        self._stack_on_pwd = stack_on_pwd
2840
 
        self._require_stacking = require_stacking
2841
 
 
2842
 
    def configure_branch(self, branch):
2843
 
        """Apply any configuration data from this policy to the branch.
2844
 
 
2845
 
        Default implementation sets repository stacking.
2846
 
        """
2847
 
        if self._stack_on is None:
2848
 
            return
2849
 
        if self._stack_on_pwd is None:
2850
 
            stack_on = self._stack_on
2851
 
        else:
2852
 
            try:
2853
 
                stack_on = urlutils.rebase_url(self._stack_on,
2854
 
                    self._stack_on_pwd,
2855
 
                    branch.bzrdir.root_transport.base)
2856
 
            except errors.InvalidRebaseURLs:
2857
 
                stack_on = self._get_full_stack_on()
2858
 
        try:
2859
 
            branch.set_stacked_on_url(stack_on)
2860
 
        except errors.UnstackableBranchFormat:
2861
 
            if self._require_stacking:
2862
 
                raise
2863
 
 
2864
 
    def _get_full_stack_on(self):
2865
 
        """Get a fully-qualified URL for the stack_on location."""
2866
 
        if self._stack_on is None:
2867
 
            return None
2868
 
        if self._stack_on_pwd is None:
2869
 
            return self._stack_on
2870
 
        else:
2871
 
            return urlutils.join(self._stack_on_pwd, self._stack_on)
2872
 
 
2873
 
    def _add_fallback(self, repository):
2874
 
        """Add a fallback to the supplied repository, if stacking is set."""
2875
 
        stack_on = self._get_full_stack_on()
2876
 
        if stack_on is None:
2877
 
            return
2878
 
        stacked_dir = BzrDir.open(stack_on)
2879
 
        try:
2880
 
            stacked_repo = stacked_dir.open_branch().repository
2881
 
        except errors.NotBranchError:
2882
 
            stacked_repo = stacked_dir.open_repository()
2883
 
        try:
2884
 
            repository.add_fallback_repository(stacked_repo)
2885
 
        except errors.UnstackableRepositoryFormat:
2886
 
            if self._require_stacking:
2887
 
                raise
2888
 
 
2889
 
    def acquire_repository(self, make_working_trees=None, shared=False):
2890
 
        """Acquire a repository for this bzrdir.
2891
 
 
2892
 
        Implementations may create a new repository or use a pre-exising
2893
 
        repository.
2894
 
        :param make_working_trees: If creating a repository, set
2895
 
            make_working_trees to this value (if non-None)
2896
 
        :param shared: If creating a repository, make it shared if True
2897
 
        :return: A repository
2898
 
        """
2899
 
        raise NotImplemented(RepositoryAcquisitionPolicy.acquire_repository)
2900
 
 
2901
 
 
2902
 
class CreateRepository(RepositoryAcquisitionPolicy):
2903
 
    """A policy of creating a new repository"""
2904
 
 
2905
 
    def __init__(self, bzrdir, stack_on=None, stack_on_pwd=None,
2906
 
                 require_stacking=False):
2907
 
        """
2908
 
        Constructor.
2909
 
        :param bzrdir: The bzrdir to create the repository on.
2910
 
        :param stack_on: A location to stack on
2911
 
        :param stack_on_pwd: If stack_on is relative, the location it is
2912
 
            relative to.
2913
 
        """
2914
 
        RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
2915
 
                                             require_stacking)
2916
 
        self._bzrdir = bzrdir
2917
 
 
2918
 
    def acquire_repository(self, make_working_trees=None, shared=False):
2919
 
        """Implementation of RepositoryAcquisitionPolicy.acquire_repository
2920
 
 
2921
 
        Creates the desired repository in the bzrdir we already have.
2922
 
        """
2923
 
        repository = self._bzrdir.create_repository(shared=shared)
2924
 
        self._add_fallback(repository)
2925
 
        if make_working_trees is not None:
2926
 
            repository.set_make_working_trees(make_working_trees)
2927
 
        return repository
2928
 
 
2929
 
 
2930
 
class UseExistingRepository(RepositoryAcquisitionPolicy):
2931
 
    """A policy of reusing an existing repository"""
2932
 
 
2933
 
    def __init__(self, repository, stack_on=None, stack_on_pwd=None,
2934
 
                 require_stacking=False):
2935
 
        """Constructor.
2936
 
 
2937
 
        :param repository: The repository to use.
2938
 
        :param stack_on: A location to stack on
2939
 
        :param stack_on_pwd: If stack_on is relative, the location it is
2940
 
            relative to.
2941
 
        """
2942
 
        RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
2943
 
                                             require_stacking)
2944
 
        self._repository = repository
2945
 
 
2946
 
    def acquire_repository(self, make_working_trees=None, shared=False):
2947
 
        """Implementation of RepositoryAcquisitionPolicy.acquire_repository
2948
 
 
2949
 
        Returns an existing repository to use
2950
 
        """
2951
 
        self._add_fallback(self._repository)
2952
 
        return self._repository
2953
 
 
2954
 
 
2955
 
format_registry = BzrDirFormatRegistry()
2956
 
format_registry.register('weave', BzrDirFormat6,
2957
 
    'Pre-0.8 format.  Slower than knit and does not'
2958
 
    ' support checkouts or shared repositories.',
2959
 
    deprecated=True)
2960
 
format_registry.register_metadir('knit',
2961
 
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2962
 
    'Format using knits.  Recommended for interoperation with bzr <= 0.14.',
2963
 
    branch_format='bzrlib.branch.BzrBranchFormat5',
2964
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat3')
2965
 
format_registry.register_metadir('metaweave',
2966
 
    'bzrlib.repofmt.weaverepo.RepositoryFormat7',
2967
 
    'Transitional format in 0.8.  Slower than knit.',
2968
 
    branch_format='bzrlib.branch.BzrBranchFormat5',
2969
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat3',
2970
 
    deprecated=True)
2971
 
format_registry.register_metadir('dirstate',
2972
 
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2973
 
    help='New in 0.15: Fast local operations. Compatible with bzr 0.8 and '
2974
 
        'above when accessed over the network.',
2975
 
    branch_format='bzrlib.branch.BzrBranchFormat5',
2976
 
    # this uses bzrlib.workingtree.WorkingTreeFormat4 because importing
2977
 
    # directly from workingtree_4 triggers a circular import.
2978
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2979
 
    )
2980
 
format_registry.register_metadir('dirstate-tags',
2981
 
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2982
 
    help='New in 0.15: Fast local operations and improved scaling for '
2983
 
        'network operations. Additionally adds support for tags.'
2984
 
        ' Incompatible with bzr < 0.15.',
2985
 
    branch_format='bzrlib.branch.BzrBranchFormat6',
2986
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2987
 
    )
2988
 
format_registry.register_metadir('rich-root',
2989
 
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
2990
 
    help='New in 1.0.  Better handling of tree roots.  Incompatible with'
2991
 
        ' bzr < 1.0',
2992
 
    branch_format='bzrlib.branch.BzrBranchFormat6',
2993
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2994
 
    )
2995
 
format_registry.register_metadir('dirstate-with-subtree',
2996
 
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
2997
 
    help='New in 0.15: Fast local operations and improved scaling for '
2998
 
        'network operations. Additionally adds support for versioning nested '
2999
 
        'bzr branches. Incompatible with bzr < 0.15.',
3000
 
    branch_format='bzrlib.branch.BzrBranchFormat6',
3001
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3002
 
    experimental=True,
3003
 
    hidden=True,
3004
 
    )
3005
 
format_registry.register_metadir('pack-0.92',
3006
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack1',
3007
 
    help='New in 0.92: Pack-based format with data compatible with '
3008
 
        'dirstate-tags format repositories. Interoperates with '
3009
 
        'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3010
 
        'Previously called knitpack-experimental.  '
3011
 
        'For more information, see '
3012
 
        'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
3013
 
    branch_format='bzrlib.branch.BzrBranchFormat6',
3014
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3015
 
    )
3016
 
format_registry.register_metadir('pack-0.92-subtree',
3017
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack3',
3018
 
    help='New in 0.92: Pack-based format with data compatible with '
3019
 
        'dirstate-with-subtree format repositories. Interoperates with '
3020
 
        'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3021
 
        'Previously called knitpack-experimental.  '
3022
 
        'For more information, see '
3023
 
        'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
3024
 
    branch_format='bzrlib.branch.BzrBranchFormat6',
3025
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3026
 
    hidden=True,
3027
 
    experimental=True,
3028
 
    )
3029
 
format_registry.register_metadir('rich-root-pack',
3030
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
3031
 
    help='New in 1.0: Pack-based format with data compatible with '
3032
 
        'rich-root format repositories. Incompatible with'
3033
 
        ' bzr < 1.0',
3034
 
    branch_format='bzrlib.branch.BzrBranchFormat6',
3035
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3036
 
    )
3037
 
format_registry.register_metadir('1.6',
3038
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5',
3039
 
    help='A branch and pack based repository that supports stacking. ',
3040
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3041
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3042
 
    )
3043
 
format_registry.register_metadir('1.6.1-rich-root',
3044
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5RichRoot',
3045
 
    help='A branch and pack based repository that supports stacking '
3046
 
         'and rich root data (needed for bzr-svn). ',
3047
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3048
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3049
 
    )
3050
 
# The following two formats should always just be aliases.
3051
 
format_registry.register_metadir('development',
3052
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment1',
3053
 
    help='Current development format. Can convert data to and from pack-0.92 '
3054
 
        '(and anything compatible with pack-0.92) format repositories. '
3055
 
        'Repositories and branches in this format can only be read by bzr.dev. '
3056
 
        'Please read '
3057
 
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3058
 
        'before use.',
3059
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3060
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3061
 
    experimental=True,
3062
 
    alias=True,
3063
 
    )
3064
 
format_registry.register_metadir('development-subtree',
3065
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment1Subtree',
3066
 
    help='Current development format, subtree variant. Can convert data to and '
3067
 
        'from pack-0.92-subtree (and anything compatible with '
3068
 
        'pack-0.92-subtree) format repositories. Repositories and branches in '
3069
 
        'this format can only be read by bzr.dev. Please read '
3070
 
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3071
 
        'before use.',
3072
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3073
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3074
 
    experimental=True,
3075
 
    alias=True,
3076
 
    )
3077
 
# And the development formats which the will have aliased one of follow:
3078
 
format_registry.register_metadir('development1',
3079
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment1',
3080
 
    help='A branch and pack based repository that supports stacking. '
3081
 
        'Please read '
3082
 
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3083
 
        'before use.',
3084
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3085
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3086
 
    hidden=True,
3087
 
    experimental=True,
3088
 
    )
3089
 
format_registry.register_metadir('development1-subtree',
3090
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment1Subtree',
3091
 
    help='A branch and pack based repository that supports stacking. '
3092
 
        'Please read '
3093
 
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3094
 
        'before use.',
3095
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3096
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3097
 
    hidden=True,
3098
 
    experimental=True,
3099
 
    )
3100
 
# The current format that is made on 'bzr init'.
3101
 
format_registry.set_default('pack-0.92')