1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
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
17
"""BzrDir logic. The BzrDir is the basic control directory used by bzr.
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.
33
from bzrlib.lazy_import import lazy_import
34
lazy_import(globals(), """
35
from stat import S_ISDIR
49
revision as _mod_revision,
59
from bzrlib.osutils import (
62
from bzrlib.push import (
65
from bzrlib.repofmt import pack_repo
66
from bzrlib.smart.client import _SmartClient
67
from bzrlib.store.versioned import WeaveStore
68
from bzrlib.transactions import WriteTransaction
69
from bzrlib.transport import (
70
do_catching_redirections,
74
from bzrlib.weave import Weave
77
from bzrlib.trace import (
91
"""A .bzr control diretory.
93
BzrDir instances let you create or open any of the things that can be
94
found within .bzr - checkouts, branches and repositories.
97
the transport which this bzr dir is rooted at (i.e. file:///.../.bzr/)
99
a transport connected to the directory this bzr was opened from
100
(i.e. the parent directory holding the .bzr directory).
102
Everything in the bzrdir should have the same file permissions.
104
:cvar hooks: An instance of BzrDirHooks.
107
def break_lock(self):
108
"""Invoke break_lock on the first object in the bzrdir.
110
If there is a tree, the tree is opened and break_lock() called.
111
Otherwise, branch is tried, and finally repository.
113
# XXX: This seems more like a UI function than something that really
114
# belongs in this class.
116
thing_to_unlock = self.open_workingtree()
117
except (errors.NotLocalUrl, errors.NoWorkingTree):
119
thing_to_unlock = self.open_branch()
120
except errors.NotBranchError:
122
thing_to_unlock = self.open_repository()
123
except errors.NoRepositoryPresent:
125
thing_to_unlock.break_lock()
127
def can_convert_format(self):
128
"""Return true if this bzrdir is one whose format we can convert from."""
131
def check_conversion_target(self, target_format):
132
"""Check that a bzrdir as a whole can be converted to a new format."""
133
# The only current restriction is that the repository content can be
134
# fetched compatibly with the target.
135
target_repo_format = target_format.repository_format
137
self.open_repository()._format.check_conversion_target(
139
except errors.NoRepositoryPresent:
140
# No repo, no problem.
144
def _check_supported(format, allow_unsupported,
145
recommend_upgrade=True,
147
"""Give an error or warning on old formats.
149
:param format: may be any kind of format - workingtree, branch,
152
:param allow_unsupported: If true, allow opening
153
formats that are strongly deprecated, and which may
154
have limited functionality.
156
:param recommend_upgrade: If true (default), warn
157
the user through the ui object that they may wish
158
to upgrade the object.
160
# TODO: perhaps move this into a base Format class; it's not BzrDir
161
# specific. mbp 20070323
162
if not allow_unsupported and not format.is_supported():
163
# see open_downlevel to open legacy branches.
164
raise errors.UnsupportedFormatError(format=format)
165
if recommend_upgrade \
166
and getattr(format, 'upgrade_recommended', False):
167
ui.ui_factory.recommend_upgrade(
168
format.get_format_description(),
171
def clone(self, url, revision_id=None, force_new_repo=False,
172
preserve_stacking=False):
173
"""Clone this bzrdir and its contents to url verbatim.
175
:param url: The url create the clone at. If url's last component does
176
not exist, it will be created.
177
:param revision_id: The tip revision-id to use for any branch or
178
working tree. If not None, then the clone operation may tune
179
itself to download less data.
180
:param force_new_repo: Do not use a shared repository for the target
181
even if one is available.
182
:param preserve_stacking: When cloning a stacked branch, stack the
183
new branch on top of the other branch's stacked-on branch.
185
return self.clone_on_transport(get_transport(url),
186
revision_id=revision_id,
187
force_new_repo=force_new_repo,
188
preserve_stacking=preserve_stacking)
190
def clone_on_transport(self, transport, revision_id=None,
191
force_new_repo=False, preserve_stacking=False, stacked_on=None,
192
create_prefix=False, use_existing_dir=True):
193
"""Clone this bzrdir and its contents to transport verbatim.
195
:param transport: The transport for the location to produce the clone
196
at. If the target directory does not exist, it will be created.
197
:param revision_id: The tip revision-id to use for any branch or
198
working tree. If not None, then the clone operation may tune
199
itself to download less data.
200
:param force_new_repo: Do not use a shared repository for the target,
201
even if one is available.
202
:param preserve_stacking: When cloning a stacked branch, stack the
203
new branch on top of the other branch's stacked-on branch.
204
:param create_prefix: Create any missing directories leading up to
206
:param use_existing_dir: Use an existing directory if one exists.
208
# Overview: put together a broad description of what we want to end up
209
# with; then make as few api calls as possible to do it.
211
# We may want to create a repo/branch/tree, if we do so what format
212
# would we want for each:
213
require_stacking = (stacked_on is not None)
214
format = self.cloning_metadir(require_stacking)
216
# Figure out what objects we want:
218
local_repo = self.find_repository()
219
except errors.NoRepositoryPresent:
222
local_branch = self.open_branch()
223
except errors.NotBranchError:
226
# enable fallbacks when branch is not a branch reference
227
if local_branch.repository.has_same_location(local_repo):
228
local_repo = local_branch.repository
229
if preserve_stacking:
231
stacked_on = local_branch.get_stacked_on_url()
232
except (errors.UnstackableBranchFormat,
233
errors.UnstackableRepositoryFormat,
236
# Bug: We create a metadir without knowing if it can support stacking,
237
# we should look up the policy needs first, or just use it as a hint,
240
make_working_trees = local_repo.make_working_trees()
241
want_shared = local_repo.is_shared()
242
repo_format_name = format.repository_format.network_name()
244
make_working_trees = False
246
repo_format_name = None
248
result_repo, result, require_stacking, repository_policy = \
249
format.initialize_on_transport_ex(transport,
250
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
251
force_new_repo=force_new_repo, stacked_on=stacked_on,
252
stack_on_pwd=self.root_transport.base,
253
repo_format_name=repo_format_name,
254
make_working_trees=make_working_trees, shared_repo=want_shared)
257
# If the result repository is in the same place as the
258
# resulting bzr dir, it will have no content, further if the
259
# result is not stacked then we know all content should be
260
# copied, and finally if we are copying up to a specific
261
# revision_id then we can use the pending-ancestry-result which
262
# does not require traversing all of history to describe it.
263
if (result_repo.bzrdir.root_transport.base ==
264
result.root_transport.base and not require_stacking and
265
revision_id is not None):
266
fetch_spec = graph.PendingAncestryResult(
267
[revision_id], local_repo)
268
result_repo.fetch(local_repo, fetch_spec=fetch_spec)
270
result_repo.fetch(local_repo, revision_id=revision_id)
274
if result_repo is not None:
275
raise AssertionError('result_repo not None(%r)' % result_repo)
276
# 1 if there is a branch present
277
# make sure its content is available in the target repository
279
if local_branch is not None:
280
result_branch = local_branch.clone(result, revision_id=revision_id,
281
repository_policy=repository_policy)
283
# Cheaper to check if the target is not local, than to try making
285
result.root_transport.local_abspath('.')
286
if result_repo is None or result_repo.make_working_trees():
287
self.open_workingtree().clone(result)
288
except (errors.NoWorkingTree, errors.NotLocalUrl):
292
# TODO: This should be given a Transport, and should chdir up; otherwise
293
# this will open a new connection.
294
def _make_tail(self, url):
295
t = get_transport(url)
299
def create(cls, base, format=None, possible_transports=None):
300
"""Create a new BzrDir at the url 'base'.
302
:param format: If supplied, the format of branch to create. If not
303
supplied, the default is used.
304
:param possible_transports: If supplied, a list of transports that
305
can be reused to share a remote connection.
307
if cls is not BzrDir:
308
raise AssertionError("BzrDir.create always creates the default"
309
" format, not one of %r" % cls)
310
t = get_transport(base, possible_transports)
313
format = BzrDirFormat.get_default_format()
314
return format.initialize_on_transport(t)
317
def find_bzrdirs(transport, evaluate=None, list_current=None):
318
"""Find bzrdirs recursively from current location.
320
This is intended primarily as a building block for more sophisticated
321
functionality, like finding trees under a directory, or finding
322
branches that use a given repository.
323
:param evaluate: An optional callable that yields recurse, value,
324
where recurse controls whether this bzrdir is recursed into
325
and value is the value to yield. By default, all bzrdirs
326
are recursed into, and the return value is the bzrdir.
327
:param list_current: if supplied, use this function to list the current
328
directory, instead of Transport.list_dir
329
:return: a generator of found bzrdirs, or whatever evaluate returns.
331
if list_current is None:
332
def list_current(transport):
333
return transport.list_dir('')
335
def evaluate(bzrdir):
338
pending = [transport]
339
while len(pending) > 0:
340
current_transport = pending.pop()
343
bzrdir = BzrDir.open_from_transport(current_transport)
344
except errors.NotBranchError:
347
recurse, value = evaluate(bzrdir)
350
subdirs = list_current(current_transport)
351
except errors.NoSuchFile:
354
for subdir in sorted(subdirs, reverse=True):
355
pending.append(current_transport.clone(subdir))
358
def find_branches(transport):
359
"""Find all branches under a transport.
361
This will find all branches below the transport, including branches
362
inside other branches. Where possible, it will use
363
Repository.find_branches.
365
To list all the branches that use a particular Repository, see
366
Repository.find_branches
368
def evaluate(bzrdir):
370
repository = bzrdir.open_repository()
371
except errors.NoRepositoryPresent:
374
return False, (None, repository)
376
branch = bzrdir.open_branch()
377
except errors.NotBranchError:
378
return True, (None, None)
380
return True, (branch, None)
382
for branch, repo in BzrDir.find_bzrdirs(transport, evaluate=evaluate):
384
branches.extend(repo.find_branches())
385
if branch is not None:
386
branches.append(branch)
389
def destroy_repository(self):
390
"""Destroy the repository in this BzrDir"""
391
raise NotImplementedError(self.destroy_repository)
393
def create_branch(self):
394
"""Create a branch in this BzrDir.
396
The bzrdir's format will control what branch format is created.
397
For more control see BranchFormatXX.create(a_bzrdir).
399
raise NotImplementedError(self.create_branch)
401
def destroy_branch(self):
402
"""Destroy the branch in this BzrDir"""
403
raise NotImplementedError(self.destroy_branch)
406
def create_branch_and_repo(base, force_new_repo=False, format=None):
407
"""Create a new BzrDir, Branch and Repository at the url 'base'.
409
This will use the current default BzrDirFormat unless one is
410
specified, and use whatever
411
repository format that that uses via bzrdir.create_branch and
412
create_repository. If a shared repository is available that is used
415
The created Branch object is returned.
417
:param base: The URL to create the branch at.
418
:param force_new_repo: If True a new repository is always created.
419
:param format: If supplied, the format of branch to create. If not
420
supplied, the default is used.
422
bzrdir = BzrDir.create(base, format)
423
bzrdir._find_or_create_repository(force_new_repo)
424
return bzrdir.create_branch()
426
def determine_repository_policy(self, force_new_repo=False, stack_on=None,
427
stack_on_pwd=None, require_stacking=False):
428
"""Return an object representing a policy to use.
430
This controls whether a new repository is created, and the format of
431
that repository, or some existing shared repository used instead.
433
If stack_on is supplied, will not seek a containing shared repo.
435
:param force_new_repo: If True, require a new repository to be created.
436
:param stack_on: If supplied, the location to stack on. If not
437
supplied, a default_stack_on location may be used.
438
:param stack_on_pwd: If stack_on is relative, the location it is
441
def repository_policy(found_bzrdir):
444
config = found_bzrdir.get_config()
446
stack_on = config.get_default_stack_on()
447
if stack_on is not None:
448
stack_on_pwd = found_bzrdir.root_transport.base
450
# does it have a repository ?
452
repository = found_bzrdir.open_repository()
453
except errors.NoRepositoryPresent:
456
if ((found_bzrdir.root_transport.base !=
457
self.root_transport.base) and not repository.is_shared()):
458
# Don't look higher, can't use a higher shared repo.
466
return UseExistingRepository(repository, stack_on,
467
stack_on_pwd, require_stacking=require_stacking), True
469
return CreateRepository(self, stack_on, stack_on_pwd,
470
require_stacking=require_stacking), True
472
if not force_new_repo:
474
policy = self._find_containing(repository_policy)
475
if policy is not None:
479
return UseExistingRepository(self.open_repository(),
480
stack_on, stack_on_pwd,
481
require_stacking=require_stacking)
482
except errors.NoRepositoryPresent:
484
return CreateRepository(self, stack_on, stack_on_pwd,
485
require_stacking=require_stacking)
487
def _find_or_create_repository(self, force_new_repo):
488
"""Create a new repository if needed, returning the repository."""
489
policy = self.determine_repository_policy(force_new_repo)
490
return policy.acquire_repository()[0]
493
def create_branch_convenience(base, force_new_repo=False,
494
force_new_tree=None, format=None,
495
possible_transports=None):
496
"""Create a new BzrDir, Branch and Repository at the url 'base'.
498
This is a convenience function - it will use an existing repository
499
if possible, can be told explicitly whether to create a working tree or
502
This will use the current default BzrDirFormat unless one is
503
specified, and use whatever
504
repository format that that uses via bzrdir.create_branch and
505
create_repository. If a shared repository is available that is used
506
preferentially. Whatever repository is used, its tree creation policy
509
The created Branch object is returned.
510
If a working tree cannot be made due to base not being a file:// url,
511
no error is raised unless force_new_tree is True, in which case no
512
data is created on disk and NotLocalUrl is raised.
514
:param base: The URL to create the branch at.
515
:param force_new_repo: If True a new repository is always created.
516
:param force_new_tree: If True or False force creation of a tree or
517
prevent such creation respectively.
518
:param format: Override for the bzrdir format to create.
519
:param possible_transports: An optional reusable transports list.
522
# check for non local urls
523
t = get_transport(base, possible_transports)
524
if not isinstance(t, local.LocalTransport):
525
raise errors.NotLocalUrl(base)
526
bzrdir = BzrDir.create(base, format, possible_transports)
527
repo = bzrdir._find_or_create_repository(force_new_repo)
528
result = bzrdir.create_branch()
529
if force_new_tree or (repo.make_working_trees() and
530
force_new_tree is None):
532
bzrdir.create_workingtree()
533
except errors.NotLocalUrl:
538
def create_standalone_workingtree(base, format=None):
539
"""Create a new BzrDir, WorkingTree, Branch and Repository at 'base'.
541
'base' must be a local path or a file:// url.
543
This will use the current default BzrDirFormat unless one is
544
specified, and use whatever
545
repository format that that uses for bzrdirformat.create_workingtree,
546
create_branch and create_repository.
548
:param format: Override for the bzrdir format to create.
549
:return: The WorkingTree object.
551
t = get_transport(base)
552
if not isinstance(t, local.LocalTransport):
553
raise errors.NotLocalUrl(base)
554
bzrdir = BzrDir.create_branch_and_repo(base,
556
format=format).bzrdir
557
return bzrdir.create_workingtree()
559
def create_workingtree(self, revision_id=None, from_branch=None,
560
accelerator_tree=None, hardlink=False):
561
"""Create a working tree at this BzrDir.
563
:param revision_id: create it as of this revision id.
564
:param from_branch: override bzrdir branch (for lightweight checkouts)
565
:param accelerator_tree: A tree which can be used for retrieving file
566
contents more quickly than the revision tree, i.e. a workingtree.
567
The revision tree will be used for cases where accelerator_tree's
568
content is different.
570
raise NotImplementedError(self.create_workingtree)
572
def backup_bzrdir(self):
573
"""Backup this bzr control directory.
575
:return: Tuple with old path name and new path name
577
pb = ui.ui_factory.nested_progress_bar()
579
# FIXME: bug 300001 -- the backup fails if the backup directory
580
# already exists, but it should instead either remove it or make
581
# a new backup directory.
583
# FIXME: bug 262450 -- the backup directory should have the same
584
# permissions as the .bzr directory (probably a bug in copy_tree)
585
old_path = self.root_transport.abspath('.bzr')
586
new_path = self.root_transport.abspath('backup.bzr')
587
pb.note('making backup of %s' % (old_path,))
588
pb.note(' to %s' % (new_path,))
589
self.root_transport.copy_tree('.bzr', 'backup.bzr')
590
return (old_path, new_path)
594
def retire_bzrdir(self, limit=10000):
595
"""Permanently disable the bzrdir.
597
This is done by renaming it to give the user some ability to recover
598
if there was a problem.
600
This will have horrible consequences if anyone has anything locked or
602
:param limit: number of times to retry
607
to_path = '.bzr.retired.%d' % i
608
self.root_transport.rename('.bzr', to_path)
609
note("renamed %s to %s"
610
% (self.root_transport.abspath('.bzr'), to_path))
612
except (errors.TransportError, IOError, errors.PathError):
619
def destroy_workingtree(self):
620
"""Destroy the working tree at this BzrDir.
622
Formats that do not support this may raise UnsupportedOperation.
624
raise NotImplementedError(self.destroy_workingtree)
626
def destroy_workingtree_metadata(self):
627
"""Destroy the control files for the working tree at this BzrDir.
629
The contents of working tree files are not affected.
630
Formats that do not support this may raise UnsupportedOperation.
632
raise NotImplementedError(self.destroy_workingtree_metadata)
634
def _find_containing(self, evaluate):
635
"""Find something in a containing control directory.
637
This method will scan containing control dirs, until it finds what
638
it is looking for, decides that it will never find it, or runs out
639
of containing control directories to check.
641
It is used to implement find_repository and
642
determine_repository_policy.
644
:param evaluate: A function returning (value, stop). If stop is True,
645
the value will be returned.
649
result, stop = evaluate(found_bzrdir)
652
next_transport = found_bzrdir.root_transport.clone('..')
653
if (found_bzrdir.root_transport.base == next_transport.base):
654
# top of the file system
656
# find the next containing bzrdir
658
found_bzrdir = BzrDir.open_containing_from_transport(
660
except errors.NotBranchError:
663
def find_repository(self):
664
"""Find the repository that should be used.
666
This does not require a branch as we use it to find the repo for
667
new branches as well as to hook existing branches up to their
670
def usable_repository(found_bzrdir):
671
# does it have a repository ?
673
repository = found_bzrdir.open_repository()
674
except errors.NoRepositoryPresent:
676
if found_bzrdir.root_transport.base == self.root_transport.base:
677
return repository, True
678
elif repository.is_shared():
679
return repository, True
683
found_repo = self._find_containing(usable_repository)
684
if found_repo is None:
685
raise errors.NoRepositoryPresent(self)
688
def get_branch_reference(self):
689
"""Return the referenced URL for the branch in this bzrdir.
691
:raises NotBranchError: If there is no Branch.
692
:return: The URL the branch in this bzrdir references if it is a
693
reference branch, or None for regular branches.
697
def get_branch_transport(self, branch_format):
698
"""Get the transport for use by branch format in this BzrDir.
700
Note that bzr dirs that do not support format strings will raise
701
IncompatibleFormat if the branch format they are given has
702
a format string, and vice versa.
704
If branch_format is None, the transport is returned with no
705
checking. If it is not None, then the returned transport is
706
guaranteed to point to an existing directory ready for use.
708
raise NotImplementedError(self.get_branch_transport)
710
def _find_creation_modes(self):
711
"""Determine the appropriate modes for files and directories.
713
They're always set to be consistent with the base directory,
714
assuming that this transport allows setting modes.
716
# TODO: Do we need or want an option (maybe a config setting) to turn
717
# this off or override it for particular locations? -- mbp 20080512
718
if self._mode_check_done:
720
self._mode_check_done = True
722
st = self.transport.stat('.')
723
except errors.TransportNotPossible:
724
self._dir_mode = None
725
self._file_mode = None
727
# Check the directory mode, but also make sure the created
728
# directories and files are read-write for this user. This is
729
# mostly a workaround for filesystems which lie about being able to
730
# write to a directory (cygwin & win32)
731
if (st.st_mode & 07777 == 00000):
732
# FTP allows stat but does not return dir/file modes
733
self._dir_mode = None
734
self._file_mode = None
736
self._dir_mode = (st.st_mode & 07777) | 00700
737
# Remove the sticky and execute bits for files
738
self._file_mode = self._dir_mode & ~07111
740
def _get_file_mode(self):
741
"""Return Unix mode for newly created files, or None.
743
if not self._mode_check_done:
744
self._find_creation_modes()
745
return self._file_mode
747
def _get_dir_mode(self):
748
"""Return Unix mode for newly created directories, or None.
750
if not self._mode_check_done:
751
self._find_creation_modes()
752
return self._dir_mode
754
def get_repository_transport(self, repository_format):
755
"""Get the transport for use by repository format in this BzrDir.
757
Note that bzr dirs that do not support format strings will raise
758
IncompatibleFormat if the repository format they are given has
759
a format string, and vice versa.
761
If repository_format is None, the transport is returned with no
762
checking. If it is not None, then the returned transport is
763
guaranteed to point to an existing directory ready for use.
765
raise NotImplementedError(self.get_repository_transport)
767
def get_workingtree_transport(self, tree_format):
768
"""Get the transport for use by workingtree format in this BzrDir.
770
Note that bzr dirs that do not support format strings will raise
771
IncompatibleFormat if the workingtree format they are given has a
772
format string, and vice versa.
774
If workingtree_format is None, the transport is returned with no
775
checking. If it is not None, then the returned transport is
776
guaranteed to point to an existing directory ready for use.
778
raise NotImplementedError(self.get_workingtree_transport)
780
def get_config(self):
781
"""Get configuration for this BzrDir."""
782
return config.BzrDirConfig(self)
784
def _get_config(self):
785
"""By default, no configuration is available."""
788
def __init__(self, _transport, _format):
789
"""Initialize a Bzr control dir object.
791
Only really common logic should reside here, concrete classes should be
792
made with varying behaviours.
794
:param _format: the format that is creating this BzrDir instance.
795
:param _transport: the transport this dir is based at.
797
self._format = _format
798
self.transport = _transport.clone('.bzr')
799
self.root_transport = _transport
800
self._mode_check_done = False
802
def is_control_filename(self, filename):
803
"""True if filename is the name of a path which is reserved for bzrdir's.
805
:param filename: A filename within the root transport of this bzrdir.
807
This is true IF and ONLY IF the filename is part of the namespace reserved
808
for bzr control dirs. Currently this is the '.bzr' directory in the root
809
of the root_transport. it is expected that plugins will need to extend
810
this in the future - for instance to make bzr talk with svn working
813
# this might be better on the BzrDirFormat class because it refers to
814
# all the possible bzrdir disk formats.
815
# This method is tested via the workingtree is_control_filename tests-
816
# it was extracted from WorkingTree.is_control_filename. If the method's
817
# contract is extended beyond the current trivial implementation, please
818
# add new tests for it to the appropriate place.
819
return filename == '.bzr' or filename.startswith('.bzr/')
821
def needs_format_conversion(self, format=None):
822
"""Return true if this bzrdir needs convert_format run on it.
824
For instance, if the repository format is out of date but the
825
branch and working tree are not, this should return True.
827
:param format: Optional parameter indicating a specific desired
828
format we plan to arrive at.
830
raise NotImplementedError(self.needs_format_conversion)
833
def open_unsupported(base):
834
"""Open a branch which is not supported."""
835
return BzrDir.open(base, _unsupported=True)
838
def open(base, _unsupported=False, possible_transports=None):
839
"""Open an existing bzrdir, rooted at 'base' (url).
841
:param _unsupported: a private parameter to the BzrDir class.
843
t = get_transport(base, possible_transports=possible_transports)
844
return BzrDir.open_from_transport(t, _unsupported=_unsupported)
847
def open_from_transport(transport, _unsupported=False,
848
_server_formats=True):
849
"""Open a bzrdir within a particular directory.
851
:param transport: Transport containing the bzrdir.
852
:param _unsupported: private.
854
for hook in BzrDir.hooks['pre_open']:
856
# Keep initial base since 'transport' may be modified while following
858
base = transport.base
859
def find_format(transport):
860
return transport, BzrDirFormat.find_format(
861
transport, _server_formats=_server_formats)
863
def redirected(transport, e, redirection_notice):
864
redirected_transport = transport._redirected_to(e.source, e.target)
865
if redirected_transport is None:
866
raise errors.NotBranchError(base)
867
note('%s is%s redirected to %s',
868
transport.base, e.permanently, redirected_transport.base)
869
return redirected_transport
872
transport, format = do_catching_redirections(find_format,
875
except errors.TooManyRedirections:
876
raise errors.NotBranchError(base)
878
BzrDir._check_supported(format, _unsupported)
879
return format.open(transport, _found=True)
881
def open_branch(self, unsupported=False, ignore_fallbacks=False):
882
"""Open the branch object at this BzrDir if one is present.
884
If unsupported is True, then no longer supported branch formats can
887
TODO: static convenience version of this?
889
raise NotImplementedError(self.open_branch)
892
def open_containing(url, possible_transports=None):
893
"""Open an existing branch which contains url.
895
:param url: url to search from.
896
See open_containing_from_transport for more detail.
898
transport = get_transport(url, possible_transports)
899
return BzrDir.open_containing_from_transport(transport)
902
def open_containing_from_transport(a_transport):
903
"""Open an existing branch which contains a_transport.base.
905
This probes for a branch at a_transport, and searches upwards from there.
907
Basically we keep looking up until we find the control directory or
908
run into the root. If there isn't one, raises NotBranchError.
909
If there is one and it is either an unrecognised format or an unsupported
910
format, UnknownFormatError or UnsupportedFormatError are raised.
911
If there is one, it is returned, along with the unused portion of url.
913
:return: The BzrDir that contains the path, and a Unicode path
914
for the rest of the URL.
916
# this gets the normalised url back. I.e. '.' -> the full path.
917
url = a_transport.base
920
result = BzrDir.open_from_transport(a_transport)
921
return result, urlutils.unescape(a_transport.relpath(url))
922
except errors.NotBranchError, e:
925
new_t = a_transport.clone('..')
926
except errors.InvalidURLJoin:
927
# reached the root, whatever that may be
928
raise errors.NotBranchError(path=url)
929
if new_t.base == a_transport.base:
930
# reached the root, whatever that may be
931
raise errors.NotBranchError(path=url)
934
def _get_tree_branch(self):
935
"""Return the branch and tree, if any, for this bzrdir.
937
Return None for tree if not present or inaccessible.
938
Raise NotBranchError if no branch is present.
939
:return: (tree, branch)
942
tree = self.open_workingtree()
943
except (errors.NoWorkingTree, errors.NotLocalUrl):
945
branch = self.open_branch()
951
def open_tree_or_branch(klass, location):
952
"""Return the branch and working tree at a location.
954
If there is no tree at the location, tree will be None.
955
If there is no branch at the location, an exception will be
957
:return: (tree, branch)
959
bzrdir = klass.open(location)
960
return bzrdir._get_tree_branch()
963
def open_containing_tree_or_branch(klass, location):
964
"""Return the branch and working tree contained by a location.
966
Returns (tree, branch, relpath).
967
If there is no tree at containing the location, tree will be None.
968
If there is no branch containing the location, an exception will be
970
relpath is the portion of the path that is contained by the branch.
972
bzrdir, relpath = klass.open_containing(location)
973
tree, branch = bzrdir._get_tree_branch()
974
return tree, branch, relpath
977
def open_containing_tree_branch_or_repository(klass, location):
978
"""Return the working tree, branch and repo contained by a location.
980
Returns (tree, branch, repository, relpath).
981
If there is no tree containing the location, tree will be None.
982
If there is no branch containing the location, branch will be None.
983
If there is no repository containing the location, repository will be
985
relpath is the portion of the path that is contained by the innermost
988
If no tree, branch or repository is found, a NotBranchError is raised.
990
bzrdir, relpath = klass.open_containing(location)
992
tree, branch = bzrdir._get_tree_branch()
993
except errors.NotBranchError:
995
repo = bzrdir.find_repository()
996
return None, None, repo, relpath
997
except (errors.NoRepositoryPresent):
998
raise errors.NotBranchError(location)
999
return tree, branch, branch.repository, relpath
1001
def open_repository(self, _unsupported=False):
1002
"""Open the repository object at this BzrDir if one is present.
1004
This will not follow the Branch object pointer - it's strictly a direct
1005
open facility. Most client code should use open_branch().repository to
1006
get at a repository.
1008
:param _unsupported: a private parameter, not part of the api.
1009
TODO: static convenience version of this?
1011
raise NotImplementedError(self.open_repository)
1013
def open_workingtree(self, _unsupported=False,
1014
recommend_upgrade=True, from_branch=None):
1015
"""Open the workingtree object at this BzrDir if one is present.
1017
:param recommend_upgrade: Optional keyword parameter, when True (the
1018
default), emit through the ui module a recommendation that the user
1019
upgrade the working tree when the workingtree being opened is old
1020
(but still fully supported).
1021
:param from_branch: override bzrdir branch (for lightweight checkouts)
1023
raise NotImplementedError(self.open_workingtree)
1025
def has_branch(self):
1026
"""Tell if this bzrdir contains a branch.
1028
Note: if you're going to open the branch, you should just go ahead
1029
and try, and not ask permission first. (This method just opens the
1030
branch and discards it, and that's somewhat expensive.)
1035
except errors.NotBranchError:
1038
def has_workingtree(self):
1039
"""Tell if this bzrdir contains a working tree.
1041
This will still raise an exception if the bzrdir has a workingtree that
1042
is remote & inaccessible.
1044
Note: if you're going to open the working tree, you should just go ahead
1045
and try, and not ask permission first. (This method just opens the
1046
workingtree and discards it, and that's somewhat expensive.)
1049
self.open_workingtree(recommend_upgrade=False)
1051
except errors.NoWorkingTree:
1054
def _cloning_metadir(self):
1055
"""Produce a metadir suitable for cloning with.
1057
:returns: (destination_bzrdir_format, source_repository)
1059
result_format = self._format.__class__()
1062
branch = self.open_branch(ignore_fallbacks=True)
1063
source_repository = branch.repository
1064
result_format._branch_format = branch._format
1065
except errors.NotBranchError:
1066
source_branch = None
1067
source_repository = self.open_repository()
1068
except errors.NoRepositoryPresent:
1069
source_repository = None
1071
# XXX TODO: This isinstance is here because we have not implemented
1072
# the fix recommended in bug # 103195 - to delegate this choice the
1073
# repository itself.
1074
repo_format = source_repository._format
1075
if isinstance(repo_format, remote.RemoteRepositoryFormat):
1076
source_repository._ensure_real()
1077
repo_format = source_repository._real_repository._format
1078
result_format.repository_format = repo_format
1080
# TODO: Couldn't we just probe for the format in these cases,
1081
# rather than opening the whole tree? It would be a little
1082
# faster. mbp 20070401
1083
tree = self.open_workingtree(recommend_upgrade=False)
1084
except (errors.NoWorkingTree, errors.NotLocalUrl):
1085
result_format.workingtree_format = None
1087
result_format.workingtree_format = tree._format.__class__()
1088
return result_format, source_repository
1090
def cloning_metadir(self, require_stacking=False):
1091
"""Produce a metadir suitable for cloning or sprouting with.
1093
These operations may produce workingtrees (yes, even though they're
1094
"cloning" something that doesn't have a tree), so a viable workingtree
1095
format must be selected.
1097
:require_stacking: If True, non-stackable formats will be upgraded
1098
to similar stackable formats.
1099
:returns: a BzrDirFormat with all component formats either set
1100
appropriately or set to None if that component should not be
1103
format, repository = self._cloning_metadir()
1104
if format._workingtree_format is None:
1106
if repository is None:
1107
# No repository either
1109
# We have a repository, so set a working tree? (Why? This seems to
1110
# contradict the stated return value in the docstring).
1111
tree_format = repository._format._matchingbzrdir.workingtree_format
1112
format.workingtree_format = tree_format.__class__()
1113
if require_stacking:
1114
format.require_stacking()
1117
def checkout_metadir(self):
1118
return self.cloning_metadir()
1120
def sprout(self, url, revision_id=None, force_new_repo=False,
1121
recurse='down', possible_transports=None,
1122
accelerator_tree=None, hardlink=False, stacked=False,
1123
source_branch=None, create_tree_if_local=True):
1124
"""Create a copy of this bzrdir prepared for use as a new line of
1127
If url's last component does not exist, it will be created.
1129
Attributes related to the identity of the source branch like
1130
branch nickname will be cleaned, a working tree is created
1131
whether one existed before or not; and a local branch is always
1134
if revision_id is not None, then the clone operation may tune
1135
itself to download less data.
1136
:param accelerator_tree: A tree which can be used for retrieving file
1137
contents more quickly than the revision tree, i.e. a workingtree.
1138
The revision tree will be used for cases where accelerator_tree's
1139
content is different.
1140
:param hardlink: If true, hard-link files from accelerator_tree,
1142
:param stacked: If true, create a stacked branch referring to the
1143
location of this control directory.
1144
:param create_tree_if_local: If true, a working-tree will be created
1145
when working locally.
1147
target_transport = get_transport(url, possible_transports)
1148
target_transport.ensure_base()
1149
cloning_format = self.cloning_metadir(stacked)
1150
# Create/update the result branch
1151
result = cloning_format.initialize_on_transport(target_transport)
1152
# if a stacked branch wasn't requested, we don't create one
1153
# even if the origin was stacked
1154
stacked_branch_url = None
1155
if source_branch is not None:
1157
stacked_branch_url = self.root_transport.base
1158
source_repository = source_branch.repository
1161
source_branch = self.open_branch()
1162
source_repository = source_branch.repository
1164
stacked_branch_url = self.root_transport.base
1165
except errors.NotBranchError:
1166
source_branch = None
1168
source_repository = self.open_repository()
1169
except errors.NoRepositoryPresent:
1170
source_repository = None
1171
repository_policy = result.determine_repository_policy(
1172
force_new_repo, stacked_branch_url, require_stacking=stacked)
1173
result_repo, is_new_repo = repository_policy.acquire_repository()
1174
if is_new_repo and revision_id is not None and not stacked:
1175
fetch_spec = graph.PendingAncestryResult(
1176
[revision_id], source_repository)
1179
if source_repository is not None:
1180
# Fetch while stacked to prevent unstacked fetch from
1182
if fetch_spec is None:
1183
result_repo.fetch(source_repository, revision_id=revision_id)
1185
result_repo.fetch(source_repository, fetch_spec=fetch_spec)
1187
if source_branch is None:
1188
# this is for sprouting a bzrdir without a branch; is that
1190
# Not especially, but it's part of the contract.
1191
result_branch = result.create_branch()
1193
result_branch = source_branch.sprout(result,
1194
revision_id=revision_id, repository_policy=repository_policy)
1195
mutter("created new branch %r" % (result_branch,))
1197
# Create/update the result working tree
1198
if (create_tree_if_local and
1199
isinstance(target_transport, local.LocalTransport) and
1200
(result_repo is None or result_repo.make_working_trees())):
1201
wt = result.create_workingtree(accelerator_tree=accelerator_tree,
1205
if wt.path2id('') is None:
1207
wt.set_root_id(self.open_workingtree.get_root_id())
1208
except errors.NoWorkingTree:
1214
if recurse == 'down':
1216
basis = wt.basis_tree()
1218
subtrees = basis.iter_references()
1219
elif result_branch is not None:
1220
basis = result_branch.basis_tree()
1222
subtrees = basis.iter_references()
1223
elif source_branch is not None:
1224
basis = source_branch.basis_tree()
1226
subtrees = basis.iter_references()
1231
for path, file_id in subtrees:
1232
target = urlutils.join(url, urlutils.escape(path))
1233
sublocation = source_branch.reference_parent(file_id, path)
1234
sublocation.bzrdir.sprout(target,
1235
basis.get_reference_revision(file_id, path),
1236
force_new_repo=force_new_repo, recurse=recurse,
1239
if basis is not None:
1243
def push_branch(self, source, revision_id=None, overwrite=False,
1244
remember=False, create_prefix=False):
1245
"""Push the source branch into this BzrDir."""
1247
# If we can open a branch, use its direct repository, otherwise see
1248
# if there is a repository without a branch.
1250
br_to = self.open_branch()
1251
except errors.NotBranchError:
1252
# Didn't find a branch, can we find a repository?
1253
repository_to = self.find_repository()
1255
# Found a branch, so we must have found a repository
1256
repository_to = br_to.repository
1258
push_result = PushResult()
1259
push_result.source_branch = source
1261
# We have a repository but no branch, copy the revisions, and then
1263
repository_to.fetch(source.repository, revision_id=revision_id)
1264
br_to = source.clone(self, revision_id=revision_id)
1265
if source.get_push_location() is None or remember:
1266
source.set_push_location(br_to.base)
1267
push_result.stacked_on = None
1268
push_result.branch_push_result = None
1269
push_result.old_revno = None
1270
push_result.old_revid = _mod_revision.NULL_REVISION
1271
push_result.target_branch = br_to
1272
push_result.master_branch = None
1273
push_result.workingtree_updated = False
1275
# We have successfully opened the branch, remember if necessary:
1276
if source.get_push_location() is None or remember:
1277
source.set_push_location(br_to.base)
1279
tree_to = self.open_workingtree()
1280
except errors.NotLocalUrl:
1281
push_result.branch_push_result = source.push(br_to,
1282
overwrite, stop_revision=revision_id)
1283
push_result.workingtree_updated = False
1284
except errors.NoWorkingTree:
1285
push_result.branch_push_result = source.push(br_to,
1286
overwrite, stop_revision=revision_id)
1287
push_result.workingtree_updated = None # Not applicable
1289
tree_to.lock_write()
1291
push_result.branch_push_result = source.push(
1292
tree_to.branch, overwrite, stop_revision=revision_id)
1296
push_result.workingtree_updated = True
1297
push_result.old_revno = push_result.branch_push_result.old_revno
1298
push_result.old_revid = push_result.branch_push_result.old_revid
1299
push_result.target_branch = \
1300
push_result.branch_push_result.target_branch
1304
class BzrDirHooks(hooks.Hooks):
1305
"""Hooks for BzrDir operations."""
1308
"""Create the default hooks."""
1309
hooks.Hooks.__init__(self)
1310
self.create_hook(hooks.HookPoint('pre_open',
1311
"Invoked before attempting to open a BzrDir with the transport "
1312
"that the open will use.", (1, 14), None))
1314
# install the default hooks
1315
BzrDir.hooks = BzrDirHooks()
1318
class BzrDirPreSplitOut(BzrDir):
1319
"""A common class for the all-in-one formats."""
1321
def __init__(self, _transport, _format):
1322
"""See BzrDir.__init__."""
1323
super(BzrDirPreSplitOut, self).__init__(_transport, _format)
1324
self._control_files = lockable_files.LockableFiles(
1325
self.get_branch_transport(None),
1326
self._format._lock_file_name,
1327
self._format._lock_class)
1329
def break_lock(self):
1330
"""Pre-splitout bzrdirs do not suffer from stale locks."""
1331
raise NotImplementedError(self.break_lock)
1333
def cloning_metadir(self, require_stacking=False):
1334
"""Produce a metadir suitable for cloning with."""
1335
if require_stacking:
1336
return format_registry.make_bzrdir('1.6')
1337
return self._format.__class__()
1339
def clone(self, url, revision_id=None, force_new_repo=False,
1340
preserve_stacking=False):
1341
"""See BzrDir.clone().
1343
force_new_repo has no effect, since this family of formats always
1344
require a new repository.
1345
preserve_stacking has no effect, since no source branch using this
1346
family of formats can be stacked, so there is no stacking to preserve.
1348
self._make_tail(url)
1349
result = self._format._initialize_for_clone(url)
1350
self.open_repository().clone(result, revision_id=revision_id)
1351
from_branch = self.open_branch()
1352
from_branch.clone(result, revision_id=revision_id)
1354
tree = self.open_workingtree()
1355
except errors.NotLocalUrl:
1356
# make a new one, this format always has to have one.
1357
result._init_workingtree()
1362
def create_branch(self):
1363
"""See BzrDir.create_branch."""
1364
return self._format.get_branch_format().initialize(self)
1366
def destroy_branch(self):
1367
"""See BzrDir.destroy_branch."""
1368
raise errors.UnsupportedOperation(self.destroy_branch, self)
1370
def create_repository(self, shared=False):
1371
"""See BzrDir.create_repository."""
1373
raise errors.IncompatibleFormat('shared repository', self._format)
1374
return self.open_repository()
1376
def destroy_repository(self):
1377
"""See BzrDir.destroy_repository."""
1378
raise errors.UnsupportedOperation(self.destroy_repository, self)
1380
def create_workingtree(self, revision_id=None, from_branch=None,
1381
accelerator_tree=None, hardlink=False):
1382
"""See BzrDir.create_workingtree."""
1383
# The workingtree is sometimes created when the bzrdir is created,
1384
# but not when cloning.
1386
# this looks buggy but is not -really-
1387
# because this format creates the workingtree when the bzrdir is
1389
# clone and sprout will have set the revision_id
1390
# and that will have set it for us, its only
1391
# specific uses of create_workingtree in isolation
1392
# that can do wonky stuff here, and that only
1393
# happens for creating checkouts, which cannot be
1394
# done on this format anyway. So - acceptable wart.
1396
warning("can't support hardlinked working trees in %r"
1399
result = self.open_workingtree(recommend_upgrade=False)
1400
except errors.NoSuchFile:
1401
result = self._init_workingtree()
1402
if revision_id is not None:
1403
if revision_id == _mod_revision.NULL_REVISION:
1404
result.set_parent_ids([])
1406
result.set_parent_ids([revision_id])
1409
def _init_workingtree(self):
1410
from bzrlib.workingtree import WorkingTreeFormat2
1412
return WorkingTreeFormat2().initialize(self)
1413
except errors.NotLocalUrl:
1414
# Even though we can't access the working tree, we need to
1415
# create its control files.
1416
return WorkingTreeFormat2()._stub_initialize_on_transport(
1417
self.transport, self._control_files._file_mode)
1419
def destroy_workingtree(self):
1420
"""See BzrDir.destroy_workingtree."""
1421
raise errors.UnsupportedOperation(self.destroy_workingtree, self)
1423
def destroy_workingtree_metadata(self):
1424
"""See BzrDir.destroy_workingtree_metadata."""
1425
raise errors.UnsupportedOperation(self.destroy_workingtree_metadata,
1428
def get_branch_transport(self, branch_format):
1429
"""See BzrDir.get_branch_transport()."""
1430
if branch_format is None:
1431
return self.transport
1433
branch_format.get_format_string()
1434
except NotImplementedError:
1435
return self.transport
1436
raise errors.IncompatibleFormat(branch_format, self._format)
1438
def get_repository_transport(self, repository_format):
1439
"""See BzrDir.get_repository_transport()."""
1440
if repository_format is None:
1441
return self.transport
1443
repository_format.get_format_string()
1444
except NotImplementedError:
1445
return self.transport
1446
raise errors.IncompatibleFormat(repository_format, self._format)
1448
def get_workingtree_transport(self, workingtree_format):
1449
"""See BzrDir.get_workingtree_transport()."""
1450
if workingtree_format is None:
1451
return self.transport
1453
workingtree_format.get_format_string()
1454
except NotImplementedError:
1455
return self.transport
1456
raise errors.IncompatibleFormat(workingtree_format, self._format)
1458
def needs_format_conversion(self, format=None):
1459
"""See BzrDir.needs_format_conversion()."""
1460
# if the format is not the same as the system default,
1461
# an upgrade is needed.
1463
symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1464
% 'needs_format_conversion(format=None)')
1465
format = BzrDirFormat.get_default_format()
1466
return not isinstance(self._format, format.__class__)
1468
def open_branch(self, unsupported=False, ignore_fallbacks=False):
1469
"""See BzrDir.open_branch."""
1470
from bzrlib.branch import BzrBranchFormat4
1471
format = BzrBranchFormat4()
1472
self._check_supported(format, unsupported)
1473
return format.open(self, _found=True)
1475
def sprout(self, url, revision_id=None, force_new_repo=False,
1476
possible_transports=None, accelerator_tree=None,
1477
hardlink=False, stacked=False, create_tree_if_local=True,
1478
source_branch=None):
1479
"""See BzrDir.sprout()."""
1480
if source_branch is not None:
1481
my_branch = self.open_branch()
1482
if source_branch.base != my_branch.base:
1483
raise AssertionError(
1484
"source branch %r is not within %r with branch %r" %
1485
(source_branch, self, my_branch))
1487
raise errors.UnstackableBranchFormat(
1488
self._format, self.root_transport.base)
1489
if not create_tree_if_local:
1490
raise errors.MustHaveWorkingTree(
1491
self._format, self.root_transport.base)
1492
from bzrlib.workingtree import WorkingTreeFormat2
1493
self._make_tail(url)
1494
result = self._format._initialize_for_clone(url)
1496
self.open_repository().clone(result, revision_id=revision_id)
1497
except errors.NoRepositoryPresent:
1500
self.open_branch().sprout(result, revision_id=revision_id)
1501
except errors.NotBranchError:
1504
# we always want a working tree
1505
WorkingTreeFormat2().initialize(result,
1506
accelerator_tree=accelerator_tree,
1511
class BzrDir4(BzrDirPreSplitOut):
1512
"""A .bzr version 4 control object.
1514
This is a deprecated format and may be removed after sept 2006.
1517
def create_repository(self, shared=False):
1518
"""See BzrDir.create_repository."""
1519
return self._format.repository_format.initialize(self, shared)
1521
def needs_format_conversion(self, format=None):
1522
"""Format 4 dirs are always in need of conversion."""
1524
symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1525
% 'needs_format_conversion(format=None)')
1528
def open_repository(self):
1529
"""See BzrDir.open_repository."""
1530
from bzrlib.repofmt.weaverepo import RepositoryFormat4
1531
return RepositoryFormat4().open(self, _found=True)
1534
class BzrDir5(BzrDirPreSplitOut):
1535
"""A .bzr version 5 control object.
1537
This is a deprecated format and may be removed after sept 2006.
1540
def open_repository(self):
1541
"""See BzrDir.open_repository."""
1542
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1543
return RepositoryFormat5().open(self, _found=True)
1545
def open_workingtree(self, _unsupported=False,
1546
recommend_upgrade=True):
1547
"""See BzrDir.create_workingtree."""
1548
from bzrlib.workingtree import WorkingTreeFormat2
1549
wt_format = WorkingTreeFormat2()
1550
# we don't warn here about upgrades; that ought to be handled for the
1552
return wt_format.open(self, _found=True)
1555
class BzrDir6(BzrDirPreSplitOut):
1556
"""A .bzr version 6 control object.
1558
This is a deprecated format and may be removed after sept 2006.
1561
def open_repository(self):
1562
"""See BzrDir.open_repository."""
1563
from bzrlib.repofmt.weaverepo import RepositoryFormat6
1564
return RepositoryFormat6().open(self, _found=True)
1566
def open_workingtree(self, _unsupported=False,
1567
recommend_upgrade=True):
1568
"""See BzrDir.create_workingtree."""
1569
# we don't warn here about upgrades; that ought to be handled for the
1571
from bzrlib.workingtree import WorkingTreeFormat2
1572
return WorkingTreeFormat2().open(self, _found=True)
1575
class BzrDirMeta1(BzrDir):
1576
"""A .bzr meta version 1 control object.
1578
This is the first control object where the
1579
individual aspects are really split out: there are separate repository,
1580
workingtree and branch subdirectories and any subset of the three can be
1581
present within a BzrDir.
1584
def can_convert_format(self):
1585
"""See BzrDir.can_convert_format()."""
1588
def create_branch(self):
1589
"""See BzrDir.create_branch."""
1590
return self._format.get_branch_format().initialize(self)
1592
def destroy_branch(self):
1593
"""See BzrDir.create_branch."""
1594
self.transport.delete_tree('branch')
1596
def create_repository(self, shared=False):
1597
"""See BzrDir.create_repository."""
1598
return self._format.repository_format.initialize(self, shared)
1600
def destroy_repository(self):
1601
"""See BzrDir.destroy_repository."""
1602
self.transport.delete_tree('repository')
1604
def create_workingtree(self, revision_id=None, from_branch=None,
1605
accelerator_tree=None, hardlink=False):
1606
"""See BzrDir.create_workingtree."""
1607
return self._format.workingtree_format.initialize(
1608
self, revision_id, from_branch=from_branch,
1609
accelerator_tree=accelerator_tree, hardlink=hardlink)
1611
def destroy_workingtree(self):
1612
"""See BzrDir.destroy_workingtree."""
1613
wt = self.open_workingtree(recommend_upgrade=False)
1614
repository = wt.branch.repository
1615
empty = repository.revision_tree(_mod_revision.NULL_REVISION)
1616
wt.revert(old_tree=empty)
1617
self.destroy_workingtree_metadata()
1619
def destroy_workingtree_metadata(self):
1620
self.transport.delete_tree('checkout')
1622
def find_branch_format(self):
1623
"""Find the branch 'format' for this bzrdir.
1625
This might be a synthetic object for e.g. RemoteBranch and SVN.
1627
from bzrlib.branch import BranchFormat
1628
return BranchFormat.find_format(self)
1630
def _get_mkdir_mode(self):
1631
"""Figure out the mode to use when creating a bzrdir subdir."""
1632
temp_control = lockable_files.LockableFiles(self.transport, '',
1633
lockable_files.TransportLock)
1634
return temp_control._dir_mode
1636
def get_branch_reference(self):
1637
"""See BzrDir.get_branch_reference()."""
1638
from bzrlib.branch import BranchFormat
1639
format = BranchFormat.find_format(self)
1640
return format.get_reference(self)
1642
def get_branch_transport(self, branch_format):
1643
"""See BzrDir.get_branch_transport()."""
1644
# XXX: this shouldn't implicitly create the directory if it's just
1645
# promising to get a transport -- mbp 20090727
1646
if branch_format is None:
1647
return self.transport.clone('branch')
1649
branch_format.get_format_string()
1650
except NotImplementedError:
1651
raise errors.IncompatibleFormat(branch_format, self._format)
1653
self.transport.mkdir('branch', mode=self._get_mkdir_mode())
1654
except errors.FileExists:
1656
return self.transport.clone('branch')
1658
def get_repository_transport(self, repository_format):
1659
"""See BzrDir.get_repository_transport()."""
1660
if repository_format is None:
1661
return self.transport.clone('repository')
1663
repository_format.get_format_string()
1664
except NotImplementedError:
1665
raise errors.IncompatibleFormat(repository_format, self._format)
1667
self.transport.mkdir('repository', mode=self._get_mkdir_mode())
1668
except errors.FileExists:
1670
return self.transport.clone('repository')
1672
def get_workingtree_transport(self, workingtree_format):
1673
"""See BzrDir.get_workingtree_transport()."""
1674
if workingtree_format is None:
1675
return self.transport.clone('checkout')
1677
workingtree_format.get_format_string()
1678
except NotImplementedError:
1679
raise errors.IncompatibleFormat(workingtree_format, self._format)
1681
self.transport.mkdir('checkout', mode=self._get_mkdir_mode())
1682
except errors.FileExists:
1684
return self.transport.clone('checkout')
1686
def needs_format_conversion(self, format=None):
1687
"""See BzrDir.needs_format_conversion()."""
1689
symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1690
% 'needs_format_conversion(format=None)')
1692
format = BzrDirFormat.get_default_format()
1693
if not isinstance(self._format, format.__class__):
1694
# it is not a meta dir format, conversion is needed.
1696
# we might want to push this down to the repository?
1698
if not isinstance(self.open_repository()._format,
1699
format.repository_format.__class__):
1700
# the repository needs an upgrade.
1702
except errors.NoRepositoryPresent:
1705
if not isinstance(self.open_branch()._format,
1706
format.get_branch_format().__class__):
1707
# the branch needs an upgrade.
1709
except errors.NotBranchError:
1712
my_wt = self.open_workingtree(recommend_upgrade=False)
1713
if not isinstance(my_wt._format,
1714
format.workingtree_format.__class__):
1715
# the workingtree needs an upgrade.
1717
except (errors.NoWorkingTree, errors.NotLocalUrl):
1721
def open_branch(self, unsupported=False, ignore_fallbacks=False):
1722
"""See BzrDir.open_branch."""
1723
format = self.find_branch_format()
1724
self._check_supported(format, unsupported)
1725
return format.open(self, _found=True, ignore_fallbacks=ignore_fallbacks)
1727
def open_repository(self, unsupported=False):
1728
"""See BzrDir.open_repository."""
1729
from bzrlib.repository import RepositoryFormat
1730
format = RepositoryFormat.find_format(self)
1731
self._check_supported(format, unsupported)
1732
return format.open(self, _found=True)
1734
def open_workingtree(self, unsupported=False,
1735
recommend_upgrade=True):
1736
"""See BzrDir.open_workingtree."""
1737
from bzrlib.workingtree import WorkingTreeFormat
1738
format = WorkingTreeFormat.find_format(self)
1739
self._check_supported(format, unsupported,
1741
basedir=self.root_transport.base)
1742
return format.open(self, _found=True)
1744
def _get_config(self):
1745
return config.TransportConfig(self.transport, 'control.conf')
1748
class BzrDirFormat(object):
1749
"""An encapsulation of the initialization and open routines for a format.
1751
Formats provide three things:
1752
* An initialization routine,
1756
Formats are placed in a dict by their format string for reference
1757
during bzrdir opening. These should be subclasses of BzrDirFormat
1760
Once a format is deprecated, just deprecate the initialize and open
1761
methods on the format class. Do not deprecate the object, as the
1762
object will be created every system load.
1765
_default_format = None
1766
"""The default format used for new .bzr dirs."""
1769
"""The known formats."""
1771
_control_formats = []
1772
"""The registered control formats - .bzr, ....
1774
This is a list of BzrDirFormat objects.
1777
_control_server_formats = []
1778
"""The registered control server formats, e.g. RemoteBzrDirs.
1780
This is a list of BzrDirFormat objects.
1783
_lock_file_name = 'branch-lock'
1785
# _lock_class must be set in subclasses to the lock type, typ.
1786
# TransportLock or LockDir
1789
def find_format(klass, transport, _server_formats=True):
1790
"""Return the format present at transport."""
1792
formats = klass._control_server_formats + klass._control_formats
1794
formats = klass._control_formats
1795
for format in formats:
1797
return format.probe_transport(transport)
1798
except errors.NotBranchError:
1799
# this format does not find a control dir here.
1801
raise errors.NotBranchError(path=transport.base)
1804
def probe_transport(klass, transport):
1805
"""Return the .bzrdir style format present in a directory."""
1807
format_string = transport.get(".bzr/branch-format").read()
1808
except errors.NoSuchFile:
1809
raise errors.NotBranchError(path=transport.base)
1812
return klass._formats[format_string]
1814
raise errors.UnknownFormatError(format=format_string, kind='bzrdir')
1817
def get_default_format(klass):
1818
"""Return the current default format."""
1819
return klass._default_format
1821
def get_format_string(self):
1822
"""Return the ASCII format string that identifies this format."""
1823
raise NotImplementedError(self.get_format_string)
1825
def get_format_description(self):
1826
"""Return the short description for this format."""
1827
raise NotImplementedError(self.get_format_description)
1829
def get_converter(self, format=None):
1830
"""Return the converter to use to convert bzrdirs needing converts.
1832
This returns a bzrlib.bzrdir.Converter object.
1834
This should return the best upgrader to step this format towards the
1835
current default format. In the case of plugins we can/should provide
1836
some means for them to extend the range of returnable converters.
1838
:param format: Optional format to override the default format of the
1841
raise NotImplementedError(self.get_converter)
1843
def initialize(self, url, possible_transports=None):
1844
"""Create a bzr control dir at this url and return an opened copy.
1846
While not deprecated, this method is very specific and its use will
1847
lead to many round trips to setup a working environment. See
1848
initialize_on_transport_ex for a [nearly] all-in-one method.
1850
Subclasses should typically override initialize_on_transport
1851
instead of this method.
1853
return self.initialize_on_transport(get_transport(url,
1854
possible_transports))
1856
def initialize_on_transport(self, transport):
1857
"""Initialize a new bzrdir in the base directory of a Transport."""
1859
# can we hand off the request to the smart server rather than using
1861
client_medium = transport.get_smart_medium()
1862
except errors.NoSmartMedium:
1863
return self._initialize_on_transport_vfs(transport)
1865
# Current RPC's only know how to create bzr metadir1 instances, so
1866
# we still delegate to vfs methods if the requested format is not a
1868
if type(self) != BzrDirMetaFormat1:
1869
return self._initialize_on_transport_vfs(transport)
1870
remote_format = RemoteBzrDirFormat()
1871
self._supply_sub_formats_to(remote_format)
1872
return remote_format.initialize_on_transport(transport)
1874
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
1875
create_prefix=False, force_new_repo=False, stacked_on=None,
1876
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
1877
shared_repo=False, vfs_only=False):
1878
"""Create this format on transport.
1880
The directory to initialize will be created.
1882
:param force_new_repo: Do not use a shared repository for the target,
1883
even if one is available.
1884
:param create_prefix: Create any missing directories leading up to
1886
:param use_existing_dir: Use an existing directory if one exists.
1887
:param stacked_on: A url to stack any created branch on, None to follow
1888
any target stacking policy.
1889
:param stack_on_pwd: If stack_on is relative, the location it is
1891
:param repo_format_name: If non-None, a repository will be
1892
made-or-found. Should none be found, or if force_new_repo is True
1893
the repo_format_name is used to select the format of repository to
1895
:param make_working_trees: Control the setting of make_working_trees
1896
for a new shared repository when one is made. None to use whatever
1897
default the format has.
1898
:param shared_repo: Control whether made repositories are shared or
1900
:param vfs_only: If True do not attempt to use a smart server
1901
:return: repo, bzrdir, require_stacking, repository_policy. repo is
1902
None if none was created or found, bzrdir is always valid.
1903
require_stacking is the result of examining the stacked_on
1904
parameter and any stacking policy found for the target.
1907
# Try to hand off to a smart server
1909
client_medium = transport.get_smart_medium()
1910
except errors.NoSmartMedium:
1913
# TODO: lookup the local format from a server hint.
1914
remote_dir_format = RemoteBzrDirFormat()
1915
remote_dir_format._network_name = self.network_name()
1916
self._supply_sub_formats_to(remote_dir_format)
1917
return remote_dir_format.initialize_on_transport_ex(transport,
1918
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
1919
force_new_repo=force_new_repo, stacked_on=stacked_on,
1920
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
1921
make_working_trees=make_working_trees, shared_repo=shared_repo)
1922
# XXX: Refactor the create_prefix/no_create_prefix code into a
1923
# common helper function
1924
# The destination may not exist - if so make it according to policy.
1925
def make_directory(transport):
1926
transport.mkdir('.')
1928
def redirected(transport, e, redirection_notice):
1929
note(redirection_notice)
1930
return transport._redirected_to(e.source, e.target)
1932
transport = do_catching_redirections(make_directory, transport,
1934
except errors.FileExists:
1935
if not use_existing_dir:
1937
except errors.NoSuchFile:
1938
if not create_prefix:
1940
transport.create_prefix()
1942
require_stacking = (stacked_on is not None)
1943
# Now the target directory exists, but doesn't have a .bzr
1944
# directory. So we need to create it, along with any work to create
1945
# all of the dependent branches, etc.
1947
result = self.initialize_on_transport(transport)
1948
if repo_format_name:
1950
# use a custom format
1951
result._format.repository_format = \
1952
repository.network_format_registry.get(repo_format_name)
1953
except AttributeError:
1954
# The format didn't permit it to be set.
1956
# A repository is desired, either in-place or shared.
1957
repository_policy = result.determine_repository_policy(
1958
force_new_repo, stacked_on, stack_on_pwd,
1959
require_stacking=require_stacking)
1960
result_repo, is_new_repo = repository_policy.acquire_repository(
1961
make_working_trees, shared_repo)
1962
if not require_stacking and repository_policy._require_stacking:
1963
require_stacking = True
1964
result._format.require_stacking()
1965
result_repo.lock_write()
1968
repository_policy = None
1969
return result_repo, result, require_stacking, repository_policy
1971
def _initialize_on_transport_vfs(self, transport):
1972
"""Initialize a new bzrdir using VFS calls.
1974
:param transport: The transport to create the .bzr directory in.
1977
# Since we are creating a .bzr directory, inherit the
1978
# mode from the root directory
1979
temp_control = lockable_files.LockableFiles(transport,
1980
'', lockable_files.TransportLock)
1981
temp_control._transport.mkdir('.bzr',
1982
# FIXME: RBC 20060121 don't peek under
1984
mode=temp_control._dir_mode)
1985
if sys.platform == 'win32' and isinstance(transport, local.LocalTransport):
1986
win32utils.set_file_attr_hidden(transport._abspath('.bzr'))
1987
file_mode = temp_control._file_mode
1989
bzrdir_transport = transport.clone('.bzr')
1990
utf8_files = [('README',
1991
"This is a Bazaar control directory.\n"
1992
"Do not change any files in this directory.\n"
1993
"See http://bazaar-vcs.org/ for more information about Bazaar.\n"),
1994
('branch-format', self.get_format_string()),
1996
# NB: no need to escape relative paths that are url safe.
1997
control_files = lockable_files.LockableFiles(bzrdir_transport,
1998
self._lock_file_name, self._lock_class)
1999
control_files.create_lock()
2000
control_files.lock_write()
2002
for (filename, content) in utf8_files:
2003
bzrdir_transport.put_bytes(filename, content,
2006
control_files.unlock()
2007
return self.open(transport, _found=True)
2009
def is_supported(self):
2010
"""Is this format supported?
2012
Supported formats must be initializable and openable.
2013
Unsupported formats may not support initialization or committing or
2014
some other features depending on the reason for not being supported.
2018
def network_name(self):
2019
"""A simple byte string uniquely identifying this format for RPC calls.
2021
Bzr control formats use thir disk format string to identify the format
2022
over the wire. Its possible that other control formats have more
2023
complex detection requirements, so we permit them to use any unique and
2024
immutable string they desire.
2026
raise NotImplementedError(self.network_name)
2028
def same_model(self, target_format):
2029
return (self.repository_format.rich_root_data ==
2030
target_format.rich_root_data)
2033
def known_formats(klass):
2034
"""Return all the known formats.
2036
Concrete formats should override _known_formats.
2038
# There is double indirection here to make sure that control
2039
# formats used by more than one dir format will only be probed
2040
# once. This can otherwise be quite expensive for remote connections.
2042
for format in klass._control_formats:
2043
result.update(format._known_formats())
2047
def _known_formats(klass):
2048
"""Return the known format instances for this control format."""
2049
return set(klass._formats.values())
2051
def open(self, transport, _found=False):
2052
"""Return an instance of this format for the dir transport points at.
2054
_found is a private parameter, do not use it.
2057
found_format = BzrDirFormat.find_format(transport)
2058
if not isinstance(found_format, self.__class__):
2059
raise AssertionError("%s was asked to open %s, but it seems to need "
2061
% (self, transport, found_format))
2062
# Allow subclasses - use the found format.
2063
self._supply_sub_formats_to(found_format)
2064
return found_format._open(transport)
2065
return self._open(transport)
2067
def _open(self, transport):
2068
"""Template method helper for opening BzrDirectories.
2070
This performs the actual open and any additional logic or parameter
2073
raise NotImplementedError(self._open)
2076
def register_format(klass, format):
2077
klass._formats[format.get_format_string()] = format
2078
# bzr native formats have a network name of their format string.
2079
network_format_registry.register(format.get_format_string(), format.__class__)
2082
def register_control_format(klass, format):
2083
"""Register a format that does not use '.bzr' for its control dir.
2085
TODO: This should be pulled up into a 'ControlDirFormat' base class
2086
which BzrDirFormat can inherit from, and renamed to register_format
2087
there. It has been done without that for now for simplicity of
2090
klass._control_formats.append(format)
2093
def register_control_server_format(klass, format):
2094
"""Register a control format for client-server environments.
2096
These formats will be tried before ones registered with
2097
register_control_format. This gives implementations that decide to the
2098
chance to grab it before anything looks at the contents of the format
2101
klass._control_server_formats.append(format)
2104
def _set_default_format(klass, format):
2105
"""Set default format (for testing behavior of defaults only)"""
2106
klass._default_format = format
2110
return self.get_format_description().rstrip()
2112
def _supply_sub_formats_to(self, other_format):
2113
"""Give other_format the same values for sub formats as this has.
2115
This method is expected to be used when parameterising a
2116
RemoteBzrDirFormat instance with the parameters from a
2117
BzrDirMetaFormat1 instance.
2119
:param other_format: other_format is a format which should be
2120
compatible with whatever sub formats are supported by self.
2125
def unregister_format(klass, format):
2126
del klass._formats[format.get_format_string()]
2129
def unregister_control_format(klass, format):
2130
klass._control_formats.remove(format)
2133
class BzrDirFormat4(BzrDirFormat):
2134
"""Bzr dir format 4.
2136
This format is a combined format for working tree, branch and repository.
2138
- Format 1 working trees [always]
2139
- Format 4 branches [always]
2140
- Format 4 repositories [always]
2142
This format is deprecated: it indexes texts using a text it which is
2143
removed in format 5; write support for this format has been removed.
2146
_lock_class = lockable_files.TransportLock
2148
def get_format_string(self):
2149
"""See BzrDirFormat.get_format_string()."""
2150
return "Bazaar-NG branch, format 0.0.4\n"
2152
def get_format_description(self):
2153
"""See BzrDirFormat.get_format_description()."""
2154
return "All-in-one format 4"
2156
def get_converter(self, format=None):
2157
"""See BzrDirFormat.get_converter()."""
2158
# there is one and only one upgrade path here.
2159
return ConvertBzrDir4To5()
2161
def initialize_on_transport(self, transport):
2162
"""Format 4 branches cannot be created."""
2163
raise errors.UninitializableFormat(self)
2165
def is_supported(self):
2166
"""Format 4 is not supported.
2168
It is not supported because the model changed from 4 to 5 and the
2169
conversion logic is expensive - so doing it on the fly was not
2174
def network_name(self):
2175
return self.get_format_string()
2177
def _open(self, transport):
2178
"""See BzrDirFormat._open."""
2179
return BzrDir4(transport, self)
2181
def __return_repository_format(self):
2182
"""Circular import protection."""
2183
from bzrlib.repofmt.weaverepo import RepositoryFormat4
2184
return RepositoryFormat4()
2185
repository_format = property(__return_repository_format)
2188
class BzrDirFormatAllInOne(BzrDirFormat):
2189
"""Common class for formats before meta-dirs."""
2191
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
2192
create_prefix=False, force_new_repo=False, stacked_on=None,
2193
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
2195
"""See BzrDirFormat.initialize_on_transport_ex."""
2196
require_stacking = (stacked_on is not None)
2197
# Format 5 cannot stack, but we've been asked to - actually init
2199
if require_stacking:
2200
format = BzrDirMetaFormat1()
2201
return format.initialize_on_transport_ex(transport,
2202
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2203
force_new_repo=force_new_repo, stacked_on=stacked_on,
2204
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2205
make_working_trees=make_working_trees, shared_repo=shared_repo)
2206
return BzrDirFormat.initialize_on_transport_ex(self, transport,
2207
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2208
force_new_repo=force_new_repo, stacked_on=stacked_on,
2209
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2210
make_working_trees=make_working_trees, shared_repo=shared_repo)
2213
class BzrDirFormat5(BzrDirFormatAllInOne):
2214
"""Bzr control format 5.
2216
This format is a combined format for working tree, branch and repository.
2218
- Format 2 working trees [always]
2219
- Format 4 branches [always]
2220
- Format 5 repositories [always]
2221
Unhashed stores in the repository.
2224
_lock_class = lockable_files.TransportLock
2226
def get_format_string(self):
2227
"""See BzrDirFormat.get_format_string()."""
2228
return "Bazaar-NG branch, format 5\n"
2230
def get_branch_format(self):
2231
from bzrlib import branch
2232
return branch.BzrBranchFormat4()
2234
def get_format_description(self):
2235
"""See BzrDirFormat.get_format_description()."""
2236
return "All-in-one format 5"
2238
def get_converter(self, format=None):
2239
"""See BzrDirFormat.get_converter()."""
2240
# there is one and only one upgrade path here.
2241
return ConvertBzrDir5To6()
2243
def _initialize_for_clone(self, url):
2244
return self.initialize_on_transport(get_transport(url), _cloning=True)
2246
def initialize_on_transport(self, transport, _cloning=False):
2247
"""Format 5 dirs always have working tree, branch and repository.
2249
Except when they are being cloned.
2251
from bzrlib.branch import BzrBranchFormat4
2252
from bzrlib.repofmt.weaverepo import RepositoryFormat5
2253
result = (super(BzrDirFormat5, self).initialize_on_transport(transport))
2254
RepositoryFormat5().initialize(result, _internal=True)
2256
branch = BzrBranchFormat4().initialize(result)
2257
result._init_workingtree()
2260
def network_name(self):
2261
return self.get_format_string()
2263
def _open(self, transport):
2264
"""See BzrDirFormat._open."""
2265
return BzrDir5(transport, self)
2267
def __return_repository_format(self):
2268
"""Circular import protection."""
2269
from bzrlib.repofmt.weaverepo import RepositoryFormat5
2270
return RepositoryFormat5()
2271
repository_format = property(__return_repository_format)
2274
class BzrDirFormat6(BzrDirFormatAllInOne):
2275
"""Bzr control format 6.
2277
This format is a combined format for working tree, branch and repository.
2279
- Format 2 working trees [always]
2280
- Format 4 branches [always]
2281
- Format 6 repositories [always]
2284
_lock_class = lockable_files.TransportLock
2286
def get_format_string(self):
2287
"""See BzrDirFormat.get_format_string()."""
2288
return "Bazaar-NG branch, format 6\n"
2290
def get_format_description(self):
2291
"""See BzrDirFormat.get_format_description()."""
2292
return "All-in-one format 6"
2294
def get_branch_format(self):
2295
from bzrlib import branch
2296
return branch.BzrBranchFormat4()
2298
def get_converter(self, format=None):
2299
"""See BzrDirFormat.get_converter()."""
2300
# there is one and only one upgrade path here.
2301
return ConvertBzrDir6ToMeta()
2303
def _initialize_for_clone(self, url):
2304
return self.initialize_on_transport(get_transport(url), _cloning=True)
2306
def initialize_on_transport(self, transport, _cloning=False):
2307
"""Format 6 dirs always have working tree, branch and repository.
2309
Except when they are being cloned.
2311
from bzrlib.branch import BzrBranchFormat4
2312
from bzrlib.repofmt.weaverepo import RepositoryFormat6
2313
result = super(BzrDirFormat6, self).initialize_on_transport(transport)
2314
RepositoryFormat6().initialize(result, _internal=True)
2316
branch = BzrBranchFormat4().initialize(result)
2317
result._init_workingtree()
2320
def network_name(self):
2321
return self.get_format_string()
2323
def _open(self, transport):
2324
"""See BzrDirFormat._open."""
2325
return BzrDir6(transport, self)
2327
def __return_repository_format(self):
2328
"""Circular import protection."""
2329
from bzrlib.repofmt.weaverepo import RepositoryFormat6
2330
return RepositoryFormat6()
2331
repository_format = property(__return_repository_format)
2334
class BzrDirMetaFormat1(BzrDirFormat):
2335
"""Bzr meta control format 1
2337
This is the first format with split out working tree, branch and repository
2340
- Format 3 working trees [optional]
2341
- Format 5 branches [optional]
2342
- Format 7 repositories [optional]
2345
_lock_class = lockdir.LockDir
2348
self._workingtree_format = None
2349
self._branch_format = None
2350
self._repository_format = None
2352
def __eq__(self, other):
2353
if other.__class__ is not self.__class__:
2355
if other.repository_format != self.repository_format:
2357
if other.workingtree_format != self.workingtree_format:
2361
def __ne__(self, other):
2362
return not self == other
2364
def get_branch_format(self):
2365
if self._branch_format is None:
2366
from bzrlib.branch import BranchFormat
2367
self._branch_format = BranchFormat.get_default_format()
2368
return self._branch_format
2370
def set_branch_format(self, format):
2371
self._branch_format = format
2373
def require_stacking(self, stack_on=None, possible_transports=None,
2375
"""We have a request to stack, try to ensure the formats support it.
2377
:param stack_on: If supplied, it is the URL to a branch that we want to
2378
stack on. Check to see if that format supports stacking before
2381
# Stacking is desired. requested by the target, but does the place it
2382
# points at support stacking? If it doesn't then we should
2383
# not implicitly upgrade. We check this here.
2384
new_repo_format = None
2385
new_branch_format = None
2387
# a bit of state for get_target_branch so that we don't try to open it
2388
# 2 times, for both repo *and* branch
2389
target = [None, False, None] # target_branch, checked, upgrade anyway
2390
def get_target_branch():
2392
# We've checked, don't check again
2394
if stack_on is None:
2395
# No target format, that means we want to force upgrading
2396
target[:] = [None, True, True]
2399
target_dir = BzrDir.open(stack_on,
2400
possible_transports=possible_transports)
2401
except errors.NotBranchError:
2402
# Nothing there, don't change formats
2403
target[:] = [None, True, False]
2405
except errors.JailBreak:
2406
# JailBreak, JFDI and upgrade anyway
2407
target[:] = [None, True, True]
2410
target_branch = target_dir.open_branch()
2411
except errors.NotBranchError:
2412
# No branch, don't upgrade formats
2413
target[:] = [None, True, False]
2415
target[:] = [target_branch, True, False]
2418
if (not _skip_repo and
2419
not self.repository_format.supports_external_lookups):
2420
# We need to upgrade the Repository.
2421
target_branch, _, do_upgrade = get_target_branch()
2422
if target_branch is None:
2423
# We don't have a target branch, should we upgrade anyway?
2425
# stack_on is inaccessible, JFDI.
2426
# TODO: bad monkey, hard-coded formats...
2427
if self.repository_format.rich_root_data:
2428
new_repo_format = pack_repo.RepositoryFormatKnitPack5RichRoot()
2430
new_repo_format = pack_repo.RepositoryFormatKnitPack5()
2432
# If the target already supports stacking, then we know the
2433
# project is already able to use stacking, so auto-upgrade
2435
new_repo_format = target_branch.repository._format
2436
if not new_repo_format.supports_external_lookups:
2437
# target doesn't, source doesn't, so don't auto upgrade
2439
new_repo_format = None
2440
if new_repo_format is not None:
2441
self.repository_format = new_repo_format
2442
note('Source repository format does not support stacking,'
2443
' using format:\n %s',
2444
new_repo_format.get_format_description())
2446
if not self.get_branch_format().supports_stacking():
2447
# We just checked the repo, now lets check if we need to
2448
# upgrade the branch format
2449
target_branch, _, do_upgrade = get_target_branch()
2450
if target_branch is None:
2452
# TODO: bad monkey, hard-coded formats...
2453
new_branch_format = branch.BzrBranchFormat7()
2455
new_branch_format = target_branch._format
2456
if not new_branch_format.supports_stacking():
2457
new_branch_format = None
2458
if new_branch_format is not None:
2459
# Does support stacking, use its format.
2460
self.set_branch_format(new_branch_format)
2461
note('Source branch format does not support stacking,'
2462
' using format:\n %s',
2463
new_branch_format.get_format_description())
2465
def get_converter(self, format=None):
2466
"""See BzrDirFormat.get_converter()."""
2468
format = BzrDirFormat.get_default_format()
2469
if not isinstance(self, format.__class__):
2470
# converting away from metadir is not implemented
2471
raise NotImplementedError(self.get_converter)
2472
return ConvertMetaToMeta(format)
2474
def get_format_string(self):
2475
"""See BzrDirFormat.get_format_string()."""
2476
return "Bazaar-NG meta directory, format 1\n"
2478
def get_format_description(self):
2479
"""See BzrDirFormat.get_format_description()."""
2480
return "Meta directory format 1"
2482
def network_name(self):
2483
return self.get_format_string()
2485
def _open(self, transport):
2486
"""See BzrDirFormat._open."""
2487
# Create a new format instance because otherwise initialisation of new
2488
# metadirs share the global default format object leading to alias
2490
format = BzrDirMetaFormat1()
2491
self._supply_sub_formats_to(format)
2492
return BzrDirMeta1(transport, format)
2494
def __return_repository_format(self):
2495
"""Circular import protection."""
2496
if self._repository_format:
2497
return self._repository_format
2498
from bzrlib.repository import RepositoryFormat
2499
return RepositoryFormat.get_default_format()
2501
def _set_repository_format(self, value):
2502
"""Allow changing the repository format for metadir formats."""
2503
self._repository_format = value
2505
repository_format = property(__return_repository_format,
2506
_set_repository_format)
2508
def _supply_sub_formats_to(self, other_format):
2509
"""Give other_format the same values for sub formats as this has.
2511
This method is expected to be used when parameterising a
2512
RemoteBzrDirFormat instance with the parameters from a
2513
BzrDirMetaFormat1 instance.
2515
:param other_format: other_format is a format which should be
2516
compatible with whatever sub formats are supported by self.
2519
if getattr(self, '_repository_format', None) is not None:
2520
other_format.repository_format = self.repository_format
2521
if self._branch_format is not None:
2522
other_format._branch_format = self._branch_format
2523
if self._workingtree_format is not None:
2524
other_format.workingtree_format = self.workingtree_format
2526
def __get_workingtree_format(self):
2527
if self._workingtree_format is None:
2528
from bzrlib.workingtree import WorkingTreeFormat
2529
self._workingtree_format = WorkingTreeFormat.get_default_format()
2530
return self._workingtree_format
2532
def __set_workingtree_format(self, wt_format):
2533
self._workingtree_format = wt_format
2535
workingtree_format = property(__get_workingtree_format,
2536
__set_workingtree_format)
2539
network_format_registry = registry.FormatRegistry()
2540
"""Registry of formats indexed by their network name.
2542
The network name for a BzrDirFormat is an identifier that can be used when
2543
referring to formats with smart server operations. See
2544
BzrDirFormat.network_name() for more detail.
2548
# Register bzr control format
2549
BzrDirFormat.register_control_format(BzrDirFormat)
2551
# Register bzr formats
2552
BzrDirFormat.register_format(BzrDirFormat4())
2553
BzrDirFormat.register_format(BzrDirFormat5())
2554
BzrDirFormat.register_format(BzrDirFormat6())
2555
__default_format = BzrDirMetaFormat1()
2556
BzrDirFormat.register_format(__default_format)
2557
BzrDirFormat._default_format = __default_format
2560
class Converter(object):
2561
"""Converts a disk format object from one format to another."""
2563
def convert(self, to_convert, pb):
2564
"""Perform the conversion of to_convert, giving feedback via pb.
2566
:param to_convert: The disk object to convert.
2567
:param pb: a progress bar to use for progress information.
2570
def step(self, message):
2571
"""Update the pb by a step."""
2573
self.pb.update(message, self.count, self.total)
2576
class ConvertBzrDir4To5(Converter):
2577
"""Converts format 4 bzr dirs to format 5."""
2580
super(ConvertBzrDir4To5, self).__init__()
2581
self.converted_revs = set()
2582
self.absent_revisions = set()
2586
def convert(self, to_convert, pb):
2587
"""See Converter.convert()."""
2588
self.bzrdir = to_convert
2590
self.pb.note('starting upgrade from format 4 to 5')
2591
if isinstance(self.bzrdir.transport, local.LocalTransport):
2592
self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
2593
self._convert_to_weaves()
2594
return BzrDir.open(self.bzrdir.root_transport.base)
2596
def _convert_to_weaves(self):
2597
self.pb.note('note: upgrade may be faster if all store files are ungzipped first')
2600
stat = self.bzrdir.transport.stat('weaves')
2601
if not S_ISDIR(stat.st_mode):
2602
self.bzrdir.transport.delete('weaves')
2603
self.bzrdir.transport.mkdir('weaves')
2604
except errors.NoSuchFile:
2605
self.bzrdir.transport.mkdir('weaves')
2606
# deliberately not a WeaveFile as we want to build it up slowly.
2607
self.inv_weave = Weave('inventory')
2608
# holds in-memory weaves for all files
2609
self.text_weaves = {}
2610
self.bzrdir.transport.delete('branch-format')
2611
self.branch = self.bzrdir.open_branch()
2612
self._convert_working_inv()
2613
rev_history = self.branch.revision_history()
2614
# to_read is a stack holding the revisions we still need to process;
2615
# appending to it adds new highest-priority revisions
2616
self.known_revisions = set(rev_history)
2617
self.to_read = rev_history[-1:]
2619
rev_id = self.to_read.pop()
2620
if (rev_id not in self.revisions
2621
and rev_id not in self.absent_revisions):
2622
self._load_one_rev(rev_id)
2624
to_import = self._make_order()
2625
for i, rev_id in enumerate(to_import):
2626
self.pb.update('converting revision', i, len(to_import))
2627
self._convert_one_rev(rev_id)
2629
self._write_all_weaves()
2630
self._write_all_revs()
2631
self.pb.note('upgraded to weaves:')
2632
self.pb.note(' %6d revisions and inventories', len(self.revisions))
2633
self.pb.note(' %6d revisions not present', len(self.absent_revisions))
2634
self.pb.note(' %6d texts', self.text_count)
2635
self._cleanup_spare_files_after_format4()
2636
self.branch._transport.put_bytes(
2638
BzrDirFormat5().get_format_string(),
2639
mode=self.bzrdir._get_file_mode())
2641
def _cleanup_spare_files_after_format4(self):
2642
# FIXME working tree upgrade foo.
2643
for n in 'merged-patches', 'pending-merged-patches':
2645
## assert os.path.getsize(p) == 0
2646
self.bzrdir.transport.delete(n)
2647
except errors.NoSuchFile:
2649
self.bzrdir.transport.delete_tree('inventory-store')
2650
self.bzrdir.transport.delete_tree('text-store')
2652
def _convert_working_inv(self):
2653
inv = xml4.serializer_v4.read_inventory(
2654
self.branch._transport.get('inventory'))
2655
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv, working=True)
2656
self.branch._transport.put_bytes('inventory', new_inv_xml,
2657
mode=self.bzrdir._get_file_mode())
2659
def _write_all_weaves(self):
2660
controlweaves = WeaveStore(self.bzrdir.transport, prefixed=False)
2661
weave_transport = self.bzrdir.transport.clone('weaves')
2662
weaves = WeaveStore(weave_transport, prefixed=False)
2663
transaction = WriteTransaction()
2667
for file_id, file_weave in self.text_weaves.items():
2668
self.pb.update('writing weave', i, len(self.text_weaves))
2669
weaves._put_weave(file_id, file_weave, transaction)
2671
self.pb.update('inventory', 0, 1)
2672
controlweaves._put_weave('inventory', self.inv_weave, transaction)
2673
self.pb.update('inventory', 1, 1)
2677
def _write_all_revs(self):
2678
"""Write all revisions out in new form."""
2679
self.bzrdir.transport.delete_tree('revision-store')
2680
self.bzrdir.transport.mkdir('revision-store')
2681
revision_transport = self.bzrdir.transport.clone('revision-store')
2683
from bzrlib.xml5 import serializer_v5
2684
from bzrlib.repofmt.weaverepo import RevisionTextStore
2685
revision_store = RevisionTextStore(revision_transport,
2686
serializer_v5, False, versionedfile.PrefixMapper(),
2687
lambda:True, lambda:True)
2689
for i, rev_id in enumerate(self.converted_revs):
2690
self.pb.update('write revision', i, len(self.converted_revs))
2691
text = serializer_v5.write_revision_to_string(
2692
self.revisions[rev_id])
2694
revision_store.add_lines(key, None, osutils.split_lines(text))
2698
def _load_one_rev(self, rev_id):
2699
"""Load a revision object into memory.
2701
Any parents not either loaded or abandoned get queued to be
2703
self.pb.update('loading revision',
2704
len(self.revisions),
2705
len(self.known_revisions))
2706
if not self.branch.repository.has_revision(rev_id):
2708
self.pb.note('revision {%s} not present in branch; '
2709
'will be converted as a ghost',
2711
self.absent_revisions.add(rev_id)
2713
rev = self.branch.repository.get_revision(rev_id)
2714
for parent_id in rev.parent_ids:
2715
self.known_revisions.add(parent_id)
2716
self.to_read.append(parent_id)
2717
self.revisions[rev_id] = rev
2719
def _load_old_inventory(self, rev_id):
2720
old_inv_xml = self.branch.repository.inventory_store.get(rev_id).read()
2721
inv = xml4.serializer_v4.read_inventory_from_string(old_inv_xml)
2722
inv.revision_id = rev_id
2723
rev = self.revisions[rev_id]
2726
def _load_updated_inventory(self, rev_id):
2727
inv_xml = self.inv_weave.get_text(rev_id)
2728
inv = xml5.serializer_v5.read_inventory_from_string(inv_xml, rev_id)
2731
def _convert_one_rev(self, rev_id):
2732
"""Convert revision and all referenced objects to new format."""
2733
rev = self.revisions[rev_id]
2734
inv = self._load_old_inventory(rev_id)
2735
present_parents = [p for p in rev.parent_ids
2736
if p not in self.absent_revisions]
2737
self._convert_revision_contents(rev, inv, present_parents)
2738
self._store_new_inv(rev, inv, present_parents)
2739
self.converted_revs.add(rev_id)
2741
def _store_new_inv(self, rev, inv, present_parents):
2742
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
2743
new_inv_sha1 = sha_string(new_inv_xml)
2744
self.inv_weave.add_lines(rev.revision_id,
2746
new_inv_xml.splitlines(True))
2747
rev.inventory_sha1 = new_inv_sha1
2749
def _convert_revision_contents(self, rev, inv, present_parents):
2750
"""Convert all the files within a revision.
2752
Also upgrade the inventory to refer to the text revision ids."""
2753
rev_id = rev.revision_id
2754
mutter('converting texts of revision {%s}',
2756
parent_invs = map(self._load_updated_inventory, present_parents)
2757
entries = inv.iter_entries()
2759
for path, ie in entries:
2760
self._convert_file_version(rev, ie, parent_invs)
2762
def _convert_file_version(self, rev, ie, parent_invs):
2763
"""Convert one version of one file.
2765
The file needs to be added into the weave if it is a merge
2766
of >=2 parents or if it's changed from its parent.
2768
file_id = ie.file_id
2769
rev_id = rev.revision_id
2770
w = self.text_weaves.get(file_id)
2773
self.text_weaves[file_id] = w
2774
text_changed = False
2775
parent_candiate_entries = ie.parent_candidates(parent_invs)
2776
heads = graph.Graph(self).heads(parent_candiate_entries.keys())
2777
# XXX: Note that this is unordered - and this is tolerable because
2778
# the previous code was also unordered.
2779
previous_entries = dict((head, parent_candiate_entries[head]) for head
2781
self.snapshot_ie(previous_entries, ie, w, rev_id)
2784
def get_parent_map(self, revision_ids):
2785
"""See graph.StackedParentsProvider.get_parent_map"""
2786
return dict((revision_id, self.revisions[revision_id])
2787
for revision_id in revision_ids
2788
if revision_id in self.revisions)
2790
def snapshot_ie(self, previous_revisions, ie, w, rev_id):
2791
# TODO: convert this logic, which is ~= snapshot to
2792
# a call to:. This needs the path figured out. rather than a work_tree
2793
# a v4 revision_tree can be given, or something that looks enough like
2794
# one to give the file content to the entry if it needs it.
2795
# and we need something that looks like a weave store for snapshot to
2797
#ie.snapshot(rev, PATH, previous_revisions, REVISION_TREE, InMemoryWeaveStore(self.text_weaves))
2798
if len(previous_revisions) == 1:
2799
previous_ie = previous_revisions.values()[0]
2800
if ie._unchanged(previous_ie):
2801
ie.revision = previous_ie.revision
2804
text = self.branch.repository._text_store.get(ie.text_id)
2805
file_lines = text.readlines()
2806
w.add_lines(rev_id, previous_revisions, file_lines)
2807
self.text_count += 1
2809
w.add_lines(rev_id, previous_revisions, [])
2810
ie.revision = rev_id
2812
def _make_order(self):
2813
"""Return a suitable order for importing revisions.
2815
The order must be such that an revision is imported after all
2816
its (present) parents.
2818
todo = set(self.revisions.keys())
2819
done = self.absent_revisions.copy()
2822
# scan through looking for a revision whose parents
2824
for rev_id in sorted(list(todo)):
2825
rev = self.revisions[rev_id]
2826
parent_ids = set(rev.parent_ids)
2827
if parent_ids.issubset(done):
2828
# can take this one now
2829
order.append(rev_id)
2835
class ConvertBzrDir5To6(Converter):
2836
"""Converts format 5 bzr dirs to format 6."""
2838
def convert(self, to_convert, pb):
2839
"""See Converter.convert()."""
2840
self.bzrdir = to_convert
2842
self.pb.note('starting upgrade from format 5 to 6')
2843
self._convert_to_prefixed()
2844
return BzrDir.open(self.bzrdir.root_transport.base)
2846
def _convert_to_prefixed(self):
2847
from bzrlib.store import TransportStore
2848
self.bzrdir.transport.delete('branch-format')
2849
for store_name in ["weaves", "revision-store"]:
2850
self.pb.note("adding prefixes to %s" % store_name)
2851
store_transport = self.bzrdir.transport.clone(store_name)
2852
store = TransportStore(store_transport, prefixed=True)
2853
for urlfilename in store_transport.list_dir('.'):
2854
filename = urlutils.unescape(urlfilename)
2855
if (filename.endswith(".weave") or
2856
filename.endswith(".gz") or
2857
filename.endswith(".sig")):
2858
file_id, suffix = os.path.splitext(filename)
2862
new_name = store._mapper.map((file_id,)) + suffix
2863
# FIXME keep track of the dirs made RBC 20060121
2865
store_transport.move(filename, new_name)
2866
except errors.NoSuchFile: # catches missing dirs strangely enough
2867
store_transport.mkdir(osutils.dirname(new_name))
2868
store_transport.move(filename, new_name)
2869
self.bzrdir.transport.put_bytes(
2871
BzrDirFormat6().get_format_string(),
2872
mode=self.bzrdir._get_file_mode())
2875
class ConvertBzrDir6ToMeta(Converter):
2876
"""Converts format 6 bzr dirs to metadirs."""
2878
def convert(self, to_convert, pb):
2879
"""See Converter.convert()."""
2880
from bzrlib.repofmt.weaverepo import RepositoryFormat7
2881
from bzrlib.branch import BzrBranchFormat5
2882
self.bzrdir = to_convert
2885
self.total = 20 # the steps we know about
2886
self.garbage_inventories = []
2887
self.dir_mode = self.bzrdir._get_dir_mode()
2888
self.file_mode = self.bzrdir._get_file_mode()
2890
self.pb.note('starting upgrade from format 6 to metadir')
2891
self.bzrdir.transport.put_bytes(
2893
"Converting to format 6",
2894
mode=self.file_mode)
2895
# its faster to move specific files around than to open and use the apis...
2896
# first off, nuke ancestry.weave, it was never used.
2898
self.step('Removing ancestry.weave')
2899
self.bzrdir.transport.delete('ancestry.weave')
2900
except errors.NoSuchFile:
2902
# find out whats there
2903
self.step('Finding branch files')
2904
last_revision = self.bzrdir.open_branch().last_revision()
2905
bzrcontents = self.bzrdir.transport.list_dir('.')
2906
for name in bzrcontents:
2907
if name.startswith('basis-inventory.'):
2908
self.garbage_inventories.append(name)
2909
# create new directories for repository, working tree and branch
2910
repository_names = [('inventory.weave', True),
2911
('revision-store', True),
2913
self.step('Upgrading repository ')
2914
self.bzrdir.transport.mkdir('repository', mode=self.dir_mode)
2915
self.make_lock('repository')
2916
# we hard code the formats here because we are converting into
2917
# the meta format. The meta format upgrader can take this to a
2918
# future format within each component.
2919
self.put_format('repository', RepositoryFormat7())
2920
for entry in repository_names:
2921
self.move_entry('repository', entry)
2923
self.step('Upgrading branch ')
2924
self.bzrdir.transport.mkdir('branch', mode=self.dir_mode)
2925
self.make_lock('branch')
2926
self.put_format('branch', BzrBranchFormat5())
2927
branch_files = [('revision-history', True),
2928
('branch-name', True),
2930
for entry in branch_files:
2931
self.move_entry('branch', entry)
2933
checkout_files = [('pending-merges', True),
2934
('inventory', True),
2935
('stat-cache', False)]
2936
# If a mandatory checkout file is not present, the branch does not have
2937
# a functional checkout. Do not create a checkout in the converted
2939
for name, mandatory in checkout_files:
2940
if mandatory and name not in bzrcontents:
2941
has_checkout = False
2945
if not has_checkout:
2946
self.pb.note('No working tree.')
2947
# If some checkout files are there, we may as well get rid of them.
2948
for name, mandatory in checkout_files:
2949
if name in bzrcontents:
2950
self.bzrdir.transport.delete(name)
2952
from bzrlib.workingtree import WorkingTreeFormat3
2953
self.step('Upgrading working tree')
2954
self.bzrdir.transport.mkdir('checkout', mode=self.dir_mode)
2955
self.make_lock('checkout')
2957
'checkout', WorkingTreeFormat3())
2958
self.bzrdir.transport.delete_multi(
2959
self.garbage_inventories, self.pb)
2960
for entry in checkout_files:
2961
self.move_entry('checkout', entry)
2962
if last_revision is not None:
2963
self.bzrdir.transport.put_bytes(
2964
'checkout/last-revision', last_revision)
2965
self.bzrdir.transport.put_bytes(
2967
BzrDirMetaFormat1().get_format_string(),
2968
mode=self.file_mode)
2969
return BzrDir.open(self.bzrdir.root_transport.base)
2971
def make_lock(self, name):
2972
"""Make a lock for the new control dir name."""
2973
self.step('Make %s lock' % name)
2974
ld = lockdir.LockDir(self.bzrdir.transport,
2976
file_modebits=self.file_mode,
2977
dir_modebits=self.dir_mode)
2980
def move_entry(self, new_dir, entry):
2981
"""Move then entry name into new_dir."""
2983
mandatory = entry[1]
2984
self.step('Moving %s' % name)
2986
self.bzrdir.transport.move(name, '%s/%s' % (new_dir, name))
2987
except errors.NoSuchFile:
2991
def put_format(self, dirname, format):
2992
self.bzrdir.transport.put_bytes('%s/format' % dirname,
2993
format.get_format_string(),
2997
class ConvertMetaToMeta(Converter):
2998
"""Converts the components of metadirs."""
3000
def __init__(self, target_format):
3001
"""Create a metadir to metadir converter.
3003
:param target_format: The final metadir format that is desired.
3005
self.target_format = target_format
3007
def convert(self, to_convert, pb):
3008
"""See Converter.convert()."""
3009
self.bzrdir = to_convert
3013
self.step('checking repository format')
3015
repo = self.bzrdir.open_repository()
3016
except errors.NoRepositoryPresent:
3019
if not isinstance(repo._format, self.target_format.repository_format.__class__):
3020
from bzrlib.repository import CopyConverter
3021
self.pb.note('starting repository conversion')
3022
converter = CopyConverter(self.target_format.repository_format)
3023
converter.convert(repo, pb)
3025
branch = self.bzrdir.open_branch()
3026
except errors.NotBranchError:
3029
# TODO: conversions of Branch and Tree should be done by
3030
# InterXFormat lookups/some sort of registry.
3031
# Avoid circular imports
3032
from bzrlib import branch as _mod_branch
3033
old = branch._format.__class__
3034
new = self.target_format.get_branch_format().__class__
3036
if (old == _mod_branch.BzrBranchFormat5 and
3037
new in (_mod_branch.BzrBranchFormat6,
3038
_mod_branch.BzrBranchFormat7,
3039
_mod_branch.BzrBranchFormat8)):
3040
branch_converter = _mod_branch.Converter5to6()
3041
elif (old == _mod_branch.BzrBranchFormat6 and
3042
new in (_mod_branch.BzrBranchFormat7,
3043
_mod_branch.BzrBranchFormat8)):
3044
branch_converter = _mod_branch.Converter6to7()
3045
elif (old == _mod_branch.BzrBranchFormat7 and
3046
new is _mod_branch.BzrBranchFormat8):
3047
branch_converter = _mod_branch.Converter7to8()
3049
raise errors.BadConversionTarget("No converter", new,
3051
branch_converter.convert(branch)
3052
branch = self.bzrdir.open_branch()
3053
old = branch._format.__class__
3055
tree = self.bzrdir.open_workingtree(recommend_upgrade=False)
3056
except (errors.NoWorkingTree, errors.NotLocalUrl):
3059
# TODO: conversions of Branch and Tree should be done by
3060
# InterXFormat lookups
3061
if (isinstance(tree, workingtree.WorkingTree3) and
3062
not isinstance(tree, workingtree_4.DirStateWorkingTree) and
3063
isinstance(self.target_format.workingtree_format,
3064
workingtree_4.DirStateWorkingTreeFormat)):
3065
workingtree_4.Converter3to4().convert(tree)
3066
if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
3067
not isinstance(tree, workingtree_4.WorkingTree5) and
3068
isinstance(self.target_format.workingtree_format,
3069
workingtree_4.WorkingTreeFormat5)):
3070
workingtree_4.Converter4to5().convert(tree)
3071
if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
3072
not isinstance(tree, workingtree_4.WorkingTree6) and
3073
isinstance(self.target_format.workingtree_format,
3074
workingtree_4.WorkingTreeFormat6)):
3075
workingtree_4.Converter4or5to6().convert(tree)
3079
# This is not in remote.py because it's relatively small, and needs to be
3080
# registered. Putting it in remote.py creates a circular import problem.
3081
# we can make it a lazy object if the control formats is turned into something
3083
class RemoteBzrDirFormat(BzrDirMetaFormat1):
3084
"""Format representing bzrdirs accessed via a smart server"""
3087
BzrDirMetaFormat1.__init__(self)
3088
self._network_name = None
3090
def get_format_description(self):
3091
return 'bzr remote bzrdir'
3093
def get_format_string(self):
3094
raise NotImplementedError(self.get_format_string)
3096
def network_name(self):
3097
if self._network_name:
3098
return self._network_name
3100
raise AssertionError("No network name set.")
3103
def probe_transport(klass, transport):
3104
"""Return a RemoteBzrDirFormat object if it looks possible."""
3106
medium = transport.get_smart_medium()
3107
except (NotImplementedError, AttributeError,
3108
errors.TransportNotPossible, errors.NoSmartMedium,
3109
errors.SmartProtocolError):
3110
# no smart server, so not a branch for this format type.
3111
raise errors.NotBranchError(path=transport.base)
3113
# Decline to open it if the server doesn't support our required
3114
# version (3) so that the VFS-based transport will do it.
3115
if medium.should_probe():
3117
server_version = medium.protocol_version()
3118
except errors.SmartProtocolError:
3119
# Apparently there's no usable smart server there, even though
3120
# the medium supports the smart protocol.
3121
raise errors.NotBranchError(path=transport.base)
3122
if server_version != '2':
3123
raise errors.NotBranchError(path=transport.base)
3126
def initialize_on_transport(self, transport):
3128
# hand off the request to the smart server
3129
client_medium = transport.get_smart_medium()
3130
except errors.NoSmartMedium:
3131
# TODO: lookup the local format from a server hint.
3132
local_dir_format = BzrDirMetaFormat1()
3133
return local_dir_format.initialize_on_transport(transport)
3134
client = _SmartClient(client_medium)
3135
path = client.remote_path_from_transport(transport)
3137
response = client.call('BzrDirFormat.initialize', path)
3138
except errors.ErrorFromSmartServer, err:
3139
remote._translate_error(err, path=path)
3140
if response[0] != 'ok':
3141
raise errors.SmartProtocolError('unexpected response code %s' % (response,))
3142
format = RemoteBzrDirFormat()
3143
self._supply_sub_formats_to(format)
3144
return remote.RemoteBzrDir(transport, format)
3146
def parse_NoneTrueFalse(self, arg):
3153
raise AssertionError("invalid arg %r" % arg)
3155
def _serialize_NoneTrueFalse(self, arg):
3162
def _serialize_NoneString(self, arg):
3165
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
3166
create_prefix=False, force_new_repo=False, stacked_on=None,
3167
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
3170
# hand off the request to the smart server
3171
client_medium = transport.get_smart_medium()
3172
except errors.NoSmartMedium:
3175
# Decline to open it if the server doesn't support our required
3176
# version (3) so that the VFS-based transport will do it.
3177
if client_medium.should_probe():
3179
server_version = client_medium.protocol_version()
3180
if server_version != '2':
3184
except errors.SmartProtocolError:
3185
# Apparently there's no usable smart server there, even though
3186
# the medium supports the smart protocol.
3191
client = _SmartClient(client_medium)
3192
path = client.remote_path_from_transport(transport)
3193
if client_medium._is_remote_before((1, 16)):
3196
# TODO: lookup the local format from a server hint.
3197
local_dir_format = BzrDirMetaFormat1()
3198
self._supply_sub_formats_to(local_dir_format)
3199
return local_dir_format.initialize_on_transport_ex(transport,
3200
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3201
force_new_repo=force_new_repo, stacked_on=stacked_on,
3202
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3203
make_working_trees=make_working_trees, shared_repo=shared_repo,
3205
return self._initialize_on_transport_ex_rpc(client, path, transport,
3206
use_existing_dir, create_prefix, force_new_repo, stacked_on,
3207
stack_on_pwd, repo_format_name, make_working_trees, shared_repo)
3209
def _initialize_on_transport_ex_rpc(self, client, path, transport,
3210
use_existing_dir, create_prefix, force_new_repo, stacked_on,
3211
stack_on_pwd, repo_format_name, make_working_trees, shared_repo):
3213
args.append(self._serialize_NoneTrueFalse(use_existing_dir))
3214
args.append(self._serialize_NoneTrueFalse(create_prefix))
3215
args.append(self._serialize_NoneTrueFalse(force_new_repo))
3216
args.append(self._serialize_NoneString(stacked_on))
3217
# stack_on_pwd is often/usually our transport
3220
stack_on_pwd = transport.relpath(stack_on_pwd)
3221
if not stack_on_pwd:
3223
except errors.PathNotChild:
3225
args.append(self._serialize_NoneString(stack_on_pwd))
3226
args.append(self._serialize_NoneString(repo_format_name))
3227
args.append(self._serialize_NoneTrueFalse(make_working_trees))
3228
args.append(self._serialize_NoneTrueFalse(shared_repo))
3229
if self._network_name is None:
3230
self._network_name = \
3231
BzrDirFormat.get_default_format().network_name()
3233
response = client.call('BzrDirFormat.initialize_ex_1.16',
3234
self.network_name(), path, *args)
3235
except errors.UnknownSmartMethod:
3236
client._medium._remember_remote_is_before((1,16))
3237
local_dir_format = BzrDirMetaFormat1()
3238
self._supply_sub_formats_to(local_dir_format)
3239
return local_dir_format.initialize_on_transport_ex(transport,
3240
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3241
force_new_repo=force_new_repo, stacked_on=stacked_on,
3242
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3243
make_working_trees=make_working_trees, shared_repo=shared_repo,
3245
except errors.ErrorFromSmartServer, err:
3246
remote._translate_error(err, path=path)
3247
repo_path = response[0]
3248
bzrdir_name = response[6]
3249
require_stacking = response[7]
3250
require_stacking = self.parse_NoneTrueFalse(require_stacking)
3251
format = RemoteBzrDirFormat()
3252
format._network_name = bzrdir_name
3253
self._supply_sub_formats_to(format)
3254
bzrdir = remote.RemoteBzrDir(transport, format, _client=client)
3256
repo_format = remote.response_tuple_to_repo_format(response[1:])
3257
if repo_path == '.':
3260
repo_bzrdir_format = RemoteBzrDirFormat()
3261
repo_bzrdir_format._network_name = response[5]
3262
repo_bzr = remote.RemoteBzrDir(transport.clone(repo_path),
3266
final_stack = response[8] or None
3267
final_stack_pwd = response[9] or None
3269
final_stack_pwd = urlutils.join(
3270
transport.base, final_stack_pwd)
3271
remote_repo = remote.RemoteRepository(repo_bzr, repo_format)
3272
if len(response) > 10:
3273
# Updated server verb that locks remotely.
3274
repo_lock_token = response[10] or None
3275
remote_repo.lock_write(repo_lock_token, _skip_rpc=True)
3277
remote_repo.dont_leave_lock_in_place()
3279
remote_repo.lock_write()
3280
policy = UseExistingRepository(remote_repo, final_stack,
3281
final_stack_pwd, require_stacking)
3282
policy.acquire_repository()
3286
bzrdir._format.set_branch_format(self.get_branch_format())
3287
if require_stacking:
3288
# The repo has already been created, but we need to make sure that
3289
# we'll make a stackable branch.
3290
bzrdir._format.require_stacking(_skip_repo=True)
3291
return remote_repo, bzrdir, require_stacking, policy
3293
def _open(self, transport):
3294
return remote.RemoteBzrDir(transport, self)
3296
def __eq__(self, other):
3297
if not isinstance(other, RemoteBzrDirFormat):
3299
return self.get_format_description() == other.get_format_description()
3301
def __return_repository_format(self):
3302
# Always return a RemoteRepositoryFormat object, but if a specific bzr
3303
# repository format has been asked for, tell the RemoteRepositoryFormat
3304
# that it should use that for init() etc.
3305
result = remote.RemoteRepositoryFormat()
3306
custom_format = getattr(self, '_repository_format', None)
3308
if isinstance(custom_format, remote.RemoteRepositoryFormat):
3309
return custom_format
3311
# We will use the custom format to create repositories over the
3312
# wire; expose its details like rich_root_data for code to
3314
result._custom_format = custom_format
3317
def get_branch_format(self):
3318
result = BzrDirMetaFormat1.get_branch_format(self)
3319
if not isinstance(result, remote.RemoteBranchFormat):
3320
new_result = remote.RemoteBranchFormat()
3321
new_result._custom_format = result
3323
self.set_branch_format(new_result)
3327
repository_format = property(__return_repository_format,
3328
BzrDirMetaFormat1._set_repository_format) #.im_func)
3331
BzrDirFormat.register_control_server_format(RemoteBzrDirFormat)
3334
class BzrDirFormatInfo(object):
3336
def __init__(self, native, deprecated, hidden, experimental):
3337
self.deprecated = deprecated
3338
self.native = native
3339
self.hidden = hidden
3340
self.experimental = experimental
3343
class BzrDirFormatRegistry(registry.Registry):
3344
"""Registry of user-selectable BzrDir subformats.
3346
Differs from BzrDirFormat._control_formats in that it provides sub-formats,
3347
e.g. BzrDirMeta1 with weave repository. Also, it's more user-oriented.
3351
"""Create a BzrDirFormatRegistry."""
3352
self._aliases = set()
3353
self._registration_order = list()
3354
super(BzrDirFormatRegistry, self).__init__()
3357
"""Return a set of the format names which are aliases."""
3358
return frozenset(self._aliases)
3360
def register_metadir(self, key,
3361
repository_format, help, native=True, deprecated=False,
3367
"""Register a metadir subformat.
3369
These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
3370
by the Repository/Branch/WorkingTreeformats.
3372
:param repository_format: The fully-qualified repository format class
3374
:param branch_format: Fully-qualified branch format class name as
3376
:param tree_format: Fully-qualified tree format class name as
3379
# This should be expanded to support setting WorkingTree and Branch
3380
# formats, once BzrDirMetaFormat1 supports that.
3381
def _load(full_name):
3382
mod_name, factory_name = full_name.rsplit('.', 1)
3384
mod = __import__(mod_name, globals(), locals(),
3386
except ImportError, e:
3387
raise ImportError('failed to load %s: %s' % (full_name, e))
3389
factory = getattr(mod, factory_name)
3390
except AttributeError:
3391
raise AttributeError('no factory %s in module %r'
3396
bd = BzrDirMetaFormat1()
3397
if branch_format is not None:
3398
bd.set_branch_format(_load(branch_format))
3399
if tree_format is not None:
3400
bd.workingtree_format = _load(tree_format)
3401
if repository_format is not None:
3402
bd.repository_format = _load(repository_format)
3404
self.register(key, helper, help, native, deprecated, hidden,
3405
experimental, alias)
3407
def register(self, key, factory, help, native=True, deprecated=False,
3408
hidden=False, experimental=False, alias=False):
3409
"""Register a BzrDirFormat factory.
3411
The factory must be a callable that takes one parameter: the key.
3412
It must produce an instance of the BzrDirFormat when called.
3414
This function mainly exists to prevent the info object from being
3417
registry.Registry.register(self, key, factory, help,
3418
BzrDirFormatInfo(native, deprecated, hidden, experimental))
3420
self._aliases.add(key)
3421
self._registration_order.append(key)
3423
def register_lazy(self, key, module_name, member_name, help, native=True,
3424
deprecated=False, hidden=False, experimental=False, alias=False):
3425
registry.Registry.register_lazy(self, key, module_name, member_name,
3426
help, BzrDirFormatInfo(native, deprecated, hidden, experimental))
3428
self._aliases.add(key)
3429
self._registration_order.append(key)
3431
def set_default(self, key):
3432
"""Set the 'default' key to be a clone of the supplied key.
3434
This method must be called once and only once.
3436
registry.Registry.register(self, 'default', self.get(key),
3437
self.get_help(key), info=self.get_info(key))
3438
self._aliases.add('default')
3440
def set_default_repository(self, key):
3441
"""Set the FormatRegistry default and Repository default.
3443
This is a transitional method while Repository.set_default_format
3446
if 'default' in self:
3447
self.remove('default')
3448
self.set_default(key)
3449
format = self.get('default')()
3451
def make_bzrdir(self, key):
3452
return self.get(key)()
3454
def help_topic(self, topic):
3456
default_realkey = None
3457
default_help = self.get_help('default')
3459
for key in self._registration_order:
3460
if key == 'default':
3462
help = self.get_help(key)
3463
if help == default_help:
3464
default_realkey = key
3466
help_pairs.append((key, help))
3468
def wrapped(key, help, info):
3470
help = '(native) ' + help
3471
return ':%s:\n%s\n\n' % (key,
3472
textwrap.fill(help, initial_indent=' ',
3473
subsequent_indent=' ',
3474
break_long_words=False))
3475
if default_realkey is not None:
3476
output += wrapped(default_realkey, '(default) %s' % default_help,
3477
self.get_info('default'))
3478
deprecated_pairs = []
3479
experimental_pairs = []
3480
for key, help in help_pairs:
3481
info = self.get_info(key)
3484
elif info.deprecated:
3485
deprecated_pairs.append((key, help))
3486
elif info.experimental:
3487
experimental_pairs.append((key, help))
3489
output += wrapped(key, help, info)
3490
output += "\nSee ``bzr help formats`` for more about storage formats."
3492
if len(experimental_pairs) > 0:
3493
other_output += "Experimental formats are shown below.\n\n"
3494
for key, help in experimental_pairs:
3495
info = self.get_info(key)
3496
other_output += wrapped(key, help, info)
3499
"No experimental formats are available.\n\n"
3500
if len(deprecated_pairs) > 0:
3501
other_output += "\nDeprecated formats are shown below.\n\n"
3502
for key, help in deprecated_pairs:
3503
info = self.get_info(key)
3504
other_output += wrapped(key, help, info)
3507
"\nNo deprecated formats are available.\n\n"
3509
"\nSee ``bzr help formats`` for more about storage formats."
3511
if topic == 'other-formats':
3517
class RepositoryAcquisitionPolicy(object):
3518
"""Abstract base class for repository acquisition policies.
3520
A repository acquisition policy decides how a BzrDir acquires a repository
3521
for a branch that is being created. The most basic policy decision is
3522
whether to create a new repository or use an existing one.
3524
def __init__(self, stack_on, stack_on_pwd, require_stacking):
3527
:param stack_on: A location to stack on
3528
:param stack_on_pwd: If stack_on is relative, the location it is
3530
:param require_stacking: If True, it is a failure to not stack.
3532
self._stack_on = stack_on
3533
self._stack_on_pwd = stack_on_pwd
3534
self._require_stacking = require_stacking
3536
def configure_branch(self, branch):
3537
"""Apply any configuration data from this policy to the branch.
3539
Default implementation sets repository stacking.
3541
if self._stack_on is None:
3543
if self._stack_on_pwd is None:
3544
stack_on = self._stack_on
3547
stack_on = urlutils.rebase_url(self._stack_on,
3549
branch.bzrdir.root_transport.base)
3550
except errors.InvalidRebaseURLs:
3551
stack_on = self._get_full_stack_on()
3553
branch.set_stacked_on_url(stack_on)
3554
except (errors.UnstackableBranchFormat,
3555
errors.UnstackableRepositoryFormat):
3556
if self._require_stacking:
3559
def requires_stacking(self):
3560
"""Return True if this policy requires stacking."""
3561
return self._stack_on is not None and self._require_stacking
3563
def _get_full_stack_on(self):
3564
"""Get a fully-qualified URL for the stack_on location."""
3565
if self._stack_on is None:
3567
if self._stack_on_pwd is None:
3568
return self._stack_on
3570
return urlutils.join(self._stack_on_pwd, self._stack_on)
3572
def _add_fallback(self, repository, possible_transports=None):
3573
"""Add a fallback to the supplied repository, if stacking is set."""
3574
stack_on = self._get_full_stack_on()
3575
if stack_on is None:
3578
stacked_dir = BzrDir.open(stack_on,
3579
possible_transports=possible_transports)
3580
except errors.JailBreak:
3581
# We keep the stacking details, but we are in the server code so
3582
# actually stacking is not needed.
3585
stacked_repo = stacked_dir.open_branch().repository
3586
except errors.NotBranchError:
3587
stacked_repo = stacked_dir.open_repository()
3589
repository.add_fallback_repository(stacked_repo)
3590
except errors.UnstackableRepositoryFormat:
3591
if self._require_stacking:
3594
self._require_stacking = True
3596
def acquire_repository(self, make_working_trees=None, shared=False):
3597
"""Acquire a repository for this bzrdir.
3599
Implementations may create a new repository or use a pre-exising
3601
:param make_working_trees: If creating a repository, set
3602
make_working_trees to this value (if non-None)
3603
:param shared: If creating a repository, make it shared if True
3604
:return: A repository, is_new_flag (True if the repository was
3607
raise NotImplemented(RepositoryAcquisitionPolicy.acquire_repository)
3610
class CreateRepository(RepositoryAcquisitionPolicy):
3611
"""A policy of creating a new repository"""
3613
def __init__(self, bzrdir, stack_on=None, stack_on_pwd=None,
3614
require_stacking=False):
3617
:param bzrdir: The bzrdir to create the repository on.
3618
:param stack_on: A location to stack on
3619
:param stack_on_pwd: If stack_on is relative, the location it is
3622
RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
3624
self._bzrdir = bzrdir
3626
def acquire_repository(self, make_working_trees=None, shared=False):
3627
"""Implementation of RepositoryAcquisitionPolicy.acquire_repository
3629
Creates the desired repository in the bzrdir we already have.
3631
stack_on = self._get_full_stack_on()
3633
format = self._bzrdir._format
3634
format.require_stacking(stack_on=stack_on,
3635
possible_transports=[self._bzrdir.root_transport])
3636
if not self._require_stacking:
3637
# We have picked up automatic stacking somewhere.
3638
note('Using default stacking branch %s at %s', self._stack_on,
3640
repository = self._bzrdir.create_repository(shared=shared)
3641
self._add_fallback(repository,
3642
possible_transports=[self._bzrdir.transport])
3643
if make_working_trees is not None:
3644
repository.set_make_working_trees(make_working_trees)
3645
return repository, True
3648
class UseExistingRepository(RepositoryAcquisitionPolicy):
3649
"""A policy of reusing an existing repository"""
3651
def __init__(self, repository, stack_on=None, stack_on_pwd=None,
3652
require_stacking=False):
3655
:param repository: The repository to use.
3656
:param stack_on: A location to stack on
3657
:param stack_on_pwd: If stack_on is relative, the location it is
3660
RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
3662
self._repository = repository
3664
def acquire_repository(self, make_working_trees=None, shared=False):
3665
"""Implementation of RepositoryAcquisitionPolicy.acquire_repository
3667
Returns an existing repository to use.
3669
self._add_fallback(self._repository,
3670
possible_transports=[self._repository.bzrdir.transport])
3671
return self._repository, False
3674
# Please register new formats after old formats so that formats
3675
# appear in chronological order and format descriptions can build
3677
format_registry = BzrDirFormatRegistry()
3678
# The pre-0.8 formats have their repository format network name registered in
3679
# repository.py. MetaDir formats have their repository format network name
3680
# inferred from their disk format string.
3681
format_registry.register('weave', BzrDirFormat6,
3682
'Pre-0.8 format. Slower than knit and does not'
3683
' support checkouts or shared repositories.',
3685
format_registry.register_metadir('metaweave',
3686
'bzrlib.repofmt.weaverepo.RepositoryFormat7',
3687
'Transitional format in 0.8. Slower than knit.',
3688
branch_format='bzrlib.branch.BzrBranchFormat5',
3689
tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3691
format_registry.register_metadir('knit',
3692
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3693
'Format using knits. Recommended for interoperation with bzr <= 0.14.',
3694
branch_format='bzrlib.branch.BzrBranchFormat5',
3695
tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3697
format_registry.register_metadir('dirstate',
3698
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3699
help='New in 0.15: Fast local operations. Compatible with bzr 0.8 and '
3700
'above when accessed over the network.',
3701
branch_format='bzrlib.branch.BzrBranchFormat5',
3702
# this uses bzrlib.workingtree.WorkingTreeFormat4 because importing
3703
# directly from workingtree_4 triggers a circular import.
3704
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3706
format_registry.register_metadir('dirstate-tags',
3707
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3708
help='New in 0.15: Fast local operations and improved scaling for '
3709
'network operations. Additionally adds support for tags.'
3710
' Incompatible with bzr < 0.15.',
3711
branch_format='bzrlib.branch.BzrBranchFormat6',
3712
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3714
format_registry.register_metadir('rich-root',
3715
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
3716
help='New in 1.0. Better handling of tree roots. Incompatible with'
3718
branch_format='bzrlib.branch.BzrBranchFormat6',
3719
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3721
format_registry.register_metadir('dirstate-with-subtree',
3722
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
3723
help='New in 0.15: Fast local operations and improved scaling for '
3724
'network operations. Additionally adds support for versioning nested '
3725
'bzr branches. Incompatible with bzr < 0.15.',
3726
branch_format='bzrlib.branch.BzrBranchFormat6',
3727
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3731
format_registry.register_metadir('pack-0.92',
3732
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack1',
3733
help='New in 0.92: Pack-based format with data compatible with '
3734
'dirstate-tags format repositories. Interoperates with '
3735
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3736
'Previously called knitpack-experimental. '
3737
'For more information, see '
3738
'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
3739
branch_format='bzrlib.branch.BzrBranchFormat6',
3740
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3742
format_registry.register_metadir('pack-0.92-subtree',
3743
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack3',
3744
help='New in 0.92: Pack-based format with data compatible with '
3745
'dirstate-with-subtree format repositories. Interoperates with '
3746
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3747
'Previously called knitpack-experimental. '
3748
'For more information, see '
3749
'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
3750
branch_format='bzrlib.branch.BzrBranchFormat6',
3751
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3755
format_registry.register_metadir('rich-root-pack',
3756
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
3757
help='New in 1.0: A variant of pack-0.92 that supports rich-root data '
3758
'(needed for bzr-svn and bzr-git).',
3759
branch_format='bzrlib.branch.BzrBranchFormat6',
3760
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3762
format_registry.register_metadir('1.6',
3763
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5',
3764
help='A format that allows a branch to indicate that there is another '
3765
'(stacked) repository that should be used to access data that is '
3766
'not present locally.',
3767
branch_format='bzrlib.branch.BzrBranchFormat7',
3768
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3770
format_registry.register_metadir('1.6.1-rich-root',
3771
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5RichRoot',
3772
help='A variant of 1.6 that supports rich-root data '
3773
'(needed for bzr-svn and bzr-git).',
3774
branch_format='bzrlib.branch.BzrBranchFormat7',
3775
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3777
format_registry.register_metadir('1.9',
3778
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3779
help='A repository format using B+tree indexes. These indexes '
3780
'are smaller in size, have smarter caching and provide faster '
3781
'performance for most operations.',
3782
branch_format='bzrlib.branch.BzrBranchFormat7',
3783
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3785
format_registry.register_metadir('1.9-rich-root',
3786
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
3787
help='A variant of 1.9 that supports rich-root data '
3788
'(needed for bzr-svn and bzr-git).',
3789
branch_format='bzrlib.branch.BzrBranchFormat7',
3790
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3792
format_registry.register_metadir('1.14',
3793
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3794
help='A working-tree format that supports content filtering.',
3795
branch_format='bzrlib.branch.BzrBranchFormat7',
3796
tree_format='bzrlib.workingtree.WorkingTreeFormat5',
3798
format_registry.register_metadir('1.14-rich-root',
3799
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
3800
help='A variant of 1.14 that supports rich-root data '
3801
'(needed for bzr-svn and bzr-git).',
3802
branch_format='bzrlib.branch.BzrBranchFormat7',
3803
tree_format='bzrlib.workingtree.WorkingTreeFormat5',
3805
# The following un-numbered 'development' formats should always just be aliases.
3806
format_registry.register_metadir('development-rich-root',
3807
'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
3808
help='Current development format. Supports rich roots. Can convert data '
3809
'to and from rich-root-pack (and anything compatible with '
3810
'rich-root-pack) format repositories. Repositories and branches in '
3811
'this format can only be read by bzr.dev. Please read '
3812
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3814
branch_format='bzrlib.branch.BzrBranchFormat7',
3815
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3819
format_registry.register_metadir('development-subtree',
3820
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment2Subtree',
3821
help='Current development format, subtree variant. Can convert data to and '
3822
'from pack-0.92-subtree (and anything compatible with '
3823
'pack-0.92-subtree) format repositories. Repositories and branches in '
3824
'this format can only be read by bzr.dev. Please read '
3825
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3827
branch_format='bzrlib.branch.BzrBranchFormat7',
3828
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3830
alias=False, # Restore to being an alias when an actual development subtree format is added
3831
# This current non-alias status is simply because we did not introduce a
3832
# chk based subtree format.
3835
# And the development formats above will have aliased one of the following:
3836
format_registry.register_metadir('development6-rich-root',
3837
'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
3838
help='pack-1.9 with 255-way hashed CHK inv, group compress, rich roots '
3840
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3842
branch_format='bzrlib.branch.BzrBranchFormat7',
3843
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3848
format_registry.register_metadir('development7-rich-root',
3849
'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK2',
3850
help='pack-1.9 with 255-way hashed CHK inv, bencode revision, group compress, '
3851
'rich roots. Please read '
3852
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3854
branch_format='bzrlib.branch.BzrBranchFormat7',
3855
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3860
format_registry.register_metadir('2a',
3861
'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
3862
help='First format for bzr 2.0 series.\n'
3863
'Uses group-compress storage.\n'
3864
'Provides rich roots which are a one-way transition.\n',
3865
# 'storage in packs, 255-way hashed CHK inventory, bencode revision, group compress, '
3866
# 'rich roots. Supported by bzr 1.16 and later.',
3867
branch_format='bzrlib.branch.BzrBranchFormat7',
3868
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3872
# The following format should be an alias for the rich root equivalent
3873
# of the default format
3874
format_registry.register_metadir('default-rich-root',
3875
'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
3876
branch_format='bzrlib.branch.BzrBranchFormat7',
3877
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3881
# The current format that is made on 'bzr init'.
3882
format_registry.set_default('2a')
added
removed
bzrlib/bzrdir.py
