1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""BzrDir logic. The BzrDir is the basic control directory used by bzr.
19
At format 7 this was split out into Branch, Repository and Checkout control
22
Note: This module has a lot of ``open`` functions/methods that return
23
references to in-memory objects. As a rule, there are no matching ``close``
24
methods. To free any associated resources, simply stop referencing the
28
# TODO: Move old formats into a plugin to make this file smaller.
33
from bzrlib.lazy_import import lazy_import
34
lazy_import(globals(), """
35
from stat import S_ISDIR
49
revision as _mod_revision,
59
from bzrlib.osutils import (
62
from bzrlib.push import (
65
from bzrlib.repofmt import pack_repo
66
from bzrlib.smart.client import _SmartClient
67
from bzrlib.store.versioned import WeaveStore
68
from bzrlib.transactions import WriteTransaction
69
from bzrlib.transport import (
70
do_catching_redirections,
74
from bzrlib.weave import Weave
77
from bzrlib.trace import (
90
"""A .bzr control diretory.
92
BzrDir instances let you create or open any of the things that can be
93
found within .bzr - checkouts, branches and repositories.
96
the transport which this bzr dir is rooted at (i.e. file:///.../.bzr/)
98
a transport connected to the directory this bzr was opened from
99
(i.e. the parent directory holding the .bzr directory).
101
Everything in the bzrdir should have the same file permissions.
103
:cvar hooks: An instance of BzrDirHooks.
106
def break_lock(self):
107
"""Invoke break_lock on the first object in the bzrdir.
109
If there is a tree, the tree is opened and break_lock() called.
110
Otherwise, branch is tried, and finally repository.
112
# XXX: This seems more like a UI function than something that really
113
# belongs in this class.
115
thing_to_unlock = self.open_workingtree()
116
except (errors.NotLocalUrl, errors.NoWorkingTree):
118
thing_to_unlock = self.open_branch()
119
except errors.NotBranchError:
121
thing_to_unlock = self.open_repository()
122
except errors.NoRepositoryPresent:
124
thing_to_unlock.break_lock()
126
def can_convert_format(self):
127
"""Return true if this bzrdir is one whose format we can convert from."""
130
def check_conversion_target(self, target_format):
131
target_repo_format = target_format.repository_format
132
source_repo_format = self._format.repository_format
133
source_repo_format.check_conversion_target(target_repo_format)
136
def _check_supported(format, allow_unsupported,
137
recommend_upgrade=True,
139
"""Give an error or warning on old formats.
141
:param format: may be any kind of format - workingtree, branch,
144
:param allow_unsupported: If true, allow opening
145
formats that are strongly deprecated, and which may
146
have limited functionality.
148
:param recommend_upgrade: If true (default), warn
149
the user through the ui object that they may wish
150
to upgrade the object.
152
# TODO: perhaps move this into a base Format class; it's not BzrDir
153
# specific. mbp 20070323
154
if not allow_unsupported and not format.is_supported():
155
# see open_downlevel to open legacy branches.
156
raise errors.UnsupportedFormatError(format=format)
157
if recommend_upgrade \
158
and getattr(format, 'upgrade_recommended', False):
159
ui.ui_factory.recommend_upgrade(
160
format.get_format_description(),
163
def clone(self, url, revision_id=None, force_new_repo=False,
164
preserve_stacking=False):
165
"""Clone this bzrdir and its contents to url verbatim.
167
:param url: The url create the clone at. If url's last component does
168
not exist, it will be created.
169
:param revision_id: The tip revision-id to use for any branch or
170
working tree. If not None, then the clone operation may tune
171
itself to download less data.
172
:param force_new_repo: Do not use a shared repository for the target
173
even if one is available.
174
:param preserve_stacking: When cloning a stacked branch, stack the
175
new branch on top of the other branch's stacked-on branch.
177
return self.clone_on_transport(get_transport(url),
178
revision_id=revision_id,
179
force_new_repo=force_new_repo,
180
preserve_stacking=preserve_stacking)
182
def clone_on_transport(self, transport, revision_id=None,
183
force_new_repo=False, preserve_stacking=False, stacked_on=None,
184
create_prefix=False, use_existing_dir=True):
185
"""Clone this bzrdir and its contents to transport verbatim.
187
:param transport: The transport for the location to produce the clone
188
at. If the target directory does not exist, it will be created.
189
:param revision_id: The tip revision-id to use for any branch or
190
working tree. If not None, then the clone operation may tune
191
itself to download less data.
192
:param force_new_repo: Do not use a shared repository for the target,
193
even if one is available.
194
:param preserve_stacking: When cloning a stacked branch, stack the
195
new branch on top of the other branch's stacked-on branch.
196
:param create_prefix: Create any missing directories leading up to
198
:param use_existing_dir: Use an existing directory if one exists.
200
# Overview: put together a broad description of what we want to end up
201
# with; then make as few api calls as possible to do it.
203
# We may want to create a repo/branch/tree, if we do so what format
204
# would we want for each:
205
require_stacking = (stacked_on is not None)
206
format = self.cloning_metadir(require_stacking)
208
# Figure out what objects we want:
210
local_repo = self.find_repository()
211
except errors.NoRepositoryPresent:
214
local_branch = self.open_branch()
215
except errors.NotBranchError:
218
# enable fallbacks when branch is not a branch reference
219
if local_branch.repository.has_same_location(local_repo):
220
local_repo = local_branch.repository
221
if preserve_stacking:
223
stacked_on = local_branch.get_stacked_on_url()
224
except (errors.UnstackableBranchFormat,
225
errors.UnstackableRepositoryFormat,
228
# Bug: We create a metadir without knowing if it can support stacking,
229
# we should look up the policy needs first, or just use it as a hint,
232
make_working_trees = local_repo.make_working_trees()
233
want_shared = local_repo.is_shared()
234
repo_format_name = format.repository_format.network_name()
236
make_working_trees = False
238
repo_format_name = None
240
result_repo, result, require_stacking, repository_policy = \
241
format.initialize_on_transport_ex(transport,
242
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
243
force_new_repo=force_new_repo, stacked_on=stacked_on,
244
stack_on_pwd=self.root_transport.base,
245
repo_format_name=repo_format_name,
246
make_working_trees=make_working_trees, shared_repo=want_shared)
249
# If the result repository is in the same place as the
250
# resulting bzr dir, it will have no content, further if the
251
# result is not stacked then we know all content should be
252
# copied, and finally if we are copying up to a specific
253
# revision_id then we can use the pending-ancestry-result which
254
# does not require traversing all of history to describe it.
255
if (result_repo.bzrdir.root_transport.base ==
256
result.root_transport.base and not require_stacking and
257
revision_id is not None):
258
fetch_spec = graph.PendingAncestryResult(
259
[revision_id], local_repo)
260
result_repo.fetch(local_repo, fetch_spec=fetch_spec)
262
result_repo.fetch(local_repo, revision_id=revision_id)
266
if result_repo is not None:
267
raise AssertionError('result_repo not None(%r)' % result_repo)
268
# 1 if there is a branch present
269
# make sure its content is available in the target repository
271
if local_branch is not None:
272
result_branch = local_branch.clone(result, revision_id=revision_id,
273
repository_policy=repository_policy)
275
# Cheaper to check if the target is not local, than to try making
277
result.root_transport.local_abspath('.')
278
if result_repo is None or result_repo.make_working_trees():
279
self.open_workingtree().clone(result)
280
except (errors.NoWorkingTree, errors.NotLocalUrl):
284
# TODO: This should be given a Transport, and should chdir up; otherwise
285
# this will open a new connection.
286
def _make_tail(self, url):
287
t = get_transport(url)
291
def create(cls, base, format=None, possible_transports=None):
292
"""Create a new BzrDir at the url 'base'.
294
:param format: If supplied, the format of branch to create. If not
295
supplied, the default is used.
296
:param possible_transports: If supplied, a list of transports that
297
can be reused to share a remote connection.
299
if cls is not BzrDir:
300
raise AssertionError("BzrDir.create always creates the default"
301
" format, not one of %r" % cls)
302
t = get_transport(base, possible_transports)
305
format = BzrDirFormat.get_default_format()
306
return format.initialize_on_transport(t)
309
def find_bzrdirs(transport, evaluate=None, list_current=None):
310
"""Find bzrdirs recursively from current location.
312
This is intended primarily as a building block for more sophisticated
313
functionality, like finding trees under a directory, or finding
314
branches that use a given repository.
315
:param evaluate: An optional callable that yields recurse, value,
316
where recurse controls whether this bzrdir is recursed into
317
and value is the value to yield. By default, all bzrdirs
318
are recursed into, and the return value is the bzrdir.
319
:param list_current: if supplied, use this function to list the current
320
directory, instead of Transport.list_dir
321
:return: a generator of found bzrdirs, or whatever evaluate returns.
323
if list_current is None:
324
def list_current(transport):
325
return transport.list_dir('')
327
def evaluate(bzrdir):
330
pending = [transport]
331
while len(pending) > 0:
332
current_transport = pending.pop()
335
bzrdir = BzrDir.open_from_transport(current_transport)
336
except errors.NotBranchError:
339
recurse, value = evaluate(bzrdir)
342
subdirs = list_current(current_transport)
343
except errors.NoSuchFile:
346
for subdir in sorted(subdirs, reverse=True):
347
pending.append(current_transport.clone(subdir))
350
def find_branches(transport):
351
"""Find all branches under a transport.
353
This will find all branches below the transport, including branches
354
inside other branches. Where possible, it will use
355
Repository.find_branches.
357
To list all the branches that use a particular Repository, see
358
Repository.find_branches
360
def evaluate(bzrdir):
362
repository = bzrdir.open_repository()
363
except errors.NoRepositoryPresent:
366
return False, (None, repository)
368
branch = bzrdir.open_branch()
369
except errors.NotBranchError:
370
return True, (None, None)
372
return True, (branch, None)
374
for branch, repo in BzrDir.find_bzrdirs(transport, evaluate=evaluate):
376
branches.extend(repo.find_branches())
377
if branch is not None:
378
branches.append(branch)
381
def destroy_repository(self):
382
"""Destroy the repository in this BzrDir"""
383
raise NotImplementedError(self.destroy_repository)
385
def create_branch(self):
386
"""Create a branch in this BzrDir.
388
The bzrdir's format will control what branch format is created.
389
For more control see BranchFormatXX.create(a_bzrdir).
391
raise NotImplementedError(self.create_branch)
393
def destroy_branch(self):
394
"""Destroy the branch in this BzrDir"""
395
raise NotImplementedError(self.destroy_branch)
398
def create_branch_and_repo(base, force_new_repo=False, format=None):
399
"""Create a new BzrDir, Branch and Repository at the url 'base'.
401
This will use the current default BzrDirFormat unless one is
402
specified, and use whatever
403
repository format that that uses via bzrdir.create_branch and
404
create_repository. If a shared repository is available that is used
407
The created Branch object is returned.
409
:param base: The URL to create the branch at.
410
:param force_new_repo: If True a new repository is always created.
411
:param format: If supplied, the format of branch to create. If not
412
supplied, the default is used.
414
bzrdir = BzrDir.create(base, format)
415
bzrdir._find_or_create_repository(force_new_repo)
416
return bzrdir.create_branch()
418
def determine_repository_policy(self, force_new_repo=False, stack_on=None,
419
stack_on_pwd=None, require_stacking=False):
420
"""Return an object representing a policy to use.
422
This controls whether a new repository is created, and the format of
423
that repository, or some existing shared repository used instead.
425
If stack_on is supplied, will not seek a containing shared repo.
427
:param force_new_repo: If True, require a new repository to be created.
428
:param stack_on: If supplied, the location to stack on. If not
429
supplied, a default_stack_on location may be used.
430
:param stack_on_pwd: If stack_on is relative, the location it is
433
def repository_policy(found_bzrdir):
436
config = found_bzrdir.get_config()
438
stack_on = config.get_default_stack_on()
439
if stack_on is not None:
440
stack_on_pwd = found_bzrdir.root_transport.base
442
# does it have a repository ?
444
repository = found_bzrdir.open_repository()
445
except errors.NoRepositoryPresent:
448
if ((found_bzrdir.root_transport.base !=
449
self.root_transport.base) and not repository.is_shared()):
450
# Don't look higher, can't use a higher shared repo.
458
return UseExistingRepository(repository, stack_on,
459
stack_on_pwd, require_stacking=require_stacking), True
461
return CreateRepository(self, stack_on, stack_on_pwd,
462
require_stacking=require_stacking), True
464
if not force_new_repo:
466
policy = self._find_containing(repository_policy)
467
if policy is not None:
471
return UseExistingRepository(self.open_repository(),
472
stack_on, stack_on_pwd,
473
require_stacking=require_stacking)
474
except errors.NoRepositoryPresent:
476
return CreateRepository(self, stack_on, stack_on_pwd,
477
require_stacking=require_stacking)
479
def _find_or_create_repository(self, force_new_repo):
480
"""Create a new repository if needed, returning the repository."""
481
policy = self.determine_repository_policy(force_new_repo)
482
return policy.acquire_repository()[0]
485
def create_branch_convenience(base, force_new_repo=False,
486
force_new_tree=None, format=None,
487
possible_transports=None):
488
"""Create a new BzrDir, Branch and Repository at the url 'base'.
490
This is a convenience function - it will use an existing repository
491
if possible, can be told explicitly whether to create a working tree or
494
This will use the current default BzrDirFormat unless one is
495
specified, and use whatever
496
repository format that that uses via bzrdir.create_branch and
497
create_repository. If a shared repository is available that is used
498
preferentially. Whatever repository is used, its tree creation policy
501
The created Branch object is returned.
502
If a working tree cannot be made due to base not being a file:// url,
503
no error is raised unless force_new_tree is True, in which case no
504
data is created on disk and NotLocalUrl is raised.
506
:param base: The URL to create the branch at.
507
:param force_new_repo: If True a new repository is always created.
508
:param force_new_tree: If True or False force creation of a tree or
509
prevent such creation respectively.
510
:param format: Override for the bzrdir format to create.
511
:param possible_transports: An optional reusable transports list.
514
# check for non local urls
515
t = get_transport(base, possible_transports)
516
if not isinstance(t, local.LocalTransport):
517
raise errors.NotLocalUrl(base)
518
bzrdir = BzrDir.create(base, format, possible_transports)
519
repo = bzrdir._find_or_create_repository(force_new_repo)
520
result = bzrdir.create_branch()
521
if force_new_tree or (repo.make_working_trees() and
522
force_new_tree is None):
524
bzrdir.create_workingtree()
525
except errors.NotLocalUrl:
530
def create_standalone_workingtree(base, format=None):
531
"""Create a new BzrDir, WorkingTree, Branch and Repository at 'base'.
533
'base' must be a local path or a file:// url.
535
This will use the current default BzrDirFormat unless one is
536
specified, and use whatever
537
repository format that that uses for bzrdirformat.create_workingtree,
538
create_branch and create_repository.
540
:param format: Override for the bzrdir format to create.
541
:return: The WorkingTree object.
543
t = get_transport(base)
544
if not isinstance(t, local.LocalTransport):
545
raise errors.NotLocalUrl(base)
546
bzrdir = BzrDir.create_branch_and_repo(base,
548
format=format).bzrdir
549
return bzrdir.create_workingtree()
551
def create_workingtree(self, revision_id=None, from_branch=None,
552
accelerator_tree=None, hardlink=False):
553
"""Create a working tree at this BzrDir.
555
:param revision_id: create it as of this revision id.
556
:param from_branch: override bzrdir branch (for lightweight checkouts)
557
:param accelerator_tree: A tree which can be used for retrieving file
558
contents more quickly than the revision tree, i.e. a workingtree.
559
The revision tree will be used for cases where accelerator_tree's
560
content is different.
562
raise NotImplementedError(self.create_workingtree)
564
def backup_bzrdir(self):
565
"""Backup this bzr control directory.
567
:return: Tuple with old path name and new path name
569
pb = ui.ui_factory.nested_progress_bar()
571
# FIXME: bug 300001 -- the backup fails if the backup directory
572
# already exists, but it should instead either remove it or make
573
# a new backup directory.
575
# FIXME: bug 262450 -- the backup directory should have the same
576
# permissions as the .bzr directory (probably a bug in copy_tree)
577
old_path = self.root_transport.abspath('.bzr')
578
new_path = self.root_transport.abspath('backup.bzr')
579
pb.note('making backup of %s' % (old_path,))
580
pb.note(' to %s' % (new_path,))
581
self.root_transport.copy_tree('.bzr', 'backup.bzr')
582
return (old_path, new_path)
586
def retire_bzrdir(self, limit=10000):
587
"""Permanently disable the bzrdir.
589
This is done by renaming it to give the user some ability to recover
590
if there was a problem.
592
This will have horrible consequences if anyone has anything locked or
594
:param limit: number of times to retry
599
to_path = '.bzr.retired.%d' % i
600
self.root_transport.rename('.bzr', to_path)
601
note("renamed %s to %s"
602
% (self.root_transport.abspath('.bzr'), to_path))
604
except (errors.TransportError, IOError, errors.PathError):
611
def destroy_workingtree(self):
612
"""Destroy the working tree at this BzrDir.
614
Formats that do not support this may raise UnsupportedOperation.
616
raise NotImplementedError(self.destroy_workingtree)
618
def destroy_workingtree_metadata(self):
619
"""Destroy the control files for the working tree at this BzrDir.
621
The contents of working tree files are not affected.
622
Formats that do not support this may raise UnsupportedOperation.
624
raise NotImplementedError(self.destroy_workingtree_metadata)
626
def _find_containing(self, evaluate):
627
"""Find something in a containing control directory.
629
This method will scan containing control dirs, until it finds what
630
it is looking for, decides that it will never find it, or runs out
631
of containing control directories to check.
633
It is used to implement find_repository and
634
determine_repository_policy.
636
:param evaluate: A function returning (value, stop). If stop is True,
637
the value will be returned.
641
result, stop = evaluate(found_bzrdir)
644
next_transport = found_bzrdir.root_transport.clone('..')
645
if (found_bzrdir.root_transport.base == next_transport.base):
646
# top of the file system
648
# find the next containing bzrdir
650
found_bzrdir = BzrDir.open_containing_from_transport(
652
except errors.NotBranchError:
655
def find_repository(self):
656
"""Find the repository that should be used.
658
This does not require a branch as we use it to find the repo for
659
new branches as well as to hook existing branches up to their
662
def usable_repository(found_bzrdir):
663
# does it have a repository ?
665
repository = found_bzrdir.open_repository()
666
except errors.NoRepositoryPresent:
668
if found_bzrdir.root_transport.base == self.root_transport.base:
669
return repository, True
670
elif repository.is_shared():
671
return repository, True
675
found_repo = self._find_containing(usable_repository)
676
if found_repo is None:
677
raise errors.NoRepositoryPresent(self)
680
def get_branch_reference(self):
681
"""Return the referenced URL for the branch in this bzrdir.
683
:raises NotBranchError: If there is no Branch.
684
:return: The URL the branch in this bzrdir references if it is a
685
reference branch, or None for regular branches.
689
def get_branch_transport(self, branch_format):
690
"""Get the transport for use by branch format in this BzrDir.
692
Note that bzr dirs that do not support format strings will raise
693
IncompatibleFormat if the branch format they are given has
694
a format string, and vice versa.
696
If branch_format is None, the transport is returned with no
697
checking. If it is not None, then the returned transport is
698
guaranteed to point to an existing directory ready for use.
700
raise NotImplementedError(self.get_branch_transport)
702
def _find_creation_modes(self):
703
"""Determine the appropriate modes for files and directories.
705
They're always set to be consistent with the base directory,
706
assuming that this transport allows setting modes.
708
# TODO: Do we need or want an option (maybe a config setting) to turn
709
# this off or override it for particular locations? -- mbp 20080512
710
if self._mode_check_done:
712
self._mode_check_done = True
714
st = self.transport.stat('.')
715
except errors.TransportNotPossible:
716
self._dir_mode = None
717
self._file_mode = None
719
# Check the directory mode, but also make sure the created
720
# directories and files are read-write for this user. This is
721
# mostly a workaround for filesystems which lie about being able to
722
# write to a directory (cygwin & win32)
723
if (st.st_mode & 07777 == 00000):
724
# FTP allows stat but does not return dir/file modes
725
self._dir_mode = None
726
self._file_mode = None
728
self._dir_mode = (st.st_mode & 07777) | 00700
729
# Remove the sticky and execute bits for files
730
self._file_mode = self._dir_mode & ~07111
732
def _get_file_mode(self):
733
"""Return Unix mode for newly created files, or None.
735
if not self._mode_check_done:
736
self._find_creation_modes()
737
return self._file_mode
739
def _get_dir_mode(self):
740
"""Return Unix mode for newly created directories, or None.
742
if not self._mode_check_done:
743
self._find_creation_modes()
744
return self._dir_mode
746
def get_repository_transport(self, repository_format):
747
"""Get the transport for use by repository format in this BzrDir.
749
Note that bzr dirs that do not support format strings will raise
750
IncompatibleFormat if the repository format they are given has
751
a format string, and vice versa.
753
If repository_format is None, the transport is returned with no
754
checking. If it is not None, then the returned transport is
755
guaranteed to point to an existing directory ready for use.
757
raise NotImplementedError(self.get_repository_transport)
759
def get_workingtree_transport(self, tree_format):
760
"""Get the transport for use by workingtree format in this BzrDir.
762
Note that bzr dirs that do not support format strings will raise
763
IncompatibleFormat if the workingtree format they are given has a
764
format string, and vice versa.
766
If workingtree_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_workingtree_transport)
772
def get_config(self):
773
"""Get configuration for this BzrDir."""
774
return config.BzrDirConfig(self)
776
def _get_config(self):
777
"""By default, no configuration is available."""
780
def __init__(self, _transport, _format):
781
"""Initialize a Bzr control dir object.
783
Only really common logic should reside here, concrete classes should be
784
made with varying behaviours.
786
:param _format: the format that is creating this BzrDir instance.
787
:param _transport: the transport this dir is based at.
789
self._format = _format
790
self.transport = _transport.clone('.bzr')
791
self.root_transport = _transport
792
self._mode_check_done = False
794
def is_control_filename(self, filename):
795
"""True if filename is the name of a path which is reserved for bzrdir's.
797
:param filename: A filename within the root transport of this bzrdir.
799
This is true IF and ONLY IF the filename is part of the namespace reserved
800
for bzr control dirs. Currently this is the '.bzr' directory in the root
801
of the root_transport. it is expected that plugins will need to extend
802
this in the future - for instance to make bzr talk with svn working
805
# this might be better on the BzrDirFormat class because it refers to
806
# all the possible bzrdir disk formats.
807
# This method is tested via the workingtree is_control_filename tests-
808
# it was extracted from WorkingTree.is_control_filename. If the method's
809
# contract is extended beyond the current trivial implementation, please
810
# add new tests for it to the appropriate place.
811
return filename == '.bzr' or filename.startswith('.bzr/')
813
def needs_format_conversion(self, format=None):
814
"""Return true if this bzrdir needs convert_format run on it.
816
For instance, if the repository format is out of date but the
817
branch and working tree are not, this should return True.
819
:param format: Optional parameter indicating a specific desired
820
format we plan to arrive at.
822
raise NotImplementedError(self.needs_format_conversion)
825
def open_unsupported(base):
826
"""Open a branch which is not supported."""
827
return BzrDir.open(base, _unsupported=True)
830
def open(base, _unsupported=False, possible_transports=None):
831
"""Open an existing bzrdir, rooted at 'base' (url).
833
:param _unsupported: a private parameter to the BzrDir class.
835
t = get_transport(base, possible_transports=possible_transports)
836
return BzrDir.open_from_transport(t, _unsupported=_unsupported)
839
def open_from_transport(transport, _unsupported=False,
840
_server_formats=True):
841
"""Open a bzrdir within a particular directory.
843
:param transport: Transport containing the bzrdir.
844
:param _unsupported: private.
846
for hook in BzrDir.hooks['pre_open']:
848
# Keep initial base since 'transport' may be modified while following
850
base = transport.base
851
def find_format(transport):
852
return transport, BzrDirFormat.find_format(
853
transport, _server_formats=_server_formats)
855
def redirected(transport, e, redirection_notice):
856
redirected_transport = transport._redirected_to(e.source, e.target)
857
if redirected_transport is None:
858
raise errors.NotBranchError(base)
859
note('%s is%s redirected to %s',
860
transport.base, e.permanently, redirected_transport.base)
861
return redirected_transport
864
transport, format = do_catching_redirections(find_format,
867
except errors.TooManyRedirections:
868
raise errors.NotBranchError(base)
870
BzrDir._check_supported(format, _unsupported)
871
return format.open(transport, _found=True)
873
def open_branch(self, unsupported=False, ignore_fallbacks=False):
874
"""Open the branch object at this BzrDir if one is present.
876
If unsupported is True, then no longer supported branch formats can
879
TODO: static convenience version of this?
881
raise NotImplementedError(self.open_branch)
884
def open_containing(url, possible_transports=None):
885
"""Open an existing branch which contains url.
887
:param url: url to search from.
888
See open_containing_from_transport for more detail.
890
transport = get_transport(url, possible_transports)
891
return BzrDir.open_containing_from_transport(transport)
894
def open_containing_from_transport(a_transport):
895
"""Open an existing branch which contains a_transport.base.
897
This probes for a branch at a_transport, and searches upwards from there.
899
Basically we keep looking up until we find the control directory or
900
run into the root. If there isn't one, raises NotBranchError.
901
If there is one and it is either an unrecognised format or an unsupported
902
format, UnknownFormatError or UnsupportedFormatError are raised.
903
If there is one, it is returned, along with the unused portion of url.
905
:return: The BzrDir that contains the path, and a Unicode path
906
for the rest of the URL.
908
# this gets the normalised url back. I.e. '.' -> the full path.
909
url = a_transport.base
912
result = BzrDir.open_from_transport(a_transport)
913
return result, urlutils.unescape(a_transport.relpath(url))
914
except errors.NotBranchError, e:
917
new_t = a_transport.clone('..')
918
except errors.InvalidURLJoin:
919
# reached the root, whatever that may be
920
raise errors.NotBranchError(path=url)
921
if new_t.base == a_transport.base:
922
# reached the root, whatever that may be
923
raise errors.NotBranchError(path=url)
926
def _get_tree_branch(self):
927
"""Return the branch and tree, if any, for this bzrdir.
929
Return None for tree if not present or inaccessible.
930
Raise NotBranchError if no branch is present.
931
:return: (tree, branch)
934
tree = self.open_workingtree()
935
except (errors.NoWorkingTree, errors.NotLocalUrl):
937
branch = self.open_branch()
943
def open_tree_or_branch(klass, location):
944
"""Return the branch and working tree at a location.
946
If there is no tree at the location, tree will be None.
947
If there is no branch at the location, an exception will be
949
:return: (tree, branch)
951
bzrdir = klass.open(location)
952
return bzrdir._get_tree_branch()
955
def open_containing_tree_or_branch(klass, location):
956
"""Return the branch and working tree contained by a location.
958
Returns (tree, branch, relpath).
959
If there is no tree at containing the location, tree will be None.
960
If there is no branch containing the location, an exception will be
962
relpath is the portion of the path that is contained by the branch.
964
bzrdir, relpath = klass.open_containing(location)
965
tree, branch = bzrdir._get_tree_branch()
966
return tree, branch, relpath
969
def open_containing_tree_branch_or_repository(klass, location):
970
"""Return the working tree, branch and repo contained by a location.
972
Returns (tree, branch, repository, relpath).
973
If there is no tree containing the location, tree will be None.
974
If there is no branch containing the location, branch will be None.
975
If there is no repository containing the location, repository will be
977
relpath is the portion of the path that is contained by the innermost
980
If no tree, branch or repository is found, a NotBranchError is raised.
982
bzrdir, relpath = klass.open_containing(location)
984
tree, branch = bzrdir._get_tree_branch()
985
except errors.NotBranchError:
987
repo = bzrdir.find_repository()
988
return None, None, repo, relpath
989
except (errors.NoRepositoryPresent):
990
raise errors.NotBranchError(location)
991
return tree, branch, branch.repository, relpath
993
def open_repository(self, _unsupported=False):
994
"""Open the repository object at this BzrDir if one is present.
996
This will not follow the Branch object pointer - it's strictly a direct
997
open facility. Most client code should use open_branch().repository to
1000
:param _unsupported: a private parameter, not part of the api.
1001
TODO: static convenience version of this?
1003
raise NotImplementedError(self.open_repository)
1005
def open_workingtree(self, _unsupported=False,
1006
recommend_upgrade=True, from_branch=None):
1007
"""Open the workingtree object at this BzrDir if one is present.
1009
:param recommend_upgrade: Optional keyword parameter, when True (the
1010
default), emit through the ui module a recommendation that the user
1011
upgrade the working tree when the workingtree being opened is old
1012
(but still fully supported).
1013
:param from_branch: override bzrdir branch (for lightweight checkouts)
1015
raise NotImplementedError(self.open_workingtree)
1017
def has_branch(self):
1018
"""Tell if this bzrdir contains a branch.
1020
Note: if you're going to open the branch, you should just go ahead
1021
and try, and not ask permission first. (This method just opens the
1022
branch and discards it, and that's somewhat expensive.)
1027
except errors.NotBranchError:
1030
def has_workingtree(self):
1031
"""Tell if this bzrdir contains a working tree.
1033
This will still raise an exception if the bzrdir has a workingtree that
1034
is remote & inaccessible.
1036
Note: if you're going to open the working tree, you should just go ahead
1037
and try, and not ask permission first. (This method just opens the
1038
workingtree and discards it, and that's somewhat expensive.)
1041
self.open_workingtree(recommend_upgrade=False)
1043
except errors.NoWorkingTree:
1046
def _cloning_metadir(self):
1047
"""Produce a metadir suitable for cloning with.
1049
:returns: (destination_bzrdir_format, source_repository)
1051
result_format = self._format.__class__()
1054
branch = self.open_branch(ignore_fallbacks=True)
1055
source_repository = branch.repository
1056
result_format._branch_format = branch._format
1057
except errors.NotBranchError:
1058
source_branch = None
1059
source_repository = self.open_repository()
1060
except errors.NoRepositoryPresent:
1061
source_repository = None
1063
# XXX TODO: This isinstance is here because we have not implemented
1064
# the fix recommended in bug # 103195 - to delegate this choice the
1065
# repository itself.
1066
repo_format = source_repository._format
1067
if isinstance(repo_format, remote.RemoteRepositoryFormat):
1068
source_repository._ensure_real()
1069
repo_format = source_repository._real_repository._format
1070
result_format.repository_format = repo_format
1072
# TODO: Couldn't we just probe for the format in these cases,
1073
# rather than opening the whole tree? It would be a little
1074
# faster. mbp 20070401
1075
tree = self.open_workingtree(recommend_upgrade=False)
1076
except (errors.NoWorkingTree, errors.NotLocalUrl):
1077
result_format.workingtree_format = None
1079
result_format.workingtree_format = tree._format.__class__()
1080
return result_format, source_repository
1082
def cloning_metadir(self, require_stacking=False):
1083
"""Produce a metadir suitable for cloning or sprouting with.
1085
These operations may produce workingtrees (yes, even though they're
1086
"cloning" something that doesn't have a tree), so a viable workingtree
1087
format must be selected.
1089
:require_stacking: If True, non-stackable formats will be upgraded
1090
to similar stackable formats.
1091
:returns: a BzrDirFormat with all component formats either set
1092
appropriately or set to None if that component should not be
1095
format, repository = self._cloning_metadir()
1096
if format._workingtree_format is None:
1098
if repository is None:
1099
# No repository either
1101
# We have a repository, so set a working tree? (Why? This seems to
1102
# contradict the stated return value in the docstring).
1103
tree_format = repository._format._matchingbzrdir.workingtree_format
1104
format.workingtree_format = tree_format.__class__()
1105
if require_stacking:
1106
format.require_stacking()
1109
def checkout_metadir(self):
1110
return self.cloning_metadir()
1112
def sprout(self, url, revision_id=None, force_new_repo=False,
1113
recurse='down', possible_transports=None,
1114
accelerator_tree=None, hardlink=False, stacked=False,
1115
source_branch=None, create_tree_if_local=True):
1116
"""Create a copy of this bzrdir prepared for use as a new line of
1119
If url's last component does not exist, it will be created.
1121
Attributes related to the identity of the source branch like
1122
branch nickname will be cleaned, a working tree is created
1123
whether one existed before or not; and a local branch is always
1126
if revision_id is not None, then the clone operation may tune
1127
itself to download less data.
1128
:param accelerator_tree: A tree which can be used for retrieving file
1129
contents more quickly than the revision tree, i.e. a workingtree.
1130
The revision tree will be used for cases where accelerator_tree's
1131
content is different.
1132
:param hardlink: If true, hard-link files from accelerator_tree,
1134
:param stacked: If true, create a stacked branch referring to the
1135
location of this control directory.
1136
:param create_tree_if_local: If true, a working-tree will be created
1137
when working locally.
1139
target_transport = get_transport(url, possible_transports)
1140
target_transport.ensure_base()
1141
cloning_format = self.cloning_metadir(stacked)
1142
# Create/update the result branch
1143
result = cloning_format.initialize_on_transport(target_transport)
1144
# if a stacked branch wasn't requested, we don't create one
1145
# even if the origin was stacked
1146
stacked_branch_url = None
1147
if source_branch is not None:
1149
stacked_branch_url = self.root_transport.base
1150
source_repository = source_branch.repository
1153
source_branch = self.open_branch()
1154
source_repository = source_branch.repository
1156
stacked_branch_url = self.root_transport.base
1157
except errors.NotBranchError:
1158
source_branch = None
1160
source_repository = self.open_repository()
1161
except errors.NoRepositoryPresent:
1162
source_repository = None
1163
repository_policy = result.determine_repository_policy(
1164
force_new_repo, stacked_branch_url, require_stacking=stacked)
1165
result_repo, is_new_repo = repository_policy.acquire_repository()
1166
if is_new_repo and revision_id is not None and not stacked:
1167
fetch_spec = graph.PendingAncestryResult(
1168
[revision_id], source_repository)
1171
if source_repository is not None:
1172
# Fetch while stacked to prevent unstacked fetch from
1174
if fetch_spec is None:
1175
result_repo.fetch(source_repository, revision_id=revision_id)
1177
result_repo.fetch(source_repository, fetch_spec=fetch_spec)
1179
if source_branch is None:
1180
# this is for sprouting a bzrdir without a branch; is that
1182
# Not especially, but it's part of the contract.
1183
result_branch = result.create_branch()
1185
result_branch = source_branch.sprout(result,
1186
revision_id=revision_id, repository_policy=repository_policy)
1187
mutter("created new branch %r" % (result_branch,))
1189
# Create/update the result working tree
1190
if (create_tree_if_local and
1191
isinstance(target_transport, local.LocalTransport) and
1192
(result_repo is None or result_repo.make_working_trees())):
1193
wt = result.create_workingtree(accelerator_tree=accelerator_tree,
1197
if wt.path2id('') is None:
1199
wt.set_root_id(self.open_workingtree.get_root_id())
1200
except errors.NoWorkingTree:
1206
if recurse == 'down':
1208
basis = wt.basis_tree()
1210
subtrees = basis.iter_references()
1211
elif result_branch is not None:
1212
basis = result_branch.basis_tree()
1214
subtrees = basis.iter_references()
1215
elif source_branch is not None:
1216
basis = source_branch.basis_tree()
1218
subtrees = basis.iter_references()
1223
for path, file_id in subtrees:
1224
target = urlutils.join(url, urlutils.escape(path))
1225
sublocation = source_branch.reference_parent(file_id, path)
1226
sublocation.bzrdir.sprout(target,
1227
basis.get_reference_revision(file_id, path),
1228
force_new_repo=force_new_repo, recurse=recurse,
1231
if basis is not None:
1235
def push_branch(self, source, revision_id=None, overwrite=False,
1236
remember=False, create_prefix=False):
1237
"""Push the source branch into this BzrDir."""
1239
# If we can open a branch, use its direct repository, otherwise see
1240
# if there is a repository without a branch.
1242
br_to = self.open_branch()
1243
except errors.NotBranchError:
1244
# Didn't find a branch, can we find a repository?
1245
repository_to = self.find_repository()
1247
# Found a branch, so we must have found a repository
1248
repository_to = br_to.repository
1250
push_result = PushResult()
1251
push_result.source_branch = source
1253
# We have a repository but no branch, copy the revisions, and then
1255
repository_to.fetch(source.repository, revision_id=revision_id)
1256
br_to = source.clone(self, revision_id=revision_id)
1257
if source.get_push_location() is None or remember:
1258
source.set_push_location(br_to.base)
1259
push_result.stacked_on = None
1260
push_result.branch_push_result = None
1261
push_result.old_revno = None
1262
push_result.old_revid = _mod_revision.NULL_REVISION
1263
push_result.target_branch = br_to
1264
push_result.master_branch = None
1265
push_result.workingtree_updated = False
1267
# We have successfully opened the branch, remember if necessary:
1268
if source.get_push_location() is None or remember:
1269
source.set_push_location(br_to.base)
1271
tree_to = self.open_workingtree()
1272
except errors.NotLocalUrl:
1273
push_result.branch_push_result = source.push(br_to,
1274
overwrite, stop_revision=revision_id)
1275
push_result.workingtree_updated = False
1276
except errors.NoWorkingTree:
1277
push_result.branch_push_result = source.push(br_to,
1278
overwrite, stop_revision=revision_id)
1279
push_result.workingtree_updated = None # Not applicable
1281
tree_to.lock_write()
1283
push_result.branch_push_result = source.push(
1284
tree_to.branch, overwrite, stop_revision=revision_id)
1288
push_result.workingtree_updated = True
1289
push_result.old_revno = push_result.branch_push_result.old_revno
1290
push_result.old_revid = push_result.branch_push_result.old_revid
1291
push_result.target_branch = \
1292
push_result.branch_push_result.target_branch
1296
class BzrDirHooks(hooks.Hooks):
1297
"""Hooks for BzrDir operations."""
1300
"""Create the default hooks."""
1301
hooks.Hooks.__init__(self)
1302
self.create_hook(hooks.HookPoint('pre_open',
1303
"Invoked before attempting to open a BzrDir with the transport "
1304
"that the open will use.", (1, 14), None))
1306
# install the default hooks
1307
BzrDir.hooks = BzrDirHooks()
1310
class BzrDirPreSplitOut(BzrDir):
1311
"""A common class for the all-in-one formats."""
1313
def __init__(self, _transport, _format):
1314
"""See BzrDir.__init__."""
1315
super(BzrDirPreSplitOut, self).__init__(_transport, _format)
1316
self._control_files = lockable_files.LockableFiles(
1317
self.get_branch_transport(None),
1318
self._format._lock_file_name,
1319
self._format._lock_class)
1321
def break_lock(self):
1322
"""Pre-splitout bzrdirs do not suffer from stale locks."""
1323
raise NotImplementedError(self.break_lock)
1325
def cloning_metadir(self, require_stacking=False):
1326
"""Produce a metadir suitable for cloning with."""
1327
if require_stacking:
1328
return format_registry.make_bzrdir('1.6')
1329
return self._format.__class__()
1331
def clone(self, url, revision_id=None, force_new_repo=False,
1332
preserve_stacking=False):
1333
"""See BzrDir.clone().
1335
force_new_repo has no effect, since this family of formats always
1336
require a new repository.
1337
preserve_stacking has no effect, since no source branch using this
1338
family of formats can be stacked, so there is no stacking to preserve.
1340
self._make_tail(url)
1341
result = self._format._initialize_for_clone(url)
1342
self.open_repository().clone(result, revision_id=revision_id)
1343
from_branch = self.open_branch()
1344
from_branch.clone(result, revision_id=revision_id)
1346
tree = self.open_workingtree()
1347
except errors.NotLocalUrl:
1348
# make a new one, this format always has to have one.
1349
result._init_workingtree()
1354
def create_branch(self):
1355
"""See BzrDir.create_branch."""
1356
return self._format.get_branch_format().initialize(self)
1358
def destroy_branch(self):
1359
"""See BzrDir.destroy_branch."""
1360
raise errors.UnsupportedOperation(self.destroy_branch, self)
1362
def create_repository(self, shared=False):
1363
"""See BzrDir.create_repository."""
1365
raise errors.IncompatibleFormat('shared repository', self._format)
1366
return self.open_repository()
1368
def destroy_repository(self):
1369
"""See BzrDir.destroy_repository."""
1370
raise errors.UnsupportedOperation(self.destroy_repository, self)
1372
def create_workingtree(self, revision_id=None, from_branch=None,
1373
accelerator_tree=None, hardlink=False):
1374
"""See BzrDir.create_workingtree."""
1375
# The workingtree is sometimes created when the bzrdir is created,
1376
# but not when cloning.
1378
# this looks buggy but is not -really-
1379
# because this format creates the workingtree when the bzrdir is
1381
# clone and sprout will have set the revision_id
1382
# and that will have set it for us, its only
1383
# specific uses of create_workingtree in isolation
1384
# that can do wonky stuff here, and that only
1385
# happens for creating checkouts, which cannot be
1386
# done on this format anyway. So - acceptable wart.
1388
result = self.open_workingtree(recommend_upgrade=False)
1389
except errors.NoSuchFile:
1390
result = self._init_workingtree()
1391
if revision_id is not None:
1392
if revision_id == _mod_revision.NULL_REVISION:
1393
result.set_parent_ids([])
1395
result.set_parent_ids([revision_id])
1398
def _init_workingtree(self):
1399
from bzrlib.workingtree import WorkingTreeFormat2
1401
return WorkingTreeFormat2().initialize(self)
1402
except errors.NotLocalUrl:
1403
# Even though we can't access the working tree, we need to
1404
# create its control files.
1405
return WorkingTreeFormat2()._stub_initialize_on_transport(
1406
self.transport, self._control_files._file_mode)
1408
def destroy_workingtree(self):
1409
"""See BzrDir.destroy_workingtree."""
1410
raise errors.UnsupportedOperation(self.destroy_workingtree, self)
1412
def destroy_workingtree_metadata(self):
1413
"""See BzrDir.destroy_workingtree_metadata."""
1414
raise errors.UnsupportedOperation(self.destroy_workingtree_metadata,
1417
def get_branch_transport(self, branch_format):
1418
"""See BzrDir.get_branch_transport()."""
1419
if branch_format is None:
1420
return self.transport
1422
branch_format.get_format_string()
1423
except NotImplementedError:
1424
return self.transport
1425
raise errors.IncompatibleFormat(branch_format, self._format)
1427
def get_repository_transport(self, repository_format):
1428
"""See BzrDir.get_repository_transport()."""
1429
if repository_format is None:
1430
return self.transport
1432
repository_format.get_format_string()
1433
except NotImplementedError:
1434
return self.transport
1435
raise errors.IncompatibleFormat(repository_format, self._format)
1437
def get_workingtree_transport(self, workingtree_format):
1438
"""See BzrDir.get_workingtree_transport()."""
1439
if workingtree_format is None:
1440
return self.transport
1442
workingtree_format.get_format_string()
1443
except NotImplementedError:
1444
return self.transport
1445
raise errors.IncompatibleFormat(workingtree_format, self._format)
1447
def needs_format_conversion(self, format=None):
1448
"""See BzrDir.needs_format_conversion()."""
1449
# if the format is not the same as the system default,
1450
# an upgrade is needed.
1452
symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1453
% 'needs_format_conversion(format=None)')
1454
format = BzrDirFormat.get_default_format()
1455
return not isinstance(self._format, format.__class__)
1457
def open_branch(self, unsupported=False, ignore_fallbacks=False):
1458
"""See BzrDir.open_branch."""
1459
from bzrlib.branch import BzrBranchFormat4
1460
format = BzrBranchFormat4()
1461
self._check_supported(format, unsupported)
1462
return format.open(self, _found=True)
1464
def sprout(self, url, revision_id=None, force_new_repo=False,
1465
possible_transports=None, accelerator_tree=None,
1466
hardlink=False, stacked=False, create_tree_if_local=True,
1467
source_branch=None):
1468
"""See BzrDir.sprout()."""
1469
if source_branch is not None:
1470
my_branch = self.open_branch()
1471
if source_branch.base != my_branch.base:
1472
raise AssertionError(
1473
"source branch %r is not within %r with branch %r" %
1474
(source_branch, self, my_branch))
1476
raise errors.UnstackableBranchFormat(
1477
self._format, self.root_transport.base)
1478
if not create_tree_if_local:
1479
raise errors.MustHaveWorkingTree(
1480
self._format, self.root_transport.base)
1481
from bzrlib.workingtree import WorkingTreeFormat2
1482
self._make_tail(url)
1483
result = self._format._initialize_for_clone(url)
1485
self.open_repository().clone(result, revision_id=revision_id)
1486
except errors.NoRepositoryPresent:
1489
self.open_branch().sprout(result, revision_id=revision_id)
1490
except errors.NotBranchError:
1493
# we always want a working tree
1494
WorkingTreeFormat2().initialize(result,
1495
accelerator_tree=accelerator_tree,
1500
class BzrDir4(BzrDirPreSplitOut):
1501
"""A .bzr version 4 control object.
1503
This is a deprecated format and may be removed after sept 2006.
1506
def create_repository(self, shared=False):
1507
"""See BzrDir.create_repository."""
1508
return self._format.repository_format.initialize(self, shared)
1510
def needs_format_conversion(self, format=None):
1511
"""Format 4 dirs are always in need of conversion."""
1513
symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1514
% 'needs_format_conversion(format=None)')
1517
def open_repository(self):
1518
"""See BzrDir.open_repository."""
1519
from bzrlib.repofmt.weaverepo import RepositoryFormat4
1520
return RepositoryFormat4().open(self, _found=True)
1523
class BzrDir5(BzrDirPreSplitOut):
1524
"""A .bzr version 5 control object.
1526
This is a deprecated format and may be removed after sept 2006.
1529
def open_repository(self):
1530
"""See BzrDir.open_repository."""
1531
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1532
return RepositoryFormat5().open(self, _found=True)
1534
def open_workingtree(self, _unsupported=False,
1535
recommend_upgrade=True):
1536
"""See BzrDir.create_workingtree."""
1537
from bzrlib.workingtree import WorkingTreeFormat2
1538
wt_format = WorkingTreeFormat2()
1539
# we don't warn here about upgrades; that ought to be handled for the
1541
return wt_format.open(self, _found=True)
1544
class BzrDir6(BzrDirPreSplitOut):
1545
"""A .bzr version 6 control object.
1547
This is a deprecated format and may be removed after sept 2006.
1550
def open_repository(self):
1551
"""See BzrDir.open_repository."""
1552
from bzrlib.repofmt.weaverepo import RepositoryFormat6
1553
return RepositoryFormat6().open(self, _found=True)
1555
def open_workingtree(self, _unsupported=False,
1556
recommend_upgrade=True):
1557
"""See BzrDir.create_workingtree."""
1558
# we don't warn here about upgrades; that ought to be handled for the
1560
from bzrlib.workingtree import WorkingTreeFormat2
1561
return WorkingTreeFormat2().open(self, _found=True)
1564
class BzrDirMeta1(BzrDir):
1565
"""A .bzr meta version 1 control object.
1567
This is the first control object where the
1568
individual aspects are really split out: there are separate repository,
1569
workingtree and branch subdirectories and any subset of the three can be
1570
present within a BzrDir.
1573
def can_convert_format(self):
1574
"""See BzrDir.can_convert_format()."""
1577
def create_branch(self):
1578
"""See BzrDir.create_branch."""
1579
return self._format.get_branch_format().initialize(self)
1581
def destroy_branch(self):
1582
"""See BzrDir.create_branch."""
1583
self.transport.delete_tree('branch')
1585
def create_repository(self, shared=False):
1586
"""See BzrDir.create_repository."""
1587
return self._format.repository_format.initialize(self, shared)
1589
def destroy_repository(self):
1590
"""See BzrDir.destroy_repository."""
1591
self.transport.delete_tree('repository')
1593
def create_workingtree(self, revision_id=None, from_branch=None,
1594
accelerator_tree=None, hardlink=False):
1595
"""See BzrDir.create_workingtree."""
1596
return self._format.workingtree_format.initialize(
1597
self, revision_id, from_branch=from_branch,
1598
accelerator_tree=accelerator_tree, hardlink=hardlink)
1600
def destroy_workingtree(self):
1601
"""See BzrDir.destroy_workingtree."""
1602
wt = self.open_workingtree(recommend_upgrade=False)
1603
repository = wt.branch.repository
1604
empty = repository.revision_tree(_mod_revision.NULL_REVISION)
1605
wt.revert(old_tree=empty)
1606
self.destroy_workingtree_metadata()
1608
def destroy_workingtree_metadata(self):
1609
self.transport.delete_tree('checkout')
1611
def find_branch_format(self):
1612
"""Find the branch 'format' for this bzrdir.
1614
This might be a synthetic object for e.g. RemoteBranch and SVN.
1616
from bzrlib.branch import BranchFormat
1617
return BranchFormat.find_format(self)
1619
def _get_mkdir_mode(self):
1620
"""Figure out the mode to use when creating a bzrdir subdir."""
1621
temp_control = lockable_files.LockableFiles(self.transport, '',
1622
lockable_files.TransportLock)
1623
return temp_control._dir_mode
1625
def get_branch_reference(self):
1626
"""See BzrDir.get_branch_reference()."""
1627
from bzrlib.branch import BranchFormat
1628
format = BranchFormat.find_format(self)
1629
return format.get_reference(self)
1631
def get_branch_transport(self, branch_format):
1632
"""See BzrDir.get_branch_transport()."""
1633
if branch_format is None:
1634
return self.transport.clone('branch')
1636
branch_format.get_format_string()
1637
except NotImplementedError:
1638
raise errors.IncompatibleFormat(branch_format, self._format)
1640
self.transport.mkdir('branch', mode=self._get_mkdir_mode())
1641
except errors.FileExists:
1643
return self.transport.clone('branch')
1645
def get_repository_transport(self, repository_format):
1646
"""See BzrDir.get_repository_transport()."""
1647
if repository_format is None:
1648
return self.transport.clone('repository')
1650
repository_format.get_format_string()
1651
except NotImplementedError:
1652
raise errors.IncompatibleFormat(repository_format, self._format)
1654
self.transport.mkdir('repository', mode=self._get_mkdir_mode())
1655
except errors.FileExists:
1657
return self.transport.clone('repository')
1659
def get_workingtree_transport(self, workingtree_format):
1660
"""See BzrDir.get_workingtree_transport()."""
1661
if workingtree_format is None:
1662
return self.transport.clone('checkout')
1664
workingtree_format.get_format_string()
1665
except NotImplementedError:
1666
raise errors.IncompatibleFormat(workingtree_format, self._format)
1668
self.transport.mkdir('checkout', mode=self._get_mkdir_mode())
1669
except errors.FileExists:
1671
return self.transport.clone('checkout')
1673
def needs_format_conversion(self, format=None):
1674
"""See BzrDir.needs_format_conversion()."""
1676
symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1677
% 'needs_format_conversion(format=None)')
1679
format = BzrDirFormat.get_default_format()
1680
if not isinstance(self._format, format.__class__):
1681
# it is not a meta dir format, conversion is needed.
1683
# we might want to push this down to the repository?
1685
if not isinstance(self.open_repository()._format,
1686
format.repository_format.__class__):
1687
# the repository needs an upgrade.
1689
except errors.NoRepositoryPresent:
1692
if not isinstance(self.open_branch()._format,
1693
format.get_branch_format().__class__):
1694
# the branch needs an upgrade.
1696
except errors.NotBranchError:
1699
my_wt = self.open_workingtree(recommend_upgrade=False)
1700
if not isinstance(my_wt._format,
1701
format.workingtree_format.__class__):
1702
# the workingtree needs an upgrade.
1704
except (errors.NoWorkingTree, errors.NotLocalUrl):
1708
def open_branch(self, unsupported=False, ignore_fallbacks=False):
1709
"""See BzrDir.open_branch."""
1710
format = self.find_branch_format()
1711
self._check_supported(format, unsupported)
1712
return format.open(self, _found=True, ignore_fallbacks=ignore_fallbacks)
1714
def open_repository(self, unsupported=False):
1715
"""See BzrDir.open_repository."""
1716
from bzrlib.repository import RepositoryFormat
1717
format = RepositoryFormat.find_format(self)
1718
self._check_supported(format, unsupported)
1719
return format.open(self, _found=True)
1721
def open_workingtree(self, unsupported=False,
1722
recommend_upgrade=True):
1723
"""See BzrDir.open_workingtree."""
1724
from bzrlib.workingtree import WorkingTreeFormat
1725
format = WorkingTreeFormat.find_format(self)
1726
self._check_supported(format, unsupported,
1728
basedir=self.root_transport.base)
1729
return format.open(self, _found=True)
1731
def _get_config(self):
1732
return config.TransportConfig(self.transport, 'control.conf')
1735
class BzrDirFormat(object):
1736
"""An encapsulation of the initialization and open routines for a format.
1738
Formats provide three things:
1739
* An initialization routine,
1743
Formats are placed in a dict by their format string for reference
1744
during bzrdir opening. These should be subclasses of BzrDirFormat
1747
Once a format is deprecated, just deprecate the initialize and open
1748
methods on the format class. Do not deprecate the object, as the
1749
object will be created every system load.
1752
_default_format = None
1753
"""The default format used for new .bzr dirs."""
1756
"""The known formats."""
1758
_control_formats = []
1759
"""The registered control formats - .bzr, ....
1761
This is a list of BzrDirFormat objects.
1764
_control_server_formats = []
1765
"""The registered control server formats, e.g. RemoteBzrDirs.
1767
This is a list of BzrDirFormat objects.
1770
_lock_file_name = 'branch-lock'
1772
# _lock_class must be set in subclasses to the lock type, typ.
1773
# TransportLock or LockDir
1776
def find_format(klass, transport, _server_formats=True):
1777
"""Return the format present at transport."""
1779
formats = klass._control_server_formats + klass._control_formats
1781
formats = klass._control_formats
1782
for format in formats:
1784
return format.probe_transport(transport)
1785
except errors.NotBranchError:
1786
# this format does not find a control dir here.
1788
raise errors.NotBranchError(path=transport.base)
1791
def probe_transport(klass, transport):
1792
"""Return the .bzrdir style format present in a directory."""
1794
format_string = transport.get(".bzr/branch-format").read()
1795
except errors.NoSuchFile:
1796
raise errors.NotBranchError(path=transport.base)
1799
return klass._formats[format_string]
1801
raise errors.UnknownFormatError(format=format_string, kind='bzrdir')
1804
def get_default_format(klass):
1805
"""Return the current default format."""
1806
return klass._default_format
1808
def get_format_string(self):
1809
"""Return the ASCII format string that identifies this format."""
1810
raise NotImplementedError(self.get_format_string)
1812
def get_format_description(self):
1813
"""Return the short description for this format."""
1814
raise NotImplementedError(self.get_format_description)
1816
def get_converter(self, format=None):
1817
"""Return the converter to use to convert bzrdirs needing converts.
1819
This returns a bzrlib.bzrdir.Converter object.
1821
This should return the best upgrader to step this format towards the
1822
current default format. In the case of plugins we can/should provide
1823
some means for them to extend the range of returnable converters.
1825
:param format: Optional format to override the default format of the
1828
raise NotImplementedError(self.get_converter)
1830
def initialize(self, url, possible_transports=None):
1831
"""Create a bzr control dir at this url and return an opened copy.
1833
While not deprecated, this method is very specific and its use will
1834
lead to many round trips to setup a working environment. See
1835
initialize_on_transport_ex for a [nearly] all-in-one method.
1837
Subclasses should typically override initialize_on_transport
1838
instead of this method.
1840
return self.initialize_on_transport(get_transport(url,
1841
possible_transports))
1843
def initialize_on_transport(self, transport):
1844
"""Initialize a new bzrdir in the base directory of a Transport."""
1846
# can we hand off the request to the smart server rather than using
1848
client_medium = transport.get_smart_medium()
1849
except errors.NoSmartMedium:
1850
return self._initialize_on_transport_vfs(transport)
1852
# Current RPC's only know how to create bzr metadir1 instances, so
1853
# we still delegate to vfs methods if the requested format is not a
1855
if type(self) != BzrDirMetaFormat1:
1856
return self._initialize_on_transport_vfs(transport)
1857
remote_format = RemoteBzrDirFormat()
1858
self._supply_sub_formats_to(remote_format)
1859
return remote_format.initialize_on_transport(transport)
1861
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
1862
create_prefix=False, force_new_repo=False, stacked_on=None,
1863
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
1864
shared_repo=False, vfs_only=False):
1865
"""Create this format on transport.
1867
The directory to initialize will be created.
1869
:param force_new_repo: Do not use a shared repository for the target,
1870
even if one is available.
1871
:param create_prefix: Create any missing directories leading up to
1873
:param use_existing_dir: Use an existing directory if one exists.
1874
:param stacked_on: A url to stack any created branch on, None to follow
1875
any target stacking policy.
1876
:param stack_on_pwd: If stack_on is relative, the location it is
1878
:param repo_format_name: If non-None, a repository will be
1879
made-or-found. Should none be found, or if force_new_repo is True
1880
the repo_format_name is used to select the format of repository to
1882
:param make_working_trees: Control the setting of make_working_trees
1883
for a new shared repository when one is made. None to use whatever
1884
default the format has.
1885
:param shared_repo: Control whether made repositories are shared or
1887
:param vfs_only: If True do not attempt to use a smart server
1888
:return: repo, bzrdir, require_stacking, repository_policy. repo is
1889
None if none was created or found, bzrdir is always valid.
1890
require_stacking is the result of examining the stacked_on
1891
parameter and any stacking policy found for the target.
1894
# Try to hand off to a smart server
1896
client_medium = transport.get_smart_medium()
1897
except errors.NoSmartMedium:
1900
# TODO: lookup the local format from a server hint.
1901
remote_dir_format = RemoteBzrDirFormat()
1902
remote_dir_format._network_name = self.network_name()
1903
self._supply_sub_formats_to(remote_dir_format)
1904
return remote_dir_format.initialize_on_transport_ex(transport,
1905
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
1906
force_new_repo=force_new_repo, stacked_on=stacked_on,
1907
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
1908
make_working_trees=make_working_trees, shared_repo=shared_repo)
1909
# XXX: Refactor the create_prefix/no_create_prefix code into a
1910
# common helper function
1911
# The destination may not exist - if so make it according to policy.
1912
def make_directory(transport):
1913
transport.mkdir('.')
1915
def redirected(transport, e, redirection_notice):
1916
note(redirection_notice)
1917
return transport._redirected_to(e.source, e.target)
1919
transport = do_catching_redirections(make_directory, transport,
1921
except errors.FileExists:
1922
if not use_existing_dir:
1924
except errors.NoSuchFile:
1925
if not create_prefix:
1927
transport.create_prefix()
1929
require_stacking = (stacked_on is not None)
1930
# Now the target directory exists, but doesn't have a .bzr
1931
# directory. So we need to create it, along with any work to create
1932
# all of the dependent branches, etc.
1934
result = self.initialize_on_transport(transport)
1935
if repo_format_name:
1937
# use a custom format
1938
result._format.repository_format = \
1939
repository.network_format_registry.get(repo_format_name)
1940
except AttributeError:
1941
# The format didn't permit it to be set.
1943
# A repository is desired, either in-place or shared.
1944
repository_policy = result.determine_repository_policy(
1945
force_new_repo, stacked_on, stack_on_pwd,
1946
require_stacking=require_stacking)
1947
result_repo, is_new_repo = repository_policy.acquire_repository(
1948
make_working_trees, shared_repo)
1949
if not require_stacking and repository_policy._require_stacking:
1950
require_stacking = True
1951
result._format.require_stacking()
1952
result_repo.lock_write()
1955
repository_policy = None
1956
return result_repo, result, require_stacking, repository_policy
1958
def _initialize_on_transport_vfs(self, transport):
1959
"""Initialize a new bzrdir using VFS calls.
1961
:param transport: The transport to create the .bzr directory in.
1964
# Since we are creating a .bzr directory, inherit the
1965
# mode from the root directory
1966
temp_control = lockable_files.LockableFiles(transport,
1967
'', lockable_files.TransportLock)
1968
temp_control._transport.mkdir('.bzr',
1969
# FIXME: RBC 20060121 don't peek under
1971
mode=temp_control._dir_mode)
1972
if sys.platform == 'win32' and isinstance(transport, local.LocalTransport):
1973
win32utils.set_file_attr_hidden(transport._abspath('.bzr'))
1974
file_mode = temp_control._file_mode
1976
bzrdir_transport = transport.clone('.bzr')
1977
utf8_files = [('README',
1978
"This is a Bazaar control directory.\n"
1979
"Do not change any files in this directory.\n"
1980
"See http://bazaar-vcs.org/ for more information about Bazaar.\n"),
1981
('branch-format', self.get_format_string()),
1983
# NB: no need to escape relative paths that are url safe.
1984
control_files = lockable_files.LockableFiles(bzrdir_transport,
1985
self._lock_file_name, self._lock_class)
1986
control_files.create_lock()
1987
control_files.lock_write()
1989
for (filename, content) in utf8_files:
1990
bzrdir_transport.put_bytes(filename, content,
1993
control_files.unlock()
1994
return self.open(transport, _found=True)
1996
def is_supported(self):
1997
"""Is this format supported?
1999
Supported formats must be initializable and openable.
2000
Unsupported formats may not support initialization or committing or
2001
some other features depending on the reason for not being supported.
2005
def network_name(self):
2006
"""A simple byte string uniquely identifying this format for RPC calls.
2008
Bzr control formats use thir disk format string to identify the format
2009
over the wire. Its possible that other control formats have more
2010
complex detection requirements, so we permit them to use any unique and
2011
immutable string they desire.
2013
raise NotImplementedError(self.network_name)
2015
def same_model(self, target_format):
2016
return (self.repository_format.rich_root_data ==
2017
target_format.rich_root_data)
2020
def known_formats(klass):
2021
"""Return all the known formats.
2023
Concrete formats should override _known_formats.
2025
# There is double indirection here to make sure that control
2026
# formats used by more than one dir format will only be probed
2027
# once. This can otherwise be quite expensive for remote connections.
2029
for format in klass._control_formats:
2030
result.update(format._known_formats())
2034
def _known_formats(klass):
2035
"""Return the known format instances for this control format."""
2036
return set(klass._formats.values())
2038
def open(self, transport, _found=False):
2039
"""Return an instance of this format for the dir transport points at.
2041
_found is a private parameter, do not use it.
2044
found_format = BzrDirFormat.find_format(transport)
2045
if not isinstance(found_format, self.__class__):
2046
raise AssertionError("%s was asked to open %s, but it seems to need "
2048
% (self, transport, found_format))
2049
# Allow subclasses - use the found format.
2050
self._supply_sub_formats_to(found_format)
2051
return found_format._open(transport)
2052
return self._open(transport)
2054
def _open(self, transport):
2055
"""Template method helper for opening BzrDirectories.
2057
This performs the actual open and any additional logic or parameter
2060
raise NotImplementedError(self._open)
2063
def register_format(klass, format):
2064
klass._formats[format.get_format_string()] = format
2065
# bzr native formats have a network name of their format string.
2066
network_format_registry.register(format.get_format_string(), format.__class__)
2069
def register_control_format(klass, format):
2070
"""Register a format that does not use '.bzr' for its control dir.
2072
TODO: This should be pulled up into a 'ControlDirFormat' base class
2073
which BzrDirFormat can inherit from, and renamed to register_format
2074
there. It has been done without that for now for simplicity of
2077
klass._control_formats.append(format)
2080
def register_control_server_format(klass, format):
2081
"""Register a control format for client-server environments.
2083
These formats will be tried before ones registered with
2084
register_control_format. This gives implementations that decide to the
2085
chance to grab it before anything looks at the contents of the format
2088
klass._control_server_formats.append(format)
2091
def _set_default_format(klass, format):
2092
"""Set default format (for testing behavior of defaults only)"""
2093
klass._default_format = format
2097
return self.get_format_description().rstrip()
2099
def _supply_sub_formats_to(self, other_format):
2100
"""Give other_format the same values for sub formats as this has.
2102
This method is expected to be used when parameterising a
2103
RemoteBzrDirFormat instance with the parameters from a
2104
BzrDirMetaFormat1 instance.
2106
:param other_format: other_format is a format which should be
2107
compatible with whatever sub formats are supported by self.
2112
def unregister_format(klass, format):
2113
del klass._formats[format.get_format_string()]
2116
def unregister_control_format(klass, format):
2117
klass._control_formats.remove(format)
2120
class BzrDirFormat4(BzrDirFormat):
2121
"""Bzr dir format 4.
2123
This format is a combined format for working tree, branch and repository.
2125
- Format 1 working trees [always]
2126
- Format 4 branches [always]
2127
- Format 4 repositories [always]
2129
This format is deprecated: it indexes texts using a text it which is
2130
removed in format 5; write support for this format has been removed.
2133
_lock_class = lockable_files.TransportLock
2135
def get_format_string(self):
2136
"""See BzrDirFormat.get_format_string()."""
2137
return "Bazaar-NG branch, format 0.0.4\n"
2139
def get_format_description(self):
2140
"""See BzrDirFormat.get_format_description()."""
2141
return "All-in-one format 4"
2143
def get_converter(self, format=None):
2144
"""See BzrDirFormat.get_converter()."""
2145
# there is one and only one upgrade path here.
2146
return ConvertBzrDir4To5()
2148
def initialize_on_transport(self, transport):
2149
"""Format 4 branches cannot be created."""
2150
raise errors.UninitializableFormat(self)
2152
def is_supported(self):
2153
"""Format 4 is not supported.
2155
It is not supported because the model changed from 4 to 5 and the
2156
conversion logic is expensive - so doing it on the fly was not
2161
def network_name(self):
2162
return self.get_format_string()
2164
def _open(self, transport):
2165
"""See BzrDirFormat._open."""
2166
return BzrDir4(transport, self)
2168
def __return_repository_format(self):
2169
"""Circular import protection."""
2170
from bzrlib.repofmt.weaverepo import RepositoryFormat4
2171
return RepositoryFormat4()
2172
repository_format = property(__return_repository_format)
2175
class BzrDirFormatAllInOne(BzrDirFormat):
2176
"""Common class for formats before meta-dirs."""
2178
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
2179
create_prefix=False, force_new_repo=False, stacked_on=None,
2180
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
2182
"""See BzrDirFormat.initialize_on_transport_ex."""
2183
require_stacking = (stacked_on is not None)
2184
# Format 5 cannot stack, but we've been asked to - actually init
2186
if require_stacking:
2187
format = BzrDirMetaFormat1()
2188
return format.initialize_on_transport_ex(transport,
2189
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2190
force_new_repo=force_new_repo, stacked_on=stacked_on,
2191
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2192
make_working_trees=make_working_trees, shared_repo=shared_repo)
2193
return BzrDirFormat.initialize_on_transport_ex(self, transport,
2194
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2195
force_new_repo=force_new_repo, stacked_on=stacked_on,
2196
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2197
make_working_trees=make_working_trees, shared_repo=shared_repo)
2200
class BzrDirFormat5(BzrDirFormatAllInOne):
2201
"""Bzr control format 5.
2203
This format is a combined format for working tree, branch and repository.
2205
- Format 2 working trees [always]
2206
- Format 4 branches [always]
2207
- Format 5 repositories [always]
2208
Unhashed stores in the repository.
2211
_lock_class = lockable_files.TransportLock
2213
def get_format_string(self):
2214
"""See BzrDirFormat.get_format_string()."""
2215
return "Bazaar-NG branch, format 5\n"
2217
def get_branch_format(self):
2218
from bzrlib import branch
2219
return branch.BzrBranchFormat4()
2221
def get_format_description(self):
2222
"""See BzrDirFormat.get_format_description()."""
2223
return "All-in-one format 5"
2225
def get_converter(self, format=None):
2226
"""See BzrDirFormat.get_converter()."""
2227
# there is one and only one upgrade path here.
2228
return ConvertBzrDir5To6()
2230
def _initialize_for_clone(self, url):
2231
return self.initialize_on_transport(get_transport(url), _cloning=True)
2233
def initialize_on_transport(self, transport, _cloning=False):
2234
"""Format 5 dirs always have working tree, branch and repository.
2236
Except when they are being cloned.
2238
from bzrlib.branch import BzrBranchFormat4
2239
from bzrlib.repofmt.weaverepo import RepositoryFormat5
2240
result = (super(BzrDirFormat5, self).initialize_on_transport(transport))
2241
RepositoryFormat5().initialize(result, _internal=True)
2243
branch = BzrBranchFormat4().initialize(result)
2244
result._init_workingtree()
2247
def network_name(self):
2248
return self.get_format_string()
2250
def _open(self, transport):
2251
"""See BzrDirFormat._open."""
2252
return BzrDir5(transport, self)
2254
def __return_repository_format(self):
2255
"""Circular import protection."""
2256
from bzrlib.repofmt.weaverepo import RepositoryFormat5
2257
return RepositoryFormat5()
2258
repository_format = property(__return_repository_format)
2261
class BzrDirFormat6(BzrDirFormatAllInOne):
2262
"""Bzr control format 6.
2264
This format is a combined format for working tree, branch and repository.
2266
- Format 2 working trees [always]
2267
- Format 4 branches [always]
2268
- Format 6 repositories [always]
2271
_lock_class = lockable_files.TransportLock
2273
def get_format_string(self):
2274
"""See BzrDirFormat.get_format_string()."""
2275
return "Bazaar-NG branch, format 6\n"
2277
def get_format_description(self):
2278
"""See BzrDirFormat.get_format_description()."""
2279
return "All-in-one format 6"
2281
def get_branch_format(self):
2282
from bzrlib import branch
2283
return branch.BzrBranchFormat4()
2285
def get_converter(self, format=None):
2286
"""See BzrDirFormat.get_converter()."""
2287
# there is one and only one upgrade path here.
2288
return ConvertBzrDir6ToMeta()
2290
def _initialize_for_clone(self, url):
2291
return self.initialize_on_transport(get_transport(url), _cloning=True)
2293
def initialize_on_transport(self, transport, _cloning=False):
2294
"""Format 6 dirs always have working tree, branch and repository.
2296
Except when they are being cloned.
2298
from bzrlib.branch import BzrBranchFormat4
2299
from bzrlib.repofmt.weaverepo import RepositoryFormat6
2300
result = super(BzrDirFormat6, self).initialize_on_transport(transport)
2301
RepositoryFormat6().initialize(result, _internal=True)
2303
branch = BzrBranchFormat4().initialize(result)
2304
result._init_workingtree()
2307
def network_name(self):
2308
return self.get_format_string()
2310
def _open(self, transport):
2311
"""See BzrDirFormat._open."""
2312
return BzrDir6(transport, self)
2314
def __return_repository_format(self):
2315
"""Circular import protection."""
2316
from bzrlib.repofmt.weaverepo import RepositoryFormat6
2317
return RepositoryFormat6()
2318
repository_format = property(__return_repository_format)
2321
class BzrDirMetaFormat1(BzrDirFormat):
2322
"""Bzr meta control format 1
2324
This is the first format with split out working tree, branch and repository
2327
- Format 3 working trees [optional]
2328
- Format 5 branches [optional]
2329
- Format 7 repositories [optional]
2332
_lock_class = lockdir.LockDir
2335
self._workingtree_format = None
2336
self._branch_format = None
2337
self._repository_format = None
2339
def __eq__(self, other):
2340
if other.__class__ is not self.__class__:
2342
if other.repository_format != self.repository_format:
2344
if other.workingtree_format != self.workingtree_format:
2348
def __ne__(self, other):
2349
return not self == other
2351
def get_branch_format(self):
2352
if self._branch_format is None:
2353
from bzrlib.branch import BranchFormat
2354
self._branch_format = BranchFormat.get_default_format()
2355
return self._branch_format
2357
def set_branch_format(self, format):
2358
self._branch_format = format
2360
def require_stacking(self, stack_on=None, possible_transports=None,
2362
"""We have a request to stack, try to ensure the formats support it.
2364
:param stack_on: If supplied, it is the URL to a branch that we want to
2365
stack on. Check to see if that format supports stacking before
2368
# Stacking is desired. requested by the target, but does the place it
2369
# points at support stacking? If it doesn't then we should
2370
# not implicitly upgrade. We check this here.
2371
new_repo_format = None
2372
new_branch_format = None
2374
# a bit of state for get_target_branch so that we don't try to open it
2375
# 2 times, for both repo *and* branch
2376
target = [None, False, None] # target_branch, checked, upgrade anyway
2377
def get_target_branch():
2379
# We've checked, don't check again
2381
if stack_on is None:
2382
# No target format, that means we want to force upgrading
2383
target[:] = [None, True, True]
2386
target_dir = BzrDir.open(stack_on,
2387
possible_transports=possible_transports)
2388
except errors.NotBranchError:
2389
# Nothing there, don't change formats
2390
target[:] = [None, True, False]
2392
except errors.JailBreak:
2393
# JailBreak, JFDI and upgrade anyway
2394
target[:] = [None, True, True]
2397
target_branch = target_dir.open_branch()
2398
except errors.NotBranchError:
2399
# No branch, don't upgrade formats
2400
target[:] = [None, True, False]
2402
target[:] = [target_branch, True, False]
2405
if (not _skip_repo and
2406
not self.repository_format.supports_external_lookups):
2407
# We need to upgrade the Repository.
2408
target_branch, _, do_upgrade = get_target_branch()
2409
if target_branch is None:
2410
# We don't have a target branch, should we upgrade anyway?
2412
# stack_on is inaccessible, JFDI.
2413
# TODO: bad monkey, hard-coded formats...
2414
if self.repository_format.rich_root_data:
2415
new_repo_format = pack_repo.RepositoryFormatKnitPack5RichRoot()
2417
new_repo_format = pack_repo.RepositoryFormatKnitPack5()
2419
# If the target already supports stacking, then we know the
2420
# project is already able to use stacking, so auto-upgrade
2422
new_repo_format = target_branch.repository._format
2423
if not new_repo_format.supports_external_lookups:
2424
# target doesn't, source doesn't, so don't auto upgrade
2426
new_repo_format = None
2427
if new_repo_format is not None:
2428
self.repository_format = new_repo_format
2429
note('Source repository format does not support stacking,'
2430
' using format:\n %s',
2431
new_repo_format.get_format_description())
2433
if not self.get_branch_format().supports_stacking():
2434
# We just checked the repo, now lets check if we need to
2435
# upgrade the branch format
2436
target_branch, _, do_upgrade = get_target_branch()
2437
if target_branch is None:
2439
# TODO: bad monkey, hard-coded formats...
2440
new_branch_format = branch.BzrBranchFormat7()
2442
new_branch_format = target_branch._format
2443
if not new_branch_format.supports_stacking():
2444
new_branch_format = None
2445
if new_branch_format is not None:
2446
# Does support stacking, use its format.
2447
self.set_branch_format(new_branch_format)
2448
note('Source branch format does not support stacking,'
2449
' using format:\n %s',
2450
new_branch_format.get_format_description())
2452
def get_converter(self, format=None):
2453
"""See BzrDirFormat.get_converter()."""
2455
format = BzrDirFormat.get_default_format()
2456
if not isinstance(self, format.__class__):
2457
# converting away from metadir is not implemented
2458
raise NotImplementedError(self.get_converter)
2459
return ConvertMetaToMeta(format)
2461
def get_format_string(self):
2462
"""See BzrDirFormat.get_format_string()."""
2463
return "Bazaar-NG meta directory, format 1\n"
2465
def get_format_description(self):
2466
"""See BzrDirFormat.get_format_description()."""
2467
return "Meta directory format 1"
2469
def network_name(self):
2470
return self.get_format_string()
2472
def _open(self, transport):
2473
"""See BzrDirFormat._open."""
2474
# Create a new format instance because otherwise initialisation of new
2475
# metadirs share the global default format object leading to alias
2477
format = BzrDirMetaFormat1()
2478
self._supply_sub_formats_to(format)
2479
return BzrDirMeta1(transport, format)
2481
def __return_repository_format(self):
2482
"""Circular import protection."""
2483
if self._repository_format:
2484
return self._repository_format
2485
from bzrlib.repository import RepositoryFormat
2486
return RepositoryFormat.get_default_format()
2488
def _set_repository_format(self, value):
2489
"""Allow changing the repository format for metadir formats."""
2490
self._repository_format = value
2492
repository_format = property(__return_repository_format,
2493
_set_repository_format)
2495
def _supply_sub_formats_to(self, other_format):
2496
"""Give other_format the same values for sub formats as this has.
2498
This method is expected to be used when parameterising a
2499
RemoteBzrDirFormat instance with the parameters from a
2500
BzrDirMetaFormat1 instance.
2502
:param other_format: other_format is a format which should be
2503
compatible with whatever sub formats are supported by self.
2506
if getattr(self, '_repository_format', None) is not None:
2507
other_format.repository_format = self.repository_format
2508
if self._branch_format is not None:
2509
other_format._branch_format = self._branch_format
2510
if self._workingtree_format is not None:
2511
other_format.workingtree_format = self.workingtree_format
2513
def __get_workingtree_format(self):
2514
if self._workingtree_format is None:
2515
from bzrlib.workingtree import WorkingTreeFormat
2516
self._workingtree_format = WorkingTreeFormat.get_default_format()
2517
return self._workingtree_format
2519
def __set_workingtree_format(self, wt_format):
2520
self._workingtree_format = wt_format
2522
workingtree_format = property(__get_workingtree_format,
2523
__set_workingtree_format)
2526
network_format_registry = registry.FormatRegistry()
2527
"""Registry of formats indexed by their network name.
2529
The network name for a BzrDirFormat is an identifier that can be used when
2530
referring to formats with smart server operations. See
2531
BzrDirFormat.network_name() for more detail.
2535
# Register bzr control format
2536
BzrDirFormat.register_control_format(BzrDirFormat)
2538
# Register bzr formats
2539
BzrDirFormat.register_format(BzrDirFormat4())
2540
BzrDirFormat.register_format(BzrDirFormat5())
2541
BzrDirFormat.register_format(BzrDirFormat6())
2542
__default_format = BzrDirMetaFormat1()
2543
BzrDirFormat.register_format(__default_format)
2544
BzrDirFormat._default_format = __default_format
2547
class Converter(object):
2548
"""Converts a disk format object from one format to another."""
2550
def convert(self, to_convert, pb):
2551
"""Perform the conversion of to_convert, giving feedback via pb.
2553
:param to_convert: The disk object to convert.
2554
:param pb: a progress bar to use for progress information.
2557
def step(self, message):
2558
"""Update the pb by a step."""
2560
self.pb.update(message, self.count, self.total)
2563
class ConvertBzrDir4To5(Converter):
2564
"""Converts format 4 bzr dirs to format 5."""
2567
super(ConvertBzrDir4To5, self).__init__()
2568
self.converted_revs = set()
2569
self.absent_revisions = set()
2573
def convert(self, to_convert, pb):
2574
"""See Converter.convert()."""
2575
self.bzrdir = to_convert
2577
self.pb.note('starting upgrade from format 4 to 5')
2578
if isinstance(self.bzrdir.transport, local.LocalTransport):
2579
self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
2580
self._convert_to_weaves()
2581
return BzrDir.open(self.bzrdir.root_transport.base)
2583
def _convert_to_weaves(self):
2584
self.pb.note('note: upgrade may be faster if all store files are ungzipped first')
2587
stat = self.bzrdir.transport.stat('weaves')
2588
if not S_ISDIR(stat.st_mode):
2589
self.bzrdir.transport.delete('weaves')
2590
self.bzrdir.transport.mkdir('weaves')
2591
except errors.NoSuchFile:
2592
self.bzrdir.transport.mkdir('weaves')
2593
# deliberately not a WeaveFile as we want to build it up slowly.
2594
self.inv_weave = Weave('inventory')
2595
# holds in-memory weaves for all files
2596
self.text_weaves = {}
2597
self.bzrdir.transport.delete('branch-format')
2598
self.branch = self.bzrdir.open_branch()
2599
self._convert_working_inv()
2600
rev_history = self.branch.revision_history()
2601
# to_read is a stack holding the revisions we still need to process;
2602
# appending to it adds new highest-priority revisions
2603
self.known_revisions = set(rev_history)
2604
self.to_read = rev_history[-1:]
2606
rev_id = self.to_read.pop()
2607
if (rev_id not in self.revisions
2608
and rev_id not in self.absent_revisions):
2609
self._load_one_rev(rev_id)
2611
to_import = self._make_order()
2612
for i, rev_id in enumerate(to_import):
2613
self.pb.update('converting revision', i, len(to_import))
2614
self._convert_one_rev(rev_id)
2616
self._write_all_weaves()
2617
self._write_all_revs()
2618
self.pb.note('upgraded to weaves:')
2619
self.pb.note(' %6d revisions and inventories', len(self.revisions))
2620
self.pb.note(' %6d revisions not present', len(self.absent_revisions))
2621
self.pb.note(' %6d texts', self.text_count)
2622
self._cleanup_spare_files_after_format4()
2623
self.branch._transport.put_bytes(
2625
BzrDirFormat5().get_format_string(),
2626
mode=self.bzrdir._get_file_mode())
2628
def _cleanup_spare_files_after_format4(self):
2629
# FIXME working tree upgrade foo.
2630
for n in 'merged-patches', 'pending-merged-patches':
2632
## assert os.path.getsize(p) == 0
2633
self.bzrdir.transport.delete(n)
2634
except errors.NoSuchFile:
2636
self.bzrdir.transport.delete_tree('inventory-store')
2637
self.bzrdir.transport.delete_tree('text-store')
2639
def _convert_working_inv(self):
2640
inv = xml4.serializer_v4.read_inventory(
2641
self.branch._transport.get('inventory'))
2642
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv, working=True)
2643
self.branch._transport.put_bytes('inventory', new_inv_xml,
2644
mode=self.bzrdir._get_file_mode())
2646
def _write_all_weaves(self):
2647
controlweaves = WeaveStore(self.bzrdir.transport, prefixed=False)
2648
weave_transport = self.bzrdir.transport.clone('weaves')
2649
weaves = WeaveStore(weave_transport, prefixed=False)
2650
transaction = WriteTransaction()
2654
for file_id, file_weave in self.text_weaves.items():
2655
self.pb.update('writing weave', i, len(self.text_weaves))
2656
weaves._put_weave(file_id, file_weave, transaction)
2658
self.pb.update('inventory', 0, 1)
2659
controlweaves._put_weave('inventory', self.inv_weave, transaction)
2660
self.pb.update('inventory', 1, 1)
2664
def _write_all_revs(self):
2665
"""Write all revisions out in new form."""
2666
self.bzrdir.transport.delete_tree('revision-store')
2667
self.bzrdir.transport.mkdir('revision-store')
2668
revision_transport = self.bzrdir.transport.clone('revision-store')
2670
from bzrlib.xml5 import serializer_v5
2671
from bzrlib.repofmt.weaverepo import RevisionTextStore
2672
revision_store = RevisionTextStore(revision_transport,
2673
serializer_v5, False, versionedfile.PrefixMapper(),
2674
lambda:True, lambda:True)
2676
for i, rev_id in enumerate(self.converted_revs):
2677
self.pb.update('write revision', i, len(self.converted_revs))
2678
text = serializer_v5.write_revision_to_string(
2679
self.revisions[rev_id])
2681
revision_store.add_lines(key, None, osutils.split_lines(text))
2685
def _load_one_rev(self, rev_id):
2686
"""Load a revision object into memory.
2688
Any parents not either loaded or abandoned get queued to be
2690
self.pb.update('loading revision',
2691
len(self.revisions),
2692
len(self.known_revisions))
2693
if not self.branch.repository.has_revision(rev_id):
2695
self.pb.note('revision {%s} not present in branch; '
2696
'will be converted as a ghost',
2698
self.absent_revisions.add(rev_id)
2700
rev = self.branch.repository.get_revision(rev_id)
2701
for parent_id in rev.parent_ids:
2702
self.known_revisions.add(parent_id)
2703
self.to_read.append(parent_id)
2704
self.revisions[rev_id] = rev
2706
def _load_old_inventory(self, rev_id):
2707
old_inv_xml = self.branch.repository.inventory_store.get(rev_id).read()
2708
inv = xml4.serializer_v4.read_inventory_from_string(old_inv_xml)
2709
inv.revision_id = rev_id
2710
rev = self.revisions[rev_id]
2713
def _load_updated_inventory(self, rev_id):
2714
inv_xml = self.inv_weave.get_text(rev_id)
2715
inv = xml5.serializer_v5.read_inventory_from_string(inv_xml, rev_id)
2718
def _convert_one_rev(self, rev_id):
2719
"""Convert revision and all referenced objects to new format."""
2720
rev = self.revisions[rev_id]
2721
inv = self._load_old_inventory(rev_id)
2722
present_parents = [p for p in rev.parent_ids
2723
if p not in self.absent_revisions]
2724
self._convert_revision_contents(rev, inv, present_parents)
2725
self._store_new_inv(rev, inv, present_parents)
2726
self.converted_revs.add(rev_id)
2728
def _store_new_inv(self, rev, inv, present_parents):
2729
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
2730
new_inv_sha1 = sha_string(new_inv_xml)
2731
self.inv_weave.add_lines(rev.revision_id,
2733
new_inv_xml.splitlines(True))
2734
rev.inventory_sha1 = new_inv_sha1
2736
def _convert_revision_contents(self, rev, inv, present_parents):
2737
"""Convert all the files within a revision.
2739
Also upgrade the inventory to refer to the text revision ids."""
2740
rev_id = rev.revision_id
2741
mutter('converting texts of revision {%s}',
2743
parent_invs = map(self._load_updated_inventory, present_parents)
2744
entries = inv.iter_entries()
2746
for path, ie in entries:
2747
self._convert_file_version(rev, ie, parent_invs)
2749
def _convert_file_version(self, rev, ie, parent_invs):
2750
"""Convert one version of one file.
2752
The file needs to be added into the weave if it is a merge
2753
of >=2 parents or if it's changed from its parent.
2755
file_id = ie.file_id
2756
rev_id = rev.revision_id
2757
w = self.text_weaves.get(file_id)
2760
self.text_weaves[file_id] = w
2761
text_changed = False
2762
parent_candiate_entries = ie.parent_candidates(parent_invs)
2763
heads = graph.Graph(self).heads(parent_candiate_entries.keys())
2764
# XXX: Note that this is unordered - and this is tolerable because
2765
# the previous code was also unordered.
2766
previous_entries = dict((head, parent_candiate_entries[head]) for head
2768
self.snapshot_ie(previous_entries, ie, w, rev_id)
2771
def get_parent_map(self, revision_ids):
2772
"""See graph.StackedParentsProvider.get_parent_map"""
2773
return dict((revision_id, self.revisions[revision_id])
2774
for revision_id in revision_ids
2775
if revision_id in self.revisions)
2777
def snapshot_ie(self, previous_revisions, ie, w, rev_id):
2778
# TODO: convert this logic, which is ~= snapshot to
2779
# a call to:. This needs the path figured out. rather than a work_tree
2780
# a v4 revision_tree can be given, or something that looks enough like
2781
# one to give the file content to the entry if it needs it.
2782
# and we need something that looks like a weave store for snapshot to
2784
#ie.snapshot(rev, PATH, previous_revisions, REVISION_TREE, InMemoryWeaveStore(self.text_weaves))
2785
if len(previous_revisions) == 1:
2786
previous_ie = previous_revisions.values()[0]
2787
if ie._unchanged(previous_ie):
2788
ie.revision = previous_ie.revision
2791
text = self.branch.repository._text_store.get(ie.text_id)
2792
file_lines = text.readlines()
2793
w.add_lines(rev_id, previous_revisions, file_lines)
2794
self.text_count += 1
2796
w.add_lines(rev_id, previous_revisions, [])
2797
ie.revision = rev_id
2799
def _make_order(self):
2800
"""Return a suitable order for importing revisions.
2802
The order must be such that an revision is imported after all
2803
its (present) parents.
2805
todo = set(self.revisions.keys())
2806
done = self.absent_revisions.copy()
2809
# scan through looking for a revision whose parents
2811
for rev_id in sorted(list(todo)):
2812
rev = self.revisions[rev_id]
2813
parent_ids = set(rev.parent_ids)
2814
if parent_ids.issubset(done):
2815
# can take this one now
2816
order.append(rev_id)
2822
class ConvertBzrDir5To6(Converter):
2823
"""Converts format 5 bzr dirs to format 6."""
2825
def convert(self, to_convert, pb):
2826
"""See Converter.convert()."""
2827
self.bzrdir = to_convert
2829
self.pb.note('starting upgrade from format 5 to 6')
2830
self._convert_to_prefixed()
2831
return BzrDir.open(self.bzrdir.root_transport.base)
2833
def _convert_to_prefixed(self):
2834
from bzrlib.store import TransportStore
2835
self.bzrdir.transport.delete('branch-format')
2836
for store_name in ["weaves", "revision-store"]:
2837
self.pb.note("adding prefixes to %s" % store_name)
2838
store_transport = self.bzrdir.transport.clone(store_name)
2839
store = TransportStore(store_transport, prefixed=True)
2840
for urlfilename in store_transport.list_dir('.'):
2841
filename = urlutils.unescape(urlfilename)
2842
if (filename.endswith(".weave") or
2843
filename.endswith(".gz") or
2844
filename.endswith(".sig")):
2845
file_id, suffix = os.path.splitext(filename)
2849
new_name = store._mapper.map((file_id,)) + suffix
2850
# FIXME keep track of the dirs made RBC 20060121
2852
store_transport.move(filename, new_name)
2853
except errors.NoSuchFile: # catches missing dirs strangely enough
2854
store_transport.mkdir(osutils.dirname(new_name))
2855
store_transport.move(filename, new_name)
2856
self.bzrdir.transport.put_bytes(
2858
BzrDirFormat6().get_format_string(),
2859
mode=self.bzrdir._get_file_mode())
2862
class ConvertBzrDir6ToMeta(Converter):
2863
"""Converts format 6 bzr dirs to metadirs."""
2865
def convert(self, to_convert, pb):
2866
"""See Converter.convert()."""
2867
from bzrlib.repofmt.weaverepo import RepositoryFormat7
2868
from bzrlib.branch import BzrBranchFormat5
2869
self.bzrdir = to_convert
2872
self.total = 20 # the steps we know about
2873
self.garbage_inventories = []
2874
self.dir_mode = self.bzrdir._get_dir_mode()
2875
self.file_mode = self.bzrdir._get_file_mode()
2877
self.pb.note('starting upgrade from format 6 to metadir')
2878
self.bzrdir.transport.put_bytes(
2880
"Converting to format 6",
2881
mode=self.file_mode)
2882
# its faster to move specific files around than to open and use the apis...
2883
# first off, nuke ancestry.weave, it was never used.
2885
self.step('Removing ancestry.weave')
2886
self.bzrdir.transport.delete('ancestry.weave')
2887
except errors.NoSuchFile:
2889
# find out whats there
2890
self.step('Finding branch files')
2891
last_revision = self.bzrdir.open_branch().last_revision()
2892
bzrcontents = self.bzrdir.transport.list_dir('.')
2893
for name in bzrcontents:
2894
if name.startswith('basis-inventory.'):
2895
self.garbage_inventories.append(name)
2896
# create new directories for repository, working tree and branch
2897
repository_names = [('inventory.weave', True),
2898
('revision-store', True),
2900
self.step('Upgrading repository ')
2901
self.bzrdir.transport.mkdir('repository', mode=self.dir_mode)
2902
self.make_lock('repository')
2903
# we hard code the formats here because we are converting into
2904
# the meta format. The meta format upgrader can take this to a
2905
# future format within each component.
2906
self.put_format('repository', RepositoryFormat7())
2907
for entry in repository_names:
2908
self.move_entry('repository', entry)
2910
self.step('Upgrading branch ')
2911
self.bzrdir.transport.mkdir('branch', mode=self.dir_mode)
2912
self.make_lock('branch')
2913
self.put_format('branch', BzrBranchFormat5())
2914
branch_files = [('revision-history', True),
2915
('branch-name', True),
2917
for entry in branch_files:
2918
self.move_entry('branch', entry)
2920
checkout_files = [('pending-merges', True),
2921
('inventory', True),
2922
('stat-cache', False)]
2923
# If a mandatory checkout file is not present, the branch does not have
2924
# a functional checkout. Do not create a checkout in the converted
2926
for name, mandatory in checkout_files:
2927
if mandatory and name not in bzrcontents:
2928
has_checkout = False
2932
if not has_checkout:
2933
self.pb.note('No working tree.')
2934
# If some checkout files are there, we may as well get rid of them.
2935
for name, mandatory in checkout_files:
2936
if name in bzrcontents:
2937
self.bzrdir.transport.delete(name)
2939
from bzrlib.workingtree import WorkingTreeFormat3
2940
self.step('Upgrading working tree')
2941
self.bzrdir.transport.mkdir('checkout', mode=self.dir_mode)
2942
self.make_lock('checkout')
2944
'checkout', WorkingTreeFormat3())
2945
self.bzrdir.transport.delete_multi(
2946
self.garbage_inventories, self.pb)
2947
for entry in checkout_files:
2948
self.move_entry('checkout', entry)
2949
if last_revision is not None:
2950
self.bzrdir.transport.put_bytes(
2951
'checkout/last-revision', last_revision)
2952
self.bzrdir.transport.put_bytes(
2954
BzrDirMetaFormat1().get_format_string(),
2955
mode=self.file_mode)
2956
return BzrDir.open(self.bzrdir.root_transport.base)
2958
def make_lock(self, name):
2959
"""Make a lock for the new control dir name."""
2960
self.step('Make %s lock' % name)
2961
ld = lockdir.LockDir(self.bzrdir.transport,
2963
file_modebits=self.file_mode,
2964
dir_modebits=self.dir_mode)
2967
def move_entry(self, new_dir, entry):
2968
"""Move then entry name into new_dir."""
2970
mandatory = entry[1]
2971
self.step('Moving %s' % name)
2973
self.bzrdir.transport.move(name, '%s/%s' % (new_dir, name))
2974
except errors.NoSuchFile:
2978
def put_format(self, dirname, format):
2979
self.bzrdir.transport.put_bytes('%s/format' % dirname,
2980
format.get_format_string(),
2984
class ConvertMetaToMeta(Converter):
2985
"""Converts the components of metadirs."""
2987
def __init__(self, target_format):
2988
"""Create a metadir to metadir converter.
2990
:param target_format: The final metadir format that is desired.
2992
self.target_format = target_format
2994
def convert(self, to_convert, pb):
2995
"""See Converter.convert()."""
2996
self.bzrdir = to_convert
3000
self.step('checking repository format')
3002
repo = self.bzrdir.open_repository()
3003
except errors.NoRepositoryPresent:
3006
if not isinstance(repo._format, self.target_format.repository_format.__class__):
3007
from bzrlib.repository import CopyConverter
3008
self.pb.note('starting repository conversion')
3009
converter = CopyConverter(self.target_format.repository_format)
3010
converter.convert(repo, pb)
3012
branch = self.bzrdir.open_branch()
3013
except errors.NotBranchError:
3016
# TODO: conversions of Branch and Tree should be done by
3017
# InterXFormat lookups/some sort of registry.
3018
# Avoid circular imports
3019
from bzrlib import branch as _mod_branch
3020
old = branch._format.__class__
3021
new = self.target_format.get_branch_format().__class__
3023
if (old == _mod_branch.BzrBranchFormat5 and
3024
new in (_mod_branch.BzrBranchFormat6,
3025
_mod_branch.BzrBranchFormat7,
3026
_mod_branch.BzrBranchFormat8)):
3027
branch_converter = _mod_branch.Converter5to6()
3028
elif (old == _mod_branch.BzrBranchFormat6 and
3029
new in (_mod_branch.BzrBranchFormat7,
3030
_mod_branch.BzrBranchFormat8)):
3031
branch_converter = _mod_branch.Converter6to7()
3032
elif (old == _mod_branch.BzrBranchFormat7 and
3033
new is _mod_branch.BzrBranchFormat8):
3034
branch_converter = _mod_branch.Converter7to8()
3036
raise errors.BadConversionTarget("No converter", new)
3037
branch_converter.convert(branch)
3038
branch = self.bzrdir.open_branch()
3039
old = branch._format.__class__
3041
tree = self.bzrdir.open_workingtree(recommend_upgrade=False)
3042
except (errors.NoWorkingTree, errors.NotLocalUrl):
3045
# TODO: conversions of Branch and Tree should be done by
3046
# InterXFormat lookups
3047
if (isinstance(tree, workingtree.WorkingTree3) and
3048
not isinstance(tree, workingtree_4.DirStateWorkingTree) and
3049
isinstance(self.target_format.workingtree_format,
3050
workingtree_4.DirStateWorkingTreeFormat)):
3051
workingtree_4.Converter3to4().convert(tree)
3052
if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
3053
not isinstance(tree, workingtree_4.WorkingTree5) and
3054
isinstance(self.target_format.workingtree_format,
3055
workingtree_4.WorkingTreeFormat5)):
3056
workingtree_4.Converter4to5().convert(tree)
3057
if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
3058
not isinstance(tree, workingtree_4.WorkingTree6) and
3059
isinstance(self.target_format.workingtree_format,
3060
workingtree_4.WorkingTreeFormat6)):
3061
workingtree_4.Converter4or5to6().convert(tree)
3065
# This is not in remote.py because it's relatively small, and needs to be
3066
# registered. Putting it in remote.py creates a circular import problem.
3067
# we can make it a lazy object if the control formats is turned into something
3069
class RemoteBzrDirFormat(BzrDirMetaFormat1):
3070
"""Format representing bzrdirs accessed via a smart server"""
3073
BzrDirMetaFormat1.__init__(self)
3074
self._network_name = None
3076
def get_format_description(self):
3077
return 'bzr remote bzrdir'
3079
def get_format_string(self):
3080
raise NotImplementedError(self.get_format_string)
3082
def network_name(self):
3083
if self._network_name:
3084
return self._network_name
3086
raise AssertionError("No network name set.")
3089
def probe_transport(klass, transport):
3090
"""Return a RemoteBzrDirFormat object if it looks possible."""
3092
medium = transport.get_smart_medium()
3093
except (NotImplementedError, AttributeError,
3094
errors.TransportNotPossible, errors.NoSmartMedium,
3095
errors.SmartProtocolError):
3096
# no smart server, so not a branch for this format type.
3097
raise errors.NotBranchError(path=transport.base)
3099
# Decline to open it if the server doesn't support our required
3100
# version (3) so that the VFS-based transport will do it.
3101
if medium.should_probe():
3103
server_version = medium.protocol_version()
3104
except errors.SmartProtocolError:
3105
# Apparently there's no usable smart server there, even though
3106
# the medium supports the smart protocol.
3107
raise errors.NotBranchError(path=transport.base)
3108
if server_version != '2':
3109
raise errors.NotBranchError(path=transport.base)
3112
def initialize_on_transport(self, transport):
3114
# hand off the request to the smart server
3115
client_medium = transport.get_smart_medium()
3116
except errors.NoSmartMedium:
3117
# TODO: lookup the local format from a server hint.
3118
local_dir_format = BzrDirMetaFormat1()
3119
return local_dir_format.initialize_on_transport(transport)
3120
client = _SmartClient(client_medium)
3121
path = client.remote_path_from_transport(transport)
3123
response = client.call('BzrDirFormat.initialize', path)
3124
except errors.ErrorFromSmartServer, err:
3125
remote._translate_error(err, path=path)
3126
if response[0] != 'ok':
3127
raise errors.SmartProtocolError('unexpected response code %s' % (response,))
3128
format = RemoteBzrDirFormat()
3129
self._supply_sub_formats_to(format)
3130
return remote.RemoteBzrDir(transport, format)
3132
def parse_NoneTrueFalse(self, arg):
3139
raise AssertionError("invalid arg %r" % arg)
3141
def _serialize_NoneTrueFalse(self, arg):
3148
def _serialize_NoneString(self, arg):
3151
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
3152
create_prefix=False, force_new_repo=False, stacked_on=None,
3153
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
3156
# hand off the request to the smart server
3157
client_medium = transport.get_smart_medium()
3158
except errors.NoSmartMedium:
3161
# Decline to open it if the server doesn't support our required
3162
# version (3) so that the VFS-based transport will do it.
3163
if client_medium.should_probe():
3165
server_version = client_medium.protocol_version()
3166
if server_version != '2':
3170
except errors.SmartProtocolError:
3171
# Apparently there's no usable smart server there, even though
3172
# the medium supports the smart protocol.
3177
client = _SmartClient(client_medium)
3178
path = client.remote_path_from_transport(transport)
3179
if client_medium._is_remote_before((1, 16)):
3182
# TODO: lookup the local format from a server hint.
3183
local_dir_format = BzrDirMetaFormat1()
3184
self._supply_sub_formats_to(local_dir_format)
3185
return local_dir_format.initialize_on_transport_ex(transport,
3186
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3187
force_new_repo=force_new_repo, stacked_on=stacked_on,
3188
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3189
make_working_trees=make_working_trees, shared_repo=shared_repo,
3191
return self._initialize_on_transport_ex_rpc(client, path, transport,
3192
use_existing_dir, create_prefix, force_new_repo, stacked_on,
3193
stack_on_pwd, repo_format_name, make_working_trees, shared_repo)
3195
def _initialize_on_transport_ex_rpc(self, client, path, transport,
3196
use_existing_dir, create_prefix, force_new_repo, stacked_on,
3197
stack_on_pwd, repo_format_name, make_working_trees, shared_repo):
3199
args.append(self._serialize_NoneTrueFalse(use_existing_dir))
3200
args.append(self._serialize_NoneTrueFalse(create_prefix))
3201
args.append(self._serialize_NoneTrueFalse(force_new_repo))
3202
args.append(self._serialize_NoneString(stacked_on))
3203
# stack_on_pwd is often/usually our transport
3206
stack_on_pwd = transport.relpath(stack_on_pwd)
3207
if not stack_on_pwd:
3209
except errors.PathNotChild:
3211
args.append(self._serialize_NoneString(stack_on_pwd))
3212
args.append(self._serialize_NoneString(repo_format_name))
3213
args.append(self._serialize_NoneTrueFalse(make_working_trees))
3214
args.append(self._serialize_NoneTrueFalse(shared_repo))
3215
if self._network_name is None:
3216
self._network_name = \
3217
BzrDirFormat.get_default_format().network_name()
3219
response = client.call('BzrDirFormat.initialize_ex_1.16',
3220
self.network_name(), path, *args)
3221
except errors.UnknownSmartMethod:
3222
client._medium._remember_remote_is_before((1,16))
3223
local_dir_format = BzrDirMetaFormat1()
3224
self._supply_sub_formats_to(local_dir_format)
3225
return local_dir_format.initialize_on_transport_ex(transport,
3226
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3227
force_new_repo=force_new_repo, stacked_on=stacked_on,
3228
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3229
make_working_trees=make_working_trees, shared_repo=shared_repo,
3231
except errors.ErrorFromSmartServer, err:
3232
remote._translate_error(err, path=path)
3233
repo_path = response[0]
3234
bzrdir_name = response[6]
3235
require_stacking = response[7]
3236
require_stacking = self.parse_NoneTrueFalse(require_stacking)
3237
format = RemoteBzrDirFormat()
3238
format._network_name = bzrdir_name
3239
self._supply_sub_formats_to(format)
3240
bzrdir = remote.RemoteBzrDir(transport, format, _client=client)
3242
repo_format = remote.response_tuple_to_repo_format(response[1:])
3243
if repo_path == '.':
3246
repo_bzrdir_format = RemoteBzrDirFormat()
3247
repo_bzrdir_format._network_name = response[5]
3248
repo_bzr = remote.RemoteBzrDir(transport.clone(repo_path),
3252
final_stack = response[8] or None
3253
final_stack_pwd = response[9] or None
3255
final_stack_pwd = urlutils.join(
3256
transport.base, final_stack_pwd)
3257
remote_repo = remote.RemoteRepository(repo_bzr, repo_format)
3258
if len(response) > 10:
3259
# Updated server verb that locks remotely.
3260
repo_lock_token = response[10] or None
3261
remote_repo.lock_write(repo_lock_token, _skip_rpc=True)
3263
remote_repo.dont_leave_lock_in_place()
3265
remote_repo.lock_write()
3266
policy = UseExistingRepository(remote_repo, final_stack,
3267
final_stack_pwd, require_stacking)
3268
policy.acquire_repository()
3272
bzrdir._format.set_branch_format(self.get_branch_format())
3273
if require_stacking:
3274
# The repo has already been created, but we need to make sure that
3275
# we'll make a stackable branch.
3276
bzrdir._format.require_stacking(_skip_repo=True)
3277
return remote_repo, bzrdir, require_stacking, policy
3279
def _open(self, transport):
3280
return remote.RemoteBzrDir(transport, self)
3282
def __eq__(self, other):
3283
if not isinstance(other, RemoteBzrDirFormat):
3285
return self.get_format_description() == other.get_format_description()
3287
def __return_repository_format(self):
3288
# Always return a RemoteRepositoryFormat object, but if a specific bzr
3289
# repository format has been asked for, tell the RemoteRepositoryFormat
3290
# that it should use that for init() etc.
3291
result = remote.RemoteRepositoryFormat()
3292
custom_format = getattr(self, '_repository_format', None)
3294
if isinstance(custom_format, remote.RemoteRepositoryFormat):
3295
return custom_format
3297
# We will use the custom format to create repositories over the
3298
# wire; expose its details like rich_root_data for code to
3300
result._custom_format = custom_format
3303
def get_branch_format(self):
3304
result = BzrDirMetaFormat1.get_branch_format(self)
3305
if not isinstance(result, remote.RemoteBranchFormat):
3306
new_result = remote.RemoteBranchFormat()
3307
new_result._custom_format = result
3309
self.set_branch_format(new_result)
3313
repository_format = property(__return_repository_format,
3314
BzrDirMetaFormat1._set_repository_format) #.im_func)
3317
BzrDirFormat.register_control_server_format(RemoteBzrDirFormat)
3320
class BzrDirFormatInfo(object):
3322
def __init__(self, native, deprecated, hidden, experimental):
3323
self.deprecated = deprecated
3324
self.native = native
3325
self.hidden = hidden
3326
self.experimental = experimental
3329
class BzrDirFormatRegistry(registry.Registry):
3330
"""Registry of user-selectable BzrDir subformats.
3332
Differs from BzrDirFormat._control_formats in that it provides sub-formats,
3333
e.g. BzrDirMeta1 with weave repository. Also, it's more user-oriented.
3337
"""Create a BzrDirFormatRegistry."""
3338
self._aliases = set()
3339
self._registration_order = list()
3340
super(BzrDirFormatRegistry, self).__init__()
3343
"""Return a set of the format names which are aliases."""
3344
return frozenset(self._aliases)
3346
def register_metadir(self, key,
3347
repository_format, help, native=True, deprecated=False,
3353
"""Register a metadir subformat.
3355
These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
3356
by the Repository/Branch/WorkingTreeformats.
3358
:param repository_format: The fully-qualified repository format class
3360
:param branch_format: Fully-qualified branch format class name as
3362
:param tree_format: Fully-qualified tree format class name as
3365
# This should be expanded to support setting WorkingTree and Branch
3366
# formats, once BzrDirMetaFormat1 supports that.
3367
def _load(full_name):
3368
mod_name, factory_name = full_name.rsplit('.', 1)
3370
mod = __import__(mod_name, globals(), locals(),
3372
except ImportError, e:
3373
raise ImportError('failed to load %s: %s' % (full_name, e))
3375
factory = getattr(mod, factory_name)
3376
except AttributeError:
3377
raise AttributeError('no factory %s in module %r'
3382
bd = BzrDirMetaFormat1()
3383
if branch_format is not None:
3384
bd.set_branch_format(_load(branch_format))
3385
if tree_format is not None:
3386
bd.workingtree_format = _load(tree_format)
3387
if repository_format is not None:
3388
bd.repository_format = _load(repository_format)
3390
self.register(key, helper, help, native, deprecated, hidden,
3391
experimental, alias)
3393
def register(self, key, factory, help, native=True, deprecated=False,
3394
hidden=False, experimental=False, alias=False):
3395
"""Register a BzrDirFormat factory.
3397
The factory must be a callable that takes one parameter: the key.
3398
It must produce an instance of the BzrDirFormat when called.
3400
This function mainly exists to prevent the info object from being
3403
registry.Registry.register(self, key, factory, help,
3404
BzrDirFormatInfo(native, deprecated, hidden, experimental))
3406
self._aliases.add(key)
3407
self._registration_order.append(key)
3409
def register_lazy(self, key, module_name, member_name, help, native=True,
3410
deprecated=False, hidden=False, experimental=False, alias=False):
3411
registry.Registry.register_lazy(self, key, module_name, member_name,
3412
help, BzrDirFormatInfo(native, deprecated, hidden, experimental))
3414
self._aliases.add(key)
3415
self._registration_order.append(key)
3417
def set_default(self, key):
3418
"""Set the 'default' key to be a clone of the supplied key.
3420
This method must be called once and only once.
3422
registry.Registry.register(self, 'default', self.get(key),
3423
self.get_help(key), info=self.get_info(key))
3424
self._aliases.add('default')
3426
def set_default_repository(self, key):
3427
"""Set the FormatRegistry default and Repository default.
3429
This is a transitional method while Repository.set_default_format
3432
if 'default' in self:
3433
self.remove('default')
3434
self.set_default(key)
3435
format = self.get('default')()
3437
def make_bzrdir(self, key):
3438
return self.get(key)()
3440
def help_topic(self, topic):
3442
default_realkey = None
3443
default_help = self.get_help('default')
3445
for key in self._registration_order:
3446
if key == 'default':
3448
help = self.get_help(key)
3449
if help == default_help:
3450
default_realkey = key
3452
help_pairs.append((key, help))
3454
def wrapped(key, help, info):
3456
help = '(native) ' + help
3457
return ':%s:\n%s\n\n' % (key,
3458
textwrap.fill(help, initial_indent=' ',
3459
subsequent_indent=' ',
3460
break_long_words=False))
3461
if default_realkey is not None:
3462
output += wrapped(default_realkey, '(default) %s' % default_help,
3463
self.get_info('default'))
3464
deprecated_pairs = []
3465
experimental_pairs = []
3466
for key, help in help_pairs:
3467
info = self.get_info(key)
3470
elif info.deprecated:
3471
deprecated_pairs.append((key, help))
3472
elif info.experimental:
3473
experimental_pairs.append((key, help))
3475
output += wrapped(key, help, info)
3476
output += "\nSee ``bzr help formats`` for more about storage formats."
3478
if len(experimental_pairs) > 0:
3479
other_output += "Experimental formats are shown below.\n\n"
3480
for key, help in experimental_pairs:
3481
info = self.get_info(key)
3482
other_output += wrapped(key, help, info)
3485
"No experimental formats are available.\n\n"
3486
if len(deprecated_pairs) > 0:
3487
other_output += "\nDeprecated formats are shown below.\n\n"
3488
for key, help in deprecated_pairs:
3489
info = self.get_info(key)
3490
other_output += wrapped(key, help, info)
3493
"\nNo deprecated formats are available.\n\n"
3495
"\nSee ``bzr help formats`` for more about storage formats."
3497
if topic == 'other-formats':
3503
class RepositoryAcquisitionPolicy(object):
3504
"""Abstract base class for repository acquisition policies.
3506
A repository acquisition policy decides how a BzrDir acquires a repository
3507
for a branch that is being created. The most basic policy decision is
3508
whether to create a new repository or use an existing one.
3510
def __init__(self, stack_on, stack_on_pwd, require_stacking):
3513
:param stack_on: A location to stack on
3514
:param stack_on_pwd: If stack_on is relative, the location it is
3516
:param require_stacking: If True, it is a failure to not stack.
3518
self._stack_on = stack_on
3519
self._stack_on_pwd = stack_on_pwd
3520
self._require_stacking = require_stacking
3522
def configure_branch(self, branch):
3523
"""Apply any configuration data from this policy to the branch.
3525
Default implementation sets repository stacking.
3527
if self._stack_on is None:
3529
if self._stack_on_pwd is None:
3530
stack_on = self._stack_on
3533
stack_on = urlutils.rebase_url(self._stack_on,
3535
branch.bzrdir.root_transport.base)
3536
except errors.InvalidRebaseURLs:
3537
stack_on = self._get_full_stack_on()
3539
branch.set_stacked_on_url(stack_on)
3540
except (errors.UnstackableBranchFormat,
3541
errors.UnstackableRepositoryFormat):
3542
if self._require_stacking:
3545
def _get_full_stack_on(self):
3546
"""Get a fully-qualified URL for the stack_on location."""
3547
if self._stack_on is None:
3549
if self._stack_on_pwd is None:
3550
return self._stack_on
3552
return urlutils.join(self._stack_on_pwd, self._stack_on)
3554
def _add_fallback(self, repository, possible_transports=None):
3555
"""Add a fallback to the supplied repository, if stacking is set."""
3556
stack_on = self._get_full_stack_on()
3557
if stack_on is None:
3560
stacked_dir = BzrDir.open(stack_on,
3561
possible_transports=possible_transports)
3562
except errors.JailBreak:
3563
# We keep the stacking details, but we are in the server code so
3564
# actually stacking is not needed.
3567
stacked_repo = stacked_dir.open_branch().repository
3568
except errors.NotBranchError:
3569
stacked_repo = stacked_dir.open_repository()
3571
repository.add_fallback_repository(stacked_repo)
3572
except errors.UnstackableRepositoryFormat:
3573
if self._require_stacking:
3576
self._require_stacking = True
3578
def acquire_repository(self, make_working_trees=None, shared=False):
3579
"""Acquire a repository for this bzrdir.
3581
Implementations may create a new repository or use a pre-exising
3583
:param make_working_trees: If creating a repository, set
3584
make_working_trees to this value (if non-None)
3585
:param shared: If creating a repository, make it shared if True
3586
:return: A repository, is_new_flag (True if the repository was
3589
raise NotImplemented(RepositoryAcquisitionPolicy.acquire_repository)
3592
class CreateRepository(RepositoryAcquisitionPolicy):
3593
"""A policy of creating a new repository"""
3595
def __init__(self, bzrdir, stack_on=None, stack_on_pwd=None,
3596
require_stacking=False):
3599
:param bzrdir: The bzrdir to create the repository on.
3600
:param stack_on: A location to stack on
3601
:param stack_on_pwd: If stack_on is relative, the location it is
3604
RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
3606
self._bzrdir = bzrdir
3608
def acquire_repository(self, make_working_trees=None, shared=False):
3609
"""Implementation of RepositoryAcquisitionPolicy.acquire_repository
3611
Creates the desired repository in the bzrdir we already have.
3613
stack_on = self._get_full_stack_on()
3615
format = self._bzrdir._format
3616
format.require_stacking(stack_on=stack_on,
3617
possible_transports=[self._bzrdir.root_transport])
3618
if not self._require_stacking:
3619
# We have picked up automatic stacking somewhere.
3620
note('Using default stacking branch %s at %s', self._stack_on,
3622
repository = self._bzrdir.create_repository(shared=shared)
3623
self._add_fallback(repository,
3624
possible_transports=[self._bzrdir.transport])
3625
if make_working_trees is not None:
3626
repository.set_make_working_trees(make_working_trees)
3627
return repository, True
3630
class UseExistingRepository(RepositoryAcquisitionPolicy):
3631
"""A policy of reusing an existing repository"""
3633
def __init__(self, repository, stack_on=None, stack_on_pwd=None,
3634
require_stacking=False):
3637
:param repository: The repository to use.
3638
:param stack_on: A location to stack on
3639
:param stack_on_pwd: If stack_on is relative, the location it is
3642
RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
3644
self._repository = repository
3646
def acquire_repository(self, make_working_trees=None, shared=False):
3647
"""Implementation of RepositoryAcquisitionPolicy.acquire_repository
3649
Returns an existing repository to use.
3651
self._add_fallback(self._repository,
3652
possible_transports=[self._repository.bzrdir.transport])
3653
return self._repository, False
3656
# Please register new formats after old formats so that formats
3657
# appear in chronological order and format descriptions can build
3659
format_registry = BzrDirFormatRegistry()
3660
# The pre-0.8 formats have their repository format network name registered in
3661
# repository.py. MetaDir formats have their repository format network name
3662
# inferred from their disk format string.
3663
format_registry.register('weave', BzrDirFormat6,
3664
'Pre-0.8 format. Slower than knit and does not'
3665
' support checkouts or shared repositories.',
3667
format_registry.register_metadir('metaweave',
3668
'bzrlib.repofmt.weaverepo.RepositoryFormat7',
3669
'Transitional format in 0.8. Slower than knit.',
3670
branch_format='bzrlib.branch.BzrBranchFormat5',
3671
tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3673
format_registry.register_metadir('knit',
3674
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3675
'Format using knits. Recommended for interoperation with bzr <= 0.14.',
3676
branch_format='bzrlib.branch.BzrBranchFormat5',
3677
tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3679
format_registry.register_metadir('dirstate',
3680
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3681
help='New in 0.15: Fast local operations. Compatible with bzr 0.8 and '
3682
'above when accessed over the network.',
3683
branch_format='bzrlib.branch.BzrBranchFormat5',
3684
# this uses bzrlib.workingtree.WorkingTreeFormat4 because importing
3685
# directly from workingtree_4 triggers a circular import.
3686
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3688
format_registry.register_metadir('dirstate-tags',
3689
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3690
help='New in 0.15: Fast local operations and improved scaling for '
3691
'network operations. Additionally adds support for tags.'
3692
' Incompatible with bzr < 0.15.',
3693
branch_format='bzrlib.branch.BzrBranchFormat6',
3694
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3696
format_registry.register_metadir('rich-root',
3697
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
3698
help='New in 1.0. Better handling of tree roots. Incompatible with'
3700
branch_format='bzrlib.branch.BzrBranchFormat6',
3701
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3703
format_registry.register_metadir('dirstate-with-subtree',
3704
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
3705
help='New in 0.15: Fast local operations and improved scaling for '
3706
'network operations. Additionally adds support for versioning nested '
3707
'bzr branches. Incompatible with bzr < 0.15.',
3708
branch_format='bzrlib.branch.BzrBranchFormat6',
3709
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3713
format_registry.register_metadir('pack-0.92',
3714
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack1',
3715
help='New in 0.92: Pack-based format with data compatible with '
3716
'dirstate-tags format repositories. Interoperates with '
3717
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3718
'Previously called knitpack-experimental. '
3719
'For more information, see '
3720
'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
3721
branch_format='bzrlib.branch.BzrBranchFormat6',
3722
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3724
format_registry.register_metadir('pack-0.92-subtree',
3725
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack3',
3726
help='New in 0.92: Pack-based format with data compatible with '
3727
'dirstate-with-subtree format repositories. Interoperates with '
3728
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3729
'Previously called knitpack-experimental. '
3730
'For more information, see '
3731
'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
3732
branch_format='bzrlib.branch.BzrBranchFormat6',
3733
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3737
format_registry.register_metadir('rich-root-pack',
3738
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
3739
help='New in 1.0: A variant of pack-0.92 that supports rich-root data '
3740
'(needed for bzr-svn and bzr-git).',
3741
branch_format='bzrlib.branch.BzrBranchFormat6',
3742
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3744
format_registry.register_metadir('1.6',
3745
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5',
3746
help='A format that allows a branch to indicate that there is another '
3747
'(stacked) repository that should be used to access data that is '
3748
'not present locally.',
3749
branch_format='bzrlib.branch.BzrBranchFormat7',
3750
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3752
format_registry.register_metadir('1.6.1-rich-root',
3753
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5RichRoot',
3754
help='A variant of 1.6 that supports rich-root data '
3755
'(needed for bzr-svn and bzr-git).',
3756
branch_format='bzrlib.branch.BzrBranchFormat7',
3757
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3759
format_registry.register_metadir('1.9',
3760
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3761
help='A repository format using B+tree indexes. These indexes '
3762
'are smaller in size, have smarter caching and provide faster '
3763
'performance for most operations.',
3764
branch_format='bzrlib.branch.BzrBranchFormat7',
3765
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3767
format_registry.register_metadir('1.9-rich-root',
3768
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
3769
help='A variant of 1.9 that supports rich-root data '
3770
'(needed for bzr-svn and bzr-git).',
3771
branch_format='bzrlib.branch.BzrBranchFormat7',
3772
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3774
format_registry.register_metadir('1.14',
3775
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3776
help='A working-tree format that supports content filtering.',
3777
branch_format='bzrlib.branch.BzrBranchFormat7',
3778
tree_format='bzrlib.workingtree.WorkingTreeFormat5',
3780
format_registry.register_metadir('1.14-rich-root',
3781
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
3782
help='A variant of 1.14 that supports rich-root data '
3783
'(needed for bzr-svn and bzr-git).',
3784
branch_format='bzrlib.branch.BzrBranchFormat7',
3785
tree_format='bzrlib.workingtree.WorkingTreeFormat5',
3787
# The following un-numbered 'development' formats should always just be aliases.
3788
format_registry.register_metadir('development-rich-root',
3789
'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
3790
help='Current development format. Supports rich roots. Can convert data '
3791
'to and from rich-root-pack (and anything compatible with '
3792
'rich-root-pack) format repositories. Repositories and branches in '
3793
'this format can only be read by bzr.dev. Please read '
3794
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3796
branch_format='bzrlib.branch.BzrBranchFormat7',
3797
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3801
format_registry.register_metadir('development-subtree',
3802
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment2Subtree',
3803
help='Current development format, subtree variant. Can convert data to and '
3804
'from pack-0.92-subtree (and anything compatible with '
3805
'pack-0.92-subtree) format repositories. Repositories and branches in '
3806
'this format can only be read by bzr.dev. Please read '
3807
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3809
branch_format='bzrlib.branch.BzrBranchFormat7',
3810
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3812
alias=False, # Restore to being an alias when an actual development subtree format is added
3813
# This current non-alias status is simply because we did not introduce a
3814
# chk based subtree format.
3817
# And the development formats above will have aliased one of the following:
3818
format_registry.register_metadir('development6-rich-root',
3819
'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
3820
help='pack-1.9 with 255-way hashed CHK inv, group compress, rich roots '
3822
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3824
branch_format='bzrlib.branch.BzrBranchFormat7',
3825
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3830
format_registry.register_metadir('development7-rich-root',
3831
'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK2',
3832
help='pack-1.9 with 255-way hashed CHK inv, bencode revision, group compress, '
3833
'rich roots. Please read '
3834
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3836
branch_format='bzrlib.branch.BzrBranchFormat7',
3837
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3842
format_registry.register_metadir('2a',
3843
'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
3844
help='First format for bzr 2.0 series.\n'
3845
'Uses group-compress storage.\n'
3846
'Provides rich roots which are a one-way transition.\n',
3847
# 'storage in packs, 255-way hashed CHK inventory, bencode revision, group compress, '
3848
# 'rich roots. Supported by bzr 1.16 and later.',
3849
branch_format='bzrlib.branch.BzrBranchFormat7',
3850
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3854
# The following format should be an alias for the rich root equivalent
3855
# of the default format
3856
format_registry.register_metadir('default-rich-root',
3857
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
3858
help='Default format, rich root variant. (needed for bzr-svn and bzr-git).',
3859
branch_format='bzrlib.branch.BzrBranchFormat6',
3860
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3863
# The current format that is made on 'bzr init'.
3864
format_registry.set_default('pack-0.92')
added
removed
bzrlib/bzrdir.py
