1
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
 
 
3
# This program is free software; you can redistribute it and/or modify
 
 
4
# it under the terms of the GNU General Public License as published by
 
 
5
# the Free Software Foundation; either version 2 of the License, or
 
 
6
# (at your option) any later version.
 
 
8
# This program is distributed in the hope that it will be useful,
 
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
 
11
# GNU General Public License for more details.
 
 
13
# You should have received a copy of the GNU General Public License
 
 
14
# along with this program; if not, write to the Free Software
 
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
 
17
"""BzrDir logic. The BzrDir is the basic control directory used by bzr.
 
 
19
At format 7 this was split out into Branch, Repository and Checkout control
 
 
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
 
 
28
# TODO: Move old formats into a plugin to make this file smaller.
 
 
33
from bzrlib.lazy_import import lazy_import
 
 
34
lazy_import(globals(), """
 
 
35
from stat import S_ISDIR
 
 
47
    revision as _mod_revision,
 
 
57
from bzrlib.osutils import (
 
 
60
from bzrlib.smart.client import _SmartClient
 
 
61
from bzrlib.store.versioned import WeaveStore
 
 
62
from bzrlib.transactions import WriteTransaction
 
 
63
from bzrlib.transport import (
 
 
64
    do_catching_redirections,
 
 
68
from bzrlib.weave import Weave
 
 
71
from bzrlib.trace import (
 
 
83
    """A .bzr control diretory.
 
 
85
    BzrDir instances let you create or open any of the things that can be
 
 
86
    found within .bzr - checkouts, branches and repositories.
 
 
89
        the transport which this bzr dir is rooted at (i.e. file:///.../.bzr/)
 
 
91
        a transport connected to the directory this bzr was opened from
 
 
92
        (i.e. the parent directory holding the .bzr directory).
 
 
94
    Everything in the bzrdir should have the same file permissions.
 
 
98
        """Invoke break_lock on the first object in the bzrdir.
 
 
100
        If there is a tree, the tree is opened and break_lock() called.
 
 
101
        Otherwise, branch is tried, and finally repository.
 
 
103
        # XXX: This seems more like a UI function than something that really
 
 
104
        # belongs in this class.
 
 
106
            thing_to_unlock = self.open_workingtree()
 
 
107
        except (errors.NotLocalUrl, errors.NoWorkingTree):
 
 
109
                thing_to_unlock = self.open_branch()
 
 
110
            except errors.NotBranchError:
 
 
112
                    thing_to_unlock = self.open_repository()
 
 
113
                except errors.NoRepositoryPresent:
 
 
115
        thing_to_unlock.break_lock()
 
 
117
    def can_convert_format(self):
 
 
118
        """Return true if this bzrdir is one whose format we can convert from."""
 
 
121
    def check_conversion_target(self, target_format):
 
 
122
        target_repo_format = target_format.repository_format
 
 
123
        source_repo_format = self._format.repository_format
 
 
124
        source_repo_format.check_conversion_target(target_repo_format)
 
 
127
    def _check_supported(format, allow_unsupported,
 
 
128
        recommend_upgrade=True,
 
 
130
        """Give an error or warning on old formats.
 
 
132
        :param format: may be any kind of format - workingtree, branch, 
 
 
135
        :param allow_unsupported: If true, allow opening 
 
 
136
        formats that are strongly deprecated, and which may 
 
 
137
        have limited functionality.
 
 
139
        :param recommend_upgrade: If true (default), warn
 
 
140
        the user through the ui object that they may wish
 
 
141
        to upgrade the object.
 
 
143
        # TODO: perhaps move this into a base Format class; it's not BzrDir
 
 
144
        # specific. mbp 20070323
 
 
145
        if not allow_unsupported and not format.is_supported():
 
 
146
            # see open_downlevel to open legacy branches.
 
 
147
            raise errors.UnsupportedFormatError(format=format)
 
 
148
        if recommend_upgrade \
 
 
149
            and getattr(format, 'upgrade_recommended', False):
 
 
150
            ui.ui_factory.recommend_upgrade(
 
 
151
                format.get_format_description(),
 
 
154
    def clone(self, url, revision_id=None, force_new_repo=False,
 
 
155
              preserve_stacking=False):
 
 
156
        """Clone this bzrdir and its contents to url verbatim.
 
 
158
        :param url: The url create the clone at.  If url's last component does
 
 
159
            not exist, it will be created.
 
 
160
        :param revision_id: The tip revision-id to use for any branch or
 
 
161
            working tree.  If not None, then the clone operation may tune
 
 
162
            itself to download less data.
 
 
163
        :param force_new_repo: Do not use a shared repository for the target
 
 
164
                               even if one is available.
 
 
165
        :param preserve_stacking: When cloning a stacked branch, stack the
 
 
166
            new branch on top of the other branch's stacked-on branch.
 
 
168
        return self.clone_on_transport(get_transport(url),
 
 
169
                                       revision_id=revision_id,
 
 
170
                                       force_new_repo=force_new_repo,
 
 
171
                                       preserve_stacking=preserve_stacking)
 
 
173
    def clone_on_transport(self, transport, revision_id=None,
 
 
174
                           force_new_repo=False, preserve_stacking=False,
 
 
176
        """Clone this bzrdir and its contents to transport verbatim.
 
 
178
        :param transport: The transport for the location to produce the clone
 
 
179
            at.  If the target directory does not exist, it will be created.
 
 
180
        :param revision_id: The tip revision-id to use for any branch or
 
 
181
            working tree.  If not None, then the clone operation may tune
 
 
182
            itself to download less data.
 
 
183
        :param force_new_repo: Do not use a shared repository for the target,
 
 
184
                               even if one is available.
 
 
185
        :param preserve_stacking: When cloning a stacked branch, stack the
 
 
186
            new branch on top of the other branch's stacked-on branch.
 
 
188
        transport.ensure_base()
 
 
189
        require_stacking = (stacked_on is not None)
 
 
190
        metadir = self.cloning_metadir(require_stacking)
 
 
191
        result = metadir.initialize_on_transport(transport)
 
 
192
        repository_policy = None
 
 
194
            local_repo = self.find_repository()
 
 
195
        except errors.NoRepositoryPresent:
 
 
198
            local_branch = self.open_branch()
 
 
199
        except errors.NotBranchError:
 
 
202
            # enable fallbacks when branch is not a branch reference
 
 
203
            if local_branch.repository.has_same_location(local_repo):
 
 
204
                local_repo = local_branch.repository
 
 
205
            if preserve_stacking:
 
 
207
                    stacked_on = local_branch.get_stacked_on_url()
 
 
208
                except (errors.UnstackableBranchFormat,
 
 
209
                        errors.UnstackableRepositoryFormat,
 
 
214
            # may need to copy content in
 
 
215
            repository_policy = result.determine_repository_policy(
 
 
216
                force_new_repo, stacked_on, self.root_transport.base,
 
 
217
                require_stacking=require_stacking)
 
 
218
            make_working_trees = local_repo.make_working_trees()
 
 
219
            result_repo = repository_policy.acquire_repository(
 
 
220
                make_working_trees, local_repo.is_shared())
 
 
221
            result_repo.fetch(local_repo, revision_id=revision_id)
 
 
224
        # 1 if there is a branch present
 
 
225
        #   make sure its content is available in the target repository
 
 
227
        if local_branch is not None:
 
 
228
            result_branch = local_branch.clone(result, revision_id=revision_id)
 
 
229
            if repository_policy is not None:
 
 
230
                repository_policy.configure_branch(result_branch)
 
 
231
        if result_repo is None or result_repo.make_working_trees():
 
 
233
                self.open_workingtree().clone(result)
 
 
234
            except (errors.NoWorkingTree, errors.NotLocalUrl):
 
 
238
    # TODO: This should be given a Transport, and should chdir up; otherwise
 
 
239
    # this will open a new connection.
 
 
240
    def _make_tail(self, url):
 
 
241
        t = get_transport(url)
 
 
245
    def create(cls, base, format=None, possible_transports=None):
 
 
246
        """Create a new BzrDir at the url 'base'.
 
 
248
        :param format: If supplied, the format of branch to create.  If not
 
 
249
            supplied, the default is used.
 
 
250
        :param possible_transports: If supplied, a list of transports that 
 
 
251
            can be reused to share a remote connection.
 
 
253
        if cls is not BzrDir:
 
 
254
            raise AssertionError("BzrDir.create always creates the default"
 
 
255
                " format, not one of %r" % cls)
 
 
256
        t = get_transport(base, possible_transports)
 
 
259
            format = BzrDirFormat.get_default_format()
 
 
260
        return format.initialize_on_transport(t)
 
 
263
    def find_bzrdirs(transport, evaluate=None, list_current=None):
 
 
264
        """Find bzrdirs recursively from current location.
 
 
266
        This is intended primarily as a building block for more sophisticated
 
 
267
        functionality, like finding trees under a directory, or finding
 
 
268
        branches that use a given repository.
 
 
269
        :param evaluate: An optional callable that yields recurse, value,
 
 
270
            where recurse controls whether this bzrdir is recursed into
 
 
271
            and value is the value to yield.  By default, all bzrdirs
 
 
272
            are recursed into, and the return value is the bzrdir.
 
 
273
        :param list_current: if supplied, use this function to list the current
 
 
274
            directory, instead of Transport.list_dir
 
 
275
        :return: a generator of found bzrdirs, or whatever evaluate returns.
 
 
277
        if list_current is None:
 
 
278
            def list_current(transport):
 
 
279
                return transport.list_dir('')
 
 
281
            def evaluate(bzrdir):
 
 
284
        pending = [transport]
 
 
285
        while len(pending) > 0:
 
 
286
            current_transport = pending.pop()
 
 
289
                bzrdir = BzrDir.open_from_transport(current_transport)
 
 
290
            except errors.NotBranchError:
 
 
293
                recurse, value = evaluate(bzrdir)
 
 
296
                subdirs = list_current(current_transport)
 
 
297
            except errors.NoSuchFile:
 
 
300
                for subdir in sorted(subdirs, reverse=True):
 
 
301
                    pending.append(current_transport.clone(subdir))
 
 
304
    def find_branches(transport):
 
 
305
        """Find all branches under a transport.
 
 
307
        This will find all branches below the transport, including branches
 
 
308
        inside other branches.  Where possible, it will use
 
 
309
        Repository.find_branches.
 
 
311
        To list all the branches that use a particular Repository, see
 
 
312
        Repository.find_branches
 
 
314
        def evaluate(bzrdir):
 
 
316
                repository = bzrdir.open_repository()
 
 
317
            except errors.NoRepositoryPresent:
 
 
320
                return False, (None, repository)
 
 
322
                branch = bzrdir.open_branch()
 
 
323
            except errors.NotBranchError:
 
 
324
                return True, (None, None)
 
 
326
                return True, (branch, None)
 
 
328
        for branch, repo in BzrDir.find_bzrdirs(transport, evaluate=evaluate):
 
 
330
                branches.extend(repo.find_branches())
 
 
331
            if branch is not None:
 
 
332
                branches.append(branch)
 
 
335
    def destroy_repository(self):
 
 
336
        """Destroy the repository in this BzrDir"""
 
 
337
        raise NotImplementedError(self.destroy_repository)
 
 
339
    def create_branch(self):
 
 
340
        """Create a branch in this BzrDir.
 
 
342
        The bzrdir's format will control what branch format is created.
 
 
343
        For more control see BranchFormatXX.create(a_bzrdir).
 
 
345
        raise NotImplementedError(self.create_branch)
 
 
347
    def destroy_branch(self):
 
 
348
        """Destroy the branch in this BzrDir"""
 
 
349
        raise NotImplementedError(self.destroy_branch)
 
 
352
    def create_branch_and_repo(base, force_new_repo=False, format=None):
 
 
353
        """Create a new BzrDir, Branch and Repository at the url 'base'.
 
 
355
        This will use the current default BzrDirFormat unless one is
 
 
356
        specified, and use whatever 
 
 
357
        repository format that that uses via bzrdir.create_branch and
 
 
358
        create_repository. If a shared repository is available that is used
 
 
361
        The created Branch object is returned.
 
 
363
        :param base: The URL to create the branch at.
 
 
364
        :param force_new_repo: If True a new repository is always created.
 
 
365
        :param format: If supplied, the format of branch to create.  If not
 
 
366
            supplied, the default is used.
 
 
368
        bzrdir = BzrDir.create(base, format)
 
 
369
        bzrdir._find_or_create_repository(force_new_repo)
 
 
370
        return bzrdir.create_branch()
 
 
372
    def determine_repository_policy(self, force_new_repo=False, stack_on=None,
 
 
373
                                    stack_on_pwd=None, require_stacking=False):
 
 
374
        """Return an object representing a policy to use.
 
 
376
        This controls whether a new repository is created, or a shared
 
 
377
        repository used instead.
 
 
379
        If stack_on is supplied, will not seek a containing shared repo.
 
 
381
        :param force_new_repo: If True, require a new repository to be created.
 
 
382
        :param stack_on: If supplied, the location to stack on.  If not
 
 
383
            supplied, a default_stack_on location may be used.
 
 
384
        :param stack_on_pwd: If stack_on is relative, the location it is
 
 
387
        def repository_policy(found_bzrdir):
 
 
390
            config = found_bzrdir.get_config()
 
 
392
            if config is not None:
 
 
393
                stack_on = config.get_default_stack_on()
 
 
394
                if stack_on is not None:
 
 
395
                    stack_on_pwd = found_bzrdir.root_transport.base
 
 
397
                    note('Using default stacking branch %s at %s', stack_on,
 
 
399
            # does it have a repository ?
 
 
401
                repository = found_bzrdir.open_repository()
 
 
402
            except errors.NoRepositoryPresent:
 
 
405
                if ((found_bzrdir.root_transport.base !=
 
 
406
                     self.root_transport.base) and not repository.is_shared()):
 
 
413
                return UseExistingRepository(repository, stack_on,
 
 
414
                    stack_on_pwd, require_stacking=require_stacking), True
 
 
416
                return CreateRepository(self, stack_on, stack_on_pwd,
 
 
417
                    require_stacking=require_stacking), True
 
 
419
        if not force_new_repo:
 
 
421
                policy = self._find_containing(repository_policy)
 
 
422
                if policy is not None:
 
 
426
                    return UseExistingRepository(self.open_repository(),
 
 
427
                        stack_on, stack_on_pwd,
 
 
428
                        require_stacking=require_stacking)
 
 
429
                except errors.NoRepositoryPresent:
 
 
431
        return CreateRepository(self, stack_on, stack_on_pwd,
 
 
432
                                require_stacking=require_stacking)
 
 
434
    def _find_or_create_repository(self, force_new_repo):
 
 
435
        """Create a new repository if needed, returning the repository."""
 
 
436
        policy = self.determine_repository_policy(force_new_repo)
 
 
437
        return policy.acquire_repository()
 
 
440
    def create_branch_convenience(base, force_new_repo=False,
 
 
441
                                  force_new_tree=None, format=None,
 
 
442
                                  possible_transports=None):
 
 
443
        """Create a new BzrDir, Branch and Repository at the url 'base'.
 
 
445
        This is a convenience function - it will use an existing repository
 
 
446
        if possible, can be told explicitly whether to create a working tree or
 
 
449
        This will use the current default BzrDirFormat unless one is
 
 
450
        specified, and use whatever 
 
 
451
        repository format that that uses via bzrdir.create_branch and
 
 
452
        create_repository. If a shared repository is available that is used
 
 
453
        preferentially. Whatever repository is used, its tree creation policy
 
 
456
        The created Branch object is returned.
 
 
457
        If a working tree cannot be made due to base not being a file:// url,
 
 
458
        no error is raised unless force_new_tree is True, in which case no 
 
 
459
        data is created on disk and NotLocalUrl is raised.
 
 
461
        :param base: The URL to create the branch at.
 
 
462
        :param force_new_repo: If True a new repository is always created.
 
 
463
        :param force_new_tree: If True or False force creation of a tree or 
 
 
464
                               prevent such creation respectively.
 
 
465
        :param format: Override for the bzrdir format to create.
 
 
466
        :param possible_transports: An optional reusable transports list.
 
 
469
            # check for non local urls
 
 
470
            t = get_transport(base, possible_transports)
 
 
471
            if not isinstance(t, local.LocalTransport):
 
 
472
                raise errors.NotLocalUrl(base)
 
 
473
        bzrdir = BzrDir.create(base, format, possible_transports)
 
 
474
        repo = bzrdir._find_or_create_repository(force_new_repo)
 
 
475
        result = bzrdir.create_branch()
 
 
476
        if force_new_tree or (repo.make_working_trees() and
 
 
477
                              force_new_tree is None):
 
 
479
                bzrdir.create_workingtree()
 
 
480
            except errors.NotLocalUrl:
 
 
485
    def create_standalone_workingtree(base, format=None):
 
 
486
        """Create a new BzrDir, WorkingTree, Branch and Repository at 'base'.
 
 
488
        'base' must be a local path or a file:// url.
 
 
490
        This will use the current default BzrDirFormat unless one is
 
 
491
        specified, and use whatever 
 
 
492
        repository format that that uses for bzrdirformat.create_workingtree,
 
 
493
        create_branch and create_repository.
 
 
495
        :param format: Override for the bzrdir format to create.
 
 
496
        :return: The WorkingTree object.
 
 
498
        t = get_transport(base)
 
 
499
        if not isinstance(t, local.LocalTransport):
 
 
500
            raise errors.NotLocalUrl(base)
 
 
501
        bzrdir = BzrDir.create_branch_and_repo(base,
 
 
503
                                               format=format).bzrdir
 
 
504
        return bzrdir.create_workingtree()
 
 
506
    def create_workingtree(self, revision_id=None, from_branch=None,
 
 
507
        accelerator_tree=None, hardlink=False):
 
 
508
        """Create a working tree at this BzrDir.
 
 
510
        :param revision_id: create it as of this revision id.
 
 
511
        :param from_branch: override bzrdir branch (for lightweight checkouts)
 
 
512
        :param accelerator_tree: A tree which can be used for retrieving file
 
 
513
            contents more quickly than the revision tree, i.e. a workingtree.
 
 
514
            The revision tree will be used for cases where accelerator_tree's
 
 
515
            content is different.
 
 
517
        raise NotImplementedError(self.create_workingtree)
 
 
519
    def retire_bzrdir(self, limit=10000):
 
 
520
        """Permanently disable the bzrdir.
 
 
522
        This is done by renaming it to give the user some ability to recover
 
 
523
        if there was a problem.
 
 
525
        This will have horrible consequences if anyone has anything locked or
 
 
527
        :param limit: number of times to retry
 
 
532
                to_path = '.bzr.retired.%d' % i
 
 
533
                self.root_transport.rename('.bzr', to_path)
 
 
534
                note("renamed %s to %s"
 
 
535
                    % (self.root_transport.abspath('.bzr'), to_path))
 
 
537
            except (errors.TransportError, IOError, errors.PathError):
 
 
544
    def destroy_workingtree(self):
 
 
545
        """Destroy the working tree at this BzrDir.
 
 
547
        Formats that do not support this may raise UnsupportedOperation.
 
 
549
        raise NotImplementedError(self.destroy_workingtree)
 
 
551
    def destroy_workingtree_metadata(self):
 
 
552
        """Destroy the control files for the working tree at this BzrDir.
 
 
554
        The contents of working tree files are not affected.
 
 
555
        Formats that do not support this may raise UnsupportedOperation.
 
 
557
        raise NotImplementedError(self.destroy_workingtree_metadata)
 
 
559
    def _find_containing(self, evaluate):
 
 
560
        """Find something in a containing control directory.
 
 
562
        This method will scan containing control dirs, until it finds what
 
 
563
        it is looking for, decides that it will never find it, or runs out
 
 
564
        of containing control directories to check.
 
 
566
        It is used to implement find_repository and
 
 
567
        determine_repository_policy.
 
 
569
        :param evaluate: A function returning (value, stop).  If stop is True,
 
 
570
            the value will be returned.
 
 
574
            result, stop = evaluate(found_bzrdir)
 
 
577
            next_transport = found_bzrdir.root_transport.clone('..')
 
 
578
            if (found_bzrdir.root_transport.base == next_transport.base):
 
 
579
                # top of the file system
 
 
581
            # find the next containing bzrdir
 
 
583
                found_bzrdir = BzrDir.open_containing_from_transport(
 
 
585
            except errors.NotBranchError:
 
 
588
    def find_repository(self):
 
 
589
        """Find the repository that should be used.
 
 
591
        This does not require a branch as we use it to find the repo for
 
 
592
        new branches as well as to hook existing branches up to their
 
 
595
        def usable_repository(found_bzrdir):
 
 
596
            # does it have a repository ?
 
 
598
                repository = found_bzrdir.open_repository()
 
 
599
            except errors.NoRepositoryPresent:
 
 
601
            if found_bzrdir.root_transport.base == self.root_transport.base:
 
 
602
                return repository, True
 
 
603
            elif repository.is_shared():
 
 
604
                return repository, True
 
 
608
        found_repo = self._find_containing(usable_repository)
 
 
609
        if found_repo is None:
 
 
610
            raise errors.NoRepositoryPresent(self)
 
 
613
    def get_branch_reference(self):
 
 
614
        """Return the referenced URL for the branch in this bzrdir.
 
 
616
        :raises NotBranchError: If there is no Branch.
 
 
617
        :return: The URL the branch in this bzrdir references if it is a
 
 
618
            reference branch, or None for regular branches.
 
 
622
    def get_branch_transport(self, branch_format):
 
 
623
        """Get the transport for use by branch format in this BzrDir.
 
 
625
        Note that bzr dirs that do not support format strings will raise
 
 
626
        IncompatibleFormat if the branch format they are given has
 
 
627
        a format string, and vice versa.
 
 
629
        If branch_format is None, the transport is returned with no 
 
 
630
        checking. If it is not None, then the returned transport is
 
 
631
        guaranteed to point to an existing directory ready for use.
 
 
633
        raise NotImplementedError(self.get_branch_transport)
 
 
635
    def _find_creation_modes(self):
 
 
636
        """Determine the appropriate modes for files and directories.
 
 
638
        They're always set to be consistent with the base directory,
 
 
639
        assuming that this transport allows setting modes.
 
 
641
        # TODO: Do we need or want an option (maybe a config setting) to turn
 
 
642
        # this off or override it for particular locations? -- mbp 20080512
 
 
643
        if self._mode_check_done:
 
 
645
        self._mode_check_done = True
 
 
647
            st = self.transport.stat('.')
 
 
648
        except errors.TransportNotPossible:
 
 
649
            self._dir_mode = None
 
 
650
            self._file_mode = None
 
 
652
            # Check the directory mode, but also make sure the created
 
 
653
            # directories and files are read-write for this user. This is
 
 
654
            # mostly a workaround for filesystems which lie about being able to
 
 
655
            # write to a directory (cygwin & win32)
 
 
656
            if (st.st_mode & 07777 == 00000):
 
 
657
                # FTP allows stat but does not return dir/file modes
 
 
658
                self._dir_mode = None
 
 
659
                self._file_mode = None
 
 
661
                self._dir_mode = (st.st_mode & 07777) | 00700
 
 
662
                # Remove the sticky and execute bits for files
 
 
663
                self._file_mode = self._dir_mode & ~07111
 
 
665
    def _get_file_mode(self):
 
 
666
        """Return Unix mode for newly created files, or None.
 
 
668
        if not self._mode_check_done:
 
 
669
            self._find_creation_modes()
 
 
670
        return self._file_mode
 
 
672
    def _get_dir_mode(self):
 
 
673
        """Return Unix mode for newly created directories, or None.
 
 
675
        if not self._mode_check_done:
 
 
676
            self._find_creation_modes()
 
 
677
        return self._dir_mode
 
 
679
    def get_repository_transport(self, repository_format):
 
 
680
        """Get the transport for use by repository format in this BzrDir.
 
 
682
        Note that bzr dirs that do not support format strings will raise
 
 
683
        IncompatibleFormat if the repository format they are given has
 
 
684
        a format string, and vice versa.
 
 
686
        If repository_format is None, the transport is returned with no 
 
 
687
        checking. If it is not None, then the returned transport is
 
 
688
        guaranteed to point to an existing directory ready for use.
 
 
690
        raise NotImplementedError(self.get_repository_transport)
 
 
692
    def get_workingtree_transport(self, tree_format):
 
 
693
        """Get the transport for use by workingtree format in this BzrDir.
 
 
695
        Note that bzr dirs that do not support format strings will raise
 
 
696
        IncompatibleFormat if the workingtree format they are given has a
 
 
697
        format string, and vice versa.
 
 
699
        If workingtree_format is None, the transport is returned with no 
 
 
700
        checking. If it is not None, then the returned transport is
 
 
701
        guaranteed to point to an existing directory ready for use.
 
 
703
        raise NotImplementedError(self.get_workingtree_transport)
 
 
705
    def get_config(self):
 
 
706
        if getattr(self, '_get_config', None) is None:
 
 
708
        return self._get_config()
 
 
710
    def __init__(self, _transport, _format):
 
 
711
        """Initialize a Bzr control dir object.
 
 
713
        Only really common logic should reside here, concrete classes should be
 
 
714
        made with varying behaviours.
 
 
716
        :param _format: the format that is creating this BzrDir instance.
 
 
717
        :param _transport: the transport this dir is based at.
 
 
719
        self._format = _format
 
 
720
        self.transport = _transport.clone('.bzr')
 
 
721
        self.root_transport = _transport
 
 
722
        self._mode_check_done = False
 
 
724
    def is_control_filename(self, filename):
 
 
725
        """True if filename is the name of a path which is reserved for bzrdir's.
 
 
727
        :param filename: A filename within the root transport of this bzrdir.
 
 
729
        This is true IF and ONLY IF the filename is part of the namespace reserved
 
 
730
        for bzr control dirs. Currently this is the '.bzr' directory in the root
 
 
731
        of the root_transport. it is expected that plugins will need to extend
 
 
732
        this in the future - for instance to make bzr talk with svn working
 
 
735
        # this might be better on the BzrDirFormat class because it refers to 
 
 
736
        # all the possible bzrdir disk formats. 
 
 
737
        # This method is tested via the workingtree is_control_filename tests- 
 
 
738
        # it was extracted from WorkingTree.is_control_filename. If the method's
 
 
739
        # contract is extended beyond the current trivial implementation, please
 
 
740
        # add new tests for it to the appropriate place.
 
 
741
        return filename == '.bzr' or filename.startswith('.bzr/')
 
 
743
    def needs_format_conversion(self, format=None):
 
 
744
        """Return true if this bzrdir needs convert_format run on it.
 
 
746
        For instance, if the repository format is out of date but the 
 
 
747
        branch and working tree are not, this should return True.
 
 
749
        :param format: Optional parameter indicating a specific desired
 
 
750
                       format we plan to arrive at.
 
 
752
        raise NotImplementedError(self.needs_format_conversion)
 
 
755
    def open_unsupported(base):
 
 
756
        """Open a branch which is not supported."""
 
 
757
        return BzrDir.open(base, _unsupported=True)
 
 
760
    def open(base, _unsupported=False, possible_transports=None):
 
 
761
        """Open an existing bzrdir, rooted at 'base' (url).
 
 
763
        :param _unsupported: a private parameter to the BzrDir class.
 
 
765
        t = get_transport(base, possible_transports=possible_transports)
 
 
766
        return BzrDir.open_from_transport(t, _unsupported=_unsupported)
 
 
769
    def open_from_transport(transport, _unsupported=False,
 
 
770
                            _server_formats=True):
 
 
771
        """Open a bzrdir within a particular directory.
 
 
773
        :param transport: Transport containing the bzrdir.
 
 
774
        :param _unsupported: private.
 
 
776
        base = transport.base
 
 
778
        def find_format(transport):
 
 
779
            return transport, BzrDirFormat.find_format(
 
 
780
                transport, _server_formats=_server_formats)
 
 
782
        def redirected(transport, e, redirection_notice):
 
 
783
            qualified_source = e.get_source_url()
 
 
784
            relpath = transport.relpath(qualified_source)
 
 
785
            if not e.target.endswith(relpath):
 
 
786
                # Not redirected to a branch-format, not a branch
 
 
787
                raise errors.NotBranchError(path=e.target)
 
 
788
            target = e.target[:-len(relpath)]
 
 
789
            note('%s is%s redirected to %s',
 
 
790
                 transport.base, e.permanently, target)
 
 
791
            # Let's try with a new transport
 
 
792
            # FIXME: If 'transport' has a qualifier, this should
 
 
793
            # be applied again to the new transport *iff* the
 
 
794
            # schemes used are the same. Uncomment this code
 
 
795
            # once the function (and tests) exist.
 
 
797
            #target = urlutils.copy_url_qualifiers(original, target)
 
 
798
            return get_transport(target)
 
 
801
            transport, format = do_catching_redirections(find_format,
 
 
804
        except errors.TooManyRedirections:
 
 
805
            raise errors.NotBranchError(base)
 
 
807
        BzrDir._check_supported(format, _unsupported)
 
 
808
        return format.open(transport, _found=True)
 
 
810
    def open_branch(self, unsupported=False):
 
 
811
        """Open the branch object at this BzrDir if one is present.
 
 
813
        If unsupported is True, then no longer supported branch formats can
 
 
816
        TODO: static convenience version of this?
 
 
818
        raise NotImplementedError(self.open_branch)
 
 
821
    def open_containing(url, possible_transports=None):
 
 
822
        """Open an existing branch which contains url.
 
 
824
        :param url: url to search from.
 
 
825
        See open_containing_from_transport for more detail.
 
 
827
        transport = get_transport(url, possible_transports)
 
 
828
        return BzrDir.open_containing_from_transport(transport)
 
 
831
    def open_containing_from_transport(a_transport):
 
 
832
        """Open an existing branch which contains a_transport.base.
 
 
834
        This probes for a branch at a_transport, and searches upwards from there.
 
 
836
        Basically we keep looking up until we find the control directory or
 
 
837
        run into the root.  If there isn't one, raises NotBranchError.
 
 
838
        If there is one and it is either an unrecognised format or an unsupported 
 
 
839
        format, UnknownFormatError or UnsupportedFormatError are raised.
 
 
840
        If there is one, it is returned, along with the unused portion of url.
 
 
842
        :return: The BzrDir that contains the path, and a Unicode path 
 
 
843
                for the rest of the URL.
 
 
845
        # this gets the normalised url back. I.e. '.' -> the full path.
 
 
846
        url = a_transport.base
 
 
849
                result = BzrDir.open_from_transport(a_transport)
 
 
850
                return result, urlutils.unescape(a_transport.relpath(url))
 
 
851
            except errors.NotBranchError, e:
 
 
854
                new_t = a_transport.clone('..')
 
 
855
            except errors.InvalidURLJoin:
 
 
856
                # reached the root, whatever that may be
 
 
857
                raise errors.NotBranchError(path=url)
 
 
858
            if new_t.base == a_transport.base:
 
 
859
                # reached the root, whatever that may be
 
 
860
                raise errors.NotBranchError(path=url)
 
 
863
    def _get_tree_branch(self):
 
 
864
        """Return the branch and tree, if any, for this bzrdir.
 
 
866
        Return None for tree if not present or inaccessible.
 
 
867
        Raise NotBranchError if no branch is present.
 
 
868
        :return: (tree, branch)
 
 
871
            tree = self.open_workingtree()
 
 
872
        except (errors.NoWorkingTree, errors.NotLocalUrl):
 
 
874
            branch = self.open_branch()
 
 
880
    def open_tree_or_branch(klass, location):
 
 
881
        """Return the branch and working tree at a location.
 
 
883
        If there is no tree at the location, tree will be None.
 
 
884
        If there is no branch at the location, an exception will be
 
 
886
        :return: (tree, branch)
 
 
888
        bzrdir = klass.open(location)
 
 
889
        return bzrdir._get_tree_branch()
 
 
892
    def open_containing_tree_or_branch(klass, location):
 
 
893
        """Return the branch and working tree contained by a location.
 
 
895
        Returns (tree, branch, relpath).
 
 
896
        If there is no tree at containing the location, tree will be None.
 
 
897
        If there is no branch containing the location, an exception will be
 
 
899
        relpath is the portion of the path that is contained by the branch.
 
 
901
        bzrdir, relpath = klass.open_containing(location)
 
 
902
        tree, branch = bzrdir._get_tree_branch()
 
 
903
        return tree, branch, relpath
 
 
906
    def open_containing_tree_branch_or_repository(klass, location):
 
 
907
        """Return the working tree, branch and repo contained by a location.
 
 
909
        Returns (tree, branch, repository, relpath).
 
 
910
        If there is no tree containing the location, tree will be None.
 
 
911
        If there is no branch containing the location, branch will be None.
 
 
912
        If there is no repository containing the location, repository will be
 
 
914
        relpath is the portion of the path that is contained by the innermost
 
 
917
        If no tree, branch or repository is found, a NotBranchError is raised.
 
 
919
        bzrdir, relpath = klass.open_containing(location)
 
 
921
            tree, branch = bzrdir._get_tree_branch()
 
 
922
        except errors.NotBranchError:
 
 
924
                repo = bzrdir.find_repository()
 
 
925
                return None, None, repo, relpath
 
 
926
            except (errors.NoRepositoryPresent):
 
 
927
                raise errors.NotBranchError(location)
 
 
928
        return tree, branch, branch.repository, relpath
 
 
930
    def open_repository(self, _unsupported=False):
 
 
931
        """Open the repository object at this BzrDir if one is present.
 
 
933
        This will not follow the Branch object pointer - it's strictly a direct
 
 
934
        open facility. Most client code should use open_branch().repository to
 
 
937
        :param _unsupported: a private parameter, not part of the api.
 
 
938
        TODO: static convenience version of this?
 
 
940
        raise NotImplementedError(self.open_repository)
 
 
942
    def open_workingtree(self, _unsupported=False,
 
 
943
                         recommend_upgrade=True, from_branch=None):
 
 
944
        """Open the workingtree object at this BzrDir if one is present.
 
 
946
        :param recommend_upgrade: Optional keyword parameter, when True (the
 
 
947
            default), emit through the ui module a recommendation that the user
 
 
948
            upgrade the working tree when the workingtree being opened is old
 
 
949
            (but still fully supported).
 
 
950
        :param from_branch: override bzrdir branch (for lightweight checkouts)
 
 
952
        raise NotImplementedError(self.open_workingtree)
 
 
954
    def has_branch(self):
 
 
955
        """Tell if this bzrdir contains a branch.
 
 
957
        Note: if you're going to open the branch, you should just go ahead
 
 
958
        and try, and not ask permission first.  (This method just opens the 
 
 
959
        branch and discards it, and that's somewhat expensive.) 
 
 
964
        except errors.NotBranchError:
 
 
967
    def has_workingtree(self):
 
 
968
        """Tell if this bzrdir contains a working tree.
 
 
970
        This will still raise an exception if the bzrdir has a workingtree that
 
 
971
        is remote & inaccessible.
 
 
973
        Note: if you're going to open the working tree, you should just go ahead
 
 
974
        and try, and not ask permission first.  (This method just opens the 
 
 
975
        workingtree and discards it, and that's somewhat expensive.) 
 
 
978
            self.open_workingtree(recommend_upgrade=False)
 
 
980
        except errors.NoWorkingTree:
 
 
983
    def _cloning_metadir(self):
 
 
984
        """Produce a metadir suitable for cloning with.
 
 
986
        :returns: (destination_bzrdir_format, source_repository)
 
 
988
        result_format = self._format.__class__()
 
 
991
                branch = self.open_branch()
 
 
992
                source_repository = branch.repository
 
 
993
                result_format._branch_format = branch._format
 
 
994
            except errors.NotBranchError:
 
 
996
                source_repository = self.open_repository()
 
 
997
        except errors.NoRepositoryPresent:
 
 
998
            source_repository = None
 
 
1000
            # XXX TODO: This isinstance is here because we have not implemented
 
 
1001
            # the fix recommended in bug # 103195 - to delegate this choice the
 
 
1002
            # repository itself.
 
 
1003
            repo_format = source_repository._format
 
 
1004
            if isinstance(repo_format, remote.RemoteRepositoryFormat):
 
 
1005
                source_repository._ensure_real()
 
 
1006
                repo_format = source_repository._real_repository._format
 
 
1007
            result_format.repository_format = repo_format
 
 
1009
            # TODO: Couldn't we just probe for the format in these cases,
 
 
1010
            # rather than opening the whole tree?  It would be a little
 
 
1011
            # faster. mbp 20070401
 
 
1012
            tree = self.open_workingtree(recommend_upgrade=False)
 
 
1013
        except (errors.NoWorkingTree, errors.NotLocalUrl):
 
 
1014
            result_format.workingtree_format = None
 
 
1016
            result_format.workingtree_format = tree._format.__class__()
 
 
1017
        return result_format, source_repository
 
 
1019
    def cloning_metadir(self, require_stacking=False):
 
 
1020
        """Produce a metadir suitable for cloning or sprouting with.
 
 
1022
        These operations may produce workingtrees (yes, even though they're
 
 
1023
        "cloning" something that doesn't have a tree), so a viable workingtree
 
 
1024
        format must be selected.
 
 
1026
        :require_stacking: If True, non-stackable formats will be upgraded
 
 
1027
            to similar stackable formats.
 
 
1028
        :returns: a BzrDirFormat with all component formats either set
 
 
1029
            appropriately or set to None if that component should not be
 
 
1032
        format, repository = self._cloning_metadir()
 
 
1033
        if format._workingtree_format is None:
 
 
1034
            if repository is None:
 
 
1036
            tree_format = repository._format._matchingbzrdir.workingtree_format
 
 
1037
            format.workingtree_format = tree_format.__class__()
 
 
1038
        if (require_stacking and not
 
 
1039
            format.get_branch_format().supports_stacking()):
 
 
1040
            # We need to make a stacked branch, but the default format for the
 
 
1041
            # target doesn't support stacking.  So force a branch that *can*
 
 
1043
            from bzrlib.branch import BzrBranchFormat7
 
 
1044
            format._branch_format = BzrBranchFormat7()
 
 
1045
            mutter("using %r for stacking" % (format._branch_format,))
 
 
1046
            from bzrlib.repofmt import pack_repo
 
 
1047
            if format.repository_format.rich_root_data:
 
 
1048
                bzrdir_format_name = '1.6.1-rich-root'
 
 
1049
                repo_format = pack_repo.RepositoryFormatKnitPack5RichRoot()
 
 
1051
                bzrdir_format_name = '1.6'
 
 
1052
                repo_format = pack_repo.RepositoryFormatKnitPack5()
 
 
1053
            note('Source format does not support stacking, using format:'
 
 
1055
                 bzrdir_format_name, repo_format.get_format_description())
 
 
1056
            format.repository_format = repo_format
 
 
1059
    def checkout_metadir(self):
 
 
1060
        return self.cloning_metadir()
 
 
1062
    def sprout(self, url, revision_id=None, force_new_repo=False,
 
 
1063
               recurse='down', possible_transports=None,
 
 
1064
               accelerator_tree=None, hardlink=False, stacked=False):
 
 
1065
        """Create a copy of this bzrdir prepared for use as a new line of
 
 
1068
        If url's last component does not exist, it will be created.
 
 
1070
        Attributes related to the identity of the source branch like
 
 
1071
        branch nickname will be cleaned, a working tree is created
 
 
1072
        whether one existed before or not; and a local branch is always
 
 
1075
        if revision_id is not None, then the clone operation may tune
 
 
1076
            itself to download less data.
 
 
1077
        :param accelerator_tree: A tree which can be used for retrieving file
 
 
1078
            contents more quickly than the revision tree, i.e. a workingtree.
 
 
1079
            The revision tree will be used for cases where accelerator_tree's
 
 
1080
            content is different.
 
 
1081
        :param hardlink: If true, hard-link files from accelerator_tree,
 
 
1083
        :param stacked: If true, create a stacked branch referring to the
 
 
1084
            location of this control directory.
 
 
1086
        target_transport = get_transport(url, possible_transports)
 
 
1087
        target_transport.ensure_base()
 
 
1088
        cloning_format = self.cloning_metadir(stacked)
 
 
1089
        # Create/update the result branch
 
 
1090
        result = cloning_format.initialize_on_transport(target_transport)
 
 
1092
            source_branch = self.open_branch()
 
 
1093
            source_repository = source_branch.repository
 
 
1095
                stacked_branch_url = self.root_transport.base
 
 
1097
                # if a stacked branch wasn't requested, we don't create one
 
 
1098
                # even if the origin was stacked
 
 
1099
                stacked_branch_url = None
 
 
1100
        except errors.NotBranchError:
 
 
1101
            source_branch = None
 
 
1103
                source_repository = self.open_repository()
 
 
1104
            except errors.NoRepositoryPresent:
 
 
1105
                source_repository = None
 
 
1106
            stacked_branch_url = None
 
 
1107
        repository_policy = result.determine_repository_policy(
 
 
1108
            force_new_repo, stacked_branch_url, require_stacking=stacked)
 
 
1109
        result_repo = repository_policy.acquire_repository()
 
 
1110
        if source_repository is not None:
 
 
1111
            # Fetch while stacked to prevent unstacked fetch from
 
 
1113
            result_repo.fetch(source_repository, revision_id=revision_id)
 
 
1115
        if source_branch is None:
 
 
1116
            # this is for sprouting a bzrdir without a branch; is that
 
 
1118
            # Not especially, but it's part of the contract.
 
 
1119
            result_branch = result.create_branch()
 
 
1121
            # Force NULL revision to avoid using repository before stacking
 
 
1123
            result_branch = source_branch.sprout(
 
 
1124
                result, revision_id=_mod_revision.NULL_REVISION)
 
 
1125
            parent_location = result_branch.get_parent()
 
 
1126
        mutter("created new branch %r" % (result_branch,))
 
 
1127
        repository_policy.configure_branch(result_branch)
 
 
1128
        if source_branch is not None:
 
 
1129
            source_branch.copy_content_into(result_branch, revision_id)
 
 
1130
            # Override copy_content_into
 
 
1131
            result_branch.set_parent(parent_location)
 
 
1133
        # Create/update the result working tree
 
 
1134
        if isinstance(target_transport, local.LocalTransport) and (
 
 
1135
            result_repo is None or result_repo.make_working_trees()):
 
 
1136
            wt = result.create_workingtree(accelerator_tree=accelerator_tree,
 
 
1140
                if wt.path2id('') is None:
 
 
1142
                        wt.set_root_id(self.open_workingtree.get_root_id())
 
 
1143
                    except errors.NoWorkingTree:
 
 
1149
        if recurse == 'down':
 
 
1151
                basis = wt.basis_tree()
 
 
1153
                subtrees = basis.iter_references()
 
 
1154
            elif result_branch is not None:
 
 
1155
                basis = result_branch.basis_tree()
 
 
1157
                subtrees = basis.iter_references()
 
 
1158
            elif source_branch is not None:
 
 
1159
                basis = source_branch.basis_tree()
 
 
1161
                subtrees = basis.iter_references()
 
 
1166
                for path, file_id in subtrees:
 
 
1167
                    target = urlutils.join(url, urlutils.escape(path))
 
 
1168
                    sublocation = source_branch.reference_parent(file_id, path)
 
 
1169
                    sublocation.bzrdir.sprout(target,
 
 
1170
                        basis.get_reference_revision(file_id, path),
 
 
1171
                        force_new_repo=force_new_repo, recurse=recurse,
 
 
1174
                if basis is not None:
 
 
1179
class BzrDirPreSplitOut(BzrDir):
 
 
1180
    """A common class for the all-in-one formats."""
 
 
1182
    def __init__(self, _transport, _format):
 
 
1183
        """See BzrDir.__init__."""
 
 
1184
        super(BzrDirPreSplitOut, self).__init__(_transport, _format)
 
 
1185
        self._control_files = lockable_files.LockableFiles(
 
 
1186
                                            self.get_branch_transport(None),
 
 
1187
                                            self._format._lock_file_name,
 
 
1188
                                            self._format._lock_class)
 
 
1190
    def break_lock(self):
 
 
1191
        """Pre-splitout bzrdirs do not suffer from stale locks."""
 
 
1192
        raise NotImplementedError(self.break_lock)
 
 
1194
    def cloning_metadir(self, require_stacking=False):
 
 
1195
        """Produce a metadir suitable for cloning with."""
 
 
1196
        if require_stacking:
 
 
1197
            return format_registry.make_bzrdir('1.6')
 
 
1198
        return self._format.__class__()
 
 
1200
    def clone(self, url, revision_id=None, force_new_repo=False,
 
 
1201
              preserve_stacking=False):
 
 
1202
        """See BzrDir.clone().
 
 
1204
        force_new_repo has no effect, since this family of formats always
 
 
1205
        require a new repository.
 
 
1206
        preserve_stacking has no effect, since no source branch using this
 
 
1207
        family of formats can be stacked, so there is no stacking to preserve.
 
 
1209
        self._make_tail(url)
 
 
1210
        result = self._format._initialize_for_clone(url)
 
 
1211
        self.open_repository().clone(result, revision_id=revision_id)
 
 
1212
        from_branch = self.open_branch()
 
 
1213
        from_branch.clone(result, revision_id=revision_id)
 
 
1215
            tree = self.open_workingtree()
 
 
1216
        except errors.NotLocalUrl:
 
 
1217
            # make a new one, this format always has to have one.
 
 
1218
            result._init_workingtree()
 
 
1223
    def create_branch(self):
 
 
1224
        """See BzrDir.create_branch."""
 
 
1225
        return self._format.get_branch_format().initialize(self)
 
 
1227
    def destroy_branch(self):
 
 
1228
        """See BzrDir.destroy_branch."""
 
 
1229
        raise errors.UnsupportedOperation(self.destroy_branch, self)
 
 
1231
    def create_repository(self, shared=False):
 
 
1232
        """See BzrDir.create_repository."""
 
 
1234
            raise errors.IncompatibleFormat('shared repository', self._format)
 
 
1235
        return self.open_repository()
 
 
1237
    def destroy_repository(self):
 
 
1238
        """See BzrDir.destroy_repository."""
 
 
1239
        raise errors.UnsupportedOperation(self.destroy_repository, self)
 
 
1241
    def create_workingtree(self, revision_id=None, from_branch=None,
 
 
1242
                           accelerator_tree=None, hardlink=False):
 
 
1243
        """See BzrDir.create_workingtree."""
 
 
1244
        # The workingtree is sometimes created when the bzrdir is created,
 
 
1245
        # but not when cloning.
 
 
1247
        # this looks buggy but is not -really-
 
 
1248
        # because this format creates the workingtree when the bzrdir is
 
 
1250
        # clone and sprout will have set the revision_id
 
 
1251
        # and that will have set it for us, its only
 
 
1252
        # specific uses of create_workingtree in isolation
 
 
1253
        # that can do wonky stuff here, and that only
 
 
1254
        # happens for creating checkouts, which cannot be 
 
 
1255
        # done on this format anyway. So - acceptable wart.
 
 
1257
            result = self.open_workingtree(recommend_upgrade=False)
 
 
1258
        except errors.NoSuchFile:
 
 
1259
            result = self._init_workingtree()
 
 
1260
        if revision_id is not None:
 
 
1261
            if revision_id == _mod_revision.NULL_REVISION:
 
 
1262
                result.set_parent_ids([])
 
 
1264
                result.set_parent_ids([revision_id])
 
 
1267
    def _init_workingtree(self):
 
 
1268
        from bzrlib.workingtree import WorkingTreeFormat2
 
 
1270
            return WorkingTreeFormat2().initialize(self)
 
 
1271
        except errors.NotLocalUrl:
 
 
1272
            # Even though we can't access the working tree, we need to
 
 
1273
            # create its control files.
 
 
1274
            return WorkingTreeFormat2()._stub_initialize_on_transport(
 
 
1275
                self.transport, self._control_files._file_mode)
 
 
1277
    def destroy_workingtree(self):
 
 
1278
        """See BzrDir.destroy_workingtree."""
 
 
1279
        raise errors.UnsupportedOperation(self.destroy_workingtree, self)
 
 
1281
    def destroy_workingtree_metadata(self):
 
 
1282
        """See BzrDir.destroy_workingtree_metadata."""
 
 
1283
        raise errors.UnsupportedOperation(self.destroy_workingtree_metadata, 
 
 
1286
    def get_branch_transport(self, branch_format):
 
 
1287
        """See BzrDir.get_branch_transport()."""
 
 
1288
        if branch_format is None:
 
 
1289
            return self.transport
 
 
1291
            branch_format.get_format_string()
 
 
1292
        except NotImplementedError:
 
 
1293
            return self.transport
 
 
1294
        raise errors.IncompatibleFormat(branch_format, self._format)
 
 
1296
    def get_repository_transport(self, repository_format):
 
 
1297
        """See BzrDir.get_repository_transport()."""
 
 
1298
        if repository_format is None:
 
 
1299
            return self.transport
 
 
1301
            repository_format.get_format_string()
 
 
1302
        except NotImplementedError:
 
 
1303
            return self.transport
 
 
1304
        raise errors.IncompatibleFormat(repository_format, self._format)
 
 
1306
    def get_workingtree_transport(self, workingtree_format):
 
 
1307
        """See BzrDir.get_workingtree_transport()."""
 
 
1308
        if workingtree_format is None:
 
 
1309
            return self.transport
 
 
1311
            workingtree_format.get_format_string()
 
 
1312
        except NotImplementedError:
 
 
1313
            return self.transport
 
 
1314
        raise errors.IncompatibleFormat(workingtree_format, self._format)
 
 
1316
    def needs_format_conversion(self, format=None):
 
 
1317
        """See BzrDir.needs_format_conversion()."""
 
 
1318
        # if the format is not the same as the system default,
 
 
1319
        # an upgrade is needed.
 
 
1321
            format = BzrDirFormat.get_default_format()
 
 
1322
        return not isinstance(self._format, format.__class__)
 
 
1324
    def open_branch(self, unsupported=False):
 
 
1325
        """See BzrDir.open_branch."""
 
 
1326
        from bzrlib.branch import BzrBranchFormat4
 
 
1327
        format = BzrBranchFormat4()
 
 
1328
        self._check_supported(format, unsupported)
 
 
1329
        return format.open(self, _found=True)
 
 
1331
    def sprout(self, url, revision_id=None, force_new_repo=False,
 
 
1332
               possible_transports=None, accelerator_tree=None,
 
 
1333
               hardlink=False, stacked=False):
 
 
1334
        """See BzrDir.sprout()."""
 
 
1336
            raise errors.UnstackableBranchFormat(
 
 
1337
                self._format, self.root_transport.base)
 
 
1338
        from bzrlib.workingtree import WorkingTreeFormat2
 
 
1339
        self._make_tail(url)
 
 
1340
        result = self._format._initialize_for_clone(url)
 
 
1342
            self.open_repository().clone(result, revision_id=revision_id)
 
 
1343
        except errors.NoRepositoryPresent:
 
 
1346
            self.open_branch().sprout(result, revision_id=revision_id)
 
 
1347
        except errors.NotBranchError:
 
 
1349
        # we always want a working tree
 
 
1350
        WorkingTreeFormat2().initialize(result,
 
 
1351
                                        accelerator_tree=accelerator_tree,
 
 
1356
class BzrDir4(BzrDirPreSplitOut):
 
 
1357
    """A .bzr version 4 control object.
 
 
1359
    This is a deprecated format and may be removed after sept 2006.
 
 
1362
    def create_repository(self, shared=False):
 
 
1363
        """See BzrDir.create_repository."""
 
 
1364
        return self._format.repository_format.initialize(self, shared)
 
 
1366
    def needs_format_conversion(self, format=None):
 
 
1367
        """Format 4 dirs are always in need of conversion."""
 
 
1370
    def open_repository(self):
 
 
1371
        """See BzrDir.open_repository."""
 
 
1372
        from bzrlib.repofmt.weaverepo import RepositoryFormat4
 
 
1373
        return RepositoryFormat4().open(self, _found=True)
 
 
1376
class BzrDir5(BzrDirPreSplitOut):
 
 
1377
    """A .bzr version 5 control object.
 
 
1379
    This is a deprecated format and may be removed after sept 2006.
 
 
1382
    def open_repository(self):
 
 
1383
        """See BzrDir.open_repository."""
 
 
1384
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
 
 
1385
        return RepositoryFormat5().open(self, _found=True)
 
 
1387
    def open_workingtree(self, _unsupported=False,
 
 
1388
            recommend_upgrade=True):
 
 
1389
        """See BzrDir.create_workingtree."""
 
 
1390
        from bzrlib.workingtree import WorkingTreeFormat2
 
 
1391
        wt_format = WorkingTreeFormat2()
 
 
1392
        # we don't warn here about upgrades; that ought to be handled for the
 
 
1394
        return wt_format.open(self, _found=True)
 
 
1397
class BzrDir6(BzrDirPreSplitOut):
 
 
1398
    """A .bzr version 6 control object.
 
 
1400
    This is a deprecated format and may be removed after sept 2006.
 
 
1403
    def open_repository(self):
 
 
1404
        """See BzrDir.open_repository."""
 
 
1405
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
 
 
1406
        return RepositoryFormat6().open(self, _found=True)
 
 
1408
    def open_workingtree(self, _unsupported=False,
 
 
1409
        recommend_upgrade=True):
 
 
1410
        """See BzrDir.create_workingtree."""
 
 
1411
        # we don't warn here about upgrades; that ought to be handled for the
 
 
1413
        from bzrlib.workingtree import WorkingTreeFormat2
 
 
1414
        return WorkingTreeFormat2().open(self, _found=True)
 
 
1417
class BzrDirMeta1(BzrDir):
 
 
1418
    """A .bzr meta version 1 control object.
 
 
1420
    This is the first control object where the 
 
 
1421
    individual aspects are really split out: there are separate repository,
 
 
1422
    workingtree and branch subdirectories and any subset of the three can be
 
 
1423
    present within a BzrDir.
 
 
1426
    def can_convert_format(self):
 
 
1427
        """See BzrDir.can_convert_format()."""
 
 
1430
    def create_branch(self):
 
 
1431
        """See BzrDir.create_branch."""
 
 
1432
        return self._format.get_branch_format().initialize(self)
 
 
1434
    def destroy_branch(self):
 
 
1435
        """See BzrDir.create_branch."""
 
 
1436
        self.transport.delete_tree('branch')
 
 
1438
    def create_repository(self, shared=False):
 
 
1439
        """See BzrDir.create_repository."""
 
 
1440
        return self._format.repository_format.initialize(self, shared)
 
 
1442
    def destroy_repository(self):
 
 
1443
        """See BzrDir.destroy_repository."""
 
 
1444
        self.transport.delete_tree('repository')
 
 
1446
    def create_workingtree(self, revision_id=None, from_branch=None,
 
 
1447
                           accelerator_tree=None, hardlink=False):
 
 
1448
        """See BzrDir.create_workingtree."""
 
 
1449
        return self._format.workingtree_format.initialize(
 
 
1450
            self, revision_id, from_branch=from_branch,
 
 
1451
            accelerator_tree=accelerator_tree, hardlink=hardlink)
 
 
1453
    def destroy_workingtree(self):
 
 
1454
        """See BzrDir.destroy_workingtree."""
 
 
1455
        wt = self.open_workingtree(recommend_upgrade=False)
 
 
1456
        repository = wt.branch.repository
 
 
1457
        empty = repository.revision_tree(_mod_revision.NULL_REVISION)
 
 
1458
        wt.revert(old_tree=empty)
 
 
1459
        self.destroy_workingtree_metadata()
 
 
1461
    def destroy_workingtree_metadata(self):
 
 
1462
        self.transport.delete_tree('checkout')
 
 
1464
    def find_branch_format(self):
 
 
1465
        """Find the branch 'format' for this bzrdir.
 
 
1467
        This might be a synthetic object for e.g. RemoteBranch and SVN.
 
 
1469
        from bzrlib.branch import BranchFormat
 
 
1470
        return BranchFormat.find_format(self)
 
 
1472
    def _get_mkdir_mode(self):
 
 
1473
        """Figure out the mode to use when creating a bzrdir subdir."""
 
 
1474
        temp_control = lockable_files.LockableFiles(self.transport, '',
 
 
1475
                                     lockable_files.TransportLock)
 
 
1476
        return temp_control._dir_mode
 
 
1478
    def get_branch_reference(self):
 
 
1479
        """See BzrDir.get_branch_reference()."""
 
 
1480
        from bzrlib.branch import BranchFormat
 
 
1481
        format = BranchFormat.find_format(self)
 
 
1482
        return format.get_reference(self)
 
 
1484
    def get_branch_transport(self, branch_format):
 
 
1485
        """See BzrDir.get_branch_transport()."""
 
 
1486
        if branch_format is None:
 
 
1487
            return self.transport.clone('branch')
 
 
1489
            branch_format.get_format_string()
 
 
1490
        except NotImplementedError:
 
 
1491
            raise errors.IncompatibleFormat(branch_format, self._format)
 
 
1493
            self.transport.mkdir('branch', mode=self._get_mkdir_mode())
 
 
1494
        except errors.FileExists:
 
 
1496
        return self.transport.clone('branch')
 
 
1498
    def get_repository_transport(self, repository_format):
 
 
1499
        """See BzrDir.get_repository_transport()."""
 
 
1500
        if repository_format is None:
 
 
1501
            return self.transport.clone('repository')
 
 
1503
            repository_format.get_format_string()
 
 
1504
        except NotImplementedError:
 
 
1505
            raise errors.IncompatibleFormat(repository_format, self._format)
 
 
1507
            self.transport.mkdir('repository', mode=self._get_mkdir_mode())
 
 
1508
        except errors.FileExists:
 
 
1510
        return self.transport.clone('repository')
 
 
1512
    def get_workingtree_transport(self, workingtree_format):
 
 
1513
        """See BzrDir.get_workingtree_transport()."""
 
 
1514
        if workingtree_format is None:
 
 
1515
            return self.transport.clone('checkout')
 
 
1517
            workingtree_format.get_format_string()
 
 
1518
        except NotImplementedError:
 
 
1519
            raise errors.IncompatibleFormat(workingtree_format, self._format)
 
 
1521
            self.transport.mkdir('checkout', mode=self._get_mkdir_mode())
 
 
1522
        except errors.FileExists:
 
 
1524
        return self.transport.clone('checkout')
 
 
1526
    def needs_format_conversion(self, format=None):
 
 
1527
        """See BzrDir.needs_format_conversion()."""
 
 
1529
            format = BzrDirFormat.get_default_format()
 
 
1530
        if not isinstance(self._format, format.__class__):
 
 
1531
            # it is not a meta dir format, conversion is needed.
 
 
1533
        # we might want to push this down to the repository?
 
 
1535
            if not isinstance(self.open_repository()._format,
 
 
1536
                              format.repository_format.__class__):
 
 
1537
                # the repository needs an upgrade.
 
 
1539
        except errors.NoRepositoryPresent:
 
 
1542
            if not isinstance(self.open_branch()._format,
 
 
1543
                              format.get_branch_format().__class__):
 
 
1544
                # the branch needs an upgrade.
 
 
1546
        except errors.NotBranchError:
 
 
1549
            my_wt = self.open_workingtree(recommend_upgrade=False)
 
 
1550
            if not isinstance(my_wt._format,
 
 
1551
                              format.workingtree_format.__class__):
 
 
1552
                # the workingtree needs an upgrade.
 
 
1554
        except (errors.NoWorkingTree, errors.NotLocalUrl):
 
 
1558
    def open_branch(self, unsupported=False):
 
 
1559
        """See BzrDir.open_branch."""
 
 
1560
        format = self.find_branch_format()
 
 
1561
        self._check_supported(format, unsupported)
 
 
1562
        return format.open(self, _found=True)
 
 
1564
    def open_repository(self, unsupported=False):
 
 
1565
        """See BzrDir.open_repository."""
 
 
1566
        from bzrlib.repository import RepositoryFormat
 
 
1567
        format = RepositoryFormat.find_format(self)
 
 
1568
        self._check_supported(format, unsupported)
 
 
1569
        return format.open(self, _found=True)
 
 
1571
    def open_workingtree(self, unsupported=False,
 
 
1572
            recommend_upgrade=True):
 
 
1573
        """See BzrDir.open_workingtree."""
 
 
1574
        from bzrlib.workingtree import WorkingTreeFormat
 
 
1575
        format = WorkingTreeFormat.find_format(self)
 
 
1576
        self._check_supported(format, unsupported,
 
 
1578
            basedir=self.root_transport.base)
 
 
1579
        return format.open(self, _found=True)
 
 
1581
    def _get_config(self):
 
 
1582
        return config.BzrDirConfig(self.transport)
 
 
1585
class BzrDirFormat(object):
 
 
1586
    """An encapsulation of the initialization and open routines for a format.
 
 
1588
    Formats provide three things:
 
 
1589
     * An initialization routine,
 
 
1593
    Formats are placed in a dict by their format string for reference 
 
 
1594
    during bzrdir opening. These should be subclasses of BzrDirFormat
 
 
1597
    Once a format is deprecated, just deprecate the initialize and open
 
 
1598
    methods on the format class. Do not deprecate the object, as the 
 
 
1599
    object will be created every system load.
 
 
1602
    _default_format = None
 
 
1603
    """The default format used for new .bzr dirs."""
 
 
1606
    """The known formats."""
 
 
1608
    _control_formats = []
 
 
1609
    """The registered control formats - .bzr, ....
 
 
1611
    This is a list of BzrDirFormat objects.
 
 
1614
    _control_server_formats = []
 
 
1615
    """The registered control server formats, e.g. RemoteBzrDirs.
 
 
1617
    This is a list of BzrDirFormat objects.
 
 
1620
    _lock_file_name = 'branch-lock'
 
 
1622
    # _lock_class must be set in subclasses to the lock type, typ.
 
 
1623
    # TransportLock or LockDir
 
 
1626
    def find_format(klass, transport, _server_formats=True):
 
 
1627
        """Return the format present at transport."""
 
 
1629
            formats = klass._control_server_formats + klass._control_formats
 
 
1631
            formats = klass._control_formats
 
 
1632
        for format in formats:
 
 
1634
                return format.probe_transport(transport)
 
 
1635
            except errors.NotBranchError:
 
 
1636
                # this format does not find a control dir here.
 
 
1638
        raise errors.NotBranchError(path=transport.base)
 
 
1641
    def probe_transport(klass, transport):
 
 
1642
        """Return the .bzrdir style format present in a directory."""
 
 
1644
            format_string = transport.get(".bzr/branch-format").read()
 
 
1645
        except errors.NoSuchFile:
 
 
1646
            raise errors.NotBranchError(path=transport.base)
 
 
1649
            return klass._formats[format_string]
 
 
1651
            raise errors.UnknownFormatError(format=format_string, kind='bzrdir')
 
 
1654
    def get_default_format(klass):
 
 
1655
        """Return the current default format."""
 
 
1656
        return klass._default_format
 
 
1658
    def get_format_string(self):
 
 
1659
        """Return the ASCII format string that identifies this format."""
 
 
1660
        raise NotImplementedError(self.get_format_string)
 
 
1662
    def get_format_description(self):
 
 
1663
        """Return the short description for this format."""
 
 
1664
        raise NotImplementedError(self.get_format_description)
 
 
1666
    def get_converter(self, format=None):
 
 
1667
        """Return the converter to use to convert bzrdirs needing converts.
 
 
1669
        This returns a bzrlib.bzrdir.Converter object.
 
 
1671
        This should return the best upgrader to step this format towards the
 
 
1672
        current default format. In the case of plugins we can/should provide
 
 
1673
        some means for them to extend the range of returnable converters.
 
 
1675
        :param format: Optional format to override the default format of the 
 
 
1678
        raise NotImplementedError(self.get_converter)
 
 
1680
    def initialize(self, url, possible_transports=None):
 
 
1681
        """Create a bzr control dir at this url and return an opened copy.
 
 
1683
        Subclasses should typically override initialize_on_transport
 
 
1684
        instead of this method.
 
 
1686
        return self.initialize_on_transport(get_transport(url,
 
 
1687
                                                          possible_transports))
 
 
1689
    def initialize_on_transport(self, transport):
 
 
1690
        """Initialize a new bzrdir in the base directory of a Transport."""
 
 
1691
        # Since we don't have a .bzr directory, inherit the
 
 
1692
        # mode from the root directory
 
 
1693
        temp_control = lockable_files.LockableFiles(transport,
 
 
1694
                            '', lockable_files.TransportLock)
 
 
1695
        temp_control._transport.mkdir('.bzr',
 
 
1696
                                      # FIXME: RBC 20060121 don't peek under
 
 
1698
                                      mode=temp_control._dir_mode)
 
 
1699
        if sys.platform == 'win32' and isinstance(transport, local.LocalTransport):
 
 
1700
            win32utils.set_file_attr_hidden(transport._abspath('.bzr'))
 
 
1701
        file_mode = temp_control._file_mode
 
 
1703
        bzrdir_transport = transport.clone('.bzr')
 
 
1704
        utf8_files = [('README',
 
 
1705
                       "This is a Bazaar control directory.\n"
 
 
1706
                       "Do not change any files in this directory.\n"
 
 
1707
                       "See http://bazaar-vcs.org/ for more information about Bazaar.\n"),
 
 
1708
                      ('branch-format', self.get_format_string()),
 
 
1710
        # NB: no need to escape relative paths that are url safe.
 
 
1711
        control_files = lockable_files.LockableFiles(bzrdir_transport,
 
 
1712
            self._lock_file_name, self._lock_class)
 
 
1713
        control_files.create_lock()
 
 
1714
        control_files.lock_write()
 
 
1716
            for (filename, content) in utf8_files:
 
 
1717
                bzrdir_transport.put_bytes(filename, content,
 
 
1720
            control_files.unlock()
 
 
1721
        return self.open(transport, _found=True)
 
 
1723
    def is_supported(self):
 
 
1724
        """Is this format supported?
 
 
1726
        Supported formats must be initializable and openable.
 
 
1727
        Unsupported formats may not support initialization or committing or 
 
 
1728
        some other features depending on the reason for not being supported.
 
 
1732
    def same_model(self, target_format):
 
 
1733
        return (self.repository_format.rich_root_data == 
 
 
1734
            target_format.rich_root_data)
 
 
1737
    def known_formats(klass):
 
 
1738
        """Return all the known formats.
 
 
1740
        Concrete formats should override _known_formats.
 
 
1742
        # There is double indirection here to make sure that control 
 
 
1743
        # formats used by more than one dir format will only be probed 
 
 
1744
        # once. This can otherwise be quite expensive for remote connections.
 
 
1746
        for format in klass._control_formats:
 
 
1747
            result.update(format._known_formats())
 
 
1751
    def _known_formats(klass):
 
 
1752
        """Return the known format instances for this control format."""
 
 
1753
        return set(klass._formats.values())
 
 
1755
    def open(self, transport, _found=False):
 
 
1756
        """Return an instance of this format for the dir transport points at.
 
 
1758
        _found is a private parameter, do not use it.
 
 
1761
            found_format = BzrDirFormat.find_format(transport)
 
 
1762
            if not isinstance(found_format, self.__class__):
 
 
1763
                raise AssertionError("%s was asked to open %s, but it seems to need "
 
 
1765
                        % (self, transport, found_format))
 
 
1766
        return self._open(transport)
 
 
1768
    def _open(self, transport):
 
 
1769
        """Template method helper for opening BzrDirectories.
 
 
1771
        This performs the actual open and any additional logic or parameter
 
 
1774
        raise NotImplementedError(self._open)
 
 
1777
    def register_format(klass, format):
 
 
1778
        klass._formats[format.get_format_string()] = format
 
 
1781
    def register_control_format(klass, format):
 
 
1782
        """Register a format that does not use '.bzr' for its control dir.
 
 
1784
        TODO: This should be pulled up into a 'ControlDirFormat' base class
 
 
1785
        which BzrDirFormat can inherit from, and renamed to register_format 
 
 
1786
        there. It has been done without that for now for simplicity of
 
 
1789
        klass._control_formats.append(format)
 
 
1792
    def register_control_server_format(klass, format):
 
 
1793
        """Register a control format for client-server environments.
 
 
1795
        These formats will be tried before ones registered with
 
 
1796
        register_control_format.  This gives implementations that decide to the
 
 
1797
        chance to grab it before anything looks at the contents of the format
 
 
1800
        klass._control_server_formats.append(format)
 
 
1803
    def _set_default_format(klass, format):
 
 
1804
        """Set default format (for testing behavior of defaults only)"""
 
 
1805
        klass._default_format = format
 
 
1809
        return self.get_format_string().rstrip()
 
 
1812
    def unregister_format(klass, format):
 
 
1813
        del klass._formats[format.get_format_string()]
 
 
1816
    def unregister_control_format(klass, format):
 
 
1817
        klass._control_formats.remove(format)
 
 
1820
class BzrDirFormat4(BzrDirFormat):
 
 
1821
    """Bzr dir format 4.
 
 
1823
    This format is a combined format for working tree, branch and repository.
 
 
1825
     - Format 1 working trees [always]
 
 
1826
     - Format 4 branches [always]
 
 
1827
     - Format 4 repositories [always]
 
 
1829
    This format is deprecated: it indexes texts using a text it which is
 
 
1830
    removed in format 5; write support for this format has been removed.
 
 
1833
    _lock_class = lockable_files.TransportLock
 
 
1835
    def get_format_string(self):
 
 
1836
        """See BzrDirFormat.get_format_string()."""
 
 
1837
        return "Bazaar-NG branch, format 0.0.4\n"
 
 
1839
    def get_format_description(self):
 
 
1840
        """See BzrDirFormat.get_format_description()."""
 
 
1841
        return "All-in-one format 4"
 
 
1843
    def get_converter(self, format=None):
 
 
1844
        """See BzrDirFormat.get_converter()."""
 
 
1845
        # there is one and only one upgrade path here.
 
 
1846
        return ConvertBzrDir4To5()
 
 
1848
    def initialize_on_transport(self, transport):
 
 
1849
        """Format 4 branches cannot be created."""
 
 
1850
        raise errors.UninitializableFormat(self)
 
 
1852
    def is_supported(self):
 
 
1853
        """Format 4 is not supported.
 
 
1855
        It is not supported because the model changed from 4 to 5 and the
 
 
1856
        conversion logic is expensive - so doing it on the fly was not 
 
 
1861
    def _open(self, transport):
 
 
1862
        """See BzrDirFormat._open."""
 
 
1863
        return BzrDir4(transport, self)
 
 
1865
    def __return_repository_format(self):
 
 
1866
        """Circular import protection."""
 
 
1867
        from bzrlib.repofmt.weaverepo import RepositoryFormat4
 
 
1868
        return RepositoryFormat4()
 
 
1869
    repository_format = property(__return_repository_format)
 
 
1872
class BzrDirFormat5(BzrDirFormat):
 
 
1873
    """Bzr control format 5.
 
 
1875
    This format is a combined format for working tree, branch and repository.
 
 
1877
     - Format 2 working trees [always] 
 
 
1878
     - Format 4 branches [always] 
 
 
1879
     - Format 5 repositories [always]
 
 
1880
       Unhashed stores in the repository.
 
 
1883
    _lock_class = lockable_files.TransportLock
 
 
1885
    def get_format_string(self):
 
 
1886
        """See BzrDirFormat.get_format_string()."""
 
 
1887
        return "Bazaar-NG branch, format 5\n"
 
 
1889
    def get_branch_format(self):
 
 
1890
        from bzrlib import branch
 
 
1891
        return branch.BzrBranchFormat4()
 
 
1893
    def get_format_description(self):
 
 
1894
        """See BzrDirFormat.get_format_description()."""
 
 
1895
        return "All-in-one format 5"
 
 
1897
    def get_converter(self, format=None):
 
 
1898
        """See BzrDirFormat.get_converter()."""
 
 
1899
        # there is one and only one upgrade path here.
 
 
1900
        return ConvertBzrDir5To6()
 
 
1902
    def _initialize_for_clone(self, url):
 
 
1903
        return self.initialize_on_transport(get_transport(url), _cloning=True)
 
 
1905
    def initialize_on_transport(self, transport, _cloning=False):
 
 
1906
        """Format 5 dirs always have working tree, branch and repository.
 
 
1908
        Except when they are being cloned.
 
 
1910
        from bzrlib.branch import BzrBranchFormat4
 
 
1911
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
 
 
1912
        result = (super(BzrDirFormat5, self).initialize_on_transport(transport))
 
 
1913
        RepositoryFormat5().initialize(result, _internal=True)
 
 
1915
            branch = BzrBranchFormat4().initialize(result)
 
 
1916
            result._init_workingtree()
 
 
1919
    def _open(self, transport):
 
 
1920
        """See BzrDirFormat._open."""
 
 
1921
        return BzrDir5(transport, self)
 
 
1923
    def __return_repository_format(self):
 
 
1924
        """Circular import protection."""
 
 
1925
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
 
 
1926
        return RepositoryFormat5()
 
 
1927
    repository_format = property(__return_repository_format)
 
 
1930
class BzrDirFormat6(BzrDirFormat):
 
 
1931
    """Bzr control format 6.
 
 
1933
    This format is a combined format for working tree, branch and repository.
 
 
1935
     - Format 2 working trees [always] 
 
 
1936
     - Format 4 branches [always] 
 
 
1937
     - Format 6 repositories [always]
 
 
1940
    _lock_class = lockable_files.TransportLock
 
 
1942
    def get_format_string(self):
 
 
1943
        """See BzrDirFormat.get_format_string()."""
 
 
1944
        return "Bazaar-NG branch, format 6\n"
 
 
1946
    def get_format_description(self):
 
 
1947
        """See BzrDirFormat.get_format_description()."""
 
 
1948
        return "All-in-one format 6"
 
 
1950
    def get_branch_format(self):
 
 
1951
        from bzrlib import branch
 
 
1952
        return branch.BzrBranchFormat4()
 
 
1954
    def get_converter(self, format=None):
 
 
1955
        """See BzrDirFormat.get_converter()."""
 
 
1956
        # there is one and only one upgrade path here.
 
 
1957
        return ConvertBzrDir6ToMeta()
 
 
1959
    def _initialize_for_clone(self, url):
 
 
1960
        return self.initialize_on_transport(get_transport(url), _cloning=True)
 
 
1962
    def initialize_on_transport(self, transport, _cloning=False):
 
 
1963
        """Format 6 dirs always have working tree, branch and repository.
 
 
1965
        Except when they are being cloned.
 
 
1967
        from bzrlib.branch import BzrBranchFormat4
 
 
1968
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
 
 
1969
        result = super(BzrDirFormat6, self).initialize_on_transport(transport)
 
 
1970
        RepositoryFormat6().initialize(result, _internal=True)
 
 
1972
            branch = BzrBranchFormat4().initialize(result)
 
 
1973
            result._init_workingtree()
 
 
1976
    def _open(self, transport):
 
 
1977
        """See BzrDirFormat._open."""
 
 
1978
        return BzrDir6(transport, self)
 
 
1980
    def __return_repository_format(self):
 
 
1981
        """Circular import protection."""
 
 
1982
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
 
 
1983
        return RepositoryFormat6()
 
 
1984
    repository_format = property(__return_repository_format)
 
 
1987
class BzrDirMetaFormat1(BzrDirFormat):
 
 
1988
    """Bzr meta control format 1
 
 
1990
    This is the first format with split out working tree, branch and repository
 
 
1993
     - Format 3 working trees [optional]
 
 
1994
     - Format 5 branches [optional]
 
 
1995
     - Format 7 repositories [optional]
 
 
1998
    _lock_class = lockdir.LockDir
 
 
2001
        self._workingtree_format = None
 
 
2002
        self._branch_format = None
 
 
2004
    def __eq__(self, other):
 
 
2005
        if other.__class__ is not self.__class__:
 
 
2007
        if other.repository_format != self.repository_format:
 
 
2009
        if other.workingtree_format != self.workingtree_format:
 
 
2013
    def __ne__(self, other):
 
 
2014
        return not self == other
 
 
2016
    def get_branch_format(self):
 
 
2017
        if self._branch_format is None:
 
 
2018
            from bzrlib.branch import BranchFormat
 
 
2019
            self._branch_format = BranchFormat.get_default_format()
 
 
2020
        return self._branch_format
 
 
2022
    def set_branch_format(self, format):
 
 
2023
        self._branch_format = format
 
 
2025
    def get_converter(self, format=None):
 
 
2026
        """See BzrDirFormat.get_converter()."""
 
 
2028
            format = BzrDirFormat.get_default_format()
 
 
2029
        if not isinstance(self, format.__class__):
 
 
2030
            # converting away from metadir is not implemented
 
 
2031
            raise NotImplementedError(self.get_converter)
 
 
2032
        return ConvertMetaToMeta(format)
 
 
2034
    def get_format_string(self):
 
 
2035
        """See BzrDirFormat.get_format_string()."""
 
 
2036
        return "Bazaar-NG meta directory, format 1\n"
 
 
2038
    def get_format_description(self):
 
 
2039
        """See BzrDirFormat.get_format_description()."""
 
 
2040
        return "Meta directory format 1"
 
 
2042
    def _open(self, transport):
 
 
2043
        """See BzrDirFormat._open."""
 
 
2044
        return BzrDirMeta1(transport, self)
 
 
2046
    def __return_repository_format(self):
 
 
2047
        """Circular import protection."""
 
 
2048
        if getattr(self, '_repository_format', None):
 
 
2049
            return self._repository_format
 
 
2050
        from bzrlib.repository import RepositoryFormat
 
 
2051
        return RepositoryFormat.get_default_format()
 
 
2053
    def __set_repository_format(self, value):
 
 
2054
        """Allow changing the repository format for metadir formats."""
 
 
2055
        self._repository_format = value
 
 
2057
    repository_format = property(__return_repository_format, __set_repository_format)
 
 
2059
    def __get_workingtree_format(self):
 
 
2060
        if self._workingtree_format is None:
 
 
2061
            from bzrlib.workingtree import WorkingTreeFormat
 
 
2062
            self._workingtree_format = WorkingTreeFormat.get_default_format()
 
 
2063
        return self._workingtree_format
 
 
2065
    def __set_workingtree_format(self, wt_format):
 
 
2066
        self._workingtree_format = wt_format
 
 
2068
    workingtree_format = property(__get_workingtree_format,
 
 
2069
                                  __set_workingtree_format)
 
 
2072
# Register bzr control format
 
 
2073
BzrDirFormat.register_control_format(BzrDirFormat)
 
 
2075
# Register bzr formats
 
 
2076
BzrDirFormat.register_format(BzrDirFormat4())
 
 
2077
BzrDirFormat.register_format(BzrDirFormat5())
 
 
2078
BzrDirFormat.register_format(BzrDirFormat6())
 
 
2079
__default_format = BzrDirMetaFormat1()
 
 
2080
BzrDirFormat.register_format(__default_format)
 
 
2081
BzrDirFormat._default_format = __default_format
 
 
2084
class Converter(object):
 
 
2085
    """Converts a disk format object from one format to another."""
 
 
2087
    def convert(self, to_convert, pb):
 
 
2088
        """Perform the conversion of to_convert, giving feedback via pb.
 
 
2090
        :param to_convert: The disk object to convert.
 
 
2091
        :param pb: a progress bar to use for progress information.
 
 
2094
    def step(self, message):
 
 
2095
        """Update the pb by a step."""
 
 
2097
        self.pb.update(message, self.count, self.total)
 
 
2100
class ConvertBzrDir4To5(Converter):
 
 
2101
    """Converts format 4 bzr dirs to format 5."""
 
 
2104
        super(ConvertBzrDir4To5, self).__init__()
 
 
2105
        self.converted_revs = set()
 
 
2106
        self.absent_revisions = set()
 
 
2110
    def convert(self, to_convert, pb):
 
 
2111
        """See Converter.convert()."""
 
 
2112
        self.bzrdir = to_convert
 
 
2114
        self.pb.note('starting upgrade from format 4 to 5')
 
 
2115
        if isinstance(self.bzrdir.transport, local.LocalTransport):
 
 
2116
            self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
 
 
2117
        self._convert_to_weaves()
 
 
2118
        return BzrDir.open(self.bzrdir.root_transport.base)
 
 
2120
    def _convert_to_weaves(self):
 
 
2121
        self.pb.note('note: upgrade may be faster if all store files are ungzipped first')
 
 
2124
            stat = self.bzrdir.transport.stat('weaves')
 
 
2125
            if not S_ISDIR(stat.st_mode):
 
 
2126
                self.bzrdir.transport.delete('weaves')
 
 
2127
                self.bzrdir.transport.mkdir('weaves')
 
 
2128
        except errors.NoSuchFile:
 
 
2129
            self.bzrdir.transport.mkdir('weaves')
 
 
2130
        # deliberately not a WeaveFile as we want to build it up slowly.
 
 
2131
        self.inv_weave = Weave('inventory')
 
 
2132
        # holds in-memory weaves for all files
 
 
2133
        self.text_weaves = {}
 
 
2134
        self.bzrdir.transport.delete('branch-format')
 
 
2135
        self.branch = self.bzrdir.open_branch()
 
 
2136
        self._convert_working_inv()
 
 
2137
        rev_history = self.branch.revision_history()
 
 
2138
        # to_read is a stack holding the revisions we still need to process;
 
 
2139
        # appending to it adds new highest-priority revisions
 
 
2140
        self.known_revisions = set(rev_history)
 
 
2141
        self.to_read = rev_history[-1:]
 
 
2143
            rev_id = self.to_read.pop()
 
 
2144
            if (rev_id not in self.revisions
 
 
2145
                and rev_id not in self.absent_revisions):
 
 
2146
                self._load_one_rev(rev_id)
 
 
2148
        to_import = self._make_order()
 
 
2149
        for i, rev_id in enumerate(to_import):
 
 
2150
            self.pb.update('converting revision', i, len(to_import))
 
 
2151
            self._convert_one_rev(rev_id)
 
 
2153
        self._write_all_weaves()
 
 
2154
        self._write_all_revs()
 
 
2155
        self.pb.note('upgraded to weaves:')
 
 
2156
        self.pb.note('  %6d revisions and inventories', len(self.revisions))
 
 
2157
        self.pb.note('  %6d revisions not present', len(self.absent_revisions))
 
 
2158
        self.pb.note('  %6d texts', self.text_count)
 
 
2159
        self._cleanup_spare_files_after_format4()
 
 
2160
        self.branch._transport.put_bytes(
 
 
2162
            BzrDirFormat5().get_format_string(),
 
 
2163
            mode=self.bzrdir._get_file_mode())
 
 
2165
    def _cleanup_spare_files_after_format4(self):
 
 
2166
        # FIXME working tree upgrade foo.
 
 
2167
        for n in 'merged-patches', 'pending-merged-patches':
 
 
2169
                ## assert os.path.getsize(p) == 0
 
 
2170
                self.bzrdir.transport.delete(n)
 
 
2171
            except errors.NoSuchFile:
 
 
2173
        self.bzrdir.transport.delete_tree('inventory-store')
 
 
2174
        self.bzrdir.transport.delete_tree('text-store')
 
 
2176
    def _convert_working_inv(self):
 
 
2177
        inv = xml4.serializer_v4.read_inventory(
 
 
2178
                self.branch._transport.get('inventory'))
 
 
2179
        new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv, working=True)
 
 
2180
        self.branch._transport.put_bytes('inventory', new_inv_xml,
 
 
2181
            mode=self.bzrdir._get_file_mode())
 
 
2183
    def _write_all_weaves(self):
 
 
2184
        controlweaves = WeaveStore(self.bzrdir.transport, prefixed=False)
 
 
2185
        weave_transport = self.bzrdir.transport.clone('weaves')
 
 
2186
        weaves = WeaveStore(weave_transport, prefixed=False)
 
 
2187
        transaction = WriteTransaction()
 
 
2191
            for file_id, file_weave in self.text_weaves.items():
 
 
2192
                self.pb.update('writing weave', i, len(self.text_weaves))
 
 
2193
                weaves._put_weave(file_id, file_weave, transaction)
 
 
2195
            self.pb.update('inventory', 0, 1)
 
 
2196
            controlweaves._put_weave('inventory', self.inv_weave, transaction)
 
 
2197
            self.pb.update('inventory', 1, 1)
 
 
2201
    def _write_all_revs(self):
 
 
2202
        """Write all revisions out in new form."""
 
 
2203
        self.bzrdir.transport.delete_tree('revision-store')
 
 
2204
        self.bzrdir.transport.mkdir('revision-store')
 
 
2205
        revision_transport = self.bzrdir.transport.clone('revision-store')
 
 
2207
        from bzrlib.xml5 import serializer_v5
 
 
2208
        from bzrlib.repofmt.weaverepo import RevisionTextStore
 
 
2209
        revision_store = RevisionTextStore(revision_transport,
 
 
2210
            serializer_v5, False, versionedfile.PrefixMapper(),
 
 
2211
            lambda:True, lambda:True)
 
 
2213
            for i, rev_id in enumerate(self.converted_revs):
 
 
2214
                self.pb.update('write revision', i, len(self.converted_revs))
 
 
2215
                text = serializer_v5.write_revision_to_string(
 
 
2216
                    self.revisions[rev_id])
 
 
2218
                revision_store.add_lines(key, None, osutils.split_lines(text))
 
 
2222
    def _load_one_rev(self, rev_id):
 
 
2223
        """Load a revision object into memory.
 
 
2225
        Any parents not either loaded or abandoned get queued to be
 
 
2227
        self.pb.update('loading revision',
 
 
2228
                       len(self.revisions),
 
 
2229
                       len(self.known_revisions))
 
 
2230
        if not self.branch.repository.has_revision(rev_id):
 
 
2232
            self.pb.note('revision {%s} not present in branch; '
 
 
2233
                         'will be converted as a ghost',
 
 
2235
            self.absent_revisions.add(rev_id)
 
 
2237
            rev = self.branch.repository.get_revision(rev_id)
 
 
2238
            for parent_id in rev.parent_ids:
 
 
2239
                self.known_revisions.add(parent_id)
 
 
2240
                self.to_read.append(parent_id)
 
 
2241
            self.revisions[rev_id] = rev
 
 
2243
    def _load_old_inventory(self, rev_id):
 
 
2244
        old_inv_xml = self.branch.repository.inventory_store.get(rev_id).read()
 
 
2245
        inv = xml4.serializer_v4.read_inventory_from_string(old_inv_xml)
 
 
2246
        inv.revision_id = rev_id
 
 
2247
        rev = self.revisions[rev_id]
 
 
2250
    def _load_updated_inventory(self, rev_id):
 
 
2251
        inv_xml = self.inv_weave.get_text(rev_id)
 
 
2252
        inv = xml5.serializer_v5.read_inventory_from_string(inv_xml, rev_id)
 
 
2255
    def _convert_one_rev(self, rev_id):
 
 
2256
        """Convert revision and all referenced objects to new format."""
 
 
2257
        rev = self.revisions[rev_id]
 
 
2258
        inv = self._load_old_inventory(rev_id)
 
 
2259
        present_parents = [p for p in rev.parent_ids
 
 
2260
                           if p not in self.absent_revisions]
 
 
2261
        self._convert_revision_contents(rev, inv, present_parents)
 
 
2262
        self._store_new_inv(rev, inv, present_parents)
 
 
2263
        self.converted_revs.add(rev_id)
 
 
2265
    def _store_new_inv(self, rev, inv, present_parents):
 
 
2266
        new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
 
 
2267
        new_inv_sha1 = sha_string(new_inv_xml)
 
 
2268
        self.inv_weave.add_lines(rev.revision_id,
 
 
2270
                                 new_inv_xml.splitlines(True))
 
 
2271
        rev.inventory_sha1 = new_inv_sha1
 
 
2273
    def _convert_revision_contents(self, rev, inv, present_parents):
 
 
2274
        """Convert all the files within a revision.
 
 
2276
        Also upgrade the inventory to refer to the text revision ids."""
 
 
2277
        rev_id = rev.revision_id
 
 
2278
        mutter('converting texts of revision {%s}',
 
 
2280
        parent_invs = map(self._load_updated_inventory, present_parents)
 
 
2281
        entries = inv.iter_entries()
 
 
2283
        for path, ie in entries:
 
 
2284
            self._convert_file_version(rev, ie, parent_invs)
 
 
2286
    def _convert_file_version(self, rev, ie, parent_invs):
 
 
2287
        """Convert one version of one file.
 
 
2289
        The file needs to be added into the weave if it is a merge
 
 
2290
        of >=2 parents or if it's changed from its parent.
 
 
2292
        file_id = ie.file_id
 
 
2293
        rev_id = rev.revision_id
 
 
2294
        w = self.text_weaves.get(file_id)
 
 
2297
            self.text_weaves[file_id] = w
 
 
2298
        text_changed = False
 
 
2299
        parent_candiate_entries = ie.parent_candidates(parent_invs)
 
 
2300
        heads = graph.Graph(self).heads(parent_candiate_entries.keys())
 
 
2301
        # XXX: Note that this is unordered - and this is tolerable because 
 
 
2302
        # the previous code was also unordered.
 
 
2303
        previous_entries = dict((head, parent_candiate_entries[head]) for head
 
 
2305
        self.snapshot_ie(previous_entries, ie, w, rev_id)
 
 
2308
    @symbol_versioning.deprecated_method(symbol_versioning.one_one)
 
 
2309
    def get_parents(self, revision_ids):
 
 
2310
        for revision_id in revision_ids:
 
 
2311
            yield self.revisions[revision_id].parent_ids
 
 
2313
    def get_parent_map(self, revision_ids):
 
 
2314
        """See graph._StackedParentsProvider.get_parent_map"""
 
 
2315
        return dict((revision_id, self.revisions[revision_id])
 
 
2316
                    for revision_id in revision_ids
 
 
2317
                     if revision_id in self.revisions)
 
 
2319
    def snapshot_ie(self, previous_revisions, ie, w, rev_id):
 
 
2320
        # TODO: convert this logic, which is ~= snapshot to
 
 
2321
        # a call to:. This needs the path figured out. rather than a work_tree
 
 
2322
        # a v4 revision_tree can be given, or something that looks enough like
 
 
2323
        # one to give the file content to the entry if it needs it.
 
 
2324
        # and we need something that looks like a weave store for snapshot to 
 
 
2326
        #ie.snapshot(rev, PATH, previous_revisions, REVISION_TREE, InMemoryWeaveStore(self.text_weaves))
 
 
2327
        if len(previous_revisions) == 1:
 
 
2328
            previous_ie = previous_revisions.values()[0]
 
 
2329
            if ie._unchanged(previous_ie):
 
 
2330
                ie.revision = previous_ie.revision
 
 
2333
            text = self.branch.repository._text_store.get(ie.text_id)
 
 
2334
            file_lines = text.readlines()
 
 
2335
            w.add_lines(rev_id, previous_revisions, file_lines)
 
 
2336
            self.text_count += 1
 
 
2338
            w.add_lines(rev_id, previous_revisions, [])
 
 
2339
        ie.revision = rev_id
 
 
2341
    def _make_order(self):
 
 
2342
        """Return a suitable order for importing revisions.
 
 
2344
        The order must be such that an revision is imported after all
 
 
2345
        its (present) parents.
 
 
2347
        todo = set(self.revisions.keys())
 
 
2348
        done = self.absent_revisions.copy()
 
 
2351
            # scan through looking for a revision whose parents
 
 
2353
            for rev_id in sorted(list(todo)):
 
 
2354
                rev = self.revisions[rev_id]
 
 
2355
                parent_ids = set(rev.parent_ids)
 
 
2356
                if parent_ids.issubset(done):
 
 
2357
                    # can take this one now
 
 
2358
                    order.append(rev_id)
 
 
2364
class ConvertBzrDir5To6(Converter):
 
 
2365
    """Converts format 5 bzr dirs to format 6."""
 
 
2367
    def convert(self, to_convert, pb):
 
 
2368
        """See Converter.convert()."""
 
 
2369
        self.bzrdir = to_convert
 
 
2371
        self.pb.note('starting upgrade from format 5 to 6')
 
 
2372
        self._convert_to_prefixed()
 
 
2373
        return BzrDir.open(self.bzrdir.root_transport.base)
 
 
2375
    def _convert_to_prefixed(self):
 
 
2376
        from bzrlib.store import TransportStore
 
 
2377
        self.bzrdir.transport.delete('branch-format')
 
 
2378
        for store_name in ["weaves", "revision-store"]:
 
 
2379
            self.pb.note("adding prefixes to %s" % store_name)
 
 
2380
            store_transport = self.bzrdir.transport.clone(store_name)
 
 
2381
            store = TransportStore(store_transport, prefixed=True)
 
 
2382
            for urlfilename in store_transport.list_dir('.'):
 
 
2383
                filename = urlutils.unescape(urlfilename)
 
 
2384
                if (filename.endswith(".weave") or
 
 
2385
                    filename.endswith(".gz") or
 
 
2386
                    filename.endswith(".sig")):
 
 
2387
                    file_id, suffix = os.path.splitext(filename)
 
 
2391
                new_name = store._mapper.map((file_id,)) + suffix
 
 
2392
                # FIXME keep track of the dirs made RBC 20060121
 
 
2394
                    store_transport.move(filename, new_name)
 
 
2395
                except errors.NoSuchFile: # catches missing dirs strangely enough
 
 
2396
                    store_transport.mkdir(osutils.dirname(new_name))
 
 
2397
                    store_transport.move(filename, new_name)
 
 
2398
        self.bzrdir.transport.put_bytes(
 
 
2400
            BzrDirFormat6().get_format_string(),
 
 
2401
            mode=self.bzrdir._get_file_mode())
 
 
2404
class ConvertBzrDir6ToMeta(Converter):
 
 
2405
    """Converts format 6 bzr dirs to metadirs."""
 
 
2407
    def convert(self, to_convert, pb):
 
 
2408
        """See Converter.convert()."""
 
 
2409
        from bzrlib.repofmt.weaverepo import RepositoryFormat7
 
 
2410
        from bzrlib.branch import BzrBranchFormat5
 
 
2411
        self.bzrdir = to_convert
 
 
2414
        self.total = 20 # the steps we know about
 
 
2415
        self.garbage_inventories = []
 
 
2416
        self.dir_mode = self.bzrdir._get_dir_mode()
 
 
2417
        self.file_mode = self.bzrdir._get_file_mode()
 
 
2419
        self.pb.note('starting upgrade from format 6 to metadir')
 
 
2420
        self.bzrdir.transport.put_bytes(
 
 
2422
                "Converting to format 6",
 
 
2423
                mode=self.file_mode)
 
 
2424
        # its faster to move specific files around than to open and use the apis...
 
 
2425
        # first off, nuke ancestry.weave, it was never used.
 
 
2427
            self.step('Removing ancestry.weave')
 
 
2428
            self.bzrdir.transport.delete('ancestry.weave')
 
 
2429
        except errors.NoSuchFile:
 
 
2431
        # find out whats there
 
 
2432
        self.step('Finding branch files')
 
 
2433
        last_revision = self.bzrdir.open_branch().last_revision()
 
 
2434
        bzrcontents = self.bzrdir.transport.list_dir('.')
 
 
2435
        for name in bzrcontents:
 
 
2436
            if name.startswith('basis-inventory.'):
 
 
2437
                self.garbage_inventories.append(name)
 
 
2438
        # create new directories for repository, working tree and branch
 
 
2439
        repository_names = [('inventory.weave', True),
 
 
2440
                            ('revision-store', True),
 
 
2442
        self.step('Upgrading repository  ')
 
 
2443
        self.bzrdir.transport.mkdir('repository', mode=self.dir_mode)
 
 
2444
        self.make_lock('repository')
 
 
2445
        # we hard code the formats here because we are converting into
 
 
2446
        # the meta format. The meta format upgrader can take this to a 
 
 
2447
        # future format within each component.
 
 
2448
        self.put_format('repository', RepositoryFormat7())
 
 
2449
        for entry in repository_names:
 
 
2450
            self.move_entry('repository', entry)
 
 
2452
        self.step('Upgrading branch      ')
 
 
2453
        self.bzrdir.transport.mkdir('branch', mode=self.dir_mode)
 
 
2454
        self.make_lock('branch')
 
 
2455
        self.put_format('branch', BzrBranchFormat5())
 
 
2456
        branch_files = [('revision-history', True),
 
 
2457
                        ('branch-name', True),
 
 
2459
        for entry in branch_files:
 
 
2460
            self.move_entry('branch', entry)
 
 
2462
        checkout_files = [('pending-merges', True),
 
 
2463
                          ('inventory', True),
 
 
2464
                          ('stat-cache', False)]
 
 
2465
        # If a mandatory checkout file is not present, the branch does not have
 
 
2466
        # a functional checkout. Do not create a checkout in the converted
 
 
2468
        for name, mandatory in checkout_files:
 
 
2469
            if mandatory and name not in bzrcontents:
 
 
2470
                has_checkout = False
 
 
2474
        if not has_checkout:
 
 
2475
            self.pb.note('No working tree.')
 
 
2476
            # If some checkout files are there, we may as well get rid of them.
 
 
2477
            for name, mandatory in checkout_files:
 
 
2478
                if name in bzrcontents:
 
 
2479
                    self.bzrdir.transport.delete(name)
 
 
2481
            from bzrlib.workingtree import WorkingTreeFormat3
 
 
2482
            self.step('Upgrading working tree')
 
 
2483
            self.bzrdir.transport.mkdir('checkout', mode=self.dir_mode)
 
 
2484
            self.make_lock('checkout')
 
 
2486
                'checkout', WorkingTreeFormat3())
 
 
2487
            self.bzrdir.transport.delete_multi(
 
 
2488
                self.garbage_inventories, self.pb)
 
 
2489
            for entry in checkout_files:
 
 
2490
                self.move_entry('checkout', entry)
 
 
2491
            if last_revision is not None:
 
 
2492
                self.bzrdir.transport.put_bytes(
 
 
2493
                    'checkout/last-revision', last_revision)
 
 
2494
        self.bzrdir.transport.put_bytes(
 
 
2496
            BzrDirMetaFormat1().get_format_string(),
 
 
2497
            mode=self.file_mode)
 
 
2498
        return BzrDir.open(self.bzrdir.root_transport.base)
 
 
2500
    def make_lock(self, name):
 
 
2501
        """Make a lock for the new control dir name."""
 
 
2502
        self.step('Make %s lock' % name)
 
 
2503
        ld = lockdir.LockDir(self.bzrdir.transport,
 
 
2505
                             file_modebits=self.file_mode,
 
 
2506
                             dir_modebits=self.dir_mode)
 
 
2509
    def move_entry(self, new_dir, entry):
 
 
2510
        """Move then entry name into new_dir."""
 
 
2512
        mandatory = entry[1]
 
 
2513
        self.step('Moving %s' % name)
 
 
2515
            self.bzrdir.transport.move(name, '%s/%s' % (new_dir, name))
 
 
2516
        except errors.NoSuchFile:
 
 
2520
    def put_format(self, dirname, format):
 
 
2521
        self.bzrdir.transport.put_bytes('%s/format' % dirname,
 
 
2522
            format.get_format_string(),
 
 
2526
class ConvertMetaToMeta(Converter):
 
 
2527
    """Converts the components of metadirs."""
 
 
2529
    def __init__(self, target_format):
 
 
2530
        """Create a metadir to metadir converter.
 
 
2532
        :param target_format: The final metadir format that is desired.
 
 
2534
        self.target_format = target_format
 
 
2536
    def convert(self, to_convert, pb):
 
 
2537
        """See Converter.convert()."""
 
 
2538
        self.bzrdir = to_convert
 
 
2542
        self.step('checking repository format')
 
 
2544
            repo = self.bzrdir.open_repository()
 
 
2545
        except errors.NoRepositoryPresent:
 
 
2548
            if not isinstance(repo._format, self.target_format.repository_format.__class__):
 
 
2549
                from bzrlib.repository import CopyConverter
 
 
2550
                self.pb.note('starting repository conversion')
 
 
2551
                converter = CopyConverter(self.target_format.repository_format)
 
 
2552
                converter.convert(repo, pb)
 
 
2554
            branch = self.bzrdir.open_branch()
 
 
2555
        except errors.NotBranchError:
 
 
2558
            # TODO: conversions of Branch and Tree should be done by
 
 
2559
            # InterXFormat lookups/some sort of registry.
 
 
2560
            # Avoid circular imports
 
 
2561
            from bzrlib import branch as _mod_branch
 
 
2562
            old = branch._format.__class__
 
 
2563
            new = self.target_format.get_branch_format().__class__
 
 
2565
                if (old == _mod_branch.BzrBranchFormat5 and
 
 
2566
                    new in (_mod_branch.BzrBranchFormat6,
 
 
2567
                        _mod_branch.BzrBranchFormat7)):
 
 
2568
                    branch_converter = _mod_branch.Converter5to6()
 
 
2569
                elif (old == _mod_branch.BzrBranchFormat6 and
 
 
2570
                    new == _mod_branch.BzrBranchFormat7):
 
 
2571
                    branch_converter = _mod_branch.Converter6to7()
 
 
2573
                    raise errors.BadConversionTarget("No converter", new)
 
 
2574
                branch_converter.convert(branch)
 
 
2575
                branch = self.bzrdir.open_branch()
 
 
2576
                old = branch._format.__class__
 
 
2578
            tree = self.bzrdir.open_workingtree(recommend_upgrade=False)
 
 
2579
        except (errors.NoWorkingTree, errors.NotLocalUrl):
 
 
2582
            # TODO: conversions of Branch and Tree should be done by
 
 
2583
            # InterXFormat lookups
 
 
2584
            if (isinstance(tree, workingtree.WorkingTree3) and
 
 
2585
                not isinstance(tree, workingtree_4.WorkingTree4) and
 
 
2586
                isinstance(self.target_format.workingtree_format,
 
 
2587
                    workingtree_4.WorkingTreeFormat4)):
 
 
2588
                workingtree_4.Converter3to4().convert(tree)
 
 
2592
# This is not in remote.py because it's small, and needs to be registered.
 
 
2593
# Putting it in remote.py creates a circular import problem.
 
 
2594
# we can make it a lazy object if the control formats is turned into something
 
 
2596
class RemoteBzrDirFormat(BzrDirMetaFormat1):
 
 
2597
    """Format representing bzrdirs accessed via a smart server"""
 
 
2599
    def get_format_description(self):
 
 
2600
        return 'bzr remote bzrdir'
 
 
2603
    def probe_transport(klass, transport):
 
 
2604
        """Return a RemoteBzrDirFormat object if it looks possible."""
 
 
2606
            medium = transport.get_smart_medium()
 
 
2607
        except (NotImplementedError, AttributeError,
 
 
2608
                errors.TransportNotPossible, errors.NoSmartMedium,
 
 
2609
                errors.SmartProtocolError):
 
 
2610
            # no smart server, so not a branch for this format type.
 
 
2611
            raise errors.NotBranchError(path=transport.base)
 
 
2613
            # Decline to open it if the server doesn't support our required
 
 
2614
            # version (3) so that the VFS-based transport will do it.
 
 
2615
            if medium.should_probe():
 
 
2617
                    server_version = medium.protocol_version()
 
 
2618
                except errors.SmartProtocolError:
 
 
2619
                    # Apparently there's no usable smart server there, even though
 
 
2620
                    # the medium supports the smart protocol.
 
 
2621
                    raise errors.NotBranchError(path=transport.base)
 
 
2622
                if server_version != '2':
 
 
2623
                    raise errors.NotBranchError(path=transport.base)
 
 
2626
    def initialize_on_transport(self, transport):
 
 
2628
            # hand off the request to the smart server
 
 
2629
            client_medium = transport.get_smart_medium()
 
 
2630
        except errors.NoSmartMedium:
 
 
2631
            # TODO: lookup the local format from a server hint.
 
 
2632
            local_dir_format = BzrDirMetaFormat1()
 
 
2633
            return local_dir_format.initialize_on_transport(transport)
 
 
2634
        client = _SmartClient(client_medium)
 
 
2635
        path = client.remote_path_from_transport(transport)
 
 
2636
        response = client.call('BzrDirFormat.initialize', path)
 
 
2637
        if response[0] != 'ok':
 
 
2638
            raise errors.SmartProtocolError('unexpected response code %s' % (response,))
 
 
2639
        return remote.RemoteBzrDir(transport)
 
 
2641
    def _open(self, transport):
 
 
2642
        return remote.RemoteBzrDir(transport)
 
 
2644
    def __eq__(self, other):
 
 
2645
        if not isinstance(other, RemoteBzrDirFormat):
 
 
2647
        return self.get_format_description() == other.get_format_description()
 
 
2650
BzrDirFormat.register_control_server_format(RemoteBzrDirFormat)
 
 
2653
class BzrDirFormatInfo(object):
 
 
2655
    def __init__(self, native, deprecated, hidden, experimental):
 
 
2656
        self.deprecated = deprecated
 
 
2657
        self.native = native
 
 
2658
        self.hidden = hidden
 
 
2659
        self.experimental = experimental
 
 
2662
class BzrDirFormatRegistry(registry.Registry):
 
 
2663
    """Registry of user-selectable BzrDir subformats.
 
 
2665
    Differs from BzrDirFormat._control_formats in that it provides sub-formats,
 
 
2666
    e.g. BzrDirMeta1 with weave repository.  Also, it's more user-oriented.
 
 
2670
        """Create a BzrDirFormatRegistry."""
 
 
2671
        self._aliases = set()
 
 
2672
        super(BzrDirFormatRegistry, self).__init__()
 
 
2675
        """Return a set of the format names which are aliases."""
 
 
2676
        return frozenset(self._aliases)
 
 
2678
    def register_metadir(self, key,
 
 
2679
             repository_format, help, native=True, deprecated=False,
 
 
2685
        """Register a metadir subformat.
 
 
2687
        These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
 
 
2688
        by the Repository format.
 
 
2690
        :param repository_format: The fully-qualified repository format class
 
 
2692
        :param branch_format: Fully-qualified branch format class name as
 
 
2694
        :param tree_format: Fully-qualified tree format class name as
 
 
2697
        # This should be expanded to support setting WorkingTree and Branch
 
 
2698
        # formats, once BzrDirMetaFormat1 supports that.
 
 
2699
        def _load(full_name):
 
 
2700
            mod_name, factory_name = full_name.rsplit('.', 1)
 
 
2702
                mod = __import__(mod_name, globals(), locals(),
 
 
2704
            except ImportError, e:
 
 
2705
                raise ImportError('failed to load %s: %s' % (full_name, e))
 
 
2707
                factory = getattr(mod, factory_name)
 
 
2708
            except AttributeError:
 
 
2709
                raise AttributeError('no factory %s in module %r'
 
 
2714
            bd = BzrDirMetaFormat1()
 
 
2715
            if branch_format is not None:
 
 
2716
                bd.set_branch_format(_load(branch_format))
 
 
2717
            if tree_format is not None:
 
 
2718
                bd.workingtree_format = _load(tree_format)
 
 
2719
            if repository_format is not None:
 
 
2720
                bd.repository_format = _load(repository_format)
 
 
2722
        self.register(key, helper, help, native, deprecated, hidden,
 
 
2723
            experimental, alias)
 
 
2725
    def register(self, key, factory, help, native=True, deprecated=False,
 
 
2726
                 hidden=False, experimental=False, alias=False):
 
 
2727
        """Register a BzrDirFormat factory.
 
 
2729
        The factory must be a callable that takes one parameter: the key.
 
 
2730
        It must produce an instance of the BzrDirFormat when called.
 
 
2732
        This function mainly exists to prevent the info object from being
 
 
2735
        registry.Registry.register(self, key, factory, help,
 
 
2736
            BzrDirFormatInfo(native, deprecated, hidden, experimental))
 
 
2738
            self._aliases.add(key)
 
 
2740
    def register_lazy(self, key, module_name, member_name, help, native=True,
 
 
2741
        deprecated=False, hidden=False, experimental=False, alias=False):
 
 
2742
        registry.Registry.register_lazy(self, key, module_name, member_name,
 
 
2743
            help, BzrDirFormatInfo(native, deprecated, hidden, experimental))
 
 
2745
            self._aliases.add(key)
 
 
2747
    def set_default(self, key):
 
 
2748
        """Set the 'default' key to be a clone of the supplied key.
 
 
2750
        This method must be called once and only once.
 
 
2752
        registry.Registry.register(self, 'default', self.get(key),
 
 
2753
            self.get_help(key), info=self.get_info(key))
 
 
2754
        self._aliases.add('default')
 
 
2756
    def set_default_repository(self, key):
 
 
2757
        """Set the FormatRegistry default and Repository default.
 
 
2759
        This is a transitional method while Repository.set_default_format
 
 
2762
        if 'default' in self:
 
 
2763
            self.remove('default')
 
 
2764
        self.set_default(key)
 
 
2765
        format = self.get('default')()
 
 
2767
    def make_bzrdir(self, key):
 
 
2768
        return self.get(key)()
 
 
2770
    def help_topic(self, topic):
 
 
2771
        output = textwrap.dedent("""\
 
 
2772
            These formats can be used for creating branches, working trees, and
 
 
2776
        default_realkey = None
 
 
2777
        default_help = self.get_help('default')
 
 
2779
        for key in self.keys():
 
 
2780
            if key == 'default':
 
 
2782
            help = self.get_help(key)
 
 
2783
            if help == default_help:
 
 
2784
                default_realkey = key
 
 
2786
                help_pairs.append((key, help))
 
 
2788
        def wrapped(key, help, info):
 
 
2790
                help = '(native) ' + help
 
 
2791
            return ':%s:\n%s\n\n' % (key, 
 
 
2792
                    textwrap.fill(help, initial_indent='    ', 
 
 
2793
                    subsequent_indent='    '))
 
 
2794
        if default_realkey is not None:
 
 
2795
            output += wrapped(default_realkey, '(default) %s' % default_help,
 
 
2796
                              self.get_info('default'))
 
 
2797
        deprecated_pairs = []
 
 
2798
        experimental_pairs = []
 
 
2799
        for key, help in help_pairs:
 
 
2800
            info = self.get_info(key)
 
 
2803
            elif info.deprecated:
 
 
2804
                deprecated_pairs.append((key, help))
 
 
2805
            elif info.experimental:
 
 
2806
                experimental_pairs.append((key, help))
 
 
2808
                output += wrapped(key, help, info)
 
 
2809
        if len(experimental_pairs) > 0:
 
 
2810
            output += "Experimental formats are shown below.\n\n"
 
 
2811
            for key, help in experimental_pairs:
 
 
2812
                info = self.get_info(key)
 
 
2813
                output += wrapped(key, help, info)
 
 
2814
        if len(deprecated_pairs) > 0:
 
 
2815
            output += "Deprecated formats are shown below.\n\n"
 
 
2816
            for key, help in deprecated_pairs:
 
 
2817
                info = self.get_info(key)
 
 
2818
                output += wrapped(key, help, info)
 
 
2823
class RepositoryAcquisitionPolicy(object):
 
 
2824
    """Abstract base class for repository acquisition policies.
 
 
2826
    A repository acquisition policy decides how a BzrDir acquires a repository
 
 
2827
    for a branch that is being created.  The most basic policy decision is
 
 
2828
    whether to create a new repository or use an existing one.
 
 
2830
    def __init__(self, stack_on, stack_on_pwd, require_stacking):
 
 
2833
        :param stack_on: A location to stack on
 
 
2834
        :param stack_on_pwd: If stack_on is relative, the location it is
 
 
2836
        :param require_stacking: If True, it is a failure to not stack.
 
 
2838
        self._stack_on = stack_on
 
 
2839
        self._stack_on_pwd = stack_on_pwd
 
 
2840
        self._require_stacking = require_stacking
 
 
2842
    def configure_branch(self, branch):
 
 
2843
        """Apply any configuration data from this policy to the branch.
 
 
2845
        Default implementation sets repository stacking.
 
 
2847
        if self._stack_on is None:
 
 
2849
        if self._stack_on_pwd is None:
 
 
2850
            stack_on = self._stack_on
 
 
2853
                stack_on = urlutils.rebase_url(self._stack_on,
 
 
2855
                    branch.bzrdir.root_transport.base)
 
 
2856
            except errors.InvalidRebaseURLs:
 
 
2857
                stack_on = self._get_full_stack_on()
 
 
2859
            branch.set_stacked_on_url(stack_on)
 
 
2860
        except errors.UnstackableBranchFormat:
 
 
2861
            if self._require_stacking:
 
 
2864
    def _get_full_stack_on(self):
 
 
2865
        """Get a fully-qualified URL for the stack_on location."""
 
 
2866
        if self._stack_on is None:
 
 
2868
        if self._stack_on_pwd is None:
 
 
2869
            return self._stack_on
 
 
2871
            return urlutils.join(self._stack_on_pwd, self._stack_on)
 
 
2873
    def _add_fallback(self, repository):
 
 
2874
        """Add a fallback to the supplied repository, if stacking is set."""
 
 
2875
        stack_on = self._get_full_stack_on()
 
 
2876
        if stack_on is None:
 
 
2878
        stacked_dir = BzrDir.open(stack_on)
 
 
2880
            stacked_repo = stacked_dir.open_branch().repository
 
 
2881
        except errors.NotBranchError:
 
 
2882
            stacked_repo = stacked_dir.open_repository()
 
 
2884
            repository.add_fallback_repository(stacked_repo)
 
 
2885
        except errors.UnstackableRepositoryFormat:
 
 
2886
            if self._require_stacking:
 
 
2889
    def acquire_repository(self, make_working_trees=None, shared=False):
 
 
2890
        """Acquire a repository for this bzrdir.
 
 
2892
        Implementations may create a new repository or use a pre-exising
 
 
2894
        :param make_working_trees: If creating a repository, set
 
 
2895
            make_working_trees to this value (if non-None)
 
 
2896
        :param shared: If creating a repository, make it shared if True
 
 
2897
        :return: A repository
 
 
2899
        raise NotImplemented(RepositoryAcquisitionPolicy.acquire_repository)
 
 
2902
class CreateRepository(RepositoryAcquisitionPolicy):
 
 
2903
    """A policy of creating a new repository"""
 
 
2905
    def __init__(self, bzrdir, stack_on=None, stack_on_pwd=None,
 
 
2906
                 require_stacking=False):
 
 
2909
        :param bzrdir: The bzrdir to create the repository on.
 
 
2910
        :param stack_on: A location to stack on
 
 
2911
        :param stack_on_pwd: If stack_on is relative, the location it is
 
 
2914
        RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
 
 
2916
        self._bzrdir = bzrdir
 
 
2918
    def acquire_repository(self, make_working_trees=None, shared=False):
 
 
2919
        """Implementation of RepositoryAcquisitionPolicy.acquire_repository
 
 
2921
        Creates the desired repository in the bzrdir we already have.
 
 
2923
        repository = self._bzrdir.create_repository(shared=shared)
 
 
2924
        self._add_fallback(repository)
 
 
2925
        if make_working_trees is not None:
 
 
2926
            repository.set_make_working_trees(make_working_trees)
 
 
2930
class UseExistingRepository(RepositoryAcquisitionPolicy):
 
 
2931
    """A policy of reusing an existing repository"""
 
 
2933
    def __init__(self, repository, stack_on=None, stack_on_pwd=None,
 
 
2934
                 require_stacking=False):
 
 
2937
        :param repository: The repository to use.
 
 
2938
        :param stack_on: A location to stack on
 
 
2939
        :param stack_on_pwd: If stack_on is relative, the location it is
 
 
2942
        RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
 
 
2944
        self._repository = repository
 
 
2946
    def acquire_repository(self, make_working_trees=None, shared=False):
 
 
2947
        """Implementation of RepositoryAcquisitionPolicy.acquire_repository
 
 
2949
        Returns an existing repository to use
 
 
2951
        self._add_fallback(self._repository)
 
 
2952
        return self._repository
 
 
2955
format_registry = BzrDirFormatRegistry()
 
 
2956
format_registry.register('weave', BzrDirFormat6,
 
 
2957
    'Pre-0.8 format.  Slower than knit and does not'
 
 
2958
    ' support checkouts or shared repositories.',
 
 
2960
format_registry.register_metadir('knit',
 
 
2961
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
 
 
2962
    'Format using knits.  Recommended for interoperation with bzr <= 0.14.',
 
 
2963
    branch_format='bzrlib.branch.BzrBranchFormat5',
 
 
2964
    tree_format='bzrlib.workingtree.WorkingTreeFormat3')
 
 
2965
format_registry.register_metadir('metaweave',
 
 
2966
    'bzrlib.repofmt.weaverepo.RepositoryFormat7',
 
 
2967
    'Transitional format in 0.8.  Slower than knit.',
 
 
2968
    branch_format='bzrlib.branch.BzrBranchFormat5',
 
 
2969
    tree_format='bzrlib.workingtree.WorkingTreeFormat3',
 
 
2971
format_registry.register_metadir('dirstate',
 
 
2972
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
 
 
2973
    help='New in 0.15: Fast local operations. Compatible with bzr 0.8 and '
 
 
2974
        'above when accessed over the network.',
 
 
2975
    branch_format='bzrlib.branch.BzrBranchFormat5',
 
 
2976
    # this uses bzrlib.workingtree.WorkingTreeFormat4 because importing
 
 
2977
    # directly from workingtree_4 triggers a circular import.
 
 
2978
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
 
2980
format_registry.register_metadir('dirstate-tags',
 
 
2981
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
 
 
2982
    help='New in 0.15: Fast local operations and improved scaling for '
 
 
2983
        'network operations. Additionally adds support for tags.'
 
 
2984
        ' Incompatible with bzr < 0.15.',
 
 
2985
    branch_format='bzrlib.branch.BzrBranchFormat6',
 
 
2986
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
 
2988
format_registry.register_metadir('rich-root',
 
 
2989
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
 
 
2990
    help='New in 1.0.  Better handling of tree roots.  Incompatible with'
 
 
2992
    branch_format='bzrlib.branch.BzrBranchFormat6',
 
 
2993
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
 
2995
format_registry.register_metadir('dirstate-with-subtree',
 
 
2996
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
 
 
2997
    help='New in 0.15: Fast local operations and improved scaling for '
 
 
2998
        'network operations. Additionally adds support for versioning nested '
 
 
2999
        'bzr branches. Incompatible with bzr < 0.15.',
 
 
3000
    branch_format='bzrlib.branch.BzrBranchFormat6',
 
 
3001
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
 
3005
format_registry.register_metadir('pack-0.92',
 
 
3006
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack1',
 
 
3007
    help='New in 0.92: Pack-based format with data compatible with '
 
 
3008
        'dirstate-tags format repositories. Interoperates with '
 
 
3009
        'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
 
 
3010
        'Previously called knitpack-experimental.  '
 
 
3011
        'For more information, see '
 
 
3012
        'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
 
 
3013
    branch_format='bzrlib.branch.BzrBranchFormat6',
 
 
3014
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
 
3016
format_registry.register_metadir('pack-0.92-subtree',
 
 
3017
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack3',
 
 
3018
    help='New in 0.92: Pack-based format with data compatible with '
 
 
3019
        'dirstate-with-subtree format repositories. Interoperates with '
 
 
3020
        'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
 
 
3021
        'Previously called knitpack-experimental.  '
 
 
3022
        'For more information, see '
 
 
3023
        'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
 
 
3024
    branch_format='bzrlib.branch.BzrBranchFormat6',
 
 
3025
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
 
3029
format_registry.register_metadir('rich-root-pack',
 
 
3030
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
 
 
3031
    help='New in 1.0: Pack-based format with data compatible with '
 
 
3032
        'rich-root format repositories. Incompatible with'
 
 
3034
    branch_format='bzrlib.branch.BzrBranchFormat6',
 
 
3035
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
 
3037
format_registry.register_metadir('1.6',
 
 
3038
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5',
 
 
3039
    help='A branch and pack based repository that supports stacking. ',
 
 
3040
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
 
3041
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
 
3043
format_registry.register_metadir('1.6.1-rich-root',
 
 
3044
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5RichRoot',
 
 
3045
    help='A branch and pack based repository that supports stacking '
 
 
3046
         'and rich root data (needed for bzr-svn). ',
 
 
3047
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
 
3048
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
 
3050
format_registry.register_metadir('1.9',
 
 
3051
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
 
 
3052
    help='A branch and pack based repository that uses btree indexes. ',
 
 
3053
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
 
3054
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
 
3056
format_registry.register_metadir('1.9-rich-root',
 
 
3057
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
 
 
3058
    help='A branch and pack based repository that uses btree indexes '
 
 
3059
         'and rich root data (needed for bzr-svn). ',
 
 
3060
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
 
3061
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
 
3063
# The following two formats should always just be aliases.
 
 
3064
format_registry.register_metadir('development',
 
 
3065
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment2',
 
 
3066
    help='Current development format. Can convert data to and from pack-0.92 '
 
 
3067
        '(and anything compatible with pack-0.92) format repositories. '
 
 
3068
        'Repositories and branches in this format can only be read by bzr.dev. '
 
 
3070
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
 
 
3072
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
 
3073
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
 
3077
format_registry.register_metadir('development-subtree',
 
 
3078
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment2Subtree',
 
 
3079
    help='Current development format, subtree variant. Can convert data to and '
 
 
3080
        'from pack-0.92-subtree (and anything compatible with '
 
 
3081
        'pack-0.92-subtree) format repositories. Repositories and branches in '
 
 
3082
        'this format can only be read by bzr.dev. Please read '
 
 
3083
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
 
 
3085
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
 
3086
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
 
3090
# And the development formats above will have aliased one of the following:
 
 
3091
format_registry.register_metadir('development2',
 
 
3092
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment2',
 
 
3093
    help='1.6.1 with B+Tree based index. '
 
 
3095
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
 
 
3097
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
 
3098
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
 
3102
format_registry.register_metadir('development2-subtree',
 
 
3103
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment2Subtree',
 
 
3104
    help='1.6.1-subtree with B+Tree based index. '
 
 
3106
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
 
 
3108
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
 
3109
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
 
3113
# The current format that is made on 'bzr init'.
 
 
3114
format_registry.set_default('pack-0.92')