/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/bzrdir.py

  • Committer: Ian Clatworthy
  • Date: 2008-07-17 00:41:25 UTC
  • mto: This revision was merged to the branch mainline in revision 3545.
  • Revision ID: ian.clatworthy@canonical.com-20080717004125-xqq4jhlh9ldxgg7a
fix how cog.py is invoked on Windows (Mark Hammond)

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