157
76
"""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.
79
Base directory/url of the branch.
81
hooks: An instance of BranchHooks.
83
# 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)
87
def __init__(self, *ignored, **ignored_too):
88
self.tags = self._format.make_tags(self)
89
self._revision_history_cache = None
90
self._revision_id_to_revno_cache = None
91
self._partial_revision_id_to_revno_cache = {}
92
self._last_revision_info_cache = None
93
self._merge_sorted_revisions_cache = None
95
hooks = Branch.hooks['open']
100
"""Called by init to allow simpler extension of the base class."""
102
def break_lock(self):
103
"""Break a lock if one is present from another instance.
105
Uses the ui factory to ask for confirmation if the lock may be from
108
This will probe the repository for its lock as well.
110
self.control_files.break_lock()
111
self.repository.break_lock()
112
master = self.get_master_branch()
113
if master is not None:
117
def open(base, _unsupported=False, possible_transports=None):
118
"""Open the branch rooted at base.
120
For instance, if the branch is at URL/.bzr/branch,
121
Branch.open(URL) -> a Branch instance.
123
control = bzrdir.BzrDir.open(base, _unsupported,
124
possible_transports=possible_transports)
125
return control.open_branch(_unsupported)
128
def open_from_transport(transport, _unsupported=False):
129
"""Open the branch rooted at transport"""
130
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
131
return control.open_branch(_unsupported)
134
def open_containing(url, possible_transports=None):
135
"""Open an existing branch which contains url.
137
This probes for a branch at url, and searches upwards from there.
139
Basically we keep looking up until we find the control directory or
140
run into the root. If there isn't one, raises NotBranchError.
141
If there is one and it is either an unrecognised format or an unsupported
142
format, UnknownFormatError or UnsupportedFormatError are raised.
143
If there is one, it is returned, along with the unused portion of url.
145
control, relpath = bzrdir.BzrDir.open_containing(url,
147
return control.open_branch(), relpath
149
def _push_should_merge_tags(self):
150
"""Should _basic_push merge this branch's tags into the target?
152
The default implementation returns False if this branch has no tags,
153
and True the rest of the time. Subclasses may override this.
155
return self.supports_tags() and self.tags.get_tag_dict()
157
def get_config(self):
158
return BranchConfig(self)
160
def _get_tags_bytes(self):
161
"""Get the bytes of a serialised tags dict.
163
Note that not all branches support tags, nor do all use the same tags
164
logic: this method is specific to BasicTags. Other tag implementations
165
may use the same method name and behave differently, safely, because
166
of the double-dispatch via
167
format.make_tags->tags_instance->get_tags_dict.
169
:return: The bytes of the tags file.
170
:seealso: Branch._set_tags_bytes.
172
return self._transport.get_bytes('tags')
174
def _get_nick(self, local=False, possible_transports=None):
175
config = self.get_config()
176
# explicit overrides master, but don't look for master if local is True
177
if not local and not config.has_explicit_nickname():
179
master = self.get_master_branch(possible_transports)
180
if master is not None:
181
# return the master branch value
183
except errors.BzrError, e:
184
# Silently fall back to local implicit nick if the master is
186
mutter("Could not connect to bound branch, "
187
"falling back to local nick.\n " + str(e))
188
return config.get_nickname()
190
def _set_nick(self, nick):
191
self.get_config().set_user_option('nickname', nick, warn_masked=True)
193
nick = property(_get_nick, _set_nick)
196
raise NotImplementedError(self.is_locked)
198
def _lefthand_history(self, revision_id, last_rev=None,
200
if 'evil' in debug.debug_flags:
201
mutter_callsite(4, "_lefthand_history scales with history.")
202
# stop_revision must be a descendant of last_revision
203
graph = self.repository.get_graph()
204
if last_rev is not None:
205
if not graph.is_ancestor(last_rev, revision_id):
206
# our previous tip is not merged into stop_revision
207
raise errors.DivergedBranches(self, other_branch)
208
# make a new revision history from the graph
209
parents_map = graph.get_parent_map([revision_id])
210
if revision_id not in parents_map:
211
raise errors.NoSuchRevision(self, revision_id)
212
current_rev_id = revision_id
214
check_not_reserved_id = _mod_revision.check_not_reserved_id
215
# Do not include ghosts or graph origin in revision_history
216
while (current_rev_id in parents_map and
217
len(parents_map[current_rev_id]) > 0):
218
check_not_reserved_id(current_rev_id)
219
new_history.append(current_rev_id)
220
current_rev_id = parents_map[current_rev_id][0]
221
parents_map = graph.get_parent_map([current_rev_id])
222
new_history.reverse()
230
225
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'
226
raise NotImplementedError(self.lock_write)
245
228
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
229
raise NotImplementedError(self.lock_read)
253
self._lock = ReadLock(self.controlfilename('branch-lock'))
254
self._lock_mode = 'r'
257
231
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
232
raise NotImplementedError(self.unlock)
234
def peek_lock_mode(self):
235
"""Return lock mode for the Branch: 'r', 'w' or None"""
236
raise NotImplementedError(self.peek_lock_mode)
238
def get_physical_lock_status(self):
239
raise NotImplementedError(self.get_physical_lock_status)
242
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
243
"""Return the revision_id for a dotted revno.
245
:param revno: a tuple like (1,) or (1,1,2)
246
:param _cache_reverse: a private parameter enabling storage
247
of the reverse mapping in a top level cache. (This should
248
only be done in selective circumstances as we want to
249
avoid having the mapping cached multiple times.)
250
:return: the revision_id
251
:raises errors.NoSuchRevision: if the revno doesn't exist
253
rev_id = self._do_dotted_revno_to_revision_id(revno)
255
self._partial_revision_id_to_revno_cache[rev_id] = revno
258
def _do_dotted_revno_to_revision_id(self, revno):
259
"""Worker function for dotted_revno_to_revision_id.
261
Subclasses should override this if they wish to
262
provide a more efficient implementation.
265
return self.get_rev_id(revno[0])
266
revision_id_to_revno = self.get_revision_id_to_revno_map()
267
revision_ids = [revision_id for revision_id, this_revno
268
in revision_id_to_revno.iteritems()
269
if revno == this_revno]
270
if len(revision_ids) == 1:
271
return revision_ids[0]
273
revno_str = '.'.join(map(str, revno))
274
raise errors.NoSuchRevision(self, revno_str)
277
def revision_id_to_dotted_revno(self, revision_id):
278
"""Given a revision id, return its dotted revno.
280
:return: a tuple like (1,) or (400,1,3).
282
return self._do_revision_id_to_dotted_revno(revision_id)
284
def _do_revision_id_to_dotted_revno(self, revision_id):
285
"""Worker function for revision_id_to_revno."""
286
# Try the caches if they are loaded
287
result = self._partial_revision_id_to_revno_cache.get(revision_id)
288
if result is not None:
290
if self._revision_id_to_revno_cache:
291
result = self._revision_id_to_revno_cache.get(revision_id)
293
raise errors.NoSuchRevision(self, revision_id)
294
# Try the mainline as it's optimised
296
revno = self.revision_id_to_revno(revision_id)
298
except errors.NoSuchRevision:
299
# We need to load and use the full revno map after all
300
result = self.get_revision_id_to_revno_map().get(revision_id)
302
raise errors.NoSuchRevision(self, revision_id)
306
def get_revision_id_to_revno_map(self):
307
"""Return the revision_id => dotted revno map.
309
This will be regenerated on demand, but will be cached.
311
:return: A dictionary mapping revision_id => dotted revno.
312
This dictionary should not be modified by the caller.
314
if self._revision_id_to_revno_cache is not None:
315
mapping = self._revision_id_to_revno_cache
317
mapping = self._gen_revno_map()
318
self._cache_revision_id_to_revno(mapping)
319
# TODO: jam 20070417 Since this is being cached, should we be returning
321
# I would rather not, and instead just declare that users should not
322
# modify the return value.
325
def _gen_revno_map(self):
326
"""Create a new mapping from revision ids to dotted revnos.
328
Dotted revnos are generated based on the current tip in the revision
330
This is the worker function for get_revision_id_to_revno_map, which
331
just caches the return value.
333
:return: A dictionary mapping revision_id => dotted revno.
335
revision_id_to_revno = dict((rev_id, revno)
336
for rev_id, depth, revno, end_of_merge
337
in self.iter_merge_sorted_revisions())
338
return revision_id_to_revno
341
def iter_merge_sorted_revisions(self, start_revision_id=None,
342
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
343
"""Walk the revisions for a branch in merge sorted order.
345
Merge sorted order is the output from a merge-aware,
346
topological sort, i.e. all parents come before their
347
children going forward; the opposite for reverse.
349
:param start_revision_id: the revision_id to begin walking from.
350
If None, the branch tip is used.
351
:param stop_revision_id: the revision_id to terminate the walk
352
after. If None, the rest of history is included.
353
:param stop_rule: if stop_revision_id is not None, the precise rule
354
to use for termination:
355
* 'exclude' - leave the stop revision out of the result (default)
356
* 'include' - the stop revision is the last item in the result
357
* 'with-merges' - include the stop revision and all of its
358
merged revisions in the result
359
:param direction: either 'reverse' or 'forward':
360
* reverse means return the start_revision_id first, i.e.
361
start at the most recent revision and go backwards in history
362
* forward returns tuples in the opposite order to reverse.
363
Note in particular that forward does *not* do any intelligent
364
ordering w.r.t. depth as some clients of this API may like.
365
(If required, that ought to be done at higher layers.)
367
:return: an iterator over (revision_id, depth, revno, end_of_merge)
370
* revision_id: the unique id of the revision
371
* depth: How many levels of merging deep this node has been
373
* revno_sequence: This field provides a sequence of
374
revision numbers for all revisions. The format is:
375
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
376
branch that the revno is on. From left to right the REVNO numbers
377
are the sequence numbers within that branch of the revision.
378
* end_of_merge: When True the next node (earlier in history) is
379
part of a different merge.
381
# Note: depth and revno values are in the context of the branch so
382
# we need the full graph to get stable numbers, regardless of the
384
if self._merge_sorted_revisions_cache is None:
385
last_revision = self.last_revision()
386
graph = self.repository.get_graph()
387
parent_map = dict(((key, value) for key, value in
388
graph.iter_ancestry([last_revision]) if value is not None))
389
revision_graph = repository._strip_NULL_ghosts(parent_map)
390
revs = tsort.merge_sort(revision_graph, last_revision, None,
392
# Drop the sequence # before caching
393
self._merge_sorted_revisions_cache = [r[1:] for r in revs]
395
filtered = self._filter_merge_sorted_revisions(
396
self._merge_sorted_revisions_cache, start_revision_id,
397
stop_revision_id, stop_rule)
398
if direction == 'reverse':
400
if direction == 'forward':
401
return reversed(list(filtered))
403
raise ValueError('invalid direction %r' % direction)
405
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
406
start_revision_id, stop_revision_id, stop_rule):
407
"""Iterate over an inclusive range of sorted revisions."""
408
rev_iter = iter(merge_sorted_revisions)
409
if start_revision_id is not None:
410
for rev_id, depth, revno, end_of_merge in rev_iter:
411
if rev_id != start_revision_id:
414
# The decision to include the start or not
415
# depends on the stop_rule if a stop is provided
417
iter([(rev_id, depth, revno, end_of_merge)]),
420
if stop_revision_id is None:
421
for rev_id, depth, revno, end_of_merge in rev_iter:
422
yield rev_id, depth, revno, end_of_merge
423
elif stop_rule == 'exclude':
424
for rev_id, depth, revno, end_of_merge in rev_iter:
425
if rev_id == stop_revision_id:
427
yield rev_id, depth, revno, end_of_merge
428
elif stop_rule == 'include':
429
for rev_id, depth, revno, end_of_merge in rev_iter:
430
yield rev_id, depth, revno, end_of_merge
431
if rev_id == stop_revision_id:
433
elif stop_rule == 'with-merges':
434
stop_rev = self.repository.get_revision(stop_revision_id)
435
if stop_rev.parent_ids:
436
left_parent = stop_rev.parent_ids[0]
438
left_parent = _mod_revision.NULL_REVISION
439
for rev_id, depth, revno, end_of_merge in rev_iter:
440
if rev_id == left_parent:
442
yield rev_id, depth, revno, end_of_merge
444
raise ValueError('invalid stop_rule %r' % stop_rule)
446
def leave_lock_in_place(self):
447
"""Tell this branch object not to release the physical lock when this
450
If lock_write doesn't return a token, then this method is not supported.
452
self.control_files.leave_in_place()
454
def dont_leave_lock_in_place(self):
455
"""Tell this branch object to release the physical lock when this
456
object is unlocked, even if it didn't originally acquire it.
458
If lock_write doesn't return a token, then this method is not supported.
460
self.control_files.dont_leave_in_place()
462
def bind(self, other):
463
"""Bind the local branch the other branch.
465
:param other: The branch to bind to
468
raise errors.UpgradeRequired(self.base)
471
def fetch(self, from_branch, last_revision=None, pb=None):
472
"""Copy revisions from from_branch into this branch.
474
:param from_branch: Where to copy from.
475
:param last_revision: What revision to stop at (None for at the end
477
:param pb: An optional progress bar to use.
480
if self.base == from_branch.base:
483
symbol_versioning.warn(
484
symbol_versioning.deprecated_in((1, 14, 0))
485
% "pb parameter to fetch()")
486
from_branch.lock_read()
488
if last_revision is None:
489
last_revision = from_branch.last_revision()
490
last_revision = _mod_revision.ensure_null(last_revision)
491
return self.repository.fetch(from_branch.repository,
492
revision_id=last_revision,
497
def get_bound_location(self):
498
"""Return the URL of the branch we are bound to.
500
Older format branches cannot bind, please be sure to use a metadir
505
def get_old_bound_location(self):
506
"""Return the URL of the branch we used to be bound to
508
raise errors.UpgradeRequired(self.base)
510
def get_commit_builder(self, parents, config=None, timestamp=None,
511
timezone=None, committer=None, revprops=None,
513
"""Obtain a CommitBuilder for this branch.
515
:param parents: Revision ids of the parents of the new revision.
516
:param config: Optional configuration to use.
517
:param timestamp: Optional timestamp recorded for commit.
518
:param timezone: Optional timezone for timestamp.
519
:param committer: Optional committer to set for commit.
520
:param revprops: Optional dictionary of revision properties.
521
:param revision_id: Optional revision id.
525
config = self.get_config()
527
return self.repository.get_commit_builder(self, parents, config,
528
timestamp, timezone, committer, revprops, revision_id)
530
def get_master_branch(self, possible_transports=None):
531
"""Return the branch we are bound to.
533
:return: Either a Branch, or None
620
537
def get_revision_delta(self, revno):
621
538
"""Return the delta for one revision.
807
695
common_index = min(self_len, other_len) -1
808
696
if common_index >= 0 and \
809
697
self_history[common_index] != other_history[common_index]:
810
raise DivergedBranches(self, other)
698
raise errors.DivergedBranches(self, other)
812
700
if stop_revision is None:
813
701
stop_revision = other_len
814
elif stop_revision > other_len:
815
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
703
if stop_revision > other_len:
704
raise errors.NoSuchRevision(self, stop_revision)
817
705
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)
708
def update_revisions(self, other, stop_revision=None, overwrite=False,
710
"""Pull in new perfect-fit revisions.
712
:param other: Another Branch to pull from
713
:param stop_revision: Updated until the given revision
714
:param overwrite: Always set the branch pointer, rather than checking
715
to see if it is a proper descendant.
716
:param graph: A Graph object that can be used to query history
717
information. This can be None.
720
return InterBranch.get(other, self).update_revisions(stop_revision,
723
def import_last_revision_info(self, source_repo, revno, revid):
724
"""Set the last revision info, importing from another repo if necessary.
726
This is used by the bound branch code to upload a revision to
727
the master branch first before updating the tip of the local branch.
729
:param source_repo: Source repository to optionally fetch from
730
:param revno: Revision number of the new tip
731
:param revid: Revision id of the new tip
733
if not self.repository.has_same_location(source_repo):
734
self.repository.fetch(source_repo, revision_id=revid)
735
self.set_last_revision_info(revno, revid)
850
737
def revision_id_to_revno(self, revision_id):
851
738
"""Given a revision id, return its revno"""
739
if _mod_revision.is_null(revision_id):
852
741
history = self.revision_history()
854
743
return history.index(revision_id) + 1
855
744
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)
745
raise errors.NoSuchRevision(self, revision_id)
872
747
def get_rev_id(self, revno, history=None):
873
748
"""Find the revision id of the specified revno."""
750
return _mod_revision.NULL_REVISION
876
751
if history is None:
877
752
history = self.revision_history()
878
elif revno <= 0 or revno > len(history):
879
raise bzrlib.errors.NoSuchRevision(self, revno)
753
if revno <= 0 or revno > len(history):
754
raise errors.NoSuchRevision(self, revno)
880
755
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())
757
def pull(self, source, overwrite=False, stop_revision=None,
758
possible_transports=None, _override_hook_target=None):
759
"""Mirror source into this branch.
761
This branch is considered to be 'local', having low latency.
763
:returns: PullResult instance
765
raise NotImplementedError(self.pull)
767
def push(self, target, overwrite=False, stop_revision=None):
768
"""Mirror this branch into target.
770
This branch is considered to be 'local', having low latency.
772
raise NotImplementedError(self.push)
1068
774
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'))
775
"""Return `Tree` object for last revision."""
776
return self.repository.revision_tree(self.last_revision())
1281
778
def get_parent(self):
1282
779
"""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']
781
This is the default location for pull/missing. The usual
782
pattern is that the user can override it by specifying a
785
parent = self._get_parent_location()
788
# This is an old-format absolute path to a local branch
790
if parent.startswith('/'):
791
parent = urlutils.local_path_to_url(parent.decode('utf8'))
793
return urlutils.join(self.base[:-1], parent)
794
except errors.InvalidURLJoin, e:
795
raise errors.InaccessibleParent(parent, self.base)
797
def _get_parent_location(self):
798
raise NotImplementedError(self._get_parent_location)
800
def _set_config_location(self, name, url, config=None,
801
make_relative=False):
803
config = self.get_config()
807
url = urlutils.relative_url(self.base, url)
808
config.set_user_option(name, url, warn_masked=True)
810
def _get_config_location(self, name, config=None):
812
config = self.get_config()
813
location = config.get_user_option(name)
818
def get_submit_branch(self):
819
"""Return the submit location of the branch.
821
This is the default location for bundle. The usual
822
pattern is that the user can override it by specifying a
825
return self.get_config().get_user_option('submit_branch')
827
def set_submit_branch(self, location):
828
"""Return the submit location of the branch.
830
This is the default location for bundle. The usual
831
pattern is that the user can override it by specifying a
834
self.get_config().set_user_option('submit_branch', location,
837
def get_public_branch(self):
838
"""Return the public location of the branch.
840
This is is used by merge directives.
842
return self._get_config_location('public_branch')
844
def set_public_branch(self, location):
845
"""Return the submit location of the branch.
847
This is the default location for bundle. The usual
848
pattern is that the user can override it by specifying a
851
self._set_config_location('public_branch', location)
853
def get_push_location(self):
854
"""Return the None or the location to push this branch to."""
855
push_loc = self.get_config().get_user_option('push_location')
858
def set_push_location(self, location):
859
"""Set a new push location for this branch."""
860
raise NotImplementedError(self.set_push_location)
862
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
863
"""Run the post_change_branch_tip hooks."""
864
hooks = Branch.hooks['post_change_branch_tip']
867
new_revno, new_revid = self.last_revision_info()
868
params = ChangeBranchTipParams(
869
self, old_revno, new_revno, old_revid, new_revid)
873
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
874
"""Run the pre_change_branch_tip hooks."""
875
hooks = Branch.hooks['pre_change_branch_tip']
878
old_revno, old_revid = self.last_revision_info()
879
params = ChangeBranchTipParams(
880
self, old_revno, new_revno, old_revid, new_revid)
1292
return self.controlfile(l, 'r').read().strip('\n')
1294
if e.errno != errno.ENOENT:
884
except errors.TipChangeRejected:
887
exc_info = sys.exc_info()
888
hook_name = Branch.hooks.get_hook_name(hook)
889
raise errors.HookFailed(
890
'pre_change_branch_tip', hook_name, exc_info)
892
def set_parent(self, url):
893
raise NotImplementedError(self.set_parent)
897
"""Synchronise this branch with the master branch if any.
899
: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
903
def check_revno(self, revno):
1315
905
Check whether a revno corresponds to any revision.
1319
909
self.check_real_revno(revno)
1321
911
def check_real_revno(self, revno):
1323
913
Check whether a revno corresponds to a real revision.
1324
914
Zero (the NULL revision) is considered invalid
1326
916
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)
917
raise errors.InvalidRevisionNumber(revno)
920
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
921
"""Clone this branch into to_bzrdir preserving all semantic values.
923
Most API users will want 'create_clone_on_transport', which creates a
924
new bzrdir and branch on the fly.
926
revision_id: if not None, the revision history in the new branch will
927
be truncated to end with revision_id.
929
result = to_bzrdir.create_branch()
930
if repository_policy is not None:
931
repository_policy.configure_branch(result)
932
self.copy_content_into(result, revision_id=revision_id)
936
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
937
"""Create a new line of development from the branch, into to_bzrdir.
939
to_bzrdir controls the branch format.
941
revision_id: if not None, the revision history in the new branch will
942
be truncated to end with revision_id.
944
result = to_bzrdir.create_branch()
945
if repository_policy is not None:
946
repository_policy.configure_branch(result)
947
self.copy_content_into(result, revision_id=revision_id)
948
result.set_parent(self.bzrdir.root_transport.base)
951
def _synchronize_history(self, destination, revision_id):
952
"""Synchronize last revision and revision history between branches.
954
This version is most efficient when the destination is also a
955
BzrBranch6, but works for BzrBranch5, as long as the destination's
956
repository contains all the lefthand ancestors of the intended
957
last_revision. If not, set_last_revision_info will fail.
959
:param destination: The branch to copy the history into
960
:param revision_id: The revision-id to truncate history at. May
961
be None to copy complete history.
963
source_revno, source_revision_id = self.last_revision_info()
964
if revision_id is None:
965
revno, revision_id = source_revno, source_revision_id
966
elif source_revision_id == revision_id:
967
# we know the revno without needing to walk all of history
970
# To figure out the revno for a random revision, we need to build
971
# the revision history, and count its length.
972
# We don't care about the order, just how long it is.
973
# Alternatively, we could start at the current location, and count
974
# backwards. But there is no guarantee that we will find it since
975
# it may be a merged revision.
976
revno = len(list(self.repository.iter_reverse_revision_history(
978
destination.set_last_revision_info(revno, revision_id)
981
def copy_content_into(self, destination, revision_id=None):
982
"""Copy the content of self into destination.
984
revision_id: if not None, the revision history in the new branch will
985
be truncated to end with revision_id.
987
self._synchronize_history(destination, revision_id)
989
parent = self.get_parent()
990
except errors.InaccessibleParent, e:
991
mutter('parent was not accessible to copy: %s', e)
994
destination.set_parent(parent)
995
if self._push_should_merge_tags():
996
self.tags.merge_to(destination.tags)
1000
"""Check consistency of the branch.
1002
In particular this checks that revisions given in the revision-history
1003
do actually match up in the revision graph, and that they're all
1004
present in the repository.
1006
Callers will typically also want to check the repository.
1008
:return: A BranchCheckResult.
1010
mainline_parent_id = None
1011
last_revno, last_revision_id = self.last_revision_info()
1012
real_rev_history = list(self.repository.iter_reverse_revision_history(
1014
real_rev_history.reverse()
1015
if len(real_rev_history) != last_revno:
1016
raise errors.BzrCheckError('revno does not match len(mainline)'
1017
' %s != %s' % (last_revno, len(real_rev_history)))
1018
# TODO: We should probably also check that real_rev_history actually
1019
# matches self.revision_history()
1020
for revision_id in real_rev_history:
1022
revision = self.repository.get_revision(revision_id)
1023
except errors.NoSuchRevision, e:
1024
raise errors.BzrCheckError("mainline revision {%s} not in repository"
1026
# In general the first entry on the revision history has no parents.
1027
# But it's not illegal for it to have parents listed; this can happen
1028
# in imports from Arch when the parents weren't reachable.
1029
if mainline_parent_id is not None:
1030
if mainline_parent_id not in revision.parent_ids:
1031
raise errors.BzrCheckError("previous revision {%s} not listed among "
1033
% (mainline_parent_id, revision_id))
1034
mainline_parent_id = revision_id
1035
return BranchCheckResult(self)
1037
def _get_checkout_format(self):
1038
"""Return the most suitable metadir for a checkout of this branch.
1039
Weaves are used if this branch's repository uses weaves.
1041
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1042
from bzrlib.repofmt import weaverepo
1043
format = bzrdir.BzrDirMetaFormat1()
1044
format.repository_format = weaverepo.RepositoryFormat7()
1046
format = self.repository.bzrdir.checkout_metadir()
1047
format.set_branch_format(self._format)
1050
def create_clone_on_transport(self, to_transport, revision_id=None,
1052
"""Create a clone of this branch and its bzrdir.
1054
:param to_transport: The transport to clone onto.
1055
:param revision_id: The revision id to use as tip in the new branch.
1056
If None the tip is obtained from this branch.
1057
:param stacked_on: An optional URL to stack the clone on.
1059
# XXX: Fix the bzrdir API to allow getting the branch back from the
1060
# clone call. Or something. 20090224 RBC/spiv.
1061
dir_to = self.bzrdir.clone_on_transport(to_transport,
1062
revision_id=revision_id, stacked_on=stacked_on)
1063
return dir_to.open_branch()
1065
def create_checkout(self, to_location, revision_id=None,
1066
lightweight=False, accelerator_tree=None,
1068
"""Create a checkout of a branch.
1070
:param to_location: The url to produce the checkout at
1071
:param revision_id: The revision to check out
1072
:param lightweight: If True, produce a lightweight checkout, otherwise,
1073
produce a bound branch (heavyweight checkout)
1074
:param accelerator_tree: A tree which can be used for retrieving file
1075
contents more quickly than the revision tree, i.e. a workingtree.
1076
The revision tree will be used for cases where accelerator_tree's
1077
content is different.
1078
:param hardlink: If true, hard-link files from accelerator_tree,
1080
:return: The tree of the created checkout
1082
t = transport.get_transport(to_location)
1085
format = self._get_checkout_format()
1086
checkout = format.initialize_on_transport(t)
1087
from_branch = BranchReferenceFormat().initialize(checkout, self)
1089
format = self._get_checkout_format()
1090
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1091
to_location, force_new_tree=False, format=format)
1092
checkout = checkout_branch.bzrdir
1093
checkout_branch.bind(self)
1094
# pull up to the specified revision_id to set the initial
1095
# branch tip correctly, and seed it with history.
1096
checkout_branch.pull(self, stop_revision=revision_id)
1098
tree = checkout.create_workingtree(revision_id,
1099
from_branch=from_branch,
1100
accelerator_tree=accelerator_tree,
1102
basis_tree = tree.basis_tree()
1103
basis_tree.lock_read()
1105
for path, file_id in basis_tree.iter_references():
1106
reference_parent = self.reference_parent(file_id, path)
1107
reference_parent.create_checkout(tree.abspath(path),
1108
basis_tree.get_reference_revision(file_id, path),
1115
def reconcile(self, thorough=True):
1116
"""Make sure the data stored in this branch is consistent."""
1117
from bzrlib.reconcile import BranchReconciler
1118
reconciler = BranchReconciler(self, thorough=thorough)
1119
reconciler.reconcile()
1122
def reference_parent(self, file_id, path):
1123
"""Return the parent branch for a tree-reference file_id
1124
:param file_id: The file_id of the tree reference
1125
:param path: The path of the file_id in the tree
1126
:return: A branch associated with the file_id
1128
# FIXME should provide multiple branches, based on config
1129
return Branch.open(self.bzrdir.root_transport.clone(path).base)
1131
def supports_tags(self):
1132
return self._format.supports_tags()
1134
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1136
"""Ensure that revision_b is a descendant of revision_a.
1138
This is a helper function for update_revisions.
1140
:raises: DivergedBranches if revision_b has diverged from revision_a.
1141
:returns: True if revision_b is a descendant of revision_a.
1143
relation = self._revision_relations(revision_a, revision_b, graph)
1144
if relation == 'b_descends_from_a':
1146
elif relation == 'diverged':
1147
raise errors.DivergedBranches(self, other_branch)
1148
elif relation == 'a_descends_from_b':
1151
raise AssertionError("invalid relation: %r" % (relation,))
1153
def _revision_relations(self, revision_a, revision_b, graph):
1154
"""Determine the relationship between two revisions.
1156
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1158
heads = graph.heads([revision_a, revision_b])
1159
if heads == set([revision_b]):
1160
return 'b_descends_from_a'
1161
elif heads == set([revision_a, revision_b]):
1162
# These branches have diverged
1164
elif heads == set([revision_a]):
1165
return 'a_descends_from_b'
1167
raise AssertionError("invalid heads: %r" % (heads,))
1170
class BranchFormat(object):
1171
"""An encapsulation of the initialization and open routines for a format.
1173
Formats provide three things:
1174
* An initialization routine,
1178
Formats are placed in an dict by their format string for reference
1179
during branch opening. Its not required that these be instances, they
1180
can be classes themselves with class methods - it simply depends on
1181
whether state is needed for a given format or not.
1183
Once a format is deprecated, just deprecate the initialize and open
1184
methods on the format class. Do not deprecate the object, as the
1185
object will be created every time regardless.
1188
_default_format = None
1189
"""The default format used for new branches."""
1192
"""The known formats."""
1194
def __eq__(self, other):
1195
return self.__class__ is other.__class__
1197
def __ne__(self, other):
1198
return not (self == other)
1201
def find_format(klass, a_bzrdir):
1202
"""Return the format for the branch object in a_bzrdir."""
1204
transport = a_bzrdir.get_branch_transport(None)
1205
format_string = transport.get("format").read()
1206
return klass._formats[format_string]
1207
except errors.NoSuchFile:
1208
raise errors.NotBranchError(path=transport.base)
1210
raise errors.UnknownFormatError(format=format_string, kind='branch')
1213
def get_default_format(klass):
1214
"""Return the current default format."""
1215
return klass._default_format
1217
def get_reference(self, a_bzrdir):
1218
"""Get the target reference of the branch in a_bzrdir.
1220
format probing must have been completed before calling
1221
this method - it is assumed that the format of the branch
1222
in a_bzrdir is correct.
1224
:param a_bzrdir: The bzrdir to get the branch data from.
1225
:return: None if the branch is not a reference branch.
1230
def set_reference(self, a_bzrdir, to_branch):
1231
"""Set the target reference of the branch in a_bzrdir.
1233
format probing must have been completed before calling
1234
this method - it is assumed that the format of the branch
1235
in a_bzrdir is correct.
1237
:param a_bzrdir: The bzrdir to set the branch reference for.
1238
:param to_branch: branch that the checkout is to reference
1240
raise NotImplementedError(self.set_reference)
1242
def get_format_string(self):
1243
"""Return the ASCII format string that identifies this format."""
1244
raise NotImplementedError(self.get_format_string)
1246
def get_format_description(self):
1247
"""Return the short format description for this format."""
1248
raise NotImplementedError(self.get_format_description)
1250
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
1252
"""Initialize a branch in a bzrdir, with specified files
1254
:param a_bzrdir: The bzrdir to initialize the branch in
1255
:param utf8_files: The files to create as a list of
1256
(filename, content) tuples
1257
:param set_format: If True, set the format with
1258
self.get_format_string. (BzrBranch4 has its format set
1260
:return: a branch in this format
1262
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1263
branch_transport = a_bzrdir.get_branch_transport(self)
1265
'metadir': ('lock', lockdir.LockDir),
1266
'branch4': ('branch-lock', lockable_files.TransportLock),
1268
lock_name, lock_class = lock_map[lock_type]
1269
control_files = lockable_files.LockableFiles(branch_transport,
1270
lock_name, lock_class)
1271
control_files.create_lock()
1272
control_files.lock_write()
1274
utf8_files += [('format', self.get_format_string())]
1276
for (filename, content) in utf8_files:
1277
branch_transport.put_bytes(
1279
mode=a_bzrdir._get_file_mode())
1281
control_files.unlock()
1282
return self.open(a_bzrdir, _found=True)
1284
def initialize(self, a_bzrdir):
1285
"""Create a branch of this format in a_bzrdir."""
1286
raise NotImplementedError(self.initialize)
1288
def is_supported(self):
1289
"""Is this format supported?
1291
Supported formats can be initialized and opened.
1292
Unsupported formats may not support initialization or committing or
1293
some other features depending on the reason for not being supported.
1297
def make_tags(self, branch):
1298
"""Create a tags object for branch.
1300
This method is on BranchFormat, because BranchFormats are reflected
1301
over the wire via network_name(), whereas full Branch instances require
1302
multiple VFS method calls to operate at all.
1304
The default implementation returns a disabled-tags instance.
1306
Note that it is normal for branch to be a RemoteBranch when using tags
1309
return DisabledTags(branch)
1311
def network_name(self):
1312
"""A simple byte string uniquely identifying this format for RPC calls.
1314
MetaDir branch formats use their disk format string to identify the
1315
repository over the wire. All in one formats such as bzr < 0.8, and
1316
foreign formats like svn/git and hg should use some marker which is
1317
unique and immutable.
1319
raise NotImplementedError(self.network_name)
1321
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1322
"""Return the branch object for a_bzrdir
1324
:param a_bzrdir: A BzrDir that contains a branch.
1325
:param _found: a private parameter, do not use it. It is used to
1326
indicate if format probing has already be done.
1327
:param ignore_fallbacks: when set, no fallback branches will be opened
1328
(if there are any). Default is to open fallbacks.
1330
raise NotImplementedError(self.open)
1333
def register_format(klass, format):
1334
"""Register a metadir format."""
1335
klass._formats[format.get_format_string()] = format
1336
# Metadir formats have a network name of their format string, and get
1337
# registered as class factories.
1338
network_format_registry.register(format.get_format_string(), format.__class__)
1341
def set_default_format(klass, format):
1342
klass._default_format = format
1344
def supports_stacking(self):
1345
"""True if this format records a stacked-on branch."""
1349
def unregister_format(klass, format):
1350
del klass._formats[format.get_format_string()]
1353
return self.get_format_description().rstrip()
1355
def supports_tags(self):
1356
"""True if this format supports tags stored in the branch"""
1357
return False # by default
1360
class BranchHooks(Hooks):
1361
"""A dictionary mapping hook name to a list of callables for branch hooks.
1363
e.g. ['set_rh'] Is the list of items to be called when the
1364
set_revision_history function is invoked.
1368
"""Create the default hooks.
1370
These are all empty initially, because by default nothing should get
1373
Hooks.__init__(self)
1374
self.create_hook(HookPoint('set_rh',
1375
"Invoked whenever the revision history has been set via "
1376
"set_revision_history. The api signature is (branch, "
1377
"revision_history), and the branch will be write-locked. "
1378
"The set_rh hook can be expensive for bzr to trigger, a better "
1379
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1380
self.create_hook(HookPoint('open',
1381
"Called with the Branch object that has been opened after a "
1382
"branch is opened.", (1, 8), None))
1383
self.create_hook(HookPoint('post_push',
1384
"Called after a push operation completes. post_push is called "
1385
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1386
"bzr client.", (0, 15), None))
1387
self.create_hook(HookPoint('post_pull',
1388
"Called after a pull operation completes. post_pull is called "
1389
"with a bzrlib.branch.PullResult object and only runs in the "
1390
"bzr client.", (0, 15), None))
1391
self.create_hook(HookPoint('pre_commit',
1392
"Called after a commit is calculated but before it is is "
1393
"completed. pre_commit is called with (local, master, old_revno, "
1394
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1395
"). old_revid is NULL_REVISION for the first commit to a branch, "
1396
"tree_delta is a TreeDelta object describing changes from the "
1397
"basis revision. hooks MUST NOT modify this delta. "
1398
" future_tree is an in-memory tree obtained from "
1399
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1400
"tree.", (0,91), None))
1401
self.create_hook(HookPoint('post_commit',
1402
"Called in the bzr client after a commit has completed. "
1403
"post_commit is called with (local, master, old_revno, old_revid, "
1404
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1405
"commit to a branch.", (0, 15), None))
1406
self.create_hook(HookPoint('post_uncommit',
1407
"Called in the bzr client after an uncommit completes. "
1408
"post_uncommit is called with (local, master, old_revno, "
1409
"old_revid, new_revno, new_revid) where local is the local branch "
1410
"or None, master is the target branch, and an empty branch "
1411
"recieves new_revno of 0, new_revid of None.", (0, 15), None))
1412
self.create_hook(HookPoint('pre_change_branch_tip',
1413
"Called in bzr client and server before a change to the tip of a "
1414
"branch is made. pre_change_branch_tip is called with a "
1415
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1416
"commit, uncommit will all trigger this hook.", (1, 6), None))
1417
self.create_hook(HookPoint('post_change_branch_tip',
1418
"Called in bzr client and server after a change to the tip of a "
1419
"branch is made. post_change_branch_tip is called with a "
1420
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1421
"commit, uncommit will all trigger this hook.", (1, 4), None))
1422
self.create_hook(HookPoint('transform_fallback_location',
1423
"Called when a stacked branch is activating its fallback "
1424
"locations. transform_fallback_location is called with (branch, "
1425
"url), and should return a new url. Returning the same url "
1426
"allows it to be used as-is, returning a different one can be "
1427
"used to cause the branch to stack on a closer copy of that "
1428
"fallback_location. Note that the branch cannot have history "
1429
"accessing methods called on it during this hook because the "
1430
"fallback locations have not been activated. When there are "
1431
"multiple hooks installed for transform_fallback_location, "
1432
"all are called with the url returned from the previous hook."
1433
"The order is however undefined.", (1, 9), None))
1436
# install the default hooks into the Branch class.
1437
Branch.hooks = BranchHooks()
1440
class ChangeBranchTipParams(object):
1441
"""Object holding parameters passed to *_change_branch_tip hooks.
1443
There are 5 fields that hooks may wish to access:
1445
:ivar branch: the branch being changed
1446
:ivar old_revno: revision number before the change
1447
:ivar new_revno: revision number after the change
1448
:ivar old_revid: revision id before the change
1449
:ivar new_revid: revision id after the change
1451
The revid fields are strings. The revno fields are integers.
1454
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1455
"""Create a group of ChangeBranchTip parameters.
1457
:param branch: The branch being changed.
1458
:param old_revno: Revision number before the change.
1459
:param new_revno: Revision number after the change.
1460
:param old_revid: Tip revision id before the change.
1461
:param new_revid: Tip revision id after the change.
1463
self.branch = branch
1464
self.old_revno = old_revno
1465
self.new_revno = new_revno
1466
self.old_revid = old_revid
1467
self.new_revid = new_revid
1469
def __eq__(self, other):
1470
return self.__dict__ == other.__dict__
1473
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1474
self.__class__.__name__, self.branch,
1475
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1478
class BzrBranchFormat4(BranchFormat):
1479
"""Bzr branch format 4.
1482
- a revision-history file.
1483
- a branch-lock lock file [ to be shared with the bzrdir ]
1486
def get_format_description(self):
1487
"""See BranchFormat.get_format_description()."""
1488
return "Branch format 4"
1490
def initialize(self, a_bzrdir):
1491
"""Create a branch of this format in a_bzrdir."""
1492
utf8_files = [('revision-history', ''),
1493
('branch-name', ''),
1495
return self._initialize_helper(a_bzrdir, utf8_files,
1496
lock_type='branch4', set_format=False)
1499
super(BzrBranchFormat4, self).__init__()
1500
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1502
def network_name(self):
1503
"""The network name for this format is the control dirs disk label."""
1504
return self._matchingbzrdir.get_format_string()
1506
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1507
"""See BranchFormat.open()."""
1509
# we are being called directly and must probe.
1510
raise NotImplementedError
1511
return BzrBranch(_format=self,
1512
_control_files=a_bzrdir._control_files,
1514
_repository=a_bzrdir.open_repository())
1517
return "Bazaar-NG branch format 4"
1520
class BranchFormatMetadir(BranchFormat):
1521
"""Common logic for meta-dir based branch formats."""
1523
def _branch_class(self):
1524
"""What class to instantiate on open calls."""
1525
raise NotImplementedError(self._branch_class)
1527
def network_name(self):
1528
"""A simple byte string uniquely identifying this format for RPC calls.
1530
Metadir branch formats use their format string.
1532
return self.get_format_string()
1534
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1535
"""See BranchFormat.open()."""
1537
format = BranchFormat.find_format(a_bzrdir)
1538
if format.__class__ != self.__class__:
1539
raise AssertionError("wrong format %r found for %r" %
1542
transport = a_bzrdir.get_branch_transport(None)
1543
control_files = lockable_files.LockableFiles(transport, 'lock',
1545
return self._branch_class()(_format=self,
1546
_control_files=control_files,
1548
_repository=a_bzrdir.find_repository(),
1549
ignore_fallbacks=ignore_fallbacks)
1550
except errors.NoSuchFile:
1551
raise errors.NotBranchError(path=transport.base)
1554
super(BranchFormatMetadir, self).__init__()
1555
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1556
self._matchingbzrdir.set_branch_format(self)
1558
def supports_tags(self):
1562
class BzrBranchFormat5(BranchFormatMetadir):
1563
"""Bzr branch format 5.
1566
- a revision-history file.
1568
- a lock dir guarding the branch itself
1569
- all of this stored in a branch/ subdirectory
1570
- works with shared repositories.
1572
This format is new in bzr 0.8.
1575
def _branch_class(self):
1578
def get_format_string(self):
1579
"""See BranchFormat.get_format_string()."""
1580
return "Bazaar-NG branch format 5\n"
1582
def get_format_description(self):
1583
"""See BranchFormat.get_format_description()."""
1584
return "Branch format 5"
1586
def initialize(self, a_bzrdir):
1587
"""Create a branch of this format in a_bzrdir."""
1588
utf8_files = [('revision-history', ''),
1589
('branch-name', ''),
1591
return self._initialize_helper(a_bzrdir, utf8_files)
1593
def supports_tags(self):
1597
class BzrBranchFormat6(BranchFormatMetadir):
1598
"""Branch format with last-revision and tags.
1600
Unlike previous formats, this has no explicit revision history. Instead,
1601
this just stores the last-revision, and the left-hand history leading
1602
up to there is the history.
1604
This format was introduced in bzr 0.15
1605
and became the default in 0.91.
1608
def _branch_class(self):
1611
def get_format_string(self):
1612
"""See BranchFormat.get_format_string()."""
1613
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1615
def get_format_description(self):
1616
"""See BranchFormat.get_format_description()."""
1617
return "Branch format 6"
1619
def initialize(self, a_bzrdir):
1620
"""Create a branch of this format in a_bzrdir."""
1621
utf8_files = [('last-revision', '0 null:\n'),
1622
('branch.conf', ''),
1625
return self._initialize_helper(a_bzrdir, utf8_files)
1627
def make_tags(self, branch):
1628
"""See bzrlib.branch.BranchFormat.make_tags()."""
1629
return BasicTags(branch)
1633
class BzrBranchFormat7(BranchFormatMetadir):
1634
"""Branch format with last-revision, tags, and a stacked location pointer.
1636
The stacked location pointer is passed down to the repository and requires
1637
a repository format with supports_external_lookups = True.
1639
This format was introduced in bzr 1.6.
1642
def _branch_class(self):
1645
def get_format_string(self):
1646
"""See BranchFormat.get_format_string()."""
1647
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
1649
def get_format_description(self):
1650
"""See BranchFormat.get_format_description()."""
1651
return "Branch format 7"
1653
def initialize(self, a_bzrdir):
1654
"""Create a branch of this format in a_bzrdir."""
1655
utf8_files = [('last-revision', '0 null:\n'),
1656
('branch.conf', ''),
1659
return self._initialize_helper(a_bzrdir, utf8_files)
1662
super(BzrBranchFormat7, self).__init__()
1663
self._matchingbzrdir.repository_format = \
1664
RepositoryFormatKnitPack5RichRoot()
1666
def make_tags(self, branch):
1667
"""See bzrlib.branch.BranchFormat.make_tags()."""
1668
return BasicTags(branch)
1670
def supports_stacking(self):
1674
class BranchReferenceFormat(BranchFormat):
1675
"""Bzr branch reference format.
1677
Branch references are used in implementing checkouts, they
1678
act as an alias to the real branch which is at some other url.
1685
def get_format_string(self):
1686
"""See BranchFormat.get_format_string()."""
1687
return "Bazaar-NG Branch Reference Format 1\n"
1689
def get_format_description(self):
1690
"""See BranchFormat.get_format_description()."""
1691
return "Checkout reference format 1"
1693
def get_reference(self, a_bzrdir):
1694
"""See BranchFormat.get_reference()."""
1695
transport = a_bzrdir.get_branch_transport(None)
1696
return transport.get('location').read()
1698
def set_reference(self, a_bzrdir, to_branch):
1699
"""See BranchFormat.set_reference()."""
1700
transport = a_bzrdir.get_branch_transport(None)
1701
location = transport.put_bytes('location', to_branch.base)
1703
def initialize(self, a_bzrdir, target_branch=None):
1704
"""Create a branch of this format in a_bzrdir."""
1705
if target_branch is None:
1706
# this format does not implement branch itself, thus the implicit
1707
# creation contract must see it as uninitializable
1708
raise errors.UninitializableFormat(self)
1709
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1710
branch_transport = a_bzrdir.get_branch_transport(self)
1711
branch_transport.put_bytes('location',
1712
target_branch.bzrdir.root_transport.base)
1713
branch_transport.put_bytes('format', self.get_format_string())
1715
a_bzrdir, _found=True,
1716
possible_transports=[target_branch.bzrdir.root_transport])
1719
super(BranchReferenceFormat, self).__init__()
1720
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1721
self._matchingbzrdir.set_branch_format(self)
1723
def _make_reference_clone_function(format, a_branch):
1724
"""Create a clone() routine for a branch dynamically."""
1725
def clone(to_bzrdir, revision_id=None,
1726
repository_policy=None):
1727
"""See Branch.clone()."""
1728
return format.initialize(to_bzrdir, a_branch)
1729
# cannot obey revision_id limits when cloning a reference ...
1730
# FIXME RBC 20060210 either nuke revision_id for clone, or
1731
# emit some sort of warning/error to the caller ?!
1734
def open(self, a_bzrdir, _found=False, location=None,
1735
possible_transports=None, ignore_fallbacks=False):
1736
"""Return the branch that the branch reference in a_bzrdir points at.
1738
:param a_bzrdir: A BzrDir that contains a branch.
1739
:param _found: a private parameter, do not use it. It is used to
1740
indicate if format probing has already be done.
1741
:param ignore_fallbacks: when set, no fallback branches will be opened
1742
(if there are any). Default is to open fallbacks.
1743
:param location: The location of the referenced branch. If
1744
unspecified, this will be determined from the branch reference in
1746
:param possible_transports: An optional reusable transports list.
1749
format = BranchFormat.find_format(a_bzrdir)
1750
if format.__class__ != self.__class__:
1751
raise AssertionError("wrong format %r found for %r" %
1753
if location is None:
1754
location = self.get_reference(a_bzrdir)
1755
real_bzrdir = bzrdir.BzrDir.open(
1756
location, possible_transports=possible_transports)
1757
result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
1758
# this changes the behaviour of result.clone to create a new reference
1759
# rather than a copy of the content of the branch.
1760
# I did not use a proxy object because that needs much more extensive
1761
# testing, and we are only changing one behaviour at the moment.
1762
# If we decide to alter more behaviours - i.e. the implicit nickname
1763
# then this should be refactored to introduce a tested proxy branch
1764
# and a subclass of that for use in overriding clone() and ....
1766
result.clone = self._make_reference_clone_function(result)
1770
network_format_registry = registry.FormatRegistry()
1771
"""Registry of formats indexed by their network name.
1773
The network name for a branch format is an identifier that can be used when
1774
referring to formats with smart server operations. See
1775
BranchFormat.network_name() for more detail.
1779
# formats which have no format string are not discoverable
1780
# and not independently creatable, so are not registered.
1781
__format5 = BzrBranchFormat5()
1782
__format6 = BzrBranchFormat6()
1783
__format7 = BzrBranchFormat7()
1784
BranchFormat.register_format(__format5)
1785
BranchFormat.register_format(BranchReferenceFormat())
1786
BranchFormat.register_format(__format6)
1787
BranchFormat.register_format(__format7)
1788
BranchFormat.set_default_format(__format6)
1789
_legacy_formats = [BzrBranchFormat4(),
1791
network_format_registry.register(
1792
_legacy_formats[0].network_name(), _legacy_formats[0].__class__)
1795
class BzrBranch(Branch):
1796
"""A branch stored in the actual filesystem.
1798
Note that it's "local" in the context of the filesystem; it doesn't
1799
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1800
it's writable, and can be accessed via the normal filesystem API.
1802
:ivar _transport: Transport for file operations on this branch's
1803
control files, typically pointing to the .bzr/branch directory.
1804
:ivar repository: Repository for this branch.
1805
:ivar base: The url of the base directory for this branch; the one
1806
containing the .bzr directory.
1809
def __init__(self, _format=None,
1810
_control_files=None, a_bzrdir=None, _repository=None,
1811
ignore_fallbacks=False):
1812
"""Create new branch object at a particular location."""
1813
if a_bzrdir is None:
1814
raise ValueError('a_bzrdir must be supplied')
1816
self.bzrdir = a_bzrdir
1817
self._base = self.bzrdir.transport.clone('..').base
1818
# XXX: We should be able to just do
1819
# self.base = self.bzrdir.root_transport.base
1820
# but this does not quite work yet -- mbp 20080522
1821
self._format = _format
1822
if _control_files is None:
1823
raise ValueError('BzrBranch _control_files is None')
1824
self.control_files = _control_files
1825
self._transport = _control_files._transport
1826
self.repository = _repository
1827
Branch.__init__(self)
1830
return '%s(%r)' % (self.__class__.__name__, self.base)
1834
def _get_base(self):
1835
"""Returns the directory containing the control directory."""
1838
base = property(_get_base, doc="The URL for the root of this branch.")
1840
def is_locked(self):
1841
return self.control_files.is_locked()
1843
def lock_write(self, token=None):
1844
repo_token = self.repository.lock_write()
1846
token = self.control_files.lock_write(token=token)
1848
self.repository.unlock()
1852
def lock_read(self):
1853
self.repository.lock_read()
1855
self.control_files.lock_read()
1857
self.repository.unlock()
1861
# TODO: test for failed two phase locks. This is known broken.
1863
self.control_files.unlock()
1865
self.repository.unlock()
1866
if not self.control_files.is_locked():
1867
# we just released the lock
1868
self._clear_cached_state()
1870
def peek_lock_mode(self):
1871
if self.control_files._lock_count == 0:
1874
return self.control_files._lock_mode
1876
def get_physical_lock_status(self):
1877
return self.control_files.get_physical_lock_status()
1880
def print_file(self, file, revision_id):
1881
"""See Branch.print_file."""
1882
return self.repository.print_file(file, revision_id)
1884
def _write_revision_history(self, history):
1885
"""Factored out of set_revision_history.
1887
This performs the actual writing to disk.
1888
It is intended to be called by BzrBranch5.set_revision_history."""
1889
self._transport.put_bytes(
1890
'revision-history', '\n'.join(history),
1891
mode=self.bzrdir._get_file_mode())
1894
def set_revision_history(self, rev_history):
1895
"""See Branch.set_revision_history."""
1896
if 'evil' in debug.debug_flags:
1897
mutter_callsite(3, "set_revision_history scales with history.")
1898
check_not_reserved_id = _mod_revision.check_not_reserved_id
1899
for rev_id in rev_history:
1900
check_not_reserved_id(rev_id)
1901
if Branch.hooks['post_change_branch_tip']:
1902
# Don't calculate the last_revision_info() if there are no hooks
1904
old_revno, old_revid = self.last_revision_info()
1905
if len(rev_history) == 0:
1906
revid = _mod_revision.NULL_REVISION
1908
revid = rev_history[-1]
1909
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
1910
self._write_revision_history(rev_history)
1911
self._clear_cached_state()
1912
self._cache_revision_history(rev_history)
1913
for hook in Branch.hooks['set_rh']:
1914
hook(self, rev_history)
1915
if Branch.hooks['post_change_branch_tip']:
1916
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1918
def _synchronize_history(self, destination, revision_id):
1919
"""Synchronize last revision and revision history between branches.
1921
This version is most efficient when the destination is also a
1922
BzrBranch5, but works for BzrBranch6 as long as the revision
1923
history is the true lefthand parent history, and all of the revisions
1924
are in the destination's repository. If not, set_revision_history
1927
:param destination: The branch to copy the history into
1928
:param revision_id: The revision-id to truncate history at. May
1929
be None to copy complete history.
1931
if not isinstance(destination._format, BzrBranchFormat5):
1932
super(BzrBranch, self)._synchronize_history(
1933
destination, revision_id)
1935
if revision_id == _mod_revision.NULL_REVISION:
1938
new_history = self.revision_history()
1939
if revision_id is not None and new_history != []:
1941
new_history = new_history[:new_history.index(revision_id) + 1]
1943
rev = self.repository.get_revision(revision_id)
1944
new_history = rev.get_history(self.repository)[1:]
1945
destination.set_revision_history(new_history)
1948
def set_last_revision_info(self, revno, revision_id):
1949
"""Set the last revision of this branch.
1951
The caller is responsible for checking that the revno is correct
1952
for this revision id.
1954
It may be possible to set the branch last revision to an id not
1955
present in the repository. However, branches can also be
1956
configured to check constraints on history, in which case this may not
1959
revision_id = _mod_revision.ensure_null(revision_id)
1960
# this old format stores the full history, but this api doesn't
1961
# provide it, so we must generate, and might as well check it's
1963
history = self._lefthand_history(revision_id)
1964
if len(history) != revno:
1965
raise AssertionError('%d != %d' % (len(history), revno))
1966
self.set_revision_history(history)
1968
def _gen_revision_history(self):
1969
history = self._transport.get_bytes('revision-history').split('\n')
1970
if history[-1:] == ['']:
1971
# There shouldn't be a trailing newline, but just in case.
1976
def generate_revision_history(self, revision_id, last_rev=None,
1978
"""Create a new revision history that will finish with revision_id.
1980
:param revision_id: the new tip to use.
1981
:param last_rev: The previous last_revision. If not None, then this
1982
must be a ancestory of revision_id, or DivergedBranches is raised.
1983
:param other_branch: The other branch that DivergedBranches should
1984
raise with respect to.
1986
self.set_revision_history(self._lefthand_history(revision_id,
1987
last_rev, other_branch))
1989
def basis_tree(self):
1990
"""See Branch.basis_tree."""
1991
return self.repository.revision_tree(self.last_revision())
1994
def pull(self, source, overwrite=False, stop_revision=None,
1995
_hook_master=None, run_hooks=True, possible_transports=None,
1996
_override_hook_target=None):
1999
:param _hook_master: Private parameter - set the branch to
2000
be supplied as the master to pull hooks.
2001
:param run_hooks: Private parameter - if false, this branch
2002
is being called because it's the master of the primary branch,
2003
so it should not run its hooks.
2004
:param _override_hook_target: Private parameter - set the branch to be
2005
supplied as the target_branch to pull hooks.
2007
result = PullResult()
2008
result.source_branch = source
2009
if _override_hook_target is None:
2010
result.target_branch = self
2012
result.target_branch = _override_hook_target
2015
# We assume that during 'pull' the local repository is closer than
2017
graph = self.repository.get_graph(source.repository)
2018
result.old_revno, result.old_revid = self.last_revision_info()
2019
self.update_revisions(source, stop_revision, overwrite=overwrite,
2021
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
2022
result.new_revno, result.new_revid = self.last_revision_info()
2024
result.master_branch = _hook_master
2025
result.local_branch = result.target_branch
2027
result.master_branch = result.target_branch
2028
result.local_branch = None
2030
for hook in Branch.hooks['post_pull']:
2036
def _get_parent_location(self):
2037
_locs = ['parent', 'pull', 'x-pull']
2040
return self._transport.get_bytes(l).strip('\n')
2041
except errors.NoSuchFile:
2046
def push(self, target, overwrite=False, stop_revision=None,
2047
_override_hook_source_branch=None):
2050
This is the basic concrete implementation of push()
2052
:param _override_hook_source_branch: If specified, run
2053
the hooks passing this Branch as the source, rather than self.
2054
This is for use of RemoteBranch, where push is delegated to the
2055
underlying vfs-based Branch.
2057
# TODO: Public option to disable running hooks - should be trivial but
2059
return _run_with_write_locked_target(
2060
target, self._push_with_bound_branches, target, overwrite,
2062
_override_hook_source_branch=_override_hook_source_branch)
2064
def _push_with_bound_branches(self, target, overwrite,
2066
_override_hook_source_branch=None):
2067
"""Push from self into target, and into target's master if any.
2069
This is on the base BzrBranch class even though it doesn't support
2070
bound branches because the *target* might be bound.
2073
if _override_hook_source_branch:
2074
result.source_branch = _override_hook_source_branch
2075
for hook in Branch.hooks['post_push']:
2078
bound_location = target.get_bound_location()
2079
if bound_location and target.base != bound_location:
2080
# there is a master branch.
2082
# XXX: Why the second check? Is it even supported for a branch to
2083
# be bound to itself? -- mbp 20070507
2084
master_branch = target.get_master_branch()
2085
master_branch.lock_write()
2087
# push into the master from this branch.
2088
self._basic_push(master_branch, overwrite, stop_revision)
2089
# and push into the target branch from this. Note that we push from
2090
# this branch again, because its considered the highest bandwidth
2092
result = self._basic_push(target, overwrite, stop_revision)
2093
result.master_branch = master_branch
2094
result.local_branch = target
2098
master_branch.unlock()
2101
result = self._basic_push(target, overwrite, stop_revision)
2102
# TODO: Why set master_branch and local_branch if there's no
2103
# binding? Maybe cleaner to just leave them unset? -- mbp
2105
result.master_branch = target
2106
result.local_branch = None
2110
def _basic_push(self, target, overwrite, stop_revision):
2111
"""Basic implementation of push without bound branches or hooks.
2113
Must be called with self read locked and target write locked.
2115
result = BranchPushResult()
2116
result.source_branch = self
2117
result.target_branch = target
2118
result.old_revno, result.old_revid = target.last_revision_info()
2119
if result.old_revid != self.last_revision():
2120
# We assume that during 'push' this repository is closer than
2122
graph = self.repository.get_graph(target.repository)
2123
target.update_revisions(self, stop_revision, overwrite=overwrite,
2125
if self._push_should_merge_tags():
2126
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
2127
result.new_revno, result.new_revid = target.last_revision_info()
2130
def get_stacked_on_url(self):
2131
raise errors.UnstackableBranchFormat(self._format, self.base)
2133
def set_push_location(self, location):
2134
"""See Branch.set_push_location."""
2135
self.get_config().set_user_option(
2136
'push_location', location,
2137
store=_mod_config.STORE_LOCATION_NORECURSE)
2140
def set_parent(self, url):
2141
"""See Branch.set_parent."""
2142
# TODO: Maybe delete old location files?
2143
# URLs should never be unicode, even on the local fs,
2144
# FIXUP this and get_parent in a future branch format bump:
2145
# read and rewrite the file. RBC 20060125
2147
if isinstance(url, unicode):
2149
url = url.encode('ascii')
2150
except UnicodeEncodeError:
2151
raise errors.InvalidURL(url,
2152
"Urls must be 7-bit ascii, "
2153
"use bzrlib.urlutils.escape")
2154
url = urlutils.relative_url(self.base, url)
2155
self._set_parent_location(url)
2157
def _set_parent_location(self, url):
2159
self._transport.delete('parent')
2161
self._transport.put_bytes('parent', url + '\n',
2162
mode=self.bzrdir._get_file_mode())
2164
def set_stacked_on_url(self, url):
2165
raise errors.UnstackableBranchFormat(self._format, self.base)
2168
class BzrBranch5(BzrBranch):
2169
"""A format 5 branch. This supports new features over plain branches.
2171
It has support for a master_branch which is the data for bound branches.
2175
def pull(self, source, overwrite=False, stop_revision=None,
2176
run_hooks=True, possible_transports=None,
2177
_override_hook_target=None):
2178
"""Pull from source into self, updating my master if any.
2180
:param run_hooks: Private parameter - if false, this branch
2181
is being called because it's the master of the primary branch,
2182
so it should not run its hooks.
2184
bound_location = self.get_bound_location()
2185
master_branch = None
2186
if bound_location and source.base != bound_location:
2187
# not pulling from master, so we need to update master.
2188
master_branch = self.get_master_branch(possible_transports)
2189
master_branch.lock_write()
2192
# pull from source into master.
2193
master_branch.pull(source, overwrite, stop_revision,
2195
return super(BzrBranch5, self).pull(source, overwrite,
2196
stop_revision, _hook_master=master_branch,
2197
run_hooks=run_hooks,
2198
_override_hook_target=_override_hook_target)
2201
master_branch.unlock()
2203
def get_bound_location(self):
2205
return self._transport.get_bytes('bound')[:-1]
2206
except errors.NoSuchFile:
2210
def get_master_branch(self, possible_transports=None):
2211
"""Return the branch we are bound to.
2213
:return: Either a Branch, or None
2215
This could memoise the branch, but if thats done
2216
it must be revalidated on each new lock.
2217
So for now we just don't memoise it.
2218
# RBC 20060304 review this decision.
2220
bound_loc = self.get_bound_location()
2224
return Branch.open(bound_loc,
2225
possible_transports=possible_transports)
2226
except (errors.NotBranchError, errors.ConnectionError), e:
2227
raise errors.BoundBranchConnectionFailure(
2231
def set_bound_location(self, location):
2232
"""Set the target where this branch is bound to.
2234
:param location: URL to the target branch
2237
self._transport.put_bytes('bound', location+'\n',
2238
mode=self.bzrdir._get_file_mode())
2241
self._transport.delete('bound')
2242
except errors.NoSuchFile:
2247
def bind(self, other):
2248
"""Bind this branch to the branch other.
2250
This does not push or pull data between the branches, though it does
2251
check for divergence to raise an error when the branches are not
2252
either the same, or one a prefix of the other. That behaviour may not
2253
be useful, so that check may be removed in future.
2255
:param other: The branch to bind to
2258
# TODO: jam 20051230 Consider checking if the target is bound
2259
# It is debatable whether you should be able to bind to
2260
# a branch which is itself bound.
2261
# Committing is obviously forbidden,
2262
# but binding itself may not be.
2263
# Since we *have* to check at commit time, we don't
2264
# *need* to check here
2266
# we want to raise diverged if:
2267
# last_rev is not in the other_last_rev history, AND
2268
# other_last_rev is not in our history, and do it without pulling
2270
self.set_bound_location(other.base)
2274
"""If bound, unbind"""
2275
return self.set_bound_location(None)
2278
def update(self, possible_transports=None):
2279
"""Synchronise this branch with the master branch if any.
2281
:return: None or the last_revision that was pivoted out during the
2284
master = self.get_master_branch(possible_transports)
2285
if master is not None:
2286
old_tip = _mod_revision.ensure_null(self.last_revision())
2287
self.pull(master, overwrite=True)
2288
if self.repository.get_graph().is_ancestor(old_tip,
2289
_mod_revision.ensure_null(self.last_revision())):
2295
class BzrBranch7(BzrBranch5):
2296
"""A branch with support for a fallback repository."""
2298
def _get_fallback_repository(self, url):
2299
"""Get the repository we fallback to at url."""
2300
url = urlutils.join(self.base, url)
2301
a_bzrdir = bzrdir.BzrDir.open(url,
2302
possible_transports=[self._transport])
2303
return a_bzrdir.open_branch().repository
2305
def _activate_fallback_location(self, url):
2306
"""Activate the branch/repository from url as a fallback repository."""
2307
self.repository.add_fallback_repository(
2308
self._get_fallback_repository(url))
2310
def _open_hook(self):
2311
if self._ignore_fallbacks:
2314
url = self.get_stacked_on_url()
2315
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2316
errors.UnstackableBranchFormat):
2319
for hook in Branch.hooks['transform_fallback_location']:
2320
url = hook(self, url)
2322
hook_name = Branch.hooks.get_hook_name(hook)
2323
raise AssertionError(
2324
"'transform_fallback_location' hook %s returned "
2325
"None, not a URL." % hook_name)
2326
self._activate_fallback_location(url)
2328
def _check_stackable_repo(self):
2329
if not self.repository._format.supports_external_lookups:
2330
raise errors.UnstackableRepositoryFormat(self.repository._format,
2331
self.repository.base)
2333
def __init__(self, *args, **kwargs):
2334
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2335
super(BzrBranch7, self).__init__(*args, **kwargs)
2336
self._last_revision_info_cache = None
2337
self._partial_revision_history_cache = []
2339
def _clear_cached_state(self):
2340
super(BzrBranch7, self)._clear_cached_state()
2341
self._last_revision_info_cache = None
2342
self._partial_revision_history_cache = []
2344
def _last_revision_info(self):
2345
revision_string = self._transport.get_bytes('last-revision')
2346
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2347
revision_id = cache_utf8.get_cached_utf8(revision_id)
2349
return revno, revision_id
2351
def _write_last_revision_info(self, revno, revision_id):
2352
"""Simply write out the revision id, with no checks.
2354
Use set_last_revision_info to perform this safely.
2356
Does not update the revision_history cache.
2357
Intended to be called by set_last_revision_info and
2358
_write_revision_history.
2360
revision_id = _mod_revision.ensure_null(revision_id)
2361
out_string = '%d %s\n' % (revno, revision_id)
2362
self._transport.put_bytes('last-revision', out_string,
2363
mode=self.bzrdir._get_file_mode())
2366
def set_last_revision_info(self, revno, revision_id):
2367
revision_id = _mod_revision.ensure_null(revision_id)
2368
old_revno, old_revid = self.last_revision_info()
2369
if self._get_append_revisions_only():
2370
self._check_history_violation(revision_id)
2371
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2372
self._write_last_revision_info(revno, revision_id)
2373
self._clear_cached_state()
2374
self._last_revision_info_cache = revno, revision_id
2375
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2377
def _synchronize_history(self, destination, revision_id):
2378
"""Synchronize last revision and revision history between branches.
2380
:see: Branch._synchronize_history
2382
# XXX: The base Branch has a fast implementation of this method based
2383
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2384
# that uses set_revision_history. This class inherits from BzrBranch5,
2385
# but wants the fast implementation, so it calls
2386
# Branch._synchronize_history directly.
2387
Branch._synchronize_history(self, destination, revision_id)
2389
def _check_history_violation(self, revision_id):
2390
last_revision = _mod_revision.ensure_null(self.last_revision())
2391
if _mod_revision.is_null(last_revision):
2393
if last_revision not in self._lefthand_history(revision_id):
2394
raise errors.AppendRevisionsOnlyViolation(self.base)
2396
def _gen_revision_history(self):
2397
"""Generate the revision history from last revision
2399
last_revno, last_revision = self.last_revision_info()
2400
self._extend_partial_history(stop_index=last_revno-1)
2401
return list(reversed(self._partial_revision_history_cache))
2403
def _extend_partial_history(self, stop_index=None, stop_revision=None):
2404
"""Extend the partial history to include a given index
2406
If a stop_index is supplied, stop when that index has been reached.
2407
If a stop_revision is supplied, stop when that revision is
2408
encountered. Otherwise, stop when the beginning of history is
2411
:param stop_index: The index which should be present. When it is
2412
present, history extension will stop.
2413
:param revision_id: The revision id which should be present. When
2414
it is encountered, history extension will stop.
2416
repo = self.repository
2417
if len(self._partial_revision_history_cache) == 0:
2418
iterator = repo.iter_reverse_revision_history(self.last_revision())
2420
start_revision = self._partial_revision_history_cache[-1]
2421
iterator = repo.iter_reverse_revision_history(start_revision)
2422
#skip the last revision in the list
2423
next_revision = iterator.next()
2424
for revision_id in iterator:
2425
self._partial_revision_history_cache.append(revision_id)
2426
if (stop_index is not None and
2427
len(self._partial_revision_history_cache) > stop_index):
2429
if revision_id == stop_revision:
2432
def _write_revision_history(self, history):
2433
"""Factored out of set_revision_history.
2435
This performs the actual writing to disk, with format-specific checks.
2436
It is intended to be called by BzrBranch5.set_revision_history.
2438
if len(history) == 0:
2439
last_revision = 'null:'
2441
if history != self._lefthand_history(history[-1]):
2442
raise errors.NotLefthandHistory(history)
2443
last_revision = history[-1]
2444
if self._get_append_revisions_only():
2445
self._check_history_violation(last_revision)
2446
self._write_last_revision_info(len(history), last_revision)
2449
def _set_parent_location(self, url):
2450
"""Set the parent branch"""
2451
self._set_config_location('parent_location', url, make_relative=True)
2454
def _get_parent_location(self):
2455
"""Set the parent branch"""
2456
return self._get_config_location('parent_location')
2458
def set_push_location(self, location):
2459
"""See Branch.set_push_location."""
2460
self._set_config_location('push_location', location)
2462
def set_bound_location(self, location):
2463
"""See Branch.set_push_location."""
2465
config = self.get_config()
2466
if location is None:
2467
if config.get_user_option('bound') != 'True':
2470
config.set_user_option('bound', 'False', warn_masked=True)
2473
self._set_config_location('bound_location', location,
2475
config.set_user_option('bound', 'True', warn_masked=True)
2478
def _get_bound_location(self, bound):
2479
"""Return the bound location in the config file.
2481
Return None if the bound parameter does not match"""
2482
config = self.get_config()
2483
config_bound = (config.get_user_option('bound') == 'True')
2484
if config_bound != bound:
2486
return self._get_config_location('bound_location', config=config)
2488
def get_bound_location(self):
2489
"""See Branch.set_push_location."""
2490
return self._get_bound_location(True)
2492
def get_old_bound_location(self):
2493
"""See Branch.get_old_bound_location"""
2494
return self._get_bound_location(False)
2496
def get_stacked_on_url(self):
2497
# you can always ask for the URL; but you might not be able to use it
2498
# if the repo can't support stacking.
2499
## self._check_stackable_repo()
2500
stacked_url = self._get_config_location('stacked_on_location')
2501
if stacked_url is None:
2502
raise errors.NotStacked(self)
2505
def set_append_revisions_only(self, enabled):
2510
self.get_config().set_user_option('append_revisions_only', value,
2513
def set_stacked_on_url(self, url):
2514
self._check_stackable_repo()
2517
old_url = self.get_stacked_on_url()
2518
except (errors.NotStacked, errors.UnstackableBranchFormat,
2519
errors.UnstackableRepositoryFormat):
2522
# repositories don't offer an interface to remove fallback
2523
# repositories today; take the conceptually simpler option and just
2525
self.repository = self.bzrdir.find_repository()
2526
# for every revision reference the branch has, ensure it is pulled
2528
source_repository = self._get_fallback_repository(old_url)
2529
for revision_id in chain([self.last_revision()],
2530
self.tags.get_reverse_tag_dict()):
2531
self.repository.fetch(source_repository, revision_id,
2534
self._activate_fallback_location(url)
2535
# write this out after the repository is stacked to avoid setting a
2536
# stacked config that doesn't work.
2537
self._set_config_location('stacked_on_location', url)
2539
def _get_append_revisions_only(self):
2540
value = self.get_config().get_user_option('append_revisions_only')
2541
return value == 'True'
2544
def generate_revision_history(self, revision_id, last_rev=None,
2546
"""See BzrBranch5.generate_revision_history"""
2547
history = self._lefthand_history(revision_id, last_rev, other_branch)
2548
revno = len(history)
2549
self.set_last_revision_info(revno, revision_id)
2552
def get_rev_id(self, revno, history=None):
2553
"""Find the revision id of the specified revno."""
2555
return _mod_revision.NULL_REVISION
2557
last_revno, last_revision_id = self.last_revision_info()
2558
if revno <= 0 or revno > last_revno:
2559
raise errors.NoSuchRevision(self, revno)
2561
if history is not None:
2562
return history[revno - 1]
2564
index = last_revno - revno
2565
if len(self._partial_revision_history_cache) <= index:
2566
self._extend_partial_history(stop_index=index)
2567
if len(self._partial_revision_history_cache) > index:
2568
return self._partial_revision_history_cache[index]
2570
raise errors.NoSuchRevision(self, revno)
2573
def revision_id_to_revno(self, revision_id):
2574
"""Given a revision id, return its revno"""
2575
if _mod_revision.is_null(revision_id):
2578
index = self._partial_revision_history_cache.index(revision_id)
2580
self._extend_partial_history(stop_revision=revision_id)
2581
index = len(self._partial_revision_history_cache) - 1
2582
if self._partial_revision_history_cache[index] != revision_id:
2583
raise errors.NoSuchRevision(self, revision_id)
2584
return self.revno() - index
2587
class BzrBranch6(BzrBranch7):
2588
"""See BzrBranchFormat6 for the capabilities of this branch.
2590
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2594
def get_stacked_on_url(self):
2595
raise errors.UnstackableBranchFormat(self._format, self.base)
2597
def set_stacked_on_url(self, url):
2598
raise errors.UnstackableBranchFormat(self._format, self.base)
1403
2601
######################################################################
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))
2602
# results of operations
2605
class _Result(object):
2607
def _show_tag_conficts(self, to_file):
2608
if not getattr(self, 'tag_conflicts', None):
2610
to_file.write('Conflicting tags:\n')
2611
for name, value1, value2 in self.tag_conflicts:
2612
to_file.write(' %s\n' % (name, ))
2615
class PullResult(_Result):
2616
"""Result of a Branch.pull operation.
2618
:ivar old_revno: Revision number before pull.
2619
:ivar new_revno: Revision number after pull.
2620
:ivar old_revid: Tip revision id before pull.
2621
:ivar new_revid: Tip revision id after pull.
2622
:ivar source_branch: Source (local) branch object. (read locked)
2623
:ivar master_branch: Master branch of the target, or the target if no
2625
:ivar local_branch: target branch if there is a Master, else None
2626
:ivar target_branch: Target/destination branch object. (write locked)
2627
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2631
# DEPRECATED: pull used to return the change in revno
2632
return self.new_revno - self.old_revno
2634
def report(self, to_file):
2636
if self.old_revid == self.new_revid:
2637
to_file.write('No revisions to pull.\n')
2639
to_file.write('Now on revision %d.\n' % self.new_revno)
2640
self._show_tag_conficts(to_file)
2643
class BranchPushResult(_Result):
2644
"""Result of a Branch.push operation.
2646
:ivar old_revno: Revision number (eg 10) of the target before push.
2647
:ivar new_revno: Revision number (eg 12) of the target after push.
2648
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
2650
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
2652
:ivar source_branch: Source branch object that the push was from. This is
2653
read locked, and generally is a local (and thus low latency) branch.
2654
:ivar master_branch: If target is a bound branch, the master branch of
2655
target, or target itself. Always write locked.
2656
:ivar target_branch: The direct Branch where data is being sent (write
2658
:ivar local_branch: If the target is a bound branch this will be the
2659
target, otherwise it will be None.
2663
# DEPRECATED: push used to return the change in revno
2664
return self.new_revno - self.old_revno
2666
def report(self, to_file):
2667
"""Write a human-readable description of the result."""
2668
if self.old_revid == self.new_revid:
2669
note('No new revisions to push.')
2671
note('Pushed up to revision %d.' % self.new_revno)
2672
self._show_tag_conficts(to_file)
2675
class BranchCheckResult(object):
2676
"""Results of checking branch consistency.
2681
def __init__(self, branch):
2682
self.branch = branch
2684
def report_results(self, verbose):
2685
"""Report the check results via trace.note.
2687
:param verbose: Requests more detailed display of what was checked,
2690
note('checked branch %s format %s',
2692
self.branch._format)
2695
class Converter5to6(object):
2696
"""Perform an in-place upgrade of format 5 to format 6"""
2698
def convert(self, branch):
2699
# Data for 5 and 6 can peacefully coexist.
2700
format = BzrBranchFormat6()
2701
new_branch = format.open(branch.bzrdir, _found=True)
2703
# Copy source data into target
2704
new_branch._write_last_revision_info(*branch.last_revision_info())
2705
new_branch.set_parent(branch.get_parent())
2706
new_branch.set_bound_location(branch.get_bound_location())
2707
new_branch.set_push_location(branch.get_push_location())
2709
# New branch has no tags by default
2710
new_branch.tags._set_tag_dict({})
2712
# Copying done; now update target format
2713
new_branch._transport.put_bytes('format',
2714
format.get_format_string(),
2715
mode=new_branch.bzrdir._get_file_mode())
2717
# Clean up old files
2718
new_branch._transport.delete('revision-history')
2720
branch.set_parent(None)
2721
except errors.NoSuchFile:
2723
branch.set_bound_location(None)
2726
class Converter6to7(object):
2727
"""Perform an in-place upgrade of format 6 to format 7"""
2729
def convert(self, branch):
2730
format = BzrBranchFormat7()
2731
branch._set_config_location('stacked_on_location', '')
2732
# update target format
2733
branch._transport.put_bytes('format', format.get_format_string())
2737
def _run_with_write_locked_target(target, callable, *args, **kwargs):
2738
"""Run ``callable(*args, **kwargs)``, write-locking target for the
2741
_run_with_write_locked_target will attempt to release the lock it acquires.
2743
If an exception is raised by callable, then that exception *will* be
2744
propagated, even if the unlock attempt raises its own error. Thus
2745
_run_with_write_locked_target should be preferred to simply doing::
2749
return callable(*args, **kwargs)
2754
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
2755
# should share code?
2758
result = callable(*args, **kwargs)
2760
exc_info = sys.exc_info()
2764
raise exc_info[0], exc_info[1], exc_info[2]
2770
class InterBranch(InterObject):
2771
"""This class represents operations taking place between two branches.
2773
Its instances have methods like pull() and push() and contain
2774
references to the source and target repositories these operations
2775
can be carried out on.
2779
"""The available optimised InterBranch types."""
2782
def _get_branch_formats_to_test():
2783
"""Return a tuple with the Branch formats to use when testing."""
2784
raise NotImplementedError(self._get_branch_formats_to_test)
2786
def update_revisions(self, stop_revision=None, overwrite=False,
2788
"""Pull in new perfect-fit revisions.
2790
:param stop_revision: Updated until the given revision
2791
:param overwrite: Always set the branch pointer, rather than checking
2792
to see if it is a proper descendant.
2793
:param graph: A Graph object that can be used to query history
2794
information. This can be None.
2797
raise NotImplementedError(self.update_revisions)
2800
class GenericInterBranch(InterBranch):
2801
"""InterBranch implementation that uses public Branch functions.
2805
def _get_branch_formats_to_test():
2806
return BranchFormat._default_format, BranchFormat._default_format
2808
def update_revisions(self, stop_revision=None, overwrite=False,
2810
"""See InterBranch.update_revisions()."""
2811
self.source.lock_read()
2813
other_revno, other_last_revision = self.source.last_revision_info()
2814
stop_revno = None # unknown
2815
if stop_revision is None:
2816
stop_revision = other_last_revision
2817
if _mod_revision.is_null(stop_revision):
2818
# if there are no commits, we're done.
2820
stop_revno = other_revno
2822
# what's the current last revision, before we fetch [and change it
2824
last_rev = _mod_revision.ensure_null(self.target.last_revision())
2825
# we fetch here so that we don't process data twice in the common
2826
# case of having something to pull, and so that the check for
2827
# already merged can operate on the just fetched graph, which will
2828
# be cached in memory.
2829
self.target.fetch(self.source, stop_revision)
2830
# Check to see if one is an ancestor of the other
2833
graph = self.target.repository.get_graph()
2834
if self.target._check_if_descendant_or_diverged(
2835
stop_revision, last_rev, graph, self.source):
2836
# stop_revision is a descendant of last_rev, but we aren't
2837
# overwriting, so we're done.
2839
if stop_revno is None:
2841
graph = self.target.repository.get_graph()
2842
this_revno, this_last_revision = \
2843
self.target.last_revision_info()
2844
stop_revno = graph.find_distance_to_null(stop_revision,
2845
[(other_last_revision, other_revno),
2846
(this_last_revision, this_revno)])
2847
self.target.set_last_revision_info(stop_revno, stop_revision)
2849
self.source.unlock()
2852
def is_compatible(self, source, target):
2853
# GenericBranch uses the public API, so always compatible
2857
InterBranch.register_optimiser(GenericInterBranch)
added
removed
bzrlib/branch.py
