1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""BzrDir logic. The BzrDir is the basic control directory used by bzr.
19
At format 7 this was split out into Branch, Repository and Checkout control
22
Note: This module has a lot of ``open`` functions/methods that return
23
references to in-memory objects. As a rule, there are no matching ``close``
24
methods. To free any associated resources, simply stop referencing the
28
# TODO: Move old formats into a plugin to make this file smaller.
33
from bzrlib.lazy_import import lazy_import
34
lazy_import(globals(), """
35
from stat import S_ISDIR
49
revision as _mod_revision,
59
from bzrlib.osutils import (
62
from bzrlib.push import (
65
from bzrlib.repofmt import pack_repo
66
from bzrlib.smart.client import _SmartClient
67
from bzrlib.store.versioned import WeaveStore
68
from bzrlib.transactions import WriteTransaction
69
from bzrlib.transport import (
70
do_catching_redirections,
74
from bzrlib.weave import Weave
77
from bzrlib.trace import (
91
"""A .bzr control diretory.
93
BzrDir instances let you create or open any of the things that can be
94
found within .bzr - checkouts, branches and repositories.
97
the transport which this bzr dir is rooted at (i.e. file:///.../.bzr/)
99
a transport connected to the directory this bzr was opened from
100
(i.e. the parent directory holding the .bzr directory).
102
Everything in the bzrdir should have the same file permissions.
104
:cvar hooks: An instance of BzrDirHooks.
107
def break_lock(self):
108
"""Invoke break_lock on the first object in the bzrdir.
110
If there is a tree, the tree is opened and break_lock() called.
111
Otherwise, branch is tried, and finally repository.
113
# XXX: This seems more like a UI function than something that really
114
# belongs in this class.
116
thing_to_unlock = self.open_workingtree()
117
except (errors.NotLocalUrl, errors.NoWorkingTree):
119
thing_to_unlock = self.open_branch()
120
except errors.NotBranchError:
122
thing_to_unlock = self.open_repository()
123
except errors.NoRepositoryPresent:
125
thing_to_unlock.break_lock()
127
def can_convert_format(self):
128
"""Return true if this bzrdir is one whose format we can convert from."""
131
def check_conversion_target(self, target_format):
132
target_repo_format = target_format.repository_format
133
self.open_repository()._format.check_conversion_target(target_repo_format)
136
def _check_supported(format, allow_unsupported,
137
recommend_upgrade=True,
139
"""Give an error or warning on old formats.
141
:param format: may be any kind of format - workingtree, branch,
144
:param allow_unsupported: If true, allow opening
145
formats that are strongly deprecated, and which may
146
have limited functionality.
148
:param recommend_upgrade: If true (default), warn
149
the user through the ui object that they may wish
150
to upgrade the object.
152
# TODO: perhaps move this into a base Format class; it's not BzrDir
153
# specific. mbp 20070323
154
if not allow_unsupported and not format.is_supported():
155
# see open_downlevel to open legacy branches.
156
raise errors.UnsupportedFormatError(format=format)
157
if recommend_upgrade \
158
and getattr(format, 'upgrade_recommended', False):
159
ui.ui_factory.recommend_upgrade(
160
format.get_format_description(),
163
def clone(self, url, revision_id=None, force_new_repo=False,
164
preserve_stacking=False):
165
"""Clone this bzrdir and its contents to url verbatim.
167
:param url: The url create the clone at. If url's last component does
168
not exist, it will be created.
169
:param revision_id: The tip revision-id to use for any branch or
170
working tree. If not None, then the clone operation may tune
171
itself to download less data.
172
:param force_new_repo: Do not use a shared repository for the target
173
even if one is available.
174
:param preserve_stacking: When cloning a stacked branch, stack the
175
new branch on top of the other branch's stacked-on branch.
177
return self.clone_on_transport(get_transport(url),
178
revision_id=revision_id,
179
force_new_repo=force_new_repo,
180
preserve_stacking=preserve_stacking)
182
def clone_on_transport(self, transport, revision_id=None,
183
force_new_repo=False, preserve_stacking=False, stacked_on=None,
184
create_prefix=False, use_existing_dir=True):
185
"""Clone this bzrdir and its contents to transport verbatim.
187
:param transport: The transport for the location to produce the clone
188
at. If the target directory does not exist, it will be created.
189
:param revision_id: The tip revision-id to use for any branch or
190
working tree. If not None, then the clone operation may tune
191
itself to download less data.
192
:param force_new_repo: Do not use a shared repository for the target,
193
even if one is available.
194
:param preserve_stacking: When cloning a stacked branch, stack the
195
new branch on top of the other branch's stacked-on branch.
196
:param create_prefix: Create any missing directories leading up to
198
:param use_existing_dir: Use an existing directory if one exists.
200
# Overview: put together a broad description of what we want to end up
201
# with; then make as few api calls as possible to do it.
203
# We may want to create a repo/branch/tree, if we do so what format
204
# would we want for each:
205
require_stacking = (stacked_on is not None)
206
format = self.cloning_metadir(require_stacking)
208
# Figure out what objects we want:
210
local_repo = self.find_repository()
211
except errors.NoRepositoryPresent:
214
local_branch = self.open_branch()
215
except errors.NotBranchError:
218
# enable fallbacks when branch is not a branch reference
219
if local_branch.repository.has_same_location(local_repo):
220
local_repo = local_branch.repository
221
if preserve_stacking:
223
stacked_on = local_branch.get_stacked_on_url()
224
except (errors.UnstackableBranchFormat,
225
errors.UnstackableRepositoryFormat,
228
# Bug: We create a metadir without knowing if it can support stacking,
229
# we should look up the policy needs first, or just use it as a hint,
232
make_working_trees = local_repo.make_working_trees()
233
want_shared = local_repo.is_shared()
234
repo_format_name = format.repository_format.network_name()
236
make_working_trees = False
238
repo_format_name = None
240
result_repo, result, require_stacking, repository_policy = \
241
format.initialize_on_transport_ex(transport,
242
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
243
force_new_repo=force_new_repo, stacked_on=stacked_on,
244
stack_on_pwd=self.root_transport.base,
245
repo_format_name=repo_format_name,
246
make_working_trees=make_working_trees, shared_repo=want_shared)
249
# If the result repository is in the same place as the
250
# resulting bzr dir, it will have no content, further if the
251
# result is not stacked then we know all content should be
252
# copied, and finally if we are copying up to a specific
253
# revision_id then we can use the pending-ancestry-result which
254
# does not require traversing all of history to describe it.
255
if (result_repo.bzrdir.root_transport.base ==
256
result.root_transport.base and not require_stacking and
257
revision_id is not None):
258
fetch_spec = graph.PendingAncestryResult(
259
[revision_id], local_repo)
260
result_repo.fetch(local_repo, fetch_spec=fetch_spec)
262
result_repo.fetch(local_repo, revision_id=revision_id)
266
if result_repo is not None:
267
raise AssertionError('result_repo not None(%r)' % result_repo)
268
# 1 if there is a branch present
269
# make sure its content is available in the target repository
271
if local_branch is not None:
272
result_branch = local_branch.clone(result, revision_id=revision_id,
273
repository_policy=repository_policy)
275
# Cheaper to check if the target is not local, than to try making
277
result.root_transport.local_abspath('.')
278
if result_repo is None or result_repo.make_working_trees():
279
self.open_workingtree().clone(result)
280
except (errors.NoWorkingTree, errors.NotLocalUrl):
284
# TODO: This should be given a Transport, and should chdir up; otherwise
285
# this will open a new connection.
286
def _make_tail(self, url):
287
t = get_transport(url)
291
def create(cls, base, format=None, possible_transports=None):
292
"""Create a new BzrDir at the url 'base'.
294
:param format: If supplied, the format of branch to create. If not
295
supplied, the default is used.
296
:param possible_transports: If supplied, a list of transports that
297
can be reused to share a remote connection.
299
if cls is not BzrDir:
300
raise AssertionError("BzrDir.create always creates the default"
301
" format, not one of %r" % cls)
302
t = get_transport(base, possible_transports)
305
format = BzrDirFormat.get_default_format()
306
return format.initialize_on_transport(t)
309
def find_bzrdirs(transport, evaluate=None, list_current=None):
310
"""Find bzrdirs recursively from current location.
312
This is intended primarily as a building block for more sophisticated
313
functionality, like finding trees under a directory, or finding
314
branches that use a given repository.
315
:param evaluate: An optional callable that yields recurse, value,
316
where recurse controls whether this bzrdir is recursed into
317
and value is the value to yield. By default, all bzrdirs
318
are recursed into, and the return value is the bzrdir.
319
:param list_current: if supplied, use this function to list the current
320
directory, instead of Transport.list_dir
321
:return: a generator of found bzrdirs, or whatever evaluate returns.
323
if list_current is None:
324
def list_current(transport):
325
return transport.list_dir('')
327
def evaluate(bzrdir):
330
pending = [transport]
331
while len(pending) > 0:
332
current_transport = pending.pop()
335
bzrdir = BzrDir.open_from_transport(current_transport)
336
except errors.NotBranchError:
339
recurse, value = evaluate(bzrdir)
342
subdirs = list_current(current_transport)
343
except errors.NoSuchFile:
346
for subdir in sorted(subdirs, reverse=True):
347
pending.append(current_transport.clone(subdir))
350
def find_branches(transport):
351
"""Find all branches under a transport.
353
This will find all branches below the transport, including branches
354
inside other branches. Where possible, it will use
355
Repository.find_branches.
357
To list all the branches that use a particular Repository, see
358
Repository.find_branches
360
def evaluate(bzrdir):
362
repository = bzrdir.open_repository()
363
except errors.NoRepositoryPresent:
366
return False, (None, repository)
368
branch = bzrdir.open_branch()
369
except errors.NotBranchError:
370
return True, (None, None)
372
return True, (branch, None)
374
for branch, repo in BzrDir.find_bzrdirs(transport, evaluate=evaluate):
376
branches.extend(repo.find_branches())
377
if branch is not None:
378
branches.append(branch)
381
def destroy_repository(self):
382
"""Destroy the repository in this BzrDir"""
383
raise NotImplementedError(self.destroy_repository)
385
def create_branch(self):
386
"""Create a branch in this BzrDir.
388
The bzrdir's format will control what branch format is created.
389
For more control see BranchFormatXX.create(a_bzrdir).
391
raise NotImplementedError(self.create_branch)
393
def destroy_branch(self):
394
"""Destroy the branch in this BzrDir"""
395
raise NotImplementedError(self.destroy_branch)
398
def create_branch_and_repo(base, force_new_repo=False, format=None):
399
"""Create a new BzrDir, Branch and Repository at the url 'base'.
401
This will use the current default BzrDirFormat unless one is
402
specified, and use whatever
403
repository format that that uses via bzrdir.create_branch and
404
create_repository. If a shared repository is available that is used
407
The created Branch object is returned.
409
:param base: The URL to create the branch at.
410
:param force_new_repo: If True a new repository is always created.
411
:param format: If supplied, the format of branch to create. If not
412
supplied, the default is used.
414
bzrdir = BzrDir.create(base, format)
415
bzrdir._find_or_create_repository(force_new_repo)
416
return bzrdir.create_branch()
418
def determine_repository_policy(self, force_new_repo=False, stack_on=None,
419
stack_on_pwd=None, require_stacking=False):
420
"""Return an object representing a policy to use.
422
This controls whether a new repository is created, and the format of
423
that repository, or some existing shared repository used instead.
425
If stack_on is supplied, will not seek a containing shared repo.
427
:param force_new_repo: If True, require a new repository to be created.
428
:param stack_on: If supplied, the location to stack on. If not
429
supplied, a default_stack_on location may be used.
430
:param stack_on_pwd: If stack_on is relative, the location it is
433
def repository_policy(found_bzrdir):
436
config = found_bzrdir.get_config()
438
stack_on = config.get_default_stack_on()
439
if stack_on is not None:
440
stack_on_pwd = found_bzrdir.root_transport.base
442
# does it have a repository ?
444
repository = found_bzrdir.open_repository()
445
except errors.NoRepositoryPresent:
448
if ((found_bzrdir.root_transport.base !=
449
self.root_transport.base) and not repository.is_shared()):
450
# Don't look higher, can't use a higher shared repo.
458
return UseExistingRepository(repository, stack_on,
459
stack_on_pwd, require_stacking=require_stacking), True
461
return CreateRepository(self, stack_on, stack_on_pwd,
462
require_stacking=require_stacking), True
464
if not force_new_repo:
466
policy = self._find_containing(repository_policy)
467
if policy is not None:
471
return UseExistingRepository(self.open_repository(),
472
stack_on, stack_on_pwd,
473
require_stacking=require_stacking)
474
except errors.NoRepositoryPresent:
476
return CreateRepository(self, stack_on, stack_on_pwd,
477
require_stacking=require_stacking)
479
def _find_or_create_repository(self, force_new_repo):
480
"""Create a new repository if needed, returning the repository."""
481
policy = self.determine_repository_policy(force_new_repo)
482
return policy.acquire_repository()[0]
485
def create_branch_convenience(base, force_new_repo=False,
486
force_new_tree=None, format=None,
487
possible_transports=None):
488
"""Create a new BzrDir, Branch and Repository at the url 'base'.
490
This is a convenience function - it will use an existing repository
491
if possible, can be told explicitly whether to create a working tree or
494
This will use the current default BzrDirFormat unless one is
495
specified, and use whatever
496
repository format that that uses via bzrdir.create_branch and
497
create_repository. If a shared repository is available that is used
498
preferentially. Whatever repository is used, its tree creation policy
501
The created Branch object is returned.
502
If a working tree cannot be made due to base not being a file:// url,
503
no error is raised unless force_new_tree is True, in which case no
504
data is created on disk and NotLocalUrl is raised.
506
:param base: The URL to create the branch at.
507
:param force_new_repo: If True a new repository is always created.
508
:param force_new_tree: If True or False force creation of a tree or
509
prevent such creation respectively.
510
:param format: Override for the bzrdir format to create.
511
:param possible_transports: An optional reusable transports list.
514
# check for non local urls
515
t = get_transport(base, possible_transports)
516
if not isinstance(t, local.LocalTransport):
517
raise errors.NotLocalUrl(base)
518
bzrdir = BzrDir.create(base, format, possible_transports)
519
repo = bzrdir._find_or_create_repository(force_new_repo)
520
result = bzrdir.create_branch()
521
if force_new_tree or (repo.make_working_trees() and
522
force_new_tree is None):
524
bzrdir.create_workingtree()
525
except errors.NotLocalUrl:
530
def create_standalone_workingtree(base, format=None):
531
"""Create a new BzrDir, WorkingTree, Branch and Repository at 'base'.
533
'base' must be a local path or a file:// url.
535
This will use the current default BzrDirFormat unless one is
536
specified, and use whatever
537
repository format that that uses for bzrdirformat.create_workingtree,
538
create_branch and create_repository.
540
:param format: Override for the bzrdir format to create.
541
:return: The WorkingTree object.
543
t = get_transport(base)
544
if not isinstance(t, local.LocalTransport):
545
raise errors.NotLocalUrl(base)
546
bzrdir = BzrDir.create_branch_and_repo(base,
548
format=format).bzrdir
549
return bzrdir.create_workingtree()
551
def create_workingtree(self, revision_id=None, from_branch=None,
552
accelerator_tree=None, hardlink=False):
553
"""Create a working tree at this BzrDir.
555
:param revision_id: create it as of this revision id.
556
:param from_branch: override bzrdir branch (for lightweight checkouts)
557
:param accelerator_tree: A tree which can be used for retrieving file
558
contents more quickly than the revision tree, i.e. a workingtree.
559
The revision tree will be used for cases where accelerator_tree's
560
content is different.
562
raise NotImplementedError(self.create_workingtree)
564
def backup_bzrdir(self):
565
"""Backup this bzr control directory.
567
:return: Tuple with old path name and new path name
569
pb = ui.ui_factory.nested_progress_bar()
571
# FIXME: bug 300001 -- the backup fails if the backup directory
572
# already exists, but it should instead either remove it or make
573
# a new backup directory.
575
# FIXME: bug 262450 -- the backup directory should have the same
576
# permissions as the .bzr directory (probably a bug in copy_tree)
577
old_path = self.root_transport.abspath('.bzr')
578
new_path = self.root_transport.abspath('backup.bzr')
579
pb.note('making backup of %s' % (old_path,))
580
pb.note(' to %s' % (new_path,))
581
self.root_transport.copy_tree('.bzr', 'backup.bzr')
582
return (old_path, new_path)
586
def retire_bzrdir(self, limit=10000):
587
"""Permanently disable the bzrdir.
589
This is done by renaming it to give the user some ability to recover
590
if there was a problem.
592
This will have horrible consequences if anyone has anything locked or
594
:param limit: number of times to retry
599
to_path = '.bzr.retired.%d' % i
600
self.root_transport.rename('.bzr', to_path)
601
note("renamed %s to %s"
602
% (self.root_transport.abspath('.bzr'), to_path))
604
except (errors.TransportError, IOError, errors.PathError):
611
def destroy_workingtree(self):
612
"""Destroy the working tree at this BzrDir.
614
Formats that do not support this may raise UnsupportedOperation.
616
raise NotImplementedError(self.destroy_workingtree)
618
def destroy_workingtree_metadata(self):
619
"""Destroy the control files for the working tree at this BzrDir.
621
The contents of working tree files are not affected.
622
Formats that do not support this may raise UnsupportedOperation.
624
raise NotImplementedError(self.destroy_workingtree_metadata)
626
def _find_containing(self, evaluate):
627
"""Find something in a containing control directory.
629
This method will scan containing control dirs, until it finds what
630
it is looking for, decides that it will never find it, or runs out
631
of containing control directories to check.
633
It is used to implement find_repository and
634
determine_repository_policy.
636
:param evaluate: A function returning (value, stop). If stop is True,
637
the value will be returned.
641
result, stop = evaluate(found_bzrdir)
644
next_transport = found_bzrdir.root_transport.clone('..')
645
if (found_bzrdir.root_transport.base == next_transport.base):
646
# top of the file system
648
# find the next containing bzrdir
650
found_bzrdir = BzrDir.open_containing_from_transport(
652
except errors.NotBranchError:
655
def find_repository(self):
656
"""Find the repository that should be used.
658
This does not require a branch as we use it to find the repo for
659
new branches as well as to hook existing branches up to their
662
def usable_repository(found_bzrdir):
663
# does it have a repository ?
665
repository = found_bzrdir.open_repository()
666
except errors.NoRepositoryPresent:
668
if found_bzrdir.root_transport.base == self.root_transport.base:
669
return repository, True
670
elif repository.is_shared():
671
return repository, True
675
found_repo = self._find_containing(usable_repository)
676
if found_repo is None:
677
raise errors.NoRepositoryPresent(self)
680
def get_branch_reference(self):
681
"""Return the referenced URL for the branch in this bzrdir.
683
:raises NotBranchError: If there is no Branch.
684
:return: The URL the branch in this bzrdir references if it is a
685
reference branch, or None for regular branches.
689
def get_branch_transport(self, branch_format):
690
"""Get the transport for use by branch format in this BzrDir.
692
Note that bzr dirs that do not support format strings will raise
693
IncompatibleFormat if the branch format they are given has
694
a format string, and vice versa.
696
If branch_format is None, the transport is returned with no
697
checking. If it is not None, then the returned transport is
698
guaranteed to point to an existing directory ready for use.
700
raise NotImplementedError(self.get_branch_transport)
702
def _find_creation_modes(self):
703
"""Determine the appropriate modes for files and directories.
705
They're always set to be consistent with the base directory,
706
assuming that this transport allows setting modes.
708
# TODO: Do we need or want an option (maybe a config setting) to turn
709
# this off or override it for particular locations? -- mbp 20080512
710
if self._mode_check_done:
712
self._mode_check_done = True
714
st = self.transport.stat('.')
715
except errors.TransportNotPossible:
716
self._dir_mode = None
717
self._file_mode = None
719
# Check the directory mode, but also make sure the created
720
# directories and files are read-write for this user. This is
721
# mostly a workaround for filesystems which lie about being able to
722
# write to a directory (cygwin & win32)
723
if (st.st_mode & 07777 == 00000):
724
# FTP allows stat but does not return dir/file modes
725
self._dir_mode = None
726
self._file_mode = None
728
self._dir_mode = (st.st_mode & 07777) | 00700
729
# Remove the sticky and execute bits for files
730
self._file_mode = self._dir_mode & ~07111
732
def _get_file_mode(self):
733
"""Return Unix mode for newly created files, or None.
735
if not self._mode_check_done:
736
self._find_creation_modes()
737
return self._file_mode
739
def _get_dir_mode(self):
740
"""Return Unix mode for newly created directories, or None.
742
if not self._mode_check_done:
743
self._find_creation_modes()
744
return self._dir_mode
746
def get_repository_transport(self, repository_format):
747
"""Get the transport for use by repository format in this BzrDir.
749
Note that bzr dirs that do not support format strings will raise
750
IncompatibleFormat if the repository format they are given has
751
a format string, and vice versa.
753
If repository_format is None, the transport is returned with no
754
checking. If it is not None, then the returned transport is
755
guaranteed to point to an existing directory ready for use.
757
raise NotImplementedError(self.get_repository_transport)
759
def get_workingtree_transport(self, tree_format):
760
"""Get the transport for use by workingtree format in this BzrDir.
762
Note that bzr dirs that do not support format strings will raise
763
IncompatibleFormat if the workingtree format they are given has a
764
format string, and vice versa.
766
If workingtree_format is None, the transport is returned with no
767
checking. If it is not None, then the returned transport is
768
guaranteed to point to an existing directory ready for use.
770
raise NotImplementedError(self.get_workingtree_transport)
772
def get_config(self):
773
"""Get configuration for this BzrDir."""
774
return config.BzrDirConfig(self)
776
def _get_config(self):
777
"""By default, no configuration is available."""
780
def __init__(self, _transport, _format):
781
"""Initialize a Bzr control dir object.
783
Only really common logic should reside here, concrete classes should be
784
made with varying behaviours.
786
:param _format: the format that is creating this BzrDir instance.
787
:param _transport: the transport this dir is based at.
789
self._format = _format
790
self.transport = _transport.clone('.bzr')
791
self.root_transport = _transport
792
self._mode_check_done = False
794
def is_control_filename(self, filename):
795
"""True if filename is the name of a path which is reserved for bzrdir's.
797
:param filename: A filename within the root transport of this bzrdir.
799
This is true IF and ONLY IF the filename is part of the namespace reserved
800
for bzr control dirs. Currently this is the '.bzr' directory in the root
801
of the root_transport. it is expected that plugins will need to extend
802
this in the future - for instance to make bzr talk with svn working
805
# this might be better on the BzrDirFormat class because it refers to
806
# all the possible bzrdir disk formats.
807
# This method is tested via the workingtree is_control_filename tests-
808
# it was extracted from WorkingTree.is_control_filename. If the method's
809
# contract is extended beyond the current trivial implementation, please
810
# add new tests for it to the appropriate place.
811
return filename == '.bzr' or filename.startswith('.bzr/')
813
def needs_format_conversion(self, format=None):
814
"""Return true if this bzrdir needs convert_format run on it.
816
For instance, if the repository format is out of date but the
817
branch and working tree are not, this should return True.
819
:param format: Optional parameter indicating a specific desired
820
format we plan to arrive at.
822
raise NotImplementedError(self.needs_format_conversion)
825
def open_unsupported(base):
826
"""Open a branch which is not supported."""
827
return BzrDir.open(base, _unsupported=True)
830
def open(base, _unsupported=False, possible_transports=None):
831
"""Open an existing bzrdir, rooted at 'base' (url).
833
:param _unsupported: a private parameter to the BzrDir class.
835
t = get_transport(base, possible_transports=possible_transports)
836
return BzrDir.open_from_transport(t, _unsupported=_unsupported)
839
def open_from_transport(transport, _unsupported=False,
840
_server_formats=True):
841
"""Open a bzrdir within a particular directory.
843
:param transport: Transport containing the bzrdir.
844
:param _unsupported: private.
846
for hook in BzrDir.hooks['pre_open']:
848
# Keep initial base since 'transport' may be modified while following
850
base = transport.base
851
def find_format(transport):
852
return transport, BzrDirFormat.find_format(
853
transport, _server_formats=_server_formats)
855
def redirected(transport, e, redirection_notice):
856
redirected_transport = transport._redirected_to(e.source, e.target)
857
if redirected_transport is None:
858
raise errors.NotBranchError(base)
859
note('%s is%s redirected to %s',
860
transport.base, e.permanently, redirected_transport.base)
861
return redirected_transport
864
transport, format = do_catching_redirections(find_format,
867
except errors.TooManyRedirections:
868
raise errors.NotBranchError(base)
870
BzrDir._check_supported(format, _unsupported)
871
return format.open(transport, _found=True)
873
def open_branch(self, unsupported=False, ignore_fallbacks=False):
874
"""Open the branch object at this BzrDir if one is present.
876
If unsupported is True, then no longer supported branch formats can
879
TODO: static convenience version of this?
881
raise NotImplementedError(self.open_branch)
884
def open_containing(url, possible_transports=None):
885
"""Open an existing branch which contains url.
887
:param url: url to search from.
888
See open_containing_from_transport for more detail.
890
transport = get_transport(url, possible_transports)
891
return BzrDir.open_containing_from_transport(transport)
894
def open_containing_from_transport(a_transport):
895
"""Open an existing branch which contains a_transport.base.
897
This probes for a branch at a_transport, and searches upwards from there.
899
Basically we keep looking up until we find the control directory or
900
run into the root. If there isn't one, raises NotBranchError.
901
If there is one and it is either an unrecognised format or an unsupported
902
format, UnknownFormatError or UnsupportedFormatError are raised.
903
If there is one, it is returned, along with the unused portion of url.
905
:return: The BzrDir that contains the path, and a Unicode path
906
for the rest of the URL.
908
# this gets the normalised url back. I.e. '.' -> the full path.
909
url = a_transport.base
912
result = BzrDir.open_from_transport(a_transport)
913
return result, urlutils.unescape(a_transport.relpath(url))
914
except errors.NotBranchError, e:
917
new_t = a_transport.clone('..')
918
except errors.InvalidURLJoin:
919
# reached the root, whatever that may be
920
raise errors.NotBranchError(path=url)
921
if new_t.base == a_transport.base:
922
# reached the root, whatever that may be
923
raise errors.NotBranchError(path=url)
926
def _get_tree_branch(self):
927
"""Return the branch and tree, if any, for this bzrdir.
929
Return None for tree if not present or inaccessible.
930
Raise NotBranchError if no branch is present.
931
:return: (tree, branch)
934
tree = self.open_workingtree()
935
except (errors.NoWorkingTree, errors.NotLocalUrl):
937
branch = self.open_branch()
943
def open_tree_or_branch(klass, location):
944
"""Return the branch and working tree at a location.
946
If there is no tree at the location, tree will be None.
947
If there is no branch at the location, an exception will be
949
:return: (tree, branch)
951
bzrdir = klass.open(location)
952
return bzrdir._get_tree_branch()
955
def open_containing_tree_or_branch(klass, location):
956
"""Return the branch and working tree contained by a location.
958
Returns (tree, branch, relpath).
959
If there is no tree at containing the location, tree will be None.
960
If there is no branch containing the location, an exception will be
962
relpath is the portion of the path that is contained by the branch.
964
bzrdir, relpath = klass.open_containing(location)
965
tree, branch = bzrdir._get_tree_branch()
966
return tree, branch, relpath
969
def open_containing_tree_branch_or_repository(klass, location):
970
"""Return the working tree, branch and repo contained by a location.
972
Returns (tree, branch, repository, relpath).
973
If there is no tree containing the location, tree will be None.
974
If there is no branch containing the location, branch will be None.
975
If there is no repository containing the location, repository will be
977
relpath is the portion of the path that is contained by the innermost
980
If no tree, branch or repository is found, a NotBranchError is raised.
982
bzrdir, relpath = klass.open_containing(location)
984
tree, branch = bzrdir._get_tree_branch()
985
except errors.NotBranchError:
987
repo = bzrdir.find_repository()
988
return None, None, repo, relpath
989
except (errors.NoRepositoryPresent):
990
raise errors.NotBranchError(location)
991
return tree, branch, branch.repository, relpath
993
def open_repository(self, _unsupported=False):
994
"""Open the repository object at this BzrDir if one is present.
996
This will not follow the Branch object pointer - it's strictly a direct
997
open facility. Most client code should use open_branch().repository to
1000
:param _unsupported: a private parameter, not part of the api.
1001
TODO: static convenience version of this?
1003
raise NotImplementedError(self.open_repository)
1005
def open_workingtree(self, _unsupported=False,
1006
recommend_upgrade=True, from_branch=None):
1007
"""Open the workingtree object at this BzrDir if one is present.
1009
:param recommend_upgrade: Optional keyword parameter, when True (the
1010
default), emit through the ui module a recommendation that the user
1011
upgrade the working tree when the workingtree being opened is old
1012
(but still fully supported).
1013
:param from_branch: override bzrdir branch (for lightweight checkouts)
1015
raise NotImplementedError(self.open_workingtree)
1017
def has_branch(self):
1018
"""Tell if this bzrdir contains a branch.
1020
Note: if you're going to open the branch, you should just go ahead
1021
and try, and not ask permission first. (This method just opens the
1022
branch and discards it, and that's somewhat expensive.)
1027
except errors.NotBranchError:
1030
def has_workingtree(self):
1031
"""Tell if this bzrdir contains a working tree.
1033
This will still raise an exception if the bzrdir has a workingtree that
1034
is remote & inaccessible.
1036
Note: if you're going to open the working tree, you should just go ahead
1037
and try, and not ask permission first. (This method just opens the
1038
workingtree and discards it, and that's somewhat expensive.)
1041
self.open_workingtree(recommend_upgrade=False)
1043
except errors.NoWorkingTree:
1046
def _cloning_metadir(self):
1047
"""Produce a metadir suitable for cloning with.
1049
:returns: (destination_bzrdir_format, source_repository)
1051
result_format = self._format.__class__()
1054
branch = self.open_branch(ignore_fallbacks=True)
1055
source_repository = branch.repository
1056
result_format._branch_format = branch._format
1057
except errors.NotBranchError:
1058
source_branch = None
1059
source_repository = self.open_repository()
1060
except errors.NoRepositoryPresent:
1061
source_repository = None
1063
# XXX TODO: This isinstance is here because we have not implemented
1064
# the fix recommended in bug # 103195 - to delegate this choice the
1065
# repository itself.
1066
repo_format = source_repository._format
1067
if isinstance(repo_format, remote.RemoteRepositoryFormat):
1068
source_repository._ensure_real()
1069
repo_format = source_repository._real_repository._format
1070
result_format.repository_format = repo_format
1072
# TODO: Couldn't we just probe for the format in these cases,
1073
# rather than opening the whole tree? It would be a little
1074
# faster. mbp 20070401
1075
tree = self.open_workingtree(recommend_upgrade=False)
1076
except (errors.NoWorkingTree, errors.NotLocalUrl):
1077
result_format.workingtree_format = None
1079
result_format.workingtree_format = tree._format.__class__()
1080
return result_format, source_repository
1082
def cloning_metadir(self, require_stacking=False):
1083
"""Produce a metadir suitable for cloning or sprouting with.
1085
These operations may produce workingtrees (yes, even though they're
1086
"cloning" something that doesn't have a tree), so a viable workingtree
1087
format must be selected.
1089
:require_stacking: If True, non-stackable formats will be upgraded
1090
to similar stackable formats.
1091
:returns: a BzrDirFormat with all component formats either set
1092
appropriately or set to None if that component should not be
1095
format, repository = self._cloning_metadir()
1096
if format._workingtree_format is None:
1098
if repository is None:
1099
# No repository either
1101
# We have a repository, so set a working tree? (Why? This seems to
1102
# contradict the stated return value in the docstring).
1103
tree_format = repository._format._matchingbzrdir.workingtree_format
1104
format.workingtree_format = tree_format.__class__()
1105
if require_stacking:
1106
format.require_stacking()
1109
def checkout_metadir(self):
1110
return self.cloning_metadir()
1112
def sprout(self, url, revision_id=None, force_new_repo=False,
1113
recurse='down', possible_transports=None,
1114
accelerator_tree=None, hardlink=False, stacked=False,
1115
source_branch=None, create_tree_if_local=True):
1116
"""Create a copy of this bzrdir prepared for use as a new line of
1119
If url's last component does not exist, it will be created.
1121
Attributes related to the identity of the source branch like
1122
branch nickname will be cleaned, a working tree is created
1123
whether one existed before or not; and a local branch is always
1126
if revision_id is not None, then the clone operation may tune
1127
itself to download less data.
1128
:param accelerator_tree: A tree which can be used for retrieving file
1129
contents more quickly than the revision tree, i.e. a workingtree.
1130
The revision tree will be used for cases where accelerator_tree's
1131
content is different.
1132
:param hardlink: If true, hard-link files from accelerator_tree,
1134
:param stacked: If true, create a stacked branch referring to the
1135
location of this control directory.
1136
:param create_tree_if_local: If true, a working-tree will be created
1137
when working locally.
1139
target_transport = get_transport(url, possible_transports)
1140
target_transport.ensure_base()
1141
cloning_format = self.cloning_metadir(stacked)
1142
# Create/update the result branch
1143
result = cloning_format.initialize_on_transport(target_transport)
1144
# if a stacked branch wasn't requested, we don't create one
1145
# even if the origin was stacked
1146
stacked_branch_url = None
1147
if source_branch is not None:
1149
stacked_branch_url = self.root_transport.base
1150
source_repository = source_branch.repository
1153
source_branch = self.open_branch()
1154
source_repository = source_branch.repository
1156
stacked_branch_url = self.root_transport.base
1157
except errors.NotBranchError:
1158
source_branch = None
1160
source_repository = self.open_repository()
1161
except errors.NoRepositoryPresent:
1162
source_repository = None
1163
repository_policy = result.determine_repository_policy(
1164
force_new_repo, stacked_branch_url, require_stacking=stacked)
1165
result_repo, is_new_repo = repository_policy.acquire_repository()
1166
if is_new_repo and revision_id is not None and not stacked:
1167
fetch_spec = graph.PendingAncestryResult(
1168
[revision_id], source_repository)
1171
if source_repository is not None:
1172
# Fetch while stacked to prevent unstacked fetch from
1174
if fetch_spec is None:
1175
result_repo.fetch(source_repository, revision_id=revision_id)
1177
result_repo.fetch(source_repository, fetch_spec=fetch_spec)
1179
if source_branch is None:
1180
# this is for sprouting a bzrdir without a branch; is that
1182
# Not especially, but it's part of the contract.
1183
result_branch = result.create_branch()
1185
result_branch = source_branch.sprout(result,
1186
revision_id=revision_id, repository_policy=repository_policy)
1187
mutter("created new branch %r" % (result_branch,))
1189
# Create/update the result working tree
1190
if (create_tree_if_local and
1191
isinstance(target_transport, local.LocalTransport) and
1192
(result_repo is None or result_repo.make_working_trees())):
1193
wt = result.create_workingtree(accelerator_tree=accelerator_tree,
1197
if wt.path2id('') is None:
1199
wt.set_root_id(self.open_workingtree.get_root_id())
1200
except errors.NoWorkingTree:
1206
if recurse == 'down':
1208
basis = wt.basis_tree()
1210
subtrees = basis.iter_references()
1211
elif result_branch is not None:
1212
basis = result_branch.basis_tree()
1214
subtrees = basis.iter_references()
1215
elif source_branch is not None:
1216
basis = source_branch.basis_tree()
1218
subtrees = basis.iter_references()
1223
for path, file_id in subtrees:
1224
target = urlutils.join(url, urlutils.escape(path))
1225
sublocation = source_branch.reference_parent(file_id, path)
1226
sublocation.bzrdir.sprout(target,
1227
basis.get_reference_revision(file_id, path),
1228
force_new_repo=force_new_repo, recurse=recurse,
1231
if basis is not None:
1235
def push_branch(self, source, revision_id=None, overwrite=False,
1236
remember=False, create_prefix=False):
1237
"""Push the source branch into this BzrDir."""
1239
# If we can open a branch, use its direct repository, otherwise see
1240
# if there is a repository without a branch.
1242
br_to = self.open_branch()
1243
except errors.NotBranchError:
1244
# Didn't find a branch, can we find a repository?
1245
repository_to = self.find_repository()
1247
# Found a branch, so we must have found a repository
1248
repository_to = br_to.repository
1250
push_result = PushResult()
1251
push_result.source_branch = source
1253
# We have a repository but no branch, copy the revisions, and then
1255
repository_to.fetch(source.repository, revision_id=revision_id)
1256
br_to = source.clone(self, revision_id=revision_id)
1257
if source.get_push_location() is None or remember:
1258
source.set_push_location(br_to.base)
1259
push_result.stacked_on = None
1260
push_result.branch_push_result = None
1261
push_result.old_revno = None
1262
push_result.old_revid = _mod_revision.NULL_REVISION
1263
push_result.target_branch = br_to
1264
push_result.master_branch = None
1265
push_result.workingtree_updated = False
1267
# We have successfully opened the branch, remember if necessary:
1268
if source.get_push_location() is None or remember:
1269
source.set_push_location(br_to.base)
1271
tree_to = self.open_workingtree()
1272
except errors.NotLocalUrl:
1273
push_result.branch_push_result = source.push(br_to,
1274
overwrite, stop_revision=revision_id)
1275
push_result.workingtree_updated = False
1276
except errors.NoWorkingTree:
1277
push_result.branch_push_result = source.push(br_to,
1278
overwrite, stop_revision=revision_id)
1279
push_result.workingtree_updated = None # Not applicable
1281
tree_to.lock_write()
1283
push_result.branch_push_result = source.push(
1284
tree_to.branch, overwrite, stop_revision=revision_id)
1288
push_result.workingtree_updated = True
1289
push_result.old_revno = push_result.branch_push_result.old_revno
1290
push_result.old_revid = push_result.branch_push_result.old_revid
1291
push_result.target_branch = \
1292
push_result.branch_push_result.target_branch
1296
class BzrDirHooks(hooks.Hooks):
1297
"""Hooks for BzrDir operations."""
1300
"""Create the default hooks."""
1301
hooks.Hooks.__init__(self)
1302
self.create_hook(hooks.HookPoint('pre_open',
1303
"Invoked before attempting to open a BzrDir with the transport "
1304
"that the open will use.", (1, 14), None))
1306
# install the default hooks
1307
BzrDir.hooks = BzrDirHooks()
1310
class BzrDirPreSplitOut(BzrDir):
1311
"""A common class for the all-in-one formats."""
1313
def __init__(self, _transport, _format):
1314
"""See BzrDir.__init__."""
1315
super(BzrDirPreSplitOut, self).__init__(_transport, _format)
1316
self._control_files = lockable_files.LockableFiles(
1317
self.get_branch_transport(None),
1318
self._format._lock_file_name,
1319
self._format._lock_class)
1321
def break_lock(self):
1322
"""Pre-splitout bzrdirs do not suffer from stale locks."""
1323
raise NotImplementedError(self.break_lock)
1325
def cloning_metadir(self, require_stacking=False):
1326
"""Produce a metadir suitable for cloning with."""
1327
if require_stacking:
1328
return format_registry.make_bzrdir('1.6')
1329
return self._format.__class__()
1331
def clone(self, url, revision_id=None, force_new_repo=False,
1332
preserve_stacking=False):
1333
"""See BzrDir.clone().
1335
force_new_repo has no effect, since this family of formats always
1336
require a new repository.
1337
preserve_stacking has no effect, since no source branch using this
1338
family of formats can be stacked, so there is no stacking to preserve.
1340
self._make_tail(url)
1341
result = self._format._initialize_for_clone(url)
1342
self.open_repository().clone(result, revision_id=revision_id)
1343
from_branch = self.open_branch()
1344
from_branch.clone(result, revision_id=revision_id)
1346
tree = self.open_workingtree()
1347
except errors.NotLocalUrl:
1348
# make a new one, this format always has to have one.
1349
result._init_workingtree()
1354
def create_branch(self):
1355
"""See BzrDir.create_branch."""
1356
return self._format.get_branch_format().initialize(self)
1358
def destroy_branch(self):
1359
"""See BzrDir.destroy_branch."""
1360
raise errors.UnsupportedOperation(self.destroy_branch, self)
1362
def create_repository(self, shared=False):
1363
"""See BzrDir.create_repository."""
1365
raise errors.IncompatibleFormat('shared repository', self._format)
1366
return self.open_repository()
1368
def destroy_repository(self):
1369
"""See BzrDir.destroy_repository."""
1370
raise errors.UnsupportedOperation(self.destroy_repository, self)
1372
def create_workingtree(self, revision_id=None, from_branch=None,
1373
accelerator_tree=None, hardlink=False):
1374
"""See BzrDir.create_workingtree."""
1375
# The workingtree is sometimes created when the bzrdir is created,
1376
# but not when cloning.
1378
# this looks buggy but is not -really-
1379
# because this format creates the workingtree when the bzrdir is
1381
# clone and sprout will have set the revision_id
1382
# and that will have set it for us, its only
1383
# specific uses of create_workingtree in isolation
1384
# that can do wonky stuff here, and that only
1385
# happens for creating checkouts, which cannot be
1386
# done on this format anyway. So - acceptable wart.
1388
warning("can't support hardlinked working trees in %r"
1391
result = self.open_workingtree(recommend_upgrade=False)
1392
except errors.NoSuchFile:
1393
result = self._init_workingtree()
1394
if revision_id is not None:
1395
if revision_id == _mod_revision.NULL_REVISION:
1396
result.set_parent_ids([])
1398
result.set_parent_ids([revision_id])
1401
def _init_workingtree(self):
1402
from bzrlib.workingtree import WorkingTreeFormat2
1404
return WorkingTreeFormat2().initialize(self)
1405
except errors.NotLocalUrl:
1406
# Even though we can't access the working tree, we need to
1407
# create its control files.
1408
return WorkingTreeFormat2()._stub_initialize_on_transport(
1409
self.transport, self._control_files._file_mode)
1411
def destroy_workingtree(self):
1412
"""See BzrDir.destroy_workingtree."""
1413
raise errors.UnsupportedOperation(self.destroy_workingtree, self)
1415
def destroy_workingtree_metadata(self):
1416
"""See BzrDir.destroy_workingtree_metadata."""
1417
raise errors.UnsupportedOperation(self.destroy_workingtree_metadata,
1420
def get_branch_transport(self, branch_format):
1421
"""See BzrDir.get_branch_transport()."""
1422
if branch_format is None:
1423
return self.transport
1425
branch_format.get_format_string()
1426
except NotImplementedError:
1427
return self.transport
1428
raise errors.IncompatibleFormat(branch_format, self._format)
1430
def get_repository_transport(self, repository_format):
1431
"""See BzrDir.get_repository_transport()."""
1432
if repository_format is None:
1433
return self.transport
1435
repository_format.get_format_string()
1436
except NotImplementedError:
1437
return self.transport
1438
raise errors.IncompatibleFormat(repository_format, self._format)
1440
def get_workingtree_transport(self, workingtree_format):
1441
"""See BzrDir.get_workingtree_transport()."""
1442
if workingtree_format is None:
1443
return self.transport
1445
workingtree_format.get_format_string()
1446
except NotImplementedError:
1447
return self.transport
1448
raise errors.IncompatibleFormat(workingtree_format, self._format)
1450
def needs_format_conversion(self, format=None):
1451
"""See BzrDir.needs_format_conversion()."""
1452
# if the format is not the same as the system default,
1453
# an upgrade is needed.
1455
symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1456
% 'needs_format_conversion(format=None)')
1457
format = BzrDirFormat.get_default_format()
1458
return not isinstance(self._format, format.__class__)
1460
def open_branch(self, unsupported=False, ignore_fallbacks=False):
1461
"""See BzrDir.open_branch."""
1462
from bzrlib.branch import BzrBranchFormat4
1463
format = BzrBranchFormat4()
1464
self._check_supported(format, unsupported)
1465
return format.open(self, _found=True)
1467
def sprout(self, url, revision_id=None, force_new_repo=False,
1468
possible_transports=None, accelerator_tree=None,
1469
hardlink=False, stacked=False, create_tree_if_local=True,
1470
source_branch=None):
1471
"""See BzrDir.sprout()."""
1472
if source_branch is not None:
1473
my_branch = self.open_branch()
1474
if source_branch.base != my_branch.base:
1475
raise AssertionError(
1476
"source branch %r is not within %r with branch %r" %
1477
(source_branch, self, my_branch))
1479
raise errors.UnstackableBranchFormat(
1480
self._format, self.root_transport.base)
1481
if not create_tree_if_local:
1482
raise errors.MustHaveWorkingTree(
1483
self._format, self.root_transport.base)
1484
from bzrlib.workingtree import WorkingTreeFormat2
1485
self._make_tail(url)
1486
result = self._format._initialize_for_clone(url)
1488
self.open_repository().clone(result, revision_id=revision_id)
1489
except errors.NoRepositoryPresent:
1492
self.open_branch().sprout(result, revision_id=revision_id)
1493
except errors.NotBranchError:
1496
# we always want a working tree
1497
WorkingTreeFormat2().initialize(result,
1498
accelerator_tree=accelerator_tree,
1503
class BzrDir4(BzrDirPreSplitOut):
1504
"""A .bzr version 4 control object.
1506
This is a deprecated format and may be removed after sept 2006.
1509
def create_repository(self, shared=False):
1510
"""See BzrDir.create_repository."""
1511
return self._format.repository_format.initialize(self, shared)
1513
def needs_format_conversion(self, format=None):
1514
"""Format 4 dirs are always in need of conversion."""
1516
symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1517
% 'needs_format_conversion(format=None)')
1520
def open_repository(self):
1521
"""See BzrDir.open_repository."""
1522
from bzrlib.repofmt.weaverepo import RepositoryFormat4
1523
return RepositoryFormat4().open(self, _found=True)
1526
class BzrDir5(BzrDirPreSplitOut):
1527
"""A .bzr version 5 control object.
1529
This is a deprecated format and may be removed after sept 2006.
1532
def open_repository(self):
1533
"""See BzrDir.open_repository."""
1534
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1535
return RepositoryFormat5().open(self, _found=True)
1537
def open_workingtree(self, _unsupported=False,
1538
recommend_upgrade=True):
1539
"""See BzrDir.create_workingtree."""
1540
from bzrlib.workingtree import WorkingTreeFormat2
1541
wt_format = WorkingTreeFormat2()
1542
# we don't warn here about upgrades; that ought to be handled for the
1544
return wt_format.open(self, _found=True)
1547
class BzrDir6(BzrDirPreSplitOut):
1548
"""A .bzr version 6 control object.
1550
This is a deprecated format and may be removed after sept 2006.
1553
def open_repository(self):
1554
"""See BzrDir.open_repository."""
1555
from bzrlib.repofmt.weaverepo import RepositoryFormat6
1556
return RepositoryFormat6().open(self, _found=True)
1558
def open_workingtree(self, _unsupported=False,
1559
recommend_upgrade=True):
1560
"""See BzrDir.create_workingtree."""
1561
# we don't warn here about upgrades; that ought to be handled for the
1563
from bzrlib.workingtree import WorkingTreeFormat2
1564
return WorkingTreeFormat2().open(self, _found=True)
1567
class BzrDirMeta1(BzrDir):
1568
"""A .bzr meta version 1 control object.
1570
This is the first control object where the
1571
individual aspects are really split out: there are separate repository,
1572
workingtree and branch subdirectories and any subset of the three can be
1573
present within a BzrDir.
1576
def can_convert_format(self):
1577
"""See BzrDir.can_convert_format()."""
1580
def create_branch(self):
1581
"""See BzrDir.create_branch."""
1582
return self._format.get_branch_format().initialize(self)
1584
def destroy_branch(self):
1585
"""See BzrDir.create_branch."""
1586
self.transport.delete_tree('branch')
1588
def create_repository(self, shared=False):
1589
"""See BzrDir.create_repository."""
1590
return self._format.repository_format.initialize(self, shared)
1592
def destroy_repository(self):
1593
"""See BzrDir.destroy_repository."""
1594
self.transport.delete_tree('repository')
1596
def create_workingtree(self, revision_id=None, from_branch=None,
1597
accelerator_tree=None, hardlink=False):
1598
"""See BzrDir.create_workingtree."""
1599
return self._format.workingtree_format.initialize(
1600
self, revision_id, from_branch=from_branch,
1601
accelerator_tree=accelerator_tree, hardlink=hardlink)
1603
def destroy_workingtree(self):
1604
"""See BzrDir.destroy_workingtree."""
1605
wt = self.open_workingtree(recommend_upgrade=False)
1606
repository = wt.branch.repository
1607
empty = repository.revision_tree(_mod_revision.NULL_REVISION)
1608
wt.revert(old_tree=empty)
1609
self.destroy_workingtree_metadata()
1611
def destroy_workingtree_metadata(self):
1612
self.transport.delete_tree('checkout')
1614
def find_branch_format(self):
1615
"""Find the branch 'format' for this bzrdir.
1617
This might be a synthetic object for e.g. RemoteBranch and SVN.
1619
from bzrlib.branch import BranchFormat
1620
return BranchFormat.find_format(self)
1622
def _get_mkdir_mode(self):
1623
"""Figure out the mode to use when creating a bzrdir subdir."""
1624
temp_control = lockable_files.LockableFiles(self.transport, '',
1625
lockable_files.TransportLock)
1626
return temp_control._dir_mode
1628
def get_branch_reference(self):
1629
"""See BzrDir.get_branch_reference()."""
1630
from bzrlib.branch import BranchFormat
1631
format = BranchFormat.find_format(self)
1632
return format.get_reference(self)
1634
def get_branch_transport(self, branch_format):
1635
"""See BzrDir.get_branch_transport()."""
1636
# XXX: this shouldn't implicitly create the directory if it's just
1637
# promising to get a transport -- mbp 20090727
1638
if branch_format is None:
1639
return self.transport.clone('branch')
1641
branch_format.get_format_string()
1642
except NotImplementedError:
1643
raise errors.IncompatibleFormat(branch_format, self._format)
1645
self.transport.mkdir('branch', mode=self._get_mkdir_mode())
1646
except errors.FileExists:
1648
return self.transport.clone('branch')
1650
def get_repository_transport(self, repository_format):
1651
"""See BzrDir.get_repository_transport()."""
1652
if repository_format is None:
1653
return self.transport.clone('repository')
1655
repository_format.get_format_string()
1656
except NotImplementedError:
1657
raise errors.IncompatibleFormat(repository_format, self._format)
1659
self.transport.mkdir('repository', mode=self._get_mkdir_mode())
1660
except errors.FileExists:
1662
return self.transport.clone('repository')
1664
def get_workingtree_transport(self, workingtree_format):
1665
"""See BzrDir.get_workingtree_transport()."""
1666
if workingtree_format is None:
1667
return self.transport.clone('checkout')
1669
workingtree_format.get_format_string()
1670
except NotImplementedError:
1671
raise errors.IncompatibleFormat(workingtree_format, self._format)
1673
self.transport.mkdir('checkout', mode=self._get_mkdir_mode())
1674
except errors.FileExists:
1676
return self.transport.clone('checkout')
1678
def needs_format_conversion(self, format=None):
1679
"""See BzrDir.needs_format_conversion()."""
1681
symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1682
% 'needs_format_conversion(format=None)')
1684
format = BzrDirFormat.get_default_format()
1685
if not isinstance(self._format, format.__class__):
1686
# it is not a meta dir format, conversion is needed.
1688
# we might want to push this down to the repository?
1690
if not isinstance(self.open_repository()._format,
1691
format.repository_format.__class__):
1692
# the repository needs an upgrade.
1694
except errors.NoRepositoryPresent:
1697
if not isinstance(self.open_branch()._format,
1698
format.get_branch_format().__class__):
1699
# the branch needs an upgrade.
1701
except errors.NotBranchError:
1704
my_wt = self.open_workingtree(recommend_upgrade=False)
1705
if not isinstance(my_wt._format,
1706
format.workingtree_format.__class__):
1707
# the workingtree needs an upgrade.
1709
except (errors.NoWorkingTree, errors.NotLocalUrl):
1713
def open_branch(self, unsupported=False, ignore_fallbacks=False):
1714
"""See BzrDir.open_branch."""
1715
format = self.find_branch_format()
1716
self._check_supported(format, unsupported)
1717
return format.open(self, _found=True, ignore_fallbacks=ignore_fallbacks)
1719
def open_repository(self, unsupported=False):
1720
"""See BzrDir.open_repository."""
1721
from bzrlib.repository import RepositoryFormat
1722
format = RepositoryFormat.find_format(self)
1723
self._check_supported(format, unsupported)
1724
return format.open(self, _found=True)
1726
def open_workingtree(self, unsupported=False,
1727
recommend_upgrade=True):
1728
"""See BzrDir.open_workingtree."""
1729
from bzrlib.workingtree import WorkingTreeFormat
1730
format = WorkingTreeFormat.find_format(self)
1731
self._check_supported(format, unsupported,
1733
basedir=self.root_transport.base)
1734
return format.open(self, _found=True)
1736
def _get_config(self):
1737
return config.TransportConfig(self.transport, 'control.conf')
1740
class BzrDirFormat(object):
1741
"""An encapsulation of the initialization and open routines for a format.
1743
Formats provide three things:
1744
* An initialization routine,
1748
Formats are placed in a dict by their format string for reference
1749
during bzrdir opening. These should be subclasses of BzrDirFormat
1752
Once a format is deprecated, just deprecate the initialize and open
1753
methods on the format class. Do not deprecate the object, as the
1754
object will be created every system load.
1757
_default_format = None
1758
"""The default format used for new .bzr dirs."""
1761
"""The known formats."""
1763
_control_formats = []
1764
"""The registered control formats - .bzr, ....
1766
This is a list of BzrDirFormat objects.
1769
_control_server_formats = []
1770
"""The registered control server formats, e.g. RemoteBzrDirs.
1772
This is a list of BzrDirFormat objects.
1775
_lock_file_name = 'branch-lock'
1777
# _lock_class must be set in subclasses to the lock type, typ.
1778
# TransportLock or LockDir
1781
def find_format(klass, transport, _server_formats=True):
1782
"""Return the format present at transport."""
1784
formats = klass._control_server_formats + klass._control_formats
1786
formats = klass._control_formats
1787
for format in formats:
1789
return format.probe_transport(transport)
1790
except errors.NotBranchError:
1791
# this format does not find a control dir here.
1793
raise errors.NotBranchError(path=transport.base)
1796
def probe_transport(klass, transport):
1797
"""Return the .bzrdir style format present in a directory."""
1799
format_string = transport.get(".bzr/branch-format").read()
1800
except errors.NoSuchFile:
1801
raise errors.NotBranchError(path=transport.base)
1804
return klass._formats[format_string]
1806
raise errors.UnknownFormatError(format=format_string, kind='bzrdir')
1809
def get_default_format(klass):
1810
"""Return the current default format."""
1811
return klass._default_format
1813
def get_format_string(self):
1814
"""Return the ASCII format string that identifies this format."""
1815
raise NotImplementedError(self.get_format_string)
1817
def get_format_description(self):
1818
"""Return the short description for this format."""
1819
raise NotImplementedError(self.get_format_description)
1821
def get_converter(self, format=None):
1822
"""Return the converter to use to convert bzrdirs needing converts.
1824
This returns a bzrlib.bzrdir.Converter object.
1826
This should return the best upgrader to step this format towards the
1827
current default format. In the case of plugins we can/should provide
1828
some means for them to extend the range of returnable converters.
1830
:param format: Optional format to override the default format of the
1833
raise NotImplementedError(self.get_converter)
1835
def initialize(self, url, possible_transports=None):
1836
"""Create a bzr control dir at this url and return an opened copy.
1838
While not deprecated, this method is very specific and its use will
1839
lead to many round trips to setup a working environment. See
1840
initialize_on_transport_ex for a [nearly] all-in-one method.
1842
Subclasses should typically override initialize_on_transport
1843
instead of this method.
1845
return self.initialize_on_transport(get_transport(url,
1846
possible_transports))
1848
def initialize_on_transport(self, transport):
1849
"""Initialize a new bzrdir in the base directory of a Transport."""
1851
# can we hand off the request to the smart server rather than using
1853
client_medium = transport.get_smart_medium()
1854
except errors.NoSmartMedium:
1855
return self._initialize_on_transport_vfs(transport)
1857
# Current RPC's only know how to create bzr metadir1 instances, so
1858
# we still delegate to vfs methods if the requested format is not a
1860
if type(self) != BzrDirMetaFormat1:
1861
return self._initialize_on_transport_vfs(transport)
1862
remote_format = RemoteBzrDirFormat()
1863
self._supply_sub_formats_to(remote_format)
1864
return remote_format.initialize_on_transport(transport)
1866
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
1867
create_prefix=False, force_new_repo=False, stacked_on=None,
1868
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
1869
shared_repo=False, vfs_only=False):
1870
"""Create this format on transport.
1872
The directory to initialize will be created.
1874
:param force_new_repo: Do not use a shared repository for the target,
1875
even if one is available.
1876
:param create_prefix: Create any missing directories leading up to
1878
:param use_existing_dir: Use an existing directory if one exists.
1879
:param stacked_on: A url to stack any created branch on, None to follow
1880
any target stacking policy.
1881
:param stack_on_pwd: If stack_on is relative, the location it is
1883
:param repo_format_name: If non-None, a repository will be
1884
made-or-found. Should none be found, or if force_new_repo is True
1885
the repo_format_name is used to select the format of repository to
1887
:param make_working_trees: Control the setting of make_working_trees
1888
for a new shared repository when one is made. None to use whatever
1889
default the format has.
1890
:param shared_repo: Control whether made repositories are shared or
1892
:param vfs_only: If True do not attempt to use a smart server
1893
:return: repo, bzrdir, require_stacking, repository_policy. repo is
1894
None if none was created or found, bzrdir is always valid.
1895
require_stacking is the result of examining the stacked_on
1896
parameter and any stacking policy found for the target.
1899
# Try to hand off to a smart server
1901
client_medium = transport.get_smart_medium()
1902
except errors.NoSmartMedium:
1905
# TODO: lookup the local format from a server hint.
1906
remote_dir_format = RemoteBzrDirFormat()
1907
remote_dir_format._network_name = self.network_name()
1908
self._supply_sub_formats_to(remote_dir_format)
1909
return remote_dir_format.initialize_on_transport_ex(transport,
1910
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
1911
force_new_repo=force_new_repo, stacked_on=stacked_on,
1912
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
1913
make_working_trees=make_working_trees, shared_repo=shared_repo)
1914
# XXX: Refactor the create_prefix/no_create_prefix code into a
1915
# common helper function
1916
# The destination may not exist - if so make it according to policy.
1917
def make_directory(transport):
1918
transport.mkdir('.')
1920
def redirected(transport, e, redirection_notice):
1921
note(redirection_notice)
1922
return transport._redirected_to(e.source, e.target)
1924
transport = do_catching_redirections(make_directory, transport,
1926
except errors.FileExists:
1927
if not use_existing_dir:
1929
except errors.NoSuchFile:
1930
if not create_prefix:
1932
transport.create_prefix()
1934
require_stacking = (stacked_on is not None)
1935
# Now the target directory exists, but doesn't have a .bzr
1936
# directory. So we need to create it, along with any work to create
1937
# all of the dependent branches, etc.
1939
result = self.initialize_on_transport(transport)
1940
if repo_format_name:
1942
# use a custom format
1943
result._format.repository_format = \
1944
repository.network_format_registry.get(repo_format_name)
1945
except AttributeError:
1946
# The format didn't permit it to be set.
1948
# A repository is desired, either in-place or shared.
1949
repository_policy = result.determine_repository_policy(
1950
force_new_repo, stacked_on, stack_on_pwd,
1951
require_stacking=require_stacking)
1952
result_repo, is_new_repo = repository_policy.acquire_repository(
1953
make_working_trees, shared_repo)
1954
if not require_stacking and repository_policy._require_stacking:
1955
require_stacking = True
1956
result._format.require_stacking()
1957
result_repo.lock_write()
1960
repository_policy = None
1961
return result_repo, result, require_stacking, repository_policy
1963
def _initialize_on_transport_vfs(self, transport):
1964
"""Initialize a new bzrdir using VFS calls.
1966
:param transport: The transport to create the .bzr directory in.
1969
# Since we are creating a .bzr directory, inherit the
1970
# mode from the root directory
1971
temp_control = lockable_files.LockableFiles(transport,
1972
'', lockable_files.TransportLock)
1973
temp_control._transport.mkdir('.bzr',
1974
# FIXME: RBC 20060121 don't peek under
1976
mode=temp_control._dir_mode)
1977
if sys.platform == 'win32' and isinstance(transport, local.LocalTransport):
1978
win32utils.set_file_attr_hidden(transport._abspath('.bzr'))
1979
file_mode = temp_control._file_mode
1981
bzrdir_transport = transport.clone('.bzr')
1982
utf8_files = [('README',
1983
"This is a Bazaar control directory.\n"
1984
"Do not change any files in this directory.\n"
1985
"See http://bazaar-vcs.org/ for more information about Bazaar.\n"),
1986
('branch-format', self.get_format_string()),
1988
# NB: no need to escape relative paths that are url safe.
1989
control_files = lockable_files.LockableFiles(bzrdir_transport,
1990
self._lock_file_name, self._lock_class)
1991
control_files.create_lock()
1992
control_files.lock_write()
1994
for (filename, content) in utf8_files:
1995
bzrdir_transport.put_bytes(filename, content,
1998
control_files.unlock()
1999
return self.open(transport, _found=True)
2001
def is_supported(self):
2002
"""Is this format supported?
2004
Supported formats must be initializable and openable.
2005
Unsupported formats may not support initialization or committing or
2006
some other features depending on the reason for not being supported.
2010
def network_name(self):
2011
"""A simple byte string uniquely identifying this format for RPC calls.
2013
Bzr control formats use thir disk format string to identify the format
2014
over the wire. Its possible that other control formats have more
2015
complex detection requirements, so we permit them to use any unique and
2016
immutable string they desire.
2018
raise NotImplementedError(self.network_name)
2020
def same_model(self, target_format):
2021
return (self.repository_format.rich_root_data ==
2022
target_format.rich_root_data)
2025
def known_formats(klass):
2026
"""Return all the known formats.
2028
Concrete formats should override _known_formats.
2030
# There is double indirection here to make sure that control
2031
# formats used by more than one dir format will only be probed
2032
# once. This can otherwise be quite expensive for remote connections.
2034
for format in klass._control_formats:
2035
result.update(format._known_formats())
2039
def _known_formats(klass):
2040
"""Return the known format instances for this control format."""
2041
return set(klass._formats.values())
2043
def open(self, transport, _found=False):
2044
"""Return an instance of this format for the dir transport points at.
2046
_found is a private parameter, do not use it.
2049
found_format = BzrDirFormat.find_format(transport)
2050
if not isinstance(found_format, self.__class__):
2051
raise AssertionError("%s was asked to open %s, but it seems to need "
2053
% (self, transport, found_format))
2054
# Allow subclasses - use the found format.
2055
self._supply_sub_formats_to(found_format)
2056
return found_format._open(transport)
2057
return self._open(transport)
2059
def _open(self, transport):
2060
"""Template method helper for opening BzrDirectories.
2062
This performs the actual open and any additional logic or parameter
2065
raise NotImplementedError(self._open)
2068
def register_format(klass, format):
2069
klass._formats[format.get_format_string()] = format
2070
# bzr native formats have a network name of their format string.
2071
network_format_registry.register(format.get_format_string(), format.__class__)
2074
def register_control_format(klass, format):
2075
"""Register a format that does not use '.bzr' for its control dir.
2077
TODO: This should be pulled up into a 'ControlDirFormat' base class
2078
which BzrDirFormat can inherit from, and renamed to register_format
2079
there. It has been done without that for now for simplicity of
2082
klass._control_formats.append(format)
2085
def register_control_server_format(klass, format):
2086
"""Register a control format for client-server environments.
2088
These formats will be tried before ones registered with
2089
register_control_format. This gives implementations that decide to the
2090
chance to grab it before anything looks at the contents of the format
2093
klass._control_server_formats.append(format)
2096
def _set_default_format(klass, format):
2097
"""Set default format (for testing behavior of defaults only)"""
2098
klass._default_format = format
2102
return self.get_format_description().rstrip()
2104
def _supply_sub_formats_to(self, other_format):
2105
"""Give other_format the same values for sub formats as this has.
2107
This method is expected to be used when parameterising a
2108
RemoteBzrDirFormat instance with the parameters from a
2109
BzrDirMetaFormat1 instance.
2111
:param other_format: other_format is a format which should be
2112
compatible with whatever sub formats are supported by self.
2117
def unregister_format(klass, format):
2118
del klass._formats[format.get_format_string()]
2121
def unregister_control_format(klass, format):
2122
klass._control_formats.remove(format)
2125
class BzrDirFormat4(BzrDirFormat):
2126
"""Bzr dir format 4.
2128
This format is a combined format for working tree, branch and repository.
2130
- Format 1 working trees [always]
2131
- Format 4 branches [always]
2132
- Format 4 repositories [always]
2134
This format is deprecated: it indexes texts using a text it which is
2135
removed in format 5; write support for this format has been removed.
2138
_lock_class = lockable_files.TransportLock
2140
def get_format_string(self):
2141
"""See BzrDirFormat.get_format_string()."""
2142
return "Bazaar-NG branch, format 0.0.4\n"
2144
def get_format_description(self):
2145
"""See BzrDirFormat.get_format_description()."""
2146
return "All-in-one format 4"
2148
def get_converter(self, format=None):
2149
"""See BzrDirFormat.get_converter()."""
2150
# there is one and only one upgrade path here.
2151
return ConvertBzrDir4To5()
2153
def initialize_on_transport(self, transport):
2154
"""Format 4 branches cannot be created."""
2155
raise errors.UninitializableFormat(self)
2157
def is_supported(self):
2158
"""Format 4 is not supported.
2160
It is not supported because the model changed from 4 to 5 and the
2161
conversion logic is expensive - so doing it on the fly was not
2166
def network_name(self):
2167
return self.get_format_string()
2169
def _open(self, transport):
2170
"""See BzrDirFormat._open."""
2171
return BzrDir4(transport, self)
2173
def __return_repository_format(self):
2174
"""Circular import protection."""
2175
from bzrlib.repofmt.weaverepo import RepositoryFormat4
2176
return RepositoryFormat4()
2177
repository_format = property(__return_repository_format)
2180
class BzrDirFormatAllInOne(BzrDirFormat):
2181
"""Common class for formats before meta-dirs."""
2183
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
2184
create_prefix=False, force_new_repo=False, stacked_on=None,
2185
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
2187
"""See BzrDirFormat.initialize_on_transport_ex."""
2188
require_stacking = (stacked_on is not None)
2189
# Format 5 cannot stack, but we've been asked to - actually init
2191
if require_stacking:
2192
format = BzrDirMetaFormat1()
2193
return format.initialize_on_transport_ex(transport,
2194
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2195
force_new_repo=force_new_repo, stacked_on=stacked_on,
2196
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2197
make_working_trees=make_working_trees, shared_repo=shared_repo)
2198
return BzrDirFormat.initialize_on_transport_ex(self, transport,
2199
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2200
force_new_repo=force_new_repo, stacked_on=stacked_on,
2201
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2202
make_working_trees=make_working_trees, shared_repo=shared_repo)
2205
class BzrDirFormat5(BzrDirFormatAllInOne):
2206
"""Bzr control format 5.
2208
This format is a combined format for working tree, branch and repository.
2210
- Format 2 working trees [always]
2211
- Format 4 branches [always]
2212
- Format 5 repositories [always]
2213
Unhashed stores in the repository.
2216
_lock_class = lockable_files.TransportLock
2218
def get_format_string(self):
2219
"""See BzrDirFormat.get_format_string()."""
2220
return "Bazaar-NG branch, format 5\n"
2222
def get_branch_format(self):
2223
from bzrlib import branch
2224
return branch.BzrBranchFormat4()
2226
def get_format_description(self):
2227
"""See BzrDirFormat.get_format_description()."""
2228
return "All-in-one format 5"
2230
def get_converter(self, format=None):
2231
"""See BzrDirFormat.get_converter()."""
2232
# there is one and only one upgrade path here.
2233
return ConvertBzrDir5To6()
2235
def _initialize_for_clone(self, url):
2236
return self.initialize_on_transport(get_transport(url), _cloning=True)
2238
def initialize_on_transport(self, transport, _cloning=False):
2239
"""Format 5 dirs always have working tree, branch and repository.
2241
Except when they are being cloned.
2243
from bzrlib.branch import BzrBranchFormat4
2244
from bzrlib.repofmt.weaverepo import RepositoryFormat5
2245
result = (super(BzrDirFormat5, self).initialize_on_transport(transport))
2246
RepositoryFormat5().initialize(result, _internal=True)
2248
branch = BzrBranchFormat4().initialize(result)
2249
result._init_workingtree()
2252
def network_name(self):
2253
return self.get_format_string()
2255
def _open(self, transport):
2256
"""See BzrDirFormat._open."""
2257
return BzrDir5(transport, self)
2259
def __return_repository_format(self):
2260
"""Circular import protection."""
2261
from bzrlib.repofmt.weaverepo import RepositoryFormat5
2262
return RepositoryFormat5()
2263
repository_format = property(__return_repository_format)
2266
class BzrDirFormat6(BzrDirFormatAllInOne):
2267
"""Bzr control format 6.
2269
This format is a combined format for working tree, branch and repository.
2271
- Format 2 working trees [always]
2272
- Format 4 branches [always]
2273
- Format 6 repositories [always]
2276
_lock_class = lockable_files.TransportLock
2278
def get_format_string(self):
2279
"""See BzrDirFormat.get_format_string()."""
2280
return "Bazaar-NG branch, format 6\n"
2282
def get_format_description(self):
2283
"""See BzrDirFormat.get_format_description()."""
2284
return "All-in-one format 6"
2286
def get_branch_format(self):
2287
from bzrlib import branch
2288
return branch.BzrBranchFormat4()
2290
def get_converter(self, format=None):
2291
"""See BzrDirFormat.get_converter()."""
2292
# there is one and only one upgrade path here.
2293
return ConvertBzrDir6ToMeta()
2295
def _initialize_for_clone(self, url):
2296
return self.initialize_on_transport(get_transport(url), _cloning=True)
2298
def initialize_on_transport(self, transport, _cloning=False):
2299
"""Format 6 dirs always have working tree, branch and repository.
2301
Except when they are being cloned.
2303
from bzrlib.branch import BzrBranchFormat4
2304
from bzrlib.repofmt.weaverepo import RepositoryFormat6
2305
result = super(BzrDirFormat6, self).initialize_on_transport(transport)
2306
RepositoryFormat6().initialize(result, _internal=True)
2308
branch = BzrBranchFormat4().initialize(result)
2309
result._init_workingtree()
2312
def network_name(self):
2313
return self.get_format_string()
2315
def _open(self, transport):
2316
"""See BzrDirFormat._open."""
2317
return BzrDir6(transport, self)
2319
def __return_repository_format(self):
2320
"""Circular import protection."""
2321
from bzrlib.repofmt.weaverepo import RepositoryFormat6
2322
return RepositoryFormat6()
2323
repository_format = property(__return_repository_format)
2326
class BzrDirMetaFormat1(BzrDirFormat):
2327
"""Bzr meta control format 1
2329
This is the first format with split out working tree, branch and repository
2332
- Format 3 working trees [optional]
2333
- Format 5 branches [optional]
2334
- Format 7 repositories [optional]
2337
_lock_class = lockdir.LockDir
2340
self._workingtree_format = None
2341
self._branch_format = None
2342
self._repository_format = None
2344
def __eq__(self, other):
2345
if other.__class__ is not self.__class__:
2347
if other.repository_format != self.repository_format:
2349
if other.workingtree_format != self.workingtree_format:
2353
def __ne__(self, other):
2354
return not self == other
2356
def get_branch_format(self):
2357
if self._branch_format is None:
2358
from bzrlib.branch import BranchFormat
2359
self._branch_format = BranchFormat.get_default_format()
2360
return self._branch_format
2362
def set_branch_format(self, format):
2363
self._branch_format = format
2365
def require_stacking(self, stack_on=None, possible_transports=None,
2367
"""We have a request to stack, try to ensure the formats support it.
2369
:param stack_on: If supplied, it is the URL to a branch that we want to
2370
stack on. Check to see if that format supports stacking before
2373
# Stacking is desired. requested by the target, but does the place it
2374
# points at support stacking? If it doesn't then we should
2375
# not implicitly upgrade. We check this here.
2376
new_repo_format = None
2377
new_branch_format = None
2379
# a bit of state for get_target_branch so that we don't try to open it
2380
# 2 times, for both repo *and* branch
2381
target = [None, False, None] # target_branch, checked, upgrade anyway
2382
def get_target_branch():
2384
# We've checked, don't check again
2386
if stack_on is None:
2387
# No target format, that means we want to force upgrading
2388
target[:] = [None, True, True]
2391
target_dir = BzrDir.open(stack_on,
2392
possible_transports=possible_transports)
2393
except errors.NotBranchError:
2394
# Nothing there, don't change formats
2395
target[:] = [None, True, False]
2397
except errors.JailBreak:
2398
# JailBreak, JFDI and upgrade anyway
2399
target[:] = [None, True, True]
2402
target_branch = target_dir.open_branch()
2403
except errors.NotBranchError:
2404
# No branch, don't upgrade formats
2405
target[:] = [None, True, False]
2407
target[:] = [target_branch, True, False]
2410
if (not _skip_repo and
2411
not self.repository_format.supports_external_lookups):
2412
# We need to upgrade the Repository.
2413
target_branch, _, do_upgrade = get_target_branch()
2414
if target_branch is None:
2415
# We don't have a target branch, should we upgrade anyway?
2417
# stack_on is inaccessible, JFDI.
2418
# TODO: bad monkey, hard-coded formats...
2419
if self.repository_format.rich_root_data:
2420
new_repo_format = pack_repo.RepositoryFormatKnitPack5RichRoot()
2422
new_repo_format = pack_repo.RepositoryFormatKnitPack5()
2424
# If the target already supports stacking, then we know the
2425
# project is already able to use stacking, so auto-upgrade
2427
new_repo_format = target_branch.repository._format
2428
if not new_repo_format.supports_external_lookups:
2429
# target doesn't, source doesn't, so don't auto upgrade
2431
new_repo_format = None
2432
if new_repo_format is not None:
2433
self.repository_format = new_repo_format
2434
note('Source repository format does not support stacking,'
2435
' using format:\n %s',
2436
new_repo_format.get_format_description())
2438
if not self.get_branch_format().supports_stacking():
2439
# We just checked the repo, now lets check if we need to
2440
# upgrade the branch format
2441
target_branch, _, do_upgrade = get_target_branch()
2442
if target_branch is None:
2444
# TODO: bad monkey, hard-coded formats...
2445
new_branch_format = branch.BzrBranchFormat7()
2447
new_branch_format = target_branch._format
2448
if not new_branch_format.supports_stacking():
2449
new_branch_format = None
2450
if new_branch_format is not None:
2451
# Does support stacking, use its format.
2452
self.set_branch_format(new_branch_format)
2453
note('Source branch format does not support stacking,'
2454
' using format:\n %s',
2455
new_branch_format.get_format_description())
2457
def get_converter(self, format=None):
2458
"""See BzrDirFormat.get_converter()."""
2460
format = BzrDirFormat.get_default_format()
2461
if not isinstance(self, format.__class__):
2462
# converting away from metadir is not implemented
2463
raise NotImplementedError(self.get_converter)
2464
return ConvertMetaToMeta(format)
2466
def get_format_string(self):
2467
"""See BzrDirFormat.get_format_string()."""
2468
return "Bazaar-NG meta directory, format 1\n"
2470
def get_format_description(self):
2471
"""See BzrDirFormat.get_format_description()."""
2472
return "Meta directory format 1"
2474
def network_name(self):
2475
return self.get_format_string()
2477
def _open(self, transport):
2478
"""See BzrDirFormat._open."""
2479
# Create a new format instance because otherwise initialisation of new
2480
# metadirs share the global default format object leading to alias
2482
format = BzrDirMetaFormat1()
2483
self._supply_sub_formats_to(format)
2484
return BzrDirMeta1(transport, format)
2486
def __return_repository_format(self):
2487
"""Circular import protection."""
2488
if self._repository_format:
2489
return self._repository_format
2490
from bzrlib.repository import RepositoryFormat
2491
return RepositoryFormat.get_default_format()
2493
def _set_repository_format(self, value):
2494
"""Allow changing the repository format for metadir formats."""
2495
self._repository_format = value
2497
repository_format = property(__return_repository_format,
2498
_set_repository_format)
2500
def _supply_sub_formats_to(self, other_format):
2501
"""Give other_format the same values for sub formats as this has.
2503
This method is expected to be used when parameterising a
2504
RemoteBzrDirFormat instance with the parameters from a
2505
BzrDirMetaFormat1 instance.
2507
:param other_format: other_format is a format which should be
2508
compatible with whatever sub formats are supported by self.
2511
if getattr(self, '_repository_format', None) is not None:
2512
other_format.repository_format = self.repository_format
2513
if self._branch_format is not None:
2514
other_format._branch_format = self._branch_format
2515
if self._workingtree_format is not None:
2516
other_format.workingtree_format = self.workingtree_format
2518
def __get_workingtree_format(self):
2519
if self._workingtree_format is None:
2520
from bzrlib.workingtree import WorkingTreeFormat
2521
self._workingtree_format = WorkingTreeFormat.get_default_format()
2522
return self._workingtree_format
2524
def __set_workingtree_format(self, wt_format):
2525
self._workingtree_format = wt_format
2527
workingtree_format = property(__get_workingtree_format,
2528
__set_workingtree_format)
2531
network_format_registry = registry.FormatRegistry()
2532
"""Registry of formats indexed by their network name.
2534
The network name for a BzrDirFormat is an identifier that can be used when
2535
referring to formats with smart server operations. See
2536
BzrDirFormat.network_name() for more detail.
2540
# Register bzr control format
2541
BzrDirFormat.register_control_format(BzrDirFormat)
2543
# Register bzr formats
2544
BzrDirFormat.register_format(BzrDirFormat4())
2545
BzrDirFormat.register_format(BzrDirFormat5())
2546
BzrDirFormat.register_format(BzrDirFormat6())
2547
__default_format = BzrDirMetaFormat1()
2548
BzrDirFormat.register_format(__default_format)
2549
BzrDirFormat._default_format = __default_format
2552
class Converter(object):
2553
"""Converts a disk format object from one format to another."""
2555
def convert(self, to_convert, pb):
2556
"""Perform the conversion of to_convert, giving feedback via pb.
2558
:param to_convert: The disk object to convert.
2559
:param pb: a progress bar to use for progress information.
2562
def step(self, message):
2563
"""Update the pb by a step."""
2565
self.pb.update(message, self.count, self.total)
2568
class ConvertBzrDir4To5(Converter):
2569
"""Converts format 4 bzr dirs to format 5."""
2572
super(ConvertBzrDir4To5, self).__init__()
2573
self.converted_revs = set()
2574
self.absent_revisions = set()
2578
def convert(self, to_convert, pb):
2579
"""See Converter.convert()."""
2580
self.bzrdir = to_convert
2582
self.pb.note('starting upgrade from format 4 to 5')
2583
if isinstance(self.bzrdir.transport, local.LocalTransport):
2584
self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
2585
self._convert_to_weaves()
2586
return BzrDir.open(self.bzrdir.root_transport.base)
2588
def _convert_to_weaves(self):
2589
self.pb.note('note: upgrade may be faster if all store files are ungzipped first')
2592
stat = self.bzrdir.transport.stat('weaves')
2593
if not S_ISDIR(stat.st_mode):
2594
self.bzrdir.transport.delete('weaves')
2595
self.bzrdir.transport.mkdir('weaves')
2596
except errors.NoSuchFile:
2597
self.bzrdir.transport.mkdir('weaves')
2598
# deliberately not a WeaveFile as we want to build it up slowly.
2599
self.inv_weave = Weave('inventory')
2600
# holds in-memory weaves for all files
2601
self.text_weaves = {}
2602
self.bzrdir.transport.delete('branch-format')
2603
self.branch = self.bzrdir.open_branch()
2604
self._convert_working_inv()
2605
rev_history = self.branch.revision_history()
2606
# to_read is a stack holding the revisions we still need to process;
2607
# appending to it adds new highest-priority revisions
2608
self.known_revisions = set(rev_history)
2609
self.to_read = rev_history[-1:]
2611
rev_id = self.to_read.pop()
2612
if (rev_id not in self.revisions
2613
and rev_id not in self.absent_revisions):
2614
self._load_one_rev(rev_id)
2616
to_import = self._make_order()
2617
for i, rev_id in enumerate(to_import):
2618
self.pb.update('converting revision', i, len(to_import))
2619
self._convert_one_rev(rev_id)
2621
self._write_all_weaves()
2622
self._write_all_revs()
2623
self.pb.note('upgraded to weaves:')
2624
self.pb.note(' %6d revisions and inventories', len(self.revisions))
2625
self.pb.note(' %6d revisions not present', len(self.absent_revisions))
2626
self.pb.note(' %6d texts', self.text_count)
2627
self._cleanup_spare_files_after_format4()
2628
self.branch._transport.put_bytes(
2630
BzrDirFormat5().get_format_string(),
2631
mode=self.bzrdir._get_file_mode())
2633
def _cleanup_spare_files_after_format4(self):
2634
# FIXME working tree upgrade foo.
2635
for n in 'merged-patches', 'pending-merged-patches':
2637
## assert os.path.getsize(p) == 0
2638
self.bzrdir.transport.delete(n)
2639
except errors.NoSuchFile:
2641
self.bzrdir.transport.delete_tree('inventory-store')
2642
self.bzrdir.transport.delete_tree('text-store')
2644
def _convert_working_inv(self):
2645
inv = xml4.serializer_v4.read_inventory(
2646
self.branch._transport.get('inventory'))
2647
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv, working=True)
2648
self.branch._transport.put_bytes('inventory', new_inv_xml,
2649
mode=self.bzrdir._get_file_mode())
2651
def _write_all_weaves(self):
2652
controlweaves = WeaveStore(self.bzrdir.transport, prefixed=False)
2653
weave_transport = self.bzrdir.transport.clone('weaves')
2654
weaves = WeaveStore(weave_transport, prefixed=False)
2655
transaction = WriteTransaction()
2659
for file_id, file_weave in self.text_weaves.items():
2660
self.pb.update('writing weave', i, len(self.text_weaves))
2661
weaves._put_weave(file_id, file_weave, transaction)
2663
self.pb.update('inventory', 0, 1)
2664
controlweaves._put_weave('inventory', self.inv_weave, transaction)
2665
self.pb.update('inventory', 1, 1)
2669
def _write_all_revs(self):
2670
"""Write all revisions out in new form."""
2671
self.bzrdir.transport.delete_tree('revision-store')
2672
self.bzrdir.transport.mkdir('revision-store')
2673
revision_transport = self.bzrdir.transport.clone('revision-store')
2675
from bzrlib.xml5 import serializer_v5
2676
from bzrlib.repofmt.weaverepo import RevisionTextStore
2677
revision_store = RevisionTextStore(revision_transport,
2678
serializer_v5, False, versionedfile.PrefixMapper(),
2679
lambda:True, lambda:True)
2681
for i, rev_id in enumerate(self.converted_revs):
2682
self.pb.update('write revision', i, len(self.converted_revs))
2683
text = serializer_v5.write_revision_to_string(
2684
self.revisions[rev_id])
2686
revision_store.add_lines(key, None, osutils.split_lines(text))
2690
def _load_one_rev(self, rev_id):
2691
"""Load a revision object into memory.
2693
Any parents not either loaded or abandoned get queued to be
2695
self.pb.update('loading revision',
2696
len(self.revisions),
2697
len(self.known_revisions))
2698
if not self.branch.repository.has_revision(rev_id):
2700
self.pb.note('revision {%s} not present in branch; '
2701
'will be converted as a ghost',
2703
self.absent_revisions.add(rev_id)
2705
rev = self.branch.repository.get_revision(rev_id)
2706
for parent_id in rev.parent_ids:
2707
self.known_revisions.add(parent_id)
2708
self.to_read.append(parent_id)
2709
self.revisions[rev_id] = rev
2711
def _load_old_inventory(self, rev_id):
2712
old_inv_xml = self.branch.repository.inventory_store.get(rev_id).read()
2713
inv = xml4.serializer_v4.read_inventory_from_string(old_inv_xml)
2714
inv.revision_id = rev_id
2715
rev = self.revisions[rev_id]
2718
def _load_updated_inventory(self, rev_id):
2719
inv_xml = self.inv_weave.get_text(rev_id)
2720
inv = xml5.serializer_v5.read_inventory_from_string(inv_xml, rev_id)
2723
def _convert_one_rev(self, rev_id):
2724
"""Convert revision and all referenced objects to new format."""
2725
rev = self.revisions[rev_id]
2726
inv = self._load_old_inventory(rev_id)
2727
present_parents = [p for p in rev.parent_ids
2728
if p not in self.absent_revisions]
2729
self._convert_revision_contents(rev, inv, present_parents)
2730
self._store_new_inv(rev, inv, present_parents)
2731
self.converted_revs.add(rev_id)
2733
def _store_new_inv(self, rev, inv, present_parents):
2734
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
2735
new_inv_sha1 = sha_string(new_inv_xml)
2736
self.inv_weave.add_lines(rev.revision_id,
2738
new_inv_xml.splitlines(True))
2739
rev.inventory_sha1 = new_inv_sha1
2741
def _convert_revision_contents(self, rev, inv, present_parents):
2742
"""Convert all the files within a revision.
2744
Also upgrade the inventory to refer to the text revision ids."""
2745
rev_id = rev.revision_id
2746
mutter('converting texts of revision {%s}',
2748
parent_invs = map(self._load_updated_inventory, present_parents)
2749
entries = inv.iter_entries()
2751
for path, ie in entries:
2752
self._convert_file_version(rev, ie, parent_invs)
2754
def _convert_file_version(self, rev, ie, parent_invs):
2755
"""Convert one version of one file.
2757
The file needs to be added into the weave if it is a merge
2758
of >=2 parents or if it's changed from its parent.
2760
file_id = ie.file_id
2761
rev_id = rev.revision_id
2762
w = self.text_weaves.get(file_id)
2765
self.text_weaves[file_id] = w
2766
text_changed = False
2767
parent_candiate_entries = ie.parent_candidates(parent_invs)
2768
heads = graph.Graph(self).heads(parent_candiate_entries.keys())
2769
# XXX: Note that this is unordered - and this is tolerable because
2770
# the previous code was also unordered.
2771
previous_entries = dict((head, parent_candiate_entries[head]) for head
2773
self.snapshot_ie(previous_entries, ie, w, rev_id)
2776
def get_parent_map(self, revision_ids):
2777
"""See graph.StackedParentsProvider.get_parent_map"""
2778
return dict((revision_id, self.revisions[revision_id])
2779
for revision_id in revision_ids
2780
if revision_id in self.revisions)
2782
def snapshot_ie(self, previous_revisions, ie, w, rev_id):
2783
# TODO: convert this logic, which is ~= snapshot to
2784
# a call to:. This needs the path figured out. rather than a work_tree
2785
# a v4 revision_tree can be given, or something that looks enough like
2786
# one to give the file content to the entry if it needs it.
2787
# and we need something that looks like a weave store for snapshot to
2789
#ie.snapshot(rev, PATH, previous_revisions, REVISION_TREE, InMemoryWeaveStore(self.text_weaves))
2790
if len(previous_revisions) == 1:
2791
previous_ie = previous_revisions.values()[0]
2792
if ie._unchanged(previous_ie):
2793
ie.revision = previous_ie.revision
2796
text = self.branch.repository._text_store.get(ie.text_id)
2797
file_lines = text.readlines()
2798
w.add_lines(rev_id, previous_revisions, file_lines)
2799
self.text_count += 1
2801
w.add_lines(rev_id, previous_revisions, [])
2802
ie.revision = rev_id
2804
def _make_order(self):
2805
"""Return a suitable order for importing revisions.
2807
The order must be such that an revision is imported after all
2808
its (present) parents.
2810
todo = set(self.revisions.keys())
2811
done = self.absent_revisions.copy()
2814
# scan through looking for a revision whose parents
2816
for rev_id in sorted(list(todo)):
2817
rev = self.revisions[rev_id]
2818
parent_ids = set(rev.parent_ids)
2819
if parent_ids.issubset(done):
2820
# can take this one now
2821
order.append(rev_id)
2827
class ConvertBzrDir5To6(Converter):
2828
"""Converts format 5 bzr dirs to format 6."""
2830
def convert(self, to_convert, pb):
2831
"""See Converter.convert()."""
2832
self.bzrdir = to_convert
2834
self.pb.note('starting upgrade from format 5 to 6')
2835
self._convert_to_prefixed()
2836
return BzrDir.open(self.bzrdir.root_transport.base)
2838
def _convert_to_prefixed(self):
2839
from bzrlib.store import TransportStore
2840
self.bzrdir.transport.delete('branch-format')
2841
for store_name in ["weaves", "revision-store"]:
2842
self.pb.note("adding prefixes to %s" % store_name)
2843
store_transport = self.bzrdir.transport.clone(store_name)
2844
store = TransportStore(store_transport, prefixed=True)
2845
for urlfilename in store_transport.list_dir('.'):
2846
filename = urlutils.unescape(urlfilename)
2847
if (filename.endswith(".weave") or
2848
filename.endswith(".gz") or
2849
filename.endswith(".sig")):
2850
file_id, suffix = os.path.splitext(filename)
2854
new_name = store._mapper.map((file_id,)) + suffix
2855
# FIXME keep track of the dirs made RBC 20060121
2857
store_transport.move(filename, new_name)
2858
except errors.NoSuchFile: # catches missing dirs strangely enough
2859
store_transport.mkdir(osutils.dirname(new_name))
2860
store_transport.move(filename, new_name)
2861
self.bzrdir.transport.put_bytes(
2863
BzrDirFormat6().get_format_string(),
2864
mode=self.bzrdir._get_file_mode())
2867
class ConvertBzrDir6ToMeta(Converter):
2868
"""Converts format 6 bzr dirs to metadirs."""
2870
def convert(self, to_convert, pb):
2871
"""See Converter.convert()."""
2872
from bzrlib.repofmt.weaverepo import RepositoryFormat7
2873
from bzrlib.branch import BzrBranchFormat5
2874
self.bzrdir = to_convert
2877
self.total = 20 # the steps we know about
2878
self.garbage_inventories = []
2879
self.dir_mode = self.bzrdir._get_dir_mode()
2880
self.file_mode = self.bzrdir._get_file_mode()
2882
self.pb.note('starting upgrade from format 6 to metadir')
2883
self.bzrdir.transport.put_bytes(
2885
"Converting to format 6",
2886
mode=self.file_mode)
2887
# its faster to move specific files around than to open and use the apis...
2888
# first off, nuke ancestry.weave, it was never used.
2890
self.step('Removing ancestry.weave')
2891
self.bzrdir.transport.delete('ancestry.weave')
2892
except errors.NoSuchFile:
2894
# find out whats there
2895
self.step('Finding branch files')
2896
last_revision = self.bzrdir.open_branch().last_revision()
2897
bzrcontents = self.bzrdir.transport.list_dir('.')
2898
for name in bzrcontents:
2899
if name.startswith('basis-inventory.'):
2900
self.garbage_inventories.append(name)
2901
# create new directories for repository, working tree and branch
2902
repository_names = [('inventory.weave', True),
2903
('revision-store', True),
2905
self.step('Upgrading repository ')
2906
self.bzrdir.transport.mkdir('repository', mode=self.dir_mode)
2907
self.make_lock('repository')
2908
# we hard code the formats here because we are converting into
2909
# the meta format. The meta format upgrader can take this to a
2910
# future format within each component.
2911
self.put_format('repository', RepositoryFormat7())
2912
for entry in repository_names:
2913
self.move_entry('repository', entry)
2915
self.step('Upgrading branch ')
2916
self.bzrdir.transport.mkdir('branch', mode=self.dir_mode)
2917
self.make_lock('branch')
2918
self.put_format('branch', BzrBranchFormat5())
2919
branch_files = [('revision-history', True),
2920
('branch-name', True),
2922
for entry in branch_files:
2923
self.move_entry('branch', entry)
2925
checkout_files = [('pending-merges', True),
2926
('inventory', True),
2927
('stat-cache', False)]
2928
# If a mandatory checkout file is not present, the branch does not have
2929
# a functional checkout. Do not create a checkout in the converted
2931
for name, mandatory in checkout_files:
2932
if mandatory and name not in bzrcontents:
2933
has_checkout = False
2937
if not has_checkout:
2938
self.pb.note('No working tree.')
2939
# If some checkout files are there, we may as well get rid of them.
2940
for name, mandatory in checkout_files:
2941
if name in bzrcontents:
2942
self.bzrdir.transport.delete(name)
2944
from bzrlib.workingtree import WorkingTreeFormat3
2945
self.step('Upgrading working tree')
2946
self.bzrdir.transport.mkdir('checkout', mode=self.dir_mode)
2947
self.make_lock('checkout')
2949
'checkout', WorkingTreeFormat3())
2950
self.bzrdir.transport.delete_multi(
2951
self.garbage_inventories, self.pb)
2952
for entry in checkout_files:
2953
self.move_entry('checkout', entry)
2954
if last_revision is not None:
2955
self.bzrdir.transport.put_bytes(
2956
'checkout/last-revision', last_revision)
2957
self.bzrdir.transport.put_bytes(
2959
BzrDirMetaFormat1().get_format_string(),
2960
mode=self.file_mode)
2961
return BzrDir.open(self.bzrdir.root_transport.base)
2963
def make_lock(self, name):
2964
"""Make a lock for the new control dir name."""
2965
self.step('Make %s lock' % name)
2966
ld = lockdir.LockDir(self.bzrdir.transport,
2968
file_modebits=self.file_mode,
2969
dir_modebits=self.dir_mode)
2972
def move_entry(self, new_dir, entry):
2973
"""Move then entry name into new_dir."""
2975
mandatory = entry[1]
2976
self.step('Moving %s' % name)
2978
self.bzrdir.transport.move(name, '%s/%s' % (new_dir, name))
2979
except errors.NoSuchFile:
2983
def put_format(self, dirname, format):
2984
self.bzrdir.transport.put_bytes('%s/format' % dirname,
2985
format.get_format_string(),
2989
class ConvertMetaToMeta(Converter):
2990
"""Converts the components of metadirs."""
2992
def __init__(self, target_format):
2993
"""Create a metadir to metadir converter.
2995
:param target_format: The final metadir format that is desired.
2997
self.target_format = target_format
2999
def convert(self, to_convert, pb):
3000
"""See Converter.convert()."""
3001
self.bzrdir = to_convert
3005
self.step('checking repository format')
3007
repo = self.bzrdir.open_repository()
3008
except errors.NoRepositoryPresent:
3011
if not isinstance(repo._format, self.target_format.repository_format.__class__):
3012
from bzrlib.repository import CopyConverter
3013
self.pb.note('starting repository conversion')
3014
converter = CopyConverter(self.target_format.repository_format)
3015
converter.convert(repo, pb)
3017
branch = self.bzrdir.open_branch()
3018
except errors.NotBranchError:
3021
# TODO: conversions of Branch and Tree should be done by
3022
# InterXFormat lookups/some sort of registry.
3023
# Avoid circular imports
3024
from bzrlib import branch as _mod_branch
3025
old = branch._format.__class__
3026
new = self.target_format.get_branch_format().__class__
3028
if (old == _mod_branch.BzrBranchFormat5 and
3029
new in (_mod_branch.BzrBranchFormat6,
3030
_mod_branch.BzrBranchFormat7,
3031
_mod_branch.BzrBranchFormat8)):
3032
branch_converter = _mod_branch.Converter5to6()
3033
elif (old == _mod_branch.BzrBranchFormat6 and
3034
new in (_mod_branch.BzrBranchFormat7,
3035
_mod_branch.BzrBranchFormat8)):
3036
branch_converter = _mod_branch.Converter6to7()
3037
elif (old == _mod_branch.BzrBranchFormat7 and
3038
new is _mod_branch.BzrBranchFormat8):
3039
branch_converter = _mod_branch.Converter7to8()
3041
raise errors.BadConversionTarget("No converter", new,
3043
branch_converter.convert(branch)
3044
branch = self.bzrdir.open_branch()
3045
old = branch._format.__class__
3047
tree = self.bzrdir.open_workingtree(recommend_upgrade=False)
3048
except (errors.NoWorkingTree, errors.NotLocalUrl):
3051
# TODO: conversions of Branch and Tree should be done by
3052
# InterXFormat lookups
3053
if (isinstance(tree, workingtree.WorkingTree3) and
3054
not isinstance(tree, workingtree_4.DirStateWorkingTree) and
3055
isinstance(self.target_format.workingtree_format,
3056
workingtree_4.DirStateWorkingTreeFormat)):
3057
workingtree_4.Converter3to4().convert(tree)
3058
if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
3059
not isinstance(tree, workingtree_4.WorkingTree5) and
3060
isinstance(self.target_format.workingtree_format,
3061
workingtree_4.WorkingTreeFormat5)):
3062
workingtree_4.Converter4to5().convert(tree)
3063
if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
3064
not isinstance(tree, workingtree_4.WorkingTree6) and
3065
isinstance(self.target_format.workingtree_format,
3066
workingtree_4.WorkingTreeFormat6)):
3067
workingtree_4.Converter4or5to6().convert(tree)
3071
# This is not in remote.py because it's relatively small, and needs to be
3072
# registered. Putting it in remote.py creates a circular import problem.
3073
# we can make it a lazy object if the control formats is turned into something
3075
class RemoteBzrDirFormat(BzrDirMetaFormat1):
3076
"""Format representing bzrdirs accessed via a smart server"""
3079
BzrDirMetaFormat1.__init__(self)
3080
self._network_name = None
3082
def get_format_description(self):
3083
return 'bzr remote bzrdir'
3085
def get_format_string(self):
3086
raise NotImplementedError(self.get_format_string)
3088
def network_name(self):
3089
if self._network_name:
3090
return self._network_name
3092
raise AssertionError("No network name set.")
3095
def probe_transport(klass, transport):
3096
"""Return a RemoteBzrDirFormat object if it looks possible."""
3098
medium = transport.get_smart_medium()
3099
except (NotImplementedError, AttributeError,
3100
errors.TransportNotPossible, errors.NoSmartMedium,
3101
errors.SmartProtocolError):
3102
# no smart server, so not a branch for this format type.
3103
raise errors.NotBranchError(path=transport.base)
3105
# Decline to open it if the server doesn't support our required
3106
# version (3) so that the VFS-based transport will do it.
3107
if medium.should_probe():
3109
server_version = medium.protocol_version()
3110
except errors.SmartProtocolError:
3111
# Apparently there's no usable smart server there, even though
3112
# the medium supports the smart protocol.
3113
raise errors.NotBranchError(path=transport.base)
3114
if server_version != '2':
3115
raise errors.NotBranchError(path=transport.base)
3118
def initialize_on_transport(self, transport):
3120
# hand off the request to the smart server
3121
client_medium = transport.get_smart_medium()
3122
except errors.NoSmartMedium:
3123
# TODO: lookup the local format from a server hint.
3124
local_dir_format = BzrDirMetaFormat1()
3125
return local_dir_format.initialize_on_transport(transport)
3126
client = _SmartClient(client_medium)
3127
path = client.remote_path_from_transport(transport)
3129
response = client.call('BzrDirFormat.initialize', path)
3130
except errors.ErrorFromSmartServer, err:
3131
remote._translate_error(err, path=path)
3132
if response[0] != 'ok':
3133
raise errors.SmartProtocolError('unexpected response code %s' % (response,))
3134
format = RemoteBzrDirFormat()
3135
self._supply_sub_formats_to(format)
3136
return remote.RemoteBzrDir(transport, format)
3138
def parse_NoneTrueFalse(self, arg):
3145
raise AssertionError("invalid arg %r" % arg)
3147
def _serialize_NoneTrueFalse(self, arg):
3154
def _serialize_NoneString(self, arg):
3157
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
3158
create_prefix=False, force_new_repo=False, stacked_on=None,
3159
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
3162
# hand off the request to the smart server
3163
client_medium = transport.get_smart_medium()
3164
except errors.NoSmartMedium:
3167
# Decline to open it if the server doesn't support our required
3168
# version (3) so that the VFS-based transport will do it.
3169
if client_medium.should_probe():
3171
server_version = client_medium.protocol_version()
3172
if server_version != '2':
3176
except errors.SmartProtocolError:
3177
# Apparently there's no usable smart server there, even though
3178
# the medium supports the smart protocol.
3183
client = _SmartClient(client_medium)
3184
path = client.remote_path_from_transport(transport)
3185
if client_medium._is_remote_before((1, 16)):
3188
# TODO: lookup the local format from a server hint.
3189
local_dir_format = BzrDirMetaFormat1()
3190
self._supply_sub_formats_to(local_dir_format)
3191
return local_dir_format.initialize_on_transport_ex(transport,
3192
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3193
force_new_repo=force_new_repo, stacked_on=stacked_on,
3194
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3195
make_working_trees=make_working_trees, shared_repo=shared_repo,
3197
return self._initialize_on_transport_ex_rpc(client, path, transport,
3198
use_existing_dir, create_prefix, force_new_repo, stacked_on,
3199
stack_on_pwd, repo_format_name, make_working_trees, shared_repo)
3201
def _initialize_on_transport_ex_rpc(self, client, path, transport,
3202
use_existing_dir, create_prefix, force_new_repo, stacked_on,
3203
stack_on_pwd, repo_format_name, make_working_trees, shared_repo):
3205
args.append(self._serialize_NoneTrueFalse(use_existing_dir))
3206
args.append(self._serialize_NoneTrueFalse(create_prefix))
3207
args.append(self._serialize_NoneTrueFalse(force_new_repo))
3208
args.append(self._serialize_NoneString(stacked_on))
3209
# stack_on_pwd is often/usually our transport
3212
stack_on_pwd = transport.relpath(stack_on_pwd)
3213
if not stack_on_pwd:
3215
except errors.PathNotChild:
3217
args.append(self._serialize_NoneString(stack_on_pwd))
3218
args.append(self._serialize_NoneString(repo_format_name))
3219
args.append(self._serialize_NoneTrueFalse(make_working_trees))
3220
args.append(self._serialize_NoneTrueFalse(shared_repo))
3221
if self._network_name is None:
3222
self._network_name = \
3223
BzrDirFormat.get_default_format().network_name()
3225
response = client.call('BzrDirFormat.initialize_ex_1.16',
3226
self.network_name(), path, *args)
3227
except errors.UnknownSmartMethod:
3228
client._medium._remember_remote_is_before((1,16))
3229
local_dir_format = BzrDirMetaFormat1()
3230
self._supply_sub_formats_to(local_dir_format)
3231
return local_dir_format.initialize_on_transport_ex(transport,
3232
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3233
force_new_repo=force_new_repo, stacked_on=stacked_on,
3234
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3235
make_working_trees=make_working_trees, shared_repo=shared_repo,
3237
except errors.ErrorFromSmartServer, err:
3238
remote._translate_error(err, path=path)
3239
repo_path = response[0]
3240
bzrdir_name = response[6]
3241
require_stacking = response[7]
3242
require_stacking = self.parse_NoneTrueFalse(require_stacking)
3243
format = RemoteBzrDirFormat()
3244
format._network_name = bzrdir_name
3245
self._supply_sub_formats_to(format)
3246
bzrdir = remote.RemoteBzrDir(transport, format, _client=client)
3248
repo_format = remote.response_tuple_to_repo_format(response[1:])
3249
if repo_path == '.':
3252
repo_bzrdir_format = RemoteBzrDirFormat()
3253
repo_bzrdir_format._network_name = response[5]
3254
repo_bzr = remote.RemoteBzrDir(transport.clone(repo_path),
3258
final_stack = response[8] or None
3259
final_stack_pwd = response[9] or None
3261
final_stack_pwd = urlutils.join(
3262
transport.base, final_stack_pwd)
3263
remote_repo = remote.RemoteRepository(repo_bzr, repo_format)
3264
if len(response) > 10:
3265
# Updated server verb that locks remotely.
3266
repo_lock_token = response[10] or None
3267
remote_repo.lock_write(repo_lock_token, _skip_rpc=True)
3269
remote_repo.dont_leave_lock_in_place()
3271
remote_repo.lock_write()
3272
policy = UseExistingRepository(remote_repo, final_stack,
3273
final_stack_pwd, require_stacking)
3274
policy.acquire_repository()
3278
bzrdir._format.set_branch_format(self.get_branch_format())
3279
if require_stacking:
3280
# The repo has already been created, but we need to make sure that
3281
# we'll make a stackable branch.
3282
bzrdir._format.require_stacking(_skip_repo=True)
3283
return remote_repo, bzrdir, require_stacking, policy
3285
def _open(self, transport):
3286
return remote.RemoteBzrDir(transport, self)
3288
def __eq__(self, other):
3289
if not isinstance(other, RemoteBzrDirFormat):
3291
return self.get_format_description() == other.get_format_description()
3293
def __return_repository_format(self):
3294
# Always return a RemoteRepositoryFormat object, but if a specific bzr
3295
# repository format has been asked for, tell the RemoteRepositoryFormat
3296
# that it should use that for init() etc.
3297
result = remote.RemoteRepositoryFormat()
3298
custom_format = getattr(self, '_repository_format', None)
3300
if isinstance(custom_format, remote.RemoteRepositoryFormat):
3301
return custom_format
3303
# We will use the custom format to create repositories over the
3304
# wire; expose its details like rich_root_data for code to
3306
result._custom_format = custom_format
3309
def get_branch_format(self):
3310
result = BzrDirMetaFormat1.get_branch_format(self)
3311
if not isinstance(result, remote.RemoteBranchFormat):
3312
new_result = remote.RemoteBranchFormat()
3313
new_result._custom_format = result
3315
self.set_branch_format(new_result)
3319
repository_format = property(__return_repository_format,
3320
BzrDirMetaFormat1._set_repository_format) #.im_func)
3323
BzrDirFormat.register_control_server_format(RemoteBzrDirFormat)
3326
class BzrDirFormatInfo(object):
3328
def __init__(self, native, deprecated, hidden, experimental):
3329
self.deprecated = deprecated
3330
self.native = native
3331
self.hidden = hidden
3332
self.experimental = experimental
3335
class BzrDirFormatRegistry(registry.Registry):
3336
"""Registry of user-selectable BzrDir subformats.
3338
Differs from BzrDirFormat._control_formats in that it provides sub-formats,
3339
e.g. BzrDirMeta1 with weave repository. Also, it's more user-oriented.
3343
"""Create a BzrDirFormatRegistry."""
3344
self._aliases = set()
3345
self._registration_order = list()
3346
super(BzrDirFormatRegistry, self).__init__()
3349
"""Return a set of the format names which are aliases."""
3350
return frozenset(self._aliases)
3352
def register_metadir(self, key,
3353
repository_format, help, native=True, deprecated=False,
3359
"""Register a metadir subformat.
3361
These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
3362
by the Repository/Branch/WorkingTreeformats.
3364
:param repository_format: The fully-qualified repository format class
3366
:param branch_format: Fully-qualified branch format class name as
3368
:param tree_format: Fully-qualified tree format class name as
3371
# This should be expanded to support setting WorkingTree and Branch
3372
# formats, once BzrDirMetaFormat1 supports that.
3373
def _load(full_name):
3374
mod_name, factory_name = full_name.rsplit('.', 1)
3376
mod = __import__(mod_name, globals(), locals(),
3378
except ImportError, e:
3379
raise ImportError('failed to load %s: %s' % (full_name, e))
3381
factory = getattr(mod, factory_name)
3382
except AttributeError:
3383
raise AttributeError('no factory %s in module %r'
3388
bd = BzrDirMetaFormat1()
3389
if branch_format is not None:
3390
bd.set_branch_format(_load(branch_format))
3391
if tree_format is not None:
3392
bd.workingtree_format = _load(tree_format)
3393
if repository_format is not None:
3394
bd.repository_format = _load(repository_format)
3396
self.register(key, helper, help, native, deprecated, hidden,
3397
experimental, alias)
3399
def register(self, key, factory, help, native=True, deprecated=False,
3400
hidden=False, experimental=False, alias=False):
3401
"""Register a BzrDirFormat factory.
3403
The factory must be a callable that takes one parameter: the key.
3404
It must produce an instance of the BzrDirFormat when called.
3406
This function mainly exists to prevent the info object from being
3409
registry.Registry.register(self, key, factory, help,
3410
BzrDirFormatInfo(native, deprecated, hidden, experimental))
3412
self._aliases.add(key)
3413
self._registration_order.append(key)
3415
def register_lazy(self, key, module_name, member_name, help, native=True,
3416
deprecated=False, hidden=False, experimental=False, alias=False):
3417
registry.Registry.register_lazy(self, key, module_name, member_name,
3418
help, BzrDirFormatInfo(native, deprecated, hidden, experimental))
3420
self._aliases.add(key)
3421
self._registration_order.append(key)
3423
def set_default(self, key):
3424
"""Set the 'default' key to be a clone of the supplied key.
3426
This method must be called once and only once.
3428
registry.Registry.register(self, 'default', self.get(key),
3429
self.get_help(key), info=self.get_info(key))
3430
self._aliases.add('default')
3432
def set_default_repository(self, key):
3433
"""Set the FormatRegistry default and Repository default.
3435
This is a transitional method while Repository.set_default_format
3438
if 'default' in self:
3439
self.remove('default')
3440
self.set_default(key)
3441
format = self.get('default')()
3443
def make_bzrdir(self, key):
3444
return self.get(key)()
3446
def help_topic(self, topic):
3448
default_realkey = None
3449
default_help = self.get_help('default')
3451
for key in self._registration_order:
3452
if key == 'default':
3454
help = self.get_help(key)
3455
if help == default_help:
3456
default_realkey = key
3458
help_pairs.append((key, help))
3460
def wrapped(key, help, info):
3462
help = '(native) ' + help
3463
return ':%s:\n%s\n\n' % (key,
3464
textwrap.fill(help, initial_indent=' ',
3465
subsequent_indent=' ',
3466
break_long_words=False))
3467
if default_realkey is not None:
3468
output += wrapped(default_realkey, '(default) %s' % default_help,
3469
self.get_info('default'))
3470
deprecated_pairs = []
3471
experimental_pairs = []
3472
for key, help in help_pairs:
3473
info = self.get_info(key)
3476
elif info.deprecated:
3477
deprecated_pairs.append((key, help))
3478
elif info.experimental:
3479
experimental_pairs.append((key, help))
3481
output += wrapped(key, help, info)
3482
output += "\nSee ``bzr help formats`` for more about storage formats."
3484
if len(experimental_pairs) > 0:
3485
other_output += "Experimental formats are shown below.\n\n"
3486
for key, help in experimental_pairs:
3487
info = self.get_info(key)
3488
other_output += wrapped(key, help, info)
3491
"No experimental formats are available.\n\n"
3492
if len(deprecated_pairs) > 0:
3493
other_output += "\nDeprecated formats are shown below.\n\n"
3494
for key, help in deprecated_pairs:
3495
info = self.get_info(key)
3496
other_output += wrapped(key, help, info)
3499
"\nNo deprecated formats are available.\n\n"
3501
"\nSee ``bzr help formats`` for more about storage formats."
3503
if topic == 'other-formats':
3509
class RepositoryAcquisitionPolicy(object):
3510
"""Abstract base class for repository acquisition policies.
3512
A repository acquisition policy decides how a BzrDir acquires a repository
3513
for a branch that is being created. The most basic policy decision is
3514
whether to create a new repository or use an existing one.
3516
def __init__(self, stack_on, stack_on_pwd, require_stacking):
3519
:param stack_on: A location to stack on
3520
:param stack_on_pwd: If stack_on is relative, the location it is
3522
:param require_stacking: If True, it is a failure to not stack.
3524
self._stack_on = stack_on
3525
self._stack_on_pwd = stack_on_pwd
3526
self._require_stacking = require_stacking
3528
def configure_branch(self, branch):
3529
"""Apply any configuration data from this policy to the branch.
3531
Default implementation sets repository stacking.
3533
if self._stack_on is None:
3535
if self._stack_on_pwd is None:
3536
stack_on = self._stack_on
3539
stack_on = urlutils.rebase_url(self._stack_on,
3541
branch.bzrdir.root_transport.base)
3542
except errors.InvalidRebaseURLs:
3543
stack_on = self._get_full_stack_on()
3545
branch.set_stacked_on_url(stack_on)
3546
except (errors.UnstackableBranchFormat,
3547
errors.UnstackableRepositoryFormat):
3548
if self._require_stacking:
3551
def requires_stacking(self):
3552
"""Return True if this policy requires stacking."""
3553
return self._stack_on is not None and self._require_stacking
3555
def _get_full_stack_on(self):
3556
"""Get a fully-qualified URL for the stack_on location."""
3557
if self._stack_on is None:
3559
if self._stack_on_pwd is None:
3560
return self._stack_on
3562
return urlutils.join(self._stack_on_pwd, self._stack_on)
3564
def _add_fallback(self, repository, possible_transports=None):
3565
"""Add a fallback to the supplied repository, if stacking is set."""
3566
stack_on = self._get_full_stack_on()
3567
if stack_on is None:
3570
stacked_dir = BzrDir.open(stack_on,
3571
possible_transports=possible_transports)
3572
except errors.JailBreak:
3573
# We keep the stacking details, but we are in the server code so
3574
# actually stacking is not needed.
3577
stacked_repo = stacked_dir.open_branch().repository
3578
except errors.NotBranchError:
3579
stacked_repo = stacked_dir.open_repository()
3581
repository.add_fallback_repository(stacked_repo)
3582
except errors.UnstackableRepositoryFormat:
3583
if self._require_stacking:
3586
self._require_stacking = True
3588
def acquire_repository(self, make_working_trees=None, shared=False):
3589
"""Acquire a repository for this bzrdir.
3591
Implementations may create a new repository or use a pre-exising
3593
:param make_working_trees: If creating a repository, set
3594
make_working_trees to this value (if non-None)
3595
:param shared: If creating a repository, make it shared if True
3596
:return: A repository, is_new_flag (True if the repository was
3599
raise NotImplemented(RepositoryAcquisitionPolicy.acquire_repository)
3602
class CreateRepository(RepositoryAcquisitionPolicy):
3603
"""A policy of creating a new repository"""
3605
def __init__(self, bzrdir, stack_on=None, stack_on_pwd=None,
3606
require_stacking=False):
3609
:param bzrdir: The bzrdir to create the repository on.
3610
:param stack_on: A location to stack on
3611
:param stack_on_pwd: If stack_on is relative, the location it is
3614
RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
3616
self._bzrdir = bzrdir
3618
def acquire_repository(self, make_working_trees=None, shared=False):
3619
"""Implementation of RepositoryAcquisitionPolicy.acquire_repository
3621
Creates the desired repository in the bzrdir we already have.
3623
stack_on = self._get_full_stack_on()
3625
format = self._bzrdir._format
3626
format.require_stacking(stack_on=stack_on,
3627
possible_transports=[self._bzrdir.root_transport])
3628
if not self._require_stacking:
3629
# We have picked up automatic stacking somewhere.
3630
note('Using default stacking branch %s at %s', self._stack_on,
3632
repository = self._bzrdir.create_repository(shared=shared)
3633
self._add_fallback(repository,
3634
possible_transports=[self._bzrdir.transport])
3635
if make_working_trees is not None:
3636
repository.set_make_working_trees(make_working_trees)
3637
return repository, True
3640
class UseExistingRepository(RepositoryAcquisitionPolicy):
3641
"""A policy of reusing an existing repository"""
3643
def __init__(self, repository, stack_on=None, stack_on_pwd=None,
3644
require_stacking=False):
3647
:param repository: The repository to use.
3648
:param stack_on: A location to stack on
3649
:param stack_on_pwd: If stack_on is relative, the location it is
3652
RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
3654
self._repository = repository
3656
def acquire_repository(self, make_working_trees=None, shared=False):
3657
"""Implementation of RepositoryAcquisitionPolicy.acquire_repository
3659
Returns an existing repository to use.
3661
self._add_fallback(self._repository,
3662
possible_transports=[self._repository.bzrdir.transport])
3663
return self._repository, False
3666
# Please register new formats after old formats so that formats
3667
# appear in chronological order and format descriptions can build
3669
format_registry = BzrDirFormatRegistry()
3670
# The pre-0.8 formats have their repository format network name registered in
3671
# repository.py. MetaDir formats have their repository format network name
3672
# inferred from their disk format string.
3673
format_registry.register('weave', BzrDirFormat6,
3674
'Pre-0.8 format. Slower than knit and does not'
3675
' support checkouts or shared repositories.',
3677
format_registry.register_metadir('metaweave',
3678
'bzrlib.repofmt.weaverepo.RepositoryFormat7',
3679
'Transitional format in 0.8. Slower than knit.',
3680
branch_format='bzrlib.branch.BzrBranchFormat5',
3681
tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3683
format_registry.register_metadir('knit',
3684
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3685
'Format using knits. Recommended for interoperation with bzr <= 0.14.',
3686
branch_format='bzrlib.branch.BzrBranchFormat5',
3687
tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3689
format_registry.register_metadir('dirstate',
3690
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3691
help='New in 0.15: Fast local operations. Compatible with bzr 0.8 and '
3692
'above when accessed over the network.',
3693
branch_format='bzrlib.branch.BzrBranchFormat5',
3694
# this uses bzrlib.workingtree.WorkingTreeFormat4 because importing
3695
# directly from workingtree_4 triggers a circular import.
3696
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3698
format_registry.register_metadir('dirstate-tags',
3699
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3700
help='New in 0.15: Fast local operations and improved scaling for '
3701
'network operations. Additionally adds support for tags.'
3702
' Incompatible with bzr < 0.15.',
3703
branch_format='bzrlib.branch.BzrBranchFormat6',
3704
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3706
format_registry.register_metadir('rich-root',
3707
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
3708
help='New in 1.0. Better handling of tree roots. Incompatible with'
3710
branch_format='bzrlib.branch.BzrBranchFormat6',
3711
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3713
format_registry.register_metadir('dirstate-with-subtree',
3714
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
3715
help='New in 0.15: Fast local operations and improved scaling for '
3716
'network operations. Additionally adds support for versioning nested '
3717
'bzr branches. Incompatible with bzr < 0.15.',
3718
branch_format='bzrlib.branch.BzrBranchFormat6',
3719
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3723
format_registry.register_metadir('pack-0.92',
3724
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack1',
3725
help='New in 0.92: Pack-based format with data compatible with '
3726
'dirstate-tags format repositories. Interoperates with '
3727
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3728
'Previously called knitpack-experimental. '
3729
'For more information, see '
3730
'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
3731
branch_format='bzrlib.branch.BzrBranchFormat6',
3732
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3734
format_registry.register_metadir('pack-0.92-subtree',
3735
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack3',
3736
help='New in 0.92: Pack-based format with data compatible with '
3737
'dirstate-with-subtree format repositories. Interoperates with '
3738
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3739
'Previously called knitpack-experimental. '
3740
'For more information, see '
3741
'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
3742
branch_format='bzrlib.branch.BzrBranchFormat6',
3743
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3747
format_registry.register_metadir('rich-root-pack',
3748
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
3749
help='New in 1.0: A variant of pack-0.92 that supports rich-root data '
3750
'(needed for bzr-svn and bzr-git).',
3751
branch_format='bzrlib.branch.BzrBranchFormat6',
3752
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3754
format_registry.register_metadir('1.6',
3755
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5',
3756
help='A format that allows a branch to indicate that there is another '
3757
'(stacked) repository that should be used to access data that is '
3758
'not present locally.',
3759
branch_format='bzrlib.branch.BzrBranchFormat7',
3760
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3762
format_registry.register_metadir('1.6.1-rich-root',
3763
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5RichRoot',
3764
help='A variant of 1.6 that supports rich-root data '
3765
'(needed for bzr-svn and bzr-git).',
3766
branch_format='bzrlib.branch.BzrBranchFormat7',
3767
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3769
format_registry.register_metadir('1.9',
3770
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3771
help='A repository format using B+tree indexes. These indexes '
3772
'are smaller in size, have smarter caching and provide faster '
3773
'performance for most operations.',
3774
branch_format='bzrlib.branch.BzrBranchFormat7',
3775
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3777
format_registry.register_metadir('1.9-rich-root',
3778
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
3779
help='A variant of 1.9 that supports rich-root data '
3780
'(needed for bzr-svn and bzr-git).',
3781
branch_format='bzrlib.branch.BzrBranchFormat7',
3782
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3784
format_registry.register_metadir('1.14',
3785
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3786
help='A working-tree format that supports content filtering.',
3787
branch_format='bzrlib.branch.BzrBranchFormat7',
3788
tree_format='bzrlib.workingtree.WorkingTreeFormat5',
3790
format_registry.register_metadir('1.14-rich-root',
3791
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
3792
help='A variant of 1.14 that supports rich-root data '
3793
'(needed for bzr-svn and bzr-git).',
3794
branch_format='bzrlib.branch.BzrBranchFormat7',
3795
tree_format='bzrlib.workingtree.WorkingTreeFormat5',
3797
# The following un-numbered 'development' formats should always just be aliases.
3798
format_registry.register_metadir('development-rich-root',
3799
'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
3800
help='Current development format. Supports rich roots. Can convert data '
3801
'to and from rich-root-pack (and anything compatible with '
3802
'rich-root-pack) format repositories. Repositories and branches in '
3803
'this format can only be read by bzr.dev. Please read '
3804
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3806
branch_format='bzrlib.branch.BzrBranchFormat7',
3807
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3811
format_registry.register_metadir('development-subtree',
3812
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment2Subtree',
3813
help='Current development format, subtree variant. Can convert data to and '
3814
'from pack-0.92-subtree (and anything compatible with '
3815
'pack-0.92-subtree) format repositories. Repositories and branches in '
3816
'this format can only be read by bzr.dev. Please read '
3817
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3819
branch_format='bzrlib.branch.BzrBranchFormat7',
3820
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3822
alias=False, # Restore to being an alias when an actual development subtree format is added
3823
# This current non-alias status is simply because we did not introduce a
3824
# chk based subtree format.
3827
# And the development formats above will have aliased one of the following:
3828
format_registry.register_metadir('development6-rich-root',
3829
'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
3830
help='pack-1.9 with 255-way hashed CHK inv, group compress, rich roots '
3832
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3834
branch_format='bzrlib.branch.BzrBranchFormat7',
3835
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3840
format_registry.register_metadir('development7-rich-root',
3841
'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK2',
3842
help='pack-1.9 with 255-way hashed CHK inv, bencode revision, group compress, '
3843
'rich roots. Please read '
3844
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3846
branch_format='bzrlib.branch.BzrBranchFormat7',
3847
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3852
format_registry.register_metadir('2a',
3853
'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
3854
help='First format for bzr 2.0 series.\n'
3855
'Uses group-compress storage.\n'
3856
'Provides rich roots which are a one-way transition.\n',
3857
# 'storage in packs, 255-way hashed CHK inventory, bencode revision, group compress, '
3858
# 'rich roots. Supported by bzr 1.16 and later.',
3859
branch_format='bzrlib.branch.BzrBranchFormat7',
3860
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3864
# The following format should be an alias for the rich root equivalent
3865
# of the default format
3866
format_registry.register_metadir('default-rich-root',
3867
'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
3868
branch_format='bzrlib.branch.BzrBranchFormat7',
3869
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3873
# The current format that is made on 'bzr init'.
3874
format_registry.set_default('2a')
added
removed
bzrlib/bzrdir.py
