/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/bzrdir.py

  • Committer: Robert Collins
  • Date: 2009-02-06 03:47:05 UTC
  • mto: This revision was merged to the branch mainline in revision 3987.
  • Revision ID: robertc@robertcollins.net-20090206034705-i3xvyq06qi5svxjd
Fix bug 319790 - unshelve of deleted paths failing.

Show diffs side-by-side

added added

removed removed

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