1
# Copyright (C) 2010, 2011, 2012 Canonical Ltd
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.
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.
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""ControlDir is the basic control directory class.
19
The ControlDir class is the base for the control directory used
20
by all bzr and foreign formats. For the ".bzr" implementation,
21
see breezy.bzrdir.BzrDir.
25
from __future__ import absolute_import
27
from .lazy_import import lazy_import
28
lazy_import(globals(), """
32
branch as _mod_branch,
34
revision as _mod_revision,
35
transport as _mod_transport,
40
from breezy.transport import local
41
from breezy.push import (
45
from breezy.i18n import gettext
57
class MustHaveWorkingTree(errors.BzrError):
59
_fmt = "Branching '%(url)s'(%(format)s) must create a working tree."
61
def __init__(self, format, url):
62
errors.BzrError.__init__(self, format=format, url=url)
65
class BranchReferenceLoop(errors.BzrError):
67
_fmt = "Can not create branch reference that points at branch itself."
69
def __init__(self, branch):
70
errors.BzrError.__init__(self, branch=branch)
73
class ControlComponent(object):
74
"""Abstract base class for control directory components.
76
This provides interfaces that are common across controldirs,
77
repositories, branches, and workingtree control directories.
79
They all expose two urls and transports: the *user* URL is the
80
one that stops above the control directory (eg .bzr) and that
81
should normally be used in messages, and the *control* URL is
82
under that in eg .bzr/checkout and is used to read the control
85
This can be used as a mixin and is intended to fit with
90
def control_transport(self):
91
raise NotImplementedError
94
def control_url(self):
95
return self.control_transport.base
98
def user_transport(self):
99
raise NotImplementedError
103
return self.user_transport.base
106
class ControlDir(ControlComponent):
107
"""A control directory.
109
While this represents a generic control directory, there are a few
110
features that are present in this interface that are currently only
111
supported by one of its implementations, BzrDir.
113
These features (bound branches, stacked branches) are currently only
114
supported by Bazaar, but could be supported by other version control
115
systems as well. Implementations are required to raise the appropriate
116
exceptions when an operation is requested that is not supported.
118
This also makes life easier for API users who can rely on the
119
implementation always allowing a particular feature to be requested but
120
raising an exception when it is not supported, rather than requiring the
121
API users to check for magic attributes to see what features are supported.
124
def can_convert_format(self):
125
"""Return true if this controldir is one whose format we can convert
129
def list_branches(self):
130
"""Return a sequence of all branches local to this control directory.
133
return list(self.get_branches().values())
135
def get_branches(self):
136
"""Get all branches in this control directory, as a dictionary.
138
:return: Dictionary mapping branch names to instances.
141
return { "": self.open_branch() }
142
except (errors.NotBranchError, errors.NoRepositoryPresent):
145
def is_control_filename(self, filename):
146
"""True if filename is the name of a path which is reserved for
149
:param filename: A filename within the root transport of this
152
This is true IF and ONLY IF the filename is part of the namespace reserved
153
for bzr control dirs. Currently this is the '.bzr' directory in the root
154
of the root_transport. it is expected that plugins will need to extend
155
this in the future - for instance to make bzr talk with svn working
158
raise NotImplementedError(self.is_control_filename)
160
def needs_format_conversion(self, format=None):
161
"""Return true if this controldir needs convert_format run on it.
163
For instance, if the repository format is out of date but the
164
branch and working tree are not, this should return True.
166
:param format: Optional parameter indicating a specific desired
167
format we plan to arrive at.
169
raise NotImplementedError(self.needs_format_conversion)
171
def create_repository(self, shared=False):
172
"""Create a new repository in this control directory.
174
:param shared: If a shared repository should be created
175
:return: The newly created repository
177
raise NotImplementedError(self.create_repository)
179
def destroy_repository(self):
180
"""Destroy the repository in this ControlDir."""
181
raise NotImplementedError(self.destroy_repository)
183
def create_branch(self, name=None, repository=None,
184
append_revisions_only=None):
185
"""Create a branch in this ControlDir.
187
:param name: Name of the colocated branch to create, None for
188
the user selected branch or "" for the active branch.
189
:param append_revisions_only: Whether this branch should only allow
190
appending new revisions to its history.
192
The controldirs format will control what branch format is created.
193
For more control see BranchFormatXX.create(a_controldir).
195
raise NotImplementedError(self.create_branch)
197
def destroy_branch(self, name=None):
198
"""Destroy a branch in this ControlDir.
200
:param name: Name of the branch to destroy, None for the
201
user selected branch or "" for the active branch.
202
:raise NotBranchError: When the branch does not exist
204
raise NotImplementedError(self.destroy_branch)
206
def create_workingtree(self, revision_id=None, from_branch=None,
207
accelerator_tree=None, hardlink=False):
208
"""Create a working tree at this ControlDir.
210
:param revision_id: create it as of this revision id.
211
:param from_branch: override controldir branch
212
(for lightweight checkouts)
213
:param accelerator_tree: A tree which can be used for retrieving file
214
contents more quickly than the revision tree, i.e. a workingtree.
215
The revision tree will be used for cases where accelerator_tree's
216
content is different.
218
raise NotImplementedError(self.create_workingtree)
220
def destroy_workingtree(self):
221
"""Destroy the working tree at this ControlDir.
223
Formats that do not support this may raise UnsupportedOperation.
225
raise NotImplementedError(self.destroy_workingtree)
227
def destroy_workingtree_metadata(self):
228
"""Destroy the control files for the working tree at this ControlDir.
230
The contents of working tree files are not affected.
231
Formats that do not support this may raise UnsupportedOperation.
233
raise NotImplementedError(self.destroy_workingtree_metadata)
235
def find_branch_format(self, name=None):
236
"""Find the branch 'format' for this controldir.
238
This might be a synthetic object for e.g. RemoteBranch and SVN.
240
raise NotImplementedError(self.find_branch_format)
242
def get_branch_reference(self, name=None):
243
"""Return the referenced URL for the branch in this controldir.
245
:param name: Optional colocated branch name
246
:raises NotBranchError: If there is no Branch.
247
:raises NoColocatedBranchSupport: If a branch name was specified
248
but colocated branches are not supported.
249
:return: The URL the branch in this controldir references if it is a
250
reference branch, or None for regular branches.
253
raise errors.NoColocatedBranchSupport(self)
256
def set_branch_reference(self, target_branch, name=None):
257
"""Set the referenced URL for the branch in this controldir.
259
:param name: Optional colocated branch name
260
:param target_branch: Branch to reference
261
:raises NoColocatedBranchSupport: If a branch name was specified
262
but colocated branches are not supported.
263
:return: The referencing branch
265
raise NotImplementedError(self.set_branch_reference)
267
def open_branch(self, name=None, unsupported=False,
268
ignore_fallbacks=False, possible_transports=None):
269
"""Open the branch object at this ControlDir if one is present.
271
:param unsupported: if True, then no longer supported branch formats can
273
:param ignore_fallbacks: Whether to open fallback repositories
274
:param possible_transports: Transports to use for opening e.g.
275
fallback repositories.
277
raise NotImplementedError(self.open_branch)
279
def open_repository(self, _unsupported=False):
280
"""Open the repository object at this ControlDir if one is present.
282
This will not follow the Branch object pointer - it's strictly a direct
283
open facility. Most client code should use open_branch().repository to
286
:param _unsupported: a private parameter, not part of the api.
288
raise NotImplementedError(self.open_repository)
290
def find_repository(self):
291
"""Find the repository that should be used.
293
This does not require a branch as we use it to find the repo for
294
new branches as well as to hook existing branches up to their
297
raise NotImplementedError(self.find_repository)
299
def open_workingtree(self, unsupported=False,
300
recommend_upgrade=True, from_branch=None):
301
"""Open the workingtree object at this ControlDir if one is present.
303
:param recommend_upgrade: Optional keyword parameter, when True (the
304
default), emit through the ui module a recommendation that the user
305
upgrade the working tree when the workingtree being opened is old
306
(but still fully supported).
307
:param from_branch: override controldir branch (for lightweight
310
raise NotImplementedError(self.open_workingtree)
312
def has_branch(self, name=None):
313
"""Tell if this controldir contains a branch.
315
Note: if you're going to open the branch, you should just go ahead
316
and try, and not ask permission first. (This method just opens the
317
branch and discards it, and that's somewhat expensive.)
320
self.open_branch(name, ignore_fallbacks=True)
322
except errors.NotBranchError:
325
def _get_selected_branch(self):
326
"""Return the name of the branch selected by the user.
328
:return: Name of the branch selected by the user, or "".
330
branch = self.root_transport.get_segment_parameters().get("branch")
333
return urlutils.unescape(branch)
335
def has_workingtree(self):
336
"""Tell if this controldir contains a working tree.
338
This will still raise an exception if the controldir has a workingtree
339
that is remote & inaccessible.
341
Note: if you're going to open the working tree, you should just go ahead
342
and try, and not ask permission first. (This method just opens the
343
workingtree and discards it, and that's somewhat expensive.)
346
self.open_workingtree(recommend_upgrade=False)
348
except errors.NoWorkingTree:
351
def cloning_metadir(self, require_stacking=False):
352
"""Produce a metadir suitable for cloning or sprouting with.
354
These operations may produce workingtrees (yes, even though they're
355
"cloning" something that doesn't have a tree), so a viable workingtree
356
format must be selected.
358
:require_stacking: If True, non-stackable formats will be upgraded
359
to similar stackable formats.
360
:returns: a ControlDirFormat with all component formats either set
361
appropriately or set to None if that component should not be
364
raise NotImplementedError(self.cloning_metadir)
366
def checkout_metadir(self):
367
"""Produce a metadir suitable for checkouts of this controldir.
369
:returns: A ControlDirFormat with all component formats
370
either set appropriately or set to None if that component
371
should not be created.
373
return self.cloning_metadir()
375
def sprout(self, url, revision_id=None, force_new_repo=False,
376
recurse='down', possible_transports=None,
377
accelerator_tree=None, hardlink=False, stacked=False,
378
source_branch=None, create_tree_if_local=True,
380
"""Create a copy of this controldir prepared for use as a new line of
383
If url's last component does not exist, it will be created.
385
Attributes related to the identity of the source branch like
386
branch nickname will be cleaned, a working tree is created
387
whether one existed before or not; and a local branch is always
390
:param revision_id: if revision_id is not None, then the clone
391
operation may tune itself to download less data.
392
:param accelerator_tree: A tree which can be used for retrieving file
393
contents more quickly than the revision tree, i.e. a workingtree.
394
The revision tree will be used for cases where accelerator_tree's
395
content is different.
396
:param hardlink: If true, hard-link files from accelerator_tree,
398
:param stacked: If true, create a stacked branch referring to the
399
location of this control directory.
400
:param create_tree_if_local: If true, a working-tree will be created
401
when working locally.
403
raise NotImplementedError(self.sprout)
405
def push_branch(self, source, revision_id=None, overwrite=False,
406
remember=False, create_prefix=False, lossy=False):
407
"""Push the source branch into this ControlDir."""
409
# If we can open a branch, use its direct repository, otherwise see
410
# if there is a repository without a branch.
412
br_to = self.open_branch()
413
except errors.NotBranchError:
414
# Didn't find a branch, can we find a repository?
415
repository_to = self.find_repository()
417
# Found a branch, so we must have found a repository
418
repository_to = br_to.repository
420
push_result = PushResult()
421
push_result.source_branch = source
423
# We have a repository but no branch, copy the revisions, and then
425
if revision_id is None:
426
# No revision supplied by the user, default to the branch
428
revision_id = source.last_revision()
429
repository_to.fetch(source.repository, revision_id=revision_id)
430
br_to = source.sprout(self, revision_id=revision_id, lossy=lossy)
431
if source.get_push_location() is None or remember:
432
# FIXME: Should be done only if we succeed ? -- vila 2012-01-18
433
source.set_push_location(br_to.base)
434
push_result.stacked_on = None
435
push_result.branch_push_result = None
436
push_result.old_revno = None
437
push_result.old_revid = _mod_revision.NULL_REVISION
438
push_result.target_branch = br_to
439
push_result.master_branch = None
440
push_result.workingtree_updated = False
442
# We have successfully opened the branch, remember if necessary:
443
if source.get_push_location() is None or remember:
444
# FIXME: Should be done only if we succeed ? -- vila 2012-01-18
445
source.set_push_location(br_to.base)
447
tree_to = self.open_workingtree()
448
except errors.NotLocalUrl:
449
push_result.branch_push_result = source.push(br_to,
450
overwrite, stop_revision=revision_id, lossy=lossy)
451
push_result.workingtree_updated = False
452
except errors.NoWorkingTree:
453
push_result.branch_push_result = source.push(br_to,
454
overwrite, stop_revision=revision_id, lossy=lossy)
455
push_result.workingtree_updated = None # Not applicable
457
with tree_to.lock_write():
458
push_result.branch_push_result = source.push(
459
tree_to.branch, overwrite, stop_revision=revision_id,
462
push_result.workingtree_updated = True
463
push_result.old_revno = push_result.branch_push_result.old_revno
464
push_result.old_revid = push_result.branch_push_result.old_revid
465
push_result.target_branch = \
466
push_result.branch_push_result.target_branch
469
def _get_tree_branch(self, name=None):
470
"""Return the branch and tree, if any, for this controldir.
472
:param name: Name of colocated branch to open.
474
Return None for tree if not present or inaccessible.
475
Raise NotBranchError if no branch is present.
476
:return: (tree, branch)
479
tree = self.open_workingtree()
480
except (errors.NoWorkingTree, errors.NotLocalUrl):
482
branch = self.open_branch(name=name)
485
branch = self.open_branch(name=name)
490
def get_config(self):
491
"""Get configuration for this ControlDir."""
492
raise NotImplementedError(self.get_config)
494
def check_conversion_target(self, target_format):
495
"""Check that a controldir as a whole can be converted to a new format."""
496
raise NotImplementedError(self.check_conversion_target)
498
def clone(self, url, revision_id=None, force_new_repo=False,
499
preserve_stacking=False):
500
"""Clone this controldir and its contents to url verbatim.
502
:param url: The url create the clone at. If url's last component does
503
not exist, it will be created.
504
:param revision_id: The tip revision-id to use for any branch or
505
working tree. If not None, then the clone operation may tune
506
itself to download less data.
507
:param force_new_repo: Do not use a shared repository for the target
508
even if one is available.
509
:param preserve_stacking: When cloning a stacked branch, stack the
510
new branch on top of the other branch's stacked-on branch.
512
return self.clone_on_transport(_mod_transport.get_transport(url),
513
revision_id=revision_id,
514
force_new_repo=force_new_repo,
515
preserve_stacking=preserve_stacking)
517
def clone_on_transport(self, transport, revision_id=None,
518
force_new_repo=False, preserve_stacking=False, stacked_on=None,
519
create_prefix=False, use_existing_dir=True, no_tree=False):
520
"""Clone this controldir and its contents to transport verbatim.
522
:param transport: The transport for the location to produce the clone
523
at. If the target directory does not exist, it will be created.
524
:param revision_id: The tip revision-id to use for any branch or
525
working tree. If not None, then the clone operation may tune
526
itself to download less data.
527
:param force_new_repo: Do not use a shared repository for the target,
528
even if one is available.
529
:param preserve_stacking: When cloning a stacked branch, stack the
530
new branch on top of the other branch's stacked-on branch.
531
:param create_prefix: Create any missing directories leading up to
533
:param use_existing_dir: Use an existing directory if one exists.
534
:param no_tree: If set to true prevents creation of a working tree.
536
raise NotImplementedError(self.clone_on_transport)
539
def find_controldirs(klass, transport, evaluate=None, list_current=None):
540
"""Find control dirs recursively from current location.
542
This is intended primarily as a building block for more sophisticated
543
functionality, like finding trees under a directory, or finding
544
branches that use a given repository.
546
:param evaluate: An optional callable that yields recurse, value,
547
where recurse controls whether this controldir is recursed into
548
and value is the value to yield. By default, all bzrdirs
549
are recursed into, and the return value is the controldir.
550
:param list_current: if supplied, use this function to list the current
551
directory, instead of Transport.list_dir
552
:return: a generator of found bzrdirs, or whatever evaluate returns.
554
if list_current is None:
555
def list_current(transport):
556
return transport.list_dir('')
558
def evaluate(controldir):
559
return True, controldir
561
pending = [transport]
562
while len(pending) > 0:
563
current_transport = pending.pop()
566
controldir = klass.open_from_transport(current_transport)
567
except (errors.NotBranchError, errors.PermissionDenied):
570
recurse, value = evaluate(controldir)
573
subdirs = list_current(current_transport)
574
except (errors.NoSuchFile, errors.PermissionDenied):
577
for subdir in sorted(subdirs, reverse=True):
578
pending.append(current_transport.clone(subdir))
581
def find_branches(klass, transport):
582
"""Find all branches under a transport.
584
This will find all branches below the transport, including branches
585
inside other branches. Where possible, it will use
586
Repository.find_branches.
588
To list all the branches that use a particular Repository, see
589
Repository.find_branches
591
def evaluate(controldir):
593
repository = controldir.open_repository()
594
except errors.NoRepositoryPresent:
597
return False, ([], repository)
598
return True, (controldir.list_branches(), None)
600
for branches, repo in klass.find_controldirs(
601
transport, evaluate=evaluate):
603
ret.extend(repo.find_branches())
604
if branches is not None:
609
def create_branch_and_repo(klass, base, force_new_repo=False, format=None):
610
"""Create a new ControlDir, Branch and Repository at the url 'base'.
612
This will use the current default ControlDirFormat unless one is
613
specified, and use whatever
614
repository format that that uses via controldir.create_branch and
615
create_repository. If a shared repository is available that is used
618
The created Branch object is returned.
620
:param base: The URL to create the branch at.
621
:param force_new_repo: If True a new repository is always created.
622
:param format: If supplied, the format of branch to create. If not
623
supplied, the default is used.
625
controldir = klass.create(base, format)
626
controldir._find_or_create_repository(force_new_repo)
627
return controldir.create_branch()
630
def create_branch_convenience(klass, base, force_new_repo=False,
631
force_new_tree=None, format=None,
632
possible_transports=None):
633
"""Create a new ControlDir, Branch and Repository at the url 'base'.
635
This is a convenience function - it will use an existing repository
636
if possible, can be told explicitly whether to create a working tree or
639
This will use the current default ControlDirFormat unless one is
640
specified, and use whatever
641
repository format that that uses via ControlDir.create_branch and
642
create_repository. If a shared repository is available that is used
643
preferentially. Whatever repository is used, its tree creation policy
646
The created Branch object is returned.
647
If a working tree cannot be made due to base not being a file:// url,
648
no error is raised unless force_new_tree is True, in which case no
649
data is created on disk and NotLocalUrl is raised.
651
:param base: The URL to create the branch at.
652
:param force_new_repo: If True a new repository is always created.
653
:param force_new_tree: If True or False force creation of a tree or
654
prevent such creation respectively.
655
:param format: Override for the controldir format to create.
656
:param possible_transports: An optional reusable transports list.
659
# check for non local urls
660
t = _mod_transport.get_transport(base, possible_transports)
661
if not isinstance(t, local.LocalTransport):
662
raise errors.NotLocalUrl(base)
663
controldir = klass.create(base, format, possible_transports)
664
repo = controldir._find_or_create_repository(force_new_repo)
665
result = controldir.create_branch()
666
if force_new_tree or (repo.make_working_trees() and
667
force_new_tree is None):
669
controldir.create_workingtree()
670
except errors.NotLocalUrl:
675
def create_standalone_workingtree(klass, base, format=None):
676
"""Create a new ControlDir, WorkingTree, Branch and Repository at 'base'.
678
'base' must be a local path or a file:// url.
680
This will use the current default ControlDirFormat unless one is
681
specified, and use whatever
682
repository format that that uses for bzrdirformat.create_workingtree,
683
create_branch and create_repository.
685
:param format: Override for the controldir format to create.
686
:return: The WorkingTree object.
688
t = _mod_transport.get_transport(base)
689
if not isinstance(t, local.LocalTransport):
690
raise errors.NotLocalUrl(base)
691
controldir = klass.create_branch_and_repo(base,
693
format=format).controldir
694
return controldir.create_workingtree()
697
def open_unsupported(klass, base):
698
"""Open a branch which is not supported."""
699
return klass.open(base, _unsupported=True)
702
def open(klass, base, possible_transports=None, probers=None,
704
"""Open an existing controldir, rooted at 'base' (url).
706
:param _unsupported: a private parameter to the ControlDir class.
708
t = _mod_transport.get_transport(base, possible_transports)
709
return klass.open_from_transport(t, probers=probers,
710
_unsupported=_unsupported)
713
def open_from_transport(klass, transport, _unsupported=False,
715
"""Open a controldir within a particular directory.
717
:param transport: Transport containing the controldir.
718
:param _unsupported: private.
720
for hook in klass.hooks['pre_open']:
722
# Keep initial base since 'transport' may be modified while following
724
base = transport.base
725
def find_format(transport):
726
return transport, ControlDirFormat.find_format(transport,
729
def redirected(transport, e, redirection_notice):
730
redirected_transport = transport._redirected_to(e.source, e.target)
731
if redirected_transport is None:
732
raise errors.NotBranchError(base)
733
trace.note(gettext('{0} is{1} redirected to {2}').format(
734
transport.base, e.permanently, redirected_transport.base))
735
return redirected_transport
738
transport, format = _mod_transport.do_catching_redirections(
739
find_format, transport, redirected)
740
except errors.TooManyRedirections:
741
raise errors.NotBranchError(base)
743
format.check_support_status(_unsupported)
744
return format.open(transport, _found=True)
747
def open_containing(klass, url, possible_transports=None):
748
"""Open an existing branch which contains url.
750
:param url: url to search from.
752
See open_containing_from_transport for more detail.
754
transport = _mod_transport.get_transport(url, possible_transports)
755
return klass.open_containing_from_transport(transport)
758
def open_containing_from_transport(klass, a_transport):
759
"""Open an existing branch which contains a_transport.base.
761
This probes for a branch at a_transport, and searches upwards from there.
763
Basically we keep looking up until we find the control directory or
764
run into the root. If there isn't one, raises NotBranchError.
765
If there is one and it is either an unrecognised format or an unsupported
766
format, UnknownFormatError or UnsupportedFormatError are raised.
767
If there is one, it is returned, along with the unused portion of url.
769
:return: The ControlDir that contains the path, and a Unicode path
770
for the rest of the URL.
772
# this gets the normalised url back. I.e. '.' -> the full path.
773
url = a_transport.base
776
result = klass.open_from_transport(a_transport)
777
return result, urlutils.unescape(a_transport.relpath(url))
778
except errors.NotBranchError as e:
780
except errors.PermissionDenied:
783
new_t = a_transport.clone('..')
784
except urlutils.InvalidURLJoin:
785
# reached the root, whatever that may be
786
raise errors.NotBranchError(path=url)
787
if new_t.base == a_transport.base:
788
# reached the root, whatever that may be
789
raise errors.NotBranchError(path=url)
793
def open_tree_or_branch(klass, location):
794
"""Return the branch and working tree at a location.
796
If there is no tree at the location, tree will be None.
797
If there is no branch at the location, an exception will be
799
:return: (tree, branch)
801
controldir = klass.open(location)
802
return controldir._get_tree_branch()
805
def open_containing_tree_or_branch(klass, location,
806
possible_transports=None):
807
"""Return the branch and working tree contained by a location.
809
Returns (tree, branch, relpath).
810
If there is no tree at containing the location, tree will be None.
811
If there is no branch containing the location, an exception will be
813
relpath is the portion of the path that is contained by the branch.
815
controldir, relpath = klass.open_containing(location,
816
possible_transports=possible_transports)
817
tree, branch = controldir._get_tree_branch()
818
return tree, branch, relpath
821
def open_containing_tree_branch_or_repository(klass, location):
822
"""Return the working tree, branch and repo contained by a location.
824
Returns (tree, branch, repository, relpath).
825
If there is no tree containing the location, tree will be None.
826
If there is no branch containing the location, branch will be None.
827
If there is no repository containing the location, repository will be
829
relpath is the portion of the path that is contained by the innermost
832
If no tree, branch or repository is found, a NotBranchError is raised.
834
controldir, relpath = klass.open_containing(location)
836
tree, branch = controldir._get_tree_branch()
837
except errors.NotBranchError:
839
repo = controldir.find_repository()
840
return None, None, repo, relpath
841
except (errors.NoRepositoryPresent):
842
raise errors.NotBranchError(location)
843
return tree, branch, branch.repository, relpath
846
def create(klass, base, format=None, possible_transports=None):
847
"""Create a new ControlDir at the url 'base'.
849
:param format: If supplied, the format of branch to create. If not
850
supplied, the default is used.
851
:param possible_transports: If supplied, a list of transports that
852
can be reused to share a remote connection.
854
if klass is not ControlDir:
855
raise AssertionError("ControlDir.create always creates the"
856
"default format, not one of %r" % klass)
857
t = _mod_transport.get_transport(base, possible_transports)
860
format = ControlDirFormat.get_default_format()
861
return format.initialize_on_transport(t)
864
class ControlDirHooks(hooks.Hooks):
865
"""Hooks for ControlDir operations."""
868
"""Create the default hooks."""
869
hooks.Hooks.__init__(self, "breezy.controldir", "ControlDir.hooks")
870
self.add_hook('pre_open',
871
"Invoked before attempting to open a ControlDir with the transport "
872
"that the open will use.", (1, 14))
873
self.add_hook('post_repo_init',
874
"Invoked after a repository has been initialized. "
875
"post_repo_init is called with a "
876
"breezy.controldir.RepoInitHookParams.",
879
# install the default hooks
880
ControlDir.hooks = ControlDirHooks()
883
class ControlComponentFormat(object):
884
"""A component that can live inside of a control directory."""
886
upgrade_recommended = False
888
def get_format_description(self):
889
"""Return the short description for this format."""
890
raise NotImplementedError(self.get_format_description)
892
def is_supported(self):
893
"""Is this format supported?
895
Supported formats must be initializable and openable.
896
Unsupported formats may not support initialization or committing or
897
some other features depending on the reason for not being supported.
901
def check_support_status(self, allow_unsupported, recommend_upgrade=True,
903
"""Give an error or warning on old formats.
905
:param allow_unsupported: If true, allow opening
906
formats that are strongly deprecated, and which may
907
have limited functionality.
909
:param recommend_upgrade: If true (default), warn
910
the user through the ui object that they may wish
911
to upgrade the object.
913
if not allow_unsupported and not self.is_supported():
914
# see open_downlevel to open legacy branches.
915
raise errors.UnsupportedFormatError(format=self)
916
if recommend_upgrade and self.upgrade_recommended:
917
ui.ui_factory.recommend_upgrade(
918
self.get_format_description(), basedir)
921
def get_format_string(cls):
922
raise NotImplementedError(cls.get_format_string)
925
class ControlComponentFormatRegistry(registry.FormatRegistry):
926
"""A registry for control components (branch, workingtree, repository)."""
928
def __init__(self, other_registry=None):
929
super(ControlComponentFormatRegistry, self).__init__(other_registry)
930
self._extra_formats = []
932
def register(self, format):
933
"""Register a new format."""
934
super(ControlComponentFormatRegistry, self).register(
935
format.get_format_string(), format)
937
def remove(self, format):
938
"""Remove a registered format."""
939
super(ControlComponentFormatRegistry, self).remove(
940
format.get_format_string())
942
def register_extra(self, format):
943
"""Register a format that can not be used in a metadir.
945
This is mainly useful to allow custom repository formats, such as older
946
Bazaar formats and foreign formats, to be tested.
948
self._extra_formats.append(registry._ObjectGetter(format))
950
def remove_extra(self, format):
951
"""Remove an extra format.
953
self._extra_formats.remove(registry._ObjectGetter(format))
955
def register_extra_lazy(self, module_name, member_name):
956
"""Register a format lazily.
958
self._extra_formats.append(
959
registry._LazyObjectGetter(module_name, member_name))
961
def _get_extra(self):
962
"""Return getters for extra formats, not usable in meta directories."""
963
return [getter.get_obj for getter in self._extra_formats]
965
def _get_all_lazy(self):
966
"""Return getters for all formats, even those not usable in metadirs."""
967
result = [self._dict[name].get_obj for name in self.keys()]
968
result.extend(self._get_extra())
972
"""Return all formats, even those not usable in metadirs."""
974
for getter in self._get_all_lazy():
981
def _get_all_modules(self):
982
"""Return a set of the modules providing objects."""
984
for name in self.keys():
985
modules.add(self._get_module(name))
986
for getter in self._extra_formats:
987
modules.add(getter.get_module())
991
class Converter(object):
992
"""Converts a disk format object from one format to another."""
994
def convert(self, to_convert, pb):
995
"""Perform the conversion of to_convert, giving feedback via pb.
997
:param to_convert: The disk object to convert.
998
:param pb: a progress bar to use for progress information.
1001
def step(self, message):
1002
"""Update the pb by a step."""
1004
self.pb.update(message, self.count, self.total)
1007
class ControlDirFormat(object):
1008
"""An encapsulation of the initialization and open routines for a format.
1010
Formats provide three things:
1011
* An initialization routine,
1015
Formats are placed in a dict by their format string for reference
1016
during controldir opening. These should be subclasses of ControlDirFormat
1019
Once a format is deprecated, just deprecate the initialize and open
1020
methods on the format class. Do not deprecate the object, as the
1021
object will be created every system load.
1023
:cvar colocated_branches: Whether this formats supports colocated branches.
1024
:cvar supports_workingtrees: This control directory can co-exist with a
1028
_default_format = None
1029
"""The default format used for new control directories."""
1031
_server_probers = []
1032
"""The registered server format probers, e.g. RemoteBzrProber.
1034
This is a list of Prober-derived classes.
1038
"""The registered format probers, e.g. BzrProber.
1040
This is a list of Prober-derived classes.
1043
colocated_branches = False
1044
"""Whether co-located branches are supported for this control dir format.
1047
supports_workingtrees = True
1048
"""Whether working trees can exist in control directories of this format.
1051
fixed_components = False
1052
"""Whether components can not change format independent of the control dir.
1055
upgrade_recommended = False
1056
"""Whether an upgrade from this format is recommended."""
1058
def get_format_description(self):
1059
"""Return the short description for this format."""
1060
raise NotImplementedError(self.get_format_description)
1062
def get_converter(self, format=None):
1063
"""Return the converter to use to convert controldirs needing converts.
1065
This returns a breezy.controldir.Converter object.
1067
This should return the best upgrader to step this format towards the
1068
current default format. In the case of plugins we can/should provide
1069
some means for them to extend the range of returnable converters.
1071
:param format: Optional format to override the default format of the
1074
raise NotImplementedError(self.get_converter)
1076
def is_supported(self):
1077
"""Is this format supported?
1079
Supported formats must be openable.
1080
Unsupported formats may not support initialization or committing or
1081
some other features depending on the reason for not being supported.
1085
def is_initializable(self):
1086
"""Whether new control directories of this format can be initialized.
1088
return self.is_supported()
1090
def check_support_status(self, allow_unsupported, recommend_upgrade=True,
1092
"""Give an error or warning on old formats.
1094
:param allow_unsupported: If true, allow opening
1095
formats that are strongly deprecated, and which may
1096
have limited functionality.
1098
:param recommend_upgrade: If true (default), warn
1099
the user through the ui object that they may wish
1100
to upgrade the object.
1102
if not allow_unsupported and not self.is_supported():
1103
# see open_downlevel to open legacy branches.
1104
raise errors.UnsupportedFormatError(format=self)
1105
if recommend_upgrade and self.upgrade_recommended:
1106
ui.ui_factory.recommend_upgrade(
1107
self.get_format_description(), basedir)
1109
def same_model(self, target_format):
1110
return (self.repository_format.rich_root_data ==
1111
target_format.rich_root_data)
1114
def register_prober(klass, prober):
1115
"""Register a prober that can look for a control dir.
1118
klass._probers.append(prober)
1121
def unregister_prober(klass, prober):
1122
"""Unregister a prober.
1125
klass._probers.remove(prober)
1128
def register_server_prober(klass, prober):
1129
"""Register a control format prober for client-server environments.
1131
These probers will be used before ones registered with
1132
register_prober. This gives implementations that decide to the
1133
chance to grab it before anything looks at the contents of the format
1136
klass._server_probers.append(prober)
1140
return self.get_format_description().rstrip()
1143
def all_probers(klass):
1144
return klass._server_probers + klass._probers
1147
def known_formats(klass):
1148
"""Return all the known formats.
1151
for prober_kls in klass.all_probers():
1152
result.extend(prober_kls.known_formats())
1156
def find_format(klass, transport, probers=None):
1157
"""Return the format present at transport."""
1159
probers = klass.all_probers()
1160
for prober_kls in probers:
1161
prober = prober_kls()
1163
return prober.probe_transport(transport)
1164
except errors.NotBranchError:
1165
# this format does not find a control dir here.
1167
raise errors.NotBranchError(path=transport.base)
1169
def initialize(self, url, possible_transports=None):
1170
"""Create a control dir at this url and return an opened copy.
1172
While not deprecated, this method is very specific and its use will
1173
lead to many round trips to setup a working environment. See
1174
initialize_on_transport_ex for a [nearly] all-in-one method.
1176
Subclasses should typically override initialize_on_transport
1177
instead of this method.
1179
return self.initialize_on_transport(
1180
_mod_transport.get_transport(url, possible_transports))
1182
def initialize_on_transport(self, transport):
1183
"""Initialize a new controldir in the base directory of a Transport."""
1184
raise NotImplementedError(self.initialize_on_transport)
1186
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
1187
create_prefix=False, force_new_repo=False, stacked_on=None,
1188
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
1189
shared_repo=False, vfs_only=False):
1190
"""Create this format on transport.
1192
The directory to initialize will be created.
1194
:param force_new_repo: Do not use a shared repository for the target,
1195
even if one is available.
1196
:param create_prefix: Create any missing directories leading up to
1198
:param use_existing_dir: Use an existing directory if one exists.
1199
:param stacked_on: A url to stack any created branch on, None to follow
1200
any target stacking policy.
1201
:param stack_on_pwd: If stack_on is relative, the location it is
1203
:param repo_format_name: If non-None, a repository will be
1204
made-or-found. Should none be found, or if force_new_repo is True
1205
the repo_format_name is used to select the format of repository to
1207
:param make_working_trees: Control the setting of make_working_trees
1208
for a new shared repository when one is made. None to use whatever
1209
default the format has.
1210
:param shared_repo: Control whether made repositories are shared or
1212
:param vfs_only: If True do not attempt to use a smart server
1213
:return: repo, controldir, require_stacking, repository_policy. repo is
1214
None if none was created or found, controldir is always valid.
1215
require_stacking is the result of examining the stacked_on
1216
parameter and any stacking policy found for the target.
1218
raise NotImplementedError(self.initialize_on_transport_ex)
1220
def network_name(self):
1221
"""A simple byte string uniquely identifying this format for RPC calls.
1223
Bzr control formats use this disk format string to identify the format
1224
over the wire. Its possible that other control formats have more
1225
complex detection requirements, so we permit them to use any unique and
1226
immutable string they desire.
1228
raise NotImplementedError(self.network_name)
1230
def open(self, transport, _found=False):
1231
"""Return an instance of this format for the dir transport points at.
1233
raise NotImplementedError(self.open)
1236
def _set_default_format(klass, format):
1237
"""Set default format (for testing behavior of defaults only)"""
1238
klass._default_format = format
1241
def get_default_format(klass):
1242
"""Return the current default format."""
1243
return klass._default_format
1245
def supports_transport(self, transport):
1246
"""Check if this format can be opened over a particular transport.
1248
raise NotImplementedError(self.supports_transport)
1251
class Prober(object):
1252
"""Abstract class that can be used to detect a particular kind of
1255
At the moment this just contains a single method to probe a particular
1256
transport, but it may be extended in the future to e.g. avoid
1257
multiple levels of probing for Subversion repositories.
1259
See BzrProber and RemoteBzrProber in breezy.bzrdir for the
1260
probers that detect .bzr/ directories and Bazaar smart servers,
1263
Probers should be registered using the register_server_prober or
1264
register_prober methods on ControlDirFormat.
1267
def probe_transport(self, transport):
1268
"""Return the controldir style format present in a directory.
1270
:raise UnknownFormatError: If a control dir was found but is
1271
in an unknown format.
1272
:raise NotBranchError: If no control directory was found.
1273
:return: A ControlDirFormat instance.
1275
raise NotImplementedError(self.probe_transport)
1278
def known_formats(klass):
1279
"""Return the control dir formats known by this prober.
1281
Multiple probers can return the same formats, so this should
1284
:return: A set of known formats.
1286
raise NotImplementedError(klass.known_formats)
1289
class ControlDirFormatInfo(object):
1291
def __init__(self, native, deprecated, hidden, experimental):
1292
self.deprecated = deprecated
1293
self.native = native
1294
self.hidden = hidden
1295
self.experimental = experimental
1298
class ControlDirFormatRegistry(registry.Registry):
1299
"""Registry of user-selectable ControlDir subformats.
1301
Differs from ControlDirFormat._formats in that it provides sub-formats,
1302
e.g. BzrDirMeta1 with weave repository. Also, it's more user-oriented.
1306
"""Create a ControlDirFormatRegistry."""
1307
self._registration_order = list()
1308
super(ControlDirFormatRegistry, self).__init__()
1310
def register(self, key, factory, help, native=True, deprecated=False,
1311
hidden=False, experimental=False):
1312
"""Register a ControlDirFormat factory.
1314
The factory must be a callable that takes one parameter: the key.
1315
It must produce an instance of the ControlDirFormat when called.
1317
This function mainly exists to prevent the info object from being
1320
registry.Registry.register(self, key, factory, help,
1321
ControlDirFormatInfo(native, deprecated, hidden, experimental))
1322
self._registration_order.append(key)
1324
def register_alias(self, key, target, hidden=False):
1325
"""Register a format alias.
1327
:param key: Alias name
1328
:param target: Target format
1329
:param hidden: Whether the alias is hidden
1331
info = self.get_info(target)
1332
registry.Registry.register_alias(self, key, target,
1333
ControlDirFormatInfo(
1334
native=info.native, deprecated=info.deprecated,
1335
hidden=hidden, experimental=info.experimental))
1337
def register_lazy(self, key, module_name, member_name, help, native=True,
1338
deprecated=False, hidden=False, experimental=False):
1339
registry.Registry.register_lazy(self, key, module_name, member_name,
1340
help, ControlDirFormatInfo(native, deprecated, hidden, experimental))
1341
self._registration_order.append(key)
1343
def set_default(self, key):
1344
"""Set the 'default' key to be a clone of the supplied key.
1346
This method must be called once and only once.
1348
self.register_alias('default', key)
1350
def set_default_repository(self, key):
1351
"""Set the FormatRegistry default and Repository default.
1353
This is a transitional method while Repository.set_default_format
1356
if 'default' in self:
1357
self.remove('default')
1358
self.set_default(key)
1359
format = self.get('default')()
1361
def make_controldir(self, key):
1362
return self.get(key)()
1364
def help_topic(self, topic):
1366
default_realkey = None
1367
default_help = self.get_help('default')
1369
for key in self._registration_order:
1370
if key == 'default':
1372
help = self.get_help(key)
1373
if help == default_help:
1374
default_realkey = key
1376
help_pairs.append((key, help))
1378
def wrapped(key, help, info):
1380
help = '(native) ' + help
1381
return ':%s:\n%s\n\n' % (key,
1382
textwrap.fill(help, initial_indent=' ',
1383
subsequent_indent=' ',
1384
break_long_words=False))
1385
if default_realkey is not None:
1386
output += wrapped(default_realkey, '(default) %s' % default_help,
1387
self.get_info('default'))
1388
deprecated_pairs = []
1389
experimental_pairs = []
1390
for key, help in help_pairs:
1391
info = self.get_info(key)
1394
elif info.deprecated:
1395
deprecated_pairs.append((key, help))
1396
elif info.experimental:
1397
experimental_pairs.append((key, help))
1399
output += wrapped(key, help, info)
1400
output += "\nSee :doc:`formats-help` for more about storage formats."
1402
if len(experimental_pairs) > 0:
1403
other_output += "Experimental formats are shown below.\n\n"
1404
for key, help in experimental_pairs:
1405
info = self.get_info(key)
1406
other_output += wrapped(key, help, info)
1409
"No experimental formats are available.\n\n"
1410
if len(deprecated_pairs) > 0:
1411
other_output += "\nDeprecated formats are shown below.\n\n"
1412
for key, help in deprecated_pairs:
1413
info = self.get_info(key)
1414
other_output += wrapped(key, help, info)
1417
"\nNo deprecated formats are available.\n\n"
1419
"\nSee :doc:`formats-help` for more about storage formats."
1421
if topic == 'other-formats':
1427
class RepoInitHookParams(object):
1428
"""Object holding parameters passed to `*_repo_init` hooks.
1430
There are 4 fields that hooks may wish to access:
1432
:ivar repository: Repository created
1433
:ivar format: Repository format
1434
:ivar bzrdir: The controldir for the repository
1435
:ivar shared: The repository is shared
1438
def __init__(self, repository, format, controldir, shared):
1439
"""Create a group of RepoInitHook parameters.
1441
:param repository: Repository created
1442
:param format: Repository format
1443
:param controldir: The controldir for the repository
1444
:param shared: The repository is shared
1446
self.repository = repository
1447
self.format = format
1448
self.controldir = controldir
1449
self.shared = shared
1451
def __eq__(self, other):
1452
return self.__dict__ == other.__dict__
1456
return "<%s for %s>" % (self.__class__.__name__,
1459
return "<%s for %s>" % (self.__class__.__name__,
1463
def is_control_filename(filename):
1464
"""Check if filename is used for control directories."""
1465
# TODO(jelmer): Allow registration by other VCSes
1466
return filename == '.bzr'
1469
class RepositoryAcquisitionPolicy(object):
1470
"""Abstract base class for repository acquisition policies.
1472
A repository acquisition policy decides how a ControlDir acquires a repository
1473
for a branch that is being created. The most basic policy decision is
1474
whether to create a new repository or use an existing one.
1476
def __init__(self, stack_on, stack_on_pwd, require_stacking):
1479
:param stack_on: A location to stack on
1480
:param stack_on_pwd: If stack_on is relative, the location it is
1482
:param require_stacking: If True, it is a failure to not stack.
1484
self._stack_on = stack_on
1485
self._stack_on_pwd = stack_on_pwd
1486
self._require_stacking = require_stacking
1488
def configure_branch(self, branch):
1489
"""Apply any configuration data from this policy to the branch.
1491
Default implementation sets repository stacking.
1493
if self._stack_on is None:
1495
if self._stack_on_pwd is None:
1496
stack_on = self._stack_on
1499
stack_on = urlutils.rebase_url(self._stack_on,
1502
except urlutils.InvalidRebaseURLs:
1503
stack_on = self._get_full_stack_on()
1505
branch.set_stacked_on_url(stack_on)
1506
except (_mod_branch.UnstackableBranchFormat,
1507
errors.UnstackableRepositoryFormat):
1508
if self._require_stacking:
1511
def requires_stacking(self):
1512
"""Return True if this policy requires stacking."""
1513
return self._stack_on is not None and self._require_stacking
1515
def _get_full_stack_on(self):
1516
"""Get a fully-qualified URL for the stack_on location."""
1517
if self._stack_on is None:
1519
if self._stack_on_pwd is None:
1520
return self._stack_on
1522
return urlutils.join(self._stack_on_pwd, self._stack_on)
1524
def _add_fallback(self, repository, possible_transports=None):
1525
"""Add a fallback to the supplied repository, if stacking is set."""
1526
stack_on = self._get_full_stack_on()
1527
if stack_on is None:
1530
stacked_dir = ControlDir.open(
1531
stack_on, possible_transports=possible_transports)
1532
except errors.JailBreak:
1533
# We keep the stacking details, but we are in the server code so
1534
# actually stacking is not needed.
1537
stacked_repo = stacked_dir.open_branch().repository
1538
except errors.NotBranchError:
1539
stacked_repo = stacked_dir.open_repository()
1541
repository.add_fallback_repository(stacked_repo)
1542
except errors.UnstackableRepositoryFormat:
1543
if self._require_stacking:
1546
self._require_stacking = True
1548
def acquire_repository(self, make_working_trees=None, shared=False,
1549
possible_transports=None):
1550
"""Acquire a repository for this controlrdir.
1552
Implementations may create a new repository or use a pre-exising
1555
:param make_working_trees: If creating a repository, set
1556
make_working_trees to this value (if non-None)
1557
:param shared: If creating a repository, make it shared if True
1558
:return: A repository, is_new_flag (True if the repository was
1561
raise NotImplementedError(RepositoryAcquisitionPolicy.acquire_repository)
1564
# Please register new formats after old formats so that formats
1565
# appear in chronological order and format descriptions can build
1567
format_registry = ControlDirFormatRegistry()
1569
network_format_registry = registry.FormatRegistry()
1570
"""Registry of formats indexed by their network name.
1572
The network name for a ControlDirFormat is an identifier that can be used when
1573
referring to formats with smart server operations. See
1574
ControlDirFormat.network_name() for more detail.
added
removed
breezy/controldir.py
