/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/bzrdir.py

  • Committer: Robert Collins
  • Date: 2007-04-19 02:27:44 UTC
  • mto: This revision was merged to the branch mainline in revision 2426.
  • Revision ID: robertc@robertcollins.net-20070419022744-pfdqz42kp1wizh43
``make docs`` now creates a man page at ``man1/bzr.1`` fixing bug 107388.
(Robert Collins)

Show diffs side-by-side

added added

removed removed

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