202
145
format.get_format_description(),
205
def clone(self, url, revision_id=None, force_new_repo=False,
206
preserve_stacking=False):
148
def clone(self, url, revision_id=None, force_new_repo=False):
207
149
"""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
151
If urls last component does not exist, it will be created.
153
if revision_id is not None, then the clone operation may tune
213
154
itself to download less data.
214
:param force_new_repo: Do not use a shared repository for the target
155
:param force_new_repo: Do not use a shared repository for the target
215
156
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
158
return self.clone_on_transport(get_transport(url),
220
159
revision_id=revision_id,
221
force_new_repo=force_new_repo,
222
preserve_stacking=preserve_stacking)
160
force_new_repo=force_new_repo)
224
162
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):
163
force_new_repo=False):
227
164
"""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
166
If the target directory does not exist, it will be created.
168
if revision_id is not None, then the clone operation may tune
233
169
itself to download less data.
234
:param force_new_repo: Do not use a shared repository for the target,
170
:param force_new_repo: Do not use a shared repository for the target
235
171
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:
173
transport.ensure_base()
174
result = self._format.initialize_on_transport(transport)
252
176
local_repo = self.find_repository()
253
177
except errors.NoRepositoryPresent:
254
178
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)
180
# may need to copy content in
182
result_repo = local_repo.clone(
184
revision_id=revision_id)
185
result_repo.set_make_working_trees(local_repo.make_working_trees())
188
result_repo = result.find_repository()
189
# fetch content this dir needs.
304
190
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)
191
except errors.NoRepositoryPresent:
192
# needed to make one anyway.
193
result_repo = local_repo.clone(
195
revision_id=revision_id)
196
result_repo.set_make_working_trees(local_repo.make_working_trees())
310
197
# 1 if there is a branch present
311
198
# 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)
201
self.open_branch().clone(result, revision_id=revision_id)
202
except errors.NotBranchError:
205
self.open_workingtree().clone(result)
322
206
except (errors.NoWorkingTree, errors.NotLocalUrl):
329
213
t = get_transport(url)
216
# TODO: Should take a Transport
333
def create(cls, base, format=None, possible_transports=None):
218
def create(cls, base, format=None):
334
219
"""Create a new BzrDir at the url 'base'.
221
This will call the current default formats initialize with base
222
as the only parameter.
336
224
:param format: If supplied, the format of branch to create. If not
337
225
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.
341
227
if cls is not BzrDir:
342
228
raise AssertionError("BzrDir.create always creates the default"
343
229
" format, not one of %r" % cls)
344
t = get_transport(base, possible_transports)
230
t = get_transport(base)
346
232
if format is None:
347
233
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):
234
return format.initialize(safe_unicode(base))
236
def create_branch(self):
433
237
"""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.
239
The bzrdirs format will control what branch format is created.
439
240
For more control see BranchFormatXX.create(a_bzrdir).
441
242
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
245
def create_branch_and_repo(base, force_new_repo=False, format=None):
453
246
"""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
248
This will use the current default BzrDirFormat, and use whatever
457
249
repository format that that uses via bzrdir.create_branch and
458
250
create_repository. If a shared repository is available that is used
463
255
:param base: The URL to create the branch at.
464
256
:param force_new_repo: If True a new repository is always created.
465
:param format: If supplied, the format of branch to create. If not
466
supplied, the default is used.
468
258
bzrdir = BzrDir.create(base, format)
469
259
bzrdir._find_or_create_repository(force_new_repo)
470
260
return bzrdir.create_branch()
472
def determine_repository_policy(self, force_new_repo=False, stack_on=None,
473
stack_on_pwd=None, require_stacking=False):
474
"""Return an object representing a policy to use.
476
This controls whether a new repository is created, and the format of
477
that repository, or some existing shared repository used instead.
479
If stack_on is supplied, will not seek a containing shared repo.
481
:param force_new_repo: If True, require a new repository to be created.
482
:param stack_on: If supplied, the location to stack on. If not
483
supplied, a default_stack_on location may be used.
484
:param stack_on_pwd: If stack_on is relative, the location it is
487
def repository_policy(found_bzrdir):
490
config = found_bzrdir.get_config()
492
stack_on = config.get_default_stack_on()
493
if stack_on is not None:
494
stack_on_pwd = found_bzrdir.user_url
496
# does it have a repository ?
498
repository = found_bzrdir.open_repository()
499
except errors.NoRepositoryPresent:
502
if (found_bzrdir.user_url != self.user_url
503
and not repository.is_shared()):
504
# Don't look higher, can't use a higher shared repo.
512
return UseExistingRepository(repository, stack_on,
513
stack_on_pwd, require_stacking=require_stacking), True
515
return CreateRepository(self, stack_on, stack_on_pwd,
516
require_stacking=require_stacking), True
518
if not force_new_repo:
520
policy = self._find_containing(repository_policy)
521
if policy is not None:
525
return UseExistingRepository(self.open_repository(),
526
stack_on, stack_on_pwd,
527
require_stacking=require_stacking)
528
except errors.NoRepositoryPresent:
530
return CreateRepository(self, stack_on, stack_on_pwd,
531
require_stacking=require_stacking)
533
262
def _find_or_create_repository(self, force_new_repo):
534
263
"""Create a new repository if needed, returning the repository."""
535
policy = self.determine_repository_policy(force_new_repo)
536
return policy.acquire_repository()[0]
265
return self.create_repository()
267
return self.find_repository()
268
except errors.NoRepositoryPresent:
269
return self.create_repository()
539
272
def create_branch_convenience(base, force_new_repo=False,
540
force_new_tree=None, format=None,
541
possible_transports=None):
273
force_new_tree=None, format=None):
542
274
"""Create a new BzrDir, Branch and Repository at the url 'base'.
544
276
This is a convenience function - it will use an existing repository
545
277
if possible, can be told explicitly whether to create a working tree or
548
This will use the current default BzrDirFormat unless one is
549
specified, and use whatever
280
This will use the current default BzrDirFormat, and use whatever
550
281
repository format that that uses via bzrdir.create_branch and
551
282
create_repository. If a shared repository is available that is used
552
283
preferentially. Whatever repository is used, its tree creation policy
587
336
'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
338
This will use the current default BzrDirFormat, and use whatever
591
339
repository format that that uses for bzrdirformat.create_workingtree,
592
340
create_branch and create_repository.
594
:param format: Override for the bzrdir format to create.
595
342
:return: The WorkingTree object.
597
t = get_transport(base)
598
if not isinstance(t, local.LocalTransport):
344
t = get_transport(safe_unicode(base))
345
if not isinstance(t, LocalTransport):
599
346
raise errors.NotLocalUrl(base)
600
bzrdir = BzrDir.create_branch_and_repo(base,
347
bzrdir = BzrDir.create_branch_and_repo(safe_unicode(base),
601
348
force_new_repo=True,
602
349
format=format).bzrdir
603
350
return bzrdir.create_workingtree()
605
def create_workingtree(self, revision_id=None, from_branch=None,
606
accelerator_tree=None, hardlink=False):
352
def create_workingtree(self, revision_id=None):
607
353
"""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.
355
revision_id: create it as of this revision id.
616
357
raise NotImplementedError(self.create_workingtree)
618
def backup_bzrdir(self):
619
"""Backup this bzr control directory.
621
:return: Tuple with old path name and new path name
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):
359
def retire_bzrdir(self):
647
360
"""Permanently disable the bzrdir.
649
362
This is done by renaming it to give the user some ability to recover
684
391
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.
393
def find_repository(self):
394
"""Find the repository that should be used for a_bzrdir.
396
This does not require a branch as we use it to find the repo for
397
new branches as well as to hook existing branches up to their
401
return self.open_repository()
402
except errors.NoRepositoryPresent:
404
next_transport = self.root_transport.clone('..')
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
708
406
# find the next containing bzrdir
710
408
found_bzrdir = BzrDir.open_containing_from_transport(
711
409
next_transport)[0]
712
410
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):
412
raise errors.NoRepositoryPresent(self)
723
413
# does it have a repository ?
725
415
repository = found_bzrdir.open_repository()
726
416
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
417
next_transport = found_bzrdir.root_transport.clone('..')
418
if (found_bzrdir.root_transport.base == next_transport.base):
419
# top of the file system
423
if ((found_bzrdir.root_transport.base ==
424
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, name=None):
427
raise errors.NoRepositoryPresent(self)
428
raise errors.NoRepositoryPresent(self)
430
def get_branch_reference(self):
741
431
"""Return the referenced URL for the branch in this bzrdir.
743
:param name: Optional colocated branch name
744
433
:raises NotBranchError: If there is no Branch.
745
:raises NoColocatedBranchSupport: If a branch name was specified
746
but colocated branches are not supported.
747
434
:return: The URL the branch in this bzrdir references if it is a
748
435
reference branch, or None for regular branches.
751
raise errors.NoColocatedBranchSupport(self)
754
def get_branch_transport(self, branch_format, name=None):
439
def get_branch_transport(self, branch_format):
755
440
"""Get the transport for use by branch format in this BzrDir.
757
442
Note that bzr dirs that do not support format strings will raise
758
443
IncompatibleFormat if the branch format they are given has
759
444
a format string, and vice versa.
761
If branch_format is None, the transport is returned with no
762
checking. If it is not None, then the returned transport is
446
If branch_format is None, the transport is returned with no
447
checking. if it is not None, then the returned transport is
763
448
guaranteed to point to an existing directory ready for use.
765
450
raise NotImplementedError(self.get_branch_transport)
767
def _find_creation_modes(self):
768
"""Determine the appropriate modes for files and directories.
770
They're always set to be consistent with the base directory,
771
assuming that this transport allows setting modes.
773
# TODO: Do we need or want an option (maybe a config setting) to turn
774
# this off or override it for particular locations? -- mbp 20080512
775
if self._mode_check_done:
777
self._mode_check_done = True
779
st = self.transport.stat('.')
780
except errors.TransportNotPossible:
781
self._dir_mode = None
782
self._file_mode = None
784
# Check the directory mode, but also make sure the created
785
# directories and files are read-write for this user. This is
786
# mostly a workaround for filesystems which lie about being able to
787
# write to a directory (cygwin & win32)
788
if (st.st_mode & 07777 == 00000):
789
# FTP allows stat but does not return dir/file modes
790
self._dir_mode = None
791
self._file_mode = None
793
self._dir_mode = (st.st_mode & 07777) | 00700
794
# Remove the sticky and execute bits for files
795
self._file_mode = self._dir_mode & ~07111
797
def _get_file_mode(self):
798
"""Return Unix mode for newly created files, or None.
800
if not self._mode_check_done:
801
self._find_creation_modes()
802
return self._file_mode
804
def _get_dir_mode(self):
805
"""Return Unix mode for newly created directories, or None.
807
if not self._mode_check_done:
808
self._find_creation_modes()
809
return self._dir_mode
811
452
def get_repository_transport(self, repository_format):
812
453
"""Get the transport for use by repository format in this BzrDir.
1043
637
relpath is the portion of the path that is contained by the branch.
1045
639
bzrdir, relpath = klass.open_containing(location)
1046
tree, branch = bzrdir._get_tree_branch()
641
tree = bzrdir.open_workingtree()
642
except (errors.NoWorkingTree, errors.NotLocalUrl):
644
branch = bzrdir.open_branch()
1047
647
return tree, branch, relpath
1050
def open_containing_tree_branch_or_repository(klass, location):
1051
"""Return the working tree, branch and repo contained by a location.
1053
Returns (tree, branch, repository, relpath).
1054
If there is no tree containing the location, tree will be None.
1055
If there is no branch containing the location, branch will be None.
1056
If there is no repository containing the location, repository will be
1058
relpath is the portion of the path that is contained by the innermost
1061
If no tree, branch or repository is found, a NotBranchError is raised.
1063
bzrdir, relpath = klass.open_containing(location)
1065
tree, branch = bzrdir._get_tree_branch()
1066
except errors.NotBranchError:
1068
repo = bzrdir.find_repository()
1069
return None, None, repo, relpath
1070
except (errors.NoRepositoryPresent):
1071
raise errors.NotBranchError(location)
1072
return tree, branch, branch.repository, relpath
1074
649
def open_repository(self, _unsupported=False):
1075
650
"""Open the repository object at this BzrDir if one is present.
1077
This will not follow the Branch object pointer - it's strictly a direct
652
This will not follow the Branch object pointer - its strictly a direct
1078
653
open facility. Most client code should use open_branch().repository to
1079
654
get at a repository.
1081
:param _unsupported: a private parameter, not part of the api.
656
_unsupported is a private parameter, not part of the api.
1082
657
TODO: static convenience version of this?
1084
659
raise NotImplementedError(self.open_repository)
1086
661
def open_workingtree(self, _unsupported=False,
1087
recommend_upgrade=True, from_branch=None):
662
recommend_upgrade=True):
1088
663
"""Open the workingtree object at this BzrDir if one is present.
1090
665
:param recommend_upgrade: Optional keyword parameter, when True (the
1091
666
default), emit through the ui module a recommendation that the user
1092
667
upgrade the working tree when the workingtree being opened is old
1093
668
(but still fully supported).
1094
:param from_branch: override bzrdir branch (for lightweight checkouts)
1096
670
raise NotImplementedError(self.open_workingtree)
1098
def has_branch(self, name=None):
672
def has_branch(self):
1099
673
"""Tell if this bzrdir contains a branch.
1101
675
Note: if you're going to open the branch, you should just go ahead
1102
and try, and not ask permission first. (This method just opens the
1103
branch and discards it, and that's somewhat expensive.)
676
and try, and not ask permission first. (This method just opens the
677
branch and discards it, and that's somewhat expensive.)
1106
self.open_branch(name)
1108
682
except errors.NotBranchError:
1207
761
if revision_id is not None, then the clone operation may tune
1208
762
itself to download less data.
1209
:param accelerator_tree: A tree which can be used for retrieving file
1210
contents more quickly than the revision tree, i.e. a workingtree.
1211
The revision tree will be used for cases where accelerator_tree's
1212
content is different.
1213
:param hardlink: If true, hard-link files from accelerator_tree,
1215
:param stacked: If true, create a stacked branch referring to the
1216
location of this control directory.
1217
:param create_tree_if_local: If true, a working-tree will be created
1218
when working locally.
1220
target_transport = get_transport(url, possible_transports)
764
target_transport = get_transport(url)
1221
765
target_transport.ensure_base()
1222
cloning_format = self.cloning_metadir(stacked)
1223
# Create/update the result branch
766
cloning_format = self.cloning_metadir()
1224
767
result = cloning_format.initialize_on_transport(target_transport)
1225
# if a stacked branch wasn't requested, we don't create one
1226
# even if the origin was stacked
1227
stacked_branch_url = None
1228
if source_branch is not None:
1230
stacked_branch_url = self.root_transport.base
769
source_branch = self.open_branch()
1231
770
source_repository = source_branch.repository
1234
source_branch = self.open_branch()
1235
source_repository = source_branch.repository
1237
stacked_branch_url = self.root_transport.base
1238
except errors.NotBranchError:
1239
source_branch = None
1241
source_repository = self.open_repository()
1242
except errors.NoRepositoryPresent:
1243
source_repository = None
1244
repository_policy = result.determine_repository_policy(
1245
force_new_repo, stacked_branch_url, require_stacking=stacked)
1246
result_repo, is_new_repo = repository_policy.acquire_repository()
1247
if is_new_repo and revision_id is not None and not stacked:
1248
fetch_spec = graph.PendingAncestryResult(
1249
[revision_id], source_repository)
1252
if source_repository is not None:
1253
# Fetch while stacked to prevent unstacked fetch from
1255
if fetch_spec is None:
771
except errors.NotBranchError:
774
source_repository = self.open_repository()
775
except errors.NoRepositoryPresent:
776
source_repository = None
781
result_repo = result.find_repository()
782
except errors.NoRepositoryPresent:
784
if source_repository is None and result_repo is not None:
786
elif source_repository is None and result_repo is None:
787
# no repo available, make a new one
788
result.create_repository()
789
elif source_repository is not None and result_repo is None:
790
# have source, and want to make a new target repo
791
result_repo = source_repository.sprout(result, revision_id=revision_id)
793
# fetch needed content into target.
794
if source_repository is not None:
796
# source_repository.copy_content_into(result_repo, revision_id=revision_id)
797
# so we can override the copy method
1256
798
result_repo.fetch(source_repository, revision_id=revision_id)
1258
result_repo.fetch(source_repository, fetch_spec=fetch_spec)
1260
if source_branch is None:
1261
# this is for sprouting a bzrdir without a branch; is that
1263
# Not especially, but it's part of the contract.
1264
result_branch = result.create_branch()
799
if source_branch is not None:
800
source_branch.sprout(result, revision_id=revision_id)
1266
result_branch = source_branch.sprout(result,
1267
revision_id=revision_id, repository_policy=repository_policy)
1268
mutter("created new branch %r" % (result_branch,))
1270
# Create/update the result working tree
1271
if (create_tree_if_local and
1272
isinstance(target_transport, local.LocalTransport) and
1273
(result_repo is None or result_repo.make_working_trees())):
1274
wt = result.create_workingtree(accelerator_tree=accelerator_tree,
802
result.create_branch()
803
# TODO: jam 20060426 we probably need a test in here in the
804
# case that the newly sprouted branch is a remote one
805
if result_repo is None or result_repo.make_working_trees():
806
wt = result.create_workingtree()
1278
809
if wt.path2id('') is None:
1306
835
sublocation = source_branch.reference_parent(file_id, path)
1307
836
sublocation.bzrdir.sprout(target,
1308
837
basis.get_reference_revision(file_id, path),
1309
force_new_repo=force_new_repo, recurse=recurse,
838
force_new_repo=force_new_repo, recurse=recurse)
1312
840
if basis is not None:
1316
def push_branch(self, source, revision_id=None, overwrite=False,
1317
remember=False, create_prefix=False):
1318
"""Push the source branch into this BzrDir."""
1320
# If we can open a branch, use its direct repository, otherwise see
1321
# if there is a repository without a branch.
1323
br_to = self.open_branch()
1324
except errors.NotBranchError:
1325
# Didn't find a branch, can we find a repository?
1326
repository_to = self.find_repository()
1328
# Found a branch, so we must have found a repository
1329
repository_to = br_to.repository
1331
push_result = PushResult()
1332
push_result.source_branch = source
1334
# We have a repository but no branch, copy the revisions, and then
1336
repository_to.fetch(source.repository, revision_id=revision_id)
1337
br_to = source.clone(self, revision_id=revision_id)
1338
if source.get_push_location() is None or remember:
1339
source.set_push_location(br_to.base)
1340
push_result.stacked_on = None
1341
push_result.branch_push_result = None
1342
push_result.old_revno = None
1343
push_result.old_revid = _mod_revision.NULL_REVISION
1344
push_result.target_branch = br_to
1345
push_result.master_branch = None
1346
push_result.workingtree_updated = False
1348
# We have successfully opened the branch, remember if necessary:
1349
if source.get_push_location() is None or remember:
1350
source.set_push_location(br_to.base)
1352
tree_to = self.open_workingtree()
1353
except errors.NotLocalUrl:
1354
push_result.branch_push_result = source.push(br_to,
1355
overwrite, stop_revision=revision_id)
1356
push_result.workingtree_updated = False
1357
except errors.NoWorkingTree:
1358
push_result.branch_push_result = source.push(br_to,
1359
overwrite, stop_revision=revision_id)
1360
push_result.workingtree_updated = None # Not applicable
1362
tree_to.lock_write()
1364
push_result.branch_push_result = source.push(
1365
tree_to.branch, overwrite, stop_revision=revision_id)
1369
push_result.workingtree_updated = True
1370
push_result.old_revno = push_result.branch_push_result.old_revno
1371
push_result.old_revid = push_result.branch_push_result.old_revid
1372
push_result.target_branch = \
1373
push_result.branch_push_result.target_branch
1377
class BzrDirHooks(hooks.Hooks):
1378
"""Hooks for BzrDir operations."""
1381
"""Create the default hooks."""
1382
hooks.Hooks.__init__(self)
1383
self.create_hook(hooks.HookPoint('pre_open',
1384
"Invoked before attempting to open a BzrDir with the transport "
1385
"that the open will use.", (1, 14), None))
1386
self.create_hook(hooks.HookPoint('post_repo_init',
1387
"Invoked after a repository has been initialized. "
1388
"post_repo_init is called with a "
1389
"bzrlib.bzrdir.RepoInitHookParams.",
1392
# install the default hooks
1393
BzrDir.hooks = BzrDirHooks()
1396
class RepoInitHookParams(object):
1397
"""Object holding parameters passed to *_repo_init hooks.
1399
There are 4 fields that hooks may wish to access:
1401
:ivar repository: Repository created
1402
:ivar format: Repository format
1403
:ivar bzrdir: The bzrdir for the repository
1404
:ivar shared: The repository is shared
1407
def __init__(self, repository, format, a_bzrdir, shared):
1408
"""Create a group of RepoInitHook parameters.
1410
:param repository: Repository created
1411
:param format: Repository format
1412
:param bzrdir: The bzrdir for the repository
1413
:param shared: The repository is shared
1415
self.repository = repository
1416
self.format = format
1417
self.bzrdir = a_bzrdir
1418
self.shared = shared
1420
def __eq__(self, other):
1421
return self.__dict__ == other.__dict__
1425
return "<%s for %s>" % (self.__class__.__name__,
1428
return "<%s for %s>" % (self.__class__.__name__,
1432
845
class BzrDirPreSplitOut(BzrDir):
1433
846
"""A common class for the all-in-one formats."""
1986
1286
current default format. In the case of plugins we can/should provide
1987
1287
some means for them to extend the range of returnable converters.
1989
:param format: Optional format to override the default format of the
1289
:param format: Optional format to override the default format of the
1992
1292
raise NotImplementedError(self.get_converter)
1994
def initialize(self, url, possible_transports=None):
1294
def initialize(self, url):
1995
1295
"""Create a bzr control dir at this url and return an opened copy.
1997
While not deprecated, this method is very specific and its use will
1998
lead to many round trips to setup a working environment. See
1999
initialize_on_transport_ex for a [nearly] all-in-one method.
2001
1297
Subclasses should typically override initialize_on_transport
2002
1298
instead of this method.
2004
return self.initialize_on_transport(get_transport(url,
2005
possible_transports))
1300
return self.initialize_on_transport(get_transport(url))
2007
1302
def initialize_on_transport(self, transport):
2008
1303
"""Initialize a new bzrdir in the base directory of a Transport."""
2010
# can we hand off the request to the smart server rather than using
2012
client_medium = transport.get_smart_medium()
2013
except errors.NoSmartMedium:
2014
return self._initialize_on_transport_vfs(transport)
2016
# Current RPC's only know how to create bzr metadir1 instances, so
2017
# we still delegate to vfs methods if the requested format is not a
2019
if type(self) != BzrDirMetaFormat1:
2020
return self._initialize_on_transport_vfs(transport)
2021
remote_format = RemoteBzrDirFormat()
2022
self._supply_sub_formats_to(remote_format)
2023
return remote_format.initialize_on_transport(transport)
2025
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
2026
create_prefix=False, force_new_repo=False, stacked_on=None,
2027
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
2028
shared_repo=False, vfs_only=False):
2029
"""Create this format on transport.
2031
The directory to initialize will be created.
2033
:param force_new_repo: Do not use a shared repository for the target,
2034
even if one is available.
2035
:param create_prefix: Create any missing directories leading up to
2037
:param use_existing_dir: Use an existing directory if one exists.
2038
:param stacked_on: A url to stack any created branch on, None to follow
2039
any target stacking policy.
2040
:param stack_on_pwd: If stack_on is relative, the location it is
2042
:param repo_format_name: If non-None, a repository will be
2043
made-or-found. Should none be found, or if force_new_repo is True
2044
the repo_format_name is used to select the format of repository to
2046
:param make_working_trees: Control the setting of make_working_trees
2047
for a new shared repository when one is made. None to use whatever
2048
default the format has.
2049
:param shared_repo: Control whether made repositories are shared or
2051
:param vfs_only: If True do not attempt to use a smart server
2052
:return: repo, bzrdir, require_stacking, repository_policy. repo is
2053
None if none was created or found, bzrdir is always valid.
2054
require_stacking is the result of examining the stacked_on
2055
parameter and any stacking policy found for the target.
2058
# Try to hand off to a smart server
2060
client_medium = transport.get_smart_medium()
2061
except errors.NoSmartMedium:
2064
# TODO: lookup the local format from a server hint.
2065
remote_dir_format = RemoteBzrDirFormat()
2066
remote_dir_format._network_name = self.network_name()
2067
self._supply_sub_formats_to(remote_dir_format)
2068
return remote_dir_format.initialize_on_transport_ex(transport,
2069
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2070
force_new_repo=force_new_repo, stacked_on=stacked_on,
2071
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2072
make_working_trees=make_working_trees, shared_repo=shared_repo)
2073
# XXX: Refactor the create_prefix/no_create_prefix code into a
2074
# common helper function
2075
# The destination may not exist - if so make it according to policy.
2076
def make_directory(transport):
2077
transport.mkdir('.')
2079
def redirected(transport, e, redirection_notice):
2080
note(redirection_notice)
2081
return transport._redirected_to(e.source, e.target)
2083
transport = do_catching_redirections(make_directory, transport,
2085
except errors.FileExists:
2086
if not use_existing_dir:
2088
except errors.NoSuchFile:
2089
if not create_prefix:
2091
transport.create_prefix()
2093
require_stacking = (stacked_on is not None)
2094
# Now the target directory exists, but doesn't have a .bzr
2095
# directory. So we need to create it, along with any work to create
2096
# all of the dependent branches, etc.
2098
result = self.initialize_on_transport(transport)
2099
if repo_format_name:
2101
# use a custom format
2102
result._format.repository_format = \
2103
repository.network_format_registry.get(repo_format_name)
2104
except AttributeError:
2105
# The format didn't permit it to be set.
2107
# A repository is desired, either in-place or shared.
2108
repository_policy = result.determine_repository_policy(
2109
force_new_repo, stacked_on, stack_on_pwd,
2110
require_stacking=require_stacking)
2111
result_repo, is_new_repo = repository_policy.acquire_repository(
2112
make_working_trees, shared_repo)
2113
if not require_stacking and repository_policy._require_stacking:
2114
require_stacking = True
2115
result._format.require_stacking()
2116
result_repo.lock_write()
2119
repository_policy = None
2120
return result_repo, result, require_stacking, repository_policy
2122
def _initialize_on_transport_vfs(self, transport):
2123
"""Initialize a new bzrdir using VFS calls.
2125
:param transport: The transport to create the .bzr directory in.
2128
# Since we are creating a .bzr directory, inherit the
1304
# Since we don't have a .bzr directory, inherit the
2129
1305
# mode from the root directory
2130
1306
temp_control = lockable_files.LockableFiles(transport,
2131
1307
'', lockable_files.TransportLock)
2521
1641
def set_branch_format(self, format):
2522
1642
self._branch_format = format
2524
def require_stacking(self, stack_on=None, possible_transports=None,
2526
"""We have a request to stack, try to ensure the formats support it.
2528
:param stack_on: If supplied, it is the URL to a branch that we want to
2529
stack on. Check to see if that format supports stacking before
2532
# Stacking is desired. requested by the target, but does the place it
2533
# points at support stacking? If it doesn't then we should
2534
# not implicitly upgrade. We check this here.
2535
new_repo_format = None
2536
new_branch_format = None
2538
# a bit of state for get_target_branch so that we don't try to open it
2539
# 2 times, for both repo *and* branch
2540
target = [None, False, None] # target_branch, checked, upgrade anyway
2541
def get_target_branch():
2543
# We've checked, don't check again
2545
if stack_on is None:
2546
# No target format, that means we want to force upgrading
2547
target[:] = [None, True, True]
2550
target_dir = BzrDir.open(stack_on,
2551
possible_transports=possible_transports)
2552
except errors.NotBranchError:
2553
# Nothing there, don't change formats
2554
target[:] = [None, True, False]
2556
except errors.JailBreak:
2557
# JailBreak, JFDI and upgrade anyway
2558
target[:] = [None, True, True]
2561
target_branch = target_dir.open_branch()
2562
except errors.NotBranchError:
2563
# No branch, don't upgrade formats
2564
target[:] = [None, True, False]
2566
target[:] = [target_branch, True, False]
2569
if (not _skip_repo and
2570
not self.repository_format.supports_external_lookups):
2571
# We need to upgrade the Repository.
2572
target_branch, _, do_upgrade = get_target_branch()
2573
if target_branch is None:
2574
# We don't have a target branch, should we upgrade anyway?
2576
# stack_on is inaccessible, JFDI.
2577
# TODO: bad monkey, hard-coded formats...
2578
if self.repository_format.rich_root_data:
2579
new_repo_format = pack_repo.RepositoryFormatKnitPack5RichRoot()
2581
new_repo_format = pack_repo.RepositoryFormatKnitPack5()
2583
# If the target already supports stacking, then we know the
2584
# project is already able to use stacking, so auto-upgrade
2586
new_repo_format = target_branch.repository._format
2587
if not new_repo_format.supports_external_lookups:
2588
# target doesn't, source doesn't, so don't auto upgrade
2590
new_repo_format = None
2591
if new_repo_format is not None:
2592
self.repository_format = new_repo_format
2593
note('Source repository format does not support stacking,'
2594
' using format:\n %s',
2595
new_repo_format.get_format_description())
2597
if not self.get_branch_format().supports_stacking():
2598
# We just checked the repo, now lets check if we need to
2599
# upgrade the branch format
2600
target_branch, _, do_upgrade = get_target_branch()
2601
if target_branch is None:
2603
# TODO: bad monkey, hard-coded formats...
2604
new_branch_format = branch.BzrBranchFormat7()
2606
new_branch_format = target_branch._format
2607
if not new_branch_format.supports_stacking():
2608
new_branch_format = None
2609
if new_branch_format is not None:
2610
# Does support stacking, use its format.
2611
self.set_branch_format(new_branch_format)
2612
note('Source branch format does not support stacking,'
2613
' using format:\n %s',
2614
new_branch_format.get_format_description())
2616
1644
def get_converter(self, format=None):
2617
1645
"""See BzrDirFormat.get_converter()."""
2618
1646
if format is None:
3222
2218
# TODO: conversions of Branch and Tree should be done by
3223
2219
# InterXFormat lookups
3224
2220
if (isinstance(tree, workingtree.WorkingTree3) and
3225
not isinstance(tree, workingtree_4.DirStateWorkingTree) and
2221
not isinstance(tree, workingtree_4.WorkingTree4) and
3226
2222
isinstance(self.target_format.workingtree_format,
3227
workingtree_4.DirStateWorkingTreeFormat)):
2223
workingtree_4.WorkingTreeFormat4)):
3228
2224
workingtree_4.Converter3to4().convert(tree)
3229
if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
3230
not isinstance(tree, workingtree_4.WorkingTree5) and
3231
isinstance(self.target_format.workingtree_format,
3232
workingtree_4.WorkingTreeFormat5)):
3233
workingtree_4.Converter4to5().convert(tree)
3234
if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
3235
not isinstance(tree, workingtree_4.WorkingTree6) and
3236
isinstance(self.target_format.workingtree_format,
3237
workingtree_4.WorkingTreeFormat6)):
3238
workingtree_4.Converter4or5to6().convert(tree)
3240
2225
return to_convert
3243
# This is not in remote.py because it's relatively small, and needs to be
3244
# registered. Putting it in remote.py creates a circular import problem.
2228
# This is not in remote.py because it's small, and needs to be registered.
2229
# Putting it in remote.py creates a circular import problem.
3245
2230
# we can make it a lazy object if the control formats is turned into something
3246
2231
# like a registry.
3247
2232
class RemoteBzrDirFormat(BzrDirMetaFormat1):
3248
2233
"""Format representing bzrdirs accessed via a smart server"""
3251
BzrDirMetaFormat1.__init__(self)
3252
# XXX: It's a bit ugly that the network name is here, because we'd
3253
# like to believe that format objects are stateless or at least
3254
# immutable, However, we do at least avoid mutating the name after
3255
# it's returned. See <https://bugs.launchpad.net/bzr/+bug/504102>
3256
self._network_name = None
3259
return "%s(_network_name=%r)" % (self.__class__.__name__,
3262
2235
def get_format_description(self):
3263
if self._network_name:
3264
real_format = network_format_registry.get(self._network_name)
3265
return 'Remote: ' + real_format.get_format_description()
3266
2236
return 'bzr remote bzrdir'
3268
def get_format_string(self):
3269
raise NotImplementedError(self.get_format_string)
3271
def network_name(self):
3272
if self._network_name:
3273
return self._network_name
3275
raise AssertionError("No network name set.")
3278
2239
def probe_transport(klass, transport):
3279
2240
"""Return a RemoteBzrDirFormat object if it looks possible."""
3281
medium = transport.get_smart_medium()
2242
client = transport.get_smart_client()
3282
2243
except (NotImplementedError, AttributeError,
3283
errors.TransportNotPossible, errors.NoSmartMedium,
3284
errors.SmartProtocolError):
2244
errors.TransportNotPossible):
3285
2245
# no smart server, so not a branch for this format type.
3286
2246
raise errors.NotBranchError(path=transport.base)
3288
# Decline to open it if the server doesn't support our required
3289
# version (3) so that the VFS-based transport will do it.
3290
if medium.should_probe():
3292
server_version = medium.protocol_version()
3293
except errors.SmartProtocolError:
3294
# Apparently there's no usable smart server there, even though
3295
# the medium supports the smart protocol.
3296
raise errors.NotBranchError(path=transport.base)
3297
if server_version != '2':
3298
raise errors.NotBranchError(path=transport.base)
2248
# Send a 'hello' request in protocol version one, and decline to
2249
# open it if the server doesn't support our required version (2) so
2250
# that the VFS-based transport will do it.
2251
request = client.get_request()
2252
smart_protocol = protocol.SmartClientRequestProtocolOne(request)
2253
server_version = smart_protocol.query_version()
2254
if server_version != 2:
2255
raise errors.NotBranchError(path=transport.base)
3301
2258
def initialize_on_transport(self, transport):
3303
2260
# hand off the request to the smart server
3304
client_medium = transport.get_smart_medium()
2261
medium = transport.get_smart_medium()
3305
2262
except errors.NoSmartMedium:
3306
2263
# TODO: lookup the local format from a server hint.
3307
2264
local_dir_format = BzrDirMetaFormat1()
3308
2265
return local_dir_format.initialize_on_transport(transport)
3309
client = _SmartClient(client_medium)
2266
client = _SmartClient(medium)
3310
2267
path = client.remote_path_from_transport(transport)
3312
response = client.call('BzrDirFormat.initialize', path)
3313
except errors.ErrorFromSmartServer, err:
3314
remote._translate_error(err, path=path)
3315
if response[0] != 'ok':
3316
raise errors.SmartProtocolError('unexpected response code %s' % (response,))
3317
format = RemoteBzrDirFormat()
3318
self._supply_sub_formats_to(format)
3319
return remote.RemoteBzrDir(transport, format)
3321
def parse_NoneTrueFalse(self, arg):
3328
raise AssertionError("invalid arg %r" % arg)
3330
def _serialize_NoneTrueFalse(self, arg):
3337
def _serialize_NoneString(self, arg):
3340
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
3341
create_prefix=False, force_new_repo=False, stacked_on=None,
3342
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
3345
# hand off the request to the smart server
3346
client_medium = transport.get_smart_medium()
3347
except errors.NoSmartMedium:
3350
# Decline to open it if the server doesn't support our required
3351
# version (3) so that the VFS-based transport will do it.
3352
if client_medium.should_probe():
3354
server_version = client_medium.protocol_version()
3355
if server_version != '2':
3359
except errors.SmartProtocolError:
3360
# Apparently there's no usable smart server there, even though
3361
# the medium supports the smart protocol.
3366
client = _SmartClient(client_medium)
3367
path = client.remote_path_from_transport(transport)
3368
if client_medium._is_remote_before((1, 16)):
3371
# TODO: lookup the local format from a server hint.
3372
local_dir_format = BzrDirMetaFormat1()
3373
self._supply_sub_formats_to(local_dir_format)
3374
return local_dir_format.initialize_on_transport_ex(transport,
3375
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3376
force_new_repo=force_new_repo, stacked_on=stacked_on,
3377
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3378
make_working_trees=make_working_trees, shared_repo=shared_repo,
3380
return self._initialize_on_transport_ex_rpc(client, path, transport,
3381
use_existing_dir, create_prefix, force_new_repo, stacked_on,
3382
stack_on_pwd, repo_format_name, make_working_trees, shared_repo)
3384
def _initialize_on_transport_ex_rpc(self, client, path, transport,
3385
use_existing_dir, create_prefix, force_new_repo, stacked_on,
3386
stack_on_pwd, repo_format_name, make_working_trees, shared_repo):
3388
args.append(self._serialize_NoneTrueFalse(use_existing_dir))
3389
args.append(self._serialize_NoneTrueFalse(create_prefix))
3390
args.append(self._serialize_NoneTrueFalse(force_new_repo))
3391
args.append(self._serialize_NoneString(stacked_on))
3392
# stack_on_pwd is often/usually our transport
3395
stack_on_pwd = transport.relpath(stack_on_pwd)
3396
if not stack_on_pwd:
3398
except errors.PathNotChild:
3400
args.append(self._serialize_NoneString(stack_on_pwd))
3401
args.append(self._serialize_NoneString(repo_format_name))
3402
args.append(self._serialize_NoneTrueFalse(make_working_trees))
3403
args.append(self._serialize_NoneTrueFalse(shared_repo))
3404
request_network_name = self._network_name or \
3405
BzrDirFormat.get_default_format().network_name()
3407
response = client.call('BzrDirFormat.initialize_ex_1.16',
3408
request_network_name, path, *args)
3409
except errors.UnknownSmartMethod:
3410
client._medium._remember_remote_is_before((1,16))
3411
local_dir_format = BzrDirMetaFormat1()
3412
self._supply_sub_formats_to(local_dir_format)
3413
return local_dir_format.initialize_on_transport_ex(transport,
3414
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3415
force_new_repo=force_new_repo, stacked_on=stacked_on,
3416
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3417
make_working_trees=make_working_trees, shared_repo=shared_repo,
3419
except errors.ErrorFromSmartServer, err:
3420
remote._translate_error(err, path=path)
3421
repo_path = response[0]
3422
bzrdir_name = response[6]
3423
require_stacking = response[7]
3424
require_stacking = self.parse_NoneTrueFalse(require_stacking)
3425
format = RemoteBzrDirFormat()
3426
format._network_name = bzrdir_name
3427
self._supply_sub_formats_to(format)
3428
bzrdir = remote.RemoteBzrDir(transport, format, _client=client)
3430
repo_format = remote.response_tuple_to_repo_format(response[1:])
3431
if repo_path == '.':
3434
repo_bzrdir_format = RemoteBzrDirFormat()
3435
repo_bzrdir_format._network_name = response[5]
3436
repo_bzr = remote.RemoteBzrDir(transport.clone(repo_path),
3440
final_stack = response[8] or None
3441
final_stack_pwd = response[9] or None
3443
final_stack_pwd = urlutils.join(
3444
transport.base, final_stack_pwd)
3445
remote_repo = remote.RemoteRepository(repo_bzr, repo_format)
3446
if len(response) > 10:
3447
# Updated server verb that locks remotely.
3448
repo_lock_token = response[10] or None
3449
remote_repo.lock_write(repo_lock_token, _skip_rpc=True)
3451
remote_repo.dont_leave_lock_in_place()
3453
remote_repo.lock_write()
3454
policy = UseExistingRepository(remote_repo, final_stack,
3455
final_stack_pwd, require_stacking)
3456
policy.acquire_repository()
3460
bzrdir._format.set_branch_format(self.get_branch_format())
3461
if require_stacking:
3462
# The repo has already been created, but we need to make sure that
3463
# we'll make a stackable branch.
3464
bzrdir._format.require_stacking(_skip_repo=True)
3465
return remote_repo, bzrdir, require_stacking, policy
2268
response = _SmartClient(medium).call('BzrDirFormat.initialize', path)
2269
assert response[0] in ('ok', ), 'unexpected response code %s' % (response,)
2270
return remote.RemoteBzrDir(transport)
3467
2272
def _open(self, transport):
3468
return remote.RemoteBzrDir(transport, self)
2273
return remote.RemoteBzrDir(transport)
3470
2275
def __eq__(self, other):
3471
2276
if not isinstance(other, RemoteBzrDirFormat):
3473
2278
return self.get_format_description() == other.get_format_description()
3475
def __return_repository_format(self):
3476
# Always return a RemoteRepositoryFormat object, but if a specific bzr
3477
# repository format has been asked for, tell the RemoteRepositoryFormat
3478
# that it should use that for init() etc.
3479
result = remote.RemoteRepositoryFormat()
3480
custom_format = getattr(self, '_repository_format', None)
3482
if isinstance(custom_format, remote.RemoteRepositoryFormat):
3483
return custom_format
3485
# We will use the custom format to create repositories over the
3486
# wire; expose its details like rich_root_data for code to
3488
result._custom_format = custom_format
3491
def get_branch_format(self):
3492
result = BzrDirMetaFormat1.get_branch_format(self)
3493
if not isinstance(result, remote.RemoteBranchFormat):
3494
new_result = remote.RemoteBranchFormat()
3495
new_result._custom_format = result
3497
self.set_branch_format(new_result)
3501
repository_format = property(__return_repository_format,
3502
BzrDirMetaFormat1._set_repository_format) #.im_func)
3505
2281
BzrDirFormat.register_control_server_format(RemoteBzrDirFormat)
3508
2284
class BzrDirFormatInfo(object):
3510
def __init__(self, native, deprecated, hidden, experimental):
2286
def __init__(self, native, deprecated, hidden):
3511
2287
self.deprecated = deprecated
3512
2288
self.native = native
3513
2289
self.hidden = hidden
3514
self.experimental = experimental
3517
2292
class BzrDirFormatRegistry(registry.Registry):
3518
2293
"""Registry of user-selectable BzrDir subformats.
3520
2295
Differs from BzrDirFormat._control_formats in that it provides sub-formats,
3521
2296
e.g. BzrDirMeta1 with weave repository. Also, it's more user-oriented.
3525
"""Create a BzrDirFormatRegistry."""
3526
self._aliases = set()
3527
self._registration_order = list()
3528
super(BzrDirFormatRegistry, self).__init__()
3531
"""Return a set of the format names which are aliases."""
3532
return frozenset(self._aliases)
3534
2299
def register_metadir(self, key,
3535
2300
repository_format, help, native=True, deprecated=False,
3536
2301
branch_format=None,
3537
2302
tree_format=None,
3541
2304
"""Register a metadir subformat.
3543
2306
These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
3544
by the Repository/Branch/WorkingTreeformats.
2307
by the Repository format.
3546
2309
:param repository_format: The fully-qualified repository format class
3547
2310
name as a string.
3575
2338
if repository_format is not None:
3576
2339
bd.repository_format = _load(repository_format)
3578
self.register(key, helper, help, native, deprecated, hidden,
3579
experimental, alias)
2341
self.register(key, helper, help, native, deprecated, hidden)
3581
2343
def register(self, key, factory, help, native=True, deprecated=False,
3582
hidden=False, experimental=False, alias=False):
3583
2345
"""Register a BzrDirFormat factory.
3585
2347
The factory must be a callable that takes one parameter: the key.
3586
2348
It must produce an instance of the BzrDirFormat when called.
3588
2350
This function mainly exists to prevent the info object from being
3589
2351
supplied directly.
3591
registry.Registry.register(self, key, factory, help,
3592
BzrDirFormatInfo(native, deprecated, hidden, experimental))
3594
self._aliases.add(key)
3595
self._registration_order.append(key)
2353
registry.Registry.register(self, key, factory, help,
2354
BzrDirFormatInfo(native, deprecated, hidden))
3597
2356
def register_lazy(self, key, module_name, member_name, help, native=True,
3598
deprecated=False, hidden=False, experimental=False, alias=False):
3599
registry.Registry.register_lazy(self, key, module_name, member_name,
3600
help, BzrDirFormatInfo(native, deprecated, hidden, experimental))
3602
self._aliases.add(key)
3603
self._registration_order.append(key)
2357
deprecated=False, hidden=False):
2358
registry.Registry.register_lazy(self, key, module_name, member_name,
2359
help, BzrDirFormatInfo(native, deprecated, hidden))
3605
2361
def set_default(self, key):
3606
2362
"""Set the 'default' key to be a clone of the supplied key.
3608
2364
This method must be called once and only once.
3610
registry.Registry.register(self, 'default', self.get(key),
2366
registry.Registry.register(self, 'default', self.get(key),
3611
2367
self.get_help(key), info=self.get_info(key))
3612
self._aliases.add('default')
3614
2369
def set_default_repository(self, key):
3615
2370
"""Set the FormatRegistry default and Repository default.
3617
2372
This is a transitional method while Repository.set_default_format
3642
2404
def wrapped(key, help, info):
3643
2405
if info.native:
3644
2406
help = '(native) ' + help
3645
return ':%s:\n%s\n\n' % (key,
3646
textwrap.fill(help, initial_indent=' ',
3647
subsequent_indent=' ',
3648
break_long_words=False))
3649
if default_realkey is not None:
3650
output += wrapped(default_realkey, '(default) %s' % default_help,
3651
self.get_info('default'))
2407
return ' %s:\n%s\n\n' % (key,
2408
textwrap.fill(help, initial_indent=' ',
2409
subsequent_indent=' '))
2410
output += wrapped('%s/default' % default_realkey, default_help,
2411
self.get_info('default'))
3652
2412
deprecated_pairs = []
3653
experimental_pairs = []
3654
2413
for key, help in help_pairs:
3655
2414
info = self.get_info(key)
3656
2415
if info.hidden:
3658
2417
elif info.deprecated:
3659
2418
deprecated_pairs.append((key, help))
3660
elif info.experimental:
3661
experimental_pairs.append((key, help))
3663
2420
output += wrapped(key, help, info)
3664
output += "\nSee :doc:`formats-help` for more about storage formats."
3666
if len(experimental_pairs) > 0:
3667
other_output += "Experimental formats are shown below.\n\n"
3668
for key, help in experimental_pairs:
3669
info = self.get_info(key)
3670
other_output += wrapped(key, help, info)
3673
"No experimental formats are available.\n\n"
3674
2421
if len(deprecated_pairs) > 0:
3675
other_output += "\nDeprecated formats are shown below.\n\n"
2422
output += "Deprecated formats\n------------------\n\n"
3676
2423
for key, help in deprecated_pairs:
3677
2424
info = self.get_info(key)
3678
other_output += wrapped(key, help, info)
3681
"\nNo deprecated formats are available.\n\n"
3683
"\nSee :doc:`formats-help` for more about storage formats."
3685
if topic == 'other-formats':
3691
class RepositoryAcquisitionPolicy(object):
3692
"""Abstract base class for repository acquisition policies.
3694
A repository acquisition policy decides how a BzrDir acquires a repository
3695
for a branch that is being created. The most basic policy decision is
3696
whether to create a new repository or use an existing one.
3698
def __init__(self, stack_on, stack_on_pwd, require_stacking):
3701
:param stack_on: A location to stack on
3702
:param stack_on_pwd: If stack_on is relative, the location it is
3704
:param require_stacking: If True, it is a failure to not stack.
3706
self._stack_on = stack_on
3707
self._stack_on_pwd = stack_on_pwd
3708
self._require_stacking = require_stacking
3710
def configure_branch(self, branch):
3711
"""Apply any configuration data from this policy to the branch.
3713
Default implementation sets repository stacking.
3715
if self._stack_on is None:
3717
if self._stack_on_pwd is None:
3718
stack_on = self._stack_on
3721
stack_on = urlutils.rebase_url(self._stack_on,
3724
except errors.InvalidRebaseURLs:
3725
stack_on = self._get_full_stack_on()
3727
branch.set_stacked_on_url(stack_on)
3728
except (errors.UnstackableBranchFormat,
3729
errors.UnstackableRepositoryFormat):
3730
if self._require_stacking:
3733
def requires_stacking(self):
3734
"""Return True if this policy requires stacking."""
3735
return self._stack_on is not None and self._require_stacking
3737
def _get_full_stack_on(self):
3738
"""Get a fully-qualified URL for the stack_on location."""
3739
if self._stack_on is None:
3741
if self._stack_on_pwd is None:
3742
return self._stack_on
3744
return urlutils.join(self._stack_on_pwd, self._stack_on)
3746
def _add_fallback(self, repository, possible_transports=None):
3747
"""Add a fallback to the supplied repository, if stacking is set."""
3748
stack_on = self._get_full_stack_on()
3749
if stack_on is None:
3752
stacked_dir = BzrDir.open(stack_on,
3753
possible_transports=possible_transports)
3754
except errors.JailBreak:
3755
# We keep the stacking details, but we are in the server code so
3756
# actually stacking is not needed.
3759
stacked_repo = stacked_dir.open_branch().repository
3760
except errors.NotBranchError:
3761
stacked_repo = stacked_dir.open_repository()
3763
repository.add_fallback_repository(stacked_repo)
3764
except errors.UnstackableRepositoryFormat:
3765
if self._require_stacking:
3768
self._require_stacking = True
3770
def acquire_repository(self, make_working_trees=None, shared=False):
3771
"""Acquire a repository for this bzrdir.
3773
Implementations may create a new repository or use a pre-exising
3775
:param make_working_trees: If creating a repository, set
3776
make_working_trees to this value (if non-None)
3777
:param shared: If creating a repository, make it shared if True
3778
:return: A repository, is_new_flag (True if the repository was
3781
raise NotImplemented(RepositoryAcquisitionPolicy.acquire_repository)
3784
class CreateRepository(RepositoryAcquisitionPolicy):
3785
"""A policy of creating a new repository"""
3787
def __init__(self, bzrdir, stack_on=None, stack_on_pwd=None,
3788
require_stacking=False):
3791
:param bzrdir: The bzrdir to create the repository on.
3792
:param stack_on: A location to stack on
3793
:param stack_on_pwd: If stack_on is relative, the location it is
3796
RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
3798
self._bzrdir = bzrdir
3800
def acquire_repository(self, make_working_trees=None, shared=False):
3801
"""Implementation of RepositoryAcquisitionPolicy.acquire_repository
3803
Creates the desired repository in the bzrdir we already have.
3805
stack_on = self._get_full_stack_on()
3807
format = self._bzrdir._format
3808
format.require_stacking(stack_on=stack_on,
3809
possible_transports=[self._bzrdir.root_transport])
3810
if not self._require_stacking:
3811
# We have picked up automatic stacking somewhere.
3812
note('Using default stacking branch %s at %s', self._stack_on,
3814
repository = self._bzrdir.create_repository(shared=shared)
3815
self._add_fallback(repository,
3816
possible_transports=[self._bzrdir.transport])
3817
if make_working_trees is not None:
3818
repository.set_make_working_trees(make_working_trees)
3819
return repository, True
3822
class UseExistingRepository(RepositoryAcquisitionPolicy):
3823
"""A policy of reusing an existing repository"""
3825
def __init__(self, repository, stack_on=None, stack_on_pwd=None,
3826
require_stacking=False):
3829
:param repository: The repository to use.
3830
:param stack_on: A location to stack on
3831
:param stack_on_pwd: If stack_on is relative, the location it is
3834
RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
3836
self._repository = repository
3838
def acquire_repository(self, make_working_trees=None, shared=False):
3839
"""Implementation of RepositoryAcquisitionPolicy.acquire_repository
3841
Returns an existing repository to use.
3843
self._add_fallback(self._repository,
3844
possible_transports=[self._repository.bzrdir.transport])
3845
return self._repository, False
3848
# Please register new formats after old formats so that formats
3849
# appear in chronological order and format descriptions can build
2425
output += wrapped(key, help, info)
3851
2430
format_registry = BzrDirFormatRegistry()
3852
# The pre-0.8 formats have their repository format network name registered in
3853
# repository.py. MetaDir formats have their repository format network name
3854
# inferred from their disk format string.
3855
2431
format_registry.register('weave', BzrDirFormat6,
3856
2432
'Pre-0.8 format. Slower than knit and does not'
3857
2433
' support checkouts or shared repositories.',
3859
2434
deprecated=True)
2435
format_registry.register_metadir('knit',
2436
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2437
'Format using knits. Recommended for interoperation with bzr <= 0.14.',
2438
branch_format='bzrlib.branch.BzrBranchFormat5',
2439
tree_format='bzrlib.workingtree.WorkingTreeFormat3')
3860
2440
format_registry.register_metadir('metaweave',
3861
2441
'bzrlib.repofmt.weaverepo.RepositoryFormat7',
3862
2442
'Transitional format in 0.8. Slower than knit.',
3863
2443
branch_format='bzrlib.branch.BzrBranchFormat5',
3864
2444
tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3867
format_registry.register_metadir('knit',
3868
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3869
'Format using knits. Recommended for interoperation with bzr <= 0.14.',
3870
branch_format='bzrlib.branch.BzrBranchFormat5',
3871
tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3873
2445
deprecated=True)
3874
2446
format_registry.register_metadir('dirstate',
3875
2447
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3905
2467
'bzr branches. Incompatible with bzr < 0.15.',
3906
2468
branch_format='bzrlib.branch.BzrBranchFormat6',
3907
2469
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3911
format_registry.register_metadir('pack-0.92',
3912
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack1',
3913
help='New in 0.92: Pack-based format with data compatible with '
3914
'dirstate-tags format repositories. Interoperates with '
3915
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3917
branch_format='bzrlib.branch.BzrBranchFormat6',
3918
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3920
format_registry.register_metadir('pack-0.92-subtree',
3921
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack3',
3922
help='New in 0.92: Pack-based format with data compatible with '
3923
'dirstate-with-subtree format repositories. Interoperates with '
3924
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3926
branch_format='bzrlib.branch.BzrBranchFormat6',
3927
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3931
format_registry.register_metadir('rich-root-pack',
3932
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
3933
help='New in 1.0: A variant of pack-0.92 that supports rich-root data '
3934
'(needed for bzr-svn and bzr-git).',
3935
branch_format='bzrlib.branch.BzrBranchFormat6',
3936
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3939
format_registry.register_metadir('1.6',
3940
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5',
3941
help='A format that allows a branch to indicate that there is another '
3942
'(stacked) repository that should be used to access data that is '
3943
'not present locally.',
3944
branch_format='bzrlib.branch.BzrBranchFormat7',
3945
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3948
format_registry.register_metadir('1.6.1-rich-root',
3949
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5RichRoot',
3950
help='A variant of 1.6 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.9',
3957
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3958
help='A repository format using B+tree indexes. These indexes '
3959
'are smaller in size, have smarter caching and provide faster '
3960
'performance for most operations.',
3961
branch_format='bzrlib.branch.BzrBranchFormat7',
3962
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3965
format_registry.register_metadir('1.9-rich-root',
3966
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
3967
help='A variant of 1.9 that supports rich-root data '
3968
'(needed for bzr-svn and bzr-git).',
3969
branch_format='bzrlib.branch.BzrBranchFormat7',
3970
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3973
format_registry.register_metadir('1.14',
3974
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3975
help='A working-tree format that supports content filtering.',
3976
branch_format='bzrlib.branch.BzrBranchFormat7',
3977
tree_format='bzrlib.workingtree.WorkingTreeFormat5',
3979
format_registry.register_metadir('1.14-rich-root',
3980
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
3981
help='A variant of 1.14 that supports rich-root data '
3982
'(needed for bzr-svn and bzr-git).',
3983
branch_format='bzrlib.branch.BzrBranchFormat7',
3984
tree_format='bzrlib.workingtree.WorkingTreeFormat5',
3986
# The following un-numbered 'development' formats should always just be aliases.
3987
format_registry.register_metadir('development-rich-root',
3988
'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
3989
help='Current development format. Supports rich roots. Can convert data '
3990
'to and from rich-root-pack (and anything compatible with '
3991
'rich-root-pack) format repositories. Repositories and branches in '
3992
'this format can only be read by bzr.dev. Please read '
3993
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
3995
branch_format='bzrlib.branch.BzrBranchFormat7',
3996
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4001
format_registry.register_metadir('development-subtree',
4002
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment2Subtree',
4003
help='Current development format, subtree variant. Can convert data to and '
4004
'from pack-0.92-subtree (and anything compatible with '
4005
'pack-0.92-subtree) format repositories. Repositories and branches in '
4006
'this format can only be read by bzr.dev. Please read '
4007
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
4009
branch_format='bzrlib.branch.BzrBranchFormat7',
4010
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4013
alias=False, # Restore to being an alias when an actual development subtree format is added
4014
# This current non-alias status is simply because we did not introduce a
4015
# chk based subtree format.
4018
# And the development formats above will have aliased one of the following:
4019
format_registry.register_metadir('development6-rich-root',
4020
'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
4021
help='pack-1.9 with 255-way hashed CHK inv, group compress, rich roots '
4023
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
4025
branch_format='bzrlib.branch.BzrBranchFormat7',
4026
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4031
format_registry.register_metadir('development7-rich-root',
4032
'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK2',
4033
help='pack-1.9 with 255-way hashed CHK inv, bencode revision, group compress, '
4034
'rich roots. Please read '
4035
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
4037
branch_format='bzrlib.branch.BzrBranchFormat7',
4038
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4043
format_registry.register_metadir('2a',
4044
'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
4045
help='First format for bzr 2.0 series.\n'
4046
'Uses group-compress storage.\n'
4047
'Provides rich roots which are a one-way transition.\n',
4048
# 'storage in packs, 255-way hashed CHK inventory, bencode revision, group compress, '
4049
# 'rich roots. Supported by bzr 1.16 and later.',
4050
branch_format='bzrlib.branch.BzrBranchFormat7',
4051
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4055
# The following format should be an alias for the rich root equivalent
4056
# of the default format
4057
format_registry.register_metadir('default-rich-root',
4058
'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
4059
branch_format='bzrlib.branch.BzrBranchFormat7',
4060
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4065
# The current format that is made on 'bzr init'.
4066
format_registry.set_default('2a')
2472
format_registry.set_default('dirstate')