1
# Copyright (C) 2006-2010 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.
34
from bzrlib.lazy_import import lazy_import
35
lazy_import(globals(), """
36
from stat import S_ISDIR
50
revision as _mod_revision,
60
from bzrlib.osutils import (
63
from bzrlib.push import (
66
from bzrlib.repofmt import pack_repo
67
from bzrlib.smart.client import _SmartClient
68
from bzrlib.store.versioned import WeaveStore
69
from bzrlib.transactions import WriteTransaction
70
from bzrlib.transport import (
71
do_catching_redirections,
75
from bzrlib.weave import Weave
78
from bzrlib.trace import (
91
class ControlComponent(object):
92
"""Abstract base class for control directory components.
94
This provides interfaces that are common across bzrdirs,
95
repositories, branches, and workingtree control directories.
97
They all expose two urls and transports: the *user* URL is the
98
one that stops above the control directory (eg .bzr) and that
99
should normally be used in messages, and the *control* URL is
100
under that in eg .bzr/checkout and is used to read the control
103
This can be used as a mixin and is intended to fit with
108
def control_transport(self):
109
raise NotImplementedError
112
def control_url(self):
113
return self.control_transport.base
116
def user_transport(self):
117
raise NotImplementedError
121
return self.user_transport.base
124
class BzrDir(ControlComponent):
125
"""A .bzr control diretory.
127
BzrDir instances let you create or open any of the things that can be
128
found within .bzr - checkouts, branches and repositories.
131
the transport which this bzr dir is rooted at (i.e. file:///.../.bzr/)
132
:ivar root_transport:
133
a transport connected to the directory this bzr was opened from
134
(i.e. the parent directory holding the .bzr directory).
136
Everything in the bzrdir should have the same file permissions.
138
:cvar hooks: An instance of BzrDirHooks.
141
def break_lock(self):
142
"""Invoke break_lock on the first object in the bzrdir.
144
If there is a tree, the tree is opened and break_lock() called.
145
Otherwise, branch is tried, and finally repository.
147
# XXX: This seems more like a UI function than something that really
148
# belongs in this class.
150
thing_to_unlock = self.open_workingtree()
151
except (errors.NotLocalUrl, errors.NoWorkingTree):
153
thing_to_unlock = self.open_branch()
154
except errors.NotBranchError:
156
thing_to_unlock = self.open_repository()
157
except errors.NoRepositoryPresent:
159
thing_to_unlock.break_lock()
161
def can_convert_format(self):
162
"""Return true if this bzrdir is one whose format we can convert from."""
165
def check_conversion_target(self, target_format):
166
"""Check that a bzrdir as a whole can be converted to a new format."""
167
# The only current restriction is that the repository content can be
168
# fetched compatibly with the target.
169
target_repo_format = target_format.repository_format
171
self.open_repository()._format.check_conversion_target(
173
except errors.NoRepositoryPresent:
174
# No repo, no problem.
178
def _check_supported(format, allow_unsupported,
179
recommend_upgrade=True,
181
"""Give an error or warning on old formats.
183
:param format: may be any kind of format - workingtree, branch,
186
:param allow_unsupported: If true, allow opening
187
formats that are strongly deprecated, and which may
188
have limited functionality.
190
:param recommend_upgrade: If true (default), warn
191
the user through the ui object that they may wish
192
to upgrade the object.
194
# TODO: perhaps move this into a base Format class; it's not BzrDir
195
# specific. mbp 20070323
196
if not allow_unsupported and not format.is_supported():
197
# see open_downlevel to open legacy branches.
198
raise errors.UnsupportedFormatError(format=format)
199
if recommend_upgrade \
200
and getattr(format, 'upgrade_recommended', False):
201
ui.ui_factory.recommend_upgrade(
202
format.get_format_description(),
205
def clone(self, url, revision_id=None, force_new_repo=False,
206
preserve_stacking=False):
207
"""Clone this bzrdir and its contents to url verbatim.
209
:param url: The url create the clone at. If url's last component does
210
not exist, it will be created.
211
:param revision_id: The tip revision-id to use for any branch or
212
working tree. If not None, then the clone operation may tune
213
itself to download less data.
214
:param force_new_repo: Do not use a shared repository for the target
215
even if one is available.
216
:param preserve_stacking: When cloning a stacked branch, stack the
217
new branch on top of the other branch's stacked-on branch.
219
return self.clone_on_transport(get_transport(url),
220
revision_id=revision_id,
221
force_new_repo=force_new_repo,
222
preserve_stacking=preserve_stacking)
224
def clone_on_transport(self, transport, revision_id=None,
225
force_new_repo=False, preserve_stacking=False, stacked_on=None,
226
create_prefix=False, use_existing_dir=True):
227
"""Clone this bzrdir and its contents to transport verbatim.
229
:param transport: The transport for the location to produce the clone
230
at. If the target directory does not exist, it will be created.
231
:param revision_id: The tip revision-id to use for any branch or
232
working tree. If not None, then the clone operation may tune
233
itself to download less data.
234
:param force_new_repo: Do not use a shared repository for the target,
235
even if one is available.
236
:param preserve_stacking: When cloning a stacked branch, stack the
237
new branch on top of the other branch's stacked-on branch.
238
:param create_prefix: Create any missing directories leading up to
240
:param use_existing_dir: Use an existing directory if one exists.
242
# Overview: put together a broad description of what we want to end up
243
# with; then make as few api calls as possible to do it.
245
# We may want to create a repo/branch/tree, if we do so what format
246
# would we want for each:
247
require_stacking = (stacked_on is not None)
248
format = self.cloning_metadir(require_stacking)
250
# Figure out what objects we want:
252
local_repo = self.find_repository()
253
except errors.NoRepositoryPresent:
256
local_branch = self.open_branch()
257
except errors.NotBranchError:
260
# enable fallbacks when branch is not a branch reference
261
if local_branch.repository.has_same_location(local_repo):
262
local_repo = local_branch.repository
263
if preserve_stacking:
265
stacked_on = local_branch.get_stacked_on_url()
266
except (errors.UnstackableBranchFormat,
267
errors.UnstackableRepositoryFormat,
270
# Bug: We create a metadir without knowing if it can support stacking,
271
# we should look up the policy needs first, or just use it as a hint,
274
make_working_trees = local_repo.make_working_trees()
275
want_shared = local_repo.is_shared()
276
repo_format_name = format.repository_format.network_name()
278
make_working_trees = False
280
repo_format_name = None
282
result_repo, result, require_stacking, repository_policy = \
283
format.initialize_on_transport_ex(transport,
284
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
285
force_new_repo=force_new_repo, stacked_on=stacked_on,
286
stack_on_pwd=self.root_transport.base,
287
repo_format_name=repo_format_name,
288
make_working_trees=make_working_trees, shared_repo=want_shared)
291
# If the result repository is in the same place as the
292
# resulting bzr dir, it will have no content, further if the
293
# result is not stacked then we know all content should be
294
# copied, and finally if we are copying up to a specific
295
# revision_id then we can use the pending-ancestry-result which
296
# does not require traversing all of history to describe it.
297
if (result_repo.user_url == result.user_url
298
and not require_stacking and
299
revision_id is not None):
300
fetch_spec = graph.PendingAncestryResult(
301
[revision_id], local_repo)
302
result_repo.fetch(local_repo, fetch_spec=fetch_spec)
304
result_repo.fetch(local_repo, revision_id=revision_id)
308
if result_repo is not None:
309
raise AssertionError('result_repo not None(%r)' % result_repo)
310
# 1 if there is a branch present
311
# make sure its content is available in the target repository
313
if local_branch is not None:
314
result_branch = local_branch.clone(result, revision_id=revision_id,
315
repository_policy=repository_policy)
317
# Cheaper to check if the target is not local, than to try making
319
result.root_transport.local_abspath('.')
320
if result_repo is None or result_repo.make_working_trees():
321
self.open_workingtree().clone(result)
322
except (errors.NoWorkingTree, errors.NotLocalUrl):
326
# TODO: This should be given a Transport, and should chdir up; otherwise
327
# this will open a new connection.
328
def _make_tail(self, url):
329
t = get_transport(url)
333
def create(cls, base, format=None, possible_transports=None):
334
"""Create a new BzrDir at the url 'base'.
336
:param format: If supplied, the format of branch to create. If not
337
supplied, the default is used.
338
:param possible_transports: If supplied, a list of transports that
339
can be reused to share a remote connection.
341
if cls is not BzrDir:
342
raise AssertionError("BzrDir.create always creates the default"
343
" format, not one of %r" % cls)
344
t = get_transport(base, possible_transports)
347
format = BzrDirFormat.get_default_format()
348
return format.initialize_on_transport(t)
351
def find_bzrdirs(transport, evaluate=None, list_current=None):
352
"""Find bzrdirs recursively from current location.
354
This is intended primarily as a building block for more sophisticated
355
functionality, like finding trees under a directory, or finding
356
branches that use a given repository.
357
:param evaluate: An optional callable that yields recurse, value,
358
where recurse controls whether this bzrdir is recursed into
359
and value is the value to yield. By default, all bzrdirs
360
are recursed into, and the return value is the bzrdir.
361
:param list_current: if supplied, use this function to list the current
362
directory, instead of Transport.list_dir
363
:return: a generator of found bzrdirs, or whatever evaluate returns.
365
if list_current is None:
366
def list_current(transport):
367
return transport.list_dir('')
369
def evaluate(bzrdir):
372
pending = [transport]
373
while len(pending) > 0:
374
current_transport = pending.pop()
377
bzrdir = BzrDir.open_from_transport(current_transport)
378
except errors.NotBranchError:
381
recurse, value = evaluate(bzrdir)
384
subdirs = list_current(current_transport)
385
except errors.NoSuchFile:
388
for subdir in sorted(subdirs, reverse=True):
389
pending.append(current_transport.clone(subdir))
391
def list_branches(self):
392
"""Return a sequence of all branches local to this control directory.
396
return [self.open_branch()]
397
except errors.NotBranchError:
401
def find_branches(transport):
402
"""Find all branches under a transport.
404
This will find all branches below the transport, including branches
405
inside other branches. Where possible, it will use
406
Repository.find_branches.
408
To list all the branches that use a particular Repository, see
409
Repository.find_branches
411
def evaluate(bzrdir):
413
repository = bzrdir.open_repository()
414
except errors.NoRepositoryPresent:
417
return False, ([], repository)
418
return True, (bzrdir.list_branches(), None)
420
for branches, repo in BzrDir.find_bzrdirs(transport,
423
ret.extend(repo.find_branches())
424
if branches is not None:
428
def destroy_repository(self):
429
"""Destroy the repository in this BzrDir"""
430
raise NotImplementedError(self.destroy_repository)
432
def create_branch(self, name=None):
433
"""Create a branch in this BzrDir.
435
:param name: Name of the colocated branch to create, None for
438
The bzrdir's format will control what branch format is created.
439
For more control see BranchFormatXX.create(a_bzrdir).
441
raise NotImplementedError(self.create_branch)
443
def destroy_branch(self, name=None):
444
"""Destroy a branch in this BzrDir.
446
:param name: Name of the branch to destroy, None for the default
449
raise NotImplementedError(self.destroy_branch)
452
def create_branch_and_repo(base, force_new_repo=False, format=None):
453
"""Create a new BzrDir, Branch and Repository at the url 'base'.
455
This will use the current default BzrDirFormat unless one is
456
specified, and use whatever
457
repository format that that uses via bzrdir.create_branch and
458
create_repository. If a shared repository is available that is used
461
The created Branch object is returned.
463
:param base: The URL to create the branch at.
464
:param force_new_repo: If True a new repository is always created.
465
:param format: If supplied, the format of branch to create. If not
466
supplied, the default is used.
468
bzrdir = BzrDir.create(base, format)
469
bzrdir._find_or_create_repository(force_new_repo)
470
return bzrdir.create_branch()
472
def determine_repository_policy(self, force_new_repo=False, stack_on=None,
473
stack_on_pwd=None, require_stacking=False):
474
"""Return an object representing a policy to use.
476
This controls whether a new repository is created, and the format of
477
that repository, or some existing shared repository used instead.
479
If stack_on is supplied, will not seek a containing shared repo.
481
:param force_new_repo: If True, require a new repository to be created.
482
:param stack_on: If supplied, the location to stack on. If not
483
supplied, a default_stack_on location may be used.
484
:param stack_on_pwd: If stack_on is relative, the location it is
487
def repository_policy(found_bzrdir):
490
config = found_bzrdir.get_config()
492
stack_on = config.get_default_stack_on()
493
if stack_on is not None:
494
stack_on_pwd = found_bzrdir.user_url
496
# does it have a repository ?
498
repository = found_bzrdir.open_repository()
499
except errors.NoRepositoryPresent:
502
if (found_bzrdir.user_url != self.user_url
503
and not repository.is_shared()):
504
# Don't look higher, can't use a higher shared repo.
512
return UseExistingRepository(repository, stack_on,
513
stack_on_pwd, require_stacking=require_stacking), True
515
return CreateRepository(self, stack_on, stack_on_pwd,
516
require_stacking=require_stacking), True
518
if not force_new_repo:
520
policy = self._find_containing(repository_policy)
521
if policy is not None:
525
return UseExistingRepository(self.open_repository(),
526
stack_on, stack_on_pwd,
527
require_stacking=require_stacking)
528
except errors.NoRepositoryPresent:
530
return CreateRepository(self, stack_on, stack_on_pwd,
531
require_stacking=require_stacking)
533
def _find_or_create_repository(self, force_new_repo):
534
"""Create a new repository if needed, returning the repository."""
535
policy = self.determine_repository_policy(force_new_repo)
536
return policy.acquire_repository()[0]
539
def create_branch_convenience(base, force_new_repo=False,
540
force_new_tree=None, format=None,
541
possible_transports=None):
542
"""Create a new BzrDir, Branch and Repository at the url 'base'.
544
This is a convenience function - it will use an existing repository
545
if possible, can be told explicitly whether to create a working tree or
548
This will use the current default BzrDirFormat unless one is
549
specified, and use whatever
550
repository format that that uses via bzrdir.create_branch and
551
create_repository. If a shared repository is available that is used
552
preferentially. Whatever repository is used, its tree creation policy
555
The created Branch object is returned.
556
If a working tree cannot be made due to base not being a file:// url,
557
no error is raised unless force_new_tree is True, in which case no
558
data is created on disk and NotLocalUrl is raised.
560
:param base: The URL to create the branch at.
561
:param force_new_repo: If True a new repository is always created.
562
:param force_new_tree: If True or False force creation of a tree or
563
prevent such creation respectively.
564
:param format: Override for the bzrdir format to create.
565
:param possible_transports: An optional reusable transports list.
568
# check for non local urls
569
t = get_transport(base, possible_transports)
570
if not isinstance(t, local.LocalTransport):
571
raise errors.NotLocalUrl(base)
572
bzrdir = BzrDir.create(base, format, possible_transports)
573
repo = bzrdir._find_or_create_repository(force_new_repo)
574
result = bzrdir.create_branch()
575
if force_new_tree or (repo.make_working_trees() and
576
force_new_tree is None):
578
bzrdir.create_workingtree()
579
except errors.NotLocalUrl:
584
def create_standalone_workingtree(base, format=None):
585
"""Create a new BzrDir, WorkingTree, Branch and Repository at 'base'.
587
'base' must be a local path or a file:// url.
589
This will use the current default BzrDirFormat unless one is
590
specified, and use whatever
591
repository format that that uses for bzrdirformat.create_workingtree,
592
create_branch and create_repository.
594
:param format: Override for the bzrdir format to create.
595
:return: The WorkingTree object.
597
t = get_transport(base)
598
if not isinstance(t, local.LocalTransport):
599
raise errors.NotLocalUrl(base)
600
bzrdir = BzrDir.create_branch_and_repo(base,
602
format=format).bzrdir
603
return bzrdir.create_workingtree()
605
def create_workingtree(self, revision_id=None, from_branch=None,
606
accelerator_tree=None, hardlink=False):
607
"""Create a working tree at this BzrDir.
609
:param revision_id: create it as of this revision id.
610
:param from_branch: override bzrdir branch (for lightweight checkouts)
611
:param accelerator_tree: A tree which can be used for retrieving file
612
contents more quickly than the revision tree, i.e. a workingtree.
613
The revision tree will be used for cases where accelerator_tree's
614
content is different.
616
raise NotImplementedError(self.create_workingtree)
618
def backup_bzrdir(self):
619
"""Backup this bzr control directory.
621
:return: Tuple with old path name and new path name
623
def name_gen(base='backup.bzr'):
625
name = "%s.~%d~" % (base, counter)
626
while self.root_transport.has(name):
628
name = "%s.~%d~" % (base, counter)
631
backup_dir=name_gen()
632
pb = ui.ui_factory.nested_progress_bar()
634
# FIXME: bug 300001 -- the backup fails if the backup directory
635
# already exists, but it should instead either remove it or make
636
# a new backup directory.
638
old_path = self.root_transport.abspath('.bzr')
639
new_path = self.root_transport.abspath(backup_dir)
640
ui.ui_factory.note('making backup of %s\n to %s' % (old_path, new_path,))
641
self.root_transport.copy_tree('.bzr', backup_dir)
642
return (old_path, new_path)
646
def retire_bzrdir(self, limit=10000):
647
"""Permanently disable the bzrdir.
649
This is done by renaming it to give the user some ability to recover
650
if there was a problem.
652
This will have horrible consequences if anyone has anything locked or
654
:param limit: number of times to retry
659
to_path = '.bzr.retired.%d' % i
660
self.root_transport.rename('.bzr', to_path)
661
note("renamed %s to %s"
662
% (self.root_transport.abspath('.bzr'), to_path))
664
except (errors.TransportError, IOError, errors.PathError):
671
def destroy_workingtree(self):
672
"""Destroy the working tree at this BzrDir.
674
Formats that do not support this may raise UnsupportedOperation.
676
raise NotImplementedError(self.destroy_workingtree)
678
def destroy_workingtree_metadata(self):
679
"""Destroy the control files for the working tree at this BzrDir.
681
The contents of working tree files are not affected.
682
Formats that do not support this may raise UnsupportedOperation.
684
raise NotImplementedError(self.destroy_workingtree_metadata)
686
def _find_containing(self, evaluate):
687
"""Find something in a containing control directory.
689
This method will scan containing control dirs, until it finds what
690
it is looking for, decides that it will never find it, or runs out
691
of containing control directories to check.
693
It is used to implement find_repository and
694
determine_repository_policy.
696
:param evaluate: A function returning (value, stop). If stop is True,
697
the value will be returned.
701
result, stop = evaluate(found_bzrdir)
704
next_transport = found_bzrdir.root_transport.clone('..')
705
if (found_bzrdir.user_url == next_transport.base):
706
# top of the file system
708
# find the next containing bzrdir
710
found_bzrdir = BzrDir.open_containing_from_transport(
712
except errors.NotBranchError:
715
def find_repository(self):
716
"""Find the repository that should be used.
718
This does not require a branch as we use it to find the repo for
719
new branches as well as to hook existing branches up to their
722
def usable_repository(found_bzrdir):
723
# does it have a repository ?
725
repository = found_bzrdir.open_repository()
726
except errors.NoRepositoryPresent:
728
if found_bzrdir.user_url == self.user_url:
729
return repository, True
730
elif repository.is_shared():
731
return repository, True
735
found_repo = self._find_containing(usable_repository)
736
if found_repo is None:
737
raise errors.NoRepositoryPresent(self)
740
def get_branch_reference(self):
741
"""Return the referenced URL for the branch in this bzrdir.
743
:raises NotBranchError: If there is no Branch.
744
:return: The URL the branch in this bzrdir references if it is a
745
reference branch, or None for regular branches.
749
def get_branch_transport(self, branch_format, name=None):
750
"""Get the transport for use by branch format in this BzrDir.
752
Note that bzr dirs that do not support format strings will raise
753
IncompatibleFormat if the branch format they are given has
754
a format string, and vice versa.
756
If branch_format is None, the transport is returned with no
757
checking. If it is not None, then the returned transport is
758
guaranteed to point to an existing directory ready for use.
760
raise NotImplementedError(self.get_branch_transport)
762
def _find_creation_modes(self):
763
"""Determine the appropriate modes for files and directories.
765
They're always set to be consistent with the base directory,
766
assuming that this transport allows setting modes.
768
# TODO: Do we need or want an option (maybe a config setting) to turn
769
# this off or override it for particular locations? -- mbp 20080512
770
if self._mode_check_done:
772
self._mode_check_done = True
774
st = self.transport.stat('.')
775
except errors.TransportNotPossible:
776
self._dir_mode = None
777
self._file_mode = None
779
# Check the directory mode, but also make sure the created
780
# directories and files are read-write for this user. This is
781
# mostly a workaround for filesystems which lie about being able to
782
# write to a directory (cygwin & win32)
783
if (st.st_mode & 07777 == 00000):
784
# FTP allows stat but does not return dir/file modes
785
self._dir_mode = None
786
self._file_mode = None
788
self._dir_mode = (st.st_mode & 07777) | 00700
789
# Remove the sticky and execute bits for files
790
self._file_mode = self._dir_mode & ~07111
792
def _get_file_mode(self):
793
"""Return Unix mode for newly created files, or None.
795
if not self._mode_check_done:
796
self._find_creation_modes()
797
return self._file_mode
799
def _get_dir_mode(self):
800
"""Return Unix mode for newly created directories, or None.
802
if not self._mode_check_done:
803
self._find_creation_modes()
804
return self._dir_mode
806
def get_repository_transport(self, repository_format):
807
"""Get the transport for use by repository format in this BzrDir.
809
Note that bzr dirs that do not support format strings will raise
810
IncompatibleFormat if the repository format they are given has
811
a format string, and vice versa.
813
If repository_format is None, the transport is returned with no
814
checking. If it is not None, then the returned transport is
815
guaranteed to point to an existing directory ready for use.
817
raise NotImplementedError(self.get_repository_transport)
819
def get_workingtree_transport(self, tree_format):
820
"""Get the transport for use by workingtree format in this BzrDir.
822
Note that bzr dirs that do not support format strings will raise
823
IncompatibleFormat if the workingtree format they are given has a
824
format string, and vice versa.
826
If workingtree_format is None, the transport is returned with no
827
checking. If it is not None, then the returned transport is
828
guaranteed to point to an existing directory ready for use.
830
raise NotImplementedError(self.get_workingtree_transport)
832
def get_config(self):
833
"""Get configuration for this BzrDir."""
834
return config.BzrDirConfig(self)
836
def _get_config(self):
837
"""By default, no configuration is available."""
840
def __init__(self, _transport, _format):
841
"""Initialize a Bzr control dir object.
843
Only really common logic should reside here, concrete classes should be
844
made with varying behaviours.
846
:param _format: the format that is creating this BzrDir instance.
847
:param _transport: the transport this dir is based at.
849
self._format = _format
850
# these are also under the more standard names of
851
# control_transport and user_transport
852
self.transport = _transport.clone('.bzr')
853
self.root_transport = _transport
854
self._mode_check_done = False
857
def user_transport(self):
858
return self.root_transport
861
def control_transport(self):
862
return self.transport
864
def is_control_filename(self, filename):
865
"""True if filename is the name of a path which is reserved for bzrdir's.
867
:param filename: A filename within the root transport of this bzrdir.
869
This is true IF and ONLY IF the filename is part of the namespace reserved
870
for bzr control dirs. Currently this is the '.bzr' directory in the root
871
of the root_transport. it is expected that plugins will need to extend
872
this in the future - for instance to make bzr talk with svn working
875
# this might be better on the BzrDirFormat class because it refers to
876
# all the possible bzrdir disk formats.
877
# This method is tested via the workingtree is_control_filename tests-
878
# it was extracted from WorkingTree.is_control_filename. If the method's
879
# contract is extended beyond the current trivial implementation, please
880
# add new tests for it to the appropriate place.
881
return filename == '.bzr' or filename.startswith('.bzr/')
883
def needs_format_conversion(self, format=None):
884
"""Return true if this bzrdir needs convert_format run on it.
886
For instance, if the repository format is out of date but the
887
branch and working tree are not, this should return True.
889
:param format: Optional parameter indicating a specific desired
890
format we plan to arrive at.
892
raise NotImplementedError(self.needs_format_conversion)
895
def open_unsupported(base):
896
"""Open a branch which is not supported."""
897
return BzrDir.open(base, _unsupported=True)
900
def open(base, _unsupported=False, possible_transports=None):
901
"""Open an existing bzrdir, rooted at 'base' (url).
903
:param _unsupported: a private parameter to the BzrDir class.
905
t = get_transport(base, possible_transports=possible_transports)
906
return BzrDir.open_from_transport(t, _unsupported=_unsupported)
909
def open_from_transport(transport, _unsupported=False,
910
_server_formats=True):
911
"""Open a bzrdir within a particular directory.
913
:param transport: Transport containing the bzrdir.
914
:param _unsupported: private.
916
for hook in BzrDir.hooks['pre_open']:
918
# Keep initial base since 'transport' may be modified while following
920
base = transport.base
921
def find_format(transport):
922
return transport, BzrDirFormat.find_format(
923
transport, _server_formats=_server_formats)
925
def redirected(transport, e, redirection_notice):
926
redirected_transport = transport._redirected_to(e.source, e.target)
927
if redirected_transport is None:
928
raise errors.NotBranchError(base)
929
note('%s is%s redirected to %s',
930
transport.base, e.permanently, redirected_transport.base)
931
return redirected_transport
934
transport, format = do_catching_redirections(find_format,
937
except errors.TooManyRedirections:
938
raise errors.NotBranchError(base)
940
BzrDir._check_supported(format, _unsupported)
941
return format.open(transport, _found=True)
943
def open_branch(self, name=None, unsupported=False,
944
ignore_fallbacks=False):
945
"""Open the branch object at this BzrDir if one is present.
947
If unsupported is True, then no longer supported branch formats can
950
TODO: static convenience version of this?
952
raise NotImplementedError(self.open_branch)
955
def open_containing(url, possible_transports=None):
956
"""Open an existing branch which contains url.
958
:param url: url to search from.
959
See open_containing_from_transport for more detail.
961
transport = get_transport(url, possible_transports)
962
return BzrDir.open_containing_from_transport(transport)
965
def open_containing_from_transport(a_transport):
966
"""Open an existing branch which contains a_transport.base.
968
This probes for a branch at a_transport, and searches upwards from there.
970
Basically we keep looking up until we find the control directory or
971
run into the root. If there isn't one, raises NotBranchError.
972
If there is one and it is either an unrecognised format or an unsupported
973
format, UnknownFormatError or UnsupportedFormatError are raised.
974
If there is one, it is returned, along with the unused portion of url.
976
:return: The BzrDir that contains the path, and a Unicode path
977
for the rest of the URL.
979
# this gets the normalised url back. I.e. '.' -> the full path.
980
url = a_transport.base
983
result = BzrDir.open_from_transport(a_transport)
984
return result, urlutils.unescape(a_transport.relpath(url))
985
except errors.NotBranchError, e:
988
new_t = a_transport.clone('..')
989
except errors.InvalidURLJoin:
990
# reached the root, whatever that may be
991
raise errors.NotBranchError(path=url)
992
if new_t.base == a_transport.base:
993
# reached the root, whatever that may be
994
raise errors.NotBranchError(path=url)
997
def _get_tree_branch(self):
998
"""Return the branch and tree, if any, for this bzrdir.
1000
Return None for tree if not present or inaccessible.
1001
Raise NotBranchError if no branch is present.
1002
:return: (tree, branch)
1005
tree = self.open_workingtree()
1006
except (errors.NoWorkingTree, errors.NotLocalUrl):
1008
branch = self.open_branch()
1010
branch = tree.branch
1014
def open_tree_or_branch(klass, location):
1015
"""Return the branch and working tree at a location.
1017
If there is no tree at the location, tree will be None.
1018
If there is no branch at the location, an exception will be
1020
:return: (tree, branch)
1022
bzrdir = klass.open(location)
1023
return bzrdir._get_tree_branch()
1026
def open_containing_tree_or_branch(klass, location):
1027
"""Return the branch and working tree contained by a location.
1029
Returns (tree, branch, relpath).
1030
If there is no tree at containing the location, tree will be None.
1031
If there is no branch containing the location, an exception will be
1033
relpath is the portion of the path that is contained by the branch.
1035
bzrdir, relpath = klass.open_containing(location)
1036
tree, branch = bzrdir._get_tree_branch()
1037
return tree, branch, relpath
1040
def open_containing_tree_branch_or_repository(klass, location):
1041
"""Return the working tree, branch and repo contained by a location.
1043
Returns (tree, branch, repository, relpath).
1044
If there is no tree containing the location, tree will be None.
1045
If there is no branch containing the location, branch will be None.
1046
If there is no repository containing the location, repository will be
1048
relpath is the portion of the path that is contained by the innermost
1051
If no tree, branch or repository is found, a NotBranchError is raised.
1053
bzrdir, relpath = klass.open_containing(location)
1055
tree, branch = bzrdir._get_tree_branch()
1056
except errors.NotBranchError:
1058
repo = bzrdir.find_repository()
1059
return None, None, repo, relpath
1060
except (errors.NoRepositoryPresent):
1061
raise errors.NotBranchError(location)
1062
return tree, branch, branch.repository, relpath
1064
def open_repository(self, _unsupported=False):
1065
"""Open the repository object at this BzrDir if one is present.
1067
This will not follow the Branch object pointer - it's strictly a direct
1068
open facility. Most client code should use open_branch().repository to
1069
get at a repository.
1071
:param _unsupported: a private parameter, not part of the api.
1072
TODO: static convenience version of this?
1074
raise NotImplementedError(self.open_repository)
1076
def open_workingtree(self, _unsupported=False,
1077
recommend_upgrade=True, from_branch=None):
1078
"""Open the workingtree object at this BzrDir if one is present.
1080
:param recommend_upgrade: Optional keyword parameter, when True (the
1081
default), emit through the ui module a recommendation that the user
1082
upgrade the working tree when the workingtree being opened is old
1083
(but still fully supported).
1084
:param from_branch: override bzrdir branch (for lightweight checkouts)
1086
raise NotImplementedError(self.open_workingtree)
1088
def has_branch(self, name=None):
1089
"""Tell if this bzrdir contains a branch.
1091
Note: if you're going to open the branch, you should just go ahead
1092
and try, and not ask permission first. (This method just opens the
1093
branch and discards it, and that's somewhat expensive.)
1096
self.open_branch(name)
1098
except errors.NotBranchError:
1101
def has_workingtree(self):
1102
"""Tell if this bzrdir contains a working tree.
1104
This will still raise an exception if the bzrdir has a workingtree that
1105
is remote & inaccessible.
1107
Note: if you're going to open the working tree, you should just go ahead
1108
and try, and not ask permission first. (This method just opens the
1109
workingtree and discards it, and that's somewhat expensive.)
1112
self.open_workingtree(recommend_upgrade=False)
1114
except errors.NoWorkingTree:
1117
def _cloning_metadir(self):
1118
"""Produce a metadir suitable for cloning with.
1120
:returns: (destination_bzrdir_format, source_repository)
1122
result_format = self._format.__class__()
1125
branch = self.open_branch(ignore_fallbacks=True)
1126
source_repository = branch.repository
1127
result_format._branch_format = branch._format
1128
except errors.NotBranchError:
1129
source_branch = None
1130
source_repository = self.open_repository()
1131
except errors.NoRepositoryPresent:
1132
source_repository = None
1134
# XXX TODO: This isinstance is here because we have not implemented
1135
# the fix recommended in bug # 103195 - to delegate this choice the
1136
# repository itself.
1137
repo_format = source_repository._format
1138
if isinstance(repo_format, remote.RemoteRepositoryFormat):
1139
source_repository._ensure_real()
1140
repo_format = source_repository._real_repository._format
1141
result_format.repository_format = repo_format
1143
# TODO: Couldn't we just probe for the format in these cases,
1144
# rather than opening the whole tree? It would be a little
1145
# faster. mbp 20070401
1146
tree = self.open_workingtree(recommend_upgrade=False)
1147
except (errors.NoWorkingTree, errors.NotLocalUrl):
1148
result_format.workingtree_format = None
1150
result_format.workingtree_format = tree._format.__class__()
1151
return result_format, source_repository
1153
def cloning_metadir(self, require_stacking=False):
1154
"""Produce a metadir suitable for cloning or sprouting with.
1156
These operations may produce workingtrees (yes, even though they're
1157
"cloning" something that doesn't have a tree), so a viable workingtree
1158
format must be selected.
1160
:require_stacking: If True, non-stackable formats will be upgraded
1161
to similar stackable formats.
1162
:returns: a BzrDirFormat with all component formats either set
1163
appropriately or set to None if that component should not be
1166
format, repository = self._cloning_metadir()
1167
if format._workingtree_format is None:
1169
if repository is None:
1170
# No repository either
1172
# We have a repository, so set a working tree? (Why? This seems to
1173
# contradict the stated return value in the docstring).
1174
tree_format = repository._format._matchingbzrdir.workingtree_format
1175
format.workingtree_format = tree_format.__class__()
1176
if require_stacking:
1177
format.require_stacking()
1180
def checkout_metadir(self):
1181
return self.cloning_metadir()
1183
def sprout(self, url, revision_id=None, force_new_repo=False,
1184
recurse='down', possible_transports=None,
1185
accelerator_tree=None, hardlink=False, stacked=False,
1186
source_branch=None, create_tree_if_local=True):
1187
"""Create a copy of this bzrdir prepared for use as a new line of
1190
If url's last component does not exist, it will be created.
1192
Attributes related to the identity of the source branch like
1193
branch nickname will be cleaned, a working tree is created
1194
whether one existed before or not; and a local branch is always
1197
if revision_id is not None, then the clone operation may tune
1198
itself to download less data.
1199
:param accelerator_tree: A tree which can be used for retrieving file
1200
contents more quickly than the revision tree, i.e. a workingtree.
1201
The revision tree will be used for cases where accelerator_tree's
1202
content is different.
1203
:param hardlink: If true, hard-link files from accelerator_tree,
1205
:param stacked: If true, create a stacked branch referring to the
1206
location of this control directory.
1207
:param create_tree_if_local: If true, a working-tree will be created
1208
when working locally.
1210
target_transport = get_transport(url, possible_transports)
1211
target_transport.ensure_base()
1212
cloning_format = self.cloning_metadir(stacked)
1213
# Create/update the result branch
1214
result = cloning_format.initialize_on_transport(target_transport)
1215
# if a stacked branch wasn't requested, we don't create one
1216
# even if the origin was stacked
1217
stacked_branch_url = None
1218
if source_branch is not None:
1220
stacked_branch_url = self.root_transport.base
1221
source_repository = source_branch.repository
1224
source_branch = self.open_branch()
1225
source_repository = source_branch.repository
1227
stacked_branch_url = self.root_transport.base
1228
except errors.NotBranchError:
1229
source_branch = None
1231
source_repository = self.open_repository()
1232
except errors.NoRepositoryPresent:
1233
source_repository = None
1234
repository_policy = result.determine_repository_policy(
1235
force_new_repo, stacked_branch_url, require_stacking=stacked)
1236
result_repo, is_new_repo = repository_policy.acquire_repository()
1237
if is_new_repo and revision_id is not None and not stacked:
1238
fetch_spec = graph.PendingAncestryResult(
1239
[revision_id], source_repository)
1242
if source_repository is not None:
1243
# Fetch while stacked to prevent unstacked fetch from
1245
if fetch_spec is None:
1246
result_repo.fetch(source_repository, revision_id=revision_id)
1248
result_repo.fetch(source_repository, fetch_spec=fetch_spec)
1250
if source_branch is None:
1251
# this is for sprouting a bzrdir without a branch; is that
1253
# Not especially, but it's part of the contract.
1254
result_branch = result.create_branch()
1256
result_branch = source_branch.sprout(result,
1257
revision_id=revision_id, repository_policy=repository_policy)
1258
mutter("created new branch %r" % (result_branch,))
1260
# Create/update the result working tree
1261
if (create_tree_if_local and
1262
isinstance(target_transport, local.LocalTransport) and
1263
(result_repo is None or result_repo.make_working_trees())):
1264
wt = result.create_workingtree(accelerator_tree=accelerator_tree,
1268
if wt.path2id('') is None:
1270
wt.set_root_id(self.open_workingtree.get_root_id())
1271
except errors.NoWorkingTree:
1277
if recurse == 'down':
1279
basis = wt.basis_tree()
1281
subtrees = basis.iter_references()
1282
elif result_branch is not None:
1283
basis = result_branch.basis_tree()
1285
subtrees = basis.iter_references()
1286
elif source_branch is not None:
1287
basis = source_branch.basis_tree()
1289
subtrees = basis.iter_references()
1294
for path, file_id in subtrees:
1295
target = urlutils.join(url, urlutils.escape(path))
1296
sublocation = source_branch.reference_parent(file_id, path)
1297
sublocation.bzrdir.sprout(target,
1298
basis.get_reference_revision(file_id, path),
1299
force_new_repo=force_new_repo, recurse=recurse,
1302
if basis is not None:
1306
def push_branch(self, source, revision_id=None, overwrite=False,
1307
remember=False, create_prefix=False):
1308
"""Push the source branch into this BzrDir."""
1310
# If we can open a branch, use its direct repository, otherwise see
1311
# if there is a repository without a branch.
1313
br_to = self.open_branch()
1314
except errors.NotBranchError:
1315
# Didn't find a branch, can we find a repository?
1316
repository_to = self.find_repository()
1318
# Found a branch, so we must have found a repository
1319
repository_to = br_to.repository
1321
push_result = PushResult()
1322
push_result.source_branch = source
1324
# We have a repository but no branch, copy the revisions, and then
1326
repository_to.fetch(source.repository, revision_id=revision_id)
1327
br_to = source.clone(self, revision_id=revision_id)
1328
if source.get_push_location() is None or remember:
1329
source.set_push_location(br_to.base)
1330
push_result.stacked_on = None
1331
push_result.branch_push_result = None
1332
push_result.old_revno = None
1333
push_result.old_revid = _mod_revision.NULL_REVISION
1334
push_result.target_branch = br_to
1335
push_result.master_branch = None
1336
push_result.workingtree_updated = False
1338
# We have successfully opened the branch, remember if necessary:
1339
if source.get_push_location() is None or remember:
1340
source.set_push_location(br_to.base)
1342
tree_to = self.open_workingtree()
1343
except errors.NotLocalUrl:
1344
push_result.branch_push_result = source.push(br_to,
1345
overwrite, stop_revision=revision_id)
1346
push_result.workingtree_updated = False
1347
except errors.NoWorkingTree:
1348
push_result.branch_push_result = source.push(br_to,
1349
overwrite, stop_revision=revision_id)
1350
push_result.workingtree_updated = None # Not applicable
1352
tree_to.lock_write()
1354
push_result.branch_push_result = source.push(
1355
tree_to.branch, overwrite, stop_revision=revision_id)
1359
push_result.workingtree_updated = True
1360
push_result.old_revno = push_result.branch_push_result.old_revno
1361
push_result.old_revid = push_result.branch_push_result.old_revid
1362
push_result.target_branch = \
1363
push_result.branch_push_result.target_branch
1367
class BzrDirHooks(hooks.Hooks):
1368
"""Hooks for BzrDir operations."""
1371
"""Create the default hooks."""
1372
hooks.Hooks.__init__(self)
1373
self.create_hook(hooks.HookPoint('pre_open',
1374
"Invoked before attempting to open a BzrDir with the transport "
1375
"that the open will use.", (1, 14), None))
1376
self.create_hook(hooks.HookPoint('post_repo_init',
1377
"Invoked after a repository has been initialized. "
1378
"post_repo_init is called with a "
1379
"bzrlib.bzrdir.RepoInitHookParams.",
1382
# install the default hooks
1383
BzrDir.hooks = BzrDirHooks()
1386
class RepoInitHookParams(object):
1387
"""Object holding parameters passed to *_repo_init hooks.
1389
There are 4 fields that hooks may wish to access:
1391
:ivar repository: Repository created
1392
:ivar format: Repository format
1393
:ivar bzrdir: The bzrdir for the repository
1394
:ivar shared: The repository is shared
1397
def __init__(self, repository, format, a_bzrdir, shared):
1398
"""Create a group of RepoInitHook parameters.
1400
:param repository: Repository created
1401
:param format: Repository format
1402
:param bzrdir: The bzrdir for the repository
1403
:param shared: The repository is shared
1405
self.repository = repository
1406
self.format = format
1407
self.bzrdir = a_bzrdir
1408
self.shared = shared
1410
def __eq__(self, other):
1411
return self.__dict__ == other.__dict__
1415
return "<%s for %s>" % (self.__class__.__name__,
1418
return "<%s for %s>" % (self.__class__.__name__,
1422
class BzrDirPreSplitOut(BzrDir):
1423
"""A common class for the all-in-one formats."""
1425
def __init__(self, _transport, _format):
1426
"""See BzrDir.__init__."""
1427
super(BzrDirPreSplitOut, self).__init__(_transport, _format)
1428
self._control_files = lockable_files.LockableFiles(
1429
self.get_branch_transport(None),
1430
self._format._lock_file_name,
1431
self._format._lock_class)
1433
def break_lock(self):
1434
"""Pre-splitout bzrdirs do not suffer from stale locks."""
1435
raise NotImplementedError(self.break_lock)
1437
def cloning_metadir(self, require_stacking=False):
1438
"""Produce a metadir suitable for cloning with."""
1439
if require_stacking:
1440
return format_registry.make_bzrdir('1.6')
1441
return self._format.__class__()
1443
def clone(self, url, revision_id=None, force_new_repo=False,
1444
preserve_stacking=False):
1445
"""See BzrDir.clone().
1447
force_new_repo has no effect, since this family of formats always
1448
require a new repository.
1449
preserve_stacking has no effect, since no source branch using this
1450
family of formats can be stacked, so there is no stacking to preserve.
1452
self._make_tail(url)
1453
result = self._format._initialize_for_clone(url)
1454
self.open_repository().clone(result, revision_id=revision_id)
1455
from_branch = self.open_branch()
1456
from_branch.clone(result, revision_id=revision_id)
1458
tree = self.open_workingtree()
1459
except errors.NotLocalUrl:
1460
# make a new one, this format always has to have one.
1461
result._init_workingtree()
1466
def create_branch(self, name=None):
1467
"""See BzrDir.create_branch."""
1468
return self._format.get_branch_format().initialize(self, name=name)
1470
def destroy_branch(self, name=None):
1471
"""See BzrDir.destroy_branch."""
1472
raise errors.UnsupportedOperation(self.destroy_branch, self)
1474
def create_repository(self, shared=False):
1475
"""See BzrDir.create_repository."""
1477
raise errors.IncompatibleFormat('shared repository', self._format)
1478
return self.open_repository()
1480
def destroy_repository(self):
1481
"""See BzrDir.destroy_repository."""
1482
raise errors.UnsupportedOperation(self.destroy_repository, self)
1484
def create_workingtree(self, revision_id=None, from_branch=None,
1485
accelerator_tree=None, hardlink=False):
1486
"""See BzrDir.create_workingtree."""
1487
# The workingtree is sometimes created when the bzrdir is created,
1488
# but not when cloning.
1490
# this looks buggy but is not -really-
1491
# because this format creates the workingtree when the bzrdir is
1493
# clone and sprout will have set the revision_id
1494
# and that will have set it for us, its only
1495
# specific uses of create_workingtree in isolation
1496
# that can do wonky stuff here, and that only
1497
# happens for creating checkouts, which cannot be
1498
# done on this format anyway. So - acceptable wart.
1500
warning("can't support hardlinked working trees in %r"
1503
result = self.open_workingtree(recommend_upgrade=False)
1504
except errors.NoSuchFile:
1505
result = self._init_workingtree()
1506
if revision_id is not None:
1507
if revision_id == _mod_revision.NULL_REVISION:
1508
result.set_parent_ids([])
1510
result.set_parent_ids([revision_id])
1513
def _init_workingtree(self):
1514
from bzrlib.workingtree import WorkingTreeFormat2
1516
return WorkingTreeFormat2().initialize(self)
1517
except errors.NotLocalUrl:
1518
# Even though we can't access the working tree, we need to
1519
# create its control files.
1520
return WorkingTreeFormat2()._stub_initialize_on_transport(
1521
self.transport, self._control_files._file_mode)
1523
def destroy_workingtree(self):
1524
"""See BzrDir.destroy_workingtree."""
1525
raise errors.UnsupportedOperation(self.destroy_workingtree, self)
1527
def destroy_workingtree_metadata(self):
1528
"""See BzrDir.destroy_workingtree_metadata."""
1529
raise errors.UnsupportedOperation(self.destroy_workingtree_metadata,
1532
def get_branch_transport(self, branch_format, name=None):
1533
"""See BzrDir.get_branch_transport()."""
1534
if name is not None:
1535
raise errors.NoColocatedBranchSupport(self)
1536
if branch_format is None:
1537
return self.transport
1539
branch_format.get_format_string()
1540
except NotImplementedError:
1541
return self.transport
1542
raise errors.IncompatibleFormat(branch_format, self._format)
1544
def get_repository_transport(self, repository_format):
1545
"""See BzrDir.get_repository_transport()."""
1546
if repository_format is None:
1547
return self.transport
1549
repository_format.get_format_string()
1550
except NotImplementedError:
1551
return self.transport
1552
raise errors.IncompatibleFormat(repository_format, self._format)
1554
def get_workingtree_transport(self, workingtree_format):
1555
"""See BzrDir.get_workingtree_transport()."""
1556
if workingtree_format is None:
1557
return self.transport
1559
workingtree_format.get_format_string()
1560
except NotImplementedError:
1561
return self.transport
1562
raise errors.IncompatibleFormat(workingtree_format, self._format)
1564
def needs_format_conversion(self, format=None):
1565
"""See BzrDir.needs_format_conversion()."""
1566
# if the format is not the same as the system default,
1567
# an upgrade is needed.
1569
symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1570
% 'needs_format_conversion(format=None)')
1571
format = BzrDirFormat.get_default_format()
1572
return not isinstance(self._format, format.__class__)
1574
def open_branch(self, name=None, unsupported=False,
1575
ignore_fallbacks=False):
1576
"""See BzrDir.open_branch."""
1577
from bzrlib.branch import BzrBranchFormat4
1578
format = BzrBranchFormat4()
1579
self._check_supported(format, unsupported)
1580
return format.open(self, name, _found=True)
1582
def sprout(self, url, revision_id=None, force_new_repo=False,
1583
possible_transports=None, accelerator_tree=None,
1584
hardlink=False, stacked=False, create_tree_if_local=True,
1585
source_branch=None):
1586
"""See BzrDir.sprout()."""
1587
if source_branch is not None:
1588
my_branch = self.open_branch()
1589
if source_branch.base != my_branch.base:
1590
raise AssertionError(
1591
"source branch %r is not within %r with branch %r" %
1592
(source_branch, self, my_branch))
1594
raise errors.UnstackableBranchFormat(
1595
self._format, self.root_transport.base)
1596
if not create_tree_if_local:
1597
raise errors.MustHaveWorkingTree(
1598
self._format, self.root_transport.base)
1599
from bzrlib.workingtree import WorkingTreeFormat2
1600
self._make_tail(url)
1601
result = self._format._initialize_for_clone(url)
1603
self.open_repository().clone(result, revision_id=revision_id)
1604
except errors.NoRepositoryPresent:
1607
self.open_branch().sprout(result, revision_id=revision_id)
1608
except errors.NotBranchError:
1611
# we always want a working tree
1612
WorkingTreeFormat2().initialize(result,
1613
accelerator_tree=accelerator_tree,
1618
class BzrDir4(BzrDirPreSplitOut):
1619
"""A .bzr version 4 control object.
1621
This is a deprecated format and may be removed after sept 2006.
1624
def create_repository(self, shared=False):
1625
"""See BzrDir.create_repository."""
1626
return self._format.repository_format.initialize(self, shared)
1628
def needs_format_conversion(self, format=None):
1629
"""Format 4 dirs are always in need of conversion."""
1631
symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1632
% 'needs_format_conversion(format=None)')
1635
def open_repository(self):
1636
"""See BzrDir.open_repository."""
1637
from bzrlib.repofmt.weaverepo import RepositoryFormat4
1638
return RepositoryFormat4().open(self, _found=True)
1641
class BzrDir5(BzrDirPreSplitOut):
1642
"""A .bzr version 5 control object.
1644
This is a deprecated format and may be removed after sept 2006.
1647
def has_workingtree(self):
1648
"""See BzrDir.has_workingtree."""
1651
def open_repository(self):
1652
"""See BzrDir.open_repository."""
1653
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1654
return RepositoryFormat5().open(self, _found=True)
1656
def open_workingtree(self, _unsupported=False,
1657
recommend_upgrade=True):
1658
"""See BzrDir.create_workingtree."""
1659
from bzrlib.workingtree import WorkingTreeFormat2
1660
wt_format = WorkingTreeFormat2()
1661
# we don't warn here about upgrades; that ought to be handled for the
1663
return wt_format.open(self, _found=True)
1666
class BzrDir6(BzrDirPreSplitOut):
1667
"""A .bzr version 6 control object.
1669
This is a deprecated format and may be removed after sept 2006.
1672
def has_workingtree(self):
1673
"""See BzrDir.has_workingtree."""
1676
def open_repository(self):
1677
"""See BzrDir.open_repository."""
1678
from bzrlib.repofmt.weaverepo import RepositoryFormat6
1679
return RepositoryFormat6().open(self, _found=True)
1681
def open_workingtree(self, _unsupported=False,
1682
recommend_upgrade=True):
1683
"""See BzrDir.create_workingtree."""
1684
# we don't warn here about upgrades; that ought to be handled for the
1686
from bzrlib.workingtree import WorkingTreeFormat2
1687
return WorkingTreeFormat2().open(self, _found=True)
1690
class BzrDirMeta1(BzrDir):
1691
"""A .bzr meta version 1 control object.
1693
This is the first control object where the
1694
individual aspects are really split out: there are separate repository,
1695
workingtree and branch subdirectories and any subset of the three can be
1696
present within a BzrDir.
1699
def can_convert_format(self):
1700
"""See BzrDir.can_convert_format()."""
1703
def create_branch(self, name=None):
1704
"""See BzrDir.create_branch."""
1705
return self._format.get_branch_format().initialize(self, name=name)
1707
def destroy_branch(self, name=None):
1708
"""See BzrDir.create_branch."""
1709
if name is not None:
1710
raise errors.NoColocatedBranchSupport(self)
1711
self.transport.delete_tree('branch')
1713
def create_repository(self, shared=False):
1714
"""See BzrDir.create_repository."""
1715
return self._format.repository_format.initialize(self, shared)
1717
def destroy_repository(self):
1718
"""See BzrDir.destroy_repository."""
1719
self.transport.delete_tree('repository')
1721
def create_workingtree(self, revision_id=None, from_branch=None,
1722
accelerator_tree=None, hardlink=False):
1723
"""See BzrDir.create_workingtree."""
1724
return self._format.workingtree_format.initialize(
1725
self, revision_id, from_branch=from_branch,
1726
accelerator_tree=accelerator_tree, hardlink=hardlink)
1728
def destroy_workingtree(self):
1729
"""See BzrDir.destroy_workingtree."""
1730
wt = self.open_workingtree(recommend_upgrade=False)
1731
repository = wt.branch.repository
1732
empty = repository.revision_tree(_mod_revision.NULL_REVISION)
1733
wt.revert(old_tree=empty)
1734
self.destroy_workingtree_metadata()
1736
def destroy_workingtree_metadata(self):
1737
self.transport.delete_tree('checkout')
1739
def find_branch_format(self):
1740
"""Find the branch 'format' for this bzrdir.
1742
This might be a synthetic object for e.g. RemoteBranch and SVN.
1744
from bzrlib.branch import BranchFormat
1745
return BranchFormat.find_format(self)
1747
def _get_mkdir_mode(self):
1748
"""Figure out the mode to use when creating a bzrdir subdir."""
1749
temp_control = lockable_files.LockableFiles(self.transport, '',
1750
lockable_files.TransportLock)
1751
return temp_control._dir_mode
1753
def get_branch_reference(self):
1754
"""See BzrDir.get_branch_reference()."""
1755
from bzrlib.branch import BranchFormat
1756
format = BranchFormat.find_format(self)
1757
return format.get_reference(self)
1759
def get_branch_transport(self, branch_format, name=None):
1760
"""See BzrDir.get_branch_transport()."""
1761
if name is not None:
1762
raise errors.NoColocatedBranchSupport(self)
1763
# XXX: this shouldn't implicitly create the directory if it's just
1764
# promising to get a transport -- mbp 20090727
1765
if branch_format is None:
1766
return self.transport.clone('branch')
1768
branch_format.get_format_string()
1769
except NotImplementedError:
1770
raise errors.IncompatibleFormat(branch_format, self._format)
1772
self.transport.mkdir('branch', mode=self._get_mkdir_mode())
1773
except errors.FileExists:
1775
return self.transport.clone('branch')
1777
def get_repository_transport(self, repository_format):
1778
"""See BzrDir.get_repository_transport()."""
1779
if repository_format is None:
1780
return self.transport.clone('repository')
1782
repository_format.get_format_string()
1783
except NotImplementedError:
1784
raise errors.IncompatibleFormat(repository_format, self._format)
1786
self.transport.mkdir('repository', mode=self._get_mkdir_mode())
1787
except errors.FileExists:
1789
return self.transport.clone('repository')
1791
def get_workingtree_transport(self, workingtree_format):
1792
"""See BzrDir.get_workingtree_transport()."""
1793
if workingtree_format is None:
1794
return self.transport.clone('checkout')
1796
workingtree_format.get_format_string()
1797
except NotImplementedError:
1798
raise errors.IncompatibleFormat(workingtree_format, self._format)
1800
self.transport.mkdir('checkout', mode=self._get_mkdir_mode())
1801
except errors.FileExists:
1803
return self.transport.clone('checkout')
1805
def has_workingtree(self):
1806
"""Tell if this bzrdir contains a working tree.
1808
This will still raise an exception if the bzrdir has a workingtree that
1809
is remote & inaccessible.
1811
Note: if you're going to open the working tree, you should just go
1812
ahead and try, and not ask permission first.
1814
from bzrlib.workingtree import WorkingTreeFormat
1816
WorkingTreeFormat.find_format(self)
1817
except errors.NoWorkingTree:
1821
def needs_format_conversion(self, format=None):
1822
"""See BzrDir.needs_format_conversion()."""
1824
symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1825
% 'needs_format_conversion(format=None)')
1827
format = BzrDirFormat.get_default_format()
1828
if not isinstance(self._format, format.__class__):
1829
# it is not a meta dir format, conversion is needed.
1831
# we might want to push this down to the repository?
1833
if not isinstance(self.open_repository()._format,
1834
format.repository_format.__class__):
1835
# the repository needs an upgrade.
1837
except errors.NoRepositoryPresent:
1839
for branch in self.list_branches():
1840
if not isinstance(branch._format,
1841
format.get_branch_format().__class__):
1842
# the branch needs an upgrade.
1845
my_wt = self.open_workingtree(recommend_upgrade=False)
1846
if not isinstance(my_wt._format,
1847
format.workingtree_format.__class__):
1848
# the workingtree needs an upgrade.
1850
except (errors.NoWorkingTree, errors.NotLocalUrl):
1854
def open_branch(self, name=None, unsupported=False,
1855
ignore_fallbacks=False):
1856
"""See BzrDir.open_branch."""
1857
format = self.find_branch_format()
1858
self._check_supported(format, unsupported)
1859
return format.open(self, name=name,
1860
_found=True, ignore_fallbacks=ignore_fallbacks)
1862
def open_repository(self, unsupported=False):
1863
"""See BzrDir.open_repository."""
1864
from bzrlib.repository import RepositoryFormat
1865
format = RepositoryFormat.find_format(self)
1866
self._check_supported(format, unsupported)
1867
return format.open(self, _found=True)
1869
def open_workingtree(self, unsupported=False,
1870
recommend_upgrade=True):
1871
"""See BzrDir.open_workingtree."""
1872
from bzrlib.workingtree import WorkingTreeFormat
1873
format = WorkingTreeFormat.find_format(self)
1874
self._check_supported(format, unsupported,
1876
basedir=self.root_transport.base)
1877
return format.open(self, _found=True)
1879
def _get_config(self):
1880
return config.TransportConfig(self.transport, 'control.conf')
1883
class BzrDirFormat(object):
1884
"""An encapsulation of the initialization and open routines for a format.
1886
Formats provide three things:
1887
* An initialization routine,
1891
Formats are placed in a dict by their format string for reference
1892
during bzrdir opening. These should be subclasses of BzrDirFormat
1895
Once a format is deprecated, just deprecate the initialize and open
1896
methods on the format class. Do not deprecate the object, as the
1897
object will be created every system load.
1899
:cvar colocated_branches: Whether this formats supports colocated branches.
1902
_default_format = None
1903
"""The default format used for new .bzr dirs."""
1906
"""The known formats."""
1908
_control_formats = []
1909
"""The registered control formats - .bzr, ....
1911
This is a list of BzrDirFormat objects.
1914
_control_server_formats = []
1915
"""The registered control server formats, e.g. RemoteBzrDirs.
1917
This is a list of BzrDirFormat objects.
1920
_lock_file_name = 'branch-lock'
1922
colocated_branches = False
1923
"""Whether co-located branches are supported for this control dir format.
1926
# _lock_class must be set in subclasses to the lock type, typ.
1927
# TransportLock or LockDir
1930
def find_format(klass, transport, _server_formats=True):
1931
"""Return the format present at transport."""
1933
formats = klass._control_server_formats + klass._control_formats
1935
formats = klass._control_formats
1936
for format in formats:
1938
return format.probe_transport(transport)
1939
except errors.NotBranchError:
1940
# this format does not find a control dir here.
1942
raise errors.NotBranchError(path=transport.base)
1945
def probe_transport(klass, transport):
1946
"""Return the .bzrdir style format present in a directory."""
1948
format_string = transport.get_bytes(".bzr/branch-format")
1949
except errors.NoSuchFile:
1950
raise errors.NotBranchError(path=transport.base)
1953
return klass._formats[format_string]
1955
raise errors.UnknownFormatError(format=format_string, kind='bzrdir')
1958
def get_default_format(klass):
1959
"""Return the current default format."""
1960
return klass._default_format
1962
def get_format_string(self):
1963
"""Return the ASCII format string that identifies this format."""
1964
raise NotImplementedError(self.get_format_string)
1966
def get_format_description(self):
1967
"""Return the short description for this format."""
1968
raise NotImplementedError(self.get_format_description)
1970
def get_converter(self, format=None):
1971
"""Return the converter to use to convert bzrdirs needing converts.
1973
This returns a bzrlib.bzrdir.Converter object.
1975
This should return the best upgrader to step this format towards the
1976
current default format. In the case of plugins we can/should provide
1977
some means for them to extend the range of returnable converters.
1979
:param format: Optional format to override the default format of the
1982
raise NotImplementedError(self.get_converter)
1984
def initialize(self, url, possible_transports=None):
1985
"""Create a bzr control dir at this url and return an opened copy.
1987
While not deprecated, this method is very specific and its use will
1988
lead to many round trips to setup a working environment. See
1989
initialize_on_transport_ex for a [nearly] all-in-one method.
1991
Subclasses should typically override initialize_on_transport
1992
instead of this method.
1994
return self.initialize_on_transport(get_transport(url,
1995
possible_transports))
1997
def initialize_on_transport(self, transport):
1998
"""Initialize a new bzrdir in the base directory of a Transport."""
2000
# can we hand off the request to the smart server rather than using
2002
client_medium = transport.get_smart_medium()
2003
except errors.NoSmartMedium:
2004
return self._initialize_on_transport_vfs(transport)
2006
# Current RPC's only know how to create bzr metadir1 instances, so
2007
# we still delegate to vfs methods if the requested format is not a
2009
if type(self) != BzrDirMetaFormat1:
2010
return self._initialize_on_transport_vfs(transport)
2011
remote_format = RemoteBzrDirFormat()
2012
self._supply_sub_formats_to(remote_format)
2013
return remote_format.initialize_on_transport(transport)
2015
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
2016
create_prefix=False, force_new_repo=False, stacked_on=None,
2017
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
2018
shared_repo=False, vfs_only=False):
2019
"""Create this format on transport.
2021
The directory to initialize will be created.
2023
:param force_new_repo: Do not use a shared repository for the target,
2024
even if one is available.
2025
:param create_prefix: Create any missing directories leading up to
2027
:param use_existing_dir: Use an existing directory if one exists.
2028
:param stacked_on: A url to stack any created branch on, None to follow
2029
any target stacking policy.
2030
:param stack_on_pwd: If stack_on is relative, the location it is
2032
:param repo_format_name: If non-None, a repository will be
2033
made-or-found. Should none be found, or if force_new_repo is True
2034
the repo_format_name is used to select the format of repository to
2036
:param make_working_trees: Control the setting of make_working_trees
2037
for a new shared repository when one is made. None to use whatever
2038
default the format has.
2039
:param shared_repo: Control whether made repositories are shared or
2041
:param vfs_only: If True do not attempt to use a smart server
2042
:return: repo, bzrdir, require_stacking, repository_policy. repo is
2043
None if none was created or found, bzrdir is always valid.
2044
require_stacking is the result of examining the stacked_on
2045
parameter and any stacking policy found for the target.
2048
# Try to hand off to a smart server
2050
client_medium = transport.get_smart_medium()
2051
except errors.NoSmartMedium:
2054
# TODO: lookup the local format from a server hint.
2055
remote_dir_format = RemoteBzrDirFormat()
2056
remote_dir_format._network_name = self.network_name()
2057
self._supply_sub_formats_to(remote_dir_format)
2058
return remote_dir_format.initialize_on_transport_ex(transport,
2059
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2060
force_new_repo=force_new_repo, stacked_on=stacked_on,
2061
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2062
make_working_trees=make_working_trees, shared_repo=shared_repo)
2063
# XXX: Refactor the create_prefix/no_create_prefix code into a
2064
# common helper function
2065
# The destination may not exist - if so make it according to policy.
2066
def make_directory(transport):
2067
transport.mkdir('.')
2069
def redirected(transport, e, redirection_notice):
2070
note(redirection_notice)
2071
return transport._redirected_to(e.source, e.target)
2073
transport = do_catching_redirections(make_directory, transport,
2075
except errors.FileExists:
2076
if not use_existing_dir:
2078
except errors.NoSuchFile:
2079
if not create_prefix:
2081
transport.create_prefix()
2083
require_stacking = (stacked_on is not None)
2084
# Now the target directory exists, but doesn't have a .bzr
2085
# directory. So we need to create it, along with any work to create
2086
# all of the dependent branches, etc.
2088
result = self.initialize_on_transport(transport)
2089
if repo_format_name:
2091
# use a custom format
2092
result._format.repository_format = \
2093
repository.network_format_registry.get(repo_format_name)
2094
except AttributeError:
2095
# The format didn't permit it to be set.
2097
# A repository is desired, either in-place or shared.
2098
repository_policy = result.determine_repository_policy(
2099
force_new_repo, stacked_on, stack_on_pwd,
2100
require_stacking=require_stacking)
2101
result_repo, is_new_repo = repository_policy.acquire_repository(
2102
make_working_trees, shared_repo)
2103
if not require_stacking and repository_policy._require_stacking:
2104
require_stacking = True
2105
result._format.require_stacking()
2106
result_repo.lock_write()
2109
repository_policy = None
2110
return result_repo, result, require_stacking, repository_policy
2112
def _initialize_on_transport_vfs(self, transport):
2113
"""Initialize a new bzrdir using VFS calls.
2115
:param transport: The transport to create the .bzr directory in.
2118
# Since we are creating a .bzr directory, inherit the
2119
# mode from the root directory
2120
temp_control = lockable_files.LockableFiles(transport,
2121
'', lockable_files.TransportLock)
2122
temp_control._transport.mkdir('.bzr',
2123
# FIXME: RBC 20060121 don't peek under
2125
mode=temp_control._dir_mode)
2126
if sys.platform == 'win32' and isinstance(transport, local.LocalTransport):
2127
win32utils.set_file_attr_hidden(transport._abspath('.bzr'))
2128
file_mode = temp_control._file_mode
2130
bzrdir_transport = transport.clone('.bzr')
2131
utf8_files = [('README',
2132
"This is a Bazaar control directory.\n"
2133
"Do not change any files in this directory.\n"
2134
"See http://bazaar-vcs.org/ for more information about Bazaar.\n"),
2135
('branch-format', self.get_format_string()),
2137
# NB: no need to escape relative paths that are url safe.
2138
control_files = lockable_files.LockableFiles(bzrdir_transport,
2139
self._lock_file_name, self._lock_class)
2140
control_files.create_lock()
2141
control_files.lock_write()
2143
for (filename, content) in utf8_files:
2144
bzrdir_transport.put_bytes(filename, content,
2147
control_files.unlock()
2148
return self.open(transport, _found=True)
2150
def is_supported(self):
2151
"""Is this format supported?
2153
Supported formats must be initializable and openable.
2154
Unsupported formats may not support initialization or committing or
2155
some other features depending on the reason for not being supported.
2159
def network_name(self):
2160
"""A simple byte string uniquely identifying this format for RPC calls.
2162
Bzr control formats use thir disk format string to identify the format
2163
over the wire. Its possible that other control formats have more
2164
complex detection requirements, so we permit them to use any unique and
2165
immutable string they desire.
2167
raise NotImplementedError(self.network_name)
2169
def same_model(self, target_format):
2170
return (self.repository_format.rich_root_data ==
2171
target_format.rich_root_data)
2174
def known_formats(klass):
2175
"""Return all the known formats.
2177
Concrete formats should override _known_formats.
2179
# There is double indirection here to make sure that control
2180
# formats used by more than one dir format will only be probed
2181
# once. This can otherwise be quite expensive for remote connections.
2183
for format in klass._control_formats:
2184
result.update(format._known_formats())
2188
def _known_formats(klass):
2189
"""Return the known format instances for this control format."""
2190
return set(klass._formats.values())
2192
def open(self, transport, _found=False):
2193
"""Return an instance of this format for the dir transport points at.
2195
_found is a private parameter, do not use it.
2198
found_format = BzrDirFormat.find_format(transport)
2199
if not isinstance(found_format, self.__class__):
2200
raise AssertionError("%s was asked to open %s, but it seems to need "
2202
% (self, transport, found_format))
2203
# Allow subclasses - use the found format.
2204
self._supply_sub_formats_to(found_format)
2205
return found_format._open(transport)
2206
return self._open(transport)
2208
def _open(self, transport):
2209
"""Template method helper for opening BzrDirectories.
2211
This performs the actual open and any additional logic or parameter
2214
raise NotImplementedError(self._open)
2217
def register_format(klass, format):
2218
klass._formats[format.get_format_string()] = format
2219
# bzr native formats have a network name of their format string.
2220
network_format_registry.register(format.get_format_string(), format.__class__)
2223
def register_control_format(klass, format):
2224
"""Register a format that does not use '.bzr' for its control dir.
2226
TODO: This should be pulled up into a 'ControlDirFormat' base class
2227
which BzrDirFormat can inherit from, and renamed to register_format
2228
there. It has been done without that for now for simplicity of
2231
klass._control_formats.append(format)
2234
def register_control_server_format(klass, format):
2235
"""Register a control format for client-server environments.
2237
These formats will be tried before ones registered with
2238
register_control_format. This gives implementations that decide to the
2239
chance to grab it before anything looks at the contents of the format
2242
klass._control_server_formats.append(format)
2245
def _set_default_format(klass, format):
2246
"""Set default format (for testing behavior of defaults only)"""
2247
klass._default_format = format
2251
return self.get_format_description().rstrip()
2253
def _supply_sub_formats_to(self, other_format):
2254
"""Give other_format the same values for sub formats as this has.
2256
This method is expected to be used when parameterising a
2257
RemoteBzrDirFormat instance with the parameters from a
2258
BzrDirMetaFormat1 instance.
2260
:param other_format: other_format is a format which should be
2261
compatible with whatever sub formats are supported by self.
2266
def unregister_format(klass, format):
2267
del klass._formats[format.get_format_string()]
2270
def unregister_control_format(klass, format):
2271
klass._control_formats.remove(format)
2274
class BzrDirFormat4(BzrDirFormat):
2275
"""Bzr dir format 4.
2277
This format is a combined format for working tree, branch and repository.
2279
- Format 1 working trees [always]
2280
- Format 4 branches [always]
2281
- Format 4 repositories [always]
2283
This format is deprecated: it indexes texts using a text it which is
2284
removed in format 5; write support for this format has been removed.
2287
_lock_class = lockable_files.TransportLock
2289
def get_format_string(self):
2290
"""See BzrDirFormat.get_format_string()."""
2291
return "Bazaar-NG branch, format 0.0.4\n"
2293
def get_format_description(self):
2294
"""See BzrDirFormat.get_format_description()."""
2295
return "All-in-one format 4"
2297
def get_converter(self, format=None):
2298
"""See BzrDirFormat.get_converter()."""
2299
# there is one and only one upgrade path here.
2300
return ConvertBzrDir4To5()
2302
def initialize_on_transport(self, transport):
2303
"""Format 4 branches cannot be created."""
2304
raise errors.UninitializableFormat(self)
2306
def is_supported(self):
2307
"""Format 4 is not supported.
2309
It is not supported because the model changed from 4 to 5 and the
2310
conversion logic is expensive - so doing it on the fly was not
2315
def network_name(self):
2316
return self.get_format_string()
2318
def _open(self, transport):
2319
"""See BzrDirFormat._open."""
2320
return BzrDir4(transport, self)
2322
def __return_repository_format(self):
2323
"""Circular import protection."""
2324
from bzrlib.repofmt.weaverepo import RepositoryFormat4
2325
return RepositoryFormat4()
2326
repository_format = property(__return_repository_format)
2329
class BzrDirFormatAllInOne(BzrDirFormat):
2330
"""Common class for formats before meta-dirs."""
2332
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
2333
create_prefix=False, force_new_repo=False, stacked_on=None,
2334
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
2336
"""See BzrDirFormat.initialize_on_transport_ex."""
2337
require_stacking = (stacked_on is not None)
2338
# Format 5 cannot stack, but we've been asked to - actually init
2340
if require_stacking:
2341
format = BzrDirMetaFormat1()
2342
return format.initialize_on_transport_ex(transport,
2343
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2344
force_new_repo=force_new_repo, stacked_on=stacked_on,
2345
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2346
make_working_trees=make_working_trees, shared_repo=shared_repo)
2347
return BzrDirFormat.initialize_on_transport_ex(self, transport,
2348
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2349
force_new_repo=force_new_repo, stacked_on=stacked_on,
2350
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2351
make_working_trees=make_working_trees, shared_repo=shared_repo)
2354
class BzrDirFormat5(BzrDirFormatAllInOne):
2355
"""Bzr control format 5.
2357
This format is a combined format for working tree, branch and repository.
2359
- Format 2 working trees [always]
2360
- Format 4 branches [always]
2361
- Format 5 repositories [always]
2362
Unhashed stores in the repository.
2365
_lock_class = lockable_files.TransportLock
2367
def get_format_string(self):
2368
"""See BzrDirFormat.get_format_string()."""
2369
return "Bazaar-NG branch, format 5\n"
2371
def get_branch_format(self):
2372
from bzrlib import branch
2373
return branch.BzrBranchFormat4()
2375
def get_format_description(self):
2376
"""See BzrDirFormat.get_format_description()."""
2377
return "All-in-one format 5"
2379
def get_converter(self, format=None):
2380
"""See BzrDirFormat.get_converter()."""
2381
# there is one and only one upgrade path here.
2382
return ConvertBzrDir5To6()
2384
def _initialize_for_clone(self, url):
2385
return self.initialize_on_transport(get_transport(url), _cloning=True)
2387
def initialize_on_transport(self, transport, _cloning=False):
2388
"""Format 5 dirs always have working tree, branch and repository.
2390
Except when they are being cloned.
2392
from bzrlib.branch import BzrBranchFormat4
2393
from bzrlib.repofmt.weaverepo import RepositoryFormat5
2394
result = (super(BzrDirFormat5, self).initialize_on_transport(transport))
2395
RepositoryFormat5().initialize(result, _internal=True)
2397
branch = BzrBranchFormat4().initialize(result)
2398
result._init_workingtree()
2401
def network_name(self):
2402
return self.get_format_string()
2404
def _open(self, transport):
2405
"""See BzrDirFormat._open."""
2406
return BzrDir5(transport, self)
2408
def __return_repository_format(self):
2409
"""Circular import protection."""
2410
from bzrlib.repofmt.weaverepo import RepositoryFormat5
2411
return RepositoryFormat5()
2412
repository_format = property(__return_repository_format)
2415
class BzrDirFormat6(BzrDirFormatAllInOne):
2416
"""Bzr control format 6.
2418
This format is a combined format for working tree, branch and repository.
2420
- Format 2 working trees [always]
2421
- Format 4 branches [always]
2422
- Format 6 repositories [always]
2425
_lock_class = lockable_files.TransportLock
2427
def get_format_string(self):
2428
"""See BzrDirFormat.get_format_string()."""
2429
return "Bazaar-NG branch, format 6\n"
2431
def get_format_description(self):
2432
"""See BzrDirFormat.get_format_description()."""
2433
return "All-in-one format 6"
2435
def get_branch_format(self):
2436
from bzrlib import branch
2437
return branch.BzrBranchFormat4()
2439
def get_converter(self, format=None):
2440
"""See BzrDirFormat.get_converter()."""
2441
# there is one and only one upgrade path here.
2442
return ConvertBzrDir6ToMeta()
2444
def _initialize_for_clone(self, url):
2445
return self.initialize_on_transport(get_transport(url), _cloning=True)
2447
def initialize_on_transport(self, transport, _cloning=False):
2448
"""Format 6 dirs always have working tree, branch and repository.
2450
Except when they are being cloned.
2452
from bzrlib.branch import BzrBranchFormat4
2453
from bzrlib.repofmt.weaverepo import RepositoryFormat6
2454
result = super(BzrDirFormat6, self).initialize_on_transport(transport)
2455
RepositoryFormat6().initialize(result, _internal=True)
2457
branch = BzrBranchFormat4().initialize(result)
2458
result._init_workingtree()
2461
def network_name(self):
2462
return self.get_format_string()
2464
def _open(self, transport):
2465
"""See BzrDirFormat._open."""
2466
return BzrDir6(transport, self)
2468
def __return_repository_format(self):
2469
"""Circular import protection."""
2470
from bzrlib.repofmt.weaverepo import RepositoryFormat6
2471
return RepositoryFormat6()
2472
repository_format = property(__return_repository_format)
2475
class BzrDirMetaFormat1(BzrDirFormat):
2476
"""Bzr meta control format 1
2478
This is the first format with split out working tree, branch and repository
2481
- Format 3 working trees [optional]
2482
- Format 5 branches [optional]
2483
- Format 7 repositories [optional]
2486
_lock_class = lockdir.LockDir
2489
self._workingtree_format = None
2490
self._branch_format = None
2491
self._repository_format = None
2493
def __eq__(self, other):
2494
if other.__class__ is not self.__class__:
2496
if other.repository_format != self.repository_format:
2498
if other.workingtree_format != self.workingtree_format:
2502
def __ne__(self, other):
2503
return not self == other
2505
def get_branch_format(self):
2506
if self._branch_format is None:
2507
from bzrlib.branch import BranchFormat
2508
self._branch_format = BranchFormat.get_default_format()
2509
return self._branch_format
2511
def set_branch_format(self, format):
2512
self._branch_format = format
2514
def require_stacking(self, stack_on=None, possible_transports=None,
2516
"""We have a request to stack, try to ensure the formats support it.
2518
:param stack_on: If supplied, it is the URL to a branch that we want to
2519
stack on. Check to see if that format supports stacking before
2522
# Stacking is desired. requested by the target, but does the place it
2523
# points at support stacking? If it doesn't then we should
2524
# not implicitly upgrade. We check this here.
2525
new_repo_format = None
2526
new_branch_format = None
2528
# a bit of state for get_target_branch so that we don't try to open it
2529
# 2 times, for both repo *and* branch
2530
target = [None, False, None] # target_branch, checked, upgrade anyway
2531
def get_target_branch():
2533
# We've checked, don't check again
2535
if stack_on is None:
2536
# No target format, that means we want to force upgrading
2537
target[:] = [None, True, True]
2540
target_dir = BzrDir.open(stack_on,
2541
possible_transports=possible_transports)
2542
except errors.NotBranchError:
2543
# Nothing there, don't change formats
2544
target[:] = [None, True, False]
2546
except errors.JailBreak:
2547
# JailBreak, JFDI and upgrade anyway
2548
target[:] = [None, True, True]
2551
target_branch = target_dir.open_branch()
2552
except errors.NotBranchError:
2553
# No branch, don't upgrade formats
2554
target[:] = [None, True, False]
2556
target[:] = [target_branch, True, False]
2559
if (not _skip_repo and
2560
not self.repository_format.supports_external_lookups):
2561
# We need to upgrade the Repository.
2562
target_branch, _, do_upgrade = get_target_branch()
2563
if target_branch is None:
2564
# We don't have a target branch, should we upgrade anyway?
2566
# stack_on is inaccessible, JFDI.
2567
# TODO: bad monkey, hard-coded formats...
2568
if self.repository_format.rich_root_data:
2569
new_repo_format = pack_repo.RepositoryFormatKnitPack5RichRoot()
2571
new_repo_format = pack_repo.RepositoryFormatKnitPack5()
2573
# If the target already supports stacking, then we know the
2574
# project is already able to use stacking, so auto-upgrade
2576
new_repo_format = target_branch.repository._format
2577
if not new_repo_format.supports_external_lookups:
2578
# target doesn't, source doesn't, so don't auto upgrade
2580
new_repo_format = None
2581
if new_repo_format is not None:
2582
self.repository_format = new_repo_format
2583
note('Source repository format does not support stacking,'
2584
' using format:\n %s',
2585
new_repo_format.get_format_description())
2587
if not self.get_branch_format().supports_stacking():
2588
# We just checked the repo, now lets check if we need to
2589
# upgrade the branch format
2590
target_branch, _, do_upgrade = get_target_branch()
2591
if target_branch is None:
2593
# TODO: bad monkey, hard-coded formats...
2594
new_branch_format = branch.BzrBranchFormat7()
2596
new_branch_format = target_branch._format
2597
if not new_branch_format.supports_stacking():
2598
new_branch_format = None
2599
if new_branch_format is not None:
2600
# Does support stacking, use its format.
2601
self.set_branch_format(new_branch_format)
2602
note('Source branch format does not support stacking,'
2603
' using format:\n %s',
2604
new_branch_format.get_format_description())
2606
def get_converter(self, format=None):
2607
"""See BzrDirFormat.get_converter()."""
2609
format = BzrDirFormat.get_default_format()
2610
if not isinstance(self, format.__class__):
2611
# converting away from metadir is not implemented
2612
raise NotImplementedError(self.get_converter)
2613
return ConvertMetaToMeta(format)
2615
def get_format_string(self):
2616
"""See BzrDirFormat.get_format_string()."""
2617
return "Bazaar-NG meta directory, format 1\n"
2619
def get_format_description(self):
2620
"""See BzrDirFormat.get_format_description()."""
2621
return "Meta directory format 1"
2623
def network_name(self):
2624
return self.get_format_string()
2626
def _open(self, transport):
2627
"""See BzrDirFormat._open."""
2628
# Create a new format instance because otherwise initialisation of new
2629
# metadirs share the global default format object leading to alias
2631
format = BzrDirMetaFormat1()
2632
self._supply_sub_formats_to(format)
2633
return BzrDirMeta1(transport, format)
2635
def __return_repository_format(self):
2636
"""Circular import protection."""
2637
if self._repository_format:
2638
return self._repository_format
2639
from bzrlib.repository import RepositoryFormat
2640
return RepositoryFormat.get_default_format()
2642
def _set_repository_format(self, value):
2643
"""Allow changing the repository format for metadir formats."""
2644
self._repository_format = value
2646
repository_format = property(__return_repository_format,
2647
_set_repository_format)
2649
def _supply_sub_formats_to(self, other_format):
2650
"""Give other_format the same values for sub formats as this has.
2652
This method is expected to be used when parameterising a
2653
RemoteBzrDirFormat instance with the parameters from a
2654
BzrDirMetaFormat1 instance.
2656
:param other_format: other_format is a format which should be
2657
compatible with whatever sub formats are supported by self.
2660
if getattr(self, '_repository_format', None) is not None:
2661
other_format.repository_format = self.repository_format
2662
if self._branch_format is not None:
2663
other_format._branch_format = self._branch_format
2664
if self._workingtree_format is not None:
2665
other_format.workingtree_format = self.workingtree_format
2667
def __get_workingtree_format(self):
2668
if self._workingtree_format is None:
2669
from bzrlib.workingtree import WorkingTreeFormat
2670
self._workingtree_format = WorkingTreeFormat.get_default_format()
2671
return self._workingtree_format
2673
def __set_workingtree_format(self, wt_format):
2674
self._workingtree_format = wt_format
2676
workingtree_format = property(__get_workingtree_format,
2677
__set_workingtree_format)
2680
network_format_registry = registry.FormatRegistry()
2681
"""Registry of formats indexed by their network name.
2683
The network name for a BzrDirFormat is an identifier that can be used when
2684
referring to formats with smart server operations. See
2685
BzrDirFormat.network_name() for more detail.
2689
# Register bzr control format
2690
BzrDirFormat.register_control_format(BzrDirFormat)
2692
# Register bzr formats
2693
BzrDirFormat.register_format(BzrDirFormat4())
2694
BzrDirFormat.register_format(BzrDirFormat5())
2695
BzrDirFormat.register_format(BzrDirFormat6())
2696
__default_format = BzrDirMetaFormat1()
2697
BzrDirFormat.register_format(__default_format)
2698
BzrDirFormat._default_format = __default_format
2701
class Converter(object):
2702
"""Converts a disk format object from one format to another."""
2704
def convert(self, to_convert, pb):
2705
"""Perform the conversion of to_convert, giving feedback via pb.
2707
:param to_convert: The disk object to convert.
2708
:param pb: a progress bar to use for progress information.
2711
def step(self, message):
2712
"""Update the pb by a step."""
2714
self.pb.update(message, self.count, self.total)
2717
class ConvertBzrDir4To5(Converter):
2718
"""Converts format 4 bzr dirs to format 5."""
2721
super(ConvertBzrDir4To5, self).__init__()
2722
self.converted_revs = set()
2723
self.absent_revisions = set()
2727
def convert(self, to_convert, pb):
2728
"""See Converter.convert()."""
2729
self.bzrdir = to_convert
2731
warnings.warn("pb parameter to convert() is deprecated")
2732
self.pb = ui.ui_factory.nested_progress_bar()
2734
ui.ui_factory.note('starting upgrade from format 4 to 5')
2735
if isinstance(self.bzrdir.transport, local.LocalTransport):
2736
self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
2737
self._convert_to_weaves()
2738
return BzrDir.open(self.bzrdir.user_url)
2742
def _convert_to_weaves(self):
2743
ui.ui_factory.note('note: upgrade may be faster if all store files are ungzipped first')
2746
stat = self.bzrdir.transport.stat('weaves')
2747
if not S_ISDIR(stat.st_mode):
2748
self.bzrdir.transport.delete('weaves')
2749
self.bzrdir.transport.mkdir('weaves')
2750
except errors.NoSuchFile:
2751
self.bzrdir.transport.mkdir('weaves')
2752
# deliberately not a WeaveFile as we want to build it up slowly.
2753
self.inv_weave = Weave('inventory')
2754
# holds in-memory weaves for all files
2755
self.text_weaves = {}
2756
self.bzrdir.transport.delete('branch-format')
2757
self.branch = self.bzrdir.open_branch()
2758
self._convert_working_inv()
2759
rev_history = self.branch.revision_history()
2760
# to_read is a stack holding the revisions we still need to process;
2761
# appending to it adds new highest-priority revisions
2762
self.known_revisions = set(rev_history)
2763
self.to_read = rev_history[-1:]
2765
rev_id = self.to_read.pop()
2766
if (rev_id not in self.revisions
2767
and rev_id not in self.absent_revisions):
2768
self._load_one_rev(rev_id)
2770
to_import = self._make_order()
2771
for i, rev_id in enumerate(to_import):
2772
self.pb.update('converting revision', i, len(to_import))
2773
self._convert_one_rev(rev_id)
2775
self._write_all_weaves()
2776
self._write_all_revs()
2777
ui.ui_factory.note('upgraded to weaves:')
2778
ui.ui_factory.note(' %6d revisions and inventories' % len(self.revisions))
2779
ui.ui_factory.note(' %6d revisions not present' % len(self.absent_revisions))
2780
ui.ui_factory.note(' %6d texts' % self.text_count)
2781
self._cleanup_spare_files_after_format4()
2782
self.branch._transport.put_bytes(
2784
BzrDirFormat5().get_format_string(),
2785
mode=self.bzrdir._get_file_mode())
2787
def _cleanup_spare_files_after_format4(self):
2788
# FIXME working tree upgrade foo.
2789
for n in 'merged-patches', 'pending-merged-patches':
2791
## assert os.path.getsize(p) == 0
2792
self.bzrdir.transport.delete(n)
2793
except errors.NoSuchFile:
2795
self.bzrdir.transport.delete_tree('inventory-store')
2796
self.bzrdir.transport.delete_tree('text-store')
2798
def _convert_working_inv(self):
2799
inv = xml4.serializer_v4.read_inventory(
2800
self.branch._transport.get('inventory'))
2801
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv, working=True)
2802
self.branch._transport.put_bytes('inventory', new_inv_xml,
2803
mode=self.bzrdir._get_file_mode())
2805
def _write_all_weaves(self):
2806
controlweaves = WeaveStore(self.bzrdir.transport, prefixed=False)
2807
weave_transport = self.bzrdir.transport.clone('weaves')
2808
weaves = WeaveStore(weave_transport, prefixed=False)
2809
transaction = WriteTransaction()
2813
for file_id, file_weave in self.text_weaves.items():
2814
self.pb.update('writing weave', i, len(self.text_weaves))
2815
weaves._put_weave(file_id, file_weave, transaction)
2817
self.pb.update('inventory', 0, 1)
2818
controlweaves._put_weave('inventory', self.inv_weave, transaction)
2819
self.pb.update('inventory', 1, 1)
2823
def _write_all_revs(self):
2824
"""Write all revisions out in new form."""
2825
self.bzrdir.transport.delete_tree('revision-store')
2826
self.bzrdir.transport.mkdir('revision-store')
2827
revision_transport = self.bzrdir.transport.clone('revision-store')
2829
from bzrlib.xml5 import serializer_v5
2830
from bzrlib.repofmt.weaverepo import RevisionTextStore
2831
revision_store = RevisionTextStore(revision_transport,
2832
serializer_v5, False, versionedfile.PrefixMapper(),
2833
lambda:True, lambda:True)
2835
for i, rev_id in enumerate(self.converted_revs):
2836
self.pb.update('write revision', i, len(self.converted_revs))
2837
text = serializer_v5.write_revision_to_string(
2838
self.revisions[rev_id])
2840
revision_store.add_lines(key, None, osutils.split_lines(text))
2844
def _load_one_rev(self, rev_id):
2845
"""Load a revision object into memory.
2847
Any parents not either loaded or abandoned get queued to be
2849
self.pb.update('loading revision',
2850
len(self.revisions),
2851
len(self.known_revisions))
2852
if not self.branch.repository.has_revision(rev_id):
2854
ui.ui_factory.note('revision {%s} not present in branch; '
2855
'will be converted as a ghost' %
2857
self.absent_revisions.add(rev_id)
2859
rev = self.branch.repository.get_revision(rev_id)
2860
for parent_id in rev.parent_ids:
2861
self.known_revisions.add(parent_id)
2862
self.to_read.append(parent_id)
2863
self.revisions[rev_id] = rev
2865
def _load_old_inventory(self, rev_id):
2866
old_inv_xml = self.branch.repository.inventory_store.get(rev_id).read()
2867
inv = xml4.serializer_v4.read_inventory_from_string(old_inv_xml)
2868
inv.revision_id = rev_id
2869
rev = self.revisions[rev_id]
2872
def _load_updated_inventory(self, rev_id):
2873
inv_xml = self.inv_weave.get_text(rev_id)
2874
inv = xml5.serializer_v5.read_inventory_from_string(inv_xml, rev_id)
2877
def _convert_one_rev(self, rev_id):
2878
"""Convert revision and all referenced objects to new format."""
2879
rev = self.revisions[rev_id]
2880
inv = self._load_old_inventory(rev_id)
2881
present_parents = [p for p in rev.parent_ids
2882
if p not in self.absent_revisions]
2883
self._convert_revision_contents(rev, inv, present_parents)
2884
self._store_new_inv(rev, inv, present_parents)
2885
self.converted_revs.add(rev_id)
2887
def _store_new_inv(self, rev, inv, present_parents):
2888
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
2889
new_inv_sha1 = sha_string(new_inv_xml)
2890
self.inv_weave.add_lines(rev.revision_id,
2892
new_inv_xml.splitlines(True))
2893
rev.inventory_sha1 = new_inv_sha1
2895
def _convert_revision_contents(self, rev, inv, present_parents):
2896
"""Convert all the files within a revision.
2898
Also upgrade the inventory to refer to the text revision ids."""
2899
rev_id = rev.revision_id
2900
mutter('converting texts of revision {%s}',
2902
parent_invs = map(self._load_updated_inventory, present_parents)
2903
entries = inv.iter_entries()
2905
for path, ie in entries:
2906
self._convert_file_version(rev, ie, parent_invs)
2908
def _convert_file_version(self, rev, ie, parent_invs):
2909
"""Convert one version of one file.
2911
The file needs to be added into the weave if it is a merge
2912
of >=2 parents or if it's changed from its parent.
2914
file_id = ie.file_id
2915
rev_id = rev.revision_id
2916
w = self.text_weaves.get(file_id)
2919
self.text_weaves[file_id] = w
2920
text_changed = False
2921
parent_candiate_entries = ie.parent_candidates(parent_invs)
2922
heads = graph.Graph(self).heads(parent_candiate_entries.keys())
2923
# XXX: Note that this is unordered - and this is tolerable because
2924
# the previous code was also unordered.
2925
previous_entries = dict((head, parent_candiate_entries[head]) for head
2927
self.snapshot_ie(previous_entries, ie, w, rev_id)
2930
def get_parent_map(self, revision_ids):
2931
"""See graph.StackedParentsProvider.get_parent_map"""
2932
return dict((revision_id, self.revisions[revision_id])
2933
for revision_id in revision_ids
2934
if revision_id in self.revisions)
2936
def snapshot_ie(self, previous_revisions, ie, w, rev_id):
2937
# TODO: convert this logic, which is ~= snapshot to
2938
# a call to:. This needs the path figured out. rather than a work_tree
2939
# a v4 revision_tree can be given, or something that looks enough like
2940
# one to give the file content to the entry if it needs it.
2941
# and we need something that looks like a weave store for snapshot to
2943
#ie.snapshot(rev, PATH, previous_revisions, REVISION_TREE, InMemoryWeaveStore(self.text_weaves))
2944
if len(previous_revisions) == 1:
2945
previous_ie = previous_revisions.values()[0]
2946
if ie._unchanged(previous_ie):
2947
ie.revision = previous_ie.revision
2950
text = self.branch.repository._text_store.get(ie.text_id)
2951
file_lines = text.readlines()
2952
w.add_lines(rev_id, previous_revisions, file_lines)
2953
self.text_count += 1
2955
w.add_lines(rev_id, previous_revisions, [])
2956
ie.revision = rev_id
2958
def _make_order(self):
2959
"""Return a suitable order for importing revisions.
2961
The order must be such that an revision is imported after all
2962
its (present) parents.
2964
todo = set(self.revisions.keys())
2965
done = self.absent_revisions.copy()
2968
# scan through looking for a revision whose parents
2970
for rev_id in sorted(list(todo)):
2971
rev = self.revisions[rev_id]
2972
parent_ids = set(rev.parent_ids)
2973
if parent_ids.issubset(done):
2974
# can take this one now
2975
order.append(rev_id)
2981
class ConvertBzrDir5To6(Converter):
2982
"""Converts format 5 bzr dirs to format 6."""
2984
def convert(self, to_convert, pb):
2985
"""See Converter.convert()."""
2986
self.bzrdir = to_convert
2987
pb = ui.ui_factory.nested_progress_bar()
2989
ui.ui_factory.note('starting upgrade from format 5 to 6')
2990
self._convert_to_prefixed()
2991
return BzrDir.open(self.bzrdir.user_url)
2995
def _convert_to_prefixed(self):
2996
from bzrlib.store import TransportStore
2997
self.bzrdir.transport.delete('branch-format')
2998
for store_name in ["weaves", "revision-store"]:
2999
ui.ui_factory.note("adding prefixes to %s" % store_name)
3000
store_transport = self.bzrdir.transport.clone(store_name)
3001
store = TransportStore(store_transport, prefixed=True)
3002
for urlfilename in store_transport.list_dir('.'):
3003
filename = urlutils.unescape(urlfilename)
3004
if (filename.endswith(".weave") or
3005
filename.endswith(".gz") or
3006
filename.endswith(".sig")):
3007
file_id, suffix = os.path.splitext(filename)
3011
new_name = store._mapper.map((file_id,)) + suffix
3012
# FIXME keep track of the dirs made RBC 20060121
3014
store_transport.move(filename, new_name)
3015
except errors.NoSuchFile: # catches missing dirs strangely enough
3016
store_transport.mkdir(osutils.dirname(new_name))
3017
store_transport.move(filename, new_name)
3018
self.bzrdir.transport.put_bytes(
3020
BzrDirFormat6().get_format_string(),
3021
mode=self.bzrdir._get_file_mode())
3024
class ConvertBzrDir6ToMeta(Converter):
3025
"""Converts format 6 bzr dirs to metadirs."""
3027
def convert(self, to_convert, pb):
3028
"""See Converter.convert()."""
3029
from bzrlib.repofmt.weaverepo import RepositoryFormat7
3030
from bzrlib.branch import BzrBranchFormat5
3031
self.bzrdir = to_convert
3032
self.pb = ui.ui_factory.nested_progress_bar()
3034
self.total = 20 # the steps we know about
3035
self.garbage_inventories = []
3036
self.dir_mode = self.bzrdir._get_dir_mode()
3037
self.file_mode = self.bzrdir._get_file_mode()
3039
ui.ui_factory.note('starting upgrade from format 6 to metadir')
3040
self.bzrdir.transport.put_bytes(
3042
"Converting to format 6",
3043
mode=self.file_mode)
3044
# its faster to move specific files around than to open and use the apis...
3045
# first off, nuke ancestry.weave, it was never used.
3047
self.step('Removing ancestry.weave')
3048
self.bzrdir.transport.delete('ancestry.weave')
3049
except errors.NoSuchFile:
3051
# find out whats there
3052
self.step('Finding branch files')
3053
last_revision = self.bzrdir.open_branch().last_revision()
3054
bzrcontents = self.bzrdir.transport.list_dir('.')
3055
for name in bzrcontents:
3056
if name.startswith('basis-inventory.'):
3057
self.garbage_inventories.append(name)
3058
# create new directories for repository, working tree and branch
3059
repository_names = [('inventory.weave', True),
3060
('revision-store', True),
3062
self.step('Upgrading repository ')
3063
self.bzrdir.transport.mkdir('repository', mode=self.dir_mode)
3064
self.make_lock('repository')
3065
# we hard code the formats here because we are converting into
3066
# the meta format. The meta format upgrader can take this to a
3067
# future format within each component.
3068
self.put_format('repository', RepositoryFormat7())
3069
for entry in repository_names:
3070
self.move_entry('repository', entry)
3072
self.step('Upgrading branch ')
3073
self.bzrdir.transport.mkdir('branch', mode=self.dir_mode)
3074
self.make_lock('branch')
3075
self.put_format('branch', BzrBranchFormat5())
3076
branch_files = [('revision-history', True),
3077
('branch-name', True),
3079
for entry in branch_files:
3080
self.move_entry('branch', entry)
3082
checkout_files = [('pending-merges', True),
3083
('inventory', True),
3084
('stat-cache', False)]
3085
# If a mandatory checkout file is not present, the branch does not have
3086
# a functional checkout. Do not create a checkout in the converted
3088
for name, mandatory in checkout_files:
3089
if mandatory and name not in bzrcontents:
3090
has_checkout = False
3094
if not has_checkout:
3095
ui.ui_factory.note('No working tree.')
3096
# If some checkout files are there, we may as well get rid of them.
3097
for name, mandatory in checkout_files:
3098
if name in bzrcontents:
3099
self.bzrdir.transport.delete(name)
3101
from bzrlib.workingtree import WorkingTreeFormat3
3102
self.step('Upgrading working tree')
3103
self.bzrdir.transport.mkdir('checkout', mode=self.dir_mode)
3104
self.make_lock('checkout')
3106
'checkout', WorkingTreeFormat3())
3107
self.bzrdir.transport.delete_multi(
3108
self.garbage_inventories, self.pb)
3109
for entry in checkout_files:
3110
self.move_entry('checkout', entry)
3111
if last_revision is not None:
3112
self.bzrdir.transport.put_bytes(
3113
'checkout/last-revision', last_revision)
3114
self.bzrdir.transport.put_bytes(
3116
BzrDirMetaFormat1().get_format_string(),
3117
mode=self.file_mode)
3119
return BzrDir.open(self.bzrdir.user_url)
3121
def make_lock(self, name):
3122
"""Make a lock for the new control dir name."""
3123
self.step('Make %s lock' % name)
3124
ld = lockdir.LockDir(self.bzrdir.transport,
3126
file_modebits=self.file_mode,
3127
dir_modebits=self.dir_mode)
3130
def move_entry(self, new_dir, entry):
3131
"""Move then entry name into new_dir."""
3133
mandatory = entry[1]
3134
self.step('Moving %s' % name)
3136
self.bzrdir.transport.move(name, '%s/%s' % (new_dir, name))
3137
except errors.NoSuchFile:
3141
def put_format(self, dirname, format):
3142
self.bzrdir.transport.put_bytes('%s/format' % dirname,
3143
format.get_format_string(),
3147
class ConvertMetaToMeta(Converter):
3148
"""Converts the components of metadirs."""
3150
def __init__(self, target_format):
3151
"""Create a metadir to metadir converter.
3153
:param target_format: The final metadir format that is desired.
3155
self.target_format = target_format
3157
def convert(self, to_convert, pb):
3158
"""See Converter.convert()."""
3159
self.bzrdir = to_convert
3160
self.pb = ui.ui_factory.nested_progress_bar()
3163
self.step('checking repository format')
3165
repo = self.bzrdir.open_repository()
3166
except errors.NoRepositoryPresent:
3169
if not isinstance(repo._format, self.target_format.repository_format.__class__):
3170
from bzrlib.repository import CopyConverter
3171
ui.ui_factory.note('starting repository conversion')
3172
converter = CopyConverter(self.target_format.repository_format)
3173
converter.convert(repo, pb)
3174
for branch in self.bzrdir.list_branches():
3175
# TODO: conversions of Branch and Tree should be done by
3176
# InterXFormat lookups/some sort of registry.
3177
# Avoid circular imports
3178
from bzrlib import branch as _mod_branch
3179
old = branch._format.__class__
3180
new = self.target_format.get_branch_format().__class__
3182
if (old == _mod_branch.BzrBranchFormat5 and
3183
new in (_mod_branch.BzrBranchFormat6,
3184
_mod_branch.BzrBranchFormat7,
3185
_mod_branch.BzrBranchFormat8)):
3186
branch_converter = _mod_branch.Converter5to6()
3187
elif (old == _mod_branch.BzrBranchFormat6 and
3188
new in (_mod_branch.BzrBranchFormat7,
3189
_mod_branch.BzrBranchFormat8)):
3190
branch_converter = _mod_branch.Converter6to7()
3191
elif (old == _mod_branch.BzrBranchFormat7 and
3192
new is _mod_branch.BzrBranchFormat8):
3193
branch_converter = _mod_branch.Converter7to8()
3195
raise errors.BadConversionTarget("No converter", new,
3197
branch_converter.convert(branch)
3198
branch = self.bzrdir.open_branch()
3199
old = branch._format.__class__
3201
tree = self.bzrdir.open_workingtree(recommend_upgrade=False)
3202
except (errors.NoWorkingTree, errors.NotLocalUrl):
3205
# TODO: conversions of Branch and Tree should be done by
3206
# InterXFormat lookups
3207
if (isinstance(tree, workingtree.WorkingTree3) and
3208
not isinstance(tree, workingtree_4.DirStateWorkingTree) and
3209
isinstance(self.target_format.workingtree_format,
3210
workingtree_4.DirStateWorkingTreeFormat)):
3211
workingtree_4.Converter3to4().convert(tree)
3212
if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
3213
not isinstance(tree, workingtree_4.WorkingTree5) and
3214
isinstance(self.target_format.workingtree_format,
3215
workingtree_4.WorkingTreeFormat5)):
3216
workingtree_4.Converter4to5().convert(tree)
3217
if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
3218
not isinstance(tree, workingtree_4.WorkingTree6) and
3219
isinstance(self.target_format.workingtree_format,
3220
workingtree_4.WorkingTreeFormat6)):
3221
workingtree_4.Converter4or5to6().convert(tree)
3226
# This is not in remote.py because it's relatively small, and needs to be
3227
# registered. Putting it in remote.py creates a circular import problem.
3228
# we can make it a lazy object if the control formats is turned into something
3230
class RemoteBzrDirFormat(BzrDirMetaFormat1):
3231
"""Format representing bzrdirs accessed via a smart server"""
3234
BzrDirMetaFormat1.__init__(self)
3235
# XXX: It's a bit ugly that the network name is here, because we'd
3236
# like to believe that format objects are stateless or at least
3237
# immutable, However, we do at least avoid mutating the name after
3238
# it's returned. See <https://bugs.edge.launchpad.net/bzr/+bug/504102>
3239
self._network_name = None
3242
return "%s(_network_name=%r)" % (self.__class__.__name__,
3245
def get_format_description(self):
3246
if self._network_name:
3247
real_format = network_format_registry.get(self._network_name)
3248
return 'Remote: ' + real_format.get_format_description()
3249
return 'bzr remote bzrdir'
3251
def get_format_string(self):
3252
raise NotImplementedError(self.get_format_string)
3254
def network_name(self):
3255
if self._network_name:
3256
return self._network_name
3258
raise AssertionError("No network name set.")
3261
def probe_transport(klass, transport):
3262
"""Return a RemoteBzrDirFormat object if it looks possible."""
3264
medium = transport.get_smart_medium()
3265
except (NotImplementedError, AttributeError,
3266
errors.TransportNotPossible, errors.NoSmartMedium,
3267
errors.SmartProtocolError):
3268
# no smart server, so not a branch for this format type.
3269
raise errors.NotBranchError(path=transport.base)
3271
# Decline to open it if the server doesn't support our required
3272
# version (3) so that the VFS-based transport will do it.
3273
if medium.should_probe():
3275
server_version = medium.protocol_version()
3276
except errors.SmartProtocolError:
3277
# Apparently there's no usable smart server there, even though
3278
# the medium supports the smart protocol.
3279
raise errors.NotBranchError(path=transport.base)
3280
if server_version != '2':
3281
raise errors.NotBranchError(path=transport.base)
3284
def initialize_on_transport(self, transport):
3286
# hand off the request to the smart server
3287
client_medium = transport.get_smart_medium()
3288
except errors.NoSmartMedium:
3289
# TODO: lookup the local format from a server hint.
3290
local_dir_format = BzrDirMetaFormat1()
3291
return local_dir_format.initialize_on_transport(transport)
3292
client = _SmartClient(client_medium)
3293
path = client.remote_path_from_transport(transport)
3295
response = client.call('BzrDirFormat.initialize', path)
3296
except errors.ErrorFromSmartServer, err:
3297
remote._translate_error(err, path=path)
3298
if response[0] != 'ok':
3299
raise errors.SmartProtocolError('unexpected response code %s' % (response,))
3300
format = RemoteBzrDirFormat()
3301
self._supply_sub_formats_to(format)
3302
return remote.RemoteBzrDir(transport, format)
3304
def parse_NoneTrueFalse(self, arg):
3311
raise AssertionError("invalid arg %r" % arg)
3313
def _serialize_NoneTrueFalse(self, arg):
3320
def _serialize_NoneString(self, arg):
3323
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
3324
create_prefix=False, force_new_repo=False, stacked_on=None,
3325
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
3328
# hand off the request to the smart server
3329
client_medium = transport.get_smart_medium()
3330
except errors.NoSmartMedium:
3333
# Decline to open it if the server doesn't support our required
3334
# version (3) so that the VFS-based transport will do it.
3335
if client_medium.should_probe():
3337
server_version = client_medium.protocol_version()
3338
if server_version != '2':
3342
except errors.SmartProtocolError:
3343
# Apparently there's no usable smart server there, even though
3344
# the medium supports the smart protocol.
3349
client = _SmartClient(client_medium)
3350
path = client.remote_path_from_transport(transport)
3351
if client_medium._is_remote_before((1, 16)):
3354
# TODO: lookup the local format from a server hint.
3355
local_dir_format = BzrDirMetaFormat1()
3356
self._supply_sub_formats_to(local_dir_format)
3357
return local_dir_format.initialize_on_transport_ex(transport,
3358
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3359
force_new_repo=force_new_repo, stacked_on=stacked_on,
3360
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3361
make_working_trees=make_working_trees, shared_repo=shared_repo,
3363
return self._initialize_on_transport_ex_rpc(client, path, transport,
3364
use_existing_dir, create_prefix, force_new_repo, stacked_on,
3365
stack_on_pwd, repo_format_name, make_working_trees, shared_repo)
3367
def _initialize_on_transport_ex_rpc(self, client, path, transport,
3368
use_existing_dir, create_prefix, force_new_repo, stacked_on,
3369
stack_on_pwd, repo_format_name, make_working_trees, shared_repo):
3371
args.append(self._serialize_NoneTrueFalse(use_existing_dir))
3372
args.append(self._serialize_NoneTrueFalse(create_prefix))
3373
args.append(self._serialize_NoneTrueFalse(force_new_repo))
3374
args.append(self._serialize_NoneString(stacked_on))
3375
# stack_on_pwd is often/usually our transport
3378
stack_on_pwd = transport.relpath(stack_on_pwd)
3379
if not stack_on_pwd:
3381
except errors.PathNotChild:
3383
args.append(self._serialize_NoneString(stack_on_pwd))
3384
args.append(self._serialize_NoneString(repo_format_name))
3385
args.append(self._serialize_NoneTrueFalse(make_working_trees))
3386
args.append(self._serialize_NoneTrueFalse(shared_repo))
3387
request_network_name = self._network_name or \
3388
BzrDirFormat.get_default_format().network_name()
3390
response = client.call('BzrDirFormat.initialize_ex_1.16',
3391
request_network_name, path, *args)
3392
except errors.UnknownSmartMethod:
3393
client._medium._remember_remote_is_before((1,16))
3394
local_dir_format = BzrDirMetaFormat1()
3395
self._supply_sub_formats_to(local_dir_format)
3396
return local_dir_format.initialize_on_transport_ex(transport,
3397
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3398
force_new_repo=force_new_repo, stacked_on=stacked_on,
3399
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3400
make_working_trees=make_working_trees, shared_repo=shared_repo,
3402
except errors.ErrorFromSmartServer, err:
3403
remote._translate_error(err, path=path)
3404
repo_path = response[0]
3405
bzrdir_name = response[6]
3406
require_stacking = response[7]
3407
require_stacking = self.parse_NoneTrueFalse(require_stacking)
3408
format = RemoteBzrDirFormat()
3409
format._network_name = bzrdir_name
3410
self._supply_sub_formats_to(format)
3411
bzrdir = remote.RemoteBzrDir(transport, format, _client=client)
3413
repo_format = remote.response_tuple_to_repo_format(response[1:])
3414
if repo_path == '.':
3417
repo_bzrdir_format = RemoteBzrDirFormat()
3418
repo_bzrdir_format._network_name = response[5]
3419
repo_bzr = remote.RemoteBzrDir(transport.clone(repo_path),
3423
final_stack = response[8] or None
3424
final_stack_pwd = response[9] or None
3426
final_stack_pwd = urlutils.join(
3427
transport.base, final_stack_pwd)
3428
remote_repo = remote.RemoteRepository(repo_bzr, repo_format)
3429
if len(response) > 10:
3430
# Updated server verb that locks remotely.
3431
repo_lock_token = response[10] or None
3432
remote_repo.lock_write(repo_lock_token, _skip_rpc=True)
3434
remote_repo.dont_leave_lock_in_place()
3436
remote_repo.lock_write()
3437
policy = UseExistingRepository(remote_repo, final_stack,
3438
final_stack_pwd, require_stacking)
3439
policy.acquire_repository()
3443
bzrdir._format.set_branch_format(self.get_branch_format())
3444
if require_stacking:
3445
# The repo has already been created, but we need to make sure that
3446
# we'll make a stackable branch.
3447
bzrdir._format.require_stacking(_skip_repo=True)
3448
return remote_repo, bzrdir, require_stacking, policy
3450
def _open(self, transport):
3451
return remote.RemoteBzrDir(transport, self)
3453
def __eq__(self, other):
3454
if not isinstance(other, RemoteBzrDirFormat):
3456
return self.get_format_description() == other.get_format_description()
3458
def __return_repository_format(self):
3459
# Always return a RemoteRepositoryFormat object, but if a specific bzr
3460
# repository format has been asked for, tell the RemoteRepositoryFormat
3461
# that it should use that for init() etc.
3462
result = remote.RemoteRepositoryFormat()
3463
custom_format = getattr(self, '_repository_format', None)
3465
if isinstance(custom_format, remote.RemoteRepositoryFormat):
3466
return custom_format
3468
# We will use the custom format to create repositories over the
3469
# wire; expose its details like rich_root_data for code to
3471
result._custom_format = custom_format
3474
def get_branch_format(self):
3475
result = BzrDirMetaFormat1.get_branch_format(self)
3476
if not isinstance(result, remote.RemoteBranchFormat):
3477
new_result = remote.RemoteBranchFormat()
3478
new_result._custom_format = result
3480
self.set_branch_format(new_result)
3484
repository_format = property(__return_repository_format,
3485
BzrDirMetaFormat1._set_repository_format) #.im_func)
3488
BzrDirFormat.register_control_server_format(RemoteBzrDirFormat)
3491
class BzrDirFormatInfo(object):
3493
def __init__(self, native, deprecated, hidden, experimental):
3494
self.deprecated = deprecated
3495
self.native = native
3496
self.hidden = hidden
3497
self.experimental = experimental
3500
class BzrDirFormatRegistry(registry.Registry):
3501
"""Registry of user-selectable BzrDir subformats.
3503
Differs from BzrDirFormat._control_formats in that it provides sub-formats,
3504
e.g. BzrDirMeta1 with weave repository. Also, it's more user-oriented.
3508
"""Create a BzrDirFormatRegistry."""
3509
self._aliases = set()
3510
self._registration_order = list()
3511
super(BzrDirFormatRegistry, self).__init__()
3514
"""Return a set of the format names which are aliases."""
3515
return frozenset(self._aliases)
3517
def register_metadir(self, key,
3518
repository_format, help, native=True, deprecated=False,
3524
"""Register a metadir subformat.
3526
These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
3527
by the Repository/Branch/WorkingTreeformats.
3529
:param repository_format: The fully-qualified repository format class
3531
:param branch_format: Fully-qualified branch format class name as
3533
:param tree_format: Fully-qualified tree format class name as
3536
# This should be expanded to support setting WorkingTree and Branch
3537
# formats, once BzrDirMetaFormat1 supports that.
3538
def _load(full_name):
3539
mod_name, factory_name = full_name.rsplit('.', 1)
3541
mod = __import__(mod_name, globals(), locals(),
3543
except ImportError, e:
3544
raise ImportError('failed to load %s: %s' % (full_name, e))
3546
factory = getattr(mod, factory_name)
3547
except AttributeError:
3548
raise AttributeError('no factory %s in module %r'
3553
bd = BzrDirMetaFormat1()
3554
if branch_format is not None:
3555
bd.set_branch_format(_load(branch_format))
3556
if tree_format is not None:
3557
bd.workingtree_format = _load(tree_format)
3558
if repository_format is not None:
3559
bd.repository_format = _load(repository_format)
3561
self.register(key, helper, help, native, deprecated, hidden,
3562
experimental, alias)
3564
def register(self, key, factory, help, native=True, deprecated=False,
3565
hidden=False, experimental=False, alias=False):
3566
"""Register a BzrDirFormat factory.
3568
The factory must be a callable that takes one parameter: the key.
3569
It must produce an instance of the BzrDirFormat when called.
3571
This function mainly exists to prevent the info object from being
3574
registry.Registry.register(self, key, factory, help,
3575
BzrDirFormatInfo(native, deprecated, hidden, experimental))
3577
self._aliases.add(key)
3578
self._registration_order.append(key)
3580
def register_lazy(self, key, module_name, member_name, help, native=True,
3581
deprecated=False, hidden=False, experimental=False, alias=False):
3582
registry.Registry.register_lazy(self, key, module_name, member_name,
3583
help, BzrDirFormatInfo(native, deprecated, hidden, experimental))
3585
self._aliases.add(key)
3586
self._registration_order.append(key)
3588
def set_default(self, key):
3589
"""Set the 'default' key to be a clone of the supplied key.
3591
This method must be called once and only once.
3593
registry.Registry.register(self, 'default', self.get(key),
3594
self.get_help(key), info=self.get_info(key))
3595
self._aliases.add('default')
3597
def set_default_repository(self, key):
3598
"""Set the FormatRegistry default and Repository default.
3600
This is a transitional method while Repository.set_default_format
3603
if 'default' in self:
3604
self.remove('default')
3605
self.set_default(key)
3606
format = self.get('default')()
3608
def make_bzrdir(self, key):
3609
return self.get(key)()
3611
def help_topic(self, topic):
3613
default_realkey = None
3614
default_help = self.get_help('default')
3616
for key in self._registration_order:
3617
if key == 'default':
3619
help = self.get_help(key)
3620
if help == default_help:
3621
default_realkey = key
3623
help_pairs.append((key, help))
3625
def wrapped(key, help, info):
3627
help = '(native) ' + help
3628
return ':%s:\n%s\n\n' % (key,
3629
textwrap.fill(help, initial_indent=' ',
3630
subsequent_indent=' ',
3631
break_long_words=False))
3632
if default_realkey is not None:
3633
output += wrapped(default_realkey, '(default) %s' % default_help,
3634
self.get_info('default'))
3635
deprecated_pairs = []
3636
experimental_pairs = []
3637
for key, help in help_pairs:
3638
info = self.get_info(key)
3641
elif info.deprecated:
3642
deprecated_pairs.append((key, help))
3643
elif info.experimental:
3644
experimental_pairs.append((key, help))
3646
output += wrapped(key, help, info)
3647
output += "\nSee :doc:`formats-help` for more about storage formats."
3649
if len(experimental_pairs) > 0:
3650
other_output += "Experimental formats are shown below.\n\n"
3651
for key, help in experimental_pairs:
3652
info = self.get_info(key)
3653
other_output += wrapped(key, help, info)
3656
"No experimental formats are available.\n\n"
3657
if len(deprecated_pairs) > 0:
3658
other_output += "\nDeprecated formats are shown below.\n\n"
3659
for key, help in deprecated_pairs:
3660
info = self.get_info(key)
3661
other_output += wrapped(key, help, info)
3664
"\nNo deprecated formats are available.\n\n"
3666
"\nSee :doc:`formats-help` for more about storage formats."
3668
if topic == 'other-formats':
3674
class RepositoryAcquisitionPolicy(object):
3675
"""Abstract base class for repository acquisition policies.
3677
A repository acquisition policy decides how a BzrDir acquires a repository
3678
for a branch that is being created. The most basic policy decision is
3679
whether to create a new repository or use an existing one.
3681
def __init__(self, stack_on, stack_on_pwd, require_stacking):
3684
:param stack_on: A location to stack on
3685
:param stack_on_pwd: If stack_on is relative, the location it is
3687
:param require_stacking: If True, it is a failure to not stack.
3689
self._stack_on = stack_on
3690
self._stack_on_pwd = stack_on_pwd
3691
self._require_stacking = require_stacking
3693
def configure_branch(self, branch):
3694
"""Apply any configuration data from this policy to the branch.
3696
Default implementation sets repository stacking.
3698
if self._stack_on is None:
3700
if self._stack_on_pwd is None:
3701
stack_on = self._stack_on
3704
stack_on = urlutils.rebase_url(self._stack_on,
3707
except errors.InvalidRebaseURLs:
3708
stack_on = self._get_full_stack_on()
3710
branch.set_stacked_on_url(stack_on)
3711
except (errors.UnstackableBranchFormat,
3712
errors.UnstackableRepositoryFormat):
3713
if self._require_stacking:
3716
def requires_stacking(self):
3717
"""Return True if this policy requires stacking."""
3718
return self._stack_on is not None and self._require_stacking
3720
def _get_full_stack_on(self):
3721
"""Get a fully-qualified URL for the stack_on location."""
3722
if self._stack_on is None:
3724
if self._stack_on_pwd is None:
3725
return self._stack_on
3727
return urlutils.join(self._stack_on_pwd, self._stack_on)
3729
def _add_fallback(self, repository, possible_transports=None):
3730
"""Add a fallback to the supplied repository, if stacking is set."""
3731
stack_on = self._get_full_stack_on()
3732
if stack_on is None:
3735
stacked_dir = BzrDir.open(stack_on,
3736
possible_transports=possible_transports)
3737
except errors.JailBreak:
3738
# We keep the stacking details, but we are in the server code so
3739
# actually stacking is not needed.
3742
stacked_repo = stacked_dir.open_branch().repository
3743
except errors.NotBranchError:
3744
stacked_repo = stacked_dir.open_repository()
3746
repository.add_fallback_repository(stacked_repo)
3747
except errors.UnstackableRepositoryFormat:
3748
if self._require_stacking:
3751
self._require_stacking = True
3753
def acquire_repository(self, make_working_trees=None, shared=False):
3754
"""Acquire a repository for this bzrdir.
3756
Implementations may create a new repository or use a pre-exising
3758
:param make_working_trees: If creating a repository, set
3759
make_working_trees to this value (if non-None)
3760
:param shared: If creating a repository, make it shared if True
3761
:return: A repository, is_new_flag (True if the repository was
3764
raise NotImplemented(RepositoryAcquisitionPolicy.acquire_repository)
3767
class CreateRepository(RepositoryAcquisitionPolicy):
3768
"""A policy of creating a new repository"""
3770
def __init__(self, bzrdir, stack_on=None, stack_on_pwd=None,
3771
require_stacking=False):
3774
:param bzrdir: The bzrdir to create the repository on.
3775
:param stack_on: A location to stack on
3776
:param stack_on_pwd: If stack_on is relative, the location it is
3779
RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
3781
self._bzrdir = bzrdir
3783
def acquire_repository(self, make_working_trees=None, shared=False):
3784
"""Implementation of RepositoryAcquisitionPolicy.acquire_repository
3786
Creates the desired repository in the bzrdir we already have.
3788
stack_on = self._get_full_stack_on()
3790
format = self._bzrdir._format
3791
format.require_stacking(stack_on=stack_on,
3792
possible_transports=[self._bzrdir.root_transport])
3793
if not self._require_stacking:
3794
# We have picked up automatic stacking somewhere.
3795
note('Using default stacking branch %s at %s', self._stack_on,
3797
repository = self._bzrdir.create_repository(shared=shared)
3798
self._add_fallback(repository,
3799
possible_transports=[self._bzrdir.transport])
3800
if make_working_trees is not None:
3801
repository.set_make_working_trees(make_working_trees)
3802
return repository, True
3805
class UseExistingRepository(RepositoryAcquisitionPolicy):
3806
"""A policy of reusing an existing repository"""
3808
def __init__(self, repository, stack_on=None, stack_on_pwd=None,
3809
require_stacking=False):
3812
:param repository: The repository to use.
3813
:param stack_on: A location to stack on
3814
:param stack_on_pwd: If stack_on is relative, the location it is
3817
RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
3819
self._repository = repository
3821
def acquire_repository(self, make_working_trees=None, shared=False):
3822
"""Implementation of RepositoryAcquisitionPolicy.acquire_repository
3824
Returns an existing repository to use.
3826
self._add_fallback(self._repository,
3827
possible_transports=[self._repository.bzrdir.transport])
3828
return self._repository, False
3831
# Please register new formats after old formats so that formats
3832
# appear in chronological order and format descriptions can build
3834
format_registry = BzrDirFormatRegistry()
3835
# The pre-0.8 formats have their repository format network name registered in
3836
# repository.py. MetaDir formats have their repository format network name
3837
# inferred from their disk format string.
3838
format_registry.register('weave', BzrDirFormat6,
3839
'Pre-0.8 format. Slower than knit and does not'
3840
' support checkouts or shared repositories.',
3843
format_registry.register_metadir('metaweave',
3844
'bzrlib.repofmt.weaverepo.RepositoryFormat7',
3845
'Transitional format in 0.8. Slower than knit.',
3846
branch_format='bzrlib.branch.BzrBranchFormat5',
3847
tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3850
format_registry.register_metadir('knit',
3851
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3852
'Format using knits. Recommended for interoperation with bzr <= 0.14.',
3853
branch_format='bzrlib.branch.BzrBranchFormat5',
3854
tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3857
format_registry.register_metadir('dirstate',
3858
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3859
help='New in 0.15: Fast local operations. Compatible with bzr 0.8 and '
3860
'above when accessed over the network.',
3861
branch_format='bzrlib.branch.BzrBranchFormat5',
3862
# this uses bzrlib.workingtree.WorkingTreeFormat4 because importing
3863
# directly from workingtree_4 triggers a circular import.
3864
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3867
format_registry.register_metadir('dirstate-tags',
3868
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3869
help='New in 0.15: Fast local operations and improved scaling for '
3870
'network operations. Additionally adds support for tags.'
3871
' Incompatible with bzr < 0.15.',
3872
branch_format='bzrlib.branch.BzrBranchFormat6',
3873
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3876
format_registry.register_metadir('rich-root',
3877
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
3878
help='New in 1.0. Better handling of tree roots. Incompatible with'
3880
branch_format='bzrlib.branch.BzrBranchFormat6',
3881
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3884
format_registry.register_metadir('dirstate-with-subtree',
3885
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
3886
help='New in 0.15: Fast local operations and improved scaling for '
3887
'network operations. Additionally adds support for versioning nested '
3888
'bzr branches. Incompatible with bzr < 0.15.',
3889
branch_format='bzrlib.branch.BzrBranchFormat6',
3890
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3894
format_registry.register_metadir('pack-0.92',
3895
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack1',
3896
help='New in 0.92: Pack-based format with data compatible with '
3897
'dirstate-tags format repositories. Interoperates with '
3898
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3900
branch_format='bzrlib.branch.BzrBranchFormat6',
3901
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3903
format_registry.register_metadir('pack-0.92-subtree',
3904
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack3',
3905
help='New in 0.92: Pack-based format with data compatible with '
3906
'dirstate-with-subtree format repositories. Interoperates with '
3907
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3909
branch_format='bzrlib.branch.BzrBranchFormat6',
3910
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3914
format_registry.register_metadir('rich-root-pack',
3915
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
3916
help='New in 1.0: A variant of pack-0.92 that supports rich-root data '
3917
'(needed for bzr-svn and bzr-git).',
3918
branch_format='bzrlib.branch.BzrBranchFormat6',
3919
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3922
format_registry.register_metadir('1.6',
3923
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5',
3924
help='A format that allows a branch to indicate that there is another '
3925
'(stacked) repository that should be used to access data that is '
3926
'not present locally.',
3927
branch_format='bzrlib.branch.BzrBranchFormat7',
3928
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3931
format_registry.register_metadir('1.6.1-rich-root',
3932
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5RichRoot',
3933
help='A variant of 1.6 that supports rich-root data '
3934
'(needed for bzr-svn and bzr-git).',
3935
branch_format='bzrlib.branch.BzrBranchFormat7',
3936
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3939
format_registry.register_metadir('1.9',
3940
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3941
help='A repository format using B+tree indexes. These indexes '
3942
'are smaller in size, have smarter caching and provide faster '
3943
'performance for most operations.',
3944
branch_format='bzrlib.branch.BzrBranchFormat7',
3945
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3948
format_registry.register_metadir('1.9-rich-root',
3949
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
3950
help='A variant of 1.9 that supports rich-root data '
3951
'(needed for bzr-svn and bzr-git).',
3952
branch_format='bzrlib.branch.BzrBranchFormat7',
3953
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3956
format_registry.register_metadir('1.14',
3957
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3958
help='A working-tree format that supports content filtering.',
3959
branch_format='bzrlib.branch.BzrBranchFormat7',
3960
tree_format='bzrlib.workingtree.WorkingTreeFormat5',
3962
format_registry.register_metadir('1.14-rich-root',
3963
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
3964
help='A variant of 1.14 that supports rich-root data '
3965
'(needed for bzr-svn and bzr-git).',
3966
branch_format='bzrlib.branch.BzrBranchFormat7',
3967
tree_format='bzrlib.workingtree.WorkingTreeFormat5',
3969
# The following un-numbered 'development' formats should always just be aliases.
3970
format_registry.register_metadir('development-rich-root',
3971
'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
3972
help='Current development format. Supports rich roots. Can convert data '
3973
'to and from rich-root-pack (and anything compatible with '
3974
'rich-root-pack) format repositories. Repositories and branches in '
3975
'this format can only be read by bzr.dev. Please read '
3976
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
3978
branch_format='bzrlib.branch.BzrBranchFormat7',
3979
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3984
format_registry.register_metadir('development-subtree',
3985
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment2Subtree',
3986
help='Current development format, subtree variant. Can convert data to and '
3987
'from pack-0.92-subtree (and anything compatible with '
3988
'pack-0.92-subtree) format repositories. Repositories and branches in '
3989
'this format can only be read by bzr.dev. Please read '
3990
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
3992
branch_format='bzrlib.branch.BzrBranchFormat7',
3993
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3996
alias=False, # Restore to being an alias when an actual development subtree format is added
3997
# This current non-alias status is simply because we did not introduce a
3998
# chk based subtree format.
4001
# And the development formats above will have aliased one of the following:
4002
format_registry.register_metadir('development6-rich-root',
4003
'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
4004
help='pack-1.9 with 255-way hashed CHK inv, group compress, rich roots '
4006
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
4008
branch_format='bzrlib.branch.BzrBranchFormat7',
4009
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4014
format_registry.register_metadir('development7-rich-root',
4015
'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK2',
4016
help='pack-1.9 with 255-way hashed CHK inv, bencode revision, group compress, '
4017
'rich roots. Please read '
4018
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
4020
branch_format='bzrlib.branch.BzrBranchFormat7',
4021
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4026
format_registry.register_metadir('2a',
4027
'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
4028
help='First format for bzr 2.0 series.\n'
4029
'Uses group-compress storage.\n'
4030
'Provides rich roots which are a one-way transition.\n',
4031
# 'storage in packs, 255-way hashed CHK inventory, bencode revision, group compress, '
4032
# 'rich roots. Supported by bzr 1.16 and later.',
4033
branch_format='bzrlib.branch.BzrBranchFormat7',
4034
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4038
# The following format should be an alias for the rich root equivalent
4039
# of the default format
4040
format_registry.register_metadir('default-rich-root',
4041
'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
4042
branch_format='bzrlib.branch.BzrBranchFormat7',
4043
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4048
# The current format that is made on 'bzr init'.
4049
format_registry.set_default('2a')
added
removed
bzrlib/bzrdir.py
