84
124
"""Return true if this bzrdir is one whose format we can convert from."""
127
def check_conversion_target(self, target_format):
128
target_repo_format = target_format.repository_format
129
source_repo_format = self._format.repository_format
130
source_repo_format.check_conversion_target(target_repo_format)
88
def _check_supported(format, allow_unsupported):
89
"""Check whether format is a supported format.
91
If allow_unsupported is True, this is a no-op.
133
def _check_supported(format, allow_unsupported,
134
recommend_upgrade=True,
136
"""Give an error or warning on old formats.
138
:param format: may be any kind of format - workingtree, branch,
141
:param allow_unsupported: If true, allow opening
142
formats that are strongly deprecated, and which may
143
have limited functionality.
145
:param recommend_upgrade: If true (default), warn
146
the user through the ui object that they may wish
147
to upgrade the object.
149
# TODO: perhaps move this into a base Format class; it's not BzrDir
150
# specific. mbp 20070323
93
151
if not allow_unsupported and not format.is_supported():
94
152
# see open_downlevel to open legacy branches.
95
raise errors.UnsupportedFormatError(
96
'sorry, format %s not supported' % format,
97
['use a different bzr version',
98
'or remove the .bzr directory'
99
' and "bzr init" again'])
153
raise errors.UnsupportedFormatError(format=format)
154
if recommend_upgrade \
155
and getattr(format, 'upgrade_recommended', False):
156
ui.ui_factory.recommend_upgrade(
157
format.get_format_description(),
101
def clone(self, url, revision_id=None, basis=None, force_new_repo=False):
160
def clone(self, url, revision_id=None, force_new_repo=False,
161
preserve_stacking=False):
102
162
"""Clone this bzrdir and its contents to url verbatim.
104
If urls last component does not exist, it will be created.
106
if revision_id is not None, then the clone operation may tune
107
itself to download less data.
108
:param force_new_repo: Do not use a shared repository for the target
109
even if one is available.
112
basis_repo, basis_branch, basis_tree = self._get_basis_components(basis)
113
result = self._format.initialize(url)
164
:param url: The url create the clone at. If url's last component does
165
not exist, it will be created.
166
:param revision_id: The tip revision-id to use for any branch or
167
working tree. If not None, then the clone operation may tune
168
itself to download less data.
169
:param force_new_repo: Do not use a shared repository for the target
170
even if one is available.
171
:param preserve_stacking: When cloning a stacked branch, stack the
172
new branch on top of the other branch's stacked-on branch.
174
return self.clone_on_transport(get_transport(url),
175
revision_id=revision_id,
176
force_new_repo=force_new_repo,
177
preserve_stacking=preserve_stacking)
179
def clone_on_transport(self, transport, revision_id=None,
180
force_new_repo=False, preserve_stacking=False,
182
"""Clone this bzrdir and its contents to transport verbatim.
184
:param transport: The transport for the location to produce the clone
185
at. If the target directory does not exist, it will be created.
186
:param revision_id: The tip revision-id to use for any branch or
187
working tree. If not None, then the clone operation may tune
188
itself to download less data.
189
:param force_new_repo: Do not use a shared repository for the target,
190
even if one is available.
191
:param preserve_stacking: When cloning a stacked branch, stack the
192
new branch on top of the other branch's stacked-on branch.
194
transport.ensure_base()
195
require_stacking = (stacked_on is not None)
196
metadir = self.cloning_metadir(require_stacking)
197
result = metadir.initialize_on_transport(transport)
198
repository_policy = None
115
200
local_repo = self.find_repository()
116
201
except errors.NoRepositoryPresent:
117
202
local_repo = None
204
local_branch = self.open_branch()
205
except errors.NotBranchError:
208
# enable fallbacks when branch is not a branch reference
209
if local_branch.repository.has_same_location(local_repo):
210
local_repo = local_branch.repository
211
if preserve_stacking:
213
stacked_on = local_branch.get_stacked_on_url()
214
except (errors.UnstackableBranchFormat,
215
errors.UnstackableRepositoryFormat,
119
220
# may need to copy content in
121
result_repo = local_repo.clone(
123
revision_id=revision_id,
125
result_repo.set_make_working_trees(local_repo.make_working_trees())
128
result_repo = result.find_repository()
129
# fetch content this dir needs.
131
# XXX FIXME RBC 20060214 need tests for this when the basis
133
result_repo.fetch(basis_repo, revision_id=revision_id)
134
result_repo.fetch(local_repo, revision_id=revision_id)
135
except errors.NoRepositoryPresent:
136
# needed to make one anyway.
137
result_repo = local_repo.clone(
139
revision_id=revision_id,
141
result_repo.set_make_working_trees(local_repo.make_working_trees())
221
repository_policy = result.determine_repository_policy(
222
force_new_repo, stacked_on, self.root_transport.base,
223
require_stacking=require_stacking)
224
make_working_trees = local_repo.make_working_trees()
225
result_repo = repository_policy.acquire_repository(
226
make_working_trees, local_repo.is_shared())
227
result_repo.fetch(local_repo, revision_id=revision_id)
142
230
# 1 if there is a branch present
143
231
# make sure its content is available in the target repository
146
self.open_branch().clone(result, revision_id=revision_id)
147
except errors.NotBranchError:
150
self.open_workingtree().clone(result, basis=basis_tree)
151
except (errors.NoWorkingTree, errors.NotLocalUrl):
233
if local_branch is not None:
234
result_branch = local_branch.clone(result, revision_id=revision_id)
235
if repository_policy is not None:
236
repository_policy.configure_branch(result_branch)
237
if result_repo is None or result_repo.make_working_trees():
239
self.open_workingtree().clone(result)
240
except (errors.NoWorkingTree, errors.NotLocalUrl):
155
def _get_basis_components(self, basis):
156
"""Retrieve the basis components that are available at basis."""
158
return None, None, None
160
basis_tree = basis.open_workingtree()
161
basis_branch = basis_tree.branch
162
basis_repo = basis_branch.repository
163
except (errors.NoWorkingTree, errors.NotLocalUrl):
166
basis_branch = basis.open_branch()
167
basis_repo = basis_branch.repository
168
except errors.NotBranchError:
171
basis_repo = basis.open_repository()
172
except errors.NoRepositoryPresent:
174
return basis_repo, basis_branch, basis_tree
176
244
# TODO: This should be given a Transport, and should chdir up; otherwise
177
245
# this will open a new connection.
178
246
def _make_tail(self, url):
179
head, tail = urlutils.split(url)
180
if tail and tail != '.':
181
t = bzrlib.transport.get_transport(head)
184
except errors.FileExists:
247
t = get_transport(url)
187
# TODO: Should take a Transport
189
def create(cls, base):
251
def create(cls, base, format=None, possible_transports=None):
190
252
"""Create a new BzrDir at the url 'base'.
192
This will call the current default formats initialize with base
193
as the only parameter.
195
If you need a specific format, consider creating an instance
196
of that and calling initialize().
254
:param format: If supplied, the format of branch to create. If not
255
supplied, the default is used.
256
:param possible_transports: If supplied, a list of transports that
257
can be reused to share a remote connection.
198
259
if cls is not BzrDir:
199
raise AssertionError("BzrDir.create always creates the default format, "
200
"not one of %r" % cls)
201
head, tail = urlutils.split(base)
202
if tail and tail != '.':
203
t = bzrlib.transport.get_transport(head)
206
except errors.FileExists:
208
return BzrDirFormat.get_default_format().initialize(safe_unicode(base))
260
raise AssertionError("BzrDir.create always creates the default"
261
" format, not one of %r" % cls)
262
t = get_transport(base, possible_transports)
265
format = BzrDirFormat.get_default_format()
266
return format.initialize_on_transport(t)
269
def find_bzrdirs(transport, evaluate=None, list_current=None):
270
"""Find bzrdirs recursively from current location.
272
This is intended primarily as a building block for more sophisticated
273
functionality, like finding trees under a directory, or finding
274
branches that use a given repository.
275
:param evaluate: An optional callable that yields recurse, value,
276
where recurse controls whether this bzrdir is recursed into
277
and value is the value to yield. By default, all bzrdirs
278
are recursed into, and the return value is the bzrdir.
279
:param list_current: if supplied, use this function to list the current
280
directory, instead of Transport.list_dir
281
:return: a generator of found bzrdirs, or whatever evaluate returns.
283
if list_current is None:
284
def list_current(transport):
285
return transport.list_dir('')
287
def evaluate(bzrdir):
290
pending = [transport]
291
while len(pending) > 0:
292
current_transport = pending.pop()
295
bzrdir = BzrDir.open_from_transport(current_transport)
296
except errors.NotBranchError:
299
recurse, value = evaluate(bzrdir)
302
subdirs = list_current(current_transport)
303
except errors.NoSuchFile:
306
for subdir in sorted(subdirs, reverse=True):
307
pending.append(current_transport.clone(subdir))
310
def find_branches(transport):
311
"""Find all branches under a transport.
313
This will find all branches below the transport, including branches
314
inside other branches. Where possible, it will use
315
Repository.find_branches.
317
To list all the branches that use a particular Repository, see
318
Repository.find_branches
320
def evaluate(bzrdir):
322
repository = bzrdir.open_repository()
323
except errors.NoRepositoryPresent:
326
return False, (None, repository)
328
branch = bzrdir.open_branch()
329
except errors.NotBranchError:
330
return True, (None, None)
332
return True, (branch, None)
334
for branch, repo in BzrDir.find_bzrdirs(transport, evaluate=evaluate):
336
branches.extend(repo.find_branches())
337
if branch is not None:
338
branches.append(branch)
341
def destroy_repository(self):
342
"""Destroy the repository in this BzrDir"""
343
raise NotImplementedError(self.destroy_repository)
210
345
def create_branch(self):
211
346
"""Create a branch in this BzrDir.
213
The bzrdirs format will control what branch format is created.
348
The bzrdir's format will control what branch format is created.
214
349
For more control see BranchFormatXX.create(a_bzrdir).
216
351
raise NotImplementedError(self.create_branch)
353
def destroy_branch(self):
354
"""Destroy the branch in this BzrDir"""
355
raise NotImplementedError(self.destroy_branch)
219
def create_branch_and_repo(base, force_new_repo=False):
358
def create_branch_and_repo(base, force_new_repo=False, format=None):
220
359
"""Create a new BzrDir, Branch and Repository at the url 'base'.
222
This will use the current default BzrDirFormat, and use whatever
361
This will use the current default BzrDirFormat unless one is
362
specified, and use whatever
223
363
repository format that that uses via bzrdir.create_branch and
224
364
create_repository. If a shared repository is available that is used
266
468
:param force_new_repo: If True a new repository is always created.
267
469
:param force_new_tree: If True or False force creation of a tree or
268
470
prevent such creation respectively.
269
:param format: Override for the for the bzrdir format to create
471
:param format: Override for the bzrdir format to create.
472
:param possible_transports: An optional reusable transports list.
271
474
if force_new_tree:
272
475
# check for non local urls
273
t = get_transport(safe_unicode(base))
476
t = get_transport(base, possible_transports)
274
477
if not isinstance(t, LocalTransport):
275
478
raise errors.NotLocalUrl(base)
277
bzrdir = BzrDir.create(base)
279
bzrdir = format.initialize(base)
479
bzrdir = BzrDir.create(base, format, possible_transports)
280
480
repo = bzrdir._find_or_create_repository(force_new_repo)
281
481
result = bzrdir.create_branch()
282
if force_new_tree or (repo.make_working_trees() and
482
if force_new_tree or (repo.make_working_trees() and
283
483
force_new_tree is None):
285
485
bzrdir.create_workingtree()
286
486
except errors.NotLocalUrl:
291
def create_repository(base, shared=False):
292
"""Create a new BzrDir and Repository at the url 'base'.
294
This will use the current default BzrDirFormat, and use whatever
295
repository format that that uses for bzrdirformat.create_repository.
297
;param shared: Create a shared repository rather than a standalone
299
The Repository object is returned.
301
This must be overridden as an instance method in child classes, where
302
it should take no parameters and construct whatever repository format
303
that child class desires.
305
bzrdir = BzrDir.create(base)
306
return bzrdir.create_repository()
309
def create_standalone_workingtree(base):
491
def create_standalone_workingtree(base, format=None):
310
492
"""Create a new BzrDir, WorkingTree, Branch and Repository at 'base'.
312
494
'base' must be a local path or a file:// url.
314
This will use the current default BzrDirFormat, and use whatever
496
This will use the current default BzrDirFormat unless one is
497
specified, and use whatever
315
498
repository format that that uses for bzrdirformat.create_workingtree,
316
499
create_branch and create_repository.
318
The WorkingTree object is returned.
501
:param format: Override for the bzrdir format to create.
502
:return: The WorkingTree object.
320
t = get_transport(safe_unicode(base))
504
t = get_transport(base)
321
505
if not isinstance(t, LocalTransport):
322
506
raise errors.NotLocalUrl(base)
323
bzrdir = BzrDir.create_branch_and_repo(safe_unicode(base),
324
force_new_repo=True).bzrdir
507
bzrdir = BzrDir.create_branch_and_repo(base,
509
format=format).bzrdir
325
510
return bzrdir.create_workingtree()
327
def create_workingtree(self, revision_id=None):
512
def create_workingtree(self, revision_id=None, from_branch=None,
513
accelerator_tree=None, hardlink=False):
328
514
"""Create a working tree at this BzrDir.
330
revision_id: create it as of this revision id.
516
:param revision_id: create it as of this revision id.
517
:param from_branch: override bzrdir branch (for lightweight checkouts)
518
:param accelerator_tree: A tree which can be used for retrieving file
519
contents more quickly than the revision tree, i.e. a workingtree.
520
The revision tree will be used for cases where accelerator_tree's
521
content is different.
332
523
raise NotImplementedError(self.create_workingtree)
525
def retire_bzrdir(self, limit=10000):
526
"""Permanently disable the bzrdir.
528
This is done by renaming it to give the user some ability to recover
529
if there was a problem.
531
This will have horrible consequences if anyone has anything locked or
533
:param limit: number of times to retry
538
to_path = '.bzr.retired.%d' % i
539
self.root_transport.rename('.bzr', to_path)
540
note("renamed %s to %s"
541
% (self.root_transport.abspath('.bzr'), to_path))
543
except (errors.TransportError, IOError, errors.PathError):
550
def destroy_workingtree(self):
551
"""Destroy the working tree at this BzrDir.
553
Formats that do not support this may raise UnsupportedOperation.
555
raise NotImplementedError(self.destroy_workingtree)
557
def destroy_workingtree_metadata(self):
558
"""Destroy the control files for the working tree at this BzrDir.
560
The contents of working tree files are not affected.
561
Formats that do not support this may raise UnsupportedOperation.
563
raise NotImplementedError(self.destroy_workingtree_metadata)
565
def _find_containing(self, evaluate):
566
"""Find something in a containing control directory.
568
This method will scan containing control dirs, until it finds what
569
it is looking for, decides that it will never find it, or runs out
570
of containing control directories to check.
572
It is used to implement find_repository and
573
determine_repository_policy.
575
:param evaluate: A function returning (value, stop). If stop is True,
576
the value will be returned.
580
result, stop = evaluate(found_bzrdir)
583
next_transport = found_bzrdir.root_transport.clone('..')
584
if (found_bzrdir.root_transport.base == next_transport.base):
585
# top of the file system
587
# find the next containing bzrdir
589
found_bzrdir = BzrDir.open_containing_from_transport(
591
except errors.NotBranchError:
334
594
def find_repository(self):
335
"""Find the repository that should be used for a_bzrdir.
595
"""Find the repository that should be used.
337
597
This does not require a branch as we use it to find the repo for
338
598
new branches as well as to hook existing branches up to their
342
return self.open_repository()
343
except errors.NoRepositoryPresent:
345
next_transport = self.root_transport.clone('..')
347
# find the next containing bzrdir
349
found_bzrdir = BzrDir.open_containing_from_transport(
351
except errors.NotBranchError:
353
raise errors.NoRepositoryPresent(self)
601
def usable_repository(found_bzrdir):
354
602
# does it have a repository ?
356
604
repository = found_bzrdir.open_repository()
357
605
except errors.NoRepositoryPresent:
358
next_transport = found_bzrdir.root_transport.clone('..')
359
if (found_bzrdir.root_transport.base == next_transport.base):
360
# top of the file system
364
if ((found_bzrdir.root_transport.base ==
365
self.root_transport.base) or repository.is_shared()):
607
if found_bzrdir.root_transport.base == self.root_transport.base:
608
return repository, True
609
elif repository.is_shared():
610
return repository, True
368
raise errors.NoRepositoryPresent(self)
369
raise errors.NoRepositoryPresent(self)
614
found_repo = self._find_containing(usable_repository)
615
if found_repo is None:
616
raise errors.NoRepositoryPresent(self)
619
def get_branch_reference(self):
620
"""Return the referenced URL for the branch in this bzrdir.
622
:raises NotBranchError: If there is no Branch.
623
:return: The URL the branch in this bzrdir references if it is a
624
reference branch, or None for regular branches.
371
628
def get_branch_transport(self, branch_format):
372
629
"""Get the transport for use by branch format in this BzrDir.
505
852
url = a_transport.base
508
format = BzrDirFormat.find_format(a_transport)
509
BzrDir._check_supported(format, False)
510
return format.open(a_transport), urlutils.unescape(a_transport.relpath(url))
855
result = BzrDir.open_from_transport(a_transport)
856
return result, urlutils.unescape(a_transport.relpath(url))
511
857
except errors.NotBranchError, e:
512
## mutter('not a branch in: %r %s', a_transport.base, e)
514
new_t = a_transport.clone('..')
860
new_t = a_transport.clone('..')
861
except errors.InvalidURLJoin:
862
# reached the root, whatever that may be
863
raise errors.NotBranchError(path=url)
515
864
if new_t.base == a_transport.base:
516
865
# reached the root, whatever that may be
517
866
raise errors.NotBranchError(path=url)
518
867
a_transport = new_t
869
def _get_tree_branch(self):
870
"""Return the branch and tree, if any, for this bzrdir.
872
Return None for tree if not present or inaccessible.
873
Raise NotBranchError if no branch is present.
874
:return: (tree, branch)
877
tree = self.open_workingtree()
878
except (errors.NoWorkingTree, errors.NotLocalUrl):
880
branch = self.open_branch()
886
def open_tree_or_branch(klass, location):
887
"""Return the branch and working tree at a location.
889
If there is no tree at the location, tree will be None.
890
If there is no branch at the location, an exception will be
892
:return: (tree, branch)
894
bzrdir = klass.open(location)
895
return bzrdir._get_tree_branch()
898
def open_containing_tree_or_branch(klass, location):
899
"""Return the branch and working tree contained by a location.
901
Returns (tree, branch, relpath).
902
If there is no tree at containing the location, tree will be None.
903
If there is no branch containing the location, an exception will be
905
relpath is the portion of the path that is contained by the branch.
907
bzrdir, relpath = klass.open_containing(location)
908
tree, branch = bzrdir._get_tree_branch()
909
return tree, branch, relpath
912
def open_containing_tree_branch_or_repository(klass, location):
913
"""Return the working tree, branch and repo contained by a location.
915
Returns (tree, branch, repository, relpath).
916
If there is no tree containing the location, tree will be None.
917
If there is no branch containing the location, branch will be None.
918
If there is no repository containing the location, repository will be
920
relpath is the portion of the path that is contained by the innermost
923
If no tree, branch or repository is found, a NotBranchError is raised.
925
bzrdir, relpath = klass.open_containing(location)
927
tree, branch = bzrdir._get_tree_branch()
928
except errors.NotBranchError:
930
repo = bzrdir.find_repository()
931
return None, None, repo, relpath
932
except (errors.NoRepositoryPresent):
933
raise errors.NotBranchError(location)
934
return tree, branch, branch.repository, relpath
520
936
def open_repository(self, _unsupported=False):
521
937
"""Open the repository object at this BzrDir if one is present.
523
This will not follow the Branch object pointer - its strictly a direct
939
This will not follow the Branch object pointer - it's strictly a direct
524
940
open facility. Most client code should use open_branch().repository to
525
941
get at a repository.
527
_unsupported is a private parameter, not part of the api.
943
:param _unsupported: a private parameter, not part of the api.
528
944
TODO: static convenience version of this?
530
946
raise NotImplementedError(self.open_repository)
532
def open_workingtree(self, _unsupported=False):
948
def open_workingtree(self, _unsupported=False,
949
recommend_upgrade=True, from_branch=None):
533
950
"""Open the workingtree object at this BzrDir if one is present.
535
TODO: static convenience version of this?
952
:param recommend_upgrade: Optional keyword parameter, when True (the
953
default), emit through the ui module a recommendation that the user
954
upgrade the working tree when the workingtree being opened is old
955
(but still fully supported).
956
:param from_branch: override bzrdir branch (for lightweight checkouts)
537
958
raise NotImplementedError(self.open_workingtree)
579
1079
if revision_id is not None, then the clone operation may tune
580
1080
itself to download less data.
1081
:param accelerator_tree: A tree which can be used for retrieving file
1082
contents more quickly than the revision tree, i.e. a workingtree.
1083
The revision tree will be used for cases where accelerator_tree's
1084
content is different.
1085
:param hardlink: If true, hard-link files from accelerator_tree,
1087
:param stacked: If true, create a stacked branch referring to the
1088
location of this control directory.
583
result = self._format.initialize(url)
584
basis_repo, basis_branch, basis_tree = self._get_basis_components(basis)
1090
target_transport = get_transport(url, possible_transports)
1091
target_transport.ensure_base()
1092
cloning_format = self.cloning_metadir(stacked)
1093
# Create/update the result branch
1094
result = cloning_format.initialize_on_transport(target_transport)
586
1096
source_branch = self.open_branch()
587
1097
source_repository = source_branch.repository
1099
stacked_branch_url = self.root_transport.base
1101
# if a stacked branch wasn't requested, we don't create one
1102
# even if the origin was stacked
1103
stacked_branch_url = None
588
1104
except errors.NotBranchError:
589
1105
source_branch = None
591
1107
source_repository = self.open_repository()
592
1108
except errors.NoRepositoryPresent:
593
# copy the entire basis one if there is one
594
# but there is no repository.
595
source_repository = basis_repo
600
result_repo = result.find_repository()
601
except errors.NoRepositoryPresent:
603
if source_repository is None and result_repo is not None:
605
elif source_repository is None and result_repo is None:
606
# no repo available, make a new one
607
result.create_repository()
608
elif source_repository is not None and result_repo is None:
609
# have source, and want to make a new target repo
610
# we don't clone the repo because that preserves attributes
611
# like is_shared(), and we have not yet implemented a
612
# repository sprout().
613
result_repo = result.create_repository()
614
if result_repo is not None:
615
# fetch needed content into target.
617
# XXX FIXME RBC 20060214 need tests for this when the basis
619
result_repo.fetch(basis_repo, revision_id=revision_id)
1109
source_repository = None
1110
stacked_branch_url = None
1111
repository_policy = result.determine_repository_policy(
1112
force_new_repo, stacked_branch_url, require_stacking=stacked)
1113
result_repo = repository_policy.acquire_repository()
1114
if source_repository is not None:
1115
# Fetch while stacked to prevent unstacked fetch from
620
1117
result_repo.fetch(source_repository, revision_id=revision_id)
1119
if source_branch is None:
1120
# this is for sprouting a bzrdir without a branch; is that
1122
# Not especially, but it's part of the contract.
1123
result_branch = result.create_branch()
1125
# Force NULL revision to avoid using repository before stacking
1127
result_branch = source_branch.sprout(
1128
result, revision_id=_mod_revision.NULL_REVISION)
1129
parent_location = result_branch.get_parent()
1130
mutter("created new branch %r" % (result_branch,))
1131
repository_policy.configure_branch(result_branch)
621
1132
if source_branch is not None:
622
source_branch.sprout(result, revision_id=revision_id)
1133
source_branch.copy_content_into(result_branch, revision_id)
1134
# Override copy_content_into
1135
result_branch.set_parent(parent_location)
1137
# Create/update the result working tree
1138
if isinstance(target_transport, LocalTransport) and (
1139
result_repo is None or result_repo.make_working_trees()):
1140
wt = result.create_workingtree(accelerator_tree=accelerator_tree,
1144
if wt.path2id('') is None:
1146
wt.set_root_id(self.open_workingtree.get_root_id())
1147
except errors.NoWorkingTree:
624
result.create_branch()
625
# TODO: jam 20060426 we probably need a test in here in the
626
# case that the newly sprouted branch is a remote one
627
if result_repo is None or result_repo.make_working_trees():
628
result.create_workingtree()
1153
if recurse == 'down':
1155
basis = wt.basis_tree()
1157
subtrees = basis.iter_references()
1158
elif source_branch is not None:
1159
basis = source_branch.basis_tree()
1161
subtrees = basis.iter_references()
1166
for path, file_id in subtrees:
1167
target = urlutils.join(url, urlutils.escape(path))
1168
sublocation = source_branch.reference_parent(file_id, path)
1169
sublocation.bzrdir.sprout(target,
1170
basis.get_reference_revision(file_id, path),
1171
force_new_repo=force_new_repo, recurse=recurse,
1174
if basis is not None:
1878
2550
self.pb.note('starting repository conversion')
1879
2551
converter = CopyConverter(self.target_format.repository_format)
1880
2552
converter.convert(repo, pb)
2554
branch = self.bzrdir.open_branch()
2555
except errors.NotBranchError:
2558
# TODO: conversions of Branch and Tree should be done by
2559
# InterXFormat lookups/some sort of registry.
2560
# Avoid circular imports
2561
from bzrlib import branch as _mod_branch
2562
old = branch._format.__class__
2563
new = self.target_format.get_branch_format().__class__
2565
if (old == _mod_branch.BzrBranchFormat5 and
2566
new in (_mod_branch.BzrBranchFormat6,
2567
_mod_branch.BzrBranchFormat7)):
2568
branch_converter = _mod_branch.Converter5to6()
2569
elif (old == _mod_branch.BzrBranchFormat6 and
2570
new == _mod_branch.BzrBranchFormat7):
2571
branch_converter = _mod_branch.Converter6to7()
2573
raise errors.BadConversionTarget("No converter", new)
2574
branch_converter.convert(branch)
2575
branch = self.bzrdir.open_branch()
2576
old = branch._format.__class__
2578
tree = self.bzrdir.open_workingtree(recommend_upgrade=False)
2579
except (errors.NoWorkingTree, errors.NotLocalUrl):
2582
# TODO: conversions of Branch and Tree should be done by
2583
# InterXFormat lookups
2584
if (isinstance(tree, workingtree.WorkingTree3) and
2585
not isinstance(tree, workingtree_4.WorkingTree4) and
2586
isinstance(self.target_format.workingtree_format,
2587
workingtree_4.WorkingTreeFormat4)):
2588
workingtree_4.Converter3to4().convert(tree)
1881
2589
return to_convert
2592
# This is not in remote.py because it's small, and needs to be registered.
2593
# Putting it in remote.py creates a circular import problem.
2594
# we can make it a lazy object if the control formats is turned into something
2596
class RemoteBzrDirFormat(BzrDirMetaFormat1):
2597
"""Format representing bzrdirs accessed via a smart server"""
2599
def get_format_description(self):
2600
return 'bzr remote bzrdir'
2603
def probe_transport(klass, transport):
2604
"""Return a RemoteBzrDirFormat object if it looks possible."""
2606
medium = transport.get_smart_medium()
2607
except (NotImplementedError, AttributeError,
2608
errors.TransportNotPossible, errors.NoSmartMedium,
2609
errors.SmartProtocolError):
2610
# no smart server, so not a branch for this format type.
2611
raise errors.NotBranchError(path=transport.base)
2613
# Decline to open it if the server doesn't support our required
2614
# version (3) so that the VFS-based transport will do it.
2615
if medium.should_probe():
2617
server_version = medium.protocol_version()
2618
except errors.SmartProtocolError:
2619
# Apparently there's no usable smart server there, even though
2620
# the medium supports the smart protocol.
2621
raise errors.NotBranchError(path=transport.base)
2622
if server_version != '2':
2623
raise errors.NotBranchError(path=transport.base)
2626
def initialize_on_transport(self, transport):
2628
# hand off the request to the smart server
2629
client_medium = transport.get_smart_medium()
2630
except errors.NoSmartMedium:
2631
# TODO: lookup the local format from a server hint.
2632
local_dir_format = BzrDirMetaFormat1()
2633
return local_dir_format.initialize_on_transport(transport)
2634
client = _SmartClient(client_medium)
2635
path = client.remote_path_from_transport(transport)
2636
response = client.call('BzrDirFormat.initialize', path)
2637
if response[0] != 'ok':
2638
raise errors.SmartProtocolError('unexpected response code %s' % (response,))
2639
return remote.RemoteBzrDir(transport)
2641
def _open(self, transport):
2642
return remote.RemoteBzrDir(transport)
2644
def __eq__(self, other):
2645
if not isinstance(other, RemoteBzrDirFormat):
2647
return self.get_format_description() == other.get_format_description()
2650
BzrDirFormat.register_control_server_format(RemoteBzrDirFormat)
2653
class BzrDirFormatInfo(object):
2655
def __init__(self, native, deprecated, hidden, experimental):
2656
self.deprecated = deprecated
2657
self.native = native
2658
self.hidden = hidden
2659
self.experimental = experimental
2662
class BzrDirFormatRegistry(registry.Registry):
2663
"""Registry of user-selectable BzrDir subformats.
2665
Differs from BzrDirFormat._control_formats in that it provides sub-formats,
2666
e.g. BzrDirMeta1 with weave repository. Also, it's more user-oriented.
2670
"""Create a BzrDirFormatRegistry."""
2671
self._aliases = set()
2672
super(BzrDirFormatRegistry, self).__init__()
2675
"""Return a set of the format names which are aliases."""
2676
return frozenset(self._aliases)
2678
def register_metadir(self, key,
2679
repository_format, help, native=True, deprecated=False,
2685
"""Register a metadir subformat.
2687
These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
2688
by the Repository format.
2690
:param repository_format: The fully-qualified repository format class
2692
:param branch_format: Fully-qualified branch format class name as
2694
:param tree_format: Fully-qualified tree format class name as
2697
# This should be expanded to support setting WorkingTree and Branch
2698
# formats, once BzrDirMetaFormat1 supports that.
2699
def _load(full_name):
2700
mod_name, factory_name = full_name.rsplit('.', 1)
2702
mod = __import__(mod_name, globals(), locals(),
2704
except ImportError, e:
2705
raise ImportError('failed to load %s: %s' % (full_name, e))
2707
factory = getattr(mod, factory_name)
2708
except AttributeError:
2709
raise AttributeError('no factory %s in module %r'
2714
bd = BzrDirMetaFormat1()
2715
if branch_format is not None:
2716
bd.set_branch_format(_load(branch_format))
2717
if tree_format is not None:
2718
bd.workingtree_format = _load(tree_format)
2719
if repository_format is not None:
2720
bd.repository_format = _load(repository_format)
2722
self.register(key, helper, help, native, deprecated, hidden,
2723
experimental, alias)
2725
def register(self, key, factory, help, native=True, deprecated=False,
2726
hidden=False, experimental=False, alias=False):
2727
"""Register a BzrDirFormat factory.
2729
The factory must be a callable that takes one parameter: the key.
2730
It must produce an instance of the BzrDirFormat when called.
2732
This function mainly exists to prevent the info object from being
2735
registry.Registry.register(self, key, factory, help,
2736
BzrDirFormatInfo(native, deprecated, hidden, experimental))
2738
self._aliases.add(key)
2740
def register_lazy(self, key, module_name, member_name, help, native=True,
2741
deprecated=False, hidden=False, experimental=False, alias=False):
2742
registry.Registry.register_lazy(self, key, module_name, member_name,
2743
help, BzrDirFormatInfo(native, deprecated, hidden, experimental))
2745
self._aliases.add(key)
2747
def set_default(self, key):
2748
"""Set the 'default' key to be a clone of the supplied key.
2750
This method must be called once and only once.
2752
registry.Registry.register(self, 'default', self.get(key),
2753
self.get_help(key), info=self.get_info(key))
2754
self._aliases.add('default')
2756
def set_default_repository(self, key):
2757
"""Set the FormatRegistry default and Repository default.
2759
This is a transitional method while Repository.set_default_format
2762
if 'default' in self:
2763
self.remove('default')
2764
self.set_default(key)
2765
format = self.get('default')()
2767
def make_bzrdir(self, key):
2768
return self.get(key)()
2770
def help_topic(self, topic):
2771
output = textwrap.dedent("""\
2772
These formats can be used for creating branches, working trees, and
2776
default_realkey = None
2777
default_help = self.get_help('default')
2779
for key in self.keys():
2780
if key == 'default':
2782
help = self.get_help(key)
2783
if help == default_help:
2784
default_realkey = key
2786
help_pairs.append((key, help))
2788
def wrapped(key, help, info):
2790
help = '(native) ' + help
2791
return ':%s:\n%s\n\n' % (key,
2792
textwrap.fill(help, initial_indent=' ',
2793
subsequent_indent=' '))
2794
if default_realkey is not None:
2795
output += wrapped(default_realkey, '(default) %s' % default_help,
2796
self.get_info('default'))
2797
deprecated_pairs = []
2798
experimental_pairs = []
2799
for key, help in help_pairs:
2800
info = self.get_info(key)
2803
elif info.deprecated:
2804
deprecated_pairs.append((key, help))
2805
elif info.experimental:
2806
experimental_pairs.append((key, help))
2808
output += wrapped(key, help, info)
2809
if len(experimental_pairs) > 0:
2810
output += "Experimental formats are shown below.\n\n"
2811
for key, help in experimental_pairs:
2812
info = self.get_info(key)
2813
output += wrapped(key, help, info)
2814
if len(deprecated_pairs) > 0:
2815
output += "Deprecated formats are shown below.\n\n"
2816
for key, help in deprecated_pairs:
2817
info = self.get_info(key)
2818
output += wrapped(key, help, info)
2823
class RepositoryAcquisitionPolicy(object):
2824
"""Abstract base class for repository acquisition policies.
2826
A repository acquisition policy decides how a BzrDir acquires a repository
2827
for a branch that is being created. The most basic policy decision is
2828
whether to create a new repository or use an existing one.
2830
def __init__(self, stack_on, stack_on_pwd, require_stacking):
2833
:param stack_on: A location to stack on
2834
:param stack_on_pwd: If stack_on is relative, the location it is
2836
:param require_stacking: If True, it is a failure to not stack.
2838
self._stack_on = stack_on
2839
self._stack_on_pwd = stack_on_pwd
2840
self._require_stacking = require_stacking
2842
def configure_branch(self, branch):
2843
"""Apply any configuration data from this policy to the branch.
2845
Default implementation sets repository stacking.
2847
if self._stack_on is None:
2849
if self._stack_on_pwd is None:
2850
stack_on = self._stack_on
2853
stack_on = urlutils.rebase_url(self._stack_on,
2855
branch.bzrdir.root_transport.base)
2856
except errors.InvalidRebaseURLs:
2857
stack_on = self._get_full_stack_on()
2859
branch.set_stacked_on_url(stack_on)
2860
except errors.UnstackableBranchFormat:
2861
if self._require_stacking:
2864
def _get_full_stack_on(self):
2865
"""Get a fully-qualified URL for the stack_on location."""
2866
if self._stack_on is None:
2868
if self._stack_on_pwd is None:
2869
return self._stack_on
2871
return urlutils.join(self._stack_on_pwd, self._stack_on)
2873
def _add_fallback(self, repository):
2874
"""Add a fallback to the supplied repository, if stacking is set."""
2875
stack_on = self._get_full_stack_on()
2876
if stack_on is None:
2878
stacked_dir = BzrDir.open(stack_on)
2880
stacked_repo = stacked_dir.open_branch().repository
2881
except errors.NotBranchError:
2882
stacked_repo = stacked_dir.open_repository()
2884
repository.add_fallback_repository(stacked_repo)
2885
except errors.UnstackableRepositoryFormat:
2886
if self._require_stacking:
2889
def acquire_repository(self, make_working_trees=None, shared=False):
2890
"""Acquire a repository for this bzrdir.
2892
Implementations may create a new repository or use a pre-exising
2894
:param make_working_trees: If creating a repository, set
2895
make_working_trees to this value (if non-None)
2896
:param shared: If creating a repository, make it shared if True
2897
:return: A repository
2899
raise NotImplemented(RepositoryAcquisitionPolicy.acquire_repository)
2902
class CreateRepository(RepositoryAcquisitionPolicy):
2903
"""A policy of creating a new repository"""
2905
def __init__(self, bzrdir, stack_on=None, stack_on_pwd=None,
2906
require_stacking=False):
2909
:param bzrdir: The bzrdir to create the repository on.
2910
:param stack_on: A location to stack on
2911
:param stack_on_pwd: If stack_on is relative, the location it is
2914
RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
2916
self._bzrdir = bzrdir
2918
def acquire_repository(self, make_working_trees=None, shared=False):
2919
"""Implementation of RepositoryAcquisitionPolicy.acquire_repository
2921
Creates the desired repository in the bzrdir we already have.
2923
repository = self._bzrdir.create_repository(shared=shared)
2924
self._add_fallback(repository)
2925
if make_working_trees is not None:
2926
repository.set_make_working_trees(make_working_trees)
2930
class UseExistingRepository(RepositoryAcquisitionPolicy):
2931
"""A policy of reusing an existing repository"""
2933
def __init__(self, repository, stack_on=None, stack_on_pwd=None,
2934
require_stacking=False):
2937
:param repository: The repository to use.
2938
:param stack_on: A location to stack on
2939
:param stack_on_pwd: If stack_on is relative, the location it is
2942
RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
2944
self._repository = repository
2946
def acquire_repository(self, make_working_trees=None, shared=False):
2947
"""Implementation of RepositoryAcquisitionPolicy.acquire_repository
2949
Returns an existing repository to use
2951
self._add_fallback(self._repository)
2952
return self._repository
2955
format_registry = BzrDirFormatRegistry()
2956
format_registry.register('weave', BzrDirFormat6,
2957
'Pre-0.8 format. Slower than knit and does not'
2958
' support checkouts or shared repositories.',
2960
format_registry.register_metadir('knit',
2961
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2962
'Format using knits. Recommended for interoperation with bzr <= 0.14.',
2963
branch_format='bzrlib.branch.BzrBranchFormat5',
2964
tree_format='bzrlib.workingtree.WorkingTreeFormat3')
2965
format_registry.register_metadir('metaweave',
2966
'bzrlib.repofmt.weaverepo.RepositoryFormat7',
2967
'Transitional format in 0.8. Slower than knit.',
2968
branch_format='bzrlib.branch.BzrBranchFormat5',
2969
tree_format='bzrlib.workingtree.WorkingTreeFormat3',
2971
format_registry.register_metadir('dirstate',
2972
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2973
help='New in 0.15: Fast local operations. Compatible with bzr 0.8 and '
2974
'above when accessed over the network.',
2975
branch_format='bzrlib.branch.BzrBranchFormat5',
2976
# this uses bzrlib.workingtree.WorkingTreeFormat4 because importing
2977
# directly from workingtree_4 triggers a circular import.
2978
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2980
format_registry.register_metadir('dirstate-tags',
2981
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2982
help='New in 0.15: Fast local operations and improved scaling for '
2983
'network operations. Additionally adds support for tags.'
2984
' Incompatible with bzr < 0.15.',
2985
branch_format='bzrlib.branch.BzrBranchFormat6',
2986
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2988
format_registry.register_metadir('rich-root',
2989
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
2990
help='New in 1.0. Better handling of tree roots. Incompatible with'
2992
branch_format='bzrlib.branch.BzrBranchFormat6',
2993
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2995
format_registry.register_metadir('dirstate-with-subtree',
2996
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
2997
help='New in 0.15: Fast local operations and improved scaling for '
2998
'network operations. Additionally adds support for versioning nested '
2999
'bzr branches. Incompatible with bzr < 0.15.',
3000
branch_format='bzrlib.branch.BzrBranchFormat6',
3001
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3005
format_registry.register_metadir('pack-0.92',
3006
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack1',
3007
help='New in 0.92: Pack-based format with data compatible with '
3008
'dirstate-tags format repositories. Interoperates with '
3009
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3010
'Previously called knitpack-experimental. '
3011
'For more information, see '
3012
'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
3013
branch_format='bzrlib.branch.BzrBranchFormat6',
3014
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3016
format_registry.register_metadir('pack-0.92-subtree',
3017
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack3',
3018
help='New in 0.92: Pack-based format with data compatible with '
3019
'dirstate-with-subtree format repositories. Interoperates with '
3020
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3021
'Previously called knitpack-experimental. '
3022
'For more information, see '
3023
'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
3024
branch_format='bzrlib.branch.BzrBranchFormat6',
3025
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3029
format_registry.register_metadir('rich-root-pack',
3030
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
3031
help='New in 1.0: Pack-based format with data compatible with '
3032
'rich-root format repositories. Incompatible with'
3034
branch_format='bzrlib.branch.BzrBranchFormat6',
3035
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3037
format_registry.register_metadir('1.6',
3038
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5',
3039
help='A branch and pack based repository that supports stacking. ',
3040
branch_format='bzrlib.branch.BzrBranchFormat7',
3041
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3043
format_registry.register_metadir('1.6.1-rich-root',
3044
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5RichRoot',
3045
help='A branch and pack based repository that supports stacking '
3046
'and rich root data (needed for bzr-svn). ',
3047
branch_format='bzrlib.branch.BzrBranchFormat7',
3048
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3050
# The following two formats should always just be aliases.
3051
format_registry.register_metadir('development',
3052
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment1',
3053
help='Current development format. Can convert data to and from pack-0.92 '
3054
'(and anything compatible with pack-0.92) format repositories. '
3055
'Repositories and branches in this format can only be read by bzr.dev. '
3057
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3059
branch_format='bzrlib.branch.BzrBranchFormat7',
3060
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3064
format_registry.register_metadir('development-subtree',
3065
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment1Subtree',
3066
help='Current development format, subtree variant. Can convert data to and '
3067
'from pack-0.92-subtree (and anything compatible with '
3068
'pack-0.92-subtree) format repositories. Repositories and branches in '
3069
'this format can only be read by bzr.dev. Please read '
3070
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3072
branch_format='bzrlib.branch.BzrBranchFormat7',
3073
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3077
# And the development formats which the will have aliased one of follow:
3078
format_registry.register_metadir('development1',
3079
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment1',
3080
help='A branch and pack based repository that supports stacking. '
3082
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3084
branch_format='bzrlib.branch.BzrBranchFormat7',
3085
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3089
format_registry.register_metadir('development1-subtree',
3090
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment1Subtree',
3091
help='A branch and pack based repository that supports stacking. '
3093
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3095
branch_format='bzrlib.branch.BzrBranchFormat7',
3096
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3100
# The current format that is made on 'bzr init'.
3101
format_registry.set_default('pack-0.92')
added
removed
bzrlib/bzrdir.py
