1
# Copyright (C) 2005-2010 Canonical Ltd
1
# Copyright (C) 2005 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22
from warnings import warn
18
23
from cStringIO import StringIO
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
23
from itertools import chain
27
config as _mod_config,
33
revision as _mod_revision,
41
from bzrlib.config import BranchConfig, TransportConfig
42
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
43
from bzrlib.tag import (
49
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
50
from bzrlib.hooks import HookPoint, Hooks
51
from bzrlib.inter import InterObject
52
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
53
from bzrlib import registry
54
from bzrlib.symbol_versioning import (
58
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
27
import bzrlib.inventory as inventory
28
from bzrlib.trace import mutter, note
29
from bzrlib.osutils import (isdir, quotefn,
30
rename, splitpath, sha_file, appendpath,
32
import bzrlib.errors as errors
33
from bzrlib.errors import (BzrError, InvalidRevisionNumber, InvalidRevisionId,
34
NoSuchRevision, HistoryMissing, NotBranchError,
35
DivergedBranches, LockError, UnlistableStore,
36
UnlistableBranch, NoSuchFile, NotVersionedError,
38
from bzrlib.textui import show_status
39
from bzrlib.revision import (Revision, is_ancestor, get_intervening_revisions,
42
from bzrlib.delta import compare_trees
43
from bzrlib.tree import EmptyTree, RevisionTree
44
from bzrlib.inventory import Inventory
45
from bzrlib.store import copy_all
46
from bzrlib.store.text import TextStore
47
from bzrlib.store.weave import WeaveStore
48
from bzrlib.testament import Testament
49
import bzrlib.transactions as transactions
50
from bzrlib.transport import Transport, get_transport
53
from config import TreeConfig
61
56
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
62
57
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
63
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
66
class Branch(bzrdir.ControlComponent):
58
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
59
## TODO: Maybe include checks for common corruption of newlines, etc?
62
# TODO: Some operations like log might retrieve the same revisions
63
# repeatedly to calculate deltas. We could perhaps have a weakref
64
# cache in memory to make this faster. In general anything can be
65
# cached in memory between lock and unlock operations.
67
def find_branch(*ignored, **ignored_too):
68
# XXX: leave this here for about one release, then remove it
69
raise NotImplementedError('find_branch() is not supported anymore, '
70
'please use one of the new branch constructors')
73
def needs_read_lock(unbound):
74
"""Decorate unbound to take out and release a read lock."""
75
def decorated(self, *args, **kwargs):
78
return unbound(self, *args, **kwargs)
84
def needs_write_lock(unbound):
85
"""Decorate unbound to take out and release a write lock."""
86
def decorated(self, *args, **kwargs):
89
return unbound(self, *args, **kwargs)
94
######################################################################
67
98
"""Branch holding a history of revisions.
70
Base directory/url of the branch; using control_url and
71
control_transport is more standardized.
73
hooks: An instance of BranchHooks.
101
Base directory/url of the branch.
75
# this is really an instance variable - FIXME move it there
80
def control_transport(self):
81
return self._transport
84
def user_transport(self):
85
return self.bzrdir.user_transport
87
105
def __init__(self, *ignored, **ignored_too):
88
self.tags = self._format.make_tags(self)
89
self._revision_history_cache = None
90
self._revision_id_to_revno_cache = None
91
self._partial_revision_id_to_revno_cache = {}
92
self._partial_revision_history_cache = []
93
self._last_revision_info_cache = None
94
self._merge_sorted_revisions_cache = None
96
hooks = Branch.hooks['open']
100
def _open_hook(self):
101
"""Called by init to allow simpler extension of the base class."""
103
def _activate_fallback_location(self, url):
104
"""Activate the branch/repository from url as a fallback repository."""
105
repo = self._get_fallback_repository(url)
106
if repo.has_same_location(self.repository):
107
raise errors.UnstackableLocationError(self.user_url, url)
108
self.repository.add_fallback_repository(repo)
110
def break_lock(self):
111
"""Break a lock if one is present from another instance.
113
Uses the ui factory to ask for confirmation if the lock may be from
116
This will probe the repository for its lock as well.
118
self.control_files.break_lock()
119
self.repository.break_lock()
120
master = self.get_master_branch()
121
if master is not None:
124
def _check_stackable_repo(self):
125
if not self.repository._format.supports_external_lookups:
126
raise errors.UnstackableRepositoryFormat(self.repository._format,
127
self.repository.base)
129
def _extend_partial_history(self, stop_index=None, stop_revision=None):
130
"""Extend the partial history to include a given index
132
If a stop_index is supplied, stop when that index has been reached.
133
If a stop_revision is supplied, stop when that revision is
134
encountered. Otherwise, stop when the beginning of history is
137
:param stop_index: The index which should be present. When it is
138
present, history extension will stop.
139
:param stop_revision: The revision id which should be present. When
140
it is encountered, history extension will stop.
142
if len(self._partial_revision_history_cache) == 0:
143
self._partial_revision_history_cache = [self.last_revision()]
144
repository._iter_for_revno(
145
self.repository, self._partial_revision_history_cache,
146
stop_index=stop_index, stop_revision=stop_revision)
147
if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
148
self._partial_revision_history_cache.pop()
150
def _get_check_refs(self):
151
"""Get the references needed for check().
155
revid = self.last_revision()
156
return [('revision-existence', revid), ('lefthand-distance', revid)]
159
def open(base, _unsupported=False, possible_transports=None):
160
"""Open the branch rooted at base.
162
For instance, if the branch is at URL/.bzr/branch,
163
Branch.open(URL) -> a Branch instance.
165
control = bzrdir.BzrDir.open(base, _unsupported,
166
possible_transports=possible_transports)
167
return control.open_branch(unsupported=_unsupported)
170
def open_from_transport(transport, name=None, _unsupported=False):
171
"""Open the branch rooted at transport"""
172
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
173
return control.open_branch(name=name, unsupported=_unsupported)
176
def open_containing(url, possible_transports=None):
106
raise NotImplementedError('The Branch class is abstract')
109
def open_downlevel(base):
110
"""Open a branch which may be of an old format.
112
Only local branches are supported."""
113
return BzrBranch(get_transport(base), relax_version_check=True)
117
"""Open an existing branch, rooted at 'base' (url)"""
118
t = get_transport(base)
119
mutter("trying to open %r with transport %r", base, t)
123
def open_containing(url):
177
124
"""Open an existing branch which contains url.
179
126
This probes for a branch at url, and searches upwards from there.
181
128
Basically we keep looking up until we find the control directory or
182
129
run into the root. If there isn't one, raises NotBranchError.
183
If there is one and it is either an unrecognised format or an unsupported
184
format, UnknownFormatError or UnsupportedFormatError are raised.
185
130
If there is one, it is returned, along with the unused portion of url.
187
control, relpath = bzrdir.BzrDir.open_containing(url,
189
return control.open_branch(), relpath
191
def _push_should_merge_tags(self):
192
"""Should _basic_push merge this branch's tags into the target?
194
The default implementation returns False if this branch has no tags,
195
and True the rest of the time. Subclasses may override this.
197
return self.supports_tags() and self.tags.get_tag_dict()
199
def get_config(self):
200
return BranchConfig(self)
202
def _get_config(self):
203
"""Get the concrete config for just the config in this branch.
205
This is not intended for client use; see Branch.get_config for the
210
:return: An object supporting get_option and set_option.
212
raise NotImplementedError(self._get_config)
214
def _get_fallback_repository(self, url):
215
"""Get the repository we fallback to at url."""
216
url = urlutils.join(self.base, url)
217
a_branch = Branch.open(url,
218
possible_transports=[self.bzrdir.root_transport])
219
return a_branch.repository
221
def _get_tags_bytes(self):
222
"""Get the bytes of a serialised tags dict.
224
Note that not all branches support tags, nor do all use the same tags
225
logic: this method is specific to BasicTags. Other tag implementations
226
may use the same method name and behave differently, safely, because
227
of the double-dispatch via
228
format.make_tags->tags_instance->get_tags_dict.
230
:return: The bytes of the tags file.
231
:seealso: Branch._set_tags_bytes.
233
return self._transport.get_bytes('tags')
235
def _get_nick(self, local=False, possible_transports=None):
236
config = self.get_config()
237
# explicit overrides master, but don't look for master if local is True
238
if not local and not config.has_explicit_nickname():
132
t = get_transport(url)
240
master = self.get_master_branch(possible_transports)
241
if master is not None:
242
# return the master branch value
244
except errors.BzrError, e:
245
# Silently fall back to local implicit nick if the master is
247
mutter("Could not connect to bound branch, "
248
"falling back to local nick.\n " + str(e))
249
return config.get_nickname()
135
return BzrBranch(t), t.relpath(url)
136
except NotBranchError:
138
new_t = t.clone('..')
139
if new_t.base == t.base:
140
# reached the root, whatever that may be
141
raise NotBranchError(path=url)
145
def initialize(base):
146
"""Create a new branch, rooted at 'base' (url)"""
147
t = get_transport(base)
148
return BzrBranch(t, init=True)
150
def setup_caching(self, cache_root):
151
"""Subclasses that care about caching should override this, and set
152
up cached stores located under cache_root.
154
self.cache_root = cache_root
157
cfg = self.tree_config()
158
return cfg.get_option(u"nickname", default=self.base.split('/')[-1])
251
160
def _set_nick(self, nick):
252
self.get_config().set_user_option('nickname', nick, warn_masked=True)
161
cfg = self.tree_config()
162
cfg.set_option(nick, "nickname")
163
assert cfg.get_option("nickname") == nick
254
165
nick = property(_get_nick, _set_nick)
257
raise NotImplementedError(self.is_locked)
259
def _lefthand_history(self, revision_id, last_rev=None,
261
if 'evil' in debug.debug_flags:
262
mutter_callsite(4, "_lefthand_history scales with history.")
263
# stop_revision must be a descendant of last_revision
264
graph = self.repository.get_graph()
265
if last_rev is not None:
266
if not graph.is_ancestor(last_rev, revision_id):
267
# our previous tip is not merged into stop_revision
268
raise errors.DivergedBranches(self, other_branch)
269
# make a new revision history from the graph
270
parents_map = graph.get_parent_map([revision_id])
271
if revision_id not in parents_map:
272
raise errors.NoSuchRevision(self, revision_id)
273
current_rev_id = revision_id
275
check_not_reserved_id = _mod_revision.check_not_reserved_id
276
# Do not include ghosts or graph origin in revision_history
277
while (current_rev_id in parents_map and
278
len(parents_map[current_rev_id]) > 0):
279
check_not_reserved_id(current_rev_id)
280
new_history.append(current_rev_id)
281
current_rev_id = parents_map[current_rev_id][0]
282
parents_map = graph.get_parent_map([current_rev_id])
283
new_history.reverse()
286
def lock_write(self, token=None):
287
"""Lock the branch for write operations.
289
:param token: A token to permit reacquiring a previously held and
291
:return: A BranchWriteLockResult.
167
def push_stores(self, branch_to):
168
"""Copy the content of this branches store to branch_to."""
169
raise NotImplementedError('push_stores is abstract')
171
def get_transaction(self):
172
"""Return the current active transaction.
174
If no transaction is active, this returns a passthrough object
175
for which all data is immediately flushed and no caching happens.
293
raise NotImplementedError(self.lock_write)
177
raise NotImplementedError('get_transaction is abstract')
179
def lock_write(self):
180
raise NotImplementedError('lock_write is abstract')
295
182
def lock_read(self):
296
"""Lock the branch for read operations.
298
:return: A bzrlib.lock.LogicalLockResult.
300
raise NotImplementedError(self.lock_read)
183
raise NotImplementedError('lock_read is abstract')
302
185
def unlock(self):
303
raise NotImplementedError(self.unlock)
305
def peek_lock_mode(self):
306
"""Return lock mode for the Branch: 'r', 'w' or None"""
307
raise NotImplementedError(self.peek_lock_mode)
309
def get_physical_lock_status(self):
310
raise NotImplementedError(self.get_physical_lock_status)
313
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
314
"""Return the revision_id for a dotted revno.
316
:param revno: a tuple like (1,) or (1,1,2)
317
:param _cache_reverse: a private parameter enabling storage
318
of the reverse mapping in a top level cache. (This should
319
only be done in selective circumstances as we want to
320
avoid having the mapping cached multiple times.)
321
:return: the revision_id
322
:raises errors.NoSuchRevision: if the revno doesn't exist
324
rev_id = self._do_dotted_revno_to_revision_id(revno)
326
self._partial_revision_id_to_revno_cache[rev_id] = revno
329
def _do_dotted_revno_to_revision_id(self, revno):
330
"""Worker function for dotted_revno_to_revision_id.
332
Subclasses should override this if they wish to
333
provide a more efficient implementation.
336
return self.get_rev_id(revno[0])
337
revision_id_to_revno = self.get_revision_id_to_revno_map()
338
revision_ids = [revision_id for revision_id, this_revno
339
in revision_id_to_revno.iteritems()
340
if revno == this_revno]
341
if len(revision_ids) == 1:
342
return revision_ids[0]
344
revno_str = '.'.join(map(str, revno))
345
raise errors.NoSuchRevision(self, revno_str)
348
def revision_id_to_dotted_revno(self, revision_id):
349
"""Given a revision id, return its dotted revno.
351
:return: a tuple like (1,) or (400,1,3).
353
return self._do_revision_id_to_dotted_revno(revision_id)
355
def _do_revision_id_to_dotted_revno(self, revision_id):
356
"""Worker function for revision_id_to_revno."""
357
# Try the caches if they are loaded
358
result = self._partial_revision_id_to_revno_cache.get(revision_id)
359
if result is not None:
361
if self._revision_id_to_revno_cache:
362
result = self._revision_id_to_revno_cache.get(revision_id)
364
raise errors.NoSuchRevision(self, revision_id)
365
# Try the mainline as it's optimised
367
revno = self.revision_id_to_revno(revision_id)
369
except errors.NoSuchRevision:
370
# We need to load and use the full revno map after all
371
result = self.get_revision_id_to_revno_map().get(revision_id)
373
raise errors.NoSuchRevision(self, revision_id)
377
def get_revision_id_to_revno_map(self):
378
"""Return the revision_id => dotted revno map.
380
This will be regenerated on demand, but will be cached.
382
:return: A dictionary mapping revision_id => dotted revno.
383
This dictionary should not be modified by the caller.
385
if self._revision_id_to_revno_cache is not None:
386
mapping = self._revision_id_to_revno_cache
388
mapping = self._gen_revno_map()
389
self._cache_revision_id_to_revno(mapping)
390
# TODO: jam 20070417 Since this is being cached, should we be returning
392
# I would rather not, and instead just declare that users should not
393
# modify the return value.
396
def _gen_revno_map(self):
397
"""Create a new mapping from revision ids to dotted revnos.
399
Dotted revnos are generated based on the current tip in the revision
401
This is the worker function for get_revision_id_to_revno_map, which
402
just caches the return value.
404
:return: A dictionary mapping revision_id => dotted revno.
406
revision_id_to_revno = dict((rev_id, revno)
407
for rev_id, depth, revno, end_of_merge
408
in self.iter_merge_sorted_revisions())
409
return revision_id_to_revno
412
def iter_merge_sorted_revisions(self, start_revision_id=None,
413
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
414
"""Walk the revisions for a branch in merge sorted order.
416
Merge sorted order is the output from a merge-aware,
417
topological sort, i.e. all parents come before their
418
children going forward; the opposite for reverse.
420
:param start_revision_id: the revision_id to begin walking from.
421
If None, the branch tip is used.
422
:param stop_revision_id: the revision_id to terminate the walk
423
after. If None, the rest of history is included.
424
:param stop_rule: if stop_revision_id is not None, the precise rule
425
to use for termination:
426
* 'exclude' - leave the stop revision out of the result (default)
427
* 'include' - the stop revision is the last item in the result
428
* 'with-merges' - include the stop revision and all of its
429
merged revisions in the result
430
* 'with-merges-without-common-ancestry' - filter out revisions
431
that are in both ancestries
432
:param direction: either 'reverse' or 'forward':
433
* reverse means return the start_revision_id first, i.e.
434
start at the most recent revision and go backwards in history
435
* forward returns tuples in the opposite order to reverse.
436
Note in particular that forward does *not* do any intelligent
437
ordering w.r.t. depth as some clients of this API may like.
438
(If required, that ought to be done at higher layers.)
440
:return: an iterator over (revision_id, depth, revno, end_of_merge)
443
* revision_id: the unique id of the revision
444
* depth: How many levels of merging deep this node has been
446
* revno_sequence: This field provides a sequence of
447
revision numbers for all revisions. The format is:
448
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
449
branch that the revno is on. From left to right the REVNO numbers
450
are the sequence numbers within that branch of the revision.
451
* end_of_merge: When True the next node (earlier in history) is
452
part of a different merge.
454
# Note: depth and revno values are in the context of the branch so
455
# we need the full graph to get stable numbers, regardless of the
457
if self._merge_sorted_revisions_cache is None:
458
last_revision = self.last_revision()
459
known_graph = self.repository.get_known_graph_ancestry(
461
self._merge_sorted_revisions_cache = known_graph.merge_sort(
463
filtered = self._filter_merge_sorted_revisions(
464
self._merge_sorted_revisions_cache, start_revision_id,
465
stop_revision_id, stop_rule)
466
# Make sure we don't return revisions that are not part of the
467
# start_revision_id ancestry.
468
filtered = self._filter_start_non_ancestors(filtered)
469
if direction == 'reverse':
471
if direction == 'forward':
472
return reversed(list(filtered))
474
raise ValueError('invalid direction %r' % direction)
476
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
477
start_revision_id, stop_revision_id, stop_rule):
478
"""Iterate over an inclusive range of sorted revisions."""
479
rev_iter = iter(merge_sorted_revisions)
480
if start_revision_id is not None:
481
for node in rev_iter:
482
rev_id = node.key[-1]
483
if rev_id != start_revision_id:
486
# The decision to include the start or not
487
# depends on the stop_rule if a stop is provided
488
# so pop this node back into the iterator
489
rev_iter = chain(iter([node]), rev_iter)
491
if stop_revision_id is None:
493
for node in rev_iter:
494
rev_id = node.key[-1]
495
yield (rev_id, node.merge_depth, node.revno,
497
elif stop_rule == 'exclude':
498
for node in rev_iter:
499
rev_id = node.key[-1]
500
if rev_id == stop_revision_id:
502
yield (rev_id, node.merge_depth, node.revno,
504
elif stop_rule == 'include':
505
for node in rev_iter:
506
rev_id = node.key[-1]
507
yield (rev_id, node.merge_depth, node.revno,
509
if rev_id == stop_revision_id:
511
elif stop_rule == 'with-merges-without-common-ancestry':
512
# We want to exclude all revisions that are already part of the
513
# stop_revision_id ancestry.
514
graph = self.repository.get_graph()
515
ancestors = graph.find_unique_ancestors(start_revision_id,
517
for node in rev_iter:
518
rev_id = node.key[-1]
519
if rev_id not in ancestors:
521
yield (rev_id, node.merge_depth, node.revno,
523
elif stop_rule == 'with-merges':
524
stop_rev = self.repository.get_revision(stop_revision_id)
525
if stop_rev.parent_ids:
526
left_parent = stop_rev.parent_ids[0]
528
left_parent = _mod_revision.NULL_REVISION
529
# left_parent is the actual revision we want to stop logging at,
530
# since we want to show the merged revisions after the stop_rev too
531
reached_stop_revision_id = False
532
revision_id_whitelist = []
533
for node in rev_iter:
534
rev_id = node.key[-1]
535
if rev_id == left_parent:
536
# reached the left parent after the stop_revision
538
if (not reached_stop_revision_id or
539
rev_id in revision_id_whitelist):
540
yield (rev_id, node.merge_depth, node.revno,
542
if reached_stop_revision_id or rev_id == stop_revision_id:
543
# only do the merged revs of rev_id from now on
544
rev = self.repository.get_revision(rev_id)
546
reached_stop_revision_id = True
547
revision_id_whitelist.extend(rev.parent_ids)
549
raise ValueError('invalid stop_rule %r' % stop_rule)
551
def _filter_start_non_ancestors(self, rev_iter):
552
# If we started from a dotted revno, we want to consider it as a tip
553
# and don't want to yield revisions that are not part of its
554
# ancestry. Given the order guaranteed by the merge sort, we will see
555
# uninteresting descendants of the first parent of our tip before the
557
first = rev_iter.next()
558
(rev_id, merge_depth, revno, end_of_merge) = first
561
# We start at a mainline revision so by definition, all others
562
# revisions in rev_iter are ancestors
563
for node in rev_iter:
568
pmap = self.repository.get_parent_map([rev_id])
569
parents = pmap.get(rev_id, [])
571
whitelist.update(parents)
573
# If there is no parents, there is nothing of interest left
575
# FIXME: It's hard to test this scenario here as this code is never
576
# called in that case. -- vila 20100322
579
for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
581
if rev_id in whitelist:
582
pmap = self.repository.get_parent_map([rev_id])
583
parents = pmap.get(rev_id, [])
584
whitelist.remove(rev_id)
585
whitelist.update(parents)
587
# We've reached the mainline, there is nothing left to
591
# A revision that is not part of the ancestry of our
594
yield (rev_id, merge_depth, revno, end_of_merge)
596
def leave_lock_in_place(self):
597
"""Tell this branch object not to release the physical lock when this
600
If lock_write doesn't return a token, then this method is not supported.
602
self.control_files.leave_in_place()
604
def dont_leave_lock_in_place(self):
605
"""Tell this branch object to release the physical lock when this
606
object is unlocked, even if it didn't originally acquire it.
608
If lock_write doesn't return a token, then this method is not supported.
610
self.control_files.dont_leave_in_place()
612
def bind(self, other):
613
"""Bind the local branch the other branch.
615
:param other: The branch to bind to
618
raise errors.UpgradeRequired(self.user_url)
620
def set_append_revisions_only(self, enabled):
621
if not self._format.supports_set_append_revisions_only():
622
raise errors.UpgradeRequired(self.user_url)
627
self.get_config().set_user_option('append_revisions_only', value,
630
def set_reference_info(self, file_id, tree_path, branch_location):
631
"""Set the branch location to use for a tree reference."""
632
raise errors.UnsupportedOperation(self.set_reference_info, self)
634
def get_reference_info(self, file_id):
635
"""Get the tree_path and branch_location for a tree reference."""
636
raise errors.UnsupportedOperation(self.get_reference_info, self)
639
def fetch(self, from_branch, last_revision=None, pb=None):
640
"""Copy revisions from from_branch into this branch.
642
:param from_branch: Where to copy from.
643
:param last_revision: What revision to stop at (None for at the end
645
:param pb: An optional progress bar to use.
648
if self.base == from_branch.base:
651
symbol_versioning.warn(
652
symbol_versioning.deprecated_in((1, 14, 0))
653
% "pb parameter to fetch()")
654
from_branch.lock_read()
656
if last_revision is None:
657
last_revision = from_branch.last_revision()
658
last_revision = _mod_revision.ensure_null(last_revision)
659
return self.repository.fetch(from_branch.repository,
660
revision_id=last_revision,
665
def get_bound_location(self):
666
"""Return the URL of the branch we are bound to.
668
Older format branches cannot bind, please be sure to use a metadir
673
def get_old_bound_location(self):
674
"""Return the URL of the branch we used to be bound to
676
raise errors.UpgradeRequired(self.user_url)
678
def get_commit_builder(self, parents, config=None, timestamp=None,
679
timezone=None, committer=None, revprops=None,
681
"""Obtain a CommitBuilder for this branch.
683
:param parents: Revision ids of the parents of the new revision.
684
:param config: Optional configuration to use.
685
:param timestamp: Optional timestamp recorded for commit.
686
:param timezone: Optional timezone for timestamp.
687
:param committer: Optional committer to set for commit.
688
:param revprops: Optional dictionary of revision properties.
689
:param revision_id: Optional revision id.
693
config = self.get_config()
695
return self.repository.get_commit_builder(self, parents, config,
696
timestamp, timezone, committer, revprops, revision_id)
698
def get_master_branch(self, possible_transports=None):
699
"""Return the branch we are bound to.
701
:return: Either a Branch, or None
186
raise NotImplementedError('unlock is abstract')
188
def abspath(self, name):
189
"""Return absolute filename for something in the branch
191
XXX: Robert Collins 20051017 what is this used for? why is it a branch
192
method and not a tree method.
194
raise NotImplementedError('abspath is abstract')
196
def controlfilename(self, file_or_path):
197
"""Return location relative to branch."""
198
raise NotImplementedError('controlfilename is abstract')
200
def controlfile(self, file_or_path, mode='r'):
201
"""Open a control file for this branch.
203
There are two classes of file in the control directory: text
204
and binary. binary files are untranslated byte streams. Text
205
control files are stored with Unix newlines and in UTF-8, even
206
if the platform or locale defaults are different.
208
Controlfiles should almost never be opened in write mode but
209
rather should be atomically copied and replaced using atomicfile.
211
raise NotImplementedError('controlfile is abstract')
213
def put_controlfile(self, path, f, encode=True):
214
"""Write an entry as a controlfile.
216
:param path: The path to put the file, relative to the .bzr control
218
:param f: A file-like or string object whose contents should be copied.
219
:param encode: If true, encode the contents as utf-8
221
raise NotImplementedError('put_controlfile is abstract')
223
def put_controlfiles(self, files, encode=True):
224
"""Write several entries as controlfiles.
226
:param files: A list of [(path, file)] pairs, where the path is the directory
227
underneath the bzr control directory
228
:param encode: If true, encode the contents as utf-8
230
raise NotImplementedError('put_controlfiles is abstract')
232
def get_root_id(self):
233
"""Return the id of this branches root"""
234
raise NotImplementedError('get_root_id is abstract')
236
def set_root_id(self, file_id):
237
raise NotImplementedError('set_root_id is abstract')
239
def print_file(self, file, revno):
240
"""Print `file` to stdout."""
241
raise NotImplementedError('print_file is abstract')
243
def append_revision(self, *revision_ids):
244
raise NotImplementedError('append_revision is abstract')
246
def set_revision_history(self, rev_history):
247
raise NotImplementedError('set_revision_history is abstract')
249
def has_revision(self, revision_id):
250
"""True if this branch has a copy of the revision.
252
This does not necessarily imply the revision is merge
253
or on the mainline."""
254
raise NotImplementedError('has_revision is abstract')
256
def get_revision_xml(self, revision_id):
257
raise NotImplementedError('get_revision_xml is abstract')
259
def get_revision(self, revision_id):
260
"""Return the Revision object for a named revision"""
261
raise NotImplementedError('get_revision is abstract')
705
263
def get_revision_delta(self, revno):
706
264
"""Return the delta for one revision.
1190
474
self.check_real_revno(revno)
1192
476
def check_real_revno(self, revno):
1194
478
Check whether a revno corresponds to a real revision.
1195
479
Zero (the NULL revision) is considered invalid
1197
481
if revno < 1 or revno > self.revno():
1198
raise errors.InvalidRevisionNumber(revno)
1201
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
1202
"""Clone this branch into to_bzrdir preserving all semantic values.
1204
Most API users will want 'create_clone_on_transport', which creates a
1205
new bzrdir and branch on the fly.
1207
revision_id: if not None, the revision history in the new branch will
1208
be truncated to end with revision_id.
1210
result = to_bzrdir.create_branch()
1213
if repository_policy is not None:
1214
repository_policy.configure_branch(result)
1215
self.copy_content_into(result, revision_id=revision_id)
1221
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
1222
"""Create a new line of development from the branch, into to_bzrdir.
1224
to_bzrdir controls the branch format.
1226
revision_id: if not None, the revision history in the new branch will
1227
be truncated to end with revision_id.
1229
if (repository_policy is not None and
1230
repository_policy.requires_stacking()):
1231
to_bzrdir._format.require_stacking(_skip_repo=True)
1232
result = to_bzrdir.create_branch()
1235
if repository_policy is not None:
1236
repository_policy.configure_branch(result)
1237
self.copy_content_into(result, revision_id=revision_id)
1238
result.set_parent(self.bzrdir.root_transport.base)
1243
def _synchronize_history(self, destination, revision_id):
1244
"""Synchronize last revision and revision history between branches.
1246
This version is most efficient when the destination is also a
1247
BzrBranch6, but works for BzrBranch5, as long as the destination's
1248
repository contains all the lefthand ancestors of the intended
1249
last_revision. If not, set_last_revision_info will fail.
1251
:param destination: The branch to copy the history into
1252
:param revision_id: The revision-id to truncate history at. May
1253
be None to copy complete history.
1255
source_revno, source_revision_id = self.last_revision_info()
1256
if revision_id is None:
1257
revno, revision_id = source_revno, source_revision_id
1259
graph = self.repository.get_graph()
1261
revno = graph.find_distance_to_null(revision_id,
1262
[(source_revision_id, source_revno)])
1263
except errors.GhostRevisionsHaveNoRevno:
1264
# Default to 1, if we can't find anything else
1266
destination.set_last_revision_info(revno, revision_id)
1269
def copy_content_into(self, destination, revision_id=None):
1270
"""Copy the content of self into destination.
1272
revision_id: if not None, the revision history in the new branch will
1273
be truncated to end with revision_id.
1275
self.update_references(destination)
1276
self._synchronize_history(destination, revision_id)
1278
parent = self.get_parent()
1279
except errors.InaccessibleParent, e:
1280
mutter('parent was not accessible to copy: %s', e)
1283
destination.set_parent(parent)
1284
if self._push_should_merge_tags():
1285
self.tags.merge_to(destination.tags)
1287
def update_references(self, target):
1288
if not getattr(self._format, 'supports_reference_locations', False):
1290
reference_dict = self._get_all_reference_info()
1291
if len(reference_dict) == 0:
1293
old_base = self.base
1294
new_base = target.base
1295
target_reference_dict = target._get_all_reference_info()
1296
for file_id, (tree_path, branch_location) in (
1297
reference_dict.items()):
1298
branch_location = urlutils.rebase_url(branch_location,
1300
target_reference_dict.setdefault(
1301
file_id, (tree_path, branch_location))
1302
target._set_all_reference_info(target_reference_dict)
1305
def check(self, refs):
1306
"""Check consistency of the branch.
1308
In particular this checks that revisions given in the revision-history
1309
do actually match up in the revision graph, and that they're all
1310
present in the repository.
1312
Callers will typically also want to check the repository.
1314
:param refs: Calculated refs for this branch as specified by
1315
branch._get_check_refs()
1316
:return: A BranchCheckResult.
1318
result = BranchCheckResult(self)
1319
last_revno, last_revision_id = self.last_revision_info()
1320
actual_revno = refs[('lefthand-distance', last_revision_id)]
1321
if actual_revno != last_revno:
1322
result.errors.append(errors.BzrCheckError(
1323
'revno does not match len(mainline) %s != %s' % (
1324
last_revno, actual_revno)))
1325
# TODO: We should probably also check that self.revision_history
1326
# matches the repository for older branch formats.
1327
# If looking for the code that cross-checks repository parents against
1328
# the iter_reverse_revision_history output, that is now a repository
1332
def _get_checkout_format(self):
1333
"""Return the most suitable metadir for a checkout of this branch.
1334
Weaves are used if this branch's repository uses weaves.
1336
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1337
from bzrlib.repofmt import weaverepo
1338
format = bzrdir.BzrDirMetaFormat1()
1339
format.repository_format = weaverepo.RepositoryFormat7()
1341
format = self.repository.bzrdir.checkout_metadir()
1342
format.set_branch_format(self._format)
1345
def create_clone_on_transport(self, to_transport, revision_id=None,
1346
stacked_on=None, create_prefix=False, use_existing_dir=False):
1347
"""Create a clone of this branch and its bzrdir.
1349
:param to_transport: The transport to clone onto.
1350
:param revision_id: The revision id to use as tip in the new branch.
1351
If None the tip is obtained from this branch.
1352
:param stacked_on: An optional URL to stack the clone on.
1353
:param create_prefix: Create any missing directories leading up to
1355
:param use_existing_dir: Use an existing directory if one exists.
1357
# XXX: Fix the bzrdir API to allow getting the branch back from the
1358
# clone call. Or something. 20090224 RBC/spiv.
1359
if revision_id is None:
1360
revision_id = self.last_revision()
1361
dir_to = self.bzrdir.clone_on_transport(to_transport,
1362
revision_id=revision_id, stacked_on=stacked_on,
1363
create_prefix=create_prefix, use_existing_dir=use_existing_dir)
1364
return dir_to.open_branch()
1366
def create_checkout(self, to_location, revision_id=None,
1367
lightweight=False, accelerator_tree=None,
1369
"""Create a checkout of a branch.
1371
:param to_location: The url to produce the checkout at
1372
:param revision_id: The revision to check out
1373
:param lightweight: If True, produce a lightweight checkout, otherwise,
1374
produce a bound branch (heavyweight checkout)
1375
:param accelerator_tree: A tree which can be used for retrieving file
1376
contents more quickly than the revision tree, i.e. a workingtree.
1377
The revision tree will be used for cases where accelerator_tree's
1378
content is different.
1379
:param hardlink: If true, hard-link files from accelerator_tree,
1381
:return: The tree of the created checkout
1383
t = transport.get_transport(to_location)
1386
format = self._get_checkout_format()
1387
checkout = format.initialize_on_transport(t)
1388
from_branch = BranchReferenceFormat().initialize(checkout,
1391
format = self._get_checkout_format()
1392
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1393
to_location, force_new_tree=False, format=format)
1394
checkout = checkout_branch.bzrdir
1395
checkout_branch.bind(self)
1396
# pull up to the specified revision_id to set the initial
1397
# branch tip correctly, and seed it with history.
1398
checkout_branch.pull(self, stop_revision=revision_id)
1400
tree = checkout.create_workingtree(revision_id,
1401
from_branch=from_branch,
1402
accelerator_tree=accelerator_tree,
1404
basis_tree = tree.basis_tree()
1405
basis_tree.lock_read()
1407
for path, file_id in basis_tree.iter_references():
1408
reference_parent = self.reference_parent(file_id, path)
1409
reference_parent.create_checkout(tree.abspath(path),
1410
basis_tree.get_reference_revision(file_id, path),
1417
def reconcile(self, thorough=True):
1418
"""Make sure the data stored in this branch is consistent."""
1419
from bzrlib.reconcile import BranchReconciler
1420
reconciler = BranchReconciler(self, thorough=thorough)
1421
reconciler.reconcile()
1424
def reference_parent(self, file_id, path, possible_transports=None):
1425
"""Return the parent branch for a tree-reference file_id
1426
:param file_id: The file_id of the tree reference
1427
:param path: The path of the file_id in the tree
1428
:return: A branch associated with the file_id
1430
# FIXME should provide multiple branches, based on config
1431
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1432
possible_transports=possible_transports)
1434
def supports_tags(self):
1435
return self._format.supports_tags()
1437
def automatic_tag_name(self, revision_id):
1438
"""Try to automatically find the tag name for a revision.
1440
:param revision_id: Revision id of the revision.
1441
:return: A tag name or None if no tag name could be determined.
1443
for hook in Branch.hooks['automatic_tag_name']:
1444
ret = hook(self, revision_id)
1449
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1451
"""Ensure that revision_b is a descendant of revision_a.
1453
This is a helper function for update_revisions.
1455
:raises: DivergedBranches if revision_b has diverged from revision_a.
1456
:returns: True if revision_b is a descendant of revision_a.
1458
relation = self._revision_relations(revision_a, revision_b, graph)
1459
if relation == 'b_descends_from_a':
1461
elif relation == 'diverged':
1462
raise errors.DivergedBranches(self, other_branch)
1463
elif relation == 'a_descends_from_b':
1466
raise AssertionError("invalid relation: %r" % (relation,))
1468
def _revision_relations(self, revision_a, revision_b, graph):
1469
"""Determine the relationship between two revisions.
1471
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1473
heads = graph.heads([revision_a, revision_b])
1474
if heads == set([revision_b]):
1475
return 'b_descends_from_a'
1476
elif heads == set([revision_a, revision_b]):
1477
# These branches have diverged
1479
elif heads == set([revision_a]):
1480
return 'a_descends_from_b'
1482
raise AssertionError("invalid heads: %r" % (heads,))
1485
class BranchFormat(object):
1486
"""An encapsulation of the initialization and open routines for a format.
1488
Formats provide three things:
1489
* An initialization routine,
1493
Formats are placed in an dict by their format string for reference
1494
during branch opening. Its not required that these be instances, they
1495
can be classes themselves with class methods - it simply depends on
1496
whether state is needed for a given format or not.
1498
Once a format is deprecated, just deprecate the initialize and open
1499
methods on the format class. Do not deprecate the object, as the
1500
object will be created every time regardless.
1503
_default_format = None
1504
"""The default format used for new branches."""
1507
"""The known formats."""
1509
can_set_append_revisions_only = True
1511
def __eq__(self, other):
1512
return self.__class__ is other.__class__
1514
def __ne__(self, other):
1515
return not (self == other)
1518
def find_format(klass, a_bzrdir, name=None):
1519
"""Return the format for the branch object in a_bzrdir."""
1521
transport = a_bzrdir.get_branch_transport(None, name=name)
1522
format_string = transport.get_bytes("format")
1523
return klass._formats[format_string]
1524
except errors.NoSuchFile:
1525
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1527
raise errors.UnknownFormatError(format=format_string, kind='branch')
1530
def get_default_format(klass):
1531
"""Return the current default format."""
1532
return klass._default_format
1534
def get_reference(self, a_bzrdir):
1535
"""Get the target reference of the branch in a_bzrdir.
1537
format probing must have been completed before calling
1538
this method - it is assumed that the format of the branch
1539
in a_bzrdir is correct.
1541
:param a_bzrdir: The bzrdir to get the branch data from.
1542
:return: None if the branch is not a reference branch.
1547
def set_reference(self, a_bzrdir, to_branch):
1548
"""Set the target reference of the branch in a_bzrdir.
1550
format probing must have been completed before calling
1551
this method - it is assumed that the format of the branch
1552
in a_bzrdir is correct.
1554
:param a_bzrdir: The bzrdir to set the branch reference for.
1555
:param to_branch: branch that the checkout is to reference
1557
raise NotImplementedError(self.set_reference)
1559
def get_format_string(self):
1560
"""Return the ASCII format string that identifies this format."""
1561
raise NotImplementedError(self.get_format_string)
1563
def get_format_description(self):
1564
"""Return the short format description for this format."""
1565
raise NotImplementedError(self.get_format_description)
1567
def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1568
hooks = Branch.hooks['post_branch_init']
1571
params = BranchInitHookParams(self, a_bzrdir, name, branch)
1575
def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1576
lock_type='metadir', set_format=True):
1577
"""Initialize a branch in a bzrdir, with specified files
1579
:param a_bzrdir: The bzrdir to initialize the branch in
1580
:param utf8_files: The files to create as a list of
1581
(filename, content) tuples
1582
:param name: Name of colocated branch to create, if any
1583
:param set_format: If True, set the format with
1584
self.get_format_string. (BzrBranch4 has its format set
1586
:return: a branch in this format
1588
mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1589
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1591
'metadir': ('lock', lockdir.LockDir),
1592
'branch4': ('branch-lock', lockable_files.TransportLock),
1594
lock_name, lock_class = lock_map[lock_type]
1595
control_files = lockable_files.LockableFiles(branch_transport,
1596
lock_name, lock_class)
1597
control_files.create_lock()
1599
control_files.lock_write()
1600
except errors.LockContention:
1601
if lock_type != 'branch4':
1607
utf8_files += [('format', self.get_format_string())]
1609
for (filename, content) in utf8_files:
1610
branch_transport.put_bytes(
1612
mode=a_bzrdir._get_file_mode())
1615
control_files.unlock()
1616
branch = self.open(a_bzrdir, name, _found=True)
1617
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1620
def initialize(self, a_bzrdir, name=None):
1621
"""Create a branch of this format in a_bzrdir.
482
raise InvalidRevisionNumber(revno)
1623
:param name: Name of the colocated branch to create.
1625
raise NotImplementedError(self.initialize)
1627
def is_supported(self):
1628
"""Is this format supported?
1630
Supported formats can be initialized and opened.
1631
Unsupported formats may not support initialization or committing or
1632
some other features depending on the reason for not being supported.
1636
def make_tags(self, branch):
1637
"""Create a tags object for branch.
1639
This method is on BranchFormat, because BranchFormats are reflected
1640
over the wire via network_name(), whereas full Branch instances require
1641
multiple VFS method calls to operate at all.
1643
The default implementation returns a disabled-tags instance.
1645
Note that it is normal for branch to be a RemoteBranch when using tags
1648
return DisabledTags(branch)
1650
def network_name(self):
1651
"""A simple byte string uniquely identifying this format for RPC calls.
1653
MetaDir branch formats use their disk format string to identify the
1654
repository over the wire. All in one formats such as bzr < 0.8, and
1655
foreign formats like svn/git and hg should use some marker which is
1656
unique and immutable.
1658
raise NotImplementedError(self.network_name)
1660
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1661
"""Return the branch object for a_bzrdir
1663
:param a_bzrdir: A BzrDir that contains a branch.
1664
:param name: Name of colocated branch to open
1665
:param _found: a private parameter, do not use it. It is used to
1666
indicate if format probing has already be done.
1667
:param ignore_fallbacks: when set, no fallback branches will be opened
1668
(if there are any). Default is to open fallbacks.
1670
raise NotImplementedError(self.open)
1673
def register_format(klass, format):
1674
"""Register a metadir format."""
1675
klass._formats[format.get_format_string()] = format
1676
# Metadir formats have a network name of their format string, and get
1677
# registered as class factories.
1678
network_format_registry.register(format.get_format_string(), format.__class__)
1681
def set_default_format(klass, format):
1682
klass._default_format = format
1684
def supports_set_append_revisions_only(self):
1685
"""True if this format supports set_append_revisions_only."""
1688
def supports_stacking(self):
1689
"""True if this format records a stacked-on branch."""
1693
def unregister_format(klass, format):
1694
del klass._formats[format.get_format_string()]
1697
return self.get_format_description().rstrip()
1699
def supports_tags(self):
1700
"""True if this format supports tags stored in the branch"""
1701
return False # by default
1704
class BranchHooks(Hooks):
1705
"""A dictionary mapping hook name to a list of callables for branch hooks.
1707
e.g. ['set_rh'] Is the list of items to be called when the
1708
set_revision_history function is invoked.
1712
"""Create the default hooks.
1714
These are all empty initially, because by default nothing should get
1717
Hooks.__init__(self)
1718
self.create_hook(HookPoint('set_rh',
1719
"Invoked whenever the revision history has been set via "
1720
"set_revision_history. The api signature is (branch, "
1721
"revision_history), and the branch will be write-locked. "
1722
"The set_rh hook can be expensive for bzr to trigger, a better "
1723
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1724
self.create_hook(HookPoint('open',
1725
"Called with the Branch object that has been opened after a "
1726
"branch is opened.", (1, 8), None))
1727
self.create_hook(HookPoint('post_push',
1728
"Called after a push operation completes. post_push is called "
1729
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1730
"bzr client.", (0, 15), None))
1731
self.create_hook(HookPoint('post_pull',
1732
"Called after a pull operation completes. post_pull is called "
1733
"with a bzrlib.branch.PullResult object and only runs in the "
1734
"bzr client.", (0, 15), None))
1735
self.create_hook(HookPoint('pre_commit',
1736
"Called after a commit is calculated but before it is is "
1737
"completed. pre_commit is called with (local, master, old_revno, "
1738
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1739
"). old_revid is NULL_REVISION for the first commit to a branch, "
1740
"tree_delta is a TreeDelta object describing changes from the "
1741
"basis revision. hooks MUST NOT modify this delta. "
1742
" future_tree is an in-memory tree obtained from "
1743
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1744
"tree.", (0,91), None))
1745
self.create_hook(HookPoint('post_commit',
1746
"Called in the bzr client after a commit has completed. "
1747
"post_commit is called with (local, master, old_revno, old_revid, "
1748
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1749
"commit to a branch.", (0, 15), None))
1750
self.create_hook(HookPoint('post_uncommit',
1751
"Called in the bzr client after an uncommit completes. "
1752
"post_uncommit is called with (local, master, old_revno, "
1753
"old_revid, new_revno, new_revid) where local is the local branch "
1754
"or None, master is the target branch, and an empty branch "
1755
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1756
self.create_hook(HookPoint('pre_change_branch_tip',
1757
"Called in bzr client and server before a change to the tip of a "
1758
"branch is made. pre_change_branch_tip is called with a "
1759
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1760
"commit, uncommit will all trigger this hook.", (1, 6), None))
1761
self.create_hook(HookPoint('post_change_branch_tip',
1762
"Called in bzr client and server after a change to the tip of a "
1763
"branch is made. post_change_branch_tip is called with a "
1764
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1765
"commit, uncommit will all trigger this hook.", (1, 4), None))
1766
self.create_hook(HookPoint('transform_fallback_location',
1767
"Called when a stacked branch is activating its fallback "
1768
"locations. transform_fallback_location is called with (branch, "
1769
"url), and should return a new url. Returning the same url "
1770
"allows it to be used as-is, returning a different one can be "
1771
"used to cause the branch to stack on a closer copy of that "
1772
"fallback_location. Note that the branch cannot have history "
1773
"accessing methods called on it during this hook because the "
1774
"fallback locations have not been activated. When there are "
1775
"multiple hooks installed for transform_fallback_location, "
1776
"all are called with the url returned from the previous hook."
1777
"The order is however undefined.", (1, 9), None))
1778
self.create_hook(HookPoint('automatic_tag_name',
1779
"Called to determine an automatic tag name for a revision."
1780
"automatic_tag_name is called with (branch, revision_id) and "
1781
"should return a tag name or None if no tag name could be "
1782
"determined. The first non-None tag name returned will be used.",
1784
self.create_hook(HookPoint('post_branch_init',
1785
"Called after new branch initialization completes. "
1786
"post_branch_init is called with a "
1787
"bzrlib.branch.BranchInitHookParams. "
1788
"Note that init, branch and checkout (both heavyweight and "
1789
"lightweight) will all trigger this hook.", (2, 2), None))
1790
self.create_hook(HookPoint('post_switch',
1791
"Called after a checkout switches branch. "
1792
"post_switch is called with a "
1793
"bzrlib.branch.SwitchHookParams.", (2, 2), None))
1797
# install the default hooks into the Branch class.
1798
Branch.hooks = BranchHooks()
1801
class ChangeBranchTipParams(object):
1802
"""Object holding parameters passed to *_change_branch_tip hooks.
1804
There are 5 fields that hooks may wish to access:
1806
:ivar branch: the branch being changed
1807
:ivar old_revno: revision number before the change
1808
:ivar new_revno: revision number after the change
1809
:ivar old_revid: revision id before the change
1810
:ivar new_revid: revision id after the change
1812
The revid fields are strings. The revno fields are integers.
1815
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1816
"""Create a group of ChangeBranchTip parameters.
1818
:param branch: The branch being changed.
1819
:param old_revno: Revision number before the change.
1820
:param new_revno: Revision number after the change.
1821
:param old_revid: Tip revision id before the change.
1822
:param new_revid: Tip revision id after the change.
1824
self.branch = branch
1825
self.old_revno = old_revno
1826
self.new_revno = new_revno
1827
self.old_revid = old_revid
1828
self.new_revid = new_revid
1830
def __eq__(self, other):
1831
return self.__dict__ == other.__dict__
1834
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1835
self.__class__.__name__, self.branch,
1836
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1839
class BranchInitHookParams(object):
1840
"""Object holding parameters passed to *_branch_init hooks.
1842
There are 4 fields that hooks may wish to access:
1844
:ivar format: the branch format
1845
:ivar bzrdir: the BzrDir where the branch will be/has been initialized
1846
:ivar name: name of colocated branch, if any (or None)
1847
:ivar branch: the branch created
1849
Note that for lightweight checkouts, the bzrdir and format fields refer to
1850
the checkout, hence they are different from the corresponding fields in
1851
branch, which refer to the original branch.
1854
def __init__(self, format, a_bzrdir, name, branch):
1855
"""Create a group of BranchInitHook parameters.
1857
:param format: the branch format
1858
:param a_bzrdir: the BzrDir where the branch will be/has been
1860
:param name: name of colocated branch, if any (or None)
1861
:param branch: the branch created
1863
Note that for lightweight checkouts, the bzrdir and format fields refer
1864
to the checkout, hence they are different from the corresponding fields
1865
in branch, which refer to the original branch.
1867
self.format = format
1868
self.bzrdir = a_bzrdir
1870
self.branch = branch
1872
def __eq__(self, other):
1873
return self.__dict__ == other.__dict__
1877
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1879
return "<%s of format:%s bzrdir:%s>" % (
1880
self.__class__.__name__, self.branch,
1881
self.format, self.bzrdir)
1884
class SwitchHookParams(object):
1885
"""Object holding parameters passed to *_switch hooks.
1887
There are 4 fields that hooks may wish to access:
1889
:ivar control_dir: BzrDir of the checkout to change
1890
:ivar to_branch: branch that the checkout is to reference
1891
:ivar force: skip the check for local commits in a heavy checkout
1892
:ivar revision_id: revision ID to switch to (or None)
1895
def __init__(self, control_dir, to_branch, force, revision_id):
1896
"""Create a group of SwitchHook parameters.
1898
:param control_dir: BzrDir of the checkout to change
1899
:param to_branch: branch that the checkout is to reference
1900
:param force: skip the check for local commits in a heavy checkout
1901
:param revision_id: revision ID to switch to (or None)
1903
self.control_dir = control_dir
1904
self.to_branch = to_branch
1906
self.revision_id = revision_id
1908
def __eq__(self, other):
1909
return self.__dict__ == other.__dict__
1912
return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1913
self.control_dir, self.to_branch,
1917
class BzrBranchFormat4(BranchFormat):
1918
"""Bzr branch format 4.
1921
- a revision-history file.
1922
- a branch-lock lock file [ to be shared with the bzrdir ]
1925
def get_format_description(self):
1926
"""See BranchFormat.get_format_description()."""
1927
return "Branch format 4"
1929
def initialize(self, a_bzrdir, name=None):
1930
"""Create a branch of this format in a_bzrdir."""
1931
utf8_files = [('revision-history', ''),
1932
('branch-name', ''),
1934
return self._initialize_helper(a_bzrdir, utf8_files, name=name,
1935
lock_type='branch4', set_format=False)
1938
super(BzrBranchFormat4, self).__init__()
1939
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1941
def network_name(self):
1942
"""The network name for this format is the control dirs disk label."""
1943
return self._matchingbzrdir.get_format_string()
1945
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1946
"""See BranchFormat.open()."""
1948
# we are being called directly and must probe.
1949
raise NotImplementedError
1950
return BzrBranch(_format=self,
1951
_control_files=a_bzrdir._control_files,
1954
_repository=a_bzrdir.open_repository())
1957
return "Bazaar-NG branch format 4"
1960
class BranchFormatMetadir(BranchFormat):
1961
"""Common logic for meta-dir based branch formats."""
1963
def _branch_class(self):
1964
"""What class to instantiate on open calls."""
1965
raise NotImplementedError(self._branch_class)
1967
def network_name(self):
1968
"""A simple byte string uniquely identifying this format for RPC calls.
1970
Metadir branch formats use their format string.
1972
return self.get_format_string()
1974
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1975
"""See BranchFormat.open()."""
1977
format = BranchFormat.find_format(a_bzrdir, name=name)
1978
if format.__class__ != self.__class__:
1979
raise AssertionError("wrong format %r found for %r" %
1981
transport = a_bzrdir.get_branch_transport(None, name=name)
1983
control_files = lockable_files.LockableFiles(transport, 'lock',
1985
return self._branch_class()(_format=self,
1986
_control_files=control_files,
1989
_repository=a_bzrdir.find_repository(),
1990
ignore_fallbacks=ignore_fallbacks)
1991
except errors.NoSuchFile:
1992
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1995
super(BranchFormatMetadir, self).__init__()
1996
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1997
self._matchingbzrdir.set_branch_format(self)
1999
def supports_tags(self):
2003
class BzrBranchFormat5(BranchFormatMetadir):
2004
"""Bzr branch format 5.
2007
- a revision-history file.
2009
- a lock dir guarding the branch itself
2010
- all of this stored in a branch/ subdirectory
2011
- works with shared repositories.
2013
This format is new in bzr 0.8.
2016
def _branch_class(self):
2019
def get_format_string(self):
2020
"""See BranchFormat.get_format_string()."""
2021
return "Bazaar-NG branch format 5\n"
2023
def get_format_description(self):
2024
"""See BranchFormat.get_format_description()."""
2025
return "Branch format 5"
2027
def initialize(self, a_bzrdir, name=None):
2028
"""Create a branch of this format in a_bzrdir."""
2029
utf8_files = [('revision-history', ''),
2030
('branch-name', ''),
2032
return self._initialize_helper(a_bzrdir, utf8_files, name)
2034
def supports_tags(self):
2038
class BzrBranchFormat6(BranchFormatMetadir):
2039
"""Branch format with last-revision and tags.
2041
Unlike previous formats, this has no explicit revision history. Instead,
2042
this just stores the last-revision, and the left-hand history leading
2043
up to there is the history.
2045
This format was introduced in bzr 0.15
2046
and became the default in 0.91.
2049
def _branch_class(self):
2052
def get_format_string(self):
2053
"""See BranchFormat.get_format_string()."""
2054
return "Bazaar Branch Format 6 (bzr 0.15)\n"
2056
def get_format_description(self):
2057
"""See BranchFormat.get_format_description()."""
2058
return "Branch format 6"
2060
def initialize(self, a_bzrdir, name=None):
2061
"""Create a branch of this format in a_bzrdir."""
2062
utf8_files = [('last-revision', '0 null:\n'),
2063
('branch.conf', ''),
2066
return self._initialize_helper(a_bzrdir, utf8_files, name)
2068
def make_tags(self, branch):
2069
"""See bzrlib.branch.BranchFormat.make_tags()."""
2070
return BasicTags(branch)
2072
def supports_set_append_revisions_only(self):
2076
class BzrBranchFormat8(BranchFormatMetadir):
2077
"""Metadir format supporting storing locations of subtree branches."""
2079
def _branch_class(self):
2082
def get_format_string(self):
2083
"""See BranchFormat.get_format_string()."""
2084
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2086
def get_format_description(self):
2087
"""See BranchFormat.get_format_description()."""
2088
return "Branch format 8"
2090
def initialize(self, a_bzrdir, name=None):
2091
"""Create a branch of this format in a_bzrdir."""
2092
utf8_files = [('last-revision', '0 null:\n'),
2093
('branch.conf', ''),
2097
return self._initialize_helper(a_bzrdir, utf8_files, name)
2100
super(BzrBranchFormat8, self).__init__()
2101
self._matchingbzrdir.repository_format = \
2102
RepositoryFormatKnitPack5RichRoot()
2104
def make_tags(self, branch):
2105
"""See bzrlib.branch.BranchFormat.make_tags()."""
2106
return BasicTags(branch)
2108
def supports_set_append_revisions_only(self):
2111
def supports_stacking(self):
2114
supports_reference_locations = True
2117
class BzrBranchFormat7(BzrBranchFormat8):
2118
"""Branch format with last-revision, tags, and a stacked location pointer.
2120
The stacked location pointer is passed down to the repository and requires
2121
a repository format with supports_external_lookups = True.
2123
This format was introduced in bzr 1.6.
2126
def initialize(self, a_bzrdir, name=None):
2127
"""Create a branch of this format in a_bzrdir."""
2128
utf8_files = [('last-revision', '0 null:\n'),
2129
('branch.conf', ''),
2132
return self._initialize_helper(a_bzrdir, utf8_files, name)
2134
def _branch_class(self):
2137
def get_format_string(self):
2138
"""See BranchFormat.get_format_string()."""
2139
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
2141
def get_format_description(self):
2142
"""See BranchFormat.get_format_description()."""
2143
return "Branch format 7"
2145
def supports_set_append_revisions_only(self):
2148
supports_reference_locations = False
2151
class BranchReferenceFormat(BranchFormat):
2152
"""Bzr branch reference format.
2154
Branch references are used in implementing checkouts, they
2155
act as an alias to the real branch which is at some other url.
2162
def get_format_string(self):
2163
"""See BranchFormat.get_format_string()."""
2164
return "Bazaar-NG Branch Reference Format 1\n"
2166
def get_format_description(self):
2167
"""See BranchFormat.get_format_description()."""
2168
return "Checkout reference format 1"
2170
def get_reference(self, a_bzrdir):
2171
"""See BranchFormat.get_reference()."""
2172
transport = a_bzrdir.get_branch_transport(None)
2173
return transport.get_bytes('location')
2175
def set_reference(self, a_bzrdir, to_branch):
2176
"""See BranchFormat.set_reference()."""
2177
transport = a_bzrdir.get_branch_transport(None)
2178
location = transport.put_bytes('location', to_branch.base)
2180
def initialize(self, a_bzrdir, name=None, target_branch=None):
2181
"""Create a branch of this format in a_bzrdir."""
2182
if target_branch is None:
2183
# this format does not implement branch itself, thus the implicit
2184
# creation contract must see it as uninitializable
2185
raise errors.UninitializableFormat(self)
2186
mutter('creating branch reference in %s', a_bzrdir.user_url)
2187
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2188
branch_transport.put_bytes('location',
2189
target_branch.bzrdir.user_url)
2190
branch_transport.put_bytes('format', self.get_format_string())
2192
a_bzrdir, name, _found=True,
2193
possible_transports=[target_branch.bzrdir.root_transport])
2194
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2198
super(BranchReferenceFormat, self).__init__()
2199
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2200
self._matchingbzrdir.set_branch_format(self)
2202
def _make_reference_clone_function(format, a_branch):
2203
"""Create a clone() routine for a branch dynamically."""
2204
def clone(to_bzrdir, revision_id=None,
2205
repository_policy=None):
2206
"""See Branch.clone()."""
2207
return format.initialize(to_bzrdir, target_branch=a_branch)
2208
# cannot obey revision_id limits when cloning a reference ...
2209
# FIXME RBC 20060210 either nuke revision_id for clone, or
2210
# emit some sort of warning/error to the caller ?!
2213
def open(self, a_bzrdir, name=None, _found=False, location=None,
2214
possible_transports=None, ignore_fallbacks=False):
2215
"""Return the branch that the branch reference in a_bzrdir points at.
2217
:param a_bzrdir: A BzrDir that contains a branch.
2218
:param name: Name of colocated branch to open, if any
2219
:param _found: a private parameter, do not use it. It is used to
2220
indicate if format probing has already be done.
2221
:param ignore_fallbacks: when set, no fallback branches will be opened
2222
(if there are any). Default is to open fallbacks.
2223
:param location: The location of the referenced branch. If
2224
unspecified, this will be determined from the branch reference in
2226
:param possible_transports: An optional reusable transports list.
2229
format = BranchFormat.find_format(a_bzrdir, name=name)
2230
if format.__class__ != self.__class__:
2231
raise AssertionError("wrong format %r found for %r" %
2233
if location is None:
2234
location = self.get_reference(a_bzrdir)
2235
real_bzrdir = bzrdir.BzrDir.open(
2236
location, possible_transports=possible_transports)
2237
result = real_bzrdir.open_branch(name=name,
2238
ignore_fallbacks=ignore_fallbacks)
2239
# this changes the behaviour of result.clone to create a new reference
2240
# rather than a copy of the content of the branch.
2241
# I did not use a proxy object because that needs much more extensive
2242
# testing, and we are only changing one behaviour at the moment.
2243
# If we decide to alter more behaviours - i.e. the implicit nickname
2244
# then this should be refactored to introduce a tested proxy branch
2245
# and a subclass of that for use in overriding clone() and ....
2247
result.clone = self._make_reference_clone_function(result)
2251
network_format_registry = registry.FormatRegistry()
2252
"""Registry of formats indexed by their network name.
2254
The network name for a branch format is an identifier that can be used when
2255
referring to formats with smart server operations. See
2256
BranchFormat.network_name() for more detail.
2260
# formats which have no format string are not discoverable
2261
# and not independently creatable, so are not registered.
2262
__format5 = BzrBranchFormat5()
2263
__format6 = BzrBranchFormat6()
2264
__format7 = BzrBranchFormat7()
2265
__format8 = BzrBranchFormat8()
2266
BranchFormat.register_format(__format5)
2267
BranchFormat.register_format(BranchReferenceFormat())
2268
BranchFormat.register_format(__format6)
2269
BranchFormat.register_format(__format7)
2270
BranchFormat.register_format(__format8)
2271
BranchFormat.set_default_format(__format7)
2272
_legacy_formats = [BzrBranchFormat4(),
2274
network_format_registry.register(
2275
_legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2278
class BranchWriteLockResult(LogicalLockResult):
2279
"""The result of write locking a branch.
2281
:ivar branch_token: The token obtained from the underlying branch lock, or
2283
:ivar unlock: A callable which will unlock the lock.
2286
def __init__(self, unlock, branch_token):
2287
LogicalLockResult.__init__(self, unlock)
2288
self.branch_token = branch_token
2291
return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2295
class BzrBranch(Branch, _RelockDebugMixin):
484
def sign_revision(self, revision_id, gpg_strategy):
485
raise NotImplementedError('sign_revision is abstract')
487
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
488
raise NotImplementedError('store_revision_signature is abstract')
490
class BzrBranch(Branch):
2296
491
"""A branch stored in the actual filesystem.
2298
493
Note that it's "local" in the context of the filesystem; it doesn't
2299
494
really matter if it's on an nfs/smb/afs/coda/... share, as long as
2300
495
it's writable, and can be accessed via the normal filesystem API.
2302
:ivar _transport: Transport for file operations on this branch's
2303
control files, typically pointing to the .bzr/branch directory.
2304
:ivar repository: Repository for this branch.
2305
:ivar base: The url of the base directory for this branch; the one
2306
containing the .bzr directory.
2307
:ivar name: Optional colocated branch name as it exists in the control
501
If _lock_mode is true, a positive count of the number of times the
505
Lock object from bzrlib.lock.
2311
def __init__(self, _format=None,
2312
_control_files=None, a_bzrdir=None, name=None,
2313
_repository=None, ignore_fallbacks=False):
2314
"""Create new branch object at a particular location."""
2315
if a_bzrdir is None:
2316
raise ValueError('a_bzrdir must be supplied')
2318
self.bzrdir = a_bzrdir
2319
self._base = self.bzrdir.transport.clone('..').base
2321
# XXX: We should be able to just do
2322
# self.base = self.bzrdir.root_transport.base
2323
# but this does not quite work yet -- mbp 20080522
2324
self._format = _format
2325
if _control_files is None:
2326
raise ValueError('BzrBranch _control_files is None')
2327
self.control_files = _control_files
2328
self._transport = _control_files._transport
2329
self.repository = _repository
2330
Branch.__init__(self)
507
# We actually expect this class to be somewhat short-lived; part of its
508
# purpose is to try to isolate what bits of the branch logic are tied to
509
# filesystem access, so that in a later step, we can extricate them to
510
# a separarte ("storage") class.
514
_inventory_weave = None
516
# Map some sort of prefix into a namespace
517
# stuff like "revno:10", "revid:", etc.
518
# This should match a prefix with a function which accepts
519
REVISION_NAMESPACES = {}
521
def push_stores(self, branch_to):
522
"""See Branch.push_stores."""
523
if (self._branch_format != branch_to._branch_format
524
or self._branch_format != 4):
525
from bzrlib.fetch import greedy_fetch
526
mutter("falling back to fetch logic to push between %s(%s) and %s(%s)",
527
self, self._branch_format, branch_to, branch_to._branch_format)
528
greedy_fetch(to_branch=branch_to, from_branch=self,
529
revision=self.last_revision())
532
store_pairs = ((self.text_store, branch_to.text_store),
533
(self.inventory_store, branch_to.inventory_store),
534
(self.revision_store, branch_to.revision_store))
536
for from_store, to_store in store_pairs:
537
copy_all(from_store, to_store)
538
except UnlistableStore:
539
raise UnlistableBranch(from_store)
541
def __init__(self, transport, init=False,
542
relax_version_check=False):
543
"""Create new branch object at a particular location.
545
transport -- A Transport object, defining how to access files.
547
init -- If True, create new control files in a previously
548
unversioned directory. If False, the branch must already
551
relax_version_check -- If true, the usual check for the branch
552
version is not applied. This is intended only for
553
upgrade/recovery type use; it's not guaranteed that
554
all operations will work on old format branches.
556
In the test suite, creation of new trees is tested using the
557
`ScratchBranch` class.
559
assert isinstance(transport, Transport), \
560
"%r is not a Transport" % transport
561
self._transport = transport
564
self._check_format(relax_version_check)
566
def get_store(name, compressed=True, prefixed=False):
567
# FIXME: This approach of assuming stores are all entirely compressed
568
# or entirely uncompressed is tidy, but breaks upgrade from
569
# some existing branches where there's a mixture; we probably
570
# still want the option to look for both.
571
relpath = self._rel_controlfilename(name)
572
store = TextStore(self._transport.clone(relpath),
574
compressed=compressed)
575
#if self._transport.should_cache():
576
# cache_path = os.path.join(self.cache_root, name)
577
# os.mkdir(cache_path)
578
# store = bzrlib.store.CachedStore(store, cache_path)
580
def get_weave(name, prefixed=False):
581
relpath = self._rel_controlfilename(name)
582
ws = WeaveStore(self._transport.clone(relpath), prefixed=prefixed)
583
if self._transport.should_cache():
584
ws.enable_cache = True
587
if self._branch_format == 4:
588
self.inventory_store = get_store('inventory-store')
589
self.text_store = get_store('text-store')
590
self.revision_store = get_store('revision-store')
591
elif self._branch_format == 5:
592
self.control_weaves = get_weave('')
593
self.weave_store = get_weave('weaves')
594
self.revision_store = get_store('revision-store', compressed=False)
595
elif self._branch_format == 6:
596
self.control_weaves = get_weave('')
597
self.weave_store = get_weave('weaves', prefixed=True)
598
self.revision_store = get_store('revision-store', compressed=False,
600
self.revision_store.register_suffix('sig')
601
self._transaction = None
2332
603
def __str__(self):
2333
if self.name is None:
2334
return '%s(%s)' % (self.__class__.__name__, self.user_url)
2336
return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
604
return '%s(%r)' % (self.__class__.__name__, self._transport.base)
2339
606
__repr__ = __str__
609
if self._lock_mode or self._lock:
610
# XXX: This should show something every time, and be suitable for
611
# headless operation and embedding
612
warn("branch %r was not explicitly unlocked" % self)
615
# TODO: It might be best to do this somewhere else,
616
# but it is nice for a Branch object to automatically
617
# cache it's information.
618
# Alternatively, we could have the Transport objects cache requests
619
# See the earlier discussion about how major objects (like Branch)
620
# should never expect their __del__ function to run.
621
if hasattr(self, 'cache_root') and self.cache_root is not None:
623
shutil.rmtree(self.cache_root)
626
self.cache_root = None
2341
628
def _get_base(self):
2342
"""Returns the directory containing the control directory."""
630
return self._transport.base
2345
633
base = property(_get_base, doc="The URL for the root of this branch.")
2347
def _get_config(self):
2348
return TransportConfig(self._transport, 'branch.conf')
2350
def is_locked(self):
2351
return self.control_files.is_locked()
2353
def lock_write(self, token=None):
2354
"""Lock the branch for write operations.
2356
:param token: A token to permit reacquiring a previously held and
2358
:return: A BranchWriteLockResult.
2360
if not self.is_locked():
2361
self._note_lock('w')
2362
# All-in-one needs to always unlock/lock.
2363
repo_control = getattr(self.repository, 'control_files', None)
2364
if self.control_files == repo_control or not self.is_locked():
2365
self.repository._warn_if_deprecated(self)
2366
self.repository.lock_write()
2371
return BranchWriteLockResult(self.unlock,
2372
self.control_files.lock_write(token=token))
2375
self.repository.unlock()
635
def _finish_transaction(self):
636
"""Exit the current transaction."""
637
if self._transaction is None:
638
raise errors.LockError('Branch %s is not in a transaction' %
640
transaction = self._transaction
641
self._transaction = None
644
def get_transaction(self):
645
"""See Branch.get_transaction."""
646
if self._transaction is None:
647
return transactions.PassThroughTransaction()
649
return self._transaction
651
def _set_transaction(self, new_transaction):
652
"""Set a new active transaction."""
653
if self._transaction is not None:
654
raise errors.LockError('Branch %s is in a transaction already.' %
656
self._transaction = new_transaction
658
def lock_write(self):
659
mutter("lock write: %s (%s)", self, self._lock_count)
660
# TODO: Upgrade locking to support using a Transport,
661
# and potentially a remote locking protocol
663
if self._lock_mode != 'w':
664
raise LockError("can't upgrade to a write lock from %r" %
666
self._lock_count += 1
668
self._lock = self._transport.lock_write(
669
self._rel_controlfilename('branch-lock'))
670
self._lock_mode = 'w'
672
self._set_transaction(transactions.PassThroughTransaction())
2378
674
def lock_read(self):
2379
"""Lock the branch for read operations.
2381
:return: A bzrlib.lock.LogicalLockResult.
2383
if not self.is_locked():
2384
self._note_lock('r')
2385
# All-in-one needs to always unlock/lock.
2386
repo_control = getattr(self.repository, 'control_files', None)
2387
if self.control_files == repo_control or not self.is_locked():
2388
self.repository._warn_if_deprecated(self)
2389
self.repository.lock_read()
675
mutter("lock read: %s (%s)", self, self._lock_count)
677
assert self._lock_mode in ('r', 'w'), \
678
"invalid lock mode %r" % self._lock_mode
679
self._lock_count += 1
2394
self.control_files.lock_read()
2395
return LogicalLockResult(self.unlock)
2398
self.repository.unlock()
2401
@only_raises(errors.LockNotHeld, errors.LockBroken)
681
self._lock = self._transport.lock_read(
682
self._rel_controlfilename('branch-lock'))
683
self._lock_mode = 'r'
685
self._set_transaction(transactions.ReadOnlyTransaction())
686
# 5K may be excessive, but hey, its a knob.
687
self.get_transaction().set_cache_size(5000)
2402
689
def unlock(self):
690
mutter("unlock: %s (%s)", self, self._lock_count)
691
if not self._lock_mode:
692
raise LockError('branch %r is not locked' % (self))
694
if self._lock_count > 1:
695
self._lock_count -= 1
697
self._finish_transaction()
700
self._lock_mode = self._lock_count = None
702
def abspath(self, name):
703
"""See Branch.abspath."""
704
return self._transport.abspath(name)
706
def _rel_controlfilename(self, file_or_path):
707
if not isinstance(file_or_path, basestring):
708
file_or_path = '/'.join(file_or_path)
709
if file_or_path == '':
711
return bzrlib.transport.urlescape(bzrlib.BZRDIR + '/' + file_or_path)
713
def controlfilename(self, file_or_path):
714
"""See Branch.controlfilename."""
715
return self._transport.abspath(self._rel_controlfilename(file_or_path))
717
def controlfile(self, file_or_path, mode='r'):
718
"""See Branch.controlfile."""
721
relpath = self._rel_controlfilename(file_or_path)
722
#TODO: codecs.open() buffers linewise, so it was overloaded with
723
# a much larger buffer, do we need to do the same for getreader/getwriter?
725
return self._transport.get(relpath)
727
raise BzrError("Branch.controlfile(mode='wb') is not supported, use put_controlfiles")
729
# XXX: Do we really want errors='replace'? Perhaps it should be
730
# an error, or at least reported, if there's incorrectly-encoded
731
# data inside a file.
732
# <https://launchpad.net/products/bzr/+bug/3823>
733
return codecs.getreader('utf-8')(self._transport.get(relpath), errors='replace')
735
raise BzrError("Branch.controlfile(mode='w') is not supported, use put_controlfiles")
737
raise BzrError("invalid controlfile mode %r" % mode)
739
def put_controlfile(self, path, f, encode=True):
740
"""See Branch.put_controlfile."""
741
self.put_controlfiles([(path, f)], encode=encode)
743
def put_controlfiles(self, files, encode=True):
744
"""See Branch.put_controlfiles."""
747
for path, f in files:
749
if isinstance(f, basestring):
750
f = f.encode('utf-8', 'replace')
752
f = codecs.getwriter('utf-8')(f, errors='replace')
753
path = self._rel_controlfilename(path)
754
ctrl_files.append((path, f))
755
self._transport.put_multi(ctrl_files)
757
def _make_control(self):
758
from bzrlib.inventory import Inventory
759
from bzrlib.weavefile import write_weave_v5
760
from bzrlib.weave import Weave
762
# Create an empty inventory
764
# if we want per-tree root ids then this is the place to set
765
# them; they're not needed for now and so ommitted for
767
bzrlib.xml5.serializer_v5.write_inventory(Inventory(), sio)
768
empty_inv = sio.getvalue()
770
bzrlib.weavefile.write_weave_v5(Weave(), sio)
771
empty_weave = sio.getvalue()
773
dirs = [[], 'revision-store', 'weaves']
775
"This is a Bazaar-NG control directory.\n"
776
"Do not change any files in this directory.\n"),
777
('branch-format', BZR_BRANCH_FORMAT_6),
778
('revision-history', ''),
781
('pending-merges', ''),
782
('inventory', empty_inv),
783
('inventory.weave', empty_weave),
784
('ancestry.weave', empty_weave)
786
cfn = self._rel_controlfilename
787
self._transport.mkdir_multi([cfn(d) for d in dirs])
788
self.put_controlfiles(files)
789
mutter('created control directory in ' + self._transport.base)
791
def _check_format(self, relax_version_check):
792
"""Check this branch format is supported.
794
The format level is stored, as an integer, in
795
self._branch_format for code that needs to check it later.
797
In the future, we might need different in-memory Branch
798
classes to support downlevel branches. But not yet.
2404
self.control_files.unlock()
2406
# All-in-one needs to always unlock/lock.
2407
repo_control = getattr(self.repository, 'control_files', None)
2408
if (self.control_files == repo_control or
2409
not self.control_files.is_locked()):
2410
self.repository.unlock()
2411
if not self.control_files.is_locked():
2412
# we just released the lock
2413
self._clear_cached_state()
2415
def peek_lock_mode(self):
2416
if self.control_files._lock_count == 0:
2419
return self.control_files._lock_mode
2421
def get_physical_lock_status(self):
2422
return self.control_files.get_physical_lock_status()
2425
def print_file(self, file, revision_id):
801
fmt = self.controlfile('branch-format', 'r').read()
803
raise NotBranchError(path=self.base)
804
mutter("got branch format %r", fmt)
805
if fmt == BZR_BRANCH_FORMAT_6:
806
self._branch_format = 6
807
elif fmt == BZR_BRANCH_FORMAT_5:
808
self._branch_format = 5
809
elif fmt == BZR_BRANCH_FORMAT_4:
810
self._branch_format = 4
812
if (not relax_version_check
813
and self._branch_format not in (5, 6)):
814
raise errors.UnsupportedFormatError(
815
'sorry, branch format %r not supported' % fmt,
816
['use a different bzr version',
817
'or remove the .bzr directory'
818
' and "bzr init" again'])
821
def get_root_id(self):
822
"""See Branch.get_root_id."""
823
inv = self.get_inventory(self.last_revision())
824
return inv.root.file_id
827
def print_file(self, file, revno):
2426
828
"""See Branch.print_file."""
2427
return self.repository.print_file(file, revision_id)
2429
def _write_revision_history(self, history):
2430
"""Factored out of set_revision_history.
2432
This performs the actual writing to disk.
2433
It is intended to be called by BzrBranch5.set_revision_history."""
2434
self._transport.put_bytes(
2435
'revision-history', '\n'.join(history),
2436
mode=self.bzrdir._get_file_mode())
829
tree = self.revision_tree(self.get_rev_id(revno))
830
# use inventory as it was in that revision
831
file_id = tree.inventory.path2id(file)
833
raise BzrError("%r is not present in revision %s" % (file, revno))
834
tree.print_file(file_id)
837
def append_revision(self, *revision_ids):
838
"""See Branch.append_revision."""
839
for revision_id in revision_ids:
840
mutter("add {%s} to revision-history" % revision_id)
841
rev_history = self.revision_history()
842
rev_history.extend(revision_ids)
843
self.set_revision_history(rev_history)
2438
845
@needs_write_lock
2439
846
def set_revision_history(self, rev_history):
2440
847
"""See Branch.set_revision_history."""
2441
if 'evil' in debug.debug_flags:
2442
mutter_callsite(3, "set_revision_history scales with history.")
2443
check_not_reserved_id = _mod_revision.check_not_reserved_id
2444
for rev_id in rev_history:
2445
check_not_reserved_id(rev_id)
2446
if Branch.hooks['post_change_branch_tip']:
2447
# Don't calculate the last_revision_info() if there are no hooks
2449
old_revno, old_revid = self.last_revision_info()
2450
if len(rev_history) == 0:
2451
revid = _mod_revision.NULL_REVISION
848
self.put_controlfile('revision-history', '\n'.join(rev_history))
850
def has_revision(self, revision_id):
851
"""See Branch.has_revision."""
852
return (revision_id is None
853
or self.revision_store.has_id(revision_id))
856
def _get_revision_xml_file(self, revision_id):
857
if not revision_id or not isinstance(revision_id, basestring):
858
raise InvalidRevisionId(revision_id=revision_id, branch=self)
860
return self.revision_store.get(revision_id)
861
except (IndexError, KeyError):
862
raise bzrlib.errors.NoSuchRevision(self, revision_id)
864
def get_revision_xml(self, revision_id):
865
"""See Branch.get_revision_xml."""
866
return self._get_revision_xml_file(revision_id).read()
868
def get_revision(self, revision_id):
869
"""See Branch.get_revision."""
870
xml_file = self._get_revision_xml_file(revision_id)
873
r = bzrlib.xml5.serializer_v5.read_revision(xml_file)
874
except SyntaxError, e:
875
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
879
assert r.revision_id == revision_id
882
def get_revision_sha1(self, revision_id):
883
"""See Branch.get_revision_sha1."""
884
# In the future, revision entries will be signed. At that
885
# point, it is probably best *not* to include the signature
886
# in the revision hash. Because that lets you re-sign
887
# the revision, (add signatures/remove signatures) and still
888
# have all hash pointers stay consistent.
889
# But for now, just hash the contents.
890
return bzrlib.osutils.sha_file(self.get_revision_xml_file(revision_id))
892
def get_ancestry(self, revision_id):
893
"""See Branch.get_ancestry."""
894
if revision_id is None:
896
w = self._get_inventory_weave()
897
return [None] + map(w.idx_to_name,
898
w.inclusions([w.lookup(revision_id)]))
900
def _get_inventory_weave(self):
901
return self.control_weaves.get_weave('inventory',
902
self.get_transaction())
904
def get_inventory(self, revision_id):
905
"""See Branch.get_inventory."""
906
xml = self.get_inventory_xml(revision_id)
907
return bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
909
def get_inventory_xml(self, revision_id):
910
"""See Branch.get_inventory_xml."""
912
assert isinstance(revision_id, basestring), type(revision_id)
913
iw = self._get_inventory_weave()
914
return iw.get_text(iw.lookup(revision_id))
916
raise bzrlib.errors.HistoryMissing(self, 'inventory', revision_id)
918
def get_inventory_sha1(self, revision_id):
919
"""See Branch.get_inventory_sha1."""
920
return self.get_revision(revision_id).inventory_sha1
922
def get_revision_inventory(self, revision_id):
923
"""See Branch.get_revision_inventory."""
924
# TODO: Unify this with get_inventory()
925
# bzr 0.0.6 and later imposes the constraint that the inventory_id
926
# must be the same as its revision, so this is trivial.
927
if revision_id == None:
928
# This does not make sense: if there is no revision,
929
# then it is the current tree inventory surely ?!
930
# and thus get_root_id() is something that looks at the last
931
# commit on the branch, and the get_root_id is an inventory check.
932
raise NotImplementedError
933
# return Inventory(self.get_root_id())
2453
revid = rev_history[-1]
2454
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2455
self._write_revision_history(rev_history)
2456
self._clear_cached_state()
2457
self._cache_revision_history(rev_history)
2458
for hook in Branch.hooks['set_rh']:
2459
hook(self, rev_history)
2460
if Branch.hooks['post_change_branch_tip']:
2461
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2463
def _synchronize_history(self, destination, revision_id):
2464
"""Synchronize last revision and revision history between branches.
2466
This version is most efficient when the destination is also a
2467
BzrBranch5, but works for BzrBranch6 as long as the revision
2468
history is the true lefthand parent history, and all of the revisions
2469
are in the destination's repository. If not, set_revision_history
2472
:param destination: The branch to copy the history into
2473
:param revision_id: The revision-id to truncate history at. May
2474
be None to copy complete history.
2476
if not isinstance(destination._format, BzrBranchFormat5):
2477
super(BzrBranch, self)._synchronize_history(
2478
destination, revision_id)
935
return self.get_inventory(revision_id)
938
def revision_history(self):
939
"""See Branch.revision_history."""
940
transaction = self.get_transaction()
941
history = transaction.map.find_revision_history()
942
if history is not None:
943
mutter("cache hit for revision-history in %s", self)
945
history = [l.rstrip('\r\n') for l in
946
self.controlfile('revision-history', 'r').readlines()]
947
transaction.map.add_revision_history(history)
948
# this call is disabled because revision_history is
949
# not really an object yet, and the transaction is for objects.
950
# transaction.register_clean(history, precious=True)
953
def update_revisions(self, other, stop_revision=None):
954
"""See Branch.update_revisions."""
955
from bzrlib.fetch import greedy_fetch
956
if stop_revision is None:
957
stop_revision = other.last_revision()
958
### Should this be checking is_ancestor instead of revision_history?
959
if (stop_revision is not None and
960
stop_revision in self.revision_history()):
2480
if revision_id == _mod_revision.NULL_REVISION:
962
greedy_fetch(to_branch=self, from_branch=other,
963
revision=stop_revision)
964
pullable_revs = self.pullable_revisions(other, stop_revision)
965
if len(pullable_revs) > 0:
966
self.append_revision(*pullable_revs)
968
def pullable_revisions(self, other, stop_revision):
969
"""See Branch.pullable_revisions."""
970
other_revno = other.revision_id_to_revno(stop_revision)
972
return self.missing_revisions(other, other_revno)
973
except DivergedBranches, e:
975
pullable_revs = get_intervening_revisions(self.last_revision(),
977
assert self.last_revision() not in pullable_revs
979
except bzrlib.errors.NotAncestor:
980
if is_ancestor(self.last_revision(), stop_revision, self):
985
def revision_tree(self, revision_id):
986
"""See Branch.revision_tree."""
987
# TODO: refactor this to use an existing revision object
988
# so we don't need to read it in twice.
989
if revision_id == None or revision_id == NULL_REVISION:
2483
new_history = self.revision_history()
2484
if revision_id is not None and new_history != []:
992
inv = self.get_revision_inventory(revision_id)
993
return RevisionTree(self.weave_store, inv, revision_id)
995
def working_tree(self):
996
"""See Branch.working_tree."""
997
from bzrlib.workingtree import WorkingTree
998
if self._transport.base.find('://') != -1:
999
raise NoWorkingTree(self.base)
1000
return WorkingTree(self.base, branch=self)
1003
def pull(self, source, overwrite=False):
1004
"""See Branch.pull."""
1007
old_count = len(self.revision_history())
2486
new_history = new_history[:new_history.index(revision_id) + 1]
2488
rev = self.repository.get_revision(revision_id)
2489
new_history = rev.get_history(self.repository)[1:]
2490
destination.set_revision_history(new_history)
2493
def set_last_revision_info(self, revno, revision_id):
2494
"""Set the last revision of this branch.
2496
The caller is responsible for checking that the revno is correct
2497
for this revision id.
2499
It may be possible to set the branch last revision to an id not
2500
present in the repository. However, branches can also be
2501
configured to check constraints on history, in which case this may not
2504
revision_id = _mod_revision.ensure_null(revision_id)
2505
# this old format stores the full history, but this api doesn't
2506
# provide it, so we must generate, and might as well check it's
2508
history = self._lefthand_history(revision_id)
2509
if len(history) != revno:
2510
raise AssertionError('%d != %d' % (len(history), revno))
2511
self.set_revision_history(history)
2513
def _gen_revision_history(self):
2514
history = self._transport.get_bytes('revision-history').split('\n')
2515
if history[-1:] == ['']:
2516
# There shouldn't be a trailing newline, but just in case.
2521
def generate_revision_history(self, revision_id, last_rev=None,
2523
"""Create a new revision history that will finish with revision_id.
2525
:param revision_id: the new tip to use.
2526
:param last_rev: The previous last_revision. If not None, then this
2527
must be a ancestory of revision_id, or DivergedBranches is raised.
2528
:param other_branch: The other branch that DivergedBranches should
2529
raise with respect to.
2531
self.set_revision_history(self._lefthand_history(revision_id,
2532
last_rev, other_branch))
2534
def basis_tree(self):
2535
"""See Branch.basis_tree."""
2536
return self.repository.revision_tree(self.last_revision())
2538
def _get_parent_location(self):
1009
self.update_revisions(source)
1010
except DivergedBranches:
1013
self.set_revision_history(source.revision_history())
1014
new_count = len(self.revision_history())
1015
return new_count - old_count
1019
def get_parent(self):
1020
"""See Branch.get_parent."""
2539
1022
_locs = ['parent', 'pull', 'x-pull']
2540
1023
for l in _locs:
2542
return self._transport.get_bytes(l).strip('\n')
2543
except errors.NoSuchFile:
1025
return self.controlfile(l, 'r').read().strip('\n')
1027
if e.errno != errno.ENOENT:
2547
def _basic_push(self, target, overwrite, stop_revision):
2548
"""Basic implementation of push without bound branches or hooks.
2550
Must be called with source read locked and target write locked.
2552
result = BranchPushResult()
2553
result.source_branch = self
2554
result.target_branch = target
2555
result.old_revno, result.old_revid = target.last_revision_info()
2556
self.update_references(target)
2557
if result.old_revid != self.last_revision():
2558
# We assume that during 'push' this repository is closer than
2560
graph = self.repository.get_graph(target.repository)
2561
target.update_revisions(self, stop_revision,
2562
overwrite=overwrite, graph=graph)
2563
if self._push_should_merge_tags():
2564
result.tag_conflicts = self.tags.merge_to(target.tags,
2566
result.new_revno, result.new_revid = target.last_revision_info()
2569
def get_stacked_on_url(self):
2570
raise errors.UnstackableBranchFormat(self._format, self.user_url)
1031
def get_push_location(self):
1032
"""See Branch.get_push_location."""
1033
config = bzrlib.config.BranchConfig(self)
1034
push_loc = config.get_user_option('push_location')
2572
1037
def set_push_location(self, location):
2573
1038
"""See Branch.set_push_location."""
2574
self.get_config().set_user_option(
2575
'push_location', location,
2576
store=_mod_config.STORE_LOCATION_NORECURSE)
2578
def _set_parent_location(self, url):
2580
self._transport.delete('parent')
2582
self._transport.put_bytes('parent', url + '\n',
2583
mode=self.bzrdir._get_file_mode())
2586
class BzrBranch5(BzrBranch):
2587
"""A format 5 branch. This supports new features over plain branches.
2589
It has support for a master_branch which is the data for bound branches.
1039
config = bzrlib.config.LocationConfig(self.base)
1040
config.set_user_option('push_location', location)
1043
def set_parent(self, url):
1044
"""See Branch.set_parent."""
1045
# TODO: Maybe delete old location files?
1046
from bzrlib.atomicfile import AtomicFile
1047
f = AtomicFile(self.controlfilename('parent'))
1054
def tree_config(self):
1055
return TreeConfig(self)
1057
def sign_revision(self, revision_id, gpg_strategy):
1058
"""See Branch.sign_revision."""
1059
plaintext = Testament.from_revision(self, revision_id).as_short_text()
1060
self.store_revision_signature(gpg_strategy, plaintext, revision_id)
1063
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1064
"""See Branch.store_revision_signature."""
1065
self.revision_store.add(StringIO(gpg_strategy.sign(plaintext)),
1069
class ScratchBranch(BzrBranch):
1070
"""Special test class: a branch that cleans up after itself.
1072
>>> b = ScratchBranch()
1076
>>> b._transport.__del__()
2592
def get_bound_location(self):
2594
return self._transport.get_bytes('bound')[:-1]
2595
except errors.NoSuchFile:
2599
def get_master_branch(self, possible_transports=None):
2600
"""Return the branch we are bound to.
2602
:return: Either a Branch, or None
2604
This could memoise the branch, but if thats done
2605
it must be revalidated on each new lock.
2606
So for now we just don't memoise it.
2607
# RBC 20060304 review this decision.
2609
bound_loc = self.get_bound_location()
2613
return Branch.open(bound_loc,
2614
possible_transports=possible_transports)
2615
except (errors.NotBranchError, errors.ConnectionError), e:
2616
raise errors.BoundBranchConnectionFailure(
2620
def set_bound_location(self, location):
2621
"""Set the target where this branch is bound to.
2623
:param location: URL to the target branch
2626
self._transport.put_bytes('bound', location+'\n',
2627
mode=self.bzrdir._get_file_mode())
1081
def __init__(self, files=[], dirs=[], transport=None):
1082
"""Make a test branch.
1084
This creates a temporary directory and runs init-tree in it.
1086
If any files are listed, they are created in the working copy.
1088
if transport is None:
1089
transport = bzrlib.transport.local.ScratchTransport()
1090
super(ScratchBranch, self).__init__(transport, init=True)
2630
self._transport.delete('bound')
2631
except errors.NoSuchFile:
1092
super(ScratchBranch, self).__init__(transport)
1095
self._transport.mkdir(d)
1098
self._transport.put(f, 'content of %s' % f)
1103
>>> orig = ScratchBranch(files=["file1", "file2"])
1104
>>> clone = orig.clone()
1105
>>> if os.name != 'nt':
1106
... os.path.samefile(orig.base, clone.base)
1108
... orig.base == clone.base
1111
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1114
from shutil import copytree
1115
from tempfile import mkdtemp
1118
copytree(self.base, base, symlinks=True)
1119
return ScratchBranch(
1120
transport=bzrlib.transport.local.ScratchTransport(base))
1123
######################################################################
1127
def is_control_file(filename):
1128
## FIXME: better check
1129
filename = os.path.normpath(filename)
1130
while filename != '':
1131
head, tail = os.path.split(filename)
1132
## mutter('check %r for control file' % ((head, tail), ))
1133
if tail == bzrlib.BZRDIR:
2636
def bind(self, other):
2637
"""Bind this branch to the branch other.
2639
This does not push or pull data between the branches, though it does
2640
check for divergence to raise an error when the branches are not
2641
either the same, or one a prefix of the other. That behaviour may not
2642
be useful, so that check may be removed in future.
2644
:param other: The branch to bind to
2647
# TODO: jam 20051230 Consider checking if the target is bound
2648
# It is debatable whether you should be able to bind to
2649
# a branch which is itself bound.
2650
# Committing is obviously forbidden,
2651
# but binding itself may not be.
2652
# Since we *have* to check at commit time, we don't
2653
# *need* to check here
2655
# we want to raise diverged if:
2656
# last_rev is not in the other_last_rev history, AND
2657
# other_last_rev is not in our history, and do it without pulling
2659
self.set_bound_location(other.base)
2663
"""If bound, unbind"""
2664
return self.set_bound_location(None)
2667
def update(self, possible_transports=None):
2668
"""Synchronise this branch with the master branch if any.
2670
:return: None or the last_revision that was pivoted out during the
2673
master = self.get_master_branch(possible_transports)
2674
if master is not None:
2675
old_tip = _mod_revision.ensure_null(self.last_revision())
2676
self.pull(master, overwrite=True)
2677
if self.repository.get_graph().is_ancestor(old_tip,
2678
_mod_revision.ensure_null(self.last_revision())):
2684
class BzrBranch8(BzrBranch5):
2685
"""A branch that stores tree-reference locations."""
2687
def _open_hook(self):
2688
if self._ignore_fallbacks:
2691
url = self.get_stacked_on_url()
2692
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2693
errors.UnstackableBranchFormat):
2696
for hook in Branch.hooks['transform_fallback_location']:
2697
url = hook(self, url)
2699
hook_name = Branch.hooks.get_hook_name(hook)
2700
raise AssertionError(
2701
"'transform_fallback_location' hook %s returned "
2702
"None, not a URL." % hook_name)
2703
self._activate_fallback_location(url)
2705
def __init__(self, *args, **kwargs):
2706
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2707
super(BzrBranch8, self).__init__(*args, **kwargs)
2708
self._last_revision_info_cache = None
2709
self._reference_info = None
2711
def _clear_cached_state(self):
2712
super(BzrBranch8, self)._clear_cached_state()
2713
self._last_revision_info_cache = None
2714
self._reference_info = None
2716
def _last_revision_info(self):
2717
revision_string = self._transport.get_bytes('last-revision')
2718
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2719
revision_id = cache_utf8.get_cached_utf8(revision_id)
2721
return revno, revision_id
2723
def _write_last_revision_info(self, revno, revision_id):
2724
"""Simply write out the revision id, with no checks.
2726
Use set_last_revision_info to perform this safely.
2728
Does not update the revision_history cache.
2729
Intended to be called by set_last_revision_info and
2730
_write_revision_history.
2732
revision_id = _mod_revision.ensure_null(revision_id)
2733
out_string = '%d %s\n' % (revno, revision_id)
2734
self._transport.put_bytes('last-revision', out_string,
2735
mode=self.bzrdir._get_file_mode())
2738
def set_last_revision_info(self, revno, revision_id):
2739
revision_id = _mod_revision.ensure_null(revision_id)
2740
old_revno, old_revid = self.last_revision_info()
2741
if self._get_append_revisions_only():
2742
self._check_history_violation(revision_id)
2743
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2744
self._write_last_revision_info(revno, revision_id)
2745
self._clear_cached_state()
2746
self._last_revision_info_cache = revno, revision_id
2747
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2749
def _synchronize_history(self, destination, revision_id):
2750
"""Synchronize last revision and revision history between branches.
2752
:see: Branch._synchronize_history
2754
# XXX: The base Branch has a fast implementation of this method based
2755
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2756
# that uses set_revision_history. This class inherits from BzrBranch5,
2757
# but wants the fast implementation, so it calls
2758
# Branch._synchronize_history directly.
2759
Branch._synchronize_history(self, destination, revision_id)
2761
def _check_history_violation(self, revision_id):
2762
last_revision = _mod_revision.ensure_null(self.last_revision())
2763
if _mod_revision.is_null(last_revision):
2765
if last_revision not in self._lefthand_history(revision_id):
2766
raise errors.AppendRevisionsOnlyViolation(self.user_url)
2768
def _gen_revision_history(self):
2769
"""Generate the revision history from last revision
2771
last_revno, last_revision = self.last_revision_info()
2772
self._extend_partial_history(stop_index=last_revno-1)
2773
return list(reversed(self._partial_revision_history_cache))
2775
def _write_revision_history(self, history):
2776
"""Factored out of set_revision_history.
2778
This performs the actual writing to disk, with format-specific checks.
2779
It is intended to be called by BzrBranch5.set_revision_history.
2781
if len(history) == 0:
2782
last_revision = 'null:'
2784
if history != self._lefthand_history(history[-1]):
2785
raise errors.NotLefthandHistory(history)
2786
last_revision = history[-1]
2787
if self._get_append_revisions_only():
2788
self._check_history_violation(last_revision)
2789
self._write_last_revision_info(len(history), last_revision)
2792
def _set_parent_location(self, url):
2793
"""Set the parent branch"""
2794
self._set_config_location('parent_location', url, make_relative=True)
2797
def _get_parent_location(self):
2798
"""Set the parent branch"""
2799
return self._get_config_location('parent_location')
2802
def _set_all_reference_info(self, info_dict):
2803
"""Replace all reference info stored in a branch.
2805
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2808
writer = rio.RioWriter(s)
2809
for key, (tree_path, branch_location) in info_dict.iteritems():
2810
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2811
branch_location=branch_location)
2812
writer.write_stanza(stanza)
2813
self._transport.put_bytes('references', s.getvalue())
2814
self._reference_info = info_dict
2817
def _get_all_reference_info(self):
2818
"""Return all the reference info stored in a branch.
2820
:return: A dict of {file_id: (tree_path, branch_location)}
2822
if self._reference_info is not None:
2823
return self._reference_info
2824
rio_file = self._transport.get('references')
2826
stanzas = rio.read_stanzas(rio_file)
2827
info_dict = dict((s['file_id'], (s['tree_path'],
2828
s['branch_location'])) for s in stanzas)
2831
self._reference_info = info_dict
2834
def set_reference_info(self, file_id, tree_path, branch_location):
2835
"""Set the branch location to use for a tree reference.
2837
:param file_id: The file-id of the tree reference.
2838
:param tree_path: The path of the tree reference in the tree.
2839
:param branch_location: The location of the branch to retrieve tree
2842
info_dict = self._get_all_reference_info()
2843
info_dict[file_id] = (tree_path, branch_location)
2844
if None in (tree_path, branch_location):
2845
if tree_path is not None:
2846
raise ValueError('tree_path must be None when branch_location'
2848
if branch_location is not None:
2849
raise ValueError('branch_location must be None when tree_path'
2851
del info_dict[file_id]
2852
self._set_all_reference_info(info_dict)
2854
def get_reference_info(self, file_id):
2855
"""Get the tree_path and branch_location for a tree reference.
2857
:return: a tuple of (tree_path, branch_location)
2859
return self._get_all_reference_info().get(file_id, (None, None))
2861
def reference_parent(self, file_id, path, possible_transports=None):
2862
"""Return the parent branch for a tree-reference file_id.
2864
:param file_id: The file_id of the tree reference
2865
:param path: The path of the file_id in the tree
2866
:return: A branch associated with the file_id
2868
branch_location = self.get_reference_info(file_id)[1]
2869
if branch_location is None:
2870
return Branch.reference_parent(self, file_id, path,
2871
possible_transports)
2872
branch_location = urlutils.join(self.user_url, branch_location)
2873
return Branch.open(branch_location,
2874
possible_transports=possible_transports)
2876
def set_push_location(self, location):
2877
"""See Branch.set_push_location."""
2878
self._set_config_location('push_location', location)
2880
def set_bound_location(self, location):
2881
"""See Branch.set_push_location."""
2883
config = self.get_config()
2884
if location is None:
2885
if config.get_user_option('bound') != 'True':
2888
config.set_user_option('bound', 'False', warn_masked=True)
2891
self._set_config_location('bound_location', location,
2893
config.set_user_option('bound', 'True', warn_masked=True)
2896
def _get_bound_location(self, bound):
2897
"""Return the bound location in the config file.
2899
Return None if the bound parameter does not match"""
2900
config = self.get_config()
2901
config_bound = (config.get_user_option('bound') == 'True')
2902
if config_bound != bound:
2904
return self._get_config_location('bound_location', config=config)
2906
def get_bound_location(self):
2907
"""See Branch.set_push_location."""
2908
return self._get_bound_location(True)
2910
def get_old_bound_location(self):
2911
"""See Branch.get_old_bound_location"""
2912
return self._get_bound_location(False)
2914
def get_stacked_on_url(self):
2915
# you can always ask for the URL; but you might not be able to use it
2916
# if the repo can't support stacking.
2917
## self._check_stackable_repo()
2918
stacked_url = self._get_config_location('stacked_on_location')
2919
if stacked_url is None:
2920
raise errors.NotStacked(self)
2923
def _get_append_revisions_only(self):
2924
return self.get_config(
2925
).get_user_option_as_bool('append_revisions_only')
2928
def generate_revision_history(self, revision_id, last_rev=None,
2930
"""See BzrBranch5.generate_revision_history"""
2931
history = self._lefthand_history(revision_id, last_rev, other_branch)
2932
revno = len(history)
2933
self.set_last_revision_info(revno, revision_id)
2936
def get_rev_id(self, revno, history=None):
2937
"""Find the revision id of the specified revno."""
2939
return _mod_revision.NULL_REVISION
2941
last_revno, last_revision_id = self.last_revision_info()
2942
if revno <= 0 or revno > last_revno:
2943
raise errors.NoSuchRevision(self, revno)
2945
if history is not None:
2946
return history[revno - 1]
2948
index = last_revno - revno
2949
if len(self._partial_revision_history_cache) <= index:
2950
self._extend_partial_history(stop_index=index)
2951
if len(self._partial_revision_history_cache) > index:
2952
return self._partial_revision_history_cache[index]
2954
raise errors.NoSuchRevision(self, revno)
2957
def revision_id_to_revno(self, revision_id):
2958
"""Given a revision id, return its revno"""
2959
if _mod_revision.is_null(revision_id):
2962
index = self._partial_revision_history_cache.index(revision_id)
2964
self._extend_partial_history(stop_revision=revision_id)
2965
index = len(self._partial_revision_history_cache) - 1
2966
if self._partial_revision_history_cache[index] != revision_id:
2967
raise errors.NoSuchRevision(self, revision_id)
2968
return self.revno() - index
2971
class BzrBranch7(BzrBranch8):
2972
"""A branch with support for a fallback repository."""
2974
def set_reference_info(self, file_id, tree_path, branch_location):
2975
Branch.set_reference_info(self, file_id, tree_path, branch_location)
2977
def get_reference_info(self, file_id):
2978
Branch.get_reference_info(self, file_id)
2980
def reference_parent(self, file_id, path, possible_transports=None):
2981
return Branch.reference_parent(self, file_id, path,
2982
possible_transports)
2985
class BzrBranch6(BzrBranch7):
2986
"""See BzrBranchFormat6 for the capabilities of this branch.
2988
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2992
def get_stacked_on_url(self):
2993
raise errors.UnstackableBranchFormat(self._format, self.user_url)
2996
######################################################################
2997
# results of operations
3000
class _Result(object):
3002
def _show_tag_conficts(self, to_file):
3003
if not getattr(self, 'tag_conflicts', None):
3005
to_file.write('Conflicting tags:\n')
3006
for name, value1, value2 in self.tag_conflicts:
3007
to_file.write(' %s\n' % (name, ))
3010
class PullResult(_Result):
3011
"""Result of a Branch.pull operation.
3013
:ivar old_revno: Revision number before pull.
3014
:ivar new_revno: Revision number after pull.
3015
:ivar old_revid: Tip revision id before pull.
3016
:ivar new_revid: Tip revision id after pull.
3017
:ivar source_branch: Source (local) branch object. (read locked)
3018
:ivar master_branch: Master branch of the target, or the target if no
3020
:ivar local_branch: target branch if there is a Master, else None
3021
:ivar target_branch: Target/destination branch object. (write locked)
3022
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
3026
# DEPRECATED: pull used to return the change in revno
3027
return self.new_revno - self.old_revno
3029
def report(self, to_file):
3031
if self.old_revid == self.new_revid:
3032
to_file.write('No revisions to pull.\n')
3034
to_file.write('Now on revision %d.\n' % self.new_revno)
3035
self._show_tag_conficts(to_file)
3038
class BranchPushResult(_Result):
3039
"""Result of a Branch.push operation.
3041
:ivar old_revno: Revision number (eg 10) of the target before push.
3042
:ivar new_revno: Revision number (eg 12) of the target after push.
3043
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
3045
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
3047
:ivar source_branch: Source branch object that the push was from. This is
3048
read locked, and generally is a local (and thus low latency) branch.
3049
:ivar master_branch: If target is a bound branch, the master branch of
3050
target, or target itself. Always write locked.
3051
:ivar target_branch: The direct Branch where data is being sent (write
3053
:ivar local_branch: If the target is a bound branch this will be the
3054
target, otherwise it will be None.
3058
# DEPRECATED: push used to return the change in revno
3059
return self.new_revno - self.old_revno
3061
def report(self, to_file):
3062
"""Write a human-readable description of the result."""
3063
if self.old_revid == self.new_revid:
3064
note('No new revisions to push.')
3066
note('Pushed up to revision %d.' % self.new_revno)
3067
self._show_tag_conficts(to_file)
3070
class BranchCheckResult(object):
3071
"""Results of checking branch consistency.
3076
def __init__(self, branch):
3077
self.branch = branch
3080
def report_results(self, verbose):
3081
"""Report the check results via trace.note.
3083
:param verbose: Requests more detailed display of what was checked,
3086
note('checked branch %s format %s', self.branch.user_url,
3087
self.branch._format)
3088
for error in self.errors:
3089
note('found error:%s', error)
3092
class Converter5to6(object):
3093
"""Perform an in-place upgrade of format 5 to format 6"""
3095
def convert(self, branch):
3096
# Data for 5 and 6 can peacefully coexist.
3097
format = BzrBranchFormat6()
3098
new_branch = format.open(branch.bzrdir, _found=True)
3100
# Copy source data into target
3101
new_branch._write_last_revision_info(*branch.last_revision_info())
3102
new_branch.set_parent(branch.get_parent())
3103
new_branch.set_bound_location(branch.get_bound_location())
3104
new_branch.set_push_location(branch.get_push_location())
3106
# New branch has no tags by default
3107
new_branch.tags._set_tag_dict({})
3109
# Copying done; now update target format
3110
new_branch._transport.put_bytes('format',
3111
format.get_format_string(),
3112
mode=new_branch.bzrdir._get_file_mode())
3114
# Clean up old files
3115
new_branch._transport.delete('revision-history')
3117
branch.set_parent(None)
3118
except errors.NoSuchFile:
3120
branch.set_bound_location(None)
3123
class Converter6to7(object):
3124
"""Perform an in-place upgrade of format 6 to format 7"""
3126
def convert(self, branch):
3127
format = BzrBranchFormat7()
3128
branch._set_config_location('stacked_on_location', '')
3129
# update target format
3130
branch._transport.put_bytes('format', format.get_format_string())
3133
class Converter7to8(object):
3134
"""Perform an in-place upgrade of format 6 to format 7"""
3136
def convert(self, branch):
3137
format = BzrBranchFormat8()
3138
branch._transport.put_bytes('references', '')
3139
# update target format
3140
branch._transport.put_bytes('format', format.get_format_string())
3143
def _run_with_write_locked_target(target, callable, *args, **kwargs):
3144
"""Run ``callable(*args, **kwargs)``, write-locking target for the
3147
_run_with_write_locked_target will attempt to release the lock it acquires.
3149
If an exception is raised by callable, then that exception *will* be
3150
propagated, even if the unlock attempt raises its own error. Thus
3151
_run_with_write_locked_target should be preferred to simply doing::
3155
return callable(*args, **kwargs)
3160
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
3161
# should share code?
3164
result = callable(*args, **kwargs)
3166
exc_info = sys.exc_info()
3170
raise exc_info[0], exc_info[1], exc_info[2]
3176
class InterBranch(InterObject):
3177
"""This class represents operations taking place between two branches.
3179
Its instances have methods like pull() and push() and contain
3180
references to the source and target repositories these operations
3181
can be carried out on.
3185
"""The available optimised InterBranch types."""
3188
def _get_branch_formats_to_test():
3189
"""Return a tuple with the Branch formats to use when testing."""
3190
raise NotImplementedError(InterBranch._get_branch_formats_to_test)
3192
def pull(self, overwrite=False, stop_revision=None,
3193
possible_transports=None, local=False):
3194
"""Mirror source into target branch.
3196
The target branch is considered to be 'local', having low latency.
3198
:returns: PullResult instance
3200
raise NotImplementedError(self.pull)
3202
def update_revisions(self, stop_revision=None, overwrite=False,
3204
"""Pull in new perfect-fit revisions.
3206
:param stop_revision: Updated until the given revision
3207
:param overwrite: Always set the branch pointer, rather than checking
3208
to see if it is a proper descendant.
3209
:param graph: A Graph object that can be used to query history
3210
information. This can be None.
3213
raise NotImplementedError(self.update_revisions)
3215
def push(self, overwrite=False, stop_revision=None,
3216
_override_hook_source_branch=None):
3217
"""Mirror the source branch into the target branch.
3219
The source branch is considered to be 'local', having low latency.
3221
raise NotImplementedError(self.push)
3224
class GenericInterBranch(InterBranch):
3225
"""InterBranch implementation that uses public Branch functions.
3229
def _get_branch_formats_to_test():
3230
return BranchFormat._default_format, BranchFormat._default_format
3232
def update_revisions(self, stop_revision=None, overwrite=False,
3234
"""See InterBranch.update_revisions()."""
3235
self.source.lock_read()
3237
other_revno, other_last_revision = self.source.last_revision_info()
3238
stop_revno = None # unknown
3239
if stop_revision is None:
3240
stop_revision = other_last_revision
3241
if _mod_revision.is_null(stop_revision):
3242
# if there are no commits, we're done.
3244
stop_revno = other_revno
3246
# what's the current last revision, before we fetch [and change it
3248
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3249
# we fetch here so that we don't process data twice in the common
3250
# case of having something to pull, and so that the check for
3251
# already merged can operate on the just fetched graph, which will
3252
# be cached in memory.
3253
self.target.fetch(self.source, stop_revision)
3254
# Check to see if one is an ancestor of the other
3257
graph = self.target.repository.get_graph()
3258
if self.target._check_if_descendant_or_diverged(
3259
stop_revision, last_rev, graph, self.source):
3260
# stop_revision is a descendant of last_rev, but we aren't
3261
# overwriting, so we're done.
3263
if stop_revno is None:
3265
graph = self.target.repository.get_graph()
3266
this_revno, this_last_revision = \
3267
self.target.last_revision_info()
3268
stop_revno = graph.find_distance_to_null(stop_revision,
3269
[(other_last_revision, other_revno),
3270
(this_last_revision, this_revno)])
3271
self.target.set_last_revision_info(stop_revno, stop_revision)
3273
self.source.unlock()
3275
def pull(self, overwrite=False, stop_revision=None,
3276
possible_transports=None, _hook_master=None, run_hooks=True,
3277
_override_hook_target=None, local=False):
3280
:param _hook_master: Private parameter - set the branch to
3281
be supplied as the master to pull hooks.
3282
:param run_hooks: Private parameter - if false, this branch
3283
is being called because it's the master of the primary branch,
3284
so it should not run its hooks.
3285
:param _override_hook_target: Private parameter - set the branch to be
3286
supplied as the target_branch to pull hooks.
3287
:param local: Only update the local branch, and not the bound branch.
3289
# This type of branch can't be bound.
3291
raise errors.LocalRequiresBoundBranch()
3292
result = PullResult()
3293
result.source_branch = self.source
3294
if _override_hook_target is None:
3295
result.target_branch = self.target
3297
result.target_branch = _override_hook_target
3298
self.source.lock_read()
3300
# We assume that during 'pull' the target repository is closer than
3302
self.source.update_references(self.target)
3303
graph = self.target.repository.get_graph(self.source.repository)
3304
# TODO: Branch formats should have a flag that indicates
3305
# that revno's are expensive, and pull() should honor that flag.
3307
result.old_revno, result.old_revid = \
3308
self.target.last_revision_info()
3309
self.target.update_revisions(self.source, stop_revision,
3310
overwrite=overwrite, graph=graph)
3311
# TODO: The old revid should be specified when merging tags,
3312
# so a tags implementation that versions tags can only
3313
# pull in the most recent changes. -- JRV20090506
3314
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3316
result.new_revno, result.new_revid = self.target.last_revision_info()
3318
result.master_branch = _hook_master
3319
result.local_branch = result.target_branch
3321
result.master_branch = result.target_branch
3322
result.local_branch = None
3324
for hook in Branch.hooks['post_pull']:
3327
self.source.unlock()
3330
def push(self, overwrite=False, stop_revision=None,
3331
_override_hook_source_branch=None):
3332
"""See InterBranch.push.
3334
This is the basic concrete implementation of push()
3336
:param _override_hook_source_branch: If specified, run
3337
the hooks passing this Branch as the source, rather than self.
3338
This is for use of RemoteBranch, where push is delegated to the
3339
underlying vfs-based Branch.
3341
# TODO: Public option to disable running hooks - should be trivial but
3343
self.source.lock_read()
3345
return _run_with_write_locked_target(
3346
self.target, self._push_with_bound_branches, overwrite,
3348
_override_hook_source_branch=_override_hook_source_branch)
3350
self.source.unlock()
3352
def _push_with_bound_branches(self, overwrite, stop_revision,
3353
_override_hook_source_branch=None):
3354
"""Push from source into target, and into target's master if any.
3357
if _override_hook_source_branch:
3358
result.source_branch = _override_hook_source_branch
3359
for hook in Branch.hooks['post_push']:
3362
bound_location = self.target.get_bound_location()
3363
if bound_location and self.target.base != bound_location:
3364
# there is a master branch.
3366
# XXX: Why the second check? Is it even supported for a branch to
3367
# be bound to itself? -- mbp 20070507
3368
master_branch = self.target.get_master_branch()
3369
master_branch.lock_write()
3371
# push into the master from the source branch.
3372
self.source._basic_push(master_branch, overwrite, stop_revision)
3373
# and push into the target branch from the source. Note that we
3374
# push from the source branch again, because its considered the
3375
# highest bandwidth repository.
3376
result = self.source._basic_push(self.target, overwrite,
3378
result.master_branch = master_branch
3379
result.local_branch = self.target
3383
master_branch.unlock()
3386
result = self.source._basic_push(self.target, overwrite,
3388
# TODO: Why set master_branch and local_branch if there's no
3389
# binding? Maybe cleaner to just leave them unset? -- mbp
3391
result.master_branch = self.target
3392
result.local_branch = None
3397
def is_compatible(self, source, target):
3398
# GenericBranch uses the public API, so always compatible
3402
class InterToBranch5(GenericInterBranch):
3405
def _get_branch_formats_to_test():
3406
return BranchFormat._default_format, BzrBranchFormat5()
3408
def pull(self, overwrite=False, stop_revision=None,
3409
possible_transports=None, run_hooks=True,
3410
_override_hook_target=None, local=False):
3411
"""Pull from source into self, updating my master if any.
3413
:param run_hooks: Private parameter - if false, this branch
3414
is being called because it's the master of the primary branch,
3415
so it should not run its hooks.
3417
bound_location = self.target.get_bound_location()
3418
if local and not bound_location:
3419
raise errors.LocalRequiresBoundBranch()
3420
master_branch = None
3421
if not local and bound_location and self.source.user_url != bound_location:
3422
# not pulling from master, so we need to update master.
3423
master_branch = self.target.get_master_branch(possible_transports)
3424
master_branch.lock_write()
3427
# pull from source into master.
3428
master_branch.pull(self.source, overwrite, stop_revision,
3430
return super(InterToBranch5, self).pull(overwrite,
3431
stop_revision, _hook_master=master_branch,
3432
run_hooks=run_hooks,
3433
_override_hook_target=_override_hook_target)
3436
master_branch.unlock()
3439
InterBranch.register_optimiser(GenericInterBranch)
3440
InterBranch.register_optimiser(InterToBranch5)
1135
if filename == head:
added
removed
bzrlib/branch.py
