/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: Andrew Bennetts
  • Date: 2008-09-14 10:46:46 UTC
  • mto: This revision was merged to the branch mainline in revision 3756.
  • Revision ID: andrew.bennetts@canonical.com-20080914104646-sjo6u2nk8bi54nzn
Polish lazy_registry feature a little.

Show diffs side-by-side

added added

removed removed

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