/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/bzrdir.py

  • Committer: Martin Pool
  • Date: 2008-12-09 01:49:56 UTC
  • mto: This revision was merged to the branch mainline in revision 3883.
  • Revision ID: mbp@sourcefrog.net-20081209014956-mbak0aw0zrprcido
Add Registry.items()

Show diffs side-by-side

added added

removed removed

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