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)
173
def open_from_transport(transport, _unsupported=False):
174
"""Open the branch rooted at transport"""
175
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
176
return control.open_branch(_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_bzrdir = bzrdir.BzrDir.open(url,
221
possible_transports=[self.bzrdir.root_transport])
222
return a_bzrdir.open_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
if direction == 'reverse':
460
if direction == 'forward':
461
return reversed(list(filtered))
463
raise ValueError('invalid direction %r' % direction)
465
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
466
start_revision_id, stop_revision_id, stop_rule):
467
"""Iterate over an inclusive range of sorted revisions."""
468
rev_iter = iter(merge_sorted_revisions)
469
if start_revision_id is not None:
470
for node in rev_iter:
471
rev_id = node.key[-1]
472
if rev_id != start_revision_id:
475
# The decision to include the start or not
476
# depends on the stop_rule if a stop is provided
477
# so pop this node back into the iterator
478
rev_iter = chain(iter([node]), rev_iter)
480
if stop_revision_id is None:
482
for node in rev_iter:
483
rev_id = node.key[-1]
484
yield (rev_id, node.merge_depth, node.revno,
486
elif stop_rule == 'exclude':
487
for node in rev_iter:
488
rev_id = node.key[-1]
489
if rev_id == stop_revision_id:
491
yield (rev_id, node.merge_depth, node.revno,
493
elif stop_rule == 'include':
494
for node in rev_iter:
495
rev_id = node.key[-1]
496
yield (rev_id, node.merge_depth, node.revno,
498
if rev_id == stop_revision_id:
500
elif stop_rule == 'with-merges':
501
stop_rev = self.repository.get_revision(stop_revision_id)
502
if stop_rev.parent_ids:
503
left_parent = stop_rev.parent_ids[0]
505
left_parent = _mod_revision.NULL_REVISION
506
for node in rev_iter:
507
rev_id = node.key[-1]
508
if rev_id == left_parent:
510
yield (rev_id, node.merge_depth, node.revno,
513
raise ValueError('invalid stop_rule %r' % stop_rule)
515
def leave_lock_in_place(self):
516
"""Tell this branch object not to release the physical lock when this
519
If lock_write doesn't return a token, then this method is not supported.
521
self.control_files.leave_in_place()
523
def dont_leave_lock_in_place(self):
524
"""Tell this branch object to release the physical lock when this
525
object is unlocked, even if it didn't originally acquire it.
527
If lock_write doesn't return a token, then this method is not supported.
529
self.control_files.dont_leave_in_place()
531
def bind(self, other):
532
"""Bind the local branch the other branch.
534
:param other: The branch to bind to
537
raise errors.UpgradeRequired(self.base)
539
def set_append_revisions_only(self, enabled):
540
if not self._format.supports_set_append_revisions_only():
541
raise errors.UpgradeRequired(self.base)
546
self.get_config().set_user_option('append_revisions_only', value,
549
def set_reference_info(self, file_id, tree_path, branch_location):
550
"""Set the branch location to use for a tree reference."""
551
raise errors.UnsupportedOperation(self.set_reference_info, self)
553
def get_reference_info(self, file_id):
554
"""Get the tree_path and branch_location for a tree reference."""
555
raise errors.UnsupportedOperation(self.get_reference_info, self)
558
def fetch(self, from_branch, last_revision=None, pb=None):
559
"""Copy revisions from from_branch into this branch.
561
:param from_branch: Where to copy from.
562
:param last_revision: What revision to stop at (None for at the end
564
:param pb: An optional progress bar to use.
567
if self.base == from_branch.base:
570
symbol_versioning.warn(
571
symbol_versioning.deprecated_in((1, 14, 0))
572
% "pb parameter to fetch()")
573
from_branch.lock_read()
575
if last_revision is None:
576
last_revision = from_branch.last_revision()
577
last_revision = _mod_revision.ensure_null(last_revision)
578
return self.repository.fetch(from_branch.repository,
579
revision_id=last_revision,
584
def get_bound_location(self):
585
"""Return the URL of the branch we are bound to.
587
Older format branches cannot bind, please be sure to use a metadir
592
def get_old_bound_location(self):
593
"""Return the URL of the branch we used to be bound to
595
raise errors.UpgradeRequired(self.base)
597
def get_commit_builder(self, parents, config=None, timestamp=None,
598
timezone=None, committer=None, revprops=None,
600
"""Obtain a CommitBuilder for this branch.
602
:param parents: Revision ids of the parents of the new revision.
603
:param config: Optional configuration to use.
604
:param timestamp: Optional timestamp recorded for commit.
605
:param timezone: Optional timezone for timestamp.
606
:param committer: Optional committer to set for commit.
607
:param revprops: Optional dictionary of revision properties.
608
:param revision_id: Optional revision id.
612
config = self.get_config()
614
return self.repository.get_commit_builder(self, parents, config,
615
timestamp, timezone, committer, revprops, revision_id)
617
def get_master_branch(self, possible_transports=None):
618
"""Return the branch we are bound to.
620
:return: Either a Branch, or None
617
624
def get_revision_delta(self, revno):
618
625
"""Return the delta for one revision.
789
871
common_index = min(self_len, other_len) -1
790
872
if common_index >= 0 and \
791
873
self_history[common_index] != other_history[common_index]:
792
raise DivergedBranches(self, other)
874
raise errors.DivergedBranches(self, other)
794
876
if stop_revision is None:
795
877
stop_revision = other_len
796
elif stop_revision > other_len:
797
raise NoSuchRevision(self, stop_revision)
879
if stop_revision > other_len:
880
raise errors.NoSuchRevision(self, stop_revision)
799
881
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)
884
def update_revisions(self, other, stop_revision=None, overwrite=False,
886
"""Pull in new perfect-fit revisions.
888
:param other: Another Branch to pull from
889
:param stop_revision: Updated until the given revision
890
:param overwrite: Always set the branch pointer, rather than checking
891
to see if it is a proper descendant.
892
:param graph: A Graph object that can be used to query history
893
information. This can be None.
896
return InterBranch.get(other, self).update_revisions(stop_revision,
899
def import_last_revision_info(self, source_repo, revno, revid):
900
"""Set the last revision info, importing from another repo if necessary.
902
This is used by the bound branch code to upload a revision to
903
the master branch first before updating the tip of the local branch.
905
:param source_repo: Source repository to optionally fetch from
906
:param revno: Revision number of the new tip
907
:param revid: Revision id of the new tip
909
if not self.repository.has_same_location(source_repo):
910
self.repository.fetch(source_repo, revision_id=revid)
911
self.set_last_revision_info(revno, revid)
913
def revision_id_to_revno(self, revision_id):
914
"""Given a revision id, return its revno"""
915
if _mod_revision.is_null(revision_id):
917
history = self.revision_history()
919
return history.index(revision_id) + 1
893
920
except ValueError:
921
raise errors.NoSuchRevision(self, revision_id)
924
def get_rev_id(self, revno, history=None):
925
"""Find the revision id of the specified revno."""
927
return _mod_revision.NULL_REVISION
928
last_revno, last_revid = self.last_revision_info()
929
if revno == last_revno:
931
if revno <= 0 or revno > last_revno:
932
raise errors.NoSuchRevision(self, revno)
933
distance_from_last = last_revno - revno
934
if len(self._partial_revision_history_cache) <= distance_from_last:
935
self._extend_partial_history(distance_from_last)
936
return self._partial_revision_history_cache[distance_from_last]
939
def pull(self, source, overwrite=False, stop_revision=None,
940
possible_transports=None, *args, **kwargs):
941
"""Mirror source into this branch.
943
This branch is considered to be 'local', having low latency.
945
:returns: PullResult instance
947
return InterBranch.get(source, self).pull(overwrite=overwrite,
948
stop_revision=stop_revision,
949
possible_transports=possible_transports, *args, **kwargs)
951
def push(self, target, overwrite=False, stop_revision=None, *args,
953
"""Mirror this branch into target.
955
This branch is considered to be 'local', having low latency.
957
return InterBranch.get(self, target).push(overwrite, stop_revision,
960
def lossy_push(self, target, stop_revision=None):
961
"""Push deltas into another branch.
963
:note: This does not, like push, retain the revision ids from
964
the source branch and will, rather than adding bzr-specific
965
metadata, push only those semantics of the revision that can be
966
natively represented by this branch' VCS.
968
:param target: Target branch
969
:param stop_revision: Revision to push, defaults to last revision.
970
:return: BranchPushResult with an extra member revidmap:
971
A dictionary mapping revision ids from the target branch
972
to new revision ids in the target branch, for each
973
revision that was pushed.
975
inter = InterBranch.get(self, target)
976
lossy_push = getattr(inter, "lossy_push", None)
977
if lossy_push is None:
978
raise errors.LossyPushToSameVCS(self, target)
979
return lossy_push(stop_revision)
981
def basis_tree(self):
982
"""Return `Tree` object for last revision."""
983
return self.repository.revision_tree(self.last_revision())
985
def get_parent(self):
986
"""Return the parent location of the branch.
988
This is the default location for pull/missing. The usual
989
pattern is that the user can override it by specifying a
992
parent = self._get_parent_location()
995
# This is an old-format absolute path to a local branch
997
if parent.startswith('/'):
998
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1000
return urlutils.join(self.base[:-1], parent)
1001
except errors.InvalidURLJoin, e:
1002
raise errors.InaccessibleParent(parent, self.base)
1004
def _get_parent_location(self):
1005
raise NotImplementedError(self._get_parent_location)
1007
def _set_config_location(self, name, url, config=None,
1008
make_relative=False):
1010
config = self.get_config()
1014
url = urlutils.relative_url(self.base, url)
1015
config.set_user_option(name, url, warn_masked=True)
1017
def _get_config_location(self, name, config=None):
1019
config = self.get_config()
1020
location = config.get_user_option(name)
1025
def get_child_submit_format(self):
1026
"""Return the preferred format of submissions to this branch."""
1027
return self.get_config().get_user_option("child_submit_format")
1029
def get_submit_branch(self):
1030
"""Return the submit location of the branch.
1032
This is the default location for bundle. The usual
1033
pattern is that the user can override it by specifying a
1036
return self.get_config().get_user_option('submit_branch')
1038
def set_submit_branch(self, location):
1039
"""Return the submit location of the branch.
1041
This is the default location for bundle. The usual
1042
pattern is that the user can override it by specifying a
1045
self.get_config().set_user_option('submit_branch', location,
1048
def get_public_branch(self):
1049
"""Return the public location of the branch.
1051
This is used by merge directives.
1053
return self._get_config_location('public_branch')
1055
def set_public_branch(self, location):
1056
"""Return the submit location of the branch.
1058
This is the default location for bundle. The usual
1059
pattern is that the user can override it by specifying a
1062
self._set_config_location('public_branch', location)
1064
def get_push_location(self):
1065
"""Return the None or the location to push this branch to."""
1066
push_loc = self.get_config().get_user_option('push_location')
1069
def set_push_location(self, location):
1070
"""Set a new push location for this branch."""
1071
raise NotImplementedError(self.set_push_location)
1073
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1074
"""Run the post_change_branch_tip hooks."""
1075
hooks = Branch.hooks['post_change_branch_tip']
1078
new_revno, new_revid = self.last_revision_info()
1079
params = ChangeBranchTipParams(
1080
self, old_revno, new_revno, old_revid, new_revid)
1084
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
1085
"""Run the pre_change_branch_tip hooks."""
1086
hooks = Branch.hooks['pre_change_branch_tip']
1089
old_revno, old_revid = self.last_revision_info()
1090
params = ChangeBranchTipParams(
1091
self, old_revno, new_revno, old_revid, new_revid)
1095
except errors.TipChangeRejected:
1098
exc_info = sys.exc_info()
1099
hook_name = Branch.hooks.get_hook_name(hook)
1100
raise errors.HookFailed(
1101
'pre_change_branch_tip', hook_name, exc_info)
1105
"""Synchronise this branch with the master branch if any.
1107
:return: None or the last_revision pivoted out during the update.
1111
def check_revno(self, revno):
1113
Check whether a revno corresponds to any revision.
1114
Zero (the NULL revision) is considered valid.
1117
self.check_real_revno(revno)
1119
def check_real_revno(self, revno):
1121
Check whether a revno corresponds to a real revision.
1122
Zero (the NULL revision) is considered invalid
1124
if revno < 1 or revno > self.revno():
1125
raise errors.InvalidRevisionNumber(revno)
1128
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
1129
"""Clone this branch into to_bzrdir preserving all semantic values.
1131
Most API users will want 'create_clone_on_transport', which creates a
1132
new bzrdir and branch on the fly.
1134
revision_id: if not None, the revision history in the new branch will
1135
be truncated to end with revision_id.
1137
result = to_bzrdir.create_branch()
1140
if repository_policy is not None:
1141
repository_policy.configure_branch(result)
1142
self.copy_content_into(result, revision_id=revision_id)
1148
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
1149
"""Create a new line of development from the branch, into to_bzrdir.
1151
to_bzrdir controls the branch format.
1153
revision_id: if not None, the revision history in the new branch will
1154
be truncated to end with revision_id.
1156
if (repository_policy is not None and
1157
repository_policy.requires_stacking()):
1158
to_bzrdir._format.require_stacking(_skip_repo=True)
1159
result = to_bzrdir.create_branch()
1162
if repository_policy is not None:
1163
repository_policy.configure_branch(result)
1164
self.copy_content_into(result, revision_id=revision_id)
1165
result.set_parent(self.bzrdir.root_transport.base)
1170
def _synchronize_history(self, destination, revision_id):
1171
"""Synchronize last revision and revision history between branches.
1173
This version is most efficient when the destination is also a
1174
BzrBranch6, but works for BzrBranch5, as long as the destination's
1175
repository contains all the lefthand ancestors of the intended
1176
last_revision. If not, set_last_revision_info will fail.
1178
:param destination: The branch to copy the history into
1179
:param revision_id: The revision-id to truncate history at. May
1180
be None to copy complete history.
1182
source_revno, source_revision_id = self.last_revision_info()
1183
if revision_id is None:
1184
revno, revision_id = source_revno, source_revision_id
1186
graph = self.repository.get_graph()
1188
revno = graph.find_distance_to_null(revision_id,
1189
[(source_revision_id, source_revno)])
1190
except errors.GhostRevisionsHaveNoRevno:
1191
# Default to 1, if we can't find anything else
1193
destination.set_last_revision_info(revno, revision_id)
1196
def copy_content_into(self, destination, revision_id=None):
1197
"""Copy the content of self into destination.
1199
revision_id: if not None, the revision history in the new branch will
1200
be truncated to end with revision_id.
1202
self.update_references(destination)
1203
self._synchronize_history(destination, revision_id)
1205
parent = self.get_parent()
1206
except errors.InaccessibleParent, e:
1207
mutter('parent was not accessible to copy: %s', e)
1210
destination.set_parent(parent)
1211
if self._push_should_merge_tags():
1212
self.tags.merge_to(destination.tags)
1214
def update_references(self, target):
1215
if not getattr(self._format, 'supports_reference_locations', False):
1217
reference_dict = self._get_all_reference_info()
1218
if len(reference_dict) == 0:
1220
old_base = self.base
1221
new_base = target.base
1222
target_reference_dict = target._get_all_reference_info()
1223
for file_id, (tree_path, branch_location) in (
1224
reference_dict.items()):
1225
branch_location = urlutils.rebase_url(branch_location,
1227
target_reference_dict.setdefault(
1228
file_id, (tree_path, branch_location))
1229
target._set_all_reference_info(target_reference_dict)
1232
def check(self, refs):
1233
"""Check consistency of the branch.
1235
In particular this checks that revisions given in the revision-history
1236
do actually match up in the revision graph, and that they're all
1237
present in the repository.
1239
Callers will typically also want to check the repository.
1241
:param refs: Calculated refs for this branch as specified by
1242
branch._get_check_refs()
1243
:return: A BranchCheckResult.
1245
result = BranchCheckResult(self)
1246
last_revno, last_revision_id = self.last_revision_info()
1247
actual_revno = refs[('lefthand-distance', last_revision_id)]
1248
if actual_revno != last_revno:
1249
result.errors.append(errors.BzrCheckError(
1250
'revno does not match len(mainline) %s != %s' % (
1251
last_revno, actual_revno)))
1252
# TODO: We should probably also check that self.revision_history
1253
# matches the repository for older branch formats.
1254
# If looking for the code that cross-checks repository parents against
1255
# the iter_reverse_revision_history output, that is now a repository
1259
def _get_checkout_format(self):
1260
"""Return the most suitable metadir for a checkout of this branch.
1261
Weaves are used if this branch's repository uses weaves.
1263
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1264
from bzrlib.repofmt import weaverepo
1265
format = bzrdir.BzrDirMetaFormat1()
1266
format.repository_format = weaverepo.RepositoryFormat7()
1268
format = self.repository.bzrdir.checkout_metadir()
1269
format.set_branch_format(self._format)
1272
def create_clone_on_transport(self, to_transport, revision_id=None,
1273
stacked_on=None, create_prefix=False, use_existing_dir=False):
1274
"""Create a clone of this branch and its bzrdir.
1276
:param to_transport: The transport to clone onto.
1277
:param revision_id: The revision id to use as tip in the new branch.
1278
If None the tip is obtained from this branch.
1279
:param stacked_on: An optional URL to stack the clone on.
1280
:param create_prefix: Create any missing directories leading up to
1282
:param use_existing_dir: Use an existing directory if one exists.
1284
# XXX: Fix the bzrdir API to allow getting the branch back from the
1285
# clone call. Or something. 20090224 RBC/spiv.
1286
if revision_id is None:
1287
revision_id = self.last_revision()
1288
dir_to = self.bzrdir.clone_on_transport(to_transport,
1289
revision_id=revision_id, stacked_on=stacked_on,
1290
create_prefix=create_prefix, use_existing_dir=use_existing_dir)
1291
return dir_to.open_branch()
1293
def create_checkout(self, to_location, revision_id=None,
1294
lightweight=False, accelerator_tree=None,
1296
"""Create a checkout of a branch.
1298
:param to_location: The url to produce the checkout at
1299
:param revision_id: The revision to check out
1300
:param lightweight: If True, produce a lightweight checkout, otherwise,
1301
produce a bound branch (heavyweight checkout)
1302
:param accelerator_tree: A tree which can be used for retrieving file
1303
contents more quickly than the revision tree, i.e. a workingtree.
1304
The revision tree will be used for cases where accelerator_tree's
1305
content is different.
1306
:param hardlink: If true, hard-link files from accelerator_tree,
1308
:return: The tree of the created checkout
1310
t = transport.get_transport(to_location)
1313
format = self._get_checkout_format()
1314
checkout = format.initialize_on_transport(t)
1315
from_branch = BranchReferenceFormat().initialize(checkout, self)
1317
format = self._get_checkout_format()
1318
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1319
to_location, force_new_tree=False, format=format)
1320
checkout = checkout_branch.bzrdir
1321
checkout_branch.bind(self)
1322
# pull up to the specified revision_id to set the initial
1323
# branch tip correctly, and seed it with history.
1324
checkout_branch.pull(self, stop_revision=revision_id)
1326
tree = checkout.create_workingtree(revision_id,
1327
from_branch=from_branch,
1328
accelerator_tree=accelerator_tree,
1330
basis_tree = tree.basis_tree()
1331
basis_tree.lock_read()
1333
for path, file_id in basis_tree.iter_references():
1334
reference_parent = self.reference_parent(file_id, path)
1335
reference_parent.create_checkout(tree.abspath(path),
1336
basis_tree.get_reference_revision(file_id, path),
1343
def reconcile(self, thorough=True):
1344
"""Make sure the data stored in this branch is consistent."""
1345
from bzrlib.reconcile import BranchReconciler
1346
reconciler = BranchReconciler(self, thorough=thorough)
1347
reconciler.reconcile()
1350
def reference_parent(self, file_id, path, possible_transports=None):
1351
"""Return the parent branch for a tree-reference file_id
1352
:param file_id: The file_id of the tree reference
1353
:param path: The path of the file_id in the tree
1354
:return: A branch associated with the file_id
1356
# FIXME should provide multiple branches, based on config
1357
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1358
possible_transports=possible_transports)
1360
def supports_tags(self):
1361
return self._format.supports_tags()
1363
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1365
"""Ensure that revision_b is a descendant of revision_a.
1367
This is a helper function for update_revisions.
1369
:raises: DivergedBranches if revision_b has diverged from revision_a.
1370
:returns: True if revision_b is a descendant of revision_a.
1372
relation = self._revision_relations(revision_a, revision_b, graph)
1373
if relation == 'b_descends_from_a':
1375
elif relation == 'diverged':
1376
raise errors.DivergedBranches(self, other_branch)
1377
elif relation == 'a_descends_from_b':
1380
raise AssertionError("invalid relation: %r" % (relation,))
1382
def _revision_relations(self, revision_a, revision_b, graph):
1383
"""Determine the relationship between two revisions.
1385
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1387
heads = graph.heads([revision_a, revision_b])
1388
if heads == set([revision_b]):
1389
return 'b_descends_from_a'
1390
elif heads == set([revision_a, revision_b]):
1391
# These branches have diverged
1393
elif heads == set([revision_a]):
1394
return 'a_descends_from_b'
1396
raise AssertionError("invalid heads: %r" % (heads,))
1399
class BranchFormat(object):
1400
"""An encapsulation of the initialization and open routines for a format.
1402
Formats provide three things:
1403
* An initialization routine,
1407
Formats are placed in an dict by their format string for reference
1408
during branch opening. Its not required that these be instances, they
1409
can be classes themselves with class methods - it simply depends on
1410
whether state is needed for a given format or not.
1412
Once a format is deprecated, just deprecate the initialize and open
1413
methods on the format class. Do not deprecate the object, as the
1414
object will be created every time regardless.
1417
_default_format = None
1418
"""The default format used for new branches."""
1421
"""The known formats."""
1423
can_set_append_revisions_only = True
1425
def __eq__(self, other):
1426
return self.__class__ is other.__class__
1428
def __ne__(self, other):
1429
return not (self == other)
1432
def find_format(klass, a_bzrdir):
1433
"""Return the format for the branch object in a_bzrdir."""
1435
transport = a_bzrdir.get_branch_transport(None)
1436
format_string = transport.get_bytes("format")
1437
return klass._formats[format_string]
1438
except errors.NoSuchFile:
1439
raise errors.NotBranchError(path=transport.base)
1441
raise errors.UnknownFormatError(format=format_string, kind='branch')
1444
def get_default_format(klass):
1445
"""Return the current default format."""
1446
return klass._default_format
1448
def get_reference(self, a_bzrdir):
1449
"""Get the target reference of the branch in a_bzrdir.
1451
format probing must have been completed before calling
1452
this method - it is assumed that the format of the branch
1453
in a_bzrdir is correct.
1455
:param a_bzrdir: The bzrdir to get the branch data from.
1456
:return: None if the branch is not a reference branch.
1461
def set_reference(self, a_bzrdir, to_branch):
1462
"""Set the target reference of the branch in a_bzrdir.
1464
format probing must have been completed before calling
1465
this method - it is assumed that the format of the branch
1466
in a_bzrdir is correct.
1468
:param a_bzrdir: The bzrdir to set the branch reference for.
1469
:param to_branch: branch that the checkout is to reference
1471
raise NotImplementedError(self.set_reference)
1473
def get_format_string(self):
1474
"""Return the ASCII format string that identifies this format."""
1475
raise NotImplementedError(self.get_format_string)
1477
def get_format_description(self):
1478
"""Return the short format description for this format."""
1479
raise NotImplementedError(self.get_format_description)
1481
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
1483
"""Initialize a branch in a bzrdir, with specified files
1485
:param a_bzrdir: The bzrdir to initialize the branch in
1486
:param utf8_files: The files to create as a list of
1487
(filename, content) tuples
1488
:param set_format: If True, set the format with
1489
self.get_format_string. (BzrBranch4 has its format set
1491
:return: a branch in this format
1493
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1494
branch_transport = a_bzrdir.get_branch_transport(self)
1496
'metadir': ('lock', lockdir.LockDir),
1497
'branch4': ('branch-lock', lockable_files.TransportLock),
1499
lock_name, lock_class = lock_map[lock_type]
1500
control_files = lockable_files.LockableFiles(branch_transport,
1501
lock_name, lock_class)
1502
control_files.create_lock()
1504
control_files.lock_write()
1505
except errors.LockContention:
1506
if lock_type != 'branch4':
1512
utf8_files += [('format', self.get_format_string())]
1514
for (filename, content) in utf8_files:
1515
branch_transport.put_bytes(
1517
mode=a_bzrdir._get_file_mode())
1520
control_files.unlock()
1521
return self.open(a_bzrdir, _found=True)
1523
def initialize(self, a_bzrdir):
1524
"""Create a branch of this format in a_bzrdir."""
1525
raise NotImplementedError(self.initialize)
1527
def is_supported(self):
1528
"""Is this format supported?
1530
Supported formats can be initialized and opened.
1531
Unsupported formats may not support initialization or committing or
1532
some other features depending on the reason for not being supported.
1536
def make_tags(self, branch):
1537
"""Create a tags object for branch.
1539
This method is on BranchFormat, because BranchFormats are reflected
1540
over the wire via network_name(), whereas full Branch instances require
1541
multiple VFS method calls to operate at all.
1543
The default implementation returns a disabled-tags instance.
1545
Note that it is normal for branch to be a RemoteBranch when using tags
1548
return DisabledTags(branch)
1550
def network_name(self):
1551
"""A simple byte string uniquely identifying this format for RPC calls.
1553
MetaDir branch formats use their disk format string to identify the
1554
repository over the wire. All in one formats such as bzr < 0.8, and
1555
foreign formats like svn/git and hg should use some marker which is
1556
unique and immutable.
1558
raise NotImplementedError(self.network_name)
1560
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1561
"""Return the branch object for a_bzrdir
1563
:param a_bzrdir: A BzrDir that contains a branch.
1564
:param _found: a private parameter, do not use it. It is used to
1565
indicate if format probing has already be done.
1566
:param ignore_fallbacks: when set, no fallback branches will be opened
1567
(if there are any). Default is to open fallbacks.
1569
raise NotImplementedError(self.open)
1572
def register_format(klass, format):
1573
"""Register a metadir format."""
1574
klass._formats[format.get_format_string()] = format
1575
# Metadir formats have a network name of their format string, and get
1576
# registered as class factories.
1577
network_format_registry.register(format.get_format_string(), format.__class__)
1580
def set_default_format(klass, format):
1581
klass._default_format = format
1583
def supports_set_append_revisions_only(self):
1584
"""True if this format supports set_append_revisions_only."""
1587
def supports_stacking(self):
1588
"""True if this format records a stacked-on branch."""
1592
def unregister_format(klass, format):
1593
del klass._formats[format.get_format_string()]
1596
return self.get_format_description().rstrip()
1598
def supports_tags(self):
1599
"""True if this format supports tags stored in the branch"""
1600
return False # by default
1603
class BranchHooks(Hooks):
1604
"""A dictionary mapping hook name to a list of callables for branch hooks.
1606
e.g. ['set_rh'] Is the list of items to be called when the
1607
set_revision_history function is invoked.
1611
"""Create the default hooks.
1613
These are all empty initially, because by default nothing should get
1616
Hooks.__init__(self)
1617
self.create_hook(HookPoint('set_rh',
1618
"Invoked whenever the revision history has been set via "
1619
"set_revision_history. The api signature is (branch, "
1620
"revision_history), and the branch will be write-locked. "
1621
"The set_rh hook can be expensive for bzr to trigger, a better "
1622
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1623
self.create_hook(HookPoint('open',
1624
"Called with the Branch object that has been opened after a "
1625
"branch is opened.", (1, 8), None))
1626
self.create_hook(HookPoint('post_push',
1627
"Called after a push operation completes. post_push is called "
1628
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1629
"bzr client.", (0, 15), None))
1630
self.create_hook(HookPoint('post_pull',
1631
"Called after a pull operation completes. post_pull is called "
1632
"with a bzrlib.branch.PullResult object and only runs in the "
1633
"bzr client.", (0, 15), None))
1634
self.create_hook(HookPoint('pre_commit',
1635
"Called after a commit is calculated but before it is is "
1636
"completed. pre_commit is called with (local, master, old_revno, "
1637
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1638
"). old_revid is NULL_REVISION for the first commit to a branch, "
1639
"tree_delta is a TreeDelta object describing changes from the "
1640
"basis revision. hooks MUST NOT modify this delta. "
1641
" future_tree is an in-memory tree obtained from "
1642
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1643
"tree.", (0,91), None))
1644
self.create_hook(HookPoint('post_commit',
1645
"Called in the bzr client after a commit has completed. "
1646
"post_commit is called with (local, master, old_revno, old_revid, "
1647
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1648
"commit to a branch.", (0, 15), None))
1649
self.create_hook(HookPoint('post_uncommit',
1650
"Called in the bzr client after an uncommit completes. "
1651
"post_uncommit is called with (local, master, old_revno, "
1652
"old_revid, new_revno, new_revid) where local is the local branch "
1653
"or None, master is the target branch, and an empty branch "
1654
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1655
self.create_hook(HookPoint('pre_change_branch_tip',
1656
"Called in bzr client and server before a change to the tip of a "
1657
"branch is made. pre_change_branch_tip is called with a "
1658
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1659
"commit, uncommit will all trigger this hook.", (1, 6), None))
1660
self.create_hook(HookPoint('post_change_branch_tip',
1661
"Called in bzr client and server after a change to the tip of a "
1662
"branch is made. post_change_branch_tip is called with a "
1663
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1664
"commit, uncommit will all trigger this hook.", (1, 4), None))
1665
self.create_hook(HookPoint('transform_fallback_location',
1666
"Called when a stacked branch is activating its fallback "
1667
"locations. transform_fallback_location is called with (branch, "
1668
"url), and should return a new url. Returning the same url "
1669
"allows it to be used as-is, returning a different one can be "
1670
"used to cause the branch to stack on a closer copy of that "
1671
"fallback_location. Note that the branch cannot have history "
1672
"accessing methods called on it during this hook because the "
1673
"fallback locations have not been activated. When there are "
1674
"multiple hooks installed for transform_fallback_location, "
1675
"all are called with the url returned from the previous hook."
1676
"The order is however undefined.", (1, 9), None))
1679
# install the default hooks into the Branch class.
1680
Branch.hooks = BranchHooks()
1683
class ChangeBranchTipParams(object):
1684
"""Object holding parameters passed to *_change_branch_tip hooks.
1686
There are 5 fields that hooks may wish to access:
1688
:ivar branch: the branch being changed
1689
:ivar old_revno: revision number before the change
1690
:ivar new_revno: revision number after the change
1691
:ivar old_revid: revision id before the change
1692
:ivar new_revid: revision id after the change
1694
The revid fields are strings. The revno fields are integers.
1697
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1698
"""Create a group of ChangeBranchTip parameters.
1700
:param branch: The branch being changed.
1701
:param old_revno: Revision number before the change.
1702
:param new_revno: Revision number after the change.
1703
:param old_revid: Tip revision id before the change.
1704
:param new_revid: Tip revision id after the change.
1706
self.branch = branch
1707
self.old_revno = old_revno
1708
self.new_revno = new_revno
1709
self.old_revid = old_revid
1710
self.new_revid = new_revid
1712
def __eq__(self, other):
1713
return self.__dict__ == other.__dict__
1716
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1717
self.__class__.__name__, self.branch,
1718
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1721
class BzrBranchFormat4(BranchFormat):
1722
"""Bzr branch format 4.
1725
- a revision-history file.
1726
- a branch-lock lock file [ to be shared with the bzrdir ]
1729
def get_format_description(self):
1730
"""See BranchFormat.get_format_description()."""
1731
return "Branch format 4"
1733
def initialize(self, a_bzrdir):
1734
"""Create a branch of this format in a_bzrdir."""
1735
utf8_files = [('revision-history', ''),
1736
('branch-name', ''),
1738
return self._initialize_helper(a_bzrdir, utf8_files,
1739
lock_type='branch4', set_format=False)
1742
super(BzrBranchFormat4, self).__init__()
1743
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1745
def network_name(self):
1746
"""The network name for this format is the control dirs disk label."""
1747
return self._matchingbzrdir.get_format_string()
1749
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1750
"""See BranchFormat.open()."""
1752
# we are being called directly and must probe.
1753
raise NotImplementedError
1754
return BzrBranch(_format=self,
1755
_control_files=a_bzrdir._control_files,
1757
_repository=a_bzrdir.open_repository())
1760
return "Bazaar-NG branch format 4"
1763
class BranchFormatMetadir(BranchFormat):
1764
"""Common logic for meta-dir based branch formats."""
1766
def _branch_class(self):
1767
"""What class to instantiate on open calls."""
1768
raise NotImplementedError(self._branch_class)
1770
def network_name(self):
1771
"""A simple byte string uniquely identifying this format for RPC calls.
1773
Metadir branch formats use their format string.
1775
return self.get_format_string()
1777
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1778
"""See BranchFormat.open()."""
1780
format = BranchFormat.find_format(a_bzrdir)
1781
if format.__class__ != self.__class__:
1782
raise AssertionError("wrong format %r found for %r" %
1785
transport = a_bzrdir.get_branch_transport(None)
1786
control_files = lockable_files.LockableFiles(transport, 'lock',
1788
return self._branch_class()(_format=self,
1789
_control_files=control_files,
1791
_repository=a_bzrdir.find_repository(),
1792
ignore_fallbacks=ignore_fallbacks)
1793
except errors.NoSuchFile:
1794
raise errors.NotBranchError(path=transport.base)
1797
super(BranchFormatMetadir, self).__init__()
1798
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1799
self._matchingbzrdir.set_branch_format(self)
1801
def supports_tags(self):
1805
class BzrBranchFormat5(BranchFormatMetadir):
1806
"""Bzr branch format 5.
1809
- a revision-history file.
1811
- a lock dir guarding the branch itself
1812
- all of this stored in a branch/ subdirectory
1813
- works with shared repositories.
1815
This format is new in bzr 0.8.
1818
def _branch_class(self):
1821
def get_format_string(self):
1822
"""See BranchFormat.get_format_string()."""
1823
return "Bazaar-NG branch format 5\n"
1825
def get_format_description(self):
1826
"""See BranchFormat.get_format_description()."""
1827
return "Branch format 5"
1829
def initialize(self, a_bzrdir):
1830
"""Create a branch of this format in a_bzrdir."""
1831
utf8_files = [('revision-history', ''),
1832
('branch-name', ''),
1834
return self._initialize_helper(a_bzrdir, utf8_files)
1836
def supports_tags(self):
1840
class BzrBranchFormat6(BranchFormatMetadir):
1841
"""Branch format with last-revision and tags.
1843
Unlike previous formats, this has no explicit revision history. Instead,
1844
this just stores the last-revision, and the left-hand history leading
1845
up to there is the history.
1847
This format was introduced in bzr 0.15
1848
and became the default in 0.91.
1851
def _branch_class(self):
1854
def get_format_string(self):
1855
"""See BranchFormat.get_format_string()."""
1856
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1858
def get_format_description(self):
1859
"""See BranchFormat.get_format_description()."""
1860
return "Branch format 6"
1862
def initialize(self, a_bzrdir):
1863
"""Create a branch of this format in a_bzrdir."""
1864
utf8_files = [('last-revision', '0 null:\n'),
1865
('branch.conf', ''),
1868
return self._initialize_helper(a_bzrdir, utf8_files)
1870
def make_tags(self, branch):
1871
"""See bzrlib.branch.BranchFormat.make_tags()."""
1872
return BasicTags(branch)
1874
def supports_set_append_revisions_only(self):
1878
class BzrBranchFormat8(BranchFormatMetadir):
1879
"""Metadir format supporting storing locations of subtree branches."""
1881
def _branch_class(self):
1884
def get_format_string(self):
1885
"""See BranchFormat.get_format_string()."""
1886
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
1888
def get_format_description(self):
1889
"""See BranchFormat.get_format_description()."""
1890
return "Branch format 8"
1892
def initialize(self, a_bzrdir):
1893
"""Create a branch of this format in a_bzrdir."""
1894
utf8_files = [('last-revision', '0 null:\n'),
1895
('branch.conf', ''),
1899
return self._initialize_helper(a_bzrdir, utf8_files)
1902
super(BzrBranchFormat8, self).__init__()
1903
self._matchingbzrdir.repository_format = \
1904
RepositoryFormatKnitPack5RichRoot()
1906
def make_tags(self, branch):
1907
"""See bzrlib.branch.BranchFormat.make_tags()."""
1908
return BasicTags(branch)
1910
def supports_set_append_revisions_only(self):
1913
def supports_stacking(self):
1916
supports_reference_locations = True
1919
class BzrBranchFormat7(BzrBranchFormat8):
1920
"""Branch format with last-revision, tags, and a stacked location pointer.
1922
The stacked location pointer is passed down to the repository and requires
1923
a repository format with supports_external_lookups = True.
1925
This format was introduced in bzr 1.6.
1928
def initialize(self, a_bzrdir):
1929
"""Create a branch of this format in a_bzrdir."""
1930
utf8_files = [('last-revision', '0 null:\n'),
1931
('branch.conf', ''),
1934
return self._initialize_helper(a_bzrdir, utf8_files)
1936
def _branch_class(self):
1939
def get_format_string(self):
1940
"""See BranchFormat.get_format_string()."""
1941
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
1943
def get_format_description(self):
1944
"""See BranchFormat.get_format_description()."""
1945
return "Branch format 7"
1947
def supports_set_append_revisions_only(self):
1950
supports_reference_locations = False
1953
class BranchReferenceFormat(BranchFormat):
1954
"""Bzr branch reference format.
1956
Branch references are used in implementing checkouts, they
1957
act as an alias to the real branch which is at some other url.
1964
def get_format_string(self):
1965
"""See BranchFormat.get_format_string()."""
1966
return "Bazaar-NG Branch Reference Format 1\n"
1968
def get_format_description(self):
1969
"""See BranchFormat.get_format_description()."""
1970
return "Checkout reference format 1"
1972
def get_reference(self, a_bzrdir):
1973
"""See BranchFormat.get_reference()."""
1974
transport = a_bzrdir.get_branch_transport(None)
1975
return transport.get_bytes('location')
1977
def set_reference(self, a_bzrdir, to_branch):
1978
"""See BranchFormat.set_reference()."""
1979
transport = a_bzrdir.get_branch_transport(None)
1980
location = transport.put_bytes('location', to_branch.base)
1982
def initialize(self, a_bzrdir, target_branch=None):
1983
"""Create a branch of this format in a_bzrdir."""
1984
if target_branch is None:
1985
# this format does not implement branch itself, thus the implicit
1986
# creation contract must see it as uninitializable
1987
raise errors.UninitializableFormat(self)
1988
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1989
branch_transport = a_bzrdir.get_branch_transport(self)
1990
branch_transport.put_bytes('location',
1991
target_branch.bzrdir.root_transport.base)
1992
branch_transport.put_bytes('format', self.get_format_string())
1994
a_bzrdir, _found=True,
1995
possible_transports=[target_branch.bzrdir.root_transport])
1998
super(BranchReferenceFormat, self).__init__()
1999
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2000
self._matchingbzrdir.set_branch_format(self)
2002
def _make_reference_clone_function(format, a_branch):
2003
"""Create a clone() routine for a branch dynamically."""
2004
def clone(to_bzrdir, revision_id=None,
2005
repository_policy=None):
2006
"""See Branch.clone()."""
2007
return format.initialize(to_bzrdir, a_branch)
2008
# cannot obey revision_id limits when cloning a reference ...
2009
# FIXME RBC 20060210 either nuke revision_id for clone, or
2010
# emit some sort of warning/error to the caller ?!
2013
def open(self, a_bzrdir, _found=False, location=None,
2014
possible_transports=None, ignore_fallbacks=False):
2015
"""Return the branch that the branch reference in a_bzrdir points at.
2017
:param a_bzrdir: A BzrDir that contains a branch.
2018
:param _found: a private parameter, do not use it. It is used to
2019
indicate if format probing has already be done.
2020
:param ignore_fallbacks: when set, no fallback branches will be opened
2021
(if there are any). Default is to open fallbacks.
2022
:param location: The location of the referenced branch. If
2023
unspecified, this will be determined from the branch reference in
2025
:param possible_transports: An optional reusable transports list.
2028
format = BranchFormat.find_format(a_bzrdir)
2029
if format.__class__ != self.__class__:
2030
raise AssertionError("wrong format %r found for %r" %
2032
if location is None:
2033
location = self.get_reference(a_bzrdir)
2034
real_bzrdir = bzrdir.BzrDir.open(
2035
location, possible_transports=possible_transports)
2036
result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
2037
# this changes the behaviour of result.clone to create a new reference
2038
# rather than a copy of the content of the branch.
2039
# I did not use a proxy object because that needs much more extensive
2040
# testing, and we are only changing one behaviour at the moment.
2041
# If we decide to alter more behaviours - i.e. the implicit nickname
2042
# then this should be refactored to introduce a tested proxy branch
2043
# and a subclass of that for use in overriding clone() and ....
2045
result.clone = self._make_reference_clone_function(result)
2049
network_format_registry = registry.FormatRegistry()
2050
"""Registry of formats indexed by their network name.
2052
The network name for a branch format is an identifier that can be used when
2053
referring to formats with smart server operations. See
2054
BranchFormat.network_name() for more detail.
2058
# formats which have no format string are not discoverable
2059
# and not independently creatable, so are not registered.
2060
__format5 = BzrBranchFormat5()
2061
__format6 = BzrBranchFormat6()
2062
__format7 = BzrBranchFormat7()
2063
__format8 = BzrBranchFormat8()
2064
BranchFormat.register_format(__format5)
2065
BranchFormat.register_format(BranchReferenceFormat())
2066
BranchFormat.register_format(__format6)
2067
BranchFormat.register_format(__format7)
2068
BranchFormat.register_format(__format8)
2069
BranchFormat.set_default_format(__format7)
2070
_legacy_formats = [BzrBranchFormat4(),
2072
network_format_registry.register(
2073
_legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2076
class BzrBranch(Branch, _RelockDebugMixin):
2077
"""A branch stored in the actual filesystem.
2079
Note that it's "local" in the context of the filesystem; it doesn't
2080
really matter if it's on an nfs/smb/afs/coda/... share, as long as
2081
it's writable, and can be accessed via the normal filesystem API.
2083
:ivar _transport: Transport for file operations on this branch's
2084
control files, typically pointing to the .bzr/branch directory.
2085
:ivar repository: Repository for this branch.
2086
:ivar base: The url of the base directory for this branch; the one
2087
containing the .bzr directory.
2090
def __init__(self, _format=None,
2091
_control_files=None, a_bzrdir=None, _repository=None,
2092
ignore_fallbacks=False):
2093
"""Create new branch object at a particular location."""
2094
if a_bzrdir is None:
2095
raise ValueError('a_bzrdir must be supplied')
2097
self.bzrdir = a_bzrdir
2098
self._base = self.bzrdir.transport.clone('..').base
2099
# XXX: We should be able to just do
2100
# self.base = self.bzrdir.root_transport.base
2101
# but this does not quite work yet -- mbp 20080522
2102
self._format = _format
2103
if _control_files is None:
2104
raise ValueError('BzrBranch _control_files is None')
2105
self.control_files = _control_files
2106
self._transport = _control_files._transport
2107
self.repository = _repository
2108
Branch.__init__(self)
2111
return '%s(%r)' % (self.__class__.__name__, self.base)
2115
def _get_base(self):
2116
"""Returns the directory containing the control directory."""
2119
base = property(_get_base, doc="The URL for the root of this branch.")
2121
def _get_config(self):
2122
return TransportConfig(self._transport, 'branch.conf')
2124
def is_locked(self):
2125
return self.control_files.is_locked()
2127
def lock_write(self, token=None):
2128
if not self.is_locked():
2129
self._note_lock('w')
2130
# All-in-one needs to always unlock/lock.
2131
repo_control = getattr(self.repository, 'control_files', None)
2132
if self.control_files == repo_control or not self.is_locked():
2133
self.repository.lock_write()
2138
return self.control_files.lock_write(token=token)
2141
self.repository.unlock()
2144
def lock_read(self):
2145
if not self.is_locked():
2146
self._note_lock('r')
2147
# All-in-one needs to always unlock/lock.
2148
repo_control = getattr(self.repository, 'control_files', None)
2149
if self.control_files == repo_control or not self.is_locked():
2150
self.repository.lock_read()
2155
self.control_files.lock_read()
2158
self.repository.unlock()
2161
@only_raises(errors.LockNotHeld, errors.LockBroken)
2164
self.control_files.unlock()
2166
# All-in-one needs to always unlock/lock.
2167
repo_control = getattr(self.repository, 'control_files', None)
2168
if (self.control_files == repo_control or
2169
not self.control_files.is_locked()):
2170
self.repository.unlock()
2171
if not self.control_files.is_locked():
2172
# we just released the lock
2173
self._clear_cached_state()
2175
def peek_lock_mode(self):
2176
if self.control_files._lock_count == 0:
2179
return self.control_files._lock_mode
2181
def get_physical_lock_status(self):
2182
return self.control_files.get_physical_lock_status()
2185
def print_file(self, file, revision_id):
2186
"""See Branch.print_file."""
2187
return self.repository.print_file(file, revision_id)
2189
def _write_revision_history(self, history):
2190
"""Factored out of set_revision_history.
2192
This performs the actual writing to disk.
2193
It is intended to be called by BzrBranch5.set_revision_history."""
2194
self._transport.put_bytes(
2195
'revision-history', '\n'.join(history),
2196
mode=self.bzrdir._get_file_mode())
2199
def set_revision_history(self, rev_history):
2200
"""See Branch.set_revision_history."""
2201
if 'evil' in debug.debug_flags:
2202
mutter_callsite(3, "set_revision_history scales with history.")
2203
check_not_reserved_id = _mod_revision.check_not_reserved_id
2204
for rev_id in rev_history:
2205
check_not_reserved_id(rev_id)
2206
if Branch.hooks['post_change_branch_tip']:
2207
# Don't calculate the last_revision_info() if there are no hooks
2209
old_revno, old_revid = self.last_revision_info()
2210
if len(rev_history) == 0:
2211
revid = _mod_revision.NULL_REVISION
2213
revid = rev_history[-1]
2214
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2215
self._write_revision_history(rev_history)
2216
self._clear_cached_state()
2217
self._cache_revision_history(rev_history)
2218
for hook in Branch.hooks['set_rh']:
2219
hook(self, rev_history)
2220
if Branch.hooks['post_change_branch_tip']:
2221
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2223
def _synchronize_history(self, destination, revision_id):
2224
"""Synchronize last revision and revision history between branches.
2226
This version is most efficient when the destination is also a
2227
BzrBranch5, but works for BzrBranch6 as long as the revision
2228
history is the true lefthand parent history, and all of the revisions
2229
are in the destination's repository. If not, set_revision_history
2232
:param destination: The branch to copy the history into
2233
:param revision_id: The revision-id to truncate history at. May
2234
be None to copy complete history.
2236
if not isinstance(destination._format, BzrBranchFormat5):
2237
super(BzrBranch, self)._synchronize_history(
2238
destination, revision_id)
2240
if revision_id == _mod_revision.NULL_REVISION:
2243
new_history = self.revision_history()
2244
if revision_id is not None and new_history != []:
2246
new_history = new_history[:new_history.index(revision_id) + 1]
2248
rev = self.repository.get_revision(revision_id)
2249
new_history = rev.get_history(self.repository)[1:]
2250
destination.set_revision_history(new_history)
2253
def set_last_revision_info(self, revno, revision_id):
2254
"""Set the last revision of this branch.
2256
The caller is responsible for checking that the revno is correct
2257
for this revision id.
2259
It may be possible to set the branch last revision to an id not
2260
present in the repository. However, branches can also be
2261
configured to check constraints on history, in which case this may not
2264
revision_id = _mod_revision.ensure_null(revision_id)
2265
# this old format stores the full history, but this api doesn't
2266
# provide it, so we must generate, and might as well check it's
2268
history = self._lefthand_history(revision_id)
2269
if len(history) != revno:
2270
raise AssertionError('%d != %d' % (len(history), revno))
2271
self.set_revision_history(history)
2273
def _gen_revision_history(self):
2274
history = self._transport.get_bytes('revision-history').split('\n')
2275
if history[-1:] == ['']:
2276
# There shouldn't be a trailing newline, but just in case.
2281
def generate_revision_history(self, revision_id, last_rev=None,
2283
"""Create a new revision history that will finish with revision_id.
2285
:param revision_id: the new tip to use.
2286
:param last_rev: The previous last_revision. If not None, then this
2287
must be a ancestory of revision_id, or DivergedBranches is raised.
2288
:param other_branch: The other branch that DivergedBranches should
2289
raise with respect to.
2291
self.set_revision_history(self._lefthand_history(revision_id,
2292
last_rev, other_branch))
2294
def basis_tree(self):
2295
"""See Branch.basis_tree."""
2296
return self.repository.revision_tree(self.last_revision())
2298
def _get_parent_location(self):
2299
_locs = ['parent', 'pull', 'x-pull']
2302
return self._transport.get_bytes(l).strip('\n')
2303
except errors.NoSuchFile:
2307
def _basic_push(self, target, overwrite, stop_revision):
2308
"""Basic implementation of push without bound branches or hooks.
2310
Must be called with source read locked and target write locked.
2312
result = BranchPushResult()
2313
result.source_branch = self
2314
result.target_branch = target
2315
result.old_revno, result.old_revid = target.last_revision_info()
2316
self.update_references(target)
2317
if result.old_revid != self.last_revision():
2318
# We assume that during 'push' this repository is closer than
2320
graph = self.repository.get_graph(target.repository)
2321
target.update_revisions(self, stop_revision,
2322
overwrite=overwrite, graph=graph)
2323
if self._push_should_merge_tags():
2324
result.tag_conflicts = self.tags.merge_to(target.tags,
2326
result.new_revno, result.new_revid = target.last_revision_info()
2329
def get_stacked_on_url(self):
2330
raise errors.UnstackableBranchFormat(self._format, self.base)
2332
def set_push_location(self, location):
2333
"""See Branch.set_push_location."""
2334
self.get_config().set_user_option(
2335
'push_location', location,
2336
store=_mod_config.STORE_LOCATION_NORECURSE)
2338
def _set_parent_location(self, url):
2340
self._transport.delete('parent')
2342
self._transport.put_bytes('parent', url + '\n',
2343
mode=self.bzrdir._get_file_mode())
2346
class BzrBranch5(BzrBranch):
2347
"""A format 5 branch. This supports new features over plain branches.
2349
It has support for a master_branch which is the data for bound branches.
2352
def get_bound_location(self):
2354
return self._transport.get_bytes('bound')[:-1]
2355
except errors.NoSuchFile:
2359
def get_master_branch(self, possible_transports=None):
2360
"""Return the branch we are bound to.
2362
:return: Either a Branch, or None
2364
This could memoise the branch, but if thats done
2365
it must be revalidated on each new lock.
2366
So for now we just don't memoise it.
2367
# RBC 20060304 review this decision.
2369
bound_loc = self.get_bound_location()
2373
return Branch.open(bound_loc,
2374
possible_transports=possible_transports)
2375
except (errors.NotBranchError, errors.ConnectionError), e:
2376
raise errors.BoundBranchConnectionFailure(
2380
def set_bound_location(self, location):
2381
"""Set the target where this branch is bound to.
2383
:param location: URL to the target branch
2386
self._transport.put_bytes('bound', location+'\n',
2387
mode=self.bzrdir._get_file_mode())
2390
self._transport.delete('bound')
2391
except errors.NoSuchFile:
2396
def bind(self, other):
2397
"""Bind this branch to the branch other.
2399
This does not push or pull data between the branches, though it does
2400
check for divergence to raise an error when the branches are not
2401
either the same, or one a prefix of the other. That behaviour may not
2402
be useful, so that check may be removed in future.
2404
:param other: The branch to bind to
2407
# TODO: jam 20051230 Consider checking if the target is bound
2408
# It is debatable whether you should be able to bind to
2409
# a branch which is itself bound.
2410
# Committing is obviously forbidden,
2411
# but binding itself may not be.
2412
# Since we *have* to check at commit time, we don't
2413
# *need* to check here
2415
# we want to raise diverged if:
2416
# last_rev is not in the other_last_rev history, AND
2417
# other_last_rev is not in our history, and do it without pulling
2419
self.set_bound_location(other.base)
2423
"""If bound, unbind"""
2424
return self.set_bound_location(None)
2427
def update(self, possible_transports=None):
2428
"""Synchronise this branch with the master branch if any.
2430
:return: None or the last_revision that was pivoted out during the
2433
master = self.get_master_branch(possible_transports)
2434
if master is not None:
2435
old_tip = _mod_revision.ensure_null(self.last_revision())
2436
self.pull(master, overwrite=True)
2437
if self.repository.get_graph().is_ancestor(old_tip,
2438
_mod_revision.ensure_null(self.last_revision())):
2444
class BzrBranch8(BzrBranch5):
2445
"""A branch that stores tree-reference locations."""
2447
def _open_hook(self):
2448
if self._ignore_fallbacks:
2451
url = self.get_stacked_on_url()
2452
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2453
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:
2456
for hook in Branch.hooks['transform_fallback_location']:
2457
url = hook(self, url)
2459
hook_name = Branch.hooks.get_hook_name(hook)
2460
raise AssertionError(
2461
"'transform_fallback_location' hook %s returned "
2462
"None, not a URL." % hook_name)
2463
self._activate_fallback_location(url)
2465
def __init__(self, *args, **kwargs):
2466
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2467
super(BzrBranch8, self).__init__(*args, **kwargs)
2468
self._last_revision_info_cache = None
2469
self._reference_info = None
2471
def _clear_cached_state(self):
2472
super(BzrBranch8, self)._clear_cached_state()
2473
self._last_revision_info_cache = None
2474
self._reference_info = None
2476
def _last_revision_info(self):
2477
revision_string = self._transport.get_bytes('last-revision')
2478
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2479
revision_id = cache_utf8.get_cached_utf8(revision_id)
2481
return revno, revision_id
2483
def _write_last_revision_info(self, revno, revision_id):
2484
"""Simply write out the revision id, with no checks.
2486
Use set_last_revision_info to perform this safely.
2488
Does not update the revision_history cache.
2489
Intended to be called by set_last_revision_info and
2490
_write_revision_history.
2492
revision_id = _mod_revision.ensure_null(revision_id)
2493
out_string = '%d %s\n' % (revno, revision_id)
2494
self._transport.put_bytes('last-revision', out_string,
2495
mode=self.bzrdir._get_file_mode())
2498
def set_last_revision_info(self, revno, revision_id):
2499
revision_id = _mod_revision.ensure_null(revision_id)
2500
old_revno, old_revid = self.last_revision_info()
2501
if self._get_append_revisions_only():
2502
self._check_history_violation(revision_id)
2503
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2504
self._write_last_revision_info(revno, revision_id)
2505
self._clear_cached_state()
2506
self._last_revision_info_cache = revno, revision_id
2507
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2509
def _synchronize_history(self, destination, revision_id):
2510
"""Synchronize last revision and revision history between branches.
2512
:see: Branch._synchronize_history
2514
# XXX: The base Branch has a fast implementation of this method based
2515
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2516
# that uses set_revision_history. This class inherits from BzrBranch5,
2517
# but wants the fast implementation, so it calls
2518
# Branch._synchronize_history directly.
2519
Branch._synchronize_history(self, destination, revision_id)
2521
def _check_history_violation(self, revision_id):
2522
last_revision = _mod_revision.ensure_null(self.last_revision())
2523
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
2525
if last_revision not in self._lefthand_history(revision_id):
2526
raise errors.AppendRevisionsOnlyViolation(self.base)
2528
def _gen_revision_history(self):
2529
"""Generate the revision history from last revision
2531
last_revno, last_revision = self.last_revision_info()
2532
self._extend_partial_history(stop_index=last_revno-1)
2533
return list(reversed(self._partial_revision_history_cache))
2535
def _write_revision_history(self, history):
2536
"""Factored out of set_revision_history.
2538
This performs the actual writing to disk, with format-specific checks.
2539
It is intended to be called by BzrBranch5.set_revision_history.
2541
if len(history) == 0:
2542
last_revision = 'null:'
2544
if history != self._lefthand_history(history[-1]):
2545
raise errors.NotLefthandHistory(history)
2546
last_revision = history[-1]
2547
if self._get_append_revisions_only():
2548
self._check_history_violation(last_revision)
2549
self._write_last_revision_info(len(history), last_revision)
2552
def _set_parent_location(self, url):
2553
"""Set the parent branch"""
2554
self._set_config_location('parent_location', url, make_relative=True)
2557
def _get_parent_location(self):
2558
"""Set the parent branch"""
2559
return self._get_config_location('parent_location')
2562
def _set_all_reference_info(self, info_dict):
2563
"""Replace all reference info stored in a branch.
2565
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2568
writer = rio.RioWriter(s)
2569
for key, (tree_path, branch_location) in info_dict.iteritems():
2570
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2571
branch_location=branch_location)
2572
writer.write_stanza(stanza)
2573
self._transport.put_bytes('references', s.getvalue())
2574
self._reference_info = info_dict
2577
def _get_all_reference_info(self):
2578
"""Return all the reference info stored in a branch.
2580
:return: A dict of {file_id: (tree_path, branch_location)}
2582
if self._reference_info is not None:
2583
return self._reference_info
2584
rio_file = self._transport.get('references')
1256
f = AtomicFile(self.controlfilename('pending-merges'))
2586
stanzas = rio.read_stanzas(rio_file)
2587
info_dict = dict((s['file_id'], (s['tree_path'],
2588
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()
2591
self._reference_info = info_dict
2594
def set_reference_info(self, file_id, tree_path, branch_location):
2595
"""Set the branch location to use for a tree reference.
2597
:param file_id: The file-id of the tree reference.
2598
:param tree_path: The path of the tree reference in the tree.
2599
:param branch_location: The location of the branch to retrieve tree
2602
info_dict = self._get_all_reference_info()
2603
info_dict[file_id] = (tree_path, branch_location)
2604
if None in (tree_path, branch_location):
2605
if tree_path is not None:
2606
raise ValueError('tree_path must be None when branch_location'
2608
if branch_location is not None:
2609
raise ValueError('branch_location must be None when tree_path'
2611
del info_dict[file_id]
2612
self._set_all_reference_info(info_dict)
2614
def get_reference_info(self, file_id):
2615
"""Get the tree_path and branch_location for a tree reference.
2617
:return: a tuple of (tree_path, branch_location)
2619
return self._get_all_reference_info().get(file_id, (None, None))
2621
def reference_parent(self, file_id, path, possible_transports=None):
2622
"""Return the parent branch for a tree-reference file_id.
2624
:param file_id: The file_id of the tree reference
2625
:param path: The path of the file_id in the tree
2626
:return: A branch associated with the file_id
2628
branch_location = self.get_reference_info(file_id)[1]
2629
if branch_location is None:
2630
return Branch.reference_parent(self, file_id, path,
2631
possible_transports)
2632
branch_location = urlutils.join(self.base, branch_location)
2633
return Branch.open(branch_location,
2634
possible_transports=possible_transports)
2636
def set_push_location(self, location):
2637
"""See Branch.set_push_location."""
2638
self._set_config_location('push_location', location)
2640
def set_bound_location(self, location):
2641
"""See Branch.set_push_location."""
2643
config = self.get_config()
2644
if location is None:
2645
if config.get_user_option('bound') != 'True':
2648
config.set_user_option('bound', 'False', warn_masked=True)
2651
self._set_config_location('bound_location', location,
2653
config.set_user_option('bound', 'True', warn_masked=True)
2656
def _get_bound_location(self, bound):
2657
"""Return the bound location in the config file.
2659
Return None if the bound parameter does not match"""
2660
config = self.get_config()
2661
config_bound = (config.get_user_option('bound') == 'True')
2662
if config_bound != bound:
2664
return self._get_config_location('bound_location', config=config)
2666
def get_bound_location(self):
2667
"""See Branch.set_push_location."""
2668
return self._get_bound_location(True)
2670
def get_old_bound_location(self):
2671
"""See Branch.get_old_bound_location"""
2672
return self._get_bound_location(False)
2674
def get_stacked_on_url(self):
2675
# you can always ask for the URL; but you might not be able to use it
2676
# if the repo can't support stacking.
2677
## self._check_stackable_repo()
2678
stacked_url = self._get_config_location('stacked_on_location')
2679
if stacked_url is None:
2680
raise errors.NotStacked(self)
2683
def _get_append_revisions_only(self):
2684
value = self.get_config().get_user_option('append_revisions_only')
2685
return value == 'True'
2688
def generate_revision_history(self, revision_id, last_rev=None,
2690
"""See BzrBranch5.generate_revision_history"""
2691
history = self._lefthand_history(revision_id, last_rev, other_branch)
2692
revno = len(history)
2693
self.set_last_revision_info(revno, revision_id)
2696
def get_rev_id(self, revno, history=None):
2697
"""Find the revision id of the specified revno."""
2699
return _mod_revision.NULL_REVISION
2701
last_revno, last_revision_id = self.last_revision_info()
2702
if revno <= 0 or revno > last_revno:
2703
raise errors.NoSuchRevision(self, revno)
2705
if history is not None:
2706
return history[revno - 1]
2708
index = last_revno - revno
2709
if len(self._partial_revision_history_cache) <= index:
2710
self._extend_partial_history(stop_index=index)
2711
if len(self._partial_revision_history_cache) > index:
2712
return self._partial_revision_history_cache[index]
2714
raise errors.NoSuchRevision(self, revno)
2717
def revision_id_to_revno(self, revision_id):
2718
"""Given a revision id, return its revno"""
2719
if _mod_revision.is_null(revision_id):
2722
index = self._partial_revision_history_cache.index(revision_id)
2724
self._extend_partial_history(stop_revision=revision_id)
2725
index = len(self._partial_revision_history_cache) - 1
2726
if self._partial_revision_history_cache[index] != revision_id:
2727
raise errors.NoSuchRevision(self, revision_id)
2728
return self.revno() - index
2731
class BzrBranch7(BzrBranch8):
2732
"""A branch with support for a fallback repository."""
2734
def set_reference_info(self, file_id, tree_path, branch_location):
2735
Branch.set_reference_info(self, file_id, tree_path, branch_location)
2737
def get_reference_info(self, file_id):
2738
Branch.get_reference_info(self, file_id)
2740
def reference_parent(self, file_id, path, possible_transports=None):
2741
return Branch.reference_parent(self, file_id, path,
2742
possible_transports)
2745
class BzrBranch6(BzrBranch7):
2746
"""See BzrBranchFormat6 for the capabilities of this branch.
2748
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)
2752
def get_stacked_on_url(self):
2753
raise errors.UnstackableBranchFormat(self._format, self.base)
1337
2756
######################################################################
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')
2757
# results of operations
2760
class _Result(object):
2762
def _show_tag_conficts(self, to_file):
2763
if not getattr(self, 'tag_conflicts', None):
2765
to_file.write('Conflicting tags:\n')
2766
for name, value1, value2 in self.tag_conflicts:
2767
to_file.write(' %s\n' % (name, ))
2770
class PullResult(_Result):
2771
"""Result of a Branch.pull operation.
2773
:ivar old_revno: Revision number before pull.
2774
:ivar new_revno: Revision number after pull.
2775
:ivar old_revid: Tip revision id before pull.
2776
:ivar new_revid: Tip revision id after pull.
2777
:ivar source_branch: Source (local) branch object. (read locked)
2778
:ivar master_branch: Master branch of the target, or the target if no
2780
:ivar local_branch: target branch if there is a Master, else None
2781
:ivar target_branch: Target/destination branch object. (write locked)
2782
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2786
# DEPRECATED: pull used to return the change in revno
2787
return self.new_revno - self.old_revno
2789
def report(self, to_file):
2791
if self.old_revid == self.new_revid:
2792
to_file.write('No revisions to pull.\n')
2794
to_file.write('Now on revision %d.\n' % self.new_revno)
2795
self._show_tag_conficts(to_file)
2798
class BranchPushResult(_Result):
2799
"""Result of a Branch.push operation.
2801
:ivar old_revno: Revision number (eg 10) of the target before push.
2802
:ivar new_revno: Revision number (eg 12) of the target after push.
2803
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
2805
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
2807
:ivar source_branch: Source branch object that the push was from. This is
2808
read locked, and generally is a local (and thus low latency) branch.
2809
:ivar master_branch: If target is a bound branch, the master branch of
2810
target, or target itself. Always write locked.
2811
:ivar target_branch: The direct Branch where data is being sent (write
2813
:ivar local_branch: If the target is a bound branch this will be the
2814
target, otherwise it will be None.
2818
# DEPRECATED: push used to return the change in revno
2819
return self.new_revno - self.old_revno
2821
def report(self, to_file):
2822
"""Write a human-readable description of the result."""
2823
if self.old_revid == self.new_revid:
2824
note('No new revisions to push.')
2826
note('Pushed up to revision %d.' % self.new_revno)
2827
self._show_tag_conficts(to_file)
2830
class BranchCheckResult(object):
2831
"""Results of checking branch consistency.
2836
def __init__(self, branch):
2837
self.branch = branch
2840
def report_results(self, verbose):
2841
"""Report the check results via trace.note.
2843
:param verbose: Requests more detailed display of what was checked,
2846
note('checked branch %s format %s', self.branch.base,
2847
self.branch._format)
2848
for error in self.errors:
2849
note('found error:%s', error)
2852
class Converter5to6(object):
2853
"""Perform an in-place upgrade of format 5 to format 6"""
2855
def convert(self, branch):
2856
# Data for 5 and 6 can peacefully coexist.
2857
format = BzrBranchFormat6()
2858
new_branch = format.open(branch.bzrdir, _found=True)
2860
# Copy source data into target
2861
new_branch._write_last_revision_info(*branch.last_revision_info())
2862
new_branch.set_parent(branch.get_parent())
2863
new_branch.set_bound_location(branch.get_bound_location())
2864
new_branch.set_push_location(branch.get_push_location())
2866
# New branch has no tags by default
2867
new_branch.tags._set_tag_dict({})
2869
# Copying done; now update target format
2870
new_branch._transport.put_bytes('format',
2871
format.get_format_string(),
2872
mode=new_branch.bzrdir._get_file_mode())
2874
# Clean up old files
2875
new_branch._transport.delete('revision-history')
2877
branch.set_parent(None)
2878
except errors.NoSuchFile:
2880
branch.set_bound_location(None)
2883
class Converter6to7(object):
2884
"""Perform an in-place upgrade of format 6 to format 7"""
2886
def convert(self, branch):
2887
format = BzrBranchFormat7()
2888
branch._set_config_location('stacked_on_location', '')
2889
# update target format
2890
branch._transport.put_bytes('format', format.get_format_string())
2893
class Converter7to8(object):
2894
"""Perform an in-place upgrade of format 6 to format 7"""
2896
def convert(self, branch):
2897
format = BzrBranchFormat8()
2898
branch._transport.put_bytes('references', '')
2899
# update target format
2900
branch._transport.put_bytes('format', format.get_format_string())
2903
def _run_with_write_locked_target(target, callable, *args, **kwargs):
2904
"""Run ``callable(*args, **kwargs)``, write-locking target for the
2907
_run_with_write_locked_target will attempt to release the lock it acquires.
2909
If an exception is raised by callable, then that exception *will* be
2910
propagated, even if the unlock attempt raises its own error. Thus
2911
_run_with_write_locked_target should be preferred to simply doing::
2915
return callable(*args, **kwargs)
2920
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
2921
# should share code?
2924
result = callable(*args, **kwargs)
2926
exc_info = sys.exc_info()
2930
raise exc_info[0], exc_info[1], exc_info[2]
2936
class InterBranch(InterObject):
2937
"""This class represents operations taking place between two branches.
2939
Its instances have methods like pull() and push() and contain
2940
references to the source and target repositories these operations
2941
can be carried out on.
2945
"""The available optimised InterBranch types."""
2948
def _get_branch_formats_to_test():
2949
"""Return a tuple with the Branch formats to use when testing."""
2950
raise NotImplementedError(InterBranch._get_branch_formats_to_test)
2952
def pull(self, overwrite=False, stop_revision=None,
2953
possible_transports=None, local=False):
2954
"""Mirror source into target branch.
2956
The target branch is considered to be 'local', having low latency.
2958
:returns: PullResult instance
2960
raise NotImplementedError(self.pull)
2962
def update_revisions(self, stop_revision=None, overwrite=False,
2964
"""Pull in new perfect-fit revisions.
2966
:param stop_revision: Updated until the given revision
2967
:param overwrite: Always set the branch pointer, rather than checking
2968
to see if it is a proper descendant.
2969
:param graph: A Graph object that can be used to query history
2970
information. This can be None.
2973
raise NotImplementedError(self.update_revisions)
2975
def push(self, overwrite=False, stop_revision=None,
2976
_override_hook_source_branch=None):
2977
"""Mirror the source branch into the target branch.
2979
The source branch is considered to be 'local', having low latency.
2981
raise NotImplementedError(self.push)
2984
class GenericInterBranch(InterBranch):
2985
"""InterBranch implementation that uses public Branch functions.
2989
def _get_branch_formats_to_test():
2990
return BranchFormat._default_format, BranchFormat._default_format
2992
def update_revisions(self, stop_revision=None, overwrite=False,
2994
"""See InterBranch.update_revisions()."""
2995
self.source.lock_read()
2997
other_revno, other_last_revision = self.source.last_revision_info()
2998
stop_revno = None # unknown
2999
if stop_revision is None:
3000
stop_revision = other_last_revision
3001
if _mod_revision.is_null(stop_revision):
3002
# if there are no commits, we're done.
3004
stop_revno = other_revno
3006
# what's the current last revision, before we fetch [and change it
3008
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3009
# we fetch here so that we don't process data twice in the common
3010
# case of having something to pull, and so that the check for
3011
# already merged can operate on the just fetched graph, which will
3012
# be cached in memory.
3013
self.target.fetch(self.source, stop_revision)
3014
# Check to see if one is an ancestor of the other
3017
graph = self.target.repository.get_graph()
3018
if self.target._check_if_descendant_or_diverged(
3019
stop_revision, last_rev, graph, self.source):
3020
# stop_revision is a descendant of last_rev, but we aren't
3021
# overwriting, so we're done.
3023
if stop_revno is None:
3025
graph = self.target.repository.get_graph()
3026
this_revno, this_last_revision = \
3027
self.target.last_revision_info()
3028
stop_revno = graph.find_distance_to_null(stop_revision,
3029
[(other_last_revision, other_revno),
3030
(this_last_revision, this_revno)])
3031
self.target.set_last_revision_info(stop_revno, stop_revision)
3033
self.source.unlock()
3035
def pull(self, overwrite=False, stop_revision=None,
3036
possible_transports=None, _hook_master=None, run_hooks=True,
3037
_override_hook_target=None, local=False):
3040
:param _hook_master: Private parameter - set the branch to
3041
be supplied as the master to pull hooks.
3042
:param run_hooks: Private parameter - if false, this branch
3043
is being called because it's the master of the primary branch,
3044
so it should not run its hooks.
3045
:param _override_hook_target: Private parameter - set the branch to be
3046
supplied as the target_branch to pull hooks.
3047
:param local: Only update the local branch, and not the bound branch.
3049
# This type of branch can't be bound.
3051
raise errors.LocalRequiresBoundBranch()
3052
result = PullResult()
3053
result.source_branch = self.source
3054
if _override_hook_target is None:
3055
result.target_branch = self.target
3057
result.target_branch = _override_hook_target
3058
self.source.lock_read()
3060
# We assume that during 'pull' the target repository is closer than
3062
self.source.update_references(self.target)
3063
graph = self.target.repository.get_graph(self.source.repository)
3064
# TODO: Branch formats should have a flag that indicates
3065
# that revno's are expensive, and pull() should honor that flag.
3067
result.old_revno, result.old_revid = \
3068
self.target.last_revision_info()
3069
self.target.update_revisions(self.source, stop_revision,
3070
overwrite=overwrite, graph=graph)
3071
# TODO: The old revid should be specified when merging tags,
3072
# so a tags implementation that versions tags can only
3073
# pull in the most recent changes. -- JRV20090506
3074
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3076
result.new_revno, result.new_revid = self.target.last_revision_info()
3078
result.master_branch = _hook_master
3079
result.local_branch = result.target_branch
3081
result.master_branch = result.target_branch
3082
result.local_branch = None
3084
for hook in Branch.hooks['post_pull']:
3087
self.source.unlock()
3090
def push(self, overwrite=False, stop_revision=None,
3091
_override_hook_source_branch=None):
3092
"""See InterBranch.push.
3094
This is the basic concrete implementation of push()
3096
:param _override_hook_source_branch: If specified, run
3097
the hooks passing this Branch as the source, rather than self.
3098
This is for use of RemoteBranch, where push is delegated to the
3099
underlying vfs-based Branch.
3101
# TODO: Public option to disable running hooks - should be trivial but
3103
self.source.lock_read()
3105
return _run_with_write_locked_target(
3106
self.target, self._push_with_bound_branches, overwrite,
3108
_override_hook_source_branch=_override_hook_source_branch)
3110
self.source.unlock()
3112
def _push_with_bound_branches(self, overwrite, stop_revision,
3113
_override_hook_source_branch=None):
3114
"""Push from source into target, and into target's master if any.
3117
if _override_hook_source_branch:
3118
result.source_branch = _override_hook_source_branch
3119
for hook in Branch.hooks['post_push']:
3122
bound_location = self.target.get_bound_location()
3123
if bound_location and self.target.base != bound_location:
3124
# there is a master branch.
3126
# XXX: Why the second check? Is it even supported for a branch to
3127
# be bound to itself? -- mbp 20070507
3128
master_branch = self.target.get_master_branch()
3129
master_branch.lock_write()
3131
# push into the master from the source branch.
3132
self.source._basic_push(master_branch, overwrite, stop_revision)
3133
# and push into the target branch from the source. Note that we
3134
# push from the source branch again, because its considered the
3135
# highest bandwidth repository.
3136
result = self.source._basic_push(self.target, overwrite,
3138
result.master_branch = master_branch
3139
result.local_branch = self.target
3143
master_branch.unlock()
3146
result = self.source._basic_push(self.target, overwrite,
3148
# TODO: Why set master_branch and local_branch if there's no
3149
# binding? Maybe cleaner to just leave them unset? -- mbp
3151
result.master_branch = self.target
3152
result.local_branch = None
3157
def is_compatible(self, source, target):
3158
# GenericBranch uses the public API, so always compatible
3162
class InterToBranch5(GenericInterBranch):
3165
def _get_branch_formats_to_test():
3166
return BranchFormat._default_format, BzrBranchFormat5()
3168
def pull(self, overwrite=False, stop_revision=None,
3169
possible_transports=None, run_hooks=True,
3170
_override_hook_target=None, local=False):
3171
"""Pull from source into self, updating my master if any.
3173
:param run_hooks: Private parameter - if false, this branch
3174
is being called because it's the master of the primary branch,
3175
so it should not run its hooks.
3177
bound_location = self.target.get_bound_location()
3178
if local and not bound_location:
3179
raise errors.LocalRequiresBoundBranch()
3180
master_branch = None
3181
if not local and bound_location and self.source.base != bound_location:
3182
# not pulling from master, so we need to update master.
3183
master_branch = self.target.get_master_branch(possible_transports)
3184
master_branch.lock_write()
3187
# pull from source into master.
3188
master_branch.pull(self.source, overwrite, stop_revision,
3190
return super(InterToBranch5, self).pull(overwrite,
3191
stop_revision, _hook_master=master_branch,
3192
run_hooks=run_hooks,
3193
_override_hook_target=_override_hook_target)
3196
master_branch.unlock()
3199
InterBranch.register_optimiser(GenericInterBranch)
3200
InterBranch.register_optimiser(InterToBranch5)
added
removed
bzrlib/branch.py
