/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: Ian Clatworthy
  • Date: 2008-07-30 04:34:59 UTC
  • mfrom: (3535.8.4 bzr.dev.send)
  • mto: This revision was merged to the branch mainline in revision 3594.
  • Revision ID: ian.clatworthy@canonical.com-20080730043459-fpeor9jlisylif0b
Give a more specific error when target branch unreachable (James Westby)

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