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
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
26
import xml.sax.saxutils
30
from bzrlib.config import TreeConfig
31
from bzrlib.delta import compare_trees
32
import bzrlib.errors as errors
33
from bzrlib.errors import (BzrError, InvalidRevisionNumber, InvalidRevisionId,
34
NoSuchRevision, HistoryMissing, NotBranchError,
35
DivergedBranches, LockError,
36
UninitializableFormat,
38
UnlistableBranch, NoSuchFile, NotVersionedError,
40
import bzrlib.inventory as inventory
41
from bzrlib.inventory import Inventory
42
from bzrlib.osutils import (isdir, quotefn,
43
rename, splitpath, sha_file,
44
file_kind, abspath, normpath, pathjoin,
47
from bzrlib.textui import show_status
48
from bzrlib.trace import mutter, note
49
from bzrlib.tree import EmptyTree, RevisionTree
50
from bzrlib.revision import (Revision, is_ancestor, get_intervening_revisions,
52
from bzrlib.store import copy_all
53
from bzrlib.store.text import TextStore
54
from bzrlib.store.weave import WeaveStore
55
from bzrlib.symbol_versioning import deprecated_nonce, deprecated_passed
56
from bzrlib.testament import Testament
57
import bzrlib.transactions as transactions
58
from bzrlib.transport import Transport, get_transport
61
63
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
62
64
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):
65
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
66
## TODO: Maybe include checks for common corruption of newlines, etc?
69
# TODO: Some operations like log might retrieve the same revisions
70
# repeatedly to calculate deltas. We could perhaps have a weakref
71
# cache in memory to make this faster. In general anything can be
72
# cached in memory between lock and unlock operations.
74
def find_branch(*ignored, **ignored_too):
75
# XXX: leave this here for about one release, then remove it
76
raise NotImplementedError('find_branch() is not supported anymore, '
77
'please use one of the new branch constructors')
80
def needs_read_lock(unbound):
81
"""Decorate unbound to take out and release a read lock."""
82
def decorated(self, *args, **kwargs):
85
return unbound(self, *args, **kwargs)
91
def needs_write_lock(unbound):
92
"""Decorate unbound to take out and release a write lock."""
93
def decorated(self, *args, **kwargs):
96
return unbound(self, *args, **kwargs)
101
######################################################################
104
class Branch(object):
67
105
"""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.
108
Base directory/url of the branch.
75
110
# 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
114
_default_initializer = None
115
"""The default initializer for making new branches."""
87
117
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):
118
raise NotImplementedError('The Branch class is abstract')
121
def open_downlevel(base):
122
"""Open a branch which may be of an old format."""
123
return Branch.open(base, _unsupported=True)
126
def open(base, _unsupported=False):
127
"""Open an existing branch, rooted at 'base' (url)
129
_unsupported is a private parameter to the Branch class.
131
t = get_transport(base)
132
mutter("trying to open %r with transport %r", base, t)
133
format = BzrBranchFormat.find_format(t)
134
if not _unsupported and not format.is_supported():
135
# see open_downlevel to open legacy branches.
136
raise errors.UnsupportedFormatError(
137
'sorry, branch format %s not supported' % format,
138
['use a different bzr version',
139
'or remove the .bzr directory'
140
' and "bzr init" again'])
141
return format.open(t)
144
def open_containing(url):
177
145
"""Open an existing branch which contains url.
179
147
This probes for a branch at url, and searches upwards from there.
181
149
Basically we keep looking up until we find the control directory or
182
150
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
151
If there is one and it is either an unrecognised format or an unsupported
184
152
format, UnknownFormatError or UnsupportedFormatError are raised.
185
153
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():
155
t = get_transport(url)
156
# 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()
160
format = BzrBranchFormat.find_format(t)
161
return format.open(t), t.relpath(url)
162
except NotBranchError, e:
163
mutter('not a branch in: %r %s', t.base, e)
164
new_t = t.clone('..')
165
if new_t.base == t.base:
166
# reached the root, whatever that may be
167
raise NotBranchError(path=url)
171
def initialize(base):
172
"""Create a new branch, rooted at 'base' (url)
174
This will call the current default initializer with base
175
as the only parameter.
177
return Branch._default_initializer(safe_unicode(base))
180
def get_default_initializer():
181
"""Return the initializer being used for new branches."""
182
return Branch._default_initializer
185
def set_default_initializer(initializer):
186
"""Set the initializer to be used for new branches."""
187
Branch._default_initializer = staticmethod(initializer)
189
def setup_caching(self, cache_root):
190
"""Subclasses that care about caching should override this, and set
191
up cached stores located under cache_root.
193
self.cache_root = cache_root
196
cfg = self.tree_config()
197
return cfg.get_option(u"nickname", default=self.base.split('/')[-2])
251
199
def _set_nick(self, nick):
252
self.get_config().set_user_option('nickname', nick, warn_masked=True)
200
cfg = self.tree_config()
201
cfg.set_option(nick, "nickname")
202
assert cfg.get_option("nickname") == nick
254
204
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()
206
def push_stores(self, branch_to):
207
"""Copy the content of this branches store to branch_to."""
208
raise NotImplementedError('push_stores is abstract')
210
def get_transaction(self):
211
"""Return the current active transaction.
213
If no transaction is active, this returns a passthrough object
214
for which all data is immediately flushed and no caching happens.
216
raise NotImplementedError('get_transaction is abstract')
286
218
def lock_write(self):
287
raise NotImplementedError(self.lock_write)
219
raise NotImplementedError('lock_write is abstract')
289
221
def lock_read(self):
290
raise NotImplementedError(self.lock_read)
222
raise NotImplementedError('lock_read is abstract')
292
224
def unlock(self):
293
raise NotImplementedError(self.unlock)
295
def peek_lock_mode(self):
296
"""Return lock mode for the Branch: 'r', 'w' or None"""
297
raise NotImplementedError(self.peek_lock_mode)
299
def get_physical_lock_status(self):
300
raise NotImplementedError(self.get_physical_lock_status)
303
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
304
"""Return the revision_id for a dotted revno.
306
:param revno: a tuple like (1,) or (1,1,2)
307
:param _cache_reverse: a private parameter enabling storage
308
of the reverse mapping in a top level cache. (This should
309
only be done in selective circumstances as we want to
310
avoid having the mapping cached multiple times.)
311
:return: the revision_id
312
:raises errors.NoSuchRevision: if the revno doesn't exist
314
rev_id = self._do_dotted_revno_to_revision_id(revno)
316
self._partial_revision_id_to_revno_cache[rev_id] = revno
319
def _do_dotted_revno_to_revision_id(self, revno):
320
"""Worker function for dotted_revno_to_revision_id.
322
Subclasses should override this if they wish to
323
provide a more efficient implementation.
326
return self.get_rev_id(revno[0])
327
revision_id_to_revno = self.get_revision_id_to_revno_map()
328
revision_ids = [revision_id for revision_id, this_revno
329
in revision_id_to_revno.iteritems()
330
if revno == this_revno]
331
if len(revision_ids) == 1:
332
return revision_ids[0]
334
revno_str = '.'.join(map(str, revno))
335
raise errors.NoSuchRevision(self, revno_str)
338
def revision_id_to_dotted_revno(self, revision_id):
339
"""Given a revision id, return its dotted revno.
341
:return: a tuple like (1,) or (400,1,3).
343
return self._do_revision_id_to_dotted_revno(revision_id)
345
def _do_revision_id_to_dotted_revno(self, revision_id):
346
"""Worker function for revision_id_to_revno."""
347
# Try the caches if they are loaded
348
result = self._partial_revision_id_to_revno_cache.get(revision_id)
349
if result is not None:
351
if self._revision_id_to_revno_cache:
352
result = self._revision_id_to_revno_cache.get(revision_id)
354
raise errors.NoSuchRevision(self, revision_id)
355
# Try the mainline as it's optimised
357
revno = self.revision_id_to_revno(revision_id)
359
except errors.NoSuchRevision:
360
# We need to load and use the full revno map after all
361
result = self.get_revision_id_to_revno_map().get(revision_id)
363
raise errors.NoSuchRevision(self, revision_id)
367
def get_revision_id_to_revno_map(self):
368
"""Return the revision_id => dotted revno map.
370
This will be regenerated on demand, but will be cached.
372
:return: A dictionary mapping revision_id => dotted revno.
373
This dictionary should not be modified by the caller.
375
if self._revision_id_to_revno_cache is not None:
376
mapping = self._revision_id_to_revno_cache
378
mapping = self._gen_revno_map()
379
self._cache_revision_id_to_revno(mapping)
380
# TODO: jam 20070417 Since this is being cached, should we be returning
382
# I would rather not, and instead just declare that users should not
383
# modify the return value.
386
def _gen_revno_map(self):
387
"""Create a new mapping from revision ids to dotted revnos.
389
Dotted revnos are generated based on the current tip in the revision
391
This is the worker function for get_revision_id_to_revno_map, which
392
just caches the return value.
394
:return: A dictionary mapping revision_id => dotted revno.
396
revision_id_to_revno = dict((rev_id, revno)
397
for rev_id, depth, revno, end_of_merge
398
in self.iter_merge_sorted_revisions())
399
return revision_id_to_revno
402
def iter_merge_sorted_revisions(self, start_revision_id=None,
403
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
404
"""Walk the revisions for a branch in merge sorted order.
406
Merge sorted order is the output from a merge-aware,
407
topological sort, i.e. all parents come before their
408
children going forward; the opposite for reverse.
410
:param start_revision_id: the revision_id to begin walking from.
411
If None, the branch tip is used.
412
:param stop_revision_id: the revision_id to terminate the walk
413
after. If None, the rest of history is included.
414
:param stop_rule: if stop_revision_id is not None, the precise rule
415
to use for termination:
416
* 'exclude' - leave the stop revision out of the result (default)
417
* 'include' - the stop revision is the last item in the result
418
* 'with-merges' - include the stop revision and all of its
419
merged revisions in the result
420
* 'with-merges-without-common-ancestry' - filter out revisions
421
that are in both ancestries
422
:param direction: either 'reverse' or 'forward':
423
* reverse means return the start_revision_id first, i.e.
424
start at the most recent revision and go backwards in history
425
* forward returns tuples in the opposite order to reverse.
426
Note in particular that forward does *not* do any intelligent
427
ordering w.r.t. depth as some clients of this API may like.
428
(If required, that ought to be done at higher layers.)
430
:return: an iterator over (revision_id, depth, revno, end_of_merge)
433
* revision_id: the unique id of the revision
434
* depth: How many levels of merging deep this node has been
436
* revno_sequence: This field provides a sequence of
437
revision numbers for all revisions. The format is:
438
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
439
branch that the revno is on. From left to right the REVNO numbers
440
are the sequence numbers within that branch of the revision.
441
* end_of_merge: When True the next node (earlier in history) is
442
part of a different merge.
444
# Note: depth and revno values are in the context of the branch so
445
# we need the full graph to get stable numbers, regardless of the
447
if self._merge_sorted_revisions_cache is None:
448
last_revision = self.last_revision()
449
known_graph = self.repository.get_known_graph_ancestry(
451
self._merge_sorted_revisions_cache = known_graph.merge_sort(
453
filtered = self._filter_merge_sorted_revisions(
454
self._merge_sorted_revisions_cache, start_revision_id,
455
stop_revision_id, stop_rule)
456
# Make sure we don't return revisions that are not part of the
457
# start_revision_id ancestry.
458
filtered = self._filter_start_non_ancestors(filtered)
459
if direction == 'reverse':
461
if direction == 'forward':
462
return reversed(list(filtered))
464
raise ValueError('invalid direction %r' % direction)
466
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
467
start_revision_id, stop_revision_id, stop_rule):
468
"""Iterate over an inclusive range of sorted revisions."""
469
rev_iter = iter(merge_sorted_revisions)
470
if start_revision_id is not None:
471
for node in rev_iter:
472
rev_id = node.key[-1]
473
if rev_id != start_revision_id:
476
# The decision to include the start or not
477
# depends on the stop_rule if a stop is provided
478
# so pop this node back into the iterator
479
rev_iter = chain(iter([node]), rev_iter)
481
if stop_revision_id is None:
483
for node in rev_iter:
484
rev_id = node.key[-1]
485
yield (rev_id, node.merge_depth, node.revno,
487
elif stop_rule == 'exclude':
488
for node in rev_iter:
489
rev_id = node.key[-1]
490
if rev_id == stop_revision_id:
492
yield (rev_id, node.merge_depth, node.revno,
494
elif stop_rule == 'include':
495
for node in rev_iter:
496
rev_id = node.key[-1]
497
yield (rev_id, node.merge_depth, node.revno,
499
if rev_id == stop_revision_id:
501
elif stop_rule == 'with-merges-without-common-ancestry':
502
# We want to exclude all revisions that are already part of the
503
# stop_revision_id ancestry.
504
graph = self.repository.get_graph()
505
ancestors = graph.find_unique_ancestors(start_revision_id,
507
for node in rev_iter:
508
rev_id = node.key[-1]
509
if rev_id not in ancestors:
511
yield (rev_id, node.merge_depth, node.revno,
513
elif stop_rule == 'with-merges':
514
stop_rev = self.repository.get_revision(stop_revision_id)
515
if stop_rev.parent_ids:
516
left_parent = stop_rev.parent_ids[0]
518
left_parent = _mod_revision.NULL_REVISION
519
# left_parent is the actual revision we want to stop logging at,
520
# since we want to show the merged revisions after the stop_rev too
521
reached_stop_revision_id = False
522
revision_id_whitelist = []
523
for node in rev_iter:
524
rev_id = node.key[-1]
525
if rev_id == left_parent:
526
# reached the left parent after the stop_revision
528
if (not reached_stop_revision_id or
529
rev_id in revision_id_whitelist):
530
yield (rev_id, node.merge_depth, node.revno,
532
if reached_stop_revision_id or rev_id == stop_revision_id:
533
# only do the merged revs of rev_id from now on
534
rev = self.repository.get_revision(rev_id)
536
reached_stop_revision_id = True
537
revision_id_whitelist.extend(rev.parent_ids)
539
raise ValueError('invalid stop_rule %r' % stop_rule)
541
def _filter_start_non_ancestors(self, rev_iter):
542
# If we started from a dotted revno, we want to consider it as a tip
543
# and don't want to yield revisions that are not part of its
544
# ancestry. Given the order guaranteed by the merge sort, we will see
545
# uninteresting descendants of the first parent of our tip before the
547
first = rev_iter.next()
548
(rev_id, merge_depth, revno, end_of_merge) = first
551
# We start at a mainline revision so by definition, all others
552
# revisions in rev_iter are ancestors
553
for node in rev_iter:
558
pmap = self.repository.get_parent_map([rev_id])
559
parents = pmap.get(rev_id, [])
561
whitelist.update(parents)
563
# If there is no parents, there is nothing of interest left
565
# FIXME: It's hard to test this scenario here as this code is never
566
# called in that case. -- vila 20100322
569
for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
571
if rev_id in whitelist:
572
pmap = self.repository.get_parent_map([rev_id])
573
parents = pmap.get(rev_id, [])
574
whitelist.remove(rev_id)
575
whitelist.update(parents)
577
# We've reached the mainline, there is nothing left to
581
# A revision that is not part of the ancestry of our
584
yield (rev_id, merge_depth, revno, end_of_merge)
586
def leave_lock_in_place(self):
587
"""Tell this branch object not to release the physical lock when this
590
If lock_write doesn't return a token, then this method is not supported.
592
self.control_files.leave_in_place()
594
def dont_leave_lock_in_place(self):
595
"""Tell this branch object to release the physical lock when this
596
object is unlocked, even if it didn't originally acquire it.
598
If lock_write doesn't return a token, then this method is not supported.
600
self.control_files.dont_leave_in_place()
602
def bind(self, other):
603
"""Bind the local branch the other branch.
605
:param other: The branch to bind to
608
raise errors.UpgradeRequired(self.user_url)
610
def set_append_revisions_only(self, enabled):
611
if not self._format.supports_set_append_revisions_only():
612
raise errors.UpgradeRequired(self.user_url)
617
self.get_config().set_user_option('append_revisions_only', value,
620
def set_reference_info(self, file_id, tree_path, branch_location):
621
"""Set the branch location to use for a tree reference."""
622
raise errors.UnsupportedOperation(self.set_reference_info, self)
624
def get_reference_info(self, file_id):
625
"""Get the tree_path and branch_location for a tree reference."""
626
raise errors.UnsupportedOperation(self.get_reference_info, self)
629
def fetch(self, from_branch, last_revision=None, pb=None):
630
"""Copy revisions from from_branch into this branch.
632
:param from_branch: Where to copy from.
633
:param last_revision: What revision to stop at (None for at the end
635
:param pb: An optional progress bar to use.
638
if self.base == from_branch.base:
641
symbol_versioning.warn(
642
symbol_versioning.deprecated_in((1, 14, 0))
643
% "pb parameter to fetch()")
644
from_branch.lock_read()
646
if last_revision is None:
647
last_revision = from_branch.last_revision()
648
last_revision = _mod_revision.ensure_null(last_revision)
649
return self.repository.fetch(from_branch.repository,
650
revision_id=last_revision,
655
def get_bound_location(self):
656
"""Return the URL of the branch we are bound to.
658
Older format branches cannot bind, please be sure to use a metadir
663
def get_old_bound_location(self):
664
"""Return the URL of the branch we used to be bound to
666
raise errors.UpgradeRequired(self.user_url)
668
def get_commit_builder(self, parents, config=None, timestamp=None,
669
timezone=None, committer=None, revprops=None,
671
"""Obtain a CommitBuilder for this branch.
673
:param parents: Revision ids of the parents of the new revision.
674
:param config: Optional configuration to use.
675
:param timestamp: Optional timestamp recorded for commit.
676
:param timezone: Optional timezone for timestamp.
677
:param committer: Optional committer to set for commit.
678
:param revprops: Optional dictionary of revision properties.
679
:param revision_id: Optional revision id.
683
config = self.get_config()
685
return self.repository.get_commit_builder(self, parents, config,
686
timestamp, timezone, committer, revprops, revision_id)
688
def get_master_branch(self, possible_transports=None):
689
"""Return the branch we are bound to.
691
:return: Either a Branch, or None
225
raise NotImplementedError('unlock is abstract')
227
def abspath(self, name):
228
"""Return absolute filename for something in the branch
230
XXX: Robert Collins 20051017 what is this used for? why is it a branch
231
method and not a tree method.
233
raise NotImplementedError('abspath is abstract')
235
def controlfilename(self, file_or_path):
236
"""Return location relative to branch."""
237
raise NotImplementedError('controlfilename is abstract')
239
def controlfile(self, file_or_path, mode='r'):
240
"""Open a control file for this branch.
242
There are two classes of file in the control directory: text
243
and binary. binary files are untranslated byte streams. Text
244
control files are stored with Unix newlines and in UTF-8, even
245
if the platform or locale defaults are different.
247
Controlfiles should almost never be opened in write mode but
248
rather should be atomically copied and replaced using atomicfile.
250
raise NotImplementedError('controlfile is abstract')
252
def put_controlfile(self, path, f, encode=True):
253
"""Write an entry as a controlfile.
255
:param path: The path to put the file, relative to the .bzr control
257
:param f: A file-like or string object whose contents should be copied.
258
:param encode: If true, encode the contents as utf-8
260
raise NotImplementedError('put_controlfile is abstract')
262
def put_controlfiles(self, files, encode=True):
263
"""Write several entries as controlfiles.
265
:param files: A list of [(path, file)] pairs, where the path is the directory
266
underneath the bzr control directory
267
:param encode: If true, encode the contents as utf-8
269
raise NotImplementedError('put_controlfiles is abstract')
271
def get_root_id(self):
272
"""Return the id of this branches root"""
273
raise NotImplementedError('get_root_id is abstract')
275
def set_root_id(self, file_id):
276
raise NotImplementedError('set_root_id is abstract')
278
def print_file(self, file, revision_id):
279
"""Print `file` to stdout."""
280
raise NotImplementedError('print_file is abstract')
282
def append_revision(self, *revision_ids):
283
raise NotImplementedError('append_revision is abstract')
285
def set_revision_history(self, rev_history):
286
raise NotImplementedError('set_revision_history is abstract')
288
def has_revision(self, revision_id):
289
"""True if this branch has a copy of the revision.
291
This does not necessarily imply the revision is merge
292
or on the mainline."""
293
raise NotImplementedError('has_revision is abstract')
295
def get_revision_xml(self, revision_id):
296
raise NotImplementedError('get_revision_xml is abstract')
298
def get_revision(self, revision_id):
299
"""Return the Revision object for a named revision"""
300
raise NotImplementedError('get_revision is abstract')
695
302
def get_revision_delta(self, revno):
696
303
"""Return the delta for one revision.
1480
576
* a format string,
1481
577
* an open routine.
1483
Formats are placed in an dict by their format string for reference
579
Formats are placed in an dict by their format string for reference
1484
580
during branch opening. Its not required that these be instances, they
1485
can be classes themselves with class methods - it simply depends on
581
can be classes themselves with class methods - it simply depends on
1486
582
whether state is needed for a given format or not.
1488
584
Once a format is deprecated, just deprecate the initialize and open
1489
methods on the format class. Do not deprecate the object, as the
585
methods on the format class. Do not deprecate the object, as the
1490
586
object will be created every time regardless.
1493
_default_format = None
1494
"""The default format used for new branches."""
1497
590
"""The known formats."""
1499
can_set_append_revisions_only = True
1501
def __eq__(self, other):
1502
return self.__class__ is other.__class__
1504
def __ne__(self, other):
1505
return not (self == other)
1508
def find_format(klass, a_bzrdir, name=None):
1509
"""Return the format for the branch object in a_bzrdir."""
593
def find_format(klass, transport):
594
"""Return the format registered for URL."""
1511
transport = a_bzrdir.get_branch_transport(None, name=name)
1512
format_string = transport.get_bytes("format")
596
format_string = transport.get(".bzr/branch-format").read()
1513
597
return klass._formats[format_string]
1514
except errors.NoSuchFile:
1515
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
599
raise NotBranchError(path=transport.base)
1516
600
except KeyError:
1517
raise errors.UnknownFormatError(format=format_string, kind='branch')
1520
def get_default_format(klass):
1521
"""Return the current default format."""
1522
return klass._default_format
1524
def get_reference(self, a_bzrdir):
1525
"""Get the target reference of the branch in a_bzrdir.
1527
format probing must have been completed before calling
1528
this method - it is assumed that the format of the branch
1529
in a_bzrdir is correct.
1531
:param a_bzrdir: The bzrdir to get the branch data from.
1532
:return: None if the branch is not a reference branch.
1537
def set_reference(self, a_bzrdir, to_branch):
1538
"""Set the target reference of the branch in a_bzrdir.
1540
format probing must have been completed before calling
1541
this method - it is assumed that the format of the branch
1542
in a_bzrdir is correct.
1544
:param a_bzrdir: The bzrdir to set the branch reference for.
1545
:param to_branch: branch that the checkout is to reference
1547
raise NotImplementedError(self.set_reference)
601
raise errors.UnknownFormatError(format_string)
1549
603
def get_format_string(self):
1550
604
"""Return the ASCII format string that identifies this format."""
1551
605
raise NotImplementedError(self.get_format_string)
1553
def get_format_description(self):
1554
"""Return the short format description for this format."""
1555
raise NotImplementedError(self.get_format_description)
1557
def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1558
hooks = Branch.hooks['post_branch_init']
1561
params = BranchInitHookParams(self, a_bzrdir, name, branch)
1565
def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1566
lock_type='metadir', set_format=True):
1567
"""Initialize a branch in a bzrdir, with specified files
1569
:param a_bzrdir: The bzrdir to initialize the branch in
1570
:param utf8_files: The files to create as a list of
1571
(filename, content) tuples
1572
:param name: Name of colocated branch to create, if any
1573
:param set_format: If True, set the format with
1574
self.get_format_string. (BzrBranch4 has its format set
1576
:return: a branch in this format
607
def _find_modes(self, t):
608
"""Determine the appropriate modes for files and directories.
610
FIXME: When this merges into, or from storage,
611
this code becomes delgatable to a LockableFiles instance.
613
For now its cribbed and returns (dir_mode, file_mode)
1578
mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1579
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1581
'metadir': ('lock', lockdir.LockDir),
1582
'branch4': ('branch-lock', lockable_files.TransportLock),
1584
lock_name, lock_class = lock_map[lock_type]
1585
control_files = lockable_files.LockableFiles(branch_transport,
1586
lock_name, lock_class)
1587
control_files.create_lock()
1589
control_files.lock_write()
1590
except errors.LockContention:
1591
if lock_type != 'branch4':
617
except errors.TransportNotPossible:
1597
utf8_files += [('format', self.get_format_string())]
1599
for (filename, content) in utf8_files:
1600
branch_transport.put_bytes(
1602
mode=a_bzrdir._get_file_mode())
1605
control_files.unlock()
1606
branch = self.open(a_bzrdir, name, _found=True)
1607
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
621
dir_mode = st.st_mode & 07777
622
# Remove the sticky and execute bits for files
623
file_mode = dir_mode & ~07111
624
if not BzrBranch._set_dir_mode:
626
if not BzrBranch._set_file_mode:
628
return dir_mode, file_mode
1610
def initialize(self, a_bzrdir, name=None):
1611
"""Create a branch of this format in a_bzrdir.
630
def initialize(self, url):
631
"""Create a branch of this format at url and return an open branch."""
632
t = get_transport(url)
633
from bzrlib.inventory import Inventory
634
from bzrlib.weavefile import write_weave_v5
635
from bzrlib.weave import Weave
1613
:param name: Name of the colocated branch to create.
1615
raise NotImplementedError(self.initialize)
637
# Create an empty inventory
639
# if we want per-tree root ids then this is the place to set
640
# them; they're not needed for now and so ommitted for
642
bzrlib.xml5.serializer_v5.write_inventory(Inventory(), sio)
643
empty_inv = sio.getvalue()
645
bzrlib.weavefile.write_weave_v5(Weave(), sio)
646
empty_weave = sio.getvalue()
648
# Since we don't have a .bzr directory, inherit the
649
# mode from the root directory
650
dir_mode, file_mode = self._find_modes(t)
652
t.mkdir('.bzr', mode=dir_mode)
653
control = t.clone('.bzr')
654
dirs = ['revision-store', 'weaves']
656
StringIO("This is a Bazaar-NG control directory.\n"
657
"Do not change any files in this directory.\n")),
658
('branch-format', StringIO(self.get_format_string())),
659
('revision-history', StringIO('')),
660
('branch-name', StringIO('')),
661
('branch-lock', StringIO('')),
662
('pending-merges', StringIO('')),
663
('inventory', StringIO(empty_inv)),
664
('inventory.weave', StringIO(empty_weave)),
666
control.mkdir_multi(dirs, mode=dir_mode)
667
control.put_multi(files, mode=file_mode)
668
mutter('created control directory in ' + t.base)
669
return BzrBranch(t, format=self)
1617
671
def is_supported(self):
1618
672
"""Is this format supported?
1620
674
Supported formats can be initialized and opened.
1621
Unsupported formats may not support initialization or committing or
675
Unsupported formats may not support initialization or committing or
1622
676
some other features depending on the reason for not being supported.
1626
def make_tags(self, branch):
1627
"""Create a tags object for branch.
1629
This method is on BranchFormat, because BranchFormats are reflected
1630
over the wire via network_name(), whereas full Branch instances require
1631
multiple VFS method calls to operate at all.
1633
The default implementation returns a disabled-tags instance.
1635
Note that it is normal for branch to be a RemoteBranch when using tags
1638
return DisabledTags(branch)
1640
def network_name(self):
1641
"""A simple byte string uniquely identifying this format for RPC calls.
1643
MetaDir branch formats use their disk format string to identify the
1644
repository over the wire. All in one formats such as bzr < 0.8, and
1645
foreign formats like svn/git and hg should use some marker which is
1646
unique and immutable.
1648
raise NotImplementedError(self.network_name)
1650
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1651
"""Return the branch object for a_bzrdir
1653
:param a_bzrdir: A BzrDir that contains a branch.
1654
:param name: Name of colocated branch to open
1655
:param _found: a private parameter, do not use it. It is used to
1656
indicate if format probing has already be done.
1657
:param ignore_fallbacks: when set, no fallback branches will be opened
1658
(if there are any). Default is to open fallbacks.
1660
raise NotImplementedError(self.open)
680
def open(self, transport):
681
"""Fill out the data in branch for the branch at url."""
682
return BzrBranch(transport, format=self)
1663
685
def register_format(klass, format):
1664
"""Register a metadir format."""
1665
686
klass._formats[format.get_format_string()] = format
1666
# Metadir formats have a network name of their format string, and get
1667
# registered as class factories.
1668
network_format_registry.register(format.get_format_string(), format.__class__)
1671
def set_default_format(klass, format):
1672
klass._default_format = format
1674
def supports_set_append_revisions_only(self):
1675
"""True if this format supports set_append_revisions_only."""
1678
def supports_stacking(self):
1679
"""True if this format records a stacked-on branch."""
1683
689
def unregister_format(klass, format):
690
assert klass._formats[format.get_format_string()] is format
1684
691
del klass._formats[format.get_format_string()]
1687
return self.get_format_description().rstrip()
1689
def supports_tags(self):
1690
"""True if this format supports tags stored in the branch"""
1691
return False # by default
1694
class BranchHooks(Hooks):
1695
"""A dictionary mapping hook name to a list of callables for branch hooks.
1697
e.g. ['set_rh'] Is the list of items to be called when the
1698
set_revision_history function is invoked.
1702
"""Create the default hooks.
1704
These are all empty initially, because by default nothing should get
1707
Hooks.__init__(self)
1708
self.create_hook(HookPoint('set_rh',
1709
"Invoked whenever the revision history has been set via "
1710
"set_revision_history. The api signature is (branch, "
1711
"revision_history), and the branch will be write-locked. "
1712
"The set_rh hook can be expensive for bzr to trigger, a better "
1713
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1714
self.create_hook(HookPoint('open',
1715
"Called with the Branch object that has been opened after a "
1716
"branch is opened.", (1, 8), None))
1717
self.create_hook(HookPoint('post_push',
1718
"Called after a push operation completes. post_push is called "
1719
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1720
"bzr client.", (0, 15), None))
1721
self.create_hook(HookPoint('post_pull',
1722
"Called after a pull operation completes. post_pull is called "
1723
"with a bzrlib.branch.PullResult object and only runs in the "
1724
"bzr client.", (0, 15), None))
1725
self.create_hook(HookPoint('pre_commit',
1726
"Called after a commit is calculated but before it is is "
1727
"completed. pre_commit is called with (local, master, old_revno, "
1728
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1729
"). old_revid is NULL_REVISION for the first commit to a branch, "
1730
"tree_delta is a TreeDelta object describing changes from the "
1731
"basis revision. hooks MUST NOT modify this delta. "
1732
" future_tree is an in-memory tree obtained from "
1733
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1734
"tree.", (0,91), None))
1735
self.create_hook(HookPoint('post_commit',
1736
"Called in the bzr client after a commit has completed. "
1737
"post_commit is called with (local, master, old_revno, old_revid, "
1738
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1739
"commit to a branch.", (0, 15), None))
1740
self.create_hook(HookPoint('post_uncommit',
1741
"Called in the bzr client after an uncommit completes. "
1742
"post_uncommit is called with (local, master, old_revno, "
1743
"old_revid, new_revno, new_revid) where local is the local branch "
1744
"or None, master is the target branch, and an empty branch "
1745
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1746
self.create_hook(HookPoint('pre_change_branch_tip',
1747
"Called in bzr client and server before a change to the tip of a "
1748
"branch is made. pre_change_branch_tip is called with a "
1749
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1750
"commit, uncommit will all trigger this hook.", (1, 6), None))
1751
self.create_hook(HookPoint('post_change_branch_tip',
1752
"Called in bzr client and server after a change to the tip of a "
1753
"branch is made. post_change_branch_tip is called with a "
1754
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1755
"commit, uncommit will all trigger this hook.", (1, 4), None))
1756
self.create_hook(HookPoint('transform_fallback_location',
1757
"Called when a stacked branch is activating its fallback "
1758
"locations. transform_fallback_location is called with (branch, "
1759
"url), and should return a new url. Returning the same url "
1760
"allows it to be used as-is, returning a different one can be "
1761
"used to cause the branch to stack on a closer copy of that "
1762
"fallback_location. Note that the branch cannot have history "
1763
"accessing methods called on it during this hook because the "
1764
"fallback locations have not been activated. When there are "
1765
"multiple hooks installed for transform_fallback_location, "
1766
"all are called with the url returned from the previous hook."
1767
"The order is however undefined.", (1, 9), None))
1768
self.create_hook(HookPoint('automatic_tag_name',
1769
"Called to determine an automatic tag name for a revision."
1770
"automatic_tag_name is called with (branch, revision_id) and "
1771
"should return a tag name or None if no tag name could be "
1772
"determined. The first non-None tag name returned will be used.",
1774
self.create_hook(HookPoint('post_branch_init',
1775
"Called after new branch initialization completes. "
1776
"post_branch_init is called with a "
1777
"bzrlib.branch.BranchInitHookParams. "
1778
"Note that init, branch and checkout (both heavyweight and "
1779
"lightweight) will all trigger this hook.", (2, 2), None))
1780
self.create_hook(HookPoint('post_switch',
1781
"Called after a checkout switches branch. "
1782
"post_switch is called with a "
1783
"bzrlib.branch.SwitchHookParams.", (2, 2), None))
1787
# install the default hooks into the Branch class.
1788
Branch.hooks = BranchHooks()
1791
class ChangeBranchTipParams(object):
1792
"""Object holding parameters passed to *_change_branch_tip hooks.
1794
There are 5 fields that hooks may wish to access:
1796
:ivar branch: the branch being changed
1797
:ivar old_revno: revision number before the change
1798
:ivar new_revno: revision number after the change
1799
:ivar old_revid: revision id before the change
1800
:ivar new_revid: revision id after the change
1802
The revid fields are strings. The revno fields are integers.
1805
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1806
"""Create a group of ChangeBranchTip parameters.
1808
:param branch: The branch being changed.
1809
:param old_revno: Revision number before the change.
1810
:param new_revno: Revision number after the change.
1811
:param old_revid: Tip revision id before the change.
1812
:param new_revid: Tip revision id after the change.
1814
self.branch = branch
1815
self.old_revno = old_revno
1816
self.new_revno = new_revno
1817
self.old_revid = old_revid
1818
self.new_revid = new_revid
1820
def __eq__(self, other):
1821
return self.__dict__ == other.__dict__
1824
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1825
self.__class__.__name__, self.branch,
1826
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1829
class BranchInitHookParams(object):
1830
"""Object holding parameters passed to *_branch_init hooks.
1832
There are 4 fields that hooks may wish to access:
1834
:ivar format: the branch format
1835
:ivar bzrdir: the BzrDir where the branch will be/has been initialized
1836
:ivar name: name of colocated branch, if any (or None)
1837
:ivar branch: the branch created
1839
Note that for lightweight checkouts, the bzrdir and format fields refer to
1840
the checkout, hence they are different from the corresponding fields in
1841
branch, which refer to the original branch.
1844
def __init__(self, format, a_bzrdir, name, branch):
1845
"""Create a group of BranchInitHook parameters.
1847
:param format: the branch format
1848
:param a_bzrdir: the BzrDir where the branch will be/has been
1850
:param name: name of colocated branch, if any (or None)
1851
:param branch: the branch created
1853
Note that for lightweight checkouts, the bzrdir and format fields refer
1854
to the checkout, hence they are different from the corresponding fields
1855
in branch, which refer to the original branch.
1857
self.format = format
1858
self.bzrdir = a_bzrdir
1860
self.branch = branch
1862
def __eq__(self, other):
1863
return self.__dict__ == other.__dict__
1867
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1869
return "<%s of format:%s bzrdir:%s>" % (
1870
self.__class__.__name__, self.branch,
1871
self.format, self.bzrdir)
1874
class SwitchHookParams(object):
1875
"""Object holding parameters passed to *_switch hooks.
1877
There are 4 fields that hooks may wish to access:
1879
:ivar control_dir: BzrDir of the checkout to change
1880
:ivar to_branch: branch that the checkout is to reference
1881
:ivar force: skip the check for local commits in a heavy checkout
1882
:ivar revision_id: revision ID to switch to (or None)
1885
def __init__(self, control_dir, to_branch, force, revision_id):
1886
"""Create a group of SwitchHook parameters.
1888
:param control_dir: BzrDir of the checkout to change
1889
:param to_branch: branch that the checkout is to reference
1890
:param force: skip the check for local commits in a heavy checkout
1891
:param revision_id: revision ID to switch to (or None)
1893
self.control_dir = control_dir
1894
self.to_branch = to_branch
1896
self.revision_id = revision_id
1898
def __eq__(self, other):
1899
return self.__dict__ == other.__dict__
1902
return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1903
self.control_dir, self.to_branch,
1907
class BzrBranchFormat4(BranchFormat):
694
class BzrBranchFormat4(BzrBranchFormat):
1908
695
"""Bzr branch format 4.
1910
697
This format has:
1911
- a revision-history file.
1912
- a branch-lock lock file [ to be shared with the bzrdir ]
699
- TextStores for texts, inventories,revisions.
701
This format is deprecated: it indexes texts using a text it which is
702
removed in format 5; write support for this format has been removed.
1915
def get_format_description(self):
1916
"""See BranchFormat.get_format_description()."""
1917
return "Branch format 4"
1919
def initialize(self, a_bzrdir, name=None):
1920
"""Create a branch of this format in a_bzrdir."""
1921
utf8_files = [('revision-history', ''),
1922
('branch-name', ''),
1924
return self._initialize_helper(a_bzrdir, utf8_files, name=name,
1925
lock_type='branch4', set_format=False)
1928
super(BzrBranchFormat4, self).__init__()
1929
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1931
def network_name(self):
1932
"""The network name for this format is the control dirs disk label."""
1933
return self._matchingbzrdir.get_format_string()
1935
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1936
"""See BranchFormat.open()."""
1938
# we are being called directly and must probe.
1939
raise NotImplementedError
1940
return BzrBranch(_format=self,
1941
_control_files=a_bzrdir._control_files,
1944
_repository=a_bzrdir.open_repository())
1947
return "Bazaar-NG branch format 4"
1950
class BranchFormatMetadir(BranchFormat):
1951
"""Common logic for meta-dir based branch formats."""
1953
def _branch_class(self):
1954
"""What class to instantiate on open calls."""
1955
raise NotImplementedError(self._branch_class)
1957
def network_name(self):
1958
"""A simple byte string uniquely identifying this format for RPC calls.
1960
Metadir branch formats use their format string.
705
def get_format_string(self):
706
"""See BzrBranchFormat.get_format_string()."""
707
return BZR_BRANCH_FORMAT_4
709
def initialize(self, url):
710
"""Format 4 branches cannot be created."""
711
raise UninitializableFormat(self)
713
def is_supported(self):
714
"""Format 4 is not supported.
716
It is not supported because the model changed from 4 to 5 and the
717
conversion logic is expensive - so doing it on the fly was not
1962
return self.get_format_string()
1964
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1965
"""See BranchFormat.open()."""
1967
format = BranchFormat.find_format(a_bzrdir, name=name)
1968
if format.__class__ != self.__class__:
1969
raise AssertionError("wrong format %r found for %r" %
1971
transport = a_bzrdir.get_branch_transport(None, name=name)
1973
control_files = lockable_files.LockableFiles(transport, 'lock',
1975
return self._branch_class()(_format=self,
1976
_control_files=control_files,
1979
_repository=a_bzrdir.find_repository(),
1980
ignore_fallbacks=ignore_fallbacks)
1981
except errors.NoSuchFile:
1982
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1985
super(BranchFormatMetadir, self).__init__()
1986
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1987
self._matchingbzrdir.set_branch_format(self)
1989
def supports_tags(self):
1993
class BzrBranchFormat5(BranchFormatMetadir):
723
class BzrBranchFormat5(BzrBranchFormat):
1994
724
"""Bzr branch format 5.
1996
726
This format has:
1997
- a revision-history file.
1999
- a lock dir guarding the branch itself
2000
- all of this stored in a branch/ subdirectory
2001
- works with shared repositories.
2003
This format is new in bzr 0.8.
2006
def _branch_class(self):
2009
def get_format_string(self):
2010
"""See BranchFormat.get_format_string()."""
2011
return "Bazaar-NG branch format 5\n"
2013
def get_format_description(self):
2014
"""See BranchFormat.get_format_description()."""
2015
return "Branch format 5"
2017
def initialize(self, a_bzrdir, name=None):
2018
"""Create a branch of this format in a_bzrdir."""
2019
utf8_files = [('revision-history', ''),
2020
('branch-name', ''),
2022
return self._initialize_helper(a_bzrdir, utf8_files, name)
2024
def supports_tags(self):
2028
class BzrBranchFormat6(BranchFormatMetadir):
2029
"""Branch format with last-revision and tags.
2031
Unlike previous formats, this has no explicit revision history. Instead,
2032
this just stores the last-revision, and the left-hand history leading
2033
up to there is the history.
2035
This format was introduced in bzr 0.15
2036
and became the default in 0.91.
2039
def _branch_class(self):
2042
def get_format_string(self):
2043
"""See BranchFormat.get_format_string()."""
2044
return "Bazaar Branch Format 6 (bzr 0.15)\n"
2046
def get_format_description(self):
2047
"""See BranchFormat.get_format_description()."""
2048
return "Branch format 6"
2050
def initialize(self, a_bzrdir, name=None):
2051
"""Create a branch of this format in a_bzrdir."""
2052
utf8_files = [('last-revision', '0 null:\n'),
2053
('branch.conf', ''),
2056
return self._initialize_helper(a_bzrdir, utf8_files, name)
2058
def make_tags(self, branch):
2059
"""See bzrlib.branch.BranchFormat.make_tags()."""
2060
return BasicTags(branch)
2062
def supports_set_append_revisions_only(self):
2066
class BzrBranchFormat8(BranchFormatMetadir):
2067
"""Metadir format supporting storing locations of subtree branches."""
2069
def _branch_class(self):
2072
def get_format_string(self):
2073
"""See BranchFormat.get_format_string()."""
2074
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2076
def get_format_description(self):
2077
"""See BranchFormat.get_format_description()."""
2078
return "Branch format 8"
2080
def initialize(self, a_bzrdir, name=None):
2081
"""Create a branch of this format in a_bzrdir."""
2082
utf8_files = [('last-revision', '0 null:\n'),
2083
('branch.conf', ''),
2087
return self._initialize_helper(a_bzrdir, utf8_files, name)
2090
super(BzrBranchFormat8, self).__init__()
2091
self._matchingbzrdir.repository_format = \
2092
RepositoryFormatKnitPack5RichRoot()
2094
def make_tags(self, branch):
2095
"""See bzrlib.branch.BranchFormat.make_tags()."""
2096
return BasicTags(branch)
2098
def supports_set_append_revisions_only(self):
2101
def supports_stacking(self):
2104
supports_reference_locations = True
2107
class BzrBranchFormat7(BzrBranchFormat8):
2108
"""Branch format with last-revision, tags, and a stacked location pointer.
2110
The stacked location pointer is passed down to the repository and requires
2111
a repository format with supports_external_lookups = True.
2113
This format was introduced in bzr 1.6.
2116
def initialize(self, a_bzrdir, name=None):
2117
"""Create a branch of this format in a_bzrdir."""
2118
utf8_files = [('last-revision', '0 null:\n'),
2119
('branch.conf', ''),
2122
return self._initialize_helper(a_bzrdir, utf8_files, name)
2124
def _branch_class(self):
2127
def get_format_string(self):
2128
"""See BranchFormat.get_format_string()."""
2129
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
2131
def get_format_description(self):
2132
"""See BranchFormat.get_format_description()."""
2133
return "Branch format 7"
2135
def supports_set_append_revisions_only(self):
2138
supports_reference_locations = False
2141
class BranchReferenceFormat(BranchFormat):
2142
"""Bzr branch reference format.
2144
Branch references are used in implementing checkouts, they
2145
act as an alias to the real branch which is at some other url.
727
- weaves for file texts and inventory
729
- TextStores for revisions and signatures.
732
def get_format_string(self):
733
"""See BzrBranchFormat.get_format_string()."""
734
return BZR_BRANCH_FORMAT_5
737
class BzrBranchFormat6(BzrBranchFormat):
738
"""Bzr branch format 6.
2147
740
This format has:
741
- weaves for file texts and inventory
742
- hash subdirectory based stores.
743
- TextStores for revisions and signatures.
2152
746
def get_format_string(self):
2153
"""See BranchFormat.get_format_string()."""
2154
return "Bazaar-NG Branch Reference Format 1\n"
2156
def get_format_description(self):
2157
"""See BranchFormat.get_format_description()."""
2158
return "Checkout reference format 1"
2160
def get_reference(self, a_bzrdir):
2161
"""See BranchFormat.get_reference()."""
2162
transport = a_bzrdir.get_branch_transport(None)
2163
return transport.get_bytes('location')
2165
def set_reference(self, a_bzrdir, to_branch):
2166
"""See BranchFormat.set_reference()."""
2167
transport = a_bzrdir.get_branch_transport(None)
2168
location = transport.put_bytes('location', to_branch.base)
2170
def initialize(self, a_bzrdir, name=None, target_branch=None):
2171
"""Create a branch of this format in a_bzrdir."""
2172
if target_branch is None:
2173
# this format does not implement branch itself, thus the implicit
2174
# creation contract must see it as uninitializable
2175
raise errors.UninitializableFormat(self)
2176
mutter('creating branch reference in %s', a_bzrdir.user_url)
2177
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2178
branch_transport.put_bytes('location',
2179
target_branch.bzrdir.user_url)
2180
branch_transport.put_bytes('format', self.get_format_string())
2182
a_bzrdir, name, _found=True,
2183
possible_transports=[target_branch.bzrdir.root_transport])
2184
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2188
super(BranchReferenceFormat, self).__init__()
2189
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2190
self._matchingbzrdir.set_branch_format(self)
2192
def _make_reference_clone_function(format, a_branch):
2193
"""Create a clone() routine for a branch dynamically."""
2194
def clone(to_bzrdir, revision_id=None,
2195
repository_policy=None):
2196
"""See Branch.clone()."""
2197
return format.initialize(to_bzrdir, target_branch=a_branch)
2198
# cannot obey revision_id limits when cloning a reference ...
2199
# FIXME RBC 20060210 either nuke revision_id for clone, or
2200
# emit some sort of warning/error to the caller ?!
2203
def open(self, a_bzrdir, name=None, _found=False, location=None,
2204
possible_transports=None, ignore_fallbacks=False):
2205
"""Return the branch that the branch reference in a_bzrdir points at.
2207
:param a_bzrdir: A BzrDir that contains a branch.
2208
:param name: Name of colocated branch to open, if any
2209
:param _found: a private parameter, do not use it. It is used to
2210
indicate if format probing has already be done.
2211
:param ignore_fallbacks: when set, no fallback branches will be opened
2212
(if there are any). Default is to open fallbacks.
2213
:param location: The location of the referenced branch. If
2214
unspecified, this will be determined from the branch reference in
2216
:param possible_transports: An optional reusable transports list.
2219
format = BranchFormat.find_format(a_bzrdir, name=name)
2220
if format.__class__ != self.__class__:
2221
raise AssertionError("wrong format %r found for %r" %
2223
if location is None:
2224
location = self.get_reference(a_bzrdir)
2225
real_bzrdir = bzrdir.BzrDir.open(
2226
location, possible_transports=possible_transports)
2227
result = real_bzrdir.open_branch(name=name,
2228
ignore_fallbacks=ignore_fallbacks)
2229
# this changes the behaviour of result.clone to create a new reference
2230
# rather than a copy of the content of the branch.
2231
# I did not use a proxy object because that needs much more extensive
2232
# testing, and we are only changing one behaviour at the moment.
2233
# If we decide to alter more behaviours - i.e. the implicit nickname
2234
# then this should be refactored to introduce a tested proxy branch
2235
# and a subclass of that for use in overriding clone() and ....
2237
result.clone = self._make_reference_clone_function(result)
2241
network_format_registry = registry.FormatRegistry()
2242
"""Registry of formats indexed by their network name.
2244
The network name for a branch format is an identifier that can be used when
2245
referring to formats with smart server operations. See
2246
BranchFormat.network_name() for more detail.
2250
# formats which have no format string are not discoverable
2251
# and not independently creatable, so are not registered.
2252
__format5 = BzrBranchFormat5()
2253
__format6 = BzrBranchFormat6()
2254
__format7 = BzrBranchFormat7()
2255
__format8 = BzrBranchFormat8()
2256
BranchFormat.register_format(__format5)
2257
BranchFormat.register_format(BranchReferenceFormat())
2258
BranchFormat.register_format(__format6)
2259
BranchFormat.register_format(__format7)
2260
BranchFormat.register_format(__format8)
2261
BranchFormat.set_default_format(__format7)
2262
_legacy_formats = [BzrBranchFormat4(),
2264
network_format_registry.register(
2265
_legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2268
class BzrBranch(Branch, _RelockDebugMixin):
747
"""See BzrBranchFormat.get_format_string()."""
748
return BZR_BRANCH_FORMAT_6
751
BzrBranchFormat.register_format(BzrBranchFormat4())
752
BzrBranchFormat.register_format(BzrBranchFormat5())
753
BzrBranchFormat.register_format(BzrBranchFormat6())
755
# TODO: jam 20060108 Create a new branch format, and as part of upgrade
756
# make sure that ancestry.weave is deleted (it is never used, but
757
# used to be created)
760
class BzrBranch(Branch):
2269
761
"""A branch stored in the actual filesystem.
2271
763
Note that it's "local" in the context of the filesystem; it doesn't
2272
764
really matter if it's on an nfs/smb/afs/coda/... share, as long as
2273
765
it's writable, and can be accessed via the normal filesystem API.
2275
:ivar _transport: Transport for file operations on this branch's
2276
control files, typically pointing to the .bzr/branch directory.
2277
:ivar repository: Repository for this branch.
2278
:ivar base: The url of the base directory for this branch; the one
2279
containing the .bzr directory.
2280
:ivar name: Optional colocated branch name as it exists in the control
771
If _lock_mode is true, a positive count of the number of times the
775
Lock object from bzrlib.lock.
2284
def __init__(self, _format=None,
2285
_control_files=None, a_bzrdir=None, name=None,
2286
_repository=None, ignore_fallbacks=False):
2287
"""Create new branch object at a particular location."""
2288
if a_bzrdir is None:
2289
raise ValueError('a_bzrdir must be supplied')
2291
self.bzrdir = a_bzrdir
2292
self._base = self.bzrdir.transport.clone('..').base
2294
# XXX: We should be able to just do
2295
# self.base = self.bzrdir.root_transport.base
2296
# but this does not quite work yet -- mbp 20080522
2297
self._format = _format
2298
if _control_files is None:
2299
raise ValueError('BzrBranch _control_files is None')
2300
self.control_files = _control_files
2301
self._transport = _control_files._transport
2302
self.repository = _repository
2303
Branch.__init__(self)
777
# We actually expect this class to be somewhat short-lived; part of its
778
# purpose is to try to isolate what bits of the branch logic are tied to
779
# filesystem access, so that in a later step, we can extricate them to
780
# a separarte ("storage") class.
784
_inventory_weave = None
785
# If set to False (by a plugin, etc) BzrBranch will not set the
786
# mode on created files or directories
787
_set_file_mode = True
790
# Map some sort of prefix into a namespace
791
# stuff like "revno:10", "revid:", etc.
792
# This should match a prefix with a function which accepts
793
REVISION_NAMESPACES = {}
795
def push_stores(self, branch_to):
796
"""See Branch.push_stores."""
797
if (not isinstance(self._branch_format, BzrBranchFormat4) or
798
self._branch_format != branch_to._branch_format):
799
from bzrlib.fetch import greedy_fetch
800
mutter("Using fetch logic to push between %s(%s) and %s(%s)",
801
self, self._branch_format, branch_to, branch_to._branch_format)
802
greedy_fetch(to_branch=branch_to, from_branch=self,
803
revision=self.last_revision())
806
# format 4 to format 4 logic only.
807
store_pairs = ((self.text_store, branch_to.text_store),
808
(self.inventory_store, branch_to.inventory_store),
809
(self.revision_store, branch_to.revision_store))
811
for from_store, to_store in store_pairs:
812
copy_all(from_store, to_store)
813
except UnlistableStore:
814
raise UnlistableBranch(from_store)
816
def __init__(self, transport, init=deprecated_nonce,
817
relax_version_check=deprecated_nonce, format=None):
818
"""Create new branch object at a particular location.
820
transport -- A Transport object, defining how to access files.
822
init -- If True, create new control files in a previously
823
unversioned directory. If False, the branch must already
826
relax_version_check -- If true, the usual check for the branch
827
version is not applied. This is intended only for
828
upgrade/recovery type use; it's not guaranteed that
829
all operations will work on old format branches.
831
In the test suite, creation of new trees is tested using the
832
`ScratchBranch` class.
834
assert isinstance(transport, Transport), \
835
"%r is not a Transport" % transport
836
self._transport = transport
837
if deprecated_passed(init):
838
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
839
"deprecated as of bzr 0.8. Please use Branch.initialize().",
842
# this is slower than before deprecation, oh well never mind.
844
self._initialize(transport.base)
846
self._check_format(format)
847
if deprecated_passed(relax_version_check):
848
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
849
"relax_version_check parameter is deprecated as of bzr 0.8. "
850
"Please use Branch.open_downlevel, or a BzrBranchFormat's "
851
"open() method.", DeprecationWarning)
852
if (not relax_version_check
853
and not self._branch_format.is_supported()):
854
raise errors.UnsupportedFormatError(
855
'sorry, branch format %r not supported' % fmt,
856
['use a different bzr version',
857
'or remove the .bzr directory'
858
' and "bzr init" again'])
860
def get_store(name, compressed=True, prefixed=False):
861
relpath = self._rel_controlfilename(safe_unicode(name))
862
store = TextStore(self._transport.clone(relpath),
863
dir_mode=self._dir_mode,
864
file_mode=self._file_mode,
866
compressed=compressed)
869
def get_weave(name, prefixed=False):
870
relpath = self._rel_controlfilename(unicode(name))
871
ws = WeaveStore(self._transport.clone(relpath),
873
dir_mode=self._dir_mode,
874
file_mode=self._file_mode)
875
if self._transport.should_cache():
876
ws.enable_cache = True
879
if isinstance(self._branch_format, BzrBranchFormat4):
880
self.inventory_store = get_store('inventory-store')
881
self.text_store = get_store('text-store')
882
self.revision_store = get_store('revision-store')
883
elif isinstance(self._branch_format, BzrBranchFormat5):
884
self.control_weaves = get_weave(u'')
885
self.weave_store = get_weave(u'weaves')
886
self.revision_store = get_store(u'revision-store', compressed=False)
887
elif isinstance(self._branch_format, BzrBranchFormat6):
888
self.control_weaves = get_weave(u'')
889
self.weave_store = get_weave(u'weaves', prefixed=True)
890
self.revision_store = get_store(u'revision-store', compressed=False,
892
self.revision_store.register_suffix('sig')
893
self._transaction = None
896
def _initialize(base):
897
"""Create a bzr branch in the latest format."""
898
return BzrBranchFormat6().initialize(base)
2305
900
def __str__(self):
2306
if self.name is None:
2307
return '%s(%s)' % (self.__class__.__name__, self.user_url)
2309
return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
901
return '%s(%r)' % (self.__class__.__name__, self._transport.base)
2312
903
__repr__ = __str__
906
if self._lock_mode or self._lock:
907
# XXX: This should show something every time, and be suitable for
908
# headless operation and embedding
909
warn("branch %r was not explicitly unlocked" % self)
912
# TODO: It might be best to do this somewhere else,
913
# but it is nice for a Branch object to automatically
914
# cache it's information.
915
# Alternatively, we could have the Transport objects cache requests
916
# See the earlier discussion about how major objects (like Branch)
917
# should never expect their __del__ function to run.
918
if hasattr(self, 'cache_root') and self.cache_root is not None:
920
shutil.rmtree(self.cache_root)
923
self.cache_root = None
2314
925
def _get_base(self):
2315
"""Returns the directory containing the control directory."""
927
return self._transport.base
2318
930
base = property(_get_base, doc="The URL for the root of this branch.")
2320
def _get_config(self):
2321
return TransportConfig(self._transport, 'branch.conf')
2323
def is_locked(self):
2324
return self.control_files.is_locked()
2326
def lock_write(self, token=None):
2327
if not self.is_locked():
2328
self._note_lock('w')
2329
# All-in-one needs to always unlock/lock.
2330
repo_control = getattr(self.repository, 'control_files', None)
2331
if self.control_files == repo_control or not self.is_locked():
2332
self.repository._warn_if_deprecated(self)
2333
self.repository.lock_write()
2338
return self.control_files.lock_write(token=token)
2341
self.repository.unlock()
932
def _finish_transaction(self):
933
"""Exit the current transaction."""
934
if self._transaction is None:
935
raise errors.LockError('Branch %s is not in a transaction' %
937
transaction = self._transaction
938
self._transaction = None
941
def get_transaction(self):
942
"""See Branch.get_transaction."""
943
if self._transaction is None:
944
return transactions.PassThroughTransaction()
946
return self._transaction
948
def _set_transaction(self, new_transaction):
949
"""Set a new active transaction."""
950
if self._transaction is not None:
951
raise errors.LockError('Branch %s is in a transaction already.' %
953
self._transaction = new_transaction
955
def lock_write(self):
956
#mutter("lock write: %s (%s)", self, self._lock_count)
957
# TODO: Upgrade locking to support using a Transport,
958
# and potentially a remote locking protocol
960
if self._lock_mode != 'w':
961
raise LockError("can't upgrade to a write lock from %r" %
963
self._lock_count += 1
965
self._lock = self._transport.lock_write(
966
self._rel_controlfilename('branch-lock'))
967
self._lock_mode = 'w'
969
self._set_transaction(transactions.PassThroughTransaction())
2344
971
def lock_read(self):
2345
if not self.is_locked():
2346
self._note_lock('r')
2347
# All-in-one needs to always unlock/lock.
2348
repo_control = getattr(self.repository, 'control_files', None)
2349
if self.control_files == repo_control or not self.is_locked():
2350
self.repository._warn_if_deprecated(self)
2351
self.repository.lock_read()
972
#mutter("lock read: %s (%s)", self, self._lock_count)
974
assert self._lock_mode in ('r', 'w'), \
975
"invalid lock mode %r" % self._lock_mode
976
self._lock_count += 1
2356
self.control_files.lock_read()
2359
self.repository.unlock()
2362
@only_raises(errors.LockNotHeld, errors.LockBroken)
978
self._lock = self._transport.lock_read(
979
self._rel_controlfilename('branch-lock'))
980
self._lock_mode = 'r'
982
self._set_transaction(transactions.ReadOnlyTransaction())
983
# 5K may be excessive, but hey, its a knob.
984
self.get_transaction().set_cache_size(5000)
2363
986
def unlock(self):
987
#mutter("unlock: %s (%s)", self, self._lock_count)
988
if not self._lock_mode:
989
raise LockError('branch %r is not locked' % (self))
991
if self._lock_count > 1:
992
self._lock_count -= 1
994
self._finish_transaction()
997
self._lock_mode = self._lock_count = None
999
def abspath(self, name):
1000
"""See Branch.abspath."""
1001
return self._transport.abspath(name)
1003
def _rel_controlfilename(self, file_or_path):
1004
if not isinstance(file_or_path, basestring):
1005
file_or_path = u'/'.join(file_or_path)
1006
if file_or_path == '':
1007
return bzrlib.BZRDIR
1008
return bzrlib.transport.urlescape(bzrlib.BZRDIR + u'/' + file_or_path)
1010
def controlfilename(self, file_or_path):
1011
"""See Branch.controlfilename."""
1012
return self._transport.abspath(self._rel_controlfilename(file_or_path))
1014
def controlfile(self, file_or_path, mode='r'):
1015
"""See Branch.controlfile."""
1018
relpath = self._rel_controlfilename(file_or_path)
1019
#TODO: codecs.open() buffers linewise, so it was overloaded with
1020
# a much larger buffer, do we need to do the same for getreader/getwriter?
1022
return self._transport.get(relpath)
1024
raise BzrError("Branch.controlfile(mode='wb') is not supported, use put_controlfiles")
1026
# XXX: Do we really want errors='replace'? Perhaps it should be
1027
# an error, or at least reported, if there's incorrectly-encoded
1028
# data inside a file.
1029
# <https://launchpad.net/products/bzr/+bug/3823>
1030
return codecs.getreader('utf-8')(self._transport.get(relpath), errors='replace')
1032
raise BzrError("Branch.controlfile(mode='w') is not supported, use put_controlfiles")
1034
raise BzrError("invalid controlfile mode %r" % mode)
1036
def put_controlfile(self, path, f, encode=True):
1037
"""See Branch.put_controlfile."""
1038
self.put_controlfiles([(path, f)], encode=encode)
1040
def put_controlfiles(self, files, encode=True):
1041
"""See Branch.put_controlfiles."""
1044
for path, f in files:
1046
if isinstance(f, basestring):
1047
f = f.encode('utf-8', 'replace')
1049
f = codecs.getwriter('utf-8')(f, errors='replace')
1050
path = self._rel_controlfilename(path)
1051
ctrl_files.append((path, f))
1052
self._transport.put_multi(ctrl_files, mode=self._file_mode)
1054
def _find_modes(self, path=None):
1055
"""Determine the appropriate modes for files and directories."""
2365
self.control_files.unlock()
2367
# All-in-one needs to always unlock/lock.
2368
repo_control = getattr(self.repository, 'control_files', None)
2369
if (self.control_files == repo_control or
2370
not self.control_files.is_locked()):
2371
self.repository.unlock()
2372
if not self.control_files.is_locked():
2373
# we just released the lock
2374
self._clear_cached_state()
2376
def peek_lock_mode(self):
2377
if self.control_files._lock_count == 0:
1058
path = self._rel_controlfilename('')
1059
st = self._transport.stat(path)
1060
except errors.TransportNotPossible:
1061
self._dir_mode = 0755
1062
self._file_mode = 0644
2380
return self.control_files._lock_mode
2382
def get_physical_lock_status(self):
2383
return self.control_files.get_physical_lock_status()
1064
self._dir_mode = st.st_mode & 07777
1065
# Remove the sticky and execute bits for files
1066
self._file_mode = self._dir_mode & ~07111
1067
if not self._set_dir_mode:
1068
self._dir_mode = None
1069
if not self._set_file_mode:
1070
self._file_mode = None
1072
def _check_format(self, format):
1073
"""Identify the branch format if needed.
1075
The format is stored as a reference to the format object in
1076
self._branch_format for code that needs to check it later.
1078
The format parameter is either None or the branch format class
1079
used to open this branch.
1082
format = BzrBranchFormat.find_format(self._transport)
1083
self._branch_format = format
1084
mutter("got branch format %s", self._branch_format)
1087
def get_root_id(self):
1088
"""See Branch.get_root_id."""
1089
inv = self.get_inventory(self.last_revision())
1090
return inv.root.file_id
2385
1092
@needs_read_lock
2386
1093
def print_file(self, file, revision_id):
2387
1094
"""See Branch.print_file."""
2388
return self.repository.print_file(file, revision_id)
2390
def _write_revision_history(self, history):
2391
"""Factored out of set_revision_history.
2393
This performs the actual writing to disk.
2394
It is intended to be called by BzrBranch5.set_revision_history."""
2395
self._transport.put_bytes(
2396
'revision-history', '\n'.join(history),
2397
mode=self.bzrdir._get_file_mode())
1095
tree = self.revision_tree(revision_id)
1096
# use inventory as it was in that revision
1097
file_id = tree.inventory.path2id(file)
1100
revno = self.revision_id_to_revno(revision_id)
1101
except errors.NoSuchRevision:
1102
# TODO: This should not be BzrError,
1103
# but NoSuchFile doesn't fit either
1104
raise BzrError('%r is not present in revision %s'
1105
% (file, revision_id))
1107
raise BzrError('%r is not present in revision %s'
1109
tree.print_file(file_id)
1112
def append_revision(self, *revision_ids):
1113
"""See Branch.append_revision."""
1114
for revision_id in revision_ids:
1115
mutter("add {%s} to revision-history" % revision_id)
1116
rev_history = self.revision_history()
1117
rev_history.extend(revision_ids)
1118
self.set_revision_history(rev_history)
2399
1120
@needs_write_lock
2400
1121
def set_revision_history(self, rev_history):
2401
1122
"""See Branch.set_revision_history."""
2402
if 'evil' in debug.debug_flags:
2403
mutter_callsite(3, "set_revision_history scales with history.")
2404
check_not_reserved_id = _mod_revision.check_not_reserved_id
2405
for rev_id in rev_history:
2406
check_not_reserved_id(rev_id)
2407
if Branch.hooks['post_change_branch_tip']:
2408
# Don't calculate the last_revision_info() if there are no hooks
2410
old_revno, old_revid = self.last_revision_info()
2411
if len(rev_history) == 0:
2412
revid = _mod_revision.NULL_REVISION
1123
old_revision = self.last_revision()
1124
new_revision = rev_history[-1]
1125
self.put_controlfile('revision-history', '\n'.join(rev_history))
1127
self.working_tree().set_last_revision(new_revision, old_revision)
1128
except NoWorkingTree:
1129
mutter('Unable to set_last_revision without a working tree.')
1131
def has_revision(self, revision_id):
1132
"""See Branch.has_revision."""
1133
return (revision_id is None
1134
or self.revision_store.has_id(revision_id))
1137
def _get_revision_xml_file(self, revision_id):
1138
if not revision_id or not isinstance(revision_id, basestring):
1139
raise InvalidRevisionId(revision_id=revision_id, branch=self)
1141
return self.revision_store.get(revision_id)
1142
except (IndexError, KeyError):
1143
raise bzrlib.errors.NoSuchRevision(self, revision_id)
1145
def get_revision_xml(self, revision_id):
1146
"""See Branch.get_revision_xml."""
1147
return self._get_revision_xml_file(revision_id).read()
1149
def get_revision(self, revision_id):
1150
"""See Branch.get_revision."""
1151
xml_file = self._get_revision_xml_file(revision_id)
1154
r = bzrlib.xml5.serializer_v5.read_revision(xml_file)
1155
except SyntaxError, e:
1156
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
1160
assert r.revision_id == revision_id
1163
def get_revision_sha1(self, revision_id):
1164
"""See Branch.get_revision_sha1."""
1165
# In the future, revision entries will be signed. At that
1166
# point, it is probably best *not* to include the signature
1167
# in the revision hash. Because that lets you re-sign
1168
# the revision, (add signatures/remove signatures) and still
1169
# have all hash pointers stay consistent.
1170
# But for now, just hash the contents.
1171
return bzrlib.osutils.sha_file(self.get_revision_xml_file(revision_id))
1173
def get_ancestry(self, revision_id):
1174
"""See Branch.get_ancestry."""
1175
if revision_id is None:
1177
w = self._get_inventory_weave()
1178
return [None] + map(w.idx_to_name,
1179
w.inclusions([w.lookup(revision_id)]))
1181
def _get_inventory_weave(self):
1182
return self.control_weaves.get_weave('inventory',
1183
self.get_transaction())
1185
def get_inventory(self, revision_id):
1186
"""See Branch.get_inventory."""
1187
xml = self.get_inventory_xml(revision_id)
1188
return bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
1190
def get_inventory_xml(self, revision_id):
1191
"""See Branch.get_inventory_xml."""
1193
assert isinstance(revision_id, basestring), type(revision_id)
1194
iw = self._get_inventory_weave()
1195
return iw.get_text(iw.lookup(revision_id))
1197
raise bzrlib.errors.HistoryMissing(self, 'inventory', revision_id)
1199
def get_inventory_sha1(self, revision_id):
1200
"""See Branch.get_inventory_sha1."""
1201
return self.get_revision(revision_id).inventory_sha1
1203
def get_revision_inventory(self, revision_id):
1204
"""See Branch.get_revision_inventory."""
1205
# TODO: Unify this with get_inventory()
1206
# bzr 0.0.6 and later imposes the constraint that the inventory_id
1207
# must be the same as its revision, so this is trivial.
1208
if revision_id == None:
1209
# This does not make sense: if there is no revision,
1210
# then it is the current tree inventory surely ?!
1211
# and thus get_root_id() is something that looks at the last
1212
# commit on the branch, and the get_root_id is an inventory check.
1213
raise NotImplementedError
1214
# return Inventory(self.get_root_id())
2414
revid = rev_history[-1]
2415
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2416
self._write_revision_history(rev_history)
2417
self._clear_cached_state()
2418
self._cache_revision_history(rev_history)
2419
for hook in Branch.hooks['set_rh']:
2420
hook(self, rev_history)
2421
if Branch.hooks['post_change_branch_tip']:
2422
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2424
def _synchronize_history(self, destination, revision_id):
2425
"""Synchronize last revision and revision history between branches.
2427
This version is most efficient when the destination is also a
2428
BzrBranch5, but works for BzrBranch6 as long as the revision
2429
history is the true lefthand parent history, and all of the revisions
2430
are in the destination's repository. If not, set_revision_history
2433
:param destination: The branch to copy the history into
2434
:param revision_id: The revision-id to truncate history at. May
2435
be None to copy complete history.
2437
if not isinstance(destination._format, BzrBranchFormat5):
2438
super(BzrBranch, self)._synchronize_history(
2439
destination, revision_id)
1216
return self.get_inventory(revision_id)
1219
def revision_history(self):
1220
"""See Branch.revision_history."""
1221
transaction = self.get_transaction()
1222
history = transaction.map.find_revision_history()
1223
if history is not None:
1224
mutter("cache hit for revision-history in %s", self)
1225
return list(history)
1226
history = [l.rstrip('\r\n') for l in
1227
self.controlfile('revision-history', 'r').readlines()]
1228
transaction.map.add_revision_history(history)
1229
# this call is disabled because revision_history is
1230
# not really an object yet, and the transaction is for objects.
1231
# transaction.register_clean(history, precious=True)
1232
return list(history)
1234
def update_revisions(self, other, stop_revision=None):
1235
"""See Branch.update_revisions."""
1236
from bzrlib.fetch import greedy_fetch
1237
if stop_revision is None:
1238
stop_revision = other.last_revision()
1239
### Should this be checking is_ancestor instead of revision_history?
1240
if (stop_revision is not None and
1241
stop_revision in self.revision_history()):
2441
if revision_id == _mod_revision.NULL_REVISION:
2444
new_history = self.revision_history()
2445
if revision_id is not None and new_history != []:
1243
greedy_fetch(to_branch=self, from_branch=other,
1244
revision=stop_revision)
1245
pullable_revs = self.pullable_revisions(other, stop_revision)
1246
if len(pullable_revs) > 0:
1247
self.append_revision(*pullable_revs)
1249
def pullable_revisions(self, other, stop_revision):
1250
"""See Branch.pullable_revisions."""
1251
other_revno = other.revision_id_to_revno(stop_revision)
1253
return self.missing_revisions(other, other_revno)
1254
except DivergedBranches, e:
2447
new_history = new_history[:new_history.index(revision_id) + 1]
2449
rev = self.repository.get_revision(revision_id)
2450
new_history = rev.get_history(self.repository)[1:]
2451
destination.set_revision_history(new_history)
2454
def set_last_revision_info(self, revno, revision_id):
2455
"""Set the last revision of this branch.
2457
The caller is responsible for checking that the revno is correct
2458
for this revision id.
2460
It may be possible to set the branch last revision to an id not
2461
present in the repository. However, branches can also be
2462
configured to check constraints on history, in which case this may not
2465
revision_id = _mod_revision.ensure_null(revision_id)
2466
# this old format stores the full history, but this api doesn't
2467
# provide it, so we must generate, and might as well check it's
2469
history = self._lefthand_history(revision_id)
2470
if len(history) != revno:
2471
raise AssertionError('%d != %d' % (len(history), revno))
2472
self.set_revision_history(history)
2474
def _gen_revision_history(self):
2475
history = self._transport.get_bytes('revision-history').split('\n')
2476
if history[-1:] == ['']:
2477
# There shouldn't be a trailing newline, but just in case.
2482
def generate_revision_history(self, revision_id, last_rev=None,
2484
"""Create a new revision history that will finish with revision_id.
2486
:param revision_id: the new tip to use.
2487
:param last_rev: The previous last_revision. If not None, then this
2488
must be a ancestory of revision_id, or DivergedBranches is raised.
2489
:param other_branch: The other branch that DivergedBranches should
2490
raise with respect to.
2492
self.set_revision_history(self._lefthand_history(revision_id,
2493
last_rev, other_branch))
1256
pullable_revs = get_intervening_revisions(self.last_revision(),
1257
stop_revision, self)
1258
assert self.last_revision() not in pullable_revs
1259
return pullable_revs
1260
except bzrlib.errors.NotAncestor:
1261
if is_ancestor(self.last_revision(), stop_revision, self):
1266
def revision_tree(self, revision_id):
1267
"""See Branch.revision_tree."""
1268
# TODO: refactor this to use an existing revision object
1269
# so we don't need to read it in twice.
1270
if revision_id == None or revision_id == NULL_REVISION:
1273
inv = self.get_revision_inventory(revision_id)
1274
return RevisionTree(self, inv, revision_id)
2495
1276
def basis_tree(self):
2496
1277
"""See Branch.basis_tree."""
2497
return self.repository.revision_tree(self.last_revision())
2499
def _get_parent_location(self):
1279
revision_id = self.revision_history()[-1]
1280
xml = self.working_tree().read_basis_inventory(revision_id)
1281
inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
1282
return RevisionTree(self, inv, revision_id)
1283
except (IndexError, NoSuchFile, NoWorkingTree), e:
1284
return self.revision_tree(self.last_revision())
1286
def working_tree(self):
1287
"""See Branch.working_tree."""
1288
from bzrlib.workingtree import WorkingTree
1289
if self._transport.base.find('://') != -1:
1290
raise NoWorkingTree(self.base)
1291
return WorkingTree(self.base, branch=self)
1294
def pull(self, source, overwrite=False):
1295
"""See Branch.pull."""
1298
old_count = len(self.revision_history())
1300
self.update_revisions(source)
1301
except DivergedBranches:
1305
self.set_revision_history(source.revision_history())
1306
new_count = len(self.revision_history())
1307
return new_count - old_count
1311
def get_parent(self):
1312
"""See Branch.get_parent."""
2500
1314
_locs = ['parent', 'pull', 'x-pull']
2501
1315
for l in _locs:
2503
return self._transport.get_bytes(l).strip('\n')
2504
except errors.NoSuchFile:
1317
return self.controlfile(l, 'r').read().strip('\n')
2508
def _basic_push(self, target, overwrite, stop_revision):
2509
"""Basic implementation of push without bound branches or hooks.
2511
Must be called with source read locked and target write locked.
2513
result = BranchPushResult()
2514
result.source_branch = self
2515
result.target_branch = target
2516
result.old_revno, result.old_revid = target.last_revision_info()
2517
self.update_references(target)
2518
if result.old_revid != self.last_revision():
2519
# We assume that during 'push' this repository is closer than
2521
graph = self.repository.get_graph(target.repository)
2522
target.update_revisions(self, stop_revision,
2523
overwrite=overwrite, graph=graph)
2524
if self._push_should_merge_tags():
2525
result.tag_conflicts = self.tags.merge_to(target.tags,
2527
result.new_revno, result.new_revid = target.last_revision_info()
2530
def get_stacked_on_url(self):
2531
raise errors.UnstackableBranchFormat(self._format, self.user_url)
1322
def get_push_location(self):
1323
"""See Branch.get_push_location."""
1324
config = bzrlib.config.BranchConfig(self)
1325
push_loc = config.get_user_option('push_location')
2533
1328
def set_push_location(self, location):
2534
1329
"""See Branch.set_push_location."""
2535
self.get_config().set_user_option(
2536
'push_location', location,
2537
store=_mod_config.STORE_LOCATION_NORECURSE)
2539
def _set_parent_location(self, url):
2541
self._transport.delete('parent')
2543
self._transport.put_bytes('parent', url + '\n',
2544
mode=self.bzrdir._get_file_mode())
2547
class BzrBranch5(BzrBranch):
2548
"""A format 5 branch. This supports new features over plain branches.
2550
It has support for a master_branch which is the data for bound branches.
2553
def get_bound_location(self):
2555
return self._transport.get_bytes('bound')[:-1]
2556
except errors.NoSuchFile:
2560
def get_master_branch(self, possible_transports=None):
2561
"""Return the branch we are bound to.
2563
:return: Either a Branch, or None
2565
This could memoise the branch, but if thats done
2566
it must be revalidated on each new lock.
2567
So for now we just don't memoise it.
2568
# RBC 20060304 review this decision.
2570
bound_loc = self.get_bound_location()
2574
return Branch.open(bound_loc,
2575
possible_transports=possible_transports)
2576
except (errors.NotBranchError, errors.ConnectionError), e:
2577
raise errors.BoundBranchConnectionFailure(
2581
def set_bound_location(self, location):
2582
"""Set the target where this branch is bound to.
2584
:param location: URL to the target branch
2587
self._transport.put_bytes('bound', location+'\n',
2588
mode=self.bzrdir._get_file_mode())
2591
self._transport.delete('bound')
2592
except errors.NoSuchFile:
1330
config = bzrlib.config.LocationConfig(self.base)
1331
config.set_user_option('push_location', location)
1334
def set_parent(self, url):
1335
"""See Branch.set_parent."""
1336
# TODO: Maybe delete old location files?
1337
from bzrlib.atomicfile import AtomicFile
1338
f = AtomicFile(self.controlfilename('parent'))
1345
def tree_config(self):
1346
return TreeConfig(self)
1348
def sign_revision(self, revision_id, gpg_strategy):
1349
"""See Branch.sign_revision."""
1350
plaintext = Testament.from_revision(self, revision_id).as_short_text()
1351
self.store_revision_signature(gpg_strategy, plaintext, revision_id)
1354
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1355
"""See Branch.store_revision_signature."""
1356
self.revision_store.add(StringIO(gpg_strategy.sign(plaintext)),
1359
def fileid_involved_between_revs(self, from_revid, to_revid):
1360
"""Find file_id(s) which are involved in the changes between revisions.
1362
This determines the set of revisions which are involved, and then
1363
finds all file ids affected by those revisions.
1365
# TODO: jam 20060119 This code assumes that w.inclusions will
1366
# always be correct. But because of the presence of ghosts
1367
# it is possible to be wrong.
1368
# One specific example from Robert Collins:
1369
# Two branches, with revisions ABC, and AD
1370
# C is a ghost merge of D.
1371
# Inclusions doesn't recognize D as an ancestor.
1372
# If D is ever merged in the future, the weave
1373
# won't be fixed, because AD never saw revision C
1374
# to cause a conflict which would force a reweave.
1375
w = self._get_inventory_weave()
1376
from_set = set(w.inclusions([w.lookup(from_revid)]))
1377
to_set = set(w.inclusions([w.lookup(to_revid)]))
1378
included = to_set.difference(from_set)
1379
changed = map(w.idx_to_name, included)
1380
return self._fileid_involved_by_set(changed)
1382
def fileid_involved(self, last_revid=None):
1383
"""Find all file_ids modified in the ancestry of last_revid.
1385
:param last_revid: If None, last_revision() will be used.
1387
w = self._get_inventory_weave()
1389
changed = set(w._names)
1391
included = w.inclusions([w.lookup(last_revid)])
1392
changed = map(w.idx_to_name, included)
1393
return self._fileid_involved_by_set(changed)
1395
def fileid_involved_by_set(self, changes):
1396
"""Find all file_ids modified by the set of revisions passed in.
1398
:param changes: A set() of revision ids
1400
# TODO: jam 20060119 This line does *nothing*, remove it.
1401
# or better yet, change _fileid_involved_by_set so
1402
# that it takes the inventory weave, rather than
1403
# pulling it out by itself.
1404
w = self._get_inventory_weave()
1405
return self._fileid_involved_by_set(changes)
1407
def _fileid_involved_by_set(self, changes):
1408
"""Find the set of file-ids affected by the set of revisions.
1410
:param changes: A set() of revision ids.
1411
:return: A set() of file ids.
1413
This peaks at the Weave, interpreting each line, looking to
1414
see if it mentions one of the revisions. And if so, includes
1415
the file id mentioned.
1416
This expects both the Weave format, and the serialization
1417
to have a single line per file/directory, and to have
1418
fileid="" and revision="" on that line.
1420
assert (isinstance(self._branch_format, BzrBranchFormat5) or
1421
isinstance(self._branch_format, BzrBranchFormat6)), \
1422
"fileid_involved only supported for branches which store inventory as xml"
1424
w = self._get_inventory_weave()
1426
for line in w._weave:
1428
# it is ugly, but it is due to the weave structure
1429
if not isinstance(line, basestring): continue
1431
start = line.find('file_id="')+9
1432
if start < 9: continue
1433
end = line.find('"', start)
1435
file_id = xml.sax.saxutils.unescape(line[start:end])
1437
# check if file_id is already present
1438
if file_id in file_ids: continue
1440
start = line.find('revision="')+10
1441
if start < 10: continue
1442
end = line.find('"', start)
1444
revision_id = xml.sax.saxutils.unescape(line[start:end])
1446
if revision_id in changes:
1447
file_ids.add(file_id)
1452
Branch.set_default_initializer(BzrBranch._initialize)
1455
class BranchTestProviderAdapter(object):
1456
"""A tool to generate a suite testing multiple branch formats at once.
1458
This is done by copying the test once for each transport and injecting
1459
the transport_server, transport_readonly_server, and branch_format
1460
classes into each copy. Each copy is also given a new id() to make it
1464
def __init__(self, transport_server, transport_readonly_server, formats):
1465
self._transport_server = transport_server
1466
self._transport_readonly_server = transport_readonly_server
1467
self._formats = formats
1469
def adapt(self, test):
1470
result = TestSuite()
1471
for format in self._formats:
1472
new_test = deepcopy(test)
1473
new_test.transport_server = self._transport_server
1474
new_test.transport_readonly_server = self._transport_readonly_server
1475
new_test.branch_format = format
1476
def make_new_test_id():
1477
new_id = "%s(%s)" % (new_test.id(), format.__class__.__name__)
1478
return lambda: new_id
1479
new_test.id = make_new_test_id()
1480
result.addTest(new_test)
1484
class ScratchBranch(BzrBranch):
1485
"""Special test class: a branch that cleans up after itself.
1487
>>> b = ScratchBranch()
1491
>>> b._transport.__del__()
1496
def __init__(self, files=[], dirs=[], transport=None):
1497
"""Make a test branch.
1499
This creates a temporary directory and runs init-tree in it.
1501
If any files are listed, they are created in the working copy.
1503
if transport is None:
1504
transport = bzrlib.transport.local.ScratchTransport()
1505
Branch.initialize(transport.base)
1506
super(ScratchBranch, self).__init__(transport)
1508
super(ScratchBranch, self).__init__(transport)
1511
self._transport.mkdir(d)
1514
self._transport.put(f, 'content of %s' % f)
1519
>>> orig = ScratchBranch(files=["file1", "file2"])
1520
>>> clone = orig.clone()
1521
>>> if os.name != 'nt':
1522
... os.path.samefile(orig.base, clone.base)
1524
... orig.base == clone.base
1527
>>> os.path.isfile(pathjoin(clone.base, "file1"))
1530
from shutil import copytree
1531
from bzrlib.osutils import mkdtemp
1534
copytree(self.base, base, symlinks=True)
1535
return ScratchBranch(
1536
transport=bzrlib.transport.local.ScratchTransport(base))
1539
######################################################################
1543
def is_control_file(filename):
1544
## FIXME: better check
1545
filename = normpath(filename)
1546
while filename != '':
1547
head, tail = os.path.split(filename)
1548
## mutter('check %r for control file' % ((head, tail),))
1549
if tail == bzrlib.BZRDIR:
2597
def bind(self, other):
2598
"""Bind this branch to the branch other.
2600
This does not push or pull data between the branches, though it does
2601
check for divergence to raise an error when the branches are not
2602
either the same, or one a prefix of the other. That behaviour may not
2603
be useful, so that check may be removed in future.
2605
:param other: The branch to bind to
2608
# TODO: jam 20051230 Consider checking if the target is bound
2609
# It is debatable whether you should be able to bind to
2610
# a branch which is itself bound.
2611
# Committing is obviously forbidden,
2612
# but binding itself may not be.
2613
# Since we *have* to check at commit time, we don't
2614
# *need* to check here
2616
# we want to raise diverged if:
2617
# last_rev is not in the other_last_rev history, AND
2618
# other_last_rev is not in our history, and do it without pulling
2620
self.set_bound_location(other.base)
2624
"""If bound, unbind"""
2625
return self.set_bound_location(None)
2628
def update(self, possible_transports=None):
2629
"""Synchronise this branch with the master branch if any.
2631
:return: None or the last_revision that was pivoted out during the
2634
master = self.get_master_branch(possible_transports)
2635
if master is not None:
2636
old_tip = _mod_revision.ensure_null(self.last_revision())
2637
self.pull(master, overwrite=True)
2638
if self.repository.get_graph().is_ancestor(old_tip,
2639
_mod_revision.ensure_null(self.last_revision())):
2645
class BzrBranch8(BzrBranch5):
2646
"""A branch that stores tree-reference locations."""
2648
def _open_hook(self):
2649
if self._ignore_fallbacks:
2652
url = self.get_stacked_on_url()
2653
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2654
errors.UnstackableBranchFormat):
2657
for hook in Branch.hooks['transform_fallback_location']:
2658
url = hook(self, url)
2660
hook_name = Branch.hooks.get_hook_name(hook)
2661
raise AssertionError(
2662
"'transform_fallback_location' hook %s returned "
2663
"None, not a URL." % hook_name)
2664
self._activate_fallback_location(url)
2666
def __init__(self, *args, **kwargs):
2667
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2668
super(BzrBranch8, self).__init__(*args, **kwargs)
2669
self._last_revision_info_cache = None
2670
self._reference_info = None
2672
def _clear_cached_state(self):
2673
super(BzrBranch8, self)._clear_cached_state()
2674
self._last_revision_info_cache = None
2675
self._reference_info = None
2677
def _last_revision_info(self):
2678
revision_string = self._transport.get_bytes('last-revision')
2679
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2680
revision_id = cache_utf8.get_cached_utf8(revision_id)
2682
return revno, revision_id
2684
def _write_last_revision_info(self, revno, revision_id):
2685
"""Simply write out the revision id, with no checks.
2687
Use set_last_revision_info to perform this safely.
2689
Does not update the revision_history cache.
2690
Intended to be called by set_last_revision_info and
2691
_write_revision_history.
2693
revision_id = _mod_revision.ensure_null(revision_id)
2694
out_string = '%d %s\n' % (revno, revision_id)
2695
self._transport.put_bytes('last-revision', out_string,
2696
mode=self.bzrdir._get_file_mode())
2699
def set_last_revision_info(self, revno, revision_id):
2700
revision_id = _mod_revision.ensure_null(revision_id)
2701
old_revno, old_revid = self.last_revision_info()
2702
if self._get_append_revisions_only():
2703
self._check_history_violation(revision_id)
2704
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2705
self._write_last_revision_info(revno, revision_id)
2706
self._clear_cached_state()
2707
self._last_revision_info_cache = revno, revision_id
2708
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2710
def _synchronize_history(self, destination, revision_id):
2711
"""Synchronize last revision and revision history between branches.
2713
:see: Branch._synchronize_history
2715
# XXX: The base Branch has a fast implementation of this method based
2716
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2717
# that uses set_revision_history. This class inherits from BzrBranch5,
2718
# but wants the fast implementation, so it calls
2719
# Branch._synchronize_history directly.
2720
Branch._synchronize_history(self, destination, revision_id)
2722
def _check_history_violation(self, revision_id):
2723
last_revision = _mod_revision.ensure_null(self.last_revision())
2724
if _mod_revision.is_null(last_revision):
2726
if last_revision not in self._lefthand_history(revision_id):
2727
raise errors.AppendRevisionsOnlyViolation(self.user_url)
2729
def _gen_revision_history(self):
2730
"""Generate the revision history from last revision
2732
last_revno, last_revision = self.last_revision_info()
2733
self._extend_partial_history(stop_index=last_revno-1)
2734
return list(reversed(self._partial_revision_history_cache))
2736
def _write_revision_history(self, history):
2737
"""Factored out of set_revision_history.
2739
This performs the actual writing to disk, with format-specific checks.
2740
It is intended to be called by BzrBranch5.set_revision_history.
2742
if len(history) == 0:
2743
last_revision = 'null:'
2745
if history != self._lefthand_history(history[-1]):
2746
raise errors.NotLefthandHistory(history)
2747
last_revision = history[-1]
2748
if self._get_append_revisions_only():
2749
self._check_history_violation(last_revision)
2750
self._write_last_revision_info(len(history), last_revision)
2753
def _set_parent_location(self, url):
2754
"""Set the parent branch"""
2755
self._set_config_location('parent_location', url, make_relative=True)
2758
def _get_parent_location(self):
2759
"""Set the parent branch"""
2760
return self._get_config_location('parent_location')
2763
def _set_all_reference_info(self, info_dict):
2764
"""Replace all reference info stored in a branch.
2766
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2769
writer = rio.RioWriter(s)
2770
for key, (tree_path, branch_location) in info_dict.iteritems():
2771
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2772
branch_location=branch_location)
2773
writer.write_stanza(stanza)
2774
self._transport.put_bytes('references', s.getvalue())
2775
self._reference_info = info_dict
2778
def _get_all_reference_info(self):
2779
"""Return all the reference info stored in a branch.
2781
:return: A dict of {file_id: (tree_path, branch_location)}
2783
if self._reference_info is not None:
2784
return self._reference_info
2785
rio_file = self._transport.get('references')
2787
stanzas = rio.read_stanzas(rio_file)
2788
info_dict = dict((s['file_id'], (s['tree_path'],
2789
s['branch_location'])) for s in stanzas)
2792
self._reference_info = info_dict
2795
def set_reference_info(self, file_id, tree_path, branch_location):
2796
"""Set the branch location to use for a tree reference.
2798
:param file_id: The file-id of the tree reference.
2799
:param tree_path: The path of the tree reference in the tree.
2800
:param branch_location: The location of the branch to retrieve tree
2803
info_dict = self._get_all_reference_info()
2804
info_dict[file_id] = (tree_path, branch_location)
2805
if None in (tree_path, branch_location):
2806
if tree_path is not None:
2807
raise ValueError('tree_path must be None when branch_location'
2809
if branch_location is not None:
2810
raise ValueError('branch_location must be None when tree_path'
2812
del info_dict[file_id]
2813
self._set_all_reference_info(info_dict)
2815
def get_reference_info(self, file_id):
2816
"""Get the tree_path and branch_location for a tree reference.
2818
:return: a tuple of (tree_path, branch_location)
2820
return self._get_all_reference_info().get(file_id, (None, None))
2822
def reference_parent(self, file_id, path, possible_transports=None):
2823
"""Return the parent branch for a tree-reference file_id.
2825
:param file_id: The file_id of the tree reference
2826
:param path: The path of the file_id in the tree
2827
:return: A branch associated with the file_id
2829
branch_location = self.get_reference_info(file_id)[1]
2830
if branch_location is None:
2831
return Branch.reference_parent(self, file_id, path,
2832
possible_transports)
2833
branch_location = urlutils.join(self.user_url, branch_location)
2834
return Branch.open(branch_location,
2835
possible_transports=possible_transports)
2837
def set_push_location(self, location):
2838
"""See Branch.set_push_location."""
2839
self._set_config_location('push_location', location)
2841
def set_bound_location(self, location):
2842
"""See Branch.set_push_location."""
2844
config = self.get_config()
2845
if location is None:
2846
if config.get_user_option('bound') != 'True':
2849
config.set_user_option('bound', 'False', warn_masked=True)
2852
self._set_config_location('bound_location', location,
2854
config.set_user_option('bound', 'True', warn_masked=True)
2857
def _get_bound_location(self, bound):
2858
"""Return the bound location in the config file.
2860
Return None if the bound parameter does not match"""
2861
config = self.get_config()
2862
config_bound = (config.get_user_option('bound') == 'True')
2863
if config_bound != bound:
2865
return self._get_config_location('bound_location', config=config)
2867
def get_bound_location(self):
2868
"""See Branch.set_push_location."""
2869
return self._get_bound_location(True)
2871
def get_old_bound_location(self):
2872
"""See Branch.get_old_bound_location"""
2873
return self._get_bound_location(False)
2875
def get_stacked_on_url(self):
2876
# you can always ask for the URL; but you might not be able to use it
2877
# if the repo can't support stacking.
2878
## self._check_stackable_repo()
2879
stacked_url = self._get_config_location('stacked_on_location')
2880
if stacked_url is None:
2881
raise errors.NotStacked(self)
2884
def _get_append_revisions_only(self):
2885
return self.get_config(
2886
).get_user_option_as_bool('append_revisions_only')
2889
def generate_revision_history(self, revision_id, last_rev=None,
2891
"""See BzrBranch5.generate_revision_history"""
2892
history = self._lefthand_history(revision_id, last_rev, other_branch)
2893
revno = len(history)
2894
self.set_last_revision_info(revno, revision_id)
2897
def get_rev_id(self, revno, history=None):
2898
"""Find the revision id of the specified revno."""
2900
return _mod_revision.NULL_REVISION
2902
last_revno, last_revision_id = self.last_revision_info()
2903
if revno <= 0 or revno > last_revno:
2904
raise errors.NoSuchRevision(self, revno)
2906
if history is not None:
2907
return history[revno - 1]
2909
index = last_revno - revno
2910
if len(self._partial_revision_history_cache) <= index:
2911
self._extend_partial_history(stop_index=index)
2912
if len(self._partial_revision_history_cache) > index:
2913
return self._partial_revision_history_cache[index]
2915
raise errors.NoSuchRevision(self, revno)
2918
def revision_id_to_revno(self, revision_id):
2919
"""Given a revision id, return its revno"""
2920
if _mod_revision.is_null(revision_id):
2923
index = self._partial_revision_history_cache.index(revision_id)
2925
self._extend_partial_history(stop_revision=revision_id)
2926
index = len(self._partial_revision_history_cache) - 1
2927
if self._partial_revision_history_cache[index] != revision_id:
2928
raise errors.NoSuchRevision(self, revision_id)
2929
return self.revno() - index
2932
class BzrBranch7(BzrBranch8):
2933
"""A branch with support for a fallback repository."""
2935
def set_reference_info(self, file_id, tree_path, branch_location):
2936
Branch.set_reference_info(self, file_id, tree_path, branch_location)
2938
def get_reference_info(self, file_id):
2939
Branch.get_reference_info(self, file_id)
2941
def reference_parent(self, file_id, path, possible_transports=None):
2942
return Branch.reference_parent(self, file_id, path,
2943
possible_transports)
2946
class BzrBranch6(BzrBranch7):
2947
"""See BzrBranchFormat6 for the capabilities of this branch.
2949
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2953
def get_stacked_on_url(self):
2954
raise errors.UnstackableBranchFormat(self._format, self.user_url)
2957
######################################################################
2958
# results of operations
2961
class _Result(object):
2963
def _show_tag_conficts(self, to_file):
2964
if not getattr(self, 'tag_conflicts', None):
2966
to_file.write('Conflicting tags:\n')
2967
for name, value1, value2 in self.tag_conflicts:
2968
to_file.write(' %s\n' % (name, ))
2971
class PullResult(_Result):
2972
"""Result of a Branch.pull operation.
2974
:ivar old_revno: Revision number before pull.
2975
:ivar new_revno: Revision number after pull.
2976
:ivar old_revid: Tip revision id before pull.
2977
:ivar new_revid: Tip revision id after pull.
2978
:ivar source_branch: Source (local) branch object. (read locked)
2979
:ivar master_branch: Master branch of the target, or the target if no
2981
:ivar local_branch: target branch if there is a Master, else None
2982
:ivar target_branch: Target/destination branch object. (write locked)
2983
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2987
# DEPRECATED: pull used to return the change in revno
2988
return self.new_revno - self.old_revno
2990
def report(self, to_file):
2992
if self.old_revid == self.new_revid:
2993
to_file.write('No revisions to pull.\n')
2995
to_file.write('Now on revision %d.\n' % self.new_revno)
2996
self._show_tag_conficts(to_file)
2999
class BranchPushResult(_Result):
3000
"""Result of a Branch.push operation.
3002
:ivar old_revno: Revision number (eg 10) of the target before push.
3003
:ivar new_revno: Revision number (eg 12) of the target after push.
3004
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
3006
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
3008
:ivar source_branch: Source branch object that the push was from. This is
3009
read locked, and generally is a local (and thus low latency) branch.
3010
:ivar master_branch: If target is a bound branch, the master branch of
3011
target, or target itself. Always write locked.
3012
:ivar target_branch: The direct Branch where data is being sent (write
3014
:ivar local_branch: If the target is a bound branch this will be the
3015
target, otherwise it will be None.
3019
# DEPRECATED: push used to return the change in revno
3020
return self.new_revno - self.old_revno
3022
def report(self, to_file):
3023
"""Write a human-readable description of the result."""
3024
if self.old_revid == self.new_revid:
3025
note('No new revisions to push.')
3027
note('Pushed up to revision %d.' % self.new_revno)
3028
self._show_tag_conficts(to_file)
3031
class BranchCheckResult(object):
3032
"""Results of checking branch consistency.
3037
def __init__(self, branch):
3038
self.branch = branch
3041
def report_results(self, verbose):
3042
"""Report the check results via trace.note.
3044
:param verbose: Requests more detailed display of what was checked,
3047
note('checked branch %s format %s', self.branch.user_url,
3048
self.branch._format)
3049
for error in self.errors:
3050
note('found error:%s', error)
3053
class Converter5to6(object):
3054
"""Perform an in-place upgrade of format 5 to format 6"""
3056
def convert(self, branch):
3057
# Data for 5 and 6 can peacefully coexist.
3058
format = BzrBranchFormat6()
3059
new_branch = format.open(branch.bzrdir, _found=True)
3061
# Copy source data into target
3062
new_branch._write_last_revision_info(*branch.last_revision_info())
3063
new_branch.set_parent(branch.get_parent())
3064
new_branch.set_bound_location(branch.get_bound_location())
3065
new_branch.set_push_location(branch.get_push_location())
3067
# New branch has no tags by default
3068
new_branch.tags._set_tag_dict({})
3070
# Copying done; now update target format
3071
new_branch._transport.put_bytes('format',
3072
format.get_format_string(),
3073
mode=new_branch.bzrdir._get_file_mode())
3075
# Clean up old files
3076
new_branch._transport.delete('revision-history')
3078
branch.set_parent(None)
3079
except errors.NoSuchFile:
3081
branch.set_bound_location(None)
3084
class Converter6to7(object):
3085
"""Perform an in-place upgrade of format 6 to format 7"""
3087
def convert(self, branch):
3088
format = BzrBranchFormat7()
3089
branch._set_config_location('stacked_on_location', '')
3090
# update target format
3091
branch._transport.put_bytes('format', format.get_format_string())
3094
class Converter7to8(object):
3095
"""Perform an in-place upgrade of format 6 to format 7"""
3097
def convert(self, branch):
3098
format = BzrBranchFormat8()
3099
branch._transport.put_bytes('references', '')
3100
# update target format
3101
branch._transport.put_bytes('format', format.get_format_string())
3104
def _run_with_write_locked_target(target, callable, *args, **kwargs):
3105
"""Run ``callable(*args, **kwargs)``, write-locking target for the
3108
_run_with_write_locked_target will attempt to release the lock it acquires.
3110
If an exception is raised by callable, then that exception *will* be
3111
propagated, even if the unlock attempt raises its own error. Thus
3112
_run_with_write_locked_target should be preferred to simply doing::
3116
return callable(*args, **kwargs)
3121
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
3122
# should share code?
3125
result = callable(*args, **kwargs)
3127
exc_info = sys.exc_info()
3131
raise exc_info[0], exc_info[1], exc_info[2]
3137
class InterBranch(InterObject):
3138
"""This class represents operations taking place between two branches.
3140
Its instances have methods like pull() and push() and contain
3141
references to the source and target repositories these operations
3142
can be carried out on.
3146
"""The available optimised InterBranch types."""
3149
def _get_branch_formats_to_test():
3150
"""Return a tuple with the Branch formats to use when testing."""
3151
raise NotImplementedError(InterBranch._get_branch_formats_to_test)
3153
def pull(self, overwrite=False, stop_revision=None,
3154
possible_transports=None, local=False):
3155
"""Mirror source into target branch.
3157
The target branch is considered to be 'local', having low latency.
3159
:returns: PullResult instance
3161
raise NotImplementedError(self.pull)
3163
def update_revisions(self, stop_revision=None, overwrite=False,
3165
"""Pull in new perfect-fit revisions.
3167
:param stop_revision: Updated until the given revision
3168
:param overwrite: Always set the branch pointer, rather than checking
3169
to see if it is a proper descendant.
3170
:param graph: A Graph object that can be used to query history
3171
information. This can be None.
3174
raise NotImplementedError(self.update_revisions)
3176
def push(self, overwrite=False, stop_revision=None,
3177
_override_hook_source_branch=None):
3178
"""Mirror the source branch into the target branch.
3180
The source branch is considered to be 'local', having low latency.
3182
raise NotImplementedError(self.push)
3185
class GenericInterBranch(InterBranch):
3186
"""InterBranch implementation that uses public Branch functions.
3190
def _get_branch_formats_to_test():
3191
return BranchFormat._default_format, BranchFormat._default_format
3193
def update_revisions(self, stop_revision=None, overwrite=False,
3195
"""See InterBranch.update_revisions()."""
3196
self.source.lock_read()
3198
other_revno, other_last_revision = self.source.last_revision_info()
3199
stop_revno = None # unknown
3200
if stop_revision is None:
3201
stop_revision = other_last_revision
3202
if _mod_revision.is_null(stop_revision):
3203
# if there are no commits, we're done.
3205
stop_revno = other_revno
3207
# what's the current last revision, before we fetch [and change it
3209
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3210
# we fetch here so that we don't process data twice in the common
3211
# case of having something to pull, and so that the check for
3212
# already merged can operate on the just fetched graph, which will
3213
# be cached in memory.
3214
self.target.fetch(self.source, stop_revision)
3215
# Check to see if one is an ancestor of the other
3218
graph = self.target.repository.get_graph()
3219
if self.target._check_if_descendant_or_diverged(
3220
stop_revision, last_rev, graph, self.source):
3221
# stop_revision is a descendant of last_rev, but we aren't
3222
# overwriting, so we're done.
3224
if stop_revno is None:
3226
graph = self.target.repository.get_graph()
3227
this_revno, this_last_revision = \
3228
self.target.last_revision_info()
3229
stop_revno = graph.find_distance_to_null(stop_revision,
3230
[(other_last_revision, other_revno),
3231
(this_last_revision, this_revno)])
3232
self.target.set_last_revision_info(stop_revno, stop_revision)
3234
self.source.unlock()
3236
def pull(self, overwrite=False, stop_revision=None,
3237
possible_transports=None, _hook_master=None, run_hooks=True,
3238
_override_hook_target=None, local=False):
3241
:param _hook_master: Private parameter - set the branch to
3242
be supplied as the master to pull hooks.
3243
:param run_hooks: Private parameter - if false, this branch
3244
is being called because it's the master of the primary branch,
3245
so it should not run its hooks.
3246
:param _override_hook_target: Private parameter - set the branch to be
3247
supplied as the target_branch to pull hooks.
3248
:param local: Only update the local branch, and not the bound branch.
3250
# This type of branch can't be bound.
3252
raise errors.LocalRequiresBoundBranch()
3253
result = PullResult()
3254
result.source_branch = self.source
3255
if _override_hook_target is None:
3256
result.target_branch = self.target
3258
result.target_branch = _override_hook_target
3259
self.source.lock_read()
3261
# We assume that during 'pull' the target repository is closer than
3263
self.source.update_references(self.target)
3264
graph = self.target.repository.get_graph(self.source.repository)
3265
# TODO: Branch formats should have a flag that indicates
3266
# that revno's are expensive, and pull() should honor that flag.
3268
result.old_revno, result.old_revid = \
3269
self.target.last_revision_info()
3270
self.target.update_revisions(self.source, stop_revision,
3271
overwrite=overwrite, graph=graph)
3272
# TODO: The old revid should be specified when merging tags,
3273
# so a tags implementation that versions tags can only
3274
# pull in the most recent changes. -- JRV20090506
3275
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3277
result.new_revno, result.new_revid = self.target.last_revision_info()
3279
result.master_branch = _hook_master
3280
result.local_branch = result.target_branch
3282
result.master_branch = result.target_branch
3283
result.local_branch = None
3285
for hook in Branch.hooks['post_pull']:
3288
self.source.unlock()
3291
def push(self, overwrite=False, stop_revision=None,
3292
_override_hook_source_branch=None):
3293
"""See InterBranch.push.
3295
This is the basic concrete implementation of push()
3297
:param _override_hook_source_branch: If specified, run
3298
the hooks passing this Branch as the source, rather than self.
3299
This is for use of RemoteBranch, where push is delegated to the
3300
underlying vfs-based Branch.
3302
# TODO: Public option to disable running hooks - should be trivial but
3304
self.source.lock_read()
3306
return _run_with_write_locked_target(
3307
self.target, self._push_with_bound_branches, overwrite,
3309
_override_hook_source_branch=_override_hook_source_branch)
3311
self.source.unlock()
3313
def _push_with_bound_branches(self, overwrite, stop_revision,
3314
_override_hook_source_branch=None):
3315
"""Push from source into target, and into target's master if any.
3318
if _override_hook_source_branch:
3319
result.source_branch = _override_hook_source_branch
3320
for hook in Branch.hooks['post_push']:
3323
bound_location = self.target.get_bound_location()
3324
if bound_location and self.target.base != bound_location:
3325
# there is a master branch.
3327
# XXX: Why the second check? Is it even supported for a branch to
3328
# be bound to itself? -- mbp 20070507
3329
master_branch = self.target.get_master_branch()
3330
master_branch.lock_write()
3332
# push into the master from the source branch.
3333
self.source._basic_push(master_branch, overwrite, stop_revision)
3334
# and push into the target branch from the source. Note that we
3335
# push from the source branch again, because its considered the
3336
# highest bandwidth repository.
3337
result = self.source._basic_push(self.target, overwrite,
3339
result.master_branch = master_branch
3340
result.local_branch = self.target
3344
master_branch.unlock()
3347
result = self.source._basic_push(self.target, overwrite,
3349
# TODO: Why set master_branch and local_branch if there's no
3350
# binding? Maybe cleaner to just leave them unset? -- mbp
3352
result.master_branch = self.target
3353
result.local_branch = None
3358
def is_compatible(self, source, target):
3359
# GenericBranch uses the public API, so always compatible
3363
class InterToBranch5(GenericInterBranch):
3366
def _get_branch_formats_to_test():
3367
return BranchFormat._default_format, BzrBranchFormat5()
3369
def pull(self, overwrite=False, stop_revision=None,
3370
possible_transports=None, run_hooks=True,
3371
_override_hook_target=None, local=False):
3372
"""Pull from source into self, updating my master if any.
3374
:param run_hooks: Private parameter - if false, this branch
3375
is being called because it's the master of the primary branch,
3376
so it should not run its hooks.
3378
bound_location = self.target.get_bound_location()
3379
if local and not bound_location:
3380
raise errors.LocalRequiresBoundBranch()
3381
master_branch = None
3382
if not local and bound_location and self.source.user_url != bound_location:
3383
# not pulling from master, so we need to update master.
3384
master_branch = self.target.get_master_branch(possible_transports)
3385
master_branch.lock_write()
3388
# pull from source into master.
3389
master_branch.pull(self.source, overwrite, stop_revision,
3391
return super(InterToBranch5, self).pull(overwrite,
3392
stop_revision, _hook_master=master_branch,
3393
run_hooks=run_hooks,
3394
_override_hook_target=_override_hook_target)
3397
master_branch.unlock()
3400
InterBranch.register_optimiser(GenericInterBranch)
3401
InterBranch.register_optimiser(InterToBranch5)
1551
if filename == head:
added
removed
bzrlib/branch.py
