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
18
from copy import deepcopy
18
19
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
24
from unittest import TestSuite
25
from warnings import warn
27
import xml.sax.saxutils
29
raise ImportError("We were unable to import 'xml.sax.saxutils',"
30
" most likely you have an xml.pyc or xml.pyo file"
31
" lying around in your bzrlib directory."
33
from cStringIO import StringIO
37
from bzrlib.config import TreeConfig
38
from bzrlib.decorators import needs_read_lock, needs_write_lock
39
from bzrlib.delta import compare_trees
40
import bzrlib.errors as errors
41
from bzrlib.errors import (BzrError, InvalidRevisionNumber, InvalidRevisionId,
42
NoSuchRevision, HistoryMissing, NotBranchError,
43
DivergedBranches, LockError,
44
UninitializableFormat,
46
UnlistableBranch, NoSuchFile, NotVersionedError,
48
import bzrlib.inventory as inventory
49
from bzrlib.inventory import Inventory
50
from bzrlib.lockable_files import LockableFiles
51
from bzrlib.osutils import (isdir, quotefn,
52
rename, splitpath, sha_file,
53
file_kind, abspath, normpath, pathjoin,
56
from bzrlib.textui import show_status
57
from bzrlib.trace import mutter, note
58
from bzrlib.tree import EmptyTree, RevisionTree
59
from bzrlib.repository import Repository
60
from bzrlib.revision import (Revision, is_ancestor, get_intervening_revisions)
61
from bzrlib.store import copy_all
62
from bzrlib.symbol_versioning import *
63
import bzrlib.transactions as transactions
64
from bzrlib.transport import Transport, get_transport
65
from bzrlib.tree import EmptyTree, RevisionTree
61
70
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
62
71
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):
72
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
75
# TODO: Maybe include checks for common corruption of newlines, etc?
77
# TODO: Some operations like log might retrieve the same revisions
78
# repeatedly to calculate deltas. We could perhaps have a weakref
79
# cache in memory to make this faster. In general anything can be
80
# cached in memory between lock and unlock operations. .. nb thats
81
# what the transaction identity map provides
84
######################################################################
67
88
"""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.
91
Base directory/url of the branch.
75
93
# 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
97
_default_initializer = None
98
"""The default initializer for making new branches."""
87
100
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):
101
raise NotImplementedError('The Branch class is abstract')
104
def open_downlevel(base):
105
"""Open a branch which may be of an old format."""
106
return Branch.open(base, _unsupported=True)
109
def open(base, _unsupported=False):
110
"""Open an existing branch, rooted at 'base' (url)
112
_unsupported is a private parameter to the Branch class.
114
t = get_transport(base)
115
mutter("trying to open %r with transport %r", base, t)
116
format = BzrBranchFormat.find_format(t)
117
if not _unsupported and not format.is_supported():
118
# see open_downlevel to open legacy branches.
119
raise errors.UnsupportedFormatError(
120
'sorry, branch format %s not supported' % format,
121
['use a different bzr version',
122
'or remove the .bzr directory'
123
' and "bzr init" again'])
124
return format.open(t)
127
def open_containing(url):
177
128
"""Open an existing branch which contains url.
179
130
This probes for a branch at url, and searches upwards from there.
181
132
Basically we keep looking up until we find the control directory or
182
133
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
134
If there is one and it is either an unrecognised format or an unsupported
184
135
format, UnknownFormatError or UnsupportedFormatError are raised.
185
136
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():
138
t = get_transport(url)
139
# this gets the normalised url back. I.e. '.' -> the full path.
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()
143
format = BzrBranchFormat.find_format(t)
144
return format.open(t), t.relpath(url)
145
except NotBranchError, e:
146
mutter('not a branch in: %r %s', t.base, e)
147
new_t = t.clone('..')
148
if new_t.base == t.base:
149
# reached the root, whatever that may be
150
raise NotBranchError(path=url)
155
"""Create a new Branch at the url 'bzr'.
157
This will call the current default initializer with base
158
as the only parameter.
160
return Branch._default_initializer(safe_unicode(base))
163
@deprecated_function(zero_eight)
164
def initialize(base):
165
"""Create a new working tree and branch, rooted at 'base' (url)
167
NOTE: This will soon be deprecated in favour of creation
170
# imported here to prevent scope creep as this is going.
171
from bzrlib.workingtree import WorkingTree
172
return WorkingTree.create_standalone(safe_unicode(base)).branch
175
def get_default_initializer():
176
"""Return the initializer being used for new branches."""
177
return Branch._default_initializer
180
def set_default_initializer(initializer):
181
"""Set the initializer to be used for new branches."""
182
Branch._default_initializer = staticmethod(initializer)
184
def setup_caching(self, cache_root):
185
"""Subclasses that care about caching should override this, and set
186
up cached stores located under cache_root.
188
# seems to be unused, 2006-01-13 mbp
189
warn('%s is deprecated' % self.setup_caching)
190
self.cache_root = cache_root
193
cfg = self.tree_config()
194
return cfg.get_option(u"nickname", default=self.base.split('/')[-2])
251
196
def _set_nick(self, nick):
252
self.get_config().set_user_option('nickname', nick, warn_masked=True)
197
cfg = self.tree_config()
198
cfg.set_option(nick, "nickname")
199
assert cfg.get_option("nickname") == nick
254
201
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.
293
raise NotImplementedError(self.lock_write)
203
def push_stores(self, branch_to):
204
"""Copy the content of this branches store to branch_to."""
205
raise NotImplementedError('push_stores is abstract')
207
def lock_write(self):
208
raise NotImplementedError('lock_write is abstract')
295
210
def lock_read(self):
296
"""Lock the branch for read operations.
298
:return: A bzrlib.lock.LogicalLockResult.
300
raise NotImplementedError(self.lock_read)
211
raise NotImplementedError('lock_read is abstract')
302
213
def unlock(self):
303
raise NotImplementedError(self.unlock)
214
raise NotImplementedError('unlock is abstract')
305
216
def peek_lock_mode(self):
306
217
"""Return lock mode for the Branch: 'r', 'w' or None"""
307
218
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
705
def get_revision_delta(self, revno):
706
"""Return the delta for one revision.
708
The delta is relative to its mainline predecessor, or the
709
empty tree for revision 1.
711
rh = self.revision_history()
712
if not (1 <= revno <= len(rh)):
713
raise errors.InvalidRevisionNumber(revno)
714
return self.repository.get_revision_delta(rh[revno-1])
716
def get_stacked_on_url(self):
717
"""Get the URL this branch is stacked against.
719
:raises NotStacked: If the branch is not stacked.
720
:raises UnstackableBranchFormat: If the branch does not support
723
raise NotImplementedError(self.get_stacked_on_url)
220
def abspath(self, name):
221
"""Return absolute filename for something in the branch
223
XXX: Robert Collins 20051017 what is this used for? why is it a branch
224
method and not a tree method.
226
raise NotImplementedError('abspath is abstract')
228
def get_root_id(self):
229
"""Return the id of this branches root"""
230
raise NotImplementedError('get_root_id is abstract')
725
232
def print_file(self, file, revision_id):
726
233
"""Print `file` to stdout."""
727
raise NotImplementedError(self.print_file)
234
raise NotImplementedError('print_file is abstract')
236
def append_revision(self, *revision_ids):
237
raise NotImplementedError('append_revision is abstract')
729
239
def set_revision_history(self, rev_history):
730
raise NotImplementedError(self.set_revision_history)
733
def set_parent(self, url):
734
"""See Branch.set_parent."""
735
# TODO: Maybe delete old location files?
736
# URLs should never be unicode, even on the local fs,
737
# FIXUP this and get_parent in a future branch format bump:
738
# read and rewrite the file. RBC 20060125
740
if isinstance(url, unicode):
742
url = url.encode('ascii')
743
except UnicodeEncodeError:
744
raise errors.InvalidURL(url,
745
"Urls must be 7-bit ascii, "
746
"use bzrlib.urlutils.escape")
747
url = urlutils.relative_url(self.base, url)
748
self._set_parent_location(url)
751
def set_stacked_on_url(self, url):
752
"""Set the URL this branch is stacked against.
754
:raises UnstackableBranchFormat: If the branch does not support
756
:raises UnstackableRepositoryFormat: If the repository does not support
759
if not self._format.supports_stacking():
760
raise errors.UnstackableBranchFormat(self._format, self.user_url)
761
# XXX: Changing from one fallback repository to another does not check
762
# that all the data you need is present in the new fallback.
763
# Possibly it should.
764
self._check_stackable_repo()
767
old_url = self.get_stacked_on_url()
768
except (errors.NotStacked, errors.UnstackableBranchFormat,
769
errors.UnstackableRepositoryFormat):
773
self._activate_fallback_location(url)
774
# write this out after the repository is stacked to avoid setting a
775
# stacked config that doesn't work.
776
self._set_config_location('stacked_on_location', url)
779
"""Change a branch to be unstacked, copying data as needed.
781
Don't call this directly, use set_stacked_on_url(None).
783
pb = ui.ui_factory.nested_progress_bar()
785
pb.update("Unstacking")
786
# The basic approach here is to fetch the tip of the branch,
787
# including all available ghosts, from the existing stacked
788
# repository into a new repository object without the fallbacks.
790
# XXX: See <https://launchpad.net/bugs/397286> - this may not be
791
# correct for CHKMap repostiories
792
old_repository = self.repository
793
if len(old_repository._fallback_repositories) != 1:
794
raise AssertionError("can't cope with fallback repositories "
795
"of %r" % (self.repository,))
796
# unlock it, including unlocking the fallback
797
old_repository.unlock()
798
old_repository.lock_read()
800
# Repositories don't offer an interface to remove fallback
801
# repositories today; take the conceptually simpler option and just
802
# reopen it. We reopen it starting from the URL so that we
803
# get a separate connection for RemoteRepositories and can
804
# stream from one of them to the other. This does mean doing
805
# separate SSH connection setup, but unstacking is not a
806
# common operation so it's tolerable.
807
new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
808
new_repository = new_bzrdir.find_repository()
809
self.repository = new_repository
810
if self.repository._fallback_repositories:
811
raise AssertionError("didn't expect %r to have "
812
"fallback_repositories"
813
% (self.repository,))
814
# this is not paired with an unlock because it's just restoring
815
# the previous state; the lock's released when set_stacked_on_url
817
self.repository.lock_write()
818
# XXX: If you unstack a branch while it has a working tree
819
# with a pending merge, the pending-merged revisions will no
820
# longer be present. You can (probably) revert and remerge.
822
# XXX: This only fetches up to the tip of the repository; it
823
# doesn't bring across any tags. That's fairly consistent
824
# with how branch works, but perhaps not ideal.
825
self.repository.fetch(old_repository,
826
revision_id=self.last_revision(),
829
old_repository.unlock()
833
def _set_tags_bytes(self, bytes):
834
"""Mirror method for _get_tags_bytes.
836
:seealso: Branch._get_tags_bytes.
838
return _run_with_write_locked_target(self, self._transport.put_bytes,
841
def _cache_revision_history(self, rev_history):
842
"""Set the cached revision history to rev_history.
844
The revision_history method will use this cache to avoid regenerating
845
the revision history.
847
This API is semi-public; it only for use by subclasses, all other code
848
should consider it to be private.
850
self._revision_history_cache = rev_history
852
def _cache_revision_id_to_revno(self, revision_id_to_revno):
853
"""Set the cached revision_id => revno map to revision_id_to_revno.
855
This API is semi-public; it only for use by subclasses, all other code
856
should consider it to be private.
858
self._revision_id_to_revno_cache = revision_id_to_revno
860
def _clear_cached_state(self):
861
"""Clear any cached data on this branch, e.g. cached revision history.
863
This means the next call to revision_history will need to call
864
_gen_revision_history.
866
This API is semi-public; it only for use by subclasses, all other code
867
should consider it to be private.
869
self._revision_history_cache = None
870
self._revision_id_to_revno_cache = None
871
self._last_revision_info_cache = None
872
self._merge_sorted_revisions_cache = None
873
self._partial_revision_history_cache = []
874
self._partial_revision_id_to_revno_cache = {}
876
def _gen_revision_history(self):
877
"""Return sequence of revision hashes on to this branch.
879
Unlike revision_history, this method always regenerates or rereads the
880
revision history, i.e. it does not cache the result, so repeated calls
883
Concrete subclasses should override this instead of revision_history so
884
that subclasses do not need to deal with caching logic.
886
This API is semi-public; it only for use by subclasses, all other code
887
should consider it to be private.
889
raise NotImplementedError(self._gen_revision_history)
240
raise NotImplementedError('set_revision_history is abstract')
892
242
def revision_history(self):
893
"""Return sequence of revision ids on this branch.
895
This method will cache the revision history for as long as it is safe to
898
if 'evil' in debug.debug_flags:
899
mutter_callsite(3, "revision_history scales with history.")
900
if self._revision_history_cache is not None:
901
history = self._revision_history_cache
903
history = self._gen_revision_history()
904
self._cache_revision_history(history)
243
"""Return sequence of revision hashes on to this branch."""
244
raise NotImplementedError('revision_history is abstract')
908
247
"""Return current revision number for this branch.
952
293
common_index = min(self_len, other_len) -1
953
294
if common_index >= 0 and \
954
295
self_history[common_index] != other_history[common_index]:
955
raise errors.DivergedBranches(self, other)
296
raise DivergedBranches(self, other)
957
298
if stop_revision is None:
958
299
stop_revision = other_len
301
assert isinstance(stop_revision, int)
960
302
if stop_revision > other_len:
961
raise errors.NoSuchRevision(self, stop_revision)
303
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
962
304
return other_history[self_len:stop_revision]
965
def update_revisions(self, other, stop_revision=None, overwrite=False,
967
"""Pull in new perfect-fit revisions.
969
:param other: Another Branch to pull from
970
:param stop_revision: Updated until the given revision
971
:param overwrite: Always set the branch pointer, rather than checking
972
to see if it is a proper descendant.
973
:param graph: A Graph object that can be used to query history
974
information. This can be None.
977
return InterBranch.get(other, self).update_revisions(stop_revision,
980
def import_last_revision_info(self, source_repo, revno, revid):
981
"""Set the last revision info, importing from another repo if necessary.
983
This is used by the bound branch code to upload a revision to
984
the master branch first before updating the tip of the local branch.
986
:param source_repo: Source repository to optionally fetch from
987
:param revno: Revision number of the new tip
988
:param revid: Revision id of the new tip
990
if not self.repository.has_same_location(source_repo):
991
self.repository.fetch(source_repo, revision_id=revid)
992
self.set_last_revision_info(revno, revid)
306
def update_revisions(self, other, stop_revision=None):
307
"""Pull in new perfect-fit revisions."""
308
raise NotImplementedError('update_revisions is abstract')
310
def pullable_revisions(self, other, stop_revision):
311
raise NotImplementedError('pullable_revisions is abstract')
994
313
def revision_id_to_revno(self, revision_id):
995
314
"""Given a revision id, return its revno"""
996
if _mod_revision.is_null(revision_id):
315
if revision_id is None:
998
317
history = self.revision_history()
1000
319
return history.index(revision_id) + 1
1001
320
except ValueError:
1002
raise errors.NoSuchRevision(self, revision_id)
321
raise bzrlib.errors.NoSuchRevision(self, revision_id)
1005
323
def get_rev_id(self, revno, history=None):
1006
324
"""Find the revision id of the specified revno."""
1008
return _mod_revision.NULL_REVISION
1009
last_revno, last_revid = self.last_revision_info()
1010
if revno == last_revno:
1012
if revno <= 0 or revno > last_revno:
1013
raise errors.NoSuchRevision(self, revno)
1014
distance_from_last = last_revno - revno
1015
if len(self._partial_revision_history_cache) <= distance_from_last:
1016
self._extend_partial_history(distance_from_last)
1017
return self._partial_revision_history_cache[distance_from_last]
1020
def pull(self, source, overwrite=False, stop_revision=None,
1021
possible_transports=None, *args, **kwargs):
1022
"""Mirror source into this branch.
1024
This branch is considered to be 'local', having low latency.
1026
:returns: PullResult instance
1028
return InterBranch.get(source, self).pull(overwrite=overwrite,
1029
stop_revision=stop_revision,
1030
possible_transports=possible_transports, *args, **kwargs)
1032
def push(self, target, overwrite=False, stop_revision=None, *args,
1034
"""Mirror this branch into target.
1036
This branch is considered to be 'local', having low latency.
1038
return InterBranch.get(self, target).push(overwrite, stop_revision,
1041
def lossy_push(self, target, stop_revision=None):
1042
"""Push deltas into another branch.
1044
:note: This does not, like push, retain the revision ids from
1045
the source branch and will, rather than adding bzr-specific
1046
metadata, push only those semantics of the revision that can be
1047
natively represented by this branch' VCS.
1049
:param target: Target branch
1050
:param stop_revision: Revision to push, defaults to last revision.
1051
:return: BranchPushResult with an extra member revidmap:
1052
A dictionary mapping revision ids from the target branch
1053
to new revision ids in the target branch, for each
1054
revision that was pushed.
1056
inter = InterBranch.get(self, target)
1057
lossy_push = getattr(inter, "lossy_push", None)
1058
if lossy_push is None:
1059
raise errors.LossyPushToSameVCS(self, target)
1060
return lossy_push(stop_revision)
328
history = self.revision_history()
329
elif revno <= 0 or revno > len(history):
330
raise bzrlib.errors.NoSuchRevision(self, revno)
331
return history[revno - 1]
333
def working_tree(self):
334
"""Return a `Tree` for the working copy if this is a local branch."""
335
raise NotImplementedError('working_tree is abstract')
337
def pull(self, source, overwrite=False, stop_revision=None):
338
raise NotImplementedError('pull is abstract')
1062
340
def basis_tree(self):
1063
"""Return `Tree` object for last revision."""
341
"""Return `Tree` object for last revision.
343
If there are no revisions yet, return an `EmptyTree`.
1064
345
return self.repository.revision_tree(self.last_revision())
347
def rename_one(self, from_rel, to_rel):
350
This can change the directory or the filename or both.
352
raise NotImplementedError('rename_one is abstract')
354
def move(self, from_paths, to_name):
357
to_name must exist as a versioned directory.
359
If to_name exists and is a directory, the files are moved into
360
it, keeping their old names. If it is a directory,
362
Note that to_name is only the last component of the new name;
363
this doesn't change the directory.
365
This returns a list of (from_path, to_path) pairs for each
368
raise NotImplementedError('move is abstract')
1066
370
def get_parent(self):
1067
371
"""Return the parent location of the branch.
1069
This is the default location for pull/missing. The usual
1070
pattern is that the user can override it by specifying a
1073
parent = self._get_parent_location()
1076
# This is an old-format absolute path to a local branch
1077
# turn it into a url
1078
if parent.startswith('/'):
1079
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1081
return urlutils.join(self.base[:-1], parent)
1082
except errors.InvalidURLJoin, e:
1083
raise errors.InaccessibleParent(parent, self.user_url)
1085
def _get_parent_location(self):
1086
raise NotImplementedError(self._get_parent_location)
1088
def _set_config_location(self, name, url, config=None,
1089
make_relative=False):
1091
config = self.get_config()
1095
url = urlutils.relative_url(self.base, url)
1096
config.set_user_option(name, url, warn_masked=True)
1098
def _get_config_location(self, name, config=None):
1100
config = self.get_config()
1101
location = config.get_user_option(name)
1106
def get_child_submit_format(self):
1107
"""Return the preferred format of submissions to this branch."""
1108
return self.get_config().get_user_option("child_submit_format")
1110
def get_submit_branch(self):
1111
"""Return the submit location of the branch.
1113
This is the default location for bundle. The usual
1114
pattern is that the user can override it by specifying a
1117
return self.get_config().get_user_option('submit_branch')
1119
def set_submit_branch(self, location):
1120
"""Return the submit location of the branch.
1122
This is the default location for bundle. The usual
1123
pattern is that the user can override it by specifying a
1126
self.get_config().set_user_option('submit_branch', location,
1129
def get_public_branch(self):
1130
"""Return the public location of the branch.
1132
This is used by merge directives.
1134
return self._get_config_location('public_branch')
1136
def set_public_branch(self, location):
1137
"""Return the submit location of the branch.
1139
This is the default location for bundle. The usual
1140
pattern is that the user can override it by specifying a
1143
self._set_config_location('public_branch', location)
373
This is the default location for push/pull/missing. The usual
374
pattern is that the user can override it by specifying a
377
raise NotImplementedError('get_parent is abstract')
1145
379
def get_push_location(self):
1146
380
"""Return the None or the location to push this branch to."""
1147
push_loc = self.get_config().get_user_option('push_location')
381
raise NotImplementedError('get_push_location is abstract')
1150
383
def set_push_location(self, location):
1151
384
"""Set a new push location for this branch."""
1152
raise NotImplementedError(self.set_push_location)
1154
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1155
"""Run the post_change_branch_tip hooks."""
1156
hooks = Branch.hooks['post_change_branch_tip']
1159
new_revno, new_revid = self.last_revision_info()
1160
params = ChangeBranchTipParams(
1161
self, old_revno, new_revno, old_revid, new_revid)
1165
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
1166
"""Run the pre_change_branch_tip hooks."""
1167
hooks = Branch.hooks['pre_change_branch_tip']
1170
old_revno, old_revid = self.last_revision_info()
1171
params = ChangeBranchTipParams(
1172
self, old_revno, new_revno, old_revid, new_revid)
1178
"""Synchronise this branch with the master branch if any.
1180
:return: None or the last_revision pivoted out during the update.
385
raise NotImplementedError('set_push_location is abstract')
387
def set_parent(self, url):
388
raise NotImplementedError('set_parent is abstract')
1184
390
def check_revno(self, revno):
1190
396
self.check_real_revno(revno)
1192
398
def check_real_revno(self, revno):
1194
400
Check whether a revno corresponds to a real revision.
1195
401
Zero (the NULL revision) is considered invalid
1197
403
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):
404
raise InvalidRevisionNumber(revno)
406
def clone(self, to_location, revision=None, basis_branch=None, to_branch_type=None):
407
"""Copy this branch into the existing directory to_location.
409
Returns the newly created branch object.
412
If not None, only revisions up to this point will be copied.
413
The head of the new branch will be that revision. Must be a
416
to_location -- The destination directory; must either exist and be
417
empty, or not exist, in which case it is created.
420
A local branch to copy revisions from, related to this branch.
421
This is used when branching from a remote (slow) branch, and we have
422
a local branch that might contain some relevant revisions.
425
Branch type of destination branch
427
from bzrlib.workingtree import WorkingTree
428
assert isinstance(to_location, basestring)
429
if not bzrlib.osutils.lexists(to_location):
430
os.mkdir(to_location)
431
if to_branch_type is None:
432
to_branch_type = BzrBranch
433
print "FIXME use a branch format here"
434
br_to = to_branch_type.initialize(to_location)
435
mutter("copy branch from %s to %s", self, br_to)
436
if basis_branch is not None:
437
basis_branch.push_stores(br_to)
439
revision = self.last_revision()
440
br_to.update_revisions(self, stop_revision=revision)
441
br_to.set_parent(self.base)
442
WorkingTree.create(br_to, to_location).set_root_id(self.get_root_id())
446
def fileid_involved_between_revs(self, from_revid, to_revid):
447
""" This function returns the file_id(s) involved in the
448
changes between the from_revid revision and the to_revid
451
raise NotImplementedError('fileid_involved_between_revs is abstract')
453
def fileid_involved(self, last_revid=None):
454
""" This function returns the file_id(s) involved in the
455
changes up to the revision last_revid
456
If no parametr is passed, then all file_id[s] present in the
457
repository are returned
459
raise NotImplementedError('fileid_involved is abstract')
461
def fileid_involved_by_set(self, changes):
462
""" This function returns the file_id(s) involved in the
463
changes present in the set 'changes'
465
raise NotImplementedError('fileid_involved_by_set is abstract')
467
def fileid_involved_between_revs(self, from_revid, to_revid):
468
""" This function returns the file_id(s) involved in the
469
changes between the from_revid revision and the to_revid
472
raise NotImplementedError('fileid_involved_between_revs is abstract')
474
def fileid_involved(self, last_revid=None):
475
""" This function returns the file_id(s) involved in the
476
changes up to the revision last_revid
477
If no parametr is passed, then all file_id[s] present in the
478
repository are returned
480
raise NotImplementedError('fileid_involved is abstract')
482
def fileid_involved_by_set(self, changes):
483
""" This function returns the file_id(s) involved in the
484
changes present in the set 'changes'
486
raise NotImplementedError('fileid_involved_by_set is abstract')
488
class BzrBranchFormat(object):
1486
489
"""An encapsulation of the initialization and open routines for a format.
1488
491
Formats provide three things:
1490
493
* a format string,
1491
494
* an open routine.
1493
Formats are placed in an dict by their format string for reference
496
Formats are placed in an dict by their format string for reference
1494
497
during branch opening. Its not required that these be instances, they
1495
can be classes themselves with class methods - it simply depends on
498
can be classes themselves with class methods - it simply depends on
1496
499
whether state is needed for a given format or not.
1498
501
Once a format is deprecated, just deprecate the initialize and open
1499
methods on the format class. Do not deprecate the object, as the
502
methods on the format class. Do not deprecate the object, as the
1500
503
object will be created every time regardless.
1503
_default_format = None
1504
"""The default format used for new branches."""
1507
507
"""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."""
510
def find_format(klass, transport):
511
"""Return the format registered for URL."""
1521
transport = a_bzrdir.get_branch_transport(None, name=name)
1522
format_string = transport.get_bytes("format")
513
format_string = transport.get(".bzr/branch-format").read()
1523
514
return klass._formats[format_string]
1524
except errors.NoSuchFile:
1525
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
516
raise NotBranchError(path=transport.base)
1526
517
except KeyError:
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)
518
raise errors.UnknownFormatError(format_string)
1559
520
def get_format_string(self):
1560
521
"""Return the ASCII format string that identifies this format."""
1561
522
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
524
def _find_modes(self, t):
525
"""Determine the appropriate modes for files and directories.
527
FIXME: When this merges into, or from storage,
528
this code becomes delgatable to a LockableFiles instance.
530
For now its cribbed and returns (dir_mode, file_mode)
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':
534
except errors.TransportNotPossible:
1607
utf8_files += [('format', self.get_format_string())]
538
dir_mode = st.st_mode & 07777
539
# Remove the sticky and execute bits for files
540
file_mode = dir_mode & ~07111
541
if not BzrBranch._set_dir_mode:
543
if not BzrBranch._set_file_mode:
545
return dir_mode, file_mode
547
def initialize(self, url):
548
"""Create a branch of this format at url and return an open branch."""
549
t = get_transport(url)
550
from bzrlib.weavefile import write_weave_v5
551
from bzrlib.weave import Weave
553
# Create an empty weave
555
bzrlib.weavefile.write_weave_v5(Weave(), sio)
556
empty_weave = sio.getvalue()
558
# Since we don't have a .bzr directory, inherit the
559
# mode from the root directory
560
temp_control = LockableFiles(t, '')
561
temp_control._transport.mkdir('.bzr',
562
mode=temp_control._dir_mode)
563
file_mode = temp_control._file_mode
565
mutter('created control directory in ' + t.base)
566
control = t.clone('.bzr')
567
dirs = ['revision-store', 'weaves']
568
lock_file = 'branch-lock'
569
utf8_files = [('README',
570
"This is a Bazaar-NG control directory.\n"
571
"Do not change any files in this directory.\n"),
572
('branch-format', self.get_format_string()),
573
('revision-history', ''),
576
files = [('inventory.weave', StringIO(empty_weave)),
579
# FIXME: RBC 20060125 dont peek under the covers
580
# NB: no need to escape relative paths that are url safe.
581
control.put(lock_file, StringIO(), mode=file_mode)
582
control_files = LockableFiles(control, lock_file)
583
control_files.lock_write()
584
control_files._transport.mkdir_multi(dirs,
585
mode=control_files._dir_mode)
1609
for (filename, content) in utf8_files:
1610
branch_transport.put_bytes(
1612
mode=a_bzrdir._get_file_mode())
587
for file, content in utf8_files:
588
control_files.put_utf8(file, content)
589
for file, content in files:
590
control_files.put(file, content)
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.
1623
:param name: Name of the colocated branch to create.
1625
raise NotImplementedError(self.initialize)
592
control_files.unlock()
593
return BzrBranch(t, _format=self, _control_files=control_files)
1627
595
def is_supported(self):
1628
596
"""Is this format supported?
1630
598
Supported formats can be initialized and opened.
1631
Unsupported formats may not support initialization or committing or
599
Unsupported formats may not support initialization or committing or
1632
600
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)
604
def open(self, transport):
605
"""Fill out the data in branch for the branch at url."""
606
return BzrBranch(transport, _format=self)
1673
609
def register_format(klass, format):
1674
"""Register a metadir format."""
1675
610
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
613
def unregister_format(klass, format):
614
assert klass._formats[format.get_format_string()] is format
1694
615
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):
618
class BzrBranchFormat4(BzrBranchFormat):
1918
619
"""Bzr branch format 4.
1920
621
This format has:
1921
- a revision-history file.
1922
- a branch-lock lock file [ to be shared with the bzrdir ]
623
- TextStores for texts, inventories,revisions.
625
This format is deprecated: it indexes texts using a text it which is
626
removed in format 5; write support for this format has been removed.
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.
629
def get_format_string(self):
630
"""See BzrBranchFormat.get_format_string()."""
631
return BZR_BRANCH_FORMAT_4
633
def initialize(self, url):
634
"""Format 4 branches cannot be created."""
635
raise UninitializableFormat(self)
637
def is_supported(self):
638
"""Format 4 is not supported.
640
It is not supported because the model changed from 4 to 5 and the
641
conversion logic is expensive - so doing it on the fly was not
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):
647
class BzrBranchFormat5(BzrBranchFormat):
2004
648
"""Bzr branch format 5.
2006
650
This format has:
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.
651
- weaves for file texts and inventory
653
- TextStores for revisions and signatures.
656
def get_format_string(self):
657
"""See BzrBranchFormat.get_format_string()."""
658
return BZR_BRANCH_FORMAT_5
661
class BzrBranchFormat6(BzrBranchFormat):
662
"""Bzr branch format 6.
2157
664
This format has:
665
- weaves for file texts and inventory
666
- hash subdirectory based stores.
667
- TextStores for revisions and signatures.
2162
670
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):
671
"""See BzrBranchFormat.get_format_string()."""
672
return BZR_BRANCH_FORMAT_6
675
BzrBranchFormat.register_format(BzrBranchFormat4())
676
BzrBranchFormat.register_format(BzrBranchFormat5())
677
BzrBranchFormat.register_format(BzrBranchFormat6())
679
# TODO: jam 20060108 Create a new branch format, and as part of upgrade
680
# make sure that ancestry.weave is deleted (it is never used, but
681
# used to be created)
684
class BzrBranch(Branch):
2296
685
"""A branch stored in the actual filesystem.
2298
687
Note that it's "local" in the context of the filesystem; it doesn't
2299
688
really matter if it's on an nfs/smb/afs/coda/... share, as long as
2300
689
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
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
692
# We actually expect this class to be somewhat short-lived; part of its
693
# purpose is to try to isolate what bits of the branch logic are tied to
694
# filesystem access, so that in a later step, we can extricate them to
695
# a separarte ("storage") class.
696
_inventory_weave = None
698
# Map some sort of prefix into a namespace
699
# stuff like "revno:10", "revid:", etc.
700
# This should match a prefix with a function which accepts
701
REVISION_NAMESPACES = {}
703
def push_stores(self, branch_to):
704
"""See Branch.push_stores."""
705
if (not isinstance(self._branch_format, BzrBranchFormat4) or
706
self._branch_format != branch_to._branch_format):
707
from bzrlib.fetch import greedy_fetch
708
mutter("Using fetch logic to push between %s(%s) and %s(%s)",
709
self, self._branch_format, branch_to, branch_to._branch_format)
710
greedy_fetch(to_branch=branch_to, from_branch=self,
711
revision=self.last_revision())
714
# format 4 to format 4 logic only.
715
store_pairs = ((self.text_store, branch_to.text_store),
716
(self.inventory_store, branch_to.inventory_store),
717
(self.revision_store, branch_to.revision_store))
719
for from_store, to_store in store_pairs:
720
copy_all(from_store, to_store)
721
except UnlistableStore:
722
raise UnlistableBranch(from_store)
724
def __init__(self, transport, init=DEPRECATED_PARAMETER,
725
relax_version_check=DEPRECATED_PARAMETER, _format=None,
726
_control_files=None):
727
"""Create new branch object at a particular location.
729
transport -- A Transport object, defining how to access files.
731
init -- If True, create new control files in a previously
732
unversioned directory. If False, the branch must already
735
relax_version_check -- If true, the usual check for the branch
736
version is not applied. This is intended only for
737
upgrade/recovery type use; it's not guaranteed that
738
all operations will work on old format branches.
740
In the test suite, creation of new trees is tested using the
741
`ScratchBranch` class.
743
assert isinstance(transport, Transport), \
744
"%r is not a Transport" % transport
745
self._transport = transport
746
self._base = self._transport.base
2325
747
if _control_files is None:
2326
raise ValueError('BzrBranch _control_files is None')
748
_control_files = LockableFiles(self._transport.clone(bzrlib.BZRDIR),
2327
750
self.control_files = _control_files
2328
self._transport = _control_files._transport
2329
self.repository = _repository
2330
Branch.__init__(self)
751
if deprecated_passed(init):
752
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
753
"deprecated as of bzr 0.8. Please use Branch.create().",
757
# this is slower than before deprecation, oh well never mind.
759
self._initialize(transport.base)
760
self._check_format(_format)
761
if deprecated_passed(relax_version_check):
762
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
763
"relax_version_check parameter is deprecated as of bzr 0.8. "
764
"Please use Branch.open_downlevel, or a BzrBranchFormat's "
768
if (not relax_version_check
769
and not self._branch_format.is_supported()):
770
raise errors.UnsupportedFormatError(
771
'sorry, branch format %r not supported' % fmt,
772
['use a different bzr version',
773
'or remove the .bzr directory'
774
' and "bzr init" again'])
775
self.repository = Repository(transport, self._branch_format)
779
def _initialize(base):
780
"""Create a bzr branch in the latest format."""
781
return BzrBranchFormat6().initialize(base)
2332
783
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,
784
return '%s(%r)' % (self.__class__.__name__, self.base)
2339
786
__repr__ = __str__
789
# TODO: It might be best to do this somewhere else,
790
# but it is nice for a Branch object to automatically
791
# cache it's information.
792
# Alternatively, we could have the Transport objects cache requests
793
# See the earlier discussion about how major objects (like Branch)
794
# should never expect their __del__ function to run.
795
# XXX: cache_root seems to be unused, 2006-01-13 mbp
796
if hasattr(self, 'cache_root') and self.cache_root is not None:
798
shutil.rmtree(self.cache_root)
801
self.cache_root = None
2341
803
def _get_base(self):
2342
"""Returns the directory containing the control directory."""
2343
804
return self._base
2345
806
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()
808
def _finish_transaction(self):
809
"""Exit the current transaction."""
810
return self.control_files._finish_transaction()
812
def get_transaction(self):
813
"""Return the current active transaction.
815
If no transaction is active, this returns a passthrough object
816
for which all data is immediately flushed and no caching happens.
818
# this is an explicit function so that we can do tricky stuff
819
# when the storage in rev_storage is elsewhere.
820
# we probably need to hook the two 'lock a location' and
821
# 'have a transaction' together more delicately, so that
822
# we can have two locks (branch and storage) and one transaction
823
# ... and finishing the transaction unlocks both, but unlocking
824
# does not. - RBC 20051121
825
return self.control_files.get_transaction()
827
def _set_transaction(self, transaction):
828
"""Set a new active transaction."""
829
return self.control_files._set_transaction(transaction)
831
def abspath(self, name):
832
"""See Branch.abspath."""
833
return self.control_files._transport.abspath(name)
835
def _check_format(self, format):
836
"""Identify the branch format if needed.
838
The format is stored as a reference to the format object in
839
self._branch_format for code that needs to check it later.
841
The format parameter is either None or the branch format class
842
used to open this branch.
845
format = BzrBranchFormat.find_format(self._transport)
846
self._branch_format = format
847
mutter("got branch format %s", self._branch_format)
850
def get_root_id(self):
851
"""See Branch.get_root_id."""
852
tree = self.repository.revision_tree(self.last_revision())
853
return tree.inventory.root.file_id
855
def lock_write(self):
856
# TODO: test for failed two phase locks. This is known broken.
857
self.control_files.lock_write()
858
self.repository.lock_write()
2378
860
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()
2394
self.control_files.lock_read()
2395
return LogicalLockResult(self.unlock)
2398
self.repository.unlock()
2401
@only_raises(errors.LockNotHeld, errors.LockBroken)
861
# TODO: test for failed two phase locks. This is known broken.
862
self.control_files.lock_read()
863
self.repository.lock_read()
2402
865
def unlock(self):
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()
866
# TODO: test for failed two phase locks. This is known broken.
867
self.repository.unlock()
868
self.control_files.unlock()
2415
870
def peek_lock_mode(self):
2416
871
if self.control_files._lock_count == 0:
2419
874
return self.control_files._lock_mode
2421
def get_physical_lock_status(self):
2422
return self.control_files.get_physical_lock_status()
2424
876
@needs_read_lock
2425
877
def print_file(self, file, revision_id):
2426
878
"""See Branch.print_file."""
2427
879
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())
882
def append_revision(self, *revision_ids):
883
"""See Branch.append_revision."""
884
for revision_id in revision_ids:
885
mutter("add {%s} to revision-history" % revision_id)
886
rev_history = self.revision_history()
887
rev_history.extend(revision_ids)
888
self.set_revision_history(rev_history)
2438
890
@needs_write_lock
2439
891
def set_revision_history(self, rev_history):
2440
892
"""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
893
self.control_files.put_utf8(
894
'revision-history', '\n'.join(rev_history))
896
def get_revision_delta(self, revno):
897
"""Return the delta for one revision.
899
The delta is relative to its mainline predecessor, or the
900
empty tree for revision 1.
902
assert isinstance(revno, int)
903
rh = self.revision_history()
904
if not (1 <= revno <= len(rh)):
905
raise InvalidRevisionNumber(revno)
907
# revno is 1-based; list is 0-based
909
new_tree = self.repository.revision_tree(rh[revno-1])
911
old_tree = EmptyTree()
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)
913
old_tree = self.repository.revision_tree(rh[revno-2])
914
return compare_trees(old_tree, new_tree)
917
def revision_history(self):
918
"""See Branch.revision_history."""
919
# FIXME are transactions bound to control files ? RBC 20051121
920
transaction = self.get_transaction()
921
history = transaction.map.find_revision_history()
922
if history is not None:
923
mutter("cache hit for revision-history in %s", self)
925
history = [l.rstrip('\r\n') for l in
926
self.control_files.get_utf8('revision-history').readlines()]
927
transaction.map.add_revision_history(history)
928
# this call is disabled because revision_history is
929
# not really an object yet, and the transaction is for objects.
930
# transaction.register_clean(history, precious=True)
933
def update_revisions(self, other, stop_revision=None):
934
"""See Branch.update_revisions."""
935
from bzrlib.fetch import greedy_fetch
937
if stop_revision is None:
938
stop_revision = other.last_revision()
939
### Should this be checking is_ancestor instead of revision_history?
940
if (stop_revision is not None and
941
stop_revision in self.revision_history()):
2480
if revision_id == _mod_revision.NULL_REVISION:
2483
new_history = self.revision_history()
2484
if revision_id is not None and new_history != []:
943
greedy_fetch(to_branch=self, from_branch=other,
944
revision=stop_revision)
945
pullable_revs = self.pullable_revisions(other, stop_revision)
946
if len(pullable_revs) > 0:
947
self.append_revision(*pullable_revs)
949
def pullable_revisions(self, other, stop_revision):
950
"""See Branch.pullable_revisions."""
951
other_revno = other.revision_id_to_revno(stop_revision)
953
return self.missing_revisions(other, other_revno)
954
except DivergedBranches, e:
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))
956
pullable_revs = get_intervening_revisions(self.last_revision(),
959
assert self.last_revision() not in pullable_revs
961
except bzrlib.errors.NotAncestor:
962
if is_ancestor(self.last_revision(), stop_revision, self):
2534
967
def basis_tree(self):
2535
968
"""See Branch.basis_tree."""
2536
return self.repository.revision_tree(self.last_revision())
2538
def _get_parent_location(self):
970
revision_id = self.revision_history()[-1]
971
# FIXME: This is an abstraction violation, the basis tree
972
# here as defined is on the working tree, the method should
973
# be too. The basis tree for a branch can be different than
974
# that for a working tree. RBC 20051207
975
xml = self.working_tree().read_basis_inventory(revision_id)
976
inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
977
return RevisionTree(self.repository, inv, revision_id)
978
except (IndexError, NoSuchFile, NoWorkingTree), e:
979
return self.repository.revision_tree(self.last_revision())
981
def working_tree(self):
982
"""See Branch.working_tree."""
983
from bzrlib.workingtree import WorkingTree
984
from bzrlib.transport.local import LocalTransport
985
if (self.base.find('://') != -1 or
986
not isinstance(self._transport, LocalTransport)):
987
raise NoWorkingTree(self.base)
988
return WorkingTree(self.base, branch=self)
991
def pull(self, source, overwrite=False, stop_revision=None):
992
"""See Branch.pull."""
995
old_count = len(self.revision_history())
997
self.update_revisions(source,stop_revision)
998
except DivergedBranches:
1002
self.set_revision_history(source.revision_history())
1003
new_count = len(self.revision_history())
1004
return new_count - old_count
1008
def get_parent(self):
1009
"""See Branch.get_parent."""
2539
1011
_locs = ['parent', 'pull', 'x-pull']
2540
1012
for l in _locs:
2542
return self._transport.get_bytes(l).strip('\n')
2543
except errors.NoSuchFile:
1014
return self.control_files.get_utf8(l).read().strip('\n')
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)
2572
def set_push_location(self, location):
2573
"""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.
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())
2630
self._transport.delete('bound')
2631
except errors.NoSuchFile:
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)
1019
def get_push_location(self):
1020
"""See Branch.get_push_location."""
1021
config = bzrlib.config.BranchConfig(self)
1022
push_loc = config.get_user_option('push_location')
1025
def set_push_location(self, location):
1026
"""See Branch.set_push_location."""
1027
config = bzrlib.config.LocationConfig(self.base)
1028
config.set_user_option('push_location', location)
1031
def set_parent(self, url):
1032
"""See Branch.set_parent."""
1033
# TODO: Maybe delete old location files?
1034
# URLs should never be unicode, even on the local fs,
1035
# FIXUP this and get_parent in a future branch format bump:
1036
# read and rewrite the file, and have the new format code read
1037
# using .get not .get_utf8. RBC 20060125
1038
self.control_files.put_utf8('parent', url + '\n')
1040
def tree_config(self):
1041
return TreeConfig(self)
1043
def _get_truncated_history(self, revision_id):
1044
history = self.revision_history()
1045
if revision_id is None:
1048
idx = history.index(revision_id)
2963
1049
except ValueError:
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)
1050
raise InvalidRevisionId(revision_id=revision, branch=self)
1051
return history[:idx+1]
1054
def _clone_weave(self, to_location, revision=None, basis_branch=None):
1056
from bzrlib.workingtree import WorkingTree
1057
assert isinstance(to_location, basestring)
1058
if basis_branch is not None:
1059
note("basis_branch is not supported for fast weave copy yet.")
1061
history = self._get_truncated_history(revision)
1062
if not bzrlib.osutils.lexists(to_location):
1063
os.mkdir(to_location)
1064
branch_to = Branch.initialize(to_location)
1065
mutter("copy branch from %s to %s", self, branch_to)
1067
self.repository.copy(branch_to.repository)
1069
# must be done *after* history is copied across
1070
# FIXME duplicate code with base .clone().
1071
# .. would template method be useful here? RBC 20051207
1072
branch_to.set_parent(self.base)
1073
branch_to.append_revision(*history)
1074
# FIXME: this should be in workingtree.clone
1075
WorkingTree.create(branch_to, to_location).set_root_id(self.get_root_id())
1079
def clone(self, to_location, revision=None, basis_branch=None, to_branch_type=None):
1080
print "FIXME: clone via create and fetch is probably faster when versioned file comes in."
1081
if to_branch_type is None:
1082
to_branch_type = BzrBranch
1084
if to_branch_type == BzrBranch \
1085
and self.repository.weave_store.listable() \
1086
and self.repository.revision_store.listable():
1087
return self._clone_weave(to_location, revision, basis_branch)
1089
return Branch.clone(self, to_location, revision, basis_branch, to_branch_type)
1091
def fileid_involved_between_revs(self, from_revid, to_revid):
1092
"""Find file_id(s) which are involved in the changes between revisions.
1094
This determines the set of revisions which are involved, and then
1095
finds all file ids affected by those revisions.
1097
# TODO: jam 20060119 This code assumes that w.inclusions will
1098
# always be correct. But because of the presence of ghosts
1099
# it is possible to be wrong.
1100
# One specific example from Robert Collins:
1101
# Two branches, with revisions ABC, and AD
1102
# C is a ghost merge of D.
1103
# Inclusions doesn't recognize D as an ancestor.
1104
# If D is ever merged in the future, the weave
1105
# won't be fixed, because AD never saw revision C
1106
# to cause a conflict which would force a reweave.
1107
w = self.repository.get_inventory_weave()
1108
from_set = set(w.inclusions([w.lookup(from_revid)]))
1109
to_set = set(w.inclusions([w.lookup(to_revid)]))
1110
included = to_set.difference(from_set)
1111
changed = map(w.idx_to_name, included)
1112
return self._fileid_involved_by_set(changed)
1114
def fileid_involved(self, last_revid=None):
1115
"""Find all file_ids modified in the ancestry of last_revid.
1117
:param last_revid: If None, last_revision() will be used.
1119
w = self.repository.get_inventory_weave()
1121
changed = set(w._names)
1123
included = w.inclusions([w.lookup(last_revid)])
1124
changed = map(w.idx_to_name, included)
1125
return self._fileid_involved_by_set(changed)
1127
def fileid_involved_by_set(self, changes):
1128
"""Find all file_ids modified by the set of revisions passed in.
1130
:param changes: A set() of revision ids
1132
# TODO: jam 20060119 This line does *nothing*, remove it.
1133
# or better yet, change _fileid_involved_by_set so
1134
# that it takes the inventory weave, rather than
1135
# pulling it out by itself.
1136
w = self.repository.get_inventory_weave()
1137
return self._fileid_involved_by_set(changes)
1139
def _fileid_involved_by_set(self, changes):
1140
"""Find the set of file-ids affected by the set of revisions.
1142
:param changes: A set() of revision ids.
1143
:return: A set() of file ids.
1145
This peaks at the Weave, interpreting each line, looking to
1146
see if it mentions one of the revisions. And if so, includes
1147
the file id mentioned.
1148
This expects both the Weave format, and the serialization
1149
to have a single line per file/directory, and to have
1150
fileid="" and revision="" on that line.
1152
assert (isinstance(self._branch_format, BzrBranchFormat5) or
1153
isinstance(self._branch_format, BzrBranchFormat6)), \
1154
"fileid_involved only supported for branches which store inventory as xml"
1156
w = self.repository.get_inventory_weave()
1158
for line in w._weave:
1160
# it is ugly, but it is due to the weave structure
1161
if not isinstance(line, basestring): continue
1163
start = line.find('file_id="')+9
1164
if start < 9: continue
1165
end = line.find('"', start)
1167
file_id = xml.sax.saxutils.unescape(line[start:end])
1169
# check if file_id is already present
1170
if file_id in file_ids: continue
1172
start = line.find('revision="')+10
1173
if start < 10: continue
1174
end = line.find('"', start)
1176
revision_id = xml.sax.saxutils.unescape(line[start:end])
1178
if revision_id in changes:
1179
file_ids.add(file_id)
1184
Branch.set_default_initializer(BzrBranch._initialize)
1187
class BranchTestProviderAdapter(object):
1188
"""A tool to generate a suite testing multiple branch formats at once.
1190
This is done by copying the test once for each transport and injecting
1191
the transport_server, transport_readonly_server, and branch_format
1192
classes into each copy. Each copy is also given a new id() to make it
1196
def __init__(self, transport_server, transport_readonly_server, formats):
1197
self._transport_server = transport_server
1198
self._transport_readonly_server = transport_readonly_server
1199
self._formats = formats
1201
def adapt(self, test):
1202
result = TestSuite()
1203
for format in self._formats:
1204
new_test = deepcopy(test)
1205
new_test.transport_server = self._transport_server
1206
new_test.transport_readonly_server = self._transport_readonly_server
1207
new_test.branch_format = format
1208
def make_new_test_id():
1209
new_id = "%s(%s)" % (new_test.id(), format.__class__.__name__)
1210
return lambda: new_id
1211
new_test.id = make_new_test_id()
1212
result.addTest(new_test)
1216
class ScratchBranch(BzrBranch):
1217
"""Special test class: a branch that cleans up after itself.
1219
>>> b = ScratchBranch()
1223
>>> b._transport.__del__()
1228
def __init__(self, files=[], dirs=[], transport=None):
1229
"""Make a test branch.
1231
This creates a temporary directory and runs init-tree in it.
1233
If any files are listed, they are created in the working copy.
1235
if transport is None:
1236
transport = bzrlib.transport.local.ScratchTransport()
1237
# local import for scope restriction
1238
from bzrlib.workingtree import WorkingTree
1239
WorkingTree.create_standalone(transport.base)
1240
super(ScratchBranch, self).__init__(transport)
1242
super(ScratchBranch, self).__init__(transport)
1244
# BzrBranch creates a clone to .bzr and then forgets about the
1245
# original transport. A ScratchTransport() deletes itself and
1246
# everything underneath it when it goes away, so we need to
1247
# grab a local copy to prevent that from happening
1248
self._transport = transport
1251
self._transport.mkdir(d)
1254
self._transport.put(f, 'content of %s' % f)
1258
>>> orig = ScratchBranch(files=["file1", "file2"])
1259
>>> os.listdir(orig.base)
1260
[u'.bzr', u'file1', u'file2']
1261
>>> clone = orig.clone()
1262
>>> if os.name != 'nt':
1263
... os.path.samefile(orig.base, clone.base)
1265
... orig.base == clone.base
1268
>>> os.listdir(clone.base)
1269
[u'.bzr', u'file1', u'file2']
1271
from shutil import copytree
1272
from bzrlib.osutils import mkdtemp
1275
copytree(self.base, base, symlinks=True)
1276
return ScratchBranch(
1277
transport=bzrlib.transport.local.ScratchTransport(base))
2996
1280
######################################################################
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)
1284
def is_control_file(filename):
1285
## FIXME: better check
1286
filename = normpath(filename)
1287
while filename != '':
1288
head, tail = os.path.split(filename)
1289
## mutter('check %r for control file' % ((head, tail),))
1290
if tail == bzrlib.BZRDIR:
1292
if filename == head:
added
removed
bzrlib/branch.py
