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, name=None):
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
return self._format.get_branch_format().initialize(self, name=name)
1388
def destroy_branch(self, name=None):
1389
"""See BzrDir.destroy_branch."""
1390
raise errors.UnsupportedOperation(self.destroy_branch, self)
1392
def create_repository(self, shared=False):
1393
"""See BzrDir.create_repository."""
1395
raise errors.IncompatibleFormat('shared repository', self._format)
1396
return self.open_repository()
1398
def destroy_repository(self):
1399
"""See BzrDir.destroy_repository."""
1400
raise errors.UnsupportedOperation(self.destroy_repository, self)
1402
def create_workingtree(self, revision_id=None, from_branch=None,
1403
accelerator_tree=None, hardlink=False):
1404
"""See BzrDir.create_workingtree."""
1405
# The workingtree is sometimes created when the bzrdir is created,
1406
# but not when cloning.
1408
# this looks buggy but is not -really-
1409
# because this format creates the workingtree when the bzrdir is
1411
# clone and sprout will have set the revision_id
1412
# and that will have set it for us, its only
1413
# specific uses of create_workingtree in isolation
1414
# that can do wonky stuff here, and that only
1415
# happens for creating checkouts, which cannot be
1416
# done on this format anyway. So - acceptable wart.
1418
warning("can't support hardlinked working trees in %r"
1421
result = self.open_workingtree(recommend_upgrade=False)
1422
except errors.NoSuchFile:
1423
result = self._init_workingtree()
1424
if revision_id is not None:
1425
if revision_id == _mod_revision.NULL_REVISION:
1426
result.set_parent_ids([])
1428
result.set_parent_ids([revision_id])
1431
def _init_workingtree(self):
1432
from bzrlib.workingtree import WorkingTreeFormat2
1434
return WorkingTreeFormat2().initialize(self)
1435
except errors.NotLocalUrl:
1436
# Even though we can't access the working tree, we need to
1437
# create its control files.
1438
return WorkingTreeFormat2()._stub_initialize_on_transport(
1439
self.transport, self._control_files._file_mode)
1441
def destroy_workingtree(self):
1442
"""See BzrDir.destroy_workingtree."""
1443
raise errors.UnsupportedOperation(self.destroy_workingtree, self)
1445
def destroy_workingtree_metadata(self):
1446
"""See BzrDir.destroy_workingtree_metadata."""
1447
raise errors.UnsupportedOperation(self.destroy_workingtree_metadata,
1450
def get_branch_transport(self, branch_format, name=None):
1451
"""See BzrDir.get_branch_transport()."""
1452
if name is not None:
1453
raise errors.NoColocatedBranchSupport(self)
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
from bzrlib.branch import BzrBranchFormat4
1496
format = BzrBranchFormat4()
1497
self._check_supported(format, unsupported)
1498
return format.open(self, name, _found=True)
1500
def sprout(self, url, revision_id=None, force_new_repo=False,
1501
possible_transports=None, accelerator_tree=None,
1502
hardlink=False, stacked=False, create_tree_if_local=True,
1503
source_branch=None):
1504
"""See BzrDir.sprout()."""
1505
if source_branch is not None:
1506
my_branch = self.open_branch()
1507
if source_branch.base != my_branch.base:
1508
raise AssertionError(
1509
"source branch %r is not within %r with branch %r" %
1510
(source_branch, self, my_branch))
1512
raise errors.UnstackableBranchFormat(
1513
self._format, self.root_transport.base)
1514
if not create_tree_if_local:
1515
raise errors.MustHaveWorkingTree(
1516
self._format, self.root_transport.base)
1517
from bzrlib.workingtree import WorkingTreeFormat2
1518
self._make_tail(url)
1519
result = self._format._initialize_for_clone(url)
1521
self.open_repository().clone(result, revision_id=revision_id)
1522
except errors.NoRepositoryPresent:
1525
self.open_branch().sprout(result, revision_id=revision_id)
1526
except errors.NotBranchError:
1529
# we always want a working tree
1530
WorkingTreeFormat2().initialize(result,
1531
accelerator_tree=accelerator_tree,
1536
class BzrDir4(BzrDirPreSplitOut):
1537
"""A .bzr version 4 control object.
1539
This is a deprecated format and may be removed after sept 2006.
1542
def create_repository(self, shared=False):
1543
"""See BzrDir.create_repository."""
1544
return self._format.repository_format.initialize(self, shared)
1546
def needs_format_conversion(self, format=None):
1547
"""Format 4 dirs are always in need of conversion."""
1549
symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1550
% 'needs_format_conversion(format=None)')
1553
def open_repository(self):
1554
"""See BzrDir.open_repository."""
1555
from bzrlib.repofmt.weaverepo import RepositoryFormat4
1556
return RepositoryFormat4().open(self, _found=True)
1559
class BzrDir5(BzrDirPreSplitOut):
1560
"""A .bzr version 5 control object.
1562
This is a deprecated format and may be removed after sept 2006.
1565
def has_workingtree(self):
1566
"""See BzrDir.has_workingtree."""
1569
def open_repository(self):
1570
"""See BzrDir.open_repository."""
1571
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1572
return RepositoryFormat5().open(self, _found=True)
1574
def open_workingtree(self, _unsupported=False,
1575
recommend_upgrade=True):
1576
"""See BzrDir.create_workingtree."""
1577
from bzrlib.workingtree import WorkingTreeFormat2
1578
wt_format = WorkingTreeFormat2()
1579
# we don't warn here about upgrades; that ought to be handled for the
1581
return wt_format.open(self, _found=True)
1584
class BzrDir6(BzrDirPreSplitOut):
1585
"""A .bzr version 6 control object.
1587
This is a deprecated format and may be removed after sept 2006.
1590
def has_workingtree(self):
1591
"""See BzrDir.has_workingtree."""
1594
def open_repository(self):
1595
"""See BzrDir.open_repository."""
1596
from bzrlib.repofmt.weaverepo import RepositoryFormat6
1597
return RepositoryFormat6().open(self, _found=True)
1599
def open_workingtree(self, _unsupported=False,
1600
recommend_upgrade=True):
1601
"""See BzrDir.create_workingtree."""
1602
# we don't warn here about upgrades; that ought to be handled for the
1604
from bzrlib.workingtree import WorkingTreeFormat2
1605
return WorkingTreeFormat2().open(self, _found=True)
1608
class BzrDirMeta1(BzrDir):
1609
"""A .bzr meta version 1 control object.
1611
This is the first control object where the
1612
individual aspects are really split out: there are separate repository,
1613
workingtree and branch subdirectories and any subset of the three can be
1614
present within a BzrDir.
1617
def can_convert_format(self):
1618
"""See BzrDir.can_convert_format()."""
1621
def create_branch(self, name=None):
1622
"""See BzrDir.create_branch."""
1623
return self._format.get_branch_format().initialize(self, name=name)
1625
def destroy_branch(self, name=None):
1626
"""See BzrDir.create_branch."""
1627
if name is not None:
1628
raise errors.NoColocatedBranchSupport(self)
1629
self.transport.delete_tree('branch')
1631
def create_repository(self, shared=False):
1632
"""See BzrDir.create_repository."""
1633
return self._format.repository_format.initialize(self, shared)
1635
def destroy_repository(self):
1636
"""See BzrDir.destroy_repository."""
1637
self.transport.delete_tree('repository')
1639
def create_workingtree(self, revision_id=None, from_branch=None,
1640
accelerator_tree=None, hardlink=False):
1641
"""See BzrDir.create_workingtree."""
1642
return self._format.workingtree_format.initialize(
1643
self, revision_id, from_branch=from_branch,
1644
accelerator_tree=accelerator_tree, hardlink=hardlink)
1646
def destroy_workingtree(self):
1647
"""See BzrDir.destroy_workingtree."""
1648
wt = self.open_workingtree(recommend_upgrade=False)
1649
repository = wt.branch.repository
1650
empty = repository.revision_tree(_mod_revision.NULL_REVISION)
1651
wt.revert(old_tree=empty)
1652
self.destroy_workingtree_metadata()
1654
def destroy_workingtree_metadata(self):
1655
self.transport.delete_tree('checkout')
1657
def find_branch_format(self):
1658
"""Find the branch 'format' for this bzrdir.
1660
This might be a synthetic object for e.g. RemoteBranch and SVN.
1662
from bzrlib.branch import BranchFormat
1663
return BranchFormat.find_format(self)
1665
def _get_mkdir_mode(self):
1666
"""Figure out the mode to use when creating a bzrdir subdir."""
1667
temp_control = lockable_files.LockableFiles(self.transport, '',
1668
lockable_files.TransportLock)
1669
return temp_control._dir_mode
1671
def get_branch_reference(self):
1672
"""See BzrDir.get_branch_reference()."""
1673
from bzrlib.branch import BranchFormat
1674
format = BranchFormat.find_format(self)
1675
return format.get_reference(self)
1677
def get_branch_transport(self, branch_format, name=None):
1678
"""See BzrDir.get_branch_transport()."""
1679
if name is not None:
1680
raise errors.NoColocatedBranchSupport(self)
1681
# XXX: this shouldn't implicitly create the directory if it's just
1682
# promising to get a transport -- mbp 20090727
1683
if branch_format is None:
1684
return self.transport.clone('branch')
1686
branch_format.get_format_string()
1687
except NotImplementedError:
1688
raise errors.IncompatibleFormat(branch_format, self._format)
1690
self.transport.mkdir('branch', mode=self._get_mkdir_mode())
1691
except errors.FileExists:
1693
return self.transport.clone('branch')
1695
def get_repository_transport(self, repository_format):
1696
"""See BzrDir.get_repository_transport()."""
1697
if repository_format is None:
1698
return self.transport.clone('repository')
1700
repository_format.get_format_string()
1701
except NotImplementedError:
1702
raise errors.IncompatibleFormat(repository_format, self._format)
1704
self.transport.mkdir('repository', mode=self._get_mkdir_mode())
1705
except errors.FileExists:
1707
return self.transport.clone('repository')
1709
def get_workingtree_transport(self, workingtree_format):
1710
"""See BzrDir.get_workingtree_transport()."""
1711
if workingtree_format is None:
1712
return self.transport.clone('checkout')
1714
workingtree_format.get_format_string()
1715
except NotImplementedError:
1716
raise errors.IncompatibleFormat(workingtree_format, self._format)
1718
self.transport.mkdir('checkout', mode=self._get_mkdir_mode())
1719
except errors.FileExists:
1721
return self.transport.clone('checkout')
1723
def has_workingtree(self):
1724
"""Tell if this bzrdir contains a working tree.
1726
This will still raise an exception if the bzrdir has a workingtree that
1727
is remote & inaccessible.
1729
Note: if you're going to open the working tree, you should just go
1730
ahead and try, and not ask permission first.
1732
from bzrlib.workingtree import WorkingTreeFormat
1734
WorkingTreeFormat.find_format(self)
1735
except errors.NoWorkingTree:
1739
def needs_format_conversion(self, format=None):
1740
"""See BzrDir.needs_format_conversion()."""
1742
symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1743
% 'needs_format_conversion(format=None)')
1745
format = BzrDirFormat.get_default_format()
1746
if not isinstance(self._format, format.__class__):
1747
# it is not a meta dir format, conversion is needed.
1749
# we might want to push this down to the repository?
1751
if not isinstance(self.open_repository()._format,
1752
format.repository_format.__class__):
1753
# the repository needs an upgrade.
1755
except errors.NoRepositoryPresent:
1757
for branch in self.list_branches():
1758
if not isinstance(branch._format,
1759
format.get_branch_format().__class__):
1760
# the branch needs an upgrade.
1763
my_wt = self.open_workingtree(recommend_upgrade=False)
1764
if not isinstance(my_wt._format,
1765
format.workingtree_format.__class__):
1766
# the workingtree needs an upgrade.
1768
except (errors.NoWorkingTree, errors.NotLocalUrl):
1772
def open_branch(self, name=None, unsupported=False,
1773
ignore_fallbacks=False):
1774
"""See BzrDir.open_branch."""
1775
format = self.find_branch_format()
1776
self._check_supported(format, unsupported)
1777
return format.open(self, name=name,
1778
_found=True, ignore_fallbacks=ignore_fallbacks)
1780
def open_repository(self, unsupported=False):
1781
"""See BzrDir.open_repository."""
1782
from bzrlib.repository import RepositoryFormat
1783
format = RepositoryFormat.find_format(self)
1784
self._check_supported(format, unsupported)
1785
return format.open(self, _found=True)
1787
def open_workingtree(self, unsupported=False,
1788
recommend_upgrade=True):
1789
"""See BzrDir.open_workingtree."""
1790
from bzrlib.workingtree import WorkingTreeFormat
1791
format = WorkingTreeFormat.find_format(self)
1792
self._check_supported(format, unsupported,
1794
basedir=self.root_transport.base)
1795
return format.open(self, _found=True)
1797
def _get_config(self):
1798
return config.TransportConfig(self.transport, 'control.conf')
1801
class BzrDirFormat(object):
1802
"""An encapsulation of the initialization and open routines for a format.
1804
Formats provide three things:
1805
* An initialization routine,
1809
Formats are placed in a dict by their format string for reference
1810
during bzrdir opening. These should be subclasses of BzrDirFormat
1813
Once a format is deprecated, just deprecate the initialize and open
1814
methods on the format class. Do not deprecate the object, as the
1815
object will be created every system load.
1817
:cvar colocated_branches: Whether this formats supports colocated branches.
1820
_default_format = None
1821
"""The default format used for new .bzr dirs."""
1824
"""The known formats."""
1826
_control_formats = []
1827
"""The registered control formats - .bzr, ....
1829
This is a list of BzrDirFormat objects.
1832
_control_server_formats = []
1833
"""The registered control server formats, e.g. RemoteBzrDirs.
1835
This is a list of BzrDirFormat objects.
1838
_lock_file_name = 'branch-lock'
1840
colocated_branches = False
1841
"""Whether co-located branches are supported for this control dir format.
1844
# _lock_class must be set in subclasses to the lock type, typ.
1845
# TransportLock or LockDir
1848
def find_format(klass, transport, _server_formats=True):
1849
"""Return the format present at transport."""
1851
formats = klass._control_server_formats + klass._control_formats
1853
formats = klass._control_formats
1854
for format in formats:
1856
return format.probe_transport(transport)
1857
except errors.NotBranchError:
1858
# this format does not find a control dir here.
1860
raise errors.NotBranchError(path=transport.base)
1863
def probe_transport(klass, transport):
1864
"""Return the .bzrdir style format present in a directory."""
1866
format_string = transport.get_bytes(".bzr/branch-format")
1867
except errors.NoSuchFile:
1868
raise errors.NotBranchError(path=transport.base)
1871
return klass._formats[format_string]
1873
raise errors.UnknownFormatError(format=format_string, kind='bzrdir')
1876
def get_default_format(klass):
1877
"""Return the current default format."""
1878
return klass._default_format
1880
def get_format_string(self):
1881
"""Return the ASCII format string that identifies this format."""
1882
raise NotImplementedError(self.get_format_string)
1884
def get_format_description(self):
1885
"""Return the short description for this format."""
1886
raise NotImplementedError(self.get_format_description)
1888
def get_converter(self, format=None):
1889
"""Return the converter to use to convert bzrdirs needing converts.
1891
This returns a bzrlib.bzrdir.Converter object.
1893
This should return the best upgrader to step this format towards the
1894
current default format. In the case of plugins we can/should provide
1895
some means for them to extend the range of returnable converters.
1897
:param format: Optional format to override the default format of the
1900
raise NotImplementedError(self.get_converter)
1902
def initialize(self, url, possible_transports=None):
1903
"""Create a bzr control dir at this url and return an opened copy.
1905
While not deprecated, this method is very specific and its use will
1906
lead to many round trips to setup a working environment. See
1907
initialize_on_transport_ex for a [nearly] all-in-one method.
1909
Subclasses should typically override initialize_on_transport
1910
instead of this method.
1912
return self.initialize_on_transport(get_transport(url,
1913
possible_transports))
1915
def initialize_on_transport(self, transport):
1916
"""Initialize a new bzrdir in the base directory of a Transport."""
1918
# can we hand off the request to the smart server rather than using
1920
client_medium = transport.get_smart_medium()
1921
except errors.NoSmartMedium:
1922
return self._initialize_on_transport_vfs(transport)
1924
# Current RPC's only know how to create bzr metadir1 instances, so
1925
# we still delegate to vfs methods if the requested format is not a
1927
if type(self) != BzrDirMetaFormat1:
1928
return self._initialize_on_transport_vfs(transport)
1929
remote_format = RemoteBzrDirFormat()
1930
self._supply_sub_formats_to(remote_format)
1931
return remote_format.initialize_on_transport(transport)
1933
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
1934
create_prefix=False, force_new_repo=False, stacked_on=None,
1935
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
1936
shared_repo=False, vfs_only=False):
1937
"""Create this format on transport.
1939
The directory to initialize will be created.
1941
:param force_new_repo: Do not use a shared repository for the target,
1942
even if one is available.
1943
:param create_prefix: Create any missing directories leading up to
1945
:param use_existing_dir: Use an existing directory if one exists.
1946
:param stacked_on: A url to stack any created branch on, None to follow
1947
any target stacking policy.
1948
:param stack_on_pwd: If stack_on is relative, the location it is
1950
:param repo_format_name: If non-None, a repository will be
1951
made-or-found. Should none be found, or if force_new_repo is True
1952
the repo_format_name is used to select the format of repository to
1954
:param make_working_trees: Control the setting of make_working_trees
1955
for a new shared repository when one is made. None to use whatever
1956
default the format has.
1957
:param shared_repo: Control whether made repositories are shared or
1959
:param vfs_only: If True do not attempt to use a smart server
1960
:return: repo, bzrdir, require_stacking, repository_policy. repo is
1961
None if none was created or found, bzrdir is always valid.
1962
require_stacking is the result of examining the stacked_on
1963
parameter and any stacking policy found for the target.
1966
# Try to hand off to a smart server
1968
client_medium = transport.get_smart_medium()
1969
except errors.NoSmartMedium:
1972
# TODO: lookup the local format from a server hint.
1973
remote_dir_format = RemoteBzrDirFormat()
1974
remote_dir_format._network_name = self.network_name()
1975
self._supply_sub_formats_to(remote_dir_format)
1976
return remote_dir_format.initialize_on_transport_ex(transport,
1977
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
1978
force_new_repo=force_new_repo, stacked_on=stacked_on,
1979
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
1980
make_working_trees=make_working_trees, shared_repo=shared_repo)
1981
# XXX: Refactor the create_prefix/no_create_prefix code into a
1982
# common helper function
1983
# The destination may not exist - if so make it according to policy.
1984
def make_directory(transport):
1985
transport.mkdir('.')
1987
def redirected(transport, e, redirection_notice):
1988
note(redirection_notice)
1989
return transport._redirected_to(e.source, e.target)
1991
transport = do_catching_redirections(make_directory, transport,
1993
except errors.FileExists:
1994
if not use_existing_dir:
1996
except errors.NoSuchFile:
1997
if not create_prefix:
1999
transport.create_prefix()
2001
require_stacking = (stacked_on is not None)
2002
# Now the target directory exists, but doesn't have a .bzr
2003
# directory. So we need to create it, along with any work to create
2004
# all of the dependent branches, etc.
2006
result = self.initialize_on_transport(transport)
2007
if repo_format_name:
2009
# use a custom format
2010
result._format.repository_format = \
2011
repository.network_format_registry.get(repo_format_name)
2012
except AttributeError:
2013
# The format didn't permit it to be set.
2015
# A repository is desired, either in-place or shared.
2016
repository_policy = result.determine_repository_policy(
2017
force_new_repo, stacked_on, stack_on_pwd,
2018
require_stacking=require_stacking)
2019
result_repo, is_new_repo = repository_policy.acquire_repository(
2020
make_working_trees, shared_repo)
2021
if not require_stacking and repository_policy._require_stacking:
2022
require_stacking = True
2023
result._format.require_stacking()
2024
result_repo.lock_write()
2027
repository_policy = None
2028
return result_repo, result, require_stacking, repository_policy
2030
def _initialize_on_transport_vfs(self, transport):
2031
"""Initialize a new bzrdir using VFS calls.
2033
:param transport: The transport to create the .bzr directory in.
2036
# Since we are creating a .bzr directory, inherit the
2037
# mode from the root directory
2038
temp_control = lockable_files.LockableFiles(transport,
2039
'', lockable_files.TransportLock)
2040
temp_control._transport.mkdir('.bzr',
2041
# FIXME: RBC 20060121 don't peek under
2043
mode=temp_control._dir_mode)
2044
if sys.platform == 'win32' and isinstance(transport, local.LocalTransport):
2045
win32utils.set_file_attr_hidden(transport._abspath('.bzr'))
2046
file_mode = temp_control._file_mode
2048
bzrdir_transport = transport.clone('.bzr')
2049
utf8_files = [('README',
2050
"This is a Bazaar control directory.\n"
2051
"Do not change any files in this directory.\n"
2052
"See http://bazaar-vcs.org/ for more information about Bazaar.\n"),
2053
('branch-format', self.get_format_string()),
2055
# NB: no need to escape relative paths that are url safe.
2056
control_files = lockable_files.LockableFiles(bzrdir_transport,
2057
self._lock_file_name, self._lock_class)
2058
control_files.create_lock()
2059
control_files.lock_write()
2061
for (filename, content) in utf8_files:
2062
bzrdir_transport.put_bytes(filename, content,
2065
control_files.unlock()
2066
return self.open(transport, _found=True)
2068
def is_supported(self):
2069
"""Is this format supported?
2071
Supported formats must be initializable and openable.
2072
Unsupported formats may not support initialization or committing or
2073
some other features depending on the reason for not being supported.
2077
def network_name(self):
2078
"""A simple byte string uniquely identifying this format for RPC calls.
2080
Bzr control formats use thir disk format string to identify the format
2081
over the wire. Its possible that other control formats have more
2082
complex detection requirements, so we permit them to use any unique and
2083
immutable string they desire.
2085
raise NotImplementedError(self.network_name)
2087
def same_model(self, target_format):
2088
return (self.repository_format.rich_root_data ==
2089
target_format.rich_root_data)
2092
def known_formats(klass):
2093
"""Return all the known formats.
2095
Concrete formats should override _known_formats.
2097
# There is double indirection here to make sure that control
2098
# formats used by more than one dir format will only be probed
2099
# once. This can otherwise be quite expensive for remote connections.
2101
for format in klass._control_formats:
2102
result.update(format._known_formats())
2106
def _known_formats(klass):
2107
"""Return the known format instances for this control format."""
2108
return set(klass._formats.values())
2110
def open(self, transport, _found=False):
2111
"""Return an instance of this format for the dir transport points at.
2113
_found is a private parameter, do not use it.
2116
found_format = BzrDirFormat.find_format(transport)
2117
if not isinstance(found_format, self.__class__):
2118
raise AssertionError("%s was asked to open %s, but it seems to need "
2120
% (self, transport, found_format))
2121
# Allow subclasses - use the found format.
2122
self._supply_sub_formats_to(found_format)
2123
return found_format._open(transport)
2124
return self._open(transport)
2126
def _open(self, transport):
2127
"""Template method helper for opening BzrDirectories.
2129
This performs the actual open and any additional logic or parameter
2132
raise NotImplementedError(self._open)
2135
def register_format(klass, format):
2136
klass._formats[format.get_format_string()] = format
2137
# bzr native formats have a network name of their format string.
2138
network_format_registry.register(format.get_format_string(), format.__class__)
2141
def register_control_format(klass, format):
2142
"""Register a format that does not use '.bzr' for its control dir.
2144
TODO: This should be pulled up into a 'ControlDirFormat' base class
2145
which BzrDirFormat can inherit from, and renamed to register_format
2146
there. It has been done without that for now for simplicity of
2149
klass._control_formats.append(format)
2152
def register_control_server_format(klass, format):
2153
"""Register a control format for client-server environments.
2155
These formats will be tried before ones registered with
2156
register_control_format. This gives implementations that decide to the
2157
chance to grab it before anything looks at the contents of the format
2160
klass._control_server_formats.append(format)
2163
def _set_default_format(klass, format):
2164
"""Set default format (for testing behavior of defaults only)"""
2165
klass._default_format = format
2169
return self.get_format_description().rstrip()
2171
def _supply_sub_formats_to(self, other_format):
2172
"""Give other_format the same values for sub formats as this has.
2174
This method is expected to be used when parameterising a
2175
RemoteBzrDirFormat instance with the parameters from a
2176
BzrDirMetaFormat1 instance.
2178
:param other_format: other_format is a format which should be
2179
compatible with whatever sub formats are supported by self.
2184
def unregister_format(klass, format):
2185
del klass._formats[format.get_format_string()]
2188
def unregister_control_format(klass, format):
2189
klass._control_formats.remove(format)
2192
class BzrDirFormat4(BzrDirFormat):
2193
"""Bzr dir format 4.
2195
This format is a combined format for working tree, branch and repository.
2197
- Format 1 working trees [always]
2198
- Format 4 branches [always]
2199
- Format 4 repositories [always]
2201
This format is deprecated: it indexes texts using a text it which is
2202
removed in format 5; write support for this format has been removed.
2205
_lock_class = lockable_files.TransportLock
2207
def get_format_string(self):
2208
"""See BzrDirFormat.get_format_string()."""
2209
return "Bazaar-NG branch, format 0.0.4\n"
2211
def get_format_description(self):
2212
"""See BzrDirFormat.get_format_description()."""
2213
return "All-in-one format 4"
2215
def get_converter(self, format=None):
2216
"""See BzrDirFormat.get_converter()."""
2217
# there is one and only one upgrade path here.
2218
return ConvertBzrDir4To5()
2220
def initialize_on_transport(self, transport):
2221
"""Format 4 branches cannot be created."""
2222
raise errors.UninitializableFormat(self)
2224
def is_supported(self):
2225
"""Format 4 is not supported.
2227
It is not supported because the model changed from 4 to 5 and the
2228
conversion logic is expensive - so doing it on the fly was not
2233
def network_name(self):
2234
return self.get_format_string()
2236
def _open(self, transport):
2237
"""See BzrDirFormat._open."""
2238
return BzrDir4(transport, self)
2240
def __return_repository_format(self):
2241
"""Circular import protection."""
2242
from bzrlib.repofmt.weaverepo import RepositoryFormat4
2243
return RepositoryFormat4()
2244
repository_format = property(__return_repository_format)
2247
class BzrDirFormatAllInOne(BzrDirFormat):
2248
"""Common class for formats before meta-dirs."""
2250
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
2251
create_prefix=False, force_new_repo=False, stacked_on=None,
2252
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
2254
"""See BzrDirFormat.initialize_on_transport_ex."""
2255
require_stacking = (stacked_on is not None)
2256
# Format 5 cannot stack, but we've been asked to - actually init
2258
if require_stacking:
2259
format = BzrDirMetaFormat1()
2260
return format.initialize_on_transport_ex(transport,
2261
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2262
force_new_repo=force_new_repo, stacked_on=stacked_on,
2263
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2264
make_working_trees=make_working_trees, shared_repo=shared_repo)
2265
return BzrDirFormat.initialize_on_transport_ex(self, transport,
2266
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2267
force_new_repo=force_new_repo, stacked_on=stacked_on,
2268
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2269
make_working_trees=make_working_trees, shared_repo=shared_repo)
2272
class BzrDirFormat5(BzrDirFormatAllInOne):
2273
"""Bzr control format 5.
2275
This format is a combined format for working tree, branch and repository.
2277
- Format 2 working trees [always]
2278
- Format 4 branches [always]
2279
- Format 5 repositories [always]
2280
Unhashed stores in the repository.
2283
_lock_class = lockable_files.TransportLock
2285
def get_format_string(self):
2286
"""See BzrDirFormat.get_format_string()."""
2287
return "Bazaar-NG branch, format 5\n"
2289
def get_branch_format(self):
2290
from bzrlib import branch
2291
return branch.BzrBranchFormat4()
2293
def get_format_description(self):
2294
"""See BzrDirFormat.get_format_description()."""
2295
return "All-in-one format 5"
2297
def get_converter(self, format=None):
2298
"""See BzrDirFormat.get_converter()."""
2299
# there is one and only one upgrade path here.
2300
return ConvertBzrDir5To6()
2302
def _initialize_for_clone(self, url):
2303
return self.initialize_on_transport(get_transport(url), _cloning=True)
2305
def initialize_on_transport(self, transport, _cloning=False):
2306
"""Format 5 dirs always have working tree, branch and repository.
2308
Except when they are being cloned.
2310
from bzrlib.branch import BzrBranchFormat4
2311
from bzrlib.repofmt.weaverepo import RepositoryFormat5
2312
result = (super(BzrDirFormat5, self).initialize_on_transport(transport))
2313
RepositoryFormat5().initialize(result, _internal=True)
2315
branch = BzrBranchFormat4().initialize(result)
2316
result._init_workingtree()
2319
def network_name(self):
2320
return self.get_format_string()
2322
def _open(self, transport):
2323
"""See BzrDirFormat._open."""
2324
return BzrDir5(transport, self)
2326
def __return_repository_format(self):
2327
"""Circular import protection."""
2328
from bzrlib.repofmt.weaverepo import RepositoryFormat5
2329
return RepositoryFormat5()
2330
repository_format = property(__return_repository_format)
2333
class BzrDirFormat6(BzrDirFormatAllInOne):
2334
"""Bzr control format 6.
2336
This format is a combined format for working tree, branch and repository.
2338
- Format 2 working trees [always]
2339
- Format 4 branches [always]
2340
- Format 6 repositories [always]
2343
_lock_class = lockable_files.TransportLock
2345
def get_format_string(self):
2346
"""See BzrDirFormat.get_format_string()."""
2347
return "Bazaar-NG branch, format 6\n"
2349
def get_format_description(self):
2350
"""See BzrDirFormat.get_format_description()."""
2351
return "All-in-one format 6"
2353
def get_branch_format(self):
2354
from bzrlib import branch
2355
return branch.BzrBranchFormat4()
2357
def get_converter(self, format=None):
2358
"""See BzrDirFormat.get_converter()."""
2359
# there is one and only one upgrade path here.
2360
return ConvertBzrDir6ToMeta()
2362
def _initialize_for_clone(self, url):
2363
return self.initialize_on_transport(get_transport(url), _cloning=True)
2365
def initialize_on_transport(self, transport, _cloning=False):
2366
"""Format 6 dirs always have working tree, branch and repository.
2368
Except when they are being cloned.
2370
from bzrlib.branch import BzrBranchFormat4
2371
from bzrlib.repofmt.weaverepo import RepositoryFormat6
2372
result = super(BzrDirFormat6, self).initialize_on_transport(transport)
2373
RepositoryFormat6().initialize(result, _internal=True)
2375
branch = BzrBranchFormat4().initialize(result)
2376
result._init_workingtree()
2379
def network_name(self):
2380
return self.get_format_string()
2382
def _open(self, transport):
2383
"""See BzrDirFormat._open."""
2384
return BzrDir6(transport, self)
2386
def __return_repository_format(self):
2387
"""Circular import protection."""
2388
from bzrlib.repofmt.weaverepo import RepositoryFormat6
2389
return RepositoryFormat6()
2390
repository_format = property(__return_repository_format)
2393
class BzrDirMetaFormat1(BzrDirFormat):
2394
"""Bzr meta control format 1
2396
This is the first format with split out working tree, branch and repository
2399
- Format 3 working trees [optional]
2400
- Format 5 branches [optional]
2401
- Format 7 repositories [optional]
2404
_lock_class = lockdir.LockDir
2407
self._workingtree_format = None
2408
self._branch_format = None
2409
self._repository_format = None
2411
def __eq__(self, other):
2412
if other.__class__ is not self.__class__:
2414
if other.repository_format != self.repository_format:
2416
if other.workingtree_format != self.workingtree_format:
2420
def __ne__(self, other):
2421
return not self == other
2423
def get_branch_format(self):
2424
if self._branch_format is None:
2425
from bzrlib.branch import BranchFormat
2426
self._branch_format = BranchFormat.get_default_format()
2427
return self._branch_format
2429
def set_branch_format(self, format):
2430
self._branch_format = format
2432
def require_stacking(self, stack_on=None, possible_transports=None,
2434
"""We have a request to stack, try to ensure the formats support it.
2436
:param stack_on: If supplied, it is the URL to a branch that we want to
2437
stack on. Check to see if that format supports stacking before
2440
# Stacking is desired. requested by the target, but does the place it
2441
# points at support stacking? If it doesn't then we should
2442
# not implicitly upgrade. We check this here.
2443
new_repo_format = None
2444
new_branch_format = None
2446
# a bit of state for get_target_branch so that we don't try to open it
2447
# 2 times, for both repo *and* branch
2448
target = [None, False, None] # target_branch, checked, upgrade anyway
2449
def get_target_branch():
2451
# We've checked, don't check again
2453
if stack_on is None:
2454
# No target format, that means we want to force upgrading
2455
target[:] = [None, True, True]
2458
target_dir = BzrDir.open(stack_on,
2459
possible_transports=possible_transports)
2460
except errors.NotBranchError:
2461
# Nothing there, don't change formats
2462
target[:] = [None, True, False]
2464
except errors.JailBreak:
2465
# JailBreak, JFDI and upgrade anyway
2466
target[:] = [None, True, True]
2469
target_branch = target_dir.open_branch()
2470
except errors.NotBranchError:
2471
# No branch, don't upgrade formats
2472
target[:] = [None, True, False]
2474
target[:] = [target_branch, True, False]
2477
if (not _skip_repo and
2478
not self.repository_format.supports_external_lookups):
2479
# We need to upgrade the Repository.
2480
target_branch, _, do_upgrade = get_target_branch()
2481
if target_branch is None:
2482
# We don't have a target branch, should we upgrade anyway?
2484
# stack_on is inaccessible, JFDI.
2485
# TODO: bad monkey, hard-coded formats...
2486
if self.repository_format.rich_root_data:
2487
new_repo_format = pack_repo.RepositoryFormatKnitPack5RichRoot()
2489
new_repo_format = pack_repo.RepositoryFormatKnitPack5()
2491
# If the target already supports stacking, then we know the
2492
# project is already able to use stacking, so auto-upgrade
2494
new_repo_format = target_branch.repository._format
2495
if not new_repo_format.supports_external_lookups:
2496
# target doesn't, source doesn't, so don't auto upgrade
2498
new_repo_format = None
2499
if new_repo_format is not None:
2500
self.repository_format = new_repo_format
2501
note('Source repository format does not support stacking,'
2502
' using format:\n %s',
2503
new_repo_format.get_format_description())
2505
if not self.get_branch_format().supports_stacking():
2506
# We just checked the repo, now lets check if we need to
2507
# upgrade the branch format
2508
target_branch, _, do_upgrade = get_target_branch()
2509
if target_branch is None:
2511
# TODO: bad monkey, hard-coded formats...
2512
new_branch_format = branch.BzrBranchFormat7()
2514
new_branch_format = target_branch._format
2515
if not new_branch_format.supports_stacking():
2516
new_branch_format = None
2517
if new_branch_format is not None:
2518
# Does support stacking, use its format.
2519
self.set_branch_format(new_branch_format)
2520
note('Source branch format does not support stacking,'
2521
' using format:\n %s',
2522
new_branch_format.get_format_description())
2524
def get_converter(self, format=None):
2525
"""See BzrDirFormat.get_converter()."""
2527
format = BzrDirFormat.get_default_format()
2528
if not isinstance(self, format.__class__):
2529
# converting away from metadir is not implemented
2530
raise NotImplementedError(self.get_converter)
2531
return ConvertMetaToMeta(format)
2533
def get_format_string(self):
2534
"""See BzrDirFormat.get_format_string()."""
2535
return "Bazaar-NG meta directory, format 1\n"
2537
def get_format_description(self):
2538
"""See BzrDirFormat.get_format_description()."""
2539
return "Meta directory format 1"
2541
def network_name(self):
2542
return self.get_format_string()
2544
def _open(self, transport):
2545
"""See BzrDirFormat._open."""
2546
# Create a new format instance because otherwise initialisation of new
2547
# metadirs share the global default format object leading to alias
2549
format = BzrDirMetaFormat1()
2550
self._supply_sub_formats_to(format)
2551
return BzrDirMeta1(transport, format)
2553
def __return_repository_format(self):
2554
"""Circular import protection."""
2555
if self._repository_format:
2556
return self._repository_format
2557
from bzrlib.repository import RepositoryFormat
2558
return RepositoryFormat.get_default_format()
2560
def _set_repository_format(self, value):
2561
"""Allow changing the repository format for metadir formats."""
2562
self._repository_format = value
2564
repository_format = property(__return_repository_format,
2565
_set_repository_format)
2567
def _supply_sub_formats_to(self, other_format):
2568
"""Give other_format the same values for sub formats as this has.
2570
This method is expected to be used when parameterising a
2571
RemoteBzrDirFormat instance with the parameters from a
2572
BzrDirMetaFormat1 instance.
2574
:param other_format: other_format is a format which should be
2575
compatible with whatever sub formats are supported by self.
2578
if getattr(self, '_repository_format', None) is not None:
2579
other_format.repository_format = self.repository_format
2580
if self._branch_format is not None:
2581
other_format._branch_format = self._branch_format
2582
if self._workingtree_format is not None:
2583
other_format.workingtree_format = self.workingtree_format
2585
def __get_workingtree_format(self):
2586
if self._workingtree_format is None:
2587
from bzrlib.workingtree import WorkingTreeFormat
2588
self._workingtree_format = WorkingTreeFormat.get_default_format()
2589
return self._workingtree_format
2591
def __set_workingtree_format(self, wt_format):
2592
self._workingtree_format = wt_format
2594
workingtree_format = property(__get_workingtree_format,
2595
__set_workingtree_format)
2598
network_format_registry = registry.FormatRegistry()
2599
"""Registry of formats indexed by their network name.
2601
The network name for a BzrDirFormat is an identifier that can be used when
2602
referring to formats with smart server operations. See
2603
BzrDirFormat.network_name() for more detail.
2607
# Register bzr control format
2608
BzrDirFormat.register_control_format(BzrDirFormat)
2610
# Register bzr formats
2611
BzrDirFormat.register_format(BzrDirFormat4())
2612
BzrDirFormat.register_format(BzrDirFormat5())
2613
BzrDirFormat.register_format(BzrDirFormat6())
2614
__default_format = BzrDirMetaFormat1()
2615
BzrDirFormat.register_format(__default_format)
2616
BzrDirFormat._default_format = __default_format
2619
class Converter(object):
2620
"""Converts a disk format object from one format to another."""
2622
def convert(self, to_convert, pb):
2623
"""Perform the conversion of to_convert, giving feedback via pb.
2625
:param to_convert: The disk object to convert.
2626
:param pb: a progress bar to use for progress information.
2629
def step(self, message):
2630
"""Update the pb by a step."""
2632
self.pb.update(message, self.count, self.total)
2635
class ConvertBzrDir4To5(Converter):
2636
"""Converts format 4 bzr dirs to format 5."""
2639
super(ConvertBzrDir4To5, self).__init__()
2640
self.converted_revs = set()
2641
self.absent_revisions = set()
2645
def convert(self, to_convert, pb):
2646
"""See Converter.convert()."""
2647
self.bzrdir = to_convert
2649
warnings.warn("pb parameter to convert() is deprecated")
2650
self.pb = ui.ui_factory.nested_progress_bar()
2652
ui.ui_factory.note('starting upgrade from format 4 to 5')
2653
if isinstance(self.bzrdir.transport, local.LocalTransport):
2654
self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
2655
self._convert_to_weaves()
2656
return BzrDir.open(self.bzrdir.root_transport.base)
2660
def _convert_to_weaves(self):
2661
ui.ui_factory.note('note: upgrade may be faster if all store files are ungzipped first')
2664
stat = self.bzrdir.transport.stat('weaves')
2665
if not S_ISDIR(stat.st_mode):
2666
self.bzrdir.transport.delete('weaves')
2667
self.bzrdir.transport.mkdir('weaves')
2668
except errors.NoSuchFile:
2669
self.bzrdir.transport.mkdir('weaves')
2670
# deliberately not a WeaveFile as we want to build it up slowly.
2671
self.inv_weave = Weave('inventory')
2672
# holds in-memory weaves for all files
2673
self.text_weaves = {}
2674
self.bzrdir.transport.delete('branch-format')
2675
self.branch = self.bzrdir.open_branch()
2676
self._convert_working_inv()
2677
rev_history = self.branch.revision_history()
2678
# to_read is a stack holding the revisions we still need to process;
2679
# appending to it adds new highest-priority revisions
2680
self.known_revisions = set(rev_history)
2681
self.to_read = rev_history[-1:]
2683
rev_id = self.to_read.pop()
2684
if (rev_id not in self.revisions
2685
and rev_id not in self.absent_revisions):
2686
self._load_one_rev(rev_id)
2688
to_import = self._make_order()
2689
for i, rev_id in enumerate(to_import):
2690
self.pb.update('converting revision', i, len(to_import))
2691
self._convert_one_rev(rev_id)
2693
self._write_all_weaves()
2694
self._write_all_revs()
2695
ui.ui_factory.note('upgraded to weaves:')
2696
ui.ui_factory.note(' %6d revisions and inventories' % len(self.revisions))
2697
ui.ui_factory.note(' %6d revisions not present' % len(self.absent_revisions))
2698
ui.ui_factory.note(' %6d texts' % self.text_count)
2699
self._cleanup_spare_files_after_format4()
2700
self.branch._transport.put_bytes(
2702
BzrDirFormat5().get_format_string(),
2703
mode=self.bzrdir._get_file_mode())
2705
def _cleanup_spare_files_after_format4(self):
2706
# FIXME working tree upgrade foo.
2707
for n in 'merged-patches', 'pending-merged-patches':
2709
## assert os.path.getsize(p) == 0
2710
self.bzrdir.transport.delete(n)
2711
except errors.NoSuchFile:
2713
self.bzrdir.transport.delete_tree('inventory-store')
2714
self.bzrdir.transport.delete_tree('text-store')
2716
def _convert_working_inv(self):
2717
inv = xml4.serializer_v4.read_inventory(
2718
self.branch._transport.get('inventory'))
2719
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv, working=True)
2720
self.branch._transport.put_bytes('inventory', new_inv_xml,
2721
mode=self.bzrdir._get_file_mode())
2723
def _write_all_weaves(self):
2724
controlweaves = WeaveStore(self.bzrdir.transport, prefixed=False)
2725
weave_transport = self.bzrdir.transport.clone('weaves')
2726
weaves = WeaveStore(weave_transport, prefixed=False)
2727
transaction = WriteTransaction()
2731
for file_id, file_weave in self.text_weaves.items():
2732
self.pb.update('writing weave', i, len(self.text_weaves))
2733
weaves._put_weave(file_id, file_weave, transaction)
2735
self.pb.update('inventory', 0, 1)
2736
controlweaves._put_weave('inventory', self.inv_weave, transaction)
2737
self.pb.update('inventory', 1, 1)
2741
def _write_all_revs(self):
2742
"""Write all revisions out in new form."""
2743
self.bzrdir.transport.delete_tree('revision-store')
2744
self.bzrdir.transport.mkdir('revision-store')
2745
revision_transport = self.bzrdir.transport.clone('revision-store')
2747
from bzrlib.xml5 import serializer_v5
2748
from bzrlib.repofmt.weaverepo import RevisionTextStore
2749
revision_store = RevisionTextStore(revision_transport,
2750
serializer_v5, False, versionedfile.PrefixMapper(),
2751
lambda:True, lambda:True)
2753
for i, rev_id in enumerate(self.converted_revs):
2754
self.pb.update('write revision', i, len(self.converted_revs))
2755
text = serializer_v5.write_revision_to_string(
2756
self.revisions[rev_id])
2758
revision_store.add_lines(key, None, osutils.split_lines(text))
2762
def _load_one_rev(self, rev_id):
2763
"""Load a revision object into memory.
2765
Any parents not either loaded or abandoned get queued to be
2767
self.pb.update('loading revision',
2768
len(self.revisions),
2769
len(self.known_revisions))
2770
if not self.branch.repository.has_revision(rev_id):
2772
ui.ui_factory.note('revision {%s} not present in branch; '
2773
'will be converted as a ghost' %
2775
self.absent_revisions.add(rev_id)
2777
rev = self.branch.repository.get_revision(rev_id)
2778
for parent_id in rev.parent_ids:
2779
self.known_revisions.add(parent_id)
2780
self.to_read.append(parent_id)
2781
self.revisions[rev_id] = rev
2783
def _load_old_inventory(self, rev_id):
2784
old_inv_xml = self.branch.repository.inventory_store.get(rev_id).read()
2785
inv = xml4.serializer_v4.read_inventory_from_string(old_inv_xml)
2786
inv.revision_id = rev_id
2787
rev = self.revisions[rev_id]
2790
def _load_updated_inventory(self, rev_id):
2791
inv_xml = self.inv_weave.get_text(rev_id)
2792
inv = xml5.serializer_v5.read_inventory_from_string(inv_xml, rev_id)
2795
def _convert_one_rev(self, rev_id):
2796
"""Convert revision and all referenced objects to new format."""
2797
rev = self.revisions[rev_id]
2798
inv = self._load_old_inventory(rev_id)
2799
present_parents = [p for p in rev.parent_ids
2800
if p not in self.absent_revisions]
2801
self._convert_revision_contents(rev, inv, present_parents)
2802
self._store_new_inv(rev, inv, present_parents)
2803
self.converted_revs.add(rev_id)
2805
def _store_new_inv(self, rev, inv, present_parents):
2806
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
2807
new_inv_sha1 = sha_string(new_inv_xml)
2808
self.inv_weave.add_lines(rev.revision_id,
2810
new_inv_xml.splitlines(True))
2811
rev.inventory_sha1 = new_inv_sha1
2813
def _convert_revision_contents(self, rev, inv, present_parents):
2814
"""Convert all the files within a revision.
2816
Also upgrade the inventory to refer to the text revision ids."""
2817
rev_id = rev.revision_id
2818
mutter('converting texts of revision {%s}',
2820
parent_invs = map(self._load_updated_inventory, present_parents)
2821
entries = inv.iter_entries()
2823
for path, ie in entries:
2824
self._convert_file_version(rev, ie, parent_invs)
2826
def _convert_file_version(self, rev, ie, parent_invs):
2827
"""Convert one version of one file.
2829
The file needs to be added into the weave if it is a merge
2830
of >=2 parents or if it's changed from its parent.
2832
file_id = ie.file_id
2833
rev_id = rev.revision_id
2834
w = self.text_weaves.get(file_id)
2837
self.text_weaves[file_id] = w
2838
text_changed = False
2839
parent_candiate_entries = ie.parent_candidates(parent_invs)
2840
heads = graph.Graph(self).heads(parent_candiate_entries.keys())
2841
# XXX: Note that this is unordered - and this is tolerable because
2842
# the previous code was also unordered.
2843
previous_entries = dict((head, parent_candiate_entries[head]) for head
2845
self.snapshot_ie(previous_entries, ie, w, rev_id)
2848
def get_parent_map(self, revision_ids):
2849
"""See graph.StackedParentsProvider.get_parent_map"""
2850
return dict((revision_id, self.revisions[revision_id])
2851
for revision_id in revision_ids
2852
if revision_id in self.revisions)
2854
def snapshot_ie(self, previous_revisions, ie, w, rev_id):
2855
# TODO: convert this logic, which is ~= snapshot to
2856
# a call to:. This needs the path figured out. rather than a work_tree
2857
# a v4 revision_tree can be given, or something that looks enough like
2858
# one to give the file content to the entry if it needs it.
2859
# and we need something that looks like a weave store for snapshot to
2861
#ie.snapshot(rev, PATH, previous_revisions, REVISION_TREE, InMemoryWeaveStore(self.text_weaves))
2862
if len(previous_revisions) == 1:
2863
previous_ie = previous_revisions.values()[0]
2864
if ie._unchanged(previous_ie):
2865
ie.revision = previous_ie.revision
2868
text = self.branch.repository._text_store.get(ie.text_id)
2869
file_lines = text.readlines()
2870
w.add_lines(rev_id, previous_revisions, file_lines)
2871
self.text_count += 1
2873
w.add_lines(rev_id, previous_revisions, [])
2874
ie.revision = rev_id
2876
def _make_order(self):
2877
"""Return a suitable order for importing revisions.
2879
The order must be such that an revision is imported after all
2880
its (present) parents.
2882
todo = set(self.revisions.keys())
2883
done = self.absent_revisions.copy()
2886
# scan through looking for a revision whose parents
2888
for rev_id in sorted(list(todo)):
2889
rev = self.revisions[rev_id]
2890
parent_ids = set(rev.parent_ids)
2891
if parent_ids.issubset(done):
2892
# can take this one now
2893
order.append(rev_id)
2899
class ConvertBzrDir5To6(Converter):
2900
"""Converts format 5 bzr dirs to format 6."""
2902
def convert(self, to_convert, pb):
2903
"""See Converter.convert()."""
2904
self.bzrdir = to_convert
2905
pb = ui.ui_factory.nested_progress_bar()
2907
ui.ui_factory.note('starting upgrade from format 5 to 6')
2908
self._convert_to_prefixed()
2909
return BzrDir.open(self.bzrdir.root_transport.base)
2913
def _convert_to_prefixed(self):
2914
from bzrlib.store import TransportStore
2915
self.bzrdir.transport.delete('branch-format')
2916
for store_name in ["weaves", "revision-store"]:
2917
ui.ui_factory.note("adding prefixes to %s" % store_name)
2918
store_transport = self.bzrdir.transport.clone(store_name)
2919
store = TransportStore(store_transport, prefixed=True)
2920
for urlfilename in store_transport.list_dir('.'):
2921
filename = urlutils.unescape(urlfilename)
2922
if (filename.endswith(".weave") or
2923
filename.endswith(".gz") or
2924
filename.endswith(".sig")):
2925
file_id, suffix = os.path.splitext(filename)
2929
new_name = store._mapper.map((file_id,)) + suffix
2930
# FIXME keep track of the dirs made RBC 20060121
2932
store_transport.move(filename, new_name)
2933
except errors.NoSuchFile: # catches missing dirs strangely enough
2934
store_transport.mkdir(osutils.dirname(new_name))
2935
store_transport.move(filename, new_name)
2936
self.bzrdir.transport.put_bytes(
2938
BzrDirFormat6().get_format_string(),
2939
mode=self.bzrdir._get_file_mode())
2942
class ConvertBzrDir6ToMeta(Converter):
2943
"""Converts format 6 bzr dirs to metadirs."""
2945
def convert(self, to_convert, pb):
2946
"""See Converter.convert()."""
2947
from bzrlib.repofmt.weaverepo import RepositoryFormat7
2948
from bzrlib.branch import BzrBranchFormat5
2949
self.bzrdir = to_convert
2950
self.pb = ui.ui_factory.nested_progress_bar()
2952
self.total = 20 # the steps we know about
2953
self.garbage_inventories = []
2954
self.dir_mode = self.bzrdir._get_dir_mode()
2955
self.file_mode = self.bzrdir._get_file_mode()
2957
ui.ui_factory.note('starting upgrade from format 6 to metadir')
2958
self.bzrdir.transport.put_bytes(
2960
"Converting to format 6",
2961
mode=self.file_mode)
2962
# its faster to move specific files around than to open and use the apis...
2963
# first off, nuke ancestry.weave, it was never used.
2965
self.step('Removing ancestry.weave')
2966
self.bzrdir.transport.delete('ancestry.weave')
2967
except errors.NoSuchFile:
2969
# find out whats there
2970
self.step('Finding branch files')
2971
last_revision = self.bzrdir.open_branch().last_revision()
2972
bzrcontents = self.bzrdir.transport.list_dir('.')
2973
for name in bzrcontents:
2974
if name.startswith('basis-inventory.'):
2975
self.garbage_inventories.append(name)
2976
# create new directories for repository, working tree and branch
2977
repository_names = [('inventory.weave', True),
2978
('revision-store', True),
2980
self.step('Upgrading repository ')
2981
self.bzrdir.transport.mkdir('repository', mode=self.dir_mode)
2982
self.make_lock('repository')
2983
# we hard code the formats here because we are converting into
2984
# the meta format. The meta format upgrader can take this to a
2985
# future format within each component.
2986
self.put_format('repository', RepositoryFormat7())
2987
for entry in repository_names:
2988
self.move_entry('repository', entry)
2990
self.step('Upgrading branch ')
2991
self.bzrdir.transport.mkdir('branch', mode=self.dir_mode)
2992
self.make_lock('branch')
2993
self.put_format('branch', BzrBranchFormat5())
2994
branch_files = [('revision-history', True),
2995
('branch-name', True),
2997
for entry in branch_files:
2998
self.move_entry('branch', entry)
3000
checkout_files = [('pending-merges', True),
3001
('inventory', True),
3002
('stat-cache', False)]
3003
# If a mandatory checkout file is not present, the branch does not have
3004
# a functional checkout. Do not create a checkout in the converted
3006
for name, mandatory in checkout_files:
3007
if mandatory and name not in bzrcontents:
3008
has_checkout = False
3012
if not has_checkout:
3013
ui.ui_factory.note('No working tree.')
3014
# If some checkout files are there, we may as well get rid of them.
3015
for name, mandatory in checkout_files:
3016
if name in bzrcontents:
3017
self.bzrdir.transport.delete(name)
3019
from bzrlib.workingtree import WorkingTreeFormat3
3020
self.step('Upgrading working tree')
3021
self.bzrdir.transport.mkdir('checkout', mode=self.dir_mode)
3022
self.make_lock('checkout')
3024
'checkout', WorkingTreeFormat3())
3025
self.bzrdir.transport.delete_multi(
3026
self.garbage_inventories, self.pb)
3027
for entry in checkout_files:
3028
self.move_entry('checkout', entry)
3029
if last_revision is not None:
3030
self.bzrdir.transport.put_bytes(
3031
'checkout/last-revision', last_revision)
3032
self.bzrdir.transport.put_bytes(
3034
BzrDirMetaFormat1().get_format_string(),
3035
mode=self.file_mode)
3037
return BzrDir.open(self.bzrdir.root_transport.base)
3039
def make_lock(self, name):
3040
"""Make a lock for the new control dir name."""
3041
self.step('Make %s lock' % name)
3042
ld = lockdir.LockDir(self.bzrdir.transport,
3044
file_modebits=self.file_mode,
3045
dir_modebits=self.dir_mode)
3048
def move_entry(self, new_dir, entry):
3049
"""Move then entry name into new_dir."""
3051
mandatory = entry[1]
3052
self.step('Moving %s' % name)
3054
self.bzrdir.transport.move(name, '%s/%s' % (new_dir, name))
3055
except errors.NoSuchFile:
3059
def put_format(self, dirname, format):
3060
self.bzrdir.transport.put_bytes('%s/format' % dirname,
3061
format.get_format_string(),
3065
class ConvertMetaToMeta(Converter):
3066
"""Converts the components of metadirs."""
3068
def __init__(self, target_format):
3069
"""Create a metadir to metadir converter.
3071
:param target_format: The final metadir format that is desired.
3073
self.target_format = target_format
3075
def convert(self, to_convert, pb):
3076
"""See Converter.convert()."""
3077
self.bzrdir = to_convert
3078
self.pb = ui.ui_factory.nested_progress_bar()
3081
self.step('checking repository format')
3083
repo = self.bzrdir.open_repository()
3084
except errors.NoRepositoryPresent:
3087
if not isinstance(repo._format, self.target_format.repository_format.__class__):
3088
from bzrlib.repository import CopyConverter
3089
ui.ui_factory.note('starting repository conversion')
3090
converter = CopyConverter(self.target_format.repository_format)
3091
converter.convert(repo, pb)
3092
for branch in self.bzrdir.list_branches():
3093
# TODO: conversions of Branch and Tree should be done by
3094
# InterXFormat lookups/some sort of registry.
3095
# Avoid circular imports
3096
from bzrlib import branch as _mod_branch
3097
old = branch._format.__class__
3098
new = self.target_format.get_branch_format().__class__
3100
if (old == _mod_branch.BzrBranchFormat5 and
3101
new in (_mod_branch.BzrBranchFormat6,
3102
_mod_branch.BzrBranchFormat7,
3103
_mod_branch.BzrBranchFormat8)):
3104
branch_converter = _mod_branch.Converter5to6()
3105
elif (old == _mod_branch.BzrBranchFormat6 and
3106
new in (_mod_branch.BzrBranchFormat7,
3107
_mod_branch.BzrBranchFormat8)):
3108
branch_converter = _mod_branch.Converter6to7()
3109
elif (old == _mod_branch.BzrBranchFormat7 and
3110
new is _mod_branch.BzrBranchFormat8):
3111
branch_converter = _mod_branch.Converter7to8()
3113
raise errors.BadConversionTarget("No converter", new,
3115
branch_converter.convert(branch)
3116
branch = self.bzrdir.open_branch()
3117
old = branch._format.__class__
3119
tree = self.bzrdir.open_workingtree(recommend_upgrade=False)
3120
except (errors.NoWorkingTree, errors.NotLocalUrl):
3123
# TODO: conversions of Branch and Tree should be done by
3124
# InterXFormat lookups
3125
if (isinstance(tree, workingtree.WorkingTree3) and
3126
not isinstance(tree, workingtree_4.DirStateWorkingTree) and
3127
isinstance(self.target_format.workingtree_format,
3128
workingtree_4.DirStateWorkingTreeFormat)):
3129
workingtree_4.Converter3to4().convert(tree)
3130
if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
3131
not isinstance(tree, workingtree_4.WorkingTree5) and
3132
isinstance(self.target_format.workingtree_format,
3133
workingtree_4.WorkingTreeFormat5)):
3134
workingtree_4.Converter4to5().convert(tree)
3135
if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
3136
not isinstance(tree, workingtree_4.WorkingTree6) and
3137
isinstance(self.target_format.workingtree_format,
3138
workingtree_4.WorkingTreeFormat6)):
3139
workingtree_4.Converter4or5to6().convert(tree)
3144
# This is not in remote.py because it's relatively small, and needs to be
3145
# registered. Putting it in remote.py creates a circular import problem.
3146
# we can make it a lazy object if the control formats is turned into something
3148
class RemoteBzrDirFormat(BzrDirMetaFormat1):
3149
"""Format representing bzrdirs accessed via a smart server"""
3152
BzrDirMetaFormat1.__init__(self)
3153
# XXX: It's a bit ugly that the network name is here, because we'd
3154
# like to believe that format objects are stateless or at least
3155
# immutable, However, we do at least avoid mutating the name after
3156
# it's returned. See <https://bugs.edge.launchpad.net/bzr/+bug/504102>
3157
self._network_name = None
3160
return "%s(_network_name=%r)" % (self.__class__.__name__,
3163
def get_format_description(self):
3164
if self._network_name:
3165
real_format = network_format_registry.get(self._network_name)
3166
return 'Remote: ' + real_format.get_format_description()
3167
return 'bzr remote bzrdir'
3169
def get_format_string(self):
3170
raise NotImplementedError(self.get_format_string)
3172
def network_name(self):
3173
if self._network_name:
3174
return self._network_name
3176
raise AssertionError("No network name set.")
3179
def probe_transport(klass, transport):
3180
"""Return a RemoteBzrDirFormat object if it looks possible."""
3182
medium = transport.get_smart_medium()
3183
except (NotImplementedError, AttributeError,
3184
errors.TransportNotPossible, errors.NoSmartMedium,
3185
errors.SmartProtocolError):
3186
# no smart server, so not a branch for this format type.
3187
raise errors.NotBranchError(path=transport.base)
3189
# Decline to open it if the server doesn't support our required
3190
# version (3) so that the VFS-based transport will do it.
3191
if medium.should_probe():
3193
server_version = medium.protocol_version()
3194
except errors.SmartProtocolError:
3195
# Apparently there's no usable smart server there, even though
3196
# the medium supports the smart protocol.
3197
raise errors.NotBranchError(path=transport.base)
3198
if server_version != '2':
3199
raise errors.NotBranchError(path=transport.base)
3202
def initialize_on_transport(self, transport):
3204
# hand off the request to the smart server
3205
client_medium = transport.get_smart_medium()
3206
except errors.NoSmartMedium:
3207
# TODO: lookup the local format from a server hint.
3208
local_dir_format = BzrDirMetaFormat1()
3209
return local_dir_format.initialize_on_transport(transport)
3210
client = _SmartClient(client_medium)
3211
path = client.remote_path_from_transport(transport)
3213
response = client.call('BzrDirFormat.initialize', path)
3214
except errors.ErrorFromSmartServer, err:
3215
remote._translate_error(err, path=path)
3216
if response[0] != 'ok':
3217
raise errors.SmartProtocolError('unexpected response code %s' % (response,))
3218
format = RemoteBzrDirFormat()
3219
self._supply_sub_formats_to(format)
3220
return remote.RemoteBzrDir(transport, format)
3222
def parse_NoneTrueFalse(self, arg):
3229
raise AssertionError("invalid arg %r" % arg)
3231
def _serialize_NoneTrueFalse(self, arg):
3238
def _serialize_NoneString(self, arg):
3241
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
3242
create_prefix=False, force_new_repo=False, stacked_on=None,
3243
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
3246
# hand off the request to the smart server
3247
client_medium = transport.get_smart_medium()
3248
except errors.NoSmartMedium:
3251
# Decline to open it if the server doesn't support our required
3252
# version (3) so that the VFS-based transport will do it.
3253
if client_medium.should_probe():
3255
server_version = client_medium.protocol_version()
3256
if server_version != '2':
3260
except errors.SmartProtocolError:
3261
# Apparently there's no usable smart server there, even though
3262
# the medium supports the smart protocol.
3267
client = _SmartClient(client_medium)
3268
path = client.remote_path_from_transport(transport)
3269
if client_medium._is_remote_before((1, 16)):
3272
# TODO: lookup the local format from a server hint.
3273
local_dir_format = BzrDirMetaFormat1()
3274
self._supply_sub_formats_to(local_dir_format)
3275
return local_dir_format.initialize_on_transport_ex(transport,
3276
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3277
force_new_repo=force_new_repo, stacked_on=stacked_on,
3278
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3279
make_working_trees=make_working_trees, shared_repo=shared_repo,
3281
return self._initialize_on_transport_ex_rpc(client, path, transport,
3282
use_existing_dir, create_prefix, force_new_repo, stacked_on,
3283
stack_on_pwd, repo_format_name, make_working_trees, shared_repo)
3285
def _initialize_on_transport_ex_rpc(self, client, path, transport,
3286
use_existing_dir, create_prefix, force_new_repo, stacked_on,
3287
stack_on_pwd, repo_format_name, make_working_trees, shared_repo):
3289
args.append(self._serialize_NoneTrueFalse(use_existing_dir))
3290
args.append(self._serialize_NoneTrueFalse(create_prefix))
3291
args.append(self._serialize_NoneTrueFalse(force_new_repo))
3292
args.append(self._serialize_NoneString(stacked_on))
3293
# stack_on_pwd is often/usually our transport
3296
stack_on_pwd = transport.relpath(stack_on_pwd)
3297
if not stack_on_pwd:
3299
except errors.PathNotChild:
3301
args.append(self._serialize_NoneString(stack_on_pwd))
3302
args.append(self._serialize_NoneString(repo_format_name))
3303
args.append(self._serialize_NoneTrueFalse(make_working_trees))
3304
args.append(self._serialize_NoneTrueFalse(shared_repo))
3305
request_network_name = self._network_name or \
3306
BzrDirFormat.get_default_format().network_name()
3308
response = client.call('BzrDirFormat.initialize_ex_1.16',
3309
request_network_name, path, *args)
3310
except errors.UnknownSmartMethod:
3311
client._medium._remember_remote_is_before((1,16))
3312
local_dir_format = BzrDirMetaFormat1()
3313
self._supply_sub_formats_to(local_dir_format)
3314
return local_dir_format.initialize_on_transport_ex(transport,
3315
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3316
force_new_repo=force_new_repo, stacked_on=stacked_on,
3317
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3318
make_working_trees=make_working_trees, shared_repo=shared_repo,
3320
except errors.ErrorFromSmartServer, err:
3321
remote._translate_error(err, path=path)
3322
repo_path = response[0]
3323
bzrdir_name = response[6]
3324
require_stacking = response[7]
3325
require_stacking = self.parse_NoneTrueFalse(require_stacking)
3326
format = RemoteBzrDirFormat()
3327
format._network_name = bzrdir_name
3328
self._supply_sub_formats_to(format)
3329
bzrdir = remote.RemoteBzrDir(transport, format, _client=client)
3331
repo_format = remote.response_tuple_to_repo_format(response[1:])
3332
if repo_path == '.':
3335
repo_bzrdir_format = RemoteBzrDirFormat()
3336
repo_bzrdir_format._network_name = response[5]
3337
repo_bzr = remote.RemoteBzrDir(transport.clone(repo_path),
3341
final_stack = response[8] or None
3342
final_stack_pwd = response[9] or None
3344
final_stack_pwd = urlutils.join(
3345
transport.base, final_stack_pwd)
3346
remote_repo = remote.RemoteRepository(repo_bzr, repo_format)
3347
if len(response) > 10:
3348
# Updated server verb that locks remotely.
3349
repo_lock_token = response[10] or None
3350
remote_repo.lock_write(repo_lock_token, _skip_rpc=True)
3352
remote_repo.dont_leave_lock_in_place()
3354
remote_repo.lock_write()
3355
policy = UseExistingRepository(remote_repo, final_stack,
3356
final_stack_pwd, require_stacking)
3357
policy.acquire_repository()
3361
bzrdir._format.set_branch_format(self.get_branch_format())
3362
if require_stacking:
3363
# The repo has already been created, but we need to make sure that
3364
# we'll make a stackable branch.
3365
bzrdir._format.require_stacking(_skip_repo=True)
3366
return remote_repo, bzrdir, require_stacking, policy
3368
def _open(self, transport):
3369
return remote.RemoteBzrDir(transport, self)
3371
def __eq__(self, other):
3372
if not isinstance(other, RemoteBzrDirFormat):
3374
return self.get_format_description() == other.get_format_description()
3376
def __return_repository_format(self):
3377
# Always return a RemoteRepositoryFormat object, but if a specific bzr
3378
# repository format has been asked for, tell the RemoteRepositoryFormat
3379
# that it should use that for init() etc.
3380
result = remote.RemoteRepositoryFormat()
3381
custom_format = getattr(self, '_repository_format', None)
3383
if isinstance(custom_format, remote.RemoteRepositoryFormat):
3384
return custom_format
3386
# We will use the custom format to create repositories over the
3387
# wire; expose its details like rich_root_data for code to
3389
result._custom_format = custom_format
3392
def get_branch_format(self):
3393
result = BzrDirMetaFormat1.get_branch_format(self)
3394
if not isinstance(result, remote.RemoteBranchFormat):
3395
new_result = remote.RemoteBranchFormat()
3396
new_result._custom_format = result
3398
self.set_branch_format(new_result)
3402
repository_format = property(__return_repository_format,
3403
BzrDirMetaFormat1._set_repository_format) #.im_func)
3406
BzrDirFormat.register_control_server_format(RemoteBzrDirFormat)
3409
class BzrDirFormatInfo(object):
3411
def __init__(self, native, deprecated, hidden, experimental):
3412
self.deprecated = deprecated
3413
self.native = native
3414
self.hidden = hidden
3415
self.experimental = experimental
3418
class BzrDirFormatRegistry(registry.Registry):
3419
"""Registry of user-selectable BzrDir subformats.
3421
Differs from BzrDirFormat._control_formats in that it provides sub-formats,
3422
e.g. BzrDirMeta1 with weave repository. Also, it's more user-oriented.
3426
"""Create a BzrDirFormatRegistry."""
3427
self._aliases = set()
3428
self._registration_order = list()
3429
super(BzrDirFormatRegistry, self).__init__()
3432
"""Return a set of the format names which are aliases."""
3433
return frozenset(self._aliases)
3435
def register_metadir(self, key,
3436
repository_format, help, native=True, deprecated=False,
3442
"""Register a metadir subformat.
3444
These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
3445
by the Repository/Branch/WorkingTreeformats.
3447
:param repository_format: The fully-qualified repository format class
3449
:param branch_format: Fully-qualified branch format class name as
3451
:param tree_format: Fully-qualified tree format class name as
3454
# This should be expanded to support setting WorkingTree and Branch
3455
# formats, once BzrDirMetaFormat1 supports that.
3456
def _load(full_name):
3457
mod_name, factory_name = full_name.rsplit('.', 1)
3459
mod = __import__(mod_name, globals(), locals(),
3461
except ImportError, e:
3462
raise ImportError('failed to load %s: %s' % (full_name, e))
3464
factory = getattr(mod, factory_name)
3465
except AttributeError:
3466
raise AttributeError('no factory %s in module %r'
3471
bd = BzrDirMetaFormat1()
3472
if branch_format is not None:
3473
bd.set_branch_format(_load(branch_format))
3474
if tree_format is not None:
3475
bd.workingtree_format = _load(tree_format)
3476
if repository_format is not None:
3477
bd.repository_format = _load(repository_format)
3479
self.register(key, helper, help, native, deprecated, hidden,
3480
experimental, alias)
3482
def register(self, key, factory, help, native=True, deprecated=False,
3483
hidden=False, experimental=False, alias=False):
3484
"""Register a BzrDirFormat factory.
3486
The factory must be a callable that takes one parameter: the key.
3487
It must produce an instance of the BzrDirFormat when called.
3489
This function mainly exists to prevent the info object from being
3492
registry.Registry.register(self, key, factory, help,
3493
BzrDirFormatInfo(native, deprecated, hidden, experimental))
3495
self._aliases.add(key)
3496
self._registration_order.append(key)
3498
def register_lazy(self, key, module_name, member_name, help, native=True,
3499
deprecated=False, hidden=False, experimental=False, alias=False):
3500
registry.Registry.register_lazy(self, key, module_name, member_name,
3501
help, BzrDirFormatInfo(native, deprecated, hidden, experimental))
3503
self._aliases.add(key)
3504
self._registration_order.append(key)
3506
def set_default(self, key):
3507
"""Set the 'default' key to be a clone of the supplied key.
3509
This method must be called once and only once.
3511
registry.Registry.register(self, 'default', self.get(key),
3512
self.get_help(key), info=self.get_info(key))
3513
self._aliases.add('default')
3515
def set_default_repository(self, key):
3516
"""Set the FormatRegistry default and Repository default.
3518
This is a transitional method while Repository.set_default_format
3521
if 'default' in self:
3522
self.remove('default')
3523
self.set_default(key)
3524
format = self.get('default')()
3526
def make_bzrdir(self, key):
3527
return self.get(key)()
3529
def help_topic(self, topic):
3531
default_realkey = None
3532
default_help = self.get_help('default')
3534
for key in self._registration_order:
3535
if key == 'default':
3537
help = self.get_help(key)
3538
if help == default_help:
3539
default_realkey = key
3541
help_pairs.append((key, help))
3543
def wrapped(key, help, info):
3545
help = '(native) ' + help
3546
return ':%s:\n%s\n\n' % (key,
3547
textwrap.fill(help, initial_indent=' ',
3548
subsequent_indent=' ',
3549
break_long_words=False))
3550
if default_realkey is not None:
3551
output += wrapped(default_realkey, '(default) %s' % default_help,
3552
self.get_info('default'))
3553
deprecated_pairs = []
3554
experimental_pairs = []
3555
for key, help in help_pairs:
3556
info = self.get_info(key)
3559
elif info.deprecated:
3560
deprecated_pairs.append((key, help))
3561
elif info.experimental:
3562
experimental_pairs.append((key, help))
3564
output += wrapped(key, help, info)
3565
output += "\nSee :doc:`formats-help` for more about storage formats."
3567
if len(experimental_pairs) > 0:
3568
other_output += "Experimental formats are shown below.\n\n"
3569
for key, help in experimental_pairs:
3570
info = self.get_info(key)
3571
other_output += wrapped(key, help, info)
3574
"No experimental formats are available.\n\n"
3575
if len(deprecated_pairs) > 0:
3576
other_output += "\nDeprecated formats are shown below.\n\n"
3577
for key, help in deprecated_pairs:
3578
info = self.get_info(key)
3579
other_output += wrapped(key, help, info)
3582
"\nNo deprecated formats are available.\n\n"
3584
"\nSee :doc:`formats-help` for more about storage formats."
3586
if topic == 'other-formats':
3592
class RepositoryAcquisitionPolicy(object):
3593
"""Abstract base class for repository acquisition policies.
3595
A repository acquisition policy decides how a BzrDir acquires a repository
3596
for a branch that is being created. The most basic policy decision is
3597
whether to create a new repository or use an existing one.
3599
def __init__(self, stack_on, stack_on_pwd, require_stacking):
3602
:param stack_on: A location to stack on
3603
:param stack_on_pwd: If stack_on is relative, the location it is
3605
:param require_stacking: If True, it is a failure to not stack.
3607
self._stack_on = stack_on
3608
self._stack_on_pwd = stack_on_pwd
3609
self._require_stacking = require_stacking
3611
def configure_branch(self, branch):
3612
"""Apply any configuration data from this policy to the branch.
3614
Default implementation sets repository stacking.
3616
if self._stack_on is None:
3618
if self._stack_on_pwd is None:
3619
stack_on = self._stack_on
3622
stack_on = urlutils.rebase_url(self._stack_on,
3624
branch.bzrdir.root_transport.base)
3625
except errors.InvalidRebaseURLs:
3626
stack_on = self._get_full_stack_on()
3628
branch.set_stacked_on_url(stack_on)
3629
except (errors.UnstackableBranchFormat,
3630
errors.UnstackableRepositoryFormat):
3631
if self._require_stacking:
3634
def requires_stacking(self):
3635
"""Return True if this policy requires stacking."""
3636
return self._stack_on is not None and self._require_stacking
3638
def _get_full_stack_on(self):
3639
"""Get a fully-qualified URL for the stack_on location."""
3640
if self._stack_on is None:
3642
if self._stack_on_pwd is None:
3643
return self._stack_on
3645
return urlutils.join(self._stack_on_pwd, self._stack_on)
3647
def _add_fallback(self, repository, possible_transports=None):
3648
"""Add a fallback to the supplied repository, if stacking is set."""
3649
stack_on = self._get_full_stack_on()
3650
if stack_on is None:
3653
stacked_dir = BzrDir.open(stack_on,
3654
possible_transports=possible_transports)
3655
except errors.JailBreak:
3656
# We keep the stacking details, but we are in the server code so
3657
# actually stacking is not needed.
3660
stacked_repo = stacked_dir.open_branch().repository
3661
except errors.NotBranchError:
3662
stacked_repo = stacked_dir.open_repository()
3664
repository.add_fallback_repository(stacked_repo)
3665
except errors.UnstackableRepositoryFormat:
3666
if self._require_stacking:
3669
self._require_stacking = True
3671
def acquire_repository(self, make_working_trees=None, shared=False):
3672
"""Acquire a repository for this bzrdir.
3674
Implementations may create a new repository or use a pre-exising
3676
:param make_working_trees: If creating a repository, set
3677
make_working_trees to this value (if non-None)
3678
:param shared: If creating a repository, make it shared if True
3679
:return: A repository, is_new_flag (True if the repository was
3682
raise NotImplemented(RepositoryAcquisitionPolicy.acquire_repository)
3685
class CreateRepository(RepositoryAcquisitionPolicy):
3686
"""A policy of creating a new repository"""
3688
def __init__(self, bzrdir, stack_on=None, stack_on_pwd=None,
3689
require_stacking=False):
3692
:param bzrdir: The bzrdir to create the repository on.
3693
:param stack_on: A location to stack on
3694
:param stack_on_pwd: If stack_on is relative, the location it is
3697
RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
3699
self._bzrdir = bzrdir
3701
def acquire_repository(self, make_working_trees=None, shared=False):
3702
"""Implementation of RepositoryAcquisitionPolicy.acquire_repository
3704
Creates the desired repository in the bzrdir we already have.
3706
stack_on = self._get_full_stack_on()
3708
format = self._bzrdir._format
3709
format.require_stacking(stack_on=stack_on,
3710
possible_transports=[self._bzrdir.root_transport])
3711
if not self._require_stacking:
3712
# We have picked up automatic stacking somewhere.
3713
note('Using default stacking branch %s at %s', self._stack_on,
3715
repository = self._bzrdir.create_repository(shared=shared)
3716
self._add_fallback(repository,
3717
possible_transports=[self._bzrdir.transport])
3718
if make_working_trees is not None:
3719
repository.set_make_working_trees(make_working_trees)
3720
return repository, True
3723
class UseExistingRepository(RepositoryAcquisitionPolicy):
3724
"""A policy of reusing an existing repository"""
3726
def __init__(self, repository, stack_on=None, stack_on_pwd=None,
3727
require_stacking=False):
3730
:param repository: The repository to use.
3731
:param stack_on: A location to stack on
3732
:param stack_on_pwd: If stack_on is relative, the location it is
3735
RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
3737
self._repository = repository
3739
def acquire_repository(self, make_working_trees=None, shared=False):
3740
"""Implementation of RepositoryAcquisitionPolicy.acquire_repository
3742
Returns an existing repository to use.
3744
self._add_fallback(self._repository,
3745
possible_transports=[self._repository.bzrdir.transport])
3746
return self._repository, False
3749
# Please register new formats after old formats so that formats
3750
# appear in chronological order and format descriptions can build
3752
format_registry = BzrDirFormatRegistry()
3753
# The pre-0.8 formats have their repository format network name registered in
3754
# repository.py. MetaDir formats have their repository format network name
3755
# inferred from their disk format string.
3756
format_registry.register('weave', BzrDirFormat6,
3757
'Pre-0.8 format. Slower than knit and does not'
3758
' support checkouts or shared repositories.',
3761
format_registry.register_metadir('metaweave',
3762
'bzrlib.repofmt.weaverepo.RepositoryFormat7',
3763
'Transitional format in 0.8. Slower than knit.',
3764
branch_format='bzrlib.branch.BzrBranchFormat5',
3765
tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3768
format_registry.register_metadir('knit',
3769
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3770
'Format using knits. Recommended for interoperation with bzr <= 0.14.',
3771
branch_format='bzrlib.branch.BzrBranchFormat5',
3772
tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3775
format_registry.register_metadir('dirstate',
3776
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3777
help='New in 0.15: Fast local operations. Compatible with bzr 0.8 and '
3778
'above when accessed over the network.',
3779
branch_format='bzrlib.branch.BzrBranchFormat5',
3780
# this uses bzrlib.workingtree.WorkingTreeFormat4 because importing
3781
# directly from workingtree_4 triggers a circular import.
3782
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3785
format_registry.register_metadir('dirstate-tags',
3786
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3787
help='New in 0.15: Fast local operations and improved scaling for '
3788
'network operations. Additionally adds support for tags.'
3789
' Incompatible with bzr < 0.15.',
3790
branch_format='bzrlib.branch.BzrBranchFormat6',
3791
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3794
format_registry.register_metadir('rich-root',
3795
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
3796
help='New in 1.0. Better handling of tree roots. Incompatible with'
3798
branch_format='bzrlib.branch.BzrBranchFormat6',
3799
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3802
format_registry.register_metadir('dirstate-with-subtree',
3803
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
3804
help='New in 0.15: Fast local operations and improved scaling for '
3805
'network operations. Additionally adds support for versioning nested '
3806
'bzr branches. Incompatible with bzr < 0.15.',
3807
branch_format='bzrlib.branch.BzrBranchFormat6',
3808
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3812
format_registry.register_metadir('pack-0.92',
3813
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack1',
3814
help='New in 0.92: Pack-based format with data compatible with '
3815
'dirstate-tags format repositories. Interoperates with '
3816
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3818
branch_format='bzrlib.branch.BzrBranchFormat6',
3819
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3821
format_registry.register_metadir('pack-0.92-subtree',
3822
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack3',
3823
help='New in 0.92: Pack-based format with data compatible with '
3824
'dirstate-with-subtree format repositories. Interoperates with '
3825
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3827
branch_format='bzrlib.branch.BzrBranchFormat6',
3828
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3832
format_registry.register_metadir('rich-root-pack',
3833
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
3834
help='New in 1.0: A variant of pack-0.92 that supports rich-root data '
3835
'(needed for bzr-svn and bzr-git).',
3836
branch_format='bzrlib.branch.BzrBranchFormat6',
3837
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3840
format_registry.register_metadir('1.6',
3841
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5',
3842
help='A format that allows a branch to indicate that there is another '
3843
'(stacked) repository that should be used to access data that is '
3844
'not present locally.',
3845
branch_format='bzrlib.branch.BzrBranchFormat7',
3846
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3849
format_registry.register_metadir('1.6.1-rich-root',
3850
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5RichRoot',
3851
help='A variant of 1.6 that supports rich-root data '
3852
'(needed for bzr-svn and bzr-git).',
3853
branch_format='bzrlib.branch.BzrBranchFormat7',
3854
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3857
format_registry.register_metadir('1.9',
3858
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3859
help='A repository format using B+tree indexes. These indexes '
3860
'are smaller in size, have smarter caching and provide faster '
3861
'performance for most operations.',
3862
branch_format='bzrlib.branch.BzrBranchFormat7',
3863
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3866
format_registry.register_metadir('1.9-rich-root',
3867
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
3868
help='A variant of 1.9 that supports rich-root data '
3869
'(needed for bzr-svn and bzr-git).',
3870
branch_format='bzrlib.branch.BzrBranchFormat7',
3871
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3874
format_registry.register_metadir('1.14',
3875
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3876
help='A working-tree format that supports content filtering.',
3877
branch_format='bzrlib.branch.BzrBranchFormat7',
3878
tree_format='bzrlib.workingtree.WorkingTreeFormat5',
3880
format_registry.register_metadir('1.14-rich-root',
3881
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
3882
help='A variant of 1.14 that supports rich-root data '
3883
'(needed for bzr-svn and bzr-git).',
3884
branch_format='bzrlib.branch.BzrBranchFormat7',
3885
tree_format='bzrlib.workingtree.WorkingTreeFormat5',
3887
# The following un-numbered 'development' formats should always just be aliases.
3888
format_registry.register_metadir('development-rich-root',
3889
'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
3890
help='Current development format. Supports rich roots. Can convert data '
3891
'to and from rich-root-pack (and anything compatible with '
3892
'rich-root-pack) format repositories. Repositories and branches in '
3893
'this format can only be read by bzr.dev. Please read '
3894
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
3896
branch_format='bzrlib.branch.BzrBranchFormat7',
3897
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3902
format_registry.register_metadir('development-subtree',
3903
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment2Subtree',
3904
help='Current development format, subtree variant. Can convert data to and '
3905
'from pack-0.92-subtree (and anything compatible with '
3906
'pack-0.92-subtree) format repositories. Repositories and branches in '
3907
'this format can only be read by bzr.dev. Please read '
3908
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
3910
branch_format='bzrlib.branch.BzrBranchFormat7',
3911
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3914
alias=False, # Restore to being an alias when an actual development subtree format is added
3915
# This current non-alias status is simply because we did not introduce a
3916
# chk based subtree format.
3919
# And the development formats above will have aliased one of the following:
3920
format_registry.register_metadir('development6-rich-root',
3921
'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
3922
help='pack-1.9 with 255-way hashed CHK inv, group compress, rich roots '
3924
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
3926
branch_format='bzrlib.branch.BzrBranchFormat7',
3927
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3932
format_registry.register_metadir('development7-rich-root',
3933
'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK2',
3934
help='pack-1.9 with 255-way hashed CHK inv, bencode revision, group compress, '
3935
'rich roots. Please read '
3936
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
3938
branch_format='bzrlib.branch.BzrBranchFormat7',
3939
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3944
format_registry.register_metadir('2a',
3945
'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
3946
help='First format for bzr 2.0 series.\n'
3947
'Uses group-compress storage.\n'
3948
'Provides rich roots which are a one-way transition.\n',
3949
# 'storage in packs, 255-way hashed CHK inventory, bencode revision, group compress, '
3950
# 'rich roots. Supported by bzr 1.16 and later.',
3951
branch_format='bzrlib.branch.BzrBranchFormat7',
3952
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3956
# The following format should be an alias for the rich root equivalent
3957
# of the default format
3958
format_registry.register_metadir('default-rich-root',
3959
'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
3960
branch_format='bzrlib.branch.BzrBranchFormat7',
3961
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3966
# The current format that is made on 'bzr init'.
3967
format_registry.set_default('2a')
added
removed
bzrlib/bzrdir.py
