1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""BzrDir logic. The BzrDir is the basic control directory used by bzr.
19
At format 7 this was split out into Branch, Repository and Checkout control
22
Note: This module has a lot of ``open`` functions/methods that return
23
references to in-memory objects. As a rule, there are no matching ``close``
24
methods. To free any associated resources, simply stop referencing the
28
# TODO: Move old formats into a plugin to make this file smaller.
33
from bzrlib.lazy_import import lazy_import
34
lazy_import(globals(), """
35
from stat import S_ISDIR
49
revision as _mod_revision,
59
from bzrlib.osutils import (
62
from bzrlib.push import (
65
from bzrlib.repofmt import pack_repo
66
from bzrlib.smart.client import _SmartClient
67
from bzrlib.store.versioned import WeaveStore
68
from bzrlib.transactions import WriteTransaction
69
from bzrlib.transport import (
70
do_catching_redirections,
74
from bzrlib.weave import Weave
77
from bzrlib.trace import (
91
"""A .bzr control diretory.
93
BzrDir instances let you create or open any of the things that can be
94
found within .bzr - checkouts, branches and repositories.
97
the transport which this bzr dir is rooted at (i.e. file:///.../.bzr/)
99
a transport connected to the directory this bzr was opened from
100
(i.e. the parent directory holding the .bzr directory).
102
Everything in the bzrdir should have the same file permissions.
104
:cvar hooks: An instance of BzrDirHooks.
107
def break_lock(self):
108
"""Invoke break_lock on the first object in the bzrdir.
110
If there is a tree, the tree is opened and break_lock() called.
111
Otherwise, branch is tried, and finally repository.
113
# XXX: This seems more like a UI function than something that really
114
# belongs in this class.
116
thing_to_unlock = self.open_workingtree()
117
except (errors.NotLocalUrl, errors.NoWorkingTree):
119
thing_to_unlock = self.open_branch()
120
except errors.NotBranchError:
122
thing_to_unlock = self.open_repository()
123
except errors.NoRepositoryPresent:
125
thing_to_unlock.break_lock()
127
def can_convert_format(self):
128
"""Return true if this bzrdir is one whose format we can convert from."""
131
def check_conversion_target(self, target_format):
132
"""Check that a bzrdir as a whole can be converted to a new format."""
133
# The only current restriction is that the repository content can be
134
# fetched compatibly with the target.
135
target_repo_format = target_format.repository_format
137
self.open_repository()._format.check_conversion_target(
139
except errors.NoRepositoryPresent:
140
# No repo, no problem.
144
def _check_supported(format, allow_unsupported,
145
recommend_upgrade=True,
147
"""Give an error or warning on old formats.
149
:param format: may be any kind of format - workingtree, branch,
152
:param allow_unsupported: If true, allow opening
153
formats that are strongly deprecated, and which may
154
have limited functionality.
156
:param recommend_upgrade: If true (default), warn
157
the user through the ui object that they may wish
158
to upgrade the object.
160
# TODO: perhaps move this into a base Format class; it's not BzrDir
161
# specific. mbp 20070323
162
if not allow_unsupported and not format.is_supported():
163
# see open_downlevel to open legacy branches.
164
raise errors.UnsupportedFormatError(format=format)
165
if recommend_upgrade \
166
and getattr(format, 'upgrade_recommended', False):
167
ui.ui_factory.recommend_upgrade(
168
format.get_format_description(),
171
def clone(self, url, revision_id=None, force_new_repo=False,
172
preserve_stacking=False):
173
"""Clone this bzrdir and its contents to url verbatim.
175
:param url: The url create the clone at. If url's last component does
176
not exist, it will be created.
177
:param revision_id: The tip revision-id to use for any branch or
178
working tree. If not None, then the clone operation may tune
179
itself to download less data.
180
:param force_new_repo: Do not use a shared repository for the target
181
even if one is available.
182
:param preserve_stacking: When cloning a stacked branch, stack the
183
new branch on top of the other branch's stacked-on branch.
185
return self.clone_on_transport(get_transport(url),
186
revision_id=revision_id,
187
force_new_repo=force_new_repo,
188
preserve_stacking=preserve_stacking)
190
def clone_on_transport(self, transport, revision_id=None,
191
force_new_repo=False, preserve_stacking=False, stacked_on=None,
192
create_prefix=False, use_existing_dir=True):
193
"""Clone this bzrdir and its contents to transport verbatim.
195
:param transport: The transport for the location to produce the clone
196
at. If the target directory does not exist, it will be created.
197
:param revision_id: The tip revision-id to use for any branch or
198
working tree. If not None, then the clone operation may tune
199
itself to download less data.
200
:param force_new_repo: Do not use a shared repository for the target,
201
even if one is available.
202
:param preserve_stacking: When cloning a stacked branch, stack the
203
new branch on top of the other branch's stacked-on branch.
204
:param create_prefix: Create any missing directories leading up to
206
:param use_existing_dir: Use an existing directory if one exists.
208
# Overview: put together a broad description of what we want to end up
209
# with; then make as few api calls as possible to do it.
211
# We may want to create a repo/branch/tree, if we do so what format
212
# would we want for each:
213
require_stacking = (stacked_on is not None)
214
format = self.cloning_metadir(require_stacking)
216
# Figure out what objects we want:
218
local_repo = self.find_repository()
219
except errors.NoRepositoryPresent:
222
local_branch = self.open_branch()
223
except errors.NotBranchError:
226
# enable fallbacks when branch is not a branch reference
227
if local_branch.repository.has_same_location(local_repo):
228
local_repo = local_branch.repository
229
if preserve_stacking:
231
stacked_on = local_branch.get_stacked_on_url()
232
except (errors.UnstackableBranchFormat,
233
errors.UnstackableRepositoryFormat,
236
# Bug: We create a metadir without knowing if it can support stacking,
237
# we should look up the policy needs first, or just use it as a hint,
240
make_working_trees = local_repo.make_working_trees()
241
want_shared = local_repo.is_shared()
242
repo_format_name = format.repository_format.network_name()
244
make_working_trees = False
246
repo_format_name = None
248
result_repo, result, require_stacking, repository_policy = \
249
format.initialize_on_transport_ex(transport,
250
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
251
force_new_repo=force_new_repo, stacked_on=stacked_on,
252
stack_on_pwd=self.root_transport.base,
253
repo_format_name=repo_format_name,
254
make_working_trees=make_working_trees, shared_repo=want_shared)
257
# If the result repository is in the same place as the
258
# resulting bzr dir, it will have no content, further if the
259
# result is not stacked then we know all content should be
260
# copied, and finally if we are copying up to a specific
261
# revision_id then we can use the pending-ancestry-result which
262
# does not require traversing all of history to describe it.
263
if (result_repo.bzrdir.root_transport.base ==
264
result.root_transport.base and not require_stacking and
265
revision_id is not None):
266
fetch_spec = graph.PendingAncestryResult(
267
[revision_id], local_repo)
268
result_repo.fetch(local_repo, fetch_spec=fetch_spec)
270
result_repo.fetch(local_repo, revision_id=revision_id)
274
if result_repo is not None:
275
raise AssertionError('result_repo not None(%r)' % result_repo)
276
# 1 if there is a branch present
277
# make sure its content is available in the target repository
279
if local_branch is not None:
280
result_branch = local_branch.clone(result, revision_id=revision_id,
281
repository_policy=repository_policy)
283
# Cheaper to check if the target is not local, than to try making
285
result.root_transport.local_abspath('.')
286
if result_repo is None or result_repo.make_working_trees():
287
self.open_workingtree().clone(result)
288
except (errors.NoWorkingTree, errors.NotLocalUrl):
292
# TODO: This should be given a Transport, and should chdir up; otherwise
293
# this will open a new connection.
294
def _make_tail(self, url):
295
t = get_transport(url)
299
def create(cls, base, format=None, possible_transports=None):
300
"""Create a new BzrDir at the url 'base'.
302
:param format: If supplied, the format of branch to create. If not
303
supplied, the default is used.
304
:param possible_transports: If supplied, a list of transports that
305
can be reused to share a remote connection.
307
if cls is not BzrDir:
308
raise AssertionError("BzrDir.create always creates the default"
309
" format, not one of %r" % cls)
310
t = get_transport(base, possible_transports)
313
format = BzrDirFormat.get_default_format()
314
return format.initialize_on_transport(t)
317
def find_bzrdirs(transport, evaluate=None, list_current=None):
318
"""Find bzrdirs recursively from current location.
320
This is intended primarily as a building block for more sophisticated
321
functionality, like finding trees under a directory, or finding
322
branches that use a given repository.
323
:param evaluate: An optional callable that yields recurse, value,
324
where recurse controls whether this bzrdir is recursed into
325
and value is the value to yield. By default, all bzrdirs
326
are recursed into, and the return value is the bzrdir.
327
:param list_current: if supplied, use this function to list the current
328
directory, instead of Transport.list_dir
329
:return: a generator of found bzrdirs, or whatever evaluate returns.
331
if list_current is None:
332
def list_current(transport):
333
return transport.list_dir('')
335
def evaluate(bzrdir):
338
pending = [transport]
339
while len(pending) > 0:
340
current_transport = pending.pop()
343
bzrdir = BzrDir.open_from_transport(current_transport)
344
except errors.NotBranchError:
347
recurse, value = evaluate(bzrdir)
350
subdirs = list_current(current_transport)
351
except errors.NoSuchFile:
354
for subdir in sorted(subdirs, reverse=True):
355
pending.append(current_transport.clone(subdir))
358
def find_branches(transport):
359
"""Find all branches under a transport.
361
This will find all branches below the transport, including branches
362
inside other branches. Where possible, it will use
363
Repository.find_branches.
365
To list all the branches that use a particular Repository, see
366
Repository.find_branches
368
def evaluate(bzrdir):
370
repository = bzrdir.open_repository()
371
except errors.NoRepositoryPresent:
374
return False, (None, repository)
376
branch = bzrdir.open_branch()
377
except errors.NotBranchError:
378
return True, (None, None)
380
return True, (branch, None)
382
for branch, repo in BzrDir.find_bzrdirs(transport, evaluate=evaluate):
384
branches.extend(repo.find_branches())
385
if branch is not None:
386
branches.append(branch)
389
def destroy_repository(self):
390
"""Destroy the repository in this BzrDir"""
391
raise NotImplementedError(self.destroy_repository)
393
def create_branch(self):
394
"""Create a branch in this BzrDir.
396
The bzrdir's format will control what branch format is created.
397
For more control see BranchFormatXX.create(a_bzrdir).
399
raise NotImplementedError(self.create_branch)
401
def destroy_branch(self):
402
"""Destroy the branch in this BzrDir"""
403
raise NotImplementedError(self.destroy_branch)
406
def create_branch_and_repo(base, force_new_repo=False, format=None):
407
"""Create a new BzrDir, Branch and Repository at the url 'base'.
409
This will use the current default BzrDirFormat unless one is
410
specified, and use whatever
411
repository format that that uses via bzrdir.create_branch and
412
create_repository. If a shared repository is available that is used
415
The created Branch object is returned.
417
:param base: The URL to create the branch at.
418
:param force_new_repo: If True a new repository is always created.
419
:param format: If supplied, the format of branch to create. If not
420
supplied, the default is used.
422
bzrdir = BzrDir.create(base, format)
423
bzrdir._find_or_create_repository(force_new_repo)
424
return bzrdir.create_branch()
426
def determine_repository_policy(self, force_new_repo=False, stack_on=None,
427
stack_on_pwd=None, require_stacking=False):
428
"""Return an object representing a policy to use.
430
This controls whether a new repository is created, and the format of
431
that repository, or some existing shared repository used instead.
433
If stack_on is supplied, will not seek a containing shared repo.
435
:param force_new_repo: If True, require a new repository to be created.
436
:param stack_on: If supplied, the location to stack on. If not
437
supplied, a default_stack_on location may be used.
438
:param stack_on_pwd: If stack_on is relative, the location it is
441
def repository_policy(found_bzrdir):
444
config = found_bzrdir.get_config()
446
stack_on = config.get_default_stack_on()
447
if stack_on is not None:
448
stack_on_pwd = found_bzrdir.root_transport.base
450
# does it have a repository ?
452
repository = found_bzrdir.open_repository()
453
except errors.NoRepositoryPresent:
456
if ((found_bzrdir.root_transport.base !=
457
self.root_transport.base) and not repository.is_shared()):
458
# Don't look higher, can't use a higher shared repo.
466
return UseExistingRepository(repository, stack_on,
467
stack_on_pwd, require_stacking=require_stacking), True
469
return CreateRepository(self, stack_on, stack_on_pwd,
470
require_stacking=require_stacking), True
472
if not force_new_repo:
474
policy = self._find_containing(repository_policy)
475
if policy is not None:
479
return UseExistingRepository(self.open_repository(),
480
stack_on, stack_on_pwd,
481
require_stacking=require_stacking)
482
except errors.NoRepositoryPresent:
484
return CreateRepository(self, stack_on, stack_on_pwd,
485
require_stacking=require_stacking)
487
def _find_or_create_repository(self, force_new_repo):
488
"""Create a new repository if needed, returning the repository."""
489
policy = self.determine_repository_policy(force_new_repo)
490
return policy.acquire_repository()[0]
493
def create_branch_convenience(base, force_new_repo=False,
494
force_new_tree=None, format=None,
495
possible_transports=None):
496
"""Create a new BzrDir, Branch and Repository at the url 'base'.
498
This is a convenience function - it will use an existing repository
499
if possible, can be told explicitly whether to create a working tree or
502
This will use the current default BzrDirFormat unless one is
503
specified, and use whatever
504
repository format that that uses via bzrdir.create_branch and
505
create_repository. If a shared repository is available that is used
506
preferentially. Whatever repository is used, its tree creation policy
509
The created Branch object is returned.
510
If a working tree cannot be made due to base not being a file:// url,
511
no error is raised unless force_new_tree is True, in which case no
512
data is created on disk and NotLocalUrl is raised.
514
:param base: The URL to create the branch at.
515
:param force_new_repo: If True a new repository is always created.
516
:param force_new_tree: If True or False force creation of a tree or
517
prevent such creation respectively.
518
:param format: Override for the bzrdir format to create.
519
:param possible_transports: An optional reusable transports list.
522
# check for non local urls
523
t = get_transport(base, possible_transports)
524
if not isinstance(t, local.LocalTransport):
525
raise errors.NotLocalUrl(base)
526
bzrdir = BzrDir.create(base, format, possible_transports)
527
repo = bzrdir._find_or_create_repository(force_new_repo)
528
result = bzrdir.create_branch()
529
if force_new_tree or (repo.make_working_trees() and
530
force_new_tree is None):
532
bzrdir.create_workingtree()
533
except errors.NotLocalUrl:
538
def create_standalone_workingtree(base, format=None):
539
"""Create a new BzrDir, WorkingTree, Branch and Repository at 'base'.
541
'base' must be a local path or a file:// url.
543
This will use the current default BzrDirFormat unless one is
544
specified, and use whatever
545
repository format that that uses for bzrdirformat.create_workingtree,
546
create_branch and create_repository.
548
:param format: Override for the bzrdir format to create.
549
:return: The WorkingTree object.
551
t = get_transport(base)
552
if not isinstance(t, local.LocalTransport):
553
raise errors.NotLocalUrl(base)
554
bzrdir = BzrDir.create_branch_and_repo(base,
556
format=format).bzrdir
557
return bzrdir.create_workingtree()
559
def create_workingtree(self, revision_id=None, from_branch=None,
560
accelerator_tree=None, hardlink=False):
561
"""Create a working tree at this BzrDir.
563
:param revision_id: create it as of this revision id.
564
:param from_branch: override bzrdir branch (for lightweight checkouts)
565
:param accelerator_tree: A tree which can be used for retrieving file
566
contents more quickly than the revision tree, i.e. a workingtree.
567
The revision tree will be used for cases where accelerator_tree's
568
content is different.
570
raise NotImplementedError(self.create_workingtree)
572
def backup_bzrdir(self):
573
"""Backup this bzr control directory.
575
:return: Tuple with old path name and new path name
577
pb = ui.ui_factory.nested_progress_bar()
579
# FIXME: bug 300001 -- the backup fails if the backup directory
580
# already exists, but it should instead either remove it or make
581
# a new backup directory.
583
# FIXME: bug 262450 -- the backup directory should have the same
584
# permissions as the .bzr directory (probably a bug in copy_tree)
585
old_path = self.root_transport.abspath('.bzr')
586
new_path = self.root_transport.abspath('backup.bzr')
587
ui.ui_factory.note('making backup of %s\n to %s' % (old_path, new_path,))
588
self.root_transport.copy_tree('.bzr', 'backup.bzr')
589
return (old_path, new_path)
593
def retire_bzrdir(self, limit=10000):
594
"""Permanently disable the bzrdir.
596
This is done by renaming it to give the user some ability to recover
597
if there was a problem.
599
This will have horrible consequences if anyone has anything locked or
601
:param limit: number of times to retry
606
to_path = '.bzr.retired.%d' % i
607
self.root_transport.rename('.bzr', to_path)
608
note("renamed %s to %s"
609
% (self.root_transport.abspath('.bzr'), to_path))
611
except (errors.TransportError, IOError, errors.PathError):
618
def destroy_workingtree(self):
619
"""Destroy the working tree at this BzrDir.
621
Formats that do not support this may raise UnsupportedOperation.
623
raise NotImplementedError(self.destroy_workingtree)
625
def destroy_workingtree_metadata(self):
626
"""Destroy the control files for the working tree at this BzrDir.
628
The contents of working tree files are not affected.
629
Formats that do not support this may raise UnsupportedOperation.
631
raise NotImplementedError(self.destroy_workingtree_metadata)
633
def _find_containing(self, evaluate):
634
"""Find something in a containing control directory.
636
This method will scan containing control dirs, until it finds what
637
it is looking for, decides that it will never find it, or runs out
638
of containing control directories to check.
640
It is used to implement find_repository and
641
determine_repository_policy.
643
:param evaluate: A function returning (value, stop). If stop is True,
644
the value will be returned.
648
result, stop = evaluate(found_bzrdir)
651
next_transport = found_bzrdir.root_transport.clone('..')
652
if (found_bzrdir.root_transport.base == next_transport.base):
653
# top of the file system
655
# find the next containing bzrdir
657
found_bzrdir = BzrDir.open_containing_from_transport(
659
except errors.NotBranchError:
662
def find_repository(self):
663
"""Find the repository that should be used.
665
This does not require a branch as we use it to find the repo for
666
new branches as well as to hook existing branches up to their
669
def usable_repository(found_bzrdir):
670
# does it have a repository ?
672
repository = found_bzrdir.open_repository()
673
except errors.NoRepositoryPresent:
675
if found_bzrdir.root_transport.base == self.root_transport.base:
676
return repository, True
677
elif repository.is_shared():
678
return repository, True
682
found_repo = self._find_containing(usable_repository)
683
if found_repo is None:
684
raise errors.NoRepositoryPresent(self)
687
def get_branch_reference(self):
688
"""Return the referenced URL for the branch in this bzrdir.
690
:raises NotBranchError: If there is no Branch.
691
:return: The URL the branch in this bzrdir references if it is a
692
reference branch, or None for regular branches.
696
def get_branch_transport(self, branch_format):
697
"""Get the transport for use by branch format in this BzrDir.
699
Note that bzr dirs that do not support format strings will raise
700
IncompatibleFormat if the branch format they are given has
701
a format string, and vice versa.
703
If branch_format is None, the transport is returned with no
704
checking. If it is not None, then the returned transport is
705
guaranteed to point to an existing directory ready for use.
707
raise NotImplementedError(self.get_branch_transport)
709
def _find_creation_modes(self):
710
"""Determine the appropriate modes for files and directories.
712
They're always set to be consistent with the base directory,
713
assuming that this transport allows setting modes.
715
# TODO: Do we need or want an option (maybe a config setting) to turn
716
# this off or override it for particular locations? -- mbp 20080512
717
if self._mode_check_done:
719
self._mode_check_done = True
721
st = self.transport.stat('.')
722
except errors.TransportNotPossible:
723
self._dir_mode = None
724
self._file_mode = None
726
# Check the directory mode, but also make sure the created
727
# directories and files are read-write for this user. This is
728
# mostly a workaround for filesystems which lie about being able to
729
# write to a directory (cygwin & win32)
730
if (st.st_mode & 07777 == 00000):
731
# FTP allows stat but does not return dir/file modes
732
self._dir_mode = None
733
self._file_mode = None
735
self._dir_mode = (st.st_mode & 07777) | 00700
736
# Remove the sticky and execute bits for files
737
self._file_mode = self._dir_mode & ~07111
739
def _get_file_mode(self):
740
"""Return Unix mode for newly created files, or None.
742
if not self._mode_check_done:
743
self._find_creation_modes()
744
return self._file_mode
746
def _get_dir_mode(self):
747
"""Return Unix mode for newly created directories, or None.
749
if not self._mode_check_done:
750
self._find_creation_modes()
751
return self._dir_mode
753
def get_repository_transport(self, repository_format):
754
"""Get the transport for use by repository format in this BzrDir.
756
Note that bzr dirs that do not support format strings will raise
757
IncompatibleFormat if the repository format they are given has
758
a format string, and vice versa.
760
If repository_format is None, the transport is returned with no
761
checking. If it is not None, then the returned transport is
762
guaranteed to point to an existing directory ready for use.
764
raise NotImplementedError(self.get_repository_transport)
766
def get_workingtree_transport(self, tree_format):
767
"""Get the transport for use by workingtree format in this BzrDir.
769
Note that bzr dirs that do not support format strings will raise
770
IncompatibleFormat if the workingtree format they are given has a
771
format string, and vice versa.
773
If workingtree_format is None, the transport is returned with no
774
checking. If it is not None, then the returned transport is
775
guaranteed to point to an existing directory ready for use.
777
raise NotImplementedError(self.get_workingtree_transport)
779
def get_config(self):
780
"""Get configuration for this BzrDir."""
781
return config.BzrDirConfig(self)
783
def _get_config(self):
784
"""By default, no configuration is available."""
787
def __init__(self, _transport, _format):
788
"""Initialize a Bzr control dir object.
790
Only really common logic should reside here, concrete classes should be
791
made with varying behaviours.
793
:param _format: the format that is creating this BzrDir instance.
794
:param _transport: the transport this dir is based at.
796
self._format = _format
797
self.transport = _transport.clone('.bzr')
798
self.root_transport = _transport
799
self._mode_check_done = False
801
def is_control_filename(self, filename):
802
"""True if filename is the name of a path which is reserved for bzrdir's.
804
:param filename: A filename within the root transport of this bzrdir.
806
This is true IF and ONLY IF the filename is part of the namespace reserved
807
for bzr control dirs. Currently this is the '.bzr' directory in the root
808
of the root_transport. it is expected that plugins will need to extend
809
this in the future - for instance to make bzr talk with svn working
812
# this might be better on the BzrDirFormat class because it refers to
813
# all the possible bzrdir disk formats.
814
# This method is tested via the workingtree is_control_filename tests-
815
# it was extracted from WorkingTree.is_control_filename. If the method's
816
# contract is extended beyond the current trivial implementation, please
817
# add new tests for it to the appropriate place.
818
return filename == '.bzr' or filename.startswith('.bzr/')
820
def needs_format_conversion(self, format=None):
821
"""Return true if this bzrdir needs convert_format run on it.
823
For instance, if the repository format is out of date but the
824
branch and working tree are not, this should return True.
826
:param format: Optional parameter indicating a specific desired
827
format we plan to arrive at.
829
raise NotImplementedError(self.needs_format_conversion)
832
def open_unsupported(base):
833
"""Open a branch which is not supported."""
834
return BzrDir.open(base, _unsupported=True)
837
def open(base, _unsupported=False, possible_transports=None):
838
"""Open an existing bzrdir, rooted at 'base' (url).
840
:param _unsupported: a private parameter to the BzrDir class.
842
t = get_transport(base, possible_transports=possible_transports)
843
return BzrDir.open_from_transport(t, _unsupported=_unsupported)
846
def open_from_transport(transport, _unsupported=False,
847
_server_formats=True):
848
"""Open a bzrdir within a particular directory.
850
:param transport: Transport containing the bzrdir.
851
:param _unsupported: private.
853
for hook in BzrDir.hooks['pre_open']:
855
# Keep initial base since 'transport' may be modified while following
857
base = transport.base
858
def find_format(transport):
859
return transport, BzrDirFormat.find_format(
860
transport, _server_formats=_server_formats)
862
def redirected(transport, e, redirection_notice):
863
redirected_transport = transport._redirected_to(e.source, e.target)
864
if redirected_transport is None:
865
raise errors.NotBranchError(base)
866
note('%s is%s redirected to %s',
867
transport.base, e.permanently, redirected_transport.base)
868
return redirected_transport
871
transport, format = do_catching_redirections(find_format,
874
except errors.TooManyRedirections:
875
raise errors.NotBranchError(base)
877
BzrDir._check_supported(format, _unsupported)
878
return format.open(transport, _found=True)
880
def open_branch(self, unsupported=False, ignore_fallbacks=False):
881
"""Open the branch object at this BzrDir if one is present.
883
If unsupported is True, then no longer supported branch formats can
886
TODO: static convenience version of this?
888
raise NotImplementedError(self.open_branch)
891
def open_containing(url, possible_transports=None):
892
"""Open an existing branch which contains url.
894
:param url: url to search from.
895
See open_containing_from_transport for more detail.
897
transport = get_transport(url, possible_transports)
898
return BzrDir.open_containing_from_transport(transport)
901
def open_containing_from_transport(a_transport):
902
"""Open an existing branch which contains a_transport.base.
904
This probes for a branch at a_transport, and searches upwards from there.
906
Basically we keep looking up until we find the control directory or
907
run into the root. If there isn't one, raises NotBranchError.
908
If there is one and it is either an unrecognised format or an unsupported
909
format, UnknownFormatError or UnsupportedFormatError are raised.
910
If there is one, it is returned, along with the unused portion of url.
912
:return: The BzrDir that contains the path, and a Unicode path
913
for the rest of the URL.
915
# this gets the normalised url back. I.e. '.' -> the full path.
916
url = a_transport.base
919
result = BzrDir.open_from_transport(a_transport)
920
return result, urlutils.unescape(a_transport.relpath(url))
921
except errors.NotBranchError, e:
924
new_t = a_transport.clone('..')
925
except errors.InvalidURLJoin:
926
# reached the root, whatever that may be
927
raise errors.NotBranchError(path=url)
928
if new_t.base == a_transport.base:
929
# reached the root, whatever that may be
930
raise errors.NotBranchError(path=url)
933
def _get_tree_branch(self):
934
"""Return the branch and tree, if any, for this bzrdir.
936
Return None for tree if not present or inaccessible.
937
Raise NotBranchError if no branch is present.
938
:return: (tree, branch)
941
tree = self.open_workingtree()
942
except (errors.NoWorkingTree, errors.NotLocalUrl):
944
branch = self.open_branch()
950
def open_tree_or_branch(klass, location):
951
"""Return the branch and working tree at a location.
953
If there is no tree at the location, tree will be None.
954
If there is no branch at the location, an exception will be
956
:return: (tree, branch)
958
bzrdir = klass.open(location)
959
return bzrdir._get_tree_branch()
962
def open_containing_tree_or_branch(klass, location):
963
"""Return the branch and working tree contained by a location.
965
Returns (tree, branch, relpath).
966
If there is no tree at containing the location, tree will be None.
967
If there is no branch containing the location, an exception will be
969
relpath is the portion of the path that is contained by the branch.
971
bzrdir, relpath = klass.open_containing(location)
972
tree, branch = bzrdir._get_tree_branch()
973
return tree, branch, relpath
976
def open_containing_tree_branch_or_repository(klass, location):
977
"""Return the working tree, branch and repo contained by a location.
979
Returns (tree, branch, repository, relpath).
980
If there is no tree containing the location, tree will be None.
981
If there is no branch containing the location, branch will be None.
982
If there is no repository containing the location, repository will be
984
relpath is the portion of the path that is contained by the innermost
987
If no tree, branch or repository is found, a NotBranchError is raised.
989
bzrdir, relpath = klass.open_containing(location)
991
tree, branch = bzrdir._get_tree_branch()
992
except errors.NotBranchError:
994
repo = bzrdir.find_repository()
995
return None, None, repo, relpath
996
except (errors.NoRepositoryPresent):
997
raise errors.NotBranchError(location)
998
return tree, branch, branch.repository, relpath
1000
def open_repository(self, _unsupported=False):
1001
"""Open the repository object at this BzrDir if one is present.
1003
This will not follow the Branch object pointer - it's strictly a direct
1004
open facility. Most client code should use open_branch().repository to
1005
get at a repository.
1007
:param _unsupported: a private parameter, not part of the api.
1008
TODO: static convenience version of this?
1010
raise NotImplementedError(self.open_repository)
1012
def open_workingtree(self, _unsupported=False,
1013
recommend_upgrade=True, from_branch=None):
1014
"""Open the workingtree object at this BzrDir if one is present.
1016
:param recommend_upgrade: Optional keyword parameter, when True (the
1017
default), emit through the ui module a recommendation that the user
1018
upgrade the working tree when the workingtree being opened is old
1019
(but still fully supported).
1020
:param from_branch: override bzrdir branch (for lightweight checkouts)
1022
raise NotImplementedError(self.open_workingtree)
1024
def has_branch(self):
1025
"""Tell if this bzrdir contains a branch.
1027
Note: if you're going to open the branch, you should just go ahead
1028
and try, and not ask permission first. (This method just opens the
1029
branch and discards it, and that's somewhat expensive.)
1034
except errors.NotBranchError:
1037
def has_workingtree(self):
1038
"""Tell if this bzrdir contains a working tree.
1040
This will still raise an exception if the bzrdir has a workingtree that
1041
is remote & inaccessible.
1043
Note: if you're going to open the working tree, you should just go ahead
1044
and try, and not ask permission first. (This method just opens the
1045
workingtree and discards it, and that's somewhat expensive.)
1048
self.open_workingtree(recommend_upgrade=False)
1050
except errors.NoWorkingTree:
1053
def _cloning_metadir(self):
1054
"""Produce a metadir suitable for cloning with.
1056
:returns: (destination_bzrdir_format, source_repository)
1058
result_format = self._format.__class__()
1061
branch = self.open_branch(ignore_fallbacks=True)
1062
source_repository = branch.repository
1063
result_format._branch_format = branch._format
1064
except errors.NotBranchError:
1065
source_branch = None
1066
source_repository = self.open_repository()
1067
except errors.NoRepositoryPresent:
1068
source_repository = None
1070
# XXX TODO: This isinstance is here because we have not implemented
1071
# the fix recommended in bug # 103195 - to delegate this choice the
1072
# repository itself.
1073
repo_format = source_repository._format
1074
if isinstance(repo_format, remote.RemoteRepositoryFormat):
1075
source_repository._ensure_real()
1076
repo_format = source_repository._real_repository._format
1077
result_format.repository_format = repo_format
1079
# TODO: Couldn't we just probe for the format in these cases,
1080
# rather than opening the whole tree? It would be a little
1081
# faster. mbp 20070401
1082
tree = self.open_workingtree(recommend_upgrade=False)
1083
except (errors.NoWorkingTree, errors.NotLocalUrl):
1084
result_format.workingtree_format = None
1086
result_format.workingtree_format = tree._format.__class__()
1087
return result_format, source_repository
1089
def cloning_metadir(self, require_stacking=False):
1090
"""Produce a metadir suitable for cloning or sprouting with.
1092
These operations may produce workingtrees (yes, even though they're
1093
"cloning" something that doesn't have a tree), so a viable workingtree
1094
format must be selected.
1096
:require_stacking: If True, non-stackable formats will be upgraded
1097
to similar stackable formats.
1098
:returns: a BzrDirFormat with all component formats either set
1099
appropriately or set to None if that component should not be
1102
format, repository = self._cloning_metadir()
1103
if format._workingtree_format is None:
1105
if repository is None:
1106
# No repository either
1108
# We have a repository, so set a working tree? (Why? This seems to
1109
# contradict the stated return value in the docstring).
1110
tree_format = repository._format._matchingbzrdir.workingtree_format
1111
format.workingtree_format = tree_format.__class__()
1112
if require_stacking:
1113
format.require_stacking()
1116
def checkout_metadir(self):
1117
return self.cloning_metadir()
1119
def sprout(self, url, revision_id=None, force_new_repo=False,
1120
recurse='down', possible_transports=None,
1121
accelerator_tree=None, hardlink=False, stacked=False,
1122
source_branch=None, create_tree_if_local=True):
1123
"""Create a copy of this bzrdir prepared for use as a new line of
1126
If url's last component does not exist, it will be created.
1128
Attributes related to the identity of the source branch like
1129
branch nickname will be cleaned, a working tree is created
1130
whether one existed before or not; and a local branch is always
1133
if revision_id is not None, then the clone operation may tune
1134
itself to download less data.
1135
:param accelerator_tree: A tree which can be used for retrieving file
1136
contents more quickly than the revision tree, i.e. a workingtree.
1137
The revision tree will be used for cases where accelerator_tree's
1138
content is different.
1139
:param hardlink: If true, hard-link files from accelerator_tree,
1141
:param stacked: If true, create a stacked branch referring to the
1142
location of this control directory.
1143
:param create_tree_if_local: If true, a working-tree will be created
1144
when working locally.
1146
target_transport = get_transport(url, possible_transports)
1147
target_transport.ensure_base()
1148
cloning_format = self.cloning_metadir(stacked)
1149
# Create/update the result branch
1150
result = cloning_format.initialize_on_transport(target_transport)
1151
# if a stacked branch wasn't requested, we don't create one
1152
# even if the origin was stacked
1153
stacked_branch_url = None
1154
if source_branch is not None:
1156
stacked_branch_url = self.root_transport.base
1157
source_repository = source_branch.repository
1160
source_branch = self.open_branch()
1161
source_repository = source_branch.repository
1163
stacked_branch_url = self.root_transport.base
1164
except errors.NotBranchError:
1165
source_branch = None
1167
source_repository = self.open_repository()
1168
except errors.NoRepositoryPresent:
1169
source_repository = None
1170
repository_policy = result.determine_repository_policy(
1171
force_new_repo, stacked_branch_url, require_stacking=stacked)
1172
result_repo, is_new_repo = repository_policy.acquire_repository()
1173
if is_new_repo and revision_id is not None and not stacked:
1174
fetch_spec = graph.PendingAncestryResult(
1175
[revision_id], source_repository)
1178
if source_repository is not None:
1179
# Fetch while stacked to prevent unstacked fetch from
1181
if fetch_spec is None:
1182
result_repo.fetch(source_repository, revision_id=revision_id)
1184
result_repo.fetch(source_repository, fetch_spec=fetch_spec)
1186
if source_branch is None:
1187
# this is for sprouting a bzrdir without a branch; is that
1189
# Not especially, but it's part of the contract.
1190
result_branch = result.create_branch()
1192
result_branch = source_branch.sprout(result,
1193
revision_id=revision_id, repository_policy=repository_policy)
1194
mutter("created new branch %r" % (result_branch,))
1196
# Create/update the result working tree
1197
if (create_tree_if_local and
1198
isinstance(target_transport, local.LocalTransport) and
1199
(result_repo is None or result_repo.make_working_trees())):
1200
wt = result.create_workingtree(accelerator_tree=accelerator_tree,
1204
if wt.path2id('') is None:
1206
wt.set_root_id(self.open_workingtree.get_root_id())
1207
except errors.NoWorkingTree:
1213
if recurse == 'down':
1215
basis = wt.basis_tree()
1217
subtrees = basis.iter_references()
1218
elif result_branch is not None:
1219
basis = result_branch.basis_tree()
1221
subtrees = basis.iter_references()
1222
elif source_branch is not None:
1223
basis = source_branch.basis_tree()
1225
subtrees = basis.iter_references()
1230
for path, file_id in subtrees:
1231
target = urlutils.join(url, urlutils.escape(path))
1232
sublocation = source_branch.reference_parent(file_id, path)
1233
sublocation.bzrdir.sprout(target,
1234
basis.get_reference_revision(file_id, path),
1235
force_new_repo=force_new_repo, recurse=recurse,
1238
if basis is not None:
1242
def push_branch(self, source, revision_id=None, overwrite=False,
1243
remember=False, create_prefix=False):
1244
"""Push the source branch into this BzrDir."""
1246
# If we can open a branch, use its direct repository, otherwise see
1247
# if there is a repository without a branch.
1249
br_to = self.open_branch()
1250
except errors.NotBranchError:
1251
# Didn't find a branch, can we find a repository?
1252
repository_to = self.find_repository()
1254
# Found a branch, so we must have found a repository
1255
repository_to = br_to.repository
1257
push_result = PushResult()
1258
push_result.source_branch = source
1260
# We have a repository but no branch, copy the revisions, and then
1262
repository_to.fetch(source.repository, revision_id=revision_id)
1263
br_to = source.clone(self, revision_id=revision_id)
1264
if source.get_push_location() is None or remember:
1265
source.set_push_location(br_to.base)
1266
push_result.stacked_on = None
1267
push_result.branch_push_result = None
1268
push_result.old_revno = None
1269
push_result.old_revid = _mod_revision.NULL_REVISION
1270
push_result.target_branch = br_to
1271
push_result.master_branch = None
1272
push_result.workingtree_updated = False
1274
# We have successfully opened the branch, remember if necessary:
1275
if source.get_push_location() is None or remember:
1276
source.set_push_location(br_to.base)
1278
tree_to = self.open_workingtree()
1279
except errors.NotLocalUrl:
1280
push_result.branch_push_result = source.push(br_to,
1281
overwrite, stop_revision=revision_id)
1282
push_result.workingtree_updated = False
1283
except errors.NoWorkingTree:
1284
push_result.branch_push_result = source.push(br_to,
1285
overwrite, stop_revision=revision_id)
1286
push_result.workingtree_updated = None # Not applicable
1288
tree_to.lock_write()
1290
push_result.branch_push_result = source.push(
1291
tree_to.branch, overwrite, stop_revision=revision_id)
1295
push_result.workingtree_updated = True
1296
push_result.old_revno = push_result.branch_push_result.old_revno
1297
push_result.old_revid = push_result.branch_push_result.old_revid
1298
push_result.target_branch = \
1299
push_result.branch_push_result.target_branch
1303
class BzrDirHooks(hooks.Hooks):
1304
"""Hooks for BzrDir operations."""
1307
"""Create the default hooks."""
1308
hooks.Hooks.__init__(self)
1309
self.create_hook(hooks.HookPoint('pre_open',
1310
"Invoked before attempting to open a BzrDir with the transport "
1311
"that the open will use.", (1, 14), None))
1313
# install the default hooks
1314
BzrDir.hooks = BzrDirHooks()
1317
class BzrDirPreSplitOut(BzrDir):
1318
"""A common class for the all-in-one formats."""
1320
def __init__(self, _transport, _format):
1321
"""See BzrDir.__init__."""
1322
super(BzrDirPreSplitOut, self).__init__(_transport, _format)
1323
self._control_files = lockable_files.LockableFiles(
1324
self.get_branch_transport(None),
1325
self._format._lock_file_name,
1326
self._format._lock_class)
1328
def break_lock(self):
1329
"""Pre-splitout bzrdirs do not suffer from stale locks."""
1330
raise NotImplementedError(self.break_lock)
1332
def cloning_metadir(self, require_stacking=False):
1333
"""Produce a metadir suitable for cloning with."""
1334
if require_stacking:
1335
return format_registry.make_bzrdir('1.6')
1336
return self._format.__class__()
1338
def clone(self, url, revision_id=None, force_new_repo=False,
1339
preserve_stacking=False):
1340
"""See BzrDir.clone().
1342
force_new_repo has no effect, since this family of formats always
1343
require a new repository.
1344
preserve_stacking has no effect, since no source branch using this
1345
family of formats can be stacked, so there is no stacking to preserve.
1347
self._make_tail(url)
1348
result = self._format._initialize_for_clone(url)
1349
self.open_repository().clone(result, revision_id=revision_id)
1350
from_branch = self.open_branch()
1351
from_branch.clone(result, revision_id=revision_id)
1353
tree = self.open_workingtree()
1354
except errors.NotLocalUrl:
1355
# make a new one, this format always has to have one.
1356
result._init_workingtree()
1361
def create_branch(self):
1362
"""See BzrDir.create_branch."""
1363
return self._format.get_branch_format().initialize(self)
1365
def destroy_branch(self):
1366
"""See BzrDir.destroy_branch."""
1367
raise errors.UnsupportedOperation(self.destroy_branch, self)
1369
def create_repository(self, shared=False):
1370
"""See BzrDir.create_repository."""
1372
raise errors.IncompatibleFormat('shared repository', self._format)
1373
return self.open_repository()
1375
def destroy_repository(self):
1376
"""See BzrDir.destroy_repository."""
1377
raise errors.UnsupportedOperation(self.destroy_repository, self)
1379
def create_workingtree(self, revision_id=None, from_branch=None,
1380
accelerator_tree=None, hardlink=False):
1381
"""See BzrDir.create_workingtree."""
1382
# The workingtree is sometimes created when the bzrdir is created,
1383
# but not when cloning.
1385
# this looks buggy but is not -really-
1386
# because this format creates the workingtree when the bzrdir is
1388
# clone and sprout will have set the revision_id
1389
# and that will have set it for us, its only
1390
# specific uses of create_workingtree in isolation
1391
# that can do wonky stuff here, and that only
1392
# happens for creating checkouts, which cannot be
1393
# done on this format anyway. So - acceptable wart.
1395
warning("can't support hardlinked working trees in %r"
1398
result = self.open_workingtree(recommend_upgrade=False)
1399
except errors.NoSuchFile:
1400
result = self._init_workingtree()
1401
if revision_id is not None:
1402
if revision_id == _mod_revision.NULL_REVISION:
1403
result.set_parent_ids([])
1405
result.set_parent_ids([revision_id])
1408
def _init_workingtree(self):
1409
from bzrlib.workingtree import WorkingTreeFormat2
1411
return WorkingTreeFormat2().initialize(self)
1412
except errors.NotLocalUrl:
1413
# Even though we can't access the working tree, we need to
1414
# create its control files.
1415
return WorkingTreeFormat2()._stub_initialize_on_transport(
1416
self.transport, self._control_files._file_mode)
1418
def destroy_workingtree(self):
1419
"""See BzrDir.destroy_workingtree."""
1420
raise errors.UnsupportedOperation(self.destroy_workingtree, self)
1422
def destroy_workingtree_metadata(self):
1423
"""See BzrDir.destroy_workingtree_metadata."""
1424
raise errors.UnsupportedOperation(self.destroy_workingtree_metadata,
1427
def get_branch_transport(self, branch_format):
1428
"""See BzrDir.get_branch_transport()."""
1429
if branch_format is None:
1430
return self.transport
1432
branch_format.get_format_string()
1433
except NotImplementedError:
1434
return self.transport
1435
raise errors.IncompatibleFormat(branch_format, self._format)
1437
def get_repository_transport(self, repository_format):
1438
"""See BzrDir.get_repository_transport()."""
1439
if repository_format is None:
1440
return self.transport
1442
repository_format.get_format_string()
1443
except NotImplementedError:
1444
return self.transport
1445
raise errors.IncompatibleFormat(repository_format, self._format)
1447
def get_workingtree_transport(self, workingtree_format):
1448
"""See BzrDir.get_workingtree_transport()."""
1449
if workingtree_format is None:
1450
return self.transport
1452
workingtree_format.get_format_string()
1453
except NotImplementedError:
1454
return self.transport
1455
raise errors.IncompatibleFormat(workingtree_format, self._format)
1457
def needs_format_conversion(self, format=None):
1458
"""See BzrDir.needs_format_conversion()."""
1459
# if the format is not the same as the system default,
1460
# an upgrade is needed.
1462
symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1463
% 'needs_format_conversion(format=None)')
1464
format = BzrDirFormat.get_default_format()
1465
return not isinstance(self._format, format.__class__)
1467
def open_branch(self, unsupported=False, ignore_fallbacks=False):
1468
"""See BzrDir.open_branch."""
1469
from bzrlib.branch import BzrBranchFormat4
1470
format = BzrBranchFormat4()
1471
self._check_supported(format, unsupported)
1472
return format.open(self, _found=True)
1474
def sprout(self, url, revision_id=None, force_new_repo=False,
1475
possible_transports=None, accelerator_tree=None,
1476
hardlink=False, stacked=False, create_tree_if_local=True,
1477
source_branch=None):
1478
"""See BzrDir.sprout()."""
1479
if source_branch is not None:
1480
my_branch = self.open_branch()
1481
if source_branch.base != my_branch.base:
1482
raise AssertionError(
1483
"source branch %r is not within %r with branch %r" %
1484
(source_branch, self, my_branch))
1486
raise errors.UnstackableBranchFormat(
1487
self._format, self.root_transport.base)
1488
if not create_tree_if_local:
1489
raise errors.MustHaveWorkingTree(
1490
self._format, self.root_transport.base)
1491
from bzrlib.workingtree import WorkingTreeFormat2
1492
self._make_tail(url)
1493
result = self._format._initialize_for_clone(url)
1495
self.open_repository().clone(result, revision_id=revision_id)
1496
except errors.NoRepositoryPresent:
1499
self.open_branch().sprout(result, revision_id=revision_id)
1500
except errors.NotBranchError:
1503
# we always want a working tree
1504
WorkingTreeFormat2().initialize(result,
1505
accelerator_tree=accelerator_tree,
1510
class BzrDir4(BzrDirPreSplitOut):
1511
"""A .bzr version 4 control object.
1513
This is a deprecated format and may be removed after sept 2006.
1516
def create_repository(self, shared=False):
1517
"""See BzrDir.create_repository."""
1518
return self._format.repository_format.initialize(self, shared)
1520
def needs_format_conversion(self, format=None):
1521
"""Format 4 dirs are always in need of conversion."""
1523
symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1524
% 'needs_format_conversion(format=None)')
1527
def open_repository(self):
1528
"""See BzrDir.open_repository."""
1529
from bzrlib.repofmt.weaverepo import RepositoryFormat4
1530
return RepositoryFormat4().open(self, _found=True)
1533
class BzrDir5(BzrDirPreSplitOut):
1534
"""A .bzr version 5 control object.
1536
This is a deprecated format and may be removed after sept 2006.
1539
def open_repository(self):
1540
"""See BzrDir.open_repository."""
1541
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1542
return RepositoryFormat5().open(self, _found=True)
1544
def open_workingtree(self, _unsupported=False,
1545
recommend_upgrade=True):
1546
"""See BzrDir.create_workingtree."""
1547
from bzrlib.workingtree import WorkingTreeFormat2
1548
wt_format = WorkingTreeFormat2()
1549
# we don't warn here about upgrades; that ought to be handled for the
1551
return wt_format.open(self, _found=True)
1554
class BzrDir6(BzrDirPreSplitOut):
1555
"""A .bzr version 6 control object.
1557
This is a deprecated format and may be removed after sept 2006.
1560
def open_repository(self):
1561
"""See BzrDir.open_repository."""
1562
from bzrlib.repofmt.weaverepo import RepositoryFormat6
1563
return RepositoryFormat6().open(self, _found=True)
1565
def open_workingtree(self, _unsupported=False,
1566
recommend_upgrade=True):
1567
"""See BzrDir.create_workingtree."""
1568
# we don't warn here about upgrades; that ought to be handled for the
1570
from bzrlib.workingtree import WorkingTreeFormat2
1571
return WorkingTreeFormat2().open(self, _found=True)
1574
class BzrDirMeta1(BzrDir):
1575
"""A .bzr meta version 1 control object.
1577
This is the first control object where the
1578
individual aspects are really split out: there are separate repository,
1579
workingtree and branch subdirectories and any subset of the three can be
1580
present within a BzrDir.
1583
def can_convert_format(self):
1584
"""See BzrDir.can_convert_format()."""
1587
def create_branch(self):
1588
"""See BzrDir.create_branch."""
1589
return self._format.get_branch_format().initialize(self)
1591
def destroy_branch(self):
1592
"""See BzrDir.create_branch."""
1593
self.transport.delete_tree('branch')
1595
def create_repository(self, shared=False):
1596
"""See BzrDir.create_repository."""
1597
return self._format.repository_format.initialize(self, shared)
1599
def destroy_repository(self):
1600
"""See BzrDir.destroy_repository."""
1601
self.transport.delete_tree('repository')
1603
def create_workingtree(self, revision_id=None, from_branch=None,
1604
accelerator_tree=None, hardlink=False):
1605
"""See BzrDir.create_workingtree."""
1606
return self._format.workingtree_format.initialize(
1607
self, revision_id, from_branch=from_branch,
1608
accelerator_tree=accelerator_tree, hardlink=hardlink)
1610
def destroy_workingtree(self):
1611
"""See BzrDir.destroy_workingtree."""
1612
wt = self.open_workingtree(recommend_upgrade=False)
1613
repository = wt.branch.repository
1614
empty = repository.revision_tree(_mod_revision.NULL_REVISION)
1615
wt.revert(old_tree=empty)
1616
self.destroy_workingtree_metadata()
1618
def destroy_workingtree_metadata(self):
1619
self.transport.delete_tree('checkout')
1621
def find_branch_format(self):
1622
"""Find the branch 'format' for this bzrdir.
1624
This might be a synthetic object for e.g. RemoteBranch and SVN.
1626
from bzrlib.branch import BranchFormat
1627
return BranchFormat.find_format(self)
1629
def _get_mkdir_mode(self):
1630
"""Figure out the mode to use when creating a bzrdir subdir."""
1631
temp_control = lockable_files.LockableFiles(self.transport, '',
1632
lockable_files.TransportLock)
1633
return temp_control._dir_mode
1635
def get_branch_reference(self):
1636
"""See BzrDir.get_branch_reference()."""
1637
from bzrlib.branch import BranchFormat
1638
format = BranchFormat.find_format(self)
1639
return format.get_reference(self)
1641
def get_branch_transport(self, branch_format):
1642
"""See BzrDir.get_branch_transport()."""
1643
# XXX: this shouldn't implicitly create the directory if it's just
1644
# promising to get a transport -- mbp 20090727
1645
if branch_format is None:
1646
return self.transport.clone('branch')
1648
branch_format.get_format_string()
1649
except NotImplementedError:
1650
raise errors.IncompatibleFormat(branch_format, self._format)
1652
self.transport.mkdir('branch', mode=self._get_mkdir_mode())
1653
except errors.FileExists:
1655
return self.transport.clone('branch')
1657
def get_repository_transport(self, repository_format):
1658
"""See BzrDir.get_repository_transport()."""
1659
if repository_format is None:
1660
return self.transport.clone('repository')
1662
repository_format.get_format_string()
1663
except NotImplementedError:
1664
raise errors.IncompatibleFormat(repository_format, self._format)
1666
self.transport.mkdir('repository', mode=self._get_mkdir_mode())
1667
except errors.FileExists:
1669
return self.transport.clone('repository')
1671
def get_workingtree_transport(self, workingtree_format):
1672
"""See BzrDir.get_workingtree_transport()."""
1673
if workingtree_format is None:
1674
return self.transport.clone('checkout')
1676
workingtree_format.get_format_string()
1677
except NotImplementedError:
1678
raise errors.IncompatibleFormat(workingtree_format, self._format)
1680
self.transport.mkdir('checkout', mode=self._get_mkdir_mode())
1681
except errors.FileExists:
1683
return self.transport.clone('checkout')
1685
def needs_format_conversion(self, format=None):
1686
"""See BzrDir.needs_format_conversion()."""
1688
symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1689
% 'needs_format_conversion(format=None)')
1691
format = BzrDirFormat.get_default_format()
1692
if not isinstance(self._format, format.__class__):
1693
# it is not a meta dir format, conversion is needed.
1695
# we might want to push this down to the repository?
1697
if not isinstance(self.open_repository()._format,
1698
format.repository_format.__class__):
1699
# the repository needs an upgrade.
1701
except errors.NoRepositoryPresent:
1704
if not isinstance(self.open_branch()._format,
1705
format.get_branch_format().__class__):
1706
# the branch needs an upgrade.
1708
except errors.NotBranchError:
1711
my_wt = self.open_workingtree(recommend_upgrade=False)
1712
if not isinstance(my_wt._format,
1713
format.workingtree_format.__class__):
1714
# the workingtree needs an upgrade.
1716
except (errors.NoWorkingTree, errors.NotLocalUrl):
1720
def open_branch(self, unsupported=False, ignore_fallbacks=False):
1721
"""See BzrDir.open_branch."""
1722
format = self.find_branch_format()
1723
self._check_supported(format, unsupported)
1724
return format.open(self, _found=True, ignore_fallbacks=ignore_fallbacks)
1726
def open_repository(self, unsupported=False):
1727
"""See BzrDir.open_repository."""
1728
from bzrlib.repository import RepositoryFormat
1729
format = RepositoryFormat.find_format(self)
1730
self._check_supported(format, unsupported)
1731
return format.open(self, _found=True)
1733
def open_workingtree(self, unsupported=False,
1734
recommend_upgrade=True):
1735
"""See BzrDir.open_workingtree."""
1736
from bzrlib.workingtree import WorkingTreeFormat
1737
format = WorkingTreeFormat.find_format(self)
1738
self._check_supported(format, unsupported,
1740
basedir=self.root_transport.base)
1741
return format.open(self, _found=True)
1743
def _get_config(self):
1744
return config.TransportConfig(self.transport, 'control.conf')
1747
class BzrDirFormat(object):
1748
"""An encapsulation of the initialization and open routines for a format.
1750
Formats provide three things:
1751
* An initialization routine,
1755
Formats are placed in a dict by their format string for reference
1756
during bzrdir opening. These should be subclasses of BzrDirFormat
1759
Once a format is deprecated, just deprecate the initialize and open
1760
methods on the format class. Do not deprecate the object, as the
1761
object will be created every system load.
1764
_default_format = None
1765
"""The default format used for new .bzr dirs."""
1768
"""The known formats."""
1770
_control_formats = []
1771
"""The registered control formats - .bzr, ....
1773
This is a list of BzrDirFormat objects.
1776
_control_server_formats = []
1777
"""The registered control server formats, e.g. RemoteBzrDirs.
1779
This is a list of BzrDirFormat objects.
1782
_lock_file_name = 'branch-lock'
1784
# _lock_class must be set in subclasses to the lock type, typ.
1785
# TransportLock or LockDir
1788
def find_format(klass, transport, _server_formats=True):
1789
"""Return the format present at transport."""
1791
formats = klass._control_server_formats + klass._control_formats
1793
formats = klass._control_formats
1794
for format in formats:
1796
return format.probe_transport(transport)
1797
except errors.NotBranchError:
1798
# this format does not find a control dir here.
1800
raise errors.NotBranchError(path=transport.base)
1803
def probe_transport(klass, transport):
1804
"""Return the .bzrdir style format present in a directory."""
1806
format_string = transport.get(".bzr/branch-format").read()
1807
except errors.NoSuchFile:
1808
raise errors.NotBranchError(path=transport.base)
1811
return klass._formats[format_string]
1813
raise errors.UnknownFormatError(format=format_string, kind='bzrdir')
1816
def get_default_format(klass):
1817
"""Return the current default format."""
1818
return klass._default_format
1820
def get_format_string(self):
1821
"""Return the ASCII format string that identifies this format."""
1822
raise NotImplementedError(self.get_format_string)
1824
def get_format_description(self):
1825
"""Return the short description for this format."""
1826
raise NotImplementedError(self.get_format_description)
1828
def get_converter(self, format=None):
1829
"""Return the converter to use to convert bzrdirs needing converts.
1831
This returns a bzrlib.bzrdir.Converter object.
1833
This should return the best upgrader to step this format towards the
1834
current default format. In the case of plugins we can/should provide
1835
some means for them to extend the range of returnable converters.
1837
:param format: Optional format to override the default format of the
1840
raise NotImplementedError(self.get_converter)
1842
def initialize(self, url, possible_transports=None):
1843
"""Create a bzr control dir at this url and return an opened copy.
1845
While not deprecated, this method is very specific and its use will
1846
lead to many round trips to setup a working environment. See
1847
initialize_on_transport_ex for a [nearly] all-in-one method.
1849
Subclasses should typically override initialize_on_transport
1850
instead of this method.
1852
return self.initialize_on_transport(get_transport(url,
1853
possible_transports))
1855
def initialize_on_transport(self, transport):
1856
"""Initialize a new bzrdir in the base directory of a Transport."""
1858
# can we hand off the request to the smart server rather than using
1860
client_medium = transport.get_smart_medium()
1861
except errors.NoSmartMedium:
1862
return self._initialize_on_transport_vfs(transport)
1864
# Current RPC's only know how to create bzr metadir1 instances, so
1865
# we still delegate to vfs methods if the requested format is not a
1867
if type(self) != BzrDirMetaFormat1:
1868
return self._initialize_on_transport_vfs(transport)
1869
remote_format = RemoteBzrDirFormat()
1870
self._supply_sub_formats_to(remote_format)
1871
return remote_format.initialize_on_transport(transport)
1873
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
1874
create_prefix=False, force_new_repo=False, stacked_on=None,
1875
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
1876
shared_repo=False, vfs_only=False):
1877
"""Create this format on transport.
1879
The directory to initialize will be created.
1881
:param force_new_repo: Do not use a shared repository for the target,
1882
even if one is available.
1883
:param create_prefix: Create any missing directories leading up to
1885
:param use_existing_dir: Use an existing directory if one exists.
1886
:param stacked_on: A url to stack any created branch on, None to follow
1887
any target stacking policy.
1888
:param stack_on_pwd: If stack_on is relative, the location it is
1890
:param repo_format_name: If non-None, a repository will be
1891
made-or-found. Should none be found, or if force_new_repo is True
1892
the repo_format_name is used to select the format of repository to
1894
:param make_working_trees: Control the setting of make_working_trees
1895
for a new shared repository when one is made. None to use whatever
1896
default the format has.
1897
:param shared_repo: Control whether made repositories are shared or
1899
:param vfs_only: If True do not attempt to use a smart server
1900
:return: repo, bzrdir, require_stacking, repository_policy. repo is
1901
None if none was created or found, bzrdir is always valid.
1902
require_stacking is the result of examining the stacked_on
1903
parameter and any stacking policy found for the target.
1906
# Try to hand off to a smart server
1908
client_medium = transport.get_smart_medium()
1909
except errors.NoSmartMedium:
1912
# TODO: lookup the local format from a server hint.
1913
remote_dir_format = RemoteBzrDirFormat()
1914
remote_dir_format._network_name = self.network_name()
1915
self._supply_sub_formats_to(remote_dir_format)
1916
return remote_dir_format.initialize_on_transport_ex(transport,
1917
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
1918
force_new_repo=force_new_repo, stacked_on=stacked_on,
1919
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
1920
make_working_trees=make_working_trees, shared_repo=shared_repo)
1921
# XXX: Refactor the create_prefix/no_create_prefix code into a
1922
# common helper function
1923
# The destination may not exist - if so make it according to policy.
1924
def make_directory(transport):
1925
transport.mkdir('.')
1927
def redirected(transport, e, redirection_notice):
1928
note(redirection_notice)
1929
return transport._redirected_to(e.source, e.target)
1931
transport = do_catching_redirections(make_directory, transport,
1933
except errors.FileExists:
1934
if not use_existing_dir:
1936
except errors.NoSuchFile:
1937
if not create_prefix:
1939
transport.create_prefix()
1941
require_stacking = (stacked_on is not None)
1942
# Now the target directory exists, but doesn't have a .bzr
1943
# directory. So we need to create it, along with any work to create
1944
# all of the dependent branches, etc.
1946
result = self.initialize_on_transport(transport)
1947
if repo_format_name:
1949
# use a custom format
1950
result._format.repository_format = \
1951
repository.network_format_registry.get(repo_format_name)
1952
except AttributeError:
1953
# The format didn't permit it to be set.
1955
# A repository is desired, either in-place or shared.
1956
repository_policy = result.determine_repository_policy(
1957
force_new_repo, stacked_on, stack_on_pwd,
1958
require_stacking=require_stacking)
1959
result_repo, is_new_repo = repository_policy.acquire_repository(
1960
make_working_trees, shared_repo)
1961
if not require_stacking and repository_policy._require_stacking:
1962
require_stacking = True
1963
result._format.require_stacking()
1964
result_repo.lock_write()
1967
repository_policy = None
1968
return result_repo, result, require_stacking, repository_policy
1970
def _initialize_on_transport_vfs(self, transport):
1971
"""Initialize a new bzrdir using VFS calls.
1973
:param transport: The transport to create the .bzr directory in.
1976
# Since we are creating a .bzr directory, inherit the
1977
# mode from the root directory
1978
temp_control = lockable_files.LockableFiles(transport,
1979
'', lockable_files.TransportLock)
1980
temp_control._transport.mkdir('.bzr',
1981
# FIXME: RBC 20060121 don't peek under
1983
mode=temp_control._dir_mode)
1984
if sys.platform == 'win32' and isinstance(transport, local.LocalTransport):
1985
win32utils.set_file_attr_hidden(transport._abspath('.bzr'))
1986
file_mode = temp_control._file_mode
1988
bzrdir_transport = transport.clone('.bzr')
1989
utf8_files = [('README',
1990
"This is a Bazaar control directory.\n"
1991
"Do not change any files in this directory.\n"
1992
"See http://bazaar-vcs.org/ for more information about Bazaar.\n"),
1993
('branch-format', self.get_format_string()),
1995
# NB: no need to escape relative paths that are url safe.
1996
control_files = lockable_files.LockableFiles(bzrdir_transport,
1997
self._lock_file_name, self._lock_class)
1998
control_files.create_lock()
1999
control_files.lock_write()
2001
for (filename, content) in utf8_files:
2002
bzrdir_transport.put_bytes(filename, content,
2005
control_files.unlock()
2006
return self.open(transport, _found=True)
2008
def is_supported(self):
2009
"""Is this format supported?
2011
Supported formats must be initializable and openable.
2012
Unsupported formats may not support initialization or committing or
2013
some other features depending on the reason for not being supported.
2017
def network_name(self):
2018
"""A simple byte string uniquely identifying this format for RPC calls.
2020
Bzr control formats use thir disk format string to identify the format
2021
over the wire. Its possible that other control formats have more
2022
complex detection requirements, so we permit them to use any unique and
2023
immutable string they desire.
2025
raise NotImplementedError(self.network_name)
2027
def same_model(self, target_format):
2028
return (self.repository_format.rich_root_data ==
2029
target_format.rich_root_data)
2032
def known_formats(klass):
2033
"""Return all the known formats.
2035
Concrete formats should override _known_formats.
2037
# There is double indirection here to make sure that control
2038
# formats used by more than one dir format will only be probed
2039
# once. This can otherwise be quite expensive for remote connections.
2041
for format in klass._control_formats:
2042
result.update(format._known_formats())
2046
def _known_formats(klass):
2047
"""Return the known format instances for this control format."""
2048
return set(klass._formats.values())
2050
def open(self, transport, _found=False):
2051
"""Return an instance of this format for the dir transport points at.
2053
_found is a private parameter, do not use it.
2056
found_format = BzrDirFormat.find_format(transport)
2057
if not isinstance(found_format, self.__class__):
2058
raise AssertionError("%s was asked to open %s, but it seems to need "
2060
% (self, transport, found_format))
2061
# Allow subclasses - use the found format.
2062
self._supply_sub_formats_to(found_format)
2063
return found_format._open(transport)
2064
return self._open(transport)
2066
def _open(self, transport):
2067
"""Template method helper for opening BzrDirectories.
2069
This performs the actual open and any additional logic or parameter
2072
raise NotImplementedError(self._open)
2075
def register_format(klass, format):
2076
klass._formats[format.get_format_string()] = format
2077
# bzr native formats have a network name of their format string.
2078
network_format_registry.register(format.get_format_string(), format.__class__)
2081
def register_control_format(klass, format):
2082
"""Register a format that does not use '.bzr' for its control dir.
2084
TODO: This should be pulled up into a 'ControlDirFormat' base class
2085
which BzrDirFormat can inherit from, and renamed to register_format
2086
there. It has been done without that for now for simplicity of
2089
klass._control_formats.append(format)
2092
def register_control_server_format(klass, format):
2093
"""Register a control format for client-server environments.
2095
These formats will be tried before ones registered with
2096
register_control_format. This gives implementations that decide to the
2097
chance to grab it before anything looks at the contents of the format
2100
klass._control_server_formats.append(format)
2103
def _set_default_format(klass, format):
2104
"""Set default format (for testing behavior of defaults only)"""
2105
klass._default_format = format
2109
return self.get_format_description().rstrip()
2111
def _supply_sub_formats_to(self, other_format):
2112
"""Give other_format the same values for sub formats as this has.
2114
This method is expected to be used when parameterising a
2115
RemoteBzrDirFormat instance with the parameters from a
2116
BzrDirMetaFormat1 instance.
2118
:param other_format: other_format is a format which should be
2119
compatible with whatever sub formats are supported by self.
2124
def unregister_format(klass, format):
2125
del klass._formats[format.get_format_string()]
2128
def unregister_control_format(klass, format):
2129
klass._control_formats.remove(format)
2132
class BzrDirFormat4(BzrDirFormat):
2133
"""Bzr dir format 4.
2135
This format is a combined format for working tree, branch and repository.
2137
- Format 1 working trees [always]
2138
- Format 4 branches [always]
2139
- Format 4 repositories [always]
2141
This format is deprecated: it indexes texts using a text it which is
2142
removed in format 5; write support for this format has been removed.
2145
_lock_class = lockable_files.TransportLock
2147
def get_format_string(self):
2148
"""See BzrDirFormat.get_format_string()."""
2149
return "Bazaar-NG branch, format 0.0.4\n"
2151
def get_format_description(self):
2152
"""See BzrDirFormat.get_format_description()."""
2153
return "All-in-one format 4"
2155
def get_converter(self, format=None):
2156
"""See BzrDirFormat.get_converter()."""
2157
# there is one and only one upgrade path here.
2158
return ConvertBzrDir4To5()
2160
def initialize_on_transport(self, transport):
2161
"""Format 4 branches cannot be created."""
2162
raise errors.UninitializableFormat(self)
2164
def is_supported(self):
2165
"""Format 4 is not supported.
2167
It is not supported because the model changed from 4 to 5 and the
2168
conversion logic is expensive - so doing it on the fly was not
2173
def network_name(self):
2174
return self.get_format_string()
2176
def _open(self, transport):
2177
"""See BzrDirFormat._open."""
2178
return BzrDir4(transport, self)
2180
def __return_repository_format(self):
2181
"""Circular import protection."""
2182
from bzrlib.repofmt.weaverepo import RepositoryFormat4
2183
return RepositoryFormat4()
2184
repository_format = property(__return_repository_format)
2187
class BzrDirFormatAllInOne(BzrDirFormat):
2188
"""Common class for formats before meta-dirs."""
2190
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
2191
create_prefix=False, force_new_repo=False, stacked_on=None,
2192
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
2194
"""See BzrDirFormat.initialize_on_transport_ex."""
2195
require_stacking = (stacked_on is not None)
2196
# Format 5 cannot stack, but we've been asked to - actually init
2198
if require_stacking:
2199
format = BzrDirMetaFormat1()
2200
return format.initialize_on_transport_ex(transport,
2201
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2202
force_new_repo=force_new_repo, stacked_on=stacked_on,
2203
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2204
make_working_trees=make_working_trees, shared_repo=shared_repo)
2205
return BzrDirFormat.initialize_on_transport_ex(self, transport,
2206
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2207
force_new_repo=force_new_repo, stacked_on=stacked_on,
2208
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2209
make_working_trees=make_working_trees, shared_repo=shared_repo)
2212
class BzrDirFormat5(BzrDirFormatAllInOne):
2213
"""Bzr control format 5.
2215
This format is a combined format for working tree, branch and repository.
2217
- Format 2 working trees [always]
2218
- Format 4 branches [always]
2219
- Format 5 repositories [always]
2220
Unhashed stores in the repository.
2223
_lock_class = lockable_files.TransportLock
2225
def get_format_string(self):
2226
"""See BzrDirFormat.get_format_string()."""
2227
return "Bazaar-NG branch, format 5\n"
2229
def get_branch_format(self):
2230
from bzrlib import branch
2231
return branch.BzrBranchFormat4()
2233
def get_format_description(self):
2234
"""See BzrDirFormat.get_format_description()."""
2235
return "All-in-one format 5"
2237
def get_converter(self, format=None):
2238
"""See BzrDirFormat.get_converter()."""
2239
# there is one and only one upgrade path here.
2240
return ConvertBzrDir5To6()
2242
def _initialize_for_clone(self, url):
2243
return self.initialize_on_transport(get_transport(url), _cloning=True)
2245
def initialize_on_transport(self, transport, _cloning=False):
2246
"""Format 5 dirs always have working tree, branch and repository.
2248
Except when they are being cloned.
2250
from bzrlib.branch import BzrBranchFormat4
2251
from bzrlib.repofmt.weaverepo import RepositoryFormat5
2252
result = (super(BzrDirFormat5, self).initialize_on_transport(transport))
2253
RepositoryFormat5().initialize(result, _internal=True)
2255
branch = BzrBranchFormat4().initialize(result)
2256
result._init_workingtree()
2259
def network_name(self):
2260
return self.get_format_string()
2262
def _open(self, transport):
2263
"""See BzrDirFormat._open."""
2264
return BzrDir5(transport, self)
2266
def __return_repository_format(self):
2267
"""Circular import protection."""
2268
from bzrlib.repofmt.weaverepo import RepositoryFormat5
2269
return RepositoryFormat5()
2270
repository_format = property(__return_repository_format)
2273
class BzrDirFormat6(BzrDirFormatAllInOne):
2274
"""Bzr control format 6.
2276
This format is a combined format for working tree, branch and repository.
2278
- Format 2 working trees [always]
2279
- Format 4 branches [always]
2280
- Format 6 repositories [always]
2283
_lock_class = lockable_files.TransportLock
2285
def get_format_string(self):
2286
"""See BzrDirFormat.get_format_string()."""
2287
return "Bazaar-NG branch, format 6\n"
2289
def get_format_description(self):
2290
"""See BzrDirFormat.get_format_description()."""
2291
return "All-in-one format 6"
2293
def get_branch_format(self):
2294
from bzrlib import branch
2295
return branch.BzrBranchFormat4()
2297
def get_converter(self, format=None):
2298
"""See BzrDirFormat.get_converter()."""
2299
# there is one and only one upgrade path here.
2300
return ConvertBzrDir6ToMeta()
2302
def _initialize_for_clone(self, url):
2303
return self.initialize_on_transport(get_transport(url), _cloning=True)
2305
def initialize_on_transport(self, transport, _cloning=False):
2306
"""Format 6 dirs always have working tree, branch and repository.
2308
Except when they are being cloned.
2310
from bzrlib.branch import BzrBranchFormat4
2311
from bzrlib.repofmt.weaverepo import RepositoryFormat6
2312
result = super(BzrDirFormat6, self).initialize_on_transport(transport)
2313
RepositoryFormat6().initialize(result, _internal=True)
2315
branch = BzrBranchFormat4().initialize(result)
2316
result._init_workingtree()
2319
def network_name(self):
2320
return self.get_format_string()
2322
def _open(self, transport):
2323
"""See BzrDirFormat._open."""
2324
return BzrDir6(transport, self)
2326
def __return_repository_format(self):
2327
"""Circular import protection."""
2328
from bzrlib.repofmt.weaverepo import RepositoryFormat6
2329
return RepositoryFormat6()
2330
repository_format = property(__return_repository_format)
2333
class BzrDirMetaFormat1(BzrDirFormat):
2334
"""Bzr meta control format 1
2336
This is the first format with split out working tree, branch and repository
2339
- Format 3 working trees [optional]
2340
- Format 5 branches [optional]
2341
- Format 7 repositories [optional]
2344
_lock_class = lockdir.LockDir
2347
self._workingtree_format = None
2348
self._branch_format = None
2349
self._repository_format = None
2351
def __eq__(self, other):
2352
if other.__class__ is not self.__class__:
2354
if other.repository_format != self.repository_format:
2356
if other.workingtree_format != self.workingtree_format:
2360
def __ne__(self, other):
2361
return not self == other
2363
def get_branch_format(self):
2364
if self._branch_format is None:
2365
from bzrlib.branch import BranchFormat
2366
self._branch_format = BranchFormat.get_default_format()
2367
return self._branch_format
2369
def set_branch_format(self, format):
2370
self._branch_format = format
2372
def require_stacking(self, stack_on=None, possible_transports=None,
2374
"""We have a request to stack, try to ensure the formats support it.
2376
:param stack_on: If supplied, it is the URL to a branch that we want to
2377
stack on. Check to see if that format supports stacking before
2380
# Stacking is desired. requested by the target, but does the place it
2381
# points at support stacking? If it doesn't then we should
2382
# not implicitly upgrade. We check this here.
2383
new_repo_format = None
2384
new_branch_format = None
2386
# a bit of state for get_target_branch so that we don't try to open it
2387
# 2 times, for both repo *and* branch
2388
target = [None, False, None] # target_branch, checked, upgrade anyway
2389
def get_target_branch():
2391
# We've checked, don't check again
2393
if stack_on is None:
2394
# No target format, that means we want to force upgrading
2395
target[:] = [None, True, True]
2398
target_dir = BzrDir.open(stack_on,
2399
possible_transports=possible_transports)
2400
except errors.NotBranchError:
2401
# Nothing there, don't change formats
2402
target[:] = [None, True, False]
2404
except errors.JailBreak:
2405
# JailBreak, JFDI and upgrade anyway
2406
target[:] = [None, True, True]
2409
target_branch = target_dir.open_branch()
2410
except errors.NotBranchError:
2411
# No branch, don't upgrade formats
2412
target[:] = [None, True, False]
2414
target[:] = [target_branch, True, False]
2417
if (not _skip_repo and
2418
not self.repository_format.supports_external_lookups):
2419
# We need to upgrade the Repository.
2420
target_branch, _, do_upgrade = get_target_branch()
2421
if target_branch is None:
2422
# We don't have a target branch, should we upgrade anyway?
2424
# stack_on is inaccessible, JFDI.
2425
# TODO: bad monkey, hard-coded formats...
2426
if self.repository_format.rich_root_data:
2427
new_repo_format = pack_repo.RepositoryFormatKnitPack5RichRoot()
2429
new_repo_format = pack_repo.RepositoryFormatKnitPack5()
2431
# If the target already supports stacking, then we know the
2432
# project is already able to use stacking, so auto-upgrade
2434
new_repo_format = target_branch.repository._format
2435
if not new_repo_format.supports_external_lookups:
2436
# target doesn't, source doesn't, so don't auto upgrade
2438
new_repo_format = None
2439
if new_repo_format is not None:
2440
self.repository_format = new_repo_format
2441
note('Source repository format does not support stacking,'
2442
' using format:\n %s',
2443
new_repo_format.get_format_description())
2445
if not self.get_branch_format().supports_stacking():
2446
# We just checked the repo, now lets check if we need to
2447
# upgrade the branch format
2448
target_branch, _, do_upgrade = get_target_branch()
2449
if target_branch is None:
2451
# TODO: bad monkey, hard-coded formats...
2452
new_branch_format = branch.BzrBranchFormat7()
2454
new_branch_format = target_branch._format
2455
if not new_branch_format.supports_stacking():
2456
new_branch_format = None
2457
if new_branch_format is not None:
2458
# Does support stacking, use its format.
2459
self.set_branch_format(new_branch_format)
2460
note('Source branch format does not support stacking,'
2461
' using format:\n %s',
2462
new_branch_format.get_format_description())
2464
def get_converter(self, format=None):
2465
"""See BzrDirFormat.get_converter()."""
2467
format = BzrDirFormat.get_default_format()
2468
if not isinstance(self, format.__class__):
2469
# converting away from metadir is not implemented
2470
raise NotImplementedError(self.get_converter)
2471
return ConvertMetaToMeta(format)
2473
def get_format_string(self):
2474
"""See BzrDirFormat.get_format_string()."""
2475
return "Bazaar-NG meta directory, format 1\n"
2477
def get_format_description(self):
2478
"""See BzrDirFormat.get_format_description()."""
2479
return "Meta directory format 1"
2481
def network_name(self):
2482
return self.get_format_string()
2484
def _open(self, transport):
2485
"""See BzrDirFormat._open."""
2486
# Create a new format instance because otherwise initialisation of new
2487
# metadirs share the global default format object leading to alias
2489
format = BzrDirMetaFormat1()
2490
self._supply_sub_formats_to(format)
2491
return BzrDirMeta1(transport, format)
2493
def __return_repository_format(self):
2494
"""Circular import protection."""
2495
if self._repository_format:
2496
return self._repository_format
2497
from bzrlib.repository import RepositoryFormat
2498
return RepositoryFormat.get_default_format()
2500
def _set_repository_format(self, value):
2501
"""Allow changing the repository format for metadir formats."""
2502
self._repository_format = value
2504
repository_format = property(__return_repository_format,
2505
_set_repository_format)
2507
def _supply_sub_formats_to(self, other_format):
2508
"""Give other_format the same values for sub formats as this has.
2510
This method is expected to be used when parameterising a
2511
RemoteBzrDirFormat instance with the parameters from a
2512
BzrDirMetaFormat1 instance.
2514
:param other_format: other_format is a format which should be
2515
compatible with whatever sub formats are supported by self.
2518
if getattr(self, '_repository_format', None) is not None:
2519
other_format.repository_format = self.repository_format
2520
if self._branch_format is not None:
2521
other_format._branch_format = self._branch_format
2522
if self._workingtree_format is not None:
2523
other_format.workingtree_format = self.workingtree_format
2525
def __get_workingtree_format(self):
2526
if self._workingtree_format is None:
2527
from bzrlib.workingtree import WorkingTreeFormat
2528
self._workingtree_format = WorkingTreeFormat.get_default_format()
2529
return self._workingtree_format
2531
def __set_workingtree_format(self, wt_format):
2532
self._workingtree_format = wt_format
2534
workingtree_format = property(__get_workingtree_format,
2535
__set_workingtree_format)
2538
network_format_registry = registry.FormatRegistry()
2539
"""Registry of formats indexed by their network name.
2541
The network name for a BzrDirFormat is an identifier that can be used when
2542
referring to formats with smart server operations. See
2543
BzrDirFormat.network_name() for more detail.
2547
# Register bzr control format
2548
BzrDirFormat.register_control_format(BzrDirFormat)
2550
# Register bzr formats
2551
BzrDirFormat.register_format(BzrDirFormat4())
2552
BzrDirFormat.register_format(BzrDirFormat5())
2553
BzrDirFormat.register_format(BzrDirFormat6())
2554
__default_format = BzrDirMetaFormat1()
2555
BzrDirFormat.register_format(__default_format)
2556
BzrDirFormat._default_format = __default_format
2559
class Converter(object):
2560
"""Converts a disk format object from one format to another."""
2562
def convert(self, to_convert, pb):
2563
"""Perform the conversion of to_convert, giving feedback via pb.
2565
:param to_convert: The disk object to convert.
2566
:param pb: a progress bar to use for progress information.
2569
def step(self, message):
2570
"""Update the pb by a step."""
2572
self.pb.update(message, self.count, self.total)
2575
class ConvertBzrDir4To5(Converter):
2576
"""Converts format 4 bzr dirs to format 5."""
2579
super(ConvertBzrDir4To5, self).__init__()
2580
self.converted_revs = set()
2581
self.absent_revisions = set()
2585
def convert(self, to_convert, pb):
2586
"""See Converter.convert()."""
2587
self.bzrdir = to_convert
2589
ui.ui_factory.note('starting upgrade from format 4 to 5')
2590
if isinstance(self.bzrdir.transport, local.LocalTransport):
2591
self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
2592
self._convert_to_weaves()
2593
return BzrDir.open(self.bzrdir.root_transport.base)
2595
def _convert_to_weaves(self):
2596
ui.ui_factory.note('note: upgrade may be faster if all store files are ungzipped first')
2599
stat = self.bzrdir.transport.stat('weaves')
2600
if not S_ISDIR(stat.st_mode):
2601
self.bzrdir.transport.delete('weaves')
2602
self.bzrdir.transport.mkdir('weaves')
2603
except errors.NoSuchFile:
2604
self.bzrdir.transport.mkdir('weaves')
2605
# deliberately not a WeaveFile as we want to build it up slowly.
2606
self.inv_weave = Weave('inventory')
2607
# holds in-memory weaves for all files
2608
self.text_weaves = {}
2609
self.bzrdir.transport.delete('branch-format')
2610
self.branch = self.bzrdir.open_branch()
2611
self._convert_working_inv()
2612
rev_history = self.branch.revision_history()
2613
# to_read is a stack holding the revisions we still need to process;
2614
# appending to it adds new highest-priority revisions
2615
self.known_revisions = set(rev_history)
2616
self.to_read = rev_history[-1:]
2618
rev_id = self.to_read.pop()
2619
if (rev_id not in self.revisions
2620
and rev_id not in self.absent_revisions):
2621
self._load_one_rev(rev_id)
2623
to_import = self._make_order()
2624
for i, rev_id in enumerate(to_import):
2625
self.pb.update('converting revision', i, len(to_import))
2626
self._convert_one_rev(rev_id)
2628
self._write_all_weaves()
2629
self._write_all_revs()
2630
ui.ui_factory.note('upgraded to weaves:')
2631
ui.ui_factory.note(' %6d revisions and inventories' % len(self.revisions))
2632
ui.ui_factory.note(' %6d revisions not present' % len(self.absent_revisions))
2633
ui.ui_factory.note(' %6d texts' % self.text_count)
2634
self._cleanup_spare_files_after_format4()
2635
self.branch._transport.put_bytes(
2637
BzrDirFormat5().get_format_string(),
2638
mode=self.bzrdir._get_file_mode())
2640
def _cleanup_spare_files_after_format4(self):
2641
# FIXME working tree upgrade foo.
2642
for n in 'merged-patches', 'pending-merged-patches':
2644
## assert os.path.getsize(p) == 0
2645
self.bzrdir.transport.delete(n)
2646
except errors.NoSuchFile:
2648
self.bzrdir.transport.delete_tree('inventory-store')
2649
self.bzrdir.transport.delete_tree('text-store')
2651
def _convert_working_inv(self):
2652
inv = xml4.serializer_v4.read_inventory(
2653
self.branch._transport.get('inventory'))
2654
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv, working=True)
2655
self.branch._transport.put_bytes('inventory', new_inv_xml,
2656
mode=self.bzrdir._get_file_mode())
2658
def _write_all_weaves(self):
2659
controlweaves = WeaveStore(self.bzrdir.transport, prefixed=False)
2660
weave_transport = self.bzrdir.transport.clone('weaves')
2661
weaves = WeaveStore(weave_transport, prefixed=False)
2662
transaction = WriteTransaction()
2666
for file_id, file_weave in self.text_weaves.items():
2667
self.pb.update('writing weave', i, len(self.text_weaves))
2668
weaves._put_weave(file_id, file_weave, transaction)
2670
self.pb.update('inventory', 0, 1)
2671
controlweaves._put_weave('inventory', self.inv_weave, transaction)
2672
self.pb.update('inventory', 1, 1)
2676
def _write_all_revs(self):
2677
"""Write all revisions out in new form."""
2678
self.bzrdir.transport.delete_tree('revision-store')
2679
self.bzrdir.transport.mkdir('revision-store')
2680
revision_transport = self.bzrdir.transport.clone('revision-store')
2682
from bzrlib.xml5 import serializer_v5
2683
from bzrlib.repofmt.weaverepo import RevisionTextStore
2684
revision_store = RevisionTextStore(revision_transport,
2685
serializer_v5, False, versionedfile.PrefixMapper(),
2686
lambda:True, lambda:True)
2688
for i, rev_id in enumerate(self.converted_revs):
2689
self.pb.update('write revision', i, len(self.converted_revs))
2690
text = serializer_v5.write_revision_to_string(
2691
self.revisions[rev_id])
2693
revision_store.add_lines(key, None, osutils.split_lines(text))
2697
def _load_one_rev(self, rev_id):
2698
"""Load a revision object into memory.
2700
Any parents not either loaded or abandoned get queued to be
2702
self.pb.update('loading revision',
2703
len(self.revisions),
2704
len(self.known_revisions))
2705
if not self.branch.repository.has_revision(rev_id):
2707
ui.ui_factory.note('revision {%s} not present in branch; '
2708
'will be converted as a ghost' %
2710
self.absent_revisions.add(rev_id)
2712
rev = self.branch.repository.get_revision(rev_id)
2713
for parent_id in rev.parent_ids:
2714
self.known_revisions.add(parent_id)
2715
self.to_read.append(parent_id)
2716
self.revisions[rev_id] = rev
2718
def _load_old_inventory(self, rev_id):
2719
old_inv_xml = self.branch.repository.inventory_store.get(rev_id).read()
2720
inv = xml4.serializer_v4.read_inventory_from_string(old_inv_xml)
2721
inv.revision_id = rev_id
2722
rev = self.revisions[rev_id]
2725
def _load_updated_inventory(self, rev_id):
2726
inv_xml = self.inv_weave.get_text(rev_id)
2727
inv = xml5.serializer_v5.read_inventory_from_string(inv_xml, rev_id)
2730
def _convert_one_rev(self, rev_id):
2731
"""Convert revision and all referenced objects to new format."""
2732
rev = self.revisions[rev_id]
2733
inv = self._load_old_inventory(rev_id)
2734
present_parents = [p for p in rev.parent_ids
2735
if p not in self.absent_revisions]
2736
self._convert_revision_contents(rev, inv, present_parents)
2737
self._store_new_inv(rev, inv, present_parents)
2738
self.converted_revs.add(rev_id)
2740
def _store_new_inv(self, rev, inv, present_parents):
2741
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
2742
new_inv_sha1 = sha_string(new_inv_xml)
2743
self.inv_weave.add_lines(rev.revision_id,
2745
new_inv_xml.splitlines(True))
2746
rev.inventory_sha1 = new_inv_sha1
2748
def _convert_revision_contents(self, rev, inv, present_parents):
2749
"""Convert all the files within a revision.
2751
Also upgrade the inventory to refer to the text revision ids."""
2752
rev_id = rev.revision_id
2753
mutter('converting texts of revision {%s}',
2755
parent_invs = map(self._load_updated_inventory, present_parents)
2756
entries = inv.iter_entries()
2758
for path, ie in entries:
2759
self._convert_file_version(rev, ie, parent_invs)
2761
def _convert_file_version(self, rev, ie, parent_invs):
2762
"""Convert one version of one file.
2764
The file needs to be added into the weave if it is a merge
2765
of >=2 parents or if it's changed from its parent.
2767
file_id = ie.file_id
2768
rev_id = rev.revision_id
2769
w = self.text_weaves.get(file_id)
2772
self.text_weaves[file_id] = w
2773
text_changed = False
2774
parent_candiate_entries = ie.parent_candidates(parent_invs)
2775
heads = graph.Graph(self).heads(parent_candiate_entries.keys())
2776
# XXX: Note that this is unordered - and this is tolerable because
2777
# the previous code was also unordered.
2778
previous_entries = dict((head, parent_candiate_entries[head]) for head
2780
self.snapshot_ie(previous_entries, ie, w, rev_id)
2783
def get_parent_map(self, revision_ids):
2784
"""See graph.StackedParentsProvider.get_parent_map"""
2785
return dict((revision_id, self.revisions[revision_id])
2786
for revision_id in revision_ids
2787
if revision_id in self.revisions)
2789
def snapshot_ie(self, previous_revisions, ie, w, rev_id):
2790
# TODO: convert this logic, which is ~= snapshot to
2791
# a call to:. This needs the path figured out. rather than a work_tree
2792
# a v4 revision_tree can be given, or something that looks enough like
2793
# one to give the file content to the entry if it needs it.
2794
# and we need something that looks like a weave store for snapshot to
2796
#ie.snapshot(rev, PATH, previous_revisions, REVISION_TREE, InMemoryWeaveStore(self.text_weaves))
2797
if len(previous_revisions) == 1:
2798
previous_ie = previous_revisions.values()[0]
2799
if ie._unchanged(previous_ie):
2800
ie.revision = previous_ie.revision
2803
text = self.branch.repository._text_store.get(ie.text_id)
2804
file_lines = text.readlines()
2805
w.add_lines(rev_id, previous_revisions, file_lines)
2806
self.text_count += 1
2808
w.add_lines(rev_id, previous_revisions, [])
2809
ie.revision = rev_id
2811
def _make_order(self):
2812
"""Return a suitable order for importing revisions.
2814
The order must be such that an revision is imported after all
2815
its (present) parents.
2817
todo = set(self.revisions.keys())
2818
done = self.absent_revisions.copy()
2821
# scan through looking for a revision whose parents
2823
for rev_id in sorted(list(todo)):
2824
rev = self.revisions[rev_id]
2825
parent_ids = set(rev.parent_ids)
2826
if parent_ids.issubset(done):
2827
# can take this one now
2828
order.append(rev_id)
2834
class ConvertBzrDir5To6(Converter):
2835
"""Converts format 5 bzr dirs to format 6."""
2837
def convert(self, to_convert, pb):
2838
"""See Converter.convert()."""
2839
self.bzrdir = to_convert
2841
ui.ui_factory.note('starting upgrade from format 5 to 6')
2842
self._convert_to_prefixed()
2843
return BzrDir.open(self.bzrdir.root_transport.base)
2845
def _convert_to_prefixed(self):
2846
from bzrlib.store import TransportStore
2847
self.bzrdir.transport.delete('branch-format')
2848
for store_name in ["weaves", "revision-store"]:
2849
ui.ui_factory.note("adding prefixes to %s" % store_name)
2850
store_transport = self.bzrdir.transport.clone(store_name)
2851
store = TransportStore(store_transport, prefixed=True)
2852
for urlfilename in store_transport.list_dir('.'):
2853
filename = urlutils.unescape(urlfilename)
2854
if (filename.endswith(".weave") or
2855
filename.endswith(".gz") or
2856
filename.endswith(".sig")):
2857
file_id, suffix = os.path.splitext(filename)
2861
new_name = store._mapper.map((file_id,)) + suffix
2862
# FIXME keep track of the dirs made RBC 20060121
2864
store_transport.move(filename, new_name)
2865
except errors.NoSuchFile: # catches missing dirs strangely enough
2866
store_transport.mkdir(osutils.dirname(new_name))
2867
store_transport.move(filename, new_name)
2868
self.bzrdir.transport.put_bytes(
2870
BzrDirFormat6().get_format_string(),
2871
mode=self.bzrdir._get_file_mode())
2874
class ConvertBzrDir6ToMeta(Converter):
2875
"""Converts format 6 bzr dirs to metadirs."""
2877
def convert(self, to_convert, pb):
2878
"""See Converter.convert()."""
2879
from bzrlib.repofmt.weaverepo import RepositoryFormat7
2880
from bzrlib.branch import BzrBranchFormat5
2881
self.bzrdir = to_convert
2884
self.total = 20 # the steps we know about
2885
self.garbage_inventories = []
2886
self.dir_mode = self.bzrdir._get_dir_mode()
2887
self.file_mode = self.bzrdir._get_file_mode()
2889
ui.ui_factory.note('starting upgrade from format 6 to metadir')
2890
self.bzrdir.transport.put_bytes(
2892
"Converting to format 6",
2893
mode=self.file_mode)
2894
# its faster to move specific files around than to open and use the apis...
2895
# first off, nuke ancestry.weave, it was never used.
2897
self.step('Removing ancestry.weave')
2898
self.bzrdir.transport.delete('ancestry.weave')
2899
except errors.NoSuchFile:
2901
# find out whats there
2902
self.step('Finding branch files')
2903
last_revision = self.bzrdir.open_branch().last_revision()
2904
bzrcontents = self.bzrdir.transport.list_dir('.')
2905
for name in bzrcontents:
2906
if name.startswith('basis-inventory.'):
2907
self.garbage_inventories.append(name)
2908
# create new directories for repository, working tree and branch
2909
repository_names = [('inventory.weave', True),
2910
('revision-store', True),
2912
self.step('Upgrading repository ')
2913
self.bzrdir.transport.mkdir('repository', mode=self.dir_mode)
2914
self.make_lock('repository')
2915
# we hard code the formats here because we are converting into
2916
# the meta format. The meta format upgrader can take this to a
2917
# future format within each component.
2918
self.put_format('repository', RepositoryFormat7())
2919
for entry in repository_names:
2920
self.move_entry('repository', entry)
2922
self.step('Upgrading branch ')
2923
self.bzrdir.transport.mkdir('branch', mode=self.dir_mode)
2924
self.make_lock('branch')
2925
self.put_format('branch', BzrBranchFormat5())
2926
branch_files = [('revision-history', True),
2927
('branch-name', True),
2929
for entry in branch_files:
2930
self.move_entry('branch', entry)
2932
checkout_files = [('pending-merges', True),
2933
('inventory', True),
2934
('stat-cache', False)]
2935
# If a mandatory checkout file is not present, the branch does not have
2936
# a functional checkout. Do not create a checkout in the converted
2938
for name, mandatory in checkout_files:
2939
if mandatory and name not in bzrcontents:
2940
has_checkout = False
2944
if not has_checkout:
2945
ui.ui_factory.note('No working tree.')
2946
# If some checkout files are there, we may as well get rid of them.
2947
for name, mandatory in checkout_files:
2948
if name in bzrcontents:
2949
self.bzrdir.transport.delete(name)
2951
from bzrlib.workingtree import WorkingTreeFormat3
2952
self.step('Upgrading working tree')
2953
self.bzrdir.transport.mkdir('checkout', mode=self.dir_mode)
2954
self.make_lock('checkout')
2956
'checkout', WorkingTreeFormat3())
2957
self.bzrdir.transport.delete_multi(
2958
self.garbage_inventories, self.pb)
2959
for entry in checkout_files:
2960
self.move_entry('checkout', entry)
2961
if last_revision is not None:
2962
self.bzrdir.transport.put_bytes(
2963
'checkout/last-revision', last_revision)
2964
self.bzrdir.transport.put_bytes(
2966
BzrDirMetaFormat1().get_format_string(),
2967
mode=self.file_mode)
2968
return BzrDir.open(self.bzrdir.root_transport.base)
2970
def make_lock(self, name):
2971
"""Make a lock for the new control dir name."""
2972
self.step('Make %s lock' % name)
2973
ld = lockdir.LockDir(self.bzrdir.transport,
2975
file_modebits=self.file_mode,
2976
dir_modebits=self.dir_mode)
2979
def move_entry(self, new_dir, entry):
2980
"""Move then entry name into new_dir."""
2982
mandatory = entry[1]
2983
self.step('Moving %s' % name)
2985
self.bzrdir.transport.move(name, '%s/%s' % (new_dir, name))
2986
except errors.NoSuchFile:
2990
def put_format(self, dirname, format):
2991
self.bzrdir.transport.put_bytes('%s/format' % dirname,
2992
format.get_format_string(),
2996
class ConvertMetaToMeta(Converter):
2997
"""Converts the components of metadirs."""
2999
def __init__(self, target_format):
3000
"""Create a metadir to metadir converter.
3002
:param target_format: The final metadir format that is desired.
3004
self.target_format = target_format
3006
def convert(self, to_convert, pb):
3007
"""See Converter.convert()."""
3008
self.bzrdir = to_convert
3012
self.step('checking repository format')
3014
repo = self.bzrdir.open_repository()
3015
except errors.NoRepositoryPresent:
3018
if not isinstance(repo._format, self.target_format.repository_format.__class__):
3019
from bzrlib.repository import CopyConverter
3020
ui.ui_factory.note('starting repository conversion')
3021
converter = CopyConverter(self.target_format.repository_format)
3022
converter.convert(repo, pb)
3024
branch = self.bzrdir.open_branch()
3025
except errors.NotBranchError:
3028
# TODO: conversions of Branch and Tree should be done by
3029
# InterXFormat lookups/some sort of registry.
3030
# Avoid circular imports
3031
from bzrlib import branch as _mod_branch
3032
old = branch._format.__class__
3033
new = self.target_format.get_branch_format().__class__
3035
if (old == _mod_branch.BzrBranchFormat5 and
3036
new in (_mod_branch.BzrBranchFormat6,
3037
_mod_branch.BzrBranchFormat7,
3038
_mod_branch.BzrBranchFormat8)):
3039
branch_converter = _mod_branch.Converter5to6()
3040
elif (old == _mod_branch.BzrBranchFormat6 and
3041
new in (_mod_branch.BzrBranchFormat7,
3042
_mod_branch.BzrBranchFormat8)):
3043
branch_converter = _mod_branch.Converter6to7()
3044
elif (old == _mod_branch.BzrBranchFormat7 and
3045
new is _mod_branch.BzrBranchFormat8):
3046
branch_converter = _mod_branch.Converter7to8()
3048
raise errors.BadConversionTarget("No converter", new,
3050
branch_converter.convert(branch)
3051
branch = self.bzrdir.open_branch()
3052
old = branch._format.__class__
3054
tree = self.bzrdir.open_workingtree(recommend_upgrade=False)
3055
except (errors.NoWorkingTree, errors.NotLocalUrl):
3058
# TODO: conversions of Branch and Tree should be done by
3059
# InterXFormat lookups
3060
if (isinstance(tree, workingtree.WorkingTree3) and
3061
not isinstance(tree, workingtree_4.DirStateWorkingTree) and
3062
isinstance(self.target_format.workingtree_format,
3063
workingtree_4.DirStateWorkingTreeFormat)):
3064
workingtree_4.Converter3to4().convert(tree)
3065
if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
3066
not isinstance(tree, workingtree_4.WorkingTree5) and
3067
isinstance(self.target_format.workingtree_format,
3068
workingtree_4.WorkingTreeFormat5)):
3069
workingtree_4.Converter4to5().convert(tree)
3070
if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
3071
not isinstance(tree, workingtree_4.WorkingTree6) and
3072
isinstance(self.target_format.workingtree_format,
3073
workingtree_4.WorkingTreeFormat6)):
3074
workingtree_4.Converter4or5to6().convert(tree)
3078
# This is not in remote.py because it's relatively small, and needs to be
3079
# registered. Putting it in remote.py creates a circular import problem.
3080
# we can make it a lazy object if the control formats is turned into something
3082
class RemoteBzrDirFormat(BzrDirMetaFormat1):
3083
"""Format representing bzrdirs accessed via a smart server"""
3086
BzrDirMetaFormat1.__init__(self)
3087
self._network_name = None
3089
def get_format_description(self):
3090
return 'bzr remote bzrdir'
3092
def get_format_string(self):
3093
raise NotImplementedError(self.get_format_string)
3095
def network_name(self):
3096
if self._network_name:
3097
return self._network_name
3099
raise AssertionError("No network name set.")
3102
def probe_transport(klass, transport):
3103
"""Return a RemoteBzrDirFormat object if it looks possible."""
3105
medium = transport.get_smart_medium()
3106
except (NotImplementedError, AttributeError,
3107
errors.TransportNotPossible, errors.NoSmartMedium,
3108
errors.SmartProtocolError):
3109
# no smart server, so not a branch for this format type.
3110
raise errors.NotBranchError(path=transport.base)
3112
# Decline to open it if the server doesn't support our required
3113
# version (3) so that the VFS-based transport will do it.
3114
if medium.should_probe():
3116
server_version = medium.protocol_version()
3117
except errors.SmartProtocolError:
3118
# Apparently there's no usable smart server there, even though
3119
# the medium supports the smart protocol.
3120
raise errors.NotBranchError(path=transport.base)
3121
if server_version != '2':
3122
raise errors.NotBranchError(path=transport.base)
3125
def initialize_on_transport(self, transport):
3127
# hand off the request to the smart server
3128
client_medium = transport.get_smart_medium()
3129
except errors.NoSmartMedium:
3130
# TODO: lookup the local format from a server hint.
3131
local_dir_format = BzrDirMetaFormat1()
3132
return local_dir_format.initialize_on_transport(transport)
3133
client = _SmartClient(client_medium)
3134
path = client.remote_path_from_transport(transport)
3136
response = client.call('BzrDirFormat.initialize', path)
3137
except errors.ErrorFromSmartServer, err:
3138
remote._translate_error(err, path=path)
3139
if response[0] != 'ok':
3140
raise errors.SmartProtocolError('unexpected response code %s' % (response,))
3141
format = RemoteBzrDirFormat()
3142
self._supply_sub_formats_to(format)
3143
return remote.RemoteBzrDir(transport, format)
3145
def parse_NoneTrueFalse(self, arg):
3152
raise AssertionError("invalid arg %r" % arg)
3154
def _serialize_NoneTrueFalse(self, arg):
3161
def _serialize_NoneString(self, arg):
3164
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
3165
create_prefix=False, force_new_repo=False, stacked_on=None,
3166
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
3169
# hand off the request to the smart server
3170
client_medium = transport.get_smart_medium()
3171
except errors.NoSmartMedium:
3174
# Decline to open it if the server doesn't support our required
3175
# version (3) so that the VFS-based transport will do it.
3176
if client_medium.should_probe():
3178
server_version = client_medium.protocol_version()
3179
if server_version != '2':
3183
except errors.SmartProtocolError:
3184
# Apparently there's no usable smart server there, even though
3185
# the medium supports the smart protocol.
3190
client = _SmartClient(client_medium)
3191
path = client.remote_path_from_transport(transport)
3192
if client_medium._is_remote_before((1, 16)):
3195
# TODO: lookup the local format from a server hint.
3196
local_dir_format = BzrDirMetaFormat1()
3197
self._supply_sub_formats_to(local_dir_format)
3198
return local_dir_format.initialize_on_transport_ex(transport,
3199
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3200
force_new_repo=force_new_repo, stacked_on=stacked_on,
3201
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3202
make_working_trees=make_working_trees, shared_repo=shared_repo,
3204
return self._initialize_on_transport_ex_rpc(client, path, transport,
3205
use_existing_dir, create_prefix, force_new_repo, stacked_on,
3206
stack_on_pwd, repo_format_name, make_working_trees, shared_repo)
3208
def _initialize_on_transport_ex_rpc(self, client, path, transport,
3209
use_existing_dir, create_prefix, force_new_repo, stacked_on,
3210
stack_on_pwd, repo_format_name, make_working_trees, shared_repo):
3212
args.append(self._serialize_NoneTrueFalse(use_existing_dir))
3213
args.append(self._serialize_NoneTrueFalse(create_prefix))
3214
args.append(self._serialize_NoneTrueFalse(force_new_repo))
3215
args.append(self._serialize_NoneString(stacked_on))
3216
# stack_on_pwd is often/usually our transport
3219
stack_on_pwd = transport.relpath(stack_on_pwd)
3220
if not stack_on_pwd:
3222
except errors.PathNotChild:
3224
args.append(self._serialize_NoneString(stack_on_pwd))
3225
args.append(self._serialize_NoneString(repo_format_name))
3226
args.append(self._serialize_NoneTrueFalse(make_working_trees))
3227
args.append(self._serialize_NoneTrueFalse(shared_repo))
3228
if self._network_name is None:
3229
self._network_name = \
3230
BzrDirFormat.get_default_format().network_name()
3232
response = client.call('BzrDirFormat.initialize_ex_1.16',
3233
self.network_name(), path, *args)
3234
except errors.UnknownSmartMethod:
3235
client._medium._remember_remote_is_before((1,16))
3236
local_dir_format = BzrDirMetaFormat1()
3237
self._supply_sub_formats_to(local_dir_format)
3238
return local_dir_format.initialize_on_transport_ex(transport,
3239
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3240
force_new_repo=force_new_repo, stacked_on=stacked_on,
3241
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3242
make_working_trees=make_working_trees, shared_repo=shared_repo,
3244
except errors.ErrorFromSmartServer, err:
3245
remote._translate_error(err, path=path)
3246
repo_path = response[0]
3247
bzrdir_name = response[6]
3248
require_stacking = response[7]
3249
require_stacking = self.parse_NoneTrueFalse(require_stacking)
3250
format = RemoteBzrDirFormat()
3251
format._network_name = bzrdir_name
3252
self._supply_sub_formats_to(format)
3253
bzrdir = remote.RemoteBzrDir(transport, format, _client=client)
3255
repo_format = remote.response_tuple_to_repo_format(response[1:])
3256
if repo_path == '.':
3259
repo_bzrdir_format = RemoteBzrDirFormat()
3260
repo_bzrdir_format._network_name = response[5]
3261
repo_bzr = remote.RemoteBzrDir(transport.clone(repo_path),
3265
final_stack = response[8] or None
3266
final_stack_pwd = response[9] or None
3268
final_stack_pwd = urlutils.join(
3269
transport.base, final_stack_pwd)
3270
remote_repo = remote.RemoteRepository(repo_bzr, repo_format)
3271
if len(response) > 10:
3272
# Updated server verb that locks remotely.
3273
repo_lock_token = response[10] or None
3274
remote_repo.lock_write(repo_lock_token, _skip_rpc=True)
3276
remote_repo.dont_leave_lock_in_place()
3278
remote_repo.lock_write()
3279
policy = UseExistingRepository(remote_repo, final_stack,
3280
final_stack_pwd, require_stacking)
3281
policy.acquire_repository()
3285
bzrdir._format.set_branch_format(self.get_branch_format())
3286
if require_stacking:
3287
# The repo has already been created, but we need to make sure that
3288
# we'll make a stackable branch.
3289
bzrdir._format.require_stacking(_skip_repo=True)
3290
return remote_repo, bzrdir, require_stacking, policy
3292
def _open(self, transport):
3293
return remote.RemoteBzrDir(transport, self)
3295
def __eq__(self, other):
3296
if not isinstance(other, RemoteBzrDirFormat):
3298
return self.get_format_description() == other.get_format_description()
3300
def __return_repository_format(self):
3301
# Always return a RemoteRepositoryFormat object, but if a specific bzr
3302
# repository format has been asked for, tell the RemoteRepositoryFormat
3303
# that it should use that for init() etc.
3304
result = remote.RemoteRepositoryFormat()
3305
custom_format = getattr(self, '_repository_format', None)
3307
if isinstance(custom_format, remote.RemoteRepositoryFormat):
3308
return custom_format
3310
# We will use the custom format to create repositories over the
3311
# wire; expose its details like rich_root_data for code to
3313
result._custom_format = custom_format
3316
def get_branch_format(self):
3317
result = BzrDirMetaFormat1.get_branch_format(self)
3318
if not isinstance(result, remote.RemoteBranchFormat):
3319
new_result = remote.RemoteBranchFormat()
3320
new_result._custom_format = result
3322
self.set_branch_format(new_result)
3326
repository_format = property(__return_repository_format,
3327
BzrDirMetaFormat1._set_repository_format) #.im_func)
3330
BzrDirFormat.register_control_server_format(RemoteBzrDirFormat)
3333
class BzrDirFormatInfo(object):
3335
def __init__(self, native, deprecated, hidden, experimental):
3336
self.deprecated = deprecated
3337
self.native = native
3338
self.hidden = hidden
3339
self.experimental = experimental
3342
class BzrDirFormatRegistry(registry.Registry):
3343
"""Registry of user-selectable BzrDir subformats.
3345
Differs from BzrDirFormat._control_formats in that it provides sub-formats,
3346
e.g. BzrDirMeta1 with weave repository. Also, it's more user-oriented.
3350
"""Create a BzrDirFormatRegistry."""
3351
self._aliases = set()
3352
self._registration_order = list()
3353
super(BzrDirFormatRegistry, self).__init__()
3356
"""Return a set of the format names which are aliases."""
3357
return frozenset(self._aliases)
3359
def register_metadir(self, key,
3360
repository_format, help, native=True, deprecated=False,
3366
"""Register a metadir subformat.
3368
These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
3369
by the Repository/Branch/WorkingTreeformats.
3371
:param repository_format: The fully-qualified repository format class
3373
:param branch_format: Fully-qualified branch format class name as
3375
:param tree_format: Fully-qualified tree format class name as
3378
# This should be expanded to support setting WorkingTree and Branch
3379
# formats, once BzrDirMetaFormat1 supports that.
3380
def _load(full_name):
3381
mod_name, factory_name = full_name.rsplit('.', 1)
3383
mod = __import__(mod_name, globals(), locals(),
3385
except ImportError, e:
3386
raise ImportError('failed to load %s: %s' % (full_name, e))
3388
factory = getattr(mod, factory_name)
3389
except AttributeError:
3390
raise AttributeError('no factory %s in module %r'
3395
bd = BzrDirMetaFormat1()
3396
if branch_format is not None:
3397
bd.set_branch_format(_load(branch_format))
3398
if tree_format is not None:
3399
bd.workingtree_format = _load(tree_format)
3400
if repository_format is not None:
3401
bd.repository_format = _load(repository_format)
3403
self.register(key, helper, help, native, deprecated, hidden,
3404
experimental, alias)
3406
def register(self, key, factory, help, native=True, deprecated=False,
3407
hidden=False, experimental=False, alias=False):
3408
"""Register a BzrDirFormat factory.
3410
The factory must be a callable that takes one parameter: the key.
3411
It must produce an instance of the BzrDirFormat when called.
3413
This function mainly exists to prevent the info object from being
3416
registry.Registry.register(self, key, factory, help,
3417
BzrDirFormatInfo(native, deprecated, hidden, experimental))
3419
self._aliases.add(key)
3420
self._registration_order.append(key)
3422
def register_lazy(self, key, module_name, member_name, help, native=True,
3423
deprecated=False, hidden=False, experimental=False, alias=False):
3424
registry.Registry.register_lazy(self, key, module_name, member_name,
3425
help, BzrDirFormatInfo(native, deprecated, hidden, experimental))
3427
self._aliases.add(key)
3428
self._registration_order.append(key)
3430
def set_default(self, key):
3431
"""Set the 'default' key to be a clone of the supplied key.
3433
This method must be called once and only once.
3435
registry.Registry.register(self, 'default', self.get(key),
3436
self.get_help(key), info=self.get_info(key))
3437
self._aliases.add('default')
3439
def set_default_repository(self, key):
3440
"""Set the FormatRegistry default and Repository default.
3442
This is a transitional method while Repository.set_default_format
3445
if 'default' in self:
3446
self.remove('default')
3447
self.set_default(key)
3448
format = self.get('default')()
3450
def make_bzrdir(self, key):
3451
return self.get(key)()
3453
def help_topic(self, topic):
3455
default_realkey = None
3456
default_help = self.get_help('default')
3458
for key in self._registration_order:
3459
if key == 'default':
3461
help = self.get_help(key)
3462
if help == default_help:
3463
default_realkey = key
3465
help_pairs.append((key, help))
3467
def wrapped(key, help, info):
3469
help = '(native) ' + help
3470
return ':%s:\n%s\n\n' % (key,
3471
textwrap.fill(help, initial_indent=' ',
3472
subsequent_indent=' ',
3473
break_long_words=False))
3474
if default_realkey is not None:
3475
output += wrapped(default_realkey, '(default) %s' % default_help,
3476
self.get_info('default'))
3477
deprecated_pairs = []
3478
experimental_pairs = []
3479
for key, help in help_pairs:
3480
info = self.get_info(key)
3483
elif info.deprecated:
3484
deprecated_pairs.append((key, help))
3485
elif info.experimental:
3486
experimental_pairs.append((key, help))
3488
output += wrapped(key, help, info)
3489
output += "\nSee ``bzr help formats`` for more about storage formats."
3491
if len(experimental_pairs) > 0:
3492
other_output += "Experimental formats are shown below.\n\n"
3493
for key, help in experimental_pairs:
3494
info = self.get_info(key)
3495
other_output += wrapped(key, help, info)
3498
"No experimental formats are available.\n\n"
3499
if len(deprecated_pairs) > 0:
3500
other_output += "\nDeprecated formats are shown below.\n\n"
3501
for key, help in deprecated_pairs:
3502
info = self.get_info(key)
3503
other_output += wrapped(key, help, info)
3506
"\nNo deprecated formats are available.\n\n"
3508
"\nSee ``bzr help formats`` for more about storage formats."
3510
if topic == 'other-formats':
3516
class RepositoryAcquisitionPolicy(object):
3517
"""Abstract base class for repository acquisition policies.
3519
A repository acquisition policy decides how a BzrDir acquires a repository
3520
for a branch that is being created. The most basic policy decision is
3521
whether to create a new repository or use an existing one.
3523
def __init__(self, stack_on, stack_on_pwd, require_stacking):
3526
:param stack_on: A location to stack on
3527
:param stack_on_pwd: If stack_on is relative, the location it is
3529
:param require_stacking: If True, it is a failure to not stack.
3531
self._stack_on = stack_on
3532
self._stack_on_pwd = stack_on_pwd
3533
self._require_stacking = require_stacking
3535
def configure_branch(self, branch):
3536
"""Apply any configuration data from this policy to the branch.
3538
Default implementation sets repository stacking.
3540
if self._stack_on is None:
3542
if self._stack_on_pwd is None:
3543
stack_on = self._stack_on
3546
stack_on = urlutils.rebase_url(self._stack_on,
3548
branch.bzrdir.root_transport.base)
3549
except errors.InvalidRebaseURLs:
3550
stack_on = self._get_full_stack_on()
3552
branch.set_stacked_on_url(stack_on)
3553
except (errors.UnstackableBranchFormat,
3554
errors.UnstackableRepositoryFormat):
3555
if self._require_stacking:
3558
def requires_stacking(self):
3559
"""Return True if this policy requires stacking."""
3560
return self._stack_on is not None and self._require_stacking
3562
def _get_full_stack_on(self):
3563
"""Get a fully-qualified URL for the stack_on location."""
3564
if self._stack_on is None:
3566
if self._stack_on_pwd is None:
3567
return self._stack_on
3569
return urlutils.join(self._stack_on_pwd, self._stack_on)
3571
def _add_fallback(self, repository, possible_transports=None):
3572
"""Add a fallback to the supplied repository, if stacking is set."""
3573
stack_on = self._get_full_stack_on()
3574
if stack_on is None:
3577
stacked_dir = BzrDir.open(stack_on,
3578
possible_transports=possible_transports)
3579
except errors.JailBreak:
3580
# We keep the stacking details, but we are in the server code so
3581
# actually stacking is not needed.
3584
stacked_repo = stacked_dir.open_branch().repository
3585
except errors.NotBranchError:
3586
stacked_repo = stacked_dir.open_repository()
3588
repository.add_fallback_repository(stacked_repo)
3589
except errors.UnstackableRepositoryFormat:
3590
if self._require_stacking:
3593
self._require_stacking = True
3595
def acquire_repository(self, make_working_trees=None, shared=False):
3596
"""Acquire a repository for this bzrdir.
3598
Implementations may create a new repository or use a pre-exising
3600
:param make_working_trees: If creating a repository, set
3601
make_working_trees to this value (if non-None)
3602
:param shared: If creating a repository, make it shared if True
3603
:return: A repository, is_new_flag (True if the repository was
3606
raise NotImplemented(RepositoryAcquisitionPolicy.acquire_repository)
3609
class CreateRepository(RepositoryAcquisitionPolicy):
3610
"""A policy of creating a new repository"""
3612
def __init__(self, bzrdir, stack_on=None, stack_on_pwd=None,
3613
require_stacking=False):
3616
:param bzrdir: The bzrdir to create the repository on.
3617
:param stack_on: A location to stack on
3618
:param stack_on_pwd: If stack_on is relative, the location it is
3621
RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
3623
self._bzrdir = bzrdir
3625
def acquire_repository(self, make_working_trees=None, shared=False):
3626
"""Implementation of RepositoryAcquisitionPolicy.acquire_repository
3628
Creates the desired repository in the bzrdir we already have.
3630
stack_on = self._get_full_stack_on()
3632
format = self._bzrdir._format
3633
format.require_stacking(stack_on=stack_on,
3634
possible_transports=[self._bzrdir.root_transport])
3635
if not self._require_stacking:
3636
# We have picked up automatic stacking somewhere.
3637
note('Using default stacking branch %s at %s', self._stack_on,
3639
repository = self._bzrdir.create_repository(shared=shared)
3640
self._add_fallback(repository,
3641
possible_transports=[self._bzrdir.transport])
3642
if make_working_trees is not None:
3643
repository.set_make_working_trees(make_working_trees)
3644
return repository, True
3647
class UseExistingRepository(RepositoryAcquisitionPolicy):
3648
"""A policy of reusing an existing repository"""
3650
def __init__(self, repository, stack_on=None, stack_on_pwd=None,
3651
require_stacking=False):
3654
:param repository: The repository to use.
3655
:param stack_on: A location to stack on
3656
:param stack_on_pwd: If stack_on is relative, the location it is
3659
RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
3661
self._repository = repository
3663
def acquire_repository(self, make_working_trees=None, shared=False):
3664
"""Implementation of RepositoryAcquisitionPolicy.acquire_repository
3666
Returns an existing repository to use.
3668
self._add_fallback(self._repository,
3669
possible_transports=[self._repository.bzrdir.transport])
3670
return self._repository, False
3673
# Please register new formats after old formats so that formats
3674
# appear in chronological order and format descriptions can build
3676
format_registry = BzrDirFormatRegistry()
3677
# The pre-0.8 formats have their repository format network name registered in
3678
# repository.py. MetaDir formats have their repository format network name
3679
# inferred from their disk format string.
3680
format_registry.register('weave', BzrDirFormat6,
3681
'Pre-0.8 format. Slower than knit and does not'
3682
' support checkouts or shared repositories.',
3684
format_registry.register_metadir('metaweave',
3685
'bzrlib.repofmt.weaverepo.RepositoryFormat7',
3686
'Transitional format in 0.8. Slower than knit.',
3687
branch_format='bzrlib.branch.BzrBranchFormat5',
3688
tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3690
format_registry.register_metadir('knit',
3691
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3692
'Format using knits. Recommended for interoperation with bzr <= 0.14.',
3693
branch_format='bzrlib.branch.BzrBranchFormat5',
3694
tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3696
format_registry.register_metadir('dirstate',
3697
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3698
help='New in 0.15: Fast local operations. Compatible with bzr 0.8 and '
3699
'above when accessed over the network.',
3700
branch_format='bzrlib.branch.BzrBranchFormat5',
3701
# this uses bzrlib.workingtree.WorkingTreeFormat4 because importing
3702
# directly from workingtree_4 triggers a circular import.
3703
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3705
format_registry.register_metadir('dirstate-tags',
3706
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3707
help='New in 0.15: Fast local operations and improved scaling for '
3708
'network operations. Additionally adds support for tags.'
3709
' Incompatible with bzr < 0.15.',
3710
branch_format='bzrlib.branch.BzrBranchFormat6',
3711
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3713
format_registry.register_metadir('rich-root',
3714
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
3715
help='New in 1.0. Better handling of tree roots. Incompatible with'
3717
branch_format='bzrlib.branch.BzrBranchFormat6',
3718
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3720
format_registry.register_metadir('dirstate-with-subtree',
3721
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
3722
help='New in 0.15: Fast local operations and improved scaling for '
3723
'network operations. Additionally adds support for versioning nested '
3724
'bzr branches. Incompatible with bzr < 0.15.',
3725
branch_format='bzrlib.branch.BzrBranchFormat6',
3726
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3730
format_registry.register_metadir('pack-0.92',
3731
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack1',
3732
help='New in 0.92: Pack-based format with data compatible with '
3733
'dirstate-tags format repositories. Interoperates with '
3734
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3735
'Previously called knitpack-experimental. '
3736
'For more information, see '
3737
'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
3738
branch_format='bzrlib.branch.BzrBranchFormat6',
3739
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3741
format_registry.register_metadir('pack-0.92-subtree',
3742
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack3',
3743
help='New in 0.92: Pack-based format with data compatible with '
3744
'dirstate-with-subtree format repositories. Interoperates with '
3745
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3746
'Previously called knitpack-experimental. '
3747
'For more information, see '
3748
'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
3749
branch_format='bzrlib.branch.BzrBranchFormat6',
3750
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3754
format_registry.register_metadir('rich-root-pack',
3755
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
3756
help='New in 1.0: A variant of pack-0.92 that supports rich-root data '
3757
'(needed for bzr-svn and bzr-git).',
3758
branch_format='bzrlib.branch.BzrBranchFormat6',
3759
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3761
format_registry.register_metadir('1.6',
3762
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5',
3763
help='A format that allows a branch to indicate that there is another '
3764
'(stacked) repository that should be used to access data that is '
3765
'not present locally.',
3766
branch_format='bzrlib.branch.BzrBranchFormat7',
3767
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3769
format_registry.register_metadir('1.6.1-rich-root',
3770
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5RichRoot',
3771
help='A variant of 1.6 that supports rich-root data '
3772
'(needed for bzr-svn and bzr-git).',
3773
branch_format='bzrlib.branch.BzrBranchFormat7',
3774
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3776
format_registry.register_metadir('1.9',
3777
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3778
help='A repository format using B+tree indexes. These indexes '
3779
'are smaller in size, have smarter caching and provide faster '
3780
'performance for most operations.',
3781
branch_format='bzrlib.branch.BzrBranchFormat7',
3782
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3784
format_registry.register_metadir('1.9-rich-root',
3785
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
3786
help='A variant of 1.9 that supports rich-root data '
3787
'(needed for bzr-svn and bzr-git).',
3788
branch_format='bzrlib.branch.BzrBranchFormat7',
3789
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3791
format_registry.register_metadir('1.14',
3792
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3793
help='A working-tree format that supports content filtering.',
3794
branch_format='bzrlib.branch.BzrBranchFormat7',
3795
tree_format='bzrlib.workingtree.WorkingTreeFormat5',
3797
format_registry.register_metadir('1.14-rich-root',
3798
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
3799
help='A variant of 1.14 that supports rich-root data '
3800
'(needed for bzr-svn and bzr-git).',
3801
branch_format='bzrlib.branch.BzrBranchFormat7',
3802
tree_format='bzrlib.workingtree.WorkingTreeFormat5',
3804
# The following un-numbered 'development' formats should always just be aliases.
3805
format_registry.register_metadir('development-rich-root',
3806
'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
3807
help='Current development format. Supports rich roots. Can convert data '
3808
'to and from rich-root-pack (and anything compatible with '
3809
'rich-root-pack) format repositories. Repositories and branches in '
3810
'this format can only be read by bzr.dev. Please read '
3811
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3813
branch_format='bzrlib.branch.BzrBranchFormat7',
3814
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3818
format_registry.register_metadir('development-subtree',
3819
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment2Subtree',
3820
help='Current development format, subtree variant. Can convert data to and '
3821
'from pack-0.92-subtree (and anything compatible with '
3822
'pack-0.92-subtree) format repositories. Repositories and branches in '
3823
'this format can only be read by bzr.dev. Please read '
3824
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3826
branch_format='bzrlib.branch.BzrBranchFormat7',
3827
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3829
alias=False, # Restore to being an alias when an actual development subtree format is added
3830
# This current non-alias status is simply because we did not introduce a
3831
# chk based subtree format.
3834
# And the development formats above will have aliased one of the following:
3835
format_registry.register_metadir('development6-rich-root',
3836
'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
3837
help='pack-1.9 with 255-way hashed CHK inv, group compress, rich roots '
3839
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3841
branch_format='bzrlib.branch.BzrBranchFormat7',
3842
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3847
format_registry.register_metadir('development7-rich-root',
3848
'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK2',
3849
help='pack-1.9 with 255-way hashed CHK inv, bencode revision, group compress, '
3850
'rich roots. Please read '
3851
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3853
branch_format='bzrlib.branch.BzrBranchFormat7',
3854
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3859
format_registry.register_metadir('2a',
3860
'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
3861
help='First format for bzr 2.0 series.\n'
3862
'Uses group-compress storage.\n'
3863
'Provides rich roots which are a one-way transition.\n',
3864
# 'storage in packs, 255-way hashed CHK inventory, bencode revision, group compress, '
3865
# 'rich roots. Supported by bzr 1.16 and later.',
3866
branch_format='bzrlib.branch.BzrBranchFormat7',
3867
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3871
# The following format should be an alias for the rich root equivalent
3872
# of the default format
3873
format_registry.register_metadir('default-rich-root',
3874
'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
3875
branch_format='bzrlib.branch.BzrBranchFormat7',
3876
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3880
# The current format that is made on 'bzr init'.
3881
format_registry.set_default('2a')
added
removed
bzrlib/bzrdir.py
