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,
73
remote as remote_transport,
75
from bzrlib.weave import Weave
78
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,
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
result = self.open_workingtree(recommend_upgrade=False)
1390
except errors.NoSuchFile:
1391
result = self._init_workingtree()
1392
if revision_id is not None:
1393
if revision_id == _mod_revision.NULL_REVISION:
1394
result.set_parent_ids([])
1396
result.set_parent_ids([revision_id])
1399
def _init_workingtree(self):
1400
from bzrlib.workingtree import WorkingTreeFormat2
1402
return WorkingTreeFormat2().initialize(self)
1403
except errors.NotLocalUrl:
1404
# Even though we can't access the working tree, we need to
1405
# create its control files.
1406
return WorkingTreeFormat2()._stub_initialize_on_transport(
1407
self.transport, self._control_files._file_mode)
1409
def destroy_workingtree(self):
1410
"""See BzrDir.destroy_workingtree."""
1411
raise errors.UnsupportedOperation(self.destroy_workingtree, self)
1413
def destroy_workingtree_metadata(self):
1414
"""See BzrDir.destroy_workingtree_metadata."""
1415
raise errors.UnsupportedOperation(self.destroy_workingtree_metadata,
1418
def get_branch_transport(self, branch_format):
1419
"""See BzrDir.get_branch_transport()."""
1420
if branch_format is None:
1421
return self.transport
1423
branch_format.get_format_string()
1424
except NotImplementedError:
1425
return self.transport
1426
raise errors.IncompatibleFormat(branch_format, self._format)
1428
def get_repository_transport(self, repository_format):
1429
"""See BzrDir.get_repository_transport()."""
1430
if repository_format is None:
1431
return self.transport
1433
repository_format.get_format_string()
1434
except NotImplementedError:
1435
return self.transport
1436
raise errors.IncompatibleFormat(repository_format, self._format)
1438
def get_workingtree_transport(self, workingtree_format):
1439
"""See BzrDir.get_workingtree_transport()."""
1440
if workingtree_format is None:
1441
return self.transport
1443
workingtree_format.get_format_string()
1444
except NotImplementedError:
1445
return self.transport
1446
raise errors.IncompatibleFormat(workingtree_format, self._format)
1448
def needs_format_conversion(self, format=None):
1449
"""See BzrDir.needs_format_conversion()."""
1450
# if the format is not the same as the system default,
1451
# an upgrade is needed.
1453
symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1454
% 'needs_format_conversion(format=None)')
1455
format = BzrDirFormat.get_default_format()
1456
return not isinstance(self._format, format.__class__)
1458
def open_branch(self, unsupported=False, ignore_fallbacks=False):
1459
"""See BzrDir.open_branch."""
1460
from bzrlib.branch import BzrBranchFormat4
1461
format = BzrBranchFormat4()
1462
self._check_supported(format, unsupported)
1463
return format.open(self, _found=True)
1465
def sprout(self, url, revision_id=None, force_new_repo=False,
1466
possible_transports=None, accelerator_tree=None,
1467
hardlink=False, stacked=False, create_tree_if_local=True,
1468
source_branch=None):
1469
"""See BzrDir.sprout()."""
1470
if source_branch is not None:
1471
my_branch = self.open_branch()
1472
if source_branch.base != my_branch.base:
1473
raise AssertionError(
1474
"source branch %r is not within %r with branch %r" %
1475
(source_branch, self, my_branch))
1477
raise errors.UnstackableBranchFormat(
1478
self._format, self.root_transport.base)
1479
if not create_tree_if_local:
1480
raise errors.MustHaveWorkingTree(
1481
self._format, self.root_transport.base)
1482
from bzrlib.workingtree import WorkingTreeFormat2
1483
self._make_tail(url)
1484
result = self._format._initialize_for_clone(url)
1486
self.open_repository().clone(result, revision_id=revision_id)
1487
except errors.NoRepositoryPresent:
1490
self.open_branch().sprout(result, revision_id=revision_id)
1491
except errors.NotBranchError:
1494
# we always want a working tree
1495
WorkingTreeFormat2().initialize(result,
1496
accelerator_tree=accelerator_tree,
1501
class BzrDir4(BzrDirPreSplitOut):
1502
"""A .bzr version 4 control object.
1504
This is a deprecated format and may be removed after sept 2006.
1507
def create_repository(self, shared=False):
1508
"""See BzrDir.create_repository."""
1509
return self._format.repository_format.initialize(self, shared)
1511
def needs_format_conversion(self, format=None):
1512
"""Format 4 dirs are always in need of conversion."""
1514
symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1515
% 'needs_format_conversion(format=None)')
1518
def open_repository(self):
1519
"""See BzrDir.open_repository."""
1520
from bzrlib.repofmt.weaverepo import RepositoryFormat4
1521
return RepositoryFormat4().open(self, _found=True)
1524
class BzrDir5(BzrDirPreSplitOut):
1525
"""A .bzr version 5 control object.
1527
This is a deprecated format and may be removed after sept 2006.
1530
def open_repository(self):
1531
"""See BzrDir.open_repository."""
1532
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1533
return RepositoryFormat5().open(self, _found=True)
1535
def open_workingtree(self, _unsupported=False,
1536
recommend_upgrade=True):
1537
"""See BzrDir.create_workingtree."""
1538
from bzrlib.workingtree import WorkingTreeFormat2
1539
wt_format = WorkingTreeFormat2()
1540
# we don't warn here about upgrades; that ought to be handled for the
1542
return wt_format.open(self, _found=True)
1545
class BzrDir6(BzrDirPreSplitOut):
1546
"""A .bzr version 6 control object.
1548
This is a deprecated format and may be removed after sept 2006.
1551
def open_repository(self):
1552
"""See BzrDir.open_repository."""
1553
from bzrlib.repofmt.weaverepo import RepositoryFormat6
1554
return RepositoryFormat6().open(self, _found=True)
1556
def open_workingtree(self, _unsupported=False,
1557
recommend_upgrade=True):
1558
"""See BzrDir.create_workingtree."""
1559
# we don't warn here about upgrades; that ought to be handled for the
1561
from bzrlib.workingtree import WorkingTreeFormat2
1562
return WorkingTreeFormat2().open(self, _found=True)
1565
class BzrDirMeta1(BzrDir):
1566
"""A .bzr meta version 1 control object.
1568
This is the first control object where the
1569
individual aspects are really split out: there are separate repository,
1570
workingtree and branch subdirectories and any subset of the three can be
1571
present within a BzrDir.
1574
def can_convert_format(self):
1575
"""See BzrDir.can_convert_format()."""
1578
def create_branch(self):
1579
"""See BzrDir.create_branch."""
1580
return self._format.get_branch_format().initialize(self)
1582
def destroy_branch(self):
1583
"""See BzrDir.create_branch."""
1584
self.transport.delete_tree('branch')
1586
def create_repository(self, shared=False):
1587
"""See BzrDir.create_repository."""
1588
return self._format.repository_format.initialize(self, shared)
1590
def destroy_repository(self):
1591
"""See BzrDir.destroy_repository."""
1592
self.transport.delete_tree('repository')
1594
def create_workingtree(self, revision_id=None, from_branch=None,
1595
accelerator_tree=None, hardlink=False):
1596
"""See BzrDir.create_workingtree."""
1597
return self._format.workingtree_format.initialize(
1598
self, revision_id, from_branch=from_branch,
1599
accelerator_tree=accelerator_tree, hardlink=hardlink)
1601
def destroy_workingtree(self):
1602
"""See BzrDir.destroy_workingtree."""
1603
wt = self.open_workingtree(recommend_upgrade=False)
1604
repository = wt.branch.repository
1605
empty = repository.revision_tree(_mod_revision.NULL_REVISION)
1606
wt.revert(old_tree=empty)
1607
self.destroy_workingtree_metadata()
1609
def destroy_workingtree_metadata(self):
1610
self.transport.delete_tree('checkout')
1612
def find_branch_format(self):
1613
"""Find the branch 'format' for this bzrdir.
1615
This might be a synthetic object for e.g. RemoteBranch and SVN.
1617
from bzrlib.branch import BranchFormat
1618
return BranchFormat.find_format(self)
1620
def _get_mkdir_mode(self):
1621
"""Figure out the mode to use when creating a bzrdir subdir."""
1622
temp_control = lockable_files.LockableFiles(self.transport, '',
1623
lockable_files.TransportLock)
1624
return temp_control._dir_mode
1626
def get_branch_reference(self):
1627
"""See BzrDir.get_branch_reference()."""
1628
from bzrlib.branch import BranchFormat
1629
format = BranchFormat.find_format(self)
1630
return format.get_reference(self)
1632
def get_branch_transport(self, branch_format):
1633
"""See BzrDir.get_branch_transport()."""
1634
if branch_format is None:
1635
return self.transport.clone('branch')
1637
branch_format.get_format_string()
1638
except NotImplementedError:
1639
raise errors.IncompatibleFormat(branch_format, self._format)
1641
self.transport.mkdir('branch', mode=self._get_mkdir_mode())
1642
except errors.FileExists:
1644
return self.transport.clone('branch')
1646
def get_repository_transport(self, repository_format):
1647
"""See BzrDir.get_repository_transport()."""
1648
if repository_format is None:
1649
return self.transport.clone('repository')
1651
repository_format.get_format_string()
1652
except NotImplementedError:
1653
raise errors.IncompatibleFormat(repository_format, self._format)
1655
self.transport.mkdir('repository', mode=self._get_mkdir_mode())
1656
except errors.FileExists:
1658
return self.transport.clone('repository')
1660
def get_workingtree_transport(self, workingtree_format):
1661
"""See BzrDir.get_workingtree_transport()."""
1662
if workingtree_format is None:
1663
return self.transport.clone('checkout')
1665
workingtree_format.get_format_string()
1666
except NotImplementedError:
1667
raise errors.IncompatibleFormat(workingtree_format, self._format)
1669
self.transport.mkdir('checkout', mode=self._get_mkdir_mode())
1670
except errors.FileExists:
1672
return self.transport.clone('checkout')
1674
def needs_format_conversion(self, format=None):
1675
"""See BzrDir.needs_format_conversion()."""
1677
symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1678
% 'needs_format_conversion(format=None)')
1680
format = BzrDirFormat.get_default_format()
1681
if not isinstance(self._format, format.__class__):
1682
# it is not a meta dir format, conversion is needed.
1684
# we might want to push this down to the repository?
1686
if not isinstance(self.open_repository()._format,
1687
format.repository_format.__class__):
1688
# the repository needs an upgrade.
1690
except errors.NoRepositoryPresent:
1693
if not isinstance(self.open_branch()._format,
1694
format.get_branch_format().__class__):
1695
# the branch needs an upgrade.
1697
except errors.NotBranchError:
1700
my_wt = self.open_workingtree(recommend_upgrade=False)
1701
if not isinstance(my_wt._format,
1702
format.workingtree_format.__class__):
1703
# the workingtree needs an upgrade.
1705
except (errors.NoWorkingTree, errors.NotLocalUrl):
1709
def open_branch(self, unsupported=False, ignore_fallbacks=False):
1710
"""See BzrDir.open_branch."""
1711
format = self.find_branch_format()
1712
self._check_supported(format, unsupported)
1713
return format.open(self, _found=True, ignore_fallbacks=ignore_fallbacks)
1715
def open_repository(self, unsupported=False):
1716
"""See BzrDir.open_repository."""
1717
from bzrlib.repository import RepositoryFormat
1718
format = RepositoryFormat.find_format(self)
1719
self._check_supported(format, unsupported)
1720
return format.open(self, _found=True)
1722
def open_workingtree(self, unsupported=False,
1723
recommend_upgrade=True):
1724
"""See BzrDir.open_workingtree."""
1725
from bzrlib.workingtree import WorkingTreeFormat
1726
format = WorkingTreeFormat.find_format(self)
1727
self._check_supported(format, unsupported,
1729
basedir=self.root_transport.base)
1730
return format.open(self, _found=True)
1732
def _get_config(self):
1733
return config.TransportConfig(self.transport, 'control.conf')
1736
class BzrDirFormat(object):
1737
"""An encapsulation of the initialization and open routines for a format.
1739
Formats provide three things:
1740
* An initialization routine,
1744
Formats are placed in a dict by their format string for reference
1745
during bzrdir opening. These should be subclasses of BzrDirFormat
1748
Once a format is deprecated, just deprecate the initialize and open
1749
methods on the format class. Do not deprecate the object, as the
1750
object will be created every system load.
1753
_default_format = None
1754
"""The default format used for new .bzr dirs."""
1757
"""The known formats."""
1759
_control_formats = []
1760
"""The registered control formats - .bzr, ....
1762
This is a list of BzrDirFormat objects.
1765
_control_server_formats = []
1766
"""The registered control server formats, e.g. RemoteBzrDirs.
1768
This is a list of BzrDirFormat objects.
1771
_lock_file_name = 'branch-lock'
1773
# _lock_class must be set in subclasses to the lock type, typ.
1774
# TransportLock or LockDir
1777
def find_format(klass, transport, _server_formats=True):
1778
"""Return the format present at transport."""
1780
formats = klass._control_server_formats + klass._control_formats
1782
formats = klass._control_formats
1783
for format in formats:
1785
return format.probe_transport(transport)
1786
except errors.NotBranchError:
1787
# this format does not find a control dir here.
1789
raise errors.NotBranchError(path=transport.base)
1792
def probe_transport(klass, transport):
1793
"""Return the .bzrdir style format present in a directory."""
1795
format_string = transport.get(".bzr/branch-format").read()
1796
except errors.NoSuchFile:
1797
raise errors.NotBranchError(path=transport.base)
1800
return klass._formats[format_string]
1802
raise errors.UnknownFormatError(format=format_string, kind='bzrdir')
1805
def get_default_format(klass):
1806
"""Return the current default format."""
1807
return klass._default_format
1809
def get_format_string(self):
1810
"""Return the ASCII format string that identifies this format."""
1811
raise NotImplementedError(self.get_format_string)
1813
def get_format_description(self):
1814
"""Return the short description for this format."""
1815
raise NotImplementedError(self.get_format_description)
1817
def get_converter(self, format=None):
1818
"""Return the converter to use to convert bzrdirs needing converts.
1820
This returns a bzrlib.bzrdir.Converter object.
1822
This should return the best upgrader to step this format towards the
1823
current default format. In the case of plugins we can/should provide
1824
some means for them to extend the range of returnable converters.
1826
:param format: Optional format to override the default format of the
1829
raise NotImplementedError(self.get_converter)
1831
def initialize(self, url, possible_transports=None):
1832
"""Create a bzr control dir at this url and return an opened copy.
1834
While not deprecated, this method is very specific and its use will
1835
lead to many round trips to setup a working environment. See
1836
initialize_on_transport_ex for a [nearly] all-in-one method.
1838
Subclasses should typically override initialize_on_transport
1839
instead of this method.
1841
return self.initialize_on_transport(get_transport(url,
1842
possible_transports))
1844
def initialize_on_transport(self, transport):
1845
"""Initialize a new bzrdir in the base directory of a Transport."""
1847
# can we hand off the request to the smart server rather than using
1849
client_medium = transport.get_smart_medium()
1850
except errors.NoSmartMedium:
1851
return self._initialize_on_transport_vfs(transport)
1853
# Current RPC's only know how to create bzr metadir1 instances, so
1854
# we still delegate to vfs methods if the requested format is not a
1856
if type(self) != BzrDirMetaFormat1:
1857
return self._initialize_on_transport_vfs(transport)
1858
remote_format = RemoteBzrDirFormat()
1859
self._supply_sub_formats_to(remote_format)
1860
return remote_format.initialize_on_transport(transport)
1862
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
1863
create_prefix=False, force_new_repo=False, stacked_on=None,
1864
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
1865
shared_repo=False, vfs_only=False):
1866
"""Create this format on transport.
1868
The directory to initialize will be created.
1870
:param force_new_repo: Do not use a shared repository for the target,
1871
even if one is available.
1872
:param create_prefix: Create any missing directories leading up to
1874
:param use_existing_dir: Use an existing directory if one exists.
1875
:param stacked_on: A url to stack any created branch on, None to follow
1876
any target stacking policy.
1877
:param stack_on_pwd: If stack_on is relative, the location it is
1879
:param repo_format_name: If non-None, a repository will be
1880
made-or-found. Should none be found, or if force_new_repo is True
1881
the repo_format_name is used to select the format of repository to
1883
:param make_working_trees: Control the setting of make_working_trees
1884
for a new shared repository when one is made. None to use whatever
1885
default the format has.
1886
:param shared_repo: Control whether made repositories are shared or
1888
:param vfs_only: If True do not attempt to use a smart server
1889
:return: repo, bzrdir, require_stacking, repository_policy. repo is
1890
None if none was created or found, bzrdir is always valid.
1891
require_stacking is the result of examining the stacked_on
1892
parameter and any stacking policy found for the target.
1895
# Try to hand off to a smart server
1897
client_medium = transport.get_smart_medium()
1898
except errors.NoSmartMedium:
1901
# TODO: lookup the local format from a server hint.
1902
remote_dir_format = RemoteBzrDirFormat()
1903
remote_dir_format._network_name = self.network_name()
1904
self._supply_sub_formats_to(remote_dir_format)
1905
return remote_dir_format.initialize_on_transport_ex(transport,
1906
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
1907
force_new_repo=force_new_repo, stacked_on=stacked_on,
1908
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
1909
make_working_trees=make_working_trees, shared_repo=shared_repo)
1910
# XXX: Refactor the create_prefix/no_create_prefix code into a
1911
# common helper function
1912
# The destination may not exist - if so make it according to policy.
1913
def make_directory(transport):
1914
transport.mkdir('.')
1916
def redirected(transport, e, redirection_notice):
1917
note(redirection_notice)
1918
return transport._redirected_to(e.source, e.target)
1920
transport = do_catching_redirections(make_directory, transport,
1922
except errors.FileExists:
1923
if not use_existing_dir:
1925
except errors.NoSuchFile:
1926
if not create_prefix:
1928
transport.create_prefix()
1930
require_stacking = (stacked_on is not None)
1931
# Now the target directory exists, but doesn't have a .bzr
1932
# directory. So we need to create it, along with any work to create
1933
# all of the dependent branches, etc.
1935
result = self.initialize_on_transport(transport)
1936
if repo_format_name:
1938
# use a custom format
1939
result._format.repository_format = \
1940
repository.network_format_registry.get(repo_format_name)
1941
except AttributeError:
1942
# The format didn't permit it to be set.
1944
# A repository is desired, either in-place or shared.
1945
repository_policy = result.determine_repository_policy(
1946
force_new_repo, stacked_on, stack_on_pwd,
1947
require_stacking=require_stacking)
1948
result_repo, is_new_repo = repository_policy.acquire_repository(
1949
make_working_trees, shared_repo)
1950
if not require_stacking and repository_policy._require_stacking:
1951
require_stacking = True
1952
result._format.require_stacking()
1953
result_repo.lock_write()
1956
repository_policy = None
1957
return result_repo, result, require_stacking, repository_policy
1959
def _initialize_on_transport_vfs(self, transport):
1960
"""Initialize a new bzrdir using VFS calls.
1962
:param transport: The transport to create the .bzr directory in.
1965
# Since we are creating a .bzr directory, inherit the
1966
# mode from the root directory
1967
temp_control = lockable_files.LockableFiles(transport,
1968
'', lockable_files.TransportLock)
1969
temp_control._transport.mkdir('.bzr',
1970
# FIXME: RBC 20060121 don't peek under
1972
mode=temp_control._dir_mode)
1973
if sys.platform == 'win32' and isinstance(transport, local.LocalTransport):
1974
win32utils.set_file_attr_hidden(transport._abspath('.bzr'))
1975
file_mode = temp_control._file_mode
1977
bzrdir_transport = transport.clone('.bzr')
1978
utf8_files = [('README',
1979
"This is a Bazaar control directory.\n"
1980
"Do not change any files in this directory.\n"
1981
"See http://bazaar-vcs.org/ for more information about Bazaar.\n"),
1982
('branch-format', self.get_format_string()),
1984
# NB: no need to escape relative paths that are url safe.
1985
control_files = lockable_files.LockableFiles(bzrdir_transport,
1986
self._lock_file_name, self._lock_class)
1987
control_files.create_lock()
1988
control_files.lock_write()
1990
for (filename, content) in utf8_files:
1991
bzrdir_transport.put_bytes(filename, content,
1994
control_files.unlock()
1995
return self.open(transport, _found=True)
1997
def is_supported(self):
1998
"""Is this format supported?
2000
Supported formats must be initializable and openable.
2001
Unsupported formats may not support initialization or committing or
2002
some other features depending on the reason for not being supported.
2006
def network_name(self):
2007
"""A simple byte string uniquely identifying this format for RPC calls.
2009
Bzr control formats use thir disk format string to identify the format
2010
over the wire. Its possible that other control formats have more
2011
complex detection requirements, so we permit them to use any unique and
2012
immutable string they desire.
2014
raise NotImplementedError(self.network_name)
2016
def same_model(self, target_format):
2017
return (self.repository_format.rich_root_data ==
2018
target_format.rich_root_data)
2021
def known_formats(klass):
2022
"""Return all the known formats.
2024
Concrete formats should override _known_formats.
2026
# There is double indirection here to make sure that control
2027
# formats used by more than one dir format will only be probed
2028
# once. This can otherwise be quite expensive for remote connections.
2030
for format in klass._control_formats:
2031
result.update(format._known_formats())
2035
def _known_formats(klass):
2036
"""Return the known format instances for this control format."""
2037
return set(klass._formats.values())
2039
def open(self, transport, _found=False):
2040
"""Return an instance of this format for the dir transport points at.
2042
_found is a private parameter, do not use it.
2045
found_format = BzrDirFormat.find_format(transport)
2046
if not isinstance(found_format, self.__class__):
2047
raise AssertionError("%s was asked to open %s, but it seems to need "
2049
% (self, transport, found_format))
2050
# Allow subclasses - use the found format.
2051
self._supply_sub_formats_to(found_format)
2052
return found_format._open(transport)
2053
return self._open(transport)
2055
def _open(self, transport):
2056
"""Template method helper for opening BzrDirectories.
2058
This performs the actual open and any additional logic or parameter
2061
raise NotImplementedError(self._open)
2064
def register_format(klass, format):
2065
klass._formats[format.get_format_string()] = format
2066
# bzr native formats have a network name of their format string.
2067
network_format_registry.register(format.get_format_string(), format.__class__)
2070
def register_control_format(klass, format):
2071
"""Register a format that does not use '.bzr' for its control dir.
2073
TODO: This should be pulled up into a 'ControlDirFormat' base class
2074
which BzrDirFormat can inherit from, and renamed to register_format
2075
there. It has been done without that for now for simplicity of
2078
klass._control_formats.append(format)
2081
def register_control_server_format(klass, format):
2082
"""Register a control format for client-server environments.
2084
These formats will be tried before ones registered with
2085
register_control_format. This gives implementations that decide to the
2086
chance to grab it before anything looks at the contents of the format
2089
klass._control_server_formats.append(format)
2092
def _set_default_format(klass, format):
2093
"""Set default format (for testing behavior of defaults only)"""
2094
klass._default_format = format
2098
return self.get_format_description().rstrip()
2100
def _supply_sub_formats_to(self, other_format):
2101
"""Give other_format the same values for sub formats as this has.
2103
This method is expected to be used when parameterising a
2104
RemoteBzrDirFormat instance with the parameters from a
2105
BzrDirMetaFormat1 instance.
2107
:param other_format: other_format is a format which should be
2108
compatible with whatever sub formats are supported by self.
2113
def unregister_format(klass, format):
2114
del klass._formats[format.get_format_string()]
2117
def unregister_control_format(klass, format):
2118
klass._control_formats.remove(format)
2121
class BzrDirFormat4(BzrDirFormat):
2122
"""Bzr dir format 4.
2124
This format is a combined format for working tree, branch and repository.
2126
- Format 1 working trees [always]
2127
- Format 4 branches [always]
2128
- Format 4 repositories [always]
2130
This format is deprecated: it indexes texts using a text it which is
2131
removed in format 5; write support for this format has been removed.
2134
_lock_class = lockable_files.TransportLock
2136
def get_format_string(self):
2137
"""See BzrDirFormat.get_format_string()."""
2138
return "Bazaar-NG branch, format 0.0.4\n"
2140
def get_format_description(self):
2141
"""See BzrDirFormat.get_format_description()."""
2142
return "All-in-one format 4"
2144
def get_converter(self, format=None):
2145
"""See BzrDirFormat.get_converter()."""
2146
# there is one and only one upgrade path here.
2147
return ConvertBzrDir4To5()
2149
def initialize_on_transport(self, transport):
2150
"""Format 4 branches cannot be created."""
2151
raise errors.UninitializableFormat(self)
2153
def is_supported(self):
2154
"""Format 4 is not supported.
2156
It is not supported because the model changed from 4 to 5 and the
2157
conversion logic is expensive - so doing it on the fly was not
2162
def network_name(self):
2163
return self.get_format_string()
2165
def _open(self, transport):
2166
"""See BzrDirFormat._open."""
2167
return BzrDir4(transport, self)
2169
def __return_repository_format(self):
2170
"""Circular import protection."""
2171
from bzrlib.repofmt.weaverepo import RepositoryFormat4
2172
return RepositoryFormat4()
2173
repository_format = property(__return_repository_format)
2176
class BzrDirFormatAllInOne(BzrDirFormat):
2177
"""Common class for formats before meta-dirs."""
2179
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
2180
create_prefix=False, force_new_repo=False, stacked_on=None,
2181
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
2183
"""See BzrDirFormat.initialize_on_transport_ex."""
2184
require_stacking = (stacked_on is not None)
2185
# Format 5 cannot stack, but we've been asked to - actually init
2187
if require_stacking:
2188
format = BzrDirMetaFormat1()
2189
return format.initialize_on_transport_ex(transport,
2190
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2191
force_new_repo=force_new_repo, stacked_on=stacked_on,
2192
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2193
make_working_trees=make_working_trees, shared_repo=shared_repo)
2194
return BzrDirFormat.initialize_on_transport_ex(self, 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)
2201
class BzrDirFormat5(BzrDirFormatAllInOne):
2202
"""Bzr control format 5.
2204
This format is a combined format for working tree, branch and repository.
2206
- Format 2 working trees [always]
2207
- Format 4 branches [always]
2208
- Format 5 repositories [always]
2209
Unhashed stores in the repository.
2212
_lock_class = lockable_files.TransportLock
2214
def get_format_string(self):
2215
"""See BzrDirFormat.get_format_string()."""
2216
return "Bazaar-NG branch, format 5\n"
2218
def get_branch_format(self):
2219
from bzrlib import branch
2220
return branch.BzrBranchFormat4()
2222
def get_format_description(self):
2223
"""See BzrDirFormat.get_format_description()."""
2224
return "All-in-one format 5"
2226
def get_converter(self, format=None):
2227
"""See BzrDirFormat.get_converter()."""
2228
# there is one and only one upgrade path here.
2229
return ConvertBzrDir5To6()
2231
def _initialize_for_clone(self, url):
2232
return self.initialize_on_transport(get_transport(url), _cloning=True)
2234
def initialize_on_transport(self, transport, _cloning=False):
2235
"""Format 5 dirs always have working tree, branch and repository.
2237
Except when they are being cloned.
2239
from bzrlib.branch import BzrBranchFormat4
2240
from bzrlib.repofmt.weaverepo import RepositoryFormat5
2241
result = (super(BzrDirFormat5, self).initialize_on_transport(transport))
2242
RepositoryFormat5().initialize(result, _internal=True)
2244
branch = BzrBranchFormat4().initialize(result)
2245
result._init_workingtree()
2248
def network_name(self):
2249
return self.get_format_string()
2251
def _open(self, transport):
2252
"""See BzrDirFormat._open."""
2253
return BzrDir5(transport, self)
2255
def __return_repository_format(self):
2256
"""Circular import protection."""
2257
from bzrlib.repofmt.weaverepo import RepositoryFormat5
2258
return RepositoryFormat5()
2259
repository_format = property(__return_repository_format)
2262
class BzrDirFormat6(BzrDirFormatAllInOne):
2263
"""Bzr control format 6.
2265
This format is a combined format for working tree, branch and repository.
2267
- Format 2 working trees [always]
2268
- Format 4 branches [always]
2269
- Format 6 repositories [always]
2272
_lock_class = lockable_files.TransportLock
2274
def get_format_string(self):
2275
"""See BzrDirFormat.get_format_string()."""
2276
return "Bazaar-NG branch, format 6\n"
2278
def get_format_description(self):
2279
"""See BzrDirFormat.get_format_description()."""
2280
return "All-in-one format 6"
2282
def get_branch_format(self):
2283
from bzrlib import branch
2284
return branch.BzrBranchFormat4()
2286
def get_converter(self, format=None):
2287
"""See BzrDirFormat.get_converter()."""
2288
# there is one and only one upgrade path here.
2289
return ConvertBzrDir6ToMeta()
2291
def _initialize_for_clone(self, url):
2292
return self.initialize_on_transport(get_transport(url), _cloning=True)
2294
def initialize_on_transport(self, transport, _cloning=False):
2295
"""Format 6 dirs always have working tree, branch and repository.
2297
Except when they are being cloned.
2299
from bzrlib.branch import BzrBranchFormat4
2300
from bzrlib.repofmt.weaverepo import RepositoryFormat6
2301
result = super(BzrDirFormat6, self).initialize_on_transport(transport)
2302
RepositoryFormat6().initialize(result, _internal=True)
2304
branch = BzrBranchFormat4().initialize(result)
2305
result._init_workingtree()
2308
def network_name(self):
2309
return self.get_format_string()
2311
def _open(self, transport):
2312
"""See BzrDirFormat._open."""
2313
return BzrDir6(transport, self)
2315
def __return_repository_format(self):
2316
"""Circular import protection."""
2317
from bzrlib.repofmt.weaverepo import RepositoryFormat6
2318
return RepositoryFormat6()
2319
repository_format = property(__return_repository_format)
2322
class BzrDirMetaFormat1(BzrDirFormat):
2323
"""Bzr meta control format 1
2325
This is the first format with split out working tree, branch and repository
2328
- Format 3 working trees [optional]
2329
- Format 5 branches [optional]
2330
- Format 7 repositories [optional]
2333
_lock_class = lockdir.LockDir
2336
self._workingtree_format = None
2337
self._branch_format = None
2338
self._repository_format = None
2340
def __eq__(self, other):
2341
if other.__class__ is not self.__class__:
2343
if other.repository_format != self.repository_format:
2345
if other.workingtree_format != self.workingtree_format:
2349
def __ne__(self, other):
2350
return not self == other
2352
def get_branch_format(self):
2353
if self._branch_format is None:
2354
from bzrlib.branch import BranchFormat
2355
self._branch_format = BranchFormat.get_default_format()
2356
return self._branch_format
2358
def set_branch_format(self, format):
2359
self._branch_format = format
2361
def require_stacking(self):
2362
if not self.get_branch_format().supports_stacking():
2363
# We need to make a stacked branch, but the default format for the
2364
# target doesn't support stacking. So force a branch that *can*
2366
from bzrlib.branch import BzrBranchFormat7
2367
branch_format = BzrBranchFormat7()
2368
self.set_branch_format(branch_format)
2369
mutter("using %r for stacking" % (branch_format,))
2370
from bzrlib.repofmt import pack_repo
2371
if self.repository_format.rich_root_data:
2372
bzrdir_format_name = '1.6.1-rich-root'
2373
repo_format = pack_repo.RepositoryFormatKnitPack5RichRoot()
2375
bzrdir_format_name = '1.6'
2376
repo_format = pack_repo.RepositoryFormatKnitPack5()
2377
note('Source format does not support stacking, using format:'
2379
bzrdir_format_name, repo_format.get_format_description())
2380
self.repository_format = repo_format
2382
def get_converter(self, format=None):
2383
"""See BzrDirFormat.get_converter()."""
2385
format = BzrDirFormat.get_default_format()
2386
if not isinstance(self, format.__class__):
2387
# converting away from metadir is not implemented
2388
raise NotImplementedError(self.get_converter)
2389
return ConvertMetaToMeta(format)
2391
def get_format_string(self):
2392
"""See BzrDirFormat.get_format_string()."""
2393
return "Bazaar-NG meta directory, format 1\n"
2395
def get_format_description(self):
2396
"""See BzrDirFormat.get_format_description()."""
2397
return "Meta directory format 1"
2399
def network_name(self):
2400
return self.get_format_string()
2402
def _open(self, transport):
2403
"""See BzrDirFormat._open."""
2404
# Create a new format instance because otherwise initialisation of new
2405
# metadirs share the global default format object leading to alias
2407
format = BzrDirMetaFormat1()
2408
self._supply_sub_formats_to(format)
2409
return BzrDirMeta1(transport, format)
2411
def __return_repository_format(self):
2412
"""Circular import protection."""
2413
if self._repository_format:
2414
return self._repository_format
2415
from bzrlib.repository import RepositoryFormat
2416
return RepositoryFormat.get_default_format()
2418
def _set_repository_format(self, value):
2419
"""Allow changing the repository format for metadir formats."""
2420
self._repository_format = value
2422
repository_format = property(__return_repository_format,
2423
_set_repository_format)
2425
def _supply_sub_formats_to(self, other_format):
2426
"""Give other_format the same values for sub formats as this has.
2428
This method is expected to be used when parameterising a
2429
RemoteBzrDirFormat instance with the parameters from a
2430
BzrDirMetaFormat1 instance.
2432
:param other_format: other_format is a format which should be
2433
compatible with whatever sub formats are supported by self.
2436
if getattr(self, '_repository_format', None) is not None:
2437
other_format.repository_format = self.repository_format
2438
if self._branch_format is not None:
2439
other_format._branch_format = self._branch_format
2440
if self._workingtree_format is not None:
2441
other_format.workingtree_format = self.workingtree_format
2443
def __get_workingtree_format(self):
2444
if self._workingtree_format is None:
2445
from bzrlib.workingtree import WorkingTreeFormat
2446
self._workingtree_format = WorkingTreeFormat.get_default_format()
2447
return self._workingtree_format
2449
def __set_workingtree_format(self, wt_format):
2450
self._workingtree_format = wt_format
2452
workingtree_format = property(__get_workingtree_format,
2453
__set_workingtree_format)
2456
network_format_registry = registry.FormatRegistry()
2457
"""Registry of formats indexed by their network name.
2459
The network name for a BzrDirFormat is an identifier that can be used when
2460
referring to formats with smart server operations. See
2461
BzrDirFormat.network_name() for more detail.
2465
# Register bzr control format
2466
BzrDirFormat.register_control_format(BzrDirFormat)
2468
# Register bzr formats
2469
BzrDirFormat.register_format(BzrDirFormat4())
2470
BzrDirFormat.register_format(BzrDirFormat5())
2471
BzrDirFormat.register_format(BzrDirFormat6())
2472
__default_format = BzrDirMetaFormat1()
2473
BzrDirFormat.register_format(__default_format)
2474
BzrDirFormat._default_format = __default_format
2477
class Converter(object):
2478
"""Converts a disk format object from one format to another."""
2480
def convert(self, to_convert, pb):
2481
"""Perform the conversion of to_convert, giving feedback via pb.
2483
:param to_convert: The disk object to convert.
2484
:param pb: a progress bar to use for progress information.
2487
def step(self, message):
2488
"""Update the pb by a step."""
2490
self.pb.update(message, self.count, self.total)
2493
class ConvertBzrDir4To5(Converter):
2494
"""Converts format 4 bzr dirs to format 5."""
2497
super(ConvertBzrDir4To5, self).__init__()
2498
self.converted_revs = set()
2499
self.absent_revisions = set()
2503
def convert(self, to_convert, pb):
2504
"""See Converter.convert()."""
2505
self.bzrdir = to_convert
2507
self.pb.note('starting upgrade from format 4 to 5')
2508
if isinstance(self.bzrdir.transport, local.LocalTransport):
2509
self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
2510
self._convert_to_weaves()
2511
return BzrDir.open(self.bzrdir.root_transport.base)
2513
def _convert_to_weaves(self):
2514
self.pb.note('note: upgrade may be faster if all store files are ungzipped first')
2517
stat = self.bzrdir.transport.stat('weaves')
2518
if not S_ISDIR(stat.st_mode):
2519
self.bzrdir.transport.delete('weaves')
2520
self.bzrdir.transport.mkdir('weaves')
2521
except errors.NoSuchFile:
2522
self.bzrdir.transport.mkdir('weaves')
2523
# deliberately not a WeaveFile as we want to build it up slowly.
2524
self.inv_weave = Weave('inventory')
2525
# holds in-memory weaves for all files
2526
self.text_weaves = {}
2527
self.bzrdir.transport.delete('branch-format')
2528
self.branch = self.bzrdir.open_branch()
2529
self._convert_working_inv()
2530
rev_history = self.branch.revision_history()
2531
# to_read is a stack holding the revisions we still need to process;
2532
# appending to it adds new highest-priority revisions
2533
self.known_revisions = set(rev_history)
2534
self.to_read = rev_history[-1:]
2536
rev_id = self.to_read.pop()
2537
if (rev_id not in self.revisions
2538
and rev_id not in self.absent_revisions):
2539
self._load_one_rev(rev_id)
2541
to_import = self._make_order()
2542
for i, rev_id in enumerate(to_import):
2543
self.pb.update('converting revision', i, len(to_import))
2544
self._convert_one_rev(rev_id)
2546
self._write_all_weaves()
2547
self._write_all_revs()
2548
self.pb.note('upgraded to weaves:')
2549
self.pb.note(' %6d revisions and inventories', len(self.revisions))
2550
self.pb.note(' %6d revisions not present', len(self.absent_revisions))
2551
self.pb.note(' %6d texts', self.text_count)
2552
self._cleanup_spare_files_after_format4()
2553
self.branch._transport.put_bytes(
2555
BzrDirFormat5().get_format_string(),
2556
mode=self.bzrdir._get_file_mode())
2558
def _cleanup_spare_files_after_format4(self):
2559
# FIXME working tree upgrade foo.
2560
for n in 'merged-patches', 'pending-merged-patches':
2562
## assert os.path.getsize(p) == 0
2563
self.bzrdir.transport.delete(n)
2564
except errors.NoSuchFile:
2566
self.bzrdir.transport.delete_tree('inventory-store')
2567
self.bzrdir.transport.delete_tree('text-store')
2569
def _convert_working_inv(self):
2570
inv = xml4.serializer_v4.read_inventory(
2571
self.branch._transport.get('inventory'))
2572
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv, working=True)
2573
self.branch._transport.put_bytes('inventory', new_inv_xml,
2574
mode=self.bzrdir._get_file_mode())
2576
def _write_all_weaves(self):
2577
controlweaves = WeaveStore(self.bzrdir.transport, prefixed=False)
2578
weave_transport = self.bzrdir.transport.clone('weaves')
2579
weaves = WeaveStore(weave_transport, prefixed=False)
2580
transaction = WriteTransaction()
2584
for file_id, file_weave in self.text_weaves.items():
2585
self.pb.update('writing weave', i, len(self.text_weaves))
2586
weaves._put_weave(file_id, file_weave, transaction)
2588
self.pb.update('inventory', 0, 1)
2589
controlweaves._put_weave('inventory', self.inv_weave, transaction)
2590
self.pb.update('inventory', 1, 1)
2594
def _write_all_revs(self):
2595
"""Write all revisions out in new form."""
2596
self.bzrdir.transport.delete_tree('revision-store')
2597
self.bzrdir.transport.mkdir('revision-store')
2598
revision_transport = self.bzrdir.transport.clone('revision-store')
2600
from bzrlib.xml5 import serializer_v5
2601
from bzrlib.repofmt.weaverepo import RevisionTextStore
2602
revision_store = RevisionTextStore(revision_transport,
2603
serializer_v5, False, versionedfile.PrefixMapper(),
2604
lambda:True, lambda:True)
2606
for i, rev_id in enumerate(self.converted_revs):
2607
self.pb.update('write revision', i, len(self.converted_revs))
2608
text = serializer_v5.write_revision_to_string(
2609
self.revisions[rev_id])
2611
revision_store.add_lines(key, None, osutils.split_lines(text))
2615
def _load_one_rev(self, rev_id):
2616
"""Load a revision object into memory.
2618
Any parents not either loaded or abandoned get queued to be
2620
self.pb.update('loading revision',
2621
len(self.revisions),
2622
len(self.known_revisions))
2623
if not self.branch.repository.has_revision(rev_id):
2625
self.pb.note('revision {%s} not present in branch; '
2626
'will be converted as a ghost',
2628
self.absent_revisions.add(rev_id)
2630
rev = self.branch.repository.get_revision(rev_id)
2631
for parent_id in rev.parent_ids:
2632
self.known_revisions.add(parent_id)
2633
self.to_read.append(parent_id)
2634
self.revisions[rev_id] = rev
2636
def _load_old_inventory(self, rev_id):
2637
old_inv_xml = self.branch.repository.inventory_store.get(rev_id).read()
2638
inv = xml4.serializer_v4.read_inventory_from_string(old_inv_xml)
2639
inv.revision_id = rev_id
2640
rev = self.revisions[rev_id]
2643
def _load_updated_inventory(self, rev_id):
2644
inv_xml = self.inv_weave.get_text(rev_id)
2645
inv = xml5.serializer_v5.read_inventory_from_string(inv_xml, rev_id)
2648
def _convert_one_rev(self, rev_id):
2649
"""Convert revision and all referenced objects to new format."""
2650
rev = self.revisions[rev_id]
2651
inv = self._load_old_inventory(rev_id)
2652
present_parents = [p for p in rev.parent_ids
2653
if p not in self.absent_revisions]
2654
self._convert_revision_contents(rev, inv, present_parents)
2655
self._store_new_inv(rev, inv, present_parents)
2656
self.converted_revs.add(rev_id)
2658
def _store_new_inv(self, rev, inv, present_parents):
2659
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
2660
new_inv_sha1 = sha_string(new_inv_xml)
2661
self.inv_weave.add_lines(rev.revision_id,
2663
new_inv_xml.splitlines(True))
2664
rev.inventory_sha1 = new_inv_sha1
2666
def _convert_revision_contents(self, rev, inv, present_parents):
2667
"""Convert all the files within a revision.
2669
Also upgrade the inventory to refer to the text revision ids."""
2670
rev_id = rev.revision_id
2671
mutter('converting texts of revision {%s}',
2673
parent_invs = map(self._load_updated_inventory, present_parents)
2674
entries = inv.iter_entries()
2676
for path, ie in entries:
2677
self._convert_file_version(rev, ie, parent_invs)
2679
def _convert_file_version(self, rev, ie, parent_invs):
2680
"""Convert one version of one file.
2682
The file needs to be added into the weave if it is a merge
2683
of >=2 parents or if it's changed from its parent.
2685
file_id = ie.file_id
2686
rev_id = rev.revision_id
2687
w = self.text_weaves.get(file_id)
2690
self.text_weaves[file_id] = w
2691
text_changed = False
2692
parent_candiate_entries = ie.parent_candidates(parent_invs)
2693
heads = graph.Graph(self).heads(parent_candiate_entries.keys())
2694
# XXX: Note that this is unordered - and this is tolerable because
2695
# the previous code was also unordered.
2696
previous_entries = dict((head, parent_candiate_entries[head]) for head
2698
self.snapshot_ie(previous_entries, ie, w, rev_id)
2701
def get_parent_map(self, revision_ids):
2702
"""See graph._StackedParentsProvider.get_parent_map"""
2703
return dict((revision_id, self.revisions[revision_id])
2704
for revision_id in revision_ids
2705
if revision_id in self.revisions)
2707
def snapshot_ie(self, previous_revisions, ie, w, rev_id):
2708
# TODO: convert this logic, which is ~= snapshot to
2709
# a call to:. This needs the path figured out. rather than a work_tree
2710
# a v4 revision_tree can be given, or something that looks enough like
2711
# one to give the file content to the entry if it needs it.
2712
# and we need something that looks like a weave store for snapshot to
2714
#ie.snapshot(rev, PATH, previous_revisions, REVISION_TREE, InMemoryWeaveStore(self.text_weaves))
2715
if len(previous_revisions) == 1:
2716
previous_ie = previous_revisions.values()[0]
2717
if ie._unchanged(previous_ie):
2718
ie.revision = previous_ie.revision
2721
text = self.branch.repository._text_store.get(ie.text_id)
2722
file_lines = text.readlines()
2723
w.add_lines(rev_id, previous_revisions, file_lines)
2724
self.text_count += 1
2726
w.add_lines(rev_id, previous_revisions, [])
2727
ie.revision = rev_id
2729
def _make_order(self):
2730
"""Return a suitable order for importing revisions.
2732
The order must be such that an revision is imported after all
2733
its (present) parents.
2735
todo = set(self.revisions.keys())
2736
done = self.absent_revisions.copy()
2739
# scan through looking for a revision whose parents
2741
for rev_id in sorted(list(todo)):
2742
rev = self.revisions[rev_id]
2743
parent_ids = set(rev.parent_ids)
2744
if parent_ids.issubset(done):
2745
# can take this one now
2746
order.append(rev_id)
2752
class ConvertBzrDir5To6(Converter):
2753
"""Converts format 5 bzr dirs to format 6."""
2755
def convert(self, to_convert, pb):
2756
"""See Converter.convert()."""
2757
self.bzrdir = to_convert
2759
self.pb.note('starting upgrade from format 5 to 6')
2760
self._convert_to_prefixed()
2761
return BzrDir.open(self.bzrdir.root_transport.base)
2763
def _convert_to_prefixed(self):
2764
from bzrlib.store import TransportStore
2765
self.bzrdir.transport.delete('branch-format')
2766
for store_name in ["weaves", "revision-store"]:
2767
self.pb.note("adding prefixes to %s" % store_name)
2768
store_transport = self.bzrdir.transport.clone(store_name)
2769
store = TransportStore(store_transport, prefixed=True)
2770
for urlfilename in store_transport.list_dir('.'):
2771
filename = urlutils.unescape(urlfilename)
2772
if (filename.endswith(".weave") or
2773
filename.endswith(".gz") or
2774
filename.endswith(".sig")):
2775
file_id, suffix = os.path.splitext(filename)
2779
new_name = store._mapper.map((file_id,)) + suffix
2780
# FIXME keep track of the dirs made RBC 20060121
2782
store_transport.move(filename, new_name)
2783
except errors.NoSuchFile: # catches missing dirs strangely enough
2784
store_transport.mkdir(osutils.dirname(new_name))
2785
store_transport.move(filename, new_name)
2786
self.bzrdir.transport.put_bytes(
2788
BzrDirFormat6().get_format_string(),
2789
mode=self.bzrdir._get_file_mode())
2792
class ConvertBzrDir6ToMeta(Converter):
2793
"""Converts format 6 bzr dirs to metadirs."""
2795
def convert(self, to_convert, pb):
2796
"""See Converter.convert()."""
2797
from bzrlib.repofmt.weaverepo import RepositoryFormat7
2798
from bzrlib.branch import BzrBranchFormat5
2799
self.bzrdir = to_convert
2802
self.total = 20 # the steps we know about
2803
self.garbage_inventories = []
2804
self.dir_mode = self.bzrdir._get_dir_mode()
2805
self.file_mode = self.bzrdir._get_file_mode()
2807
self.pb.note('starting upgrade from format 6 to metadir')
2808
self.bzrdir.transport.put_bytes(
2810
"Converting to format 6",
2811
mode=self.file_mode)
2812
# its faster to move specific files around than to open and use the apis...
2813
# first off, nuke ancestry.weave, it was never used.
2815
self.step('Removing ancestry.weave')
2816
self.bzrdir.transport.delete('ancestry.weave')
2817
except errors.NoSuchFile:
2819
# find out whats there
2820
self.step('Finding branch files')
2821
last_revision = self.bzrdir.open_branch().last_revision()
2822
bzrcontents = self.bzrdir.transport.list_dir('.')
2823
for name in bzrcontents:
2824
if name.startswith('basis-inventory.'):
2825
self.garbage_inventories.append(name)
2826
# create new directories for repository, working tree and branch
2827
repository_names = [('inventory.weave', True),
2828
('revision-store', True),
2830
self.step('Upgrading repository ')
2831
self.bzrdir.transport.mkdir('repository', mode=self.dir_mode)
2832
self.make_lock('repository')
2833
# we hard code the formats here because we are converting into
2834
# the meta format. The meta format upgrader can take this to a
2835
# future format within each component.
2836
self.put_format('repository', RepositoryFormat7())
2837
for entry in repository_names:
2838
self.move_entry('repository', entry)
2840
self.step('Upgrading branch ')
2841
self.bzrdir.transport.mkdir('branch', mode=self.dir_mode)
2842
self.make_lock('branch')
2843
self.put_format('branch', BzrBranchFormat5())
2844
branch_files = [('revision-history', True),
2845
('branch-name', True),
2847
for entry in branch_files:
2848
self.move_entry('branch', entry)
2850
checkout_files = [('pending-merges', True),
2851
('inventory', True),
2852
('stat-cache', False)]
2853
# If a mandatory checkout file is not present, the branch does not have
2854
# a functional checkout. Do not create a checkout in the converted
2856
for name, mandatory in checkout_files:
2857
if mandatory and name not in bzrcontents:
2858
has_checkout = False
2862
if not has_checkout:
2863
self.pb.note('No working tree.')
2864
# If some checkout files are there, we may as well get rid of them.
2865
for name, mandatory in checkout_files:
2866
if name in bzrcontents:
2867
self.bzrdir.transport.delete(name)
2869
from bzrlib.workingtree import WorkingTreeFormat3
2870
self.step('Upgrading working tree')
2871
self.bzrdir.transport.mkdir('checkout', mode=self.dir_mode)
2872
self.make_lock('checkout')
2874
'checkout', WorkingTreeFormat3())
2875
self.bzrdir.transport.delete_multi(
2876
self.garbage_inventories, self.pb)
2877
for entry in checkout_files:
2878
self.move_entry('checkout', entry)
2879
if last_revision is not None:
2880
self.bzrdir.transport.put_bytes(
2881
'checkout/last-revision', last_revision)
2882
self.bzrdir.transport.put_bytes(
2884
BzrDirMetaFormat1().get_format_string(),
2885
mode=self.file_mode)
2886
return BzrDir.open(self.bzrdir.root_transport.base)
2888
def make_lock(self, name):
2889
"""Make a lock for the new control dir name."""
2890
self.step('Make %s lock' % name)
2891
ld = lockdir.LockDir(self.bzrdir.transport,
2893
file_modebits=self.file_mode,
2894
dir_modebits=self.dir_mode)
2897
def move_entry(self, new_dir, entry):
2898
"""Move then entry name into new_dir."""
2900
mandatory = entry[1]
2901
self.step('Moving %s' % name)
2903
self.bzrdir.transport.move(name, '%s/%s' % (new_dir, name))
2904
except errors.NoSuchFile:
2908
def put_format(self, dirname, format):
2909
self.bzrdir.transport.put_bytes('%s/format' % dirname,
2910
format.get_format_string(),
2914
class ConvertMetaToMeta(Converter):
2915
"""Converts the components of metadirs."""
2917
def __init__(self, target_format):
2918
"""Create a metadir to metadir converter.
2920
:param target_format: The final metadir format that is desired.
2922
self.target_format = target_format
2924
def convert(self, to_convert, pb):
2925
"""See Converter.convert()."""
2926
self.bzrdir = to_convert
2930
self.step('checking repository format')
2932
repo = self.bzrdir.open_repository()
2933
except errors.NoRepositoryPresent:
2936
if not isinstance(repo._format, self.target_format.repository_format.__class__):
2937
from bzrlib.repository import CopyConverter
2938
self.pb.note('starting repository conversion')
2939
converter = CopyConverter(self.target_format.repository_format)
2940
converter.convert(repo, pb)
2942
branch = self.bzrdir.open_branch()
2943
except errors.NotBranchError:
2946
# TODO: conversions of Branch and Tree should be done by
2947
# InterXFormat lookups/some sort of registry.
2948
# Avoid circular imports
2949
from bzrlib import branch as _mod_branch
2950
old = branch._format.__class__
2951
new = self.target_format.get_branch_format().__class__
2953
if (old == _mod_branch.BzrBranchFormat5 and
2954
new in (_mod_branch.BzrBranchFormat6,
2955
_mod_branch.BzrBranchFormat7,
2956
_mod_branch.BzrBranchFormat8)):
2957
branch_converter = _mod_branch.Converter5to6()
2958
elif (old == _mod_branch.BzrBranchFormat6 and
2959
new in (_mod_branch.BzrBranchFormat7,
2960
_mod_branch.BzrBranchFormat8)):
2961
branch_converter = _mod_branch.Converter6to7()
2962
elif (old == _mod_branch.BzrBranchFormat7 and
2963
new is _mod_branch.BzrBranchFormat8):
2964
branch_converter = _mod_branch.Converter7to8()
2966
raise errors.BadConversionTarget("No converter", new)
2967
branch_converter.convert(branch)
2968
branch = self.bzrdir.open_branch()
2969
old = branch._format.__class__
2971
tree = self.bzrdir.open_workingtree(recommend_upgrade=False)
2972
except (errors.NoWorkingTree, errors.NotLocalUrl):
2975
# TODO: conversions of Branch and Tree should be done by
2976
# InterXFormat lookups
2977
if (isinstance(tree, workingtree.WorkingTree3) and
2978
not isinstance(tree, workingtree_4.DirStateWorkingTree) and
2979
isinstance(self.target_format.workingtree_format,
2980
workingtree_4.DirStateWorkingTreeFormat)):
2981
workingtree_4.Converter3to4().convert(tree)
2982
if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
2983
not isinstance(tree, workingtree_4.WorkingTree5) and
2984
isinstance(self.target_format.workingtree_format,
2985
workingtree_4.WorkingTreeFormat5)):
2986
workingtree_4.Converter4to5().convert(tree)
2987
if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
2988
not isinstance(tree, workingtree_4.WorkingTree6) and
2989
isinstance(self.target_format.workingtree_format,
2990
workingtree_4.WorkingTreeFormat6)):
2991
workingtree_4.Converter4or5to6().convert(tree)
2995
# This is not in remote.py because it's relatively small, and needs to be
2996
# registered. Putting it in remote.py creates a circular import problem.
2997
# we can make it a lazy object if the control formats is turned into something
2999
class RemoteBzrDirFormat(BzrDirMetaFormat1):
3000
"""Format representing bzrdirs accessed via a smart server"""
3003
BzrDirMetaFormat1.__init__(self)
3004
self._network_name = None
3006
def get_format_description(self):
3007
return 'bzr remote bzrdir'
3009
def get_format_string(self):
3010
raise NotImplementedError(self.get_format_string)
3012
def network_name(self):
3013
if self._network_name:
3014
return self._network_name
3016
raise AssertionError("No network name set.")
3019
def probe_transport(klass, transport):
3020
"""Return a RemoteBzrDirFormat object if it looks possible."""
3022
medium = transport.get_smart_medium()
3023
except (NotImplementedError, AttributeError,
3024
errors.TransportNotPossible, errors.NoSmartMedium,
3025
errors.SmartProtocolError):
3026
# no smart server, so not a branch for this format type.
3027
raise errors.NotBranchError(path=transport.base)
3029
# Decline to open it if the server doesn't support our required
3030
# version (3) so that the VFS-based transport will do it.
3031
if medium.should_probe():
3033
server_version = medium.protocol_version()
3034
except errors.SmartProtocolError:
3035
# Apparently there's no usable smart server there, even though
3036
# the medium supports the smart protocol.
3037
raise errors.NotBranchError(path=transport.base)
3038
if server_version != '2':
3039
raise errors.NotBranchError(path=transport.base)
3042
def initialize_on_transport(self, transport):
3044
# hand off the request to the smart server
3045
client_medium = transport.get_smart_medium()
3046
except errors.NoSmartMedium:
3047
# TODO: lookup the local format from a server hint.
3048
local_dir_format = BzrDirMetaFormat1()
3049
return local_dir_format.initialize_on_transport(transport)
3050
client = _SmartClient(client_medium)
3051
path = client.remote_path_from_transport(transport)
3052
response = client.call('BzrDirFormat.initialize', path)
3053
if response[0] != 'ok':
3054
raise errors.SmartProtocolError('unexpected response code %s' % (response,))
3055
format = RemoteBzrDirFormat()
3056
self._supply_sub_formats_to(format)
3057
return remote.RemoteBzrDir(transport, format)
3059
def parse_NoneTrueFalse(self, arg):
3066
raise AssertionError("invalid arg %r" % arg)
3068
def _serialize_NoneTrueFalse(self, arg):
3075
def _serialize_NoneString(self, arg):
3078
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
3079
create_prefix=False, force_new_repo=False, stacked_on=None,
3080
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
3083
# hand off the request to the smart server
3084
client_medium = transport.get_smart_medium()
3085
except errors.NoSmartMedium:
3088
# Decline to open it if the server doesn't support our required
3089
# version (3) so that the VFS-based transport will do it.
3090
if client_medium.should_probe():
3092
server_version = client_medium.protocol_version()
3093
if server_version != '2':
3097
except errors.SmartProtocolError:
3098
# Apparently there's no usable smart server there, even though
3099
# the medium supports the smart protocol.
3104
client = _SmartClient(client_medium)
3105
path = client.remote_path_from_transport(transport)
3106
if client_medium._is_remote_before((1, 15)):
3109
# TODO: lookup the local format from a server hint.
3110
local_dir_format = BzrDirMetaFormat1()
3111
self._supply_sub_formats_to(local_dir_format)
3112
return local_dir_format.initialize_on_transport_ex(transport,
3113
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3114
force_new_repo=force_new_repo, stacked_on=stacked_on,
3115
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3116
make_working_trees=make_working_trees, shared_repo=shared_repo,
3119
args.append(self._serialize_NoneTrueFalse(use_existing_dir))
3120
args.append(self._serialize_NoneTrueFalse(create_prefix))
3121
args.append(self._serialize_NoneTrueFalse(force_new_repo))
3122
args.append(self._serialize_NoneString(stacked_on))
3123
# stack_on_pwd is often/usually our transport
3126
stack_on_pwd = transport.relpath(stack_on_pwd)
3127
if not stack_on_pwd:
3129
except errors.PathNotChild:
3131
args.append(self._serialize_NoneString(stack_on_pwd))
3132
args.append(self._serialize_NoneString(repo_format_name))
3133
args.append(self._serialize_NoneTrueFalse(make_working_trees))
3134
args.append(self._serialize_NoneTrueFalse(shared_repo))
3135
if self._network_name is None:
3136
self._network_name = \
3137
BzrDirFormat.get_default_format().network_name()
3139
response = client.call('BzrDirFormat.initialize_ex',
3140
self.network_name(), path, *args)
3141
except errors.UnknownSmartMethod:
3142
local_dir_format = BzrDirMetaFormat1()
3143
self._supply_sub_formats_to(local_dir_format)
3144
return local_dir_format.initialize_on_transport_ex(transport,
3145
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3146
force_new_repo=force_new_repo, stacked_on=stacked_on,
3147
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3148
make_working_trees=make_working_trees, shared_repo=shared_repo,
3150
repo_path = response[0]
3151
bzrdir_name = response[6]
3152
require_stacking = response[7]
3153
require_stacking = self.parse_NoneTrueFalse(require_stacking)
3154
format = RemoteBzrDirFormat()
3155
format._network_name = bzrdir_name
3156
self._supply_sub_formats_to(format)
3157
bzrdir = remote.RemoteBzrDir(transport, format, _client=client)
3159
repo_format = remote.response_tuple_to_repo_format(response[1:])
3160
if repo_path == '.':
3163
repo_bzrdir_format = RemoteBzrDirFormat()
3164
repo_bzrdir_format._network_name = response[5]
3165
repo_bzr = remote.RemoteBzrDir(transport.clone(repo_path),
3169
final_stack = response[8] or None
3170
final_stack_pwd = response[9] or None
3171
remote_repo = remote.RemoteRepository(repo_bzr, repo_format)
3172
if len(response) > 10:
3173
# Updated server verb that locks remotely.
3174
repo_lock_token = response[10] or None
3175
remote_repo.lock_write(repo_lock_token, _skip_rpc=True)
3177
remote_repo.dont_leave_lock_in_place()
3179
remote_repo.lock_write()
3180
policy = UseExistingRepository(remote_repo, final_stack,
3181
final_stack_pwd, require_stacking)
3182
policy.acquire_repository()
3186
return remote_repo, bzrdir, require_stacking, policy
3188
def _open(self, transport):
3189
return remote.RemoteBzrDir(transport, self)
3191
def __eq__(self, other):
3192
if not isinstance(other, RemoteBzrDirFormat):
3194
return self.get_format_description() == other.get_format_description()
3196
def __return_repository_format(self):
3197
# Always return a RemoteRepositoryFormat object, but if a specific bzr
3198
# repository format has been asked for, tell the RemoteRepositoryFormat
3199
# that it should use that for init() etc.
3200
result = remote.RemoteRepositoryFormat()
3201
custom_format = getattr(self, '_repository_format', None)
3203
if isinstance(custom_format, remote.RemoteRepositoryFormat):
3204
return custom_format
3206
# We will use the custom format to create repositories over the
3207
# wire; expose its details like rich_root_data for code to
3209
result._custom_format = custom_format
3212
def get_branch_format(self):
3213
result = BzrDirMetaFormat1.get_branch_format(self)
3214
if not isinstance(result, remote.RemoteBranchFormat):
3215
new_result = remote.RemoteBranchFormat()
3216
new_result._custom_format = result
3218
self.set_branch_format(new_result)
3222
repository_format = property(__return_repository_format,
3223
BzrDirMetaFormat1._set_repository_format) #.im_func)
3226
BzrDirFormat.register_control_server_format(RemoteBzrDirFormat)
3229
class BzrDirFormatInfo(object):
3231
def __init__(self, native, deprecated, hidden, experimental):
3232
self.deprecated = deprecated
3233
self.native = native
3234
self.hidden = hidden
3235
self.experimental = experimental
3238
class BzrDirFormatRegistry(registry.Registry):
3239
"""Registry of user-selectable BzrDir subformats.
3241
Differs from BzrDirFormat._control_formats in that it provides sub-formats,
3242
e.g. BzrDirMeta1 with weave repository. Also, it's more user-oriented.
3246
"""Create a BzrDirFormatRegistry."""
3247
self._aliases = set()
3248
self._registration_order = list()
3249
super(BzrDirFormatRegistry, self).__init__()
3252
"""Return a set of the format names which are aliases."""
3253
return frozenset(self._aliases)
3255
def register_metadir(self, key,
3256
repository_format, help, native=True, deprecated=False,
3262
"""Register a metadir subformat.
3264
These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
3265
by the Repository/Branch/WorkingTreeformats.
3267
:param repository_format: The fully-qualified repository format class
3269
:param branch_format: Fully-qualified branch format class name as
3271
:param tree_format: Fully-qualified tree format class name as
3274
# This should be expanded to support setting WorkingTree and Branch
3275
# formats, once BzrDirMetaFormat1 supports that.
3276
def _load(full_name):
3277
mod_name, factory_name = full_name.rsplit('.', 1)
3279
mod = __import__(mod_name, globals(), locals(),
3281
except ImportError, e:
3282
raise ImportError('failed to load %s: %s' % (full_name, e))
3284
factory = getattr(mod, factory_name)
3285
except AttributeError:
3286
raise AttributeError('no factory %s in module %r'
3291
bd = BzrDirMetaFormat1()
3292
if branch_format is not None:
3293
bd.set_branch_format(_load(branch_format))
3294
if tree_format is not None:
3295
bd.workingtree_format = _load(tree_format)
3296
if repository_format is not None:
3297
bd.repository_format = _load(repository_format)
3299
self.register(key, helper, help, native, deprecated, hidden,
3300
experimental, alias)
3302
def register(self, key, factory, help, native=True, deprecated=False,
3303
hidden=False, experimental=False, alias=False):
3304
"""Register a BzrDirFormat factory.
3306
The factory must be a callable that takes one parameter: the key.
3307
It must produce an instance of the BzrDirFormat when called.
3309
This function mainly exists to prevent the info object from being
3312
registry.Registry.register(self, key, factory, help,
3313
BzrDirFormatInfo(native, deprecated, hidden, experimental))
3315
self._aliases.add(key)
3316
self._registration_order.append(key)
3318
def register_lazy(self, key, module_name, member_name, help, native=True,
3319
deprecated=False, hidden=False, experimental=False, alias=False):
3320
registry.Registry.register_lazy(self, key, module_name, member_name,
3321
help, BzrDirFormatInfo(native, deprecated, hidden, experimental))
3323
self._aliases.add(key)
3324
self._registration_order.append(key)
3326
def set_default(self, key):
3327
"""Set the 'default' key to be a clone of the supplied key.
3329
This method must be called once and only once.
3331
registry.Registry.register(self, 'default', self.get(key),
3332
self.get_help(key), info=self.get_info(key))
3333
self._aliases.add('default')
3335
def set_default_repository(self, key):
3336
"""Set the FormatRegistry default and Repository default.
3338
This is a transitional method while Repository.set_default_format
3341
if 'default' in self:
3342
self.remove('default')
3343
self.set_default(key)
3344
format = self.get('default')()
3346
def make_bzrdir(self, key):
3347
return self.get(key)()
3349
def help_topic(self, topic):
3351
default_realkey = None
3352
default_help = self.get_help('default')
3354
for key in self._registration_order:
3355
if key == 'default':
3357
help = self.get_help(key)
3358
if help == default_help:
3359
default_realkey = key
3361
help_pairs.append((key, help))
3363
def wrapped(key, help, info):
3365
help = '(native) ' + help
3366
return ':%s:\n%s\n\n' % (key,
3367
textwrap.fill(help, initial_indent=' ',
3368
subsequent_indent=' '))
3369
if default_realkey is not None:
3370
output += wrapped(default_realkey, '(default) %s' % default_help,
3371
self.get_info('default'))
3372
deprecated_pairs = []
3373
experimental_pairs = []
3374
for key, help in help_pairs:
3375
info = self.get_info(key)
3378
elif info.deprecated:
3379
deprecated_pairs.append((key, help))
3380
elif info.experimental:
3381
experimental_pairs.append((key, help))
3383
output += wrapped(key, help, info)
3384
output += "\nSee ``bzr help formats`` for more about storage formats."
3386
if len(experimental_pairs) > 0:
3387
other_output += "Experimental formats are shown below.\n\n"
3388
for key, help in experimental_pairs:
3389
info = self.get_info(key)
3390
other_output += wrapped(key, help, info)
3393
"No experimental formats are available.\n\n"
3394
if len(deprecated_pairs) > 0:
3395
other_output += "\nDeprecated formats are shown below.\n\n"
3396
for key, help in deprecated_pairs:
3397
info = self.get_info(key)
3398
other_output += wrapped(key, help, info)
3401
"\nNo deprecated formats are available.\n\n"
3403
"\nSee ``bzr help formats`` for more about storage formats."
3405
if topic == 'other-formats':
3411
class RepositoryAcquisitionPolicy(object):
3412
"""Abstract base class for repository acquisition policies.
3414
A repository acquisition policy decides how a BzrDir acquires a repository
3415
for a branch that is being created. The most basic policy decision is
3416
whether to create a new repository or use an existing one.
3418
def __init__(self, stack_on, stack_on_pwd, require_stacking):
3421
:param stack_on: A location to stack on
3422
:param stack_on_pwd: If stack_on is relative, the location it is
3424
:param require_stacking: If True, it is a failure to not stack.
3426
self._stack_on = stack_on
3427
self._stack_on_pwd = stack_on_pwd
3428
self._require_stacking = require_stacking
3430
def configure_branch(self, branch):
3431
"""Apply any configuration data from this policy to the branch.
3433
Default implementation sets repository stacking.
3435
if self._stack_on is None:
3437
if self._stack_on_pwd is None:
3438
stack_on = self._stack_on
3441
stack_on = urlutils.rebase_url(self._stack_on,
3443
branch.bzrdir.root_transport.base)
3444
except errors.InvalidRebaseURLs:
3445
stack_on = self._get_full_stack_on()
3447
branch.set_stacked_on_url(stack_on)
3448
except (errors.UnstackableBranchFormat,
3449
errors.UnstackableRepositoryFormat):
3450
if self._require_stacking:
3453
def _get_full_stack_on(self):
3454
"""Get a fully-qualified URL for the stack_on location."""
3455
if self._stack_on is None:
3457
if self._stack_on_pwd is None:
3458
return self._stack_on
3460
return urlutils.join(self._stack_on_pwd, self._stack_on)
3462
def _add_fallback(self, repository, possible_transports=None):
3463
"""Add a fallback to the supplied repository, if stacking is set."""
3464
stack_on = self._get_full_stack_on()
3465
if stack_on is None:
3468
stacked_dir = BzrDir.open(stack_on,
3469
possible_transports=possible_transports)
3470
except errors.JailBreak:
3471
# We keep the stacking details, but we are in the server code so
3472
# actually stacking is not needed.
3475
stacked_repo = stacked_dir.open_branch().repository
3476
except errors.NotBranchError:
3477
stacked_repo = stacked_dir.open_repository()
3479
repository.add_fallback_repository(stacked_repo)
3480
except errors.UnstackableRepositoryFormat:
3481
if self._require_stacking:
3484
self._require_stacking = True
3486
def acquire_repository(self, make_working_trees=None, shared=False):
3487
"""Acquire a repository for this bzrdir.
3489
Implementations may create a new repository or use a pre-exising
3491
:param make_working_trees: If creating a repository, set
3492
make_working_trees to this value (if non-None)
3493
:param shared: If creating a repository, make it shared if True
3494
:return: A repository, is_new_flag (True if the repository was
3497
raise NotImplemented(RepositoryAcquisitionPolicy.acquire_repository)
3500
class CreateRepository(RepositoryAcquisitionPolicy):
3501
"""A policy of creating a new repository"""
3503
def __init__(self, bzrdir, stack_on=None, stack_on_pwd=None,
3504
require_stacking=False):
3507
:param bzrdir: The bzrdir to create the repository on.
3508
:param stack_on: A location to stack on
3509
:param stack_on_pwd: If stack_on is relative, the location it is
3512
RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
3514
self._bzrdir = bzrdir
3516
def acquire_repository(self, make_working_trees=None, shared=False):
3517
"""Implementation of RepositoryAcquisitionPolicy.acquire_repository
3519
Creates the desired repository in the bzrdir we already have.
3521
stack_on = self._get_full_stack_on()
3523
# Stacking is desired. requested by the target, but does the place it
3524
# points at support stacking? If it doesn't then we should
3525
# not implicitly upgrade. We check this here.
3526
format = self._bzrdir._format
3527
if not (format.repository_format.supports_external_lookups
3528
and format.get_branch_format().supports_stacking()):
3529
# May need to upgrade - but only do if the target also
3530
# supports stacking. Note that this currently wastes
3531
# network round trips to check - but we only do this
3532
# when the source can't stack so it will fade away
3533
# as people do upgrade.
3534
branch_format = None
3537
target_dir = BzrDir.open(stack_on,
3538
possible_transports=[self._bzrdir.root_transport])
3539
except errors.NotBranchError:
3540
# Nothing there, don't change formats
3542
except errors.JailBreak:
3543
# stack_on is inaccessible, JFDI.
3544
if format.repository_format.rich_root_data:
3545
repo_format = pack_repo.RepositoryFormatKnitPack6RichRoot()
3547
repo_format = pack_repo.RepositoryFormatKnitPack6()
3548
branch_format = branch.BzrBranchFormat7()
3551
target_branch = target_dir.open_branch()
3552
except errors.NotBranchError:
3553
# No branch, don't change formats
3556
branch_format = target_branch._format
3557
repo_format = target_branch.repository._format
3558
if not (branch_format.supports_stacking()
3559
and repo_format.supports_external_lookups):
3560
# Doesn't stack itself, don't force an upgrade
3561
branch_format = None
3563
if branch_format and repo_format:
3564
# Does support stacking, use its format.
3565
format.repository_format = repo_format
3566
format.set_branch_format(branch_format)
3567
note('Source format does not support stacking, '
3568
'using format: \'%s\'\n %s\n',
3569
branch_format.get_format_description(),
3570
repo_format.get_format_description())
3571
if not self._require_stacking:
3572
# We have picked up automatic stacking somewhere.
3573
note('Using default stacking branch %s at %s', self._stack_on,
3575
repository = self._bzrdir.create_repository(shared=shared)
3576
self._add_fallback(repository,
3577
possible_transports=[self._bzrdir.transport])
3578
if make_working_trees is not None:
3579
repository.set_make_working_trees(make_working_trees)
3580
return repository, True
3583
class UseExistingRepository(RepositoryAcquisitionPolicy):
3584
"""A policy of reusing an existing repository"""
3586
def __init__(self, repository, stack_on=None, stack_on_pwd=None,
3587
require_stacking=False):
3590
:param repository: The repository to use.
3591
:param stack_on: A location to stack on
3592
:param stack_on_pwd: If stack_on is relative, the location it is
3595
RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
3597
self._repository = repository
3599
def acquire_repository(self, make_working_trees=None, shared=False):
3600
"""Implementation of RepositoryAcquisitionPolicy.acquire_repository
3602
Returns an existing repository to use.
3604
self._add_fallback(self._repository,
3605
possible_transports=[self._repository.bzrdir.transport])
3606
return self._repository, False
3609
# Please register new formats after old formats so that formats
3610
# appear in chronological order and format descriptions can build
3612
format_registry = BzrDirFormatRegistry()
3613
# The pre-0.8 formats have their repository format network name registered in
3614
# repository.py. MetaDir formats have their repository format network name
3615
# inferred from their disk format string.
3616
format_registry.register('weave', BzrDirFormat6,
3617
'Pre-0.8 format. Slower than knit and does not'
3618
' support checkouts or shared repositories.',
3620
format_registry.register_metadir('metaweave',
3621
'bzrlib.repofmt.weaverepo.RepositoryFormat7',
3622
'Transitional format in 0.8. Slower than knit.',
3623
branch_format='bzrlib.branch.BzrBranchFormat5',
3624
tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3626
format_registry.register_metadir('knit',
3627
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3628
'Format using knits. Recommended for interoperation with bzr <= 0.14.',
3629
branch_format='bzrlib.branch.BzrBranchFormat5',
3630
tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3632
format_registry.register_metadir('dirstate',
3633
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3634
help='New in 0.15: Fast local operations. Compatible with bzr 0.8 and '
3635
'above when accessed over the network.',
3636
branch_format='bzrlib.branch.BzrBranchFormat5',
3637
# this uses bzrlib.workingtree.WorkingTreeFormat4 because importing
3638
# directly from workingtree_4 triggers a circular import.
3639
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3641
format_registry.register_metadir('dirstate-tags',
3642
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3643
help='New in 0.15: Fast local operations and improved scaling for '
3644
'network operations. Additionally adds support for tags.'
3645
' Incompatible with bzr < 0.15.',
3646
branch_format='bzrlib.branch.BzrBranchFormat6',
3647
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3649
format_registry.register_metadir('rich-root',
3650
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
3651
help='New in 1.0. Better handling of tree roots. Incompatible with'
3653
branch_format='bzrlib.branch.BzrBranchFormat6',
3654
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3656
format_registry.register_metadir('dirstate-with-subtree',
3657
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
3658
help='New in 0.15: Fast local operations and improved scaling for '
3659
'network operations. Additionally adds support for versioning nested '
3660
'bzr branches. Incompatible with bzr < 0.15.',
3661
branch_format='bzrlib.branch.BzrBranchFormat6',
3662
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3666
format_registry.register_metadir('pack-0.92',
3667
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack1',
3668
help='New in 0.92: Pack-based format with data compatible with '
3669
'dirstate-tags format repositories. Interoperates with '
3670
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3671
'Previously called knitpack-experimental. '
3672
'For more information, see '
3673
'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
3674
branch_format='bzrlib.branch.BzrBranchFormat6',
3675
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3677
format_registry.register_metadir('pack-0.92-subtree',
3678
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack3',
3679
help='New in 0.92: Pack-based format with data compatible with '
3680
'dirstate-with-subtree format repositories. Interoperates with '
3681
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3682
'Previously called knitpack-experimental. '
3683
'For more information, see '
3684
'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
3685
branch_format='bzrlib.branch.BzrBranchFormat6',
3686
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3690
format_registry.register_metadir('rich-root-pack',
3691
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
3692
help='New in 1.0: A variant of pack-0.92 that supports rich-root data '
3693
'(needed for bzr-svn and bzr-git).',
3694
branch_format='bzrlib.branch.BzrBranchFormat6',
3695
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3697
format_registry.register_metadir('1.6',
3698
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5',
3699
help='A format that allows a branch to indicate that there is another '
3700
'(stacked) repository that should be used to access data that is '
3701
'not present locally.',
3702
branch_format='bzrlib.branch.BzrBranchFormat7',
3703
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3705
format_registry.register_metadir('1.6.1-rich-root',
3706
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5RichRoot',
3707
help='A variant of 1.6 that supports rich-root data '
3708
'(needed for bzr-svn and bzr-git).',
3709
branch_format='bzrlib.branch.BzrBranchFormat7',
3710
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3712
format_registry.register_metadir('1.9',
3713
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3714
help='A repository format using B+tree indexes. These indexes '
3715
'are smaller in size, have smarter caching and provide faster '
3716
'performance for most operations.',
3717
branch_format='bzrlib.branch.BzrBranchFormat7',
3718
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3720
format_registry.register_metadir('1.9-rich-root',
3721
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
3722
help='A variant of 1.9 that supports rich-root data '
3723
'(needed for bzr-svn and bzr-git).',
3724
branch_format='bzrlib.branch.BzrBranchFormat7',
3725
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3727
format_registry.register_metadir('1.14',
3728
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3729
help='A working-tree format that supports content filtering.',
3730
branch_format='bzrlib.branch.BzrBranchFormat7',
3731
tree_format='bzrlib.workingtree.WorkingTreeFormat5',
3733
format_registry.register_metadir('1.14-rich-root',
3734
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
3735
help='A variant of 1.14 that supports rich-root data '
3736
'(needed for bzr-svn and bzr-git).',
3737
branch_format='bzrlib.branch.BzrBranchFormat7',
3738
tree_format='bzrlib.workingtree.WorkingTreeFormat5',
3740
# The following un-numbered 'development' formats should always just be aliases.
3741
format_registry.register_metadir('development-rich-root',
3742
'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
3743
help='Current development format. Supports rich roots. Can convert data '
3744
'to and from rich-root-pack (and anything compatible with '
3745
'rich-root-pack) format repositories. Repositories and branches in '
3746
'this format can only be read by bzr.dev. Please read '
3747
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3749
branch_format='bzrlib.branch.BzrBranchFormat7',
3750
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3754
format_registry.register_metadir('development-subtree',
3755
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment2Subtree',
3756
help='Current development format, subtree variant. Can convert data to and '
3757
'from pack-0.92-subtree (and anything compatible with '
3758
'pack-0.92-subtree) format repositories. Repositories and branches in '
3759
'this format can only be read by bzr.dev. Please read '
3760
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3762
branch_format='bzrlib.branch.BzrBranchFormat7',
3763
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3765
alias=False, # Restore to being an alias when an actual development subtree format is added
3766
# This current non-alias status is simply because we did not introduce a
3767
# chk based subtree format.
3770
# And the development formats above will have aliased one of the following:
3771
format_registry.register_metadir('development6-rich-root',
3772
'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
3773
help='pack-1.9 with 255-way hashed CHK inv, group compress, rich roots '
3775
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3777
branch_format='bzrlib.branch.BzrBranchFormat7',
3778
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3783
# The following format should be an alias for the rich root equivalent
3784
# of the default format
3785
format_registry.register_metadir('default-rich-root',
3786
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
3787
help='Default format, rich root variant. (needed for bzr-svn and bzr-git).',
3788
branch_format='bzrlib.branch.BzrBranchFormat6',
3789
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3792
# The current format that is made on 'bzr init'.
3793
format_registry.set_default('pack-0.92')
added
removed
bzrlib/bzrdir.py
