/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/bzrdir.py

  • Committer: John Arbash Meinel
  • Date: 2008-08-29 02:05:22 UTC
  • mto: (3606.5.11 1.6)
  • mto: This revision was merged to the branch mainline in revision 3667.
  • Revision ID: john@arbash-meinel.com-20080829020522-kpkk0zvxf52oj3kh
Fix bug #261339, Always request full texts for Revision texts.

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