13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
17
"""BzrDir logic. The BzrDir is the basic control directory used by bzr.
19
19
At format 7 this was split out into Branch, Repository and Checkout control
22
Note: This module has a lot of ``open`` functions/methods that return
23
references to in-memory objects. As a rule, there are no matching ``close``
24
methods. To free any associated resources, simply stop referencing the
28
# TODO: Move old formats into a plugin to make this file smaller.
23
# TODO: remove unittest dependency; put that stuff inside the test suite
25
# TODO: The Format probe_transport seems a bit redundant with just trying to
26
# open the bzrdir. -- mbp
28
# TODO: Can we move specific formats into separate modules to make this file
31
from cStringIO import StringIO
34
35
from bzrlib.lazy_import import lazy_import
35
36
lazy_import(globals(), """
37
from copy import deepcopy
36
38
from stat import S_ISDIR
40
42
from bzrlib import (
50
47
revision as _mod_revision,
60
56
from bzrlib.osutils import (
63
from bzrlib.push import (
66
from bzrlib.repofmt import pack_repo
67
from bzrlib.smart.client import _SmartClient
61
from bzrlib.store.revision.text import TextRevisionStore
62
from bzrlib.store.text import TextStore
68
63
from bzrlib.store.versioned import WeaveStore
69
64
from bzrlib.transactions import WriteTransaction
70
from bzrlib.transport import (
71
do_catching_redirections,
65
from bzrlib.transport import get_transport
75
66
from bzrlib.weave import Weave
78
from bzrlib.trace import (
91
class ControlComponent(object):
92
"""Abstract base class for control directory components.
94
This provides interfaces that are common across bzrdirs,
95
repositories, branches, and workingtree control directories.
97
They all expose two urls and transports: the *user* URL is the
98
one that stops above the control directory (eg .bzr) and that
99
should normally be used in messages, and the *control* URL is
100
under that in eg .bzr/checkout and is used to read the control
103
This can be used as a mixin and is intended to fit with
108
def control_transport(self):
109
raise NotImplementedError
112
def control_url(self):
113
return self.control_transport.base
116
def user_transport(self):
117
raise NotImplementedError
121
return self.user_transport.base
124
class BzrDir(ControlComponent):
69
from bzrlib.trace import mutter, note
70
from bzrlib.transport.local import LocalTransport
125
74
"""A .bzr control diretory.
127
76
BzrDir instances let you create or open any of the things that can be
128
77
found within .bzr - checkouts, branches and repositories.
131
80
the transport which this bzr dir is rooted at (i.e. file:///.../.bzr/)
132
:ivar root_transport:
133
a transport connected to the directory this bzr was opened from
134
(i.e. the parent directory holding the .bzr directory).
136
Everything in the bzrdir should have the same file permissions.
138
:cvar hooks: An instance of BzrDirHooks.
82
a transport connected to the directory this bzr was opened from.
141
85
def break_lock(self):
202
137
format.get_format_description(),
205
def clone(self, url, revision_id=None, force_new_repo=False,
206
preserve_stacking=False):
140
def clone(self, url, revision_id=None, basis=None, force_new_repo=False):
207
141
"""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:
143
If urls last component does not exist, it will be created.
145
if revision_id is not None, then the clone operation may tune
146
itself to download less data.
147
:param force_new_repo: Do not use a shared repository for the target
148
even if one is available.
151
basis_repo, basis_branch, basis_tree = self._get_basis_components(basis)
152
result = self._format.initialize(url)
252
154
local_repo = self.find_repository()
253
155
except errors.NoRepositoryPresent:
254
156
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)
158
# may need to copy content in
160
result_repo = local_repo.clone(
162
revision_id=revision_id,
164
result_repo.set_make_working_trees(local_repo.make_working_trees())
167
result_repo = result.find_repository()
168
# fetch content this dir needs.
170
# XXX FIXME RBC 20060214 need tests for this when the basis
172
result_repo.fetch(basis_repo, revision_id=revision_id)
304
173
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)
174
except errors.NoRepositoryPresent:
175
# needed to make one anyway.
176
result_repo = local_repo.clone(
178
revision_id=revision_id,
180
result_repo.set_make_working_trees(local_repo.make_working_trees())
310
181
# 1 if there is a branch present
311
182
# 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)
185
self.open_branch().clone(result, revision_id=revision_id)
186
except errors.NotBranchError:
189
self.open_workingtree().clone(result, basis=basis_tree)
322
190
except (errors.NoWorkingTree, errors.NotLocalUrl):
194
def _get_basis_components(self, basis):
195
"""Retrieve the basis components that are available at basis."""
197
return None, None, None
199
basis_tree = basis.open_workingtree()
200
basis_branch = basis_tree.branch
201
basis_repo = basis_branch.repository
202
except (errors.NoWorkingTree, errors.NotLocalUrl):
205
basis_branch = basis.open_branch()
206
basis_repo = basis_branch.repository
207
except errors.NotBranchError:
210
basis_repo = basis.open_repository()
211
except errors.NoRepositoryPresent:
213
return basis_repo, basis_branch, basis_tree
326
215
# TODO: This should be given a Transport, and should chdir up; otherwise
327
216
# this will open a new connection.
328
217
def _make_tail(self, url):
329
t = get_transport(url)
218
head, tail = urlutils.split(url)
219
if tail and tail != '.':
220
t = get_transport(head)
223
except errors.FileExists:
226
# TODO: Should take a Transport
333
def create(cls, base, format=None, possible_transports=None):
228
def create(cls, base, format=None):
334
229
"""Create a new BzrDir at the url 'base'.
231
This will call the current default formats initialize with base
232
as the only parameter.
336
234
:param format: If supplied, the format of branch to create. If not
337
235
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
237
if cls is not BzrDir:
342
238
raise AssertionError("BzrDir.create always creates the default"
343
239
" format, not one of %r" % cls)
344
t = get_transport(base, possible_transports)
240
head, tail = urlutils.split(base)
241
if tail and tail != '.':
242
t = get_transport(head)
245
except errors.FileExists:
346
247
if format is None:
347
248
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):
249
return format.initialize(safe_unicode(base))
251
def create_branch(self):
433
252
"""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.
254
The bzrdirs format will control what branch format is created.
439
255
For more control see BranchFormatXX.create(a_bzrdir).
441
257
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
260
def create_branch_and_repo(base, force_new_repo=False, format=None):
453
261
"""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
263
This will use the current default BzrDirFormat, and use whatever
457
264
repository format that that uses via bzrdir.create_branch and
458
265
create_repository. If a shared repository is available that is used
463
270
:param base: The URL to create the branch at.
464
271
: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
273
bzrdir = BzrDir.create(base, format)
469
274
bzrdir._find_or_create_repository(force_new_repo)
470
275
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
277
def _find_or_create_repository(self, force_new_repo):
534
278
"""Create a new repository if needed, returning the repository."""
535
policy = self.determine_repository_policy(force_new_repo)
536
return policy.acquire_repository()[0]
280
return self.create_repository()
282
return self.find_repository()
283
except errors.NoRepositoryPresent:
284
return self.create_repository()
539
287
def create_branch_convenience(base, force_new_repo=False,
540
force_new_tree=None, format=None,
541
possible_transports=None):
288
force_new_tree=None, format=None):
542
289
"""Create a new BzrDir, Branch and Repository at the url 'base'.
544
291
This is a convenience function - it will use an existing repository
545
292
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
295
This will use the current default BzrDirFormat, and use whatever
550
296
repository format that that uses via bzrdir.create_branch and
551
297
create_repository. If a shared repository is available that is used
552
298
preferentially. Whatever repository is used, its tree creation policy
587
351
'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
353
This will use the current default BzrDirFormat, and use whatever
591
354
repository format that that uses for bzrdirformat.create_workingtree,
592
355
create_branch and create_repository.
594
:param format: Override for the bzrdir format to create.
595
357
:return: The WorkingTree object.
597
t = get_transport(base)
598
if not isinstance(t, local.LocalTransport):
359
t = get_transport(safe_unicode(base))
360
if not isinstance(t, LocalTransport):
599
361
raise errors.NotLocalUrl(base)
600
bzrdir = BzrDir.create_branch_and_repo(base,
362
bzrdir = BzrDir.create_branch_and_repo(safe_unicode(base),
601
363
force_new_repo=True,
602
364
format=format).bzrdir
603
365
return bzrdir.create_workingtree()
605
def create_workingtree(self, revision_id=None, from_branch=None,
606
accelerator_tree=None, hardlink=False):
367
def create_workingtree(self, revision_id=None):
607
368
"""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.
370
revision_id: create it as of this revision id.
616
372
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):
374
def retire_bzrdir(self):
647
375
"""Permanently disable the bzrdir.
649
377
This is done by renaming it to give the user some ability to recover
684
406
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.
408
def find_repository(self):
409
"""Find the repository that should be used for a_bzrdir.
411
This does not require a branch as we use it to find the repo for
412
new branches as well as to hook existing branches up to their
416
return self.open_repository()
417
except errors.NoRepositoryPresent:
419
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
421
# find the next containing bzrdir
710
423
found_bzrdir = BzrDir.open_containing_from_transport(
711
424
next_transport)[0]
712
425
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):
427
raise errors.NoRepositoryPresent(self)
723
428
# does it have a repository ?
725
430
repository = found_bzrdir.open_repository()
726
431
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
432
next_transport = found_bzrdir.root_transport.clone('..')
433
if (found_bzrdir.root_transport.base == next_transport.base):
434
# top of the file system
438
if ((found_bzrdir.root_transport.base ==
439
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):
442
raise errors.NoRepositoryPresent(self)
443
raise errors.NoRepositoryPresent(self)
445
def get_branch_transport(self, branch_format):
750
446
"""Get the transport for use by branch format in this BzrDir.
752
448
Note that bzr dirs that do not support format strings will raise
753
449
IncompatibleFormat if the branch format they are given has
754
450
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
452
If branch_format is None, the transport is returned with no
453
checking. if it is not None, then the returned transport is
758
454
guaranteed to point to an existing directory ready for use.
760
456
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
458
def get_repository_transport(self, repository_format):
807
459
"""Get the transport for use by repository format in this BzrDir.
895
528
def open_unsupported(base):
896
529
"""Open a branch which is not supported."""
897
530
return BzrDir.open(base, _unsupported=True)
900
def open(base, _unsupported=False, possible_transports=None):
901
"""Open an existing bzrdir, rooted at 'base' (url).
903
:param _unsupported: a private parameter to the BzrDir class.
533
def open(base, _unsupported=False):
534
"""Open an existing bzrdir, rooted at 'base' (url)
536
_unsupported is a private parameter to the BzrDir class.
905
t = get_transport(base, possible_transports=possible_transports)
538
t = get_transport(base)
906
539
return BzrDir.open_from_transport(t, _unsupported=_unsupported)
909
def open_from_transport(transport, _unsupported=False,
910
_server_formats=True):
542
def open_from_transport(transport, _unsupported=False):
911
543
"""Open a bzrdir within a particular directory.
913
545
:param transport: Transport containing the bzrdir.
914
546
:param _unsupported: private.
916
for hook in BzrDir.hooks['pre_open']:
918
# Keep initial base since 'transport' may be modified while following
920
base = transport.base
921
def find_format(transport):
922
return transport, BzrDirFormat.find_format(
923
transport, _server_formats=_server_formats)
925
def redirected(transport, e, redirection_notice):
926
redirected_transport = transport._redirected_to(e.source, e.target)
927
if redirected_transport is None:
928
raise errors.NotBranchError(base)
929
note('%s is%s redirected to %s',
930
transport.base, e.permanently, redirected_transport.base)
931
return redirected_transport
934
transport, format = do_catching_redirections(find_format,
937
except errors.TooManyRedirections:
938
raise errors.NotBranchError(base)
940
BzrDir._check_supported(format, _unsupported)
548
format = BzrDirFormat.find_format(transport)
549
BzrDir._check_supported(format, _unsupported,
550
basedir=transport.base)
941
551
return format.open(transport, _found=True)
943
def open_branch(self, name=None, unsupported=False,
944
ignore_fallbacks=False):
553
def open_branch(self, unsupported=False):
945
554
"""Open the branch object at this BzrDir if one is present.
947
556
If unsupported is True, then no longer supported branch formats can
950
559
TODO: static convenience version of this?
952
561
raise NotImplementedError(self.open_branch)
955
def open_containing(url, possible_transports=None):
564
def open_containing(url):
956
565
"""Open an existing branch which contains url.
958
567
:param url: url to search from.
959
568
See open_containing_from_transport for more detail.
961
transport = get_transport(url, possible_transports)
962
return BzrDir.open_containing_from_transport(transport)
570
return BzrDir.open_containing_from_transport(get_transport(url))
965
573
def open_containing_from_transport(a_transport):
966
"""Open an existing branch which contains a_transport.base.
574
"""Open an existing branch which contains a_transport.base
968
576
This probes for a branch at a_transport, and searches upwards from there.
970
578
Basically we keep looking up until we find the control directory or
971
579
run into the root. If there isn't one, raises NotBranchError.
972
If there is one and it is either an unrecognised format or an unsupported
580
If there is one and it is either an unrecognised format or an unsupported
973
581
format, UnknownFormatError or UnsupportedFormatError are raised.
974
582
If there is one, it is returned, along with the unused portion of url.
976
:return: The BzrDir that contains the path, and a Unicode path
584
:return: The BzrDir that contains the path, and a Unicode path
977
585
for the rest of the URL.
979
587
# this gets the normalised url back. I.e. '.' -> the full path.
1033
609
relpath is the portion of the path that is contained by the branch.
1035
611
bzrdir, relpath = klass.open_containing(location)
1036
tree, branch = bzrdir._get_tree_branch()
613
tree = bzrdir.open_workingtree()
614
except (errors.NoWorkingTree, errors.NotLocalUrl):
616
branch = bzrdir.open_branch()
1037
619
return tree, branch, relpath
1040
def open_containing_tree_branch_or_repository(klass, location):
1041
"""Return the working tree, branch and repo contained by a location.
1043
Returns (tree, branch, repository, relpath).
1044
If there is no tree containing the location, tree will be None.
1045
If there is no branch containing the location, branch will be None.
1046
If there is no repository containing the location, repository will be
1048
relpath is the portion of the path that is contained by the innermost
1051
If no tree, branch or repository is found, a NotBranchError is raised.
1053
bzrdir, relpath = klass.open_containing(location)
1055
tree, branch = bzrdir._get_tree_branch()
1056
except errors.NotBranchError:
1058
repo = bzrdir.find_repository()
1059
return None, None, repo, relpath
1060
except (errors.NoRepositoryPresent):
1061
raise errors.NotBranchError(location)
1062
return tree, branch, branch.repository, relpath
1064
621
def open_repository(self, _unsupported=False):
1065
622
"""Open the repository object at this BzrDir if one is present.
1067
This will not follow the Branch object pointer - it's strictly a direct
624
This will not follow the Branch object pointer - its strictly a direct
1068
625
open facility. Most client code should use open_branch().repository to
1069
626
get at a repository.
1071
:param _unsupported: a private parameter, not part of the api.
628
_unsupported is a private parameter, not part of the api.
1072
629
TODO: static convenience version of this?
1074
631
raise NotImplementedError(self.open_repository)
1076
def open_workingtree(self, _unsupported=False,
1077
recommend_upgrade=True, from_branch=None):
633
def open_workingtree(self, _unsupported=False):
1078
634
"""Open the workingtree object at this BzrDir if one is present.
1080
:param recommend_upgrade: Optional keyword parameter, when True (the
1081
default), emit through the ui module a recommendation that the user
1082
upgrade the working tree when the workingtree being opened is old
1083
(but still fully supported).
1084
:param from_branch: override bzrdir branch (for lightweight checkouts)
636
TODO: static convenience version of this?
1086
638
raise NotImplementedError(self.open_workingtree)
1088
def has_branch(self, name=None):
640
def has_branch(self):
1089
641
"""Tell if this bzrdir contains a branch.
1091
643
Note: if you're going to open the branch, you should just go ahead
1092
and try, and not ask permission first. (This method just opens the
1093
branch and discards it, and that's somewhat expensive.)
644
and try, and not ask permission first. (This method just opens the
645
branch and discards it, and that's somewhat expensive.)
1096
self.open_branch(name)
1098
650
except errors.NotBranchError:
1114
666
except errors.NoWorkingTree:
1117
def _cloning_metadir(self):
1118
"""Produce a metadir suitable for cloning with.
1120
:returns: (destination_bzrdir_format, source_repository)
669
def _cloning_metadir(self, basis=None):
670
def related_repository(bzrdir):
672
branch = bzrdir.open_branch()
673
return branch.repository
674
except errors.NotBranchError:
676
return bzrdir.open_repository()
1122
677
result_format = self._format.__class__()
1125
branch = self.open_branch(ignore_fallbacks=True)
1126
source_repository = branch.repository
1127
result_format._branch_format = branch._format
1128
except errors.NotBranchError:
1129
source_branch = None
1130
source_repository = self.open_repository()
680
source_repository = related_repository(self)
681
except errors.NoRepositoryPresent:
684
source_repository = related_repository(self)
685
result_format.repository_format = source_repository._format
1131
686
except errors.NoRepositoryPresent:
1132
687
source_repository = None
1134
# XXX TODO: This isinstance is here because we have not implemented
1135
# the fix recommended in bug # 103195 - to delegate this choice the
1136
# repository itself.
1137
repo_format = source_repository._format
1138
if isinstance(repo_format, remote.RemoteRepositoryFormat):
1139
source_repository._ensure_real()
1140
repo_format = source_repository._real_repository._format
1141
result_format.repository_format = repo_format
1143
# TODO: Couldn't we just probe for the format in these cases,
1144
# rather than opening the whole tree? It would be a little
1145
# faster. mbp 20070401
1146
tree = self.open_workingtree(recommend_upgrade=False)
689
tree = self.open_workingtree()
1147
690
except (errors.NoWorkingTree, errors.NotLocalUrl):
1148
691
result_format.workingtree_format = None
1150
693
result_format.workingtree_format = tree._format.__class__()
1151
694
return result_format, source_repository
1153
def cloning_metadir(self, require_stacking=False):
696
def cloning_metadir(self, basis=None):
1154
697
"""Produce a metadir suitable for cloning or sprouting with.
1156
699
These operations may produce workingtrees (yes, even though they're
1157
"cloning" something that doesn't have a tree), so a viable workingtree
700
"cloning" something that doesn't have a tree, so a viable workingtree
1158
701
format must be selected.
1160
:require_stacking: If True, non-stackable formats will be upgraded
1161
to similar stackable formats.
1162
:returns: a BzrDirFormat with all component formats either set
1163
appropriately or set to None if that component should not be
1166
703
format, repository = self._cloning_metadir()
1167
704
if format._workingtree_format is None:
1169
705
if repository is None:
1170
# No repository either
1172
# We have a repository, so set a working tree? (Why? This seems to
1173
# contradict the stated return value in the docstring).
1174
707
tree_format = repository._format._matchingbzrdir.workingtree_format
1175
708
format.workingtree_format = tree_format.__class__()
1176
if require_stacking:
1177
format.require_stacking()
1180
711
def checkout_metadir(self):
1181
712
return self.cloning_metadir()
1183
def sprout(self, url, revision_id=None, force_new_repo=False,
1184
recurse='down', possible_transports=None,
1185
accelerator_tree=None, hardlink=False, stacked=False,
1186
source_branch=None, create_tree_if_local=True):
714
def sprout(self, url, revision_id=None, basis=None, force_new_repo=False,
1187
716
"""Create a copy of this bzrdir prepared for use as a new line of
1190
If url's last component does not exist, it will be created.
719
If urls last component does not exist, it will be created.
1192
721
Attributes related to the identity of the source branch like
1193
722
branch nickname will be cleaned, a working tree is created
1197
726
if revision_id is not None, then the clone operation may tune
1198
727
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
730
cloning_format = self.cloning_metadir(basis)
731
result = cloning_format.initialize(url)
732
basis_repo, basis_branch, basis_tree = self._get_basis_components(basis)
734
source_branch = self.open_branch()
1221
735
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:
736
except errors.NotBranchError:
739
source_repository = self.open_repository()
740
except errors.NoRepositoryPresent:
741
# copy the entire basis one if there is one
742
# but there is no repository.
743
source_repository = basis_repo
748
result_repo = result.find_repository()
749
except errors.NoRepositoryPresent:
751
if source_repository is None and result_repo is not None:
753
elif source_repository is None and result_repo is None:
754
# no repo available, make a new one
755
result.create_repository()
756
elif source_repository is not None and result_repo is None:
757
# have source, and want to make a new target repo
758
# we don't clone the repo because that preserves attributes
759
# like is_shared(), and we have not yet implemented a
760
# repository sprout().
761
result_repo = result.create_repository()
762
if result_repo is not None:
763
# fetch needed content into target.
765
# XXX FIXME RBC 20060214 need tests for this when the basis
767
result_repo.fetch(basis_repo, revision_id=revision_id)
768
if source_repository is not None:
1246
769
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()
770
if source_branch is not None:
771
source_branch.sprout(result, revision_id=revision_id)
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,
773
result.create_branch()
774
# TODO: jam 20060426 we probably need a test in here in the
775
# case that the newly sprouted branch is a remote one
776
if result_repo is None or result_repo.make_working_trees():
777
wt = result.create_workingtree()
1268
780
if wt.path2id('') is None:
1296
806
sublocation = source_branch.reference_parent(file_id, path)
1297
807
sublocation.bzrdir.sprout(target,
1298
808
basis.get_reference_revision(file_id, path),
1299
force_new_repo=force_new_repo, recurse=recurse,
809
force_new_repo=force_new_repo, recurse=recurse)
1302
811
if basis is not None:
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
816
class BzrDirPreSplitOut(BzrDir):
1423
817
"""A common class for the all-in-one formats."""
1434
830
"""Pre-splitout bzrdirs do not suffer from stale locks."""
1435
831
raise NotImplementedError(self.break_lock)
1437
def cloning_metadir(self, require_stacking=False):
1438
"""Produce a metadir suitable for cloning with."""
1439
if require_stacking:
1440
return format_registry.make_bzrdir('1.6')
1441
return self._format.__class__()
1443
def clone(self, url, revision_id=None, force_new_repo=False,
1444
preserve_stacking=False):
1445
"""See BzrDir.clone().
1447
force_new_repo has no effect, since this family of formats always
1448
require a new repository.
1449
preserve_stacking has no effect, since no source branch using this
1450
family of formats can be stacked, so there is no stacking to preserve.
833
def clone(self, url, revision_id=None, basis=None, force_new_repo=False):
834
"""See BzrDir.clone()."""
835
from bzrlib.workingtree import WorkingTreeFormat2
1452
836
self._make_tail(url)
1453
837
result = self._format._initialize_for_clone(url)
1454
self.open_repository().clone(result, revision_id=revision_id)
838
basis_repo, basis_branch, basis_tree = self._get_basis_components(basis)
839
self.open_repository().clone(result, revision_id=revision_id, basis=basis_repo)
1455
840
from_branch = self.open_branch()
1456
841
from_branch.clone(result, revision_id=revision_id)
1458
tree = self.open_workingtree()
843
self.open_workingtree().clone(result, basis=basis_tree)
1459
844
except errors.NotLocalUrl:
1460
845
# make a new one, this format always has to have one.
1461
result._init_workingtree()
847
WorkingTreeFormat2().initialize(result)
848
except errors.NotLocalUrl:
849
# but we cannot do it for remote trees.
850
to_branch = result.open_branch()
851
WorkingTreeFormat2().stub_initialize_remote(to_branch.control_files)
1466
def create_branch(self, name=None):
854
def create_branch(self):
1467
855
"""See BzrDir.create_branch."""
1468
return self._format.get_branch_format().initialize(self, name=name)
1470
def destroy_branch(self, name=None):
1471
"""See BzrDir.destroy_branch."""
1472
raise errors.UnsupportedOperation(self.destroy_branch, self)
856
return self.open_branch()
1474
858
def create_repository(self, shared=False):
1475
859
"""See BzrDir.create_repository."""
1566
924
# if the format is not the same as the system default,
1567
925
# an upgrade is needed.
1568
926
if format is None:
1569
symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1570
% 'needs_format_conversion(format=None)')
1571
927
format = BzrDirFormat.get_default_format()
1572
928
return not isinstance(self._format, format.__class__)
1574
def open_branch(self, name=None, unsupported=False,
1575
ignore_fallbacks=False):
930
def open_branch(self, unsupported=False):
1576
931
"""See BzrDir.open_branch."""
1577
932
from bzrlib.branch import BzrBranchFormat4
1578
933
format = BzrBranchFormat4()
1579
934
self._check_supported(format, unsupported)
1580
return format.open(self, name, _found=True)
935
return format.open(self, _found=True)
1582
def sprout(self, url, revision_id=None, force_new_repo=False,
1583
possible_transports=None, accelerator_tree=None,
1584
hardlink=False, stacked=False, create_tree_if_local=True,
1585
source_branch=None):
937
def sprout(self, url, revision_id=None, basis=None, force_new_repo=False):
1586
938
"""See BzrDir.sprout()."""
1587
if source_branch is not None:
1588
my_branch = self.open_branch()
1589
if source_branch.base != my_branch.base:
1590
raise AssertionError(
1591
"source branch %r is not within %r with branch %r" %
1592
(source_branch, self, my_branch))
1594
raise errors.UnstackableBranchFormat(
1595
self._format, self.root_transport.base)
1596
if not create_tree_if_local:
1597
raise errors.MustHaveWorkingTree(
1598
self._format, self.root_transport.base)
1599
939
from bzrlib.workingtree import WorkingTreeFormat2
1600
940
self._make_tail(url)
1601
941
result = self._format._initialize_for_clone(url)
942
basis_repo, basis_branch, basis_tree = self._get_basis_components(basis)
1603
self.open_repository().clone(result, revision_id=revision_id)
944
self.open_repository().clone(result, revision_id=revision_id, basis=basis_repo)
1604
945
except errors.NoRepositoryPresent:
1607
948
self.open_branch().sprout(result, revision_id=revision_id)
1608
949
except errors.NotBranchError:
1611
951
# we always want a working tree
1612
WorkingTreeFormat2().initialize(result,
1613
accelerator_tree=accelerator_tree,
952
WorkingTreeFormat2().initialize(result)
1618
956
class BzrDir4(BzrDirPreSplitOut):
1619
957
"""A .bzr version 4 control object.
1621
959
This is a deprecated format and may be removed after sept 2006.
1700
1027
"""See BzrDir.can_convert_format()."""
1703
def create_branch(self, name=None):
1704
"""See BzrDir.create_branch."""
1705
return self._format.get_branch_format().initialize(self, name=name)
1707
def destroy_branch(self, name=None):
1708
"""See BzrDir.create_branch."""
1709
if name is not None:
1710
raise errors.NoColocatedBranchSupport(self)
1711
self.transport.delete_tree('branch')
1030
def create_branch(self):
1031
"""See BzrDir.create_branch."""
1032
return self._format.get_branch_format().initialize(self)
1713
1034
def create_repository(self, shared=False):
1714
1035
"""See BzrDir.create_repository."""
1715
1036
return self._format.repository_format.initialize(self, shared)
1717
def destroy_repository(self):
1718
"""See BzrDir.destroy_repository."""
1719
self.transport.delete_tree('repository')
1721
def create_workingtree(self, revision_id=None, from_branch=None,
1722
accelerator_tree=None, hardlink=False):
1038
def create_workingtree(self, revision_id=None):
1723
1039
"""See BzrDir.create_workingtree."""
1724
return self._format.workingtree_format.initialize(
1725
self, revision_id, from_branch=from_branch,
1726
accelerator_tree=accelerator_tree, hardlink=hardlink)
1040
from bzrlib.workingtree import WorkingTreeFormat
1041
return self._format.workingtree_format.initialize(self, revision_id)
1728
1043
def destroy_workingtree(self):
1729
1044
"""See BzrDir.destroy_workingtree."""
1730
1045
wt = self.open_workingtree(recommend_upgrade=False)
1731
1046
repository = wt.branch.repository
1732
1047
empty = repository.revision_tree(_mod_revision.NULL_REVISION)
1733
wt.revert(old_tree=empty)
1048
wt.revert([], old_tree=empty)
1734
1049
self.destroy_workingtree_metadata()
1736
1051
def destroy_workingtree_metadata(self):
1737
1052
self.transport.delete_tree('checkout')
1739
def find_branch_format(self):
1740
"""Find the branch 'format' for this bzrdir.
1742
This might be a synthetic object for e.g. RemoteBranch and SVN.
1744
from bzrlib.branch import BranchFormat
1745
return BranchFormat.find_format(self)
1747
1054
def _get_mkdir_mode(self):
1748
1055
"""Figure out the mode to use when creating a bzrdir subdir."""
1749
1056
temp_control = lockable_files.LockableFiles(self.transport, '',
1750
1057
lockable_files.TransportLock)
1751
1058
return temp_control._dir_mode
1753
def get_branch_reference(self):
1754
"""See BzrDir.get_branch_reference()."""
1755
from bzrlib.branch import BranchFormat
1756
format = BranchFormat.find_format(self)
1757
return format.get_reference(self)
1759
def get_branch_transport(self, branch_format, name=None):
1060
def get_branch_transport(self, branch_format):
1760
1061
"""See BzrDir.get_branch_transport()."""
1761
if name is not None:
1762
raise errors.NoColocatedBranchSupport(self)
1763
# XXX: this shouldn't implicitly create the directory if it's just
1764
# promising to get a transport -- mbp 20090727
1765
1062
if branch_format is None:
1766
1063
return self.transport.clone('branch')
1976
1236
current default format. In the case of plugins we can/should provide
1977
1237
some means for them to extend the range of returnable converters.
1979
:param format: Optional format to override the default format of the
1239
:param format: Optional format to override the default format of the
1982
1242
raise NotImplementedError(self.get_converter)
1984
def initialize(self, url, possible_transports=None):
1244
def initialize(self, url):
1985
1245
"""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
1247
Subclasses should typically override initialize_on_transport
1992
1248
instead of this method.
1994
return self.initialize_on_transport(get_transport(url,
1995
possible_transports))
1250
return self.initialize_on_transport(get_transport(url))
1997
1252
def initialize_on_transport(self, transport):
1998
1253
"""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
1254
# Since we don't have a .bzr directory, inherit the
2119
1255
# mode from the root directory
2120
1256
temp_control = lockable_files.LockableFiles(transport,
2121
1257
'', lockable_files.TransportLock)
2511
1584
def set_branch_format(self, format):
2512
1585
self._branch_format = format
2514
def require_stacking(self, stack_on=None, possible_transports=None,
2516
"""We have a request to stack, try to ensure the formats support it.
2518
:param stack_on: If supplied, it is the URL to a branch that we want to
2519
stack on. Check to see if that format supports stacking before
2522
# Stacking is desired. requested by the target, but does the place it
2523
# points at support stacking? If it doesn't then we should
2524
# not implicitly upgrade. We check this here.
2525
new_repo_format = None
2526
new_branch_format = None
2528
# a bit of state for get_target_branch so that we don't try to open it
2529
# 2 times, for both repo *and* branch
2530
target = [None, False, None] # target_branch, checked, upgrade anyway
2531
def get_target_branch():
2533
# We've checked, don't check again
2535
if stack_on is None:
2536
# No target format, that means we want to force upgrading
2537
target[:] = [None, True, True]
2540
target_dir = BzrDir.open(stack_on,
2541
possible_transports=possible_transports)
2542
except errors.NotBranchError:
2543
# Nothing there, don't change formats
2544
target[:] = [None, True, False]
2546
except errors.JailBreak:
2547
# JailBreak, JFDI and upgrade anyway
2548
target[:] = [None, True, True]
2551
target_branch = target_dir.open_branch()
2552
except errors.NotBranchError:
2553
# No branch, don't upgrade formats
2554
target[:] = [None, True, False]
2556
target[:] = [target_branch, True, False]
2559
if (not _skip_repo and
2560
not self.repository_format.supports_external_lookups):
2561
# We need to upgrade the Repository.
2562
target_branch, _, do_upgrade = get_target_branch()
2563
if target_branch is None:
2564
# We don't have a target branch, should we upgrade anyway?
2566
# stack_on is inaccessible, JFDI.
2567
# TODO: bad monkey, hard-coded formats...
2568
if self.repository_format.rich_root_data:
2569
new_repo_format = pack_repo.RepositoryFormatKnitPack5RichRoot()
2571
new_repo_format = pack_repo.RepositoryFormatKnitPack5()
2573
# If the target already supports stacking, then we know the
2574
# project is already able to use stacking, so auto-upgrade
2576
new_repo_format = target_branch.repository._format
2577
if not new_repo_format.supports_external_lookups:
2578
# target doesn't, source doesn't, so don't auto upgrade
2580
new_repo_format = None
2581
if new_repo_format is not None:
2582
self.repository_format = new_repo_format
2583
note('Source repository format does not support stacking,'
2584
' using format:\n %s',
2585
new_repo_format.get_format_description())
2587
if not self.get_branch_format().supports_stacking():
2588
# We just checked the repo, now lets check if we need to
2589
# upgrade the branch format
2590
target_branch, _, do_upgrade = get_target_branch()
2591
if target_branch is None:
2593
# TODO: bad monkey, hard-coded formats...
2594
new_branch_format = branch.BzrBranchFormat7()
2596
new_branch_format = target_branch._format
2597
if not new_branch_format.supports_stacking():
2598
new_branch_format = None
2599
if new_branch_format is not None:
2600
# Does support stacking, use its format.
2601
self.set_branch_format(new_branch_format)
2602
note('Source branch format does not support stacking,'
2603
' using format:\n %s',
2604
new_branch_format.get_format_description())
2606
1587
def get_converter(self, format=None):
2607
1588
"""See BzrDirFormat.get_converter()."""
2608
1589
if format is None:
3205
2149
# TODO: conversions of Branch and Tree should be done by
3206
2150
# InterXFormat lookups
3207
2151
if (isinstance(tree, workingtree.WorkingTree3) and
3208
not isinstance(tree, workingtree_4.DirStateWorkingTree) and
2152
not isinstance(tree, workingtree_4.WorkingTree4) and
3209
2153
isinstance(self.target_format.workingtree_format,
3210
workingtree_4.DirStateWorkingTreeFormat)):
2154
workingtree_4.WorkingTreeFormat4)):
3211
2155
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
2156
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
2159
class BzrDirFormatInfo(object):
3493
def __init__(self, native, deprecated, hidden, experimental):
2161
def __init__(self, native, deprecated, hidden):
3494
2162
self.deprecated = deprecated
3495
2163
self.native = native
3496
2164
self.hidden = hidden
3497
self.experimental = experimental
3500
2167
class BzrDirFormatRegistry(registry.Registry):
3501
2168
"""Registry of user-selectable BzrDir subformats.
3503
2170
Differs from BzrDirFormat._control_formats in that it provides sub-formats,
3504
2171
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
2174
def register_metadir(self, key,
3518
2175
repository_format, help, native=True, deprecated=False,
3519
2176
branch_format=None,
3520
2177
tree_format=None,
3524
2179
"""Register a metadir subformat.
3526
2181
These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
3527
by the Repository/Branch/WorkingTreeformats.
2182
by the Repository format.
3529
2184
:param repository_format: The fully-qualified repository format class
3530
2185
name as a string.
3558
2213
if repository_format is not None:
3559
2214
bd.repository_format = _load(repository_format)
3561
self.register(key, helper, help, native, deprecated, hidden,
3562
experimental, alias)
2216
self.register(key, helper, help, native, deprecated, hidden)
3564
2218
def register(self, key, factory, help, native=True, deprecated=False,
3565
hidden=False, experimental=False, alias=False):
3566
2220
"""Register a BzrDirFormat factory.
3568
2222
The factory must be a callable that takes one parameter: the key.
3569
2223
It must produce an instance of the BzrDirFormat when called.
3571
2225
This function mainly exists to prevent the info object from being
3572
2226
supplied directly.
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)
2228
registry.Registry.register(self, key, factory, help,
2229
BzrDirFormatInfo(native, deprecated, hidden))
3580
2231
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)
2232
deprecated=False, hidden=False):
2233
registry.Registry.register_lazy(self, key, module_name, member_name,
2234
help, BzrDirFormatInfo(native, deprecated, hidden))
3588
2236
def set_default(self, key):
3589
2237
"""Set the 'default' key to be a clone of the supplied key.
3591
2239
This method must be called once and only once.
3593
registry.Registry.register(self, 'default', self.get(key),
2241
registry.Registry.register(self, 'default', self.get(key),
3594
2242
self.get_help(key), info=self.get_info(key))
3595
self._aliases.add('default')
3597
2244
def set_default_repository(self, key):
3598
2245
"""Set the FormatRegistry default and Repository default.
3600
2247
This is a transitional method while Repository.set_default_format
3625
2279
def wrapped(key, help, info):
3626
2280
if info.native:
3627
2281
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'))
2282
return ' %s:\n%s\n\n' % (key,
2283
textwrap.fill(help, initial_indent=' ',
2284
subsequent_indent=' '))
2285
output += wrapped('%s/default' % default_realkey, default_help,
2286
self.get_info('default'))
3635
2287
deprecated_pairs = []
3636
experimental_pairs = []
3637
2288
for key, help in help_pairs:
3638
2289
info = self.get_info(key)
3639
2290
if info.hidden:
3641
2292
elif info.deprecated:
3642
2293
deprecated_pairs.append((key, help))
3643
elif info.experimental:
3644
experimental_pairs.append((key, help))
3646
2295
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
2296
if len(deprecated_pairs) > 0:
3658
other_output += "\nDeprecated formats are shown below.\n\n"
2297
output += "Deprecated formats\n------------------\n\n"
3659
2298
for key, help in deprecated_pairs:
3660
2299
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
2300
output += wrapped(key, help, info)
3834
2305
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
2306
format_registry.register('weave', BzrDirFormat6,
3839
2307
'Pre-0.8 format. Slower than knit and does not'
3840
2308
' support checkouts or shared repositories.',
3842
2309
deprecated=True)
2310
format_registry.register_metadir('knit',
2311
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2312
'Format using knits. Recommended for interoperation with bzr <= 0.14.',
2313
branch_format='bzrlib.branch.BzrBranchFormat5',
2314
tree_format='bzrlib.workingtree.WorkingTreeFormat3')
3843
2315
format_registry.register_metadir('metaweave',
3844
2316
'bzrlib.repofmt.weaverepo.RepositoryFormat7',
3845
2317
'Transitional format in 0.8. Slower than knit.',
3846
2318
branch_format='bzrlib.branch.BzrBranchFormat5',
3847
2319
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',
3856
2320
deprecated=True)
3857
2321
format_registry.register_metadir('dirstate',
3858
2322
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3888
2342
'bzr branches. Incompatible with bzr < 0.15.',
3889
2343
branch_format='bzrlib.branch.BzrBranchFormat6',
3890
2344
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')
2347
format_registry.set_default('dirstate')
added
removed
bzrlib/bzrdir.py
