1
# Copyright (C) 2006-2010 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.
34
from bzrlib.lazy_import import lazy_import
35
lazy_import(globals(), """
36
from stat import S_ISDIR
50
revision as _mod_revision,
60
from bzrlib.osutils import (
63
from bzrlib.push import (
66
from bzrlib.repofmt import pack_repo
67
from bzrlib.smart.client import _SmartClient
68
from bzrlib.store.versioned import WeaveStore
69
from bzrlib.transactions import WriteTransaction
70
from bzrlib.transport import (
71
do_catching_redirections,
75
from bzrlib.weave import Weave
78
from bzrlib.trace import (
92
"""A .bzr control diretory.
94
BzrDir instances let you create or open any of the things that can be
95
found within .bzr - checkouts, branches and repositories.
98
the transport which this bzr dir is rooted at (i.e. file:///.../.bzr/)
100
a transport connected to the directory this bzr was opened from
101
(i.e. the parent directory holding the .bzr directory).
103
Everything in the bzrdir should have the same file permissions.
105
:cvar hooks: An instance of BzrDirHooks.
108
def break_lock(self):
109
"""Invoke break_lock on the first object in the bzrdir.
111
If there is a tree, the tree is opened and break_lock() called.
112
Otherwise, branch is tried, and finally repository.
114
# XXX: This seems more like a UI function than something that really
115
# belongs in this class.
117
thing_to_unlock = self.open_workingtree()
118
except (errors.NotLocalUrl, errors.NoWorkingTree):
120
thing_to_unlock = self.open_branch()
121
except errors.NotBranchError:
123
thing_to_unlock = self.open_repository()
124
except errors.NoRepositoryPresent:
126
thing_to_unlock.break_lock()
128
def can_convert_format(self):
129
"""Return true if this bzrdir is one whose format we can convert from."""
132
def check_conversion_target(self, target_format):
133
"""Check that a bzrdir as a whole can be converted to a new format."""
134
# The only current restriction is that the repository content can be
135
# fetched compatibly with the target.
136
target_repo_format = target_format.repository_format
138
self.open_repository()._format.check_conversion_target(
140
except errors.NoRepositoryPresent:
141
# No repo, no problem.
145
def _check_supported(format, allow_unsupported,
146
recommend_upgrade=True,
148
"""Give an error or warning on old formats.
150
:param format: may be any kind of format - workingtree, branch,
153
:param allow_unsupported: If true, allow opening
154
formats that are strongly deprecated, and which may
155
have limited functionality.
157
:param recommend_upgrade: If true (default), warn
158
the user through the ui object that they may wish
159
to upgrade the object.
161
# TODO: perhaps move this into a base Format class; it's not BzrDir
162
# specific. mbp 20070323
163
if not allow_unsupported and not format.is_supported():
164
# see open_downlevel to open legacy branches.
165
raise errors.UnsupportedFormatError(format=format)
166
if recommend_upgrade \
167
and getattr(format, 'upgrade_recommended', False):
168
ui.ui_factory.recommend_upgrade(
169
format.get_format_description(),
172
def clone(self, url, revision_id=None, force_new_repo=False,
173
preserve_stacking=False):
174
"""Clone this bzrdir and its contents to url verbatim.
176
:param url: The url create the clone at. If url's last component does
177
not exist, it will be created.
178
:param revision_id: The tip revision-id to use for any branch or
179
working tree. If not None, then the clone operation may tune
180
itself to download less data.
181
:param force_new_repo: Do not use a shared repository for the target
182
even if one is available.
183
:param preserve_stacking: When cloning a stacked branch, stack the
184
new branch on top of the other branch's stacked-on branch.
186
return self.clone_on_transport(get_transport(url),
187
revision_id=revision_id,
188
force_new_repo=force_new_repo,
189
preserve_stacking=preserve_stacking)
191
def clone_on_transport(self, transport, revision_id=None,
192
force_new_repo=False, preserve_stacking=False, stacked_on=None,
193
create_prefix=False, use_existing_dir=True):
194
"""Clone this bzrdir and its contents to transport verbatim.
196
:param transport: The transport for the location to produce the clone
197
at. If the target directory does not exist, it will be created.
198
:param revision_id: The tip revision-id to use for any branch or
199
working tree. If not None, then the clone operation may tune
200
itself to download less data.
201
:param force_new_repo: Do not use a shared repository for the target,
202
even if one is available.
203
:param preserve_stacking: When cloning a stacked branch, stack the
204
new branch on top of the other branch's stacked-on branch.
205
:param create_prefix: Create any missing directories leading up to
207
:param use_existing_dir: Use an existing directory if one exists.
209
# Overview: put together a broad description of what we want to end up
210
# with; then make as few api calls as possible to do it.
212
# We may want to create a repo/branch/tree, if we do so what format
213
# would we want for each:
214
require_stacking = (stacked_on is not None)
215
format = self.cloning_metadir(require_stacking)
217
# Figure out what objects we want:
219
local_repo = self.find_repository()
220
except errors.NoRepositoryPresent:
223
local_branch = self.open_branch()
224
except errors.NotBranchError:
227
# enable fallbacks when branch is not a branch reference
228
if local_branch.repository.has_same_location(local_repo):
229
local_repo = local_branch.repository
230
if preserve_stacking:
232
stacked_on = local_branch.get_stacked_on_url()
233
except (errors.UnstackableBranchFormat,
234
errors.UnstackableRepositoryFormat,
237
# Bug: We create a metadir without knowing if it can support stacking,
238
# we should look up the policy needs first, or just use it as a hint,
241
make_working_trees = local_repo.make_working_trees()
242
want_shared = local_repo.is_shared()
243
repo_format_name = format.repository_format.network_name()
245
make_working_trees = False
247
repo_format_name = None
249
result_repo, result, require_stacking, repository_policy = \
250
format.initialize_on_transport_ex(transport,
251
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
252
force_new_repo=force_new_repo, stacked_on=stacked_on,
253
stack_on_pwd=self.root_transport.base,
254
repo_format_name=repo_format_name,
255
make_working_trees=make_working_trees, shared_repo=want_shared)
258
# If the result repository is in the same place as the
259
# resulting bzr dir, it will have no content, further if the
260
# result is not stacked then we know all content should be
261
# copied, and finally if we are copying up to a specific
262
# revision_id then we can use the pending-ancestry-result which
263
# does not require traversing all of history to describe it.
264
if (result_repo.bzrdir.root_transport.base ==
265
result.root_transport.base and not require_stacking and
266
revision_id is not None):
267
fetch_spec = graph.PendingAncestryResult(
268
[revision_id], local_repo)
269
result_repo.fetch(local_repo, fetch_spec=fetch_spec)
271
result_repo.fetch(local_repo, revision_id=revision_id)
275
if result_repo is not None:
276
raise AssertionError('result_repo not None(%r)' % result_repo)
277
# 1 if there is a branch present
278
# make sure its content is available in the target repository
280
if local_branch is not None:
281
result_branch = local_branch.clone(result, revision_id=revision_id,
282
repository_policy=repository_policy)
284
# Cheaper to check if the target is not local, than to try making
286
result.root_transport.local_abspath('.')
287
if result_repo is None or result_repo.make_working_trees():
288
self.open_workingtree().clone(result)
289
except (errors.NoWorkingTree, errors.NotLocalUrl):
293
# TODO: This should be given a Transport, and should chdir up; otherwise
294
# this will open a new connection.
295
def _make_tail(self, url):
296
t = get_transport(url)
300
def create(cls, base, format=None, possible_transports=None):
301
"""Create a new BzrDir at the url 'base'.
303
:param format: If supplied, the format of branch to create. If not
304
supplied, the default is used.
305
:param possible_transports: If supplied, a list of transports that
306
can be reused to share a remote connection.
308
if cls is not BzrDir:
309
raise AssertionError("BzrDir.create always creates the default"
310
" format, not one of %r" % cls)
311
t = get_transport(base, possible_transports)
314
format = BzrDirFormat.get_default_format()
315
return format.initialize_on_transport(t)
318
def find_bzrdirs(transport, evaluate=None, list_current=None):
319
"""Find bzrdirs recursively from current location.
321
This is intended primarily as a building block for more sophisticated
322
functionality, like finding trees under a directory, or finding
323
branches that use a given repository.
324
:param evaluate: An optional callable that yields recurse, value,
325
where recurse controls whether this bzrdir is recursed into
326
and value is the value to yield. By default, all bzrdirs
327
are recursed into, and the return value is the bzrdir.
328
:param list_current: if supplied, use this function to list the current
329
directory, instead of Transport.list_dir
330
:return: a generator of found bzrdirs, or whatever evaluate returns.
332
if list_current is None:
333
def list_current(transport):
334
return transport.list_dir('')
336
def evaluate(bzrdir):
339
pending = [transport]
340
while len(pending) > 0:
341
current_transport = pending.pop()
344
bzrdir = BzrDir.open_from_transport(current_transport)
345
except errors.NotBranchError:
348
recurse, value = evaluate(bzrdir)
351
subdirs = list_current(current_transport)
352
except errors.NoSuchFile:
355
for subdir in sorted(subdirs, reverse=True):
356
pending.append(current_transport.clone(subdir))
358
def list_branches(self):
359
"""Return a sequence of all branches local to this control directory.
363
return [self.open_branch()]
364
except errors.NotBranchError:
368
def find_branches(transport):
369
"""Find all branches under a transport.
371
This will find all branches below the transport, including branches
372
inside other branches. Where possible, it will use
373
Repository.find_branches.
375
To list all the branches that use a particular Repository, see
376
Repository.find_branches
378
def evaluate(bzrdir):
380
repository = bzrdir.open_repository()
381
except errors.NoRepositoryPresent:
384
return False, ([], repository)
385
return True, (bzrdir.list_branches(), None)
387
for branches, repo in BzrDir.find_bzrdirs(transport,
390
ret.extend(repo.find_branches())
391
if branches is not None:
395
def destroy_repository(self):
396
"""Destroy the repository in this BzrDir"""
397
raise NotImplementedError(self.destroy_repository)
399
def create_branch(self, name=None):
400
"""Create a branch in this BzrDir.
402
:param name: Name of the colocated branch to create, None for
405
The bzrdir's format will control what branch format is created.
406
For more control see BranchFormatXX.create(a_bzrdir).
408
raise NotImplementedError(self.create_branch)
410
def destroy_branch(self, name=None):
411
"""Destroy a branch in this BzrDir.
413
:param name: Name of the branch to destroy, None for the default
416
raise NotImplementedError(self.destroy_branch)
419
def create_branch_and_repo(base, force_new_repo=False, format=None):
420
"""Create a new BzrDir, Branch and Repository at the url 'base'.
422
This will use the current default BzrDirFormat unless one is
423
specified, and use whatever
424
repository format that that uses via bzrdir.create_branch and
425
create_repository. If a shared repository is available that is used
428
The created Branch object is returned.
430
:param base: The URL to create the branch at.
431
:param force_new_repo: If True a new repository is always created.
432
:param format: If supplied, the format of branch to create. If not
433
supplied, the default is used.
435
bzrdir = BzrDir.create(base, format)
436
bzrdir._find_or_create_repository(force_new_repo)
437
return bzrdir.create_branch()
439
def determine_repository_policy(self, force_new_repo=False, stack_on=None,
440
stack_on_pwd=None, require_stacking=False):
441
"""Return an object representing a policy to use.
443
This controls whether a new repository is created, and the format of
444
that repository, or some existing shared repository used instead.
446
If stack_on is supplied, will not seek a containing shared repo.
448
:param force_new_repo: If True, require a new repository to be created.
449
:param stack_on: If supplied, the location to stack on. If not
450
supplied, a default_stack_on location may be used.
451
:param stack_on_pwd: If stack_on is relative, the location it is
454
def repository_policy(found_bzrdir):
457
config = found_bzrdir.get_config()
459
stack_on = config.get_default_stack_on()
460
if stack_on is not None:
461
stack_on_pwd = found_bzrdir.root_transport.base
463
# does it have a repository ?
465
repository = found_bzrdir.open_repository()
466
except errors.NoRepositoryPresent:
469
if ((found_bzrdir.root_transport.base !=
470
self.root_transport.base) and not repository.is_shared()):
471
# Don't look higher, can't use a higher shared repo.
479
return UseExistingRepository(repository, stack_on,
480
stack_on_pwd, require_stacking=require_stacking), True
482
return CreateRepository(self, stack_on, stack_on_pwd,
483
require_stacking=require_stacking), True
485
if not force_new_repo:
487
policy = self._find_containing(repository_policy)
488
if policy is not None:
492
return UseExistingRepository(self.open_repository(),
493
stack_on, stack_on_pwd,
494
require_stacking=require_stacking)
495
except errors.NoRepositoryPresent:
497
return CreateRepository(self, stack_on, stack_on_pwd,
498
require_stacking=require_stacking)
500
def _find_or_create_repository(self, force_new_repo):
501
"""Create a new repository if needed, returning the repository."""
502
policy = self.determine_repository_policy(force_new_repo)
503
return policy.acquire_repository()[0]
506
def create_branch_convenience(base, force_new_repo=False,
507
force_new_tree=None, format=None,
508
possible_transports=None):
509
"""Create a new BzrDir, Branch and Repository at the url 'base'.
511
This is a convenience function - it will use an existing repository
512
if possible, can be told explicitly whether to create a working tree or
515
This will use the current default BzrDirFormat unless one is
516
specified, and use whatever
517
repository format that that uses via bzrdir.create_branch and
518
create_repository. If a shared repository is available that is used
519
preferentially. Whatever repository is used, its tree creation policy
522
The created Branch object is returned.
523
If a working tree cannot be made due to base not being a file:// url,
524
no error is raised unless force_new_tree is True, in which case no
525
data is created on disk and NotLocalUrl is raised.
527
:param base: The URL to create the branch at.
528
:param force_new_repo: If True a new repository is always created.
529
:param force_new_tree: If True or False force creation of a tree or
530
prevent such creation respectively.
531
:param format: Override for the bzrdir format to create.
532
:param possible_transports: An optional reusable transports list.
535
# check for non local urls
536
t = get_transport(base, possible_transports)
537
if not isinstance(t, local.LocalTransport):
538
raise errors.NotLocalUrl(base)
539
bzrdir = BzrDir.create(base, format, possible_transports)
540
repo = bzrdir._find_or_create_repository(force_new_repo)
541
result = bzrdir.create_branch()
542
if force_new_tree or (repo.make_working_trees() and
543
force_new_tree is None):
545
bzrdir.create_workingtree()
546
except errors.NotLocalUrl:
551
def create_standalone_workingtree(base, format=None):
552
"""Create a new BzrDir, WorkingTree, Branch and Repository at 'base'.
554
'base' must be a local path or a file:// url.
556
This will use the current default BzrDirFormat unless one is
557
specified, and use whatever
558
repository format that that uses for bzrdirformat.create_workingtree,
559
create_branch and create_repository.
561
:param format: Override for the bzrdir format to create.
562
:return: The WorkingTree object.
564
t = get_transport(base)
565
if not isinstance(t, local.LocalTransport):
566
raise errors.NotLocalUrl(base)
567
bzrdir = BzrDir.create_branch_and_repo(base,
569
format=format).bzrdir
570
return bzrdir.create_workingtree()
572
def create_workingtree(self, revision_id=None, from_branch=None,
573
accelerator_tree=None, hardlink=False):
574
"""Create a working tree at this BzrDir.
576
:param revision_id: create it as of this revision id.
577
:param from_branch: override bzrdir branch (for lightweight checkouts)
578
:param accelerator_tree: A tree which can be used for retrieving file
579
contents more quickly than the revision tree, i.e. a workingtree.
580
The revision tree will be used for cases where accelerator_tree's
581
content is different.
583
raise NotImplementedError(self.create_workingtree)
585
def backup_bzrdir(self):
586
"""Backup this bzr control directory.
588
:return: Tuple with old path name and new path name
590
def name_gen(base='backup.bzr'):
592
name = "%s.~%d~" % (base, counter)
593
while self.root_transport.has(name):
595
name = "%s.~%d~" % (base, counter)
598
backup_dir=name_gen()
599
pb = ui.ui_factory.nested_progress_bar()
601
# FIXME: bug 300001 -- the backup fails if the backup directory
602
# already exists, but it should instead either remove it or make
603
# a new backup directory.
605
# FIXME: bug 262450 -- the backup directory should have the same
606
# permissions as the .bzr directory (probably a bug in copy_tree)
607
old_path = self.root_transport.abspath('.bzr')
608
new_path = self.root_transport.abspath(backup_dir)
609
ui.ui_factory.note('making backup of %s\n to %s' % (old_path, new_path,))
610
self.root_transport.copy_tree('.bzr', backup_dir)
611
return (old_path, new_path)
615
def retire_bzrdir(self, limit=10000):
616
"""Permanently disable the bzrdir.
618
This is done by renaming it to give the user some ability to recover
619
if there was a problem.
621
This will have horrible consequences if anyone has anything locked or
623
:param limit: number of times to retry
628
to_path = '.bzr.retired.%d' % i
629
self.root_transport.rename('.bzr', to_path)
630
note("renamed %s to %s"
631
% (self.root_transport.abspath('.bzr'), to_path))
633
except (errors.TransportError, IOError, errors.PathError):
640
def destroy_workingtree(self):
641
"""Destroy the working tree at this BzrDir.
643
Formats that do not support this may raise UnsupportedOperation.
645
raise NotImplementedError(self.destroy_workingtree)
647
def destroy_workingtree_metadata(self):
648
"""Destroy the control files for the working tree at this BzrDir.
650
The contents of working tree files are not affected.
651
Formats that do not support this may raise UnsupportedOperation.
653
raise NotImplementedError(self.destroy_workingtree_metadata)
655
def _find_containing(self, evaluate):
656
"""Find something in a containing control directory.
658
This method will scan containing control dirs, until it finds what
659
it is looking for, decides that it will never find it, or runs out
660
of containing control directories to check.
662
It is used to implement find_repository and
663
determine_repository_policy.
665
:param evaluate: A function returning (value, stop). If stop is True,
666
the value will be returned.
670
result, stop = evaluate(found_bzrdir)
673
next_transport = found_bzrdir.root_transport.clone('..')
674
if (found_bzrdir.root_transport.base == next_transport.base):
675
# top of the file system
677
# find the next containing bzrdir
679
found_bzrdir = BzrDir.open_containing_from_transport(
681
except errors.NotBranchError:
684
def find_repository(self):
685
"""Find the repository that should be used.
687
This does not require a branch as we use it to find the repo for
688
new branches as well as to hook existing branches up to their
691
def usable_repository(found_bzrdir):
692
# does it have a repository ?
694
repository = found_bzrdir.open_repository()
695
except errors.NoRepositoryPresent:
697
if found_bzrdir.root_transport.base == self.root_transport.base:
698
return repository, True
699
elif repository.is_shared():
700
return repository, True
704
found_repo = self._find_containing(usable_repository)
705
if found_repo is None:
706
raise errors.NoRepositoryPresent(self)
709
def get_branch_reference(self):
710
"""Return the referenced URL for the branch in this bzrdir.
712
:raises NotBranchError: If there is no Branch.
713
:return: The URL the branch in this bzrdir references if it is a
714
reference branch, or None for regular branches.
718
def get_branch_transport(self, branch_format):
719
"""Get the transport for use by branch format in this BzrDir.
721
Note that bzr dirs that do not support format strings will raise
722
IncompatibleFormat if the branch format they are given has
723
a format string, and vice versa.
725
If branch_format is None, the transport is returned with no
726
checking. If it is not None, then the returned transport is
727
guaranteed to point to an existing directory ready for use.
729
raise NotImplementedError(self.get_branch_transport)
731
def _find_creation_modes(self):
732
"""Determine the appropriate modes for files and directories.
734
They're always set to be consistent with the base directory,
735
assuming that this transport allows setting modes.
737
# TODO: Do we need or want an option (maybe a config setting) to turn
738
# this off or override it for particular locations? -- mbp 20080512
739
if self._mode_check_done:
741
self._mode_check_done = True
743
st = self.transport.stat('.')
744
except errors.TransportNotPossible:
745
self._dir_mode = None
746
self._file_mode = None
748
# Check the directory mode, but also make sure the created
749
# directories and files are read-write for this user. This is
750
# mostly a workaround for filesystems which lie about being able to
751
# write to a directory (cygwin & win32)
752
if (st.st_mode & 07777 == 00000):
753
# FTP allows stat but does not return dir/file modes
754
self._dir_mode = None
755
self._file_mode = None
757
self._dir_mode = (st.st_mode & 07777) | 00700
758
# Remove the sticky and execute bits for files
759
self._file_mode = self._dir_mode & ~07111
761
def _get_file_mode(self):
762
"""Return Unix mode for newly created files, or None.
764
if not self._mode_check_done:
765
self._find_creation_modes()
766
return self._file_mode
768
def _get_dir_mode(self):
769
"""Return Unix mode for newly created directories, or None.
771
if not self._mode_check_done:
772
self._find_creation_modes()
773
return self._dir_mode
775
def get_repository_transport(self, repository_format):
776
"""Get the transport for use by repository format in this BzrDir.
778
Note that bzr dirs that do not support format strings will raise
779
IncompatibleFormat if the repository format they are given has
780
a format string, and vice versa.
782
If repository_format is None, the transport is returned with no
783
checking. If it is not None, then the returned transport is
784
guaranteed to point to an existing directory ready for use.
786
raise NotImplementedError(self.get_repository_transport)
788
def get_workingtree_transport(self, tree_format):
789
"""Get the transport for use by workingtree format in this BzrDir.
791
Note that bzr dirs that do not support format strings will raise
792
IncompatibleFormat if the workingtree format they are given has a
793
format string, and vice versa.
795
If workingtree_format is None, the transport is returned with no
796
checking. If it is not None, then the returned transport is
797
guaranteed to point to an existing directory ready for use.
799
raise NotImplementedError(self.get_workingtree_transport)
801
def get_config(self):
802
"""Get configuration for this BzrDir."""
803
return config.BzrDirConfig(self)
805
def _get_config(self):
806
"""By default, no configuration is available."""
809
def __init__(self, _transport, _format):
810
"""Initialize a Bzr control dir object.
812
Only really common logic should reside here, concrete classes should be
813
made with varying behaviours.
815
:param _format: the format that is creating this BzrDir instance.
816
:param _transport: the transport this dir is based at.
818
self._format = _format
819
self.transport = _transport.clone('.bzr')
820
self.root_transport = _transport
821
self._mode_check_done = False
823
def is_control_filename(self, filename):
824
"""True if filename is the name of a path which is reserved for bzrdir's.
826
:param filename: A filename within the root transport of this bzrdir.
828
This is true IF and ONLY IF the filename is part of the namespace reserved
829
for bzr control dirs. Currently this is the '.bzr' directory in the root
830
of the root_transport. it is expected that plugins will need to extend
831
this in the future - for instance to make bzr talk with svn working
834
# this might be better on the BzrDirFormat class because it refers to
835
# all the possible bzrdir disk formats.
836
# This method is tested via the workingtree is_control_filename tests-
837
# it was extracted from WorkingTree.is_control_filename. If the method's
838
# contract is extended beyond the current trivial implementation, please
839
# add new tests for it to the appropriate place.
840
return filename == '.bzr' or filename.startswith('.bzr/')
842
def needs_format_conversion(self, format=None):
843
"""Return true if this bzrdir needs convert_format run on it.
845
For instance, if the repository format is out of date but the
846
branch and working tree are not, this should return True.
848
:param format: Optional parameter indicating a specific desired
849
format we plan to arrive at.
851
raise NotImplementedError(self.needs_format_conversion)
854
def open_unsupported(base):
855
"""Open a branch which is not supported."""
856
return BzrDir.open(base, _unsupported=True)
859
def open(base, _unsupported=False, possible_transports=None):
860
"""Open an existing bzrdir, rooted at 'base' (url).
862
:param _unsupported: a private parameter to the BzrDir class.
864
t = get_transport(base, possible_transports=possible_transports)
865
return BzrDir.open_from_transport(t, _unsupported=_unsupported)
868
def open_from_transport(transport, _unsupported=False,
869
_server_formats=True):
870
"""Open a bzrdir within a particular directory.
872
:param transport: Transport containing the bzrdir.
873
:param _unsupported: private.
875
for hook in BzrDir.hooks['pre_open']:
877
# Keep initial base since 'transport' may be modified while following
879
base = transport.base
880
def find_format(transport):
881
return transport, BzrDirFormat.find_format(
882
transport, _server_formats=_server_formats)
884
def redirected(transport, e, redirection_notice):
885
redirected_transport = transport._redirected_to(e.source, e.target)
886
if redirected_transport is None:
887
raise errors.NotBranchError(base)
888
note('%s is%s redirected to %s',
889
transport.base, e.permanently, redirected_transport.base)
890
return redirected_transport
893
transport, format = do_catching_redirections(find_format,
896
except errors.TooManyRedirections:
897
raise errors.NotBranchError(base)
899
BzrDir._check_supported(format, _unsupported)
900
return format.open(transport, _found=True)
902
def open_branch(self, name=None, unsupported=False,
903
ignore_fallbacks=False):
904
"""Open the branch object at this BzrDir if one is present.
906
If unsupported is True, then no longer supported branch formats can
909
TODO: static convenience version of this?
911
raise NotImplementedError(self.open_branch)
914
def open_containing(url, possible_transports=None):
915
"""Open an existing branch which contains url.
917
:param url: url to search from.
918
See open_containing_from_transport for more detail.
920
transport = get_transport(url, possible_transports)
921
return BzrDir.open_containing_from_transport(transport)
924
def open_containing_from_transport(a_transport):
925
"""Open an existing branch which contains a_transport.base.
927
This probes for a branch at a_transport, and searches upwards from there.
929
Basically we keep looking up until we find the control directory or
930
run into the root. If there isn't one, raises NotBranchError.
931
If there is one and it is either an unrecognised format or an unsupported
932
format, UnknownFormatError or UnsupportedFormatError are raised.
933
If there is one, it is returned, along with the unused portion of url.
935
:return: The BzrDir that contains the path, and a Unicode path
936
for the rest of the URL.
938
# this gets the normalised url back. I.e. '.' -> the full path.
939
url = a_transport.base
942
result = BzrDir.open_from_transport(a_transport)
943
return result, urlutils.unescape(a_transport.relpath(url))
944
except errors.NotBranchError, e:
947
new_t = a_transport.clone('..')
948
except errors.InvalidURLJoin:
949
# reached the root, whatever that may be
950
raise errors.NotBranchError(path=url)
951
if new_t.base == a_transport.base:
952
# reached the root, whatever that may be
953
raise errors.NotBranchError(path=url)
956
def _get_tree_branch(self):
957
"""Return the branch and tree, if any, for this bzrdir.
959
Return None for tree if not present or inaccessible.
960
Raise NotBranchError if no branch is present.
961
:return: (tree, branch)
964
tree = self.open_workingtree()
965
except (errors.NoWorkingTree, errors.NotLocalUrl):
967
branch = self.open_branch()
973
def open_tree_or_branch(klass, location):
974
"""Return the branch and working tree at a location.
976
If there is no tree at the location, tree will be None.
977
If there is no branch at the location, an exception will be
979
:return: (tree, branch)
981
bzrdir = klass.open(location)
982
return bzrdir._get_tree_branch()
985
def open_containing_tree_or_branch(klass, location):
986
"""Return the branch and working tree contained by a location.
988
Returns (tree, branch, relpath).
989
If there is no tree at containing the location, tree will be None.
990
If there is no branch containing the location, an exception will be
992
relpath is the portion of the path that is contained by the branch.
994
bzrdir, relpath = klass.open_containing(location)
995
tree, branch = bzrdir._get_tree_branch()
996
return tree, branch, relpath
999
def open_containing_tree_branch_or_repository(klass, location):
1000
"""Return the working tree, branch and repo contained by a location.
1002
Returns (tree, branch, repository, relpath).
1003
If there is no tree containing the location, tree will be None.
1004
If there is no branch containing the location, branch will be None.
1005
If there is no repository containing the location, repository will be
1007
relpath is the portion of the path that is contained by the innermost
1010
If no tree, branch or repository is found, a NotBranchError is raised.
1012
bzrdir, relpath = klass.open_containing(location)
1014
tree, branch = bzrdir._get_tree_branch()
1015
except errors.NotBranchError:
1017
repo = bzrdir.find_repository()
1018
return None, None, repo, relpath
1019
except (errors.NoRepositoryPresent):
1020
raise errors.NotBranchError(location)
1021
return tree, branch, branch.repository, relpath
1023
def open_repository(self, _unsupported=False):
1024
"""Open the repository object at this BzrDir if one is present.
1026
This will not follow the Branch object pointer - it's strictly a direct
1027
open facility. Most client code should use open_branch().repository to
1028
get at a repository.
1030
:param _unsupported: a private parameter, not part of the api.
1031
TODO: static convenience version of this?
1033
raise NotImplementedError(self.open_repository)
1035
def open_workingtree(self, _unsupported=False,
1036
recommend_upgrade=True, from_branch=None):
1037
"""Open the workingtree object at this BzrDir if one is present.
1039
:param recommend_upgrade: Optional keyword parameter, when True (the
1040
default), emit through the ui module a recommendation that the user
1041
upgrade the working tree when the workingtree being opened is old
1042
(but still fully supported).
1043
:param from_branch: override bzrdir branch (for lightweight checkouts)
1045
raise NotImplementedError(self.open_workingtree)
1047
def has_branch(self, name=None):
1048
"""Tell if this bzrdir contains a branch.
1050
Note: if you're going to open the branch, you should just go ahead
1051
and try, and not ask permission first. (This method just opens the
1052
branch and discards it, and that's somewhat expensive.)
1055
self.open_branch(name)
1057
except errors.NotBranchError:
1060
def has_workingtree(self):
1061
"""Tell if this bzrdir contains a working tree.
1063
This will still raise an exception if the bzrdir has a workingtree that
1064
is remote & inaccessible.
1066
Note: if you're going to open the working tree, you should just go ahead
1067
and try, and not ask permission first. (This method just opens the
1068
workingtree and discards it, and that's somewhat expensive.)
1071
self.open_workingtree(recommend_upgrade=False)
1073
except errors.NoWorkingTree:
1076
def _cloning_metadir(self):
1077
"""Produce a metadir suitable for cloning with.
1079
:returns: (destination_bzrdir_format, source_repository)
1081
result_format = self._format.__class__()
1084
branch = self.open_branch(ignore_fallbacks=True)
1085
source_repository = branch.repository
1086
result_format._branch_format = branch._format
1087
except errors.NotBranchError:
1088
source_branch = None
1089
source_repository = self.open_repository()
1090
except errors.NoRepositoryPresent:
1091
source_repository = None
1093
# XXX TODO: This isinstance is here because we have not implemented
1094
# the fix recommended in bug # 103195 - to delegate this choice the
1095
# repository itself.
1096
repo_format = source_repository._format
1097
if isinstance(repo_format, remote.RemoteRepositoryFormat):
1098
source_repository._ensure_real()
1099
repo_format = source_repository._real_repository._format
1100
result_format.repository_format = repo_format
1102
# TODO: Couldn't we just probe for the format in these cases,
1103
# rather than opening the whole tree? It would be a little
1104
# faster. mbp 20070401
1105
tree = self.open_workingtree(recommend_upgrade=False)
1106
except (errors.NoWorkingTree, errors.NotLocalUrl):
1107
result_format.workingtree_format = None
1109
result_format.workingtree_format = tree._format.__class__()
1110
return result_format, source_repository
1112
def cloning_metadir(self, require_stacking=False):
1113
"""Produce a metadir suitable for cloning or sprouting with.
1115
These operations may produce workingtrees (yes, even though they're
1116
"cloning" something that doesn't have a tree), so a viable workingtree
1117
format must be selected.
1119
:require_stacking: If True, non-stackable formats will be upgraded
1120
to similar stackable formats.
1121
:returns: a BzrDirFormat with all component formats either set
1122
appropriately or set to None if that component should not be
1125
format, repository = self._cloning_metadir()
1126
if format._workingtree_format is None:
1128
if repository is None:
1129
# No repository either
1131
# We have a repository, so set a working tree? (Why? This seems to
1132
# contradict the stated return value in the docstring).
1133
tree_format = repository._format._matchingbzrdir.workingtree_format
1134
format.workingtree_format = tree_format.__class__()
1135
if require_stacking:
1136
format.require_stacking()
1139
def checkout_metadir(self):
1140
return self.cloning_metadir()
1142
def sprout(self, url, revision_id=None, force_new_repo=False,
1143
recurse='down', possible_transports=None,
1144
accelerator_tree=None, hardlink=False, stacked=False,
1145
source_branch=None, create_tree_if_local=True):
1146
"""Create a copy of this bzrdir prepared for use as a new line of
1149
If url's last component does not exist, it will be created.
1151
Attributes related to the identity of the source branch like
1152
branch nickname will be cleaned, a working tree is created
1153
whether one existed before or not; and a local branch is always
1156
if revision_id is not None, then the clone operation may tune
1157
itself to download less data.
1158
:param accelerator_tree: A tree which can be used for retrieving file
1159
contents more quickly than the revision tree, i.e. a workingtree.
1160
The revision tree will be used for cases where accelerator_tree's
1161
content is different.
1162
:param hardlink: If true, hard-link files from accelerator_tree,
1164
:param stacked: If true, create a stacked branch referring to the
1165
location of this control directory.
1166
:param create_tree_if_local: If true, a working-tree will be created
1167
when working locally.
1169
target_transport = get_transport(url, possible_transports)
1170
target_transport.ensure_base()
1171
cloning_format = self.cloning_metadir(stacked)
1172
# Create/update the result branch
1173
result = cloning_format.initialize_on_transport(target_transport)
1174
# if a stacked branch wasn't requested, we don't create one
1175
# even if the origin was stacked
1176
stacked_branch_url = None
1177
if source_branch is not None:
1179
stacked_branch_url = self.root_transport.base
1180
source_repository = source_branch.repository
1183
source_branch = self.open_branch()
1184
source_repository = source_branch.repository
1186
stacked_branch_url = self.root_transport.base
1187
except errors.NotBranchError:
1188
source_branch = None
1190
source_repository = self.open_repository()
1191
except errors.NoRepositoryPresent:
1192
source_repository = None
1193
repository_policy = result.determine_repository_policy(
1194
force_new_repo, stacked_branch_url, require_stacking=stacked)
1195
result_repo, is_new_repo = repository_policy.acquire_repository()
1196
if is_new_repo and revision_id is not None and not stacked:
1197
fetch_spec = graph.PendingAncestryResult(
1198
[revision_id], source_repository)
1201
if source_repository is not None:
1202
# Fetch while stacked to prevent unstacked fetch from
1204
if fetch_spec is None:
1205
result_repo.fetch(source_repository, revision_id=revision_id)
1207
result_repo.fetch(source_repository, fetch_spec=fetch_spec)
1209
if source_branch is None:
1210
# this is for sprouting a bzrdir without a branch; is that
1212
# Not especially, but it's part of the contract.
1213
result_branch = result.create_branch()
1215
result_branch = source_branch.sprout(result,
1216
revision_id=revision_id, repository_policy=repository_policy)
1217
mutter("created new branch %r" % (result_branch,))
1219
# Create/update the result working tree
1220
if (create_tree_if_local and
1221
isinstance(target_transport, local.LocalTransport) and
1222
(result_repo is None or result_repo.make_working_trees())):
1223
wt = result.create_workingtree(accelerator_tree=accelerator_tree,
1227
if wt.path2id('') is None:
1229
wt.set_root_id(self.open_workingtree.get_root_id())
1230
except errors.NoWorkingTree:
1236
if recurse == 'down':
1238
basis = wt.basis_tree()
1240
subtrees = basis.iter_references()
1241
elif result_branch is not None:
1242
basis = result_branch.basis_tree()
1244
subtrees = basis.iter_references()
1245
elif source_branch is not None:
1246
basis = source_branch.basis_tree()
1248
subtrees = basis.iter_references()
1253
for path, file_id in subtrees:
1254
target = urlutils.join(url, urlutils.escape(path))
1255
sublocation = source_branch.reference_parent(file_id, path)
1256
sublocation.bzrdir.sprout(target,
1257
basis.get_reference_revision(file_id, path),
1258
force_new_repo=force_new_repo, recurse=recurse,
1261
if basis is not None:
1265
def push_branch(self, source, revision_id=None, overwrite=False,
1266
remember=False, create_prefix=False):
1267
"""Push the source branch into this BzrDir."""
1269
# If we can open a branch, use its direct repository, otherwise see
1270
# if there is a repository without a branch.
1272
br_to = self.open_branch()
1273
except errors.NotBranchError:
1274
# Didn't find a branch, can we find a repository?
1275
repository_to = self.find_repository()
1277
# Found a branch, so we must have found a repository
1278
repository_to = br_to.repository
1280
push_result = PushResult()
1281
push_result.source_branch = source
1283
# We have a repository but no branch, copy the revisions, and then
1285
repository_to.fetch(source.repository, revision_id=revision_id)
1286
br_to = source.clone(self, revision_id=revision_id)
1287
if source.get_push_location() is None or remember:
1288
source.set_push_location(br_to.base)
1289
push_result.stacked_on = None
1290
push_result.branch_push_result = None
1291
push_result.old_revno = None
1292
push_result.old_revid = _mod_revision.NULL_REVISION
1293
push_result.target_branch = br_to
1294
push_result.master_branch = None
1295
push_result.workingtree_updated = False
1297
# We have successfully opened the branch, remember if necessary:
1298
if source.get_push_location() is None or remember:
1299
source.set_push_location(br_to.base)
1301
tree_to = self.open_workingtree()
1302
except errors.NotLocalUrl:
1303
push_result.branch_push_result = source.push(br_to,
1304
overwrite, stop_revision=revision_id)
1305
push_result.workingtree_updated = False
1306
except errors.NoWorkingTree:
1307
push_result.branch_push_result = source.push(br_to,
1308
overwrite, stop_revision=revision_id)
1309
push_result.workingtree_updated = None # Not applicable
1311
tree_to.lock_write()
1313
push_result.branch_push_result = source.push(
1314
tree_to.branch, overwrite, stop_revision=revision_id)
1318
push_result.workingtree_updated = True
1319
push_result.old_revno = push_result.branch_push_result.old_revno
1320
push_result.old_revid = push_result.branch_push_result.old_revid
1321
push_result.target_branch = \
1322
push_result.branch_push_result.target_branch
1326
class BzrDirHooks(hooks.Hooks):
1327
"""Hooks for BzrDir operations."""
1330
"""Create the default hooks."""
1331
hooks.Hooks.__init__(self)
1332
self.create_hook(hooks.HookPoint('pre_open',
1333
"Invoked before attempting to open a BzrDir with the transport "
1334
"that the open will use.", (1, 14), None))
1336
# install the default hooks
1337
BzrDir.hooks = BzrDirHooks()
1340
class BzrDirPreSplitOut(BzrDir):
1341
"""A common class for the all-in-one formats."""
1343
def __init__(self, _transport, _format):
1344
"""See BzrDir.__init__."""
1345
super(BzrDirPreSplitOut, self).__init__(_transport, _format)
1346
self._control_files = lockable_files.LockableFiles(
1347
self.get_branch_transport(None),
1348
self._format._lock_file_name,
1349
self._format._lock_class)
1351
def break_lock(self):
1352
"""Pre-splitout bzrdirs do not suffer from stale locks."""
1353
raise NotImplementedError(self.break_lock)
1355
def cloning_metadir(self, require_stacking=False):
1356
"""Produce a metadir suitable for cloning with."""
1357
if require_stacking:
1358
return format_registry.make_bzrdir('1.6')
1359
return self._format.__class__()
1361
def clone(self, url, revision_id=None, force_new_repo=False,
1362
preserve_stacking=False):
1363
"""See BzrDir.clone().
1365
force_new_repo has no effect, since this family of formats always
1366
require a new repository.
1367
preserve_stacking has no effect, since no source branch using this
1368
family of formats can be stacked, so there is no stacking to preserve.
1370
self._make_tail(url)
1371
result = self._format._initialize_for_clone(url)
1372
self.open_repository().clone(result, revision_id=revision_id)
1373
from_branch = self.open_branch()
1374
from_branch.clone(result, revision_id=revision_id)
1376
tree = self.open_workingtree()
1377
except errors.NotLocalUrl:
1378
# make a new one, this format always has to have one.
1379
result._init_workingtree()
1384
def create_branch(self, name=None):
1385
"""See BzrDir.create_branch."""
1386
if name is not None:
1387
raise errors.NoColocatedBranchSupport(self)
1388
return self._format.get_branch_format().initialize(self)
1390
def destroy_branch(self, name=None):
1391
"""See BzrDir.destroy_branch."""
1392
raise errors.UnsupportedOperation(self.destroy_branch, self)
1394
def create_repository(self, shared=False):
1395
"""See BzrDir.create_repository."""
1397
raise errors.IncompatibleFormat('shared repository', self._format)
1398
return self.open_repository()
1400
def destroy_repository(self):
1401
"""See BzrDir.destroy_repository."""
1402
raise errors.UnsupportedOperation(self.destroy_repository, self)
1404
def create_workingtree(self, revision_id=None, from_branch=None,
1405
accelerator_tree=None, hardlink=False):
1406
"""See BzrDir.create_workingtree."""
1407
# The workingtree is sometimes created when the bzrdir is created,
1408
# but not when cloning.
1410
# this looks buggy but is not -really-
1411
# because this format creates the workingtree when the bzrdir is
1413
# clone and sprout will have set the revision_id
1414
# and that will have set it for us, its only
1415
# specific uses of create_workingtree in isolation
1416
# that can do wonky stuff here, and that only
1417
# happens for creating checkouts, which cannot be
1418
# done on this format anyway. So - acceptable wart.
1420
warning("can't support hardlinked working trees in %r"
1423
result = self.open_workingtree(recommend_upgrade=False)
1424
except errors.NoSuchFile:
1425
result = self._init_workingtree()
1426
if revision_id is not None:
1427
if revision_id == _mod_revision.NULL_REVISION:
1428
result.set_parent_ids([])
1430
result.set_parent_ids([revision_id])
1433
def _init_workingtree(self):
1434
from bzrlib.workingtree import WorkingTreeFormat2
1436
return WorkingTreeFormat2().initialize(self)
1437
except errors.NotLocalUrl:
1438
# Even though we can't access the working tree, we need to
1439
# create its control files.
1440
return WorkingTreeFormat2()._stub_initialize_on_transport(
1441
self.transport, self._control_files._file_mode)
1443
def destroy_workingtree(self):
1444
"""See BzrDir.destroy_workingtree."""
1445
raise errors.UnsupportedOperation(self.destroy_workingtree, self)
1447
def destroy_workingtree_metadata(self):
1448
"""See BzrDir.destroy_workingtree_metadata."""
1449
raise errors.UnsupportedOperation(self.destroy_workingtree_metadata,
1452
def get_branch_transport(self, branch_format):
1453
"""See BzrDir.get_branch_transport()."""
1454
if branch_format is None:
1455
return self.transport
1457
branch_format.get_format_string()
1458
except NotImplementedError:
1459
return self.transport
1460
raise errors.IncompatibleFormat(branch_format, self._format)
1462
def get_repository_transport(self, repository_format):
1463
"""See BzrDir.get_repository_transport()."""
1464
if repository_format is None:
1465
return self.transport
1467
repository_format.get_format_string()
1468
except NotImplementedError:
1469
return self.transport
1470
raise errors.IncompatibleFormat(repository_format, self._format)
1472
def get_workingtree_transport(self, workingtree_format):
1473
"""See BzrDir.get_workingtree_transport()."""
1474
if workingtree_format is None:
1475
return self.transport
1477
workingtree_format.get_format_string()
1478
except NotImplementedError:
1479
return self.transport
1480
raise errors.IncompatibleFormat(workingtree_format, self._format)
1482
def needs_format_conversion(self, format=None):
1483
"""See BzrDir.needs_format_conversion()."""
1484
# if the format is not the same as the system default,
1485
# an upgrade is needed.
1487
symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1488
% 'needs_format_conversion(format=None)')
1489
format = BzrDirFormat.get_default_format()
1490
return not isinstance(self._format, format.__class__)
1492
def open_branch(self, name=None, unsupported=False,
1493
ignore_fallbacks=False):
1494
"""See BzrDir.open_branch."""
1495
if name is not None:
1496
raise errors.NoColocatedBranchSupport(self)
1497
from bzrlib.branch import BzrBranchFormat4
1498
format = BzrBranchFormat4()
1499
self._check_supported(format, unsupported)
1500
return format.open(self, _found=True)
1502
def sprout(self, url, revision_id=None, force_new_repo=False,
1503
possible_transports=None, accelerator_tree=None,
1504
hardlink=False, stacked=False, create_tree_if_local=True,
1505
source_branch=None):
1506
"""See BzrDir.sprout()."""
1507
if source_branch is not None:
1508
my_branch = self.open_branch()
1509
if source_branch.base != my_branch.base:
1510
raise AssertionError(
1511
"source branch %r is not within %r with branch %r" %
1512
(source_branch, self, my_branch))
1514
raise errors.UnstackableBranchFormat(
1515
self._format, self.root_transport.base)
1516
if not create_tree_if_local:
1517
raise errors.MustHaveWorkingTree(
1518
self._format, self.root_transport.base)
1519
from bzrlib.workingtree import WorkingTreeFormat2
1520
self._make_tail(url)
1521
result = self._format._initialize_for_clone(url)
1523
self.open_repository().clone(result, revision_id=revision_id)
1524
except errors.NoRepositoryPresent:
1527
self.open_branch().sprout(result, revision_id=revision_id)
1528
except errors.NotBranchError:
1531
# we always want a working tree
1532
WorkingTreeFormat2().initialize(result,
1533
accelerator_tree=accelerator_tree,
1538
class BzrDir4(BzrDirPreSplitOut):
1539
"""A .bzr version 4 control object.
1541
This is a deprecated format and may be removed after sept 2006.
1544
def create_repository(self, shared=False):
1545
"""See BzrDir.create_repository."""
1546
return self._format.repository_format.initialize(self, shared)
1548
def needs_format_conversion(self, format=None):
1549
"""Format 4 dirs are always in need of conversion."""
1551
symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1552
% 'needs_format_conversion(format=None)')
1555
def open_repository(self):
1556
"""See BzrDir.open_repository."""
1557
from bzrlib.repofmt.weaverepo import RepositoryFormat4
1558
return RepositoryFormat4().open(self, _found=True)
1561
class BzrDir5(BzrDirPreSplitOut):
1562
"""A .bzr version 5 control object.
1564
This is a deprecated format and may be removed after sept 2006.
1567
def has_workingtree(self):
1568
"""See BzrDir.has_workingtree."""
1571
def open_repository(self):
1572
"""See BzrDir.open_repository."""
1573
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1574
return RepositoryFormat5().open(self, _found=True)
1576
def open_workingtree(self, _unsupported=False,
1577
recommend_upgrade=True):
1578
"""See BzrDir.create_workingtree."""
1579
from bzrlib.workingtree import WorkingTreeFormat2
1580
wt_format = WorkingTreeFormat2()
1581
# we don't warn here about upgrades; that ought to be handled for the
1583
return wt_format.open(self, _found=True)
1586
class BzrDir6(BzrDirPreSplitOut):
1587
"""A .bzr version 6 control object.
1589
This is a deprecated format and may be removed after sept 2006.
1592
def has_workingtree(self):
1593
"""See BzrDir.has_workingtree."""
1596
def open_repository(self):
1597
"""See BzrDir.open_repository."""
1598
from bzrlib.repofmt.weaverepo import RepositoryFormat6
1599
return RepositoryFormat6().open(self, _found=True)
1601
def open_workingtree(self, _unsupported=False,
1602
recommend_upgrade=True):
1603
"""See BzrDir.create_workingtree."""
1604
# we don't warn here about upgrades; that ought to be handled for the
1606
from bzrlib.workingtree import WorkingTreeFormat2
1607
return WorkingTreeFormat2().open(self, _found=True)
1610
class BzrDirMeta1(BzrDir):
1611
"""A .bzr meta version 1 control object.
1613
This is the first control object where the
1614
individual aspects are really split out: there are separate repository,
1615
workingtree and branch subdirectories and any subset of the three can be
1616
present within a BzrDir.
1619
def can_convert_format(self):
1620
"""See BzrDir.can_convert_format()."""
1623
def create_branch(self, name=None):
1624
"""See BzrDir.create_branch."""
1625
if name is not None:
1626
raise errors.NoColocatedBranchSupport(self)
1627
return self._format.get_branch_format().initialize(self)
1629
def destroy_branch(self, name=None):
1630
"""See BzrDir.create_branch."""
1631
if name is not None:
1632
raise errors.NoColocatedBranchSupport(self)
1633
self.transport.delete_tree('branch')
1635
def create_repository(self, shared=False):
1636
"""See BzrDir.create_repository."""
1637
return self._format.repository_format.initialize(self, shared)
1639
def destroy_repository(self):
1640
"""See BzrDir.destroy_repository."""
1641
self.transport.delete_tree('repository')
1643
def create_workingtree(self, revision_id=None, from_branch=None,
1644
accelerator_tree=None, hardlink=False):
1645
"""See BzrDir.create_workingtree."""
1646
return self._format.workingtree_format.initialize(
1647
self, revision_id, from_branch=from_branch,
1648
accelerator_tree=accelerator_tree, hardlink=hardlink)
1650
def destroy_workingtree(self):
1651
"""See BzrDir.destroy_workingtree."""
1652
wt = self.open_workingtree(recommend_upgrade=False)
1653
repository = wt.branch.repository
1654
empty = repository.revision_tree(_mod_revision.NULL_REVISION)
1655
wt.revert(old_tree=empty)
1656
self.destroy_workingtree_metadata()
1658
def destroy_workingtree_metadata(self):
1659
self.transport.delete_tree('checkout')
1661
def find_branch_format(self):
1662
"""Find the branch 'format' for this bzrdir.
1664
This might be a synthetic object for e.g. RemoteBranch and SVN.
1666
from bzrlib.branch import BranchFormat
1667
return BranchFormat.find_format(self)
1669
def _get_mkdir_mode(self):
1670
"""Figure out the mode to use when creating a bzrdir subdir."""
1671
temp_control = lockable_files.LockableFiles(self.transport, '',
1672
lockable_files.TransportLock)
1673
return temp_control._dir_mode
1675
def get_branch_reference(self):
1676
"""See BzrDir.get_branch_reference()."""
1677
from bzrlib.branch import BranchFormat
1678
format = BranchFormat.find_format(self)
1679
return format.get_reference(self)
1681
def get_branch_transport(self, branch_format):
1682
"""See BzrDir.get_branch_transport()."""
1683
# XXX: this shouldn't implicitly create the directory if it's just
1684
# promising to get a transport -- mbp 20090727
1685
if branch_format is None:
1686
return self.transport.clone('branch')
1688
branch_format.get_format_string()
1689
except NotImplementedError:
1690
raise errors.IncompatibleFormat(branch_format, self._format)
1692
self.transport.mkdir('branch', mode=self._get_mkdir_mode())
1693
except errors.FileExists:
1695
return self.transport.clone('branch')
1697
def get_repository_transport(self, repository_format):
1698
"""See BzrDir.get_repository_transport()."""
1699
if repository_format is None:
1700
return self.transport.clone('repository')
1702
repository_format.get_format_string()
1703
except NotImplementedError:
1704
raise errors.IncompatibleFormat(repository_format, self._format)
1706
self.transport.mkdir('repository', mode=self._get_mkdir_mode())
1707
except errors.FileExists:
1709
return self.transport.clone('repository')
1711
def get_workingtree_transport(self, workingtree_format):
1712
"""See BzrDir.get_workingtree_transport()."""
1713
if workingtree_format is None:
1714
return self.transport.clone('checkout')
1716
workingtree_format.get_format_string()
1717
except NotImplementedError:
1718
raise errors.IncompatibleFormat(workingtree_format, self._format)
1720
self.transport.mkdir('checkout', mode=self._get_mkdir_mode())
1721
except errors.FileExists:
1723
return self.transport.clone('checkout')
1725
def has_workingtree(self):
1726
"""Tell if this bzrdir contains a working tree.
1728
This will still raise an exception if the bzrdir has a workingtree that
1729
is remote & inaccessible.
1731
Note: if you're going to open the working tree, you should just go
1732
ahead and try, and not ask permission first.
1734
from bzrlib.workingtree import WorkingTreeFormat
1736
WorkingTreeFormat.find_format(self)
1737
except errors.NoWorkingTree:
1741
def needs_format_conversion(self, format=None):
1742
"""See BzrDir.needs_format_conversion()."""
1744
symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1745
% 'needs_format_conversion(format=None)')
1747
format = BzrDirFormat.get_default_format()
1748
if not isinstance(self._format, format.__class__):
1749
# it is not a meta dir format, conversion is needed.
1751
# we might want to push this down to the repository?
1753
if not isinstance(self.open_repository()._format,
1754
format.repository_format.__class__):
1755
# the repository needs an upgrade.
1757
except errors.NoRepositoryPresent:
1759
for branch in self.list_branches():
1760
if not isinstance(branch._format,
1761
format.get_branch_format().__class__):
1762
# the branch needs an upgrade.
1765
my_wt = self.open_workingtree(recommend_upgrade=False)
1766
if not isinstance(my_wt._format,
1767
format.workingtree_format.__class__):
1768
# the workingtree needs an upgrade.
1770
except (errors.NoWorkingTree, errors.NotLocalUrl):
1774
def open_branch(self, name=None, unsupported=False,
1775
ignore_fallbacks=False):
1776
"""See BzrDir.open_branch."""
1777
if name is not None:
1778
raise errors.NoColocatedBranchSupport(self)
1779
format = self.find_branch_format()
1780
self._check_supported(format, unsupported)
1781
return format.open(self, _found=True, ignore_fallbacks=ignore_fallbacks)
1783
def open_repository(self, unsupported=False):
1784
"""See BzrDir.open_repository."""
1785
from bzrlib.repository import RepositoryFormat
1786
format = RepositoryFormat.find_format(self)
1787
self._check_supported(format, unsupported)
1788
return format.open(self, _found=True)
1790
def open_workingtree(self, unsupported=False,
1791
recommend_upgrade=True):
1792
"""See BzrDir.open_workingtree."""
1793
from bzrlib.workingtree import WorkingTreeFormat
1794
format = WorkingTreeFormat.find_format(self)
1795
self._check_supported(format, unsupported,
1797
basedir=self.root_transport.base)
1798
return format.open(self, _found=True)
1800
def _get_config(self):
1801
return config.TransportConfig(self.transport, 'control.conf')
1804
class BzrDirFormat(object):
1805
"""An encapsulation of the initialization and open routines for a format.
1807
Formats provide three things:
1808
* An initialization routine,
1812
Formats are placed in a dict by their format string for reference
1813
during bzrdir opening. These should be subclasses of BzrDirFormat
1816
Once a format is deprecated, just deprecate the initialize and open
1817
methods on the format class. Do not deprecate the object, as the
1818
object will be created every system load.
1821
_default_format = None
1822
"""The default format used for new .bzr dirs."""
1825
"""The known formats."""
1827
_control_formats = []
1828
"""The registered control formats - .bzr, ....
1830
This is a list of BzrDirFormat objects.
1833
_control_server_formats = []
1834
"""The registered control server formats, e.g. RemoteBzrDirs.
1836
This is a list of BzrDirFormat objects.
1839
_lock_file_name = 'branch-lock'
1841
colocated_branches = False
1842
"""Whether co-located branches are supported for this control dir format.
1845
# _lock_class must be set in subclasses to the lock type, typ.
1846
# TransportLock or LockDir
1849
def find_format(klass, transport, _server_formats=True):
1850
"""Return the format present at transport."""
1852
formats = klass._control_server_formats + klass._control_formats
1854
formats = klass._control_formats
1855
for format in formats:
1857
return format.probe_transport(transport)
1858
except errors.NotBranchError:
1859
# this format does not find a control dir here.
1861
raise errors.NotBranchError(path=transport.base)
1864
def probe_transport(klass, transport):
1865
"""Return the .bzrdir style format present in a directory."""
1867
format_string = transport.get_bytes(".bzr/branch-format")
1868
except errors.NoSuchFile:
1869
raise errors.NotBranchError(path=transport.base)
1872
return klass._formats[format_string]
1874
raise errors.UnknownFormatError(format=format_string, kind='bzrdir')
1877
def get_default_format(klass):
1878
"""Return the current default format."""
1879
return klass._default_format
1881
def get_format_string(self):
1882
"""Return the ASCII format string that identifies this format."""
1883
raise NotImplementedError(self.get_format_string)
1885
def get_format_description(self):
1886
"""Return the short description for this format."""
1887
raise NotImplementedError(self.get_format_description)
1889
def get_converter(self, format=None):
1890
"""Return the converter to use to convert bzrdirs needing converts.
1892
This returns a bzrlib.bzrdir.Converter object.
1894
This should return the best upgrader to step this format towards the
1895
current default format. In the case of plugins we can/should provide
1896
some means for them to extend the range of returnable converters.
1898
:param format: Optional format to override the default format of the
1901
raise NotImplementedError(self.get_converter)
1903
def initialize(self, url, possible_transports=None):
1904
"""Create a bzr control dir at this url and return an opened copy.
1906
While not deprecated, this method is very specific and its use will
1907
lead to many round trips to setup a working environment. See
1908
initialize_on_transport_ex for a [nearly] all-in-one method.
1910
Subclasses should typically override initialize_on_transport
1911
instead of this method.
1913
return self.initialize_on_transport(get_transport(url,
1914
possible_transports))
1916
def initialize_on_transport(self, transport):
1917
"""Initialize a new bzrdir in the base directory of a Transport."""
1919
# can we hand off the request to the smart server rather than using
1921
client_medium = transport.get_smart_medium()
1922
except errors.NoSmartMedium:
1923
return self._initialize_on_transport_vfs(transport)
1925
# Current RPC's only know how to create bzr metadir1 instances, so
1926
# we still delegate to vfs methods if the requested format is not a
1928
if type(self) != BzrDirMetaFormat1:
1929
return self._initialize_on_transport_vfs(transport)
1930
remote_format = RemoteBzrDirFormat()
1931
self._supply_sub_formats_to(remote_format)
1932
return remote_format.initialize_on_transport(transport)
1934
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
1935
create_prefix=False, force_new_repo=False, stacked_on=None,
1936
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
1937
shared_repo=False, vfs_only=False):
1938
"""Create this format on transport.
1940
The directory to initialize will be created.
1942
:param force_new_repo: Do not use a shared repository for the target,
1943
even if one is available.
1944
:param create_prefix: Create any missing directories leading up to
1946
:param use_existing_dir: Use an existing directory if one exists.
1947
:param stacked_on: A url to stack any created branch on, None to follow
1948
any target stacking policy.
1949
:param stack_on_pwd: If stack_on is relative, the location it is
1951
:param repo_format_name: If non-None, a repository will be
1952
made-or-found. Should none be found, or if force_new_repo is True
1953
the repo_format_name is used to select the format of repository to
1955
:param make_working_trees: Control the setting of make_working_trees
1956
for a new shared repository when one is made. None to use whatever
1957
default the format has.
1958
:param shared_repo: Control whether made repositories are shared or
1960
:param vfs_only: If True do not attempt to use a smart server
1961
:return: repo, bzrdir, require_stacking, repository_policy. repo is
1962
None if none was created or found, bzrdir is always valid.
1963
require_stacking is the result of examining the stacked_on
1964
parameter and any stacking policy found for the target.
1967
# Try to hand off to a smart server
1969
client_medium = transport.get_smart_medium()
1970
except errors.NoSmartMedium:
1973
# TODO: lookup the local format from a server hint.
1974
remote_dir_format = RemoteBzrDirFormat()
1975
remote_dir_format._network_name = self.network_name()
1976
self._supply_sub_formats_to(remote_dir_format)
1977
return remote_dir_format.initialize_on_transport_ex(transport,
1978
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
1979
force_new_repo=force_new_repo, stacked_on=stacked_on,
1980
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
1981
make_working_trees=make_working_trees, shared_repo=shared_repo)
1982
# XXX: Refactor the create_prefix/no_create_prefix code into a
1983
# common helper function
1984
# The destination may not exist - if so make it according to policy.
1985
def make_directory(transport):
1986
transport.mkdir('.')
1988
def redirected(transport, e, redirection_notice):
1989
note(redirection_notice)
1990
return transport._redirected_to(e.source, e.target)
1992
transport = do_catching_redirections(make_directory, transport,
1994
except errors.FileExists:
1995
if not use_existing_dir:
1997
except errors.NoSuchFile:
1998
if not create_prefix:
2000
transport.create_prefix()
2002
require_stacking = (stacked_on is not None)
2003
# Now the target directory exists, but doesn't have a .bzr
2004
# directory. So we need to create it, along with any work to create
2005
# all of the dependent branches, etc.
2007
result = self.initialize_on_transport(transport)
2008
if repo_format_name:
2010
# use a custom format
2011
result._format.repository_format = \
2012
repository.network_format_registry.get(repo_format_name)
2013
except AttributeError:
2014
# The format didn't permit it to be set.
2016
# A repository is desired, either in-place or shared.
2017
repository_policy = result.determine_repository_policy(
2018
force_new_repo, stacked_on, stack_on_pwd,
2019
require_stacking=require_stacking)
2020
result_repo, is_new_repo = repository_policy.acquire_repository(
2021
make_working_trees, shared_repo)
2022
if not require_stacking and repository_policy._require_stacking:
2023
require_stacking = True
2024
result._format.require_stacking()
2025
result_repo.lock_write()
2028
repository_policy = None
2029
return result_repo, result, require_stacking, repository_policy
2031
def _initialize_on_transport_vfs(self, transport):
2032
"""Initialize a new bzrdir using VFS calls.
2034
:param transport: The transport to create the .bzr directory in.
2037
# Since we are creating a .bzr directory, inherit the
2038
# mode from the root directory
2039
temp_control = lockable_files.LockableFiles(transport,
2040
'', lockable_files.TransportLock)
2041
temp_control._transport.mkdir('.bzr',
2042
# FIXME: RBC 20060121 don't peek under
2044
mode=temp_control._dir_mode)
2045
if sys.platform == 'win32' and isinstance(transport, local.LocalTransport):
2046
win32utils.set_file_attr_hidden(transport._abspath('.bzr'))
2047
file_mode = temp_control._file_mode
2049
bzrdir_transport = transport.clone('.bzr')
2050
utf8_files = [('README',
2051
"This is a Bazaar control directory.\n"
2052
"Do not change any files in this directory.\n"
2053
"See http://bazaar-vcs.org/ for more information about Bazaar.\n"),
2054
('branch-format', self.get_format_string()),
2056
# NB: no need to escape relative paths that are url safe.
2057
control_files = lockable_files.LockableFiles(bzrdir_transport,
2058
self._lock_file_name, self._lock_class)
2059
control_files.create_lock()
2060
control_files.lock_write()
2062
for (filename, content) in utf8_files:
2063
bzrdir_transport.put_bytes(filename, content,
2066
control_files.unlock()
2067
return self.open(transport, _found=True)
2069
def is_supported(self):
2070
"""Is this format supported?
2072
Supported formats must be initializable and openable.
2073
Unsupported formats may not support initialization or committing or
2074
some other features depending on the reason for not being supported.
2078
def network_name(self):
2079
"""A simple byte string uniquely identifying this format for RPC calls.
2081
Bzr control formats use thir disk format string to identify the format
2082
over the wire. Its possible that other control formats have more
2083
complex detection requirements, so we permit them to use any unique and
2084
immutable string they desire.
2086
raise NotImplementedError(self.network_name)
2088
def same_model(self, target_format):
2089
return (self.repository_format.rich_root_data ==
2090
target_format.rich_root_data)
2093
def known_formats(klass):
2094
"""Return all the known formats.
2096
Concrete formats should override _known_formats.
2098
# There is double indirection here to make sure that control
2099
# formats used by more than one dir format will only be probed
2100
# once. This can otherwise be quite expensive for remote connections.
2102
for format in klass._control_formats:
2103
result.update(format._known_formats())
2107
def _known_formats(klass):
2108
"""Return the known format instances for this control format."""
2109
return set(klass._formats.values())
2111
def open(self, transport, _found=False):
2112
"""Return an instance of this format for the dir transport points at.
2114
_found is a private parameter, do not use it.
2117
found_format = BzrDirFormat.find_format(transport)
2118
if not isinstance(found_format, self.__class__):
2119
raise AssertionError("%s was asked to open %s, but it seems to need "
2121
% (self, transport, found_format))
2122
# Allow subclasses - use the found format.
2123
self._supply_sub_formats_to(found_format)
2124
return found_format._open(transport)
2125
return self._open(transport)
2127
def _open(self, transport):
2128
"""Template method helper for opening BzrDirectories.
2130
This performs the actual open and any additional logic or parameter
2133
raise NotImplementedError(self._open)
2136
def register_format(klass, format):
2137
klass._formats[format.get_format_string()] = format
2138
# bzr native formats have a network name of their format string.
2139
network_format_registry.register(format.get_format_string(), format.__class__)
2142
def register_control_format(klass, format):
2143
"""Register a format that does not use '.bzr' for its control dir.
2145
TODO: This should be pulled up into a 'ControlDirFormat' base class
2146
which BzrDirFormat can inherit from, and renamed to register_format
2147
there. It has been done without that for now for simplicity of
2150
klass._control_formats.append(format)
2153
def register_control_server_format(klass, format):
2154
"""Register a control format for client-server environments.
2156
These formats will be tried before ones registered with
2157
register_control_format. This gives implementations that decide to the
2158
chance to grab it before anything looks at the contents of the format
2161
klass._control_server_formats.append(format)
2164
def _set_default_format(klass, format):
2165
"""Set default format (for testing behavior of defaults only)"""
2166
klass._default_format = format
2170
return self.get_format_description().rstrip()
2172
def _supply_sub_formats_to(self, other_format):
2173
"""Give other_format the same values for sub formats as this has.
2175
This method is expected to be used when parameterising a
2176
RemoteBzrDirFormat instance with the parameters from a
2177
BzrDirMetaFormat1 instance.
2179
:param other_format: other_format is a format which should be
2180
compatible with whatever sub formats are supported by self.
2185
def unregister_format(klass, format):
2186
del klass._formats[format.get_format_string()]
2189
def unregister_control_format(klass, format):
2190
klass._control_formats.remove(format)
2193
class BzrDirFormat4(BzrDirFormat):
2194
"""Bzr dir format 4.
2196
This format is a combined format for working tree, branch and repository.
2198
- Format 1 working trees [always]
2199
- Format 4 branches [always]
2200
- Format 4 repositories [always]
2202
This format is deprecated: it indexes texts using a text it which is
2203
removed in format 5; write support for this format has been removed.
2206
_lock_class = lockable_files.TransportLock
2208
def get_format_string(self):
2209
"""See BzrDirFormat.get_format_string()."""
2210
return "Bazaar-NG branch, format 0.0.4\n"
2212
def get_format_description(self):
2213
"""See BzrDirFormat.get_format_description()."""
2214
return "All-in-one format 4"
2216
def get_converter(self, format=None):
2217
"""See BzrDirFormat.get_converter()."""
2218
# there is one and only one upgrade path here.
2219
return ConvertBzrDir4To5()
2221
def initialize_on_transport(self, transport):
2222
"""Format 4 branches cannot be created."""
2223
raise errors.UninitializableFormat(self)
2225
def is_supported(self):
2226
"""Format 4 is not supported.
2228
It is not supported because the model changed from 4 to 5 and the
2229
conversion logic is expensive - so doing it on the fly was not
2234
def network_name(self):
2235
return self.get_format_string()
2237
def _open(self, transport):
2238
"""See BzrDirFormat._open."""
2239
return BzrDir4(transport, self)
2241
def __return_repository_format(self):
2242
"""Circular import protection."""
2243
from bzrlib.repofmt.weaverepo import RepositoryFormat4
2244
return RepositoryFormat4()
2245
repository_format = property(__return_repository_format)
2248
class BzrDirFormatAllInOne(BzrDirFormat):
2249
"""Common class for formats before meta-dirs."""
2251
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
2252
create_prefix=False, force_new_repo=False, stacked_on=None,
2253
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
2255
"""See BzrDirFormat.initialize_on_transport_ex."""
2256
require_stacking = (stacked_on is not None)
2257
# Format 5 cannot stack, but we've been asked to - actually init
2259
if require_stacking:
2260
format = BzrDirMetaFormat1()
2261
return format.initialize_on_transport_ex(transport,
2262
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2263
force_new_repo=force_new_repo, stacked_on=stacked_on,
2264
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2265
make_working_trees=make_working_trees, shared_repo=shared_repo)
2266
return BzrDirFormat.initialize_on_transport_ex(self, transport,
2267
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2268
force_new_repo=force_new_repo, stacked_on=stacked_on,
2269
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2270
make_working_trees=make_working_trees, shared_repo=shared_repo)
2273
class BzrDirFormat5(BzrDirFormatAllInOne):
2274
"""Bzr control format 5.
2276
This format is a combined format for working tree, branch and repository.
2278
- Format 2 working trees [always]
2279
- Format 4 branches [always]
2280
- Format 5 repositories [always]
2281
Unhashed stores in the repository.
2284
_lock_class = lockable_files.TransportLock
2286
def get_format_string(self):
2287
"""See BzrDirFormat.get_format_string()."""
2288
return "Bazaar-NG branch, format 5\n"
2290
def get_branch_format(self):
2291
from bzrlib import branch
2292
return branch.BzrBranchFormat4()
2294
def get_format_description(self):
2295
"""See BzrDirFormat.get_format_description()."""
2296
return "All-in-one format 5"
2298
def get_converter(self, format=None):
2299
"""See BzrDirFormat.get_converter()."""
2300
# there is one and only one upgrade path here.
2301
return ConvertBzrDir5To6()
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 5 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 RepositoryFormat5
2313
result = (super(BzrDirFormat5, self).initialize_on_transport(transport))
2314
RepositoryFormat5().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 BzrDir5(transport, self)
2327
def __return_repository_format(self):
2328
"""Circular import protection."""
2329
from bzrlib.repofmt.weaverepo import RepositoryFormat5
2330
return RepositoryFormat5()
2331
repository_format = property(__return_repository_format)
2334
class BzrDirFormat6(BzrDirFormatAllInOne):
2335
"""Bzr control format 6.
2337
This format is a combined format for working tree, branch and repository.
2339
- Format 2 working trees [always]
2340
- Format 4 branches [always]
2341
- Format 6 repositories [always]
2344
_lock_class = lockable_files.TransportLock
2346
def get_format_string(self):
2347
"""See BzrDirFormat.get_format_string()."""
2348
return "Bazaar-NG branch, format 6\n"
2350
def get_format_description(self):
2351
"""See BzrDirFormat.get_format_description()."""
2352
return "All-in-one format 6"
2354
def get_branch_format(self):
2355
from bzrlib import branch
2356
return branch.BzrBranchFormat4()
2358
def get_converter(self, format=None):
2359
"""See BzrDirFormat.get_converter()."""
2360
# there is one and only one upgrade path here.
2361
return ConvertBzrDir6ToMeta()
2363
def _initialize_for_clone(self, url):
2364
return self.initialize_on_transport(get_transport(url), _cloning=True)
2366
def initialize_on_transport(self, transport, _cloning=False):
2367
"""Format 6 dirs always have working tree, branch and repository.
2369
Except when they are being cloned.
2371
from bzrlib.branch import BzrBranchFormat4
2372
from bzrlib.repofmt.weaverepo import RepositoryFormat6
2373
result = super(BzrDirFormat6, self).initialize_on_transport(transport)
2374
RepositoryFormat6().initialize(result, _internal=True)
2376
branch = BzrBranchFormat4().initialize(result)
2377
result._init_workingtree()
2380
def network_name(self):
2381
return self.get_format_string()
2383
def _open(self, transport):
2384
"""See BzrDirFormat._open."""
2385
return BzrDir6(transport, self)
2387
def __return_repository_format(self):
2388
"""Circular import protection."""
2389
from bzrlib.repofmt.weaverepo import RepositoryFormat6
2390
return RepositoryFormat6()
2391
repository_format = property(__return_repository_format)
2394
class BzrDirMetaFormat1(BzrDirFormat):
2395
"""Bzr meta control format 1
2397
This is the first format with split out working tree, branch and repository
2400
- Format 3 working trees [optional]
2401
- Format 5 branches [optional]
2402
- Format 7 repositories [optional]
2405
_lock_class = lockdir.LockDir
2408
self._workingtree_format = None
2409
self._branch_format = None
2410
self._repository_format = None
2412
def __eq__(self, other):
2413
if other.__class__ is not self.__class__:
2415
if other.repository_format != self.repository_format:
2417
if other.workingtree_format != self.workingtree_format:
2421
def __ne__(self, other):
2422
return not self == other
2424
def get_branch_format(self):
2425
if self._branch_format is None:
2426
from bzrlib.branch import BranchFormat
2427
self._branch_format = BranchFormat.get_default_format()
2428
return self._branch_format
2430
def set_branch_format(self, format):
2431
self._branch_format = format
2433
def require_stacking(self, stack_on=None, possible_transports=None,
2435
"""We have a request to stack, try to ensure the formats support it.
2437
:param stack_on: If supplied, it is the URL to a branch that we want to
2438
stack on. Check to see if that format supports stacking before
2441
# Stacking is desired. requested by the target, but does the place it
2442
# points at support stacking? If it doesn't then we should
2443
# not implicitly upgrade. We check this here.
2444
new_repo_format = None
2445
new_branch_format = None
2447
# a bit of state for get_target_branch so that we don't try to open it
2448
# 2 times, for both repo *and* branch
2449
target = [None, False, None] # target_branch, checked, upgrade anyway
2450
def get_target_branch():
2452
# We've checked, don't check again
2454
if stack_on is None:
2455
# No target format, that means we want to force upgrading
2456
target[:] = [None, True, True]
2459
target_dir = BzrDir.open(stack_on,
2460
possible_transports=possible_transports)
2461
except errors.NotBranchError:
2462
# Nothing there, don't change formats
2463
target[:] = [None, True, False]
2465
except errors.JailBreak:
2466
# JailBreak, JFDI and upgrade anyway
2467
target[:] = [None, True, True]
2470
target_branch = target_dir.open_branch()
2471
except errors.NotBranchError:
2472
# No branch, don't upgrade formats
2473
target[:] = [None, True, False]
2475
target[:] = [target_branch, True, False]
2478
if (not _skip_repo and
2479
not self.repository_format.supports_external_lookups):
2480
# We need to upgrade the Repository.
2481
target_branch, _, do_upgrade = get_target_branch()
2482
if target_branch is None:
2483
# We don't have a target branch, should we upgrade anyway?
2485
# stack_on is inaccessible, JFDI.
2486
# TODO: bad monkey, hard-coded formats...
2487
if self.repository_format.rich_root_data:
2488
new_repo_format = pack_repo.RepositoryFormatKnitPack5RichRoot()
2490
new_repo_format = pack_repo.RepositoryFormatKnitPack5()
2492
# If the target already supports stacking, then we know the
2493
# project is already able to use stacking, so auto-upgrade
2495
new_repo_format = target_branch.repository._format
2496
if not new_repo_format.supports_external_lookups:
2497
# target doesn't, source doesn't, so don't auto upgrade
2499
new_repo_format = None
2500
if new_repo_format is not None:
2501
self.repository_format = new_repo_format
2502
note('Source repository format does not support stacking,'
2503
' using format:\n %s',
2504
new_repo_format.get_format_description())
2506
if not self.get_branch_format().supports_stacking():
2507
# We just checked the repo, now lets check if we need to
2508
# upgrade the branch format
2509
target_branch, _, do_upgrade = get_target_branch()
2510
if target_branch is None:
2512
# TODO: bad monkey, hard-coded formats...
2513
new_branch_format = branch.BzrBranchFormat7()
2515
new_branch_format = target_branch._format
2516
if not new_branch_format.supports_stacking():
2517
new_branch_format = None
2518
if new_branch_format is not None:
2519
# Does support stacking, use its format.
2520
self.set_branch_format(new_branch_format)
2521
note('Source branch format does not support stacking,'
2522
' using format:\n %s',
2523
new_branch_format.get_format_description())
2525
def get_converter(self, format=None):
2526
"""See BzrDirFormat.get_converter()."""
2528
format = BzrDirFormat.get_default_format()
2529
if not isinstance(self, format.__class__):
2530
# converting away from metadir is not implemented
2531
raise NotImplementedError(self.get_converter)
2532
return ConvertMetaToMeta(format)
2534
def get_format_string(self):
2535
"""See BzrDirFormat.get_format_string()."""
2536
return "Bazaar-NG meta directory, format 1\n"
2538
def get_format_description(self):
2539
"""See BzrDirFormat.get_format_description()."""
2540
return "Meta directory format 1"
2542
def network_name(self):
2543
return self.get_format_string()
2545
def _open(self, transport):
2546
"""See BzrDirFormat._open."""
2547
# Create a new format instance because otherwise initialisation of new
2548
# metadirs share the global default format object leading to alias
2550
format = BzrDirMetaFormat1()
2551
self._supply_sub_formats_to(format)
2552
return BzrDirMeta1(transport, format)
2554
def __return_repository_format(self):
2555
"""Circular import protection."""
2556
if self._repository_format:
2557
return self._repository_format
2558
from bzrlib.repository import RepositoryFormat
2559
return RepositoryFormat.get_default_format()
2561
def _set_repository_format(self, value):
2562
"""Allow changing the repository format for metadir formats."""
2563
self._repository_format = value
2565
repository_format = property(__return_repository_format,
2566
_set_repository_format)
2568
def _supply_sub_formats_to(self, other_format):
2569
"""Give other_format the same values for sub formats as this has.
2571
This method is expected to be used when parameterising a
2572
RemoteBzrDirFormat instance with the parameters from a
2573
BzrDirMetaFormat1 instance.
2575
:param other_format: other_format is a format which should be
2576
compatible with whatever sub formats are supported by self.
2579
if getattr(self, '_repository_format', None) is not None:
2580
other_format.repository_format = self.repository_format
2581
if self._branch_format is not None:
2582
other_format._branch_format = self._branch_format
2583
if self._workingtree_format is not None:
2584
other_format.workingtree_format = self.workingtree_format
2586
def __get_workingtree_format(self):
2587
if self._workingtree_format is None:
2588
from bzrlib.workingtree import WorkingTreeFormat
2589
self._workingtree_format = WorkingTreeFormat.get_default_format()
2590
return self._workingtree_format
2592
def __set_workingtree_format(self, wt_format):
2593
self._workingtree_format = wt_format
2595
workingtree_format = property(__get_workingtree_format,
2596
__set_workingtree_format)
2599
network_format_registry = registry.FormatRegistry()
2600
"""Registry of formats indexed by their network name.
2602
The network name for a BzrDirFormat is an identifier that can be used when
2603
referring to formats with smart server operations. See
2604
BzrDirFormat.network_name() for more detail.
2608
# Register bzr control format
2609
BzrDirFormat.register_control_format(BzrDirFormat)
2611
# Register bzr formats
2612
BzrDirFormat.register_format(BzrDirFormat4())
2613
BzrDirFormat.register_format(BzrDirFormat5())
2614
BzrDirFormat.register_format(BzrDirFormat6())
2615
__default_format = BzrDirMetaFormat1()
2616
BzrDirFormat.register_format(__default_format)
2617
BzrDirFormat._default_format = __default_format
2620
class Converter(object):
2621
"""Converts a disk format object from one format to another."""
2623
def convert(self, to_convert, pb):
2624
"""Perform the conversion of to_convert, giving feedback via pb.
2626
:param to_convert: The disk object to convert.
2627
:param pb: a progress bar to use for progress information.
2630
def step(self, message):
2631
"""Update the pb by a step."""
2633
self.pb.update(message, self.count, self.total)
2636
class ConvertBzrDir4To5(Converter):
2637
"""Converts format 4 bzr dirs to format 5."""
2640
super(ConvertBzrDir4To5, self).__init__()
2641
self.converted_revs = set()
2642
self.absent_revisions = set()
2646
def convert(self, to_convert, pb):
2647
"""See Converter.convert()."""
2648
self.bzrdir = to_convert
2650
warnings.warn("pb parameter to convert() is deprecated")
2651
self.pb = ui.ui_factory.nested_progress_bar()
2653
ui.ui_factory.note('starting upgrade from format 4 to 5')
2654
if isinstance(self.bzrdir.transport, local.LocalTransport):
2655
self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
2656
self._convert_to_weaves()
2657
return BzrDir.open(self.bzrdir.root_transport.base)
2661
def _convert_to_weaves(self):
2662
ui.ui_factory.note('note: upgrade may be faster if all store files are ungzipped first')
2665
stat = self.bzrdir.transport.stat('weaves')
2666
if not S_ISDIR(stat.st_mode):
2667
self.bzrdir.transport.delete('weaves')
2668
self.bzrdir.transport.mkdir('weaves')
2669
except errors.NoSuchFile:
2670
self.bzrdir.transport.mkdir('weaves')
2671
# deliberately not a WeaveFile as we want to build it up slowly.
2672
self.inv_weave = Weave('inventory')
2673
# holds in-memory weaves for all files
2674
self.text_weaves = {}
2675
self.bzrdir.transport.delete('branch-format')
2676
self.branch = self.bzrdir.open_branch()
2677
self._convert_working_inv()
2678
rev_history = self.branch.revision_history()
2679
# to_read is a stack holding the revisions we still need to process;
2680
# appending to it adds new highest-priority revisions
2681
self.known_revisions = set(rev_history)
2682
self.to_read = rev_history[-1:]
2684
rev_id = self.to_read.pop()
2685
if (rev_id not in self.revisions
2686
and rev_id not in self.absent_revisions):
2687
self._load_one_rev(rev_id)
2689
to_import = self._make_order()
2690
for i, rev_id in enumerate(to_import):
2691
self.pb.update('converting revision', i, len(to_import))
2692
self._convert_one_rev(rev_id)
2694
self._write_all_weaves()
2695
self._write_all_revs()
2696
ui.ui_factory.note('upgraded to weaves:')
2697
ui.ui_factory.note(' %6d revisions and inventories' % len(self.revisions))
2698
ui.ui_factory.note(' %6d revisions not present' % len(self.absent_revisions))
2699
ui.ui_factory.note(' %6d texts' % self.text_count)
2700
self._cleanup_spare_files_after_format4()
2701
self.branch._transport.put_bytes(
2703
BzrDirFormat5().get_format_string(),
2704
mode=self.bzrdir._get_file_mode())
2706
def _cleanup_spare_files_after_format4(self):
2707
# FIXME working tree upgrade foo.
2708
for n in 'merged-patches', 'pending-merged-patches':
2710
## assert os.path.getsize(p) == 0
2711
self.bzrdir.transport.delete(n)
2712
except errors.NoSuchFile:
2714
self.bzrdir.transport.delete_tree('inventory-store')
2715
self.bzrdir.transport.delete_tree('text-store')
2717
def _convert_working_inv(self):
2718
inv = xml4.serializer_v4.read_inventory(
2719
self.branch._transport.get('inventory'))
2720
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv, working=True)
2721
self.branch._transport.put_bytes('inventory', new_inv_xml,
2722
mode=self.bzrdir._get_file_mode())
2724
def _write_all_weaves(self):
2725
controlweaves = WeaveStore(self.bzrdir.transport, prefixed=False)
2726
weave_transport = self.bzrdir.transport.clone('weaves')
2727
weaves = WeaveStore(weave_transport, prefixed=False)
2728
transaction = WriteTransaction()
2732
for file_id, file_weave in self.text_weaves.items():
2733
self.pb.update('writing weave', i, len(self.text_weaves))
2734
weaves._put_weave(file_id, file_weave, transaction)
2736
self.pb.update('inventory', 0, 1)
2737
controlweaves._put_weave('inventory', self.inv_weave, transaction)
2738
self.pb.update('inventory', 1, 1)
2742
def _write_all_revs(self):
2743
"""Write all revisions out in new form."""
2744
self.bzrdir.transport.delete_tree('revision-store')
2745
self.bzrdir.transport.mkdir('revision-store')
2746
revision_transport = self.bzrdir.transport.clone('revision-store')
2748
from bzrlib.xml5 import serializer_v5
2749
from bzrlib.repofmt.weaverepo import RevisionTextStore
2750
revision_store = RevisionTextStore(revision_transport,
2751
serializer_v5, False, versionedfile.PrefixMapper(),
2752
lambda:True, lambda:True)
2754
for i, rev_id in enumerate(self.converted_revs):
2755
self.pb.update('write revision', i, len(self.converted_revs))
2756
text = serializer_v5.write_revision_to_string(
2757
self.revisions[rev_id])
2759
revision_store.add_lines(key, None, osutils.split_lines(text))
2763
def _load_one_rev(self, rev_id):
2764
"""Load a revision object into memory.
2766
Any parents not either loaded or abandoned get queued to be
2768
self.pb.update('loading revision',
2769
len(self.revisions),
2770
len(self.known_revisions))
2771
if not self.branch.repository.has_revision(rev_id):
2773
ui.ui_factory.note('revision {%s} not present in branch; '
2774
'will be converted as a ghost' %
2776
self.absent_revisions.add(rev_id)
2778
rev = self.branch.repository.get_revision(rev_id)
2779
for parent_id in rev.parent_ids:
2780
self.known_revisions.add(parent_id)
2781
self.to_read.append(parent_id)
2782
self.revisions[rev_id] = rev
2784
def _load_old_inventory(self, rev_id):
2785
old_inv_xml = self.branch.repository.inventory_store.get(rev_id).read()
2786
inv = xml4.serializer_v4.read_inventory_from_string(old_inv_xml)
2787
inv.revision_id = rev_id
2788
rev = self.revisions[rev_id]
2791
def _load_updated_inventory(self, rev_id):
2792
inv_xml = self.inv_weave.get_text(rev_id)
2793
inv = xml5.serializer_v5.read_inventory_from_string(inv_xml, rev_id)
2796
def _convert_one_rev(self, rev_id):
2797
"""Convert revision and all referenced objects to new format."""
2798
rev = self.revisions[rev_id]
2799
inv = self._load_old_inventory(rev_id)
2800
present_parents = [p for p in rev.parent_ids
2801
if p not in self.absent_revisions]
2802
self._convert_revision_contents(rev, inv, present_parents)
2803
self._store_new_inv(rev, inv, present_parents)
2804
self.converted_revs.add(rev_id)
2806
def _store_new_inv(self, rev, inv, present_parents):
2807
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
2808
new_inv_sha1 = sha_string(new_inv_xml)
2809
self.inv_weave.add_lines(rev.revision_id,
2811
new_inv_xml.splitlines(True))
2812
rev.inventory_sha1 = new_inv_sha1
2814
def _convert_revision_contents(self, rev, inv, present_parents):
2815
"""Convert all the files within a revision.
2817
Also upgrade the inventory to refer to the text revision ids."""
2818
rev_id = rev.revision_id
2819
mutter('converting texts of revision {%s}',
2821
parent_invs = map(self._load_updated_inventory, present_parents)
2822
entries = inv.iter_entries()
2824
for path, ie in entries:
2825
self._convert_file_version(rev, ie, parent_invs)
2827
def _convert_file_version(self, rev, ie, parent_invs):
2828
"""Convert one version of one file.
2830
The file needs to be added into the weave if it is a merge
2831
of >=2 parents or if it's changed from its parent.
2833
file_id = ie.file_id
2834
rev_id = rev.revision_id
2835
w = self.text_weaves.get(file_id)
2838
self.text_weaves[file_id] = w
2839
text_changed = False
2840
parent_candiate_entries = ie.parent_candidates(parent_invs)
2841
heads = graph.Graph(self).heads(parent_candiate_entries.keys())
2842
# XXX: Note that this is unordered - and this is tolerable because
2843
# the previous code was also unordered.
2844
previous_entries = dict((head, parent_candiate_entries[head]) for head
2846
self.snapshot_ie(previous_entries, ie, w, rev_id)
2849
def get_parent_map(self, revision_ids):
2850
"""See graph.StackedParentsProvider.get_parent_map"""
2851
return dict((revision_id, self.revisions[revision_id])
2852
for revision_id in revision_ids
2853
if revision_id in self.revisions)
2855
def snapshot_ie(self, previous_revisions, ie, w, rev_id):
2856
# TODO: convert this logic, which is ~= snapshot to
2857
# a call to:. This needs the path figured out. rather than a work_tree
2858
# a v4 revision_tree can be given, or something that looks enough like
2859
# one to give the file content to the entry if it needs it.
2860
# and we need something that looks like a weave store for snapshot to
2862
#ie.snapshot(rev, PATH, previous_revisions, REVISION_TREE, InMemoryWeaveStore(self.text_weaves))
2863
if len(previous_revisions) == 1:
2864
previous_ie = previous_revisions.values()[0]
2865
if ie._unchanged(previous_ie):
2866
ie.revision = previous_ie.revision
2869
text = self.branch.repository._text_store.get(ie.text_id)
2870
file_lines = text.readlines()
2871
w.add_lines(rev_id, previous_revisions, file_lines)
2872
self.text_count += 1
2874
w.add_lines(rev_id, previous_revisions, [])
2875
ie.revision = rev_id
2877
def _make_order(self):
2878
"""Return a suitable order for importing revisions.
2880
The order must be such that an revision is imported after all
2881
its (present) parents.
2883
todo = set(self.revisions.keys())
2884
done = self.absent_revisions.copy()
2887
# scan through looking for a revision whose parents
2889
for rev_id in sorted(list(todo)):
2890
rev = self.revisions[rev_id]
2891
parent_ids = set(rev.parent_ids)
2892
if parent_ids.issubset(done):
2893
# can take this one now
2894
order.append(rev_id)
2900
class ConvertBzrDir5To6(Converter):
2901
"""Converts format 5 bzr dirs to format 6."""
2903
def convert(self, to_convert, pb):
2904
"""See Converter.convert()."""
2905
self.bzrdir = to_convert
2906
pb = ui.ui_factory.nested_progress_bar()
2908
ui.ui_factory.note('starting upgrade from format 5 to 6')
2909
self._convert_to_prefixed()
2910
return BzrDir.open(self.bzrdir.root_transport.base)
2914
def _convert_to_prefixed(self):
2915
from bzrlib.store import TransportStore
2916
self.bzrdir.transport.delete('branch-format')
2917
for store_name in ["weaves", "revision-store"]:
2918
ui.ui_factory.note("adding prefixes to %s" % store_name)
2919
store_transport = self.bzrdir.transport.clone(store_name)
2920
store = TransportStore(store_transport, prefixed=True)
2921
for urlfilename in store_transport.list_dir('.'):
2922
filename = urlutils.unescape(urlfilename)
2923
if (filename.endswith(".weave") or
2924
filename.endswith(".gz") or
2925
filename.endswith(".sig")):
2926
file_id, suffix = os.path.splitext(filename)
2930
new_name = store._mapper.map((file_id,)) + suffix
2931
# FIXME keep track of the dirs made RBC 20060121
2933
store_transport.move(filename, new_name)
2934
except errors.NoSuchFile: # catches missing dirs strangely enough
2935
store_transport.mkdir(osutils.dirname(new_name))
2936
store_transport.move(filename, new_name)
2937
self.bzrdir.transport.put_bytes(
2939
BzrDirFormat6().get_format_string(),
2940
mode=self.bzrdir._get_file_mode())
2943
class ConvertBzrDir6ToMeta(Converter):
2944
"""Converts format 6 bzr dirs to metadirs."""
2946
def convert(self, to_convert, pb):
2947
"""See Converter.convert()."""
2948
from bzrlib.repofmt.weaverepo import RepositoryFormat7
2949
from bzrlib.branch import BzrBranchFormat5
2950
self.bzrdir = to_convert
2951
self.pb = ui.ui_factory.nested_progress_bar()
2953
self.total = 20 # the steps we know about
2954
self.garbage_inventories = []
2955
self.dir_mode = self.bzrdir._get_dir_mode()
2956
self.file_mode = self.bzrdir._get_file_mode()
2958
ui.ui_factory.note('starting upgrade from format 6 to metadir')
2959
self.bzrdir.transport.put_bytes(
2961
"Converting to format 6",
2962
mode=self.file_mode)
2963
# its faster to move specific files around than to open and use the apis...
2964
# first off, nuke ancestry.weave, it was never used.
2966
self.step('Removing ancestry.weave')
2967
self.bzrdir.transport.delete('ancestry.weave')
2968
except errors.NoSuchFile:
2970
# find out whats there
2971
self.step('Finding branch files')
2972
last_revision = self.bzrdir.open_branch().last_revision()
2973
bzrcontents = self.bzrdir.transport.list_dir('.')
2974
for name in bzrcontents:
2975
if name.startswith('basis-inventory.'):
2976
self.garbage_inventories.append(name)
2977
# create new directories for repository, working tree and branch
2978
repository_names = [('inventory.weave', True),
2979
('revision-store', True),
2981
self.step('Upgrading repository ')
2982
self.bzrdir.transport.mkdir('repository', mode=self.dir_mode)
2983
self.make_lock('repository')
2984
# we hard code the formats here because we are converting into
2985
# the meta format. The meta format upgrader can take this to a
2986
# future format within each component.
2987
self.put_format('repository', RepositoryFormat7())
2988
for entry in repository_names:
2989
self.move_entry('repository', entry)
2991
self.step('Upgrading branch ')
2992
self.bzrdir.transport.mkdir('branch', mode=self.dir_mode)
2993
self.make_lock('branch')
2994
self.put_format('branch', BzrBranchFormat5())
2995
branch_files = [('revision-history', True),
2996
('branch-name', True),
2998
for entry in branch_files:
2999
self.move_entry('branch', entry)
3001
checkout_files = [('pending-merges', True),
3002
('inventory', True),
3003
('stat-cache', False)]
3004
# If a mandatory checkout file is not present, the branch does not have
3005
# a functional checkout. Do not create a checkout in the converted
3007
for name, mandatory in checkout_files:
3008
if mandatory and name not in bzrcontents:
3009
has_checkout = False
3013
if not has_checkout:
3014
ui.ui_factory.note('No working tree.')
3015
# If some checkout files are there, we may as well get rid of them.
3016
for name, mandatory in checkout_files:
3017
if name in bzrcontents:
3018
self.bzrdir.transport.delete(name)
3020
from bzrlib.workingtree import WorkingTreeFormat3
3021
self.step('Upgrading working tree')
3022
self.bzrdir.transport.mkdir('checkout', mode=self.dir_mode)
3023
self.make_lock('checkout')
3025
'checkout', WorkingTreeFormat3())
3026
self.bzrdir.transport.delete_multi(
3027
self.garbage_inventories, self.pb)
3028
for entry in checkout_files:
3029
self.move_entry('checkout', entry)
3030
if last_revision is not None:
3031
self.bzrdir.transport.put_bytes(
3032
'checkout/last-revision', last_revision)
3033
self.bzrdir.transport.put_bytes(
3035
BzrDirMetaFormat1().get_format_string(),
3036
mode=self.file_mode)
3038
return BzrDir.open(self.bzrdir.root_transport.base)
3040
def make_lock(self, name):
3041
"""Make a lock for the new control dir name."""
3042
self.step('Make %s lock' % name)
3043
ld = lockdir.LockDir(self.bzrdir.transport,
3045
file_modebits=self.file_mode,
3046
dir_modebits=self.dir_mode)
3049
def move_entry(self, new_dir, entry):
3050
"""Move then entry name into new_dir."""
3052
mandatory = entry[1]
3053
self.step('Moving %s' % name)
3055
self.bzrdir.transport.move(name, '%s/%s' % (new_dir, name))
3056
except errors.NoSuchFile:
3060
def put_format(self, dirname, format):
3061
self.bzrdir.transport.put_bytes('%s/format' % dirname,
3062
format.get_format_string(),
3066
class ConvertMetaToMeta(Converter):
3067
"""Converts the components of metadirs."""
3069
def __init__(self, target_format):
3070
"""Create a metadir to metadir converter.
3072
:param target_format: The final metadir format that is desired.
3074
self.target_format = target_format
3076
def convert(self, to_convert, pb):
3077
"""See Converter.convert()."""
3078
self.bzrdir = to_convert
3079
self.pb = ui.ui_factory.nested_progress_bar()
3082
self.step('checking repository format')
3084
repo = self.bzrdir.open_repository()
3085
except errors.NoRepositoryPresent:
3088
if not isinstance(repo._format, self.target_format.repository_format.__class__):
3089
from bzrlib.repository import CopyConverter
3090
ui.ui_factory.note('starting repository conversion')
3091
converter = CopyConverter(self.target_format.repository_format)
3092
converter.convert(repo, pb)
3093
for branch in self.bzrdir.list_branches():
3094
# TODO: conversions of Branch and Tree should be done by
3095
# InterXFormat lookups/some sort of registry.
3096
# Avoid circular imports
3097
from bzrlib import branch as _mod_branch
3098
old = branch._format.__class__
3099
new = self.target_format.get_branch_format().__class__
3101
if (old == _mod_branch.BzrBranchFormat5 and
3102
new in (_mod_branch.BzrBranchFormat6,
3103
_mod_branch.BzrBranchFormat7,
3104
_mod_branch.BzrBranchFormat8)):
3105
branch_converter = _mod_branch.Converter5to6()
3106
elif (old == _mod_branch.BzrBranchFormat6 and
3107
new in (_mod_branch.BzrBranchFormat7,
3108
_mod_branch.BzrBranchFormat8)):
3109
branch_converter = _mod_branch.Converter6to7()
3110
elif (old == _mod_branch.BzrBranchFormat7 and
3111
new is _mod_branch.BzrBranchFormat8):
3112
branch_converter = _mod_branch.Converter7to8()
3114
raise errors.BadConversionTarget("No converter", new,
3116
branch_converter.convert(branch)
3117
branch = self.bzrdir.open_branch()
3118
old = branch._format.__class__
3120
tree = self.bzrdir.open_workingtree(recommend_upgrade=False)
3121
except (errors.NoWorkingTree, errors.NotLocalUrl):
3124
# TODO: conversions of Branch and Tree should be done by
3125
# InterXFormat lookups
3126
if (isinstance(tree, workingtree.WorkingTree3) and
3127
not isinstance(tree, workingtree_4.DirStateWorkingTree) and
3128
isinstance(self.target_format.workingtree_format,
3129
workingtree_4.DirStateWorkingTreeFormat)):
3130
workingtree_4.Converter3to4().convert(tree)
3131
if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
3132
not isinstance(tree, workingtree_4.WorkingTree5) and
3133
isinstance(self.target_format.workingtree_format,
3134
workingtree_4.WorkingTreeFormat5)):
3135
workingtree_4.Converter4to5().convert(tree)
3136
if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
3137
not isinstance(tree, workingtree_4.WorkingTree6) and
3138
isinstance(self.target_format.workingtree_format,
3139
workingtree_4.WorkingTreeFormat6)):
3140
workingtree_4.Converter4or5to6().convert(tree)
3145
# This is not in remote.py because it's relatively small, and needs to be
3146
# registered. Putting it in remote.py creates a circular import problem.
3147
# we can make it a lazy object if the control formats is turned into something
3149
class RemoteBzrDirFormat(BzrDirMetaFormat1):
3150
"""Format representing bzrdirs accessed via a smart server"""
3153
BzrDirMetaFormat1.__init__(self)
3154
# XXX: It's a bit ugly that the network name is here, because we'd
3155
# like to believe that format objects are stateless or at least
3156
# immutable, However, we do at least avoid mutating the name after
3157
# it's returned. See <https://bugs.edge.launchpad.net/bzr/+bug/504102>
3158
self._network_name = None
3161
return "%s(_network_name=%r)" % (self.__class__.__name__,
3164
def get_format_description(self):
3165
if self._network_name:
3166
real_format = network_format_registry.get(self._network_name)
3167
return 'Remote: ' + real_format.get_format_description()
3168
return 'bzr remote bzrdir'
3170
def get_format_string(self):
3171
raise NotImplementedError(self.get_format_string)
3173
def network_name(self):
3174
if self._network_name:
3175
return self._network_name
3177
raise AssertionError("No network name set.")
3180
def probe_transport(klass, transport):
3181
"""Return a RemoteBzrDirFormat object if it looks possible."""
3183
medium = transport.get_smart_medium()
3184
except (NotImplementedError, AttributeError,
3185
errors.TransportNotPossible, errors.NoSmartMedium,
3186
errors.SmartProtocolError):
3187
# no smart server, so not a branch for this format type.
3188
raise errors.NotBranchError(path=transport.base)
3190
# Decline to open it if the server doesn't support our required
3191
# version (3) so that the VFS-based transport will do it.
3192
if medium.should_probe():
3194
server_version = medium.protocol_version()
3195
except errors.SmartProtocolError:
3196
# Apparently there's no usable smart server there, even though
3197
# the medium supports the smart protocol.
3198
raise errors.NotBranchError(path=transport.base)
3199
if server_version != '2':
3200
raise errors.NotBranchError(path=transport.base)
3203
def initialize_on_transport(self, transport):
3205
# hand off the request to the smart server
3206
client_medium = transport.get_smart_medium()
3207
except errors.NoSmartMedium:
3208
# TODO: lookup the local format from a server hint.
3209
local_dir_format = BzrDirMetaFormat1()
3210
return local_dir_format.initialize_on_transport(transport)
3211
client = _SmartClient(client_medium)
3212
path = client.remote_path_from_transport(transport)
3214
response = client.call('BzrDirFormat.initialize', path)
3215
except errors.ErrorFromSmartServer, err:
3216
remote._translate_error(err, path=path)
3217
if response[0] != 'ok':
3218
raise errors.SmartProtocolError('unexpected response code %s' % (response,))
3219
format = RemoteBzrDirFormat()
3220
self._supply_sub_formats_to(format)
3221
return remote.RemoteBzrDir(transport, format)
3223
def parse_NoneTrueFalse(self, arg):
3230
raise AssertionError("invalid arg %r" % arg)
3232
def _serialize_NoneTrueFalse(self, arg):
3239
def _serialize_NoneString(self, arg):
3242
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
3243
create_prefix=False, force_new_repo=False, stacked_on=None,
3244
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
3247
# hand off the request to the smart server
3248
client_medium = transport.get_smart_medium()
3249
except errors.NoSmartMedium:
3252
# Decline to open it if the server doesn't support our required
3253
# version (3) so that the VFS-based transport will do it.
3254
if client_medium.should_probe():
3256
server_version = client_medium.protocol_version()
3257
if server_version != '2':
3261
except errors.SmartProtocolError:
3262
# Apparently there's no usable smart server there, even though
3263
# the medium supports the smart protocol.
3268
client = _SmartClient(client_medium)
3269
path = client.remote_path_from_transport(transport)
3270
if client_medium._is_remote_before((1, 16)):
3273
# TODO: lookup the local format from a server hint.
3274
local_dir_format = BzrDirMetaFormat1()
3275
self._supply_sub_formats_to(local_dir_format)
3276
return local_dir_format.initialize_on_transport_ex(transport,
3277
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3278
force_new_repo=force_new_repo, stacked_on=stacked_on,
3279
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3280
make_working_trees=make_working_trees, shared_repo=shared_repo,
3282
return self._initialize_on_transport_ex_rpc(client, path, transport,
3283
use_existing_dir, create_prefix, force_new_repo, stacked_on,
3284
stack_on_pwd, repo_format_name, make_working_trees, shared_repo)
3286
def _initialize_on_transport_ex_rpc(self, client, path, transport,
3287
use_existing_dir, create_prefix, force_new_repo, stacked_on,
3288
stack_on_pwd, repo_format_name, make_working_trees, shared_repo):
3290
args.append(self._serialize_NoneTrueFalse(use_existing_dir))
3291
args.append(self._serialize_NoneTrueFalse(create_prefix))
3292
args.append(self._serialize_NoneTrueFalse(force_new_repo))
3293
args.append(self._serialize_NoneString(stacked_on))
3294
# stack_on_pwd is often/usually our transport
3297
stack_on_pwd = transport.relpath(stack_on_pwd)
3298
if not stack_on_pwd:
3300
except errors.PathNotChild:
3302
args.append(self._serialize_NoneString(stack_on_pwd))
3303
args.append(self._serialize_NoneString(repo_format_name))
3304
args.append(self._serialize_NoneTrueFalse(make_working_trees))
3305
args.append(self._serialize_NoneTrueFalse(shared_repo))
3306
request_network_name = self._network_name or \
3307
BzrDirFormat.get_default_format().network_name()
3309
response = client.call('BzrDirFormat.initialize_ex_1.16',
3310
request_network_name, path, *args)
3311
except errors.UnknownSmartMethod:
3312
client._medium._remember_remote_is_before((1,16))
3313
local_dir_format = BzrDirMetaFormat1()
3314
self._supply_sub_formats_to(local_dir_format)
3315
return local_dir_format.initialize_on_transport_ex(transport,
3316
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3317
force_new_repo=force_new_repo, stacked_on=stacked_on,
3318
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3319
make_working_trees=make_working_trees, shared_repo=shared_repo,
3321
except errors.ErrorFromSmartServer, err:
3322
remote._translate_error(err, path=path)
3323
repo_path = response[0]
3324
bzrdir_name = response[6]
3325
require_stacking = response[7]
3326
require_stacking = self.parse_NoneTrueFalse(require_stacking)
3327
format = RemoteBzrDirFormat()
3328
format._network_name = bzrdir_name
3329
self._supply_sub_formats_to(format)
3330
bzrdir = remote.RemoteBzrDir(transport, format, _client=client)
3332
repo_format = remote.response_tuple_to_repo_format(response[1:])
3333
if repo_path == '.':
3336
repo_bzrdir_format = RemoteBzrDirFormat()
3337
repo_bzrdir_format._network_name = response[5]
3338
repo_bzr = remote.RemoteBzrDir(transport.clone(repo_path),
3342
final_stack = response[8] or None
3343
final_stack_pwd = response[9] or None
3345
final_stack_pwd = urlutils.join(
3346
transport.base, final_stack_pwd)
3347
remote_repo = remote.RemoteRepository(repo_bzr, repo_format)
3348
if len(response) > 10:
3349
# Updated server verb that locks remotely.
3350
repo_lock_token = response[10] or None
3351
remote_repo.lock_write(repo_lock_token, _skip_rpc=True)
3353
remote_repo.dont_leave_lock_in_place()
3355
remote_repo.lock_write()
3356
policy = UseExistingRepository(remote_repo, final_stack,
3357
final_stack_pwd, require_stacking)
3358
policy.acquire_repository()
3362
bzrdir._format.set_branch_format(self.get_branch_format())
3363
if require_stacking:
3364
# The repo has already been created, but we need to make sure that
3365
# we'll make a stackable branch.
3366
bzrdir._format.require_stacking(_skip_repo=True)
3367
return remote_repo, bzrdir, require_stacking, policy
3369
def _open(self, transport):
3370
return remote.RemoteBzrDir(transport, self)
3372
def __eq__(self, other):
3373
if not isinstance(other, RemoteBzrDirFormat):
3375
return self.get_format_description() == other.get_format_description()
3377
def __return_repository_format(self):
3378
# Always return a RemoteRepositoryFormat object, but if a specific bzr
3379
# repository format has been asked for, tell the RemoteRepositoryFormat
3380
# that it should use that for init() etc.
3381
result = remote.RemoteRepositoryFormat()
3382
custom_format = getattr(self, '_repository_format', None)
3384
if isinstance(custom_format, remote.RemoteRepositoryFormat):
3385
return custom_format
3387
# We will use the custom format to create repositories over the
3388
# wire; expose its details like rich_root_data for code to
3390
result._custom_format = custom_format
3393
def get_branch_format(self):
3394
result = BzrDirMetaFormat1.get_branch_format(self)
3395
if not isinstance(result, remote.RemoteBranchFormat):
3396
new_result = remote.RemoteBranchFormat()
3397
new_result._custom_format = result
3399
self.set_branch_format(new_result)
3403
repository_format = property(__return_repository_format,
3404
BzrDirMetaFormat1._set_repository_format) #.im_func)
3407
BzrDirFormat.register_control_server_format(RemoteBzrDirFormat)
3410
class BzrDirFormatInfo(object):
3412
def __init__(self, native, deprecated, hidden, experimental):
3413
self.deprecated = deprecated
3414
self.native = native
3415
self.hidden = hidden
3416
self.experimental = experimental
3419
class BzrDirFormatRegistry(registry.Registry):
3420
"""Registry of user-selectable BzrDir subformats.
3422
Differs from BzrDirFormat._control_formats in that it provides sub-formats,
3423
e.g. BzrDirMeta1 with weave repository. Also, it's more user-oriented.
3427
"""Create a BzrDirFormatRegistry."""
3428
self._aliases = set()
3429
self._registration_order = list()
3430
super(BzrDirFormatRegistry, self).__init__()
3433
"""Return a set of the format names which are aliases."""
3434
return frozenset(self._aliases)
3436
def register_metadir(self, key,
3437
repository_format, help, native=True, deprecated=False,
3443
"""Register a metadir subformat.
3445
These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
3446
by the Repository/Branch/WorkingTreeformats.
3448
:param repository_format: The fully-qualified repository format class
3450
:param branch_format: Fully-qualified branch format class name as
3452
:param tree_format: Fully-qualified tree format class name as
3455
# This should be expanded to support setting WorkingTree and Branch
3456
# formats, once BzrDirMetaFormat1 supports that.
3457
def _load(full_name):
3458
mod_name, factory_name = full_name.rsplit('.', 1)
3460
mod = __import__(mod_name, globals(), locals(),
3462
except ImportError, e:
3463
raise ImportError('failed to load %s: %s' % (full_name, e))
3465
factory = getattr(mod, factory_name)
3466
except AttributeError:
3467
raise AttributeError('no factory %s in module %r'
3472
bd = BzrDirMetaFormat1()
3473
if branch_format is not None:
3474
bd.set_branch_format(_load(branch_format))
3475
if tree_format is not None:
3476
bd.workingtree_format = _load(tree_format)
3477
if repository_format is not None:
3478
bd.repository_format = _load(repository_format)
3480
self.register(key, helper, help, native, deprecated, hidden,
3481
experimental, alias)
3483
def register(self, key, factory, help, native=True, deprecated=False,
3484
hidden=False, experimental=False, alias=False):
3485
"""Register a BzrDirFormat factory.
3487
The factory must be a callable that takes one parameter: the key.
3488
It must produce an instance of the BzrDirFormat when called.
3490
This function mainly exists to prevent the info object from being
3493
registry.Registry.register(self, key, factory, help,
3494
BzrDirFormatInfo(native, deprecated, hidden, experimental))
3496
self._aliases.add(key)
3497
self._registration_order.append(key)
3499
def register_lazy(self, key, module_name, member_name, help, native=True,
3500
deprecated=False, hidden=False, experimental=False, alias=False):
3501
registry.Registry.register_lazy(self, key, module_name, member_name,
3502
help, BzrDirFormatInfo(native, deprecated, hidden, experimental))
3504
self._aliases.add(key)
3505
self._registration_order.append(key)
3507
def set_default(self, key):
3508
"""Set the 'default' key to be a clone of the supplied key.
3510
This method must be called once and only once.
3512
registry.Registry.register(self, 'default', self.get(key),
3513
self.get_help(key), info=self.get_info(key))
3514
self._aliases.add('default')
3516
def set_default_repository(self, key):
3517
"""Set the FormatRegistry default and Repository default.
3519
This is a transitional method while Repository.set_default_format
3522
if 'default' in self:
3523
self.remove('default')
3524
self.set_default(key)
3525
format = self.get('default')()
3527
def make_bzrdir(self, key):
3528
return self.get(key)()
3530
def help_topic(self, topic):
3532
default_realkey = None
3533
default_help = self.get_help('default')
3535
for key in self._registration_order:
3536
if key == 'default':
3538
help = self.get_help(key)
3539
if help == default_help:
3540
default_realkey = key
3542
help_pairs.append((key, help))
3544
def wrapped(key, help, info):
3546
help = '(native) ' + help
3547
return ':%s:\n%s\n\n' % (key,
3548
textwrap.fill(help, initial_indent=' ',
3549
subsequent_indent=' ',
3550
break_long_words=False))
3551
if default_realkey is not None:
3552
output += wrapped(default_realkey, '(default) %s' % default_help,
3553
self.get_info('default'))
3554
deprecated_pairs = []
3555
experimental_pairs = []
3556
for key, help in help_pairs:
3557
info = self.get_info(key)
3560
elif info.deprecated:
3561
deprecated_pairs.append((key, help))
3562
elif info.experimental:
3563
experimental_pairs.append((key, help))
3565
output += wrapped(key, help, info)
3566
output += "\nSee :doc:`formats-help` for more about storage formats."
3568
if len(experimental_pairs) > 0:
3569
other_output += "Experimental formats are shown below.\n\n"
3570
for key, help in experimental_pairs:
3571
info = self.get_info(key)
3572
other_output += wrapped(key, help, info)
3575
"No experimental formats are available.\n\n"
3576
if len(deprecated_pairs) > 0:
3577
other_output += "\nDeprecated formats are shown below.\n\n"
3578
for key, help in deprecated_pairs:
3579
info = self.get_info(key)
3580
other_output += wrapped(key, help, info)
3583
"\nNo deprecated formats are available.\n\n"
3585
"\nSee :doc:`formats-help` for more about storage formats."
3587
if topic == 'other-formats':
3593
class RepositoryAcquisitionPolicy(object):
3594
"""Abstract base class for repository acquisition policies.
3596
A repository acquisition policy decides how a BzrDir acquires a repository
3597
for a branch that is being created. The most basic policy decision is
3598
whether to create a new repository or use an existing one.
3600
def __init__(self, stack_on, stack_on_pwd, require_stacking):
3603
:param stack_on: A location to stack on
3604
:param stack_on_pwd: If stack_on is relative, the location it is
3606
:param require_stacking: If True, it is a failure to not stack.
3608
self._stack_on = stack_on
3609
self._stack_on_pwd = stack_on_pwd
3610
self._require_stacking = require_stacking
3612
def configure_branch(self, branch):
3613
"""Apply any configuration data from this policy to the branch.
3615
Default implementation sets repository stacking.
3617
if self._stack_on is None:
3619
if self._stack_on_pwd is None:
3620
stack_on = self._stack_on
3623
stack_on = urlutils.rebase_url(self._stack_on,
3625
branch.bzrdir.root_transport.base)
3626
except errors.InvalidRebaseURLs:
3627
stack_on = self._get_full_stack_on()
3629
branch.set_stacked_on_url(stack_on)
3630
except (errors.UnstackableBranchFormat,
3631
errors.UnstackableRepositoryFormat):
3632
if self._require_stacking:
3635
def requires_stacking(self):
3636
"""Return True if this policy requires stacking."""
3637
return self._stack_on is not None and self._require_stacking
3639
def _get_full_stack_on(self):
3640
"""Get a fully-qualified URL for the stack_on location."""
3641
if self._stack_on is None:
3643
if self._stack_on_pwd is None:
3644
return self._stack_on
3646
return urlutils.join(self._stack_on_pwd, self._stack_on)
3648
def _add_fallback(self, repository, possible_transports=None):
3649
"""Add a fallback to the supplied repository, if stacking is set."""
3650
stack_on = self._get_full_stack_on()
3651
if stack_on is None:
3654
stacked_dir = BzrDir.open(stack_on,
3655
possible_transports=possible_transports)
3656
except errors.JailBreak:
3657
# We keep the stacking details, but we are in the server code so
3658
# actually stacking is not needed.
3661
stacked_repo = stacked_dir.open_branch().repository
3662
except errors.NotBranchError:
3663
stacked_repo = stacked_dir.open_repository()
3665
repository.add_fallback_repository(stacked_repo)
3666
except errors.UnstackableRepositoryFormat:
3667
if self._require_stacking:
3670
self._require_stacking = True
3672
def acquire_repository(self, make_working_trees=None, shared=False):
3673
"""Acquire a repository for this bzrdir.
3675
Implementations may create a new repository or use a pre-exising
3677
:param make_working_trees: If creating a repository, set
3678
make_working_trees to this value (if non-None)
3679
:param shared: If creating a repository, make it shared if True
3680
:return: A repository, is_new_flag (True if the repository was
3683
raise NotImplemented(RepositoryAcquisitionPolicy.acquire_repository)
3686
class CreateRepository(RepositoryAcquisitionPolicy):
3687
"""A policy of creating a new repository"""
3689
def __init__(self, bzrdir, stack_on=None, stack_on_pwd=None,
3690
require_stacking=False):
3693
:param bzrdir: The bzrdir to create the repository on.
3694
:param stack_on: A location to stack on
3695
:param stack_on_pwd: If stack_on is relative, the location it is
3698
RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
3700
self._bzrdir = bzrdir
3702
def acquire_repository(self, make_working_trees=None, shared=False):
3703
"""Implementation of RepositoryAcquisitionPolicy.acquire_repository
3705
Creates the desired repository in the bzrdir we already have.
3707
stack_on = self._get_full_stack_on()
3709
format = self._bzrdir._format
3710
format.require_stacking(stack_on=stack_on,
3711
possible_transports=[self._bzrdir.root_transport])
3712
if not self._require_stacking:
3713
# We have picked up automatic stacking somewhere.
3714
note('Using default stacking branch %s at %s', self._stack_on,
3716
repository = self._bzrdir.create_repository(shared=shared)
3717
self._add_fallback(repository,
3718
possible_transports=[self._bzrdir.transport])
3719
if make_working_trees is not None:
3720
repository.set_make_working_trees(make_working_trees)
3721
return repository, True
3724
class UseExistingRepository(RepositoryAcquisitionPolicy):
3725
"""A policy of reusing an existing repository"""
3727
def __init__(self, repository, stack_on=None, stack_on_pwd=None,
3728
require_stacking=False):
3731
:param repository: The repository to use.
3732
:param stack_on: A location to stack on
3733
:param stack_on_pwd: If stack_on is relative, the location it is
3736
RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
3738
self._repository = repository
3740
def acquire_repository(self, make_working_trees=None, shared=False):
3741
"""Implementation of RepositoryAcquisitionPolicy.acquire_repository
3743
Returns an existing repository to use.
3745
self._add_fallback(self._repository,
3746
possible_transports=[self._repository.bzrdir.transport])
3747
return self._repository, False
3750
# Please register new formats after old formats so that formats
3751
# appear in chronological order and format descriptions can build
3753
format_registry = BzrDirFormatRegistry()
3754
# The pre-0.8 formats have their repository format network name registered in
3755
# repository.py. MetaDir formats have their repository format network name
3756
# inferred from their disk format string.
3757
format_registry.register('weave', BzrDirFormat6,
3758
'Pre-0.8 format. Slower than knit and does not'
3759
' support checkouts or shared repositories.',
3762
format_registry.register_metadir('metaweave',
3763
'bzrlib.repofmt.weaverepo.RepositoryFormat7',
3764
'Transitional format in 0.8. Slower than knit.',
3765
branch_format='bzrlib.branch.BzrBranchFormat5',
3766
tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3769
format_registry.register_metadir('knit',
3770
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3771
'Format using knits. Recommended for interoperation with bzr <= 0.14.',
3772
branch_format='bzrlib.branch.BzrBranchFormat5',
3773
tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3776
format_registry.register_metadir('dirstate',
3777
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3778
help='New in 0.15: Fast local operations. Compatible with bzr 0.8 and '
3779
'above when accessed over the network.',
3780
branch_format='bzrlib.branch.BzrBranchFormat5',
3781
# this uses bzrlib.workingtree.WorkingTreeFormat4 because importing
3782
# directly from workingtree_4 triggers a circular import.
3783
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3786
format_registry.register_metadir('dirstate-tags',
3787
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3788
help='New in 0.15: Fast local operations and improved scaling for '
3789
'network operations. Additionally adds support for tags.'
3790
' Incompatible with bzr < 0.15.',
3791
branch_format='bzrlib.branch.BzrBranchFormat6',
3792
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3795
format_registry.register_metadir('rich-root',
3796
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
3797
help='New in 1.0. Better handling of tree roots. Incompatible with'
3799
branch_format='bzrlib.branch.BzrBranchFormat6',
3800
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3803
format_registry.register_metadir('dirstate-with-subtree',
3804
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
3805
help='New in 0.15: Fast local operations and improved scaling for '
3806
'network operations. Additionally adds support for versioning nested '
3807
'bzr branches. Incompatible with bzr < 0.15.',
3808
branch_format='bzrlib.branch.BzrBranchFormat6',
3809
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3813
format_registry.register_metadir('pack-0.92',
3814
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack1',
3815
help='New in 0.92: Pack-based format with data compatible with '
3816
'dirstate-tags format repositories. Interoperates with '
3817
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3819
branch_format='bzrlib.branch.BzrBranchFormat6',
3820
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3822
format_registry.register_metadir('pack-0.92-subtree',
3823
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack3',
3824
help='New in 0.92: Pack-based format with data compatible with '
3825
'dirstate-with-subtree format repositories. Interoperates with '
3826
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3828
branch_format='bzrlib.branch.BzrBranchFormat6',
3829
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3833
format_registry.register_metadir('rich-root-pack',
3834
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
3835
help='New in 1.0: A variant of pack-0.92 that supports rich-root data '
3836
'(needed for bzr-svn and bzr-git).',
3837
branch_format='bzrlib.branch.BzrBranchFormat6',
3838
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3841
format_registry.register_metadir('1.6',
3842
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5',
3843
help='A format that allows a branch to indicate that there is another '
3844
'(stacked) repository that should be used to access data that is '
3845
'not present locally.',
3846
branch_format='bzrlib.branch.BzrBranchFormat7',
3847
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3850
format_registry.register_metadir('1.6.1-rich-root',
3851
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5RichRoot',
3852
help='A variant of 1.6 that supports rich-root data '
3853
'(needed for bzr-svn and bzr-git).',
3854
branch_format='bzrlib.branch.BzrBranchFormat7',
3855
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3858
format_registry.register_metadir('1.9',
3859
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3860
help='A repository format using B+tree indexes. These indexes '
3861
'are smaller in size, have smarter caching and provide faster '
3862
'performance for most operations.',
3863
branch_format='bzrlib.branch.BzrBranchFormat7',
3864
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3867
format_registry.register_metadir('1.9-rich-root',
3868
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
3869
help='A variant of 1.9 that supports rich-root data '
3870
'(needed for bzr-svn and bzr-git).',
3871
branch_format='bzrlib.branch.BzrBranchFormat7',
3872
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3875
format_registry.register_metadir('1.14',
3876
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3877
help='A working-tree format that supports content filtering.',
3878
branch_format='bzrlib.branch.BzrBranchFormat7',
3879
tree_format='bzrlib.workingtree.WorkingTreeFormat5',
3881
format_registry.register_metadir('1.14-rich-root',
3882
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
3883
help='A variant of 1.14 that supports rich-root data '
3884
'(needed for bzr-svn and bzr-git).',
3885
branch_format='bzrlib.branch.BzrBranchFormat7',
3886
tree_format='bzrlib.workingtree.WorkingTreeFormat5',
3888
# The following un-numbered 'development' formats should always just be aliases.
3889
format_registry.register_metadir('development-rich-root',
3890
'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
3891
help='Current development format. Supports rich roots. Can convert data '
3892
'to and from rich-root-pack (and anything compatible with '
3893
'rich-root-pack) format repositories. Repositories and branches in '
3894
'this format can only be read by bzr.dev. Please read '
3895
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
3897
branch_format='bzrlib.branch.BzrBranchFormat7',
3898
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3903
format_registry.register_metadir('development-subtree',
3904
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment2Subtree',
3905
help='Current development format, subtree variant. Can convert data to and '
3906
'from pack-0.92-subtree (and anything compatible with '
3907
'pack-0.92-subtree) format repositories. Repositories and branches in '
3908
'this format can only be read by bzr.dev. Please read '
3909
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
3911
branch_format='bzrlib.branch.BzrBranchFormat7',
3912
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3915
alias=False, # Restore to being an alias when an actual development subtree format is added
3916
# This current non-alias status is simply because we did not introduce a
3917
# chk based subtree format.
3920
# And the development formats above will have aliased one of the following:
3921
format_registry.register_metadir('development6-rich-root',
3922
'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
3923
help='pack-1.9 with 255-way hashed CHK inv, group compress, rich roots '
3925
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
3927
branch_format='bzrlib.branch.BzrBranchFormat7',
3928
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3933
format_registry.register_metadir('development7-rich-root',
3934
'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK2',
3935
help='pack-1.9 with 255-way hashed CHK inv, bencode revision, group compress, '
3936
'rich roots. Please read '
3937
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
3939
branch_format='bzrlib.branch.BzrBranchFormat7',
3940
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3945
format_registry.register_metadir('2a',
3946
'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
3947
help='First format for bzr 2.0 series.\n'
3948
'Uses group-compress storage.\n'
3949
'Provides rich roots which are a one-way transition.\n',
3950
# 'storage in packs, 255-way hashed CHK inventory, bencode revision, group compress, '
3951
# 'rich roots. Supported by bzr 1.16 and later.',
3952
branch_format='bzrlib.branch.BzrBranchFormat7',
3953
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3957
# The following format should be an alias for the rich root equivalent
3958
# of the default format
3959
format_registry.register_metadir('default-rich-root',
3960
'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
3961
branch_format='bzrlib.branch.BzrBranchFormat7',
3962
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3967
# The current format that is made on 'bzr init'.
3968
format_registry.set_default('2a')
added
removed
bzrlib/bzrdir.py
