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 bzrlib.bzrdir.BzrDir.
25
from __future__ import absolute_import
27
from bzrlib.lazy_import import lazy_import
28
lazy_import(globals(), """
34
revision as _mod_revision,
35
transport as _mod_transport,
40
from bzrlib.transport import local
41
from bzrlib.push import (
45
from bzrlib.i18n import gettext
48
from bzrlib import registry
51
class ControlComponent(object):
52
"""Abstract base class for control directory components.
54
This provides interfaces that are common across controldirs,
55
repositories, branches, and workingtree control directories.
57
They all expose two urls and transports: the *user* URL is the
58
one that stops above the control directory (eg .bzr) and that
59
should normally be used in messages, and the *control* URL is
60
under that in eg .bzr/checkout and is used to read the control
63
This can be used as a mixin and is intended to fit with
68
def control_transport(self):
69
raise NotImplementedError
72
def control_url(self):
73
return self.control_transport.base
76
def user_transport(self):
77
raise NotImplementedError
81
return self.user_transport.base
84
class ControlDir(ControlComponent):
85
"""A control directory.
87
While this represents a generic control directory, there are a few
88
features that are present in this interface that are currently only
89
supported by one of its implementations, BzrDir.
91
These features (bound branches, stacked branches) are currently only
92
supported by Bazaar, but could be supported by other version control
93
systems as well. Implementations are required to raise the appropriate
94
exceptions when an operation is requested that is not supported.
96
This also makes life easier for API users who can rely on the
97
implementation always allowing a particular feature to be requested but
98
raising an exception when it is not supported, rather than requiring the
99
API users to check for magic attributes to see what features are supported.
102
def can_convert_format(self):
103
"""Return true if this controldir is one whose format we can convert
107
def list_branches(self):
108
"""Return a sequence of all branches local to this control directory.
111
return self.get_branches().values()
113
def get_branches(self):
114
"""Get all branches in this control directory, as a dictionary.
116
:return: Dictionary mapping branch names to instances.
119
return { None: self.open_branch() }
120
except (errors.NotBranchError, errors.NoRepositoryPresent):
123
def is_control_filename(self, filename):
124
"""True if filename is the name of a path which is reserved for
127
:param filename: A filename within the root transport of this
130
This is true IF and ONLY IF the filename is part of the namespace reserved
131
for bzr control dirs. Currently this is the '.bzr' directory in the root
132
of the root_transport. it is expected that plugins will need to extend
133
this in the future - for instance to make bzr talk with svn working
136
raise NotImplementedError(self.is_control_filename)
138
def needs_format_conversion(self, format=None):
139
"""Return true if this controldir needs convert_format run on it.
141
For instance, if the repository format is out of date but the
142
branch and working tree are not, this should return True.
144
:param format: Optional parameter indicating a specific desired
145
format we plan to arrive at.
147
raise NotImplementedError(self.needs_format_conversion)
149
def create_repository(self, shared=False):
150
"""Create a new repository in this control directory.
152
:param shared: If a shared repository should be created
153
:return: The newly created repository
155
raise NotImplementedError(self.create_repository)
157
def destroy_repository(self):
158
"""Destroy the repository in this ControlDir."""
159
raise NotImplementedError(self.destroy_repository)
161
def create_branch(self, name=None, repository=None,
162
append_revisions_only=None):
163
"""Create a branch in this ControlDir.
165
:param name: Name of the colocated branch to create, None for
167
:param append_revisions_only: Whether this branch should only allow
168
appending new revisions to its history.
170
The controldirs format will control what branch format is created.
171
For more control see BranchFormatXX.create(a_controldir).
173
raise NotImplementedError(self.create_branch)
175
def destroy_branch(self, name=None):
176
"""Destroy a branch in this ControlDir.
178
:param name: Name of the branch to destroy, None for the default
181
raise NotImplementedError(self.destroy_branch)
183
def create_workingtree(self, revision_id=None, from_branch=None,
184
accelerator_tree=None, hardlink=False):
185
"""Create a working tree at this ControlDir.
187
:param revision_id: create it as of this revision id.
188
:param from_branch: override controldir branch
189
(for lightweight checkouts)
190
:param accelerator_tree: A tree which can be used for retrieving file
191
contents more quickly than the revision tree, i.e. a workingtree.
192
The revision tree will be used for cases where accelerator_tree's
193
content is different.
195
raise NotImplementedError(self.create_workingtree)
197
def destroy_workingtree(self):
198
"""Destroy the working tree at this ControlDir.
200
Formats that do not support this may raise UnsupportedOperation.
202
raise NotImplementedError(self.destroy_workingtree)
204
def destroy_workingtree_metadata(self):
205
"""Destroy the control files for the working tree at this ControlDir.
207
The contents of working tree files are not affected.
208
Formats that do not support this may raise UnsupportedOperation.
210
raise NotImplementedError(self.destroy_workingtree_metadata)
212
def find_branch_format(self, name=None):
213
"""Find the branch 'format' for this controldir.
215
This might be a synthetic object for e.g. RemoteBranch and SVN.
217
raise NotImplementedError(self.find_branch_format)
219
def get_branch_reference(self, name=None):
220
"""Return the referenced URL for the branch in this controldir.
222
:param name: Optional colocated branch name
223
:raises NotBranchError: If there is no Branch.
224
:raises NoColocatedBranchSupport: If a branch name was specified
225
but colocated branches are not supported.
226
:return: The URL the branch in this controldir references if it is a
227
reference branch, or None for regular branches.
230
raise errors.NoColocatedBranchSupport(self)
233
def open_branch(self, name=None, unsupported=False,
234
ignore_fallbacks=False, possible_transports=None):
235
"""Open the branch object at this ControlDir if one is present.
237
:param unsupported: if True, then no longer supported branch formats can
239
:param ignore_fallbacks: Whether to open fallback repositories
240
:param possible_transports: Transports to use for opening e.g.
241
fallback repositories.
243
raise NotImplementedError(self.open_branch)
245
def open_repository(self, _unsupported=False):
246
"""Open the repository object at this ControlDir if one is present.
248
This will not follow the Branch object pointer - it's strictly a direct
249
open facility. Most client code should use open_branch().repository to
252
:param _unsupported: a private parameter, not part of the api.
254
raise NotImplementedError(self.open_repository)
256
def find_repository(self):
257
"""Find the repository that should be used.
259
This does not require a branch as we use it to find the repo for
260
new branches as well as to hook existing branches up to their
263
raise NotImplementedError(self.find_repository)
265
def open_workingtree(self, _unsupported=False,
266
recommend_upgrade=True, from_branch=None):
267
"""Open the workingtree object at this ControlDir if one is present.
269
:param recommend_upgrade: Optional keyword parameter, when True (the
270
default), emit through the ui module a recommendation that the user
271
upgrade the working tree when the workingtree being opened is old
272
(but still fully supported).
273
:param from_branch: override controldir branch (for lightweight
276
raise NotImplementedError(self.open_workingtree)
278
def has_branch(self, name=None):
279
"""Tell if this controldir contains a branch.
281
Note: if you're going to open the branch, you should just go ahead
282
and try, and not ask permission first. (This method just opens the
283
branch and discards it, and that's somewhat expensive.)
286
self.open_branch(name, ignore_fallbacks=True)
288
except errors.NotBranchError:
291
def _get_selected_branch(self):
292
"""Return the name of the branch selected by the user.
294
:return: Name of the branch selected by the user, or None.
296
branch = self.root_transport.get_segment_parameters().get("branch")
297
if branch is not None:
298
branch = urlutils.unescape(branch)
301
def has_workingtree(self):
302
"""Tell if this controldir contains a working tree.
304
This will still raise an exception if the controldir has a workingtree
305
that is remote & inaccessible.
307
Note: if you're going to open the working tree, you should just go ahead
308
and try, and not ask permission first. (This method just opens the
309
workingtree and discards it, and that's somewhat expensive.)
312
self.open_workingtree(recommend_upgrade=False)
314
except errors.NoWorkingTree:
317
def cloning_metadir(self, require_stacking=False):
318
"""Produce a metadir suitable for cloning or sprouting with.
320
These operations may produce workingtrees (yes, even though they're
321
"cloning" something that doesn't have a tree), so a viable workingtree
322
format must be selected.
324
:require_stacking: If True, non-stackable formats will be upgraded
325
to similar stackable formats.
326
:returns: a ControlDirFormat with all component formats either set
327
appropriately or set to None if that component should not be
330
raise NotImplementedError(self.cloning_metadir)
332
def checkout_metadir(self):
333
"""Produce a metadir suitable for checkouts of this controldir.
335
:returns: A ControlDirFormat with all component formats
336
either set appropriately or set to None if that component
337
should not be created.
339
return self.cloning_metadir()
341
def sprout(self, url, revision_id=None, force_new_repo=False,
342
recurse='down', possible_transports=None,
343
accelerator_tree=None, hardlink=False, stacked=False,
344
source_branch=None, create_tree_if_local=True):
345
"""Create a copy of this controldir prepared for use as a new line of
348
If url's last component does not exist, it will be created.
350
Attributes related to the identity of the source branch like
351
branch nickname will be cleaned, a working tree is created
352
whether one existed before or not; and a local branch is always
355
:param revision_id: if revision_id is not None, then the clone
356
operation may tune itself to download less data.
357
:param accelerator_tree: A tree which can be used for retrieving file
358
contents more quickly than the revision tree, i.e. a workingtree.
359
The revision tree will be used for cases where accelerator_tree's
360
content is different.
361
:param hardlink: If true, hard-link files from accelerator_tree,
363
:param stacked: If true, create a stacked branch referring to the
364
location of this control directory.
365
:param create_tree_if_local: If true, a working-tree will be created
366
when working locally.
368
raise NotImplementedError(self.sprout)
370
def push_branch(self, source, revision_id=None, overwrite=False,
371
remember=False, create_prefix=False):
372
"""Push the source branch into this ControlDir."""
374
# If we can open a branch, use its direct repository, otherwise see
375
# if there is a repository without a branch.
377
br_to = self.open_branch()
378
except errors.NotBranchError:
379
# Didn't find a branch, can we find a repository?
380
repository_to = self.find_repository()
382
# Found a branch, so we must have found a repository
383
repository_to = br_to.repository
385
push_result = PushResult()
386
push_result.source_branch = source
388
# We have a repository but no branch, copy the revisions, and then
390
if revision_id is None:
391
# No revision supplied by the user, default to the branch
393
revision_id = source.last_revision()
394
repository_to.fetch(source.repository, revision_id=revision_id)
395
br_to = source.clone(self, revision_id=revision_id)
396
if source.get_push_location() is None or remember:
399
source.set_push_location(br_to.base)
402
push_result.stacked_on = None
403
push_result.branch_push_result = None
404
push_result.old_revno = None
405
push_result.old_revid = _mod_revision.NULL_REVISION
406
push_result.target_branch = br_to
407
push_result.master_branch = None
408
push_result.workingtree_updated = False
410
# We have successfully opened the branch, remember if necessary:
411
if source.get_push_location() is None or remember:
414
source.set_push_location(br_to.base)
418
tree_to = self.open_workingtree()
419
except errors.NotLocalUrl:
420
push_result.branch_push_result = source.push(br_to,
421
overwrite, stop_revision=revision_id)
422
push_result.workingtree_updated = False
423
except errors.NoWorkingTree:
424
push_result.branch_push_result = source.push(br_to,
425
overwrite, stop_revision=revision_id)
426
push_result.workingtree_updated = None # Not applicable
430
push_result.branch_push_result = source.push(
431
tree_to.branch, overwrite, stop_revision=revision_id)
435
push_result.workingtree_updated = True
436
push_result.old_revno = push_result.branch_push_result.old_revno
437
push_result.old_revid = push_result.branch_push_result.old_revid
438
push_result.target_branch = \
439
push_result.branch_push_result.target_branch
442
def _get_tree_branch(self, name=None):
443
"""Return the branch and tree, if any, for this controldir.
445
:param name: Name of colocated branch to open.
447
Return None for tree if not present or inaccessible.
448
Raise NotBranchError if no branch is present.
449
:return: (tree, branch)
452
tree = self.open_workingtree()
453
except (errors.NoWorkingTree, errors.NotLocalUrl):
455
branch = self.open_branch(name=name)
458
branch = self.open_branch(name=name)
463
def get_config(self):
464
"""Get configuration for this ControlDir."""
465
raise NotImplementedError(self.get_config)
467
def check_conversion_target(self, target_format):
468
"""Check that a controldir as a whole can be converted to a new format."""
469
raise NotImplementedError(self.check_conversion_target)
471
def clone(self, url, revision_id=None, force_new_repo=False,
472
preserve_stacking=False):
473
"""Clone this controldir and its contents to url verbatim.
475
:param url: The url create the clone at. If url's last component does
476
not exist, it will be created.
477
:param revision_id: The tip revision-id to use for any branch or
478
working tree. If not None, then the clone operation may tune
479
itself to download less data.
480
:param force_new_repo: Do not use a shared repository for the target
481
even if one is available.
482
:param preserve_stacking: When cloning a stacked branch, stack the
483
new branch on top of the other branch's stacked-on branch.
485
return self.clone_on_transport(_mod_transport.get_transport(url),
486
revision_id=revision_id,
487
force_new_repo=force_new_repo,
488
preserve_stacking=preserve_stacking)
490
def clone_on_transport(self, transport, revision_id=None,
491
force_new_repo=False, preserve_stacking=False, stacked_on=None,
492
create_prefix=False, use_existing_dir=True, no_tree=False):
493
"""Clone this controldir and its contents to transport verbatim.
495
:param transport: The transport for the location to produce the clone
496
at. If the target directory does not exist, it will be created.
497
:param revision_id: The tip revision-id to use for any branch or
498
working tree. If not None, then the clone operation may tune
499
itself to download less data.
500
:param force_new_repo: Do not use a shared repository for the target,
501
even if one is available.
502
:param preserve_stacking: When cloning a stacked branch, stack the
503
new branch on top of the other branch's stacked-on branch.
504
:param create_prefix: Create any missing directories leading up to
506
:param use_existing_dir: Use an existing directory if one exists.
507
:param no_tree: If set to true prevents creation of a working tree.
509
raise NotImplementedError(self.clone_on_transport)
512
def find_bzrdirs(klass, transport, evaluate=None, list_current=None):
513
"""Find control dirs recursively from current location.
515
This is intended primarily as a building block for more sophisticated
516
functionality, like finding trees under a directory, or finding
517
branches that use a given repository.
519
:param evaluate: An optional callable that yields recurse, value,
520
where recurse controls whether this controldir is recursed into
521
and value is the value to yield. By default, all bzrdirs
522
are recursed into, and the return value is the controldir.
523
:param list_current: if supplied, use this function to list the current
524
directory, instead of Transport.list_dir
525
:return: a generator of found bzrdirs, or whatever evaluate returns.
527
if list_current is None:
528
def list_current(transport):
529
return transport.list_dir('')
531
def evaluate(controldir):
532
return True, controldir
534
pending = [transport]
535
while len(pending) > 0:
536
current_transport = pending.pop()
539
controldir = klass.open_from_transport(current_transport)
540
except (errors.NotBranchError, errors.PermissionDenied):
543
recurse, value = evaluate(controldir)
546
subdirs = list_current(current_transport)
547
except (errors.NoSuchFile, errors.PermissionDenied):
550
for subdir in sorted(subdirs, reverse=True):
551
pending.append(current_transport.clone(subdir))
554
def find_branches(klass, transport):
555
"""Find all branches under a transport.
557
This will find all branches below the transport, including branches
558
inside other branches. Where possible, it will use
559
Repository.find_branches.
561
To list all the branches that use a particular Repository, see
562
Repository.find_branches
564
def evaluate(controldir):
566
repository = controldir.open_repository()
567
except errors.NoRepositoryPresent:
570
return False, ([], repository)
571
return True, (controldir.list_branches(), None)
573
for branches, repo in klass.find_bzrdirs(
574
transport, evaluate=evaluate):
576
ret.extend(repo.find_branches())
577
if branches is not None:
582
def create_branch_and_repo(klass, base, force_new_repo=False, format=None):
583
"""Create a new ControlDir, Branch and Repository at the url 'base'.
585
This will use the current default ControlDirFormat unless one is
586
specified, and use whatever
587
repository format that that uses via controldir.create_branch and
588
create_repository. If a shared repository is available that is used
591
The created Branch object is returned.
593
:param base: The URL to create the branch at.
594
:param force_new_repo: If True a new repository is always created.
595
:param format: If supplied, the format of branch to create. If not
596
supplied, the default is used.
598
controldir = klass.create(base, format)
599
controldir._find_or_create_repository(force_new_repo)
600
return controldir.create_branch()
603
def create_branch_convenience(klass, base, force_new_repo=False,
604
force_new_tree=None, format=None,
605
possible_transports=None):
606
"""Create a new ControlDir, Branch and Repository at the url 'base'.
608
This is a convenience function - it will use an existing repository
609
if possible, can be told explicitly whether to create a working tree or
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
616
preferentially. Whatever repository is used, its tree creation policy
619
The created Branch object is returned.
620
If a working tree cannot be made due to base not being a file:// url,
621
no error is raised unless force_new_tree is True, in which case no
622
data is created on disk and NotLocalUrl is raised.
624
:param base: The URL to create the branch at.
625
:param force_new_repo: If True a new repository is always created.
626
:param force_new_tree: If True or False force creation of a tree or
627
prevent such creation respectively.
628
:param format: Override for the controldir format to create.
629
:param possible_transports: An optional reusable transports list.
632
# check for non local urls
633
t = _mod_transport.get_transport(base, possible_transports)
634
if not isinstance(t, local.LocalTransport):
635
raise errors.NotLocalUrl(base)
636
controldir = klass.create(base, format, possible_transports)
637
repo = controldir._find_or_create_repository(force_new_repo)
638
result = controldir.create_branch()
639
if force_new_tree or (repo.make_working_trees() and
640
force_new_tree is None):
642
controldir.create_workingtree()
643
except errors.NotLocalUrl:
648
def create_standalone_workingtree(klass, base, format=None):
649
"""Create a new ControlDir, WorkingTree, Branch and Repository at 'base'.
651
'base' must be a local path or a file:// url.
653
This will use the current default ControlDirFormat unless one is
654
specified, and use whatever
655
repository format that that uses for bzrdirformat.create_workingtree,
656
create_branch and create_repository.
658
:param format: Override for the controldir format to create.
659
:return: The WorkingTree object.
661
t = _mod_transport.get_transport(base)
662
if not isinstance(t, local.LocalTransport):
663
raise errors.NotLocalUrl(base)
664
controldir = klass.create_branch_and_repo(base,
666
format=format).bzrdir
667
return controldir.create_workingtree()
670
def open_unsupported(klass, base):
671
"""Open a branch which is not supported."""
672
return klass.open(base, _unsupported=True)
675
def open(klass, base, _unsupported=False, possible_transports=None):
676
"""Open an existing controldir, rooted at 'base' (url).
678
:param _unsupported: a private parameter to the ControlDir class.
680
t = _mod_transport.get_transport(base, possible_transports)
681
return klass.open_from_transport(t, _unsupported=_unsupported)
684
def open_from_transport(klass, transport, _unsupported=False,
685
_server_formats=True):
686
"""Open a controldir within a particular directory.
688
:param transport: Transport containing the controldir.
689
:param _unsupported: private.
691
for hook in klass.hooks['pre_open']:
693
# Keep initial base since 'transport' may be modified while following
695
base = transport.base
696
def find_format(transport):
697
return transport, ControlDirFormat.find_format(
698
transport, _server_formats=_server_formats)
700
def redirected(transport, e, redirection_notice):
701
redirected_transport = transport._redirected_to(e.source, e.target)
702
if redirected_transport is None:
703
raise errors.NotBranchError(base)
704
trace.note(gettext('{0} is{1} redirected to {2}').format(
705
transport.base, e.permanently, redirected_transport.base))
706
return redirected_transport
709
transport, format = _mod_transport.do_catching_redirections(
710
find_format, transport, redirected)
711
except errors.TooManyRedirections:
712
raise errors.NotBranchError(base)
714
format.check_support_status(_unsupported)
715
return format.open(transport, _found=True)
718
def open_containing(klass, url, possible_transports=None):
719
"""Open an existing branch which contains url.
721
:param url: url to search from.
723
See open_containing_from_transport for more detail.
725
transport = _mod_transport.get_transport(url, possible_transports)
726
return klass.open_containing_from_transport(transport)
729
def open_containing_from_transport(klass, a_transport):
730
"""Open an existing branch which contains a_transport.base.
732
This probes for a branch at a_transport, and searches upwards from there.
734
Basically we keep looking up until we find the control directory or
735
run into the root. If there isn't one, raises NotBranchError.
736
If there is one and it is either an unrecognised format or an unsupported
737
format, UnknownFormatError or UnsupportedFormatError are raised.
738
If there is one, it is returned, along with the unused portion of url.
740
:return: The ControlDir that contains the path, and a Unicode path
741
for the rest of the URL.
743
# this gets the normalised url back. I.e. '.' -> the full path.
744
url = a_transport.base
747
result = klass.open_from_transport(a_transport)
748
return result, urlutils.unescape(a_transport.relpath(url))
749
except errors.NotBranchError, e:
751
except errors.PermissionDenied:
754
new_t = a_transport.clone('..')
755
except errors.InvalidURLJoin:
756
# reached the root, whatever that may be
757
raise errors.NotBranchError(path=url)
758
if new_t.base == a_transport.base:
759
# reached the root, whatever that may be
760
raise errors.NotBranchError(path=url)
764
def open_tree_or_branch(klass, location):
765
"""Return the branch and working tree at a location.
767
If there is no tree at the location, tree will be None.
768
If there is no branch at the location, an exception will be
770
:return: (tree, branch)
772
controldir = klass.open(location)
773
return controldir._get_tree_branch()
776
def open_containing_tree_or_branch(klass, location):
777
"""Return the branch and working tree contained by a location.
779
Returns (tree, branch, relpath).
780
If there is no tree at containing the location, tree will be None.
781
If there is no branch containing the location, an exception will be
783
relpath is the portion of the path that is contained by the branch.
785
controldir, relpath = klass.open_containing(location)
786
tree, branch = controldir._get_tree_branch()
787
return tree, branch, relpath
790
def open_containing_tree_branch_or_repository(klass, location):
791
"""Return the working tree, branch and repo contained by a location.
793
Returns (tree, branch, repository, relpath).
794
If there is no tree containing the location, tree will be None.
795
If there is no branch containing the location, branch will be None.
796
If there is no repository containing the location, repository will be
798
relpath is the portion of the path that is contained by the innermost
801
If no tree, branch or repository is found, a NotBranchError is raised.
803
controldir, relpath = klass.open_containing(location)
805
tree, branch = controldir._get_tree_branch()
806
except errors.NotBranchError:
808
repo = controldir.find_repository()
809
return None, None, repo, relpath
810
except (errors.NoRepositoryPresent):
811
raise errors.NotBranchError(location)
812
return tree, branch, branch.repository, relpath
815
def create(klass, base, format=None, possible_transports=None):
816
"""Create a new ControlDir at the url 'base'.
818
:param format: If supplied, the format of branch to create. If not
819
supplied, the default is used.
820
:param possible_transports: If supplied, a list of transports that
821
can be reused to share a remote connection.
823
if klass is not ControlDir:
824
raise AssertionError("ControlDir.create always creates the"
825
"default format, not one of %r" % klass)
826
t = _mod_transport.get_transport(base, possible_transports)
829
format = ControlDirFormat.get_default_format()
830
return format.initialize_on_transport(t)
833
class ControlDirHooks(hooks.Hooks):
834
"""Hooks for ControlDir operations."""
837
"""Create the default hooks."""
838
hooks.Hooks.__init__(self, "bzrlib.controldir", "ControlDir.hooks")
839
self.add_hook('pre_open',
840
"Invoked before attempting to open a ControlDir with the transport "
841
"that the open will use.", (1, 14))
842
self.add_hook('post_repo_init',
843
"Invoked after a repository has been initialized. "
844
"post_repo_init is called with a "
845
"bzrlib.controldir.RepoInitHookParams.",
848
# install the default hooks
849
ControlDir.hooks = ControlDirHooks()
852
class ControlComponentFormat(object):
853
"""A component that can live inside of a control directory."""
855
upgrade_recommended = False
857
def get_format_description(self):
858
"""Return the short description for this format."""
859
raise NotImplementedError(self.get_format_description)
861
def is_supported(self):
862
"""Is this format supported?
864
Supported formats must be initializable and openable.
865
Unsupported formats may not support initialization or committing or
866
some other features depending on the reason for not being supported.
870
def check_support_status(self, allow_unsupported, recommend_upgrade=True,
872
"""Give an error or warning on old formats.
874
:param allow_unsupported: If true, allow opening
875
formats that are strongly deprecated, and which may
876
have limited functionality.
878
:param recommend_upgrade: If true (default), warn
879
the user through the ui object that they may wish
880
to upgrade the object.
882
if not allow_unsupported and not self.is_supported():
883
# see open_downlevel to open legacy branches.
884
raise errors.UnsupportedFormatError(format=self)
885
if recommend_upgrade and self.upgrade_recommended:
886
ui.ui_factory.recommend_upgrade(
887
self.get_format_description(), basedir)
890
def get_format_string(cls):
891
raise NotImplementedError(cls.get_format_string)
894
class ControlComponentFormatRegistry(registry.FormatRegistry):
895
"""A registry for control components (branch, workingtree, repository)."""
897
def __init__(self, other_registry=None):
898
super(ControlComponentFormatRegistry, self).__init__(other_registry)
899
self._extra_formats = []
901
def register(self, format):
902
"""Register a new format."""
903
super(ControlComponentFormatRegistry, self).register(
904
format.get_format_string(), format)
906
def remove(self, format):
907
"""Remove a registered format."""
908
super(ControlComponentFormatRegistry, self).remove(
909
format.get_format_string())
911
def register_extra(self, format):
912
"""Register a format that can not be used in a metadir.
914
This is mainly useful to allow custom repository formats, such as older
915
Bazaar formats and foreign formats, to be tested.
917
self._extra_formats.append(registry._ObjectGetter(format))
919
def remove_extra(self, format):
920
"""Remove an extra format.
922
self._extra_formats.remove(registry._ObjectGetter(format))
924
def register_extra_lazy(self, module_name, member_name):
925
"""Register a format lazily.
927
self._extra_formats.append(
928
registry._LazyObjectGetter(module_name, member_name))
930
def _get_extra(self):
931
"""Return all "extra" formats, not usable in meta directories."""
933
for getter in self._extra_formats:
941
"""Return all formats, even those not usable in metadirs.
944
for name in self.keys():
949
return result + self._get_extra()
951
def _get_all_modules(self):
952
"""Return a set of the modules providing objects."""
954
for name in self.keys():
955
modules.add(self._get_module(name))
956
for getter in self._extra_formats:
957
modules.add(getter.get_module())
961
class Converter(object):
962
"""Converts a disk format object from one format to another."""
964
def convert(self, to_convert, pb):
965
"""Perform the conversion of to_convert, giving feedback via pb.
967
:param to_convert: The disk object to convert.
968
:param pb: a progress bar to use for progress information.
971
def step(self, message):
972
"""Update the pb by a step."""
974
self.pb.update(message, self.count, self.total)
977
class ControlDirFormat(object):
978
"""An encapsulation of the initialization and open routines for a format.
980
Formats provide three things:
981
* An initialization routine,
985
Formats are placed in a dict by their format string for reference
986
during controldir opening. These should be subclasses of ControlDirFormat
989
Once a format is deprecated, just deprecate the initialize and open
990
methods on the format class. Do not deprecate the object, as the
991
object will be created every system load.
993
:cvar colocated_branches: Whether this formats supports colocated branches.
994
:cvar supports_workingtrees: This control directory can co-exist with a
998
_default_format = None
999
"""The default format used for new control directories."""
1001
_server_probers = []
1002
"""The registered server format probers, e.g. RemoteBzrProber.
1004
This is a list of Prober-derived classes.
1008
"""The registered format probers, e.g. BzrProber.
1010
This is a list of Prober-derived classes.
1013
colocated_branches = False
1014
"""Whether co-located branches are supported for this control dir format.
1017
supports_workingtrees = True
1018
"""Whether working trees can exist in control directories of this format.
1021
fixed_components = False
1022
"""Whether components can not change format independent of the control dir.
1025
upgrade_recommended = False
1026
"""Whether an upgrade from this format is recommended."""
1028
def get_format_description(self):
1029
"""Return the short description for this format."""
1030
raise NotImplementedError(self.get_format_description)
1032
def get_converter(self, format=None):
1033
"""Return the converter to use to convert controldirs needing converts.
1035
This returns a bzrlib.controldir.Converter object.
1037
This should return the best upgrader to step this format towards the
1038
current default format. In the case of plugins we can/should provide
1039
some means for them to extend the range of returnable converters.
1041
:param format: Optional format to override the default format of the
1044
raise NotImplementedError(self.get_converter)
1046
def is_supported(self):
1047
"""Is this format supported?
1049
Supported formats must be openable.
1050
Unsupported formats may not support initialization or committing or
1051
some other features depending on the reason for not being supported.
1055
def is_initializable(self):
1056
"""Whether new control directories of this format can be initialized.
1058
return self.is_supported()
1060
def check_support_status(self, allow_unsupported, recommend_upgrade=True,
1062
"""Give an error or warning on old formats.
1064
:param allow_unsupported: If true, allow opening
1065
formats that are strongly deprecated, and which may
1066
have limited functionality.
1068
:param recommend_upgrade: If true (default), warn
1069
the user through the ui object that they may wish
1070
to upgrade the object.
1072
if not allow_unsupported and not self.is_supported():
1073
# see open_downlevel to open legacy branches.
1074
raise errors.UnsupportedFormatError(format=self)
1075
if recommend_upgrade and self.upgrade_recommended:
1076
ui.ui_factory.recommend_upgrade(
1077
self.get_format_description(), basedir)
1079
def same_model(self, target_format):
1080
return (self.repository_format.rich_root_data ==
1081
target_format.rich_root_data)
1084
def register_format(klass, format):
1085
"""Register a format that does not use '.bzr' for its control dir.
1088
raise errors.BzrError("ControlDirFormat.register_format() has been "
1089
"removed in Bazaar 2.4. Please upgrade your plugins.")
1092
def register_prober(klass, prober):
1093
"""Register a prober that can look for a control dir.
1096
klass._probers.append(prober)
1099
def unregister_prober(klass, prober):
1100
"""Unregister a prober.
1103
klass._probers.remove(prober)
1106
def register_server_prober(klass, prober):
1107
"""Register a control format prober for client-server environments.
1109
These probers will be used before ones registered with
1110
register_prober. This gives implementations that decide to the
1111
chance to grab it before anything looks at the contents of the format
1114
klass._server_probers.append(prober)
1118
return self.get_format_description().rstrip()
1121
def known_formats(klass):
1122
"""Return all the known formats.
1125
for prober_kls in klass._probers + klass._server_probers:
1126
result.update(prober_kls.known_formats())
1130
def find_format(klass, transport, _server_formats=True):
1131
"""Return the format present at transport."""
1133
_probers = klass._server_probers + klass._probers
1135
_probers = klass._probers
1136
for prober_kls in _probers:
1137
prober = prober_kls()
1139
return prober.probe_transport(transport)
1140
except errors.NotBranchError:
1141
# this format does not find a control dir here.
1143
raise errors.NotBranchError(path=transport.base)
1145
def initialize(self, url, possible_transports=None):
1146
"""Create a control dir at this url and return an opened copy.
1148
While not deprecated, this method is very specific and its use will
1149
lead to many round trips to setup a working environment. See
1150
initialize_on_transport_ex for a [nearly] all-in-one method.
1152
Subclasses should typically override initialize_on_transport
1153
instead of this method.
1155
return self.initialize_on_transport(
1156
_mod_transport.get_transport(url, possible_transports))
1158
def initialize_on_transport(self, transport):
1159
"""Initialize a new controldir in the base directory of a Transport."""
1160
raise NotImplementedError(self.initialize_on_transport)
1162
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
1163
create_prefix=False, force_new_repo=False, stacked_on=None,
1164
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
1165
shared_repo=False, vfs_only=False):
1166
"""Create this format on transport.
1168
The directory to initialize will be created.
1170
:param force_new_repo: Do not use a shared repository for the target,
1171
even if one is available.
1172
:param create_prefix: Create any missing directories leading up to
1174
:param use_existing_dir: Use an existing directory if one exists.
1175
:param stacked_on: A url to stack any created branch on, None to follow
1176
any target stacking policy.
1177
:param stack_on_pwd: If stack_on is relative, the location it is
1179
:param repo_format_name: If non-None, a repository will be
1180
made-or-found. Should none be found, or if force_new_repo is True
1181
the repo_format_name is used to select the format of repository to
1183
:param make_working_trees: Control the setting of make_working_trees
1184
for a new shared repository when one is made. None to use whatever
1185
default the format has.
1186
:param shared_repo: Control whether made repositories are shared or
1188
:param vfs_only: If True do not attempt to use a smart server
1189
:return: repo, controldir, require_stacking, repository_policy. repo is
1190
None if none was created or found, controldir is always valid.
1191
require_stacking is the result of examining the stacked_on
1192
parameter and any stacking policy found for the target.
1194
raise NotImplementedError(self.initialize_on_transport_ex)
1196
def network_name(self):
1197
"""A simple byte string uniquely identifying this format for RPC calls.
1199
Bzr control formats use this disk format string to identify the format
1200
over the wire. Its possible that other control formats have more
1201
complex detection requirements, so we permit them to use any unique and
1202
immutable string they desire.
1204
raise NotImplementedError(self.network_name)
1206
def open(self, transport, _found=False):
1207
"""Return an instance of this format for the dir transport points at.
1209
raise NotImplementedError(self.open)
1212
def _set_default_format(klass, format):
1213
"""Set default format (for testing behavior of defaults only)"""
1214
klass._default_format = format
1217
def get_default_format(klass):
1218
"""Return the current default format."""
1219
return klass._default_format
1221
def supports_transport(self, transport):
1222
"""Check if this format can be opened over a particular transport.
1224
raise NotImplementedError(self.supports_transport)
1227
class Prober(object):
1228
"""Abstract class that can be used to detect a particular kind of
1231
At the moment this just contains a single method to probe a particular
1232
transport, but it may be extended in the future to e.g. avoid
1233
multiple levels of probing for Subversion repositories.
1235
See BzrProber and RemoteBzrProber in bzrlib.bzrdir for the
1236
probers that detect .bzr/ directories and Bazaar smart servers,
1239
Probers should be registered using the register_server_prober or
1240
register_prober methods on ControlDirFormat.
1243
def probe_transport(self, transport):
1244
"""Return the controldir style format present in a directory.
1246
:raise UnknownFormatError: If a control dir was found but is
1247
in an unknown format.
1248
:raise NotBranchError: If no control directory was found.
1249
:return: A ControlDirFormat instance.
1251
raise NotImplementedError(self.probe_transport)
1254
def known_formats(klass):
1255
"""Return the control dir formats known by this prober.
1257
Multiple probers can return the same formats, so this should
1260
:return: A set of known formats.
1262
raise NotImplementedError(klass.known_formats)
1265
class ControlDirFormatInfo(object):
1267
def __init__(self, native, deprecated, hidden, experimental):
1268
self.deprecated = deprecated
1269
self.native = native
1270
self.hidden = hidden
1271
self.experimental = experimental
1274
class ControlDirFormatRegistry(registry.Registry):
1275
"""Registry of user-selectable ControlDir subformats.
1277
Differs from ControlDirFormat._formats in that it provides sub-formats,
1278
e.g. BzrDirMeta1 with weave repository. Also, it's more user-oriented.
1282
"""Create a ControlDirFormatRegistry."""
1283
self._aliases = set()
1284
self._registration_order = list()
1285
super(ControlDirFormatRegistry, self).__init__()
1288
"""Return a set of the format names which are aliases."""
1289
return frozenset(self._aliases)
1291
def register(self, key, factory, help, native=True, deprecated=False,
1292
hidden=False, experimental=False, alias=False):
1293
"""Register a ControlDirFormat factory.
1295
The factory must be a callable that takes one parameter: the key.
1296
It must produce an instance of the ControlDirFormat when called.
1298
This function mainly exists to prevent the info object from being
1301
registry.Registry.register(self, key, factory, help,
1302
ControlDirFormatInfo(native, deprecated, hidden, experimental))
1304
self._aliases.add(key)
1305
self._registration_order.append(key)
1307
def register_lazy(self, key, module_name, member_name, help, native=True,
1308
deprecated=False, hidden=False, experimental=False, alias=False):
1309
registry.Registry.register_lazy(self, key, module_name, member_name,
1310
help, ControlDirFormatInfo(native, deprecated, hidden, experimental))
1312
self._aliases.add(key)
1313
self._registration_order.append(key)
1315
def set_default(self, key):
1316
"""Set the 'default' key to be a clone of the supplied key.
1318
This method must be called once and only once.
1320
registry.Registry.register(self, 'default', self.get(key),
1321
self.get_help(key), info=self.get_info(key))
1322
self._aliases.add('default')
1324
def set_default_repository(self, key):
1325
"""Set the FormatRegistry default and Repository default.
1327
This is a transitional method while Repository.set_default_format
1330
if 'default' in self:
1331
self.remove('default')
1332
self.set_default(key)
1333
format = self.get('default')()
1335
def make_bzrdir(self, key):
1336
return self.get(key)()
1338
def help_topic(self, topic):
1340
default_realkey = None
1341
default_help = self.get_help('default')
1343
for key in self._registration_order:
1344
if key == 'default':
1346
help = self.get_help(key)
1347
if help == default_help:
1348
default_realkey = key
1350
help_pairs.append((key, help))
1352
def wrapped(key, help, info):
1354
help = '(native) ' + help
1355
return ':%s:\n%s\n\n' % (key,
1356
textwrap.fill(help, initial_indent=' ',
1357
subsequent_indent=' ',
1358
break_long_words=False))
1359
if default_realkey is not None:
1360
output += wrapped(default_realkey, '(default) %s' % default_help,
1361
self.get_info('default'))
1362
deprecated_pairs = []
1363
experimental_pairs = []
1364
for key, help in help_pairs:
1365
info = self.get_info(key)
1368
elif info.deprecated:
1369
deprecated_pairs.append((key, help))
1370
elif info.experimental:
1371
experimental_pairs.append((key, help))
1373
output += wrapped(key, help, info)
1374
output += "\nSee :doc:`formats-help` for more about storage formats."
1376
if len(experimental_pairs) > 0:
1377
other_output += "Experimental formats are shown below.\n\n"
1378
for key, help in experimental_pairs:
1379
info = self.get_info(key)
1380
other_output += wrapped(key, help, info)
1383
"No experimental formats are available.\n\n"
1384
if len(deprecated_pairs) > 0:
1385
other_output += "\nDeprecated formats are shown below.\n\n"
1386
for key, help in deprecated_pairs:
1387
info = self.get_info(key)
1388
other_output += wrapped(key, help, info)
1391
"\nNo deprecated formats are available.\n\n"
1393
"\nSee :doc:`formats-help` for more about storage formats."
1395
if topic == 'other-formats':
1401
class RepoInitHookParams(object):
1402
"""Object holding parameters passed to `*_repo_init` hooks.
1404
There are 4 fields that hooks may wish to access:
1406
:ivar repository: Repository created
1407
:ivar format: Repository format
1408
:ivar bzrdir: The controldir for the repository
1409
:ivar shared: The repository is shared
1412
def __init__(self, repository, format, controldir, shared):
1413
"""Create a group of RepoInitHook parameters.
1415
:param repository: Repository created
1416
:param format: Repository format
1417
:param controldir: The controldir for the repository
1418
:param shared: The repository is shared
1420
self.repository = repository
1421
self.format = format
1422
self.bzrdir = controldir
1423
self.shared = shared
1425
def __eq__(self, other):
1426
return self.__dict__ == other.__dict__
1430
return "<%s for %s>" % (self.__class__.__name__,
1433
return "<%s for %s>" % (self.__class__.__name__,
1437
# Please register new formats after old formats so that formats
1438
# appear in chronological order and format descriptions can build
1440
format_registry = ControlDirFormatRegistry()
1442
network_format_registry = registry.FormatRegistry()
1443
"""Registry of formats indexed by their network name.
1445
The network name for a ControlDirFormat is an identifier that can be used when
1446
referring to formats with smart server operations. See
1447
ControlDirFormat.network_name() for more detail.
added
removed
bzrlib/controldir.py
