85
55
BzrDir instances let you create or open any of the things that can be
86
56
found within .bzr - checkouts, branches and repositories.
89
59
the transport which this bzr dir is rooted at (i.e. file:///.../.bzr/)
91
a transport connected to the directory this bzr was opened from
92
(i.e. the parent directory holding the .bzr directory).
94
Everything in the bzrdir should have the same file permissions.
61
a transport connected to the directory this bzr was opened from.
98
"""Invoke break_lock on the first object in the bzrdir.
100
If there is a tree, the tree is opened and break_lock() called.
101
Otherwise, branch is tried, and finally repository.
103
# XXX: This seems more like a UI function than something that really
104
# belongs in this class.
106
thing_to_unlock = self.open_workingtree()
107
except (errors.NotLocalUrl, errors.NoWorkingTree):
109
thing_to_unlock = self.open_branch()
110
except errors.NotBranchError:
112
thing_to_unlock = self.open_repository()
113
except errors.NoRepositoryPresent:
115
thing_to_unlock.break_lock()
117
64
def can_convert_format(self):
118
65
"""Return true if this bzrdir is one whose format we can convert from."""
121
def check_conversion_target(self, target_format):
122
target_repo_format = target_format.repository_format
123
source_repo_format = self._format.repository_format
124
source_repo_format.check_conversion_target(target_repo_format)
127
def _check_supported(format, allow_unsupported,
128
recommend_upgrade=True,
130
"""Give an error or warning on old formats.
132
:param format: may be any kind of format - workingtree, branch,
135
:param allow_unsupported: If true, allow opening
136
formats that are strongly deprecated, and which may
137
have limited functionality.
139
:param recommend_upgrade: If true (default), warn
140
the user through the ui object that they may wish
141
to upgrade the object.
68
def _check_supported(self, format, allow_unsupported):
69
"""Check whether format is a supported format.
71
If allow_unsupported is True, this is a no-op.
143
# TODO: perhaps move this into a base Format class; it's not BzrDir
144
# specific. mbp 20070323
145
73
if not allow_unsupported and not format.is_supported():
146
# see open_downlevel to open legacy branches.
147
raise errors.UnsupportedFormatError(format=format)
148
if recommend_upgrade \
149
and getattr(format, 'upgrade_recommended', False):
150
ui.ui_factory.recommend_upgrade(
151
format.get_format_description(),
74
raise errors.UnsupportedFormatError(format)
154
def clone(self, url, revision_id=None, force_new_repo=False,
155
preserve_stacking=False):
76
def clone(self, url, revision_id=None, basis=None, force_new_repo=False):
156
77
"""Clone this bzrdir and its contents to url verbatim.
158
:param url: The url create the clone at. If url's last component does
159
not exist, it will be created.
160
:param revision_id: The tip revision-id to use for any branch or
161
working tree. If not None, then the clone operation may tune
162
itself to download less data.
163
:param force_new_repo: Do not use a shared repository for the target
164
even if one is available.
165
:param preserve_stacking: When cloning a stacked branch, stack the
166
new branch on top of the other branch's stacked-on branch.
168
return self.clone_on_transport(get_transport(url),
169
revision_id=revision_id,
170
force_new_repo=force_new_repo,
171
preserve_stacking=preserve_stacking)
173
def clone_on_transport(self, transport, revision_id=None,
174
force_new_repo=False, preserve_stacking=False,
176
"""Clone this bzrdir and its contents to transport verbatim.
178
:param transport: The transport for the location to produce the clone
179
at. If the target directory does not exist, it will be created.
180
:param revision_id: The tip revision-id to use for any branch or
181
working tree. If not None, then the clone operation may tune
182
itself to download less data.
183
:param force_new_repo: Do not use a shared repository for the target,
184
even if one is available.
185
:param preserve_stacking: When cloning a stacked branch, stack the
186
new branch on top of the other branch's stacked-on branch.
188
transport.ensure_base()
189
require_stacking = (stacked_on is not None)
190
metadir = self.cloning_metadir(require_stacking)
191
result = metadir.initialize_on_transport(transport)
192
repository_policy = None
79
If urls last component does not exist, it will be created.
81
if revision_id is not None, then the clone operation may tune
82
itself to download less data.
83
:param force_new_repo: Do not use a shared repository for the target
84
even if one is available.
87
basis_repo, basis_branch, basis_tree = self._get_basis_components(basis)
88
result = self._format.initialize(url)
194
90
local_repo = self.find_repository()
195
91
except errors.NoRepositoryPresent:
198
local_branch = self.open_branch()
199
except errors.NotBranchError:
202
# enable fallbacks when branch is not a branch reference
203
if local_branch.repository.has_same_location(local_repo):
204
local_repo = local_branch.repository
205
if preserve_stacking:
207
stacked_on = local_branch.get_stacked_on_url()
208
except (errors.UnstackableBranchFormat,
209
errors.UnstackableRepositoryFormat,
214
94
# may need to copy content in
215
repository_policy = result.determine_repository_policy(
216
force_new_repo, stacked_on, self.root_transport.base,
217
require_stacking=require_stacking)
218
make_working_trees = local_repo.make_working_trees()
219
result_repo = repository_policy.acquire_repository(
220
make_working_trees, local_repo.is_shared())
221
result_repo.fetch(local_repo, revision_id=revision_id)
96
local_repo.clone(result, revision_id=revision_id, basis=basis_repo)
99
result_repo = result.find_repository()
100
# fetch content this dir needs.
102
# XXX FIXME RBC 20060214 need tests for this when the basis
104
result_repo.fetch(basis_repo, revision_id=revision_id)
105
result_repo.fetch(local_repo, revision_id=revision_id)
106
except errors.NoRepositoryPresent:
107
# needed to make one anyway.
108
local_repo.clone(result, revision_id=revision_id, basis=basis_repo)
224
109
# 1 if there is a branch present
225
110
# make sure its content is available in the target repository
227
if local_branch is not None:
228
result_branch = local_branch.clone(result, revision_id=revision_id)
229
if repository_policy is not None:
230
repository_policy.configure_branch(result_branch)
231
if result_repo is None or result_repo.make_working_trees():
113
self.open_branch().clone(result, revision_id=revision_id)
114
except errors.NotBranchError:
117
self.open_workingtree().clone(result, basis=basis_tree)
118
except (errors.NoWorkingTree, errors.NotLocalUrl):
122
def _get_basis_components(self, basis):
123
"""Retrieve the basis components that are available at basis."""
125
return None, None, None
127
basis_tree = basis.open_workingtree()
128
basis_branch = basis_tree.branch
129
basis_repo = basis_branch.repository
130
except (errors.NoWorkingTree, errors.NotLocalUrl):
233
self.open_workingtree().clone(result)
234
except (errors.NoWorkingTree, errors.NotLocalUrl):
133
basis_branch = basis.open_branch()
134
basis_repo = basis_branch.repository
135
except errors.NotBranchError:
138
basis_repo = basis.open_repository()
139
except errors.NoRepositoryPresent:
141
return basis_repo, basis_branch, basis_tree
238
# TODO: This should be given a Transport, and should chdir up; otherwise
239
# this will open a new connection.
240
143
def _make_tail(self, url):
241
t = get_transport(url)
144
segments = url.split('/')
145
if segments and segments[-1] not in ('', '.'):
146
parent = '/'.join(segments[:-1])
147
t = bzrlib.transport.get_transport(parent)
149
t.mkdir(segments[-1])
150
except errors.FileExists:
245
def create(cls, base, format=None, possible_transports=None):
246
155
"""Create a new BzrDir at the url 'base'.
248
:param format: If supplied, the format of branch to create. If not
249
supplied, the default is used.
250
:param possible_transports: If supplied, a list of transports that
251
can be reused to share a remote connection.
253
if cls is not BzrDir:
254
raise AssertionError("BzrDir.create always creates the default"
255
" format, not one of %r" % cls)
256
t = get_transport(base, possible_transports)
259
format = BzrDirFormat.get_default_format()
260
return format.initialize_on_transport(t)
263
def find_bzrdirs(transport, evaluate=None, list_current=None):
264
"""Find bzrdirs recursively from current location.
266
This is intended primarily as a building block for more sophisticated
267
functionality, like finding trees under a directory, or finding
268
branches that use a given repository.
269
:param evaluate: An optional callable that yields recurse, value,
270
where recurse controls whether this bzrdir is recursed into
271
and value is the value to yield. By default, all bzrdirs
272
are recursed into, and the return value is the bzrdir.
273
:param list_current: if supplied, use this function to list the current
274
directory, instead of Transport.list_dir
275
:return: a generator of found bzrdirs, or whatever evaluate returns.
277
if list_current is None:
278
def list_current(transport):
279
return transport.list_dir('')
281
def evaluate(bzrdir):
284
pending = [transport]
285
while len(pending) > 0:
286
current_transport = pending.pop()
289
bzrdir = BzrDir.open_from_transport(current_transport)
290
except errors.NotBranchError:
293
recurse, value = evaluate(bzrdir)
296
subdirs = list_current(current_transport)
297
except errors.NoSuchFile:
300
for subdir in sorted(subdirs, reverse=True):
301
pending.append(current_transport.clone(subdir))
304
def find_branches(transport):
305
"""Find all branches under a transport.
307
This will find all branches below the transport, including branches
308
inside other branches. Where possible, it will use
309
Repository.find_branches.
311
To list all the branches that use a particular Repository, see
312
Repository.find_branches
314
def evaluate(bzrdir):
316
repository = bzrdir.open_repository()
317
except errors.NoRepositoryPresent:
320
return False, (None, repository)
322
branch = bzrdir.open_branch()
323
except errors.NotBranchError:
324
return True, (None, None)
326
return True, (branch, None)
328
for branch, repo in BzrDir.find_bzrdirs(transport, evaluate=evaluate):
330
branches.extend(repo.find_branches())
331
if branch is not None:
332
branches.append(branch)
335
def destroy_repository(self):
336
"""Destroy the repository in this BzrDir"""
337
raise NotImplementedError(self.destroy_repository)
157
This will call the current default formats initialize with base
158
as the only parameter.
160
If you need a specific format, consider creating an instance
161
of that and calling initialize().
163
segments = base.split('/')
164
if segments and segments[-1] not in ('', '.'):
165
parent = '/'.join(segments[:-1])
166
t = bzrlib.transport.get_transport(parent)
168
t.mkdir(segments[-1])
169
except errors.FileExists:
171
return BzrDirFormat.get_default_format().initialize(safe_unicode(base))
339
173
def create_branch(self):
340
174
"""Create a branch in this BzrDir.
342
The bzrdir's format will control what branch format is created.
176
The bzrdirs format will control what branch format is created.
343
177
For more control see BranchFormatXX.create(a_bzrdir).
345
179
raise NotImplementedError(self.create_branch)
347
def destroy_branch(self):
348
"""Destroy the branch in this BzrDir"""
349
raise NotImplementedError(self.destroy_branch)
352
def create_branch_and_repo(base, force_new_repo=False, format=None):
182
def create_branch_and_repo(base, force_new_repo=False):
353
183
"""Create a new BzrDir, Branch and Repository at the url 'base'.
355
This will use the current default BzrDirFormat unless one is
356
specified, and use whatever
185
This will use the current default BzrDirFormat, and use whatever
357
186
repository format that that uses via bzrdir.create_branch and
358
187
create_repository. If a shared repository is available that is used
456
222
The created Branch object is returned.
457
223
If a working tree cannot be made due to base not being a file:// url,
458
no error is raised unless force_new_tree is True, in which case no
459
data is created on disk and NotLocalUrl is raised.
461
226
:param base: The URL to create the branch at.
462
227
:param force_new_repo: If True a new repository is always created.
463
228
:param force_new_tree: If True or False force creation of a tree or
464
229
prevent such creation respectively.
465
:param format: Override for the bzrdir format to create.
466
:param possible_transports: An optional reusable transports list.
469
# check for non local urls
470
t = get_transport(base, possible_transports)
471
if not isinstance(t, local.LocalTransport):
472
raise errors.NotLocalUrl(base)
473
bzrdir = BzrDir.create(base, format, possible_transports)
231
bzrdir = BzrDir.create(base)
474
232
repo = bzrdir._find_or_create_repository(force_new_repo)
475
233
result = bzrdir.create_branch()
476
if force_new_tree or (repo.make_working_trees() and
234
if force_new_tree or (repo.make_working_trees() and
477
235
force_new_tree is None):
479
bzrdir.create_workingtree()
480
except errors.NotLocalUrl:
236
bzrdir.create_workingtree()
485
def create_standalone_workingtree(base, format=None):
240
def create_repository(base, shared=False):
241
"""Create a new BzrDir and Repository at the url 'base'.
243
This will use the current default BzrDirFormat, and use whatever
244
repository format that that uses for bzrdirformat.create_repository.
246
;param shared: Create a shared repository rather than a standalone
248
The Repository object is returned.
250
This must be overridden as an instance method in child classes, where
251
it should take no parameters and construct whatever repository format
252
that child class desires.
254
bzrdir = BzrDir.create(base)
255
return bzrdir.create_repository()
258
def create_standalone_workingtree(base):
486
259
"""Create a new BzrDir, WorkingTree, Branch and Repository at 'base'.
488
261
'base' must be a local path or a file:// url.
490
This will use the current default BzrDirFormat unless one is
491
specified, and use whatever
263
This will use the current default BzrDirFormat, and use whatever
492
264
repository format that that uses for bzrdirformat.create_workingtree,
493
265
create_branch and create_repository.
495
:param format: Override for the bzrdir format to create.
496
:return: The WorkingTree object.
267
The WorkingTree object is returned.
498
t = get_transport(base)
499
if not isinstance(t, local.LocalTransport):
269
t = get_transport(safe_unicode(base))
270
if not isinstance(t, LocalTransport):
500
271
raise errors.NotLocalUrl(base)
501
bzrdir = BzrDir.create_branch_and_repo(base,
503
format=format).bzrdir
272
bzrdir = BzrDir.create_branch_and_repo(safe_unicode(base),
273
force_new_repo=True).bzrdir
504
274
return bzrdir.create_workingtree()
506
def create_workingtree(self, revision_id=None, from_branch=None,
507
accelerator_tree=None, hardlink=False):
276
def create_workingtree(self, revision_id=None):
508
277
"""Create a working tree at this BzrDir.
510
:param revision_id: create it as of this revision id.
511
:param from_branch: override bzrdir branch (for lightweight checkouts)
512
:param accelerator_tree: A tree which can be used for retrieving file
513
contents more quickly than the revision tree, i.e. a workingtree.
514
The revision tree will be used for cases where accelerator_tree's
515
content is different.
279
revision_id: create it as of this revision id.
517
281
raise NotImplementedError(self.create_workingtree)
519
def retire_bzrdir(self, limit=10000):
520
"""Permanently disable the bzrdir.
522
This is done by renaming it to give the user some ability to recover
523
if there was a problem.
525
This will have horrible consequences if anyone has anything locked or
527
:param limit: number of times to retry
532
to_path = '.bzr.retired.%d' % i
533
self.root_transport.rename('.bzr', to_path)
534
note("renamed %s to %s"
535
% (self.root_transport.abspath('.bzr'), to_path))
537
except (errors.TransportError, IOError, errors.PathError):
544
def destroy_workingtree(self):
545
"""Destroy the working tree at this BzrDir.
547
Formats that do not support this may raise UnsupportedOperation.
549
raise NotImplementedError(self.destroy_workingtree)
551
def destroy_workingtree_metadata(self):
552
"""Destroy the control files for the working tree at this BzrDir.
554
The contents of working tree files are not affected.
555
Formats that do not support this may raise UnsupportedOperation.
557
raise NotImplementedError(self.destroy_workingtree_metadata)
559
def _find_containing(self, evaluate):
560
"""Find something in a containing control directory.
562
This method will scan containing control dirs, until it finds what
563
it is looking for, decides that it will never find it, or runs out
564
of containing control directories to check.
566
It is used to implement find_repository and
567
determine_repository_policy.
569
:param evaluate: A function returning (value, stop). If stop is True,
570
the value will be returned.
574
result, stop = evaluate(found_bzrdir)
577
next_transport = found_bzrdir.root_transport.clone('..')
578
if (found_bzrdir.root_transport.base == next_transport.base):
579
# top of the file system
581
# find the next containing bzrdir
583
found_bzrdir = BzrDir.open_containing_from_transport(
585
except errors.NotBranchError:
588
283
def find_repository(self):
589
"""Find the repository that should be used.
284
"""Find the repository that should be used for a_bzrdir.
591
286
This does not require a branch as we use it to find the repo for
592
287
new branches as well as to hook existing branches up to their
595
def usable_repository(found_bzrdir):
596
# does it have a repository ?
291
return self.open_repository()
292
except errors.NoRepositoryPresent:
294
next_transport = self.root_transport.clone('..')
297
found_bzrdir = BzrDir.open_containing_from_transport(
299
except errors.NotBranchError:
300
raise errors.NoRepositoryPresent(self)
598
302
repository = found_bzrdir.open_repository()
599
303
except errors.NoRepositoryPresent:
601
if found_bzrdir.root_transport.base == self.root_transport.base:
602
return repository, True
603
elif repository.is_shared():
604
return repository, True
304
next_transport = found_bzrdir.root_transport.clone('..')
306
if ((found_bzrdir.root_transport.base ==
307
self.root_transport.base) or repository.is_shared()):
608
found_repo = self._find_containing(usable_repository)
609
if found_repo is None:
610
raise errors.NoRepositoryPresent(self)
613
def get_branch_reference(self):
614
"""Return the referenced URL for the branch in this bzrdir.
616
:raises NotBranchError: If there is no Branch.
617
:return: The URL the branch in this bzrdir references if it is a
618
reference branch, or None for regular branches.
310
raise errors.NoRepositoryPresent(self)
311
raise errors.NoRepositoryPresent(self)
622
313
def get_branch_transport(self, branch_format):
623
314
"""Get the transport for use by branch format in this BzrDir.
625
316
Note that bzr dirs that do not support format strings will raise
626
317
IncompatibleFormat if the branch format they are given has
627
a format string, and vice versa.
318
a format string, and vice verca.
629
320
If branch_format is None, the transport is returned with no
630
checking. If it is not None, then the returned transport is
321
checking. if it is not None, then the returned transport is
631
322
guaranteed to point to an existing directory ready for use.
633
324
raise NotImplementedError(self.get_branch_transport)
635
def _find_creation_modes(self):
636
"""Determine the appropriate modes for files and directories.
638
They're always set to be consistent with the base directory,
639
assuming that this transport allows setting modes.
641
# TODO: Do we need or want an option (maybe a config setting) to turn
642
# this off or override it for particular locations? -- mbp 20080512
643
if self._mode_check_done:
645
self._mode_check_done = True
647
st = self.transport.stat('.')
648
except errors.TransportNotPossible:
649
self._dir_mode = None
650
self._file_mode = None
652
# Check the directory mode, but also make sure the created
653
# directories and files are read-write for this user. This is
654
# mostly a workaround for filesystems which lie about being able to
655
# write to a directory (cygwin & win32)
656
if (st.st_mode & 07777 == 00000):
657
# FTP allows stat but does not return dir/file modes
658
self._dir_mode = None
659
self._file_mode = None
661
self._dir_mode = (st.st_mode & 07777) | 00700
662
# Remove the sticky and execute bits for files
663
self._file_mode = self._dir_mode & ~07111
665
def _get_file_mode(self):
666
"""Return Unix mode for newly created files, or None.
668
if not self._mode_check_done:
669
self._find_creation_modes()
670
return self._file_mode
672
def _get_dir_mode(self):
673
"""Return Unix mode for newly created directories, or None.
675
if not self._mode_check_done:
676
self._find_creation_modes()
677
return self._dir_mode
679
326
def get_repository_transport(self, repository_format):
680
327
"""Get the transport for use by repository format in this BzrDir.
682
329
Note that bzr dirs that do not support format strings will raise
683
330
IncompatibleFormat if the repository format they are given has
684
a format string, and vice versa.
331
a format string, and vice verca.
686
333
If repository_format is None, the transport is returned with no
687
checking. If it is not None, then the returned transport is
334
checking. if it is not None, then the returned transport is
688
335
guaranteed to point to an existing directory ready for use.
690
337
raise NotImplementedError(self.get_repository_transport)
838
431
If there is one and it is either an unrecognised format or an unsupported
839
432
format, UnknownFormatError or UnsupportedFormatError are raised.
840
433
If there is one, it is returned, along with the unused portion of url.
842
:return: The BzrDir that contains the path, and a Unicode path
843
for the rest of the URL.
845
435
# this gets the normalised url back. I.e. '.' -> the full path.
846
436
url = a_transport.base
849
result = BzrDir.open_from_transport(a_transport)
850
return result, urlutils.unescape(a_transport.relpath(url))
439
format = BzrDirFormat.find_format(a_transport)
440
return format.open(a_transport), a_transport.relpath(url)
851
441
except errors.NotBranchError, e:
854
new_t = a_transport.clone('..')
855
except errors.InvalidURLJoin:
856
# reached the root, whatever that may be
857
raise errors.NotBranchError(path=url)
442
mutter('not a branch in: %r %s', a_transport.base, e)
443
new_t = a_transport.clone('..')
858
444
if new_t.base == a_transport.base:
859
445
# reached the root, whatever that may be
860
446
raise errors.NotBranchError(path=url)
861
447
a_transport = new_t
863
def _get_tree_branch(self):
864
"""Return the branch and tree, if any, for this bzrdir.
866
Return None for tree if not present or inaccessible.
867
Raise NotBranchError if no branch is present.
868
:return: (tree, branch)
871
tree = self.open_workingtree()
872
except (errors.NoWorkingTree, errors.NotLocalUrl):
874
branch = self.open_branch()
880
def open_tree_or_branch(klass, location):
881
"""Return the branch and working tree at a location.
883
If there is no tree at the location, tree will be None.
884
If there is no branch at the location, an exception will be
886
:return: (tree, branch)
888
bzrdir = klass.open(location)
889
return bzrdir._get_tree_branch()
892
def open_containing_tree_or_branch(klass, location):
893
"""Return the branch and working tree contained by a location.
895
Returns (tree, branch, relpath).
896
If there is no tree at containing the location, tree will be None.
897
If there is no branch containing the location, an exception will be
899
relpath is the portion of the path that is contained by the branch.
901
bzrdir, relpath = klass.open_containing(location)
902
tree, branch = bzrdir._get_tree_branch()
903
return tree, branch, relpath
906
def open_containing_tree_branch_or_repository(klass, location):
907
"""Return the working tree, branch and repo contained by a location.
909
Returns (tree, branch, repository, relpath).
910
If there is no tree containing the location, tree will be None.
911
If there is no branch containing the location, branch will be None.
912
If there is no repository containing the location, repository will be
914
relpath is the portion of the path that is contained by the innermost
917
If no tree, branch or repository is found, a NotBranchError is raised.
919
bzrdir, relpath = klass.open_containing(location)
921
tree, branch = bzrdir._get_tree_branch()
922
except errors.NotBranchError:
924
repo = bzrdir.find_repository()
925
return None, None, repo, relpath
926
except (errors.NoRepositoryPresent):
927
raise errors.NotBranchError(location)
928
return tree, branch, branch.repository, relpath
930
449
def open_repository(self, _unsupported=False):
931
450
"""Open the repository object at this BzrDir if one is present.
933
This will not follow the Branch object pointer - it's strictly a direct
452
This will not follow the Branch object pointer - its strictly a direct
934
453
open facility. Most client code should use open_branch().repository to
935
454
get at a repository.
937
:param _unsupported: a private parameter, not part of the api.
456
_unsupported is a private parameter, not part of the api.
938
457
TODO: static convenience version of this?
940
459
raise NotImplementedError(self.open_repository)
942
def open_workingtree(self, _unsupported=False,
943
recommend_upgrade=True, from_branch=None):
461
def open_workingtree(self, _unsupported=False):
944
462
"""Open the workingtree object at this BzrDir if one is present.
946
:param recommend_upgrade: Optional keyword parameter, when True (the
947
default), emit through the ui module a recommendation that the user
948
upgrade the working tree when the workingtree being opened is old
949
(but still fully supported).
950
:param from_branch: override bzrdir branch (for lightweight checkouts)
464
TODO: static convenience version of this?
952
466
raise NotImplementedError(self.open_workingtree)
954
def has_branch(self):
955
"""Tell if this bzrdir contains a branch.
957
Note: if you're going to open the branch, you should just go ahead
958
and try, and not ask permission first. (This method just opens the
959
branch and discards it, and that's somewhat expensive.)
964
except errors.NotBranchError:
967
def has_workingtree(self):
968
"""Tell if this bzrdir contains a working tree.
970
This will still raise an exception if the bzrdir has a workingtree that
971
is remote & inaccessible.
973
Note: if you're going to open the working tree, you should just go ahead
974
and try, and not ask permission first. (This method just opens the
975
workingtree and discards it, and that's somewhat expensive.)
978
self.open_workingtree(recommend_upgrade=False)
980
except errors.NoWorkingTree:
983
def _cloning_metadir(self):
984
"""Produce a metadir suitable for cloning with.
986
:returns: (destination_bzrdir_format, source_repository)
988
result_format = self._format.__class__()
991
branch = self.open_branch()
992
source_repository = branch.repository
993
result_format._branch_format = branch._format
994
except errors.NotBranchError:
996
source_repository = self.open_repository()
997
except errors.NoRepositoryPresent:
998
source_repository = None
1000
# XXX TODO: This isinstance is here because we have not implemented
1001
# the fix recommended in bug # 103195 - to delegate this choice the
1002
# repository itself.
1003
repo_format = source_repository._format
1004
if isinstance(repo_format, remote.RemoteRepositoryFormat):
1005
source_repository._ensure_real()
1006
repo_format = source_repository._real_repository._format
1007
result_format.repository_format = repo_format
1009
# TODO: Couldn't we just probe for the format in these cases,
1010
# rather than opening the whole tree? It would be a little
1011
# faster. mbp 20070401
1012
tree = self.open_workingtree(recommend_upgrade=False)
1013
except (errors.NoWorkingTree, errors.NotLocalUrl):
1014
result_format.workingtree_format = None
1016
result_format.workingtree_format = tree._format.__class__()
1017
return result_format, source_repository
1019
def cloning_metadir(self, require_stacking=False):
1020
"""Produce a metadir suitable for cloning or sprouting with.
1022
These operations may produce workingtrees (yes, even though they're
1023
"cloning" something that doesn't have a tree), so a viable workingtree
1024
format must be selected.
1026
:require_stacking: If True, non-stackable formats will be upgraded
1027
to similar stackable formats.
1028
:returns: a BzrDirFormat with all component formats either set
1029
appropriately or set to None if that component should not be
1032
format, repository = self._cloning_metadir()
1033
if format._workingtree_format is None:
1034
if repository is None:
1036
tree_format = repository._format._matchingbzrdir.workingtree_format
1037
format.workingtree_format = tree_format.__class__()
1038
if (require_stacking and not
1039
format.get_branch_format().supports_stacking()):
1040
# We need to make a stacked branch, but the default format for the
1041
# target doesn't support stacking. So force a branch that *can*
1043
from bzrlib.branch import BzrBranchFormat7
1044
format._branch_format = BzrBranchFormat7()
1045
mutter("using %r for stacking" % (format._branch_format,))
1046
from bzrlib.repofmt import pack_repo
1047
if format.repository_format.rich_root_data:
1048
bzrdir_format_name = '1.6.1-rich-root'
1049
repo_format = pack_repo.RepositoryFormatKnitPack5RichRoot()
1051
bzrdir_format_name = '1.6'
1052
repo_format = pack_repo.RepositoryFormatKnitPack5()
1053
note('Source format does not support stacking, using format:'
1055
bzrdir_format_name, repo_format.get_format_description())
1056
format.repository_format = repo_format
1059
def checkout_metadir(self):
1060
return self.cloning_metadir()
1062
def sprout(self, url, revision_id=None, force_new_repo=False,
1063
recurse='down', possible_transports=None,
1064
accelerator_tree=None, hardlink=False, stacked=False):
468
def sprout(self, url, revision_id=None, basis=None, force_new_repo=False):
1065
469
"""Create a copy of this bzrdir prepared for use as a new line of
1068
If url's last component does not exist, it will be created.
472
If urls last component does not exist, it will be created.
1070
474
Attributes related to the identity of the source branch like
1071
475
branch nickname will be cleaned, a working tree is created
1075
479
if revision_id is not None, then the clone operation may tune
1076
480
itself to download less data.
1077
:param accelerator_tree: A tree which can be used for retrieving file
1078
contents more quickly than the revision tree, i.e. a workingtree.
1079
The revision tree will be used for cases where accelerator_tree's
1080
content is different.
1081
:param hardlink: If true, hard-link files from accelerator_tree,
1083
:param stacked: If true, create a stacked branch referring to the
1084
location of this control directory.
1086
target_transport = get_transport(url, possible_transports)
1087
target_transport.ensure_base()
1088
cloning_format = self.cloning_metadir(stacked)
1089
# Create/update the result branch
1090
result = cloning_format.initialize_on_transport(target_transport)
483
result = self._format.initialize(url)
484
basis_repo, basis_branch, basis_tree = self._get_basis_components(basis)
1092
486
source_branch = self.open_branch()
1093
487
source_repository = source_branch.repository
1095
stacked_branch_url = self.root_transport.base
1097
# if a stacked branch wasn't requested, we don't create one
1098
# even if the origin was stacked
1099
stacked_branch_url = None
1100
488
except errors.NotBranchError:
1101
489
source_branch = None
1103
491
source_repository = self.open_repository()
1104
492
except errors.NoRepositoryPresent:
1105
source_repository = None
1106
stacked_branch_url = None
1107
repository_policy = result.determine_repository_policy(
1108
force_new_repo, stacked_branch_url, require_stacking=stacked)
1109
result_repo = repository_policy.acquire_repository()
1110
if source_repository is not None:
1111
# Fetch while stacked to prevent unstacked fetch from
493
# copy the entire basis one if there is one
494
# but there is no repository.
495
source_repository = basis_repo
500
result_repo = result.find_repository()
501
except errors.NoRepositoryPresent:
503
if source_repository is None and result_repo is not None:
505
elif source_repository is None and result_repo is None:
506
# no repo available, make a new one
507
result.create_repository()
508
elif source_repository is not None and result_repo is None:
509
# have soure, and want to make a new target repo
510
source_repository.clone(result,
511
revision_id=revision_id,
514
# fetch needed content into target.
516
# XXX FIXME RBC 20060214 need tests for this when the basis
518
result_repo.fetch(basis_repo, revision_id=revision_id)
1113
519
result_repo.fetch(source_repository, revision_id=revision_id)
1115
if source_branch is None:
1116
# this is for sprouting a bzrdir without a branch; is that
1118
# Not especially, but it's part of the contract.
1119
result_branch = result.create_branch()
1121
# Force NULL revision to avoid using repository before stacking
1123
result_branch = source_branch.sprout(
1124
result, revision_id=_mod_revision.NULL_REVISION)
1125
parent_location = result_branch.get_parent()
1126
mutter("created new branch %r" % (result_branch,))
1127
repository_policy.configure_branch(result_branch)
1128
520
if source_branch is not None:
1129
source_branch.copy_content_into(result_branch, revision_id)
1130
# Override copy_content_into
1131
result_branch.set_parent(parent_location)
1133
# Create/update the result working tree
1134
if isinstance(target_transport, local.LocalTransport) and (
1135
result_repo is None or result_repo.make_working_trees()):
1136
wt = result.create_workingtree(accelerator_tree=accelerator_tree,
1140
if wt.path2id('') is None:
1142
wt.set_root_id(self.open_workingtree.get_root_id())
1143
except errors.NoWorkingTree:
521
source_branch.sprout(result, revision_id=revision_id)
1149
if recurse == 'down':
1151
basis = wt.basis_tree()
1153
subtrees = basis.iter_references()
1154
elif result_branch is not None:
1155
basis = result_branch.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:
523
result.create_branch()
525
self.open_workingtree().clone(result,
526
revision_id=revision_id,
528
except (errors.NoWorkingTree, errors.NotLocalUrl):
529
result.create_workingtree()
1995
1055
- Format 7 repositories [optional]
1998
_lock_class = lockdir.LockDir
2001
self._workingtree_format = None
2002
self._branch_format = None
2004
def __eq__(self, other):
2005
if other.__class__ is not self.__class__:
2007
if other.repository_format != self.repository_format:
2009
if other.workingtree_format != self.workingtree_format:
2013
def __ne__(self, other):
2014
return not self == other
2016
def get_branch_format(self):
2017
if self._branch_format is None:
2018
from bzrlib.branch import BranchFormat
2019
self._branch_format = BranchFormat.get_default_format()
2020
return self._branch_format
2022
def set_branch_format(self, format):
2023
self._branch_format = format
2025
def get_converter(self, format=None):
2026
"""See BzrDirFormat.get_converter()."""
2028
format = BzrDirFormat.get_default_format()
2029
if not isinstance(self, format.__class__):
2030
# converting away from metadir is not implemented
2031
raise NotImplementedError(self.get_converter)
2032
return ConvertMetaToMeta(format)
2034
1058
def get_format_string(self):
2035
1059
"""See BzrDirFormat.get_format_string()."""
2036
1060
return "Bazaar-NG meta directory, format 1\n"
2038
def get_format_description(self):
2039
"""See BzrDirFormat.get_format_description()."""
2040
return "Meta directory format 1"
2042
1062
def _open(self, transport):
2043
1063
"""See BzrDirFormat._open."""
2044
1064
return BzrDirMeta1(transport, self)
2046
def __return_repository_format(self):
2047
"""Circular import protection."""
2048
if getattr(self, '_repository_format', None):
2049
return self._repository_format
2050
from bzrlib.repository import RepositoryFormat
2051
return RepositoryFormat.get_default_format()
2053
def __set_repository_format(self, value):
2054
"""Allow changing the repository format for metadir formats."""
2055
self._repository_format = value
2057
repository_format = property(__return_repository_format, __set_repository_format)
2059
def __get_workingtree_format(self):
2060
if self._workingtree_format is None:
2061
from bzrlib.workingtree import WorkingTreeFormat
2062
self._workingtree_format = WorkingTreeFormat.get_default_format()
2063
return self._workingtree_format
2065
def __set_workingtree_format(self, wt_format):
2066
self._workingtree_format = wt_format
2068
workingtree_format = property(__get_workingtree_format,
2069
__set_workingtree_format)
2072
# Register bzr control format
2073
BzrDirFormat.register_control_format(BzrDirFormat)
2075
# Register bzr formats
2076
1067
BzrDirFormat.register_format(BzrDirFormat4())
2077
1068
BzrDirFormat.register_format(BzrDirFormat5())
2078
BzrDirFormat.register_format(BzrDirFormat6())
2079
__default_format = BzrDirMetaFormat1()
1069
BzrDirFormat.register_format(BzrDirMetaFormat1())
1070
__default_format = BzrDirFormat6()
2080
1071
BzrDirFormat.register_format(__default_format)
2081
BzrDirFormat._default_format = __default_format
1072
BzrDirFormat.set_default_format(__default_format)
1075
class BzrDirTestProviderAdapter(object):
1076
"""A tool to generate a suite testing multiple bzrdir formats at once.
1078
This is done by copying the test once for each transport and injecting
1079
the transport_server, transport_readonly_server, and bzrdir_format
1080
classes into each copy. Each copy is also given a new id() to make it
1084
def __init__(self, transport_server, transport_readonly_server, formats):
1085
self._transport_server = transport_server
1086
self._transport_readonly_server = transport_readonly_server
1087
self._formats = formats
1089
def adapt(self, test):
1090
result = TestSuite()
1091
for format in self._formats:
1092
new_test = deepcopy(test)
1093
new_test.transport_server = self._transport_server
1094
new_test.transport_readonly_server = self._transport_readonly_server
1095
new_test.bzrdir_format = format
1096
def make_new_test_id():
1097
new_id = "%s(%s)" % (new_test.id(), format.__class__.__name__)
1098
return lambda: new_id
1099
new_test.id = make_new_test_id()
1100
result.addTest(new_test)
1104
class ScratchDir(BzrDir6):
1105
"""Special test class: a bzrdir that cleans up itself..
1107
>>> d = ScratchDir()
1108
>>> base = d.transport.base
1111
>>> b.transport.__del__()
1116
def __init__(self, files=[], dirs=[], transport=None):
1117
"""Make a test branch.
1119
This creates a temporary directory and runs init-tree in it.
1121
If any files are listed, they are created in the working copy.
1123
if transport is None:
1124
transport = bzrlib.transport.local.ScratchTransport()
1125
# local import for scope restriction
1126
BzrDirFormat6().initialize(transport.base)
1127
super(ScratchDir, self).__init__(transport, BzrDirFormat6())
1128
self.create_repository()
1129
self.create_branch()
1130
self.create_workingtree()
1132
super(ScratchDir, self).__init__(transport, BzrDirFormat6())
1134
# BzrBranch creates a clone to .bzr and then forgets about the
1135
# original transport. A ScratchTransport() deletes itself and
1136
# everything underneath it when it goes away, so we need to
1137
# grab a local copy to prevent that from happening
1138
self._transport = transport
1141
self._transport.mkdir(d)
1144
self._transport.put(f, 'content of %s' % f)
1148
>>> orig = ScratchDir(files=["file1", "file2"])
1149
>>> os.listdir(orig.base)
1150
[u'.bzr', u'file1', u'file2']
1151
>>> clone = orig.clone()
1152
>>> if os.name != 'nt':
1153
... os.path.samefile(orig.base, clone.base)
1155
... orig.base == clone.base
1158
>>> os.listdir(clone.base)
1159
[u'.bzr', u'file1', u'file2']
1161
from shutil import copytree
1162
from bzrlib.osutils import mkdtemp
1165
copytree(self.base, base, symlinks=True)
1167
transport=bzrlib.transport.local.ScratchTransport(base))
2084
1170
class Converter(object):
2431
1497
# find out whats there
2432
1498
self.step('Finding branch files')
2433
last_revision = self.bzrdir.open_branch().last_revision()
1499
last_revision = self.bzrdir.open_workingtree().last_revision()
2434
1500
bzrcontents = self.bzrdir.transport.list_dir('.')
2435
1501
for name in bzrcontents:
2436
1502
if name.startswith('basis-inventory.'):
2437
1503
self.garbage_inventories.append(name)
2438
1504
# create new directories for repository, working tree and branch
1505
dir_mode = self.bzrdir._control_files._dir_mode
1506
self.file_mode = self.bzrdir._control_files._file_mode
2439
1507
repository_names = [('inventory.weave', True),
2440
1508
('revision-store', True),
2441
1509
('weaves', True)]
2442
1510
self.step('Upgrading repository ')
2443
self.bzrdir.transport.mkdir('repository', mode=self.dir_mode)
1511
self.bzrdir.transport.mkdir('repository', mode=dir_mode)
2444
1512
self.make_lock('repository')
2445
1513
# we hard code the formats here because we are converting into
2446
1514
# the meta format. The meta format upgrader can take this to a
2447
1515
# future format within each component.
2448
self.put_format('repository', RepositoryFormat7())
1516
self.put_format('repository', bzrlib.repository.RepositoryFormat7())
2449
1517
for entry in repository_names:
2450
1518
self.move_entry('repository', entry)
2452
1520
self.step('Upgrading branch ')
2453
self.bzrdir.transport.mkdir('branch', mode=self.dir_mode)
1521
self.bzrdir.transport.mkdir('branch', mode=dir_mode)
2454
1522
self.make_lock('branch')
2455
self.put_format('branch', BzrBranchFormat5())
1523
self.put_format('branch', bzrlib.branch.BzrBranchFormat5())
2456
1524
branch_files = [('revision-history', True),
2457
1525
('branch-name', True),
2458
1526
('parent', False)]
2459
1527
for entry in branch_files:
2460
1528
self.move_entry('branch', entry)
1530
self.step('Upgrading working tree')
1531
self.bzrdir.transport.mkdir('checkout', mode=dir_mode)
1532
self.make_lock('checkout')
1533
self.put_format('checkout', bzrlib.workingtree.WorkingTreeFormat3())
1534
self.bzrdir.transport.delete_multi(self.garbage_inventories, self.pb)
2462
1535
checkout_files = [('pending-merges', True),
2463
1536
('inventory', True),
2464
1537
('stat-cache', False)]
2465
# If a mandatory checkout file is not present, the branch does not have
2466
# a functional checkout. Do not create a checkout in the converted
2468
for name, mandatory in checkout_files:
2469
if mandatory and name not in bzrcontents:
2470
has_checkout = False
2474
if not has_checkout:
2475
self.pb.note('No working tree.')
2476
# If some checkout files are there, we may as well get rid of them.
2477
for name, mandatory in checkout_files:
2478
if name in bzrcontents:
2479
self.bzrdir.transport.delete(name)
2481
from bzrlib.workingtree import WorkingTreeFormat3
2482
self.step('Upgrading working tree')
2483
self.bzrdir.transport.mkdir('checkout', mode=self.dir_mode)
2484
self.make_lock('checkout')
2486
'checkout', WorkingTreeFormat3())
2487
self.bzrdir.transport.delete_multi(
2488
self.garbage_inventories, self.pb)
2489
for entry in checkout_files:
2490
self.move_entry('checkout', entry)
2491
if last_revision is not None:
2492
self.bzrdir.transport.put_bytes(
2493
'checkout/last-revision', last_revision)
2494
self.bzrdir.transport.put_bytes(
2496
BzrDirMetaFormat1().get_format_string(),
2497
mode=self.file_mode)
1538
for entry in checkout_files:
1539
self.move_entry('checkout', entry)
1540
if last_revision is not None:
1541
self.bzrdir._control_files.put_utf8('checkout/last-revision',
1543
self.bzrdir._control_files.put_utf8('branch-format', BzrDirMetaFormat1().get_format_string())
2498
1544
return BzrDir.open(self.bzrdir.root_transport.base)
2500
1546
def make_lock(self, name):
2501
1547
"""Make a lock for the new control dir name."""
2502
1548
self.step('Make %s lock' % name)
2503
ld = lockdir.LockDir(self.bzrdir.transport,
2505
file_modebits=self.file_mode,
2506
dir_modebits=self.dir_mode)
1549
self.bzrdir.transport.put('%s/lock' % name, StringIO(), mode=self.file_mode)
2509
1551
def move_entry(self, new_dir, entry):
2510
1552
"""Move then entry name into new_dir."""
2520
1562
def put_format(self, dirname, format):
2521
self.bzrdir.transport.put_bytes('%s/format' % dirname,
2522
format.get_format_string(),
2526
class ConvertMetaToMeta(Converter):
2527
"""Converts the components of metadirs."""
2529
def __init__(self, target_format):
2530
"""Create a metadir to metadir converter.
2532
:param target_format: The final metadir format that is desired.
2534
self.target_format = target_format
2536
def convert(self, to_convert, pb):
2537
"""See Converter.convert()."""
2538
self.bzrdir = to_convert
2542
self.step('checking repository format')
2544
repo = self.bzrdir.open_repository()
2545
except errors.NoRepositoryPresent:
2548
if not isinstance(repo._format, self.target_format.repository_format.__class__):
2549
from bzrlib.repository import CopyConverter
2550
self.pb.note('starting repository conversion')
2551
converter = CopyConverter(self.target_format.repository_format)
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)
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.RepositoryFormatPackDevelopment2',
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.RepositoryFormatPackDevelopment2Subtree',
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 above will have aliased one of the following:
3078
format_registry.register_metadir('development2',
3079
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment2',
3080
help='1.6.1 with B+Tree based index. '
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('development2-subtree',
3090
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment2Subtree',
3091
help='1.6.1-subtree with B+Tree based index. '
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')
1563
self.bzrdir._control_files.put_utf8('%s/format' % dirname, format.get_format_string())
1565
def step(self, message):
1566
"""Update the pb by a step."""
1568
self.pb.update('Upgrading repository ', self.count, self.total)
added
removed
bzrlib/bzrdir.py
