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, errors.PermissionDenied):
381
recurse, value = evaluate(bzrdir)
384
subdirs = list_current(current_transport)
385
except (errors.NoSuchFile, errors.PermissionDenied):
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, errors.NoRepositoryPresent):
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 generate_backup_name(self, base):
619
"""Generate a non-existing backup file name based on base."""
621
name = "%s.~%d~" % (base, counter)
622
while self.root_transport.has(name):
624
name = "%s.~%d~" % (base, counter)
627
def backup_bzrdir(self):
628
"""Backup this bzr control directory.
630
:return: Tuple with old path name and new path name
633
backup_dir=self.generate_backup_name('backup.bzr')
634
pb = ui.ui_factory.nested_progress_bar()
636
# FIXME: bug 300001 -- the backup fails if the backup directory
637
# already exists, but it should instead either remove it or make
638
# a new backup directory.
640
old_path = self.root_transport.abspath('.bzr')
641
new_path = self.root_transport.abspath(backup_dir)
642
ui.ui_factory.note('making backup of %s\n to %s' % (old_path, new_path,))
643
self.root_transport.copy_tree('.bzr', backup_dir)
644
return (old_path, new_path)
648
def retire_bzrdir(self, limit=10000):
649
"""Permanently disable the bzrdir.
651
This is done by renaming it to give the user some ability to recover
652
if there was a problem.
654
This will have horrible consequences if anyone has anything locked or
656
:param limit: number of times to retry
661
to_path = '.bzr.retired.%d' % i
662
self.root_transport.rename('.bzr', to_path)
663
note("renamed %s to %s"
664
% (self.root_transport.abspath('.bzr'), to_path))
666
except (errors.TransportError, IOError, errors.PathError):
673
def destroy_workingtree(self):
674
"""Destroy the working tree at this BzrDir.
676
Formats that do not support this may raise UnsupportedOperation.
678
raise NotImplementedError(self.destroy_workingtree)
680
def destroy_workingtree_metadata(self):
681
"""Destroy the control files for the working tree at this BzrDir.
683
The contents of working tree files are not affected.
684
Formats that do not support this may raise UnsupportedOperation.
686
raise NotImplementedError(self.destroy_workingtree_metadata)
688
def _find_containing(self, evaluate):
689
"""Find something in a containing control directory.
691
This method will scan containing control dirs, until it finds what
692
it is looking for, decides that it will never find it, or runs out
693
of containing control directories to check.
695
It is used to implement find_repository and
696
determine_repository_policy.
698
:param evaluate: A function returning (value, stop). If stop is True,
699
the value will be returned.
703
result, stop = evaluate(found_bzrdir)
706
next_transport = found_bzrdir.root_transport.clone('..')
707
if (found_bzrdir.user_url == next_transport.base):
708
# top of the file system
710
# find the next containing bzrdir
712
found_bzrdir = BzrDir.open_containing_from_transport(
714
except errors.NotBranchError:
717
def find_repository(self):
718
"""Find the repository that should be used.
720
This does not require a branch as we use it to find the repo for
721
new branches as well as to hook existing branches up to their
724
def usable_repository(found_bzrdir):
725
# does it have a repository ?
727
repository = found_bzrdir.open_repository()
728
except errors.NoRepositoryPresent:
730
if found_bzrdir.user_url == self.user_url:
731
return repository, True
732
elif repository.is_shared():
733
return repository, True
737
found_repo = self._find_containing(usable_repository)
738
if found_repo is None:
739
raise errors.NoRepositoryPresent(self)
742
def get_branch_reference(self, name=None):
743
"""Return the referenced URL for the branch in this bzrdir.
745
:param name: Optional colocated branch name
746
:raises NotBranchError: If there is no Branch.
747
:raises NoColocatedBranchSupport: If a branch name was specified
748
but colocated branches are not supported.
749
:return: The URL the branch in this bzrdir references if it is a
750
reference branch, or None for regular branches.
753
raise errors.NoColocatedBranchSupport(self)
756
def get_branch_transport(self, branch_format, name=None):
757
"""Get the transport for use by branch format in this BzrDir.
759
Note that bzr dirs that do not support format strings will raise
760
IncompatibleFormat if the branch format they are given has
761
a format string, and vice versa.
763
If branch_format is None, the transport is returned with no
764
checking. If it is not None, then the returned transport is
765
guaranteed to point to an existing directory ready for use.
767
raise NotImplementedError(self.get_branch_transport)
769
def _find_creation_modes(self):
770
"""Determine the appropriate modes for files and directories.
772
They're always set to be consistent with the base directory,
773
assuming that this transport allows setting modes.
775
# TODO: Do we need or want an option (maybe a config setting) to turn
776
# this off or override it for particular locations? -- mbp 20080512
777
if self._mode_check_done:
779
self._mode_check_done = True
781
st = self.transport.stat('.')
782
except errors.TransportNotPossible:
783
self._dir_mode = None
784
self._file_mode = None
786
# Check the directory mode, but also make sure the created
787
# directories and files are read-write for this user. This is
788
# mostly a workaround for filesystems which lie about being able to
789
# write to a directory (cygwin & win32)
790
if (st.st_mode & 07777 == 00000):
791
# FTP allows stat but does not return dir/file modes
792
self._dir_mode = None
793
self._file_mode = None
795
self._dir_mode = (st.st_mode & 07777) | 00700
796
# Remove the sticky and execute bits for files
797
self._file_mode = self._dir_mode & ~07111
799
def _get_file_mode(self):
800
"""Return Unix mode for newly created files, or None.
802
if not self._mode_check_done:
803
self._find_creation_modes()
804
return self._file_mode
806
def _get_dir_mode(self):
807
"""Return Unix mode for newly created directories, or None.
809
if not self._mode_check_done:
810
self._find_creation_modes()
811
return self._dir_mode
813
def get_repository_transport(self, repository_format):
814
"""Get the transport for use by repository format in this BzrDir.
816
Note that bzr dirs that do not support format strings will raise
817
IncompatibleFormat if the repository format they are given has
818
a format string, and vice versa.
820
If repository_format is None, the transport is returned with no
821
checking. If it is not None, then the returned transport is
822
guaranteed to point to an existing directory ready for use.
824
raise NotImplementedError(self.get_repository_transport)
826
def get_workingtree_transport(self, tree_format):
827
"""Get the transport for use by workingtree format in this BzrDir.
829
Note that bzr dirs that do not support format strings will raise
830
IncompatibleFormat if the workingtree format they are given has a
831
format string, and vice versa.
833
If workingtree_format is None, the transport is returned with no
834
checking. If it is not None, then the returned transport is
835
guaranteed to point to an existing directory ready for use.
837
raise NotImplementedError(self.get_workingtree_transport)
839
def get_config(self):
840
"""Get configuration for this BzrDir."""
841
return config.BzrDirConfig(self)
843
def _get_config(self):
844
"""By default, no configuration is available."""
847
def __init__(self, _transport, _format):
848
"""Initialize a Bzr control dir object.
850
Only really common logic should reside here, concrete classes should be
851
made with varying behaviours.
853
:param _format: the format that is creating this BzrDir instance.
854
:param _transport: the transport this dir is based at.
856
self._format = _format
857
# these are also under the more standard names of
858
# control_transport and user_transport
859
self.transport = _transport.clone('.bzr')
860
self.root_transport = _transport
861
self._mode_check_done = False
864
def user_transport(self):
865
return self.root_transport
868
def control_transport(self):
869
return self.transport
871
def is_control_filename(self, filename):
872
"""True if filename is the name of a path which is reserved for bzrdir's.
874
:param filename: A filename within the root transport of this bzrdir.
876
This is true IF and ONLY IF the filename is part of the namespace reserved
877
for bzr control dirs. Currently this is the '.bzr' directory in the root
878
of the root_transport. it is expected that plugins will need to extend
879
this in the future - for instance to make bzr talk with svn working
882
# this might be better on the BzrDirFormat class because it refers to
883
# all the possible bzrdir disk formats.
884
# This method is tested via the workingtree is_control_filename tests-
885
# it was extracted from WorkingTree.is_control_filename. If the method's
886
# contract is extended beyond the current trivial implementation, please
887
# add new tests for it to the appropriate place.
888
return filename == '.bzr' or filename.startswith('.bzr/')
890
def needs_format_conversion(self, format=None):
891
"""Return true if this bzrdir needs convert_format run on it.
893
For instance, if the repository format is out of date but the
894
branch and working tree are not, this should return True.
896
:param format: Optional parameter indicating a specific desired
897
format we plan to arrive at.
899
raise NotImplementedError(self.needs_format_conversion)
902
def open_unsupported(base):
903
"""Open a branch which is not supported."""
904
return BzrDir.open(base, _unsupported=True)
907
def open(base, _unsupported=False, possible_transports=None):
908
"""Open an existing bzrdir, rooted at 'base' (url).
910
:param _unsupported: a private parameter to the BzrDir class.
912
t = get_transport(base, possible_transports=possible_transports)
913
return BzrDir.open_from_transport(t, _unsupported=_unsupported)
916
def open_from_transport(transport, _unsupported=False,
917
_server_formats=True):
918
"""Open a bzrdir within a particular directory.
920
:param transport: Transport containing the bzrdir.
921
:param _unsupported: private.
923
for hook in BzrDir.hooks['pre_open']:
925
# Keep initial base since 'transport' may be modified while following
927
base = transport.base
928
def find_format(transport):
929
return transport, BzrDirFormat.find_format(
930
transport, _server_formats=_server_formats)
932
def redirected(transport, e, redirection_notice):
933
redirected_transport = transport._redirected_to(e.source, e.target)
934
if redirected_transport is None:
935
raise errors.NotBranchError(base)
936
note('%s is%s redirected to %s',
937
transport.base, e.permanently, redirected_transport.base)
938
return redirected_transport
941
transport, format = do_catching_redirections(find_format,
944
except errors.TooManyRedirections:
945
raise errors.NotBranchError(base)
947
BzrDir._check_supported(format, _unsupported)
948
return format.open(transport, _found=True)
950
def open_branch(self, name=None, unsupported=False,
951
ignore_fallbacks=False):
952
"""Open the branch object at this BzrDir if one is present.
954
If unsupported is True, then no longer supported branch formats can
957
TODO: static convenience version of this?
959
raise NotImplementedError(self.open_branch)
962
def open_containing(url, possible_transports=None):
963
"""Open an existing branch which contains url.
965
:param url: url to search from.
966
See open_containing_from_transport for more detail.
968
transport = get_transport(url, possible_transports)
969
return BzrDir.open_containing_from_transport(transport)
972
def open_containing_from_transport(a_transport):
973
"""Open an existing branch which contains a_transport.base.
975
This probes for a branch at a_transport, and searches upwards from there.
977
Basically we keep looking up until we find the control directory or
978
run into the root. If there isn't one, raises NotBranchError.
979
If there is one and it is either an unrecognised format or an unsupported
980
format, UnknownFormatError or UnsupportedFormatError are raised.
981
If there is one, it is returned, along with the unused portion of url.
983
:return: The BzrDir that contains the path, and a Unicode path
984
for the rest of the URL.
986
# this gets the normalised url back. I.e. '.' -> the full path.
987
url = a_transport.base
990
result = BzrDir.open_from_transport(a_transport)
991
return result, urlutils.unescape(a_transport.relpath(url))
992
except errors.NotBranchError, e:
995
new_t = a_transport.clone('..')
996
except errors.InvalidURLJoin:
997
# reached the root, whatever that may be
998
raise errors.NotBranchError(path=url)
999
if new_t.base == a_transport.base:
1000
# reached the root, whatever that may be
1001
raise errors.NotBranchError(path=url)
1004
def _get_tree_branch(self, name=None):
1005
"""Return the branch and tree, if any, for this bzrdir.
1007
:param name: Name of colocated branch to open.
1009
Return None for tree if not present or inaccessible.
1010
Raise NotBranchError if no branch is present.
1011
:return: (tree, branch)
1014
tree = self.open_workingtree()
1015
except (errors.NoWorkingTree, errors.NotLocalUrl):
1017
branch = self.open_branch(name=name)
1019
if name is not None:
1020
branch = self.open_branch(name=name)
1022
branch = tree.branch
1026
def open_tree_or_branch(klass, location):
1027
"""Return the branch and working tree at a location.
1029
If there is no tree at the location, tree will be None.
1030
If there is no branch at the location, an exception will be
1032
:return: (tree, branch)
1034
bzrdir = klass.open(location)
1035
return bzrdir._get_tree_branch()
1038
def open_containing_tree_or_branch(klass, location):
1039
"""Return the branch and working tree contained by a location.
1041
Returns (tree, branch, relpath).
1042
If there is no tree at containing the location, tree will be None.
1043
If there is no branch containing the location, an exception will be
1045
relpath is the portion of the path that is contained by the branch.
1047
bzrdir, relpath = klass.open_containing(location)
1048
tree, branch = bzrdir._get_tree_branch()
1049
return tree, branch, relpath
1052
def open_containing_tree_branch_or_repository(klass, location):
1053
"""Return the working tree, branch and repo contained by a location.
1055
Returns (tree, branch, repository, relpath).
1056
If there is no tree containing the location, tree will be None.
1057
If there is no branch containing the location, branch will be None.
1058
If there is no repository containing the location, repository will be
1060
relpath is the portion of the path that is contained by the innermost
1063
If no tree, branch or repository is found, a NotBranchError is raised.
1065
bzrdir, relpath = klass.open_containing(location)
1067
tree, branch = bzrdir._get_tree_branch()
1068
except errors.NotBranchError:
1070
repo = bzrdir.find_repository()
1071
return None, None, repo, relpath
1072
except (errors.NoRepositoryPresent):
1073
raise errors.NotBranchError(location)
1074
return tree, branch, branch.repository, relpath
1076
def open_repository(self, _unsupported=False):
1077
"""Open the repository object at this BzrDir if one is present.
1079
This will not follow the Branch object pointer - it's strictly a direct
1080
open facility. Most client code should use open_branch().repository to
1081
get at a repository.
1083
:param _unsupported: a private parameter, not part of the api.
1084
TODO: static convenience version of this?
1086
raise NotImplementedError(self.open_repository)
1088
def open_workingtree(self, _unsupported=False,
1089
recommend_upgrade=True, from_branch=None):
1090
"""Open the workingtree object at this BzrDir if one is present.
1092
:param recommend_upgrade: Optional keyword parameter, when True (the
1093
default), emit through the ui module a recommendation that the user
1094
upgrade the working tree when the workingtree being opened is old
1095
(but still fully supported).
1096
:param from_branch: override bzrdir branch (for lightweight checkouts)
1098
raise NotImplementedError(self.open_workingtree)
1100
def has_branch(self, name=None):
1101
"""Tell if this bzrdir contains a branch.
1103
Note: if you're going to open the branch, you should just go ahead
1104
and try, and not ask permission first. (This method just opens the
1105
branch and discards it, and that's somewhat expensive.)
1108
self.open_branch(name)
1110
except errors.NotBranchError:
1113
def has_workingtree(self):
1114
"""Tell if this bzrdir contains a working tree.
1116
This will still raise an exception if the bzrdir has a workingtree that
1117
is remote & inaccessible.
1119
Note: if you're going to open the working tree, you should just go ahead
1120
and try, and not ask permission first. (This method just opens the
1121
workingtree and discards it, and that's somewhat expensive.)
1124
self.open_workingtree(recommend_upgrade=False)
1126
except errors.NoWorkingTree:
1129
def _cloning_metadir(self):
1130
"""Produce a metadir suitable for cloning with.
1132
:returns: (destination_bzrdir_format, source_repository)
1134
result_format = self._format.__class__()
1137
branch = self.open_branch(ignore_fallbacks=True)
1138
source_repository = branch.repository
1139
result_format._branch_format = branch._format
1140
except errors.NotBranchError:
1141
source_branch = None
1142
source_repository = self.open_repository()
1143
except errors.NoRepositoryPresent:
1144
source_repository = None
1146
# XXX TODO: This isinstance is here because we have not implemented
1147
# the fix recommended in bug # 103195 - to delegate this choice the
1148
# repository itself.
1149
repo_format = source_repository._format
1150
if isinstance(repo_format, remote.RemoteRepositoryFormat):
1151
source_repository._ensure_real()
1152
repo_format = source_repository._real_repository._format
1153
result_format.repository_format = repo_format
1155
# TODO: Couldn't we just probe for the format in these cases,
1156
# rather than opening the whole tree? It would be a little
1157
# faster. mbp 20070401
1158
tree = self.open_workingtree(recommend_upgrade=False)
1159
except (errors.NoWorkingTree, errors.NotLocalUrl):
1160
result_format.workingtree_format = None
1162
result_format.workingtree_format = tree._format.__class__()
1163
return result_format, source_repository
1165
def cloning_metadir(self, require_stacking=False):
1166
"""Produce a metadir suitable for cloning or sprouting with.
1168
These operations may produce workingtrees (yes, even though they're
1169
"cloning" something that doesn't have a tree), so a viable workingtree
1170
format must be selected.
1172
:require_stacking: If True, non-stackable formats will be upgraded
1173
to similar stackable formats.
1174
:returns: a BzrDirFormat with all component formats either set
1175
appropriately or set to None if that component should not be
1178
format, repository = self._cloning_metadir()
1179
if format._workingtree_format is None:
1181
if repository is None:
1182
# No repository either
1184
# We have a repository, so set a working tree? (Why? This seems to
1185
# contradict the stated return value in the docstring).
1186
tree_format = repository._format._matchingbzrdir.workingtree_format
1187
format.workingtree_format = tree_format.__class__()
1188
if require_stacking:
1189
format.require_stacking()
1192
def checkout_metadir(self):
1193
return self.cloning_metadir()
1195
def sprout(self, url, revision_id=None, force_new_repo=False,
1196
recurse='down', possible_transports=None,
1197
accelerator_tree=None, hardlink=False, stacked=False,
1198
source_branch=None, create_tree_if_local=True):
1199
"""Create a copy of this bzrdir prepared for use as a new line of
1202
If url's last component does not exist, it will be created.
1204
Attributes related to the identity of the source branch like
1205
branch nickname will be cleaned, a working tree is created
1206
whether one existed before or not; and a local branch is always
1209
if revision_id is not None, then the clone operation may tune
1210
itself to download less data.
1211
:param accelerator_tree: A tree which can be used for retrieving file
1212
contents more quickly than the revision tree, i.e. a workingtree.
1213
The revision tree will be used for cases where accelerator_tree's
1214
content is different.
1215
:param hardlink: If true, hard-link files from accelerator_tree,
1217
:param stacked: If true, create a stacked branch referring to the
1218
location of this control directory.
1219
:param create_tree_if_local: If true, a working-tree will be created
1220
when working locally.
1222
target_transport = get_transport(url, possible_transports)
1223
target_transport.ensure_base()
1224
cloning_format = self.cloning_metadir(stacked)
1225
# Create/update the result branch
1226
result = cloning_format.initialize_on_transport(target_transport)
1227
# if a stacked branch wasn't requested, we don't create one
1228
# even if the origin was stacked
1229
stacked_branch_url = None
1230
if source_branch is not None:
1232
stacked_branch_url = self.root_transport.base
1233
source_repository = source_branch.repository
1236
source_branch = self.open_branch()
1237
source_repository = source_branch.repository
1239
stacked_branch_url = self.root_transport.base
1240
except errors.NotBranchError:
1241
source_branch = None
1243
source_repository = self.open_repository()
1244
except errors.NoRepositoryPresent:
1245
source_repository = None
1246
repository_policy = result.determine_repository_policy(
1247
force_new_repo, stacked_branch_url, require_stacking=stacked)
1248
result_repo, is_new_repo = repository_policy.acquire_repository()
1249
is_stacked = stacked or (len(result_repo._fallback_repositories) != 0)
1250
if is_new_repo and revision_id is not None and not is_stacked:
1251
fetch_spec = graph.PendingAncestryResult(
1252
[revision_id], source_repository)
1255
if source_repository is not None:
1256
# Fetch while stacked to prevent unstacked fetch from
1258
if fetch_spec is None:
1259
result_repo.fetch(source_repository, revision_id=revision_id)
1261
result_repo.fetch(source_repository, fetch_spec=fetch_spec)
1263
if source_branch is None:
1264
# this is for sprouting a bzrdir without a branch; is that
1266
# Not especially, but it's part of the contract.
1267
result_branch = result.create_branch()
1269
result_branch = source_branch.sprout(result,
1270
revision_id=revision_id, repository_policy=repository_policy)
1271
mutter("created new branch %r" % (result_branch,))
1273
# Create/update the result working tree
1274
if (create_tree_if_local and
1275
isinstance(target_transport, local.LocalTransport) and
1276
(result_repo is None or result_repo.make_working_trees())):
1277
wt = result.create_workingtree(accelerator_tree=accelerator_tree,
1281
if wt.path2id('') is None:
1283
wt.set_root_id(self.open_workingtree.get_root_id())
1284
except errors.NoWorkingTree:
1290
if recurse == 'down':
1292
basis = wt.basis_tree()
1294
subtrees = basis.iter_references()
1295
elif result_branch is not None:
1296
basis = result_branch.basis_tree()
1298
subtrees = basis.iter_references()
1299
elif source_branch is not None:
1300
basis = source_branch.basis_tree()
1302
subtrees = basis.iter_references()
1307
for path, file_id in subtrees:
1308
target = urlutils.join(url, urlutils.escape(path))
1309
sublocation = source_branch.reference_parent(file_id, path)
1310
sublocation.bzrdir.sprout(target,
1311
basis.get_reference_revision(file_id, path),
1312
force_new_repo=force_new_repo, recurse=recurse,
1315
if basis is not None:
1319
def push_branch(self, source, revision_id=None, overwrite=False,
1320
remember=False, create_prefix=False):
1321
"""Push the source branch into this BzrDir."""
1323
# If we can open a branch, use its direct repository, otherwise see
1324
# if there is a repository without a branch.
1326
br_to = self.open_branch()
1327
except errors.NotBranchError:
1328
# Didn't find a branch, can we find a repository?
1329
repository_to = self.find_repository()
1331
# Found a branch, so we must have found a repository
1332
repository_to = br_to.repository
1334
push_result = PushResult()
1335
push_result.source_branch = source
1337
# We have a repository but no branch, copy the revisions, and then
1339
repository_to.fetch(source.repository, revision_id=revision_id)
1340
br_to = source.clone(self, revision_id=revision_id)
1341
if source.get_push_location() is None or remember:
1342
source.set_push_location(br_to.base)
1343
push_result.stacked_on = None
1344
push_result.branch_push_result = None
1345
push_result.old_revno = None
1346
push_result.old_revid = _mod_revision.NULL_REVISION
1347
push_result.target_branch = br_to
1348
push_result.master_branch = None
1349
push_result.workingtree_updated = False
1351
# We have successfully opened the branch, remember if necessary:
1352
if source.get_push_location() is None or remember:
1353
source.set_push_location(br_to.base)
1355
tree_to = self.open_workingtree()
1356
except errors.NotLocalUrl:
1357
push_result.branch_push_result = source.push(br_to,
1358
overwrite, stop_revision=revision_id)
1359
push_result.workingtree_updated = False
1360
except errors.NoWorkingTree:
1361
push_result.branch_push_result = source.push(br_to,
1362
overwrite, stop_revision=revision_id)
1363
push_result.workingtree_updated = None # Not applicable
1365
tree_to.lock_write()
1367
push_result.branch_push_result = source.push(
1368
tree_to.branch, overwrite, stop_revision=revision_id)
1372
push_result.workingtree_updated = True
1373
push_result.old_revno = push_result.branch_push_result.old_revno
1374
push_result.old_revid = push_result.branch_push_result.old_revid
1375
push_result.target_branch = \
1376
push_result.branch_push_result.target_branch
1380
class BzrDirHooks(hooks.Hooks):
1381
"""Hooks for BzrDir operations."""
1384
"""Create the default hooks."""
1385
hooks.Hooks.__init__(self)
1386
self.create_hook(hooks.HookPoint('pre_open',
1387
"Invoked before attempting to open a BzrDir with the transport "
1388
"that the open will use.", (1, 14), None))
1389
self.create_hook(hooks.HookPoint('post_repo_init',
1390
"Invoked after a repository has been initialized. "
1391
"post_repo_init is called with a "
1392
"bzrlib.bzrdir.RepoInitHookParams.",
1395
# install the default hooks
1396
BzrDir.hooks = BzrDirHooks()
1399
class RepoInitHookParams(object):
1400
"""Object holding parameters passed to *_repo_init hooks.
1402
There are 4 fields that hooks may wish to access:
1404
:ivar repository: Repository created
1405
:ivar format: Repository format
1406
:ivar bzrdir: The bzrdir for the repository
1407
:ivar shared: The repository is shared
1410
def __init__(self, repository, format, a_bzrdir, shared):
1411
"""Create a group of RepoInitHook parameters.
1413
:param repository: Repository created
1414
:param format: Repository format
1415
:param bzrdir: The bzrdir for the repository
1416
:param shared: The repository is shared
1418
self.repository = repository
1419
self.format = format
1420
self.bzrdir = a_bzrdir
1421
self.shared = shared
1423
def __eq__(self, other):
1424
return self.__dict__ == other.__dict__
1428
return "<%s for %s>" % (self.__class__.__name__,
1431
return "<%s for %s>" % (self.__class__.__name__,
1435
class BzrDirPreSplitOut(BzrDir):
1436
"""A common class for the all-in-one formats."""
1438
def __init__(self, _transport, _format):
1439
"""See BzrDir.__init__."""
1440
super(BzrDirPreSplitOut, self).__init__(_transport, _format)
1441
self._control_files = lockable_files.LockableFiles(
1442
self.get_branch_transport(None),
1443
self._format._lock_file_name,
1444
self._format._lock_class)
1446
def break_lock(self):
1447
"""Pre-splitout bzrdirs do not suffer from stale locks."""
1448
raise NotImplementedError(self.break_lock)
1450
def cloning_metadir(self, require_stacking=False):
1451
"""Produce a metadir suitable for cloning with."""
1452
if require_stacking:
1453
return format_registry.make_bzrdir('1.6')
1454
return self._format.__class__()
1456
def clone(self, url, revision_id=None, force_new_repo=False,
1457
preserve_stacking=False):
1458
"""See BzrDir.clone().
1460
force_new_repo has no effect, since this family of formats always
1461
require a new repository.
1462
preserve_stacking has no effect, since no source branch using this
1463
family of formats can be stacked, so there is no stacking to preserve.
1465
self._make_tail(url)
1466
result = self._format._initialize_for_clone(url)
1467
self.open_repository().clone(result, revision_id=revision_id)
1468
from_branch = self.open_branch()
1469
from_branch.clone(result, revision_id=revision_id)
1471
tree = self.open_workingtree()
1472
except errors.NotLocalUrl:
1473
# make a new one, this format always has to have one.
1474
result._init_workingtree()
1479
def create_branch(self, name=None):
1480
"""See BzrDir.create_branch."""
1481
return self._format.get_branch_format().initialize(self, name=name)
1483
def destroy_branch(self, name=None):
1484
"""See BzrDir.destroy_branch."""
1485
raise errors.UnsupportedOperation(self.destroy_branch, self)
1487
def create_repository(self, shared=False):
1488
"""See BzrDir.create_repository."""
1490
raise errors.IncompatibleFormat('shared repository', self._format)
1491
return self.open_repository()
1493
def destroy_repository(self):
1494
"""See BzrDir.destroy_repository."""
1495
raise errors.UnsupportedOperation(self.destroy_repository, self)
1497
def create_workingtree(self, revision_id=None, from_branch=None,
1498
accelerator_tree=None, hardlink=False):
1499
"""See BzrDir.create_workingtree."""
1500
# The workingtree is sometimes created when the bzrdir is created,
1501
# but not when cloning.
1503
# this looks buggy but is not -really-
1504
# because this format creates the workingtree when the bzrdir is
1506
# clone and sprout will have set the revision_id
1507
# and that will have set it for us, its only
1508
# specific uses of create_workingtree in isolation
1509
# that can do wonky stuff here, and that only
1510
# happens for creating checkouts, which cannot be
1511
# done on this format anyway. So - acceptable wart.
1513
warning("can't support hardlinked working trees in %r"
1516
result = self.open_workingtree(recommend_upgrade=False)
1517
except errors.NoSuchFile:
1518
result = self._init_workingtree()
1519
if revision_id is not None:
1520
if revision_id == _mod_revision.NULL_REVISION:
1521
result.set_parent_ids([])
1523
result.set_parent_ids([revision_id])
1526
def _init_workingtree(self):
1527
from bzrlib.workingtree import WorkingTreeFormat2
1529
return WorkingTreeFormat2().initialize(self)
1530
except errors.NotLocalUrl:
1531
# Even though we can't access the working tree, we need to
1532
# create its control files.
1533
return WorkingTreeFormat2()._stub_initialize_on_transport(
1534
self.transport, self._control_files._file_mode)
1536
def destroy_workingtree(self):
1537
"""See BzrDir.destroy_workingtree."""
1538
raise errors.UnsupportedOperation(self.destroy_workingtree, self)
1540
def destroy_workingtree_metadata(self):
1541
"""See BzrDir.destroy_workingtree_metadata."""
1542
raise errors.UnsupportedOperation(self.destroy_workingtree_metadata,
1545
def get_branch_transport(self, branch_format, name=None):
1546
"""See BzrDir.get_branch_transport()."""
1547
if name is not None:
1548
raise errors.NoColocatedBranchSupport(self)
1549
if branch_format is None:
1550
return self.transport
1552
branch_format.get_format_string()
1553
except NotImplementedError:
1554
return self.transport
1555
raise errors.IncompatibleFormat(branch_format, self._format)
1557
def get_repository_transport(self, repository_format):
1558
"""See BzrDir.get_repository_transport()."""
1559
if repository_format is None:
1560
return self.transport
1562
repository_format.get_format_string()
1563
except NotImplementedError:
1564
return self.transport
1565
raise errors.IncompatibleFormat(repository_format, self._format)
1567
def get_workingtree_transport(self, workingtree_format):
1568
"""See BzrDir.get_workingtree_transport()."""
1569
if workingtree_format is None:
1570
return self.transport
1572
workingtree_format.get_format_string()
1573
except NotImplementedError:
1574
return self.transport
1575
raise errors.IncompatibleFormat(workingtree_format, self._format)
1577
def needs_format_conversion(self, format=None):
1578
"""See BzrDir.needs_format_conversion()."""
1579
# if the format is not the same as the system default,
1580
# an upgrade is needed.
1582
symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1583
% 'needs_format_conversion(format=None)')
1584
format = BzrDirFormat.get_default_format()
1585
return not isinstance(self._format, format.__class__)
1587
def open_branch(self, name=None, unsupported=False,
1588
ignore_fallbacks=False):
1589
"""See BzrDir.open_branch."""
1590
from bzrlib.branch import BzrBranchFormat4
1591
format = BzrBranchFormat4()
1592
self._check_supported(format, unsupported)
1593
return format.open(self, name, _found=True)
1595
def sprout(self, url, revision_id=None, force_new_repo=False,
1596
possible_transports=None, accelerator_tree=None,
1597
hardlink=False, stacked=False, create_tree_if_local=True,
1598
source_branch=None):
1599
"""See BzrDir.sprout()."""
1600
if source_branch is not None:
1601
my_branch = self.open_branch()
1602
if source_branch.base != my_branch.base:
1603
raise AssertionError(
1604
"source branch %r is not within %r with branch %r" %
1605
(source_branch, self, my_branch))
1607
raise errors.UnstackableBranchFormat(
1608
self._format, self.root_transport.base)
1609
if not create_tree_if_local:
1610
raise errors.MustHaveWorkingTree(
1611
self._format, self.root_transport.base)
1612
from bzrlib.workingtree import WorkingTreeFormat2
1613
self._make_tail(url)
1614
result = self._format._initialize_for_clone(url)
1616
self.open_repository().clone(result, revision_id=revision_id)
1617
except errors.NoRepositoryPresent:
1620
self.open_branch().sprout(result, revision_id=revision_id)
1621
except errors.NotBranchError:
1624
# we always want a working tree
1625
WorkingTreeFormat2().initialize(result,
1626
accelerator_tree=accelerator_tree,
1631
class BzrDir4(BzrDirPreSplitOut):
1632
"""A .bzr version 4 control object.
1634
This is a deprecated format and may be removed after sept 2006.
1637
def create_repository(self, shared=False):
1638
"""See BzrDir.create_repository."""
1639
return self._format.repository_format.initialize(self, shared)
1641
def needs_format_conversion(self, format=None):
1642
"""Format 4 dirs are always in need of conversion."""
1644
symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1645
% 'needs_format_conversion(format=None)')
1648
def open_repository(self):
1649
"""See BzrDir.open_repository."""
1650
from bzrlib.repofmt.weaverepo import RepositoryFormat4
1651
return RepositoryFormat4().open(self, _found=True)
1654
class BzrDir5(BzrDirPreSplitOut):
1655
"""A .bzr version 5 control object.
1657
This is a deprecated format and may be removed after sept 2006.
1660
def has_workingtree(self):
1661
"""See BzrDir.has_workingtree."""
1664
def open_repository(self):
1665
"""See BzrDir.open_repository."""
1666
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1667
return RepositoryFormat5().open(self, _found=True)
1669
def open_workingtree(self, _unsupported=False,
1670
recommend_upgrade=True):
1671
"""See BzrDir.create_workingtree."""
1672
from bzrlib.workingtree import WorkingTreeFormat2
1673
wt_format = WorkingTreeFormat2()
1674
# we don't warn here about upgrades; that ought to be handled for the
1676
return wt_format.open(self, _found=True)
1679
class BzrDir6(BzrDirPreSplitOut):
1680
"""A .bzr version 6 control object.
1682
This is a deprecated format and may be removed after sept 2006.
1685
def has_workingtree(self):
1686
"""See BzrDir.has_workingtree."""
1689
def open_repository(self):
1690
"""See BzrDir.open_repository."""
1691
from bzrlib.repofmt.weaverepo import RepositoryFormat6
1692
return RepositoryFormat6().open(self, _found=True)
1694
def open_workingtree(self, _unsupported=False,
1695
recommend_upgrade=True):
1696
"""See BzrDir.create_workingtree."""
1697
# we don't warn here about upgrades; that ought to be handled for the
1699
from bzrlib.workingtree import WorkingTreeFormat2
1700
return WorkingTreeFormat2().open(self, _found=True)
1703
class BzrDirMeta1(BzrDir):
1704
"""A .bzr meta version 1 control object.
1706
This is the first control object where the
1707
individual aspects are really split out: there are separate repository,
1708
workingtree and branch subdirectories and any subset of the three can be
1709
present within a BzrDir.
1712
def can_convert_format(self):
1713
"""See BzrDir.can_convert_format()."""
1716
def create_branch(self, name=None):
1717
"""See BzrDir.create_branch."""
1718
return self._format.get_branch_format().initialize(self, name=name)
1720
def destroy_branch(self, name=None):
1721
"""See BzrDir.create_branch."""
1722
if name is not None:
1723
raise errors.NoColocatedBranchSupport(self)
1724
self.transport.delete_tree('branch')
1726
def create_repository(self, shared=False):
1727
"""See BzrDir.create_repository."""
1728
return self._format.repository_format.initialize(self, shared)
1730
def destroy_repository(self):
1731
"""See BzrDir.destroy_repository."""
1732
self.transport.delete_tree('repository')
1734
def create_workingtree(self, revision_id=None, from_branch=None,
1735
accelerator_tree=None, hardlink=False):
1736
"""See BzrDir.create_workingtree."""
1737
return self._format.workingtree_format.initialize(
1738
self, revision_id, from_branch=from_branch,
1739
accelerator_tree=accelerator_tree, hardlink=hardlink)
1741
def destroy_workingtree(self):
1742
"""See BzrDir.destroy_workingtree."""
1743
wt = self.open_workingtree(recommend_upgrade=False)
1744
repository = wt.branch.repository
1745
empty = repository.revision_tree(_mod_revision.NULL_REVISION)
1746
wt.revert(old_tree=empty)
1747
self.destroy_workingtree_metadata()
1749
def destroy_workingtree_metadata(self):
1750
self.transport.delete_tree('checkout')
1752
def find_branch_format(self, name=None):
1753
"""Find the branch 'format' for this bzrdir.
1755
This might be a synthetic object for e.g. RemoteBranch and SVN.
1757
from bzrlib.branch import BranchFormat
1758
return BranchFormat.find_format(self, name=name)
1760
def _get_mkdir_mode(self):
1761
"""Figure out the mode to use when creating a bzrdir subdir."""
1762
temp_control = lockable_files.LockableFiles(self.transport, '',
1763
lockable_files.TransportLock)
1764
return temp_control._dir_mode
1766
def get_branch_reference(self, name=None):
1767
"""See BzrDir.get_branch_reference()."""
1768
from bzrlib.branch import BranchFormat
1769
format = BranchFormat.find_format(self, name=name)
1770
return format.get_reference(self, name=name)
1772
def get_branch_transport(self, branch_format, name=None):
1773
"""See BzrDir.get_branch_transport()."""
1774
if name is not None:
1775
raise errors.NoColocatedBranchSupport(self)
1776
# XXX: this shouldn't implicitly create the directory if it's just
1777
# promising to get a transport -- mbp 20090727
1778
if branch_format is None:
1779
return self.transport.clone('branch')
1781
branch_format.get_format_string()
1782
except NotImplementedError:
1783
raise errors.IncompatibleFormat(branch_format, self._format)
1785
self.transport.mkdir('branch', mode=self._get_mkdir_mode())
1786
except errors.FileExists:
1788
return self.transport.clone('branch')
1790
def get_repository_transport(self, repository_format):
1791
"""See BzrDir.get_repository_transport()."""
1792
if repository_format is None:
1793
return self.transport.clone('repository')
1795
repository_format.get_format_string()
1796
except NotImplementedError:
1797
raise errors.IncompatibleFormat(repository_format, self._format)
1799
self.transport.mkdir('repository', mode=self._get_mkdir_mode())
1800
except errors.FileExists:
1802
return self.transport.clone('repository')
1804
def get_workingtree_transport(self, workingtree_format):
1805
"""See BzrDir.get_workingtree_transport()."""
1806
if workingtree_format is None:
1807
return self.transport.clone('checkout')
1809
workingtree_format.get_format_string()
1810
except NotImplementedError:
1811
raise errors.IncompatibleFormat(workingtree_format, self._format)
1813
self.transport.mkdir('checkout', mode=self._get_mkdir_mode())
1814
except errors.FileExists:
1816
return self.transport.clone('checkout')
1818
def has_workingtree(self):
1819
"""Tell if this bzrdir contains a working tree.
1821
This will still raise an exception if the bzrdir has a workingtree that
1822
is remote & inaccessible.
1824
Note: if you're going to open the working tree, you should just go
1825
ahead and try, and not ask permission first.
1827
from bzrlib.workingtree import WorkingTreeFormat
1829
WorkingTreeFormat.find_format(self)
1830
except errors.NoWorkingTree:
1834
def needs_format_conversion(self, format=None):
1835
"""See BzrDir.needs_format_conversion()."""
1837
symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1838
% 'needs_format_conversion(format=None)')
1840
format = BzrDirFormat.get_default_format()
1841
if not isinstance(self._format, format.__class__):
1842
# it is not a meta dir format, conversion is needed.
1844
# we might want to push this down to the repository?
1846
if not isinstance(self.open_repository()._format,
1847
format.repository_format.__class__):
1848
# the repository needs an upgrade.
1850
except errors.NoRepositoryPresent:
1852
for branch in self.list_branches():
1853
if not isinstance(branch._format,
1854
format.get_branch_format().__class__):
1855
# the branch needs an upgrade.
1858
my_wt = self.open_workingtree(recommend_upgrade=False)
1859
if not isinstance(my_wt._format,
1860
format.workingtree_format.__class__):
1861
# the workingtree needs an upgrade.
1863
except (errors.NoWorkingTree, errors.NotLocalUrl):
1867
def open_branch(self, name=None, unsupported=False,
1868
ignore_fallbacks=False):
1869
"""See BzrDir.open_branch."""
1870
format = self.find_branch_format(name=name)
1871
self._check_supported(format, unsupported)
1872
return format.open(self, name=name,
1873
_found=True, ignore_fallbacks=ignore_fallbacks)
1875
def open_repository(self, unsupported=False):
1876
"""See BzrDir.open_repository."""
1877
from bzrlib.repository import RepositoryFormat
1878
format = RepositoryFormat.find_format(self)
1879
self._check_supported(format, unsupported)
1880
return format.open(self, _found=True)
1882
def open_workingtree(self, unsupported=False,
1883
recommend_upgrade=True):
1884
"""See BzrDir.open_workingtree."""
1885
from bzrlib.workingtree import WorkingTreeFormat
1886
format = WorkingTreeFormat.find_format(self)
1887
self._check_supported(format, unsupported,
1889
basedir=self.root_transport.base)
1890
return format.open(self, _found=True)
1892
def _get_config(self):
1893
return config.TransportConfig(self.transport, 'control.conf')
1896
class BzrDirFormat(object):
1897
"""An encapsulation of the initialization and open routines for a format.
1899
Formats provide three things:
1900
* An initialization routine,
1904
Formats are placed in a dict by their format string for reference
1905
during bzrdir opening. These should be subclasses of BzrDirFormat
1908
Once a format is deprecated, just deprecate the initialize and open
1909
methods on the format class. Do not deprecate the object, as the
1910
object will be created every system load.
1912
:cvar colocated_branches: Whether this formats supports colocated branches.
1915
_default_format = None
1916
"""The default format used for new .bzr dirs."""
1919
"""The known formats."""
1921
_control_formats = []
1922
"""The registered control formats - .bzr, ....
1924
This is a list of BzrDirFormat objects.
1927
_control_server_formats = []
1928
"""The registered control server formats, e.g. RemoteBzrDirs.
1930
This is a list of BzrDirFormat objects.
1933
_lock_file_name = 'branch-lock'
1935
colocated_branches = False
1936
"""Whether co-located branches are supported for this control dir format.
1939
# _lock_class must be set in subclasses to the lock type, typ.
1940
# TransportLock or LockDir
1943
def find_format(klass, transport, _server_formats=True):
1944
"""Return the format present at transport."""
1946
formats = klass._control_server_formats + klass._control_formats
1948
formats = klass._control_formats
1949
for format in formats:
1951
return format.probe_transport(transport)
1952
except errors.NotBranchError:
1953
# this format does not find a control dir here.
1955
raise errors.NotBranchError(path=transport.base)
1958
def probe_transport(klass, transport):
1959
"""Return the .bzrdir style format present in a directory."""
1961
format_string = transport.get_bytes(".bzr/branch-format")
1962
except errors.NoSuchFile:
1963
raise errors.NotBranchError(path=transport.base)
1965
return klass._formats[format_string]
1967
raise errors.UnknownFormatError(format=format_string, kind='bzrdir')
1970
def get_default_format(klass):
1971
"""Return the current default format."""
1972
return klass._default_format
1974
def get_format_string(self):
1975
"""Return the ASCII format string that identifies this format."""
1976
raise NotImplementedError(self.get_format_string)
1978
def get_format_description(self):
1979
"""Return the short description for this format."""
1980
raise NotImplementedError(self.get_format_description)
1982
def get_converter(self, format=None):
1983
"""Return the converter to use to convert bzrdirs needing converts.
1985
This returns a bzrlib.bzrdir.Converter object.
1987
This should return the best upgrader to step this format towards the
1988
current default format. In the case of plugins we can/should provide
1989
some means for them to extend the range of returnable converters.
1991
:param format: Optional format to override the default format of the
1994
raise NotImplementedError(self.get_converter)
1996
def initialize(self, url, possible_transports=None):
1997
"""Create a bzr control dir at this url and return an opened copy.
1999
While not deprecated, this method is very specific and its use will
2000
lead to many round trips to setup a working environment. See
2001
initialize_on_transport_ex for a [nearly] all-in-one method.
2003
Subclasses should typically override initialize_on_transport
2004
instead of this method.
2006
return self.initialize_on_transport(get_transport(url,
2007
possible_transports))
2009
def initialize_on_transport(self, transport):
2010
"""Initialize a new bzrdir in the base directory of a Transport."""
2012
# can we hand off the request to the smart server rather than using
2014
client_medium = transport.get_smart_medium()
2015
except errors.NoSmartMedium:
2016
return self._initialize_on_transport_vfs(transport)
2018
# Current RPC's only know how to create bzr metadir1 instances, so
2019
# we still delegate to vfs methods if the requested format is not a
2021
if type(self) != BzrDirMetaFormat1:
2022
return self._initialize_on_transport_vfs(transport)
2023
remote_format = RemoteBzrDirFormat()
2024
self._supply_sub_formats_to(remote_format)
2025
return remote_format.initialize_on_transport(transport)
2027
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
2028
create_prefix=False, force_new_repo=False, stacked_on=None,
2029
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
2030
shared_repo=False, vfs_only=False):
2031
"""Create this format on transport.
2033
The directory to initialize will be created.
2035
:param force_new_repo: Do not use a shared repository for the target,
2036
even if one is available.
2037
:param create_prefix: Create any missing directories leading up to
2039
:param use_existing_dir: Use an existing directory if one exists.
2040
:param stacked_on: A url to stack any created branch on, None to follow
2041
any target stacking policy.
2042
:param stack_on_pwd: If stack_on is relative, the location it is
2044
:param repo_format_name: If non-None, a repository will be
2045
made-or-found. Should none be found, or if force_new_repo is True
2046
the repo_format_name is used to select the format of repository to
2048
:param make_working_trees: Control the setting of make_working_trees
2049
for a new shared repository when one is made. None to use whatever
2050
default the format has.
2051
:param shared_repo: Control whether made repositories are shared or
2053
:param vfs_only: If True do not attempt to use a smart server
2054
:return: repo, bzrdir, require_stacking, repository_policy. repo is
2055
None if none was created or found, bzrdir is always valid.
2056
require_stacking is the result of examining the stacked_on
2057
parameter and any stacking policy found for the target.
2060
# Try to hand off to a smart server
2062
client_medium = transport.get_smart_medium()
2063
except errors.NoSmartMedium:
2066
# TODO: lookup the local format from a server hint.
2067
remote_dir_format = RemoteBzrDirFormat()
2068
remote_dir_format._network_name = self.network_name()
2069
self._supply_sub_formats_to(remote_dir_format)
2070
return remote_dir_format.initialize_on_transport_ex(transport,
2071
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2072
force_new_repo=force_new_repo, stacked_on=stacked_on,
2073
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2074
make_working_trees=make_working_trees, shared_repo=shared_repo)
2075
# XXX: Refactor the create_prefix/no_create_prefix code into a
2076
# common helper function
2077
# The destination may not exist - if so make it according to policy.
2078
def make_directory(transport):
2079
transport.mkdir('.')
2081
def redirected(transport, e, redirection_notice):
2082
note(redirection_notice)
2083
return transport._redirected_to(e.source, e.target)
2085
transport = do_catching_redirections(make_directory, transport,
2087
except errors.FileExists:
2088
if not use_existing_dir:
2090
except errors.NoSuchFile:
2091
if not create_prefix:
2093
transport.create_prefix()
2095
require_stacking = (stacked_on is not None)
2096
# Now the target directory exists, but doesn't have a .bzr
2097
# directory. So we need to create it, along with any work to create
2098
# all of the dependent branches, etc.
2100
result = self.initialize_on_transport(transport)
2101
if repo_format_name:
2103
# use a custom format
2104
result._format.repository_format = \
2105
repository.network_format_registry.get(repo_format_name)
2106
except AttributeError:
2107
# The format didn't permit it to be set.
2109
# A repository is desired, either in-place or shared.
2110
repository_policy = result.determine_repository_policy(
2111
force_new_repo, stacked_on, stack_on_pwd,
2112
require_stacking=require_stacking)
2113
result_repo, is_new_repo = repository_policy.acquire_repository(
2114
make_working_trees, shared_repo)
2115
if not require_stacking and repository_policy._require_stacking:
2116
require_stacking = True
2117
result._format.require_stacking()
2118
result_repo.lock_write()
2121
repository_policy = None
2122
return result_repo, result, require_stacking, repository_policy
2124
def _initialize_on_transport_vfs(self, transport):
2125
"""Initialize a new bzrdir using VFS calls.
2127
:param transport: The transport to create the .bzr directory in.
2130
# Since we are creating a .bzr directory, inherit the
2131
# mode from the root directory
2132
temp_control = lockable_files.LockableFiles(transport,
2133
'', lockable_files.TransportLock)
2134
temp_control._transport.mkdir('.bzr',
2135
# FIXME: RBC 20060121 don't peek under
2137
mode=temp_control._dir_mode)
2138
if sys.platform == 'win32' and isinstance(transport, local.LocalTransport):
2139
win32utils.set_file_attr_hidden(transport._abspath('.bzr'))
2140
file_mode = temp_control._file_mode
2142
bzrdir_transport = transport.clone('.bzr')
2143
utf8_files = [('README',
2144
"This is a Bazaar control directory.\n"
2145
"Do not change any files in this directory.\n"
2146
"See http://bazaar-vcs.org/ for more information about Bazaar.\n"),
2147
('branch-format', self.get_format_string()),
2149
# NB: no need to escape relative paths that are url safe.
2150
control_files = lockable_files.LockableFiles(bzrdir_transport,
2151
self._lock_file_name, self._lock_class)
2152
control_files.create_lock()
2153
control_files.lock_write()
2155
for (filename, content) in utf8_files:
2156
bzrdir_transport.put_bytes(filename, content,
2159
control_files.unlock()
2160
return self.open(transport, _found=True)
2162
def is_supported(self):
2163
"""Is this format supported?
2165
Supported formats must be initializable and openable.
2166
Unsupported formats may not support initialization or committing or
2167
some other features depending on the reason for not being supported.
2171
def network_name(self):
2172
"""A simple byte string uniquely identifying this format for RPC calls.
2174
Bzr control formats use thir disk format string to identify the format
2175
over the wire. Its possible that other control formats have more
2176
complex detection requirements, so we permit them to use any unique and
2177
immutable string they desire.
2179
raise NotImplementedError(self.network_name)
2181
def same_model(self, target_format):
2182
return (self.repository_format.rich_root_data ==
2183
target_format.rich_root_data)
2186
def known_formats(klass):
2187
"""Return all the known formats.
2189
Concrete formats should override _known_formats.
2191
# There is double indirection here to make sure that control
2192
# formats used by more than one dir format will only be probed
2193
# once. This can otherwise be quite expensive for remote connections.
2195
for format in klass._control_formats:
2196
result.update(format._known_formats())
2200
def _known_formats(klass):
2201
"""Return the known format instances for this control format."""
2202
return set(klass._formats.values())
2204
def open(self, transport, _found=False):
2205
"""Return an instance of this format for the dir transport points at.
2207
_found is a private parameter, do not use it.
2210
found_format = BzrDirFormat.find_format(transport)
2211
if not isinstance(found_format, self.__class__):
2212
raise AssertionError("%s was asked to open %s, but it seems to need "
2214
% (self, transport, found_format))
2215
# Allow subclasses - use the found format.
2216
self._supply_sub_formats_to(found_format)
2217
return found_format._open(transport)
2218
return self._open(transport)
2220
def _open(self, transport):
2221
"""Template method helper for opening BzrDirectories.
2223
This performs the actual open and any additional logic or parameter
2226
raise NotImplementedError(self._open)
2229
def register_format(klass, format):
2230
klass._formats[format.get_format_string()] = format
2231
# bzr native formats have a network name of their format string.
2232
network_format_registry.register(format.get_format_string(), format.__class__)
2235
def register_control_format(klass, format):
2236
"""Register a format that does not use '.bzr' for its control dir.
2238
TODO: This should be pulled up into a 'ControlDirFormat' base class
2239
which BzrDirFormat can inherit from, and renamed to register_format
2240
there. It has been done without that for now for simplicity of
2243
klass._control_formats.append(format)
2246
def register_control_server_format(klass, format):
2247
"""Register a control format for client-server environments.
2249
These formats will be tried before ones registered with
2250
register_control_format. This gives implementations that decide to the
2251
chance to grab it before anything looks at the contents of the format
2254
klass._control_server_formats.append(format)
2257
def _set_default_format(klass, format):
2258
"""Set default format (for testing behavior of defaults only)"""
2259
klass._default_format = format
2263
return self.get_format_description().rstrip()
2265
def _supply_sub_formats_to(self, other_format):
2266
"""Give other_format the same values for sub formats as this has.
2268
This method is expected to be used when parameterising a
2269
RemoteBzrDirFormat instance with the parameters from a
2270
BzrDirMetaFormat1 instance.
2272
:param other_format: other_format is a format which should be
2273
compatible with whatever sub formats are supported by self.
2278
def unregister_format(klass, format):
2279
del klass._formats[format.get_format_string()]
2282
def unregister_control_format(klass, format):
2283
klass._control_formats.remove(format)
2286
class BzrDirFormat4(BzrDirFormat):
2287
"""Bzr dir format 4.
2289
This format is a combined format for working tree, branch and repository.
2291
- Format 1 working trees [always]
2292
- Format 4 branches [always]
2293
- Format 4 repositories [always]
2295
This format is deprecated: it indexes texts using a text it which is
2296
removed in format 5; write support for this format has been removed.
2299
_lock_class = lockable_files.TransportLock
2301
def get_format_string(self):
2302
"""See BzrDirFormat.get_format_string()."""
2303
return "Bazaar-NG branch, format 0.0.4\n"
2305
def get_format_description(self):
2306
"""See BzrDirFormat.get_format_description()."""
2307
return "All-in-one format 4"
2309
def get_converter(self, format=None):
2310
"""See BzrDirFormat.get_converter()."""
2311
# there is one and only one upgrade path here.
2312
return ConvertBzrDir4To5()
2314
def initialize_on_transport(self, transport):
2315
"""Format 4 branches cannot be created."""
2316
raise errors.UninitializableFormat(self)
2318
def is_supported(self):
2319
"""Format 4 is not supported.
2321
It is not supported because the model changed from 4 to 5 and the
2322
conversion logic is expensive - so doing it on the fly was not
2327
def network_name(self):
2328
return self.get_format_string()
2330
def _open(self, transport):
2331
"""See BzrDirFormat._open."""
2332
return BzrDir4(transport, self)
2334
def __return_repository_format(self):
2335
"""Circular import protection."""
2336
from bzrlib.repofmt.weaverepo import RepositoryFormat4
2337
return RepositoryFormat4()
2338
repository_format = property(__return_repository_format)
2341
class BzrDirFormatAllInOne(BzrDirFormat):
2342
"""Common class for formats before meta-dirs."""
2344
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
2345
create_prefix=False, force_new_repo=False, stacked_on=None,
2346
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
2348
"""See BzrDirFormat.initialize_on_transport_ex."""
2349
require_stacking = (stacked_on is not None)
2350
# Format 5 cannot stack, but we've been asked to - actually init
2352
if require_stacking:
2353
format = BzrDirMetaFormat1()
2354
return format.initialize_on_transport_ex(transport,
2355
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2356
force_new_repo=force_new_repo, stacked_on=stacked_on,
2357
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2358
make_working_trees=make_working_trees, shared_repo=shared_repo)
2359
return BzrDirFormat.initialize_on_transport_ex(self, transport,
2360
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2361
force_new_repo=force_new_repo, stacked_on=stacked_on,
2362
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2363
make_working_trees=make_working_trees, shared_repo=shared_repo)
2366
class BzrDirFormat5(BzrDirFormatAllInOne):
2367
"""Bzr control format 5.
2369
This format is a combined format for working tree, branch and repository.
2371
- Format 2 working trees [always]
2372
- Format 4 branches [always]
2373
- Format 5 repositories [always]
2374
Unhashed stores in the repository.
2377
_lock_class = lockable_files.TransportLock
2379
def get_format_string(self):
2380
"""See BzrDirFormat.get_format_string()."""
2381
return "Bazaar-NG branch, format 5\n"
2383
def get_branch_format(self):
2384
from bzrlib import branch
2385
return branch.BzrBranchFormat4()
2387
def get_format_description(self):
2388
"""See BzrDirFormat.get_format_description()."""
2389
return "All-in-one format 5"
2391
def get_converter(self, format=None):
2392
"""See BzrDirFormat.get_converter()."""
2393
# there is one and only one upgrade path here.
2394
return ConvertBzrDir5To6()
2396
def _initialize_for_clone(self, url):
2397
return self.initialize_on_transport(get_transport(url), _cloning=True)
2399
def initialize_on_transport(self, transport, _cloning=False):
2400
"""Format 5 dirs always have working tree, branch and repository.
2402
Except when they are being cloned.
2404
from bzrlib.branch import BzrBranchFormat4
2405
from bzrlib.repofmt.weaverepo import RepositoryFormat5
2406
result = (super(BzrDirFormat5, self).initialize_on_transport(transport))
2407
RepositoryFormat5().initialize(result, _internal=True)
2409
branch = BzrBranchFormat4().initialize(result)
2410
result._init_workingtree()
2413
def network_name(self):
2414
return self.get_format_string()
2416
def _open(self, transport):
2417
"""See BzrDirFormat._open."""
2418
return BzrDir5(transport, self)
2420
def __return_repository_format(self):
2421
"""Circular import protection."""
2422
from bzrlib.repofmt.weaverepo import RepositoryFormat5
2423
return RepositoryFormat5()
2424
repository_format = property(__return_repository_format)
2427
class BzrDirFormat6(BzrDirFormatAllInOne):
2428
"""Bzr control format 6.
2430
This format is a combined format for working tree, branch and repository.
2432
- Format 2 working trees [always]
2433
- Format 4 branches [always]
2434
- Format 6 repositories [always]
2437
_lock_class = lockable_files.TransportLock
2439
def get_format_string(self):
2440
"""See BzrDirFormat.get_format_string()."""
2441
return "Bazaar-NG branch, format 6\n"
2443
def get_format_description(self):
2444
"""See BzrDirFormat.get_format_description()."""
2445
return "All-in-one format 6"
2447
def get_branch_format(self):
2448
from bzrlib import branch
2449
return branch.BzrBranchFormat4()
2451
def get_converter(self, format=None):
2452
"""See BzrDirFormat.get_converter()."""
2453
# there is one and only one upgrade path here.
2454
return ConvertBzrDir6ToMeta()
2456
def _initialize_for_clone(self, url):
2457
return self.initialize_on_transport(get_transport(url), _cloning=True)
2459
def initialize_on_transport(self, transport, _cloning=False):
2460
"""Format 6 dirs always have working tree, branch and repository.
2462
Except when they are being cloned.
2464
from bzrlib.branch import BzrBranchFormat4
2465
from bzrlib.repofmt.weaverepo import RepositoryFormat6
2466
result = super(BzrDirFormat6, self).initialize_on_transport(transport)
2467
RepositoryFormat6().initialize(result, _internal=True)
2469
branch = BzrBranchFormat4().initialize(result)
2470
result._init_workingtree()
2473
def network_name(self):
2474
return self.get_format_string()
2476
def _open(self, transport):
2477
"""See BzrDirFormat._open."""
2478
return BzrDir6(transport, self)
2480
def __return_repository_format(self):
2481
"""Circular import protection."""
2482
from bzrlib.repofmt.weaverepo import RepositoryFormat6
2483
return RepositoryFormat6()
2484
repository_format = property(__return_repository_format)
2487
class BzrDirMetaFormat1(BzrDirFormat):
2488
"""Bzr meta control format 1
2490
This is the first format with split out working tree, branch and repository
2493
- Format 3 working trees [optional]
2494
- Format 5 branches [optional]
2495
- Format 7 repositories [optional]
2498
_lock_class = lockdir.LockDir
2501
self._workingtree_format = None
2502
self._branch_format = None
2503
self._repository_format = None
2505
def __eq__(self, other):
2506
if other.__class__ is not self.__class__:
2508
if other.repository_format != self.repository_format:
2510
if other.workingtree_format != self.workingtree_format:
2514
def __ne__(self, other):
2515
return not self == other
2517
def get_branch_format(self):
2518
if self._branch_format is None:
2519
from bzrlib.branch import BranchFormat
2520
self._branch_format = BranchFormat.get_default_format()
2521
return self._branch_format
2523
def set_branch_format(self, format):
2524
self._branch_format = format
2526
def require_stacking(self, stack_on=None, possible_transports=None,
2528
"""We have a request to stack, try to ensure the formats support it.
2530
:param stack_on: If supplied, it is the URL to a branch that we want to
2531
stack on. Check to see if that format supports stacking before
2534
# Stacking is desired. requested by the target, but does the place it
2535
# points at support stacking? If it doesn't then we should
2536
# not implicitly upgrade. We check this here.
2537
new_repo_format = None
2538
new_branch_format = None
2540
# a bit of state for get_target_branch so that we don't try to open it
2541
# 2 times, for both repo *and* branch
2542
target = [None, False, None] # target_branch, checked, upgrade anyway
2543
def get_target_branch():
2545
# We've checked, don't check again
2547
if stack_on is None:
2548
# No target format, that means we want to force upgrading
2549
target[:] = [None, True, True]
2552
target_dir = BzrDir.open(stack_on,
2553
possible_transports=possible_transports)
2554
except errors.NotBranchError:
2555
# Nothing there, don't change formats
2556
target[:] = [None, True, False]
2558
except errors.JailBreak:
2559
# JailBreak, JFDI and upgrade anyway
2560
target[:] = [None, True, True]
2563
target_branch = target_dir.open_branch()
2564
except errors.NotBranchError:
2565
# No branch, don't upgrade formats
2566
target[:] = [None, True, False]
2568
target[:] = [target_branch, True, False]
2571
if (not _skip_repo and
2572
not self.repository_format.supports_external_lookups):
2573
# We need to upgrade the Repository.
2574
target_branch, _, do_upgrade = get_target_branch()
2575
if target_branch is None:
2576
# We don't have a target branch, should we upgrade anyway?
2578
# stack_on is inaccessible, JFDI.
2579
# TODO: bad monkey, hard-coded formats...
2580
if self.repository_format.rich_root_data:
2581
new_repo_format = pack_repo.RepositoryFormatKnitPack5RichRoot()
2583
new_repo_format = pack_repo.RepositoryFormatKnitPack5()
2585
# If the target already supports stacking, then we know the
2586
# project is already able to use stacking, so auto-upgrade
2588
new_repo_format = target_branch.repository._format
2589
if not new_repo_format.supports_external_lookups:
2590
# target doesn't, source doesn't, so don't auto upgrade
2592
new_repo_format = None
2593
if new_repo_format is not None:
2594
self.repository_format = new_repo_format
2595
note('Source repository format does not support stacking,'
2596
' using format:\n %s',
2597
new_repo_format.get_format_description())
2599
if not self.get_branch_format().supports_stacking():
2600
# We just checked the repo, now lets check if we need to
2601
# upgrade the branch format
2602
target_branch, _, do_upgrade = get_target_branch()
2603
if target_branch is None:
2605
# TODO: bad monkey, hard-coded formats...
2606
new_branch_format = branch.BzrBranchFormat7()
2608
new_branch_format = target_branch._format
2609
if not new_branch_format.supports_stacking():
2610
new_branch_format = None
2611
if new_branch_format is not None:
2612
# Does support stacking, use its format.
2613
self.set_branch_format(new_branch_format)
2614
note('Source branch format does not support stacking,'
2615
' using format:\n %s',
2616
new_branch_format.get_format_description())
2618
def get_converter(self, format=None):
2619
"""See BzrDirFormat.get_converter()."""
2621
format = BzrDirFormat.get_default_format()
2622
if not isinstance(self, format.__class__):
2623
# converting away from metadir is not implemented
2624
raise NotImplementedError(self.get_converter)
2625
return ConvertMetaToMeta(format)
2627
def get_format_string(self):
2628
"""See BzrDirFormat.get_format_string()."""
2629
return "Bazaar-NG meta directory, format 1\n"
2631
def get_format_description(self):
2632
"""See BzrDirFormat.get_format_description()."""
2633
return "Meta directory format 1"
2635
def network_name(self):
2636
return self.get_format_string()
2638
def _open(self, transport):
2639
"""See BzrDirFormat._open."""
2640
# Create a new format instance because otherwise initialisation of new
2641
# metadirs share the global default format object leading to alias
2643
format = BzrDirMetaFormat1()
2644
self._supply_sub_formats_to(format)
2645
return BzrDirMeta1(transport, format)
2647
def __return_repository_format(self):
2648
"""Circular import protection."""
2649
if self._repository_format:
2650
return self._repository_format
2651
from bzrlib.repository import RepositoryFormat
2652
return RepositoryFormat.get_default_format()
2654
def _set_repository_format(self, value):
2655
"""Allow changing the repository format for metadir formats."""
2656
self._repository_format = value
2658
repository_format = property(__return_repository_format,
2659
_set_repository_format)
2661
def _supply_sub_formats_to(self, other_format):
2662
"""Give other_format the same values for sub formats as this has.
2664
This method is expected to be used when parameterising a
2665
RemoteBzrDirFormat instance with the parameters from a
2666
BzrDirMetaFormat1 instance.
2668
:param other_format: other_format is a format which should be
2669
compatible with whatever sub formats are supported by self.
2672
if getattr(self, '_repository_format', None) is not None:
2673
other_format.repository_format = self.repository_format
2674
if self._branch_format is not None:
2675
other_format._branch_format = self._branch_format
2676
if self._workingtree_format is not None:
2677
other_format.workingtree_format = self.workingtree_format
2679
def __get_workingtree_format(self):
2680
if self._workingtree_format is None:
2681
from bzrlib.workingtree import WorkingTreeFormat
2682
self._workingtree_format = WorkingTreeFormat.get_default_format()
2683
return self._workingtree_format
2685
def __set_workingtree_format(self, wt_format):
2686
self._workingtree_format = wt_format
2688
workingtree_format = property(__get_workingtree_format,
2689
__set_workingtree_format)
2692
network_format_registry = registry.FormatRegistry()
2693
"""Registry of formats indexed by their network name.
2695
The network name for a BzrDirFormat is an identifier that can be used when
2696
referring to formats with smart server operations. See
2697
BzrDirFormat.network_name() for more detail.
2701
# Register bzr control format
2702
BzrDirFormat.register_control_format(BzrDirFormat)
2704
# Register bzr formats
2705
BzrDirFormat.register_format(BzrDirFormat4())
2706
BzrDirFormat.register_format(BzrDirFormat5())
2707
BzrDirFormat.register_format(BzrDirFormat6())
2708
__default_format = BzrDirMetaFormat1()
2709
BzrDirFormat.register_format(__default_format)
2710
BzrDirFormat._default_format = __default_format
2713
class Converter(object):
2714
"""Converts a disk format object from one format to another."""
2716
def convert(self, to_convert, pb):
2717
"""Perform the conversion of to_convert, giving feedback via pb.
2719
:param to_convert: The disk object to convert.
2720
:param pb: a progress bar to use for progress information.
2723
def step(self, message):
2724
"""Update the pb by a step."""
2726
self.pb.update(message, self.count, self.total)
2729
class ConvertBzrDir4To5(Converter):
2730
"""Converts format 4 bzr dirs to format 5."""
2733
super(ConvertBzrDir4To5, self).__init__()
2734
self.converted_revs = set()
2735
self.absent_revisions = set()
2739
def convert(self, to_convert, pb):
2740
"""See Converter.convert()."""
2741
self.bzrdir = to_convert
2743
warnings.warn("pb parameter to convert() is deprecated")
2744
self.pb = ui.ui_factory.nested_progress_bar()
2746
ui.ui_factory.note('starting upgrade from format 4 to 5')
2747
if isinstance(self.bzrdir.transport, local.LocalTransport):
2748
self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
2749
self._convert_to_weaves()
2750
return BzrDir.open(self.bzrdir.user_url)
2754
def _convert_to_weaves(self):
2755
ui.ui_factory.note('note: upgrade may be faster if all store files are ungzipped first')
2758
stat = self.bzrdir.transport.stat('weaves')
2759
if not S_ISDIR(stat.st_mode):
2760
self.bzrdir.transport.delete('weaves')
2761
self.bzrdir.transport.mkdir('weaves')
2762
except errors.NoSuchFile:
2763
self.bzrdir.transport.mkdir('weaves')
2764
# deliberately not a WeaveFile as we want to build it up slowly.
2765
self.inv_weave = Weave('inventory')
2766
# holds in-memory weaves for all files
2767
self.text_weaves = {}
2768
self.bzrdir.transport.delete('branch-format')
2769
self.branch = self.bzrdir.open_branch()
2770
self._convert_working_inv()
2771
rev_history = self.branch.revision_history()
2772
# to_read is a stack holding the revisions we still need to process;
2773
# appending to it adds new highest-priority revisions
2774
self.known_revisions = set(rev_history)
2775
self.to_read = rev_history[-1:]
2777
rev_id = self.to_read.pop()
2778
if (rev_id not in self.revisions
2779
and rev_id not in self.absent_revisions):
2780
self._load_one_rev(rev_id)
2782
to_import = self._make_order()
2783
for i, rev_id in enumerate(to_import):
2784
self.pb.update('converting revision', i, len(to_import))
2785
self._convert_one_rev(rev_id)
2787
self._write_all_weaves()
2788
self._write_all_revs()
2789
ui.ui_factory.note('upgraded to weaves:')
2790
ui.ui_factory.note(' %6d revisions and inventories' % len(self.revisions))
2791
ui.ui_factory.note(' %6d revisions not present' % len(self.absent_revisions))
2792
ui.ui_factory.note(' %6d texts' % self.text_count)
2793
self._cleanup_spare_files_after_format4()
2794
self.branch._transport.put_bytes(
2796
BzrDirFormat5().get_format_string(),
2797
mode=self.bzrdir._get_file_mode())
2799
def _cleanup_spare_files_after_format4(self):
2800
# FIXME working tree upgrade foo.
2801
for n in 'merged-patches', 'pending-merged-patches':
2803
## assert os.path.getsize(p) == 0
2804
self.bzrdir.transport.delete(n)
2805
except errors.NoSuchFile:
2807
self.bzrdir.transport.delete_tree('inventory-store')
2808
self.bzrdir.transport.delete_tree('text-store')
2810
def _convert_working_inv(self):
2811
inv = xml4.serializer_v4.read_inventory(
2812
self.branch._transport.get('inventory'))
2813
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv, working=True)
2814
self.branch._transport.put_bytes('inventory', new_inv_xml,
2815
mode=self.bzrdir._get_file_mode())
2817
def _write_all_weaves(self):
2818
controlweaves = WeaveStore(self.bzrdir.transport, prefixed=False)
2819
weave_transport = self.bzrdir.transport.clone('weaves')
2820
weaves = WeaveStore(weave_transport, prefixed=False)
2821
transaction = WriteTransaction()
2825
for file_id, file_weave in self.text_weaves.items():
2826
self.pb.update('writing weave', i, len(self.text_weaves))
2827
weaves._put_weave(file_id, file_weave, transaction)
2829
self.pb.update('inventory', 0, 1)
2830
controlweaves._put_weave('inventory', self.inv_weave, transaction)
2831
self.pb.update('inventory', 1, 1)
2835
def _write_all_revs(self):
2836
"""Write all revisions out in new form."""
2837
self.bzrdir.transport.delete_tree('revision-store')
2838
self.bzrdir.transport.mkdir('revision-store')
2839
revision_transport = self.bzrdir.transport.clone('revision-store')
2841
from bzrlib.xml5 import serializer_v5
2842
from bzrlib.repofmt.weaverepo import RevisionTextStore
2843
revision_store = RevisionTextStore(revision_transport,
2844
serializer_v5, False, versionedfile.PrefixMapper(),
2845
lambda:True, lambda:True)
2847
for i, rev_id in enumerate(self.converted_revs):
2848
self.pb.update('write revision', i, len(self.converted_revs))
2849
text = serializer_v5.write_revision_to_string(
2850
self.revisions[rev_id])
2852
revision_store.add_lines(key, None, osutils.split_lines(text))
2856
def _load_one_rev(self, rev_id):
2857
"""Load a revision object into memory.
2859
Any parents not either loaded or abandoned get queued to be
2861
self.pb.update('loading revision',
2862
len(self.revisions),
2863
len(self.known_revisions))
2864
if not self.branch.repository.has_revision(rev_id):
2866
ui.ui_factory.note('revision {%s} not present in branch; '
2867
'will be converted as a ghost' %
2869
self.absent_revisions.add(rev_id)
2871
rev = self.branch.repository.get_revision(rev_id)
2872
for parent_id in rev.parent_ids:
2873
self.known_revisions.add(parent_id)
2874
self.to_read.append(parent_id)
2875
self.revisions[rev_id] = rev
2877
def _load_old_inventory(self, rev_id):
2878
f = self.branch.repository.inventory_store.get(rev_id)
2880
old_inv_xml = f.read()
2883
inv = xml4.serializer_v4.read_inventory_from_string(old_inv_xml)
2884
inv.revision_id = rev_id
2885
rev = self.revisions[rev_id]
2888
def _load_updated_inventory(self, rev_id):
2889
inv_xml = self.inv_weave.get_text(rev_id)
2890
inv = xml5.serializer_v5.read_inventory_from_string(inv_xml, rev_id)
2893
def _convert_one_rev(self, rev_id):
2894
"""Convert revision and all referenced objects to new format."""
2895
rev = self.revisions[rev_id]
2896
inv = self._load_old_inventory(rev_id)
2897
present_parents = [p for p in rev.parent_ids
2898
if p not in self.absent_revisions]
2899
self._convert_revision_contents(rev, inv, present_parents)
2900
self._store_new_inv(rev, inv, present_parents)
2901
self.converted_revs.add(rev_id)
2903
def _store_new_inv(self, rev, inv, present_parents):
2904
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
2905
new_inv_sha1 = sha_string(new_inv_xml)
2906
self.inv_weave.add_lines(rev.revision_id,
2908
new_inv_xml.splitlines(True))
2909
rev.inventory_sha1 = new_inv_sha1
2911
def _convert_revision_contents(self, rev, inv, present_parents):
2912
"""Convert all the files within a revision.
2914
Also upgrade the inventory to refer to the text revision ids."""
2915
rev_id = rev.revision_id
2916
mutter('converting texts of revision {%s}',
2918
parent_invs = map(self._load_updated_inventory, present_parents)
2919
entries = inv.iter_entries()
2921
for path, ie in entries:
2922
self._convert_file_version(rev, ie, parent_invs)
2924
def _convert_file_version(self, rev, ie, parent_invs):
2925
"""Convert one version of one file.
2927
The file needs to be added into the weave if it is a merge
2928
of >=2 parents or if it's changed from its parent.
2930
file_id = ie.file_id
2931
rev_id = rev.revision_id
2932
w = self.text_weaves.get(file_id)
2935
self.text_weaves[file_id] = w
2936
text_changed = False
2937
parent_candiate_entries = ie.parent_candidates(parent_invs)
2938
heads = graph.Graph(self).heads(parent_candiate_entries.keys())
2939
# XXX: Note that this is unordered - and this is tolerable because
2940
# the previous code was also unordered.
2941
previous_entries = dict((head, parent_candiate_entries[head]) for head
2943
self.snapshot_ie(previous_entries, ie, w, rev_id)
2945
def get_parent_map(self, revision_ids):
2946
"""See graph.StackedParentsProvider.get_parent_map"""
2947
return dict((revision_id, self.revisions[revision_id])
2948
for revision_id in revision_ids
2949
if revision_id in self.revisions)
2951
def snapshot_ie(self, previous_revisions, ie, w, rev_id):
2952
# TODO: convert this logic, which is ~= snapshot to
2953
# a call to:. This needs the path figured out. rather than a work_tree
2954
# a v4 revision_tree can be given, or something that looks enough like
2955
# one to give the file content to the entry if it needs it.
2956
# and we need something that looks like a weave store for snapshot to
2958
#ie.snapshot(rev, PATH, previous_revisions, REVISION_TREE, InMemoryWeaveStore(self.text_weaves))
2959
if len(previous_revisions) == 1:
2960
previous_ie = previous_revisions.values()[0]
2961
if ie._unchanged(previous_ie):
2962
ie.revision = previous_ie.revision
2965
f = self.branch.repository._text_store.get(ie.text_id)
2967
file_lines = f.readlines()
2970
w.add_lines(rev_id, previous_revisions, file_lines)
2971
self.text_count += 1
2973
w.add_lines(rev_id, previous_revisions, [])
2974
ie.revision = rev_id
2976
def _make_order(self):
2977
"""Return a suitable order for importing revisions.
2979
The order must be such that an revision is imported after all
2980
its (present) parents.
2982
todo = set(self.revisions.keys())
2983
done = self.absent_revisions.copy()
2986
# scan through looking for a revision whose parents
2988
for rev_id in sorted(list(todo)):
2989
rev = self.revisions[rev_id]
2990
parent_ids = set(rev.parent_ids)
2991
if parent_ids.issubset(done):
2992
# can take this one now
2993
order.append(rev_id)
2999
class ConvertBzrDir5To6(Converter):
3000
"""Converts format 5 bzr dirs to format 6."""
3002
def convert(self, to_convert, pb):
3003
"""See Converter.convert()."""
3004
self.bzrdir = to_convert
3005
pb = ui.ui_factory.nested_progress_bar()
3007
ui.ui_factory.note('starting upgrade from format 5 to 6')
3008
self._convert_to_prefixed()
3009
return BzrDir.open(self.bzrdir.user_url)
3013
def _convert_to_prefixed(self):
3014
from bzrlib.store import TransportStore
3015
self.bzrdir.transport.delete('branch-format')
3016
for store_name in ["weaves", "revision-store"]:
3017
ui.ui_factory.note("adding prefixes to %s" % store_name)
3018
store_transport = self.bzrdir.transport.clone(store_name)
3019
store = TransportStore(store_transport, prefixed=True)
3020
for urlfilename in store_transport.list_dir('.'):
3021
filename = urlutils.unescape(urlfilename)
3022
if (filename.endswith(".weave") or
3023
filename.endswith(".gz") or
3024
filename.endswith(".sig")):
3025
file_id, suffix = os.path.splitext(filename)
3029
new_name = store._mapper.map((file_id,)) + suffix
3030
# FIXME keep track of the dirs made RBC 20060121
3032
store_transport.move(filename, new_name)
3033
except errors.NoSuchFile: # catches missing dirs strangely enough
3034
store_transport.mkdir(osutils.dirname(new_name))
3035
store_transport.move(filename, new_name)
3036
self.bzrdir.transport.put_bytes(
3038
BzrDirFormat6().get_format_string(),
3039
mode=self.bzrdir._get_file_mode())
3042
class ConvertBzrDir6ToMeta(Converter):
3043
"""Converts format 6 bzr dirs to metadirs."""
3045
def convert(self, to_convert, pb):
3046
"""See Converter.convert()."""
3047
from bzrlib.repofmt.weaverepo import RepositoryFormat7
3048
from bzrlib.branch import BzrBranchFormat5
3049
self.bzrdir = to_convert
3050
self.pb = ui.ui_factory.nested_progress_bar()
3052
self.total = 20 # the steps we know about
3053
self.garbage_inventories = []
3054
self.dir_mode = self.bzrdir._get_dir_mode()
3055
self.file_mode = self.bzrdir._get_file_mode()
3057
ui.ui_factory.note('starting upgrade from format 6 to metadir')
3058
self.bzrdir.transport.put_bytes(
3060
"Converting to format 6",
3061
mode=self.file_mode)
3062
# its faster to move specific files around than to open and use the apis...
3063
# first off, nuke ancestry.weave, it was never used.
3065
self.step('Removing ancestry.weave')
3066
self.bzrdir.transport.delete('ancestry.weave')
3067
except errors.NoSuchFile:
3069
# find out whats there
3070
self.step('Finding branch files')
3071
last_revision = self.bzrdir.open_branch().last_revision()
3072
bzrcontents = self.bzrdir.transport.list_dir('.')
3073
for name in bzrcontents:
3074
if name.startswith('basis-inventory.'):
3075
self.garbage_inventories.append(name)
3076
# create new directories for repository, working tree and branch
3077
repository_names = [('inventory.weave', True),
3078
('revision-store', True),
3080
self.step('Upgrading repository ')
3081
self.bzrdir.transport.mkdir('repository', mode=self.dir_mode)
3082
self.make_lock('repository')
3083
# we hard code the formats here because we are converting into
3084
# the meta format. The meta format upgrader can take this to a
3085
# future format within each component.
3086
self.put_format('repository', RepositoryFormat7())
3087
for entry in repository_names:
3088
self.move_entry('repository', entry)
3090
self.step('Upgrading branch ')
3091
self.bzrdir.transport.mkdir('branch', mode=self.dir_mode)
3092
self.make_lock('branch')
3093
self.put_format('branch', BzrBranchFormat5())
3094
branch_files = [('revision-history', True),
3095
('branch-name', True),
3097
for entry in branch_files:
3098
self.move_entry('branch', entry)
3100
checkout_files = [('pending-merges', True),
3101
('inventory', True),
3102
('stat-cache', False)]
3103
# If a mandatory checkout file is not present, the branch does not have
3104
# a functional checkout. Do not create a checkout in the converted
3106
for name, mandatory in checkout_files:
3107
if mandatory and name not in bzrcontents:
3108
has_checkout = False
3112
if not has_checkout:
3113
ui.ui_factory.note('No working tree.')
3114
# If some checkout files are there, we may as well get rid of them.
3115
for name, mandatory in checkout_files:
3116
if name in bzrcontents:
3117
self.bzrdir.transport.delete(name)
3119
from bzrlib.workingtree import WorkingTreeFormat3
3120
self.step('Upgrading working tree')
3121
self.bzrdir.transport.mkdir('checkout', mode=self.dir_mode)
3122
self.make_lock('checkout')
3124
'checkout', WorkingTreeFormat3())
3125
self.bzrdir.transport.delete_multi(
3126
self.garbage_inventories, self.pb)
3127
for entry in checkout_files:
3128
self.move_entry('checkout', entry)
3129
if last_revision is not None:
3130
self.bzrdir.transport.put_bytes(
3131
'checkout/last-revision', last_revision)
3132
self.bzrdir.transport.put_bytes(
3134
BzrDirMetaFormat1().get_format_string(),
3135
mode=self.file_mode)
3137
return BzrDir.open(self.bzrdir.user_url)
3139
def make_lock(self, name):
3140
"""Make a lock for the new control dir name."""
3141
self.step('Make %s lock' % name)
3142
ld = lockdir.LockDir(self.bzrdir.transport,
3144
file_modebits=self.file_mode,
3145
dir_modebits=self.dir_mode)
3148
def move_entry(self, new_dir, entry):
3149
"""Move then entry name into new_dir."""
3151
mandatory = entry[1]
3152
self.step('Moving %s' % name)
3154
self.bzrdir.transport.move(name, '%s/%s' % (new_dir, name))
3155
except errors.NoSuchFile:
3159
def put_format(self, dirname, format):
3160
self.bzrdir.transport.put_bytes('%s/format' % dirname,
3161
format.get_format_string(),
3165
class ConvertMetaToMeta(Converter):
3166
"""Converts the components of metadirs."""
3168
def __init__(self, target_format):
3169
"""Create a metadir to metadir converter.
3171
:param target_format: The final metadir format that is desired.
3173
self.target_format = target_format
3175
def convert(self, to_convert, pb):
3176
"""See Converter.convert()."""
3177
self.bzrdir = to_convert
3178
self.pb = ui.ui_factory.nested_progress_bar()
3181
self.step('checking repository format')
3183
repo = self.bzrdir.open_repository()
3184
except errors.NoRepositoryPresent:
3187
if not isinstance(repo._format, self.target_format.repository_format.__class__):
3188
from bzrlib.repository import CopyConverter
3189
ui.ui_factory.note('starting repository conversion')
3190
converter = CopyConverter(self.target_format.repository_format)
3191
converter.convert(repo, pb)
3192
for branch in self.bzrdir.list_branches():
3193
# TODO: conversions of Branch and Tree should be done by
3194
# InterXFormat lookups/some sort of registry.
3195
# Avoid circular imports
3196
from bzrlib import branch as _mod_branch
3197
old = branch._format.__class__
3198
new = self.target_format.get_branch_format().__class__
3200
if (old == _mod_branch.BzrBranchFormat5 and
3201
new in (_mod_branch.BzrBranchFormat6,
3202
_mod_branch.BzrBranchFormat7,
3203
_mod_branch.BzrBranchFormat8)):
3204
branch_converter = _mod_branch.Converter5to6()
3205
elif (old == _mod_branch.BzrBranchFormat6 and
3206
new in (_mod_branch.BzrBranchFormat7,
3207
_mod_branch.BzrBranchFormat8)):
3208
branch_converter = _mod_branch.Converter6to7()
3209
elif (old == _mod_branch.BzrBranchFormat7 and
3210
new is _mod_branch.BzrBranchFormat8):
3211
branch_converter = _mod_branch.Converter7to8()
3213
raise errors.BadConversionTarget("No converter", new,
3215
branch_converter.convert(branch)
3216
branch = self.bzrdir.open_branch()
3217
old = branch._format.__class__
3219
tree = self.bzrdir.open_workingtree(recommend_upgrade=False)
3220
except (errors.NoWorkingTree, errors.NotLocalUrl):
3223
# TODO: conversions of Branch and Tree should be done by
3224
# InterXFormat lookups
3225
if (isinstance(tree, workingtree.WorkingTree3) and
3226
not isinstance(tree, workingtree_4.DirStateWorkingTree) and
3227
isinstance(self.target_format.workingtree_format,
3228
workingtree_4.DirStateWorkingTreeFormat)):
3229
workingtree_4.Converter3to4().convert(tree)
3230
if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
3231
not isinstance(tree, workingtree_4.WorkingTree5) and
3232
isinstance(self.target_format.workingtree_format,
3233
workingtree_4.WorkingTreeFormat5)):
3234
workingtree_4.Converter4to5().convert(tree)
3235
if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
3236
not isinstance(tree, workingtree_4.WorkingTree6) and
3237
isinstance(self.target_format.workingtree_format,
3238
workingtree_4.WorkingTreeFormat6)):
3239
workingtree_4.Converter4or5to6().convert(tree)
3244
# This is not in remote.py because it's relatively small, and needs to be
3245
# registered. Putting it in remote.py creates a circular import problem.
3246
# we can make it a lazy object if the control formats is turned into something
3248
class RemoteBzrDirFormat(BzrDirMetaFormat1):
3249
"""Format representing bzrdirs accessed via a smart server"""
3252
BzrDirMetaFormat1.__init__(self)
3253
# XXX: It's a bit ugly that the network name is here, because we'd
3254
# like to believe that format objects are stateless or at least
3255
# immutable, However, we do at least avoid mutating the name after
3256
# it's returned. See <https://bugs.launchpad.net/bzr/+bug/504102>
3257
self._network_name = None
3260
return "%s(_network_name=%r)" % (self.__class__.__name__,
3263
def get_format_description(self):
3264
if self._network_name:
3265
real_format = network_format_registry.get(self._network_name)
3266
return 'Remote: ' + real_format.get_format_description()
3267
return 'bzr remote bzrdir'
3269
def get_format_string(self):
3270
raise NotImplementedError(self.get_format_string)
3272
def network_name(self):
3273
if self._network_name:
3274
return self._network_name
3276
raise AssertionError("No network name set.")
3279
def probe_transport(klass, transport):
3280
"""Return a RemoteBzrDirFormat object if it looks possible."""
3282
medium = transport.get_smart_medium()
3283
except (NotImplementedError, AttributeError,
3284
errors.TransportNotPossible, errors.NoSmartMedium,
3285
errors.SmartProtocolError):
3286
# no smart server, so not a branch for this format type.
3287
raise errors.NotBranchError(path=transport.base)
3289
# Decline to open it if the server doesn't support our required
3290
# version (3) so that the VFS-based transport will do it.
3291
if medium.should_probe():
3293
server_version = medium.protocol_version()
3294
except errors.SmartProtocolError:
3295
# Apparently there's no usable smart server there, even though
3296
# the medium supports the smart protocol.
3297
raise errors.NotBranchError(path=transport.base)
3298
if server_version != '2':
3299
raise errors.NotBranchError(path=transport.base)
3302
def initialize_on_transport(self, transport):
3304
# hand off the request to the smart server
3305
client_medium = transport.get_smart_medium()
3306
except errors.NoSmartMedium:
3307
# TODO: lookup the local format from a server hint.
3308
local_dir_format = BzrDirMetaFormat1()
3309
return local_dir_format.initialize_on_transport(transport)
3310
client = _SmartClient(client_medium)
3311
path = client.remote_path_from_transport(transport)
3313
response = client.call('BzrDirFormat.initialize', path)
3314
except errors.ErrorFromSmartServer, err:
3315
remote._translate_error(err, path=path)
3316
if response[0] != 'ok':
3317
raise errors.SmartProtocolError('unexpected response code %s' % (response,))
3318
format = RemoteBzrDirFormat()
3319
self._supply_sub_formats_to(format)
3320
return remote.RemoteBzrDir(transport, format)
3322
def parse_NoneTrueFalse(self, arg):
3329
raise AssertionError("invalid arg %r" % arg)
3331
def _serialize_NoneTrueFalse(self, arg):
3338
def _serialize_NoneString(self, arg):
3341
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
3342
create_prefix=False, force_new_repo=False, stacked_on=None,
3343
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
3346
# hand off the request to the smart server
3347
client_medium = transport.get_smart_medium()
3348
except errors.NoSmartMedium:
3351
# Decline to open it if the server doesn't support our required
3352
# version (3) so that the VFS-based transport will do it.
3353
if client_medium.should_probe():
3355
server_version = client_medium.protocol_version()
3356
if server_version != '2':
3360
except errors.SmartProtocolError:
3361
# Apparently there's no usable smart server there, even though
3362
# the medium supports the smart protocol.
3367
client = _SmartClient(client_medium)
3368
path = client.remote_path_from_transport(transport)
3369
if client_medium._is_remote_before((1, 16)):
3372
# TODO: lookup the local format from a server hint.
3373
local_dir_format = BzrDirMetaFormat1()
3374
self._supply_sub_formats_to(local_dir_format)
3375
return local_dir_format.initialize_on_transport_ex(transport,
3376
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3377
force_new_repo=force_new_repo, stacked_on=stacked_on,
3378
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3379
make_working_trees=make_working_trees, shared_repo=shared_repo,
3381
return self._initialize_on_transport_ex_rpc(client, path, transport,
3382
use_existing_dir, create_prefix, force_new_repo, stacked_on,
3383
stack_on_pwd, repo_format_name, make_working_trees, shared_repo)
3385
def _initialize_on_transport_ex_rpc(self, client, path, transport,
3386
use_existing_dir, create_prefix, force_new_repo, stacked_on,
3387
stack_on_pwd, repo_format_name, make_working_trees, shared_repo):
3389
args.append(self._serialize_NoneTrueFalse(use_existing_dir))
3390
args.append(self._serialize_NoneTrueFalse(create_prefix))
3391
args.append(self._serialize_NoneTrueFalse(force_new_repo))
3392
args.append(self._serialize_NoneString(stacked_on))
3393
# stack_on_pwd is often/usually our transport
3396
stack_on_pwd = transport.relpath(stack_on_pwd)
3397
if not stack_on_pwd:
3399
except errors.PathNotChild:
3401
args.append(self._serialize_NoneString(stack_on_pwd))
3402
args.append(self._serialize_NoneString(repo_format_name))
3403
args.append(self._serialize_NoneTrueFalse(make_working_trees))
3404
args.append(self._serialize_NoneTrueFalse(shared_repo))
3405
request_network_name = self._network_name or \
3406
BzrDirFormat.get_default_format().network_name()
3408
response = client.call('BzrDirFormat.initialize_ex_1.16',
3409
request_network_name, path, *args)
3410
except errors.UnknownSmartMethod:
3411
client._medium._remember_remote_is_before((1,16))
3412
local_dir_format = BzrDirMetaFormat1()
3413
self._supply_sub_formats_to(local_dir_format)
3414
return local_dir_format.initialize_on_transport_ex(transport,
3415
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3416
force_new_repo=force_new_repo, stacked_on=stacked_on,
3417
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3418
make_working_trees=make_working_trees, shared_repo=shared_repo,
3420
except errors.ErrorFromSmartServer, err:
3421
remote._translate_error(err, path=path)
3422
repo_path = response[0]
3423
bzrdir_name = response[6]
3424
require_stacking = response[7]
3425
require_stacking = self.parse_NoneTrueFalse(require_stacking)
3426
format = RemoteBzrDirFormat()
3427
format._network_name = bzrdir_name
3428
self._supply_sub_formats_to(format)
3429
bzrdir = remote.RemoteBzrDir(transport, format, _client=client)
3431
repo_format = remote.response_tuple_to_repo_format(response[1:])
3432
if repo_path == '.':
3435
repo_bzrdir_format = RemoteBzrDirFormat()
3436
repo_bzrdir_format._network_name = response[5]
3437
repo_bzr = remote.RemoteBzrDir(transport.clone(repo_path),
3441
final_stack = response[8] or None
3442
final_stack_pwd = response[9] or None
3444
final_stack_pwd = urlutils.join(
3445
transport.base, final_stack_pwd)
3446
remote_repo = remote.RemoteRepository(repo_bzr, repo_format)
3447
if len(response) > 10:
3448
# Updated server verb that locks remotely.
3449
repo_lock_token = response[10] or None
3450
remote_repo.lock_write(repo_lock_token, _skip_rpc=True)
3452
remote_repo.dont_leave_lock_in_place()
3454
remote_repo.lock_write()
3455
policy = UseExistingRepository(remote_repo, final_stack,
3456
final_stack_pwd, require_stacking)
3457
policy.acquire_repository()
3461
bzrdir._format.set_branch_format(self.get_branch_format())
3462
if require_stacking:
3463
# The repo has already been created, but we need to make sure that
3464
# we'll make a stackable branch.
3465
bzrdir._format.require_stacking(_skip_repo=True)
3466
return remote_repo, bzrdir, require_stacking, policy
3468
def _open(self, transport):
3469
return remote.RemoteBzrDir(transport, self)
3471
def __eq__(self, other):
3472
if not isinstance(other, RemoteBzrDirFormat):
3474
return self.get_format_description() == other.get_format_description()
3476
def __return_repository_format(self):
3477
# Always return a RemoteRepositoryFormat object, but if a specific bzr
3478
# repository format has been asked for, tell the RemoteRepositoryFormat
3479
# that it should use that for init() etc.
3480
result = remote.RemoteRepositoryFormat()
3481
custom_format = getattr(self, '_repository_format', None)
3483
if isinstance(custom_format, remote.RemoteRepositoryFormat):
3484
return custom_format
3486
# We will use the custom format to create repositories over the
3487
# wire; expose its details like rich_root_data for code to
3489
result._custom_format = custom_format
3492
def get_branch_format(self):
3493
result = BzrDirMetaFormat1.get_branch_format(self)
3494
if not isinstance(result, remote.RemoteBranchFormat):
3495
new_result = remote.RemoteBranchFormat()
3496
new_result._custom_format = result
3498
self.set_branch_format(new_result)
3502
repository_format = property(__return_repository_format,
3503
BzrDirMetaFormat1._set_repository_format) #.im_func)
3506
BzrDirFormat.register_control_server_format(RemoteBzrDirFormat)
3509
class BzrDirFormatInfo(object):
3511
def __init__(self, native, deprecated, hidden, experimental):
3512
self.deprecated = deprecated
3513
self.native = native
3514
self.hidden = hidden
3515
self.experimental = experimental
3518
class BzrDirFormatRegistry(registry.Registry):
3519
"""Registry of user-selectable BzrDir subformats.
3521
Differs from BzrDirFormat._control_formats in that it provides sub-formats,
3522
e.g. BzrDirMeta1 with weave repository. Also, it's more user-oriented.
3526
"""Create a BzrDirFormatRegistry."""
3527
self._aliases = set()
3528
self._registration_order = list()
3529
super(BzrDirFormatRegistry, self).__init__()
3532
"""Return a set of the format names which are aliases."""
3533
return frozenset(self._aliases)
3535
def register_metadir(self, key,
3536
repository_format, help, native=True, deprecated=False,
3542
"""Register a metadir subformat.
3544
These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
3545
by the Repository/Branch/WorkingTreeformats.
3547
:param repository_format: The fully-qualified repository format class
3549
:param branch_format: Fully-qualified branch format class name as
3551
:param tree_format: Fully-qualified tree format class name as
3554
# This should be expanded to support setting WorkingTree and Branch
3555
# formats, once BzrDirMetaFormat1 supports that.
3556
def _load(full_name):
3557
mod_name, factory_name = full_name.rsplit('.', 1)
3559
mod = __import__(mod_name, globals(), locals(),
3561
except ImportError, e:
3562
raise ImportError('failed to load %s: %s' % (full_name, e))
3564
factory = getattr(mod, factory_name)
3565
except AttributeError:
3566
raise AttributeError('no factory %s in module %r'
3571
bd = BzrDirMetaFormat1()
3572
if branch_format is not None:
3573
bd.set_branch_format(_load(branch_format))
3574
if tree_format is not None:
3575
bd.workingtree_format = _load(tree_format)
3576
if repository_format is not None:
3577
bd.repository_format = _load(repository_format)
3579
self.register(key, helper, help, native, deprecated, hidden,
3580
experimental, alias)
3582
def register(self, key, factory, help, native=True, deprecated=False,
3583
hidden=False, experimental=False, alias=False):
3584
"""Register a BzrDirFormat factory.
3586
The factory must be a callable that takes one parameter: the key.
3587
It must produce an instance of the BzrDirFormat when called.
3589
This function mainly exists to prevent the info object from being
3592
registry.Registry.register(self, key, factory, help,
3593
BzrDirFormatInfo(native, deprecated, hidden, experimental))
3595
self._aliases.add(key)
3596
self._registration_order.append(key)
3598
def register_lazy(self, key, module_name, member_name, help, native=True,
3599
deprecated=False, hidden=False, experimental=False, alias=False):
3600
registry.Registry.register_lazy(self, key, module_name, member_name,
3601
help, BzrDirFormatInfo(native, deprecated, hidden, experimental))
3603
self._aliases.add(key)
3604
self._registration_order.append(key)
3606
def set_default(self, key):
3607
"""Set the 'default' key to be a clone of the supplied key.
3609
This method must be called once and only once.
3611
registry.Registry.register(self, 'default', self.get(key),
3612
self.get_help(key), info=self.get_info(key))
3613
self._aliases.add('default')
3615
def set_default_repository(self, key):
3616
"""Set the FormatRegistry default and Repository default.
3618
This is a transitional method while Repository.set_default_format
3621
if 'default' in self:
3622
self.remove('default')
3623
self.set_default(key)
3624
format = self.get('default')()
3626
def make_bzrdir(self, key):
3627
return self.get(key)()
3629
def help_topic(self, topic):
3631
default_realkey = None
3632
default_help = self.get_help('default')
3634
for key in self._registration_order:
3635
if key == 'default':
3637
help = self.get_help(key)
3638
if help == default_help:
3639
default_realkey = key
3641
help_pairs.append((key, help))
3643
def wrapped(key, help, info):
3645
help = '(native) ' + help
3646
return ':%s:\n%s\n\n' % (key,
3647
textwrap.fill(help, initial_indent=' ',
3648
subsequent_indent=' ',
3649
break_long_words=False))
3650
if default_realkey is not None:
3651
output += wrapped(default_realkey, '(default) %s' % default_help,
3652
self.get_info('default'))
3653
deprecated_pairs = []
3654
experimental_pairs = []
3655
for key, help in help_pairs:
3656
info = self.get_info(key)
3659
elif info.deprecated:
3660
deprecated_pairs.append((key, help))
3661
elif info.experimental:
3662
experimental_pairs.append((key, help))
3664
output += wrapped(key, help, info)
3665
output += "\nSee :doc:`formats-help` for more about storage formats."
3667
if len(experimental_pairs) > 0:
3668
other_output += "Experimental formats are shown below.\n\n"
3669
for key, help in experimental_pairs:
3670
info = self.get_info(key)
3671
other_output += wrapped(key, help, info)
3674
"No experimental formats are available.\n\n"
3675
if len(deprecated_pairs) > 0:
3676
other_output += "\nDeprecated formats are shown below.\n\n"
3677
for key, help in deprecated_pairs:
3678
info = self.get_info(key)
3679
other_output += wrapped(key, help, info)
3682
"\nNo deprecated formats are available.\n\n"
3684
"\nSee :doc:`formats-help` for more about storage formats."
3686
if topic == 'other-formats':
3692
class RepositoryAcquisitionPolicy(object):
3693
"""Abstract base class for repository acquisition policies.
3695
A repository acquisition policy decides how a BzrDir acquires a repository
3696
for a branch that is being created. The most basic policy decision is
3697
whether to create a new repository or use an existing one.
3699
def __init__(self, stack_on, stack_on_pwd, require_stacking):
3702
:param stack_on: A location to stack on
3703
:param stack_on_pwd: If stack_on is relative, the location it is
3705
:param require_stacking: If True, it is a failure to not stack.
3707
self._stack_on = stack_on
3708
self._stack_on_pwd = stack_on_pwd
3709
self._require_stacking = require_stacking
3711
def configure_branch(self, branch):
3712
"""Apply any configuration data from this policy to the branch.
3714
Default implementation sets repository stacking.
3716
if self._stack_on is None:
3718
if self._stack_on_pwd is None:
3719
stack_on = self._stack_on
3722
stack_on = urlutils.rebase_url(self._stack_on,
3725
except errors.InvalidRebaseURLs:
3726
stack_on = self._get_full_stack_on()
3728
branch.set_stacked_on_url(stack_on)
3729
except (errors.UnstackableBranchFormat,
3730
errors.UnstackableRepositoryFormat):
3731
if self._require_stacking:
3734
def requires_stacking(self):
3735
"""Return True if this policy requires stacking."""
3736
return self._stack_on is not None and self._require_stacking
3738
def _get_full_stack_on(self):
3739
"""Get a fully-qualified URL for the stack_on location."""
3740
if self._stack_on is None:
3742
if self._stack_on_pwd is None:
3743
return self._stack_on
3745
return urlutils.join(self._stack_on_pwd, self._stack_on)
3747
def _add_fallback(self, repository, possible_transports=None):
3748
"""Add a fallback to the supplied repository, if stacking is set."""
3749
stack_on = self._get_full_stack_on()
3750
if stack_on is None:
3753
stacked_dir = BzrDir.open(stack_on,
3754
possible_transports=possible_transports)
3755
except errors.JailBreak:
3756
# We keep the stacking details, but we are in the server code so
3757
# actually stacking is not needed.
3760
stacked_repo = stacked_dir.open_branch().repository
3761
except errors.NotBranchError:
3762
stacked_repo = stacked_dir.open_repository()
3764
repository.add_fallback_repository(stacked_repo)
3765
except errors.UnstackableRepositoryFormat:
3766
if self._require_stacking:
3769
self._require_stacking = True
3771
def acquire_repository(self, make_working_trees=None, shared=False):
3772
"""Acquire a repository for this bzrdir.
3774
Implementations may create a new repository or use a pre-exising
3776
:param make_working_trees: If creating a repository, set
3777
make_working_trees to this value (if non-None)
3778
:param shared: If creating a repository, make it shared if True
3779
:return: A repository, is_new_flag (True if the repository was
3782
raise NotImplemented(RepositoryAcquisitionPolicy.acquire_repository)
3785
class CreateRepository(RepositoryAcquisitionPolicy):
3786
"""A policy of creating a new repository"""
3788
def __init__(self, bzrdir, stack_on=None, stack_on_pwd=None,
3789
require_stacking=False):
3792
:param bzrdir: The bzrdir to create the repository on.
3793
:param stack_on: A location to stack on
3794
:param stack_on_pwd: If stack_on is relative, the location it is
3797
RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
3799
self._bzrdir = bzrdir
3801
def acquire_repository(self, make_working_trees=None, shared=False):
3802
"""Implementation of RepositoryAcquisitionPolicy.acquire_repository
3804
Creates the desired repository in the bzrdir we already have.
3806
stack_on = self._get_full_stack_on()
3808
format = self._bzrdir._format
3809
format.require_stacking(stack_on=stack_on,
3810
possible_transports=[self._bzrdir.root_transport])
3811
if not self._require_stacking:
3812
# We have picked up automatic stacking somewhere.
3813
note('Using default stacking branch %s at %s', self._stack_on,
3815
repository = self._bzrdir.create_repository(shared=shared)
3816
self._add_fallback(repository,
3817
possible_transports=[self._bzrdir.transport])
3818
if make_working_trees is not None:
3819
repository.set_make_working_trees(make_working_trees)
3820
return repository, True
3823
class UseExistingRepository(RepositoryAcquisitionPolicy):
3824
"""A policy of reusing an existing repository"""
3826
def __init__(self, repository, stack_on=None, stack_on_pwd=None,
3827
require_stacking=False):
3830
:param repository: The repository to use.
3831
:param stack_on: A location to stack on
3832
:param stack_on_pwd: If stack_on is relative, the location it is
3835
RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
3837
self._repository = repository
3839
def acquire_repository(self, make_working_trees=None, shared=False):
3840
"""Implementation of RepositoryAcquisitionPolicy.acquire_repository
3842
Returns an existing repository to use.
3844
self._add_fallback(self._repository,
3845
possible_transports=[self._repository.bzrdir.transport])
3846
return self._repository, False
3849
# Please register new formats after old formats so that formats
3850
# appear in chronological order and format descriptions can build
3852
format_registry = BzrDirFormatRegistry()
3853
# The pre-0.8 formats have their repository format network name registered in
3854
# repository.py. MetaDir formats have their repository format network name
3855
# inferred from their disk format string.
3856
format_registry.register('weave', BzrDirFormat6,
3857
'Pre-0.8 format. Slower than knit and does not'
3858
' support checkouts or shared repositories.',
3861
format_registry.register_metadir('metaweave',
3862
'bzrlib.repofmt.weaverepo.RepositoryFormat7',
3863
'Transitional format in 0.8. Slower than knit.',
3864
branch_format='bzrlib.branch.BzrBranchFormat5',
3865
tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3868
format_registry.register_metadir('knit',
3869
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3870
'Format using knits. Recommended for interoperation with bzr <= 0.14.',
3871
branch_format='bzrlib.branch.BzrBranchFormat5',
3872
tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3875
format_registry.register_metadir('dirstate',
3876
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3877
help='New in 0.15: Fast local operations. Compatible with bzr 0.8 and '
3878
'above when accessed over the network.',
3879
branch_format='bzrlib.branch.BzrBranchFormat5',
3880
# this uses bzrlib.workingtree.WorkingTreeFormat4 because importing
3881
# directly from workingtree_4 triggers a circular import.
3882
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3885
format_registry.register_metadir('dirstate-tags',
3886
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3887
help='New in 0.15: Fast local operations and improved scaling for '
3888
'network operations. Additionally adds support for tags.'
3889
' Incompatible with bzr < 0.15.',
3890
branch_format='bzrlib.branch.BzrBranchFormat6',
3891
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3894
format_registry.register_metadir('rich-root',
3895
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
3896
help='New in 1.0. Better handling of tree roots. Incompatible with'
3898
branch_format='bzrlib.branch.BzrBranchFormat6',
3899
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3902
format_registry.register_metadir('dirstate-with-subtree',
3903
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
3904
help='New in 0.15: Fast local operations and improved scaling for '
3905
'network operations. Additionally adds support for versioning nested '
3906
'bzr branches. Incompatible with bzr < 0.15.',
3907
branch_format='bzrlib.branch.BzrBranchFormat6',
3908
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3912
format_registry.register_metadir('pack-0.92',
3913
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack1',
3914
help='New in 0.92: Pack-based format with data compatible with '
3915
'dirstate-tags format repositories. Interoperates with '
3916
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3918
branch_format='bzrlib.branch.BzrBranchFormat6',
3919
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3921
format_registry.register_metadir('pack-0.92-subtree',
3922
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack3',
3923
help='New in 0.92: Pack-based format with data compatible with '
3924
'dirstate-with-subtree format repositories. Interoperates with '
3925
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3927
branch_format='bzrlib.branch.BzrBranchFormat6',
3928
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3932
format_registry.register_metadir('rich-root-pack',
3933
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
3934
help='New in 1.0: A variant of pack-0.92 that supports rich-root data '
3935
'(needed for bzr-svn and bzr-git).',
3936
branch_format='bzrlib.branch.BzrBranchFormat6',
3937
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3940
format_registry.register_metadir('1.6',
3941
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5',
3942
help='A format that allows a branch to indicate that there is another '
3943
'(stacked) repository that should be used to access data that is '
3944
'not present locally.',
3945
branch_format='bzrlib.branch.BzrBranchFormat7',
3946
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3949
format_registry.register_metadir('1.6.1-rich-root',
3950
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5RichRoot',
3951
help='A variant of 1.6 that supports rich-root data '
3952
'(needed for bzr-svn and bzr-git).',
3953
branch_format='bzrlib.branch.BzrBranchFormat7',
3954
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3957
format_registry.register_metadir('1.9',
3958
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3959
help='A repository format using B+tree indexes. These indexes '
3960
'are smaller in size, have smarter caching and provide faster '
3961
'performance for most operations.',
3962
branch_format='bzrlib.branch.BzrBranchFormat7',
3963
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3966
format_registry.register_metadir('1.9-rich-root',
3967
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
3968
help='A variant of 1.9 that supports rich-root data '
3969
'(needed for bzr-svn and bzr-git).',
3970
branch_format='bzrlib.branch.BzrBranchFormat7',
3971
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3974
format_registry.register_metadir('1.14',
3975
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3976
help='A working-tree format that supports content filtering.',
3977
branch_format='bzrlib.branch.BzrBranchFormat7',
3978
tree_format='bzrlib.workingtree.WorkingTreeFormat5',
3980
format_registry.register_metadir('1.14-rich-root',
3981
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
3982
help='A variant of 1.14 that supports rich-root data '
3983
'(needed for bzr-svn and bzr-git).',
3984
branch_format='bzrlib.branch.BzrBranchFormat7',
3985
tree_format='bzrlib.workingtree.WorkingTreeFormat5',
3987
# The following un-numbered 'development' formats should always just be aliases.
3988
format_registry.register_metadir('development-rich-root',
3989
'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
3990
help='Current development format. Supports rich roots. Can convert data '
3991
'to and from rich-root-pack (and anything compatible with '
3992
'rich-root-pack) format repositories. Repositories and branches in '
3993
'this format can only be read by bzr.dev. Please read '
3994
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
3996
branch_format='bzrlib.branch.BzrBranchFormat7',
3997
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4002
format_registry.register_metadir('development-subtree',
4003
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment2Subtree',
4004
help='Current development format, subtree variant. Can convert data to and '
4005
'from pack-0.92-subtree (and anything compatible with '
4006
'pack-0.92-subtree) format repositories. Repositories and branches in '
4007
'this format can only be read by bzr.dev. Please read '
4008
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
4010
branch_format='bzrlib.branch.BzrBranchFormat7',
4011
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4014
alias=False, # Restore to being an alias when an actual development subtree format is added
4015
# This current non-alias status is simply because we did not introduce a
4016
# chk based subtree format.
4019
# And the development formats above will have aliased one of the following:
4020
format_registry.register_metadir('development6-rich-root',
4021
'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
4022
help='pack-1.9 with 255-way hashed CHK inv, group compress, rich roots '
4024
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
4026
branch_format='bzrlib.branch.BzrBranchFormat7',
4027
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4032
format_registry.register_metadir('development7-rich-root',
4033
'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK2',
4034
help='pack-1.9 with 255-way hashed CHK inv, bencode revision, group compress, '
4035
'rich roots. Please read '
4036
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
4038
branch_format='bzrlib.branch.BzrBranchFormat7',
4039
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4044
format_registry.register_metadir('2a',
4045
'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
4046
help='First format for bzr 2.0 series.\n'
4047
'Uses group-compress storage.\n'
4048
'Provides rich roots which are a one-way transition.\n',
4049
# 'storage in packs, 255-way hashed CHK inventory, bencode revision, group compress, '
4050
# 'rich roots. Supported by bzr 1.16 and later.',
4051
branch_format='bzrlib.branch.BzrBranchFormat7',
4052
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4056
# The following format should be an alias for the rich root equivalent
4057
# of the default format
4058
format_registry.register_metadir('default-rich-root',
4059
'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
4060
branch_format='bzrlib.branch.BzrBranchFormat7',
4061
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4066
# The current format that is made on 'bzr init'.
4067
format_registry.set_default('2a')
added
removed
bzrlib/bzrdir.py
