1
# Copyright (C) 2005-2012 Canonical Ltd
1
# Copyright (C) 2005 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
from __future__ import absolute_import
21
from cStringIO import StringIO
23
from bzrlib.lazy_import import lazy_import
24
lazy_import(globals(), """
31
config as _mod_config,
40
revision as _mod_revision,
48
from bzrlib.i18n import gettext, ngettext
51
# Explicitly import bzrlib.bzrdir so that the BzrProber
52
# is guaranteed to be registered.
59
from bzrlib.decorators import (
64
from bzrlib.hooks import Hooks
65
from bzrlib.inter import InterObject
66
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
67
from bzrlib import registry
68
from bzrlib.symbol_versioning import (
72
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
75
class Branch(controldir.ControlComponent):
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21
from bzrlib.trace import mutter, note
22
from bzrlib.osutils import isdir, quotefn, compact_date, rand_bytes, splitpath, \
23
sha_file, appendpath, file_kind
24
from bzrlib.errors import BzrError
26
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
27
## TODO: Maybe include checks for common corruption of newlines, etc?
31
def find_branch(f, **args):
32
if f and (f.startswith('http://') or f.startswith('https://')):
34
return remotebranch.RemoteBranch(f, **args)
36
return Branch(f, **args)
39
def find_cached_branch(f, cache_root, **args):
40
from remotebranch import RemoteBranch
41
br = find_branch(f, **args)
42
def cacheify(br, store_name):
43
from meta_store import CachedStore
44
cache_path = os.path.join(cache_root, store_name)
46
new_store = CachedStore(getattr(br, store_name), cache_path)
47
setattr(br, store_name, new_store)
49
if isinstance(br, RemoteBranch):
50
cacheify(br, 'inventory_store')
51
cacheify(br, 'text_store')
52
cacheify(br, 'revision_store')
56
def _relpath(base, path):
57
"""Return path relative to base, or raise exception.
59
The path may be either an absolute path or a path relative to the
60
current working directory.
62
Lifted out of Branch.relpath for ease of testing.
64
os.path.commonprefix (python2.4) has a bad bug that it works just
65
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
66
avoids that problem."""
67
rp = os.path.abspath(path)
71
while len(head) >= len(base):
74
head, tail = os.path.split(head)
78
from errors import NotBranchError
79
raise NotBranchError("path %r is not within branch %r" % (rp, base))
84
def find_branch_root(f=None):
85
"""Find the branch root enclosing f, or pwd.
87
f may be a filename or a URL.
89
It is not necessary that f exists.
91
Basically we keep looking up until we find the control directory or
95
elif hasattr(os.path, 'realpath'):
96
f = os.path.realpath(f)
98
f = os.path.abspath(f)
99
if not os.path.exists(f):
100
raise BzrError('%r does not exist' % f)
106
if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
108
head, tail = os.path.split(f)
110
# reached the root, whatever that may be
111
raise BzrError('%r is not in a branch' % orig_f)
114
class DivergedBranches(Exception):
115
def __init__(self, branch1, branch2):
116
self.branch1 = branch1
117
self.branch2 = branch2
118
Exception.__init__(self, "These branches have diverged.")
121
class NoSuchRevision(BzrError):
122
def __init__(self, branch, revision):
124
self.revision = revision
125
msg = "Branch %s has no revision %d" % (branch, revision)
126
BzrError.__init__(self, msg)
129
######################################################################
132
class Branch(object):
76
133
"""Branch holding a history of revisions.
79
Base directory/url of the branch; using control_url and
80
control_transport is more standardized.
81
:ivar hooks: An instance of BranchHooks.
82
:ivar _master_branch_cache: cached result of get_master_branch, see
136
Base directory of the branch.
142
If _lock_mode is true, a positive count of the number of times the
146
Lock object from bzrlib.lock.
85
# this is really an instance variable - FIXME move it there
90
def control_transport(self):
91
return self._transport
94
def user_transport(self):
95
return self.bzrdir.user_transport
97
def __init__(self, possible_transports=None):
98
self.tags = self._format.make_tags(self)
99
self._revision_history_cache = None
100
self._revision_id_to_revno_cache = None
101
self._partial_revision_id_to_revno_cache = {}
102
self._partial_revision_history_cache = []
103
self._tags_bytes = None
104
self._last_revision_info_cache = None
105
self._master_branch_cache = None
106
self._merge_sorted_revisions_cache = None
107
self._open_hook(possible_transports)
108
hooks = Branch.hooks['open']
112
def _open_hook(self, possible_transports):
113
"""Called by init to allow simpler extension of the base class."""
115
def _activate_fallback_location(self, url, possible_transports):
116
"""Activate the branch/repository from url as a fallback repository."""
117
for existing_fallback_repo in self.repository._fallback_repositories:
118
if existing_fallback_repo.user_url == url:
119
# This fallback is already configured. This probably only
120
# happens because ControlDir.sprout is a horrible mess. To avoid
121
# confusing _unstack we don't add this a second time.
122
mutter('duplicate activation of fallback %r on %r', url, self)
124
repo = self._get_fallback_repository(url, possible_transports)
125
if repo.has_same_location(self.repository):
126
raise errors.UnstackableLocationError(self.user_url, url)
127
self.repository.add_fallback_repository(repo)
129
def break_lock(self):
130
"""Break a lock if one is present from another instance.
132
Uses the ui factory to ask for confirmation if the lock may be from
135
This will probe the repository for its lock as well.
137
self.control_files.break_lock()
138
self.repository.break_lock()
139
master = self.get_master_branch()
140
if master is not None:
143
def _check_stackable_repo(self):
144
if not self.repository._format.supports_external_lookups:
145
raise errors.UnstackableRepositoryFormat(self.repository._format,
146
self.repository.base)
148
def _extend_partial_history(self, stop_index=None, stop_revision=None):
149
"""Extend the partial history to include a given index
151
If a stop_index is supplied, stop when that index has been reached.
152
If a stop_revision is supplied, stop when that revision is
153
encountered. Otherwise, stop when the beginning of history is
156
:param stop_index: The index which should be present. When it is
157
present, history extension will stop.
158
:param stop_revision: The revision id which should be present. When
159
it is encountered, history extension will stop.
161
if len(self._partial_revision_history_cache) == 0:
162
self._partial_revision_history_cache = [self.last_revision()]
163
repository._iter_for_revno(
164
self.repository, self._partial_revision_history_cache,
165
stop_index=stop_index, stop_revision=stop_revision)
166
if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
167
self._partial_revision_history_cache.pop()
169
def _get_check_refs(self):
170
"""Get the references needed for check().
174
revid = self.last_revision()
175
return [('revision-existence', revid), ('lefthand-distance', revid)]
178
def open(base, _unsupported=False, possible_transports=None):
179
"""Open the branch rooted at base.
181
For instance, if the branch is at URL/.bzr/branch,
182
Branch.open(URL) -> a Branch instance.
184
control = controldir.ControlDir.open(base,
185
possible_transports=possible_transports, _unsupported=_unsupported)
186
return control.open_branch(unsupported=_unsupported,
187
possible_transports=possible_transports)
190
def open_from_transport(transport, name=None, _unsupported=False,
191
possible_transports=None):
192
"""Open the branch rooted at transport"""
193
control = controldir.ControlDir.open_from_transport(transport, _unsupported)
194
return control.open_branch(name=name, unsupported=_unsupported,
195
possible_transports=possible_transports)
198
def open_containing(url, possible_transports=None):
199
"""Open an existing branch which contains url.
201
This probes for a branch at url, and searches upwards from there.
203
Basically we keep looking up until we find the control directory or
204
run into the root. If there isn't one, raises NotBranchError.
205
If there is one and it is either an unrecognised format or an unsupported
206
format, UnknownFormatError or UnsupportedFormatError are raised.
207
If there is one, it is returned, along with the unused portion of url.
209
control, relpath = controldir.ControlDir.open_containing(url,
211
branch = control.open_branch(possible_transports=possible_transports)
212
return (branch, relpath)
214
def _push_should_merge_tags(self):
215
"""Should _basic_push merge this branch's tags into the target?
217
The default implementation returns False if this branch has no tags,
218
and True the rest of the time. Subclasses may override this.
220
return self.supports_tags() and self.tags.get_tag_dict()
222
def get_config(self):
223
"""Get a bzrlib.config.BranchConfig for this Branch.
225
This can then be used to get and set configuration options for the
228
:return: A bzrlib.config.BranchConfig.
230
return _mod_config.BranchConfig(self)
232
def get_config_stack(self):
233
"""Get a bzrlib.config.BranchStack for this Branch.
235
This can then be used to get and set configuration options for the
238
:return: A bzrlib.config.BranchStack.
240
return _mod_config.BranchStack(self)
242
def _get_config(self):
243
"""Get the concrete config for just the config in this branch.
245
This is not intended for client use; see Branch.get_config for the
250
:return: An object supporting get_option and set_option.
252
raise NotImplementedError(self._get_config)
254
def _get_fallback_repository(self, url, possible_transports):
255
"""Get the repository we fallback to at url."""
256
url = urlutils.join(self.base, url)
257
a_branch = Branch.open(url, possible_transports=possible_transports)
258
return a_branch.repository
261
def _get_tags_bytes(self):
262
"""Get the bytes of a serialised tags dict.
264
Note that not all branches support tags, nor do all use the same tags
265
logic: this method is specific to BasicTags. Other tag implementations
266
may use the same method name and behave differently, safely, because
267
of the double-dispatch via
268
format.make_tags->tags_instance->get_tags_dict.
270
:return: The bytes of the tags file.
271
:seealso: Branch._set_tags_bytes.
273
if self._tags_bytes is None:
274
self._tags_bytes = self._transport.get_bytes('tags')
275
return self._tags_bytes
277
def _get_nick(self, local=False, possible_transports=None):
278
config = self.get_config()
279
# explicit overrides master, but don't look for master if local is True
280
if not local and not config.has_explicit_nickname():
282
master = self.get_master_branch(possible_transports)
283
if master and self.user_url == master.user_url:
284
raise errors.RecursiveBind(self.user_url)
285
if master is not None:
286
# return the master branch value
288
except errors.RecursiveBind, e:
290
except errors.BzrError, e:
291
# Silently fall back to local implicit nick if the master is
293
mutter("Could not connect to bound branch, "
294
"falling back to local nick.\n " + str(e))
295
return config.get_nickname()
297
def _set_nick(self, nick):
298
self.get_config().set_user_option('nickname', nick, warn_masked=True)
300
nick = property(_get_nick, _set_nick)
303
raise NotImplementedError(self.is_locked)
305
def _lefthand_history(self, revision_id, last_rev=None,
307
if 'evil' in debug.debug_flags:
308
mutter_callsite(4, "_lefthand_history scales with history.")
309
# stop_revision must be a descendant of last_revision
310
graph = self.repository.get_graph()
311
if last_rev is not None:
312
if not graph.is_ancestor(last_rev, revision_id):
313
# our previous tip is not merged into stop_revision
314
raise errors.DivergedBranches(self, other_branch)
315
# make a new revision history from the graph
316
parents_map = graph.get_parent_map([revision_id])
317
if revision_id not in parents_map:
318
raise errors.NoSuchRevision(self, revision_id)
319
current_rev_id = revision_id
321
check_not_reserved_id = _mod_revision.check_not_reserved_id
322
# Do not include ghosts or graph origin in revision_history
323
while (current_rev_id in parents_map and
324
len(parents_map[current_rev_id]) > 0):
325
check_not_reserved_id(current_rev_id)
326
new_history.append(current_rev_id)
327
current_rev_id = parents_map[current_rev_id][0]
328
parents_map = graph.get_parent_map([current_rev_id])
329
new_history.reverse()
332
def lock_write(self, token=None):
333
"""Lock the branch for write operations.
335
:param token: A token to permit reacquiring a previously held and
337
:return: A BranchWriteLockResult.
339
raise NotImplementedError(self.lock_write)
153
def __init__(self, base, init=False, find_root=True):
154
"""Create new branch object at a particular location.
156
base -- Base directory for the branch.
158
init -- If True, create new control files in a previously
159
unversioned directory. If False, the branch must already
162
find_root -- If true and init is false, find the root of the
163
existing branch containing base.
165
In the test suite, creation of new trees is tested using the
166
`ScratchBranch` class.
168
from bzrlib.store import ImmutableStore
170
self.base = os.path.realpath(base)
173
self.base = find_branch_root(base)
175
self.base = os.path.realpath(base)
176
if not isdir(self.controlfilename('.')):
177
from errors import NotBranchError
178
raise NotBranchError("not a bzr branch: %s" % quotefn(base),
179
['use "bzr init" to initialize a new working tree',
180
'current bzr can only operate from top-of-tree'])
183
self.text_store = ImmutableStore(self.controlfilename('text-store'))
184
self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
185
self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
189
return '%s(%r)' % (self.__class__.__name__, self.base)
196
if self._lock_mode or self._lock:
197
from warnings import warn
198
warn("branch %r was not explicitly unlocked" % self)
203
def lock_write(self):
205
if self._lock_mode != 'w':
206
from errors import LockError
207
raise LockError("can't upgrade to a write lock from %r" %
209
self._lock_count += 1
211
from bzrlib.lock import WriteLock
213
self._lock = WriteLock(self.controlfilename('branch-lock'))
214
self._lock_mode = 'w'
341
219
def lock_read(self):
342
"""Lock the branch for read operations.
344
:return: A bzrlib.lock.LogicalLockResult.
346
raise NotImplementedError(self.lock_read)
221
assert self._lock_mode in ('r', 'w'), \
222
"invalid lock mode %r" % self._lock_mode
223
self._lock_count += 1
225
from bzrlib.lock import ReadLock
227
self._lock = ReadLock(self.controlfilename('branch-lock'))
228
self._lock_mode = 'r'
348
233
def unlock(self):
349
raise NotImplementedError(self.unlock)
351
def peek_lock_mode(self):
352
"""Return lock mode for the Branch: 'r', 'w' or None"""
353
raise NotImplementedError(self.peek_lock_mode)
355
def get_physical_lock_status(self):
356
raise NotImplementedError(self.get_physical_lock_status)
359
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
360
"""Return the revision_id for a dotted revno.
362
:param revno: a tuple like (1,) or (1,1,2)
363
:param _cache_reverse: a private parameter enabling storage
364
of the reverse mapping in a top level cache. (This should
365
only be done in selective circumstances as we want to
366
avoid having the mapping cached multiple times.)
367
:return: the revision_id
368
:raises errors.NoSuchRevision: if the revno doesn't exist
370
rev_id = self._do_dotted_revno_to_revision_id(revno)
372
self._partial_revision_id_to_revno_cache[rev_id] = revno
375
def _do_dotted_revno_to_revision_id(self, revno):
376
"""Worker function for dotted_revno_to_revision_id.
378
Subclasses should override this if they wish to
379
provide a more efficient implementation.
382
return self.get_rev_id(revno[0])
383
revision_id_to_revno = self.get_revision_id_to_revno_map()
384
revision_ids = [revision_id for revision_id, this_revno
385
in revision_id_to_revno.iteritems()
386
if revno == this_revno]
387
if len(revision_ids) == 1:
388
return revision_ids[0]
390
revno_str = '.'.join(map(str, revno))
391
raise errors.NoSuchRevision(self, revno_str)
394
def revision_id_to_dotted_revno(self, revision_id):
395
"""Given a revision id, return its dotted revno.
397
:return: a tuple like (1,) or (400,1,3).
399
return self._do_revision_id_to_dotted_revno(revision_id)
401
def _do_revision_id_to_dotted_revno(self, revision_id):
402
"""Worker function for revision_id_to_revno."""
403
# Try the caches if they are loaded
404
result = self._partial_revision_id_to_revno_cache.get(revision_id)
405
if result is not None:
407
if self._revision_id_to_revno_cache:
408
result = self._revision_id_to_revno_cache.get(revision_id)
410
raise errors.NoSuchRevision(self, revision_id)
411
# Try the mainline as it's optimised
413
revno = self.revision_id_to_revno(revision_id)
415
except errors.NoSuchRevision:
416
# We need to load and use the full revno map after all
417
result = self.get_revision_id_to_revno_map().get(revision_id)
419
raise errors.NoSuchRevision(self, revision_id)
423
def get_revision_id_to_revno_map(self):
424
"""Return the revision_id => dotted revno map.
426
This will be regenerated on demand, but will be cached.
428
:return: A dictionary mapping revision_id => dotted revno.
429
This dictionary should not be modified by the caller.
431
if self._revision_id_to_revno_cache is not None:
432
mapping = self._revision_id_to_revno_cache
434
mapping = self._gen_revno_map()
435
self._cache_revision_id_to_revno(mapping)
436
# TODO: jam 20070417 Since this is being cached, should we be returning
438
# I would rather not, and instead just declare that users should not
439
# modify the return value.
442
def _gen_revno_map(self):
443
"""Create a new mapping from revision ids to dotted revnos.
445
Dotted revnos are generated based on the current tip in the revision
447
This is the worker function for get_revision_id_to_revno_map, which
448
just caches the return value.
450
:return: A dictionary mapping revision_id => dotted revno.
452
revision_id_to_revno = dict((rev_id, revno)
453
for rev_id, depth, revno, end_of_merge
454
in self.iter_merge_sorted_revisions())
455
return revision_id_to_revno
458
def iter_merge_sorted_revisions(self, start_revision_id=None,
459
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
460
"""Walk the revisions for a branch in merge sorted order.
462
Merge sorted order is the output from a merge-aware,
463
topological sort, i.e. all parents come before their
464
children going forward; the opposite for reverse.
466
:param start_revision_id: the revision_id to begin walking from.
467
If None, the branch tip is used.
468
:param stop_revision_id: the revision_id to terminate the walk
469
after. If None, the rest of history is included.
470
:param stop_rule: if stop_revision_id is not None, the precise rule
471
to use for termination:
473
* 'exclude' - leave the stop revision out of the result (default)
474
* 'include' - the stop revision is the last item in the result
475
* 'with-merges' - include the stop revision and all of its
476
merged revisions in the result
477
* 'with-merges-without-common-ancestry' - filter out revisions
478
that are in both ancestries
479
:param direction: either 'reverse' or 'forward':
481
* reverse means return the start_revision_id first, i.e.
482
start at the most recent revision and go backwards in history
483
* forward returns tuples in the opposite order to reverse.
484
Note in particular that forward does *not* do any intelligent
485
ordering w.r.t. depth as some clients of this API may like.
486
(If required, that ought to be done at higher layers.)
488
:return: an iterator over (revision_id, depth, revno, end_of_merge)
491
* revision_id: the unique id of the revision
492
* depth: How many levels of merging deep this node has been
494
* revno_sequence: This field provides a sequence of
495
revision numbers for all revisions. The format is:
496
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
497
branch that the revno is on. From left to right the REVNO numbers
498
are the sequence numbers within that branch of the revision.
499
* end_of_merge: When True the next node (earlier in history) is
500
part of a different merge.
502
# Note: depth and revno values are in the context of the branch so
503
# we need the full graph to get stable numbers, regardless of the
505
if self._merge_sorted_revisions_cache is None:
506
last_revision = self.last_revision()
507
known_graph = self.repository.get_known_graph_ancestry(
509
self._merge_sorted_revisions_cache = known_graph.merge_sort(
511
filtered = self._filter_merge_sorted_revisions(
512
self._merge_sorted_revisions_cache, start_revision_id,
513
stop_revision_id, stop_rule)
514
# Make sure we don't return revisions that are not part of the
515
# start_revision_id ancestry.
516
filtered = self._filter_start_non_ancestors(filtered)
517
if direction == 'reverse':
519
if direction == 'forward':
520
return reversed(list(filtered))
522
raise ValueError('invalid direction %r' % direction)
524
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
525
start_revision_id, stop_revision_id, stop_rule):
526
"""Iterate over an inclusive range of sorted revisions."""
527
rev_iter = iter(merge_sorted_revisions)
528
if start_revision_id is not None:
529
for node in rev_iter:
531
if rev_id != start_revision_id:
534
# The decision to include the start or not
535
# depends on the stop_rule if a stop is provided
536
# so pop this node back into the iterator
537
rev_iter = itertools.chain(iter([node]), rev_iter)
539
if stop_revision_id is None:
541
for node in rev_iter:
543
yield (rev_id, node.merge_depth, node.revno,
545
elif stop_rule == 'exclude':
546
for node in rev_iter:
548
if rev_id == stop_revision_id:
550
yield (rev_id, node.merge_depth, node.revno,
552
elif stop_rule == 'include':
553
for node in rev_iter:
555
yield (rev_id, node.merge_depth, node.revno,
557
if rev_id == stop_revision_id:
559
elif stop_rule == 'with-merges-without-common-ancestry':
560
# We want to exclude all revisions that are already part of the
561
# stop_revision_id ancestry.
562
graph = self.repository.get_graph()
563
ancestors = graph.find_unique_ancestors(start_revision_id,
565
for node in rev_iter:
567
if rev_id not in ancestors:
569
yield (rev_id, node.merge_depth, node.revno,
571
elif stop_rule == 'with-merges':
572
stop_rev = self.repository.get_revision(stop_revision_id)
573
if stop_rev.parent_ids:
574
left_parent = stop_rev.parent_ids[0]
576
left_parent = _mod_revision.NULL_REVISION
577
# left_parent is the actual revision we want to stop logging at,
578
# since we want to show the merged revisions after the stop_rev too
579
reached_stop_revision_id = False
580
revision_id_whitelist = []
581
for node in rev_iter:
583
if rev_id == left_parent:
584
# reached the left parent after the stop_revision
586
if (not reached_stop_revision_id or
587
rev_id in revision_id_whitelist):
588
yield (rev_id, node.merge_depth, node.revno,
590
if reached_stop_revision_id or rev_id == stop_revision_id:
591
# only do the merged revs of rev_id from now on
592
rev = self.repository.get_revision(rev_id)
594
reached_stop_revision_id = True
595
revision_id_whitelist.extend(rev.parent_ids)
597
raise ValueError('invalid stop_rule %r' % stop_rule)
599
def _filter_start_non_ancestors(self, rev_iter):
600
# If we started from a dotted revno, we want to consider it as a tip
601
# and don't want to yield revisions that are not part of its
602
# ancestry. Given the order guaranteed by the merge sort, we will see
603
# uninteresting descendants of the first parent of our tip before the
605
first = rev_iter.next()
606
(rev_id, merge_depth, revno, end_of_merge) = first
609
# We start at a mainline revision so by definition, all others
610
# revisions in rev_iter are ancestors
611
for node in rev_iter:
616
pmap = self.repository.get_parent_map([rev_id])
617
parents = pmap.get(rev_id, [])
619
whitelist.update(parents)
621
# If there is no parents, there is nothing of interest left
623
# FIXME: It's hard to test this scenario here as this code is never
624
# called in that case. -- vila 20100322
627
for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
629
if rev_id in whitelist:
630
pmap = self.repository.get_parent_map([rev_id])
631
parents = pmap.get(rev_id, [])
632
whitelist.remove(rev_id)
633
whitelist.update(parents)
635
# We've reached the mainline, there is nothing left to
639
# A revision that is not part of the ancestry of our
642
yield (rev_id, merge_depth, revno, end_of_merge)
644
def leave_lock_in_place(self):
645
"""Tell this branch object not to release the physical lock when this
648
If lock_write doesn't return a token, then this method is not supported.
650
self.control_files.leave_in_place()
652
def dont_leave_lock_in_place(self):
653
"""Tell this branch object to release the physical lock when this
654
object is unlocked, even if it didn't originally acquire it.
656
If lock_write doesn't return a token, then this method is not supported.
658
self.control_files.dont_leave_in_place()
660
def bind(self, other):
661
"""Bind the local branch the other branch.
663
:param other: The branch to bind to
666
raise errors.UpgradeRequired(self.user_url)
668
def get_append_revisions_only(self):
669
"""Whether it is only possible to append revisions to the history.
671
if not self._format.supports_set_append_revisions_only():
673
return self.get_config_stack().get('append_revisions_only')
675
def set_append_revisions_only(self, enabled):
676
if not self._format.supports_set_append_revisions_only():
677
raise errors.UpgradeRequired(self.user_url)
678
self.get_config_stack().set('append_revisions_only', enabled)
680
def set_reference_info(self, file_id, tree_path, branch_location):
681
"""Set the branch location to use for a tree reference."""
682
raise errors.UnsupportedOperation(self.set_reference_info, self)
684
def get_reference_info(self, file_id):
685
"""Get the tree_path and branch_location for a tree reference."""
686
raise errors.UnsupportedOperation(self.get_reference_info, self)
689
def fetch(self, from_branch, last_revision=None, limit=None):
690
"""Copy revisions from from_branch into this branch.
692
:param from_branch: Where to copy from.
693
:param last_revision: What revision to stop at (None for at the end
695
:param limit: Optional rough limit of revisions to fetch
698
return InterBranch.get(from_branch, self).fetch(last_revision, limit=limit)
700
def get_bound_location(self):
701
"""Return the URL of the branch we are bound to.
703
Older format branches cannot bind, please be sure to use a metadir
708
def get_old_bound_location(self):
709
"""Return the URL of the branch we used to be bound to
711
raise errors.UpgradeRequired(self.user_url)
713
def get_commit_builder(self, parents, config_stack=None, timestamp=None,
714
timezone=None, committer=None, revprops=None,
715
revision_id=None, lossy=False):
716
"""Obtain a CommitBuilder for this branch.
718
:param parents: Revision ids of the parents of the new revision.
719
:param config: Optional configuration to use.
720
:param timestamp: Optional timestamp recorded for commit.
721
:param timezone: Optional timezone for timestamp.
722
:param committer: Optional committer to set for commit.
723
:param revprops: Optional dictionary of revision properties.
724
:param revision_id: Optional revision id.
725
:param lossy: Whether to discard data that can not be natively
726
represented, when pushing to a foreign VCS
729
if config_stack is None:
730
config_stack = self.get_config_stack()
732
return self.repository.get_commit_builder(self, parents, config_stack,
733
timestamp, timezone, committer, revprops, revision_id,
736
def get_master_branch(self, possible_transports=None):
737
"""Return the branch we are bound to.
739
:return: Either a Branch, or None
743
@deprecated_method(deprecated_in((2, 5, 0)))
744
def get_revision_delta(self, revno):
745
"""Return the delta for one revision.
747
The delta is relative to its mainline predecessor, or the
748
empty tree for revision 1.
751
revid = self.get_rev_id(revno)
752
except errors.NoSuchRevision:
753
raise errors.InvalidRevisionNumber(revno)
754
return self.repository.get_revision_delta(revid)
756
def get_stacked_on_url(self):
757
"""Get the URL this branch is stacked against.
759
:raises NotStacked: If the branch is not stacked.
760
:raises UnstackableBranchFormat: If the branch does not support
763
raise NotImplementedError(self.get_stacked_on_url)
765
def print_file(self, file, revision_id):
234
if not self._lock_mode:
235
from errors import LockError
236
raise LockError('branch %r is not locked' % (self))
238
if self._lock_count > 1:
239
self._lock_count -= 1
243
self._lock_mode = self._lock_count = None
246
def abspath(self, name):
247
"""Return absolute filename for something in the branch"""
248
return os.path.join(self.base, name)
251
def relpath(self, path):
252
"""Return path relative to this branch of something inside it.
254
Raises an error if path is not in this branch."""
255
return _relpath(self.base, path)
258
def controlfilename(self, file_or_path):
259
"""Return location relative to branch."""
260
if isinstance(file_or_path, basestring):
261
file_or_path = [file_or_path]
262
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
265
def controlfile(self, file_or_path, mode='r'):
266
"""Open a control file for this branch.
268
There are two classes of file in the control directory: text
269
and binary. binary files are untranslated byte streams. Text
270
control files are stored with Unix newlines and in UTF-8, even
271
if the platform or locale defaults are different.
273
Controlfiles should almost never be opened in write mode but
274
rather should be atomically copied and replaced using atomicfile.
277
fn = self.controlfilename(file_or_path)
279
if mode == 'rb' or mode == 'wb':
280
return file(fn, mode)
281
elif mode == 'r' or mode == 'w':
282
# open in binary mode anyhow so there's no newline translation;
283
# codecs uses line buffering by default; don't want that.
285
return codecs.open(fn, mode + 'b', 'utf-8',
288
raise BzrError("invalid controlfile mode %r" % mode)
292
def _make_control(self):
293
from bzrlib.inventory import Inventory
294
from bzrlib.xml import pack_xml
296
os.mkdir(self.controlfilename([]))
297
self.controlfile('README', 'w').write(
298
"This is a Bazaar-NG control directory.\n"
299
"Do not change any files in this directory.\n")
300
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
301
for d in ('text-store', 'inventory-store', 'revision-store'):
302
os.mkdir(self.controlfilename(d))
303
for f in ('revision-history', 'merged-patches',
304
'pending-merged-patches', 'branch-name',
307
self.controlfile(f, 'w').write('')
308
mutter('created control directory in ' + self.base)
310
pack_xml(Inventory(), self.controlfile('inventory','w'))
313
def _check_format(self):
314
"""Check this branch format is supported.
316
The current tool only supports the current unstable format.
318
In the future, we might need different in-memory Branch
319
classes to support downlevel branches. But not yet.
321
# This ignores newlines so that we can open branches created
322
# on Windows from Linux and so on. I think it might be better
323
# to always make all internal files in unix format.
324
fmt = self.controlfile('branch-format', 'r').read()
325
fmt.replace('\r\n', '')
326
if fmt != BZR_BRANCH_FORMAT:
327
raise BzrError('sorry, branch format %r not supported' % fmt,
328
['use a different bzr version',
329
'or remove the .bzr directory and "bzr init" again'])
333
def read_working_inventory(self):
334
"""Read the working inventory."""
335
from bzrlib.inventory import Inventory
336
from bzrlib.xml import unpack_xml
337
from time import time
341
# ElementTree does its own conversion from UTF-8, so open in
343
inv = unpack_xml(Inventory,
344
self.controlfile('inventory', 'rb'))
345
mutter("loaded inventory of %d items in %f"
346
% (len(inv), time() - before))
352
def _write_inventory(self, inv):
353
"""Update the working inventory.
355
That is to say, the inventory describing changes underway, that
356
will be committed to the next revision.
358
from bzrlib.atomicfile import AtomicFile
359
from bzrlib.xml import pack_xml
363
f = AtomicFile(self.controlfilename('inventory'), 'wb')
372
mutter('wrote working inventory')
375
inventory = property(read_working_inventory, _write_inventory, None,
376
"""Inventory for the working copy.""")
379
def add(self, files, verbose=False, ids=None):
380
"""Make files versioned.
382
Note that the command line normally calls smart_add instead.
384
This puts the files in the Added state, so that they will be
385
recorded by the next commit.
388
List of paths to add, relative to the base of the tree.
391
If set, use these instead of automatically generated ids.
392
Must be the same length as the list of files, but may
393
contain None for ids that are to be autogenerated.
395
TODO: Perhaps have an option to add the ids even if the files do
398
TODO: Perhaps return the ids of the files? But then again it
399
is easy to retrieve them if they're needed.
401
TODO: Adding a directory should optionally recurse down and
402
add all non-ignored children. Perhaps do that in a
405
from bzrlib.textui import show_status
406
# TODO: Re-adding a file that is removed in the working copy
407
# should probably put it back with the previous ID.
408
if isinstance(files, basestring):
409
assert(ids is None or isinstance(ids, basestring))
415
ids = [None] * len(files)
417
assert(len(ids) == len(files))
421
inv = self.read_working_inventory()
422
for f,file_id in zip(files, ids):
423
if is_control_file(f):
424
raise BzrError("cannot add control file %s" % quotefn(f))
429
raise BzrError("cannot add top-level %r" % f)
431
fullpath = os.path.normpath(self.abspath(f))
434
kind = file_kind(fullpath)
436
# maybe something better?
437
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
439
if kind != 'file' and kind != 'directory':
440
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
443
file_id = gen_file_id(f)
444
inv.add_path(f, kind=kind, file_id=file_id)
447
print 'added', quotefn(f)
449
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
451
self._write_inventory(inv)
456
def print_file(self, file, revno):
766
457
"""Print `file` to stdout."""
767
raise NotImplementedError(self.print_file)
769
@deprecated_method(deprecated_in((2, 4, 0)))
770
def set_revision_history(self, rev_history):
771
"""See Branch.set_revision_history."""
772
self._set_revision_history(rev_history)
775
def _set_revision_history(self, rev_history):
776
if len(rev_history) == 0:
777
revid = _mod_revision.NULL_REVISION
779
revid = rev_history[-1]
780
if rev_history != self._lefthand_history(revid):
781
raise errors.NotLefthandHistory(rev_history)
782
self.set_last_revision_info(len(rev_history), revid)
783
self._cache_revision_history(rev_history)
784
for hook in Branch.hooks['set_rh']:
785
hook(self, rev_history)
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()
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 only for use by subclasses, all other code
990
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):
460
tree = self.revision_tree(self.lookup_revision(revno))
461
# use inventory as it was in that revision
462
file_id = tree.inventory.path2id(file)
464
raise BzrError("%r is not present in revision %d" % (file, revno))
465
tree.print_file(file_id)
470
def remove(self, files, verbose=False):
471
"""Mark nominated files for removal from the inventory.
473
This does not remove their text. This does not run on
475
TODO: Refuse to remove modified files unless --force is given?
477
TODO: Do something useful with directories.
479
TODO: Should this remove the text or not? Tough call; not
480
removing may be useful and the user can just use use rm, and
481
is the opposite of add. Removing it is consistent with most
482
other tools. Maybe an option.
484
from bzrlib.textui import show_status
485
## TODO: Normalize names
486
## TODO: Remove nested loops; better scalability
487
if isinstance(files, basestring):
493
tree = self.working_tree()
496
# do this before any modifications
500
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
501
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
503
# having remove it, it must be either ignored or unknown
504
if tree.is_ignored(f):
508
show_status(new_status, inv[fid].kind, quotefn(f))
511
self._write_inventory(inv)
516
# FIXME: this doesn't need to be a branch method
517
def set_inventory(self, new_inventory_list):
518
from bzrlib.inventory import Inventory, InventoryEntry
520
for path, file_id, parent, kind in new_inventory_list:
521
name = os.path.basename(path)
524
inv.add(InventoryEntry(file_id, name, kind, parent))
525
self._write_inventory(inv)
529
"""Return all unknown files.
531
These are files in the working directory that are not versioned or
532
control files or ignored.
534
>>> b = ScratchBranch(files=['foo', 'foo~'])
535
>>> list(b.unknowns())
538
>>> list(b.unknowns())
541
>>> list(b.unknowns())
544
return self.working_tree().unknowns()
547
def append_revision(self, revision_id):
548
from bzrlib.atomicfile import AtomicFile
550
mutter("add {%s} to revision-history" % revision_id)
551
rev_history = self.revision_history() + [revision_id]
553
f = AtomicFile(self.controlfilename('revision-history'))
555
for rev_id in rev_history:
562
def get_revision(self, revision_id):
563
"""Return the Revision object for a named revision"""
564
from bzrlib.revision import Revision
565
from bzrlib.xml import unpack_xml
569
if not revision_id or not isinstance(revision_id, basestring):
570
raise ValueError('invalid revision-id: %r' % revision_id)
571
r = unpack_xml(Revision, self.revision_store[revision_id])
575
assert r.revision_id == revision_id
579
def get_revision_sha1(self, revision_id):
580
"""Hash the stored value of a revision, and return it."""
581
# In the future, revision entries will be signed. At that
582
# point, it is probably best *not* to include the signature
583
# in the revision hash. Because that lets you re-sign
584
# the revision, (add signatures/remove signatures) and still
585
# have all hash pointers stay consistent.
586
# But for now, just hash the contents.
587
return sha_file(self.revision_store[revision_id])
590
def get_inventory(self, inventory_id):
591
"""Get Inventory object by hash.
593
TODO: Perhaps for this and similar methods, take a revision
594
parameter which can be either an integer revno or a
596
from bzrlib.inventory import Inventory
597
from bzrlib.xml import unpack_xml
599
return unpack_xml(Inventory, self.inventory_store[inventory_id])
602
def get_inventory_sha1(self, inventory_id):
603
"""Return the sha1 hash of the inventory entry
605
return sha_file(self.inventory_store[inventory_id])
608
def get_revision_inventory(self, revision_id):
609
"""Return inventory of a past revision."""
610
# bzr 0.0.6 imposes the constraint that the inventory_id
611
# must be the same as its revision, so this is trivial.
612
if revision_id == None:
613
from bzrlib.inventory import Inventory
616
return self.get_inventory(revision_id)
619
def revision_history(self):
1002
620
"""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
@deprecated_method(deprecated_in((2, 5, 0)))
1018
def revision_history(self):
1019
"""Return sequence of revision ids on this branch.
1021
This method will cache the revision history for as long as it is safe to
1024
return self._revision_history()
1026
def _revision_history(self):
1027
if 'evil' in debug.debug_flags:
1028
mutter_callsite(3, "revision_history scales with history.")
1029
if self._revision_history_cache is not None:
1030
history = self._revision_history_cache
622
>>> ScratchBranch().revision_history()
627
return [l.rstrip('\r\n') for l in
628
self.controlfile('revision-history', 'r').readlines()]
633
def common_ancestor(self, other, self_revno=None, other_revno=None):
636
>>> sb = ScratchBranch(files=['foo', 'foo~'])
637
>>> sb.common_ancestor(sb) == (None, None)
639
>>> commit.commit(sb, "Committing first revision", verbose=False)
640
>>> sb.common_ancestor(sb)[0]
642
>>> clone = sb.clone()
643
>>> commit.commit(sb, "Committing second revision", verbose=False)
644
>>> sb.common_ancestor(sb)[0]
646
>>> sb.common_ancestor(clone)[0]
648
>>> commit.commit(clone, "Committing divergent second revision",
650
>>> sb.common_ancestor(clone)[0]
652
>>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
654
>>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
656
>>> clone2 = sb.clone()
657
>>> sb.common_ancestor(clone2)[0]
659
>>> sb.common_ancestor(clone2, self_revno=1)[0]
661
>>> sb.common_ancestor(clone2, other_revno=1)[0]
664
my_history = self.revision_history()
665
other_history = other.revision_history()
666
if self_revno is None:
667
self_revno = len(my_history)
668
if other_revno is None:
669
other_revno = len(other_history)
670
indices = range(min((self_revno, other_revno)))
673
if my_history[r] == other_history[r]:
674
return r+1, my_history[r]
677
def enum_history(self, direction):
678
"""Return (revno, revision_id) for history of branch.
681
'forward' is from earliest to latest
682
'reverse' is from latest to earliest
684
rh = self.revision_history()
685
if direction == 'forward':
690
elif direction == 'reverse':
1032
history = self._gen_revision_history()
1033
self._cache_revision_history(history)
1034
return list(history)
696
raise ValueError('invalid history direction', direction)
1036
699
def revno(self):
1037
700
"""Return current revision number for this branch.
1039
702
That is equivalent to the number of revisions committed to
1042
return self.last_revision_info()[0]
1045
"""Older format branches cannot bind or unbind."""
1046
raise errors.UpgradeRequired(self.user_url)
1048
def last_revision(self):
1049
"""Return last revision id, or NULL_REVISION."""
1050
return self.last_revision_info()[1]
1053
def last_revision_info(self):
1054
"""Return information about the last revision.
1056
:return: A tuple (revno, revision_id).
1058
if self._last_revision_info_cache is None:
1059
self._last_revision_info_cache = self._read_last_revision_info()
1060
return self._last_revision_info_cache
1062
def _read_last_revision_info(self):
1063
raise NotImplementedError(self._read_last_revision_info)
1065
@deprecated_method(deprecated_in((2, 4, 0)))
1066
def import_last_revision_info(self, source_repo, revno, revid):
1067
"""Set the last revision info, importing from another repo if necessary.
1069
:param source_repo: Source repository to optionally fetch from
1070
:param revno: Revision number of the new tip
1071
:param revid: Revision id of the new tip
1073
if not self.repository.has_same_location(source_repo):
1074
self.repository.fetch(source_repo, revision_id=revid)
1075
self.set_last_revision_info(revno, revid)
1077
def import_last_revision_info_and_tags(self, source, revno, revid,
1079
"""Set the last revision info, importing from another repo if necessary.
1081
This is used by the bound branch code to upload a revision to
1082
the master branch first before updating the tip of the local branch.
1083
Revisions referenced by source's tags are also transferred.
1085
:param source: Source branch to optionally fetch from
1086
:param revno: Revision number of the new tip
1087
:param revid: Revision id of the new tip
1088
:param lossy: Whether to discard metadata that can not be
1089
natively represented
1090
:return: Tuple with the new revision number and revision id
1091
(should only be different from the arguments when lossy=True)
1093
if not self.repository.has_same_location(source.repository):
1094
self.fetch(source, revid)
1095
self.set_last_revision_info(revno, revid)
1096
return (revno, revid)
1098
def revision_id_to_revno(self, revision_id):
1099
"""Given a revision id, return its revno"""
1100
if _mod_revision.is_null(revision_id):
1102
history = self._revision_history()
1104
return history.index(revision_id) + 1
1106
raise errors.NoSuchRevision(self, revision_id)
1109
def get_rev_id(self, revno, history=None):
1110
"""Find the revision id of the specified revno."""
1112
return _mod_revision.NULL_REVISION
1113
last_revno, last_revid = self.last_revision_info()
1114
if revno == last_revno:
1116
if revno <= 0 or revno > last_revno:
1117
raise errors.NoSuchRevision(self, revno)
1118
distance_from_last = last_revno - revno
1119
if len(self._partial_revision_history_cache) <= distance_from_last:
1120
self._extend_partial_history(distance_from_last)
1121
return self._partial_revision_history_cache[distance_from_last]
1123
def pull(self, source, overwrite=False, stop_revision=None,
1124
possible_transports=None, *args, **kwargs):
1125
"""Mirror source into this branch.
1127
This branch is considered to be 'local', having low latency.
1129
:returns: PullResult instance
1131
return InterBranch.get(source, self).pull(overwrite=overwrite,
1132
stop_revision=stop_revision,
1133
possible_transports=possible_transports, *args, **kwargs)
1135
def push(self, target, overwrite=False, stop_revision=None, lossy=False,
1137
"""Mirror this branch into target.
1139
This branch is considered to be 'local', having low latency.
1141
return InterBranch.get(self, target).push(overwrite, stop_revision,
1142
lossy, *args, **kwargs)
1144
def basis_tree(self):
1145
"""Return `Tree` object for last revision."""
1146
return self.repository.revision_tree(self.last_revision())
1148
def get_parent(self):
1149
"""Return the parent location of the branch.
1151
This is the default location for pull/missing. The usual
1152
pattern is that the user can override it by specifying a
1155
parent = self._get_parent_location()
1158
# This is an old-format absolute path to a local branch
1159
# turn it into a url
1160
if parent.startswith('/'):
1161
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1163
return urlutils.join(self.base[:-1], parent)
1164
except errors.InvalidURLJoin, e:
1165
raise errors.InaccessibleParent(parent, self.user_url)
1167
def _get_parent_location(self):
1168
raise NotImplementedError(self._get_parent_location)
1170
def _set_config_location(self, name, url, config=None,
1171
make_relative=False):
1173
config = self.get_config_stack()
1177
url = urlutils.relative_url(self.base, url)
1178
config.set(name, url)
1180
def _get_config_location(self, name, config=None):
1182
config = self.get_config_stack()
1183
location = config.get(name)
1188
def get_child_submit_format(self):
1189
"""Return the preferred format of submissions to this branch."""
1190
return self.get_config_stack().get('child_submit_format')
1192
def get_submit_branch(self):
1193
"""Return the submit location of the branch.
1195
This is the default location for bundle. The usual
1196
pattern is that the user can override it by specifying a
1199
return self.get_config_stack().get('submit_branch')
1201
def set_submit_branch(self, location):
1202
"""Return the submit location of the branch.
1204
This is the default location for bundle. The usual
1205
pattern is that the user can override it by specifying a
1208
self.get_config_stack().set('submit_branch', location)
1210
def get_public_branch(self):
1211
"""Return the public location of the branch.
1213
This is used by merge directives.
1215
return self._get_config_location('public_branch')
1217
def set_public_branch(self, location):
1218
"""Return the submit location of the branch.
1220
This is the default location for bundle. The usual
1221
pattern is that the user can override it by specifying a
1224
self._set_config_location('public_branch', location)
1226
def get_push_location(self):
1227
"""Return None or the location to push this branch to."""
1228
return self.get_config_stack().get('push_location')
1230
def set_push_location(self, location):
1231
"""Set a new push location for this branch."""
1232
raise NotImplementedError(self.set_push_location)
1234
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1235
"""Run the post_change_branch_tip hooks."""
1236
hooks = Branch.hooks['post_change_branch_tip']
1239
new_revno, new_revid = self.last_revision_info()
1240
params = ChangeBranchTipParams(
1241
self, old_revno, new_revno, old_revid, new_revid)
1245
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
1246
"""Run the pre_change_branch_tip hooks."""
1247
hooks = Branch.hooks['pre_change_branch_tip']
1250
old_revno, old_revid = self.last_revision_info()
1251
params = ChangeBranchTipParams(
1252
self, old_revno, new_revno, old_revid, new_revid)
1258
"""Synchronise this branch with the master branch if any.
1260
:return: None or the last_revision pivoted out during the update.
1264
def check_revno(self, revno):
1266
Check whether a revno corresponds to any revision.
1267
Zero (the NULL revision) is considered valid.
1270
self.check_real_revno(revno)
1272
def check_real_revno(self, revno):
1274
Check whether a revno corresponds to a real revision.
1275
Zero (the NULL revision) is considered invalid
1277
if revno < 1 or revno > self.revno():
1278
raise errors.InvalidRevisionNumber(revno)
1281
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
1282
"""Clone this branch into to_bzrdir preserving all semantic values.
1284
Most API users will want 'create_clone_on_transport', which creates a
1285
new bzrdir and branch on the fly.
1287
revision_id: if not None, the revision history in the new branch will
1288
be truncated to end with revision_id.
1290
result = to_bzrdir.create_branch()
1293
if repository_policy is not None:
1294
repository_policy.configure_branch(result)
1295
self.copy_content_into(result, revision_id=revision_id)
1301
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None,
1303
"""Create a new line of development from the branch, into to_bzrdir.
1305
to_bzrdir controls the branch format.
1307
revision_id: if not None, the revision history in the new branch will
1308
be truncated to end with revision_id.
1310
if (repository_policy is not None and
1311
repository_policy.requires_stacking()):
1312
to_bzrdir._format.require_stacking(_skip_repo=True)
1313
result = to_bzrdir.create_branch(repository=repository)
1316
if repository_policy is not None:
1317
repository_policy.configure_branch(result)
1318
self.copy_content_into(result, revision_id=revision_id)
1319
master_url = self.get_bound_location()
1320
if master_url is None:
1321
result.set_parent(self.bzrdir.root_transport.base)
1323
result.set_parent(master_url)
1328
def _synchronize_history(self, destination, revision_id):
1329
"""Synchronize last revision and revision history between branches.
1331
This version is most efficient when the destination is also a
1332
BzrBranch6, but works for BzrBranch5, as long as the destination's
1333
repository contains all the lefthand ancestors of the intended
1334
last_revision. If not, set_last_revision_info will fail.
1336
:param destination: The branch to copy the history into
1337
:param revision_id: The revision-id to truncate history at. May
1338
be None to copy complete history.
1340
source_revno, source_revision_id = self.last_revision_info()
1341
if revision_id is None:
1342
revno, revision_id = source_revno, source_revision_id
1344
graph = self.repository.get_graph()
1346
revno = graph.find_distance_to_null(revision_id,
1347
[(source_revision_id, source_revno)])
1348
except errors.GhostRevisionsHaveNoRevno:
1349
# Default to 1, if we can't find anything else
1351
destination.set_last_revision_info(revno, revision_id)
1353
def copy_content_into(self, destination, revision_id=None):
1354
"""Copy the content of self into destination.
1356
revision_id: if not None, the revision history in the new branch will
1357
be truncated to end with revision_id.
1359
return InterBranch.get(self, destination).copy_content_into(
1360
revision_id=revision_id)
1362
def update_references(self, target):
1363
if not getattr(self._format, 'supports_reference_locations', False):
1365
reference_dict = self._get_all_reference_info()
1366
if len(reference_dict) == 0:
1368
old_base = self.base
1369
new_base = target.base
1370
target_reference_dict = target._get_all_reference_info()
1371
for file_id, (tree_path, branch_location) in (
1372
reference_dict.items()):
1373
branch_location = urlutils.rebase_url(branch_location,
1375
target_reference_dict.setdefault(
1376
file_id, (tree_path, branch_location))
1377
target._set_all_reference_info(target_reference_dict)
1380
def check(self, refs):
1381
"""Check consistency of the branch.
1383
In particular this checks that revisions given in the revision-history
1384
do actually match up in the revision graph, and that they're all
1385
present in the repository.
1387
Callers will typically also want to check the repository.
1389
:param refs: Calculated refs for this branch as specified by
1390
branch._get_check_refs()
1391
:return: A BranchCheckResult.
1393
result = BranchCheckResult(self)
1394
last_revno, last_revision_id = self.last_revision_info()
1395
actual_revno = refs[('lefthand-distance', last_revision_id)]
1396
if actual_revno != last_revno:
1397
result.errors.append(errors.BzrCheckError(
1398
'revno does not match len(mainline) %s != %s' % (
1399
last_revno, actual_revno)))
1400
# TODO: We should probably also check that self.revision_history
1401
# matches the repository for older branch formats.
1402
# If looking for the code that cross-checks repository parents against
1403
# the Graph.iter_lefthand_ancestry output, that is now a repository
1407
def _get_checkout_format(self, lightweight=False):
1408
"""Return the most suitable metadir for a checkout of this branch.
1409
Weaves are used if this branch's repository uses weaves.
1411
format = self.repository.bzrdir.checkout_metadir()
1412
format.set_branch_format(self._format)
1415
def create_clone_on_transport(self, to_transport, revision_id=None,
1416
stacked_on=None, create_prefix=False, use_existing_dir=False,
1418
"""Create a clone of this branch and its bzrdir.
1420
:param to_transport: The transport to clone onto.
1421
:param revision_id: The revision id to use as tip in the new branch.
1422
If None the tip is obtained from this branch.
1423
:param stacked_on: An optional URL to stack the clone on.
1424
:param create_prefix: Create any missing directories leading up to
1426
:param use_existing_dir: Use an existing directory if one exists.
1428
# XXX: Fix the bzrdir API to allow getting the branch back from the
1429
# clone call. Or something. 20090224 RBC/spiv.
1430
# XXX: Should this perhaps clone colocated branches as well,
1431
# rather than just the default branch? 20100319 JRV
1432
if revision_id is None:
1433
revision_id = self.last_revision()
1434
dir_to = self.bzrdir.clone_on_transport(to_transport,
1435
revision_id=revision_id, stacked_on=stacked_on,
1436
create_prefix=create_prefix, use_existing_dir=use_existing_dir,
1438
return dir_to.open_branch()
1440
def create_checkout(self, to_location, revision_id=None,
1441
lightweight=False, accelerator_tree=None,
1443
"""Create a checkout of a branch.
1445
:param to_location: The url to produce the checkout at
1446
:param revision_id: The revision to check out
1447
:param lightweight: If True, produce a lightweight checkout, otherwise,
1448
produce a bound branch (heavyweight checkout)
1449
:param accelerator_tree: A tree which can be used for retrieving file
1450
contents more quickly than the revision tree, i.e. a workingtree.
1451
The revision tree will be used for cases where accelerator_tree's
1452
content is different.
1453
:param hardlink: If true, hard-link files from accelerator_tree,
1455
:return: The tree of the created checkout
1457
t = transport.get_transport(to_location)
1459
format = self._get_checkout_format(lightweight=lightweight)
1461
checkout = format.initialize_on_transport(t)
1462
except errors.AlreadyControlDirError:
1463
# It's fine if the control directory already exists,
1464
# as long as there is no existing branch and working tree.
1465
checkout = controldir.ControlDir.open_from_transport(t)
1467
checkout.open_branch()
1468
except errors.NotBranchError:
1471
raise errors.AlreadyControlDirError(t.base)
1472
if checkout.control_transport.base == self.bzrdir.control_transport.base:
1473
# When checking out to the same control directory,
1474
# always create a lightweight checkout
1478
from_branch = checkout.set_branch_reference(target_branch=self)
1480
policy = checkout.determine_repository_policy()
1481
repo = policy.acquire_repository()[0]
1482
checkout_branch = checkout.create_branch()
1483
checkout_branch.bind(self)
1484
# pull up to the specified revision_id to set the initial
1485
# branch tip correctly, and seed it with history.
1486
checkout_branch.pull(self, stop_revision=revision_id)
1488
tree = checkout.create_workingtree(revision_id,
1489
from_branch=from_branch,
1490
accelerator_tree=accelerator_tree,
1492
basis_tree = tree.basis_tree()
1493
basis_tree.lock_read()
1495
for path, file_id in basis_tree.iter_references():
1496
reference_parent = self.reference_parent(file_id, path)
1497
reference_parent.create_checkout(tree.abspath(path),
1498
basis_tree.get_reference_revision(file_id, path),
1505
def reconcile(self, thorough=True):
1506
"""Make sure the data stored in this branch is consistent."""
1507
from bzrlib.reconcile import BranchReconciler
1508
reconciler = BranchReconciler(self, thorough=thorough)
1509
reconciler.reconcile()
1512
def reference_parent(self, file_id, path, possible_transports=None):
1513
"""Return the parent branch for a tree-reference file_id
1515
:param file_id: The file_id of the tree reference
1516
:param path: The path of the file_id in the tree
1517
:return: A branch associated with the file_id
1519
# FIXME should provide multiple branches, based on config
1520
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1521
possible_transports=possible_transports)
1523
def supports_tags(self):
1524
return self._format.supports_tags()
1526
def automatic_tag_name(self, revision_id):
1527
"""Try to automatically find the tag name for a revision.
1529
:param revision_id: Revision id of the revision.
1530
:return: A tag name or None if no tag name could be determined.
1532
for hook in Branch.hooks['automatic_tag_name']:
1533
ret = hook(self, revision_id)
1538
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1540
"""Ensure that revision_b is a descendant of revision_a.
1542
This is a helper function for update_revisions.
1544
:raises: DivergedBranches if revision_b has diverged from revision_a.
1545
:returns: True if revision_b is a descendant of revision_a.
1547
relation = self._revision_relations(revision_a, revision_b, graph)
1548
if relation == 'b_descends_from_a':
1550
elif relation == 'diverged':
1551
raise errors.DivergedBranches(self, other_branch)
1552
elif relation == 'a_descends_from_b':
1555
raise AssertionError("invalid relation: %r" % (relation,))
1557
def _revision_relations(self, revision_a, revision_b, graph):
1558
"""Determine the relationship between two revisions.
1560
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1562
heads = graph.heads([revision_a, revision_b])
1563
if heads == set([revision_b]):
1564
return 'b_descends_from_a'
1565
elif heads == set([revision_a, revision_b]):
1566
# These branches have diverged
1568
elif heads == set([revision_a]):
1569
return 'a_descends_from_b'
1571
raise AssertionError("invalid heads: %r" % (heads,))
1573
def heads_to_fetch(self):
1574
"""Return the heads that must and that should be fetched to copy this
1575
branch into another repo.
1577
:returns: a 2-tuple of (must_fetch, if_present_fetch). must_fetch is a
1578
set of heads that must be fetched. if_present_fetch is a set of
1579
heads that must be fetched if present, but no error is necessary if
1580
they are not present.
1582
# For bzr native formats must_fetch is just the tip, and
1583
# if_present_fetch are the tags.
1584
must_fetch = set([self.last_revision()])
1585
if_present_fetch = set()
1586
if self.get_config_stack().get('branch.fetch_tags'):
1588
if_present_fetch = set(self.tags.get_reverse_tag_dict())
1589
except errors.TagsNotSupported:
1591
must_fetch.discard(_mod_revision.NULL_REVISION)
1592
if_present_fetch.discard(_mod_revision.NULL_REVISION)
1593
return must_fetch, if_present_fetch
1596
class BranchFormat(controldir.ControlComponentFormat):
1597
"""An encapsulation of the initialization and open routines for a format.
1599
Formats provide three things:
1600
* An initialization routine,
1601
* a format description
1604
Formats are placed in an dict by their format string for reference
1605
during branch opening. It's not required that these be instances, they
1606
can be classes themselves with class methods - it simply depends on
1607
whether state is needed for a given format or not.
1609
Once a format is deprecated, just deprecate the initialize and open
1610
methods on the format class. Do not deprecate the object, as the
1611
object will be created every time regardless.
1614
def __eq__(self, other):
1615
return self.__class__ is other.__class__
1617
def __ne__(self, other):
1618
return not (self == other)
1621
@deprecated_method(deprecated_in((2, 4, 0)))
1622
def get_default_format(klass):
1623
"""Return the current default format."""
1624
return format_registry.get_default()
1627
@deprecated_method(deprecated_in((2, 4, 0)))
1628
def get_formats(klass):
1629
"""Get all the known formats.
1631
Warning: This triggers a load of all lazy registered formats: do not
1632
use except when that is desireed.
1634
return format_registry._get_all()
1636
def get_reference(self, controldir, name=None):
1637
"""Get the target reference of the branch in controldir.
1639
format probing must have been completed before calling
1640
this method - it is assumed that the format of the branch
1641
in controldir is correct.
1643
:param controldir: The controldir to get the branch data from.
1644
:param name: Name of the colocated branch to fetch
1645
:return: None if the branch is not a reference branch.
1650
def set_reference(self, controldir, name, to_branch):
1651
"""Set the target reference of the branch in controldir.
1653
format probing must have been completed before calling
1654
this method - it is assumed that the format of the branch
1655
in controldir is correct.
1657
:param controldir: The controldir to set the branch reference for.
1658
:param name: Name of colocated branch to set, None for default
1659
:param to_branch: branch that the checkout is to reference
1661
raise NotImplementedError(self.set_reference)
1663
def get_format_description(self):
1664
"""Return the short format description for this format."""
1665
raise NotImplementedError(self.get_format_description)
1667
def _run_post_branch_init_hooks(self, controldir, name, branch):
1668
hooks = Branch.hooks['post_branch_init']
1671
params = BranchInitHookParams(self, controldir, name, branch)
1675
def initialize(self, controldir, name=None, repository=None,
1676
append_revisions_only=None):
1677
"""Create a branch of this format in controldir.
1679
:param name: Name of the colocated branch to create.
1681
raise NotImplementedError(self.initialize)
1683
def is_supported(self):
1684
"""Is this format supported?
1686
Supported formats can be initialized and opened.
1687
Unsupported formats may not support initialization or committing or
1688
some other features depending on the reason for not being supported.
1692
def make_tags(self, branch):
1693
"""Create a tags object for branch.
1695
This method is on BranchFormat, because BranchFormats are reflected
1696
over the wire via network_name(), whereas full Branch instances require
1697
multiple VFS method calls to operate at all.
1699
The default implementation returns a disabled-tags instance.
1701
Note that it is normal for branch to be a RemoteBranch when using tags
1704
return _mod_tag.DisabledTags(branch)
1706
def network_name(self):
1707
"""A simple byte string uniquely identifying this format for RPC calls.
1709
MetaDir branch formats use their disk format string to identify the
1710
repository over the wire. All in one formats such as bzr < 0.8, and
1711
foreign formats like svn/git and hg should use some marker which is
1712
unique and immutable.
1714
raise NotImplementedError(self.network_name)
1716
def open(self, controldir, name=None, _found=False, ignore_fallbacks=False,
1717
found_repository=None, possible_transports=None):
1718
"""Return the branch object for controldir.
1720
:param controldir: A ControlDir that contains a branch.
1721
:param name: Name of colocated branch to open
1722
:param _found: a private parameter, do not use it. It is used to
1723
indicate if format probing has already be done.
1724
:param ignore_fallbacks: when set, no fallback branches will be opened
1725
(if there are any). Default is to open fallbacks.
1727
raise NotImplementedError(self.open)
1730
@deprecated_method(deprecated_in((2, 4, 0)))
1731
def register_format(klass, format):
1732
"""Register a metadir format.
1734
See MetaDirBranchFormatFactory for the ability to register a format
1735
without loading the code the format needs until it is actually used.
1737
format_registry.register(format)
1740
@deprecated_method(deprecated_in((2, 4, 0)))
1741
def set_default_format(klass, format):
1742
format_registry.set_default(format)
1744
def supports_set_append_revisions_only(self):
1745
"""True if this format supports set_append_revisions_only."""
1748
def supports_stacking(self):
1749
"""True if this format records a stacked-on branch."""
1752
def supports_leaving_lock(self):
1753
"""True if this format supports leaving locks in place."""
1754
return False # by default
1757
@deprecated_method(deprecated_in((2, 4, 0)))
1758
def unregister_format(klass, format):
1759
format_registry.remove(format)
1762
return self.get_format_description().rstrip()
1764
def supports_tags(self):
1765
"""True if this format supports tags stored in the branch"""
1766
return False # by default
1768
def tags_are_versioned(self):
1769
"""Whether the tag container for this branch versions tags."""
1772
def supports_tags_referencing_ghosts(self):
1773
"""True if tags can reference ghost revisions."""
1777
class MetaDirBranchFormatFactory(registry._LazyObjectGetter):
1778
"""A factory for a BranchFormat object, permitting simple lazy registration.
1780
While none of the built in BranchFormats are lazy registered yet,
1781
bzrlib.tests.test_branch.TestMetaDirBranchFormatFactory demonstrates how to
1782
use it, and the bzr-loom plugin uses it as well (see
1783
bzrlib.plugins.loom.formats).
1786
def __init__(self, format_string, module_name, member_name):
1787
"""Create a MetaDirBranchFormatFactory.
1789
:param format_string: The format string the format has.
1790
:param module_name: Module to load the format class from.
1791
:param member_name: Attribute name within the module for the format class.
1793
registry._LazyObjectGetter.__init__(self, module_name, member_name)
1794
self._format_string = format_string
1796
def get_format_string(self):
1797
"""See BranchFormat.get_format_string."""
1798
return self._format_string
1801
"""Used for network_format_registry support."""
1802
return self.get_obj()()
1805
class BranchHooks(Hooks):
1806
"""A dictionary mapping hook name to a list of callables for branch hooks.
1808
e.g. ['set_rh'] Is the list of items to be called when the
1809
set_revision_history function is invoked.
1813
"""Create the default hooks.
1815
These are all empty initially, because by default nothing should get
1818
Hooks.__init__(self, "bzrlib.branch", "Branch.hooks")
1819
self.add_hook('set_rh',
1820
"Invoked whenever the revision history has been set via "
1821
"set_revision_history. The api signature is (branch, "
1822
"revision_history), and the branch will be write-locked. "
1823
"The set_rh hook can be expensive for bzr to trigger, a better "
1824
"hook to use is Branch.post_change_branch_tip.", (0, 15))
1825
self.add_hook('open',
1826
"Called with the Branch object that has been opened after a "
1827
"branch is opened.", (1, 8))
1828
self.add_hook('post_push',
1829
"Called after a push operation completes. post_push is called "
1830
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1831
"bzr client.", (0, 15))
1832
self.add_hook('post_pull',
1833
"Called after a pull operation completes. post_pull is called "
1834
"with a bzrlib.branch.PullResult object and only runs in the "
1835
"bzr client.", (0, 15))
1836
self.add_hook('pre_commit',
1837
"Called after a commit is calculated but before it is "
1838
"completed. pre_commit is called with (local, master, old_revno, "
1839
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1840
"). old_revid is NULL_REVISION for the first commit to a branch, "
1841
"tree_delta is a TreeDelta object describing changes from the "
1842
"basis revision. hooks MUST NOT modify this delta. "
1843
" future_tree is an in-memory tree obtained from "
1844
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1846
self.add_hook('post_commit',
1847
"Called in the bzr client after a commit has completed. "
1848
"post_commit is called with (local, master, old_revno, old_revid, "
1849
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1850
"commit to a branch.", (0, 15))
1851
self.add_hook('post_uncommit',
1852
"Called in the bzr client after an uncommit completes. "
1853
"post_uncommit is called with (local, master, old_revno, "
1854
"old_revid, new_revno, new_revid) where local is the local branch "
1855
"or None, master is the target branch, and an empty branch "
1856
"receives new_revno of 0, new_revid of None.", (0, 15))
1857
self.add_hook('pre_change_branch_tip',
1858
"Called in bzr client and server before a change to the tip of a "
1859
"branch is made. pre_change_branch_tip is called with a "
1860
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1861
"commit, uncommit will all trigger this hook.", (1, 6))
1862
self.add_hook('post_change_branch_tip',
1863
"Called in bzr client and server after a change to the tip of a "
1864
"branch is made. post_change_branch_tip is called with a "
1865
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1866
"commit, uncommit will all trigger this hook.", (1, 4))
1867
self.add_hook('transform_fallback_location',
1868
"Called when a stacked branch is activating its fallback "
1869
"locations. transform_fallback_location is called with (branch, "
1870
"url), and should return a new url. Returning the same url "
1871
"allows it to be used as-is, returning a different one can be "
1872
"used to cause the branch to stack on a closer copy of that "
1873
"fallback_location. Note that the branch cannot have history "
1874
"accessing methods called on it during this hook because the "
1875
"fallback locations have not been activated. When there are "
1876
"multiple hooks installed for transform_fallback_location, "
1877
"all are called with the url returned from the previous hook."
1878
"The order is however undefined.", (1, 9))
1879
self.add_hook('automatic_tag_name',
1880
"Called to determine an automatic tag name for a revision. "
1881
"automatic_tag_name is called with (branch, revision_id) and "
1882
"should return a tag name or None if no tag name could be "
1883
"determined. The first non-None tag name returned will be used.",
1885
self.add_hook('post_branch_init',
1886
"Called after new branch initialization completes. "
1887
"post_branch_init is called with a "
1888
"bzrlib.branch.BranchInitHookParams. "
1889
"Note that init, branch and checkout (both heavyweight and "
1890
"lightweight) will all trigger this hook.", (2, 2))
1891
self.add_hook('post_switch',
1892
"Called after a checkout switches branch. "
1893
"post_switch is called with a "
1894
"bzrlib.branch.SwitchHookParams.", (2, 2))
1898
# install the default hooks into the Branch class.
1899
Branch.hooks = BranchHooks()
1902
class ChangeBranchTipParams(object):
1903
"""Object holding parameters passed to `*_change_branch_tip` hooks.
1905
There are 5 fields that hooks may wish to access:
1907
:ivar branch: the branch being changed
1908
:ivar old_revno: revision number before the change
1909
:ivar new_revno: revision number after the change
1910
:ivar old_revid: revision id before the change
1911
:ivar new_revid: revision id after the change
1913
The revid fields are strings. The revno fields are integers.
1916
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1917
"""Create a group of ChangeBranchTip parameters.
1919
:param branch: The branch being changed.
1920
:param old_revno: Revision number before the change.
1921
:param new_revno: Revision number after the change.
1922
:param old_revid: Tip revision id before the change.
1923
:param new_revid: Tip revision id after the change.
1925
self.branch = branch
1926
self.old_revno = old_revno
1927
self.new_revno = new_revno
1928
self.old_revid = old_revid
1929
self.new_revid = new_revid
1931
def __eq__(self, other):
1932
return self.__dict__ == other.__dict__
1935
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1936
self.__class__.__name__, self.branch,
1937
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1940
class BranchInitHookParams(object):
1941
"""Object holding parameters passed to `*_branch_init` hooks.
1943
There are 4 fields that hooks may wish to access:
1945
:ivar format: the branch format
1946
:ivar bzrdir: the ControlDir where the branch will be/has been initialized
1947
:ivar name: name of colocated branch, if any (or None)
1948
:ivar branch: the branch created
1950
Note that for lightweight checkouts, the bzrdir and format fields refer to
1951
the checkout, hence they are different from the corresponding fields in
1952
branch, which refer to the original branch.
1955
def __init__(self, format, controldir, name, branch):
1956
"""Create a group of BranchInitHook parameters.
1958
:param format: the branch format
1959
:param controldir: the ControlDir where the branch will be/has been
1961
:param name: name of colocated branch, if any (or None)
1962
:param branch: the branch created
1964
Note that for lightweight checkouts, the bzrdir and format fields refer
1965
to the checkout, hence they are different from the corresponding fields
1966
in branch, which refer to the original branch.
1968
self.format = format
1969
self.bzrdir = controldir
1971
self.branch = branch
1973
def __eq__(self, other):
1974
return self.__dict__ == other.__dict__
1977
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1980
class SwitchHookParams(object):
1981
"""Object holding parameters passed to `*_switch` hooks.
1983
There are 4 fields that hooks may wish to access:
1985
:ivar control_dir: ControlDir of the checkout to change
1986
:ivar to_branch: branch that the checkout is to reference
1987
:ivar force: skip the check for local commits in a heavy checkout
1988
:ivar revision_id: revision ID to switch to (or None)
1991
def __init__(self, control_dir, to_branch, force, revision_id):
1992
"""Create a group of SwitchHook parameters.
1994
:param control_dir: ControlDir of the checkout to change
1995
:param to_branch: branch that the checkout is to reference
1996
:param force: skip the check for local commits in a heavy checkout
1997
:param revision_id: revision ID to switch to (or None)
1999
self.control_dir = control_dir
2000
self.to_branch = to_branch
2002
self.revision_id = revision_id
2004
def __eq__(self, other):
2005
return self.__dict__ == other.__dict__
2008
return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
2009
self.control_dir, self.to_branch,
2013
class BranchFormatMetadir(bzrdir.BzrFormat, BranchFormat):
2014
"""Base class for branch formats that live in meta directories.
2018
BranchFormat.__init__(self)
2019
bzrdir.BzrFormat.__init__(self)
2022
def find_format(klass, controldir, name=None):
2023
"""Return the format for the branch object in controldir."""
2025
transport = controldir.get_branch_transport(None, name=name)
2026
except errors.NoSuchFile:
2027
raise errors.NotBranchError(path=name, bzrdir=controldir)
2029
format_string = transport.get_bytes("format")
2030
except errors.NoSuchFile:
2031
raise errors.NotBranchError(path=transport.base, bzrdir=controldir)
2032
return klass._find_format(format_registry, 'branch', format_string)
2034
def _branch_class(self):
2035
"""What class to instantiate on open calls."""
2036
raise NotImplementedError(self._branch_class)
2038
def _get_initial_config(self, append_revisions_only=None):
2039
if append_revisions_only:
2040
return "append_revisions_only = True\n"
2042
# Avoid writing anything if append_revisions_only is disabled,
2043
# as that is the default.
2046
def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
2048
"""Initialize a branch in a bzrdir, with specified files
2050
:param a_bzrdir: The bzrdir to initialize the branch in
2051
:param utf8_files: The files to create as a list of
2052
(filename, content) tuples
2053
:param name: Name of colocated branch to create, if any
2054
:return: a branch in this format
2057
name = a_bzrdir._get_selected_branch()
2058
mutter('creating branch %r in %s', self, a_bzrdir.user_url)
2059
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2060
control_files = lockable_files.LockableFiles(branch_transport,
2061
'lock', lockdir.LockDir)
2062
control_files.create_lock()
2063
control_files.lock_write()
2065
utf8_files += [('format', self.as_string())]
2066
for (filename, content) in utf8_files:
2067
branch_transport.put_bytes(
2069
mode=a_bzrdir._get_file_mode())
2071
control_files.unlock()
2072
branch = self.open(a_bzrdir, name, _found=True,
2073
found_repository=repository)
2074
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2077
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
2078
found_repository=None, possible_transports=None):
2079
"""See BranchFormat.open()."""
2081
name = a_bzrdir._get_selected_branch()
2083
format = BranchFormatMetadir.find_format(a_bzrdir, name=name)
2084
if format.__class__ != self.__class__:
2085
raise AssertionError("wrong format %r found for %r" %
2087
transport = a_bzrdir.get_branch_transport(None, name=name)
2089
control_files = lockable_files.LockableFiles(transport, 'lock',
2091
if found_repository is None:
2092
found_repository = a_bzrdir.find_repository()
2093
return self._branch_class()(_format=self,
2094
_control_files=control_files,
2097
_repository=found_repository,
2098
ignore_fallbacks=ignore_fallbacks,
2099
possible_transports=possible_transports)
2100
except errors.NoSuchFile:
2101
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
2104
def _matchingbzrdir(self):
2105
ret = bzrdir.BzrDirMetaFormat1()
2106
ret.set_branch_format(self)
2109
def supports_tags(self):
2112
def supports_leaving_lock(self):
2115
def check_support_status(self, allow_unsupported, recommend_upgrade=True,
2117
BranchFormat.check_support_status(self,
2118
allow_unsupported=allow_unsupported, recommend_upgrade=recommend_upgrade,
2120
bzrdir.BzrFormat.check_support_status(self, allow_unsupported=allow_unsupported,
2121
recommend_upgrade=recommend_upgrade, basedir=basedir)
2124
class BzrBranchFormat5(BranchFormatMetadir):
2125
"""Bzr branch format 5.
2128
- a revision-history file.
2130
- a lock dir guarding the branch itself
2131
- all of this stored in a branch/ subdirectory
2132
- works with shared repositories.
2134
This format is new in bzr 0.8.
2137
def _branch_class(self):
2141
def get_format_string(cls):
2142
"""See BranchFormat.get_format_string()."""
2143
return "Bazaar-NG branch format 5\n"
2145
def get_format_description(self):
2146
"""See BranchFormat.get_format_description()."""
2147
return "Branch format 5"
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
if append_revisions_only:
2153
raise errors.UpgradeRequired(a_bzrdir.user_url)
2154
utf8_files = [('revision-history', ''),
2155
('branch-name', ''),
2157
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2159
def supports_tags(self):
2163
class BzrBranchFormat6(BranchFormatMetadir):
2164
"""Branch format with last-revision and tags.
2166
Unlike previous formats, this has no explicit revision history. Instead,
2167
this just stores the last-revision, and the left-hand history leading
2168
up to there is the history.
2170
This format was introduced in bzr 0.15
2171
and became the default in 0.91.
2174
def _branch_class(self):
2178
def get_format_string(cls):
2179
"""See BranchFormat.get_format_string()."""
2180
return "Bazaar Branch Format 6 (bzr 0.15)\n"
2182
def get_format_description(self):
2183
"""See BranchFormat.get_format_description()."""
2184
return "Branch format 6"
2186
def initialize(self, a_bzrdir, name=None, repository=None,
2187
append_revisions_only=None):
2188
"""Create a branch of this format in a_bzrdir."""
2189
utf8_files = [('last-revision', '0 null:\n'),
2191
self._get_initial_config(append_revisions_only)),
2194
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2196
def make_tags(self, branch):
2197
"""See bzrlib.branch.BranchFormat.make_tags()."""
2198
return _mod_tag.BasicTags(branch)
2200
def supports_set_append_revisions_only(self):
2204
class BzrBranchFormat8(BranchFormatMetadir):
2205
"""Metadir format supporting storing locations of subtree branches."""
2207
def _branch_class(self):
2211
def get_format_string(cls):
2212
"""See BranchFormat.get_format_string()."""
2213
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2215
def get_format_description(self):
2216
"""See BranchFormat.get_format_description()."""
2217
return "Branch format 8"
2219
def initialize(self, a_bzrdir, name=None, repository=None,
2220
append_revisions_only=None):
2221
"""Create a branch of this format in a_bzrdir."""
2222
utf8_files = [('last-revision', '0 null:\n'),
2224
self._get_initial_config(append_revisions_only)),
2228
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2230
def make_tags(self, branch):
2231
"""See bzrlib.branch.BranchFormat.make_tags()."""
2232
return _mod_tag.BasicTags(branch)
2234
def supports_set_append_revisions_only(self):
2237
def supports_stacking(self):
2240
supports_reference_locations = True
2243
class BzrBranchFormat7(BranchFormatMetadir):
2244
"""Branch format with last-revision, tags, and a stacked location pointer.
2246
The stacked location pointer is passed down to the repository and requires
2247
a repository format with supports_external_lookups = True.
2249
This format was introduced in bzr 1.6.
2252
def initialize(self, a_bzrdir, name=None, repository=None,
2253
append_revisions_only=None):
2254
"""Create a branch of this format in a_bzrdir."""
2255
utf8_files = [('last-revision', '0 null:\n'),
2257
self._get_initial_config(append_revisions_only)),
2260
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2262
def _branch_class(self):
2266
def get_format_string(cls):
2267
"""See BranchFormat.get_format_string()."""
2268
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
2270
def get_format_description(self):
2271
"""See BranchFormat.get_format_description()."""
2272
return "Branch format 7"
2274
def supports_set_append_revisions_only(self):
2277
def supports_stacking(self):
2280
def make_tags(self, branch):
2281
"""See bzrlib.branch.BranchFormat.make_tags()."""
2282
return _mod_tag.BasicTags(branch)
2284
supports_reference_locations = False
2287
class BranchReferenceFormat(BranchFormatMetadir):
2288
"""Bzr branch reference format.
2290
Branch references are used in implementing checkouts, they
2291
act as an alias to the real branch which is at some other url.
2299
def get_format_string(cls):
2300
"""See BranchFormat.get_format_string()."""
2301
return "Bazaar-NG Branch Reference Format 1\n"
2303
def get_format_description(self):
2304
"""See BranchFormat.get_format_description()."""
2305
return "Checkout reference format 1"
2307
def get_reference(self, a_bzrdir, name=None):
2308
"""See BranchFormat.get_reference()."""
2309
transport = a_bzrdir.get_branch_transport(None, name=name)
2310
return transport.get_bytes('location')
2312
def set_reference(self, a_bzrdir, name, to_branch):
2313
"""See BranchFormat.set_reference()."""
2314
transport = a_bzrdir.get_branch_transport(None, name=name)
2315
location = transport.put_bytes('location', to_branch.base)
2317
def initialize(self, a_bzrdir, name=None, target_branch=None,
2318
repository=None, append_revisions_only=None):
2319
"""Create a branch of this format in a_bzrdir."""
2320
if target_branch is None:
2321
# this format does not implement branch itself, thus the implicit
2322
# creation contract must see it as uninitializable
2323
raise errors.UninitializableFormat(self)
2324
mutter('creating branch reference in %s', a_bzrdir.user_url)
2325
if a_bzrdir._format.fixed_components:
2326
raise errors.IncompatibleFormat(self, a_bzrdir._format)
2328
name = a_bzrdir._get_selected_branch()
2329
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2330
branch_transport.put_bytes('location',
2331
target_branch.user_url)
2332
branch_transport.put_bytes('format', self.as_string())
2333
branch = self.open(a_bzrdir, name, _found=True,
2334
possible_transports=[target_branch.bzrdir.root_transport])
2335
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2338
def _make_reference_clone_function(format, a_branch):
2339
"""Create a clone() routine for a branch dynamically."""
2340
def clone(to_bzrdir, revision_id=None,
2341
repository_policy=None):
2342
"""See Branch.clone()."""
2343
return format.initialize(to_bzrdir, target_branch=a_branch)
2344
# cannot obey revision_id limits when cloning a reference ...
2345
# FIXME RBC 20060210 either nuke revision_id for clone, or
2346
# emit some sort of warning/error to the caller ?!
2349
def open(self, a_bzrdir, name=None, _found=False, location=None,
2350
possible_transports=None, ignore_fallbacks=False,
2351
found_repository=None):
2352
"""Return the branch that the branch reference in a_bzrdir points at.
2354
:param a_bzrdir: A BzrDir that contains a branch.
2355
:param name: Name of colocated branch to open, if any
2356
:param _found: a private parameter, do not use it. It is used to
2357
indicate if format probing has already be done.
2358
:param ignore_fallbacks: when set, no fallback branches will be opened
2359
(if there are any). Default is to open fallbacks.
2360
:param location: The location of the referenced branch. If
2361
unspecified, this will be determined from the branch reference in
2363
:param possible_transports: An optional reusable transports list.
2366
name = a_bzrdir._get_selected_branch()
2368
format = BranchFormatMetadir.find_format(a_bzrdir, name=name)
2369
if format.__class__ != self.__class__:
2370
raise AssertionError("wrong format %r found for %r" %
2372
if location is None:
2373
location = self.get_reference(a_bzrdir, name)
2374
real_bzrdir = controldir.ControlDir.open(
2375
location, possible_transports=possible_transports)
2376
result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks,
2377
possible_transports=possible_transports)
2378
# this changes the behaviour of result.clone to create a new reference
2379
# rather than a copy of the content of the branch.
2380
# I did not use a proxy object because that needs much more extensive
2381
# testing, and we are only changing one behaviour at the moment.
2382
# If we decide to alter more behaviours - i.e. the implicit nickname
2383
# then this should be refactored to introduce a tested proxy branch
2384
# and a subclass of that for use in overriding clone() and ....
2386
result.clone = self._make_reference_clone_function(result)
2390
class BranchFormatRegistry(controldir.ControlComponentFormatRegistry):
2391
"""Branch format registry."""
2393
def __init__(self, other_registry=None):
2394
super(BranchFormatRegistry, self).__init__(other_registry)
2395
self._default_format = None
2397
def set_default(self, format):
2398
self._default_format = format
2400
def get_default(self):
2401
return self._default_format
2404
network_format_registry = registry.FormatRegistry()
2405
"""Registry of formats indexed by their network name.
2407
The network name for a branch format is an identifier that can be used when
2408
referring to formats with smart server operations. See
2409
BranchFormat.network_name() for more detail.
2412
format_registry = BranchFormatRegistry(network_format_registry)
2415
# formats which have no format string are not discoverable
2416
# and not independently creatable, so are not registered.
2417
__format5 = BzrBranchFormat5()
2418
__format6 = BzrBranchFormat6()
2419
__format7 = BzrBranchFormat7()
2420
__format8 = BzrBranchFormat8()
2421
format_registry.register(__format5)
2422
format_registry.register(BranchReferenceFormat())
2423
format_registry.register(__format6)
2424
format_registry.register(__format7)
2425
format_registry.register(__format8)
2426
format_registry.set_default(__format7)
2429
class BranchWriteLockResult(LogicalLockResult):
2430
"""The result of write locking a branch.
2432
:ivar branch_token: The token obtained from the underlying branch lock, or
2434
:ivar unlock: A callable which will unlock the lock.
2437
def __init__(self, unlock, branch_token):
2438
LogicalLockResult.__init__(self, unlock)
2439
self.branch_token = branch_token
2442
return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2446
class BzrBranch(Branch, _RelockDebugMixin):
2447
"""A branch stored in the actual filesystem.
2449
Note that it's "local" in the context of the filesystem; it doesn't
2450
really matter if it's on an nfs/smb/afs/coda/... share, as long as
2451
it's writable, and can be accessed via the normal filesystem API.
2453
:ivar _transport: Transport for file operations on this branch's
2454
control files, typically pointing to the .bzr/branch directory.
2455
:ivar repository: Repository for this branch.
2456
:ivar base: The url of the base directory for this branch; the one
2457
containing the .bzr directory.
2458
:ivar name: Optional colocated branch name as it exists in the control
2462
def __init__(self, _format=None,
2463
_control_files=None, a_bzrdir=None, name=None,
2464
_repository=None, ignore_fallbacks=False,
2465
possible_transports=None):
2466
"""Create new branch object at a particular location."""
2467
if a_bzrdir is None:
2468
raise ValueError('a_bzrdir must be supplied')
2470
raise ValueError('name must be supplied')
2471
self.bzrdir = a_bzrdir
2472
self._user_transport = self.bzrdir.transport.clone('..')
2474
self._user_transport.set_segment_parameter(
2475
"branch", urlutils.escape(name))
2476
self._base = self._user_transport.base
2478
self._format = _format
2479
if _control_files is None:
2480
raise ValueError('BzrBranch _control_files is None')
2481
self.control_files = _control_files
2482
self._transport = _control_files._transport
2483
self.repository = _repository
2484
self.conf_store = None
2485
Branch.__init__(self, possible_transports)
2488
return '%s(%s)' % (self.__class__.__name__, self.user_url)
2492
def _get_base(self):
2493
"""Returns the directory containing the control directory."""
2496
base = property(_get_base, doc="The URL for the root of this branch.")
2499
def user_transport(self):
2500
return self._user_transport
2502
def _get_config(self):
2503
return _mod_config.TransportConfig(self._transport, 'branch.conf')
2505
def _get_config_store(self):
2506
if self.conf_store is None:
2507
self.conf_store = _mod_config.BranchStore(self)
2508
return self.conf_store
2510
def is_locked(self):
2511
return self.control_files.is_locked()
2513
def lock_write(self, token=None):
2514
"""Lock the branch for write operations.
2516
:param token: A token to permit reacquiring a previously held and
2518
:return: A BranchWriteLockResult.
2520
if not self.is_locked():
2521
self._note_lock('w')
2522
# All-in-one needs to always unlock/lock.
2523
repo_control = getattr(self.repository, 'control_files', None)
2524
if self.control_files == repo_control or not self.is_locked():
2525
self.repository._warn_if_deprecated(self)
2526
self.repository.lock_write()
2531
return BranchWriteLockResult(self.unlock,
2532
self.control_files.lock_write(token=token))
2535
self.repository.unlock()
2538
def lock_read(self):
2539
"""Lock the branch for read operations.
2541
:return: A bzrlib.lock.LogicalLockResult.
2543
if not self.is_locked():
2544
self._note_lock('r')
2545
# All-in-one needs to always unlock/lock.
2546
repo_control = getattr(self.repository, 'control_files', None)
2547
if self.control_files == repo_control or not self.is_locked():
2548
self.repository._warn_if_deprecated(self)
2549
self.repository.lock_read()
2554
self.control_files.lock_read()
2555
return LogicalLockResult(self.unlock)
2558
self.repository.unlock()
2561
@only_raises(errors.LockNotHeld, errors.LockBroken)
2563
if self.conf_store is not None:
2564
self.conf_store.save_changes()
2566
self.control_files.unlock()
2568
# All-in-one needs to always unlock/lock.
2569
repo_control = getattr(self.repository, 'control_files', None)
2570
if (self.control_files == repo_control or
2571
not self.control_files.is_locked()):
2572
self.repository.unlock()
2573
if not self.control_files.is_locked():
2574
# we just released the lock
2575
self._clear_cached_state()
2577
def peek_lock_mode(self):
2578
if self.control_files._lock_count == 0:
2581
return self.control_files._lock_mode
2583
def get_physical_lock_status(self):
2584
return self.control_files.get_physical_lock_status()
2587
def print_file(self, file, revision_id):
2588
"""See Branch.print_file."""
2589
return self.repository.print_file(file, revision_id)
2592
def set_last_revision_info(self, revno, revision_id):
2593
if not revision_id or not isinstance(revision_id, basestring):
2594
raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2595
revision_id = _mod_revision.ensure_null(revision_id)
2596
old_revno, old_revid = self.last_revision_info()
2597
if self.get_append_revisions_only():
2598
self._check_history_violation(revision_id)
2599
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2600
self._write_last_revision_info(revno, revision_id)
2601
self._clear_cached_state()
2602
self._last_revision_info_cache = revno, revision_id
2603
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2605
def basis_tree(self):
2606
"""See Branch.basis_tree."""
2607
return self.repository.revision_tree(self.last_revision())
2609
def _get_parent_location(self):
2610
_locs = ['parent', 'pull', 'x-pull']
2613
return self._transport.get_bytes(l).strip('\n')
2614
except errors.NoSuchFile:
2618
def get_stacked_on_url(self):
2619
raise errors.UnstackableBranchFormat(self._format, self.user_url)
2621
def set_push_location(self, location):
2622
"""See Branch.set_push_location."""
2623
self.get_config().set_user_option(
2624
'push_location', location,
2625
store=_mod_config.STORE_LOCATION_NORECURSE)
2627
def _set_parent_location(self, url):
2629
self._transport.delete('parent')
2631
self._transport.put_bytes('parent', url + '\n',
2632
mode=self.bzrdir._get_file_mode())
2636
"""If bound, unbind"""
2637
return self.set_bound_location(None)
2640
def bind(self, other):
2641
"""Bind this branch to the branch other.
2643
This does not push or pull data between the branches, though it does
2644
check for divergence to raise an error when the branches are not
2645
either the same, or one a prefix of the other. That behaviour may not
2646
be useful, so that check may be removed in future.
2648
:param other: The branch to bind to
2651
# TODO: jam 20051230 Consider checking if the target is bound
2652
# It is debatable whether you should be able to bind to
2653
# a branch which is itself bound.
2654
# Committing is obviously forbidden,
2655
# but binding itself may not be.
2656
# Since we *have* to check at commit time, we don't
2657
# *need* to check here
2659
# we want to raise diverged if:
2660
# last_rev is not in the other_last_rev history, AND
2661
# other_last_rev is not in our history, and do it without pulling
2663
self.set_bound_location(other.base)
2665
def get_bound_location(self):
2667
return self._transport.get_bytes('bound')[:-1]
2668
except errors.NoSuchFile:
2672
def get_master_branch(self, possible_transports=None):
2673
"""Return the branch we are bound to.
2675
:return: Either a Branch, or None
2677
if self._master_branch_cache is None:
2678
self._master_branch_cache = self._get_master_branch(
2679
possible_transports)
2680
return self._master_branch_cache
2682
def _get_master_branch(self, possible_transports):
2683
bound_loc = self.get_bound_location()
2687
return Branch.open(bound_loc,
2688
possible_transports=possible_transports)
2689
except (errors.NotBranchError, errors.ConnectionError), e:
2690
raise errors.BoundBranchConnectionFailure(
2694
def set_bound_location(self, location):
2695
"""Set the target where this branch is bound to.
2697
:param location: URL to the target branch
2699
self._master_branch_cache = None
2701
self._transport.put_bytes('bound', location+'\n',
2702
mode=self.bzrdir._get_file_mode())
2705
self._transport.delete('bound')
2706
except errors.NoSuchFile:
2711
def update(self, possible_transports=None):
2712
"""Synchronise this branch with the master branch if any.
2714
:return: None or the last_revision that was pivoted out during the
2717
master = self.get_master_branch(possible_transports)
2718
if master is not None:
2719
old_tip = _mod_revision.ensure_null(self.last_revision())
2720
self.pull(master, overwrite=True)
2721
if self.repository.get_graph().is_ancestor(old_tip,
2722
_mod_revision.ensure_null(self.last_revision())):
2727
def _read_last_revision_info(self):
2728
revision_string = self._transport.get_bytes('last-revision')
2729
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2730
revision_id = cache_utf8.get_cached_utf8(revision_id)
2732
return revno, revision_id
2734
def _write_last_revision_info(self, revno, revision_id):
2735
"""Simply write out the revision id, with no checks.
2737
Use set_last_revision_info to perform this safely.
2739
Does not update the revision_history cache.
2741
revision_id = _mod_revision.ensure_null(revision_id)
2742
out_string = '%d %s\n' % (revno, revision_id)
2743
self._transport.put_bytes('last-revision', out_string,
2744
mode=self.bzrdir._get_file_mode())
2747
def update_feature_flags(self, updated_flags):
2748
"""Update the feature flags for this branch.
2750
:param updated_flags: Dictionary mapping feature names to necessities
2751
A necessity can be None to indicate the feature should be removed
2753
self._format._update_feature_flags(updated_flags)
2754
self.control_transport.put_bytes('format', self._format.as_string())
2757
class FullHistoryBzrBranch(BzrBranch):
2758
"""Bzr branch which contains the full revision history."""
2761
def set_last_revision_info(self, revno, revision_id):
2762
if not revision_id or not isinstance(revision_id, basestring):
2763
raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2764
revision_id = _mod_revision.ensure_null(revision_id)
2765
# this old format stores the full history, but this api doesn't
2766
# provide it, so we must generate, and might as well check it's
2768
history = self._lefthand_history(revision_id)
2769
if len(history) != revno:
2770
raise AssertionError('%d != %d' % (len(history), revno))
2771
self._set_revision_history(history)
2773
def _read_last_revision_info(self):
2774
rh = self._revision_history()
2777
return (revno, rh[-1])
2779
return (0, _mod_revision.NULL_REVISION)
2781
@deprecated_method(deprecated_in((2, 4, 0)))
2783
def set_revision_history(self, rev_history):
2784
"""See Branch.set_revision_history."""
2785
self._set_revision_history(rev_history)
2787
def _set_revision_history(self, rev_history):
2788
if 'evil' in debug.debug_flags:
2789
mutter_callsite(3, "set_revision_history scales with history.")
2790
check_not_reserved_id = _mod_revision.check_not_reserved_id
2791
for rev_id in rev_history:
2792
check_not_reserved_id(rev_id)
2793
if Branch.hooks['post_change_branch_tip']:
2794
# Don't calculate the last_revision_info() if there are no hooks
2796
old_revno, old_revid = self.last_revision_info()
2797
if len(rev_history) == 0:
2798
revid = _mod_revision.NULL_REVISION
2800
revid = rev_history[-1]
2801
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2802
self._write_revision_history(rev_history)
2803
self._clear_cached_state()
2804
self._cache_revision_history(rev_history)
2805
for hook in Branch.hooks['set_rh']:
2806
hook(self, rev_history)
2807
if Branch.hooks['post_change_branch_tip']:
2808
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2810
def _write_revision_history(self, history):
2811
"""Factored out of set_revision_history.
2813
This performs the actual writing to disk.
2814
It is intended to be called by set_revision_history."""
2815
self._transport.put_bytes(
2816
'revision-history', '\n'.join(history),
2817
mode=self.bzrdir._get_file_mode())
2819
def _gen_revision_history(self):
2820
history = self._transport.get_bytes('revision-history').split('\n')
2821
if history[-1:] == ['']:
2822
# There shouldn't be a trailing newline, but just in case.
2826
def _synchronize_history(self, destination, revision_id):
2827
if not isinstance(destination, FullHistoryBzrBranch):
2828
super(BzrBranch, self)._synchronize_history(
2829
destination, revision_id)
2831
if revision_id == _mod_revision.NULL_REVISION:
2834
new_history = self._revision_history()
2835
if revision_id is not None and new_history != []:
2837
new_history = new_history[:new_history.index(revision_id) + 1]
2839
rev = self.repository.get_revision(revision_id)
2840
new_history = rev.get_history(self.repository)[1:]
2841
destination._set_revision_history(new_history)
2844
def generate_revision_history(self, revision_id, last_rev=None,
2846
"""Create a new revision history that will finish with revision_id.
2848
:param revision_id: the new tip to use.
2849
:param last_rev: The previous last_revision. If not None, then this
2850
must be a ancestory of revision_id, or DivergedBranches is raised.
2851
:param other_branch: The other branch that DivergedBranches should
2852
raise with respect to.
2854
self._set_revision_history(self._lefthand_history(revision_id,
2855
last_rev, other_branch))
2858
class BzrBranch5(FullHistoryBzrBranch):
2859
"""A format 5 branch. This supports new features over plain branches.
2861
It has support for a master_branch which is the data for bound branches.
2865
class BzrBranch8(BzrBranch):
2866
"""A branch that stores tree-reference locations."""
2868
def _open_hook(self, possible_transports=None):
2869
if self._ignore_fallbacks:
2871
if possible_transports is None:
2872
possible_transports = [self.bzrdir.root_transport]
2874
url = self.get_stacked_on_url()
2875
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2876
errors.UnstackableBranchFormat):
2879
for hook in Branch.hooks['transform_fallback_location']:
2880
url = hook(self, url)
2882
hook_name = Branch.hooks.get_hook_name(hook)
2883
raise AssertionError(
2884
"'transform_fallback_location' hook %s returned "
2885
"None, not a URL." % hook_name)
2886
self._activate_fallback_location(url,
2887
possible_transports=possible_transports)
2889
def __init__(self, *args, **kwargs):
2890
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2891
super(BzrBranch8, self).__init__(*args, **kwargs)
2892
self._last_revision_info_cache = None
2893
self._reference_info = None
2895
def _clear_cached_state(self):
2896
super(BzrBranch8, self)._clear_cached_state()
2897
self._last_revision_info_cache = None
2898
self._reference_info = None
2900
def _check_history_violation(self, revision_id):
2901
current_revid = self.last_revision()
2902
last_revision = _mod_revision.ensure_null(current_revid)
2903
if _mod_revision.is_null(last_revision):
2905
graph = self.repository.get_graph()
2906
for lh_ancestor in graph.iter_lefthand_ancestry(revision_id):
2907
if lh_ancestor == current_revid:
2909
raise errors.AppendRevisionsOnlyViolation(self.user_url)
2911
def _gen_revision_history(self):
2912
"""Generate the revision history from last revision
2914
last_revno, last_revision = self.last_revision_info()
2915
self._extend_partial_history(stop_index=last_revno-1)
2916
return list(reversed(self._partial_revision_history_cache))
2919
def _set_parent_location(self, url):
2920
"""Set the parent branch"""
2921
self._set_config_location('parent_location', url, make_relative=True)
2924
def _get_parent_location(self):
2925
"""Set the parent branch"""
2926
return self._get_config_location('parent_location')
2929
def _set_all_reference_info(self, info_dict):
2930
"""Replace all reference info stored in a branch.
2932
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2935
writer = rio.RioWriter(s)
2936
for key, (tree_path, branch_location) in info_dict.iteritems():
2937
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2938
branch_location=branch_location)
2939
writer.write_stanza(stanza)
2940
self._transport.put_bytes('references', s.getvalue())
2941
self._reference_info = info_dict
2944
def _get_all_reference_info(self):
2945
"""Return all the reference info stored in a branch.
2947
:return: A dict of {file_id: (tree_path, branch_location)}
2949
if self._reference_info is not None:
2950
return self._reference_info
2951
rio_file = self._transport.get('references')
2953
stanzas = rio.read_stanzas(rio_file)
2954
info_dict = dict((s['file_id'], (s['tree_path'],
2955
s['branch_location'])) for s in stanzas)
2958
self._reference_info = info_dict
2961
def set_reference_info(self, file_id, tree_path, branch_location):
2962
"""Set the branch location to use for a tree reference.
2964
:param file_id: The file-id of the tree reference.
2965
:param tree_path: The path of the tree reference in the tree.
2966
:param branch_location: The location of the branch to retrieve tree
2969
info_dict = self._get_all_reference_info()
2970
info_dict[file_id] = (tree_path, branch_location)
2971
if None in (tree_path, branch_location):
2972
if tree_path is not None:
2973
raise ValueError('tree_path must be None when branch_location'
2975
if branch_location is not None:
2976
raise ValueError('branch_location must be None when tree_path'
2978
del info_dict[file_id]
2979
self._set_all_reference_info(info_dict)
2981
def get_reference_info(self, file_id):
2982
"""Get the tree_path and branch_location for a tree reference.
2984
:return: a tuple of (tree_path, branch_location)
2986
return self._get_all_reference_info().get(file_id, (None, None))
2988
def reference_parent(self, file_id, path, possible_transports=None):
2989
"""Return the parent branch for a tree-reference file_id.
2991
:param file_id: The file_id of the tree reference
2992
:param path: The path of the file_id in the tree
2993
:return: A branch associated with the file_id
2995
branch_location = self.get_reference_info(file_id)[1]
2996
if branch_location is None:
2997
return Branch.reference_parent(self, file_id, path,
2998
possible_transports)
2999
branch_location = urlutils.join(self.user_url, branch_location)
3000
return Branch.open(branch_location,
3001
possible_transports=possible_transports)
3003
def set_push_location(self, location):
3004
"""See Branch.set_push_location."""
3005
self._set_config_location('push_location', location)
3007
def set_bound_location(self, location):
3008
"""See Branch.set_push_location."""
3009
self._master_branch_cache = None
3011
conf = self.get_config_stack()
3012
if location is None:
3013
if not conf.get('bound'):
3016
conf.set('bound', 'False')
3019
self._set_config_location('bound_location', location,
3021
conf.set('bound', 'True')
3024
def _get_bound_location(self, bound):
3025
"""Return the bound location in the config file.
3027
Return None if the bound parameter does not match"""
3028
conf = self.get_config_stack()
3029
if conf.get('bound') != bound:
3031
return self._get_config_location('bound_location', config=conf)
3033
def get_bound_location(self):
3034
"""See Branch.get_bound_location."""
3035
return self._get_bound_location(True)
3037
def get_old_bound_location(self):
3038
"""See Branch.get_old_bound_location"""
3039
return self._get_bound_location(False)
3041
def get_stacked_on_url(self):
3042
# you can always ask for the URL; but you might not be able to use it
3043
# if the repo can't support stacking.
3044
## self._check_stackable_repo()
3045
# stacked_on_location is only ever defined in branch.conf, so don't
3046
# waste effort reading the whole stack of config files.
3047
conf = _mod_config.BranchOnlyStack(self)
3048
stacked_url = self._get_config_location('stacked_on_location',
3050
if stacked_url is None:
3051
raise errors.NotStacked(self)
3052
return stacked_url.encode('utf-8')
3055
def get_rev_id(self, revno, history=None):
3056
"""Find the revision id of the specified revno."""
3058
return _mod_revision.NULL_REVISION
3060
last_revno, last_revision_id = self.last_revision_info()
3061
if revno <= 0 or revno > last_revno:
3062
raise errors.NoSuchRevision(self, revno)
3064
if history is not None:
3065
return history[revno - 1]
3067
index = last_revno - revno
3068
if len(self._partial_revision_history_cache) <= index:
3069
self._extend_partial_history(stop_index=index)
3070
if len(self._partial_revision_history_cache) > index:
3071
return self._partial_revision_history_cache[index]
3073
raise errors.NoSuchRevision(self, revno)
3076
def revision_id_to_revno(self, revision_id):
3077
"""Given a revision id, return its revno"""
3078
if _mod_revision.is_null(revision_id):
3081
index = self._partial_revision_history_cache.index(revision_id)
3084
self._extend_partial_history(stop_revision=revision_id)
3085
except errors.RevisionNotPresent, e:
3086
raise errors.GhostRevisionsHaveNoRevno(revision_id, e.revision_id)
3087
index = len(self._partial_revision_history_cache) - 1
3089
raise errors.NoSuchRevision(self, revision_id)
3090
if self._partial_revision_history_cache[index] != revision_id:
3091
raise errors.NoSuchRevision(self, revision_id)
3092
return self.revno() - index
3095
class BzrBranch7(BzrBranch8):
3096
"""A branch with support for a fallback repository."""
3098
def set_reference_info(self, file_id, tree_path, branch_location):
3099
Branch.set_reference_info(self, file_id, tree_path, branch_location)
3101
def get_reference_info(self, file_id):
3102
Branch.get_reference_info(self, file_id)
3104
def reference_parent(self, file_id, path, possible_transports=None):
3105
return Branch.reference_parent(self, file_id, path,
3106
possible_transports)
3109
class BzrBranch6(BzrBranch7):
3110
"""See BzrBranchFormat6 for the capabilities of this branch.
3112
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
3116
def get_stacked_on_url(self):
3117
raise errors.UnstackableBranchFormat(self._format, self.user_url)
3120
######################################################################
3121
# results of operations
3124
class _Result(object):
3126
def _show_tag_conficts(self, to_file):
3127
if not getattr(self, 'tag_conflicts', None):
3129
to_file.write('Conflicting tags:\n')
3130
for name, value1, value2 in self.tag_conflicts:
3131
to_file.write(' %s\n' % (name, ))
3134
class PullResult(_Result):
3135
"""Result of a Branch.pull operation.
3137
:ivar old_revno: Revision number before pull.
3138
:ivar new_revno: Revision number after pull.
3139
:ivar old_revid: Tip revision id before pull.
3140
:ivar new_revid: Tip revision id after pull.
3141
:ivar source_branch: Source (local) branch object. (read locked)
3142
:ivar master_branch: Master branch of the target, or the target if no
3144
:ivar local_branch: target branch if there is a Master, else None
3145
:ivar target_branch: Target/destination branch object. (write locked)
3146
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
3147
:ivar tag_updates: A dict with new tags, see BasicTags.merge_to
3150
@deprecated_method(deprecated_in((2, 3, 0)))
3152
"""Return the relative change in revno.
3154
:deprecated: Use `new_revno` and `old_revno` instead.
3156
return self.new_revno - self.old_revno
3158
def report(self, to_file):
3159
tag_conflicts = getattr(self, "tag_conflicts", None)
3160
tag_updates = getattr(self, "tag_updates", None)
3162
if self.old_revid != self.new_revid:
3163
to_file.write('Now on revision %d.\n' % self.new_revno)
3165
to_file.write('%d tag(s) updated.\n' % len(tag_updates))
3166
if self.old_revid == self.new_revid and not tag_updates:
3167
if not tag_conflicts:
3168
to_file.write('No revisions or tags to pull.\n')
3170
to_file.write('No revisions to pull.\n')
3171
self._show_tag_conficts(to_file)
3174
class BranchPushResult(_Result):
3175
"""Result of a Branch.push operation.
3177
:ivar old_revno: Revision number (eg 10) of the target before push.
3178
:ivar new_revno: Revision number (eg 12) of the target after push.
3179
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
3181
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
3183
:ivar source_branch: Source branch object that the push was from. This is
3184
read locked, and generally is a local (and thus low latency) branch.
3185
:ivar master_branch: If target is a bound branch, the master branch of
3186
target, or target itself. Always write locked.
3187
:ivar target_branch: The direct Branch where data is being sent (write
3189
:ivar local_branch: If the target is a bound branch this will be the
3190
target, otherwise it will be None.
3193
@deprecated_method(deprecated_in((2, 3, 0)))
3195
"""Return the relative change in revno.
3197
:deprecated: Use `new_revno` and `old_revno` instead.
3199
return self.new_revno - self.old_revno
3201
def report(self, to_file):
3202
# TODO: This function gets passed a to_file, but then
3203
# ignores it and calls note() instead. This is also
3204
# inconsistent with PullResult(), which writes to stdout.
3205
# -- JRV20110901, bug #838853
3206
tag_conflicts = getattr(self, "tag_conflicts", None)
3207
tag_updates = getattr(self, "tag_updates", None)
3209
if self.old_revid != self.new_revid:
3210
note(gettext('Pushed up to revision %d.') % self.new_revno)
3212
note(ngettext('%d tag updated.', '%d tags updated.', len(tag_updates)) % len(tag_updates))
3213
if self.old_revid == self.new_revid and not tag_updates:
3214
if not tag_conflicts:
3215
note(gettext('No new revisions or tags to push.'))
3217
note(gettext('No new revisions to push.'))
3218
self._show_tag_conficts(to_file)
3221
class BranchCheckResult(object):
3222
"""Results of checking branch consistency.
3227
def __init__(self, branch):
3228
self.branch = branch
3231
def report_results(self, verbose):
3232
"""Report the check results via trace.note.
3234
:param verbose: Requests more detailed display of what was checked,
3237
note(gettext('checked branch {0} format {1}').format(
3238
self.branch.user_url, self.branch._format))
3239
for error in self.errors:
3240
note(gettext('found error:%s'), error)
3243
class Converter5to6(object):
3244
"""Perform an in-place upgrade of format 5 to format 6"""
3246
def convert(self, branch):
3247
# Data for 5 and 6 can peacefully coexist.
3248
format = BzrBranchFormat6()
3249
new_branch = format.open(branch.bzrdir, _found=True)
3251
# Copy source data into target
3252
new_branch._write_last_revision_info(*branch.last_revision_info())
3253
new_branch.lock_write()
3255
new_branch.set_parent(branch.get_parent())
3256
new_branch.set_bound_location(branch.get_bound_location())
3257
new_branch.set_push_location(branch.get_push_location())
3261
# New branch has no tags by default
3262
new_branch.tags._set_tag_dict({})
3264
# Copying done; now update target format
3265
new_branch._transport.put_bytes('format',
3267
mode=new_branch.bzrdir._get_file_mode())
3269
# Clean up old files
3270
new_branch._transport.delete('revision-history')
3274
branch.set_parent(None)
3275
except errors.NoSuchFile:
3277
branch.set_bound_location(None)
3282
class Converter6to7(object):
3283
"""Perform an in-place upgrade of format 6 to format 7"""
3285
def convert(self, branch):
3286
format = BzrBranchFormat7()
3287
branch._set_config_location('stacked_on_location', '')
3288
# update target format
3289
branch._transport.put_bytes('format', format.as_string())
3292
class Converter7to8(object):
3293
"""Perform an in-place upgrade of format 7 to format 8"""
3295
def convert(self, branch):
3296
format = BzrBranchFormat8()
3297
branch._transport.put_bytes('references', '')
3298
# update target format
3299
branch._transport.put_bytes('format', format.as_string())
3302
class InterBranch(InterObject):
3303
"""This class represents operations taking place between two branches.
3305
Its instances have methods like pull() and push() and contain
3306
references to the source and target repositories these operations
3307
can be carried out on.
3311
"""The available optimised InterBranch types."""
3314
def _get_branch_formats_to_test(klass):
3315
"""Return an iterable of format tuples for testing.
3317
:return: An iterable of (from_format, to_format) to use when testing
3318
this InterBranch class. Each InterBranch class should define this
3321
raise NotImplementedError(klass._get_branch_formats_to_test)
3324
def pull(self, overwrite=False, stop_revision=None,
3325
possible_transports=None, local=False):
3326
"""Mirror source into target branch.
3328
The target branch is considered to be 'local', having low latency.
3330
:returns: PullResult instance
3332
raise NotImplementedError(self.pull)
3335
def push(self, overwrite=False, stop_revision=None, lossy=False,
3336
_override_hook_source_branch=None):
3337
"""Mirror the source branch into the target branch.
3339
The source branch is considered to be 'local', having low latency.
3341
raise NotImplementedError(self.push)
3344
def copy_content_into(self, revision_id=None):
3345
"""Copy the content of source into target
3347
revision_id: if not None, the revision history in the new branch will
3348
be truncated to end with revision_id.
3350
raise NotImplementedError(self.copy_content_into)
3353
def fetch(self, stop_revision=None, limit=None):
3356
:param stop_revision: Last revision to fetch
3357
:param limit: Optional rough limit of revisions to fetch
3359
raise NotImplementedError(self.fetch)
3362
class GenericInterBranch(InterBranch):
3363
"""InterBranch implementation that uses public Branch functions."""
3366
def is_compatible(klass, source, target):
3367
# GenericBranch uses the public API, so always compatible
3371
def _get_branch_formats_to_test(klass):
3372
return [(format_registry.get_default(), format_registry.get_default())]
3375
def unwrap_format(klass, format):
3376
if isinstance(format, remote.RemoteBranchFormat):
3377
format._ensure_real()
3378
return format._custom_format
3382
def copy_content_into(self, revision_id=None):
3383
"""Copy the content of source into target
3385
revision_id: if not None, the revision history in the new branch will
3386
be truncated to end with revision_id.
3388
self.source.update_references(self.target)
3389
self.source._synchronize_history(self.target, revision_id)
3391
parent = self.source.get_parent()
3392
except errors.InaccessibleParent, e:
3393
mutter('parent was not accessible to copy: %s', e)
3396
self.target.set_parent(parent)
3397
if self.source._push_should_merge_tags():
3398
self.source.tags.merge_to(self.target.tags)
3401
def fetch(self, stop_revision=None, limit=None):
3402
if self.target.base == self.source.base:
3404
self.source.lock_read()
3406
fetch_spec_factory = fetch.FetchSpecFactory()
3407
fetch_spec_factory.source_branch = self.source
3408
fetch_spec_factory.source_branch_stop_revision_id = stop_revision
3409
fetch_spec_factory.source_repo = self.source.repository
3410
fetch_spec_factory.target_repo = self.target.repository
3411
fetch_spec_factory.target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
3412
fetch_spec_factory.limit = limit
3413
fetch_spec = fetch_spec_factory.make_fetch_spec()
3414
return self.target.repository.fetch(self.source.repository,
3415
fetch_spec=fetch_spec)
3417
self.source.unlock()
3420
def _update_revisions(self, stop_revision=None, overwrite=False,
3422
other_revno, other_last_revision = self.source.last_revision_info()
3423
stop_revno = None # unknown
705
return len(self.revision_history())
708
def last_patch(self):
709
"""Return last patch hash, or None if no history.
711
ph = self.revision_history()
718
def missing_revisions(self, other, stop_revision=None):
720
If self and other have not diverged, return a list of the revisions
721
present in other, but missing from self.
723
>>> from bzrlib.commit import commit
724
>>> bzrlib.trace.silent = True
725
>>> br1 = ScratchBranch()
726
>>> br2 = ScratchBranch()
727
>>> br1.missing_revisions(br2)
729
>>> commit(br2, "lala!", rev_id="REVISION-ID-1")
730
>>> br1.missing_revisions(br2)
732
>>> br2.missing_revisions(br1)
734
>>> commit(br1, "lala!", rev_id="REVISION-ID-1")
735
>>> br1.missing_revisions(br2)
737
>>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
738
>>> br1.missing_revisions(br2)
740
>>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
741
>>> br1.missing_revisions(br2)
742
Traceback (most recent call last):
743
DivergedBranches: These branches have diverged.
745
self_history = self.revision_history()
746
self_len = len(self_history)
747
other_history = other.revision_history()
748
other_len = len(other_history)
749
common_index = min(self_len, other_len) -1
750
if common_index >= 0 and \
751
self_history[common_index] != other_history[common_index]:
752
raise DivergedBranches(self, other)
3424
754
if stop_revision is None:
3425
stop_revision = other_last_revision
3426
if _mod_revision.is_null(stop_revision):
3427
# if there are no commits, we're done.
3429
stop_revno = other_revno
3431
# what's the current last revision, before we fetch [and change it
3433
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3434
# we fetch here so that we don't process data twice in the common
3435
# case of having something to pull, and so that the check for
3436
# already merged can operate on the just fetched graph, which will
3437
# be cached in memory.
3438
self.fetch(stop_revision=stop_revision)
3439
# Check to see if one is an ancestor of the other
3442
graph = self.target.repository.get_graph()
3443
if self.target._check_if_descendant_or_diverged(
3444
stop_revision, last_rev, graph, self.source):
3445
# stop_revision is a descendant of last_rev, but we aren't
3446
# overwriting, so we're done.
3448
if stop_revno is None:
3450
graph = self.target.repository.get_graph()
3451
this_revno, this_last_revision = \
3452
self.target.last_revision_info()
3453
stop_revno = graph.find_distance_to_null(stop_revision,
3454
[(other_last_revision, other_revno),
3455
(this_last_revision, this_revno)])
3456
self.target.set_last_revision_info(stop_revno, stop_revision)
3459
def pull(self, overwrite=False, stop_revision=None,
3460
possible_transports=None, run_hooks=True,
3461
_override_hook_target=None, local=False):
3462
"""Pull from source into self, updating my master if any.
3464
:param run_hooks: Private parameter - if false, this branch
3465
is being called because it's the master of the primary branch,
3466
so it should not run its hooks.
3468
bound_location = self.target.get_bound_location()
3469
if local and not bound_location:
3470
raise errors.LocalRequiresBoundBranch()
3471
master_branch = None
3472
source_is_master = False
3474
# bound_location comes from a config file, some care has to be
3475
# taken to relate it to source.user_url
3476
normalized = urlutils.normalize_url(bound_location)
3478
relpath = self.source.user_transport.relpath(normalized)
3479
source_is_master = (relpath == '')
3480
except (errors.PathNotChild, errors.InvalidURL):
3481
source_is_master = False
3482
if not local and bound_location and not source_is_master:
3483
# not pulling from master, so we need to update master.
3484
master_branch = self.target.get_master_branch(possible_transports)
3485
master_branch.lock_write()
3488
# pull from source into master.
3489
master_branch.pull(self.source, overwrite, stop_revision,
3491
return self._pull(overwrite,
3492
stop_revision, _hook_master=master_branch,
3493
run_hooks=run_hooks,
3494
_override_hook_target=_override_hook_target,
3495
merge_tags_to_master=not source_is_master)
3498
master_branch.unlock()
3500
def push(self, overwrite=False, stop_revision=None, lossy=False,
3501
_override_hook_source_branch=None):
3502
"""See InterBranch.push.
3504
This is the basic concrete implementation of push()
3506
:param _override_hook_source_branch: If specified, run the hooks
3507
passing this Branch as the source, rather than self. This is for
3508
use of RemoteBranch, where push is delegated to the underlying
3512
raise errors.LossyPushToSameVCS(self.source, self.target)
3513
# TODO: Public option to disable running hooks - should be trivial but
3516
op = cleanup.OperationWithCleanups(self._push_with_bound_branches)
3517
op.add_cleanup(self.source.lock_read().unlock)
3518
op.add_cleanup(self.target.lock_write().unlock)
3519
return op.run(overwrite, stop_revision,
3520
_override_hook_source_branch=_override_hook_source_branch)
3522
def _basic_push(self, overwrite, stop_revision):
3523
"""Basic implementation of push without bound branches or hooks.
3525
Must be called with source read locked and target write locked.
3527
result = BranchPushResult()
3528
result.source_branch = self.source
3529
result.target_branch = self.target
3530
result.old_revno, result.old_revid = self.target.last_revision_info()
3531
self.source.update_references(self.target)
3532
if result.old_revid != stop_revision:
3533
# We assume that during 'push' this repository is closer than
3535
graph = self.source.repository.get_graph(self.target.repository)
3536
self._update_revisions(stop_revision, overwrite=overwrite,
3538
if self.source._push_should_merge_tags():
3539
result.tag_updates, result.tag_conflicts = (
3540
self.source.tags.merge_to(self.target.tags, overwrite))
3541
result.new_revno, result.new_revid = self.target.last_revision_info()
3544
def _push_with_bound_branches(self, operation, overwrite, stop_revision,
3545
_override_hook_source_branch=None):
3546
"""Push from source into target, and into target's master if any.
3549
if _override_hook_source_branch:
3550
result.source_branch = _override_hook_source_branch
3551
for hook in Branch.hooks['post_push']:
3554
bound_location = self.target.get_bound_location()
3555
if bound_location and self.target.base != bound_location:
3556
# there is a master branch.
3558
# XXX: Why the second check? Is it even supported for a branch to
3559
# be bound to itself? -- mbp 20070507
3560
master_branch = self.target.get_master_branch()
3561
master_branch.lock_write()
3562
operation.add_cleanup(master_branch.unlock)
3563
# push into the master from the source branch.
3564
master_inter = InterBranch.get(self.source, master_branch)
3565
master_inter._basic_push(overwrite, stop_revision)
3566
# and push into the target branch from the source. Note that
3567
# we push from the source branch again, because it's considered
3568
# the highest bandwidth repository.
3569
result = self._basic_push(overwrite, stop_revision)
3570
result.master_branch = master_branch
3571
result.local_branch = self.target
3573
master_branch = None
3575
result = self._basic_push(overwrite, stop_revision)
3576
# TODO: Why set master_branch and local_branch if there's no
3577
# binding? Maybe cleaner to just leave them unset? -- mbp
3579
result.master_branch = self.target
3580
result.local_branch = None
3584
def _pull(self, overwrite=False, stop_revision=None,
3585
possible_transports=None, _hook_master=None, run_hooks=True,
3586
_override_hook_target=None, local=False,
3587
merge_tags_to_master=True):
3590
This function is the core worker, used by GenericInterBranch.pull to
3591
avoid duplication when pulling source->master and source->local.
3593
:param _hook_master: Private parameter - set the branch to
3594
be supplied as the master to pull hooks.
3595
:param run_hooks: Private parameter - if false, this branch
3596
is being called because it's the master of the primary branch,
3597
so it should not run its hooks.
3598
is being called because it's the master of the primary branch,
3599
so it should not run its hooks.
3600
:param _override_hook_target: Private parameter - set the branch to be
3601
supplied as the target_branch to pull hooks.
3602
:param local: Only update the local branch, and not the bound branch.
3604
# This type of branch can't be bound.
3606
raise errors.LocalRequiresBoundBranch()
3607
result = PullResult()
3608
result.source_branch = self.source
3609
if _override_hook_target is None:
3610
result.target_branch = self.target
3612
result.target_branch = _override_hook_target
3613
self.source.lock_read()
3615
# We assume that during 'pull' the target repository is closer than
3617
self.source.update_references(self.target)
3618
graph = self.target.repository.get_graph(self.source.repository)
3619
# TODO: Branch formats should have a flag that indicates
3620
# that revno's are expensive, and pull() should honor that flag.
3622
result.old_revno, result.old_revid = \
3623
self.target.last_revision_info()
3624
self._update_revisions(stop_revision, overwrite=overwrite,
3626
# TODO: The old revid should be specified when merging tags,
3627
# so a tags implementation that versions tags can only
3628
# pull in the most recent changes. -- JRV20090506
3629
result.tag_updates, result.tag_conflicts = (
3630
self.source.tags.merge_to(self.target.tags, overwrite,
3631
ignore_master=not merge_tags_to_master))
3632
result.new_revno, result.new_revid = self.target.last_revision_info()
3634
result.master_branch = _hook_master
3635
result.local_branch = result.target_branch
3637
result.master_branch = result.target_branch
3638
result.local_branch = None
3640
for hook in Branch.hooks['post_pull']:
3643
self.source.unlock()
3647
InterBranch.register_optimiser(GenericInterBranch)
755
stop_revision = other_len
756
elif stop_revision > other_len:
757
raise NoSuchRevision(self, stop_revision)
759
return other_history[self_len:stop_revision]
762
def update_revisions(self, other, stop_revision=None):
763
"""Pull in all new revisions from other branch.
765
>>> from bzrlib.commit import commit
766
>>> bzrlib.trace.silent = True
767
>>> br1 = ScratchBranch(files=['foo', 'bar'])
770
>>> commit(br1, "lala!", rev_id="REVISION-ID-1", verbose=False)
771
>>> br2 = ScratchBranch()
772
>>> br2.update_revisions(br1)
776
>>> br2.revision_history()
778
>>> br2.update_revisions(br1)
782
>>> br1.text_store.total_size() == br2.text_store.total_size()
785
from bzrlib.progress import ProgressBar
789
from sets import Set as set
793
pb.update('comparing histories')
794
revision_ids = self.missing_revisions(other, stop_revision)
796
if hasattr(other.revision_store, "prefetch"):
797
other.revision_store.prefetch(revision_ids)
798
if hasattr(other.inventory_store, "prefetch"):
799
inventory_ids = [other.get_revision(r).inventory_id
800
for r in revision_ids]
801
other.inventory_store.prefetch(inventory_ids)
806
for rev_id in revision_ids:
808
pb.update('fetching revision', i, len(revision_ids))
809
rev = other.get_revision(rev_id)
810
revisions.append(rev)
811
inv = other.get_inventory(str(rev.inventory_id))
812
for key, entry in inv.iter_entries():
813
if entry.text_id is None:
815
if entry.text_id not in self.text_store:
816
needed_texts.add(entry.text_id)
820
count = self.text_store.copy_multi(other.text_store, needed_texts)
821
print "Added %d texts." % count
822
inventory_ids = [ f.inventory_id for f in revisions ]
823
count = self.inventory_store.copy_multi(other.inventory_store,
825
print "Added %d inventories." % count
826
revision_ids = [ f.revision_id for f in revisions]
827
count = self.revision_store.copy_multi(other.revision_store,
829
for revision_id in revision_ids:
830
self.append_revision(revision_id)
831
print "Added %d revisions." % count
834
def commit(self, *args, **kw):
835
from bzrlib.commit import commit
836
commit(self, *args, **kw)
839
def lookup_revision(self, revno):
840
"""Return revision hash for revision number."""
845
# list is 0-based; revisions are 1-based
846
return self.revision_history()[revno-1]
848
raise BzrError("no such revision %s" % revno)
851
def revision_tree(self, revision_id):
852
"""Return Tree for a revision on this branch.
854
`revision_id` may be None for the null revision, in which case
855
an `EmptyTree` is returned."""
856
from bzrlib.tree import EmptyTree, RevisionTree
857
# TODO: refactor this to use an existing revision object
858
# so we don't need to read it in twice.
859
if revision_id == None:
862
inv = self.get_revision_inventory(revision_id)
863
return RevisionTree(self.text_store, inv)
866
def working_tree(self):
867
"""Return a `Tree` for the working copy."""
868
from workingtree import WorkingTree
869
return WorkingTree(self.base, self.read_working_inventory())
872
def basis_tree(self):
873
"""Return `Tree` object for last revision.
875
If there are no revisions yet, return an `EmptyTree`.
877
from bzrlib.tree import EmptyTree, RevisionTree
878
r = self.last_patch()
882
return RevisionTree(self.text_store, self.get_revision_inventory(r))
886
def rename_one(self, from_rel, to_rel):
889
This can change the directory or the filename or both.
893
tree = self.working_tree()
895
if not tree.has_filename(from_rel):
896
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
897
if tree.has_filename(to_rel):
898
raise BzrError("can't rename: new working file %r already exists" % to_rel)
900
file_id = inv.path2id(from_rel)
902
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
904
if inv.path2id(to_rel):
905
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
907
to_dir, to_tail = os.path.split(to_rel)
908
to_dir_id = inv.path2id(to_dir)
909
if to_dir_id == None and to_dir != '':
910
raise BzrError("can't determine destination directory id for %r" % to_dir)
912
mutter("rename_one:")
913
mutter(" file_id {%s}" % file_id)
914
mutter(" from_rel %r" % from_rel)
915
mutter(" to_rel %r" % to_rel)
916
mutter(" to_dir %r" % to_dir)
917
mutter(" to_dir_id {%s}" % to_dir_id)
919
inv.rename(file_id, to_dir_id, to_tail)
921
print "%s => %s" % (from_rel, to_rel)
923
from_abs = self.abspath(from_rel)
924
to_abs = self.abspath(to_rel)
926
os.rename(from_abs, to_abs)
928
raise BzrError("failed to rename %r to %r: %s"
929
% (from_abs, to_abs, e[1]),
930
["rename rolled back"])
932
self._write_inventory(inv)
937
def move(self, from_paths, to_name):
940
to_name must exist as a versioned directory.
942
If to_name exists and is a directory, the files are moved into
943
it, keeping their old names. If it is a directory,
945
Note that to_name is only the last component of the new name;
946
this doesn't change the directory.
950
## TODO: Option to move IDs only
951
assert not isinstance(from_paths, basestring)
952
tree = self.working_tree()
954
to_abs = self.abspath(to_name)
955
if not isdir(to_abs):
956
raise BzrError("destination %r is not a directory" % to_abs)
957
if not tree.has_filename(to_name):
958
raise BzrError("destination %r not in working directory" % to_abs)
959
to_dir_id = inv.path2id(to_name)
960
if to_dir_id == None and to_name != '':
961
raise BzrError("destination %r is not a versioned directory" % to_name)
962
to_dir_ie = inv[to_dir_id]
963
if to_dir_ie.kind not in ('directory', 'root_directory'):
964
raise BzrError("destination %r is not a directory" % to_abs)
966
to_idpath = inv.get_idpath(to_dir_id)
969
if not tree.has_filename(f):
970
raise BzrError("%r does not exist in working tree" % f)
971
f_id = inv.path2id(f)
973
raise BzrError("%r is not versioned" % f)
974
name_tail = splitpath(f)[-1]
975
dest_path = appendpath(to_name, name_tail)
976
if tree.has_filename(dest_path):
977
raise BzrError("destination %r already exists" % dest_path)
978
if f_id in to_idpath:
979
raise BzrError("can't move %r to a subdirectory of itself" % f)
981
# OK, so there's a race here, it's possible that someone will
982
# create a file in this interval and then the rename might be
983
# left half-done. But we should have caught most problems.
986
name_tail = splitpath(f)[-1]
987
dest_path = appendpath(to_name, name_tail)
988
print "%s => %s" % (f, dest_path)
989
inv.rename(inv.path2id(f), to_dir_id, name_tail)
991
os.rename(self.abspath(f), self.abspath(dest_path))
993
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
994
["rename rolled back"])
996
self._write_inventory(inv)
1001
def revert(self, filenames, old_tree=None, backups=True):
1002
"""Restore selected files to the versions from a previous tree.
1005
If true (default) backups are made of files before
1008
from bzrlib.errors import NotVersionedError, BzrError
1009
from bzrlib.atomicfile import AtomicFile
1010
from bzrlib.osutils import backup_file
1012
inv = self.read_working_inventory()
1013
if old_tree is None:
1014
old_tree = self.basis_tree()
1015
old_inv = old_tree.inventory
1018
for fn in filenames:
1019
file_id = inv.path2id(fn)
1021
raise NotVersionedError("not a versioned file", fn)
1022
if not old_inv.has_id(file_id):
1023
raise BzrError("file not present in old tree", fn, file_id)
1024
nids.append((fn, file_id))
1026
# TODO: Rename back if it was previously at a different location
1028
# TODO: If given a directory, restore the entire contents from
1029
# the previous version.
1031
# TODO: Make a backup to a temporary file.
1033
# TODO: If the file previously didn't exist, delete it?
1034
for fn, file_id in nids:
1037
f = AtomicFile(fn, 'wb')
1039
f.write(old_tree.get_file(file_id).read())
1045
def pending_merges(self):
1046
"""Return a list of pending merges.
1048
These are revisions that have been merged into the working
1049
directory but not yet committed.
1051
cfn = self.controlfilename('pending-merges')
1052
if not os.path.exists(cfn):
1055
for l in self.controlfile('pending-merges', 'r').readlines():
1056
p.append(l.rstrip('\n'))
1060
def add_pending_merge(self, revision_id):
1061
from bzrlib.revision import validate_revision_id
1063
validate_revision_id(revision_id)
1065
p = self.pending_merges()
1066
if revision_id in p:
1068
p.append(revision_id)
1069
self.set_pending_merges(p)
1072
def set_pending_merges(self, rev_list):
1073
from bzrlib.atomicfile import AtomicFile
1076
f = AtomicFile(self.controlfilename('pending-merges'))
1088
class ScratchBranch(Branch):
1089
"""Special test class: a branch that cleans up after itself.
1091
>>> b = ScratchBranch()
1099
def __init__(self, files=[], dirs=[], base=None):
1100
"""Make a test branch.
1102
This creates a temporary directory and runs init-tree in it.
1104
If any files are listed, they are created in the working copy.
1106
from tempfile import mkdtemp
1111
Branch.__init__(self, base, init=init)
1113
os.mkdir(self.abspath(d))
1116
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
1121
>>> orig = ScratchBranch(files=["file1", "file2"])
1122
>>> clone = orig.clone()
1123
>>> os.path.samefile(orig.base, clone.base)
1125
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1128
from shutil import copytree
1129
from tempfile import mkdtemp
1132
copytree(self.base, base, symlinks=True)
1133
return ScratchBranch(base=base)
1139
"""Destroy the test branch, removing the scratch directory."""
1140
from shutil import rmtree
1143
mutter("delete ScratchBranch %s" % self.base)
1146
# Work around for shutil.rmtree failing on Windows when
1147
# readonly files are encountered
1148
mutter("hit exception in destroying ScratchBranch: %s" % e)
1149
for root, dirs, files in os.walk(self.base, topdown=False):
1151
os.chmod(os.path.join(root, name), 0700)
1157
######################################################################
1161
def is_control_file(filename):
1162
## FIXME: better check
1163
filename = os.path.normpath(filename)
1164
while filename != '':
1165
head, tail = os.path.split(filename)
1166
## mutter('check %r for control file' % ((head, tail), ))
1167
if tail == bzrlib.BZRDIR:
1169
if filename == head:
1176
def gen_file_id(name):
1177
"""Return new file id.
1179
This should probably generate proper UUIDs, but for the moment we
1180
cope with just randomness because running uuidgen every time is
1183
from binascii import hexlify
1184
from time import time
1186
# get last component
1187
idx = name.rfind('/')
1189
name = name[idx+1 : ]
1190
idx = name.rfind('\\')
1192
name = name[idx+1 : ]
1194
# make it not a hidden file
1195
name = name.lstrip('.')
1197
# remove any wierd characters; we don't escape them but rather
1198
# just pull them out
1199
name = re.sub(r'[^\w.]', '', name)
1201
s = hexlify(rand_bytes(8))
1202
return '-'.join((name, compact_date(time()), s))
added
removed
bzrlib/branch.py
