/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: Aaron Bentley
  • Date: 2008-08-28 18:57:59 UTC
  • mto: This revision was merged to the branch mainline in revision 3678.
  • Revision ID: aaron@aaronbentley.com-20080828185759-fbc45dxmvt02c3a1
Fix push to use clone all the time.

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