/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: John Arbash Meinel
  • Date: 2008-09-30 20:30:04 UTC
  • mto: This revision was merged to the branch mainline in revision 3761.
  • Revision ID: john@arbash-meinel.com-20080930203004-sf06gl9iaovamxzl
Add some simple direct tests for WT.open and WT.open_containing.
Fixes bug #276436.

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