/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: Martin Pool
  • Date: 2008-09-23 05:37:53 UTC
  • mfrom: (3331.3.13 lock_hooks)
  • mto: This revision was merged to the branch mainline in revision 3730.
  • Revision ID: mbp@sourcefrog.net-20080923053753-yusi3tdaemoflcya
Move Lock hooks onto a base Lock class and make them more consistent with other lock classes

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 isinstance(repo_format, remote.RemoteRepositoryFormat):
 
1011
                source_repository._ensure_real()
 
1012
                repo_format = source_repository._real_repository._format
 
1013
            result_format.repository_format = repo_format
 
1014
        try:
 
1015
            # TODO: Couldn't we just probe for the format in these cases,
 
1016
            # rather than opening the whole tree?  It would be a little
 
1017
            # faster. mbp 20070401
 
1018
            tree = self.open_workingtree(recommend_upgrade=False)
 
1019
        except (errors.NoWorkingTree, errors.NotLocalUrl):
 
1020
            result_format.workingtree_format = None
 
1021
        else:
 
1022
            result_format.workingtree_format = tree._format.__class__()
 
1023
        return result_format, source_repository
 
1024
 
 
1025
    def cloning_metadir(self, require_stacking=False):
 
1026
        """Produce a metadir suitable for cloning or sprouting with.
 
1027
 
 
1028
        These operations may produce workingtrees (yes, even though they're
 
1029
        "cloning" something that doesn't have a tree), so a viable workingtree
 
1030
        format must be selected.
 
1031
 
 
1032
        :require_stacking: If True, non-stackable formats will be upgraded
 
1033
            to similar stackable formats.
 
1034
        :returns: a BzrDirFormat with all component formats either set
 
1035
            appropriately or set to None if that component should not be
 
1036
            created.
 
1037
        """
 
1038
        format, repository = self._cloning_metadir()
 
1039
        if format._workingtree_format is None:
 
1040
            if repository is None:
 
1041
                return format
 
1042
            tree_format = repository._format._matchingbzrdir.workingtree_format
 
1043
            format.workingtree_format = tree_format.__class__()
 
1044
        if (require_stacking and not
 
1045
            format.get_branch_format().supports_stacking()):
 
1046
            # We need to make a stacked branch, but the default format for the
 
1047
            # target doesn't support stacking.  So force a branch that *can*
 
1048
            # support stacking.
 
1049
            from bzrlib.branch import BzrBranchFormat7
 
1050
            format._branch_format = BzrBranchFormat7()
 
1051
            mutter("using %r for stacking" % (format._branch_format,))
 
1052
            from bzrlib.repofmt import pack_repo
 
1053
            if format.repository_format.rich_root_data:
 
1054
                bzrdir_format_name = '1.6.1-rich-root'
 
1055
                repo_format = pack_repo.RepositoryFormatKnitPack5RichRoot()
 
1056
            else:
 
1057
                bzrdir_format_name = '1.6'
 
1058
                repo_format = pack_repo.RepositoryFormatKnitPack5()
 
1059
            note('Source format does not support stacking, using format:'
 
1060
                 ' \'%s\'\n  %s\n',
 
1061
                 bzrdir_format_name, repo_format.get_format_description())
 
1062
            format.repository_format = repo_format
 
1063
        return format
 
1064
 
 
1065
    def checkout_metadir(self):
 
1066
        return self.cloning_metadir()
 
1067
 
 
1068
    def sprout(self, url, revision_id=None, force_new_repo=False,
 
1069
               recurse='down', possible_transports=None,
 
1070
               accelerator_tree=None, hardlink=False, stacked=False):
 
1071
        """Create a copy of this bzrdir prepared for use as a new line of
 
1072
        development.
 
1073
 
 
1074
        If url's last component does not exist, it will be created.
 
1075
 
 
1076
        Attributes related to the identity of the source branch like
 
1077
        branch nickname will be cleaned, a working tree is created
 
1078
        whether one existed before or not; and a local branch is always
 
1079
        created.
 
1080
 
 
1081
        if revision_id is not None, then the clone operation may tune
 
1082
            itself to download less data.
 
1083
        :param accelerator_tree: A tree which can be used for retrieving file
 
1084
            contents more quickly than the revision tree, i.e. a workingtree.
 
1085
            The revision tree will be used for cases where accelerator_tree's
 
1086
            content is different.
 
1087
        :param hardlink: If true, hard-link files from accelerator_tree,
 
1088
            where possible.
 
1089
        :param stacked: If true, create a stacked branch referring to the
 
1090
            location of this control directory.
 
1091
        """
 
1092
        target_transport = get_transport(url, possible_transports)
 
1093
        target_transport.ensure_base()
 
1094
        cloning_format = self.cloning_metadir(stacked)
 
1095
        # Create/update the result branch
 
1096
        result = cloning_format.initialize_on_transport(target_transport)
 
1097
        try:
 
1098
            source_branch = self.open_branch()
 
1099
            source_repository = source_branch.repository
 
1100
            if stacked:
 
1101
                stacked_branch_url = self.root_transport.base
 
1102
            else:
 
1103
                # if a stacked branch wasn't requested, we don't create one
 
1104
                # even if the origin was stacked
 
1105
                stacked_branch_url = None
 
1106
        except errors.NotBranchError:
 
1107
            source_branch = None
 
1108
            try:
 
1109
                source_repository = self.open_repository()
 
1110
            except errors.NoRepositoryPresent:
 
1111
                source_repository = None
 
1112
            stacked_branch_url = None
 
1113
        repository_policy = result.determine_repository_policy(
 
1114
            force_new_repo, stacked_branch_url, require_stacking=stacked)
 
1115
        result_repo = repository_policy.acquire_repository()
 
1116
        if source_repository is not None:
 
1117
            # Fetch while stacked to prevent unstacked fetch from
 
1118
            # Branch.sprout.
 
1119
            result_repo.fetch(source_repository, revision_id=revision_id)
 
1120
 
 
1121
        if source_branch is None:
 
1122
            # this is for sprouting a bzrdir without a branch; is that
 
1123
            # actually useful?
 
1124
            # Not especially, but it's part of the contract.
 
1125
            result_branch = result.create_branch()
 
1126
        else:
 
1127
            # Force NULL revision to avoid using repository before stacking
 
1128
            # is configured.
 
1129
            result_branch = source_branch.sprout(
 
1130
                result, revision_id=_mod_revision.NULL_REVISION)
 
1131
            parent_location = result_branch.get_parent()
 
1132
        mutter("created new branch %r" % (result_branch,))
 
1133
        repository_policy.configure_branch(result_branch)
 
1134
        if source_branch is not None:
 
1135
            source_branch.copy_content_into(result_branch, revision_id)
 
1136
            # Override copy_content_into
 
1137
            result_branch.set_parent(parent_location)
 
1138
 
 
1139
        # Create/update the result working tree
 
1140
        if isinstance(target_transport, LocalTransport) and (
 
1141
            result_repo is None or result_repo.make_working_trees()):
 
1142
            wt = result.create_workingtree(accelerator_tree=accelerator_tree,
 
1143
                hardlink=hardlink)
 
1144
            wt.lock_write()
 
1145
            try:
 
1146
                if wt.path2id('') is None:
 
1147
                    try:
 
1148
                        wt.set_root_id(self.open_workingtree.get_root_id())
 
1149
                    except errors.NoWorkingTree:
 
1150
                        pass
 
1151
            finally:
 
1152
                wt.unlock()
 
1153
        else:
 
1154
            wt = None
 
1155
        if recurse == 'down':
 
1156
            if wt is not None:
 
1157
                basis = wt.basis_tree()
 
1158
                basis.lock_read()
 
1159
                subtrees = basis.iter_references()
 
1160
            elif source_branch is not None:
 
1161
                basis = source_branch.basis_tree()
 
1162
                basis.lock_read()
 
1163
                subtrees = basis.iter_references()
 
1164
            else:
 
1165
                subtrees = []
 
1166
                basis = None
 
1167
            try:
 
1168
                for path, file_id in subtrees:
 
1169
                    target = urlutils.join(url, urlutils.escape(path))
 
1170
                    sublocation = source_branch.reference_parent(file_id, path)
 
1171
                    sublocation.bzrdir.sprout(target,
 
1172
                        basis.get_reference_revision(file_id, path),
 
1173
                        force_new_repo=force_new_repo, recurse=recurse,
 
1174
                        stacked=stacked)
 
1175
            finally:
 
1176
                if basis is not None:
 
1177
                    basis.unlock()
 
1178
        return result
 
1179
 
 
1180
 
 
1181
class BzrDirPreSplitOut(BzrDir):
 
1182
    """A common class for the all-in-one formats."""
 
1183
 
 
1184
    def __init__(self, _transport, _format):
 
1185
        """See BzrDir.__init__."""
 
1186
        super(BzrDirPreSplitOut, self).__init__(_transport, _format)
 
1187
        self._control_files = lockable_files.LockableFiles(
 
1188
                                            self.get_branch_transport(None),
 
1189
                                            self._format._lock_file_name,
 
1190
                                            self._format._lock_class)
 
1191
 
 
1192
    def break_lock(self):
 
1193
        """Pre-splitout bzrdirs do not suffer from stale locks."""
 
1194
        raise NotImplementedError(self.break_lock)
 
1195
 
 
1196
    def cloning_metadir(self, require_stacking=False):
 
1197
        """Produce a metadir suitable for cloning with."""
 
1198
        if require_stacking:
 
1199
            return format_registry.make_bzrdir('1.6')
 
1200
        return self._format.__class__()
 
1201
 
 
1202
    def clone(self, url, revision_id=None, force_new_repo=False,
 
1203
              preserve_stacking=False):
 
1204
        """See BzrDir.clone().
 
1205
 
 
1206
        force_new_repo has no effect, since this family of formats always
 
1207
        require a new repository.
 
1208
        preserve_stacking has no effect, since no source branch using this
 
1209
        family of formats can be stacked, so there is no stacking to preserve.
 
1210
        """
 
1211
        self._make_tail(url)
 
1212
        result = self._format._initialize_for_clone(url)
 
1213
        self.open_repository().clone(result, revision_id=revision_id)
 
1214
        from_branch = self.open_branch()
 
1215
        from_branch.clone(result, revision_id=revision_id)
 
1216
        try:
 
1217
            tree = self.open_workingtree()
 
1218
        except errors.NotLocalUrl:
 
1219
            # make a new one, this format always has to have one.
 
1220
            result._init_workingtree()
 
1221
        else:
 
1222
            tree.clone(result)
 
1223
        return result
 
1224
 
 
1225
    def create_branch(self):
 
1226
        """See BzrDir.create_branch."""
 
1227
        return self._format.get_branch_format().initialize(self)
 
1228
 
 
1229
    def destroy_branch(self):
 
1230
        """See BzrDir.destroy_branch."""
 
1231
        raise errors.UnsupportedOperation(self.destroy_branch, self)
 
1232
 
 
1233
    def create_repository(self, shared=False):
 
1234
        """See BzrDir.create_repository."""
 
1235
        if shared:
 
1236
            raise errors.IncompatibleFormat('shared repository', self._format)
 
1237
        return self.open_repository()
 
1238
 
 
1239
    def destroy_repository(self):
 
1240
        """See BzrDir.destroy_repository."""
 
1241
        raise errors.UnsupportedOperation(self.destroy_repository, self)
 
1242
 
 
1243
    def create_workingtree(self, revision_id=None, from_branch=None,
 
1244
                           accelerator_tree=None, hardlink=False):
 
1245
        """See BzrDir.create_workingtree."""
 
1246
        # The workingtree is sometimes created when the bzrdir is created,
 
1247
        # but not when cloning.
 
1248
 
 
1249
        # this looks buggy but is not -really-
 
1250
        # because this format creates the workingtree when the bzrdir is
 
1251
        # created
 
1252
        # clone and sprout will have set the revision_id
 
1253
        # and that will have set it for us, its only
 
1254
        # specific uses of create_workingtree in isolation
 
1255
        # that can do wonky stuff here, and that only
 
1256
        # happens for creating checkouts, which cannot be 
 
1257
        # done on this format anyway. So - acceptable wart.
 
1258
        try:
 
1259
            result = self.open_workingtree(recommend_upgrade=False)
 
1260
        except errors.NoSuchFile:
 
1261
            result = self._init_workingtree()
 
1262
        if revision_id is not None:
 
1263
            if revision_id == _mod_revision.NULL_REVISION:
 
1264
                result.set_parent_ids([])
 
1265
            else:
 
1266
                result.set_parent_ids([revision_id])
 
1267
        return result
 
1268
 
 
1269
    def _init_workingtree(self):
 
1270
        from bzrlib.workingtree import WorkingTreeFormat2
 
1271
        try:
 
1272
            return WorkingTreeFormat2().initialize(self)
 
1273
        except errors.NotLocalUrl:
 
1274
            # Even though we can't access the working tree, we need to
 
1275
            # create its control files.
 
1276
            return WorkingTreeFormat2()._stub_initialize_on_transport(
 
1277
                self.transport, self._control_files._file_mode)
 
1278
 
 
1279
    def destroy_workingtree(self):
 
1280
        """See BzrDir.destroy_workingtree."""
 
1281
        raise errors.UnsupportedOperation(self.destroy_workingtree, self)
 
1282
 
 
1283
    def destroy_workingtree_metadata(self):
 
1284
        """See BzrDir.destroy_workingtree_metadata."""
 
1285
        raise errors.UnsupportedOperation(self.destroy_workingtree_metadata, 
 
1286
                                          self)
 
1287
 
 
1288
    def get_branch_transport(self, branch_format):
 
1289
        """See BzrDir.get_branch_transport()."""
 
1290
        if branch_format is None:
 
1291
            return self.transport
 
1292
        try:
 
1293
            branch_format.get_format_string()
 
1294
        except NotImplementedError:
 
1295
            return self.transport
 
1296
        raise errors.IncompatibleFormat(branch_format, self._format)
 
1297
 
 
1298
    def get_repository_transport(self, repository_format):
 
1299
        """See BzrDir.get_repository_transport()."""
 
1300
        if repository_format is None:
 
1301
            return self.transport
 
1302
        try:
 
1303
            repository_format.get_format_string()
 
1304
        except NotImplementedError:
 
1305
            return self.transport
 
1306
        raise errors.IncompatibleFormat(repository_format, self._format)
 
1307
 
 
1308
    def get_workingtree_transport(self, workingtree_format):
 
1309
        """See BzrDir.get_workingtree_transport()."""
 
1310
        if workingtree_format is None:
 
1311
            return self.transport
 
1312
        try:
 
1313
            workingtree_format.get_format_string()
 
1314
        except NotImplementedError:
 
1315
            return self.transport
 
1316
        raise errors.IncompatibleFormat(workingtree_format, self._format)
 
1317
 
 
1318
    def needs_format_conversion(self, format=None):
 
1319
        """See BzrDir.needs_format_conversion()."""
 
1320
        # if the format is not the same as the system default,
 
1321
        # an upgrade is needed.
 
1322
        if format is None:
 
1323
            format = BzrDirFormat.get_default_format()
 
1324
        return not isinstance(self._format, format.__class__)
 
1325
 
 
1326
    def open_branch(self, unsupported=False):
 
1327
        """See BzrDir.open_branch."""
 
1328
        from bzrlib.branch import BzrBranchFormat4
 
1329
        format = BzrBranchFormat4()
 
1330
        self._check_supported(format, unsupported)
 
1331
        return format.open(self, _found=True)
 
1332
 
 
1333
    def sprout(self, url, revision_id=None, force_new_repo=False,
 
1334
               possible_transports=None, accelerator_tree=None,
 
1335
               hardlink=False, stacked=False):
 
1336
        """See BzrDir.sprout()."""
 
1337
        if stacked:
 
1338
            raise errors.UnstackableBranchFormat(
 
1339
                self._format, self.root_transport.base)
 
1340
        from bzrlib.workingtree import WorkingTreeFormat2
 
1341
        self._make_tail(url)
 
1342
        result = self._format._initialize_for_clone(url)
 
1343
        try:
 
1344
            self.open_repository().clone(result, revision_id=revision_id)
 
1345
        except errors.NoRepositoryPresent:
 
1346
            pass
 
1347
        try:
 
1348
            self.open_branch().sprout(result, revision_id=revision_id)
 
1349
        except errors.NotBranchError:
 
1350
            pass
 
1351
        # we always want a working tree
 
1352
        WorkingTreeFormat2().initialize(result,
 
1353
                                        accelerator_tree=accelerator_tree,
 
1354
                                        hardlink=hardlink)
 
1355
        return result
 
1356
 
 
1357
 
 
1358
class BzrDir4(BzrDirPreSplitOut):
 
1359
    """A .bzr version 4 control object.
 
1360
    
 
1361
    This is a deprecated format and may be removed after sept 2006.
 
1362
    """
 
1363
 
 
1364
    def create_repository(self, shared=False):
 
1365
        """See BzrDir.create_repository."""
 
1366
        return self._format.repository_format.initialize(self, shared)
 
1367
 
 
1368
    def needs_format_conversion(self, format=None):
 
1369
        """Format 4 dirs are always in need of conversion."""
 
1370
        return True
 
1371
 
 
1372
    def open_repository(self):
 
1373
        """See BzrDir.open_repository."""
 
1374
        from bzrlib.repofmt.weaverepo import RepositoryFormat4
 
1375
        return RepositoryFormat4().open(self, _found=True)
 
1376
 
 
1377
 
 
1378
class BzrDir5(BzrDirPreSplitOut):
 
1379
    """A .bzr version 5 control object.
 
1380
 
 
1381
    This is a deprecated format and may be removed after sept 2006.
 
1382
    """
 
1383
 
 
1384
    def open_repository(self):
 
1385
        """See BzrDir.open_repository."""
 
1386
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
 
1387
        return RepositoryFormat5().open(self, _found=True)
 
1388
 
 
1389
    def open_workingtree(self, _unsupported=False,
 
1390
            recommend_upgrade=True):
 
1391
        """See BzrDir.create_workingtree."""
 
1392
        from bzrlib.workingtree import WorkingTreeFormat2
 
1393
        wt_format = WorkingTreeFormat2()
 
1394
        # we don't warn here about upgrades; that ought to be handled for the
 
1395
        # bzrdir as a whole
 
1396
        return wt_format.open(self, _found=True)
 
1397
 
 
1398
 
 
1399
class BzrDir6(BzrDirPreSplitOut):
 
1400
    """A .bzr version 6 control object.
 
1401
 
 
1402
    This is a deprecated format and may be removed after sept 2006.
 
1403
    """
 
1404
 
 
1405
    def open_repository(self):
 
1406
        """See BzrDir.open_repository."""
 
1407
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
 
1408
        return RepositoryFormat6().open(self, _found=True)
 
1409
 
 
1410
    def open_workingtree(self, _unsupported=False,
 
1411
        recommend_upgrade=True):
 
1412
        """See BzrDir.create_workingtree."""
 
1413
        # we don't warn here about upgrades; that ought to be handled for the
 
1414
        # bzrdir as a whole
 
1415
        from bzrlib.workingtree import WorkingTreeFormat2
 
1416
        return WorkingTreeFormat2().open(self, _found=True)
 
1417
 
 
1418
 
 
1419
class BzrDirMeta1(BzrDir):
 
1420
    """A .bzr meta version 1 control object.
 
1421
    
 
1422
    This is the first control object where the 
 
1423
    individual aspects are really split out: there are separate repository,
 
1424
    workingtree and branch subdirectories and any subset of the three can be
 
1425
    present within a BzrDir.
 
1426
    """
 
1427
 
 
1428
    def can_convert_format(self):
 
1429
        """See BzrDir.can_convert_format()."""
 
1430
        return True
 
1431
 
 
1432
    def create_branch(self):
 
1433
        """See BzrDir.create_branch."""
 
1434
        return self._format.get_branch_format().initialize(self)
 
1435
 
 
1436
    def destroy_branch(self):
 
1437
        """See BzrDir.create_branch."""
 
1438
        self.transport.delete_tree('branch')
 
1439
 
 
1440
    def create_repository(self, shared=False):
 
1441
        """See BzrDir.create_repository."""
 
1442
        return self._format.repository_format.initialize(self, shared)
 
1443
 
 
1444
    def destroy_repository(self):
 
1445
        """See BzrDir.destroy_repository."""
 
1446
        self.transport.delete_tree('repository')
 
1447
 
 
1448
    def create_workingtree(self, revision_id=None, from_branch=None,
 
1449
                           accelerator_tree=None, hardlink=False):
 
1450
        """See BzrDir.create_workingtree."""
 
1451
        return self._format.workingtree_format.initialize(
 
1452
            self, revision_id, from_branch=from_branch,
 
1453
            accelerator_tree=accelerator_tree, hardlink=hardlink)
 
1454
 
 
1455
    def destroy_workingtree(self):
 
1456
        """See BzrDir.destroy_workingtree."""
 
1457
        wt = self.open_workingtree(recommend_upgrade=False)
 
1458
        repository = wt.branch.repository
 
1459
        empty = repository.revision_tree(_mod_revision.NULL_REVISION)
 
1460
        wt.revert(old_tree=empty)
 
1461
        self.destroy_workingtree_metadata()
 
1462
 
 
1463
    def destroy_workingtree_metadata(self):
 
1464
        self.transport.delete_tree('checkout')
 
1465
 
 
1466
    def find_branch_format(self):
 
1467
        """Find the branch 'format' for this bzrdir.
 
1468
 
 
1469
        This might be a synthetic object for e.g. RemoteBranch and SVN.
 
1470
        """
 
1471
        from bzrlib.branch import BranchFormat
 
1472
        return BranchFormat.find_format(self)
 
1473
 
 
1474
    def _get_mkdir_mode(self):
 
1475
        """Figure out the mode to use when creating a bzrdir subdir."""
 
1476
        temp_control = lockable_files.LockableFiles(self.transport, '',
 
1477
                                     lockable_files.TransportLock)
 
1478
        return temp_control._dir_mode
 
1479
 
 
1480
    def get_branch_reference(self):
 
1481
        """See BzrDir.get_branch_reference()."""
 
1482
        from bzrlib.branch import BranchFormat
 
1483
        format = BranchFormat.find_format(self)
 
1484
        return format.get_reference(self)
 
1485
 
 
1486
    def get_branch_transport(self, branch_format):
 
1487
        """See BzrDir.get_branch_transport()."""
 
1488
        if branch_format is None:
 
1489
            return self.transport.clone('branch')
 
1490
        try:
 
1491
            branch_format.get_format_string()
 
1492
        except NotImplementedError:
 
1493
            raise errors.IncompatibleFormat(branch_format, self._format)
 
1494
        try:
 
1495
            self.transport.mkdir('branch', mode=self._get_mkdir_mode())
 
1496
        except errors.FileExists:
 
1497
            pass
 
1498
        return self.transport.clone('branch')
 
1499
 
 
1500
    def get_repository_transport(self, repository_format):
 
1501
        """See BzrDir.get_repository_transport()."""
 
1502
        if repository_format is None:
 
1503
            return self.transport.clone('repository')
 
1504
        try:
 
1505
            repository_format.get_format_string()
 
1506
        except NotImplementedError:
 
1507
            raise errors.IncompatibleFormat(repository_format, self._format)
 
1508
        try:
 
1509
            self.transport.mkdir('repository', mode=self._get_mkdir_mode())
 
1510
        except errors.FileExists:
 
1511
            pass
 
1512
        return self.transport.clone('repository')
 
1513
 
 
1514
    def get_workingtree_transport(self, workingtree_format):
 
1515
        """See BzrDir.get_workingtree_transport()."""
 
1516
        if workingtree_format is None:
 
1517
            return self.transport.clone('checkout')
 
1518
        try:
 
1519
            workingtree_format.get_format_string()
 
1520
        except NotImplementedError:
 
1521
            raise errors.IncompatibleFormat(workingtree_format, self._format)
 
1522
        try:
 
1523
            self.transport.mkdir('checkout', mode=self._get_mkdir_mode())
 
1524
        except errors.FileExists:
 
1525
            pass
 
1526
        return self.transport.clone('checkout')
 
1527
 
 
1528
    def needs_format_conversion(self, format=None):
 
1529
        """See BzrDir.needs_format_conversion()."""
 
1530
        if format is None:
 
1531
            format = BzrDirFormat.get_default_format()
 
1532
        if not isinstance(self._format, format.__class__):
 
1533
            # it is not a meta dir format, conversion is needed.
 
1534
            return True
 
1535
        # we might want to push this down to the repository?
 
1536
        try:
 
1537
            if not isinstance(self.open_repository()._format,
 
1538
                              format.repository_format.__class__):
 
1539
                # the repository needs an upgrade.
 
1540
                return True
 
1541
        except errors.NoRepositoryPresent:
 
1542
            pass
 
1543
        try:
 
1544
            if not isinstance(self.open_branch()._format,
 
1545
                              format.get_branch_format().__class__):
 
1546
                # the branch needs an upgrade.
 
1547
                return True
 
1548
        except errors.NotBranchError:
 
1549
            pass
 
1550
        try:
 
1551
            my_wt = self.open_workingtree(recommend_upgrade=False)
 
1552
            if not isinstance(my_wt._format,
 
1553
                              format.workingtree_format.__class__):
 
1554
                # the workingtree needs an upgrade.
 
1555
                return True
 
1556
        except (errors.NoWorkingTree, errors.NotLocalUrl):
 
1557
            pass
 
1558
        return False
 
1559
 
 
1560
    def open_branch(self, unsupported=False):
 
1561
        """See BzrDir.open_branch."""
 
1562
        format = self.find_branch_format()
 
1563
        self._check_supported(format, unsupported)
 
1564
        return format.open(self, _found=True)
 
1565
 
 
1566
    def open_repository(self, unsupported=False):
 
1567
        """See BzrDir.open_repository."""
 
1568
        from bzrlib.repository import RepositoryFormat
 
1569
        format = RepositoryFormat.find_format(self)
 
1570
        self._check_supported(format, unsupported)
 
1571
        return format.open(self, _found=True)
 
1572
 
 
1573
    def open_workingtree(self, unsupported=False,
 
1574
            recommend_upgrade=True):
 
1575
        """See BzrDir.open_workingtree."""
 
1576
        from bzrlib.workingtree import WorkingTreeFormat
 
1577
        format = WorkingTreeFormat.find_format(self)
 
1578
        self._check_supported(format, unsupported,
 
1579
            recommend_upgrade,
 
1580
            basedir=self.root_transport.base)
 
1581
        return format.open(self, _found=True)
 
1582
 
 
1583
    def _get_config(self):
 
1584
        return config.BzrDirConfig(self.transport)
 
1585
 
 
1586
 
 
1587
class BzrDirFormat(object):
 
1588
    """An encapsulation of the initialization and open routines for a format.
 
1589
 
 
1590
    Formats provide three things:
 
1591
     * An initialization routine,
 
1592
     * a format string,
 
1593
     * an open routine.
 
1594
 
 
1595
    Formats are placed in a dict by their format string for reference 
 
1596
    during bzrdir opening. These should be subclasses of BzrDirFormat
 
1597
    for consistency.
 
1598
 
 
1599
    Once a format is deprecated, just deprecate the initialize and open
 
1600
    methods on the format class. Do not deprecate the object, as the 
 
1601
    object will be created every system load.
 
1602
    """
 
1603
 
 
1604
    _default_format = None
 
1605
    """The default format used for new .bzr dirs."""
 
1606
 
 
1607
    _formats = {}
 
1608
    """The known formats."""
 
1609
 
 
1610
    _control_formats = []
 
1611
    """The registered control formats - .bzr, ....
 
1612
    
 
1613
    This is a list of BzrDirFormat objects.
 
1614
    """
 
1615
 
 
1616
    _control_server_formats = []
 
1617
    """The registered control server formats, e.g. RemoteBzrDirs.
 
1618
 
 
1619
    This is a list of BzrDirFormat objects.
 
1620
    """
 
1621
 
 
1622
    _lock_file_name = 'branch-lock'
 
1623
 
 
1624
    # _lock_class must be set in subclasses to the lock type, typ.
 
1625
    # TransportLock or LockDir
 
1626
 
 
1627
    @classmethod
 
1628
    def find_format(klass, transport, _server_formats=True):
 
1629
        """Return the format present at transport."""
 
1630
        if _server_formats:
 
1631
            formats = klass._control_server_formats + klass._control_formats
 
1632
        else:
 
1633
            formats = klass._control_formats
 
1634
        for format in formats:
 
1635
            try:
 
1636
                return format.probe_transport(transport)
 
1637
            except errors.NotBranchError:
 
1638
                # this format does not find a control dir here.
 
1639
                pass
 
1640
        raise errors.NotBranchError(path=transport.base)
 
1641
 
 
1642
    @classmethod
 
1643
    def probe_transport(klass, transport):
 
1644
        """Return the .bzrdir style format present in a directory."""
 
1645
        try:
 
1646
            format_string = transport.get(".bzr/branch-format").read()
 
1647
        except errors.NoSuchFile:
 
1648
            raise errors.NotBranchError(path=transport.base)
 
1649
 
 
1650
        try:
 
1651
            return klass._formats[format_string]
 
1652
        except KeyError:
 
1653
            raise errors.UnknownFormatError(format=format_string, kind='bzrdir')
 
1654
 
 
1655
    @classmethod
 
1656
    def get_default_format(klass):
 
1657
        """Return the current default format."""
 
1658
        return klass._default_format
 
1659
 
 
1660
    def get_format_string(self):
 
1661
        """Return the ASCII format string that identifies this format."""
 
1662
        raise NotImplementedError(self.get_format_string)
 
1663
 
 
1664
    def get_format_description(self):
 
1665
        """Return the short description for this format."""
 
1666
        raise NotImplementedError(self.get_format_description)
 
1667
 
 
1668
    def get_converter(self, format=None):
 
1669
        """Return the converter to use to convert bzrdirs needing converts.
 
1670
 
 
1671
        This returns a bzrlib.bzrdir.Converter object.
 
1672
 
 
1673
        This should return the best upgrader to step this format towards the
 
1674
        current default format. In the case of plugins we can/should provide
 
1675
        some means for them to extend the range of returnable converters.
 
1676
 
 
1677
        :param format: Optional format to override the default format of the 
 
1678
                       library.
 
1679
        """
 
1680
        raise NotImplementedError(self.get_converter)
 
1681
 
 
1682
    def initialize(self, url, possible_transports=None):
 
1683
        """Create a bzr control dir at this url and return an opened copy.
 
1684
        
 
1685
        Subclasses should typically override initialize_on_transport
 
1686
        instead of this method.
 
1687
        """
 
1688
        return self.initialize_on_transport(get_transport(url,
 
1689
                                                          possible_transports))
 
1690
 
 
1691
    def initialize_on_transport(self, transport):
 
1692
        """Initialize a new bzrdir in the base directory of a Transport."""
 
1693
        # Since we don't have a .bzr directory, inherit the
 
1694
        # mode from the root directory
 
1695
        temp_control = lockable_files.LockableFiles(transport,
 
1696
                            '', lockable_files.TransportLock)
 
1697
        temp_control._transport.mkdir('.bzr',
 
1698
                                      # FIXME: RBC 20060121 don't peek under
 
1699
                                      # the covers
 
1700
                                      mode=temp_control._dir_mode)
 
1701
        if sys.platform == 'win32' and isinstance(transport, LocalTransport):
 
1702
            win32utils.set_file_attr_hidden(transport._abspath('.bzr'))
 
1703
        file_mode = temp_control._file_mode
 
1704
        del temp_control
 
1705
        bzrdir_transport = transport.clone('.bzr')
 
1706
        utf8_files = [('README',
 
1707
                       "This is a Bazaar control directory.\n"
 
1708
                       "Do not change any files in this directory.\n"
 
1709
                       "See http://bazaar-vcs.org/ for more information about Bazaar.\n"),
 
1710
                      ('branch-format', self.get_format_string()),
 
1711
                      ]
 
1712
        # NB: no need to escape relative paths that are url safe.
 
1713
        control_files = lockable_files.LockableFiles(bzrdir_transport,
 
1714
            self._lock_file_name, self._lock_class)
 
1715
        control_files.create_lock()
 
1716
        control_files.lock_write()
 
1717
        try:
 
1718
            for (filename, content) in utf8_files:
 
1719
                bzrdir_transport.put_bytes(filename, content,
 
1720
                    mode=file_mode)
 
1721
        finally:
 
1722
            control_files.unlock()
 
1723
        return self.open(transport, _found=True)
 
1724
 
 
1725
    def is_supported(self):
 
1726
        """Is this format supported?
 
1727
 
 
1728
        Supported formats must be initializable and openable.
 
1729
        Unsupported formats may not support initialization or committing or 
 
1730
        some other features depending on the reason for not being supported.
 
1731
        """
 
1732
        return True
 
1733
 
 
1734
    def same_model(self, target_format):
 
1735
        return (self.repository_format.rich_root_data == 
 
1736
            target_format.rich_root_data)
 
1737
 
 
1738
    @classmethod
 
1739
    def known_formats(klass):
 
1740
        """Return all the known formats.
 
1741
        
 
1742
        Concrete formats should override _known_formats.
 
1743
        """
 
1744
        # There is double indirection here to make sure that control 
 
1745
        # formats used by more than one dir format will only be probed 
 
1746
        # once. This can otherwise be quite expensive for remote connections.
 
1747
        result = set()
 
1748
        for format in klass._control_formats:
 
1749
            result.update(format._known_formats())
 
1750
        return result
 
1751
    
 
1752
    @classmethod
 
1753
    def _known_formats(klass):
 
1754
        """Return the known format instances for this control format."""
 
1755
        return set(klass._formats.values())
 
1756
 
 
1757
    def open(self, transport, _found=False):
 
1758
        """Return an instance of this format for the dir transport points at.
 
1759
        
 
1760
        _found is a private parameter, do not use it.
 
1761
        """
 
1762
        if not _found:
 
1763
            found_format = BzrDirFormat.find_format(transport)
 
1764
            if not isinstance(found_format, self.__class__):
 
1765
                raise AssertionError("%s was asked to open %s, but it seems to need "
 
1766
                        "format %s" 
 
1767
                        % (self, transport, found_format))
 
1768
        return self._open(transport)
 
1769
 
 
1770
    def _open(self, transport):
 
1771
        """Template method helper for opening BzrDirectories.
 
1772
 
 
1773
        This performs the actual open and any additional logic or parameter
 
1774
        passing.
 
1775
        """
 
1776
        raise NotImplementedError(self._open)
 
1777
 
 
1778
    @classmethod
 
1779
    def register_format(klass, format):
 
1780
        klass._formats[format.get_format_string()] = format
 
1781
 
 
1782
    @classmethod
 
1783
    def register_control_format(klass, format):
 
1784
        """Register a format that does not use '.bzr' for its control dir.
 
1785
 
 
1786
        TODO: This should be pulled up into a 'ControlDirFormat' base class
 
1787
        which BzrDirFormat can inherit from, and renamed to register_format 
 
1788
        there. It has been done without that for now for simplicity of
 
1789
        implementation.
 
1790
        """
 
1791
        klass._control_formats.append(format)
 
1792
 
 
1793
    @classmethod
 
1794
    def register_control_server_format(klass, format):
 
1795
        """Register a control format for client-server environments.
 
1796
 
 
1797
        These formats will be tried before ones registered with
 
1798
        register_control_format.  This gives implementations that decide to the
 
1799
        chance to grab it before anything looks at the contents of the format
 
1800
        file.
 
1801
        """
 
1802
        klass._control_server_formats.append(format)
 
1803
 
 
1804
    @classmethod
 
1805
    def _set_default_format(klass, format):
 
1806
        """Set default format (for testing behavior of defaults only)"""
 
1807
        klass._default_format = format
 
1808
 
 
1809
    def __str__(self):
 
1810
        # Trim the newline
 
1811
        return self.get_format_string().rstrip()
 
1812
 
 
1813
    @classmethod
 
1814
    def unregister_format(klass, format):
 
1815
        del klass._formats[format.get_format_string()]
 
1816
 
 
1817
    @classmethod
 
1818
    def unregister_control_format(klass, format):
 
1819
        klass._control_formats.remove(format)
 
1820
 
 
1821
 
 
1822
class BzrDirFormat4(BzrDirFormat):
 
1823
    """Bzr dir format 4.
 
1824
 
 
1825
    This format is a combined format for working tree, branch and repository.
 
1826
    It has:
 
1827
     - Format 1 working trees [always]
 
1828
     - Format 4 branches [always]
 
1829
     - Format 4 repositories [always]
 
1830
 
 
1831
    This format is deprecated: it indexes texts using a text it which is
 
1832
    removed in format 5; write support for this format has been removed.
 
1833
    """
 
1834
 
 
1835
    _lock_class = lockable_files.TransportLock
 
1836
 
 
1837
    def get_format_string(self):
 
1838
        """See BzrDirFormat.get_format_string()."""
 
1839
        return "Bazaar-NG branch, format 0.0.4\n"
 
1840
 
 
1841
    def get_format_description(self):
 
1842
        """See BzrDirFormat.get_format_description()."""
 
1843
        return "All-in-one format 4"
 
1844
 
 
1845
    def get_converter(self, format=None):
 
1846
        """See BzrDirFormat.get_converter()."""
 
1847
        # there is one and only one upgrade path here.
 
1848
        return ConvertBzrDir4To5()
 
1849
        
 
1850
    def initialize_on_transport(self, transport):
 
1851
        """Format 4 branches cannot be created."""
 
1852
        raise errors.UninitializableFormat(self)
 
1853
 
 
1854
    def is_supported(self):
 
1855
        """Format 4 is not supported.
 
1856
 
 
1857
        It is not supported because the model changed from 4 to 5 and the
 
1858
        conversion logic is expensive - so doing it on the fly was not 
 
1859
        feasible.
 
1860
        """
 
1861
        return False
 
1862
 
 
1863
    def _open(self, transport):
 
1864
        """See BzrDirFormat._open."""
 
1865
        return BzrDir4(transport, self)
 
1866
 
 
1867
    def __return_repository_format(self):
 
1868
        """Circular import protection."""
 
1869
        from bzrlib.repofmt.weaverepo import RepositoryFormat4
 
1870
        return RepositoryFormat4()
 
1871
    repository_format = property(__return_repository_format)
 
1872
 
 
1873
 
 
1874
class BzrDirFormat5(BzrDirFormat):
 
1875
    """Bzr control format 5.
 
1876
 
 
1877
    This format is a combined format for working tree, branch and repository.
 
1878
    It has:
 
1879
     - Format 2 working trees [always] 
 
1880
     - Format 4 branches [always] 
 
1881
     - Format 5 repositories [always]
 
1882
       Unhashed stores in the repository.
 
1883
    """
 
1884
 
 
1885
    _lock_class = lockable_files.TransportLock
 
1886
 
 
1887
    def get_format_string(self):
 
1888
        """See BzrDirFormat.get_format_string()."""
 
1889
        return "Bazaar-NG branch, format 5\n"
 
1890
 
 
1891
    def get_branch_format(self):
 
1892
        from bzrlib import branch
 
1893
        return branch.BzrBranchFormat4()
 
1894
 
 
1895
    def get_format_description(self):
 
1896
        """See BzrDirFormat.get_format_description()."""
 
1897
        return "All-in-one format 5"
 
1898
 
 
1899
    def get_converter(self, format=None):
 
1900
        """See BzrDirFormat.get_converter()."""
 
1901
        # there is one and only one upgrade path here.
 
1902
        return ConvertBzrDir5To6()
 
1903
 
 
1904
    def _initialize_for_clone(self, url):
 
1905
        return self.initialize_on_transport(get_transport(url), _cloning=True)
 
1906
        
 
1907
    def initialize_on_transport(self, transport, _cloning=False):
 
1908
        """Format 5 dirs always have working tree, branch and repository.
 
1909
        
 
1910
        Except when they are being cloned.
 
1911
        """
 
1912
        from bzrlib.branch import BzrBranchFormat4
 
1913
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
 
1914
        result = (super(BzrDirFormat5, self).initialize_on_transport(transport))
 
1915
        RepositoryFormat5().initialize(result, _internal=True)
 
1916
        if not _cloning:
 
1917
            branch = BzrBranchFormat4().initialize(result)
 
1918
            result._init_workingtree()
 
1919
        return result
 
1920
 
 
1921
    def _open(self, transport):
 
1922
        """See BzrDirFormat._open."""
 
1923
        return BzrDir5(transport, self)
 
1924
 
 
1925
    def __return_repository_format(self):
 
1926
        """Circular import protection."""
 
1927
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
 
1928
        return RepositoryFormat5()
 
1929
    repository_format = property(__return_repository_format)
 
1930
 
 
1931
 
 
1932
class BzrDirFormat6(BzrDirFormat):
 
1933
    """Bzr control format 6.
 
1934
 
 
1935
    This format is a combined format for working tree, branch and repository.
 
1936
    It has:
 
1937
     - Format 2 working trees [always] 
 
1938
     - Format 4 branches [always] 
 
1939
     - Format 6 repositories [always]
 
1940
    """
 
1941
 
 
1942
    _lock_class = lockable_files.TransportLock
 
1943
 
 
1944
    def get_format_string(self):
 
1945
        """See BzrDirFormat.get_format_string()."""
 
1946
        return "Bazaar-NG branch, format 6\n"
 
1947
 
 
1948
    def get_format_description(self):
 
1949
        """See BzrDirFormat.get_format_description()."""
 
1950
        return "All-in-one format 6"
 
1951
 
 
1952
    def get_branch_format(self):
 
1953
        from bzrlib import branch
 
1954
        return branch.BzrBranchFormat4()
 
1955
 
 
1956
    def get_converter(self, format=None):
 
1957
        """See BzrDirFormat.get_converter()."""
 
1958
        # there is one and only one upgrade path here.
 
1959
        return ConvertBzrDir6ToMeta()
 
1960
        
 
1961
    def _initialize_for_clone(self, url):
 
1962
        return self.initialize_on_transport(get_transport(url), _cloning=True)
 
1963
 
 
1964
    def initialize_on_transport(self, transport, _cloning=False):
 
1965
        """Format 6 dirs always have working tree, branch and repository.
 
1966
        
 
1967
        Except when they are being cloned.
 
1968
        """
 
1969
        from bzrlib.branch import BzrBranchFormat4
 
1970
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
 
1971
        result = super(BzrDirFormat6, self).initialize_on_transport(transport)
 
1972
        RepositoryFormat6().initialize(result, _internal=True)
 
1973
        if not _cloning:
 
1974
            branch = BzrBranchFormat4().initialize(result)
 
1975
            result._init_workingtree()
 
1976
        return result
 
1977
 
 
1978
    def _open(self, transport):
 
1979
        """See BzrDirFormat._open."""
 
1980
        return BzrDir6(transport, self)
 
1981
 
 
1982
    def __return_repository_format(self):
 
1983
        """Circular import protection."""
 
1984
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
 
1985
        return RepositoryFormat6()
 
1986
    repository_format = property(__return_repository_format)
 
1987
 
 
1988
 
 
1989
class BzrDirMetaFormat1(BzrDirFormat):
 
1990
    """Bzr meta control format 1
 
1991
 
 
1992
    This is the first format with split out working tree, branch and repository
 
1993
    disk storage.
 
1994
    It has:
 
1995
     - Format 3 working trees [optional]
 
1996
     - Format 5 branches [optional]
 
1997
     - Format 7 repositories [optional]
 
1998
    """
 
1999
 
 
2000
    _lock_class = lockdir.LockDir
 
2001
 
 
2002
    def __init__(self):
 
2003
        self._workingtree_format = None
 
2004
        self._branch_format = None
 
2005
 
 
2006
    def __eq__(self, other):
 
2007
        if other.__class__ is not self.__class__:
 
2008
            return False
 
2009
        if other.repository_format != self.repository_format:
 
2010
            return False
 
2011
        if other.workingtree_format != self.workingtree_format:
 
2012
            return False
 
2013
        return True
 
2014
 
 
2015
    def __ne__(self, other):
 
2016
        return not self == other
 
2017
 
 
2018
    def get_branch_format(self):
 
2019
        if self._branch_format is None:
 
2020
            from bzrlib.branch import BranchFormat
 
2021
            self._branch_format = BranchFormat.get_default_format()
 
2022
        return self._branch_format
 
2023
 
 
2024
    def set_branch_format(self, format):
 
2025
        self._branch_format = format
 
2026
 
 
2027
    def get_converter(self, format=None):
 
2028
        """See BzrDirFormat.get_converter()."""
 
2029
        if format is None:
 
2030
            format = BzrDirFormat.get_default_format()
 
2031
        if not isinstance(self, format.__class__):
 
2032
            # converting away from metadir is not implemented
 
2033
            raise NotImplementedError(self.get_converter)
 
2034
        return ConvertMetaToMeta(format)
 
2035
 
 
2036
    def get_format_string(self):
 
2037
        """See BzrDirFormat.get_format_string()."""
 
2038
        return "Bazaar-NG meta directory, format 1\n"
 
2039
 
 
2040
    def get_format_description(self):
 
2041
        """See BzrDirFormat.get_format_description()."""
 
2042
        return "Meta directory format 1"
 
2043
 
 
2044
    def _open(self, transport):
 
2045
        """See BzrDirFormat._open."""
 
2046
        return BzrDirMeta1(transport, self)
 
2047
 
 
2048
    def __return_repository_format(self):
 
2049
        """Circular import protection."""
 
2050
        if getattr(self, '_repository_format', None):
 
2051
            return self._repository_format
 
2052
        from bzrlib.repository import RepositoryFormat
 
2053
        return RepositoryFormat.get_default_format()
 
2054
 
 
2055
    def __set_repository_format(self, value):
 
2056
        """Allow changing the repository format for metadir formats."""
 
2057
        self._repository_format = value
 
2058
 
 
2059
    repository_format = property(__return_repository_format, __set_repository_format)
 
2060
 
 
2061
    def __get_workingtree_format(self):
 
2062
        if self._workingtree_format is None:
 
2063
            from bzrlib.workingtree import WorkingTreeFormat
 
2064
            self._workingtree_format = WorkingTreeFormat.get_default_format()
 
2065
        return self._workingtree_format
 
2066
 
 
2067
    def __set_workingtree_format(self, wt_format):
 
2068
        self._workingtree_format = wt_format
 
2069
 
 
2070
    workingtree_format = property(__get_workingtree_format,
 
2071
                                  __set_workingtree_format)
 
2072
 
 
2073
 
 
2074
# Register bzr control format
 
2075
BzrDirFormat.register_control_format(BzrDirFormat)
 
2076
 
 
2077
# Register bzr formats
 
2078
BzrDirFormat.register_format(BzrDirFormat4())
 
2079
BzrDirFormat.register_format(BzrDirFormat5())
 
2080
BzrDirFormat.register_format(BzrDirFormat6())
 
2081
__default_format = BzrDirMetaFormat1()
 
2082
BzrDirFormat.register_format(__default_format)
 
2083
BzrDirFormat._default_format = __default_format
 
2084
 
 
2085
 
 
2086
class Converter(object):
 
2087
    """Converts a disk format object from one format to another."""
 
2088
 
 
2089
    def convert(self, to_convert, pb):
 
2090
        """Perform the conversion of to_convert, giving feedback via pb.
 
2091
 
 
2092
        :param to_convert: The disk object to convert.
 
2093
        :param pb: a progress bar to use for progress information.
 
2094
        """
 
2095
 
 
2096
    def step(self, message):
 
2097
        """Update the pb by a step."""
 
2098
        self.count +=1
 
2099
        self.pb.update(message, self.count, self.total)
 
2100
 
 
2101
 
 
2102
class ConvertBzrDir4To5(Converter):
 
2103
    """Converts format 4 bzr dirs to format 5."""
 
2104
 
 
2105
    def __init__(self):
 
2106
        super(ConvertBzrDir4To5, self).__init__()
 
2107
        self.converted_revs = set()
 
2108
        self.absent_revisions = set()
 
2109
        self.text_count = 0
 
2110
        self.revisions = {}
 
2111
        
 
2112
    def convert(self, to_convert, pb):
 
2113
        """See Converter.convert()."""
 
2114
        self.bzrdir = to_convert
 
2115
        self.pb = pb
 
2116
        self.pb.note('starting upgrade from format 4 to 5')
 
2117
        if isinstance(self.bzrdir.transport, LocalTransport):
 
2118
            self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
 
2119
        self._convert_to_weaves()
 
2120
        return BzrDir.open(self.bzrdir.root_transport.base)
 
2121
 
 
2122
    def _convert_to_weaves(self):
 
2123
        self.pb.note('note: upgrade may be faster if all store files are ungzipped first')
 
2124
        try:
 
2125
            # TODO permissions
 
2126
            stat = self.bzrdir.transport.stat('weaves')
 
2127
            if not S_ISDIR(stat.st_mode):
 
2128
                self.bzrdir.transport.delete('weaves')
 
2129
                self.bzrdir.transport.mkdir('weaves')
 
2130
        except errors.NoSuchFile:
 
2131
            self.bzrdir.transport.mkdir('weaves')
 
2132
        # deliberately not a WeaveFile as we want to build it up slowly.
 
2133
        self.inv_weave = Weave('inventory')
 
2134
        # holds in-memory weaves for all files
 
2135
        self.text_weaves = {}
 
2136
        self.bzrdir.transport.delete('branch-format')
 
2137
        self.branch = self.bzrdir.open_branch()
 
2138
        self._convert_working_inv()
 
2139
        rev_history = self.branch.revision_history()
 
2140
        # to_read is a stack holding the revisions we still need to process;
 
2141
        # appending to it adds new highest-priority revisions
 
2142
        self.known_revisions = set(rev_history)
 
2143
        self.to_read = rev_history[-1:]
 
2144
        while self.to_read:
 
2145
            rev_id = self.to_read.pop()
 
2146
            if (rev_id not in self.revisions
 
2147
                and rev_id not in self.absent_revisions):
 
2148
                self._load_one_rev(rev_id)
 
2149
        self.pb.clear()
 
2150
        to_import = self._make_order()
 
2151
        for i, rev_id in enumerate(to_import):
 
2152
            self.pb.update('converting revision', i, len(to_import))
 
2153
            self._convert_one_rev(rev_id)
 
2154
        self.pb.clear()
 
2155
        self._write_all_weaves()
 
2156
        self._write_all_revs()
 
2157
        self.pb.note('upgraded to weaves:')
 
2158
        self.pb.note('  %6d revisions and inventories', len(self.revisions))
 
2159
        self.pb.note('  %6d revisions not present', len(self.absent_revisions))
 
2160
        self.pb.note('  %6d texts', self.text_count)
 
2161
        self._cleanup_spare_files_after_format4()
 
2162
        self.branch._transport.put_bytes(
 
2163
            'branch-format',
 
2164
            BzrDirFormat5().get_format_string(),
 
2165
            mode=self.bzrdir._get_file_mode())
 
2166
 
 
2167
    def _cleanup_spare_files_after_format4(self):
 
2168
        # FIXME working tree upgrade foo.
 
2169
        for n in 'merged-patches', 'pending-merged-patches':
 
2170
            try:
 
2171
                ## assert os.path.getsize(p) == 0
 
2172
                self.bzrdir.transport.delete(n)
 
2173
            except errors.NoSuchFile:
 
2174
                pass
 
2175
        self.bzrdir.transport.delete_tree('inventory-store')
 
2176
        self.bzrdir.transport.delete_tree('text-store')
 
2177
 
 
2178
    def _convert_working_inv(self):
 
2179
        inv = xml4.serializer_v4.read_inventory(
 
2180
                self.branch._transport.get('inventory'))
 
2181
        new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv, working=True)
 
2182
        self.branch._transport.put_bytes('inventory', new_inv_xml,
 
2183
            mode=self.bzrdir._get_file_mode())
 
2184
 
 
2185
    def _write_all_weaves(self):
 
2186
        controlweaves = WeaveStore(self.bzrdir.transport, prefixed=False)
 
2187
        weave_transport = self.bzrdir.transport.clone('weaves')
 
2188
        weaves = WeaveStore(weave_transport, prefixed=False)
 
2189
        transaction = WriteTransaction()
 
2190
 
 
2191
        try:
 
2192
            i = 0
 
2193
            for file_id, file_weave in self.text_weaves.items():
 
2194
                self.pb.update('writing weave', i, len(self.text_weaves))
 
2195
                weaves._put_weave(file_id, file_weave, transaction)
 
2196
                i += 1
 
2197
            self.pb.update('inventory', 0, 1)
 
2198
            controlweaves._put_weave('inventory', self.inv_weave, transaction)
 
2199
            self.pb.update('inventory', 1, 1)
 
2200
        finally:
 
2201
            self.pb.clear()
 
2202
 
 
2203
    def _write_all_revs(self):
 
2204
        """Write all revisions out in new form."""
 
2205
        self.bzrdir.transport.delete_tree('revision-store')
 
2206
        self.bzrdir.transport.mkdir('revision-store')
 
2207
        revision_transport = self.bzrdir.transport.clone('revision-store')
 
2208
        # TODO permissions
 
2209
        from bzrlib.xml5 import serializer_v5
 
2210
        from bzrlib.repofmt.weaverepo import RevisionTextStore
 
2211
        revision_store = RevisionTextStore(revision_transport,
 
2212
            serializer_v5, False, versionedfile.PrefixMapper(),
 
2213
            lambda:True, lambda:True)
 
2214
        try:
 
2215
            for i, rev_id in enumerate(self.converted_revs):
 
2216
                self.pb.update('write revision', i, len(self.converted_revs))
 
2217
                text = serializer_v5.write_revision_to_string(
 
2218
                    self.revisions[rev_id])
 
2219
                key = (rev_id,)
 
2220
                revision_store.add_lines(key, None, osutils.split_lines(text))
 
2221
        finally:
 
2222
            self.pb.clear()
 
2223
            
 
2224
    def _load_one_rev(self, rev_id):
 
2225
        """Load a revision object into memory.
 
2226
 
 
2227
        Any parents not either loaded or abandoned get queued to be
 
2228
        loaded."""
 
2229
        self.pb.update('loading revision',
 
2230
                       len(self.revisions),
 
2231
                       len(self.known_revisions))
 
2232
        if not self.branch.repository.has_revision(rev_id):
 
2233
            self.pb.clear()
 
2234
            self.pb.note('revision {%s} not present in branch; '
 
2235
                         'will be converted as a ghost',
 
2236
                         rev_id)
 
2237
            self.absent_revisions.add(rev_id)
 
2238
        else:
 
2239
            rev = self.branch.repository.get_revision(rev_id)
 
2240
            for parent_id in rev.parent_ids:
 
2241
                self.known_revisions.add(parent_id)
 
2242
                self.to_read.append(parent_id)
 
2243
            self.revisions[rev_id] = rev
 
2244
 
 
2245
    def _load_old_inventory(self, rev_id):
 
2246
        old_inv_xml = self.branch.repository.inventory_store.get(rev_id).read()
 
2247
        inv = xml4.serializer_v4.read_inventory_from_string(old_inv_xml)
 
2248
        inv.revision_id = rev_id
 
2249
        rev = self.revisions[rev_id]
 
2250
        return inv
 
2251
 
 
2252
    def _load_updated_inventory(self, rev_id):
 
2253
        inv_xml = self.inv_weave.get_text(rev_id)
 
2254
        inv = xml5.serializer_v5.read_inventory_from_string(inv_xml, rev_id)
 
2255
        return inv
 
2256
 
 
2257
    def _convert_one_rev(self, rev_id):
 
2258
        """Convert revision and all referenced objects to new format."""
 
2259
        rev = self.revisions[rev_id]
 
2260
        inv = self._load_old_inventory(rev_id)
 
2261
        present_parents = [p for p in rev.parent_ids
 
2262
                           if p not in self.absent_revisions]
 
2263
        self._convert_revision_contents(rev, inv, present_parents)
 
2264
        self._store_new_inv(rev, inv, present_parents)
 
2265
        self.converted_revs.add(rev_id)
 
2266
 
 
2267
    def _store_new_inv(self, rev, inv, present_parents):
 
2268
        new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
 
2269
        new_inv_sha1 = sha_string(new_inv_xml)
 
2270
        self.inv_weave.add_lines(rev.revision_id,
 
2271
                                 present_parents,
 
2272
                                 new_inv_xml.splitlines(True))
 
2273
        rev.inventory_sha1 = new_inv_sha1
 
2274
 
 
2275
    def _convert_revision_contents(self, rev, inv, present_parents):
 
2276
        """Convert all the files within a revision.
 
2277
 
 
2278
        Also upgrade the inventory to refer to the text revision ids."""
 
2279
        rev_id = rev.revision_id
 
2280
        mutter('converting texts of revision {%s}',
 
2281
               rev_id)
 
2282
        parent_invs = map(self._load_updated_inventory, present_parents)
 
2283
        entries = inv.iter_entries()
 
2284
        entries.next()
 
2285
        for path, ie in entries:
 
2286
            self._convert_file_version(rev, ie, parent_invs)
 
2287
 
 
2288
    def _convert_file_version(self, rev, ie, parent_invs):
 
2289
        """Convert one version of one file.
 
2290
 
 
2291
        The file needs to be added into the weave if it is a merge
 
2292
        of >=2 parents or if it's changed from its parent.
 
2293
        """
 
2294
        file_id = ie.file_id
 
2295
        rev_id = rev.revision_id
 
2296
        w = self.text_weaves.get(file_id)
 
2297
        if w is None:
 
2298
            w = Weave(file_id)
 
2299
            self.text_weaves[file_id] = w
 
2300
        text_changed = False
 
2301
        parent_candiate_entries = ie.parent_candidates(parent_invs)
 
2302
        heads = graph.Graph(self).heads(parent_candiate_entries.keys())
 
2303
        # XXX: Note that this is unordered - and this is tolerable because 
 
2304
        # the previous code was also unordered.
 
2305
        previous_entries = dict((head, parent_candiate_entries[head]) for head
 
2306
            in heads)
 
2307
        self.snapshot_ie(previous_entries, ie, w, rev_id)
 
2308
        del ie.text_id
 
2309
 
 
2310
    @symbol_versioning.deprecated_method(symbol_versioning.one_one)
 
2311
    def get_parents(self, revision_ids):
 
2312
        for revision_id in revision_ids:
 
2313
            yield self.revisions[revision_id].parent_ids
 
2314
 
 
2315
    def get_parent_map(self, revision_ids):
 
2316
        """See graph._StackedParentsProvider.get_parent_map"""
 
2317
        return dict((revision_id, self.revisions[revision_id])
 
2318
                    for revision_id in revision_ids
 
2319
                     if revision_id in self.revisions)
 
2320
 
 
2321
    def snapshot_ie(self, previous_revisions, ie, w, rev_id):
 
2322
        # TODO: convert this logic, which is ~= snapshot to
 
2323
        # a call to:. This needs the path figured out. rather than a work_tree
 
2324
        # a v4 revision_tree can be given, or something that looks enough like
 
2325
        # one to give the file content to the entry if it needs it.
 
2326
        # and we need something that looks like a weave store for snapshot to 
 
2327
        # save against.
 
2328
        #ie.snapshot(rev, PATH, previous_revisions, REVISION_TREE, InMemoryWeaveStore(self.text_weaves))
 
2329
        if len(previous_revisions) == 1:
 
2330
            previous_ie = previous_revisions.values()[0]
 
2331
            if ie._unchanged(previous_ie):
 
2332
                ie.revision = previous_ie.revision
 
2333
                return
 
2334
        if ie.has_text():
 
2335
            text = self.branch.repository._text_store.get(ie.text_id)
 
2336
            file_lines = text.readlines()
 
2337
            w.add_lines(rev_id, previous_revisions, file_lines)
 
2338
            self.text_count += 1
 
2339
        else:
 
2340
            w.add_lines(rev_id, previous_revisions, [])
 
2341
        ie.revision = rev_id
 
2342
 
 
2343
    def _make_order(self):
 
2344
        """Return a suitable order for importing revisions.
 
2345
 
 
2346
        The order must be such that an revision is imported after all
 
2347
        its (present) parents.
 
2348
        """
 
2349
        todo = set(self.revisions.keys())
 
2350
        done = self.absent_revisions.copy()
 
2351
        order = []
 
2352
        while todo:
 
2353
            # scan through looking for a revision whose parents
 
2354
            # are all done
 
2355
            for rev_id in sorted(list(todo)):
 
2356
                rev = self.revisions[rev_id]
 
2357
                parent_ids = set(rev.parent_ids)
 
2358
                if parent_ids.issubset(done):
 
2359
                    # can take this one now
 
2360
                    order.append(rev_id)
 
2361
                    todo.remove(rev_id)
 
2362
                    done.add(rev_id)
 
2363
        return order
 
2364
 
 
2365
 
 
2366
class ConvertBzrDir5To6(Converter):
 
2367
    """Converts format 5 bzr dirs to format 6."""
 
2368
 
 
2369
    def convert(self, to_convert, pb):
 
2370
        """See Converter.convert()."""
 
2371
        self.bzrdir = to_convert
 
2372
        self.pb = pb
 
2373
        self.pb.note('starting upgrade from format 5 to 6')
 
2374
        self._convert_to_prefixed()
 
2375
        return BzrDir.open(self.bzrdir.root_transport.base)
 
2376
 
 
2377
    def _convert_to_prefixed(self):
 
2378
        from bzrlib.store import TransportStore
 
2379
        self.bzrdir.transport.delete('branch-format')
 
2380
        for store_name in ["weaves", "revision-store"]:
 
2381
            self.pb.note("adding prefixes to %s" % store_name)
 
2382
            store_transport = self.bzrdir.transport.clone(store_name)
 
2383
            store = TransportStore(store_transport, prefixed=True)
 
2384
            for urlfilename in store_transport.list_dir('.'):
 
2385
                filename = urlutils.unescape(urlfilename)
 
2386
                if (filename.endswith(".weave") or
 
2387
                    filename.endswith(".gz") or
 
2388
                    filename.endswith(".sig")):
 
2389
                    file_id, suffix = os.path.splitext(filename)
 
2390
                else:
 
2391
                    file_id = filename
 
2392
                    suffix = ''
 
2393
                new_name = store._mapper.map((file_id,)) + suffix
 
2394
                # FIXME keep track of the dirs made RBC 20060121
 
2395
                try:
 
2396
                    store_transport.move(filename, new_name)
 
2397
                except errors.NoSuchFile: # catches missing dirs strangely enough
 
2398
                    store_transport.mkdir(osutils.dirname(new_name))
 
2399
                    store_transport.move(filename, new_name)
 
2400
        self.bzrdir.transport.put_bytes(
 
2401
            'branch-format',
 
2402
            BzrDirFormat6().get_format_string(),
 
2403
            mode=self.bzrdir._get_file_mode())
 
2404
 
 
2405
 
 
2406
class ConvertBzrDir6ToMeta(Converter):
 
2407
    """Converts format 6 bzr dirs to metadirs."""
 
2408
 
 
2409
    def convert(self, to_convert, pb):
 
2410
        """See Converter.convert()."""
 
2411
        from bzrlib.repofmt.weaverepo import RepositoryFormat7
 
2412
        from bzrlib.branch import BzrBranchFormat5
 
2413
        self.bzrdir = to_convert
 
2414
        self.pb = pb
 
2415
        self.count = 0
 
2416
        self.total = 20 # the steps we know about
 
2417
        self.garbage_inventories = []
 
2418
        self.dir_mode = self.bzrdir._get_dir_mode()
 
2419
        self.file_mode = self.bzrdir._get_file_mode()
 
2420
 
 
2421
        self.pb.note('starting upgrade from format 6 to metadir')
 
2422
        self.bzrdir.transport.put_bytes(
 
2423
                'branch-format',
 
2424
                "Converting to format 6",
 
2425
                mode=self.file_mode)
 
2426
        # its faster to move specific files around than to open and use the apis...
 
2427
        # first off, nuke ancestry.weave, it was never used.
 
2428
        try:
 
2429
            self.step('Removing ancestry.weave')
 
2430
            self.bzrdir.transport.delete('ancestry.weave')
 
2431
        except errors.NoSuchFile:
 
2432
            pass
 
2433
        # find out whats there
 
2434
        self.step('Finding branch files')
 
2435
        last_revision = self.bzrdir.open_branch().last_revision()
 
2436
        bzrcontents = self.bzrdir.transport.list_dir('.')
 
2437
        for name in bzrcontents:
 
2438
            if name.startswith('basis-inventory.'):
 
2439
                self.garbage_inventories.append(name)
 
2440
        # create new directories for repository, working tree and branch
 
2441
        repository_names = [('inventory.weave', True),
 
2442
                            ('revision-store', True),
 
2443
                            ('weaves', True)]
 
2444
        self.step('Upgrading repository  ')
 
2445
        self.bzrdir.transport.mkdir('repository', mode=self.dir_mode)
 
2446
        self.make_lock('repository')
 
2447
        # we hard code the formats here because we are converting into
 
2448
        # the meta format. The meta format upgrader can take this to a 
 
2449
        # future format within each component.
 
2450
        self.put_format('repository', RepositoryFormat7())
 
2451
        for entry in repository_names:
 
2452
            self.move_entry('repository', entry)
 
2453
 
 
2454
        self.step('Upgrading branch      ')
 
2455
        self.bzrdir.transport.mkdir('branch', mode=self.dir_mode)
 
2456
        self.make_lock('branch')
 
2457
        self.put_format('branch', BzrBranchFormat5())
 
2458
        branch_files = [('revision-history', True),
 
2459
                        ('branch-name', True),
 
2460
                        ('parent', False)]
 
2461
        for entry in branch_files:
 
2462
            self.move_entry('branch', entry)
 
2463
 
 
2464
        checkout_files = [('pending-merges', True),
 
2465
                          ('inventory', True),
 
2466
                          ('stat-cache', False)]
 
2467
        # If a mandatory checkout file is not present, the branch does not have
 
2468
        # a functional checkout. Do not create a checkout in the converted
 
2469
        # branch.
 
2470
        for name, mandatory in checkout_files:
 
2471
            if mandatory and name not in bzrcontents:
 
2472
                has_checkout = False
 
2473
                break
 
2474
        else:
 
2475
            has_checkout = True
 
2476
        if not has_checkout:
 
2477
            self.pb.note('No working tree.')
 
2478
            # If some checkout files are there, we may as well get rid of them.
 
2479
            for name, mandatory in checkout_files:
 
2480
                if name in bzrcontents:
 
2481
                    self.bzrdir.transport.delete(name)
 
2482
        else:
 
2483
            from bzrlib.workingtree import WorkingTreeFormat3
 
2484
            self.step('Upgrading working tree')
 
2485
            self.bzrdir.transport.mkdir('checkout', mode=self.dir_mode)
 
2486
            self.make_lock('checkout')
 
2487
            self.put_format(
 
2488
                'checkout', WorkingTreeFormat3())
 
2489
            self.bzrdir.transport.delete_multi(
 
2490
                self.garbage_inventories, self.pb)
 
2491
            for entry in checkout_files:
 
2492
                self.move_entry('checkout', entry)
 
2493
            if last_revision is not None:
 
2494
                self.bzrdir.transport.put_bytes(
 
2495
                    'checkout/last-revision', last_revision)
 
2496
        self.bzrdir.transport.put_bytes(
 
2497
            'branch-format',
 
2498
            BzrDirMetaFormat1().get_format_string(),
 
2499
            mode=self.file_mode)
 
2500
        return BzrDir.open(self.bzrdir.root_transport.base)
 
2501
 
 
2502
    def make_lock(self, name):
 
2503
        """Make a lock for the new control dir name."""
 
2504
        self.step('Make %s lock' % name)
 
2505
        ld = lockdir.LockDir(self.bzrdir.transport,
 
2506
                             '%s/lock' % name,
 
2507
                             file_modebits=self.file_mode,
 
2508
                             dir_modebits=self.dir_mode)
 
2509
        ld.create()
 
2510
 
 
2511
    def move_entry(self, new_dir, entry):
 
2512
        """Move then entry name into new_dir."""
 
2513
        name = entry[0]
 
2514
        mandatory = entry[1]
 
2515
        self.step('Moving %s' % name)
 
2516
        try:
 
2517
            self.bzrdir.transport.move(name, '%s/%s' % (new_dir, name))
 
2518
        except errors.NoSuchFile:
 
2519
            if mandatory:
 
2520
                raise
 
2521
 
 
2522
    def put_format(self, dirname, format):
 
2523
        self.bzrdir.transport.put_bytes('%s/format' % dirname,
 
2524
            format.get_format_string(),
 
2525
            self.file_mode)
 
2526
 
 
2527
 
 
2528
class ConvertMetaToMeta(Converter):
 
2529
    """Converts the components of metadirs."""
 
2530
 
 
2531
    def __init__(self, target_format):
 
2532
        """Create a metadir to metadir converter.
 
2533
 
 
2534
        :param target_format: The final metadir format that is desired.
 
2535
        """
 
2536
        self.target_format = target_format
 
2537
 
 
2538
    def convert(self, to_convert, pb):
 
2539
        """See Converter.convert()."""
 
2540
        self.bzrdir = to_convert
 
2541
        self.pb = pb
 
2542
        self.count = 0
 
2543
        self.total = 1
 
2544
        self.step('checking repository format')
 
2545
        try:
 
2546
            repo = self.bzrdir.open_repository()
 
2547
        except errors.NoRepositoryPresent:
 
2548
            pass
 
2549
        else:
 
2550
            if not isinstance(repo._format, self.target_format.repository_format.__class__):
 
2551
                from bzrlib.repository import CopyConverter
 
2552
                self.pb.note('starting repository conversion')
 
2553
                converter = CopyConverter(self.target_format.repository_format)
 
2554
                converter.convert(repo, pb)
 
2555
        try:
 
2556
            branch = self.bzrdir.open_branch()
 
2557
        except errors.NotBranchError:
 
2558
            pass
 
2559
        else:
 
2560
            # TODO: conversions of Branch and Tree should be done by
 
2561
            # InterXFormat lookups/some sort of registry.
 
2562
            # Avoid circular imports
 
2563
            from bzrlib import branch as _mod_branch
 
2564
            old = branch._format.__class__
 
2565
            new = self.target_format.get_branch_format().__class__
 
2566
            while old != new:
 
2567
                if (old == _mod_branch.BzrBranchFormat5 and
 
2568
                    new in (_mod_branch.BzrBranchFormat6,
 
2569
                        _mod_branch.BzrBranchFormat7)):
 
2570
                    branch_converter = _mod_branch.Converter5to6()
 
2571
                elif (old == _mod_branch.BzrBranchFormat6 and
 
2572
                    new == _mod_branch.BzrBranchFormat7):
 
2573
                    branch_converter = _mod_branch.Converter6to7()
 
2574
                else:
 
2575
                    raise errors.BadConversionTarget("No converter", new)
 
2576
                branch_converter.convert(branch)
 
2577
                branch = self.bzrdir.open_branch()
 
2578
                old = branch._format.__class__
 
2579
        try:
 
2580
            tree = self.bzrdir.open_workingtree(recommend_upgrade=False)
 
2581
        except (errors.NoWorkingTree, errors.NotLocalUrl):
 
2582
            pass
 
2583
        else:
 
2584
            # TODO: conversions of Branch and Tree should be done by
 
2585
            # InterXFormat lookups
 
2586
            if (isinstance(tree, workingtree.WorkingTree3) and
 
2587
                not isinstance(tree, workingtree_4.WorkingTree4) and
 
2588
                isinstance(self.target_format.workingtree_format,
 
2589
                    workingtree_4.WorkingTreeFormat4)):
 
2590
                workingtree_4.Converter3to4().convert(tree)
 
2591
        return to_convert
 
2592
 
 
2593
 
 
2594
# This is not in remote.py because it's small, and needs to be registered.
 
2595
# Putting it in remote.py creates a circular import problem.
 
2596
# we can make it a lazy object if the control formats is turned into something
 
2597
# like a registry.
 
2598
class RemoteBzrDirFormat(BzrDirMetaFormat1):
 
2599
    """Format representing bzrdirs accessed via a smart server"""
 
2600
 
 
2601
    def get_format_description(self):
 
2602
        return 'bzr remote bzrdir'
 
2603
    
 
2604
    @classmethod
 
2605
    def probe_transport(klass, transport):
 
2606
        """Return a RemoteBzrDirFormat object if it looks possible."""
 
2607
        try:
 
2608
            medium = transport.get_smart_medium()
 
2609
        except (NotImplementedError, AttributeError,
 
2610
                errors.TransportNotPossible, errors.NoSmartMedium,
 
2611
                errors.SmartProtocolError):
 
2612
            # no smart server, so not a branch for this format type.
 
2613
            raise errors.NotBranchError(path=transport.base)
 
2614
        else:
 
2615
            # Decline to open it if the server doesn't support our required
 
2616
            # version (3) so that the VFS-based transport will do it.
 
2617
            if medium.should_probe():
 
2618
                try:
 
2619
                    server_version = medium.protocol_version()
 
2620
                except errors.SmartProtocolError:
 
2621
                    # Apparently there's no usable smart server there, even though
 
2622
                    # the medium supports the smart protocol.
 
2623
                    raise errors.NotBranchError(path=transport.base)
 
2624
                if server_version != '2':
 
2625
                    raise errors.NotBranchError(path=transport.base)
 
2626
            return klass()
 
2627
 
 
2628
    def initialize_on_transport(self, transport):
 
2629
        try:
 
2630
            # hand off the request to the smart server
 
2631
            client_medium = transport.get_smart_medium()
 
2632
        except errors.NoSmartMedium:
 
2633
            # TODO: lookup the local format from a server hint.
 
2634
            local_dir_format = BzrDirMetaFormat1()
 
2635
            return local_dir_format.initialize_on_transport(transport)
 
2636
        client = _SmartClient(client_medium)
 
2637
        path = client.remote_path_from_transport(transport)
 
2638
        response = client.call('BzrDirFormat.initialize', path)
 
2639
        if response[0] != 'ok':
 
2640
            raise errors.SmartProtocolError('unexpected response code %s' % (response,))
 
2641
        return remote.RemoteBzrDir(transport)
 
2642
 
 
2643
    def _open(self, transport):
 
2644
        return remote.RemoteBzrDir(transport)
 
2645
 
 
2646
    def __eq__(self, other):
 
2647
        if not isinstance(other, RemoteBzrDirFormat):
 
2648
            return False
 
2649
        return self.get_format_description() == other.get_format_description()
 
2650
 
 
2651
 
 
2652
BzrDirFormat.register_control_server_format(RemoteBzrDirFormat)
 
2653
 
 
2654
 
 
2655
class BzrDirFormatInfo(object):
 
2656
 
 
2657
    def __init__(self, native, deprecated, hidden, experimental):
 
2658
        self.deprecated = deprecated
 
2659
        self.native = native
 
2660
        self.hidden = hidden
 
2661
        self.experimental = experimental
 
2662
 
 
2663
 
 
2664
class BzrDirFormatRegistry(registry.Registry):
 
2665
    """Registry of user-selectable BzrDir subformats.
 
2666
    
 
2667
    Differs from BzrDirFormat._control_formats in that it provides sub-formats,
 
2668
    e.g. BzrDirMeta1 with weave repository.  Also, it's more user-oriented.
 
2669
    """
 
2670
 
 
2671
    def __init__(self):
 
2672
        """Create a BzrDirFormatRegistry."""
 
2673
        self._aliases = set()
 
2674
        super(BzrDirFormatRegistry, self).__init__()
 
2675
 
 
2676
    def aliases(self):
 
2677
        """Return a set of the format names which are aliases."""
 
2678
        return frozenset(self._aliases)
 
2679
 
 
2680
    def register_metadir(self, key,
 
2681
             repository_format, help, native=True, deprecated=False,
 
2682
             branch_format=None,
 
2683
             tree_format=None,
 
2684
             hidden=False,
 
2685
             experimental=False,
 
2686
             alias=False):
 
2687
        """Register a metadir subformat.
 
2688
 
 
2689
        These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
 
2690
        by the Repository format.
 
2691
 
 
2692
        :param repository_format: The fully-qualified repository format class
 
2693
            name as a string.
 
2694
        :param branch_format: Fully-qualified branch format class name as
 
2695
            a string.
 
2696
        :param tree_format: Fully-qualified tree format class name as
 
2697
            a string.
 
2698
        """
 
2699
        # This should be expanded to support setting WorkingTree and Branch
 
2700
        # formats, once BzrDirMetaFormat1 supports that.
 
2701
        def _load(full_name):
 
2702
            mod_name, factory_name = full_name.rsplit('.', 1)
 
2703
            try:
 
2704
                mod = __import__(mod_name, globals(), locals(),
 
2705
                        [factory_name])
 
2706
            except ImportError, e:
 
2707
                raise ImportError('failed to load %s: %s' % (full_name, e))
 
2708
            try:
 
2709
                factory = getattr(mod, factory_name)
 
2710
            except AttributeError:
 
2711
                raise AttributeError('no factory %s in module %r'
 
2712
                    % (full_name, mod))
 
2713
            return factory()
 
2714
 
 
2715
        def helper():
 
2716
            bd = BzrDirMetaFormat1()
 
2717
            if branch_format is not None:
 
2718
                bd.set_branch_format(_load(branch_format))
 
2719
            if tree_format is not None:
 
2720
                bd.workingtree_format = _load(tree_format)
 
2721
            if repository_format is not None:
 
2722
                bd.repository_format = _load(repository_format)
 
2723
            return bd
 
2724
        self.register(key, helper, help, native, deprecated, hidden,
 
2725
            experimental, alias)
 
2726
 
 
2727
    def register(self, key, factory, help, native=True, deprecated=False,
 
2728
                 hidden=False, experimental=False, alias=False):
 
2729
        """Register a BzrDirFormat factory.
 
2730
        
 
2731
        The factory must be a callable that takes one parameter: the key.
 
2732
        It must produce an instance of the BzrDirFormat when called.
 
2733
 
 
2734
        This function mainly exists to prevent the info object from being
 
2735
        supplied directly.
 
2736
        """
 
2737
        registry.Registry.register(self, key, factory, help,
 
2738
            BzrDirFormatInfo(native, deprecated, hidden, experimental))
 
2739
        if alias:
 
2740
            self._aliases.add(key)
 
2741
 
 
2742
    def register_lazy(self, key, module_name, member_name, help, native=True,
 
2743
        deprecated=False, hidden=False, experimental=False, alias=False):
 
2744
        registry.Registry.register_lazy(self, key, module_name, member_name,
 
2745
            help, BzrDirFormatInfo(native, deprecated, hidden, experimental))
 
2746
        if alias:
 
2747
            self._aliases.add(key)
 
2748
 
 
2749
    def set_default(self, key):
 
2750
        """Set the 'default' key to be a clone of the supplied key.
 
2751
        
 
2752
        This method must be called once and only once.
 
2753
        """
 
2754
        registry.Registry.register(self, 'default', self.get(key),
 
2755
            self.get_help(key), info=self.get_info(key))
 
2756
        self._aliases.add('default')
 
2757
 
 
2758
    def set_default_repository(self, key):
 
2759
        """Set the FormatRegistry default and Repository default.
 
2760
        
 
2761
        This is a transitional method while Repository.set_default_format
 
2762
        is deprecated.
 
2763
        """
 
2764
        if 'default' in self:
 
2765
            self.remove('default')
 
2766
        self.set_default(key)
 
2767
        format = self.get('default')()
 
2768
 
 
2769
    def make_bzrdir(self, key):
 
2770
        return self.get(key)()
 
2771
 
 
2772
    def help_topic(self, topic):
 
2773
        output = textwrap.dedent("""\
 
2774
            These formats can be used for creating branches, working trees, and
 
2775
            repositories.
 
2776
 
 
2777
            """)
 
2778
        default_realkey = None
 
2779
        default_help = self.get_help('default')
 
2780
        help_pairs = []
 
2781
        for key in self.keys():
 
2782
            if key == 'default':
 
2783
                continue
 
2784
            help = self.get_help(key)
 
2785
            if help == default_help:
 
2786
                default_realkey = key
 
2787
            else:
 
2788
                help_pairs.append((key, help))
 
2789
 
 
2790
        def wrapped(key, help, info):
 
2791
            if info.native:
 
2792
                help = '(native) ' + help
 
2793
            return ':%s:\n%s\n\n' % (key, 
 
2794
                    textwrap.fill(help, initial_indent='    ', 
 
2795
                    subsequent_indent='    '))
 
2796
        if default_realkey is not None:
 
2797
            output += wrapped(default_realkey, '(default) %s' % default_help,
 
2798
                              self.get_info('default'))
 
2799
        deprecated_pairs = []
 
2800
        experimental_pairs = []
 
2801
        for key, help in help_pairs:
 
2802
            info = self.get_info(key)
 
2803
            if info.hidden:
 
2804
                continue
 
2805
            elif info.deprecated:
 
2806
                deprecated_pairs.append((key, help))
 
2807
            elif info.experimental:
 
2808
                experimental_pairs.append((key, help))
 
2809
            else:
 
2810
                output += wrapped(key, help, info)
 
2811
        if len(experimental_pairs) > 0:
 
2812
            output += "Experimental formats are shown below.\n\n"
 
2813
            for key, help in experimental_pairs:
 
2814
                info = self.get_info(key)
 
2815
                output += wrapped(key, help, info)
 
2816
        if len(deprecated_pairs) > 0:
 
2817
            output += "Deprecated formats are shown below.\n\n"
 
2818
            for key, help in deprecated_pairs:
 
2819
                info = self.get_info(key)
 
2820
                output += wrapped(key, help, info)
 
2821
 
 
2822
        return output
 
2823
 
 
2824
 
 
2825
class RepositoryAcquisitionPolicy(object):
 
2826
    """Abstract base class for repository acquisition policies.
 
2827
 
 
2828
    A repository acquisition policy decides how a BzrDir acquires a repository
 
2829
    for a branch that is being created.  The most basic policy decision is
 
2830
    whether to create a new repository or use an existing one.
 
2831
    """
 
2832
    def __init__(self, stack_on, stack_on_pwd, require_stacking):
 
2833
        """Constructor.
 
2834
 
 
2835
        :param stack_on: A location to stack on
 
2836
        :param stack_on_pwd: If stack_on is relative, the location it is
 
2837
            relative to.
 
2838
        :param require_stacking: If True, it is a failure to not stack.
 
2839
        """
 
2840
        self._stack_on = stack_on
 
2841
        self._stack_on_pwd = stack_on_pwd
 
2842
        self._require_stacking = require_stacking
 
2843
 
 
2844
    def configure_branch(self, branch):
 
2845
        """Apply any configuration data from this policy to the branch.
 
2846
 
 
2847
        Default implementation sets repository stacking.
 
2848
        """
 
2849
        if self._stack_on is None:
 
2850
            return
 
2851
        if self._stack_on_pwd is None:
 
2852
            stack_on = self._stack_on
 
2853
        else:
 
2854
            try:
 
2855
                stack_on = urlutils.rebase_url(self._stack_on,
 
2856
                    self._stack_on_pwd,
 
2857
                    branch.bzrdir.root_transport.base)
 
2858
            except errors.InvalidRebaseURLs:
 
2859
                stack_on = self._get_full_stack_on()
 
2860
        try:
 
2861
            branch.set_stacked_on_url(stack_on)
 
2862
        except errors.UnstackableBranchFormat:
 
2863
            if self._require_stacking:
 
2864
                raise
 
2865
 
 
2866
    def _get_full_stack_on(self):
 
2867
        """Get a fully-qualified URL for the stack_on location."""
 
2868
        if self._stack_on is None:
 
2869
            return None
 
2870
        if self._stack_on_pwd is None:
 
2871
            return self._stack_on
 
2872
        else:
 
2873
            return urlutils.join(self._stack_on_pwd, self._stack_on)
 
2874
 
 
2875
    def _add_fallback(self, repository):
 
2876
        """Add a fallback to the supplied repository, if stacking is set."""
 
2877
        stack_on = self._get_full_stack_on()
 
2878
        if stack_on is None:
 
2879
            return
 
2880
        stacked_dir = BzrDir.open(stack_on)
 
2881
        try:
 
2882
            stacked_repo = stacked_dir.open_branch().repository
 
2883
        except errors.NotBranchError:
 
2884
            stacked_repo = stacked_dir.open_repository()
 
2885
        try:
 
2886
            repository.add_fallback_repository(stacked_repo)
 
2887
        except errors.UnstackableRepositoryFormat:
 
2888
            if self._require_stacking:
 
2889
                raise
 
2890
 
 
2891
    def acquire_repository(self, make_working_trees=None, shared=False):
 
2892
        """Acquire a repository for this bzrdir.
 
2893
 
 
2894
        Implementations may create a new repository or use a pre-exising
 
2895
        repository.
 
2896
        :param make_working_trees: If creating a repository, set
 
2897
            make_working_trees to this value (if non-None)
 
2898
        :param shared: If creating a repository, make it shared if True
 
2899
        :return: A repository
 
2900
        """
 
2901
        raise NotImplemented(RepositoryAcquisitionPolicy.acquire_repository)
 
2902
 
 
2903
 
 
2904
class CreateRepository(RepositoryAcquisitionPolicy):
 
2905
    """A policy of creating a new repository"""
 
2906
 
 
2907
    def __init__(self, bzrdir, stack_on=None, stack_on_pwd=None,
 
2908
                 require_stacking=False):
 
2909
        """
 
2910
        Constructor.
 
2911
        :param bzrdir: The bzrdir to create the repository on.
 
2912
        :param stack_on: A location to stack on
 
2913
        :param stack_on_pwd: If stack_on is relative, the location it is
 
2914
            relative to.
 
2915
        """
 
2916
        RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
 
2917
                                             require_stacking)
 
2918
        self._bzrdir = bzrdir
 
2919
 
 
2920
    def acquire_repository(self, make_working_trees=None, shared=False):
 
2921
        """Implementation of RepositoryAcquisitionPolicy.acquire_repository
 
2922
 
 
2923
        Creates the desired repository in the bzrdir we already have.
 
2924
        """
 
2925
        repository = self._bzrdir.create_repository(shared=shared)
 
2926
        self._add_fallback(repository)
 
2927
        if make_working_trees is not None:
 
2928
            repository.set_make_working_trees(make_working_trees)
 
2929
        return repository
 
2930
 
 
2931
 
 
2932
class UseExistingRepository(RepositoryAcquisitionPolicy):
 
2933
    """A policy of reusing an existing repository"""
 
2934
 
 
2935
    def __init__(self, repository, stack_on=None, stack_on_pwd=None,
 
2936
                 require_stacking=False):
 
2937
        """Constructor.
 
2938
 
 
2939
        :param repository: The repository to use.
 
2940
        :param stack_on: A location to stack on
 
2941
        :param stack_on_pwd: If stack_on is relative, the location it is
 
2942
            relative to.
 
2943
        """
 
2944
        RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
 
2945
                                             require_stacking)
 
2946
        self._repository = repository
 
2947
 
 
2948
    def acquire_repository(self, make_working_trees=None, shared=False):
 
2949
        """Implementation of RepositoryAcquisitionPolicy.acquire_repository
 
2950
 
 
2951
        Returns an existing repository to use
 
2952
        """
 
2953
        self._add_fallback(self._repository)
 
2954
        return self._repository
 
2955
 
 
2956
 
 
2957
format_registry = BzrDirFormatRegistry()
 
2958
format_registry.register('weave', BzrDirFormat6,
 
2959
    'Pre-0.8 format.  Slower than knit and does not'
 
2960
    ' support checkouts or shared repositories.',
 
2961
    deprecated=True)
 
2962
format_registry.register_metadir('knit',
 
2963
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
 
2964
    'Format using knits.  Recommended for interoperation with bzr <= 0.14.',
 
2965
    branch_format='bzrlib.branch.BzrBranchFormat5',
 
2966
    tree_format='bzrlib.workingtree.WorkingTreeFormat3')
 
2967
format_registry.register_metadir('metaweave',
 
2968
    'bzrlib.repofmt.weaverepo.RepositoryFormat7',
 
2969
    'Transitional format in 0.8.  Slower than knit.',
 
2970
    branch_format='bzrlib.branch.BzrBranchFormat5',
 
2971
    tree_format='bzrlib.workingtree.WorkingTreeFormat3',
 
2972
    deprecated=True)
 
2973
format_registry.register_metadir('dirstate',
 
2974
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
 
2975
    help='New in 0.15: Fast local operations. Compatible with bzr 0.8 and '
 
2976
        'above when accessed over the network.',
 
2977
    branch_format='bzrlib.branch.BzrBranchFormat5',
 
2978
    # this uses bzrlib.workingtree.WorkingTreeFormat4 because importing
 
2979
    # directly from workingtree_4 triggers a circular import.
 
2980
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
2981
    )
 
2982
format_registry.register_metadir('dirstate-tags',
 
2983
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
 
2984
    help='New in 0.15: Fast local operations and improved scaling for '
 
2985
        'network operations. Additionally adds support for tags.'
 
2986
        ' Incompatible with bzr < 0.15.',
 
2987
    branch_format='bzrlib.branch.BzrBranchFormat6',
 
2988
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
2989
    )
 
2990
format_registry.register_metadir('rich-root',
 
2991
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
 
2992
    help='New in 1.0.  Better handling of tree roots.  Incompatible with'
 
2993
        ' bzr < 1.0',
 
2994
    branch_format='bzrlib.branch.BzrBranchFormat6',
 
2995
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
2996
    )
 
2997
format_registry.register_metadir('dirstate-with-subtree',
 
2998
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
 
2999
    help='New in 0.15: Fast local operations and improved scaling for '
 
3000
        'network operations. Additionally adds support for versioning nested '
 
3001
        'bzr branches. Incompatible with bzr < 0.15.',
 
3002
    branch_format='bzrlib.branch.BzrBranchFormat6',
 
3003
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
3004
    experimental=True,
 
3005
    hidden=True,
 
3006
    )
 
3007
format_registry.register_metadir('pack-0.92',
 
3008
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack1',
 
3009
    help='New in 0.92: Pack-based format with data compatible with '
 
3010
        'dirstate-tags format repositories. Interoperates with '
 
3011
        'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
 
3012
        'Previously called knitpack-experimental.  '
 
3013
        'For more information, see '
 
3014
        'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
 
3015
    branch_format='bzrlib.branch.BzrBranchFormat6',
 
3016
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
3017
    )
 
3018
format_registry.register_metadir('pack-0.92-subtree',
 
3019
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack3',
 
3020
    help='New in 0.92: Pack-based format with data compatible with '
 
3021
        'dirstate-with-subtree format repositories. Interoperates with '
 
3022
        'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
 
3023
        'Previously called knitpack-experimental.  '
 
3024
        'For more information, see '
 
3025
        'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
 
3026
    branch_format='bzrlib.branch.BzrBranchFormat6',
 
3027
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
3028
    hidden=True,
 
3029
    experimental=True,
 
3030
    )
 
3031
format_registry.register_metadir('rich-root-pack',
 
3032
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
 
3033
    help='New in 1.0: Pack-based format with data compatible with '
 
3034
        'rich-root format repositories. Incompatible with'
 
3035
        ' bzr < 1.0',
 
3036
    branch_format='bzrlib.branch.BzrBranchFormat6',
 
3037
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
3038
    )
 
3039
format_registry.register_metadir('1.6',
 
3040
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5',
 
3041
    help='A branch and pack based repository that supports stacking. ',
 
3042
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
3043
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
3044
    )
 
3045
format_registry.register_metadir('1.6.1-rich-root',
 
3046
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5RichRoot',
 
3047
    help='A branch and pack based repository that supports stacking '
 
3048
         'and rich root data (needed for bzr-svn). ',
 
3049
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
3050
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
3051
    )
 
3052
# The following two formats should always just be aliases.
 
3053
format_registry.register_metadir('development',
 
3054
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment1',
 
3055
    help='Current development format. Can convert data to and from pack-0.92 '
 
3056
        '(and anything compatible with pack-0.92) format repositories. '
 
3057
        'Repositories and branches in this format can only be read by bzr.dev. '
 
3058
        'Please read '
 
3059
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
 
3060
        'before use.',
 
3061
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
3062
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
3063
    experimental=True,
 
3064
    alias=True,
 
3065
    )
 
3066
format_registry.register_metadir('development-subtree',
 
3067
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment1Subtree',
 
3068
    help='Current development format, subtree variant. Can convert data to and '
 
3069
        'from pack-0.92-subtree (and anything compatible with '
 
3070
        'pack-0.92-subtree) format repositories. Repositories and branches in '
 
3071
        'this format can only be read by bzr.dev. Please read '
 
3072
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
 
3073
        'before use.',
 
3074
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
3075
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
3076
    experimental=True,
 
3077
    alias=True,
 
3078
    )
 
3079
# And the development formats which the will have aliased one of follow:
 
3080
format_registry.register_metadir('development1',
 
3081
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment1',
 
3082
    help='A branch and pack based repository that supports stacking. '
 
3083
        'Please read '
 
3084
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
 
3085
        'before use.',
 
3086
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
3087
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
3088
    hidden=True,
 
3089
    experimental=True,
 
3090
    )
 
3091
format_registry.register_metadir('development1-subtree',
 
3092
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment1Subtree',
 
3093
    help='A branch and pack based repository that supports stacking. '
 
3094
        'Please read '
 
3095
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
 
3096
        'before use.',
 
3097
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
3098
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
3099
    hidden=True,
 
3100
    experimental=True,
 
3101
    )
 
3102
# The current format that is made on 'bzr init'.
 
3103
format_registry.set_default('pack-0.92')