157
78
"""Branch holding a history of revisions.
160
Base directory of the branch.
166
If _lock_mode is true, a positive count of the number of times the
170
Lock object from bzrlib.lock.
81
Base directory/url of the branch.
83
hooks: An instance of BranchHooks.
85
# this is really an instance variable - FIXME move it there
176
_inventory_weave = None
178
# Map some sort of prefix into a namespace
179
# stuff like "revno:10", "revid:", etc.
180
# This should match a prefix with a function which accepts
181
REVISION_NAMESPACES = {}
183
def __init__(self, base, init=False, find_root=True):
184
"""Create new branch object at a particular location.
186
base -- Base directory for the branch.
188
init -- If True, create new control files in a previously
189
unversioned directory. If False, the branch must already
192
find_root -- If true and init is false, find the root of the
193
existing branch containing base.
195
In the test suite, creation of new trees is tested using the
196
`ScratchBranch` class.
199
self.base = os.path.realpath(base)
202
self.base = find_branch_root(base)
204
self.base = os.path.realpath(base)
205
if not isdir(self.controlfilename('.')):
206
from errors import NotBranchError
207
raise NotBranchError("not a bzr branch: %s" % quotefn(base),
208
['use "bzr init" to initialize a new working tree',
209
'current bzr can only operate from top-of-tree'])
212
self.weave_store = WeaveStore(self.controlfilename('weaves'))
213
self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
217
return '%s(%r)' % (self.__class__.__name__, self.base)
224
if self._lock_mode or self._lock:
225
from warnings import warn
226
warn("branch %r was not explicitly unlocked" % self)
89
def __init__(self, *ignored, **ignored_too):
90
self.tags = self._format.make_tags(self)
91
self._revision_history_cache = None
92
self._revision_id_to_revno_cache = None
93
self._partial_revision_id_to_revno_cache = {}
94
self._partial_revision_history_cache = []
95
self._last_revision_info_cache = None
96
self._merge_sorted_revisions_cache = None
98
hooks = Branch.hooks['open']
102
def _open_hook(self):
103
"""Called by init to allow simpler extension of the base class."""
105
def _activate_fallback_location(self, url):
106
"""Activate the branch/repository from url as a fallback repository."""
107
repo = self._get_fallback_repository(url)
108
if repo.has_same_location(self.repository):
109
raise errors.UnstackableLocationError(self.base, url)
110
self.repository.add_fallback_repository(repo)
112
def break_lock(self):
113
"""Break a lock if one is present from another instance.
115
Uses the ui factory to ask for confirmation if the lock may be from
118
This will probe the repository for its lock as well.
120
self.control_files.break_lock()
121
self.repository.break_lock()
122
master = self.get_master_branch()
123
if master is not None:
126
def _check_stackable_repo(self):
127
if not self.repository._format.supports_external_lookups:
128
raise errors.UnstackableRepositoryFormat(self.repository._format,
129
self.repository.base)
131
def _extend_partial_history(self, stop_index=None, stop_revision=None):
132
"""Extend the partial history to include a given index
134
If a stop_index is supplied, stop when that index has been reached.
135
If a stop_revision is supplied, stop when that revision is
136
encountered. Otherwise, stop when the beginning of history is
139
:param stop_index: The index which should be present. When it is
140
present, history extension will stop.
141
:param stop_revision: The revision id which should be present. When
142
it is encountered, history extension will stop.
144
if len(self._partial_revision_history_cache) == 0:
145
self._partial_revision_history_cache = [self.last_revision()]
146
repository._iter_for_revno(
147
self.repository, self._partial_revision_history_cache,
148
stop_index=stop_index, stop_revision=stop_revision)
149
if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
150
self._partial_revision_history_cache.pop()
153
def open(base, _unsupported=False, possible_transports=None):
154
"""Open the branch rooted at base.
156
For instance, if the branch is at URL/.bzr/branch,
157
Branch.open(URL) -> a Branch instance.
159
control = bzrdir.BzrDir.open(base, _unsupported,
160
possible_transports=possible_transports)
161
return control.open_branch(_unsupported)
164
def open_from_transport(transport, _unsupported=False):
165
"""Open the branch rooted at transport"""
166
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
167
return control.open_branch(_unsupported)
170
def open_containing(url, possible_transports=None):
171
"""Open an existing branch which contains url.
173
This probes for a branch at url, and searches upwards from there.
175
Basically we keep looking up until we find the control directory or
176
run into the root. If there isn't one, raises NotBranchError.
177
If there is one and it is either an unrecognised format or an unsupported
178
format, UnknownFormatError or UnsupportedFormatError are raised.
179
If there is one, it is returned, along with the unused portion of url.
181
control, relpath = bzrdir.BzrDir.open_containing(url,
183
return control.open_branch(), relpath
185
def _push_should_merge_tags(self):
186
"""Should _basic_push merge this branch's tags into the target?
188
The default implementation returns False if this branch has no tags,
189
and True the rest of the time. Subclasses may override this.
191
return self.supports_tags() and self.tags.get_tag_dict()
193
def get_config(self):
194
return BranchConfig(self)
196
def _get_config(self):
197
"""Get the concrete config for just the config in this branch.
199
This is not intended for client use; see Branch.get_config for the
204
:return: An object supporting get_option and set_option.
206
raise NotImplementedError(self._get_config)
208
def _get_fallback_repository(self, url):
209
"""Get the repository we fallback to at url."""
210
url = urlutils.join(self.base, url)
211
a_bzrdir = bzrdir.BzrDir.open(url,
212
possible_transports=[self.bzrdir.root_transport])
213
return a_bzrdir.open_branch().repository
215
def _get_tags_bytes(self):
216
"""Get the bytes of a serialised tags dict.
218
Note that not all branches support tags, nor do all use the same tags
219
logic: this method is specific to BasicTags. Other tag implementations
220
may use the same method name and behave differently, safely, because
221
of the double-dispatch via
222
format.make_tags->tags_instance->get_tags_dict.
224
:return: The bytes of the tags file.
225
:seealso: Branch._set_tags_bytes.
227
return self._transport.get_bytes('tags')
229
def _get_nick(self, local=False, possible_transports=None):
230
config = self.get_config()
231
# explicit overrides master, but don't look for master if local is True
232
if not local and not config.has_explicit_nickname():
234
master = self.get_master_branch(possible_transports)
235
if master is not None:
236
# return the master branch value
238
except errors.BzrError, e:
239
# Silently fall back to local implicit nick if the master is
241
mutter("Could not connect to bound branch, "
242
"falling back to local nick.\n " + str(e))
243
return config.get_nickname()
245
def _set_nick(self, nick):
246
self.get_config().set_user_option('nickname', nick, warn_masked=True)
248
nick = property(_get_nick, _set_nick)
251
raise NotImplementedError(self.is_locked)
253
def _lefthand_history(self, revision_id, last_rev=None,
255
if 'evil' in debug.debug_flags:
256
mutter_callsite(4, "_lefthand_history scales with history.")
257
# stop_revision must be a descendant of last_revision
258
graph = self.repository.get_graph()
259
if last_rev is not None:
260
if not graph.is_ancestor(last_rev, revision_id):
261
# our previous tip is not merged into stop_revision
262
raise errors.DivergedBranches(self, other_branch)
263
# make a new revision history from the graph
264
parents_map = graph.get_parent_map([revision_id])
265
if revision_id not in parents_map:
266
raise errors.NoSuchRevision(self, revision_id)
267
current_rev_id = revision_id
269
check_not_reserved_id = _mod_revision.check_not_reserved_id
270
# Do not include ghosts or graph origin in revision_history
271
while (current_rev_id in parents_map and
272
len(parents_map[current_rev_id]) > 0):
273
check_not_reserved_id(current_rev_id)
274
new_history.append(current_rev_id)
275
current_rev_id = parents_map[current_rev_id][0]
276
parents_map = graph.get_parent_map([current_rev_id])
277
new_history.reverse()
230
280
def lock_write(self):
232
if self._lock_mode != 'w':
233
from errors import LockError
234
raise LockError("can't upgrade to a write lock from %r" %
236
self._lock_count += 1
238
from bzrlib.lock import WriteLock
240
self._lock = WriteLock(self.controlfilename('branch-lock'))
241
self._lock_mode = 'w'
281
raise NotImplementedError(self.lock_write)
245
283
def lock_read(self):
247
assert self._lock_mode in ('r', 'w'), \
248
"invalid lock mode %r" % self._lock_mode
249
self._lock_count += 1
251
from bzrlib.lock import ReadLock
284
raise NotImplementedError(self.lock_read)
253
self._lock = ReadLock(self.controlfilename('branch-lock'))
254
self._lock_mode = 'r'
257
286
def unlock(self):
258
if not self._lock_mode:
259
from errors import LockError
260
raise LockError('branch %r is not locked' % (self))
262
if self._lock_count > 1:
263
self._lock_count -= 1
267
self._lock_mode = self._lock_count = None
269
def abspath(self, name):
270
"""Return absolute filename for something in the branch"""
271
return os.path.join(self.base, name)
273
def relpath(self, path):
274
"""Return path relative to this branch of something inside it.
276
Raises an error if path is not in this branch."""
277
return _relpath(self.base, path)
279
def controlfilename(self, file_or_path):
280
"""Return location relative to branch."""
281
if isinstance(file_or_path, basestring):
282
file_or_path = [file_or_path]
283
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
286
def controlfile(self, file_or_path, mode='r'):
287
"""Open a control file for this branch.
289
There are two classes of file in the control directory: text
290
and binary. binary files are untranslated byte streams. Text
291
control files are stored with Unix newlines and in UTF-8, even
292
if the platform or locale defaults are different.
294
Controlfiles should almost never be opened in write mode but
295
rather should be atomically copied and replaced using atomicfile.
298
fn = self.controlfilename(file_or_path)
300
if mode == 'rb' or mode == 'wb':
301
return file(fn, mode)
302
elif mode == 'r' or mode == 'w':
303
# open in binary mode anyhow so there's no newline translation;
304
# codecs uses line buffering by default; don't want that.
306
return codecs.open(fn, mode + 'b', 'utf-8',
309
raise BzrError("invalid controlfile mode %r" % mode)
311
def _make_control(self):
312
os.mkdir(self.controlfilename([]))
313
self.controlfile('README', 'w').write(
314
"This is a Bazaar-NG control directory.\n"
315
"Do not change any files in this directory.\n")
316
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT_5)
317
for d in ('text-store', 'revision-store',
319
os.mkdir(self.controlfilename(d))
320
for f in ('revision-history', 'merged-patches',
321
'pending-merged-patches', 'branch-name',
324
self.controlfile(f, 'w').write('')
325
mutter('created control directory in ' + self.base)
327
# if we want per-tree root ids then this is the place to set
328
# them; they're not needed for now and so ommitted for
330
f = self.controlfile('inventory','w')
331
bzrlib.xml5.serializer_v5.write_inventory(Inventory(), f)
335
def _check_format(self):
336
"""Check this branch format is supported.
338
The format level is stored, as an integer, in
339
self._branch_format for code that needs to check it later.
341
In the future, we might need different in-memory Branch
342
classes to support downlevel branches. But not yet.
344
fmt = self.controlfile('branch-format', 'r').read()
345
if fmt == BZR_BRANCH_FORMAT_5:
346
self._branch_format = 5
348
raise BzrError('sorry, branch format "%s" not supported; '
349
'use a different bzr version, '
350
'or run "bzr upgrade", '
351
'or remove the .bzr directory and "bzr init" again'
352
% fmt.rstrip('\n\r'))
354
def get_root_id(self):
355
"""Return the id of this branches root"""
356
inv = self.read_working_inventory()
357
return inv.root.file_id
359
def set_root_id(self, file_id):
360
inv = self.read_working_inventory()
361
orig_root_id = inv.root.file_id
362
del inv._byid[inv.root.file_id]
363
inv.root.file_id = file_id
364
inv._byid[inv.root.file_id] = inv.root
367
if entry.parent_id in (None, orig_root_id):
368
entry.parent_id = inv.root.file_id
369
self._write_inventory(inv)
371
def read_working_inventory(self):
372
"""Read the working inventory."""
375
# ElementTree does its own conversion from UTF-8, so open in
377
f = self.controlfile('inventory', 'rb')
378
return bzrlib.xml5.serializer_v5.read_inventory(f)
383
def _write_inventory(self, inv):
384
"""Update the working inventory.
386
That is to say, the inventory describing changes underway, that
387
will be committed to the next revision.
389
from bzrlib.atomicfile import AtomicFile
393
f = AtomicFile(self.controlfilename('inventory'), 'wb')
395
bzrlib.xml5.serializer_v5.write_inventory(inv, f)
402
mutter('wrote working inventory')
405
inventory = property(read_working_inventory, _write_inventory, None,
406
"""Inventory for the working copy.""")
409
def add(self, files, ids=None):
410
"""Make files versioned.
412
Note that the command line normally calls smart_add instead,
413
which can automatically recurse.
415
This puts the files in the Added state, so that they will be
416
recorded by the next commit.
419
List of paths to add, relative to the base of the tree.
422
If set, use these instead of automatically generated ids.
423
Must be the same length as the list of files, but may
424
contain None for ids that are to be autogenerated.
426
TODO: Perhaps have an option to add the ids even if the files do
429
TODO: Perhaps yield the ids and paths as they're added.
431
# TODO: Re-adding a file that is removed in the working copy
432
# should probably put it back with the previous ID.
433
if isinstance(files, basestring):
434
assert(ids is None or isinstance(ids, basestring))
440
ids = [None] * len(files)
442
assert(len(ids) == len(files))
446
inv = self.read_working_inventory()
447
for f,file_id in zip(files, ids):
448
if is_control_file(f):
449
raise BzrError("cannot add control file %s" % quotefn(f))
454
raise BzrError("cannot add top-level %r" % f)
456
fullpath = os.path.normpath(self.abspath(f))
459
kind = file_kind(fullpath)
461
# maybe something better?
462
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
464
if kind != 'file' and kind != 'directory':
465
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
468
file_id = gen_file_id(f)
469
inv.add_path(f, kind=kind, file_id=file_id)
471
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
473
self._write_inventory(inv)
478
def print_file(self, file, revno):
479
"""Print `file` to stdout."""
482
tree = self.revision_tree(self.lookup_revision(revno))
483
# use inventory as it was in that revision
484
file_id = tree.inventory.path2id(file)
486
raise BzrError("%r is not present in revision %s" % (file, revno))
487
tree.print_file(file_id)
492
def remove(self, files, verbose=False):
493
"""Mark nominated files for removal from the inventory.
495
This does not remove their text. This does not run on
497
TODO: Refuse to remove modified files unless --force is given?
499
TODO: Do something useful with directories.
501
TODO: Should this remove the text or not? Tough call; not
502
removing may be useful and the user can just use use rm, and
503
is the opposite of add. Removing it is consistent with most
504
other tools. Maybe an option.
506
## TODO: Normalize names
507
## TODO: Remove nested loops; better scalability
508
if isinstance(files, basestring):
514
tree = self.working_tree()
517
# do this before any modifications
521
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
522
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
524
# having remove it, it must be either ignored or unknown
525
if tree.is_ignored(f):
529
show_status(new_status, inv[fid].kind, quotefn(f))
532
self._write_inventory(inv)
537
# FIXME: this doesn't need to be a branch method
538
def set_inventory(self, new_inventory_list):
539
from bzrlib.inventory import Inventory, InventoryEntry
540
inv = Inventory(self.get_root_id())
541
for path, file_id, parent, kind in new_inventory_list:
542
name = os.path.basename(path)
545
inv.add(InventoryEntry(file_id, name, kind, parent))
546
self._write_inventory(inv)
550
"""Return all unknown files.
552
These are files in the working directory that are not versioned or
553
control files or ignored.
555
>>> b = ScratchBranch(files=['foo', 'foo~'])
556
>>> list(b.unknowns())
559
>>> list(b.unknowns())
562
>>> list(b.unknowns())
565
return self.working_tree().unknowns()
568
def append_revision(self, *revision_ids):
569
from bzrlib.atomicfile import AtomicFile
571
for revision_id in revision_ids:
572
mutter("add {%s} to revision-history" % revision_id)
574
rev_history = self.revision_history()
575
rev_history.extend(revision_ids)
577
f = AtomicFile(self.controlfilename('revision-history'))
579
for rev_id in rev_history:
586
def get_revision_xml_file(self, revision_id):
587
"""Return XML file object for revision object."""
588
if not revision_id or not isinstance(revision_id, basestring):
589
raise InvalidRevisionId(revision_id)
594
return self.revision_store[revision_id]
596
raise bzrlib.errors.NoSuchRevision(self, revision_id)
602
get_revision_xml = get_revision_xml_file
605
def get_revision(self, revision_id):
606
"""Return the Revision object for a named revision"""
607
xml_file = self.get_revision_xml_file(revision_id)
610
r = bzrlib.xml5.serializer_v5.read_revision(xml_file)
611
except SyntaxError, e:
612
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
616
assert r.revision_id == revision_id
287
raise NotImplementedError(self.unlock)
289
def peek_lock_mode(self):
290
"""Return lock mode for the Branch: 'r', 'w' or None"""
291
raise NotImplementedError(self.peek_lock_mode)
293
def get_physical_lock_status(self):
294
raise NotImplementedError(self.get_physical_lock_status)
297
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
298
"""Return the revision_id for a dotted revno.
300
:param revno: a tuple like (1,) or (1,1,2)
301
:param _cache_reverse: a private parameter enabling storage
302
of the reverse mapping in a top level cache. (This should
303
only be done in selective circumstances as we want to
304
avoid having the mapping cached multiple times.)
305
:return: the revision_id
306
:raises errors.NoSuchRevision: if the revno doesn't exist
308
rev_id = self._do_dotted_revno_to_revision_id(revno)
310
self._partial_revision_id_to_revno_cache[rev_id] = revno
313
def _do_dotted_revno_to_revision_id(self, revno):
314
"""Worker function for dotted_revno_to_revision_id.
316
Subclasses should override this if they wish to
317
provide a more efficient implementation.
320
return self.get_rev_id(revno[0])
321
revision_id_to_revno = self.get_revision_id_to_revno_map()
322
revision_ids = [revision_id for revision_id, this_revno
323
in revision_id_to_revno.iteritems()
324
if revno == this_revno]
325
if len(revision_ids) == 1:
326
return revision_ids[0]
328
revno_str = '.'.join(map(str, revno))
329
raise errors.NoSuchRevision(self, revno_str)
332
def revision_id_to_dotted_revno(self, revision_id):
333
"""Given a revision id, return its dotted revno.
335
:return: a tuple like (1,) or (400,1,3).
337
return self._do_revision_id_to_dotted_revno(revision_id)
339
def _do_revision_id_to_dotted_revno(self, revision_id):
340
"""Worker function for revision_id_to_revno."""
341
# Try the caches if they are loaded
342
result = self._partial_revision_id_to_revno_cache.get(revision_id)
343
if result is not None:
345
if self._revision_id_to_revno_cache:
346
result = self._revision_id_to_revno_cache.get(revision_id)
348
raise errors.NoSuchRevision(self, revision_id)
349
# Try the mainline as it's optimised
351
revno = self.revision_id_to_revno(revision_id)
353
except errors.NoSuchRevision:
354
# We need to load and use the full revno map after all
355
result = self.get_revision_id_to_revno_map().get(revision_id)
357
raise errors.NoSuchRevision(self, revision_id)
361
def get_revision_id_to_revno_map(self):
362
"""Return the revision_id => dotted revno map.
364
This will be regenerated on demand, but will be cached.
366
:return: A dictionary mapping revision_id => dotted revno.
367
This dictionary should not be modified by the caller.
369
if self._revision_id_to_revno_cache is not None:
370
mapping = self._revision_id_to_revno_cache
372
mapping = self._gen_revno_map()
373
self._cache_revision_id_to_revno(mapping)
374
# TODO: jam 20070417 Since this is being cached, should we be returning
376
# I would rather not, and instead just declare that users should not
377
# modify the return value.
380
def _gen_revno_map(self):
381
"""Create a new mapping from revision ids to dotted revnos.
383
Dotted revnos are generated based on the current tip in the revision
385
This is the worker function for get_revision_id_to_revno_map, which
386
just caches the return value.
388
:return: A dictionary mapping revision_id => dotted revno.
390
revision_id_to_revno = dict((rev_id, revno)
391
for rev_id, depth, revno, end_of_merge
392
in self.iter_merge_sorted_revisions())
393
return revision_id_to_revno
396
def iter_merge_sorted_revisions(self, start_revision_id=None,
397
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
398
"""Walk the revisions for a branch in merge sorted order.
400
Merge sorted order is the output from a merge-aware,
401
topological sort, i.e. all parents come before their
402
children going forward; the opposite for reverse.
404
:param start_revision_id: the revision_id to begin walking from.
405
If None, the branch tip is used.
406
:param stop_revision_id: the revision_id to terminate the walk
407
after. If None, the rest of history is included.
408
:param stop_rule: if stop_revision_id is not None, the precise rule
409
to use for termination:
410
* 'exclude' - leave the stop revision out of the result (default)
411
* 'include' - the stop revision is the last item in the result
412
* 'with-merges' - include the stop revision and all of its
413
merged revisions in the result
414
:param direction: either 'reverse' or 'forward':
415
* reverse means return the start_revision_id first, i.e.
416
start at the most recent revision and go backwards in history
417
* forward returns tuples in the opposite order to reverse.
418
Note in particular that forward does *not* do any intelligent
419
ordering w.r.t. depth as some clients of this API may like.
420
(If required, that ought to be done at higher layers.)
422
:return: an iterator over (revision_id, depth, revno, end_of_merge)
425
* revision_id: the unique id of the revision
426
* depth: How many levels of merging deep this node has been
428
* revno_sequence: This field provides a sequence of
429
revision numbers for all revisions. The format is:
430
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
431
branch that the revno is on. From left to right the REVNO numbers
432
are the sequence numbers within that branch of the revision.
433
* end_of_merge: When True the next node (earlier in history) is
434
part of a different merge.
436
# Note: depth and revno values are in the context of the branch so
437
# we need the full graph to get stable numbers, regardless of the
439
if self._merge_sorted_revisions_cache is None:
440
last_revision = self.last_revision()
441
graph = self.repository.get_graph()
442
parent_map = dict(((key, value) for key, value in
443
graph.iter_ancestry([last_revision]) if value is not None))
444
revision_graph = repository._strip_NULL_ghosts(parent_map)
445
revs = tsort.merge_sort(revision_graph, last_revision, None,
447
# Drop the sequence # before caching
448
self._merge_sorted_revisions_cache = [r[1:] for r in revs]
450
filtered = self._filter_merge_sorted_revisions(
451
self._merge_sorted_revisions_cache, start_revision_id,
452
stop_revision_id, stop_rule)
453
if direction == 'reverse':
455
if direction == 'forward':
456
return reversed(list(filtered))
458
raise ValueError('invalid direction %r' % direction)
460
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
461
start_revision_id, stop_revision_id, stop_rule):
462
"""Iterate over an inclusive range of sorted revisions."""
463
rev_iter = iter(merge_sorted_revisions)
464
if start_revision_id is not None:
465
for rev_id, depth, revno, end_of_merge in rev_iter:
466
if rev_id != start_revision_id:
469
# The decision to include the start or not
470
# depends on the stop_rule if a stop is provided
472
iter([(rev_id, depth, revno, end_of_merge)]),
475
if stop_revision_id is None:
476
for rev_id, depth, revno, end_of_merge in rev_iter:
477
yield rev_id, depth, revno, end_of_merge
478
elif stop_rule == 'exclude':
479
for rev_id, depth, revno, end_of_merge in rev_iter:
480
if rev_id == stop_revision_id:
482
yield rev_id, depth, revno, end_of_merge
483
elif stop_rule == 'include':
484
for rev_id, depth, revno, end_of_merge in rev_iter:
485
yield rev_id, depth, revno, end_of_merge
486
if rev_id == stop_revision_id:
488
elif stop_rule == 'with-merges':
489
stop_rev = self.repository.get_revision(stop_revision_id)
490
if stop_rev.parent_ids:
491
left_parent = stop_rev.parent_ids[0]
493
left_parent = _mod_revision.NULL_REVISION
494
for rev_id, depth, revno, end_of_merge in rev_iter:
495
if rev_id == left_parent:
497
yield rev_id, depth, revno, end_of_merge
499
raise ValueError('invalid stop_rule %r' % stop_rule)
501
def leave_lock_in_place(self):
502
"""Tell this branch object not to release the physical lock when this
505
If lock_write doesn't return a token, then this method is not supported.
507
self.control_files.leave_in_place()
509
def dont_leave_lock_in_place(self):
510
"""Tell this branch object to release the physical lock when this
511
object is unlocked, even if it didn't originally acquire it.
513
If lock_write doesn't return a token, then this method is not supported.
515
self.control_files.dont_leave_in_place()
517
def bind(self, other):
518
"""Bind the local branch the other branch.
520
:param other: The branch to bind to
523
raise errors.UpgradeRequired(self.base)
525
def set_append_revisions_only(self, enabled):
526
if not self._format.supports_set_append_revisions_only():
527
raise errors.UpgradeRequired(self.base)
532
self.get_config().set_user_option('append_revisions_only', value,
535
def set_reference_info(self, file_id, tree_path, branch_location):
536
"""Set the branch location to use for a tree reference."""
537
raise errors.UnsupportedOperation(self.set_reference_info, self)
539
def get_reference_info(self, file_id):
540
"""Get the tree_path and branch_location for a tree reference."""
541
raise errors.UnsupportedOperation(self.get_reference_info, self)
544
def fetch(self, from_branch, last_revision=None, pb=None):
545
"""Copy revisions from from_branch into this branch.
547
:param from_branch: Where to copy from.
548
:param last_revision: What revision to stop at (None for at the end
550
:param pb: An optional progress bar to use.
553
if self.base == from_branch.base:
556
symbol_versioning.warn(
557
symbol_versioning.deprecated_in((1, 14, 0))
558
% "pb parameter to fetch()")
559
from_branch.lock_read()
561
if last_revision is None:
562
last_revision = from_branch.last_revision()
563
last_revision = _mod_revision.ensure_null(last_revision)
564
return self.repository.fetch(from_branch.repository,
565
revision_id=last_revision,
570
def get_bound_location(self):
571
"""Return the URL of the branch we are bound to.
573
Older format branches cannot bind, please be sure to use a metadir
578
def get_old_bound_location(self):
579
"""Return the URL of the branch we used to be bound to
581
raise errors.UpgradeRequired(self.base)
583
def get_commit_builder(self, parents, config=None, timestamp=None,
584
timezone=None, committer=None, revprops=None,
586
"""Obtain a CommitBuilder for this branch.
588
:param parents: Revision ids of the parents of the new revision.
589
:param config: Optional configuration to use.
590
:param timestamp: Optional timestamp recorded for commit.
591
:param timezone: Optional timezone for timestamp.
592
:param committer: Optional committer to set for commit.
593
:param revprops: Optional dictionary of revision properties.
594
:param revision_id: Optional revision id.
598
config = self.get_config()
600
return self.repository.get_commit_builder(self, parents, config,
601
timestamp, timezone, committer, revprops, revision_id)
603
def get_master_branch(self, possible_transports=None):
604
"""Return the branch we are bound to.
606
:return: Either a Branch, or None
620
610
def get_revision_delta(self, revno):
621
611
"""Return the delta for one revision.
807
857
common_index = min(self_len, other_len) -1
808
858
if common_index >= 0 and \
809
859
self_history[common_index] != other_history[common_index]:
810
raise DivergedBranches(self, other)
860
raise errors.DivergedBranches(self, other)
812
862
if stop_revision is None:
813
863
stop_revision = other_len
814
elif stop_revision > other_len:
815
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
865
if stop_revision > other_len:
866
raise errors.NoSuchRevision(self, stop_revision)
817
867
return other_history[self_len:stop_revision]
820
def update_revisions(self, other, stop_revision=None):
821
"""Pull in all new revisions from other branch.
823
from bzrlib.fetch import greedy_fetch
825
pb = bzrlib.ui.ui_factory.progress_bar()
826
pb.update('comparing histories')
828
revision_ids = self.missing_revisions(other, stop_revision)
830
if len(revision_ids) > 0:
831
count = greedy_fetch(self, other, revision_ids[-1], pb)[0]
834
self.append_revision(*revision_ids)
835
## note("Added %d revisions." % count)
839
def commit(self, *args, **kw):
840
from bzrlib.commit import Commit
841
Commit().commit(self, *args, **kw)
844
def lookup_revision(self, revision):
845
"""Return the revision identifier for a given revision information."""
846
revno, info = self._get_revision_info(revision)
870
def update_revisions(self, other, stop_revision=None, overwrite=False,
872
"""Pull in new perfect-fit revisions.
874
:param other: Another Branch to pull from
875
:param stop_revision: Updated until the given revision
876
:param overwrite: Always set the branch pointer, rather than checking
877
to see if it is a proper descendant.
878
:param graph: A Graph object that can be used to query history
879
information. This can be None.
882
return InterBranch.get(other, self).update_revisions(stop_revision,
885
def import_last_revision_info(self, source_repo, revno, revid):
886
"""Set the last revision info, importing from another repo if necessary.
888
This is used by the bound branch code to upload a revision to
889
the master branch first before updating the tip of the local branch.
891
:param source_repo: Source repository to optionally fetch from
892
:param revno: Revision number of the new tip
893
:param revid: Revision id of the new tip
895
if not self.repository.has_same_location(source_repo):
896
self.repository.fetch(source_repo, revision_id=revid)
897
self.set_last_revision_info(revno, revid)
850
899
def revision_id_to_revno(self, revision_id):
851
900
"""Given a revision id, return its revno"""
901
if _mod_revision.is_null(revision_id):
852
903
history = self.revision_history()
854
905
return history.index(revision_id) + 1
855
906
except ValueError:
856
raise bzrlib.errors.NoSuchRevision(self, revision_id)
859
def get_revision_info(self, revision):
860
"""Return (revno, revision id) for revision identifier.
862
revision can be an integer, in which case it is assumed to be revno (though
863
this will translate negative values into positive ones)
864
revision can also be a string, in which case it is parsed for something like
865
'date:' or 'revid:' etc.
867
revno, rev_id = self._get_revision_info(revision)
869
raise bzrlib.errors.NoSuchRevision(self, revision)
907
raise errors.NoSuchRevision(self, revision_id)
872
910
def get_rev_id(self, revno, history=None):
873
911
"""Find the revision id of the specified revno."""
877
history = self.revision_history()
878
elif revno <= 0 or revno > len(history):
879
raise bzrlib.errors.NoSuchRevision(self, revno)
880
return history[revno - 1]
882
def _get_revision_info(self, revision):
883
"""Return (revno, revision id) for revision specifier.
885
revision can be an integer, in which case it is assumed to be revno
886
(though this will translate negative values into positive ones)
887
revision can also be a string, in which case it is parsed for something
888
like 'date:' or 'revid:' etc.
890
A revid is always returned. If it is None, the specifier referred to
891
the null revision. If the revid does not occur in the revision
892
history, revno will be None.
898
try:# Convert to int if possible
899
revision = int(revision)
902
revs = self.revision_history()
903
if isinstance(revision, int):
905
revno = len(revs) + revision + 1
908
rev_id = self.get_rev_id(revno, revs)
909
elif isinstance(revision, basestring):
910
for prefix, func in Branch.REVISION_NAMESPACES.iteritems():
911
if revision.startswith(prefix):
912
result = func(self, revs, revision)
914
revno, rev_id = result
917
rev_id = self.get_rev_id(revno, revs)
920
raise BzrError('No namespace registered for string: %r' %
923
raise TypeError('Unhandled revision type %s' % revision)
927
raise bzrlib.errors.NoSuchRevision(self, revision)
930
def _namespace_revno(self, revs, revision):
931
"""Lookup a revision by revision number"""
932
assert revision.startswith('revno:')
934
return (int(revision[6:]),)
937
REVISION_NAMESPACES['revno:'] = _namespace_revno
939
def _namespace_revid(self, revs, revision):
940
assert revision.startswith('revid:')
941
rev_id = revision[len('revid:'):]
943
return revs.index(rev_id) + 1, rev_id
946
REVISION_NAMESPACES['revid:'] = _namespace_revid
948
def _namespace_last(self, revs, revision):
949
assert revision.startswith('last:')
951
offset = int(revision[5:])
956
raise BzrError('You must supply a positive value for --revision last:XXX')
957
return (len(revs) - offset + 1,)
958
REVISION_NAMESPACES['last:'] = _namespace_last
960
def _namespace_tag(self, revs, revision):
961
assert revision.startswith('tag:')
962
raise BzrError('tag: namespace registered, but not implemented.')
963
REVISION_NAMESPACES['tag:'] = _namespace_tag
965
def _namespace_date(self, revs, revision):
966
assert revision.startswith('date:')
968
# Spec for date revisions:
970
# value can be 'yesterday', 'today', 'tomorrow' or a YYYY-MM-DD string.
971
# it can also start with a '+/-/='. '+' says match the first
972
# entry after the given date. '-' is match the first entry before the date
973
# '=' is match the first entry after, but still on the given date.
975
# +2005-05-12 says find the first matching entry after May 12th, 2005 at 0:00
976
# -2005-05-12 says find the first matching entry before May 12th, 2005 at 0:00
977
# =2005-05-12 says find the first match after May 12th, 2005 at 0:00 but before
978
# May 13th, 2005 at 0:00
980
# So the proper way of saying 'give me all entries for today' is:
981
# -r {date:+today}:{date:-tomorrow}
982
# The default is '=' when not supplied
985
if val[:1] in ('+', '-', '='):
986
match_style = val[:1]
989
today = datetime.datetime.today().replace(hour=0,minute=0,second=0,microsecond=0)
990
if val.lower() == 'yesterday':
991
dt = today - datetime.timedelta(days=1)
992
elif val.lower() == 'today':
994
elif val.lower() == 'tomorrow':
995
dt = today + datetime.timedelta(days=1)
998
# This should be done outside the function to avoid recompiling it.
999
_date_re = re.compile(
1000
r'(?P<date>(?P<year>\d\d\d\d)-(?P<month>\d\d)-(?P<day>\d\d))?'
1002
r'(?P<time>(?P<hour>\d\d):(?P<minute>\d\d)(:(?P<second>\d\d))?)?'
1004
m = _date_re.match(val)
1005
if not m or (not m.group('date') and not m.group('time')):
1006
raise BzrError('Invalid revision date %r' % revision)
1009
year, month, day = int(m.group('year')), int(m.group('month')), int(m.group('day'))
1011
year, month, day = today.year, today.month, today.day
1013
hour = int(m.group('hour'))
1014
minute = int(m.group('minute'))
1015
if m.group('second'):
1016
second = int(m.group('second'))
1020
hour, minute, second = 0,0,0
1022
dt = datetime.datetime(year=year, month=month, day=day,
1023
hour=hour, minute=minute, second=second)
1027
if match_style == '-':
1029
elif match_style == '=':
1030
last = dt + datetime.timedelta(days=1)
1033
for i in range(len(revs)-1, -1, -1):
1034
r = self.get_revision(revs[i])
1035
# TODO: Handle timezone.
1036
dt = datetime.datetime.fromtimestamp(r.timestamp)
1037
if first >= dt and (last is None or dt >= last):
1040
for i in range(len(revs)):
1041
r = self.get_revision(revs[i])
1042
# TODO: Handle timezone.
1043
dt = datetime.datetime.fromtimestamp(r.timestamp)
1044
if first <= dt and (last is None or dt <= last):
1046
REVISION_NAMESPACES['date:'] = _namespace_date
1048
def revision_tree(self, revision_id):
1049
"""Return Tree for a revision on this branch.
1051
`revision_id` may be None for the null revision, in which case
1052
an `EmptyTree` is returned."""
1053
# TODO: refactor this to use an existing revision object
1054
# so we don't need to read it in twice.
1055
if revision_id == None:
1058
inv = self.get_revision_inventory(revision_id)
1059
return RevisionTree(self.weave_store, inv, revision_id)
1062
def working_tree(self):
1063
"""Return a `Tree` for the working copy."""
1064
from workingtree import WorkingTree
1065
return WorkingTree(self.base, self.read_working_inventory())
913
return _mod_revision.NULL_REVISION
914
last_revno, last_revid = self.last_revision_info()
915
if revno == last_revno:
917
if revno <= 0 or revno > last_revno:
918
raise errors.NoSuchRevision(self, revno)
919
distance_from_last = last_revno - revno
920
if len(self._partial_revision_history_cache) <= distance_from_last:
921
self._extend_partial_history(distance_from_last)
922
return self._partial_revision_history_cache[distance_from_last]
925
def pull(self, source, overwrite=False, stop_revision=None,
926
possible_transports=None, *args, **kwargs):
927
"""Mirror source into this branch.
929
This branch is considered to be 'local', having low latency.
931
:returns: PullResult instance
933
return InterBranch.get(source, self).pull(overwrite=overwrite,
934
stop_revision=stop_revision,
935
possible_transports=possible_transports, *args, **kwargs)
937
def push(self, target, overwrite=False, stop_revision=None, *args,
939
"""Mirror this branch into target.
941
This branch is considered to be 'local', having low latency.
943
return InterBranch.get(self, target).push(overwrite, stop_revision,
946
def lossy_push(self, target, stop_revision=None):
947
"""Push deltas into another branch.
949
:note: This does not, like push, retain the revision ids from
950
the source branch and will, rather than adding bzr-specific
951
metadata, push only those semantics of the revision that can be
952
natively represented by this branch' VCS.
954
:param target: Target branch
955
:param stop_revision: Revision to push, defaults to last revision.
956
:return: BranchPushResult with an extra member revidmap:
957
A dictionary mapping revision ids from the target branch
958
to new revision ids in the target branch, for each
959
revision that was pushed.
961
inter = InterBranch.get(self, target)
962
lossy_push = getattr(inter, "lossy_push", None)
963
if lossy_push is None:
964
raise errors.LossyPushToSameVCS(self, target)
965
return lossy_push(stop_revision)
1068
967
def basis_tree(self):
1069
"""Return `Tree` object for last revision.
1071
If there are no revisions yet, return an `EmptyTree`.
1073
return self.revision_tree(self.last_patch())
1076
def rename_one(self, from_rel, to_rel):
1079
This can change the directory or the filename or both.
1083
tree = self.working_tree()
1084
inv = tree.inventory
1085
if not tree.has_filename(from_rel):
1086
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1087
if tree.has_filename(to_rel):
1088
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1090
file_id = inv.path2id(from_rel)
1092
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1094
if inv.path2id(to_rel):
1095
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1097
to_dir, to_tail = os.path.split(to_rel)
1098
to_dir_id = inv.path2id(to_dir)
1099
if to_dir_id == None and to_dir != '':
1100
raise BzrError("can't determine destination directory id for %r" % to_dir)
1102
mutter("rename_one:")
1103
mutter(" file_id {%s}" % file_id)
1104
mutter(" from_rel %r" % from_rel)
1105
mutter(" to_rel %r" % to_rel)
1106
mutter(" to_dir %r" % to_dir)
1107
mutter(" to_dir_id {%s}" % to_dir_id)
1109
inv.rename(file_id, to_dir_id, to_tail)
1111
from_abs = self.abspath(from_rel)
1112
to_abs = self.abspath(to_rel)
1114
os.rename(from_abs, to_abs)
1116
raise BzrError("failed to rename %r to %r: %s"
1117
% (from_abs, to_abs, e[1]),
1118
["rename rolled back"])
1120
self._write_inventory(inv)
1125
def move(self, from_paths, to_name):
1128
to_name must exist as a versioned directory.
1130
If to_name exists and is a directory, the files are moved into
1131
it, keeping their old names. If it is a directory,
1133
Note that to_name is only the last component of the new name;
1134
this doesn't change the directory.
1136
This returns a list of (from_path, to_path) pairs for each
1137
entry that is moved.
1142
## TODO: Option to move IDs only
1143
assert not isinstance(from_paths, basestring)
1144
tree = self.working_tree()
1145
inv = tree.inventory
1146
to_abs = self.abspath(to_name)
1147
if not isdir(to_abs):
1148
raise BzrError("destination %r is not a directory" % to_abs)
1149
if not tree.has_filename(to_name):
1150
raise BzrError("destination %r not in working directory" % to_abs)
1151
to_dir_id = inv.path2id(to_name)
1152
if to_dir_id == None and to_name != '':
1153
raise BzrError("destination %r is not a versioned directory" % to_name)
1154
to_dir_ie = inv[to_dir_id]
1155
if to_dir_ie.kind not in ('directory', 'root_directory'):
1156
raise BzrError("destination %r is not a directory" % to_abs)
1158
to_idpath = inv.get_idpath(to_dir_id)
1160
for f in from_paths:
1161
if not tree.has_filename(f):
1162
raise BzrError("%r does not exist in working tree" % f)
1163
f_id = inv.path2id(f)
1165
raise BzrError("%r is not versioned" % f)
1166
name_tail = splitpath(f)[-1]
1167
dest_path = appendpath(to_name, name_tail)
1168
if tree.has_filename(dest_path):
1169
raise BzrError("destination %r already exists" % dest_path)
1170
if f_id in to_idpath:
1171
raise BzrError("can't move %r to a subdirectory of itself" % f)
1173
# OK, so there's a race here, it's possible that someone will
1174
# create a file in this interval and then the rename might be
1175
# left half-done. But we should have caught most problems.
1177
for f in from_paths:
1178
name_tail = splitpath(f)[-1]
1179
dest_path = appendpath(to_name, name_tail)
1180
result.append((f, dest_path))
1181
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1183
os.rename(self.abspath(f), self.abspath(dest_path))
1185
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1186
["rename rolled back"])
1188
self._write_inventory(inv)
1195
def revert(self, filenames, old_tree=None, backups=True):
1196
"""Restore selected files to the versions from a previous tree.
1199
If true (default) backups are made of files before
1202
from bzrlib.errors import NotVersionedError, BzrError
1203
from bzrlib.atomicfile import AtomicFile
1204
from bzrlib.osutils import backup_file
1206
inv = self.read_working_inventory()
1207
if old_tree is None:
1208
old_tree = self.basis_tree()
1209
old_inv = old_tree.inventory
1212
for fn in filenames:
1213
file_id = inv.path2id(fn)
1215
raise NotVersionedError("not a versioned file", fn)
1216
if not old_inv.has_id(file_id):
1217
raise BzrError("file not present in old tree", fn, file_id)
1218
nids.append((fn, file_id))
1220
# TODO: Rename back if it was previously at a different location
1222
# TODO: If given a directory, restore the entire contents from
1223
# the previous version.
1225
# TODO: Make a backup to a temporary file.
1227
# TODO: If the file previously didn't exist, delete it?
1228
for fn, file_id in nids:
1231
f = AtomicFile(fn, 'wb')
1233
f.write(old_tree.get_file(file_id).read())
1239
def pending_merges(self):
1240
"""Return a list of pending merges.
1242
These are revisions that have been merged into the working
1243
directory but not yet committed.
1245
cfn = self.controlfilename('pending-merges')
1246
if not os.path.exists(cfn):
1249
for l in self.controlfile('pending-merges', 'r').readlines():
1250
p.append(l.rstrip('\n'))
1254
def add_pending_merge(self, revision_id):
1255
from bzrlib.revision import validate_revision_id
1257
validate_revision_id(revision_id)
1259
p = self.pending_merges()
1260
if revision_id in p:
1262
p.append(revision_id)
1263
self.set_pending_merges(p)
1266
def set_pending_merges(self, rev_list):
1267
from bzrlib.atomicfile import AtomicFile
1270
f = AtomicFile(self.controlfilename('pending-merges'))
968
"""Return `Tree` object for last revision."""
969
return self.repository.revision_tree(self.last_revision())
1281
971
def get_parent(self):
1282
972
"""Return the parent location of the branch.
1284
This is the default location for push/pull/missing. The usual
1285
pattern is that the user can override it by specifying a
1289
_locs = ['parent', 'pull', 'x-pull']
974
This is the default location for pull/missing. The usual
975
pattern is that the user can override it by specifying a
978
parent = self._get_parent_location()
981
# This is an old-format absolute path to a local branch
983
if parent.startswith('/'):
984
parent = urlutils.local_path_to_url(parent.decode('utf8'))
986
return urlutils.join(self.base[:-1], parent)
987
except errors.InvalidURLJoin, e:
988
raise errors.InaccessibleParent(parent, self.base)
990
def _get_parent_location(self):
991
raise NotImplementedError(self._get_parent_location)
993
def _set_config_location(self, name, url, config=None,
994
make_relative=False):
996
config = self.get_config()
1000
url = urlutils.relative_url(self.base, url)
1001
config.set_user_option(name, url, warn_masked=True)
1003
def _get_config_location(self, name, config=None):
1005
config = self.get_config()
1006
location = config.get_user_option(name)
1011
def get_child_submit_format(self):
1012
"""Return the preferred format of submissions to this branch."""
1013
return self.get_config().get_user_option("child_submit_format")
1015
def get_submit_branch(self):
1016
"""Return the submit location of the branch.
1018
This is the default location for bundle. The usual
1019
pattern is that the user can override it by specifying a
1022
return self.get_config().get_user_option('submit_branch')
1024
def set_submit_branch(self, location):
1025
"""Return the submit location of the branch.
1027
This is the default location for bundle. The usual
1028
pattern is that the user can override it by specifying a
1031
self.get_config().set_user_option('submit_branch', location,
1034
def get_public_branch(self):
1035
"""Return the public location of the branch.
1037
This is used by merge directives.
1039
return self._get_config_location('public_branch')
1041
def set_public_branch(self, location):
1042
"""Return the submit location of the branch.
1044
This is the default location for bundle. The usual
1045
pattern is that the user can override it by specifying a
1048
self._set_config_location('public_branch', location)
1050
def get_push_location(self):
1051
"""Return the None or the location to push this branch to."""
1052
push_loc = self.get_config().get_user_option('push_location')
1055
def set_push_location(self, location):
1056
"""Set a new push location for this branch."""
1057
raise NotImplementedError(self.set_push_location)
1059
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1060
"""Run the post_change_branch_tip hooks."""
1061
hooks = Branch.hooks['post_change_branch_tip']
1064
new_revno, new_revid = self.last_revision_info()
1065
params = ChangeBranchTipParams(
1066
self, old_revno, new_revno, old_revid, new_revid)
1070
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
1071
"""Run the pre_change_branch_tip hooks."""
1072
hooks = Branch.hooks['pre_change_branch_tip']
1075
old_revno, old_revid = self.last_revision_info()
1076
params = ChangeBranchTipParams(
1077
self, old_revno, new_revno, old_revid, new_revid)
1292
return self.controlfile(l, 'r').read().strip('\n')
1294
if e.errno != errno.ENOENT:
1081
except errors.TipChangeRejected:
1084
exc_info = sys.exc_info()
1085
hook_name = Branch.hooks.get_hook_name(hook)
1086
raise errors.HookFailed(
1087
'pre_change_branch_tip', hook_name, exc_info)
1091
"""Synchronise this branch with the master branch if any.
1093
:return: None or the last_revision pivoted out during the update.
1299
def set_parent(self, url):
1300
# TODO: Maybe delete old location files?
1301
from bzrlib.atomicfile import AtomicFile
1304
f = AtomicFile(self.controlfilename('parent'))
1313
1097
def check_revno(self, revno):
1315
1099
Check whether a revno corresponds to any revision.
1319
1103
self.check_real_revno(revno)
1321
1105
def check_real_revno(self, revno):
1323
1107
Check whether a revno corresponds to a real revision.
1324
1108
Zero (the NULL revision) is considered invalid
1326
1110
if revno < 1 or revno > self.revno():
1327
raise InvalidRevisionNumber(revno)
1332
class ScratchBranch(Branch):
1333
"""Special test class: a branch that cleans up after itself.
1335
>>> b = ScratchBranch()
1343
def __init__(self, files=[], dirs=[], base=None):
1344
"""Make a test branch.
1346
This creates a temporary directory and runs init-tree in it.
1348
If any files are listed, they are created in the working copy.
1350
from tempfile import mkdtemp
1355
Branch.__init__(self, base, init=init)
1357
os.mkdir(self.abspath(d))
1360
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
1365
>>> orig = ScratchBranch(files=["file1", "file2"])
1366
>>> clone = orig.clone()
1367
>>> os.path.samefile(orig.base, clone.base)
1369
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1372
from shutil import copytree
1373
from tempfile import mkdtemp
1376
copytree(self.base, base, symlinks=True)
1377
return ScratchBranch(base=base)
1385
"""Destroy the test branch, removing the scratch directory."""
1386
from shutil import rmtree
1389
mutter("delete ScratchBranch %s" % self.base)
1392
# Work around for shutil.rmtree failing on Windows when
1393
# readonly files are encountered
1394
mutter("hit exception in destroying ScratchBranch: %s" % e)
1395
for root, dirs, files in os.walk(self.base, topdown=False):
1397
os.chmod(os.path.join(root, name), 0700)
1111
raise errors.InvalidRevisionNumber(revno)
1114
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
1115
"""Clone this branch into to_bzrdir preserving all semantic values.
1117
Most API users will want 'create_clone_on_transport', which creates a
1118
new bzrdir and branch on the fly.
1120
revision_id: if not None, the revision history in the new branch will
1121
be truncated to end with revision_id.
1123
result = to_bzrdir.create_branch()
1126
if repository_policy is not None:
1127
repository_policy.configure_branch(result)
1128
self.copy_content_into(result, revision_id=revision_id)
1134
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
1135
"""Create a new line of development from the branch, into to_bzrdir.
1137
to_bzrdir controls the branch format.
1139
revision_id: if not None, the revision history in the new branch will
1140
be truncated to end with revision_id.
1142
result = to_bzrdir.create_branch()
1145
if repository_policy is not None:
1146
repository_policy.configure_branch(result)
1147
self.copy_content_into(result, revision_id=revision_id)
1148
result.set_parent(self.bzrdir.root_transport.base)
1153
def _synchronize_history(self, destination, revision_id):
1154
"""Synchronize last revision and revision history between branches.
1156
This version is most efficient when the destination is also a
1157
BzrBranch6, but works for BzrBranch5, as long as the destination's
1158
repository contains all the lefthand ancestors of the intended
1159
last_revision. If not, set_last_revision_info will fail.
1161
:param destination: The branch to copy the history into
1162
:param revision_id: The revision-id to truncate history at. May
1163
be None to copy complete history.
1165
source_revno, source_revision_id = self.last_revision_info()
1166
if revision_id is None:
1167
revno, revision_id = source_revno, source_revision_id
1169
graph = self.repository.get_graph()
1171
revno = graph.find_distance_to_null(revision_id,
1172
[(source_revision_id, source_revno)])
1173
except errors.GhostRevisionsHaveNoRevno:
1174
# Default to 1, if we can't find anything else
1176
destination.set_last_revision_info(revno, revision_id)
1179
def copy_content_into(self, destination, revision_id=None):
1180
"""Copy the content of self into destination.
1182
revision_id: if not None, the revision history in the new branch will
1183
be truncated to end with revision_id.
1185
self.update_references(destination)
1186
self._synchronize_history(destination, revision_id)
1188
parent = self.get_parent()
1189
except errors.InaccessibleParent, e:
1190
mutter('parent was not accessible to copy: %s', e)
1193
destination.set_parent(parent)
1194
if self._push_should_merge_tags():
1195
self.tags.merge_to(destination.tags)
1197
def update_references(self, target):
1198
if not getattr(self._format, 'supports_reference_locations', False):
1200
reference_dict = self._get_all_reference_info()
1201
if len(reference_dict) == 0:
1203
old_base = self.base
1204
new_base = target.base
1205
target_reference_dict = target._get_all_reference_info()
1206
for file_id, (tree_path, branch_location) in (
1207
reference_dict.items()):
1208
branch_location = urlutils.rebase_url(branch_location,
1210
target_reference_dict.setdefault(
1211
file_id, (tree_path, branch_location))
1212
target._set_all_reference_info(target_reference_dict)
1216
"""Check consistency of the branch.
1218
In particular this checks that revisions given in the revision-history
1219
do actually match up in the revision graph, and that they're all
1220
present in the repository.
1222
Callers will typically also want to check the repository.
1224
:return: A BranchCheckResult.
1226
ret = BranchCheckResult(self)
1227
mainline_parent_id = None
1228
last_revno, last_revision_id = self.last_revision_info()
1229
real_rev_history = []
1231
for revid in self.repository.iter_reverse_revision_history(
1233
real_rev_history.append(revid)
1234
except errors.RevisionNotPresent:
1235
ret.ghosts_in_mainline = True
1237
ret.ghosts_in_mainline = False
1238
real_rev_history.reverse()
1239
if len(real_rev_history) != last_revno:
1240
raise errors.BzrCheckError('revno does not match len(mainline)'
1241
' %s != %s' % (last_revno, len(real_rev_history)))
1242
# TODO: We should probably also check that real_rev_history actually
1243
# matches self.revision_history()
1244
for revision_id in real_rev_history:
1246
revision = self.repository.get_revision(revision_id)
1247
except errors.NoSuchRevision, e:
1248
raise errors.BzrCheckError("mainline revision {%s} not in repository"
1250
# In general the first entry on the revision history has no parents.
1251
# But it's not illegal for it to have parents listed; this can happen
1252
# in imports from Arch when the parents weren't reachable.
1253
if mainline_parent_id is not None:
1254
if mainline_parent_id not in revision.parent_ids:
1255
raise errors.BzrCheckError("previous revision {%s} not listed among "
1257
% (mainline_parent_id, revision_id))
1258
mainline_parent_id = revision_id
1261
def _get_checkout_format(self):
1262
"""Return the most suitable metadir for a checkout of this branch.
1263
Weaves are used if this branch's repository uses weaves.
1265
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1266
from bzrlib.repofmt import weaverepo
1267
format = bzrdir.BzrDirMetaFormat1()
1268
format.repository_format = weaverepo.RepositoryFormat7()
1270
format = self.repository.bzrdir.checkout_metadir()
1271
format.set_branch_format(self._format)
1274
def create_clone_on_transport(self, to_transport, revision_id=None,
1275
stacked_on=None, create_prefix=False, use_existing_dir=False):
1276
"""Create a clone of this branch and its bzrdir.
1278
:param to_transport: The transport to clone onto.
1279
:param revision_id: The revision id to use as tip in the new branch.
1280
If None the tip is obtained from this branch.
1281
:param stacked_on: An optional URL to stack the clone on.
1282
:param create_prefix: Create any missing directories leading up to
1284
:param use_existing_dir: Use an existing directory if one exists.
1286
# XXX: Fix the bzrdir API to allow getting the branch back from the
1287
# clone call. Or something. 20090224 RBC/spiv.
1288
if revision_id is None:
1289
revision_id = self.last_revision()
1291
dir_to = self.bzrdir.clone_on_transport(to_transport,
1292
revision_id=revision_id, stacked_on=stacked_on,
1293
create_prefix=create_prefix, use_existing_dir=use_existing_dir)
1294
except errors.FileExists:
1295
if not use_existing_dir:
1297
except errors.NoSuchFile:
1298
if not create_prefix:
1300
return dir_to.open_branch()
1302
def create_checkout(self, to_location, revision_id=None,
1303
lightweight=False, accelerator_tree=None,
1305
"""Create a checkout of a branch.
1307
:param to_location: The url to produce the checkout at
1308
:param revision_id: The revision to check out
1309
:param lightweight: If True, produce a lightweight checkout, otherwise,
1310
produce a bound branch (heavyweight checkout)
1311
:param accelerator_tree: A tree which can be used for retrieving file
1312
contents more quickly than the revision tree, i.e. a workingtree.
1313
The revision tree will be used for cases where accelerator_tree's
1314
content is different.
1315
:param hardlink: If true, hard-link files from accelerator_tree,
1317
:return: The tree of the created checkout
1319
t = transport.get_transport(to_location)
1322
format = self._get_checkout_format()
1323
checkout = format.initialize_on_transport(t)
1324
from_branch = BranchReferenceFormat().initialize(checkout, self)
1326
format = self._get_checkout_format()
1327
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1328
to_location, force_new_tree=False, format=format)
1329
checkout = checkout_branch.bzrdir
1330
checkout_branch.bind(self)
1331
# pull up to the specified revision_id to set the initial
1332
# branch tip correctly, and seed it with history.
1333
checkout_branch.pull(self, stop_revision=revision_id)
1335
tree = checkout.create_workingtree(revision_id,
1336
from_branch=from_branch,
1337
accelerator_tree=accelerator_tree,
1339
basis_tree = tree.basis_tree()
1340
basis_tree.lock_read()
1342
for path, file_id in basis_tree.iter_references():
1343
reference_parent = self.reference_parent(file_id, path)
1344
reference_parent.create_checkout(tree.abspath(path),
1345
basis_tree.get_reference_revision(file_id, path),
1352
def reconcile(self, thorough=True):
1353
"""Make sure the data stored in this branch is consistent."""
1354
from bzrlib.reconcile import BranchReconciler
1355
reconciler = BranchReconciler(self, thorough=thorough)
1356
reconciler.reconcile()
1359
def reference_parent(self, file_id, path, possible_transports=None):
1360
"""Return the parent branch for a tree-reference file_id
1361
:param file_id: The file_id of the tree reference
1362
:param path: The path of the file_id in the tree
1363
:return: A branch associated with the file_id
1365
# FIXME should provide multiple branches, based on config
1366
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1367
possible_transports=possible_transports)
1369
def supports_tags(self):
1370
return self._format.supports_tags()
1372
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1374
"""Ensure that revision_b is a descendant of revision_a.
1376
This is a helper function for update_revisions.
1378
:raises: DivergedBranches if revision_b has diverged from revision_a.
1379
:returns: True if revision_b is a descendant of revision_a.
1381
relation = self._revision_relations(revision_a, revision_b, graph)
1382
if relation == 'b_descends_from_a':
1384
elif relation == 'diverged':
1385
raise errors.DivergedBranches(self, other_branch)
1386
elif relation == 'a_descends_from_b':
1389
raise AssertionError("invalid relation: %r" % (relation,))
1391
def _revision_relations(self, revision_a, revision_b, graph):
1392
"""Determine the relationship between two revisions.
1394
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1396
heads = graph.heads([revision_a, revision_b])
1397
if heads == set([revision_b]):
1398
return 'b_descends_from_a'
1399
elif heads == set([revision_a, revision_b]):
1400
# These branches have diverged
1402
elif heads == set([revision_a]):
1403
return 'a_descends_from_b'
1405
raise AssertionError("invalid heads: %r" % (heads,))
1408
class BranchFormat(object):
1409
"""An encapsulation of the initialization and open routines for a format.
1411
Formats provide three things:
1412
* An initialization routine,
1416
Formats are placed in an dict by their format string for reference
1417
during branch opening. Its not required that these be instances, they
1418
can be classes themselves with class methods - it simply depends on
1419
whether state is needed for a given format or not.
1421
Once a format is deprecated, just deprecate the initialize and open
1422
methods on the format class. Do not deprecate the object, as the
1423
object will be created every time regardless.
1426
_default_format = None
1427
"""The default format used for new branches."""
1430
"""The known formats."""
1432
can_set_append_revisions_only = True
1434
def __eq__(self, other):
1435
return self.__class__ is other.__class__
1437
def __ne__(self, other):
1438
return not (self == other)
1441
def find_format(klass, a_bzrdir):
1442
"""Return the format for the branch object in a_bzrdir."""
1444
transport = a_bzrdir.get_branch_transport(None)
1445
format_string = transport.get("format").read()
1446
return klass._formats[format_string]
1447
except errors.NoSuchFile:
1448
raise errors.NotBranchError(path=transport.base)
1450
raise errors.UnknownFormatError(format=format_string, kind='branch')
1453
def get_default_format(klass):
1454
"""Return the current default format."""
1455
return klass._default_format
1457
def get_reference(self, a_bzrdir):
1458
"""Get the target reference of the branch in a_bzrdir.
1460
format probing must have been completed before calling
1461
this method - it is assumed that the format of the branch
1462
in a_bzrdir is correct.
1464
:param a_bzrdir: The bzrdir to get the branch data from.
1465
:return: None if the branch is not a reference branch.
1470
def set_reference(self, a_bzrdir, to_branch):
1471
"""Set the target reference of the branch in a_bzrdir.
1473
format probing must have been completed before calling
1474
this method - it is assumed that the format of the branch
1475
in a_bzrdir is correct.
1477
:param a_bzrdir: The bzrdir to set the branch reference for.
1478
:param to_branch: branch that the checkout is to reference
1480
raise NotImplementedError(self.set_reference)
1482
def get_format_string(self):
1483
"""Return the ASCII format string that identifies this format."""
1484
raise NotImplementedError(self.get_format_string)
1486
def get_format_description(self):
1487
"""Return the short format description for this format."""
1488
raise NotImplementedError(self.get_format_description)
1490
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
1492
"""Initialize a branch in a bzrdir, with specified files
1494
:param a_bzrdir: The bzrdir to initialize the branch in
1495
:param utf8_files: The files to create as a list of
1496
(filename, content) tuples
1497
:param set_format: If True, set the format with
1498
self.get_format_string. (BzrBranch4 has its format set
1500
:return: a branch in this format
1502
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1503
branch_transport = a_bzrdir.get_branch_transport(self)
1505
'metadir': ('lock', lockdir.LockDir),
1506
'branch4': ('branch-lock', lockable_files.TransportLock),
1508
lock_name, lock_class = lock_map[lock_type]
1509
control_files = lockable_files.LockableFiles(branch_transport,
1510
lock_name, lock_class)
1511
control_files.create_lock()
1513
control_files.lock_write()
1514
except errors.LockContention:
1515
if lock_type != 'branch4':
1521
utf8_files += [('format', self.get_format_string())]
1523
for (filename, content) in utf8_files:
1524
branch_transport.put_bytes(
1526
mode=a_bzrdir._get_file_mode())
1529
control_files.unlock()
1530
return self.open(a_bzrdir, _found=True)
1532
def initialize(self, a_bzrdir):
1533
"""Create a branch of this format in a_bzrdir."""
1534
raise NotImplementedError(self.initialize)
1536
def is_supported(self):
1537
"""Is this format supported?
1539
Supported formats can be initialized and opened.
1540
Unsupported formats may not support initialization or committing or
1541
some other features depending on the reason for not being supported.
1545
def make_tags(self, branch):
1546
"""Create a tags object for branch.
1548
This method is on BranchFormat, because BranchFormats are reflected
1549
over the wire via network_name(), whereas full Branch instances require
1550
multiple VFS method calls to operate at all.
1552
The default implementation returns a disabled-tags instance.
1554
Note that it is normal for branch to be a RemoteBranch when using tags
1557
return DisabledTags(branch)
1559
def network_name(self):
1560
"""A simple byte string uniquely identifying this format for RPC calls.
1562
MetaDir branch formats use their disk format string to identify the
1563
repository over the wire. All in one formats such as bzr < 0.8, and
1564
foreign formats like svn/git and hg should use some marker which is
1565
unique and immutable.
1567
raise NotImplementedError(self.network_name)
1569
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1570
"""Return the branch object for a_bzrdir
1572
:param a_bzrdir: A BzrDir that contains a branch.
1573
:param _found: a private parameter, do not use it. It is used to
1574
indicate if format probing has already be done.
1575
:param ignore_fallbacks: when set, no fallback branches will be opened
1576
(if there are any). Default is to open fallbacks.
1578
raise NotImplementedError(self.open)
1581
def register_format(klass, format):
1582
"""Register a metadir format."""
1583
klass._formats[format.get_format_string()] = format
1584
# Metadir formats have a network name of their format string, and get
1585
# registered as class factories.
1586
network_format_registry.register(format.get_format_string(), format.__class__)
1589
def set_default_format(klass, format):
1590
klass._default_format = format
1592
def supports_set_append_revisions_only(self):
1593
"""True if this format supports set_append_revisions_only."""
1596
def supports_stacking(self):
1597
"""True if this format records a stacked-on branch."""
1601
def unregister_format(klass, format):
1602
del klass._formats[format.get_format_string()]
1605
return self.get_format_description().rstrip()
1607
def supports_tags(self):
1608
"""True if this format supports tags stored in the branch"""
1609
return False # by default
1612
class BranchHooks(Hooks):
1613
"""A dictionary mapping hook name to a list of callables for branch hooks.
1615
e.g. ['set_rh'] Is the list of items to be called when the
1616
set_revision_history function is invoked.
1620
"""Create the default hooks.
1622
These are all empty initially, because by default nothing should get
1625
Hooks.__init__(self)
1626
self.create_hook(HookPoint('set_rh',
1627
"Invoked whenever the revision history has been set via "
1628
"set_revision_history. The api signature is (branch, "
1629
"revision_history), and the branch will be write-locked. "
1630
"The set_rh hook can be expensive for bzr to trigger, a better "
1631
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1632
self.create_hook(HookPoint('open',
1633
"Called with the Branch object that has been opened after a "
1634
"branch is opened.", (1, 8), None))
1635
self.create_hook(HookPoint('post_push',
1636
"Called after a push operation completes. post_push is called "
1637
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1638
"bzr client.", (0, 15), None))
1639
self.create_hook(HookPoint('post_pull',
1640
"Called after a pull operation completes. post_pull is called "
1641
"with a bzrlib.branch.PullResult object and only runs in the "
1642
"bzr client.", (0, 15), None))
1643
self.create_hook(HookPoint('pre_commit',
1644
"Called after a commit is calculated but before it is is "
1645
"completed. pre_commit is called with (local, master, old_revno, "
1646
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1647
"). old_revid is NULL_REVISION for the first commit to a branch, "
1648
"tree_delta is a TreeDelta object describing changes from the "
1649
"basis revision. hooks MUST NOT modify this delta. "
1650
" future_tree is an in-memory tree obtained from "
1651
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1652
"tree.", (0,91), None))
1653
self.create_hook(HookPoint('post_commit',
1654
"Called in the bzr client after a commit has completed. "
1655
"post_commit is called with (local, master, old_revno, old_revid, "
1656
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1657
"commit to a branch.", (0, 15), None))
1658
self.create_hook(HookPoint('post_uncommit',
1659
"Called in the bzr client after an uncommit completes. "
1660
"post_uncommit is called with (local, master, old_revno, "
1661
"old_revid, new_revno, new_revid) where local is the local branch "
1662
"or None, master is the target branch, and an empty branch "
1663
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1664
self.create_hook(HookPoint('pre_change_branch_tip',
1665
"Called in bzr client and server before a change to the tip of a "
1666
"branch is made. pre_change_branch_tip is called with a "
1667
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1668
"commit, uncommit will all trigger this hook.", (1, 6), None))
1669
self.create_hook(HookPoint('post_change_branch_tip',
1670
"Called in bzr client and server after a change to the tip of a "
1671
"branch is made. post_change_branch_tip is called with a "
1672
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1673
"commit, uncommit will all trigger this hook.", (1, 4), None))
1674
self.create_hook(HookPoint('transform_fallback_location',
1675
"Called when a stacked branch is activating its fallback "
1676
"locations. transform_fallback_location is called with (branch, "
1677
"url), and should return a new url. Returning the same url "
1678
"allows it to be used as-is, returning a different one can be "
1679
"used to cause the branch to stack on a closer copy of that "
1680
"fallback_location. Note that the branch cannot have history "
1681
"accessing methods called on it during this hook because the "
1682
"fallback locations have not been activated. When there are "
1683
"multiple hooks installed for transform_fallback_location, "
1684
"all are called with the url returned from the previous hook."
1685
"The order is however undefined.", (1, 9), None))
1688
# install the default hooks into the Branch class.
1689
Branch.hooks = BranchHooks()
1692
class ChangeBranchTipParams(object):
1693
"""Object holding parameters passed to *_change_branch_tip hooks.
1695
There are 5 fields that hooks may wish to access:
1697
:ivar branch: the branch being changed
1698
:ivar old_revno: revision number before the change
1699
:ivar new_revno: revision number after the change
1700
:ivar old_revid: revision id before the change
1701
:ivar new_revid: revision id after the change
1703
The revid fields are strings. The revno fields are integers.
1706
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1707
"""Create a group of ChangeBranchTip parameters.
1709
:param branch: The branch being changed.
1710
:param old_revno: Revision number before the change.
1711
:param new_revno: Revision number after the change.
1712
:param old_revid: Tip revision id before the change.
1713
:param new_revid: Tip revision id after the change.
1715
self.branch = branch
1716
self.old_revno = old_revno
1717
self.new_revno = new_revno
1718
self.old_revid = old_revid
1719
self.new_revid = new_revid
1721
def __eq__(self, other):
1722
return self.__dict__ == other.__dict__
1725
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1726
self.__class__.__name__, self.branch,
1727
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1730
class BzrBranchFormat4(BranchFormat):
1731
"""Bzr branch format 4.
1734
- a revision-history file.
1735
- a branch-lock lock file [ to be shared with the bzrdir ]
1738
def get_format_description(self):
1739
"""See BranchFormat.get_format_description()."""
1740
return "Branch format 4"
1742
def initialize(self, a_bzrdir):
1743
"""Create a branch of this format in a_bzrdir."""
1744
utf8_files = [('revision-history', ''),
1745
('branch-name', ''),
1747
return self._initialize_helper(a_bzrdir, utf8_files,
1748
lock_type='branch4', set_format=False)
1751
super(BzrBranchFormat4, self).__init__()
1752
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1754
def network_name(self):
1755
"""The network name for this format is the control dirs disk label."""
1756
return self._matchingbzrdir.get_format_string()
1758
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1759
"""See BranchFormat.open()."""
1761
# we are being called directly and must probe.
1762
raise NotImplementedError
1763
return BzrBranch(_format=self,
1764
_control_files=a_bzrdir._control_files,
1766
_repository=a_bzrdir.open_repository())
1769
return "Bazaar-NG branch format 4"
1772
class BranchFormatMetadir(BranchFormat):
1773
"""Common logic for meta-dir based branch formats."""
1775
def _branch_class(self):
1776
"""What class to instantiate on open calls."""
1777
raise NotImplementedError(self._branch_class)
1779
def network_name(self):
1780
"""A simple byte string uniquely identifying this format for RPC calls.
1782
Metadir branch formats use their format string.
1784
return self.get_format_string()
1786
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1787
"""See BranchFormat.open()."""
1789
format = BranchFormat.find_format(a_bzrdir)
1790
if format.__class__ != self.__class__:
1791
raise AssertionError("wrong format %r found for %r" %
1794
transport = a_bzrdir.get_branch_transport(None)
1795
control_files = lockable_files.LockableFiles(transport, 'lock',
1797
return self._branch_class()(_format=self,
1798
_control_files=control_files,
1800
_repository=a_bzrdir.find_repository(),
1801
ignore_fallbacks=ignore_fallbacks)
1802
except errors.NoSuchFile:
1803
raise errors.NotBranchError(path=transport.base)
1806
super(BranchFormatMetadir, self).__init__()
1807
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1808
self._matchingbzrdir.set_branch_format(self)
1810
def supports_tags(self):
1814
class BzrBranchFormat5(BranchFormatMetadir):
1815
"""Bzr branch format 5.
1818
- a revision-history file.
1820
- a lock dir guarding the branch itself
1821
- all of this stored in a branch/ subdirectory
1822
- works with shared repositories.
1824
This format is new in bzr 0.8.
1827
def _branch_class(self):
1830
def get_format_string(self):
1831
"""See BranchFormat.get_format_string()."""
1832
return "Bazaar-NG branch format 5\n"
1834
def get_format_description(self):
1835
"""See BranchFormat.get_format_description()."""
1836
return "Branch format 5"
1838
def initialize(self, a_bzrdir):
1839
"""Create a branch of this format in a_bzrdir."""
1840
utf8_files = [('revision-history', ''),
1841
('branch-name', ''),
1843
return self._initialize_helper(a_bzrdir, utf8_files)
1845
def supports_tags(self):
1849
class BzrBranchFormat6(BranchFormatMetadir):
1850
"""Branch format with last-revision and tags.
1852
Unlike previous formats, this has no explicit revision history. Instead,
1853
this just stores the last-revision, and the left-hand history leading
1854
up to there is the history.
1856
This format was introduced in bzr 0.15
1857
and became the default in 0.91.
1860
def _branch_class(self):
1863
def get_format_string(self):
1864
"""See BranchFormat.get_format_string()."""
1865
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1867
def get_format_description(self):
1868
"""See BranchFormat.get_format_description()."""
1869
return "Branch format 6"
1871
def initialize(self, a_bzrdir):
1872
"""Create a branch of this format in a_bzrdir."""
1873
utf8_files = [('last-revision', '0 null:\n'),
1874
('branch.conf', ''),
1877
return self._initialize_helper(a_bzrdir, utf8_files)
1879
def make_tags(self, branch):
1880
"""See bzrlib.branch.BranchFormat.make_tags()."""
1881
return BasicTags(branch)
1883
def supports_set_append_revisions_only(self):
1887
class BzrBranchFormat8(BranchFormatMetadir):
1888
"""Metadir format supporting storing locations of subtree branches."""
1890
def _branch_class(self):
1893
def get_format_string(self):
1894
"""See BranchFormat.get_format_string()."""
1895
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
1897
def get_format_description(self):
1898
"""See BranchFormat.get_format_description()."""
1899
return "Branch format 8"
1901
def initialize(self, a_bzrdir):
1902
"""Create a branch of this format in a_bzrdir."""
1903
utf8_files = [('last-revision', '0 null:\n'),
1904
('branch.conf', ''),
1908
return self._initialize_helper(a_bzrdir, utf8_files)
1911
super(BzrBranchFormat8, self).__init__()
1912
self._matchingbzrdir.repository_format = \
1913
RepositoryFormatKnitPack5RichRoot()
1915
def make_tags(self, branch):
1916
"""See bzrlib.branch.BranchFormat.make_tags()."""
1917
return BasicTags(branch)
1919
def supports_set_append_revisions_only(self):
1922
def supports_stacking(self):
1925
supports_reference_locations = True
1928
class BzrBranchFormat7(BzrBranchFormat8):
1929
"""Branch format with last-revision, tags, and a stacked location pointer.
1931
The stacked location pointer is passed down to the repository and requires
1932
a repository format with supports_external_lookups = True.
1934
This format was introduced in bzr 1.6.
1937
def initialize(self, a_bzrdir):
1938
"""Create a branch of this format in a_bzrdir."""
1939
utf8_files = [('last-revision', '0 null:\n'),
1940
('branch.conf', ''),
1943
return self._initialize_helper(a_bzrdir, utf8_files)
1945
def _branch_class(self):
1948
def get_format_string(self):
1949
"""See BranchFormat.get_format_string()."""
1950
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
1952
def get_format_description(self):
1953
"""See BranchFormat.get_format_description()."""
1954
return "Branch format 7"
1956
def supports_set_append_revisions_only(self):
1959
supports_reference_locations = False
1962
class BranchReferenceFormat(BranchFormat):
1963
"""Bzr branch reference format.
1965
Branch references are used in implementing checkouts, they
1966
act as an alias to the real branch which is at some other url.
1973
def get_format_string(self):
1974
"""See BranchFormat.get_format_string()."""
1975
return "Bazaar-NG Branch Reference Format 1\n"
1977
def get_format_description(self):
1978
"""See BranchFormat.get_format_description()."""
1979
return "Checkout reference format 1"
1981
def get_reference(self, a_bzrdir):
1982
"""See BranchFormat.get_reference()."""
1983
transport = a_bzrdir.get_branch_transport(None)
1984
return transport.get('location').read()
1986
def set_reference(self, a_bzrdir, to_branch):
1987
"""See BranchFormat.set_reference()."""
1988
transport = a_bzrdir.get_branch_transport(None)
1989
location = transport.put_bytes('location', to_branch.base)
1991
def initialize(self, a_bzrdir, target_branch=None):
1992
"""Create a branch of this format in a_bzrdir."""
1993
if target_branch is None:
1994
# this format does not implement branch itself, thus the implicit
1995
# creation contract must see it as uninitializable
1996
raise errors.UninitializableFormat(self)
1997
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1998
branch_transport = a_bzrdir.get_branch_transport(self)
1999
branch_transport.put_bytes('location',
2000
target_branch.bzrdir.root_transport.base)
2001
branch_transport.put_bytes('format', self.get_format_string())
2003
a_bzrdir, _found=True,
2004
possible_transports=[target_branch.bzrdir.root_transport])
2007
super(BranchReferenceFormat, self).__init__()
2008
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2009
self._matchingbzrdir.set_branch_format(self)
2011
def _make_reference_clone_function(format, a_branch):
2012
"""Create a clone() routine for a branch dynamically."""
2013
def clone(to_bzrdir, revision_id=None,
2014
repository_policy=None):
2015
"""See Branch.clone()."""
2016
return format.initialize(to_bzrdir, a_branch)
2017
# cannot obey revision_id limits when cloning a reference ...
2018
# FIXME RBC 20060210 either nuke revision_id for clone, or
2019
# emit some sort of warning/error to the caller ?!
2022
def open(self, a_bzrdir, _found=False, location=None,
2023
possible_transports=None, ignore_fallbacks=False):
2024
"""Return the branch that the branch reference in a_bzrdir points at.
2026
:param a_bzrdir: A BzrDir that contains a branch.
2027
:param _found: a private parameter, do not use it. It is used to
2028
indicate if format probing has already be done.
2029
:param ignore_fallbacks: when set, no fallback branches will be opened
2030
(if there are any). Default is to open fallbacks.
2031
:param location: The location of the referenced branch. If
2032
unspecified, this will be determined from the branch reference in
2034
:param possible_transports: An optional reusable transports list.
2037
format = BranchFormat.find_format(a_bzrdir)
2038
if format.__class__ != self.__class__:
2039
raise AssertionError("wrong format %r found for %r" %
2041
if location is None:
2042
location = self.get_reference(a_bzrdir)
2043
real_bzrdir = bzrdir.BzrDir.open(
2044
location, possible_transports=possible_transports)
2045
result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
2046
# this changes the behaviour of result.clone to create a new reference
2047
# rather than a copy of the content of the branch.
2048
# I did not use a proxy object because that needs much more extensive
2049
# testing, and we are only changing one behaviour at the moment.
2050
# If we decide to alter more behaviours - i.e. the implicit nickname
2051
# then this should be refactored to introduce a tested proxy branch
2052
# and a subclass of that for use in overriding clone() and ....
2054
result.clone = self._make_reference_clone_function(result)
2058
network_format_registry = registry.FormatRegistry()
2059
"""Registry of formats indexed by their network name.
2061
The network name for a branch format is an identifier that can be used when
2062
referring to formats with smart server operations. See
2063
BranchFormat.network_name() for more detail.
2067
# formats which have no format string are not discoverable
2068
# and not independently creatable, so are not registered.
2069
__format5 = BzrBranchFormat5()
2070
__format6 = BzrBranchFormat6()
2071
__format7 = BzrBranchFormat7()
2072
__format8 = BzrBranchFormat8()
2073
BranchFormat.register_format(__format5)
2074
BranchFormat.register_format(BranchReferenceFormat())
2075
BranchFormat.register_format(__format6)
2076
BranchFormat.register_format(__format7)
2077
BranchFormat.register_format(__format8)
2078
BranchFormat.set_default_format(__format6)
2079
_legacy_formats = [BzrBranchFormat4(),
2081
network_format_registry.register(
2082
_legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2085
class BzrBranch(Branch):
2086
"""A branch stored in the actual filesystem.
2088
Note that it's "local" in the context of the filesystem; it doesn't
2089
really matter if it's on an nfs/smb/afs/coda/... share, as long as
2090
it's writable, and can be accessed via the normal filesystem API.
2092
:ivar _transport: Transport for file operations on this branch's
2093
control files, typically pointing to the .bzr/branch directory.
2094
:ivar repository: Repository for this branch.
2095
:ivar base: The url of the base directory for this branch; the one
2096
containing the .bzr directory.
2099
def __init__(self, _format=None,
2100
_control_files=None, a_bzrdir=None, _repository=None,
2101
ignore_fallbacks=False):
2102
"""Create new branch object at a particular location."""
2103
if a_bzrdir is None:
2104
raise ValueError('a_bzrdir must be supplied')
2106
self.bzrdir = a_bzrdir
2107
self._base = self.bzrdir.transport.clone('..').base
2108
# XXX: We should be able to just do
2109
# self.base = self.bzrdir.root_transport.base
2110
# but this does not quite work yet -- mbp 20080522
2111
self._format = _format
2112
if _control_files is None:
2113
raise ValueError('BzrBranch _control_files is None')
2114
self.control_files = _control_files
2115
self._transport = _control_files._transport
2116
self.repository = _repository
2117
Branch.__init__(self)
2120
return '%s(%r)' % (self.__class__.__name__, self.base)
2124
def _get_base(self):
2125
"""Returns the directory containing the control directory."""
2128
base = property(_get_base, doc="The URL for the root of this branch.")
2130
def _get_config(self):
2131
return TransportConfig(self._transport, 'branch.conf')
2133
def is_locked(self):
2134
return self.control_files.is_locked()
2136
def lock_write(self, token=None):
2137
# All-in-one needs to always unlock/lock.
2138
repo_control = getattr(self.repository, 'control_files', None)
2139
if self.control_files == repo_control or not self.is_locked():
2140
self.repository.lock_write()
2145
return self.control_files.lock_write(token=token)
2148
self.repository.unlock()
2151
def lock_read(self):
2152
# All-in-one needs to always unlock/lock.
2153
repo_control = getattr(self.repository, 'control_files', None)
2154
if self.control_files == repo_control or not self.is_locked():
2155
self.repository.lock_read()
2160
self.control_files.lock_read()
2163
self.repository.unlock()
2168
self.control_files.unlock()
2170
# All-in-one needs to always unlock/lock.
2171
repo_control = getattr(self.repository, 'control_files', None)
2172
if (self.control_files == repo_control or
2173
not self.control_files.is_locked()):
2174
self.repository.unlock()
2175
if not self.control_files.is_locked():
2176
# we just released the lock
2177
self._clear_cached_state()
2179
def peek_lock_mode(self):
2180
if self.control_files._lock_count == 0:
2183
return self.control_files._lock_mode
2185
def get_physical_lock_status(self):
2186
return self.control_files.get_physical_lock_status()
2189
def print_file(self, file, revision_id):
2190
"""See Branch.print_file."""
2191
return self.repository.print_file(file, revision_id)
2193
def _write_revision_history(self, history):
2194
"""Factored out of set_revision_history.
2196
This performs the actual writing to disk.
2197
It is intended to be called by BzrBranch5.set_revision_history."""
2198
self._transport.put_bytes(
2199
'revision-history', '\n'.join(history),
2200
mode=self.bzrdir._get_file_mode())
2203
def set_revision_history(self, rev_history):
2204
"""See Branch.set_revision_history."""
2205
if 'evil' in debug.debug_flags:
2206
mutter_callsite(3, "set_revision_history scales with history.")
2207
check_not_reserved_id = _mod_revision.check_not_reserved_id
2208
for rev_id in rev_history:
2209
check_not_reserved_id(rev_id)
2210
if Branch.hooks['post_change_branch_tip']:
2211
# Don't calculate the last_revision_info() if there are no hooks
2213
old_revno, old_revid = self.last_revision_info()
2214
if len(rev_history) == 0:
2215
revid = _mod_revision.NULL_REVISION
2217
revid = rev_history[-1]
2218
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2219
self._write_revision_history(rev_history)
2220
self._clear_cached_state()
2221
self._cache_revision_history(rev_history)
2222
for hook in Branch.hooks['set_rh']:
2223
hook(self, rev_history)
2224
if Branch.hooks['post_change_branch_tip']:
2225
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2227
def _synchronize_history(self, destination, revision_id):
2228
"""Synchronize last revision and revision history between branches.
2230
This version is most efficient when the destination is also a
2231
BzrBranch5, but works for BzrBranch6 as long as the revision
2232
history is the true lefthand parent history, and all of the revisions
2233
are in the destination's repository. If not, set_revision_history
2236
:param destination: The branch to copy the history into
2237
:param revision_id: The revision-id to truncate history at. May
2238
be None to copy complete history.
2240
if not isinstance(destination._format, BzrBranchFormat5):
2241
super(BzrBranch, self)._synchronize_history(
2242
destination, revision_id)
2244
if revision_id == _mod_revision.NULL_REVISION:
2247
new_history = self.revision_history()
2248
if revision_id is not None and new_history != []:
2250
new_history = new_history[:new_history.index(revision_id) + 1]
2252
rev = self.repository.get_revision(revision_id)
2253
new_history = rev.get_history(self.repository)[1:]
2254
destination.set_revision_history(new_history)
2257
def set_last_revision_info(self, revno, revision_id):
2258
"""Set the last revision of this branch.
2260
The caller is responsible for checking that the revno is correct
2261
for this revision id.
2263
It may be possible to set the branch last revision to an id not
2264
present in the repository. However, branches can also be
2265
configured to check constraints on history, in which case this may not
2268
revision_id = _mod_revision.ensure_null(revision_id)
2269
# this old format stores the full history, but this api doesn't
2270
# provide it, so we must generate, and might as well check it's
2272
history = self._lefthand_history(revision_id)
2273
if len(history) != revno:
2274
raise AssertionError('%d != %d' % (len(history), revno))
2275
self.set_revision_history(history)
2277
def _gen_revision_history(self):
2278
history = self._transport.get_bytes('revision-history').split('\n')
2279
if history[-1:] == ['']:
2280
# There shouldn't be a trailing newline, but just in case.
2285
def generate_revision_history(self, revision_id, last_rev=None,
2287
"""Create a new revision history that will finish with revision_id.
2289
:param revision_id: the new tip to use.
2290
:param last_rev: The previous last_revision. If not None, then this
2291
must be a ancestory of revision_id, or DivergedBranches is raised.
2292
:param other_branch: The other branch that DivergedBranches should
2293
raise with respect to.
2295
self.set_revision_history(self._lefthand_history(revision_id,
2296
last_rev, other_branch))
2298
def basis_tree(self):
2299
"""See Branch.basis_tree."""
2300
return self.repository.revision_tree(self.last_revision())
2302
def _get_parent_location(self):
2303
_locs = ['parent', 'pull', 'x-pull']
2306
return self._transport.get_bytes(l).strip('\n')
2307
except errors.NoSuchFile:
2311
def _basic_push(self, target, overwrite, stop_revision):
2312
"""Basic implementation of push without bound branches or hooks.
2314
Must be called with source read locked and target write locked.
2316
result = BranchPushResult()
2317
result.source_branch = self
2318
result.target_branch = target
2319
result.old_revno, result.old_revid = target.last_revision_info()
2320
self.update_references(target)
2321
if result.old_revid != self.last_revision():
2322
# We assume that during 'push' this repository is closer than
2324
graph = self.repository.get_graph(target.repository)
2325
target.update_revisions(self, stop_revision,
2326
overwrite=overwrite, graph=graph)
2327
if self._push_should_merge_tags():
2328
result.tag_conflicts = self.tags.merge_to(target.tags,
2330
result.new_revno, result.new_revid = target.last_revision_info()
2333
def get_stacked_on_url(self):
2334
raise errors.UnstackableBranchFormat(self._format, self.base)
2336
def set_push_location(self, location):
2337
"""See Branch.set_push_location."""
2338
self.get_config().set_user_option(
2339
'push_location', location,
2340
store=_mod_config.STORE_LOCATION_NORECURSE)
2342
def _set_parent_location(self, url):
2344
self._transport.delete('parent')
2346
self._transport.put_bytes('parent', url + '\n',
2347
mode=self.bzrdir._get_file_mode())
2350
class BzrBranch5(BzrBranch):
2351
"""A format 5 branch. This supports new features over plain branches.
2353
It has support for a master_branch which is the data for bound branches.
2356
def get_bound_location(self):
2358
return self._transport.get_bytes('bound')[:-1]
2359
except errors.NoSuchFile:
2363
def get_master_branch(self, possible_transports=None):
2364
"""Return the branch we are bound to.
2366
:return: Either a Branch, or None
2368
This could memoise the branch, but if thats done
2369
it must be revalidated on each new lock.
2370
So for now we just don't memoise it.
2371
# RBC 20060304 review this decision.
2373
bound_loc = self.get_bound_location()
2377
return Branch.open(bound_loc,
2378
possible_transports=possible_transports)
2379
except (errors.NotBranchError, errors.ConnectionError), e:
2380
raise errors.BoundBranchConnectionFailure(
2384
def set_bound_location(self, location):
2385
"""Set the target where this branch is bound to.
2387
:param location: URL to the target branch
2390
self._transport.put_bytes('bound', location+'\n',
2391
mode=self.bzrdir._get_file_mode())
2394
self._transport.delete('bound')
2395
except errors.NoSuchFile:
2400
def bind(self, other):
2401
"""Bind this branch to the branch other.
2403
This does not push or pull data between the branches, though it does
2404
check for divergence to raise an error when the branches are not
2405
either the same, or one a prefix of the other. That behaviour may not
2406
be useful, so that check may be removed in future.
2408
:param other: The branch to bind to
2411
# TODO: jam 20051230 Consider checking if the target is bound
2412
# It is debatable whether you should be able to bind to
2413
# a branch which is itself bound.
2414
# Committing is obviously forbidden,
2415
# but binding itself may not be.
2416
# Since we *have* to check at commit time, we don't
2417
# *need* to check here
2419
# we want to raise diverged if:
2420
# last_rev is not in the other_last_rev history, AND
2421
# other_last_rev is not in our history, and do it without pulling
2423
self.set_bound_location(other.base)
2427
"""If bound, unbind"""
2428
return self.set_bound_location(None)
2431
def update(self, possible_transports=None):
2432
"""Synchronise this branch with the master branch if any.
2434
:return: None or the last_revision that was pivoted out during the
2437
master = self.get_master_branch(possible_transports)
2438
if master is not None:
2439
old_tip = _mod_revision.ensure_null(self.last_revision())
2440
self.pull(master, overwrite=True)
2441
if self.repository.get_graph().is_ancestor(old_tip,
2442
_mod_revision.ensure_null(self.last_revision())):
2448
class BzrBranch8(BzrBranch5):
2449
"""A branch that stores tree-reference locations."""
2451
def _open_hook(self):
2452
if self._ignore_fallbacks:
2455
url = self.get_stacked_on_url()
2456
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2457
errors.UnstackableBranchFormat):
2460
for hook in Branch.hooks['transform_fallback_location']:
2461
url = hook(self, url)
2463
hook_name = Branch.hooks.get_hook_name(hook)
2464
raise AssertionError(
2465
"'transform_fallback_location' hook %s returned "
2466
"None, not a URL." % hook_name)
2467
self._activate_fallback_location(url)
2469
def __init__(self, *args, **kwargs):
2470
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2471
super(BzrBranch8, self).__init__(*args, **kwargs)
2472
self._last_revision_info_cache = None
2473
self._reference_info = None
2475
def _clear_cached_state(self):
2476
super(BzrBranch8, self)._clear_cached_state()
2477
self._last_revision_info_cache = None
2478
self._reference_info = None
2480
def _last_revision_info(self):
2481
revision_string = self._transport.get_bytes('last-revision')
2482
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2483
revision_id = cache_utf8.get_cached_utf8(revision_id)
2485
return revno, revision_id
2487
def _write_last_revision_info(self, revno, revision_id):
2488
"""Simply write out the revision id, with no checks.
2490
Use set_last_revision_info to perform this safely.
2492
Does not update the revision_history cache.
2493
Intended to be called by set_last_revision_info and
2494
_write_revision_history.
2496
revision_id = _mod_revision.ensure_null(revision_id)
2497
out_string = '%d %s\n' % (revno, revision_id)
2498
self._transport.put_bytes('last-revision', out_string,
2499
mode=self.bzrdir._get_file_mode())
2502
def set_last_revision_info(self, revno, revision_id):
2503
revision_id = _mod_revision.ensure_null(revision_id)
2504
old_revno, old_revid = self.last_revision_info()
2505
if self._get_append_revisions_only():
2506
self._check_history_violation(revision_id)
2507
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2508
self._write_last_revision_info(revno, revision_id)
2509
self._clear_cached_state()
2510
self._last_revision_info_cache = revno, revision_id
2511
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2513
def _synchronize_history(self, destination, revision_id):
2514
"""Synchronize last revision and revision history between branches.
2516
:see: Branch._synchronize_history
2518
# XXX: The base Branch has a fast implementation of this method based
2519
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2520
# that uses set_revision_history. This class inherits from BzrBranch5,
2521
# but wants the fast implementation, so it calls
2522
# Branch._synchronize_history directly.
2523
Branch._synchronize_history(self, destination, revision_id)
2525
def _check_history_violation(self, revision_id):
2526
last_revision = _mod_revision.ensure_null(self.last_revision())
2527
if _mod_revision.is_null(last_revision):
2529
if last_revision not in self._lefthand_history(revision_id):
2530
raise errors.AppendRevisionsOnlyViolation(self.base)
2532
def _gen_revision_history(self):
2533
"""Generate the revision history from last revision
2535
last_revno, last_revision = self.last_revision_info()
2536
self._extend_partial_history(stop_index=last_revno-1)
2537
return list(reversed(self._partial_revision_history_cache))
2539
def _write_revision_history(self, history):
2540
"""Factored out of set_revision_history.
2542
This performs the actual writing to disk, with format-specific checks.
2543
It is intended to be called by BzrBranch5.set_revision_history.
2545
if len(history) == 0:
2546
last_revision = 'null:'
2548
if history != self._lefthand_history(history[-1]):
2549
raise errors.NotLefthandHistory(history)
2550
last_revision = history[-1]
2551
if self._get_append_revisions_only():
2552
self._check_history_violation(last_revision)
2553
self._write_last_revision_info(len(history), last_revision)
2556
def _set_parent_location(self, url):
2557
"""Set the parent branch"""
2558
self._set_config_location('parent_location', url, make_relative=True)
2561
def _get_parent_location(self):
2562
"""Set the parent branch"""
2563
return self._get_config_location('parent_location')
2566
def _set_all_reference_info(self, info_dict):
2567
"""Replace all reference info stored in a branch.
2569
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2572
writer = rio.RioWriter(s)
2573
for key, (tree_path, branch_location) in info_dict.iteritems():
2574
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2575
branch_location=branch_location)
2576
writer.write_stanza(stanza)
2577
self._transport.put_bytes('references', s.getvalue())
2578
self._reference_info = info_dict
2581
def _get_all_reference_info(self):
2582
"""Return all the reference info stored in a branch.
2584
:return: A dict of {file_id: (tree_path, branch_location)}
2586
if self._reference_info is not None:
2587
return self._reference_info
2588
rio_file = self._transport.get('references')
2590
stanzas = rio.read_stanzas(rio_file)
2591
info_dict = dict((s['file_id'], (s['tree_path'],
2592
s['branch_location'])) for s in stanzas)
2595
self._reference_info = info_dict
2598
def set_reference_info(self, file_id, tree_path, branch_location):
2599
"""Set the branch location to use for a tree reference.
2601
:param file_id: The file-id of the tree reference.
2602
:param tree_path: The path of the tree reference in the tree.
2603
:param branch_location: The location of the branch to retrieve tree
2606
info_dict = self._get_all_reference_info()
2607
info_dict[file_id] = (tree_path, branch_location)
2608
if None in (tree_path, branch_location):
2609
if tree_path is not None:
2610
raise ValueError('tree_path must be None when branch_location'
2612
if branch_location is not None:
2613
raise ValueError('branch_location must be None when tree_path'
2615
del info_dict[file_id]
2616
self._set_all_reference_info(info_dict)
2618
def get_reference_info(self, file_id):
2619
"""Get the tree_path and branch_location for a tree reference.
2621
:return: a tuple of (tree_path, branch_location)
2623
return self._get_all_reference_info().get(file_id, (None, None))
2625
def reference_parent(self, file_id, path, possible_transports=None):
2626
"""Return the parent branch for a tree-reference file_id.
2628
:param file_id: The file_id of the tree reference
2629
:param path: The path of the file_id in the tree
2630
:return: A branch associated with the file_id
2632
branch_location = self.get_reference_info(file_id)[1]
2633
if branch_location is None:
2634
return Branch.reference_parent(self, file_id, path,
2635
possible_transports)
2636
branch_location = urlutils.join(self.base, branch_location)
2637
return Branch.open(branch_location,
2638
possible_transports=possible_transports)
2640
def set_push_location(self, location):
2641
"""See Branch.set_push_location."""
2642
self._set_config_location('push_location', location)
2644
def set_bound_location(self, location):
2645
"""See Branch.set_push_location."""
2647
config = self.get_config()
2648
if location is None:
2649
if config.get_user_option('bound') != 'True':
2652
config.set_user_option('bound', 'False', warn_masked=True)
2655
self._set_config_location('bound_location', location,
2657
config.set_user_option('bound', 'True', warn_masked=True)
2660
def _get_bound_location(self, bound):
2661
"""Return the bound location in the config file.
2663
Return None if the bound parameter does not match"""
2664
config = self.get_config()
2665
config_bound = (config.get_user_option('bound') == 'True')
2666
if config_bound != bound:
2668
return self._get_config_location('bound_location', config=config)
2670
def get_bound_location(self):
2671
"""See Branch.set_push_location."""
2672
return self._get_bound_location(True)
2674
def get_old_bound_location(self):
2675
"""See Branch.get_old_bound_location"""
2676
return self._get_bound_location(False)
2678
def get_stacked_on_url(self):
2679
# you can always ask for the URL; but you might not be able to use it
2680
# if the repo can't support stacking.
2681
## self._check_stackable_repo()
2682
stacked_url = self._get_config_location('stacked_on_location')
2683
if stacked_url is None:
2684
raise errors.NotStacked(self)
2687
def _get_append_revisions_only(self):
2688
value = self.get_config().get_user_option('append_revisions_only')
2689
return value == 'True'
2692
def generate_revision_history(self, revision_id, last_rev=None,
2694
"""See BzrBranch5.generate_revision_history"""
2695
history = self._lefthand_history(revision_id, last_rev, other_branch)
2696
revno = len(history)
2697
self.set_last_revision_info(revno, revision_id)
2700
def get_rev_id(self, revno, history=None):
2701
"""Find the revision id of the specified revno."""
2703
return _mod_revision.NULL_REVISION
2705
last_revno, last_revision_id = self.last_revision_info()
2706
if revno <= 0 or revno > last_revno:
2707
raise errors.NoSuchRevision(self, revno)
2709
if history is not None:
2710
return history[revno - 1]
2712
index = last_revno - revno
2713
if len(self._partial_revision_history_cache) <= index:
2714
self._extend_partial_history(stop_index=index)
2715
if len(self._partial_revision_history_cache) > index:
2716
return self._partial_revision_history_cache[index]
2718
raise errors.NoSuchRevision(self, revno)
2721
def revision_id_to_revno(self, revision_id):
2722
"""Given a revision id, return its revno"""
2723
if _mod_revision.is_null(revision_id):
2726
index = self._partial_revision_history_cache.index(revision_id)
2728
self._extend_partial_history(stop_revision=revision_id)
2729
index = len(self._partial_revision_history_cache) - 1
2730
if self._partial_revision_history_cache[index] != revision_id:
2731
raise errors.NoSuchRevision(self, revision_id)
2732
return self.revno() - index
2735
class BzrBranch7(BzrBranch8):
2736
"""A branch with support for a fallback repository."""
2738
def set_reference_info(self, file_id, tree_path, branch_location):
2739
Branch.set_reference_info(self, file_id, tree_path, branch_location)
2741
def get_reference_info(self, file_id):
2742
Branch.get_reference_info(self, file_id)
2744
def reference_parent(self, file_id, path, possible_transports=None):
2745
return Branch.reference_parent(self, file_id, path,
2746
possible_transports)
2749
class BzrBranch6(BzrBranch7):
2750
"""See BzrBranchFormat6 for the capabilities of this branch.
2752
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2756
def get_stacked_on_url(self):
2757
raise errors.UnstackableBranchFormat(self._format, self.base)
1403
2760
######################################################################
1407
def is_control_file(filename):
1408
## FIXME: better check
1409
filename = os.path.normpath(filename)
1410
while filename != '':
1411
head, tail = os.path.split(filename)
1412
## mutter('check %r for control file' % ((head, tail), ))
1413
if tail == bzrlib.BZRDIR:
1415
if filename == head:
1422
def gen_file_id(name):
1423
"""Return new file id.
1425
This should probably generate proper UUIDs, but for the moment we
1426
cope with just randomness because running uuidgen every time is
1429
from binascii import hexlify
1430
from time import time
1432
# get last component
1433
idx = name.rfind('/')
1435
name = name[idx+1 : ]
1436
idx = name.rfind('\\')
1438
name = name[idx+1 : ]
1440
# make it not a hidden file
1441
name = name.lstrip('.')
1443
# remove any wierd characters; we don't escape them but rather
1444
# just pull them out
1445
name = re.sub(r'[^\w.]', '', name)
1447
s = hexlify(rand_bytes(8))
1448
return '-'.join((name, compact_date(time()), s))
1452
"""Return a new tree-root file id."""
1453
return gen_file_id('TREE_ROOT')
1456
def pull_loc(branch):
1457
# TODO: Should perhaps just make attribute be 'base' in
1458
# RemoteBranch and Branch?
1459
if hasattr(branch, "baseurl"):
1460
return branch.baseurl
1465
def copy_branch(branch_from, to_location, revision=None):
1466
"""Copy branch_from into the existing directory to_location.
1469
If not None, only revisions up to this point will be copied.
1470
The head of the new branch will be that revision.
1473
The name of a local directory that exists but is empty.
1475
from bzrlib.merge import merge
1476
from bzrlib.branch import Branch
1478
assert isinstance(branch_from, Branch)
1479
assert isinstance(to_location, basestring)
1481
br_to = Branch(to_location, init=True)
1482
br_to.set_root_id(branch_from.get_root_id())
1483
if revision is None:
1484
revno = branch_from.revno()
1486
revno, rev_id = branch_from.get_revision_info(revision)
1487
br_to.update_revisions(branch_from, stop_revision=revno)
1488
merge((to_location, -1), (to_location, 0), this_dir=to_location,
1489
check_clean=False, ignore_zero=True)
1491
from_location = pull_loc(branch_from)
1492
br_to.set_parent(pull_loc(branch_from))
2761
# results of operations
2764
class _Result(object):
2766
def _show_tag_conficts(self, to_file):
2767
if not getattr(self, 'tag_conflicts', None):
2769
to_file.write('Conflicting tags:\n')
2770
for name, value1, value2 in self.tag_conflicts:
2771
to_file.write(' %s\n' % (name, ))
2774
class PullResult(_Result):
2775
"""Result of a Branch.pull operation.
2777
:ivar old_revno: Revision number before pull.
2778
:ivar new_revno: Revision number after pull.
2779
:ivar old_revid: Tip revision id before pull.
2780
:ivar new_revid: Tip revision id after pull.
2781
:ivar source_branch: Source (local) branch object. (read locked)
2782
:ivar master_branch: Master branch of the target, or the target if no
2784
:ivar local_branch: target branch if there is a Master, else None
2785
:ivar target_branch: Target/destination branch object. (write locked)
2786
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2790
# DEPRECATED: pull used to return the change in revno
2791
return self.new_revno - self.old_revno
2793
def report(self, to_file):
2795
if self.old_revid == self.new_revid:
2796
to_file.write('No revisions to pull.\n')
2798
to_file.write('Now on revision %d.\n' % self.new_revno)
2799
self._show_tag_conficts(to_file)
2802
class BranchPushResult(_Result):
2803
"""Result of a Branch.push operation.
2805
:ivar old_revno: Revision number (eg 10) of the target before push.
2806
:ivar new_revno: Revision number (eg 12) of the target after push.
2807
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
2809
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
2811
:ivar source_branch: Source branch object that the push was from. This is
2812
read locked, and generally is a local (and thus low latency) branch.
2813
:ivar master_branch: If target is a bound branch, the master branch of
2814
target, or target itself. Always write locked.
2815
:ivar target_branch: The direct Branch where data is being sent (write
2817
:ivar local_branch: If the target is a bound branch this will be the
2818
target, otherwise it will be None.
2822
# DEPRECATED: push used to return the change in revno
2823
return self.new_revno - self.old_revno
2825
def report(self, to_file):
2826
"""Write a human-readable description of the result."""
2827
if self.old_revid == self.new_revid:
2828
note('No new revisions to push.')
2830
note('Pushed up to revision %d.' % self.new_revno)
2831
self._show_tag_conficts(to_file)
2834
class BranchCheckResult(object):
2835
"""Results of checking branch consistency.
2840
def __init__(self, branch):
2841
self.branch = branch
2842
self.ghosts_in_mainline = False
2844
def report_results(self, verbose):
2845
"""Report the check results via trace.note.
2847
:param verbose: Requests more detailed display of what was checked,
2850
note('checked branch %s format %s',
2852
self.branch._format)
2853
if self.ghosts_in_mainline:
2854
note('branch contains ghosts in mainline')
2857
class Converter5to6(object):
2858
"""Perform an in-place upgrade of format 5 to format 6"""
2860
def convert(self, branch):
2861
# Data for 5 and 6 can peacefully coexist.
2862
format = BzrBranchFormat6()
2863
new_branch = format.open(branch.bzrdir, _found=True)
2865
# Copy source data into target
2866
new_branch._write_last_revision_info(*branch.last_revision_info())
2867
new_branch.set_parent(branch.get_parent())
2868
new_branch.set_bound_location(branch.get_bound_location())
2869
new_branch.set_push_location(branch.get_push_location())
2871
# New branch has no tags by default
2872
new_branch.tags._set_tag_dict({})
2874
# Copying done; now update target format
2875
new_branch._transport.put_bytes('format',
2876
format.get_format_string(),
2877
mode=new_branch.bzrdir._get_file_mode())
2879
# Clean up old files
2880
new_branch._transport.delete('revision-history')
2882
branch.set_parent(None)
2883
except errors.NoSuchFile:
2885
branch.set_bound_location(None)
2888
class Converter6to7(object):
2889
"""Perform an in-place upgrade of format 6 to format 7"""
2891
def convert(self, branch):
2892
format = BzrBranchFormat7()
2893
branch._set_config_location('stacked_on_location', '')
2894
# update target format
2895
branch._transport.put_bytes('format', format.get_format_string())
2898
class Converter7to8(object):
2899
"""Perform an in-place upgrade of format 6 to format 7"""
2901
def convert(self, branch):
2902
format = BzrBranchFormat8()
2903
branch._transport.put_bytes('references', '')
2904
# update target format
2905
branch._transport.put_bytes('format', format.get_format_string())
2908
def _run_with_write_locked_target(target, callable, *args, **kwargs):
2909
"""Run ``callable(*args, **kwargs)``, write-locking target for the
2912
_run_with_write_locked_target will attempt to release the lock it acquires.
2914
If an exception is raised by callable, then that exception *will* be
2915
propagated, even if the unlock attempt raises its own error. Thus
2916
_run_with_write_locked_target should be preferred to simply doing::
2920
return callable(*args, **kwargs)
2925
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
2926
# should share code?
2929
result = callable(*args, **kwargs)
2931
exc_info = sys.exc_info()
2935
raise exc_info[0], exc_info[1], exc_info[2]
2941
class InterBranch(InterObject):
2942
"""This class represents operations taking place between two branches.
2944
Its instances have methods like pull() and push() and contain
2945
references to the source and target repositories these operations
2946
can be carried out on.
2950
"""The available optimised InterBranch types."""
2953
def _get_branch_formats_to_test():
2954
"""Return a tuple with the Branch formats to use when testing."""
2955
raise NotImplementedError(InterBranch._get_branch_formats_to_test)
2957
def pull(self, overwrite=False, stop_revision=None,
2958
possible_transports=None, local=False):
2959
"""Mirror source into target branch.
2961
The target branch is considered to be 'local', having low latency.
2963
:returns: PullResult instance
2965
raise NotImplementedError(self.pull)
2967
def update_revisions(self, stop_revision=None, overwrite=False,
2969
"""Pull in new perfect-fit revisions.
2971
:param stop_revision: Updated until the given revision
2972
:param overwrite: Always set the branch pointer, rather than checking
2973
to see if it is a proper descendant.
2974
:param graph: A Graph object that can be used to query history
2975
information. This can be None.
2978
raise NotImplementedError(self.update_revisions)
2980
def push(self, overwrite=False, stop_revision=None,
2981
_override_hook_source_branch=None):
2982
"""Mirror the source branch into the target branch.
2984
The source branch is considered to be 'local', having low latency.
2986
raise NotImplementedError(self.push)
2989
class GenericInterBranch(InterBranch):
2990
"""InterBranch implementation that uses public Branch functions.
2994
def _get_branch_formats_to_test():
2995
return BranchFormat._default_format, BranchFormat._default_format
2997
def update_revisions(self, stop_revision=None, overwrite=False,
2999
"""See InterBranch.update_revisions()."""
3000
self.source.lock_read()
3002
other_revno, other_last_revision = self.source.last_revision_info()
3003
stop_revno = None # unknown
3004
if stop_revision is None:
3005
stop_revision = other_last_revision
3006
if _mod_revision.is_null(stop_revision):
3007
# if there are no commits, we're done.
3009
stop_revno = other_revno
3011
# what's the current last revision, before we fetch [and change it
3013
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3014
# we fetch here so that we don't process data twice in the common
3015
# case of having something to pull, and so that the check for
3016
# already merged can operate on the just fetched graph, which will
3017
# be cached in memory.
3018
self.target.fetch(self.source, stop_revision)
3019
# Check to see if one is an ancestor of the other
3022
graph = self.target.repository.get_graph()
3023
if self.target._check_if_descendant_or_diverged(
3024
stop_revision, last_rev, graph, self.source):
3025
# stop_revision is a descendant of last_rev, but we aren't
3026
# overwriting, so we're done.
3028
if stop_revno is None:
3030
graph = self.target.repository.get_graph()
3031
this_revno, this_last_revision = \
3032
self.target.last_revision_info()
3033
stop_revno = graph.find_distance_to_null(stop_revision,
3034
[(other_last_revision, other_revno),
3035
(this_last_revision, this_revno)])
3036
self.target.set_last_revision_info(stop_revno, stop_revision)
3038
self.source.unlock()
3040
def pull(self, overwrite=False, stop_revision=None,
3041
possible_transports=None, _hook_master=None, run_hooks=True,
3042
_override_hook_target=None, local=False):
3045
:param _hook_master: Private parameter - set the branch to
3046
be supplied as the master to pull hooks.
3047
:param run_hooks: Private parameter - if false, this branch
3048
is being called because it's the master of the primary branch,
3049
so it should not run its hooks.
3050
:param _override_hook_target: Private parameter - set the branch to be
3051
supplied as the target_branch to pull hooks.
3052
:param local: Only update the local branch, and not the bound branch.
3054
# This type of branch can't be bound.
3056
raise errors.LocalRequiresBoundBranch()
3057
result = PullResult()
3058
result.source_branch = self.source
3059
if _override_hook_target is None:
3060
result.target_branch = self.target
3062
result.target_branch = _override_hook_target
3063
self.source.lock_read()
3065
# We assume that during 'pull' the target repository is closer than
3067
self.source.update_references(self.target)
3068
graph = self.target.repository.get_graph(self.source.repository)
3069
# TODO: Branch formats should have a flag that indicates
3070
# that revno's are expensive, and pull() should honor that flag.
3072
result.old_revno, result.old_revid = \
3073
self.target.last_revision_info()
3074
self.target.update_revisions(self.source, stop_revision,
3075
overwrite=overwrite, graph=graph)
3076
# TODO: The old revid should be specified when merging tags,
3077
# so a tags implementation that versions tags can only
3078
# pull in the most recent changes. -- JRV20090506
3079
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3081
result.new_revno, result.new_revid = self.target.last_revision_info()
3083
result.master_branch = _hook_master
3084
result.local_branch = result.target_branch
3086
result.master_branch = result.target_branch
3087
result.local_branch = None
3089
for hook in Branch.hooks['post_pull']:
3092
self.source.unlock()
3095
def push(self, overwrite=False, stop_revision=None,
3096
_override_hook_source_branch=None):
3097
"""See InterBranch.push.
3099
This is the basic concrete implementation of push()
3101
:param _override_hook_source_branch: If specified, run
3102
the hooks passing this Branch as the source, rather than self.
3103
This is for use of RemoteBranch, where push is delegated to the
3104
underlying vfs-based Branch.
3106
# TODO: Public option to disable running hooks - should be trivial but
3108
self.source.lock_read()
3110
return _run_with_write_locked_target(
3111
self.target, self._push_with_bound_branches, overwrite,
3113
_override_hook_source_branch=_override_hook_source_branch)
3115
self.source.unlock()
3117
def _push_with_bound_branches(self, overwrite, stop_revision,
3118
_override_hook_source_branch=None):
3119
"""Push from source into target, and into target's master if any.
3122
if _override_hook_source_branch:
3123
result.source_branch = _override_hook_source_branch
3124
for hook in Branch.hooks['post_push']:
3127
bound_location = self.target.get_bound_location()
3128
if bound_location and self.target.base != bound_location:
3129
# there is a master branch.
3131
# XXX: Why the second check? Is it even supported for a branch to
3132
# be bound to itself? -- mbp 20070507
3133
master_branch = self.target.get_master_branch()
3134
master_branch.lock_write()
3136
# push into the master from the source branch.
3137
self.source._basic_push(master_branch, overwrite, stop_revision)
3138
# and push into the target branch from the source. Note that we
3139
# push from the source branch again, because its considered the
3140
# highest bandwidth repository.
3141
result = self.source._basic_push(self.target, overwrite,
3143
result.master_branch = master_branch
3144
result.local_branch = self.target
3148
master_branch.unlock()
3151
result = self.source._basic_push(self.target, overwrite,
3153
# TODO: Why set master_branch and local_branch if there's no
3154
# binding? Maybe cleaner to just leave them unset? -- mbp
3156
result.master_branch = self.target
3157
result.local_branch = None
3162
def is_compatible(self, source, target):
3163
# GenericBranch uses the public API, so always compatible
3167
class InterToBranch5(GenericInterBranch):
3170
def _get_branch_formats_to_test():
3171
return BranchFormat._default_format, BzrBranchFormat5()
3173
def pull(self, overwrite=False, stop_revision=None,
3174
possible_transports=None, run_hooks=True,
3175
_override_hook_target=None, local=False):
3176
"""Pull from source into self, updating my master if any.
3178
:param run_hooks: Private parameter - if false, this branch
3179
is being called because it's the master of the primary branch,
3180
so it should not run its hooks.
3182
bound_location = self.target.get_bound_location()
3183
if local and not bound_location:
3184
raise errors.LocalRequiresBoundBranch()
3185
master_branch = None
3186
if not local and bound_location and self.source.base != bound_location:
3187
# not pulling from master, so we need to update master.
3188
master_branch = self.target.get_master_branch(possible_transports)
3189
master_branch.lock_write()
3192
# pull from source into master.
3193
master_branch.pull(self.source, overwrite, stop_revision,
3195
return super(InterToBranch5, self).pull(overwrite,
3196
stop_revision, _hook_master=master_branch,
3197
run_hooks=run_hooks,
3198
_override_hook_target=_override_hook_target)
3201
master_branch.unlock()
3204
InterBranch.register_optimiser(GenericInterBranch)
3205
InterBranch.register_optimiser(InterToBranch5)
added
removed
bzrlib/branch.py
