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 (
91
"""A .bzr control diretory.
93
BzrDir instances let you create or open any of the things that can be
94
found within .bzr - checkouts, branches and repositories.
97
the transport which this bzr dir is rooted at (i.e. file:///.../.bzr/)
99
a transport connected to the directory this bzr was opened from
100
(i.e. the parent directory holding the .bzr directory).
102
Everything in the bzrdir should have the same file permissions.
104
:cvar hooks: An instance of BzrDirHooks.
107
def break_lock(self):
108
"""Invoke break_lock on the first object in the bzrdir.
110
If there is a tree, the tree is opened and break_lock() called.
111
Otherwise, branch is tried, and finally repository.
113
# XXX: This seems more like a UI function than something that really
114
# belongs in this class.
116
thing_to_unlock = self.open_workingtree()
117
except (errors.NotLocalUrl, errors.NoWorkingTree):
119
thing_to_unlock = self.open_branch()
120
except errors.NotBranchError:
122
thing_to_unlock = self.open_repository()
123
except errors.NoRepositoryPresent:
125
thing_to_unlock.break_lock()
127
def can_convert_format(self):
128
"""Return true if this bzrdir is one whose format we can convert from."""
131
def check_conversion_target(self, target_format):
132
target_repo_format = target_format.repository_format
133
source_repo_format = self._format.repository_format
134
source_repo_format.check_conversion_target(target_repo_format)
137
def _check_supported(format, allow_unsupported,
138
recommend_upgrade=True,
140
"""Give an error or warning on old formats.
142
:param format: may be any kind of format - workingtree, branch,
145
:param allow_unsupported: If true, allow opening
146
formats that are strongly deprecated, and which may
147
have limited functionality.
149
:param recommend_upgrade: If true (default), warn
150
the user through the ui object that they may wish
151
to upgrade the object.
153
# TODO: perhaps move this into a base Format class; it's not BzrDir
154
# specific. mbp 20070323
155
if not allow_unsupported and not format.is_supported():
156
# see open_downlevel to open legacy branches.
157
raise errors.UnsupportedFormatError(format=format)
158
if recommend_upgrade \
159
and getattr(format, 'upgrade_recommended', False):
160
ui.ui_factory.recommend_upgrade(
161
format.get_format_description(),
164
def clone(self, url, revision_id=None, force_new_repo=False,
165
preserve_stacking=False):
166
"""Clone this bzrdir and its contents to url verbatim.
168
:param url: The url create the clone at. If url's last component does
169
not exist, it will be created.
170
:param revision_id: The tip revision-id to use for any branch or
171
working tree. If not None, then the clone operation may tune
172
itself to download less data.
173
:param force_new_repo: Do not use a shared repository for the target
174
even if one is available.
175
:param preserve_stacking: When cloning a stacked branch, stack the
176
new branch on top of the other branch's stacked-on branch.
178
return self.clone_on_transport(get_transport(url),
179
revision_id=revision_id,
180
force_new_repo=force_new_repo,
181
preserve_stacking=preserve_stacking)
183
def clone_on_transport(self, transport, revision_id=None,
184
force_new_repo=False, preserve_stacking=False, stacked_on=None,
185
create_prefix=False, use_existing_dir=True):
186
"""Clone this bzrdir and its contents to transport verbatim.
188
:param transport: The transport for the location to produce the clone
189
at. If the target directory does not exist, it will be created.
190
:param revision_id: The tip revision-id to use for any branch or
191
working tree. If not None, then the clone operation may tune
192
itself to download less data.
193
:param force_new_repo: Do not use a shared repository for the target,
194
even if one is available.
195
:param preserve_stacking: When cloning a stacked branch, stack the
196
new branch on top of the other branch's stacked-on branch.
197
:param create_prefix: Create any missing directories leading up to
199
:param use_existing_dir: Use an existing directory if one exists.
201
# Overview: put together a broad description of what we want to end up
202
# with; then make as few api calls as possible to do it.
204
# We may want to create a repo/branch/tree, if we do so what format
205
# would we want for each:
206
require_stacking = (stacked_on is not None)
207
format = self.cloning_metadir(require_stacking)
209
# Figure out what objects we want:
211
local_repo = self.find_repository()
212
except errors.NoRepositoryPresent:
215
local_branch = self.open_branch()
216
except errors.NotBranchError:
219
# enable fallbacks when branch is not a branch reference
220
if local_branch.repository.has_same_location(local_repo):
221
local_repo = local_branch.repository
222
if preserve_stacking:
224
stacked_on = local_branch.get_stacked_on_url()
225
except (errors.UnstackableBranchFormat,
226
errors.UnstackableRepositoryFormat,
229
# Bug: We create a metadir without knowing if it can support stacking,
230
# we should look up the policy needs first, or just use it as a hint,
233
make_working_trees = local_repo.make_working_trees()
234
want_shared = local_repo.is_shared()
235
repo_format_name = format.repository_format.network_name()
237
make_working_trees = False
239
repo_format_name = None
241
result_repo, result, require_stacking, repository_policy = \
242
format.initialize_on_transport_ex(transport,
243
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
244
force_new_repo=force_new_repo, stacked_on=stacked_on,
245
stack_on_pwd=self.root_transport.base,
246
repo_format_name=repo_format_name,
247
make_working_trees=make_working_trees, shared_repo=want_shared)
250
# If the result repository is in the same place as the
251
# resulting bzr dir, it will have no content, further if the
252
# result is not stacked then we know all content should be
253
# copied, and finally if we are copying up to a specific
254
# revision_id then we can use the pending-ancestry-result which
255
# does not require traversing all of history to describe it.
256
if (result_repo.bzrdir.root_transport.base ==
257
result.root_transport.base and not require_stacking and
258
revision_id is not None):
259
fetch_spec = graph.PendingAncestryResult(
260
[revision_id], local_repo)
261
result_repo.fetch(local_repo, fetch_spec=fetch_spec)
263
result_repo.fetch(local_repo, revision_id=revision_id)
267
if result_repo is not None:
268
raise AssertionError('result_repo not None(%r)' % result_repo)
269
# 1 if there is a branch present
270
# make sure its content is available in the target repository
272
if local_branch is not None:
273
result_branch = local_branch.clone(result, revision_id=revision_id,
274
repository_policy=repository_policy)
276
# Cheaper to check if the target is not local, than to try making
278
result.root_transport.local_abspath('.')
279
if result_repo is None or result_repo.make_working_trees():
280
self.open_workingtree().clone(result)
281
except (errors.NoWorkingTree, errors.NotLocalUrl):
285
# TODO: This should be given a Transport, and should chdir up; otherwise
286
# this will open a new connection.
287
def _make_tail(self, url):
288
t = get_transport(url)
292
def create(cls, base, format=None, possible_transports=None):
293
"""Create a new BzrDir at the url 'base'.
295
:param format: If supplied, the format of branch to create. If not
296
supplied, the default is used.
297
:param possible_transports: If supplied, a list of transports that
298
can be reused to share a remote connection.
300
if cls is not BzrDir:
301
raise AssertionError("BzrDir.create always creates the default"
302
" format, not one of %r" % cls)
303
t = get_transport(base, possible_transports)
306
format = BzrDirFormat.get_default_format()
307
return format.initialize_on_transport(t)
310
def find_bzrdirs(transport, evaluate=None, list_current=None):
311
"""Find bzrdirs recursively from current location.
313
This is intended primarily as a building block for more sophisticated
314
functionality, like finding trees under a directory, or finding
315
branches that use a given repository.
316
:param evaluate: An optional callable that yields recurse, value,
317
where recurse controls whether this bzrdir is recursed into
318
and value is the value to yield. By default, all bzrdirs
319
are recursed into, and the return value is the bzrdir.
320
:param list_current: if supplied, use this function to list the current
321
directory, instead of Transport.list_dir
322
:return: a generator of found bzrdirs, or whatever evaluate returns.
324
if list_current is None:
325
def list_current(transport):
326
return transport.list_dir('')
328
def evaluate(bzrdir):
331
pending = [transport]
332
while len(pending) > 0:
333
current_transport = pending.pop()
336
bzrdir = BzrDir.open_from_transport(current_transport)
337
except errors.NotBranchError:
340
recurse, value = evaluate(bzrdir)
343
subdirs = list_current(current_transport)
344
except errors.NoSuchFile:
347
for subdir in sorted(subdirs, reverse=True):
348
pending.append(current_transport.clone(subdir))
351
def find_branches(transport):
352
"""Find all branches under a transport.
354
This will find all branches below the transport, including branches
355
inside other branches. Where possible, it will use
356
Repository.find_branches.
358
To list all the branches that use a particular Repository, see
359
Repository.find_branches
361
def evaluate(bzrdir):
363
repository = bzrdir.open_repository()
364
except errors.NoRepositoryPresent:
367
return False, (None, repository)
369
branch = bzrdir.open_branch()
370
except errors.NotBranchError:
371
return True, (None, None)
373
return True, (branch, None)
375
for branch, repo in BzrDir.find_bzrdirs(transport, evaluate=evaluate):
377
branches.extend(repo.find_branches())
378
if branch is not None:
379
branches.append(branch)
382
def destroy_repository(self):
383
"""Destroy the repository in this BzrDir"""
384
raise NotImplementedError(self.destroy_repository)
386
def create_branch(self):
387
"""Create a branch in this BzrDir.
389
The bzrdir's format will control what branch format is created.
390
For more control see BranchFormatXX.create(a_bzrdir).
392
raise NotImplementedError(self.create_branch)
394
def destroy_branch(self):
395
"""Destroy the branch in this BzrDir"""
396
raise NotImplementedError(self.destroy_branch)
399
def create_branch_and_repo(base, force_new_repo=False, format=None):
400
"""Create a new BzrDir, Branch and Repository at the url 'base'.
402
This will use the current default BzrDirFormat unless one is
403
specified, and use whatever
404
repository format that that uses via bzrdir.create_branch and
405
create_repository. If a shared repository is available that is used
408
The created Branch object is returned.
410
:param base: The URL to create the branch at.
411
:param force_new_repo: If True a new repository is always created.
412
:param format: If supplied, the format of branch to create. If not
413
supplied, the default is used.
415
bzrdir = BzrDir.create(base, format)
416
bzrdir._find_or_create_repository(force_new_repo)
417
return bzrdir.create_branch()
419
def determine_repository_policy(self, force_new_repo=False, stack_on=None,
420
stack_on_pwd=None, require_stacking=False):
421
"""Return an object representing a policy to use.
423
This controls whether a new repository is created, and the format of
424
that repository, or some existing shared repository used instead.
426
If stack_on is supplied, will not seek a containing shared repo.
428
:param force_new_repo: If True, require a new repository to be created.
429
:param stack_on: If supplied, the location to stack on. If not
430
supplied, a default_stack_on location may be used.
431
:param stack_on_pwd: If stack_on is relative, the location it is
434
def repository_policy(found_bzrdir):
437
config = found_bzrdir.get_config()
439
stack_on = config.get_default_stack_on()
440
if stack_on is not None:
441
stack_on_pwd = found_bzrdir.root_transport.base
443
# does it have a repository ?
445
repository = found_bzrdir.open_repository()
446
except errors.NoRepositoryPresent:
449
if ((found_bzrdir.root_transport.base !=
450
self.root_transport.base) and not repository.is_shared()):
451
# Don't look higher, can't use a higher shared repo.
459
return UseExistingRepository(repository, stack_on,
460
stack_on_pwd, require_stacking=require_stacking), True
462
return CreateRepository(self, stack_on, stack_on_pwd,
463
require_stacking=require_stacking), True
465
if not force_new_repo:
467
policy = self._find_containing(repository_policy)
468
if policy is not None:
472
return UseExistingRepository(self.open_repository(),
473
stack_on, stack_on_pwd,
474
require_stacking=require_stacking)
475
except errors.NoRepositoryPresent:
477
return CreateRepository(self, stack_on, stack_on_pwd,
478
require_stacking=require_stacking)
480
def _find_or_create_repository(self, force_new_repo):
481
"""Create a new repository if needed, returning the repository."""
482
policy = self.determine_repository_policy(force_new_repo)
483
return policy.acquire_repository()[0]
486
def create_branch_convenience(base, force_new_repo=False,
487
force_new_tree=None, format=None,
488
possible_transports=None):
489
"""Create a new BzrDir, Branch and Repository at the url 'base'.
491
This is a convenience function - it will use an existing repository
492
if possible, can be told explicitly whether to create a working tree or
495
This will use the current default BzrDirFormat unless one is
496
specified, and use whatever
497
repository format that that uses via bzrdir.create_branch and
498
create_repository. If a shared repository is available that is used
499
preferentially. Whatever repository is used, its tree creation policy
502
The created Branch object is returned.
503
If a working tree cannot be made due to base not being a file:// url,
504
no error is raised unless force_new_tree is True, in which case no
505
data is created on disk and NotLocalUrl is raised.
507
:param base: The URL to create the branch at.
508
:param force_new_repo: If True a new repository is always created.
509
:param force_new_tree: If True or False force creation of a tree or
510
prevent such creation respectively.
511
:param format: Override for the bzrdir format to create.
512
:param possible_transports: An optional reusable transports list.
515
# check for non local urls
516
t = get_transport(base, possible_transports)
517
if not isinstance(t, local.LocalTransport):
518
raise errors.NotLocalUrl(base)
519
bzrdir = BzrDir.create(base, format, possible_transports)
520
repo = bzrdir._find_or_create_repository(force_new_repo)
521
result = bzrdir.create_branch()
522
if force_new_tree or (repo.make_working_trees() and
523
force_new_tree is None):
525
bzrdir.create_workingtree()
526
except errors.NotLocalUrl:
531
def create_standalone_workingtree(base, format=None):
532
"""Create a new BzrDir, WorkingTree, Branch and Repository at 'base'.
534
'base' must be a local path or a file:// url.
536
This will use the current default BzrDirFormat unless one is
537
specified, and use whatever
538
repository format that that uses for bzrdirformat.create_workingtree,
539
create_branch and create_repository.
541
:param format: Override for the bzrdir format to create.
542
:return: The WorkingTree object.
544
t = get_transport(base)
545
if not isinstance(t, local.LocalTransport):
546
raise errors.NotLocalUrl(base)
547
bzrdir = BzrDir.create_branch_and_repo(base,
549
format=format).bzrdir
550
return bzrdir.create_workingtree()
552
def create_workingtree(self, revision_id=None, from_branch=None,
553
accelerator_tree=None, hardlink=False):
554
"""Create a working tree at this BzrDir.
556
:param revision_id: create it as of this revision id.
557
:param from_branch: override bzrdir branch (for lightweight checkouts)
558
:param accelerator_tree: A tree which can be used for retrieving file
559
contents more quickly than the revision tree, i.e. a workingtree.
560
The revision tree will be used for cases where accelerator_tree's
561
content is different.
563
raise NotImplementedError(self.create_workingtree)
565
def backup_bzrdir(self):
566
"""Backup this bzr control directory.
568
:return: Tuple with old path name and new path name
570
pb = ui.ui_factory.nested_progress_bar()
572
# FIXME: bug 300001 -- the backup fails if the backup directory
573
# already exists, but it should instead either remove it or make
574
# a new backup directory.
576
# FIXME: bug 262450 -- the backup directory should have the same
577
# permissions as the .bzr directory (probably a bug in copy_tree)
578
old_path = self.root_transport.abspath('.bzr')
579
new_path = self.root_transport.abspath('backup.bzr')
580
pb.note('making backup of %s' % (old_path,))
581
pb.note(' to %s' % (new_path,))
582
self.root_transport.copy_tree('.bzr', 'backup.bzr')
583
return (old_path, new_path)
587
def retire_bzrdir(self, limit=10000):
588
"""Permanently disable the bzrdir.
590
This is done by renaming it to give the user some ability to recover
591
if there was a problem.
593
This will have horrible consequences if anyone has anything locked or
595
:param limit: number of times to retry
600
to_path = '.bzr.retired.%d' % i
601
self.root_transport.rename('.bzr', to_path)
602
note("renamed %s to %s"
603
% (self.root_transport.abspath('.bzr'), to_path))
605
except (errors.TransportError, IOError, errors.PathError):
612
def destroy_workingtree(self):
613
"""Destroy the working tree at this BzrDir.
615
Formats that do not support this may raise UnsupportedOperation.
617
raise NotImplementedError(self.destroy_workingtree)
619
def destroy_workingtree_metadata(self):
620
"""Destroy the control files for the working tree at this BzrDir.
622
The contents of working tree files are not affected.
623
Formats that do not support this may raise UnsupportedOperation.
625
raise NotImplementedError(self.destroy_workingtree_metadata)
627
def _find_containing(self, evaluate):
628
"""Find something in a containing control directory.
630
This method will scan containing control dirs, until it finds what
631
it is looking for, decides that it will never find it, or runs out
632
of containing control directories to check.
634
It is used to implement find_repository and
635
determine_repository_policy.
637
:param evaluate: A function returning (value, stop). If stop is True,
638
the value will be returned.
642
result, stop = evaluate(found_bzrdir)
645
next_transport = found_bzrdir.root_transport.clone('..')
646
if (found_bzrdir.root_transport.base == next_transport.base):
647
# top of the file system
649
# find the next containing bzrdir
651
found_bzrdir = BzrDir.open_containing_from_transport(
653
except errors.NotBranchError:
656
def find_repository(self):
657
"""Find the repository that should be used.
659
This does not require a branch as we use it to find the repo for
660
new branches as well as to hook existing branches up to their
663
def usable_repository(found_bzrdir):
664
# does it have a repository ?
666
repository = found_bzrdir.open_repository()
667
except errors.NoRepositoryPresent:
669
if found_bzrdir.root_transport.base == self.root_transport.base:
670
return repository, True
671
elif repository.is_shared():
672
return repository, True
676
found_repo = self._find_containing(usable_repository)
677
if found_repo is None:
678
raise errors.NoRepositoryPresent(self)
681
def get_branch_reference(self):
682
"""Return the referenced URL for the branch in this bzrdir.
684
:raises NotBranchError: If there is no Branch.
685
:return: The URL the branch in this bzrdir references if it is a
686
reference branch, or None for regular branches.
690
def get_branch_transport(self, branch_format):
691
"""Get the transport for use by branch format in this BzrDir.
693
Note that bzr dirs that do not support format strings will raise
694
IncompatibleFormat if the branch format they are given has
695
a format string, and vice versa.
697
If branch_format is None, the transport is returned with no
698
checking. If it is not None, then the returned transport is
699
guaranteed to point to an existing directory ready for use.
701
raise NotImplementedError(self.get_branch_transport)
703
def _find_creation_modes(self):
704
"""Determine the appropriate modes for files and directories.
706
They're always set to be consistent with the base directory,
707
assuming that this transport allows setting modes.
709
# TODO: Do we need or want an option (maybe a config setting) to turn
710
# this off or override it for particular locations? -- mbp 20080512
711
if self._mode_check_done:
713
self._mode_check_done = True
715
st = self.transport.stat('.')
716
except errors.TransportNotPossible:
717
self._dir_mode = None
718
self._file_mode = None
720
# Check the directory mode, but also make sure the created
721
# directories and files are read-write for this user. This is
722
# mostly a workaround for filesystems which lie about being able to
723
# write to a directory (cygwin & win32)
724
if (st.st_mode & 07777 == 00000):
725
# FTP allows stat but does not return dir/file modes
726
self._dir_mode = None
727
self._file_mode = None
729
self._dir_mode = (st.st_mode & 07777) | 00700
730
# Remove the sticky and execute bits for files
731
self._file_mode = self._dir_mode & ~07111
733
def _get_file_mode(self):
734
"""Return Unix mode for newly created files, or None.
736
if not self._mode_check_done:
737
self._find_creation_modes()
738
return self._file_mode
740
def _get_dir_mode(self):
741
"""Return Unix mode for newly created directories, or None.
743
if not self._mode_check_done:
744
self._find_creation_modes()
745
return self._dir_mode
747
def get_repository_transport(self, repository_format):
748
"""Get the transport for use by repository format in this BzrDir.
750
Note that bzr dirs that do not support format strings will raise
751
IncompatibleFormat if the repository format they are given has
752
a format string, and vice versa.
754
If repository_format is None, the transport is returned with no
755
checking. If it is not None, then the returned transport is
756
guaranteed to point to an existing directory ready for use.
758
raise NotImplementedError(self.get_repository_transport)
760
def get_workingtree_transport(self, tree_format):
761
"""Get the transport for use by workingtree format in this BzrDir.
763
Note that bzr dirs that do not support format strings will raise
764
IncompatibleFormat if the workingtree format they are given has a
765
format string, and vice versa.
767
If workingtree_format is None, the transport is returned with no
768
checking. If it is not None, then the returned transport is
769
guaranteed to point to an existing directory ready for use.
771
raise NotImplementedError(self.get_workingtree_transport)
773
def get_config(self):
774
"""Get configuration for this BzrDir."""
775
return config.BzrDirConfig(self)
777
def _get_config(self):
778
"""By default, no configuration is available."""
781
def __init__(self, _transport, _format):
782
"""Initialize a Bzr control dir object.
784
Only really common logic should reside here, concrete classes should be
785
made with varying behaviours.
787
:param _format: the format that is creating this BzrDir instance.
788
:param _transport: the transport this dir is based at.
790
self._format = _format
791
self.transport = _transport.clone('.bzr')
792
self.root_transport = _transport
793
self._mode_check_done = False
795
def is_control_filename(self, filename):
796
"""True if filename is the name of a path which is reserved for bzrdir's.
798
:param filename: A filename within the root transport of this bzrdir.
800
This is true IF and ONLY IF the filename is part of the namespace reserved
801
for bzr control dirs. Currently this is the '.bzr' directory in the root
802
of the root_transport. it is expected that plugins will need to extend
803
this in the future - for instance to make bzr talk with svn working
806
# this might be better on the BzrDirFormat class because it refers to
807
# all the possible bzrdir disk formats.
808
# This method is tested via the workingtree is_control_filename tests-
809
# it was extracted from WorkingTree.is_control_filename. If the method's
810
# contract is extended beyond the current trivial implementation, please
811
# add new tests for it to the appropriate place.
812
return filename == '.bzr' or filename.startswith('.bzr/')
814
def needs_format_conversion(self, format=None):
815
"""Return true if this bzrdir needs convert_format run on it.
817
For instance, if the repository format is out of date but the
818
branch and working tree are not, this should return True.
820
:param format: Optional parameter indicating a specific desired
821
format we plan to arrive at.
823
raise NotImplementedError(self.needs_format_conversion)
826
def open_unsupported(base):
827
"""Open a branch which is not supported."""
828
return BzrDir.open(base, _unsupported=True)
831
def open(base, _unsupported=False, possible_transports=None):
832
"""Open an existing bzrdir, rooted at 'base' (url).
834
:param _unsupported: a private parameter to the BzrDir class.
836
t = get_transport(base, possible_transports=possible_transports)
837
return BzrDir.open_from_transport(t, _unsupported=_unsupported)
840
def open_from_transport(transport, _unsupported=False,
841
_server_formats=True):
842
"""Open a bzrdir within a particular directory.
844
:param transport: Transport containing the bzrdir.
845
:param _unsupported: private.
847
for hook in BzrDir.hooks['pre_open']:
849
# Keep initial base since 'transport' may be modified while following
851
base = transport.base
852
def find_format(transport):
853
return transport, BzrDirFormat.find_format(
854
transport, _server_formats=_server_formats)
856
def redirected(transport, e, redirection_notice):
857
redirected_transport = transport._redirected_to(e.source, e.target)
858
if redirected_transport is None:
859
raise errors.NotBranchError(base)
860
note('%s is%s redirected to %s',
861
transport.base, e.permanently, redirected_transport.base)
862
return redirected_transport
865
transport, format = do_catching_redirections(find_format,
868
except errors.TooManyRedirections:
869
raise errors.NotBranchError(base)
871
BzrDir._check_supported(format, _unsupported)
872
return format.open(transport, _found=True)
874
def open_branch(self, unsupported=False, ignore_fallbacks=False):
875
"""Open the branch object at this BzrDir if one is present.
877
If unsupported is True, then no longer supported branch formats can
880
TODO: static convenience version of this?
882
raise NotImplementedError(self.open_branch)
885
def open_containing(url, possible_transports=None):
886
"""Open an existing branch which contains url.
888
:param url: url to search from.
889
See open_containing_from_transport for more detail.
891
transport = get_transport(url, possible_transports)
892
return BzrDir.open_containing_from_transport(transport)
895
def open_containing_from_transport(a_transport):
896
"""Open an existing branch which contains a_transport.base.
898
This probes for a branch at a_transport, and searches upwards from there.
900
Basically we keep looking up until we find the control directory or
901
run into the root. If there isn't one, raises NotBranchError.
902
If there is one and it is either an unrecognised format or an unsupported
903
format, UnknownFormatError or UnsupportedFormatError are raised.
904
If there is one, it is returned, along with the unused portion of url.
906
:return: The BzrDir that contains the path, and a Unicode path
907
for the rest of the URL.
909
# this gets the normalised url back. I.e. '.' -> the full path.
910
url = a_transport.base
913
result = BzrDir.open_from_transport(a_transport)
914
return result, urlutils.unescape(a_transport.relpath(url))
915
except errors.NotBranchError, e:
918
new_t = a_transport.clone('..')
919
except errors.InvalidURLJoin:
920
# reached the root, whatever that may be
921
raise errors.NotBranchError(path=url)
922
if new_t.base == a_transport.base:
923
# reached the root, whatever that may be
924
raise errors.NotBranchError(path=url)
927
def _get_tree_branch(self):
928
"""Return the branch and tree, if any, for this bzrdir.
930
Return None for tree if not present or inaccessible.
931
Raise NotBranchError if no branch is present.
932
:return: (tree, branch)
935
tree = self.open_workingtree()
936
except (errors.NoWorkingTree, errors.NotLocalUrl):
938
branch = self.open_branch()
944
def open_tree_or_branch(klass, location):
945
"""Return the branch and working tree at a location.
947
If there is no tree at the location, tree will be None.
948
If there is no branch at the location, an exception will be
950
:return: (tree, branch)
952
bzrdir = klass.open(location)
953
return bzrdir._get_tree_branch()
956
def open_containing_tree_or_branch(klass, location):
957
"""Return the branch and working tree contained by a location.
959
Returns (tree, branch, relpath).
960
If there is no tree at containing the location, tree will be None.
961
If there is no branch containing the location, an exception will be
963
relpath is the portion of the path that is contained by the branch.
965
bzrdir, relpath = klass.open_containing(location)
966
tree, branch = bzrdir._get_tree_branch()
967
return tree, branch, relpath
970
def open_containing_tree_branch_or_repository(klass, location):
971
"""Return the working tree, branch and repo contained by a location.
973
Returns (tree, branch, repository, relpath).
974
If there is no tree containing the location, tree will be None.
975
If there is no branch containing the location, branch will be None.
976
If there is no repository containing the location, repository will be
978
relpath is the portion of the path that is contained by the innermost
981
If no tree, branch or repository is found, a NotBranchError is raised.
983
bzrdir, relpath = klass.open_containing(location)
985
tree, branch = bzrdir._get_tree_branch()
986
except errors.NotBranchError:
988
repo = bzrdir.find_repository()
989
return None, None, repo, relpath
990
except (errors.NoRepositoryPresent):
991
raise errors.NotBranchError(location)
992
return tree, branch, branch.repository, relpath
994
def open_repository(self, _unsupported=False):
995
"""Open the repository object at this BzrDir if one is present.
997
This will not follow the Branch object pointer - it's strictly a direct
998
open facility. Most client code should use open_branch().repository to
1001
:param _unsupported: a private parameter, not part of the api.
1002
TODO: static convenience version of this?
1004
raise NotImplementedError(self.open_repository)
1006
def open_workingtree(self, _unsupported=False,
1007
recommend_upgrade=True, from_branch=None):
1008
"""Open the workingtree object at this BzrDir if one is present.
1010
:param recommend_upgrade: Optional keyword parameter, when True (the
1011
default), emit through the ui module a recommendation that the user
1012
upgrade the working tree when the workingtree being opened is old
1013
(but still fully supported).
1014
:param from_branch: override bzrdir branch (for lightweight checkouts)
1016
raise NotImplementedError(self.open_workingtree)
1018
def has_branch(self):
1019
"""Tell if this bzrdir contains a branch.
1021
Note: if you're going to open the branch, you should just go ahead
1022
and try, and not ask permission first. (This method just opens the
1023
branch and discards it, and that's somewhat expensive.)
1028
except errors.NotBranchError:
1031
def has_workingtree(self):
1032
"""Tell if this bzrdir contains a working tree.
1034
This will still raise an exception if the bzrdir has a workingtree that
1035
is remote & inaccessible.
1037
Note: if you're going to open the working tree, you should just go ahead
1038
and try, and not ask permission first. (This method just opens the
1039
workingtree and discards it, and that's somewhat expensive.)
1042
self.open_workingtree(recommend_upgrade=False)
1044
except errors.NoWorkingTree:
1047
def _cloning_metadir(self):
1048
"""Produce a metadir suitable for cloning with.
1050
:returns: (destination_bzrdir_format, source_repository)
1052
result_format = self._format.__class__()
1055
branch = self.open_branch(ignore_fallbacks=True)
1056
source_repository = branch.repository
1057
result_format._branch_format = branch._format
1058
except errors.NotBranchError:
1059
source_branch = None
1060
source_repository = self.open_repository()
1061
except errors.NoRepositoryPresent:
1062
source_repository = None
1064
# XXX TODO: This isinstance is here because we have not implemented
1065
# the fix recommended in bug # 103195 - to delegate this choice the
1066
# repository itself.
1067
repo_format = source_repository._format
1068
if isinstance(repo_format, remote.RemoteRepositoryFormat):
1069
source_repository._ensure_real()
1070
repo_format = source_repository._real_repository._format
1071
result_format.repository_format = repo_format
1073
# TODO: Couldn't we just probe for the format in these cases,
1074
# rather than opening the whole tree? It would be a little
1075
# faster. mbp 20070401
1076
tree = self.open_workingtree(recommend_upgrade=False)
1077
except (errors.NoWorkingTree, errors.NotLocalUrl):
1078
result_format.workingtree_format = None
1080
result_format.workingtree_format = tree._format.__class__()
1081
return result_format, source_repository
1083
def cloning_metadir(self, require_stacking=False):
1084
"""Produce a metadir suitable for cloning or sprouting with.
1086
These operations may produce workingtrees (yes, even though they're
1087
"cloning" something that doesn't have a tree), so a viable workingtree
1088
format must be selected.
1090
:require_stacking: If True, non-stackable formats will be upgraded
1091
to similar stackable formats.
1092
:returns: a BzrDirFormat with all component formats either set
1093
appropriately or set to None if that component should not be
1096
format, repository = self._cloning_metadir()
1097
if format._workingtree_format is None:
1099
if repository is None:
1100
# No repository either
1102
# We have a repository, so set a working tree? (Why? This seems to
1103
# contradict the stated return value in the docstring).
1104
tree_format = repository._format._matchingbzrdir.workingtree_format
1105
format.workingtree_format = tree_format.__class__()
1106
if require_stacking:
1107
format.require_stacking()
1110
def checkout_metadir(self):
1111
return self.cloning_metadir()
1113
def sprout(self, url, revision_id=None, force_new_repo=False,
1114
recurse='down', possible_transports=None,
1115
accelerator_tree=None, hardlink=False, stacked=False,
1116
source_branch=None, create_tree_if_local=True):
1117
"""Create a copy of this bzrdir prepared for use as a new line of
1120
If url's last component does not exist, it will be created.
1122
Attributes related to the identity of the source branch like
1123
branch nickname will be cleaned, a working tree is created
1124
whether one existed before or not; and a local branch is always
1127
if revision_id is not None, then the clone operation may tune
1128
itself to download less data.
1129
:param accelerator_tree: A tree which can be used for retrieving file
1130
contents more quickly than the revision tree, i.e. a workingtree.
1131
The revision tree will be used for cases where accelerator_tree's
1132
content is different.
1133
:param hardlink: If true, hard-link files from accelerator_tree,
1135
:param stacked: If true, create a stacked branch referring to the
1136
location of this control directory.
1137
:param create_tree_if_local: If true, a working-tree will be created
1138
when working locally.
1140
target_transport = get_transport(url, possible_transports)
1141
target_transport.ensure_base()
1142
cloning_format = self.cloning_metadir(stacked)
1143
# Create/update the result branch
1144
result = cloning_format.initialize_on_transport(target_transport)
1145
# if a stacked branch wasn't requested, we don't create one
1146
# even if the origin was stacked
1147
stacked_branch_url = None
1148
if source_branch is not None:
1150
stacked_branch_url = self.root_transport.base
1151
source_repository = source_branch.repository
1154
source_branch = self.open_branch()
1155
source_repository = source_branch.repository
1157
stacked_branch_url = self.root_transport.base
1158
except errors.NotBranchError:
1159
source_branch = None
1161
source_repository = self.open_repository()
1162
except errors.NoRepositoryPresent:
1163
source_repository = None
1164
repository_policy = result.determine_repository_policy(
1165
force_new_repo, stacked_branch_url, require_stacking=stacked)
1166
result_repo, is_new_repo = repository_policy.acquire_repository()
1167
if is_new_repo and revision_id is not None and not stacked:
1168
fetch_spec = graph.PendingAncestryResult(
1169
[revision_id], source_repository)
1172
if source_repository is not None:
1173
# Fetch while stacked to prevent unstacked fetch from
1175
if fetch_spec is None:
1176
result_repo.fetch(source_repository, revision_id=revision_id)
1178
result_repo.fetch(source_repository, fetch_spec=fetch_spec)
1180
if source_branch is None:
1181
# this is for sprouting a bzrdir without a branch; is that
1183
# Not especially, but it's part of the contract.
1184
result_branch = result.create_branch()
1186
result_branch = source_branch.sprout(result,
1187
revision_id=revision_id, repository_policy=repository_policy)
1188
mutter("created new branch %r" % (result_branch,))
1190
# Create/update the result working tree
1191
if (create_tree_if_local and
1192
isinstance(target_transport, local.LocalTransport) and
1193
(result_repo is None or result_repo.make_working_trees())):
1194
wt = result.create_workingtree(accelerator_tree=accelerator_tree,
1198
if wt.path2id('') is None:
1200
wt.set_root_id(self.open_workingtree.get_root_id())
1201
except errors.NoWorkingTree:
1207
if recurse == 'down':
1209
basis = wt.basis_tree()
1211
subtrees = basis.iter_references()
1212
elif result_branch is not None:
1213
basis = result_branch.basis_tree()
1215
subtrees = basis.iter_references()
1216
elif source_branch is not None:
1217
basis = source_branch.basis_tree()
1219
subtrees = basis.iter_references()
1224
for path, file_id in subtrees:
1225
target = urlutils.join(url, urlutils.escape(path))
1226
sublocation = source_branch.reference_parent(file_id, path)
1227
sublocation.bzrdir.sprout(target,
1228
basis.get_reference_revision(file_id, path),
1229
force_new_repo=force_new_repo, recurse=recurse,
1232
if basis is not None:
1236
def push_branch(self, source, revision_id=None, overwrite=False,
1237
remember=False, create_prefix=False):
1238
"""Push the source branch into this BzrDir."""
1240
# If we can open a branch, use its direct repository, otherwise see
1241
# if there is a repository without a branch.
1243
br_to = self.open_branch()
1244
except errors.NotBranchError:
1245
# Didn't find a branch, can we find a repository?
1246
repository_to = self.find_repository()
1248
# Found a branch, so we must have found a repository
1249
repository_to = br_to.repository
1251
push_result = PushResult()
1252
push_result.source_branch = source
1254
# We have a repository but no branch, copy the revisions, and then
1256
repository_to.fetch(source.repository, revision_id=revision_id)
1257
br_to = source.clone(self, revision_id=revision_id)
1258
if source.get_push_location() is None or remember:
1259
source.set_push_location(br_to.base)
1260
push_result.stacked_on = None
1261
push_result.branch_push_result = None
1262
push_result.old_revno = None
1263
push_result.old_revid = _mod_revision.NULL_REVISION
1264
push_result.target_branch = br_to
1265
push_result.master_branch = None
1266
push_result.workingtree_updated = False
1268
# We have successfully opened the branch, remember if necessary:
1269
if source.get_push_location() is None or remember:
1270
source.set_push_location(br_to.base)
1272
tree_to = self.open_workingtree()
1273
except errors.NotLocalUrl:
1274
push_result.branch_push_result = source.push(br_to,
1275
overwrite, stop_revision=revision_id)
1276
push_result.workingtree_updated = False
1277
except errors.NoWorkingTree:
1278
push_result.branch_push_result = source.push(br_to,
1279
overwrite, stop_revision=revision_id)
1280
push_result.workingtree_updated = None # Not applicable
1282
tree_to.lock_write()
1284
push_result.branch_push_result = source.push(
1285
tree_to.branch, overwrite, stop_revision=revision_id)
1289
push_result.workingtree_updated = True
1290
push_result.old_revno = push_result.branch_push_result.old_revno
1291
push_result.old_revid = push_result.branch_push_result.old_revid
1292
push_result.target_branch = \
1293
push_result.branch_push_result.target_branch
1297
class BzrDirHooks(hooks.Hooks):
1298
"""Hooks for BzrDir operations."""
1301
"""Create the default hooks."""
1302
hooks.Hooks.__init__(self)
1303
self.create_hook(hooks.HookPoint('pre_open',
1304
"Invoked before attempting to open a BzrDir with the transport "
1305
"that the open will use.", (1, 14), None))
1307
# install the default hooks
1308
BzrDir.hooks = BzrDirHooks()
1311
class BzrDirPreSplitOut(BzrDir):
1312
"""A common class for the all-in-one formats."""
1314
def __init__(self, _transport, _format):
1315
"""See BzrDir.__init__."""
1316
super(BzrDirPreSplitOut, self).__init__(_transport, _format)
1317
self._control_files = lockable_files.LockableFiles(
1318
self.get_branch_transport(None),
1319
self._format._lock_file_name,
1320
self._format._lock_class)
1322
def break_lock(self):
1323
"""Pre-splitout bzrdirs do not suffer from stale locks."""
1324
raise NotImplementedError(self.break_lock)
1326
def cloning_metadir(self, require_stacking=False):
1327
"""Produce a metadir suitable for cloning with."""
1328
if require_stacking:
1329
return format_registry.make_bzrdir('1.6')
1330
return self._format.__class__()
1332
def clone(self, url, revision_id=None, force_new_repo=False,
1333
preserve_stacking=False):
1334
"""See BzrDir.clone().
1336
force_new_repo has no effect, since this family of formats always
1337
require a new repository.
1338
preserve_stacking has no effect, since no source branch using this
1339
family of formats can be stacked, so there is no stacking to preserve.
1341
self._make_tail(url)
1342
result = self._format._initialize_for_clone(url)
1343
self.open_repository().clone(result, revision_id=revision_id)
1344
from_branch = self.open_branch()
1345
from_branch.clone(result, revision_id=revision_id)
1347
tree = self.open_workingtree()
1348
except errors.NotLocalUrl:
1349
# make a new one, this format always has to have one.
1350
result._init_workingtree()
1355
def create_branch(self):
1356
"""See BzrDir.create_branch."""
1357
return self._format.get_branch_format().initialize(self)
1359
def destroy_branch(self):
1360
"""See BzrDir.destroy_branch."""
1361
raise errors.UnsupportedOperation(self.destroy_branch, self)
1363
def create_repository(self, shared=False):
1364
"""See BzrDir.create_repository."""
1366
raise errors.IncompatibleFormat('shared repository', self._format)
1367
return self.open_repository()
1369
def destroy_repository(self):
1370
"""See BzrDir.destroy_repository."""
1371
raise errors.UnsupportedOperation(self.destroy_repository, self)
1373
def create_workingtree(self, revision_id=None, from_branch=None,
1374
accelerator_tree=None, hardlink=False):
1375
"""See BzrDir.create_workingtree."""
1376
# The workingtree is sometimes created when the bzrdir is created,
1377
# but not when cloning.
1379
# this looks buggy but is not -really-
1380
# because this format creates the workingtree when the bzrdir is
1382
# clone and sprout will have set the revision_id
1383
# and that will have set it for us, its only
1384
# specific uses of create_workingtree in isolation
1385
# that can do wonky stuff here, and that only
1386
# happens for creating checkouts, which cannot be
1387
# done on this format anyway. So - acceptable wart.
1389
warning("can't support hardlinked working trees in %r"
1392
result = self.open_workingtree(recommend_upgrade=False)
1393
except errors.NoSuchFile:
1394
result = self._init_workingtree()
1395
if revision_id is not None:
1396
if revision_id == _mod_revision.NULL_REVISION:
1397
result.set_parent_ids([])
1399
result.set_parent_ids([revision_id])
1402
def _init_workingtree(self):
1403
from bzrlib.workingtree import WorkingTreeFormat2
1405
return WorkingTreeFormat2().initialize(self)
1406
except errors.NotLocalUrl:
1407
# Even though we can't access the working tree, we need to
1408
# create its control files.
1409
return WorkingTreeFormat2()._stub_initialize_on_transport(
1410
self.transport, self._control_files._file_mode)
1412
def destroy_workingtree(self):
1413
"""See BzrDir.destroy_workingtree."""
1414
raise errors.UnsupportedOperation(self.destroy_workingtree, self)
1416
def destroy_workingtree_metadata(self):
1417
"""See BzrDir.destroy_workingtree_metadata."""
1418
raise errors.UnsupportedOperation(self.destroy_workingtree_metadata,
1421
def get_branch_transport(self, branch_format):
1422
"""See BzrDir.get_branch_transport()."""
1423
if branch_format is None:
1424
return self.transport
1426
branch_format.get_format_string()
1427
except NotImplementedError:
1428
return self.transport
1429
raise errors.IncompatibleFormat(branch_format, self._format)
1431
def get_repository_transport(self, repository_format):
1432
"""See BzrDir.get_repository_transport()."""
1433
if repository_format is None:
1434
return self.transport
1436
repository_format.get_format_string()
1437
except NotImplementedError:
1438
return self.transport
1439
raise errors.IncompatibleFormat(repository_format, self._format)
1441
def get_workingtree_transport(self, workingtree_format):
1442
"""See BzrDir.get_workingtree_transport()."""
1443
if workingtree_format is None:
1444
return self.transport
1446
workingtree_format.get_format_string()
1447
except NotImplementedError:
1448
return self.transport
1449
raise errors.IncompatibleFormat(workingtree_format, self._format)
1451
def needs_format_conversion(self, format=None):
1452
"""See BzrDir.needs_format_conversion()."""
1453
# if the format is not the same as the system default,
1454
# an upgrade is needed.
1456
symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1457
% 'needs_format_conversion(format=None)')
1458
format = BzrDirFormat.get_default_format()
1459
return not isinstance(self._format, format.__class__)
1461
def open_branch(self, unsupported=False, ignore_fallbacks=False):
1462
"""See BzrDir.open_branch."""
1463
from bzrlib.branch import BzrBranchFormat4
1464
format = BzrBranchFormat4()
1465
self._check_supported(format, unsupported)
1466
return format.open(self, _found=True)
1468
def sprout(self, url, revision_id=None, force_new_repo=False,
1469
possible_transports=None, accelerator_tree=None,
1470
hardlink=False, stacked=False, create_tree_if_local=True,
1471
source_branch=None):
1472
"""See BzrDir.sprout()."""
1473
if source_branch is not None:
1474
my_branch = self.open_branch()
1475
if source_branch.base != my_branch.base:
1476
raise AssertionError(
1477
"source branch %r is not within %r with branch %r" %
1478
(source_branch, self, my_branch))
1480
raise errors.UnstackableBranchFormat(
1481
self._format, self.root_transport.base)
1482
if not create_tree_if_local:
1483
raise errors.MustHaveWorkingTree(
1484
self._format, self.root_transport.base)
1485
from bzrlib.workingtree import WorkingTreeFormat2
1486
self._make_tail(url)
1487
result = self._format._initialize_for_clone(url)
1489
self.open_repository().clone(result, revision_id=revision_id)
1490
except errors.NoRepositoryPresent:
1493
self.open_branch().sprout(result, revision_id=revision_id)
1494
except errors.NotBranchError:
1497
# we always want a working tree
1498
WorkingTreeFormat2().initialize(result,
1499
accelerator_tree=accelerator_tree,
1504
class BzrDir4(BzrDirPreSplitOut):
1505
"""A .bzr version 4 control object.
1507
This is a deprecated format and may be removed after sept 2006.
1510
def create_repository(self, shared=False):
1511
"""See BzrDir.create_repository."""
1512
return self._format.repository_format.initialize(self, shared)
1514
def needs_format_conversion(self, format=None):
1515
"""Format 4 dirs are always in need of conversion."""
1517
symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1518
% 'needs_format_conversion(format=None)')
1521
def open_repository(self):
1522
"""See BzrDir.open_repository."""
1523
from bzrlib.repofmt.weaverepo import RepositoryFormat4
1524
return RepositoryFormat4().open(self, _found=True)
1527
class BzrDir5(BzrDirPreSplitOut):
1528
"""A .bzr version 5 control object.
1530
This is a deprecated format and may be removed after sept 2006.
1533
def open_repository(self):
1534
"""See BzrDir.open_repository."""
1535
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1536
return RepositoryFormat5().open(self, _found=True)
1538
def open_workingtree(self, _unsupported=False,
1539
recommend_upgrade=True):
1540
"""See BzrDir.create_workingtree."""
1541
from bzrlib.workingtree import WorkingTreeFormat2
1542
wt_format = WorkingTreeFormat2()
1543
# we don't warn here about upgrades; that ought to be handled for the
1545
return wt_format.open(self, _found=True)
1548
class BzrDir6(BzrDirPreSplitOut):
1549
"""A .bzr version 6 control object.
1551
This is a deprecated format and may be removed after sept 2006.
1554
def open_repository(self):
1555
"""See BzrDir.open_repository."""
1556
from bzrlib.repofmt.weaverepo import RepositoryFormat6
1557
return RepositoryFormat6().open(self, _found=True)
1559
def open_workingtree(self, _unsupported=False,
1560
recommend_upgrade=True):
1561
"""See BzrDir.create_workingtree."""
1562
# we don't warn here about upgrades; that ought to be handled for the
1564
from bzrlib.workingtree import WorkingTreeFormat2
1565
return WorkingTreeFormat2().open(self, _found=True)
1568
class BzrDirMeta1(BzrDir):
1569
"""A .bzr meta version 1 control object.
1571
This is the first control object where the
1572
individual aspects are really split out: there are separate repository,
1573
workingtree and branch subdirectories and any subset of the three can be
1574
present within a BzrDir.
1577
def can_convert_format(self):
1578
"""See BzrDir.can_convert_format()."""
1581
def create_branch(self):
1582
"""See BzrDir.create_branch."""
1583
return self._format.get_branch_format().initialize(self)
1585
def destroy_branch(self):
1586
"""See BzrDir.create_branch."""
1587
self.transport.delete_tree('branch')
1589
def create_repository(self, shared=False):
1590
"""See BzrDir.create_repository."""
1591
return self._format.repository_format.initialize(self, shared)
1593
def destroy_repository(self):
1594
"""See BzrDir.destroy_repository."""
1595
self.transport.delete_tree('repository')
1597
def create_workingtree(self, revision_id=None, from_branch=None,
1598
accelerator_tree=None, hardlink=False):
1599
"""See BzrDir.create_workingtree."""
1600
return self._format.workingtree_format.initialize(
1601
self, revision_id, from_branch=from_branch,
1602
accelerator_tree=accelerator_tree, hardlink=hardlink)
1604
def destroy_workingtree(self):
1605
"""See BzrDir.destroy_workingtree."""
1606
wt = self.open_workingtree(recommend_upgrade=False)
1607
repository = wt.branch.repository
1608
empty = repository.revision_tree(_mod_revision.NULL_REVISION)
1609
wt.revert(old_tree=empty)
1610
self.destroy_workingtree_metadata()
1612
def destroy_workingtree_metadata(self):
1613
self.transport.delete_tree('checkout')
1615
def find_branch_format(self):
1616
"""Find the branch 'format' for this bzrdir.
1618
This might be a synthetic object for e.g. RemoteBranch and SVN.
1620
from bzrlib.branch import BranchFormat
1621
return BranchFormat.find_format(self)
1623
def _get_mkdir_mode(self):
1624
"""Figure out the mode to use when creating a bzrdir subdir."""
1625
temp_control = lockable_files.LockableFiles(self.transport, '',
1626
lockable_files.TransportLock)
1627
return temp_control._dir_mode
1629
def get_branch_reference(self):
1630
"""See BzrDir.get_branch_reference()."""
1631
from bzrlib.branch import BranchFormat
1632
format = BranchFormat.find_format(self)
1633
return format.get_reference(self)
1635
def get_branch_transport(self, branch_format):
1636
"""See BzrDir.get_branch_transport()."""
1637
# XXX: this shouldn't implicitly create the directory if it's just
1638
# promising to get a transport -- mbp 20090727
1639
if branch_format is None:
1640
return self.transport.clone('branch')
1642
branch_format.get_format_string()
1643
except NotImplementedError:
1644
raise errors.IncompatibleFormat(branch_format, self._format)
1646
self.transport.mkdir('branch', mode=self._get_mkdir_mode())
1647
except errors.FileExists:
1649
return self.transport.clone('branch')
1651
def get_repository_transport(self, repository_format):
1652
"""See BzrDir.get_repository_transport()."""
1653
if repository_format is None:
1654
return self.transport.clone('repository')
1656
repository_format.get_format_string()
1657
except NotImplementedError:
1658
raise errors.IncompatibleFormat(repository_format, self._format)
1660
self.transport.mkdir('repository', mode=self._get_mkdir_mode())
1661
except errors.FileExists:
1663
return self.transport.clone('repository')
1665
def get_workingtree_transport(self, workingtree_format):
1666
"""See BzrDir.get_workingtree_transport()."""
1667
if workingtree_format is None:
1668
return self.transport.clone('checkout')
1670
workingtree_format.get_format_string()
1671
except NotImplementedError:
1672
raise errors.IncompatibleFormat(workingtree_format, self._format)
1674
self.transport.mkdir('checkout', mode=self._get_mkdir_mode())
1675
except errors.FileExists:
1677
return self.transport.clone('checkout')
1679
def needs_format_conversion(self, format=None):
1680
"""See BzrDir.needs_format_conversion()."""
1682
symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1683
% 'needs_format_conversion(format=None)')
1685
format = BzrDirFormat.get_default_format()
1686
if not isinstance(self._format, format.__class__):
1687
# it is not a meta dir format, conversion is needed.
1689
# we might want to push this down to the repository?
1691
if not isinstance(self.open_repository()._format,
1692
format.repository_format.__class__):
1693
# the repository needs an upgrade.
1695
except errors.NoRepositoryPresent:
1698
if not isinstance(self.open_branch()._format,
1699
format.get_branch_format().__class__):
1700
# the branch needs an upgrade.
1702
except errors.NotBranchError:
1705
my_wt = self.open_workingtree(recommend_upgrade=False)
1706
if not isinstance(my_wt._format,
1707
format.workingtree_format.__class__):
1708
# the workingtree needs an upgrade.
1710
except (errors.NoWorkingTree, errors.NotLocalUrl):
1714
def open_branch(self, unsupported=False, ignore_fallbacks=False):
1715
"""See BzrDir.open_branch."""
1716
format = self.find_branch_format()
1717
self._check_supported(format, unsupported)
1718
return format.open(self, _found=True, ignore_fallbacks=ignore_fallbacks)
1720
def open_repository(self, unsupported=False):
1721
"""See BzrDir.open_repository."""
1722
from bzrlib.repository import RepositoryFormat
1723
format = RepositoryFormat.find_format(self)
1724
self._check_supported(format, unsupported)
1725
return format.open(self, _found=True)
1727
def open_workingtree(self, unsupported=False,
1728
recommend_upgrade=True):
1729
"""See BzrDir.open_workingtree."""
1730
from bzrlib.workingtree import WorkingTreeFormat
1731
format = WorkingTreeFormat.find_format(self)
1732
self._check_supported(format, unsupported,
1734
basedir=self.root_transport.base)
1735
return format.open(self, _found=True)
1737
def _get_config(self):
1738
return config.TransportConfig(self.transport, 'control.conf')
1741
class BzrDirFormat(object):
1742
"""An encapsulation of the initialization and open routines for a format.
1744
Formats provide three things:
1745
* An initialization routine,
1749
Formats are placed in a dict by their format string for reference
1750
during bzrdir opening. These should be subclasses of BzrDirFormat
1753
Once a format is deprecated, just deprecate the initialize and open
1754
methods on the format class. Do not deprecate the object, as the
1755
object will be created every system load.
1758
_default_format = None
1759
"""The default format used for new .bzr dirs."""
1762
"""The known formats."""
1764
_control_formats = []
1765
"""The registered control formats - .bzr, ....
1767
This is a list of BzrDirFormat objects.
1770
_control_server_formats = []
1771
"""The registered control server formats, e.g. RemoteBzrDirs.
1773
This is a list of BzrDirFormat objects.
1776
_lock_file_name = 'branch-lock'
1778
# _lock_class must be set in subclasses to the lock type, typ.
1779
# TransportLock or LockDir
1782
def find_format(klass, transport, _server_formats=True):
1783
"""Return the format present at transport."""
1785
formats = klass._control_server_formats + klass._control_formats
1787
formats = klass._control_formats
1788
for format in formats:
1790
return format.probe_transport(transport)
1791
except errors.NotBranchError:
1792
# this format does not find a control dir here.
1794
raise errors.NotBranchError(path=transport.base)
1797
def probe_transport(klass, transport):
1798
"""Return the .bzrdir style format present in a directory."""
1800
format_string = transport.get(".bzr/branch-format").read()
1801
except errors.NoSuchFile:
1802
raise errors.NotBranchError(path=transport.base)
1805
return klass._formats[format_string]
1807
raise errors.UnknownFormatError(format=format_string, kind='bzrdir')
1810
def get_default_format(klass):
1811
"""Return the current default format."""
1812
return klass._default_format
1814
def get_format_string(self):
1815
"""Return the ASCII format string that identifies this format."""
1816
raise NotImplementedError(self.get_format_string)
1818
def get_format_description(self):
1819
"""Return the short description for this format."""
1820
raise NotImplementedError(self.get_format_description)
1822
def get_converter(self, format=None):
1823
"""Return the converter to use to convert bzrdirs needing converts.
1825
This returns a bzrlib.bzrdir.Converter object.
1827
This should return the best upgrader to step this format towards the
1828
current default format. In the case of plugins we can/should provide
1829
some means for them to extend the range of returnable converters.
1831
:param format: Optional format to override the default format of the
1834
raise NotImplementedError(self.get_converter)
1836
def initialize(self, url, possible_transports=None):
1837
"""Create a bzr control dir at this url and return an opened copy.
1839
While not deprecated, this method is very specific and its use will
1840
lead to many round trips to setup a working environment. See
1841
initialize_on_transport_ex for a [nearly] all-in-one method.
1843
Subclasses should typically override initialize_on_transport
1844
instead of this method.
1846
return self.initialize_on_transport(get_transport(url,
1847
possible_transports))
1849
def initialize_on_transport(self, transport):
1850
"""Initialize a new bzrdir in the base directory of a Transport."""
1852
# can we hand off the request to the smart server rather than using
1854
client_medium = transport.get_smart_medium()
1855
except errors.NoSmartMedium:
1856
return self._initialize_on_transport_vfs(transport)
1858
# Current RPC's only know how to create bzr metadir1 instances, so
1859
# we still delegate to vfs methods if the requested format is not a
1861
if type(self) != BzrDirMetaFormat1:
1862
return self._initialize_on_transport_vfs(transport)
1863
remote_format = RemoteBzrDirFormat()
1864
self._supply_sub_formats_to(remote_format)
1865
return remote_format.initialize_on_transport(transport)
1867
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
1868
create_prefix=False, force_new_repo=False, stacked_on=None,
1869
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
1870
shared_repo=False, vfs_only=False):
1871
"""Create this format on transport.
1873
The directory to initialize will be created.
1875
:param force_new_repo: Do not use a shared repository for the target,
1876
even if one is available.
1877
:param create_prefix: Create any missing directories leading up to
1879
:param use_existing_dir: Use an existing directory if one exists.
1880
:param stacked_on: A url to stack any created branch on, None to follow
1881
any target stacking policy.
1882
:param stack_on_pwd: If stack_on is relative, the location it is
1884
:param repo_format_name: If non-None, a repository will be
1885
made-or-found. Should none be found, or if force_new_repo is True
1886
the repo_format_name is used to select the format of repository to
1888
:param make_working_trees: Control the setting of make_working_trees
1889
for a new shared repository when one is made. None to use whatever
1890
default the format has.
1891
:param shared_repo: Control whether made repositories are shared or
1893
:param vfs_only: If True do not attempt to use a smart server
1894
:return: repo, bzrdir, require_stacking, repository_policy. repo is
1895
None if none was created or found, bzrdir is always valid.
1896
require_stacking is the result of examining the stacked_on
1897
parameter and any stacking policy found for the target.
1900
# Try to hand off to a smart server
1902
client_medium = transport.get_smart_medium()
1903
except errors.NoSmartMedium:
1906
# TODO: lookup the local format from a server hint.
1907
remote_dir_format = RemoteBzrDirFormat()
1908
remote_dir_format._network_name = self.network_name()
1909
self._supply_sub_formats_to(remote_dir_format)
1910
return remote_dir_format.initialize_on_transport_ex(transport,
1911
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
1912
force_new_repo=force_new_repo, stacked_on=stacked_on,
1913
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
1914
make_working_trees=make_working_trees, shared_repo=shared_repo)
1915
# XXX: Refactor the create_prefix/no_create_prefix code into a
1916
# common helper function
1917
# The destination may not exist - if so make it according to policy.
1918
def make_directory(transport):
1919
transport.mkdir('.')
1921
def redirected(transport, e, redirection_notice):
1922
note(redirection_notice)
1923
return transport._redirected_to(e.source, e.target)
1925
transport = do_catching_redirections(make_directory, transport,
1927
except errors.FileExists:
1928
if not use_existing_dir:
1930
except errors.NoSuchFile:
1931
if not create_prefix:
1933
transport.create_prefix()
1935
require_stacking = (stacked_on is not None)
1936
# Now the target directory exists, but doesn't have a .bzr
1937
# directory. So we need to create it, along with any work to create
1938
# all of the dependent branches, etc.
1940
result = self.initialize_on_transport(transport)
1941
if repo_format_name:
1943
# use a custom format
1944
result._format.repository_format = \
1945
repository.network_format_registry.get(repo_format_name)
1946
except AttributeError:
1947
# The format didn't permit it to be set.
1949
# A repository is desired, either in-place or shared.
1950
repository_policy = result.determine_repository_policy(
1951
force_new_repo, stacked_on, stack_on_pwd,
1952
require_stacking=require_stacking)
1953
result_repo, is_new_repo = repository_policy.acquire_repository(
1954
make_working_trees, shared_repo)
1955
if not require_stacking and repository_policy._require_stacking:
1956
require_stacking = True
1957
result._format.require_stacking()
1958
result_repo.lock_write()
1961
repository_policy = None
1962
return result_repo, result, require_stacking, repository_policy
1964
def _initialize_on_transport_vfs(self, transport):
1965
"""Initialize a new bzrdir using VFS calls.
1967
:param transport: The transport to create the .bzr directory in.
1970
# Since we are creating a .bzr directory, inherit the
1971
# mode from the root directory
1972
temp_control = lockable_files.LockableFiles(transport,
1973
'', lockable_files.TransportLock)
1974
temp_control._transport.mkdir('.bzr',
1975
# FIXME: RBC 20060121 don't peek under
1977
mode=temp_control._dir_mode)
1978
if sys.platform == 'win32' and isinstance(transport, local.LocalTransport):
1979
win32utils.set_file_attr_hidden(transport._abspath('.bzr'))
1980
file_mode = temp_control._file_mode
1982
bzrdir_transport = transport.clone('.bzr')
1983
utf8_files = [('README',
1984
"This is a Bazaar control directory.\n"
1985
"Do not change any files in this directory.\n"
1986
"See http://bazaar-vcs.org/ for more information about Bazaar.\n"),
1987
('branch-format', self.get_format_string()),
1989
# NB: no need to escape relative paths that are url safe.
1990
control_files = lockable_files.LockableFiles(bzrdir_transport,
1991
self._lock_file_name, self._lock_class)
1992
control_files.create_lock()
1993
control_files.lock_write()
1995
for (filename, content) in utf8_files:
1996
bzrdir_transport.put_bytes(filename, content,
1999
control_files.unlock()
2000
return self.open(transport, _found=True)
2002
def is_supported(self):
2003
"""Is this format supported?
2005
Supported formats must be initializable and openable.
2006
Unsupported formats may not support initialization or committing or
2007
some other features depending on the reason for not being supported.
2011
def network_name(self):
2012
"""A simple byte string uniquely identifying this format for RPC calls.
2014
Bzr control formats use thir disk format string to identify the format
2015
over the wire. Its possible that other control formats have more
2016
complex detection requirements, so we permit them to use any unique and
2017
immutable string they desire.
2019
raise NotImplementedError(self.network_name)
2021
def same_model(self, target_format):
2022
return (self.repository_format.rich_root_data ==
2023
target_format.rich_root_data)
2026
def known_formats(klass):
2027
"""Return all the known formats.
2029
Concrete formats should override _known_formats.
2031
# There is double indirection here to make sure that control
2032
# formats used by more than one dir format will only be probed
2033
# once. This can otherwise be quite expensive for remote connections.
2035
for format in klass._control_formats:
2036
result.update(format._known_formats())
2040
def _known_formats(klass):
2041
"""Return the known format instances for this control format."""
2042
return set(klass._formats.values())
2044
def open(self, transport, _found=False):
2045
"""Return an instance of this format for the dir transport points at.
2047
_found is a private parameter, do not use it.
2050
found_format = BzrDirFormat.find_format(transport)
2051
if not isinstance(found_format, self.__class__):
2052
raise AssertionError("%s was asked to open %s, but it seems to need "
2054
% (self, transport, found_format))
2055
# Allow subclasses - use the found format.
2056
self._supply_sub_formats_to(found_format)
2057
return found_format._open(transport)
2058
return self._open(transport)
2060
def _open(self, transport):
2061
"""Template method helper for opening BzrDirectories.
2063
This performs the actual open and any additional logic or parameter
2066
raise NotImplementedError(self._open)
2069
def register_format(klass, format):
2070
klass._formats[format.get_format_string()] = format
2071
# bzr native formats have a network name of their format string.
2072
network_format_registry.register(format.get_format_string(), format.__class__)
2075
def register_control_format(klass, format):
2076
"""Register a format that does not use '.bzr' for its control dir.
2078
TODO: This should be pulled up into a 'ControlDirFormat' base class
2079
which BzrDirFormat can inherit from, and renamed to register_format
2080
there. It has been done without that for now for simplicity of
2083
klass._control_formats.append(format)
2086
def register_control_server_format(klass, format):
2087
"""Register a control format for client-server environments.
2089
These formats will be tried before ones registered with
2090
register_control_format. This gives implementations that decide to the
2091
chance to grab it before anything looks at the contents of the format
2094
klass._control_server_formats.append(format)
2097
def _set_default_format(klass, format):
2098
"""Set default format (for testing behavior of defaults only)"""
2099
klass._default_format = format
2103
return self.get_format_description().rstrip()
2105
def _supply_sub_formats_to(self, other_format):
2106
"""Give other_format the same values for sub formats as this has.
2108
This method is expected to be used when parameterising a
2109
RemoteBzrDirFormat instance with the parameters from a
2110
BzrDirMetaFormat1 instance.
2112
:param other_format: other_format is a format which should be
2113
compatible with whatever sub formats are supported by self.
2118
def unregister_format(klass, format):
2119
del klass._formats[format.get_format_string()]
2122
def unregister_control_format(klass, format):
2123
klass._control_formats.remove(format)
2126
class BzrDirFormat4(BzrDirFormat):
2127
"""Bzr dir format 4.
2129
This format is a combined format for working tree, branch and repository.
2131
- Format 1 working trees [always]
2132
- Format 4 branches [always]
2133
- Format 4 repositories [always]
2135
This format is deprecated: it indexes texts using a text it which is
2136
removed in format 5; write support for this format has been removed.
2139
_lock_class = lockable_files.TransportLock
2141
def get_format_string(self):
2142
"""See BzrDirFormat.get_format_string()."""
2143
return "Bazaar-NG branch, format 0.0.4\n"
2145
def get_format_description(self):
2146
"""See BzrDirFormat.get_format_description()."""
2147
return "All-in-one format 4"
2149
def get_converter(self, format=None):
2150
"""See BzrDirFormat.get_converter()."""
2151
# there is one and only one upgrade path here.
2152
return ConvertBzrDir4To5()
2154
def initialize_on_transport(self, transport):
2155
"""Format 4 branches cannot be created."""
2156
raise errors.UninitializableFormat(self)
2158
def is_supported(self):
2159
"""Format 4 is not supported.
2161
It is not supported because the model changed from 4 to 5 and the
2162
conversion logic is expensive - so doing it on the fly was not
2167
def network_name(self):
2168
return self.get_format_string()
2170
def _open(self, transport):
2171
"""See BzrDirFormat._open."""
2172
return BzrDir4(transport, self)
2174
def __return_repository_format(self):
2175
"""Circular import protection."""
2176
from bzrlib.repofmt.weaverepo import RepositoryFormat4
2177
return RepositoryFormat4()
2178
repository_format = property(__return_repository_format)
2181
class BzrDirFormatAllInOne(BzrDirFormat):
2182
"""Common class for formats before meta-dirs."""
2184
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
2185
create_prefix=False, force_new_repo=False, stacked_on=None,
2186
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
2188
"""See BzrDirFormat.initialize_on_transport_ex."""
2189
require_stacking = (stacked_on is not None)
2190
# Format 5 cannot stack, but we've been asked to - actually init
2192
if require_stacking:
2193
format = BzrDirMetaFormat1()
2194
return format.initialize_on_transport_ex(transport,
2195
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2196
force_new_repo=force_new_repo, stacked_on=stacked_on,
2197
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2198
make_working_trees=make_working_trees, shared_repo=shared_repo)
2199
return BzrDirFormat.initialize_on_transport_ex(self, transport,
2200
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2201
force_new_repo=force_new_repo, stacked_on=stacked_on,
2202
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2203
make_working_trees=make_working_trees, shared_repo=shared_repo)
2206
class BzrDirFormat5(BzrDirFormatAllInOne):
2207
"""Bzr control format 5.
2209
This format is a combined format for working tree, branch and repository.
2211
- Format 2 working trees [always]
2212
- Format 4 branches [always]
2213
- Format 5 repositories [always]
2214
Unhashed stores in the repository.
2217
_lock_class = lockable_files.TransportLock
2219
def get_format_string(self):
2220
"""See BzrDirFormat.get_format_string()."""
2221
return "Bazaar-NG branch, format 5\n"
2223
def get_branch_format(self):
2224
from bzrlib import branch
2225
return branch.BzrBranchFormat4()
2227
def get_format_description(self):
2228
"""See BzrDirFormat.get_format_description()."""
2229
return "All-in-one format 5"
2231
def get_converter(self, format=None):
2232
"""See BzrDirFormat.get_converter()."""
2233
# there is one and only one upgrade path here.
2234
return ConvertBzrDir5To6()
2236
def _initialize_for_clone(self, url):
2237
return self.initialize_on_transport(get_transport(url), _cloning=True)
2239
def initialize_on_transport(self, transport, _cloning=False):
2240
"""Format 5 dirs always have working tree, branch and repository.
2242
Except when they are being cloned.
2244
from bzrlib.branch import BzrBranchFormat4
2245
from bzrlib.repofmt.weaverepo import RepositoryFormat5
2246
result = (super(BzrDirFormat5, self).initialize_on_transport(transport))
2247
RepositoryFormat5().initialize(result, _internal=True)
2249
branch = BzrBranchFormat4().initialize(result)
2250
result._init_workingtree()
2253
def network_name(self):
2254
return self.get_format_string()
2256
def _open(self, transport):
2257
"""See BzrDirFormat._open."""
2258
return BzrDir5(transport, self)
2260
def __return_repository_format(self):
2261
"""Circular import protection."""
2262
from bzrlib.repofmt.weaverepo import RepositoryFormat5
2263
return RepositoryFormat5()
2264
repository_format = property(__return_repository_format)
2267
class BzrDirFormat6(BzrDirFormatAllInOne):
2268
"""Bzr control format 6.
2270
This format is a combined format for working tree, branch and repository.
2272
- Format 2 working trees [always]
2273
- Format 4 branches [always]
2274
- Format 6 repositories [always]
2277
_lock_class = lockable_files.TransportLock
2279
def get_format_string(self):
2280
"""See BzrDirFormat.get_format_string()."""
2281
return "Bazaar-NG branch, format 6\n"
2283
def get_format_description(self):
2284
"""See BzrDirFormat.get_format_description()."""
2285
return "All-in-one format 6"
2287
def get_branch_format(self):
2288
from bzrlib import branch
2289
return branch.BzrBranchFormat4()
2291
def get_converter(self, format=None):
2292
"""See BzrDirFormat.get_converter()."""
2293
# there is one and only one upgrade path here.
2294
return ConvertBzrDir6ToMeta()
2296
def _initialize_for_clone(self, url):
2297
return self.initialize_on_transport(get_transport(url), _cloning=True)
2299
def initialize_on_transport(self, transport, _cloning=False):
2300
"""Format 6 dirs always have working tree, branch and repository.
2302
Except when they are being cloned.
2304
from bzrlib.branch import BzrBranchFormat4
2305
from bzrlib.repofmt.weaverepo import RepositoryFormat6
2306
result = super(BzrDirFormat6, self).initialize_on_transport(transport)
2307
RepositoryFormat6().initialize(result, _internal=True)
2309
branch = BzrBranchFormat4().initialize(result)
2310
result._init_workingtree()
2313
def network_name(self):
2314
return self.get_format_string()
2316
def _open(self, transport):
2317
"""See BzrDirFormat._open."""
2318
return BzrDir6(transport, self)
2320
def __return_repository_format(self):
2321
"""Circular import protection."""
2322
from bzrlib.repofmt.weaverepo import RepositoryFormat6
2323
return RepositoryFormat6()
2324
repository_format = property(__return_repository_format)
2327
class BzrDirMetaFormat1(BzrDirFormat):
2328
"""Bzr meta control format 1
2330
This is the first format with split out working tree, branch and repository
2333
- Format 3 working trees [optional]
2334
- Format 5 branches [optional]
2335
- Format 7 repositories [optional]
2338
_lock_class = lockdir.LockDir
2341
self._workingtree_format = None
2342
self._branch_format = None
2343
self._repository_format = None
2345
def __eq__(self, other):
2346
if other.__class__ is not self.__class__:
2348
if other.repository_format != self.repository_format:
2350
if other.workingtree_format != self.workingtree_format:
2354
def __ne__(self, other):
2355
return not self == other
2357
def get_branch_format(self):
2358
if self._branch_format is None:
2359
from bzrlib.branch import BranchFormat
2360
self._branch_format = BranchFormat.get_default_format()
2361
return self._branch_format
2363
def set_branch_format(self, format):
2364
self._branch_format = format
2366
def require_stacking(self, stack_on=None, possible_transports=None,
2368
"""We have a request to stack, try to ensure the formats support it.
2370
:param stack_on: If supplied, it is the URL to a branch that we want to
2371
stack on. Check to see if that format supports stacking before
2374
# Stacking is desired. requested by the target, but does the place it
2375
# points at support stacking? If it doesn't then we should
2376
# not implicitly upgrade. We check this here.
2377
new_repo_format = None
2378
new_branch_format = None
2380
# a bit of state for get_target_branch so that we don't try to open it
2381
# 2 times, for both repo *and* branch
2382
target = [None, False, None] # target_branch, checked, upgrade anyway
2383
def get_target_branch():
2385
# We've checked, don't check again
2387
if stack_on is None:
2388
# No target format, that means we want to force upgrading
2389
target[:] = [None, True, True]
2392
target_dir = BzrDir.open(stack_on,
2393
possible_transports=possible_transports)
2394
except errors.NotBranchError:
2395
# Nothing there, don't change formats
2396
target[:] = [None, True, False]
2398
except errors.JailBreak:
2399
# JailBreak, JFDI and upgrade anyway
2400
target[:] = [None, True, True]
2403
target_branch = target_dir.open_branch()
2404
except errors.NotBranchError:
2405
# No branch, don't upgrade formats
2406
target[:] = [None, True, False]
2408
target[:] = [target_branch, True, False]
2411
if (not _skip_repo and
2412
not self.repository_format.supports_external_lookups):
2413
# We need to upgrade the Repository.
2414
target_branch, _, do_upgrade = get_target_branch()
2415
if target_branch is None:
2416
# We don't have a target branch, should we upgrade anyway?
2418
# stack_on is inaccessible, JFDI.
2419
# TODO: bad monkey, hard-coded formats...
2420
if self.repository_format.rich_root_data:
2421
new_repo_format = pack_repo.RepositoryFormatKnitPack5RichRoot()
2423
new_repo_format = pack_repo.RepositoryFormatKnitPack5()
2425
# If the target already supports stacking, then we know the
2426
# project is already able to use stacking, so auto-upgrade
2428
new_repo_format = target_branch.repository._format
2429
if not new_repo_format.supports_external_lookups:
2430
# target doesn't, source doesn't, so don't auto upgrade
2432
new_repo_format = None
2433
if new_repo_format is not None:
2434
self.repository_format = new_repo_format
2435
note('Source repository format does not support stacking,'
2436
' using format:\n %s',
2437
new_repo_format.get_format_description())
2439
if not self.get_branch_format().supports_stacking():
2440
# We just checked the repo, now lets check if we need to
2441
# upgrade the branch format
2442
target_branch, _, do_upgrade = get_target_branch()
2443
if target_branch is None:
2445
# TODO: bad monkey, hard-coded formats...
2446
new_branch_format = branch.BzrBranchFormat7()
2448
new_branch_format = target_branch._format
2449
if not new_branch_format.supports_stacking():
2450
new_branch_format = None
2451
if new_branch_format is not None:
2452
# Does support stacking, use its format.
2453
self.set_branch_format(new_branch_format)
2454
note('Source branch format does not support stacking,'
2455
' using format:\n %s',
2456
new_branch_format.get_format_description())
2458
def get_converter(self, format=None):
2459
"""See BzrDirFormat.get_converter()."""
2461
format = BzrDirFormat.get_default_format()
2462
if not isinstance(self, format.__class__):
2463
# converting away from metadir is not implemented
2464
raise NotImplementedError(self.get_converter)
2465
return ConvertMetaToMeta(format)
2467
def get_format_string(self):
2468
"""See BzrDirFormat.get_format_string()."""
2469
return "Bazaar-NG meta directory, format 1\n"
2471
def get_format_description(self):
2472
"""See BzrDirFormat.get_format_description()."""
2473
return "Meta directory format 1"
2475
def network_name(self):
2476
return self.get_format_string()
2478
def _open(self, transport):
2479
"""See BzrDirFormat._open."""
2480
# Create a new format instance because otherwise initialisation of new
2481
# metadirs share the global default format object leading to alias
2483
format = BzrDirMetaFormat1()
2484
self._supply_sub_formats_to(format)
2485
return BzrDirMeta1(transport, format)
2487
def __return_repository_format(self):
2488
"""Circular import protection."""
2489
if self._repository_format:
2490
return self._repository_format
2491
from bzrlib.repository import RepositoryFormat
2492
return RepositoryFormat.get_default_format()
2494
def _set_repository_format(self, value):
2495
"""Allow changing the repository format for metadir formats."""
2496
self._repository_format = value
2498
repository_format = property(__return_repository_format,
2499
_set_repository_format)
2501
def _supply_sub_formats_to(self, other_format):
2502
"""Give other_format the same values for sub formats as this has.
2504
This method is expected to be used when parameterising a
2505
RemoteBzrDirFormat instance with the parameters from a
2506
BzrDirMetaFormat1 instance.
2508
:param other_format: other_format is a format which should be
2509
compatible with whatever sub formats are supported by self.
2512
if getattr(self, '_repository_format', None) is not None:
2513
other_format.repository_format = self.repository_format
2514
if self._branch_format is not None:
2515
other_format._branch_format = self._branch_format
2516
if self._workingtree_format is not None:
2517
other_format.workingtree_format = self.workingtree_format
2519
def __get_workingtree_format(self):
2520
if self._workingtree_format is None:
2521
from bzrlib.workingtree import WorkingTreeFormat
2522
self._workingtree_format = WorkingTreeFormat.get_default_format()
2523
return self._workingtree_format
2525
def __set_workingtree_format(self, wt_format):
2526
self._workingtree_format = wt_format
2528
workingtree_format = property(__get_workingtree_format,
2529
__set_workingtree_format)
2532
network_format_registry = registry.FormatRegistry()
2533
"""Registry of formats indexed by their network name.
2535
The network name for a BzrDirFormat is an identifier that can be used when
2536
referring to formats with smart server operations. See
2537
BzrDirFormat.network_name() for more detail.
2541
# Register bzr control format
2542
BzrDirFormat.register_control_format(BzrDirFormat)
2544
# Register bzr formats
2545
BzrDirFormat.register_format(BzrDirFormat4())
2546
BzrDirFormat.register_format(BzrDirFormat5())
2547
BzrDirFormat.register_format(BzrDirFormat6())
2548
__default_format = BzrDirMetaFormat1()
2549
BzrDirFormat.register_format(__default_format)
2550
BzrDirFormat._default_format = __default_format
2553
class Converter(object):
2554
"""Converts a disk format object from one format to another."""
2556
def convert(self, to_convert, pb):
2557
"""Perform the conversion of to_convert, giving feedback via pb.
2559
:param to_convert: The disk object to convert.
2560
:param pb: a progress bar to use for progress information.
2563
def step(self, message):
2564
"""Update the pb by a step."""
2566
self.pb.update(message, self.count, self.total)
2569
class ConvertBzrDir4To5(Converter):
2570
"""Converts format 4 bzr dirs to format 5."""
2573
super(ConvertBzrDir4To5, self).__init__()
2574
self.converted_revs = set()
2575
self.absent_revisions = set()
2579
def convert(self, to_convert, pb):
2580
"""See Converter.convert()."""
2581
self.bzrdir = to_convert
2583
self.pb.note('starting upgrade from format 4 to 5')
2584
if isinstance(self.bzrdir.transport, local.LocalTransport):
2585
self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
2586
self._convert_to_weaves()
2587
return BzrDir.open(self.bzrdir.root_transport.base)
2589
def _convert_to_weaves(self):
2590
self.pb.note('note: upgrade may be faster if all store files are ungzipped first')
2593
stat = self.bzrdir.transport.stat('weaves')
2594
if not S_ISDIR(stat.st_mode):
2595
self.bzrdir.transport.delete('weaves')
2596
self.bzrdir.transport.mkdir('weaves')
2597
except errors.NoSuchFile:
2598
self.bzrdir.transport.mkdir('weaves')
2599
# deliberately not a WeaveFile as we want to build it up slowly.
2600
self.inv_weave = Weave('inventory')
2601
# holds in-memory weaves for all files
2602
self.text_weaves = {}
2603
self.bzrdir.transport.delete('branch-format')
2604
self.branch = self.bzrdir.open_branch()
2605
self._convert_working_inv()
2606
rev_history = self.branch.revision_history()
2607
# to_read is a stack holding the revisions we still need to process;
2608
# appending to it adds new highest-priority revisions
2609
self.known_revisions = set(rev_history)
2610
self.to_read = rev_history[-1:]
2612
rev_id = self.to_read.pop()
2613
if (rev_id not in self.revisions
2614
and rev_id not in self.absent_revisions):
2615
self._load_one_rev(rev_id)
2617
to_import = self._make_order()
2618
for i, rev_id in enumerate(to_import):
2619
self.pb.update('converting revision', i, len(to_import))
2620
self._convert_one_rev(rev_id)
2622
self._write_all_weaves()
2623
self._write_all_revs()
2624
self.pb.note('upgraded to weaves:')
2625
self.pb.note(' %6d revisions and inventories', len(self.revisions))
2626
self.pb.note(' %6d revisions not present', len(self.absent_revisions))
2627
self.pb.note(' %6d texts', self.text_count)
2628
self._cleanup_spare_files_after_format4()
2629
self.branch._transport.put_bytes(
2631
BzrDirFormat5().get_format_string(),
2632
mode=self.bzrdir._get_file_mode())
2634
def _cleanup_spare_files_after_format4(self):
2635
# FIXME working tree upgrade foo.
2636
for n in 'merged-patches', 'pending-merged-patches':
2638
## assert os.path.getsize(p) == 0
2639
self.bzrdir.transport.delete(n)
2640
except errors.NoSuchFile:
2642
self.bzrdir.transport.delete_tree('inventory-store')
2643
self.bzrdir.transport.delete_tree('text-store')
2645
def _convert_working_inv(self):
2646
inv = xml4.serializer_v4.read_inventory(
2647
self.branch._transport.get('inventory'))
2648
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv, working=True)
2649
self.branch._transport.put_bytes('inventory', new_inv_xml,
2650
mode=self.bzrdir._get_file_mode())
2652
def _write_all_weaves(self):
2653
controlweaves = WeaveStore(self.bzrdir.transport, prefixed=False)
2654
weave_transport = self.bzrdir.transport.clone('weaves')
2655
weaves = WeaveStore(weave_transport, prefixed=False)
2656
transaction = WriteTransaction()
2660
for file_id, file_weave in self.text_weaves.items():
2661
self.pb.update('writing weave', i, len(self.text_weaves))
2662
weaves._put_weave(file_id, file_weave, transaction)
2664
self.pb.update('inventory', 0, 1)
2665
controlweaves._put_weave('inventory', self.inv_weave, transaction)
2666
self.pb.update('inventory', 1, 1)
2670
def _write_all_revs(self):
2671
"""Write all revisions out in new form."""
2672
self.bzrdir.transport.delete_tree('revision-store')
2673
self.bzrdir.transport.mkdir('revision-store')
2674
revision_transport = self.bzrdir.transport.clone('revision-store')
2676
from bzrlib.xml5 import serializer_v5
2677
from bzrlib.repofmt.weaverepo import RevisionTextStore
2678
revision_store = RevisionTextStore(revision_transport,
2679
serializer_v5, False, versionedfile.PrefixMapper(),
2680
lambda:True, lambda:True)
2682
for i, rev_id in enumerate(self.converted_revs):
2683
self.pb.update('write revision', i, len(self.converted_revs))
2684
text = serializer_v5.write_revision_to_string(
2685
self.revisions[rev_id])
2687
revision_store.add_lines(key, None, osutils.split_lines(text))
2691
def _load_one_rev(self, rev_id):
2692
"""Load a revision object into memory.
2694
Any parents not either loaded or abandoned get queued to be
2696
self.pb.update('loading revision',
2697
len(self.revisions),
2698
len(self.known_revisions))
2699
if not self.branch.repository.has_revision(rev_id):
2701
self.pb.note('revision {%s} not present in branch; '
2702
'will be converted as a ghost',
2704
self.absent_revisions.add(rev_id)
2706
rev = self.branch.repository.get_revision(rev_id)
2707
for parent_id in rev.parent_ids:
2708
self.known_revisions.add(parent_id)
2709
self.to_read.append(parent_id)
2710
self.revisions[rev_id] = rev
2712
def _load_old_inventory(self, rev_id):
2713
old_inv_xml = self.branch.repository.inventory_store.get(rev_id).read()
2714
inv = xml4.serializer_v4.read_inventory_from_string(old_inv_xml)
2715
inv.revision_id = rev_id
2716
rev = self.revisions[rev_id]
2719
def _load_updated_inventory(self, rev_id):
2720
inv_xml = self.inv_weave.get_text(rev_id)
2721
inv = xml5.serializer_v5.read_inventory_from_string(inv_xml, rev_id)
2724
def _convert_one_rev(self, rev_id):
2725
"""Convert revision and all referenced objects to new format."""
2726
rev = self.revisions[rev_id]
2727
inv = self._load_old_inventory(rev_id)
2728
present_parents = [p for p in rev.parent_ids
2729
if p not in self.absent_revisions]
2730
self._convert_revision_contents(rev, inv, present_parents)
2731
self._store_new_inv(rev, inv, present_parents)
2732
self.converted_revs.add(rev_id)
2734
def _store_new_inv(self, rev, inv, present_parents):
2735
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
2736
new_inv_sha1 = sha_string(new_inv_xml)
2737
self.inv_weave.add_lines(rev.revision_id,
2739
new_inv_xml.splitlines(True))
2740
rev.inventory_sha1 = new_inv_sha1
2742
def _convert_revision_contents(self, rev, inv, present_parents):
2743
"""Convert all the files within a revision.
2745
Also upgrade the inventory to refer to the text revision ids."""
2746
rev_id = rev.revision_id
2747
mutter('converting texts of revision {%s}',
2749
parent_invs = map(self._load_updated_inventory, present_parents)
2750
entries = inv.iter_entries()
2752
for path, ie in entries:
2753
self._convert_file_version(rev, ie, parent_invs)
2755
def _convert_file_version(self, rev, ie, parent_invs):
2756
"""Convert one version of one file.
2758
The file needs to be added into the weave if it is a merge
2759
of >=2 parents or if it's changed from its parent.
2761
file_id = ie.file_id
2762
rev_id = rev.revision_id
2763
w = self.text_weaves.get(file_id)
2766
self.text_weaves[file_id] = w
2767
text_changed = False
2768
parent_candiate_entries = ie.parent_candidates(parent_invs)
2769
heads = graph.Graph(self).heads(parent_candiate_entries.keys())
2770
# XXX: Note that this is unordered - and this is tolerable because
2771
# the previous code was also unordered.
2772
previous_entries = dict((head, parent_candiate_entries[head]) for head
2774
self.snapshot_ie(previous_entries, ie, w, rev_id)
2777
def get_parent_map(self, revision_ids):
2778
"""See graph.StackedParentsProvider.get_parent_map"""
2779
return dict((revision_id, self.revisions[revision_id])
2780
for revision_id in revision_ids
2781
if revision_id in self.revisions)
2783
def snapshot_ie(self, previous_revisions, ie, w, rev_id):
2784
# TODO: convert this logic, which is ~= snapshot to
2785
# a call to:. This needs the path figured out. rather than a work_tree
2786
# a v4 revision_tree can be given, or something that looks enough like
2787
# one to give the file content to the entry if it needs it.
2788
# and we need something that looks like a weave store for snapshot to
2790
#ie.snapshot(rev, PATH, previous_revisions, REVISION_TREE, InMemoryWeaveStore(self.text_weaves))
2791
if len(previous_revisions) == 1:
2792
previous_ie = previous_revisions.values()[0]
2793
if ie._unchanged(previous_ie):
2794
ie.revision = previous_ie.revision
2797
text = self.branch.repository._text_store.get(ie.text_id)
2798
file_lines = text.readlines()
2799
w.add_lines(rev_id, previous_revisions, file_lines)
2800
self.text_count += 1
2802
w.add_lines(rev_id, previous_revisions, [])
2803
ie.revision = rev_id
2805
def _make_order(self):
2806
"""Return a suitable order for importing revisions.
2808
The order must be such that an revision is imported after all
2809
its (present) parents.
2811
todo = set(self.revisions.keys())
2812
done = self.absent_revisions.copy()
2815
# scan through looking for a revision whose parents
2817
for rev_id in sorted(list(todo)):
2818
rev = self.revisions[rev_id]
2819
parent_ids = set(rev.parent_ids)
2820
if parent_ids.issubset(done):
2821
# can take this one now
2822
order.append(rev_id)
2828
class ConvertBzrDir5To6(Converter):
2829
"""Converts format 5 bzr dirs to format 6."""
2831
def convert(self, to_convert, pb):
2832
"""See Converter.convert()."""
2833
self.bzrdir = to_convert
2835
self.pb.note('starting upgrade from format 5 to 6')
2836
self._convert_to_prefixed()
2837
return BzrDir.open(self.bzrdir.root_transport.base)
2839
def _convert_to_prefixed(self):
2840
from bzrlib.store import TransportStore
2841
self.bzrdir.transport.delete('branch-format')
2842
for store_name in ["weaves", "revision-store"]:
2843
self.pb.note("adding prefixes to %s" % store_name)
2844
store_transport = self.bzrdir.transport.clone(store_name)
2845
store = TransportStore(store_transport, prefixed=True)
2846
for urlfilename in store_transport.list_dir('.'):
2847
filename = urlutils.unescape(urlfilename)
2848
if (filename.endswith(".weave") or
2849
filename.endswith(".gz") or
2850
filename.endswith(".sig")):
2851
file_id, suffix = os.path.splitext(filename)
2855
new_name = store._mapper.map((file_id,)) + suffix
2856
# FIXME keep track of the dirs made RBC 20060121
2858
store_transport.move(filename, new_name)
2859
except errors.NoSuchFile: # catches missing dirs strangely enough
2860
store_transport.mkdir(osutils.dirname(new_name))
2861
store_transport.move(filename, new_name)
2862
self.bzrdir.transport.put_bytes(
2864
BzrDirFormat6().get_format_string(),
2865
mode=self.bzrdir._get_file_mode())
2868
class ConvertBzrDir6ToMeta(Converter):
2869
"""Converts format 6 bzr dirs to metadirs."""
2871
def convert(self, to_convert, pb):
2872
"""See Converter.convert()."""
2873
from bzrlib.repofmt.weaverepo import RepositoryFormat7
2874
from bzrlib.branch import BzrBranchFormat5
2875
self.bzrdir = to_convert
2878
self.total = 20 # the steps we know about
2879
self.garbage_inventories = []
2880
self.dir_mode = self.bzrdir._get_dir_mode()
2881
self.file_mode = self.bzrdir._get_file_mode()
2883
self.pb.note('starting upgrade from format 6 to metadir')
2884
self.bzrdir.transport.put_bytes(
2886
"Converting to format 6",
2887
mode=self.file_mode)
2888
# its faster to move specific files around than to open and use the apis...
2889
# first off, nuke ancestry.weave, it was never used.
2891
self.step('Removing ancestry.weave')
2892
self.bzrdir.transport.delete('ancestry.weave')
2893
except errors.NoSuchFile:
2895
# find out whats there
2896
self.step('Finding branch files')
2897
last_revision = self.bzrdir.open_branch().last_revision()
2898
bzrcontents = self.bzrdir.transport.list_dir('.')
2899
for name in bzrcontents:
2900
if name.startswith('basis-inventory.'):
2901
self.garbage_inventories.append(name)
2902
# create new directories for repository, working tree and branch
2903
repository_names = [('inventory.weave', True),
2904
('revision-store', True),
2906
self.step('Upgrading repository ')
2907
self.bzrdir.transport.mkdir('repository', mode=self.dir_mode)
2908
self.make_lock('repository')
2909
# we hard code the formats here because we are converting into
2910
# the meta format. The meta format upgrader can take this to a
2911
# future format within each component.
2912
self.put_format('repository', RepositoryFormat7())
2913
for entry in repository_names:
2914
self.move_entry('repository', entry)
2916
self.step('Upgrading branch ')
2917
self.bzrdir.transport.mkdir('branch', mode=self.dir_mode)
2918
self.make_lock('branch')
2919
self.put_format('branch', BzrBranchFormat5())
2920
branch_files = [('revision-history', True),
2921
('branch-name', True),
2923
for entry in branch_files:
2924
self.move_entry('branch', entry)
2926
checkout_files = [('pending-merges', True),
2927
('inventory', True),
2928
('stat-cache', False)]
2929
# If a mandatory checkout file is not present, the branch does not have
2930
# a functional checkout. Do not create a checkout in the converted
2932
for name, mandatory in checkout_files:
2933
if mandatory and name not in bzrcontents:
2934
has_checkout = False
2938
if not has_checkout:
2939
self.pb.note('No working tree.')
2940
# If some checkout files are there, we may as well get rid of them.
2941
for name, mandatory in checkout_files:
2942
if name in bzrcontents:
2943
self.bzrdir.transport.delete(name)
2945
from bzrlib.workingtree import WorkingTreeFormat3
2946
self.step('Upgrading working tree')
2947
self.bzrdir.transport.mkdir('checkout', mode=self.dir_mode)
2948
self.make_lock('checkout')
2950
'checkout', WorkingTreeFormat3())
2951
self.bzrdir.transport.delete_multi(
2952
self.garbage_inventories, self.pb)
2953
for entry in checkout_files:
2954
self.move_entry('checkout', entry)
2955
if last_revision is not None:
2956
self.bzrdir.transport.put_bytes(
2957
'checkout/last-revision', last_revision)
2958
self.bzrdir.transport.put_bytes(
2960
BzrDirMetaFormat1().get_format_string(),
2961
mode=self.file_mode)
2962
return BzrDir.open(self.bzrdir.root_transport.base)
2964
def make_lock(self, name):
2965
"""Make a lock for the new control dir name."""
2966
self.step('Make %s lock' % name)
2967
ld = lockdir.LockDir(self.bzrdir.transport,
2969
file_modebits=self.file_mode,
2970
dir_modebits=self.dir_mode)
2973
def move_entry(self, new_dir, entry):
2974
"""Move then entry name into new_dir."""
2976
mandatory = entry[1]
2977
self.step('Moving %s' % name)
2979
self.bzrdir.transport.move(name, '%s/%s' % (new_dir, name))
2980
except errors.NoSuchFile:
2984
def put_format(self, dirname, format):
2985
self.bzrdir.transport.put_bytes('%s/format' % dirname,
2986
format.get_format_string(),
2990
class ConvertMetaToMeta(Converter):
2991
"""Converts the components of metadirs."""
2993
def __init__(self, target_format):
2994
"""Create a metadir to metadir converter.
2996
:param target_format: The final metadir format that is desired.
2998
self.target_format = target_format
3000
def convert(self, to_convert, pb):
3001
"""See Converter.convert()."""
3002
self.bzrdir = to_convert
3006
self.step('checking repository format')
3008
repo = self.bzrdir.open_repository()
3009
except errors.NoRepositoryPresent:
3012
if not isinstance(repo._format, self.target_format.repository_format.__class__):
3013
from bzrlib.repository import CopyConverter
3014
self.pb.note('starting repository conversion')
3015
converter = CopyConverter(self.target_format.repository_format)
3016
converter.convert(repo, pb)
3018
branch = self.bzrdir.open_branch()
3019
except errors.NotBranchError:
3022
# TODO: conversions of Branch and Tree should be done by
3023
# InterXFormat lookups/some sort of registry.
3024
# Avoid circular imports
3025
from bzrlib import branch as _mod_branch
3026
old = branch._format.__class__
3027
new = self.target_format.get_branch_format().__class__
3029
if (old == _mod_branch.BzrBranchFormat5 and
3030
new in (_mod_branch.BzrBranchFormat6,
3031
_mod_branch.BzrBranchFormat7,
3032
_mod_branch.BzrBranchFormat8)):
3033
branch_converter = _mod_branch.Converter5to6()
3034
elif (old == _mod_branch.BzrBranchFormat6 and
3035
new in (_mod_branch.BzrBranchFormat7,
3036
_mod_branch.BzrBranchFormat8)):
3037
branch_converter = _mod_branch.Converter6to7()
3038
elif (old == _mod_branch.BzrBranchFormat7 and
3039
new is _mod_branch.BzrBranchFormat8):
3040
branch_converter = _mod_branch.Converter7to8()
3042
raise errors.BadConversionTarget("No converter", new)
3043
branch_converter.convert(branch)
3044
branch = self.bzrdir.open_branch()
3045
old = branch._format.__class__
3047
tree = self.bzrdir.open_workingtree(recommend_upgrade=False)
3048
except (errors.NoWorkingTree, errors.NotLocalUrl):
3051
# TODO: conversions of Branch and Tree should be done by
3052
# InterXFormat lookups
3053
if (isinstance(tree, workingtree.WorkingTree3) and
3054
not isinstance(tree, workingtree_4.DirStateWorkingTree) and
3055
isinstance(self.target_format.workingtree_format,
3056
workingtree_4.DirStateWorkingTreeFormat)):
3057
workingtree_4.Converter3to4().convert(tree)
3058
if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
3059
not isinstance(tree, workingtree_4.WorkingTree5) and
3060
isinstance(self.target_format.workingtree_format,
3061
workingtree_4.WorkingTreeFormat5)):
3062
workingtree_4.Converter4to5().convert(tree)
3063
if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
3064
not isinstance(tree, workingtree_4.WorkingTree6) and
3065
isinstance(self.target_format.workingtree_format,
3066
workingtree_4.WorkingTreeFormat6)):
3067
workingtree_4.Converter4or5to6().convert(tree)
3071
# This is not in remote.py because it's relatively small, and needs to be
3072
# registered. Putting it in remote.py creates a circular import problem.
3073
# we can make it a lazy object if the control formats is turned into something
3075
class RemoteBzrDirFormat(BzrDirMetaFormat1):
3076
"""Format representing bzrdirs accessed via a smart server"""
3079
BzrDirMetaFormat1.__init__(self)
3080
self._network_name = None
3082
def get_format_description(self):
3083
return 'bzr remote bzrdir'
3085
def get_format_string(self):
3086
raise NotImplementedError(self.get_format_string)
3088
def network_name(self):
3089
if self._network_name:
3090
return self._network_name
3092
raise AssertionError("No network name set.")
3095
def probe_transport(klass, transport):
3096
"""Return a RemoteBzrDirFormat object if it looks possible."""
3098
medium = transport.get_smart_medium()
3099
except (NotImplementedError, AttributeError,
3100
errors.TransportNotPossible, errors.NoSmartMedium,
3101
errors.SmartProtocolError):
3102
# no smart server, so not a branch for this format type.
3103
raise errors.NotBranchError(path=transport.base)
3105
# Decline to open it if the server doesn't support our required
3106
# version (3) so that the VFS-based transport will do it.
3107
if medium.should_probe():
3109
server_version = medium.protocol_version()
3110
except errors.SmartProtocolError:
3111
# Apparently there's no usable smart server there, even though
3112
# the medium supports the smart protocol.
3113
raise errors.NotBranchError(path=transport.base)
3114
if server_version != '2':
3115
raise errors.NotBranchError(path=transport.base)
3118
def initialize_on_transport(self, transport):
3120
# hand off the request to the smart server
3121
client_medium = transport.get_smart_medium()
3122
except errors.NoSmartMedium:
3123
# TODO: lookup the local format from a server hint.
3124
local_dir_format = BzrDirMetaFormat1()
3125
return local_dir_format.initialize_on_transport(transport)
3126
client = _SmartClient(client_medium)
3127
path = client.remote_path_from_transport(transport)
3129
response = client.call('BzrDirFormat.initialize', path)
3130
except errors.ErrorFromSmartServer, err:
3131
remote._translate_error(err, path=path)
3132
if response[0] != 'ok':
3133
raise errors.SmartProtocolError('unexpected response code %s' % (response,))
3134
format = RemoteBzrDirFormat()
3135
self._supply_sub_formats_to(format)
3136
return remote.RemoteBzrDir(transport, format)
3138
def parse_NoneTrueFalse(self, arg):
3145
raise AssertionError("invalid arg %r" % arg)
3147
def _serialize_NoneTrueFalse(self, arg):
3154
def _serialize_NoneString(self, arg):
3157
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
3158
create_prefix=False, force_new_repo=False, stacked_on=None,
3159
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
3162
# hand off the request to the smart server
3163
client_medium = transport.get_smart_medium()
3164
except errors.NoSmartMedium:
3167
# Decline to open it if the server doesn't support our required
3168
# version (3) so that the VFS-based transport will do it.
3169
if client_medium.should_probe():
3171
server_version = client_medium.protocol_version()
3172
if server_version != '2':
3176
except errors.SmartProtocolError:
3177
# Apparently there's no usable smart server there, even though
3178
# the medium supports the smart protocol.
3183
client = _SmartClient(client_medium)
3184
path = client.remote_path_from_transport(transport)
3185
if client_medium._is_remote_before((1, 16)):
3188
# TODO: lookup the local format from a server hint.
3189
local_dir_format = BzrDirMetaFormat1()
3190
self._supply_sub_formats_to(local_dir_format)
3191
return local_dir_format.initialize_on_transport_ex(transport,
3192
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3193
force_new_repo=force_new_repo, stacked_on=stacked_on,
3194
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3195
make_working_trees=make_working_trees, shared_repo=shared_repo,
3197
return self._initialize_on_transport_ex_rpc(client, path, transport,
3198
use_existing_dir, create_prefix, force_new_repo, stacked_on,
3199
stack_on_pwd, repo_format_name, make_working_trees, shared_repo)
3201
def _initialize_on_transport_ex_rpc(self, client, path, transport,
3202
use_existing_dir, create_prefix, force_new_repo, stacked_on,
3203
stack_on_pwd, repo_format_name, make_working_trees, shared_repo):
3205
args.append(self._serialize_NoneTrueFalse(use_existing_dir))
3206
args.append(self._serialize_NoneTrueFalse(create_prefix))
3207
args.append(self._serialize_NoneTrueFalse(force_new_repo))
3208
args.append(self._serialize_NoneString(stacked_on))
3209
# stack_on_pwd is often/usually our transport
3212
stack_on_pwd = transport.relpath(stack_on_pwd)
3213
if not stack_on_pwd:
3215
except errors.PathNotChild:
3217
args.append(self._serialize_NoneString(stack_on_pwd))
3218
args.append(self._serialize_NoneString(repo_format_name))
3219
args.append(self._serialize_NoneTrueFalse(make_working_trees))
3220
args.append(self._serialize_NoneTrueFalse(shared_repo))
3221
if self._network_name is None:
3222
self._network_name = \
3223
BzrDirFormat.get_default_format().network_name()
3225
response = client.call('BzrDirFormat.initialize_ex_1.16',
3226
self.network_name(), path, *args)
3227
except errors.UnknownSmartMethod:
3228
client._medium._remember_remote_is_before((1,16))
3229
local_dir_format = BzrDirMetaFormat1()
3230
self._supply_sub_formats_to(local_dir_format)
3231
return local_dir_format.initialize_on_transport_ex(transport,
3232
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3233
force_new_repo=force_new_repo, stacked_on=stacked_on,
3234
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3235
make_working_trees=make_working_trees, shared_repo=shared_repo,
3237
except errors.ErrorFromSmartServer, err:
3238
remote._translate_error(err, path=path)
3239
repo_path = response[0]
3240
bzrdir_name = response[6]
3241
require_stacking = response[7]
3242
require_stacking = self.parse_NoneTrueFalse(require_stacking)
3243
format = RemoteBzrDirFormat()
3244
format._network_name = bzrdir_name
3245
self._supply_sub_formats_to(format)
3246
bzrdir = remote.RemoteBzrDir(transport, format, _client=client)
3248
repo_format = remote.response_tuple_to_repo_format(response[1:])
3249
if repo_path == '.':
3252
repo_bzrdir_format = RemoteBzrDirFormat()
3253
repo_bzrdir_format._network_name = response[5]
3254
repo_bzr = remote.RemoteBzrDir(transport.clone(repo_path),
3258
final_stack = response[8] or None
3259
final_stack_pwd = response[9] or None
3261
final_stack_pwd = urlutils.join(
3262
transport.base, final_stack_pwd)
3263
remote_repo = remote.RemoteRepository(repo_bzr, repo_format)
3264
if len(response) > 10:
3265
# Updated server verb that locks remotely.
3266
repo_lock_token = response[10] or None
3267
remote_repo.lock_write(repo_lock_token, _skip_rpc=True)
3269
remote_repo.dont_leave_lock_in_place()
3271
remote_repo.lock_write()
3272
policy = UseExistingRepository(remote_repo, final_stack,
3273
final_stack_pwd, require_stacking)
3274
policy.acquire_repository()
3278
bzrdir._format.set_branch_format(self.get_branch_format())
3279
if require_stacking:
3280
# The repo has already been created, but we need to make sure that
3281
# we'll make a stackable branch.
3282
bzrdir._format.require_stacking(_skip_repo=True)
3283
return remote_repo, bzrdir, require_stacking, policy
3285
def _open(self, transport):
3286
return remote.RemoteBzrDir(transport, self)
3288
def __eq__(self, other):
3289
if not isinstance(other, RemoteBzrDirFormat):
3291
return self.get_format_description() == other.get_format_description()
3293
def __return_repository_format(self):
3294
# Always return a RemoteRepositoryFormat object, but if a specific bzr
3295
# repository format has been asked for, tell the RemoteRepositoryFormat
3296
# that it should use that for init() etc.
3297
result = remote.RemoteRepositoryFormat()
3298
custom_format = getattr(self, '_repository_format', None)
3300
if isinstance(custom_format, remote.RemoteRepositoryFormat):
3301
return custom_format
3303
# We will use the custom format to create repositories over the
3304
# wire; expose its details like rich_root_data for code to
3306
result._custom_format = custom_format
3309
def get_branch_format(self):
3310
result = BzrDirMetaFormat1.get_branch_format(self)
3311
if not isinstance(result, remote.RemoteBranchFormat):
3312
new_result = remote.RemoteBranchFormat()
3313
new_result._custom_format = result
3315
self.set_branch_format(new_result)
3319
repository_format = property(__return_repository_format,
3320
BzrDirMetaFormat1._set_repository_format) #.im_func)
3323
BzrDirFormat.register_control_server_format(RemoteBzrDirFormat)
3326
class BzrDirFormatInfo(object):
3328
def __init__(self, native, deprecated, hidden, experimental):
3329
self.deprecated = deprecated
3330
self.native = native
3331
self.hidden = hidden
3332
self.experimental = experimental
3335
class BzrDirFormatRegistry(registry.Registry):
3336
"""Registry of user-selectable BzrDir subformats.
3338
Differs from BzrDirFormat._control_formats in that it provides sub-formats,
3339
e.g. BzrDirMeta1 with weave repository. Also, it's more user-oriented.
3343
"""Create a BzrDirFormatRegistry."""
3344
self._aliases = set()
3345
self._registration_order = list()
3346
super(BzrDirFormatRegistry, self).__init__()
3349
"""Return a set of the format names which are aliases."""
3350
return frozenset(self._aliases)
3352
def register_metadir(self, key,
3353
repository_format, help, native=True, deprecated=False,
3359
"""Register a metadir subformat.
3361
These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
3362
by the Repository/Branch/WorkingTreeformats.
3364
:param repository_format: The fully-qualified repository format class
3366
:param branch_format: Fully-qualified branch format class name as
3368
:param tree_format: Fully-qualified tree format class name as
3371
# This should be expanded to support setting WorkingTree and Branch
3372
# formats, once BzrDirMetaFormat1 supports that.
3373
def _load(full_name):
3374
mod_name, factory_name = full_name.rsplit('.', 1)
3376
mod = __import__(mod_name, globals(), locals(),
3378
except ImportError, e:
3379
raise ImportError('failed to load %s: %s' % (full_name, e))
3381
factory = getattr(mod, factory_name)
3382
except AttributeError:
3383
raise AttributeError('no factory %s in module %r'
3388
bd = BzrDirMetaFormat1()
3389
if branch_format is not None:
3390
bd.set_branch_format(_load(branch_format))
3391
if tree_format is not None:
3392
bd.workingtree_format = _load(tree_format)
3393
if repository_format is not None:
3394
bd.repository_format = _load(repository_format)
3396
self.register(key, helper, help, native, deprecated, hidden,
3397
experimental, alias)
3399
def register(self, key, factory, help, native=True, deprecated=False,
3400
hidden=False, experimental=False, alias=False):
3401
"""Register a BzrDirFormat factory.
3403
The factory must be a callable that takes one parameter: the key.
3404
It must produce an instance of the BzrDirFormat when called.
3406
This function mainly exists to prevent the info object from being
3409
registry.Registry.register(self, key, factory, help,
3410
BzrDirFormatInfo(native, deprecated, hidden, experimental))
3412
self._aliases.add(key)
3413
self._registration_order.append(key)
3415
def register_lazy(self, key, module_name, member_name, help, native=True,
3416
deprecated=False, hidden=False, experimental=False, alias=False):
3417
registry.Registry.register_lazy(self, key, module_name, member_name,
3418
help, BzrDirFormatInfo(native, deprecated, hidden, experimental))
3420
self._aliases.add(key)
3421
self._registration_order.append(key)
3423
def set_default(self, key):
3424
"""Set the 'default' key to be a clone of the supplied key.
3426
This method must be called once and only once.
3428
registry.Registry.register(self, 'default', self.get(key),
3429
self.get_help(key), info=self.get_info(key))
3430
self._aliases.add('default')
3432
def set_default_repository(self, key):
3433
"""Set the FormatRegistry default and Repository default.
3435
This is a transitional method while Repository.set_default_format
3438
if 'default' in self:
3439
self.remove('default')
3440
self.set_default(key)
3441
format = self.get('default')()
3443
def make_bzrdir(self, key):
3444
return self.get(key)()
3446
def help_topic(self, topic):
3448
default_realkey = None
3449
default_help = self.get_help('default')
3451
for key in self._registration_order:
3452
if key == 'default':
3454
help = self.get_help(key)
3455
if help == default_help:
3456
default_realkey = key
3458
help_pairs.append((key, help))
3460
def wrapped(key, help, info):
3462
help = '(native) ' + help
3463
return ':%s:\n%s\n\n' % (key,
3464
textwrap.fill(help, initial_indent=' ',
3465
subsequent_indent=' ',
3466
break_long_words=False))
3467
if default_realkey is not None:
3468
output += wrapped(default_realkey, '(default) %s' % default_help,
3469
self.get_info('default'))
3470
deprecated_pairs = []
3471
experimental_pairs = []
3472
for key, help in help_pairs:
3473
info = self.get_info(key)
3476
elif info.deprecated:
3477
deprecated_pairs.append((key, help))
3478
elif info.experimental:
3479
experimental_pairs.append((key, help))
3481
output += wrapped(key, help, info)
3482
output += "\nSee ``bzr help formats`` for more about storage formats."
3484
if len(experimental_pairs) > 0:
3485
other_output += "Experimental formats are shown below.\n\n"
3486
for key, help in experimental_pairs:
3487
info = self.get_info(key)
3488
other_output += wrapped(key, help, info)
3491
"No experimental formats are available.\n\n"
3492
if len(deprecated_pairs) > 0:
3493
other_output += "\nDeprecated formats are shown below.\n\n"
3494
for key, help in deprecated_pairs:
3495
info = self.get_info(key)
3496
other_output += wrapped(key, help, info)
3499
"\nNo deprecated formats are available.\n\n"
3501
"\nSee ``bzr help formats`` for more about storage formats."
3503
if topic == 'other-formats':
3509
class RepositoryAcquisitionPolicy(object):
3510
"""Abstract base class for repository acquisition policies.
3512
A repository acquisition policy decides how a BzrDir acquires a repository
3513
for a branch that is being created. The most basic policy decision is
3514
whether to create a new repository or use an existing one.
3516
def __init__(self, stack_on, stack_on_pwd, require_stacking):
3519
:param stack_on: A location to stack on
3520
:param stack_on_pwd: If stack_on is relative, the location it is
3522
:param require_stacking: If True, it is a failure to not stack.
3524
self._stack_on = stack_on
3525
self._stack_on_pwd = stack_on_pwd
3526
self._require_stacking = require_stacking
3528
def configure_branch(self, branch):
3529
"""Apply any configuration data from this policy to the branch.
3531
Default implementation sets repository stacking.
3533
if self._stack_on is None:
3535
if self._stack_on_pwd is None:
3536
stack_on = self._stack_on
3539
stack_on = urlutils.rebase_url(self._stack_on,
3541
branch.bzrdir.root_transport.base)
3542
except errors.InvalidRebaseURLs:
3543
stack_on = self._get_full_stack_on()
3545
branch.set_stacked_on_url(stack_on)
3546
except (errors.UnstackableBranchFormat,
3547
errors.UnstackableRepositoryFormat):
3548
if self._require_stacking:
3551
def _get_full_stack_on(self):
3552
"""Get a fully-qualified URL for the stack_on location."""
3553
if self._stack_on is None:
3555
if self._stack_on_pwd is None:
3556
return self._stack_on
3558
return urlutils.join(self._stack_on_pwd, self._stack_on)
3560
def _add_fallback(self, repository, possible_transports=None):
3561
"""Add a fallback to the supplied repository, if stacking is set."""
3562
stack_on = self._get_full_stack_on()
3563
if stack_on is None:
3566
stacked_dir = BzrDir.open(stack_on,
3567
possible_transports=possible_transports)
3568
except errors.JailBreak:
3569
# We keep the stacking details, but we are in the server code so
3570
# actually stacking is not needed.
3573
stacked_repo = stacked_dir.open_branch().repository
3574
except errors.NotBranchError:
3575
stacked_repo = stacked_dir.open_repository()
3577
repository.add_fallback_repository(stacked_repo)
3578
except errors.UnstackableRepositoryFormat:
3579
if self._require_stacking:
3582
self._require_stacking = True
3584
def acquire_repository(self, make_working_trees=None, shared=False):
3585
"""Acquire a repository for this bzrdir.
3587
Implementations may create a new repository or use a pre-exising
3589
:param make_working_trees: If creating a repository, set
3590
make_working_trees to this value (if non-None)
3591
:param shared: If creating a repository, make it shared if True
3592
:return: A repository, is_new_flag (True if the repository was
3595
raise NotImplemented(RepositoryAcquisitionPolicy.acquire_repository)
3598
class CreateRepository(RepositoryAcquisitionPolicy):
3599
"""A policy of creating a new repository"""
3601
def __init__(self, bzrdir, stack_on=None, stack_on_pwd=None,
3602
require_stacking=False):
3605
:param bzrdir: The bzrdir to create the repository on.
3606
:param stack_on: A location to stack on
3607
:param stack_on_pwd: If stack_on is relative, the location it is
3610
RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
3612
self._bzrdir = bzrdir
3614
def acquire_repository(self, make_working_trees=None, shared=False):
3615
"""Implementation of RepositoryAcquisitionPolicy.acquire_repository
3617
Creates the desired repository in the bzrdir we already have.
3619
stack_on = self._get_full_stack_on()
3621
format = self._bzrdir._format
3622
format.require_stacking(stack_on=stack_on,
3623
possible_transports=[self._bzrdir.root_transport])
3624
if not self._require_stacking:
3625
# We have picked up automatic stacking somewhere.
3626
note('Using default stacking branch %s at %s', self._stack_on,
3628
repository = self._bzrdir.create_repository(shared=shared)
3629
self._add_fallback(repository,
3630
possible_transports=[self._bzrdir.transport])
3631
if make_working_trees is not None:
3632
repository.set_make_working_trees(make_working_trees)
3633
return repository, True
3636
class UseExistingRepository(RepositoryAcquisitionPolicy):
3637
"""A policy of reusing an existing repository"""
3639
def __init__(self, repository, stack_on=None, stack_on_pwd=None,
3640
require_stacking=False):
3643
:param repository: The repository to use.
3644
:param stack_on: A location to stack on
3645
:param stack_on_pwd: If stack_on is relative, the location it is
3648
RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
3650
self._repository = repository
3652
def acquire_repository(self, make_working_trees=None, shared=False):
3653
"""Implementation of RepositoryAcquisitionPolicy.acquire_repository
3655
Returns an existing repository to use.
3657
self._add_fallback(self._repository,
3658
possible_transports=[self._repository.bzrdir.transport])
3659
return self._repository, False
3662
# Please register new formats after old formats so that formats
3663
# appear in chronological order and format descriptions can build
3665
format_registry = BzrDirFormatRegistry()
3666
# The pre-0.8 formats have their repository format network name registered in
3667
# repository.py. MetaDir formats have their repository format network name
3668
# inferred from their disk format string.
3669
format_registry.register('weave', BzrDirFormat6,
3670
'Pre-0.8 format. Slower than knit and does not'
3671
' support checkouts or shared repositories.',
3673
format_registry.register_metadir('metaweave',
3674
'bzrlib.repofmt.weaverepo.RepositoryFormat7',
3675
'Transitional format in 0.8. Slower than knit.',
3676
branch_format='bzrlib.branch.BzrBranchFormat5',
3677
tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3679
format_registry.register_metadir('knit',
3680
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3681
'Format using knits. Recommended for interoperation with bzr <= 0.14.',
3682
branch_format='bzrlib.branch.BzrBranchFormat5',
3683
tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3685
format_registry.register_metadir('dirstate',
3686
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3687
help='New in 0.15: Fast local operations. Compatible with bzr 0.8 and '
3688
'above when accessed over the network.',
3689
branch_format='bzrlib.branch.BzrBranchFormat5',
3690
# this uses bzrlib.workingtree.WorkingTreeFormat4 because importing
3691
# directly from workingtree_4 triggers a circular import.
3692
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3694
format_registry.register_metadir('dirstate-tags',
3695
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3696
help='New in 0.15: Fast local operations and improved scaling for '
3697
'network operations. Additionally adds support for tags.'
3698
' Incompatible with bzr < 0.15.',
3699
branch_format='bzrlib.branch.BzrBranchFormat6',
3700
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3702
format_registry.register_metadir('rich-root',
3703
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
3704
help='New in 1.0. Better handling of tree roots. Incompatible with'
3706
branch_format='bzrlib.branch.BzrBranchFormat6',
3707
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3709
format_registry.register_metadir('dirstate-with-subtree',
3710
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
3711
help='New in 0.15: Fast local operations and improved scaling for '
3712
'network operations. Additionally adds support for versioning nested '
3713
'bzr branches. Incompatible with bzr < 0.15.',
3714
branch_format='bzrlib.branch.BzrBranchFormat6',
3715
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3719
format_registry.register_metadir('pack-0.92',
3720
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack1',
3721
help='New in 0.92: Pack-based format with data compatible with '
3722
'dirstate-tags format repositories. Interoperates with '
3723
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3724
'Previously called knitpack-experimental. '
3725
'For more information, see '
3726
'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
3727
branch_format='bzrlib.branch.BzrBranchFormat6',
3728
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3730
format_registry.register_metadir('pack-0.92-subtree',
3731
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack3',
3732
help='New in 0.92: Pack-based format with data compatible with '
3733
'dirstate-with-subtree format repositories. Interoperates with '
3734
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3735
'Previously called knitpack-experimental. '
3736
'For more information, see '
3737
'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
3738
branch_format='bzrlib.branch.BzrBranchFormat6',
3739
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3743
format_registry.register_metadir('rich-root-pack',
3744
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
3745
help='New in 1.0: A variant of pack-0.92 that supports rich-root data '
3746
'(needed for bzr-svn and bzr-git).',
3747
branch_format='bzrlib.branch.BzrBranchFormat6',
3748
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3750
format_registry.register_metadir('1.6',
3751
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5',
3752
help='A format that allows a branch to indicate that there is another '
3753
'(stacked) repository that should be used to access data that is '
3754
'not present locally.',
3755
branch_format='bzrlib.branch.BzrBranchFormat7',
3756
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3758
format_registry.register_metadir('1.6.1-rich-root',
3759
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5RichRoot',
3760
help='A variant of 1.6 that supports rich-root data '
3761
'(needed for bzr-svn and bzr-git).',
3762
branch_format='bzrlib.branch.BzrBranchFormat7',
3763
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3765
format_registry.register_metadir('1.9',
3766
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3767
help='A repository format using B+tree indexes. These indexes '
3768
'are smaller in size, have smarter caching and provide faster '
3769
'performance for most operations.',
3770
branch_format='bzrlib.branch.BzrBranchFormat7',
3771
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3773
format_registry.register_metadir('1.9-rich-root',
3774
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
3775
help='A variant of 1.9 that supports rich-root data '
3776
'(needed for bzr-svn and bzr-git).',
3777
branch_format='bzrlib.branch.BzrBranchFormat7',
3778
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3780
format_registry.register_metadir('1.14',
3781
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3782
help='A working-tree format that supports content filtering.',
3783
branch_format='bzrlib.branch.BzrBranchFormat7',
3784
tree_format='bzrlib.workingtree.WorkingTreeFormat5',
3786
format_registry.register_metadir('1.14-rich-root',
3787
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
3788
help='A variant of 1.14 that supports rich-root data '
3789
'(needed for bzr-svn and bzr-git).',
3790
branch_format='bzrlib.branch.BzrBranchFormat7',
3791
tree_format='bzrlib.workingtree.WorkingTreeFormat5',
3793
# The following un-numbered 'development' formats should always just be aliases.
3794
format_registry.register_metadir('development-rich-root',
3795
'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
3796
help='Current development format. Supports rich roots. Can convert data '
3797
'to and from rich-root-pack (and anything compatible with '
3798
'rich-root-pack) format repositories. Repositories and branches in '
3799
'this format can only be read by bzr.dev. Please read '
3800
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3802
branch_format='bzrlib.branch.BzrBranchFormat7',
3803
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3807
format_registry.register_metadir('development-subtree',
3808
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment2Subtree',
3809
help='Current development format, subtree variant. Can convert data to and '
3810
'from pack-0.92-subtree (and anything compatible with '
3811
'pack-0.92-subtree) format repositories. Repositories and branches in '
3812
'this format can only be read by bzr.dev. Please read '
3813
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3815
branch_format='bzrlib.branch.BzrBranchFormat7',
3816
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3818
alias=False, # Restore to being an alias when an actual development subtree format is added
3819
# This current non-alias status is simply because we did not introduce a
3820
# chk based subtree format.
3823
# And the development formats above will have aliased one of the following:
3824
format_registry.register_metadir('development6-rich-root',
3825
'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
3826
help='pack-1.9 with 255-way hashed CHK inv, group compress, rich roots '
3828
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3830
branch_format='bzrlib.branch.BzrBranchFormat7',
3831
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3836
format_registry.register_metadir('development7-rich-root',
3837
'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK2',
3838
help='pack-1.9 with 255-way hashed CHK inv, bencode revision, group compress, '
3839
'rich roots. Please read '
3840
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3842
branch_format='bzrlib.branch.BzrBranchFormat7',
3843
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3848
format_registry.register_metadir('2a',
3849
'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
3850
help='First format for bzr 2.0 series.\n'
3851
'Uses group-compress storage.\n'
3852
'Provides rich roots which are a one-way transition.\n',
3853
# 'storage in packs, 255-way hashed CHK inventory, bencode revision, group compress, '
3854
# 'rich roots. Supported by bzr 1.16 and later.',
3855
branch_format='bzrlib.branch.BzrBranchFormat7',
3856
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3860
# The following format should be an alias for the rich root equivalent
3861
# of the default format
3862
format_registry.register_metadir('default-rich-root',
3863
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
3864
help='Default format, rich root variant. (needed for bzr-svn and bzr-git).',
3865
branch_format='bzrlib.branch.BzrBranchFormat6',
3866
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3869
# The current format that is made on 'bzr init'.
3870
format_registry.set_default('pack-0.92')
added
removed
bzrlib/bzrdir.py
