137
79
"""Branch holding a history of revisions.
140
Base directory of the branch.
146
If _lock_mode is true, a positive count of the number of times the
150
Lock object from bzrlib.lock.
82
Base directory/url of the branch.
84
hooks: An instance of BranchHooks.
86
# this is really an instance variable - FIXME move it there
157
# Map some sort of prefix into a namespace
158
# stuff like "revno:10", "revid:", etc.
159
# This should match a prefix with a function which accepts
160
REVISION_NAMESPACES = {}
162
def __init__(self, base, init=False, find_root=True):
163
"""Create new branch object at a particular location.
165
base -- Base directory for the branch.
167
init -- If True, create new control files in a previously
168
unversioned directory. If False, the branch must already
171
find_root -- If true and init is false, find the root of the
172
existing branch containing base.
174
In the test suite, creation of new trees is tested using the
175
`ScratchBranch` class.
177
from bzrlib.store import ImmutableStore
179
self.base = os.path.realpath(base)
182
self.base = find_branch_root(base)
184
self.base = os.path.realpath(base)
185
if not isdir(self.controlfilename('.')):
186
from errors import NotBranchError
187
raise NotBranchError("not a bzr branch: %s" % quotefn(base),
188
['use "bzr init" to initialize a new working tree',
189
'current bzr can only operate from top-of-tree'])
192
self.text_store = ImmutableStore(self.controlfilename('text-store'))
193
self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
194
self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
198
return '%s(%r)' % (self.__class__.__name__, self.base)
205
if self._lock_mode or self._lock:
206
from warnings import warn
207
warn("branch %r was not explicitly unlocked" % self)
90
def __init__(self, *ignored, **ignored_too):
91
self.tags = self._format.make_tags(self)
92
self._revision_history_cache = None
93
self._revision_id_to_revno_cache = None
94
self._partial_revision_id_to_revno_cache = {}
95
self._partial_revision_history_cache = []
96
self._last_revision_info_cache = None
97
self._merge_sorted_revisions_cache = None
99
hooks = Branch.hooks['open']
103
def _open_hook(self):
104
"""Called by init to allow simpler extension of the base class."""
106
def _activate_fallback_location(self, url):
107
"""Activate the branch/repository from url as a fallback repository."""
108
repo = self._get_fallback_repository(url)
109
if repo.has_same_location(self.repository):
110
raise errors.UnstackableLocationError(self.base, url)
111
self.repository.add_fallback_repository(repo)
113
def break_lock(self):
114
"""Break a lock if one is present from another instance.
116
Uses the ui factory to ask for confirmation if the lock may be from
119
This will probe the repository for its lock as well.
121
self.control_files.break_lock()
122
self.repository.break_lock()
123
master = self.get_master_branch()
124
if master is not None:
127
def _check_stackable_repo(self):
128
if not self.repository._format.supports_external_lookups:
129
raise errors.UnstackableRepositoryFormat(self.repository._format,
130
self.repository.base)
132
def _extend_partial_history(self, stop_index=None, stop_revision=None):
133
"""Extend the partial history to include a given index
135
If a stop_index is supplied, stop when that index has been reached.
136
If a stop_revision is supplied, stop when that revision is
137
encountered. Otherwise, stop when the beginning of history is
140
:param stop_index: The index which should be present. When it is
141
present, history extension will stop.
142
:param stop_revision: The revision id which should be present. When
143
it is encountered, history extension will stop.
145
if len(self._partial_revision_history_cache) == 0:
146
self._partial_revision_history_cache = [self.last_revision()]
147
repository._iter_for_revno(
148
self.repository, self._partial_revision_history_cache,
149
stop_index=stop_index, stop_revision=stop_revision)
150
if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
151
self._partial_revision_history_cache.pop()
153
def _get_check_refs(self):
154
"""Get the references needed for check().
158
revid = self.last_revision()
159
return [('revision-existence', revid), ('lefthand-distance', revid)]
162
def open(base, _unsupported=False, possible_transports=None):
163
"""Open the branch rooted at base.
165
For instance, if the branch is at URL/.bzr/branch,
166
Branch.open(URL) -> a Branch instance.
168
control = bzrdir.BzrDir.open(base, _unsupported,
169
possible_transports=possible_transports)
170
return control.open_branch(unsupported=_unsupported)
173
def open_from_transport(transport, name=None, _unsupported=False):
174
"""Open the branch rooted at transport"""
175
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
176
return control.open_branch(name=name, unsupported=_unsupported)
179
def open_containing(url, possible_transports=None):
180
"""Open an existing branch which contains url.
182
This probes for a branch at url, and searches upwards from there.
184
Basically we keep looking up until we find the control directory or
185
run into the root. If there isn't one, raises NotBranchError.
186
If there is one and it is either an unrecognised format or an unsupported
187
format, UnknownFormatError or UnsupportedFormatError are raised.
188
If there is one, it is returned, along with the unused portion of url.
190
control, relpath = bzrdir.BzrDir.open_containing(url,
192
return control.open_branch(), relpath
194
def _push_should_merge_tags(self):
195
"""Should _basic_push merge this branch's tags into the target?
197
The default implementation returns False if this branch has no tags,
198
and True the rest of the time. Subclasses may override this.
200
return self.supports_tags() and self.tags.get_tag_dict()
202
def get_config(self):
203
return BranchConfig(self)
205
def _get_config(self):
206
"""Get the concrete config for just the config in this branch.
208
This is not intended for client use; see Branch.get_config for the
213
:return: An object supporting get_option and set_option.
215
raise NotImplementedError(self._get_config)
217
def _get_fallback_repository(self, url):
218
"""Get the repository we fallback to at url."""
219
url = urlutils.join(self.base, url)
220
a_branch = Branch.open(url,
221
possible_transports=[self.bzrdir.root_transport])
222
return a_branch.repository
224
def _get_tags_bytes(self):
225
"""Get the bytes of a serialised tags dict.
227
Note that not all branches support tags, nor do all use the same tags
228
logic: this method is specific to BasicTags. Other tag implementations
229
may use the same method name and behave differently, safely, because
230
of the double-dispatch via
231
format.make_tags->tags_instance->get_tags_dict.
233
:return: The bytes of the tags file.
234
:seealso: Branch._set_tags_bytes.
236
return self._transport.get_bytes('tags')
238
def _get_nick(self, local=False, possible_transports=None):
239
config = self.get_config()
240
# explicit overrides master, but don't look for master if local is True
241
if not local and not config.has_explicit_nickname():
243
master = self.get_master_branch(possible_transports)
244
if master is not None:
245
# return the master branch value
247
except errors.BzrError, e:
248
# Silently fall back to local implicit nick if the master is
250
mutter("Could not connect to bound branch, "
251
"falling back to local nick.\n " + str(e))
252
return config.get_nickname()
254
def _set_nick(self, nick):
255
self.get_config().set_user_option('nickname', nick, warn_masked=True)
257
nick = property(_get_nick, _set_nick)
260
raise NotImplementedError(self.is_locked)
262
def _lefthand_history(self, revision_id, last_rev=None,
264
if 'evil' in debug.debug_flags:
265
mutter_callsite(4, "_lefthand_history scales with history.")
266
# stop_revision must be a descendant of last_revision
267
graph = self.repository.get_graph()
268
if last_rev is not None:
269
if not graph.is_ancestor(last_rev, revision_id):
270
# our previous tip is not merged into stop_revision
271
raise errors.DivergedBranches(self, other_branch)
272
# make a new revision history from the graph
273
parents_map = graph.get_parent_map([revision_id])
274
if revision_id not in parents_map:
275
raise errors.NoSuchRevision(self, revision_id)
276
current_rev_id = revision_id
278
check_not_reserved_id = _mod_revision.check_not_reserved_id
279
# Do not include ghosts or graph origin in revision_history
280
while (current_rev_id in parents_map and
281
len(parents_map[current_rev_id]) > 0):
282
check_not_reserved_id(current_rev_id)
283
new_history.append(current_rev_id)
284
current_rev_id = parents_map[current_rev_id][0]
285
parents_map = graph.get_parent_map([current_rev_id])
286
new_history.reverse()
212
289
def lock_write(self):
214
if self._lock_mode != 'w':
215
from errors import LockError
216
raise LockError("can't upgrade to a write lock from %r" %
218
self._lock_count += 1
220
from bzrlib.lock import WriteLock
222
self._lock = WriteLock(self.controlfilename('branch-lock'))
223
self._lock_mode = 'w'
290
raise NotImplementedError(self.lock_write)
228
292
def lock_read(self):
230
assert self._lock_mode in ('r', 'w'), \
231
"invalid lock mode %r" % self._lock_mode
232
self._lock_count += 1
234
from bzrlib.lock import ReadLock
236
self._lock = ReadLock(self.controlfilename('branch-lock'))
237
self._lock_mode = 'r'
293
raise NotImplementedError(self.lock_read)
242
295
def unlock(self):
243
if not self._lock_mode:
244
from errors import LockError
245
raise LockError('branch %r is not locked' % (self))
247
if self._lock_count > 1:
248
self._lock_count -= 1
252
self._lock_mode = self._lock_count = None
255
def abspath(self, name):
256
"""Return absolute filename for something in the branch"""
257
return os.path.join(self.base, name)
260
def relpath(self, path):
261
"""Return path relative to this branch of something inside it.
263
Raises an error if path is not in this branch."""
264
return _relpath(self.base, path)
267
def controlfilename(self, file_or_path):
268
"""Return location relative to branch."""
269
if isinstance(file_or_path, basestring):
270
file_or_path = [file_or_path]
271
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
274
def controlfile(self, file_or_path, mode='r'):
275
"""Open a control file for this branch.
277
There are two classes of file in the control directory: text
278
and binary. binary files are untranslated byte streams. Text
279
control files are stored with Unix newlines and in UTF-8, even
280
if the platform or locale defaults are different.
282
Controlfiles should almost never be opened in write mode but
283
rather should be atomically copied and replaced using atomicfile.
286
fn = self.controlfilename(file_or_path)
288
if mode == 'rb' or mode == 'wb':
289
return file(fn, mode)
290
elif mode == 'r' or mode == 'w':
291
# open in binary mode anyhow so there's no newline translation;
292
# codecs uses line buffering by default; don't want that.
294
return codecs.open(fn, mode + 'b', 'utf-8',
297
raise BzrError("invalid controlfile mode %r" % mode)
301
def _make_control(self):
302
from bzrlib.inventory import Inventory
303
from bzrlib.xml import pack_xml
305
os.mkdir(self.controlfilename([]))
306
self.controlfile('README', 'w').write(
307
"This is a Bazaar-NG control directory.\n"
308
"Do not change any files in this directory.\n")
309
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
310
for d in ('text-store', 'inventory-store', 'revision-store'):
311
os.mkdir(self.controlfilename(d))
312
for f in ('revision-history', 'merged-patches',
313
'pending-merged-patches', 'branch-name',
316
self.controlfile(f, 'w').write('')
317
mutter('created control directory in ' + self.base)
319
pack_xml(Inventory(gen_root_id()), self.controlfile('inventory','w'))
322
def _check_format(self):
323
"""Check this branch format is supported.
325
The current tool only supports the current unstable format.
327
In the future, we might need different in-memory Branch
328
classes to support downlevel branches. But not yet.
330
# This ignores newlines so that we can open branches created
331
# on Windows from Linux and so on. I think it might be better
332
# to always make all internal files in unix format.
333
fmt = self.controlfile('branch-format', 'r').read()
334
fmt.replace('\r\n', '')
335
if fmt != BZR_BRANCH_FORMAT:
336
raise BzrError('sorry, branch format %r not supported' % fmt,
337
['use a different bzr version',
338
'or remove the .bzr directory and "bzr init" again'])
340
def get_root_id(self):
341
"""Return the id of this branches root"""
342
inv = self.read_working_inventory()
343
return inv.root.file_id
345
def set_root_id(self, file_id):
346
inv = self.read_working_inventory()
347
orig_root_id = inv.root.file_id
348
del inv._byid[inv.root.file_id]
349
inv.root.file_id = file_id
350
inv._byid[inv.root.file_id] = inv.root
353
if entry.parent_id in (None, orig_root_id):
354
entry.parent_id = inv.root.file_id
355
self._write_inventory(inv)
357
def read_working_inventory(self):
358
"""Read the working inventory."""
359
from bzrlib.inventory import Inventory
360
from bzrlib.xml import unpack_xml
361
from time import time
365
# ElementTree does its own conversion from UTF-8, so open in
367
inv = unpack_xml(Inventory,
368
self.controlfile('inventory', 'rb'))
369
mutter("loaded inventory of %d items in %f"
370
% (len(inv), time() - before))
376
def _write_inventory(self, inv):
377
"""Update the working inventory.
379
That is to say, the inventory describing changes underway, that
380
will be committed to the next revision.
382
from bzrlib.atomicfile import AtomicFile
383
from bzrlib.xml import pack_xml
387
f = AtomicFile(self.controlfilename('inventory'), 'wb')
396
mutter('wrote working inventory')
399
inventory = property(read_working_inventory, _write_inventory, None,
400
"""Inventory for the working copy.""")
403
def add(self, files, verbose=False, ids=None):
404
"""Make files versioned.
406
Note that the command line normally calls smart_add instead.
408
This puts the files in the Added state, so that they will be
409
recorded by the next commit.
412
List of paths to add, relative to the base of the tree.
415
If set, use these instead of automatically generated ids.
416
Must be the same length as the list of files, but may
417
contain None for ids that are to be autogenerated.
419
TODO: Perhaps have an option to add the ids even if the files do
422
TODO: Perhaps return the ids of the files? But then again it
423
is easy to retrieve them if they're needed.
425
TODO: Adding a directory should optionally recurse down and
426
add all non-ignored children. Perhaps do that in a
429
# TODO: Re-adding a file that is removed in the working copy
430
# should probably put it back with the previous ID.
431
if isinstance(files, basestring):
432
assert(ids is None or isinstance(ids, basestring))
438
ids = [None] * len(files)
440
assert(len(ids) == len(files))
444
inv = self.read_working_inventory()
445
for f,file_id in zip(files, ids):
446
if is_control_file(f):
447
raise BzrError("cannot add control file %s" % quotefn(f))
452
raise BzrError("cannot add top-level %r" % f)
454
fullpath = os.path.normpath(self.abspath(f))
457
kind = file_kind(fullpath)
459
# maybe something better?
460
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
462
if kind != 'file' and kind != 'directory':
463
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
466
file_id = gen_file_id(f)
467
inv.add_path(f, kind=kind, file_id=file_id)
470
print 'added', quotefn(f)
472
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
474
self._write_inventory(inv)
479
def print_file(self, file, revno):
480
"""Print `file` to stdout."""
483
tree = self.revision_tree(self.lookup_revision(revno))
484
# use inventory as it was in that revision
485
file_id = tree.inventory.path2id(file)
487
raise BzrError("%r is not present in revision %s" % (file, revno))
488
tree.print_file(file_id)
493
def remove(self, files, verbose=False):
494
"""Mark nominated files for removal from the inventory.
496
This does not remove their text. This does not run on
498
TODO: Refuse to remove modified files unless --force is given?
500
TODO: Do something useful with directories.
502
TODO: Should this remove the text or not? Tough call; not
503
removing may be useful and the user can just use use rm, and
504
is the opposite of add. Removing it is consistent with most
505
other tools. Maybe an option.
507
## TODO: Normalize names
508
## TODO: Remove nested loops; better scalability
509
if isinstance(files, basestring):
515
tree = self.working_tree()
518
# do this before any modifications
522
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
523
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
525
# having remove it, it must be either ignored or unknown
526
if tree.is_ignored(f):
530
show_status(new_status, inv[fid].kind, quotefn(f))
533
self._write_inventory(inv)
538
# FIXME: this doesn't need to be a branch method
539
def set_inventory(self, new_inventory_list):
540
from bzrlib.inventory import Inventory, InventoryEntry
541
inv = Inventory(self.get_root_id())
542
for path, file_id, parent, kind in new_inventory_list:
543
name = os.path.basename(path)
546
inv.add(InventoryEntry(file_id, name, kind, parent))
547
self._write_inventory(inv)
551
"""Return all unknown files.
553
These are files in the working directory that are not versioned or
554
control files or ignored.
556
>>> b = ScratchBranch(files=['foo', 'foo~'])
557
>>> list(b.unknowns())
560
>>> list(b.unknowns())
563
>>> list(b.unknowns())
566
return self.working_tree().unknowns()
569
def append_revision(self, *revision_ids):
570
from bzrlib.atomicfile import AtomicFile
572
for revision_id in revision_ids:
573
mutter("add {%s} to revision-history" % revision_id)
575
rev_history = self.revision_history()
576
rev_history.extend(revision_ids)
578
f = AtomicFile(self.controlfilename('revision-history'))
580
for rev_id in rev_history:
587
def get_revision_xml(self, revision_id):
588
"""Return XML file object for revision object."""
589
if not revision_id or not isinstance(revision_id, basestring):
590
raise InvalidRevisionId(revision_id)
595
return self.revision_store[revision_id]
597
raise bzrlib.errors.NoSuchRevision(revision_id)
602
def get_revision(self, revision_id):
603
"""Return the Revision object for a named revision"""
604
xml_file = self.get_revision_xml(revision_id)
607
r = unpack_xml(Revision, xml_file)
608
except SyntaxError, e:
609
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
613
assert r.revision_id == revision_id
296
raise NotImplementedError(self.unlock)
298
def peek_lock_mode(self):
299
"""Return lock mode for the Branch: 'r', 'w' or None"""
300
raise NotImplementedError(self.peek_lock_mode)
302
def get_physical_lock_status(self):
303
raise NotImplementedError(self.get_physical_lock_status)
306
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
307
"""Return the revision_id for a dotted revno.
309
:param revno: a tuple like (1,) or (1,1,2)
310
:param _cache_reverse: a private parameter enabling storage
311
of the reverse mapping in a top level cache. (This should
312
only be done in selective circumstances as we want to
313
avoid having the mapping cached multiple times.)
314
:return: the revision_id
315
:raises errors.NoSuchRevision: if the revno doesn't exist
317
rev_id = self._do_dotted_revno_to_revision_id(revno)
319
self._partial_revision_id_to_revno_cache[rev_id] = revno
322
def _do_dotted_revno_to_revision_id(self, revno):
323
"""Worker function for dotted_revno_to_revision_id.
325
Subclasses should override this if they wish to
326
provide a more efficient implementation.
329
return self.get_rev_id(revno[0])
330
revision_id_to_revno = self.get_revision_id_to_revno_map()
331
revision_ids = [revision_id for revision_id, this_revno
332
in revision_id_to_revno.iteritems()
333
if revno == this_revno]
334
if len(revision_ids) == 1:
335
return revision_ids[0]
337
revno_str = '.'.join(map(str, revno))
338
raise errors.NoSuchRevision(self, revno_str)
341
def revision_id_to_dotted_revno(self, revision_id):
342
"""Given a revision id, return its dotted revno.
344
:return: a tuple like (1,) or (400,1,3).
346
return self._do_revision_id_to_dotted_revno(revision_id)
348
def _do_revision_id_to_dotted_revno(self, revision_id):
349
"""Worker function for revision_id_to_revno."""
350
# Try the caches if they are loaded
351
result = self._partial_revision_id_to_revno_cache.get(revision_id)
352
if result is not None:
354
if self._revision_id_to_revno_cache:
355
result = self._revision_id_to_revno_cache.get(revision_id)
357
raise errors.NoSuchRevision(self, revision_id)
358
# Try the mainline as it's optimised
360
revno = self.revision_id_to_revno(revision_id)
362
except errors.NoSuchRevision:
363
# We need to load and use the full revno map after all
364
result = self.get_revision_id_to_revno_map().get(revision_id)
366
raise errors.NoSuchRevision(self, revision_id)
370
def get_revision_id_to_revno_map(self):
371
"""Return the revision_id => dotted revno map.
373
This will be regenerated on demand, but will be cached.
375
:return: A dictionary mapping revision_id => dotted revno.
376
This dictionary should not be modified by the caller.
378
if self._revision_id_to_revno_cache is not None:
379
mapping = self._revision_id_to_revno_cache
381
mapping = self._gen_revno_map()
382
self._cache_revision_id_to_revno(mapping)
383
# TODO: jam 20070417 Since this is being cached, should we be returning
385
# I would rather not, and instead just declare that users should not
386
# modify the return value.
389
def _gen_revno_map(self):
390
"""Create a new mapping from revision ids to dotted revnos.
392
Dotted revnos are generated based on the current tip in the revision
394
This is the worker function for get_revision_id_to_revno_map, which
395
just caches the return value.
397
:return: A dictionary mapping revision_id => dotted revno.
399
revision_id_to_revno = dict((rev_id, revno)
400
for rev_id, depth, revno, end_of_merge
401
in self.iter_merge_sorted_revisions())
402
return revision_id_to_revno
405
def iter_merge_sorted_revisions(self, start_revision_id=None,
406
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
407
"""Walk the revisions for a branch in merge sorted order.
409
Merge sorted order is the output from a merge-aware,
410
topological sort, i.e. all parents come before their
411
children going forward; the opposite for reverse.
413
:param start_revision_id: the revision_id to begin walking from.
414
If None, the branch tip is used.
415
:param stop_revision_id: the revision_id to terminate the walk
416
after. If None, the rest of history is included.
417
:param stop_rule: if stop_revision_id is not None, the precise rule
418
to use for termination:
419
* 'exclude' - leave the stop revision out of the result (default)
420
* 'include' - the stop revision is the last item in the result
421
* 'with-merges' - include the stop revision and all of its
422
merged revisions in the result
423
:param direction: either 'reverse' or 'forward':
424
* reverse means return the start_revision_id first, i.e.
425
start at the most recent revision and go backwards in history
426
* forward returns tuples in the opposite order to reverse.
427
Note in particular that forward does *not* do any intelligent
428
ordering w.r.t. depth as some clients of this API may like.
429
(If required, that ought to be done at higher layers.)
431
:return: an iterator over (revision_id, depth, revno, end_of_merge)
434
* revision_id: the unique id of the revision
435
* depth: How many levels of merging deep this node has been
437
* revno_sequence: This field provides a sequence of
438
revision numbers for all revisions. The format is:
439
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
440
branch that the revno is on. From left to right the REVNO numbers
441
are the sequence numbers within that branch of the revision.
442
* end_of_merge: When True the next node (earlier in history) is
443
part of a different merge.
445
# Note: depth and revno values are in the context of the branch so
446
# we need the full graph to get stable numbers, regardless of the
448
if self._merge_sorted_revisions_cache is None:
449
last_revision = self.last_revision()
450
last_key = (last_revision,)
451
known_graph = self.repository.revisions.get_known_graph_ancestry(
453
self._merge_sorted_revisions_cache = known_graph.merge_sort(
455
filtered = self._filter_merge_sorted_revisions(
456
self._merge_sorted_revisions_cache, start_revision_id,
457
stop_revision_id, stop_rule)
458
# Make sure we don't return revisions that are not part of the
459
# start_revision_id ancestry.
460
filtered = self._filter_non_ancestors(filtered)
461
if direction == 'reverse':
463
if direction == 'forward':
464
return reversed(list(filtered))
466
raise ValueError('invalid direction %r' % direction)
468
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
469
start_revision_id, stop_revision_id, stop_rule):
470
"""Iterate over an inclusive range of sorted revisions."""
471
rev_iter = iter(merge_sorted_revisions)
472
if start_revision_id is not None:
473
for node in rev_iter:
474
rev_id = node.key[-1]
475
if rev_id != start_revision_id:
478
# The decision to include the start or not
479
# depends on the stop_rule if a stop is provided
480
# so pop this node back into the iterator
481
rev_iter = chain(iter([node]), rev_iter)
483
if stop_revision_id is None:
485
for node in rev_iter:
486
rev_id = node.key[-1]
487
yield (rev_id, node.merge_depth, node.revno,
489
elif stop_rule == 'exclude':
490
for node in rev_iter:
491
rev_id = node.key[-1]
492
if rev_id == stop_revision_id:
494
yield (rev_id, node.merge_depth, node.revno,
496
elif stop_rule == 'include':
497
for node in rev_iter:
498
rev_id = node.key[-1]
499
yield (rev_id, node.merge_depth, node.revno,
501
if rev_id == stop_revision_id:
503
elif stop_rule == 'with-merges':
504
stop_rev = self.repository.get_revision(stop_revision_id)
505
if stop_rev.parent_ids:
506
left_parent = stop_rev.parent_ids[0]
508
left_parent = _mod_revision.NULL_REVISION
509
# left_parent is the actual revision we want to stop logging at,
510
# since we want to show the merged revisions after the stop_rev too
511
reached_stop_revision_id = False
512
revision_id_whitelist = []
513
for node in rev_iter:
514
rev_id = node.key[-1]
515
if rev_id == left_parent:
516
# reached the left parent after the stop_revision
518
if (not reached_stop_revision_id or
519
rev_id in revision_id_whitelist):
520
yield (rev_id, node.merge_depth, node.revno,
522
if reached_stop_revision_id or rev_id == stop_revision_id:
523
# only do the merged revs of rev_id from now on
524
rev = self.repository.get_revision(rev_id)
526
reached_stop_revision_id = True
527
revision_id_whitelist.extend(rev.parent_ids)
529
raise ValueError('invalid stop_rule %r' % stop_rule)
531
def _filter_non_ancestors(self, rev_iter):
532
# If we started from a dotted revno, we want to consider it as a tip
533
# and don't want to yield revisions that are not part of its
534
# ancestry. Given the order guaranteed by the merge sort, we will see
535
# uninteresting descendants of the first parent of our tip before the
537
first = rev_iter.next()
538
(rev_id, merge_depth, revno, end_of_merge) = first
541
# We start at a mainline revision so by definition, all others
542
# revisions in rev_iter are ancestors
543
for node in rev_iter:
548
pmap = self.repository.get_parent_map([rev_id])
549
parents = pmap.get(rev_id, [])
551
whitelist.update(parents)
553
# If there is no parents, there is nothing of interest left
555
# FIXME: It's hard to test this scenario here as this code is never
556
# called in that case. -- vila 20100322
559
for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
561
if rev_id in whitelist:
562
pmap = self.repository.get_parent_map([rev_id])
563
parents = pmap.get(rev_id, [])
564
whitelist.remove(rev_id)
565
whitelist.update(parents)
567
# We've reached the mainline, there is nothing left to
571
# A revision that is not part of the ancestry of our
574
yield (rev_id, merge_depth, revno, end_of_merge)
576
def leave_lock_in_place(self):
577
"""Tell this branch object not to release the physical lock when this
580
If lock_write doesn't return a token, then this method is not supported.
582
self.control_files.leave_in_place()
584
def dont_leave_lock_in_place(self):
585
"""Tell this branch object to release the physical lock when this
586
object is unlocked, even if it didn't originally acquire it.
588
If lock_write doesn't return a token, then this method is not supported.
590
self.control_files.dont_leave_in_place()
592
def bind(self, other):
593
"""Bind the local branch the other branch.
595
:param other: The branch to bind to
598
raise errors.UpgradeRequired(self.base)
600
def set_append_revisions_only(self, enabled):
601
if not self._format.supports_set_append_revisions_only():
602
raise errors.UpgradeRequired(self.base)
607
self.get_config().set_user_option('append_revisions_only', value,
610
def set_reference_info(self, file_id, tree_path, branch_location):
611
"""Set the branch location to use for a tree reference."""
612
raise errors.UnsupportedOperation(self.set_reference_info, self)
614
def get_reference_info(self, file_id):
615
"""Get the tree_path and branch_location for a tree reference."""
616
raise errors.UnsupportedOperation(self.get_reference_info, self)
619
def fetch(self, from_branch, last_revision=None, pb=None):
620
"""Copy revisions from from_branch into this branch.
622
:param from_branch: Where to copy from.
623
:param last_revision: What revision to stop at (None for at the end
625
:param pb: An optional progress bar to use.
628
if self.base == from_branch.base:
631
symbol_versioning.warn(
632
symbol_versioning.deprecated_in((1, 14, 0))
633
% "pb parameter to fetch()")
634
from_branch.lock_read()
636
if last_revision is None:
637
last_revision = from_branch.last_revision()
638
last_revision = _mod_revision.ensure_null(last_revision)
639
return self.repository.fetch(from_branch.repository,
640
revision_id=last_revision,
645
def get_bound_location(self):
646
"""Return the URL of the branch we are bound to.
648
Older format branches cannot bind, please be sure to use a metadir
653
def get_old_bound_location(self):
654
"""Return the URL of the branch we used to be bound to
656
raise errors.UpgradeRequired(self.base)
658
def get_commit_builder(self, parents, config=None, timestamp=None,
659
timezone=None, committer=None, revprops=None,
661
"""Obtain a CommitBuilder for this branch.
663
:param parents: Revision ids of the parents of the new revision.
664
:param config: Optional configuration to use.
665
:param timestamp: Optional timestamp recorded for commit.
666
:param timezone: Optional timezone for timestamp.
667
:param committer: Optional committer to set for commit.
668
:param revprops: Optional dictionary of revision properties.
669
:param revision_id: Optional revision id.
673
config = self.get_config()
675
return self.repository.get_commit_builder(self, parents, config,
676
timestamp, timezone, committer, revprops, revision_id)
678
def get_master_branch(self, possible_transports=None):
679
"""Return the branch we are bound to.
681
:return: Either a Branch, or None
617
685
def get_revision_delta(self, revno):
618
686
"""Return the delta for one revision.
789
932
common_index = min(self_len, other_len) -1
790
933
if common_index >= 0 and \
791
934
self_history[common_index] != other_history[common_index]:
792
raise DivergedBranches(self, other)
935
raise errors.DivergedBranches(self, other)
794
937
if stop_revision is None:
795
938
stop_revision = other_len
796
elif stop_revision > other_len:
797
raise NoSuchRevision(self, stop_revision)
940
if stop_revision > other_len:
941
raise errors.NoSuchRevision(self, stop_revision)
799
942
return other_history[self_len:stop_revision]
802
def update_revisions(self, other, stop_revision=None):
803
"""Pull in all new revisions from other branch.
805
>>> from bzrlib.commit import commit
806
>>> bzrlib.trace.silent = True
807
>>> br1 = ScratchBranch(files=['foo', 'bar'])
810
>>> commit(br1, "lala!", rev_id="REVISION-ID-1", verbose=False)
811
>>> br2 = ScratchBranch()
812
>>> br2.update_revisions(br1)
816
>>> br2.revision_history()
818
>>> br2.update_revisions(br1)
822
>>> br1.text_store.total_size() == br2.text_store.total_size()
825
from bzrlib.progress import ProgressBar
829
pb.update('comparing histories')
830
revision_ids = self.missing_revisions(other, stop_revision)
832
if hasattr(other.revision_store, "prefetch"):
833
other.revision_store.prefetch(revision_ids)
834
if hasattr(other.inventory_store, "prefetch"):
835
inventory_ids = [other.get_revision(r).inventory_id
836
for r in revision_ids]
837
other.inventory_store.prefetch(inventory_ids)
842
for rev_id in revision_ids:
844
pb.update('fetching revision', i, len(revision_ids))
845
rev = other.get_revision(rev_id)
846
revisions.append(rev)
847
inv = other.get_inventory(str(rev.inventory_id))
848
for key, entry in inv.iter_entries():
849
if entry.text_id is None:
851
if entry.text_id not in self.text_store:
852
needed_texts.add(entry.text_id)
856
count = self.text_store.copy_multi(other.text_store, needed_texts)
857
print "Added %d texts." % count
858
inventory_ids = [ f.inventory_id for f in revisions ]
859
count = self.inventory_store.copy_multi(other.inventory_store,
861
print "Added %d inventories." % count
862
revision_ids = [ f.revision_id for f in revisions]
863
count = self.revision_store.copy_multi(other.revision_store,
865
for revision_id in revision_ids:
866
self.append_revision(revision_id)
867
print "Added %d revisions." % count
870
def commit(self, *args, **kw):
871
from bzrlib.commit import commit
872
commit(self, *args, **kw)
875
def lookup_revision(self, revision):
876
"""Return the revision identifier for a given revision information."""
877
revno, info = self.get_revision_info(revision)
880
def get_revision_info(self, revision):
881
"""Return (revno, revision id) for revision identifier.
883
revision can be an integer, in which case it is assumed to be revno (though
884
this will translate negative values into positive ones)
885
revision can also be a string, in which case it is parsed for something like
886
'date:' or 'revid:' etc.
891
try:# Convert to int if possible
892
revision = int(revision)
945
def update_revisions(self, other, stop_revision=None, overwrite=False,
947
"""Pull in new perfect-fit revisions.
949
:param other: Another Branch to pull from
950
:param stop_revision: Updated until the given revision
951
:param overwrite: Always set the branch pointer, rather than checking
952
to see if it is a proper descendant.
953
:param graph: A Graph object that can be used to query history
954
information. This can be None.
957
return InterBranch.get(other, self).update_revisions(stop_revision,
960
def import_last_revision_info(self, source_repo, revno, revid):
961
"""Set the last revision info, importing from another repo if necessary.
963
This is used by the bound branch code to upload a revision to
964
the master branch first before updating the tip of the local branch.
966
:param source_repo: Source repository to optionally fetch from
967
:param revno: Revision number of the new tip
968
:param revid: Revision id of the new tip
970
if not self.repository.has_same_location(source_repo):
971
self.repository.fetch(source_repo, revision_id=revid)
972
self.set_last_revision_info(revno, revid)
974
def revision_id_to_revno(self, revision_id):
975
"""Given a revision id, return its revno"""
976
if _mod_revision.is_null(revision_id):
978
history = self.revision_history()
980
return history.index(revision_id) + 1
893
981
except ValueError:
982
raise errors.NoSuchRevision(self, revision_id)
985
def get_rev_id(self, revno, history=None):
986
"""Find the revision id of the specified revno."""
988
return _mod_revision.NULL_REVISION
989
last_revno, last_revid = self.last_revision_info()
990
if revno == last_revno:
992
if revno <= 0 or revno > last_revno:
993
raise errors.NoSuchRevision(self, revno)
994
distance_from_last = last_revno - revno
995
if len(self._partial_revision_history_cache) <= distance_from_last:
996
self._extend_partial_history(distance_from_last)
997
return self._partial_revision_history_cache[distance_from_last]
1000
def pull(self, source, overwrite=False, stop_revision=None,
1001
possible_transports=None, *args, **kwargs):
1002
"""Mirror source into this branch.
1004
This branch is considered to be 'local', having low latency.
1006
:returns: PullResult instance
1008
return InterBranch.get(source, self).pull(overwrite=overwrite,
1009
stop_revision=stop_revision,
1010
possible_transports=possible_transports, *args, **kwargs)
1012
def push(self, target, overwrite=False, stop_revision=None, *args,
1014
"""Mirror this branch into target.
1016
This branch is considered to be 'local', having low latency.
1018
return InterBranch.get(self, target).push(overwrite, stop_revision,
1021
def lossy_push(self, target, stop_revision=None):
1022
"""Push deltas into another branch.
1024
:note: This does not, like push, retain the revision ids from
1025
the source branch and will, rather than adding bzr-specific
1026
metadata, push only those semantics of the revision that can be
1027
natively represented by this branch' VCS.
1029
:param target: Target branch
1030
:param stop_revision: Revision to push, defaults to last revision.
1031
:return: BranchPushResult with an extra member revidmap:
1032
A dictionary mapping revision ids from the target branch
1033
to new revision ids in the target branch, for each
1034
revision that was pushed.
1036
inter = InterBranch.get(self, target)
1037
lossy_push = getattr(inter, "lossy_push", None)
1038
if lossy_push is None:
1039
raise errors.LossyPushToSameVCS(self, target)
1040
return lossy_push(stop_revision)
1042
def basis_tree(self):
1043
"""Return `Tree` object for last revision."""
1044
return self.repository.revision_tree(self.last_revision())
1046
def get_parent(self):
1047
"""Return the parent location of the branch.
1049
This is the default location for pull/missing. The usual
1050
pattern is that the user can override it by specifying a
1053
parent = self._get_parent_location()
1056
# This is an old-format absolute path to a local branch
1057
# turn it into a url
1058
if parent.startswith('/'):
1059
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1061
return urlutils.join(self.base[:-1], parent)
1062
except errors.InvalidURLJoin, e:
1063
raise errors.InaccessibleParent(parent, self.base)
1065
def _get_parent_location(self):
1066
raise NotImplementedError(self._get_parent_location)
1068
def _set_config_location(self, name, url, config=None,
1069
make_relative=False):
1071
config = self.get_config()
1075
url = urlutils.relative_url(self.base, url)
1076
config.set_user_option(name, url, warn_masked=True)
1078
def _get_config_location(self, name, config=None):
1080
config = self.get_config()
1081
location = config.get_user_option(name)
1086
def get_child_submit_format(self):
1087
"""Return the preferred format of submissions to this branch."""
1088
return self.get_config().get_user_option("child_submit_format")
1090
def get_submit_branch(self):
1091
"""Return the submit location of the branch.
1093
This is the default location for bundle. The usual
1094
pattern is that the user can override it by specifying a
1097
return self.get_config().get_user_option('submit_branch')
1099
def set_submit_branch(self, location):
1100
"""Return the submit location of the branch.
1102
This is the default location for bundle. The usual
1103
pattern is that the user can override it by specifying a
1106
self.get_config().set_user_option('submit_branch', location,
1109
def get_public_branch(self):
1110
"""Return the public location of the branch.
1112
This is used by merge directives.
1114
return self._get_config_location('public_branch')
1116
def set_public_branch(self, location):
1117
"""Return the submit location of the branch.
1119
This is the default location for bundle. The usual
1120
pattern is that the user can override it by specifying a
1123
self._set_config_location('public_branch', location)
1125
def get_push_location(self):
1126
"""Return the None or the location to push this branch to."""
1127
push_loc = self.get_config().get_user_option('push_location')
1130
def set_push_location(self, location):
1131
"""Set a new push location for this branch."""
1132
raise NotImplementedError(self.set_push_location)
1134
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1135
"""Run the post_change_branch_tip hooks."""
1136
hooks = Branch.hooks['post_change_branch_tip']
1139
new_revno, new_revid = self.last_revision_info()
1140
params = ChangeBranchTipParams(
1141
self, old_revno, new_revno, old_revid, new_revid)
1145
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
1146
"""Run the pre_change_branch_tip hooks."""
1147
hooks = Branch.hooks['pre_change_branch_tip']
1150
old_revno, old_revid = self.last_revision_info()
1151
params = ChangeBranchTipParams(
1152
self, old_revno, new_revno, old_revid, new_revid)
1158
"""Synchronise this branch with the master branch if any.
1160
:return: None or the last_revision pivoted out during the update.
1164
def check_revno(self, revno):
1166
Check whether a revno corresponds to any revision.
1167
Zero (the NULL revision) is considered valid.
1170
self.check_real_revno(revno)
1172
def check_real_revno(self, revno):
1174
Check whether a revno corresponds to a real revision.
1175
Zero (the NULL revision) is considered invalid
1177
if revno < 1 or revno > self.revno():
1178
raise errors.InvalidRevisionNumber(revno)
1181
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
1182
"""Clone this branch into to_bzrdir preserving all semantic values.
1184
Most API users will want 'create_clone_on_transport', which creates a
1185
new bzrdir and branch on the fly.
1187
revision_id: if not None, the revision history in the new branch will
1188
be truncated to end with revision_id.
1190
result = to_bzrdir.create_branch()
1193
if repository_policy is not None:
1194
repository_policy.configure_branch(result)
1195
self.copy_content_into(result, revision_id=revision_id)
1201
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
1202
"""Create a new line of development from the branch, into to_bzrdir.
1204
to_bzrdir controls the branch format.
1206
revision_id: if not None, the revision history in the new branch will
1207
be truncated to end with revision_id.
1209
if (repository_policy is not None and
1210
repository_policy.requires_stacking()):
1211
to_bzrdir._format.require_stacking(_skip_repo=True)
1212
result = to_bzrdir.create_branch()
1215
if repository_policy is not None:
1216
repository_policy.configure_branch(result)
1217
self.copy_content_into(result, revision_id=revision_id)
1218
result.set_parent(self.bzrdir.root_transport.base)
1223
def _synchronize_history(self, destination, revision_id):
1224
"""Synchronize last revision and revision history between branches.
1226
This version is most efficient when the destination is also a
1227
BzrBranch6, but works for BzrBranch5, as long as the destination's
1228
repository contains all the lefthand ancestors of the intended
1229
last_revision. If not, set_last_revision_info will fail.
1231
:param destination: The branch to copy the history into
1232
:param revision_id: The revision-id to truncate history at. May
1233
be None to copy complete history.
1235
source_revno, source_revision_id = self.last_revision_info()
1236
if revision_id is None:
1237
revno, revision_id = source_revno, source_revision_id
1239
graph = self.repository.get_graph()
1241
revno = graph.find_distance_to_null(revision_id,
1242
[(source_revision_id, source_revno)])
1243
except errors.GhostRevisionsHaveNoRevno:
1244
# Default to 1, if we can't find anything else
1246
destination.set_last_revision_info(revno, revision_id)
1249
def copy_content_into(self, destination, revision_id=None):
1250
"""Copy the content of self into destination.
1252
revision_id: if not None, the revision history in the new branch will
1253
be truncated to end with revision_id.
1255
self.update_references(destination)
1256
self._synchronize_history(destination, revision_id)
1258
parent = self.get_parent()
1259
except errors.InaccessibleParent, e:
1260
mutter('parent was not accessible to copy: %s', e)
1263
destination.set_parent(parent)
1264
if self._push_should_merge_tags():
1265
self.tags.merge_to(destination.tags)
1267
def update_references(self, target):
1268
if not getattr(self._format, 'supports_reference_locations', False):
1270
reference_dict = self._get_all_reference_info()
1271
if len(reference_dict) == 0:
1273
old_base = self.base
1274
new_base = target.base
1275
target_reference_dict = target._get_all_reference_info()
1276
for file_id, (tree_path, branch_location) in (
1277
reference_dict.items()):
1278
branch_location = urlutils.rebase_url(branch_location,
1280
target_reference_dict.setdefault(
1281
file_id, (tree_path, branch_location))
1282
target._set_all_reference_info(target_reference_dict)
1285
def check(self, refs):
1286
"""Check consistency of the branch.
1288
In particular this checks that revisions given in the revision-history
1289
do actually match up in the revision graph, and that they're all
1290
present in the repository.
1292
Callers will typically also want to check the repository.
1294
:param refs: Calculated refs for this branch as specified by
1295
branch._get_check_refs()
1296
:return: A BranchCheckResult.
1298
result = BranchCheckResult(self)
1299
last_revno, last_revision_id = self.last_revision_info()
1300
actual_revno = refs[('lefthand-distance', last_revision_id)]
1301
if actual_revno != last_revno:
1302
result.errors.append(errors.BzrCheckError(
1303
'revno does not match len(mainline) %s != %s' % (
1304
last_revno, actual_revno)))
1305
# TODO: We should probably also check that self.revision_history
1306
# matches the repository for older branch formats.
1307
# If looking for the code that cross-checks repository parents against
1308
# the iter_reverse_revision_history output, that is now a repository
1312
def _get_checkout_format(self):
1313
"""Return the most suitable metadir for a checkout of this branch.
1314
Weaves are used if this branch's repository uses weaves.
1316
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1317
from bzrlib.repofmt import weaverepo
1318
format = bzrdir.BzrDirMetaFormat1()
1319
format.repository_format = weaverepo.RepositoryFormat7()
1321
format = self.repository.bzrdir.checkout_metadir()
1322
format.set_branch_format(self._format)
1325
def create_clone_on_transport(self, to_transport, revision_id=None,
1326
stacked_on=None, create_prefix=False, use_existing_dir=False):
1327
"""Create a clone of this branch and its bzrdir.
1329
:param to_transport: The transport to clone onto.
1330
:param revision_id: The revision id to use as tip in the new branch.
1331
If None the tip is obtained from this branch.
1332
:param stacked_on: An optional URL to stack the clone on.
1333
:param create_prefix: Create any missing directories leading up to
1335
:param use_existing_dir: Use an existing directory if one exists.
1337
# XXX: Fix the bzrdir API to allow getting the branch back from the
1338
# clone call. Or something. 20090224 RBC/spiv.
1339
if revision_id is None:
1340
revision_id = self.last_revision()
1341
dir_to = self.bzrdir.clone_on_transport(to_transport,
1342
revision_id=revision_id, stacked_on=stacked_on,
1343
create_prefix=create_prefix, use_existing_dir=use_existing_dir)
1344
return dir_to.open_branch()
1346
def create_checkout(self, to_location, revision_id=None,
1347
lightweight=False, accelerator_tree=None,
1349
"""Create a checkout of a branch.
1351
:param to_location: The url to produce the checkout at
1352
:param revision_id: The revision to check out
1353
:param lightweight: If True, produce a lightweight checkout, otherwise,
1354
produce a bound branch (heavyweight checkout)
1355
:param accelerator_tree: A tree which can be used for retrieving file
1356
contents more quickly than the revision tree, i.e. a workingtree.
1357
The revision tree will be used for cases where accelerator_tree's
1358
content is different.
1359
:param hardlink: If true, hard-link files from accelerator_tree,
1361
:return: The tree of the created checkout
1363
t = transport.get_transport(to_location)
1366
format = self._get_checkout_format()
1367
checkout = format.initialize_on_transport(t)
1368
from_branch = BranchReferenceFormat().initialize(checkout,
1371
format = self._get_checkout_format()
1372
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1373
to_location, force_new_tree=False, format=format)
1374
checkout = checkout_branch.bzrdir
1375
checkout_branch.bind(self)
1376
# pull up to the specified revision_id to set the initial
1377
# branch tip correctly, and seed it with history.
1378
checkout_branch.pull(self, stop_revision=revision_id)
1380
tree = checkout.create_workingtree(revision_id,
1381
from_branch=from_branch,
1382
accelerator_tree=accelerator_tree,
1384
basis_tree = tree.basis_tree()
1385
basis_tree.lock_read()
1387
for path, file_id in basis_tree.iter_references():
1388
reference_parent = self.reference_parent(file_id, path)
1389
reference_parent.create_checkout(tree.abspath(path),
1390
basis_tree.get_reference_revision(file_id, path),
1397
def reconcile(self, thorough=True):
1398
"""Make sure the data stored in this branch is consistent."""
1399
from bzrlib.reconcile import BranchReconciler
1400
reconciler = BranchReconciler(self, thorough=thorough)
1401
reconciler.reconcile()
1404
def reference_parent(self, file_id, path, possible_transports=None):
1405
"""Return the parent branch for a tree-reference file_id
1406
:param file_id: The file_id of the tree reference
1407
:param path: The path of the file_id in the tree
1408
:return: A branch associated with the file_id
1410
# FIXME should provide multiple branches, based on config
1411
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1412
possible_transports=possible_transports)
1414
def supports_tags(self):
1415
return self._format.supports_tags()
1417
def automatic_tag_name(self, revision_id):
1418
"""Try to automatically find the tag name for a revision.
1420
:param revision_id: Revision id of the revision.
1421
:return: A tag name or None if no tag name could be determined.
1423
for hook in Branch.hooks['automatic_tag_name']:
1424
ret = hook(self, revision_id)
1429
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1431
"""Ensure that revision_b is a descendant of revision_a.
1433
This is a helper function for update_revisions.
1435
:raises: DivergedBranches if revision_b has diverged from revision_a.
1436
:returns: True if revision_b is a descendant of revision_a.
1438
relation = self._revision_relations(revision_a, revision_b, graph)
1439
if relation == 'b_descends_from_a':
1441
elif relation == 'diverged':
1442
raise errors.DivergedBranches(self, other_branch)
1443
elif relation == 'a_descends_from_b':
1446
raise AssertionError("invalid relation: %r" % (relation,))
1448
def _revision_relations(self, revision_a, revision_b, graph):
1449
"""Determine the relationship between two revisions.
1451
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1453
heads = graph.heads([revision_a, revision_b])
1454
if heads == set([revision_b]):
1455
return 'b_descends_from_a'
1456
elif heads == set([revision_a, revision_b]):
1457
# These branches have diverged
1459
elif heads == set([revision_a]):
1460
return 'a_descends_from_b'
1462
raise AssertionError("invalid heads: %r" % (heads,))
1465
class BranchFormat(object):
1466
"""An encapsulation of the initialization and open routines for a format.
1468
Formats provide three things:
1469
* An initialization routine,
1473
Formats are placed in an dict by their format string for reference
1474
during branch opening. Its not required that these be instances, they
1475
can be classes themselves with class methods - it simply depends on
1476
whether state is needed for a given format or not.
1478
Once a format is deprecated, just deprecate the initialize and open
1479
methods on the format class. Do not deprecate the object, as the
1480
object will be created every time regardless.
1483
_default_format = None
1484
"""The default format used for new branches."""
1487
"""The known formats."""
1489
can_set_append_revisions_only = True
1491
def __eq__(self, other):
1492
return self.__class__ is other.__class__
1494
def __ne__(self, other):
1495
return not (self == other)
1498
def find_format(klass, a_bzrdir, name=None):
1499
"""Return the format for the branch object in a_bzrdir."""
1501
transport = a_bzrdir.get_branch_transport(None, name=name)
1502
format_string = transport.get_bytes("format")
1503
return klass._formats[format_string]
1504
except errors.NoSuchFile:
1505
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1507
raise errors.UnknownFormatError(format=format_string, kind='branch')
1510
def get_default_format(klass):
1511
"""Return the current default format."""
1512
return klass._default_format
1514
def get_reference(self, a_bzrdir):
1515
"""Get the target reference of the branch in a_bzrdir.
1517
format probing must have been completed before calling
1518
this method - it is assumed that the format of the branch
1519
in a_bzrdir is correct.
1521
:param a_bzrdir: The bzrdir to get the branch data from.
1522
:return: None if the branch is not a reference branch.
1527
def set_reference(self, a_bzrdir, to_branch):
1528
"""Set the target reference of the branch in a_bzrdir.
1530
format probing must have been completed before calling
1531
this method - it is assumed that the format of the branch
1532
in a_bzrdir is correct.
1534
:param a_bzrdir: The bzrdir to set the branch reference for.
1535
:param to_branch: branch that the checkout is to reference
1537
raise NotImplementedError(self.set_reference)
1539
def get_format_string(self):
1540
"""Return the ASCII format string that identifies this format."""
1541
raise NotImplementedError(self.get_format_string)
1543
def get_format_description(self):
1544
"""Return the short format description for this format."""
1545
raise NotImplementedError(self.get_format_description)
1547
def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1548
lock_type='metadir', set_format=True):
1549
"""Initialize a branch in a bzrdir, with specified files
1551
:param a_bzrdir: The bzrdir to initialize the branch in
1552
:param utf8_files: The files to create as a list of
1553
(filename, content) tuples
1554
:param name: Name of colocated branch to create, if any
1555
:param set_format: If True, set the format with
1556
self.get_format_string. (BzrBranch4 has its format set
1558
:return: a branch in this format
1560
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1561
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1563
'metadir': ('lock', lockdir.LockDir),
1564
'branch4': ('branch-lock', lockable_files.TransportLock),
1566
lock_name, lock_class = lock_map[lock_type]
1567
control_files = lockable_files.LockableFiles(branch_transport,
1568
lock_name, lock_class)
1569
control_files.create_lock()
1571
control_files.lock_write()
1572
except errors.LockContention:
1573
if lock_type != 'branch4':
1579
utf8_files += [('format', self.get_format_string())]
1581
for (filename, content) in utf8_files:
1582
branch_transport.put_bytes(
1584
mode=a_bzrdir._get_file_mode())
1587
control_files.unlock()
1588
return self.open(a_bzrdir, name, _found=True)
1590
def initialize(self, a_bzrdir, name=None):
1591
"""Create a branch of this format in a_bzrdir.
1593
:param name: Name of the colocated branch to create.
1595
raise NotImplementedError(self.initialize)
1597
def is_supported(self):
1598
"""Is this format supported?
1600
Supported formats can be initialized and opened.
1601
Unsupported formats may not support initialization or committing or
1602
some other features depending on the reason for not being supported.
1606
def make_tags(self, branch):
1607
"""Create a tags object for branch.
1609
This method is on BranchFormat, because BranchFormats are reflected
1610
over the wire via network_name(), whereas full Branch instances require
1611
multiple VFS method calls to operate at all.
1613
The default implementation returns a disabled-tags instance.
1615
Note that it is normal for branch to be a RemoteBranch when using tags
1618
return DisabledTags(branch)
1620
def network_name(self):
1621
"""A simple byte string uniquely identifying this format for RPC calls.
1623
MetaDir branch formats use their disk format string to identify the
1624
repository over the wire. All in one formats such as bzr < 0.8, and
1625
foreign formats like svn/git and hg should use some marker which is
1626
unique and immutable.
1628
raise NotImplementedError(self.network_name)
1630
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1631
"""Return the branch object for a_bzrdir
1633
:param a_bzrdir: A BzrDir that contains a branch.
1634
:param name: Name of colocated branch to open
1635
:param _found: a private parameter, do not use it. It is used to
1636
indicate if format probing has already be done.
1637
:param ignore_fallbacks: when set, no fallback branches will be opened
1638
(if there are any). Default is to open fallbacks.
1640
raise NotImplementedError(self.open)
1643
def register_format(klass, format):
1644
"""Register a metadir format."""
1645
klass._formats[format.get_format_string()] = format
1646
# Metadir formats have a network name of their format string, and get
1647
# registered as class factories.
1648
network_format_registry.register(format.get_format_string(), format.__class__)
1651
def set_default_format(klass, format):
1652
klass._default_format = format
1654
def supports_set_append_revisions_only(self):
1655
"""True if this format supports set_append_revisions_only."""
1658
def supports_stacking(self):
1659
"""True if this format records a stacked-on branch."""
1663
def unregister_format(klass, format):
1664
del klass._formats[format.get_format_string()]
1667
return self.get_format_description().rstrip()
1669
def supports_tags(self):
1670
"""True if this format supports tags stored in the branch"""
1671
return False # by default
1674
class BranchHooks(Hooks):
1675
"""A dictionary mapping hook name to a list of callables for branch hooks.
1677
e.g. ['set_rh'] Is the list of items to be called when the
1678
set_revision_history function is invoked.
1682
"""Create the default hooks.
1684
These are all empty initially, because by default nothing should get
1687
Hooks.__init__(self)
1688
self.create_hook(HookPoint('set_rh',
1689
"Invoked whenever the revision history has been set via "
1690
"set_revision_history. The api signature is (branch, "
1691
"revision_history), and the branch will be write-locked. "
1692
"The set_rh hook can be expensive for bzr to trigger, a better "
1693
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1694
self.create_hook(HookPoint('open',
1695
"Called with the Branch object that has been opened after a "
1696
"branch is opened.", (1, 8), None))
1697
self.create_hook(HookPoint('post_push',
1698
"Called after a push operation completes. post_push is called "
1699
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1700
"bzr client.", (0, 15), None))
1701
self.create_hook(HookPoint('post_pull',
1702
"Called after a pull operation completes. post_pull is called "
1703
"with a bzrlib.branch.PullResult object and only runs in the "
1704
"bzr client.", (0, 15), None))
1705
self.create_hook(HookPoint('pre_commit',
1706
"Called after a commit is calculated but before it is is "
1707
"completed. pre_commit is called with (local, master, old_revno, "
1708
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1709
"). old_revid is NULL_REVISION for the first commit to a branch, "
1710
"tree_delta is a TreeDelta object describing changes from the "
1711
"basis revision. hooks MUST NOT modify this delta. "
1712
" future_tree is an in-memory tree obtained from "
1713
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1714
"tree.", (0,91), None))
1715
self.create_hook(HookPoint('post_commit',
1716
"Called in the bzr client after a commit has completed. "
1717
"post_commit is called with (local, master, old_revno, old_revid, "
1718
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1719
"commit to a branch.", (0, 15), None))
1720
self.create_hook(HookPoint('post_uncommit',
1721
"Called in the bzr client after an uncommit completes. "
1722
"post_uncommit is called with (local, master, old_revno, "
1723
"old_revid, new_revno, new_revid) where local is the local branch "
1724
"or None, master is the target branch, and an empty branch "
1725
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1726
self.create_hook(HookPoint('pre_change_branch_tip',
1727
"Called in bzr client and server before a change to the tip of a "
1728
"branch is made. pre_change_branch_tip is called with a "
1729
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1730
"commit, uncommit will all trigger this hook.", (1, 6), None))
1731
self.create_hook(HookPoint('post_change_branch_tip',
1732
"Called in bzr client and server after a change to the tip of a "
1733
"branch is made. post_change_branch_tip is called with a "
1734
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1735
"commit, uncommit will all trigger this hook.", (1, 4), None))
1736
self.create_hook(HookPoint('transform_fallback_location',
1737
"Called when a stacked branch is activating its fallback "
1738
"locations. transform_fallback_location is called with (branch, "
1739
"url), and should return a new url. Returning the same url "
1740
"allows it to be used as-is, returning a different one can be "
1741
"used to cause the branch to stack on a closer copy of that "
1742
"fallback_location. Note that the branch cannot have history "
1743
"accessing methods called on it during this hook because the "
1744
"fallback locations have not been activated. When there are "
1745
"multiple hooks installed for transform_fallback_location, "
1746
"all are called with the url returned from the previous hook."
1747
"The order is however undefined.", (1, 9), None))
1748
self.create_hook(HookPoint('automatic_tag_name',
1749
"Called to determine an automatic tag name for a revision."
1750
"automatic_tag_name is called with (branch, revision_id) and "
1751
"should return a tag name or None if no tag name could be "
1752
"determined. The first non-None tag name returned will be used.",
1757
# install the default hooks into the Branch class.
1758
Branch.hooks = BranchHooks()
1761
class ChangeBranchTipParams(object):
1762
"""Object holding parameters passed to *_change_branch_tip hooks.
1764
There are 5 fields that hooks may wish to access:
1766
:ivar branch: the branch being changed
1767
:ivar old_revno: revision number before the change
1768
:ivar new_revno: revision number after the change
1769
:ivar old_revid: revision id before the change
1770
:ivar new_revid: revision id after the change
1772
The revid fields are strings. The revno fields are integers.
1775
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1776
"""Create a group of ChangeBranchTip parameters.
1778
:param branch: The branch being changed.
1779
:param old_revno: Revision number before the change.
1780
:param new_revno: Revision number after the change.
1781
:param old_revid: Tip revision id before the change.
1782
:param new_revid: Tip revision id after the change.
1784
self.branch = branch
1785
self.old_revno = old_revno
1786
self.new_revno = new_revno
1787
self.old_revid = old_revid
1788
self.new_revid = new_revid
1790
def __eq__(self, other):
1791
return self.__dict__ == other.__dict__
1794
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1795
self.__class__.__name__, self.branch,
1796
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1799
class BzrBranchFormat4(BranchFormat):
1800
"""Bzr branch format 4.
1803
- a revision-history file.
1804
- a branch-lock lock file [ to be shared with the bzrdir ]
1807
def get_format_description(self):
1808
"""See BranchFormat.get_format_description()."""
1809
return "Branch format 4"
1811
def initialize(self, a_bzrdir, name=None):
1812
"""Create a branch of this format in a_bzrdir."""
1813
utf8_files = [('revision-history', ''),
1814
('branch-name', ''),
1816
return self._initialize_helper(a_bzrdir, utf8_files, name=name,
1817
lock_type='branch4', set_format=False)
1820
super(BzrBranchFormat4, self).__init__()
1821
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1823
def network_name(self):
1824
"""The network name for this format is the control dirs disk label."""
1825
return self._matchingbzrdir.get_format_string()
1827
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1828
"""See BranchFormat.open()."""
1830
# we are being called directly and must probe.
1831
raise NotImplementedError
1832
return BzrBranch(_format=self,
1833
_control_files=a_bzrdir._control_files,
1836
_repository=a_bzrdir.open_repository())
1839
return "Bazaar-NG branch format 4"
1842
class BranchFormatMetadir(BranchFormat):
1843
"""Common logic for meta-dir based branch formats."""
1845
def _branch_class(self):
1846
"""What class to instantiate on open calls."""
1847
raise NotImplementedError(self._branch_class)
1849
def network_name(self):
1850
"""A simple byte string uniquely identifying this format for RPC calls.
1852
Metadir branch formats use their format string.
1854
return self.get_format_string()
1856
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1857
"""See BranchFormat.open()."""
1859
format = BranchFormat.find_format(a_bzrdir, name=name)
1860
if format.__class__ != self.__class__:
1861
raise AssertionError("wrong format %r found for %r" %
1864
transport = a_bzrdir.get_branch_transport(None, name=name)
1865
control_files = lockable_files.LockableFiles(transport, 'lock',
1867
return self._branch_class()(_format=self,
1868
_control_files=control_files,
1871
_repository=a_bzrdir.find_repository(),
1872
ignore_fallbacks=ignore_fallbacks)
1873
except errors.NoSuchFile:
1874
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1877
super(BranchFormatMetadir, self).__init__()
1878
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1879
self._matchingbzrdir.set_branch_format(self)
1881
def supports_tags(self):
1885
class BzrBranchFormat5(BranchFormatMetadir):
1886
"""Bzr branch format 5.
1889
- a revision-history file.
1891
- a lock dir guarding the branch itself
1892
- all of this stored in a branch/ subdirectory
1893
- works with shared repositories.
1895
This format is new in bzr 0.8.
1898
def _branch_class(self):
1901
def get_format_string(self):
1902
"""See BranchFormat.get_format_string()."""
1903
return "Bazaar-NG branch format 5\n"
1905
def get_format_description(self):
1906
"""See BranchFormat.get_format_description()."""
1907
return "Branch format 5"
1909
def initialize(self, a_bzrdir, name=None):
1910
"""Create a branch of this format in a_bzrdir."""
1911
utf8_files = [('revision-history', ''),
1912
('branch-name', ''),
1914
return self._initialize_helper(a_bzrdir, utf8_files, name)
1916
def supports_tags(self):
1920
class BzrBranchFormat6(BranchFormatMetadir):
1921
"""Branch format with last-revision and tags.
1923
Unlike previous formats, this has no explicit revision history. Instead,
1924
this just stores the last-revision, and the left-hand history leading
1925
up to there is the history.
1927
This format was introduced in bzr 0.15
1928
and became the default in 0.91.
1931
def _branch_class(self):
1934
def get_format_string(self):
1935
"""See BranchFormat.get_format_string()."""
1936
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1938
def get_format_description(self):
1939
"""See BranchFormat.get_format_description()."""
1940
return "Branch format 6"
1942
def initialize(self, a_bzrdir, name=None):
1943
"""Create a branch of this format in a_bzrdir."""
1944
utf8_files = [('last-revision', '0 null:\n'),
1945
('branch.conf', ''),
1948
return self._initialize_helper(a_bzrdir, utf8_files, name)
1950
def make_tags(self, branch):
1951
"""See bzrlib.branch.BranchFormat.make_tags()."""
1952
return BasicTags(branch)
1954
def supports_set_append_revisions_only(self):
1958
class BzrBranchFormat8(BranchFormatMetadir):
1959
"""Metadir format supporting storing locations of subtree branches."""
1961
def _branch_class(self):
1964
def get_format_string(self):
1965
"""See BranchFormat.get_format_string()."""
1966
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
1968
def get_format_description(self):
1969
"""See BranchFormat.get_format_description()."""
1970
return "Branch format 8"
1972
def initialize(self, a_bzrdir, name=None):
1973
"""Create a branch of this format in a_bzrdir."""
1974
utf8_files = [('last-revision', '0 null:\n'),
1975
('branch.conf', ''),
1979
return self._initialize_helper(a_bzrdir, utf8_files, name)
1982
super(BzrBranchFormat8, self).__init__()
1983
self._matchingbzrdir.repository_format = \
1984
RepositoryFormatKnitPack5RichRoot()
1986
def make_tags(self, branch):
1987
"""See bzrlib.branch.BranchFormat.make_tags()."""
1988
return BasicTags(branch)
1990
def supports_set_append_revisions_only(self):
1993
def supports_stacking(self):
1996
supports_reference_locations = True
1999
class BzrBranchFormat7(BzrBranchFormat8):
2000
"""Branch format with last-revision, tags, and a stacked location pointer.
2002
The stacked location pointer is passed down to the repository and requires
2003
a repository format with supports_external_lookups = True.
2005
This format was introduced in bzr 1.6.
2008
def initialize(self, a_bzrdir, name=None):
2009
"""Create a branch of this format in a_bzrdir."""
2010
utf8_files = [('last-revision', '0 null:\n'),
2011
('branch.conf', ''),
2014
return self._initialize_helper(a_bzrdir, utf8_files, name)
2016
def _branch_class(self):
2019
def get_format_string(self):
2020
"""See BranchFormat.get_format_string()."""
2021
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
2023
def get_format_description(self):
2024
"""See BranchFormat.get_format_description()."""
2025
return "Branch format 7"
2027
def supports_set_append_revisions_only(self):
2030
supports_reference_locations = False
2033
class BranchReferenceFormat(BranchFormat):
2034
"""Bzr branch reference format.
2036
Branch references are used in implementing checkouts, they
2037
act as an alias to the real branch which is at some other url.
2044
def get_format_string(self):
2045
"""See BranchFormat.get_format_string()."""
2046
return "Bazaar-NG Branch Reference Format 1\n"
2048
def get_format_description(self):
2049
"""See BranchFormat.get_format_description()."""
2050
return "Checkout reference format 1"
2052
def get_reference(self, a_bzrdir):
2053
"""See BranchFormat.get_reference()."""
2054
transport = a_bzrdir.get_branch_transport(None)
2055
return transport.get_bytes('location')
2057
def set_reference(self, a_bzrdir, to_branch):
2058
"""See BranchFormat.set_reference()."""
2059
transport = a_bzrdir.get_branch_transport(None)
2060
location = transport.put_bytes('location', to_branch.base)
2062
def initialize(self, a_bzrdir, name=None, target_branch=None):
2063
"""Create a branch of this format in a_bzrdir."""
2064
if target_branch is None:
2065
# this format does not implement branch itself, thus the implicit
2066
# creation contract must see it as uninitializable
2067
raise errors.UninitializableFormat(self)
2068
mutter('creating branch reference in %s', a_bzrdir.transport.base)
2069
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2070
branch_transport.put_bytes('location',
2071
target_branch.bzrdir.root_transport.base)
2072
branch_transport.put_bytes('format', self.get_format_string())
2074
a_bzrdir, name, _found=True,
2075
possible_transports=[target_branch.bzrdir.root_transport])
2078
super(BranchReferenceFormat, self).__init__()
2079
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2080
self._matchingbzrdir.set_branch_format(self)
2082
def _make_reference_clone_function(format, a_branch):
2083
"""Create a clone() routine for a branch dynamically."""
2084
def clone(to_bzrdir, revision_id=None,
2085
repository_policy=None):
2086
"""See Branch.clone()."""
2087
return format.initialize(to_bzrdir, target_branch=a_branch)
2088
# cannot obey revision_id limits when cloning a reference ...
2089
# FIXME RBC 20060210 either nuke revision_id for clone, or
2090
# emit some sort of warning/error to the caller ?!
2093
def open(self, a_bzrdir, name=None, _found=False, location=None,
2094
possible_transports=None, ignore_fallbacks=False):
2095
"""Return the branch that the branch reference in a_bzrdir points at.
2097
:param a_bzrdir: A BzrDir that contains a branch.
2098
:param name: Name of colocated branch to open, if any
2099
:param _found: a private parameter, do not use it. It is used to
2100
indicate if format probing has already be done.
2101
:param ignore_fallbacks: when set, no fallback branches will be opened
2102
(if there are any). Default is to open fallbacks.
2103
:param location: The location of the referenced branch. If
2104
unspecified, this will be determined from the branch reference in
2106
:param possible_transports: An optional reusable transports list.
2109
format = BranchFormat.find_format(a_bzrdir, name=name)
2110
if format.__class__ != self.__class__:
2111
raise AssertionError("wrong format %r found for %r" %
2113
if location is None:
2114
location = self.get_reference(a_bzrdir)
2115
real_bzrdir = bzrdir.BzrDir.open(
2116
location, possible_transports=possible_transports)
2117
result = real_bzrdir.open_branch(name=name,
2118
ignore_fallbacks=ignore_fallbacks)
2119
# this changes the behaviour of result.clone to create a new reference
2120
# rather than a copy of the content of the branch.
2121
# I did not use a proxy object because that needs much more extensive
2122
# testing, and we are only changing one behaviour at the moment.
2123
# If we decide to alter more behaviours - i.e. the implicit nickname
2124
# then this should be refactored to introduce a tested proxy branch
2125
# and a subclass of that for use in overriding clone() and ....
2127
result.clone = self._make_reference_clone_function(result)
2131
network_format_registry = registry.FormatRegistry()
2132
"""Registry of formats indexed by their network name.
2134
The network name for a branch format is an identifier that can be used when
2135
referring to formats with smart server operations. See
2136
BranchFormat.network_name() for more detail.
2140
# formats which have no format string are not discoverable
2141
# and not independently creatable, so are not registered.
2142
__format5 = BzrBranchFormat5()
2143
__format6 = BzrBranchFormat6()
2144
__format7 = BzrBranchFormat7()
2145
__format8 = BzrBranchFormat8()
2146
BranchFormat.register_format(__format5)
2147
BranchFormat.register_format(BranchReferenceFormat())
2148
BranchFormat.register_format(__format6)
2149
BranchFormat.register_format(__format7)
2150
BranchFormat.register_format(__format8)
2151
BranchFormat.set_default_format(__format7)
2152
_legacy_formats = [BzrBranchFormat4(),
2154
network_format_registry.register(
2155
_legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2158
class BzrBranch(Branch, _RelockDebugMixin):
2159
"""A branch stored in the actual filesystem.
2161
Note that it's "local" in the context of the filesystem; it doesn't
2162
really matter if it's on an nfs/smb/afs/coda/... share, as long as
2163
it's writable, and can be accessed via the normal filesystem API.
2165
:ivar _transport: Transport for file operations on this branch's
2166
control files, typically pointing to the .bzr/branch directory.
2167
:ivar repository: Repository for this branch.
2168
:ivar base: The url of the base directory for this branch; the one
2169
containing the .bzr directory.
2170
:ivar name: Optional colocated branch name as it exists in the control
2174
def __init__(self, _format=None,
2175
_control_files=None, a_bzrdir=None, name=None,
2176
_repository=None, ignore_fallbacks=False):
2177
"""Create new branch object at a particular location."""
2178
if a_bzrdir is None:
2179
raise ValueError('a_bzrdir must be supplied')
2181
self.bzrdir = a_bzrdir
2182
self._base = self.bzrdir.transport.clone('..').base
2184
# XXX: We should be able to just do
2185
# self.base = self.bzrdir.root_transport.base
2186
# but this does not quite work yet -- mbp 20080522
2187
self._format = _format
2188
if _control_files is None:
2189
raise ValueError('BzrBranch _control_files is None')
2190
self.control_files = _control_files
2191
self._transport = _control_files._transport
2192
self.repository = _repository
2193
Branch.__init__(self)
2196
if self.name is None:
2197
return '%s(%r)' % (self.__class__.__name__, self.base)
2199
return '%s(%r,%r)' % (self.__class__.__name__, self.base, self.name)
2203
def _get_base(self):
2204
"""Returns the directory containing the control directory."""
2207
base = property(_get_base, doc="The URL for the root of this branch.")
2209
def _get_config(self):
2210
return TransportConfig(self._transport, 'branch.conf')
2212
def is_locked(self):
2213
return self.control_files.is_locked()
2215
def lock_write(self, token=None):
2216
if not self.is_locked():
2217
self._note_lock('w')
2218
# All-in-one needs to always unlock/lock.
2219
repo_control = getattr(self.repository, 'control_files', None)
2220
if self.control_files == repo_control or not self.is_locked():
2221
self.repository._warn_if_deprecated(self)
2222
self.repository.lock_write()
2227
return self.control_files.lock_write(token=token)
2230
self.repository.unlock()
2233
def lock_read(self):
2234
if not self.is_locked():
2235
self._note_lock('r')
2236
# All-in-one needs to always unlock/lock.
2237
repo_control = getattr(self.repository, 'control_files', None)
2238
if self.control_files == repo_control or not self.is_locked():
2239
self.repository._warn_if_deprecated(self)
2240
self.repository.lock_read()
2245
self.control_files.lock_read()
2248
self.repository.unlock()
2251
@only_raises(errors.LockNotHeld, errors.LockBroken)
2254
self.control_files.unlock()
2256
# All-in-one needs to always unlock/lock.
2257
repo_control = getattr(self.repository, 'control_files', None)
2258
if (self.control_files == repo_control or
2259
not self.control_files.is_locked()):
2260
self.repository.unlock()
2261
if not self.control_files.is_locked():
2262
# we just released the lock
2263
self._clear_cached_state()
2265
def peek_lock_mode(self):
2266
if self.control_files._lock_count == 0:
2269
return self.control_files._lock_mode
2271
def get_physical_lock_status(self):
2272
return self.control_files.get_physical_lock_status()
2275
def print_file(self, file, revision_id):
2276
"""See Branch.print_file."""
2277
return self.repository.print_file(file, revision_id)
2279
def _write_revision_history(self, history):
2280
"""Factored out of set_revision_history.
2282
This performs the actual writing to disk.
2283
It is intended to be called by BzrBranch5.set_revision_history."""
2284
self._transport.put_bytes(
2285
'revision-history', '\n'.join(history),
2286
mode=self.bzrdir._get_file_mode())
2289
def set_revision_history(self, rev_history):
2290
"""See Branch.set_revision_history."""
2291
if 'evil' in debug.debug_flags:
2292
mutter_callsite(3, "set_revision_history scales with history.")
2293
check_not_reserved_id = _mod_revision.check_not_reserved_id
2294
for rev_id in rev_history:
2295
check_not_reserved_id(rev_id)
2296
if Branch.hooks['post_change_branch_tip']:
2297
# Don't calculate the last_revision_info() if there are no hooks
2299
old_revno, old_revid = self.last_revision_info()
2300
if len(rev_history) == 0:
2301
revid = _mod_revision.NULL_REVISION
2303
revid = rev_history[-1]
2304
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2305
self._write_revision_history(rev_history)
2306
self._clear_cached_state()
2307
self._cache_revision_history(rev_history)
2308
for hook in Branch.hooks['set_rh']:
2309
hook(self, rev_history)
2310
if Branch.hooks['post_change_branch_tip']:
2311
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2313
def _synchronize_history(self, destination, revision_id):
2314
"""Synchronize last revision and revision history between branches.
2316
This version is most efficient when the destination is also a
2317
BzrBranch5, but works for BzrBranch6 as long as the revision
2318
history is the true lefthand parent history, and all of the revisions
2319
are in the destination's repository. If not, set_revision_history
2322
:param destination: The branch to copy the history into
2323
:param revision_id: The revision-id to truncate history at. May
2324
be None to copy complete history.
2326
if not isinstance(destination._format, BzrBranchFormat5):
2327
super(BzrBranch, self)._synchronize_history(
2328
destination, revision_id)
2330
if revision_id == _mod_revision.NULL_REVISION:
2333
new_history = self.revision_history()
2334
if revision_id is not None and new_history != []:
2336
new_history = new_history[:new_history.index(revision_id) + 1]
2338
rev = self.repository.get_revision(revision_id)
2339
new_history = rev.get_history(self.repository)[1:]
2340
destination.set_revision_history(new_history)
2343
def set_last_revision_info(self, revno, revision_id):
2344
"""Set the last revision of this branch.
2346
The caller is responsible for checking that the revno is correct
2347
for this revision id.
2349
It may be possible to set the branch last revision to an id not
2350
present in the repository. However, branches can also be
2351
configured to check constraints on history, in which case this may not
2354
revision_id = _mod_revision.ensure_null(revision_id)
2355
# this old format stores the full history, but this api doesn't
2356
# provide it, so we must generate, and might as well check it's
2358
history = self._lefthand_history(revision_id)
2359
if len(history) != revno:
2360
raise AssertionError('%d != %d' % (len(history), revno))
2361
self.set_revision_history(history)
2363
def _gen_revision_history(self):
2364
history = self._transport.get_bytes('revision-history').split('\n')
2365
if history[-1:] == ['']:
2366
# There shouldn't be a trailing newline, but just in case.
2371
def generate_revision_history(self, revision_id, last_rev=None,
2373
"""Create a new revision history that will finish with revision_id.
2375
:param revision_id: the new tip to use.
2376
:param last_rev: The previous last_revision. If not None, then this
2377
must be a ancestory of revision_id, or DivergedBranches is raised.
2378
:param other_branch: The other branch that DivergedBranches should
2379
raise with respect to.
2381
self.set_revision_history(self._lefthand_history(revision_id,
2382
last_rev, other_branch))
2384
def basis_tree(self):
2385
"""See Branch.basis_tree."""
2386
return self.repository.revision_tree(self.last_revision())
2388
def _get_parent_location(self):
2389
_locs = ['parent', 'pull', 'x-pull']
2392
return self._transport.get_bytes(l).strip('\n')
2393
except errors.NoSuchFile:
2397
def _basic_push(self, target, overwrite, stop_revision):
2398
"""Basic implementation of push without bound branches or hooks.
2400
Must be called with source read locked and target write locked.
2402
result = BranchPushResult()
2403
result.source_branch = self
2404
result.target_branch = target
2405
result.old_revno, result.old_revid = target.last_revision_info()
2406
self.update_references(target)
2407
if result.old_revid != self.last_revision():
2408
# We assume that during 'push' this repository is closer than
2410
graph = self.repository.get_graph(target.repository)
2411
target.update_revisions(self, stop_revision,
2412
overwrite=overwrite, graph=graph)
2413
if self._push_should_merge_tags():
2414
result.tag_conflicts = self.tags.merge_to(target.tags,
2416
result.new_revno, result.new_revid = target.last_revision_info()
2419
def get_stacked_on_url(self):
2420
raise errors.UnstackableBranchFormat(self._format, self.base)
2422
def set_push_location(self, location):
2423
"""See Branch.set_push_location."""
2424
self.get_config().set_user_option(
2425
'push_location', location,
2426
store=_mod_config.STORE_LOCATION_NORECURSE)
2428
def _set_parent_location(self, url):
2430
self._transport.delete('parent')
2432
self._transport.put_bytes('parent', url + '\n',
2433
mode=self.bzrdir._get_file_mode())
2436
class BzrBranch5(BzrBranch):
2437
"""A format 5 branch. This supports new features over plain branches.
2439
It has support for a master_branch which is the data for bound branches.
2442
def get_bound_location(self):
2444
return self._transport.get_bytes('bound')[:-1]
2445
except errors.NoSuchFile:
2449
def get_master_branch(self, possible_transports=None):
2450
"""Return the branch we are bound to.
2452
:return: Either a Branch, or None
2454
This could memoise the branch, but if thats done
2455
it must be revalidated on each new lock.
2456
So for now we just don't memoise it.
2457
# RBC 20060304 review this decision.
2459
bound_loc = self.get_bound_location()
2463
return Branch.open(bound_loc,
2464
possible_transports=possible_transports)
2465
except (errors.NotBranchError, errors.ConnectionError), e:
2466
raise errors.BoundBranchConnectionFailure(
2470
def set_bound_location(self, location):
2471
"""Set the target where this branch is bound to.
2473
:param location: URL to the target branch
2476
self._transport.put_bytes('bound', location+'\n',
2477
mode=self.bzrdir._get_file_mode())
2480
self._transport.delete('bound')
2481
except errors.NoSuchFile:
2486
def bind(self, other):
2487
"""Bind this branch to the branch other.
2489
This does not push or pull data between the branches, though it does
2490
check for divergence to raise an error when the branches are not
2491
either the same, or one a prefix of the other. That behaviour may not
2492
be useful, so that check may be removed in future.
2494
:param other: The branch to bind to
2497
# TODO: jam 20051230 Consider checking if the target is bound
2498
# It is debatable whether you should be able to bind to
2499
# a branch which is itself bound.
2500
# Committing is obviously forbidden,
2501
# but binding itself may not be.
2502
# Since we *have* to check at commit time, we don't
2503
# *need* to check here
2505
# we want to raise diverged if:
2506
# last_rev is not in the other_last_rev history, AND
2507
# other_last_rev is not in our history, and do it without pulling
2509
self.set_bound_location(other.base)
2513
"""If bound, unbind"""
2514
return self.set_bound_location(None)
2517
def update(self, possible_transports=None):
2518
"""Synchronise this branch with the master branch if any.
2520
:return: None or the last_revision that was pivoted out during the
2523
master = self.get_master_branch(possible_transports)
2524
if master is not None:
2525
old_tip = _mod_revision.ensure_null(self.last_revision())
2526
self.pull(master, overwrite=True)
2527
if self.repository.get_graph().is_ancestor(old_tip,
2528
_mod_revision.ensure_null(self.last_revision())):
2534
class BzrBranch8(BzrBranch5):
2535
"""A branch that stores tree-reference locations."""
2537
def _open_hook(self):
2538
if self._ignore_fallbacks:
2541
url = self.get_stacked_on_url()
2542
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2543
errors.UnstackableBranchFormat):
895
revs = self.revision_history()
896
if isinstance(revision, int):
899
# Mabye we should do this first, but we don't need it if revision == 0
901
revno = len(revs) + revision + 1
904
elif isinstance(revision, basestring):
905
for prefix, func in Branch.REVISION_NAMESPACES.iteritems():
906
if revision.startswith(prefix):
907
revno = func(self, revs, revision)
910
raise BzrError('No namespace registered for string: %r' % revision)
912
if revno is None or revno <= 0 or revno > len(revs):
913
raise BzrError("no such revision %s" % revision)
914
return revno, revs[revno-1]
916
def _namespace_revno(self, revs, revision):
917
"""Lookup a revision by revision number"""
918
assert revision.startswith('revno:')
920
return int(revision[6:])
923
REVISION_NAMESPACES['revno:'] = _namespace_revno
925
def _namespace_revid(self, revs, revision):
926
assert revision.startswith('revid:')
928
return revs.index(revision[6:]) + 1
931
REVISION_NAMESPACES['revid:'] = _namespace_revid
933
def _namespace_last(self, revs, revision):
934
assert revision.startswith('last:')
936
offset = int(revision[5:])
941
raise BzrError('You must supply a positive value for --revision last:XXX')
942
return len(revs) - offset + 1
943
REVISION_NAMESPACES['last:'] = _namespace_last
945
def _namespace_tag(self, revs, revision):
946
assert revision.startswith('tag:')
947
raise BzrError('tag: namespace registered, but not implemented.')
948
REVISION_NAMESPACES['tag:'] = _namespace_tag
950
def _namespace_date(self, revs, revision):
951
assert revision.startswith('date:')
953
# Spec for date revisions:
955
# value can be 'yesterday', 'today', 'tomorrow' or a YYYY-MM-DD string.
956
# it can also start with a '+/-/='. '+' says match the first
957
# entry after the given date. '-' is match the first entry before the date
958
# '=' is match the first entry after, but still on the given date.
960
# +2005-05-12 says find the first matching entry after May 12th, 2005 at 0:00
961
# -2005-05-12 says find the first matching entry before May 12th, 2005 at 0:00
962
# =2005-05-12 says find the first match after May 12th, 2005 at 0:00 but before
963
# May 13th, 2005 at 0:00
965
# So the proper way of saying 'give me all entries for today' is:
966
# -r {date:+today}:{date:-tomorrow}
967
# The default is '=' when not supplied
970
if val[:1] in ('+', '-', '='):
971
match_style = val[:1]
974
today = datetime.datetime.today().replace(hour=0,minute=0,second=0,microsecond=0)
975
if val.lower() == 'yesterday':
976
dt = today - datetime.timedelta(days=1)
977
elif val.lower() == 'today':
979
elif val.lower() == 'tomorrow':
980
dt = today + datetime.timedelta(days=1)
983
# This should be done outside the function to avoid recompiling it.
984
_date_re = re.compile(
985
r'(?P<date>(?P<year>\d\d\d\d)-(?P<month>\d\d)-(?P<day>\d\d))?'
987
r'(?P<time>(?P<hour>\d\d):(?P<minute>\d\d)(:(?P<second>\d\d))?)?'
989
m = _date_re.match(val)
990
if not m or (not m.group('date') and not m.group('time')):
991
raise BzrError('Invalid revision date %r' % revision)
994
year, month, day = int(m.group('year')), int(m.group('month')), int(m.group('day'))
996
year, month, day = today.year, today.month, today.day
998
hour = int(m.group('hour'))
999
minute = int(m.group('minute'))
1000
if m.group('second'):
1001
second = int(m.group('second'))
1005
hour, minute, second = 0,0,0
1007
dt = datetime.datetime(year=year, month=month, day=day,
1008
hour=hour, minute=minute, second=second)
1012
if match_style == '-':
1014
elif match_style == '=':
1015
last = dt + datetime.timedelta(days=1)
1018
for i in range(len(revs)-1, -1, -1):
1019
r = self.get_revision(revs[i])
1020
# TODO: Handle timezone.
1021
dt = datetime.datetime.fromtimestamp(r.timestamp)
1022
if first >= dt and (last is None or dt >= last):
1025
for i in range(len(revs)):
1026
r = self.get_revision(revs[i])
1027
# TODO: Handle timezone.
1028
dt = datetime.datetime.fromtimestamp(r.timestamp)
1029
if first <= dt and (last is None or dt <= last):
1031
REVISION_NAMESPACES['date:'] = _namespace_date
1033
def revision_tree(self, revision_id):
1034
"""Return Tree for a revision on this branch.
1036
`revision_id` may be None for the null revision, in which case
1037
an `EmptyTree` is returned."""
1038
# TODO: refactor this to use an existing revision object
1039
# so we don't need to read it in twice.
1040
if revision_id == None:
1043
inv = self.get_revision_inventory(revision_id)
1044
return RevisionTree(self.text_store, inv)
1047
def working_tree(self):
1048
"""Return a `Tree` for the working copy."""
1049
from workingtree import WorkingTree
1050
return WorkingTree(self.base, self.read_working_inventory())
1053
def basis_tree(self):
1054
"""Return `Tree` object for last revision.
1056
If there are no revisions yet, return an `EmptyTree`.
1058
r = self.last_patch()
1062
return RevisionTree(self.text_store, self.get_revision_inventory(r))
1066
def rename_one(self, from_rel, to_rel):
1069
This can change the directory or the filename or both.
1073
tree = self.working_tree()
1074
inv = tree.inventory
1075
if not tree.has_filename(from_rel):
1076
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1077
if tree.has_filename(to_rel):
1078
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1080
file_id = inv.path2id(from_rel)
1082
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1084
if inv.path2id(to_rel):
1085
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1087
to_dir, to_tail = os.path.split(to_rel)
1088
to_dir_id = inv.path2id(to_dir)
1089
if to_dir_id == None and to_dir != '':
1090
raise BzrError("can't determine destination directory id for %r" % to_dir)
1092
mutter("rename_one:")
1093
mutter(" file_id {%s}" % file_id)
1094
mutter(" from_rel %r" % from_rel)
1095
mutter(" to_rel %r" % to_rel)
1096
mutter(" to_dir %r" % to_dir)
1097
mutter(" to_dir_id {%s}" % to_dir_id)
1099
inv.rename(file_id, to_dir_id, to_tail)
1101
print "%s => %s" % (from_rel, to_rel)
1103
from_abs = self.abspath(from_rel)
1104
to_abs = self.abspath(to_rel)
1106
os.rename(from_abs, to_abs)
1108
raise BzrError("failed to rename %r to %r: %s"
1109
% (from_abs, to_abs, e[1]),
1110
["rename rolled back"])
1112
self._write_inventory(inv)
1117
def move(self, from_paths, to_name):
1120
to_name must exist as a versioned directory.
1122
If to_name exists and is a directory, the files are moved into
1123
it, keeping their old names. If it is a directory,
1125
Note that to_name is only the last component of the new name;
1126
this doesn't change the directory.
1130
## TODO: Option to move IDs only
1131
assert not isinstance(from_paths, basestring)
1132
tree = self.working_tree()
1133
inv = tree.inventory
1134
to_abs = self.abspath(to_name)
1135
if not isdir(to_abs):
1136
raise BzrError("destination %r is not a directory" % to_abs)
1137
if not tree.has_filename(to_name):
1138
raise BzrError("destination %r not in working directory" % to_abs)
1139
to_dir_id = inv.path2id(to_name)
1140
if to_dir_id == None and to_name != '':
1141
raise BzrError("destination %r is not a versioned directory" % to_name)
1142
to_dir_ie = inv[to_dir_id]
1143
if to_dir_ie.kind not in ('directory', 'root_directory'):
1144
raise BzrError("destination %r is not a directory" % to_abs)
1146
to_idpath = inv.get_idpath(to_dir_id)
1148
for f in from_paths:
1149
if not tree.has_filename(f):
1150
raise BzrError("%r does not exist in working tree" % f)
1151
f_id = inv.path2id(f)
1153
raise BzrError("%r is not versioned" % f)
1154
name_tail = splitpath(f)[-1]
1155
dest_path = appendpath(to_name, name_tail)
1156
if tree.has_filename(dest_path):
1157
raise BzrError("destination %r already exists" % dest_path)
1158
if f_id in to_idpath:
1159
raise BzrError("can't move %r to a subdirectory of itself" % f)
1161
# OK, so there's a race here, it's possible that someone will
1162
# create a file in this interval and then the rename might be
1163
# left half-done. But we should have caught most problems.
1165
for f in from_paths:
1166
name_tail = splitpath(f)[-1]
1167
dest_path = appendpath(to_name, name_tail)
1168
print "%s => %s" % (f, dest_path)
1169
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1171
os.rename(self.abspath(f), self.abspath(dest_path))
1173
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1174
["rename rolled back"])
1176
self._write_inventory(inv)
1181
def revert(self, filenames, old_tree=None, backups=True):
1182
"""Restore selected files to the versions from a previous tree.
1185
If true (default) backups are made of files before
1188
from bzrlib.errors import NotVersionedError, BzrError
1189
from bzrlib.atomicfile import AtomicFile
1190
from bzrlib.osutils import backup_file
1192
inv = self.read_working_inventory()
1193
if old_tree is None:
1194
old_tree = self.basis_tree()
1195
old_inv = old_tree.inventory
1198
for fn in filenames:
1199
file_id = inv.path2id(fn)
1201
raise NotVersionedError("not a versioned file", fn)
1202
if not old_inv.has_id(file_id):
1203
raise BzrError("file not present in old tree", fn, file_id)
1204
nids.append((fn, file_id))
1206
# TODO: Rename back if it was previously at a different location
1208
# TODO: If given a directory, restore the entire contents from
1209
# the previous version.
1211
# TODO: Make a backup to a temporary file.
1213
# TODO: If the file previously didn't exist, delete it?
1214
for fn, file_id in nids:
1217
f = AtomicFile(fn, 'wb')
1219
f.write(old_tree.get_file(file_id).read())
1225
def pending_merges(self):
1226
"""Return a list of pending merges.
1228
These are revisions that have been merged into the working
1229
directory but not yet committed.
1231
cfn = self.controlfilename('pending-merges')
1232
if not os.path.exists(cfn):
1235
for l in self.controlfile('pending-merges', 'r').readlines():
1236
p.append(l.rstrip('\n'))
1240
def add_pending_merge(self, revision_id):
1241
from bzrlib.revision import validate_revision_id
1243
validate_revision_id(revision_id)
1245
p = self.pending_merges()
1246
if revision_id in p:
2546
for hook in Branch.hooks['transform_fallback_location']:
2547
url = hook(self, url)
2549
hook_name = Branch.hooks.get_hook_name(hook)
2550
raise AssertionError(
2551
"'transform_fallback_location' hook %s returned "
2552
"None, not a URL." % hook_name)
2553
self._activate_fallback_location(url)
2555
def __init__(self, *args, **kwargs):
2556
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2557
super(BzrBranch8, self).__init__(*args, **kwargs)
2558
self._last_revision_info_cache = None
2559
self._reference_info = None
2561
def _clear_cached_state(self):
2562
super(BzrBranch8, self)._clear_cached_state()
2563
self._last_revision_info_cache = None
2564
self._reference_info = None
2566
def _last_revision_info(self):
2567
revision_string = self._transport.get_bytes('last-revision')
2568
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2569
revision_id = cache_utf8.get_cached_utf8(revision_id)
2571
return revno, revision_id
2573
def _write_last_revision_info(self, revno, revision_id):
2574
"""Simply write out the revision id, with no checks.
2576
Use set_last_revision_info to perform this safely.
2578
Does not update the revision_history cache.
2579
Intended to be called by set_last_revision_info and
2580
_write_revision_history.
2582
revision_id = _mod_revision.ensure_null(revision_id)
2583
out_string = '%d %s\n' % (revno, revision_id)
2584
self._transport.put_bytes('last-revision', out_string,
2585
mode=self.bzrdir._get_file_mode())
2588
def set_last_revision_info(self, revno, revision_id):
2589
revision_id = _mod_revision.ensure_null(revision_id)
2590
old_revno, old_revid = self.last_revision_info()
2591
if self._get_append_revisions_only():
2592
self._check_history_violation(revision_id)
2593
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2594
self._write_last_revision_info(revno, revision_id)
2595
self._clear_cached_state()
2596
self._last_revision_info_cache = revno, revision_id
2597
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2599
def _synchronize_history(self, destination, revision_id):
2600
"""Synchronize last revision and revision history between branches.
2602
:see: Branch._synchronize_history
2604
# XXX: The base Branch has a fast implementation of this method based
2605
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2606
# that uses set_revision_history. This class inherits from BzrBranch5,
2607
# but wants the fast implementation, so it calls
2608
# Branch._synchronize_history directly.
2609
Branch._synchronize_history(self, destination, revision_id)
2611
def _check_history_violation(self, revision_id):
2612
last_revision = _mod_revision.ensure_null(self.last_revision())
2613
if _mod_revision.is_null(last_revision):
1248
p.append(revision_id)
1249
self.set_pending_merges(p)
1252
def set_pending_merges(self, rev_list):
1253
from bzrlib.atomicfile import AtomicFile
2615
if last_revision not in self._lefthand_history(revision_id):
2616
raise errors.AppendRevisionsOnlyViolation(self.base)
2618
def _gen_revision_history(self):
2619
"""Generate the revision history from last revision
2621
last_revno, last_revision = self.last_revision_info()
2622
self._extend_partial_history(stop_index=last_revno-1)
2623
return list(reversed(self._partial_revision_history_cache))
2625
def _write_revision_history(self, history):
2626
"""Factored out of set_revision_history.
2628
This performs the actual writing to disk, with format-specific checks.
2629
It is intended to be called by BzrBranch5.set_revision_history.
2631
if len(history) == 0:
2632
last_revision = 'null:'
2634
if history != self._lefthand_history(history[-1]):
2635
raise errors.NotLefthandHistory(history)
2636
last_revision = history[-1]
2637
if self._get_append_revisions_only():
2638
self._check_history_violation(last_revision)
2639
self._write_last_revision_info(len(history), last_revision)
2642
def _set_parent_location(self, url):
2643
"""Set the parent branch"""
2644
self._set_config_location('parent_location', url, make_relative=True)
2647
def _get_parent_location(self):
2648
"""Set the parent branch"""
2649
return self._get_config_location('parent_location')
2652
def _set_all_reference_info(self, info_dict):
2653
"""Replace all reference info stored in a branch.
2655
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2658
writer = rio.RioWriter(s)
2659
for key, (tree_path, branch_location) in info_dict.iteritems():
2660
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2661
branch_location=branch_location)
2662
writer.write_stanza(stanza)
2663
self._transport.put_bytes('references', s.getvalue())
2664
self._reference_info = info_dict
2667
def _get_all_reference_info(self):
2668
"""Return all the reference info stored in a branch.
2670
:return: A dict of {file_id: (tree_path, branch_location)}
2672
if self._reference_info is not None:
2673
return self._reference_info
2674
rio_file = self._transport.get('references')
1256
f = AtomicFile(self.controlfilename('pending-merges'))
2676
stanzas = rio.read_stanzas(rio_file)
2677
info_dict = dict((s['file_id'], (s['tree_path'],
2678
s['branch_location'])) for s in stanzas)
1268
class ScratchBranch(Branch):
1269
"""Special test class: a branch that cleans up after itself.
1271
>>> b = ScratchBranch()
2681
self._reference_info = info_dict
2684
def set_reference_info(self, file_id, tree_path, branch_location):
2685
"""Set the branch location to use for a tree reference.
2687
:param file_id: The file-id of the tree reference.
2688
:param tree_path: The path of the tree reference in the tree.
2689
:param branch_location: The location of the branch to retrieve tree
2692
info_dict = self._get_all_reference_info()
2693
info_dict[file_id] = (tree_path, branch_location)
2694
if None in (tree_path, branch_location):
2695
if tree_path is not None:
2696
raise ValueError('tree_path must be None when branch_location'
2698
if branch_location is not None:
2699
raise ValueError('branch_location must be None when tree_path'
2701
del info_dict[file_id]
2702
self._set_all_reference_info(info_dict)
2704
def get_reference_info(self, file_id):
2705
"""Get the tree_path and branch_location for a tree reference.
2707
:return: a tuple of (tree_path, branch_location)
2709
return self._get_all_reference_info().get(file_id, (None, None))
2711
def reference_parent(self, file_id, path, possible_transports=None):
2712
"""Return the parent branch for a tree-reference file_id.
2714
:param file_id: The file_id of the tree reference
2715
:param path: The path of the file_id in the tree
2716
:return: A branch associated with the file_id
2718
branch_location = self.get_reference_info(file_id)[1]
2719
if branch_location is None:
2720
return Branch.reference_parent(self, file_id, path,
2721
possible_transports)
2722
branch_location = urlutils.join(self.base, branch_location)
2723
return Branch.open(branch_location,
2724
possible_transports=possible_transports)
2726
def set_push_location(self, location):
2727
"""See Branch.set_push_location."""
2728
self._set_config_location('push_location', location)
2730
def set_bound_location(self, location):
2731
"""See Branch.set_push_location."""
2733
config = self.get_config()
2734
if location is None:
2735
if config.get_user_option('bound') != 'True':
2738
config.set_user_option('bound', 'False', warn_masked=True)
2741
self._set_config_location('bound_location', location,
2743
config.set_user_option('bound', 'True', warn_masked=True)
2746
def _get_bound_location(self, bound):
2747
"""Return the bound location in the config file.
2749
Return None if the bound parameter does not match"""
2750
config = self.get_config()
2751
config_bound = (config.get_user_option('bound') == 'True')
2752
if config_bound != bound:
2754
return self._get_config_location('bound_location', config=config)
2756
def get_bound_location(self):
2757
"""See Branch.set_push_location."""
2758
return self._get_bound_location(True)
2760
def get_old_bound_location(self):
2761
"""See Branch.get_old_bound_location"""
2762
return self._get_bound_location(False)
2764
def get_stacked_on_url(self):
2765
# you can always ask for the URL; but you might not be able to use it
2766
# if the repo can't support stacking.
2767
## self._check_stackable_repo()
2768
stacked_url = self._get_config_location('stacked_on_location')
2769
if stacked_url is None:
2770
raise errors.NotStacked(self)
2773
def _get_append_revisions_only(self):
2774
value = self.get_config().get_user_option('append_revisions_only')
2775
return value == 'True'
2778
def generate_revision_history(self, revision_id, last_rev=None,
2780
"""See BzrBranch5.generate_revision_history"""
2781
history = self._lefthand_history(revision_id, last_rev, other_branch)
2782
revno = len(history)
2783
self.set_last_revision_info(revno, revision_id)
2786
def get_rev_id(self, revno, history=None):
2787
"""Find the revision id of the specified revno."""
2789
return _mod_revision.NULL_REVISION
2791
last_revno, last_revision_id = self.last_revision_info()
2792
if revno <= 0 or revno > last_revno:
2793
raise errors.NoSuchRevision(self, revno)
2795
if history is not None:
2796
return history[revno - 1]
2798
index = last_revno - revno
2799
if len(self._partial_revision_history_cache) <= index:
2800
self._extend_partial_history(stop_index=index)
2801
if len(self._partial_revision_history_cache) > index:
2802
return self._partial_revision_history_cache[index]
2804
raise errors.NoSuchRevision(self, revno)
2807
def revision_id_to_revno(self, revision_id):
2808
"""Given a revision id, return its revno"""
2809
if _mod_revision.is_null(revision_id):
2812
index = self._partial_revision_history_cache.index(revision_id)
2814
self._extend_partial_history(stop_revision=revision_id)
2815
index = len(self._partial_revision_history_cache) - 1
2816
if self._partial_revision_history_cache[index] != revision_id:
2817
raise errors.NoSuchRevision(self, revision_id)
2818
return self.revno() - index
2821
class BzrBranch7(BzrBranch8):
2822
"""A branch with support for a fallback repository."""
2824
def set_reference_info(self, file_id, tree_path, branch_location):
2825
Branch.set_reference_info(self, file_id, tree_path, branch_location)
2827
def get_reference_info(self, file_id):
2828
Branch.get_reference_info(self, file_id)
2830
def reference_parent(self, file_id, path, possible_transports=None):
2831
return Branch.reference_parent(self, file_id, path,
2832
possible_transports)
2835
class BzrBranch6(BzrBranch7):
2836
"""See BzrBranchFormat6 for the capabilities of this branch.
2838
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
1279
def __init__(self, files=[], dirs=[], base=None):
1280
"""Make a test branch.
1282
This creates a temporary directory and runs init-tree in it.
1284
If any files are listed, they are created in the working copy.
1286
from tempfile import mkdtemp
1291
Branch.__init__(self, base, init=init)
1293
os.mkdir(self.abspath(d))
1296
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
1301
>>> orig = ScratchBranch(files=["file1", "file2"])
1302
>>> clone = orig.clone()
1303
>>> os.path.samefile(orig.base, clone.base)
1305
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1308
from shutil import copytree
1309
from tempfile import mkdtemp
1312
copytree(self.base, base, symlinks=True)
1313
return ScratchBranch(base=base)
1319
"""Destroy the test branch, removing the scratch directory."""
1320
from shutil import rmtree
1323
mutter("delete ScratchBranch %s" % self.base)
1326
# Work around for shutil.rmtree failing on Windows when
1327
# readonly files are encountered
1328
mutter("hit exception in destroying ScratchBranch: %s" % e)
1329
for root, dirs, files in os.walk(self.base, topdown=False):
1331
os.chmod(os.path.join(root, name), 0700)
2842
def get_stacked_on_url(self):
2843
raise errors.UnstackableBranchFormat(self._format, self.base)
1337
2846
######################################################################
1341
def is_control_file(filename):
1342
## FIXME: better check
1343
filename = os.path.normpath(filename)
1344
while filename != '':
1345
head, tail = os.path.split(filename)
1346
## mutter('check %r for control file' % ((head, tail), ))
1347
if tail == bzrlib.BZRDIR:
1349
if filename == head:
1356
def gen_file_id(name):
1357
"""Return new file id.
1359
This should probably generate proper UUIDs, but for the moment we
1360
cope with just randomness because running uuidgen every time is
1363
from binascii import hexlify
1364
from time import time
1366
# get last component
1367
idx = name.rfind('/')
1369
name = name[idx+1 : ]
1370
idx = name.rfind('\\')
1372
name = name[idx+1 : ]
1374
# make it not a hidden file
1375
name = name.lstrip('.')
1377
# remove any wierd characters; we don't escape them but rather
1378
# just pull them out
1379
name = re.sub(r'[^\w.]', '', name)
1381
s = hexlify(rand_bytes(8))
1382
return '-'.join((name, compact_date(time()), s))
1386
"""Return a new tree-root file id."""
1387
return gen_file_id('TREE_ROOT')
2847
# results of operations
2850
class _Result(object):
2852
def _show_tag_conficts(self, to_file):
2853
if not getattr(self, 'tag_conflicts', None):
2855
to_file.write('Conflicting tags:\n')
2856
for name, value1, value2 in self.tag_conflicts:
2857
to_file.write(' %s\n' % (name, ))
2860
class PullResult(_Result):
2861
"""Result of a Branch.pull operation.
2863
:ivar old_revno: Revision number before pull.
2864
:ivar new_revno: Revision number after pull.
2865
:ivar old_revid: Tip revision id before pull.
2866
:ivar new_revid: Tip revision id after pull.
2867
:ivar source_branch: Source (local) branch object. (read locked)
2868
:ivar master_branch: Master branch of the target, or the target if no
2870
:ivar local_branch: target branch if there is a Master, else None
2871
:ivar target_branch: Target/destination branch object. (write locked)
2872
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2876
# DEPRECATED: pull used to return the change in revno
2877
return self.new_revno - self.old_revno
2879
def report(self, to_file):
2881
if self.old_revid == self.new_revid:
2882
to_file.write('No revisions to pull.\n')
2884
to_file.write('Now on revision %d.\n' % self.new_revno)
2885
self._show_tag_conficts(to_file)
2888
class BranchPushResult(_Result):
2889
"""Result of a Branch.push operation.
2891
:ivar old_revno: Revision number (eg 10) of the target before push.
2892
:ivar new_revno: Revision number (eg 12) of the target after push.
2893
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
2895
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
2897
:ivar source_branch: Source branch object that the push was from. This is
2898
read locked, and generally is a local (and thus low latency) branch.
2899
:ivar master_branch: If target is a bound branch, the master branch of
2900
target, or target itself. Always write locked.
2901
:ivar target_branch: The direct Branch where data is being sent (write
2903
:ivar local_branch: If the target is a bound branch this will be the
2904
target, otherwise it will be None.
2908
# DEPRECATED: push used to return the change in revno
2909
return self.new_revno - self.old_revno
2911
def report(self, to_file):
2912
"""Write a human-readable description of the result."""
2913
if self.old_revid == self.new_revid:
2914
note('No new revisions to push.')
2916
note('Pushed up to revision %d.' % self.new_revno)
2917
self._show_tag_conficts(to_file)
2920
class BranchCheckResult(object):
2921
"""Results of checking branch consistency.
2926
def __init__(self, branch):
2927
self.branch = branch
2930
def report_results(self, verbose):
2931
"""Report the check results via trace.note.
2933
:param verbose: Requests more detailed display of what was checked,
2936
note('checked branch %s format %s', self.branch.base,
2937
self.branch._format)
2938
for error in self.errors:
2939
note('found error:%s', error)
2942
class Converter5to6(object):
2943
"""Perform an in-place upgrade of format 5 to format 6"""
2945
def convert(self, branch):
2946
# Data for 5 and 6 can peacefully coexist.
2947
format = BzrBranchFormat6()
2948
new_branch = format.open(branch.bzrdir, _found=True)
2950
# Copy source data into target
2951
new_branch._write_last_revision_info(*branch.last_revision_info())
2952
new_branch.set_parent(branch.get_parent())
2953
new_branch.set_bound_location(branch.get_bound_location())
2954
new_branch.set_push_location(branch.get_push_location())
2956
# New branch has no tags by default
2957
new_branch.tags._set_tag_dict({})
2959
# Copying done; now update target format
2960
new_branch._transport.put_bytes('format',
2961
format.get_format_string(),
2962
mode=new_branch.bzrdir._get_file_mode())
2964
# Clean up old files
2965
new_branch._transport.delete('revision-history')
2967
branch.set_parent(None)
2968
except errors.NoSuchFile:
2970
branch.set_bound_location(None)
2973
class Converter6to7(object):
2974
"""Perform an in-place upgrade of format 6 to format 7"""
2976
def convert(self, branch):
2977
format = BzrBranchFormat7()
2978
branch._set_config_location('stacked_on_location', '')
2979
# update target format
2980
branch._transport.put_bytes('format', format.get_format_string())
2983
class Converter7to8(object):
2984
"""Perform an in-place upgrade of format 6 to format 7"""
2986
def convert(self, branch):
2987
format = BzrBranchFormat8()
2988
branch._transport.put_bytes('references', '')
2989
# update target format
2990
branch._transport.put_bytes('format', format.get_format_string())
2993
def _run_with_write_locked_target(target, callable, *args, **kwargs):
2994
"""Run ``callable(*args, **kwargs)``, write-locking target for the
2997
_run_with_write_locked_target will attempt to release the lock it acquires.
2999
If an exception is raised by callable, then that exception *will* be
3000
propagated, even if the unlock attempt raises its own error. Thus
3001
_run_with_write_locked_target should be preferred to simply doing::
3005
return callable(*args, **kwargs)
3010
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
3011
# should share code?
3014
result = callable(*args, **kwargs)
3016
exc_info = sys.exc_info()
3020
raise exc_info[0], exc_info[1], exc_info[2]
3026
class InterBranch(InterObject):
3027
"""This class represents operations taking place between two branches.
3029
Its instances have methods like pull() and push() and contain
3030
references to the source and target repositories these operations
3031
can be carried out on.
3035
"""The available optimised InterBranch types."""
3038
def _get_branch_formats_to_test():
3039
"""Return a tuple with the Branch formats to use when testing."""
3040
raise NotImplementedError(InterBranch._get_branch_formats_to_test)
3042
def pull(self, overwrite=False, stop_revision=None,
3043
possible_transports=None, local=False):
3044
"""Mirror source into target branch.
3046
The target branch is considered to be 'local', having low latency.
3048
:returns: PullResult instance
3050
raise NotImplementedError(self.pull)
3052
def update_revisions(self, stop_revision=None, overwrite=False,
3054
"""Pull in new perfect-fit revisions.
3056
:param stop_revision: Updated until the given revision
3057
:param overwrite: Always set the branch pointer, rather than checking
3058
to see if it is a proper descendant.
3059
:param graph: A Graph object that can be used to query history
3060
information. This can be None.
3063
raise NotImplementedError(self.update_revisions)
3065
def push(self, overwrite=False, stop_revision=None,
3066
_override_hook_source_branch=None):
3067
"""Mirror the source branch into the target branch.
3069
The source branch is considered to be 'local', having low latency.
3071
raise NotImplementedError(self.push)
3074
class GenericInterBranch(InterBranch):
3075
"""InterBranch implementation that uses public Branch functions.
3079
def _get_branch_formats_to_test():
3080
return BranchFormat._default_format, BranchFormat._default_format
3082
def update_revisions(self, stop_revision=None, overwrite=False,
3084
"""See InterBranch.update_revisions()."""
3085
self.source.lock_read()
3087
other_revno, other_last_revision = self.source.last_revision_info()
3088
stop_revno = None # unknown
3089
if stop_revision is None:
3090
stop_revision = other_last_revision
3091
if _mod_revision.is_null(stop_revision):
3092
# if there are no commits, we're done.
3094
stop_revno = other_revno
3096
# what's the current last revision, before we fetch [and change it
3098
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3099
# we fetch here so that we don't process data twice in the common
3100
# case of having something to pull, and so that the check for
3101
# already merged can operate on the just fetched graph, which will
3102
# be cached in memory.
3103
self.target.fetch(self.source, stop_revision)
3104
# Check to see if one is an ancestor of the other
3107
graph = self.target.repository.get_graph()
3108
if self.target._check_if_descendant_or_diverged(
3109
stop_revision, last_rev, graph, self.source):
3110
# stop_revision is a descendant of last_rev, but we aren't
3111
# overwriting, so we're done.
3113
if stop_revno is None:
3115
graph = self.target.repository.get_graph()
3116
this_revno, this_last_revision = \
3117
self.target.last_revision_info()
3118
stop_revno = graph.find_distance_to_null(stop_revision,
3119
[(other_last_revision, other_revno),
3120
(this_last_revision, this_revno)])
3121
self.target.set_last_revision_info(stop_revno, stop_revision)
3123
self.source.unlock()
3125
def pull(self, overwrite=False, stop_revision=None,
3126
possible_transports=None, _hook_master=None, run_hooks=True,
3127
_override_hook_target=None, local=False):
3130
:param _hook_master: Private parameter - set the branch to
3131
be supplied as the master to pull hooks.
3132
:param run_hooks: Private parameter - if false, this branch
3133
is being called because it's the master of the primary branch,
3134
so it should not run its hooks.
3135
:param _override_hook_target: Private parameter - set the branch to be
3136
supplied as the target_branch to pull hooks.
3137
:param local: Only update the local branch, and not the bound branch.
3139
# This type of branch can't be bound.
3141
raise errors.LocalRequiresBoundBranch()
3142
result = PullResult()
3143
result.source_branch = self.source
3144
if _override_hook_target is None:
3145
result.target_branch = self.target
3147
result.target_branch = _override_hook_target
3148
self.source.lock_read()
3150
# We assume that during 'pull' the target repository is closer than
3152
self.source.update_references(self.target)
3153
graph = self.target.repository.get_graph(self.source.repository)
3154
# TODO: Branch formats should have a flag that indicates
3155
# that revno's are expensive, and pull() should honor that flag.
3157
result.old_revno, result.old_revid = \
3158
self.target.last_revision_info()
3159
self.target.update_revisions(self.source, stop_revision,
3160
overwrite=overwrite, graph=graph)
3161
# TODO: The old revid should be specified when merging tags,
3162
# so a tags implementation that versions tags can only
3163
# pull in the most recent changes. -- JRV20090506
3164
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3166
result.new_revno, result.new_revid = self.target.last_revision_info()
3168
result.master_branch = _hook_master
3169
result.local_branch = result.target_branch
3171
result.master_branch = result.target_branch
3172
result.local_branch = None
3174
for hook in Branch.hooks['post_pull']:
3177
self.source.unlock()
3180
def push(self, overwrite=False, stop_revision=None,
3181
_override_hook_source_branch=None):
3182
"""See InterBranch.push.
3184
This is the basic concrete implementation of push()
3186
:param _override_hook_source_branch: If specified, run
3187
the hooks passing this Branch as the source, rather than self.
3188
This is for use of RemoteBranch, where push is delegated to the
3189
underlying vfs-based Branch.
3191
# TODO: Public option to disable running hooks - should be trivial but
3193
self.source.lock_read()
3195
return _run_with_write_locked_target(
3196
self.target, self._push_with_bound_branches, overwrite,
3198
_override_hook_source_branch=_override_hook_source_branch)
3200
self.source.unlock()
3202
def _push_with_bound_branches(self, overwrite, stop_revision,
3203
_override_hook_source_branch=None):
3204
"""Push from source into target, and into target's master if any.
3207
if _override_hook_source_branch:
3208
result.source_branch = _override_hook_source_branch
3209
for hook in Branch.hooks['post_push']:
3212
bound_location = self.target.get_bound_location()
3213
if bound_location and self.target.base != bound_location:
3214
# there is a master branch.
3216
# XXX: Why the second check? Is it even supported for a branch to
3217
# be bound to itself? -- mbp 20070507
3218
master_branch = self.target.get_master_branch()
3219
master_branch.lock_write()
3221
# push into the master from the source branch.
3222
self.source._basic_push(master_branch, overwrite, stop_revision)
3223
# and push into the target branch from the source. Note that we
3224
# push from the source branch again, because its considered the
3225
# highest bandwidth repository.
3226
result = self.source._basic_push(self.target, overwrite,
3228
result.master_branch = master_branch
3229
result.local_branch = self.target
3233
master_branch.unlock()
3236
result = self.source._basic_push(self.target, overwrite,
3238
# TODO: Why set master_branch and local_branch if there's no
3239
# binding? Maybe cleaner to just leave them unset? -- mbp
3241
result.master_branch = self.target
3242
result.local_branch = None
3247
def is_compatible(self, source, target):
3248
# GenericBranch uses the public API, so always compatible
3252
class InterToBranch5(GenericInterBranch):
3255
def _get_branch_formats_to_test():
3256
return BranchFormat._default_format, BzrBranchFormat5()
3258
def pull(self, overwrite=False, stop_revision=None,
3259
possible_transports=None, run_hooks=True,
3260
_override_hook_target=None, local=False):
3261
"""Pull from source into self, updating my master if any.
3263
:param run_hooks: Private parameter - if false, this branch
3264
is being called because it's the master of the primary branch,
3265
so it should not run its hooks.
3267
bound_location = self.target.get_bound_location()
3268
if local and not bound_location:
3269
raise errors.LocalRequiresBoundBranch()
3270
master_branch = None
3271
if not local and bound_location and self.source.base != bound_location:
3272
# not pulling from master, so we need to update master.
3273
master_branch = self.target.get_master_branch(possible_transports)
3274
master_branch.lock_write()
3277
# pull from source into master.
3278
master_branch.pull(self.source, overwrite, stop_revision,
3280
return super(InterToBranch5, self).pull(overwrite,
3281
stop_revision, _hook_master=master_branch,
3282
run_hooks=run_hooks,
3283
_override_hook_target=_override_hook_target)
3286
master_branch.unlock()
3289
InterBranch.register_optimiser(GenericInterBranch)
3290
InterBranch.register_optimiser(InterToBranch5)
added
removed
bzrlib/branch.py
