1
# Copyright (C) 2005-2010 Canonical Ltd
1
# Copyright (C) 2005, 2006 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
33
from bzrlib.lazy_import import lazy_import
34
lazy_import(globals(), """
35
from stat import S_ISDIR
25
from cStringIO import StringIO
26
from unittest import TestSuite
49
revision as _mod_revision,
29
import bzrlib.errors as errors
30
from bzrlib.lockable_files import LockableFiles, TransportLock
31
from bzrlib.lockdir import LockDir
32
from bzrlib.osutils import safe_unicode
59
33
from bzrlib.osutils import (
62
from bzrlib.push import (
65
from bzrlib.repofmt import pack_repo
66
from bzrlib.smart.client import _SmartClient
40
from bzrlib.store.revision.text import TextRevisionStore
41
from bzrlib.store.text import TextStore
67
42
from bzrlib.store.versioned import WeaveStore
43
from bzrlib.symbol_versioning import *
44
from bzrlib.trace import mutter
68
45
from bzrlib.transactions import WriteTransaction
69
from bzrlib.transport import (
70
do_catching_redirections,
46
from bzrlib.transport import get_transport, urlunescape
47
from bzrlib.transport.local import LocalTransport
74
48
from bzrlib.weave import Weave
77
from bzrlib.trace import (
49
from bzrlib.xml4 import serializer_v4
50
from bzrlib.xml5 import serializer_v5
90
53
class BzrDir(object):
91
54
"""A .bzr control diretory.
93
56
BzrDir instances let you create or open any of the things that can be
94
57
found within .bzr - checkouts, branches and repositories.
97
60
the transport which this bzr dir is rooted at (i.e. file:///.../.bzr/)
99
a transport connected to the directory this bzr was opened from
100
(i.e. the parent directory holding the .bzr directory).
102
Everything in the bzrdir should have the same file permissions.
104
:cvar hooks: An instance of BzrDirHooks.
62
a transport connected to the directory this bzr was opened from.
107
def break_lock(self):
108
"""Invoke break_lock on the first object in the bzrdir.
110
If there is a tree, the tree is opened and break_lock() called.
111
Otherwise, branch is tried, and finally repository.
113
# XXX: This seems more like a UI function than something that really
114
# belongs in this class.
116
thing_to_unlock = self.open_workingtree()
117
except (errors.NotLocalUrl, errors.NoWorkingTree):
119
thing_to_unlock = self.open_branch()
120
except errors.NotBranchError:
122
thing_to_unlock = self.open_repository()
123
except errors.NoRepositoryPresent:
125
thing_to_unlock.break_lock()
127
65
def can_convert_format(self):
128
66
"""Return true if this bzrdir is one whose format we can convert from."""
131
def check_conversion_target(self, target_format):
132
"""Check that a bzrdir as a whole can be converted to a new format."""
133
# The only current restriction is that the repository content can be
134
# fetched compatibly with the target.
135
target_repo_format = target_format.repository_format
137
self.open_repository()._format.check_conversion_target(
139
except errors.NoRepositoryPresent:
140
# No repo, no problem.
144
def _check_supported(format, allow_unsupported,
145
recommend_upgrade=True,
147
"""Give an error or warning on old formats.
149
:param format: may be any kind of format - workingtree, branch,
152
:param allow_unsupported: If true, allow opening
153
formats that are strongly deprecated, and which may
154
have limited functionality.
156
:param recommend_upgrade: If true (default), warn
157
the user through the ui object that they may wish
158
to upgrade the object.
70
def _check_supported(format, allow_unsupported):
71
"""Check whether format is a supported format.
73
If allow_unsupported is True, this is a no-op.
160
# TODO: perhaps move this into a base Format class; it's not BzrDir
161
# specific. mbp 20070323
162
75
if not allow_unsupported and not format.is_supported():
163
76
# see open_downlevel to open legacy branches.
164
raise errors.UnsupportedFormatError(format=format)
165
if recommend_upgrade \
166
and getattr(format, 'upgrade_recommended', False):
167
ui.ui_factory.recommend_upgrade(
168
format.get_format_description(),
77
raise errors.UnsupportedFormatError(
78
'sorry, format %s not supported' % format,
79
['use a different bzr version',
80
'or remove the .bzr directory'
81
' and "bzr init" again'])
171
def clone(self, url, revision_id=None, force_new_repo=False,
172
preserve_stacking=False):
83
def clone(self, url, revision_id=None, basis=None, force_new_repo=False):
173
84
"""Clone this bzrdir and its contents to url verbatim.
175
:param url: The url create the clone at. If url's last component does
176
not exist, it will be created.
177
:param revision_id: The tip revision-id to use for any branch or
178
working tree. If not None, then the clone operation may tune
179
itself to download less data.
180
:param force_new_repo: Do not use a shared repository for the target
181
even if one is available.
182
:param preserve_stacking: When cloning a stacked branch, stack the
183
new branch on top of the other branch's stacked-on branch.
185
return self.clone_on_transport(get_transport(url),
186
revision_id=revision_id,
187
force_new_repo=force_new_repo,
188
preserve_stacking=preserve_stacking)
190
def clone_on_transport(self, transport, revision_id=None,
191
force_new_repo=False, preserve_stacking=False, stacked_on=None,
192
create_prefix=False, use_existing_dir=True):
193
"""Clone this bzrdir and its contents to transport verbatim.
195
:param transport: The transport for the location to produce the clone
196
at. If the target directory does not exist, it will be created.
197
:param revision_id: The tip revision-id to use for any branch or
198
working tree. If not None, then the clone operation may tune
199
itself to download less data.
200
:param force_new_repo: Do not use a shared repository for the target,
201
even if one is available.
202
:param preserve_stacking: When cloning a stacked branch, stack the
203
new branch on top of the other branch's stacked-on branch.
204
:param create_prefix: Create any missing directories leading up to
206
:param use_existing_dir: Use an existing directory if one exists.
208
# Overview: put together a broad description of what we want to end up
209
# with; then make as few api calls as possible to do it.
211
# We may want to create a repo/branch/tree, if we do so what format
212
# would we want for each:
213
require_stacking = (stacked_on is not None)
214
format = self.cloning_metadir(require_stacking)
216
# Figure out what objects we want:
86
If urls last component does not exist, it will be created.
88
if revision_id is not None, then the clone operation may tune
89
itself to download less data.
90
:param force_new_repo: Do not use a shared repository for the target
91
even if one is available.
94
basis_repo, basis_branch, basis_tree = self._get_basis_components(basis)
95
result = self._format.initialize(url)
218
97
local_repo = self.find_repository()
219
98
except errors.NoRepositoryPresent:
222
local_branch = self.open_branch()
223
except errors.NotBranchError:
226
# enable fallbacks when branch is not a branch reference
227
if local_branch.repository.has_same_location(local_repo):
228
local_repo = local_branch.repository
229
if preserve_stacking:
231
stacked_on = local_branch.get_stacked_on_url()
232
except (errors.UnstackableBranchFormat,
233
errors.UnstackableRepositoryFormat,
236
# Bug: We create a metadir without knowing if it can support stacking,
237
# we should look up the policy needs first, or just use it as a hint,
240
make_working_trees = local_repo.make_working_trees()
241
want_shared = local_repo.is_shared()
242
repo_format_name = format.repository_format.network_name()
244
make_working_trees = False
246
repo_format_name = None
248
result_repo, result, require_stacking, repository_policy = \
249
format.initialize_on_transport_ex(transport,
250
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
251
force_new_repo=force_new_repo, stacked_on=stacked_on,
252
stack_on_pwd=self.root_transport.base,
253
repo_format_name=repo_format_name,
254
make_working_trees=make_working_trees, shared_repo=want_shared)
257
# If the result repository is in the same place as the
258
# resulting bzr dir, it will have no content, further if the
259
# result is not stacked then we know all content should be
260
# copied, and finally if we are copying up to a specific
261
# revision_id then we can use the pending-ancestry-result which
262
# does not require traversing all of history to describe it.
263
if (result_repo.bzrdir.root_transport.base ==
264
result.root_transport.base and not require_stacking and
265
revision_id is not None):
266
fetch_spec = graph.PendingAncestryResult(
267
[revision_id], local_repo)
268
result_repo.fetch(local_repo, fetch_spec=fetch_spec)
101
# may need to copy content in
103
local_repo.clone(result, revision_id=revision_id, basis=basis_repo)
106
result_repo = result.find_repository()
107
# fetch content this dir needs.
109
# XXX FIXME RBC 20060214 need tests for this when the basis
111
result_repo.fetch(basis_repo, revision_id=revision_id)
270
112
result_repo.fetch(local_repo, revision_id=revision_id)
274
if result_repo is not None:
275
raise AssertionError('result_repo not None(%r)' % result_repo)
113
except errors.NoRepositoryPresent:
114
# needed to make one anyway.
115
local_repo.clone(result, revision_id=revision_id, basis=basis_repo)
276
116
# 1 if there is a branch present
277
117
# make sure its content is available in the target repository
279
if local_branch is not None:
280
result_branch = local_branch.clone(result, revision_id=revision_id,
281
repository_policy=repository_policy)
283
# Cheaper to check if the target is not local, than to try making
285
result.root_transport.local_abspath('.')
286
if result_repo is None or result_repo.make_working_trees():
287
self.open_workingtree().clone(result)
120
self.open_branch().clone(result, revision_id=revision_id)
121
except errors.NotBranchError:
124
self.open_workingtree().clone(result, basis=basis_tree)
288
125
except (errors.NoWorkingTree, errors.NotLocalUrl):
292
# TODO: This should be given a Transport, and should chdir up; otherwise
293
# this will open a new connection.
129
def _get_basis_components(self, basis):
130
"""Retrieve the basis components that are available at basis."""
132
return None, None, None
134
basis_tree = basis.open_workingtree()
135
basis_branch = basis_tree.branch
136
basis_repo = basis_branch.repository
137
except (errors.NoWorkingTree, errors.NotLocalUrl):
140
basis_branch = basis.open_branch()
141
basis_repo = basis_branch.repository
142
except errors.NotBranchError:
145
basis_repo = basis.open_repository()
146
except errors.NoRepositoryPresent:
148
return basis_repo, basis_branch, basis_tree
294
150
def _make_tail(self, url):
295
t = get_transport(url)
151
segments = url.split('/')
152
if segments and segments[-1] not in ('', '.'):
153
parent = '/'.join(segments[:-1])
154
t = bzrlib.transport.get_transport(parent)
156
t.mkdir(segments[-1])
157
except errors.FileExists:
299
def create(cls, base, format=None, possible_transports=None):
161
def create(cls, base):
300
162
"""Create a new BzrDir at the url 'base'.
164
This will call the current default formats initialize with base
165
as the only parameter.
302
:param format: If supplied, the format of branch to create. If not
303
supplied, the default is used.
304
:param possible_transports: If supplied, a list of transports that
305
can be reused to share a remote connection.
167
If you need a specific format, consider creating an instance
168
of that and calling initialize().
307
170
if cls is not BzrDir:
308
raise AssertionError("BzrDir.create always creates the default"
309
" format, not one of %r" % cls)
310
t = get_transport(base, possible_transports)
313
format = BzrDirFormat.get_default_format()
314
return format.initialize_on_transport(t)
317
def find_bzrdirs(transport, evaluate=None, list_current=None):
318
"""Find bzrdirs recursively from current location.
320
This is intended primarily as a building block for more sophisticated
321
functionality, like finding trees under a directory, or finding
322
branches that use a given repository.
323
:param evaluate: An optional callable that yields recurse, value,
324
where recurse controls whether this bzrdir is recursed into
325
and value is the value to yield. By default, all bzrdirs
326
are recursed into, and the return value is the bzrdir.
327
:param list_current: if supplied, use this function to list the current
328
directory, instead of Transport.list_dir
329
:return: a generator of found bzrdirs, or whatever evaluate returns.
331
if list_current is None:
332
def list_current(transport):
333
return transport.list_dir('')
335
def evaluate(bzrdir):
338
pending = [transport]
339
while len(pending) > 0:
340
current_transport = pending.pop()
343
bzrdir = BzrDir.open_from_transport(current_transport)
344
except errors.NotBranchError:
347
recurse, value = evaluate(bzrdir)
350
subdirs = list_current(current_transport)
351
except errors.NoSuchFile:
354
for subdir in sorted(subdirs, reverse=True):
355
pending.append(current_transport.clone(subdir))
358
def find_branches(transport):
359
"""Find all branches under a transport.
361
This will find all branches below the transport, including branches
362
inside other branches. Where possible, it will use
363
Repository.find_branches.
365
To list all the branches that use a particular Repository, see
366
Repository.find_branches
368
def evaluate(bzrdir):
370
repository = bzrdir.open_repository()
371
except errors.NoRepositoryPresent:
374
return False, (None, repository)
376
branch = bzrdir.open_branch()
377
except errors.NotBranchError:
378
return True, (None, None)
380
return True, (branch, None)
382
for branch, repo in BzrDir.find_bzrdirs(transport, evaluate=evaluate):
384
branches.extend(repo.find_branches())
385
if branch is not None:
386
branches.append(branch)
389
def destroy_repository(self):
390
"""Destroy the repository in this BzrDir"""
391
raise NotImplementedError(self.destroy_repository)
171
raise AssertionError("BzrDir.create always creates the default format, "
172
"not one of %r" % cls)
173
segments = base.split('/')
174
if segments and segments[-1] not in ('', '.'):
175
parent = '/'.join(segments[:-1])
176
t = bzrlib.transport.get_transport(parent)
178
t.mkdir(segments[-1])
179
except errors.FileExists:
181
return BzrDirFormat.get_default_format().initialize(safe_unicode(base))
393
183
def create_branch(self):
394
184
"""Create a branch in this BzrDir.
396
The bzrdir's format will control what branch format is created.
186
The bzrdirs format will control what branch format is created.
397
187
For more control see BranchFormatXX.create(a_bzrdir).
399
189
raise NotImplementedError(self.create_branch)
401
def destroy_branch(self):
402
"""Destroy the branch in this BzrDir"""
403
raise NotImplementedError(self.destroy_branch)
406
def create_branch_and_repo(base, force_new_repo=False, format=None):
192
def create_branch_and_repo(base, force_new_repo=False):
407
193
"""Create a new BzrDir, Branch and Repository at the url 'base'.
409
This will use the current default BzrDirFormat unless one is
410
specified, and use whatever
195
This will use the current default BzrDirFormat, and use whatever
411
196
repository format that that uses via bzrdir.create_branch and
412
197
create_repository. If a shared repository is available that is used
509
232
The created Branch object is returned.
510
233
If a working tree cannot be made due to base not being a file:// url,
511
no error is raised unless force_new_tree is True, in which case no
234
no error is raised unless force_new_tree is True, in which case no
512
235
data is created on disk and NotLocalUrl is raised.
514
237
:param base: The URL to create the branch at.
515
238
:param force_new_repo: If True a new repository is always created.
516
:param force_new_tree: If True or False force creation of a tree or
239
:param force_new_tree: If True or False force creation of a tree or
517
240
prevent such creation respectively.
518
:param format: Override for the bzrdir format to create.
519
:param possible_transports: An optional reusable transports list.
521
242
if force_new_tree:
522
243
# check for non local urls
523
t = get_transport(base, possible_transports)
524
if not isinstance(t, local.LocalTransport):
244
t = get_transport(safe_unicode(base))
245
if not isinstance(t, LocalTransport):
525
246
raise errors.NotLocalUrl(base)
526
bzrdir = BzrDir.create(base, format, possible_transports)
247
bzrdir = BzrDir.create(base)
527
248
repo = bzrdir._find_or_create_repository(force_new_repo)
528
249
result = bzrdir.create_branch()
529
if force_new_tree or (repo.make_working_trees() and
250
if force_new_tree or (repo.make_working_trees() and
530
251
force_new_tree is None):
532
253
bzrdir.create_workingtree()
533
254
except errors.NotLocalUrl:
538
def create_standalone_workingtree(base, format=None):
259
def create_repository(base, shared=False):
260
"""Create a new BzrDir and Repository at the url 'base'.
262
This will use the current default BzrDirFormat, and use whatever
263
repository format that that uses for bzrdirformat.create_repository.
265
;param shared: Create a shared repository rather than a standalone
267
The Repository object is returned.
269
This must be overridden as an instance method in child classes, where
270
it should take no parameters and construct whatever repository format
271
that child class desires.
273
bzrdir = BzrDir.create(base)
274
return bzrdir.create_repository()
277
def create_standalone_workingtree(base):
539
278
"""Create a new BzrDir, WorkingTree, Branch and Repository at 'base'.
541
280
'base' must be a local path or a file:// url.
543
This will use the current default BzrDirFormat unless one is
544
specified, and use whatever
282
This will use the current default BzrDirFormat, and use whatever
545
283
repository format that that uses for bzrdirformat.create_workingtree,
546
284
create_branch and create_repository.
548
:param format: Override for the bzrdir format to create.
549
:return: The WorkingTree object.
286
The WorkingTree object is returned.
551
t = get_transport(base)
552
if not isinstance(t, local.LocalTransport):
288
t = get_transport(safe_unicode(base))
289
if not isinstance(t, LocalTransport):
553
290
raise errors.NotLocalUrl(base)
554
bzrdir = BzrDir.create_branch_and_repo(base,
556
format=format).bzrdir
291
bzrdir = BzrDir.create_branch_and_repo(safe_unicode(base),
292
force_new_repo=True).bzrdir
557
293
return bzrdir.create_workingtree()
559
def create_workingtree(self, revision_id=None, from_branch=None,
560
accelerator_tree=None, hardlink=False):
295
def create_workingtree(self, revision_id=None):
561
296
"""Create a working tree at this BzrDir.
563
:param revision_id: create it as of this revision id.
564
:param from_branch: override bzrdir branch (for lightweight checkouts)
565
:param accelerator_tree: A tree which can be used for retrieving file
566
contents more quickly than the revision tree, i.e. a workingtree.
567
The revision tree will be used for cases where accelerator_tree's
568
content is different.
298
revision_id: create it as of this revision id.
570
300
raise NotImplementedError(self.create_workingtree)
572
def backup_bzrdir(self):
573
"""Backup this bzr control directory.
575
:return: Tuple with old path name and new path name
577
pb = ui.ui_factory.nested_progress_bar()
579
# FIXME: bug 300001 -- the backup fails if the backup directory
580
# already exists, but it should instead either remove it or make
581
# a new backup directory.
583
# FIXME: bug 262450 -- the backup directory should have the same
584
# permissions as the .bzr directory (probably a bug in copy_tree)
585
old_path = self.root_transport.abspath('.bzr')
586
new_path = self.root_transport.abspath('backup.bzr')
587
ui.ui_factory.note('making backup of %s\n to %s' % (old_path, new_path,))
588
self.root_transport.copy_tree('.bzr', 'backup.bzr')
589
return (old_path, new_path)
593
def retire_bzrdir(self, limit=10000):
594
"""Permanently disable the bzrdir.
596
This is done by renaming it to give the user some ability to recover
597
if there was a problem.
599
This will have horrible consequences if anyone has anything locked or
601
:param limit: number of times to retry
606
to_path = '.bzr.retired.%d' % i
607
self.root_transport.rename('.bzr', to_path)
608
note("renamed %s to %s"
609
% (self.root_transport.abspath('.bzr'), to_path))
611
except (errors.TransportError, IOError, errors.PathError):
618
def destroy_workingtree(self):
619
"""Destroy the working tree at this BzrDir.
621
Formats that do not support this may raise UnsupportedOperation.
623
raise NotImplementedError(self.destroy_workingtree)
625
def destroy_workingtree_metadata(self):
626
"""Destroy the control files for the working tree at this BzrDir.
628
The contents of working tree files are not affected.
629
Formats that do not support this may raise UnsupportedOperation.
631
raise NotImplementedError(self.destroy_workingtree_metadata)
633
def _find_containing(self, evaluate):
634
"""Find something in a containing control directory.
636
This method will scan containing control dirs, until it finds what
637
it is looking for, decides that it will never find it, or runs out
638
of containing control directories to check.
640
It is used to implement find_repository and
641
determine_repository_policy.
643
:param evaluate: A function returning (value, stop). If stop is True,
644
the value will be returned.
648
result, stop = evaluate(found_bzrdir)
651
next_transport = found_bzrdir.root_transport.clone('..')
652
if (found_bzrdir.root_transport.base == next_transport.base):
653
# top of the file system
655
# find the next containing bzrdir
657
found_bzrdir = BzrDir.open_containing_from_transport(
659
except errors.NotBranchError:
662
302
def find_repository(self):
663
"""Find the repository that should be used.
303
"""Find the repository that should be used for a_bzrdir.
665
305
This does not require a branch as we use it to find the repo for
666
306
new branches as well as to hook existing branches up to their
669
def usable_repository(found_bzrdir):
670
# does it have a repository ?
310
return self.open_repository()
311
except errors.NoRepositoryPresent:
313
next_transport = self.root_transport.clone('..')
316
found_bzrdir = BzrDir.open_containing_from_transport(
318
except errors.NotBranchError:
319
raise errors.NoRepositoryPresent(self)
672
321
repository = found_bzrdir.open_repository()
673
322
except errors.NoRepositoryPresent:
675
if found_bzrdir.root_transport.base == self.root_transport.base:
676
return repository, True
677
elif repository.is_shared():
678
return repository, True
323
next_transport = found_bzrdir.root_transport.clone('..')
325
if ((found_bzrdir.root_transport.base ==
326
self.root_transport.base) or repository.is_shared()):
682
found_repo = self._find_containing(usable_repository)
683
if found_repo is None:
684
raise errors.NoRepositoryPresent(self)
687
def get_branch_reference(self):
688
"""Return the referenced URL for the branch in this bzrdir.
690
:raises NotBranchError: If there is no Branch.
691
:return: The URL the branch in this bzrdir references if it is a
692
reference branch, or None for regular branches.
329
raise errors.NoRepositoryPresent(self)
330
raise errors.NoRepositoryPresent(self)
696
332
def get_branch_transport(self, branch_format):
697
333
"""Get the transport for use by branch format in this BzrDir.
699
335
Note that bzr dirs that do not support format strings will raise
700
336
IncompatibleFormat if the branch format they are given has
701
a format string, and vice versa.
337
a format string, and vice verca.
703
If branch_format is None, the transport is returned with no
704
checking. If it is not None, then the returned transport is
339
If branch_format is None, the transport is returned with no
340
checking. if it is not None, then the returned transport is
705
341
guaranteed to point to an existing directory ready for use.
707
343
raise NotImplementedError(self.get_branch_transport)
709
def _find_creation_modes(self):
710
"""Determine the appropriate modes for files and directories.
712
They're always set to be consistent with the base directory,
713
assuming that this transport allows setting modes.
715
# TODO: Do we need or want an option (maybe a config setting) to turn
716
# this off or override it for particular locations? -- mbp 20080512
717
if self._mode_check_done:
719
self._mode_check_done = True
721
st = self.transport.stat('.')
722
except errors.TransportNotPossible:
723
self._dir_mode = None
724
self._file_mode = None
726
# Check the directory mode, but also make sure the created
727
# directories and files are read-write for this user. This is
728
# mostly a workaround for filesystems which lie about being able to
729
# write to a directory (cygwin & win32)
730
if (st.st_mode & 07777 == 00000):
731
# FTP allows stat but does not return dir/file modes
732
self._dir_mode = None
733
self._file_mode = None
735
self._dir_mode = (st.st_mode & 07777) | 00700
736
# Remove the sticky and execute bits for files
737
self._file_mode = self._dir_mode & ~07111
739
def _get_file_mode(self):
740
"""Return Unix mode for newly created files, or None.
742
if not self._mode_check_done:
743
self._find_creation_modes()
744
return self._file_mode
746
def _get_dir_mode(self):
747
"""Return Unix mode for newly created directories, or None.
749
if not self._mode_check_done:
750
self._find_creation_modes()
751
return self._dir_mode
753
345
def get_repository_transport(self, repository_format):
754
346
"""Get the transport for use by repository format in this BzrDir.
756
348
Note that bzr dirs that do not support format strings will raise
757
349
IncompatibleFormat if the repository format they are given has
758
a format string, and vice versa.
350
a format string, and vice verca.
760
If repository_format is None, the transport is returned with no
761
checking. If it is not None, then the returned transport is
352
If repository_format is None, the transport is returned with no
353
checking. if it is not None, then the returned transport is
762
354
guaranteed to point to an existing directory ready for use.
764
356
raise NotImplementedError(self.get_repository_transport)
766
358
def get_workingtree_transport(self, tree_format):
767
359
"""Get the transport for use by workingtree format in this BzrDir.
769
361
Note that bzr dirs that do not support format strings will raise
770
IncompatibleFormat if the workingtree format they are given has a
771
format string, and vice versa.
362
IncompatibleFormat if the workingtree format they are given has
363
a format string, and vice verca.
773
If workingtree_format is None, the transport is returned with no
774
checking. If it is not None, then the returned transport is
365
If workingtree_format is None, the transport is returned with no
366
checking. if it is not None, then the returned transport is
775
367
guaranteed to point to an existing directory ready for use.
777
369
raise NotImplementedError(self.get_workingtree_transport)
779
def get_config(self):
780
"""Get configuration for this BzrDir."""
781
return config.BzrDirConfig(self)
783
def _get_config(self):
784
"""By default, no configuration is available."""
787
371
def __init__(self, _transport, _format):
788
372
"""Initialize a Bzr control dir object.
790
374
Only really common logic should reside here, concrete classes should be
791
375
made with varying behaviours.
832
396
def open_unsupported(base):
833
397
"""Open a branch which is not supported."""
834
398
return BzrDir.open(base, _unsupported=True)
837
def open(base, _unsupported=False, possible_transports=None):
838
"""Open an existing bzrdir, rooted at 'base' (url).
840
:param _unsupported: a private parameter to the BzrDir class.
842
t = get_transport(base, possible_transports=possible_transports)
843
return BzrDir.open_from_transport(t, _unsupported=_unsupported)
846
def open_from_transport(transport, _unsupported=False,
847
_server_formats=True):
848
"""Open a bzrdir within a particular directory.
850
:param transport: Transport containing the bzrdir.
851
:param _unsupported: private.
853
for hook in BzrDir.hooks['pre_open']:
855
# Keep initial base since 'transport' may be modified while following
857
base = transport.base
858
def find_format(transport):
859
return transport, BzrDirFormat.find_format(
860
transport, _server_formats=_server_formats)
862
def redirected(transport, e, redirection_notice):
863
redirected_transport = transport._redirected_to(e.source, e.target)
864
if redirected_transport is None:
865
raise errors.NotBranchError(base)
866
note('%s is%s redirected to %s',
867
transport.base, e.permanently, redirected_transport.base)
868
return redirected_transport
871
transport, format = do_catching_redirections(find_format,
874
except errors.TooManyRedirections:
875
raise errors.NotBranchError(base)
401
def open(base, _unsupported=False):
402
"""Open an existing bzrdir, rooted at 'base' (url)
404
_unsupported is a private parameter to the BzrDir class.
406
t = get_transport(base)
407
mutter("trying to open %r with transport %r", base, t)
408
format = BzrDirFormat.find_format(t)
877
409
BzrDir._check_supported(format, _unsupported)
878
return format.open(transport, _found=True)
410
return format.open(t, _found=True)
880
def open_branch(self, unsupported=False, ignore_fallbacks=False):
412
def open_branch(self, unsupported=False):
881
413
"""Open the branch object at this BzrDir if one is present.
883
415
If unsupported is True, then no longer supported branch formats can
886
418
TODO: static convenience version of this?
888
420
raise NotImplementedError(self.open_branch)
891
def open_containing(url, possible_transports=None):
423
def open_containing(url):
892
424
"""Open an existing branch which contains url.
894
426
:param url: url to search from.
895
427
See open_containing_from_transport for more detail.
897
transport = get_transport(url, possible_transports)
898
return BzrDir.open_containing_from_transport(transport)
429
return BzrDir.open_containing_from_transport(get_transport(url))
901
432
def open_containing_from_transport(a_transport):
902
"""Open an existing branch which contains a_transport.base.
433
"""Open an existing branch which contains a_transport.base
904
435
This probes for a branch at a_transport, and searches upwards from there.
906
437
Basically we keep looking up until we find the control directory or
907
438
run into the root. If there isn't one, raises NotBranchError.
908
If there is one and it is either an unrecognised format or an unsupported
439
If there is one and it is either an unrecognised format or an unsupported
909
440
format, UnknownFormatError or UnsupportedFormatError are raised.
910
441
If there is one, it is returned, along with the unused portion of url.
912
:return: The BzrDir that contains the path, and a Unicode path
913
for the rest of the URL.
915
443
# this gets the normalised url back. I.e. '.' -> the full path.
916
444
url = a_transport.base
919
result = BzrDir.open_from_transport(a_transport)
920
return result, urlutils.unescape(a_transport.relpath(url))
447
format = BzrDirFormat.find_format(a_transport)
448
BzrDir._check_supported(format, False)
449
return format.open(a_transport), a_transport.relpath(url)
921
450
except errors.NotBranchError, e:
924
new_t = a_transport.clone('..')
925
except errors.InvalidURLJoin:
926
# reached the root, whatever that may be
927
raise errors.NotBranchError(path=url)
451
mutter('not a branch in: %r %s', a_transport.base, e)
452
new_t = a_transport.clone('..')
928
453
if new_t.base == a_transport.base:
929
454
# reached the root, whatever that may be
930
455
raise errors.NotBranchError(path=url)
931
456
a_transport = new_t
933
def _get_tree_branch(self):
934
"""Return the branch and tree, if any, for this bzrdir.
936
Return None for tree if not present or inaccessible.
937
Raise NotBranchError if no branch is present.
938
:return: (tree, branch)
941
tree = self.open_workingtree()
942
except (errors.NoWorkingTree, errors.NotLocalUrl):
944
branch = self.open_branch()
950
def open_tree_or_branch(klass, location):
951
"""Return the branch and working tree at a location.
953
If there is no tree at the location, tree will be None.
954
If there is no branch at the location, an exception will be
956
:return: (tree, branch)
958
bzrdir = klass.open(location)
959
return bzrdir._get_tree_branch()
962
def open_containing_tree_or_branch(klass, location):
963
"""Return the branch and working tree contained by a location.
965
Returns (tree, branch, relpath).
966
If there is no tree at containing the location, tree will be None.
967
If there is no branch containing the location, an exception will be
969
relpath is the portion of the path that is contained by the branch.
971
bzrdir, relpath = klass.open_containing(location)
972
tree, branch = bzrdir._get_tree_branch()
973
return tree, branch, relpath
976
def open_containing_tree_branch_or_repository(klass, location):
977
"""Return the working tree, branch and repo contained by a location.
979
Returns (tree, branch, repository, relpath).
980
If there is no tree containing the location, tree will be None.
981
If there is no branch containing the location, branch will be None.
982
If there is no repository containing the location, repository will be
984
relpath is the portion of the path that is contained by the innermost
987
If no tree, branch or repository is found, a NotBranchError is raised.
989
bzrdir, relpath = klass.open_containing(location)
991
tree, branch = bzrdir._get_tree_branch()
992
except errors.NotBranchError:
994
repo = bzrdir.find_repository()
995
return None, None, repo, relpath
996
except (errors.NoRepositoryPresent):
997
raise errors.NotBranchError(location)
998
return tree, branch, branch.repository, relpath
1000
458
def open_repository(self, _unsupported=False):
1001
459
"""Open the repository object at this BzrDir if one is present.
1003
This will not follow the Branch object pointer - it's strictly a direct
461
This will not follow the Branch object pointer - its strictly a direct
1004
462
open facility. Most client code should use open_branch().repository to
1005
463
get at a repository.
1007
:param _unsupported: a private parameter, not part of the api.
465
_unsupported is a private parameter, not part of the api.
1008
466
TODO: static convenience version of this?
1010
468
raise NotImplementedError(self.open_repository)
1012
def open_workingtree(self, _unsupported=False,
1013
recommend_upgrade=True, from_branch=None):
470
def open_workingtree(self, _unsupported=False):
1014
471
"""Open the workingtree object at this BzrDir if one is present.
1016
:param recommend_upgrade: Optional keyword parameter, when True (the
1017
default), emit through the ui module a recommendation that the user
1018
upgrade the working tree when the workingtree being opened is old
1019
(but still fully supported).
1020
:param from_branch: override bzrdir branch (for lightweight checkouts)
473
TODO: static convenience version of this?
1022
475
raise NotImplementedError(self.open_workingtree)
1024
def has_branch(self):
1025
"""Tell if this bzrdir contains a branch.
1027
Note: if you're going to open the branch, you should just go ahead
1028
and try, and not ask permission first. (This method just opens the
1029
branch and discards it, and that's somewhat expensive.)
1034
except errors.NotBranchError:
1037
def has_workingtree(self):
1038
"""Tell if this bzrdir contains a working tree.
1040
This will still raise an exception if the bzrdir has a workingtree that
1041
is remote & inaccessible.
1043
Note: if you're going to open the working tree, you should just go ahead
1044
and try, and not ask permission first. (This method just opens the
1045
workingtree and discards it, and that's somewhat expensive.)
1048
self.open_workingtree(recommend_upgrade=False)
1050
except errors.NoWorkingTree:
1053
def _cloning_metadir(self):
1054
"""Produce a metadir suitable for cloning with.
1056
:returns: (destination_bzrdir_format, source_repository)
1058
result_format = self._format.__class__()
1061
branch = self.open_branch(ignore_fallbacks=True)
1062
source_repository = branch.repository
1063
result_format._branch_format = branch._format
1064
except errors.NotBranchError:
1065
source_branch = None
1066
source_repository = self.open_repository()
1067
except errors.NoRepositoryPresent:
1068
source_repository = None
1070
# XXX TODO: This isinstance is here because we have not implemented
1071
# the fix recommended in bug # 103195 - to delegate this choice the
1072
# repository itself.
1073
repo_format = source_repository._format
1074
if isinstance(repo_format, remote.RemoteRepositoryFormat):
1075
source_repository._ensure_real()
1076
repo_format = source_repository._real_repository._format
1077
result_format.repository_format = repo_format
1079
# TODO: Couldn't we just probe for the format in these cases,
1080
# rather than opening the whole tree? It would be a little
1081
# faster. mbp 20070401
1082
tree = self.open_workingtree(recommend_upgrade=False)
1083
except (errors.NoWorkingTree, errors.NotLocalUrl):
1084
result_format.workingtree_format = None
1086
result_format.workingtree_format = tree._format.__class__()
1087
return result_format, source_repository
1089
def cloning_metadir(self, require_stacking=False):
1090
"""Produce a metadir suitable for cloning or sprouting with.
1092
These operations may produce workingtrees (yes, even though they're
1093
"cloning" something that doesn't have a tree), so a viable workingtree
1094
format must be selected.
1096
:require_stacking: If True, non-stackable formats will be upgraded
1097
to similar stackable formats.
1098
:returns: a BzrDirFormat with all component formats either set
1099
appropriately or set to None if that component should not be
1102
format, repository = self._cloning_metadir()
1103
if format._workingtree_format is None:
1105
if repository is None:
1106
# No repository either
1108
# We have a repository, so set a working tree? (Why? This seems to
1109
# contradict the stated return value in the docstring).
1110
tree_format = repository._format._matchingbzrdir.workingtree_format
1111
format.workingtree_format = tree_format.__class__()
1112
if require_stacking:
1113
format.require_stacking()
1116
def checkout_metadir(self):
1117
return self.cloning_metadir()
1119
def sprout(self, url, revision_id=None, force_new_repo=False,
1120
recurse='down', possible_transports=None,
1121
accelerator_tree=None, hardlink=False, stacked=False,
1122
source_branch=None, create_tree_if_local=True):
477
def sprout(self, url, revision_id=None, basis=None, force_new_repo=False):
1123
478
"""Create a copy of this bzrdir prepared for use as a new line of
1126
If url's last component does not exist, it will be created.
481
If urls last component does not exist, it will be created.
1128
483
Attributes related to the identity of the source branch like
1129
484
branch nickname will be cleaned, a working tree is created
1133
488
if revision_id is not None, then the clone operation may tune
1134
489
itself to download less data.
1135
:param accelerator_tree: A tree which can be used for retrieving file
1136
contents more quickly than the revision tree, i.e. a workingtree.
1137
The revision tree will be used for cases where accelerator_tree's
1138
content is different.
1139
:param hardlink: If true, hard-link files from accelerator_tree,
1141
:param stacked: If true, create a stacked branch referring to the
1142
location of this control directory.
1143
:param create_tree_if_local: If true, a working-tree will be created
1144
when working locally.
1146
target_transport = get_transport(url, possible_transports)
1147
target_transport.ensure_base()
1148
cloning_format = self.cloning_metadir(stacked)
1149
# Create/update the result branch
1150
result = cloning_format.initialize_on_transport(target_transport)
1151
# if a stacked branch wasn't requested, we don't create one
1152
# even if the origin was stacked
1153
stacked_branch_url = None
1154
if source_branch is not None:
1156
stacked_branch_url = self.root_transport.base
492
result = self._format.initialize(url)
493
basis_repo, basis_branch, basis_tree = self._get_basis_components(basis)
495
source_branch = self.open_branch()
1157
496
source_repository = source_branch.repository
1160
source_branch = self.open_branch()
1161
source_repository = source_branch.repository
1163
stacked_branch_url = self.root_transport.base
1164
except errors.NotBranchError:
1165
source_branch = None
1167
source_repository = self.open_repository()
1168
except errors.NoRepositoryPresent:
1169
source_repository = None
1170
repository_policy = result.determine_repository_policy(
1171
force_new_repo, stacked_branch_url, require_stacking=stacked)
1172
result_repo, is_new_repo = repository_policy.acquire_repository()
1173
if is_new_repo and revision_id is not None and not stacked:
1174
fetch_spec = graph.PendingAncestryResult(
1175
[revision_id], source_repository)
1178
if source_repository is not None:
1179
# Fetch while stacked to prevent unstacked fetch from
1181
if fetch_spec is None:
1182
result_repo.fetch(source_repository, revision_id=revision_id)
1184
result_repo.fetch(source_repository, fetch_spec=fetch_spec)
1186
if source_branch is None:
1187
# this is for sprouting a bzrdir without a branch; is that
1189
# Not especially, but it's part of the contract.
1190
result_branch = result.create_branch()
1192
result_branch = source_branch.sprout(result,
1193
revision_id=revision_id, repository_policy=repository_policy)
1194
mutter("created new branch %r" % (result_branch,))
1196
# Create/update the result working tree
1197
if (create_tree_if_local and
1198
isinstance(target_transport, local.LocalTransport) and
1199
(result_repo is None or result_repo.make_working_trees())):
1200
wt = result.create_workingtree(accelerator_tree=accelerator_tree,
1204
if wt.path2id('') is None:
1206
wt.set_root_id(self.open_workingtree.get_root_id())
1207
except errors.NoWorkingTree:
1213
if recurse == 'down':
1215
basis = wt.basis_tree()
1217
subtrees = basis.iter_references()
1218
elif result_branch is not None:
1219
basis = result_branch.basis_tree()
1221
subtrees = basis.iter_references()
1222
elif source_branch is not None:
1223
basis = source_branch.basis_tree()
1225
subtrees = basis.iter_references()
1230
for path, file_id in subtrees:
1231
target = urlutils.join(url, urlutils.escape(path))
1232
sublocation = source_branch.reference_parent(file_id, path)
1233
sublocation.bzrdir.sprout(target,
1234
basis.get_reference_revision(file_id, path),
1235
force_new_repo=force_new_repo, recurse=recurse,
1238
if basis is not None:
497
except errors.NotBranchError:
500
source_repository = self.open_repository()
501
except errors.NoRepositoryPresent:
502
# copy the entire basis one if there is one
503
# but there is no repository.
504
source_repository = basis_repo
509
result_repo = result.find_repository()
510
except errors.NoRepositoryPresent:
512
if source_repository is None and result_repo is not None:
514
elif source_repository is None and result_repo is None:
515
# no repo available, make a new one
516
result.create_repository()
517
elif source_repository is not None and result_repo is None:
518
# have soure, and want to make a new target repo
519
source_repository.clone(result,
520
revision_id=revision_id,
523
# fetch needed content into target.
525
# XXX FIXME RBC 20060214 need tests for this when the basis
527
result_repo.fetch(basis_repo, revision_id=revision_id)
528
result_repo.fetch(source_repository, revision_id=revision_id)
529
if source_branch is not None:
530
source_branch.sprout(result, revision_id=revision_id)
532
result.create_branch()
533
result.create_workingtree()
1242
def push_branch(self, source, revision_id=None, overwrite=False,
1243
remember=False, create_prefix=False):
1244
"""Push the source branch into this BzrDir."""
1246
# If we can open a branch, use its direct repository, otherwise see
1247
# if there is a repository without a branch.
1249
br_to = self.open_branch()
1250
except errors.NotBranchError:
1251
# Didn't find a branch, can we find a repository?
1252
repository_to = self.find_repository()
1254
# Found a branch, so we must have found a repository
1255
repository_to = br_to.repository
1257
push_result = PushResult()
1258
push_result.source_branch = source
1260
# We have a repository but no branch, copy the revisions, and then
1262
repository_to.fetch(source.repository, revision_id=revision_id)
1263
br_to = source.clone(self, revision_id=revision_id)
1264
if source.get_push_location() is None or remember:
1265
source.set_push_location(br_to.base)
1266
push_result.stacked_on = None
1267
push_result.branch_push_result = None
1268
push_result.old_revno = None
1269
push_result.old_revid = _mod_revision.NULL_REVISION
1270
push_result.target_branch = br_to
1271
push_result.master_branch = None
1272
push_result.workingtree_updated = False
1274
# We have successfully opened the branch, remember if necessary:
1275
if source.get_push_location() is None or remember:
1276
source.set_push_location(br_to.base)
1278
tree_to = self.open_workingtree()
1279
except errors.NotLocalUrl:
1280
push_result.branch_push_result = source.push(br_to,
1281
overwrite, stop_revision=revision_id)
1282
push_result.workingtree_updated = False
1283
except errors.NoWorkingTree:
1284
push_result.branch_push_result = source.push(br_to,
1285
overwrite, stop_revision=revision_id)
1286
push_result.workingtree_updated = None # Not applicable
1288
tree_to.lock_write()
1290
push_result.branch_push_result = source.push(
1291
tree_to.branch, overwrite, stop_revision=revision_id)
1295
push_result.workingtree_updated = True
1296
push_result.old_revno = push_result.branch_push_result.old_revno
1297
push_result.old_revid = push_result.branch_push_result.old_revid
1298
push_result.target_branch = \
1299
push_result.branch_push_result.target_branch
1303
class BzrDirHooks(hooks.Hooks):
1304
"""Hooks for BzrDir operations."""
1307
"""Create the default hooks."""
1308
hooks.Hooks.__init__(self)
1309
self.create_hook(hooks.HookPoint('pre_open',
1310
"Invoked before attempting to open a BzrDir with the transport "
1311
"that the open will use.", (1, 14), None))
1313
# install the default hooks
1314
BzrDir.hooks = BzrDirHooks()
1317
537
class BzrDirPreSplitOut(BzrDir):
1318
538
"""A common class for the all-in-one formats."""
1845
864
"""Return the ASCII format string that identifies this format."""
1846
865
raise NotImplementedError(self.get_format_string)
1848
def get_format_description(self):
1849
"""Return the short description for this format."""
1850
raise NotImplementedError(self.get_format_description)
1852
867
def get_converter(self, format=None):
1853
868
"""Return the converter to use to convert bzrdirs needing converts.
1855
870
This returns a bzrlib.bzrdir.Converter object.
1857
872
This should return the best upgrader to step this format towards the
1858
current default format. In the case of plugins we can/should provide
873
current default format. In the case of plugins we can/shouold provide
1859
874
some means for them to extend the range of returnable converters.
1861
:param format: Optional format to override the default format of the
876
:param format: Optional format to override the default foramt of the
1864
879
raise NotImplementedError(self.get_converter)
1866
def initialize(self, url, possible_transports=None):
1867
"""Create a bzr control dir at this url and return an opened copy.
1869
While not deprecated, this method is very specific and its use will
1870
lead to many round trips to setup a working environment. See
1871
initialize_on_transport_ex for a [nearly] all-in-one method.
1873
Subclasses should typically override initialize_on_transport
1874
instead of this method.
1876
return self.initialize_on_transport(get_transport(url,
1877
possible_transports))
1879
def initialize_on_transport(self, transport):
1880
"""Initialize a new bzrdir in the base directory of a Transport."""
1882
# can we hand off the request to the smart server rather than using
1884
client_medium = transport.get_smart_medium()
1885
except errors.NoSmartMedium:
1886
return self._initialize_on_transport_vfs(transport)
1888
# Current RPC's only know how to create bzr metadir1 instances, so
1889
# we still delegate to vfs methods if the requested format is not a
1891
if type(self) != BzrDirMetaFormat1:
1892
return self._initialize_on_transport_vfs(transport)
1893
remote_format = RemoteBzrDirFormat()
1894
self._supply_sub_formats_to(remote_format)
1895
return remote_format.initialize_on_transport(transport)
1897
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
1898
create_prefix=False, force_new_repo=False, stacked_on=None,
1899
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
1900
shared_repo=False, vfs_only=False):
1901
"""Create this format on transport.
1903
The directory to initialize will be created.
1905
:param force_new_repo: Do not use a shared repository for the target,
1906
even if one is available.
1907
:param create_prefix: Create any missing directories leading up to
1909
:param use_existing_dir: Use an existing directory if one exists.
1910
:param stacked_on: A url to stack any created branch on, None to follow
1911
any target stacking policy.
1912
:param stack_on_pwd: If stack_on is relative, the location it is
1914
:param repo_format_name: If non-None, a repository will be
1915
made-or-found. Should none be found, or if force_new_repo is True
1916
the repo_format_name is used to select the format of repository to
1918
:param make_working_trees: Control the setting of make_working_trees
1919
for a new shared repository when one is made. None to use whatever
1920
default the format has.
1921
:param shared_repo: Control whether made repositories are shared or
1923
:param vfs_only: If True do not attempt to use a smart server
1924
:return: repo, bzrdir, require_stacking, repository_policy. repo is
1925
None if none was created or found, bzrdir is always valid.
1926
require_stacking is the result of examining the stacked_on
1927
parameter and any stacking policy found for the target.
1930
# Try to hand off to a smart server
1932
client_medium = transport.get_smart_medium()
1933
except errors.NoSmartMedium:
1936
# TODO: lookup the local format from a server hint.
1937
remote_dir_format = RemoteBzrDirFormat()
1938
remote_dir_format._network_name = self.network_name()
1939
self._supply_sub_formats_to(remote_dir_format)
1940
return remote_dir_format.initialize_on_transport_ex(transport,
1941
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
1942
force_new_repo=force_new_repo, stacked_on=stacked_on,
1943
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
1944
make_working_trees=make_working_trees, shared_repo=shared_repo)
1945
# XXX: Refactor the create_prefix/no_create_prefix code into a
1946
# common helper function
1947
# The destination may not exist - if so make it according to policy.
1948
def make_directory(transport):
1949
transport.mkdir('.')
1951
def redirected(transport, e, redirection_notice):
1952
note(redirection_notice)
1953
return transport._redirected_to(e.source, e.target)
1955
transport = do_catching_redirections(make_directory, transport,
1957
except errors.FileExists:
1958
if not use_existing_dir:
1960
except errors.NoSuchFile:
1961
if not create_prefix:
1963
transport.create_prefix()
1965
require_stacking = (stacked_on is not None)
1966
# Now the target directory exists, but doesn't have a .bzr
1967
# directory. So we need to create it, along with any work to create
1968
# all of the dependent branches, etc.
1970
result = self.initialize_on_transport(transport)
1971
if repo_format_name:
1973
# use a custom format
1974
result._format.repository_format = \
1975
repository.network_format_registry.get(repo_format_name)
1976
except AttributeError:
1977
# The format didn't permit it to be set.
1979
# A repository is desired, either in-place or shared.
1980
repository_policy = result.determine_repository_policy(
1981
force_new_repo, stacked_on, stack_on_pwd,
1982
require_stacking=require_stacking)
1983
result_repo, is_new_repo = repository_policy.acquire_repository(
1984
make_working_trees, shared_repo)
1985
if not require_stacking and repository_policy._require_stacking:
1986
require_stacking = True
1987
result._format.require_stacking()
1988
result_repo.lock_write()
1991
repository_policy = None
1992
return result_repo, result, require_stacking, repository_policy
1994
def _initialize_on_transport_vfs(self, transport):
1995
"""Initialize a new bzrdir using VFS calls.
1997
:param transport: The transport to create the .bzr directory in.
2000
# Since we are creating a .bzr directory, inherit the
881
def initialize(self, url):
882
"""Create a bzr control dir at this url and return an opened copy."""
883
# Since we don't have a .bzr directory, inherit the
2001
884
# mode from the root directory
2002
temp_control = lockable_files.LockableFiles(transport,
2003
'', lockable_files.TransportLock)
885
t = get_transport(url)
886
temp_control = LockableFiles(t, '', TransportLock)
2004
887
temp_control._transport.mkdir('.bzr',
2005
# FIXME: RBC 20060121 don't peek under
888
# FIXME: RBC 20060121 dont peek under
2007
890
mode=temp_control._dir_mode)
2008
if sys.platform == 'win32' and isinstance(transport, local.LocalTransport):
2009
win32utils.set_file_attr_hidden(transport._abspath('.bzr'))
2010
891
file_mode = temp_control._file_mode
2011
892
del temp_control
2012
bzrdir_transport = transport.clone('.bzr')
2013
utf8_files = [('README',
2014
"This is a Bazaar control directory.\n"
2015
"Do not change any files in this directory.\n"
2016
"See http://bazaar-vcs.org/ for more information about Bazaar.\n"),
893
mutter('created control directory in ' + t.base)
894
control = t.clone('.bzr')
895
utf8_files = [('README',
896
"This is a Bazaar-NG control directory.\n"
897
"Do not change any files in this directory.\n"),
2017
898
('branch-format', self.get_format_string()),
2019
900
# NB: no need to escape relative paths that are url safe.
2020
control_files = lockable_files.LockableFiles(bzrdir_transport,
2021
self._lock_file_name, self._lock_class)
901
control_files = LockableFiles(control, self._lock_file_name, self._lock_class)
2022
902
control_files.create_lock()
2023
903
control_files.lock_write()
2025
for (filename, content) in utf8_files:
2026
bzrdir_transport.put_bytes(filename, content,
905
for file, content in utf8_files:
906
control_files.put_utf8(file, content)
2029
908
control_files.unlock()
2030
return self.open(transport, _found=True)
909
return self.open(t, _found=True)
2032
911
def is_supported(self):
2033
912
"""Is this format supported?
2035
914
Supported formats must be initializable and openable.
2036
Unsupported formats may not support initialization or committing or
915
Unsupported formats may not support initialization or committing or
2037
916
some other features depending on the reason for not being supported.
2041
def network_name(self):
2042
"""A simple byte string uniquely identifying this format for RPC calls.
2044
Bzr control formats use thir disk format string to identify the format
2045
over the wire. Its possible that other control formats have more
2046
complex detection requirements, so we permit them to use any unique and
2047
immutable string they desire.
2049
raise NotImplementedError(self.network_name)
2051
def same_model(self, target_format):
2052
return (self.repository_format.rich_root_data ==
2053
target_format.rich_root_data)
2056
def known_formats(klass):
2057
"""Return all the known formats.
2059
Concrete formats should override _known_formats.
2061
# There is double indirection here to make sure that control
2062
# formats used by more than one dir format will only be probed
2063
# once. This can otherwise be quite expensive for remote connections.
2065
for format in klass._control_formats:
2066
result.update(format._known_formats())
2070
def _known_formats(klass):
2071
"""Return the known format instances for this control format."""
2072
return set(klass._formats.values())
2074
920
def open(self, transport, _found=False):
2075
921
"""Return an instance of this format for the dir transport points at.
2077
923
_found is a private parameter, do not use it.
2080
found_format = BzrDirFormat.find_format(transport)
2081
if not isinstance(found_format, self.__class__):
2082
raise AssertionError("%s was asked to open %s, but it seems to need "
2084
% (self, transport, found_format))
2085
# Allow subclasses - use the found format.
2086
self._supply_sub_formats_to(found_format)
2087
return found_format._open(transport)
926
assert isinstance(BzrDirFormat.find_format(transport),
2088
928
return self._open(transport)
2090
930
def _open(self, transport):
2189
984
"""Format 4 is not supported.
2191
986
It is not supported because the model changed from 4 to 5 and the
2192
conversion logic is expensive - so doing it on the fly was not
987
conversion logic is expensive - so doing it on the fly was not
2197
def network_name(self):
2198
return self.get_format_string()
2200
992
def _open(self, transport):
2201
993
"""See BzrDirFormat._open."""
2202
994
return BzrDir4(transport, self)
2204
996
def __return_repository_format(self):
2205
997
"""Circular import protection."""
2206
from bzrlib.repofmt.weaverepo import RepositoryFormat4
2207
return RepositoryFormat4()
998
from bzrlib.repository import RepositoryFormat4
999
return RepositoryFormat4(self)
2208
1000
repository_format = property(__return_repository_format)
2211
class BzrDirFormatAllInOne(BzrDirFormat):
2212
"""Common class for formats before meta-dirs."""
2214
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
2215
create_prefix=False, force_new_repo=False, stacked_on=None,
2216
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
2218
"""See BzrDirFormat.initialize_on_transport_ex."""
2219
require_stacking = (stacked_on is not None)
2220
# Format 5 cannot stack, but we've been asked to - actually init
2222
if require_stacking:
2223
format = BzrDirMetaFormat1()
2224
return format.initialize_on_transport_ex(transport,
2225
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2226
force_new_repo=force_new_repo, stacked_on=stacked_on,
2227
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2228
make_working_trees=make_working_trees, shared_repo=shared_repo)
2229
return BzrDirFormat.initialize_on_transport_ex(self, transport,
2230
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2231
force_new_repo=force_new_repo, stacked_on=stacked_on,
2232
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2233
make_working_trees=make_working_trees, shared_repo=shared_repo)
2236
class BzrDirFormat5(BzrDirFormatAllInOne):
1003
class BzrDirFormat5(BzrDirFormat):
2237
1004
"""Bzr control format 5.
2239
1006
This format is a combined format for working tree, branch and repository.
2241
- Format 2 working trees [always]
2242
- Format 4 branches [always]
1008
- Format 2 working trees [always]
1009
- Format 4 branches [always]
2243
1010
- Format 5 repositories [always]
2244
1011
Unhashed stores in the repository.
2247
_lock_class = lockable_files.TransportLock
1014
_lock_class = TransportLock
2249
1016
def get_format_string(self):
2250
1017
"""See BzrDirFormat.get_format_string()."""
2251
1018
return "Bazaar-NG branch, format 5\n"
2253
def get_branch_format(self):
2254
from bzrlib import branch
2255
return branch.BzrBranchFormat4()
2257
def get_format_description(self):
2258
"""See BzrDirFormat.get_format_description()."""
2259
return "All-in-one format 5"
2261
1020
def get_converter(self, format=None):
2262
1021
"""See BzrDirFormat.get_converter()."""
2263
1022
# there is one and only one upgrade path here.
2264
1023
return ConvertBzrDir5To6()
2266
def _initialize_for_clone(self, url):
2267
return self.initialize_on_transport(get_transport(url), _cloning=True)
2269
def initialize_on_transport(self, transport, _cloning=False):
1025
def initialize(self, url, _cloning=False):
2270
1026
"""Format 5 dirs always have working tree, branch and repository.
2272
1028
Except when they are being cloned.
2274
1030
from bzrlib.branch import BzrBranchFormat4
2275
from bzrlib.repofmt.weaverepo import RepositoryFormat5
2276
result = (super(BzrDirFormat5, self).initialize_on_transport(transport))
1031
from bzrlib.repository import RepositoryFormat5
1032
from bzrlib.workingtree import WorkingTreeFormat2
1033
result = super(BzrDirFormat5, self).initialize(url)
2277
1034
RepositoryFormat5().initialize(result, _internal=True)
2278
1035
if not _cloning:
2279
branch = BzrBranchFormat4().initialize(result)
2280
result._init_workingtree()
1036
BzrBranchFormat4().initialize(result)
1037
WorkingTreeFormat2().initialize(result)
2283
def network_name(self):
2284
return self.get_format_string()
2286
1040
def _open(self, transport):
2287
1041
"""See BzrDirFormat._open."""
2288
1042
return BzrDir5(transport, self)
2290
1044
def __return_repository_format(self):
2291
1045
"""Circular import protection."""
2292
from bzrlib.repofmt.weaverepo import RepositoryFormat5
2293
return RepositoryFormat5()
1046
from bzrlib.repository import RepositoryFormat5
1047
return RepositoryFormat5(self)
2294
1048
repository_format = property(__return_repository_format)
2297
class BzrDirFormat6(BzrDirFormatAllInOne):
1051
class BzrDirFormat6(BzrDirFormat):
2298
1052
"""Bzr control format 6.
2300
1054
This format is a combined format for working tree, branch and repository.
2302
- Format 2 working trees [always]
2303
- Format 4 branches [always]
1056
- Format 2 working trees [always]
1057
- Format 4 branches [always]
2304
1058
- Format 6 repositories [always]
2307
_lock_class = lockable_files.TransportLock
1061
_lock_class = TransportLock
2309
1063
def get_format_string(self):
2310
1064
"""See BzrDirFormat.get_format_string()."""
2311
1065
return "Bazaar-NG branch, format 6\n"
2313
def get_format_description(self):
2314
"""See BzrDirFormat.get_format_description()."""
2315
return "All-in-one format 6"
2317
def get_branch_format(self):
2318
from bzrlib import branch
2319
return branch.BzrBranchFormat4()
2321
1067
def get_converter(self, format=None):
2322
1068
"""See BzrDirFormat.get_converter()."""
2323
1069
# there is one and only one upgrade path here.
2324
1070
return ConvertBzrDir6ToMeta()
2326
def _initialize_for_clone(self, url):
2327
return self.initialize_on_transport(get_transport(url), _cloning=True)
2329
def initialize_on_transport(self, transport, _cloning=False):
1072
def initialize(self, url, _cloning=False):
2330
1073
"""Format 6 dirs always have working tree, branch and repository.
2332
1075
Except when they are being cloned.
2334
1077
from bzrlib.branch import BzrBranchFormat4
2335
from bzrlib.repofmt.weaverepo import RepositoryFormat6
2336
result = super(BzrDirFormat6, self).initialize_on_transport(transport)
1078
from bzrlib.repository import RepositoryFormat6
1079
from bzrlib.workingtree import WorkingTreeFormat2
1080
result = super(BzrDirFormat6, self).initialize(url)
2337
1081
RepositoryFormat6().initialize(result, _internal=True)
2338
1082
if not _cloning:
2339
branch = BzrBranchFormat4().initialize(result)
2340
result._init_workingtree()
1083
BzrBranchFormat4().initialize(result)
1085
WorkingTreeFormat2().initialize(result)
1086
except errors.NotLocalUrl:
1087
# emulate pre-check behaviour for working tree and silently
2343
def network_name(self):
2344
return self.get_format_string()
2346
1092
def _open(self, transport):
2347
1093
"""See BzrDirFormat._open."""
2348
1094
return BzrDir6(transport, self)
2350
1096
def __return_repository_format(self):
2351
1097
"""Circular import protection."""
2352
from bzrlib.repofmt.weaverepo import RepositoryFormat6
2353
return RepositoryFormat6()
1098
from bzrlib.repository import RepositoryFormat6
1099
return RepositoryFormat6(self)
2354
1100
repository_format = property(__return_repository_format)
3042
1677
if not isinstance(repo._format, self.target_format.repository_format.__class__):
3043
1678
from bzrlib.repository import CopyConverter
3044
ui.ui_factory.note('starting repository conversion')
1679
self.pb.note('starting repository conversion')
3045
1680
converter = CopyConverter(self.target_format.repository_format)
3046
1681
converter.convert(repo, pb)
3048
branch = self.bzrdir.open_branch()
3049
except errors.NotBranchError:
3052
# TODO: conversions of Branch and Tree should be done by
3053
# InterXFormat lookups/some sort of registry.
3054
# Avoid circular imports
3055
from bzrlib import branch as _mod_branch
3056
old = branch._format.__class__
3057
new = self.target_format.get_branch_format().__class__
3059
if (old == _mod_branch.BzrBranchFormat5 and
3060
new in (_mod_branch.BzrBranchFormat6,
3061
_mod_branch.BzrBranchFormat7,
3062
_mod_branch.BzrBranchFormat8)):
3063
branch_converter = _mod_branch.Converter5to6()
3064
elif (old == _mod_branch.BzrBranchFormat6 and
3065
new in (_mod_branch.BzrBranchFormat7,
3066
_mod_branch.BzrBranchFormat8)):
3067
branch_converter = _mod_branch.Converter6to7()
3068
elif (old == _mod_branch.BzrBranchFormat7 and
3069
new is _mod_branch.BzrBranchFormat8):
3070
branch_converter = _mod_branch.Converter7to8()
3072
raise errors.BadConversionTarget("No converter", new,
3074
branch_converter.convert(branch)
3075
branch = self.bzrdir.open_branch()
3076
old = branch._format.__class__
3078
tree = self.bzrdir.open_workingtree(recommend_upgrade=False)
3079
except (errors.NoWorkingTree, errors.NotLocalUrl):
3082
# TODO: conversions of Branch and Tree should be done by
3083
# InterXFormat lookups
3084
if (isinstance(tree, workingtree.WorkingTree3) and
3085
not isinstance(tree, workingtree_4.DirStateWorkingTree) and
3086
isinstance(self.target_format.workingtree_format,
3087
workingtree_4.DirStateWorkingTreeFormat)):
3088
workingtree_4.Converter3to4().convert(tree)
3089
if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
3090
not isinstance(tree, workingtree_4.WorkingTree5) and
3091
isinstance(self.target_format.workingtree_format,
3092
workingtree_4.WorkingTreeFormat5)):
3093
workingtree_4.Converter4to5().convert(tree)
3094
if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
3095
not isinstance(tree, workingtree_4.WorkingTree6) and
3096
isinstance(self.target_format.workingtree_format,
3097
workingtree_4.WorkingTreeFormat6)):
3098
workingtree_4.Converter4or5to6().convert(tree)
3099
1682
return to_convert
3102
# This is not in remote.py because it's relatively small, and needs to be
3103
# registered. Putting it in remote.py creates a circular import problem.
3104
# we can make it a lazy object if the control formats is turned into something
3106
class RemoteBzrDirFormat(BzrDirMetaFormat1):
3107
"""Format representing bzrdirs accessed via a smart server"""
3110
BzrDirMetaFormat1.__init__(self)
3111
# XXX: It's a bit ugly that the network name is here, because we'd
3112
# like to believe that format objects are stateless or at least
3113
# immutable, However, we do at least avoid mutating the name after
3114
# it's returned. See <https://bugs.edge.launchpad.net/bzr/+bug/504102>
3115
self._network_name = None
3118
return "%s(_network_name=%r)" % (self.__class__.__name__,
3121
def get_format_description(self):
3122
if self._network_name:
3123
real_format = network_format_registry.get(self._network_name)
3124
return 'Remote: ' + real_format.get_format_description()
3125
return 'bzr remote bzrdir'
3127
def get_format_string(self):
3128
raise NotImplementedError(self.get_format_string)
3130
def network_name(self):
3131
if self._network_name:
3132
return self._network_name
3134
raise AssertionError("No network name set.")
3137
def probe_transport(klass, transport):
3138
"""Return a RemoteBzrDirFormat object if it looks possible."""
3140
medium = transport.get_smart_medium()
3141
except (NotImplementedError, AttributeError,
3142
errors.TransportNotPossible, errors.NoSmartMedium,
3143
errors.SmartProtocolError):
3144
# no smart server, so not a branch for this format type.
3145
raise errors.NotBranchError(path=transport.base)
3147
# Decline to open it if the server doesn't support our required
3148
# version (3) so that the VFS-based transport will do it.
3149
if medium.should_probe():
3151
server_version = medium.protocol_version()
3152
except errors.SmartProtocolError:
3153
# Apparently there's no usable smart server there, even though
3154
# the medium supports the smart protocol.
3155
raise errors.NotBranchError(path=transport.base)
3156
if server_version != '2':
3157
raise errors.NotBranchError(path=transport.base)
3160
def initialize_on_transport(self, transport):
3162
# hand off the request to the smart server
3163
client_medium = transport.get_smart_medium()
3164
except errors.NoSmartMedium:
3165
# TODO: lookup the local format from a server hint.
3166
local_dir_format = BzrDirMetaFormat1()
3167
return local_dir_format.initialize_on_transport(transport)
3168
client = _SmartClient(client_medium)
3169
path = client.remote_path_from_transport(transport)
3171
response = client.call('BzrDirFormat.initialize', path)
3172
except errors.ErrorFromSmartServer, err:
3173
remote._translate_error(err, path=path)
3174
if response[0] != 'ok':
3175
raise errors.SmartProtocolError('unexpected response code %s' % (response,))
3176
format = RemoteBzrDirFormat()
3177
self._supply_sub_formats_to(format)
3178
return remote.RemoteBzrDir(transport, format)
3180
def parse_NoneTrueFalse(self, arg):
3187
raise AssertionError("invalid arg %r" % arg)
3189
def _serialize_NoneTrueFalse(self, arg):
3196
def _serialize_NoneString(self, arg):
3199
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
3200
create_prefix=False, force_new_repo=False, stacked_on=None,
3201
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
3204
# hand off the request to the smart server
3205
client_medium = transport.get_smart_medium()
3206
except errors.NoSmartMedium:
3209
# Decline to open it if the server doesn't support our required
3210
# version (3) so that the VFS-based transport will do it.
3211
if client_medium.should_probe():
3213
server_version = client_medium.protocol_version()
3214
if server_version != '2':
3218
except errors.SmartProtocolError:
3219
# Apparently there's no usable smart server there, even though
3220
# the medium supports the smart protocol.
3225
client = _SmartClient(client_medium)
3226
path = client.remote_path_from_transport(transport)
3227
if client_medium._is_remote_before((1, 16)):
3230
# TODO: lookup the local format from a server hint.
3231
local_dir_format = BzrDirMetaFormat1()
3232
self._supply_sub_formats_to(local_dir_format)
3233
return local_dir_format.initialize_on_transport_ex(transport,
3234
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3235
force_new_repo=force_new_repo, stacked_on=stacked_on,
3236
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3237
make_working_trees=make_working_trees, shared_repo=shared_repo,
3239
return self._initialize_on_transport_ex_rpc(client, path, transport,
3240
use_existing_dir, create_prefix, force_new_repo, stacked_on,
3241
stack_on_pwd, repo_format_name, make_working_trees, shared_repo)
3243
def _initialize_on_transport_ex_rpc(self, client, path, transport,
3244
use_existing_dir, create_prefix, force_new_repo, stacked_on,
3245
stack_on_pwd, repo_format_name, make_working_trees, shared_repo):
3247
args.append(self._serialize_NoneTrueFalse(use_existing_dir))
3248
args.append(self._serialize_NoneTrueFalse(create_prefix))
3249
args.append(self._serialize_NoneTrueFalse(force_new_repo))
3250
args.append(self._serialize_NoneString(stacked_on))
3251
# stack_on_pwd is often/usually our transport
3254
stack_on_pwd = transport.relpath(stack_on_pwd)
3255
if not stack_on_pwd:
3257
except errors.PathNotChild:
3259
args.append(self._serialize_NoneString(stack_on_pwd))
3260
args.append(self._serialize_NoneString(repo_format_name))
3261
args.append(self._serialize_NoneTrueFalse(make_working_trees))
3262
args.append(self._serialize_NoneTrueFalse(shared_repo))
3263
request_network_name = self._network_name or \
3264
BzrDirFormat.get_default_format().network_name()
3266
response = client.call('BzrDirFormat.initialize_ex_1.16',
3267
request_network_name, path, *args)
3268
except errors.UnknownSmartMethod:
3269
client._medium._remember_remote_is_before((1,16))
3270
local_dir_format = BzrDirMetaFormat1()
3271
self._supply_sub_formats_to(local_dir_format)
3272
return local_dir_format.initialize_on_transport_ex(transport,
3273
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3274
force_new_repo=force_new_repo, stacked_on=stacked_on,
3275
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3276
make_working_trees=make_working_trees, shared_repo=shared_repo,
3278
except errors.ErrorFromSmartServer, err:
3279
remote._translate_error(err, path=path)
3280
repo_path = response[0]
3281
bzrdir_name = response[6]
3282
require_stacking = response[7]
3283
require_stacking = self.parse_NoneTrueFalse(require_stacking)
3284
format = RemoteBzrDirFormat()
3285
format._network_name = bzrdir_name
3286
self._supply_sub_formats_to(format)
3287
bzrdir = remote.RemoteBzrDir(transport, format, _client=client)
3289
repo_format = remote.response_tuple_to_repo_format(response[1:])
3290
if repo_path == '.':
3293
repo_bzrdir_format = RemoteBzrDirFormat()
3294
repo_bzrdir_format._network_name = response[5]
3295
repo_bzr = remote.RemoteBzrDir(transport.clone(repo_path),
3299
final_stack = response[8] or None
3300
final_stack_pwd = response[9] or None
3302
final_stack_pwd = urlutils.join(
3303
transport.base, final_stack_pwd)
3304
remote_repo = remote.RemoteRepository(repo_bzr, repo_format)
3305
if len(response) > 10:
3306
# Updated server verb that locks remotely.
3307
repo_lock_token = response[10] or None
3308
remote_repo.lock_write(repo_lock_token, _skip_rpc=True)
3310
remote_repo.dont_leave_lock_in_place()
3312
remote_repo.lock_write()
3313
policy = UseExistingRepository(remote_repo, final_stack,
3314
final_stack_pwd, require_stacking)
3315
policy.acquire_repository()
3319
bzrdir._format.set_branch_format(self.get_branch_format())
3320
if require_stacking:
3321
# The repo has already been created, but we need to make sure that
3322
# we'll make a stackable branch.
3323
bzrdir._format.require_stacking(_skip_repo=True)
3324
return remote_repo, bzrdir, require_stacking, policy
3326
def _open(self, transport):
3327
return remote.RemoteBzrDir(transport, self)
3329
def __eq__(self, other):
3330
if not isinstance(other, RemoteBzrDirFormat):
3332
return self.get_format_description() == other.get_format_description()
3334
def __return_repository_format(self):
3335
# Always return a RemoteRepositoryFormat object, but if a specific bzr
3336
# repository format has been asked for, tell the RemoteRepositoryFormat
3337
# that it should use that for init() etc.
3338
result = remote.RemoteRepositoryFormat()
3339
custom_format = getattr(self, '_repository_format', None)
3341
if isinstance(custom_format, remote.RemoteRepositoryFormat):
3342
return custom_format
3344
# We will use the custom format to create repositories over the
3345
# wire; expose its details like rich_root_data for code to
3347
result._custom_format = custom_format
3350
def get_branch_format(self):
3351
result = BzrDirMetaFormat1.get_branch_format(self)
3352
if not isinstance(result, remote.RemoteBranchFormat):
3353
new_result = remote.RemoteBranchFormat()
3354
new_result._custom_format = result
3356
self.set_branch_format(new_result)
3360
repository_format = property(__return_repository_format,
3361
BzrDirMetaFormat1._set_repository_format) #.im_func)
3364
BzrDirFormat.register_control_server_format(RemoteBzrDirFormat)
3367
class BzrDirFormatInfo(object):
3369
def __init__(self, native, deprecated, hidden, experimental):
3370
self.deprecated = deprecated
3371
self.native = native
3372
self.hidden = hidden
3373
self.experimental = experimental
3376
class BzrDirFormatRegistry(registry.Registry):
3377
"""Registry of user-selectable BzrDir subformats.
3379
Differs from BzrDirFormat._control_formats in that it provides sub-formats,
3380
e.g. BzrDirMeta1 with weave repository. Also, it's more user-oriented.
3384
"""Create a BzrDirFormatRegistry."""
3385
self._aliases = set()
3386
self._registration_order = list()
3387
super(BzrDirFormatRegistry, self).__init__()
3390
"""Return a set of the format names which are aliases."""
3391
return frozenset(self._aliases)
3393
def register_metadir(self, key,
3394
repository_format, help, native=True, deprecated=False,
3400
"""Register a metadir subformat.
3402
These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
3403
by the Repository/Branch/WorkingTreeformats.
3405
:param repository_format: The fully-qualified repository format class
3407
:param branch_format: Fully-qualified branch format class name as
3409
:param tree_format: Fully-qualified tree format class name as
3412
# This should be expanded to support setting WorkingTree and Branch
3413
# formats, once BzrDirMetaFormat1 supports that.
3414
def _load(full_name):
3415
mod_name, factory_name = full_name.rsplit('.', 1)
3417
mod = __import__(mod_name, globals(), locals(),
3419
except ImportError, e:
3420
raise ImportError('failed to load %s: %s' % (full_name, e))
3422
factory = getattr(mod, factory_name)
3423
except AttributeError:
3424
raise AttributeError('no factory %s in module %r'
3429
bd = BzrDirMetaFormat1()
3430
if branch_format is not None:
3431
bd.set_branch_format(_load(branch_format))
3432
if tree_format is not None:
3433
bd.workingtree_format = _load(tree_format)
3434
if repository_format is not None:
3435
bd.repository_format = _load(repository_format)
3437
self.register(key, helper, help, native, deprecated, hidden,
3438
experimental, alias)
3440
def register(self, key, factory, help, native=True, deprecated=False,
3441
hidden=False, experimental=False, alias=False):
3442
"""Register a BzrDirFormat factory.
3444
The factory must be a callable that takes one parameter: the key.
3445
It must produce an instance of the BzrDirFormat when called.
3447
This function mainly exists to prevent the info object from being
3450
registry.Registry.register(self, key, factory, help,
3451
BzrDirFormatInfo(native, deprecated, hidden, experimental))
3453
self._aliases.add(key)
3454
self._registration_order.append(key)
3456
def register_lazy(self, key, module_name, member_name, help, native=True,
3457
deprecated=False, hidden=False, experimental=False, alias=False):
3458
registry.Registry.register_lazy(self, key, module_name, member_name,
3459
help, BzrDirFormatInfo(native, deprecated, hidden, experimental))
3461
self._aliases.add(key)
3462
self._registration_order.append(key)
3464
def set_default(self, key):
3465
"""Set the 'default' key to be a clone of the supplied key.
3467
This method must be called once and only once.
3469
registry.Registry.register(self, 'default', self.get(key),
3470
self.get_help(key), info=self.get_info(key))
3471
self._aliases.add('default')
3473
def set_default_repository(self, key):
3474
"""Set the FormatRegistry default and Repository default.
3476
This is a transitional method while Repository.set_default_format
3479
if 'default' in self:
3480
self.remove('default')
3481
self.set_default(key)
3482
format = self.get('default')()
3484
def make_bzrdir(self, key):
3485
return self.get(key)()
3487
def help_topic(self, topic):
3489
default_realkey = None
3490
default_help = self.get_help('default')
3492
for key in self._registration_order:
3493
if key == 'default':
3495
help = self.get_help(key)
3496
if help == default_help:
3497
default_realkey = key
3499
help_pairs.append((key, help))
3501
def wrapped(key, help, info):
3503
help = '(native) ' + help
3504
return ':%s:\n%s\n\n' % (key,
3505
textwrap.fill(help, initial_indent=' ',
3506
subsequent_indent=' ',
3507
break_long_words=False))
3508
if default_realkey is not None:
3509
output += wrapped(default_realkey, '(default) %s' % default_help,
3510
self.get_info('default'))
3511
deprecated_pairs = []
3512
experimental_pairs = []
3513
for key, help in help_pairs:
3514
info = self.get_info(key)
3517
elif info.deprecated:
3518
deprecated_pairs.append((key, help))
3519
elif info.experimental:
3520
experimental_pairs.append((key, help))
3522
output += wrapped(key, help, info)
3523
output += "\nSee :doc:`formats-help` for more about storage formats."
3525
if len(experimental_pairs) > 0:
3526
other_output += "Experimental formats are shown below.\n\n"
3527
for key, help in experimental_pairs:
3528
info = self.get_info(key)
3529
other_output += wrapped(key, help, info)
3532
"No experimental formats are available.\n\n"
3533
if len(deprecated_pairs) > 0:
3534
other_output += "\nDeprecated formats are shown below.\n\n"
3535
for key, help in deprecated_pairs:
3536
info = self.get_info(key)
3537
other_output += wrapped(key, help, info)
3540
"\nNo deprecated formats are available.\n\n"
3542
"\nSee :doc:`formats-help` for more about storage formats."
3544
if topic == 'other-formats':
3550
class RepositoryAcquisitionPolicy(object):
3551
"""Abstract base class for repository acquisition policies.
3553
A repository acquisition policy decides how a BzrDir acquires a repository
3554
for a branch that is being created. The most basic policy decision is
3555
whether to create a new repository or use an existing one.
3557
def __init__(self, stack_on, stack_on_pwd, require_stacking):
3560
:param stack_on: A location to stack on
3561
:param stack_on_pwd: If stack_on is relative, the location it is
3563
:param require_stacking: If True, it is a failure to not stack.
3565
self._stack_on = stack_on
3566
self._stack_on_pwd = stack_on_pwd
3567
self._require_stacking = require_stacking
3569
def configure_branch(self, branch):
3570
"""Apply any configuration data from this policy to the branch.
3572
Default implementation sets repository stacking.
3574
if self._stack_on is None:
3576
if self._stack_on_pwd is None:
3577
stack_on = self._stack_on
3580
stack_on = urlutils.rebase_url(self._stack_on,
3582
branch.bzrdir.root_transport.base)
3583
except errors.InvalidRebaseURLs:
3584
stack_on = self._get_full_stack_on()
3586
branch.set_stacked_on_url(stack_on)
3587
except (errors.UnstackableBranchFormat,
3588
errors.UnstackableRepositoryFormat):
3589
if self._require_stacking:
3592
def requires_stacking(self):
3593
"""Return True if this policy requires stacking."""
3594
return self._stack_on is not None and self._require_stacking
3596
def _get_full_stack_on(self):
3597
"""Get a fully-qualified URL for the stack_on location."""
3598
if self._stack_on is None:
3600
if self._stack_on_pwd is None:
3601
return self._stack_on
3603
return urlutils.join(self._stack_on_pwd, self._stack_on)
3605
def _add_fallback(self, repository, possible_transports=None):
3606
"""Add a fallback to the supplied repository, if stacking is set."""
3607
stack_on = self._get_full_stack_on()
3608
if stack_on is None:
3611
stacked_dir = BzrDir.open(stack_on,
3612
possible_transports=possible_transports)
3613
except errors.JailBreak:
3614
# We keep the stacking details, but we are in the server code so
3615
# actually stacking is not needed.
3618
stacked_repo = stacked_dir.open_branch().repository
3619
except errors.NotBranchError:
3620
stacked_repo = stacked_dir.open_repository()
3622
repository.add_fallback_repository(stacked_repo)
3623
except errors.UnstackableRepositoryFormat:
3624
if self._require_stacking:
3627
self._require_stacking = True
3629
def acquire_repository(self, make_working_trees=None, shared=False):
3630
"""Acquire a repository for this bzrdir.
3632
Implementations may create a new repository or use a pre-exising
3634
:param make_working_trees: If creating a repository, set
3635
make_working_trees to this value (if non-None)
3636
:param shared: If creating a repository, make it shared if True
3637
:return: A repository, is_new_flag (True if the repository was
3640
raise NotImplemented(RepositoryAcquisitionPolicy.acquire_repository)
3643
class CreateRepository(RepositoryAcquisitionPolicy):
3644
"""A policy of creating a new repository"""
3646
def __init__(self, bzrdir, stack_on=None, stack_on_pwd=None,
3647
require_stacking=False):
3650
:param bzrdir: The bzrdir to create the repository on.
3651
:param stack_on: A location to stack on
3652
:param stack_on_pwd: If stack_on is relative, the location it is
3655
RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
3657
self._bzrdir = bzrdir
3659
def acquire_repository(self, make_working_trees=None, shared=False):
3660
"""Implementation of RepositoryAcquisitionPolicy.acquire_repository
3662
Creates the desired repository in the bzrdir we already have.
3664
stack_on = self._get_full_stack_on()
3666
format = self._bzrdir._format
3667
format.require_stacking(stack_on=stack_on,
3668
possible_transports=[self._bzrdir.root_transport])
3669
if not self._require_stacking:
3670
# We have picked up automatic stacking somewhere.
3671
note('Using default stacking branch %s at %s', self._stack_on,
3673
repository = self._bzrdir.create_repository(shared=shared)
3674
self._add_fallback(repository,
3675
possible_transports=[self._bzrdir.transport])
3676
if make_working_trees is not None:
3677
repository.set_make_working_trees(make_working_trees)
3678
return repository, True
3681
class UseExistingRepository(RepositoryAcquisitionPolicy):
3682
"""A policy of reusing an existing repository"""
3684
def __init__(self, repository, stack_on=None, stack_on_pwd=None,
3685
require_stacking=False):
3688
:param repository: The repository to use.
3689
:param stack_on: A location to stack on
3690
:param stack_on_pwd: If stack_on is relative, the location it is
3693
RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
3695
self._repository = repository
3697
def acquire_repository(self, make_working_trees=None, shared=False):
3698
"""Implementation of RepositoryAcquisitionPolicy.acquire_repository
3700
Returns an existing repository to use.
3702
self._add_fallback(self._repository,
3703
possible_transports=[self._repository.bzrdir.transport])
3704
return self._repository, False
3707
# Please register new formats after old formats so that formats
3708
# appear in chronological order and format descriptions can build
3710
format_registry = BzrDirFormatRegistry()
3711
# The pre-0.8 formats have their repository format network name registered in
3712
# repository.py. MetaDir formats have their repository format network name
3713
# inferred from their disk format string.
3714
format_registry.register('weave', BzrDirFormat6,
3715
'Pre-0.8 format. Slower than knit and does not'
3716
' support checkouts or shared repositories.',
3718
format_registry.register_metadir('metaweave',
3719
'bzrlib.repofmt.weaverepo.RepositoryFormat7',
3720
'Transitional format in 0.8. Slower than knit.',
3721
branch_format='bzrlib.branch.BzrBranchFormat5',
3722
tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3724
format_registry.register_metadir('knit',
3725
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3726
'Format using knits. Recommended for interoperation with bzr <= 0.14.',
3727
branch_format='bzrlib.branch.BzrBranchFormat5',
3728
tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3730
format_registry.register_metadir('dirstate',
3731
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3732
help='New in 0.15: Fast local operations. Compatible with bzr 0.8 and '
3733
'above when accessed over the network.',
3734
branch_format='bzrlib.branch.BzrBranchFormat5',
3735
# this uses bzrlib.workingtree.WorkingTreeFormat4 because importing
3736
# directly from workingtree_4 triggers a circular import.
3737
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3739
format_registry.register_metadir('dirstate-tags',
3740
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3741
help='New in 0.15: Fast local operations and improved scaling for '
3742
'network operations. Additionally adds support for tags.'
3743
' Incompatible with bzr < 0.15.',
3744
branch_format='bzrlib.branch.BzrBranchFormat6',
3745
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3747
format_registry.register_metadir('rich-root',
3748
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
3749
help='New in 1.0. Better handling of tree roots. Incompatible with'
3751
branch_format='bzrlib.branch.BzrBranchFormat6',
3752
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3754
format_registry.register_metadir('dirstate-with-subtree',
3755
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
3756
help='New in 0.15: Fast local operations and improved scaling for '
3757
'network operations. Additionally adds support for versioning nested '
3758
'bzr branches. Incompatible with bzr < 0.15.',
3759
branch_format='bzrlib.branch.BzrBranchFormat6',
3760
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3764
format_registry.register_metadir('pack-0.92',
3765
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack1',
3766
help='New in 0.92: Pack-based format with data compatible with '
3767
'dirstate-tags format repositories. Interoperates with '
3768
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3769
'Previously called knitpack-experimental. '
3770
'For more information, see '
3771
'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
3772
branch_format='bzrlib.branch.BzrBranchFormat6',
3773
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3775
format_registry.register_metadir('pack-0.92-subtree',
3776
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack3',
3777
help='New in 0.92: Pack-based format with data compatible with '
3778
'dirstate-with-subtree format repositories. Interoperates with '
3779
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3780
'Previously called knitpack-experimental. '
3781
'For more information, see '
3782
'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
3783
branch_format='bzrlib.branch.BzrBranchFormat6',
3784
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3788
format_registry.register_metadir('rich-root-pack',
3789
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
3790
help='New in 1.0: A variant of pack-0.92 that supports rich-root data '
3791
'(needed for bzr-svn and bzr-git).',
3792
branch_format='bzrlib.branch.BzrBranchFormat6',
3793
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3795
format_registry.register_metadir('1.6',
3796
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5',
3797
help='A format that allows a branch to indicate that there is another '
3798
'(stacked) repository that should be used to access data that is '
3799
'not present locally.',
3800
branch_format='bzrlib.branch.BzrBranchFormat7',
3801
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3803
format_registry.register_metadir('1.6.1-rich-root',
3804
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5RichRoot',
3805
help='A variant of 1.6 that supports rich-root data '
3806
'(needed for bzr-svn and bzr-git).',
3807
branch_format='bzrlib.branch.BzrBranchFormat7',
3808
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3810
format_registry.register_metadir('1.9',
3811
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3812
help='A repository format using B+tree indexes. These indexes '
3813
'are smaller in size, have smarter caching and provide faster '
3814
'performance for most operations.',
3815
branch_format='bzrlib.branch.BzrBranchFormat7',
3816
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3818
format_registry.register_metadir('1.9-rich-root',
3819
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
3820
help='A variant of 1.9 that supports rich-root data '
3821
'(needed for bzr-svn and bzr-git).',
3822
branch_format='bzrlib.branch.BzrBranchFormat7',
3823
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3825
format_registry.register_metadir('1.14',
3826
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3827
help='A working-tree format that supports content filtering.',
3828
branch_format='bzrlib.branch.BzrBranchFormat7',
3829
tree_format='bzrlib.workingtree.WorkingTreeFormat5',
3831
format_registry.register_metadir('1.14-rich-root',
3832
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
3833
help='A variant of 1.14 that supports rich-root data '
3834
'(needed for bzr-svn and bzr-git).',
3835
branch_format='bzrlib.branch.BzrBranchFormat7',
3836
tree_format='bzrlib.workingtree.WorkingTreeFormat5',
3838
# The following un-numbered 'development' formats should always just be aliases.
3839
format_registry.register_metadir('development-rich-root',
3840
'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
3841
help='Current development format. Supports rich roots. Can convert data '
3842
'to and from rich-root-pack (and anything compatible with '
3843
'rich-root-pack) format repositories. Repositories and branches in '
3844
'this format can only be read by bzr.dev. Please read '
3845
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3847
branch_format='bzrlib.branch.BzrBranchFormat7',
3848
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3852
format_registry.register_metadir('development-subtree',
3853
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment2Subtree',
3854
help='Current development format, subtree variant. Can convert data to and '
3855
'from pack-0.92-subtree (and anything compatible with '
3856
'pack-0.92-subtree) format repositories. Repositories and branches in '
3857
'this format can only be read by bzr.dev. Please read '
3858
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3860
branch_format='bzrlib.branch.BzrBranchFormat7',
3861
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3863
alias=False, # Restore to being an alias when an actual development subtree format is added
3864
# This current non-alias status is simply because we did not introduce a
3865
# chk based subtree format.
3868
# And the development formats above will have aliased one of the following:
3869
format_registry.register_metadir('development6-rich-root',
3870
'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
3871
help='pack-1.9 with 255-way hashed CHK inv, group compress, rich roots '
3873
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3875
branch_format='bzrlib.branch.BzrBranchFormat7',
3876
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3881
format_registry.register_metadir('development7-rich-root',
3882
'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK2',
3883
help='pack-1.9 with 255-way hashed CHK inv, bencode revision, group compress, '
3884
'rich roots. Please read '
3885
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3887
branch_format='bzrlib.branch.BzrBranchFormat7',
3888
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3893
format_registry.register_metadir('2a',
3894
'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
3895
help='First format for bzr 2.0 series.\n'
3896
'Uses group-compress storage.\n'
3897
'Provides rich roots which are a one-way transition.\n',
3898
# 'storage in packs, 255-way hashed CHK inventory, bencode revision, group compress, '
3899
# 'rich roots. Supported by bzr 1.16 and later.',
3900
branch_format='bzrlib.branch.BzrBranchFormat7',
3901
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3905
# The following format should be an alias for the rich root equivalent
3906
# of the default format
3907
format_registry.register_metadir('default-rich-root',
3908
'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
3909
branch_format='bzrlib.branch.BzrBranchFormat7',
3910
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3914
# The current format that is made on 'bzr init'.
3915
format_registry.set_default('2a')
added
removed
bzrlib/bzrdir.py
