~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/bzrdir.py

  • Committer: Aaron Bentley
  • Date: 2008-12-03 05:31:27 UTC
  • mto: This revision was merged to the branch mainline in revision 3893.
  • Revision ID: aaron@aaronbentley.com-20081203053127-vozu5rmsixaadw0v
Change ls-shelf to shelve --list

Show diffs side-by-side

added added

removed removed

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