1
# Copyright (C) 2006-2010 Canonical Ltd
1
# Copyright (C) 2005 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
13
13
# You should have received a copy of the GNU General Public License
14
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
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
17
"""BzrDir logic. The BzrDir is the basic control directory used by bzr.
19
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.
23
from copy import deepcopy
34
from bzrlib.lazy_import import lazy_import
35
lazy_import(globals(), """
36
from stat import S_ISDIR
25
from cStringIO import StringIO
26
from unittest import TestSuite
50
revision as _mod_revision,
29
import bzrlib.errors as errors
30
from bzrlib.lockable_files import LockableFiles
31
from bzrlib.osutils import safe_unicode
60
32
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,
39
from bzrlib.store.text import TextStore
40
from bzrlib.store.weave import WeaveStore
41
from bzrlib.symbol_versioning import *
42
from bzrlib.trace import mutter
43
from bzrlib.transactions import PassThroughTransaction
44
from bzrlib.transport import get_transport
45
from bzrlib.transport.local import LocalTransport
75
46
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):
47
from bzrlib.weavefile import read_weave, write_weave
48
from bzrlib.xml4 import serializer_v4
49
from bzrlib.xml5 import serializer_v5
125
53
"""A .bzr control diretory.
127
55
BzrDir instances let you create or open any of the things that can be
128
56
found within .bzr - checkouts, branches and repositories.
131
59
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.
61
a transport connected to the directory this bzr was opened from.
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
64
def can_convert_format(self):
162
65
"""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.
68
def _check_supported(self, format, allow_unsupported):
69
"""Check whether format is a supported format.
71
If allow_unsupported is True, this is a no-op.
194
# TODO: perhaps move this into a base Format class; it's not BzrDir
195
# specific. mbp 20070323
196
73
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(),
74
raise errors.UnsupportedFormatError(format)
205
def clone(self, url, revision_id=None, force_new_repo=False,
206
preserve_stacking=False):
76
def clone(self, url, revision_id=None, basis=None, force_new_repo=False):
207
77
"""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:
79
If urls last component does not exist, it will be created.
81
if revision_id is not None, then the clone operation may tune
82
itself to download less data.
83
:param force_new_repo: Do not use a shared repository for the target
84
even if one is available.
87
basis_repo, basis_branch, basis_tree = self._get_basis_components(basis)
88
result = self._format.initialize(url)
252
90
local_repo = self.find_repository()
253
91
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)
94
# may need to copy content in
96
local_repo.clone(result, revision_id=revision_id, basis=basis_repo)
99
result_repo = result.find_repository()
100
# fetch content this dir needs.
102
# XXX FIXME RBC 20060214 need tests for this when the basis
104
result_repo.fetch(basis_repo, revision_id=revision_id)
304
105
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)
106
except errors.NoRepositoryPresent:
107
# needed to make one anyway.
108
local_repo.clone(result, revision_id=revision_id, basis=basis_repo)
310
109
# 1 if there is a branch present
311
110
# 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)
113
self.open_branch().clone(result, revision_id=revision_id)
114
except errors.NotBranchError:
117
self.open_workingtree().clone(result, basis=basis_tree)
322
118
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.
122
def _get_basis_components(self, basis):
123
"""Retrieve the basis components that are available at basis."""
125
return None, None, None
127
basis_tree = basis.open_workingtree()
128
basis_branch = basis_tree.branch
129
basis_repo = basis_branch.repository
130
except (errors.NoWorkingTree, errors.NotLocalUrl):
133
basis_branch = basis.open_branch()
134
basis_repo = basis_branch.repository
135
except errors.NotBranchError:
138
basis_repo = basis.open_repository()
139
except errors.NoRepositoryPresent:
141
return basis_repo, basis_branch, basis_tree
328
143
def _make_tail(self, url):
329
t = get_transport(url)
144
segments = url.split('/')
145
if segments and segments[-1] not in ('', '.'):
146
parent = '/'.join(segments[:-1])
147
t = bzrlib.transport.get_transport(parent)
149
t.mkdir(segments[-1])
150
except errors.FileExists:
333
def create(cls, base, format=None, possible_transports=None):
334
155
"""Create a new BzrDir at the url 'base'.
336
:param format: If supplied, the format of branch to create. If not
337
supplied, the default is used.
338
:param possible_transports: If supplied, a list of transports that
339
can be reused to share a remote connection.
341
if cls is not BzrDir:
342
raise AssertionError("BzrDir.create always creates the default"
343
" format, not one of %r" % cls)
344
t = get_transport(base, possible_transports)
347
format = BzrDirFormat.get_default_format()
348
return format.initialize_on_transport(t)
351
def find_bzrdirs(transport, evaluate=None, list_current=None):
352
"""Find bzrdirs recursively from current location.
354
This is intended primarily as a building block for more sophisticated
355
functionality, like finding trees under a directory, or finding
356
branches that use a given repository.
357
:param evaluate: An optional callable that yields recurse, value,
358
where recurse controls whether this bzrdir is recursed into
359
and value is the value to yield. By default, all bzrdirs
360
are recursed into, and the return value is the bzrdir.
361
:param list_current: if supplied, use this function to list the current
362
directory, instead of Transport.list_dir
363
:return: a generator of found bzrdirs, or whatever evaluate returns.
365
if list_current is None:
366
def list_current(transport):
367
return transport.list_dir('')
369
def evaluate(bzrdir):
372
pending = [transport]
373
while len(pending) > 0:
374
current_transport = pending.pop()
377
bzrdir = BzrDir.open_from_transport(current_transport)
378
except errors.NotBranchError:
381
recurse, value = evaluate(bzrdir)
384
subdirs = list_current(current_transport)
385
except errors.NoSuchFile:
388
for subdir in sorted(subdirs, reverse=True):
389
pending.append(current_transport.clone(subdir))
391
def list_branches(self):
392
"""Return a sequence of all branches local to this control directory.
396
return [self.open_branch()]
397
except errors.NotBranchError:
401
def find_branches(transport):
402
"""Find all branches under a transport.
404
This will find all branches below the transport, including branches
405
inside other branches. Where possible, it will use
406
Repository.find_branches.
408
To list all the branches that use a particular Repository, see
409
Repository.find_branches
411
def evaluate(bzrdir):
413
repository = bzrdir.open_repository()
414
except errors.NoRepositoryPresent:
417
return False, ([], repository)
418
return True, (bzrdir.list_branches(), None)
420
for branches, repo in BzrDir.find_bzrdirs(transport,
423
ret.extend(repo.find_branches())
424
if branches is not None:
428
def destroy_repository(self):
429
"""Destroy the repository in this BzrDir"""
430
raise NotImplementedError(self.destroy_repository)
432
def create_branch(self, name=None):
157
This will call the current default formats initialize with base
158
as the only parameter.
160
If you need a specific format, consider creating an instance
161
of that and calling initialize().
163
segments = base.split('/')
164
if segments and segments[-1] not in ('', '.'):
165
parent = '/'.join(segments[:-1])
166
t = bzrlib.transport.get_transport(parent)
168
t.mkdir(segments[-1])
169
except errors.FileExists:
171
return BzrDirFormat.get_default_format().initialize(safe_unicode(base))
173
def create_branch(self):
433
174
"""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.
176
The bzrdirs format will control what branch format is created.
439
177
For more control see BranchFormatXX.create(a_bzrdir).
441
179
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):
182
def create_branch_and_repo(base, force_new_repo=False):
453
183
"""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
185
This will use the current default BzrDirFormat, and use whatever
457
186
repository format that that uses via bzrdir.create_branch and
458
187
create_repository. If a shared repository is available that is used
555
222
The created Branch object is returned.
556
223
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
224
no error is raised unless force_new_tree is True, in which case no
558
225
data is created on disk and NotLocalUrl is raised.
560
227
:param base: The URL to create the branch at.
561
228
: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
229
:param force_new_tree: If True or False force creation of a tree or
563
230
prevent such creation respectively.
564
:param format: Override for the bzrdir format to create.
565
:param possible_transports: An optional reusable transports list.
567
232
if force_new_tree:
568
233
# check for non local urls
569
t = get_transport(base, possible_transports)
570
if not isinstance(t, local.LocalTransport):
234
t = get_transport(safe_unicode(base))
235
if not isinstance(t, LocalTransport):
571
236
raise errors.NotLocalUrl(base)
572
bzrdir = BzrDir.create(base, format, possible_transports)
237
bzrdir = BzrDir.create(base)
573
238
repo = bzrdir._find_or_create_repository(force_new_repo)
574
239
result = bzrdir.create_branch()
575
if force_new_tree or (repo.make_working_trees() and
240
if force_new_tree or (repo.make_working_trees() and
576
241
force_new_tree is None):
578
243
bzrdir.create_workingtree()
579
244
except errors.NotLocalUrl:
584
def create_standalone_workingtree(base, format=None):
249
def create_repository(base, shared=False):
250
"""Create a new BzrDir and Repository at the url 'base'.
252
This will use the current default BzrDirFormat, and use whatever
253
repository format that that uses for bzrdirformat.create_repository.
255
;param shared: Create a shared repository rather than a standalone
257
The Repository object is returned.
259
This must be overridden as an instance method in child classes, where
260
it should take no parameters and construct whatever repository format
261
that child class desires.
263
bzrdir = BzrDir.create(base)
264
return bzrdir.create_repository()
267
def create_standalone_workingtree(base):
585
268
"""Create a new BzrDir, WorkingTree, Branch and Repository at 'base'.
587
270
'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
272
This will use the current default BzrDirFormat, and use whatever
591
273
repository format that that uses for bzrdirformat.create_workingtree,
592
274
create_branch and create_repository.
594
:param format: Override for the bzrdir format to create.
595
:return: The WorkingTree object.
276
The WorkingTree object is returned.
597
t = get_transport(base)
598
if not isinstance(t, local.LocalTransport):
278
t = get_transport(safe_unicode(base))
279
if not isinstance(t, LocalTransport):
599
280
raise errors.NotLocalUrl(base)
600
bzrdir = BzrDir.create_branch_and_repo(base,
602
format=format).bzrdir
281
bzrdir = BzrDir.create_branch_and_repo(safe_unicode(base),
282
force_new_repo=True).bzrdir
603
283
return bzrdir.create_workingtree()
605
def create_workingtree(self, revision_id=None, from_branch=None,
606
accelerator_tree=None, hardlink=False):
285
def create_workingtree(self, revision_id=None):
607
286
"""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.
288
revision_id: create it as of this revision id.
616
290
raise NotImplementedError(self.create_workingtree)
618
def backup_bzrdir(self):
619
"""Backup this bzr control directory.
621
:return: Tuple with old path name and new path name
623
def name_gen(base='backup.bzr'):
625
name = "%s.~%d~" % (base, counter)
626
while self.root_transport.has(name):
628
name = "%s.~%d~" % (base, counter)
631
backup_dir=name_gen()
632
pb = ui.ui_factory.nested_progress_bar()
634
# FIXME: bug 300001 -- the backup fails if the backup directory
635
# already exists, but it should instead either remove it or make
636
# a new backup directory.
638
old_path = self.root_transport.abspath('.bzr')
639
new_path = self.root_transport.abspath(backup_dir)
640
ui.ui_factory.note('making backup of %s\n to %s' % (old_path, new_path,))
641
self.root_transport.copy_tree('.bzr', backup_dir)
642
return (old_path, new_path)
646
def retire_bzrdir(self, limit=10000):
647
"""Permanently disable the bzrdir.
649
This is done by renaming it to give the user some ability to recover
650
if there was a problem.
652
This will have horrible consequences if anyone has anything locked or
654
:param limit: number of times to retry
659
to_path = '.bzr.retired.%d' % i
660
self.root_transport.rename('.bzr', to_path)
661
note("renamed %s to %s"
662
% (self.root_transport.abspath('.bzr'), to_path))
664
except (errors.TransportError, IOError, errors.PathError):
671
def destroy_workingtree(self):
672
"""Destroy the working tree at this BzrDir.
674
Formats that do not support this may raise UnsupportedOperation.
676
raise NotImplementedError(self.destroy_workingtree)
678
def destroy_workingtree_metadata(self):
679
"""Destroy the control files for the working tree at this BzrDir.
681
The contents of working tree files are not affected.
682
Formats that do not support this may raise UnsupportedOperation.
684
raise NotImplementedError(self.destroy_workingtree_metadata)
686
def _find_containing(self, evaluate):
687
"""Find something in a containing control directory.
689
This method will scan containing control dirs, until it finds what
690
it is looking for, decides that it will never find it, or runs out
691
of containing control directories to check.
693
It is used to implement find_repository and
694
determine_repository_policy.
696
:param evaluate: A function returning (value, stop). If stop is True,
697
the value will be returned.
701
result, stop = evaluate(found_bzrdir)
704
next_transport = found_bzrdir.root_transport.clone('..')
705
if (found_bzrdir.user_url == next_transport.base):
706
# top of the file system
708
# find the next containing bzrdir
710
found_bzrdir = BzrDir.open_containing_from_transport(
712
except errors.NotBranchError:
715
292
def find_repository(self):
716
"""Find the repository that should be used.
293
"""Find the repository that should be used for a_bzrdir.
718
295
This does not require a branch as we use it to find the repo for
719
296
new branches as well as to hook existing branches up to their
722
def usable_repository(found_bzrdir):
723
# does it have a repository ?
300
return self.open_repository()
301
except errors.NoRepositoryPresent:
303
next_transport = self.root_transport.clone('..')
306
found_bzrdir = BzrDir.open_containing_from_transport(
308
except errors.NotBranchError:
309
raise errors.NoRepositoryPresent(self)
725
311
repository = found_bzrdir.open_repository()
726
312
except errors.NoRepositoryPresent:
728
if found_bzrdir.user_url == self.user_url:
729
return repository, True
730
elif repository.is_shared():
731
return repository, True
313
next_transport = found_bzrdir.root_transport.clone('..')
315
if ((found_bzrdir.root_transport.base ==
316
self.root_transport.base) or repository.is_shared()):
735
found_repo = self._find_containing(usable_repository)
736
if found_repo is None:
737
raise errors.NoRepositoryPresent(self)
740
def get_branch_reference(self, name=None):
741
"""Return the referenced URL for the branch in this bzrdir.
743
:param name: Optional colocated branch name
744
:raises NotBranchError: If there is no Branch.
745
:raises NoColocatedBranchSupport: If a branch name was specified
746
but colocated branches are not supported.
747
:return: The URL the branch in this bzrdir references if it is a
748
reference branch, or None for regular branches.
751
raise errors.NoColocatedBranchSupport(self)
754
def get_branch_transport(self, branch_format, name=None):
319
raise errors.NoRepositoryPresent(self)
320
raise errors.NoRepositoryPresent(self)
322
def get_branch_transport(self, branch_format):
755
323
"""Get the transport for use by branch format in this BzrDir.
757
325
Note that bzr dirs that do not support format strings will raise
758
326
IncompatibleFormat if the branch format they are given has
759
a format string, and vice versa.
327
a format string, and vice verca.
761
If branch_format is None, the transport is returned with no
762
checking. If it is not None, then the returned transport is
329
If branch_format is None, the transport is returned with no
330
checking. if it is not None, then the returned transport is
763
331
guaranteed to point to an existing directory ready for use.
765
333
raise NotImplementedError(self.get_branch_transport)
767
def _find_creation_modes(self):
768
"""Determine the appropriate modes for files and directories.
770
They're always set to be consistent with the base directory,
771
assuming that this transport allows setting modes.
773
# TODO: Do we need or want an option (maybe a config setting) to turn
774
# this off or override it for particular locations? -- mbp 20080512
775
if self._mode_check_done:
777
self._mode_check_done = True
779
st = self.transport.stat('.')
780
except errors.TransportNotPossible:
781
self._dir_mode = None
782
self._file_mode = None
784
# Check the directory mode, but also make sure the created
785
# directories and files are read-write for this user. This is
786
# mostly a workaround for filesystems which lie about being able to
787
# write to a directory (cygwin & win32)
788
if (st.st_mode & 07777 == 00000):
789
# FTP allows stat but does not return dir/file modes
790
self._dir_mode = None
791
self._file_mode = None
793
self._dir_mode = (st.st_mode & 07777) | 00700
794
# Remove the sticky and execute bits for files
795
self._file_mode = self._dir_mode & ~07111
797
def _get_file_mode(self):
798
"""Return Unix mode for newly created files, or None.
800
if not self._mode_check_done:
801
self._find_creation_modes()
802
return self._file_mode
804
def _get_dir_mode(self):
805
"""Return Unix mode for newly created directories, or None.
807
if not self._mode_check_done:
808
self._find_creation_modes()
809
return self._dir_mode
811
335
def get_repository_transport(self, repository_format):
812
336
"""Get the transport for use by repository format in this BzrDir.
814
338
Note that bzr dirs that do not support format strings will raise
815
339
IncompatibleFormat if the repository format they are given has
816
a format string, and vice versa.
340
a format string, and vice verca.
818
If repository_format is None, the transport is returned with no
819
checking. If it is not None, then the returned transport is
342
If repository_format is None, the transport is returned with no
343
checking. if it is not None, then the returned transport is
820
344
guaranteed to point to an existing directory ready for use.
822
346
raise NotImplementedError(self.get_repository_transport)
824
348
def get_workingtree_transport(self, tree_format):
825
349
"""Get the transport for use by workingtree format in this BzrDir.
827
351
Note that bzr dirs that do not support format strings will raise
828
IncompatibleFormat if the workingtree format they are given has a
829
format string, and vice versa.
352
IncompatibleFormat if the workingtree format they are given has
353
a format string, and vice verca.
831
If workingtree_format is None, the transport is returned with no
832
checking. If it is not None, then the returned transport is
355
If workingtree_format is None, the transport is returned with no
356
checking. if it is not None, then the returned transport is
833
357
guaranteed to point to an existing directory ready for use.
835
359
raise NotImplementedError(self.get_workingtree_transport)
837
def get_config(self):
838
"""Get configuration for this BzrDir."""
839
return config.BzrDirConfig(self)
841
def _get_config(self):
842
"""By default, no configuration is available."""
845
361
def __init__(self, _transport, _format):
846
362
"""Initialize a Bzr control dir object.
848
364
Only really common logic should reside here, concrete classes should be
849
365
made with varying behaviours.
900
386
def open_unsupported(base):
901
387
"""Open a branch which is not supported."""
902
388
return BzrDir.open(base, _unsupported=True)
905
def open(base, _unsupported=False, possible_transports=None):
906
"""Open an existing bzrdir, rooted at 'base' (url).
908
:param _unsupported: a private parameter to the BzrDir class.
910
t = get_transport(base, possible_transports=possible_transports)
911
return BzrDir.open_from_transport(t, _unsupported=_unsupported)
914
def open_from_transport(transport, _unsupported=False,
915
_server_formats=True):
916
"""Open a bzrdir within a particular directory.
918
:param transport: Transport containing the bzrdir.
919
:param _unsupported: private.
921
for hook in BzrDir.hooks['pre_open']:
923
# Keep initial base since 'transport' may be modified while following
925
base = transport.base
926
def find_format(transport):
927
return transport, BzrDirFormat.find_format(
928
transport, _server_formats=_server_formats)
930
def redirected(transport, e, redirection_notice):
931
redirected_transport = transport._redirected_to(e.source, e.target)
932
if redirected_transport is None:
933
raise errors.NotBranchError(base)
934
note('%s is%s redirected to %s',
935
transport.base, e.permanently, redirected_transport.base)
936
return redirected_transport
939
transport, format = do_catching_redirections(find_format,
942
except errors.TooManyRedirections:
943
raise errors.NotBranchError(base)
945
BzrDir._check_supported(format, _unsupported)
946
return format.open(transport, _found=True)
948
def open_branch(self, name=None, unsupported=False,
949
ignore_fallbacks=False):
391
def open(base, _unsupported=False):
392
"""Open an existing bzrdir, rooted at 'base' (url)
394
_unsupported is a private parameter to the BzrDir class.
396
t = get_transport(base)
397
mutter("trying to open %r with transport %r", base, t)
398
format = BzrDirFormat.find_format(t)
399
if not _unsupported and not format.is_supported():
400
# see open_downlevel to open legacy branches.
401
raise errors.UnsupportedFormatError(
402
'sorry, format %s not supported' % format,
403
['use a different bzr version',
404
'or remove the .bzr directory'
405
' and "bzr init" again'])
406
return format.open(t, _found=True)
408
def open_branch(self, unsupported=False):
950
409
"""Open the branch object at this BzrDir if one is present.
952
411
If unsupported is True, then no longer supported branch formats can
955
414
TODO: static convenience version of this?
957
416
raise NotImplementedError(self.open_branch)
960
def open_containing(url, possible_transports=None):
419
def open_containing(url):
961
420
"""Open an existing branch which contains url.
963
422
:param url: url to search from.
964
423
See open_containing_from_transport for more detail.
966
transport = get_transport(url, possible_transports)
967
return BzrDir.open_containing_from_transport(transport)
425
return BzrDir.open_containing_from_transport(get_transport(url))
970
428
def open_containing_from_transport(a_transport):
971
"""Open an existing branch which contains a_transport.base.
429
"""Open an existing branch which contains a_transport.base
973
431
This probes for a branch at a_transport, and searches upwards from there.
975
433
Basically we keep looking up until we find the control directory or
976
434
run into the root. If there isn't one, raises NotBranchError.
977
If there is one and it is either an unrecognised format or an unsupported
435
If there is one and it is either an unrecognised format or an unsupported
978
436
format, UnknownFormatError or UnsupportedFormatError are raised.
979
437
If there is one, it is returned, along with the unused portion of url.
981
:return: The BzrDir that contains the path, and a Unicode path
982
for the rest of the URL.
984
439
# this gets the normalised url back. I.e. '.' -> the full path.
985
440
url = a_transport.base
988
result = BzrDir.open_from_transport(a_transport)
989
return result, urlutils.unescape(a_transport.relpath(url))
443
format = BzrDirFormat.find_format(a_transport)
444
return format.open(a_transport), a_transport.relpath(url)
990
445
except errors.NotBranchError, e:
993
new_t = a_transport.clone('..')
994
except errors.InvalidURLJoin:
995
# reached the root, whatever that may be
996
raise errors.NotBranchError(path=url)
446
mutter('not a branch in: %r %s', a_transport.base, e)
447
new_t = a_transport.clone('..')
997
448
if new_t.base == a_transport.base:
998
449
# reached the root, whatever that may be
999
450
raise errors.NotBranchError(path=url)
1000
451
a_transport = new_t
1002
def _get_tree_branch(self, name=None):
1003
"""Return the branch and tree, if any, for this bzrdir.
1005
:param name: Name of colocated branch to open.
1007
Return None for tree if not present or inaccessible.
1008
Raise NotBranchError if no branch is present.
1009
:return: (tree, branch)
1012
tree = self.open_workingtree()
1013
except (errors.NoWorkingTree, errors.NotLocalUrl):
1015
branch = self.open_branch(name=name)
1017
if name is not None:
1018
branch = self.open_branch(name=name)
1020
branch = tree.branch
1024
def open_tree_or_branch(klass, location):
1025
"""Return the branch and working tree at a location.
1027
If there is no tree at the location, tree will be None.
1028
If there is no branch at the location, an exception will be
1030
:return: (tree, branch)
1032
bzrdir = klass.open(location)
1033
return bzrdir._get_tree_branch()
1036
def open_containing_tree_or_branch(klass, location):
1037
"""Return the branch and working tree contained by a location.
1039
Returns (tree, branch, relpath).
1040
If there is no tree at containing the location, tree will be None.
1041
If there is no branch containing the location, an exception will be
1043
relpath is the portion of the path that is contained by the branch.
1045
bzrdir, relpath = klass.open_containing(location)
1046
tree, branch = bzrdir._get_tree_branch()
1047
return tree, branch, relpath
1050
def open_containing_tree_branch_or_repository(klass, location):
1051
"""Return the working tree, branch and repo contained by a location.
1053
Returns (tree, branch, repository, relpath).
1054
If there is no tree containing the location, tree will be None.
1055
If there is no branch containing the location, branch will be None.
1056
If there is no repository containing the location, repository will be
1058
relpath is the portion of the path that is contained by the innermost
1061
If no tree, branch or repository is found, a NotBranchError is raised.
1063
bzrdir, relpath = klass.open_containing(location)
1065
tree, branch = bzrdir._get_tree_branch()
1066
except errors.NotBranchError:
1068
repo = bzrdir.find_repository()
1069
return None, None, repo, relpath
1070
except (errors.NoRepositoryPresent):
1071
raise errors.NotBranchError(location)
1072
return tree, branch, branch.repository, relpath
1074
453
def open_repository(self, _unsupported=False):
1075
454
"""Open the repository object at this BzrDir if one is present.
1077
This will not follow the Branch object pointer - it's strictly a direct
456
This will not follow the Branch object pointer - its strictly a direct
1078
457
open facility. Most client code should use open_branch().repository to
1079
458
get at a repository.
1081
:param _unsupported: a private parameter, not part of the api.
460
_unsupported is a private parameter, not part of the api.
1082
461
TODO: static convenience version of this?
1084
463
raise NotImplementedError(self.open_repository)
1086
def open_workingtree(self, _unsupported=False,
1087
recommend_upgrade=True, from_branch=None):
465
def open_workingtree(self, _unsupported=False):
1088
466
"""Open the workingtree object at this BzrDir if one is present.
1090
:param recommend_upgrade: Optional keyword parameter, when True (the
1091
default), emit through the ui module a recommendation that the user
1092
upgrade the working tree when the workingtree being opened is old
1093
(but still fully supported).
1094
:param from_branch: override bzrdir branch (for lightweight checkouts)
468
TODO: static convenience version of this?
1096
470
raise NotImplementedError(self.open_workingtree)
1098
def has_branch(self, name=None):
1099
"""Tell if this bzrdir contains a branch.
1101
Note: if you're going to open the branch, you should just go ahead
1102
and try, and not ask permission first. (This method just opens the
1103
branch and discards it, and that's somewhat expensive.)
1106
self.open_branch(name)
1108
except errors.NotBranchError:
1111
def has_workingtree(self):
1112
"""Tell if this bzrdir contains a working tree.
1114
This will still raise an exception if the bzrdir has a workingtree that
1115
is remote & inaccessible.
1117
Note: if you're going to open the working tree, you should just go ahead
1118
and try, and not ask permission first. (This method just opens the
1119
workingtree and discards it, and that's somewhat expensive.)
1122
self.open_workingtree(recommend_upgrade=False)
1124
except errors.NoWorkingTree:
1127
def _cloning_metadir(self):
1128
"""Produce a metadir suitable for cloning with.
1130
:returns: (destination_bzrdir_format, source_repository)
1132
result_format = self._format.__class__()
1135
branch = self.open_branch(ignore_fallbacks=True)
1136
source_repository = branch.repository
1137
result_format._branch_format = branch._format
1138
except errors.NotBranchError:
1139
source_branch = None
1140
source_repository = self.open_repository()
1141
except errors.NoRepositoryPresent:
1142
source_repository = None
1144
# XXX TODO: This isinstance is here because we have not implemented
1145
# the fix recommended in bug # 103195 - to delegate this choice the
1146
# repository itself.
1147
repo_format = source_repository._format
1148
if isinstance(repo_format, remote.RemoteRepositoryFormat):
1149
source_repository._ensure_real()
1150
repo_format = source_repository._real_repository._format
1151
result_format.repository_format = repo_format
1153
# TODO: Couldn't we just probe for the format in these cases,
1154
# rather than opening the whole tree? It would be a little
1155
# faster. mbp 20070401
1156
tree = self.open_workingtree(recommend_upgrade=False)
1157
except (errors.NoWorkingTree, errors.NotLocalUrl):
1158
result_format.workingtree_format = None
1160
result_format.workingtree_format = tree._format.__class__()
1161
return result_format, source_repository
1163
def cloning_metadir(self, require_stacking=False):
1164
"""Produce a metadir suitable for cloning or sprouting with.
1166
These operations may produce workingtrees (yes, even though they're
1167
"cloning" something that doesn't have a tree), so a viable workingtree
1168
format must be selected.
1170
:require_stacking: If True, non-stackable formats will be upgraded
1171
to similar stackable formats.
1172
:returns: a BzrDirFormat with all component formats either set
1173
appropriately or set to None if that component should not be
1176
format, repository = self._cloning_metadir()
1177
if format._workingtree_format is None:
1179
if repository is None:
1180
# No repository either
1182
# We have a repository, so set a working tree? (Why? This seems to
1183
# contradict the stated return value in the docstring).
1184
tree_format = repository._format._matchingbzrdir.workingtree_format
1185
format.workingtree_format = tree_format.__class__()
1186
if require_stacking:
1187
format.require_stacking()
1190
def checkout_metadir(self):
1191
return self.cloning_metadir()
1193
def sprout(self, url, revision_id=None, force_new_repo=False,
1194
recurse='down', possible_transports=None,
1195
accelerator_tree=None, hardlink=False, stacked=False,
1196
source_branch=None, create_tree_if_local=True):
472
def sprout(self, url, revision_id=None, basis=None, force_new_repo=False):
1197
473
"""Create a copy of this bzrdir prepared for use as a new line of
1200
If url's last component does not exist, it will be created.
476
If urls last component does not exist, it will be created.
1202
478
Attributes related to the identity of the source branch like
1203
479
branch nickname will be cleaned, a working tree is created
1207
483
if revision_id is not None, then the clone operation may tune
1208
484
itself to download less data.
1209
:param accelerator_tree: A tree which can be used for retrieving file
1210
contents more quickly than the revision tree, i.e. a workingtree.
1211
The revision tree will be used for cases where accelerator_tree's
1212
content is different.
1213
:param hardlink: If true, hard-link files from accelerator_tree,
1215
:param stacked: If true, create a stacked branch referring to the
1216
location of this control directory.
1217
:param create_tree_if_local: If true, a working-tree will be created
1218
when working locally.
1220
target_transport = get_transport(url, possible_transports)
1221
target_transport.ensure_base()
1222
cloning_format = self.cloning_metadir(stacked)
1223
# Create/update the result branch
1224
result = cloning_format.initialize_on_transport(target_transport)
1225
# if a stacked branch wasn't requested, we don't create one
1226
# even if the origin was stacked
1227
stacked_branch_url = None
1228
if source_branch is not None:
1230
stacked_branch_url = self.root_transport.base
487
result = self._format.initialize(url)
488
basis_repo, basis_branch, basis_tree = self._get_basis_components(basis)
490
source_branch = self.open_branch()
1231
491
source_repository = source_branch.repository
1234
source_branch = self.open_branch()
1235
source_repository = source_branch.repository
1237
stacked_branch_url = self.root_transport.base
1238
except errors.NotBranchError:
1239
source_branch = None
1241
source_repository = self.open_repository()
1242
except errors.NoRepositoryPresent:
1243
source_repository = None
1244
repository_policy = result.determine_repository_policy(
1245
force_new_repo, stacked_branch_url, require_stacking=stacked)
1246
result_repo, is_new_repo = repository_policy.acquire_repository()
1247
if is_new_repo and revision_id is not None and not stacked:
1248
fetch_spec = graph.PendingAncestryResult(
1249
[revision_id], source_repository)
1252
if source_repository is not None:
1253
# Fetch while stacked to prevent unstacked fetch from
1255
if fetch_spec is None:
1256
result_repo.fetch(source_repository, revision_id=revision_id)
1258
result_repo.fetch(source_repository, fetch_spec=fetch_spec)
1260
if source_branch is None:
1261
# this is for sprouting a bzrdir without a branch; is that
1263
# Not especially, but it's part of the contract.
1264
result_branch = result.create_branch()
1266
result_branch = source_branch.sprout(result,
1267
revision_id=revision_id, repository_policy=repository_policy)
1268
mutter("created new branch %r" % (result_branch,))
1270
# Create/update the result working tree
1271
if (create_tree_if_local and
1272
isinstance(target_transport, local.LocalTransport) and
1273
(result_repo is None or result_repo.make_working_trees())):
1274
wt = result.create_workingtree(accelerator_tree=accelerator_tree,
1278
if wt.path2id('') is None:
1280
wt.set_root_id(self.open_workingtree.get_root_id())
1281
except errors.NoWorkingTree:
1287
if recurse == 'down':
1289
basis = wt.basis_tree()
1291
subtrees = basis.iter_references()
1292
elif result_branch is not None:
1293
basis = result_branch.basis_tree()
1295
subtrees = basis.iter_references()
1296
elif source_branch is not None:
1297
basis = source_branch.basis_tree()
1299
subtrees = basis.iter_references()
1304
for path, file_id in subtrees:
1305
target = urlutils.join(url, urlutils.escape(path))
1306
sublocation = source_branch.reference_parent(file_id, path)
1307
sublocation.bzrdir.sprout(target,
1308
basis.get_reference_revision(file_id, path),
1309
force_new_repo=force_new_repo, recurse=recurse,
1312
if basis is not None:
492
except errors.NotBranchError:
495
source_repository = self.open_repository()
496
except errors.NoRepositoryPresent:
497
# copy the entire basis one if there is one
498
# but there is no repository.
499
source_repository = basis_repo
504
result_repo = result.find_repository()
505
except errors.NoRepositoryPresent:
507
if source_repository is None and result_repo is not None:
509
elif source_repository is None and result_repo is None:
510
# no repo available, make a new one
511
result.create_repository()
512
elif source_repository is not None and result_repo is None:
513
# have soure, and want to make a new target repo
514
source_repository.clone(result,
515
revision_id=revision_id,
518
# fetch needed content into target.
520
# XXX FIXME RBC 20060214 need tests for this when the basis
522
result_repo.fetch(basis_repo, revision_id=revision_id)
523
result_repo.fetch(source_repository, revision_id=revision_id)
524
if source_branch is not None:
525
source_branch.sprout(result, revision_id=revision_id)
527
result.create_branch()
529
self.open_workingtree().clone(result,
530
revision_id=revision_id,
532
except (errors.NoWorkingTree, errors.NotLocalUrl):
533
result.create_workingtree()
1316
def push_branch(self, source, revision_id=None, overwrite=False,
1317
remember=False, create_prefix=False):
1318
"""Push the source branch into this BzrDir."""
1320
# If we can open a branch, use its direct repository, otherwise see
1321
# if there is a repository without a branch.
1323
br_to = self.open_branch()
1324
except errors.NotBranchError:
1325
# Didn't find a branch, can we find a repository?
1326
repository_to = self.find_repository()
1328
# Found a branch, so we must have found a repository
1329
repository_to = br_to.repository
1331
push_result = PushResult()
1332
push_result.source_branch = source
1334
# We have a repository but no branch, copy the revisions, and then
1336
repository_to.fetch(source.repository, revision_id=revision_id)
1337
br_to = source.clone(self, revision_id=revision_id)
1338
if source.get_push_location() is None or remember:
1339
source.set_push_location(br_to.base)
1340
push_result.stacked_on = None
1341
push_result.branch_push_result = None
1342
push_result.old_revno = None
1343
push_result.old_revid = _mod_revision.NULL_REVISION
1344
push_result.target_branch = br_to
1345
push_result.master_branch = None
1346
push_result.workingtree_updated = False
1348
# We have successfully opened the branch, remember if necessary:
1349
if source.get_push_location() is None or remember:
1350
source.set_push_location(br_to.base)
1352
tree_to = self.open_workingtree()
1353
except errors.NotLocalUrl:
1354
push_result.branch_push_result = source.push(br_to,
1355
overwrite, stop_revision=revision_id)
1356
push_result.workingtree_updated = False
1357
except errors.NoWorkingTree:
1358
push_result.branch_push_result = source.push(br_to,
1359
overwrite, stop_revision=revision_id)
1360
push_result.workingtree_updated = None # Not applicable
1362
tree_to.lock_write()
1364
push_result.branch_push_result = source.push(
1365
tree_to.branch, overwrite, stop_revision=revision_id)
1369
push_result.workingtree_updated = True
1370
push_result.old_revno = push_result.branch_push_result.old_revno
1371
push_result.old_revid = push_result.branch_push_result.old_revid
1372
push_result.target_branch = \
1373
push_result.branch_push_result.target_branch
1377
class BzrDirHooks(hooks.Hooks):
1378
"""Hooks for BzrDir operations."""
1381
"""Create the default hooks."""
1382
hooks.Hooks.__init__(self)
1383
self.create_hook(hooks.HookPoint('pre_open',
1384
"Invoked before attempting to open a BzrDir with the transport "
1385
"that the open will use.", (1, 14), None))
1386
self.create_hook(hooks.HookPoint('post_repo_init',
1387
"Invoked after a repository has been initialized. "
1388
"post_repo_init is called with a "
1389
"bzrlib.bzrdir.RepoInitHookParams.",
1392
# install the default hooks
1393
BzrDir.hooks = BzrDirHooks()
1396
class RepoInitHookParams(object):
1397
"""Object holding parameters passed to *_repo_init hooks.
1399
There are 4 fields that hooks may wish to access:
1401
:ivar repository: Repository created
1402
:ivar format: Repository format
1403
:ivar bzrdir: The bzrdir for the repository
1404
:ivar shared: The repository is shared
1407
def __init__(self, repository, format, a_bzrdir, shared):
1408
"""Create a group of RepoInitHook parameters.
1410
:param repository: Repository created
1411
:param format: Repository format
1412
:param bzrdir: The bzrdir for the repository
1413
:param shared: The repository is shared
1415
self.repository = repository
1416
self.format = format
1417
self.bzrdir = a_bzrdir
1418
self.shared = shared
1420
def __eq__(self, other):
1421
return self.__dict__ == other.__dict__
1425
return "<%s for %s>" % (self.__class__.__name__,
1428
return "<%s for %s>" % (self.__class__.__name__,
1432
537
class BzrDirPreSplitOut(BzrDir):
1433
538
"""A common class for the all-in-one formats."""
1973
853
"""Return the ASCII format string that identifies this format."""
1974
854
raise NotImplementedError(self.get_format_string)
1976
def get_format_description(self):
1977
"""Return the short description for this format."""
1978
raise NotImplementedError(self.get_format_description)
1980
856
def get_converter(self, format=None):
1981
857
"""Return the converter to use to convert bzrdirs needing converts.
1983
859
This returns a bzrlib.bzrdir.Converter object.
1985
861
This should return the best upgrader to step this format towards the
1986
current default format. In the case of plugins we can/should provide
862
current default format. In the case of plugins we can/shouold provide
1987
863
some means for them to extend the range of returnable converters.
1989
:param format: Optional format to override the default format of the
865
:param format: Optional format to override the default foramt of the
1992
868
raise NotImplementedError(self.get_converter)
1994
def initialize(self, url, possible_transports=None):
1995
"""Create a bzr control dir at this url and return an opened copy.
1997
While not deprecated, this method is very specific and its use will
1998
lead to many round trips to setup a working environment. See
1999
initialize_on_transport_ex for a [nearly] all-in-one method.
2001
Subclasses should typically override initialize_on_transport
2002
instead of this method.
2004
return self.initialize_on_transport(get_transport(url,
2005
possible_transports))
2007
def initialize_on_transport(self, transport):
2008
"""Initialize a new bzrdir in the base directory of a Transport."""
2010
# can we hand off the request to the smart server rather than using
2012
client_medium = transport.get_smart_medium()
2013
except errors.NoSmartMedium:
2014
return self._initialize_on_transport_vfs(transport)
2016
# Current RPC's only know how to create bzr metadir1 instances, so
2017
# we still delegate to vfs methods if the requested format is not a
2019
if type(self) != BzrDirMetaFormat1:
2020
return self._initialize_on_transport_vfs(transport)
2021
remote_format = RemoteBzrDirFormat()
2022
self._supply_sub_formats_to(remote_format)
2023
return remote_format.initialize_on_transport(transport)
2025
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
2026
create_prefix=False, force_new_repo=False, stacked_on=None,
2027
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
2028
shared_repo=False, vfs_only=False):
2029
"""Create this format on transport.
2031
The directory to initialize will be created.
2033
:param force_new_repo: Do not use a shared repository for the target,
2034
even if one is available.
2035
:param create_prefix: Create any missing directories leading up to
2037
:param use_existing_dir: Use an existing directory if one exists.
2038
:param stacked_on: A url to stack any created branch on, None to follow
2039
any target stacking policy.
2040
:param stack_on_pwd: If stack_on is relative, the location it is
2042
:param repo_format_name: If non-None, a repository will be
2043
made-or-found. Should none be found, or if force_new_repo is True
2044
the repo_format_name is used to select the format of repository to
2046
:param make_working_trees: Control the setting of make_working_trees
2047
for a new shared repository when one is made. None to use whatever
2048
default the format has.
2049
:param shared_repo: Control whether made repositories are shared or
2051
:param vfs_only: If True do not attempt to use a smart server
2052
:return: repo, bzrdir, require_stacking, repository_policy. repo is
2053
None if none was created or found, bzrdir is always valid.
2054
require_stacking is the result of examining the stacked_on
2055
parameter and any stacking policy found for the target.
2058
# Try to hand off to a smart server
2060
client_medium = transport.get_smart_medium()
2061
except errors.NoSmartMedium:
2064
# TODO: lookup the local format from a server hint.
2065
remote_dir_format = RemoteBzrDirFormat()
2066
remote_dir_format._network_name = self.network_name()
2067
self._supply_sub_formats_to(remote_dir_format)
2068
return remote_dir_format.initialize_on_transport_ex(transport,
2069
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2070
force_new_repo=force_new_repo, stacked_on=stacked_on,
2071
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2072
make_working_trees=make_working_trees, shared_repo=shared_repo)
2073
# XXX: Refactor the create_prefix/no_create_prefix code into a
2074
# common helper function
2075
# The destination may not exist - if so make it according to policy.
2076
def make_directory(transport):
2077
transport.mkdir('.')
2079
def redirected(transport, e, redirection_notice):
2080
note(redirection_notice)
2081
return transport._redirected_to(e.source, e.target)
2083
transport = do_catching_redirections(make_directory, transport,
2085
except errors.FileExists:
2086
if not use_existing_dir:
2088
except errors.NoSuchFile:
2089
if not create_prefix:
2091
transport.create_prefix()
2093
require_stacking = (stacked_on is not None)
2094
# Now the target directory exists, but doesn't have a .bzr
2095
# directory. So we need to create it, along with any work to create
2096
# all of the dependent branches, etc.
2098
result = self.initialize_on_transport(transport)
2099
if repo_format_name:
2101
# use a custom format
2102
result._format.repository_format = \
2103
repository.network_format_registry.get(repo_format_name)
2104
except AttributeError:
2105
# The format didn't permit it to be set.
2107
# A repository is desired, either in-place or shared.
2108
repository_policy = result.determine_repository_policy(
2109
force_new_repo, stacked_on, stack_on_pwd,
2110
require_stacking=require_stacking)
2111
result_repo, is_new_repo = repository_policy.acquire_repository(
2112
make_working_trees, shared_repo)
2113
if not require_stacking and repository_policy._require_stacking:
2114
require_stacking = True
2115
result._format.require_stacking()
2116
result_repo.lock_write()
2119
repository_policy = None
2120
return result_repo, result, require_stacking, repository_policy
2122
def _initialize_on_transport_vfs(self, transport):
2123
"""Initialize a new bzrdir using VFS calls.
2125
:param transport: The transport to create the .bzr directory in.
2128
# Since we are creating a .bzr directory, inherit the
870
def initialize(self, url):
871
"""Create a bzr control dir at this url and return an opened copy."""
872
# Since we don't have a .bzr directory, inherit the
2129
873
# mode from the root directory
2130
temp_control = lockable_files.LockableFiles(transport,
2131
'', lockable_files.TransportLock)
874
t = get_transport(url)
875
temp_control = LockableFiles(t, '')
2132
876
temp_control._transport.mkdir('.bzr',
2133
# FIXME: RBC 20060121 don't peek under
877
# FIXME: RBC 20060121 dont peek under
2135
879
mode=temp_control._dir_mode)
2136
if sys.platform == 'win32' and isinstance(transport, local.LocalTransport):
2137
win32utils.set_file_attr_hidden(transport._abspath('.bzr'))
2138
880
file_mode = temp_control._file_mode
2139
881
del temp_control
2140
bzrdir_transport = transport.clone('.bzr')
2141
utf8_files = [('README',
2142
"This is a Bazaar control directory.\n"
2143
"Do not change any files in this directory.\n"
2144
"See http://bazaar-vcs.org/ for more information about Bazaar.\n"),
882
mutter('created control directory in ' + t.base)
883
control = t.clone('.bzr')
884
lock_file = 'branch-lock'
885
utf8_files = [('README',
886
"This is a Bazaar-NG control directory.\n"
887
"Do not change any files in this directory.\n"),
2145
888
('branch-format', self.get_format_string()),
2147
890
# NB: no need to escape relative paths that are url safe.
2148
control_files = lockable_files.LockableFiles(bzrdir_transport,
2149
self._lock_file_name, self._lock_class)
2150
control_files.create_lock()
891
control.put(lock_file, StringIO(), mode=file_mode)
892
control_files = LockableFiles(control, lock_file)
2151
893
control_files.lock_write()
2153
for (filename, content) in utf8_files:
2154
bzrdir_transport.put_bytes(filename, content,
895
for file, content in utf8_files:
896
control_files.put_utf8(file, content)
2157
898
control_files.unlock()
2158
return self.open(transport, _found=True)
899
return self.open(t, _found=True)
2160
901
def is_supported(self):
2161
902
"""Is this format supported?
2163
904
Supported formats must be initializable and openable.
2164
Unsupported formats may not support initialization or committing or
905
Unsupported formats may not support initialization or committing or
2165
906
some other features depending on the reason for not being supported.
2169
def network_name(self):
2170
"""A simple byte string uniquely identifying this format for RPC calls.
2172
Bzr control formats use thir disk format string to identify the format
2173
over the wire. Its possible that other control formats have more
2174
complex detection requirements, so we permit them to use any unique and
2175
immutable string they desire.
2177
raise NotImplementedError(self.network_name)
2179
def same_model(self, target_format):
2180
return (self.repository_format.rich_root_data ==
2181
target_format.rich_root_data)
2184
def known_formats(klass):
2185
"""Return all the known formats.
2187
Concrete formats should override _known_formats.
2189
# There is double indirection here to make sure that control
2190
# formats used by more than one dir format will only be probed
2191
# once. This can otherwise be quite expensive for remote connections.
2193
for format in klass._control_formats:
2194
result.update(format._known_formats())
2198
def _known_formats(klass):
2199
"""Return the known format instances for this control format."""
2200
return set(klass._formats.values())
2202
910
def open(self, transport, _found=False):
2203
911
"""Return an instance of this format for the dir transport points at.
2205
913
_found is a private parameter, do not use it.
2208
found_format = BzrDirFormat.find_format(transport)
2209
if not isinstance(found_format, self.__class__):
2210
raise AssertionError("%s was asked to open %s, but it seems to need "
2212
% (self, transport, found_format))
2213
# Allow subclasses - use the found format.
2214
self._supply_sub_formats_to(found_format)
2215
return found_format._open(transport)
916
assert isinstance(BzrDirFormat.find_format(transport),
2216
918
return self._open(transport)
2218
920
def _open(self, transport):
2317
972
"""Format 4 is not supported.
2319
974
It is not supported because the model changed from 4 to 5 and the
2320
conversion logic is expensive - so doing it on the fly was not
975
conversion logic is expensive - so doing it on the fly was not
2325
def network_name(self):
2326
return self.get_format_string()
2328
980
def _open(self, transport):
2329
981
"""See BzrDirFormat._open."""
2330
982
return BzrDir4(transport, self)
2332
984
def __return_repository_format(self):
2333
985
"""Circular import protection."""
2334
from bzrlib.repofmt.weaverepo import RepositoryFormat4
2335
return RepositoryFormat4()
986
from bzrlib.repository import RepositoryFormat4
987
return RepositoryFormat4(self)
2336
988
repository_format = property(__return_repository_format)
2339
class BzrDirFormatAllInOne(BzrDirFormat):
2340
"""Common class for formats before meta-dirs."""
2342
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
2343
create_prefix=False, force_new_repo=False, stacked_on=None,
2344
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
2346
"""See BzrDirFormat.initialize_on_transport_ex."""
2347
require_stacking = (stacked_on is not None)
2348
# Format 5 cannot stack, but we've been asked to - actually init
2350
if require_stacking:
2351
format = BzrDirMetaFormat1()
2352
return format.initialize_on_transport_ex(transport,
2353
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2354
force_new_repo=force_new_repo, stacked_on=stacked_on,
2355
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2356
make_working_trees=make_working_trees, shared_repo=shared_repo)
2357
return BzrDirFormat.initialize_on_transport_ex(self, transport,
2358
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2359
force_new_repo=force_new_repo, stacked_on=stacked_on,
2360
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2361
make_working_trees=make_working_trees, shared_repo=shared_repo)
2364
class BzrDirFormat5(BzrDirFormatAllInOne):
991
class BzrDirFormat5(BzrDirFormat):
2365
992
"""Bzr control format 5.
2367
994
This format is a combined format for working tree, branch and repository.
2369
- Format 2 working trees [always]
2370
- Format 4 branches [always]
996
- Format 2 working trees [always]
997
- Format 4 branches [always]
2371
998
- Format 5 repositories [always]
2372
999
Unhashed stores in the repository.
2375
_lock_class = lockable_files.TransportLock
2377
1002
def get_format_string(self):
2378
1003
"""See BzrDirFormat.get_format_string()."""
2379
1004
return "Bazaar-NG branch, format 5\n"
2381
def get_branch_format(self):
2382
from bzrlib import branch
2383
return branch.BzrBranchFormat4()
2385
def get_format_description(self):
2386
"""See BzrDirFormat.get_format_description()."""
2387
return "All-in-one format 5"
2389
1006
def get_converter(self, format=None):
2390
1007
"""See BzrDirFormat.get_converter()."""
2391
1008
# there is one and only one upgrade path here.
2392
1009
return ConvertBzrDir5To6()
2394
def _initialize_for_clone(self, url):
2395
return self.initialize_on_transport(get_transport(url), _cloning=True)
2397
def initialize_on_transport(self, transport, _cloning=False):
1011
def initialize(self, url, _cloning=False):
2398
1012
"""Format 5 dirs always have working tree, branch and repository.
2400
1014
Except when they are being cloned.
2402
1016
from bzrlib.branch import BzrBranchFormat4
2403
from bzrlib.repofmt.weaverepo import RepositoryFormat5
2404
result = (super(BzrDirFormat5, self).initialize_on_transport(transport))
1017
from bzrlib.repository import RepositoryFormat5
1018
from bzrlib.workingtree import WorkingTreeFormat2
1019
result = super(BzrDirFormat5, self).initialize(url)
2405
1020
RepositoryFormat5().initialize(result, _internal=True)
2406
1021
if not _cloning:
2407
branch = BzrBranchFormat4().initialize(result)
2408
result._init_workingtree()
1022
BzrBranchFormat4().initialize(result)
1023
WorkingTreeFormat2().initialize(result)
2411
def network_name(self):
2412
return self.get_format_string()
2414
1026
def _open(self, transport):
2415
1027
"""See BzrDirFormat._open."""
2416
1028
return BzrDir5(transport, self)
2418
1030
def __return_repository_format(self):
2419
1031
"""Circular import protection."""
2420
from bzrlib.repofmt.weaverepo import RepositoryFormat5
2421
return RepositoryFormat5()
1032
from bzrlib.repository import RepositoryFormat5
1033
return RepositoryFormat5(self)
2422
1034
repository_format = property(__return_repository_format)
2425
class BzrDirFormat6(BzrDirFormatAllInOne):
1037
class BzrDirFormat6(BzrDirFormat):
2426
1038
"""Bzr control format 6.
2428
1040
This format is a combined format for working tree, branch and repository.
2430
- Format 2 working trees [always]
2431
- Format 4 branches [always]
1042
- Format 2 working trees [always]
1043
- Format 4 branches [always]
2432
1044
- Format 6 repositories [always]
2435
_lock_class = lockable_files.TransportLock
2437
1047
def get_format_string(self):
2438
1048
"""See BzrDirFormat.get_format_string()."""
2439
1049
return "Bazaar-NG branch, format 6\n"
2441
def get_format_description(self):
2442
"""See BzrDirFormat.get_format_description()."""
2443
return "All-in-one format 6"
2445
def get_branch_format(self):
2446
from bzrlib import branch
2447
return branch.BzrBranchFormat4()
2449
1051
def get_converter(self, format=None):
2450
1052
"""See BzrDirFormat.get_converter()."""
2451
1053
# there is one and only one upgrade path here.
2452
1054
return ConvertBzrDir6ToMeta()
2454
def _initialize_for_clone(self, url):
2455
return self.initialize_on_transport(get_transport(url), _cloning=True)
2457
def initialize_on_transport(self, transport, _cloning=False):
1056
def initialize(self, url, _cloning=False):
2458
1057
"""Format 6 dirs always have working tree, branch and repository.
2460
1059
Except when they are being cloned.
2462
1061
from bzrlib.branch import BzrBranchFormat4
2463
from bzrlib.repofmt.weaverepo import RepositoryFormat6
2464
result = super(BzrDirFormat6, self).initialize_on_transport(transport)
1062
from bzrlib.repository import RepositoryFormat6
1063
from bzrlib.workingtree import WorkingTreeFormat2
1064
result = super(BzrDirFormat6, self).initialize(url)
2465
1065
RepositoryFormat6().initialize(result, _internal=True)
2466
1066
if not _cloning:
2467
branch = BzrBranchFormat4().initialize(result)
2468
result._init_workingtree()
1067
BzrBranchFormat4().initialize(result)
1069
WorkingTreeFormat2().initialize(result)
1070
except errors.NotLocalUrl:
1071
# emulate pre-check behaviour for working tree and silently
2471
def network_name(self):
2472
return self.get_format_string()
2474
1076
def _open(self, transport):
2475
1077
"""See BzrDirFormat._open."""
2476
1078
return BzrDir6(transport, self)
2478
1080
def __return_repository_format(self):
2479
1081
"""Circular import protection."""
2480
from bzrlib.repofmt.weaverepo import RepositoryFormat6
2481
return RepositoryFormat6()
1082
from bzrlib.repository import RepositoryFormat6
1083
return RepositoryFormat6(self)
2482
1084
repository_format = property(__return_repository_format)
3179
1654
if not isinstance(repo._format, self.target_format.repository_format.__class__):
3180
1655
from bzrlib.repository import CopyConverter
3181
ui.ui_factory.note('starting repository conversion')
1656
self.pb.note('starting repository conversion')
3182
1657
converter = CopyConverter(self.target_format.repository_format)
3183
1658
converter.convert(repo, pb)
3184
for branch in self.bzrdir.list_branches():
3185
# TODO: conversions of Branch and Tree should be done by
3186
# InterXFormat lookups/some sort of registry.
3187
# Avoid circular imports
3188
from bzrlib import branch as _mod_branch
3189
old = branch._format.__class__
3190
new = self.target_format.get_branch_format().__class__
3192
if (old == _mod_branch.BzrBranchFormat5 and
3193
new in (_mod_branch.BzrBranchFormat6,
3194
_mod_branch.BzrBranchFormat7,
3195
_mod_branch.BzrBranchFormat8)):
3196
branch_converter = _mod_branch.Converter5to6()
3197
elif (old == _mod_branch.BzrBranchFormat6 and
3198
new in (_mod_branch.BzrBranchFormat7,
3199
_mod_branch.BzrBranchFormat8)):
3200
branch_converter = _mod_branch.Converter6to7()
3201
elif (old == _mod_branch.BzrBranchFormat7 and
3202
new is _mod_branch.BzrBranchFormat8):
3203
branch_converter = _mod_branch.Converter7to8()
3205
raise errors.BadConversionTarget("No converter", new,
3207
branch_converter.convert(branch)
3208
branch = self.bzrdir.open_branch()
3209
old = branch._format.__class__
3211
tree = self.bzrdir.open_workingtree(recommend_upgrade=False)
3212
except (errors.NoWorkingTree, errors.NotLocalUrl):
3215
# TODO: conversions of Branch and Tree should be done by
3216
# InterXFormat lookups
3217
if (isinstance(tree, workingtree.WorkingTree3) and
3218
not isinstance(tree, workingtree_4.DirStateWorkingTree) and
3219
isinstance(self.target_format.workingtree_format,
3220
workingtree_4.DirStateWorkingTreeFormat)):
3221
workingtree_4.Converter3to4().convert(tree)
3222
if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
3223
not isinstance(tree, workingtree_4.WorkingTree5) and
3224
isinstance(self.target_format.workingtree_format,
3225
workingtree_4.WorkingTreeFormat5)):
3226
workingtree_4.Converter4to5().convert(tree)
3227
if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
3228
not isinstance(tree, workingtree_4.WorkingTree6) and
3229
isinstance(self.target_format.workingtree_format,
3230
workingtree_4.WorkingTreeFormat6)):
3231
workingtree_4.Converter4or5to6().convert(tree)
3233
1659
return to_convert
3236
# This is not in remote.py because it's relatively small, and needs to be
3237
# registered. Putting it in remote.py creates a circular import problem.
3238
# we can make it a lazy object if the control formats is turned into something
3240
class RemoteBzrDirFormat(BzrDirMetaFormat1):
3241
"""Format representing bzrdirs accessed via a smart server"""
3244
BzrDirMetaFormat1.__init__(self)
3245
# XXX: It's a bit ugly that the network name is here, because we'd
3246
# like to believe that format objects are stateless or at least
3247
# immutable, However, we do at least avoid mutating the name after
3248
# it's returned. See <https://bugs.edge.launchpad.net/bzr/+bug/504102>
3249
self._network_name = None
3252
return "%s(_network_name=%r)" % (self.__class__.__name__,
3255
def get_format_description(self):
3256
if self._network_name:
3257
real_format = network_format_registry.get(self._network_name)
3258
return 'Remote: ' + real_format.get_format_description()
3259
return 'bzr remote bzrdir'
3261
def get_format_string(self):
3262
raise NotImplementedError(self.get_format_string)
3264
def network_name(self):
3265
if self._network_name:
3266
return self._network_name
3268
raise AssertionError("No network name set.")
3271
def probe_transport(klass, transport):
3272
"""Return a RemoteBzrDirFormat object if it looks possible."""
3274
medium = transport.get_smart_medium()
3275
except (NotImplementedError, AttributeError,
3276
errors.TransportNotPossible, errors.NoSmartMedium,
3277
errors.SmartProtocolError):
3278
# no smart server, so not a branch for this format type.
3279
raise errors.NotBranchError(path=transport.base)
3281
# Decline to open it if the server doesn't support our required
3282
# version (3) so that the VFS-based transport will do it.
3283
if medium.should_probe():
3285
server_version = medium.protocol_version()
3286
except errors.SmartProtocolError:
3287
# Apparently there's no usable smart server there, even though
3288
# the medium supports the smart protocol.
3289
raise errors.NotBranchError(path=transport.base)
3290
if server_version != '2':
3291
raise errors.NotBranchError(path=transport.base)
3294
def initialize_on_transport(self, transport):
3296
# hand off the request to the smart server
3297
client_medium = transport.get_smart_medium()
3298
except errors.NoSmartMedium:
3299
# TODO: lookup the local format from a server hint.
3300
local_dir_format = BzrDirMetaFormat1()
3301
return local_dir_format.initialize_on_transport(transport)
3302
client = _SmartClient(client_medium)
3303
path = client.remote_path_from_transport(transport)
3305
response = client.call('BzrDirFormat.initialize', path)
3306
except errors.ErrorFromSmartServer, err:
3307
remote._translate_error(err, path=path)
3308
if response[0] != 'ok':
3309
raise errors.SmartProtocolError('unexpected response code %s' % (response,))
3310
format = RemoteBzrDirFormat()
3311
self._supply_sub_formats_to(format)
3312
return remote.RemoteBzrDir(transport, format)
3314
def parse_NoneTrueFalse(self, arg):
3321
raise AssertionError("invalid arg %r" % arg)
3323
def _serialize_NoneTrueFalse(self, arg):
3330
def _serialize_NoneString(self, arg):
3333
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
3334
create_prefix=False, force_new_repo=False, stacked_on=None,
3335
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
3338
# hand off the request to the smart server
3339
client_medium = transport.get_smart_medium()
3340
except errors.NoSmartMedium:
3343
# Decline to open it if the server doesn't support our required
3344
# version (3) so that the VFS-based transport will do it.
3345
if client_medium.should_probe():
3347
server_version = client_medium.protocol_version()
3348
if server_version != '2':
3352
except errors.SmartProtocolError:
3353
# Apparently there's no usable smart server there, even though
3354
# the medium supports the smart protocol.
3359
client = _SmartClient(client_medium)
3360
path = client.remote_path_from_transport(transport)
3361
if client_medium._is_remote_before((1, 16)):
3364
# TODO: lookup the local format from a server hint.
3365
local_dir_format = BzrDirMetaFormat1()
3366
self._supply_sub_formats_to(local_dir_format)
3367
return local_dir_format.initialize_on_transport_ex(transport,
3368
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3369
force_new_repo=force_new_repo, stacked_on=stacked_on,
3370
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3371
make_working_trees=make_working_trees, shared_repo=shared_repo,
3373
return self._initialize_on_transport_ex_rpc(client, path, transport,
3374
use_existing_dir, create_prefix, force_new_repo, stacked_on,
3375
stack_on_pwd, repo_format_name, make_working_trees, shared_repo)
3377
def _initialize_on_transport_ex_rpc(self, client, path, transport,
3378
use_existing_dir, create_prefix, force_new_repo, stacked_on,
3379
stack_on_pwd, repo_format_name, make_working_trees, shared_repo):
3381
args.append(self._serialize_NoneTrueFalse(use_existing_dir))
3382
args.append(self._serialize_NoneTrueFalse(create_prefix))
3383
args.append(self._serialize_NoneTrueFalse(force_new_repo))
3384
args.append(self._serialize_NoneString(stacked_on))
3385
# stack_on_pwd is often/usually our transport
3388
stack_on_pwd = transport.relpath(stack_on_pwd)
3389
if not stack_on_pwd:
3391
except errors.PathNotChild:
3393
args.append(self._serialize_NoneString(stack_on_pwd))
3394
args.append(self._serialize_NoneString(repo_format_name))
3395
args.append(self._serialize_NoneTrueFalse(make_working_trees))
3396
args.append(self._serialize_NoneTrueFalse(shared_repo))
3397
request_network_name = self._network_name or \
3398
BzrDirFormat.get_default_format().network_name()
3400
response = client.call('BzrDirFormat.initialize_ex_1.16',
3401
request_network_name, path, *args)
3402
except errors.UnknownSmartMethod:
3403
client._medium._remember_remote_is_before((1,16))
3404
local_dir_format = BzrDirMetaFormat1()
3405
self._supply_sub_formats_to(local_dir_format)
3406
return local_dir_format.initialize_on_transport_ex(transport,
3407
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3408
force_new_repo=force_new_repo, stacked_on=stacked_on,
3409
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3410
make_working_trees=make_working_trees, shared_repo=shared_repo,
3412
except errors.ErrorFromSmartServer, err:
3413
remote._translate_error(err, path=path)
3414
repo_path = response[0]
3415
bzrdir_name = response[6]
3416
require_stacking = response[7]
3417
require_stacking = self.parse_NoneTrueFalse(require_stacking)
3418
format = RemoteBzrDirFormat()
3419
format._network_name = bzrdir_name
3420
self._supply_sub_formats_to(format)
3421
bzrdir = remote.RemoteBzrDir(transport, format, _client=client)
3423
repo_format = remote.response_tuple_to_repo_format(response[1:])
3424
if repo_path == '.':
3427
repo_bzrdir_format = RemoteBzrDirFormat()
3428
repo_bzrdir_format._network_name = response[5]
3429
repo_bzr = remote.RemoteBzrDir(transport.clone(repo_path),
3433
final_stack = response[8] or None
3434
final_stack_pwd = response[9] or None
3436
final_stack_pwd = urlutils.join(
3437
transport.base, final_stack_pwd)
3438
remote_repo = remote.RemoteRepository(repo_bzr, repo_format)
3439
if len(response) > 10:
3440
# Updated server verb that locks remotely.
3441
repo_lock_token = response[10] or None
3442
remote_repo.lock_write(repo_lock_token, _skip_rpc=True)
3444
remote_repo.dont_leave_lock_in_place()
3446
remote_repo.lock_write()
3447
policy = UseExistingRepository(remote_repo, final_stack,
3448
final_stack_pwd, require_stacking)
3449
policy.acquire_repository()
3453
bzrdir._format.set_branch_format(self.get_branch_format())
3454
if require_stacking:
3455
# The repo has already been created, but we need to make sure that
3456
# we'll make a stackable branch.
3457
bzrdir._format.require_stacking(_skip_repo=True)
3458
return remote_repo, bzrdir, require_stacking, policy
3460
def _open(self, transport):
3461
return remote.RemoteBzrDir(transport, self)
3463
def __eq__(self, other):
3464
if not isinstance(other, RemoteBzrDirFormat):
3466
return self.get_format_description() == other.get_format_description()
3468
def __return_repository_format(self):
3469
# Always return a RemoteRepositoryFormat object, but if a specific bzr
3470
# repository format has been asked for, tell the RemoteRepositoryFormat
3471
# that it should use that for init() etc.
3472
result = remote.RemoteRepositoryFormat()
3473
custom_format = getattr(self, '_repository_format', None)
3475
if isinstance(custom_format, remote.RemoteRepositoryFormat):
3476
return custom_format
3478
# We will use the custom format to create repositories over the
3479
# wire; expose its details like rich_root_data for code to
3481
result._custom_format = custom_format
3484
def get_branch_format(self):
3485
result = BzrDirMetaFormat1.get_branch_format(self)
3486
if not isinstance(result, remote.RemoteBranchFormat):
3487
new_result = remote.RemoteBranchFormat()
3488
new_result._custom_format = result
3490
self.set_branch_format(new_result)
3494
repository_format = property(__return_repository_format,
3495
BzrDirMetaFormat1._set_repository_format) #.im_func)
3498
BzrDirFormat.register_control_server_format(RemoteBzrDirFormat)
3501
class BzrDirFormatInfo(object):
3503
def __init__(self, native, deprecated, hidden, experimental):
3504
self.deprecated = deprecated
3505
self.native = native
3506
self.hidden = hidden
3507
self.experimental = experimental
3510
class BzrDirFormatRegistry(registry.Registry):
3511
"""Registry of user-selectable BzrDir subformats.
3513
Differs from BzrDirFormat._control_formats in that it provides sub-formats,
3514
e.g. BzrDirMeta1 with weave repository. Also, it's more user-oriented.
3518
"""Create a BzrDirFormatRegistry."""
3519
self._aliases = set()
3520
self._registration_order = list()
3521
super(BzrDirFormatRegistry, self).__init__()
3524
"""Return a set of the format names which are aliases."""
3525
return frozenset(self._aliases)
3527
def register_metadir(self, key,
3528
repository_format, help, native=True, deprecated=False,
3534
"""Register a metadir subformat.
3536
These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
3537
by the Repository/Branch/WorkingTreeformats.
3539
:param repository_format: The fully-qualified repository format class
3541
:param branch_format: Fully-qualified branch format class name as
3543
:param tree_format: Fully-qualified tree format class name as
3546
# This should be expanded to support setting WorkingTree and Branch
3547
# formats, once BzrDirMetaFormat1 supports that.
3548
def _load(full_name):
3549
mod_name, factory_name = full_name.rsplit('.', 1)
3551
mod = __import__(mod_name, globals(), locals(),
3553
except ImportError, e:
3554
raise ImportError('failed to load %s: %s' % (full_name, e))
3556
factory = getattr(mod, factory_name)
3557
except AttributeError:
3558
raise AttributeError('no factory %s in module %r'
3563
bd = BzrDirMetaFormat1()
3564
if branch_format is not None:
3565
bd.set_branch_format(_load(branch_format))
3566
if tree_format is not None:
3567
bd.workingtree_format = _load(tree_format)
3568
if repository_format is not None:
3569
bd.repository_format = _load(repository_format)
3571
self.register(key, helper, help, native, deprecated, hidden,
3572
experimental, alias)
3574
def register(self, key, factory, help, native=True, deprecated=False,
3575
hidden=False, experimental=False, alias=False):
3576
"""Register a BzrDirFormat factory.
3578
The factory must be a callable that takes one parameter: the key.
3579
It must produce an instance of the BzrDirFormat when called.
3581
This function mainly exists to prevent the info object from being
3584
registry.Registry.register(self, key, factory, help,
3585
BzrDirFormatInfo(native, deprecated, hidden, experimental))
3587
self._aliases.add(key)
3588
self._registration_order.append(key)
3590
def register_lazy(self, key, module_name, member_name, help, native=True,
3591
deprecated=False, hidden=False, experimental=False, alias=False):
3592
registry.Registry.register_lazy(self, key, module_name, member_name,
3593
help, BzrDirFormatInfo(native, deprecated, hidden, experimental))
3595
self._aliases.add(key)
3596
self._registration_order.append(key)
3598
def set_default(self, key):
3599
"""Set the 'default' key to be a clone of the supplied key.
3601
This method must be called once and only once.
3603
registry.Registry.register(self, 'default', self.get(key),
3604
self.get_help(key), info=self.get_info(key))
3605
self._aliases.add('default')
3607
def set_default_repository(self, key):
3608
"""Set the FormatRegistry default and Repository default.
3610
This is a transitional method while Repository.set_default_format
3613
if 'default' in self:
3614
self.remove('default')
3615
self.set_default(key)
3616
format = self.get('default')()
3618
def make_bzrdir(self, key):
3619
return self.get(key)()
3621
def help_topic(self, topic):
3623
default_realkey = None
3624
default_help = self.get_help('default')
3626
for key in self._registration_order:
3627
if key == 'default':
3629
help = self.get_help(key)
3630
if help == default_help:
3631
default_realkey = key
3633
help_pairs.append((key, help))
3635
def wrapped(key, help, info):
3637
help = '(native) ' + help
3638
return ':%s:\n%s\n\n' % (key,
3639
textwrap.fill(help, initial_indent=' ',
3640
subsequent_indent=' ',
3641
break_long_words=False))
3642
if default_realkey is not None:
3643
output += wrapped(default_realkey, '(default) %s' % default_help,
3644
self.get_info('default'))
3645
deprecated_pairs = []
3646
experimental_pairs = []
3647
for key, help in help_pairs:
3648
info = self.get_info(key)
3651
elif info.deprecated:
3652
deprecated_pairs.append((key, help))
3653
elif info.experimental:
3654
experimental_pairs.append((key, help))
3656
output += wrapped(key, help, info)
3657
output += "\nSee :doc:`formats-help` for more about storage formats."
3659
if len(experimental_pairs) > 0:
3660
other_output += "Experimental formats are shown below.\n\n"
3661
for key, help in experimental_pairs:
3662
info = self.get_info(key)
3663
other_output += wrapped(key, help, info)
3666
"No experimental formats are available.\n\n"
3667
if len(deprecated_pairs) > 0:
3668
other_output += "\nDeprecated formats are shown below.\n\n"
3669
for key, help in deprecated_pairs:
3670
info = self.get_info(key)
3671
other_output += wrapped(key, help, info)
3674
"\nNo deprecated formats are available.\n\n"
3676
"\nSee :doc:`formats-help` for more about storage formats."
3678
if topic == 'other-formats':
3684
class RepositoryAcquisitionPolicy(object):
3685
"""Abstract base class for repository acquisition policies.
3687
A repository acquisition policy decides how a BzrDir acquires a repository
3688
for a branch that is being created. The most basic policy decision is
3689
whether to create a new repository or use an existing one.
3691
def __init__(self, stack_on, stack_on_pwd, require_stacking):
3694
:param stack_on: A location to stack on
3695
:param stack_on_pwd: If stack_on is relative, the location it is
3697
:param require_stacking: If True, it is a failure to not stack.
3699
self._stack_on = stack_on
3700
self._stack_on_pwd = stack_on_pwd
3701
self._require_stacking = require_stacking
3703
def configure_branch(self, branch):
3704
"""Apply any configuration data from this policy to the branch.
3706
Default implementation sets repository stacking.
3708
if self._stack_on is None:
3710
if self._stack_on_pwd is None:
3711
stack_on = self._stack_on
3714
stack_on = urlutils.rebase_url(self._stack_on,
3717
except errors.InvalidRebaseURLs:
3718
stack_on = self._get_full_stack_on()
3720
branch.set_stacked_on_url(stack_on)
3721
except (errors.UnstackableBranchFormat,
3722
errors.UnstackableRepositoryFormat):
3723
if self._require_stacking:
3726
def requires_stacking(self):
3727
"""Return True if this policy requires stacking."""
3728
return self._stack_on is not None and self._require_stacking
3730
def _get_full_stack_on(self):
3731
"""Get a fully-qualified URL for the stack_on location."""
3732
if self._stack_on is None:
3734
if self._stack_on_pwd is None:
3735
return self._stack_on
3737
return urlutils.join(self._stack_on_pwd, self._stack_on)
3739
def _add_fallback(self, repository, possible_transports=None):
3740
"""Add a fallback to the supplied repository, if stacking is set."""
3741
stack_on = self._get_full_stack_on()
3742
if stack_on is None:
3745
stacked_dir = BzrDir.open(stack_on,
3746
possible_transports=possible_transports)
3747
except errors.JailBreak:
3748
# We keep the stacking details, but we are in the server code so
3749
# actually stacking is not needed.
3752
stacked_repo = stacked_dir.open_branch().repository
3753
except errors.NotBranchError:
3754
stacked_repo = stacked_dir.open_repository()
3756
repository.add_fallback_repository(stacked_repo)
3757
except errors.UnstackableRepositoryFormat:
3758
if self._require_stacking:
3761
self._require_stacking = True
3763
def acquire_repository(self, make_working_trees=None, shared=False):
3764
"""Acquire a repository for this bzrdir.
3766
Implementations may create a new repository or use a pre-exising
3768
:param make_working_trees: If creating a repository, set
3769
make_working_trees to this value (if non-None)
3770
:param shared: If creating a repository, make it shared if True
3771
:return: A repository, is_new_flag (True if the repository was
3774
raise NotImplemented(RepositoryAcquisitionPolicy.acquire_repository)
3777
class CreateRepository(RepositoryAcquisitionPolicy):
3778
"""A policy of creating a new repository"""
3780
def __init__(self, bzrdir, stack_on=None, stack_on_pwd=None,
3781
require_stacking=False):
3784
:param bzrdir: The bzrdir to create the repository on.
3785
:param stack_on: A location to stack on
3786
:param stack_on_pwd: If stack_on is relative, the location it is
3789
RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
3791
self._bzrdir = bzrdir
3793
def acquire_repository(self, make_working_trees=None, shared=False):
3794
"""Implementation of RepositoryAcquisitionPolicy.acquire_repository
3796
Creates the desired repository in the bzrdir we already have.
3798
stack_on = self._get_full_stack_on()
3800
format = self._bzrdir._format
3801
format.require_stacking(stack_on=stack_on,
3802
possible_transports=[self._bzrdir.root_transport])
3803
if not self._require_stacking:
3804
# We have picked up automatic stacking somewhere.
3805
note('Using default stacking branch %s at %s', self._stack_on,
3807
repository = self._bzrdir.create_repository(shared=shared)
3808
self._add_fallback(repository,
3809
possible_transports=[self._bzrdir.transport])
3810
if make_working_trees is not None:
3811
repository.set_make_working_trees(make_working_trees)
3812
return repository, True
3815
class UseExistingRepository(RepositoryAcquisitionPolicy):
3816
"""A policy of reusing an existing repository"""
3818
def __init__(self, repository, stack_on=None, stack_on_pwd=None,
3819
require_stacking=False):
3822
:param repository: The repository to use.
3823
:param stack_on: A location to stack on
3824
:param stack_on_pwd: If stack_on is relative, the location it is
3827
RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
3829
self._repository = repository
3831
def acquire_repository(self, make_working_trees=None, shared=False):
3832
"""Implementation of RepositoryAcquisitionPolicy.acquire_repository
3834
Returns an existing repository to use.
3836
self._add_fallback(self._repository,
3837
possible_transports=[self._repository.bzrdir.transport])
3838
return self._repository, False
3841
# Please register new formats after old formats so that formats
3842
# appear in chronological order and format descriptions can build
3844
format_registry = BzrDirFormatRegistry()
3845
# The pre-0.8 formats have their repository format network name registered in
3846
# repository.py. MetaDir formats have their repository format network name
3847
# inferred from their disk format string.
3848
format_registry.register('weave', BzrDirFormat6,
3849
'Pre-0.8 format. Slower than knit and does not'
3850
' support checkouts or shared repositories.',
3853
format_registry.register_metadir('metaweave',
3854
'bzrlib.repofmt.weaverepo.RepositoryFormat7',
3855
'Transitional format in 0.8. Slower than knit.',
3856
branch_format='bzrlib.branch.BzrBranchFormat5',
3857
tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3860
format_registry.register_metadir('knit',
3861
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3862
'Format using knits. Recommended for interoperation with bzr <= 0.14.',
3863
branch_format='bzrlib.branch.BzrBranchFormat5',
3864
tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3867
format_registry.register_metadir('dirstate',
3868
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3869
help='New in 0.15: Fast local operations. Compatible with bzr 0.8 and '
3870
'above when accessed over the network.',
3871
branch_format='bzrlib.branch.BzrBranchFormat5',
3872
# this uses bzrlib.workingtree.WorkingTreeFormat4 because importing
3873
# directly from workingtree_4 triggers a circular import.
3874
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3877
format_registry.register_metadir('dirstate-tags',
3878
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3879
help='New in 0.15: Fast local operations and improved scaling for '
3880
'network operations. Additionally adds support for tags.'
3881
' Incompatible with bzr < 0.15.',
3882
branch_format='bzrlib.branch.BzrBranchFormat6',
3883
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3886
format_registry.register_metadir('rich-root',
3887
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
3888
help='New in 1.0. Better handling of tree roots. Incompatible with'
3890
branch_format='bzrlib.branch.BzrBranchFormat6',
3891
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3894
format_registry.register_metadir('dirstate-with-subtree',
3895
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
3896
help='New in 0.15: Fast local operations and improved scaling for '
3897
'network operations. Additionally adds support for versioning nested '
3898
'bzr branches. Incompatible with bzr < 0.15.',
3899
branch_format='bzrlib.branch.BzrBranchFormat6',
3900
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3904
format_registry.register_metadir('pack-0.92',
3905
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack1',
3906
help='New in 0.92: Pack-based format with data compatible with '
3907
'dirstate-tags format repositories. Interoperates with '
3908
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3910
branch_format='bzrlib.branch.BzrBranchFormat6',
3911
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3913
format_registry.register_metadir('pack-0.92-subtree',
3914
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack3',
3915
help='New in 0.92: Pack-based format with data compatible with '
3916
'dirstate-with-subtree format repositories. Interoperates with '
3917
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3919
branch_format='bzrlib.branch.BzrBranchFormat6',
3920
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3924
format_registry.register_metadir('rich-root-pack',
3925
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
3926
help='New in 1.0: A variant of pack-0.92 that supports rich-root data '
3927
'(needed for bzr-svn and bzr-git).',
3928
branch_format='bzrlib.branch.BzrBranchFormat6',
3929
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3932
format_registry.register_metadir('1.6',
3933
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5',
3934
help='A format that allows a branch to indicate that there is another '
3935
'(stacked) repository that should be used to access data that is '
3936
'not present locally.',
3937
branch_format='bzrlib.branch.BzrBranchFormat7',
3938
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3941
format_registry.register_metadir('1.6.1-rich-root',
3942
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5RichRoot',
3943
help='A variant of 1.6 that supports rich-root data '
3944
'(needed for bzr-svn and bzr-git).',
3945
branch_format='bzrlib.branch.BzrBranchFormat7',
3946
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3949
format_registry.register_metadir('1.9',
3950
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3951
help='A repository format using B+tree indexes. These indexes '
3952
'are smaller in size, have smarter caching and provide faster '
3953
'performance for most operations.',
3954
branch_format='bzrlib.branch.BzrBranchFormat7',
3955
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3958
format_registry.register_metadir('1.9-rich-root',
3959
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
3960
help='A variant of 1.9 that supports rich-root data '
3961
'(needed for bzr-svn and bzr-git).',
3962
branch_format='bzrlib.branch.BzrBranchFormat7',
3963
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3966
format_registry.register_metadir('1.14',
3967
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3968
help='A working-tree format that supports content filtering.',
3969
branch_format='bzrlib.branch.BzrBranchFormat7',
3970
tree_format='bzrlib.workingtree.WorkingTreeFormat5',
3972
format_registry.register_metadir('1.14-rich-root',
3973
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
3974
help='A variant of 1.14 that supports rich-root data '
3975
'(needed for bzr-svn and bzr-git).',
3976
branch_format='bzrlib.branch.BzrBranchFormat7',
3977
tree_format='bzrlib.workingtree.WorkingTreeFormat5',
3979
# The following un-numbered 'development' formats should always just be aliases.
3980
format_registry.register_metadir('development-rich-root',
3981
'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
3982
help='Current development format. Supports rich roots. Can convert data '
3983
'to and from rich-root-pack (and anything compatible with '
3984
'rich-root-pack) format repositories. Repositories and branches in '
3985
'this format can only be read by bzr.dev. Please read '
3986
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
3988
branch_format='bzrlib.branch.BzrBranchFormat7',
3989
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3994
format_registry.register_metadir('development-subtree',
3995
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment2Subtree',
3996
help='Current development format, subtree variant. Can convert data to and '
3997
'from pack-0.92-subtree (and anything compatible with '
3998
'pack-0.92-subtree) format repositories. Repositories and branches in '
3999
'this format can only be read by bzr.dev. Please read '
4000
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
4002
branch_format='bzrlib.branch.BzrBranchFormat7',
4003
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4006
alias=False, # Restore to being an alias when an actual development subtree format is added
4007
# This current non-alias status is simply because we did not introduce a
4008
# chk based subtree format.
4011
# And the development formats above will have aliased one of the following:
4012
format_registry.register_metadir('development6-rich-root',
4013
'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
4014
help='pack-1.9 with 255-way hashed CHK inv, group compress, rich roots '
4016
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
4018
branch_format='bzrlib.branch.BzrBranchFormat7',
4019
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4024
format_registry.register_metadir('development7-rich-root',
4025
'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK2',
4026
help='pack-1.9 with 255-way hashed CHK inv, bencode revision, group compress, '
4027
'rich roots. Please read '
4028
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
4030
branch_format='bzrlib.branch.BzrBranchFormat7',
4031
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4036
format_registry.register_metadir('2a',
4037
'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
4038
help='First format for bzr 2.0 series.\n'
4039
'Uses group-compress storage.\n'
4040
'Provides rich roots which are a one-way transition.\n',
4041
# 'storage in packs, 255-way hashed CHK inventory, bencode revision, group compress, '
4042
# 'rich roots. Supported by bzr 1.16 and later.',
4043
branch_format='bzrlib.branch.BzrBranchFormat7',
4044
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4048
# The following format should be an alias for the rich root equivalent
4049
# of the default format
4050
format_registry.register_metadir('default-rich-root',
4051
'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
4052
branch_format='bzrlib.branch.BzrBranchFormat7',
4053
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4058
# The current format that is made on 'bzr init'.
4059
format_registry.set_default('2a')
added
removed
bzrlib/bzrdir.py
