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, name=None):
741
"""Return the referenced URL for the branch in this bzrdir.
743
:param name: Optional colocated branch name
744
:raises NotBranchError: If there is no Branch.
745
:raises NoColocatedBranchSupport: If a branch name was specified
746
but colocated branches are not supported.
747
:return: The URL the branch in this bzrdir references if it is a
748
reference branch, or None for regular branches.
751
raise errors.NoColocatedBranchSupport(self)
754
def get_branch_transport(self, branch_format, name=None):
755
"""Get the transport for use by branch format in this BzrDir.
757
Note that bzr dirs that do not support format strings will raise
758
IncompatibleFormat if the branch format they are given has
759
a format string, and vice versa.
761
If branch_format is None, the transport is returned with no
762
checking. If it is not None, then the returned transport is
763
guaranteed to point to an existing directory ready for use.
765
raise NotImplementedError(self.get_branch_transport)
767
def _find_creation_modes(self):
768
"""Determine the appropriate modes for files and directories.
770
They're always set to be consistent with the base directory,
771
assuming that this transport allows setting modes.
773
# TODO: Do we need or want an option (maybe a config setting) to turn
774
# this off or override it for particular locations? -- mbp 20080512
775
if self._mode_check_done:
777
self._mode_check_done = True
779
st = self.transport.stat('.')
780
except errors.TransportNotPossible:
781
self._dir_mode = None
782
self._file_mode = None
784
# Check the directory mode, but also make sure the created
785
# directories and files are read-write for this user. This is
786
# mostly a workaround for filesystems which lie about being able to
787
# write to a directory (cygwin & win32)
788
if (st.st_mode & 07777 == 00000):
789
# FTP allows stat but does not return dir/file modes
790
self._dir_mode = None
791
self._file_mode = None
793
self._dir_mode = (st.st_mode & 07777) | 00700
794
# Remove the sticky and execute bits for files
795
self._file_mode = self._dir_mode & ~07111
797
def _get_file_mode(self):
798
"""Return Unix mode for newly created files, or None.
800
if not self._mode_check_done:
801
self._find_creation_modes()
802
return self._file_mode
804
def _get_dir_mode(self):
805
"""Return Unix mode for newly created directories, or None.
807
if not self._mode_check_done:
808
self._find_creation_modes()
809
return self._dir_mode
811
def get_repository_transport(self, repository_format):
812
"""Get the transport for use by repository format in this BzrDir.
814
Note that bzr dirs that do not support format strings will raise
815
IncompatibleFormat if the repository format they are given has
816
a format string, and vice versa.
818
If repository_format is None, the transport is returned with no
819
checking. If it is not None, then the returned transport is
820
guaranteed to point to an existing directory ready for use.
822
raise NotImplementedError(self.get_repository_transport)
824
def get_workingtree_transport(self, tree_format):
825
"""Get the transport for use by workingtree format in this BzrDir.
827
Note that bzr dirs that do not support format strings will raise
828
IncompatibleFormat if the workingtree format they are given has a
829
format string, and vice versa.
831
If workingtree_format is None, the transport is returned with no
832
checking. If it is not None, then the returned transport is
833
guaranteed to point to an existing directory ready for use.
835
raise NotImplementedError(self.get_workingtree_transport)
837
def get_config(self):
838
"""Get configuration for this BzrDir."""
839
return config.BzrDirConfig(self)
841
def _get_config(self):
842
"""By default, no configuration is available."""
845
def __init__(self, _transport, _format):
846
"""Initialize a Bzr control dir object.
848
Only really common logic should reside here, concrete classes should be
849
made with varying behaviours.
851
:param _format: the format that is creating this BzrDir instance.
852
:param _transport: the transport this dir is based at.
854
self._format = _format
855
# these are also under the more standard names of
856
# control_transport and user_transport
857
self.transport = _transport.clone('.bzr')
858
self.root_transport = _transport
859
self._mode_check_done = False
862
def user_transport(self):
863
return self.root_transport
866
def control_transport(self):
867
return self.transport
869
def is_control_filename(self, filename):
870
"""True if filename is the name of a path which is reserved for bzrdir's.
872
:param filename: A filename within the root transport of this bzrdir.
874
This is true IF and ONLY IF the filename is part of the namespace reserved
875
for bzr control dirs. Currently this is the '.bzr' directory in the root
876
of the root_transport. it is expected that plugins will need to extend
877
this in the future - for instance to make bzr talk with svn working
880
# this might be better on the BzrDirFormat class because it refers to
881
# all the possible bzrdir disk formats.
882
# This method is tested via the workingtree is_control_filename tests-
883
# it was extracted from WorkingTree.is_control_filename. If the method's
884
# contract is extended beyond the current trivial implementation, please
885
# add new tests for it to the appropriate place.
886
return filename == '.bzr' or filename.startswith('.bzr/')
888
def needs_format_conversion(self, format=None):
889
"""Return true if this bzrdir needs convert_format run on it.
891
For instance, if the repository format is out of date but the
892
branch and working tree are not, this should return True.
894
:param format: Optional parameter indicating a specific desired
895
format we plan to arrive at.
897
raise NotImplementedError(self.needs_format_conversion)
900
def open_unsupported(base):
901
"""Open a branch which is not supported."""
902
return BzrDir.open(base, _unsupported=True)
905
def open(base, _unsupported=False, possible_transports=None):
906
"""Open an existing bzrdir, rooted at 'base' (url).
908
:param _unsupported: a private parameter to the BzrDir class.
910
t = get_transport(base, possible_transports=possible_transports)
911
return BzrDir.open_from_transport(t, _unsupported=_unsupported)
914
def open_from_transport(transport, _unsupported=False,
915
_server_formats=True):
916
"""Open a bzrdir within a particular directory.
918
:param transport: Transport containing the bzrdir.
919
:param _unsupported: private.
921
for hook in BzrDir.hooks['pre_open']:
923
# Keep initial base since 'transport' may be modified while following
925
base = transport.base
926
def find_format(transport):
927
return transport, BzrDirFormat.find_format(
928
transport, _server_formats=_server_formats)
930
def redirected(transport, e, redirection_notice):
931
redirected_transport = transport._redirected_to(e.source, e.target)
932
if redirected_transport is None:
933
raise errors.NotBranchError(base)
934
note('%s is%s redirected to %s',
935
transport.base, e.permanently, redirected_transport.base)
936
return redirected_transport
939
transport, format = do_catching_redirections(find_format,
942
except errors.TooManyRedirections:
943
raise errors.NotBranchError(base)
945
BzrDir._check_supported(format, _unsupported)
946
return format.open(transport, _found=True)
948
def open_branch(self, name=None, unsupported=False,
949
ignore_fallbacks=False):
950
"""Open the branch object at this BzrDir if one is present.
952
If unsupported is True, then no longer supported branch formats can
955
TODO: static convenience version of this?
957
raise NotImplementedError(self.open_branch)
960
def open_containing(url, possible_transports=None):
961
"""Open an existing branch which contains url.
963
:param url: url to search from.
964
See open_containing_from_transport for more detail.
966
transport = get_transport(url, possible_transports)
967
return BzrDir.open_containing_from_transport(transport)
970
def open_containing_from_transport(a_transport):
971
"""Open an existing branch which contains a_transport.base.
973
This probes for a branch at a_transport, and searches upwards from there.
975
Basically we keep looking up until we find the control directory or
976
run into the root. If there isn't one, raises NotBranchError.
977
If there is one and it is either an unrecognised format or an unsupported
978
format, UnknownFormatError or UnsupportedFormatError are raised.
979
If there is one, it is returned, along with the unused portion of url.
981
:return: The BzrDir that contains the path, and a Unicode path
982
for the rest of the URL.
984
# this gets the normalised url back. I.e. '.' -> the full path.
985
url = a_transport.base
988
result = BzrDir.open_from_transport(a_transport)
989
return result, urlutils.unescape(a_transport.relpath(url))
990
except errors.NotBranchError, e:
993
new_t = a_transport.clone('..')
994
except errors.InvalidURLJoin:
995
# reached the root, whatever that may be
996
raise errors.NotBranchError(path=url)
997
if new_t.base == a_transport.base:
998
# reached the root, whatever that may be
999
raise errors.NotBranchError(path=url)
1002
def _get_tree_branch(self, name=None):
1003
"""Return the branch and tree, if any, for this bzrdir.
1005
:param name: Name of colocated branch to open.
1007
Return None for tree if not present or inaccessible.
1008
Raise NotBranchError if no branch is present.
1009
:return: (tree, branch)
1012
tree = self.open_workingtree()
1013
except (errors.NoWorkingTree, errors.NotLocalUrl):
1015
branch = self.open_branch(name=name)
1017
if name is not None:
1018
branch = self.open_branch(name=name)
1020
branch = tree.branch
1024
def open_tree_or_branch(klass, location):
1025
"""Return the branch and working tree at a location.
1027
If there is no tree at the location, tree will be None.
1028
If there is no branch at the location, an exception will be
1030
:return: (tree, branch)
1032
bzrdir = klass.open(location)
1033
return bzrdir._get_tree_branch()
1036
def open_containing_tree_or_branch(klass, location):
1037
"""Return the branch and working tree contained by a location.
1039
Returns (tree, branch, relpath).
1040
If there is no tree at containing the location, tree will be None.
1041
If there is no branch containing the location, an exception will be
1043
relpath is the portion of the path that is contained by the branch.
1045
bzrdir, relpath = klass.open_containing(location)
1046
tree, branch = bzrdir._get_tree_branch()
1047
return tree, branch, relpath
1050
def open_containing_tree_branch_or_repository(klass, location):
1051
"""Return the working tree, branch and repo contained by a location.
1053
Returns (tree, branch, repository, relpath).
1054
If there is no tree containing the location, tree will be None.
1055
If there is no branch containing the location, branch will be None.
1056
If there is no repository containing the location, repository will be
1058
relpath is the portion of the path that is contained by the innermost
1061
If no tree, branch or repository is found, a NotBranchError is raised.
1063
bzrdir, relpath = klass.open_containing(location)
1065
tree, branch = bzrdir._get_tree_branch()
1066
except errors.NotBranchError:
1068
repo = bzrdir.find_repository()
1069
return None, None, repo, relpath
1070
except (errors.NoRepositoryPresent):
1071
raise errors.NotBranchError(location)
1072
return tree, branch, branch.repository, relpath
1074
def open_repository(self, _unsupported=False):
1075
"""Open the repository object at this BzrDir if one is present.
1077
This will not follow the Branch object pointer - it's strictly a direct
1078
open facility. Most client code should use open_branch().repository to
1079
get at a repository.
1081
:param _unsupported: a private parameter, not part of the api.
1082
TODO: static convenience version of this?
1084
raise NotImplementedError(self.open_repository)
1086
def open_workingtree(self, _unsupported=False,
1087
recommend_upgrade=True, from_branch=None):
1088
"""Open the workingtree object at this BzrDir if one is present.
1090
:param recommend_upgrade: Optional keyword parameter, when True (the
1091
default), emit through the ui module a recommendation that the user
1092
upgrade the working tree when the workingtree being opened is old
1093
(but still fully supported).
1094
:param from_branch: override bzrdir branch (for lightweight checkouts)
1096
raise NotImplementedError(self.open_workingtree)
1098
def has_branch(self, name=None):
1099
"""Tell if this bzrdir contains a branch.
1101
Note: if you're going to open the branch, you should just go ahead
1102
and try, and not ask permission first. (This method just opens the
1103
branch and discards it, and that's somewhat expensive.)
1106
self.open_branch(name)
1108
except errors.NotBranchError:
1111
def has_workingtree(self):
1112
"""Tell if this bzrdir contains a working tree.
1114
This will still raise an exception if the bzrdir has a workingtree that
1115
is remote & inaccessible.
1117
Note: if you're going to open the working tree, you should just go ahead
1118
and try, and not ask permission first. (This method just opens the
1119
workingtree and discards it, and that's somewhat expensive.)
1122
self.open_workingtree(recommend_upgrade=False)
1124
except errors.NoWorkingTree:
1127
def _cloning_metadir(self):
1128
"""Produce a metadir suitable for cloning with.
1130
:returns: (destination_bzrdir_format, source_repository)
1132
result_format = self._format.__class__()
1135
branch = self.open_branch(ignore_fallbacks=True)
1136
source_repository = branch.repository
1137
result_format._branch_format = branch._format
1138
except errors.NotBranchError:
1139
source_branch = None
1140
source_repository = self.open_repository()
1141
except errors.NoRepositoryPresent:
1142
source_repository = None
1144
# XXX TODO: This isinstance is here because we have not implemented
1145
# the fix recommended in bug # 103195 - to delegate this choice the
1146
# repository itself.
1147
repo_format = source_repository._format
1148
if isinstance(repo_format, remote.RemoteRepositoryFormat):
1149
source_repository._ensure_real()
1150
repo_format = source_repository._real_repository._format
1151
result_format.repository_format = repo_format
1153
# TODO: Couldn't we just probe for the format in these cases,
1154
# rather than opening the whole tree? It would be a little
1155
# faster. mbp 20070401
1156
tree = self.open_workingtree(recommend_upgrade=False)
1157
except (errors.NoWorkingTree, errors.NotLocalUrl):
1158
result_format.workingtree_format = None
1160
result_format.workingtree_format = tree._format.__class__()
1161
return result_format, source_repository
1163
def cloning_metadir(self, require_stacking=False):
1164
"""Produce a metadir suitable for cloning or sprouting with.
1166
These operations may produce workingtrees (yes, even though they're
1167
"cloning" something that doesn't have a tree), so a viable workingtree
1168
format must be selected.
1170
:require_stacking: If True, non-stackable formats will be upgraded
1171
to similar stackable formats.
1172
:returns: a BzrDirFormat with all component formats either set
1173
appropriately or set to None if that component should not be
1176
format, repository = self._cloning_metadir()
1177
if format._workingtree_format is None:
1179
if repository is None:
1180
# No repository either
1182
# We have a repository, so set a working tree? (Why? This seems to
1183
# contradict the stated return value in the docstring).
1184
tree_format = repository._format._matchingbzrdir.workingtree_format
1185
format.workingtree_format = tree_format.__class__()
1186
if require_stacking:
1187
format.require_stacking()
1190
def checkout_metadir(self):
1191
return self.cloning_metadir()
1193
def sprout(self, url, revision_id=None, force_new_repo=False,
1194
recurse='down', possible_transports=None,
1195
accelerator_tree=None, hardlink=False, stacked=False,
1196
source_branch=None, create_tree_if_local=True):
1197
"""Create a copy of this bzrdir prepared for use as a new line of
1200
If url's last component does not exist, it will be created.
1202
Attributes related to the identity of the source branch like
1203
branch nickname will be cleaned, a working tree is created
1204
whether one existed before or not; and a local branch is always
1207
if revision_id is not None, then the clone operation may tune
1208
itself to download less data.
1209
:param accelerator_tree: A tree which can be used for retrieving file
1210
contents more quickly than the revision tree, i.e. a workingtree.
1211
The revision tree will be used for cases where accelerator_tree's
1212
content is different.
1213
:param hardlink: If true, hard-link files from accelerator_tree,
1215
:param stacked: If true, create a stacked branch referring to the
1216
location of this control directory.
1217
:param create_tree_if_local: If true, a working-tree will be created
1218
when working locally.
1220
target_transport = get_transport(url, possible_transports)
1221
target_transport.ensure_base()
1222
cloning_format = self.cloning_metadir(stacked)
1223
# Create/update the result branch
1224
result = cloning_format.initialize_on_transport(target_transport)
1225
# if a stacked branch wasn't requested, we don't create one
1226
# even if the origin was stacked
1227
stacked_branch_url = None
1228
if source_branch is not None:
1230
stacked_branch_url = self.root_transport.base
1231
source_repository = source_branch.repository
1234
source_branch = self.open_branch()
1235
source_repository = source_branch.repository
1237
stacked_branch_url = self.root_transport.base
1238
except errors.NotBranchError:
1239
source_branch = None
1241
source_repository = self.open_repository()
1242
except errors.NoRepositoryPresent:
1243
source_repository = None
1244
repository_policy = result.determine_repository_policy(
1245
force_new_repo, stacked_branch_url, require_stacking=stacked)
1246
result_repo, is_new_repo = repository_policy.acquire_repository()
1247
if is_new_repo and revision_id is not None and not stacked:
1248
fetch_spec = graph.PendingAncestryResult(
1249
[revision_id], source_repository)
1252
if source_repository is not None:
1253
# Fetch while stacked to prevent unstacked fetch from
1255
if fetch_spec is None:
1256
result_repo.fetch(source_repository, revision_id=revision_id)
1258
result_repo.fetch(source_repository, fetch_spec=fetch_spec)
1260
if source_branch is None:
1261
# this is for sprouting a bzrdir without a branch; is that
1263
# Not especially, but it's part of the contract.
1264
result_branch = result.create_branch()
1266
result_branch = source_branch.sprout(result,
1267
revision_id=revision_id, repository_policy=repository_policy)
1268
mutter("created new branch %r" % (result_branch,))
1270
# Create/update the result working tree
1271
if (create_tree_if_local and
1272
isinstance(target_transport, local.LocalTransport) and
1273
(result_repo is None or result_repo.make_working_trees())):
1274
wt = result.create_workingtree(accelerator_tree=accelerator_tree,
1278
if wt.path2id('') is None:
1280
wt.set_root_id(self.open_workingtree.get_root_id())
1281
except errors.NoWorkingTree:
1287
if recurse == 'down':
1289
basis = wt.basis_tree()
1291
subtrees = basis.iter_references()
1292
elif result_branch is not None:
1293
basis = result_branch.basis_tree()
1295
subtrees = basis.iter_references()
1296
elif source_branch is not None:
1297
basis = source_branch.basis_tree()
1299
subtrees = basis.iter_references()
1304
for path, file_id in subtrees:
1305
target = urlutils.join(url, urlutils.escape(path))
1306
sublocation = source_branch.reference_parent(file_id, path)
1307
sublocation.bzrdir.sprout(target,
1308
basis.get_reference_revision(file_id, path),
1309
force_new_repo=force_new_repo, recurse=recurse,
1312
if basis is not None:
1316
def push_branch(self, source, revision_id=None, overwrite=False,
1317
remember=False, create_prefix=False):
1318
"""Push the source branch into this BzrDir."""
1320
# If we can open a branch, use its direct repository, otherwise see
1321
# if there is a repository without a branch.
1323
br_to = self.open_branch()
1324
except errors.NotBranchError:
1325
# Didn't find a branch, can we find a repository?
1326
repository_to = self.find_repository()
1328
# Found a branch, so we must have found a repository
1329
repository_to = br_to.repository
1331
push_result = PushResult()
1332
push_result.source_branch = source
1334
# We have a repository but no branch, copy the revisions, and then
1336
repository_to.fetch(source.repository, revision_id=revision_id)
1337
br_to = source.clone(self, revision_id=revision_id)
1338
if source.get_push_location() is None or remember:
1339
source.set_push_location(br_to.base)
1340
push_result.stacked_on = None
1341
push_result.branch_push_result = None
1342
push_result.old_revno = None
1343
push_result.old_revid = _mod_revision.NULL_REVISION
1344
push_result.target_branch = br_to
1345
push_result.master_branch = None
1346
push_result.workingtree_updated = False
1348
# We have successfully opened the branch, remember if necessary:
1349
if source.get_push_location() is None or remember:
1350
source.set_push_location(br_to.base)
1352
tree_to = self.open_workingtree()
1353
except errors.NotLocalUrl:
1354
push_result.branch_push_result = source.push(br_to,
1355
overwrite, stop_revision=revision_id)
1356
push_result.workingtree_updated = False
1357
except errors.NoWorkingTree:
1358
push_result.branch_push_result = source.push(br_to,
1359
overwrite, stop_revision=revision_id)
1360
push_result.workingtree_updated = None # Not applicable
1362
tree_to.lock_write()
1364
push_result.branch_push_result = source.push(
1365
tree_to.branch, overwrite, stop_revision=revision_id)
1369
push_result.workingtree_updated = True
1370
push_result.old_revno = push_result.branch_push_result.old_revno
1371
push_result.old_revid = push_result.branch_push_result.old_revid
1372
push_result.target_branch = \
1373
push_result.branch_push_result.target_branch
1377
class BzrDirHooks(hooks.Hooks):
1378
"""Hooks for BzrDir operations."""
1381
"""Create the default hooks."""
1382
hooks.Hooks.__init__(self)
1383
self.create_hook(hooks.HookPoint('pre_open',
1384
"Invoked before attempting to open a BzrDir with the transport "
1385
"that the open will use.", (1, 14), None))
1386
self.create_hook(hooks.HookPoint('post_repo_init',
1387
"Invoked after a repository has been initialized. "
1388
"post_repo_init is called with a "
1389
"bzrlib.bzrdir.RepoInitHookParams.",
1392
# install the default hooks
1393
BzrDir.hooks = BzrDirHooks()
1396
class RepoInitHookParams(object):
1397
"""Object holding parameters passed to *_repo_init hooks.
1399
There are 4 fields that hooks may wish to access:
1401
:ivar repository: Repository created
1402
:ivar format: Repository format
1403
:ivar bzrdir: The bzrdir for the repository
1404
:ivar shared: The repository is shared
1407
def __init__(self, repository, format, a_bzrdir, shared):
1408
"""Create a group of RepoInitHook parameters.
1410
:param repository: Repository created
1411
:param format: Repository format
1412
:param bzrdir: The bzrdir for the repository
1413
:param shared: The repository is shared
1415
self.repository = repository
1416
self.format = format
1417
self.bzrdir = a_bzrdir
1418
self.shared = shared
1420
def __eq__(self, other):
1421
return self.__dict__ == other.__dict__
1425
return "<%s for %s>" % (self.__class__.__name__,
1428
return "<%s for %s>" % (self.__class__.__name__,
1432
class BzrDirPreSplitOut(BzrDir):
1433
"""A common class for the all-in-one formats."""
1435
def __init__(self, _transport, _format):
1436
"""See BzrDir.__init__."""
1437
super(BzrDirPreSplitOut, self).__init__(_transport, _format)
1438
self._control_files = lockable_files.LockableFiles(
1439
self.get_branch_transport(None),
1440
self._format._lock_file_name,
1441
self._format._lock_class)
1443
def break_lock(self):
1444
"""Pre-splitout bzrdirs do not suffer from stale locks."""
1445
raise NotImplementedError(self.break_lock)
1447
def cloning_metadir(self, require_stacking=False):
1448
"""Produce a metadir suitable for cloning with."""
1449
if require_stacking:
1450
return format_registry.make_bzrdir('1.6')
1451
return self._format.__class__()
1453
def clone(self, url, revision_id=None, force_new_repo=False,
1454
preserve_stacking=False):
1455
"""See BzrDir.clone().
1457
force_new_repo has no effect, since this family of formats always
1458
require a new repository.
1459
preserve_stacking has no effect, since no source branch using this
1460
family of formats can be stacked, so there is no stacking to preserve.
1462
self._make_tail(url)
1463
result = self._format._initialize_for_clone(url)
1464
self.open_repository().clone(result, revision_id=revision_id)
1465
from_branch = self.open_branch()
1466
from_branch.clone(result, revision_id=revision_id)
1468
tree = self.open_workingtree()
1469
except errors.NotLocalUrl:
1470
# make a new one, this format always has to have one.
1471
result._init_workingtree()
1476
def create_branch(self, name=None):
1477
"""See BzrDir.create_branch."""
1478
return self._format.get_branch_format().initialize(self, name=name)
1480
def destroy_branch(self, name=None):
1481
"""See BzrDir.destroy_branch."""
1482
raise errors.UnsupportedOperation(self.destroy_branch, self)
1484
def create_repository(self, shared=False):
1485
"""See BzrDir.create_repository."""
1487
raise errors.IncompatibleFormat('shared repository', self._format)
1488
return self.open_repository()
1490
def destroy_repository(self):
1491
"""See BzrDir.destroy_repository."""
1492
raise errors.UnsupportedOperation(self.destroy_repository, self)
1494
def create_workingtree(self, revision_id=None, from_branch=None,
1495
accelerator_tree=None, hardlink=False):
1496
"""See BzrDir.create_workingtree."""
1497
# The workingtree is sometimes created when the bzrdir is created,
1498
# but not when cloning.
1500
# this looks buggy but is not -really-
1501
# because this format creates the workingtree when the bzrdir is
1503
# clone and sprout will have set the revision_id
1504
# and that will have set it for us, its only
1505
# specific uses of create_workingtree in isolation
1506
# that can do wonky stuff here, and that only
1507
# happens for creating checkouts, which cannot be
1508
# done on this format anyway. So - acceptable wart.
1510
warning("can't support hardlinked working trees in %r"
1513
result = self.open_workingtree(recommend_upgrade=False)
1514
except errors.NoSuchFile:
1515
result = self._init_workingtree()
1516
if revision_id is not None:
1517
if revision_id == _mod_revision.NULL_REVISION:
1518
result.set_parent_ids([])
1520
result.set_parent_ids([revision_id])
1523
def _init_workingtree(self):
1524
from bzrlib.workingtree import WorkingTreeFormat2
1526
return WorkingTreeFormat2().initialize(self)
1527
except errors.NotLocalUrl:
1528
# Even though we can't access the working tree, we need to
1529
# create its control files.
1530
return WorkingTreeFormat2()._stub_initialize_on_transport(
1531
self.transport, self._control_files._file_mode)
1533
def destroy_workingtree(self):
1534
"""See BzrDir.destroy_workingtree."""
1535
raise errors.UnsupportedOperation(self.destroy_workingtree, self)
1537
def destroy_workingtree_metadata(self):
1538
"""See BzrDir.destroy_workingtree_metadata."""
1539
raise errors.UnsupportedOperation(self.destroy_workingtree_metadata,
1542
def get_branch_transport(self, branch_format, name=None):
1543
"""See BzrDir.get_branch_transport()."""
1544
if name is not None:
1545
raise errors.NoColocatedBranchSupport(self)
1546
if branch_format is None:
1547
return self.transport
1549
branch_format.get_format_string()
1550
except NotImplementedError:
1551
return self.transport
1552
raise errors.IncompatibleFormat(branch_format, self._format)
1554
def get_repository_transport(self, repository_format):
1555
"""See BzrDir.get_repository_transport()."""
1556
if repository_format is None:
1557
return self.transport
1559
repository_format.get_format_string()
1560
except NotImplementedError:
1561
return self.transport
1562
raise errors.IncompatibleFormat(repository_format, self._format)
1564
def get_workingtree_transport(self, workingtree_format):
1565
"""See BzrDir.get_workingtree_transport()."""
1566
if workingtree_format is None:
1567
return self.transport
1569
workingtree_format.get_format_string()
1570
except NotImplementedError:
1571
return self.transport
1572
raise errors.IncompatibleFormat(workingtree_format, self._format)
1574
def needs_format_conversion(self, format=None):
1575
"""See BzrDir.needs_format_conversion()."""
1576
# if the format is not the same as the system default,
1577
# an upgrade is needed.
1579
symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1580
% 'needs_format_conversion(format=None)')
1581
format = BzrDirFormat.get_default_format()
1582
return not isinstance(self._format, format.__class__)
1584
def open_branch(self, name=None, unsupported=False,
1585
ignore_fallbacks=False):
1586
"""See BzrDir.open_branch."""
1587
from bzrlib.branch import BzrBranchFormat4
1588
format = BzrBranchFormat4()
1589
self._check_supported(format, unsupported)
1590
return format.open(self, name, _found=True)
1592
def sprout(self, url, revision_id=None, force_new_repo=False,
1593
possible_transports=None, accelerator_tree=None,
1594
hardlink=False, stacked=False, create_tree_if_local=True,
1595
source_branch=None):
1596
"""See BzrDir.sprout()."""
1597
if source_branch is not None:
1598
my_branch = self.open_branch()
1599
if source_branch.base != my_branch.base:
1600
raise AssertionError(
1601
"source branch %r is not within %r with branch %r" %
1602
(source_branch, self, my_branch))
1604
raise errors.UnstackableBranchFormat(
1605
self._format, self.root_transport.base)
1606
if not create_tree_if_local:
1607
raise errors.MustHaveWorkingTree(
1608
self._format, self.root_transport.base)
1609
from bzrlib.workingtree import WorkingTreeFormat2
1610
self._make_tail(url)
1611
result = self._format._initialize_for_clone(url)
1613
self.open_repository().clone(result, revision_id=revision_id)
1614
except errors.NoRepositoryPresent:
1617
self.open_branch().sprout(result, revision_id=revision_id)
1618
except errors.NotBranchError:
1621
# we always want a working tree
1622
WorkingTreeFormat2().initialize(result,
1623
accelerator_tree=accelerator_tree,
1628
class BzrDir4(BzrDirPreSplitOut):
1629
"""A .bzr version 4 control object.
1631
This is a deprecated format and may be removed after sept 2006.
1634
def create_repository(self, shared=False):
1635
"""See BzrDir.create_repository."""
1636
return self._format.repository_format.initialize(self, shared)
1638
def needs_format_conversion(self, format=None):
1639
"""Format 4 dirs are always in need of conversion."""
1641
symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1642
% 'needs_format_conversion(format=None)')
1645
def open_repository(self):
1646
"""See BzrDir.open_repository."""
1647
from bzrlib.repofmt.weaverepo import RepositoryFormat4
1648
return RepositoryFormat4().open(self, _found=True)
1651
class BzrDir5(BzrDirPreSplitOut):
1652
"""A .bzr version 5 control object.
1654
This is a deprecated format and may be removed after sept 2006.
1657
def has_workingtree(self):
1658
"""See BzrDir.has_workingtree."""
1661
def open_repository(self):
1662
"""See BzrDir.open_repository."""
1663
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1664
return RepositoryFormat5().open(self, _found=True)
1666
def open_workingtree(self, _unsupported=False,
1667
recommend_upgrade=True):
1668
"""See BzrDir.create_workingtree."""
1669
from bzrlib.workingtree import WorkingTreeFormat2
1670
wt_format = WorkingTreeFormat2()
1671
# we don't warn here about upgrades; that ought to be handled for the
1673
return wt_format.open(self, _found=True)
1676
class BzrDir6(BzrDirPreSplitOut):
1677
"""A .bzr version 6 control object.
1679
This is a deprecated format and may be removed after sept 2006.
1682
def has_workingtree(self):
1683
"""See BzrDir.has_workingtree."""
1686
def open_repository(self):
1687
"""See BzrDir.open_repository."""
1688
from bzrlib.repofmt.weaverepo import RepositoryFormat6
1689
return RepositoryFormat6().open(self, _found=True)
1691
def open_workingtree(self, _unsupported=False,
1692
recommend_upgrade=True):
1693
"""See BzrDir.create_workingtree."""
1694
# we don't warn here about upgrades; that ought to be handled for the
1696
from bzrlib.workingtree import WorkingTreeFormat2
1697
return WorkingTreeFormat2().open(self, _found=True)
1700
class BzrDirMeta1(BzrDir):
1701
"""A .bzr meta version 1 control object.
1703
This is the first control object where the
1704
individual aspects are really split out: there are separate repository,
1705
workingtree and branch subdirectories and any subset of the three can be
1706
present within a BzrDir.
1709
def can_convert_format(self):
1710
"""See BzrDir.can_convert_format()."""
1713
def create_branch(self, name=None):
1714
"""See BzrDir.create_branch."""
1715
return self._format.get_branch_format().initialize(self, name=name)
1717
def destroy_branch(self, name=None):
1718
"""See BzrDir.create_branch."""
1719
if name is not None:
1720
raise errors.NoColocatedBranchSupport(self)
1721
self.transport.delete_tree('branch')
1723
def create_repository(self, shared=False):
1724
"""See BzrDir.create_repository."""
1725
return self._format.repository_format.initialize(self, shared)
1727
def destroy_repository(self):
1728
"""See BzrDir.destroy_repository."""
1729
self.transport.delete_tree('repository')
1731
def create_workingtree(self, revision_id=None, from_branch=None,
1732
accelerator_tree=None, hardlink=False):
1733
"""See BzrDir.create_workingtree."""
1734
return self._format.workingtree_format.initialize(
1735
self, revision_id, from_branch=from_branch,
1736
accelerator_tree=accelerator_tree, hardlink=hardlink)
1738
def destroy_workingtree(self):
1739
"""See BzrDir.destroy_workingtree."""
1740
wt = self.open_workingtree(recommend_upgrade=False)
1741
repository = wt.branch.repository
1742
empty = repository.revision_tree(_mod_revision.NULL_REVISION)
1743
wt.revert(old_tree=empty)
1744
self.destroy_workingtree_metadata()
1746
def destroy_workingtree_metadata(self):
1747
self.transport.delete_tree('checkout')
1749
def find_branch_format(self, name=None):
1750
"""Find the branch 'format' for this bzrdir.
1752
This might be a synthetic object for e.g. RemoteBranch and SVN.
1754
from bzrlib.branch import BranchFormat
1755
return BranchFormat.find_format(self, name=name)
1757
def _get_mkdir_mode(self):
1758
"""Figure out the mode to use when creating a bzrdir subdir."""
1759
temp_control = lockable_files.LockableFiles(self.transport, '',
1760
lockable_files.TransportLock)
1761
return temp_control._dir_mode
1763
def get_branch_reference(self, name=None):
1764
"""See BzrDir.get_branch_reference()."""
1765
from bzrlib.branch import BranchFormat
1766
format = BranchFormat.find_format(self, name=name)
1767
return format.get_reference(self, name=name)
1769
def get_branch_transport(self, branch_format, name=None):
1770
"""See BzrDir.get_branch_transport()."""
1771
if name is not None:
1772
raise errors.NoColocatedBranchSupport(self)
1773
# XXX: this shouldn't implicitly create the directory if it's just
1774
# promising to get a transport -- mbp 20090727
1775
if branch_format is None:
1776
return self.transport.clone('branch')
1778
branch_format.get_format_string()
1779
except NotImplementedError:
1780
raise errors.IncompatibleFormat(branch_format, self._format)
1782
self.transport.mkdir('branch', mode=self._get_mkdir_mode())
1783
except errors.FileExists:
1785
return self.transport.clone('branch')
1787
def get_repository_transport(self, repository_format):
1788
"""See BzrDir.get_repository_transport()."""
1789
if repository_format is None:
1790
return self.transport.clone('repository')
1792
repository_format.get_format_string()
1793
except NotImplementedError:
1794
raise errors.IncompatibleFormat(repository_format, self._format)
1796
self.transport.mkdir('repository', mode=self._get_mkdir_mode())
1797
except errors.FileExists:
1799
return self.transport.clone('repository')
1801
def get_workingtree_transport(self, workingtree_format):
1802
"""See BzrDir.get_workingtree_transport()."""
1803
if workingtree_format is None:
1804
return self.transport.clone('checkout')
1806
workingtree_format.get_format_string()
1807
except NotImplementedError:
1808
raise errors.IncompatibleFormat(workingtree_format, self._format)
1810
self.transport.mkdir('checkout', mode=self._get_mkdir_mode())
1811
except errors.FileExists:
1813
return self.transport.clone('checkout')
1815
def has_workingtree(self):
1816
"""Tell if this bzrdir contains a working tree.
1818
This will still raise an exception if the bzrdir has a workingtree that
1819
is remote & inaccessible.
1821
Note: if you're going to open the working tree, you should just go
1822
ahead and try, and not ask permission first.
1824
from bzrlib.workingtree import WorkingTreeFormat
1826
WorkingTreeFormat.find_format(self)
1827
except errors.NoWorkingTree:
1831
def needs_format_conversion(self, format=None):
1832
"""See BzrDir.needs_format_conversion()."""
1834
symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1835
% 'needs_format_conversion(format=None)')
1837
format = BzrDirFormat.get_default_format()
1838
if not isinstance(self._format, format.__class__):
1839
# it is not a meta dir format, conversion is needed.
1841
# we might want to push this down to the repository?
1843
if not isinstance(self.open_repository()._format,
1844
format.repository_format.__class__):
1845
# the repository needs an upgrade.
1847
except errors.NoRepositoryPresent:
1849
for branch in self.list_branches():
1850
if not isinstance(branch._format,
1851
format.get_branch_format().__class__):
1852
# the branch needs an upgrade.
1855
my_wt = self.open_workingtree(recommend_upgrade=False)
1856
if not isinstance(my_wt._format,
1857
format.workingtree_format.__class__):
1858
# the workingtree needs an upgrade.
1860
except (errors.NoWorkingTree, errors.NotLocalUrl):
1864
def open_branch(self, name=None, unsupported=False,
1865
ignore_fallbacks=False):
1866
"""See BzrDir.open_branch."""
1867
format = self.find_branch_format(name=name)
1868
self._check_supported(format, unsupported)
1869
return format.open(self, name=name,
1870
_found=True, ignore_fallbacks=ignore_fallbacks)
1872
def open_repository(self, unsupported=False):
1873
"""See BzrDir.open_repository."""
1874
from bzrlib.repository import RepositoryFormat
1875
format = RepositoryFormat.find_format(self)
1876
self._check_supported(format, unsupported)
1877
return format.open(self, _found=True)
1879
def open_workingtree(self, unsupported=False,
1880
recommend_upgrade=True):
1881
"""See BzrDir.open_workingtree."""
1882
from bzrlib.workingtree import WorkingTreeFormat
1883
format = WorkingTreeFormat.find_format(self)
1884
self._check_supported(format, unsupported,
1886
basedir=self.root_transport.base)
1887
return format.open(self, _found=True)
1889
def _get_config(self):
1890
return config.TransportConfig(self.transport, 'control.conf')
1893
class BzrDirFormat(object):
1894
"""An encapsulation of the initialization and open routines for a format.
1896
Formats provide three things:
1897
* An initialization routine,
1901
Formats are placed in a dict by their format string for reference
1902
during bzrdir opening. These should be subclasses of BzrDirFormat
1905
Once a format is deprecated, just deprecate the initialize and open
1906
methods on the format class. Do not deprecate the object, as the
1907
object will be created every system load.
1909
:cvar colocated_branches: Whether this formats supports colocated branches.
1912
_default_format = None
1913
"""The default format used for new .bzr dirs."""
1916
"""The known formats."""
1918
_control_formats = []
1919
"""The registered control formats - .bzr, ....
1921
This is a list of BzrDirFormat objects.
1924
_control_server_formats = []
1925
"""The registered control server formats, e.g. RemoteBzrDirs.
1927
This is a list of BzrDirFormat objects.
1930
_lock_file_name = 'branch-lock'
1932
colocated_branches = False
1933
"""Whether co-located branches are supported for this control dir format.
1936
# _lock_class must be set in subclasses to the lock type, typ.
1937
# TransportLock or LockDir
1940
def find_format(klass, transport, _server_formats=True):
1941
"""Return the format present at transport."""
1943
formats = klass._control_server_formats + klass._control_formats
1945
formats = klass._control_formats
1946
for format in formats:
1948
return format.probe_transport(transport)
1949
except errors.NotBranchError:
1950
# this format does not find a control dir here.
1952
raise errors.NotBranchError(path=transport.base)
1955
def probe_transport(klass, transport):
1956
"""Return the .bzrdir style format present in a directory."""
1958
format_string = transport.get_bytes(".bzr/branch-format")
1959
except errors.NoSuchFile:
1960
raise errors.NotBranchError(path=transport.base)
1963
return klass._formats[format_string]
1965
raise errors.UnknownFormatError(format=format_string, kind='bzrdir')
1968
def get_default_format(klass):
1969
"""Return the current default format."""
1970
return klass._default_format
1972
def get_format_string(self):
1973
"""Return the ASCII format string that identifies this format."""
1974
raise NotImplementedError(self.get_format_string)
1976
def get_format_description(self):
1977
"""Return the short description for this format."""
1978
raise NotImplementedError(self.get_format_description)
1980
def get_converter(self, format=None):
1981
"""Return the converter to use to convert bzrdirs needing converts.
1983
This returns a bzrlib.bzrdir.Converter object.
1985
This should return the best upgrader to step this format towards the
1986
current default format. In the case of plugins we can/should provide
1987
some means for them to extend the range of returnable converters.
1989
:param format: Optional format to override the default format of the
1992
raise NotImplementedError(self.get_converter)
1994
def initialize(self, url, possible_transports=None):
1995
"""Create a bzr control dir at this url and return an opened copy.
1997
While not deprecated, this method is very specific and its use will
1998
lead to many round trips to setup a working environment. See
1999
initialize_on_transport_ex for a [nearly] all-in-one method.
2001
Subclasses should typically override initialize_on_transport
2002
instead of this method.
2004
return self.initialize_on_transport(get_transport(url,
2005
possible_transports))
2007
def initialize_on_transport(self, transport):
2008
"""Initialize a new bzrdir in the base directory of a Transport."""
2010
# can we hand off the request to the smart server rather than using
2012
client_medium = transport.get_smart_medium()
2013
except errors.NoSmartMedium:
2014
return self._initialize_on_transport_vfs(transport)
2016
# Current RPC's only know how to create bzr metadir1 instances, so
2017
# we still delegate to vfs methods if the requested format is not a
2019
if type(self) != BzrDirMetaFormat1:
2020
return self._initialize_on_transport_vfs(transport)
2021
remote_format = RemoteBzrDirFormat()
2022
self._supply_sub_formats_to(remote_format)
2023
return remote_format.initialize_on_transport(transport)
2025
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
2026
create_prefix=False, force_new_repo=False, stacked_on=None,
2027
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
2028
shared_repo=False, vfs_only=False):
2029
"""Create this format on transport.
2031
The directory to initialize will be created.
2033
:param force_new_repo: Do not use a shared repository for the target,
2034
even if one is available.
2035
:param create_prefix: Create any missing directories leading up to
2037
:param use_existing_dir: Use an existing directory if one exists.
2038
:param stacked_on: A url to stack any created branch on, None to follow
2039
any target stacking policy.
2040
:param stack_on_pwd: If stack_on is relative, the location it is
2042
:param repo_format_name: If non-None, a repository will be
2043
made-or-found. Should none be found, or if force_new_repo is True
2044
the repo_format_name is used to select the format of repository to
2046
:param make_working_trees: Control the setting of make_working_trees
2047
for a new shared repository when one is made. None to use whatever
2048
default the format has.
2049
:param shared_repo: Control whether made repositories are shared or
2051
:param vfs_only: If True do not attempt to use a smart server
2052
:return: repo, bzrdir, require_stacking, repository_policy. repo is
2053
None if none was created or found, bzrdir is always valid.
2054
require_stacking is the result of examining the stacked_on
2055
parameter and any stacking policy found for the target.
2058
# Try to hand off to a smart server
2060
client_medium = transport.get_smart_medium()
2061
except errors.NoSmartMedium:
2064
# TODO: lookup the local format from a server hint.
2065
remote_dir_format = RemoteBzrDirFormat()
2066
remote_dir_format._network_name = self.network_name()
2067
self._supply_sub_formats_to(remote_dir_format)
2068
return remote_dir_format.initialize_on_transport_ex(transport,
2069
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2070
force_new_repo=force_new_repo, stacked_on=stacked_on,
2071
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2072
make_working_trees=make_working_trees, shared_repo=shared_repo)
2073
# XXX: Refactor the create_prefix/no_create_prefix code into a
2074
# common helper function
2075
# The destination may not exist - if so make it according to policy.
2076
def make_directory(transport):
2077
transport.mkdir('.')
2079
def redirected(transport, e, redirection_notice):
2080
note(redirection_notice)
2081
return transport._redirected_to(e.source, e.target)
2083
transport = do_catching_redirections(make_directory, transport,
2085
except errors.FileExists:
2086
if not use_existing_dir:
2088
except errors.NoSuchFile:
2089
if not create_prefix:
2091
transport.create_prefix()
2093
require_stacking = (stacked_on is not None)
2094
# Now the target directory exists, but doesn't have a .bzr
2095
# directory. So we need to create it, along with any work to create
2096
# all of the dependent branches, etc.
2098
result = self.initialize_on_transport(transport)
2099
if repo_format_name:
2101
# use a custom format
2102
result._format.repository_format = \
2103
repository.network_format_registry.get(repo_format_name)
2104
except AttributeError:
2105
# The format didn't permit it to be set.
2107
# A repository is desired, either in-place or shared.
2108
repository_policy = result.determine_repository_policy(
2109
force_new_repo, stacked_on, stack_on_pwd,
2110
require_stacking=require_stacking)
2111
result_repo, is_new_repo = repository_policy.acquire_repository(
2112
make_working_trees, shared_repo)
2113
if not require_stacking and repository_policy._require_stacking:
2114
require_stacking = True
2115
result._format.require_stacking()
2116
result_repo.lock_write()
2119
repository_policy = None
2120
return result_repo, result, require_stacking, repository_policy
2122
def _initialize_on_transport_vfs(self, transport):
2123
"""Initialize a new bzrdir using VFS calls.
2125
:param transport: The transport to create the .bzr directory in.
2128
# Since we are creating a .bzr directory, inherit the
2129
# mode from the root directory
2130
temp_control = lockable_files.LockableFiles(transport,
2131
'', lockable_files.TransportLock)
2132
temp_control._transport.mkdir('.bzr',
2133
# FIXME: RBC 20060121 don't peek under
2135
mode=temp_control._dir_mode)
2136
if sys.platform == 'win32' and isinstance(transport, local.LocalTransport):
2137
win32utils.set_file_attr_hidden(transport._abspath('.bzr'))
2138
file_mode = temp_control._file_mode
2140
bzrdir_transport = transport.clone('.bzr')
2141
utf8_files = [('README',
2142
"This is a Bazaar control directory.\n"
2143
"Do not change any files in this directory.\n"
2144
"See http://bazaar-vcs.org/ for more information about Bazaar.\n"),
2145
('branch-format', self.get_format_string()),
2147
# NB: no need to escape relative paths that are url safe.
2148
control_files = lockable_files.LockableFiles(bzrdir_transport,
2149
self._lock_file_name, self._lock_class)
2150
control_files.create_lock()
2151
control_files.lock_write()
2153
for (filename, content) in utf8_files:
2154
bzrdir_transport.put_bytes(filename, content,
2157
control_files.unlock()
2158
return self.open(transport, _found=True)
2160
def is_supported(self):
2161
"""Is this format supported?
2163
Supported formats must be initializable and openable.
2164
Unsupported formats may not support initialization or committing or
2165
some other features depending on the reason for not being supported.
2169
def network_name(self):
2170
"""A simple byte string uniquely identifying this format for RPC calls.
2172
Bzr control formats use thir disk format string to identify the format
2173
over the wire. Its possible that other control formats have more
2174
complex detection requirements, so we permit them to use any unique and
2175
immutable string they desire.
2177
raise NotImplementedError(self.network_name)
2179
def same_model(self, target_format):
2180
return (self.repository_format.rich_root_data ==
2181
target_format.rich_root_data)
2184
def known_formats(klass):
2185
"""Return all the known formats.
2187
Concrete formats should override _known_formats.
2189
# There is double indirection here to make sure that control
2190
# formats used by more than one dir format will only be probed
2191
# once. This can otherwise be quite expensive for remote connections.
2193
for format in klass._control_formats:
2194
result.update(format._known_formats())
2198
def _known_formats(klass):
2199
"""Return the known format instances for this control format."""
2200
return set(klass._formats.values())
2202
def open(self, transport, _found=False):
2203
"""Return an instance of this format for the dir transport points at.
2205
_found is a private parameter, do not use it.
2208
found_format = BzrDirFormat.find_format(transport)
2209
if not isinstance(found_format, self.__class__):
2210
raise AssertionError("%s was asked to open %s, but it seems to need "
2212
% (self, transport, found_format))
2213
# Allow subclasses - use the found format.
2214
self._supply_sub_formats_to(found_format)
2215
return found_format._open(transport)
2216
return self._open(transport)
2218
def _open(self, transport):
2219
"""Template method helper for opening BzrDirectories.
2221
This performs the actual open and any additional logic or parameter
2224
raise NotImplementedError(self._open)
2227
def register_format(klass, format):
2228
klass._formats[format.get_format_string()] = format
2229
# bzr native formats have a network name of their format string.
2230
network_format_registry.register(format.get_format_string(), format.__class__)
2233
def register_control_format(klass, format):
2234
"""Register a format that does not use '.bzr' for its control dir.
2236
TODO: This should be pulled up into a 'ControlDirFormat' base class
2237
which BzrDirFormat can inherit from, and renamed to register_format
2238
there. It has been done without that for now for simplicity of
2241
klass._control_formats.append(format)
2244
def register_control_server_format(klass, format):
2245
"""Register a control format for client-server environments.
2247
These formats will be tried before ones registered with
2248
register_control_format. This gives implementations that decide to the
2249
chance to grab it before anything looks at the contents of the format
2252
klass._control_server_formats.append(format)
2255
def _set_default_format(klass, format):
2256
"""Set default format (for testing behavior of defaults only)"""
2257
klass._default_format = format
2261
return self.get_format_description().rstrip()
2263
def _supply_sub_formats_to(self, other_format):
2264
"""Give other_format the same values for sub formats as this has.
2266
This method is expected to be used when parameterising a
2267
RemoteBzrDirFormat instance with the parameters from a
2268
BzrDirMetaFormat1 instance.
2270
:param other_format: other_format is a format which should be
2271
compatible with whatever sub formats are supported by self.
2276
def unregister_format(klass, format):
2277
del klass._formats[format.get_format_string()]
2280
def unregister_control_format(klass, format):
2281
klass._control_formats.remove(format)
2284
class BzrDirFormat4(BzrDirFormat):
2285
"""Bzr dir format 4.
2287
This format is a combined format for working tree, branch and repository.
2289
- Format 1 working trees [always]
2290
- Format 4 branches [always]
2291
- Format 4 repositories [always]
2293
This format is deprecated: it indexes texts using a text it which is
2294
removed in format 5; write support for this format has been removed.
2297
_lock_class = lockable_files.TransportLock
2299
def get_format_string(self):
2300
"""See BzrDirFormat.get_format_string()."""
2301
return "Bazaar-NG branch, format 0.0.4\n"
2303
def get_format_description(self):
2304
"""See BzrDirFormat.get_format_description()."""
2305
return "All-in-one format 4"
2307
def get_converter(self, format=None):
2308
"""See BzrDirFormat.get_converter()."""
2309
# there is one and only one upgrade path here.
2310
return ConvertBzrDir4To5()
2312
def initialize_on_transport(self, transport):
2313
"""Format 4 branches cannot be created."""
2314
raise errors.UninitializableFormat(self)
2316
def is_supported(self):
2317
"""Format 4 is not supported.
2319
It is not supported because the model changed from 4 to 5 and the
2320
conversion logic is expensive - so doing it on the fly was not
2325
def network_name(self):
2326
return self.get_format_string()
2328
def _open(self, transport):
2329
"""See BzrDirFormat._open."""
2330
return BzrDir4(transport, self)
2332
def __return_repository_format(self):
2333
"""Circular import protection."""
2334
from bzrlib.repofmt.weaverepo import RepositoryFormat4
2335
return RepositoryFormat4()
2336
repository_format = property(__return_repository_format)
2339
class BzrDirFormatAllInOne(BzrDirFormat):
2340
"""Common class for formats before meta-dirs."""
2342
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
2343
create_prefix=False, force_new_repo=False, stacked_on=None,
2344
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
2346
"""See BzrDirFormat.initialize_on_transport_ex."""
2347
require_stacking = (stacked_on is not None)
2348
# Format 5 cannot stack, but we've been asked to - actually init
2350
if require_stacking:
2351
format = BzrDirMetaFormat1()
2352
return format.initialize_on_transport_ex(transport,
2353
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2354
force_new_repo=force_new_repo, stacked_on=stacked_on,
2355
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2356
make_working_trees=make_working_trees, shared_repo=shared_repo)
2357
return BzrDirFormat.initialize_on_transport_ex(self, transport,
2358
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2359
force_new_repo=force_new_repo, stacked_on=stacked_on,
2360
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2361
make_working_trees=make_working_trees, shared_repo=shared_repo)
2364
class BzrDirFormat5(BzrDirFormatAllInOne):
2365
"""Bzr control format 5.
2367
This format is a combined format for working tree, branch and repository.
2369
- Format 2 working trees [always]
2370
- Format 4 branches [always]
2371
- Format 5 repositories [always]
2372
Unhashed stores in the repository.
2375
_lock_class = lockable_files.TransportLock
2377
def get_format_string(self):
2378
"""See BzrDirFormat.get_format_string()."""
2379
return "Bazaar-NG branch, format 5\n"
2381
def get_branch_format(self):
2382
from bzrlib import branch
2383
return branch.BzrBranchFormat4()
2385
def get_format_description(self):
2386
"""See BzrDirFormat.get_format_description()."""
2387
return "All-in-one format 5"
2389
def get_converter(self, format=None):
2390
"""See BzrDirFormat.get_converter()."""
2391
# there is one and only one upgrade path here.
2392
return ConvertBzrDir5To6()
2394
def _initialize_for_clone(self, url):
2395
return self.initialize_on_transport(get_transport(url), _cloning=True)
2397
def initialize_on_transport(self, transport, _cloning=False):
2398
"""Format 5 dirs always have working tree, branch and repository.
2400
Except when they are being cloned.
2402
from bzrlib.branch import BzrBranchFormat4
2403
from bzrlib.repofmt.weaverepo import RepositoryFormat5
2404
result = (super(BzrDirFormat5, self).initialize_on_transport(transport))
2405
RepositoryFormat5().initialize(result, _internal=True)
2407
branch = BzrBranchFormat4().initialize(result)
2408
result._init_workingtree()
2411
def network_name(self):
2412
return self.get_format_string()
2414
def _open(self, transport):
2415
"""See BzrDirFormat._open."""
2416
return BzrDir5(transport, self)
2418
def __return_repository_format(self):
2419
"""Circular import protection."""
2420
from bzrlib.repofmt.weaverepo import RepositoryFormat5
2421
return RepositoryFormat5()
2422
repository_format = property(__return_repository_format)
2425
class BzrDirFormat6(BzrDirFormatAllInOne):
2426
"""Bzr control format 6.
2428
This format is a combined format for working tree, branch and repository.
2430
- Format 2 working trees [always]
2431
- Format 4 branches [always]
2432
- Format 6 repositories [always]
2435
_lock_class = lockable_files.TransportLock
2437
def get_format_string(self):
2438
"""See BzrDirFormat.get_format_string()."""
2439
return "Bazaar-NG branch, format 6\n"
2441
def get_format_description(self):
2442
"""See BzrDirFormat.get_format_description()."""
2443
return "All-in-one format 6"
2445
def get_branch_format(self):
2446
from bzrlib import branch
2447
return branch.BzrBranchFormat4()
2449
def get_converter(self, format=None):
2450
"""See BzrDirFormat.get_converter()."""
2451
# there is one and only one upgrade path here.
2452
return ConvertBzrDir6ToMeta()
2454
def _initialize_for_clone(self, url):
2455
return self.initialize_on_transport(get_transport(url), _cloning=True)
2457
def initialize_on_transport(self, transport, _cloning=False):
2458
"""Format 6 dirs always have working tree, branch and repository.
2460
Except when they are being cloned.
2462
from bzrlib.branch import BzrBranchFormat4
2463
from bzrlib.repofmt.weaverepo import RepositoryFormat6
2464
result = super(BzrDirFormat6, self).initialize_on_transport(transport)
2465
RepositoryFormat6().initialize(result, _internal=True)
2467
branch = BzrBranchFormat4().initialize(result)
2468
result._init_workingtree()
2471
def network_name(self):
2472
return self.get_format_string()
2474
def _open(self, transport):
2475
"""See BzrDirFormat._open."""
2476
return BzrDir6(transport, self)
2478
def __return_repository_format(self):
2479
"""Circular import protection."""
2480
from bzrlib.repofmt.weaverepo import RepositoryFormat6
2481
return RepositoryFormat6()
2482
repository_format = property(__return_repository_format)
2485
class BzrDirMetaFormat1(BzrDirFormat):
2486
"""Bzr meta control format 1
2488
This is the first format with split out working tree, branch and repository
2491
- Format 3 working trees [optional]
2492
- Format 5 branches [optional]
2493
- Format 7 repositories [optional]
2496
_lock_class = lockdir.LockDir
2499
self._workingtree_format = None
2500
self._branch_format = None
2501
self._repository_format = None
2503
def __eq__(self, other):
2504
if other.__class__ is not self.__class__:
2506
if other.repository_format != self.repository_format:
2508
if other.workingtree_format != self.workingtree_format:
2512
def __ne__(self, other):
2513
return not self == other
2515
def get_branch_format(self):
2516
if self._branch_format is None:
2517
from bzrlib.branch import BranchFormat
2518
self._branch_format = BranchFormat.get_default_format()
2519
return self._branch_format
2521
def set_branch_format(self, format):
2522
self._branch_format = format
2524
def require_stacking(self, stack_on=None, possible_transports=None,
2526
"""We have a request to stack, try to ensure the formats support it.
2528
:param stack_on: If supplied, it is the URL to a branch that we want to
2529
stack on. Check to see if that format supports stacking before
2532
# Stacking is desired. requested by the target, but does the place it
2533
# points at support stacking? If it doesn't then we should
2534
# not implicitly upgrade. We check this here.
2535
new_repo_format = None
2536
new_branch_format = None
2538
# a bit of state for get_target_branch so that we don't try to open it
2539
# 2 times, for both repo *and* branch
2540
target = [None, False, None] # target_branch, checked, upgrade anyway
2541
def get_target_branch():
2543
# We've checked, don't check again
2545
if stack_on is None:
2546
# No target format, that means we want to force upgrading
2547
target[:] = [None, True, True]
2550
target_dir = BzrDir.open(stack_on,
2551
possible_transports=possible_transports)
2552
except errors.NotBranchError:
2553
# Nothing there, don't change formats
2554
target[:] = [None, True, False]
2556
except errors.JailBreak:
2557
# JailBreak, JFDI and upgrade anyway
2558
target[:] = [None, True, True]
2561
target_branch = target_dir.open_branch()
2562
except errors.NotBranchError:
2563
# No branch, don't upgrade formats
2564
target[:] = [None, True, False]
2566
target[:] = [target_branch, True, False]
2569
if (not _skip_repo and
2570
not self.repository_format.supports_external_lookups):
2571
# We need to upgrade the Repository.
2572
target_branch, _, do_upgrade = get_target_branch()
2573
if target_branch is None:
2574
# We don't have a target branch, should we upgrade anyway?
2576
# stack_on is inaccessible, JFDI.
2577
# TODO: bad monkey, hard-coded formats...
2578
if self.repository_format.rich_root_data:
2579
new_repo_format = pack_repo.RepositoryFormatKnitPack5RichRoot()
2581
new_repo_format = pack_repo.RepositoryFormatKnitPack5()
2583
# If the target already supports stacking, then we know the
2584
# project is already able to use stacking, so auto-upgrade
2586
new_repo_format = target_branch.repository._format
2587
if not new_repo_format.supports_external_lookups:
2588
# target doesn't, source doesn't, so don't auto upgrade
2590
new_repo_format = None
2591
if new_repo_format is not None:
2592
self.repository_format = new_repo_format
2593
note('Source repository format does not support stacking,'
2594
' using format:\n %s',
2595
new_repo_format.get_format_description())
2597
if not self.get_branch_format().supports_stacking():
2598
# We just checked the repo, now lets check if we need to
2599
# upgrade the branch format
2600
target_branch, _, do_upgrade = get_target_branch()
2601
if target_branch is None:
2603
# TODO: bad monkey, hard-coded formats...
2604
new_branch_format = branch.BzrBranchFormat7()
2606
new_branch_format = target_branch._format
2607
if not new_branch_format.supports_stacking():
2608
new_branch_format = None
2609
if new_branch_format is not None:
2610
# Does support stacking, use its format.
2611
self.set_branch_format(new_branch_format)
2612
note('Source branch format does not support stacking,'
2613
' using format:\n %s',
2614
new_branch_format.get_format_description())
2616
def get_converter(self, format=None):
2617
"""See BzrDirFormat.get_converter()."""
2619
format = BzrDirFormat.get_default_format()
2620
if not isinstance(self, format.__class__):
2621
# converting away from metadir is not implemented
2622
raise NotImplementedError(self.get_converter)
2623
return ConvertMetaToMeta(format)
2625
def get_format_string(self):
2626
"""See BzrDirFormat.get_format_string()."""
2627
return "Bazaar-NG meta directory, format 1\n"
2629
def get_format_description(self):
2630
"""See BzrDirFormat.get_format_description()."""
2631
return "Meta directory format 1"
2633
def network_name(self):
2634
return self.get_format_string()
2636
def _open(self, transport):
2637
"""See BzrDirFormat._open."""
2638
# Create a new format instance because otherwise initialisation of new
2639
# metadirs share the global default format object leading to alias
2641
format = BzrDirMetaFormat1()
2642
self._supply_sub_formats_to(format)
2643
return BzrDirMeta1(transport, format)
2645
def __return_repository_format(self):
2646
"""Circular import protection."""
2647
if self._repository_format:
2648
return self._repository_format
2649
from bzrlib.repository import RepositoryFormat
2650
return RepositoryFormat.get_default_format()
2652
def _set_repository_format(self, value):
2653
"""Allow changing the repository format for metadir formats."""
2654
self._repository_format = value
2656
repository_format = property(__return_repository_format,
2657
_set_repository_format)
2659
def _supply_sub_formats_to(self, other_format):
2660
"""Give other_format the same values for sub formats as this has.
2662
This method is expected to be used when parameterising a
2663
RemoteBzrDirFormat instance with the parameters from a
2664
BzrDirMetaFormat1 instance.
2666
:param other_format: other_format is a format which should be
2667
compatible with whatever sub formats are supported by self.
2670
if getattr(self, '_repository_format', None) is not None:
2671
other_format.repository_format = self.repository_format
2672
if self._branch_format is not None:
2673
other_format._branch_format = self._branch_format
2674
if self._workingtree_format is not None:
2675
other_format.workingtree_format = self.workingtree_format
2677
def __get_workingtree_format(self):
2678
if self._workingtree_format is None:
2679
from bzrlib.workingtree import WorkingTreeFormat
2680
self._workingtree_format = WorkingTreeFormat.get_default_format()
2681
return self._workingtree_format
2683
def __set_workingtree_format(self, wt_format):
2684
self._workingtree_format = wt_format
2686
workingtree_format = property(__get_workingtree_format,
2687
__set_workingtree_format)
2690
network_format_registry = registry.FormatRegistry()
2691
"""Registry of formats indexed by their network name.
2693
The network name for a BzrDirFormat is an identifier that can be used when
2694
referring to formats with smart server operations. See
2695
BzrDirFormat.network_name() for more detail.
2699
# Register bzr control format
2700
BzrDirFormat.register_control_format(BzrDirFormat)
2702
# Register bzr formats
2703
BzrDirFormat.register_format(BzrDirFormat4())
2704
BzrDirFormat.register_format(BzrDirFormat5())
2705
BzrDirFormat.register_format(BzrDirFormat6())
2706
__default_format = BzrDirMetaFormat1()
2707
BzrDirFormat.register_format(__default_format)
2708
BzrDirFormat._default_format = __default_format
2711
class Converter(object):
2712
"""Converts a disk format object from one format to another."""
2714
def convert(self, to_convert, pb):
2715
"""Perform the conversion of to_convert, giving feedback via pb.
2717
:param to_convert: The disk object to convert.
2718
:param pb: a progress bar to use for progress information.
2721
def step(self, message):
2722
"""Update the pb by a step."""
2724
self.pb.update(message, self.count, self.total)
2727
class ConvertBzrDir4To5(Converter):
2728
"""Converts format 4 bzr dirs to format 5."""
2731
super(ConvertBzrDir4To5, self).__init__()
2732
self.converted_revs = set()
2733
self.absent_revisions = set()
2737
def convert(self, to_convert, pb):
2738
"""See Converter.convert()."""
2739
self.bzrdir = to_convert
2741
warnings.warn("pb parameter to convert() is deprecated")
2742
self.pb = ui.ui_factory.nested_progress_bar()
2744
ui.ui_factory.note('starting upgrade from format 4 to 5')
2745
if isinstance(self.bzrdir.transport, local.LocalTransport):
2746
self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
2747
self._convert_to_weaves()
2748
return BzrDir.open(self.bzrdir.user_url)
2752
def _convert_to_weaves(self):
2753
ui.ui_factory.note('note: upgrade may be faster if all store files are ungzipped first')
2756
stat = self.bzrdir.transport.stat('weaves')
2757
if not S_ISDIR(stat.st_mode):
2758
self.bzrdir.transport.delete('weaves')
2759
self.bzrdir.transport.mkdir('weaves')
2760
except errors.NoSuchFile:
2761
self.bzrdir.transport.mkdir('weaves')
2762
# deliberately not a WeaveFile as we want to build it up slowly.
2763
self.inv_weave = Weave('inventory')
2764
# holds in-memory weaves for all files
2765
self.text_weaves = {}
2766
self.bzrdir.transport.delete('branch-format')
2767
self.branch = self.bzrdir.open_branch()
2768
self._convert_working_inv()
2769
rev_history = self.branch.revision_history()
2770
# to_read is a stack holding the revisions we still need to process;
2771
# appending to it adds new highest-priority revisions
2772
self.known_revisions = set(rev_history)
2773
self.to_read = rev_history[-1:]
2775
rev_id = self.to_read.pop()
2776
if (rev_id not in self.revisions
2777
and rev_id not in self.absent_revisions):
2778
self._load_one_rev(rev_id)
2780
to_import = self._make_order()
2781
for i, rev_id in enumerate(to_import):
2782
self.pb.update('converting revision', i, len(to_import))
2783
self._convert_one_rev(rev_id)
2785
self._write_all_weaves()
2786
self._write_all_revs()
2787
ui.ui_factory.note('upgraded to weaves:')
2788
ui.ui_factory.note(' %6d revisions and inventories' % len(self.revisions))
2789
ui.ui_factory.note(' %6d revisions not present' % len(self.absent_revisions))
2790
ui.ui_factory.note(' %6d texts' % self.text_count)
2791
self._cleanup_spare_files_after_format4()
2792
self.branch._transport.put_bytes(
2794
BzrDirFormat5().get_format_string(),
2795
mode=self.bzrdir._get_file_mode())
2797
def _cleanup_spare_files_after_format4(self):
2798
# FIXME working tree upgrade foo.
2799
for n in 'merged-patches', 'pending-merged-patches':
2801
## assert os.path.getsize(p) == 0
2802
self.bzrdir.transport.delete(n)
2803
except errors.NoSuchFile:
2805
self.bzrdir.transport.delete_tree('inventory-store')
2806
self.bzrdir.transport.delete_tree('text-store')
2808
def _convert_working_inv(self):
2809
inv = xml4.serializer_v4.read_inventory(
2810
self.branch._transport.get('inventory'))
2811
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv, working=True)
2812
self.branch._transport.put_bytes('inventory', new_inv_xml,
2813
mode=self.bzrdir._get_file_mode())
2815
def _write_all_weaves(self):
2816
controlweaves = WeaveStore(self.bzrdir.transport, prefixed=False)
2817
weave_transport = self.bzrdir.transport.clone('weaves')
2818
weaves = WeaveStore(weave_transport, prefixed=False)
2819
transaction = WriteTransaction()
2823
for file_id, file_weave in self.text_weaves.items():
2824
self.pb.update('writing weave', i, len(self.text_weaves))
2825
weaves._put_weave(file_id, file_weave, transaction)
2827
self.pb.update('inventory', 0, 1)
2828
controlweaves._put_weave('inventory', self.inv_weave, transaction)
2829
self.pb.update('inventory', 1, 1)
2833
def _write_all_revs(self):
2834
"""Write all revisions out in new form."""
2835
self.bzrdir.transport.delete_tree('revision-store')
2836
self.bzrdir.transport.mkdir('revision-store')
2837
revision_transport = self.bzrdir.transport.clone('revision-store')
2839
from bzrlib.xml5 import serializer_v5
2840
from bzrlib.repofmt.weaverepo import RevisionTextStore
2841
revision_store = RevisionTextStore(revision_transport,
2842
serializer_v5, False, versionedfile.PrefixMapper(),
2843
lambda:True, lambda:True)
2845
for i, rev_id in enumerate(self.converted_revs):
2846
self.pb.update('write revision', i, len(self.converted_revs))
2847
text = serializer_v5.write_revision_to_string(
2848
self.revisions[rev_id])
2850
revision_store.add_lines(key, None, osutils.split_lines(text))
2854
def _load_one_rev(self, rev_id):
2855
"""Load a revision object into memory.
2857
Any parents not either loaded or abandoned get queued to be
2859
self.pb.update('loading revision',
2860
len(self.revisions),
2861
len(self.known_revisions))
2862
if not self.branch.repository.has_revision(rev_id):
2864
ui.ui_factory.note('revision {%s} not present in branch; '
2865
'will be converted as a ghost' %
2867
self.absent_revisions.add(rev_id)
2869
rev = self.branch.repository.get_revision(rev_id)
2870
for parent_id in rev.parent_ids:
2871
self.known_revisions.add(parent_id)
2872
self.to_read.append(parent_id)
2873
self.revisions[rev_id] = rev
2875
def _load_old_inventory(self, rev_id):
2876
f = self.branch.repository.inventory_store.get(rev_id)
2878
old_inv_xml = f.read()
2881
inv = xml4.serializer_v4.read_inventory_from_string(old_inv_xml)
2882
inv.revision_id = rev_id
2883
rev = self.revisions[rev_id]
2886
def _load_updated_inventory(self, rev_id):
2887
inv_xml = self.inv_weave.get_text(rev_id)
2888
inv = xml5.serializer_v5.read_inventory_from_string(inv_xml, rev_id)
2891
def _convert_one_rev(self, rev_id):
2892
"""Convert revision and all referenced objects to new format."""
2893
rev = self.revisions[rev_id]
2894
inv = self._load_old_inventory(rev_id)
2895
present_parents = [p for p in rev.parent_ids
2896
if p not in self.absent_revisions]
2897
self._convert_revision_contents(rev, inv, present_parents)
2898
self._store_new_inv(rev, inv, present_parents)
2899
self.converted_revs.add(rev_id)
2901
def _store_new_inv(self, rev, inv, present_parents):
2902
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
2903
new_inv_sha1 = sha_string(new_inv_xml)
2904
self.inv_weave.add_lines(rev.revision_id,
2906
new_inv_xml.splitlines(True))
2907
rev.inventory_sha1 = new_inv_sha1
2909
def _convert_revision_contents(self, rev, inv, present_parents):
2910
"""Convert all the files within a revision.
2912
Also upgrade the inventory to refer to the text revision ids."""
2913
rev_id = rev.revision_id
2914
mutter('converting texts of revision {%s}',
2916
parent_invs = map(self._load_updated_inventory, present_parents)
2917
entries = inv.iter_entries()
2919
for path, ie in entries:
2920
self._convert_file_version(rev, ie, parent_invs)
2922
def _convert_file_version(self, rev, ie, parent_invs):
2923
"""Convert one version of one file.
2925
The file needs to be added into the weave if it is a merge
2926
of >=2 parents or if it's changed from its parent.
2928
file_id = ie.file_id
2929
rev_id = rev.revision_id
2930
w = self.text_weaves.get(file_id)
2933
self.text_weaves[file_id] = w
2934
text_changed = False
2935
parent_candiate_entries = ie.parent_candidates(parent_invs)
2936
heads = graph.Graph(self).heads(parent_candiate_entries.keys())
2937
# XXX: Note that this is unordered - and this is tolerable because
2938
# the previous code was also unordered.
2939
previous_entries = dict((head, parent_candiate_entries[head]) for head
2941
self.snapshot_ie(previous_entries, ie, w, rev_id)
2944
def get_parent_map(self, revision_ids):
2945
"""See graph.StackedParentsProvider.get_parent_map"""
2946
return dict((revision_id, self.revisions[revision_id])
2947
for revision_id in revision_ids
2948
if revision_id in self.revisions)
2950
def snapshot_ie(self, previous_revisions, ie, w, rev_id):
2951
# TODO: convert this logic, which is ~= snapshot to
2952
# a call to:. This needs the path figured out. rather than a work_tree
2953
# a v4 revision_tree can be given, or something that looks enough like
2954
# one to give the file content to the entry if it needs it.
2955
# and we need something that looks like a weave store for snapshot to
2957
#ie.snapshot(rev, PATH, previous_revisions, REVISION_TREE, InMemoryWeaveStore(self.text_weaves))
2958
if len(previous_revisions) == 1:
2959
previous_ie = previous_revisions.values()[0]
2960
if ie._unchanged(previous_ie):
2961
ie.revision = previous_ie.revision
2964
f = self.branch.repository._text_store.get(ie.text_id)
2966
file_lines = f.readlines()
2969
w.add_lines(rev_id, previous_revisions, file_lines)
2970
self.text_count += 1
2972
w.add_lines(rev_id, previous_revisions, [])
2973
ie.revision = rev_id
2975
def _make_order(self):
2976
"""Return a suitable order for importing revisions.
2978
The order must be such that an revision is imported after all
2979
its (present) parents.
2981
todo = set(self.revisions.keys())
2982
done = self.absent_revisions.copy()
2985
# scan through looking for a revision whose parents
2987
for rev_id in sorted(list(todo)):
2988
rev = self.revisions[rev_id]
2989
parent_ids = set(rev.parent_ids)
2990
if parent_ids.issubset(done):
2991
# can take this one now
2992
order.append(rev_id)
2998
class ConvertBzrDir5To6(Converter):
2999
"""Converts format 5 bzr dirs to format 6."""
3001
def convert(self, to_convert, pb):
3002
"""See Converter.convert()."""
3003
self.bzrdir = to_convert
3004
pb = ui.ui_factory.nested_progress_bar()
3006
ui.ui_factory.note('starting upgrade from format 5 to 6')
3007
self._convert_to_prefixed()
3008
return BzrDir.open(self.bzrdir.user_url)
3012
def _convert_to_prefixed(self):
3013
from bzrlib.store import TransportStore
3014
self.bzrdir.transport.delete('branch-format')
3015
for store_name in ["weaves", "revision-store"]:
3016
ui.ui_factory.note("adding prefixes to %s" % store_name)
3017
store_transport = self.bzrdir.transport.clone(store_name)
3018
store = TransportStore(store_transport, prefixed=True)
3019
for urlfilename in store_transport.list_dir('.'):
3020
filename = urlutils.unescape(urlfilename)
3021
if (filename.endswith(".weave") or
3022
filename.endswith(".gz") or
3023
filename.endswith(".sig")):
3024
file_id, suffix = os.path.splitext(filename)
3028
new_name = store._mapper.map((file_id,)) + suffix
3029
# FIXME keep track of the dirs made RBC 20060121
3031
store_transport.move(filename, new_name)
3032
except errors.NoSuchFile: # catches missing dirs strangely enough
3033
store_transport.mkdir(osutils.dirname(new_name))
3034
store_transport.move(filename, new_name)
3035
self.bzrdir.transport.put_bytes(
3037
BzrDirFormat6().get_format_string(),
3038
mode=self.bzrdir._get_file_mode())
3041
class ConvertBzrDir6ToMeta(Converter):
3042
"""Converts format 6 bzr dirs to metadirs."""
3044
def convert(self, to_convert, pb):
3045
"""See Converter.convert()."""
3046
from bzrlib.repofmt.weaverepo import RepositoryFormat7
3047
from bzrlib.branch import BzrBranchFormat5
3048
self.bzrdir = to_convert
3049
self.pb = ui.ui_factory.nested_progress_bar()
3051
self.total = 20 # the steps we know about
3052
self.garbage_inventories = []
3053
self.dir_mode = self.bzrdir._get_dir_mode()
3054
self.file_mode = self.bzrdir._get_file_mode()
3056
ui.ui_factory.note('starting upgrade from format 6 to metadir')
3057
self.bzrdir.transport.put_bytes(
3059
"Converting to format 6",
3060
mode=self.file_mode)
3061
# its faster to move specific files around than to open and use the apis...
3062
# first off, nuke ancestry.weave, it was never used.
3064
self.step('Removing ancestry.weave')
3065
self.bzrdir.transport.delete('ancestry.weave')
3066
except errors.NoSuchFile:
3068
# find out whats there
3069
self.step('Finding branch files')
3070
last_revision = self.bzrdir.open_branch().last_revision()
3071
bzrcontents = self.bzrdir.transport.list_dir('.')
3072
for name in bzrcontents:
3073
if name.startswith('basis-inventory.'):
3074
self.garbage_inventories.append(name)
3075
# create new directories for repository, working tree and branch
3076
repository_names = [('inventory.weave', True),
3077
('revision-store', True),
3079
self.step('Upgrading repository ')
3080
self.bzrdir.transport.mkdir('repository', mode=self.dir_mode)
3081
self.make_lock('repository')
3082
# we hard code the formats here because we are converting into
3083
# the meta format. The meta format upgrader can take this to a
3084
# future format within each component.
3085
self.put_format('repository', RepositoryFormat7())
3086
for entry in repository_names:
3087
self.move_entry('repository', entry)
3089
self.step('Upgrading branch ')
3090
self.bzrdir.transport.mkdir('branch', mode=self.dir_mode)
3091
self.make_lock('branch')
3092
self.put_format('branch', BzrBranchFormat5())
3093
branch_files = [('revision-history', True),
3094
('branch-name', True),
3096
for entry in branch_files:
3097
self.move_entry('branch', entry)
3099
checkout_files = [('pending-merges', True),
3100
('inventory', True),
3101
('stat-cache', False)]
3102
# If a mandatory checkout file is not present, the branch does not have
3103
# a functional checkout. Do not create a checkout in the converted
3105
for name, mandatory in checkout_files:
3106
if mandatory and name not in bzrcontents:
3107
has_checkout = False
3111
if not has_checkout:
3112
ui.ui_factory.note('No working tree.')
3113
# If some checkout files are there, we may as well get rid of them.
3114
for name, mandatory in checkout_files:
3115
if name in bzrcontents:
3116
self.bzrdir.transport.delete(name)
3118
from bzrlib.workingtree import WorkingTreeFormat3
3119
self.step('Upgrading working tree')
3120
self.bzrdir.transport.mkdir('checkout', mode=self.dir_mode)
3121
self.make_lock('checkout')
3123
'checkout', WorkingTreeFormat3())
3124
self.bzrdir.transport.delete_multi(
3125
self.garbage_inventories, self.pb)
3126
for entry in checkout_files:
3127
self.move_entry('checkout', entry)
3128
if last_revision is not None:
3129
self.bzrdir.transport.put_bytes(
3130
'checkout/last-revision', last_revision)
3131
self.bzrdir.transport.put_bytes(
3133
BzrDirMetaFormat1().get_format_string(),
3134
mode=self.file_mode)
3136
return BzrDir.open(self.bzrdir.user_url)
3138
def make_lock(self, name):
3139
"""Make a lock for the new control dir name."""
3140
self.step('Make %s lock' % name)
3141
ld = lockdir.LockDir(self.bzrdir.transport,
3143
file_modebits=self.file_mode,
3144
dir_modebits=self.dir_mode)
3147
def move_entry(self, new_dir, entry):
3148
"""Move then entry name into new_dir."""
3150
mandatory = entry[1]
3151
self.step('Moving %s' % name)
3153
self.bzrdir.transport.move(name, '%s/%s' % (new_dir, name))
3154
except errors.NoSuchFile:
3158
def put_format(self, dirname, format):
3159
self.bzrdir.transport.put_bytes('%s/format' % dirname,
3160
format.get_format_string(),
3164
class ConvertMetaToMeta(Converter):
3165
"""Converts the components of metadirs."""
3167
def __init__(self, target_format):
3168
"""Create a metadir to metadir converter.
3170
:param target_format: The final metadir format that is desired.
3172
self.target_format = target_format
3174
def convert(self, to_convert, pb):
3175
"""See Converter.convert()."""
3176
self.bzrdir = to_convert
3177
self.pb = ui.ui_factory.nested_progress_bar()
3180
self.step('checking repository format')
3182
repo = self.bzrdir.open_repository()
3183
except errors.NoRepositoryPresent:
3186
if not isinstance(repo._format, self.target_format.repository_format.__class__):
3187
from bzrlib.repository import CopyConverter
3188
ui.ui_factory.note('starting repository conversion')
3189
converter = CopyConverter(self.target_format.repository_format)
3190
converter.convert(repo, pb)
3191
for branch in self.bzrdir.list_branches():
3192
# TODO: conversions of Branch and Tree should be done by
3193
# InterXFormat lookups/some sort of registry.
3194
# Avoid circular imports
3195
from bzrlib import branch as _mod_branch
3196
old = branch._format.__class__
3197
new = self.target_format.get_branch_format().__class__
3199
if (old == _mod_branch.BzrBranchFormat5 and
3200
new in (_mod_branch.BzrBranchFormat6,
3201
_mod_branch.BzrBranchFormat7,
3202
_mod_branch.BzrBranchFormat8)):
3203
branch_converter = _mod_branch.Converter5to6()
3204
elif (old == _mod_branch.BzrBranchFormat6 and
3205
new in (_mod_branch.BzrBranchFormat7,
3206
_mod_branch.BzrBranchFormat8)):
3207
branch_converter = _mod_branch.Converter6to7()
3208
elif (old == _mod_branch.BzrBranchFormat7 and
3209
new is _mod_branch.BzrBranchFormat8):
3210
branch_converter = _mod_branch.Converter7to8()
3212
raise errors.BadConversionTarget("No converter", new,
3214
branch_converter.convert(branch)
3215
branch = self.bzrdir.open_branch()
3216
old = branch._format.__class__
3218
tree = self.bzrdir.open_workingtree(recommend_upgrade=False)
3219
except (errors.NoWorkingTree, errors.NotLocalUrl):
3222
# TODO: conversions of Branch and Tree should be done by
3223
# InterXFormat lookups
3224
if (isinstance(tree, workingtree.WorkingTree3) and
3225
not isinstance(tree, workingtree_4.DirStateWorkingTree) and
3226
isinstance(self.target_format.workingtree_format,
3227
workingtree_4.DirStateWorkingTreeFormat)):
3228
workingtree_4.Converter3to4().convert(tree)
3229
if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
3230
not isinstance(tree, workingtree_4.WorkingTree5) and
3231
isinstance(self.target_format.workingtree_format,
3232
workingtree_4.WorkingTreeFormat5)):
3233
workingtree_4.Converter4to5().convert(tree)
3234
if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
3235
not isinstance(tree, workingtree_4.WorkingTree6) and
3236
isinstance(self.target_format.workingtree_format,
3237
workingtree_4.WorkingTreeFormat6)):
3238
workingtree_4.Converter4or5to6().convert(tree)
3243
# This is not in remote.py because it's relatively small, and needs to be
3244
# registered. Putting it in remote.py creates a circular import problem.
3245
# we can make it a lazy object if the control formats is turned into something
3247
class RemoteBzrDirFormat(BzrDirMetaFormat1):
3248
"""Format representing bzrdirs accessed via a smart server"""
3251
BzrDirMetaFormat1.__init__(self)
3252
# XXX: It's a bit ugly that the network name is here, because we'd
3253
# like to believe that format objects are stateless or at least
3254
# immutable, However, we do at least avoid mutating the name after
3255
# it's returned. See <https://bugs.launchpad.net/bzr/+bug/504102>
3256
self._network_name = None
3259
return "%s(_network_name=%r)" % (self.__class__.__name__,
3262
def get_format_description(self):
3263
if self._network_name:
3264
real_format = network_format_registry.get(self._network_name)
3265
return 'Remote: ' + real_format.get_format_description()
3266
return 'bzr remote bzrdir'
3268
def get_format_string(self):
3269
raise NotImplementedError(self.get_format_string)
3271
def network_name(self):
3272
if self._network_name:
3273
return self._network_name
3275
raise AssertionError("No network name set.")
3278
def probe_transport(klass, transport):
3279
"""Return a RemoteBzrDirFormat object if it looks possible."""
3281
medium = transport.get_smart_medium()
3282
except (NotImplementedError, AttributeError,
3283
errors.TransportNotPossible, errors.NoSmartMedium,
3284
errors.SmartProtocolError):
3285
# no smart server, so not a branch for this format type.
3286
raise errors.NotBranchError(path=transport.base)
3288
# Decline to open it if the server doesn't support our required
3289
# version (3) so that the VFS-based transport will do it.
3290
if medium.should_probe():
3292
server_version = medium.protocol_version()
3293
except errors.SmartProtocolError:
3294
# Apparently there's no usable smart server there, even though
3295
# the medium supports the smart protocol.
3296
raise errors.NotBranchError(path=transport.base)
3297
if server_version != '2':
3298
raise errors.NotBranchError(path=transport.base)
3301
def initialize_on_transport(self, transport):
3303
# hand off the request to the smart server
3304
client_medium = transport.get_smart_medium()
3305
except errors.NoSmartMedium:
3306
# TODO: lookup the local format from a server hint.
3307
local_dir_format = BzrDirMetaFormat1()
3308
return local_dir_format.initialize_on_transport(transport)
3309
client = _SmartClient(client_medium)
3310
path = client.remote_path_from_transport(transport)
3312
response = client.call('BzrDirFormat.initialize', path)
3313
except errors.ErrorFromSmartServer, err:
3314
remote._translate_error(err, path=path)
3315
if response[0] != 'ok':
3316
raise errors.SmartProtocolError('unexpected response code %s' % (response,))
3317
format = RemoteBzrDirFormat()
3318
self._supply_sub_formats_to(format)
3319
return remote.RemoteBzrDir(transport, format)
3321
def parse_NoneTrueFalse(self, arg):
3328
raise AssertionError("invalid arg %r" % arg)
3330
def _serialize_NoneTrueFalse(self, arg):
3337
def _serialize_NoneString(self, arg):
3340
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
3341
create_prefix=False, force_new_repo=False, stacked_on=None,
3342
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
3345
# hand off the request to the smart server
3346
client_medium = transport.get_smart_medium()
3347
except errors.NoSmartMedium:
3350
# Decline to open it if the server doesn't support our required
3351
# version (3) so that the VFS-based transport will do it.
3352
if client_medium.should_probe():
3354
server_version = client_medium.protocol_version()
3355
if server_version != '2':
3359
except errors.SmartProtocolError:
3360
# Apparently there's no usable smart server there, even though
3361
# the medium supports the smart protocol.
3366
client = _SmartClient(client_medium)
3367
path = client.remote_path_from_transport(transport)
3368
if client_medium._is_remote_before((1, 16)):
3371
# TODO: lookup the local format from a server hint.
3372
local_dir_format = BzrDirMetaFormat1()
3373
self._supply_sub_formats_to(local_dir_format)
3374
return local_dir_format.initialize_on_transport_ex(transport,
3375
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3376
force_new_repo=force_new_repo, stacked_on=stacked_on,
3377
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3378
make_working_trees=make_working_trees, shared_repo=shared_repo,
3380
return self._initialize_on_transport_ex_rpc(client, path, transport,
3381
use_existing_dir, create_prefix, force_new_repo, stacked_on,
3382
stack_on_pwd, repo_format_name, make_working_trees, shared_repo)
3384
def _initialize_on_transport_ex_rpc(self, client, path, transport,
3385
use_existing_dir, create_prefix, force_new_repo, stacked_on,
3386
stack_on_pwd, repo_format_name, make_working_trees, shared_repo):
3388
args.append(self._serialize_NoneTrueFalse(use_existing_dir))
3389
args.append(self._serialize_NoneTrueFalse(create_prefix))
3390
args.append(self._serialize_NoneTrueFalse(force_new_repo))
3391
args.append(self._serialize_NoneString(stacked_on))
3392
# stack_on_pwd is often/usually our transport
3395
stack_on_pwd = transport.relpath(stack_on_pwd)
3396
if not stack_on_pwd:
3398
except errors.PathNotChild:
3400
args.append(self._serialize_NoneString(stack_on_pwd))
3401
args.append(self._serialize_NoneString(repo_format_name))
3402
args.append(self._serialize_NoneTrueFalse(make_working_trees))
3403
args.append(self._serialize_NoneTrueFalse(shared_repo))
3404
request_network_name = self._network_name or \
3405
BzrDirFormat.get_default_format().network_name()
3407
response = client.call('BzrDirFormat.initialize_ex_1.16',
3408
request_network_name, path, *args)
3409
except errors.UnknownSmartMethod:
3410
client._medium._remember_remote_is_before((1,16))
3411
local_dir_format = BzrDirMetaFormat1()
3412
self._supply_sub_formats_to(local_dir_format)
3413
return local_dir_format.initialize_on_transport_ex(transport,
3414
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3415
force_new_repo=force_new_repo, stacked_on=stacked_on,
3416
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3417
make_working_trees=make_working_trees, shared_repo=shared_repo,
3419
except errors.ErrorFromSmartServer, err:
3420
remote._translate_error(err, path=path)
3421
repo_path = response[0]
3422
bzrdir_name = response[6]
3423
require_stacking = response[7]
3424
require_stacking = self.parse_NoneTrueFalse(require_stacking)
3425
format = RemoteBzrDirFormat()
3426
format._network_name = bzrdir_name
3427
self._supply_sub_formats_to(format)
3428
bzrdir = remote.RemoteBzrDir(transport, format, _client=client)
3430
repo_format = remote.response_tuple_to_repo_format(response[1:])
3431
if repo_path == '.':
3434
repo_bzrdir_format = RemoteBzrDirFormat()
3435
repo_bzrdir_format._network_name = response[5]
3436
repo_bzr = remote.RemoteBzrDir(transport.clone(repo_path),
3440
final_stack = response[8] or None
3441
final_stack_pwd = response[9] or None
3443
final_stack_pwd = urlutils.join(
3444
transport.base, final_stack_pwd)
3445
remote_repo = remote.RemoteRepository(repo_bzr, repo_format)
3446
if len(response) > 10:
3447
# Updated server verb that locks remotely.
3448
repo_lock_token = response[10] or None
3449
remote_repo.lock_write(repo_lock_token, _skip_rpc=True)
3451
remote_repo.dont_leave_lock_in_place()
3453
remote_repo.lock_write()
3454
policy = UseExistingRepository(remote_repo, final_stack,
3455
final_stack_pwd, require_stacking)
3456
policy.acquire_repository()
3460
bzrdir._format.set_branch_format(self.get_branch_format())
3461
if require_stacking:
3462
# The repo has already been created, but we need to make sure that
3463
# we'll make a stackable branch.
3464
bzrdir._format.require_stacking(_skip_repo=True)
3465
return remote_repo, bzrdir, require_stacking, policy
3467
def _open(self, transport):
3468
return remote.RemoteBzrDir(transport, self)
3470
def __eq__(self, other):
3471
if not isinstance(other, RemoteBzrDirFormat):
3473
return self.get_format_description() == other.get_format_description()
3475
def __return_repository_format(self):
3476
# Always return a RemoteRepositoryFormat object, but if a specific bzr
3477
# repository format has been asked for, tell the RemoteRepositoryFormat
3478
# that it should use that for init() etc.
3479
result = remote.RemoteRepositoryFormat()
3480
custom_format = getattr(self, '_repository_format', None)
3482
if isinstance(custom_format, remote.RemoteRepositoryFormat):
3483
return custom_format
3485
# We will use the custom format to create repositories over the
3486
# wire; expose its details like rich_root_data for code to
3488
result._custom_format = custom_format
3491
def get_branch_format(self):
3492
result = BzrDirMetaFormat1.get_branch_format(self)
3493
if not isinstance(result, remote.RemoteBranchFormat):
3494
new_result = remote.RemoteBranchFormat()
3495
new_result._custom_format = result
3497
self.set_branch_format(new_result)
3501
repository_format = property(__return_repository_format,
3502
BzrDirMetaFormat1._set_repository_format) #.im_func)
3505
BzrDirFormat.register_control_server_format(RemoteBzrDirFormat)
3508
class BzrDirFormatInfo(object):
3510
def __init__(self, native, deprecated, hidden, experimental):
3511
self.deprecated = deprecated
3512
self.native = native
3513
self.hidden = hidden
3514
self.experimental = experimental
3517
class BzrDirFormatRegistry(registry.Registry):
3518
"""Registry of user-selectable BzrDir subformats.
3520
Differs from BzrDirFormat._control_formats in that it provides sub-formats,
3521
e.g. BzrDirMeta1 with weave repository. Also, it's more user-oriented.
3525
"""Create a BzrDirFormatRegistry."""
3526
self._aliases = set()
3527
self._registration_order = list()
3528
super(BzrDirFormatRegistry, self).__init__()
3531
"""Return a set of the format names which are aliases."""
3532
return frozenset(self._aliases)
3534
def register_metadir(self, key,
3535
repository_format, help, native=True, deprecated=False,
3541
"""Register a metadir subformat.
3543
These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
3544
by the Repository/Branch/WorkingTreeformats.
3546
:param repository_format: The fully-qualified repository format class
3548
:param branch_format: Fully-qualified branch format class name as
3550
:param tree_format: Fully-qualified tree format class name as
3553
# This should be expanded to support setting WorkingTree and Branch
3554
# formats, once BzrDirMetaFormat1 supports that.
3555
def _load(full_name):
3556
mod_name, factory_name = full_name.rsplit('.', 1)
3558
mod = __import__(mod_name, globals(), locals(),
3560
except ImportError, e:
3561
raise ImportError('failed to load %s: %s' % (full_name, e))
3563
factory = getattr(mod, factory_name)
3564
except AttributeError:
3565
raise AttributeError('no factory %s in module %r'
3570
bd = BzrDirMetaFormat1()
3571
if branch_format is not None:
3572
bd.set_branch_format(_load(branch_format))
3573
if tree_format is not None:
3574
bd.workingtree_format = _load(tree_format)
3575
if repository_format is not None:
3576
bd.repository_format = _load(repository_format)
3578
self.register(key, helper, help, native, deprecated, hidden,
3579
experimental, alias)
3581
def register(self, key, factory, help, native=True, deprecated=False,
3582
hidden=False, experimental=False, alias=False):
3583
"""Register a BzrDirFormat factory.
3585
The factory must be a callable that takes one parameter: the key.
3586
It must produce an instance of the BzrDirFormat when called.
3588
This function mainly exists to prevent the info object from being
3591
registry.Registry.register(self, key, factory, help,
3592
BzrDirFormatInfo(native, deprecated, hidden, experimental))
3594
self._aliases.add(key)
3595
self._registration_order.append(key)
3597
def register_lazy(self, key, module_name, member_name, help, native=True,
3598
deprecated=False, hidden=False, experimental=False, alias=False):
3599
registry.Registry.register_lazy(self, key, module_name, member_name,
3600
help, BzrDirFormatInfo(native, deprecated, hidden, experimental))
3602
self._aliases.add(key)
3603
self._registration_order.append(key)
3605
def set_default(self, key):
3606
"""Set the 'default' key to be a clone of the supplied key.
3608
This method must be called once and only once.
3610
registry.Registry.register(self, 'default', self.get(key),
3611
self.get_help(key), info=self.get_info(key))
3612
self._aliases.add('default')
3614
def set_default_repository(self, key):
3615
"""Set the FormatRegistry default and Repository default.
3617
This is a transitional method while Repository.set_default_format
3620
if 'default' in self:
3621
self.remove('default')
3622
self.set_default(key)
3623
format = self.get('default')()
3625
def make_bzrdir(self, key):
3626
return self.get(key)()
3628
def help_topic(self, topic):
3630
default_realkey = None
3631
default_help = self.get_help('default')
3633
for key in self._registration_order:
3634
if key == 'default':
3636
help = self.get_help(key)
3637
if help == default_help:
3638
default_realkey = key
3640
help_pairs.append((key, help))
3642
def wrapped(key, help, info):
3644
help = '(native) ' + help
3645
return ':%s:\n%s\n\n' % (key,
3646
textwrap.fill(help, initial_indent=' ',
3647
subsequent_indent=' ',
3648
break_long_words=False))
3649
if default_realkey is not None:
3650
output += wrapped(default_realkey, '(default) %s' % default_help,
3651
self.get_info('default'))
3652
deprecated_pairs = []
3653
experimental_pairs = []
3654
for key, help in help_pairs:
3655
info = self.get_info(key)
3658
elif info.deprecated:
3659
deprecated_pairs.append((key, help))
3660
elif info.experimental:
3661
experimental_pairs.append((key, help))
3663
output += wrapped(key, help, info)
3664
output += "\nSee :doc:`formats-help` for more about storage formats."
3666
if len(experimental_pairs) > 0:
3667
other_output += "Experimental formats are shown below.\n\n"
3668
for key, help in experimental_pairs:
3669
info = self.get_info(key)
3670
other_output += wrapped(key, help, info)
3673
"No experimental formats are available.\n\n"
3674
if len(deprecated_pairs) > 0:
3675
other_output += "\nDeprecated formats are shown below.\n\n"
3676
for key, help in deprecated_pairs:
3677
info = self.get_info(key)
3678
other_output += wrapped(key, help, info)
3681
"\nNo deprecated formats are available.\n\n"
3683
"\nSee :doc:`formats-help` for more about storage formats."
3685
if topic == 'other-formats':
3691
class RepositoryAcquisitionPolicy(object):
3692
"""Abstract base class for repository acquisition policies.
3694
A repository acquisition policy decides how a BzrDir acquires a repository
3695
for a branch that is being created. The most basic policy decision is
3696
whether to create a new repository or use an existing one.
3698
def __init__(self, stack_on, stack_on_pwd, require_stacking):
3701
:param stack_on: A location to stack on
3702
:param stack_on_pwd: If stack_on is relative, the location it is
3704
:param require_stacking: If True, it is a failure to not stack.
3706
self._stack_on = stack_on
3707
self._stack_on_pwd = stack_on_pwd
3708
self._require_stacking = require_stacking
3710
def configure_branch(self, branch):
3711
"""Apply any configuration data from this policy to the branch.
3713
Default implementation sets repository stacking.
3715
if self._stack_on is None:
3717
if self._stack_on_pwd is None:
3718
stack_on = self._stack_on
3721
stack_on = urlutils.rebase_url(self._stack_on,
3724
except errors.InvalidRebaseURLs:
3725
stack_on = self._get_full_stack_on()
3727
branch.set_stacked_on_url(stack_on)
3728
except (errors.UnstackableBranchFormat,
3729
errors.UnstackableRepositoryFormat):
3730
if self._require_stacking:
3733
def requires_stacking(self):
3734
"""Return True if this policy requires stacking."""
3735
return self._stack_on is not None and self._require_stacking
3737
def _get_full_stack_on(self):
3738
"""Get a fully-qualified URL for the stack_on location."""
3739
if self._stack_on is None:
3741
if self._stack_on_pwd is None:
3742
return self._stack_on
3744
return urlutils.join(self._stack_on_pwd, self._stack_on)
3746
def _add_fallback(self, repository, possible_transports=None):
3747
"""Add a fallback to the supplied repository, if stacking is set."""
3748
stack_on = self._get_full_stack_on()
3749
if stack_on is None:
3752
stacked_dir = BzrDir.open(stack_on,
3753
possible_transports=possible_transports)
3754
except errors.JailBreak:
3755
# We keep the stacking details, but we are in the server code so
3756
# actually stacking is not needed.
3759
stacked_repo = stacked_dir.open_branch().repository
3760
except errors.NotBranchError:
3761
stacked_repo = stacked_dir.open_repository()
3763
repository.add_fallback_repository(stacked_repo)
3764
except errors.UnstackableRepositoryFormat:
3765
if self._require_stacking:
3768
self._require_stacking = True
3770
def acquire_repository(self, make_working_trees=None, shared=False):
3771
"""Acquire a repository for this bzrdir.
3773
Implementations may create a new repository or use a pre-exising
3775
:param make_working_trees: If creating a repository, set
3776
make_working_trees to this value (if non-None)
3777
:param shared: If creating a repository, make it shared if True
3778
:return: A repository, is_new_flag (True if the repository was
3781
raise NotImplemented(RepositoryAcquisitionPolicy.acquire_repository)
3784
class CreateRepository(RepositoryAcquisitionPolicy):
3785
"""A policy of creating a new repository"""
3787
def __init__(self, bzrdir, stack_on=None, stack_on_pwd=None,
3788
require_stacking=False):
3791
:param bzrdir: The bzrdir to create the repository on.
3792
:param stack_on: A location to stack on
3793
:param stack_on_pwd: If stack_on is relative, the location it is
3796
RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
3798
self._bzrdir = bzrdir
3800
def acquire_repository(self, make_working_trees=None, shared=False):
3801
"""Implementation of RepositoryAcquisitionPolicy.acquire_repository
3803
Creates the desired repository in the bzrdir we already have.
3805
stack_on = self._get_full_stack_on()
3807
format = self._bzrdir._format
3808
format.require_stacking(stack_on=stack_on,
3809
possible_transports=[self._bzrdir.root_transport])
3810
if not self._require_stacking:
3811
# We have picked up automatic stacking somewhere.
3812
note('Using default stacking branch %s at %s', self._stack_on,
3814
repository = self._bzrdir.create_repository(shared=shared)
3815
self._add_fallback(repository,
3816
possible_transports=[self._bzrdir.transport])
3817
if make_working_trees is not None:
3818
repository.set_make_working_trees(make_working_trees)
3819
return repository, True
3822
class UseExistingRepository(RepositoryAcquisitionPolicy):
3823
"""A policy of reusing an existing repository"""
3825
def __init__(self, repository, stack_on=None, stack_on_pwd=None,
3826
require_stacking=False):
3829
:param repository: The repository to use.
3830
:param stack_on: A location to stack on
3831
:param stack_on_pwd: If stack_on is relative, the location it is
3834
RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
3836
self._repository = repository
3838
def acquire_repository(self, make_working_trees=None, shared=False):
3839
"""Implementation of RepositoryAcquisitionPolicy.acquire_repository
3841
Returns an existing repository to use.
3843
self._add_fallback(self._repository,
3844
possible_transports=[self._repository.bzrdir.transport])
3845
return self._repository, False
3848
# Please register new formats after old formats so that formats
3849
# appear in chronological order and format descriptions can build
3851
format_registry = BzrDirFormatRegistry()
3852
# The pre-0.8 formats have their repository format network name registered in
3853
# repository.py. MetaDir formats have their repository format network name
3854
# inferred from their disk format string.
3855
format_registry.register('weave', BzrDirFormat6,
3856
'Pre-0.8 format. Slower than knit and does not'
3857
' support checkouts or shared repositories.',
3860
format_registry.register_metadir('metaweave',
3861
'bzrlib.repofmt.weaverepo.RepositoryFormat7',
3862
'Transitional format in 0.8. Slower than knit.',
3863
branch_format='bzrlib.branch.BzrBranchFormat5',
3864
tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3867
format_registry.register_metadir('knit',
3868
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3869
'Format using knits. Recommended for interoperation with bzr <= 0.14.',
3870
branch_format='bzrlib.branch.BzrBranchFormat5',
3871
tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3874
format_registry.register_metadir('dirstate',
3875
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3876
help='New in 0.15: Fast local operations. Compatible with bzr 0.8 and '
3877
'above when accessed over the network.',
3878
branch_format='bzrlib.branch.BzrBranchFormat5',
3879
# this uses bzrlib.workingtree.WorkingTreeFormat4 because importing
3880
# directly from workingtree_4 triggers a circular import.
3881
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3884
format_registry.register_metadir('dirstate-tags',
3885
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3886
help='New in 0.15: Fast local operations and improved scaling for '
3887
'network operations. Additionally adds support for tags.'
3888
' Incompatible with bzr < 0.15.',
3889
branch_format='bzrlib.branch.BzrBranchFormat6',
3890
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3893
format_registry.register_metadir('rich-root',
3894
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
3895
help='New in 1.0. Better handling of tree roots. Incompatible with'
3897
branch_format='bzrlib.branch.BzrBranchFormat6',
3898
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3901
format_registry.register_metadir('dirstate-with-subtree',
3902
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
3903
help='New in 0.15: Fast local operations and improved scaling for '
3904
'network operations. Additionally adds support for versioning nested '
3905
'bzr branches. Incompatible with bzr < 0.15.',
3906
branch_format='bzrlib.branch.BzrBranchFormat6',
3907
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3911
format_registry.register_metadir('pack-0.92',
3912
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack1',
3913
help='New in 0.92: Pack-based format with data compatible with '
3914
'dirstate-tags format repositories. Interoperates with '
3915
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3917
branch_format='bzrlib.branch.BzrBranchFormat6',
3918
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3920
format_registry.register_metadir('pack-0.92-subtree',
3921
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack3',
3922
help='New in 0.92: Pack-based format with data compatible with '
3923
'dirstate-with-subtree format repositories. Interoperates with '
3924
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3926
branch_format='bzrlib.branch.BzrBranchFormat6',
3927
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3931
format_registry.register_metadir('rich-root-pack',
3932
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
3933
help='New in 1.0: A variant of pack-0.92 that supports rich-root data '
3934
'(needed for bzr-svn and bzr-git).',
3935
branch_format='bzrlib.branch.BzrBranchFormat6',
3936
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3939
format_registry.register_metadir('1.6',
3940
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5',
3941
help='A format that allows a branch to indicate that there is another '
3942
'(stacked) repository that should be used to access data that is '
3943
'not present locally.',
3944
branch_format='bzrlib.branch.BzrBranchFormat7',
3945
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3948
format_registry.register_metadir('1.6.1-rich-root',
3949
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5RichRoot',
3950
help='A variant of 1.6 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.9',
3957
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3958
help='A repository format using B+tree indexes. These indexes '
3959
'are smaller in size, have smarter caching and provide faster '
3960
'performance for most operations.',
3961
branch_format='bzrlib.branch.BzrBranchFormat7',
3962
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3965
format_registry.register_metadir('1.9-rich-root',
3966
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
3967
help='A variant of 1.9 that supports rich-root data '
3968
'(needed for bzr-svn and bzr-git).',
3969
branch_format='bzrlib.branch.BzrBranchFormat7',
3970
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3973
format_registry.register_metadir('1.14',
3974
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3975
help='A working-tree format that supports content filtering.',
3976
branch_format='bzrlib.branch.BzrBranchFormat7',
3977
tree_format='bzrlib.workingtree.WorkingTreeFormat5',
3979
format_registry.register_metadir('1.14-rich-root',
3980
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
3981
help='A variant of 1.14 that supports rich-root data '
3982
'(needed for bzr-svn and bzr-git).',
3983
branch_format='bzrlib.branch.BzrBranchFormat7',
3984
tree_format='bzrlib.workingtree.WorkingTreeFormat5',
3986
# The following un-numbered 'development' formats should always just be aliases.
3987
format_registry.register_metadir('development-rich-root',
3988
'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
3989
help='Current development format. Supports rich roots. Can convert data '
3990
'to and from rich-root-pack (and anything compatible with '
3991
'rich-root-pack) format repositories. Repositories and branches in '
3992
'this format can only be read by bzr.dev. Please read '
3993
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
3995
branch_format='bzrlib.branch.BzrBranchFormat7',
3996
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4001
format_registry.register_metadir('development-subtree',
4002
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment2Subtree',
4003
help='Current development format, subtree variant. Can convert data to and '
4004
'from pack-0.92-subtree (and anything compatible with '
4005
'pack-0.92-subtree) format repositories. Repositories and branches in '
4006
'this format can only be read by bzr.dev. Please read '
4007
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
4009
branch_format='bzrlib.branch.BzrBranchFormat7',
4010
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4013
alias=False, # Restore to being an alias when an actual development subtree format is added
4014
# This current non-alias status is simply because we did not introduce a
4015
# chk based subtree format.
4018
# And the development formats above will have aliased one of the following:
4019
format_registry.register_metadir('development6-rich-root',
4020
'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
4021
help='pack-1.9 with 255-way hashed CHK inv, group compress, rich roots '
4023
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
4025
branch_format='bzrlib.branch.BzrBranchFormat7',
4026
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4031
format_registry.register_metadir('development7-rich-root',
4032
'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK2',
4033
help='pack-1.9 with 255-way hashed CHK inv, bencode revision, group compress, '
4034
'rich roots. Please read '
4035
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
4037
branch_format='bzrlib.branch.BzrBranchFormat7',
4038
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4043
format_registry.register_metadir('2a',
4044
'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
4045
help='First format for bzr 2.0 series.\n'
4046
'Uses group-compress storage.\n'
4047
'Provides rich roots which are a one-way transition.\n',
4048
# 'storage in packs, 255-way hashed CHK inventory, bencode revision, group compress, '
4049
# 'rich roots. Supported by bzr 1.16 and later.',
4050
branch_format='bzrlib.branch.BzrBranchFormat7',
4051
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4055
# The following format should be an alias for the rich root equivalent
4056
# of the default format
4057
format_registry.register_metadir('default-rich-root',
4058
'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
4059
branch_format='bzrlib.branch.BzrBranchFormat7',
4060
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4065
# The current format that is made on 'bzr init'.
4066
format_registry.set_default('2a')
added
removed
bzrlib/bzrdir.py
