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
old_path = self.root_transport.abspath('.bzr')
606
new_path = self.root_transport.abspath(backup_dir)
607
ui.ui_factory.note('making backup of %s\n to %s' % (old_path, new_path,))
608
self.root_transport.copy_tree('.bzr', backup_dir)
609
return (old_path, new_path)
613
def retire_bzrdir(self, limit=10000):
614
"""Permanently disable the bzrdir.
616
This is done by renaming it to give the user some ability to recover
617
if there was a problem.
619
This will have horrible consequences if anyone has anything locked or
621
:param limit: number of times to retry
626
to_path = '.bzr.retired.%d' % i
627
self.root_transport.rename('.bzr', to_path)
628
note("renamed %s to %s"
629
% (self.root_transport.abspath('.bzr'), to_path))
631
except (errors.TransportError, IOError, errors.PathError):
638
def destroy_workingtree(self):
639
"""Destroy the working tree at this BzrDir.
641
Formats that do not support this may raise UnsupportedOperation.
643
raise NotImplementedError(self.destroy_workingtree)
645
def destroy_workingtree_metadata(self):
646
"""Destroy the control files for the working tree at this BzrDir.
648
The contents of working tree files are not affected.
649
Formats that do not support this may raise UnsupportedOperation.
651
raise NotImplementedError(self.destroy_workingtree_metadata)
653
def _find_containing(self, evaluate):
654
"""Find something in a containing control directory.
656
This method will scan containing control dirs, until it finds what
657
it is looking for, decides that it will never find it, or runs out
658
of containing control directories to check.
660
It is used to implement find_repository and
661
determine_repository_policy.
663
:param evaluate: A function returning (value, stop). If stop is True,
664
the value will be returned.
668
result, stop = evaluate(found_bzrdir)
671
next_transport = found_bzrdir.root_transport.clone('..')
672
if (found_bzrdir.root_transport.base == next_transport.base):
673
# top of the file system
675
# find the next containing bzrdir
677
found_bzrdir = BzrDir.open_containing_from_transport(
679
except errors.NotBranchError:
682
def find_repository(self):
683
"""Find the repository that should be used.
685
This does not require a branch as we use it to find the repo for
686
new branches as well as to hook existing branches up to their
689
def usable_repository(found_bzrdir):
690
# does it have a repository ?
692
repository = found_bzrdir.open_repository()
693
except errors.NoRepositoryPresent:
695
if found_bzrdir.root_transport.base == self.root_transport.base:
696
return repository, True
697
elif repository.is_shared():
698
return repository, True
702
found_repo = self._find_containing(usable_repository)
703
if found_repo is None:
704
raise errors.NoRepositoryPresent(self)
707
def get_branch_reference(self):
708
"""Return the referenced URL for the branch in this bzrdir.
710
:raises NotBranchError: If there is no Branch.
711
:return: The URL the branch in this bzrdir references if it is a
712
reference branch, or None for regular branches.
716
def get_branch_transport(self, branch_format, name=None):
717
"""Get the transport for use by branch format in this BzrDir.
719
Note that bzr dirs that do not support format strings will raise
720
IncompatibleFormat if the branch format they are given has
721
a format string, and vice versa.
723
If branch_format is None, the transport is returned with no
724
checking. If it is not None, then the returned transport is
725
guaranteed to point to an existing directory ready for use.
727
raise NotImplementedError(self.get_branch_transport)
729
def _find_creation_modes(self):
730
"""Determine the appropriate modes for files and directories.
732
They're always set to be consistent with the base directory,
733
assuming that this transport allows setting modes.
735
# TODO: Do we need or want an option (maybe a config setting) to turn
736
# this off or override it for particular locations? -- mbp 20080512
737
if self._mode_check_done:
739
self._mode_check_done = True
741
st = self.transport.stat('.')
742
except errors.TransportNotPossible:
743
self._dir_mode = None
744
self._file_mode = None
746
# Check the directory mode, but also make sure the created
747
# directories and files are read-write for this user. This is
748
# mostly a workaround for filesystems which lie about being able to
749
# write to a directory (cygwin & win32)
750
if (st.st_mode & 07777 == 00000):
751
# FTP allows stat but does not return dir/file modes
752
self._dir_mode = None
753
self._file_mode = None
755
self._dir_mode = (st.st_mode & 07777) | 00700
756
# Remove the sticky and execute bits for files
757
self._file_mode = self._dir_mode & ~07111
759
def _get_file_mode(self):
760
"""Return Unix mode for newly created files, or None.
762
if not self._mode_check_done:
763
self._find_creation_modes()
764
return self._file_mode
766
def _get_dir_mode(self):
767
"""Return Unix mode for newly created directories, or None.
769
if not self._mode_check_done:
770
self._find_creation_modes()
771
return self._dir_mode
773
def get_repository_transport(self, repository_format):
774
"""Get the transport for use by repository format in this BzrDir.
776
Note that bzr dirs that do not support format strings will raise
777
IncompatibleFormat if the repository format they are given has
778
a format string, and vice versa.
780
If repository_format is None, the transport is returned with no
781
checking. If it is not None, then the returned transport is
782
guaranteed to point to an existing directory ready for use.
784
raise NotImplementedError(self.get_repository_transport)
786
def get_workingtree_transport(self, tree_format):
787
"""Get the transport for use by workingtree format in this BzrDir.
789
Note that bzr dirs that do not support format strings will raise
790
IncompatibleFormat if the workingtree format they are given has a
791
format string, and vice versa.
793
If workingtree_format is None, the transport is returned with no
794
checking. If it is not None, then the returned transport is
795
guaranteed to point to an existing directory ready for use.
797
raise NotImplementedError(self.get_workingtree_transport)
799
def get_config(self):
800
"""Get configuration for this BzrDir."""
801
return config.BzrDirConfig(self)
803
def _get_config(self):
804
"""By default, no configuration is available."""
807
def __init__(self, _transport, _format):
808
"""Initialize a Bzr control dir object.
810
Only really common logic should reside here, concrete classes should be
811
made with varying behaviours.
813
:param _format: the format that is creating this BzrDir instance.
814
:param _transport: the transport this dir is based at.
816
self._format = _format
817
self.transport = _transport.clone('.bzr')
818
self.root_transport = _transport
819
self._mode_check_done = False
821
def is_control_filename(self, filename):
822
"""True if filename is the name of a path which is reserved for bzrdir's.
824
:param filename: A filename within the root transport of this bzrdir.
826
This is true IF and ONLY IF the filename is part of the namespace reserved
827
for bzr control dirs. Currently this is the '.bzr' directory in the root
828
of the root_transport. it is expected that plugins will need to extend
829
this in the future - for instance to make bzr talk with svn working
832
# this might be better on the BzrDirFormat class because it refers to
833
# all the possible bzrdir disk formats.
834
# This method is tested via the workingtree is_control_filename tests-
835
# it was extracted from WorkingTree.is_control_filename. If the method's
836
# contract is extended beyond the current trivial implementation, please
837
# add new tests for it to the appropriate place.
838
return filename == '.bzr' or filename.startswith('.bzr/')
840
def needs_format_conversion(self, format=None):
841
"""Return true if this bzrdir needs convert_format run on it.
843
For instance, if the repository format is out of date but the
844
branch and working tree are not, this should return True.
846
:param format: Optional parameter indicating a specific desired
847
format we plan to arrive at.
849
raise NotImplementedError(self.needs_format_conversion)
852
def open_unsupported(base):
853
"""Open a branch which is not supported."""
854
return BzrDir.open(base, _unsupported=True)
857
def open(base, _unsupported=False, possible_transports=None):
858
"""Open an existing bzrdir, rooted at 'base' (url).
860
:param _unsupported: a private parameter to the BzrDir class.
862
t = get_transport(base, possible_transports=possible_transports)
863
return BzrDir.open_from_transport(t, _unsupported=_unsupported)
866
def open_from_transport(transport, _unsupported=False,
867
_server_formats=True):
868
"""Open a bzrdir within a particular directory.
870
:param transport: Transport containing the bzrdir.
871
:param _unsupported: private.
873
for hook in BzrDir.hooks['pre_open']:
875
# Keep initial base since 'transport' may be modified while following
877
base = transport.base
878
def find_format(transport):
879
return transport, BzrDirFormat.find_format(
880
transport, _server_formats=_server_formats)
882
def redirected(transport, e, redirection_notice):
883
redirected_transport = transport._redirected_to(e.source, e.target)
884
if redirected_transport is None:
885
raise errors.NotBranchError(base)
886
note('%s is%s redirected to %s',
887
transport.base, e.permanently, redirected_transport.base)
888
return redirected_transport
891
transport, format = do_catching_redirections(find_format,
894
except errors.TooManyRedirections:
895
raise errors.NotBranchError(base)
897
BzrDir._check_supported(format, _unsupported)
898
return format.open(transport, _found=True)
900
def open_branch(self, name=None, unsupported=False,
901
ignore_fallbacks=False):
902
"""Open the branch object at this BzrDir if one is present.
904
If unsupported is True, then no longer supported branch formats can
907
TODO: static convenience version of this?
909
raise NotImplementedError(self.open_branch)
912
def open_containing(url, possible_transports=None):
913
"""Open an existing branch which contains url.
915
:param url: url to search from.
916
See open_containing_from_transport for more detail.
918
transport = get_transport(url, possible_transports)
919
return BzrDir.open_containing_from_transport(transport)
922
def open_containing_from_transport(a_transport):
923
"""Open an existing branch which contains a_transport.base.
925
This probes for a branch at a_transport, and searches upwards from there.
927
Basically we keep looking up until we find the control directory or
928
run into the root. If there isn't one, raises NotBranchError.
929
If there is one and it is either an unrecognised format or an unsupported
930
format, UnknownFormatError or UnsupportedFormatError are raised.
931
If there is one, it is returned, along with the unused portion of url.
933
:return: The BzrDir that contains the path, and a Unicode path
934
for the rest of the URL.
936
# this gets the normalised url back. I.e. '.' -> the full path.
937
url = a_transport.base
940
result = BzrDir.open_from_transport(a_transport)
941
return result, urlutils.unescape(a_transport.relpath(url))
942
except errors.NotBranchError, e:
945
new_t = a_transport.clone('..')
946
except errors.InvalidURLJoin:
947
# reached the root, whatever that may be
948
raise errors.NotBranchError(path=url)
949
if new_t.base == a_transport.base:
950
# reached the root, whatever that may be
951
raise errors.NotBranchError(path=url)
954
def _get_tree_branch(self):
955
"""Return the branch and tree, if any, for this bzrdir.
957
Return None for tree if not present or inaccessible.
958
Raise NotBranchError if no branch is present.
959
:return: (tree, branch)
962
tree = self.open_workingtree()
963
except (errors.NoWorkingTree, errors.NotLocalUrl):
965
branch = self.open_branch()
971
def open_tree_or_branch(klass, location):
972
"""Return the branch and working tree at a location.
974
If there is no tree at the location, tree will be None.
975
If there is no branch at the location, an exception will be
977
:return: (tree, branch)
979
bzrdir = klass.open(location)
980
return bzrdir._get_tree_branch()
983
def open_containing_tree_or_branch(klass, location):
984
"""Return the branch and working tree contained by a location.
986
Returns (tree, branch, relpath).
987
If there is no tree at containing the location, tree will be None.
988
If there is no branch containing the location, an exception will be
990
relpath is the portion of the path that is contained by the branch.
992
bzrdir, relpath = klass.open_containing(location)
993
tree, branch = bzrdir._get_tree_branch()
994
return tree, branch, relpath
997
def open_containing_tree_branch_or_repository(klass, location):
998
"""Return the working tree, branch and repo contained by a location.
1000
Returns (tree, branch, repository, relpath).
1001
If there is no tree containing the location, tree will be None.
1002
If there is no branch containing the location, branch will be None.
1003
If there is no repository containing the location, repository will be
1005
relpath is the portion of the path that is contained by the innermost
1008
If no tree, branch or repository is found, a NotBranchError is raised.
1010
bzrdir, relpath = klass.open_containing(location)
1012
tree, branch = bzrdir._get_tree_branch()
1013
except errors.NotBranchError:
1015
repo = bzrdir.find_repository()
1016
return None, None, repo, relpath
1017
except (errors.NoRepositoryPresent):
1018
raise errors.NotBranchError(location)
1019
return tree, branch, branch.repository, relpath
1021
def open_repository(self, _unsupported=False):
1022
"""Open the repository object at this BzrDir if one is present.
1024
This will not follow the Branch object pointer - it's strictly a direct
1025
open facility. Most client code should use open_branch().repository to
1026
get at a repository.
1028
:param _unsupported: a private parameter, not part of the api.
1029
TODO: static convenience version of this?
1031
raise NotImplementedError(self.open_repository)
1033
def open_workingtree(self, _unsupported=False,
1034
recommend_upgrade=True, from_branch=None):
1035
"""Open the workingtree object at this BzrDir if one is present.
1037
:param recommend_upgrade: Optional keyword parameter, when True (the
1038
default), emit through the ui module a recommendation that the user
1039
upgrade the working tree when the workingtree being opened is old
1040
(but still fully supported).
1041
:param from_branch: override bzrdir branch (for lightweight checkouts)
1043
raise NotImplementedError(self.open_workingtree)
1045
def has_branch(self, name=None):
1046
"""Tell if this bzrdir contains a branch.
1048
Note: if you're going to open the branch, you should just go ahead
1049
and try, and not ask permission first. (This method just opens the
1050
branch and discards it, and that's somewhat expensive.)
1053
self.open_branch(name)
1055
except errors.NotBranchError:
1058
def has_workingtree(self):
1059
"""Tell if this bzrdir contains a working tree.
1061
This will still raise an exception if the bzrdir has a workingtree that
1062
is remote & inaccessible.
1064
Note: if you're going to open the working tree, you should just go ahead
1065
and try, and not ask permission first. (This method just opens the
1066
workingtree and discards it, and that's somewhat expensive.)
1069
self.open_workingtree(recommend_upgrade=False)
1071
except errors.NoWorkingTree:
1074
def _cloning_metadir(self):
1075
"""Produce a metadir suitable for cloning with.
1077
:returns: (destination_bzrdir_format, source_repository)
1079
result_format = self._format.__class__()
1082
branch = self.open_branch(ignore_fallbacks=True)
1083
source_repository = branch.repository
1084
result_format._branch_format = branch._format
1085
except errors.NotBranchError:
1086
source_branch = None
1087
source_repository = self.open_repository()
1088
except errors.NoRepositoryPresent:
1089
source_repository = None
1091
# XXX TODO: This isinstance is here because we have not implemented
1092
# the fix recommended in bug # 103195 - to delegate this choice the
1093
# repository itself.
1094
repo_format = source_repository._format
1095
if isinstance(repo_format, remote.RemoteRepositoryFormat):
1096
source_repository._ensure_real()
1097
repo_format = source_repository._real_repository._format
1098
result_format.repository_format = repo_format
1100
# TODO: Couldn't we just probe for the format in these cases,
1101
# rather than opening the whole tree? It would be a little
1102
# faster. mbp 20070401
1103
tree = self.open_workingtree(recommend_upgrade=False)
1104
except (errors.NoWorkingTree, errors.NotLocalUrl):
1105
result_format.workingtree_format = None
1107
result_format.workingtree_format = tree._format.__class__()
1108
return result_format, source_repository
1110
def cloning_metadir(self, require_stacking=False):
1111
"""Produce a metadir suitable for cloning or sprouting with.
1113
These operations may produce workingtrees (yes, even though they're
1114
"cloning" something that doesn't have a tree), so a viable workingtree
1115
format must be selected.
1117
:require_stacking: If True, non-stackable formats will be upgraded
1118
to similar stackable formats.
1119
:returns: a BzrDirFormat with all component formats either set
1120
appropriately or set to None if that component should not be
1123
format, repository = self._cloning_metadir()
1124
if format._workingtree_format is None:
1126
if repository is None:
1127
# No repository either
1129
# We have a repository, so set a working tree? (Why? This seems to
1130
# contradict the stated return value in the docstring).
1131
tree_format = repository._format._matchingbzrdir.workingtree_format
1132
format.workingtree_format = tree_format.__class__()
1133
if require_stacking:
1134
format.require_stacking()
1137
def checkout_metadir(self):
1138
return self.cloning_metadir()
1140
def sprout(self, url, revision_id=None, force_new_repo=False,
1141
recurse='down', possible_transports=None,
1142
accelerator_tree=None, hardlink=False, stacked=False,
1143
source_branch=None, create_tree_if_local=True):
1144
"""Create a copy of this bzrdir prepared for use as a new line of
1147
If url's last component does not exist, it will be created.
1149
Attributes related to the identity of the source branch like
1150
branch nickname will be cleaned, a working tree is created
1151
whether one existed before or not; and a local branch is always
1154
if revision_id is not None, then the clone operation may tune
1155
itself to download less data.
1156
:param accelerator_tree: A tree which can be used for retrieving file
1157
contents more quickly than the revision tree, i.e. a workingtree.
1158
The revision tree will be used for cases where accelerator_tree's
1159
content is different.
1160
:param hardlink: If true, hard-link files from accelerator_tree,
1162
:param stacked: If true, create a stacked branch referring to the
1163
location of this control directory.
1164
:param create_tree_if_local: If true, a working-tree will be created
1165
when working locally.
1167
target_transport = get_transport(url, possible_transports)
1168
target_transport.ensure_base()
1169
cloning_format = self.cloning_metadir(stacked)
1170
# Create/update the result branch
1171
result = cloning_format.initialize_on_transport(target_transport)
1172
# if a stacked branch wasn't requested, we don't create one
1173
# even if the origin was stacked
1174
stacked_branch_url = None
1175
if source_branch is not None:
1177
stacked_branch_url = self.root_transport.base
1178
source_repository = source_branch.repository
1181
source_branch = self.open_branch()
1182
source_repository = source_branch.repository
1184
stacked_branch_url = self.root_transport.base
1185
except errors.NotBranchError:
1186
source_branch = None
1188
source_repository = self.open_repository()
1189
except errors.NoRepositoryPresent:
1190
source_repository = None
1191
repository_policy = result.determine_repository_policy(
1192
force_new_repo, stacked_branch_url, require_stacking=stacked)
1193
result_repo, is_new_repo = repository_policy.acquire_repository()
1194
if is_new_repo and revision_id is not None and not stacked:
1195
fetch_spec = graph.PendingAncestryResult(
1196
[revision_id], source_repository)
1199
if source_repository is not None:
1200
# Fetch while stacked to prevent unstacked fetch from
1202
if fetch_spec is None:
1203
result_repo.fetch(source_repository, revision_id=revision_id)
1205
result_repo.fetch(source_repository, fetch_spec=fetch_spec)
1207
if source_branch is None:
1208
# this is for sprouting a bzrdir without a branch; is that
1210
# Not especially, but it's part of the contract.
1211
result_branch = result.create_branch()
1213
result_branch = source_branch.sprout(result,
1214
revision_id=revision_id, repository_policy=repository_policy)
1215
mutter("created new branch %r" % (result_branch,))
1217
# Create/update the result working tree
1218
if (create_tree_if_local and
1219
isinstance(target_transport, local.LocalTransport) and
1220
(result_repo is None or result_repo.make_working_trees())):
1221
wt = result.create_workingtree(accelerator_tree=accelerator_tree,
1225
if wt.path2id('') is None:
1227
wt.set_root_id(self.open_workingtree.get_root_id())
1228
except errors.NoWorkingTree:
1234
if recurse == 'down':
1236
basis = wt.basis_tree()
1238
subtrees = basis.iter_references()
1239
elif result_branch is not None:
1240
basis = result_branch.basis_tree()
1242
subtrees = basis.iter_references()
1243
elif source_branch is not None:
1244
basis = source_branch.basis_tree()
1246
subtrees = basis.iter_references()
1251
for path, file_id in subtrees:
1252
target = urlutils.join(url, urlutils.escape(path))
1253
sublocation = source_branch.reference_parent(file_id, path)
1254
sublocation.bzrdir.sprout(target,
1255
basis.get_reference_revision(file_id, path),
1256
force_new_repo=force_new_repo, recurse=recurse,
1259
if basis is not None:
1263
def push_branch(self, source, revision_id=None, overwrite=False,
1264
remember=False, create_prefix=False):
1265
"""Push the source branch into this BzrDir."""
1267
# If we can open a branch, use its direct repository, otherwise see
1268
# if there is a repository without a branch.
1270
br_to = self.open_branch()
1271
except errors.NotBranchError:
1272
# Didn't find a branch, can we find a repository?
1273
repository_to = self.find_repository()
1275
# Found a branch, so we must have found a repository
1276
repository_to = br_to.repository
1278
push_result = PushResult()
1279
push_result.source_branch = source
1281
# We have a repository but no branch, copy the revisions, and then
1283
repository_to.fetch(source.repository, revision_id=revision_id)
1284
br_to = source.clone(self, revision_id=revision_id)
1285
if source.get_push_location() is None or remember:
1286
source.set_push_location(br_to.base)
1287
push_result.stacked_on = None
1288
push_result.branch_push_result = None
1289
push_result.old_revno = None
1290
push_result.old_revid = _mod_revision.NULL_REVISION
1291
push_result.target_branch = br_to
1292
push_result.master_branch = None
1293
push_result.workingtree_updated = False
1295
# We have successfully opened the branch, remember if necessary:
1296
if source.get_push_location() is None or remember:
1297
source.set_push_location(br_to.base)
1299
tree_to = self.open_workingtree()
1300
except errors.NotLocalUrl:
1301
push_result.branch_push_result = source.push(br_to,
1302
overwrite, stop_revision=revision_id)
1303
push_result.workingtree_updated = False
1304
except errors.NoWorkingTree:
1305
push_result.branch_push_result = source.push(br_to,
1306
overwrite, stop_revision=revision_id)
1307
push_result.workingtree_updated = None # Not applicable
1309
tree_to.lock_write()
1311
push_result.branch_push_result = source.push(
1312
tree_to.branch, overwrite, stop_revision=revision_id)
1316
push_result.workingtree_updated = True
1317
push_result.old_revno = push_result.branch_push_result.old_revno
1318
push_result.old_revid = push_result.branch_push_result.old_revid
1319
push_result.target_branch = \
1320
push_result.branch_push_result.target_branch
1324
class BzrDirHooks(hooks.Hooks):
1325
"""Hooks for BzrDir operations."""
1328
"""Create the default hooks."""
1329
hooks.Hooks.__init__(self)
1330
self.create_hook(hooks.HookPoint('pre_open',
1331
"Invoked before attempting to open a BzrDir with the transport "
1332
"that the open will use.", (1, 14), None))
1334
# install the default hooks
1335
BzrDir.hooks = BzrDirHooks()
1338
class BzrDirPreSplitOut(BzrDir):
1339
"""A common class for the all-in-one formats."""
1341
def __init__(self, _transport, _format):
1342
"""See BzrDir.__init__."""
1343
super(BzrDirPreSplitOut, self).__init__(_transport, _format)
1344
self._control_files = lockable_files.LockableFiles(
1345
self.get_branch_transport(None),
1346
self._format._lock_file_name,
1347
self._format._lock_class)
1349
def break_lock(self):
1350
"""Pre-splitout bzrdirs do not suffer from stale locks."""
1351
raise NotImplementedError(self.break_lock)
1353
def cloning_metadir(self, require_stacking=False):
1354
"""Produce a metadir suitable for cloning with."""
1355
if require_stacking:
1356
return format_registry.make_bzrdir('1.6')
1357
return self._format.__class__()
1359
def clone(self, url, revision_id=None, force_new_repo=False,
1360
preserve_stacking=False):
1361
"""See BzrDir.clone().
1363
force_new_repo has no effect, since this family of formats always
1364
require a new repository.
1365
preserve_stacking has no effect, since no source branch using this
1366
family of formats can be stacked, so there is no stacking to preserve.
1368
self._make_tail(url)
1369
result = self._format._initialize_for_clone(url)
1370
self.open_repository().clone(result, revision_id=revision_id)
1371
from_branch = self.open_branch()
1372
from_branch.clone(result, revision_id=revision_id)
1374
tree = self.open_workingtree()
1375
except errors.NotLocalUrl:
1376
# make a new one, this format always has to have one.
1377
result._init_workingtree()
1382
def create_branch(self, name=None):
1383
"""See BzrDir.create_branch."""
1384
return self._format.get_branch_format().initialize(self, name=name)
1386
def destroy_branch(self, name=None):
1387
"""See BzrDir.destroy_branch."""
1388
raise errors.UnsupportedOperation(self.destroy_branch, self)
1390
def create_repository(self, shared=False):
1391
"""See BzrDir.create_repository."""
1393
raise errors.IncompatibleFormat('shared repository', self._format)
1394
return self.open_repository()
1396
def destroy_repository(self):
1397
"""See BzrDir.destroy_repository."""
1398
raise errors.UnsupportedOperation(self.destroy_repository, self)
1400
def create_workingtree(self, revision_id=None, from_branch=None,
1401
accelerator_tree=None, hardlink=False):
1402
"""See BzrDir.create_workingtree."""
1403
# The workingtree is sometimes created when the bzrdir is created,
1404
# but not when cloning.
1406
# this looks buggy but is not -really-
1407
# because this format creates the workingtree when the bzrdir is
1409
# clone and sprout will have set the revision_id
1410
# and that will have set it for us, its only
1411
# specific uses of create_workingtree in isolation
1412
# that can do wonky stuff here, and that only
1413
# happens for creating checkouts, which cannot be
1414
# done on this format anyway. So - acceptable wart.
1416
warning("can't support hardlinked working trees in %r"
1419
result = self.open_workingtree(recommend_upgrade=False)
1420
except errors.NoSuchFile:
1421
result = self._init_workingtree()
1422
if revision_id is not None:
1423
if revision_id == _mod_revision.NULL_REVISION:
1424
result.set_parent_ids([])
1426
result.set_parent_ids([revision_id])
1429
def _init_workingtree(self):
1430
from bzrlib.workingtree import WorkingTreeFormat2
1432
return WorkingTreeFormat2().initialize(self)
1433
except errors.NotLocalUrl:
1434
# Even though we can't access the working tree, we need to
1435
# create its control files.
1436
return WorkingTreeFormat2()._stub_initialize_on_transport(
1437
self.transport, self._control_files._file_mode)
1439
def destroy_workingtree(self):
1440
"""See BzrDir.destroy_workingtree."""
1441
raise errors.UnsupportedOperation(self.destroy_workingtree, self)
1443
def destroy_workingtree_metadata(self):
1444
"""See BzrDir.destroy_workingtree_metadata."""
1445
raise errors.UnsupportedOperation(self.destroy_workingtree_metadata,
1448
def get_branch_transport(self, branch_format, name=None):
1449
"""See BzrDir.get_branch_transport()."""
1450
if name is not None:
1451
raise errors.NoColocatedBranchSupport(self)
1452
if branch_format is None:
1453
return self.transport
1455
branch_format.get_format_string()
1456
except NotImplementedError:
1457
return self.transport
1458
raise errors.IncompatibleFormat(branch_format, self._format)
1460
def get_repository_transport(self, repository_format):
1461
"""See BzrDir.get_repository_transport()."""
1462
if repository_format is None:
1463
return self.transport
1465
repository_format.get_format_string()
1466
except NotImplementedError:
1467
return self.transport
1468
raise errors.IncompatibleFormat(repository_format, self._format)
1470
def get_workingtree_transport(self, workingtree_format):
1471
"""See BzrDir.get_workingtree_transport()."""
1472
if workingtree_format is None:
1473
return self.transport
1475
workingtree_format.get_format_string()
1476
except NotImplementedError:
1477
return self.transport
1478
raise errors.IncompatibleFormat(workingtree_format, self._format)
1480
def needs_format_conversion(self, format=None):
1481
"""See BzrDir.needs_format_conversion()."""
1482
# if the format is not the same as the system default,
1483
# an upgrade is needed.
1485
symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1486
% 'needs_format_conversion(format=None)')
1487
format = BzrDirFormat.get_default_format()
1488
return not isinstance(self._format, format.__class__)
1490
def open_branch(self, name=None, unsupported=False,
1491
ignore_fallbacks=False):
1492
"""See BzrDir.open_branch."""
1493
from bzrlib.branch import BzrBranchFormat4
1494
format = BzrBranchFormat4()
1495
self._check_supported(format, unsupported)
1496
return format.open(self, name, _found=True)
1498
def sprout(self, url, revision_id=None, force_new_repo=False,
1499
possible_transports=None, accelerator_tree=None,
1500
hardlink=False, stacked=False, create_tree_if_local=True,
1501
source_branch=None):
1502
"""See BzrDir.sprout()."""
1503
if source_branch is not None:
1504
my_branch = self.open_branch()
1505
if source_branch.base != my_branch.base:
1506
raise AssertionError(
1507
"source branch %r is not within %r with branch %r" %
1508
(source_branch, self, my_branch))
1510
raise errors.UnstackableBranchFormat(
1511
self._format, self.root_transport.base)
1512
if not create_tree_if_local:
1513
raise errors.MustHaveWorkingTree(
1514
self._format, self.root_transport.base)
1515
from bzrlib.workingtree import WorkingTreeFormat2
1516
self._make_tail(url)
1517
result = self._format._initialize_for_clone(url)
1519
self.open_repository().clone(result, revision_id=revision_id)
1520
except errors.NoRepositoryPresent:
1523
self.open_branch().sprout(result, revision_id=revision_id)
1524
except errors.NotBranchError:
1527
# we always want a working tree
1528
WorkingTreeFormat2().initialize(result,
1529
accelerator_tree=accelerator_tree,
1534
class BzrDir4(BzrDirPreSplitOut):
1535
"""A .bzr version 4 control object.
1537
This is a deprecated format and may be removed after sept 2006.
1540
def create_repository(self, shared=False):
1541
"""See BzrDir.create_repository."""
1542
return self._format.repository_format.initialize(self, shared)
1544
def needs_format_conversion(self, format=None):
1545
"""Format 4 dirs are always in need of conversion."""
1547
symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1548
% 'needs_format_conversion(format=None)')
1551
def open_repository(self):
1552
"""See BzrDir.open_repository."""
1553
from bzrlib.repofmt.weaverepo import RepositoryFormat4
1554
return RepositoryFormat4().open(self, _found=True)
1557
class BzrDir5(BzrDirPreSplitOut):
1558
"""A .bzr version 5 control object.
1560
This is a deprecated format and may be removed after sept 2006.
1563
def has_workingtree(self):
1564
"""See BzrDir.has_workingtree."""
1567
def open_repository(self):
1568
"""See BzrDir.open_repository."""
1569
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1570
return RepositoryFormat5().open(self, _found=True)
1572
def open_workingtree(self, _unsupported=False,
1573
recommend_upgrade=True):
1574
"""See BzrDir.create_workingtree."""
1575
from bzrlib.workingtree import WorkingTreeFormat2
1576
wt_format = WorkingTreeFormat2()
1577
# we don't warn here about upgrades; that ought to be handled for the
1579
return wt_format.open(self, _found=True)
1582
class BzrDir6(BzrDirPreSplitOut):
1583
"""A .bzr version 6 control object.
1585
This is a deprecated format and may be removed after sept 2006.
1588
def has_workingtree(self):
1589
"""See BzrDir.has_workingtree."""
1592
def open_repository(self):
1593
"""See BzrDir.open_repository."""
1594
from bzrlib.repofmt.weaverepo import RepositoryFormat6
1595
return RepositoryFormat6().open(self, _found=True)
1597
def open_workingtree(self, _unsupported=False,
1598
recommend_upgrade=True):
1599
"""See BzrDir.create_workingtree."""
1600
# we don't warn here about upgrades; that ought to be handled for the
1602
from bzrlib.workingtree import WorkingTreeFormat2
1603
return WorkingTreeFormat2().open(self, _found=True)
1606
class BzrDirMeta1(BzrDir):
1607
"""A .bzr meta version 1 control object.
1609
This is the first control object where the
1610
individual aspects are really split out: there are separate repository,
1611
workingtree and branch subdirectories and any subset of the three can be
1612
present within a BzrDir.
1615
def can_convert_format(self):
1616
"""See BzrDir.can_convert_format()."""
1619
def create_branch(self, name=None):
1620
"""See BzrDir.create_branch."""
1621
return self._format.get_branch_format().initialize(self, name=name)
1623
def destroy_branch(self, name=None):
1624
"""See BzrDir.create_branch."""
1625
if name is not None:
1626
raise errors.NoColocatedBranchSupport(self)
1627
self.transport.delete_tree('branch')
1629
def create_repository(self, shared=False):
1630
"""See BzrDir.create_repository."""
1631
return self._format.repository_format.initialize(self, shared)
1633
def destroy_repository(self):
1634
"""See BzrDir.destroy_repository."""
1635
self.transport.delete_tree('repository')
1637
def create_workingtree(self, revision_id=None, from_branch=None,
1638
accelerator_tree=None, hardlink=False):
1639
"""See BzrDir.create_workingtree."""
1640
return self._format.workingtree_format.initialize(
1641
self, revision_id, from_branch=from_branch,
1642
accelerator_tree=accelerator_tree, hardlink=hardlink)
1644
def destroy_workingtree(self):
1645
"""See BzrDir.destroy_workingtree."""
1646
wt = self.open_workingtree(recommend_upgrade=False)
1647
repository = wt.branch.repository
1648
empty = repository.revision_tree(_mod_revision.NULL_REVISION)
1649
wt.revert(old_tree=empty)
1650
self.destroy_workingtree_metadata()
1652
def destroy_workingtree_metadata(self):
1653
self.transport.delete_tree('checkout')
1655
def find_branch_format(self):
1656
"""Find the branch 'format' for this bzrdir.
1658
This might be a synthetic object for e.g. RemoteBranch and SVN.
1660
from bzrlib.branch import BranchFormat
1661
return BranchFormat.find_format(self)
1663
def _get_mkdir_mode(self):
1664
"""Figure out the mode to use when creating a bzrdir subdir."""
1665
temp_control = lockable_files.LockableFiles(self.transport, '',
1666
lockable_files.TransportLock)
1667
return temp_control._dir_mode
1669
def get_branch_reference(self):
1670
"""See BzrDir.get_branch_reference()."""
1671
from bzrlib.branch import BranchFormat
1672
format = BranchFormat.find_format(self)
1673
return format.get_reference(self)
1675
def get_branch_transport(self, branch_format, name=None):
1676
"""See BzrDir.get_branch_transport()."""
1677
if name is not None:
1678
raise errors.NoColocatedBranchSupport(self)
1679
# XXX: this shouldn't implicitly create the directory if it's just
1680
# promising to get a transport -- mbp 20090727
1681
if branch_format is None:
1682
return self.transport.clone('branch')
1684
branch_format.get_format_string()
1685
except NotImplementedError:
1686
raise errors.IncompatibleFormat(branch_format, self._format)
1688
self.transport.mkdir('branch', mode=self._get_mkdir_mode())
1689
except errors.FileExists:
1691
return self.transport.clone('branch')
1693
def get_repository_transport(self, repository_format):
1694
"""See BzrDir.get_repository_transport()."""
1695
if repository_format is None:
1696
return self.transport.clone('repository')
1698
repository_format.get_format_string()
1699
except NotImplementedError:
1700
raise errors.IncompatibleFormat(repository_format, self._format)
1702
self.transport.mkdir('repository', mode=self._get_mkdir_mode())
1703
except errors.FileExists:
1705
return self.transport.clone('repository')
1707
def get_workingtree_transport(self, workingtree_format):
1708
"""See BzrDir.get_workingtree_transport()."""
1709
if workingtree_format is None:
1710
return self.transport.clone('checkout')
1712
workingtree_format.get_format_string()
1713
except NotImplementedError:
1714
raise errors.IncompatibleFormat(workingtree_format, self._format)
1716
self.transport.mkdir('checkout', mode=self._get_mkdir_mode())
1717
except errors.FileExists:
1719
return self.transport.clone('checkout')
1721
def has_workingtree(self):
1722
"""Tell if this bzrdir contains a working tree.
1724
This will still raise an exception if the bzrdir has a workingtree that
1725
is remote & inaccessible.
1727
Note: if you're going to open the working tree, you should just go
1728
ahead and try, and not ask permission first.
1730
from bzrlib.workingtree import WorkingTreeFormat
1732
WorkingTreeFormat.find_format(self)
1733
except errors.NoWorkingTree:
1737
def needs_format_conversion(self, format=None):
1738
"""See BzrDir.needs_format_conversion()."""
1740
symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1741
% 'needs_format_conversion(format=None)')
1743
format = BzrDirFormat.get_default_format()
1744
if not isinstance(self._format, format.__class__):
1745
# it is not a meta dir format, conversion is needed.
1747
# we might want to push this down to the repository?
1749
if not isinstance(self.open_repository()._format,
1750
format.repository_format.__class__):
1751
# the repository needs an upgrade.
1753
except errors.NoRepositoryPresent:
1755
for branch in self.list_branches():
1756
if not isinstance(branch._format,
1757
format.get_branch_format().__class__):
1758
# the branch needs an upgrade.
1761
my_wt = self.open_workingtree(recommend_upgrade=False)
1762
if not isinstance(my_wt._format,
1763
format.workingtree_format.__class__):
1764
# the workingtree needs an upgrade.
1766
except (errors.NoWorkingTree, errors.NotLocalUrl):
1770
def open_branch(self, name=None, unsupported=False,
1771
ignore_fallbacks=False):
1772
"""See BzrDir.open_branch."""
1773
format = self.find_branch_format()
1774
self._check_supported(format, unsupported)
1775
return format.open(self, name=name,
1776
_found=True, ignore_fallbacks=ignore_fallbacks)
1778
def open_repository(self, unsupported=False):
1779
"""See BzrDir.open_repository."""
1780
from bzrlib.repository import RepositoryFormat
1781
format = RepositoryFormat.find_format(self)
1782
self._check_supported(format, unsupported)
1783
return format.open(self, _found=True)
1785
def open_workingtree(self, unsupported=False,
1786
recommend_upgrade=True):
1787
"""See BzrDir.open_workingtree."""
1788
from bzrlib.workingtree import WorkingTreeFormat
1789
format = WorkingTreeFormat.find_format(self)
1790
self._check_supported(format, unsupported,
1792
basedir=self.root_transport.base)
1793
return format.open(self, _found=True)
1795
def _get_config(self):
1796
return config.TransportConfig(self.transport, 'control.conf')
1799
class BzrDirFormat(object):
1800
"""An encapsulation of the initialization and open routines for a format.
1802
Formats provide three things:
1803
* An initialization routine,
1807
Formats are placed in a dict by their format string for reference
1808
during bzrdir opening. These should be subclasses of BzrDirFormat
1811
Once a format is deprecated, just deprecate the initialize and open
1812
methods on the format class. Do not deprecate the object, as the
1813
object will be created every system load.
1815
:cvar colocated_branches: Whether this formats supports colocated branches.
1818
_default_format = None
1819
"""The default format used for new .bzr dirs."""
1822
"""The known formats."""
1824
_control_formats = []
1825
"""The registered control formats - .bzr, ....
1827
This is a list of BzrDirFormat objects.
1830
_control_server_formats = []
1831
"""The registered control server formats, e.g. RemoteBzrDirs.
1833
This is a list of BzrDirFormat objects.
1836
_lock_file_name = 'branch-lock'
1838
colocated_branches = False
1839
"""Whether co-located branches are supported for this control dir format.
1842
# _lock_class must be set in subclasses to the lock type, typ.
1843
# TransportLock or LockDir
1846
def find_format(klass, transport, _server_formats=True):
1847
"""Return the format present at transport."""
1849
formats = klass._control_server_formats + klass._control_formats
1851
formats = klass._control_formats
1852
for format in formats:
1854
return format.probe_transport(transport)
1855
except errors.NotBranchError:
1856
# this format does not find a control dir here.
1858
raise errors.NotBranchError(path=transport.base)
1861
def probe_transport(klass, transport):
1862
"""Return the .bzrdir style format present in a directory."""
1864
format_string = transport.get_bytes(".bzr/branch-format")
1865
except errors.NoSuchFile:
1866
raise errors.NotBranchError(path=transport.base)
1869
return klass._formats[format_string]
1871
raise errors.UnknownFormatError(format=format_string, kind='bzrdir')
1874
def get_default_format(klass):
1875
"""Return the current default format."""
1876
return klass._default_format
1878
def get_format_string(self):
1879
"""Return the ASCII format string that identifies this format."""
1880
raise NotImplementedError(self.get_format_string)
1882
def get_format_description(self):
1883
"""Return the short description for this format."""
1884
raise NotImplementedError(self.get_format_description)
1886
def get_converter(self, format=None):
1887
"""Return the converter to use to convert bzrdirs needing converts.
1889
This returns a bzrlib.bzrdir.Converter object.
1891
This should return the best upgrader to step this format towards the
1892
current default format. In the case of plugins we can/should provide
1893
some means for them to extend the range of returnable converters.
1895
:param format: Optional format to override the default format of the
1898
raise NotImplementedError(self.get_converter)
1900
def initialize(self, url, possible_transports=None):
1901
"""Create a bzr control dir at this url and return an opened copy.
1903
While not deprecated, this method is very specific and its use will
1904
lead to many round trips to setup a working environment. See
1905
initialize_on_transport_ex for a [nearly] all-in-one method.
1907
Subclasses should typically override initialize_on_transport
1908
instead of this method.
1910
return self.initialize_on_transport(get_transport(url,
1911
possible_transports))
1913
def initialize_on_transport(self, transport):
1914
"""Initialize a new bzrdir in the base directory of a Transport."""
1916
# can we hand off the request to the smart server rather than using
1918
client_medium = transport.get_smart_medium()
1919
except errors.NoSmartMedium:
1920
return self._initialize_on_transport_vfs(transport)
1922
# Current RPC's only know how to create bzr metadir1 instances, so
1923
# we still delegate to vfs methods if the requested format is not a
1925
if type(self) != BzrDirMetaFormat1:
1926
return self._initialize_on_transport_vfs(transport)
1927
remote_format = RemoteBzrDirFormat()
1928
self._supply_sub_formats_to(remote_format)
1929
return remote_format.initialize_on_transport(transport)
1931
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
1932
create_prefix=False, force_new_repo=False, stacked_on=None,
1933
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
1934
shared_repo=False, vfs_only=False):
1935
"""Create this format on transport.
1937
The directory to initialize will be created.
1939
:param force_new_repo: Do not use a shared repository for the target,
1940
even if one is available.
1941
:param create_prefix: Create any missing directories leading up to
1943
:param use_existing_dir: Use an existing directory if one exists.
1944
:param stacked_on: A url to stack any created branch on, None to follow
1945
any target stacking policy.
1946
:param stack_on_pwd: If stack_on is relative, the location it is
1948
:param repo_format_name: If non-None, a repository will be
1949
made-or-found. Should none be found, or if force_new_repo is True
1950
the repo_format_name is used to select the format of repository to
1952
:param make_working_trees: Control the setting of make_working_trees
1953
for a new shared repository when one is made. None to use whatever
1954
default the format has.
1955
:param shared_repo: Control whether made repositories are shared or
1957
:param vfs_only: If True do not attempt to use a smart server
1958
:return: repo, bzrdir, require_stacking, repository_policy. repo is
1959
None if none was created or found, bzrdir is always valid.
1960
require_stacking is the result of examining the stacked_on
1961
parameter and any stacking policy found for the target.
1964
# Try to hand off to a smart server
1966
client_medium = transport.get_smart_medium()
1967
except errors.NoSmartMedium:
1970
# TODO: lookup the local format from a server hint.
1971
remote_dir_format = RemoteBzrDirFormat()
1972
remote_dir_format._network_name = self.network_name()
1973
self._supply_sub_formats_to(remote_dir_format)
1974
return remote_dir_format.initialize_on_transport_ex(transport,
1975
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
1976
force_new_repo=force_new_repo, stacked_on=stacked_on,
1977
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
1978
make_working_trees=make_working_trees, shared_repo=shared_repo)
1979
# XXX: Refactor the create_prefix/no_create_prefix code into a
1980
# common helper function
1981
# The destination may not exist - if so make it according to policy.
1982
def make_directory(transport):
1983
transport.mkdir('.')
1985
def redirected(transport, e, redirection_notice):
1986
note(redirection_notice)
1987
return transport._redirected_to(e.source, e.target)
1989
transport = do_catching_redirections(make_directory, transport,
1991
except errors.FileExists:
1992
if not use_existing_dir:
1994
except errors.NoSuchFile:
1995
if not create_prefix:
1997
transport.create_prefix()
1999
require_stacking = (stacked_on is not None)
2000
# Now the target directory exists, but doesn't have a .bzr
2001
# directory. So we need to create it, along with any work to create
2002
# all of the dependent branches, etc.
2004
result = self.initialize_on_transport(transport)
2005
if repo_format_name:
2007
# use a custom format
2008
result._format.repository_format = \
2009
repository.network_format_registry.get(repo_format_name)
2010
except AttributeError:
2011
# The format didn't permit it to be set.
2013
# A repository is desired, either in-place or shared.
2014
repository_policy = result.determine_repository_policy(
2015
force_new_repo, stacked_on, stack_on_pwd,
2016
require_stacking=require_stacking)
2017
result_repo, is_new_repo = repository_policy.acquire_repository(
2018
make_working_trees, shared_repo)
2019
if not require_stacking and repository_policy._require_stacking:
2020
require_stacking = True
2021
result._format.require_stacking()
2022
result_repo.lock_write()
2025
repository_policy = None
2026
return result_repo, result, require_stacking, repository_policy
2028
def _initialize_on_transport_vfs(self, transport):
2029
"""Initialize a new bzrdir using VFS calls.
2031
:param transport: The transport to create the .bzr directory in.
2034
# Since we are creating a .bzr directory, inherit the
2035
# mode from the root directory
2036
temp_control = lockable_files.LockableFiles(transport,
2037
'', lockable_files.TransportLock)
2038
temp_control._transport.mkdir('.bzr',
2039
# FIXME: RBC 20060121 don't peek under
2041
mode=temp_control._dir_mode)
2042
if sys.platform == 'win32' and isinstance(transport, local.LocalTransport):
2043
win32utils.set_file_attr_hidden(transport._abspath('.bzr'))
2044
file_mode = temp_control._file_mode
2046
bzrdir_transport = transport.clone('.bzr')
2047
utf8_files = [('README',
2048
"This is a Bazaar control directory.\n"
2049
"Do not change any files in this directory.\n"
2050
"See http://bazaar-vcs.org/ for more information about Bazaar.\n"),
2051
('branch-format', self.get_format_string()),
2053
# NB: no need to escape relative paths that are url safe.
2054
control_files = lockable_files.LockableFiles(bzrdir_transport,
2055
self._lock_file_name, self._lock_class)
2056
control_files.create_lock()
2057
control_files.lock_write()
2059
for (filename, content) in utf8_files:
2060
bzrdir_transport.put_bytes(filename, content,
2063
control_files.unlock()
2064
return self.open(transport, _found=True)
2066
def is_supported(self):
2067
"""Is this format supported?
2069
Supported formats must be initializable and openable.
2070
Unsupported formats may not support initialization or committing or
2071
some other features depending on the reason for not being supported.
2075
def network_name(self):
2076
"""A simple byte string uniquely identifying this format for RPC calls.
2078
Bzr control formats use thir disk format string to identify the format
2079
over the wire. Its possible that other control formats have more
2080
complex detection requirements, so we permit them to use any unique and
2081
immutable string they desire.
2083
raise NotImplementedError(self.network_name)
2085
def same_model(self, target_format):
2086
return (self.repository_format.rich_root_data ==
2087
target_format.rich_root_data)
2090
def known_formats(klass):
2091
"""Return all the known formats.
2093
Concrete formats should override _known_formats.
2095
# There is double indirection here to make sure that control
2096
# formats used by more than one dir format will only be probed
2097
# once. This can otherwise be quite expensive for remote connections.
2099
for format in klass._control_formats:
2100
result.update(format._known_formats())
2104
def _known_formats(klass):
2105
"""Return the known format instances for this control format."""
2106
return set(klass._formats.values())
2108
def open(self, transport, _found=False):
2109
"""Return an instance of this format for the dir transport points at.
2111
_found is a private parameter, do not use it.
2114
found_format = BzrDirFormat.find_format(transport)
2115
if not isinstance(found_format, self.__class__):
2116
raise AssertionError("%s was asked to open %s, but it seems to need "
2118
% (self, transport, found_format))
2119
# Allow subclasses - use the found format.
2120
self._supply_sub_formats_to(found_format)
2121
return found_format._open(transport)
2122
return self._open(transport)
2124
def _open(self, transport):
2125
"""Template method helper for opening BzrDirectories.
2127
This performs the actual open and any additional logic or parameter
2130
raise NotImplementedError(self._open)
2133
def register_format(klass, format):
2134
klass._formats[format.get_format_string()] = format
2135
# bzr native formats have a network name of their format string.
2136
network_format_registry.register(format.get_format_string(), format.__class__)
2139
def register_control_format(klass, format):
2140
"""Register a format that does not use '.bzr' for its control dir.
2142
TODO: This should be pulled up into a 'ControlDirFormat' base class
2143
which BzrDirFormat can inherit from, and renamed to register_format
2144
there. It has been done without that for now for simplicity of
2147
klass._control_formats.append(format)
2150
def register_control_server_format(klass, format):
2151
"""Register a control format for client-server environments.
2153
These formats will be tried before ones registered with
2154
register_control_format. This gives implementations that decide to the
2155
chance to grab it before anything looks at the contents of the format
2158
klass._control_server_formats.append(format)
2161
def _set_default_format(klass, format):
2162
"""Set default format (for testing behavior of defaults only)"""
2163
klass._default_format = format
2167
return self.get_format_description().rstrip()
2169
def _supply_sub_formats_to(self, other_format):
2170
"""Give other_format the same values for sub formats as this has.
2172
This method is expected to be used when parameterising a
2173
RemoteBzrDirFormat instance with the parameters from a
2174
BzrDirMetaFormat1 instance.
2176
:param other_format: other_format is a format which should be
2177
compatible with whatever sub formats are supported by self.
2182
def unregister_format(klass, format):
2183
del klass._formats[format.get_format_string()]
2186
def unregister_control_format(klass, format):
2187
klass._control_formats.remove(format)
2190
class BzrDirFormat4(BzrDirFormat):
2191
"""Bzr dir format 4.
2193
This format is a combined format for working tree, branch and repository.
2195
- Format 1 working trees [always]
2196
- Format 4 branches [always]
2197
- Format 4 repositories [always]
2199
This format is deprecated: it indexes texts using a text it which is
2200
removed in format 5; write support for this format has been removed.
2203
_lock_class = lockable_files.TransportLock
2205
def get_format_string(self):
2206
"""See BzrDirFormat.get_format_string()."""
2207
return "Bazaar-NG branch, format 0.0.4\n"
2209
def get_format_description(self):
2210
"""See BzrDirFormat.get_format_description()."""
2211
return "All-in-one format 4"
2213
def get_converter(self, format=None):
2214
"""See BzrDirFormat.get_converter()."""
2215
# there is one and only one upgrade path here.
2216
return ConvertBzrDir4To5()
2218
def initialize_on_transport(self, transport):
2219
"""Format 4 branches cannot be created."""
2220
raise errors.UninitializableFormat(self)
2222
def is_supported(self):
2223
"""Format 4 is not supported.
2225
It is not supported because the model changed from 4 to 5 and the
2226
conversion logic is expensive - so doing it on the fly was not
2231
def network_name(self):
2232
return self.get_format_string()
2234
def _open(self, transport):
2235
"""See BzrDirFormat._open."""
2236
return BzrDir4(transport, self)
2238
def __return_repository_format(self):
2239
"""Circular import protection."""
2240
from bzrlib.repofmt.weaverepo import RepositoryFormat4
2241
return RepositoryFormat4()
2242
repository_format = property(__return_repository_format)
2245
class BzrDirFormatAllInOne(BzrDirFormat):
2246
"""Common class for formats before meta-dirs."""
2248
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
2249
create_prefix=False, force_new_repo=False, stacked_on=None,
2250
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
2252
"""See BzrDirFormat.initialize_on_transport_ex."""
2253
require_stacking = (stacked_on is not None)
2254
# Format 5 cannot stack, but we've been asked to - actually init
2256
if require_stacking:
2257
format = BzrDirMetaFormat1()
2258
return format.initialize_on_transport_ex(transport,
2259
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2260
force_new_repo=force_new_repo, stacked_on=stacked_on,
2261
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2262
make_working_trees=make_working_trees, shared_repo=shared_repo)
2263
return BzrDirFormat.initialize_on_transport_ex(self, transport,
2264
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2265
force_new_repo=force_new_repo, stacked_on=stacked_on,
2266
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2267
make_working_trees=make_working_trees, shared_repo=shared_repo)
2270
class BzrDirFormat5(BzrDirFormatAllInOne):
2271
"""Bzr control format 5.
2273
This format is a combined format for working tree, branch and repository.
2275
- Format 2 working trees [always]
2276
- Format 4 branches [always]
2277
- Format 5 repositories [always]
2278
Unhashed stores in the repository.
2281
_lock_class = lockable_files.TransportLock
2283
def get_format_string(self):
2284
"""See BzrDirFormat.get_format_string()."""
2285
return "Bazaar-NG branch, format 5\n"
2287
def get_branch_format(self):
2288
from bzrlib import branch
2289
return branch.BzrBranchFormat4()
2291
def get_format_description(self):
2292
"""See BzrDirFormat.get_format_description()."""
2293
return "All-in-one format 5"
2295
def get_converter(self, format=None):
2296
"""See BzrDirFormat.get_converter()."""
2297
# there is one and only one upgrade path here.
2298
return ConvertBzrDir5To6()
2300
def _initialize_for_clone(self, url):
2301
return self.initialize_on_transport(get_transport(url), _cloning=True)
2303
def initialize_on_transport(self, transport, _cloning=False):
2304
"""Format 5 dirs always have working tree, branch and repository.
2306
Except when they are being cloned.
2308
from bzrlib.branch import BzrBranchFormat4
2309
from bzrlib.repofmt.weaverepo import RepositoryFormat5
2310
result = (super(BzrDirFormat5, self).initialize_on_transport(transport))
2311
RepositoryFormat5().initialize(result, _internal=True)
2313
branch = BzrBranchFormat4().initialize(result)
2314
result._init_workingtree()
2317
def network_name(self):
2318
return self.get_format_string()
2320
def _open(self, transport):
2321
"""See BzrDirFormat._open."""
2322
return BzrDir5(transport, self)
2324
def __return_repository_format(self):
2325
"""Circular import protection."""
2326
from bzrlib.repofmt.weaverepo import RepositoryFormat5
2327
return RepositoryFormat5()
2328
repository_format = property(__return_repository_format)
2331
class BzrDirFormat6(BzrDirFormatAllInOne):
2332
"""Bzr control format 6.
2334
This format is a combined format for working tree, branch and repository.
2336
- Format 2 working trees [always]
2337
- Format 4 branches [always]
2338
- Format 6 repositories [always]
2341
_lock_class = lockable_files.TransportLock
2343
def get_format_string(self):
2344
"""See BzrDirFormat.get_format_string()."""
2345
return "Bazaar-NG branch, format 6\n"
2347
def get_format_description(self):
2348
"""See BzrDirFormat.get_format_description()."""
2349
return "All-in-one format 6"
2351
def get_branch_format(self):
2352
from bzrlib import branch
2353
return branch.BzrBranchFormat4()
2355
def get_converter(self, format=None):
2356
"""See BzrDirFormat.get_converter()."""
2357
# there is one and only one upgrade path here.
2358
return ConvertBzrDir6ToMeta()
2360
def _initialize_for_clone(self, url):
2361
return self.initialize_on_transport(get_transport(url), _cloning=True)
2363
def initialize_on_transport(self, transport, _cloning=False):
2364
"""Format 6 dirs always have working tree, branch and repository.
2366
Except when they are being cloned.
2368
from bzrlib.branch import BzrBranchFormat4
2369
from bzrlib.repofmt.weaverepo import RepositoryFormat6
2370
result = super(BzrDirFormat6, self).initialize_on_transport(transport)
2371
RepositoryFormat6().initialize(result, _internal=True)
2373
branch = BzrBranchFormat4().initialize(result)
2374
result._init_workingtree()
2377
def network_name(self):
2378
return self.get_format_string()
2380
def _open(self, transport):
2381
"""See BzrDirFormat._open."""
2382
return BzrDir6(transport, self)
2384
def __return_repository_format(self):
2385
"""Circular import protection."""
2386
from bzrlib.repofmt.weaverepo import RepositoryFormat6
2387
return RepositoryFormat6()
2388
repository_format = property(__return_repository_format)
2391
class BzrDirMetaFormat1(BzrDirFormat):
2392
"""Bzr meta control format 1
2394
This is the first format with split out working tree, branch and repository
2397
- Format 3 working trees [optional]
2398
- Format 5 branches [optional]
2399
- Format 7 repositories [optional]
2402
_lock_class = lockdir.LockDir
2405
self._workingtree_format = None
2406
self._branch_format = None
2407
self._repository_format = None
2409
def __eq__(self, other):
2410
if other.__class__ is not self.__class__:
2412
if other.repository_format != self.repository_format:
2414
if other.workingtree_format != self.workingtree_format:
2418
def __ne__(self, other):
2419
return not self == other
2421
def get_branch_format(self):
2422
if self._branch_format is None:
2423
from bzrlib.branch import BranchFormat
2424
self._branch_format = BranchFormat.get_default_format()
2425
return self._branch_format
2427
def set_branch_format(self, format):
2428
self._branch_format = format
2430
def require_stacking(self, stack_on=None, possible_transports=None,
2432
"""We have a request to stack, try to ensure the formats support it.
2434
:param stack_on: If supplied, it is the URL to a branch that we want to
2435
stack on. Check to see if that format supports stacking before
2438
# Stacking is desired. requested by the target, but does the place it
2439
# points at support stacking? If it doesn't then we should
2440
# not implicitly upgrade. We check this here.
2441
new_repo_format = None
2442
new_branch_format = None
2444
# a bit of state for get_target_branch so that we don't try to open it
2445
# 2 times, for both repo *and* branch
2446
target = [None, False, None] # target_branch, checked, upgrade anyway
2447
def get_target_branch():
2449
# We've checked, don't check again
2451
if stack_on is None:
2452
# No target format, that means we want to force upgrading
2453
target[:] = [None, True, True]
2456
target_dir = BzrDir.open(stack_on,
2457
possible_transports=possible_transports)
2458
except errors.NotBranchError:
2459
# Nothing there, don't change formats
2460
target[:] = [None, True, False]
2462
except errors.JailBreak:
2463
# JailBreak, JFDI and upgrade anyway
2464
target[:] = [None, True, True]
2467
target_branch = target_dir.open_branch()
2468
except errors.NotBranchError:
2469
# No branch, don't upgrade formats
2470
target[:] = [None, True, False]
2472
target[:] = [target_branch, True, False]
2475
if (not _skip_repo and
2476
not self.repository_format.supports_external_lookups):
2477
# We need to upgrade the Repository.
2478
target_branch, _, do_upgrade = get_target_branch()
2479
if target_branch is None:
2480
# We don't have a target branch, should we upgrade anyway?
2482
# stack_on is inaccessible, JFDI.
2483
# TODO: bad monkey, hard-coded formats...
2484
if self.repository_format.rich_root_data:
2485
new_repo_format = pack_repo.RepositoryFormatKnitPack5RichRoot()
2487
new_repo_format = pack_repo.RepositoryFormatKnitPack5()
2489
# If the target already supports stacking, then we know the
2490
# project is already able to use stacking, so auto-upgrade
2492
new_repo_format = target_branch.repository._format
2493
if not new_repo_format.supports_external_lookups:
2494
# target doesn't, source doesn't, so don't auto upgrade
2496
new_repo_format = None
2497
if new_repo_format is not None:
2498
self.repository_format = new_repo_format
2499
note('Source repository format does not support stacking,'
2500
' using format:\n %s',
2501
new_repo_format.get_format_description())
2503
if not self.get_branch_format().supports_stacking():
2504
# We just checked the repo, now lets check if we need to
2505
# upgrade the branch format
2506
target_branch, _, do_upgrade = get_target_branch()
2507
if target_branch is None:
2509
# TODO: bad monkey, hard-coded formats...
2510
new_branch_format = branch.BzrBranchFormat7()
2512
new_branch_format = target_branch._format
2513
if not new_branch_format.supports_stacking():
2514
new_branch_format = None
2515
if new_branch_format is not None:
2516
# Does support stacking, use its format.
2517
self.set_branch_format(new_branch_format)
2518
note('Source branch format does not support stacking,'
2519
' using format:\n %s',
2520
new_branch_format.get_format_description())
2522
def get_converter(self, format=None):
2523
"""See BzrDirFormat.get_converter()."""
2525
format = BzrDirFormat.get_default_format()
2526
if not isinstance(self, format.__class__):
2527
# converting away from metadir is not implemented
2528
raise NotImplementedError(self.get_converter)
2529
return ConvertMetaToMeta(format)
2531
def get_format_string(self):
2532
"""See BzrDirFormat.get_format_string()."""
2533
return "Bazaar-NG meta directory, format 1\n"
2535
def get_format_description(self):
2536
"""See BzrDirFormat.get_format_description()."""
2537
return "Meta directory format 1"
2539
def network_name(self):
2540
return self.get_format_string()
2542
def _open(self, transport):
2543
"""See BzrDirFormat._open."""
2544
# Create a new format instance because otherwise initialisation of new
2545
# metadirs share the global default format object leading to alias
2547
format = BzrDirMetaFormat1()
2548
self._supply_sub_formats_to(format)
2549
return BzrDirMeta1(transport, format)
2551
def __return_repository_format(self):
2552
"""Circular import protection."""
2553
if self._repository_format:
2554
return self._repository_format
2555
from bzrlib.repository import RepositoryFormat
2556
return RepositoryFormat.get_default_format()
2558
def _set_repository_format(self, value):
2559
"""Allow changing the repository format for metadir formats."""
2560
self._repository_format = value
2562
repository_format = property(__return_repository_format,
2563
_set_repository_format)
2565
def _supply_sub_formats_to(self, other_format):
2566
"""Give other_format the same values for sub formats as this has.
2568
This method is expected to be used when parameterising a
2569
RemoteBzrDirFormat instance with the parameters from a
2570
BzrDirMetaFormat1 instance.
2572
:param other_format: other_format is a format which should be
2573
compatible with whatever sub formats are supported by self.
2576
if getattr(self, '_repository_format', None) is not None:
2577
other_format.repository_format = self.repository_format
2578
if self._branch_format is not None:
2579
other_format._branch_format = self._branch_format
2580
if self._workingtree_format is not None:
2581
other_format.workingtree_format = self.workingtree_format
2583
def __get_workingtree_format(self):
2584
if self._workingtree_format is None:
2585
from bzrlib.workingtree import WorkingTreeFormat
2586
self._workingtree_format = WorkingTreeFormat.get_default_format()
2587
return self._workingtree_format
2589
def __set_workingtree_format(self, wt_format):
2590
self._workingtree_format = wt_format
2592
workingtree_format = property(__get_workingtree_format,
2593
__set_workingtree_format)
2596
network_format_registry = registry.FormatRegistry()
2597
"""Registry of formats indexed by their network name.
2599
The network name for a BzrDirFormat is an identifier that can be used when
2600
referring to formats with smart server operations. See
2601
BzrDirFormat.network_name() for more detail.
2605
# Register bzr control format
2606
BzrDirFormat.register_control_format(BzrDirFormat)
2608
# Register bzr formats
2609
BzrDirFormat.register_format(BzrDirFormat4())
2610
BzrDirFormat.register_format(BzrDirFormat5())
2611
BzrDirFormat.register_format(BzrDirFormat6())
2612
__default_format = BzrDirMetaFormat1()
2613
BzrDirFormat.register_format(__default_format)
2614
BzrDirFormat._default_format = __default_format
2617
class Converter(object):
2618
"""Converts a disk format object from one format to another."""
2620
def convert(self, to_convert, pb):
2621
"""Perform the conversion of to_convert, giving feedback via pb.
2623
:param to_convert: The disk object to convert.
2624
:param pb: a progress bar to use for progress information.
2627
def step(self, message):
2628
"""Update the pb by a step."""
2630
self.pb.update(message, self.count, self.total)
2633
class ConvertBzrDir4To5(Converter):
2634
"""Converts format 4 bzr dirs to format 5."""
2637
super(ConvertBzrDir4To5, self).__init__()
2638
self.converted_revs = set()
2639
self.absent_revisions = set()
2643
def convert(self, to_convert, pb):
2644
"""See Converter.convert()."""
2645
self.bzrdir = to_convert
2647
warnings.warn("pb parameter to convert() is deprecated")
2648
self.pb = ui.ui_factory.nested_progress_bar()
2650
ui.ui_factory.note('starting upgrade from format 4 to 5')
2651
if isinstance(self.bzrdir.transport, local.LocalTransport):
2652
self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
2653
self._convert_to_weaves()
2654
return BzrDir.open(self.bzrdir.root_transport.base)
2658
def _convert_to_weaves(self):
2659
ui.ui_factory.note('note: upgrade may be faster if all store files are ungzipped first')
2662
stat = self.bzrdir.transport.stat('weaves')
2663
if not S_ISDIR(stat.st_mode):
2664
self.bzrdir.transport.delete('weaves')
2665
self.bzrdir.transport.mkdir('weaves')
2666
except errors.NoSuchFile:
2667
self.bzrdir.transport.mkdir('weaves')
2668
# deliberately not a WeaveFile as we want to build it up slowly.
2669
self.inv_weave = Weave('inventory')
2670
# holds in-memory weaves for all files
2671
self.text_weaves = {}
2672
self.bzrdir.transport.delete('branch-format')
2673
self.branch = self.bzrdir.open_branch()
2674
self._convert_working_inv()
2675
rev_history = self.branch.revision_history()
2676
# to_read is a stack holding the revisions we still need to process;
2677
# appending to it adds new highest-priority revisions
2678
self.known_revisions = set(rev_history)
2679
self.to_read = rev_history[-1:]
2681
rev_id = self.to_read.pop()
2682
if (rev_id not in self.revisions
2683
and rev_id not in self.absent_revisions):
2684
self._load_one_rev(rev_id)
2686
to_import = self._make_order()
2687
for i, rev_id in enumerate(to_import):
2688
self.pb.update('converting revision', i, len(to_import))
2689
self._convert_one_rev(rev_id)
2691
self._write_all_weaves()
2692
self._write_all_revs()
2693
ui.ui_factory.note('upgraded to weaves:')
2694
ui.ui_factory.note(' %6d revisions and inventories' % len(self.revisions))
2695
ui.ui_factory.note(' %6d revisions not present' % len(self.absent_revisions))
2696
ui.ui_factory.note(' %6d texts' % self.text_count)
2697
self._cleanup_spare_files_after_format4()
2698
self.branch._transport.put_bytes(
2700
BzrDirFormat5().get_format_string(),
2701
mode=self.bzrdir._get_file_mode())
2703
def _cleanup_spare_files_after_format4(self):
2704
# FIXME working tree upgrade foo.
2705
for n in 'merged-patches', 'pending-merged-patches':
2707
## assert os.path.getsize(p) == 0
2708
self.bzrdir.transport.delete(n)
2709
except errors.NoSuchFile:
2711
self.bzrdir.transport.delete_tree('inventory-store')
2712
self.bzrdir.transport.delete_tree('text-store')
2714
def _convert_working_inv(self):
2715
inv = xml4.serializer_v4.read_inventory(
2716
self.branch._transport.get('inventory'))
2717
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv, working=True)
2718
self.branch._transport.put_bytes('inventory', new_inv_xml,
2719
mode=self.bzrdir._get_file_mode())
2721
def _write_all_weaves(self):
2722
controlweaves = WeaveStore(self.bzrdir.transport, prefixed=False)
2723
weave_transport = self.bzrdir.transport.clone('weaves')
2724
weaves = WeaveStore(weave_transport, prefixed=False)
2725
transaction = WriteTransaction()
2729
for file_id, file_weave in self.text_weaves.items():
2730
self.pb.update('writing weave', i, len(self.text_weaves))
2731
weaves._put_weave(file_id, file_weave, transaction)
2733
self.pb.update('inventory', 0, 1)
2734
controlweaves._put_weave('inventory', self.inv_weave, transaction)
2735
self.pb.update('inventory', 1, 1)
2739
def _write_all_revs(self):
2740
"""Write all revisions out in new form."""
2741
self.bzrdir.transport.delete_tree('revision-store')
2742
self.bzrdir.transport.mkdir('revision-store')
2743
revision_transport = self.bzrdir.transport.clone('revision-store')
2745
from bzrlib.xml5 import serializer_v5
2746
from bzrlib.repofmt.weaverepo import RevisionTextStore
2747
revision_store = RevisionTextStore(revision_transport,
2748
serializer_v5, False, versionedfile.PrefixMapper(),
2749
lambda:True, lambda:True)
2751
for i, rev_id in enumerate(self.converted_revs):
2752
self.pb.update('write revision', i, len(self.converted_revs))
2753
text = serializer_v5.write_revision_to_string(
2754
self.revisions[rev_id])
2756
revision_store.add_lines(key, None, osutils.split_lines(text))
2760
def _load_one_rev(self, rev_id):
2761
"""Load a revision object into memory.
2763
Any parents not either loaded or abandoned get queued to be
2765
self.pb.update('loading revision',
2766
len(self.revisions),
2767
len(self.known_revisions))
2768
if not self.branch.repository.has_revision(rev_id):
2770
ui.ui_factory.note('revision {%s} not present in branch; '
2771
'will be converted as a ghost' %
2773
self.absent_revisions.add(rev_id)
2775
rev = self.branch.repository.get_revision(rev_id)
2776
for parent_id in rev.parent_ids:
2777
self.known_revisions.add(parent_id)
2778
self.to_read.append(parent_id)
2779
self.revisions[rev_id] = rev
2781
def _load_old_inventory(self, rev_id):
2782
old_inv_xml = self.branch.repository.inventory_store.get(rev_id).read()
2783
inv = xml4.serializer_v4.read_inventory_from_string(old_inv_xml)
2784
inv.revision_id = rev_id
2785
rev = self.revisions[rev_id]
2788
def _load_updated_inventory(self, rev_id):
2789
inv_xml = self.inv_weave.get_text(rev_id)
2790
inv = xml5.serializer_v5.read_inventory_from_string(inv_xml, rev_id)
2793
def _convert_one_rev(self, rev_id):
2794
"""Convert revision and all referenced objects to new format."""
2795
rev = self.revisions[rev_id]
2796
inv = self._load_old_inventory(rev_id)
2797
present_parents = [p for p in rev.parent_ids
2798
if p not in self.absent_revisions]
2799
self._convert_revision_contents(rev, inv, present_parents)
2800
self._store_new_inv(rev, inv, present_parents)
2801
self.converted_revs.add(rev_id)
2803
def _store_new_inv(self, rev, inv, present_parents):
2804
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
2805
new_inv_sha1 = sha_string(new_inv_xml)
2806
self.inv_weave.add_lines(rev.revision_id,
2808
new_inv_xml.splitlines(True))
2809
rev.inventory_sha1 = new_inv_sha1
2811
def _convert_revision_contents(self, rev, inv, present_parents):
2812
"""Convert all the files within a revision.
2814
Also upgrade the inventory to refer to the text revision ids."""
2815
rev_id = rev.revision_id
2816
mutter('converting texts of revision {%s}',
2818
parent_invs = map(self._load_updated_inventory, present_parents)
2819
entries = inv.iter_entries()
2821
for path, ie in entries:
2822
self._convert_file_version(rev, ie, parent_invs)
2824
def _convert_file_version(self, rev, ie, parent_invs):
2825
"""Convert one version of one file.
2827
The file needs to be added into the weave if it is a merge
2828
of >=2 parents or if it's changed from its parent.
2830
file_id = ie.file_id
2831
rev_id = rev.revision_id
2832
w = self.text_weaves.get(file_id)
2835
self.text_weaves[file_id] = w
2836
text_changed = False
2837
parent_candiate_entries = ie.parent_candidates(parent_invs)
2838
heads = graph.Graph(self).heads(parent_candiate_entries.keys())
2839
# XXX: Note that this is unordered - and this is tolerable because
2840
# the previous code was also unordered.
2841
previous_entries = dict((head, parent_candiate_entries[head]) for head
2843
self.snapshot_ie(previous_entries, ie, w, rev_id)
2846
def get_parent_map(self, revision_ids):
2847
"""See graph.StackedParentsProvider.get_parent_map"""
2848
return dict((revision_id, self.revisions[revision_id])
2849
for revision_id in revision_ids
2850
if revision_id in self.revisions)
2852
def snapshot_ie(self, previous_revisions, ie, w, rev_id):
2853
# TODO: convert this logic, which is ~= snapshot to
2854
# a call to:. This needs the path figured out. rather than a work_tree
2855
# a v4 revision_tree can be given, or something that looks enough like
2856
# one to give the file content to the entry if it needs it.
2857
# and we need something that looks like a weave store for snapshot to
2859
#ie.snapshot(rev, PATH, previous_revisions, REVISION_TREE, InMemoryWeaveStore(self.text_weaves))
2860
if len(previous_revisions) == 1:
2861
previous_ie = previous_revisions.values()[0]
2862
if ie._unchanged(previous_ie):
2863
ie.revision = previous_ie.revision
2866
text = self.branch.repository._text_store.get(ie.text_id)
2867
file_lines = text.readlines()
2868
w.add_lines(rev_id, previous_revisions, file_lines)
2869
self.text_count += 1
2871
w.add_lines(rev_id, previous_revisions, [])
2872
ie.revision = rev_id
2874
def _make_order(self):
2875
"""Return a suitable order for importing revisions.
2877
The order must be such that an revision is imported after all
2878
its (present) parents.
2880
todo = set(self.revisions.keys())
2881
done = self.absent_revisions.copy()
2884
# scan through looking for a revision whose parents
2886
for rev_id in sorted(list(todo)):
2887
rev = self.revisions[rev_id]
2888
parent_ids = set(rev.parent_ids)
2889
if parent_ids.issubset(done):
2890
# can take this one now
2891
order.append(rev_id)
2897
class ConvertBzrDir5To6(Converter):
2898
"""Converts format 5 bzr dirs to format 6."""
2900
def convert(self, to_convert, pb):
2901
"""See Converter.convert()."""
2902
self.bzrdir = to_convert
2903
pb = ui.ui_factory.nested_progress_bar()
2905
ui.ui_factory.note('starting upgrade from format 5 to 6')
2906
self._convert_to_prefixed()
2907
return BzrDir.open(self.bzrdir.root_transport.base)
2911
def _convert_to_prefixed(self):
2912
from bzrlib.store import TransportStore
2913
self.bzrdir.transport.delete('branch-format')
2914
for store_name in ["weaves", "revision-store"]:
2915
ui.ui_factory.note("adding prefixes to %s" % store_name)
2916
store_transport = self.bzrdir.transport.clone(store_name)
2917
store = TransportStore(store_transport, prefixed=True)
2918
for urlfilename in store_transport.list_dir('.'):
2919
filename = urlutils.unescape(urlfilename)
2920
if (filename.endswith(".weave") or
2921
filename.endswith(".gz") or
2922
filename.endswith(".sig")):
2923
file_id, suffix = os.path.splitext(filename)
2927
new_name = store._mapper.map((file_id,)) + suffix
2928
# FIXME keep track of the dirs made RBC 20060121
2930
store_transport.move(filename, new_name)
2931
except errors.NoSuchFile: # catches missing dirs strangely enough
2932
store_transport.mkdir(osutils.dirname(new_name))
2933
store_transport.move(filename, new_name)
2934
self.bzrdir.transport.put_bytes(
2936
BzrDirFormat6().get_format_string(),
2937
mode=self.bzrdir._get_file_mode())
2940
class ConvertBzrDir6ToMeta(Converter):
2941
"""Converts format 6 bzr dirs to metadirs."""
2943
def convert(self, to_convert, pb):
2944
"""See Converter.convert()."""
2945
from bzrlib.repofmt.weaverepo import RepositoryFormat7
2946
from bzrlib.branch import BzrBranchFormat5
2947
self.bzrdir = to_convert
2948
self.pb = ui.ui_factory.nested_progress_bar()
2950
self.total = 20 # the steps we know about
2951
self.garbage_inventories = []
2952
self.dir_mode = self.bzrdir._get_dir_mode()
2953
self.file_mode = self.bzrdir._get_file_mode()
2955
ui.ui_factory.note('starting upgrade from format 6 to metadir')
2956
self.bzrdir.transport.put_bytes(
2958
"Converting to format 6",
2959
mode=self.file_mode)
2960
# its faster to move specific files around than to open and use the apis...
2961
# first off, nuke ancestry.weave, it was never used.
2963
self.step('Removing ancestry.weave')
2964
self.bzrdir.transport.delete('ancestry.weave')
2965
except errors.NoSuchFile:
2967
# find out whats there
2968
self.step('Finding branch files')
2969
last_revision = self.bzrdir.open_branch().last_revision()
2970
bzrcontents = self.bzrdir.transport.list_dir('.')
2971
for name in bzrcontents:
2972
if name.startswith('basis-inventory.'):
2973
self.garbage_inventories.append(name)
2974
# create new directories for repository, working tree and branch
2975
repository_names = [('inventory.weave', True),
2976
('revision-store', True),
2978
self.step('Upgrading repository ')
2979
self.bzrdir.transport.mkdir('repository', mode=self.dir_mode)
2980
self.make_lock('repository')
2981
# we hard code the formats here because we are converting into
2982
# the meta format. The meta format upgrader can take this to a
2983
# future format within each component.
2984
self.put_format('repository', RepositoryFormat7())
2985
for entry in repository_names:
2986
self.move_entry('repository', entry)
2988
self.step('Upgrading branch ')
2989
self.bzrdir.transport.mkdir('branch', mode=self.dir_mode)
2990
self.make_lock('branch')
2991
self.put_format('branch', BzrBranchFormat5())
2992
branch_files = [('revision-history', True),
2993
('branch-name', True),
2995
for entry in branch_files:
2996
self.move_entry('branch', entry)
2998
checkout_files = [('pending-merges', True),
2999
('inventory', True),
3000
('stat-cache', False)]
3001
# If a mandatory checkout file is not present, the branch does not have
3002
# a functional checkout. Do not create a checkout in the converted
3004
for name, mandatory in checkout_files:
3005
if mandatory and name not in bzrcontents:
3006
has_checkout = False
3010
if not has_checkout:
3011
ui.ui_factory.note('No working tree.')
3012
# If some checkout files are there, we may as well get rid of them.
3013
for name, mandatory in checkout_files:
3014
if name in bzrcontents:
3015
self.bzrdir.transport.delete(name)
3017
from bzrlib.workingtree import WorkingTreeFormat3
3018
self.step('Upgrading working tree')
3019
self.bzrdir.transport.mkdir('checkout', mode=self.dir_mode)
3020
self.make_lock('checkout')
3022
'checkout', WorkingTreeFormat3())
3023
self.bzrdir.transport.delete_multi(
3024
self.garbage_inventories, self.pb)
3025
for entry in checkout_files:
3026
self.move_entry('checkout', entry)
3027
if last_revision is not None:
3028
self.bzrdir.transport.put_bytes(
3029
'checkout/last-revision', last_revision)
3030
self.bzrdir.transport.put_bytes(
3032
BzrDirMetaFormat1().get_format_string(),
3033
mode=self.file_mode)
3035
return BzrDir.open(self.bzrdir.root_transport.base)
3037
def make_lock(self, name):
3038
"""Make a lock for the new control dir name."""
3039
self.step('Make %s lock' % name)
3040
ld = lockdir.LockDir(self.bzrdir.transport,
3042
file_modebits=self.file_mode,
3043
dir_modebits=self.dir_mode)
3046
def move_entry(self, new_dir, entry):
3047
"""Move then entry name into new_dir."""
3049
mandatory = entry[1]
3050
self.step('Moving %s' % name)
3052
self.bzrdir.transport.move(name, '%s/%s' % (new_dir, name))
3053
except errors.NoSuchFile:
3057
def put_format(self, dirname, format):
3058
self.bzrdir.transport.put_bytes('%s/format' % dirname,
3059
format.get_format_string(),
3063
class ConvertMetaToMeta(Converter):
3064
"""Converts the components of metadirs."""
3066
def __init__(self, target_format):
3067
"""Create a metadir to metadir converter.
3069
:param target_format: The final metadir format that is desired.
3071
self.target_format = target_format
3073
def convert(self, to_convert, pb):
3074
"""See Converter.convert()."""
3075
self.bzrdir = to_convert
3076
self.pb = ui.ui_factory.nested_progress_bar()
3079
self.step('checking repository format')
3081
repo = self.bzrdir.open_repository()
3082
except errors.NoRepositoryPresent:
3085
if not isinstance(repo._format, self.target_format.repository_format.__class__):
3086
from bzrlib.repository import CopyConverter
3087
ui.ui_factory.note('starting repository conversion')
3088
converter = CopyConverter(self.target_format.repository_format)
3089
converter.convert(repo, pb)
3090
for branch in self.bzrdir.list_branches():
3091
# TODO: conversions of Branch and Tree should be done by
3092
# InterXFormat lookups/some sort of registry.
3093
# Avoid circular imports
3094
from bzrlib import branch as _mod_branch
3095
old = branch._format.__class__
3096
new = self.target_format.get_branch_format().__class__
3098
if (old == _mod_branch.BzrBranchFormat5 and
3099
new in (_mod_branch.BzrBranchFormat6,
3100
_mod_branch.BzrBranchFormat7,
3101
_mod_branch.BzrBranchFormat8)):
3102
branch_converter = _mod_branch.Converter5to6()
3103
elif (old == _mod_branch.BzrBranchFormat6 and
3104
new in (_mod_branch.BzrBranchFormat7,
3105
_mod_branch.BzrBranchFormat8)):
3106
branch_converter = _mod_branch.Converter6to7()
3107
elif (old == _mod_branch.BzrBranchFormat7 and
3108
new is _mod_branch.BzrBranchFormat8):
3109
branch_converter = _mod_branch.Converter7to8()
3111
raise errors.BadConversionTarget("No converter", new,
3113
branch_converter.convert(branch)
3114
branch = self.bzrdir.open_branch()
3115
old = branch._format.__class__
3117
tree = self.bzrdir.open_workingtree(recommend_upgrade=False)
3118
except (errors.NoWorkingTree, errors.NotLocalUrl):
3121
# TODO: conversions of Branch and Tree should be done by
3122
# InterXFormat lookups
3123
if (isinstance(tree, workingtree.WorkingTree3) and
3124
not isinstance(tree, workingtree_4.DirStateWorkingTree) and
3125
isinstance(self.target_format.workingtree_format,
3126
workingtree_4.DirStateWorkingTreeFormat)):
3127
workingtree_4.Converter3to4().convert(tree)
3128
if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
3129
not isinstance(tree, workingtree_4.WorkingTree5) and
3130
isinstance(self.target_format.workingtree_format,
3131
workingtree_4.WorkingTreeFormat5)):
3132
workingtree_4.Converter4to5().convert(tree)
3133
if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
3134
not isinstance(tree, workingtree_4.WorkingTree6) and
3135
isinstance(self.target_format.workingtree_format,
3136
workingtree_4.WorkingTreeFormat6)):
3137
workingtree_4.Converter4or5to6().convert(tree)
3142
# This is not in remote.py because it's relatively small, and needs to be
3143
# registered. Putting it in remote.py creates a circular import problem.
3144
# we can make it a lazy object if the control formats is turned into something
3146
class RemoteBzrDirFormat(BzrDirMetaFormat1):
3147
"""Format representing bzrdirs accessed via a smart server"""
3150
BzrDirMetaFormat1.__init__(self)
3151
# XXX: It's a bit ugly that the network name is here, because we'd
3152
# like to believe that format objects are stateless or at least
3153
# immutable, However, we do at least avoid mutating the name after
3154
# it's returned. See <https://bugs.edge.launchpad.net/bzr/+bug/504102>
3155
self._network_name = None
3158
return "%s(_network_name=%r)" % (self.__class__.__name__,
3161
def get_format_description(self):
3162
if self._network_name:
3163
real_format = network_format_registry.get(self._network_name)
3164
return 'Remote: ' + real_format.get_format_description()
3165
return 'bzr remote bzrdir'
3167
def get_format_string(self):
3168
raise NotImplementedError(self.get_format_string)
3170
def network_name(self):
3171
if self._network_name:
3172
return self._network_name
3174
raise AssertionError("No network name set.")
3177
def probe_transport(klass, transport):
3178
"""Return a RemoteBzrDirFormat object if it looks possible."""
3180
medium = transport.get_smart_medium()
3181
except (NotImplementedError, AttributeError,
3182
errors.TransportNotPossible, errors.NoSmartMedium,
3183
errors.SmartProtocolError):
3184
# no smart server, so not a branch for this format type.
3185
raise errors.NotBranchError(path=transport.base)
3187
# Decline to open it if the server doesn't support our required
3188
# version (3) so that the VFS-based transport will do it.
3189
if medium.should_probe():
3191
server_version = medium.protocol_version()
3192
except errors.SmartProtocolError:
3193
# Apparently there's no usable smart server there, even though
3194
# the medium supports the smart protocol.
3195
raise errors.NotBranchError(path=transport.base)
3196
if server_version != '2':
3197
raise errors.NotBranchError(path=transport.base)
3200
def initialize_on_transport(self, transport):
3202
# hand off the request to the smart server
3203
client_medium = transport.get_smart_medium()
3204
except errors.NoSmartMedium:
3205
# TODO: lookup the local format from a server hint.
3206
local_dir_format = BzrDirMetaFormat1()
3207
return local_dir_format.initialize_on_transport(transport)
3208
client = _SmartClient(client_medium)
3209
path = client.remote_path_from_transport(transport)
3211
response = client.call('BzrDirFormat.initialize', path)
3212
except errors.ErrorFromSmartServer, err:
3213
remote._translate_error(err, path=path)
3214
if response[0] != 'ok':
3215
raise errors.SmartProtocolError('unexpected response code %s' % (response,))
3216
format = RemoteBzrDirFormat()
3217
self._supply_sub_formats_to(format)
3218
return remote.RemoteBzrDir(transport, format)
3220
def parse_NoneTrueFalse(self, arg):
3227
raise AssertionError("invalid arg %r" % arg)
3229
def _serialize_NoneTrueFalse(self, arg):
3236
def _serialize_NoneString(self, arg):
3239
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
3240
create_prefix=False, force_new_repo=False, stacked_on=None,
3241
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
3244
# hand off the request to the smart server
3245
client_medium = transport.get_smart_medium()
3246
except errors.NoSmartMedium:
3249
# Decline to open it if the server doesn't support our required
3250
# version (3) so that the VFS-based transport will do it.
3251
if client_medium.should_probe():
3253
server_version = client_medium.protocol_version()
3254
if server_version != '2':
3258
except errors.SmartProtocolError:
3259
# Apparently there's no usable smart server there, even though
3260
# the medium supports the smart protocol.
3265
client = _SmartClient(client_medium)
3266
path = client.remote_path_from_transport(transport)
3267
if client_medium._is_remote_before((1, 16)):
3270
# TODO: lookup the local format from a server hint.
3271
local_dir_format = BzrDirMetaFormat1()
3272
self._supply_sub_formats_to(local_dir_format)
3273
return local_dir_format.initialize_on_transport_ex(transport,
3274
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3275
force_new_repo=force_new_repo, stacked_on=stacked_on,
3276
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3277
make_working_trees=make_working_trees, shared_repo=shared_repo,
3279
return self._initialize_on_transport_ex_rpc(client, path, transport,
3280
use_existing_dir, create_prefix, force_new_repo, stacked_on,
3281
stack_on_pwd, repo_format_name, make_working_trees, shared_repo)
3283
def _initialize_on_transport_ex_rpc(self, client, path, transport,
3284
use_existing_dir, create_prefix, force_new_repo, stacked_on,
3285
stack_on_pwd, repo_format_name, make_working_trees, shared_repo):
3287
args.append(self._serialize_NoneTrueFalse(use_existing_dir))
3288
args.append(self._serialize_NoneTrueFalse(create_prefix))
3289
args.append(self._serialize_NoneTrueFalse(force_new_repo))
3290
args.append(self._serialize_NoneString(stacked_on))
3291
# stack_on_pwd is often/usually our transport
3294
stack_on_pwd = transport.relpath(stack_on_pwd)
3295
if not stack_on_pwd:
3297
except errors.PathNotChild:
3299
args.append(self._serialize_NoneString(stack_on_pwd))
3300
args.append(self._serialize_NoneString(repo_format_name))
3301
args.append(self._serialize_NoneTrueFalse(make_working_trees))
3302
args.append(self._serialize_NoneTrueFalse(shared_repo))
3303
request_network_name = self._network_name or \
3304
BzrDirFormat.get_default_format().network_name()
3306
response = client.call('BzrDirFormat.initialize_ex_1.16',
3307
request_network_name, path, *args)
3308
except errors.UnknownSmartMethod:
3309
client._medium._remember_remote_is_before((1,16))
3310
local_dir_format = BzrDirMetaFormat1()
3311
self._supply_sub_formats_to(local_dir_format)
3312
return local_dir_format.initialize_on_transport_ex(transport,
3313
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3314
force_new_repo=force_new_repo, stacked_on=stacked_on,
3315
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3316
make_working_trees=make_working_trees, shared_repo=shared_repo,
3318
except errors.ErrorFromSmartServer, err:
3319
remote._translate_error(err, path=path)
3320
repo_path = response[0]
3321
bzrdir_name = response[6]
3322
require_stacking = response[7]
3323
require_stacking = self.parse_NoneTrueFalse(require_stacking)
3324
format = RemoteBzrDirFormat()
3325
format._network_name = bzrdir_name
3326
self._supply_sub_formats_to(format)
3327
bzrdir = remote.RemoteBzrDir(transport, format, _client=client)
3329
repo_format = remote.response_tuple_to_repo_format(response[1:])
3330
if repo_path == '.':
3333
repo_bzrdir_format = RemoteBzrDirFormat()
3334
repo_bzrdir_format._network_name = response[5]
3335
repo_bzr = remote.RemoteBzrDir(transport.clone(repo_path),
3339
final_stack = response[8] or None
3340
final_stack_pwd = response[9] or None
3342
final_stack_pwd = urlutils.join(
3343
transport.base, final_stack_pwd)
3344
remote_repo = remote.RemoteRepository(repo_bzr, repo_format)
3345
if len(response) > 10:
3346
# Updated server verb that locks remotely.
3347
repo_lock_token = response[10] or None
3348
remote_repo.lock_write(repo_lock_token, _skip_rpc=True)
3350
remote_repo.dont_leave_lock_in_place()
3352
remote_repo.lock_write()
3353
policy = UseExistingRepository(remote_repo, final_stack,
3354
final_stack_pwd, require_stacking)
3355
policy.acquire_repository()
3359
bzrdir._format.set_branch_format(self.get_branch_format())
3360
if require_stacking:
3361
# The repo has already been created, but we need to make sure that
3362
# we'll make a stackable branch.
3363
bzrdir._format.require_stacking(_skip_repo=True)
3364
return remote_repo, bzrdir, require_stacking, policy
3366
def _open(self, transport):
3367
return remote.RemoteBzrDir(transport, self)
3369
def __eq__(self, other):
3370
if not isinstance(other, RemoteBzrDirFormat):
3372
return self.get_format_description() == other.get_format_description()
3374
def __return_repository_format(self):
3375
# Always return a RemoteRepositoryFormat object, but if a specific bzr
3376
# repository format has been asked for, tell the RemoteRepositoryFormat
3377
# that it should use that for init() etc.
3378
result = remote.RemoteRepositoryFormat()
3379
custom_format = getattr(self, '_repository_format', None)
3381
if isinstance(custom_format, remote.RemoteRepositoryFormat):
3382
return custom_format
3384
# We will use the custom format to create repositories over the
3385
# wire; expose its details like rich_root_data for code to
3387
result._custom_format = custom_format
3390
def get_branch_format(self):
3391
result = BzrDirMetaFormat1.get_branch_format(self)
3392
if not isinstance(result, remote.RemoteBranchFormat):
3393
new_result = remote.RemoteBranchFormat()
3394
new_result._custom_format = result
3396
self.set_branch_format(new_result)
3400
repository_format = property(__return_repository_format,
3401
BzrDirMetaFormat1._set_repository_format) #.im_func)
3404
BzrDirFormat.register_control_server_format(RemoteBzrDirFormat)
3407
class BzrDirFormatInfo(object):
3409
def __init__(self, native, deprecated, hidden, experimental):
3410
self.deprecated = deprecated
3411
self.native = native
3412
self.hidden = hidden
3413
self.experimental = experimental
3416
class BzrDirFormatRegistry(registry.Registry):
3417
"""Registry of user-selectable BzrDir subformats.
3419
Differs from BzrDirFormat._control_formats in that it provides sub-formats,
3420
e.g. BzrDirMeta1 with weave repository. Also, it's more user-oriented.
3424
"""Create a BzrDirFormatRegistry."""
3425
self._aliases = set()
3426
self._registration_order = list()
3427
super(BzrDirFormatRegistry, self).__init__()
3430
"""Return a set of the format names which are aliases."""
3431
return frozenset(self._aliases)
3433
def register_metadir(self, key,
3434
repository_format, help, native=True, deprecated=False,
3440
"""Register a metadir subformat.
3442
These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
3443
by the Repository/Branch/WorkingTreeformats.
3445
:param repository_format: The fully-qualified repository format class
3447
:param branch_format: Fully-qualified branch format class name as
3449
:param tree_format: Fully-qualified tree format class name as
3452
# This should be expanded to support setting WorkingTree and Branch
3453
# formats, once BzrDirMetaFormat1 supports that.
3454
def _load(full_name):
3455
mod_name, factory_name = full_name.rsplit('.', 1)
3457
mod = __import__(mod_name, globals(), locals(),
3459
except ImportError, e:
3460
raise ImportError('failed to load %s: %s' % (full_name, e))
3462
factory = getattr(mod, factory_name)
3463
except AttributeError:
3464
raise AttributeError('no factory %s in module %r'
3469
bd = BzrDirMetaFormat1()
3470
if branch_format is not None:
3471
bd.set_branch_format(_load(branch_format))
3472
if tree_format is not None:
3473
bd.workingtree_format = _load(tree_format)
3474
if repository_format is not None:
3475
bd.repository_format = _load(repository_format)
3477
self.register(key, helper, help, native, deprecated, hidden,
3478
experimental, alias)
3480
def register(self, key, factory, help, native=True, deprecated=False,
3481
hidden=False, experimental=False, alias=False):
3482
"""Register a BzrDirFormat factory.
3484
The factory must be a callable that takes one parameter: the key.
3485
It must produce an instance of the BzrDirFormat when called.
3487
This function mainly exists to prevent the info object from being
3490
registry.Registry.register(self, key, factory, help,
3491
BzrDirFormatInfo(native, deprecated, hidden, experimental))
3493
self._aliases.add(key)
3494
self._registration_order.append(key)
3496
def register_lazy(self, key, module_name, member_name, help, native=True,
3497
deprecated=False, hidden=False, experimental=False, alias=False):
3498
registry.Registry.register_lazy(self, key, module_name, member_name,
3499
help, BzrDirFormatInfo(native, deprecated, hidden, experimental))
3501
self._aliases.add(key)
3502
self._registration_order.append(key)
3504
def set_default(self, key):
3505
"""Set the 'default' key to be a clone of the supplied key.
3507
This method must be called once and only once.
3509
registry.Registry.register(self, 'default', self.get(key),
3510
self.get_help(key), info=self.get_info(key))
3511
self._aliases.add('default')
3513
def set_default_repository(self, key):
3514
"""Set the FormatRegistry default and Repository default.
3516
This is a transitional method while Repository.set_default_format
3519
if 'default' in self:
3520
self.remove('default')
3521
self.set_default(key)
3522
format = self.get('default')()
3524
def make_bzrdir(self, key):
3525
return self.get(key)()
3527
def help_topic(self, topic):
3529
default_realkey = None
3530
default_help = self.get_help('default')
3532
for key in self._registration_order:
3533
if key == 'default':
3535
help = self.get_help(key)
3536
if help == default_help:
3537
default_realkey = key
3539
help_pairs.append((key, help))
3541
def wrapped(key, help, info):
3543
help = '(native) ' + help
3544
return ':%s:\n%s\n\n' % (key,
3545
textwrap.fill(help, initial_indent=' ',
3546
subsequent_indent=' ',
3547
break_long_words=False))
3548
if default_realkey is not None:
3549
output += wrapped(default_realkey, '(default) %s' % default_help,
3550
self.get_info('default'))
3551
deprecated_pairs = []
3552
experimental_pairs = []
3553
for key, help in help_pairs:
3554
info = self.get_info(key)
3557
elif info.deprecated:
3558
deprecated_pairs.append((key, help))
3559
elif info.experimental:
3560
experimental_pairs.append((key, help))
3562
output += wrapped(key, help, info)
3563
output += "\nSee :doc:`formats-help` for more about storage formats."
3565
if len(experimental_pairs) > 0:
3566
other_output += "Experimental formats are shown below.\n\n"
3567
for key, help in experimental_pairs:
3568
info = self.get_info(key)
3569
other_output += wrapped(key, help, info)
3572
"No experimental formats are available.\n\n"
3573
if len(deprecated_pairs) > 0:
3574
other_output += "\nDeprecated formats are shown below.\n\n"
3575
for key, help in deprecated_pairs:
3576
info = self.get_info(key)
3577
other_output += wrapped(key, help, info)
3580
"\nNo deprecated formats are available.\n\n"
3582
"\nSee :doc:`formats-help` for more about storage formats."
3584
if topic == 'other-formats':
3590
class RepositoryAcquisitionPolicy(object):
3591
"""Abstract base class for repository acquisition policies.
3593
A repository acquisition policy decides how a BzrDir acquires a repository
3594
for a branch that is being created. The most basic policy decision is
3595
whether to create a new repository or use an existing one.
3597
def __init__(self, stack_on, stack_on_pwd, require_stacking):
3600
:param stack_on: A location to stack on
3601
:param stack_on_pwd: If stack_on is relative, the location it is
3603
:param require_stacking: If True, it is a failure to not stack.
3605
self._stack_on = stack_on
3606
self._stack_on_pwd = stack_on_pwd
3607
self._require_stacking = require_stacking
3609
def configure_branch(self, branch):
3610
"""Apply any configuration data from this policy to the branch.
3612
Default implementation sets repository stacking.
3614
if self._stack_on is None:
3616
if self._stack_on_pwd is None:
3617
stack_on = self._stack_on
3620
stack_on = urlutils.rebase_url(self._stack_on,
3622
branch.bzrdir.root_transport.base)
3623
except errors.InvalidRebaseURLs:
3624
stack_on = self._get_full_stack_on()
3626
branch.set_stacked_on_url(stack_on)
3627
except (errors.UnstackableBranchFormat,
3628
errors.UnstackableRepositoryFormat):
3629
if self._require_stacking:
3632
def requires_stacking(self):
3633
"""Return True if this policy requires stacking."""
3634
return self._stack_on is not None and self._require_stacking
3636
def _get_full_stack_on(self):
3637
"""Get a fully-qualified URL for the stack_on location."""
3638
if self._stack_on is None:
3640
if self._stack_on_pwd is None:
3641
return self._stack_on
3643
return urlutils.join(self._stack_on_pwd, self._stack_on)
3645
def _add_fallback(self, repository, possible_transports=None):
3646
"""Add a fallback to the supplied repository, if stacking is set."""
3647
stack_on = self._get_full_stack_on()
3648
if stack_on is None:
3651
stacked_dir = BzrDir.open(stack_on,
3652
possible_transports=possible_transports)
3653
except errors.JailBreak:
3654
# We keep the stacking details, but we are in the server code so
3655
# actually stacking is not needed.
3658
stacked_repo = stacked_dir.open_branch().repository
3659
except errors.NotBranchError:
3660
stacked_repo = stacked_dir.open_repository()
3662
repository.add_fallback_repository(stacked_repo)
3663
except errors.UnstackableRepositoryFormat:
3664
if self._require_stacking:
3667
self._require_stacking = True
3669
def acquire_repository(self, make_working_trees=None, shared=False):
3670
"""Acquire a repository for this bzrdir.
3672
Implementations may create a new repository or use a pre-exising
3674
:param make_working_trees: If creating a repository, set
3675
make_working_trees to this value (if non-None)
3676
:param shared: If creating a repository, make it shared if True
3677
:return: A repository, is_new_flag (True if the repository was
3680
raise NotImplemented(RepositoryAcquisitionPolicy.acquire_repository)
3683
class CreateRepository(RepositoryAcquisitionPolicy):
3684
"""A policy of creating a new repository"""
3686
def __init__(self, bzrdir, stack_on=None, stack_on_pwd=None,
3687
require_stacking=False):
3690
:param bzrdir: The bzrdir to create the repository on.
3691
:param stack_on: A location to stack on
3692
:param stack_on_pwd: If stack_on is relative, the location it is
3695
RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
3697
self._bzrdir = bzrdir
3699
def acquire_repository(self, make_working_trees=None, shared=False):
3700
"""Implementation of RepositoryAcquisitionPolicy.acquire_repository
3702
Creates the desired repository in the bzrdir we already have.
3704
stack_on = self._get_full_stack_on()
3706
format = self._bzrdir._format
3707
format.require_stacking(stack_on=stack_on,
3708
possible_transports=[self._bzrdir.root_transport])
3709
if not self._require_stacking:
3710
# We have picked up automatic stacking somewhere.
3711
note('Using default stacking branch %s at %s', self._stack_on,
3713
repository = self._bzrdir.create_repository(shared=shared)
3714
self._add_fallback(repository,
3715
possible_transports=[self._bzrdir.transport])
3716
if make_working_trees is not None:
3717
repository.set_make_working_trees(make_working_trees)
3718
return repository, True
3721
class UseExistingRepository(RepositoryAcquisitionPolicy):
3722
"""A policy of reusing an existing repository"""
3724
def __init__(self, repository, stack_on=None, stack_on_pwd=None,
3725
require_stacking=False):
3728
:param repository: The repository to use.
3729
:param stack_on: A location to stack on
3730
:param stack_on_pwd: If stack_on is relative, the location it is
3733
RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
3735
self._repository = repository
3737
def acquire_repository(self, make_working_trees=None, shared=False):
3738
"""Implementation of RepositoryAcquisitionPolicy.acquire_repository
3740
Returns an existing repository to use.
3742
self._add_fallback(self._repository,
3743
possible_transports=[self._repository.bzrdir.transport])
3744
return self._repository, False
3747
# Please register new formats after old formats so that formats
3748
# appear in chronological order and format descriptions can build
3750
format_registry = BzrDirFormatRegistry()
3751
# The pre-0.8 formats have their repository format network name registered in
3752
# repository.py. MetaDir formats have their repository format network name
3753
# inferred from their disk format string.
3754
format_registry.register('weave', BzrDirFormat6,
3755
'Pre-0.8 format. Slower than knit and does not'
3756
' support checkouts or shared repositories.',
3759
format_registry.register_metadir('metaweave',
3760
'bzrlib.repofmt.weaverepo.RepositoryFormat7',
3761
'Transitional format in 0.8. Slower than knit.',
3762
branch_format='bzrlib.branch.BzrBranchFormat5',
3763
tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3766
format_registry.register_metadir('knit',
3767
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3768
'Format using knits. Recommended for interoperation with bzr <= 0.14.',
3769
branch_format='bzrlib.branch.BzrBranchFormat5',
3770
tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3773
format_registry.register_metadir('dirstate',
3774
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3775
help='New in 0.15: Fast local operations. Compatible with bzr 0.8 and '
3776
'above when accessed over the network.',
3777
branch_format='bzrlib.branch.BzrBranchFormat5',
3778
# this uses bzrlib.workingtree.WorkingTreeFormat4 because importing
3779
# directly from workingtree_4 triggers a circular import.
3780
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3783
format_registry.register_metadir('dirstate-tags',
3784
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3785
help='New in 0.15: Fast local operations and improved scaling for '
3786
'network operations. Additionally adds support for tags.'
3787
' Incompatible with bzr < 0.15.',
3788
branch_format='bzrlib.branch.BzrBranchFormat6',
3789
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3792
format_registry.register_metadir('rich-root',
3793
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
3794
help='New in 1.0. Better handling of tree roots. Incompatible with'
3796
branch_format='bzrlib.branch.BzrBranchFormat6',
3797
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3800
format_registry.register_metadir('dirstate-with-subtree',
3801
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
3802
help='New in 0.15: Fast local operations and improved scaling for '
3803
'network operations. Additionally adds support for versioning nested '
3804
'bzr branches. Incompatible with bzr < 0.15.',
3805
branch_format='bzrlib.branch.BzrBranchFormat6',
3806
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3810
format_registry.register_metadir('pack-0.92',
3811
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack1',
3812
help='New in 0.92: Pack-based format with data compatible with '
3813
'dirstate-tags format repositories. Interoperates with '
3814
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3816
branch_format='bzrlib.branch.BzrBranchFormat6',
3817
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3819
format_registry.register_metadir('pack-0.92-subtree',
3820
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack3',
3821
help='New in 0.92: Pack-based format with data compatible with '
3822
'dirstate-with-subtree format repositories. Interoperates with '
3823
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3825
branch_format='bzrlib.branch.BzrBranchFormat6',
3826
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3830
format_registry.register_metadir('rich-root-pack',
3831
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
3832
help='New in 1.0: A variant of pack-0.92 that supports rich-root data '
3833
'(needed for bzr-svn and bzr-git).',
3834
branch_format='bzrlib.branch.BzrBranchFormat6',
3835
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3838
format_registry.register_metadir('1.6',
3839
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5',
3840
help='A format that allows a branch to indicate that there is another '
3841
'(stacked) repository that should be used to access data that is '
3842
'not present locally.',
3843
branch_format='bzrlib.branch.BzrBranchFormat7',
3844
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3847
format_registry.register_metadir('1.6.1-rich-root',
3848
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5RichRoot',
3849
help='A variant of 1.6 that supports rich-root data '
3850
'(needed for bzr-svn and bzr-git).',
3851
branch_format='bzrlib.branch.BzrBranchFormat7',
3852
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3855
format_registry.register_metadir('1.9',
3856
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3857
help='A repository format using B+tree indexes. These indexes '
3858
'are smaller in size, have smarter caching and provide faster '
3859
'performance for most operations.',
3860
branch_format='bzrlib.branch.BzrBranchFormat7',
3861
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3864
format_registry.register_metadir('1.9-rich-root',
3865
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
3866
help='A variant of 1.9 that supports rich-root data '
3867
'(needed for bzr-svn and bzr-git).',
3868
branch_format='bzrlib.branch.BzrBranchFormat7',
3869
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3872
format_registry.register_metadir('1.14',
3873
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3874
help='A working-tree format that supports content filtering.',
3875
branch_format='bzrlib.branch.BzrBranchFormat7',
3876
tree_format='bzrlib.workingtree.WorkingTreeFormat5',
3878
format_registry.register_metadir('1.14-rich-root',
3879
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
3880
help='A variant of 1.14 that supports rich-root data '
3881
'(needed for bzr-svn and bzr-git).',
3882
branch_format='bzrlib.branch.BzrBranchFormat7',
3883
tree_format='bzrlib.workingtree.WorkingTreeFormat5',
3885
# The following un-numbered 'development' formats should always just be aliases.
3886
format_registry.register_metadir('development-rich-root',
3887
'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
3888
help='Current development format. Supports rich roots. Can convert data '
3889
'to and from rich-root-pack (and anything compatible with '
3890
'rich-root-pack) format repositories. Repositories and branches in '
3891
'this format can only be read by bzr.dev. Please read '
3892
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
3894
branch_format='bzrlib.branch.BzrBranchFormat7',
3895
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3900
format_registry.register_metadir('development-subtree',
3901
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment2Subtree',
3902
help='Current development format, subtree variant. Can convert data to and '
3903
'from pack-0.92-subtree (and anything compatible with '
3904
'pack-0.92-subtree) format repositories. Repositories and branches in '
3905
'this format can only be read by bzr.dev. Please read '
3906
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
3908
branch_format='bzrlib.branch.BzrBranchFormat7',
3909
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3912
alias=False, # Restore to being an alias when an actual development subtree format is added
3913
# This current non-alias status is simply because we did not introduce a
3914
# chk based subtree format.
3917
# And the development formats above will have aliased one of the following:
3918
format_registry.register_metadir('development6-rich-root',
3919
'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
3920
help='pack-1.9 with 255-way hashed CHK inv, group compress, rich roots '
3922
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
3924
branch_format='bzrlib.branch.BzrBranchFormat7',
3925
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3930
format_registry.register_metadir('development7-rich-root',
3931
'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK2',
3932
help='pack-1.9 with 255-way hashed CHK inv, bencode revision, group compress, '
3933
'rich roots. Please read '
3934
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
3936
branch_format='bzrlib.branch.BzrBranchFormat7',
3937
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3942
format_registry.register_metadir('2a',
3943
'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
3944
help='First format for bzr 2.0 series.\n'
3945
'Uses group-compress storage.\n'
3946
'Provides rich roots which are a one-way transition.\n',
3947
# 'storage in packs, 255-way hashed CHK inventory, bencode revision, group compress, '
3948
# 'rich roots. Supported by bzr 1.16 and later.',
3949
branch_format='bzrlib.branch.BzrBranchFormat7',
3950
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3954
# The following format should be an alias for the rich root equivalent
3955
# of the default format
3956
format_registry.register_metadir('default-rich-root',
3957
'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
3958
branch_format='bzrlib.branch.BzrBranchFormat7',
3959
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3964
# The current format that is made on 'bzr init'.
3965
format_registry.set_default('2a')
added
removed
bzrlib/bzrdir.py
