162
93
"""Return true if this bzrdir is one whose format we can convert from."""
165
def check_conversion_target(self, target_format):
166
"""Check that a bzrdir as a whole can be converted to a new format."""
167
# The only current restriction is that the repository content can be
168
# fetched compatibly with the target.
169
target_repo_format = target_format.repository_format
171
self.open_repository()._format.check_conversion_target(
173
except errors.NoRepositoryPresent:
174
# No repo, no problem.
178
def _check_supported(format, allow_unsupported,
179
recommend_upgrade=True,
181
"""Give an error or warning on old formats.
183
:param format: may be any kind of format - workingtree, branch,
186
:param allow_unsupported: If true, allow opening
187
formats that are strongly deprecated, and which may
188
have limited functionality.
190
:param recommend_upgrade: If true (default), warn
191
the user through the ui object that they may wish
192
to upgrade the object.
97
def _check_supported(format, allow_unsupported):
98
"""Check whether format is a supported format.
100
If allow_unsupported is True, this is a no-op.
194
# TODO: perhaps move this into a base Format class; it's not BzrDir
195
# specific. mbp 20070323
196
102
if not allow_unsupported and not format.is_supported():
197
103
# see open_downlevel to open legacy branches.
198
104
raise errors.UnsupportedFormatError(format=format)
199
if recommend_upgrade \
200
and getattr(format, 'upgrade_recommended', False):
201
ui.ui_factory.recommend_upgrade(
202
format.get_format_description(),
205
def clone(self, url, revision_id=None, force_new_repo=False,
206
preserve_stacking=False):
106
def clone(self, url, revision_id=None, basis=None, force_new_repo=False):
207
107
"""Clone this bzrdir and its contents to url verbatim.
209
:param url: The url create the clone at. If url's last component does
210
not exist, it will be created.
211
:param revision_id: The tip revision-id to use for any branch or
212
working tree. If not None, then the clone operation may tune
213
itself to download less data.
214
:param force_new_repo: Do not use a shared repository for the target
215
even if one is available.
216
:param preserve_stacking: When cloning a stacked branch, stack the
217
new branch on top of the other branch's stacked-on branch.
219
return self.clone_on_transport(get_transport(url),
220
revision_id=revision_id,
221
force_new_repo=force_new_repo,
222
preserve_stacking=preserve_stacking)
224
def clone_on_transport(self, transport, revision_id=None,
225
force_new_repo=False, preserve_stacking=False, stacked_on=None,
226
create_prefix=False, use_existing_dir=True):
227
"""Clone this bzrdir and its contents to transport verbatim.
229
:param transport: The transport for the location to produce the clone
230
at. If the target directory does not exist, it will be created.
231
:param revision_id: The tip revision-id to use for any branch or
232
working tree. If not None, then the clone operation may tune
233
itself to download less data.
234
:param force_new_repo: Do not use a shared repository for the target,
235
even if one is available.
236
:param preserve_stacking: When cloning a stacked branch, stack the
237
new branch on top of the other branch's stacked-on branch.
238
:param create_prefix: Create any missing directories leading up to
240
:param use_existing_dir: Use an existing directory if one exists.
242
# Overview: put together a broad description of what we want to end up
243
# with; then make as few api calls as possible to do it.
245
# We may want to create a repo/branch/tree, if we do so what format
246
# would we want for each:
247
require_stacking = (stacked_on is not None)
248
format = self.cloning_metadir(require_stacking)
250
# Figure out what objects we want:
109
If urls last component does not exist, it will be created.
111
if revision_id is not None, then the clone operation may tune
112
itself to download less data.
113
:param force_new_repo: Do not use a shared repository for the target
114
even if one is available.
117
basis_repo, basis_branch, basis_tree = self._get_basis_components(basis)
118
result = self._format.initialize(url)
252
120
local_repo = self.find_repository()
253
121
except errors.NoRepositoryPresent:
254
122
local_repo = None
256
local_branch = self.open_branch()
257
except errors.NotBranchError:
260
# enable fallbacks when branch is not a branch reference
261
if local_branch.repository.has_same_location(local_repo):
262
local_repo = local_branch.repository
263
if preserve_stacking:
265
stacked_on = local_branch.get_stacked_on_url()
266
except (errors.UnstackableBranchFormat,
267
errors.UnstackableRepositoryFormat,
270
# Bug: We create a metadir without knowing if it can support stacking,
271
# we should look up the policy needs first, or just use it as a hint,
274
make_working_trees = local_repo.make_working_trees()
275
want_shared = local_repo.is_shared()
276
repo_format_name = format.repository_format.network_name()
278
make_working_trees = False
280
repo_format_name = None
282
result_repo, result, require_stacking, repository_policy = \
283
format.initialize_on_transport_ex(transport,
284
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
285
force_new_repo=force_new_repo, stacked_on=stacked_on,
286
stack_on_pwd=self.root_transport.base,
287
repo_format_name=repo_format_name,
288
make_working_trees=make_working_trees, shared_repo=want_shared)
291
# If the result repository is in the same place as the
292
# resulting bzr dir, it will have no content, further if the
293
# result is not stacked then we know all content should be
294
# copied, and finally if we are copying up to a specific
295
# revision_id then we can use the pending-ancestry-result which
296
# does not require traversing all of history to describe it.
297
if (result_repo.user_url == result.user_url
298
and not require_stacking and
299
revision_id is not None):
300
fetch_spec = graph.PendingAncestryResult(
301
[revision_id], local_repo)
302
result_repo.fetch(local_repo, fetch_spec=fetch_spec)
124
# may need to copy content in
126
result_repo = local_repo.clone(
128
revision_id=revision_id,
130
result_repo.set_make_working_trees(local_repo.make_working_trees())
133
result_repo = result.find_repository()
134
# fetch content this dir needs.
136
# XXX FIXME RBC 20060214 need tests for this when the basis
138
result_repo.fetch(basis_repo, revision_id=revision_id)
304
139
result_repo.fetch(local_repo, revision_id=revision_id)
308
if result_repo is not None:
309
raise AssertionError('result_repo not None(%r)' % result_repo)
140
except errors.NoRepositoryPresent:
141
# needed to make one anyway.
142
result_repo = local_repo.clone(
144
revision_id=revision_id,
146
result_repo.set_make_working_trees(local_repo.make_working_trees())
310
147
# 1 if there is a branch present
311
148
# make sure its content is available in the target repository
313
if local_branch is not None:
314
result_branch = local_branch.clone(result, revision_id=revision_id,
315
repository_policy=repository_policy)
317
# Cheaper to check if the target is not local, than to try making
319
result.root_transport.local_abspath('.')
320
if result_repo is None or result_repo.make_working_trees():
321
self.open_workingtree().clone(result)
151
self.open_branch().clone(result, revision_id=revision_id)
152
except errors.NotBranchError:
155
self.open_workingtree().clone(result, basis=basis_tree)
322
156
except (errors.NoWorkingTree, errors.NotLocalUrl):
160
def _get_basis_components(self, basis):
161
"""Retrieve the basis components that are available at basis."""
163
return None, None, None
165
basis_tree = basis.open_workingtree()
166
basis_branch = basis_tree.branch
167
basis_repo = basis_branch.repository
168
except (errors.NoWorkingTree, errors.NotLocalUrl):
171
basis_branch = basis.open_branch()
172
basis_repo = basis_branch.repository
173
except errors.NotBranchError:
176
basis_repo = basis.open_repository()
177
except errors.NoRepositoryPresent:
179
return basis_repo, basis_branch, basis_tree
326
181
# TODO: This should be given a Transport, and should chdir up; otherwise
327
182
# this will open a new connection.
328
183
def _make_tail(self, url):
329
t = get_transport(url)
184
head, tail = urlutils.split(url)
185
if tail and tail != '.':
186
t = bzrlib.transport.get_transport(head)
189
except errors.FileExists:
192
# TODO: Should take a Transport
333
def create(cls, base, format=None, possible_transports=None):
194
def create(cls, base):
334
195
"""Create a new BzrDir at the url 'base'.
197
This will call the current default formats initialize with base
198
as the only parameter.
336
:param format: If supplied, the format of branch to create. If not
337
supplied, the default is used.
338
:param possible_transports: If supplied, a list of transports that
339
can be reused to share a remote connection.
200
If you need a specific format, consider creating an instance
201
of that and calling initialize().
341
203
if cls is not BzrDir:
342
raise AssertionError("BzrDir.create always creates the default"
343
" format, not one of %r" % cls)
344
t = get_transport(base, possible_transports)
347
format = BzrDirFormat.get_default_format()
348
return format.initialize_on_transport(t)
351
def find_bzrdirs(transport, evaluate=None, list_current=None):
352
"""Find bzrdirs recursively from current location.
354
This is intended primarily as a building block for more sophisticated
355
functionality, like finding trees under a directory, or finding
356
branches that use a given repository.
357
:param evaluate: An optional callable that yields recurse, value,
358
where recurse controls whether this bzrdir is recursed into
359
and value is the value to yield. By default, all bzrdirs
360
are recursed into, and the return value is the bzrdir.
361
:param list_current: if supplied, use this function to list the current
362
directory, instead of Transport.list_dir
363
:return: a generator of found bzrdirs, or whatever evaluate returns.
365
if list_current is None:
366
def list_current(transport):
367
return transport.list_dir('')
369
def evaluate(bzrdir):
372
pending = [transport]
373
while len(pending) > 0:
374
current_transport = pending.pop()
377
bzrdir = BzrDir.open_from_transport(current_transport)
378
except errors.NotBranchError:
381
recurse, value = evaluate(bzrdir)
384
subdirs = list_current(current_transport)
385
except errors.NoSuchFile:
388
for subdir in sorted(subdirs, reverse=True):
389
pending.append(current_transport.clone(subdir))
391
def list_branches(self):
392
"""Return a sequence of all branches local to this control directory.
396
return [self.open_branch()]
397
except errors.NotBranchError:
401
def find_branches(transport):
402
"""Find all branches under a transport.
404
This will find all branches below the transport, including branches
405
inside other branches. Where possible, it will use
406
Repository.find_branches.
408
To list all the branches that use a particular Repository, see
409
Repository.find_branches
411
def evaluate(bzrdir):
413
repository = bzrdir.open_repository()
414
except errors.NoRepositoryPresent:
417
return False, ([], repository)
418
return True, (bzrdir.list_branches(), None)
420
for branches, repo in BzrDir.find_bzrdirs(transport,
423
ret.extend(repo.find_branches())
424
if branches is not None:
428
def destroy_repository(self):
429
"""Destroy the repository in this BzrDir"""
430
raise NotImplementedError(self.destroy_repository)
432
def create_branch(self, name=None):
204
raise AssertionError("BzrDir.create always creates the default format, "
205
"not one of %r" % cls)
206
head, tail = urlutils.split(base)
207
if tail and tail != '.':
208
t = bzrlib.transport.get_transport(head)
211
except errors.FileExists:
213
return BzrDirFormat.get_default_format().initialize(safe_unicode(base))
215
def create_branch(self):
433
216
"""Create a branch in this BzrDir.
435
:param name: Name of the colocated branch to create, None for
438
The bzrdir's format will control what branch format is created.
218
The bzrdirs format will control what branch format is created.
439
219
For more control see BranchFormatXX.create(a_bzrdir).
441
221
raise NotImplementedError(self.create_branch)
443
def destroy_branch(self, name=None):
444
"""Destroy a branch in this BzrDir.
446
:param name: Name of the branch to destroy, None for the default
449
raise NotImplementedError(self.destroy_branch)
452
def create_branch_and_repo(base, force_new_repo=False, format=None):
224
def create_branch_and_repo(base, force_new_repo=False):
453
225
"""Create a new BzrDir, Branch and Repository at the url 'base'.
455
This will use the current default BzrDirFormat unless one is
456
specified, and use whatever
227
This will use the current default BzrDirFormat, and use whatever
457
228
repository format that that uses via bzrdir.create_branch and
458
229
create_repository. If a shared repository is available that is used
555
265
The created Branch object is returned.
556
266
If a working tree cannot be made due to base not being a file:// url,
557
no error is raised unless force_new_tree is True, in which case no
267
no error is raised unless force_new_tree is True, in which case no
558
268
data is created on disk and NotLocalUrl is raised.
560
270
:param base: The URL to create the branch at.
561
271
:param force_new_repo: If True a new repository is always created.
562
:param force_new_tree: If True or False force creation of a tree or
272
:param force_new_tree: If True or False force creation of a tree or
563
273
prevent such creation respectively.
564
:param format: Override for the bzrdir format to create.
565
:param possible_transports: An optional reusable transports list.
274
:param format: Override for the for the bzrdir format to create
567
276
if force_new_tree:
568
277
# check for non local urls
569
t = get_transport(base, possible_transports)
570
if not isinstance(t, local.LocalTransport):
278
t = get_transport(safe_unicode(base))
279
if not isinstance(t, LocalTransport):
571
280
raise errors.NotLocalUrl(base)
572
bzrdir = BzrDir.create(base, format, possible_transports)
282
bzrdir = BzrDir.create(base)
284
bzrdir = format.initialize(base)
573
285
repo = bzrdir._find_or_create_repository(force_new_repo)
574
286
result = bzrdir.create_branch()
575
if force_new_tree or (repo.make_working_trees() and
287
if force_new_tree or (repo.make_working_trees() and
576
288
force_new_tree is None):
578
290
bzrdir.create_workingtree()
579
291
except errors.NotLocalUrl:
584
def create_standalone_workingtree(base, format=None):
296
def create_repository(base, shared=False):
297
"""Create a new BzrDir and Repository at the url 'base'.
299
This will use the current default BzrDirFormat, and use whatever
300
repository format that that uses for bzrdirformat.create_repository.
302
:param shared: Create a shared repository rather than a standalone
304
The Repository object is returned.
306
This must be overridden as an instance method in child classes, where
307
it should take no parameters and construct whatever repository format
308
that child class desires.
310
bzrdir = BzrDir.create(base)
311
return bzrdir.create_repository(shared)
314
def create_standalone_workingtree(base):
585
315
"""Create a new BzrDir, WorkingTree, Branch and Repository at 'base'.
587
317
'base' must be a local path or a file:// url.
589
This will use the current default BzrDirFormat unless one is
590
specified, and use whatever
319
This will use the current default BzrDirFormat, and use whatever
591
320
repository format that that uses for bzrdirformat.create_workingtree,
592
321
create_branch and create_repository.
594
:param format: Override for the bzrdir format to create.
595
323
:return: The WorkingTree object.
597
t = get_transport(base)
598
if not isinstance(t, local.LocalTransport):
325
t = get_transport(safe_unicode(base))
326
if not isinstance(t, LocalTransport):
599
327
raise errors.NotLocalUrl(base)
600
bzrdir = BzrDir.create_branch_and_repo(base,
602
format=format).bzrdir
328
bzrdir = BzrDir.create_branch_and_repo(safe_unicode(base),
329
force_new_repo=True).bzrdir
603
330
return bzrdir.create_workingtree()
605
def create_workingtree(self, revision_id=None, from_branch=None,
606
accelerator_tree=None, hardlink=False):
332
def create_workingtree(self, revision_id=None):
607
333
"""Create a working tree at this BzrDir.
609
:param revision_id: create it as of this revision id.
610
:param from_branch: override bzrdir branch (for lightweight checkouts)
611
:param accelerator_tree: A tree which can be used for retrieving file
612
contents more quickly than the revision tree, i.e. a workingtree.
613
The revision tree will be used for cases where accelerator_tree's
614
content is different.
335
revision_id: create it as of this revision id.
616
337
raise NotImplementedError(self.create_workingtree)
618
def backup_bzrdir(self):
619
"""Backup this bzr control directory.
339
def find_repository(self):
340
"""Find the repository that should be used for a_bzrdir.
621
:return: Tuple with old path name and new path name
342
This does not require a branch as we use it to find the repo for
343
new branches as well as to hook existing branches up to their
623
def name_gen(base='backup.bzr'):
625
name = "%s.~%d~" % (base, counter)
626
while self.root_transport.has(name):
628
name = "%s.~%d~" % (base, counter)
631
backup_dir=name_gen()
632
pb = ui.ui_factory.nested_progress_bar()
634
# FIXME: bug 300001 -- the backup fails if the backup directory
635
# already exists, but it should instead either remove it or make
636
# a new backup directory.
638
old_path = self.root_transport.abspath('.bzr')
639
new_path = self.root_transport.abspath(backup_dir)
640
ui.ui_factory.note('making backup of %s\n to %s' % (old_path, new_path,))
641
self.root_transport.copy_tree('.bzr', backup_dir)
642
return (old_path, new_path)
646
def retire_bzrdir(self, limit=10000):
647
"""Permanently disable the bzrdir.
649
This is done by renaming it to give the user some ability to recover
650
if there was a problem.
652
This will have horrible consequences if anyone has anything locked or
654
:param limit: number of times to retry
659
to_path = '.bzr.retired.%d' % i
660
self.root_transport.rename('.bzr', to_path)
661
note("renamed %s to %s"
662
% (self.root_transport.abspath('.bzr'), to_path))
664
except (errors.TransportError, IOError, errors.PathError):
671
def destroy_workingtree(self):
672
"""Destroy the working tree at this BzrDir.
674
Formats that do not support this may raise UnsupportedOperation.
676
raise NotImplementedError(self.destroy_workingtree)
678
def destroy_workingtree_metadata(self):
679
"""Destroy the control files for the working tree at this BzrDir.
681
The contents of working tree files are not affected.
682
Formats that do not support this may raise UnsupportedOperation.
684
raise NotImplementedError(self.destroy_workingtree_metadata)
686
def _find_containing(self, evaluate):
687
"""Find something in a containing control directory.
689
This method will scan containing control dirs, until it finds what
690
it is looking for, decides that it will never find it, or runs out
691
of containing control directories to check.
693
It is used to implement find_repository and
694
determine_repository_policy.
696
:param evaluate: A function returning (value, stop). If stop is True,
697
the value will be returned.
701
result, stop = evaluate(found_bzrdir)
704
next_transport = found_bzrdir.root_transport.clone('..')
705
if (found_bzrdir.user_url == next_transport.base):
706
# top of the file system
347
return self.open_repository()
348
except errors.NoRepositoryPresent:
350
next_transport = self.root_transport.clone('..')
708
352
# find the next containing bzrdir
710
354
found_bzrdir = BzrDir.open_containing_from_transport(
711
355
next_transport)[0]
712
356
except errors.NotBranchError:
715
def find_repository(self):
716
"""Find the repository that should be used.
718
This does not require a branch as we use it to find the repo for
719
new branches as well as to hook existing branches up to their
722
def usable_repository(found_bzrdir):
358
raise errors.NoRepositoryPresent(self)
723
359
# does it have a repository ?
725
361
repository = found_bzrdir.open_repository()
726
362
except errors.NoRepositoryPresent:
728
if found_bzrdir.user_url == self.user_url:
729
return repository, True
730
elif repository.is_shared():
731
return repository, True
363
next_transport = found_bzrdir.root_transport.clone('..')
364
if (found_bzrdir.root_transport.base == next_transport.base):
365
# top of the file system
369
if ((found_bzrdir.root_transport.base ==
370
self.root_transport.base) or repository.is_shared()):
735
found_repo = self._find_containing(usable_repository)
736
if found_repo is None:
737
raise errors.NoRepositoryPresent(self)
740
def get_branch_reference(self):
741
"""Return the referenced URL for the branch in this bzrdir.
743
:raises NotBranchError: If there is no Branch.
744
:return: The URL the branch in this bzrdir references if it is a
745
reference branch, or None for regular branches.
749
def get_branch_transport(self, branch_format, name=None):
373
raise errors.NoRepositoryPresent(self)
374
raise errors.NoRepositoryPresent(self)
376
def get_branch_transport(self, branch_format):
750
377
"""Get the transport for use by branch format in this BzrDir.
752
379
Note that bzr dirs that do not support format strings will raise
753
380
IncompatibleFormat if the branch format they are given has
754
381
a format string, and vice versa.
756
If branch_format is None, the transport is returned with no
757
checking. If it is not None, then the returned transport is
383
If branch_format is None, the transport is returned with no
384
checking. if it is not None, then the returned transport is
758
385
guaranteed to point to an existing directory ready for use.
760
387
raise NotImplementedError(self.get_branch_transport)
762
def _find_creation_modes(self):
763
"""Determine the appropriate modes for files and directories.
765
They're always set to be consistent with the base directory,
766
assuming that this transport allows setting modes.
768
# TODO: Do we need or want an option (maybe a config setting) to turn
769
# this off or override it for particular locations? -- mbp 20080512
770
if self._mode_check_done:
772
self._mode_check_done = True
774
st = self.transport.stat('.')
775
except errors.TransportNotPossible:
776
self._dir_mode = None
777
self._file_mode = None
779
# Check the directory mode, but also make sure the created
780
# directories and files are read-write for this user. This is
781
# mostly a workaround for filesystems which lie about being able to
782
# write to a directory (cygwin & win32)
783
if (st.st_mode & 07777 == 00000):
784
# FTP allows stat but does not return dir/file modes
785
self._dir_mode = None
786
self._file_mode = None
788
self._dir_mode = (st.st_mode & 07777) | 00700
789
# Remove the sticky and execute bits for files
790
self._file_mode = self._dir_mode & ~07111
792
def _get_file_mode(self):
793
"""Return Unix mode for newly created files, or None.
795
if not self._mode_check_done:
796
self._find_creation_modes()
797
return self._file_mode
799
def _get_dir_mode(self):
800
"""Return Unix mode for newly created directories, or None.
802
if not self._mode_check_done:
803
self._find_creation_modes()
804
return self._dir_mode
806
389
def get_repository_transport(self, repository_format):
807
390
"""Get the transport for use by repository format in this BzrDir.
1197
590
if revision_id is not None, then the clone operation may tune
1198
591
itself to download less data.
1199
:param accelerator_tree: A tree which can be used for retrieving file
1200
contents more quickly than the revision tree, i.e. a workingtree.
1201
The revision tree will be used for cases where accelerator_tree's
1202
content is different.
1203
:param hardlink: If true, hard-link files from accelerator_tree,
1205
:param stacked: If true, create a stacked branch referring to the
1206
location of this control directory.
1207
:param create_tree_if_local: If true, a working-tree will be created
1208
when working locally.
1210
target_transport = get_transport(url, possible_transports)
1211
target_transport.ensure_base()
1212
cloning_format = self.cloning_metadir(stacked)
1213
# Create/update the result branch
1214
result = cloning_format.initialize_on_transport(target_transport)
1215
# if a stacked branch wasn't requested, we don't create one
1216
# even if the origin was stacked
1217
stacked_branch_url = None
1218
if source_branch is not None:
1220
stacked_branch_url = self.root_transport.base
594
result = self._format.initialize(url)
595
basis_repo, basis_branch, basis_tree = self._get_basis_components(basis)
597
source_branch = self.open_branch()
1221
598
source_repository = source_branch.repository
1224
source_branch = self.open_branch()
1225
source_repository = source_branch.repository
1227
stacked_branch_url = self.root_transport.base
1228
except errors.NotBranchError:
1229
source_branch = None
1231
source_repository = self.open_repository()
1232
except errors.NoRepositoryPresent:
1233
source_repository = None
1234
repository_policy = result.determine_repository_policy(
1235
force_new_repo, stacked_branch_url, require_stacking=stacked)
1236
result_repo, is_new_repo = repository_policy.acquire_repository()
1237
if is_new_repo and revision_id is not None and not stacked:
1238
fetch_spec = graph.PendingAncestryResult(
1239
[revision_id], source_repository)
1242
if source_repository is not None:
1243
# Fetch while stacked to prevent unstacked fetch from
1245
if fetch_spec is None:
599
except errors.NotBranchError:
602
source_repository = self.open_repository()
603
except errors.NoRepositoryPresent:
604
# copy the entire basis one if there is one
605
# but there is no repository.
606
source_repository = basis_repo
611
result_repo = result.find_repository()
612
except errors.NoRepositoryPresent:
614
if source_repository is None and result_repo is not None:
616
elif source_repository is None and result_repo is None:
617
# no repo available, make a new one
618
result.create_repository()
619
elif source_repository is not None and result_repo is None:
620
# have source, and want to make a new target repo
621
# we don't clone the repo because that preserves attributes
622
# like is_shared(), and we have not yet implemented a
623
# repository sprout().
624
result_repo = result.create_repository()
625
if result_repo is not None:
626
# fetch needed content into target.
628
# XXX FIXME RBC 20060214 need tests for this when the basis
630
result_repo.fetch(basis_repo, revision_id=revision_id)
631
if source_repository is not None:
1246
632
result_repo.fetch(source_repository, revision_id=revision_id)
1248
result_repo.fetch(source_repository, fetch_spec=fetch_spec)
1250
if source_branch is None:
1251
# this is for sprouting a bzrdir without a branch; is that
1253
# Not especially, but it's part of the contract.
1254
result_branch = result.create_branch()
1256
result_branch = source_branch.sprout(result,
1257
revision_id=revision_id, repository_policy=repository_policy)
1258
mutter("created new branch %r" % (result_branch,))
1260
# Create/update the result working tree
1261
if (create_tree_if_local and
1262
isinstance(target_transport, local.LocalTransport) and
1263
(result_repo is None or result_repo.make_working_trees())):
1264
wt = result.create_workingtree(accelerator_tree=accelerator_tree,
1268
if wt.path2id('') is None:
1270
wt.set_root_id(self.open_workingtree.get_root_id())
1271
except errors.NoWorkingTree:
1277
if recurse == 'down':
1279
basis = wt.basis_tree()
1281
subtrees = basis.iter_references()
1282
elif result_branch is not None:
1283
basis = result_branch.basis_tree()
1285
subtrees = basis.iter_references()
1286
elif source_branch is not None:
1287
basis = source_branch.basis_tree()
1289
subtrees = basis.iter_references()
1294
for path, file_id in subtrees:
1295
target = urlutils.join(url, urlutils.escape(path))
1296
sublocation = source_branch.reference_parent(file_id, path)
1297
sublocation.bzrdir.sprout(target,
1298
basis.get_reference_revision(file_id, path),
1299
force_new_repo=force_new_repo, recurse=recurse,
1302
if basis is not None:
633
if source_branch is not None:
634
source_branch.sprout(result, revision_id=revision_id)
636
result.create_branch()
637
# TODO: jam 20060426 we probably need a test in here in the
638
# case that the newly sprouted branch is a remote one
639
if result_repo is None or result_repo.make_working_trees():
640
result.create_workingtree()
1306
def push_branch(self, source, revision_id=None, overwrite=False,
1307
remember=False, create_prefix=False):
1308
"""Push the source branch into this BzrDir."""
1310
# If we can open a branch, use its direct repository, otherwise see
1311
# if there is a repository without a branch.
1313
br_to = self.open_branch()
1314
except errors.NotBranchError:
1315
# Didn't find a branch, can we find a repository?
1316
repository_to = self.find_repository()
1318
# Found a branch, so we must have found a repository
1319
repository_to = br_to.repository
1321
push_result = PushResult()
1322
push_result.source_branch = source
1324
# We have a repository but no branch, copy the revisions, and then
1326
repository_to.fetch(source.repository, revision_id=revision_id)
1327
br_to = source.clone(self, revision_id=revision_id)
1328
if source.get_push_location() is None or remember:
1329
source.set_push_location(br_to.base)
1330
push_result.stacked_on = None
1331
push_result.branch_push_result = None
1332
push_result.old_revno = None
1333
push_result.old_revid = _mod_revision.NULL_REVISION
1334
push_result.target_branch = br_to
1335
push_result.master_branch = None
1336
push_result.workingtree_updated = False
1338
# We have successfully opened the branch, remember if necessary:
1339
if source.get_push_location() is None or remember:
1340
source.set_push_location(br_to.base)
1342
tree_to = self.open_workingtree()
1343
except errors.NotLocalUrl:
1344
push_result.branch_push_result = source.push(br_to,
1345
overwrite, stop_revision=revision_id)
1346
push_result.workingtree_updated = False
1347
except errors.NoWorkingTree:
1348
push_result.branch_push_result = source.push(br_to,
1349
overwrite, stop_revision=revision_id)
1350
push_result.workingtree_updated = None # Not applicable
1352
tree_to.lock_write()
1354
push_result.branch_push_result = source.push(
1355
tree_to.branch, overwrite, stop_revision=revision_id)
1359
push_result.workingtree_updated = True
1360
push_result.old_revno = push_result.branch_push_result.old_revno
1361
push_result.old_revid = push_result.branch_push_result.old_revid
1362
push_result.target_branch = \
1363
push_result.branch_push_result.target_branch
1367
class BzrDirHooks(hooks.Hooks):
1368
"""Hooks for BzrDir operations."""
1371
"""Create the default hooks."""
1372
hooks.Hooks.__init__(self)
1373
self.create_hook(hooks.HookPoint('pre_open',
1374
"Invoked before attempting to open a BzrDir with the transport "
1375
"that the open will use.", (1, 14), None))
1376
self.create_hook(hooks.HookPoint('post_repo_init',
1377
"Invoked after a repository has been initialized. "
1378
"post_repo_init is called with a "
1379
"bzrlib.bzrdir.RepoInitHookParams.",
1382
# install the default hooks
1383
BzrDir.hooks = BzrDirHooks()
1386
class RepoInitHookParams(object):
1387
"""Object holding parameters passed to *_repo_init hooks.
1389
There are 4 fields that hooks may wish to access:
1391
:ivar repository: Repository created
1392
:ivar format: Repository format
1393
:ivar bzrdir: The bzrdir for the repository
1394
:ivar shared: The repository is shared
1397
def __init__(self, repository, format, a_bzrdir, shared):
1398
"""Create a group of RepoInitHook parameters.
1400
:param repository: Repository created
1401
:param format: Repository format
1402
:param bzrdir: The bzrdir for the repository
1403
:param shared: The repository is shared
1405
self.repository = repository
1406
self.format = format
1407
self.bzrdir = a_bzrdir
1408
self.shared = shared
1410
def __eq__(self, other):
1411
return self.__dict__ == other.__dict__
1415
return "<%s for %s>" % (self.__class__.__name__,
1418
return "<%s for %s>" % (self.__class__.__name__,
1422
644
class BzrDirPreSplitOut(BzrDir):
1423
645
"""A common class for the all-in-one formats."""
1976
1017
current default format. In the case of plugins we can/should provide
1977
1018
some means for them to extend the range of returnable converters.
1979
:param format: Optional format to override the default format of the
1020
:param format: Optional format to override the default format of the
1982
1023
raise NotImplementedError(self.get_converter)
1984
def initialize(self, url, possible_transports=None):
1025
def initialize(self, url):
1985
1026
"""Create a bzr control dir at this url and return an opened copy.
1987
While not deprecated, this method is very specific and its use will
1988
lead to many round trips to setup a working environment. See
1989
initialize_on_transport_ex for a [nearly] all-in-one method.
1991
1028
Subclasses should typically override initialize_on_transport
1992
1029
instead of this method.
1994
return self.initialize_on_transport(get_transport(url,
1995
possible_transports))
1031
return self.initialize_on_transport(get_transport(url))
1997
1033
def initialize_on_transport(self, transport):
1998
1034
"""Initialize a new bzrdir in the base directory of a Transport."""
2000
# can we hand off the request to the smart server rather than using
2002
client_medium = transport.get_smart_medium()
2003
except errors.NoSmartMedium:
2004
return self._initialize_on_transport_vfs(transport)
2006
# Current RPC's only know how to create bzr metadir1 instances, so
2007
# we still delegate to vfs methods if the requested format is not a
2009
if type(self) != BzrDirMetaFormat1:
2010
return self._initialize_on_transport_vfs(transport)
2011
remote_format = RemoteBzrDirFormat()
2012
self._supply_sub_formats_to(remote_format)
2013
return remote_format.initialize_on_transport(transport)
2015
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
2016
create_prefix=False, force_new_repo=False, stacked_on=None,
2017
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
2018
shared_repo=False, vfs_only=False):
2019
"""Create this format on transport.
2021
The directory to initialize will be created.
2023
:param force_new_repo: Do not use a shared repository for the target,
2024
even if one is available.
2025
:param create_prefix: Create any missing directories leading up to
2027
:param use_existing_dir: Use an existing directory if one exists.
2028
:param stacked_on: A url to stack any created branch on, None to follow
2029
any target stacking policy.
2030
:param stack_on_pwd: If stack_on is relative, the location it is
2032
:param repo_format_name: If non-None, a repository will be
2033
made-or-found. Should none be found, or if force_new_repo is True
2034
the repo_format_name is used to select the format of repository to
2036
:param make_working_trees: Control the setting of make_working_trees
2037
for a new shared repository when one is made. None to use whatever
2038
default the format has.
2039
:param shared_repo: Control whether made repositories are shared or
2041
:param vfs_only: If True do not attempt to use a smart server
2042
:return: repo, bzrdir, require_stacking, repository_policy. repo is
2043
None if none was created or found, bzrdir is always valid.
2044
require_stacking is the result of examining the stacked_on
2045
parameter and any stacking policy found for the target.
2048
# Try to hand off to a smart server
2050
client_medium = transport.get_smart_medium()
2051
except errors.NoSmartMedium:
2054
# TODO: lookup the local format from a server hint.
2055
remote_dir_format = RemoteBzrDirFormat()
2056
remote_dir_format._network_name = self.network_name()
2057
self._supply_sub_formats_to(remote_dir_format)
2058
return remote_dir_format.initialize_on_transport_ex(transport,
2059
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2060
force_new_repo=force_new_repo, stacked_on=stacked_on,
2061
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2062
make_working_trees=make_working_trees, shared_repo=shared_repo)
2063
# XXX: Refactor the create_prefix/no_create_prefix code into a
2064
# common helper function
2065
# The destination may not exist - if so make it according to policy.
2066
def make_directory(transport):
2067
transport.mkdir('.')
2069
def redirected(transport, e, redirection_notice):
2070
note(redirection_notice)
2071
return transport._redirected_to(e.source, e.target)
2073
transport = do_catching_redirections(make_directory, transport,
2075
except errors.FileExists:
2076
if not use_existing_dir:
2078
except errors.NoSuchFile:
2079
if not create_prefix:
2081
transport.create_prefix()
2083
require_stacking = (stacked_on is not None)
2084
# Now the target directory exists, but doesn't have a .bzr
2085
# directory. So we need to create it, along with any work to create
2086
# all of the dependent branches, etc.
2088
result = self.initialize_on_transport(transport)
2089
if repo_format_name:
2091
# use a custom format
2092
result._format.repository_format = \
2093
repository.network_format_registry.get(repo_format_name)
2094
except AttributeError:
2095
# The format didn't permit it to be set.
2097
# A repository is desired, either in-place or shared.
2098
repository_policy = result.determine_repository_policy(
2099
force_new_repo, stacked_on, stack_on_pwd,
2100
require_stacking=require_stacking)
2101
result_repo, is_new_repo = repository_policy.acquire_repository(
2102
make_working_trees, shared_repo)
2103
if not require_stacking and repository_policy._require_stacking:
2104
require_stacking = True
2105
result._format.require_stacking()
2106
result_repo.lock_write()
2109
repository_policy = None
2110
return result_repo, result, require_stacking, repository_policy
2112
def _initialize_on_transport_vfs(self, transport):
2113
"""Initialize a new bzrdir using VFS calls.
2115
:param transport: The transport to create the .bzr directory in.
2118
# Since we are creating a .bzr directory, inherit the
1035
# Since we don't have a .bzr directory, inherit the
2119
1036
# mode from the root directory
2120
temp_control = lockable_files.LockableFiles(transport,
2121
'', lockable_files.TransportLock)
1037
temp_control = LockableFiles(transport, '', TransportLock)
2122
1038
temp_control._transport.mkdir('.bzr',
2123
1039
# FIXME: RBC 20060121 don't peek under
2125
1041
mode=temp_control._dir_mode)
2126
if sys.platform == 'win32' and isinstance(transport, local.LocalTransport):
2127
win32utils.set_file_attr_hidden(transport._abspath('.bzr'))
2128
1042
file_mode = temp_control._file_mode
2129
1043
del temp_control
2130
bzrdir_transport = transport.clone('.bzr')
2131
utf8_files = [('README',
2132
"This is a Bazaar control directory.\n"
2133
"Do not change any files in this directory.\n"
2134
"See http://bazaar-vcs.org/ for more information about Bazaar.\n"),
1044
mutter('created control directory in ' + transport.base)
1045
control = transport.clone('.bzr')
1046
utf8_files = [('README',
1047
"This is a Bazaar-NG control directory.\n"
1048
"Do not change any files in this directory.\n"),
2135
1049
('branch-format', self.get_format_string()),
2137
1051
# NB: no need to escape relative paths that are url safe.
2138
control_files = lockable_files.LockableFiles(bzrdir_transport,
2139
self._lock_file_name, self._lock_class)
1052
control_files = LockableFiles(control, self._lock_file_name,
2140
1054
control_files.create_lock()
2141
1055
control_files.lock_write()
2143
for (filename, content) in utf8_files:
2144
bzrdir_transport.put_bytes(filename, content,
1057
for file, content in utf8_files:
1058
control_files.put_utf8(file, content)
2147
1060
control_files.unlock()
2148
1061
return self.open(transport, _found=True)
3169
1849
if not isinstance(repo._format, self.target_format.repository_format.__class__):
3170
1850
from bzrlib.repository import CopyConverter
3171
ui.ui_factory.note('starting repository conversion')
1851
self.pb.note('starting repository conversion')
3172
1852
converter = CopyConverter(self.target_format.repository_format)
3173
1853
converter.convert(repo, pb)
3174
for branch in self.bzrdir.list_branches():
3175
# TODO: conversions of Branch and Tree should be done by
3176
# InterXFormat lookups/some sort of registry.
3177
# Avoid circular imports
3178
from bzrlib import branch as _mod_branch
3179
old = branch._format.__class__
3180
new = self.target_format.get_branch_format().__class__
3182
if (old == _mod_branch.BzrBranchFormat5 and
3183
new in (_mod_branch.BzrBranchFormat6,
3184
_mod_branch.BzrBranchFormat7,
3185
_mod_branch.BzrBranchFormat8)):
3186
branch_converter = _mod_branch.Converter5to6()
3187
elif (old == _mod_branch.BzrBranchFormat6 and
3188
new in (_mod_branch.BzrBranchFormat7,
3189
_mod_branch.BzrBranchFormat8)):
3190
branch_converter = _mod_branch.Converter6to7()
3191
elif (old == _mod_branch.BzrBranchFormat7 and
3192
new is _mod_branch.BzrBranchFormat8):
3193
branch_converter = _mod_branch.Converter7to8()
3195
raise errors.BadConversionTarget("No converter", new,
3197
branch_converter.convert(branch)
3198
branch = self.bzrdir.open_branch()
3199
old = branch._format.__class__
3201
tree = self.bzrdir.open_workingtree(recommend_upgrade=False)
3202
except (errors.NoWorkingTree, errors.NotLocalUrl):
3205
# TODO: conversions of Branch and Tree should be done by
3206
# InterXFormat lookups
3207
if (isinstance(tree, workingtree.WorkingTree3) and
3208
not isinstance(tree, workingtree_4.DirStateWorkingTree) and
3209
isinstance(self.target_format.workingtree_format,
3210
workingtree_4.DirStateWorkingTreeFormat)):
3211
workingtree_4.Converter3to4().convert(tree)
3212
if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
3213
not isinstance(tree, workingtree_4.WorkingTree5) and
3214
isinstance(self.target_format.workingtree_format,
3215
workingtree_4.WorkingTreeFormat5)):
3216
workingtree_4.Converter4to5().convert(tree)
3217
if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
3218
not isinstance(tree, workingtree_4.WorkingTree6) and
3219
isinstance(self.target_format.workingtree_format,
3220
workingtree_4.WorkingTreeFormat6)):
3221
workingtree_4.Converter4or5to6().convert(tree)
3223
1854
return to_convert
3226
# This is not in remote.py because it's relatively small, and needs to be
3227
# registered. Putting it in remote.py creates a circular import problem.
3228
# we can make it a lazy object if the control formats is turned into something
3230
class RemoteBzrDirFormat(BzrDirMetaFormat1):
3231
"""Format representing bzrdirs accessed via a smart server"""
3234
BzrDirMetaFormat1.__init__(self)
3235
# XXX: It's a bit ugly that the network name is here, because we'd
3236
# like to believe that format objects are stateless or at least
3237
# immutable, However, we do at least avoid mutating the name after
3238
# it's returned. See <https://bugs.edge.launchpad.net/bzr/+bug/504102>
3239
self._network_name = None
3242
return "%s(_network_name=%r)" % (self.__class__.__name__,
3245
def get_format_description(self):
3246
if self._network_name:
3247
real_format = network_format_registry.get(self._network_name)
3248
return 'Remote: ' + real_format.get_format_description()
3249
return 'bzr remote bzrdir'
3251
def get_format_string(self):
3252
raise NotImplementedError(self.get_format_string)
3254
def network_name(self):
3255
if self._network_name:
3256
return self._network_name
3258
raise AssertionError("No network name set.")
3261
def probe_transport(klass, transport):
3262
"""Return a RemoteBzrDirFormat object if it looks possible."""
3264
medium = transport.get_smart_medium()
3265
except (NotImplementedError, AttributeError,
3266
errors.TransportNotPossible, errors.NoSmartMedium,
3267
errors.SmartProtocolError):
3268
# no smart server, so not a branch for this format type.
3269
raise errors.NotBranchError(path=transport.base)
3271
# Decline to open it if the server doesn't support our required
3272
# version (3) so that the VFS-based transport will do it.
3273
if medium.should_probe():
3275
server_version = medium.protocol_version()
3276
except errors.SmartProtocolError:
3277
# Apparently there's no usable smart server there, even though
3278
# the medium supports the smart protocol.
3279
raise errors.NotBranchError(path=transport.base)
3280
if server_version != '2':
3281
raise errors.NotBranchError(path=transport.base)
3284
def initialize_on_transport(self, transport):
3286
# hand off the request to the smart server
3287
client_medium = transport.get_smart_medium()
3288
except errors.NoSmartMedium:
3289
# TODO: lookup the local format from a server hint.
3290
local_dir_format = BzrDirMetaFormat1()
3291
return local_dir_format.initialize_on_transport(transport)
3292
client = _SmartClient(client_medium)
3293
path = client.remote_path_from_transport(transport)
3295
response = client.call('BzrDirFormat.initialize', path)
3296
except errors.ErrorFromSmartServer, err:
3297
remote._translate_error(err, path=path)
3298
if response[0] != 'ok':
3299
raise errors.SmartProtocolError('unexpected response code %s' % (response,))
3300
format = RemoteBzrDirFormat()
3301
self._supply_sub_formats_to(format)
3302
return remote.RemoteBzrDir(transport, format)
3304
def parse_NoneTrueFalse(self, arg):
3311
raise AssertionError("invalid arg %r" % arg)
3313
def _serialize_NoneTrueFalse(self, arg):
3320
def _serialize_NoneString(self, arg):
3323
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
3324
create_prefix=False, force_new_repo=False, stacked_on=None,
3325
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
3328
# hand off the request to the smart server
3329
client_medium = transport.get_smart_medium()
3330
except errors.NoSmartMedium:
3333
# Decline to open it if the server doesn't support our required
3334
# version (3) so that the VFS-based transport will do it.
3335
if client_medium.should_probe():
3337
server_version = client_medium.protocol_version()
3338
if server_version != '2':
3342
except errors.SmartProtocolError:
3343
# Apparently there's no usable smart server there, even though
3344
# the medium supports the smart protocol.
3349
client = _SmartClient(client_medium)
3350
path = client.remote_path_from_transport(transport)
3351
if client_medium._is_remote_before((1, 16)):
3354
# TODO: lookup the local format from a server hint.
3355
local_dir_format = BzrDirMetaFormat1()
3356
self._supply_sub_formats_to(local_dir_format)
3357
return local_dir_format.initialize_on_transport_ex(transport,
3358
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3359
force_new_repo=force_new_repo, stacked_on=stacked_on,
3360
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3361
make_working_trees=make_working_trees, shared_repo=shared_repo,
3363
return self._initialize_on_transport_ex_rpc(client, path, transport,
3364
use_existing_dir, create_prefix, force_new_repo, stacked_on,
3365
stack_on_pwd, repo_format_name, make_working_trees, shared_repo)
3367
def _initialize_on_transport_ex_rpc(self, client, path, transport,
3368
use_existing_dir, create_prefix, force_new_repo, stacked_on,
3369
stack_on_pwd, repo_format_name, make_working_trees, shared_repo):
3371
args.append(self._serialize_NoneTrueFalse(use_existing_dir))
3372
args.append(self._serialize_NoneTrueFalse(create_prefix))
3373
args.append(self._serialize_NoneTrueFalse(force_new_repo))
3374
args.append(self._serialize_NoneString(stacked_on))
3375
# stack_on_pwd is often/usually our transport
3378
stack_on_pwd = transport.relpath(stack_on_pwd)
3379
if not stack_on_pwd:
3381
except errors.PathNotChild:
3383
args.append(self._serialize_NoneString(stack_on_pwd))
3384
args.append(self._serialize_NoneString(repo_format_name))
3385
args.append(self._serialize_NoneTrueFalse(make_working_trees))
3386
args.append(self._serialize_NoneTrueFalse(shared_repo))
3387
request_network_name = self._network_name or \
3388
BzrDirFormat.get_default_format().network_name()
3390
response = client.call('BzrDirFormat.initialize_ex_1.16',
3391
request_network_name, path, *args)
3392
except errors.UnknownSmartMethod:
3393
client._medium._remember_remote_is_before((1,16))
3394
local_dir_format = BzrDirMetaFormat1()
3395
self._supply_sub_formats_to(local_dir_format)
3396
return local_dir_format.initialize_on_transport_ex(transport,
3397
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3398
force_new_repo=force_new_repo, stacked_on=stacked_on,
3399
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3400
make_working_trees=make_working_trees, shared_repo=shared_repo,
3402
except errors.ErrorFromSmartServer, err:
3403
remote._translate_error(err, path=path)
3404
repo_path = response[0]
3405
bzrdir_name = response[6]
3406
require_stacking = response[7]
3407
require_stacking = self.parse_NoneTrueFalse(require_stacking)
3408
format = RemoteBzrDirFormat()
3409
format._network_name = bzrdir_name
3410
self._supply_sub_formats_to(format)
3411
bzrdir = remote.RemoteBzrDir(transport, format, _client=client)
3413
repo_format = remote.response_tuple_to_repo_format(response[1:])
3414
if repo_path == '.':
3417
repo_bzrdir_format = RemoteBzrDirFormat()
3418
repo_bzrdir_format._network_name = response[5]
3419
repo_bzr = remote.RemoteBzrDir(transport.clone(repo_path),
3423
final_stack = response[8] or None
3424
final_stack_pwd = response[9] or None
3426
final_stack_pwd = urlutils.join(
3427
transport.base, final_stack_pwd)
3428
remote_repo = remote.RemoteRepository(repo_bzr, repo_format)
3429
if len(response) > 10:
3430
# Updated server verb that locks remotely.
3431
repo_lock_token = response[10] or None
3432
remote_repo.lock_write(repo_lock_token, _skip_rpc=True)
3434
remote_repo.dont_leave_lock_in_place()
3436
remote_repo.lock_write()
3437
policy = UseExistingRepository(remote_repo, final_stack,
3438
final_stack_pwd, require_stacking)
3439
policy.acquire_repository()
3443
bzrdir._format.set_branch_format(self.get_branch_format())
3444
if require_stacking:
3445
# The repo has already been created, but we need to make sure that
3446
# we'll make a stackable branch.
3447
bzrdir._format.require_stacking(_skip_repo=True)
3448
return remote_repo, bzrdir, require_stacking, policy
3450
def _open(self, transport):
3451
return remote.RemoteBzrDir(transport, self)
3453
def __eq__(self, other):
3454
if not isinstance(other, RemoteBzrDirFormat):
3456
return self.get_format_description() == other.get_format_description()
3458
def __return_repository_format(self):
3459
# Always return a RemoteRepositoryFormat object, but if a specific bzr
3460
# repository format has been asked for, tell the RemoteRepositoryFormat
3461
# that it should use that for init() etc.
3462
result = remote.RemoteRepositoryFormat()
3463
custom_format = getattr(self, '_repository_format', None)
3465
if isinstance(custom_format, remote.RemoteRepositoryFormat):
3466
return custom_format
3468
# We will use the custom format to create repositories over the
3469
# wire; expose its details like rich_root_data for code to
3471
result._custom_format = custom_format
3474
def get_branch_format(self):
3475
result = BzrDirMetaFormat1.get_branch_format(self)
3476
if not isinstance(result, remote.RemoteBranchFormat):
3477
new_result = remote.RemoteBranchFormat()
3478
new_result._custom_format = result
3480
self.set_branch_format(new_result)
3484
repository_format = property(__return_repository_format,
3485
BzrDirMetaFormat1._set_repository_format) #.im_func)
3488
BzrDirFormat.register_control_server_format(RemoteBzrDirFormat)
3491
class BzrDirFormatInfo(object):
3493
def __init__(self, native, deprecated, hidden, experimental):
3494
self.deprecated = deprecated
3495
self.native = native
3496
self.hidden = hidden
3497
self.experimental = experimental
3500
class BzrDirFormatRegistry(registry.Registry):
3501
"""Registry of user-selectable BzrDir subformats.
3503
Differs from BzrDirFormat._control_formats in that it provides sub-formats,
3504
e.g. BzrDirMeta1 with weave repository. Also, it's more user-oriented.
3508
"""Create a BzrDirFormatRegistry."""
3509
self._aliases = set()
3510
self._registration_order = list()
3511
super(BzrDirFormatRegistry, self).__init__()
3514
"""Return a set of the format names which are aliases."""
3515
return frozenset(self._aliases)
3517
def register_metadir(self, key,
3518
repository_format, help, native=True, deprecated=False,
3524
"""Register a metadir subformat.
3526
These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
3527
by the Repository/Branch/WorkingTreeformats.
3529
:param repository_format: The fully-qualified repository format class
3531
:param branch_format: Fully-qualified branch format class name as
3533
:param tree_format: Fully-qualified tree format class name as
3536
# This should be expanded to support setting WorkingTree and Branch
3537
# formats, once BzrDirMetaFormat1 supports that.
3538
def _load(full_name):
3539
mod_name, factory_name = full_name.rsplit('.', 1)
3541
mod = __import__(mod_name, globals(), locals(),
3543
except ImportError, e:
3544
raise ImportError('failed to load %s: %s' % (full_name, e))
3546
factory = getattr(mod, factory_name)
3547
except AttributeError:
3548
raise AttributeError('no factory %s in module %r'
3553
bd = BzrDirMetaFormat1()
3554
if branch_format is not None:
3555
bd.set_branch_format(_load(branch_format))
3556
if tree_format is not None:
3557
bd.workingtree_format = _load(tree_format)
3558
if repository_format is not None:
3559
bd.repository_format = _load(repository_format)
3561
self.register(key, helper, help, native, deprecated, hidden,
3562
experimental, alias)
3564
def register(self, key, factory, help, native=True, deprecated=False,
3565
hidden=False, experimental=False, alias=False):
3566
"""Register a BzrDirFormat factory.
3568
The factory must be a callable that takes one parameter: the key.
3569
It must produce an instance of the BzrDirFormat when called.
3571
This function mainly exists to prevent the info object from being
3574
registry.Registry.register(self, key, factory, help,
3575
BzrDirFormatInfo(native, deprecated, hidden, experimental))
3577
self._aliases.add(key)
3578
self._registration_order.append(key)
3580
def register_lazy(self, key, module_name, member_name, help, native=True,
3581
deprecated=False, hidden=False, experimental=False, alias=False):
3582
registry.Registry.register_lazy(self, key, module_name, member_name,
3583
help, BzrDirFormatInfo(native, deprecated, hidden, experimental))
3585
self._aliases.add(key)
3586
self._registration_order.append(key)
3588
def set_default(self, key):
3589
"""Set the 'default' key to be a clone of the supplied key.
3591
This method must be called once and only once.
3593
registry.Registry.register(self, 'default', self.get(key),
3594
self.get_help(key), info=self.get_info(key))
3595
self._aliases.add('default')
3597
def set_default_repository(self, key):
3598
"""Set the FormatRegistry default and Repository default.
3600
This is a transitional method while Repository.set_default_format
3603
if 'default' in self:
3604
self.remove('default')
3605
self.set_default(key)
3606
format = self.get('default')()
3608
def make_bzrdir(self, key):
3609
return self.get(key)()
3611
def help_topic(self, topic):
3613
default_realkey = None
3614
default_help = self.get_help('default')
3616
for key in self._registration_order:
3617
if key == 'default':
3619
help = self.get_help(key)
3620
if help == default_help:
3621
default_realkey = key
3623
help_pairs.append((key, help))
3625
def wrapped(key, help, info):
3627
help = '(native) ' + help
3628
return ':%s:\n%s\n\n' % (key,
3629
textwrap.fill(help, initial_indent=' ',
3630
subsequent_indent=' ',
3631
break_long_words=False))
3632
if default_realkey is not None:
3633
output += wrapped(default_realkey, '(default) %s' % default_help,
3634
self.get_info('default'))
3635
deprecated_pairs = []
3636
experimental_pairs = []
3637
for key, help in help_pairs:
3638
info = self.get_info(key)
3641
elif info.deprecated:
3642
deprecated_pairs.append((key, help))
3643
elif info.experimental:
3644
experimental_pairs.append((key, help))
3646
output += wrapped(key, help, info)
3647
output += "\nSee :doc:`formats-help` for more about storage formats."
3649
if len(experimental_pairs) > 0:
3650
other_output += "Experimental formats are shown below.\n\n"
3651
for key, help in experimental_pairs:
3652
info = self.get_info(key)
3653
other_output += wrapped(key, help, info)
3656
"No experimental formats are available.\n\n"
3657
if len(deprecated_pairs) > 0:
3658
other_output += "\nDeprecated formats are shown below.\n\n"
3659
for key, help in deprecated_pairs:
3660
info = self.get_info(key)
3661
other_output += wrapped(key, help, info)
3664
"\nNo deprecated formats are available.\n\n"
3666
"\nSee :doc:`formats-help` for more about storage formats."
3668
if topic == 'other-formats':
3674
class RepositoryAcquisitionPolicy(object):
3675
"""Abstract base class for repository acquisition policies.
3677
A repository acquisition policy decides how a BzrDir acquires a repository
3678
for a branch that is being created. The most basic policy decision is
3679
whether to create a new repository or use an existing one.
3681
def __init__(self, stack_on, stack_on_pwd, require_stacking):
3684
:param stack_on: A location to stack on
3685
:param stack_on_pwd: If stack_on is relative, the location it is
3687
:param require_stacking: If True, it is a failure to not stack.
3689
self._stack_on = stack_on
3690
self._stack_on_pwd = stack_on_pwd
3691
self._require_stacking = require_stacking
3693
def configure_branch(self, branch):
3694
"""Apply any configuration data from this policy to the branch.
3696
Default implementation sets repository stacking.
3698
if self._stack_on is None:
3700
if self._stack_on_pwd is None:
3701
stack_on = self._stack_on
3704
stack_on = urlutils.rebase_url(self._stack_on,
3707
except errors.InvalidRebaseURLs:
3708
stack_on = self._get_full_stack_on()
3710
branch.set_stacked_on_url(stack_on)
3711
except (errors.UnstackableBranchFormat,
3712
errors.UnstackableRepositoryFormat):
3713
if self._require_stacking:
3716
def requires_stacking(self):
3717
"""Return True if this policy requires stacking."""
3718
return self._stack_on is not None and self._require_stacking
3720
def _get_full_stack_on(self):
3721
"""Get a fully-qualified URL for the stack_on location."""
3722
if self._stack_on is None:
3724
if self._stack_on_pwd is None:
3725
return self._stack_on
3727
return urlutils.join(self._stack_on_pwd, self._stack_on)
3729
def _add_fallback(self, repository, possible_transports=None):
3730
"""Add a fallback to the supplied repository, if stacking is set."""
3731
stack_on = self._get_full_stack_on()
3732
if stack_on is None:
3735
stacked_dir = BzrDir.open(stack_on,
3736
possible_transports=possible_transports)
3737
except errors.JailBreak:
3738
# We keep the stacking details, but we are in the server code so
3739
# actually stacking is not needed.
3742
stacked_repo = stacked_dir.open_branch().repository
3743
except errors.NotBranchError:
3744
stacked_repo = stacked_dir.open_repository()
3746
repository.add_fallback_repository(stacked_repo)
3747
except errors.UnstackableRepositoryFormat:
3748
if self._require_stacking:
3751
self._require_stacking = True
3753
def acquire_repository(self, make_working_trees=None, shared=False):
3754
"""Acquire a repository for this bzrdir.
3756
Implementations may create a new repository or use a pre-exising
3758
:param make_working_trees: If creating a repository, set
3759
make_working_trees to this value (if non-None)
3760
:param shared: If creating a repository, make it shared if True
3761
:return: A repository, is_new_flag (True if the repository was
3764
raise NotImplemented(RepositoryAcquisitionPolicy.acquire_repository)
3767
class CreateRepository(RepositoryAcquisitionPolicy):
3768
"""A policy of creating a new repository"""
3770
def __init__(self, bzrdir, stack_on=None, stack_on_pwd=None,
3771
require_stacking=False):
3774
:param bzrdir: The bzrdir to create the repository on.
3775
:param stack_on: A location to stack on
3776
:param stack_on_pwd: If stack_on is relative, the location it is
3779
RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
3781
self._bzrdir = bzrdir
3783
def acquire_repository(self, make_working_trees=None, shared=False):
3784
"""Implementation of RepositoryAcquisitionPolicy.acquire_repository
3786
Creates the desired repository in the bzrdir we already have.
3788
stack_on = self._get_full_stack_on()
3790
format = self._bzrdir._format
3791
format.require_stacking(stack_on=stack_on,
3792
possible_transports=[self._bzrdir.root_transport])
3793
if not self._require_stacking:
3794
# We have picked up automatic stacking somewhere.
3795
note('Using default stacking branch %s at %s', self._stack_on,
3797
repository = self._bzrdir.create_repository(shared=shared)
3798
self._add_fallback(repository,
3799
possible_transports=[self._bzrdir.transport])
3800
if make_working_trees is not None:
3801
repository.set_make_working_trees(make_working_trees)
3802
return repository, True
3805
class UseExistingRepository(RepositoryAcquisitionPolicy):
3806
"""A policy of reusing an existing repository"""
3808
def __init__(self, repository, stack_on=None, stack_on_pwd=None,
3809
require_stacking=False):
3812
:param repository: The repository to use.
3813
:param stack_on: A location to stack on
3814
:param stack_on_pwd: If stack_on is relative, the location it is
3817
RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
3819
self._repository = repository
3821
def acquire_repository(self, make_working_trees=None, shared=False):
3822
"""Implementation of RepositoryAcquisitionPolicy.acquire_repository
3824
Returns an existing repository to use.
3826
self._add_fallback(self._repository,
3827
possible_transports=[self._repository.bzrdir.transport])
3828
return self._repository, False
3831
# Please register new formats after old formats so that formats
3832
# appear in chronological order and format descriptions can build
3834
format_registry = BzrDirFormatRegistry()
3835
# The pre-0.8 formats have their repository format network name registered in
3836
# repository.py. MetaDir formats have their repository format network name
3837
# inferred from their disk format string.
3838
format_registry.register('weave', BzrDirFormat6,
3839
'Pre-0.8 format. Slower than knit and does not'
3840
' support checkouts or shared repositories.',
3843
format_registry.register_metadir('metaweave',
3844
'bzrlib.repofmt.weaverepo.RepositoryFormat7',
3845
'Transitional format in 0.8. Slower than knit.',
3846
branch_format='bzrlib.branch.BzrBranchFormat5',
3847
tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3850
format_registry.register_metadir('knit',
3851
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3852
'Format using knits. Recommended for interoperation with bzr <= 0.14.',
3853
branch_format='bzrlib.branch.BzrBranchFormat5',
3854
tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3857
format_registry.register_metadir('dirstate',
3858
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3859
help='New in 0.15: Fast local operations. Compatible with bzr 0.8 and '
3860
'above when accessed over the network.',
3861
branch_format='bzrlib.branch.BzrBranchFormat5',
3862
# this uses bzrlib.workingtree.WorkingTreeFormat4 because importing
3863
# directly from workingtree_4 triggers a circular import.
3864
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3867
format_registry.register_metadir('dirstate-tags',
3868
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3869
help='New in 0.15: Fast local operations and improved scaling for '
3870
'network operations. Additionally adds support for tags.'
3871
' Incompatible with bzr < 0.15.',
3872
branch_format='bzrlib.branch.BzrBranchFormat6',
3873
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3876
format_registry.register_metadir('rich-root',
3877
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
3878
help='New in 1.0. Better handling of tree roots. Incompatible with'
3880
branch_format='bzrlib.branch.BzrBranchFormat6',
3881
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3884
format_registry.register_metadir('dirstate-with-subtree',
3885
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
3886
help='New in 0.15: Fast local operations and improved scaling for '
3887
'network operations. Additionally adds support for versioning nested '
3888
'bzr branches. Incompatible with bzr < 0.15.',
3889
branch_format='bzrlib.branch.BzrBranchFormat6',
3890
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3894
format_registry.register_metadir('pack-0.92',
3895
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack1',
3896
help='New in 0.92: Pack-based format with data compatible with '
3897
'dirstate-tags format repositories. Interoperates with '
3898
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3900
branch_format='bzrlib.branch.BzrBranchFormat6',
3901
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3903
format_registry.register_metadir('pack-0.92-subtree',
3904
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack3',
3905
help='New in 0.92: Pack-based format with data compatible with '
3906
'dirstate-with-subtree format repositories. Interoperates with '
3907
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3909
branch_format='bzrlib.branch.BzrBranchFormat6',
3910
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3914
format_registry.register_metadir('rich-root-pack',
3915
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
3916
help='New in 1.0: A variant of pack-0.92 that supports rich-root data '
3917
'(needed for bzr-svn and bzr-git).',
3918
branch_format='bzrlib.branch.BzrBranchFormat6',
3919
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3922
format_registry.register_metadir('1.6',
3923
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5',
3924
help='A format that allows a branch to indicate that there is another '
3925
'(stacked) repository that should be used to access data that is '
3926
'not present locally.',
3927
branch_format='bzrlib.branch.BzrBranchFormat7',
3928
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3931
format_registry.register_metadir('1.6.1-rich-root',
3932
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5RichRoot',
3933
help='A variant of 1.6 that supports rich-root data '
3934
'(needed for bzr-svn and bzr-git).',
3935
branch_format='bzrlib.branch.BzrBranchFormat7',
3936
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3939
format_registry.register_metadir('1.9',
3940
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3941
help='A repository format using B+tree indexes. These indexes '
3942
'are smaller in size, have smarter caching and provide faster '
3943
'performance for most operations.',
3944
branch_format='bzrlib.branch.BzrBranchFormat7',
3945
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3948
format_registry.register_metadir('1.9-rich-root',
3949
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
3950
help='A variant of 1.9 that supports rich-root data '
3951
'(needed for bzr-svn and bzr-git).',
3952
branch_format='bzrlib.branch.BzrBranchFormat7',
3953
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3956
format_registry.register_metadir('1.14',
3957
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3958
help='A working-tree format that supports content filtering.',
3959
branch_format='bzrlib.branch.BzrBranchFormat7',
3960
tree_format='bzrlib.workingtree.WorkingTreeFormat5',
3962
format_registry.register_metadir('1.14-rich-root',
3963
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
3964
help='A variant of 1.14 that supports rich-root data '
3965
'(needed for bzr-svn and bzr-git).',
3966
branch_format='bzrlib.branch.BzrBranchFormat7',
3967
tree_format='bzrlib.workingtree.WorkingTreeFormat5',
3969
# The following un-numbered 'development' formats should always just be aliases.
3970
format_registry.register_metadir('development-rich-root',
3971
'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
3972
help='Current development format. Supports rich roots. Can convert data '
3973
'to and from rich-root-pack (and anything compatible with '
3974
'rich-root-pack) format repositories. Repositories and branches in '
3975
'this format can only be read by bzr.dev. Please read '
3976
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
3978
branch_format='bzrlib.branch.BzrBranchFormat7',
3979
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3984
format_registry.register_metadir('development-subtree',
3985
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment2Subtree',
3986
help='Current development format, subtree variant. Can convert data to and '
3987
'from pack-0.92-subtree (and anything compatible with '
3988
'pack-0.92-subtree) format repositories. Repositories and branches in '
3989
'this format can only be read by bzr.dev. Please read '
3990
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
3992
branch_format='bzrlib.branch.BzrBranchFormat7',
3993
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3996
alias=False, # Restore to being an alias when an actual development subtree format is added
3997
# This current non-alias status is simply because we did not introduce a
3998
# chk based subtree format.
4001
# And the development formats above will have aliased one of the following:
4002
format_registry.register_metadir('development6-rich-root',
4003
'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
4004
help='pack-1.9 with 255-way hashed CHK inv, group compress, rich roots '
4006
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
4008
branch_format='bzrlib.branch.BzrBranchFormat7',
4009
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4014
format_registry.register_metadir('development7-rich-root',
4015
'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK2',
4016
help='pack-1.9 with 255-way hashed CHK inv, bencode revision, group compress, '
4017
'rich roots. Please read '
4018
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
4020
branch_format='bzrlib.branch.BzrBranchFormat7',
4021
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4026
format_registry.register_metadir('2a',
4027
'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
4028
help='First format for bzr 2.0 series.\n'
4029
'Uses group-compress storage.\n'
4030
'Provides rich roots which are a one-way transition.\n',
4031
# 'storage in packs, 255-way hashed CHK inventory, bencode revision, group compress, '
4032
# 'rich roots. Supported by bzr 1.16 and later.',
4033
branch_format='bzrlib.branch.BzrBranchFormat7',
4034
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4038
# The following format should be an alias for the rich root equivalent
4039
# of the default format
4040
format_registry.register_metadir('default-rich-root',
4041
'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
4042
branch_format='bzrlib.branch.BzrBranchFormat7',
4043
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4048
# The current format that is made on 'bzr init'.
4049
format_registry.set_default('2a')
added
removed
bzrlib/bzrdir.py
