1
# Copyright (C) 2010, 2011 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 bzrlib.lazy_import import lazy_import
26
lazy_import(globals(), """
32
revision as _mod_revision,
33
transport as _mod_transport,
38
from bzrlib.transport import local
39
from bzrlib.push import (
43
from bzrlib.i18n import gettext
46
from bzrlib import registry
49
class ControlComponent(object):
50
"""Abstract base class for control directory components.
52
This provides interfaces that are common across controldirs,
53
repositories, branches, and workingtree control directories.
55
They all expose two urls and transports: the *user* URL is the
56
one that stops above the control directory (eg .bzr) and that
57
should normally be used in messages, and the *control* URL is
58
under that in eg .bzr/checkout and is used to read the control
61
This can be used as a mixin and is intended to fit with
66
def control_transport(self):
67
raise NotImplementedError
70
def control_url(self):
71
return self.control_transport.base
74
def user_transport(self):
75
raise NotImplementedError
79
return self.user_transport.base
82
def get_format_string(cls):
83
raise NotImplementedError(self.get_format_string)
86
class ControlDir(ControlComponent):
87
"""A control directory.
89
While this represents a generic control directory, there are a few
90
features that are present in this interface that are currently only
91
supported by one of its implementations, BzrDir.
93
These features (bound branches, stacked branches) are currently only
94
supported by Bazaar, but could be supported by other version control
95
systems as well. Implementations are required to raise the appropriate
96
exceptions when an operation is requested that is not supported.
98
This also makes life easier for API users who can rely on the
99
implementation always allowing a particular feature to be requested but
100
raising an exception when it is not supported, rather than requiring the
101
API users to check for magic attributes to see what features are supported.
104
def can_convert_format(self):
105
"""Return true if this controldir is one whose format we can convert
109
def list_branches(self):
110
"""Return a sequence of all branches local to this control directory.
114
return [self.open_branch()]
115
except (errors.NotBranchError, errors.NoRepositoryPresent):
118
def is_control_filename(self, filename):
119
"""True if filename is the name of a path which is reserved for
122
:param filename: A filename within the root transport of this
125
This is true IF and ONLY IF the filename is part of the namespace reserved
126
for bzr control dirs. Currently this is the '.bzr' directory in the root
127
of the root_transport. it is expected that plugins will need to extend
128
this in the future - for instance to make bzr talk with svn working
131
raise NotImplementedError(self.is_control_filename)
133
def needs_format_conversion(self, format=None):
134
"""Return true if this controldir needs convert_format run on it.
136
For instance, if the repository format is out of date but the
137
branch and working tree are not, this should return True.
139
:param format: Optional parameter indicating a specific desired
140
format we plan to arrive at.
142
raise NotImplementedError(self.needs_format_conversion)
144
def create_repository(self, shared=False):
145
"""Create a new repository in this control directory.
147
:param shared: If a shared repository should be created
148
:return: The newly created repository
150
raise NotImplementedError(self.create_repository)
152
def destroy_repository(self):
153
"""Destroy the repository in this ControlDir."""
154
raise NotImplementedError(self.destroy_repository)
156
def create_branch(self, name=None, repository=None,
157
append_revisions_only=None):
158
"""Create a branch in this ControlDir.
160
:param name: Name of the colocated branch to create, None for
162
:param append_revisions_only: Whether this branch should only allow
163
appending new revisions to its history.
165
The controldirs format will control what branch format is created.
166
For more control see BranchFormatXX.create(a_controldir).
168
raise NotImplementedError(self.create_branch)
170
def destroy_branch(self, name=None):
171
"""Destroy a branch in this ControlDir.
173
:param name: Name of the branch to destroy, None for the default
176
raise NotImplementedError(self.destroy_branch)
178
def create_workingtree(self, revision_id=None, from_branch=None,
179
accelerator_tree=None, hardlink=False):
180
"""Create a working tree at this ControlDir.
182
:param revision_id: create it as of this revision id.
183
:param from_branch: override controldir branch
184
(for lightweight checkouts)
185
:param accelerator_tree: A tree which can be used for retrieving file
186
contents more quickly than the revision tree, i.e. a workingtree.
187
The revision tree will be used for cases where accelerator_tree's
188
content is different.
190
raise NotImplementedError(self.create_workingtree)
192
def destroy_workingtree(self):
193
"""Destroy the working tree at this ControlDir.
195
Formats that do not support this may raise UnsupportedOperation.
197
raise NotImplementedError(self.destroy_workingtree)
199
def destroy_workingtree_metadata(self):
200
"""Destroy the control files for the working tree at this ControlDir.
202
The contents of working tree files are not affected.
203
Formats that do not support this may raise UnsupportedOperation.
205
raise NotImplementedError(self.destroy_workingtree_metadata)
207
def find_branch_format(self, name=None):
208
"""Find the branch 'format' for this controldir.
210
This might be a synthetic object for e.g. RemoteBranch and SVN.
212
raise NotImplementedError(self.find_branch_format)
214
def get_branch_reference(self, name=None):
215
"""Return the referenced URL for the branch in this controldir.
217
:param name: Optional colocated branch name
218
:raises NotBranchError: If there is no Branch.
219
:raises NoColocatedBranchSupport: If a branch name was specified
220
but colocated branches are not supported.
221
:return: The URL the branch in this controldir references if it is a
222
reference branch, or None for regular branches.
225
raise errors.NoColocatedBranchSupport(self)
228
def open_branch(self, name=None, unsupported=False,
229
ignore_fallbacks=False, possible_transports=None):
230
"""Open the branch object at this ControlDir if one is present.
232
:param unsupported: if True, then no longer supported branch formats can
234
:param ignore_fallbacks: Whether to open fallback repositories
235
:param possible_transports: Transports to use for opening e.g.
236
fallback repositories.
238
raise NotImplementedError(self.open_branch)
240
def open_repository(self, _unsupported=False):
241
"""Open the repository object at this ControlDir if one is present.
243
This will not follow the Branch object pointer - it's strictly a direct
244
open facility. Most client code should use open_branch().repository to
247
:param _unsupported: a private parameter, not part of the api.
249
raise NotImplementedError(self.open_repository)
251
def find_repository(self):
252
"""Find the repository that should be used.
254
This does not require a branch as we use it to find the repo for
255
new branches as well as to hook existing branches up to their
258
raise NotImplementedError(self.find_repository)
260
def open_workingtree(self, _unsupported=False,
261
recommend_upgrade=True, from_branch=None):
262
"""Open the workingtree object at this ControlDir if one is present.
264
:param recommend_upgrade: Optional keyword parameter, when True (the
265
default), emit through the ui module a recommendation that the user
266
upgrade the working tree when the workingtree being opened is old
267
(but still fully supported).
268
:param from_branch: override controldir branch (for lightweight
271
raise NotImplementedError(self.open_workingtree)
273
def has_branch(self, name=None):
274
"""Tell if this controldir contains a branch.
276
Note: if you're going to open the branch, you should just go ahead
277
and try, and not ask permission first. (This method just opens the
278
branch and discards it, and that's somewhat expensive.)
281
self.open_branch(name, ignore_fallbacks=True)
283
except errors.NotBranchError:
286
def _get_selected_branch(self):
287
"""Return the name of the branch selected by the user.
289
:return: Name of the branch selected by the user, or None.
291
branch = self.root_transport.get_segment_parameters().get("branch")
292
if branch is not None:
293
branch = urlutils.unescape(branch)
296
def has_workingtree(self):
297
"""Tell if this controldir contains a working tree.
299
This will still raise an exception if the controldir has a workingtree
300
that is remote & inaccessible.
302
Note: if you're going to open the working tree, you should just go ahead
303
and try, and not ask permission first. (This method just opens the
304
workingtree and discards it, and that's somewhat expensive.)
307
self.open_workingtree(recommend_upgrade=False)
309
except errors.NoWorkingTree:
312
def cloning_metadir(self, require_stacking=False):
313
"""Produce a metadir suitable for cloning or sprouting with.
315
These operations may produce workingtrees (yes, even though they're
316
"cloning" something that doesn't have a tree), so a viable workingtree
317
format must be selected.
319
:require_stacking: If True, non-stackable formats will be upgraded
320
to similar stackable formats.
321
:returns: a ControlDirFormat with all component formats either set
322
appropriately or set to None if that component should not be
325
raise NotImplementedError(self.cloning_metadir)
327
def checkout_metadir(self):
328
"""Produce a metadir suitable for checkouts of this controldir."""
329
return self.cloning_metadir()
331
def sprout(self, url, revision_id=None, force_new_repo=False,
332
recurse='down', possible_transports=None,
333
accelerator_tree=None, hardlink=False, stacked=False,
334
source_branch=None, create_tree_if_local=True):
335
"""Create a copy of this controldir prepared for use as a new line of
338
If url's last component does not exist, it will be created.
340
Attributes related to the identity of the source branch like
341
branch nickname will be cleaned, a working tree is created
342
whether one existed before or not; and a local branch is always
345
:param revision_id: if revision_id is not None, then the clone
346
operation may tune itself to download less data.
347
:param accelerator_tree: A tree which can be used for retrieving file
348
contents more quickly than the revision tree, i.e. a workingtree.
349
The revision tree will be used for cases where accelerator_tree's
350
content is different.
351
:param hardlink: If true, hard-link files from accelerator_tree,
353
:param stacked: If true, create a stacked branch referring to the
354
location of this control directory.
355
:param create_tree_if_local: If true, a working-tree will be created
356
when working locally.
358
raise NotImplementedError(self.sprout)
360
def push_branch(self, source, revision_id=None, overwrite=False,
361
remember=False, create_prefix=False):
362
"""Push the source branch into this ControlDir."""
364
# If we can open a branch, use its direct repository, otherwise see
365
# if there is a repository without a branch.
367
br_to = self.open_branch()
368
except errors.NotBranchError:
369
# Didn't find a branch, can we find a repository?
370
repository_to = self.find_repository()
372
# Found a branch, so we must have found a repository
373
repository_to = br_to.repository
375
push_result = PushResult()
376
push_result.source_branch = source
378
# We have a repository but no branch, copy the revisions, and then
380
if revision_id is None:
381
# No revision supplied by the user, default to the branch
383
revision_id = source.last_revision()
384
repository_to.fetch(source.repository, revision_id=revision_id)
385
br_to = source.clone(self, revision_id=revision_id)
386
if source.get_push_location() is None or remember:
387
source.set_push_location(br_to.base)
388
push_result.stacked_on = None
389
push_result.branch_push_result = None
390
push_result.old_revno = None
391
push_result.old_revid = _mod_revision.NULL_REVISION
392
push_result.target_branch = br_to
393
push_result.master_branch = None
394
push_result.workingtree_updated = False
396
# We have successfully opened the branch, remember if necessary:
397
if source.get_push_location() is None or remember:
398
source.set_push_location(br_to.base)
400
tree_to = self.open_workingtree()
401
except errors.NotLocalUrl:
402
push_result.branch_push_result = source.push(br_to,
403
overwrite, stop_revision=revision_id)
404
push_result.workingtree_updated = False
405
except errors.NoWorkingTree:
406
push_result.branch_push_result = source.push(br_to,
407
overwrite, stop_revision=revision_id)
408
push_result.workingtree_updated = None # Not applicable
412
push_result.branch_push_result = source.push(
413
tree_to.branch, overwrite, stop_revision=revision_id)
417
push_result.workingtree_updated = True
418
push_result.old_revno = push_result.branch_push_result.old_revno
419
push_result.old_revid = push_result.branch_push_result.old_revid
420
push_result.target_branch = \
421
push_result.branch_push_result.target_branch
424
def _get_tree_branch(self, name=None):
425
"""Return the branch and tree, if any, for this controldir.
427
:param name: Name of colocated branch to open.
429
Return None for tree if not present or inaccessible.
430
Raise NotBranchError if no branch is present.
431
:return: (tree, branch)
434
tree = self.open_workingtree()
435
except (errors.NoWorkingTree, errors.NotLocalUrl):
437
branch = self.open_branch(name=name)
440
branch = self.open_branch(name=name)
445
def get_config(self):
446
"""Get configuration for this ControlDir."""
447
raise NotImplementedError(self.get_config)
449
def check_conversion_target(self, target_format):
450
"""Check that a controldir as a whole can be converted to a new format."""
451
raise NotImplementedError(self.check_conversion_target)
453
def clone(self, url, revision_id=None, force_new_repo=False,
454
preserve_stacking=False):
455
"""Clone this controldir and its contents to url verbatim.
457
:param url: The url create the clone at. If url's last component does
458
not exist, it will be created.
459
:param revision_id: The tip revision-id to use for any branch or
460
working tree. If not None, then the clone operation may tune
461
itself to download less data.
462
:param force_new_repo: Do not use a shared repository for the target
463
even if one is available.
464
:param preserve_stacking: When cloning a stacked branch, stack the
465
new branch on top of the other branch's stacked-on branch.
467
return self.clone_on_transport(_mod_transport.get_transport(url),
468
revision_id=revision_id,
469
force_new_repo=force_new_repo,
470
preserve_stacking=preserve_stacking)
472
def clone_on_transport(self, transport, revision_id=None,
473
force_new_repo=False, preserve_stacking=False, stacked_on=None,
474
create_prefix=False, use_existing_dir=True, no_tree=False):
475
"""Clone this controldir and its contents to transport verbatim.
477
:param transport: The transport for the location to produce the clone
478
at. If the target directory does not exist, it will be created.
479
:param revision_id: The tip revision-id to use for any branch or
480
working tree. If not None, then the clone operation may tune
481
itself to download less data.
482
:param force_new_repo: Do not use a shared repository for the target,
483
even if one is available.
484
:param preserve_stacking: When cloning a stacked branch, stack the
485
new branch on top of the other branch's stacked-on branch.
486
:param create_prefix: Create any missing directories leading up to
488
:param use_existing_dir: Use an existing directory if one exists.
489
:param no_tree: If set to true prevents creation of a working tree.
491
raise NotImplementedError(self.clone_on_transport)
494
def find_bzrdirs(klass, transport, evaluate=None, list_current=None):
495
"""Find control dirs recursively from current location.
497
This is intended primarily as a building block for more sophisticated
498
functionality, like finding trees under a directory, or finding
499
branches that use a given repository.
501
:param evaluate: An optional callable that yields recurse, value,
502
where recurse controls whether this controldir is recursed into
503
and value is the value to yield. By default, all bzrdirs
504
are recursed into, and the return value is the controldir.
505
:param list_current: if supplied, use this function to list the current
506
directory, instead of Transport.list_dir
507
:return: a generator of found bzrdirs, or whatever evaluate returns.
509
if list_current is None:
510
def list_current(transport):
511
return transport.list_dir('')
513
def evaluate(controldir):
514
return True, controldir
516
pending = [transport]
517
while len(pending) > 0:
518
current_transport = pending.pop()
521
controldir = klass.open_from_transport(current_transport)
522
except (errors.NotBranchError, errors.PermissionDenied):
525
recurse, value = evaluate(controldir)
528
subdirs = list_current(current_transport)
529
except (errors.NoSuchFile, errors.PermissionDenied):
532
for subdir in sorted(subdirs, reverse=True):
533
pending.append(current_transport.clone(subdir))
536
def find_branches(klass, transport):
537
"""Find all branches under a transport.
539
This will find all branches below the transport, including branches
540
inside other branches. Where possible, it will use
541
Repository.find_branches.
543
To list all the branches that use a particular Repository, see
544
Repository.find_branches
546
def evaluate(controldir):
548
repository = controldir.open_repository()
549
except errors.NoRepositoryPresent:
552
return False, ([], repository)
553
return True, (controldir.list_branches(), None)
555
for branches, repo in klass.find_bzrdirs(
556
transport, evaluate=evaluate):
558
ret.extend(repo.find_branches())
559
if branches is not None:
564
def create_branch_and_repo(klass, base, force_new_repo=False, format=None):
565
"""Create a new ControlDir, Branch and Repository at the url 'base'.
567
This will use the current default ControlDirFormat unless one is
568
specified, and use whatever
569
repository format that that uses via controldir.create_branch and
570
create_repository. If a shared repository is available that is used
573
The created Branch object is returned.
575
:param base: The URL to create the branch at.
576
:param force_new_repo: If True a new repository is always created.
577
:param format: If supplied, the format of branch to create. If not
578
supplied, the default is used.
580
controldir = klass.create(base, format)
581
controldir._find_or_create_repository(force_new_repo)
582
return controldir.create_branch()
585
def create_branch_convenience(klass, base, force_new_repo=False,
586
force_new_tree=None, format=None,
587
possible_transports=None):
588
"""Create a new ControlDir, Branch and Repository at the url 'base'.
590
This is a convenience function - it will use an existing repository
591
if possible, can be told explicitly whether to create a working tree or
594
This will use the current default ControlDirFormat unless one is
595
specified, and use whatever
596
repository format that that uses via ControlDir.create_branch and
597
create_repository. If a shared repository is available that is used
598
preferentially. Whatever repository is used, its tree creation policy
601
The created Branch object is returned.
602
If a working tree cannot be made due to base not being a file:// url,
603
no error is raised unless force_new_tree is True, in which case no
604
data is created on disk and NotLocalUrl is raised.
606
:param base: The URL to create the branch at.
607
:param force_new_repo: If True a new repository is always created.
608
:param force_new_tree: If True or False force creation of a tree or
609
prevent such creation respectively.
610
:param format: Override for the controldir format to create.
611
:param possible_transports: An optional reusable transports list.
614
# check for non local urls
615
t = _mod_transport.get_transport(base, possible_transports)
616
if not isinstance(t, local.LocalTransport):
617
raise errors.NotLocalUrl(base)
618
controldir = klass.create(base, format, possible_transports)
619
repo = controldir._find_or_create_repository(force_new_repo)
620
result = controldir.create_branch()
621
if force_new_tree or (repo.make_working_trees() and
622
force_new_tree is None):
624
controldir.create_workingtree()
625
except errors.NotLocalUrl:
630
def create_standalone_workingtree(klass, base, format=None):
631
"""Create a new ControlDir, WorkingTree, Branch and Repository at 'base'.
633
'base' must be a local path or a file:// url.
635
This will use the current default ControlDirFormat unless one is
636
specified, and use whatever
637
repository format that that uses for bzrdirformat.create_workingtree,
638
create_branch and create_repository.
640
:param format: Override for the controldir format to create.
641
:return: The WorkingTree object.
643
t = _mod_transport.get_transport(base)
644
if not isinstance(t, local.LocalTransport):
645
raise errors.NotLocalUrl(base)
646
controldir = klass.create_branch_and_repo(base,
648
format=format).bzrdir
649
return controldir.create_workingtree()
652
def open_unsupported(klass, base):
653
"""Open a branch which is not supported."""
654
return klass.open(base, _unsupported=True)
657
def open(klass, base, _unsupported=False, possible_transports=None):
658
"""Open an existing controldir, rooted at 'base' (url).
660
:param _unsupported: a private parameter to the ControlDir class.
662
t = _mod_transport.get_transport(base, possible_transports)
663
return klass.open_from_transport(t, _unsupported=_unsupported)
666
def open_from_transport(klass, transport, _unsupported=False,
667
_server_formats=True):
668
"""Open a controldir within a particular directory.
670
:param transport: Transport containing the controldir.
671
:param _unsupported: private.
673
for hook in klass.hooks['pre_open']:
675
# Keep initial base since 'transport' may be modified while following
677
base = transport.base
678
def find_format(transport):
679
return transport, ControlDirFormat.find_format(
680
transport, _server_formats=_server_formats)
682
def redirected(transport, e, redirection_notice):
683
redirected_transport = transport._redirected_to(e.source, e.target)
684
if redirected_transport is None:
685
raise errors.NotBranchError(base)
686
trace.note(gettext('{0} is{1} redirected to {2}').format(
687
transport.base, e.permanently, redirected_transport.base))
688
return redirected_transport
691
transport, format = _mod_transport.do_catching_redirections(
692
find_format, transport, redirected)
693
except errors.TooManyRedirections:
694
raise errors.NotBranchError(base)
696
format.check_support_status(_unsupported)
697
return format.open(transport, _found=True)
700
def open_containing(klass, url, possible_transports=None):
701
"""Open an existing branch which contains url.
703
:param url: url to search from.
705
See open_containing_from_transport for more detail.
707
transport = _mod_transport.get_transport(url, possible_transports)
708
return klass.open_containing_from_transport(transport)
711
def open_containing_from_transport(klass, a_transport):
712
"""Open an existing branch which contains a_transport.base.
714
This probes for a branch at a_transport, and searches upwards from there.
716
Basically we keep looking up until we find the control directory or
717
run into the root. If there isn't one, raises NotBranchError.
718
If there is one and it is either an unrecognised format or an unsupported
719
format, UnknownFormatError or UnsupportedFormatError are raised.
720
If there is one, it is returned, along with the unused portion of url.
722
:return: The ControlDir that contains the path, and a Unicode path
723
for the rest of the URL.
725
# this gets the normalised url back. I.e. '.' -> the full path.
726
url = a_transport.base
729
result = klass.open_from_transport(a_transport)
730
return result, urlutils.unescape(a_transport.relpath(url))
731
except errors.NotBranchError, e:
734
new_t = a_transport.clone('..')
735
except errors.InvalidURLJoin:
736
# reached the root, whatever that may be
737
raise errors.NotBranchError(path=url)
738
if new_t.base == a_transport.base:
739
# reached the root, whatever that may be
740
raise errors.NotBranchError(path=url)
744
def open_tree_or_branch(klass, location):
745
"""Return the branch and working tree at a location.
747
If there is no tree at the location, tree will be None.
748
If there is no branch at the location, an exception will be
750
:return: (tree, branch)
752
controldir = klass.open(location)
753
return controldir._get_tree_branch()
756
def open_containing_tree_or_branch(klass, location):
757
"""Return the branch and working tree contained by a location.
759
Returns (tree, branch, relpath).
760
If there is no tree at containing the location, tree will be None.
761
If there is no branch containing the location, an exception will be
763
relpath is the portion of the path that is contained by the branch.
765
controldir, relpath = klass.open_containing(location)
766
tree, branch = controldir._get_tree_branch()
767
return tree, branch, relpath
770
def open_containing_tree_branch_or_repository(klass, location):
771
"""Return the working tree, branch and repo contained by a location.
773
Returns (tree, branch, repository, relpath).
774
If there is no tree containing the location, tree will be None.
775
If there is no branch containing the location, branch will be None.
776
If there is no repository containing the location, repository will be
778
relpath is the portion of the path that is contained by the innermost
781
If no tree, branch or repository is found, a NotBranchError is raised.
783
controldir, relpath = klass.open_containing(location)
785
tree, branch = controldir._get_tree_branch()
786
except errors.NotBranchError:
788
repo = controldir.find_repository()
789
return None, None, repo, relpath
790
except (errors.NoRepositoryPresent):
791
raise errors.NotBranchError(location)
792
return tree, branch, branch.repository, relpath
795
def create(klass, base, format=None, possible_transports=None):
796
"""Create a new ControlDir at the url 'base'.
798
:param format: If supplied, the format of branch to create. If not
799
supplied, the default is used.
800
:param possible_transports: If supplied, a list of transports that
801
can be reused to share a remote connection.
803
if klass is not ControlDir:
804
raise AssertionError("ControlDir.create always creates the"
805
"default format, not one of %r" % klass)
806
t = _mod_transport.get_transport(base, possible_transports)
809
format = ControlDirFormat.get_default_format()
810
return format.initialize_on_transport(t)
813
class ControlDirHooks(hooks.Hooks):
814
"""Hooks for ControlDir operations."""
817
"""Create the default hooks."""
818
hooks.Hooks.__init__(self, "bzrlib.controldir", "ControlDir.hooks")
819
self.add_hook('pre_open',
820
"Invoked before attempting to open a ControlDir with the transport "
821
"that the open will use.", (1, 14))
822
self.add_hook('post_repo_init',
823
"Invoked after a repository has been initialized. "
824
"post_repo_init is called with a "
825
"bzrlib.controldir.RepoInitHookParams.",
828
# install the default hooks
829
ControlDir.hooks = ControlDirHooks()
832
class ControlComponentFormat(object):
833
"""A component that can live inside of a .bzr meta directory."""
835
upgrade_recommended = False
837
def get_format_description(self):
838
"""Return the short description for this format."""
839
raise NotImplementedError(self.get_format_description)
841
def is_supported(self):
842
"""Is this format supported?
844
Supported formats must be initializable and openable.
845
Unsupported formats may not support initialization or committing or
846
some other features depending on the reason for not being supported.
850
def check_support_status(self, allow_unsupported, recommend_upgrade=True,
852
"""Give an error or warning on old formats.
854
:param allow_unsupported: If true, allow opening
855
formats that are strongly deprecated, and which may
856
have limited functionality.
858
:param recommend_upgrade: If true (default), warn
859
the user through the ui object that they may wish
860
to upgrade the object.
862
if not allow_unsupported and not self.is_supported():
863
# see open_downlevel to open legacy branches.
864
raise errors.UnsupportedFormatError(format=self)
865
if recommend_upgrade and self.upgrade_recommended:
866
ui.ui_factory.recommend_upgrade(
867
self.get_format_description(), basedir)
870
class ControlComponentFormatRegistry(registry.FormatRegistry):
871
"""A registry for control components (branch, workingtree, repository)."""
873
def __init__(self, other_registry=None):
874
super(ControlComponentFormatRegistry, self).__init__(other_registry)
875
self._extra_formats = []
877
def register(self, format):
878
"""Register a new format."""
879
super(ControlComponentFormatRegistry, self).register(
880
format.get_format_string(), format)
882
def remove(self, format):
883
"""Remove a registered format."""
884
super(ControlComponentFormatRegistry, self).remove(
885
format.get_format_string())
887
def register_extra(self, format):
888
"""Register a format that can not be used in a metadir.
890
This is mainly useful to allow custom repository formats, such as older
891
Bazaar formats and foreign formats, to be tested.
893
self._extra_formats.append(registry._ObjectGetter(format))
895
def remove_extra(self, format):
896
"""Remove an extra format.
898
self._extra_formats.remove(registry._ObjectGetter(format))
900
def register_extra_lazy(self, module_name, member_name):
901
"""Register a format lazily.
903
self._extra_formats.append(
904
registry._LazyObjectGetter(module_name, member_name))
906
def _get_extra(self):
907
"""Return all "extra" formats, not usable in meta directories."""
909
for getter in self._extra_formats:
917
"""Return all formats, even those not usable in metadirs.
920
for name in self.keys():
925
return result + self._get_extra()
927
def _get_all_modules(self):
928
"""Return a set of the modules providing objects."""
930
for name in self.keys():
931
modules.add(self._get_module(name))
932
for getter in self._extra_formats:
933
modules.add(getter.get_module())
937
class Converter(object):
938
"""Converts a disk format object from one format to another."""
940
def convert(self, to_convert, pb):
941
"""Perform the conversion of to_convert, giving feedback via pb.
943
:param to_convert: The disk object to convert.
944
:param pb: a progress bar to use for progress information.
947
def step(self, message):
948
"""Update the pb by a step."""
950
self.pb.update(message, self.count, self.total)
953
class ControlDirFormat(object):
954
"""An encapsulation of the initialization and open routines for a format.
956
Formats provide three things:
957
* An initialization routine,
961
Formats are placed in a dict by their format string for reference
962
during controldir opening. These should be subclasses of ControlDirFormat
965
Once a format is deprecated, just deprecate the initialize and open
966
methods on the format class. Do not deprecate the object, as the
967
object will be created every system load.
969
:cvar colocated_branches: Whether this formats supports colocated branches.
970
:cvar supports_workingtrees: This control directory can co-exist with a
974
_default_format = None
975
"""The default format used for new control directories."""
978
"""The registered server format probers, e.g. RemoteBzrProber.
980
This is a list of Prober-derived classes.
984
"""The registered format probers, e.g. BzrProber.
986
This is a list of Prober-derived classes.
989
colocated_branches = False
990
"""Whether co-located branches are supported for this control dir format.
993
supports_workingtrees = True
994
"""Whether working trees can exist in control directories of this format.
997
fixed_components = False
998
"""Whether components can not change format independent of the control dir.
1001
upgrade_recommended = False
1002
"""Whether an upgrade from this format is recommended."""
1004
def get_format_description(self):
1005
"""Return the short description for this format."""
1006
raise NotImplementedError(self.get_format_description)
1008
def get_converter(self, format=None):
1009
"""Return the converter to use to convert controldirs needing converts.
1011
This returns a bzrlib.controldir.Converter object.
1013
This should return the best upgrader to step this format towards the
1014
current default format. In the case of plugins we can/should provide
1015
some means for them to extend the range of returnable converters.
1017
:param format: Optional format to override the default format of the
1020
raise NotImplementedError(self.get_converter)
1022
def is_supported(self):
1023
"""Is this format supported?
1025
Supported formats must be openable.
1026
Unsupported formats may not support initialization or committing or
1027
some other features depending on the reason for not being supported.
1031
def is_initializable(self):
1032
"""Whether new control directories of this format can be initialized.
1034
return self.is_supported()
1036
def check_support_status(self, allow_unsupported, recommend_upgrade=True,
1038
"""Give an error or warning on old formats.
1040
:param allow_unsupported: If true, allow opening
1041
formats that are strongly deprecated, and which may
1042
have limited functionality.
1044
:param recommend_upgrade: If true (default), warn
1045
the user through the ui object that they may wish
1046
to upgrade the object.
1048
if not allow_unsupported and not self.is_supported():
1049
# see open_downlevel to open legacy branches.
1050
raise errors.UnsupportedFormatError(format=self)
1051
if recommend_upgrade and self.upgrade_recommended:
1052
ui.ui_factory.recommend_upgrade(
1053
self.get_format_description(), basedir)
1055
def same_model(self, target_format):
1056
return (self.repository_format.rich_root_data ==
1057
target_format.rich_root_data)
1060
def register_format(klass, format):
1061
"""Register a format that does not use '.bzr' for its control dir.
1064
raise errors.BzrError("ControlDirFormat.register_format() has been "
1065
"removed in Bazaar 2.4. Please upgrade your plugins.")
1068
def register_prober(klass, prober):
1069
"""Register a prober that can look for a control dir.
1072
klass._probers.append(prober)
1075
def unregister_prober(klass, prober):
1076
"""Unregister a prober.
1079
klass._probers.remove(prober)
1082
def register_server_prober(klass, prober):
1083
"""Register a control format prober for client-server environments.
1085
These probers will be used before ones registered with
1086
register_prober. This gives implementations that decide to the
1087
chance to grab it before anything looks at the contents of the format
1090
klass._server_probers.append(prober)
1094
return self.get_format_description().rstrip()
1097
def known_formats(klass):
1098
"""Return all the known formats.
1101
for prober_kls in klass._probers + klass._server_probers:
1102
result.update(prober_kls.known_formats())
1106
def find_format(klass, transport, _server_formats=True):
1107
"""Return the format present at transport."""
1109
_probers = klass._server_probers + klass._probers
1111
_probers = klass._probers
1112
for prober_kls in _probers:
1113
prober = prober_kls()
1115
return prober.probe_transport(transport)
1116
except errors.NotBranchError:
1117
# this format does not find a control dir here.
1119
raise errors.NotBranchError(path=transport.base)
1121
def initialize(self, url, possible_transports=None):
1122
"""Create a control dir at this url and return an opened copy.
1124
While not deprecated, this method is very specific and its use will
1125
lead to many round trips to setup a working environment. See
1126
initialize_on_transport_ex for a [nearly] all-in-one method.
1128
Subclasses should typically override initialize_on_transport
1129
instead of this method.
1131
return self.initialize_on_transport(
1132
_mod_transport.get_transport(url, possible_transports))
1134
def initialize_on_transport(self, transport):
1135
"""Initialize a new controldir in the base directory of a Transport."""
1136
raise NotImplementedError(self.initialize_on_transport)
1138
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
1139
create_prefix=False, force_new_repo=False, stacked_on=None,
1140
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
1141
shared_repo=False, vfs_only=False):
1142
"""Create this format on transport.
1144
The directory to initialize will be created.
1146
:param force_new_repo: Do not use a shared repository for the target,
1147
even if one is available.
1148
:param create_prefix: Create any missing directories leading up to
1150
:param use_existing_dir: Use an existing directory if one exists.
1151
:param stacked_on: A url to stack any created branch on, None to follow
1152
any target stacking policy.
1153
:param stack_on_pwd: If stack_on is relative, the location it is
1155
:param repo_format_name: If non-None, a repository will be
1156
made-or-found. Should none be found, or if force_new_repo is True
1157
the repo_format_name is used to select the format of repository to
1159
:param make_working_trees: Control the setting of make_working_trees
1160
for a new shared repository when one is made. None to use whatever
1161
default the format has.
1162
:param shared_repo: Control whether made repositories are shared or
1164
:param vfs_only: If True do not attempt to use a smart server
1165
:return: repo, controldir, require_stacking, repository_policy. repo is
1166
None if none was created or found, controldir is always valid.
1167
require_stacking is the result of examining the stacked_on
1168
parameter and any stacking policy found for the target.
1170
raise NotImplementedError(self.initialize_on_transport_ex)
1172
def network_name(self):
1173
"""A simple byte string uniquely identifying this format for RPC calls.
1175
Bzr control formats use this disk format string to identify the format
1176
over the wire. Its possible that other control formats have more
1177
complex detection requirements, so we permit them to use any unique and
1178
immutable string they desire.
1180
raise NotImplementedError(self.network_name)
1182
def open(self, transport, _found=False):
1183
"""Return an instance of this format for the dir transport points at.
1185
raise NotImplementedError(self.open)
1188
def _set_default_format(klass, format):
1189
"""Set default format (for testing behavior of defaults only)"""
1190
klass._default_format = format
1193
def get_default_format(klass):
1194
"""Return the current default format."""
1195
return klass._default_format
1197
def supports_transport(self, transport):
1198
"""Check if this format can be opened over a particular transport.
1200
raise NotImplementedError(self.supports_transport)
1203
class Prober(object):
1204
"""Abstract class that can be used to detect a particular kind of
1207
At the moment this just contains a single method to probe a particular
1208
transport, but it may be extended in the future to e.g. avoid
1209
multiple levels of probing for Subversion repositories.
1211
See BzrProber and RemoteBzrProber in bzrlib.bzrdir for the
1212
probers that detect .bzr/ directories and Bazaar smart servers,
1215
Probers should be registered using the register_server_prober or
1216
register_prober methods on ControlDirFormat.
1219
def probe_transport(self, transport):
1220
"""Return the controldir style format present in a directory.
1222
:raise UnknownFormatError: If a control dir was found but is
1223
in an unknown format.
1224
:raise NotBranchError: If no control directory was found.
1225
:return: A ControlDirFormat instance.
1227
raise NotImplementedError(self.probe_transport)
1230
def known_formats(klass):
1231
"""Return the control dir formats known by this prober.
1233
Multiple probers can return the same formats, so this should
1236
:return: A set of known formats.
1238
raise NotImplementedError(klass.known_formats)
1241
class ControlDirFormatInfo(object):
1243
def __init__(self, native, deprecated, hidden, experimental):
1244
self.deprecated = deprecated
1245
self.native = native
1246
self.hidden = hidden
1247
self.experimental = experimental
1250
class ControlDirFormatRegistry(registry.Registry):
1251
"""Registry of user-selectable ControlDir subformats.
1253
Differs from ControlDirFormat._formats in that it provides sub-formats,
1254
e.g. BzrDirMeta1 with weave repository. Also, it's more user-oriented.
1258
"""Create a ControlDirFormatRegistry."""
1259
self._aliases = set()
1260
self._registration_order = list()
1261
super(ControlDirFormatRegistry, self).__init__()
1264
"""Return a set of the format names which are aliases."""
1265
return frozenset(self._aliases)
1267
def register(self, key, factory, help, native=True, deprecated=False,
1268
hidden=False, experimental=False, alias=False):
1269
"""Register a ControlDirFormat factory.
1271
The factory must be a callable that takes one parameter: the key.
1272
It must produce an instance of the ControlDirFormat when called.
1274
This function mainly exists to prevent the info object from being
1277
registry.Registry.register(self, key, factory, help,
1278
ControlDirFormatInfo(native, deprecated, hidden, experimental))
1280
self._aliases.add(key)
1281
self._registration_order.append(key)
1283
def register_lazy(self, key, module_name, member_name, help, native=True,
1284
deprecated=False, hidden=False, experimental=False, alias=False):
1285
registry.Registry.register_lazy(self, key, module_name, member_name,
1286
help, ControlDirFormatInfo(native, deprecated, hidden, experimental))
1288
self._aliases.add(key)
1289
self._registration_order.append(key)
1291
def set_default(self, key):
1292
"""Set the 'default' key to be a clone of the supplied key.
1294
This method must be called once and only once.
1296
registry.Registry.register(self, 'default', self.get(key),
1297
self.get_help(key), info=self.get_info(key))
1298
self._aliases.add('default')
1300
def set_default_repository(self, key):
1301
"""Set the FormatRegistry default and Repository default.
1303
This is a transitional method while Repository.set_default_format
1306
if 'default' in self:
1307
self.remove('default')
1308
self.set_default(key)
1309
format = self.get('default')()
1311
def make_bzrdir(self, key):
1312
return self.get(key)()
1314
def help_topic(self, topic):
1316
default_realkey = None
1317
default_help = self.get_help('default')
1319
for key in self._registration_order:
1320
if key == 'default':
1322
help = self.get_help(key)
1323
if help == default_help:
1324
default_realkey = key
1326
help_pairs.append((key, help))
1328
def wrapped(key, help, info):
1330
help = '(native) ' + help
1331
return ':%s:\n%s\n\n' % (key,
1332
textwrap.fill(help, initial_indent=' ',
1333
subsequent_indent=' ',
1334
break_long_words=False))
1335
if default_realkey is not None:
1336
output += wrapped(default_realkey, '(default) %s' % default_help,
1337
self.get_info('default'))
1338
deprecated_pairs = []
1339
experimental_pairs = []
1340
for key, help in help_pairs:
1341
info = self.get_info(key)
1344
elif info.deprecated:
1345
deprecated_pairs.append((key, help))
1346
elif info.experimental:
1347
experimental_pairs.append((key, help))
1349
output += wrapped(key, help, info)
1350
output += "\nSee :doc:`formats-help` for more about storage formats."
1352
if len(experimental_pairs) > 0:
1353
other_output += "Experimental formats are shown below.\n\n"
1354
for key, help in experimental_pairs:
1355
info = self.get_info(key)
1356
other_output += wrapped(key, help, info)
1359
"No experimental formats are available.\n\n"
1360
if len(deprecated_pairs) > 0:
1361
other_output += "\nDeprecated formats are shown below.\n\n"
1362
for key, help in deprecated_pairs:
1363
info = self.get_info(key)
1364
other_output += wrapped(key, help, info)
1367
"\nNo deprecated formats are available.\n\n"
1369
"\nSee :doc:`formats-help` for more about storage formats."
1371
if topic == 'other-formats':
1377
class RepoInitHookParams(object):
1378
"""Object holding parameters passed to `*_repo_init` hooks.
1380
There are 4 fields that hooks may wish to access:
1382
:ivar repository: Repository created
1383
:ivar format: Repository format
1384
:ivar bzrdir: The controldir for the repository
1385
:ivar shared: The repository is shared
1388
def __init__(self, repository, format, controldir, shared):
1389
"""Create a group of RepoInitHook parameters.
1391
:param repository: Repository created
1392
:param format: Repository format
1393
:param controldir: The controldir for the repository
1394
:param shared: The repository is shared
1396
self.repository = repository
1397
self.format = format
1398
self.bzrdir = controldir
1399
self.shared = shared
1401
def __eq__(self, other):
1402
return self.__dict__ == other.__dict__
1406
return "<%s for %s>" % (self.__class__.__name__,
1409
return "<%s for %s>" % (self.__class__.__name__,
1413
# Please register new formats after old formats so that formats
1414
# appear in chronological order and format descriptions can build
1416
format_registry = ControlDirFormatRegistry()
1418
network_format_registry = registry.FormatRegistry()
1419
"""Registry of formats indexed by their network name.
1421
The network name for a ControlDirFormat is an identifier that can be used when
1422
referring to formats with smart server operations. See
1423
ControlDirFormat.network_name() for more detail.
added
removed
bzrlib/controldir.py
