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.
 
 
30
from cStringIO import StringIO
 
 
34
from bzrlib.lazy_import import lazy_import
 
 
35
lazy_import(globals(), """
 
 
36
from stat import S_ISDIR
 
 
38
from warnings import warn
 
 
50
    revision as _mod_revision,
 
 
61
from bzrlib.osutils import (
 
 
65
from bzrlib.repository import Repository
 
 
66
from bzrlib.smart.client import _SmartClient
 
 
67
from bzrlib.smart import protocol
 
 
68
from bzrlib.store.versioned import WeaveStore
 
 
69
from bzrlib.transactions import WriteTransaction
 
 
70
from bzrlib.transport import (
 
 
71
    do_catching_redirections,
 
 
74
from bzrlib.weave import Weave
 
 
77
from bzrlib.trace import (
 
 
81
from bzrlib.transport.local import LocalTransport
 
 
82
from bzrlib.symbol_versioning import (
 
 
89
    """A .bzr control diretory.
 
 
91
    BzrDir instances let you create or open any of the things that can be
 
 
92
    found within .bzr - checkouts, branches and repositories.
 
 
95
        the transport which this bzr dir is rooted at (i.e. file:///.../.bzr/)
 
 
97
        a transport connected to the directory this bzr was opened from
 
 
98
        (i.e. the parent directory holding the .bzr directory).
 
 
100
    Everything in the bzrdir should have the same file permissions.
 
 
103
    def break_lock(self):
 
 
104
        """Invoke break_lock on the first object in the bzrdir.
 
 
106
        If there is a tree, the tree is opened and break_lock() called.
 
 
107
        Otherwise, branch is tried, and finally repository.
 
 
109
        # XXX: This seems more like a UI function than something that really
 
 
110
        # belongs in this class.
 
 
112
            thing_to_unlock = self.open_workingtree()
 
 
113
        except (errors.NotLocalUrl, errors.NoWorkingTree):
 
 
115
                thing_to_unlock = self.open_branch()
 
 
116
            except errors.NotBranchError:
 
 
118
                    thing_to_unlock = self.open_repository()
 
 
119
                except errors.NoRepositoryPresent:
 
 
121
        thing_to_unlock.break_lock()
 
 
123
    def can_convert_format(self):
 
 
124
        """Return true if this bzrdir is one whose format we can convert from."""
 
 
127
    def check_conversion_target(self, target_format):
 
 
128
        target_repo_format = target_format.repository_format
 
 
129
        source_repo_format = self._format.repository_format
 
 
130
        source_repo_format.check_conversion_target(target_repo_format)
 
 
133
    def _check_supported(format, allow_unsupported,
 
 
134
        recommend_upgrade=True,
 
 
136
        """Give an error or warning on old formats.
 
 
138
        :param format: may be any kind of format - workingtree, branch, 
 
 
141
        :param allow_unsupported: If true, allow opening 
 
 
142
        formats that are strongly deprecated, and which may 
 
 
143
        have limited functionality.
 
 
145
        :param recommend_upgrade: If true (default), warn
 
 
146
        the user through the ui object that they may wish
 
 
147
        to upgrade the object.
 
 
149
        # TODO: perhaps move this into a base Format class; it's not BzrDir
 
 
150
        # specific. mbp 20070323
 
 
151
        if not allow_unsupported and not format.is_supported():
 
 
152
            # see open_downlevel to open legacy branches.
 
 
153
            raise errors.UnsupportedFormatError(format=format)
 
 
154
        if recommend_upgrade \
 
 
155
            and getattr(format, 'upgrade_recommended', False):
 
 
156
            ui.ui_factory.recommend_upgrade(
 
 
157
                format.get_format_description(),
 
 
160
    def clone(self, url, revision_id=None, force_new_repo=False,
 
 
161
              preserve_stacking=False):
 
 
162
        """Clone this bzrdir and its contents to url verbatim.
 
 
164
        :param url: The url create the clone at.  If url's last component does
 
 
165
            not exist, it will be created.
 
 
166
        :param revision_id: The tip revision-id to use for any branch or
 
 
167
            working tree.  If not None, then the clone operation may tune
 
 
168
            itself to download less data.
 
 
169
        :param force_new_repo: Do not use a shared repository for the target
 
 
170
                               even if one is available.
 
 
171
        :param preserve_stacking: When cloning a stacked branch, stack the
 
 
172
            new branch on top of the other branch's stacked-on branch.
 
 
174
        return self.clone_on_transport(get_transport(url),
 
 
175
                                       revision_id=revision_id,
 
 
176
                                       force_new_repo=force_new_repo,
 
 
177
                                       preserve_stacking=preserve_stacking)
 
 
179
    def clone_on_transport(self, transport, revision_id=None,
 
 
180
                           force_new_repo=False, preserve_stacking=False):
 
 
181
        """Clone this bzrdir and its contents to transport verbatim.
 
 
183
        :param transport: The transport for the location to produce the clone
 
 
184
            at.  If the target directory does not exist, it will be created.
 
 
185
        :param revision_id: The tip revision-id to use for any branch or
 
 
186
            working tree.  If not None, then the clone operation may tune
 
 
187
            itself to download less data.
 
 
188
        :param force_new_repo: Do not use a shared repository for the target,
 
 
189
                               even if one is available.
 
 
190
        :param preserve_stacking: When cloning a stacked branch, stack the
 
 
191
            new branch on top of the other branch's stacked-on branch.
 
 
193
        transport.ensure_base()
 
 
194
        result = self.cloning_metadir().initialize_on_transport(transport)
 
 
195
        repository_policy = None
 
 
198
            local_repo = self.find_repository()
 
 
199
        except errors.NoRepositoryPresent:
 
 
202
            local_branch = self.open_branch()
 
 
203
        except errors.NotBranchError:
 
 
206
            # enable fallbacks when branch is not a branch reference
 
 
207
            if local_branch.repository.has_same_location(local_repo):
 
 
208
                local_repo = local_branch.repository
 
 
209
            if preserve_stacking:
 
 
211
                    stack_on = local_branch.get_stacked_on_url()
 
 
212
                except (errors.UnstackableBranchFormat,
 
 
213
                        errors.UnstackableRepositoryFormat,
 
 
218
            # may need to copy content in
 
 
219
            repository_policy = result.determine_repository_policy(
 
 
220
                force_new_repo, stack_on, self.root_transport.base)
 
 
221
            make_working_trees = local_repo.make_working_trees()
 
 
222
            result_repo = repository_policy.acquire_repository(
 
 
223
                make_working_trees, local_repo.is_shared())
 
 
224
            result_repo.fetch(local_repo, revision_id=revision_id)
 
 
227
        # 1 if there is a branch present
 
 
228
        #   make sure its content is available in the target repository
 
 
230
        if local_branch is not None:
 
 
231
            result_branch = local_branch.clone(result, revision_id=revision_id)
 
 
232
            if repository_policy is not None:
 
 
233
                repository_policy.configure_branch(result_branch)
 
 
234
        if result_repo is None or result_repo.make_working_trees():
 
 
236
                self.open_workingtree().clone(result)
 
 
237
            except (errors.NoWorkingTree, errors.NotLocalUrl):
 
 
241
    # TODO: This should be given a Transport, and should chdir up; otherwise
 
 
242
    # this will open a new connection.
 
 
243
    def _make_tail(self, url):
 
 
244
        t = get_transport(url)
 
 
248
    def create(cls, base, format=None, possible_transports=None):
 
 
249
        """Create a new BzrDir at the url 'base'.
 
 
251
        :param format: If supplied, the format of branch to create.  If not
 
 
252
            supplied, the default is used.
 
 
253
        :param possible_transports: If supplied, a list of transports that 
 
 
254
            can be reused to share a remote connection.
 
 
256
        if cls is not BzrDir:
 
 
257
            raise AssertionError("BzrDir.create always creates the default"
 
 
258
                " format, not one of %r" % cls)
 
 
259
        t = get_transport(base, possible_transports)
 
 
262
            format = BzrDirFormat.get_default_format()
 
 
263
        return format.initialize_on_transport(t)
 
 
266
    def find_bzrdirs(transport, evaluate=None, list_current=None):
 
 
267
        """Find bzrdirs recursively from current location.
 
 
269
        This is intended primarily as a building block for more sophisticated
 
 
270
        functionality, like finding trees under a directory, or finding
 
 
271
        branches that use a given repository.
 
 
272
        :param evaluate: An optional callable that yields recurse, value,
 
 
273
            where recurse controls whether this bzrdir is recursed into
 
 
274
            and value is the value to yield.  By default, all bzrdirs
 
 
275
            are recursed into, and the return value is the bzrdir.
 
 
276
        :param list_current: if supplied, use this function to list the current
 
 
277
            directory, instead of Transport.list_dir
 
 
278
        :return: a generator of found bzrdirs, or whatever evaluate returns.
 
 
280
        if list_current is None:
 
 
281
            def list_current(transport):
 
 
282
                return transport.list_dir('')
 
 
284
            def evaluate(bzrdir):
 
 
287
        pending = [transport]
 
 
288
        while len(pending) > 0:
 
 
289
            current_transport = pending.pop()
 
 
292
                bzrdir = BzrDir.open_from_transport(current_transport)
 
 
293
            except errors.NotBranchError:
 
 
296
                recurse, value = evaluate(bzrdir)
 
 
299
                subdirs = list_current(current_transport)
 
 
300
            except errors.NoSuchFile:
 
 
303
                for subdir in sorted(subdirs, reverse=True):
 
 
304
                    pending.append(current_transport.clone(subdir))
 
 
307
    def find_branches(transport):
 
 
308
        """Find all branches under a transport.
 
 
310
        This will find all branches below the transport, including branches
 
 
311
        inside other branches.  Where possible, it will use
 
 
312
        Repository.find_branches.
 
 
314
        To list all the branches that use a particular Repository, see
 
 
315
        Repository.find_branches
 
 
317
        def evaluate(bzrdir):
 
 
319
                repository = bzrdir.open_repository()
 
 
320
            except errors.NoRepositoryPresent:
 
 
323
                return False, (None, repository)
 
 
325
                branch = bzrdir.open_branch()
 
 
326
            except errors.NotBranchError:
 
 
327
                return True, (None, None)
 
 
329
                return True, (branch, None)
 
 
331
        for branch, repo in BzrDir.find_bzrdirs(transport, evaluate=evaluate):
 
 
333
                branches.extend(repo.find_branches())
 
 
334
            if branch is not None:
 
 
335
                branches.append(branch)
 
 
338
    def destroy_repository(self):
 
 
339
        """Destroy the repository in this BzrDir"""
 
 
340
        raise NotImplementedError(self.destroy_repository)
 
 
342
    def create_branch(self):
 
 
343
        """Create a branch in this BzrDir.
 
 
345
        The bzrdir's format will control what branch format is created.
 
 
346
        For more control see BranchFormatXX.create(a_bzrdir).
 
 
348
        raise NotImplementedError(self.create_branch)
 
 
350
    def destroy_branch(self):
 
 
351
        """Destroy the branch in this BzrDir"""
 
 
352
        raise NotImplementedError(self.destroy_branch)
 
 
355
    def create_branch_and_repo(base, force_new_repo=False, format=None):
 
 
356
        """Create a new BzrDir, Branch and Repository at the url 'base'.
 
 
358
        This will use the current default BzrDirFormat unless one is
 
 
359
        specified, and use whatever 
 
 
360
        repository format that that uses via bzrdir.create_branch and
 
 
361
        create_repository. If a shared repository is available that is used
 
 
364
        The created Branch object is returned.
 
 
366
        :param base: The URL to create the branch at.
 
 
367
        :param force_new_repo: If True a new repository is always created.
 
 
368
        :param format: If supplied, the format of branch to create.  If not
 
 
369
            supplied, the default is used.
 
 
371
        bzrdir = BzrDir.create(base, format)
 
 
372
        bzrdir._find_or_create_repository(force_new_repo)
 
 
373
        return bzrdir.create_branch()
 
 
375
    def determine_repository_policy(self, force_new_repo=False, stack_on=None,
 
 
376
                                    stack_on_pwd=None, require_stacking=False):
 
 
377
        """Return an object representing a policy to use.
 
 
379
        This controls whether a new repository is created, or a shared
 
 
380
        repository used instead.
 
 
382
        If stack_on is supplied, will not seek a containing shared repo.
 
 
384
        :param force_new_repo: If True, require a new repository to be created.
 
 
385
        :param stack_on: If supplied, the location to stack on.  If not
 
 
386
            supplied, a default_stack_on location may be used.
 
 
387
        :param stack_on_pwd: If stack_on is relative, the location it is
 
 
390
        def repository_policy(found_bzrdir):
 
 
393
            config = found_bzrdir.get_config()
 
 
395
            if config is not None:
 
 
396
                stack_on = config.get_default_stack_on()
 
 
397
                if stack_on is not None:
 
 
398
                    stack_on_pwd = found_bzrdir.root_transport.base
 
 
400
                    note('Using default stacking branch %s at %s', stack_on,
 
 
402
            # does it have a repository ?
 
 
404
                repository = found_bzrdir.open_repository()
 
 
405
            except errors.NoRepositoryPresent:
 
 
408
                if ((found_bzrdir.root_transport.base !=
 
 
409
                     self.root_transport.base) and not repository.is_shared()):
 
 
416
                return UseExistingRepository(repository, stack_on,
 
 
417
                    stack_on_pwd, require_stacking=require_stacking), True
 
 
419
                return CreateRepository(self, stack_on, stack_on_pwd,
 
 
420
                    require_stacking=require_stacking), True
 
 
422
        if not force_new_repo:
 
 
424
                policy = self._find_containing(repository_policy)
 
 
425
                if policy is not None:
 
 
429
                    return UseExistingRepository(self.open_repository(),
 
 
430
                        stack_on, stack_on_pwd,
 
 
431
                        require_stacking=require_stacking)
 
 
432
                except errors.NoRepositoryPresent:
 
 
434
        return CreateRepository(self, stack_on, stack_on_pwd,
 
 
435
                                require_stacking=require_stacking)
 
 
437
    def _find_or_create_repository(self, force_new_repo):
 
 
438
        """Create a new repository if needed, returning the repository."""
 
 
439
        policy = self.determine_repository_policy(force_new_repo)
 
 
440
        return policy.acquire_repository()
 
 
443
    def create_branch_convenience(base, force_new_repo=False,
 
 
444
                                  force_new_tree=None, format=None,
 
 
445
                                  possible_transports=None):
 
 
446
        """Create a new BzrDir, Branch and Repository at the url 'base'.
 
 
448
        This is a convenience function - it will use an existing repository
 
 
449
        if possible, can be told explicitly whether to create a working tree or
 
 
452
        This will use the current default BzrDirFormat unless one is
 
 
453
        specified, and use whatever 
 
 
454
        repository format that that uses via bzrdir.create_branch and
 
 
455
        create_repository. If a shared repository is available that is used
 
 
456
        preferentially. Whatever repository is used, its tree creation policy
 
 
459
        The created Branch object is returned.
 
 
460
        If a working tree cannot be made due to base not being a file:// url,
 
 
461
        no error is raised unless force_new_tree is True, in which case no 
 
 
462
        data is created on disk and NotLocalUrl is raised.
 
 
464
        :param base: The URL to create the branch at.
 
 
465
        :param force_new_repo: If True a new repository is always created.
 
 
466
        :param force_new_tree: If True or False force creation of a tree or 
 
 
467
                               prevent such creation respectively.
 
 
468
        :param format: Override for the bzrdir format to create.
 
 
469
        :param possible_transports: An optional reusable transports list.
 
 
472
            # check for non local urls
 
 
473
            t = get_transport(base, possible_transports)
 
 
474
            if not isinstance(t, LocalTransport):
 
 
475
                raise errors.NotLocalUrl(base)
 
 
476
        bzrdir = BzrDir.create(base, format, possible_transports)
 
 
477
        repo = bzrdir._find_or_create_repository(force_new_repo)
 
 
478
        result = bzrdir.create_branch()
 
 
479
        if force_new_tree or (repo.make_working_trees() and
 
 
480
                              force_new_tree is None):
 
 
482
                bzrdir.create_workingtree()
 
 
483
            except errors.NotLocalUrl:
 
 
488
    def create_standalone_workingtree(base, format=None):
 
 
489
        """Create a new BzrDir, WorkingTree, Branch and Repository at 'base'.
 
 
491
        'base' must be a local path or a file:// url.
 
 
493
        This will use the current default BzrDirFormat unless one is
 
 
494
        specified, and use whatever 
 
 
495
        repository format that that uses for bzrdirformat.create_workingtree,
 
 
496
        create_branch and create_repository.
 
 
498
        :param format: Override for the bzrdir format to create.
 
 
499
        :return: The WorkingTree object.
 
 
501
        t = get_transport(base)
 
 
502
        if not isinstance(t, LocalTransport):
 
 
503
            raise errors.NotLocalUrl(base)
 
 
504
        bzrdir = BzrDir.create_branch_and_repo(base,
 
 
506
                                               format=format).bzrdir
 
 
507
        return bzrdir.create_workingtree()
 
 
509
    def create_workingtree(self, revision_id=None, from_branch=None,
 
 
510
        accelerator_tree=None, hardlink=False):
 
 
511
        """Create a working tree at this BzrDir.
 
 
513
        :param revision_id: create it as of this revision id.
 
 
514
        :param from_branch: override bzrdir branch (for lightweight checkouts)
 
 
515
        :param accelerator_tree: A tree which can be used for retrieving file
 
 
516
            contents more quickly than the revision tree, i.e. a workingtree.
 
 
517
            The revision tree will be used for cases where accelerator_tree's
 
 
518
            content is different.
 
 
520
        raise NotImplementedError(self.create_workingtree)
 
 
522
    def retire_bzrdir(self, limit=10000):
 
 
523
        """Permanently disable the bzrdir.
 
 
525
        This is done by renaming it to give the user some ability to recover
 
 
526
        if there was a problem.
 
 
528
        This will have horrible consequences if anyone has anything locked or
 
 
530
        :param limit: number of times to retry
 
 
535
                to_path = '.bzr.retired.%d' % i
 
 
536
                self.root_transport.rename('.bzr', to_path)
 
 
537
                note("renamed %s to %s"
 
 
538
                    % (self.root_transport.abspath('.bzr'), to_path))
 
 
540
            except (errors.TransportError, IOError, errors.PathError):
 
 
547
    def destroy_workingtree(self):
 
 
548
        """Destroy the working tree at this BzrDir.
 
 
550
        Formats that do not support this may raise UnsupportedOperation.
 
 
552
        raise NotImplementedError(self.destroy_workingtree)
 
 
554
    def destroy_workingtree_metadata(self):
 
 
555
        """Destroy the control files for the working tree at this BzrDir.
 
 
557
        The contents of working tree files are not affected.
 
 
558
        Formats that do not support this may raise UnsupportedOperation.
 
 
560
        raise NotImplementedError(self.destroy_workingtree_metadata)
 
 
562
    def _find_containing(self, evaluate):
 
 
563
        """Find something in a containing control directory.
 
 
565
        This method will scan containing control dirs, until it finds what
 
 
566
        it is looking for, decides that it will never find it, or runs out
 
 
567
        of containing control directories to check.
 
 
569
        It is used to implement find_repository and
 
 
570
        determine_repository_policy.
 
 
572
        :param evaluate: A function returning (value, stop).  If stop is True,
 
 
573
            the value will be returned.
 
 
577
            result, stop = evaluate(found_bzrdir)
 
 
580
            next_transport = found_bzrdir.root_transport.clone('..')
 
 
581
            if (found_bzrdir.root_transport.base == next_transport.base):
 
 
582
                # top of the file system
 
 
584
            # find the next containing bzrdir
 
 
586
                found_bzrdir = BzrDir.open_containing_from_transport(
 
 
588
            except errors.NotBranchError:
 
 
591
    def find_repository(self):
 
 
592
        """Find the repository that should be used.
 
 
594
        This does not require a branch as we use it to find the repo for
 
 
595
        new branches as well as to hook existing branches up to their
 
 
598
        def usable_repository(found_bzrdir):
 
 
599
            # does it have a repository ?
 
 
601
                repository = found_bzrdir.open_repository()
 
 
602
            except errors.NoRepositoryPresent:
 
 
604
            if found_bzrdir.root_transport.base == self.root_transport.base:
 
 
605
                return repository, True
 
 
606
            elif repository.is_shared():
 
 
607
                return repository, True
 
 
611
        found_repo = self._find_containing(usable_repository)
 
 
612
        if found_repo is None:
 
 
613
            raise errors.NoRepositoryPresent(self)
 
 
616
    def get_branch_reference(self):
 
 
617
        """Return the referenced URL for the branch in this bzrdir.
 
 
619
        :raises NotBranchError: If there is no Branch.
 
 
620
        :return: The URL the branch in this bzrdir references if it is a
 
 
621
            reference branch, or None for regular branches.
 
 
625
    def get_branch_transport(self, branch_format):
 
 
626
        """Get the transport for use by branch format in this BzrDir.
 
 
628
        Note that bzr dirs that do not support format strings will raise
 
 
629
        IncompatibleFormat if the branch format they are given has
 
 
630
        a format string, and vice versa.
 
 
632
        If branch_format is None, the transport is returned with no 
 
 
633
        checking. If it is not None, then the returned transport is
 
 
634
        guaranteed to point to an existing directory ready for use.
 
 
636
        raise NotImplementedError(self.get_branch_transport)
 
 
638
    def _find_creation_modes(self):
 
 
639
        """Determine the appropriate modes for files and directories.
 
 
641
        They're always set to be consistent with the base directory,
 
 
642
        assuming that this transport allows setting modes.
 
 
644
        # TODO: Do we need or want an option (maybe a config setting) to turn
 
 
645
        # this off or override it for particular locations? -- mbp 20080512
 
 
646
        if self._mode_check_done:
 
 
648
        self._mode_check_done = True
 
 
650
            st = self.transport.stat('.')
 
 
651
        except errors.TransportNotPossible:
 
 
652
            self._dir_mode = None
 
 
653
            self._file_mode = None
 
 
655
            # Check the directory mode, but also make sure the created
 
 
656
            # directories and files are read-write for this user. This is
 
 
657
            # mostly a workaround for filesystems which lie about being able to
 
 
658
            # write to a directory (cygwin & win32)
 
 
659
            self._dir_mode = (st.st_mode & 07777) | 00700
 
 
660
            # Remove the sticky and execute bits for files
 
 
661
            self._file_mode = self._dir_mode & ~07111
 
 
663
    def _get_file_mode(self):
 
 
664
        """Return Unix mode for newly created files, or None.
 
 
666
        if not self._mode_check_done:
 
 
667
            self._find_creation_modes()
 
 
668
        return self._file_mode
 
 
670
    def _get_dir_mode(self):
 
 
671
        """Return Unix mode for newly created directories, or None.
 
 
673
        if not self._mode_check_done:
 
 
674
            self._find_creation_modes()
 
 
675
        return self._dir_mode
 
 
677
    def get_repository_transport(self, repository_format):
 
 
678
        """Get the transport for use by repository format in this BzrDir.
 
 
680
        Note that bzr dirs that do not support format strings will raise
 
 
681
        IncompatibleFormat if the repository format they are given has
 
 
682
        a format string, and vice versa.
 
 
684
        If repository_format is None, the transport is returned with no 
 
 
685
        checking. If it is not None, then the returned transport is
 
 
686
        guaranteed to point to an existing directory ready for use.
 
 
688
        raise NotImplementedError(self.get_repository_transport)
 
 
690
    def get_workingtree_transport(self, tree_format):
 
 
691
        """Get the transport for use by workingtree format in this BzrDir.
 
 
693
        Note that bzr dirs that do not support format strings will raise
 
 
694
        IncompatibleFormat if the workingtree format they are given has a
 
 
695
        format string, and vice versa.
 
 
697
        If workingtree_format is None, the transport is returned with no 
 
 
698
        checking. If it is not None, then the returned transport is
 
 
699
        guaranteed to point to an existing directory ready for use.
 
 
701
        raise NotImplementedError(self.get_workingtree_transport)
 
 
703
    def get_config(self):
 
 
704
        if getattr(self, '_get_config', None) is None:
 
 
706
        return self._get_config()
 
 
708
    def __init__(self, _transport, _format):
 
 
709
        """Initialize a Bzr control dir object.
 
 
711
        Only really common logic should reside here, concrete classes should be
 
 
712
        made with varying behaviours.
 
 
714
        :param _format: the format that is creating this BzrDir instance.
 
 
715
        :param _transport: the transport this dir is based at.
 
 
717
        self._format = _format
 
 
718
        self.transport = _transport.clone('.bzr')
 
 
719
        self.root_transport = _transport
 
 
720
        self._mode_check_done = False
 
 
722
    def is_control_filename(self, filename):
 
 
723
        """True if filename is the name of a path which is reserved for bzrdir's.
 
 
725
        :param filename: A filename within the root transport of this bzrdir.
 
 
727
        This is true IF and ONLY IF the filename is part of the namespace reserved
 
 
728
        for bzr control dirs. Currently this is the '.bzr' directory in the root
 
 
729
        of the root_transport. it is expected that plugins will need to extend
 
 
730
        this in the future - for instance to make bzr talk with svn working
 
 
733
        # this might be better on the BzrDirFormat class because it refers to 
 
 
734
        # all the possible bzrdir disk formats. 
 
 
735
        # This method is tested via the workingtree is_control_filename tests- 
 
 
736
        # it was extracted from WorkingTree.is_control_filename. If the method's
 
 
737
        # contract is extended beyond the current trivial implementation, please
 
 
738
        # add new tests for it to the appropriate place.
 
 
739
        return filename == '.bzr' or filename.startswith('.bzr/')
 
 
741
    def needs_format_conversion(self, format=None):
 
 
742
        """Return true if this bzrdir needs convert_format run on it.
 
 
744
        For instance, if the repository format is out of date but the 
 
 
745
        branch and working tree are not, this should return True.
 
 
747
        :param format: Optional parameter indicating a specific desired
 
 
748
                       format we plan to arrive at.
 
 
750
        raise NotImplementedError(self.needs_format_conversion)
 
 
753
    def open_unsupported(base):
 
 
754
        """Open a branch which is not supported."""
 
 
755
        return BzrDir.open(base, _unsupported=True)
 
 
758
    def open(base, _unsupported=False, possible_transports=None):
 
 
759
        """Open an existing bzrdir, rooted at 'base' (url).
 
 
761
        :param _unsupported: a private parameter to the BzrDir class.
 
 
763
        t = get_transport(base, possible_transports=possible_transports)
 
 
764
        return BzrDir.open_from_transport(t, _unsupported=_unsupported)
 
 
767
    def open_from_transport(transport, _unsupported=False,
 
 
768
                            _server_formats=True):
 
 
769
        """Open a bzrdir within a particular directory.
 
 
771
        :param transport: Transport containing the bzrdir.
 
 
772
        :param _unsupported: private.
 
 
774
        base = transport.base
 
 
776
        def find_format(transport):
 
 
777
            return transport, BzrDirFormat.find_format(
 
 
778
                transport, _server_formats=_server_formats)
 
 
780
        def redirected(transport, e, redirection_notice):
 
 
781
            qualified_source = e.get_source_url()
 
 
782
            relpath = transport.relpath(qualified_source)
 
 
783
            if not e.target.endswith(relpath):
 
 
784
                # Not redirected to a branch-format, not a branch
 
 
785
                raise errors.NotBranchError(path=e.target)
 
 
786
            target = e.target[:-len(relpath)]
 
 
787
            note('%s is%s redirected to %s',
 
 
788
                 transport.base, e.permanently, target)
 
 
789
            # Let's try with a new transport
 
 
790
            # FIXME: If 'transport' has a qualifier, this should
 
 
791
            # be applied again to the new transport *iff* the
 
 
792
            # schemes used are the same. Uncomment this code
 
 
793
            # once the function (and tests) exist.
 
 
795
            #target = urlutils.copy_url_qualifiers(original, target)
 
 
796
            return get_transport(target)
 
 
799
            transport, format = do_catching_redirections(find_format,
 
 
802
        except errors.TooManyRedirections:
 
 
803
            raise errors.NotBranchError(base)
 
 
805
        BzrDir._check_supported(format, _unsupported)
 
 
806
        return format.open(transport, _found=True)
 
 
808
    def open_branch(self, unsupported=False):
 
 
809
        """Open the branch object at this BzrDir if one is present.
 
 
811
        If unsupported is True, then no longer supported branch formats can
 
 
814
        TODO: static convenience version of this?
 
 
816
        raise NotImplementedError(self.open_branch)
 
 
819
    def open_containing(url, possible_transports=None):
 
 
820
        """Open an existing branch which contains url.
 
 
822
        :param url: url to search from.
 
 
823
        See open_containing_from_transport for more detail.
 
 
825
        transport = get_transport(url, possible_transports)
 
 
826
        return BzrDir.open_containing_from_transport(transport)
 
 
829
    def open_containing_from_transport(a_transport):
 
 
830
        """Open an existing branch which contains a_transport.base.
 
 
832
        This probes for a branch at a_transport, and searches upwards from there.
 
 
834
        Basically we keep looking up until we find the control directory or
 
 
835
        run into the root.  If there isn't one, raises NotBranchError.
 
 
836
        If there is one and it is either an unrecognised format or an unsupported 
 
 
837
        format, UnknownFormatError or UnsupportedFormatError are raised.
 
 
838
        If there is one, it is returned, along with the unused portion of url.
 
 
840
        :return: The BzrDir that contains the path, and a Unicode path 
 
 
841
                for the rest of the URL.
 
 
843
        # this gets the normalised url back. I.e. '.' -> the full path.
 
 
844
        url = a_transport.base
 
 
847
                result = BzrDir.open_from_transport(a_transport)
 
 
848
                return result, urlutils.unescape(a_transport.relpath(url))
 
 
849
            except errors.NotBranchError, e:
 
 
852
                new_t = a_transport.clone('..')
 
 
853
            except errors.InvalidURLJoin:
 
 
854
                # reached the root, whatever that may be
 
 
855
                raise errors.NotBranchError(path=url)
 
 
856
            if new_t.base == a_transport.base:
 
 
857
                # reached the root, whatever that may be
 
 
858
                raise errors.NotBranchError(path=url)
 
 
861
    def _get_tree_branch(self):
 
 
862
        """Return the branch and tree, if any, for this bzrdir.
 
 
864
        Return None for tree if not present or inaccessible.
 
 
865
        Raise NotBranchError if no branch is present.
 
 
866
        :return: (tree, branch)
 
 
869
            tree = self.open_workingtree()
 
 
870
        except (errors.NoWorkingTree, errors.NotLocalUrl):
 
 
872
            branch = self.open_branch()
 
 
878
    def open_tree_or_branch(klass, location):
 
 
879
        """Return the branch and working tree at a location.
 
 
881
        If there is no tree at the location, tree will be None.
 
 
882
        If there is no branch at the location, an exception will be
 
 
884
        :return: (tree, branch)
 
 
886
        bzrdir = klass.open(location)
 
 
887
        return bzrdir._get_tree_branch()
 
 
890
    def open_containing_tree_or_branch(klass, location):
 
 
891
        """Return the branch and working tree contained by a location.
 
 
893
        Returns (tree, branch, relpath).
 
 
894
        If there is no tree at containing the location, tree will be None.
 
 
895
        If there is no branch containing the location, an exception will be
 
 
897
        relpath is the portion of the path that is contained by the branch.
 
 
899
        bzrdir, relpath = klass.open_containing(location)
 
 
900
        tree, branch = bzrdir._get_tree_branch()
 
 
901
        return tree, branch, relpath
 
 
904
    def open_containing_tree_branch_or_repository(klass, location):
 
 
905
        """Return the working tree, branch and repo contained by a location.
 
 
907
        Returns (tree, branch, repository, relpath).
 
 
908
        If there is no tree containing the location, tree will be None.
 
 
909
        If there is no branch containing the location, branch will be None.
 
 
910
        If there is no repository containing the location, repository will be
 
 
912
        relpath is the portion of the path that is contained by the innermost
 
 
915
        If no tree, branch or repository is found, a NotBranchError is raised.
 
 
917
        bzrdir, relpath = klass.open_containing(location)
 
 
919
            tree, branch = bzrdir._get_tree_branch()
 
 
920
        except errors.NotBranchError:
 
 
922
                repo = bzrdir.find_repository()
 
 
923
                return None, None, repo, relpath
 
 
924
            except (errors.NoRepositoryPresent):
 
 
925
                raise errors.NotBranchError(location)
 
 
926
        return tree, branch, branch.repository, relpath
 
 
928
    def open_repository(self, _unsupported=False):
 
 
929
        """Open the repository object at this BzrDir if one is present.
 
 
931
        This will not follow the Branch object pointer - it's strictly a direct
 
 
932
        open facility. Most client code should use open_branch().repository to
 
 
935
        :param _unsupported: a private parameter, not part of the api.
 
 
936
        TODO: static convenience version of this?
 
 
938
        raise NotImplementedError(self.open_repository)
 
 
940
    def open_workingtree(self, _unsupported=False,
 
 
941
                         recommend_upgrade=True, from_branch=None):
 
 
942
        """Open the workingtree object at this BzrDir if one is present.
 
 
944
        :param recommend_upgrade: Optional keyword parameter, when True (the
 
 
945
            default), emit through the ui module a recommendation that the user
 
 
946
            upgrade the working tree when the workingtree being opened is old
 
 
947
            (but still fully supported).
 
 
948
        :param from_branch: override bzrdir branch (for lightweight checkouts)
 
 
950
        raise NotImplementedError(self.open_workingtree)
 
 
952
    def has_branch(self):
 
 
953
        """Tell if this bzrdir contains a branch.
 
 
955
        Note: if you're going to open the branch, you should just go ahead
 
 
956
        and try, and not ask permission first.  (This method just opens the 
 
 
957
        branch and discards it, and that's somewhat expensive.) 
 
 
962
        except errors.NotBranchError:
 
 
965
    def has_workingtree(self):
 
 
966
        """Tell if this bzrdir contains a working tree.
 
 
968
        This will still raise an exception if the bzrdir has a workingtree that
 
 
969
        is remote & inaccessible.
 
 
971
        Note: if you're going to open the working tree, you should just go ahead
 
 
972
        and try, and not ask permission first.  (This method just opens the 
 
 
973
        workingtree and discards it, and that's somewhat expensive.) 
 
 
976
            self.open_workingtree(recommend_upgrade=False)
 
 
978
        except errors.NoWorkingTree:
 
 
981
    def _cloning_metadir(self):
 
 
982
        """Produce a metadir suitable for cloning with.
 
 
984
        :returns: (destination_bzrdir_format, source_repository)
 
 
986
        result_format = self._format.__class__()
 
 
989
                branch = self.open_branch()
 
 
990
                source_repository = branch.repository
 
 
991
            except errors.NotBranchError:
 
 
993
                source_repository = self.open_repository()
 
 
994
        except errors.NoRepositoryPresent:
 
 
995
            source_repository = None
 
 
997
            # XXX TODO: This isinstance is here because we have not implemented
 
 
998
            # the fix recommended in bug # 103195 - to delegate this choice the
 
 
1000
            repo_format = source_repository._format
 
 
1001
            if not isinstance(repo_format, remote.RemoteRepositoryFormat):
 
 
1002
                result_format.repository_format = repo_format
 
 
1004
            # TODO: Couldn't we just probe for the format in these cases,
 
 
1005
            # rather than opening the whole tree?  It would be a little
 
 
1006
            # faster. mbp 20070401
 
 
1007
            tree = self.open_workingtree(recommend_upgrade=False)
 
 
1008
        except (errors.NoWorkingTree, errors.NotLocalUrl):
 
 
1009
            result_format.workingtree_format = None
 
 
1011
            result_format.workingtree_format = tree._format.__class__()
 
 
1012
        return result_format, source_repository
 
 
1014
    def cloning_metadir(self):
 
 
1015
        """Produce a metadir suitable for cloning or sprouting with.
 
 
1017
        These operations may produce workingtrees (yes, even though they're
 
 
1018
        "cloning" something that doesn't have a tree), so a viable workingtree
 
 
1019
        format must be selected.
 
 
1021
        :returns: a BzrDirFormat with all component formats either set
 
 
1022
            appropriately or set to None if that component should not be 
 
 
1025
        format, repository = self._cloning_metadir()
 
 
1026
        if format._workingtree_format is None:
 
 
1027
            if repository is None:
 
 
1029
            tree_format = repository._format._matchingbzrdir.workingtree_format
 
 
1030
            format.workingtree_format = tree_format.__class__()
 
 
1033
    def checkout_metadir(self):
 
 
1034
        return self.cloning_metadir()
 
 
1036
    def sprout(self, url, revision_id=None, force_new_repo=False,
 
 
1037
               recurse='down', possible_transports=None,
 
 
1038
               accelerator_tree=None, hardlink=False, stacked=False):
 
 
1039
        """Create a copy of this bzrdir prepared for use as a new line of
 
 
1042
        If url's last component does not exist, it will be created.
 
 
1044
        Attributes related to the identity of the source branch like
 
 
1045
        branch nickname will be cleaned, a working tree is created
 
 
1046
        whether one existed before or not; and a local branch is always
 
 
1049
        if revision_id is not None, then the clone operation may tune
 
 
1050
            itself to download less data.
 
 
1051
        :param accelerator_tree: A tree which can be used for retrieving file
 
 
1052
            contents more quickly than the revision tree, i.e. a workingtree.
 
 
1053
            The revision tree will be used for cases where accelerator_tree's
 
 
1054
            content is different.
 
 
1055
        :param hardlink: If true, hard-link files from accelerator_tree,
 
 
1057
        :param stacked: If true, create a stacked branch referring to the
 
 
1058
            location of this control directory.
 
 
1060
        target_transport = get_transport(url, possible_transports)
 
 
1061
        target_transport.ensure_base()
 
 
1062
        cloning_format = self.cloning_metadir()
 
 
1063
        result = cloning_format.initialize_on_transport(target_transport)
 
 
1065
            source_branch = self.open_branch()
 
 
1066
            source_repository = source_branch.repository
 
 
1068
                stacked_branch_url = self.root_transport.base
 
 
1070
                # if a stacked branch wasn't requested, we don't create one
 
 
1071
                # even if the origin was stacked
 
 
1072
                stacked_branch_url = None
 
 
1073
        except errors.NotBranchError:
 
 
1074
            source_branch = None
 
 
1076
                source_repository = self.open_repository()
 
 
1077
            except errors.NoRepositoryPresent:
 
 
1078
                source_repository = None
 
 
1079
            stacked_branch_url = None
 
 
1080
        repository_policy = result.determine_repository_policy(
 
 
1081
            force_new_repo, stacked_branch_url, require_stacking=stacked)
 
 
1082
        result_repo = repository_policy.acquire_repository()
 
 
1083
        if source_repository is not None:
 
 
1084
            # XXX: Isn't this redundant with the copy_content_into used below
 
 
1085
            # after creating the branch? -- mbp 20080724
 
 
1086
            result_repo.fetch(source_repository, revision_id=revision_id)
 
 
1088
        # Create/update the result branch
 
 
1089
        format_forced = False
 
 
1091
             or repository_policy._require_stacking 
 
 
1092
             or repository_policy._stack_on)
 
 
1093
            and not result._format.get_branch_format().supports_stacking()):
 
 
1094
            # We need to make a stacked branch, but the default format for the
 
 
1095
            # target doesn't support stacking.  So force a branch that *can*
 
 
1097
            from bzrlib.branch import BzrBranchFormat7
 
 
1098
            format = BzrBranchFormat7()
 
 
1099
            result_branch = format.initialize(result)
 
 
1100
            mutter("using %r for stacking" % (format,))
 
 
1101
            format_forced = True
 
 
1102
        elif source_branch is None:
 
 
1103
            # this is for sprouting a bzrdir without a branch; is that
 
 
1105
            result_branch = result.create_branch()
 
 
1107
            result_branch = source_branch.sprout(
 
 
1108
                result, revision_id=revision_id)
 
 
1109
        mutter("created new branch %r" % (result_branch,))
 
 
1110
        repository_policy.configure_branch(result_branch)
 
 
1111
        if source_branch is not None and format_forced:
 
 
1112
            # XXX: this duplicates Branch.sprout(); it probably belongs on an
 
 
1113
            # InterBranch method? -- mbp 20080724
 
 
1114
            source_branch.copy_content_into(result_branch,
 
 
1115
                 revision_id=revision_id)
 
 
1116
            result_branch.set_parent(self.root_transport.base)
 
 
1118
        # Create/update the result working tree
 
 
1119
        if isinstance(target_transport, LocalTransport) and (
 
 
1120
            result_repo is None or result_repo.make_working_trees()):
 
 
1121
            wt = result.create_workingtree(accelerator_tree=accelerator_tree,
 
 
1125
                if wt.path2id('') is None:
 
 
1127
                        wt.set_root_id(self.open_workingtree.get_root_id())
 
 
1128
                    except errors.NoWorkingTree:
 
 
1134
        if recurse == 'down':
 
 
1136
                basis = wt.basis_tree()
 
 
1138
                subtrees = basis.iter_references()
 
 
1139
            elif source_branch is not None:
 
 
1140
                basis = source_branch.basis_tree()
 
 
1142
                subtrees = basis.iter_references()
 
 
1147
                for path, file_id in subtrees:
 
 
1148
                    target = urlutils.join(url, urlutils.escape(path))
 
 
1149
                    sublocation = source_branch.reference_parent(file_id, path)
 
 
1150
                    sublocation.bzrdir.sprout(target,
 
 
1151
                        basis.get_reference_revision(file_id, path),
 
 
1152
                        force_new_repo=force_new_repo, recurse=recurse,
 
 
1155
                if basis is not None:
 
 
1160
class BzrDirPreSplitOut(BzrDir):
 
 
1161
    """A common class for the all-in-one formats."""
 
 
1163
    def __init__(self, _transport, _format):
 
 
1164
        """See BzrDir.__init__."""
 
 
1165
        super(BzrDirPreSplitOut, self).__init__(_transport, _format)
 
 
1166
        self._control_files = lockable_files.LockableFiles(
 
 
1167
                                            self.get_branch_transport(None),
 
 
1168
                                            self._format._lock_file_name,
 
 
1169
                                            self._format._lock_class)
 
 
1171
    def break_lock(self):
 
 
1172
        """Pre-splitout bzrdirs do not suffer from stale locks."""
 
 
1173
        raise NotImplementedError(self.break_lock)
 
 
1175
    def cloning_metadir(self):
 
 
1176
        """Produce a metadir suitable for cloning with."""
 
 
1177
        return self._format.__class__()
 
 
1179
    def clone(self, url, revision_id=None, force_new_repo=False,
 
 
1180
              preserve_stacking=False):
 
 
1181
        """See BzrDir.clone().
 
 
1183
        force_new_repo has no effect, since this family of formats always
 
 
1184
        require a new repository.
 
 
1185
        preserve_stacking has no effect, since no source branch using this
 
 
1186
        family of formats can be stacked, so there is no stacking to preserve.
 
 
1188
        from bzrlib.workingtree import WorkingTreeFormat2
 
 
1189
        self._make_tail(url)
 
 
1190
        result = self._format._initialize_for_clone(url)
 
 
1191
        self.open_repository().clone(result, revision_id=revision_id)
 
 
1192
        from_branch = self.open_branch()
 
 
1193
        from_branch.clone(result, revision_id=revision_id)
 
 
1195
            self.open_workingtree().clone(result)
 
 
1196
        except errors.NotLocalUrl:
 
 
1197
            # make a new one, this format always has to have one.
 
 
1199
                WorkingTreeFormat2().initialize(result)
 
 
1200
            except errors.NotLocalUrl:
 
 
1201
                # but we cannot do it for remote trees.
 
 
1202
                to_branch = result.open_branch()
 
 
1203
                WorkingTreeFormat2()._stub_initialize_remote(to_branch)
 
 
1206
    def create_branch(self):
 
 
1207
        """See BzrDir.create_branch."""
 
 
1208
        return self.open_branch()
 
 
1210
    def destroy_branch(self):
 
 
1211
        """See BzrDir.destroy_branch."""
 
 
1212
        raise errors.UnsupportedOperation(self.destroy_branch, self)
 
 
1214
    def create_repository(self, shared=False):
 
 
1215
        """See BzrDir.create_repository."""
 
 
1217
            raise errors.IncompatibleFormat('shared repository', self._format)
 
 
1218
        return self.open_repository()
 
 
1220
    def destroy_repository(self):
 
 
1221
        """See BzrDir.destroy_repository."""
 
 
1222
        raise errors.UnsupportedOperation(self.destroy_repository, self)
 
 
1224
    def create_workingtree(self, revision_id=None, from_branch=None,
 
 
1225
                           accelerator_tree=None, hardlink=False):
 
 
1226
        """See BzrDir.create_workingtree."""
 
 
1227
        # this looks buggy but is not -really-
 
 
1228
        # because this format creates the workingtree when the bzrdir is
 
 
1230
        # clone and sprout will have set the revision_id
 
 
1231
        # and that will have set it for us, its only
 
 
1232
        # specific uses of create_workingtree in isolation
 
 
1233
        # that can do wonky stuff here, and that only
 
 
1234
        # happens for creating checkouts, which cannot be 
 
 
1235
        # done on this format anyway. So - acceptable wart.
 
 
1236
        result = self.open_workingtree(recommend_upgrade=False)
 
 
1237
        if revision_id is not None:
 
 
1238
            if revision_id == _mod_revision.NULL_REVISION:
 
 
1239
                result.set_parent_ids([])
 
 
1241
                result.set_parent_ids([revision_id])
 
 
1244
    def destroy_workingtree(self):
 
 
1245
        """See BzrDir.destroy_workingtree."""
 
 
1246
        raise errors.UnsupportedOperation(self.destroy_workingtree, self)
 
 
1248
    def destroy_workingtree_metadata(self):
 
 
1249
        """See BzrDir.destroy_workingtree_metadata."""
 
 
1250
        raise errors.UnsupportedOperation(self.destroy_workingtree_metadata, 
 
 
1253
    def get_branch_transport(self, branch_format):
 
 
1254
        """See BzrDir.get_branch_transport()."""
 
 
1255
        if branch_format is None:
 
 
1256
            return self.transport
 
 
1258
            branch_format.get_format_string()
 
 
1259
        except NotImplementedError:
 
 
1260
            return self.transport
 
 
1261
        raise errors.IncompatibleFormat(branch_format, self._format)
 
 
1263
    def get_repository_transport(self, repository_format):
 
 
1264
        """See BzrDir.get_repository_transport()."""
 
 
1265
        if repository_format is None:
 
 
1266
            return self.transport
 
 
1268
            repository_format.get_format_string()
 
 
1269
        except NotImplementedError:
 
 
1270
            return self.transport
 
 
1271
        raise errors.IncompatibleFormat(repository_format, self._format)
 
 
1273
    def get_workingtree_transport(self, workingtree_format):
 
 
1274
        """See BzrDir.get_workingtree_transport()."""
 
 
1275
        if workingtree_format is None:
 
 
1276
            return self.transport
 
 
1278
            workingtree_format.get_format_string()
 
 
1279
        except NotImplementedError:
 
 
1280
            return self.transport
 
 
1281
        raise errors.IncompatibleFormat(workingtree_format, self._format)
 
 
1283
    def needs_format_conversion(self, format=None):
 
 
1284
        """See BzrDir.needs_format_conversion()."""
 
 
1285
        # if the format is not the same as the system default,
 
 
1286
        # an upgrade is needed.
 
 
1288
            format = BzrDirFormat.get_default_format()
 
 
1289
        return not isinstance(self._format, format.__class__)
 
 
1291
    def open_branch(self, unsupported=False):
 
 
1292
        """See BzrDir.open_branch."""
 
 
1293
        from bzrlib.branch import BzrBranchFormat4
 
 
1294
        format = BzrBranchFormat4()
 
 
1295
        self._check_supported(format, unsupported)
 
 
1296
        return format.open(self, _found=True)
 
 
1298
    def sprout(self, url, revision_id=None, force_new_repo=False,
 
 
1299
               possible_transports=None, accelerator_tree=None,
 
 
1300
               hardlink=False, stacked=False):
 
 
1301
        """See BzrDir.sprout()."""
 
 
1303
            raise errors.UnstackableBranchFormat(
 
 
1304
                self._format, self.root_transport.base)
 
 
1305
        from bzrlib.workingtree import WorkingTreeFormat2
 
 
1306
        self._make_tail(url)
 
 
1307
        result = self._format._initialize_for_clone(url)
 
 
1309
            self.open_repository().clone(result, revision_id=revision_id)
 
 
1310
        except errors.NoRepositoryPresent:
 
 
1313
            self.open_branch().sprout(result, revision_id=revision_id)
 
 
1314
        except errors.NotBranchError:
 
 
1316
        # we always want a working tree
 
 
1317
        WorkingTreeFormat2().initialize(result,
 
 
1318
                                        accelerator_tree=accelerator_tree,
 
 
1323
class BzrDir4(BzrDirPreSplitOut):
 
 
1324
    """A .bzr version 4 control object.
 
 
1326
    This is a deprecated format and may be removed after sept 2006.
 
 
1329
    def create_repository(self, shared=False):
 
 
1330
        """See BzrDir.create_repository."""
 
 
1331
        return self._format.repository_format.initialize(self, shared)
 
 
1333
    def needs_format_conversion(self, format=None):
 
 
1334
        """Format 4 dirs are always in need of conversion."""
 
 
1337
    def open_repository(self):
 
 
1338
        """See BzrDir.open_repository."""
 
 
1339
        from bzrlib.repofmt.weaverepo import RepositoryFormat4
 
 
1340
        return RepositoryFormat4().open(self, _found=True)
 
 
1343
class BzrDir5(BzrDirPreSplitOut):
 
 
1344
    """A .bzr version 5 control object.
 
 
1346
    This is a deprecated format and may be removed after sept 2006.
 
 
1349
    def open_repository(self):
 
 
1350
        """See BzrDir.open_repository."""
 
 
1351
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
 
 
1352
        return RepositoryFormat5().open(self, _found=True)
 
 
1354
    def open_workingtree(self, _unsupported=False,
 
 
1355
            recommend_upgrade=True):
 
 
1356
        """See BzrDir.create_workingtree."""
 
 
1357
        from bzrlib.workingtree import WorkingTreeFormat2
 
 
1358
        wt_format = WorkingTreeFormat2()
 
 
1359
        # we don't warn here about upgrades; that ought to be handled for the
 
 
1361
        return wt_format.open(self, _found=True)
 
 
1364
class BzrDir6(BzrDirPreSplitOut):
 
 
1365
    """A .bzr version 6 control object.
 
 
1367
    This is a deprecated format and may be removed after sept 2006.
 
 
1370
    def open_repository(self):
 
 
1371
        """See BzrDir.open_repository."""
 
 
1372
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
 
 
1373
        return RepositoryFormat6().open(self, _found=True)
 
 
1375
    def open_workingtree(self, _unsupported=False,
 
 
1376
        recommend_upgrade=True):
 
 
1377
        """See BzrDir.create_workingtree."""
 
 
1378
        # we don't warn here about upgrades; that ought to be handled for the
 
 
1380
        from bzrlib.workingtree import WorkingTreeFormat2
 
 
1381
        return WorkingTreeFormat2().open(self, _found=True)
 
 
1384
class BzrDirMeta1(BzrDir):
 
 
1385
    """A .bzr meta version 1 control object.
 
 
1387
    This is the first control object where the 
 
 
1388
    individual aspects are really split out: there are separate repository,
 
 
1389
    workingtree and branch subdirectories and any subset of the three can be
 
 
1390
    present within a BzrDir.
 
 
1393
    def can_convert_format(self):
 
 
1394
        """See BzrDir.can_convert_format()."""
 
 
1397
    def create_branch(self):
 
 
1398
        """See BzrDir.create_branch."""
 
 
1399
        return self._format.get_branch_format().initialize(self)
 
 
1401
    def destroy_branch(self):
 
 
1402
        """See BzrDir.create_branch."""
 
 
1403
        self.transport.delete_tree('branch')
 
 
1405
    def create_repository(self, shared=False):
 
 
1406
        """See BzrDir.create_repository."""
 
 
1407
        return self._format.repository_format.initialize(self, shared)
 
 
1409
    def destroy_repository(self):
 
 
1410
        """See BzrDir.destroy_repository."""
 
 
1411
        self.transport.delete_tree('repository')
 
 
1413
    def create_workingtree(self, revision_id=None, from_branch=None,
 
 
1414
                           accelerator_tree=None, hardlink=False):
 
 
1415
        """See BzrDir.create_workingtree."""
 
 
1416
        return self._format.workingtree_format.initialize(
 
 
1417
            self, revision_id, from_branch=from_branch,
 
 
1418
            accelerator_tree=accelerator_tree, hardlink=hardlink)
 
 
1420
    def destroy_workingtree(self):
 
 
1421
        """See BzrDir.destroy_workingtree."""
 
 
1422
        wt = self.open_workingtree(recommend_upgrade=False)
 
 
1423
        repository = wt.branch.repository
 
 
1424
        empty = repository.revision_tree(_mod_revision.NULL_REVISION)
 
 
1425
        wt.revert(old_tree=empty)
 
 
1426
        self.destroy_workingtree_metadata()
 
 
1428
    def destroy_workingtree_metadata(self):
 
 
1429
        self.transport.delete_tree('checkout')
 
 
1431
    def find_branch_format(self):
 
 
1432
        """Find the branch 'format' for this bzrdir.
 
 
1434
        This might be a synthetic object for e.g. RemoteBranch and SVN.
 
 
1436
        from bzrlib.branch import BranchFormat
 
 
1437
        return BranchFormat.find_format(self)
 
 
1439
    def _get_mkdir_mode(self):
 
 
1440
        """Figure out the mode to use when creating a bzrdir subdir."""
 
 
1441
        temp_control = lockable_files.LockableFiles(self.transport, '',
 
 
1442
                                     lockable_files.TransportLock)
 
 
1443
        return temp_control._dir_mode
 
 
1445
    def get_branch_reference(self):
 
 
1446
        """See BzrDir.get_branch_reference()."""
 
 
1447
        from bzrlib.branch import BranchFormat
 
 
1448
        format = BranchFormat.find_format(self)
 
 
1449
        return format.get_reference(self)
 
 
1451
    def get_branch_transport(self, branch_format):
 
 
1452
        """See BzrDir.get_branch_transport()."""
 
 
1453
        if branch_format is None:
 
 
1454
            return self.transport.clone('branch')
 
 
1456
            branch_format.get_format_string()
 
 
1457
        except NotImplementedError:
 
 
1458
            raise errors.IncompatibleFormat(branch_format, self._format)
 
 
1460
            self.transport.mkdir('branch', mode=self._get_mkdir_mode())
 
 
1461
        except errors.FileExists:
 
 
1463
        return self.transport.clone('branch')
 
 
1465
    def get_repository_transport(self, repository_format):
 
 
1466
        """See BzrDir.get_repository_transport()."""
 
 
1467
        if repository_format is None:
 
 
1468
            return self.transport.clone('repository')
 
 
1470
            repository_format.get_format_string()
 
 
1471
        except NotImplementedError:
 
 
1472
            raise errors.IncompatibleFormat(repository_format, self._format)
 
 
1474
            self.transport.mkdir('repository', mode=self._get_mkdir_mode())
 
 
1475
        except errors.FileExists:
 
 
1477
        return self.transport.clone('repository')
 
 
1479
    def get_workingtree_transport(self, workingtree_format):
 
 
1480
        """See BzrDir.get_workingtree_transport()."""
 
 
1481
        if workingtree_format is None:
 
 
1482
            return self.transport.clone('checkout')
 
 
1484
            workingtree_format.get_format_string()
 
 
1485
        except NotImplementedError:
 
 
1486
            raise errors.IncompatibleFormat(workingtree_format, self._format)
 
 
1488
            self.transport.mkdir('checkout', mode=self._get_mkdir_mode())
 
 
1489
        except errors.FileExists:
 
 
1491
        return self.transport.clone('checkout')
 
 
1493
    def needs_format_conversion(self, format=None):
 
 
1494
        """See BzrDir.needs_format_conversion()."""
 
 
1496
            format = BzrDirFormat.get_default_format()
 
 
1497
        if not isinstance(self._format, format.__class__):
 
 
1498
            # it is not a meta dir format, conversion is needed.
 
 
1500
        # we might want to push this down to the repository?
 
 
1502
            if not isinstance(self.open_repository()._format,
 
 
1503
                              format.repository_format.__class__):
 
 
1504
                # the repository needs an upgrade.
 
 
1506
        except errors.NoRepositoryPresent:
 
 
1509
            if not isinstance(self.open_branch()._format,
 
 
1510
                              format.get_branch_format().__class__):
 
 
1511
                # the branch needs an upgrade.
 
 
1513
        except errors.NotBranchError:
 
 
1516
            my_wt = self.open_workingtree(recommend_upgrade=False)
 
 
1517
            if not isinstance(my_wt._format,
 
 
1518
                              format.workingtree_format.__class__):
 
 
1519
                # the workingtree needs an upgrade.
 
 
1521
        except (errors.NoWorkingTree, errors.NotLocalUrl):
 
 
1525
    def open_branch(self, unsupported=False):
 
 
1526
        """See BzrDir.open_branch."""
 
 
1527
        format = self.find_branch_format()
 
 
1528
        self._check_supported(format, unsupported)
 
 
1529
        return format.open(self, _found=True)
 
 
1531
    def open_repository(self, unsupported=False):
 
 
1532
        """See BzrDir.open_repository."""
 
 
1533
        from bzrlib.repository import RepositoryFormat
 
 
1534
        format = RepositoryFormat.find_format(self)
 
 
1535
        self._check_supported(format, unsupported)
 
 
1536
        return format.open(self, _found=True)
 
 
1538
    def open_workingtree(self, unsupported=False,
 
 
1539
            recommend_upgrade=True):
 
 
1540
        """See BzrDir.open_workingtree."""
 
 
1541
        from bzrlib.workingtree import WorkingTreeFormat
 
 
1542
        format = WorkingTreeFormat.find_format(self)
 
 
1543
        self._check_supported(format, unsupported,
 
 
1545
            basedir=self.root_transport.base)
 
 
1546
        return format.open(self, _found=True)
 
 
1548
    def _get_config(self):
 
 
1549
        return config.BzrDirConfig(self.transport)
 
 
1552
class BzrDirFormat(object):
 
 
1553
    """An encapsulation of the initialization and open routines for a format.
 
 
1555
    Formats provide three things:
 
 
1556
     * An initialization routine,
 
 
1560
    Formats are placed in a dict by their format string for reference 
 
 
1561
    during bzrdir opening. These should be subclasses of BzrDirFormat
 
 
1564
    Once a format is deprecated, just deprecate the initialize and open
 
 
1565
    methods on the format class. Do not deprecate the object, as the 
 
 
1566
    object will be created every system load.
 
 
1569
    _default_format = None
 
 
1570
    """The default format used for new .bzr dirs."""
 
 
1573
    """The known formats."""
 
 
1575
    _control_formats = []
 
 
1576
    """The registered control formats - .bzr, ....
 
 
1578
    This is a list of BzrDirFormat objects.
 
 
1581
    _control_server_formats = []
 
 
1582
    """The registered control server formats, e.g. RemoteBzrDirs.
 
 
1584
    This is a list of BzrDirFormat objects.
 
 
1587
    _lock_file_name = 'branch-lock'
 
 
1589
    # _lock_class must be set in subclasses to the lock type, typ.
 
 
1590
    # TransportLock or LockDir
 
 
1593
    def find_format(klass, transport, _server_formats=True):
 
 
1594
        """Return the format present at transport."""
 
 
1596
            formats = klass._control_server_formats + klass._control_formats
 
 
1598
            formats = klass._control_formats
 
 
1599
        for format in formats:
 
 
1601
                return format.probe_transport(transport)
 
 
1602
            except errors.NotBranchError:
 
 
1603
                # this format does not find a control dir here.
 
 
1605
        raise errors.NotBranchError(path=transport.base)
 
 
1608
    def probe_transport(klass, transport):
 
 
1609
        """Return the .bzrdir style format present in a directory."""
 
 
1611
            format_string = transport.get(".bzr/branch-format").read()
 
 
1612
        except errors.NoSuchFile:
 
 
1613
            raise errors.NotBranchError(path=transport.base)
 
 
1616
            return klass._formats[format_string]
 
 
1618
            raise errors.UnknownFormatError(format=format_string, kind='bzrdir')
 
 
1621
    def get_default_format(klass):
 
 
1622
        """Return the current default format."""
 
 
1623
        return klass._default_format
 
 
1625
    def get_format_string(self):
 
 
1626
        """Return the ASCII format string that identifies this format."""
 
 
1627
        raise NotImplementedError(self.get_format_string)
 
 
1629
    def get_format_description(self):
 
 
1630
        """Return the short description for this format."""
 
 
1631
        raise NotImplementedError(self.get_format_description)
 
 
1633
    def get_converter(self, format=None):
 
 
1634
        """Return the converter to use to convert bzrdirs needing converts.
 
 
1636
        This returns a bzrlib.bzrdir.Converter object.
 
 
1638
        This should return the best upgrader to step this format towards the
 
 
1639
        current default format. In the case of plugins we can/should provide
 
 
1640
        some means for them to extend the range of returnable converters.
 
 
1642
        :param format: Optional format to override the default format of the 
 
 
1645
        raise NotImplementedError(self.get_converter)
 
 
1647
    def initialize(self, url, possible_transports=None):
 
 
1648
        """Create a bzr control dir at this url and return an opened copy.
 
 
1650
        Subclasses should typically override initialize_on_transport
 
 
1651
        instead of this method.
 
 
1653
        return self.initialize_on_transport(get_transport(url,
 
 
1654
                                                          possible_transports))
 
 
1656
    def initialize_on_transport(self, transport):
 
 
1657
        """Initialize a new bzrdir in the base directory of a Transport."""
 
 
1658
        # Since we don't have a .bzr directory, inherit the
 
 
1659
        # mode from the root directory
 
 
1660
        temp_control = lockable_files.LockableFiles(transport,
 
 
1661
                            '', lockable_files.TransportLock)
 
 
1662
        temp_control._transport.mkdir('.bzr',
 
 
1663
                                      # FIXME: RBC 20060121 don't peek under
 
 
1665
                                      mode=temp_control._dir_mode)
 
 
1666
        if sys.platform == 'win32' and isinstance(transport, LocalTransport):
 
 
1667
            win32utils.set_file_attr_hidden(transport._abspath('.bzr'))
 
 
1668
        file_mode = temp_control._file_mode
 
 
1670
        bzrdir_transport = transport.clone('.bzr')
 
 
1671
        utf8_files = [('README',
 
 
1672
                       "This is a Bazaar control directory.\n"
 
 
1673
                       "Do not change any files in this directory.\n"
 
 
1674
                       "See http://bazaar-vcs.org/ for more information about Bazaar.\n"),
 
 
1675
                      ('branch-format', self.get_format_string()),
 
 
1677
        # NB: no need to escape relative paths that are url safe.
 
 
1678
        control_files = lockable_files.LockableFiles(bzrdir_transport,
 
 
1679
            self._lock_file_name, self._lock_class)
 
 
1680
        control_files.create_lock()
 
 
1681
        control_files.lock_write()
 
 
1683
            for (filename, content) in utf8_files:
 
 
1684
                bzrdir_transport.put_bytes(filename, content,
 
 
1687
            control_files.unlock()
 
 
1688
        return self.open(transport, _found=True)
 
 
1690
    def is_supported(self):
 
 
1691
        """Is this format supported?
 
 
1693
        Supported formats must be initializable and openable.
 
 
1694
        Unsupported formats may not support initialization or committing or 
 
 
1695
        some other features depending on the reason for not being supported.
 
 
1699
    def same_model(self, target_format):
 
 
1700
        return (self.repository_format.rich_root_data == 
 
 
1701
            target_format.rich_root_data)
 
 
1704
    def known_formats(klass):
 
 
1705
        """Return all the known formats.
 
 
1707
        Concrete formats should override _known_formats.
 
 
1709
        # There is double indirection here to make sure that control 
 
 
1710
        # formats used by more than one dir format will only be probed 
 
 
1711
        # once. This can otherwise be quite expensive for remote connections.
 
 
1713
        for format in klass._control_formats:
 
 
1714
            result.update(format._known_formats())
 
 
1718
    def _known_formats(klass):
 
 
1719
        """Return the known format instances for this control format."""
 
 
1720
        return set(klass._formats.values())
 
 
1722
    def open(self, transport, _found=False):
 
 
1723
        """Return an instance of this format for the dir transport points at.
 
 
1725
        _found is a private parameter, do not use it.
 
 
1728
            found_format = BzrDirFormat.find_format(transport)
 
 
1729
            if not isinstance(found_format, self.__class__):
 
 
1730
                raise AssertionError("%s was asked to open %s, but it seems to need "
 
 
1732
                        % (self, transport, found_format))
 
 
1733
        return self._open(transport)
 
 
1735
    def _open(self, transport):
 
 
1736
        """Template method helper for opening BzrDirectories.
 
 
1738
        This performs the actual open and any additional logic or parameter
 
 
1741
        raise NotImplementedError(self._open)
 
 
1744
    def register_format(klass, format):
 
 
1745
        klass._formats[format.get_format_string()] = format
 
 
1748
    def register_control_format(klass, format):
 
 
1749
        """Register a format that does not use '.bzr' for its control dir.
 
 
1751
        TODO: This should be pulled up into a 'ControlDirFormat' base class
 
 
1752
        which BzrDirFormat can inherit from, and renamed to register_format 
 
 
1753
        there. It has been done without that for now for simplicity of
 
 
1756
        klass._control_formats.append(format)
 
 
1759
    def register_control_server_format(klass, format):
 
 
1760
        """Register a control format for client-server environments.
 
 
1762
        These formats will be tried before ones registered with
 
 
1763
        register_control_format.  This gives implementations that decide to the
 
 
1764
        chance to grab it before anything looks at the contents of the format
 
 
1767
        klass._control_server_formats.append(format)
 
 
1770
    def _set_default_format(klass, format):
 
 
1771
        """Set default format (for testing behavior of defaults only)"""
 
 
1772
        klass._default_format = format
 
 
1776
        return self.get_format_string().rstrip()
 
 
1779
    def unregister_format(klass, format):
 
 
1780
        del klass._formats[format.get_format_string()]
 
 
1783
    def unregister_control_format(klass, format):
 
 
1784
        klass._control_formats.remove(format)
 
 
1787
class BzrDirFormat4(BzrDirFormat):
 
 
1788
    """Bzr dir format 4.
 
 
1790
    This format is a combined format for working tree, branch and repository.
 
 
1792
     - Format 1 working trees [always]
 
 
1793
     - Format 4 branches [always]
 
 
1794
     - Format 4 repositories [always]
 
 
1796
    This format is deprecated: it indexes texts using a text it which is
 
 
1797
    removed in format 5; write support for this format has been removed.
 
 
1800
    _lock_class = lockable_files.TransportLock
 
 
1802
    def get_format_string(self):
 
 
1803
        """See BzrDirFormat.get_format_string()."""
 
 
1804
        return "Bazaar-NG branch, format 0.0.4\n"
 
 
1806
    def get_format_description(self):
 
 
1807
        """See BzrDirFormat.get_format_description()."""
 
 
1808
        return "All-in-one format 4"
 
 
1810
    def get_converter(self, format=None):
 
 
1811
        """See BzrDirFormat.get_converter()."""
 
 
1812
        # there is one and only one upgrade path here.
 
 
1813
        return ConvertBzrDir4To5()
 
 
1815
    def initialize_on_transport(self, transport):
 
 
1816
        """Format 4 branches cannot be created."""
 
 
1817
        raise errors.UninitializableFormat(self)
 
 
1819
    def is_supported(self):
 
 
1820
        """Format 4 is not supported.
 
 
1822
        It is not supported because the model changed from 4 to 5 and the
 
 
1823
        conversion logic is expensive - so doing it on the fly was not 
 
 
1828
    def _open(self, transport):
 
 
1829
        """See BzrDirFormat._open."""
 
 
1830
        return BzrDir4(transport, self)
 
 
1832
    def __return_repository_format(self):
 
 
1833
        """Circular import protection."""
 
 
1834
        from bzrlib.repofmt.weaverepo import RepositoryFormat4
 
 
1835
        return RepositoryFormat4()
 
 
1836
    repository_format = property(__return_repository_format)
 
 
1839
class BzrDirFormat5(BzrDirFormat):
 
 
1840
    """Bzr control format 5.
 
 
1842
    This format is a combined format for working tree, branch and repository.
 
 
1844
     - Format 2 working trees [always] 
 
 
1845
     - Format 4 branches [always] 
 
 
1846
     - Format 5 repositories [always]
 
 
1847
       Unhashed stores in the repository.
 
 
1850
    _lock_class = lockable_files.TransportLock
 
 
1852
    def get_format_string(self):
 
 
1853
        """See BzrDirFormat.get_format_string()."""
 
 
1854
        return "Bazaar-NG branch, format 5\n"
 
 
1856
    def get_format_description(self):
 
 
1857
        """See BzrDirFormat.get_format_description()."""
 
 
1858
        return "All-in-one format 5"
 
 
1860
    def get_converter(self, format=None):
 
 
1861
        """See BzrDirFormat.get_converter()."""
 
 
1862
        # there is one and only one upgrade path here.
 
 
1863
        return ConvertBzrDir5To6()
 
 
1865
    def _initialize_for_clone(self, url):
 
 
1866
        return self.initialize_on_transport(get_transport(url), _cloning=True)
 
 
1868
    def initialize_on_transport(self, transport, _cloning=False):
 
 
1869
        """Format 5 dirs always have working tree, branch and repository.
 
 
1871
        Except when they are being cloned.
 
 
1873
        from bzrlib.branch import BzrBranchFormat4
 
 
1874
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
 
 
1875
        from bzrlib.workingtree import WorkingTreeFormat2
 
 
1876
        result = (super(BzrDirFormat5, self).initialize_on_transport(transport))
 
 
1877
        RepositoryFormat5().initialize(result, _internal=True)
 
 
1879
            branch = BzrBranchFormat4().initialize(result)
 
 
1881
                WorkingTreeFormat2().initialize(result)
 
 
1882
            except errors.NotLocalUrl:
 
 
1883
                # Even though we can't access the working tree, we need to
 
 
1884
                # create its control files.
 
 
1885
                WorkingTreeFormat2()._stub_initialize_remote(branch)
 
 
1888
    def _open(self, transport):
 
 
1889
        """See BzrDirFormat._open."""
 
 
1890
        return BzrDir5(transport, self)
 
 
1892
    def __return_repository_format(self):
 
 
1893
        """Circular import protection."""
 
 
1894
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
 
 
1895
        return RepositoryFormat5()
 
 
1896
    repository_format = property(__return_repository_format)
 
 
1899
class BzrDirFormat6(BzrDirFormat):
 
 
1900
    """Bzr control format 6.
 
 
1902
    This format is a combined format for working tree, branch and repository.
 
 
1904
     - Format 2 working trees [always] 
 
 
1905
     - Format 4 branches [always] 
 
 
1906
     - Format 6 repositories [always]
 
 
1909
    _lock_class = lockable_files.TransportLock
 
 
1911
    def get_format_string(self):
 
 
1912
        """See BzrDirFormat.get_format_string()."""
 
 
1913
        return "Bazaar-NG branch, format 6\n"
 
 
1915
    def get_format_description(self):
 
 
1916
        """See BzrDirFormat.get_format_description()."""
 
 
1917
        return "All-in-one format 6"
 
 
1919
    def get_converter(self, format=None):
 
 
1920
        """See BzrDirFormat.get_converter()."""
 
 
1921
        # there is one and only one upgrade path here.
 
 
1922
        return ConvertBzrDir6ToMeta()
 
 
1924
    def _initialize_for_clone(self, url):
 
 
1925
        return self.initialize_on_transport(get_transport(url), _cloning=True)
 
 
1927
    def initialize_on_transport(self, transport, _cloning=False):
 
 
1928
        """Format 6 dirs always have working tree, branch and repository.
 
 
1930
        Except when they are being cloned.
 
 
1932
        from bzrlib.branch import BzrBranchFormat4
 
 
1933
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
 
 
1934
        from bzrlib.workingtree import WorkingTreeFormat2
 
 
1935
        result = super(BzrDirFormat6, self).initialize_on_transport(transport)
 
 
1936
        RepositoryFormat6().initialize(result, _internal=True)
 
 
1938
            branch = BzrBranchFormat4().initialize(result)
 
 
1940
                WorkingTreeFormat2().initialize(result)
 
 
1941
            except errors.NotLocalUrl:
 
 
1942
                # Even though we can't access the working tree, we need to
 
 
1943
                # create its control files.
 
 
1944
                WorkingTreeFormat2()._stub_initialize_remote(branch)
 
 
1947
    def _open(self, transport):
 
 
1948
        """See BzrDirFormat._open."""
 
 
1949
        return BzrDir6(transport, self)
 
 
1951
    def __return_repository_format(self):
 
 
1952
        """Circular import protection."""
 
 
1953
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
 
 
1954
        return RepositoryFormat6()
 
 
1955
    repository_format = property(__return_repository_format)
 
 
1958
class BzrDirMetaFormat1(BzrDirFormat):
 
 
1959
    """Bzr meta control format 1
 
 
1961
    This is the first format with split out working tree, branch and repository
 
 
1964
     - Format 3 working trees [optional]
 
 
1965
     - Format 5 branches [optional]
 
 
1966
     - Format 7 repositories [optional]
 
 
1969
    _lock_class = lockdir.LockDir
 
 
1972
        self._workingtree_format = None
 
 
1973
        self._branch_format = None
 
 
1975
    def __eq__(self, other):
 
 
1976
        if other.__class__ is not self.__class__:
 
 
1978
        if other.repository_format != self.repository_format:
 
 
1980
        if other.workingtree_format != self.workingtree_format:
 
 
1984
    def __ne__(self, other):
 
 
1985
        return not self == other
 
 
1987
    def get_branch_format(self):
 
 
1988
        if self._branch_format is None:
 
 
1989
            from bzrlib.branch import BranchFormat
 
 
1990
            self._branch_format = BranchFormat.get_default_format()
 
 
1991
        return self._branch_format
 
 
1993
    def set_branch_format(self, format):
 
 
1994
        self._branch_format = format
 
 
1996
    def get_converter(self, format=None):
 
 
1997
        """See BzrDirFormat.get_converter()."""
 
 
1999
            format = BzrDirFormat.get_default_format()
 
 
2000
        if not isinstance(self, format.__class__):
 
 
2001
            # converting away from metadir is not implemented
 
 
2002
            raise NotImplementedError(self.get_converter)
 
 
2003
        return ConvertMetaToMeta(format)
 
 
2005
    def get_format_string(self):
 
 
2006
        """See BzrDirFormat.get_format_string()."""
 
 
2007
        return "Bazaar-NG meta directory, format 1\n"
 
 
2009
    def get_format_description(self):
 
 
2010
        """See BzrDirFormat.get_format_description()."""
 
 
2011
        return "Meta directory format 1"
 
 
2013
    def _open(self, transport):
 
 
2014
        """See BzrDirFormat._open."""
 
 
2015
        return BzrDirMeta1(transport, self)
 
 
2017
    def __return_repository_format(self):
 
 
2018
        """Circular import protection."""
 
 
2019
        if getattr(self, '_repository_format', None):
 
 
2020
            return self._repository_format
 
 
2021
        from bzrlib.repository import RepositoryFormat
 
 
2022
        return RepositoryFormat.get_default_format()
 
 
2024
    def __set_repository_format(self, value):
 
 
2025
        """Allow changing the repository format for metadir formats."""
 
 
2026
        self._repository_format = value
 
 
2028
    repository_format = property(__return_repository_format, __set_repository_format)
 
 
2030
    def __get_workingtree_format(self):
 
 
2031
        if self._workingtree_format is None:
 
 
2032
            from bzrlib.workingtree import WorkingTreeFormat
 
 
2033
            self._workingtree_format = WorkingTreeFormat.get_default_format()
 
 
2034
        return self._workingtree_format
 
 
2036
    def __set_workingtree_format(self, wt_format):
 
 
2037
        self._workingtree_format = wt_format
 
 
2039
    workingtree_format = property(__get_workingtree_format,
 
 
2040
                                  __set_workingtree_format)
 
 
2043
# Register bzr control format
 
 
2044
BzrDirFormat.register_control_format(BzrDirFormat)
 
 
2046
# Register bzr formats
 
 
2047
BzrDirFormat.register_format(BzrDirFormat4())
 
 
2048
BzrDirFormat.register_format(BzrDirFormat5())
 
 
2049
BzrDirFormat.register_format(BzrDirFormat6())
 
 
2050
__default_format = BzrDirMetaFormat1()
 
 
2051
BzrDirFormat.register_format(__default_format)
 
 
2052
BzrDirFormat._default_format = __default_format
 
 
2055
class Converter(object):
 
 
2056
    """Converts a disk format object from one format to another."""
 
 
2058
    def convert(self, to_convert, pb):
 
 
2059
        """Perform the conversion of to_convert, giving feedback via pb.
 
 
2061
        :param to_convert: The disk object to convert.
 
 
2062
        :param pb: a progress bar to use for progress information.
 
 
2065
    def step(self, message):
 
 
2066
        """Update the pb by a step."""
 
 
2068
        self.pb.update(message, self.count, self.total)
 
 
2071
class ConvertBzrDir4To5(Converter):
 
 
2072
    """Converts format 4 bzr dirs to format 5."""
 
 
2075
        super(ConvertBzrDir4To5, self).__init__()
 
 
2076
        self.converted_revs = set()
 
 
2077
        self.absent_revisions = set()
 
 
2081
    def convert(self, to_convert, pb):
 
 
2082
        """See Converter.convert()."""
 
 
2083
        self.bzrdir = to_convert
 
 
2085
        self.pb.note('starting upgrade from format 4 to 5')
 
 
2086
        if isinstance(self.bzrdir.transport, LocalTransport):
 
 
2087
            self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
 
 
2088
        self._convert_to_weaves()
 
 
2089
        return BzrDir.open(self.bzrdir.root_transport.base)
 
 
2091
    def _convert_to_weaves(self):
 
 
2092
        self.pb.note('note: upgrade may be faster if all store files are ungzipped first')
 
 
2095
            stat = self.bzrdir.transport.stat('weaves')
 
 
2096
            if not S_ISDIR(stat.st_mode):
 
 
2097
                self.bzrdir.transport.delete('weaves')
 
 
2098
                self.bzrdir.transport.mkdir('weaves')
 
 
2099
        except errors.NoSuchFile:
 
 
2100
            self.bzrdir.transport.mkdir('weaves')
 
 
2101
        # deliberately not a WeaveFile as we want to build it up slowly.
 
 
2102
        self.inv_weave = Weave('inventory')
 
 
2103
        # holds in-memory weaves for all files
 
 
2104
        self.text_weaves = {}
 
 
2105
        self.bzrdir.transport.delete('branch-format')
 
 
2106
        self.branch = self.bzrdir.open_branch()
 
 
2107
        self._convert_working_inv()
 
 
2108
        rev_history = self.branch.revision_history()
 
 
2109
        # to_read is a stack holding the revisions we still need to process;
 
 
2110
        # appending to it adds new highest-priority revisions
 
 
2111
        self.known_revisions = set(rev_history)
 
 
2112
        self.to_read = rev_history[-1:]
 
 
2114
            rev_id = self.to_read.pop()
 
 
2115
            if (rev_id not in self.revisions
 
 
2116
                and rev_id not in self.absent_revisions):
 
 
2117
                self._load_one_rev(rev_id)
 
 
2119
        to_import = self._make_order()
 
 
2120
        for i, rev_id in enumerate(to_import):
 
 
2121
            self.pb.update('converting revision', i, len(to_import))
 
 
2122
            self._convert_one_rev(rev_id)
 
 
2124
        self._write_all_weaves()
 
 
2125
        self._write_all_revs()
 
 
2126
        self.pb.note('upgraded to weaves:')
 
 
2127
        self.pb.note('  %6d revisions and inventories', len(self.revisions))
 
 
2128
        self.pb.note('  %6d revisions not present', len(self.absent_revisions))
 
 
2129
        self.pb.note('  %6d texts', self.text_count)
 
 
2130
        self._cleanup_spare_files_after_format4()
 
 
2131
        self.branch._transport.put_bytes(
 
 
2133
            BzrDirFormat5().get_format_string(),
 
 
2134
            mode=self.bzrdir._get_file_mode())
 
 
2136
    def _cleanup_spare_files_after_format4(self):
 
 
2137
        # FIXME working tree upgrade foo.
 
 
2138
        for n in 'merged-patches', 'pending-merged-patches':
 
 
2140
                ## assert os.path.getsize(p) == 0
 
 
2141
                self.bzrdir.transport.delete(n)
 
 
2142
            except errors.NoSuchFile:
 
 
2144
        self.bzrdir.transport.delete_tree('inventory-store')
 
 
2145
        self.bzrdir.transport.delete_tree('text-store')
 
 
2147
    def _convert_working_inv(self):
 
 
2148
        inv = xml4.serializer_v4.read_inventory(
 
 
2149
                self.branch._transport.get('inventory'))
 
 
2150
        new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv, working=True)
 
 
2151
        self.branch._transport.put_bytes('inventory', new_inv_xml,
 
 
2152
            mode=self.bzrdir._get_file_mode())
 
 
2154
    def _write_all_weaves(self):
 
 
2155
        controlweaves = WeaveStore(self.bzrdir.transport, prefixed=False)
 
 
2156
        weave_transport = self.bzrdir.transport.clone('weaves')
 
 
2157
        weaves = WeaveStore(weave_transport, prefixed=False)
 
 
2158
        transaction = WriteTransaction()
 
 
2162
            for file_id, file_weave in self.text_weaves.items():
 
 
2163
                self.pb.update('writing weave', i, len(self.text_weaves))
 
 
2164
                weaves._put_weave(file_id, file_weave, transaction)
 
 
2166
            self.pb.update('inventory', 0, 1)
 
 
2167
            controlweaves._put_weave('inventory', self.inv_weave, transaction)
 
 
2168
            self.pb.update('inventory', 1, 1)
 
 
2172
    def _write_all_revs(self):
 
 
2173
        """Write all revisions out in new form."""
 
 
2174
        self.bzrdir.transport.delete_tree('revision-store')
 
 
2175
        self.bzrdir.transport.mkdir('revision-store')
 
 
2176
        revision_transport = self.bzrdir.transport.clone('revision-store')
 
 
2178
        from bzrlib.xml5 import serializer_v5
 
 
2179
        from bzrlib.repofmt.weaverepo import RevisionTextStore
 
 
2180
        revision_store = RevisionTextStore(revision_transport,
 
 
2181
            serializer_v5, False, versionedfile.PrefixMapper(),
 
 
2182
            lambda:True, lambda:True)
 
 
2184
            for i, rev_id in enumerate(self.converted_revs):
 
 
2185
                self.pb.update('write revision', i, len(self.converted_revs))
 
 
2186
                text = serializer_v5.write_revision_to_string(
 
 
2187
                    self.revisions[rev_id])
 
 
2189
                revision_store.add_lines(key, None, osutils.split_lines(text))
 
 
2193
    def _load_one_rev(self, rev_id):
 
 
2194
        """Load a revision object into memory.
 
 
2196
        Any parents not either loaded or abandoned get queued to be
 
 
2198
        self.pb.update('loading revision',
 
 
2199
                       len(self.revisions),
 
 
2200
                       len(self.known_revisions))
 
 
2201
        if not self.branch.repository.has_revision(rev_id):
 
 
2203
            self.pb.note('revision {%s} not present in branch; '
 
 
2204
                         'will be converted as a ghost',
 
 
2206
            self.absent_revisions.add(rev_id)
 
 
2208
            rev = self.branch.repository.get_revision(rev_id)
 
 
2209
            for parent_id in rev.parent_ids:
 
 
2210
                self.known_revisions.add(parent_id)
 
 
2211
                self.to_read.append(parent_id)
 
 
2212
            self.revisions[rev_id] = rev
 
 
2214
    def _load_old_inventory(self, rev_id):
 
 
2215
        old_inv_xml = self.branch.repository.inventory_store.get(rev_id).read()
 
 
2216
        inv = xml4.serializer_v4.read_inventory_from_string(old_inv_xml)
 
 
2217
        inv.revision_id = rev_id
 
 
2218
        rev = self.revisions[rev_id]
 
 
2221
    def _load_updated_inventory(self, rev_id):
 
 
2222
        inv_xml = self.inv_weave.get_text(rev_id)
 
 
2223
        inv = xml5.serializer_v5.read_inventory_from_string(inv_xml, rev_id)
 
 
2226
    def _convert_one_rev(self, rev_id):
 
 
2227
        """Convert revision and all referenced objects to new format."""
 
 
2228
        rev = self.revisions[rev_id]
 
 
2229
        inv = self._load_old_inventory(rev_id)
 
 
2230
        present_parents = [p for p in rev.parent_ids
 
 
2231
                           if p not in self.absent_revisions]
 
 
2232
        self._convert_revision_contents(rev, inv, present_parents)
 
 
2233
        self._store_new_inv(rev, inv, present_parents)
 
 
2234
        self.converted_revs.add(rev_id)
 
 
2236
    def _store_new_inv(self, rev, inv, present_parents):
 
 
2237
        new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
 
 
2238
        new_inv_sha1 = sha_string(new_inv_xml)
 
 
2239
        self.inv_weave.add_lines(rev.revision_id,
 
 
2241
                                 new_inv_xml.splitlines(True))
 
 
2242
        rev.inventory_sha1 = new_inv_sha1
 
 
2244
    def _convert_revision_contents(self, rev, inv, present_parents):
 
 
2245
        """Convert all the files within a revision.
 
 
2247
        Also upgrade the inventory to refer to the text revision ids."""
 
 
2248
        rev_id = rev.revision_id
 
 
2249
        mutter('converting texts of revision {%s}',
 
 
2251
        parent_invs = map(self._load_updated_inventory, present_parents)
 
 
2252
        entries = inv.iter_entries()
 
 
2254
        for path, ie in entries:
 
 
2255
            self._convert_file_version(rev, ie, parent_invs)
 
 
2257
    def _convert_file_version(self, rev, ie, parent_invs):
 
 
2258
        """Convert one version of one file.
 
 
2260
        The file needs to be added into the weave if it is a merge
 
 
2261
        of >=2 parents or if it's changed from its parent.
 
 
2263
        file_id = ie.file_id
 
 
2264
        rev_id = rev.revision_id
 
 
2265
        w = self.text_weaves.get(file_id)
 
 
2268
            self.text_weaves[file_id] = w
 
 
2269
        text_changed = False
 
 
2270
        parent_candiate_entries = ie.parent_candidates(parent_invs)
 
 
2271
        heads = graph.Graph(self).heads(parent_candiate_entries.keys())
 
 
2272
        # XXX: Note that this is unordered - and this is tolerable because 
 
 
2273
        # the previous code was also unordered.
 
 
2274
        previous_entries = dict((head, parent_candiate_entries[head]) for head
 
 
2276
        self.snapshot_ie(previous_entries, ie, w, rev_id)
 
 
2279
    @symbol_versioning.deprecated_method(symbol_versioning.one_one)
 
 
2280
    def get_parents(self, revision_ids):
 
 
2281
        for revision_id in revision_ids:
 
 
2282
            yield self.revisions[revision_id].parent_ids
 
 
2284
    def get_parent_map(self, revision_ids):
 
 
2285
        """See graph._StackedParentsProvider.get_parent_map"""
 
 
2286
        return dict((revision_id, self.revisions[revision_id])
 
 
2287
                    for revision_id in revision_ids
 
 
2288
                     if revision_id in self.revisions)
 
 
2290
    def snapshot_ie(self, previous_revisions, ie, w, rev_id):
 
 
2291
        # TODO: convert this logic, which is ~= snapshot to
 
 
2292
        # a call to:. This needs the path figured out. rather than a work_tree
 
 
2293
        # a v4 revision_tree can be given, or something that looks enough like
 
 
2294
        # one to give the file content to the entry if it needs it.
 
 
2295
        # and we need something that looks like a weave store for snapshot to 
 
 
2297
        #ie.snapshot(rev, PATH, previous_revisions, REVISION_TREE, InMemoryWeaveStore(self.text_weaves))
 
 
2298
        if len(previous_revisions) == 1:
 
 
2299
            previous_ie = previous_revisions.values()[0]
 
 
2300
            if ie._unchanged(previous_ie):
 
 
2301
                ie.revision = previous_ie.revision
 
 
2304
            text = self.branch.repository._text_store.get(ie.text_id)
 
 
2305
            file_lines = text.readlines()
 
 
2306
            w.add_lines(rev_id, previous_revisions, file_lines)
 
 
2307
            self.text_count += 1
 
 
2309
            w.add_lines(rev_id, previous_revisions, [])
 
 
2310
        ie.revision = rev_id
 
 
2312
    def _make_order(self):
 
 
2313
        """Return a suitable order for importing revisions.
 
 
2315
        The order must be such that an revision is imported after all
 
 
2316
        its (present) parents.
 
 
2318
        todo = set(self.revisions.keys())
 
 
2319
        done = self.absent_revisions.copy()
 
 
2322
            # scan through looking for a revision whose parents
 
 
2324
            for rev_id in sorted(list(todo)):
 
 
2325
                rev = self.revisions[rev_id]
 
 
2326
                parent_ids = set(rev.parent_ids)
 
 
2327
                if parent_ids.issubset(done):
 
 
2328
                    # can take this one now
 
 
2329
                    order.append(rev_id)
 
 
2335
class ConvertBzrDir5To6(Converter):
 
 
2336
    """Converts format 5 bzr dirs to format 6."""
 
 
2338
    def convert(self, to_convert, pb):
 
 
2339
        """See Converter.convert()."""
 
 
2340
        self.bzrdir = to_convert
 
 
2342
        self.pb.note('starting upgrade from format 5 to 6')
 
 
2343
        self._convert_to_prefixed()
 
 
2344
        return BzrDir.open(self.bzrdir.root_transport.base)
 
 
2346
    def _convert_to_prefixed(self):
 
 
2347
        from bzrlib.store import TransportStore
 
 
2348
        self.bzrdir.transport.delete('branch-format')
 
 
2349
        for store_name in ["weaves", "revision-store"]:
 
 
2350
            self.pb.note("adding prefixes to %s" % store_name)
 
 
2351
            store_transport = self.bzrdir.transport.clone(store_name)
 
 
2352
            store = TransportStore(store_transport, prefixed=True)
 
 
2353
            for urlfilename in store_transport.list_dir('.'):
 
 
2354
                filename = urlutils.unescape(urlfilename)
 
 
2355
                if (filename.endswith(".weave") or
 
 
2356
                    filename.endswith(".gz") or
 
 
2357
                    filename.endswith(".sig")):
 
 
2358
                    file_id, suffix = os.path.splitext(filename)
 
 
2362
                new_name = store._mapper.map((file_id,)) + suffix
 
 
2363
                # FIXME keep track of the dirs made RBC 20060121
 
 
2365
                    store_transport.move(filename, new_name)
 
 
2366
                except errors.NoSuchFile: # catches missing dirs strangely enough
 
 
2367
                    store_transport.mkdir(osutils.dirname(new_name))
 
 
2368
                    store_transport.move(filename, new_name)
 
 
2369
        self.bzrdir.transport.put_bytes(
 
 
2371
            BzrDirFormat6().get_format_string(),
 
 
2372
            mode=self.bzrdir._get_file_mode())
 
 
2375
class ConvertBzrDir6ToMeta(Converter):
 
 
2376
    """Converts format 6 bzr dirs to metadirs."""
 
 
2378
    def convert(self, to_convert, pb):
 
 
2379
        """See Converter.convert()."""
 
 
2380
        from bzrlib.repofmt.weaverepo import RepositoryFormat7
 
 
2381
        from bzrlib.branch import BzrBranchFormat5
 
 
2382
        self.bzrdir = to_convert
 
 
2385
        self.total = 20 # the steps we know about
 
 
2386
        self.garbage_inventories = []
 
 
2387
        self.dir_mode = self.bzrdir._get_dir_mode()
 
 
2388
        self.file_mode = self.bzrdir._get_file_mode()
 
 
2390
        self.pb.note('starting upgrade from format 6 to metadir')
 
 
2391
        self.bzrdir.transport.put_bytes(
 
 
2393
                "Converting to format 6",
 
 
2394
                mode=self.file_mode)
 
 
2395
        # its faster to move specific files around than to open and use the apis...
 
 
2396
        # first off, nuke ancestry.weave, it was never used.
 
 
2398
            self.step('Removing ancestry.weave')
 
 
2399
            self.bzrdir.transport.delete('ancestry.weave')
 
 
2400
        except errors.NoSuchFile:
 
 
2402
        # find out whats there
 
 
2403
        self.step('Finding branch files')
 
 
2404
        last_revision = self.bzrdir.open_branch().last_revision()
 
 
2405
        bzrcontents = self.bzrdir.transport.list_dir('.')
 
 
2406
        for name in bzrcontents:
 
 
2407
            if name.startswith('basis-inventory.'):
 
 
2408
                self.garbage_inventories.append(name)
 
 
2409
        # create new directories for repository, working tree and branch
 
 
2410
        repository_names = [('inventory.weave', True),
 
 
2411
                            ('revision-store', True),
 
 
2413
        self.step('Upgrading repository  ')
 
 
2414
        self.bzrdir.transport.mkdir('repository', mode=self.dir_mode)
 
 
2415
        self.make_lock('repository')
 
 
2416
        # we hard code the formats here because we are converting into
 
 
2417
        # the meta format. The meta format upgrader can take this to a 
 
 
2418
        # future format within each component.
 
 
2419
        self.put_format('repository', RepositoryFormat7())
 
 
2420
        for entry in repository_names:
 
 
2421
            self.move_entry('repository', entry)
 
 
2423
        self.step('Upgrading branch      ')
 
 
2424
        self.bzrdir.transport.mkdir('branch', mode=self.dir_mode)
 
 
2425
        self.make_lock('branch')
 
 
2426
        self.put_format('branch', BzrBranchFormat5())
 
 
2427
        branch_files = [('revision-history', True),
 
 
2428
                        ('branch-name', True),
 
 
2430
        for entry in branch_files:
 
 
2431
            self.move_entry('branch', entry)
 
 
2433
        checkout_files = [('pending-merges', True),
 
 
2434
                          ('inventory', True),
 
 
2435
                          ('stat-cache', False)]
 
 
2436
        # If a mandatory checkout file is not present, the branch does not have
 
 
2437
        # a functional checkout. Do not create a checkout in the converted
 
 
2439
        for name, mandatory in checkout_files:
 
 
2440
            if mandatory and name not in bzrcontents:
 
 
2441
                has_checkout = False
 
 
2445
        if not has_checkout:
 
 
2446
            self.pb.note('No working tree.')
 
 
2447
            # If some checkout files are there, we may as well get rid of them.
 
 
2448
            for name, mandatory in checkout_files:
 
 
2449
                if name in bzrcontents:
 
 
2450
                    self.bzrdir.transport.delete(name)
 
 
2452
            from bzrlib.workingtree import WorkingTreeFormat3
 
 
2453
            self.step('Upgrading working tree')
 
 
2454
            self.bzrdir.transport.mkdir('checkout', mode=self.dir_mode)
 
 
2455
            self.make_lock('checkout')
 
 
2457
                'checkout', WorkingTreeFormat3())
 
 
2458
            self.bzrdir.transport.delete_multi(
 
 
2459
                self.garbage_inventories, self.pb)
 
 
2460
            for entry in checkout_files:
 
 
2461
                self.move_entry('checkout', entry)
 
 
2462
            if last_revision is not None:
 
 
2463
                self.bzrdir.transport.put_bytes(
 
 
2464
                    'checkout/last-revision', last_revision)
 
 
2465
        self.bzrdir.transport.put_bytes(
 
 
2467
            BzrDirMetaFormat1().get_format_string(),
 
 
2468
            mode=self.file_mode)
 
 
2469
        return BzrDir.open(self.bzrdir.root_transport.base)
 
 
2471
    def make_lock(self, name):
 
 
2472
        """Make a lock for the new control dir name."""
 
 
2473
        self.step('Make %s lock' % name)
 
 
2474
        ld = lockdir.LockDir(self.bzrdir.transport,
 
 
2476
                             file_modebits=self.file_mode,
 
 
2477
                             dir_modebits=self.dir_mode)
 
 
2480
    def move_entry(self, new_dir, entry):
 
 
2481
        """Move then entry name into new_dir."""
 
 
2483
        mandatory = entry[1]
 
 
2484
        self.step('Moving %s' % name)
 
 
2486
            self.bzrdir.transport.move(name, '%s/%s' % (new_dir, name))
 
 
2487
        except errors.NoSuchFile:
 
 
2491
    def put_format(self, dirname, format):
 
 
2492
        self.bzrdir.transport.put_bytes('%s/format' % dirname,
 
 
2493
            format.get_format_string(),
 
 
2497
class ConvertMetaToMeta(Converter):
 
 
2498
    """Converts the components of metadirs."""
 
 
2500
    def __init__(self, target_format):
 
 
2501
        """Create a metadir to metadir converter.
 
 
2503
        :param target_format: The final metadir format that is desired.
 
 
2505
        self.target_format = target_format
 
 
2507
    def convert(self, to_convert, pb):
 
 
2508
        """See Converter.convert()."""
 
 
2509
        self.bzrdir = to_convert
 
 
2513
        self.step('checking repository format')
 
 
2515
            repo = self.bzrdir.open_repository()
 
 
2516
        except errors.NoRepositoryPresent:
 
 
2519
            if not isinstance(repo._format, self.target_format.repository_format.__class__):
 
 
2520
                from bzrlib.repository import CopyConverter
 
 
2521
                self.pb.note('starting repository conversion')
 
 
2522
                converter = CopyConverter(self.target_format.repository_format)
 
 
2523
                converter.convert(repo, pb)
 
 
2525
            branch = self.bzrdir.open_branch()
 
 
2526
        except errors.NotBranchError:
 
 
2529
            # TODO: conversions of Branch and Tree should be done by
 
 
2530
            # InterXFormat lookups/some sort of registry.
 
 
2531
            # Avoid circular imports
 
 
2532
            from bzrlib import branch as _mod_branch
 
 
2533
            old = branch._format.__class__
 
 
2534
            new = self.target_format.get_branch_format().__class__
 
 
2536
                if (old == _mod_branch.BzrBranchFormat5 and
 
 
2537
                    new in (_mod_branch.BzrBranchFormat6,
 
 
2538
                        _mod_branch.BzrBranchFormat7)):
 
 
2539
                    branch_converter = _mod_branch.Converter5to6()
 
 
2540
                elif (old == _mod_branch.BzrBranchFormat6 and
 
 
2541
                    new == _mod_branch.BzrBranchFormat7):
 
 
2542
                    branch_converter = _mod_branch.Converter6to7()
 
 
2544
                    raise errors.BadConversionTarget("No converter", new)
 
 
2545
                branch_converter.convert(branch)
 
 
2546
                branch = self.bzrdir.open_branch()
 
 
2547
                old = branch._format.__class__
 
 
2549
            tree = self.bzrdir.open_workingtree(recommend_upgrade=False)
 
 
2550
        except (errors.NoWorkingTree, errors.NotLocalUrl):
 
 
2553
            # TODO: conversions of Branch and Tree should be done by
 
 
2554
            # InterXFormat lookups
 
 
2555
            if (isinstance(tree, workingtree.WorkingTree3) and
 
 
2556
                not isinstance(tree, workingtree_4.WorkingTree4) and
 
 
2557
                isinstance(self.target_format.workingtree_format,
 
 
2558
                    workingtree_4.WorkingTreeFormat4)):
 
 
2559
                workingtree_4.Converter3to4().convert(tree)
 
 
2563
# This is not in remote.py because it's small, and needs to be registered.
 
 
2564
# Putting it in remote.py creates a circular import problem.
 
 
2565
# we can make it a lazy object if the control formats is turned into something
 
 
2567
class RemoteBzrDirFormat(BzrDirMetaFormat1):
 
 
2568
    """Format representing bzrdirs accessed via a smart server"""
 
 
2570
    def get_format_description(self):
 
 
2571
        return 'bzr remote bzrdir'
 
 
2574
    def probe_transport(klass, transport):
 
 
2575
        """Return a RemoteBzrDirFormat object if it looks possible."""
 
 
2577
            medium = transport.get_smart_medium()
 
 
2578
        except (NotImplementedError, AttributeError,
 
 
2579
                errors.TransportNotPossible, errors.NoSmartMedium,
 
 
2580
                errors.SmartProtocolError):
 
 
2581
            # no smart server, so not a branch for this format type.
 
 
2582
            raise errors.NotBranchError(path=transport.base)
 
 
2584
            # Decline to open it if the server doesn't support our required
 
 
2585
            # version (3) so that the VFS-based transport will do it.
 
 
2586
            if medium.should_probe():
 
 
2588
                    server_version = medium.protocol_version()
 
 
2589
                except errors.SmartProtocolError:
 
 
2590
                    # Apparently there's no usable smart server there, even though
 
 
2591
                    # the medium supports the smart protocol.
 
 
2592
                    raise errors.NotBranchError(path=transport.base)
 
 
2593
                if server_version != '2':
 
 
2594
                    raise errors.NotBranchError(path=transport.base)
 
 
2597
    def initialize_on_transport(self, transport):
 
 
2599
            # hand off the request to the smart server
 
 
2600
            client_medium = transport.get_smart_medium()
 
 
2601
        except errors.NoSmartMedium:
 
 
2602
            # TODO: lookup the local format from a server hint.
 
 
2603
            local_dir_format = BzrDirMetaFormat1()
 
 
2604
            return local_dir_format.initialize_on_transport(transport)
 
 
2605
        client = _SmartClient(client_medium)
 
 
2606
        path = client.remote_path_from_transport(transport)
 
 
2607
        response = client.call('BzrDirFormat.initialize', path)
 
 
2608
        if response[0] != 'ok':
 
 
2609
            raise errors.SmartProtocolError('unexpected response code %s' % (response,))
 
 
2610
        return remote.RemoteBzrDir(transport)
 
 
2612
    def _open(self, transport):
 
 
2613
        return remote.RemoteBzrDir(transport)
 
 
2615
    def __eq__(self, other):
 
 
2616
        if not isinstance(other, RemoteBzrDirFormat):
 
 
2618
        return self.get_format_description() == other.get_format_description()
 
 
2621
BzrDirFormat.register_control_server_format(RemoteBzrDirFormat)
 
 
2624
class BzrDirFormatInfo(object):
 
 
2626
    def __init__(self, native, deprecated, hidden, experimental):
 
 
2627
        self.deprecated = deprecated
 
 
2628
        self.native = native
 
 
2629
        self.hidden = hidden
 
 
2630
        self.experimental = experimental
 
 
2633
class BzrDirFormatRegistry(registry.Registry):
 
 
2634
    """Registry of user-selectable BzrDir subformats.
 
 
2636
    Differs from BzrDirFormat._control_formats in that it provides sub-formats,
 
 
2637
    e.g. BzrDirMeta1 with weave repository.  Also, it's more user-oriented.
 
 
2641
        """Create a BzrDirFormatRegistry."""
 
 
2642
        self._aliases = set()
 
 
2643
        super(BzrDirFormatRegistry, self).__init__()
 
 
2646
        """Return a set of the format names which are aliases."""
 
 
2647
        return frozenset(self._aliases)
 
 
2649
    def register_metadir(self, key,
 
 
2650
             repository_format, help, native=True, deprecated=False,
 
 
2656
        """Register a metadir subformat.
 
 
2658
        These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
 
 
2659
        by the Repository format.
 
 
2661
        :param repository_format: The fully-qualified repository format class
 
 
2663
        :param branch_format: Fully-qualified branch format class name as
 
 
2665
        :param tree_format: Fully-qualified tree format class name as
 
 
2668
        # This should be expanded to support setting WorkingTree and Branch
 
 
2669
        # formats, once BzrDirMetaFormat1 supports that.
 
 
2670
        def _load(full_name):
 
 
2671
            mod_name, factory_name = full_name.rsplit('.', 1)
 
 
2673
                mod = __import__(mod_name, globals(), locals(),
 
 
2675
            except ImportError, e:
 
 
2676
                raise ImportError('failed to load %s: %s' % (full_name, e))
 
 
2678
                factory = getattr(mod, factory_name)
 
 
2679
            except AttributeError:
 
 
2680
                raise AttributeError('no factory %s in module %r'
 
 
2685
            bd = BzrDirMetaFormat1()
 
 
2686
            if branch_format is not None:
 
 
2687
                bd.set_branch_format(_load(branch_format))
 
 
2688
            if tree_format is not None:
 
 
2689
                bd.workingtree_format = _load(tree_format)
 
 
2690
            if repository_format is not None:
 
 
2691
                bd.repository_format = _load(repository_format)
 
 
2693
        self.register(key, helper, help, native, deprecated, hidden,
 
 
2694
            experimental, alias)
 
 
2696
    def register(self, key, factory, help, native=True, deprecated=False,
 
 
2697
                 hidden=False, experimental=False, alias=False):
 
 
2698
        """Register a BzrDirFormat factory.
 
 
2700
        The factory must be a callable that takes one parameter: the key.
 
 
2701
        It must produce an instance of the BzrDirFormat when called.
 
 
2703
        This function mainly exists to prevent the info object from being
 
 
2706
        registry.Registry.register(self, key, factory, help,
 
 
2707
            BzrDirFormatInfo(native, deprecated, hidden, experimental))
 
 
2709
            self._aliases.add(key)
 
 
2711
    def register_lazy(self, key, module_name, member_name, help, native=True,
 
 
2712
        deprecated=False, hidden=False, experimental=False, alias=False):
 
 
2713
        registry.Registry.register_lazy(self, key, module_name, member_name,
 
 
2714
            help, BzrDirFormatInfo(native, deprecated, hidden, experimental))
 
 
2716
            self._aliases.add(key)
 
 
2718
    def set_default(self, key):
 
 
2719
        """Set the 'default' key to be a clone of the supplied key.
 
 
2721
        This method must be called once and only once.
 
 
2723
        registry.Registry.register(self, 'default', self.get(key),
 
 
2724
            self.get_help(key), info=self.get_info(key))
 
 
2725
        self._aliases.add('default')
 
 
2727
    def set_default_repository(self, key):
 
 
2728
        """Set the FormatRegistry default and Repository default.
 
 
2730
        This is a transitional method while Repository.set_default_format
 
 
2733
        if 'default' in self:
 
 
2734
            self.remove('default')
 
 
2735
        self.set_default(key)
 
 
2736
        format = self.get('default')()
 
 
2738
    def make_bzrdir(self, key):
 
 
2739
        return self.get(key)()
 
 
2741
    def help_topic(self, topic):
 
 
2742
        output = textwrap.dedent("""\
 
 
2743
            These formats can be used for creating branches, working trees, and
 
 
2747
        default_realkey = None
 
 
2748
        default_help = self.get_help('default')
 
 
2750
        for key in self.keys():
 
 
2751
            if key == 'default':
 
 
2753
            help = self.get_help(key)
 
 
2754
            if help == default_help:
 
 
2755
                default_realkey = key
 
 
2757
                help_pairs.append((key, help))
 
 
2759
        def wrapped(key, help, info):
 
 
2761
                help = '(native) ' + help
 
 
2762
            return ':%s:\n%s\n\n' % (key, 
 
 
2763
                    textwrap.fill(help, initial_indent='    ', 
 
 
2764
                    subsequent_indent='    '))
 
 
2765
        if default_realkey is not None:
 
 
2766
            output += wrapped(default_realkey, '(default) %s' % default_help,
 
 
2767
                              self.get_info('default'))
 
 
2768
        deprecated_pairs = []
 
 
2769
        experimental_pairs = []
 
 
2770
        for key, help in help_pairs:
 
 
2771
            info = self.get_info(key)
 
 
2774
            elif info.deprecated:
 
 
2775
                deprecated_pairs.append((key, help))
 
 
2776
            elif info.experimental:
 
 
2777
                experimental_pairs.append((key, help))
 
 
2779
                output += wrapped(key, help, info)
 
 
2780
        if len(experimental_pairs) > 0:
 
 
2781
            output += "Experimental formats are shown below.\n\n"
 
 
2782
            for key, help in experimental_pairs:
 
 
2783
                info = self.get_info(key)
 
 
2784
                output += wrapped(key, help, info)
 
 
2785
        if len(deprecated_pairs) > 0:
 
 
2786
            output += "Deprecated formats are shown below.\n\n"
 
 
2787
            for key, help in deprecated_pairs:
 
 
2788
                info = self.get_info(key)
 
 
2789
                output += wrapped(key, help, info)
 
 
2794
class RepositoryAcquisitionPolicy(object):
 
 
2795
    """Abstract base class for repository acquisition policies.
 
 
2797
    A repository acquisition policy decides how a BzrDir acquires a repository
 
 
2798
    for a branch that is being created.  The most basic policy decision is
 
 
2799
    whether to create a new repository or use an existing one.
 
 
2801
    def __init__(self, stack_on, stack_on_pwd, require_stacking):
 
 
2804
        :param stack_on: A location to stack on
 
 
2805
        :param stack_on_pwd: If stack_on is relative, the location it is
 
 
2807
        :param require_stacking: If True, it is a failure to not stack.
 
 
2809
        self._stack_on = stack_on
 
 
2810
        self._stack_on_pwd = stack_on_pwd
 
 
2811
        self._require_stacking = require_stacking
 
 
2813
    def configure_branch(self, branch):
 
 
2814
        """Apply any configuration data from this policy to the branch.
 
 
2816
        Default implementation sets repository stacking.
 
 
2818
        if self._stack_on is None:
 
 
2820
        if self._stack_on_pwd is None:
 
 
2821
            stack_on = self._stack_on
 
 
2824
                stack_on = urlutils.rebase_url(self._stack_on,
 
 
2826
                    branch.bzrdir.root_transport.base)
 
 
2827
            except errors.InvalidRebaseURLs:
 
 
2828
                stack_on = self._get_full_stack_on()
 
 
2830
            branch.set_stacked_on_url(stack_on)
 
 
2831
        except errors.UnstackableBranchFormat:
 
 
2832
            if self._require_stacking:
 
 
2835
    def _get_full_stack_on(self):
 
 
2836
        """Get a fully-qualified URL for the stack_on location."""
 
 
2837
        if self._stack_on is None:
 
 
2839
        if self._stack_on_pwd is None:
 
 
2840
            return self._stack_on
 
 
2842
            return urlutils.join(self._stack_on_pwd, self._stack_on)
 
 
2844
    def _add_fallback(self, repository):
 
 
2845
        """Add a fallback to the supplied repository, if stacking is set."""
 
 
2846
        stack_on = self._get_full_stack_on()
 
 
2847
        if stack_on is None:
 
 
2849
        stacked_dir = BzrDir.open(stack_on)
 
 
2851
            stacked_repo = stacked_dir.open_branch().repository
 
 
2852
        except errors.NotBranchError:
 
 
2853
            stacked_repo = stacked_dir.open_repository()
 
 
2855
            repository.add_fallback_repository(stacked_repo)
 
 
2856
        except errors.UnstackableRepositoryFormat:
 
 
2857
            if self._require_stacking:
 
 
2860
    def acquire_repository(self, make_working_trees=None, shared=False):
 
 
2861
        """Acquire a repository for this bzrdir.
 
 
2863
        Implementations may create a new repository or use a pre-exising
 
 
2865
        :param make_working_trees: If creating a repository, set
 
 
2866
            make_working_trees to this value (if non-None)
 
 
2867
        :param shared: If creating a repository, make it shared if True
 
 
2868
        :return: A repository
 
 
2870
        raise NotImplemented(RepositoryAcquisitionPolicy.acquire_repository)
 
 
2873
class CreateRepository(RepositoryAcquisitionPolicy):
 
 
2874
    """A policy of creating a new repository"""
 
 
2876
    def __init__(self, bzrdir, stack_on=None, stack_on_pwd=None,
 
 
2877
                 require_stacking=False):
 
 
2880
        :param bzrdir: The bzrdir to create the repository on.
 
 
2881
        :param stack_on: A location to stack on
 
 
2882
        :param stack_on_pwd: If stack_on is relative, the location it is
 
 
2885
        RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
 
 
2887
        self._bzrdir = bzrdir
 
 
2889
    def acquire_repository(self, make_working_trees=None, shared=False):
 
 
2890
        """Implementation of RepositoryAcquisitionPolicy.acquire_repository
 
 
2892
        Creates the desired repository in the bzrdir we already have.
 
 
2894
        if self._stack_on or self._require_stacking:
 
 
2895
            # we may be coming from a format that doesn't support stacking,
 
 
2896
            # but we require it in the destination, so force creation of a new
 
 
2899
            # TODO: perhaps this should be treated as a distinct repository
 
 
2900
            # acquisition policy?
 
 
2901
            repository_format = self._bzrdir._format.repository_format
 
 
2902
            if not repository_format.supports_external_lookups:
 
 
2903
                # should possibly be controlled by the registry rather than
 
 
2905
                from bzrlib.repofmt import pack_repo
 
 
2906
                if repository_format.rich_root_data:
 
 
2907
                    repository_format = \
 
 
2908
                        pack_repo.RepositoryFormatKnitPack5RichRoot()
 
 
2910
                    repository_format = pack_repo.RepositoryFormatKnitPack5()
 
 
2911
                note("using %r for stacking" % (repository_format,))
 
 
2912
            repository = repository_format.initialize(self._bzrdir,
 
 
2916
            repository = self._bzrdir.create_repository(shared=shared)
 
 
2917
        self._add_fallback(repository)
 
 
2918
        if make_working_trees is not None:
 
 
2919
            repository.set_make_working_trees(make_working_trees)
 
 
2923
class UseExistingRepository(RepositoryAcquisitionPolicy):
 
 
2924
    """A policy of reusing an existing repository"""
 
 
2926
    def __init__(self, repository, stack_on=None, stack_on_pwd=None,
 
 
2927
                 require_stacking=False):
 
 
2930
        :param repository: The repository to use.
 
 
2931
        :param stack_on: A location to stack on
 
 
2932
        :param stack_on_pwd: If stack_on is relative, the location it is
 
 
2935
        RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
 
 
2937
        self._repository = repository
 
 
2939
    def acquire_repository(self, make_working_trees=None, shared=False):
 
 
2940
        """Implementation of RepositoryAcquisitionPolicy.acquire_repository
 
 
2942
        Returns an existing repository to use
 
 
2944
        self._add_fallback(self._repository)
 
 
2945
        return self._repository
 
 
2948
format_registry = BzrDirFormatRegistry()
 
 
2949
format_registry.register('weave', BzrDirFormat6,
 
 
2950
    'Pre-0.8 format.  Slower than knit and does not'
 
 
2951
    ' support checkouts or shared repositories.',
 
 
2953
format_registry.register_metadir('knit',
 
 
2954
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
 
 
2955
    'Format using knits.  Recommended for interoperation with bzr <= 0.14.',
 
 
2956
    branch_format='bzrlib.branch.BzrBranchFormat5',
 
 
2957
    tree_format='bzrlib.workingtree.WorkingTreeFormat3')
 
 
2958
format_registry.register_metadir('metaweave',
 
 
2959
    'bzrlib.repofmt.weaverepo.RepositoryFormat7',
 
 
2960
    'Transitional format in 0.8.  Slower than knit.',
 
 
2961
    branch_format='bzrlib.branch.BzrBranchFormat5',
 
 
2962
    tree_format='bzrlib.workingtree.WorkingTreeFormat3',
 
 
2964
format_registry.register_metadir('dirstate',
 
 
2965
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
 
 
2966
    help='New in 0.15: Fast local operations. Compatible with bzr 0.8 and '
 
 
2967
        'above when accessed over the network.',
 
 
2968
    branch_format='bzrlib.branch.BzrBranchFormat5',
 
 
2969
    # this uses bzrlib.workingtree.WorkingTreeFormat4 because importing
 
 
2970
    # directly from workingtree_4 triggers a circular import.
 
 
2971
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
 
2973
format_registry.register_metadir('dirstate-tags',
 
 
2974
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
 
 
2975
    help='New in 0.15: Fast local operations and improved scaling for '
 
 
2976
        'network operations. Additionally adds support for tags.'
 
 
2977
        ' Incompatible with bzr < 0.15.',
 
 
2978
    branch_format='bzrlib.branch.BzrBranchFormat6',
 
 
2979
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
 
2981
format_registry.register_metadir('rich-root',
 
 
2982
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
 
 
2983
    help='New in 1.0.  Better handling of tree roots.  Incompatible with'
 
 
2985
    branch_format='bzrlib.branch.BzrBranchFormat6',
 
 
2986
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
 
2988
format_registry.register_metadir('dirstate-with-subtree',
 
 
2989
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
 
 
2990
    help='New in 0.15: Fast local operations and improved scaling for '
 
 
2991
        'network operations. Additionally adds support for versioning nested '
 
 
2992
        'bzr branches. Incompatible with bzr < 0.15.',
 
 
2993
    branch_format='bzrlib.branch.BzrBranchFormat6',
 
 
2994
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
 
2998
format_registry.register_metadir('pack-0.92',
 
 
2999
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack1',
 
 
3000
    help='New in 0.92: Pack-based format with data compatible with '
 
 
3001
        'dirstate-tags format repositories. Interoperates with '
 
 
3002
        'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
 
 
3003
        'Previously called knitpack-experimental.  '
 
 
3004
        'For more information, see '
 
 
3005
        'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
 
 
3006
    branch_format='bzrlib.branch.BzrBranchFormat6',
 
 
3007
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
 
3009
format_registry.register_metadir('pack-0.92-subtree',
 
 
3010
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack3',
 
 
3011
    help='New in 0.92: Pack-based format with data compatible with '
 
 
3012
        'dirstate-with-subtree format repositories. Interoperates with '
 
 
3013
        'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
 
 
3014
        'Previously called knitpack-experimental.  '
 
 
3015
        'For more information, see '
 
 
3016
        'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
 
 
3017
    branch_format='bzrlib.branch.BzrBranchFormat6',
 
 
3018
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
 
3022
format_registry.register_metadir('rich-root-pack',
 
 
3023
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
 
 
3024
    help='New in 1.0: Pack-based format with data compatible with '
 
 
3025
        'rich-root format repositories. Incompatible with'
 
 
3027
    branch_format='bzrlib.branch.BzrBranchFormat6',
 
 
3028
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
 
3030
format_registry.register_metadir('1.6',
 
 
3031
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5',
 
 
3032
    help='A branch and pack based repository that supports stacking. ',
 
 
3033
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
 
3034
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
 
3036
format_registry.register_metadir('1.6-rich-root',
 
 
3037
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5RichRoot',
 
 
3038
    help='A branch and pack based repository that supports stacking '
 
 
3039
         'and rich root data (needed for bzr-svn). ',
 
 
3040
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
 
3041
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
 
3043
# The following two formats should always just be aliases.
 
 
3044
format_registry.register_metadir('development',
 
 
3045
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment1',
 
 
3046
    help='Current development format. Can convert data to and from pack-0.92 '
 
 
3047
        '(and anything compatible with pack-0.92) format repositories. '
 
 
3048
        'Repositories and branches in this format can only be read by bzr.dev. '
 
 
3050
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
 
 
3052
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
 
3053
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
 
3057
format_registry.register_metadir('development-subtree',
 
 
3058
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment1Subtree',
 
 
3059
    help='Current development format, subtree variant. Can convert data to and '
 
 
3060
        'from pack-0.92-subtree (and anything compatible with '
 
 
3061
        'pack-0.92-subtree) format repositories. Repositories and branches in '
 
 
3062
        'this format can only be read by bzr.dev. Please read '
 
 
3063
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
 
 
3065
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
 
3066
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
 
3070
# And the development formats which the will have aliased one of follow:
 
 
3071
format_registry.register_metadir('development0',
 
 
3072
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment0',
 
 
3073
    help='Trivial rename of pack-0.92 to provide a development format. '
 
 
3075
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
 
 
3077
    branch_format='bzrlib.branch.BzrBranchFormat6',
 
 
3078
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
 
3082
format_registry.register_metadir('development0-subtree',
 
 
3083
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment0Subtree',
 
 
3084
    help='Trivial rename of pack-0.92-subtree to provide a development format. '
 
 
3086
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
 
 
3088
    branch_format='bzrlib.branch.BzrBranchFormat6',
 
 
3089
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
 
3093
format_registry.register_metadir('development1',
 
 
3094
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment1',
 
 
3095
    help='A branch and pack based repository that supports stacking. '
 
 
3097
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
 
 
3099
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
 
3100
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
 
3104
format_registry.register_metadir('development1-subtree',
 
 
3105
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment1Subtree',
 
 
3106
    help='A branch and pack based repository that supports stacking. '
 
 
3108
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
 
 
3110
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
 
3111
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
 
3115
# The current format that is made on 'bzr init'.
 
 
3116
format_registry.set_default('pack-0.92')