/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/bzrdir.py

  • Committer: John Arbash Meinel
  • Date: 2008-09-02 19:15:57 UTC
  • mto: This revision was merged to the branch mainline in revision 3680.
  • Revision ID: john@arbash-meinel.com-20080902191557-s88j283bmnnnlvhr
PQM's pyrex needs a Py_ssize_t typedef.

Show diffs side-by-side

added added

removed removed

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