1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""BzrDir logic. The BzrDir is the basic control directory used by bzr.
19
At format 7 this was split out into Branch, Repository and Checkout control
22
Note: This module has a lot of ``open`` functions/methods that return
23
references to in-memory objects. As a rule, there are no matching ``close``
24
methods. To free any associated resources, simply stop referencing the
28
# TODO: Move old formats into a plugin to make this file smaller.
33
from bzrlib.lazy_import import lazy_import
34
lazy_import(globals(), """
35
from stat import S_ISDIR
49
revision as _mod_revision,
59
from bzrlib.osutils import (
62
from bzrlib.push import (
65
from bzrlib.repofmt import pack_repo
66
from bzrlib.smart.client import _SmartClient
67
from bzrlib.store.versioned import WeaveStore
68
from bzrlib.transactions import WriteTransaction
69
from bzrlib.transport import (
70
do_catching_redirections,
73
remote as remote_transport,
75
from bzrlib.weave import Weave
78
from bzrlib.trace import (
91
"""A .bzr control diretory.
93
BzrDir instances let you create or open any of the things that can be
94
found within .bzr - checkouts, branches and repositories.
97
the transport which this bzr dir is rooted at (i.e. file:///.../.bzr/)
99
a transport connected to the directory this bzr was opened from
100
(i.e. the parent directory holding the .bzr directory).
102
Everything in the bzrdir should have the same file permissions.
104
:cvar hooks: An instance of BzrDirHooks.
107
def break_lock(self):
108
"""Invoke break_lock on the first object in the bzrdir.
110
If there is a tree, the tree is opened and break_lock() called.
111
Otherwise, branch is tried, and finally repository.
113
# XXX: This seems more like a UI function than something that really
114
# belongs in this class.
116
thing_to_unlock = self.open_workingtree()
117
except (errors.NotLocalUrl, errors.NoWorkingTree):
119
thing_to_unlock = self.open_branch()
120
except errors.NotBranchError:
122
thing_to_unlock = self.open_repository()
123
except errors.NoRepositoryPresent:
125
thing_to_unlock.break_lock()
127
def can_convert_format(self):
128
"""Return true if this bzrdir is one whose format we can convert from."""
131
def check_conversion_target(self, target_format):
132
target_repo_format = target_format.repository_format
133
source_repo_format = self._format.repository_format
134
source_repo_format.check_conversion_target(target_repo_format)
137
def _check_supported(format, allow_unsupported,
138
recommend_upgrade=True,
140
"""Give an error or warning on old formats.
142
:param format: may be any kind of format - workingtree, branch,
145
:param allow_unsupported: If true, allow opening
146
formats that are strongly deprecated, and which may
147
have limited functionality.
149
:param recommend_upgrade: If true (default), warn
150
the user through the ui object that they may wish
151
to upgrade the object.
153
# TODO: perhaps move this into a base Format class; it's not BzrDir
154
# specific. mbp 20070323
155
if not allow_unsupported and not format.is_supported():
156
# see open_downlevel to open legacy branches.
157
raise errors.UnsupportedFormatError(format=format)
158
if recommend_upgrade \
159
and getattr(format, 'upgrade_recommended', False):
160
ui.ui_factory.recommend_upgrade(
161
format.get_format_description(),
164
def clone(self, url, revision_id=None, force_new_repo=False,
165
preserve_stacking=False):
166
"""Clone this bzrdir and its contents to url verbatim.
168
:param url: The url create the clone at. If url's last component does
169
not exist, it will be created.
170
:param revision_id: The tip revision-id to use for any branch or
171
working tree. If not None, then the clone operation may tune
172
itself to download less data.
173
:param force_new_repo: Do not use a shared repository for the target
174
even if one is available.
175
:param preserve_stacking: When cloning a stacked branch, stack the
176
new branch on top of the other branch's stacked-on branch.
178
return self.clone_on_transport(get_transport(url),
179
revision_id=revision_id,
180
force_new_repo=force_new_repo,
181
preserve_stacking=preserve_stacking)
183
def clone_on_transport(self, transport, revision_id=None,
184
force_new_repo=False, preserve_stacking=False, stacked_on=None,
185
create_prefix=False, use_existing_dir=True):
186
"""Clone this bzrdir and its contents to transport verbatim.
188
:param transport: The transport for the location to produce the clone
189
at. If the target directory does not exist, it will be created.
190
:param revision_id: The tip revision-id to use for any branch or
191
working tree. If not None, then the clone operation may tune
192
itself to download less data.
193
:param force_new_repo: Do not use a shared repository for the target,
194
even if one is available.
195
:param preserve_stacking: When cloning a stacked branch, stack the
196
new branch on top of the other branch's stacked-on branch.
197
:param create_prefix: Create any missing directories leading up to
199
:param use_existing_dir: Use an existing directory if one exists.
201
# Overview: put together a broad description of what we want to end up
202
# with; then make as few api calls as possible to do it.
204
# We may want to create a repo/branch/tree, if we do so what format
205
# would we want for each:
206
require_stacking = (stacked_on is not None)
207
format = self.cloning_metadir(require_stacking)
209
# Figure out what objects we want:
211
local_repo = self.find_repository()
212
except errors.NoRepositoryPresent:
215
local_branch = self.open_branch()
216
except errors.NotBranchError:
219
# enable fallbacks when branch is not a branch reference
220
if local_branch.repository.has_same_location(local_repo):
221
local_repo = local_branch.repository
222
if preserve_stacking:
224
stacked_on = local_branch.get_stacked_on_url()
225
except (errors.UnstackableBranchFormat,
226
errors.UnstackableRepositoryFormat,
229
# Bug: We create a metadir without knowing if it can support stacking,
230
# we should look up the policy needs first, or just use it as a hint,
233
make_working_trees = local_repo.make_working_trees()
234
want_shared = local_repo.is_shared()
235
repo_format_name = format.repository_format.network_name()
237
make_working_trees = False
239
repo_format_name = None
241
result_repo, result, require_stacking, repository_policy = \
242
format.initialize_on_transport_ex(transport,
243
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
244
force_new_repo=force_new_repo, stacked_on=stacked_on,
245
stack_on_pwd=self.root_transport.base,
246
repo_format_name=repo_format_name,
247
make_working_trees=make_working_trees, shared_repo=want_shared)
250
# If the result repository is in the same place as the
251
# resulting bzr dir, it will have no content, further if the
252
# result is not stacked then we know all content should be
253
# copied, and finally if we are copying up to a specific
254
# revision_id then we can use the pending-ancestry-result which
255
# does not require traversing all of history to describe it.
256
if (result_repo.bzrdir.root_transport.base ==
257
result.root_transport.base and not require_stacking and
258
revision_id is not None):
259
fetch_spec = graph.PendingAncestryResult(
260
[revision_id], local_repo)
261
result_repo.fetch(local_repo, fetch_spec=fetch_spec)
263
result_repo.fetch(local_repo, revision_id=revision_id)
267
if result_repo is not None:
268
raise AssertionError('result_repo not None(%r)' % result_repo)
269
# 1 if there is a branch present
270
# make sure its content is available in the target repository
272
if local_branch is not None:
273
result_branch = local_branch.clone(result, revision_id=revision_id,
274
repository_policy=repository_policy)
276
# Cheaper to check if the target is not local, than to try making
278
result.root_transport.local_abspath('.')
279
if result_repo is None or result_repo.make_working_trees():
280
self.open_workingtree().clone(result)
281
except (errors.NoWorkingTree, errors.NotLocalUrl):
285
# TODO: This should be given a Transport, and should chdir up; otherwise
286
# this will open a new connection.
287
def _make_tail(self, url):
288
t = get_transport(url)
292
def create(cls, base, format=None, possible_transports=None):
293
"""Create a new BzrDir at the url 'base'.
295
:param format: If supplied, the format of branch to create. If not
296
supplied, the default is used.
297
:param possible_transports: If supplied, a list of transports that
298
can be reused to share a remote connection.
300
if cls is not BzrDir:
301
raise AssertionError("BzrDir.create always creates the default"
302
" format, not one of %r" % cls)
303
t = get_transport(base, possible_transports)
306
format = BzrDirFormat.get_default_format()
307
return format.initialize_on_transport(t)
310
def find_bzrdirs(transport, evaluate=None, list_current=None):
311
"""Find bzrdirs recursively from current location.
313
This is intended primarily as a building block for more sophisticated
314
functionality, like finding trees under a directory, or finding
315
branches that use a given repository.
316
:param evaluate: An optional callable that yields recurse, value,
317
where recurse controls whether this bzrdir is recursed into
318
and value is the value to yield. By default, all bzrdirs
319
are recursed into, and the return value is the bzrdir.
320
:param list_current: if supplied, use this function to list the current
321
directory, instead of Transport.list_dir
322
:return: a generator of found bzrdirs, or whatever evaluate returns.
324
if list_current is None:
325
def list_current(transport):
326
return transport.list_dir('')
328
def evaluate(bzrdir):
331
pending = [transport]
332
while len(pending) > 0:
333
current_transport = pending.pop()
336
bzrdir = BzrDir.open_from_transport(current_transport)
337
except errors.NotBranchError:
340
recurse, value = evaluate(bzrdir)
343
subdirs = list_current(current_transport)
344
except errors.NoSuchFile:
347
for subdir in sorted(subdirs, reverse=True):
348
pending.append(current_transport.clone(subdir))
351
def find_branches(transport):
352
"""Find all branches under a transport.
354
This will find all branches below the transport, including branches
355
inside other branches. Where possible, it will use
356
Repository.find_branches.
358
To list all the branches that use a particular Repository, see
359
Repository.find_branches
361
def evaluate(bzrdir):
363
repository = bzrdir.open_repository()
364
except errors.NoRepositoryPresent:
367
return False, (None, repository)
369
branch = bzrdir.open_branch()
370
except errors.NotBranchError:
371
return True, (None, None)
373
return True, (branch, None)
375
for branch, repo in BzrDir.find_bzrdirs(transport, evaluate=evaluate):
377
branches.extend(repo.find_branches())
378
if branch is not None:
379
branches.append(branch)
382
def destroy_repository(self):
383
"""Destroy the repository in this BzrDir"""
384
raise NotImplementedError(self.destroy_repository)
386
def create_branch(self):
387
"""Create a branch in this BzrDir.
389
The bzrdir's format will control what branch format is created.
390
For more control see BranchFormatXX.create(a_bzrdir).
392
raise NotImplementedError(self.create_branch)
394
def destroy_branch(self):
395
"""Destroy the branch in this BzrDir"""
396
raise NotImplementedError(self.destroy_branch)
399
def create_branch_and_repo(base, force_new_repo=False, format=None):
400
"""Create a new BzrDir, Branch and Repository at the url 'base'.
402
This will use the current default BzrDirFormat unless one is
403
specified, and use whatever
404
repository format that that uses via bzrdir.create_branch and
405
create_repository. If a shared repository is available that is used
408
The created Branch object is returned.
410
:param base: The URL to create the branch at.
411
:param force_new_repo: If True a new repository is always created.
412
:param format: If supplied, the format of branch to create. If not
413
supplied, the default is used.
415
bzrdir = BzrDir.create(base, format)
416
bzrdir._find_or_create_repository(force_new_repo)
417
return bzrdir.create_branch()
419
def determine_repository_policy(self, force_new_repo=False, stack_on=None,
420
stack_on_pwd=None, require_stacking=False):
421
"""Return an object representing a policy to use.
423
This controls whether a new repository is created, and the format of
424
that repository, or some existing shared repository used instead.
426
If stack_on is supplied, will not seek a containing shared repo.
428
:param force_new_repo: If True, require a new repository to be created.
429
:param stack_on: If supplied, the location to stack on. If not
430
supplied, a default_stack_on location may be used.
431
:param stack_on_pwd: If stack_on is relative, the location it is
434
def repository_policy(found_bzrdir):
437
config = found_bzrdir.get_config()
439
stack_on = config.get_default_stack_on()
440
if stack_on is not None:
441
stack_on_pwd = found_bzrdir.root_transport.base
443
# does it have a repository ?
445
repository = found_bzrdir.open_repository()
446
except errors.NoRepositoryPresent:
449
if ((found_bzrdir.root_transport.base !=
450
self.root_transport.base) and not repository.is_shared()):
451
# Don't look higher, can't use a higher shared repo.
459
return UseExistingRepository(repository, stack_on,
460
stack_on_pwd, require_stacking=require_stacking), True
462
return CreateRepository(self, stack_on, stack_on_pwd,
463
require_stacking=require_stacking), True
465
if not force_new_repo:
467
policy = self._find_containing(repository_policy)
468
if policy is not None:
472
return UseExistingRepository(self.open_repository(),
473
stack_on, stack_on_pwd,
474
require_stacking=require_stacking)
475
except errors.NoRepositoryPresent:
477
return CreateRepository(self, stack_on, stack_on_pwd,
478
require_stacking=require_stacking)
480
def _find_or_create_repository(self, force_new_repo):
481
"""Create a new repository if needed, returning the repository."""
482
policy = self.determine_repository_policy(force_new_repo)
483
return policy.acquire_repository()[0]
486
def create_branch_convenience(base, force_new_repo=False,
487
force_new_tree=None, format=None,
488
possible_transports=None):
489
"""Create a new BzrDir, Branch and Repository at the url 'base'.
491
This is a convenience function - it will use an existing repository
492
if possible, can be told explicitly whether to create a working tree or
495
This will use the current default BzrDirFormat unless one is
496
specified, and use whatever
497
repository format that that uses via bzrdir.create_branch and
498
create_repository. If a shared repository is available that is used
499
preferentially. Whatever repository is used, its tree creation policy
502
The created Branch object is returned.
503
If a working tree cannot be made due to base not being a file:// url,
504
no error is raised unless force_new_tree is True, in which case no
505
data is created on disk and NotLocalUrl is raised.
507
:param base: The URL to create the branch at.
508
:param force_new_repo: If True a new repository is always created.
509
:param force_new_tree: If True or False force creation of a tree or
510
prevent such creation respectively.
511
:param format: Override for the bzrdir format to create.
512
:param possible_transports: An optional reusable transports list.
515
# check for non local urls
516
t = get_transport(base, possible_transports)
517
if not isinstance(t, local.LocalTransport):
518
raise errors.NotLocalUrl(base)
519
bzrdir = BzrDir.create(base, format, possible_transports)
520
repo = bzrdir._find_or_create_repository(force_new_repo)
521
result = bzrdir.create_branch()
522
if force_new_tree or (repo.make_working_trees() and
523
force_new_tree is None):
525
bzrdir.create_workingtree()
526
except errors.NotLocalUrl:
531
def create_standalone_workingtree(base, format=None):
532
"""Create a new BzrDir, WorkingTree, Branch and Repository at 'base'.
534
'base' must be a local path or a file:// url.
536
This will use the current default BzrDirFormat unless one is
537
specified, and use whatever
538
repository format that that uses for bzrdirformat.create_workingtree,
539
create_branch and create_repository.
541
:param format: Override for the bzrdir format to create.
542
:return: The WorkingTree object.
544
t = get_transport(base)
545
if not isinstance(t, local.LocalTransport):
546
raise errors.NotLocalUrl(base)
547
bzrdir = BzrDir.create_branch_and_repo(base,
549
format=format).bzrdir
550
return bzrdir.create_workingtree()
552
def create_workingtree(self, revision_id=None, from_branch=None,
553
accelerator_tree=None, hardlink=False):
554
"""Create a working tree at this BzrDir.
556
:param revision_id: create it as of this revision id.
557
:param from_branch: override bzrdir branch (for lightweight checkouts)
558
:param accelerator_tree: A tree which can be used for retrieving file
559
contents more quickly than the revision tree, i.e. a workingtree.
560
The revision tree will be used for cases where accelerator_tree's
561
content is different.
563
raise NotImplementedError(self.create_workingtree)
565
def backup_bzrdir(self):
566
"""Backup this bzr control directory.
568
:return: Tuple with old path name and new path name
570
pb = ui.ui_factory.nested_progress_bar()
572
# FIXME: bug 300001 -- the backup fails if the backup directory
573
# already exists, but it should instead either remove it or make
574
# a new backup directory.
576
# FIXME: bug 262450 -- the backup directory should have the same
577
# permissions as the .bzr directory (probably a bug in copy_tree)
578
old_path = self.root_transport.abspath('.bzr')
579
new_path = self.root_transport.abspath('backup.bzr')
580
pb.note('making backup of %s' % (old_path,))
581
pb.note(' to %s' % (new_path,))
582
self.root_transport.copy_tree('.bzr', 'backup.bzr')
583
return (old_path, new_path)
587
def retire_bzrdir(self, limit=10000):
588
"""Permanently disable the bzrdir.
590
This is done by renaming it to give the user some ability to recover
591
if there was a problem.
593
This will have horrible consequences if anyone has anything locked or
595
:param limit: number of times to retry
600
to_path = '.bzr.retired.%d' % i
601
self.root_transport.rename('.bzr', to_path)
602
note("renamed %s to %s"
603
% (self.root_transport.abspath('.bzr'), to_path))
605
except (errors.TransportError, IOError, errors.PathError):
612
def destroy_workingtree(self):
613
"""Destroy the working tree at this BzrDir.
615
Formats that do not support this may raise UnsupportedOperation.
617
raise NotImplementedError(self.destroy_workingtree)
619
def destroy_workingtree_metadata(self):
620
"""Destroy the control files for the working tree at this BzrDir.
622
The contents of working tree files are not affected.
623
Formats that do not support this may raise UnsupportedOperation.
625
raise NotImplementedError(self.destroy_workingtree_metadata)
627
def _find_containing(self, evaluate):
628
"""Find something in a containing control directory.
630
This method will scan containing control dirs, until it finds what
631
it is looking for, decides that it will never find it, or runs out
632
of containing control directories to check.
634
It is used to implement find_repository and
635
determine_repository_policy.
637
:param evaluate: A function returning (value, stop). If stop is True,
638
the value will be returned.
642
result, stop = evaluate(found_bzrdir)
645
next_transport = found_bzrdir.root_transport.clone('..')
646
if (found_bzrdir.root_transport.base == next_transport.base):
647
# top of the file system
649
# find the next containing bzrdir
651
found_bzrdir = BzrDir.open_containing_from_transport(
653
except errors.NotBranchError:
656
def find_repository(self):
657
"""Find the repository that should be used.
659
This does not require a branch as we use it to find the repo for
660
new branches as well as to hook existing branches up to their
663
def usable_repository(found_bzrdir):
664
# does it have a repository ?
666
repository = found_bzrdir.open_repository()
667
except errors.NoRepositoryPresent:
669
if found_bzrdir.root_transport.base == self.root_transport.base:
670
return repository, True
671
elif repository.is_shared():
672
return repository, True
676
found_repo = self._find_containing(usable_repository)
677
if found_repo is None:
678
raise errors.NoRepositoryPresent(self)
681
def get_branch_reference(self):
682
"""Return the referenced URL for the branch in this bzrdir.
684
:raises NotBranchError: If there is no Branch.
685
:return: The URL the branch in this bzrdir references if it is a
686
reference branch, or None for regular branches.
690
def get_branch_transport(self, branch_format):
691
"""Get the transport for use by branch format in this BzrDir.
693
Note that bzr dirs that do not support format strings will raise
694
IncompatibleFormat if the branch format they are given has
695
a format string, and vice versa.
697
If branch_format is None, the transport is returned with no
698
checking. If it is not None, then the returned transport is
699
guaranteed to point to an existing directory ready for use.
701
raise NotImplementedError(self.get_branch_transport)
703
def _find_creation_modes(self):
704
"""Determine the appropriate modes for files and directories.
706
They're always set to be consistent with the base directory,
707
assuming that this transport allows setting modes.
709
# TODO: Do we need or want an option (maybe a config setting) to turn
710
# this off or override it for particular locations? -- mbp 20080512
711
if self._mode_check_done:
713
self._mode_check_done = True
715
st = self.transport.stat('.')
716
except errors.TransportNotPossible:
717
self._dir_mode = None
718
self._file_mode = None
720
# Check the directory mode, but also make sure the created
721
# directories and files are read-write for this user. This is
722
# mostly a workaround for filesystems which lie about being able to
723
# write to a directory (cygwin & win32)
724
if (st.st_mode & 07777 == 00000):
725
# FTP allows stat but does not return dir/file modes
726
self._dir_mode = None
727
self._file_mode = None
729
self._dir_mode = (st.st_mode & 07777) | 00700
730
# Remove the sticky and execute bits for files
731
self._file_mode = self._dir_mode & ~07111
733
def _get_file_mode(self):
734
"""Return Unix mode for newly created files, or None.
736
if not self._mode_check_done:
737
self._find_creation_modes()
738
return self._file_mode
740
def _get_dir_mode(self):
741
"""Return Unix mode for newly created directories, or None.
743
if not self._mode_check_done:
744
self._find_creation_modes()
745
return self._dir_mode
747
def get_repository_transport(self, repository_format):
748
"""Get the transport for use by repository format in this BzrDir.
750
Note that bzr dirs that do not support format strings will raise
751
IncompatibleFormat if the repository format they are given has
752
a format string, and vice versa.
754
If repository_format is None, the transport is returned with no
755
checking. If it is not None, then the returned transport is
756
guaranteed to point to an existing directory ready for use.
758
raise NotImplementedError(self.get_repository_transport)
760
def get_workingtree_transport(self, tree_format):
761
"""Get the transport for use by workingtree format in this BzrDir.
763
Note that bzr dirs that do not support format strings will raise
764
IncompatibleFormat if the workingtree format they are given has a
765
format string, and vice versa.
767
If workingtree_format is None, the transport is returned with no
768
checking. If it is not None, then the returned transport is
769
guaranteed to point to an existing directory ready for use.
771
raise NotImplementedError(self.get_workingtree_transport)
773
def get_config(self):
774
"""Get configuration for this BzrDir."""
775
return config.BzrDirConfig(self)
777
def _get_config(self):
778
"""By default, no configuration is available."""
781
def __init__(self, _transport, _format):
782
"""Initialize a Bzr control dir object.
784
Only really common logic should reside here, concrete classes should be
785
made with varying behaviours.
787
:param _format: the format that is creating this BzrDir instance.
788
:param _transport: the transport this dir is based at.
790
self._format = _format
791
self.transport = _transport.clone('.bzr')
792
self.root_transport = _transport
793
self._mode_check_done = False
795
def is_control_filename(self, filename):
796
"""True if filename is the name of a path which is reserved for bzrdir's.
798
:param filename: A filename within the root transport of this bzrdir.
800
This is true IF and ONLY IF the filename is part of the namespace reserved
801
for bzr control dirs. Currently this is the '.bzr' directory in the root
802
of the root_transport. it is expected that plugins will need to extend
803
this in the future - for instance to make bzr talk with svn working
806
# this might be better on the BzrDirFormat class because it refers to
807
# all the possible bzrdir disk formats.
808
# This method is tested via the workingtree is_control_filename tests-
809
# it was extracted from WorkingTree.is_control_filename. If the method's
810
# contract is extended beyond the current trivial implementation, please
811
# add new tests for it to the appropriate place.
812
return filename == '.bzr' or filename.startswith('.bzr/')
814
def needs_format_conversion(self, format=None):
815
"""Return true if this bzrdir needs convert_format run on it.
817
For instance, if the repository format is out of date but the
818
branch and working tree are not, this should return True.
820
:param format: Optional parameter indicating a specific desired
821
format we plan to arrive at.
823
raise NotImplementedError(self.needs_format_conversion)
826
def open_unsupported(base):
827
"""Open a branch which is not supported."""
828
return BzrDir.open(base, _unsupported=True)
831
def open(base, _unsupported=False, possible_transports=None):
832
"""Open an existing bzrdir, rooted at 'base' (url).
834
:param _unsupported: a private parameter to the BzrDir class.
836
t = get_transport(base, possible_transports=possible_transports)
837
return BzrDir.open_from_transport(t, _unsupported=_unsupported)
840
def open_from_transport(transport, _unsupported=False,
841
_server_formats=True):
842
"""Open a bzrdir within a particular directory.
844
:param transport: Transport containing the bzrdir.
845
:param _unsupported: private.
847
for hook in BzrDir.hooks['pre_open']:
849
# Keep initial base since 'transport' may be modified while following
851
base = transport.base
852
def find_format(transport):
853
return transport, BzrDirFormat.find_format(
854
transport, _server_formats=_server_formats)
856
def redirected(transport, e, redirection_notice):
857
redirected_transport = transport._redirected_to(e.source, e.target)
858
if redirected_transport is None:
859
raise errors.NotBranchError(base)
860
note('%s is%s redirected to %s',
861
transport.base, e.permanently, redirected_transport.base)
862
return redirected_transport
865
transport, format = do_catching_redirections(find_format,
868
except errors.TooManyRedirections:
869
raise errors.NotBranchError(base)
871
BzrDir._check_supported(format, _unsupported)
872
return format.open(transport, _found=True)
874
def open_branch(self, unsupported=False, ignore_fallbacks=False):
875
"""Open the branch object at this BzrDir if one is present.
877
If unsupported is True, then no longer supported branch formats can
880
TODO: static convenience version of this?
882
raise NotImplementedError(self.open_branch)
885
def open_containing(url, possible_transports=None):
886
"""Open an existing branch which contains url.
888
:param url: url to search from.
889
See open_containing_from_transport for more detail.
891
transport = get_transport(url, possible_transports)
892
return BzrDir.open_containing_from_transport(transport)
895
def open_containing_from_transport(a_transport):
896
"""Open an existing branch which contains a_transport.base.
898
This probes for a branch at a_transport, and searches upwards from there.
900
Basically we keep looking up until we find the control directory or
901
run into the root. If there isn't one, raises NotBranchError.
902
If there is one and it is either an unrecognised format or an unsupported
903
format, UnknownFormatError or UnsupportedFormatError are raised.
904
If there is one, it is returned, along with the unused portion of url.
906
:return: The BzrDir that contains the path, and a Unicode path
907
for the rest of the URL.
909
# this gets the normalised url back. I.e. '.' -> the full path.
910
url = a_transport.base
913
result = BzrDir.open_from_transport(a_transport)
914
return result, urlutils.unescape(a_transport.relpath(url))
915
except errors.NotBranchError, e:
918
new_t = a_transport.clone('..')
919
except errors.InvalidURLJoin:
920
# reached the root, whatever that may be
921
raise errors.NotBranchError(path=url)
922
if new_t.base == a_transport.base:
923
# reached the root, whatever that may be
924
raise errors.NotBranchError(path=url)
927
def _get_tree_branch(self):
928
"""Return the branch and tree, if any, for this bzrdir.
930
Return None for tree if not present or inaccessible.
931
Raise NotBranchError if no branch is present.
932
:return: (tree, branch)
935
tree = self.open_workingtree()
936
except (errors.NoWorkingTree, errors.NotLocalUrl):
938
branch = self.open_branch()
944
def open_tree_or_branch(klass, location):
945
"""Return the branch and working tree at a location.
947
If there is no tree at the location, tree will be None.
948
If there is no branch at the location, an exception will be
950
:return: (tree, branch)
952
bzrdir = klass.open(location)
953
return bzrdir._get_tree_branch()
956
def open_containing_tree_or_branch(klass, location):
957
"""Return the branch and working tree contained by a location.
959
Returns (tree, branch, relpath).
960
If there is no tree at containing the location, tree will be None.
961
If there is no branch containing the location, an exception will be
963
relpath is the portion of the path that is contained by the branch.
965
bzrdir, relpath = klass.open_containing(location)
966
tree, branch = bzrdir._get_tree_branch()
967
return tree, branch, relpath
970
def open_containing_tree_branch_or_repository(klass, location):
971
"""Return the working tree, branch and repo contained by a location.
973
Returns (tree, branch, repository, relpath).
974
If there is no tree containing the location, tree will be None.
975
If there is no branch containing the location, branch will be None.
976
If there is no repository containing the location, repository will be
978
relpath is the portion of the path that is contained by the innermost
981
If no tree, branch or repository is found, a NotBranchError is raised.
983
bzrdir, relpath = klass.open_containing(location)
985
tree, branch = bzrdir._get_tree_branch()
986
except errors.NotBranchError:
988
repo = bzrdir.find_repository()
989
return None, None, repo, relpath
990
except (errors.NoRepositoryPresent):
991
raise errors.NotBranchError(location)
992
return tree, branch, branch.repository, relpath
994
def open_repository(self, _unsupported=False):
995
"""Open the repository object at this BzrDir if one is present.
997
This will not follow the Branch object pointer - it's strictly a direct
998
open facility. Most client code should use open_branch().repository to
1001
:param _unsupported: a private parameter, not part of the api.
1002
TODO: static convenience version of this?
1004
raise NotImplementedError(self.open_repository)
1006
def open_workingtree(self, _unsupported=False,
1007
recommend_upgrade=True, from_branch=None):
1008
"""Open the workingtree object at this BzrDir if one is present.
1010
:param recommend_upgrade: Optional keyword parameter, when True (the
1011
default), emit through the ui module a recommendation that the user
1012
upgrade the working tree when the workingtree being opened is old
1013
(but still fully supported).
1014
:param from_branch: override bzrdir branch (for lightweight checkouts)
1016
raise NotImplementedError(self.open_workingtree)
1018
def has_branch(self):
1019
"""Tell if this bzrdir contains a branch.
1021
Note: if you're going to open the branch, you should just go ahead
1022
and try, and not ask permission first. (This method just opens the
1023
branch and discards it, and that's somewhat expensive.)
1028
except errors.NotBranchError:
1031
def has_workingtree(self):
1032
"""Tell if this bzrdir contains a working tree.
1034
This will still raise an exception if the bzrdir has a workingtree that
1035
is remote & inaccessible.
1037
Note: if you're going to open the working tree, you should just go ahead
1038
and try, and not ask permission first. (This method just opens the
1039
workingtree and discards it, and that's somewhat expensive.)
1042
self.open_workingtree(recommend_upgrade=False)
1044
except errors.NoWorkingTree:
1047
def _cloning_metadir(self):
1048
"""Produce a metadir suitable for cloning with.
1050
:returns: (destination_bzrdir_format, source_repository)
1052
result_format = self._format.__class__()
1055
branch = self.open_branch(ignore_fallbacks=True)
1056
source_repository = branch.repository
1057
result_format._branch_format = branch._format
1058
except errors.NotBranchError:
1059
source_branch = None
1060
source_repository = self.open_repository()
1061
except errors.NoRepositoryPresent:
1062
source_repository = None
1064
# XXX TODO: This isinstance is here because we have not implemented
1065
# the fix recommended in bug # 103195 - to delegate this choice the
1066
# repository itself.
1067
repo_format = source_repository._format
1068
if isinstance(repo_format, remote.RemoteRepositoryFormat):
1069
source_repository._ensure_real()
1070
repo_format = source_repository._real_repository._format
1071
result_format.repository_format = repo_format
1073
# TODO: Couldn't we just probe for the format in these cases,
1074
# rather than opening the whole tree? It would be a little
1075
# faster. mbp 20070401
1076
tree = self.open_workingtree(recommend_upgrade=False)
1077
except (errors.NoWorkingTree, errors.NotLocalUrl):
1078
result_format.workingtree_format = None
1080
result_format.workingtree_format = tree._format.__class__()
1081
return result_format, source_repository
1083
def cloning_metadir(self, require_stacking=False):
1084
"""Produce a metadir suitable for cloning or sprouting with.
1086
These operations may produce workingtrees (yes, even though they're
1087
"cloning" something that doesn't have a tree), so a viable workingtree
1088
format must be selected.
1090
:require_stacking: If True, non-stackable formats will be upgraded
1091
to similar stackable formats.
1092
:returns: a BzrDirFormat with all component formats either set
1093
appropriately or set to None if that component should not be
1096
format, repository = self._cloning_metadir()
1097
if format._workingtree_format is None:
1099
if repository is None:
1100
# No repository either
1102
# We have a repository, so set a working tree? (Why? This seems to
1103
# contradict the stated return value in the docstring).
1104
tree_format = repository._format._matchingbzrdir.workingtree_format
1105
format.workingtree_format = tree_format.__class__()
1106
if require_stacking:
1107
format.require_stacking()
1110
def checkout_metadir(self):
1111
return self.cloning_metadir()
1113
def sprout(self, url, revision_id=None, force_new_repo=False,
1114
recurse='down', possible_transports=None,
1115
accelerator_tree=None, hardlink=False, stacked=False,
1116
source_branch=None, create_tree_if_local=True):
1117
"""Create a copy of this bzrdir prepared for use as a new line of
1120
If url's last component does not exist, it will be created.
1122
Attributes related to the identity of the source branch like
1123
branch nickname will be cleaned, a working tree is created
1124
whether one existed before or not; and a local branch is always
1127
if revision_id is not None, then the clone operation may tune
1128
itself to download less data.
1129
:param accelerator_tree: A tree which can be used for retrieving file
1130
contents more quickly than the revision tree, i.e. a workingtree.
1131
The revision tree will be used for cases where accelerator_tree's
1132
content is different.
1133
:param hardlink: If true, hard-link files from accelerator_tree,
1135
:param stacked: If true, create a stacked branch referring to the
1136
location of this control directory.
1137
:param create_tree_if_local: If true, a working-tree will be created
1138
when working locally.
1140
target_transport = get_transport(url, possible_transports)
1141
target_transport.ensure_base()
1142
cloning_format = self.cloning_metadir(stacked)
1143
# Create/update the result branch
1144
result = cloning_format.initialize_on_transport(target_transport)
1145
# if a stacked branch wasn't requested, we don't create one
1146
# even if the origin was stacked
1147
stacked_branch_url = None
1148
if source_branch is not None:
1150
stacked_branch_url = self.root_transport.base
1151
source_repository = source_branch.repository
1154
source_branch = self.open_branch()
1155
source_repository = source_branch.repository
1157
stacked_branch_url = self.root_transport.base
1158
except errors.NotBranchError:
1159
source_branch = None
1161
source_repository = self.open_repository()
1162
except errors.NoRepositoryPresent:
1163
source_repository = None
1164
repository_policy = result.determine_repository_policy(
1165
force_new_repo, stacked_branch_url, require_stacking=stacked)
1166
result_repo, is_new_repo = repository_policy.acquire_repository()
1167
if is_new_repo and revision_id is not None and not stacked:
1168
fetch_spec = graph.PendingAncestryResult(
1169
[revision_id], source_repository)
1172
if source_repository is not None:
1173
# Fetch while stacked to prevent unstacked fetch from
1175
if fetch_spec is None:
1176
result_repo.fetch(source_repository, revision_id=revision_id)
1178
result_repo.fetch(source_repository, fetch_spec=fetch_spec)
1180
if source_branch is None:
1181
# this is for sprouting a bzrdir without a branch; is that
1183
# Not especially, but it's part of the contract.
1184
result_branch = result.create_branch()
1186
result_branch = source_branch.sprout(result,
1187
revision_id=revision_id, repository_policy=repository_policy)
1188
mutter("created new branch %r" % (result_branch,))
1190
# Create/update the result working tree
1191
if (create_tree_if_local and
1192
isinstance(target_transport, local.LocalTransport) and
1193
(result_repo is None or result_repo.make_working_trees())):
1194
wt = result.create_workingtree(accelerator_tree=accelerator_tree,
1198
if wt.path2id('') is None:
1200
wt.set_root_id(self.open_workingtree.get_root_id())
1201
except errors.NoWorkingTree:
1207
if recurse == 'down':
1209
basis = wt.basis_tree()
1211
subtrees = basis.iter_references()
1212
elif result_branch is not None:
1213
basis = result_branch.basis_tree()
1215
subtrees = basis.iter_references()
1216
elif source_branch is not None:
1217
basis = source_branch.basis_tree()
1219
subtrees = basis.iter_references()
1224
for path, file_id in subtrees:
1225
target = urlutils.join(url, urlutils.escape(path))
1226
sublocation = source_branch.reference_parent(file_id, path)
1227
sublocation.bzrdir.sprout(target,
1228
basis.get_reference_revision(file_id, path),
1229
force_new_repo=force_new_repo, recurse=recurse,
1232
if basis is not None:
1236
def push_branch(self, source, revision_id=None, overwrite=False,
1238
"""Push the source branch into this BzrDir."""
1240
# If we can open a branch, use its direct repository, otherwise see
1241
# if there is a repository without a branch.
1243
br_to = self.open_branch()
1244
except errors.NotBranchError:
1245
# Didn't find a branch, can we find a repository?
1246
repository_to = self.find_repository()
1248
# Found a branch, so we must have found a repository
1249
repository_to = br_to.repository
1251
push_result = PushResult()
1252
push_result.source_branch = source
1254
# We have a repository but no branch, copy the revisions, and then
1256
repository_to.fetch(source.repository, revision_id=revision_id)
1257
br_to = source.clone(self, revision_id=revision_id)
1258
if source.get_push_location() is None or remember:
1259
source.set_push_location(br_to.base)
1260
push_result.stacked_on = None
1261
push_result.branch_push_result = None
1262
push_result.old_revno = None
1263
push_result.old_revid = _mod_revision.NULL_REVISION
1264
push_result.target_branch = br_to
1265
push_result.master_branch = None
1266
push_result.workingtree_updated = False
1268
# We have successfully opened the branch, remember if necessary:
1269
if source.get_push_location() is None or remember:
1270
source.set_push_location(br_to.base)
1272
tree_to = self.open_workingtree()
1273
except errors.NotLocalUrl:
1274
push_result.branch_push_result = source.push(br_to,
1275
overwrite, stop_revision=revision_id)
1276
push_result.workingtree_updated = False
1277
except errors.NoWorkingTree:
1278
push_result.branch_push_result = source.push(br_to,
1279
overwrite, stop_revision=revision_id)
1280
push_result.workingtree_updated = None # Not applicable
1282
tree_to.lock_write()
1284
push_result.branch_push_result = source.push(
1285
tree_to.branch, overwrite, stop_revision=revision_id)
1289
push_result.workingtree_updated = True
1290
push_result.old_revno = push_result.branch_push_result.old_revno
1291
push_result.old_revid = push_result.branch_push_result.old_revid
1292
push_result.target_branch = \
1293
push_result.branch_push_result.target_branch
1297
class BzrDirHooks(hooks.Hooks):
1298
"""Hooks for BzrDir operations."""
1301
"""Create the default hooks."""
1302
hooks.Hooks.__init__(self)
1303
self.create_hook(hooks.HookPoint('pre_open',
1304
"Invoked before attempting to open a BzrDir with the transport "
1305
"that the open will use.", (1, 14), None))
1307
# install the default hooks
1308
BzrDir.hooks = BzrDirHooks()
1311
class BzrDirPreSplitOut(BzrDir):
1312
"""A common class for the all-in-one formats."""
1314
def __init__(self, _transport, _format):
1315
"""See BzrDir.__init__."""
1316
super(BzrDirPreSplitOut, self).__init__(_transport, _format)
1317
self._control_files = lockable_files.LockableFiles(
1318
self.get_branch_transport(None),
1319
self._format._lock_file_name,
1320
self._format._lock_class)
1322
def break_lock(self):
1323
"""Pre-splitout bzrdirs do not suffer from stale locks."""
1324
raise NotImplementedError(self.break_lock)
1326
def cloning_metadir(self, require_stacking=False):
1327
"""Produce a metadir suitable for cloning with."""
1328
if require_stacking:
1329
return format_registry.make_bzrdir('1.6')
1330
return self._format.__class__()
1332
def clone(self, url, revision_id=None, force_new_repo=False,
1333
preserve_stacking=False):
1334
"""See BzrDir.clone().
1336
force_new_repo has no effect, since this family of formats always
1337
require a new repository.
1338
preserve_stacking has no effect, since no source branch using this
1339
family of formats can be stacked, so there is no stacking to preserve.
1341
self._make_tail(url)
1342
result = self._format._initialize_for_clone(url)
1343
self.open_repository().clone(result, revision_id=revision_id)
1344
from_branch = self.open_branch()
1345
from_branch.clone(result, revision_id=revision_id)
1347
tree = self.open_workingtree()
1348
except errors.NotLocalUrl:
1349
# make a new one, this format always has to have one.
1350
result._init_workingtree()
1355
def create_branch(self):
1356
"""See BzrDir.create_branch."""
1357
return self._format.get_branch_format().initialize(self)
1359
def destroy_branch(self):
1360
"""See BzrDir.destroy_branch."""
1361
raise errors.UnsupportedOperation(self.destroy_branch, self)
1363
def create_repository(self, shared=False):
1364
"""See BzrDir.create_repository."""
1366
raise errors.IncompatibleFormat('shared repository', self._format)
1367
return self.open_repository()
1369
def destroy_repository(self):
1370
"""See BzrDir.destroy_repository."""
1371
raise errors.UnsupportedOperation(self.destroy_repository, self)
1373
def create_workingtree(self, revision_id=None, from_branch=None,
1374
accelerator_tree=None, hardlink=False):
1375
"""See BzrDir.create_workingtree."""
1376
# The workingtree is sometimes created when the bzrdir is created,
1377
# but not when cloning.
1379
# this looks buggy but is not -really-
1380
# because this format creates the workingtree when the bzrdir is
1382
# clone and sprout will have set the revision_id
1383
# and that will have set it for us, its only
1384
# specific uses of create_workingtree in isolation
1385
# that can do wonky stuff here, and that only
1386
# happens for creating checkouts, which cannot be
1387
# done on this format anyway. So - acceptable wart.
1389
result = self.open_workingtree(recommend_upgrade=False)
1390
except errors.NoSuchFile:
1391
result = self._init_workingtree()
1392
if revision_id is not None:
1393
if revision_id == _mod_revision.NULL_REVISION:
1394
result.set_parent_ids([])
1396
result.set_parent_ids([revision_id])
1399
def _init_workingtree(self):
1400
from bzrlib.workingtree import WorkingTreeFormat2
1402
return WorkingTreeFormat2().initialize(self)
1403
except errors.NotLocalUrl:
1404
# Even though we can't access the working tree, we need to
1405
# create its control files.
1406
return WorkingTreeFormat2()._stub_initialize_on_transport(
1407
self.transport, self._control_files._file_mode)
1409
def destroy_workingtree(self):
1410
"""See BzrDir.destroy_workingtree."""
1411
raise errors.UnsupportedOperation(self.destroy_workingtree, self)
1413
def destroy_workingtree_metadata(self):
1414
"""See BzrDir.destroy_workingtree_metadata."""
1415
raise errors.UnsupportedOperation(self.destroy_workingtree_metadata,
1418
def get_branch_transport(self, branch_format):
1419
"""See BzrDir.get_branch_transport()."""
1420
if branch_format is None:
1421
return self.transport
1423
branch_format.get_format_string()
1424
except NotImplementedError:
1425
return self.transport
1426
raise errors.IncompatibleFormat(branch_format, self._format)
1428
def get_repository_transport(self, repository_format):
1429
"""See BzrDir.get_repository_transport()."""
1430
if repository_format is None:
1431
return self.transport
1433
repository_format.get_format_string()
1434
except NotImplementedError:
1435
return self.transport
1436
raise errors.IncompatibleFormat(repository_format, self._format)
1438
def get_workingtree_transport(self, workingtree_format):
1439
"""See BzrDir.get_workingtree_transport()."""
1440
if workingtree_format is None:
1441
return self.transport
1443
workingtree_format.get_format_string()
1444
except NotImplementedError:
1445
return self.transport
1446
raise errors.IncompatibleFormat(workingtree_format, self._format)
1448
def needs_format_conversion(self, format=None):
1449
"""See BzrDir.needs_format_conversion()."""
1450
# if the format is not the same as the system default,
1451
# an upgrade is needed.
1453
symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1454
% 'needs_format_conversion(format=None)')
1455
format = BzrDirFormat.get_default_format()
1456
return not isinstance(self._format, format.__class__)
1458
def open_branch(self, unsupported=False, ignore_fallbacks=False):
1459
"""See BzrDir.open_branch."""
1460
from bzrlib.branch import BzrBranchFormat4
1461
format = BzrBranchFormat4()
1462
self._check_supported(format, unsupported)
1463
return format.open(self, _found=True)
1465
def sprout(self, url, revision_id=None, force_new_repo=False,
1466
possible_transports=None, accelerator_tree=None,
1467
hardlink=False, stacked=False, create_tree_if_local=True,
1468
source_branch=None):
1469
"""See BzrDir.sprout()."""
1470
if source_branch is not None:
1471
my_branch = self.open_branch()
1472
if source_branch.base != my_branch.base:
1473
raise AssertionError(
1474
"source branch %r is not within %r with branch %r" %
1475
(source_branch, self, my_branch))
1477
raise errors.UnstackableBranchFormat(
1478
self._format, self.root_transport.base)
1479
if not create_tree_if_local:
1480
raise errors.MustHaveWorkingTree(
1481
self._format, self.root_transport.base)
1482
from bzrlib.workingtree import WorkingTreeFormat2
1483
self._make_tail(url)
1484
result = self._format._initialize_for_clone(url)
1486
self.open_repository().clone(result, revision_id=revision_id)
1487
except errors.NoRepositoryPresent:
1490
self.open_branch().sprout(result, revision_id=revision_id)
1491
except errors.NotBranchError:
1494
# we always want a working tree
1495
WorkingTreeFormat2().initialize(result,
1496
accelerator_tree=accelerator_tree,
1501
class BzrDir4(BzrDirPreSplitOut):
1502
"""A .bzr version 4 control object.
1504
This is a deprecated format and may be removed after sept 2006.
1507
def create_repository(self, shared=False):
1508
"""See BzrDir.create_repository."""
1509
return self._format.repository_format.initialize(self, shared)
1511
def needs_format_conversion(self, format=None):
1512
"""Format 4 dirs are always in need of conversion."""
1514
symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1515
% 'needs_format_conversion(format=None)')
1518
def open_repository(self):
1519
"""See BzrDir.open_repository."""
1520
from bzrlib.repofmt.weaverepo import RepositoryFormat4
1521
return RepositoryFormat4().open(self, _found=True)
1524
class BzrDir5(BzrDirPreSplitOut):
1525
"""A .bzr version 5 control object.
1527
This is a deprecated format and may be removed after sept 2006.
1530
def open_repository(self):
1531
"""See BzrDir.open_repository."""
1532
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1533
return RepositoryFormat5().open(self, _found=True)
1535
def open_workingtree(self, _unsupported=False,
1536
recommend_upgrade=True):
1537
"""See BzrDir.create_workingtree."""
1538
from bzrlib.workingtree import WorkingTreeFormat2
1539
wt_format = WorkingTreeFormat2()
1540
# we don't warn here about upgrades; that ought to be handled for the
1542
return wt_format.open(self, _found=True)
1545
class BzrDir6(BzrDirPreSplitOut):
1546
"""A .bzr version 6 control object.
1548
This is a deprecated format and may be removed after sept 2006.
1551
def open_repository(self):
1552
"""See BzrDir.open_repository."""
1553
from bzrlib.repofmt.weaverepo import RepositoryFormat6
1554
return RepositoryFormat6().open(self, _found=True)
1556
def open_workingtree(self, _unsupported=False,
1557
recommend_upgrade=True):
1558
"""See BzrDir.create_workingtree."""
1559
# we don't warn here about upgrades; that ought to be handled for the
1561
from bzrlib.workingtree import WorkingTreeFormat2
1562
return WorkingTreeFormat2().open(self, _found=True)
1565
class BzrDirMeta1(BzrDir):
1566
"""A .bzr meta version 1 control object.
1568
This is the first control object where the
1569
individual aspects are really split out: there are separate repository,
1570
workingtree and branch subdirectories and any subset of the three can be
1571
present within a BzrDir.
1574
def can_convert_format(self):
1575
"""See BzrDir.can_convert_format()."""
1578
def create_branch(self):
1579
"""See BzrDir.create_branch."""
1580
return self._format.get_branch_format().initialize(self)
1582
def destroy_branch(self):
1583
"""See BzrDir.create_branch."""
1584
self.transport.delete_tree('branch')
1586
def create_repository(self, shared=False):
1587
"""See BzrDir.create_repository."""
1588
return self._format.repository_format.initialize(self, shared)
1590
def destroy_repository(self):
1591
"""See BzrDir.destroy_repository."""
1592
self.transport.delete_tree('repository')
1594
def create_workingtree(self, revision_id=None, from_branch=None,
1595
accelerator_tree=None, hardlink=False):
1596
"""See BzrDir.create_workingtree."""
1597
return self._format.workingtree_format.initialize(
1598
self, revision_id, from_branch=from_branch,
1599
accelerator_tree=accelerator_tree, hardlink=hardlink)
1601
def destroy_workingtree(self):
1602
"""See BzrDir.destroy_workingtree."""
1603
wt = self.open_workingtree(recommend_upgrade=False)
1604
repository = wt.branch.repository
1605
empty = repository.revision_tree(_mod_revision.NULL_REVISION)
1606
wt.revert(old_tree=empty)
1607
self.destroy_workingtree_metadata()
1609
def destroy_workingtree_metadata(self):
1610
self.transport.delete_tree('checkout')
1612
def find_branch_format(self):
1613
"""Find the branch 'format' for this bzrdir.
1615
This might be a synthetic object for e.g. RemoteBranch and SVN.
1617
from bzrlib.branch import BranchFormat
1618
return BranchFormat.find_format(self)
1620
def _get_mkdir_mode(self):
1621
"""Figure out the mode to use when creating a bzrdir subdir."""
1622
temp_control = lockable_files.LockableFiles(self.transport, '',
1623
lockable_files.TransportLock)
1624
return temp_control._dir_mode
1626
def get_branch_reference(self):
1627
"""See BzrDir.get_branch_reference()."""
1628
from bzrlib.branch import BranchFormat
1629
format = BranchFormat.find_format(self)
1630
return format.get_reference(self)
1632
def get_branch_transport(self, branch_format):
1633
"""See BzrDir.get_branch_transport()."""
1634
if branch_format is None:
1635
return self.transport.clone('branch')
1637
branch_format.get_format_string()
1638
except NotImplementedError:
1639
raise errors.IncompatibleFormat(branch_format, self._format)
1641
self.transport.mkdir('branch', mode=self._get_mkdir_mode())
1642
except errors.FileExists:
1644
return self.transport.clone('branch')
1646
def get_repository_transport(self, repository_format):
1647
"""See BzrDir.get_repository_transport()."""
1648
if repository_format is None:
1649
return self.transport.clone('repository')
1651
repository_format.get_format_string()
1652
except NotImplementedError:
1653
raise errors.IncompatibleFormat(repository_format, self._format)
1655
self.transport.mkdir('repository', mode=self._get_mkdir_mode())
1656
except errors.FileExists:
1658
return self.transport.clone('repository')
1660
def get_workingtree_transport(self, workingtree_format):
1661
"""See BzrDir.get_workingtree_transport()."""
1662
if workingtree_format is None:
1663
return self.transport.clone('checkout')
1665
workingtree_format.get_format_string()
1666
except NotImplementedError:
1667
raise errors.IncompatibleFormat(workingtree_format, self._format)
1669
self.transport.mkdir('checkout', mode=self._get_mkdir_mode())
1670
except errors.FileExists:
1672
return self.transport.clone('checkout')
1674
def needs_format_conversion(self, format=None):
1675
"""See BzrDir.needs_format_conversion()."""
1677
symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1678
% 'needs_format_conversion(format=None)')
1680
format = BzrDirFormat.get_default_format()
1681
if not isinstance(self._format, format.__class__):
1682
# it is not a meta dir format, conversion is needed.
1684
# we might want to push this down to the repository?
1686
if not isinstance(self.open_repository()._format,
1687
format.repository_format.__class__):
1688
# the repository needs an upgrade.
1690
except errors.NoRepositoryPresent:
1693
if not isinstance(self.open_branch()._format,
1694
format.get_branch_format().__class__):
1695
# the branch needs an upgrade.
1697
except errors.NotBranchError:
1700
my_wt = self.open_workingtree(recommend_upgrade=False)
1701
if not isinstance(my_wt._format,
1702
format.workingtree_format.__class__):
1703
# the workingtree needs an upgrade.
1705
except (errors.NoWorkingTree, errors.NotLocalUrl):
1709
def open_branch(self, unsupported=False, ignore_fallbacks=False):
1710
"""See BzrDir.open_branch."""
1711
format = self.find_branch_format()
1712
self._check_supported(format, unsupported)
1713
return format.open(self, _found=True, ignore_fallbacks=ignore_fallbacks)
1715
def open_repository(self, unsupported=False):
1716
"""See BzrDir.open_repository."""
1717
from bzrlib.repository import RepositoryFormat
1718
format = RepositoryFormat.find_format(self)
1719
self._check_supported(format, unsupported)
1720
return format.open(self, _found=True)
1722
def open_workingtree(self, unsupported=False,
1723
recommend_upgrade=True):
1724
"""See BzrDir.open_workingtree."""
1725
from bzrlib.workingtree import WorkingTreeFormat
1726
format = WorkingTreeFormat.find_format(self)
1727
self._check_supported(format, unsupported,
1729
basedir=self.root_transport.base)
1730
return format.open(self, _found=True)
1732
def _get_config(self):
1733
return config.TransportConfig(self.transport, 'control.conf')
1736
class BzrDirFormat(object):
1737
"""An encapsulation of the initialization and open routines for a format.
1739
Formats provide three things:
1740
* An initialization routine,
1744
Formats are placed in a dict by their format string for reference
1745
during bzrdir opening. These should be subclasses of BzrDirFormat
1748
Once a format is deprecated, just deprecate the initialize and open
1749
methods on the format class. Do not deprecate the object, as the
1750
object will be created every system load.
1753
_default_format = None
1754
"""The default format used for new .bzr dirs."""
1757
"""The known formats."""
1759
_control_formats = []
1760
"""The registered control formats - .bzr, ....
1762
This is a list of BzrDirFormat objects.
1765
_control_server_formats = []
1766
"""The registered control server formats, e.g. RemoteBzrDirs.
1768
This is a list of BzrDirFormat objects.
1771
_lock_file_name = 'branch-lock'
1773
# _lock_class must be set in subclasses to the lock type, typ.
1774
# TransportLock or LockDir
1777
def find_format(klass, transport, _server_formats=True):
1778
"""Return the format present at transport."""
1780
formats = klass._control_server_formats + klass._control_formats
1782
formats = klass._control_formats
1783
for format in formats:
1785
return format.probe_transport(transport)
1786
except errors.NotBranchError:
1787
# this format does not find a control dir here.
1789
raise errors.NotBranchError(path=transport.base)
1792
def probe_transport(klass, transport):
1793
"""Return the .bzrdir style format present in a directory."""
1795
format_string = transport.get(".bzr/branch-format").read()
1796
except errors.NoSuchFile:
1797
raise errors.NotBranchError(path=transport.base)
1800
return klass._formats[format_string]
1802
raise errors.UnknownFormatError(format=format_string, kind='bzrdir')
1805
def get_default_format(klass):
1806
"""Return the current default format."""
1807
return klass._default_format
1809
def get_format_string(self):
1810
"""Return the ASCII format string that identifies this format."""
1811
raise NotImplementedError(self.get_format_string)
1813
def get_format_description(self):
1814
"""Return the short description for this format."""
1815
raise NotImplementedError(self.get_format_description)
1817
def get_converter(self, format=None):
1818
"""Return the converter to use to convert bzrdirs needing converts.
1820
This returns a bzrlib.bzrdir.Converter object.
1822
This should return the best upgrader to step this format towards the
1823
current default format. In the case of plugins we can/should provide
1824
some means for them to extend the range of returnable converters.
1826
:param format: Optional format to override the default format of the
1829
raise NotImplementedError(self.get_converter)
1831
def initialize(self, url, possible_transports=None):
1832
"""Create a bzr control dir at this url and return an opened copy.
1834
While not deprecated, this method is very specific and its use will
1835
lead to many round trips to setup a working environment. See
1836
initialize_on_transport_ex for a [nearly] all-in-one method.
1838
Subclasses should typically override initialize_on_transport
1839
instead of this method.
1841
return self.initialize_on_transport(get_transport(url,
1842
possible_transports))
1844
def initialize_on_transport(self, transport):
1845
"""Initialize a new bzrdir in the base directory of a Transport."""
1847
# can we hand off the request to the smart server rather than using
1849
client_medium = transport.get_smart_medium()
1850
except errors.NoSmartMedium:
1851
return self._initialize_on_transport_vfs(transport)
1853
# Current RPC's only know how to create bzr metadir1 instances, so
1854
# we still delegate to vfs methods if the requested format is not a
1856
if type(self) != BzrDirMetaFormat1:
1857
return self._initialize_on_transport_vfs(transport)
1858
remote_format = RemoteBzrDirFormat()
1859
self._supply_sub_formats_to(remote_format)
1860
return remote_format.initialize_on_transport(transport)
1862
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
1863
create_prefix=False, force_new_repo=False, stacked_on=None,
1864
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
1865
shared_repo=False, vfs_only=False):
1866
"""Create this format on transport.
1868
The directory to initialize will be created.
1870
:param force_new_repo: Do not use a shared repository for the target,
1871
even if one is available.
1872
:param create_prefix: Create any missing directories leading up to
1874
:param use_existing_dir: Use an existing directory if one exists.
1875
:param stacked_on: A url to stack any created branch on, None to follow
1876
any target stacking policy.
1877
:param stack_on_pwd: If stack_on is relative, the location it is
1879
:param repo_format_name: If non-None, a repository will be
1880
made-or-found. Should none be found, or if force_new_repo is True
1881
the repo_format_name is used to select the format of repository to
1883
:param make_working_trees: Control the setting of make_working_trees
1884
for a new shared repository when one is made. None to use whatever
1885
default the format has.
1886
:param shared_repo: Control whether made repositories are shared or
1888
:param vfs_only: If True do not attempt to use a smart server
1889
:return: repo, bzrdir, require_stacking, repository_policy. repo is
1890
None if none was created or found, bzrdir is always valid.
1891
require_stacking is the result of examining the stacked_on
1892
parameter and any stacking policy found for the target.
1895
# Try to hand off to a smart server
1897
client_medium = transport.get_smart_medium()
1898
except errors.NoSmartMedium:
1901
# TODO: lookup the local format from a server hint.
1902
remote_dir_format = RemoteBzrDirFormat()
1903
remote_dir_format._network_name = self.network_name()
1904
self._supply_sub_formats_to(remote_dir_format)
1905
return remote_dir_format.initialize_on_transport_ex(transport,
1906
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
1907
force_new_repo=force_new_repo, stacked_on=stacked_on,
1908
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
1909
make_working_trees=make_working_trees, shared_repo=shared_repo)
1910
# XXX: Refactor the create_prefix/no_create_prefix code into a
1911
# common helper function
1912
# The destination may not exist - if so make it according to policy.
1913
def make_directory(transport):
1914
transport.mkdir('.')
1916
def redirected(transport, e, redirection_notice):
1917
note(redirection_notice)
1918
return transport._redirected_to(e.source, e.target)
1920
transport = do_catching_redirections(make_directory, transport,
1922
except errors.FileExists:
1923
if not use_existing_dir:
1925
except errors.NoSuchFile:
1926
if not create_prefix:
1928
transport.create_prefix()
1930
require_stacking = (stacked_on is not None)
1931
# Now the target directory exists, but doesn't have a .bzr
1932
# directory. So we need to create it, along with any work to create
1933
# all of the dependent branches, etc.
1935
result = self.initialize_on_transport(transport)
1936
if repo_format_name:
1938
# use a custom format
1939
result._format.repository_format = \
1940
repository.network_format_registry.get(repo_format_name)
1941
except AttributeError:
1942
# The format didn't permit it to be set.
1944
# A repository is desired, either in-place or shared.
1945
repository_policy = result.determine_repository_policy(
1946
force_new_repo, stacked_on, stack_on_pwd,
1947
require_stacking=require_stacking)
1948
result_repo, is_new_repo = repository_policy.acquire_repository(
1949
make_working_trees, shared_repo)
1950
if not require_stacking and repository_policy._require_stacking:
1951
require_stacking = True
1952
result._format.require_stacking()
1953
result_repo.lock_write()
1956
repository_policy = None
1957
return result_repo, result, require_stacking, repository_policy
1959
def _initialize_on_transport_vfs(self, transport):
1960
"""Initialize a new bzrdir using VFS calls.
1962
:param transport: The transport to create the .bzr directory in.
1965
# Since we are creating a .bzr directory, inherit the
1966
# mode from the root directory
1967
temp_control = lockable_files.LockableFiles(transport,
1968
'', lockable_files.TransportLock)
1969
temp_control._transport.mkdir('.bzr',
1970
# FIXME: RBC 20060121 don't peek under
1972
mode=temp_control._dir_mode)
1973
if sys.platform == 'win32' and isinstance(transport, local.LocalTransport):
1974
win32utils.set_file_attr_hidden(transport._abspath('.bzr'))
1975
file_mode = temp_control._file_mode
1977
bzrdir_transport = transport.clone('.bzr')
1978
utf8_files = [('README',
1979
"This is a Bazaar control directory.\n"
1980
"Do not change any files in this directory.\n"
1981
"See http://bazaar-vcs.org/ for more information about Bazaar.\n"),
1982
('branch-format', self.get_format_string()),
1984
# NB: no need to escape relative paths that are url safe.
1985
control_files = lockable_files.LockableFiles(bzrdir_transport,
1986
self._lock_file_name, self._lock_class)
1987
control_files.create_lock()
1988
control_files.lock_write()
1990
for (filename, content) in utf8_files:
1991
bzrdir_transport.put_bytes(filename, content,
1994
control_files.unlock()
1995
return self.open(transport, _found=True)
1997
def is_supported(self):
1998
"""Is this format supported?
2000
Supported formats must be initializable and openable.
2001
Unsupported formats may not support initialization or committing or
2002
some other features depending on the reason for not being supported.
2006
def network_name(self):
2007
"""A simple byte string uniquely identifying this format for RPC calls.
2009
Bzr control formats use thir disk format string to identify the format
2010
over the wire. Its possible that other control formats have more
2011
complex detection requirements, so we permit them to use any unique and
2012
immutable string they desire.
2014
raise NotImplementedError(self.network_name)
2016
def same_model(self, target_format):
2017
return (self.repository_format.rich_root_data ==
2018
target_format.rich_root_data)
2021
def known_formats(klass):
2022
"""Return all the known formats.
2024
Concrete formats should override _known_formats.
2026
# There is double indirection here to make sure that control
2027
# formats used by more than one dir format will only be probed
2028
# once. This can otherwise be quite expensive for remote connections.
2030
for format in klass._control_formats:
2031
result.update(format._known_formats())
2035
def _known_formats(klass):
2036
"""Return the known format instances for this control format."""
2037
return set(klass._formats.values())
2039
def open(self, transport, _found=False):
2040
"""Return an instance of this format for the dir transport points at.
2042
_found is a private parameter, do not use it.
2045
found_format = BzrDirFormat.find_format(transport)
2046
if not isinstance(found_format, self.__class__):
2047
raise AssertionError("%s was asked to open %s, but it seems to need "
2049
% (self, transport, found_format))
2050
# Allow subclasses - use the found format.
2051
self._supply_sub_formats_to(found_format)
2052
return found_format._open(transport)
2053
return self._open(transport)
2055
def _open(self, transport):
2056
"""Template method helper for opening BzrDirectories.
2058
This performs the actual open and any additional logic or parameter
2061
raise NotImplementedError(self._open)
2064
def register_format(klass, format):
2065
klass._formats[format.get_format_string()] = format
2066
# bzr native formats have a network name of their format string.
2067
network_format_registry.register(format.get_format_string(), format.__class__)
2070
def register_control_format(klass, format):
2071
"""Register a format that does not use '.bzr' for its control dir.
2073
TODO: This should be pulled up into a 'ControlDirFormat' base class
2074
which BzrDirFormat can inherit from, and renamed to register_format
2075
there. It has been done without that for now for simplicity of
2078
klass._control_formats.append(format)
2081
def register_control_server_format(klass, format):
2082
"""Register a control format for client-server environments.
2084
These formats will be tried before ones registered with
2085
register_control_format. This gives implementations that decide to the
2086
chance to grab it before anything looks at the contents of the format
2089
klass._control_server_formats.append(format)
2092
def _set_default_format(klass, format):
2093
"""Set default format (for testing behavior of defaults only)"""
2094
klass._default_format = format
2098
return self.get_format_description().rstrip()
2100
def _supply_sub_formats_to(self, other_format):
2101
"""Give other_format the same values for sub formats as this has.
2103
This method is expected to be used when parameterising a
2104
RemoteBzrDirFormat instance with the parameters from a
2105
BzrDirMetaFormat1 instance.
2107
:param other_format: other_format is a format which should be
2108
compatible with whatever sub formats are supported by self.
2113
def unregister_format(klass, format):
2114
del klass._formats[format.get_format_string()]
2117
def unregister_control_format(klass, format):
2118
klass._control_formats.remove(format)
2121
class BzrDirFormat4(BzrDirFormat):
2122
"""Bzr dir format 4.
2124
This format is a combined format for working tree, branch and repository.
2126
- Format 1 working trees [always]
2127
- Format 4 branches [always]
2128
- Format 4 repositories [always]
2130
This format is deprecated: it indexes texts using a text it which is
2131
removed in format 5; write support for this format has been removed.
2134
_lock_class = lockable_files.TransportLock
2136
def get_format_string(self):
2137
"""See BzrDirFormat.get_format_string()."""
2138
return "Bazaar-NG branch, format 0.0.4\n"
2140
def get_format_description(self):
2141
"""See BzrDirFormat.get_format_description()."""
2142
return "All-in-one format 4"
2144
def get_converter(self, format=None):
2145
"""See BzrDirFormat.get_converter()."""
2146
# there is one and only one upgrade path here.
2147
return ConvertBzrDir4To5()
2149
def initialize_on_transport(self, transport):
2150
"""Format 4 branches cannot be created."""
2151
raise errors.UninitializableFormat(self)
2153
def is_supported(self):
2154
"""Format 4 is not supported.
2156
It is not supported because the model changed from 4 to 5 and the
2157
conversion logic is expensive - so doing it on the fly was not
2162
def network_name(self):
2163
return self.get_format_string()
2165
def _open(self, transport):
2166
"""See BzrDirFormat._open."""
2167
return BzrDir4(transport, self)
2169
def __return_repository_format(self):
2170
"""Circular import protection."""
2171
from bzrlib.repofmt.weaverepo import RepositoryFormat4
2172
return RepositoryFormat4()
2173
repository_format = property(__return_repository_format)
2176
class BzrDirFormatAllInOne(BzrDirFormat):
2177
"""Common class for formats before meta-dirs."""
2179
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
2180
create_prefix=False, force_new_repo=False, stacked_on=None,
2181
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
2183
"""See BzrDirFormat.initialize_on_transport_ex."""
2184
require_stacking = (stacked_on is not None)
2185
# Format 5 cannot stack, but we've been asked to - actually init
2187
if require_stacking:
2188
format = BzrDirMetaFormat1()
2189
return format.initialize_on_transport_ex(transport,
2190
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2191
force_new_repo=force_new_repo, stacked_on=stacked_on,
2192
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2193
make_working_trees=make_working_trees, shared_repo=shared_repo)
2194
return BzrDirFormat.initialize_on_transport_ex(self, transport,
2195
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2196
force_new_repo=force_new_repo, stacked_on=stacked_on,
2197
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2198
make_working_trees=make_working_trees, shared_repo=shared_repo)
2201
class BzrDirFormat5(BzrDirFormatAllInOne):
2202
"""Bzr control format 5.
2204
This format is a combined format for working tree, branch and repository.
2206
- Format 2 working trees [always]
2207
- Format 4 branches [always]
2208
- Format 5 repositories [always]
2209
Unhashed stores in the repository.
2212
_lock_class = lockable_files.TransportLock
2214
def get_format_string(self):
2215
"""See BzrDirFormat.get_format_string()."""
2216
return "Bazaar-NG branch, format 5\n"
2218
def get_branch_format(self):
2219
from bzrlib import branch
2220
return branch.BzrBranchFormat4()
2222
def get_format_description(self):
2223
"""See BzrDirFormat.get_format_description()."""
2224
return "All-in-one format 5"
2226
def get_converter(self, format=None):
2227
"""See BzrDirFormat.get_converter()."""
2228
# there is one and only one upgrade path here.
2229
return ConvertBzrDir5To6()
2231
def _initialize_for_clone(self, url):
2232
return self.initialize_on_transport(get_transport(url), _cloning=True)
2234
def initialize_on_transport(self, transport, _cloning=False):
2235
"""Format 5 dirs always have working tree, branch and repository.
2237
Except when they are being cloned.
2239
from bzrlib.branch import BzrBranchFormat4
2240
from bzrlib.repofmt.weaverepo import RepositoryFormat5
2241
result = (super(BzrDirFormat5, self).initialize_on_transport(transport))
2242
RepositoryFormat5().initialize(result, _internal=True)
2244
branch = BzrBranchFormat4().initialize(result)
2245
result._init_workingtree()
2248
def network_name(self):
2249
return self.get_format_string()
2251
def _open(self, transport):
2252
"""See BzrDirFormat._open."""
2253
return BzrDir5(transport, self)
2255
def __return_repository_format(self):
2256
"""Circular import protection."""
2257
from bzrlib.repofmt.weaverepo import RepositoryFormat5
2258
return RepositoryFormat5()
2259
repository_format = property(__return_repository_format)
2262
class BzrDirFormat6(BzrDirFormatAllInOne):
2263
"""Bzr control format 6.
2265
This format is a combined format for working tree, branch and repository.
2267
- Format 2 working trees [always]
2268
- Format 4 branches [always]
2269
- Format 6 repositories [always]
2272
_lock_class = lockable_files.TransportLock
2274
def get_format_string(self):
2275
"""See BzrDirFormat.get_format_string()."""
2276
return "Bazaar-NG branch, format 6\n"
2278
def get_format_description(self):
2279
"""See BzrDirFormat.get_format_description()."""
2280
return "All-in-one format 6"
2282
def get_branch_format(self):
2283
from bzrlib import branch
2284
return branch.BzrBranchFormat4()
2286
def get_converter(self, format=None):
2287
"""See BzrDirFormat.get_converter()."""
2288
# there is one and only one upgrade path here.
2289
return ConvertBzrDir6ToMeta()
2291
def _initialize_for_clone(self, url):
2292
return self.initialize_on_transport(get_transport(url), _cloning=True)
2294
def initialize_on_transport(self, transport, _cloning=False):
2295
"""Format 6 dirs always have working tree, branch and repository.
2297
Except when they are being cloned.
2299
from bzrlib.branch import BzrBranchFormat4
2300
from bzrlib.repofmt.weaverepo import RepositoryFormat6
2301
result = super(BzrDirFormat6, self).initialize_on_transport(transport)
2302
RepositoryFormat6().initialize(result, _internal=True)
2304
branch = BzrBranchFormat4().initialize(result)
2305
result._init_workingtree()
2308
def network_name(self):
2309
return self.get_format_string()
2311
def _open(self, transport):
2312
"""See BzrDirFormat._open."""
2313
return BzrDir6(transport, self)
2315
def __return_repository_format(self):
2316
"""Circular import protection."""
2317
from bzrlib.repofmt.weaverepo import RepositoryFormat6
2318
return RepositoryFormat6()
2319
repository_format = property(__return_repository_format)
2322
class BzrDirMetaFormat1(BzrDirFormat):
2323
"""Bzr meta control format 1
2325
This is the first format with split out working tree, branch and repository
2328
- Format 3 working trees [optional]
2329
- Format 5 branches [optional]
2330
- Format 7 repositories [optional]
2333
_lock_class = lockdir.LockDir
2336
self._workingtree_format = None
2337
self._branch_format = None
2338
self._repository_format = None
2340
def __eq__(self, other):
2341
if other.__class__ is not self.__class__:
2343
if other.repository_format != self.repository_format:
2345
if other.workingtree_format != self.workingtree_format:
2349
def __ne__(self, other):
2350
return not self == other
2352
def get_branch_format(self):
2353
if self._branch_format is None:
2354
from bzrlib.branch import BranchFormat
2355
self._branch_format = BranchFormat.get_default_format()
2356
return self._branch_format
2358
def set_branch_format(self, format):
2359
self._branch_format = format
2361
def require_stacking(self, stack_on=None, possible_transports=None,
2363
"""We have a request to stack, try to ensure the formats support it.
2365
:param stack_on: If supplied, it is the URL to a branch that we want to
2366
stack on. Check to see if that format supports stacking before
2369
# Stacking is desired. requested by the target, but does the place it
2370
# points at support stacking? If it doesn't then we should
2371
# not implicitly upgrade. We check this here.
2372
new_repo_format = None
2373
new_branch_format = None
2375
# a bit of state for get_target_branch so that we don't try to open it
2376
# 2 times, for both repo *and* branch
2377
target = [None, False, None] # target_branch, checked, upgrade anyway
2378
def get_target_branch():
2380
# We've checked, don't check again
2382
if stack_on is None:
2383
# No target format, that means we want to force upgrading
2384
target[:] = [None, True, True]
2387
target_dir = BzrDir.open(stack_on,
2388
possible_transports=possible_transports)
2389
except errors.NotBranchError:
2390
# Nothing there, don't change formats
2391
target[:] = [None, True, False]
2393
except errors.JailBreak:
2394
# JailBreak, JFDI and upgrade anyway
2395
target[:] = [None, True, True]
2398
target_branch = target_dir.open_branch()
2399
except errors.NotBranchError:
2400
# No branch, don't upgrade formats
2401
target[:] = [None, True, False]
2403
target[:] = [target_branch, True, False]
2406
if (not _skip_repo and
2407
not self.repository_format.supports_external_lookups):
2408
# We need to upgrade the Repository.
2409
target_branch, _, do_upgrade = get_target_branch()
2410
if target_branch is None:
2411
# We don't have a target branch, should we upgrade anyway?
2413
# stack_on is inaccessible, JFDI.
2414
# TODO: bad monkey, hard-coded formats...
2415
if self.repository_format.rich_root_data:
2416
new_repo_format = pack_repo.RepositoryFormatKnitPack5RichRoot()
2418
new_repo_format = pack_repo.RepositoryFormatKnitPack5()
2420
# If the target already supports stacking, then we know the
2421
# project is already able to use stacking, so auto-upgrade
2423
new_repo_format = target_branch.repository._format
2424
if not new_repo_format.supports_external_lookups:
2425
# target doesn't, source doesn't, so don't auto upgrade
2427
new_repo_format = None
2428
if new_repo_format is not None:
2429
self.repository_format = new_repo_format
2430
note('Source repository format does not support stacking,'
2431
' using format:\n %s',
2432
new_repo_format.get_format_description())
2434
if not self.get_branch_format().supports_stacking():
2435
# We just checked the repo, now lets check if we need to
2436
# upgrade the branch format
2437
target_branch, _, do_upgrade = get_target_branch()
2438
if target_branch is None:
2440
# TODO: bad monkey, hard-coded formats...
2441
new_branch_format = branch.BzrBranchFormat7()
2443
new_branch_format = target_branch._format
2444
if not new_branch_format.supports_stacking():
2445
new_branch_format = None
2446
if new_branch_format is not None:
2447
# Does support stacking, use its format.
2448
self.set_branch_format(new_branch_format)
2449
note('Source branch format does not support stacking,'
2450
' using format:\n %s',
2451
new_branch_format.get_format_description())
2453
def get_converter(self, format=None):
2454
"""See BzrDirFormat.get_converter()."""
2456
format = BzrDirFormat.get_default_format()
2457
if not isinstance(self, format.__class__):
2458
# converting away from metadir is not implemented
2459
raise NotImplementedError(self.get_converter)
2460
return ConvertMetaToMeta(format)
2462
def get_format_string(self):
2463
"""See BzrDirFormat.get_format_string()."""
2464
return "Bazaar-NG meta directory, format 1\n"
2466
def get_format_description(self):
2467
"""See BzrDirFormat.get_format_description()."""
2468
return "Meta directory format 1"
2470
def network_name(self):
2471
return self.get_format_string()
2473
def _open(self, transport):
2474
"""See BzrDirFormat._open."""
2475
# Create a new format instance because otherwise initialisation of new
2476
# metadirs share the global default format object leading to alias
2478
format = BzrDirMetaFormat1()
2479
self._supply_sub_formats_to(format)
2480
return BzrDirMeta1(transport, format)
2482
def __return_repository_format(self):
2483
"""Circular import protection."""
2484
if self._repository_format:
2485
return self._repository_format
2486
from bzrlib.repository import RepositoryFormat
2487
return RepositoryFormat.get_default_format()
2489
def _set_repository_format(self, value):
2490
"""Allow changing the repository format for metadir formats."""
2491
self._repository_format = value
2493
repository_format = property(__return_repository_format,
2494
_set_repository_format)
2496
def _supply_sub_formats_to(self, other_format):
2497
"""Give other_format the same values for sub formats as this has.
2499
This method is expected to be used when parameterising a
2500
RemoteBzrDirFormat instance with the parameters from a
2501
BzrDirMetaFormat1 instance.
2503
:param other_format: other_format is a format which should be
2504
compatible with whatever sub formats are supported by self.
2507
if getattr(self, '_repository_format', None) is not None:
2508
other_format.repository_format = self.repository_format
2509
if self._branch_format is not None:
2510
other_format._branch_format = self._branch_format
2511
if self._workingtree_format is not None:
2512
other_format.workingtree_format = self.workingtree_format
2514
def __get_workingtree_format(self):
2515
if self._workingtree_format is None:
2516
from bzrlib.workingtree import WorkingTreeFormat
2517
self._workingtree_format = WorkingTreeFormat.get_default_format()
2518
return self._workingtree_format
2520
def __set_workingtree_format(self, wt_format):
2521
self._workingtree_format = wt_format
2523
workingtree_format = property(__get_workingtree_format,
2524
__set_workingtree_format)
2527
network_format_registry = registry.FormatRegistry()
2528
"""Registry of formats indexed by their network name.
2530
The network name for a BzrDirFormat is an identifier that can be used when
2531
referring to formats with smart server operations. See
2532
BzrDirFormat.network_name() for more detail.
2536
# Register bzr control format
2537
BzrDirFormat.register_control_format(BzrDirFormat)
2539
# Register bzr formats
2540
BzrDirFormat.register_format(BzrDirFormat4())
2541
BzrDirFormat.register_format(BzrDirFormat5())
2542
BzrDirFormat.register_format(BzrDirFormat6())
2543
__default_format = BzrDirMetaFormat1()
2544
BzrDirFormat.register_format(__default_format)
2545
BzrDirFormat._default_format = __default_format
2548
class Converter(object):
2549
"""Converts a disk format object from one format to another."""
2551
def convert(self, to_convert, pb):
2552
"""Perform the conversion of to_convert, giving feedback via pb.
2554
:param to_convert: The disk object to convert.
2555
:param pb: a progress bar to use for progress information.
2558
def step(self, message):
2559
"""Update the pb by a step."""
2561
self.pb.update(message, self.count, self.total)
2564
class ConvertBzrDir4To5(Converter):
2565
"""Converts format 4 bzr dirs to format 5."""
2568
super(ConvertBzrDir4To5, self).__init__()
2569
self.converted_revs = set()
2570
self.absent_revisions = set()
2574
def convert(self, to_convert, pb):
2575
"""See Converter.convert()."""
2576
self.bzrdir = to_convert
2578
self.pb.note('starting upgrade from format 4 to 5')
2579
if isinstance(self.bzrdir.transport, local.LocalTransport):
2580
self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
2581
self._convert_to_weaves()
2582
return BzrDir.open(self.bzrdir.root_transport.base)
2584
def _convert_to_weaves(self):
2585
self.pb.note('note: upgrade may be faster if all store files are ungzipped first')
2588
stat = self.bzrdir.transport.stat('weaves')
2589
if not S_ISDIR(stat.st_mode):
2590
self.bzrdir.transport.delete('weaves')
2591
self.bzrdir.transport.mkdir('weaves')
2592
except errors.NoSuchFile:
2593
self.bzrdir.transport.mkdir('weaves')
2594
# deliberately not a WeaveFile as we want to build it up slowly.
2595
self.inv_weave = Weave('inventory')
2596
# holds in-memory weaves for all files
2597
self.text_weaves = {}
2598
self.bzrdir.transport.delete('branch-format')
2599
self.branch = self.bzrdir.open_branch()
2600
self._convert_working_inv()
2601
rev_history = self.branch.revision_history()
2602
# to_read is a stack holding the revisions we still need to process;
2603
# appending to it adds new highest-priority revisions
2604
self.known_revisions = set(rev_history)
2605
self.to_read = rev_history[-1:]
2607
rev_id = self.to_read.pop()
2608
if (rev_id not in self.revisions
2609
and rev_id not in self.absent_revisions):
2610
self._load_one_rev(rev_id)
2612
to_import = self._make_order()
2613
for i, rev_id in enumerate(to_import):
2614
self.pb.update('converting revision', i, len(to_import))
2615
self._convert_one_rev(rev_id)
2617
self._write_all_weaves()
2618
self._write_all_revs()
2619
self.pb.note('upgraded to weaves:')
2620
self.pb.note(' %6d revisions and inventories', len(self.revisions))
2621
self.pb.note(' %6d revisions not present', len(self.absent_revisions))
2622
self.pb.note(' %6d texts', self.text_count)
2623
self._cleanup_spare_files_after_format4()
2624
self.branch._transport.put_bytes(
2626
BzrDirFormat5().get_format_string(),
2627
mode=self.bzrdir._get_file_mode())
2629
def _cleanup_spare_files_after_format4(self):
2630
# FIXME working tree upgrade foo.
2631
for n in 'merged-patches', 'pending-merged-patches':
2633
## assert os.path.getsize(p) == 0
2634
self.bzrdir.transport.delete(n)
2635
except errors.NoSuchFile:
2637
self.bzrdir.transport.delete_tree('inventory-store')
2638
self.bzrdir.transport.delete_tree('text-store')
2640
def _convert_working_inv(self):
2641
inv = xml4.serializer_v4.read_inventory(
2642
self.branch._transport.get('inventory'))
2643
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv, working=True)
2644
self.branch._transport.put_bytes('inventory', new_inv_xml,
2645
mode=self.bzrdir._get_file_mode())
2647
def _write_all_weaves(self):
2648
controlweaves = WeaveStore(self.bzrdir.transport, prefixed=False)
2649
weave_transport = self.bzrdir.transport.clone('weaves')
2650
weaves = WeaveStore(weave_transport, prefixed=False)
2651
transaction = WriteTransaction()
2655
for file_id, file_weave in self.text_weaves.items():
2656
self.pb.update('writing weave', i, len(self.text_weaves))
2657
weaves._put_weave(file_id, file_weave, transaction)
2659
self.pb.update('inventory', 0, 1)
2660
controlweaves._put_weave('inventory', self.inv_weave, transaction)
2661
self.pb.update('inventory', 1, 1)
2665
def _write_all_revs(self):
2666
"""Write all revisions out in new form."""
2667
self.bzrdir.transport.delete_tree('revision-store')
2668
self.bzrdir.transport.mkdir('revision-store')
2669
revision_transport = self.bzrdir.transport.clone('revision-store')
2671
from bzrlib.xml5 import serializer_v5
2672
from bzrlib.repofmt.weaverepo import RevisionTextStore
2673
revision_store = RevisionTextStore(revision_transport,
2674
serializer_v5, False, versionedfile.PrefixMapper(),
2675
lambda:True, lambda:True)
2677
for i, rev_id in enumerate(self.converted_revs):
2678
self.pb.update('write revision', i, len(self.converted_revs))
2679
text = serializer_v5.write_revision_to_string(
2680
self.revisions[rev_id])
2682
revision_store.add_lines(key, None, osutils.split_lines(text))
2686
def _load_one_rev(self, rev_id):
2687
"""Load a revision object into memory.
2689
Any parents not either loaded or abandoned get queued to be
2691
self.pb.update('loading revision',
2692
len(self.revisions),
2693
len(self.known_revisions))
2694
if not self.branch.repository.has_revision(rev_id):
2696
self.pb.note('revision {%s} not present in branch; '
2697
'will be converted as a ghost',
2699
self.absent_revisions.add(rev_id)
2701
rev = self.branch.repository.get_revision(rev_id)
2702
for parent_id in rev.parent_ids:
2703
self.known_revisions.add(parent_id)
2704
self.to_read.append(parent_id)
2705
self.revisions[rev_id] = rev
2707
def _load_old_inventory(self, rev_id):
2708
old_inv_xml = self.branch.repository.inventory_store.get(rev_id).read()
2709
inv = xml4.serializer_v4.read_inventory_from_string(old_inv_xml)
2710
inv.revision_id = rev_id
2711
rev = self.revisions[rev_id]
2714
def _load_updated_inventory(self, rev_id):
2715
inv_xml = self.inv_weave.get_text(rev_id)
2716
inv = xml5.serializer_v5.read_inventory_from_string(inv_xml, rev_id)
2719
def _convert_one_rev(self, rev_id):
2720
"""Convert revision and all referenced objects to new format."""
2721
rev = self.revisions[rev_id]
2722
inv = self._load_old_inventory(rev_id)
2723
present_parents = [p for p in rev.parent_ids
2724
if p not in self.absent_revisions]
2725
self._convert_revision_contents(rev, inv, present_parents)
2726
self._store_new_inv(rev, inv, present_parents)
2727
self.converted_revs.add(rev_id)
2729
def _store_new_inv(self, rev, inv, present_parents):
2730
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
2731
new_inv_sha1 = sha_string(new_inv_xml)
2732
self.inv_weave.add_lines(rev.revision_id,
2734
new_inv_xml.splitlines(True))
2735
rev.inventory_sha1 = new_inv_sha1
2737
def _convert_revision_contents(self, rev, inv, present_parents):
2738
"""Convert all the files within a revision.
2740
Also upgrade the inventory to refer to the text revision ids."""
2741
rev_id = rev.revision_id
2742
mutter('converting texts of revision {%s}',
2744
parent_invs = map(self._load_updated_inventory, present_parents)
2745
entries = inv.iter_entries()
2747
for path, ie in entries:
2748
self._convert_file_version(rev, ie, parent_invs)
2750
def _convert_file_version(self, rev, ie, parent_invs):
2751
"""Convert one version of one file.
2753
The file needs to be added into the weave if it is a merge
2754
of >=2 parents or if it's changed from its parent.
2756
file_id = ie.file_id
2757
rev_id = rev.revision_id
2758
w = self.text_weaves.get(file_id)
2761
self.text_weaves[file_id] = w
2762
text_changed = False
2763
parent_candiate_entries = ie.parent_candidates(parent_invs)
2764
heads = graph.Graph(self).heads(parent_candiate_entries.keys())
2765
# XXX: Note that this is unordered - and this is tolerable because
2766
# the previous code was also unordered.
2767
previous_entries = dict((head, parent_candiate_entries[head]) for head
2769
self.snapshot_ie(previous_entries, ie, w, rev_id)
2772
def get_parent_map(self, revision_ids):
2773
"""See graph.StackedParentsProvider.get_parent_map"""
2774
return dict((revision_id, self.revisions[revision_id])
2775
for revision_id in revision_ids
2776
if revision_id in self.revisions)
2778
def snapshot_ie(self, previous_revisions, ie, w, rev_id):
2779
# TODO: convert this logic, which is ~= snapshot to
2780
# a call to:. This needs the path figured out. rather than a work_tree
2781
# a v4 revision_tree can be given, or something that looks enough like
2782
# one to give the file content to the entry if it needs it.
2783
# and we need something that looks like a weave store for snapshot to
2785
#ie.snapshot(rev, PATH, previous_revisions, REVISION_TREE, InMemoryWeaveStore(self.text_weaves))
2786
if len(previous_revisions) == 1:
2787
previous_ie = previous_revisions.values()[0]
2788
if ie._unchanged(previous_ie):
2789
ie.revision = previous_ie.revision
2792
text = self.branch.repository._text_store.get(ie.text_id)
2793
file_lines = text.readlines()
2794
w.add_lines(rev_id, previous_revisions, file_lines)
2795
self.text_count += 1
2797
w.add_lines(rev_id, previous_revisions, [])
2798
ie.revision = rev_id
2800
def _make_order(self):
2801
"""Return a suitable order for importing revisions.
2803
The order must be such that an revision is imported after all
2804
its (present) parents.
2806
todo = set(self.revisions.keys())
2807
done = self.absent_revisions.copy()
2810
# scan through looking for a revision whose parents
2812
for rev_id in sorted(list(todo)):
2813
rev = self.revisions[rev_id]
2814
parent_ids = set(rev.parent_ids)
2815
if parent_ids.issubset(done):
2816
# can take this one now
2817
order.append(rev_id)
2823
class ConvertBzrDir5To6(Converter):
2824
"""Converts format 5 bzr dirs to format 6."""
2826
def convert(self, to_convert, pb):
2827
"""See Converter.convert()."""
2828
self.bzrdir = to_convert
2830
self.pb.note('starting upgrade from format 5 to 6')
2831
self._convert_to_prefixed()
2832
return BzrDir.open(self.bzrdir.root_transport.base)
2834
def _convert_to_prefixed(self):
2835
from bzrlib.store import TransportStore
2836
self.bzrdir.transport.delete('branch-format')
2837
for store_name in ["weaves", "revision-store"]:
2838
self.pb.note("adding prefixes to %s" % store_name)
2839
store_transport = self.bzrdir.transport.clone(store_name)
2840
store = TransportStore(store_transport, prefixed=True)
2841
for urlfilename in store_transport.list_dir('.'):
2842
filename = urlutils.unescape(urlfilename)
2843
if (filename.endswith(".weave") or
2844
filename.endswith(".gz") or
2845
filename.endswith(".sig")):
2846
file_id, suffix = os.path.splitext(filename)
2850
new_name = store._mapper.map((file_id,)) + suffix
2851
# FIXME keep track of the dirs made RBC 20060121
2853
store_transport.move(filename, new_name)
2854
except errors.NoSuchFile: # catches missing dirs strangely enough
2855
store_transport.mkdir(osutils.dirname(new_name))
2856
store_transport.move(filename, new_name)
2857
self.bzrdir.transport.put_bytes(
2859
BzrDirFormat6().get_format_string(),
2860
mode=self.bzrdir._get_file_mode())
2863
class ConvertBzrDir6ToMeta(Converter):
2864
"""Converts format 6 bzr dirs to metadirs."""
2866
def convert(self, to_convert, pb):
2867
"""See Converter.convert()."""
2868
from bzrlib.repofmt.weaverepo import RepositoryFormat7
2869
from bzrlib.branch import BzrBranchFormat5
2870
self.bzrdir = to_convert
2873
self.total = 20 # the steps we know about
2874
self.garbage_inventories = []
2875
self.dir_mode = self.bzrdir._get_dir_mode()
2876
self.file_mode = self.bzrdir._get_file_mode()
2878
self.pb.note('starting upgrade from format 6 to metadir')
2879
self.bzrdir.transport.put_bytes(
2881
"Converting to format 6",
2882
mode=self.file_mode)
2883
# its faster to move specific files around than to open and use the apis...
2884
# first off, nuke ancestry.weave, it was never used.
2886
self.step('Removing ancestry.weave')
2887
self.bzrdir.transport.delete('ancestry.weave')
2888
except errors.NoSuchFile:
2890
# find out whats there
2891
self.step('Finding branch files')
2892
last_revision = self.bzrdir.open_branch().last_revision()
2893
bzrcontents = self.bzrdir.transport.list_dir('.')
2894
for name in bzrcontents:
2895
if name.startswith('basis-inventory.'):
2896
self.garbage_inventories.append(name)
2897
# create new directories for repository, working tree and branch
2898
repository_names = [('inventory.weave', True),
2899
('revision-store', True),
2901
self.step('Upgrading repository ')
2902
self.bzrdir.transport.mkdir('repository', mode=self.dir_mode)
2903
self.make_lock('repository')
2904
# we hard code the formats here because we are converting into
2905
# the meta format. The meta format upgrader can take this to a
2906
# future format within each component.
2907
self.put_format('repository', RepositoryFormat7())
2908
for entry in repository_names:
2909
self.move_entry('repository', entry)
2911
self.step('Upgrading branch ')
2912
self.bzrdir.transport.mkdir('branch', mode=self.dir_mode)
2913
self.make_lock('branch')
2914
self.put_format('branch', BzrBranchFormat5())
2915
branch_files = [('revision-history', True),
2916
('branch-name', True),
2918
for entry in branch_files:
2919
self.move_entry('branch', entry)
2921
checkout_files = [('pending-merges', True),
2922
('inventory', True),
2923
('stat-cache', False)]
2924
# If a mandatory checkout file is not present, the branch does not have
2925
# a functional checkout. Do not create a checkout in the converted
2927
for name, mandatory in checkout_files:
2928
if mandatory and name not in bzrcontents:
2929
has_checkout = False
2933
if not has_checkout:
2934
self.pb.note('No working tree.')
2935
# If some checkout files are there, we may as well get rid of them.
2936
for name, mandatory in checkout_files:
2937
if name in bzrcontents:
2938
self.bzrdir.transport.delete(name)
2940
from bzrlib.workingtree import WorkingTreeFormat3
2941
self.step('Upgrading working tree')
2942
self.bzrdir.transport.mkdir('checkout', mode=self.dir_mode)
2943
self.make_lock('checkout')
2945
'checkout', WorkingTreeFormat3())
2946
self.bzrdir.transport.delete_multi(
2947
self.garbage_inventories, self.pb)
2948
for entry in checkout_files:
2949
self.move_entry('checkout', entry)
2950
if last_revision is not None:
2951
self.bzrdir.transport.put_bytes(
2952
'checkout/last-revision', last_revision)
2953
self.bzrdir.transport.put_bytes(
2955
BzrDirMetaFormat1().get_format_string(),
2956
mode=self.file_mode)
2957
return BzrDir.open(self.bzrdir.root_transport.base)
2959
def make_lock(self, name):
2960
"""Make a lock for the new control dir name."""
2961
self.step('Make %s lock' % name)
2962
ld = lockdir.LockDir(self.bzrdir.transport,
2964
file_modebits=self.file_mode,
2965
dir_modebits=self.dir_mode)
2968
def move_entry(self, new_dir, entry):
2969
"""Move then entry name into new_dir."""
2971
mandatory = entry[1]
2972
self.step('Moving %s' % name)
2974
self.bzrdir.transport.move(name, '%s/%s' % (new_dir, name))
2975
except errors.NoSuchFile:
2979
def put_format(self, dirname, format):
2980
self.bzrdir.transport.put_bytes('%s/format' % dirname,
2981
format.get_format_string(),
2985
class ConvertMetaToMeta(Converter):
2986
"""Converts the components of metadirs."""
2988
def __init__(self, target_format):
2989
"""Create a metadir to metadir converter.
2991
:param target_format: The final metadir format that is desired.
2993
self.target_format = target_format
2995
def convert(self, to_convert, pb):
2996
"""See Converter.convert()."""
2997
self.bzrdir = to_convert
3001
self.step('checking repository format')
3003
repo = self.bzrdir.open_repository()
3004
except errors.NoRepositoryPresent:
3007
if not isinstance(repo._format, self.target_format.repository_format.__class__):
3008
from bzrlib.repository import CopyConverter
3009
self.pb.note('starting repository conversion')
3010
converter = CopyConverter(self.target_format.repository_format)
3011
converter.convert(repo, pb)
3013
branch = self.bzrdir.open_branch()
3014
except errors.NotBranchError:
3017
# TODO: conversions of Branch and Tree should be done by
3018
# InterXFormat lookups/some sort of registry.
3019
# Avoid circular imports
3020
from bzrlib import branch as _mod_branch
3021
old = branch._format.__class__
3022
new = self.target_format.get_branch_format().__class__
3024
if (old == _mod_branch.BzrBranchFormat5 and
3025
new in (_mod_branch.BzrBranchFormat6,
3026
_mod_branch.BzrBranchFormat7,
3027
_mod_branch.BzrBranchFormat8)):
3028
branch_converter = _mod_branch.Converter5to6()
3029
elif (old == _mod_branch.BzrBranchFormat6 and
3030
new in (_mod_branch.BzrBranchFormat7,
3031
_mod_branch.BzrBranchFormat8)):
3032
branch_converter = _mod_branch.Converter6to7()
3033
elif (old == _mod_branch.BzrBranchFormat7 and
3034
new is _mod_branch.BzrBranchFormat8):
3035
branch_converter = _mod_branch.Converter7to8()
3037
raise errors.BadConversionTarget("No converter", new)
3038
branch_converter.convert(branch)
3039
branch = self.bzrdir.open_branch()
3040
old = branch._format.__class__
3042
tree = self.bzrdir.open_workingtree(recommend_upgrade=False)
3043
except (errors.NoWorkingTree, errors.NotLocalUrl):
3046
# TODO: conversions of Branch and Tree should be done by
3047
# InterXFormat lookups
3048
if (isinstance(tree, workingtree.WorkingTree3) and
3049
not isinstance(tree, workingtree_4.DirStateWorkingTree) and
3050
isinstance(self.target_format.workingtree_format,
3051
workingtree_4.DirStateWorkingTreeFormat)):
3052
workingtree_4.Converter3to4().convert(tree)
3053
if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
3054
not isinstance(tree, workingtree_4.WorkingTree5) and
3055
isinstance(self.target_format.workingtree_format,
3056
workingtree_4.WorkingTreeFormat5)):
3057
workingtree_4.Converter4to5().convert(tree)
3058
if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
3059
not isinstance(tree, workingtree_4.WorkingTree6) and
3060
isinstance(self.target_format.workingtree_format,
3061
workingtree_4.WorkingTreeFormat6)):
3062
workingtree_4.Converter4or5to6().convert(tree)
3066
# This is not in remote.py because it's relatively small, and needs to be
3067
# registered. Putting it in remote.py creates a circular import problem.
3068
# we can make it a lazy object if the control formats is turned into something
3070
class RemoteBzrDirFormat(BzrDirMetaFormat1):
3071
"""Format representing bzrdirs accessed via a smart server"""
3074
BzrDirMetaFormat1.__init__(self)
3075
self._network_name = None
3077
def get_format_description(self):
3078
return 'bzr remote bzrdir'
3080
def get_format_string(self):
3081
raise NotImplementedError(self.get_format_string)
3083
def network_name(self):
3084
if self._network_name:
3085
return self._network_name
3087
raise AssertionError("No network name set.")
3090
def probe_transport(klass, transport):
3091
"""Return a RemoteBzrDirFormat object if it looks possible."""
3093
medium = transport.get_smart_medium()
3094
except (NotImplementedError, AttributeError,
3095
errors.TransportNotPossible, errors.NoSmartMedium,
3096
errors.SmartProtocolError):
3097
# no smart server, so not a branch for this format type.
3098
raise errors.NotBranchError(path=transport.base)
3100
# Decline to open it if the server doesn't support our required
3101
# version (3) so that the VFS-based transport will do it.
3102
if medium.should_probe():
3104
server_version = medium.protocol_version()
3105
except errors.SmartProtocolError:
3106
# Apparently there's no usable smart server there, even though
3107
# the medium supports the smart protocol.
3108
raise errors.NotBranchError(path=transport.base)
3109
if server_version != '2':
3110
raise errors.NotBranchError(path=transport.base)
3113
def initialize_on_transport(self, transport):
3115
# hand off the request to the smart server
3116
client_medium = transport.get_smart_medium()
3117
except errors.NoSmartMedium:
3118
# TODO: lookup the local format from a server hint.
3119
local_dir_format = BzrDirMetaFormat1()
3120
return local_dir_format.initialize_on_transport(transport)
3121
client = _SmartClient(client_medium)
3122
path = client.remote_path_from_transport(transport)
3124
response = client.call('BzrDirFormat.initialize', path)
3125
except errors.ErrorFromSmartServer, err:
3126
remote._translate_error(err, path=path)
3127
if response[0] != 'ok':
3128
raise errors.SmartProtocolError('unexpected response code %s' % (response,))
3129
format = RemoteBzrDirFormat()
3130
self._supply_sub_formats_to(format)
3131
return remote.RemoteBzrDir(transport, format)
3133
def parse_NoneTrueFalse(self, arg):
3140
raise AssertionError("invalid arg %r" % arg)
3142
def _serialize_NoneTrueFalse(self, arg):
3149
def _serialize_NoneString(self, arg):
3152
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
3153
create_prefix=False, force_new_repo=False, stacked_on=None,
3154
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
3157
# hand off the request to the smart server
3158
client_medium = transport.get_smart_medium()
3159
except errors.NoSmartMedium:
3162
# Decline to open it if the server doesn't support our required
3163
# version (3) so that the VFS-based transport will do it.
3164
if client_medium.should_probe():
3166
server_version = client_medium.protocol_version()
3167
if server_version != '2':
3171
except errors.SmartProtocolError:
3172
# Apparently there's no usable smart server there, even though
3173
# the medium supports the smart protocol.
3178
client = _SmartClient(client_medium)
3179
path = client.remote_path_from_transport(transport)
3180
if client_medium._is_remote_before((1, 16)):
3183
# TODO: lookup the local format from a server hint.
3184
local_dir_format = BzrDirMetaFormat1()
3185
self._supply_sub_formats_to(local_dir_format)
3186
return local_dir_format.initialize_on_transport_ex(transport,
3187
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3188
force_new_repo=force_new_repo, stacked_on=stacked_on,
3189
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3190
make_working_trees=make_working_trees, shared_repo=shared_repo,
3192
return self._initialize_on_transport_ex_rpc(client, path, transport,
3193
use_existing_dir, create_prefix, force_new_repo, stacked_on,
3194
stack_on_pwd, repo_format_name, make_working_trees, shared_repo)
3196
def _initialize_on_transport_ex_rpc(self, client, path, transport,
3197
use_existing_dir, create_prefix, force_new_repo, stacked_on,
3198
stack_on_pwd, repo_format_name, make_working_trees, shared_repo):
3200
args.append(self._serialize_NoneTrueFalse(use_existing_dir))
3201
args.append(self._serialize_NoneTrueFalse(create_prefix))
3202
args.append(self._serialize_NoneTrueFalse(force_new_repo))
3203
args.append(self._serialize_NoneString(stacked_on))
3204
# stack_on_pwd is often/usually our transport
3207
stack_on_pwd = transport.relpath(stack_on_pwd)
3208
if not stack_on_pwd:
3210
except errors.PathNotChild:
3212
args.append(self._serialize_NoneString(stack_on_pwd))
3213
args.append(self._serialize_NoneString(repo_format_name))
3214
args.append(self._serialize_NoneTrueFalse(make_working_trees))
3215
args.append(self._serialize_NoneTrueFalse(shared_repo))
3216
if self._network_name is None:
3217
self._network_name = \
3218
BzrDirFormat.get_default_format().network_name()
3220
response = client.call('BzrDirFormat.initialize_ex_1.16',
3221
self.network_name(), path, *args)
3222
except errors.UnknownSmartMethod:
3223
client._medium._remember_remote_is_before((1,16))
3224
local_dir_format = BzrDirMetaFormat1()
3225
self._supply_sub_formats_to(local_dir_format)
3226
return local_dir_format.initialize_on_transport_ex(transport,
3227
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3228
force_new_repo=force_new_repo, stacked_on=stacked_on,
3229
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3230
make_working_trees=make_working_trees, shared_repo=shared_repo,
3232
except errors.ErrorFromSmartServer, err:
3233
remote._translate_error(err, path=path)
3234
repo_path = response[0]
3235
bzrdir_name = response[6]
3236
require_stacking = response[7]
3237
require_stacking = self.parse_NoneTrueFalse(require_stacking)
3238
format = RemoteBzrDirFormat()
3239
format._network_name = bzrdir_name
3240
self._supply_sub_formats_to(format)
3241
bzrdir = remote.RemoteBzrDir(transport, format, _client=client)
3243
repo_format = remote.response_tuple_to_repo_format(response[1:])
3244
if repo_path == '.':
3247
repo_bzrdir_format = RemoteBzrDirFormat()
3248
repo_bzrdir_format._network_name = response[5]
3249
repo_bzr = remote.RemoteBzrDir(transport.clone(repo_path),
3253
final_stack = response[8] or None
3254
final_stack_pwd = response[9] or None
3256
final_stack_pwd = urlutils.join(
3257
transport.base, final_stack_pwd)
3258
remote_repo = remote.RemoteRepository(repo_bzr, repo_format)
3259
if len(response) > 10:
3260
# Updated server verb that locks remotely.
3261
repo_lock_token = response[10] or None
3262
remote_repo.lock_write(repo_lock_token, _skip_rpc=True)
3264
remote_repo.dont_leave_lock_in_place()
3266
remote_repo.lock_write()
3267
policy = UseExistingRepository(remote_repo, final_stack,
3268
final_stack_pwd, require_stacking)
3269
policy.acquire_repository()
3273
if require_stacking:
3274
# The repo has already been created, but we need to make sure that
3275
# we'll make a stackable branch.
3276
bzrdir._format.require_stacking(_skip_repo=True)
3277
return remote_repo, bzrdir, require_stacking, policy
3279
def _open(self, transport):
3280
return remote.RemoteBzrDir(transport, self)
3282
def __eq__(self, other):
3283
if not isinstance(other, RemoteBzrDirFormat):
3285
return self.get_format_description() == other.get_format_description()
3287
def __return_repository_format(self):
3288
# Always return a RemoteRepositoryFormat object, but if a specific bzr
3289
# repository format has been asked for, tell the RemoteRepositoryFormat
3290
# that it should use that for init() etc.
3291
result = remote.RemoteRepositoryFormat()
3292
custom_format = getattr(self, '_repository_format', None)
3294
if isinstance(custom_format, remote.RemoteRepositoryFormat):
3295
return custom_format
3297
# We will use the custom format to create repositories over the
3298
# wire; expose its details like rich_root_data for code to
3300
result._custom_format = custom_format
3303
def get_branch_format(self):
3304
result = BzrDirMetaFormat1.get_branch_format(self)
3305
if not isinstance(result, remote.RemoteBranchFormat):
3306
new_result = remote.RemoteBranchFormat()
3307
new_result._custom_format = result
3309
self.set_branch_format(new_result)
3313
repository_format = property(__return_repository_format,
3314
BzrDirMetaFormat1._set_repository_format) #.im_func)
3317
BzrDirFormat.register_control_server_format(RemoteBzrDirFormat)
3320
class BzrDirFormatInfo(object):
3322
def __init__(self, native, deprecated, hidden, experimental):
3323
self.deprecated = deprecated
3324
self.native = native
3325
self.hidden = hidden
3326
self.experimental = experimental
3329
class BzrDirFormatRegistry(registry.Registry):
3330
"""Registry of user-selectable BzrDir subformats.
3332
Differs from BzrDirFormat._control_formats in that it provides sub-formats,
3333
e.g. BzrDirMeta1 with weave repository. Also, it's more user-oriented.
3337
"""Create a BzrDirFormatRegistry."""
3338
self._aliases = set()
3339
self._registration_order = list()
3340
super(BzrDirFormatRegistry, self).__init__()
3343
"""Return a set of the format names which are aliases."""
3344
return frozenset(self._aliases)
3346
def register_metadir(self, key,
3347
repository_format, help, native=True, deprecated=False,
3353
"""Register a metadir subformat.
3355
These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
3356
by the Repository/Branch/WorkingTreeformats.
3358
:param repository_format: The fully-qualified repository format class
3360
:param branch_format: Fully-qualified branch format class name as
3362
:param tree_format: Fully-qualified tree format class name as
3365
# This should be expanded to support setting WorkingTree and Branch
3366
# formats, once BzrDirMetaFormat1 supports that.
3367
def _load(full_name):
3368
mod_name, factory_name = full_name.rsplit('.', 1)
3370
mod = __import__(mod_name, globals(), locals(),
3372
except ImportError, e:
3373
raise ImportError('failed to load %s: %s' % (full_name, e))
3375
factory = getattr(mod, factory_name)
3376
except AttributeError:
3377
raise AttributeError('no factory %s in module %r'
3382
bd = BzrDirMetaFormat1()
3383
if branch_format is not None:
3384
bd.set_branch_format(_load(branch_format))
3385
if tree_format is not None:
3386
bd.workingtree_format = _load(tree_format)
3387
if repository_format is not None:
3388
bd.repository_format = _load(repository_format)
3390
self.register(key, helper, help, native, deprecated, hidden,
3391
experimental, alias)
3393
def register(self, key, factory, help, native=True, deprecated=False,
3394
hidden=False, experimental=False, alias=False):
3395
"""Register a BzrDirFormat factory.
3397
The factory must be a callable that takes one parameter: the key.
3398
It must produce an instance of the BzrDirFormat when called.
3400
This function mainly exists to prevent the info object from being
3403
registry.Registry.register(self, key, factory, help,
3404
BzrDirFormatInfo(native, deprecated, hidden, experimental))
3406
self._aliases.add(key)
3407
self._registration_order.append(key)
3409
def register_lazy(self, key, module_name, member_name, help, native=True,
3410
deprecated=False, hidden=False, experimental=False, alias=False):
3411
registry.Registry.register_lazy(self, key, module_name, member_name,
3412
help, BzrDirFormatInfo(native, deprecated, hidden, experimental))
3414
self._aliases.add(key)
3415
self._registration_order.append(key)
3417
def set_default(self, key):
3418
"""Set the 'default' key to be a clone of the supplied key.
3420
This method must be called once and only once.
3422
registry.Registry.register(self, 'default', self.get(key),
3423
self.get_help(key), info=self.get_info(key))
3424
self._aliases.add('default')
3426
def set_default_repository(self, key):
3427
"""Set the FormatRegistry default and Repository default.
3429
This is a transitional method while Repository.set_default_format
3432
if 'default' in self:
3433
self.remove('default')
3434
self.set_default(key)
3435
format = self.get('default')()
3437
def make_bzrdir(self, key):
3438
return self.get(key)()
3440
def help_topic(self, topic):
3442
default_realkey = None
3443
default_help = self.get_help('default')
3445
for key in self._registration_order:
3446
if key == 'default':
3448
help = self.get_help(key)
3449
if help == default_help:
3450
default_realkey = key
3452
help_pairs.append((key, help))
3454
def wrapped(key, help, info):
3456
help = '(native) ' + help
3457
return ':%s:\n%s\n\n' % (key,
3458
textwrap.fill(help, initial_indent=' ',
3459
subsequent_indent=' ',
3460
break_long_words=False))
3461
if default_realkey is not None:
3462
output += wrapped(default_realkey, '(default) %s' % default_help,
3463
self.get_info('default'))
3464
deprecated_pairs = []
3465
experimental_pairs = []
3466
for key, help in help_pairs:
3467
info = self.get_info(key)
3470
elif info.deprecated:
3471
deprecated_pairs.append((key, help))
3472
elif info.experimental:
3473
experimental_pairs.append((key, help))
3475
output += wrapped(key, help, info)
3476
output += "\nSee ``bzr help formats`` for more about storage formats."
3478
if len(experimental_pairs) > 0:
3479
other_output += "Experimental formats are shown below.\n\n"
3480
for key, help in experimental_pairs:
3481
info = self.get_info(key)
3482
other_output += wrapped(key, help, info)
3485
"No experimental formats are available.\n\n"
3486
if len(deprecated_pairs) > 0:
3487
other_output += "\nDeprecated formats are shown below.\n\n"
3488
for key, help in deprecated_pairs:
3489
info = self.get_info(key)
3490
other_output += wrapped(key, help, info)
3493
"\nNo deprecated formats are available.\n\n"
3495
"\nSee ``bzr help formats`` for more about storage formats."
3497
if topic == 'other-formats':
3503
class RepositoryAcquisitionPolicy(object):
3504
"""Abstract base class for repository acquisition policies.
3506
A repository acquisition policy decides how a BzrDir acquires a repository
3507
for a branch that is being created. The most basic policy decision is
3508
whether to create a new repository or use an existing one.
3510
def __init__(self, stack_on, stack_on_pwd, require_stacking):
3513
:param stack_on: A location to stack on
3514
:param stack_on_pwd: If stack_on is relative, the location it is
3516
:param require_stacking: If True, it is a failure to not stack.
3518
self._stack_on = stack_on
3519
self._stack_on_pwd = stack_on_pwd
3520
self._require_stacking = require_stacking
3522
def configure_branch(self, branch):
3523
"""Apply any configuration data from this policy to the branch.
3525
Default implementation sets repository stacking.
3527
if self._stack_on is None:
3529
if self._stack_on_pwd is None:
3530
stack_on = self._stack_on
3533
stack_on = urlutils.rebase_url(self._stack_on,
3535
branch.bzrdir.root_transport.base)
3536
except errors.InvalidRebaseURLs:
3537
stack_on = self._get_full_stack_on()
3539
branch.set_stacked_on_url(stack_on)
3540
except (errors.UnstackableBranchFormat,
3541
errors.UnstackableRepositoryFormat):
3542
if self._require_stacking:
3545
def _get_full_stack_on(self):
3546
"""Get a fully-qualified URL for the stack_on location."""
3547
if self._stack_on is None:
3549
if self._stack_on_pwd is None:
3550
return self._stack_on
3552
return urlutils.join(self._stack_on_pwd, self._stack_on)
3554
def _add_fallback(self, repository, possible_transports=None):
3555
"""Add a fallback to the supplied repository, if stacking is set."""
3556
stack_on = self._get_full_stack_on()
3557
if stack_on is None:
3560
stacked_dir = BzrDir.open(stack_on,
3561
possible_transports=possible_transports)
3562
except errors.JailBreak:
3563
# We keep the stacking details, but we are in the server code so
3564
# actually stacking is not needed.
3567
stacked_repo = stacked_dir.open_branch().repository
3568
except errors.NotBranchError:
3569
stacked_repo = stacked_dir.open_repository()
3571
repository.add_fallback_repository(stacked_repo)
3572
except errors.UnstackableRepositoryFormat:
3573
if self._require_stacking:
3576
self._require_stacking = True
3578
def acquire_repository(self, make_working_trees=None, shared=False):
3579
"""Acquire a repository for this bzrdir.
3581
Implementations may create a new repository or use a pre-exising
3583
:param make_working_trees: If creating a repository, set
3584
make_working_trees to this value (if non-None)
3585
:param shared: If creating a repository, make it shared if True
3586
:return: A repository, is_new_flag (True if the repository was
3589
raise NotImplemented(RepositoryAcquisitionPolicy.acquire_repository)
3592
class CreateRepository(RepositoryAcquisitionPolicy):
3593
"""A policy of creating a new repository"""
3595
def __init__(self, bzrdir, stack_on=None, stack_on_pwd=None,
3596
require_stacking=False):
3599
:param bzrdir: The bzrdir to create the repository on.
3600
:param stack_on: A location to stack on
3601
:param stack_on_pwd: If stack_on is relative, the location it is
3604
RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
3606
self._bzrdir = bzrdir
3608
def acquire_repository(self, make_working_trees=None, shared=False):
3609
"""Implementation of RepositoryAcquisitionPolicy.acquire_repository
3611
Creates the desired repository in the bzrdir we already have.
3613
stack_on = self._get_full_stack_on()
3615
format = self._bzrdir._format
3616
format.require_stacking(stack_on=stack_on,
3617
possible_transports=[self._bzrdir.root_transport])
3618
if not self._require_stacking:
3619
# We have picked up automatic stacking somewhere.
3620
note('Using default stacking branch %s at %s', self._stack_on,
3622
repository = self._bzrdir.create_repository(shared=shared)
3623
self._add_fallback(repository,
3624
possible_transports=[self._bzrdir.transport])
3625
if make_working_trees is not None:
3626
repository.set_make_working_trees(make_working_trees)
3627
return repository, True
3630
class UseExistingRepository(RepositoryAcquisitionPolicy):
3631
"""A policy of reusing an existing repository"""
3633
def __init__(self, repository, stack_on=None, stack_on_pwd=None,
3634
require_stacking=False):
3637
:param repository: The repository to use.
3638
:param stack_on: A location to stack on
3639
:param stack_on_pwd: If stack_on is relative, the location it is
3642
RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
3644
self._repository = repository
3646
def acquire_repository(self, make_working_trees=None, shared=False):
3647
"""Implementation of RepositoryAcquisitionPolicy.acquire_repository
3649
Returns an existing repository to use.
3651
self._add_fallback(self._repository,
3652
possible_transports=[self._repository.bzrdir.transport])
3653
return self._repository, False
3656
# Please register new formats after old formats so that formats
3657
# appear in chronological order and format descriptions can build
3659
format_registry = BzrDirFormatRegistry()
3660
# The pre-0.8 formats have their repository format network name registered in
3661
# repository.py. MetaDir formats have their repository format network name
3662
# inferred from their disk format string.
3663
format_registry.register('weave', BzrDirFormat6,
3664
'Pre-0.8 format. Slower than knit and does not'
3665
' support checkouts or shared repositories.',
3667
format_registry.register_metadir('metaweave',
3668
'bzrlib.repofmt.weaverepo.RepositoryFormat7',
3669
'Transitional format in 0.8. Slower than knit.',
3670
branch_format='bzrlib.branch.BzrBranchFormat5',
3671
tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3673
format_registry.register_metadir('knit',
3674
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3675
'Format using knits. Recommended for interoperation with bzr <= 0.14.',
3676
branch_format='bzrlib.branch.BzrBranchFormat5',
3677
tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3679
format_registry.register_metadir('dirstate',
3680
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3681
help='New in 0.15: Fast local operations. Compatible with bzr 0.8 and '
3682
'above when accessed over the network.',
3683
branch_format='bzrlib.branch.BzrBranchFormat5',
3684
# this uses bzrlib.workingtree.WorkingTreeFormat4 because importing
3685
# directly from workingtree_4 triggers a circular import.
3686
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3688
format_registry.register_metadir('dirstate-tags',
3689
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3690
help='New in 0.15: Fast local operations and improved scaling for '
3691
'network operations. Additionally adds support for tags.'
3692
' Incompatible with bzr < 0.15.',
3693
branch_format='bzrlib.branch.BzrBranchFormat6',
3694
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3696
format_registry.register_metadir('rich-root',
3697
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
3698
help='New in 1.0. Better handling of tree roots. Incompatible with'
3700
branch_format='bzrlib.branch.BzrBranchFormat6',
3701
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3703
format_registry.register_metadir('dirstate-with-subtree',
3704
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
3705
help='New in 0.15: Fast local operations and improved scaling for '
3706
'network operations. Additionally adds support for versioning nested '
3707
'bzr branches. Incompatible with bzr < 0.15.',
3708
branch_format='bzrlib.branch.BzrBranchFormat6',
3709
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3713
format_registry.register_metadir('pack-0.92',
3714
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack1',
3715
help='New in 0.92: Pack-based format with data compatible with '
3716
'dirstate-tags format repositories. Interoperates with '
3717
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3718
'Previously called knitpack-experimental. '
3719
'For more information, see '
3720
'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
3721
branch_format='bzrlib.branch.BzrBranchFormat6',
3722
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3724
format_registry.register_metadir('pack-0.92-subtree',
3725
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack3',
3726
help='New in 0.92: Pack-based format with data compatible with '
3727
'dirstate-with-subtree format repositories. Interoperates with '
3728
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3729
'Previously called knitpack-experimental. '
3730
'For more information, see '
3731
'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
3732
branch_format='bzrlib.branch.BzrBranchFormat6',
3733
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3737
format_registry.register_metadir('rich-root-pack',
3738
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
3739
help='New in 1.0: A variant of pack-0.92 that supports rich-root data '
3740
'(needed for bzr-svn and bzr-git).',
3741
branch_format='bzrlib.branch.BzrBranchFormat6',
3742
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3744
format_registry.register_metadir('1.6',
3745
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5',
3746
help='A format that allows a branch to indicate that there is another '
3747
'(stacked) repository that should be used to access data that is '
3748
'not present locally.',
3749
branch_format='bzrlib.branch.BzrBranchFormat7',
3750
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3752
format_registry.register_metadir('1.6.1-rich-root',
3753
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5RichRoot',
3754
help='A variant of 1.6 that supports rich-root data '
3755
'(needed for bzr-svn and bzr-git).',
3756
branch_format='bzrlib.branch.BzrBranchFormat7',
3757
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3759
format_registry.register_metadir('1.9',
3760
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3761
help='A repository format using B+tree indexes. These indexes '
3762
'are smaller in size, have smarter caching and provide faster '
3763
'performance for most operations.',
3764
branch_format='bzrlib.branch.BzrBranchFormat7',
3765
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3767
format_registry.register_metadir('1.9-rich-root',
3768
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
3769
help='A variant of 1.9 that supports rich-root data '
3770
'(needed for bzr-svn and bzr-git).',
3771
branch_format='bzrlib.branch.BzrBranchFormat7',
3772
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3774
format_registry.register_metadir('1.14',
3775
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3776
help='A working-tree format that supports content filtering.',
3777
branch_format='bzrlib.branch.BzrBranchFormat7',
3778
tree_format='bzrlib.workingtree.WorkingTreeFormat5',
3780
format_registry.register_metadir('1.14-rich-root',
3781
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
3782
help='A variant of 1.14 that supports rich-root data '
3783
'(needed for bzr-svn and bzr-git).',
3784
branch_format='bzrlib.branch.BzrBranchFormat7',
3785
tree_format='bzrlib.workingtree.WorkingTreeFormat5',
3787
# The following un-numbered 'development' formats should always just be aliases.
3788
format_registry.register_metadir('development-rich-root',
3789
'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
3790
help='Current development format. Supports rich roots. Can convert data '
3791
'to and from rich-root-pack (and anything compatible with '
3792
'rich-root-pack) format repositories. Repositories and branches in '
3793
'this format can only be read by bzr.dev. Please read '
3794
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3796
branch_format='bzrlib.branch.BzrBranchFormat7',
3797
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3801
format_registry.register_metadir('development-subtree',
3802
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment2Subtree',
3803
help='Current development format, subtree variant. Can convert data to and '
3804
'from pack-0.92-subtree (and anything compatible with '
3805
'pack-0.92-subtree) format repositories. Repositories and branches in '
3806
'this format can only be read by bzr.dev. Please read '
3807
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3809
branch_format='bzrlib.branch.BzrBranchFormat7',
3810
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3812
alias=False, # Restore to being an alias when an actual development subtree format is added
3813
# This current non-alias status is simply because we did not introduce a
3814
# chk based subtree format.
3817
# And the development formats above will have aliased one of the following:
3818
format_registry.register_metadir('development6-rich-root',
3819
'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
3820
help='pack-1.9 with 255-way hashed CHK inv, group compress, rich roots '
3822
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3824
branch_format='bzrlib.branch.BzrBranchFormat7',
3825
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3830
format_registry.register_metadir('development7-rich-root',
3831
'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK2',
3832
help='pack-1.9 with 255-way hashed CHK inv, bencode revision, group compress, '
3833
'rich roots. Please read '
3834
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3836
branch_format='bzrlib.branch.BzrBranchFormat7',
3837
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3842
format_registry.register_metadir('2a',
3843
'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
3844
help='First format for bzr 2.0 series.\n'
3845
'Uses group-compress storage.\n'
3846
'Provides rich roots which are a one-way transition.\n',
3847
# 'storage in packs, 255-way hashed CHK inventory, bencode revision, group compress, '
3848
# 'rich roots. Supported by bzr 1.16 and later.',
3849
branch_format='bzrlib.branch.BzrBranchFormat7',
3850
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3854
# The following format should be an alias for the rich root equivalent
3855
# of the default format
3856
format_registry.register_metadir('default-rich-root',
3857
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
3858
help='Default format, rich root variant. (needed for bzr-svn and bzr-git).',
3859
branch_format='bzrlib.branch.BzrBranchFormat6',
3860
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3863
# The current format that is made on 'bzr init'.
3864
format_registry.set_default('pack-0.92')
added
removed
bzrlib/bzrdir.py
