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):
400
"""Create a branch in this BzrDir.
402
The bzrdir's format will control what branch format is created.
403
For more control see BranchFormatXX.create(a_bzrdir).
405
raise NotImplementedError(self.create_branch)
407
def destroy_branch(self):
408
"""Destroy the branch in this BzrDir"""
409
raise NotImplementedError(self.destroy_branch)
412
def create_branch_and_repo(base, force_new_repo=False, format=None):
413
"""Create a new BzrDir, Branch and Repository at the url 'base'.
415
This will use the current default BzrDirFormat unless one is
416
specified, and use whatever
417
repository format that that uses via bzrdir.create_branch and
418
create_repository. If a shared repository is available that is used
421
The created Branch object is returned.
423
:param base: The URL to create the branch at.
424
:param force_new_repo: If True a new repository is always created.
425
:param format: If supplied, the format of branch to create. If not
426
supplied, the default is used.
428
bzrdir = BzrDir.create(base, format)
429
bzrdir._find_or_create_repository(force_new_repo)
430
return bzrdir.create_branch()
432
def determine_repository_policy(self, force_new_repo=False, stack_on=None,
433
stack_on_pwd=None, require_stacking=False):
434
"""Return an object representing a policy to use.
436
This controls whether a new repository is created, and the format of
437
that repository, or some existing shared repository used instead.
439
If stack_on is supplied, will not seek a containing shared repo.
441
:param force_new_repo: If True, require a new repository to be created.
442
:param stack_on: If supplied, the location to stack on. If not
443
supplied, a default_stack_on location may be used.
444
:param stack_on_pwd: If stack_on is relative, the location it is
447
def repository_policy(found_bzrdir):
450
config = found_bzrdir.get_config()
452
stack_on = config.get_default_stack_on()
453
if stack_on is not None:
454
stack_on_pwd = found_bzrdir.root_transport.base
456
# does it have a repository ?
458
repository = found_bzrdir.open_repository()
459
except errors.NoRepositoryPresent:
462
if ((found_bzrdir.root_transport.base !=
463
self.root_transport.base) and not repository.is_shared()):
464
# Don't look higher, can't use a higher shared repo.
472
return UseExistingRepository(repository, stack_on,
473
stack_on_pwd, require_stacking=require_stacking), True
475
return CreateRepository(self, stack_on, stack_on_pwd,
476
require_stacking=require_stacking), True
478
if not force_new_repo:
480
policy = self._find_containing(repository_policy)
481
if policy is not None:
485
return UseExistingRepository(self.open_repository(),
486
stack_on, stack_on_pwd,
487
require_stacking=require_stacking)
488
except errors.NoRepositoryPresent:
490
return CreateRepository(self, stack_on, stack_on_pwd,
491
require_stacking=require_stacking)
493
def _find_or_create_repository(self, force_new_repo):
494
"""Create a new repository if needed, returning the repository."""
495
policy = self.determine_repository_policy(force_new_repo)
496
return policy.acquire_repository()[0]
499
def create_branch_convenience(base, force_new_repo=False,
500
force_new_tree=None, format=None,
501
possible_transports=None):
502
"""Create a new BzrDir, Branch and Repository at the url 'base'.
504
This is a convenience function - it will use an existing repository
505
if possible, can be told explicitly whether to create a working tree or
508
This will use the current default BzrDirFormat unless one is
509
specified, and use whatever
510
repository format that that uses via bzrdir.create_branch and
511
create_repository. If a shared repository is available that is used
512
preferentially. Whatever repository is used, its tree creation policy
515
The created Branch object is returned.
516
If a working tree cannot be made due to base not being a file:// url,
517
no error is raised unless force_new_tree is True, in which case no
518
data is created on disk and NotLocalUrl is raised.
520
:param base: The URL to create the branch at.
521
:param force_new_repo: If True a new repository is always created.
522
:param force_new_tree: If True or False force creation of a tree or
523
prevent such creation respectively.
524
:param format: Override for the bzrdir format to create.
525
:param possible_transports: An optional reusable transports list.
528
# check for non local urls
529
t = get_transport(base, possible_transports)
530
if not isinstance(t, local.LocalTransport):
531
raise errors.NotLocalUrl(base)
532
bzrdir = BzrDir.create(base, format, possible_transports)
533
repo = bzrdir._find_or_create_repository(force_new_repo)
534
result = bzrdir.create_branch()
535
if force_new_tree or (repo.make_working_trees() and
536
force_new_tree is None):
538
bzrdir.create_workingtree()
539
except errors.NotLocalUrl:
544
def create_standalone_workingtree(base, format=None):
545
"""Create a new BzrDir, WorkingTree, Branch and Repository at 'base'.
547
'base' must be a local path or a file:// url.
549
This will use the current default BzrDirFormat unless one is
550
specified, and use whatever
551
repository format that that uses for bzrdirformat.create_workingtree,
552
create_branch and create_repository.
554
:param format: Override for the bzrdir format to create.
555
:return: The WorkingTree object.
557
t = get_transport(base)
558
if not isinstance(t, local.LocalTransport):
559
raise errors.NotLocalUrl(base)
560
bzrdir = BzrDir.create_branch_and_repo(base,
562
format=format).bzrdir
563
return bzrdir.create_workingtree()
565
def create_workingtree(self, revision_id=None, from_branch=None,
566
accelerator_tree=None, hardlink=False):
567
"""Create a working tree at this BzrDir.
569
:param revision_id: create it as of this revision id.
570
:param from_branch: override bzrdir branch (for lightweight checkouts)
571
:param accelerator_tree: A tree which can be used for retrieving file
572
contents more quickly than the revision tree, i.e. a workingtree.
573
The revision tree will be used for cases where accelerator_tree's
574
content is different.
576
raise NotImplementedError(self.create_workingtree)
578
def backup_bzrdir(self):
579
"""Backup this bzr control directory.
581
:return: Tuple with old path name and new path name
583
pb = ui.ui_factory.nested_progress_bar()
585
# FIXME: bug 300001 -- the backup fails if the backup directory
586
# already exists, but it should instead either remove it or make
587
# a new backup directory.
589
# FIXME: bug 262450 -- the backup directory should have the same
590
# permissions as the .bzr directory (probably a bug in copy_tree)
591
old_path = self.root_transport.abspath('.bzr')
592
new_path = self.root_transport.abspath('backup.bzr')
593
ui.ui_factory.note('making backup of %s\n to %s' % (old_path, new_path,))
594
self.root_transport.copy_tree('.bzr', 'backup.bzr')
595
return (old_path, new_path)
599
def retire_bzrdir(self, limit=10000):
600
"""Permanently disable the bzrdir.
602
This is done by renaming it to give the user some ability to recover
603
if there was a problem.
605
This will have horrible consequences if anyone has anything locked or
607
:param limit: number of times to retry
612
to_path = '.bzr.retired.%d' % i
613
self.root_transport.rename('.bzr', to_path)
614
note("renamed %s to %s"
615
% (self.root_transport.abspath('.bzr'), to_path))
617
except (errors.TransportError, IOError, errors.PathError):
624
def destroy_workingtree(self):
625
"""Destroy the working tree at this BzrDir.
627
Formats that do not support this may raise UnsupportedOperation.
629
raise NotImplementedError(self.destroy_workingtree)
631
def destroy_workingtree_metadata(self):
632
"""Destroy the control files for the working tree at this BzrDir.
634
The contents of working tree files are not affected.
635
Formats that do not support this may raise UnsupportedOperation.
637
raise NotImplementedError(self.destroy_workingtree_metadata)
639
def _find_containing(self, evaluate):
640
"""Find something in a containing control directory.
642
This method will scan containing control dirs, until it finds what
643
it is looking for, decides that it will never find it, or runs out
644
of containing control directories to check.
646
It is used to implement find_repository and
647
determine_repository_policy.
649
:param evaluate: A function returning (value, stop). If stop is True,
650
the value will be returned.
654
result, stop = evaluate(found_bzrdir)
657
next_transport = found_bzrdir.root_transport.clone('..')
658
if (found_bzrdir.root_transport.base == next_transport.base):
659
# top of the file system
661
# find the next containing bzrdir
663
found_bzrdir = BzrDir.open_containing_from_transport(
665
except errors.NotBranchError:
668
def find_repository(self):
669
"""Find the repository that should be used.
671
This does not require a branch as we use it to find the repo for
672
new branches as well as to hook existing branches up to their
675
def usable_repository(found_bzrdir):
676
# does it have a repository ?
678
repository = found_bzrdir.open_repository()
679
except errors.NoRepositoryPresent:
681
if found_bzrdir.root_transport.base == self.root_transport.base:
682
return repository, True
683
elif repository.is_shared():
684
return repository, True
688
found_repo = self._find_containing(usable_repository)
689
if found_repo is None:
690
raise errors.NoRepositoryPresent(self)
693
def get_branch_reference(self):
694
"""Return the referenced URL for the branch in this bzrdir.
696
:raises NotBranchError: If there is no Branch.
697
:return: The URL the branch in this bzrdir references if it is a
698
reference branch, or None for regular branches.
702
def get_branch_transport(self, branch_format):
703
"""Get the transport for use by branch format in this BzrDir.
705
Note that bzr dirs that do not support format strings will raise
706
IncompatibleFormat if the branch format they are given has
707
a format string, and vice versa.
709
If branch_format is None, the transport is returned with no
710
checking. If it is not None, then the returned transport is
711
guaranteed to point to an existing directory ready for use.
713
raise NotImplementedError(self.get_branch_transport)
715
def _find_creation_modes(self):
716
"""Determine the appropriate modes for files and directories.
718
They're always set to be consistent with the base directory,
719
assuming that this transport allows setting modes.
721
# TODO: Do we need or want an option (maybe a config setting) to turn
722
# this off or override it for particular locations? -- mbp 20080512
723
if self._mode_check_done:
725
self._mode_check_done = True
727
st = self.transport.stat('.')
728
except errors.TransportNotPossible:
729
self._dir_mode = None
730
self._file_mode = None
732
# Check the directory mode, but also make sure the created
733
# directories and files are read-write for this user. This is
734
# mostly a workaround for filesystems which lie about being able to
735
# write to a directory (cygwin & win32)
736
if (st.st_mode & 07777 == 00000):
737
# FTP allows stat but does not return dir/file modes
738
self._dir_mode = None
739
self._file_mode = None
741
self._dir_mode = (st.st_mode & 07777) | 00700
742
# Remove the sticky and execute bits for files
743
self._file_mode = self._dir_mode & ~07111
745
def _get_file_mode(self):
746
"""Return Unix mode for newly created files, or None.
748
if not self._mode_check_done:
749
self._find_creation_modes()
750
return self._file_mode
752
def _get_dir_mode(self):
753
"""Return Unix mode for newly created directories, or None.
755
if not self._mode_check_done:
756
self._find_creation_modes()
757
return self._dir_mode
759
def get_repository_transport(self, repository_format):
760
"""Get the transport for use by repository format in this BzrDir.
762
Note that bzr dirs that do not support format strings will raise
763
IncompatibleFormat if the repository format they are given has
764
a format string, and vice versa.
766
If repository_format is None, the transport is returned with no
767
checking. If it is not None, then the returned transport is
768
guaranteed to point to an existing directory ready for use.
770
raise NotImplementedError(self.get_repository_transport)
772
def get_workingtree_transport(self, tree_format):
773
"""Get the transport for use by workingtree format in this BzrDir.
775
Note that bzr dirs that do not support format strings will raise
776
IncompatibleFormat if the workingtree format they are given has a
777
format string, and vice versa.
779
If workingtree_format is None, the transport is returned with no
780
checking. If it is not None, then the returned transport is
781
guaranteed to point to an existing directory ready for use.
783
raise NotImplementedError(self.get_workingtree_transport)
785
def get_config(self):
786
"""Get configuration for this BzrDir."""
787
return config.BzrDirConfig(self)
789
def _get_config(self):
790
"""By default, no configuration is available."""
793
def __init__(self, _transport, _format):
794
"""Initialize a Bzr control dir object.
796
Only really common logic should reside here, concrete classes should be
797
made with varying behaviours.
799
:param _format: the format that is creating this BzrDir instance.
800
:param _transport: the transport this dir is based at.
802
self._format = _format
803
self.transport = _transport.clone('.bzr')
804
self.root_transport = _transport
805
self._mode_check_done = False
807
def is_control_filename(self, filename):
808
"""True if filename is the name of a path which is reserved for bzrdir's.
810
:param filename: A filename within the root transport of this bzrdir.
812
This is true IF and ONLY IF the filename is part of the namespace reserved
813
for bzr control dirs. Currently this is the '.bzr' directory in the root
814
of the root_transport. it is expected that plugins will need to extend
815
this in the future - for instance to make bzr talk with svn working
818
# this might be better on the BzrDirFormat class because it refers to
819
# all the possible bzrdir disk formats.
820
# This method is tested via the workingtree is_control_filename tests-
821
# it was extracted from WorkingTree.is_control_filename. If the method's
822
# contract is extended beyond the current trivial implementation, please
823
# add new tests for it to the appropriate place.
824
return filename == '.bzr' or filename.startswith('.bzr/')
826
def needs_format_conversion(self, format=None):
827
"""Return true if this bzrdir needs convert_format run on it.
829
For instance, if the repository format is out of date but the
830
branch and working tree are not, this should return True.
832
:param format: Optional parameter indicating a specific desired
833
format we plan to arrive at.
835
raise NotImplementedError(self.needs_format_conversion)
838
def open_unsupported(base):
839
"""Open a branch which is not supported."""
840
return BzrDir.open(base, _unsupported=True)
843
def open(base, _unsupported=False, possible_transports=None):
844
"""Open an existing bzrdir, rooted at 'base' (url).
846
:param _unsupported: a private parameter to the BzrDir class.
848
t = get_transport(base, possible_transports=possible_transports)
849
return BzrDir.open_from_transport(t, _unsupported=_unsupported)
852
def open_from_transport(transport, _unsupported=False,
853
_server_formats=True):
854
"""Open a bzrdir within a particular directory.
856
:param transport: Transport containing the bzrdir.
857
:param _unsupported: private.
859
for hook in BzrDir.hooks['pre_open']:
861
# Keep initial base since 'transport' may be modified while following
863
base = transport.base
864
def find_format(transport):
865
return transport, BzrDirFormat.find_format(
866
transport, _server_formats=_server_formats)
868
def redirected(transport, e, redirection_notice):
869
redirected_transport = transport._redirected_to(e.source, e.target)
870
if redirected_transport is None:
871
raise errors.NotBranchError(base)
872
note('%s is%s redirected to %s',
873
transport.base, e.permanently, redirected_transport.base)
874
return redirected_transport
877
transport, format = do_catching_redirections(find_format,
880
except errors.TooManyRedirections:
881
raise errors.NotBranchError(base)
883
BzrDir._check_supported(format, _unsupported)
884
return format.open(transport, _found=True)
886
def open_branch(self, unsupported=False, ignore_fallbacks=False):
887
"""Open the branch object at this BzrDir if one is present.
889
If unsupported is True, then no longer supported branch formats can
892
TODO: static convenience version of this?
894
raise NotImplementedError(self.open_branch)
897
def open_containing(url, possible_transports=None):
898
"""Open an existing branch which contains url.
900
:param url: url to search from.
901
See open_containing_from_transport for more detail.
903
transport = get_transport(url, possible_transports)
904
return BzrDir.open_containing_from_transport(transport)
907
def open_containing_from_transport(a_transport):
908
"""Open an existing branch which contains a_transport.base.
910
This probes for a branch at a_transport, and searches upwards from there.
912
Basically we keep looking up until we find the control directory or
913
run into the root. If there isn't one, raises NotBranchError.
914
If there is one and it is either an unrecognised format or an unsupported
915
format, UnknownFormatError or UnsupportedFormatError are raised.
916
If there is one, it is returned, along with the unused portion of url.
918
:return: The BzrDir that contains the path, and a Unicode path
919
for the rest of the URL.
921
# this gets the normalised url back. I.e. '.' -> the full path.
922
url = a_transport.base
925
result = BzrDir.open_from_transport(a_transport)
926
return result, urlutils.unescape(a_transport.relpath(url))
927
except errors.NotBranchError, e:
930
new_t = a_transport.clone('..')
931
except errors.InvalidURLJoin:
932
# reached the root, whatever that may be
933
raise errors.NotBranchError(path=url)
934
if new_t.base == a_transport.base:
935
# reached the root, whatever that may be
936
raise errors.NotBranchError(path=url)
939
def _get_tree_branch(self):
940
"""Return the branch and tree, if any, for this bzrdir.
942
Return None for tree if not present or inaccessible.
943
Raise NotBranchError if no branch is present.
944
:return: (tree, branch)
947
tree = self.open_workingtree()
948
except (errors.NoWorkingTree, errors.NotLocalUrl):
950
branch = self.open_branch()
956
def open_tree_or_branch(klass, location):
957
"""Return the branch and working tree at a location.
959
If there is no tree at the location, tree will be None.
960
If there is no branch at the location, an exception will be
962
:return: (tree, branch)
964
bzrdir = klass.open(location)
965
return bzrdir._get_tree_branch()
968
def open_containing_tree_or_branch(klass, location):
969
"""Return the branch and working tree contained by a location.
971
Returns (tree, branch, relpath).
972
If there is no tree at containing the location, tree will be None.
973
If there is no branch containing the location, an exception will be
975
relpath is the portion of the path that is contained by the branch.
977
bzrdir, relpath = klass.open_containing(location)
978
tree, branch = bzrdir._get_tree_branch()
979
return tree, branch, relpath
982
def open_containing_tree_branch_or_repository(klass, location):
983
"""Return the working tree, branch and repo contained by a location.
985
Returns (tree, branch, repository, relpath).
986
If there is no tree containing the location, tree will be None.
987
If there is no branch containing the location, branch will be None.
988
If there is no repository containing the location, repository will be
990
relpath is the portion of the path that is contained by the innermost
993
If no tree, branch or repository is found, a NotBranchError is raised.
995
bzrdir, relpath = klass.open_containing(location)
997
tree, branch = bzrdir._get_tree_branch()
998
except errors.NotBranchError:
1000
repo = bzrdir.find_repository()
1001
return None, None, repo, relpath
1002
except (errors.NoRepositoryPresent):
1003
raise errors.NotBranchError(location)
1004
return tree, branch, branch.repository, relpath
1006
def open_repository(self, _unsupported=False):
1007
"""Open the repository object at this BzrDir if one is present.
1009
This will not follow the Branch object pointer - it's strictly a direct
1010
open facility. Most client code should use open_branch().repository to
1011
get at a repository.
1013
:param _unsupported: a private parameter, not part of the api.
1014
TODO: static convenience version of this?
1016
raise NotImplementedError(self.open_repository)
1018
def open_workingtree(self, _unsupported=False,
1019
recommend_upgrade=True, from_branch=None):
1020
"""Open the workingtree object at this BzrDir if one is present.
1022
:param recommend_upgrade: Optional keyword parameter, when True (the
1023
default), emit through the ui module a recommendation that the user
1024
upgrade the working tree when the workingtree being opened is old
1025
(but still fully supported).
1026
:param from_branch: override bzrdir branch (for lightweight checkouts)
1028
raise NotImplementedError(self.open_workingtree)
1030
def has_branch(self):
1031
"""Tell if this bzrdir contains a branch.
1033
Note: if you're going to open the branch, you should just go ahead
1034
and try, and not ask permission first. (This method just opens the
1035
branch and discards it, and that's somewhat expensive.)
1040
except errors.NotBranchError:
1043
def has_workingtree(self):
1044
"""Tell if this bzrdir contains a working tree.
1046
This will still raise an exception if the bzrdir has a workingtree that
1047
is remote & inaccessible.
1049
Note: if you're going to open the working tree, you should just go ahead
1050
and try, and not ask permission first. (This method just opens the
1051
workingtree and discards it, and that's somewhat expensive.)
1054
self.open_workingtree(recommend_upgrade=False)
1056
except errors.NoWorkingTree:
1059
def _cloning_metadir(self):
1060
"""Produce a metadir suitable for cloning with.
1062
:returns: (destination_bzrdir_format, source_repository)
1064
result_format = self._format.__class__()
1067
branch = self.open_branch(ignore_fallbacks=True)
1068
source_repository = branch.repository
1069
result_format._branch_format = branch._format
1070
except errors.NotBranchError:
1071
source_branch = None
1072
source_repository = self.open_repository()
1073
except errors.NoRepositoryPresent:
1074
source_repository = None
1076
# XXX TODO: This isinstance is here because we have not implemented
1077
# the fix recommended in bug # 103195 - to delegate this choice the
1078
# repository itself.
1079
repo_format = source_repository._format
1080
if isinstance(repo_format, remote.RemoteRepositoryFormat):
1081
source_repository._ensure_real()
1082
repo_format = source_repository._real_repository._format
1083
result_format.repository_format = repo_format
1085
# TODO: Couldn't we just probe for the format in these cases,
1086
# rather than opening the whole tree? It would be a little
1087
# faster. mbp 20070401
1088
tree = self.open_workingtree(recommend_upgrade=False)
1089
except (errors.NoWorkingTree, errors.NotLocalUrl):
1090
result_format.workingtree_format = None
1092
result_format.workingtree_format = tree._format.__class__()
1093
return result_format, source_repository
1095
def cloning_metadir(self, require_stacking=False):
1096
"""Produce a metadir suitable for cloning or sprouting with.
1098
These operations may produce workingtrees (yes, even though they're
1099
"cloning" something that doesn't have a tree), so a viable workingtree
1100
format must be selected.
1102
:require_stacking: If True, non-stackable formats will be upgraded
1103
to similar stackable formats.
1104
:returns: a BzrDirFormat with all component formats either set
1105
appropriately or set to None if that component should not be
1108
format, repository = self._cloning_metadir()
1109
if format._workingtree_format is None:
1111
if repository is None:
1112
# No repository either
1114
# We have a repository, so set a working tree? (Why? This seems to
1115
# contradict the stated return value in the docstring).
1116
tree_format = repository._format._matchingbzrdir.workingtree_format
1117
format.workingtree_format = tree_format.__class__()
1118
if require_stacking:
1119
format.require_stacking()
1122
def checkout_metadir(self):
1123
return self.cloning_metadir()
1125
def sprout(self, url, revision_id=None, force_new_repo=False,
1126
recurse='down', possible_transports=None,
1127
accelerator_tree=None, hardlink=False, stacked=False,
1128
source_branch=None, create_tree_if_local=True):
1129
"""Create a copy of this bzrdir prepared for use as a new line of
1132
If url's last component does not exist, it will be created.
1134
Attributes related to the identity of the source branch like
1135
branch nickname will be cleaned, a working tree is created
1136
whether one existed before or not; and a local branch is always
1139
if revision_id is not None, then the clone operation may tune
1140
itself to download less data.
1141
:param accelerator_tree: A tree which can be used for retrieving file
1142
contents more quickly than the revision tree, i.e. a workingtree.
1143
The revision tree will be used for cases where accelerator_tree's
1144
content is different.
1145
:param hardlink: If true, hard-link files from accelerator_tree,
1147
:param stacked: If true, create a stacked branch referring to the
1148
location of this control directory.
1149
:param create_tree_if_local: If true, a working-tree will be created
1150
when working locally.
1152
target_transport = get_transport(url, possible_transports)
1153
target_transport.ensure_base()
1154
cloning_format = self.cloning_metadir(stacked)
1155
# Create/update the result branch
1156
result = cloning_format.initialize_on_transport(target_transport)
1157
# if a stacked branch wasn't requested, we don't create one
1158
# even if the origin was stacked
1159
stacked_branch_url = None
1160
if source_branch is not None:
1162
stacked_branch_url = self.root_transport.base
1163
source_repository = source_branch.repository
1166
source_branch = self.open_branch()
1167
source_repository = source_branch.repository
1169
stacked_branch_url = self.root_transport.base
1170
except errors.NotBranchError:
1171
source_branch = None
1173
source_repository = self.open_repository()
1174
except errors.NoRepositoryPresent:
1175
source_repository = None
1176
repository_policy = result.determine_repository_policy(
1177
force_new_repo, stacked_branch_url, require_stacking=stacked)
1178
result_repo, is_new_repo = repository_policy.acquire_repository()
1179
if is_new_repo and revision_id is not None and not stacked:
1180
fetch_spec = graph.PendingAncestryResult(
1181
[revision_id], source_repository)
1184
if source_repository is not None:
1185
# Fetch while stacked to prevent unstacked fetch from
1187
if fetch_spec is None:
1188
result_repo.fetch(source_repository, revision_id=revision_id)
1190
result_repo.fetch(source_repository, fetch_spec=fetch_spec)
1192
if source_branch is None:
1193
# this is for sprouting a bzrdir without a branch; is that
1195
# Not especially, but it's part of the contract.
1196
result_branch = result.create_branch()
1198
result_branch = source_branch.sprout(result,
1199
revision_id=revision_id, repository_policy=repository_policy)
1200
mutter("created new branch %r" % (result_branch,))
1202
# Create/update the result working tree
1203
if (create_tree_if_local and
1204
isinstance(target_transport, local.LocalTransport) and
1205
(result_repo is None or result_repo.make_working_trees())):
1206
wt = result.create_workingtree(accelerator_tree=accelerator_tree,
1210
if wt.path2id('') is None:
1212
wt.set_root_id(self.open_workingtree.get_root_id())
1213
except errors.NoWorkingTree:
1219
if recurse == 'down':
1221
basis = wt.basis_tree()
1223
subtrees = basis.iter_references()
1224
elif result_branch is not None:
1225
basis = result_branch.basis_tree()
1227
subtrees = basis.iter_references()
1228
elif source_branch is not None:
1229
basis = source_branch.basis_tree()
1231
subtrees = basis.iter_references()
1236
for path, file_id in subtrees:
1237
target = urlutils.join(url, urlutils.escape(path))
1238
sublocation = source_branch.reference_parent(file_id, path)
1239
sublocation.bzrdir.sprout(target,
1240
basis.get_reference_revision(file_id, path),
1241
force_new_repo=force_new_repo, recurse=recurse,
1244
if basis is not None:
1248
def push_branch(self, source, revision_id=None, overwrite=False,
1249
remember=False, create_prefix=False):
1250
"""Push the source branch into this BzrDir."""
1252
# If we can open a branch, use its direct repository, otherwise see
1253
# if there is a repository without a branch.
1255
br_to = self.open_branch()
1256
except errors.NotBranchError:
1257
# Didn't find a branch, can we find a repository?
1258
repository_to = self.find_repository()
1260
# Found a branch, so we must have found a repository
1261
repository_to = br_to.repository
1263
push_result = PushResult()
1264
push_result.source_branch = source
1266
# We have a repository but no branch, copy the revisions, and then
1268
repository_to.fetch(source.repository, revision_id=revision_id)
1269
br_to = source.clone(self, revision_id=revision_id)
1270
if source.get_push_location() is None or remember:
1271
source.set_push_location(br_to.base)
1272
push_result.stacked_on = None
1273
push_result.branch_push_result = None
1274
push_result.old_revno = None
1275
push_result.old_revid = _mod_revision.NULL_REVISION
1276
push_result.target_branch = br_to
1277
push_result.master_branch = None
1278
push_result.workingtree_updated = False
1280
# We have successfully opened the branch, remember if necessary:
1281
if source.get_push_location() is None or remember:
1282
source.set_push_location(br_to.base)
1284
tree_to = self.open_workingtree()
1285
except errors.NotLocalUrl:
1286
push_result.branch_push_result = source.push(br_to,
1287
overwrite, stop_revision=revision_id)
1288
push_result.workingtree_updated = False
1289
except errors.NoWorkingTree:
1290
push_result.branch_push_result = source.push(br_to,
1291
overwrite, stop_revision=revision_id)
1292
push_result.workingtree_updated = None # Not applicable
1294
tree_to.lock_write()
1296
push_result.branch_push_result = source.push(
1297
tree_to.branch, overwrite, stop_revision=revision_id)
1301
push_result.workingtree_updated = True
1302
push_result.old_revno = push_result.branch_push_result.old_revno
1303
push_result.old_revid = push_result.branch_push_result.old_revid
1304
push_result.target_branch = \
1305
push_result.branch_push_result.target_branch
1309
class BzrDirHooks(hooks.Hooks):
1310
"""Hooks for BzrDir operations."""
1313
"""Create the default hooks."""
1314
hooks.Hooks.__init__(self)
1315
self.create_hook(hooks.HookPoint('pre_open',
1316
"Invoked before attempting to open a BzrDir with the transport "
1317
"that the open will use.", (1, 14), None))
1319
# install the default hooks
1320
BzrDir.hooks = BzrDirHooks()
1323
class BzrDirPreSplitOut(BzrDir):
1324
"""A common class for the all-in-one formats."""
1326
def __init__(self, _transport, _format):
1327
"""See BzrDir.__init__."""
1328
super(BzrDirPreSplitOut, self).__init__(_transport, _format)
1329
self._control_files = lockable_files.LockableFiles(
1330
self.get_branch_transport(None),
1331
self._format._lock_file_name,
1332
self._format._lock_class)
1334
def break_lock(self):
1335
"""Pre-splitout bzrdirs do not suffer from stale locks."""
1336
raise NotImplementedError(self.break_lock)
1338
def cloning_metadir(self, require_stacking=False):
1339
"""Produce a metadir suitable for cloning with."""
1340
if require_stacking:
1341
return format_registry.make_bzrdir('1.6')
1342
return self._format.__class__()
1344
def clone(self, url, revision_id=None, force_new_repo=False,
1345
preserve_stacking=False):
1346
"""See BzrDir.clone().
1348
force_new_repo has no effect, since this family of formats always
1349
require a new repository.
1350
preserve_stacking has no effect, since no source branch using this
1351
family of formats can be stacked, so there is no stacking to preserve.
1353
self._make_tail(url)
1354
result = self._format._initialize_for_clone(url)
1355
self.open_repository().clone(result, revision_id=revision_id)
1356
from_branch = self.open_branch()
1357
from_branch.clone(result, revision_id=revision_id)
1359
tree = self.open_workingtree()
1360
except errors.NotLocalUrl:
1361
# make a new one, this format always has to have one.
1362
result._init_workingtree()
1367
def create_branch(self):
1368
"""See BzrDir.create_branch."""
1369
return self._format.get_branch_format().initialize(self)
1371
def destroy_branch(self):
1372
"""See BzrDir.destroy_branch."""
1373
raise errors.UnsupportedOperation(self.destroy_branch, self)
1375
def create_repository(self, shared=False):
1376
"""See BzrDir.create_repository."""
1378
raise errors.IncompatibleFormat('shared repository', self._format)
1379
return self.open_repository()
1381
def destroy_repository(self):
1382
"""See BzrDir.destroy_repository."""
1383
raise errors.UnsupportedOperation(self.destroy_repository, self)
1385
def create_workingtree(self, revision_id=None, from_branch=None,
1386
accelerator_tree=None, hardlink=False):
1387
"""See BzrDir.create_workingtree."""
1388
# The workingtree is sometimes created when the bzrdir is created,
1389
# but not when cloning.
1391
# this looks buggy but is not -really-
1392
# because this format creates the workingtree when the bzrdir is
1394
# clone and sprout will have set the revision_id
1395
# and that will have set it for us, its only
1396
# specific uses of create_workingtree in isolation
1397
# that can do wonky stuff here, and that only
1398
# happens for creating checkouts, which cannot be
1399
# done on this format anyway. So - acceptable wart.
1401
warning("can't support hardlinked working trees in %r"
1404
result = self.open_workingtree(recommend_upgrade=False)
1405
except errors.NoSuchFile:
1406
result = self._init_workingtree()
1407
if revision_id is not None:
1408
if revision_id == _mod_revision.NULL_REVISION:
1409
result.set_parent_ids([])
1411
result.set_parent_ids([revision_id])
1414
def _init_workingtree(self):
1415
from bzrlib.workingtree import WorkingTreeFormat2
1417
return WorkingTreeFormat2().initialize(self)
1418
except errors.NotLocalUrl:
1419
# Even though we can't access the working tree, we need to
1420
# create its control files.
1421
return WorkingTreeFormat2()._stub_initialize_on_transport(
1422
self.transport, self._control_files._file_mode)
1424
def destroy_workingtree(self):
1425
"""See BzrDir.destroy_workingtree."""
1426
raise errors.UnsupportedOperation(self.destroy_workingtree, self)
1428
def destroy_workingtree_metadata(self):
1429
"""See BzrDir.destroy_workingtree_metadata."""
1430
raise errors.UnsupportedOperation(self.destroy_workingtree_metadata,
1433
def get_branch_transport(self, branch_format):
1434
"""See BzrDir.get_branch_transport()."""
1435
if branch_format is None:
1436
return self.transport
1438
branch_format.get_format_string()
1439
except NotImplementedError:
1440
return self.transport
1441
raise errors.IncompatibleFormat(branch_format, self._format)
1443
def get_repository_transport(self, repository_format):
1444
"""See BzrDir.get_repository_transport()."""
1445
if repository_format is None:
1446
return self.transport
1448
repository_format.get_format_string()
1449
except NotImplementedError:
1450
return self.transport
1451
raise errors.IncompatibleFormat(repository_format, self._format)
1453
def get_workingtree_transport(self, workingtree_format):
1454
"""See BzrDir.get_workingtree_transport()."""
1455
if workingtree_format is None:
1456
return self.transport
1458
workingtree_format.get_format_string()
1459
except NotImplementedError:
1460
return self.transport
1461
raise errors.IncompatibleFormat(workingtree_format, self._format)
1463
def needs_format_conversion(self, format=None):
1464
"""See BzrDir.needs_format_conversion()."""
1465
# if the format is not the same as the system default,
1466
# an upgrade is needed.
1468
symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1469
% 'needs_format_conversion(format=None)')
1470
format = BzrDirFormat.get_default_format()
1471
return not isinstance(self._format, format.__class__)
1473
def open_branch(self, unsupported=False, ignore_fallbacks=False):
1474
"""See BzrDir.open_branch."""
1475
from bzrlib.branch import BzrBranchFormat4
1476
format = BzrBranchFormat4()
1477
self._check_supported(format, unsupported)
1478
return format.open(self, _found=True)
1480
def sprout(self, url, revision_id=None, force_new_repo=False,
1481
possible_transports=None, accelerator_tree=None,
1482
hardlink=False, stacked=False, create_tree_if_local=True,
1483
source_branch=None):
1484
"""See BzrDir.sprout()."""
1485
if source_branch is not None:
1486
my_branch = self.open_branch()
1487
if source_branch.base != my_branch.base:
1488
raise AssertionError(
1489
"source branch %r is not within %r with branch %r" %
1490
(source_branch, self, my_branch))
1492
raise errors.UnstackableBranchFormat(
1493
self._format, self.root_transport.base)
1494
if not create_tree_if_local:
1495
raise errors.MustHaveWorkingTree(
1496
self._format, self.root_transport.base)
1497
from bzrlib.workingtree import WorkingTreeFormat2
1498
self._make_tail(url)
1499
result = self._format._initialize_for_clone(url)
1501
self.open_repository().clone(result, revision_id=revision_id)
1502
except errors.NoRepositoryPresent:
1505
self.open_branch().sprout(result, revision_id=revision_id)
1506
except errors.NotBranchError:
1509
# we always want a working tree
1510
WorkingTreeFormat2().initialize(result,
1511
accelerator_tree=accelerator_tree,
1516
class BzrDir4(BzrDirPreSplitOut):
1517
"""A .bzr version 4 control object.
1519
This is a deprecated format and may be removed after sept 2006.
1522
def create_repository(self, shared=False):
1523
"""See BzrDir.create_repository."""
1524
return self._format.repository_format.initialize(self, shared)
1526
def needs_format_conversion(self, format=None):
1527
"""Format 4 dirs are always in need of conversion."""
1529
symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1530
% 'needs_format_conversion(format=None)')
1533
def open_repository(self):
1534
"""See BzrDir.open_repository."""
1535
from bzrlib.repofmt.weaverepo import RepositoryFormat4
1536
return RepositoryFormat4().open(self, _found=True)
1539
class BzrDir5(BzrDirPreSplitOut):
1540
"""A .bzr version 5 control object.
1542
This is a deprecated format and may be removed after sept 2006.
1545
def has_workingtree(self):
1546
"""See BzrDir.has_workingtree."""
1549
def open_repository(self):
1550
"""See BzrDir.open_repository."""
1551
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1552
return RepositoryFormat5().open(self, _found=True)
1554
def open_workingtree(self, _unsupported=False,
1555
recommend_upgrade=True):
1556
"""See BzrDir.create_workingtree."""
1557
from bzrlib.workingtree import WorkingTreeFormat2
1558
wt_format = WorkingTreeFormat2()
1559
# we don't warn here about upgrades; that ought to be handled for the
1561
return wt_format.open(self, _found=True)
1564
class BzrDir6(BzrDirPreSplitOut):
1565
"""A .bzr version 6 control object.
1567
This is a deprecated format and may be removed after sept 2006.
1570
def has_workingtree(self):
1571
"""See BzrDir.has_workingtree."""
1574
def open_repository(self):
1575
"""See BzrDir.open_repository."""
1576
from bzrlib.repofmt.weaverepo import RepositoryFormat6
1577
return RepositoryFormat6().open(self, _found=True)
1579
def open_workingtree(self, _unsupported=False,
1580
recommend_upgrade=True):
1581
"""See BzrDir.create_workingtree."""
1582
# we don't warn here about upgrades; that ought to be handled for the
1584
from bzrlib.workingtree import WorkingTreeFormat2
1585
return WorkingTreeFormat2().open(self, _found=True)
1588
class BzrDirMeta1(BzrDir):
1589
"""A .bzr meta version 1 control object.
1591
This is the first control object where the
1592
individual aspects are really split out: there are separate repository,
1593
workingtree and branch subdirectories and any subset of the three can be
1594
present within a BzrDir.
1597
def can_convert_format(self):
1598
"""See BzrDir.can_convert_format()."""
1601
def create_branch(self):
1602
"""See BzrDir.create_branch."""
1603
return self._format.get_branch_format().initialize(self)
1605
def destroy_branch(self):
1606
"""See BzrDir.create_branch."""
1607
self.transport.delete_tree('branch')
1609
def create_repository(self, shared=False):
1610
"""See BzrDir.create_repository."""
1611
return self._format.repository_format.initialize(self, shared)
1613
def destroy_repository(self):
1614
"""See BzrDir.destroy_repository."""
1615
self.transport.delete_tree('repository')
1617
def create_workingtree(self, revision_id=None, from_branch=None,
1618
accelerator_tree=None, hardlink=False):
1619
"""See BzrDir.create_workingtree."""
1620
return self._format.workingtree_format.initialize(
1621
self, revision_id, from_branch=from_branch,
1622
accelerator_tree=accelerator_tree, hardlink=hardlink)
1624
def destroy_workingtree(self):
1625
"""See BzrDir.destroy_workingtree."""
1626
wt = self.open_workingtree(recommend_upgrade=False)
1627
repository = wt.branch.repository
1628
empty = repository.revision_tree(_mod_revision.NULL_REVISION)
1629
wt.revert(old_tree=empty)
1630
self.destroy_workingtree_metadata()
1632
def destroy_workingtree_metadata(self):
1633
self.transport.delete_tree('checkout')
1635
def find_branch_format(self):
1636
"""Find the branch 'format' for this bzrdir.
1638
This might be a synthetic object for e.g. RemoteBranch and SVN.
1640
from bzrlib.branch import BranchFormat
1641
return BranchFormat.find_format(self)
1643
def _get_mkdir_mode(self):
1644
"""Figure out the mode to use when creating a bzrdir subdir."""
1645
temp_control = lockable_files.LockableFiles(self.transport, '',
1646
lockable_files.TransportLock)
1647
return temp_control._dir_mode
1649
def get_branch_reference(self):
1650
"""See BzrDir.get_branch_reference()."""
1651
from bzrlib.branch import BranchFormat
1652
format = BranchFormat.find_format(self)
1653
return format.get_reference(self)
1655
def get_branch_transport(self, branch_format):
1656
"""See BzrDir.get_branch_transport()."""
1657
# XXX: this shouldn't implicitly create the directory if it's just
1658
# promising to get a transport -- mbp 20090727
1659
if branch_format is None:
1660
return self.transport.clone('branch')
1662
branch_format.get_format_string()
1663
except NotImplementedError:
1664
raise errors.IncompatibleFormat(branch_format, self._format)
1666
self.transport.mkdir('branch', mode=self._get_mkdir_mode())
1667
except errors.FileExists:
1669
return self.transport.clone('branch')
1671
def get_repository_transport(self, repository_format):
1672
"""See BzrDir.get_repository_transport()."""
1673
if repository_format is None:
1674
return self.transport.clone('repository')
1676
repository_format.get_format_string()
1677
except NotImplementedError:
1678
raise errors.IncompatibleFormat(repository_format, self._format)
1680
self.transport.mkdir('repository', mode=self._get_mkdir_mode())
1681
except errors.FileExists:
1683
return self.transport.clone('repository')
1685
def get_workingtree_transport(self, workingtree_format):
1686
"""See BzrDir.get_workingtree_transport()."""
1687
if workingtree_format is None:
1688
return self.transport.clone('checkout')
1690
workingtree_format.get_format_string()
1691
except NotImplementedError:
1692
raise errors.IncompatibleFormat(workingtree_format, self._format)
1694
self.transport.mkdir('checkout', mode=self._get_mkdir_mode())
1695
except errors.FileExists:
1697
return self.transport.clone('checkout')
1699
def has_workingtree(self):
1700
"""Tell if this bzrdir contains a working tree.
1702
This will still raise an exception if the bzrdir has a workingtree that
1703
is remote & inaccessible.
1705
Note: if you're going to open the working tree, you should just go
1706
ahead and try, and not ask permission first.
1708
from bzrlib.workingtree import WorkingTreeFormat
1710
WorkingTreeFormat.find_format(self)
1711
except errors.NoWorkingTree:
1715
def needs_format_conversion(self, format=None):
1716
"""See BzrDir.needs_format_conversion()."""
1718
symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1719
% 'needs_format_conversion(format=None)')
1721
format = BzrDirFormat.get_default_format()
1722
if not isinstance(self._format, format.__class__):
1723
# it is not a meta dir format, conversion is needed.
1725
# we might want to push this down to the repository?
1727
if not isinstance(self.open_repository()._format,
1728
format.repository_format.__class__):
1729
# the repository needs an upgrade.
1731
except errors.NoRepositoryPresent:
1734
if not isinstance(self.open_branch()._format,
1735
format.get_branch_format().__class__):
1736
# the branch needs an upgrade.
1738
except errors.NotBranchError:
1741
my_wt = self.open_workingtree(recommend_upgrade=False)
1742
if not isinstance(my_wt._format,
1743
format.workingtree_format.__class__):
1744
# the workingtree needs an upgrade.
1746
except (errors.NoWorkingTree, errors.NotLocalUrl):
1750
def open_branch(self, unsupported=False, ignore_fallbacks=False):
1751
"""See BzrDir.open_branch."""
1752
format = self.find_branch_format()
1753
self._check_supported(format, unsupported)
1754
return format.open(self, _found=True, ignore_fallbacks=ignore_fallbacks)
1756
def open_repository(self, unsupported=False):
1757
"""See BzrDir.open_repository."""
1758
from bzrlib.repository import RepositoryFormat
1759
format = RepositoryFormat.find_format(self)
1760
self._check_supported(format, unsupported)
1761
return format.open(self, _found=True)
1763
def open_workingtree(self, unsupported=False,
1764
recommend_upgrade=True):
1765
"""See BzrDir.open_workingtree."""
1766
from bzrlib.workingtree import WorkingTreeFormat
1767
format = WorkingTreeFormat.find_format(self)
1768
self._check_supported(format, unsupported,
1770
basedir=self.root_transport.base)
1771
return format.open(self, _found=True)
1773
def _get_config(self):
1774
return config.TransportConfig(self.transport, 'control.conf')
1777
class BzrDirFormat(object):
1778
"""An encapsulation of the initialization and open routines for a format.
1780
Formats provide three things:
1781
* An initialization routine,
1785
Formats are placed in a dict by their format string for reference
1786
during bzrdir opening. These should be subclasses of BzrDirFormat
1789
Once a format is deprecated, just deprecate the initialize and open
1790
methods on the format class. Do not deprecate the object, as the
1791
object will be created every system load.
1794
_default_format = None
1795
"""The default format used for new .bzr dirs."""
1798
"""The known formats."""
1800
_control_formats = []
1801
"""The registered control formats - .bzr, ....
1803
This is a list of BzrDirFormat objects.
1806
_control_server_formats = []
1807
"""The registered control server formats, e.g. RemoteBzrDirs.
1809
This is a list of BzrDirFormat objects.
1812
_lock_file_name = 'branch-lock'
1814
# _lock_class must be set in subclasses to the lock type, typ.
1815
# TransportLock or LockDir
1818
def find_format(klass, transport, _server_formats=True):
1819
"""Return the format present at transport."""
1821
formats = klass._control_server_formats + klass._control_formats
1823
formats = klass._control_formats
1824
for format in formats:
1826
return format.probe_transport(transport)
1827
except errors.NotBranchError:
1828
# this format does not find a control dir here.
1830
raise errors.NotBranchError(path=transport.base)
1833
def probe_transport(klass, transport):
1834
"""Return the .bzrdir style format present in a directory."""
1836
format_string = transport.get_bytes(".bzr/branch-format")
1837
except errors.NoSuchFile:
1838
raise errors.NotBranchError(path=transport.base)
1841
return klass._formats[format_string]
1843
raise errors.UnknownFormatError(format=format_string, kind='bzrdir')
1846
def get_default_format(klass):
1847
"""Return the current default format."""
1848
return klass._default_format
1850
def get_format_string(self):
1851
"""Return the ASCII format string that identifies this format."""
1852
raise NotImplementedError(self.get_format_string)
1854
def get_format_description(self):
1855
"""Return the short description for this format."""
1856
raise NotImplementedError(self.get_format_description)
1858
def get_converter(self, format=None):
1859
"""Return the converter to use to convert bzrdirs needing converts.
1861
This returns a bzrlib.bzrdir.Converter object.
1863
This should return the best upgrader to step this format towards the
1864
current default format. In the case of plugins we can/should provide
1865
some means for them to extend the range of returnable converters.
1867
:param format: Optional format to override the default format of the
1870
raise NotImplementedError(self.get_converter)
1872
def initialize(self, url, possible_transports=None):
1873
"""Create a bzr control dir at this url and return an opened copy.
1875
While not deprecated, this method is very specific and its use will
1876
lead to many round trips to setup a working environment. See
1877
initialize_on_transport_ex for a [nearly] all-in-one method.
1879
Subclasses should typically override initialize_on_transport
1880
instead of this method.
1882
return self.initialize_on_transport(get_transport(url,
1883
possible_transports))
1885
def initialize_on_transport(self, transport):
1886
"""Initialize a new bzrdir in the base directory of a Transport."""
1888
# can we hand off the request to the smart server rather than using
1890
client_medium = transport.get_smart_medium()
1891
except errors.NoSmartMedium:
1892
return self._initialize_on_transport_vfs(transport)
1894
# Current RPC's only know how to create bzr metadir1 instances, so
1895
# we still delegate to vfs methods if the requested format is not a
1897
if type(self) != BzrDirMetaFormat1:
1898
return self._initialize_on_transport_vfs(transport)
1899
remote_format = RemoteBzrDirFormat()
1900
self._supply_sub_formats_to(remote_format)
1901
return remote_format.initialize_on_transport(transport)
1903
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
1904
create_prefix=False, force_new_repo=False, stacked_on=None,
1905
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
1906
shared_repo=False, vfs_only=False):
1907
"""Create this format on transport.
1909
The directory to initialize will be created.
1911
:param force_new_repo: Do not use a shared repository for the target,
1912
even if one is available.
1913
:param create_prefix: Create any missing directories leading up to
1915
:param use_existing_dir: Use an existing directory if one exists.
1916
:param stacked_on: A url to stack any created branch on, None to follow
1917
any target stacking policy.
1918
:param stack_on_pwd: If stack_on is relative, the location it is
1920
:param repo_format_name: If non-None, a repository will be
1921
made-or-found. Should none be found, or if force_new_repo is True
1922
the repo_format_name is used to select the format of repository to
1924
:param make_working_trees: Control the setting of make_working_trees
1925
for a new shared repository when one is made. None to use whatever
1926
default the format has.
1927
:param shared_repo: Control whether made repositories are shared or
1929
:param vfs_only: If True do not attempt to use a smart server
1930
:return: repo, bzrdir, require_stacking, repository_policy. repo is
1931
None if none was created or found, bzrdir is always valid.
1932
require_stacking is the result of examining the stacked_on
1933
parameter and any stacking policy found for the target.
1936
# Try to hand off to a smart server
1938
client_medium = transport.get_smart_medium()
1939
except errors.NoSmartMedium:
1942
# TODO: lookup the local format from a server hint.
1943
remote_dir_format = RemoteBzrDirFormat()
1944
remote_dir_format._network_name = self.network_name()
1945
self._supply_sub_formats_to(remote_dir_format)
1946
return remote_dir_format.initialize_on_transport_ex(transport,
1947
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
1948
force_new_repo=force_new_repo, stacked_on=stacked_on,
1949
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
1950
make_working_trees=make_working_trees, shared_repo=shared_repo)
1951
# XXX: Refactor the create_prefix/no_create_prefix code into a
1952
# common helper function
1953
# The destination may not exist - if so make it according to policy.
1954
def make_directory(transport):
1955
transport.mkdir('.')
1957
def redirected(transport, e, redirection_notice):
1958
note(redirection_notice)
1959
return transport._redirected_to(e.source, e.target)
1961
transport = do_catching_redirections(make_directory, transport,
1963
except errors.FileExists:
1964
if not use_existing_dir:
1966
except errors.NoSuchFile:
1967
if not create_prefix:
1969
transport.create_prefix()
1971
require_stacking = (stacked_on is not None)
1972
# Now the target directory exists, but doesn't have a .bzr
1973
# directory. So we need to create it, along with any work to create
1974
# all of the dependent branches, etc.
1976
result = self.initialize_on_transport(transport)
1977
if repo_format_name:
1979
# use a custom format
1980
result._format.repository_format = \
1981
repository.network_format_registry.get(repo_format_name)
1982
except AttributeError:
1983
# The format didn't permit it to be set.
1985
# A repository is desired, either in-place or shared.
1986
repository_policy = result.determine_repository_policy(
1987
force_new_repo, stacked_on, stack_on_pwd,
1988
require_stacking=require_stacking)
1989
result_repo, is_new_repo = repository_policy.acquire_repository(
1990
make_working_trees, shared_repo)
1991
if not require_stacking and repository_policy._require_stacking:
1992
require_stacking = True
1993
result._format.require_stacking()
1994
result_repo.lock_write()
1997
repository_policy = None
1998
return result_repo, result, require_stacking, repository_policy
2000
def _initialize_on_transport_vfs(self, transport):
2001
"""Initialize a new bzrdir using VFS calls.
2003
:param transport: The transport to create the .bzr directory in.
2006
# Since we are creating a .bzr directory, inherit the
2007
# mode from the root directory
2008
temp_control = lockable_files.LockableFiles(transport,
2009
'', lockable_files.TransportLock)
2010
temp_control._transport.mkdir('.bzr',
2011
# FIXME: RBC 20060121 don't peek under
2013
mode=temp_control._dir_mode)
2014
if sys.platform == 'win32' and isinstance(transport, local.LocalTransport):
2015
win32utils.set_file_attr_hidden(transport._abspath('.bzr'))
2016
file_mode = temp_control._file_mode
2018
bzrdir_transport = transport.clone('.bzr')
2019
utf8_files = [('README',
2020
"This is a Bazaar control directory.\n"
2021
"Do not change any files in this directory.\n"
2022
"See http://bazaar-vcs.org/ for more information about Bazaar.\n"),
2023
('branch-format', self.get_format_string()),
2025
# NB: no need to escape relative paths that are url safe.
2026
control_files = lockable_files.LockableFiles(bzrdir_transport,
2027
self._lock_file_name, self._lock_class)
2028
control_files.create_lock()
2029
control_files.lock_write()
2031
for (filename, content) in utf8_files:
2032
bzrdir_transport.put_bytes(filename, content,
2035
control_files.unlock()
2036
return self.open(transport, _found=True)
2038
def is_supported(self):
2039
"""Is this format supported?
2041
Supported formats must be initializable and openable.
2042
Unsupported formats may not support initialization or committing or
2043
some other features depending on the reason for not being supported.
2047
def network_name(self):
2048
"""A simple byte string uniquely identifying this format for RPC calls.
2050
Bzr control formats use thir disk format string to identify the format
2051
over the wire. Its possible that other control formats have more
2052
complex detection requirements, so we permit them to use any unique and
2053
immutable string they desire.
2055
raise NotImplementedError(self.network_name)
2057
def same_model(self, target_format):
2058
return (self.repository_format.rich_root_data ==
2059
target_format.rich_root_data)
2062
def known_formats(klass):
2063
"""Return all the known formats.
2065
Concrete formats should override _known_formats.
2067
# There is double indirection here to make sure that control
2068
# formats used by more than one dir format will only be probed
2069
# once. This can otherwise be quite expensive for remote connections.
2071
for format in klass._control_formats:
2072
result.update(format._known_formats())
2076
def _known_formats(klass):
2077
"""Return the known format instances for this control format."""
2078
return set(klass._formats.values())
2080
def open(self, transport, _found=False):
2081
"""Return an instance of this format for the dir transport points at.
2083
_found is a private parameter, do not use it.
2086
found_format = BzrDirFormat.find_format(transport)
2087
if not isinstance(found_format, self.__class__):
2088
raise AssertionError("%s was asked to open %s, but it seems to need "
2090
% (self, transport, found_format))
2091
# Allow subclasses - use the found format.
2092
self._supply_sub_formats_to(found_format)
2093
return found_format._open(transport)
2094
return self._open(transport)
2096
def _open(self, transport):
2097
"""Template method helper for opening BzrDirectories.
2099
This performs the actual open and any additional logic or parameter
2102
raise NotImplementedError(self._open)
2105
def register_format(klass, format):
2106
klass._formats[format.get_format_string()] = format
2107
# bzr native formats have a network name of their format string.
2108
network_format_registry.register(format.get_format_string(), format.__class__)
2111
def register_control_format(klass, format):
2112
"""Register a format that does not use '.bzr' for its control dir.
2114
TODO: This should be pulled up into a 'ControlDirFormat' base class
2115
which BzrDirFormat can inherit from, and renamed to register_format
2116
there. It has been done without that for now for simplicity of
2119
klass._control_formats.append(format)
2122
def register_control_server_format(klass, format):
2123
"""Register a control format for client-server environments.
2125
These formats will be tried before ones registered with
2126
register_control_format. This gives implementations that decide to the
2127
chance to grab it before anything looks at the contents of the format
2130
klass._control_server_formats.append(format)
2133
def _set_default_format(klass, format):
2134
"""Set default format (for testing behavior of defaults only)"""
2135
klass._default_format = format
2139
return self.get_format_description().rstrip()
2141
def _supply_sub_formats_to(self, other_format):
2142
"""Give other_format the same values for sub formats as this has.
2144
This method is expected to be used when parameterising a
2145
RemoteBzrDirFormat instance with the parameters from a
2146
BzrDirMetaFormat1 instance.
2148
:param other_format: other_format is a format which should be
2149
compatible with whatever sub formats are supported by self.
2154
def unregister_format(klass, format):
2155
del klass._formats[format.get_format_string()]
2158
def unregister_control_format(klass, format):
2159
klass._control_formats.remove(format)
2162
class BzrDirFormat4(BzrDirFormat):
2163
"""Bzr dir format 4.
2165
This format is a combined format for working tree, branch and repository.
2167
- Format 1 working trees [always]
2168
- Format 4 branches [always]
2169
- Format 4 repositories [always]
2171
This format is deprecated: it indexes texts using a text it which is
2172
removed in format 5; write support for this format has been removed.
2175
_lock_class = lockable_files.TransportLock
2177
def get_format_string(self):
2178
"""See BzrDirFormat.get_format_string()."""
2179
return "Bazaar-NG branch, format 0.0.4\n"
2181
def get_format_description(self):
2182
"""See BzrDirFormat.get_format_description()."""
2183
return "All-in-one format 4"
2185
def get_converter(self, format=None):
2186
"""See BzrDirFormat.get_converter()."""
2187
# there is one and only one upgrade path here.
2188
return ConvertBzrDir4To5()
2190
def initialize_on_transport(self, transport):
2191
"""Format 4 branches cannot be created."""
2192
raise errors.UninitializableFormat(self)
2194
def is_supported(self):
2195
"""Format 4 is not supported.
2197
It is not supported because the model changed from 4 to 5 and the
2198
conversion logic is expensive - so doing it on the fly was not
2203
def network_name(self):
2204
return self.get_format_string()
2206
def _open(self, transport):
2207
"""See BzrDirFormat._open."""
2208
return BzrDir4(transport, self)
2210
def __return_repository_format(self):
2211
"""Circular import protection."""
2212
from bzrlib.repofmt.weaverepo import RepositoryFormat4
2213
return RepositoryFormat4()
2214
repository_format = property(__return_repository_format)
2217
class BzrDirFormatAllInOne(BzrDirFormat):
2218
"""Common class for formats before meta-dirs."""
2220
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
2221
create_prefix=False, force_new_repo=False, stacked_on=None,
2222
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
2224
"""See BzrDirFormat.initialize_on_transport_ex."""
2225
require_stacking = (stacked_on is not None)
2226
# Format 5 cannot stack, but we've been asked to - actually init
2228
if require_stacking:
2229
format = BzrDirMetaFormat1()
2230
return format.initialize_on_transport_ex(transport,
2231
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2232
force_new_repo=force_new_repo, stacked_on=stacked_on,
2233
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2234
make_working_trees=make_working_trees, shared_repo=shared_repo)
2235
return BzrDirFormat.initialize_on_transport_ex(self, transport,
2236
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2237
force_new_repo=force_new_repo, stacked_on=stacked_on,
2238
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2239
make_working_trees=make_working_trees, shared_repo=shared_repo)
2242
class BzrDirFormat5(BzrDirFormatAllInOne):
2243
"""Bzr control format 5.
2245
This format is a combined format for working tree, branch and repository.
2247
- Format 2 working trees [always]
2248
- Format 4 branches [always]
2249
- Format 5 repositories [always]
2250
Unhashed stores in the repository.
2253
_lock_class = lockable_files.TransportLock
2255
def get_format_string(self):
2256
"""See BzrDirFormat.get_format_string()."""
2257
return "Bazaar-NG branch, format 5\n"
2259
def get_branch_format(self):
2260
from bzrlib import branch
2261
return branch.BzrBranchFormat4()
2263
def get_format_description(self):
2264
"""See BzrDirFormat.get_format_description()."""
2265
return "All-in-one format 5"
2267
def get_converter(self, format=None):
2268
"""See BzrDirFormat.get_converter()."""
2269
# there is one and only one upgrade path here.
2270
return ConvertBzrDir5To6()
2272
def _initialize_for_clone(self, url):
2273
return self.initialize_on_transport(get_transport(url), _cloning=True)
2275
def initialize_on_transport(self, transport, _cloning=False):
2276
"""Format 5 dirs always have working tree, branch and repository.
2278
Except when they are being cloned.
2280
from bzrlib.branch import BzrBranchFormat4
2281
from bzrlib.repofmt.weaverepo import RepositoryFormat5
2282
result = (super(BzrDirFormat5, self).initialize_on_transport(transport))
2283
RepositoryFormat5().initialize(result, _internal=True)
2285
branch = BzrBranchFormat4().initialize(result)
2286
result._init_workingtree()
2289
def network_name(self):
2290
return self.get_format_string()
2292
def _open(self, transport):
2293
"""See BzrDirFormat._open."""
2294
return BzrDir5(transport, self)
2296
def __return_repository_format(self):
2297
"""Circular import protection."""
2298
from bzrlib.repofmt.weaverepo import RepositoryFormat5
2299
return RepositoryFormat5()
2300
repository_format = property(__return_repository_format)
2303
class BzrDirFormat6(BzrDirFormatAllInOne):
2304
"""Bzr control format 6.
2306
This format is a combined format for working tree, branch and repository.
2308
- Format 2 working trees [always]
2309
- Format 4 branches [always]
2310
- Format 6 repositories [always]
2313
_lock_class = lockable_files.TransportLock
2315
def get_format_string(self):
2316
"""See BzrDirFormat.get_format_string()."""
2317
return "Bazaar-NG branch, format 6\n"
2319
def get_format_description(self):
2320
"""See BzrDirFormat.get_format_description()."""
2321
return "All-in-one format 6"
2323
def get_branch_format(self):
2324
from bzrlib import branch
2325
return branch.BzrBranchFormat4()
2327
def get_converter(self, format=None):
2328
"""See BzrDirFormat.get_converter()."""
2329
# there is one and only one upgrade path here.
2330
return ConvertBzrDir6ToMeta()
2332
def _initialize_for_clone(self, url):
2333
return self.initialize_on_transport(get_transport(url), _cloning=True)
2335
def initialize_on_transport(self, transport, _cloning=False):
2336
"""Format 6 dirs always have working tree, branch and repository.
2338
Except when they are being cloned.
2340
from bzrlib.branch import BzrBranchFormat4
2341
from bzrlib.repofmt.weaverepo import RepositoryFormat6
2342
result = super(BzrDirFormat6, self).initialize_on_transport(transport)
2343
RepositoryFormat6().initialize(result, _internal=True)
2345
branch = BzrBranchFormat4().initialize(result)
2346
result._init_workingtree()
2349
def network_name(self):
2350
return self.get_format_string()
2352
def _open(self, transport):
2353
"""See BzrDirFormat._open."""
2354
return BzrDir6(transport, self)
2356
def __return_repository_format(self):
2357
"""Circular import protection."""
2358
from bzrlib.repofmt.weaverepo import RepositoryFormat6
2359
return RepositoryFormat6()
2360
repository_format = property(__return_repository_format)
2363
class BzrDirMetaFormat1(BzrDirFormat):
2364
"""Bzr meta control format 1
2366
This is the first format with split out working tree, branch and repository
2369
- Format 3 working trees [optional]
2370
- Format 5 branches [optional]
2371
- Format 7 repositories [optional]
2374
_lock_class = lockdir.LockDir
2377
self._workingtree_format = None
2378
self._branch_format = None
2379
self._repository_format = None
2381
def __eq__(self, other):
2382
if other.__class__ is not self.__class__:
2384
if other.repository_format != self.repository_format:
2386
if other.workingtree_format != self.workingtree_format:
2390
def __ne__(self, other):
2391
return not self == other
2393
def get_branch_format(self):
2394
if self._branch_format is None:
2395
from bzrlib.branch import BranchFormat
2396
self._branch_format = BranchFormat.get_default_format()
2397
return self._branch_format
2399
def set_branch_format(self, format):
2400
self._branch_format = format
2402
def require_stacking(self, stack_on=None, possible_transports=None,
2404
"""We have a request to stack, try to ensure the formats support it.
2406
:param stack_on: If supplied, it is the URL to a branch that we want to
2407
stack on. Check to see if that format supports stacking before
2410
# Stacking is desired. requested by the target, but does the place it
2411
# points at support stacking? If it doesn't then we should
2412
# not implicitly upgrade. We check this here.
2413
new_repo_format = None
2414
new_branch_format = None
2416
# a bit of state for get_target_branch so that we don't try to open it
2417
# 2 times, for both repo *and* branch
2418
target = [None, False, None] # target_branch, checked, upgrade anyway
2419
def get_target_branch():
2421
# We've checked, don't check again
2423
if stack_on is None:
2424
# No target format, that means we want to force upgrading
2425
target[:] = [None, True, True]
2428
target_dir = BzrDir.open(stack_on,
2429
possible_transports=possible_transports)
2430
except errors.NotBranchError:
2431
# Nothing there, don't change formats
2432
target[:] = [None, True, False]
2434
except errors.JailBreak:
2435
# JailBreak, JFDI and upgrade anyway
2436
target[:] = [None, True, True]
2439
target_branch = target_dir.open_branch()
2440
except errors.NotBranchError:
2441
# No branch, don't upgrade formats
2442
target[:] = [None, True, False]
2444
target[:] = [target_branch, True, False]
2447
if (not _skip_repo and
2448
not self.repository_format.supports_external_lookups):
2449
# We need to upgrade the Repository.
2450
target_branch, _, do_upgrade = get_target_branch()
2451
if target_branch is None:
2452
# We don't have a target branch, should we upgrade anyway?
2454
# stack_on is inaccessible, JFDI.
2455
# TODO: bad monkey, hard-coded formats...
2456
if self.repository_format.rich_root_data:
2457
new_repo_format = pack_repo.RepositoryFormatKnitPack5RichRoot()
2459
new_repo_format = pack_repo.RepositoryFormatKnitPack5()
2461
# If the target already supports stacking, then we know the
2462
# project is already able to use stacking, so auto-upgrade
2464
new_repo_format = target_branch.repository._format
2465
if not new_repo_format.supports_external_lookups:
2466
# target doesn't, source doesn't, so don't auto upgrade
2468
new_repo_format = None
2469
if new_repo_format is not None:
2470
self.repository_format = new_repo_format
2471
note('Source repository format does not support stacking,'
2472
' using format:\n %s',
2473
new_repo_format.get_format_description())
2475
if not self.get_branch_format().supports_stacking():
2476
# We just checked the repo, now lets check if we need to
2477
# upgrade the branch format
2478
target_branch, _, do_upgrade = get_target_branch()
2479
if target_branch is None:
2481
# TODO: bad monkey, hard-coded formats...
2482
new_branch_format = branch.BzrBranchFormat7()
2484
new_branch_format = target_branch._format
2485
if not new_branch_format.supports_stacking():
2486
new_branch_format = None
2487
if new_branch_format is not None:
2488
# Does support stacking, use its format.
2489
self.set_branch_format(new_branch_format)
2490
note('Source branch format does not support stacking,'
2491
' using format:\n %s',
2492
new_branch_format.get_format_description())
2494
def get_converter(self, format=None):
2495
"""See BzrDirFormat.get_converter()."""
2497
format = BzrDirFormat.get_default_format()
2498
if not isinstance(self, format.__class__):
2499
# converting away from metadir is not implemented
2500
raise NotImplementedError(self.get_converter)
2501
return ConvertMetaToMeta(format)
2503
def get_format_string(self):
2504
"""See BzrDirFormat.get_format_string()."""
2505
return "Bazaar-NG meta directory, format 1\n"
2507
def get_format_description(self):
2508
"""See BzrDirFormat.get_format_description()."""
2509
return "Meta directory format 1"
2511
def network_name(self):
2512
return self.get_format_string()
2514
def _open(self, transport):
2515
"""See BzrDirFormat._open."""
2516
# Create a new format instance because otherwise initialisation of new
2517
# metadirs share the global default format object leading to alias
2519
format = BzrDirMetaFormat1()
2520
self._supply_sub_formats_to(format)
2521
return BzrDirMeta1(transport, format)
2523
def __return_repository_format(self):
2524
"""Circular import protection."""
2525
if self._repository_format:
2526
return self._repository_format
2527
from bzrlib.repository import RepositoryFormat
2528
return RepositoryFormat.get_default_format()
2530
def _set_repository_format(self, value):
2531
"""Allow changing the repository format for metadir formats."""
2532
self._repository_format = value
2534
repository_format = property(__return_repository_format,
2535
_set_repository_format)
2537
def _supply_sub_formats_to(self, other_format):
2538
"""Give other_format the same values for sub formats as this has.
2540
This method is expected to be used when parameterising a
2541
RemoteBzrDirFormat instance with the parameters from a
2542
BzrDirMetaFormat1 instance.
2544
:param other_format: other_format is a format which should be
2545
compatible with whatever sub formats are supported by self.
2548
if getattr(self, '_repository_format', None) is not None:
2549
other_format.repository_format = self.repository_format
2550
if self._branch_format is not None:
2551
other_format._branch_format = self._branch_format
2552
if self._workingtree_format is not None:
2553
other_format.workingtree_format = self.workingtree_format
2555
def __get_workingtree_format(self):
2556
if self._workingtree_format is None:
2557
from bzrlib.workingtree import WorkingTreeFormat
2558
self._workingtree_format = WorkingTreeFormat.get_default_format()
2559
return self._workingtree_format
2561
def __set_workingtree_format(self, wt_format):
2562
self._workingtree_format = wt_format
2564
workingtree_format = property(__get_workingtree_format,
2565
__set_workingtree_format)
2568
network_format_registry = registry.FormatRegistry()
2569
"""Registry of formats indexed by their network name.
2571
The network name for a BzrDirFormat is an identifier that can be used when
2572
referring to formats with smart server operations. See
2573
BzrDirFormat.network_name() for more detail.
2577
# Register bzr control format
2578
BzrDirFormat.register_control_format(BzrDirFormat)
2580
# Register bzr formats
2581
BzrDirFormat.register_format(BzrDirFormat4())
2582
BzrDirFormat.register_format(BzrDirFormat5())
2583
BzrDirFormat.register_format(BzrDirFormat6())
2584
__default_format = BzrDirMetaFormat1()
2585
BzrDirFormat.register_format(__default_format)
2586
BzrDirFormat._default_format = __default_format
2589
class Converter(object):
2590
"""Converts a disk format object from one format to another."""
2592
def convert(self, to_convert, pb):
2593
"""Perform the conversion of to_convert, giving feedback via pb.
2595
:param to_convert: The disk object to convert.
2596
:param pb: a progress bar to use for progress information.
2599
def step(self, message):
2600
"""Update the pb by a step."""
2602
self.pb.update(message, self.count, self.total)
2605
class ConvertBzrDir4To5(Converter):
2606
"""Converts format 4 bzr dirs to format 5."""
2609
super(ConvertBzrDir4To5, self).__init__()
2610
self.converted_revs = set()
2611
self.absent_revisions = set()
2615
def convert(self, to_convert, pb):
2616
"""See Converter.convert()."""
2617
self.bzrdir = to_convert
2619
warnings.warn("pb parameter to convert() is deprecated")
2620
self.pb = ui.ui_factory.nested_progress_bar()
2622
ui.ui_factory.note('starting upgrade from format 4 to 5')
2623
if isinstance(self.bzrdir.transport, local.LocalTransport):
2624
self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
2625
self._convert_to_weaves()
2626
return BzrDir.open(self.bzrdir.root_transport.base)
2630
def _convert_to_weaves(self):
2631
ui.ui_factory.note('note: upgrade may be faster if all store files are ungzipped first')
2634
stat = self.bzrdir.transport.stat('weaves')
2635
if not S_ISDIR(stat.st_mode):
2636
self.bzrdir.transport.delete('weaves')
2637
self.bzrdir.transport.mkdir('weaves')
2638
except errors.NoSuchFile:
2639
self.bzrdir.transport.mkdir('weaves')
2640
# deliberately not a WeaveFile as we want to build it up slowly.
2641
self.inv_weave = Weave('inventory')
2642
# holds in-memory weaves for all files
2643
self.text_weaves = {}
2644
self.bzrdir.transport.delete('branch-format')
2645
self.branch = self.bzrdir.open_branch()
2646
self._convert_working_inv()
2647
rev_history = self.branch.revision_history()
2648
# to_read is a stack holding the revisions we still need to process;
2649
# appending to it adds new highest-priority revisions
2650
self.known_revisions = set(rev_history)
2651
self.to_read = rev_history[-1:]
2653
rev_id = self.to_read.pop()
2654
if (rev_id not in self.revisions
2655
and rev_id not in self.absent_revisions):
2656
self._load_one_rev(rev_id)
2658
to_import = self._make_order()
2659
for i, rev_id in enumerate(to_import):
2660
self.pb.update('converting revision', i, len(to_import))
2661
self._convert_one_rev(rev_id)
2663
self._write_all_weaves()
2664
self._write_all_revs()
2665
ui.ui_factory.note('upgraded to weaves:')
2666
ui.ui_factory.note(' %6d revisions and inventories' % len(self.revisions))
2667
ui.ui_factory.note(' %6d revisions not present' % len(self.absent_revisions))
2668
ui.ui_factory.note(' %6d texts' % self.text_count)
2669
self._cleanup_spare_files_after_format4()
2670
self.branch._transport.put_bytes(
2672
BzrDirFormat5().get_format_string(),
2673
mode=self.bzrdir._get_file_mode())
2675
def _cleanup_spare_files_after_format4(self):
2676
# FIXME working tree upgrade foo.
2677
for n in 'merged-patches', 'pending-merged-patches':
2679
## assert os.path.getsize(p) == 0
2680
self.bzrdir.transport.delete(n)
2681
except errors.NoSuchFile:
2683
self.bzrdir.transport.delete_tree('inventory-store')
2684
self.bzrdir.transport.delete_tree('text-store')
2686
def _convert_working_inv(self):
2687
inv = xml4.serializer_v4.read_inventory(
2688
self.branch._transport.get('inventory'))
2689
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv, working=True)
2690
self.branch._transport.put_bytes('inventory', new_inv_xml,
2691
mode=self.bzrdir._get_file_mode())
2693
def _write_all_weaves(self):
2694
controlweaves = WeaveStore(self.bzrdir.transport, prefixed=False)
2695
weave_transport = self.bzrdir.transport.clone('weaves')
2696
weaves = WeaveStore(weave_transport, prefixed=False)
2697
transaction = WriteTransaction()
2701
for file_id, file_weave in self.text_weaves.items():
2702
self.pb.update('writing weave', i, len(self.text_weaves))
2703
weaves._put_weave(file_id, file_weave, transaction)
2705
self.pb.update('inventory', 0, 1)
2706
controlweaves._put_weave('inventory', self.inv_weave, transaction)
2707
self.pb.update('inventory', 1, 1)
2711
def _write_all_revs(self):
2712
"""Write all revisions out in new form."""
2713
self.bzrdir.transport.delete_tree('revision-store')
2714
self.bzrdir.transport.mkdir('revision-store')
2715
revision_transport = self.bzrdir.transport.clone('revision-store')
2717
from bzrlib.xml5 import serializer_v5
2718
from bzrlib.repofmt.weaverepo import RevisionTextStore
2719
revision_store = RevisionTextStore(revision_transport,
2720
serializer_v5, False, versionedfile.PrefixMapper(),
2721
lambda:True, lambda:True)
2723
for i, rev_id in enumerate(self.converted_revs):
2724
self.pb.update('write revision', i, len(self.converted_revs))
2725
text = serializer_v5.write_revision_to_string(
2726
self.revisions[rev_id])
2728
revision_store.add_lines(key, None, osutils.split_lines(text))
2732
def _load_one_rev(self, rev_id):
2733
"""Load a revision object into memory.
2735
Any parents not either loaded or abandoned get queued to be
2737
self.pb.update('loading revision',
2738
len(self.revisions),
2739
len(self.known_revisions))
2740
if not self.branch.repository.has_revision(rev_id):
2742
ui.ui_factory.note('revision {%s} not present in branch; '
2743
'will be converted as a ghost' %
2745
self.absent_revisions.add(rev_id)
2747
rev = self.branch.repository.get_revision(rev_id)
2748
for parent_id in rev.parent_ids:
2749
self.known_revisions.add(parent_id)
2750
self.to_read.append(parent_id)
2751
self.revisions[rev_id] = rev
2753
def _load_old_inventory(self, rev_id):
2754
old_inv_xml = self.branch.repository.inventory_store.get(rev_id).read()
2755
inv = xml4.serializer_v4.read_inventory_from_string(old_inv_xml)
2756
inv.revision_id = rev_id
2757
rev = self.revisions[rev_id]
2760
def _load_updated_inventory(self, rev_id):
2761
inv_xml = self.inv_weave.get_text(rev_id)
2762
inv = xml5.serializer_v5.read_inventory_from_string(inv_xml, rev_id)
2765
def _convert_one_rev(self, rev_id):
2766
"""Convert revision and all referenced objects to new format."""
2767
rev = self.revisions[rev_id]
2768
inv = self._load_old_inventory(rev_id)
2769
present_parents = [p for p in rev.parent_ids
2770
if p not in self.absent_revisions]
2771
self._convert_revision_contents(rev, inv, present_parents)
2772
self._store_new_inv(rev, inv, present_parents)
2773
self.converted_revs.add(rev_id)
2775
def _store_new_inv(self, rev, inv, present_parents):
2776
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
2777
new_inv_sha1 = sha_string(new_inv_xml)
2778
self.inv_weave.add_lines(rev.revision_id,
2780
new_inv_xml.splitlines(True))
2781
rev.inventory_sha1 = new_inv_sha1
2783
def _convert_revision_contents(self, rev, inv, present_parents):
2784
"""Convert all the files within a revision.
2786
Also upgrade the inventory to refer to the text revision ids."""
2787
rev_id = rev.revision_id
2788
mutter('converting texts of revision {%s}',
2790
parent_invs = map(self._load_updated_inventory, present_parents)
2791
entries = inv.iter_entries()
2793
for path, ie in entries:
2794
self._convert_file_version(rev, ie, parent_invs)
2796
def _convert_file_version(self, rev, ie, parent_invs):
2797
"""Convert one version of one file.
2799
The file needs to be added into the weave if it is a merge
2800
of >=2 parents or if it's changed from its parent.
2802
file_id = ie.file_id
2803
rev_id = rev.revision_id
2804
w = self.text_weaves.get(file_id)
2807
self.text_weaves[file_id] = w
2808
text_changed = False
2809
parent_candiate_entries = ie.parent_candidates(parent_invs)
2810
heads = graph.Graph(self).heads(parent_candiate_entries.keys())
2811
# XXX: Note that this is unordered - and this is tolerable because
2812
# the previous code was also unordered.
2813
previous_entries = dict((head, parent_candiate_entries[head]) for head
2815
self.snapshot_ie(previous_entries, ie, w, rev_id)
2818
def get_parent_map(self, revision_ids):
2819
"""See graph.StackedParentsProvider.get_parent_map"""
2820
return dict((revision_id, self.revisions[revision_id])
2821
for revision_id in revision_ids
2822
if revision_id in self.revisions)
2824
def snapshot_ie(self, previous_revisions, ie, w, rev_id):
2825
# TODO: convert this logic, which is ~= snapshot to
2826
# a call to:. This needs the path figured out. rather than a work_tree
2827
# a v4 revision_tree can be given, or something that looks enough like
2828
# one to give the file content to the entry if it needs it.
2829
# and we need something that looks like a weave store for snapshot to
2831
#ie.snapshot(rev, PATH, previous_revisions, REVISION_TREE, InMemoryWeaveStore(self.text_weaves))
2832
if len(previous_revisions) == 1:
2833
previous_ie = previous_revisions.values()[0]
2834
if ie._unchanged(previous_ie):
2835
ie.revision = previous_ie.revision
2838
text = self.branch.repository._text_store.get(ie.text_id)
2839
file_lines = text.readlines()
2840
w.add_lines(rev_id, previous_revisions, file_lines)
2841
self.text_count += 1
2843
w.add_lines(rev_id, previous_revisions, [])
2844
ie.revision = rev_id
2846
def _make_order(self):
2847
"""Return a suitable order for importing revisions.
2849
The order must be such that an revision is imported after all
2850
its (present) parents.
2852
todo = set(self.revisions.keys())
2853
done = self.absent_revisions.copy()
2856
# scan through looking for a revision whose parents
2858
for rev_id in sorted(list(todo)):
2859
rev = self.revisions[rev_id]
2860
parent_ids = set(rev.parent_ids)
2861
if parent_ids.issubset(done):
2862
# can take this one now
2863
order.append(rev_id)
2869
class ConvertBzrDir5To6(Converter):
2870
"""Converts format 5 bzr dirs to format 6."""
2872
def convert(self, to_convert, pb):
2873
"""See Converter.convert()."""
2874
self.bzrdir = to_convert
2875
pb = ui.ui_factory.nested_progress_bar()
2877
ui.ui_factory.note('starting upgrade from format 5 to 6')
2878
self._convert_to_prefixed()
2879
return BzrDir.open(self.bzrdir.root_transport.base)
2883
def _convert_to_prefixed(self):
2884
from bzrlib.store import TransportStore
2885
self.bzrdir.transport.delete('branch-format')
2886
for store_name in ["weaves", "revision-store"]:
2887
ui.ui_factory.note("adding prefixes to %s" % store_name)
2888
store_transport = self.bzrdir.transport.clone(store_name)
2889
store = TransportStore(store_transport, prefixed=True)
2890
for urlfilename in store_transport.list_dir('.'):
2891
filename = urlutils.unescape(urlfilename)
2892
if (filename.endswith(".weave") or
2893
filename.endswith(".gz") or
2894
filename.endswith(".sig")):
2895
file_id, suffix = os.path.splitext(filename)
2899
new_name = store._mapper.map((file_id,)) + suffix
2900
# FIXME keep track of the dirs made RBC 20060121
2902
store_transport.move(filename, new_name)
2903
except errors.NoSuchFile: # catches missing dirs strangely enough
2904
store_transport.mkdir(osutils.dirname(new_name))
2905
store_transport.move(filename, new_name)
2906
self.bzrdir.transport.put_bytes(
2908
BzrDirFormat6().get_format_string(),
2909
mode=self.bzrdir._get_file_mode())
2912
class ConvertBzrDir6ToMeta(Converter):
2913
"""Converts format 6 bzr dirs to metadirs."""
2915
def convert(self, to_convert, pb):
2916
"""See Converter.convert()."""
2917
from bzrlib.repofmt.weaverepo import RepositoryFormat7
2918
from bzrlib.branch import BzrBranchFormat5
2919
self.bzrdir = to_convert
2920
self.pb = ui.ui_factory.nested_progress_bar()
2922
self.total = 20 # the steps we know about
2923
self.garbage_inventories = []
2924
self.dir_mode = self.bzrdir._get_dir_mode()
2925
self.file_mode = self.bzrdir._get_file_mode()
2927
ui.ui_factory.note('starting upgrade from format 6 to metadir')
2928
self.bzrdir.transport.put_bytes(
2930
"Converting to format 6",
2931
mode=self.file_mode)
2932
# its faster to move specific files around than to open and use the apis...
2933
# first off, nuke ancestry.weave, it was never used.
2935
self.step('Removing ancestry.weave')
2936
self.bzrdir.transport.delete('ancestry.weave')
2937
except errors.NoSuchFile:
2939
# find out whats there
2940
self.step('Finding branch files')
2941
last_revision = self.bzrdir.open_branch().last_revision()
2942
bzrcontents = self.bzrdir.transport.list_dir('.')
2943
for name in bzrcontents:
2944
if name.startswith('basis-inventory.'):
2945
self.garbage_inventories.append(name)
2946
# create new directories for repository, working tree and branch
2947
repository_names = [('inventory.weave', True),
2948
('revision-store', True),
2950
self.step('Upgrading repository ')
2951
self.bzrdir.transport.mkdir('repository', mode=self.dir_mode)
2952
self.make_lock('repository')
2953
# we hard code the formats here because we are converting into
2954
# the meta format. The meta format upgrader can take this to a
2955
# future format within each component.
2956
self.put_format('repository', RepositoryFormat7())
2957
for entry in repository_names:
2958
self.move_entry('repository', entry)
2960
self.step('Upgrading branch ')
2961
self.bzrdir.transport.mkdir('branch', mode=self.dir_mode)
2962
self.make_lock('branch')
2963
self.put_format('branch', BzrBranchFormat5())
2964
branch_files = [('revision-history', True),
2965
('branch-name', True),
2967
for entry in branch_files:
2968
self.move_entry('branch', entry)
2970
checkout_files = [('pending-merges', True),
2971
('inventory', True),
2972
('stat-cache', False)]
2973
# If a mandatory checkout file is not present, the branch does not have
2974
# a functional checkout. Do not create a checkout in the converted
2976
for name, mandatory in checkout_files:
2977
if mandatory and name not in bzrcontents:
2978
has_checkout = False
2982
if not has_checkout:
2983
ui.ui_factory.note('No working tree.')
2984
# If some checkout files are there, we may as well get rid of them.
2985
for name, mandatory in checkout_files:
2986
if name in bzrcontents:
2987
self.bzrdir.transport.delete(name)
2989
from bzrlib.workingtree import WorkingTreeFormat3
2990
self.step('Upgrading working tree')
2991
self.bzrdir.transport.mkdir('checkout', mode=self.dir_mode)
2992
self.make_lock('checkout')
2994
'checkout', WorkingTreeFormat3())
2995
self.bzrdir.transport.delete_multi(
2996
self.garbage_inventories, self.pb)
2997
for entry in checkout_files:
2998
self.move_entry('checkout', entry)
2999
if last_revision is not None:
3000
self.bzrdir.transport.put_bytes(
3001
'checkout/last-revision', last_revision)
3002
self.bzrdir.transport.put_bytes(
3004
BzrDirMetaFormat1().get_format_string(),
3005
mode=self.file_mode)
3007
return BzrDir.open(self.bzrdir.root_transport.base)
3009
def make_lock(self, name):
3010
"""Make a lock for the new control dir name."""
3011
self.step('Make %s lock' % name)
3012
ld = lockdir.LockDir(self.bzrdir.transport,
3014
file_modebits=self.file_mode,
3015
dir_modebits=self.dir_mode)
3018
def move_entry(self, new_dir, entry):
3019
"""Move then entry name into new_dir."""
3021
mandatory = entry[1]
3022
self.step('Moving %s' % name)
3024
self.bzrdir.transport.move(name, '%s/%s' % (new_dir, name))
3025
except errors.NoSuchFile:
3029
def put_format(self, dirname, format):
3030
self.bzrdir.transport.put_bytes('%s/format' % dirname,
3031
format.get_format_string(),
3035
class ConvertMetaToMeta(Converter):
3036
"""Converts the components of metadirs."""
3038
def __init__(self, target_format):
3039
"""Create a metadir to metadir converter.
3041
:param target_format: The final metadir format that is desired.
3043
self.target_format = target_format
3045
def convert(self, to_convert, pb):
3046
"""See Converter.convert()."""
3047
self.bzrdir = to_convert
3048
self.pb = ui.ui_factory.nested_progress_bar()
3051
self.step('checking repository format')
3053
repo = self.bzrdir.open_repository()
3054
except errors.NoRepositoryPresent:
3057
if not isinstance(repo._format, self.target_format.repository_format.__class__):
3058
from bzrlib.repository import CopyConverter
3059
ui.ui_factory.note('starting repository conversion')
3060
converter = CopyConverter(self.target_format.repository_format)
3061
converter.convert(repo, pb)
3062
for branch in self.bzrdir.list_branches():
3063
# TODO: conversions of Branch and Tree should be done by
3064
# InterXFormat lookups/some sort of registry.
3065
# Avoid circular imports
3066
from bzrlib import branch as _mod_branch
3067
old = branch._format.__class__
3068
new = self.target_format.get_branch_format().__class__
3070
if (old == _mod_branch.BzrBranchFormat5 and
3071
new in (_mod_branch.BzrBranchFormat6,
3072
_mod_branch.BzrBranchFormat7,
3073
_mod_branch.BzrBranchFormat8)):
3074
branch_converter = _mod_branch.Converter5to6()
3075
elif (old == _mod_branch.BzrBranchFormat6 and
3076
new in (_mod_branch.BzrBranchFormat7,
3077
_mod_branch.BzrBranchFormat8)):
3078
branch_converter = _mod_branch.Converter6to7()
3079
elif (old == _mod_branch.BzrBranchFormat7 and
3080
new is _mod_branch.BzrBranchFormat8):
3081
branch_converter = _mod_branch.Converter7to8()
3083
raise errors.BadConversionTarget("No converter", new,
3085
branch_converter.convert(branch)
3086
branch = self.bzrdir.open_branch()
3087
old = branch._format.__class__
3089
tree = self.bzrdir.open_workingtree(recommend_upgrade=False)
3090
except (errors.NoWorkingTree, errors.NotLocalUrl):
3093
# TODO: conversions of Branch and Tree should be done by
3094
# InterXFormat lookups
3095
if (isinstance(tree, workingtree.WorkingTree3) and
3096
not isinstance(tree, workingtree_4.DirStateWorkingTree) and
3097
isinstance(self.target_format.workingtree_format,
3098
workingtree_4.DirStateWorkingTreeFormat)):
3099
workingtree_4.Converter3to4().convert(tree)
3100
if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
3101
not isinstance(tree, workingtree_4.WorkingTree5) and
3102
isinstance(self.target_format.workingtree_format,
3103
workingtree_4.WorkingTreeFormat5)):
3104
workingtree_4.Converter4to5().convert(tree)
3105
if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
3106
not isinstance(tree, workingtree_4.WorkingTree6) and
3107
isinstance(self.target_format.workingtree_format,
3108
workingtree_4.WorkingTreeFormat6)):
3109
workingtree_4.Converter4or5to6().convert(tree)
3114
# This is not in remote.py because it's relatively small, and needs to be
3115
# registered. Putting it in remote.py creates a circular import problem.
3116
# we can make it a lazy object if the control formats is turned into something
3118
class RemoteBzrDirFormat(BzrDirMetaFormat1):
3119
"""Format representing bzrdirs accessed via a smart server"""
3122
BzrDirMetaFormat1.__init__(self)
3123
# XXX: It's a bit ugly that the network name is here, because we'd
3124
# like to believe that format objects are stateless or at least
3125
# immutable, However, we do at least avoid mutating the name after
3126
# it's returned. See <https://bugs.edge.launchpad.net/bzr/+bug/504102>
3127
self._network_name = None
3130
return "%s(_network_name=%r)" % (self.__class__.__name__,
3133
def get_format_description(self):
3134
if self._network_name:
3135
real_format = network_format_registry.get(self._network_name)
3136
return 'Remote: ' + real_format.get_format_description()
3137
return 'bzr remote bzrdir'
3139
def get_format_string(self):
3140
raise NotImplementedError(self.get_format_string)
3142
def network_name(self):
3143
if self._network_name:
3144
return self._network_name
3146
raise AssertionError("No network name set.")
3149
def probe_transport(klass, transport):
3150
"""Return a RemoteBzrDirFormat object if it looks possible."""
3152
medium = transport.get_smart_medium()
3153
except (NotImplementedError, AttributeError,
3154
errors.TransportNotPossible, errors.NoSmartMedium,
3155
errors.SmartProtocolError):
3156
# no smart server, so not a branch for this format type.
3157
raise errors.NotBranchError(path=transport.base)
3159
# Decline to open it if the server doesn't support our required
3160
# version (3) so that the VFS-based transport will do it.
3161
if medium.should_probe():
3163
server_version = medium.protocol_version()
3164
except errors.SmartProtocolError:
3165
# Apparently there's no usable smart server there, even though
3166
# the medium supports the smart protocol.
3167
raise errors.NotBranchError(path=transport.base)
3168
if server_version != '2':
3169
raise errors.NotBranchError(path=transport.base)
3172
def initialize_on_transport(self, transport):
3174
# hand off the request to the smart server
3175
client_medium = transport.get_smart_medium()
3176
except errors.NoSmartMedium:
3177
# TODO: lookup the local format from a server hint.
3178
local_dir_format = BzrDirMetaFormat1()
3179
return local_dir_format.initialize_on_transport(transport)
3180
client = _SmartClient(client_medium)
3181
path = client.remote_path_from_transport(transport)
3183
response = client.call('BzrDirFormat.initialize', path)
3184
except errors.ErrorFromSmartServer, err:
3185
remote._translate_error(err, path=path)
3186
if response[0] != 'ok':
3187
raise errors.SmartProtocolError('unexpected response code %s' % (response,))
3188
format = RemoteBzrDirFormat()
3189
self._supply_sub_formats_to(format)
3190
return remote.RemoteBzrDir(transport, format)
3192
def parse_NoneTrueFalse(self, arg):
3199
raise AssertionError("invalid arg %r" % arg)
3201
def _serialize_NoneTrueFalse(self, arg):
3208
def _serialize_NoneString(self, arg):
3211
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
3212
create_prefix=False, force_new_repo=False, stacked_on=None,
3213
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
3216
# hand off the request to the smart server
3217
client_medium = transport.get_smart_medium()
3218
except errors.NoSmartMedium:
3221
# Decline to open it if the server doesn't support our required
3222
# version (3) so that the VFS-based transport will do it.
3223
if client_medium.should_probe():
3225
server_version = client_medium.protocol_version()
3226
if server_version != '2':
3230
except errors.SmartProtocolError:
3231
# Apparently there's no usable smart server there, even though
3232
# the medium supports the smart protocol.
3237
client = _SmartClient(client_medium)
3238
path = client.remote_path_from_transport(transport)
3239
if client_medium._is_remote_before((1, 16)):
3242
# TODO: lookup the local format from a server hint.
3243
local_dir_format = BzrDirMetaFormat1()
3244
self._supply_sub_formats_to(local_dir_format)
3245
return local_dir_format.initialize_on_transport_ex(transport,
3246
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3247
force_new_repo=force_new_repo, stacked_on=stacked_on,
3248
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3249
make_working_trees=make_working_trees, shared_repo=shared_repo,
3251
return self._initialize_on_transport_ex_rpc(client, path, transport,
3252
use_existing_dir, create_prefix, force_new_repo, stacked_on,
3253
stack_on_pwd, repo_format_name, make_working_trees, shared_repo)
3255
def _initialize_on_transport_ex_rpc(self, client, path, transport,
3256
use_existing_dir, create_prefix, force_new_repo, stacked_on,
3257
stack_on_pwd, repo_format_name, make_working_trees, shared_repo):
3259
args.append(self._serialize_NoneTrueFalse(use_existing_dir))
3260
args.append(self._serialize_NoneTrueFalse(create_prefix))
3261
args.append(self._serialize_NoneTrueFalse(force_new_repo))
3262
args.append(self._serialize_NoneString(stacked_on))
3263
# stack_on_pwd is often/usually our transport
3266
stack_on_pwd = transport.relpath(stack_on_pwd)
3267
if not stack_on_pwd:
3269
except errors.PathNotChild:
3271
args.append(self._serialize_NoneString(stack_on_pwd))
3272
args.append(self._serialize_NoneString(repo_format_name))
3273
args.append(self._serialize_NoneTrueFalse(make_working_trees))
3274
args.append(self._serialize_NoneTrueFalse(shared_repo))
3275
request_network_name = self._network_name or \
3276
BzrDirFormat.get_default_format().network_name()
3278
response = client.call('BzrDirFormat.initialize_ex_1.16',
3279
request_network_name, path, *args)
3280
except errors.UnknownSmartMethod:
3281
client._medium._remember_remote_is_before((1,16))
3282
local_dir_format = BzrDirMetaFormat1()
3283
self._supply_sub_formats_to(local_dir_format)
3284
return local_dir_format.initialize_on_transport_ex(transport,
3285
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3286
force_new_repo=force_new_repo, stacked_on=stacked_on,
3287
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3288
make_working_trees=make_working_trees, shared_repo=shared_repo,
3290
except errors.ErrorFromSmartServer, err:
3291
remote._translate_error(err, path=path)
3292
repo_path = response[0]
3293
bzrdir_name = response[6]
3294
require_stacking = response[7]
3295
require_stacking = self.parse_NoneTrueFalse(require_stacking)
3296
format = RemoteBzrDirFormat()
3297
format._network_name = bzrdir_name
3298
self._supply_sub_formats_to(format)
3299
bzrdir = remote.RemoteBzrDir(transport, format, _client=client)
3301
repo_format = remote.response_tuple_to_repo_format(response[1:])
3302
if repo_path == '.':
3305
repo_bzrdir_format = RemoteBzrDirFormat()
3306
repo_bzrdir_format._network_name = response[5]
3307
repo_bzr = remote.RemoteBzrDir(transport.clone(repo_path),
3311
final_stack = response[8] or None
3312
final_stack_pwd = response[9] or None
3314
final_stack_pwd = urlutils.join(
3315
transport.base, final_stack_pwd)
3316
remote_repo = remote.RemoteRepository(repo_bzr, repo_format)
3317
if len(response) > 10:
3318
# Updated server verb that locks remotely.
3319
repo_lock_token = response[10] or None
3320
remote_repo.lock_write(repo_lock_token, _skip_rpc=True)
3322
remote_repo.dont_leave_lock_in_place()
3324
remote_repo.lock_write()
3325
policy = UseExistingRepository(remote_repo, final_stack,
3326
final_stack_pwd, require_stacking)
3327
policy.acquire_repository()
3331
bzrdir._format.set_branch_format(self.get_branch_format())
3332
if require_stacking:
3333
# The repo has already been created, but we need to make sure that
3334
# we'll make a stackable branch.
3335
bzrdir._format.require_stacking(_skip_repo=True)
3336
return remote_repo, bzrdir, require_stacking, policy
3338
def _open(self, transport):
3339
return remote.RemoteBzrDir(transport, self)
3341
def __eq__(self, other):
3342
if not isinstance(other, RemoteBzrDirFormat):
3344
return self.get_format_description() == other.get_format_description()
3346
def __return_repository_format(self):
3347
# Always return a RemoteRepositoryFormat object, but if a specific bzr
3348
# repository format has been asked for, tell the RemoteRepositoryFormat
3349
# that it should use that for init() etc.
3350
result = remote.RemoteRepositoryFormat()
3351
custom_format = getattr(self, '_repository_format', None)
3353
if isinstance(custom_format, remote.RemoteRepositoryFormat):
3354
return custom_format
3356
# We will use the custom format to create repositories over the
3357
# wire; expose its details like rich_root_data for code to
3359
result._custom_format = custom_format
3362
def get_branch_format(self):
3363
result = BzrDirMetaFormat1.get_branch_format(self)
3364
if not isinstance(result, remote.RemoteBranchFormat):
3365
new_result = remote.RemoteBranchFormat()
3366
new_result._custom_format = result
3368
self.set_branch_format(new_result)
3372
repository_format = property(__return_repository_format,
3373
BzrDirMetaFormat1._set_repository_format) #.im_func)
3376
BzrDirFormat.register_control_server_format(RemoteBzrDirFormat)
3379
class BzrDirFormatInfo(object):
3381
def __init__(self, native, deprecated, hidden, experimental):
3382
self.deprecated = deprecated
3383
self.native = native
3384
self.hidden = hidden
3385
self.experimental = experimental
3388
class BzrDirFormatRegistry(registry.Registry):
3389
"""Registry of user-selectable BzrDir subformats.
3391
Differs from BzrDirFormat._control_formats in that it provides sub-formats,
3392
e.g. BzrDirMeta1 with weave repository. Also, it's more user-oriented.
3396
"""Create a BzrDirFormatRegistry."""
3397
self._aliases = set()
3398
self._registration_order = list()
3399
super(BzrDirFormatRegistry, self).__init__()
3402
"""Return a set of the format names which are aliases."""
3403
return frozenset(self._aliases)
3405
def register_metadir(self, key,
3406
repository_format, help, native=True, deprecated=False,
3412
"""Register a metadir subformat.
3414
These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
3415
by the Repository/Branch/WorkingTreeformats.
3417
:param repository_format: The fully-qualified repository format class
3419
:param branch_format: Fully-qualified branch format class name as
3421
:param tree_format: Fully-qualified tree format class name as
3424
# This should be expanded to support setting WorkingTree and Branch
3425
# formats, once BzrDirMetaFormat1 supports that.
3426
def _load(full_name):
3427
mod_name, factory_name = full_name.rsplit('.', 1)
3429
mod = __import__(mod_name, globals(), locals(),
3431
except ImportError, e:
3432
raise ImportError('failed to load %s: %s' % (full_name, e))
3434
factory = getattr(mod, factory_name)
3435
except AttributeError:
3436
raise AttributeError('no factory %s in module %r'
3441
bd = BzrDirMetaFormat1()
3442
if branch_format is not None:
3443
bd.set_branch_format(_load(branch_format))
3444
if tree_format is not None:
3445
bd.workingtree_format = _load(tree_format)
3446
if repository_format is not None:
3447
bd.repository_format = _load(repository_format)
3449
self.register(key, helper, help, native, deprecated, hidden,
3450
experimental, alias)
3452
def register(self, key, factory, help, native=True, deprecated=False,
3453
hidden=False, experimental=False, alias=False):
3454
"""Register a BzrDirFormat factory.
3456
The factory must be a callable that takes one parameter: the key.
3457
It must produce an instance of the BzrDirFormat when called.
3459
This function mainly exists to prevent the info object from being
3462
registry.Registry.register(self, key, factory, help,
3463
BzrDirFormatInfo(native, deprecated, hidden, experimental))
3465
self._aliases.add(key)
3466
self._registration_order.append(key)
3468
def register_lazy(self, key, module_name, member_name, help, native=True,
3469
deprecated=False, hidden=False, experimental=False, alias=False):
3470
registry.Registry.register_lazy(self, key, module_name, member_name,
3471
help, BzrDirFormatInfo(native, deprecated, hidden, experimental))
3473
self._aliases.add(key)
3474
self._registration_order.append(key)
3476
def set_default(self, key):
3477
"""Set the 'default' key to be a clone of the supplied key.
3479
This method must be called once and only once.
3481
registry.Registry.register(self, 'default', self.get(key),
3482
self.get_help(key), info=self.get_info(key))
3483
self._aliases.add('default')
3485
def set_default_repository(self, key):
3486
"""Set the FormatRegistry default and Repository default.
3488
This is a transitional method while Repository.set_default_format
3491
if 'default' in self:
3492
self.remove('default')
3493
self.set_default(key)
3494
format = self.get('default')()
3496
def make_bzrdir(self, key):
3497
return self.get(key)()
3499
def help_topic(self, topic):
3501
default_realkey = None
3502
default_help = self.get_help('default')
3504
for key in self._registration_order:
3505
if key == 'default':
3507
help = self.get_help(key)
3508
if help == default_help:
3509
default_realkey = key
3511
help_pairs.append((key, help))
3513
def wrapped(key, help, info):
3515
help = '(native) ' + help
3516
return ':%s:\n%s\n\n' % (key,
3517
textwrap.fill(help, initial_indent=' ',
3518
subsequent_indent=' ',
3519
break_long_words=False))
3520
if default_realkey is not None:
3521
output += wrapped(default_realkey, '(default) %s' % default_help,
3522
self.get_info('default'))
3523
deprecated_pairs = []
3524
experimental_pairs = []
3525
for key, help in help_pairs:
3526
info = self.get_info(key)
3529
elif info.deprecated:
3530
deprecated_pairs.append((key, help))
3531
elif info.experimental:
3532
experimental_pairs.append((key, help))
3534
output += wrapped(key, help, info)
3535
output += "\nSee :doc:`formats-help` for more about storage formats."
3537
if len(experimental_pairs) > 0:
3538
other_output += "Experimental formats are shown below.\n\n"
3539
for key, help in experimental_pairs:
3540
info = self.get_info(key)
3541
other_output += wrapped(key, help, info)
3544
"No experimental formats are available.\n\n"
3545
if len(deprecated_pairs) > 0:
3546
other_output += "\nDeprecated formats are shown below.\n\n"
3547
for key, help in deprecated_pairs:
3548
info = self.get_info(key)
3549
other_output += wrapped(key, help, info)
3552
"\nNo deprecated formats are available.\n\n"
3554
"\nSee :doc:`formats-help` for more about storage formats."
3556
if topic == 'other-formats':
3562
class RepositoryAcquisitionPolicy(object):
3563
"""Abstract base class for repository acquisition policies.
3565
A repository acquisition policy decides how a BzrDir acquires a repository
3566
for a branch that is being created. The most basic policy decision is
3567
whether to create a new repository or use an existing one.
3569
def __init__(self, stack_on, stack_on_pwd, require_stacking):
3572
:param stack_on: A location to stack on
3573
:param stack_on_pwd: If stack_on is relative, the location it is
3575
:param require_stacking: If True, it is a failure to not stack.
3577
self._stack_on = stack_on
3578
self._stack_on_pwd = stack_on_pwd
3579
self._require_stacking = require_stacking
3581
def configure_branch(self, branch):
3582
"""Apply any configuration data from this policy to the branch.
3584
Default implementation sets repository stacking.
3586
if self._stack_on is None:
3588
if self._stack_on_pwd is None:
3589
stack_on = self._stack_on
3592
stack_on = urlutils.rebase_url(self._stack_on,
3594
branch.bzrdir.root_transport.base)
3595
except errors.InvalidRebaseURLs:
3596
stack_on = self._get_full_stack_on()
3598
branch.set_stacked_on_url(stack_on)
3599
except (errors.UnstackableBranchFormat,
3600
errors.UnstackableRepositoryFormat):
3601
if self._require_stacking:
3604
def requires_stacking(self):
3605
"""Return True if this policy requires stacking."""
3606
return self._stack_on is not None and self._require_stacking
3608
def _get_full_stack_on(self):
3609
"""Get a fully-qualified URL for the stack_on location."""
3610
if self._stack_on is None:
3612
if self._stack_on_pwd is None:
3613
return self._stack_on
3615
return urlutils.join(self._stack_on_pwd, self._stack_on)
3617
def _add_fallback(self, repository, possible_transports=None):
3618
"""Add a fallback to the supplied repository, if stacking is set."""
3619
stack_on = self._get_full_stack_on()
3620
if stack_on is None:
3623
stacked_dir = BzrDir.open(stack_on,
3624
possible_transports=possible_transports)
3625
except errors.JailBreak:
3626
# We keep the stacking details, but we are in the server code so
3627
# actually stacking is not needed.
3630
stacked_repo = stacked_dir.open_branch().repository
3631
except errors.NotBranchError:
3632
stacked_repo = stacked_dir.open_repository()
3634
repository.add_fallback_repository(stacked_repo)
3635
except errors.UnstackableRepositoryFormat:
3636
if self._require_stacking:
3639
self._require_stacking = True
3641
def acquire_repository(self, make_working_trees=None, shared=False):
3642
"""Acquire a repository for this bzrdir.
3644
Implementations may create a new repository or use a pre-exising
3646
:param make_working_trees: If creating a repository, set
3647
make_working_trees to this value (if non-None)
3648
:param shared: If creating a repository, make it shared if True
3649
:return: A repository, is_new_flag (True if the repository was
3652
raise NotImplemented(RepositoryAcquisitionPolicy.acquire_repository)
3655
class CreateRepository(RepositoryAcquisitionPolicy):
3656
"""A policy of creating a new repository"""
3658
def __init__(self, bzrdir, stack_on=None, stack_on_pwd=None,
3659
require_stacking=False):
3662
:param bzrdir: The bzrdir to create the repository on.
3663
:param stack_on: A location to stack on
3664
:param stack_on_pwd: If stack_on is relative, the location it is
3667
RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
3669
self._bzrdir = bzrdir
3671
def acquire_repository(self, make_working_trees=None, shared=False):
3672
"""Implementation of RepositoryAcquisitionPolicy.acquire_repository
3674
Creates the desired repository in the bzrdir we already have.
3676
stack_on = self._get_full_stack_on()
3678
format = self._bzrdir._format
3679
format.require_stacking(stack_on=stack_on,
3680
possible_transports=[self._bzrdir.root_transport])
3681
if not self._require_stacking:
3682
# We have picked up automatic stacking somewhere.
3683
note('Using default stacking branch %s at %s', self._stack_on,
3685
repository = self._bzrdir.create_repository(shared=shared)
3686
self._add_fallback(repository,
3687
possible_transports=[self._bzrdir.transport])
3688
if make_working_trees is not None:
3689
repository.set_make_working_trees(make_working_trees)
3690
return repository, True
3693
class UseExistingRepository(RepositoryAcquisitionPolicy):
3694
"""A policy of reusing an existing repository"""
3696
def __init__(self, repository, stack_on=None, stack_on_pwd=None,
3697
require_stacking=False):
3700
:param repository: The repository to use.
3701
:param stack_on: A location to stack on
3702
:param stack_on_pwd: If stack_on is relative, the location it is
3705
RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
3707
self._repository = repository
3709
def acquire_repository(self, make_working_trees=None, shared=False):
3710
"""Implementation of RepositoryAcquisitionPolicy.acquire_repository
3712
Returns an existing repository to use.
3714
self._add_fallback(self._repository,
3715
possible_transports=[self._repository.bzrdir.transport])
3716
return self._repository, False
3719
# Please register new formats after old formats so that formats
3720
# appear in chronological order and format descriptions can build
3722
format_registry = BzrDirFormatRegistry()
3723
# The pre-0.8 formats have their repository format network name registered in
3724
# repository.py. MetaDir formats have their repository format network name
3725
# inferred from their disk format string.
3726
format_registry.register('weave', BzrDirFormat6,
3727
'Pre-0.8 format. Slower than knit and does not'
3728
' support checkouts or shared repositories.',
3731
format_registry.register_metadir('metaweave',
3732
'bzrlib.repofmt.weaverepo.RepositoryFormat7',
3733
'Transitional format in 0.8. Slower than knit.',
3734
branch_format='bzrlib.branch.BzrBranchFormat5',
3735
tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3738
format_registry.register_metadir('knit',
3739
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3740
'Format using knits. Recommended for interoperation with bzr <= 0.14.',
3741
branch_format='bzrlib.branch.BzrBranchFormat5',
3742
tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3745
format_registry.register_metadir('dirstate',
3746
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3747
help='New in 0.15: Fast local operations. Compatible with bzr 0.8 and '
3748
'above when accessed over the network.',
3749
branch_format='bzrlib.branch.BzrBranchFormat5',
3750
# this uses bzrlib.workingtree.WorkingTreeFormat4 because importing
3751
# directly from workingtree_4 triggers a circular import.
3752
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3755
format_registry.register_metadir('dirstate-tags',
3756
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3757
help='New in 0.15: Fast local operations and improved scaling for '
3758
'network operations. Additionally adds support for tags.'
3759
' Incompatible with bzr < 0.15.',
3760
branch_format='bzrlib.branch.BzrBranchFormat6',
3761
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3764
format_registry.register_metadir('rich-root',
3765
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
3766
help='New in 1.0. Better handling of tree roots. Incompatible with'
3768
branch_format='bzrlib.branch.BzrBranchFormat6',
3769
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3772
format_registry.register_metadir('dirstate-with-subtree',
3773
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
3774
help='New in 0.15: Fast local operations and improved scaling for '
3775
'network operations. Additionally adds support for versioning nested '
3776
'bzr branches. Incompatible with bzr < 0.15.',
3777
branch_format='bzrlib.branch.BzrBranchFormat6',
3778
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3782
format_registry.register_metadir('pack-0.92',
3783
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack1',
3784
help='New in 0.92: Pack-based format with data compatible with '
3785
'dirstate-tags format repositories. Interoperates with '
3786
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3788
branch_format='bzrlib.branch.BzrBranchFormat6',
3789
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3791
format_registry.register_metadir('pack-0.92-subtree',
3792
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack3',
3793
help='New in 0.92: Pack-based format with data compatible with '
3794
'dirstate-with-subtree format repositories. Interoperates with '
3795
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3797
branch_format='bzrlib.branch.BzrBranchFormat6',
3798
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3802
format_registry.register_metadir('rich-root-pack',
3803
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
3804
help='New in 1.0: A variant of pack-0.92 that supports rich-root data '
3805
'(needed for bzr-svn and bzr-git).',
3806
branch_format='bzrlib.branch.BzrBranchFormat6',
3807
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3810
format_registry.register_metadir('1.6',
3811
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5',
3812
help='A format that allows a branch to indicate that there is another '
3813
'(stacked) repository that should be used to access data that is '
3814
'not present locally.',
3815
branch_format='bzrlib.branch.BzrBranchFormat7',
3816
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3819
format_registry.register_metadir('1.6.1-rich-root',
3820
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5RichRoot',
3821
help='A variant of 1.6 that supports rich-root data '
3822
'(needed for bzr-svn and bzr-git).',
3823
branch_format='bzrlib.branch.BzrBranchFormat7',
3824
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3827
format_registry.register_metadir('1.9',
3828
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3829
help='A repository format using B+tree indexes. These indexes '
3830
'are smaller in size, have smarter caching and provide faster '
3831
'performance for most operations.',
3832
branch_format='bzrlib.branch.BzrBranchFormat7',
3833
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3836
format_registry.register_metadir('1.9-rich-root',
3837
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
3838
help='A variant of 1.9 that supports rich-root data '
3839
'(needed for bzr-svn and bzr-git).',
3840
branch_format='bzrlib.branch.BzrBranchFormat7',
3841
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3844
format_registry.register_metadir('1.14',
3845
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3846
help='A working-tree format that supports content filtering.',
3847
branch_format='bzrlib.branch.BzrBranchFormat7',
3848
tree_format='bzrlib.workingtree.WorkingTreeFormat5',
3850
format_registry.register_metadir('1.14-rich-root',
3851
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
3852
help='A variant of 1.14 that supports rich-root data '
3853
'(needed for bzr-svn and bzr-git).',
3854
branch_format='bzrlib.branch.BzrBranchFormat7',
3855
tree_format='bzrlib.workingtree.WorkingTreeFormat5',
3857
# The following un-numbered 'development' formats should always just be aliases.
3858
format_registry.register_metadir('development-rich-root',
3859
'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
3860
help='Current development format. Supports rich roots. Can convert data '
3861
'to and from rich-root-pack (and anything compatible with '
3862
'rich-root-pack) format repositories. Repositories and branches in '
3863
'this format can only be read by bzr.dev. Please read '
3864
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
3866
branch_format='bzrlib.branch.BzrBranchFormat7',
3867
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3872
format_registry.register_metadir('development-subtree',
3873
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment2Subtree',
3874
help='Current development format, subtree variant. Can convert data to and '
3875
'from pack-0.92-subtree (and anything compatible with '
3876
'pack-0.92-subtree) format repositories. Repositories and branches in '
3877
'this format can only be read by bzr.dev. Please read '
3878
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
3880
branch_format='bzrlib.branch.BzrBranchFormat7',
3881
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3884
alias=False, # Restore to being an alias when an actual development subtree format is added
3885
# This current non-alias status is simply because we did not introduce a
3886
# chk based subtree format.
3889
# And the development formats above will have aliased one of the following:
3890
format_registry.register_metadir('development6-rich-root',
3891
'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
3892
help='pack-1.9 with 255-way hashed CHK inv, group compress, rich roots '
3894
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
3896
branch_format='bzrlib.branch.BzrBranchFormat7',
3897
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3902
format_registry.register_metadir('development7-rich-root',
3903
'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK2',
3904
help='pack-1.9 with 255-way hashed CHK inv, bencode revision, group compress, '
3905
'rich roots. 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',
3914
format_registry.register_metadir('2a',
3915
'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
3916
help='First format for bzr 2.0 series.\n'
3917
'Uses group-compress storage.\n'
3918
'Provides rich roots which are a one-way transition.\n',
3919
# 'storage in packs, 255-way hashed CHK inventory, bencode revision, group compress, '
3920
# 'rich roots. Supported by bzr 1.16 and later.',
3921
branch_format='bzrlib.branch.BzrBranchFormat7',
3922
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3926
# The following format should be an alias for the rich root equivalent
3927
# of the default format
3928
format_registry.register_metadir('default-rich-root',
3929
'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
3930
branch_format='bzrlib.branch.BzrBranchFormat7',
3931
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3936
# The current format that is made on 'bzr init'.
3937
format_registry.set_default('2a')
added
removed
bzrlib/bzrdir.py
