/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: Martin Pool
  • Date: 2007-05-02 14:00:53 UTC
  • mto: This revision was merged to the branch mainline in revision 2486.
  • Revision ID: mbp@sourcefrog.net-20070502140053-50hm0ihm249u627n
Start adding CountedLock class to partially replace LockableFiles

Show diffs side-by-side

added added

removed removed

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