1
# Copyright (C) 2005 Canonical Ltd
1
# Copyright (C) 2005-2012 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21
from warnings import warn
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
from __future__ import absolute_import
22
21
from cStringIO import StringIO
26
from bzrlib.trace import mutter, note
27
from bzrlib.osutils import (isdir, quotefn, compact_date, rand_bytes,
28
rename, splitpath, sha_file, appendpath,
30
from bzrlib.errors import (BzrError, InvalidRevisionNumber, InvalidRevisionId,
31
NoSuchRevision, HistoryMissing, NotBranchError,
32
DivergedBranches, LockError, UnlistableStore,
33
UnlistableBranch, NoSuchFile)
34
from bzrlib.textui import show_status
35
from bzrlib.revision import Revision, validate_revision_id, is_ancestor
36
from bzrlib.delta import compare_trees
37
from bzrlib.tree import EmptyTree, RevisionTree
38
from bzrlib.inventory import Inventory
39
from bzrlib.store import copy_all
40
from bzrlib.store.compressed_text import CompressedTextStore
41
from bzrlib.store.text import TextStore
42
from bzrlib.store.weave import WeaveStore
43
from bzrlib.transport import Transport, get_transport
48
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
49
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
50
## TODO: Maybe include checks for common corruption of newlines, etc?
53
# TODO: Some operations like log might retrieve the same revisions
54
# repeatedly to calculate deltas. We could perhaps have a weakref
55
# cache in memory to make this faster. In general anything can be
56
# cached in memory between lock and unlock operations.
58
def find_branch(*ignored, **ignored_too):
59
# XXX: leave this here for about one release, then remove it
60
raise NotImplementedError('find_branch() is not supported anymore, '
61
'please use one of the new branch constructors')
62
def _relpath(base, path):
63
"""Return path relative to base, or raise exception.
65
The path may be either an absolute path or a path relative to the
66
current working directory.
68
Lifted out of Branch.relpath for ease of testing.
70
os.path.commonprefix (python2.4) has a bad bug that it works just
71
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
72
avoids that problem."""
73
rp = os.path.abspath(path)
77
while len(head) >= len(base):
80
head, tail = os.path.split(head)
84
raise NotBranchError("path %r is not within branch %r" % (rp, base))
89
def find_branch_root(t):
90
"""Find the branch root enclosing the transport's base.
92
t is a Transport object.
94
It is not necessary that the base of t exists.
96
Basically we keep looking up until we find the control directory or
97
run into the root. If there isn't one, raises NotBranchError.
101
if t.has(bzrlib.BZRDIR):
103
new_t = t.clone('..')
104
if new_t.base == t.base:
105
# reached the root, whatever that may be
106
raise NotBranchError('%s is not in a branch' % orig_base)
110
######################################################################
113
class Branch(object):
23
from bzrlib.lazy_import import lazy_import
24
lazy_import(globals(), """
31
config as _mod_config,
40
revision as _mod_revision,
49
from bzrlib.i18n import gettext, ngettext
52
# Explicitly import bzrlib.bzrdir so that the BzrProber
53
# is guaranteed to be registered.
60
from bzrlib.decorators import (
65
from bzrlib.hooks import Hooks
66
from bzrlib.inter import InterObject
67
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
68
from bzrlib import registry
69
from bzrlib.symbol_versioning import (
73
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
76
class Branch(controldir.ControlComponent):
114
77
"""Branch holding a history of revisions.
117
Base directory/url of the branch.
80
Base directory/url of the branch; using control_url and
81
control_transport is more standardized.
82
:ivar hooks: An instance of BranchHooks.
83
:ivar _master_branch_cache: cached result of get_master_branch, see
86
# this is really an instance variable - FIXME move it there
121
def __init__(self, *ignored, **ignored_too):
122
raise NotImplementedError('The Branch class is abstract')
125
def open_downlevel(base):
126
"""Open a branch which may be of an old format.
128
Only local branches are supported."""
129
return _Branch(get_transport(base), relax_version_check=True)
133
"""Open an existing branch, rooted at 'base' (url)"""
134
t = get_transport(base)
138
def open_containing(url):
91
def control_transport(self):
92
return self._transport
95
def user_transport(self):
96
return self.bzrdir.user_transport
98
def __init__(self, possible_transports=None):
99
self.tags = self._format.make_tags(self)
100
self._revision_history_cache = None
101
self._revision_id_to_revno_cache = None
102
self._partial_revision_id_to_revno_cache = {}
103
self._partial_revision_history_cache = []
104
self._tags_bytes = None
105
self._last_revision_info_cache = None
106
self._master_branch_cache = None
107
self._merge_sorted_revisions_cache = None
108
self._open_hook(possible_transports)
109
hooks = Branch.hooks['open']
113
def _open_hook(self, possible_transports):
114
"""Called by init to allow simpler extension of the base class."""
116
def _activate_fallback_location(self, url, possible_transports):
117
"""Activate the branch/repository from url as a fallback repository."""
118
for existing_fallback_repo in self.repository._fallback_repositories:
119
if existing_fallback_repo.user_url == url:
120
# This fallback is already configured. This probably only
121
# happens because ControlDir.sprout is a horrible mess. To avoid
122
# confusing _unstack we don't add this a second time.
123
mutter('duplicate activation of fallback %r on %r', url, self)
125
repo = self._get_fallback_repository(url, possible_transports)
126
if repo.has_same_location(self.repository):
127
raise errors.UnstackableLocationError(self.user_url, url)
128
self.repository.add_fallback_repository(repo)
130
def break_lock(self):
131
"""Break a lock if one is present from another instance.
133
Uses the ui factory to ask for confirmation if the lock may be from
136
This will probe the repository for its lock as well.
138
self.control_files.break_lock()
139
self.repository.break_lock()
140
master = self.get_master_branch()
141
if master is not None:
144
def _check_stackable_repo(self):
145
if not self.repository._format.supports_external_lookups:
146
raise errors.UnstackableRepositoryFormat(self.repository._format,
147
self.repository.base)
149
def _extend_partial_history(self, stop_index=None, stop_revision=None):
150
"""Extend the partial history to include a given index
152
If a stop_index is supplied, stop when that index has been reached.
153
If a stop_revision is supplied, stop when that revision is
154
encountered. Otherwise, stop when the beginning of history is
157
:param stop_index: The index which should be present. When it is
158
present, history extension will stop.
159
:param stop_revision: The revision id which should be present. When
160
it is encountered, history extension will stop.
162
if len(self._partial_revision_history_cache) == 0:
163
self._partial_revision_history_cache = [self.last_revision()]
164
repository._iter_for_revno(
165
self.repository, self._partial_revision_history_cache,
166
stop_index=stop_index, stop_revision=stop_revision)
167
if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
168
self._partial_revision_history_cache.pop()
170
def _get_check_refs(self):
171
"""Get the references needed for check().
175
revid = self.last_revision()
176
return [('revision-existence', revid), ('lefthand-distance', revid)]
179
def open(base, _unsupported=False, possible_transports=None):
180
"""Open the branch rooted at base.
182
For instance, if the branch is at URL/.bzr/branch,
183
Branch.open(URL) -> a Branch instance.
185
control = controldir.ControlDir.open(base,
186
possible_transports=possible_transports, _unsupported=_unsupported)
187
return control.open_branch(unsupported=_unsupported,
188
possible_transports=possible_transports)
191
def open_from_transport(transport, name=None, _unsupported=False,
192
possible_transports=None):
193
"""Open the branch rooted at transport"""
194
control = controldir.ControlDir.open_from_transport(transport, _unsupported)
195
return control.open_branch(name=name, unsupported=_unsupported,
196
possible_transports=possible_transports)
199
def open_containing(url, possible_transports=None):
139
200
"""Open an existing branch which contains url.
141
202
This probes for a branch at url, and searches upwards from there.
143
t = get_transport(url)
144
t = find_branch_root(t)
148
def initialize(base):
149
"""Create a new branch, rooted at 'base' (url)"""
150
t = get_transport(base)
151
return _Branch(t, init=True)
153
def setup_caching(self, cache_root):
154
"""Subclasses that care about caching should override this, and set
155
up cached stores located under cache_root.
159
class _Branch(Branch):
160
"""A branch stored in the actual filesystem.
162
Note that it's "local" in the context of the filesystem; it doesn't
163
really matter if it's on an nfs/smb/afs/coda/... share, as long as
164
it's writable, and can be accessed via the normal filesystem API.
170
If _lock_mode is true, a positive count of the number of times the
174
Lock object from bzrlib.lock.
176
# We actually expect this class to be somewhat short-lived; part of its
177
# purpose is to try to isolate what bits of the branch logic are tied to
178
# filesystem access, so that in a later step, we can extricate them to
179
# a separarte ("storage") class.
183
_inventory_weave = None
185
# Map some sort of prefix into a namespace
186
# stuff like "revno:10", "revid:", etc.
187
# This should match a prefix with a function which accepts
188
REVISION_NAMESPACES = {}
190
def push_stores(self, branch_to):
191
"""Copy the content of this branches store to branch_to."""
192
if (self._branch_format != branch_to._branch_format
193
or self._branch_format != 4):
194
from bzrlib.fetch import greedy_fetch
195
mutter("falling back to fetch logic to push between %s(%s) and %s(%s)",
196
self, self._branch_format, branch_to, branch_to._branch_format)
197
greedy_fetch(to_branch=branch_to, from_branch=self,
198
revision=self.last_revision())
201
store_pairs = ((self.text_store, branch_to.text_store),
202
(self.inventory_store, branch_to.inventory_store),
203
(self.revision_store, branch_to.revision_store))
205
for from_store, to_store in store_pairs:
206
copy_all(from_store, to_store)
207
except UnlistableStore:
208
raise UnlistableBranch(from_store)
210
def __init__(self, transport, init=False,
211
relax_version_check=False):
212
"""Create new branch object at a particular location.
214
transport -- A Transport object, defining how to access files.
215
(If a string, transport.transport() will be used to
216
create a Transport object)
218
init -- If True, create new control files in a previously
219
unversioned directory. If False, the branch must already
222
relax_version_check -- If true, the usual check for the branch
223
version is not applied. This is intended only for
224
upgrade/recovery type use; it's not guaranteed that
225
all operations will work on old format branches.
227
In the test suite, creation of new trees is tested using the
228
`ScratchBranch` class.
230
assert isinstance(transport, Transport), \
231
"%r is not a Transport" % transport
232
self._transport = transport
235
self._check_format(relax_version_check)
237
def get_store(name, compressed=True):
238
relpath = self._rel_controlfilename(name)
240
store = CompressedTextStore(self._transport.clone(relpath))
242
store = TextStore(self._transport.clone(relpath))
243
if self._transport.should_cache():
244
from meta_store import CachedStore
245
cache_path = os.path.join(self.cache_root, name)
247
store = CachedStore(store, cache_path)
250
relpath = self._rel_controlfilename(name)
251
ws = WeaveStore(self._transport.clone(relpath))
252
if self._transport.should_cache():
253
ws.enable_cache = True
256
if self._branch_format == 4:
257
self.inventory_store = get_store('inventory-store')
258
self.text_store = get_store('text-store')
259
self.revision_store = get_store('revision-store')
260
elif self._branch_format == 5:
261
self.control_weaves = get_weave([])
262
self.weave_store = get_weave('weaves')
263
self.revision_store = get_store('revision-store', compressed=False)
266
return '%s(%r)' % (self.__class__.__name__, self._transport.base)
273
if self._lock_mode or self._lock:
274
# XXX: This should show something every time, and be suitable for
275
# headless operation and embedding
276
warn("branch %r was not explicitly unlocked" % self)
279
# TODO: It might be best to do this somewhere else,
280
# but it is nice for a Branch object to automatically
281
# cache it's information.
282
# Alternatively, we could have the Transport objects cache requests
283
# See the earlier discussion about how major objects (like Branch)
284
# should never expect their __del__ function to run.
285
if hasattr(self, 'cache_root') and self.cache_root is not None:
204
Basically we keep looking up until we find the control directory or
205
run into the root. If there isn't one, raises NotBranchError.
206
If there is one and it is either an unrecognised format or an unsupported
207
format, UnknownFormatError or UnsupportedFormatError are raised.
208
If there is one, it is returned, along with the unused portion of url.
210
control, relpath = controldir.ControlDir.open_containing(url,
212
branch = control.open_branch(possible_transports=possible_transports)
213
return (branch, relpath)
215
def _push_should_merge_tags(self):
216
"""Should _basic_push merge this branch's tags into the target?
218
The default implementation returns False if this branch has no tags,
219
and True the rest of the time. Subclasses may override this.
221
return self.supports_tags() and self.tags.get_tag_dict()
223
def get_config(self):
224
"""Get a bzrlib.config.BranchConfig for this Branch.
226
This can then be used to get and set configuration options for the
229
:return: A bzrlib.config.BranchConfig.
231
return _mod_config.BranchConfig(self)
233
def get_config_stack(self):
234
"""Get a bzrlib.config.BranchStack for this Branch.
236
This can then be used to get and set configuration options for the
239
:return: A bzrlib.config.BranchStack.
241
return _mod_config.BranchStack(self)
243
def _get_config(self):
244
"""Get the concrete config for just the config in this branch.
246
This is not intended for client use; see Branch.get_config for the
251
:return: An object supporting get_option and set_option.
253
raise NotImplementedError(self._get_config)
255
def store_uncommitted(self, creator):
256
"""Store uncommitted changes from a ShelfCreator.
258
:param creator: The ShelfCreator containing uncommitted changes, or
259
None to delete any stored changes.
260
:raises: ChangesAlreadyStored if the branch already has changes.
262
raise NotImplementedError(self.store_uncommitted)
264
def get_unshelver(self, tree):
265
"""Return a shelf.Unshelver for this branch and tree.
267
:param tree: The tree to use to construct the Unshelver.
268
:return: an Unshelver or None if no changes are stored.
270
raise NotImplementedError(self.get_unshelver)
272
def _get_fallback_repository(self, url, possible_transports):
273
"""Get the repository we fallback to at url."""
274
url = urlutils.join(self.base, url)
275
a_branch = Branch.open(url, possible_transports=possible_transports)
276
return a_branch.repository
279
def _get_tags_bytes(self):
280
"""Get the bytes of a serialised tags dict.
282
Note that not all branches support tags, nor do all use the same tags
283
logic: this method is specific to BasicTags. Other tag implementations
284
may use the same method name and behave differently, safely, because
285
of the double-dispatch via
286
format.make_tags->tags_instance->get_tags_dict.
288
:return: The bytes of the tags file.
289
:seealso: Branch._set_tags_bytes.
291
if self._tags_bytes is None:
292
self._tags_bytes = self._transport.get_bytes('tags')
293
return self._tags_bytes
295
def _get_nick(self, local=False, possible_transports=None):
296
config = self.get_config()
297
# explicit overrides master, but don't look for master if local is True
298
if not local and not config.has_explicit_nickname():
288
shutil.rmtree(self.cache_root)
291
self.cache_root = None
295
return self._transport.base
298
base = property(_get_base)
301
def lock_write(self):
302
# TODO: Upgrade locking to support using a Transport,
303
# and potentially a remote locking protocol
305
if self._lock_mode != 'w':
306
raise LockError("can't upgrade to a write lock from %r" %
308
self._lock_count += 1
310
self._lock = self._transport.lock_write(
311
self._rel_controlfilename('branch-lock'))
312
self._lock_mode = 'w'
300
master = self.get_master_branch(possible_transports)
301
if master and self.user_url == master.user_url:
302
raise errors.RecursiveBind(self.user_url)
303
if master is not None:
304
# return the master branch value
306
except errors.RecursiveBind, e:
308
except errors.BzrError, e:
309
# Silently fall back to local implicit nick if the master is
311
mutter("Could not connect to bound branch, "
312
"falling back to local nick.\n " + str(e))
313
return config.get_nickname()
315
def _set_nick(self, nick):
316
self.get_config().set_user_option('nickname', nick, warn_masked=True)
318
nick = property(_get_nick, _set_nick)
321
raise NotImplementedError(self.is_locked)
323
def _lefthand_history(self, revision_id, last_rev=None,
325
if 'evil' in debug.debug_flags:
326
mutter_callsite(4, "_lefthand_history scales with history.")
327
# stop_revision must be a descendant of last_revision
328
graph = self.repository.get_graph()
329
if last_rev is not None:
330
if not graph.is_ancestor(last_rev, revision_id):
331
# our previous tip is not merged into stop_revision
332
raise errors.DivergedBranches(self, other_branch)
333
# make a new revision history from the graph
334
parents_map = graph.get_parent_map([revision_id])
335
if revision_id not in parents_map:
336
raise errors.NoSuchRevision(self, revision_id)
337
current_rev_id = revision_id
339
check_not_reserved_id = _mod_revision.check_not_reserved_id
340
# Do not include ghosts or graph origin in revision_history
341
while (current_rev_id in parents_map and
342
len(parents_map[current_rev_id]) > 0):
343
check_not_reserved_id(current_rev_id)
344
new_history.append(current_rev_id)
345
current_rev_id = parents_map[current_rev_id][0]
346
parents_map = graph.get_parent_map([current_rev_id])
347
new_history.reverse()
350
def lock_write(self, token=None):
351
"""Lock the branch for write operations.
353
:param token: A token to permit reacquiring a previously held and
355
:return: A BranchWriteLockResult.
357
raise NotImplementedError(self.lock_write)
316
359
def lock_read(self):
318
assert self._lock_mode in ('r', 'w'), \
319
"invalid lock mode %r" % self._lock_mode
320
self._lock_count += 1
322
self._lock = self._transport.lock_read(
323
self._rel_controlfilename('branch-lock'))
324
self._lock_mode = 'r'
360
"""Lock the branch for read operations.
362
:return: A bzrlib.lock.LogicalLockResult.
364
raise NotImplementedError(self.lock_read)
327
366
def unlock(self):
328
if not self._lock_mode:
329
raise LockError('branch %r is not locked' % (self))
331
if self._lock_count > 1:
332
self._lock_count -= 1
336
self._lock_mode = self._lock_count = None
338
def abspath(self, name):
339
"""Return absolute filename for something in the branch"""
340
return self._transport.abspath(name)
342
def relpath(self, path):
343
"""Return path relative to this branch of something inside it.
345
Raises an error if path is not in this branch."""
346
return self._transport.relpath(path)
349
def _rel_controlfilename(self, file_or_path):
350
if isinstance(file_or_path, basestring):
351
file_or_path = [file_or_path]
352
return [bzrlib.BZRDIR] + file_or_path
354
def controlfilename(self, file_or_path):
355
"""Return location relative to branch."""
356
return self._transport.abspath(self._rel_controlfilename(file_or_path))
359
def controlfile(self, file_or_path, mode='r'):
360
"""Open a control file for this branch.
362
There are two classes of file in the control directory: text
363
and binary. binary files are untranslated byte streams. Text
364
control files are stored with Unix newlines and in UTF-8, even
365
if the platform or locale defaults are different.
367
Controlfiles should almost never be opened in write mode but
368
rather should be atomically copied and replaced using atomicfile.
372
relpath = self._rel_controlfilename(file_or_path)
373
#TODO: codecs.open() buffers linewise, so it was overloaded with
374
# a much larger buffer, do we need to do the same for getreader/getwriter?
376
return self._transport.get(relpath)
378
raise BzrError("Branch.controlfile(mode='wb') is not supported, use put_controlfiles")
380
return codecs.getreader('utf-8')(self._transport.get(relpath), errors='replace')
382
raise BzrError("Branch.controlfile(mode='w') is not supported, use put_controlfiles")
384
raise BzrError("invalid controlfile mode %r" % mode)
386
def put_controlfile(self, path, f, encode=True):
387
"""Write an entry as a controlfile.
389
:param path: The path to put the file, relative to the .bzr control
391
:param f: A file-like or string object whose contents should be copied.
392
:param encode: If true, encode the contents as utf-8
394
self.put_controlfiles([(path, f)], encode=encode)
396
def put_controlfiles(self, files, encode=True):
397
"""Write several entries as controlfiles.
399
:param files: A list of [(path, file)] pairs, where the path is the directory
400
underneath the bzr control directory
401
:param encode: If true, encode the contents as utf-8
405
for path, f in files:
407
if isinstance(f, basestring):
408
f = f.encode('utf-8', 'replace')
410
f = codecs.getwriter('utf-8')(f, errors='replace')
411
path = self._rel_controlfilename(path)
412
ctrl_files.append((path, f))
413
self._transport.put_multi(ctrl_files)
415
def _make_control(self):
416
from bzrlib.inventory import Inventory
417
from bzrlib.weavefile import write_weave_v5
418
from bzrlib.weave import Weave
420
# Create an empty inventory
422
# if we want per-tree root ids then this is the place to set
423
# them; they're not needed for now and so ommitted for
425
bzrlib.xml5.serializer_v5.write_inventory(Inventory(), sio)
426
empty_inv = sio.getvalue()
428
bzrlib.weavefile.write_weave_v5(Weave(), sio)
429
empty_weave = sio.getvalue()
431
dirs = [[], 'revision-store', 'weaves']
433
"This is a Bazaar-NG control directory.\n"
434
"Do not change any files in this directory.\n"),
435
('branch-format', BZR_BRANCH_FORMAT_5),
436
('revision-history', ''),
439
('pending-merges', ''),
440
('inventory', empty_inv),
441
('inventory.weave', empty_weave),
442
('ancestry.weave', empty_weave)
444
cfn = self._rel_controlfilename
445
self._transport.mkdir_multi([cfn(d) for d in dirs])
446
self.put_controlfiles(files)
447
mutter('created control directory in ' + self._transport.base)
449
def _check_format(self, relax_version_check):
450
"""Check this branch format is supported.
452
The format level is stored, as an integer, in
453
self._branch_format for code that needs to check it later.
455
In the future, we might need different in-memory Branch
456
classes to support downlevel branches. But not yet.
459
fmt = self.controlfile('branch-format', 'r').read()
461
raise NotBranchError(self.base)
463
if fmt == BZR_BRANCH_FORMAT_5:
464
self._branch_format = 5
465
elif fmt == BZR_BRANCH_FORMAT_4:
466
self._branch_format = 4
468
if (not relax_version_check
469
and self._branch_format != 5):
470
raise BzrError('sorry, branch format %r not supported' % fmt,
471
['use a different bzr version',
472
'or remove the .bzr directory'
473
' and "bzr init" again'])
475
def get_root_id(self):
476
"""Return the id of this branches root"""
477
inv = self.read_working_inventory()
478
return inv.root.file_id
480
def set_root_id(self, file_id):
481
inv = self.read_working_inventory()
482
orig_root_id = inv.root.file_id
483
del inv._byid[inv.root.file_id]
484
inv.root.file_id = file_id
485
inv._byid[inv.root.file_id] = inv.root
488
if entry.parent_id in (None, orig_root_id):
489
entry.parent_id = inv.root.file_id
490
self._write_inventory(inv)
492
def read_working_inventory(self):
493
"""Read the working inventory."""
496
# ElementTree does its own conversion from UTF-8, so open in
498
f = self.controlfile('inventory', 'rb')
499
return bzrlib.xml5.serializer_v5.read_inventory(f)
504
def _write_inventory(self, inv):
505
"""Update the working inventory.
507
That is to say, the inventory describing changes underway, that
508
will be committed to the next revision.
510
from cStringIO import StringIO
514
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
516
# Transport handles atomicity
517
self.put_controlfile('inventory', sio)
521
mutter('wrote working inventory')
523
inventory = property(read_working_inventory, _write_inventory, None,
524
"""Inventory for the working copy.""")
526
def add(self, files, ids=None):
527
"""Make files versioned.
529
Note that the command line normally calls smart_add instead,
530
which can automatically recurse.
532
This puts the files in the Added state, so that they will be
533
recorded by the next commit.
536
List of paths to add, relative to the base of the tree.
539
If set, use these instead of automatically generated ids.
540
Must be the same length as the list of files, but may
541
contain None for ids that are to be autogenerated.
543
TODO: Perhaps have an option to add the ids even if the files do
546
TODO: Perhaps yield the ids and paths as they're added.
548
# TODO: Re-adding a file that is removed in the working copy
549
# should probably put it back with the previous ID.
550
if isinstance(files, basestring):
551
assert(ids is None or isinstance(ids, basestring))
557
ids = [None] * len(files)
559
assert(len(ids) == len(files))
563
inv = self.read_working_inventory()
564
for f,file_id in zip(files, ids):
565
if is_control_file(f):
566
raise BzrError("cannot add control file %s" % quotefn(f))
571
raise BzrError("cannot add top-level %r" % f)
573
fullpath = os.path.normpath(self.abspath(f))
576
kind = file_kind(fullpath)
578
# maybe something better?
579
raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
581
if kind not in ('file', 'directory', 'symlink'):
582
raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
585
file_id = gen_file_id(f)
586
inv.add_path(f, kind=kind, file_id=file_id)
588
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
590
self._write_inventory(inv)
595
def print_file(self, file, revno):
596
"""Print `file` to stdout."""
599
tree = self.revision_tree(self.get_rev_id(revno))
600
# use inventory as it was in that revision
601
file_id = tree.inventory.path2id(file)
603
raise BzrError("%r is not present in revision %s" % (file, revno))
604
tree.print_file(file_id)
609
def remove(self, files, verbose=False):
610
"""Mark nominated files for removal from the inventory.
612
This does not remove their text. This does not run on
614
TODO: Refuse to remove modified files unless --force is given?
616
TODO: Do something useful with directories.
618
TODO: Should this remove the text or not? Tough call; not
619
removing may be useful and the user can just use use rm, and
620
is the opposite of add. Removing it is consistent with most
621
other tools. Maybe an option.
623
## TODO: Normalize names
624
## TODO: Remove nested loops; better scalability
625
if isinstance(files, basestring):
631
tree = self.working_tree()
634
# do this before any modifications
638
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
639
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
641
# having remove it, it must be either ignored or unknown
642
if tree.is_ignored(f):
646
show_status(new_status, inv[fid].kind, quotefn(f))
649
self._write_inventory(inv)
653
# FIXME: this doesn't need to be a branch method
654
def set_inventory(self, new_inventory_list):
655
from bzrlib.inventory import Inventory, InventoryEntry
656
inv = Inventory(self.get_root_id())
657
for path, file_id, parent, kind in new_inventory_list:
658
name = os.path.basename(path)
661
inv.add(InventoryEntry(file_id, name, kind, parent))
662
self._write_inventory(inv)
665
"""Return all unknown files.
667
These are files in the working directory that are not versioned or
668
control files or ignored.
670
>>> b = ScratchBranch(files=['foo', 'foo~'])
671
>>> list(b.unknowns())
674
>>> list(b.unknowns())
677
>>> list(b.unknowns())
680
return self.working_tree().unknowns()
683
def append_revision(self, *revision_ids):
684
for revision_id in revision_ids:
685
mutter("add {%s} to revision-history" % revision_id)
688
rev_history = self.revision_history()
689
rev_history.extend(revision_ids)
690
self.put_controlfile('revision-history', '\n'.join(rev_history))
694
def has_revision(self, revision_id):
695
"""True if this branch has a copy of the revision.
697
This does not necessarily imply the revision is merge
698
or on the mainline."""
699
return (revision_id is None
700
or revision_id in self.revision_store)
702
def get_revision_xml_file(self, revision_id):
703
"""Return XML file object for revision object."""
704
if not revision_id or not isinstance(revision_id, basestring):
705
raise InvalidRevisionId(revision_id)
710
return self.revision_store[revision_id]
711
except (IndexError, KeyError):
712
raise bzrlib.errors.NoSuchRevision(self, revision_id)
717
get_revision_xml = get_revision_xml_file
719
def get_revision_xml(self, revision_id):
720
return self.get_revision_xml_file(revision_id).read()
723
def get_revision(self, revision_id):
724
"""Return the Revision object for a named revision"""
725
xml_file = self.get_revision_xml_file(revision_id)
728
r = bzrlib.xml5.serializer_v5.read_revision(xml_file)
729
except SyntaxError, e:
730
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
734
assert r.revision_id == revision_id
367
raise NotImplementedError(self.unlock)
369
def peek_lock_mode(self):
370
"""Return lock mode for the Branch: 'r', 'w' or None"""
371
raise NotImplementedError(self.peek_lock_mode)
373
def get_physical_lock_status(self):
374
raise NotImplementedError(self.get_physical_lock_status)
377
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
378
"""Return the revision_id for a dotted revno.
380
:param revno: a tuple like (1,) or (1,1,2)
381
:param _cache_reverse: a private parameter enabling storage
382
of the reverse mapping in a top level cache. (This should
383
only be done in selective circumstances as we want to
384
avoid having the mapping cached multiple times.)
385
:return: the revision_id
386
:raises errors.NoSuchRevision: if the revno doesn't exist
388
rev_id = self._do_dotted_revno_to_revision_id(revno)
390
self._partial_revision_id_to_revno_cache[rev_id] = revno
393
def _do_dotted_revno_to_revision_id(self, revno):
394
"""Worker function for dotted_revno_to_revision_id.
396
Subclasses should override this if they wish to
397
provide a more efficient implementation.
400
return self.get_rev_id(revno[0])
401
revision_id_to_revno = self.get_revision_id_to_revno_map()
402
revision_ids = [revision_id for revision_id, this_revno
403
in revision_id_to_revno.iteritems()
404
if revno == this_revno]
405
if len(revision_ids) == 1:
406
return revision_ids[0]
408
revno_str = '.'.join(map(str, revno))
409
raise errors.NoSuchRevision(self, revno_str)
412
def revision_id_to_dotted_revno(self, revision_id):
413
"""Given a revision id, return its dotted revno.
415
:return: a tuple like (1,) or (400,1,3).
417
return self._do_revision_id_to_dotted_revno(revision_id)
419
def _do_revision_id_to_dotted_revno(self, revision_id):
420
"""Worker function for revision_id_to_revno."""
421
# Try the caches if they are loaded
422
result = self._partial_revision_id_to_revno_cache.get(revision_id)
423
if result is not None:
425
if self._revision_id_to_revno_cache:
426
result = self._revision_id_to_revno_cache.get(revision_id)
428
raise errors.NoSuchRevision(self, revision_id)
429
# Try the mainline as it's optimised
431
revno = self.revision_id_to_revno(revision_id)
433
except errors.NoSuchRevision:
434
# We need to load and use the full revno map after all
435
result = self.get_revision_id_to_revno_map().get(revision_id)
437
raise errors.NoSuchRevision(self, revision_id)
441
def get_revision_id_to_revno_map(self):
442
"""Return the revision_id => dotted revno map.
444
This will be regenerated on demand, but will be cached.
446
:return: A dictionary mapping revision_id => dotted revno.
447
This dictionary should not be modified by the caller.
449
if self._revision_id_to_revno_cache is not None:
450
mapping = self._revision_id_to_revno_cache
452
mapping = self._gen_revno_map()
453
self._cache_revision_id_to_revno(mapping)
454
# TODO: jam 20070417 Since this is being cached, should we be returning
456
# I would rather not, and instead just declare that users should not
457
# modify the return value.
460
def _gen_revno_map(self):
461
"""Create a new mapping from revision ids to dotted revnos.
463
Dotted revnos are generated based on the current tip in the revision
465
This is the worker function for get_revision_id_to_revno_map, which
466
just caches the return value.
468
:return: A dictionary mapping revision_id => dotted revno.
470
revision_id_to_revno = dict((rev_id, revno)
471
for rev_id, depth, revno, end_of_merge
472
in self.iter_merge_sorted_revisions())
473
return revision_id_to_revno
476
def iter_merge_sorted_revisions(self, start_revision_id=None,
477
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
478
"""Walk the revisions for a branch in merge sorted order.
480
Merge sorted order is the output from a merge-aware,
481
topological sort, i.e. all parents come before their
482
children going forward; the opposite for reverse.
484
:param start_revision_id: the revision_id to begin walking from.
485
If None, the branch tip is used.
486
:param stop_revision_id: the revision_id to terminate the walk
487
after. If None, the rest of history is included.
488
:param stop_rule: if stop_revision_id is not None, the precise rule
489
to use for termination:
491
* 'exclude' - leave the stop revision out of the result (default)
492
* 'include' - the stop revision is the last item in the result
493
* 'with-merges' - include the stop revision and all of its
494
merged revisions in the result
495
* 'with-merges-without-common-ancestry' - filter out revisions
496
that are in both ancestries
497
:param direction: either 'reverse' or 'forward':
499
* reverse means return the start_revision_id first, i.e.
500
start at the most recent revision and go backwards in history
501
* forward returns tuples in the opposite order to reverse.
502
Note in particular that forward does *not* do any intelligent
503
ordering w.r.t. depth as some clients of this API may like.
504
(If required, that ought to be done at higher layers.)
506
:return: an iterator over (revision_id, depth, revno, end_of_merge)
509
* revision_id: the unique id of the revision
510
* depth: How many levels of merging deep this node has been
512
* revno_sequence: This field provides a sequence of
513
revision numbers for all revisions. The format is:
514
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
515
branch that the revno is on. From left to right the REVNO numbers
516
are the sequence numbers within that branch of the revision.
517
* end_of_merge: When True the next node (earlier in history) is
518
part of a different merge.
520
# Note: depth and revno values are in the context of the branch so
521
# we need the full graph to get stable numbers, regardless of the
523
if self._merge_sorted_revisions_cache is None:
524
last_revision = self.last_revision()
525
known_graph = self.repository.get_known_graph_ancestry(
527
self._merge_sorted_revisions_cache = known_graph.merge_sort(
529
filtered = self._filter_merge_sorted_revisions(
530
self._merge_sorted_revisions_cache, start_revision_id,
531
stop_revision_id, stop_rule)
532
# Make sure we don't return revisions that are not part of the
533
# start_revision_id ancestry.
534
filtered = self._filter_start_non_ancestors(filtered)
535
if direction == 'reverse':
537
if direction == 'forward':
538
return reversed(list(filtered))
540
raise ValueError('invalid direction %r' % direction)
542
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
543
start_revision_id, stop_revision_id, stop_rule):
544
"""Iterate over an inclusive range of sorted revisions."""
545
rev_iter = iter(merge_sorted_revisions)
546
if start_revision_id is not None:
547
for node in rev_iter:
549
if rev_id != start_revision_id:
552
# The decision to include the start or not
553
# depends on the stop_rule if a stop is provided
554
# so pop this node back into the iterator
555
rev_iter = itertools.chain(iter([node]), rev_iter)
557
if stop_revision_id is None:
559
for node in rev_iter:
561
yield (rev_id, node.merge_depth, node.revno,
563
elif stop_rule == 'exclude':
564
for node in rev_iter:
566
if rev_id == stop_revision_id:
568
yield (rev_id, node.merge_depth, node.revno,
570
elif stop_rule == 'include':
571
for node in rev_iter:
573
yield (rev_id, node.merge_depth, node.revno,
575
if rev_id == stop_revision_id:
577
elif stop_rule == 'with-merges-without-common-ancestry':
578
# We want to exclude all revisions that are already part of the
579
# stop_revision_id ancestry.
580
graph = self.repository.get_graph()
581
ancestors = graph.find_unique_ancestors(start_revision_id,
583
for node in rev_iter:
585
if rev_id not in ancestors:
587
yield (rev_id, node.merge_depth, node.revno,
589
elif stop_rule == 'with-merges':
590
stop_rev = self.repository.get_revision(stop_revision_id)
591
if stop_rev.parent_ids:
592
left_parent = stop_rev.parent_ids[0]
594
left_parent = _mod_revision.NULL_REVISION
595
# left_parent is the actual revision we want to stop logging at,
596
# since we want to show the merged revisions after the stop_rev too
597
reached_stop_revision_id = False
598
revision_id_whitelist = []
599
for node in rev_iter:
601
if rev_id == left_parent:
602
# reached the left parent after the stop_revision
604
if (not reached_stop_revision_id or
605
rev_id in revision_id_whitelist):
606
yield (rev_id, node.merge_depth, node.revno,
608
if reached_stop_revision_id or rev_id == stop_revision_id:
609
# only do the merged revs of rev_id from now on
610
rev = self.repository.get_revision(rev_id)
612
reached_stop_revision_id = True
613
revision_id_whitelist.extend(rev.parent_ids)
615
raise ValueError('invalid stop_rule %r' % stop_rule)
617
def _filter_start_non_ancestors(self, rev_iter):
618
# If we started from a dotted revno, we want to consider it as a tip
619
# and don't want to yield revisions that are not part of its
620
# ancestry. Given the order guaranteed by the merge sort, we will see
621
# uninteresting descendants of the first parent of our tip before the
623
first = rev_iter.next()
624
(rev_id, merge_depth, revno, end_of_merge) = first
627
# We start at a mainline revision so by definition, all others
628
# revisions in rev_iter are ancestors
629
for node in rev_iter:
634
pmap = self.repository.get_parent_map([rev_id])
635
parents = pmap.get(rev_id, [])
637
whitelist.update(parents)
639
# If there is no parents, there is nothing of interest left
641
# FIXME: It's hard to test this scenario here as this code is never
642
# called in that case. -- vila 20100322
645
for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
647
if rev_id in whitelist:
648
pmap = self.repository.get_parent_map([rev_id])
649
parents = pmap.get(rev_id, [])
650
whitelist.remove(rev_id)
651
whitelist.update(parents)
653
# We've reached the mainline, there is nothing left to
657
# A revision that is not part of the ancestry of our
660
yield (rev_id, merge_depth, revno, end_of_merge)
662
def leave_lock_in_place(self):
663
"""Tell this branch object not to release the physical lock when this
666
If lock_write doesn't return a token, then this method is not supported.
668
self.control_files.leave_in_place()
670
def dont_leave_lock_in_place(self):
671
"""Tell this branch object to release the physical lock when this
672
object is unlocked, even if it didn't originally acquire it.
674
If lock_write doesn't return a token, then this method is not supported.
676
self.control_files.dont_leave_in_place()
678
def bind(self, other):
679
"""Bind the local branch the other branch.
681
:param other: The branch to bind to
684
raise errors.UpgradeRequired(self.user_url)
686
def get_append_revisions_only(self):
687
"""Whether it is only possible to append revisions to the history.
689
if not self._format.supports_set_append_revisions_only():
691
return self.get_config_stack().get('append_revisions_only')
693
def set_append_revisions_only(self, enabled):
694
if not self._format.supports_set_append_revisions_only():
695
raise errors.UpgradeRequired(self.user_url)
696
self.get_config_stack().set('append_revisions_only', enabled)
698
def set_reference_info(self, file_id, tree_path, branch_location):
699
"""Set the branch location to use for a tree reference."""
700
raise errors.UnsupportedOperation(self.set_reference_info, self)
702
def get_reference_info(self, file_id):
703
"""Get the tree_path and branch_location for a tree reference."""
704
raise errors.UnsupportedOperation(self.get_reference_info, self)
707
def fetch(self, from_branch, last_revision=None, limit=None):
708
"""Copy revisions from from_branch into this branch.
710
:param from_branch: Where to copy from.
711
:param last_revision: What revision to stop at (None for at the end
713
:param limit: Optional rough limit of revisions to fetch
716
return InterBranch.get(from_branch, self).fetch(last_revision, limit=limit)
718
def get_bound_location(self):
719
"""Return the URL of the branch we are bound to.
721
Older format branches cannot bind, please be sure to use a metadir
726
def get_old_bound_location(self):
727
"""Return the URL of the branch we used to be bound to
729
raise errors.UpgradeRequired(self.user_url)
731
def get_commit_builder(self, parents, config_stack=None, timestamp=None,
732
timezone=None, committer=None, revprops=None,
733
revision_id=None, lossy=False):
734
"""Obtain a CommitBuilder for this branch.
736
:param parents: Revision ids of the parents of the new revision.
737
:param config: Optional configuration to use.
738
:param timestamp: Optional timestamp recorded for commit.
739
:param timezone: Optional timezone for timestamp.
740
:param committer: Optional committer to set for commit.
741
:param revprops: Optional dictionary of revision properties.
742
:param revision_id: Optional revision id.
743
:param lossy: Whether to discard data that can not be natively
744
represented, when pushing to a foreign VCS
747
if config_stack is None:
748
config_stack = self.get_config_stack()
750
return self.repository.get_commit_builder(self, parents, config_stack,
751
timestamp, timezone, committer, revprops, revision_id,
754
def get_master_branch(self, possible_transports=None):
755
"""Return the branch we are bound to.
757
:return: Either a Branch, or None
761
@deprecated_method(deprecated_in((2, 5, 0)))
737
762
def get_revision_delta(self, revno):
738
763
"""Return the delta for one revision.
740
765
The delta is relative to its mainline predecessor, or the
741
766
empty tree for revision 1.
743
assert isinstance(revno, int)
744
rh = self.revision_history()
745
if not (1 <= revno <= len(rh)):
746
raise InvalidRevisionNumber(revno)
748
# revno is 1-based; list is 0-based
750
new_tree = self.revision_tree(rh[revno-1])
752
old_tree = EmptyTree()
754
old_tree = self.revision_tree(rh[revno-2])
756
return compare_trees(old_tree, new_tree)
758
def get_revision_sha1(self, revision_id):
759
"""Hash the stored value of a revision, and return it."""
760
# In the future, revision entries will be signed. At that
761
# point, it is probably best *not* to include the signature
762
# in the revision hash. Because that lets you re-sign
763
# the revision, (add signatures/remove signatures) and still
764
# have all hash pointers stay consistent.
765
# But for now, just hash the contents.
766
return bzrlib.osutils.sha_file(self.get_revision_xml_file(revision_id))
768
def _get_ancestry_weave(self):
769
return self.control_weaves.get_weave('ancestry')
771
def get_ancestry(self, revision_id):
772
"""Return a list of revision-ids integrated by a revision.
775
if revision_id is None:
777
w = self._get_ancestry_weave()
778
return [None] + [l[:-1] for l in w.get_iter(w.lookup(revision_id))]
780
def get_inventory_weave(self):
781
return self.control_weaves.get_weave('inventory')
783
def get_inventory(self, revision_id):
784
"""Get Inventory object by hash."""
785
xml = self.get_inventory_xml(revision_id)
786
return bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
788
def get_inventory_xml(self, revision_id):
789
"""Get inventory XML as a file object."""
791
assert isinstance(revision_id, basestring), type(revision_id)
792
iw = self.get_inventory_weave()
793
return iw.get_text(iw.lookup(revision_id))
795
raise bzrlib.errors.HistoryMissing(self, 'inventory', revision_id)
797
def get_inventory_sha1(self, revision_id):
798
"""Return the sha1 hash of the inventory entry
800
return self.get_revision(revision_id).inventory_sha1
802
def get_revision_inventory(self, revision_id):
803
"""Return inventory of a past revision."""
804
# TODO: Unify this with get_inventory()
805
# bzr 0.0.6 and later imposes the constraint that the inventory_id
806
# must be the same as its revision, so this is trivial.
807
if revision_id == None:
808
return Inventory(self.get_root_id())
810
return self.get_inventory(revision_id)
812
def revision_history(self):
813
"""Return sequence of revision hashes on to this branch."""
816
return [l.rstrip('\r\n') for l in
817
self.controlfile('revision-history', 'r').readlines()]
769
revid = self.get_rev_id(revno)
770
except errors.NoSuchRevision:
771
raise errors.InvalidRevisionNumber(revno)
772
return self.repository.get_revision_delta(revid)
774
def get_stacked_on_url(self):
775
"""Get the URL this branch is stacked against.
777
:raises NotStacked: If the branch is not stacked.
778
:raises UnstackableBranchFormat: If the branch does not support
781
raise NotImplementedError(self.get_stacked_on_url)
783
def print_file(self, file, revision_id):
784
"""Print `file` to stdout."""
785
raise NotImplementedError(self.print_file)
788
def set_last_revision_info(self, revno, revision_id):
789
"""Set the last revision of this branch.
791
The caller is responsible for checking that the revno is correct
792
for this revision id.
794
It may be possible to set the branch last revision to an id not
795
present in the repository. However, branches can also be
796
configured to check constraints on history, in which case this may not
799
raise NotImplementedError(self.set_last_revision_info)
802
def generate_revision_history(self, revision_id, last_rev=None,
804
"""See Branch.generate_revision_history"""
805
graph = self.repository.get_graph()
806
(last_revno, last_revid) = self.last_revision_info()
807
known_revision_ids = [
808
(last_revid, last_revno),
809
(_mod_revision.NULL_REVISION, 0),
811
if last_rev is not None:
812
if not graph.is_ancestor(last_rev, revision_id):
813
# our previous tip is not merged into stop_revision
814
raise errors.DivergedBranches(self, other_branch)
815
revno = graph.find_distance_to_null(revision_id, known_revision_ids)
816
self.set_last_revision_info(revno, revision_id)
819
def set_parent(self, url):
820
"""See Branch.set_parent."""
821
# TODO: Maybe delete old location files?
822
# URLs should never be unicode, even on the local fs,
823
# FIXUP this and get_parent in a future branch format bump:
824
# read and rewrite the file. RBC 20060125
826
if isinstance(url, unicode):
828
url = url.encode('ascii')
829
except UnicodeEncodeError:
830
raise errors.InvalidURL(url,
831
"Urls must be 7-bit ascii, "
832
"use bzrlib.urlutils.escape")
833
url = urlutils.relative_url(self.base, url)
834
self._set_parent_location(url)
837
def set_stacked_on_url(self, url):
838
"""Set the URL this branch is stacked against.
840
:raises UnstackableBranchFormat: If the branch does not support
842
:raises UnstackableRepositoryFormat: If the repository does not support
845
if not self._format.supports_stacking():
846
raise errors.UnstackableBranchFormat(self._format, self.user_url)
847
# XXX: Changing from one fallback repository to another does not check
848
# that all the data you need is present in the new fallback.
849
# Possibly it should.
850
self._check_stackable_repo()
853
old_url = self.get_stacked_on_url()
854
except (errors.NotStacked, errors.UnstackableBranchFormat,
855
errors.UnstackableRepositoryFormat):
859
self._activate_fallback_location(url,
860
possible_transports=[self.bzrdir.root_transport])
861
# write this out after the repository is stacked to avoid setting a
862
# stacked config that doesn't work.
863
self._set_config_location('stacked_on_location', url)
866
"""Change a branch to be unstacked, copying data as needed.
868
Don't call this directly, use set_stacked_on_url(None).
870
pb = ui.ui_factory.nested_progress_bar()
872
pb.update(gettext("Unstacking"))
873
# The basic approach here is to fetch the tip of the branch,
874
# including all available ghosts, from the existing stacked
875
# repository into a new repository object without the fallbacks.
877
# XXX: See <https://launchpad.net/bugs/397286> - this may not be
878
# correct for CHKMap repostiories
879
old_repository = self.repository
880
if len(old_repository._fallback_repositories) != 1:
881
raise AssertionError("can't cope with fallback repositories "
882
"of %r (fallbacks: %r)" % (old_repository,
883
old_repository._fallback_repositories))
884
# Open the new repository object.
885
# Repositories don't offer an interface to remove fallback
886
# repositories today; take the conceptually simpler option and just
887
# reopen it. We reopen it starting from the URL so that we
888
# get a separate connection for RemoteRepositories and can
889
# stream from one of them to the other. This does mean doing
890
# separate SSH connection setup, but unstacking is not a
891
# common operation so it's tolerable.
892
new_bzrdir = controldir.ControlDir.open(
893
self.bzrdir.root_transport.base)
894
new_repository = new_bzrdir.find_repository()
895
if new_repository._fallback_repositories:
896
raise AssertionError("didn't expect %r to have "
897
"fallback_repositories"
898
% (self.repository,))
899
# Replace self.repository with the new repository.
900
# Do our best to transfer the lock state (i.e. lock-tokens and
901
# lock count) of self.repository to the new repository.
902
lock_token = old_repository.lock_write().repository_token
903
self.repository = new_repository
904
if isinstance(self, remote.RemoteBranch):
905
# Remote branches can have a second reference to the old
906
# repository that need to be replaced.
907
if self._real_branch is not None:
908
self._real_branch.repository = new_repository
909
self.repository.lock_write(token=lock_token)
910
if lock_token is not None:
911
old_repository.leave_lock_in_place()
912
old_repository.unlock()
913
if lock_token is not None:
914
# XXX: self.repository.leave_lock_in_place() before this
915
# function will not be preserved. Fortunately that doesn't
916
# affect the current default format (2a), and would be a
917
# corner-case anyway.
918
# - Andrew Bennetts, 2010/06/30
919
self.repository.dont_leave_lock_in_place()
923
old_repository.unlock()
924
except errors.LockNotHeld:
927
if old_lock_count == 0:
928
raise AssertionError(
929
'old_repository should have been locked at least once.')
930
for i in range(old_lock_count-1):
931
self.repository.lock_write()
932
# Fetch from the old repository into the new.
933
old_repository.lock_read()
935
# XXX: If you unstack a branch while it has a working tree
936
# with a pending merge, the pending-merged revisions will no
937
# longer be present. You can (probably) revert and remerge.
939
tags_to_fetch = set(self.tags.get_reverse_tag_dict())
940
except errors.TagsNotSupported:
941
tags_to_fetch = set()
942
fetch_spec = vf_search.NotInOtherForRevs(self.repository,
943
old_repository, required_ids=[self.last_revision()],
944
if_present_ids=tags_to_fetch, find_ghosts=True).execute()
945
self.repository.fetch(old_repository, fetch_spec=fetch_spec)
947
old_repository.unlock()
821
def common_ancestor(self, other, self_revno=None, other_revno=None):
823
>>> from bzrlib.commit import commit
824
>>> sb = ScratchBranch(files=['foo', 'foo~'])
825
>>> sb.common_ancestor(sb) == (None, None)
827
>>> commit(sb, "Committing first revision", verbose=False)
828
>>> sb.common_ancestor(sb)[0]
830
>>> clone = sb.clone()
831
>>> commit(sb, "Committing second revision", verbose=False)
832
>>> sb.common_ancestor(sb)[0]
834
>>> sb.common_ancestor(clone)[0]
836
>>> commit(clone, "Committing divergent second revision",
838
>>> sb.common_ancestor(clone)[0]
840
>>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
842
>>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
844
>>> clone2 = sb.clone()
845
>>> sb.common_ancestor(clone2)[0]
847
>>> sb.common_ancestor(clone2, self_revno=1)[0]
849
>>> sb.common_ancestor(clone2, other_revno=1)[0]
852
my_history = self.revision_history()
853
other_history = other.revision_history()
854
if self_revno is None:
855
self_revno = len(my_history)
856
if other_revno is None:
857
other_revno = len(other_history)
858
indices = range(min((self_revno, other_revno)))
861
if my_history[r] == other_history[r]:
862
return r+1, my_history[r]
951
def _set_tags_bytes(self, bytes):
952
"""Mirror method for _get_tags_bytes.
954
:seealso: Branch._get_tags_bytes.
956
op = cleanup.OperationWithCleanups(self._set_tags_bytes_locked)
957
op.add_cleanup(self.lock_write().unlock)
958
return op.run_simple(bytes)
960
def _set_tags_bytes_locked(self, bytes):
961
self._tags_bytes = bytes
962
return self._transport.put_bytes('tags', bytes)
964
def _cache_revision_history(self, rev_history):
965
"""Set the cached revision history to rev_history.
967
The revision_history method will use this cache to avoid regenerating
968
the revision history.
970
This API is semi-public; it only for use by subclasses, all other code
971
should consider it to be private.
973
self._revision_history_cache = rev_history
975
def _cache_revision_id_to_revno(self, revision_id_to_revno):
976
"""Set the cached revision_id => revno map to revision_id_to_revno.
978
This API is semi-public; it only for use by subclasses, all other code
979
should consider it to be private.
981
self._revision_id_to_revno_cache = revision_id_to_revno
983
def _clear_cached_state(self):
984
"""Clear any cached data on this branch, e.g. cached revision history.
986
This means the next call to revision_history will need to call
987
_gen_revision_history.
989
This API is semi-public; it is only for use by subclasses, all other
990
code should consider it to be private.
992
self._revision_history_cache = None
993
self._revision_id_to_revno_cache = None
994
self._last_revision_info_cache = None
995
self._master_branch_cache = None
996
self._merge_sorted_revisions_cache = None
997
self._partial_revision_history_cache = []
998
self._partial_revision_id_to_revno_cache = {}
999
self._tags_bytes = None
1001
def _gen_revision_history(self):
1002
"""Return sequence of revision hashes on to this branch.
1004
Unlike revision_history, this method always regenerates or rereads the
1005
revision history, i.e. it does not cache the result, so repeated calls
1008
Concrete subclasses should override this instead of revision_history so
1009
that subclasses do not need to deal with caching logic.
1011
This API is semi-public; it only for use by subclasses, all other code
1012
should consider it to be private.
1014
raise NotImplementedError(self._gen_revision_history)
1016
def _revision_history(self):
1017
if 'evil' in debug.debug_flags:
1018
mutter_callsite(3, "revision_history scales with history.")
1019
if self._revision_history_cache is not None:
1020
history = self._revision_history_cache
1022
history = self._gen_revision_history()
1023
self._cache_revision_history(history)
1024
return list(history)
866
1026
def revno(self):
867
1027
"""Return current revision number for this branch.
869
1029
That is equivalent to the number of revisions committed to
872
return len(self.revision_history())
1032
return self.last_revision_info()[0]
1035
"""Older format branches cannot bind or unbind."""
1036
raise errors.UpgradeRequired(self.user_url)
875
1038
def last_revision(self):
876
"""Return last patch hash, or None if no history.
878
ph = self.revision_history()
885
def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
886
"""Return a list of new revisions that would perfectly fit.
888
If self and other have not diverged, return a list of the revisions
889
present in other, but missing from self.
891
>>> from bzrlib.commit import commit
892
>>> bzrlib.trace.silent = True
893
>>> br1 = ScratchBranch()
894
>>> br2 = ScratchBranch()
895
>>> br1.missing_revisions(br2)
897
>>> commit(br2, "lala!", rev_id="REVISION-ID-1")
898
>>> br1.missing_revisions(br2)
900
>>> br2.missing_revisions(br1)
902
>>> commit(br1, "lala!", rev_id="REVISION-ID-1")
903
>>> br1.missing_revisions(br2)
905
>>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
906
>>> br1.missing_revisions(br2)
908
>>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
909
>>> br1.missing_revisions(br2)
910
Traceback (most recent call last):
911
DivergedBranches: These branches have diverged.
913
# FIXME: If the branches have diverged, but the latest
914
# revision in this branch is completely merged into the other,
915
# then we should still be able to pull.
916
self_history = self.revision_history()
917
self_len = len(self_history)
918
other_history = other.revision_history()
919
other_len = len(other_history)
920
common_index = min(self_len, other_len) -1
921
if common_index >= 0 and \
922
self_history[common_index] != other_history[common_index]:
923
raise DivergedBranches(self, other)
925
if stop_revision is None:
926
stop_revision = other_len
928
assert isinstance(stop_revision, int)
929
if stop_revision > other_len:
930
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
931
return other_history[self_len:stop_revision]
933
def update_revisions(self, other, stop_revision=None):
934
"""Pull in new perfect-fit revisions."""
935
from bzrlib.fetch import greedy_fetch
936
from bzrlib.revision import get_intervening_revisions
937
if stop_revision is None:
938
stop_revision = other.last_revision()
939
greedy_fetch(to_branch=self, from_branch=other,
940
revision=stop_revision)
941
pullable_revs = self.missing_revisions(
942
other, other.revision_id_to_revno(stop_revision))
944
greedy_fetch(to_branch=self,
946
revision=pullable_revs[-1])
947
self.append_revision(*pullable_revs)
950
def commit(self, *args, **kw):
951
from bzrlib.commit import Commit
952
Commit().commit(self, *args, **kw)
1039
"""Return last revision id, or NULL_REVISION."""
1040
return self.last_revision_info()[1]
1043
def last_revision_info(self):
1044
"""Return information about the last revision.
1046
:return: A tuple (revno, revision_id).
1048
if self._last_revision_info_cache is None:
1049
self._last_revision_info_cache = self._read_last_revision_info()
1050
return self._last_revision_info_cache
1052
def _read_last_revision_info(self):
1053
raise NotImplementedError(self._read_last_revision_info)
1055
def import_last_revision_info_and_tags(self, source, revno, revid,
1057
"""Set the last revision info, importing from another repo if necessary.
1059
This is used by the bound branch code to upload a revision to
1060
the master branch first before updating the tip of the local branch.
1061
Revisions referenced by source's tags are also transferred.
1063
:param source: Source branch to optionally fetch from
1064
:param revno: Revision number of the new tip
1065
:param revid: Revision id of the new tip
1066
:param lossy: Whether to discard metadata that can not be
1067
natively represented
1068
:return: Tuple with the new revision number and revision id
1069
(should only be different from the arguments when lossy=True)
1071
if not self.repository.has_same_location(source.repository):
1072
self.fetch(source, revid)
1073
self.set_last_revision_info(revno, revid)
1074
return (revno, revid)
954
1076
def revision_id_to_revno(self, revision_id):
955
1077
"""Given a revision id, return its revno"""
956
if revision_id is None:
1078
if _mod_revision.is_null(revision_id):
958
history = self.revision_history()
1080
history = self._revision_history()
960
1082
return history.index(revision_id) + 1
961
1083
except ValueError:
962
raise bzrlib.errors.NoSuchRevision(self, revision_id)
1084
raise errors.NoSuchRevision(self, revision_id)
964
1087
def get_rev_id(self, revno, history=None):
965
1088
"""Find the revision id of the specified revno."""
969
history = self.revision_history()
970
elif revno <= 0 or revno > len(history):
971
raise bzrlib.errors.NoSuchRevision(self, revno)
972
return history[revno - 1]
974
def revision_tree(self, revision_id):
975
"""Return Tree for a revision on this branch.
977
`revision_id` may be None for the null revision, in which case
978
an `EmptyTree` is returned."""
979
# TODO: refactor this to use an existing revision object
980
# so we don't need to read it in twice.
981
if revision_id == None:
984
inv = self.get_revision_inventory(revision_id)
985
return RevisionTree(self.weave_store, inv, revision_id)
988
def working_tree(self):
989
"""Return a `Tree` for the working copy."""
990
from bzrlib.workingtree import WorkingTree
991
# TODO: In the future, WorkingTree should utilize Transport
992
return WorkingTree(self._transport.base, self.read_working_inventory())
1090
return _mod_revision.NULL_REVISION
1091
last_revno, last_revid = self.last_revision_info()
1092
if revno == last_revno:
1094
if revno <= 0 or revno > last_revno:
1095
raise errors.NoSuchRevision(self, revno)
1096
distance_from_last = last_revno - revno
1097
if len(self._partial_revision_history_cache) <= distance_from_last:
1098
self._extend_partial_history(distance_from_last)
1099
return self._partial_revision_history_cache[distance_from_last]
1101
def pull(self, source, overwrite=False, stop_revision=None,
1102
possible_transports=None, *args, **kwargs):
1103
"""Mirror source into this branch.
1105
This branch is considered to be 'local', having low latency.
1107
:returns: PullResult instance
1109
return InterBranch.get(source, self).pull(overwrite=overwrite,
1110
stop_revision=stop_revision,
1111
possible_transports=possible_transports, *args, **kwargs)
1113
def push(self, target, overwrite=False, stop_revision=None, lossy=False,
1115
"""Mirror this branch into target.
1117
This branch is considered to be 'local', having low latency.
1119
return InterBranch.get(self, target).push(overwrite, stop_revision,
1120
lossy, *args, **kwargs)
995
1122
def basis_tree(self):
996
"""Return `Tree` object for last revision.
998
If there are no revisions yet, return an `EmptyTree`.
1000
return self.revision_tree(self.last_revision())
1003
def rename_one(self, from_rel, to_rel):
1006
This can change the directory or the filename or both.
1010
tree = self.working_tree()
1011
inv = tree.inventory
1012
if not tree.has_filename(from_rel):
1013
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1014
if tree.has_filename(to_rel):
1015
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1017
file_id = inv.path2id(from_rel)
1019
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1021
if inv.path2id(to_rel):
1022
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1024
to_dir, to_tail = os.path.split(to_rel)
1025
to_dir_id = inv.path2id(to_dir)
1026
if to_dir_id == None and to_dir != '':
1027
raise BzrError("can't determine destination directory id for %r" % to_dir)
1029
mutter("rename_one:")
1030
mutter(" file_id {%s}" % file_id)
1031
mutter(" from_rel %r" % from_rel)
1032
mutter(" to_rel %r" % to_rel)
1033
mutter(" to_dir %r" % to_dir)
1034
mutter(" to_dir_id {%s}" % to_dir_id)
1036
inv.rename(file_id, to_dir_id, to_tail)
1038
from_abs = self.abspath(from_rel)
1039
to_abs = self.abspath(to_rel)
1041
rename(from_abs, to_abs)
1043
raise BzrError("failed to rename %r to %r: %s"
1044
% (from_abs, to_abs, e[1]),
1045
["rename rolled back"])
1047
self._write_inventory(inv)
1052
def move(self, from_paths, to_name):
1055
to_name must exist as a versioned directory.
1057
If to_name exists and is a directory, the files are moved into
1058
it, keeping their old names. If it is a directory,
1060
Note that to_name is only the last component of the new name;
1061
this doesn't change the directory.
1063
This returns a list of (from_path, to_path) pairs for each
1064
entry that is moved.
1069
## TODO: Option to move IDs only
1070
assert not isinstance(from_paths, basestring)
1071
tree = self.working_tree()
1072
inv = tree.inventory
1073
to_abs = self.abspath(to_name)
1074
if not isdir(to_abs):
1075
raise BzrError("destination %r is not a directory" % to_abs)
1076
if not tree.has_filename(to_name):
1077
raise BzrError("destination %r not in working directory" % to_abs)
1078
to_dir_id = inv.path2id(to_name)
1079
if to_dir_id == None and to_name != '':
1080
raise BzrError("destination %r is not a versioned directory" % to_name)
1081
to_dir_ie = inv[to_dir_id]
1082
if to_dir_ie.kind not in ('directory', 'root_directory'):
1083
raise BzrError("destination %r is not a directory" % to_abs)
1085
to_idpath = inv.get_idpath(to_dir_id)
1087
for f in from_paths:
1088
if not tree.has_filename(f):
1089
raise BzrError("%r does not exist in working tree" % f)
1090
f_id = inv.path2id(f)
1092
raise BzrError("%r is not versioned" % f)
1093
name_tail = splitpath(f)[-1]
1094
dest_path = appendpath(to_name, name_tail)
1095
if tree.has_filename(dest_path):
1096
raise BzrError("destination %r already exists" % dest_path)
1097
if f_id in to_idpath:
1098
raise BzrError("can't move %r to a subdirectory of itself" % f)
1100
# OK, so there's a race here, it's possible that someone will
1101
# create a file in this interval and then the rename might be
1102
# left half-done. But we should have caught most problems.
1104
for f in from_paths:
1105
name_tail = splitpath(f)[-1]
1106
dest_path = appendpath(to_name, name_tail)
1107
result.append((f, dest_path))
1108
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1110
rename(self.abspath(f), self.abspath(dest_path))
1112
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1113
["rename rolled back"])
1115
self._write_inventory(inv)
1122
def revert(self, filenames, old_tree=None, backups=True):
1123
"""Restore selected files to the versions from a previous tree.
1126
If true (default) backups are made of files before
1129
from bzrlib.errors import NotVersionedError, BzrError
1130
from bzrlib.atomicfile import AtomicFile
1131
from bzrlib.osutils import backup_file
1133
inv = self.read_working_inventory()
1134
if old_tree is None:
1135
old_tree = self.basis_tree()
1136
old_inv = old_tree.inventory
1139
for fn in filenames:
1140
file_id = inv.path2id(fn)
1142
raise NotVersionedError("not a versioned file", fn)
1143
if not old_inv.has_id(file_id):
1144
raise BzrError("file not present in old tree", fn, file_id)
1145
nids.append((fn, file_id))
1147
# TODO: Rename back if it was previously at a different location
1149
# TODO: If given a directory, restore the entire contents from
1150
# the previous version.
1152
# TODO: Make a backup to a temporary file.
1154
# TODO: If the file previously didn't exist, delete it?
1155
for fn, file_id in nids:
1158
f = AtomicFile(fn, 'wb')
1160
f.write(old_tree.get_file(file_id).read())
1166
def pending_merges(self):
1167
"""Return a list of pending merges.
1169
These are revisions that have been merged into the working
1170
directory but not yet committed.
1172
cfn = self._rel_controlfilename('pending-merges')
1173
if not self._transport.has(cfn):
1176
for l in self.controlfile('pending-merges', 'r').readlines():
1177
p.append(l.rstrip('\n'))
1181
def add_pending_merge(self, *revision_ids):
1182
# TODO: Perhaps should check at this point that the
1183
# history of the revision is actually present?
1184
for rev_id in revision_ids:
1185
validate_revision_id(rev_id)
1187
p = self.pending_merges()
1189
for rev_id in revision_ids:
1195
self.set_pending_merges(p)
1197
def set_pending_merges(self, rev_list):
1200
self.put_controlfile('pending-merges', '\n'.join(rev_list))
1123
"""Return `Tree` object for last revision."""
1124
return self.repository.revision_tree(self.last_revision())
1205
1126
def get_parent(self):
1206
1127
"""Return the parent location of the branch.
1208
This is the default location for push/pull/missing. The usual
1209
pattern is that the user can override it by specifying a
1213
_locs = ['parent', 'pull', 'x-pull']
1216
return self.controlfile(l, 'r').read().strip('\n')
1218
if e.errno != errno.ENOENT:
1129
This is the default location for pull/missing. The usual
1130
pattern is that the user can override it by specifying a
1133
parent = self._get_parent_location()
1136
# This is an old-format absolute path to a local branch
1137
# turn it into a url
1138
if parent.startswith('/'):
1139
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1141
return urlutils.join(self.base[:-1], parent)
1142
except errors.InvalidURLJoin, e:
1143
raise errors.InaccessibleParent(parent, self.user_url)
1145
def _get_parent_location(self):
1146
raise NotImplementedError(self._get_parent_location)
1148
def _set_config_location(self, name, url, config=None,
1149
make_relative=False):
1151
config = self.get_config_stack()
1155
url = urlutils.relative_url(self.base, url)
1156
config.set(name, url)
1158
def _get_config_location(self, name, config=None):
1160
config = self.get_config_stack()
1161
location = config.get(name)
1166
def get_child_submit_format(self):
1167
"""Return the preferred format of submissions to this branch."""
1168
return self.get_config_stack().get('child_submit_format')
1170
def get_submit_branch(self):
1171
"""Return the submit location of the branch.
1173
This is the default location for bundle. The usual
1174
pattern is that the user can override it by specifying a
1177
return self.get_config_stack().get('submit_branch')
1179
def set_submit_branch(self, location):
1180
"""Return the submit location of the branch.
1182
This is the default location for bundle. The usual
1183
pattern is that the user can override it by specifying a
1186
self.get_config_stack().set('submit_branch', location)
1188
def get_public_branch(self):
1189
"""Return the public location of the branch.
1191
This is used by merge directives.
1193
return self._get_config_location('public_branch')
1195
def set_public_branch(self, location):
1196
"""Return the submit location of the branch.
1198
This is the default location for bundle. The usual
1199
pattern is that the user can override it by specifying a
1202
self._set_config_location('public_branch', location)
1204
def get_push_location(self):
1205
"""Return None or the location to push this branch to."""
1206
return self.get_config_stack().get('push_location')
1208
def set_push_location(self, location):
1209
"""Set a new push location for this branch."""
1210
raise NotImplementedError(self.set_push_location)
1212
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1213
"""Run the post_change_branch_tip hooks."""
1214
hooks = Branch.hooks['post_change_branch_tip']
1217
new_revno, new_revid = self.last_revision_info()
1218
params = ChangeBranchTipParams(
1219
self, old_revno, new_revno, old_revid, new_revid)
1223
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
1224
"""Run the pre_change_branch_tip hooks."""
1225
hooks = Branch.hooks['pre_change_branch_tip']
1228
old_revno, old_revid = self.last_revision_info()
1229
params = ChangeBranchTipParams(
1230
self, old_revno, new_revno, old_revid, new_revid)
1236
"""Synchronise this branch with the master branch if any.
1238
:return: None or the last_revision pivoted out during the update.
1223
def set_parent(self, url):
1224
# TODO: Maybe delete old location files?
1225
from bzrlib.atomicfile import AtomicFile
1228
f = AtomicFile(self.controlfilename('parent'))
1237
1242
def check_revno(self, revno):
1239
1244
Check whether a revno corresponds to any revision.
1243
1248
self.check_real_revno(revno)
1245
1250
def check_real_revno(self, revno):
1247
1252
Check whether a revno corresponds to a real revision.
1248
1253
Zero (the NULL revision) is considered invalid
1250
1255
if revno < 1 or revno > self.revno():
1251
raise InvalidRevisionNumber(revno)
1257
class ScratchBranch(_Branch):
1258
"""Special test class: a branch that cleans up after itself.
1260
>>> b = ScratchBranch()
1256
raise errors.InvalidRevisionNumber(revno)
1259
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
1260
"""Clone this branch into to_bzrdir preserving all semantic values.
1262
Most API users will want 'create_clone_on_transport', which creates a
1263
new bzrdir and branch on the fly.
1265
revision_id: if not None, the revision history in the new branch will
1266
be truncated to end with revision_id.
1268
result = to_bzrdir.create_branch()
1271
if repository_policy is not None:
1272
repository_policy.configure_branch(result)
1273
self.copy_content_into(result, revision_id=revision_id)
1279
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None,
1281
"""Create a new line of development from the branch, into to_bzrdir.
1283
to_bzrdir controls the branch format.
1285
revision_id: if not None, the revision history in the new branch will
1286
be truncated to end with revision_id.
1288
if (repository_policy is not None and
1289
repository_policy.requires_stacking()):
1290
to_bzrdir._format.require_stacking(_skip_repo=True)
1291
result = to_bzrdir.create_branch(repository=repository)
1294
if repository_policy is not None:
1295
repository_policy.configure_branch(result)
1296
self.copy_content_into(result, revision_id=revision_id)
1297
master_url = self.get_bound_location()
1298
if master_url is None:
1299
result.set_parent(self.bzrdir.root_transport.base)
1301
result.set_parent(master_url)
1306
def _synchronize_history(self, destination, revision_id):
1307
"""Synchronize last revision and revision history between branches.
1309
This version is most efficient when the destination is also a
1310
BzrBranch6, but works for BzrBranch5, as long as the destination's
1311
repository contains all the lefthand ancestors of the intended
1312
last_revision. If not, set_last_revision_info will fail.
1314
:param destination: The branch to copy the history into
1315
:param revision_id: The revision-id to truncate history at. May
1316
be None to copy complete history.
1318
source_revno, source_revision_id = self.last_revision_info()
1319
if revision_id is None:
1320
revno, revision_id = source_revno, source_revision_id
1322
graph = self.repository.get_graph()
1324
revno = graph.find_distance_to_null(revision_id,
1325
[(source_revision_id, source_revno)])
1326
except errors.GhostRevisionsHaveNoRevno:
1327
# Default to 1, if we can't find anything else
1329
destination.set_last_revision_info(revno, revision_id)
1331
def copy_content_into(self, destination, revision_id=None):
1332
"""Copy the content of self into destination.
1334
revision_id: if not None, the revision history in the new branch will
1335
be truncated to end with revision_id.
1337
return InterBranch.get(self, destination).copy_content_into(
1338
revision_id=revision_id)
1340
def update_references(self, target):
1341
if not getattr(self._format, 'supports_reference_locations', False):
1343
reference_dict = self._get_all_reference_info()
1344
if len(reference_dict) == 0:
1346
old_base = self.base
1347
new_base = target.base
1348
target_reference_dict = target._get_all_reference_info()
1349
for file_id, (tree_path, branch_location) in (
1350
reference_dict.items()):
1351
branch_location = urlutils.rebase_url(branch_location,
1353
target_reference_dict.setdefault(
1354
file_id, (tree_path, branch_location))
1355
target._set_all_reference_info(target_reference_dict)
1358
def check(self, refs):
1359
"""Check consistency of the branch.
1361
In particular this checks that revisions given in the revision-history
1362
do actually match up in the revision graph, and that they're all
1363
present in the repository.
1365
Callers will typically also want to check the repository.
1367
:param refs: Calculated refs for this branch as specified by
1368
branch._get_check_refs()
1369
:return: A BranchCheckResult.
1371
result = BranchCheckResult(self)
1372
last_revno, last_revision_id = self.last_revision_info()
1373
actual_revno = refs[('lefthand-distance', last_revision_id)]
1374
if actual_revno != last_revno:
1375
result.errors.append(errors.BzrCheckError(
1376
'revno does not match len(mainline) %s != %s' % (
1377
last_revno, actual_revno)))
1378
# TODO: We should probably also check that self.revision_history
1379
# matches the repository for older branch formats.
1380
# If looking for the code that cross-checks repository parents against
1381
# the Graph.iter_lefthand_ancestry output, that is now a repository
1385
def _get_checkout_format(self, lightweight=False):
1386
"""Return the most suitable metadir for a checkout of this branch.
1387
Weaves are used if this branch's repository uses weaves.
1389
format = self.repository.bzrdir.checkout_metadir()
1390
format.set_branch_format(self._format)
1393
def create_clone_on_transport(self, to_transport, revision_id=None,
1394
stacked_on=None, create_prefix=False, use_existing_dir=False,
1396
"""Create a clone of this branch and its bzrdir.
1398
:param to_transport: The transport to clone onto.
1399
:param revision_id: The revision id to use as tip in the new branch.
1400
If None the tip is obtained from this branch.
1401
:param stacked_on: An optional URL to stack the clone on.
1402
:param create_prefix: Create any missing directories leading up to
1404
:param use_existing_dir: Use an existing directory if one exists.
1406
# XXX: Fix the bzrdir API to allow getting the branch back from the
1407
# clone call. Or something. 20090224 RBC/spiv.
1408
# XXX: Should this perhaps clone colocated branches as well,
1409
# rather than just the default branch? 20100319 JRV
1410
if revision_id is None:
1411
revision_id = self.last_revision()
1412
dir_to = self.bzrdir.clone_on_transport(to_transport,
1413
revision_id=revision_id, stacked_on=stacked_on,
1414
create_prefix=create_prefix, use_existing_dir=use_existing_dir,
1416
return dir_to.open_branch()
1418
def create_checkout(self, to_location, revision_id=None,
1419
lightweight=False, accelerator_tree=None,
1421
"""Create a checkout of a branch.
1423
:param to_location: The url to produce the checkout at
1424
:param revision_id: The revision to check out
1425
:param lightweight: If True, produce a lightweight checkout, otherwise,
1426
produce a bound branch (heavyweight checkout)
1427
:param accelerator_tree: A tree which can be used for retrieving file
1428
contents more quickly than the revision tree, i.e. a workingtree.
1429
The revision tree will be used for cases where accelerator_tree's
1430
content is different.
1431
:param hardlink: If true, hard-link files from accelerator_tree,
1433
:return: The tree of the created checkout
1435
t = transport.get_transport(to_location)
1437
format = self._get_checkout_format(lightweight=lightweight)
1439
checkout = format.initialize_on_transport(t)
1440
except errors.AlreadyControlDirError:
1441
# It's fine if the control directory already exists,
1442
# as long as there is no existing branch and working tree.
1443
checkout = controldir.ControlDir.open_from_transport(t)
1445
checkout.open_branch()
1446
except errors.NotBranchError:
1449
raise errors.AlreadyControlDirError(t.base)
1450
if checkout.control_transport.base == self.bzrdir.control_transport.base:
1451
# When checking out to the same control directory,
1452
# always create a lightweight checkout
1456
from_branch = checkout.set_branch_reference(target_branch=self)
1458
policy = checkout.determine_repository_policy()
1459
repo = policy.acquire_repository()[0]
1460
checkout_branch = checkout.create_branch()
1461
checkout_branch.bind(self)
1462
# pull up to the specified revision_id to set the initial
1463
# branch tip correctly, and seed it with history.
1464
checkout_branch.pull(self, stop_revision=revision_id)
1466
tree = checkout.create_workingtree(revision_id,
1467
from_branch=from_branch,
1468
accelerator_tree=accelerator_tree,
1470
basis_tree = tree.basis_tree()
1471
basis_tree.lock_read()
1473
for path, file_id in basis_tree.iter_references():
1474
reference_parent = self.reference_parent(file_id, path)
1475
reference_parent.create_checkout(tree.abspath(path),
1476
basis_tree.get_reference_revision(file_id, path),
1483
def reconcile(self, thorough=True):
1484
"""Make sure the data stored in this branch is consistent."""
1485
from bzrlib.reconcile import BranchReconciler
1486
reconciler = BranchReconciler(self, thorough=thorough)
1487
reconciler.reconcile()
1490
def reference_parent(self, file_id, path, possible_transports=None):
1491
"""Return the parent branch for a tree-reference file_id
1493
:param file_id: The file_id of the tree reference
1494
:param path: The path of the file_id in the tree
1495
:return: A branch associated with the file_id
1497
# FIXME should provide multiple branches, based on config
1498
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1499
possible_transports=possible_transports)
1501
def supports_tags(self):
1502
return self._format.supports_tags()
1504
def automatic_tag_name(self, revision_id):
1505
"""Try to automatically find the tag name for a revision.
1507
:param revision_id: Revision id of the revision.
1508
:return: A tag name or None if no tag name could be determined.
1510
for hook in Branch.hooks['automatic_tag_name']:
1511
ret = hook(self, revision_id)
1516
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1518
"""Ensure that revision_b is a descendant of revision_a.
1520
This is a helper function for update_revisions.
1522
:raises: DivergedBranches if revision_b has diverged from revision_a.
1523
:returns: True if revision_b is a descendant of revision_a.
1525
relation = self._revision_relations(revision_a, revision_b, graph)
1526
if relation == 'b_descends_from_a':
1528
elif relation == 'diverged':
1529
raise errors.DivergedBranches(self, other_branch)
1530
elif relation == 'a_descends_from_b':
1533
raise AssertionError("invalid relation: %r" % (relation,))
1535
def _revision_relations(self, revision_a, revision_b, graph):
1536
"""Determine the relationship between two revisions.
1538
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1540
heads = graph.heads([revision_a, revision_b])
1541
if heads == set([revision_b]):
1542
return 'b_descends_from_a'
1543
elif heads == set([revision_a, revision_b]):
1544
# These branches have diverged
1546
elif heads == set([revision_a]):
1547
return 'a_descends_from_b'
1549
raise AssertionError("invalid heads: %r" % (heads,))
1551
def heads_to_fetch(self):
1552
"""Return the heads that must and that should be fetched to copy this
1553
branch into another repo.
1555
:returns: a 2-tuple of (must_fetch, if_present_fetch). must_fetch is a
1556
set of heads that must be fetched. if_present_fetch is a set of
1557
heads that must be fetched if present, but no error is necessary if
1558
they are not present.
1560
# For bzr native formats must_fetch is just the tip, and
1561
# if_present_fetch are the tags.
1562
must_fetch = set([self.last_revision()])
1563
if_present_fetch = set()
1564
if self.get_config_stack().get('branch.fetch_tags'):
1566
if_present_fetch = set(self.tags.get_reverse_tag_dict())
1567
except errors.TagsNotSupported:
1569
must_fetch.discard(_mod_revision.NULL_REVISION)
1570
if_present_fetch.discard(_mod_revision.NULL_REVISION)
1571
return must_fetch, if_present_fetch
1574
class BranchFormat(controldir.ControlComponentFormat):
1575
"""An encapsulation of the initialization and open routines for a format.
1577
Formats provide three things:
1578
* An initialization routine,
1579
* a format description
1582
Formats are placed in an dict by their format string for reference
1583
during branch opening. It's not required that these be instances, they
1584
can be classes themselves with class methods - it simply depends on
1585
whether state is needed for a given format or not.
1587
Once a format is deprecated, just deprecate the initialize and open
1588
methods on the format class. Do not deprecate the object, as the
1589
object will be created every time regardless.
1268
def __init__(self, files=[], dirs=[], base=None):
1269
"""Make a test branch.
1271
This creates a temporary directory and runs init-tree in it.
1273
If any files are listed, they are created in the working copy.
1275
from tempfile import mkdtemp
1280
if isinstance(base, basestring):
1281
base = get_transport(base)
1282
_Branch.__init__(self, base, init=init)
1284
self._transport.mkdir(d)
1287
self._transport.put(f, 'content of %s' % f)
1292
>>> orig = ScratchBranch(files=["file1", "file2"])
1293
>>> clone = orig.clone()
1294
>>> if os.name != 'nt':
1295
... os.path.samefile(orig.base, clone.base)
1297
... orig.base == clone.base
1300
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1303
from shutil import copytree
1304
from tempfile import mkdtemp
1307
copytree(self.base, base, symlinks=True)
1308
return ScratchBranch(base=base)
1314
"""Destroy the test branch, removing the scratch directory."""
1315
from shutil import rmtree
1318
mutter("delete ScratchBranch %s" % self.base)
1321
# Work around for shutil.rmtree failing on Windows when
1322
# readonly files are encountered
1323
mutter("hit exception in destroying ScratchBranch: %s" % e)
1324
for root, dirs, files in os.walk(self.base, topdown=False):
1326
os.chmod(os.path.join(root, name), 0700)
1328
self._transport = None
1592
def __eq__(self, other):
1593
return self.__class__ is other.__class__
1595
def __ne__(self, other):
1596
return not (self == other)
1598
def get_reference(self, controldir, name=None):
1599
"""Get the target reference of the branch in controldir.
1601
format probing must have been completed before calling
1602
this method - it is assumed that the format of the branch
1603
in controldir is correct.
1605
:param controldir: The controldir to get the branch data from.
1606
:param name: Name of the colocated branch to fetch
1607
:return: None if the branch is not a reference branch.
1612
def set_reference(self, controldir, name, to_branch):
1613
"""Set the target reference of the branch in controldir.
1615
format probing must have been completed before calling
1616
this method - it is assumed that the format of the branch
1617
in controldir is correct.
1619
:param controldir: The controldir to set the branch reference for.
1620
:param name: Name of colocated branch to set, None for default
1621
:param to_branch: branch that the checkout is to reference
1623
raise NotImplementedError(self.set_reference)
1625
def get_format_description(self):
1626
"""Return the short format description for this format."""
1627
raise NotImplementedError(self.get_format_description)
1629
def _run_post_branch_init_hooks(self, controldir, name, branch):
1630
hooks = Branch.hooks['post_branch_init']
1633
params = BranchInitHookParams(self, controldir, name, branch)
1637
def initialize(self, controldir, name=None, repository=None,
1638
append_revisions_only=None):
1639
"""Create a branch of this format in controldir.
1641
:param name: Name of the colocated branch to create.
1643
raise NotImplementedError(self.initialize)
1645
def is_supported(self):
1646
"""Is this format supported?
1648
Supported formats can be initialized and opened.
1649
Unsupported formats may not support initialization or committing or
1650
some other features depending on the reason for not being supported.
1654
def make_tags(self, branch):
1655
"""Create a tags object for branch.
1657
This method is on BranchFormat, because BranchFormats are reflected
1658
over the wire via network_name(), whereas full Branch instances require
1659
multiple VFS method calls to operate at all.
1661
The default implementation returns a disabled-tags instance.
1663
Note that it is normal for branch to be a RemoteBranch when using tags
1666
return _mod_tag.DisabledTags(branch)
1668
def network_name(self):
1669
"""A simple byte string uniquely identifying this format for RPC calls.
1671
MetaDir branch formats use their disk format string to identify the
1672
repository over the wire. All in one formats such as bzr < 0.8, and
1673
foreign formats like svn/git and hg should use some marker which is
1674
unique and immutable.
1676
raise NotImplementedError(self.network_name)
1678
def open(self, controldir, name=None, _found=False, ignore_fallbacks=False,
1679
found_repository=None, possible_transports=None):
1680
"""Return the branch object for controldir.
1682
:param controldir: A ControlDir that contains a branch.
1683
:param name: Name of colocated branch to open
1684
:param _found: a private parameter, do not use it. It is used to
1685
indicate if format probing has already be done.
1686
:param ignore_fallbacks: when set, no fallback branches will be opened
1687
(if there are any). Default is to open fallbacks.
1689
raise NotImplementedError(self.open)
1691
def supports_set_append_revisions_only(self):
1692
"""True if this format supports set_append_revisions_only."""
1695
def supports_stacking(self):
1696
"""True if this format records a stacked-on branch."""
1699
def supports_leaving_lock(self):
1700
"""True if this format supports leaving locks in place."""
1701
return False # by default
1704
return self.get_format_description().rstrip()
1706
def supports_tags(self):
1707
"""True if this format supports tags stored in the branch"""
1708
return False # by default
1710
def tags_are_versioned(self):
1711
"""Whether the tag container for this branch versions tags."""
1714
def supports_tags_referencing_ghosts(self):
1715
"""True if tags can reference ghost revisions."""
1719
class MetaDirBranchFormatFactory(registry._LazyObjectGetter):
1720
"""A factory for a BranchFormat object, permitting simple lazy registration.
1722
While none of the built in BranchFormats are lazy registered yet,
1723
bzrlib.tests.test_branch.TestMetaDirBranchFormatFactory demonstrates how to
1724
use it, and the bzr-loom plugin uses it as well (see
1725
bzrlib.plugins.loom.formats).
1728
def __init__(self, format_string, module_name, member_name):
1729
"""Create a MetaDirBranchFormatFactory.
1731
:param format_string: The format string the format has.
1732
:param module_name: Module to load the format class from.
1733
:param member_name: Attribute name within the module for the format class.
1735
registry._LazyObjectGetter.__init__(self, module_name, member_name)
1736
self._format_string = format_string
1738
def get_format_string(self):
1739
"""See BranchFormat.get_format_string."""
1740
return self._format_string
1743
"""Used for network_format_registry support."""
1744
return self.get_obj()()
1747
class BranchHooks(Hooks):
1748
"""A dictionary mapping hook name to a list of callables for branch hooks.
1750
e.g. ['post_push'] Is the list of items to be called when the
1751
push function is invoked.
1755
"""Create the default hooks.
1757
These are all empty initially, because by default nothing should get
1760
Hooks.__init__(self, "bzrlib.branch", "Branch.hooks")
1761
self.add_hook('open',
1762
"Called with the Branch object that has been opened after a "
1763
"branch is opened.", (1, 8))
1764
self.add_hook('post_push',
1765
"Called after a push operation completes. post_push is called "
1766
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1767
"bzr client.", (0, 15))
1768
self.add_hook('post_pull',
1769
"Called after a pull operation completes. post_pull is called "
1770
"with a bzrlib.branch.PullResult object and only runs in the "
1771
"bzr client.", (0, 15))
1772
self.add_hook('pre_commit',
1773
"Called after a commit is calculated but before it is "
1774
"completed. pre_commit is called with (local, master, old_revno, "
1775
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1776
"). old_revid is NULL_REVISION for the first commit to a branch, "
1777
"tree_delta is a TreeDelta object describing changes from the "
1778
"basis revision. hooks MUST NOT modify this delta. "
1779
" future_tree is an in-memory tree obtained from "
1780
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1782
self.add_hook('post_commit',
1783
"Called in the bzr client after a commit has completed. "
1784
"post_commit is called with (local, master, old_revno, old_revid, "
1785
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1786
"commit to a branch.", (0, 15))
1787
self.add_hook('post_uncommit',
1788
"Called in the bzr client after an uncommit completes. "
1789
"post_uncommit is called with (local, master, old_revno, "
1790
"old_revid, new_revno, new_revid) where local is the local branch "
1791
"or None, master is the target branch, and an empty branch "
1792
"receives new_revno of 0, new_revid of None.", (0, 15))
1793
self.add_hook('pre_change_branch_tip',
1794
"Called in bzr client and server before a change to the tip of a "
1795
"branch is made. pre_change_branch_tip is called with a "
1796
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1797
"commit, uncommit will all trigger this hook.", (1, 6))
1798
self.add_hook('post_change_branch_tip',
1799
"Called in bzr client and server after a change to the tip of a "
1800
"branch is made. post_change_branch_tip is called with a "
1801
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1802
"commit, uncommit will all trigger this hook.", (1, 4))
1803
self.add_hook('transform_fallback_location',
1804
"Called when a stacked branch is activating its fallback "
1805
"locations. transform_fallback_location is called with (branch, "
1806
"url), and should return a new url. Returning the same url "
1807
"allows it to be used as-is, returning a different one can be "
1808
"used to cause the branch to stack on a closer copy of that "
1809
"fallback_location. Note that the branch cannot have history "
1810
"accessing methods called on it during this hook because the "
1811
"fallback locations have not been activated. When there are "
1812
"multiple hooks installed for transform_fallback_location, "
1813
"all are called with the url returned from the previous hook."
1814
"The order is however undefined.", (1, 9))
1815
self.add_hook('automatic_tag_name',
1816
"Called to determine an automatic tag name for a revision. "
1817
"automatic_tag_name is called with (branch, revision_id) and "
1818
"should return a tag name or None if no tag name could be "
1819
"determined. The first non-None tag name returned will be used.",
1821
self.add_hook('post_branch_init',
1822
"Called after new branch initialization completes. "
1823
"post_branch_init is called with a "
1824
"bzrlib.branch.BranchInitHookParams. "
1825
"Note that init, branch and checkout (both heavyweight and "
1826
"lightweight) will all trigger this hook.", (2, 2))
1827
self.add_hook('post_switch',
1828
"Called after a checkout switches branch. "
1829
"post_switch is called with a "
1830
"bzrlib.branch.SwitchHookParams.", (2, 2))
1834
# install the default hooks into the Branch class.
1835
Branch.hooks = BranchHooks()
1838
class ChangeBranchTipParams(object):
1839
"""Object holding parameters passed to `*_change_branch_tip` hooks.
1841
There are 5 fields that hooks may wish to access:
1843
:ivar branch: the branch being changed
1844
:ivar old_revno: revision number before the change
1845
:ivar new_revno: revision number after the change
1846
:ivar old_revid: revision id before the change
1847
:ivar new_revid: revision id after the change
1849
The revid fields are strings. The revno fields are integers.
1852
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1853
"""Create a group of ChangeBranchTip parameters.
1855
:param branch: The branch being changed.
1856
:param old_revno: Revision number before the change.
1857
:param new_revno: Revision number after the change.
1858
:param old_revid: Tip revision id before the change.
1859
:param new_revid: Tip revision id after the change.
1861
self.branch = branch
1862
self.old_revno = old_revno
1863
self.new_revno = new_revno
1864
self.old_revid = old_revid
1865
self.new_revid = new_revid
1867
def __eq__(self, other):
1868
return self.__dict__ == other.__dict__
1871
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1872
self.__class__.__name__, self.branch,
1873
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1876
class BranchInitHookParams(object):
1877
"""Object holding parameters passed to `*_branch_init` hooks.
1879
There are 4 fields that hooks may wish to access:
1881
:ivar format: the branch format
1882
:ivar bzrdir: the ControlDir where the branch will be/has been initialized
1883
:ivar name: name of colocated branch, if any (or None)
1884
:ivar branch: the branch created
1886
Note that for lightweight checkouts, the bzrdir and format fields refer to
1887
the checkout, hence they are different from the corresponding fields in
1888
branch, which refer to the original branch.
1891
def __init__(self, format, controldir, name, branch):
1892
"""Create a group of BranchInitHook parameters.
1894
:param format: the branch format
1895
:param controldir: the ControlDir where the branch will be/has been
1897
:param name: name of colocated branch, if any (or None)
1898
:param branch: the branch created
1900
Note that for lightweight checkouts, the bzrdir and format fields refer
1901
to the checkout, hence they are different from the corresponding fields
1902
in branch, which refer to the original branch.
1904
self.format = format
1905
self.bzrdir = controldir
1907
self.branch = branch
1909
def __eq__(self, other):
1910
return self.__dict__ == other.__dict__
1913
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1916
class SwitchHookParams(object):
1917
"""Object holding parameters passed to `*_switch` hooks.
1919
There are 4 fields that hooks may wish to access:
1921
:ivar control_dir: ControlDir of the checkout to change
1922
:ivar to_branch: branch that the checkout is to reference
1923
:ivar force: skip the check for local commits in a heavy checkout
1924
:ivar revision_id: revision ID to switch to (or None)
1927
def __init__(self, control_dir, to_branch, force, revision_id):
1928
"""Create a group of SwitchHook parameters.
1930
:param control_dir: ControlDir of the checkout to change
1931
:param to_branch: branch that the checkout is to reference
1932
:param force: skip the check for local commits in a heavy checkout
1933
:param revision_id: revision ID to switch to (or None)
1935
self.control_dir = control_dir
1936
self.to_branch = to_branch
1938
self.revision_id = revision_id
1940
def __eq__(self, other):
1941
return self.__dict__ == other.__dict__
1944
return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1945
self.control_dir, self.to_branch,
1949
class BranchFormatMetadir(bzrdir.BzrFormat, BranchFormat):
1950
"""Base class for branch formats that live in meta directories.
1954
BranchFormat.__init__(self)
1955
bzrdir.BzrFormat.__init__(self)
1958
def find_format(klass, controldir, name=None):
1959
"""Return the format for the branch object in controldir."""
1961
transport = controldir.get_branch_transport(None, name=name)
1962
except errors.NoSuchFile:
1963
raise errors.NotBranchError(path=name, bzrdir=controldir)
1965
format_string = transport.get_bytes("format")
1966
except errors.NoSuchFile:
1967
raise errors.NotBranchError(path=transport.base, bzrdir=controldir)
1968
return klass._find_format(format_registry, 'branch', format_string)
1970
def _branch_class(self):
1971
"""What class to instantiate on open calls."""
1972
raise NotImplementedError(self._branch_class)
1974
def _get_initial_config(self, append_revisions_only=None):
1975
if append_revisions_only:
1976
return "append_revisions_only = True\n"
1978
# Avoid writing anything if append_revisions_only is disabled,
1979
# as that is the default.
1982
def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1984
"""Initialize a branch in a control dir, with specified files
1986
:param a_bzrdir: The bzrdir to initialize the branch in
1987
:param utf8_files: The files to create as a list of
1988
(filename, content) tuples
1989
:param name: Name of colocated branch to create, if any
1990
:return: a branch in this format
1993
name = a_bzrdir._get_selected_branch()
1994
mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1995
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1996
control_files = lockable_files.LockableFiles(branch_transport,
1997
'lock', lockdir.LockDir)
1998
control_files.create_lock()
1999
control_files.lock_write()
2001
utf8_files += [('format', self.as_string())]
2002
for (filename, content) in utf8_files:
2003
branch_transport.put_bytes(
2005
mode=a_bzrdir._get_file_mode())
2007
control_files.unlock()
2008
branch = self.open(a_bzrdir, name, _found=True,
2009
found_repository=repository)
2010
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2013
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
2014
found_repository=None, possible_transports=None):
2015
"""See BranchFormat.open()."""
2017
name = a_bzrdir._get_selected_branch()
2019
format = BranchFormatMetadir.find_format(a_bzrdir, name=name)
2020
if format.__class__ != self.__class__:
2021
raise AssertionError("wrong format %r found for %r" %
2023
transport = a_bzrdir.get_branch_transport(None, name=name)
2025
control_files = lockable_files.LockableFiles(transport, 'lock',
2027
if found_repository is None:
2028
found_repository = a_bzrdir.find_repository()
2029
return self._branch_class()(_format=self,
2030
_control_files=control_files,
2033
_repository=found_repository,
2034
ignore_fallbacks=ignore_fallbacks,
2035
possible_transports=possible_transports)
2036
except errors.NoSuchFile:
2037
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
2040
def _matchingbzrdir(self):
2041
ret = bzrdir.BzrDirMetaFormat1()
2042
ret.set_branch_format(self)
2045
def supports_tags(self):
2048
def supports_leaving_lock(self):
2051
def check_support_status(self, allow_unsupported, recommend_upgrade=True,
2053
BranchFormat.check_support_status(self,
2054
allow_unsupported=allow_unsupported, recommend_upgrade=recommend_upgrade,
2056
bzrdir.BzrFormat.check_support_status(self, allow_unsupported=allow_unsupported,
2057
recommend_upgrade=recommend_upgrade, basedir=basedir)
2060
class BzrBranchFormat6(BranchFormatMetadir):
2061
"""Branch format with last-revision and tags.
2063
Unlike previous formats, this has no explicit revision history. Instead,
2064
this just stores the last-revision, and the left-hand history leading
2065
up to there is the history.
2067
This format was introduced in bzr 0.15
2068
and became the default in 0.91.
2071
def _branch_class(self):
2075
def get_format_string(cls):
2076
"""See BranchFormat.get_format_string()."""
2077
return "Bazaar Branch Format 6 (bzr 0.15)\n"
2079
def get_format_description(self):
2080
"""See BranchFormat.get_format_description()."""
2081
return "Branch format 6"
2083
def initialize(self, a_bzrdir, name=None, repository=None,
2084
append_revisions_only=None):
2085
"""Create a branch of this format in a_bzrdir."""
2086
utf8_files = [('last-revision', '0 null:\n'),
2088
self._get_initial_config(append_revisions_only)),
2091
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2093
def make_tags(self, branch):
2094
"""See bzrlib.branch.BranchFormat.make_tags()."""
2095
return _mod_tag.BasicTags(branch)
2097
def supports_set_append_revisions_only(self):
2101
class BzrBranchFormat8(BranchFormatMetadir):
2102
"""Metadir format supporting storing locations of subtree branches."""
2104
def _branch_class(self):
2108
def get_format_string(cls):
2109
"""See BranchFormat.get_format_string()."""
2110
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2112
def get_format_description(self):
2113
"""See BranchFormat.get_format_description()."""
2114
return "Branch format 8"
2116
def initialize(self, a_bzrdir, name=None, repository=None,
2117
append_revisions_only=None):
2118
"""Create a branch of this format in a_bzrdir."""
2119
utf8_files = [('last-revision', '0 null:\n'),
2121
self._get_initial_config(append_revisions_only)),
2125
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2127
def make_tags(self, branch):
2128
"""See bzrlib.branch.BranchFormat.make_tags()."""
2129
return _mod_tag.BasicTags(branch)
2131
def supports_set_append_revisions_only(self):
2134
def supports_stacking(self):
2137
supports_reference_locations = True
2140
class BzrBranchFormat7(BranchFormatMetadir):
2141
"""Branch format with last-revision, tags, and a stacked location pointer.
2143
The stacked location pointer is passed down to the repository and requires
2144
a repository format with supports_external_lookups = True.
2146
This format was introduced in bzr 1.6.
2149
def initialize(self, a_bzrdir, name=None, repository=None,
2150
append_revisions_only=None):
2151
"""Create a branch of this format in a_bzrdir."""
2152
utf8_files = [('last-revision', '0 null:\n'),
2154
self._get_initial_config(append_revisions_only)),
2157
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2159
def _branch_class(self):
2163
def get_format_string(cls):
2164
"""See BranchFormat.get_format_string()."""
2165
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
2167
def get_format_description(self):
2168
"""See BranchFormat.get_format_description()."""
2169
return "Branch format 7"
2171
def supports_set_append_revisions_only(self):
2174
def supports_stacking(self):
2177
def make_tags(self, branch):
2178
"""See bzrlib.branch.BranchFormat.make_tags()."""
2179
return _mod_tag.BasicTags(branch)
2181
supports_reference_locations = False
2184
class BranchReferenceFormat(BranchFormatMetadir):
2185
"""Bzr branch reference format.
2187
Branch references are used in implementing checkouts, they
2188
act as an alias to the real branch which is at some other url.
2196
def get_format_string(cls):
2197
"""See BranchFormat.get_format_string()."""
2198
return "Bazaar-NG Branch Reference Format 1\n"
2200
def get_format_description(self):
2201
"""See BranchFormat.get_format_description()."""
2202
return "Checkout reference format 1"
2204
def get_reference(self, a_bzrdir, name=None):
2205
"""See BranchFormat.get_reference()."""
2206
transport = a_bzrdir.get_branch_transport(None, name=name)
2207
return transport.get_bytes('location')
2209
def set_reference(self, a_bzrdir, name, to_branch):
2210
"""See BranchFormat.set_reference()."""
2211
transport = a_bzrdir.get_branch_transport(None, name=name)
2212
location = transport.put_bytes('location', to_branch.base)
2214
def initialize(self, a_bzrdir, name=None, target_branch=None,
2215
repository=None, append_revisions_only=None):
2216
"""Create a branch of this format in a_bzrdir."""
2217
if target_branch is None:
2218
# this format does not implement branch itself, thus the implicit
2219
# creation contract must see it as uninitializable
2220
raise errors.UninitializableFormat(self)
2221
mutter('creating branch reference in %s', a_bzrdir.user_url)
2222
if a_bzrdir._format.fixed_components:
2223
raise errors.IncompatibleFormat(self, a_bzrdir._format)
2225
name = a_bzrdir._get_selected_branch()
2226
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2227
branch_transport.put_bytes('location',
2228
target_branch.user_url)
2229
branch_transport.put_bytes('format', self.as_string())
2230
branch = self.open(a_bzrdir, name, _found=True,
2231
possible_transports=[target_branch.bzrdir.root_transport])
2232
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2235
def _make_reference_clone_function(format, a_branch):
2236
"""Create a clone() routine for a branch dynamically."""
2237
def clone(to_bzrdir, revision_id=None,
2238
repository_policy=None):
2239
"""See Branch.clone()."""
2240
return format.initialize(to_bzrdir, target_branch=a_branch)
2241
# cannot obey revision_id limits when cloning a reference ...
2242
# FIXME RBC 20060210 either nuke revision_id for clone, or
2243
# emit some sort of warning/error to the caller ?!
2246
def open(self, a_bzrdir, name=None, _found=False, location=None,
2247
possible_transports=None, ignore_fallbacks=False,
2248
found_repository=None):
2249
"""Return the branch that the branch reference in a_bzrdir points at.
2251
:param a_bzrdir: A BzrDir that contains a branch.
2252
:param name: Name of colocated branch to open, if any
2253
:param _found: a private parameter, do not use it. It is used to
2254
indicate if format probing has already be done.
2255
:param ignore_fallbacks: when set, no fallback branches will be opened
2256
(if there are any). Default is to open fallbacks.
2257
:param location: The location of the referenced branch. If
2258
unspecified, this will be determined from the branch reference in
2260
:param possible_transports: An optional reusable transports list.
2263
name = a_bzrdir._get_selected_branch()
2265
format = BranchFormatMetadir.find_format(a_bzrdir, name=name)
2266
if format.__class__ != self.__class__:
2267
raise AssertionError("wrong format %r found for %r" %
2269
if location is None:
2270
location = self.get_reference(a_bzrdir, name)
2271
real_bzrdir = controldir.ControlDir.open(
2272
location, possible_transports=possible_transports)
2273
result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks,
2274
possible_transports=possible_transports)
2275
# this changes the behaviour of result.clone to create a new reference
2276
# rather than a copy of the content of the branch.
2277
# I did not use a proxy object because that needs much more extensive
2278
# testing, and we are only changing one behaviour at the moment.
2279
# If we decide to alter more behaviours - i.e. the implicit nickname
2280
# then this should be refactored to introduce a tested proxy branch
2281
# and a subclass of that for use in overriding clone() and ....
2283
result.clone = self._make_reference_clone_function(result)
2287
class BranchFormatRegistry(controldir.ControlComponentFormatRegistry):
2288
"""Branch format registry."""
2290
def __init__(self, other_registry=None):
2291
super(BranchFormatRegistry, self).__init__(other_registry)
2292
self._default_format = None
2294
def set_default(self, format):
2295
self._default_format = format
2297
def get_default(self):
2298
return self._default_format
2301
network_format_registry = registry.FormatRegistry()
2302
"""Registry of formats indexed by their network name.
2304
The network name for a branch format is an identifier that can be used when
2305
referring to formats with smart server operations. See
2306
BranchFormat.network_name() for more detail.
2309
format_registry = BranchFormatRegistry(network_format_registry)
2312
# formats which have no format string are not discoverable
2313
# and not independently creatable, so are not registered.
2314
__format6 = BzrBranchFormat6()
2315
__format7 = BzrBranchFormat7()
2316
__format8 = BzrBranchFormat8()
2317
format_registry.register_lazy(
2318
"Bazaar-NG branch format 5\n", "bzrlib.branchfmt.fullhistory", "BzrBranchFormat5")
2319
format_registry.register(BranchReferenceFormat())
2320
format_registry.register(__format6)
2321
format_registry.register(__format7)
2322
format_registry.register(__format8)
2323
format_registry.set_default(__format7)
2326
class BranchWriteLockResult(LogicalLockResult):
2327
"""The result of write locking a branch.
2329
:ivar branch_token: The token obtained from the underlying branch lock, or
2331
:ivar unlock: A callable which will unlock the lock.
2334
def __init__(self, unlock, branch_token):
2335
LogicalLockResult.__init__(self, unlock)
2336
self.branch_token = branch_token
2339
return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2343
class BzrBranch(Branch, _RelockDebugMixin):
2344
"""A branch stored in the actual filesystem.
2346
Note that it's "local" in the context of the filesystem; it doesn't
2347
really matter if it's on an nfs/smb/afs/coda/... share, as long as
2348
it's writable, and can be accessed via the normal filesystem API.
2350
:ivar _transport: Transport for file operations on this branch's
2351
control files, typically pointing to the .bzr/branch directory.
2352
:ivar repository: Repository for this branch.
2353
:ivar base: The url of the base directory for this branch; the one
2354
containing the .bzr directory.
2355
:ivar name: Optional colocated branch name as it exists in the control
2359
def __init__(self, _format=None,
2360
_control_files=None, a_bzrdir=None, name=None,
2361
_repository=None, ignore_fallbacks=False,
2362
possible_transports=None):
2363
"""Create new branch object at a particular location."""
2364
if a_bzrdir is None:
2365
raise ValueError('a_bzrdir must be supplied')
2367
raise ValueError('name must be supplied')
2368
self.bzrdir = a_bzrdir
2369
self._user_transport = self.bzrdir.transport.clone('..')
2371
self._user_transport.set_segment_parameter(
2372
"branch", urlutils.escape(name))
2373
self._base = self._user_transport.base
2375
self._format = _format
2376
if _control_files is None:
2377
raise ValueError('BzrBranch _control_files is None')
2378
self.control_files = _control_files
2379
self._transport = _control_files._transport
2380
self.repository = _repository
2381
self.conf_store = None
2382
Branch.__init__(self, possible_transports)
2385
return '%s(%s)' % (self.__class__.__name__, self.user_url)
2389
def _get_base(self):
2390
"""Returns the directory containing the control directory."""
2393
base = property(_get_base, doc="The URL for the root of this branch.")
2396
def user_transport(self):
2397
return self._user_transport
2399
def _get_config(self):
2400
return _mod_config.TransportConfig(self._transport, 'branch.conf')
2402
def _get_config_store(self):
2403
if self.conf_store is None:
2404
self.conf_store = _mod_config.BranchStore(self)
2405
return self.conf_store
2407
def _uncommitted_branch(self):
2408
"""Return the branch that may contain uncommitted changes."""
2409
master = self.get_master_branch()
2410
if master is not None:
2415
def store_uncommitted(self, creator):
2416
"""Store uncommitted changes from a ShelfCreator.
2418
:param creator: The ShelfCreator containing uncommitted changes, or
2419
None to delete any stored changes.
2420
:raises: ChangesAlreadyStored if the branch already has changes.
2422
branch = self._uncommitted_branch()
2424
branch._transport.delete('stored-transform')
2426
if branch._transport.has('stored-transform'):
2427
raise errors.ChangesAlreadyStored
2428
transform = StringIO()
2429
creator.write_shelf(transform)
2431
branch._transport.put_file('stored-transform', transform)
2433
def get_unshelver(self, tree):
2434
"""Return a shelf.Unshelver for this branch and tree.
2436
:param tree: The tree to use to construct the Unshelver.
2437
:return: an Unshelver or None if no changes are stored.
2439
branch = self._uncommitted_branch()
2441
transform = branch._transport.get('stored-transform')
2442
except errors.NoSuchFile:
2444
return shelf.Unshelver.from_tree_and_shelf(tree, transform)
2446
def is_locked(self):
2447
return self.control_files.is_locked()
2449
def lock_write(self, token=None):
2450
"""Lock the branch for write operations.
2452
:param token: A token to permit reacquiring a previously held and
2454
:return: A BranchWriteLockResult.
2456
if not self.is_locked():
2457
self._note_lock('w')
2458
self.repository._warn_if_deprecated(self)
2459
self.repository.lock_write()
2464
return BranchWriteLockResult(self.unlock,
2465
self.control_files.lock_write(token=token))
2468
self.repository.unlock()
2471
def lock_read(self):
2472
"""Lock the branch for read operations.
2474
:return: A bzrlib.lock.LogicalLockResult.
2476
if not self.is_locked():
2477
self._note_lock('r')
2478
self.repository._warn_if_deprecated(self)
2479
self.repository.lock_read()
2484
self.control_files.lock_read()
2485
return LogicalLockResult(self.unlock)
2488
self.repository.unlock()
2491
@only_raises(errors.LockNotHeld, errors.LockBroken)
2493
if self.control_files._lock_count == 1 and self.conf_store is not None:
2494
self.conf_store.save_changes()
2496
self.control_files.unlock()
2498
if not self.control_files.is_locked():
2499
self.repository.unlock()
2500
# we just released the lock
2501
self._clear_cached_state()
2503
def peek_lock_mode(self):
2504
if self.control_files._lock_count == 0:
2507
return self.control_files._lock_mode
2509
def get_physical_lock_status(self):
2510
return self.control_files.get_physical_lock_status()
2513
def print_file(self, file, revision_id):
2514
"""See Branch.print_file."""
2515
return self.repository.print_file(file, revision_id)
2518
def set_last_revision_info(self, revno, revision_id):
2519
if not revision_id or not isinstance(revision_id, basestring):
2520
raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2521
revision_id = _mod_revision.ensure_null(revision_id)
2522
old_revno, old_revid = self.last_revision_info()
2523
if self.get_append_revisions_only():
2524
self._check_history_violation(revision_id)
2525
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2526
self._write_last_revision_info(revno, revision_id)
2527
self._clear_cached_state()
2528
self._last_revision_info_cache = revno, revision_id
2529
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2531
def basis_tree(self):
2532
"""See Branch.basis_tree."""
2533
return self.repository.revision_tree(self.last_revision())
2535
def _get_parent_location(self):
2536
_locs = ['parent', 'pull', 'x-pull']
2539
return self._transport.get_bytes(l).strip('\n')
2540
except errors.NoSuchFile:
2544
def get_stacked_on_url(self):
2545
raise errors.UnstackableBranchFormat(self._format, self.user_url)
2547
def set_push_location(self, location):
2548
"""See Branch.set_push_location."""
2549
self.get_config().set_user_option(
2550
'push_location', location,
2551
store=_mod_config.STORE_LOCATION_NORECURSE)
2553
def _set_parent_location(self, url):
2555
self._transport.delete('parent')
2557
self._transport.put_bytes('parent', url + '\n',
2558
mode=self.bzrdir._get_file_mode())
2562
"""If bound, unbind"""
2563
return self.set_bound_location(None)
2566
def bind(self, other):
2567
"""Bind this branch to the branch other.
2569
This does not push or pull data between the branches, though it does
2570
check for divergence to raise an error when the branches are not
2571
either the same, or one a prefix of the other. That behaviour may not
2572
be useful, so that check may be removed in future.
2574
:param other: The branch to bind to
2577
# TODO: jam 20051230 Consider checking if the target is bound
2578
# It is debatable whether you should be able to bind to
2579
# a branch which is itself bound.
2580
# Committing is obviously forbidden,
2581
# but binding itself may not be.
2582
# Since we *have* to check at commit time, we don't
2583
# *need* to check here
2585
# we want to raise diverged if:
2586
# last_rev is not in the other_last_rev history, AND
2587
# other_last_rev is not in our history, and do it without pulling
2589
self.set_bound_location(other.base)
2591
def get_bound_location(self):
2593
return self._transport.get_bytes('bound')[:-1]
2594
except errors.NoSuchFile:
2598
def get_master_branch(self, possible_transports=None):
2599
"""Return the branch we are bound to.
2601
:return: Either a Branch, or None
2603
if self._master_branch_cache is None:
2604
self._master_branch_cache = self._get_master_branch(
2605
possible_transports)
2606
return self._master_branch_cache
2608
def _get_master_branch(self, possible_transports):
2609
bound_loc = self.get_bound_location()
2613
return Branch.open(bound_loc,
2614
possible_transports=possible_transports)
2615
except (errors.NotBranchError, errors.ConnectionError), e:
2616
raise errors.BoundBranchConnectionFailure(
2620
def set_bound_location(self, location):
2621
"""Set the target where this branch is bound to.
2623
:param location: URL to the target branch
2625
self._master_branch_cache = None
2627
self._transport.put_bytes('bound', location+'\n',
2628
mode=self.bzrdir._get_file_mode())
2631
self._transport.delete('bound')
2632
except errors.NoSuchFile:
2637
def update(self, possible_transports=None):
2638
"""Synchronise this branch with the master branch if any.
2640
:return: None or the last_revision that was pivoted out during the
2643
master = self.get_master_branch(possible_transports)
2644
if master is not None:
2645
old_tip = _mod_revision.ensure_null(self.last_revision())
2646
self.pull(master, overwrite=True)
2647
if self.repository.get_graph().is_ancestor(old_tip,
2648
_mod_revision.ensure_null(self.last_revision())):
2653
def _read_last_revision_info(self):
2654
revision_string = self._transport.get_bytes('last-revision')
2655
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2656
revision_id = cache_utf8.get_cached_utf8(revision_id)
2658
return revno, revision_id
2660
def _write_last_revision_info(self, revno, revision_id):
2661
"""Simply write out the revision id, with no checks.
2663
Use set_last_revision_info to perform this safely.
2665
Does not update the revision_history cache.
2667
revision_id = _mod_revision.ensure_null(revision_id)
2668
out_string = '%d %s\n' % (revno, revision_id)
2669
self._transport.put_bytes('last-revision', out_string,
2670
mode=self.bzrdir._get_file_mode())
2673
def update_feature_flags(self, updated_flags):
2674
"""Update the feature flags for this branch.
2676
:param updated_flags: Dictionary mapping feature names to necessities
2677
A necessity can be None to indicate the feature should be removed
2679
self._format._update_feature_flags(updated_flags)
2680
self.control_transport.put_bytes('format', self._format.as_string())
2683
class BzrBranch8(BzrBranch):
2684
"""A branch that stores tree-reference locations."""
2686
def _open_hook(self, possible_transports=None):
2687
if self._ignore_fallbacks:
2689
if possible_transports is None:
2690
possible_transports = [self.bzrdir.root_transport]
2692
url = self.get_stacked_on_url()
2693
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2694
errors.UnstackableBranchFormat):
2697
for hook in Branch.hooks['transform_fallback_location']:
2698
url = hook(self, url)
2700
hook_name = Branch.hooks.get_hook_name(hook)
2701
raise AssertionError(
2702
"'transform_fallback_location' hook %s returned "
2703
"None, not a URL." % hook_name)
2704
self._activate_fallback_location(url,
2705
possible_transports=possible_transports)
2707
def __init__(self, *args, **kwargs):
2708
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2709
super(BzrBranch8, self).__init__(*args, **kwargs)
2710
self._last_revision_info_cache = None
2711
self._reference_info = None
2713
def _clear_cached_state(self):
2714
super(BzrBranch8, self)._clear_cached_state()
2715
self._last_revision_info_cache = None
2716
self._reference_info = None
2718
def _check_history_violation(self, revision_id):
2719
current_revid = self.last_revision()
2720
last_revision = _mod_revision.ensure_null(current_revid)
2721
if _mod_revision.is_null(last_revision):
2723
graph = self.repository.get_graph()
2724
for lh_ancestor in graph.iter_lefthand_ancestry(revision_id):
2725
if lh_ancestor == current_revid:
2727
raise errors.AppendRevisionsOnlyViolation(self.user_url)
2729
def _gen_revision_history(self):
2730
"""Generate the revision history from last revision
2732
last_revno, last_revision = self.last_revision_info()
2733
self._extend_partial_history(stop_index=last_revno-1)
2734
return list(reversed(self._partial_revision_history_cache))
2737
def _set_parent_location(self, url):
2738
"""Set the parent branch"""
2739
self._set_config_location('parent_location', url, make_relative=True)
2742
def _get_parent_location(self):
2743
"""Set the parent branch"""
2744
return self._get_config_location('parent_location')
2747
def _set_all_reference_info(self, info_dict):
2748
"""Replace all reference info stored in a branch.
2750
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2753
writer = rio.RioWriter(s)
2754
for key, (tree_path, branch_location) in info_dict.iteritems():
2755
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2756
branch_location=branch_location)
2757
writer.write_stanza(stanza)
2758
self._transport.put_bytes('references', s.getvalue())
2759
self._reference_info = info_dict
2762
def _get_all_reference_info(self):
2763
"""Return all the reference info stored in a branch.
2765
:return: A dict of {file_id: (tree_path, branch_location)}
2767
if self._reference_info is not None:
2768
return self._reference_info
2769
rio_file = self._transport.get('references')
2771
stanzas = rio.read_stanzas(rio_file)
2772
info_dict = dict((s['file_id'], (s['tree_path'],
2773
s['branch_location'])) for s in stanzas)
2776
self._reference_info = info_dict
2779
def set_reference_info(self, file_id, tree_path, branch_location):
2780
"""Set the branch location to use for a tree reference.
2782
:param file_id: The file-id of the tree reference.
2783
:param tree_path: The path of the tree reference in the tree.
2784
:param branch_location: The location of the branch to retrieve tree
2787
info_dict = self._get_all_reference_info()
2788
info_dict[file_id] = (tree_path, branch_location)
2789
if None in (tree_path, branch_location):
2790
if tree_path is not None:
2791
raise ValueError('tree_path must be None when branch_location'
2793
if branch_location is not None:
2794
raise ValueError('branch_location must be None when tree_path'
2796
del info_dict[file_id]
2797
self._set_all_reference_info(info_dict)
2799
def get_reference_info(self, file_id):
2800
"""Get the tree_path and branch_location for a tree reference.
2802
:return: a tuple of (tree_path, branch_location)
2804
return self._get_all_reference_info().get(file_id, (None, None))
2806
def reference_parent(self, file_id, path, possible_transports=None):
2807
"""Return the parent branch for a tree-reference file_id.
2809
:param file_id: The file_id of the tree reference
2810
:param path: The path of the file_id in the tree
2811
:return: A branch associated with the file_id
2813
branch_location = self.get_reference_info(file_id)[1]
2814
if branch_location is None:
2815
return Branch.reference_parent(self, file_id, path,
2816
possible_transports)
2817
branch_location = urlutils.join(self.user_url, branch_location)
2818
return Branch.open(branch_location,
2819
possible_transports=possible_transports)
2821
def set_push_location(self, location):
2822
"""See Branch.set_push_location."""
2823
self._set_config_location('push_location', location)
2825
def set_bound_location(self, location):
2826
"""See Branch.set_push_location."""
2827
self._master_branch_cache = None
2829
conf = self.get_config_stack()
2830
if location is None:
2831
if not conf.get('bound'):
2834
conf.set('bound', 'False')
2837
self._set_config_location('bound_location', location,
2839
conf.set('bound', 'True')
2842
def _get_bound_location(self, bound):
2843
"""Return the bound location in the config file.
2845
Return None if the bound parameter does not match"""
2846
conf = self.get_config_stack()
2847
if conf.get('bound') != bound:
2849
return self._get_config_location('bound_location', config=conf)
2851
def get_bound_location(self):
2852
"""See Branch.get_bound_location."""
2853
return self._get_bound_location(True)
2855
def get_old_bound_location(self):
2856
"""See Branch.get_old_bound_location"""
2857
return self._get_bound_location(False)
2859
def get_stacked_on_url(self):
2860
# you can always ask for the URL; but you might not be able to use it
2861
# if the repo can't support stacking.
2862
## self._check_stackable_repo()
2863
# stacked_on_location is only ever defined in branch.conf, so don't
2864
# waste effort reading the whole stack of config files.
2865
conf = _mod_config.BranchOnlyStack(self)
2866
stacked_url = self._get_config_location('stacked_on_location',
2868
if stacked_url is None:
2869
raise errors.NotStacked(self)
2870
return stacked_url.encode('utf-8')
2873
def get_rev_id(self, revno, history=None):
2874
"""Find the revision id of the specified revno."""
2876
return _mod_revision.NULL_REVISION
2878
last_revno, last_revision_id = self.last_revision_info()
2879
if revno <= 0 or revno > last_revno:
2880
raise errors.NoSuchRevision(self, revno)
2882
if history is not None:
2883
return history[revno - 1]
2885
index = last_revno - revno
2886
if len(self._partial_revision_history_cache) <= index:
2887
self._extend_partial_history(stop_index=index)
2888
if len(self._partial_revision_history_cache) > index:
2889
return self._partial_revision_history_cache[index]
2891
raise errors.NoSuchRevision(self, revno)
2894
def revision_id_to_revno(self, revision_id):
2895
"""Given a revision id, return its revno"""
2896
if _mod_revision.is_null(revision_id):
2899
index = self._partial_revision_history_cache.index(revision_id)
2902
self._extend_partial_history(stop_revision=revision_id)
2903
except errors.RevisionNotPresent, e:
2904
raise errors.GhostRevisionsHaveNoRevno(revision_id, e.revision_id)
2905
index = len(self._partial_revision_history_cache) - 1
2907
raise errors.NoSuchRevision(self, revision_id)
2908
if self._partial_revision_history_cache[index] != revision_id:
2909
raise errors.NoSuchRevision(self, revision_id)
2910
return self.revno() - index
2913
class BzrBranch7(BzrBranch8):
2914
"""A branch with support for a fallback repository."""
2916
def set_reference_info(self, file_id, tree_path, branch_location):
2917
Branch.set_reference_info(self, file_id, tree_path, branch_location)
2919
def get_reference_info(self, file_id):
2920
Branch.get_reference_info(self, file_id)
2922
def reference_parent(self, file_id, path, possible_transports=None):
2923
return Branch.reference_parent(self, file_id, path,
2924
possible_transports)
2927
class BzrBranch6(BzrBranch7):
2928
"""See BzrBranchFormat6 for the capabilities of this branch.
2930
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2934
def get_stacked_on_url(self):
2935
raise errors.UnstackableBranchFormat(self._format, self.user_url)
1332
2938
######################################################################
1336
def is_control_file(filename):
1337
## FIXME: better check
1338
filename = os.path.normpath(filename)
1339
while filename != '':
1340
head, tail = os.path.split(filename)
1341
## mutter('check %r for control file' % ((head, tail), ))
1342
if tail == bzrlib.BZRDIR:
1344
if filename == head:
1351
def gen_file_id(name):
1352
"""Return new file id.
1354
This should probably generate proper UUIDs, but for the moment we
1355
cope with just randomness because running uuidgen every time is
1358
from binascii import hexlify
1359
from time import time
1361
# get last component
1362
idx = name.rfind('/')
1364
name = name[idx+1 : ]
1365
idx = name.rfind('\\')
1367
name = name[idx+1 : ]
1369
# make it not a hidden file
1370
name = name.lstrip('.')
1372
# remove any wierd characters; we don't escape them but rather
1373
# just pull them out
1374
name = re.sub(r'[^\w.]', '', name)
1376
s = hexlify(rand_bytes(8))
1377
return '-'.join((name, compact_date(time()), s))
1381
"""Return a new tree-root file id."""
1382
return gen_file_id('TREE_ROOT')
2939
# results of operations
2942
class _Result(object):
2944
def _show_tag_conficts(self, to_file):
2945
if not getattr(self, 'tag_conflicts', None):
2947
to_file.write('Conflicting tags:\n')
2948
for name, value1, value2 in self.tag_conflicts:
2949
to_file.write(' %s\n' % (name, ))
2952
class PullResult(_Result):
2953
"""Result of a Branch.pull operation.
2955
:ivar old_revno: Revision number before pull.
2956
:ivar new_revno: Revision number after pull.
2957
:ivar old_revid: Tip revision id before pull.
2958
:ivar new_revid: Tip revision id after pull.
2959
:ivar source_branch: Source (local) branch object. (read locked)
2960
:ivar master_branch: Master branch of the target, or the target if no
2962
:ivar local_branch: target branch if there is a Master, else None
2963
:ivar target_branch: Target/destination branch object. (write locked)
2964
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2965
:ivar tag_updates: A dict with new tags, see BasicTags.merge_to
2968
def report(self, to_file):
2969
tag_conflicts = getattr(self, "tag_conflicts", None)
2970
tag_updates = getattr(self, "tag_updates", None)
2972
if self.old_revid != self.new_revid:
2973
to_file.write('Now on revision %d.\n' % self.new_revno)
2975
to_file.write('%d tag(s) updated.\n' % len(tag_updates))
2976
if self.old_revid == self.new_revid and not tag_updates:
2977
if not tag_conflicts:
2978
to_file.write('No revisions or tags to pull.\n')
2980
to_file.write('No revisions to pull.\n')
2981
self._show_tag_conficts(to_file)
2984
class BranchPushResult(_Result):
2985
"""Result of a Branch.push operation.
2987
:ivar old_revno: Revision number (eg 10) of the target before push.
2988
:ivar new_revno: Revision number (eg 12) of the target after push.
2989
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
2991
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
2993
:ivar source_branch: Source branch object that the push was from. This is
2994
read locked, and generally is a local (and thus low latency) branch.
2995
:ivar master_branch: If target is a bound branch, the master branch of
2996
target, or target itself. Always write locked.
2997
:ivar target_branch: The direct Branch where data is being sent (write
2999
:ivar local_branch: If the target is a bound branch this will be the
3000
target, otherwise it will be None.
3003
def report(self, to_file):
3004
# TODO: This function gets passed a to_file, but then
3005
# ignores it and calls note() instead. This is also
3006
# inconsistent with PullResult(), which writes to stdout.
3007
# -- JRV20110901, bug #838853
3008
tag_conflicts = getattr(self, "tag_conflicts", None)
3009
tag_updates = getattr(self, "tag_updates", None)
3011
if self.old_revid != self.new_revid:
3012
note(gettext('Pushed up to revision %d.') % self.new_revno)
3014
note(ngettext('%d tag updated.', '%d tags updated.', len(tag_updates)) % len(tag_updates))
3015
if self.old_revid == self.new_revid and not tag_updates:
3016
if not tag_conflicts:
3017
note(gettext('No new revisions or tags to push.'))
3019
note(gettext('No new revisions to push.'))
3020
self._show_tag_conficts(to_file)
3023
class BranchCheckResult(object):
3024
"""Results of checking branch consistency.
3029
def __init__(self, branch):
3030
self.branch = branch
3033
def report_results(self, verbose):
3034
"""Report the check results via trace.note.
3036
:param verbose: Requests more detailed display of what was checked,
3039
note(gettext('checked branch {0} format {1}').format(
3040
self.branch.user_url, self.branch._format))
3041
for error in self.errors:
3042
note(gettext('found error:%s'), error)
3045
class Converter5to6(object):
3046
"""Perform an in-place upgrade of format 5 to format 6"""
3048
def convert(self, branch):
3049
# Data for 5 and 6 can peacefully coexist.
3050
format = BzrBranchFormat6()
3051
new_branch = format.open(branch.bzrdir, _found=True)
3053
# Copy source data into target
3054
new_branch._write_last_revision_info(*branch.last_revision_info())
3055
new_branch.lock_write()
3057
new_branch.set_parent(branch.get_parent())
3058
new_branch.set_bound_location(branch.get_bound_location())
3059
new_branch.set_push_location(branch.get_push_location())
3063
# New branch has no tags by default
3064
new_branch.tags._set_tag_dict({})
3066
# Copying done; now update target format
3067
new_branch._transport.put_bytes('format',
3069
mode=new_branch.bzrdir._get_file_mode())
3071
# Clean up old files
3072
new_branch._transport.delete('revision-history')
3076
branch.set_parent(None)
3077
except errors.NoSuchFile:
3079
branch.set_bound_location(None)
3084
class Converter6to7(object):
3085
"""Perform an in-place upgrade of format 6 to format 7"""
3087
def convert(self, branch):
3088
format = BzrBranchFormat7()
3089
branch._set_config_location('stacked_on_location', '')
3090
# update target format
3091
branch._transport.put_bytes('format', format.as_string())
3094
class Converter7to8(object):
3095
"""Perform an in-place upgrade of format 7 to format 8"""
3097
def convert(self, branch):
3098
format = BzrBranchFormat8()
3099
branch._transport.put_bytes('references', '')
3100
# update target format
3101
branch._transport.put_bytes('format', format.as_string())
3104
class InterBranch(InterObject):
3105
"""This class represents operations taking place between two branches.
3107
Its instances have methods like pull() and push() and contain
3108
references to the source and target repositories these operations
3109
can be carried out on.
3113
"""The available optimised InterBranch types."""
3116
def _get_branch_formats_to_test(klass):
3117
"""Return an iterable of format tuples for testing.
3119
:return: An iterable of (from_format, to_format) to use when testing
3120
this InterBranch class. Each InterBranch class should define this
3123
raise NotImplementedError(klass._get_branch_formats_to_test)
3126
def pull(self, overwrite=False, stop_revision=None,
3127
possible_transports=None, local=False):
3128
"""Mirror source into target branch.
3130
The target branch is considered to be 'local', having low latency.
3132
:returns: PullResult instance
3134
raise NotImplementedError(self.pull)
3137
def push(self, overwrite=False, stop_revision=None, lossy=False,
3138
_override_hook_source_branch=None):
3139
"""Mirror the source branch into the target branch.
3141
The source branch is considered to be 'local', having low latency.
3143
raise NotImplementedError(self.push)
3146
def copy_content_into(self, revision_id=None):
3147
"""Copy the content of source into target
3149
revision_id: if not None, the revision history in the new branch will
3150
be truncated to end with revision_id.
3152
raise NotImplementedError(self.copy_content_into)
3155
def fetch(self, stop_revision=None, limit=None):
3158
:param stop_revision: Last revision to fetch
3159
:param limit: Optional rough limit of revisions to fetch
3161
raise NotImplementedError(self.fetch)
3164
def _fix_overwrite_type(overwrite):
3165
if isinstance(overwrite, bool):
3167
return ["history", "tags"]
3173
class GenericInterBranch(InterBranch):
3174
"""InterBranch implementation that uses public Branch functions."""
3177
def is_compatible(klass, source, target):
3178
# GenericBranch uses the public API, so always compatible
3182
def _get_branch_formats_to_test(klass):
3183
return [(format_registry.get_default(), format_registry.get_default())]
3186
def unwrap_format(klass, format):
3187
if isinstance(format, remote.RemoteBranchFormat):
3188
format._ensure_real()
3189
return format._custom_format
3193
def copy_content_into(self, revision_id=None):
3194
"""Copy the content of source into target
3196
revision_id: if not None, the revision history in the new branch will
3197
be truncated to end with revision_id.
3199
self.source.update_references(self.target)
3200
self.source._synchronize_history(self.target, revision_id)
3202
parent = self.source.get_parent()
3203
except errors.InaccessibleParent, e:
3204
mutter('parent was not accessible to copy: %s', e)
3207
self.target.set_parent(parent)
3208
if self.source._push_should_merge_tags():
3209
self.source.tags.merge_to(self.target.tags)
3212
def fetch(self, stop_revision=None, limit=None):
3213
if self.target.base == self.source.base:
3215
self.source.lock_read()
3217
fetch_spec_factory = fetch.FetchSpecFactory()
3218
fetch_spec_factory.source_branch = self.source
3219
fetch_spec_factory.source_branch_stop_revision_id = stop_revision
3220
fetch_spec_factory.source_repo = self.source.repository
3221
fetch_spec_factory.target_repo = self.target.repository
3222
fetch_spec_factory.target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
3223
fetch_spec_factory.limit = limit
3224
fetch_spec = fetch_spec_factory.make_fetch_spec()
3225
return self.target.repository.fetch(self.source.repository,
3226
fetch_spec=fetch_spec)
3228
self.source.unlock()
3231
def _update_revisions(self, stop_revision=None, overwrite=False,
3233
other_revno, other_last_revision = self.source.last_revision_info()
3234
stop_revno = None # unknown
3235
if stop_revision is None:
3236
stop_revision = other_last_revision
3237
if _mod_revision.is_null(stop_revision):
3238
# if there are no commits, we're done.
3240
stop_revno = other_revno
3242
# what's the current last revision, before we fetch [and change it
3244
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3245
# we fetch here so that we don't process data twice in the common
3246
# case of having something to pull, and so that the check for
3247
# already merged can operate on the just fetched graph, which will
3248
# be cached in memory.
3249
self.fetch(stop_revision=stop_revision)
3250
# Check to see if one is an ancestor of the other
3253
graph = self.target.repository.get_graph()
3254
if self.target._check_if_descendant_or_diverged(
3255
stop_revision, last_rev, graph, self.source):
3256
# stop_revision is a descendant of last_rev, but we aren't
3257
# overwriting, so we're done.
3259
if stop_revno is None:
3261
graph = self.target.repository.get_graph()
3262
this_revno, this_last_revision = \
3263
self.target.last_revision_info()
3264
stop_revno = graph.find_distance_to_null(stop_revision,
3265
[(other_last_revision, other_revno),
3266
(this_last_revision, this_revno)])
3267
self.target.set_last_revision_info(stop_revno, stop_revision)
3270
def pull(self, overwrite=False, stop_revision=None,
3271
possible_transports=None, run_hooks=True,
3272
_override_hook_target=None, local=False):
3273
"""Pull from source into self, updating my master if any.
3275
:param run_hooks: Private parameter - if false, this branch
3276
is being called because it's the master of the primary branch,
3277
so it should not run its hooks.
3279
bound_location = self.target.get_bound_location()
3280
if local and not bound_location:
3281
raise errors.LocalRequiresBoundBranch()
3282
master_branch = None
3283
source_is_master = False
3285
# bound_location comes from a config file, some care has to be
3286
# taken to relate it to source.user_url
3287
normalized = urlutils.normalize_url(bound_location)
3289
relpath = self.source.user_transport.relpath(normalized)
3290
source_is_master = (relpath == '')
3291
except (errors.PathNotChild, errors.InvalidURL):
3292
source_is_master = False
3293
if not local and bound_location and not source_is_master:
3294
# not pulling from master, so we need to update master.
3295
master_branch = self.target.get_master_branch(possible_transports)
3296
master_branch.lock_write()
3299
# pull from source into master.
3300
master_branch.pull(self.source, overwrite, stop_revision,
3302
return self._pull(overwrite,
3303
stop_revision, _hook_master=master_branch,
3304
run_hooks=run_hooks,
3305
_override_hook_target=_override_hook_target,
3306
merge_tags_to_master=not source_is_master)
3309
master_branch.unlock()
3311
def push(self, overwrite=False, stop_revision=None, lossy=False,
3312
_override_hook_source_branch=None):
3313
"""See InterBranch.push.
3315
This is the basic concrete implementation of push()
3317
:param _override_hook_source_branch: If specified, run the hooks
3318
passing this Branch as the source, rather than self. This is for
3319
use of RemoteBranch, where push is delegated to the underlying
3323
raise errors.LossyPushToSameVCS(self.source, self.target)
3324
# TODO: Public option to disable running hooks - should be trivial but
3327
op = cleanup.OperationWithCleanups(self._push_with_bound_branches)
3328
op.add_cleanup(self.source.lock_read().unlock)
3329
op.add_cleanup(self.target.lock_write().unlock)
3330
return op.run(overwrite, stop_revision,
3331
_override_hook_source_branch=_override_hook_source_branch)
3333
def _basic_push(self, overwrite, stop_revision):
3334
"""Basic implementation of push without bound branches or hooks.
3336
Must be called with source read locked and target write locked.
3338
result = BranchPushResult()
3339
result.source_branch = self.source
3340
result.target_branch = self.target
3341
result.old_revno, result.old_revid = self.target.last_revision_info()
3342
self.source.update_references(self.target)
3343
overwrite = _fix_overwrite_type(overwrite)
3344
if result.old_revid != stop_revision:
3345
# We assume that during 'push' this repository is closer than
3347
graph = self.source.repository.get_graph(self.target.repository)
3348
self._update_revisions(stop_revision,
3349
overwrite=("history" in overwrite),
3351
if self.source._push_should_merge_tags():
3352
result.tag_updates, result.tag_conflicts = (
3353
self.source.tags.merge_to(
3354
self.target.tags, "tags" in overwrite))
3355
result.new_revno, result.new_revid = self.target.last_revision_info()
3358
def _push_with_bound_branches(self, operation, overwrite, stop_revision,
3359
_override_hook_source_branch=None):
3360
"""Push from source into target, and into target's master if any.
3363
if _override_hook_source_branch:
3364
result.source_branch = _override_hook_source_branch
3365
for hook in Branch.hooks['post_push']:
3368
bound_location = self.target.get_bound_location()
3369
if bound_location and self.target.base != bound_location:
3370
# there is a master branch.
3372
# XXX: Why the second check? Is it even supported for a branch to
3373
# be bound to itself? -- mbp 20070507
3374
master_branch = self.target.get_master_branch()
3375
master_branch.lock_write()
3376
operation.add_cleanup(master_branch.unlock)
3377
# push into the master from the source branch.
3378
master_inter = InterBranch.get(self.source, master_branch)
3379
master_inter._basic_push(overwrite, stop_revision)
3380
# and push into the target branch from the source. Note that
3381
# we push from the source branch again, because it's considered
3382
# the highest bandwidth repository.
3383
result = self._basic_push(overwrite, stop_revision)
3384
result.master_branch = master_branch
3385
result.local_branch = self.target
3387
master_branch = None
3389
result = self._basic_push(overwrite, stop_revision)
3390
# TODO: Why set master_branch and local_branch if there's no
3391
# binding? Maybe cleaner to just leave them unset? -- mbp
3393
result.master_branch = self.target
3394
result.local_branch = None
3398
def _pull(self, overwrite=False, stop_revision=None,
3399
possible_transports=None, _hook_master=None, run_hooks=True,
3400
_override_hook_target=None, local=False,
3401
merge_tags_to_master=True):
3404
This function is the core worker, used by GenericInterBranch.pull to
3405
avoid duplication when pulling source->master and source->local.
3407
:param _hook_master: Private parameter - set the branch to
3408
be supplied as the master to pull hooks.
3409
:param run_hooks: Private parameter - if false, this branch
3410
is being called because it's the master of the primary branch,
3411
so it should not run its hooks.
3412
is being called because it's the master of the primary branch,
3413
so it should not run its hooks.
3414
:param _override_hook_target: Private parameter - set the branch to be
3415
supplied as the target_branch to pull hooks.
3416
:param local: Only update the local branch, and not the bound branch.
3418
# This type of branch can't be bound.
3420
raise errors.LocalRequiresBoundBranch()
3421
result = PullResult()
3422
result.source_branch = self.source
3423
if _override_hook_target is None:
3424
result.target_branch = self.target
3426
result.target_branch = _override_hook_target
3427
self.source.lock_read()
3429
# We assume that during 'pull' the target repository is closer than
3431
self.source.update_references(self.target)
3432
graph = self.target.repository.get_graph(self.source.repository)
3433
# TODO: Branch formats should have a flag that indicates
3434
# that revno's are expensive, and pull() should honor that flag.
3436
result.old_revno, result.old_revid = \
3437
self.target.last_revision_info()
3438
overwrite = _fix_overwrite_type(overwrite)
3439
self._update_revisions(stop_revision,
3440
overwrite=("history" in overwrite),
3442
# TODO: The old revid should be specified when merging tags,
3443
# so a tags implementation that versions tags can only
3444
# pull in the most recent changes. -- JRV20090506
3445
result.tag_updates, result.tag_conflicts = (
3446
self.source.tags.merge_to(self.target.tags,
3447
"tags" in overwrite,
3448
ignore_master=not merge_tags_to_master))
3449
result.new_revno, result.new_revid = self.target.last_revision_info()
3451
result.master_branch = _hook_master
3452
result.local_branch = result.target_branch
3454
result.master_branch = result.target_branch
3455
result.local_branch = None
3457
for hook in Branch.hooks['post_pull']:
3460
self.source.unlock()
3464
InterBranch.register_optimiser(GenericInterBranch)
added
removed
bzrlib/branch.py
