/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: Canonical.com Patch Queue Manager
  • Date: 2008-08-23 18:54:47 UTC
  • mfrom: (3645.1.1 bzr.dev)
  • Revision ID: pqm@pqm.ubuntu.com-20080823185447-4fimhc5kjnedx6t6
(James Westby) Give the user a bit more information about which saved
        location is being used.

Show diffs side-by-side

added added

removed removed

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