83
116
thing_to_unlock.break_lock()
85
def can_convert_format(self):
86
"""Return true if this bzrdir is one whose format we can convert from."""
90
def _check_supported(format, allow_unsupported):
91
"""Check whether format is a supported format.
93
If allow_unsupported is True, this is a no-op.
95
if not allow_unsupported and not format.is_supported():
96
# see open_downlevel to open legacy branches.
97
raise errors.UnsupportedFormatError(format=format)
99
def clone(self, url, revision_id=None, basis=None, force_new_repo=False):
100
"""Clone this bzrdir and its contents to url verbatim.
102
If urls last component does not exist, it will be created.
104
if revision_id is not None, then the clone operation may tune
118
def check_conversion_target(self, target_format):
119
"""Check that a bzrdir as a whole can be converted to a new format."""
120
# The only current restriction is that the repository content can be
121
# fetched compatibly with the target.
122
target_repo_format = target_format.repository_format
124
self.open_repository()._format.check_conversion_target(
126
except errors.NoRepositoryPresent:
127
# No repo, no problem.
130
def clone_on_transport(self, transport, revision_id=None,
131
force_new_repo=False, preserve_stacking=False, stacked_on=None,
132
create_prefix=False, use_existing_dir=True, no_tree=False):
133
"""Clone this bzrdir and its contents to transport verbatim.
135
:param transport: The transport for the location to produce the clone
136
at. If the target directory does not exist, it will be created.
137
:param revision_id: The tip revision-id to use for any branch or
138
working tree. If not None, then the clone operation may tune
105
139
itself to download less data.
106
:param force_new_repo: Do not use a shared repository for the target
140
:param force_new_repo: Do not use a shared repository for the target,
107
141
even if one is available.
142
:param preserve_stacking: When cloning a stacked branch, stack the
143
new branch on top of the other branch's stacked-on branch.
144
:param create_prefix: Create any missing directories leading up to
146
:param use_existing_dir: Use an existing directory if one exists.
147
:param no_tree: If set to true prevents creation of a working tree.
110
basis_repo, basis_branch, basis_tree = self._get_basis_components(basis)
111
result = self._format.initialize(url)
149
# Overview: put together a broad description of what we want to end up
150
# with; then make as few api calls as possible to do it.
152
# We may want to create a repo/branch/tree, if we do so what format
153
# would we want for each:
154
require_stacking = (stacked_on is not None)
155
format = self.cloning_metadir(require_stacking)
157
# Figure out what objects we want:
113
159
local_repo = self.find_repository()
114
160
except errors.NoRepositoryPresent:
115
161
local_repo = None
163
local_branch = self.open_branch()
164
except errors.NotBranchError:
167
# enable fallbacks when branch is not a branch reference
168
if local_branch.repository.has_same_location(local_repo):
169
local_repo = local_branch.repository
170
if preserve_stacking:
172
stacked_on = local_branch.get_stacked_on_url()
173
except (errors.UnstackableBranchFormat,
174
errors.UnstackableRepositoryFormat,
177
# Bug: We create a metadir without knowing if it can support stacking,
178
# we should look up the policy needs first, or just use it as a hint,
117
# may need to copy content in
119
result_repo = local_repo.clone(
121
revision_id=revision_id,
123
result_repo.set_make_working_trees(local_repo.make_working_trees())
126
result_repo = result.find_repository()
127
# fetch content this dir needs.
129
# XXX FIXME RBC 20060214 need tests for this when the basis
131
result_repo.fetch(basis_repo, revision_id=revision_id)
181
make_working_trees = local_repo.make_working_trees() and not no_tree
182
want_shared = local_repo.is_shared()
183
repo_format_name = format.repository_format.network_name()
185
make_working_trees = False
187
repo_format_name = None
189
result_repo, result, require_stacking, repository_policy = \
190
format.initialize_on_transport_ex(transport,
191
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
192
force_new_repo=force_new_repo, stacked_on=stacked_on,
193
stack_on_pwd=self.root_transport.base,
194
repo_format_name=repo_format_name,
195
make_working_trees=make_working_trees, shared_repo=want_shared)
198
# If the result repository is in the same place as the
199
# resulting bzr dir, it will have no content, further if the
200
# result is not stacked then we know all content should be
201
# copied, and finally if we are copying up to a specific
202
# revision_id then we can use the pending-ancestry-result which
203
# does not require traversing all of history to describe it.
204
if (result_repo.user_url == result.user_url
205
and not require_stacking and
206
revision_id is not None):
207
fetch_spec = vf_search.PendingAncestryResult(
208
[revision_id], local_repo)
209
result_repo.fetch(local_repo, fetch_spec=fetch_spec)
132
211
result_repo.fetch(local_repo, revision_id=revision_id)
133
except errors.NoRepositoryPresent:
134
# needed to make one anyway.
135
result_repo = local_repo.clone(
137
revision_id=revision_id,
139
result_repo.set_make_working_trees(local_repo.make_working_trees())
215
if result_repo is not None:
216
raise AssertionError('result_repo not None(%r)' % result_repo)
140
217
# 1 if there is a branch present
141
218
# make sure its content is available in the target repository
144
self.open_branch().clone(result, revision_id=revision_id)
145
except errors.NotBranchError:
148
self.open_workingtree().clone(result, basis=basis_tree)
220
if local_branch is not None:
221
result_branch = local_branch.clone(result, revision_id=revision_id,
222
repository_policy=repository_policy)
224
# Cheaper to check if the target is not local, than to try making
226
result.root_transport.local_abspath('.')
227
if result_repo is None or result_repo.make_working_trees():
228
self.open_workingtree().clone(result, revision_id=revision_id)
149
229
except (errors.NoWorkingTree, errors.NotLocalUrl):
153
def _get_basis_components(self, basis):
154
"""Retrieve the basis components that are available at basis."""
156
return None, None, None
158
basis_tree = basis.open_workingtree()
159
basis_branch = basis_tree.branch
160
basis_repo = basis_branch.repository
161
except (errors.NoWorkingTree, errors.NotLocalUrl):
164
basis_branch = basis.open_branch()
165
basis_repo = basis_branch.repository
166
except errors.NotBranchError:
169
basis_repo = basis.open_repository()
170
except errors.NoRepositoryPresent:
172
return basis_repo, basis_branch, basis_tree
174
233
# TODO: This should be given a Transport, and should chdir up; otherwise
175
234
# this will open a new connection.
176
235
def _make_tail(self, url):
177
head, tail = urlutils.split(url)
178
if tail and tail != '.':
179
t = bzrlib.transport.get_transport(head)
182
except errors.FileExists:
185
# TODO: Should take a Transport
187
def create(cls, base):
188
"""Create a new BzrDir at the url 'base'.
190
This will call the current default formats initialize with base
191
as the only parameter.
193
If you need a specific format, consider creating an instance
194
of that and calling initialize().
196
if cls is not BzrDir:
197
raise AssertionError("BzrDir.create always creates the default format, "
198
"not one of %r" % cls)
199
head, tail = urlutils.split(base)
200
if tail and tail != '.':
201
t = bzrlib.transport.get_transport(head)
204
except errors.FileExists:
206
return BzrDirFormat.get_default_format().initialize(safe_unicode(base))
208
def create_branch(self):
209
"""Create a branch in this BzrDir.
211
The bzrdirs format will control what branch format is created.
212
For more control see BranchFormatXX.create(a_bzrdir).
214
raise NotImplementedError(self.create_branch)
217
def create_branch_and_repo(base, force_new_repo=False):
218
"""Create a new BzrDir, Branch and Repository at the url 'base'.
220
This will use the current default BzrDirFormat, and use whatever
221
repository format that that uses via bzrdir.create_branch and
222
create_repository. If a shared repository is available that is used
225
The created Branch object is returned.
227
:param base: The URL to create the branch at.
228
:param force_new_repo: If True a new repository is always created.
230
bzrdir = BzrDir.create(base)
231
bzrdir._find_or_create_repository(force_new_repo)
232
return bzrdir.create_branch()
236
t = _mod_transport.get_transport(url)
239
def determine_repository_policy(self, force_new_repo=False, stack_on=None,
240
stack_on_pwd=None, require_stacking=False):
241
"""Return an object representing a policy to use.
243
This controls whether a new repository is created, and the format of
244
that repository, or some existing shared repository used instead.
246
If stack_on is supplied, will not seek a containing shared repo.
248
:param force_new_repo: If True, require a new repository to be created.
249
:param stack_on: If supplied, the location to stack on. If not
250
supplied, a default_stack_on location may be used.
251
:param stack_on_pwd: If stack_on is relative, the location it is
254
def repository_policy(found_bzrdir):
257
config = found_bzrdir.get_config()
259
stack_on = config.get_default_stack_on()
260
if stack_on is not None:
261
stack_on_pwd = found_bzrdir.user_url
263
# does it have a repository ?
265
repository = found_bzrdir.open_repository()
266
except errors.NoRepositoryPresent:
269
if (found_bzrdir.user_url != self.user_url
270
and not repository.is_shared()):
271
# Don't look higher, can't use a higher shared repo.
279
return UseExistingRepository(repository, stack_on,
280
stack_on_pwd, require_stacking=require_stacking), True
282
return CreateRepository(self, stack_on, stack_on_pwd,
283
require_stacking=require_stacking), True
285
if not force_new_repo:
287
policy = self._find_containing(repository_policy)
288
if policy is not None:
292
return UseExistingRepository(self.open_repository(),
293
stack_on, stack_on_pwd,
294
require_stacking=require_stacking)
295
except errors.NoRepositoryPresent:
297
return CreateRepository(self, stack_on, stack_on_pwd,
298
require_stacking=require_stacking)
234
300
def _find_or_create_repository(self, force_new_repo):
235
301
"""Create a new repository if needed, returning the repository."""
237
return self.create_repository()
239
return self.find_repository()
240
except errors.NoRepositoryPresent:
241
return self.create_repository()
302
policy = self.determine_repository_policy(force_new_repo)
303
return policy.acquire_repository()[0]
305
def _find_source_repo(self, add_cleanup, source_branch):
306
"""Find the source branch and repo for a sprout operation.
244
def create_branch_convenience(base, force_new_repo=False,
245
force_new_tree=None, format=None):
246
"""Create a new BzrDir, Branch and Repository at the url 'base'.
248
This is a convenience function - it will use an existing repository
249
if possible, can be told explicitly whether to create a working tree or
252
This will use the current default BzrDirFormat, and use whatever
253
repository format that that uses via bzrdir.create_branch and
254
create_repository. If a shared repository is available that is used
255
preferentially. Whatever repository is used, its tree creation policy
258
The created Branch object is returned.
259
If a working tree cannot be made due to base not being a file:// url,
260
no error is raised unless force_new_tree is True, in which case no
261
data is created on disk and NotLocalUrl is raised.
263
:param base: The URL to create the branch at.
264
:param force_new_repo: If True a new repository is always created.
265
:param force_new_tree: If True or False force creation of a tree or
266
prevent such creation respectively.
267
:param format: Override for the for the bzrdir format to create
270
# check for non local urls
271
t = get_transport(safe_unicode(base))
272
if not isinstance(t, LocalTransport):
273
raise errors.NotLocalUrl(base)
275
bzrdir = BzrDir.create(base)
277
bzrdir = format.initialize(base)
278
repo = bzrdir._find_or_create_repository(force_new_repo)
279
result = bzrdir.create_branch()
280
if force_new_tree or (repo.make_working_trees() and
281
force_new_tree is None):
283
bzrdir.create_workingtree()
284
except errors.NotLocalUrl:
308
This is helper intended for use by _sprout.
310
:returns: (source_branch, source_repository). Either or both may be
311
None. If not None, they will be read-locked (and their unlock(s)
312
scheduled via the add_cleanup param).
314
if source_branch is not None:
315
add_cleanup(source_branch.lock_read().unlock)
316
return source_branch, source_branch.repository
318
source_branch = self.open_branch()
319
source_repository = source_branch.repository
320
except errors.NotBranchError:
323
source_repository = self.open_repository()
324
except errors.NoRepositoryPresent:
325
source_repository = None
327
add_cleanup(source_repository.lock_read().unlock)
329
add_cleanup(source_branch.lock_read().unlock)
330
return source_branch, source_repository
332
def sprout(self, url, revision_id=None, force_new_repo=False,
333
recurse='down', possible_transports=None,
334
accelerator_tree=None, hardlink=False, stacked=False,
335
source_branch=None, create_tree_if_local=True):
336
"""Create a copy of this controldir prepared for use as a new line of
339
If url's last component does not exist, it will be created.
341
Attributes related to the identity of the source branch like
342
branch nickname will be cleaned, a working tree is created
343
whether one existed before or not; and a local branch is always
346
if revision_id is not None, then the clone operation may tune
347
itself to download less data.
349
:param accelerator_tree: A tree which can be used for retrieving file
350
contents more quickly than the revision tree, i.e. a workingtree.
351
The revision tree will be used for cases where accelerator_tree's
352
content is different.
353
:param hardlink: If true, hard-link files from accelerator_tree,
355
:param stacked: If true, create a stacked branch referring to the
356
location of this control directory.
357
:param create_tree_if_local: If true, a working-tree will be created
358
when working locally.
359
:return: The created control directory
361
operation = cleanup.OperationWithCleanups(self._sprout)
362
return operation.run(url, revision_id=revision_id,
363
force_new_repo=force_new_repo, recurse=recurse,
364
possible_transports=possible_transports,
365
accelerator_tree=accelerator_tree, hardlink=hardlink,
366
stacked=stacked, source_branch=source_branch,
367
create_tree_if_local=create_tree_if_local)
369
def _sprout(self, op, url, revision_id=None, force_new_repo=False,
370
recurse='down', possible_transports=None,
371
accelerator_tree=None, hardlink=False, stacked=False,
372
source_branch=None, create_tree_if_local=True):
373
add_cleanup = op.add_cleanup
374
fetch_spec_factory = fetch.FetchSpecFactory()
375
if revision_id is not None:
376
fetch_spec_factory.add_revision_ids([revision_id])
377
fetch_spec_factory.source_branch_stop_revision_id = revision_id
378
if possible_transports is None:
379
possible_transports = []
381
possible_transports = list(possible_transports) + [
383
target_transport = _mod_transport.get_transport(url,
385
target_transport.ensure_base()
386
cloning_format = self.cloning_metadir(stacked)
387
# Create/update the result branch
389
result = controldir.ControlDir.open_from_transport(target_transport)
390
except errors.NotBranchError:
391
result = cloning_format.initialize_on_transport(target_transport)
392
source_branch, source_repository = self._find_source_repo(
393
add_cleanup, source_branch)
394
fetch_spec_factory.source_branch = source_branch
395
# if a stacked branch wasn't requested, we don't create one
396
# even if the origin was stacked
397
if stacked and source_branch is not None:
398
stacked_branch_url = self.root_transport.base
400
stacked_branch_url = None
401
repository_policy = result.determine_repository_policy(
402
force_new_repo, stacked_branch_url, require_stacking=stacked)
403
result_repo, is_new_repo = repository_policy.acquire_repository(
404
possible_transports=possible_transports)
405
add_cleanup(result_repo.lock_write().unlock)
406
fetch_spec_factory.source_repo = source_repository
407
fetch_spec_factory.target_repo = result_repo
408
if stacked or (len(result_repo._fallback_repositories) != 0):
409
target_repo_kind = fetch.TargetRepoKinds.STACKED
411
target_repo_kind = fetch.TargetRepoKinds.EMPTY
413
target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
414
fetch_spec_factory.target_repo_kind = target_repo_kind
415
if source_repository is not None:
416
fetch_spec = fetch_spec_factory.make_fetch_spec()
417
result_repo.fetch(source_repository, fetch_spec=fetch_spec)
419
if source_branch is None:
420
# this is for sprouting a controldir without a branch; is that
422
# Not especially, but it's part of the contract.
423
result_branch = result.create_branch()
425
result_branch = source_branch.sprout(result,
426
revision_id=revision_id, repository_policy=repository_policy,
427
repository=result_repo)
428
mutter("created new branch %r" % (result_branch,))
430
# Create/update the result working tree
431
if (create_tree_if_local and not result.has_workingtree() and
432
isinstance(target_transport, local.LocalTransport) and
433
(result_repo is None or result_repo.make_working_trees())):
434
wt = result.create_workingtree(accelerator_tree=accelerator_tree,
435
hardlink=hardlink, from_branch=result_branch)
438
if wt.path2id('') is None:
440
wt.set_root_id(self.open_workingtree.get_root_id())
441
except errors.NoWorkingTree:
447
if recurse == 'down':
450
basis = wt.basis_tree()
451
elif result_branch is not None:
452
basis = result_branch.basis_tree()
453
elif source_branch is not None:
454
basis = source_branch.basis_tree()
455
if basis is not None:
456
add_cleanup(basis.lock_read().unlock)
457
subtrees = basis.iter_references()
460
for path, file_id in subtrees:
461
target = urlutils.join(url, urlutils.escape(path))
462
sublocation = source_branch.reference_parent(file_id, path)
463
sublocation.bzrdir.sprout(target,
464
basis.get_reference_revision(file_id, path),
465
force_new_repo=force_new_repo, recurse=recurse,
289
def create_repository(base, shared=False):
290
"""Create a new BzrDir and Repository at the url 'base'.
292
This will use the current default BzrDirFormat, and use whatever
293
repository format that that uses for bzrdirformat.create_repository.
295
;param shared: Create a shared repository rather than a standalone
297
The Repository object is returned.
299
This must be overridden as an instance method in child classes, where
300
it should take no parameters and construct whatever repository format
301
that child class desires.
303
bzrdir = BzrDir.create(base)
304
return bzrdir.create_repository(shared)
307
def create_standalone_workingtree(base):
308
"""Create a new BzrDir, WorkingTree, Branch and Repository at 'base'.
310
'base' must be a local path or a file:// url.
312
This will use the current default BzrDirFormat, and use whatever
313
repository format that that uses for bzrdirformat.create_workingtree,
314
create_branch and create_repository.
316
The WorkingTree object is returned.
318
t = get_transport(safe_unicode(base))
319
if not isinstance(t, LocalTransport):
320
raise errors.NotLocalUrl(base)
321
bzrdir = BzrDir.create_branch_and_repo(safe_unicode(base),
322
force_new_repo=True).bzrdir
323
return bzrdir.create_workingtree()
325
def create_workingtree(self, revision_id=None):
326
"""Create a working tree at this BzrDir.
328
revision_id: create it as of this revision id.
330
raise NotImplementedError(self.create_workingtree)
469
def _available_backup_name(self, base):
470
"""Find a non-existing backup file name based on base.
472
See bzrlib.osutils.available_backup_name about race conditions.
474
return osutils.available_backup_name(base, self.root_transport.has)
476
def backup_bzrdir(self):
477
"""Backup this bzr control directory.
479
:return: Tuple with old path name and new path name
482
pb = ui.ui_factory.nested_progress_bar()
484
old_path = self.root_transport.abspath('.bzr')
485
backup_dir = self._available_backup_name('backup.bzr')
486
new_path = self.root_transport.abspath(backup_dir)
487
ui.ui_factory.note(gettext('making backup of {0}\n to {1}').format(
488
urlutils.unescape_for_display(old_path, 'utf-8'),
489
urlutils.unescape_for_display(new_path, 'utf-8')))
490
self.root_transport.copy_tree('.bzr', backup_dir)
491
return (old_path, new_path)
495
def retire_bzrdir(self, limit=10000):
496
"""Permanently disable the bzrdir.
498
This is done by renaming it to give the user some ability to recover
499
if there was a problem.
501
This will have horrible consequences if anyone has anything locked or
503
:param limit: number of times to retry
508
to_path = '.bzr.retired.%d' % i
509
self.root_transport.rename('.bzr', to_path)
510
note(gettext("renamed {0} to {1}").format(
511
self.root_transport.abspath('.bzr'), to_path))
513
except (errors.TransportError, IOError, errors.PathError):
520
def _find_containing(self, evaluate):
521
"""Find something in a containing control directory.
523
This method will scan containing control dirs, until it finds what
524
it is looking for, decides that it will never find it, or runs out
525
of containing control directories to check.
527
It is used to implement find_repository and
528
determine_repository_policy.
530
:param evaluate: A function returning (value, stop). If stop is True,
531
the value will be returned.
535
result, stop = evaluate(found_bzrdir)
538
next_transport = found_bzrdir.root_transport.clone('..')
539
if (found_bzrdir.user_url == next_transport.base):
540
# top of the file system
542
# find the next containing bzrdir
544
found_bzrdir = self.open_containing_from_transport(
546
except errors.NotBranchError:
332
549
def find_repository(self):
333
"""Find the repository that should be used for a_bzrdir.
550
"""Find the repository that should be used.
335
552
This does not require a branch as we use it to find the repo for
336
553
new branches as well as to hook existing branches up to their
340
return self.open_repository()
341
except errors.NoRepositoryPresent:
343
next_transport = self.root_transport.clone('..')
345
# find the next containing bzrdir
347
found_bzrdir = BzrDir.open_containing_from_transport(
349
except errors.NotBranchError:
351
raise errors.NoRepositoryPresent(self)
556
def usable_repository(found_bzrdir):
352
557
# does it have a repository ?
354
559
repository = found_bzrdir.open_repository()
355
560
except errors.NoRepositoryPresent:
356
next_transport = found_bzrdir.root_transport.clone('..')
357
if (found_bzrdir.root_transport.base == next_transport.base):
358
# top of the file system
362
if ((found_bzrdir.root_transport.base ==
363
self.root_transport.base) or repository.is_shared()):
366
raise errors.NoRepositoryPresent(self)
367
raise errors.NoRepositoryPresent(self)
369
def get_branch_transport(self, branch_format):
370
"""Get the transport for use by branch format in this BzrDir.
372
Note that bzr dirs that do not support format strings will raise
373
IncompatibleFormat if the branch format they are given has
374
a format string, and vice versa.
376
If branch_format is None, the transport is returned with no
377
checking. if it is not None, then the returned transport is
378
guaranteed to point to an existing directory ready for use.
380
raise NotImplementedError(self.get_branch_transport)
382
def get_repository_transport(self, repository_format):
383
"""Get the transport for use by repository format in this BzrDir.
385
Note that bzr dirs that do not support format strings will raise
386
IncompatibleFormat if the repository format they are given has
387
a format string, and vice versa.
389
If repository_format is None, the transport is returned with no
390
checking. if it is not None, then the returned transport is
391
guaranteed to point to an existing directory ready for use.
393
raise NotImplementedError(self.get_repository_transport)
395
def get_workingtree_transport(self, tree_format):
396
"""Get the transport for use by workingtree format in this BzrDir.
398
Note that bzr dirs that do not support format strings will raise
399
IncompatibleFormat if the workingtree format they are given has
400
a format string, and vice versa.
402
If workingtree_format is None, the transport is returned with no
403
checking. if it is not None, then the returned transport is
404
guaranteed to point to an existing directory ready for use.
406
raise NotImplementedError(self.get_workingtree_transport)
562
if found_bzrdir.user_url == self.user_url:
563
return repository, True
564
elif repository.is_shared():
565
return repository, True
569
found_repo = self._find_containing(usable_repository)
570
if found_repo is None:
571
raise errors.NoRepositoryPresent(self)
574
def _find_creation_modes(self):
575
"""Determine the appropriate modes for files and directories.
577
They're always set to be consistent with the base directory,
578
assuming that this transport allows setting modes.
580
# TODO: Do we need or want an option (maybe a config setting) to turn
581
# this off or override it for particular locations? -- mbp 20080512
582
if self._mode_check_done:
584
self._mode_check_done = True
586
st = self.transport.stat('.')
587
except errors.TransportNotPossible:
588
self._dir_mode = None
589
self._file_mode = None
591
# Check the directory mode, but also make sure the created
592
# directories and files are read-write for this user. This is
593
# mostly a workaround for filesystems which lie about being able to
594
# write to a directory (cygwin & win32)
595
if (st.st_mode & 07777 == 00000):
596
# FTP allows stat but does not return dir/file modes
597
self._dir_mode = None
598
self._file_mode = None
600
self._dir_mode = (st.st_mode & 07777) | 00700
601
# Remove the sticky and execute bits for files
602
self._file_mode = self._dir_mode & ~07111
604
def _get_file_mode(self):
605
"""Return Unix mode for newly created files, or None.
607
if not self._mode_check_done:
608
self._find_creation_modes()
609
return self._file_mode
611
def _get_dir_mode(self):
612
"""Return Unix mode for newly created directories, or None.
614
if not self._mode_check_done:
615
self._find_creation_modes()
616
return self._dir_mode
618
def get_config(self):
619
"""Get configuration for this BzrDir."""
620
return config.BzrDirConfig(self)
622
def _get_config(self):
623
"""By default, no configuration is available."""
408
626
def __init__(self, _transport, _format):
409
627
"""Initialize a Bzr control dir object.
411
629
Only really common logic should reside here, concrete classes should be
412
630
made with varying behaviours.
415
633
:param _transport: the transport this dir is based at.
417
635
self._format = _format
636
# these are also under the more standard names of
637
# control_transport and user_transport
418
638
self.transport = _transport.clone('.bzr')
419
639
self.root_transport = _transport
640
self._mode_check_done = False
643
def user_transport(self):
644
return self.root_transport
647
def control_transport(self):
648
return self.transport
421
650
def is_control_filename(self, filename):
422
651
"""True if filename is the name of a path which is reserved for bzrdir's.
424
653
:param filename: A filename within the root transport of this bzrdir.
426
655
This is true IF and ONLY IF the filename is part of the namespace reserved
427
656
for bzr control dirs. Currently this is the '.bzr' directory in the root
428
of the root_transport. it is expected that plugins will need to extend
429
this in the future - for instance to make bzr talk with svn working
657
of the root_transport.
432
# this might be better on the BzrDirFormat class because it refers to
433
# all the possible bzrdir disk formats.
434
# This method is tested via the workingtree is_control_filename tests-
435
# it was extracted from WorkingTree.is_control_filename. If the methods
436
# contract is extended beyond the current trivial implementation please
659
# this might be better on the BzrDirFormat class because it refers to
660
# all the possible bzrdir disk formats.
661
# This method is tested via the workingtree is_control_filename tests-
662
# it was extracted from WorkingTree.is_control_filename. If the method's
663
# contract is extended beyond the current trivial implementation, please
437
664
# add new tests for it to the appropriate place.
438
665
return filename == '.bzr' or filename.startswith('.bzr/')
440
def needs_format_conversion(self, format=None):
441
"""Return true if this bzrdir needs convert_format run on it.
443
For instance, if the repository format is out of date but the
444
branch and working tree are not, this should return True.
446
:param format: Optional parameter indicating a specific desired
447
format we plan to arrive at.
449
raise NotImplementedError(self.needs_format_conversion)
452
def open_unsupported(base):
453
"""Open a branch which is not supported."""
454
return BzrDir.open(base, _unsupported=True)
457
def open(base, _unsupported=False):
458
"""Open an existing bzrdir, rooted at 'base' (url)
460
_unsupported is a private parameter to the BzrDir class.
462
t = get_transport(base)
463
mutter("trying to open %r with transport %r", base, t)
464
format = BzrDirFormat.find_format(t)
465
BzrDir._check_supported(format, _unsupported)
466
return format.open(t, _found=True)
468
def open_branch(self, unsupported=False):
469
"""Open the branch object at this BzrDir if one is present.
471
If unsupported is True, then no longer supported branch formats can
474
TODO: static convenience version of this?
476
raise NotImplementedError(self.open_branch)
479
def open_containing(url):
480
"""Open an existing branch which contains url.
482
:param url: url to search from.
483
See open_containing_from_transport for more detail.
485
return BzrDir.open_containing_from_transport(get_transport(url))
488
def open_containing_from_transport(a_transport):
489
"""Open an existing branch which contains a_transport.base
491
This probes for a branch at a_transport, and searches upwards from there.
493
Basically we keep looking up until we find the control directory or
494
run into the root. If there isn't one, raises NotBranchError.
495
If there is one and it is either an unrecognised format or an unsupported
496
format, UnknownFormatError or UnsupportedFormatError are raised.
497
If there is one, it is returned, along with the unused portion of url.
499
:return: The BzrDir that contains the path, and a Unicode path
500
for the rest of the URL.
502
# this gets the normalised url back. I.e. '.' -> the full path.
503
url = a_transport.base
506
format = BzrDirFormat.find_format(a_transport)
507
BzrDir._check_supported(format, False)
508
return format.open(a_transport), urlutils.unescape(a_transport.relpath(url))
509
except errors.NotBranchError, e:
510
## mutter('not a branch in: %r %s', a_transport.base, e)
512
new_t = a_transport.clone('..')
513
if new_t.base == a_transport.base:
514
# reached the root, whatever that may be
515
raise errors.NotBranchError(path=url)
518
def open_repository(self, _unsupported=False):
519
"""Open the repository object at this BzrDir if one is present.
521
This will not follow the Branch object pointer - its strictly a direct
522
open facility. Most client code should use open_branch().repository to
525
_unsupported is a private parameter, not part of the api.
526
TODO: static convenience version of this?
528
raise NotImplementedError(self.open_repository)
530
def open_workingtree(self, _unsupported=False):
531
"""Open the workingtree object at this BzrDir if one is present.
533
TODO: static convenience version of this?
535
raise NotImplementedError(self.open_workingtree)
537
def has_branch(self):
538
"""Tell if this bzrdir contains a branch.
540
Note: if you're going to open the branch, you should just go ahead
541
and try, and not ask permission first. (This method just opens the
542
branch and discards it, and that's somewhat expensive.)
547
except errors.NotBranchError:
550
def has_workingtree(self):
551
"""Tell if this bzrdir contains a working tree.
553
This will still raise an exception if the bzrdir has a workingtree that
554
is remote & inaccessible.
556
Note: if you're going to open the working tree, you should just go ahead
557
and try, and not ask permission first. (This method just opens the
558
workingtree and discards it, and that's somewhat expensive.)
561
self.open_workingtree()
563
except errors.NoWorkingTree:
566
def sprout(self, url, revision_id=None, basis=None, force_new_repo=False):
567
"""Create a copy of this bzrdir prepared for use as a new line of
570
If urls last component does not exist, it will be created.
572
Attributes related to the identity of the source branch like
573
branch nickname will be cleaned, a working tree is created
574
whether one existed before or not; and a local branch is always
577
if revision_id is not None, then the clone operation may tune
578
itself to download less data.
581
result = self._format.initialize(url)
582
basis_repo, basis_branch, basis_tree = self._get_basis_components(basis)
584
source_branch = self.open_branch()
585
source_repository = source_branch.repository
586
except errors.NotBranchError:
667
def _cloning_metadir(self):
668
"""Produce a metadir suitable for cloning with.
670
:returns: (destination_bzrdir_format, source_repository)
672
result_format = self._format.__class__()
675
branch = self.open_branch(ignore_fallbacks=True)
676
source_repository = branch.repository
677
result_format._branch_format = branch._format
678
except errors.NotBranchError:
589
680
source_repository = self.open_repository()
590
except errors.NoRepositoryPresent:
591
# copy the entire basis one if there is one
592
# but there is no repository.
593
source_repository = basis_repo
598
result_repo = result.find_repository()
599
except errors.NoRepositoryPresent:
601
if source_repository is None and result_repo is not None:
603
elif source_repository is None and result_repo is None:
604
# no repo available, make a new one
605
result.create_repository()
606
elif source_repository is not None and result_repo is None:
607
# have source, and want to make a new target repo
608
# we don't clone the repo because that preserves attributes
609
# like is_shared(), and we have not yet implemented a
610
# repository sprout().
611
result_repo = result.create_repository()
612
if result_repo is not None:
613
# fetch needed content into target.
615
# XXX FIXME RBC 20060214 need tests for this when the basis
617
result_repo.fetch(basis_repo, revision_id=revision_id)
618
result_repo.fetch(source_repository, revision_id=revision_id)
619
if source_branch is not None:
620
source_branch.sprout(result, revision_id=revision_id)
622
result.create_branch()
623
# TODO: jam 20060426 we probably need a test in here in the
624
# case that the newly sprouted branch is a remote one
625
if result_repo is None or result_repo.make_working_trees():
626
result.create_workingtree()
630
class BzrDirPreSplitOut(BzrDir):
631
"""A common class for the all-in-one formats."""
633
def __init__(self, _transport, _format):
634
"""See BzrDir.__init__."""
635
super(BzrDirPreSplitOut, self).__init__(_transport, _format)
636
assert self._format._lock_class == TransportLock
637
assert self._format._lock_file_name == 'branch-lock'
638
self._control_files = LockableFiles(self.get_branch_transport(None),
639
self._format._lock_file_name,
640
self._format._lock_class)
642
def break_lock(self):
643
"""Pre-splitout bzrdirs do not suffer from stale locks."""
644
raise NotImplementedError(self.break_lock)
646
def clone(self, url, revision_id=None, basis=None, force_new_repo=False):
647
"""See BzrDir.clone()."""
648
from bzrlib.workingtree import WorkingTreeFormat2
650
result = self._format._initialize_for_clone(url)
651
basis_repo, basis_branch, basis_tree = self._get_basis_components(basis)
652
self.open_repository().clone(result, revision_id=revision_id, basis=basis_repo)
653
from_branch = self.open_branch()
654
from_branch.clone(result, revision_id=revision_id)
656
self.open_workingtree().clone(result, basis=basis_tree)
657
except errors.NotLocalUrl:
658
# make a new one, this format always has to have one.
660
WorkingTreeFormat2().initialize(result)
661
except errors.NotLocalUrl:
662
# but we cannot do it for remote trees.
663
to_branch = result.open_branch()
664
WorkingTreeFormat2().stub_initialize_remote(to_branch.control_files)
667
def create_branch(self):
668
"""See BzrDir.create_branch."""
669
return self.open_branch()
671
def create_repository(self, shared=False):
672
"""See BzrDir.create_repository."""
674
raise errors.IncompatibleFormat('shared repository', self._format)
675
return self.open_repository()
677
def create_workingtree(self, revision_id=None):
678
"""See BzrDir.create_workingtree."""
679
# this looks buggy but is not -really-
680
# clone and sprout will have set the revision_id
681
# and that will have set it for us, its only
682
# specific uses of create_workingtree in isolation
683
# that can do wonky stuff here, and that only
684
# happens for creating checkouts, which cannot be
685
# done on this format anyway. So - acceptable wart.
686
result = self.open_workingtree()
687
if revision_id is not None:
688
result.set_last_revision(revision_id)
691
def get_branch_transport(self, branch_format):
692
"""See BzrDir.get_branch_transport()."""
693
if branch_format is None:
694
return self.transport
696
branch_format.get_format_string()
697
except NotImplementedError:
698
return self.transport
699
raise errors.IncompatibleFormat(branch_format, self._format)
681
except errors.NoRepositoryPresent:
682
source_repository = None
684
# XXX TODO: This isinstance is here because we have not implemented
685
# the fix recommended in bug # 103195 - to delegate this choice the
687
repo_format = source_repository._format
688
if isinstance(repo_format, remote.RemoteRepositoryFormat):
689
source_repository._ensure_real()
690
repo_format = source_repository._real_repository._format
691
result_format.repository_format = repo_format
693
# TODO: Couldn't we just probe for the format in these cases,
694
# rather than opening the whole tree? It would be a little
695
# faster. mbp 20070401
696
tree = self.open_workingtree(recommend_upgrade=False)
697
except (errors.NoWorkingTree, errors.NotLocalUrl):
698
result_format.workingtree_format = None
700
result_format.workingtree_format = tree._format.__class__()
701
return result_format, source_repository
703
def cloning_metadir(self, require_stacking=False):
704
"""Produce a metadir suitable for cloning or sprouting with.
706
These operations may produce workingtrees (yes, even though they're
707
"cloning" something that doesn't have a tree), so a viable workingtree
708
format must be selected.
710
:require_stacking: If True, non-stackable formats will be upgraded
711
to similar stackable formats.
712
:returns: a ControlDirFormat with all component formats either set
713
appropriately or set to None if that component should not be
716
format, repository = self._cloning_metadir()
717
if format._workingtree_format is None:
719
if repository is None:
720
# No repository either
722
# We have a repository, so set a working tree? (Why? This seems to
723
# contradict the stated return value in the docstring).
724
tree_format = repository._format._matchingbzrdir.workingtree_format
725
format.workingtree_format = tree_format.__class__()
727
format.require_stacking()
730
def get_branch_transport(self, branch_format, name=None):
731
"""Get the transport for use by branch format in this BzrDir.
733
Note that bzr dirs that do not support format strings will raise
734
IncompatibleFormat if the branch format they are given has
735
a format string, and vice versa.
737
If branch_format is None, the transport is returned with no
738
checking. If it is not None, then the returned transport is
739
guaranteed to point to an existing directory ready for use.
741
raise NotImplementedError(self.get_branch_transport)
701
743
def get_repository_transport(self, repository_format):
702
"""See BzrDir.get_repository_transport()."""
703
if repository_format is None:
704
return self.transport
706
repository_format.get_format_string()
707
except NotImplementedError:
708
return self.transport
709
raise errors.IncompatibleFormat(repository_format, self._format)
711
def get_workingtree_transport(self, workingtree_format):
712
"""See BzrDir.get_workingtree_transport()."""
713
if workingtree_format is None:
714
return self.transport
716
workingtree_format.get_format_string()
717
except NotImplementedError:
718
return self.transport
719
raise errors.IncompatibleFormat(workingtree_format, self._format)
721
def needs_format_conversion(self, format=None):
722
"""See BzrDir.needs_format_conversion()."""
723
# if the format is not the same as the system default,
724
# an upgrade is needed.
726
format = BzrDirFormat.get_default_format()
727
return not isinstance(self._format, format.__class__)
729
def open_branch(self, unsupported=False):
730
"""See BzrDir.open_branch."""
731
from bzrlib.branch import BzrBranchFormat4
732
format = BzrBranchFormat4()
733
self._check_supported(format, unsupported)
734
return format.open(self, _found=True)
736
def sprout(self, url, revision_id=None, basis=None):
737
"""See BzrDir.sprout()."""
738
from bzrlib.workingtree import WorkingTreeFormat2
740
result = self._format._initialize_for_clone(url)
741
basis_repo, basis_branch, basis_tree = self._get_basis_components(basis)
743
self.open_repository().clone(result, revision_id=revision_id, basis=basis_repo)
744
except errors.NoRepositoryPresent:
747
self.open_branch().sprout(result, revision_id=revision_id)
748
except errors.NotBranchError:
750
# we always want a working tree
751
WorkingTreeFormat2().initialize(result)
755
class BzrDir4(BzrDirPreSplitOut):
756
"""A .bzr version 4 control object.
758
This is a deprecated format and may be removed after sept 2006.
761
def create_repository(self, shared=False):
762
"""See BzrDir.create_repository."""
763
return self._format.repository_format.initialize(self, shared)
765
def needs_format_conversion(self, format=None):
766
"""Format 4 dirs are always in need of conversion."""
769
def open_repository(self):
770
"""See BzrDir.open_repository."""
771
from bzrlib.repository import RepositoryFormat4
772
return RepositoryFormat4().open(self, _found=True)
775
class BzrDir5(BzrDirPreSplitOut):
776
"""A .bzr version 5 control object.
778
This is a deprecated format and may be removed after sept 2006.
781
def open_repository(self):
782
"""See BzrDir.open_repository."""
783
from bzrlib.repository import RepositoryFormat5
784
return RepositoryFormat5().open(self, _found=True)
786
def open_workingtree(self, _unsupported=False):
787
"""See BzrDir.create_workingtree."""
788
from bzrlib.workingtree import WorkingTreeFormat2
789
return WorkingTreeFormat2().open(self, _found=True)
792
class BzrDir6(BzrDirPreSplitOut):
793
"""A .bzr version 6 control object.
795
This is a deprecated format and may be removed after sept 2006.
798
def open_repository(self):
799
"""See BzrDir.open_repository."""
800
from bzrlib.repository import RepositoryFormat6
801
return RepositoryFormat6().open(self, _found=True)
803
def open_workingtree(self, _unsupported=False):
804
"""See BzrDir.create_workingtree."""
805
from bzrlib.workingtree import WorkingTreeFormat2
806
return WorkingTreeFormat2().open(self, _found=True)
744
"""Get the transport for use by repository format in this BzrDir.
746
Note that bzr dirs that do not support format strings will raise
747
IncompatibleFormat if the repository format they are given has
748
a format string, and vice versa.
750
If repository_format is None, the transport is returned with no
751
checking. If it is not None, then the returned transport is
752
guaranteed to point to an existing directory ready for use.
754
raise NotImplementedError(self.get_repository_transport)
756
def get_workingtree_transport(self, tree_format):
757
"""Get the transport for use by workingtree format in this BzrDir.
759
Note that bzr dirs that do not support format strings will raise
760
IncompatibleFormat if the workingtree format they are given has a
761
format string, and vice versa.
763
If workingtree_format is None, the transport is returned with no
764
checking. If it is not None, then the returned transport is
765
guaranteed to point to an existing directory ready for use.
767
raise NotImplementedError(self.get_workingtree_transport)
770
def create(cls, base, format=None, possible_transports=None):
771
"""Create a new BzrDir at the url 'base'.
773
:param format: If supplied, the format of branch to create. If not
774
supplied, the default is used.
775
:param possible_transports: If supplied, a list of transports that
776
can be reused to share a remote connection.
778
if cls is not BzrDir:
779
raise AssertionError("BzrDir.create always creates the "
780
"default format, not one of %r" % cls)
781
return controldir.ControlDir.create(base, format=format,
782
possible_transports=possible_transports)
785
return "<%s at %r>" % (self.__class__.__name__, self.user_url)
787
def update_feature_flags(self, updated_flags):
788
"""Update the features required by this bzrdir.
790
:param updated_flags: Dictionary mapping feature names to necessities
791
A necessity can be None to indicate the feature should be removed
793
self.control_files.lock_write()
795
self._format._update_feature_flags(updated_flags)
796
self.transport.put_bytes('branch-format', self._format.as_string())
798
self.control_files.unlock()
809
801
class BzrDirMeta1(BzrDir):
810
802
"""A .bzr meta version 1 control object.
812
This is the first control object where the
804
This is the first control object where the
813
805
individual aspects are really split out: there are separate repository,
814
806
workingtree and branch subdirectories and any subset of the three can be
815
807
present within a BzrDir.
810
def _get_branch_path(self, name):
811
"""Obtain the branch path to use.
813
This uses the API specified branch name first, and then falls back to
814
the branch name specified in the URL. If neither of those is specified,
815
it uses the default branch.
817
:param name: Optional branch name to use
818
:return: Relative path to branch
822
return urlutils.join('branches', name.encode("utf-8"))
824
def _read_branch_list(self):
825
"""Read the branch list.
827
:return: List of utf-8 encoded branch names.
830
f = self.control_transport.get('branch-list')
831
except errors.NoSuchFile:
837
ret.append(name.rstrip("\n"))
842
def _write_branch_list(self, branches):
843
"""Write out the branch list.
845
:param branches: List of utf-8 branch names to write
847
self.transport.put_bytes('branch-list',
848
"".join([name+"\n" for name in branches]))
850
def __init__(self, _transport, _format):
851
super(BzrDirMeta1, self).__init__(_transport, _format)
852
self.control_files = lockable_files.LockableFiles(
853
self.control_transport, self._format._lock_file_name,
854
self._format._lock_class)
818
856
def can_convert_format(self):
819
857
"""See BzrDir.can_convert_format()."""
822
def create_branch(self):
823
"""See BzrDir.create_branch."""
824
from bzrlib.branch import BranchFormat
825
return BranchFormat.get_default_format().initialize(self)
860
def create_branch(self, name=None, repository=None,
861
append_revisions_only=None):
862
"""See ControlDir.create_branch."""
864
name = self._get_selected_branch()
865
return self._format.get_branch_format().initialize(self, name=name,
866
repository=repository,
867
append_revisions_only=append_revisions_only)
869
def destroy_branch(self, name=None):
870
"""See ControlDir.destroy_branch."""
872
name = self._get_selected_branch()
873
path = self._get_branch_path(name)
875
self.control_files.lock_write()
877
branches = self._read_branch_list()
879
branches.remove(name.encode("utf-8"))
881
raise errors.NotBranchError(name)
882
self._write_branch_list(branches)
884
self.control_files.unlock()
886
self.transport.delete_tree(path)
887
except errors.NoSuchFile:
888
raise errors.NotBranchError(path=urlutils.join(self.transport.base,
827
891
def create_repository(self, shared=False):
828
892
"""See BzrDir.create_repository."""
829
893
return self._format.repository_format.initialize(self, shared)
831
def create_workingtree(self, revision_id=None):
895
def destroy_repository(self):
896
"""See BzrDir.destroy_repository."""
898
self.transport.delete_tree('repository')
899
except errors.NoSuchFile:
900
raise errors.NoRepositoryPresent(self)
902
def create_workingtree(self, revision_id=None, from_branch=None,
903
accelerator_tree=None, hardlink=False):
832
904
"""See BzrDir.create_workingtree."""
833
from bzrlib.workingtree import WorkingTreeFormat
834
return WorkingTreeFormat.get_default_format().initialize(self, revision_id)
905
return self._format.workingtree_format.initialize(
906
self, revision_id, from_branch=from_branch,
907
accelerator_tree=accelerator_tree, hardlink=hardlink)
909
def destroy_workingtree(self):
910
"""See BzrDir.destroy_workingtree."""
911
wt = self.open_workingtree(recommend_upgrade=False)
912
repository = wt.branch.repository
913
empty = repository.revision_tree(_mod_revision.NULL_REVISION)
914
# We ignore the conflicts returned by wt.revert since we're about to
915
# delete the wt metadata anyway, all that should be left here are
916
# detritus. But see bug #634470 about subtree .bzr dirs.
917
conflicts = wt.revert(old_tree=empty)
918
self.destroy_workingtree_metadata()
920
def destroy_workingtree_metadata(self):
921
self.transport.delete_tree('checkout')
923
def find_branch_format(self, name=None):
924
"""Find the branch 'format' for this bzrdir.
926
This might be a synthetic object for e.g. RemoteBranch and SVN.
928
from bzrlib.branch import BranchFormatMetadir
929
return BranchFormatMetadir.find_format(self, name=name)
836
931
def _get_mkdir_mode(self):
837
932
"""Figure out the mode to use when creating a bzrdir subdir."""
838
temp_control = LockableFiles(self.transport, '', TransportLock)
933
temp_control = lockable_files.LockableFiles(self.transport, '',
934
lockable_files.TransportLock)
839
935
return temp_control._dir_mode
841
def get_branch_transport(self, branch_format):
937
def get_branch_reference(self, name=None):
938
"""See BzrDir.get_branch_reference()."""
939
from bzrlib.branch import BranchFormatMetadir
940
format = BranchFormatMetadir.find_format(self, name=name)
941
return format.get_reference(self, name=name)
943
def set_branch_reference(self, target_branch, name=None):
944
format = _mod_branch.BranchReferenceFormat()
945
return format.initialize(self, target_branch=target_branch, name=name)
947
def get_branch_transport(self, branch_format, name=None):
842
948
"""See BzrDir.get_branch_transport()."""
950
name = self._get_selected_branch()
951
path = self._get_branch_path(name)
952
# XXX: this shouldn't implicitly create the directory if it's just
953
# promising to get a transport -- mbp 20090727
843
954
if branch_format is None:
844
return self.transport.clone('branch')
955
return self.transport.clone(path)
846
957
branch_format.get_format_string()
847
958
except NotImplementedError:
848
959
raise errors.IncompatibleFormat(branch_format, self._format)
961
branches = self._read_branch_list()
962
utf8_name = name.encode("utf-8")
963
if not utf8_name in branches:
964
self.control_files.lock_write()
966
branches = self._read_branch_list()
967
dirname = urlutils.dirname(utf8_name)
968
if dirname != "" and dirname in branches:
969
raise errors.ParentBranchExists(name)
971
b.startswith(utf8_name+"/") for b in branches]
972
if any(child_branches):
973
raise errors.AlreadyBranchError(name)
974
branches.append(utf8_name)
975
self._write_branch_list(branches)
977
self.control_files.unlock()
978
branch_transport = self.transport.clone(path)
979
mode = self._get_mkdir_mode()
980
branch_transport.create_prefix(mode=mode)
850
self.transport.mkdir('branch', mode=self._get_mkdir_mode())
982
self.transport.mkdir(path, mode=mode)
851
983
except errors.FileExists:
853
return self.transport.clone('branch')
985
return self.transport.clone(path)
855
987
def get_repository_transport(self, repository_format):
856
988
"""See BzrDir.get_repository_transport()."""
896
1053
except errors.NoRepositoryPresent:
898
# currently there are no other possible conversions for meta1 formats.
1055
for branch in self.list_branches():
1056
if not isinstance(branch._format,
1057
format.get_branch_format().__class__):
1058
# the branch needs an upgrade.
1061
my_wt = self.open_workingtree(recommend_upgrade=False)
1062
if not isinstance(my_wt._format,
1063
format.workingtree_format.__class__):
1064
# the workingtree needs an upgrade.
1066
except (errors.NoWorkingTree, errors.NotLocalUrl):
901
def open_branch(self, unsupported=False):
902
"""See BzrDir.open_branch."""
903
from bzrlib.branch import BranchFormat
904
format = BranchFormat.find_format(self)
905
self._check_supported(format, unsupported)
906
return format.open(self, _found=True)
1070
def open_branch(self, name=None, unsupported=False,
1071
ignore_fallbacks=False, possible_transports=None):
1072
"""See ControlDir.open_branch."""
1074
name = self._get_selected_branch()
1075
format = self.find_branch_format(name=name)
1076
format.check_support_status(unsupported)
1077
return format.open(self, name=name,
1078
_found=True, ignore_fallbacks=ignore_fallbacks,
1079
possible_transports=possible_transports)
908
1081
def open_repository(self, unsupported=False):
909
1082
"""See BzrDir.open_repository."""
910
from bzrlib.repository import RepositoryFormat
911
format = RepositoryFormat.find_format(self)
912
self._check_supported(format, unsupported)
1083
from bzrlib.repository import RepositoryFormatMetaDir
1084
format = RepositoryFormatMetaDir.find_format(self)
1085
format.check_support_status(unsupported)
913
1086
return format.open(self, _found=True)
915
def open_workingtree(self, unsupported=False):
1088
def open_workingtree(self, unsupported=False,
1089
recommend_upgrade=True):
916
1090
"""See BzrDir.open_workingtree."""
917
from bzrlib.workingtree import WorkingTreeFormat
918
format = WorkingTreeFormat.find_format(self)
919
self._check_supported(format, unsupported)
1091
from bzrlib.workingtree import WorkingTreeFormatMetaDir
1092
format = WorkingTreeFormatMetaDir.find_format(self)
1093
format.check_support_status(unsupported, recommend_upgrade,
1094
basedir=self.root_transport.base)
920
1095
return format.open(self, _found=True)
923
class BzrDirFormat(object):
924
"""An encapsulation of the initialization and open routines for a format.
926
Formats provide three things:
927
* An initialization routine,
931
Formats are placed in an dict by their format string for reference
1097
def _get_config(self):
1098
return config.TransportConfig(self.transport, 'control.conf')
1101
class BzrFormat(object):
1102
"""Base class for all formats of things living in metadirs.
1104
This class manages the format string that is stored in the 'format'
1105
or 'branch-format' file.
1107
All classes for (branch-, repository-, workingtree-) formats that
1108
live in meta directories and have their own 'format' file
1109
(i.e. different from .bzr/branch-format) derive from this class,
1110
as well as the relevant base class for their kind
1111
(BranchFormat, WorkingTreeFormat, RepositoryFormat).
1113
Each format is identified by a "format" or "branch-format" file with a
1114
single line containing the base format name and then an optional list of
1117
Feature flags are supported as of bzr 2.5. Setting feature flags on formats
1118
will render them inaccessible to older versions of bzr.
1120
:ivar features: Dictionary mapping feature names to their necessity
1123
_present_features = set()
1129
def register_feature(cls, name):
1130
"""Register a feature as being present.
1132
:param name: Name of the feature
1135
raise ValueError("spaces are not allowed in feature names")
1136
if name in cls._present_features:
1137
raise errors.FeatureAlreadyRegistered(name)
1138
cls._present_features.add(name)
1141
def unregister_feature(cls, name):
1142
"""Unregister a feature."""
1143
cls._present_features.remove(name)
1145
def check_support_status(self, allow_unsupported, recommend_upgrade=True,
1147
for name, necessity in self.features.iteritems():
1148
if name in self._present_features:
1150
if necessity == "optional":
1151
mutter("ignoring optional missing feature %s", name)
1153
elif necessity == "required":
1154
raise errors.MissingFeature(name)
1156
mutter("treating unknown necessity as require for %s",
1158
raise errors.MissingFeature(name)
1161
def get_format_string(cls):
1162
"""Return the ASCII format string that identifies this format."""
1163
raise NotImplementedError(cls.get_format_string)
1166
def from_string(cls, text):
1167
format_string = cls.get_format_string()
1168
if not text.startswith(format_string):
1169
raise AssertionError("Invalid format header %r for %r" % (text, cls))
1170
lines = text[len(format_string):].splitlines()
1172
for lineno, line in enumerate(lines):
1174
(necessity, feature) = line.split(" ", 1)
1176
raise errors.ParseFormatError(format=cls, lineno=lineno+2,
1177
line=line, text=text)
1178
ret.features[feature] = necessity
1181
def as_string(self):
1182
"""Return the string representation of this format.
1184
lines = [self.get_format_string()]
1185
lines.extend([("%s %s\n" % (item[1], item[0])) for item in
1186
self.features.iteritems()])
1187
return "".join(lines)
1190
def _find_format(klass, registry, kind, format_string):
1192
first_line = format_string[:format_string.index("\n")+1]
1194
first_line = format_string
1196
cls = registry.get(first_line)
1198
raise errors.UnknownFormatError(format=first_line, kind=kind)
1199
return cls.from_string(format_string)
1201
def network_name(self):
1202
"""A simple byte string uniquely identifying this format for RPC calls.
1204
Metadir branch formats use their format string.
1206
return self.as_string()
1208
def __eq__(self, other):
1209
return (self.__class__ is other.__class__ and
1210
self.features == other.features)
1212
def _update_feature_flags(self, updated_flags):
1213
"""Update the feature flags in this format.
1215
:param updated_flags: Updated feature flags
1217
for name, necessity in updated_flags.iteritems():
1218
if necessity is None:
1220
del self.features[name]
1224
self.features[name] = necessity
1227
class BzrProber(controldir.Prober):
1228
"""Prober for formats that use a .bzr/ control directory."""
1230
formats = registry.FormatRegistry(controldir.network_format_registry)
1231
"""The known .bzr formats."""
1234
def probe_transport(klass, transport):
1235
"""Return the .bzrdir style format present in a directory."""
1237
format_string = transport.get_bytes(".bzr/branch-format")
1238
except errors.NoSuchFile:
1239
raise errors.NotBranchError(path=transport.base)
1241
first_line = format_string[:format_string.index("\n")+1]
1243
first_line = format_string
1245
cls = klass.formats.get(first_line)
1247
raise errors.UnknownFormatError(format=first_line, kind='bzrdir')
1248
return cls.from_string(format_string)
1251
def known_formats(cls):
1253
for name, format in cls.formats.iteritems():
1254
if callable(format):
1260
controldir.ControlDirFormat.register_prober(BzrProber)
1263
class RemoteBzrProber(controldir.Prober):
1264
"""Prober for remote servers that provide a Bazaar smart server."""
1267
def probe_transport(klass, transport):
1268
"""Return a RemoteBzrDirFormat object if it looks possible."""
1270
medium = transport.get_smart_medium()
1271
except (NotImplementedError, AttributeError,
1272
errors.TransportNotPossible, errors.NoSmartMedium,
1273
errors.SmartProtocolError):
1274
# no smart server, so not a branch for this format type.
1275
raise errors.NotBranchError(path=transport.base)
1277
# Decline to open it if the server doesn't support our required
1278
# version (3) so that the VFS-based transport will do it.
1279
if medium.should_probe():
1281
server_version = medium.protocol_version()
1282
except errors.SmartProtocolError:
1283
# Apparently there's no usable smart server there, even though
1284
# the medium supports the smart protocol.
1285
raise errors.NotBranchError(path=transport.base)
1286
if server_version != '2':
1287
raise errors.NotBranchError(path=transport.base)
1288
from bzrlib.remote import RemoteBzrDirFormat
1289
return RemoteBzrDirFormat()
1292
def known_formats(cls):
1293
from bzrlib.remote import RemoteBzrDirFormat
1294
return set([RemoteBzrDirFormat()])
1297
class BzrDirFormat(BzrFormat, controldir.ControlDirFormat):
1298
"""ControlDirFormat base class for .bzr/ directories.
1300
Formats are placed in a dict by their format string for reference
932
1301
during bzrdir opening. These should be subclasses of BzrDirFormat
933
1302
for consistency.
935
1304
Once a format is deprecated, just deprecate the initialize and open
936
methods on the format class. Do not deprecate the object, as the
1305
methods on the format class. Do not deprecate the object, as the
937
1306
object will be created every system load.
940
_default_format = None
941
"""The default format used for new .bzr dirs."""
944
"""The known formats."""
946
_control_formats = []
947
"""The registered control formats - .bzr, ....
949
This is a list of BzrDirFormat objects.
952
1309
_lock_file_name = 'branch-lock'
954
1311
# _lock_class must be set in subclasses to the lock type, typ.
955
1312
# TransportLock or LockDir
958
def find_format(klass, transport):
959
"""Return the format present at transport."""
960
for format in klass._control_formats:
962
return format.probe_transport(transport)
963
except errors.NotBranchError:
964
# this format does not find a control dir here.
966
raise errors.NotBranchError(path=transport.base)
969
def probe_transport(klass, transport):
970
"""Return the .bzrdir style transport present at URL."""
972
format_string = transport.get(".bzr/branch-format").read()
973
except errors.NoSuchFile:
974
raise errors.NotBranchError(path=transport.base)
977
return klass._formats[format_string]
979
raise errors.UnknownFormatError(format=format_string)
982
def get_default_format(klass):
983
"""Return the current default format."""
984
return klass._default_format
986
def get_format_string(self):
987
"""Return the ASCII format string that identifies this format."""
988
raise NotImplementedError(self.get_format_string)
990
def get_format_description(self):
991
"""Return the short description for this format."""
992
raise NotImplementedError(self.get_format_description)
994
def get_converter(self, format=None):
995
"""Return the converter to use to convert bzrdirs needing converts.
997
This returns a bzrlib.bzrdir.Converter object.
999
This should return the best upgrader to step this format towards the
1000
current default format. In the case of plugins we can/should provide
1001
some means for them to extend the range of returnable converters.
1003
:param format: Optional format to override the default format of the
1006
raise NotImplementedError(self.get_converter)
1008
def initialize(self, url):
1009
"""Create a bzr control dir at this url and return an opened copy.
1011
Subclasses should typically override initialize_on_transport
1012
instead of this method.
1014
return self.initialize_on_transport(get_transport(url))
1016
1314
def initialize_on_transport(self, transport):
1017
1315
"""Initialize a new bzrdir in the base directory of a Transport."""
1018
# Since we don't have a .bzr directory, inherit the
1317
# can we hand off the request to the smart server rather than using
1319
client_medium = transport.get_smart_medium()
1320
except errors.NoSmartMedium:
1321
return self._initialize_on_transport_vfs(transport)
1323
# Current RPC's only know how to create bzr metadir1 instances, so
1324
# we still delegate to vfs methods if the requested format is not a
1326
if type(self) != BzrDirMetaFormat1:
1327
return self._initialize_on_transport_vfs(transport)
1328
from bzrlib.remote import RemoteBzrDirFormat
1329
remote_format = RemoteBzrDirFormat()
1330
self._supply_sub_formats_to(remote_format)
1331
return remote_format.initialize_on_transport(transport)
1333
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
1334
create_prefix=False, force_new_repo=False, stacked_on=None,
1335
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
1336
shared_repo=False, vfs_only=False):
1337
"""Create this format on transport.
1339
The directory to initialize will be created.
1341
:param force_new_repo: Do not use a shared repository for the target,
1342
even if one is available.
1343
:param create_prefix: Create any missing directories leading up to
1345
:param use_existing_dir: Use an existing directory if one exists.
1346
:param stacked_on: A url to stack any created branch on, None to follow
1347
any target stacking policy.
1348
:param stack_on_pwd: If stack_on is relative, the location it is
1350
:param repo_format_name: If non-None, a repository will be
1351
made-or-found. Should none be found, or if force_new_repo is True
1352
the repo_format_name is used to select the format of repository to
1354
:param make_working_trees: Control the setting of make_working_trees
1355
for a new shared repository when one is made. None to use whatever
1356
default the format has.
1357
:param shared_repo: Control whether made repositories are shared or
1359
:param vfs_only: If True do not attempt to use a smart server
1360
:return: repo, controldir, require_stacking, repository_policy. repo is
1361
None if none was created or found, bzrdir is always valid.
1362
require_stacking is the result of examining the stacked_on
1363
parameter and any stacking policy found for the target.
1366
# Try to hand off to a smart server
1368
client_medium = transport.get_smart_medium()
1369
except errors.NoSmartMedium:
1372
from bzrlib.remote import RemoteBzrDirFormat
1373
# TODO: lookup the local format from a server hint.
1374
remote_dir_format = RemoteBzrDirFormat()
1375
remote_dir_format._network_name = self.network_name()
1376
self._supply_sub_formats_to(remote_dir_format)
1377
return remote_dir_format.initialize_on_transport_ex(transport,
1378
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
1379
force_new_repo=force_new_repo, stacked_on=stacked_on,
1380
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
1381
make_working_trees=make_working_trees, shared_repo=shared_repo)
1382
# XXX: Refactor the create_prefix/no_create_prefix code into a
1383
# common helper function
1384
# The destination may not exist - if so make it according to policy.
1385
def make_directory(transport):
1386
transport.mkdir('.')
1388
def redirected(transport, e, redirection_notice):
1389
note(redirection_notice)
1390
return transport._redirected_to(e.source, e.target)
1392
transport = do_catching_redirections(make_directory, transport,
1394
except errors.FileExists:
1395
if not use_existing_dir:
1397
except errors.NoSuchFile:
1398
if not create_prefix:
1400
transport.create_prefix()
1402
require_stacking = (stacked_on is not None)
1403
# Now the target directory exists, but doesn't have a .bzr
1404
# directory. So we need to create it, along with any work to create
1405
# all of the dependent branches, etc.
1407
result = self.initialize_on_transport(transport)
1408
if repo_format_name:
1410
# use a custom format
1411
result._format.repository_format = \
1412
repository.network_format_registry.get(repo_format_name)
1413
except AttributeError:
1414
# The format didn't permit it to be set.
1416
# A repository is desired, either in-place or shared.
1417
repository_policy = result.determine_repository_policy(
1418
force_new_repo, stacked_on, stack_on_pwd,
1419
require_stacking=require_stacking)
1420
result_repo, is_new_repo = repository_policy.acquire_repository(
1421
make_working_trees, shared_repo)
1422
if not require_stacking and repository_policy._require_stacking:
1423
require_stacking = True
1424
result._format.require_stacking()
1425
result_repo.lock_write()
1428
repository_policy = None
1429
return result_repo, result, require_stacking, repository_policy
1431
def _initialize_on_transport_vfs(self, transport):
1432
"""Initialize a new bzrdir using VFS calls.
1434
:param transport: The transport to create the .bzr directory in.
1437
# Since we are creating a .bzr directory, inherit the
1019
1438
# mode from the root directory
1020
temp_control = LockableFiles(transport, '', TransportLock)
1021
temp_control._transport.mkdir('.bzr',
1022
# FIXME: RBC 20060121 don't peek under
1024
mode=temp_control._dir_mode)
1439
temp_control = lockable_files.LockableFiles(transport,
1440
'', lockable_files.TransportLock)
1442
temp_control._transport.mkdir('.bzr',
1443
# FIXME: RBC 20060121 don't peek under
1445
mode=temp_control._dir_mode)
1446
except errors.FileExists:
1447
raise errors.AlreadyControlDirError(transport.base)
1448
if sys.platform == 'win32' and isinstance(transport, local.LocalTransport):
1449
win32utils.set_file_attr_hidden(transport._abspath('.bzr'))
1025
1450
file_mode = temp_control._file_mode
1026
1451
del temp_control
1027
mutter('created control directory in ' + transport.base)
1028
control = transport.clone('.bzr')
1029
utf8_files = [('README',
1030
"This is a Bazaar-NG control directory.\n"
1031
"Do not change any files in this directory.\n"),
1032
('branch-format', self.get_format_string()),
1452
bzrdir_transport = transport.clone('.bzr')
1453
utf8_files = [('README',
1454
"This is a Bazaar control directory.\n"
1455
"Do not change any files in this directory.\n"
1456
"See http://bazaar.canonical.com/ for more information about Bazaar.\n"),
1457
('branch-format', self.as_string()),
1034
1459
# NB: no need to escape relative paths that are url safe.
1035
control_files = LockableFiles(control, self._lock_file_name,
1460
control_files = lockable_files.LockableFiles(bzrdir_transport,
1461
self._lock_file_name, self._lock_class)
1037
1462
control_files.create_lock()
1038
1463
control_files.lock_write()
1040
for file, content in utf8_files:
1041
control_files.put_utf8(file, content)
1465
for (filename, content) in utf8_files:
1466
bzrdir_transport.put_bytes(filename, content,
1043
1469
control_files.unlock()
1044
1470
return self.open(transport, _found=True)
1046
def is_supported(self):
1047
"""Is this format supported?
1049
Supported formats must be initializable and openable.
1050
Unsupported formats may not support initialization or committing or
1051
some other features depending on the reason for not being supported.
1056
def known_formats(klass):
1057
"""Return all the known formats.
1059
Concrete formats should override _known_formats.
1061
# There is double indirection here to make sure that control
1062
# formats used by more than one dir format will only be probed
1063
# once. This can otherwise be quite expensive for remote connections.
1065
for format in klass._control_formats:
1066
result.update(format._known_formats())
1070
def _known_formats(klass):
1071
"""Return the known format instances for this control format."""
1072
return set(klass._formats.values())
1074
1472
def open(self, transport, _found=False):
1075
1473
"""Return an instance of this format for the dir transport points at.
1077
1475
_found is a private parameter, do not use it.
1080
assert isinstance(BzrDirFormat.find_format(transport),
1478
found_format = controldir.ControlDirFormat.find_format(transport)
1479
if not isinstance(found_format, self.__class__):
1480
raise AssertionError("%s was asked to open %s, but it seems to need "
1482
% (self, transport, found_format))
1483
# Allow subclasses - use the found format.
1484
self._supply_sub_formats_to(found_format)
1485
return found_format._open(transport)
1082
1486
return self._open(transport)
1084
1488
def _open(self, transport):
1090
1494
raise NotImplementedError(self._open)
1093
def register_format(klass, format):
1094
klass._formats[format.get_format_string()] = format
1097
def register_control_format(klass, format):
1098
"""Register a format that does not use '.bzrdir' for its control dir.
1100
TODO: This should be pulled up into a 'ControlDirFormat' base class
1101
which BzrDirFormat can inherit from, and renamed to register_format
1102
there. It has been done without that for now for simplicity of
1105
klass._control_formats.append(format)
1108
def set_default_format(klass, format):
1109
klass._default_format = format
1112
return self.get_format_string()[:-1]
1115
def unregister_format(klass, format):
1116
assert klass._formats[format.get_format_string()] is format
1117
del klass._formats[format.get_format_string()]
1120
def unregister_control_format(klass, format):
1121
klass._control_formats.remove(format)
1124
# register BzrDirFormat as a control format
1125
BzrDirFormat.register_control_format(BzrDirFormat)
1128
class BzrDirFormat4(BzrDirFormat):
1129
"""Bzr dir format 4.
1131
This format is a combined format for working tree, branch and repository.
1133
- Format 1 working trees [always]
1134
- Format 4 branches [always]
1135
- Format 4 repositories [always]
1137
This format is deprecated: it indexes texts using a text it which is
1138
removed in format 5; write support for this format has been removed.
1141
_lock_class = TransportLock
1143
def get_format_string(self):
1144
"""See BzrDirFormat.get_format_string()."""
1145
return "Bazaar-NG branch, format 0.0.4\n"
1147
def get_format_description(self):
1148
"""See BzrDirFormat.get_format_description()."""
1149
return "All-in-one format 4"
1151
def get_converter(self, format=None):
1152
"""See BzrDirFormat.get_converter()."""
1153
# there is one and only one upgrade path here.
1154
return ConvertBzrDir4To5()
1156
def initialize_on_transport(self, transport):
1157
"""Format 4 branches cannot be created."""
1158
raise errors.UninitializableFormat(self)
1160
def is_supported(self):
1161
"""Format 4 is not supported.
1163
It is not supported because the model changed from 4 to 5 and the
1164
conversion logic is expensive - so doing it on the fly was not
1169
def _open(self, transport):
1170
"""See BzrDirFormat._open."""
1171
return BzrDir4(transport, self)
1173
def __return_repository_format(self):
1174
"""Circular import protection."""
1175
from bzrlib.repository import RepositoryFormat4
1176
return RepositoryFormat4(self)
1177
repository_format = property(__return_repository_format)
1180
class BzrDirFormat5(BzrDirFormat):
1181
"""Bzr control format 5.
1183
This format is a combined format for working tree, branch and repository.
1185
- Format 2 working trees [always]
1186
- Format 4 branches [always]
1187
- Format 5 repositories [always]
1188
Unhashed stores in the repository.
1191
_lock_class = TransportLock
1193
def get_format_string(self):
1194
"""See BzrDirFormat.get_format_string()."""
1195
return "Bazaar-NG branch, format 5\n"
1197
def get_format_description(self):
1198
"""See BzrDirFormat.get_format_description()."""
1199
return "All-in-one format 5"
1201
def get_converter(self, format=None):
1202
"""See BzrDirFormat.get_converter()."""
1203
# there is one and only one upgrade path here.
1204
return ConvertBzrDir5To6()
1206
def _initialize_for_clone(self, url):
1207
return self.initialize_on_transport(get_transport(url), _cloning=True)
1209
def initialize_on_transport(self, transport, _cloning=False):
1210
"""Format 5 dirs always have working tree, branch and repository.
1212
Except when they are being cloned.
1214
from bzrlib.branch import BzrBranchFormat4
1215
from bzrlib.repository import RepositoryFormat5
1216
from bzrlib.workingtree import WorkingTreeFormat2
1217
result = (super(BzrDirFormat5, self).initialize_on_transport(transport))
1218
RepositoryFormat5().initialize(result, _internal=True)
1220
BzrBranchFormat4().initialize(result)
1221
WorkingTreeFormat2().initialize(result)
1224
def _open(self, transport):
1225
"""See BzrDirFormat._open."""
1226
return BzrDir5(transport, self)
1228
def __return_repository_format(self):
1229
"""Circular import protection."""
1230
from bzrlib.repository import RepositoryFormat5
1231
return RepositoryFormat5(self)
1232
repository_format = property(__return_repository_format)
1235
class BzrDirFormat6(BzrDirFormat):
1236
"""Bzr control format 6.
1238
This format is a combined format for working tree, branch and repository.
1240
- Format 2 working trees [always]
1241
- Format 4 branches [always]
1242
- Format 6 repositories [always]
1245
_lock_class = TransportLock
1247
def get_format_string(self):
1248
"""See BzrDirFormat.get_format_string()."""
1249
return "Bazaar-NG branch, format 6\n"
1251
def get_format_description(self):
1252
"""See BzrDirFormat.get_format_description()."""
1253
return "All-in-one format 6"
1255
def get_converter(self, format=None):
1256
"""See BzrDirFormat.get_converter()."""
1257
# there is one and only one upgrade path here.
1258
return ConvertBzrDir6ToMeta()
1260
def _initialize_for_clone(self, url):
1261
return self.initialize_on_transport(get_transport(url), _cloning=True)
1263
def initialize_on_transport(self, transport, _cloning=False):
1264
"""Format 6 dirs always have working tree, branch and repository.
1266
Except when they are being cloned.
1268
from bzrlib.branch import BzrBranchFormat4
1269
from bzrlib.repository import RepositoryFormat6
1270
from bzrlib.workingtree import WorkingTreeFormat2
1271
result = super(BzrDirFormat6, self).initialize_on_transport(transport)
1272
RepositoryFormat6().initialize(result, _internal=True)
1274
BzrBranchFormat4().initialize(result)
1276
WorkingTreeFormat2().initialize(result)
1277
except errors.NotLocalUrl:
1278
# emulate pre-check behaviour for working tree and silently
1283
def _open(self, transport):
1284
"""See BzrDirFormat._open."""
1285
return BzrDir6(transport, self)
1287
def __return_repository_format(self):
1288
"""Circular import protection."""
1289
from bzrlib.repository import RepositoryFormat6
1290
return RepositoryFormat6(self)
1291
repository_format = property(__return_repository_format)
1496
def _supply_sub_formats_to(self, other_format):
1497
"""Give other_format the same values for sub formats as this has.
1499
This method is expected to be used when parameterising a
1500
RemoteBzrDirFormat instance with the parameters from a
1501
BzrDirMetaFormat1 instance.
1503
:param other_format: other_format is a format which should be
1504
compatible with whatever sub formats are supported by self.
1507
other_format.features = dict(self.features)
1509
def supports_transport(self, transport):
1510
# bzr formats can be opened over all known transports
1513
def check_support_status(self, allow_unsupported, recommend_upgrade=True,
1515
controldir.ControlDirFormat.check_support_status(self,
1516
allow_unsupported=allow_unsupported, recommend_upgrade=recommend_upgrade,
1518
BzrFormat.check_support_status(self, allow_unsupported=allow_unsupported,
1519
recommend_upgrade=recommend_upgrade, basedir=basedir)
1294
1522
class BzrDirMetaFormat1(BzrDirFormat):
1297
1525
This is the first format with split out working tree, branch and repository
1300
- Format 3 working trees [optional]
1301
- Format 5 branches [optional]
1302
- Format 7 repositories [optional]
1530
- Format 3 working trees [optional]
1531
- Format 5 branches [optional]
1532
- Format 7 repositories [optional]
1305
_lock_class = LockDir
1535
_lock_class = lockdir.LockDir
1537
fixed_components = False
1539
colocated_branches = True
1542
BzrDirFormat.__init__(self)
1543
self._workingtree_format = None
1544
self._branch_format = None
1545
self._repository_format = None
1547
def __eq__(self, other):
1548
if other.__class__ is not self.__class__:
1550
if other.repository_format != self.repository_format:
1552
if other.workingtree_format != self.workingtree_format:
1554
if other.features != self.features:
1558
def __ne__(self, other):
1559
return not self == other
1561
def get_branch_format(self):
1562
if self._branch_format is None:
1563
from bzrlib.branch import format_registry as branch_format_registry
1564
self._branch_format = branch_format_registry.get_default()
1565
return self._branch_format
1567
def set_branch_format(self, format):
1568
self._branch_format = format
1570
def require_stacking(self, stack_on=None, possible_transports=None,
1572
"""We have a request to stack, try to ensure the formats support it.
1574
:param stack_on: If supplied, it is the URL to a branch that we want to
1575
stack on. Check to see if that format supports stacking before
1578
# Stacking is desired. requested by the target, but does the place it
1579
# points at support stacking? If it doesn't then we should
1580
# not implicitly upgrade. We check this here.
1581
new_repo_format = None
1582
new_branch_format = None
1584
# a bit of state for get_target_branch so that we don't try to open it
1585
# 2 times, for both repo *and* branch
1586
target = [None, False, None] # target_branch, checked, upgrade anyway
1587
def get_target_branch():
1589
# We've checked, don't check again
1591
if stack_on is None:
1592
# No target format, that means we want to force upgrading
1593
target[:] = [None, True, True]
1596
target_dir = BzrDir.open(stack_on,
1597
possible_transports=possible_transports)
1598
except errors.NotBranchError:
1599
# Nothing there, don't change formats
1600
target[:] = [None, True, False]
1602
except errors.JailBreak:
1603
# JailBreak, JFDI and upgrade anyway
1604
target[:] = [None, True, True]
1607
target_branch = target_dir.open_branch()
1608
except errors.NotBranchError:
1609
# No branch, don't upgrade formats
1610
target[:] = [None, True, False]
1612
target[:] = [target_branch, True, False]
1615
if (not _skip_repo and
1616
not self.repository_format.supports_external_lookups):
1617
# We need to upgrade the Repository.
1618
target_branch, _, do_upgrade = get_target_branch()
1619
if target_branch is None:
1620
# We don't have a target branch, should we upgrade anyway?
1622
# stack_on is inaccessible, JFDI.
1623
# TODO: bad monkey, hard-coded formats...
1624
if self.repository_format.rich_root_data:
1625
new_repo_format = knitpack_repo.RepositoryFormatKnitPack5RichRoot()
1627
new_repo_format = knitpack_repo.RepositoryFormatKnitPack5()
1629
# If the target already supports stacking, then we know the
1630
# project is already able to use stacking, so auto-upgrade
1632
new_repo_format = target_branch.repository._format
1633
if not new_repo_format.supports_external_lookups:
1634
# target doesn't, source doesn't, so don't auto upgrade
1636
new_repo_format = None
1637
if new_repo_format is not None:
1638
self.repository_format = new_repo_format
1639
note(gettext('Source repository format does not support stacking,'
1640
' using format:\n %s'),
1641
new_repo_format.get_format_description())
1643
if not self.get_branch_format().supports_stacking():
1644
# We just checked the repo, now lets check if we need to
1645
# upgrade the branch format
1646
target_branch, _, do_upgrade = get_target_branch()
1647
if target_branch is None:
1649
# TODO: bad monkey, hard-coded formats...
1650
from bzrlib.branch import BzrBranchFormat7
1651
new_branch_format = BzrBranchFormat7()
1653
new_branch_format = target_branch._format
1654
if not new_branch_format.supports_stacking():
1655
new_branch_format = None
1656
if new_branch_format is not None:
1657
# Does support stacking, use its format.
1658
self.set_branch_format(new_branch_format)
1659
note(gettext('Source branch format does not support stacking,'
1660
' using format:\n %s'),
1661
new_branch_format.get_format_description())
1307
1663
def get_converter(self, format=None):
1308
1664
"""See BzrDirFormat.get_converter()."""
1309
1665
if format is None:
1310
1666
format = BzrDirFormat.get_default_format()
1667
if (type(self) is BzrDirMetaFormat1 and
1668
type(format) is BzrDirMetaFormat1Colo):
1669
return ConvertMetaToColo(format)
1670
if (type(self) is BzrDirMetaFormat1Colo and
1671
type(format) is BzrDirMetaFormat1):
1672
return ConvertMetaToColo(format)
1311
1673
if not isinstance(self, format.__class__):
1312
1674
# converting away from metadir is not implemented
1313
1675
raise NotImplementedError(self.get_converter)
1314
1676
return ConvertMetaToMeta(format)
1316
def get_format_string(self):
1679
def get_format_string(cls):
1317
1680
"""See BzrDirFormat.get_format_string()."""
1318
1681
return "Bazaar-NG meta directory, format 1\n"
1324
1687
def _open(self, transport):
1325
1688
"""See BzrDirFormat._open."""
1326
return BzrDirMeta1(transport, self)
1689
# Create a new format instance because otherwise initialisation of new
1690
# metadirs share the global default format object leading to alias
1692
format = BzrDirMetaFormat1()
1693
self._supply_sub_formats_to(format)
1694
return BzrDirMeta1(transport, format)
1328
1696
def __return_repository_format(self):
1329
1697
"""Circular import protection."""
1330
if getattr(self, '_repository_format', None):
1698
if self._repository_format:
1331
1699
return self._repository_format
1332
from bzrlib.repository import RepositoryFormat
1333
return RepositoryFormat.get_default_format()
1700
from bzrlib.repository import format_registry
1701
return format_registry.get_default()
1335
def __set_repository_format(self, value):
1336
"""Allow changint the repository format for metadir formats."""
1703
def _set_repository_format(self, value):
1704
"""Allow changing the repository format for metadir formats."""
1337
1705
self._repository_format = value
1339
repository_format = property(__return_repository_format, __set_repository_format)
1342
BzrDirFormat.register_format(BzrDirFormat4())
1343
BzrDirFormat.register_format(BzrDirFormat5())
1344
BzrDirFormat.register_format(BzrDirFormat6())
1345
__default_format = BzrDirMetaFormat1()
1346
BzrDirFormat.register_format(__default_format)
1347
BzrDirFormat.set_default_format(__default_format)
1350
class BzrDirTestProviderAdapter(object):
1351
"""A tool to generate a suite testing multiple bzrdir formats at once.
1353
This is done by copying the test once for each transport and injecting
1354
the transport_server, transport_readonly_server, and bzrdir_format
1355
classes into each copy. Each copy is also given a new id() to make it
1359
def __init__(self, transport_server, transport_readonly_server, formats):
1360
self._transport_server = transport_server
1361
self._transport_readonly_server = transport_readonly_server
1362
self._formats = formats
1364
def adapt(self, test):
1365
result = TestSuite()
1366
for format in self._formats:
1367
new_test = deepcopy(test)
1368
new_test.transport_server = self._transport_server
1369
new_test.transport_readonly_server = self._transport_readonly_server
1370
new_test.bzrdir_format = format
1371
def make_new_test_id():
1372
new_id = "%s(%s)" % (new_test.id(), format.__class__.__name__)
1373
return lambda: new_id
1374
new_test.id = make_new_test_id()
1375
result.addTest(new_test)
1379
class Converter(object):
1380
"""Converts a disk format object from one format to another."""
1382
def convert(self, to_convert, pb):
1383
"""Perform the conversion of to_convert, giving feedback via pb.
1385
:param to_convert: The disk object to convert.
1386
:param pb: a progress bar to use for progress information.
1389
def step(self, message):
1390
"""Update the pb by a step."""
1392
self.pb.update(message, self.count, self.total)
1395
class ConvertBzrDir4To5(Converter):
1396
"""Converts format 4 bzr dirs to format 5."""
1399
super(ConvertBzrDir4To5, self).__init__()
1400
self.converted_revs = set()
1401
self.absent_revisions = set()
1405
def convert(self, to_convert, pb):
1406
"""See Converter.convert()."""
1407
self.bzrdir = to_convert
1409
self.pb.note('starting upgrade from format 4 to 5')
1410
if isinstance(self.bzrdir.transport, LocalTransport):
1411
self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
1412
self._convert_to_weaves()
1413
return BzrDir.open(self.bzrdir.root_transport.base)
1415
def _convert_to_weaves(self):
1416
self.pb.note('note: upgrade may be faster if all store files are ungzipped first')
1419
stat = self.bzrdir.transport.stat('weaves')
1420
if not S_ISDIR(stat.st_mode):
1421
self.bzrdir.transport.delete('weaves')
1422
self.bzrdir.transport.mkdir('weaves')
1423
except errors.NoSuchFile:
1424
self.bzrdir.transport.mkdir('weaves')
1425
# deliberately not a WeaveFile as we want to build it up slowly.
1426
self.inv_weave = Weave('inventory')
1427
# holds in-memory weaves for all files
1428
self.text_weaves = {}
1429
self.bzrdir.transport.delete('branch-format')
1430
self.branch = self.bzrdir.open_branch()
1431
self._convert_working_inv()
1432
rev_history = self.branch.revision_history()
1433
# to_read is a stack holding the revisions we still need to process;
1434
# appending to it adds new highest-priority revisions
1435
self.known_revisions = set(rev_history)
1436
self.to_read = rev_history[-1:]
1438
rev_id = self.to_read.pop()
1439
if (rev_id not in self.revisions
1440
and rev_id not in self.absent_revisions):
1441
self._load_one_rev(rev_id)
1443
to_import = self._make_order()
1444
for i, rev_id in enumerate(to_import):
1445
self.pb.update('converting revision', i, len(to_import))
1446
self._convert_one_rev(rev_id)
1448
self._write_all_weaves()
1449
self._write_all_revs()
1450
self.pb.note('upgraded to weaves:')
1451
self.pb.note(' %6d revisions and inventories', len(self.revisions))
1452
self.pb.note(' %6d revisions not present', len(self.absent_revisions))
1453
self.pb.note(' %6d texts', self.text_count)
1454
self._cleanup_spare_files_after_format4()
1455
self.branch.control_files.put_utf8('branch-format', BzrDirFormat5().get_format_string())
1457
def _cleanup_spare_files_after_format4(self):
1458
# FIXME working tree upgrade foo.
1459
for n in 'merged-patches', 'pending-merged-patches':
1461
## assert os.path.getsize(p) == 0
1462
self.bzrdir.transport.delete(n)
1463
except errors.NoSuchFile:
1465
self.bzrdir.transport.delete_tree('inventory-store')
1466
self.bzrdir.transport.delete_tree('text-store')
1468
def _convert_working_inv(self):
1469
inv = serializer_v4.read_inventory(self.branch.control_files.get('inventory'))
1470
new_inv_xml = bzrlib.xml5.serializer_v5.write_inventory_to_string(inv)
1471
# FIXME inventory is a working tree change.
1472
self.branch.control_files.put('inventory', new_inv_xml)
1474
def _write_all_weaves(self):
1475
controlweaves = WeaveStore(self.bzrdir.transport, prefixed=False)
1476
weave_transport = self.bzrdir.transport.clone('weaves')
1477
weaves = WeaveStore(weave_transport, prefixed=False)
1478
transaction = WriteTransaction()
1482
for file_id, file_weave in self.text_weaves.items():
1483
self.pb.update('writing weave', i, len(self.text_weaves))
1484
weaves._put_weave(file_id, file_weave, transaction)
1486
self.pb.update('inventory', 0, 1)
1487
controlweaves._put_weave('inventory', self.inv_weave, transaction)
1488
self.pb.update('inventory', 1, 1)
1492
def _write_all_revs(self):
1493
"""Write all revisions out in new form."""
1494
self.bzrdir.transport.delete_tree('revision-store')
1495
self.bzrdir.transport.mkdir('revision-store')
1496
revision_transport = self.bzrdir.transport.clone('revision-store')
1498
_revision_store = TextRevisionStore(TextStore(revision_transport,
1502
transaction = bzrlib.transactions.WriteTransaction()
1503
for i, rev_id in enumerate(self.converted_revs):
1504
self.pb.update('write revision', i, len(self.converted_revs))
1505
_revision_store.add_revision(self.revisions[rev_id], transaction)
1509
def _load_one_rev(self, rev_id):
1510
"""Load a revision object into memory.
1512
Any parents not either loaded or abandoned get queued to be
1514
self.pb.update('loading revision',
1515
len(self.revisions),
1516
len(self.known_revisions))
1517
if not self.branch.repository.has_revision(rev_id):
1519
self.pb.note('revision {%s} not present in branch; '
1520
'will be converted as a ghost',
1522
self.absent_revisions.add(rev_id)
1524
rev = self.branch.repository._revision_store.get_revision(rev_id,
1525
self.branch.repository.get_transaction())
1526
for parent_id in rev.parent_ids:
1527
self.known_revisions.add(parent_id)
1528
self.to_read.append(parent_id)
1529
self.revisions[rev_id] = rev
1531
def _load_old_inventory(self, rev_id):
1532
assert rev_id not in self.converted_revs
1533
old_inv_xml = self.branch.repository.inventory_store.get(rev_id).read()
1534
inv = serializer_v4.read_inventory_from_string(old_inv_xml)
1535
rev = self.revisions[rev_id]
1536
if rev.inventory_sha1:
1537
assert rev.inventory_sha1 == sha_string(old_inv_xml), \
1538
'inventory sha mismatch for {%s}' % rev_id
1541
def _load_updated_inventory(self, rev_id):
1542
assert rev_id in self.converted_revs
1543
inv_xml = self.inv_weave.get_text(rev_id)
1544
inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(inv_xml)
1547
def _convert_one_rev(self, rev_id):
1548
"""Convert revision and all referenced objects to new format."""
1549
rev = self.revisions[rev_id]
1550
inv = self._load_old_inventory(rev_id)
1551
present_parents = [p for p in rev.parent_ids
1552
if p not in self.absent_revisions]
1553
self._convert_revision_contents(rev, inv, present_parents)
1554
self._store_new_weave(rev, inv, present_parents)
1555
self.converted_revs.add(rev_id)
1557
def _store_new_weave(self, rev, inv, present_parents):
1558
# the XML is now updated with text versions
1562
if ie.kind == 'root_directory':
1564
assert hasattr(ie, 'revision'), \
1565
'no revision on {%s} in {%s}' % \
1566
(file_id, rev.revision_id)
1567
new_inv_xml = bzrlib.xml5.serializer_v5.write_inventory_to_string(inv)
1568
new_inv_sha1 = sha_string(new_inv_xml)
1569
self.inv_weave.add_lines(rev.revision_id,
1571
new_inv_xml.splitlines(True))
1572
rev.inventory_sha1 = new_inv_sha1
1574
def _convert_revision_contents(self, rev, inv, present_parents):
1575
"""Convert all the files within a revision.
1577
Also upgrade the inventory to refer to the text revision ids."""
1578
rev_id = rev.revision_id
1579
mutter('converting texts of revision {%s}',
1581
parent_invs = map(self._load_updated_inventory, present_parents)
1584
self._convert_file_version(rev, ie, parent_invs)
1586
def _convert_file_version(self, rev, ie, parent_invs):
1587
"""Convert one version of one file.
1589
The file needs to be added into the weave if it is a merge
1590
of >=2 parents or if it's changed from its parent.
1592
if ie.kind == 'root_directory':
1594
file_id = ie.file_id
1595
rev_id = rev.revision_id
1596
w = self.text_weaves.get(file_id)
1599
self.text_weaves[file_id] = w
1600
text_changed = False
1601
previous_entries = ie.find_previous_heads(parent_invs,
1605
for old_revision in previous_entries:
1606
# if this fails, its a ghost ?
1607
assert old_revision in self.converted_revs
1608
self.snapshot_ie(previous_entries, ie, w, rev_id)
1610
assert getattr(ie, 'revision', None) is not None
1612
def snapshot_ie(self, previous_revisions, ie, w, rev_id):
1613
# TODO: convert this logic, which is ~= snapshot to
1614
# a call to:. This needs the path figured out. rather than a work_tree
1615
# a v4 revision_tree can be given, or something that looks enough like
1616
# one to give the file content to the entry if it needs it.
1617
# and we need something that looks like a weave store for snapshot to
1619
#ie.snapshot(rev, PATH, previous_revisions, REVISION_TREE, InMemoryWeaveStore(self.text_weaves))
1620
if len(previous_revisions) == 1:
1621
previous_ie = previous_revisions.values()[0]
1622
if ie._unchanged(previous_ie):
1623
ie.revision = previous_ie.revision
1626
text = self.branch.repository.text_store.get(ie.text_id)
1627
file_lines = text.readlines()
1628
assert sha_strings(file_lines) == ie.text_sha1
1629
assert sum(map(len, file_lines)) == ie.text_size
1630
w.add_lines(rev_id, previous_revisions, file_lines)
1631
self.text_count += 1
1633
w.add_lines(rev_id, previous_revisions, [])
1634
ie.revision = rev_id
1636
def _make_order(self):
1637
"""Return a suitable order for importing revisions.
1639
The order must be such that an revision is imported after all
1640
its (present) parents.
1642
todo = set(self.revisions.keys())
1643
done = self.absent_revisions.copy()
1646
# scan through looking for a revision whose parents
1648
for rev_id in sorted(list(todo)):
1649
rev = self.revisions[rev_id]
1650
parent_ids = set(rev.parent_ids)
1651
if parent_ids.issubset(done):
1652
# can take this one now
1653
order.append(rev_id)
1659
class ConvertBzrDir5To6(Converter):
1660
"""Converts format 5 bzr dirs to format 6."""
1662
def convert(self, to_convert, pb):
1663
"""See Converter.convert()."""
1664
self.bzrdir = to_convert
1666
self.pb.note('starting upgrade from format 5 to 6')
1667
self._convert_to_prefixed()
1668
return BzrDir.open(self.bzrdir.root_transport.base)
1670
def _convert_to_prefixed(self):
1671
from bzrlib.store import TransportStore
1672
self.bzrdir.transport.delete('branch-format')
1673
for store_name in ["weaves", "revision-store"]:
1674
self.pb.note("adding prefixes to %s" % store_name)
1675
store_transport = self.bzrdir.transport.clone(store_name)
1676
store = TransportStore(store_transport, prefixed=True)
1677
for urlfilename in store_transport.list_dir('.'):
1678
filename = urlutils.unescape(urlfilename)
1679
if (filename.endswith(".weave") or
1680
filename.endswith(".gz") or
1681
filename.endswith(".sig")):
1682
file_id = os.path.splitext(filename)[0]
1685
prefix_dir = store.hash_prefix(file_id)
1686
# FIXME keep track of the dirs made RBC 20060121
1688
store_transport.move(filename, prefix_dir + '/' + filename)
1689
except errors.NoSuchFile: # catches missing dirs strangely enough
1690
store_transport.mkdir(prefix_dir)
1691
store_transport.move(filename, prefix_dir + '/' + filename)
1692
self.bzrdir._control_files.put_utf8('branch-format', BzrDirFormat6().get_format_string())
1695
class ConvertBzrDir6ToMeta(Converter):
1696
"""Converts format 6 bzr dirs to metadirs."""
1698
def convert(self, to_convert, pb):
1699
"""See Converter.convert()."""
1700
self.bzrdir = to_convert
1703
self.total = 20 # the steps we know about
1704
self.garbage_inventories = []
1706
self.pb.note('starting upgrade from format 6 to metadir')
1707
self.bzrdir._control_files.put_utf8('branch-format', "Converting to format 6")
1708
# its faster to move specific files around than to open and use the apis...
1709
# first off, nuke ancestry.weave, it was never used.
1711
self.step('Removing ancestry.weave')
1712
self.bzrdir.transport.delete('ancestry.weave')
1713
except errors.NoSuchFile:
1715
# find out whats there
1716
self.step('Finding branch files')
1717
last_revision = self.bzrdir.open_branch().last_revision()
1718
bzrcontents = self.bzrdir.transport.list_dir('.')
1719
for name in bzrcontents:
1720
if name.startswith('basis-inventory.'):
1721
self.garbage_inventories.append(name)
1722
# create new directories for repository, working tree and branch
1723
self.dir_mode = self.bzrdir._control_files._dir_mode
1724
self.file_mode = self.bzrdir._control_files._file_mode
1725
repository_names = [('inventory.weave', True),
1726
('revision-store', True),
1728
self.step('Upgrading repository ')
1729
self.bzrdir.transport.mkdir('repository', mode=self.dir_mode)
1730
self.make_lock('repository')
1731
# we hard code the formats here because we are converting into
1732
# the meta format. The meta format upgrader can take this to a
1733
# future format within each component.
1734
self.put_format('repository', bzrlib.repository.RepositoryFormat7())
1735
for entry in repository_names:
1736
self.move_entry('repository', entry)
1738
self.step('Upgrading branch ')
1739
self.bzrdir.transport.mkdir('branch', mode=self.dir_mode)
1740
self.make_lock('branch')
1741
self.put_format('branch', bzrlib.branch.BzrBranchFormat5())
1742
branch_files = [('revision-history', True),
1743
('branch-name', True),
1745
for entry in branch_files:
1746
self.move_entry('branch', entry)
1748
self.step('Upgrading working tree')
1749
self.bzrdir.transport.mkdir('checkout', mode=self.dir_mode)
1750
self.make_lock('checkout')
1751
self.put_format('checkout', bzrlib.workingtree.WorkingTreeFormat3())
1752
self.bzrdir.transport.delete_multi(self.garbage_inventories, self.pb)
1753
checkout_files = [('pending-merges', True),
1754
('inventory', True),
1755
('stat-cache', False)]
1756
for entry in checkout_files:
1757
self.move_entry('checkout', entry)
1758
if last_revision is not None:
1759
self.bzrdir._control_files.put_utf8('checkout/last-revision',
1761
self.bzrdir._control_files.put_utf8('branch-format', BzrDirMetaFormat1().get_format_string())
1762
return BzrDir.open(self.bzrdir.root_transport.base)
1764
def make_lock(self, name):
1765
"""Make a lock for the new control dir name."""
1766
self.step('Make %s lock' % name)
1767
ld = LockDir(self.bzrdir.transport,
1769
file_modebits=self.file_mode,
1770
dir_modebits=self.dir_mode)
1773
def move_entry(self, new_dir, entry):
1774
"""Move then entry name into new_dir."""
1776
mandatory = entry[1]
1777
self.step('Moving %s' % name)
1779
self.bzrdir.transport.move(name, '%s/%s' % (new_dir, name))
1780
except errors.NoSuchFile:
1784
def put_format(self, dirname, format):
1785
self.bzrdir._control_files.put_utf8('%s/format' % dirname, format.get_format_string())
1788
class ConvertMetaToMeta(Converter):
1707
repository_format = property(__return_repository_format,
1708
_set_repository_format)
1710
def _supply_sub_formats_to(self, other_format):
1711
"""Give other_format the same values for sub formats as this has.
1713
This method is expected to be used when parameterising a
1714
RemoteBzrDirFormat instance with the parameters from a
1715
BzrDirMetaFormat1 instance.
1717
:param other_format: other_format is a format which should be
1718
compatible with whatever sub formats are supported by self.
1721
super(BzrDirMetaFormat1, self)._supply_sub_formats_to(other_format)
1722
if getattr(self, '_repository_format', None) is not None:
1723
other_format.repository_format = self.repository_format
1724
if self._branch_format is not None:
1725
other_format._branch_format = self._branch_format
1726
if self._workingtree_format is not None:
1727
other_format.workingtree_format = self.workingtree_format
1729
def __get_workingtree_format(self):
1730
if self._workingtree_format is None:
1731
from bzrlib.workingtree import (
1732
format_registry as wt_format_registry,
1734
self._workingtree_format = wt_format_registry.get_default()
1735
return self._workingtree_format
1737
def __set_workingtree_format(self, wt_format):
1738
self._workingtree_format = wt_format
1741
return "<%r>" % (self.__class__.__name__,)
1743
workingtree_format = property(__get_workingtree_format,
1744
__set_workingtree_format)
1747
# Register bzr formats
1748
BzrProber.formats.register(BzrDirMetaFormat1.get_format_string(),
1750
controldir.ControlDirFormat._default_format = BzrDirMetaFormat1()
1753
class BzrDirMetaFormat1Colo(BzrDirMetaFormat1):
1754
"""BzrDirMeta1 format with support for colocated branches."""
1756
colocated_branches = True
1759
def get_format_string(cls):
1760
"""See BzrDirFormat.get_format_string()."""
1761
return "Bazaar meta directory, format 1 (with colocated branches)\n"
1763
def get_format_description(self):
1764
"""See BzrDirFormat.get_format_description()."""
1765
return "Meta directory format 1 with support for colocated branches"
1767
def _open(self, transport):
1768
"""See BzrDirFormat._open."""
1769
# Create a new format instance because otherwise initialisation of new
1770
# metadirs share the global default format object leading to alias
1772
format = BzrDirMetaFormat1Colo()
1773
self._supply_sub_formats_to(format)
1774
return BzrDirMeta1(transport, format)
1777
BzrProber.formats.register(BzrDirMetaFormat1Colo.get_format_string(),
1778
BzrDirMetaFormat1Colo)
1781
class ConvertMetaToMeta(controldir.Converter):
1789
1782
"""Converts the components of metadirs."""
1791
1784
def __init__(self, target_format):
1810
1803
if not isinstance(repo._format, self.target_format.repository_format.__class__):
1811
1804
from bzrlib.repository import CopyConverter
1812
self.pb.note('starting repository conversion')
1805
ui.ui_factory.note(gettext('starting repository conversion'))
1813
1806
converter = CopyConverter(self.target_format.repository_format)
1814
1807
converter.convert(repo, pb)
1808
for branch in self.bzrdir.list_branches():
1809
# TODO: conversions of Branch and Tree should be done by
1810
# InterXFormat lookups/some sort of registry.
1811
# Avoid circular imports
1812
old = branch._format.__class__
1813
new = self.target_format.get_branch_format().__class__
1815
if (old == fullhistorybranch.BzrBranchFormat5 and
1816
new in (_mod_branch.BzrBranchFormat6,
1817
_mod_branch.BzrBranchFormat7,
1818
_mod_branch.BzrBranchFormat8)):
1819
branch_converter = _mod_branch.Converter5to6()
1820
elif (old == _mod_branch.BzrBranchFormat6 and
1821
new in (_mod_branch.BzrBranchFormat7,
1822
_mod_branch.BzrBranchFormat8)):
1823
branch_converter = _mod_branch.Converter6to7()
1824
elif (old == _mod_branch.BzrBranchFormat7 and
1825
new is _mod_branch.BzrBranchFormat8):
1826
branch_converter = _mod_branch.Converter7to8()
1828
raise errors.BadConversionTarget("No converter", new,
1830
branch_converter.convert(branch)
1831
branch = self.bzrdir.open_branch()
1832
old = branch._format.__class__
1834
tree = self.bzrdir.open_workingtree(recommend_upgrade=False)
1835
except (errors.NoWorkingTree, errors.NotLocalUrl):
1838
# TODO: conversions of Branch and Tree should be done by
1839
# InterXFormat lookups
1840
if (isinstance(tree, workingtree_3.WorkingTree3) and
1841
not isinstance(tree, workingtree_4.DirStateWorkingTree) and
1842
isinstance(self.target_format.workingtree_format,
1843
workingtree_4.DirStateWorkingTreeFormat)):
1844
workingtree_4.Converter3to4().convert(tree)
1845
if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
1846
not isinstance(tree, workingtree_4.WorkingTree5) and
1847
isinstance(self.target_format.workingtree_format,
1848
workingtree_4.WorkingTreeFormat5)):
1849
workingtree_4.Converter4to5().convert(tree)
1850
if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
1851
not isinstance(tree, workingtree_4.WorkingTree6) and
1852
isinstance(self.target_format.workingtree_format,
1853
workingtree_4.WorkingTreeFormat6)):
1854
workingtree_4.Converter4or5to6().convert(tree)
1815
1856
return to_convert
1859
class ConvertMetaToColo(controldir.Converter):
1860
"""Add colocated branch support."""
1862
def __init__(self, target_format):
1863
"""Create a converter.that upgrades a metadir to the colo format.
1865
:param target_format: The final metadir format that is desired.
1867
self.target_format = target_format
1869
def convert(self, to_convert, pb):
1870
"""See Converter.convert()."""
1871
to_convert.transport.put_bytes('branch-format',
1872
self.target_format.as_string())
1873
return BzrDir.open_from_transport(to_convert.root_transport)
1876
class ConvertMetaToColo(controldir.Converter):
1877
"""Convert a 'development-colo' bzrdir to a '2a' bzrdir."""
1879
def __init__(self, target_format):
1880
"""Create a converter that converts a 'development-colo' metadir
1883
:param target_format: The final metadir format that is desired.
1885
self.target_format = target_format
1887
def convert(self, to_convert, pb):
1888
"""See Converter.convert()."""
1889
to_convert.transport.put_bytes('branch-format',
1890
self.target_format.as_string())
1891
return BzrDir.open_from_transport(to_convert.root_transport)
1894
controldir.ControlDirFormat.register_server_prober(RemoteBzrProber)
1897
class RepositoryAcquisitionPolicy(object):
1898
"""Abstract base class for repository acquisition policies.
1900
A repository acquisition policy decides how a BzrDir acquires a repository
1901
for a branch that is being created. The most basic policy decision is
1902
whether to create a new repository or use an existing one.
1904
def __init__(self, stack_on, stack_on_pwd, require_stacking):
1907
:param stack_on: A location to stack on
1908
:param stack_on_pwd: If stack_on is relative, the location it is
1910
:param require_stacking: If True, it is a failure to not stack.
1912
self._stack_on = stack_on
1913
self._stack_on_pwd = stack_on_pwd
1914
self._require_stacking = require_stacking
1916
def configure_branch(self, branch):
1917
"""Apply any configuration data from this policy to the branch.
1919
Default implementation sets repository stacking.
1921
if self._stack_on is None:
1923
if self._stack_on_pwd is None:
1924
stack_on = self._stack_on
1927
stack_on = urlutils.rebase_url(self._stack_on,
1930
except errors.InvalidRebaseURLs:
1931
stack_on = self._get_full_stack_on()
1933
branch.set_stacked_on_url(stack_on)
1934
except (errors.UnstackableBranchFormat,
1935
errors.UnstackableRepositoryFormat):
1936
if self._require_stacking:
1939
def requires_stacking(self):
1940
"""Return True if this policy requires stacking."""
1941
return self._stack_on is not None and self._require_stacking
1943
def _get_full_stack_on(self):
1944
"""Get a fully-qualified URL for the stack_on location."""
1945
if self._stack_on is None:
1947
if self._stack_on_pwd is None:
1948
return self._stack_on
1950
return urlutils.join(self._stack_on_pwd, self._stack_on)
1952
def _add_fallback(self, repository, possible_transports=None):
1953
"""Add a fallback to the supplied repository, if stacking is set."""
1954
stack_on = self._get_full_stack_on()
1955
if stack_on is None:
1958
stacked_dir = BzrDir.open(stack_on,
1959
possible_transports=possible_transports)
1960
except errors.JailBreak:
1961
# We keep the stacking details, but we are in the server code so
1962
# actually stacking is not needed.
1965
stacked_repo = stacked_dir.open_branch().repository
1966
except errors.NotBranchError:
1967
stacked_repo = stacked_dir.open_repository()
1969
repository.add_fallback_repository(stacked_repo)
1970
except errors.UnstackableRepositoryFormat:
1971
if self._require_stacking:
1974
self._require_stacking = True
1976
def acquire_repository(self, make_working_trees=None, shared=False,
1977
possible_transports=None):
1978
"""Acquire a repository for this bzrdir.
1980
Implementations may create a new repository or use a pre-exising
1983
:param make_working_trees: If creating a repository, set
1984
make_working_trees to this value (if non-None)
1985
:param shared: If creating a repository, make it shared if True
1986
:return: A repository, is_new_flag (True if the repository was
1989
raise NotImplementedError(RepositoryAcquisitionPolicy.acquire_repository)
1992
class CreateRepository(RepositoryAcquisitionPolicy):
1993
"""A policy of creating a new repository"""
1995
def __init__(self, bzrdir, stack_on=None, stack_on_pwd=None,
1996
require_stacking=False):
1999
:param bzrdir: The bzrdir to create the repository on.
2000
:param stack_on: A location to stack on
2001
:param stack_on_pwd: If stack_on is relative, the location it is
2004
RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
2006
self._bzrdir = bzrdir
2008
def acquire_repository(self, make_working_trees=None, shared=False,
2009
possible_transports=None):
2010
"""Implementation of RepositoryAcquisitionPolicy.acquire_repository
2012
Creates the desired repository in the bzrdir we already have.
2014
if possible_transports is None:
2015
possible_transports = []
2017
possible_transports = list(possible_transports)
2018
possible_transports.append(self._bzrdir.root_transport)
2019
stack_on = self._get_full_stack_on()
2021
format = self._bzrdir._format
2022
format.require_stacking(stack_on=stack_on,
2023
possible_transports=possible_transports)
2024
if not self._require_stacking:
2025
# We have picked up automatic stacking somewhere.
2026
note(gettext('Using default stacking branch {0} at {1}').format(
2027
self._stack_on, self._stack_on_pwd))
2028
repository = self._bzrdir.create_repository(shared=shared)
2029
self._add_fallback(repository,
2030
possible_transports=possible_transports)
2031
if make_working_trees is not None:
2032
repository.set_make_working_trees(make_working_trees)
2033
return repository, True
2036
class UseExistingRepository(RepositoryAcquisitionPolicy):
2037
"""A policy of reusing an existing repository"""
2039
def __init__(self, repository, stack_on=None, stack_on_pwd=None,
2040
require_stacking=False):
2043
:param repository: The repository to use.
2044
:param stack_on: A location to stack on
2045
:param stack_on_pwd: If stack_on is relative, the location it is
2048
RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
2050
self._repository = repository
2052
def acquire_repository(self, make_working_trees=None, shared=False,
2053
possible_transports=None):
2054
"""Implementation of RepositoryAcquisitionPolicy.acquire_repository
2056
Returns an existing repository to use.
2058
if possible_transports is None:
2059
possible_transports = []
2061
possible_transports = list(possible_transports)
2062
possible_transports.append(self._repository.bzrdir.transport)
2063
self._add_fallback(self._repository,
2064
possible_transports=possible_transports)
2065
return self._repository, False
2068
def register_metadir(registry, key,
2069
repository_format, help, native=True, deprecated=False,
2074
alias=False, bzrdir_format=None):
2075
"""Register a metadir subformat.
2077
These all use a meta bzrdir, but can be parameterized by the
2078
Repository/Branch/WorkingTreeformats.
2080
:param repository_format: The fully-qualified repository format class
2082
:param branch_format: Fully-qualified branch format class name as
2084
:param tree_format: Fully-qualified tree format class name as
2087
if bzrdir_format is None:
2088
bzrdir_format = BzrDirMetaFormat1
2089
# This should be expanded to support setting WorkingTree and Branch
2090
# formats, once the API supports that.
2091
def _load(full_name):
2092
mod_name, factory_name = full_name.rsplit('.', 1)
2094
factory = pyutils.get_named_object(mod_name, factory_name)
2095
except ImportError, e:
2096
raise ImportError('failed to load %s: %s' % (full_name, e))
2097
except AttributeError:
2098
raise AttributeError('no factory %s in module %r'
2099
% (full_name, sys.modules[mod_name]))
2103
bd = bzrdir_format()
2104
if branch_format is not None:
2105
bd.set_branch_format(_load(branch_format))
2106
if tree_format is not None:
2107
bd.workingtree_format = _load(tree_format)
2108
if repository_format is not None:
2109
bd.repository_format = _load(repository_format)
2111
registry.register(key, helper, help, native, deprecated, hidden,
2112
experimental, alias)
2114
register_metadir(controldir.format_registry, 'knit',
2115
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2116
'Format using knits. Recommended for interoperation with bzr <= 0.14.',
2117
branch_format='bzrlib.branchfmt.fullhistory.BzrBranchFormat5',
2118
tree_format='bzrlib.workingtree_3.WorkingTreeFormat3',
2121
register_metadir(controldir.format_registry, 'dirstate',
2122
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2123
help='Format using dirstate for working trees. '
2124
'Compatible with bzr 0.8 and '
2125
'above when accessed over the network. Introduced in bzr 0.15.',
2126
branch_format='bzrlib.branchfmt.fullhistory.BzrBranchFormat5',
2127
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2130
register_metadir(controldir.format_registry, 'dirstate-tags',
2131
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2132
help='Variant of dirstate with support for tags. '
2133
'Introduced in bzr 0.15.',
2134
branch_format='bzrlib.branch.BzrBranchFormat6',
2135
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2138
register_metadir(controldir.format_registry, 'rich-root',
2139
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
2140
help='Variant of dirstate with better handling of tree roots. '
2141
'Introduced in bzr 1.0',
2142
branch_format='bzrlib.branch.BzrBranchFormat6',
2143
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2146
register_metadir(controldir.format_registry, 'dirstate-with-subtree',
2147
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
2148
help='Variant of dirstate with support for nested trees. '
2149
'Introduced in 0.15.',
2150
branch_format='bzrlib.branch.BzrBranchFormat6',
2151
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2155
register_metadir(controldir.format_registry, 'pack-0.92',
2156
'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack1',
2157
help='Pack-based format used in 1.x series. Introduced in 0.92. '
2158
'Interoperates with bzr repositories before 0.92 but cannot be '
2159
'read by bzr < 0.92. '
2161
branch_format='bzrlib.branch.BzrBranchFormat6',
2162
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2165
register_metadir(controldir.format_registry, 'pack-0.92-subtree',
2166
'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack3',
2167
help='Pack-based format used in 1.x series, with subtree support. '
2168
'Introduced in 0.92. Interoperates with '
2169
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
2171
branch_format='bzrlib.branch.BzrBranchFormat6',
2172
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2177
register_metadir(controldir.format_registry, 'rich-root-pack',
2178
'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack4',
2179
help='A variant of pack-0.92 that supports rich-root data '
2180
'(needed for bzr-svn and bzr-git). Introduced in 1.0.',
2181
branch_format='bzrlib.branch.BzrBranchFormat6',
2182
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2186
register_metadir(controldir.format_registry, '1.6',
2187
'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack5',
2188
help='A format that allows a branch to indicate that there is another '
2189
'(stacked) repository that should be used to access data that is '
2190
'not present locally.',
2191
branch_format='bzrlib.branch.BzrBranchFormat7',
2192
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2196
register_metadir(controldir.format_registry, '1.6.1-rich-root',
2197
'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack5RichRoot',
2198
help='A variant of 1.6 that supports rich-root data '
2199
'(needed for bzr-svn and bzr-git).',
2200
branch_format='bzrlib.branch.BzrBranchFormat7',
2201
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2205
register_metadir(controldir.format_registry, '1.9',
2206
'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6',
2207
help='A repository format using B+tree indexes. These indexes '
2208
'are smaller in size, have smarter caching and provide faster '
2209
'performance for most operations.',
2210
branch_format='bzrlib.branch.BzrBranchFormat7',
2211
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2215
register_metadir(controldir.format_registry, '1.9-rich-root',
2216
'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6RichRoot',
2217
help='A variant of 1.9 that supports rich-root data '
2218
'(needed for bzr-svn and bzr-git).',
2219
branch_format='bzrlib.branch.BzrBranchFormat7',
2220
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2224
register_metadir(controldir.format_registry, '1.14',
2225
'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6',
2226
help='A working-tree format that supports content filtering.',
2227
branch_format='bzrlib.branch.BzrBranchFormat7',
2228
tree_format='bzrlib.workingtree_4.WorkingTreeFormat5',
2232
register_metadir(controldir.format_registry, '1.14-rich-root',
2233
'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6RichRoot',
2234
help='A variant of 1.14 that supports rich-root data '
2235
'(needed for bzr-svn and bzr-git).',
2236
branch_format='bzrlib.branch.BzrBranchFormat7',
2237
tree_format='bzrlib.workingtree_4.WorkingTreeFormat5',
2241
# The following un-numbered 'development' formats should always just be aliases.
2242
register_metadir(controldir.format_registry, 'development-subtree',
2243
'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2aSubtree',
2244
help='Current development format, subtree variant. Can convert data to and '
2245
'from pack-0.92-subtree (and anything compatible with '
2246
'pack-0.92-subtree) format repositories. Repositories and branches in '
2247
'this format can only be read by bzr.dev. Please read '
2248
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
2250
branch_format='bzrlib.branch.BzrBranchFormat7',
2251
tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
2254
alias=False, # Restore to being an alias when an actual development subtree format is added
2255
# This current non-alias status is simply because we did not introduce a
2256
# chk based subtree format.
2258
register_metadir(controldir.format_registry, 'development5-subtree',
2259
'bzrlib.repofmt.knitpack_repo.RepositoryFormatPackDevelopment2Subtree',
2260
help='Development format, subtree variant. Can convert data to and '
2261
'from pack-0.92-subtree (and anything compatible with '
2262
'pack-0.92-subtree) format repositories. Repositories and branches in '
2263
'this format can only be read by bzr.dev. Please read '
2264
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
2266
branch_format='bzrlib.branch.BzrBranchFormat7',
2267
tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
2273
register_metadir(controldir.format_registry, 'development-colo',
2274
'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
2275
help='The 2a format with experimental support for colocated branches.\n',
2276
branch_format='bzrlib.branch.BzrBranchFormat7',
2277
tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
2279
bzrdir_format=BzrDirMetaFormat1Colo,
2283
# And the development formats above will have aliased one of the following:
2285
# Finally, the current format.
2286
register_metadir(controldir.format_registry, '2a',
2287
'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
2288
help='Format for the bzr 2.0 series.\n'
2289
'Uses group-compress storage.\n'
2290
'Provides rich roots which are a one-way transition.\n',
2291
# 'storage in packs, 255-way hashed CHK inventory, bencode revision, group compress, '
2292
# 'rich roots. Supported by bzr 1.16 and later.',
2293
branch_format='bzrlib.branch.BzrBranchFormat7',
2294
tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
2298
# The following format should be an alias for the rich root equivalent
2299
# of the default format
2300
register_metadir(controldir.format_registry, 'default-rich-root',
2301
'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
2302
branch_format='bzrlib.branch.BzrBranchFormat7',
2303
tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
2308
# The current format that is made on 'bzr init'.
2309
format_name = config.GlobalStack().get('default_format')
2310
controldir.format_registry.set_default(format_name)
2312
# XXX 2010-08-20 JRV: There is still a lot of code relying on
2313
# bzrlib.bzrdir.format_registry existing. When BzrDir.create/BzrDir.open/etc
2314
# get changed to ControlDir.create/ControlDir.open/etc this should be removed.
2315
format_registry = controldir.format_registry
added
removed
bzrlib/bzrdir.py
