/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: Jelmer Vernooij
  • Date: 2008-09-02 00:29:28 UTC
  • mto: (3680.1.1 bzr.dev)
  • mto: This revision was merged to the branch mainline in revision 3689.
  • Revision ID: jelmer@samba.org-20080902002928-qp0m5mq97t5zm414
Eliminate more uses of Repository.revision_tree(None).

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