137
78
"""Branch holding a history of revisions.
140
Base directory of the branch.
146
If _lock_mode is true, a positive count of the number of times the
150
Lock object from bzrlib.lock.
81
Base directory/url of the branch.
83
hooks: An instance of BranchHooks.
85
# this is really an instance variable - FIXME move it there
157
# Map some sort of prefix into a namespace
158
# stuff like "revno:10", "revid:", etc.
159
# This should match a prefix with a function which accepts
160
REVISION_NAMESPACES = {}
162
def __init__(self, base, init=False, find_root=True):
163
"""Create new branch object at a particular location.
165
base -- Base directory for the branch.
167
init -- If True, create new control files in a previously
168
unversioned directory. If False, the branch must already
171
find_root -- If true and init is false, find the root of the
172
existing branch containing base.
174
In the test suite, creation of new trees is tested using the
175
`ScratchBranch` class.
177
from bzrlib.store import ImmutableStore
179
self.base = os.path.realpath(base)
182
self.base = find_branch_root(base)
184
self.base = os.path.realpath(base)
185
if not isdir(self.controlfilename('.')):
186
from errors import NotBranchError
187
raise NotBranchError("not a bzr branch: %s" % quotefn(base),
188
['use "bzr init" to initialize a new working tree',
189
'current bzr can only operate from top-of-tree'])
192
self.text_store = ImmutableStore(self.controlfilename('text-store'))
193
self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
194
self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
198
return '%s(%r)' % (self.__class__.__name__, self.base)
205
if self._lock_mode or self._lock:
206
from warnings import warn
207
warn("branch %r was not explicitly unlocked" % self)
89
def __init__(self, *ignored, **ignored_too):
90
self.tags = self._format.make_tags(self)
91
self._revision_history_cache = None
92
self._revision_id_to_revno_cache = None
93
self._partial_revision_id_to_revno_cache = {}
94
self._partial_revision_history_cache = []
95
self._last_revision_info_cache = None
96
self._merge_sorted_revisions_cache = None
98
hooks = Branch.hooks['open']
102
def _open_hook(self):
103
"""Called by init to allow simpler extension of the base class."""
105
def _activate_fallback_location(self, url):
106
"""Activate the branch/repository from url as a fallback repository."""
107
repo = self._get_fallback_repository(url)
108
if repo.has_same_location(self.repository):
109
raise errors.UnstackableLocationError(self.base, url)
110
self.repository.add_fallback_repository(repo)
112
def break_lock(self):
113
"""Break a lock if one is present from another instance.
115
Uses the ui factory to ask for confirmation if the lock may be from
118
This will probe the repository for its lock as well.
120
self.control_files.break_lock()
121
self.repository.break_lock()
122
master = self.get_master_branch()
123
if master is not None:
126
def _check_stackable_repo(self):
127
if not self.repository._format.supports_external_lookups:
128
raise errors.UnstackableRepositoryFormat(self.repository._format,
129
self.repository.base)
131
def _extend_partial_history(self, stop_index=None, stop_revision=None):
132
"""Extend the partial history to include a given index
134
If a stop_index is supplied, stop when that index has been reached.
135
If a stop_revision is supplied, stop when that revision is
136
encountered. Otherwise, stop when the beginning of history is
139
:param stop_index: The index which should be present. When it is
140
present, history extension will stop.
141
:param stop_revision: The revision id which should be present. When
142
it is encountered, history extension will stop.
144
if len(self._partial_revision_history_cache) == 0:
145
self._partial_revision_history_cache = [self.last_revision()]
146
repository._iter_for_revno(
147
self.repository, self._partial_revision_history_cache,
148
stop_index=stop_index, stop_revision=stop_revision)
149
if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
150
self._partial_revision_history_cache.pop()
152
def _get_check_refs(self):
153
"""Get the references needed for check().
157
revid = self.last_revision()
158
return [('revision-existence', revid), ('lefthand-distance', revid)]
161
def open(base, _unsupported=False, possible_transports=None):
162
"""Open the branch rooted at base.
164
For instance, if the branch is at URL/.bzr/branch,
165
Branch.open(URL) -> a Branch instance.
167
control = bzrdir.BzrDir.open(base, _unsupported,
168
possible_transports=possible_transports)
169
return control.open_branch(_unsupported)
172
def open_from_transport(transport, _unsupported=False):
173
"""Open the branch rooted at transport"""
174
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
175
return control.open_branch(_unsupported)
178
def open_containing(url, possible_transports=None):
179
"""Open an existing branch which contains url.
181
This probes for a branch at url, and searches upwards from there.
183
Basically we keep looking up until we find the control directory or
184
run into the root. If there isn't one, raises NotBranchError.
185
If there is one and it is either an unrecognised format or an unsupported
186
format, UnknownFormatError or UnsupportedFormatError are raised.
187
If there is one, it is returned, along with the unused portion of url.
189
control, relpath = bzrdir.BzrDir.open_containing(url,
191
return control.open_branch(), relpath
193
def _push_should_merge_tags(self):
194
"""Should _basic_push merge this branch's tags into the target?
196
The default implementation returns False if this branch has no tags,
197
and True the rest of the time. Subclasses may override this.
199
return self.supports_tags() and self.tags.get_tag_dict()
201
def get_config(self):
202
return BranchConfig(self)
204
def _get_config(self):
205
"""Get the concrete config for just the config in this branch.
207
This is not intended for client use; see Branch.get_config for the
212
:return: An object supporting get_option and set_option.
214
raise NotImplementedError(self._get_config)
216
def _get_fallback_repository(self, url):
217
"""Get the repository we fallback to at url."""
218
url = urlutils.join(self.base, url)
219
a_bzrdir = bzrdir.BzrDir.open(url,
220
possible_transports=[self.bzrdir.root_transport])
221
return a_bzrdir.open_branch().repository
223
def _get_tags_bytes(self):
224
"""Get the bytes of a serialised tags dict.
226
Note that not all branches support tags, nor do all use the same tags
227
logic: this method is specific to BasicTags. Other tag implementations
228
may use the same method name and behave differently, safely, because
229
of the double-dispatch via
230
format.make_tags->tags_instance->get_tags_dict.
232
:return: The bytes of the tags file.
233
:seealso: Branch._set_tags_bytes.
235
return self._transport.get_bytes('tags')
237
def _get_nick(self, local=False, possible_transports=None):
238
config = self.get_config()
239
# explicit overrides master, but don't look for master if local is True
240
if not local and not config.has_explicit_nickname():
242
master = self.get_master_branch(possible_transports)
243
if master is not None:
244
# return the master branch value
246
except errors.BzrError, e:
247
# Silently fall back to local implicit nick if the master is
249
mutter("Could not connect to bound branch, "
250
"falling back to local nick.\n " + str(e))
251
return config.get_nickname()
253
def _set_nick(self, nick):
254
self.get_config().set_user_option('nickname', nick, warn_masked=True)
256
nick = property(_get_nick, _set_nick)
259
raise NotImplementedError(self.is_locked)
261
def _lefthand_history(self, revision_id, last_rev=None,
263
if 'evil' in debug.debug_flags:
264
mutter_callsite(4, "_lefthand_history scales with history.")
265
# stop_revision must be a descendant of last_revision
266
graph = self.repository.get_graph()
267
if last_rev is not None:
268
if not graph.is_ancestor(last_rev, revision_id):
269
# our previous tip is not merged into stop_revision
270
raise errors.DivergedBranches(self, other_branch)
271
# make a new revision history from the graph
272
parents_map = graph.get_parent_map([revision_id])
273
if revision_id not in parents_map:
274
raise errors.NoSuchRevision(self, revision_id)
275
current_rev_id = revision_id
277
check_not_reserved_id = _mod_revision.check_not_reserved_id
278
# Do not include ghosts or graph origin in revision_history
279
while (current_rev_id in parents_map and
280
len(parents_map[current_rev_id]) > 0):
281
check_not_reserved_id(current_rev_id)
282
new_history.append(current_rev_id)
283
current_rev_id = parents_map[current_rev_id][0]
284
parents_map = graph.get_parent_map([current_rev_id])
285
new_history.reverse()
212
288
def lock_write(self):
214
if self._lock_mode != 'w':
215
from errors import LockError
216
raise LockError("can't upgrade to a write lock from %r" %
218
self._lock_count += 1
220
from bzrlib.lock import WriteLock
222
self._lock = WriteLock(self.controlfilename('branch-lock'))
223
self._lock_mode = 'w'
289
raise NotImplementedError(self.lock_write)
228
291
def lock_read(self):
230
assert self._lock_mode in ('r', 'w'), \
231
"invalid lock mode %r" % self._lock_mode
232
self._lock_count += 1
234
from bzrlib.lock import ReadLock
236
self._lock = ReadLock(self.controlfilename('branch-lock'))
237
self._lock_mode = 'r'
292
raise NotImplementedError(self.lock_read)
242
294
def unlock(self):
243
if not self._lock_mode:
244
from errors import LockError
245
raise LockError('branch %r is not locked' % (self))
247
if self._lock_count > 1:
248
self._lock_count -= 1
252
self._lock_mode = self._lock_count = None
255
def abspath(self, name):
256
"""Return absolute filename for something in the branch"""
257
return os.path.join(self.base, name)
260
def relpath(self, path):
261
"""Return path relative to this branch of something inside it.
263
Raises an error if path is not in this branch."""
264
return _relpath(self.base, path)
267
def controlfilename(self, file_or_path):
268
"""Return location relative to branch."""
269
if isinstance(file_or_path, basestring):
270
file_or_path = [file_or_path]
271
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
274
def controlfile(self, file_or_path, mode='r'):
275
"""Open a control file for this branch.
277
There are two classes of file in the control directory: text
278
and binary. binary files are untranslated byte streams. Text
279
control files are stored with Unix newlines and in UTF-8, even
280
if the platform or locale defaults are different.
282
Controlfiles should almost never be opened in write mode but
283
rather should be atomically copied and replaced using atomicfile.
286
fn = self.controlfilename(file_or_path)
288
if mode == 'rb' or mode == 'wb':
289
return file(fn, mode)
290
elif mode == 'r' or mode == 'w':
291
# open in binary mode anyhow so there's no newline translation;
292
# codecs uses line buffering by default; don't want that.
294
return codecs.open(fn, mode + 'b', 'utf-8',
297
raise BzrError("invalid controlfile mode %r" % mode)
301
def _make_control(self):
302
from bzrlib.inventory import Inventory
303
from bzrlib.xml import pack_xml
305
os.mkdir(self.controlfilename([]))
306
self.controlfile('README', 'w').write(
307
"This is a Bazaar-NG control directory.\n"
308
"Do not change any files in this directory.\n")
309
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
310
for d in ('text-store', 'inventory-store', 'revision-store'):
311
os.mkdir(self.controlfilename(d))
312
for f in ('revision-history', 'merged-patches',
313
'pending-merged-patches', 'branch-name',
316
self.controlfile(f, 'w').write('')
317
mutter('created control directory in ' + self.base)
319
pack_xml(Inventory(gen_root_id()), self.controlfile('inventory','w'))
322
def _check_format(self):
323
"""Check this branch format is supported.
325
The current tool only supports the current unstable format.
327
In the future, we might need different in-memory Branch
328
classes to support downlevel branches. But not yet.
330
# This ignores newlines so that we can open branches created
331
# on Windows from Linux and so on. I think it might be better
332
# to always make all internal files in unix format.
333
fmt = self.controlfile('branch-format', 'r').read()
334
fmt.replace('\r\n', '')
335
if fmt != BZR_BRANCH_FORMAT:
336
raise BzrError('sorry, branch format %r not supported' % fmt,
337
['use a different bzr version',
338
'or remove the .bzr directory and "bzr init" again'])
340
def get_root_id(self):
341
"""Return the id of this branches root"""
342
inv = self.read_working_inventory()
343
return inv.root.file_id
345
def set_root_id(self, file_id):
346
inv = self.read_working_inventory()
347
orig_root_id = inv.root.file_id
348
del inv._byid[inv.root.file_id]
349
inv.root.file_id = file_id
350
inv._byid[inv.root.file_id] = inv.root
353
if entry.parent_id in (None, orig_root_id):
354
entry.parent_id = inv.root.file_id
355
self._write_inventory(inv)
357
def read_working_inventory(self):
358
"""Read the working inventory."""
359
from bzrlib.inventory import Inventory
360
from bzrlib.xml import unpack_xml
361
from time import time
365
# ElementTree does its own conversion from UTF-8, so open in
367
inv = unpack_xml(Inventory,
368
self.controlfile('inventory', 'rb'))
369
mutter("loaded inventory of %d items in %f"
370
% (len(inv), time() - before))
376
def _write_inventory(self, inv):
377
"""Update the working inventory.
379
That is to say, the inventory describing changes underway, that
380
will be committed to the next revision.
382
from bzrlib.atomicfile import AtomicFile
383
from bzrlib.xml import pack_xml
387
f = AtomicFile(self.controlfilename('inventory'), 'wb')
396
mutter('wrote working inventory')
399
inventory = property(read_working_inventory, _write_inventory, None,
400
"""Inventory for the working copy.""")
403
def add(self, files, verbose=False, ids=None):
404
"""Make files versioned.
406
Note that the command line normally calls smart_add instead.
408
This puts the files in the Added state, so that they will be
409
recorded by the next commit.
412
List of paths to add, relative to the base of the tree.
415
If set, use these instead of automatically generated ids.
416
Must be the same length as the list of files, but may
417
contain None for ids that are to be autogenerated.
419
TODO: Perhaps have an option to add the ids even if the files do
422
TODO: Perhaps return the ids of the files? But then again it
423
is easy to retrieve them if they're needed.
425
TODO: Adding a directory should optionally recurse down and
426
add all non-ignored children. Perhaps do that in a
429
# TODO: Re-adding a file that is removed in the working copy
430
# should probably put it back with the previous ID.
431
if isinstance(files, basestring):
432
assert(ids is None or isinstance(ids, basestring))
438
ids = [None] * len(files)
440
assert(len(ids) == len(files))
444
inv = self.read_working_inventory()
445
for f,file_id in zip(files, ids):
446
if is_control_file(f):
447
raise BzrError("cannot add control file %s" % quotefn(f))
452
raise BzrError("cannot add top-level %r" % f)
454
fullpath = os.path.normpath(self.abspath(f))
457
kind = file_kind(fullpath)
459
# maybe something better?
460
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
462
if kind != 'file' and kind != 'directory':
463
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
466
file_id = gen_file_id(f)
467
inv.add_path(f, kind=kind, file_id=file_id)
470
print 'added', quotefn(f)
472
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
474
self._write_inventory(inv)
479
def print_file(self, file, revno):
480
"""Print `file` to stdout."""
483
tree = self.revision_tree(self.lookup_revision(revno))
484
# use inventory as it was in that revision
485
file_id = tree.inventory.path2id(file)
487
raise BzrError("%r is not present in revision %s" % (file, revno))
488
tree.print_file(file_id)
493
def remove(self, files, verbose=False):
494
"""Mark nominated files for removal from the inventory.
496
This does not remove their text. This does not run on
498
TODO: Refuse to remove modified files unless --force is given?
500
TODO: Do something useful with directories.
502
TODO: Should this remove the text or not? Tough call; not
503
removing may be useful and the user can just use use rm, and
504
is the opposite of add. Removing it is consistent with most
505
other tools. Maybe an option.
507
## TODO: Normalize names
508
## TODO: Remove nested loops; better scalability
509
if isinstance(files, basestring):
515
tree = self.working_tree()
518
# do this before any modifications
522
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
523
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
525
# having remove it, it must be either ignored or unknown
526
if tree.is_ignored(f):
530
show_status(new_status, inv[fid].kind, quotefn(f))
533
self._write_inventory(inv)
538
# FIXME: this doesn't need to be a branch method
539
def set_inventory(self, new_inventory_list):
540
from bzrlib.inventory import Inventory, InventoryEntry
541
inv = Inventory(self.get_root_id())
542
for path, file_id, parent, kind in new_inventory_list:
543
name = os.path.basename(path)
546
inv.add(InventoryEntry(file_id, name, kind, parent))
547
self._write_inventory(inv)
551
"""Return all unknown files.
553
These are files in the working directory that are not versioned or
554
control files or ignored.
556
>>> b = ScratchBranch(files=['foo', 'foo~'])
557
>>> list(b.unknowns())
560
>>> list(b.unknowns())
563
>>> list(b.unknowns())
566
return self.working_tree().unknowns()
569
def append_revision(self, *revision_ids):
570
from bzrlib.atomicfile import AtomicFile
572
for revision_id in revision_ids:
573
mutter("add {%s} to revision-history" % revision_id)
575
rev_history = self.revision_history()
576
rev_history.extend(revision_ids)
578
f = AtomicFile(self.controlfilename('revision-history'))
580
for rev_id in rev_history:
587
def get_revision_xml(self, revision_id):
588
"""Return XML file object for revision object."""
589
if not revision_id or not isinstance(revision_id, basestring):
590
raise InvalidRevisionId(revision_id)
595
return self.revision_store[revision_id]
597
raise bzrlib.errors.NoSuchRevision(revision_id)
602
def get_revision(self, revision_id):
603
"""Return the Revision object for a named revision"""
604
xml_file = self.get_revision_xml(revision_id)
607
r = unpack_xml(Revision, xml_file)
608
except SyntaxError, e:
609
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
613
assert r.revision_id == revision_id
295
raise NotImplementedError(self.unlock)
297
def peek_lock_mode(self):
298
"""Return lock mode for the Branch: 'r', 'w' or None"""
299
raise NotImplementedError(self.peek_lock_mode)
301
def get_physical_lock_status(self):
302
raise NotImplementedError(self.get_physical_lock_status)
305
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
306
"""Return the revision_id for a dotted revno.
308
:param revno: a tuple like (1,) or (1,1,2)
309
:param _cache_reverse: a private parameter enabling storage
310
of the reverse mapping in a top level cache. (This should
311
only be done in selective circumstances as we want to
312
avoid having the mapping cached multiple times.)
313
:return: the revision_id
314
:raises errors.NoSuchRevision: if the revno doesn't exist
316
rev_id = self._do_dotted_revno_to_revision_id(revno)
318
self._partial_revision_id_to_revno_cache[rev_id] = revno
321
def _do_dotted_revno_to_revision_id(self, revno):
322
"""Worker function for dotted_revno_to_revision_id.
324
Subclasses should override this if they wish to
325
provide a more efficient implementation.
328
return self.get_rev_id(revno[0])
329
revision_id_to_revno = self.get_revision_id_to_revno_map()
330
revision_ids = [revision_id for revision_id, this_revno
331
in revision_id_to_revno.iteritems()
332
if revno == this_revno]
333
if len(revision_ids) == 1:
334
return revision_ids[0]
336
revno_str = '.'.join(map(str, revno))
337
raise errors.NoSuchRevision(self, revno_str)
340
def revision_id_to_dotted_revno(self, revision_id):
341
"""Given a revision id, return its dotted revno.
343
:return: a tuple like (1,) or (400,1,3).
345
return self._do_revision_id_to_dotted_revno(revision_id)
347
def _do_revision_id_to_dotted_revno(self, revision_id):
348
"""Worker function for revision_id_to_revno."""
349
# Try the caches if they are loaded
350
result = self._partial_revision_id_to_revno_cache.get(revision_id)
351
if result is not None:
353
if self._revision_id_to_revno_cache:
354
result = self._revision_id_to_revno_cache.get(revision_id)
356
raise errors.NoSuchRevision(self, revision_id)
357
# Try the mainline as it's optimised
359
revno = self.revision_id_to_revno(revision_id)
361
except errors.NoSuchRevision:
362
# We need to load and use the full revno map after all
363
result = self.get_revision_id_to_revno_map().get(revision_id)
365
raise errors.NoSuchRevision(self, revision_id)
369
def get_revision_id_to_revno_map(self):
370
"""Return the revision_id => dotted revno map.
372
This will be regenerated on demand, but will be cached.
374
:return: A dictionary mapping revision_id => dotted revno.
375
This dictionary should not be modified by the caller.
377
if self._revision_id_to_revno_cache is not None:
378
mapping = self._revision_id_to_revno_cache
380
mapping = self._gen_revno_map()
381
self._cache_revision_id_to_revno(mapping)
382
# TODO: jam 20070417 Since this is being cached, should we be returning
384
# I would rather not, and instead just declare that users should not
385
# modify the return value.
388
def _gen_revno_map(self):
389
"""Create a new mapping from revision ids to dotted revnos.
391
Dotted revnos are generated based on the current tip in the revision
393
This is the worker function for get_revision_id_to_revno_map, which
394
just caches the return value.
396
:return: A dictionary mapping revision_id => dotted revno.
398
revision_id_to_revno = dict((rev_id, revno)
399
for rev_id, depth, revno, end_of_merge
400
in self.iter_merge_sorted_revisions())
401
return revision_id_to_revno
404
def iter_merge_sorted_revisions(self, start_revision_id=None,
405
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
406
"""Walk the revisions for a branch in merge sorted order.
408
Merge sorted order is the output from a merge-aware,
409
topological sort, i.e. all parents come before their
410
children going forward; the opposite for reverse.
412
:param start_revision_id: the revision_id to begin walking from.
413
If None, the branch tip is used.
414
:param stop_revision_id: the revision_id to terminate the walk
415
after. If None, the rest of history is included.
416
:param stop_rule: if stop_revision_id is not None, the precise rule
417
to use for termination:
418
* 'exclude' - leave the stop revision out of the result (default)
419
* 'include' - the stop revision is the last item in the result
420
* 'with-merges' - include the stop revision and all of its
421
merged revisions in the result
422
:param direction: either 'reverse' or 'forward':
423
* reverse means return the start_revision_id first, i.e.
424
start at the most recent revision and go backwards in history
425
* forward returns tuples in the opposite order to reverse.
426
Note in particular that forward does *not* do any intelligent
427
ordering w.r.t. depth as some clients of this API may like.
428
(If required, that ought to be done at higher layers.)
430
:return: an iterator over (revision_id, depth, revno, end_of_merge)
433
* revision_id: the unique id of the revision
434
* depth: How many levels of merging deep this node has been
436
* revno_sequence: This field provides a sequence of
437
revision numbers for all revisions. The format is:
438
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
439
branch that the revno is on. From left to right the REVNO numbers
440
are the sequence numbers within that branch of the revision.
441
* end_of_merge: When True the next node (earlier in history) is
442
part of a different merge.
444
# Note: depth and revno values are in the context of the branch so
445
# we need the full graph to get stable numbers, regardless of the
447
if self._merge_sorted_revisions_cache is None:
448
last_revision = self.last_revision()
449
graph = self.repository.get_graph()
450
parent_map = dict(((key, value) for key, value in
451
graph.iter_ancestry([last_revision]) if value is not None))
452
revision_graph = repository._strip_NULL_ghosts(parent_map)
453
revs = tsort.merge_sort(revision_graph, last_revision, None,
455
# Drop the sequence # before caching
456
self._merge_sorted_revisions_cache = [r[1:] for r in revs]
458
filtered = self._filter_merge_sorted_revisions(
459
self._merge_sorted_revisions_cache, start_revision_id,
460
stop_revision_id, stop_rule)
461
if direction == 'reverse':
463
if direction == 'forward':
464
return reversed(list(filtered))
466
raise ValueError('invalid direction %r' % direction)
468
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
469
start_revision_id, stop_revision_id, stop_rule):
470
"""Iterate over an inclusive range of sorted revisions."""
471
rev_iter = iter(merge_sorted_revisions)
472
if start_revision_id is not None:
473
for rev_id, depth, revno, end_of_merge in rev_iter:
474
if rev_id != start_revision_id:
477
# The decision to include the start or not
478
# depends on the stop_rule if a stop is provided
480
iter([(rev_id, depth, revno, end_of_merge)]),
483
if stop_revision_id is None:
484
for rev_id, depth, revno, end_of_merge in rev_iter:
485
yield rev_id, depth, revno, end_of_merge
486
elif stop_rule == 'exclude':
487
for rev_id, depth, revno, end_of_merge in rev_iter:
488
if rev_id == stop_revision_id:
490
yield rev_id, depth, revno, end_of_merge
491
elif stop_rule == 'include':
492
for rev_id, depth, revno, end_of_merge in rev_iter:
493
yield rev_id, depth, revno, end_of_merge
494
if rev_id == stop_revision_id:
496
elif stop_rule == 'with-merges':
497
stop_rev = self.repository.get_revision(stop_revision_id)
498
if stop_rev.parent_ids:
499
left_parent = stop_rev.parent_ids[0]
501
left_parent = _mod_revision.NULL_REVISION
502
for rev_id, depth, revno, end_of_merge in rev_iter:
503
if rev_id == left_parent:
505
yield rev_id, depth, revno, end_of_merge
507
raise ValueError('invalid stop_rule %r' % stop_rule)
509
def leave_lock_in_place(self):
510
"""Tell this branch object not to release the physical lock when this
513
If lock_write doesn't return a token, then this method is not supported.
515
self.control_files.leave_in_place()
517
def dont_leave_lock_in_place(self):
518
"""Tell this branch object to release the physical lock when this
519
object is unlocked, even if it didn't originally acquire it.
521
If lock_write doesn't return a token, then this method is not supported.
523
self.control_files.dont_leave_in_place()
525
def bind(self, other):
526
"""Bind the local branch the other branch.
528
:param other: The branch to bind to
531
raise errors.UpgradeRequired(self.base)
533
def set_append_revisions_only(self, enabled):
534
if not self._format.supports_set_append_revisions_only():
535
raise errors.UpgradeRequired(self.base)
540
self.get_config().set_user_option('append_revisions_only', value,
543
def set_reference_info(self, file_id, tree_path, branch_location):
544
"""Set the branch location to use for a tree reference."""
545
raise errors.UnsupportedOperation(self.set_reference_info, self)
547
def get_reference_info(self, file_id):
548
"""Get the tree_path and branch_location for a tree reference."""
549
raise errors.UnsupportedOperation(self.get_reference_info, self)
552
def fetch(self, from_branch, last_revision=None, pb=None):
553
"""Copy revisions from from_branch into this branch.
555
:param from_branch: Where to copy from.
556
:param last_revision: What revision to stop at (None for at the end
558
:param pb: An optional progress bar to use.
561
if self.base == from_branch.base:
564
symbol_versioning.warn(
565
symbol_versioning.deprecated_in((1, 14, 0))
566
% "pb parameter to fetch()")
567
from_branch.lock_read()
569
if last_revision is None:
570
last_revision = from_branch.last_revision()
571
last_revision = _mod_revision.ensure_null(last_revision)
572
return self.repository.fetch(from_branch.repository,
573
revision_id=last_revision,
578
def get_bound_location(self):
579
"""Return the URL of the branch we are bound to.
581
Older format branches cannot bind, please be sure to use a metadir
586
def get_old_bound_location(self):
587
"""Return the URL of the branch we used to be bound to
589
raise errors.UpgradeRequired(self.base)
591
def get_commit_builder(self, parents, config=None, timestamp=None,
592
timezone=None, committer=None, revprops=None,
594
"""Obtain a CommitBuilder for this branch.
596
:param parents: Revision ids of the parents of the new revision.
597
:param config: Optional configuration to use.
598
:param timestamp: Optional timestamp recorded for commit.
599
:param timezone: Optional timezone for timestamp.
600
:param committer: Optional committer to set for commit.
601
:param revprops: Optional dictionary of revision properties.
602
:param revision_id: Optional revision id.
606
config = self.get_config()
608
return self.repository.get_commit_builder(self, parents, config,
609
timestamp, timezone, committer, revprops, revision_id)
611
def get_master_branch(self, possible_transports=None):
612
"""Return the branch we are bound to.
614
:return: Either a Branch, or None
617
618
def get_revision_delta(self, revno):
618
619
"""Return the delta for one revision.
789
865
common_index = min(self_len, other_len) -1
790
866
if common_index >= 0 and \
791
867
self_history[common_index] != other_history[common_index]:
792
raise DivergedBranches(self, other)
868
raise errors.DivergedBranches(self, other)
794
870
if stop_revision is None:
795
871
stop_revision = other_len
796
elif stop_revision > other_len:
797
raise NoSuchRevision(self, stop_revision)
873
if stop_revision > other_len:
874
raise errors.NoSuchRevision(self, stop_revision)
799
875
return other_history[self_len:stop_revision]
802
def update_revisions(self, other, stop_revision=None):
803
"""Pull in all new revisions from other branch.
805
>>> from bzrlib.commit import commit
806
>>> bzrlib.trace.silent = True
807
>>> br1 = ScratchBranch(files=['foo', 'bar'])
810
>>> commit(br1, "lala!", rev_id="REVISION-ID-1", verbose=False)
811
>>> br2 = ScratchBranch()
812
>>> br2.update_revisions(br1)
816
>>> br2.revision_history()
818
>>> br2.update_revisions(br1)
822
>>> br1.text_store.total_size() == br2.text_store.total_size()
825
from bzrlib.progress import ProgressBar
829
pb.update('comparing histories')
830
revision_ids = self.missing_revisions(other, stop_revision)
832
if hasattr(other.revision_store, "prefetch"):
833
other.revision_store.prefetch(revision_ids)
834
if hasattr(other.inventory_store, "prefetch"):
835
inventory_ids = [other.get_revision(r).inventory_id
836
for r in revision_ids]
837
other.inventory_store.prefetch(inventory_ids)
842
for rev_id in revision_ids:
844
pb.update('fetching revision', i, len(revision_ids))
845
rev = other.get_revision(rev_id)
846
revisions.append(rev)
847
inv = other.get_inventory(str(rev.inventory_id))
848
for key, entry in inv.iter_entries():
849
if entry.text_id is None:
851
if entry.text_id not in self.text_store:
852
needed_texts.add(entry.text_id)
856
count = self.text_store.copy_multi(other.text_store, needed_texts)
857
print "Added %d texts." % count
858
inventory_ids = [ f.inventory_id for f in revisions ]
859
count = self.inventory_store.copy_multi(other.inventory_store,
861
print "Added %d inventories." % count
862
revision_ids = [ f.revision_id for f in revisions]
863
count = self.revision_store.copy_multi(other.revision_store,
865
for revision_id in revision_ids:
866
self.append_revision(revision_id)
867
print "Added %d revisions." % count
870
def commit(self, *args, **kw):
871
from bzrlib.commit import commit
872
commit(self, *args, **kw)
875
def lookup_revision(self, revision):
876
"""Return the revision identifier for a given revision information."""
877
revno, info = self.get_revision_info(revision)
880
def get_revision_info(self, revision):
881
"""Return (revno, revision id) for revision identifier.
883
revision can be an integer, in which case it is assumed to be revno (though
884
this will translate negative values into positive ones)
885
revision can also be a string, in which case it is parsed for something like
886
'date:' or 'revid:' etc.
891
try:# Convert to int if possible
892
revision = int(revision)
878
def update_revisions(self, other, stop_revision=None, overwrite=False,
880
"""Pull in new perfect-fit revisions.
882
:param other: Another Branch to pull from
883
:param stop_revision: Updated until the given revision
884
:param overwrite: Always set the branch pointer, rather than checking
885
to see if it is a proper descendant.
886
:param graph: A Graph object that can be used to query history
887
information. This can be None.
890
return InterBranch.get(other, self).update_revisions(stop_revision,
893
def import_last_revision_info(self, source_repo, revno, revid):
894
"""Set the last revision info, importing from another repo if necessary.
896
This is used by the bound branch code to upload a revision to
897
the master branch first before updating the tip of the local branch.
899
:param source_repo: Source repository to optionally fetch from
900
:param revno: Revision number of the new tip
901
:param revid: Revision id of the new tip
903
if not self.repository.has_same_location(source_repo):
904
self.repository.fetch(source_repo, revision_id=revid)
905
self.set_last_revision_info(revno, revid)
907
def revision_id_to_revno(self, revision_id):
908
"""Given a revision id, return its revno"""
909
if _mod_revision.is_null(revision_id):
911
history = self.revision_history()
913
return history.index(revision_id) + 1
893
914
except ValueError:
915
raise errors.NoSuchRevision(self, revision_id)
918
def get_rev_id(self, revno, history=None):
919
"""Find the revision id of the specified revno."""
921
return _mod_revision.NULL_REVISION
922
last_revno, last_revid = self.last_revision_info()
923
if revno == last_revno:
925
if revno <= 0 or revno > last_revno:
926
raise errors.NoSuchRevision(self, revno)
927
distance_from_last = last_revno - revno
928
if len(self._partial_revision_history_cache) <= distance_from_last:
929
self._extend_partial_history(distance_from_last)
930
return self._partial_revision_history_cache[distance_from_last]
933
def pull(self, source, overwrite=False, stop_revision=None,
934
possible_transports=None, *args, **kwargs):
935
"""Mirror source into this branch.
937
This branch is considered to be 'local', having low latency.
939
:returns: PullResult instance
941
return InterBranch.get(source, self).pull(overwrite=overwrite,
942
stop_revision=stop_revision,
943
possible_transports=possible_transports, *args, **kwargs)
945
def push(self, target, overwrite=False, stop_revision=None, *args,
947
"""Mirror this branch into target.
949
This branch is considered to be 'local', having low latency.
951
return InterBranch.get(self, target).push(overwrite, stop_revision,
954
def lossy_push(self, target, stop_revision=None):
955
"""Push deltas into another branch.
957
:note: This does not, like push, retain the revision ids from
958
the source branch and will, rather than adding bzr-specific
959
metadata, push only those semantics of the revision that can be
960
natively represented by this branch' VCS.
962
:param target: Target branch
963
:param stop_revision: Revision to push, defaults to last revision.
964
:return: BranchPushResult with an extra member revidmap:
965
A dictionary mapping revision ids from the target branch
966
to new revision ids in the target branch, for each
967
revision that was pushed.
969
inter = InterBranch.get(self, target)
970
lossy_push = getattr(inter, "lossy_push", None)
971
if lossy_push is None:
972
raise errors.LossyPushToSameVCS(self, target)
973
return lossy_push(stop_revision)
975
def basis_tree(self):
976
"""Return `Tree` object for last revision."""
977
return self.repository.revision_tree(self.last_revision())
979
def get_parent(self):
980
"""Return the parent location of the branch.
982
This is the default location for pull/missing. The usual
983
pattern is that the user can override it by specifying a
986
parent = self._get_parent_location()
989
# This is an old-format absolute path to a local branch
991
if parent.startswith('/'):
992
parent = urlutils.local_path_to_url(parent.decode('utf8'))
994
return urlutils.join(self.base[:-1], parent)
995
except errors.InvalidURLJoin, e:
996
raise errors.InaccessibleParent(parent, self.base)
998
def _get_parent_location(self):
999
raise NotImplementedError(self._get_parent_location)
1001
def _set_config_location(self, name, url, config=None,
1002
make_relative=False):
1004
config = self.get_config()
1008
url = urlutils.relative_url(self.base, url)
1009
config.set_user_option(name, url, warn_masked=True)
1011
def _get_config_location(self, name, config=None):
1013
config = self.get_config()
1014
location = config.get_user_option(name)
1019
def get_child_submit_format(self):
1020
"""Return the preferred format of submissions to this branch."""
1021
return self.get_config().get_user_option("child_submit_format")
1023
def get_submit_branch(self):
1024
"""Return the submit location of the branch.
1026
This is the default location for bundle. The usual
1027
pattern is that the user can override it by specifying a
1030
return self.get_config().get_user_option('submit_branch')
1032
def set_submit_branch(self, location):
1033
"""Return the submit location of the branch.
1035
This is the default location for bundle. The usual
1036
pattern is that the user can override it by specifying a
1039
self.get_config().set_user_option('submit_branch', location,
1042
def get_public_branch(self):
1043
"""Return the public location of the branch.
1045
This is used by merge directives.
1047
return self._get_config_location('public_branch')
1049
def set_public_branch(self, location):
1050
"""Return the submit location of the branch.
1052
This is the default location for bundle. The usual
1053
pattern is that the user can override it by specifying a
1056
self._set_config_location('public_branch', location)
1058
def get_push_location(self):
1059
"""Return the None or the location to push this branch to."""
1060
push_loc = self.get_config().get_user_option('push_location')
1063
def set_push_location(self, location):
1064
"""Set a new push location for this branch."""
1065
raise NotImplementedError(self.set_push_location)
1067
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1068
"""Run the post_change_branch_tip hooks."""
1069
hooks = Branch.hooks['post_change_branch_tip']
1072
new_revno, new_revid = self.last_revision_info()
1073
params = ChangeBranchTipParams(
1074
self, old_revno, new_revno, old_revid, new_revid)
1078
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
1079
"""Run the pre_change_branch_tip hooks."""
1080
hooks = Branch.hooks['pre_change_branch_tip']
1083
old_revno, old_revid = self.last_revision_info()
1084
params = ChangeBranchTipParams(
1085
self, old_revno, new_revno, old_revid, new_revid)
1089
except errors.TipChangeRejected:
1092
exc_info = sys.exc_info()
1093
hook_name = Branch.hooks.get_hook_name(hook)
1094
raise errors.HookFailed(
1095
'pre_change_branch_tip', hook_name, exc_info)
1099
"""Synchronise this branch with the master branch if any.
1101
:return: None or the last_revision pivoted out during the update.
1105
def check_revno(self, revno):
1107
Check whether a revno corresponds to any revision.
1108
Zero (the NULL revision) is considered valid.
1111
self.check_real_revno(revno)
1113
def check_real_revno(self, revno):
1115
Check whether a revno corresponds to a real revision.
1116
Zero (the NULL revision) is considered invalid
1118
if revno < 1 or revno > self.revno():
1119
raise errors.InvalidRevisionNumber(revno)
1122
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
1123
"""Clone this branch into to_bzrdir preserving all semantic values.
1125
Most API users will want 'create_clone_on_transport', which creates a
1126
new bzrdir and branch on the fly.
1128
revision_id: if not None, the revision history in the new branch will
1129
be truncated to end with revision_id.
1131
result = to_bzrdir.create_branch()
1134
if repository_policy is not None:
1135
repository_policy.configure_branch(result)
1136
self.copy_content_into(result, revision_id=revision_id)
1142
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
1143
"""Create a new line of development from the branch, into to_bzrdir.
1145
to_bzrdir controls the branch format.
1147
revision_id: if not None, the revision history in the new branch will
1148
be truncated to end with revision_id.
1150
if (repository_policy is not None and
1151
repository_policy.requires_stacking()):
1152
to_bzrdir._format.require_stacking(_skip_repo=True)
1153
result = to_bzrdir.create_branch()
1156
if repository_policy is not None:
1157
repository_policy.configure_branch(result)
1158
self.copy_content_into(result, revision_id=revision_id)
1159
result.set_parent(self.bzrdir.root_transport.base)
1164
def _synchronize_history(self, destination, revision_id):
1165
"""Synchronize last revision and revision history between branches.
1167
This version is most efficient when the destination is also a
1168
BzrBranch6, but works for BzrBranch5, as long as the destination's
1169
repository contains all the lefthand ancestors of the intended
1170
last_revision. If not, set_last_revision_info will fail.
1172
:param destination: The branch to copy the history into
1173
:param revision_id: The revision-id to truncate history at. May
1174
be None to copy complete history.
1176
source_revno, source_revision_id = self.last_revision_info()
1177
if revision_id is None:
1178
revno, revision_id = source_revno, source_revision_id
1180
graph = self.repository.get_graph()
1182
revno = graph.find_distance_to_null(revision_id,
1183
[(source_revision_id, source_revno)])
1184
except errors.GhostRevisionsHaveNoRevno:
1185
# Default to 1, if we can't find anything else
1187
destination.set_last_revision_info(revno, revision_id)
1190
def copy_content_into(self, destination, revision_id=None):
1191
"""Copy the content of self into destination.
1193
revision_id: if not None, the revision history in the new branch will
1194
be truncated to end with revision_id.
1196
self.update_references(destination)
1197
self._synchronize_history(destination, revision_id)
1199
parent = self.get_parent()
1200
except errors.InaccessibleParent, e:
1201
mutter('parent was not accessible to copy: %s', e)
1204
destination.set_parent(parent)
1205
if self._push_should_merge_tags():
1206
self.tags.merge_to(destination.tags)
1208
def update_references(self, target):
1209
if not getattr(self._format, 'supports_reference_locations', False):
1211
reference_dict = self._get_all_reference_info()
1212
if len(reference_dict) == 0:
1214
old_base = self.base
1215
new_base = target.base
1216
target_reference_dict = target._get_all_reference_info()
1217
for file_id, (tree_path, branch_location) in (
1218
reference_dict.items()):
1219
branch_location = urlutils.rebase_url(branch_location,
1221
target_reference_dict.setdefault(
1222
file_id, (tree_path, branch_location))
1223
target._set_all_reference_info(target_reference_dict)
1226
def check(self, refs):
1227
"""Check consistency of the branch.
1229
In particular this checks that revisions given in the revision-history
1230
do actually match up in the revision graph, and that they're all
1231
present in the repository.
1233
Callers will typically also want to check the repository.
1235
:param refs: Calculated refs for this branch as specified by
1236
branch._get_check_refs()
1237
:return: A BranchCheckResult.
1239
result = BranchCheckResult(self)
1240
last_revno, last_revision_id = self.last_revision_info()
1241
actual_revno = refs[('lefthand-distance', last_revision_id)]
1242
if actual_revno != last_revno:
1243
result.errors.append(errors.BzrCheckError(
1244
'revno does not match len(mainline) %s != %s' % (
1245
last_revno, actual_revno)))
1246
# TODO: We should probably also check that self.revision_history
1247
# matches the repository for older branch formats.
1248
# If looking for the code that cross-checks repository parents against
1249
# the iter_reverse_revision_history output, that is now a repository
1253
def _get_checkout_format(self):
1254
"""Return the most suitable metadir for a checkout of this branch.
1255
Weaves are used if this branch's repository uses weaves.
1257
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1258
from bzrlib.repofmt import weaverepo
1259
format = bzrdir.BzrDirMetaFormat1()
1260
format.repository_format = weaverepo.RepositoryFormat7()
1262
format = self.repository.bzrdir.checkout_metadir()
1263
format.set_branch_format(self._format)
1266
def create_clone_on_transport(self, to_transport, revision_id=None,
1267
stacked_on=None, create_prefix=False, use_existing_dir=False):
1268
"""Create a clone of this branch and its bzrdir.
1270
:param to_transport: The transport to clone onto.
1271
:param revision_id: The revision id to use as tip in the new branch.
1272
If None the tip is obtained from this branch.
1273
:param stacked_on: An optional URL to stack the clone on.
1274
:param create_prefix: Create any missing directories leading up to
1276
:param use_existing_dir: Use an existing directory if one exists.
1278
# XXX: Fix the bzrdir API to allow getting the branch back from the
1279
# clone call. Or something. 20090224 RBC/spiv.
1280
if revision_id is None:
1281
revision_id = self.last_revision()
1283
dir_to = self.bzrdir.clone_on_transport(to_transport,
1284
revision_id=revision_id, stacked_on=stacked_on,
1285
create_prefix=create_prefix, use_existing_dir=use_existing_dir)
1286
except errors.FileExists:
1287
if not use_existing_dir:
1289
except errors.NoSuchFile:
1290
if not create_prefix:
1292
return dir_to.open_branch()
1294
def create_checkout(self, to_location, revision_id=None,
1295
lightweight=False, accelerator_tree=None,
1297
"""Create a checkout of a branch.
1299
:param to_location: The url to produce the checkout at
1300
:param revision_id: The revision to check out
1301
:param lightweight: If True, produce a lightweight checkout, otherwise,
1302
produce a bound branch (heavyweight checkout)
1303
:param accelerator_tree: A tree which can be used for retrieving file
1304
contents more quickly than the revision tree, i.e. a workingtree.
1305
The revision tree will be used for cases where accelerator_tree's
1306
content is different.
1307
:param hardlink: If true, hard-link files from accelerator_tree,
1309
:return: The tree of the created checkout
1311
t = transport.get_transport(to_location)
1314
format = self._get_checkout_format()
1315
checkout = format.initialize_on_transport(t)
1316
from_branch = BranchReferenceFormat().initialize(checkout, self)
1318
format = self._get_checkout_format()
1319
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1320
to_location, force_new_tree=False, format=format)
1321
checkout = checkout_branch.bzrdir
1322
checkout_branch.bind(self)
1323
# pull up to the specified revision_id to set the initial
1324
# branch tip correctly, and seed it with history.
1325
checkout_branch.pull(self, stop_revision=revision_id)
1327
tree = checkout.create_workingtree(revision_id,
1328
from_branch=from_branch,
1329
accelerator_tree=accelerator_tree,
1331
basis_tree = tree.basis_tree()
1332
basis_tree.lock_read()
1334
for path, file_id in basis_tree.iter_references():
1335
reference_parent = self.reference_parent(file_id, path)
1336
reference_parent.create_checkout(tree.abspath(path),
1337
basis_tree.get_reference_revision(file_id, path),
1344
def reconcile(self, thorough=True):
1345
"""Make sure the data stored in this branch is consistent."""
1346
from bzrlib.reconcile import BranchReconciler
1347
reconciler = BranchReconciler(self, thorough=thorough)
1348
reconciler.reconcile()
1351
def reference_parent(self, file_id, path, possible_transports=None):
1352
"""Return the parent branch for a tree-reference file_id
1353
:param file_id: The file_id of the tree reference
1354
:param path: The path of the file_id in the tree
1355
:return: A branch associated with the file_id
1357
# FIXME should provide multiple branches, based on config
1358
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1359
possible_transports=possible_transports)
1361
def supports_tags(self):
1362
return self._format.supports_tags()
1364
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1366
"""Ensure that revision_b is a descendant of revision_a.
1368
This is a helper function for update_revisions.
1370
:raises: DivergedBranches if revision_b has diverged from revision_a.
1371
:returns: True if revision_b is a descendant of revision_a.
1373
relation = self._revision_relations(revision_a, revision_b, graph)
1374
if relation == 'b_descends_from_a':
1376
elif relation == 'diverged':
1377
raise errors.DivergedBranches(self, other_branch)
1378
elif relation == 'a_descends_from_b':
1381
raise AssertionError("invalid relation: %r" % (relation,))
1383
def _revision_relations(self, revision_a, revision_b, graph):
1384
"""Determine the relationship between two revisions.
1386
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1388
heads = graph.heads([revision_a, revision_b])
1389
if heads == set([revision_b]):
1390
return 'b_descends_from_a'
1391
elif heads == set([revision_a, revision_b]):
1392
# These branches have diverged
1394
elif heads == set([revision_a]):
1395
return 'a_descends_from_b'
1397
raise AssertionError("invalid heads: %r" % (heads,))
1400
class BranchFormat(object):
1401
"""An encapsulation of the initialization and open routines for a format.
1403
Formats provide three things:
1404
* An initialization routine,
1408
Formats are placed in an dict by their format string for reference
1409
during branch opening. Its not required that these be instances, they
1410
can be classes themselves with class methods - it simply depends on
1411
whether state is needed for a given format or not.
1413
Once a format is deprecated, just deprecate the initialize and open
1414
methods on the format class. Do not deprecate the object, as the
1415
object will be created every time regardless.
1418
_default_format = None
1419
"""The default format used for new branches."""
1422
"""The known formats."""
1424
can_set_append_revisions_only = True
1426
def __eq__(self, other):
1427
return self.__class__ is other.__class__
1429
def __ne__(self, other):
1430
return not (self == other)
1433
def find_format(klass, a_bzrdir):
1434
"""Return the format for the branch object in a_bzrdir."""
1436
transport = a_bzrdir.get_branch_transport(None)
1437
format_string = transport.get("format").read()
1438
return klass._formats[format_string]
1439
except errors.NoSuchFile:
1440
raise errors.NotBranchError(path=transport.base)
1442
raise errors.UnknownFormatError(format=format_string, kind='branch')
1445
def get_default_format(klass):
1446
"""Return the current default format."""
1447
return klass._default_format
1449
def get_reference(self, a_bzrdir):
1450
"""Get the target reference of the branch in a_bzrdir.
1452
format probing must have been completed before calling
1453
this method - it is assumed that the format of the branch
1454
in a_bzrdir is correct.
1456
:param a_bzrdir: The bzrdir to get the branch data from.
1457
:return: None if the branch is not a reference branch.
1462
def set_reference(self, a_bzrdir, to_branch):
1463
"""Set the target reference of the branch in a_bzrdir.
1465
format probing must have been completed before calling
1466
this method - it is assumed that the format of the branch
1467
in a_bzrdir is correct.
1469
:param a_bzrdir: The bzrdir to set the branch reference for.
1470
:param to_branch: branch that the checkout is to reference
1472
raise NotImplementedError(self.set_reference)
1474
def get_format_string(self):
1475
"""Return the ASCII format string that identifies this format."""
1476
raise NotImplementedError(self.get_format_string)
1478
def get_format_description(self):
1479
"""Return the short format description for this format."""
1480
raise NotImplementedError(self.get_format_description)
1482
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
1484
"""Initialize a branch in a bzrdir, with specified files
1486
:param a_bzrdir: The bzrdir to initialize the branch in
1487
:param utf8_files: The files to create as a list of
1488
(filename, content) tuples
1489
:param set_format: If True, set the format with
1490
self.get_format_string. (BzrBranch4 has its format set
1492
:return: a branch in this format
1494
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1495
branch_transport = a_bzrdir.get_branch_transport(self)
1497
'metadir': ('lock', lockdir.LockDir),
1498
'branch4': ('branch-lock', lockable_files.TransportLock),
1500
lock_name, lock_class = lock_map[lock_type]
1501
control_files = lockable_files.LockableFiles(branch_transport,
1502
lock_name, lock_class)
1503
control_files.create_lock()
1505
control_files.lock_write()
1506
except errors.LockContention:
1507
if lock_type != 'branch4':
1513
utf8_files += [('format', self.get_format_string())]
1515
for (filename, content) in utf8_files:
1516
branch_transport.put_bytes(
1518
mode=a_bzrdir._get_file_mode())
1521
control_files.unlock()
1522
return self.open(a_bzrdir, _found=True)
1524
def initialize(self, a_bzrdir):
1525
"""Create a branch of this format in a_bzrdir."""
1526
raise NotImplementedError(self.initialize)
1528
def is_supported(self):
1529
"""Is this format supported?
1531
Supported formats can be initialized and opened.
1532
Unsupported formats may not support initialization or committing or
1533
some other features depending on the reason for not being supported.
1537
def make_tags(self, branch):
1538
"""Create a tags object for branch.
1540
This method is on BranchFormat, because BranchFormats are reflected
1541
over the wire via network_name(), whereas full Branch instances require
1542
multiple VFS method calls to operate at all.
1544
The default implementation returns a disabled-tags instance.
1546
Note that it is normal for branch to be a RemoteBranch when using tags
1549
return DisabledTags(branch)
1551
def network_name(self):
1552
"""A simple byte string uniquely identifying this format for RPC calls.
1554
MetaDir branch formats use their disk format string to identify the
1555
repository over the wire. All in one formats such as bzr < 0.8, and
1556
foreign formats like svn/git and hg should use some marker which is
1557
unique and immutable.
1559
raise NotImplementedError(self.network_name)
1561
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1562
"""Return the branch object for a_bzrdir
1564
:param a_bzrdir: A BzrDir that contains a branch.
1565
:param _found: a private parameter, do not use it. It is used to
1566
indicate if format probing has already be done.
1567
:param ignore_fallbacks: when set, no fallback branches will be opened
1568
(if there are any). Default is to open fallbacks.
1570
raise NotImplementedError(self.open)
1573
def register_format(klass, format):
1574
"""Register a metadir format."""
1575
klass._formats[format.get_format_string()] = format
1576
# Metadir formats have a network name of their format string, and get
1577
# registered as class factories.
1578
network_format_registry.register(format.get_format_string(), format.__class__)
1581
def set_default_format(klass, format):
1582
klass._default_format = format
1584
def supports_set_append_revisions_only(self):
1585
"""True if this format supports set_append_revisions_only."""
1588
def supports_stacking(self):
1589
"""True if this format records a stacked-on branch."""
1593
def unregister_format(klass, format):
1594
del klass._formats[format.get_format_string()]
1597
return self.get_format_description().rstrip()
1599
def supports_tags(self):
1600
"""True if this format supports tags stored in the branch"""
1601
return False # by default
1604
class BranchHooks(Hooks):
1605
"""A dictionary mapping hook name to a list of callables for branch hooks.
1607
e.g. ['set_rh'] Is the list of items to be called when the
1608
set_revision_history function is invoked.
1612
"""Create the default hooks.
1614
These are all empty initially, because by default nothing should get
1617
Hooks.__init__(self)
1618
self.create_hook(HookPoint('set_rh',
1619
"Invoked whenever the revision history has been set via "
1620
"set_revision_history. The api signature is (branch, "
1621
"revision_history), and the branch will be write-locked. "
1622
"The set_rh hook can be expensive for bzr to trigger, a better "
1623
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1624
self.create_hook(HookPoint('open',
1625
"Called with the Branch object that has been opened after a "
1626
"branch is opened.", (1, 8), None))
1627
self.create_hook(HookPoint('post_push',
1628
"Called after a push operation completes. post_push is called "
1629
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1630
"bzr client.", (0, 15), None))
1631
self.create_hook(HookPoint('post_pull',
1632
"Called after a pull operation completes. post_pull is called "
1633
"with a bzrlib.branch.PullResult object and only runs in the "
1634
"bzr client.", (0, 15), None))
1635
self.create_hook(HookPoint('pre_commit',
1636
"Called after a commit is calculated but before it is is "
1637
"completed. pre_commit is called with (local, master, old_revno, "
1638
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1639
"). old_revid is NULL_REVISION for the first commit to a branch, "
1640
"tree_delta is a TreeDelta object describing changes from the "
1641
"basis revision. hooks MUST NOT modify this delta. "
1642
" future_tree is an in-memory tree obtained from "
1643
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1644
"tree.", (0,91), None))
1645
self.create_hook(HookPoint('post_commit',
1646
"Called in the bzr client after a commit has completed. "
1647
"post_commit is called with (local, master, old_revno, old_revid, "
1648
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1649
"commit to a branch.", (0, 15), None))
1650
self.create_hook(HookPoint('post_uncommit',
1651
"Called in the bzr client after an uncommit completes. "
1652
"post_uncommit is called with (local, master, old_revno, "
1653
"old_revid, new_revno, new_revid) where local is the local branch "
1654
"or None, master is the target branch, and an empty branch "
1655
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1656
self.create_hook(HookPoint('pre_change_branch_tip',
1657
"Called in bzr client and server before a change to the tip of a "
1658
"branch is made. pre_change_branch_tip is called with a "
1659
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1660
"commit, uncommit will all trigger this hook.", (1, 6), None))
1661
self.create_hook(HookPoint('post_change_branch_tip',
1662
"Called in bzr client and server after a change to the tip of a "
1663
"branch is made. post_change_branch_tip is called with a "
1664
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1665
"commit, uncommit will all trigger this hook.", (1, 4), None))
1666
self.create_hook(HookPoint('transform_fallback_location',
1667
"Called when a stacked branch is activating its fallback "
1668
"locations. transform_fallback_location is called with (branch, "
1669
"url), and should return a new url. Returning the same url "
1670
"allows it to be used as-is, returning a different one can be "
1671
"used to cause the branch to stack on a closer copy of that "
1672
"fallback_location. Note that the branch cannot have history "
1673
"accessing methods called on it during this hook because the "
1674
"fallback locations have not been activated. When there are "
1675
"multiple hooks installed for transform_fallback_location, "
1676
"all are called with the url returned from the previous hook."
1677
"The order is however undefined.", (1, 9), None))
1680
# install the default hooks into the Branch class.
1681
Branch.hooks = BranchHooks()
1684
class ChangeBranchTipParams(object):
1685
"""Object holding parameters passed to *_change_branch_tip hooks.
1687
There are 5 fields that hooks may wish to access:
1689
:ivar branch: the branch being changed
1690
:ivar old_revno: revision number before the change
1691
:ivar new_revno: revision number after the change
1692
:ivar old_revid: revision id before the change
1693
:ivar new_revid: revision id after the change
1695
The revid fields are strings. The revno fields are integers.
1698
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1699
"""Create a group of ChangeBranchTip parameters.
1701
:param branch: The branch being changed.
1702
:param old_revno: Revision number before the change.
1703
:param new_revno: Revision number after the change.
1704
:param old_revid: Tip revision id before the change.
1705
:param new_revid: Tip revision id after the change.
1707
self.branch = branch
1708
self.old_revno = old_revno
1709
self.new_revno = new_revno
1710
self.old_revid = old_revid
1711
self.new_revid = new_revid
1713
def __eq__(self, other):
1714
return self.__dict__ == other.__dict__
1717
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1718
self.__class__.__name__, self.branch,
1719
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1722
class BzrBranchFormat4(BranchFormat):
1723
"""Bzr branch format 4.
1726
- a revision-history file.
1727
- a branch-lock lock file [ to be shared with the bzrdir ]
1730
def get_format_description(self):
1731
"""See BranchFormat.get_format_description()."""
1732
return "Branch format 4"
1734
def initialize(self, a_bzrdir):
1735
"""Create a branch of this format in a_bzrdir."""
1736
utf8_files = [('revision-history', ''),
1737
('branch-name', ''),
1739
return self._initialize_helper(a_bzrdir, utf8_files,
1740
lock_type='branch4', set_format=False)
1743
super(BzrBranchFormat4, self).__init__()
1744
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1746
def network_name(self):
1747
"""The network name for this format is the control dirs disk label."""
1748
return self._matchingbzrdir.get_format_string()
1750
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1751
"""See BranchFormat.open()."""
1753
# we are being called directly and must probe.
1754
raise NotImplementedError
1755
return BzrBranch(_format=self,
1756
_control_files=a_bzrdir._control_files,
1758
_repository=a_bzrdir.open_repository())
1761
return "Bazaar-NG branch format 4"
1764
class BranchFormatMetadir(BranchFormat):
1765
"""Common logic for meta-dir based branch formats."""
1767
def _branch_class(self):
1768
"""What class to instantiate on open calls."""
1769
raise NotImplementedError(self._branch_class)
1771
def network_name(self):
1772
"""A simple byte string uniquely identifying this format for RPC calls.
1774
Metadir branch formats use their format string.
1776
return self.get_format_string()
1778
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1779
"""See BranchFormat.open()."""
1781
format = BranchFormat.find_format(a_bzrdir)
1782
if format.__class__ != self.__class__:
1783
raise AssertionError("wrong format %r found for %r" %
1786
transport = a_bzrdir.get_branch_transport(None)
1787
control_files = lockable_files.LockableFiles(transport, 'lock',
1789
return self._branch_class()(_format=self,
1790
_control_files=control_files,
1792
_repository=a_bzrdir.find_repository(),
1793
ignore_fallbacks=ignore_fallbacks)
1794
except errors.NoSuchFile:
1795
raise errors.NotBranchError(path=transport.base)
1798
super(BranchFormatMetadir, self).__init__()
1799
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1800
self._matchingbzrdir.set_branch_format(self)
1802
def supports_tags(self):
1806
class BzrBranchFormat5(BranchFormatMetadir):
1807
"""Bzr branch format 5.
1810
- a revision-history file.
1812
- a lock dir guarding the branch itself
1813
- all of this stored in a branch/ subdirectory
1814
- works with shared repositories.
1816
This format is new in bzr 0.8.
1819
def _branch_class(self):
1822
def get_format_string(self):
1823
"""See BranchFormat.get_format_string()."""
1824
return "Bazaar-NG branch format 5\n"
1826
def get_format_description(self):
1827
"""See BranchFormat.get_format_description()."""
1828
return "Branch format 5"
1830
def initialize(self, a_bzrdir):
1831
"""Create a branch of this format in a_bzrdir."""
1832
utf8_files = [('revision-history', ''),
1833
('branch-name', ''),
1835
return self._initialize_helper(a_bzrdir, utf8_files)
1837
def supports_tags(self):
1841
class BzrBranchFormat6(BranchFormatMetadir):
1842
"""Branch format with last-revision and tags.
1844
Unlike previous formats, this has no explicit revision history. Instead,
1845
this just stores the last-revision, and the left-hand history leading
1846
up to there is the history.
1848
This format was introduced in bzr 0.15
1849
and became the default in 0.91.
1852
def _branch_class(self):
1855
def get_format_string(self):
1856
"""See BranchFormat.get_format_string()."""
1857
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1859
def get_format_description(self):
1860
"""See BranchFormat.get_format_description()."""
1861
return "Branch format 6"
1863
def initialize(self, a_bzrdir):
1864
"""Create a branch of this format in a_bzrdir."""
1865
utf8_files = [('last-revision', '0 null:\n'),
1866
('branch.conf', ''),
1869
return self._initialize_helper(a_bzrdir, utf8_files)
1871
def make_tags(self, branch):
1872
"""See bzrlib.branch.BranchFormat.make_tags()."""
1873
return BasicTags(branch)
1875
def supports_set_append_revisions_only(self):
1879
class BzrBranchFormat8(BranchFormatMetadir):
1880
"""Metadir format supporting storing locations of subtree branches."""
1882
def _branch_class(self):
1885
def get_format_string(self):
1886
"""See BranchFormat.get_format_string()."""
1887
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
1889
def get_format_description(self):
1890
"""See BranchFormat.get_format_description()."""
1891
return "Branch format 8"
1893
def initialize(self, a_bzrdir):
1894
"""Create a branch of this format in a_bzrdir."""
1895
utf8_files = [('last-revision', '0 null:\n'),
1896
('branch.conf', ''),
1900
return self._initialize_helper(a_bzrdir, utf8_files)
1903
super(BzrBranchFormat8, self).__init__()
1904
self._matchingbzrdir.repository_format = \
1905
RepositoryFormatKnitPack5RichRoot()
1907
def make_tags(self, branch):
1908
"""See bzrlib.branch.BranchFormat.make_tags()."""
1909
return BasicTags(branch)
1911
def supports_set_append_revisions_only(self):
1914
def supports_stacking(self):
1917
supports_reference_locations = True
1920
class BzrBranchFormat7(BzrBranchFormat8):
1921
"""Branch format with last-revision, tags, and a stacked location pointer.
1923
The stacked location pointer is passed down to the repository and requires
1924
a repository format with supports_external_lookups = True.
1926
This format was introduced in bzr 1.6.
1929
def initialize(self, a_bzrdir):
1930
"""Create a branch of this format in a_bzrdir."""
1931
utf8_files = [('last-revision', '0 null:\n'),
1932
('branch.conf', ''),
1935
return self._initialize_helper(a_bzrdir, utf8_files)
1937
def _branch_class(self):
1940
def get_format_string(self):
1941
"""See BranchFormat.get_format_string()."""
1942
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
1944
def get_format_description(self):
1945
"""See BranchFormat.get_format_description()."""
1946
return "Branch format 7"
1948
def supports_set_append_revisions_only(self):
1951
supports_reference_locations = False
1954
class BranchReferenceFormat(BranchFormat):
1955
"""Bzr branch reference format.
1957
Branch references are used in implementing checkouts, they
1958
act as an alias to the real branch which is at some other url.
1965
def get_format_string(self):
1966
"""See BranchFormat.get_format_string()."""
1967
return "Bazaar-NG Branch Reference Format 1\n"
1969
def get_format_description(self):
1970
"""See BranchFormat.get_format_description()."""
1971
return "Checkout reference format 1"
1973
def get_reference(self, a_bzrdir):
1974
"""See BranchFormat.get_reference()."""
1975
transport = a_bzrdir.get_branch_transport(None)
1976
return transport.get('location').read()
1978
def set_reference(self, a_bzrdir, to_branch):
1979
"""See BranchFormat.set_reference()."""
1980
transport = a_bzrdir.get_branch_transport(None)
1981
location = transport.put_bytes('location', to_branch.base)
1983
def initialize(self, a_bzrdir, target_branch=None):
1984
"""Create a branch of this format in a_bzrdir."""
1985
if target_branch is None:
1986
# this format does not implement branch itself, thus the implicit
1987
# creation contract must see it as uninitializable
1988
raise errors.UninitializableFormat(self)
1989
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1990
branch_transport = a_bzrdir.get_branch_transport(self)
1991
branch_transport.put_bytes('location',
1992
target_branch.bzrdir.root_transport.base)
1993
branch_transport.put_bytes('format', self.get_format_string())
1995
a_bzrdir, _found=True,
1996
possible_transports=[target_branch.bzrdir.root_transport])
1999
super(BranchReferenceFormat, self).__init__()
2000
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2001
self._matchingbzrdir.set_branch_format(self)
2003
def _make_reference_clone_function(format, a_branch):
2004
"""Create a clone() routine for a branch dynamically."""
2005
def clone(to_bzrdir, revision_id=None,
2006
repository_policy=None):
2007
"""See Branch.clone()."""
2008
return format.initialize(to_bzrdir, a_branch)
2009
# cannot obey revision_id limits when cloning a reference ...
2010
# FIXME RBC 20060210 either nuke revision_id for clone, or
2011
# emit some sort of warning/error to the caller ?!
2014
def open(self, a_bzrdir, _found=False, location=None,
2015
possible_transports=None, ignore_fallbacks=False):
2016
"""Return the branch that the branch reference in a_bzrdir points at.
2018
:param a_bzrdir: A BzrDir that contains a branch.
2019
:param _found: a private parameter, do not use it. It is used to
2020
indicate if format probing has already be done.
2021
:param ignore_fallbacks: when set, no fallback branches will be opened
2022
(if there are any). Default is to open fallbacks.
2023
:param location: The location of the referenced branch. If
2024
unspecified, this will be determined from the branch reference in
2026
:param possible_transports: An optional reusable transports list.
2029
format = BranchFormat.find_format(a_bzrdir)
2030
if format.__class__ != self.__class__:
2031
raise AssertionError("wrong format %r found for %r" %
2033
if location is None:
2034
location = self.get_reference(a_bzrdir)
2035
real_bzrdir = bzrdir.BzrDir.open(
2036
location, possible_transports=possible_transports)
2037
result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
2038
# this changes the behaviour of result.clone to create a new reference
2039
# rather than a copy of the content of the branch.
2040
# I did not use a proxy object because that needs much more extensive
2041
# testing, and we are only changing one behaviour at the moment.
2042
# If we decide to alter more behaviours - i.e. the implicit nickname
2043
# then this should be refactored to introduce a tested proxy branch
2044
# and a subclass of that for use in overriding clone() and ....
2046
result.clone = self._make_reference_clone_function(result)
2050
network_format_registry = registry.FormatRegistry()
2051
"""Registry of formats indexed by their network name.
2053
The network name for a branch format is an identifier that can be used when
2054
referring to formats with smart server operations. See
2055
BranchFormat.network_name() for more detail.
2059
# formats which have no format string are not discoverable
2060
# and not independently creatable, so are not registered.
2061
__format5 = BzrBranchFormat5()
2062
__format6 = BzrBranchFormat6()
2063
__format7 = BzrBranchFormat7()
2064
__format8 = BzrBranchFormat8()
2065
BranchFormat.register_format(__format5)
2066
BranchFormat.register_format(BranchReferenceFormat())
2067
BranchFormat.register_format(__format6)
2068
BranchFormat.register_format(__format7)
2069
BranchFormat.register_format(__format8)
2070
BranchFormat.set_default_format(__format7)
2071
_legacy_formats = [BzrBranchFormat4(),
2073
network_format_registry.register(
2074
_legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2077
class BzrBranch(Branch):
2078
"""A branch stored in the actual filesystem.
2080
Note that it's "local" in the context of the filesystem; it doesn't
2081
really matter if it's on an nfs/smb/afs/coda/... share, as long as
2082
it's writable, and can be accessed via the normal filesystem API.
2084
:ivar _transport: Transport for file operations on this branch's
2085
control files, typically pointing to the .bzr/branch directory.
2086
:ivar repository: Repository for this branch.
2087
:ivar base: The url of the base directory for this branch; the one
2088
containing the .bzr directory.
2091
def __init__(self, _format=None,
2092
_control_files=None, a_bzrdir=None, _repository=None,
2093
ignore_fallbacks=False):
2094
"""Create new branch object at a particular location."""
2095
if a_bzrdir is None:
2096
raise ValueError('a_bzrdir must be supplied')
2098
self.bzrdir = a_bzrdir
2099
self._base = self.bzrdir.transport.clone('..').base
2100
# XXX: We should be able to just do
2101
# self.base = self.bzrdir.root_transport.base
2102
# but this does not quite work yet -- mbp 20080522
2103
self._format = _format
2104
if _control_files is None:
2105
raise ValueError('BzrBranch _control_files is None')
2106
self.control_files = _control_files
2107
self._transport = _control_files._transport
2108
self.repository = _repository
2109
Branch.__init__(self)
2112
return '%s(%r)' % (self.__class__.__name__, self.base)
2116
def _get_base(self):
2117
"""Returns the directory containing the control directory."""
2120
base = property(_get_base, doc="The URL for the root of this branch.")
2122
def _get_config(self):
2123
return TransportConfig(self._transport, 'branch.conf')
2125
def is_locked(self):
2126
return self.control_files.is_locked()
2128
def lock_write(self, token=None):
2129
# All-in-one needs to always unlock/lock.
2130
repo_control = getattr(self.repository, 'control_files', None)
2131
if self.control_files == repo_control or not self.is_locked():
2132
self.repository.lock_write()
2137
return self.control_files.lock_write(token=token)
2140
self.repository.unlock()
2143
def lock_read(self):
2144
# All-in-one needs to always unlock/lock.
2145
repo_control = getattr(self.repository, 'control_files', None)
2146
if self.control_files == repo_control or not self.is_locked():
2147
self.repository.lock_read()
2152
self.control_files.lock_read()
2155
self.repository.unlock()
2160
self.control_files.unlock()
2162
# All-in-one needs to always unlock/lock.
2163
repo_control = getattr(self.repository, 'control_files', None)
2164
if (self.control_files == repo_control or
2165
not self.control_files.is_locked()):
2166
self.repository.unlock()
2167
if not self.control_files.is_locked():
2168
# we just released the lock
2169
self._clear_cached_state()
2171
def peek_lock_mode(self):
2172
if self.control_files._lock_count == 0:
2175
return self.control_files._lock_mode
2177
def get_physical_lock_status(self):
2178
return self.control_files.get_physical_lock_status()
2181
def print_file(self, file, revision_id):
2182
"""See Branch.print_file."""
2183
return self.repository.print_file(file, revision_id)
2185
def _write_revision_history(self, history):
2186
"""Factored out of set_revision_history.
2188
This performs the actual writing to disk.
2189
It is intended to be called by BzrBranch5.set_revision_history."""
2190
self._transport.put_bytes(
2191
'revision-history', '\n'.join(history),
2192
mode=self.bzrdir._get_file_mode())
2195
def set_revision_history(self, rev_history):
2196
"""See Branch.set_revision_history."""
2197
if 'evil' in debug.debug_flags:
2198
mutter_callsite(3, "set_revision_history scales with history.")
2199
check_not_reserved_id = _mod_revision.check_not_reserved_id
2200
for rev_id in rev_history:
2201
check_not_reserved_id(rev_id)
2202
if Branch.hooks['post_change_branch_tip']:
2203
# Don't calculate the last_revision_info() if there are no hooks
2205
old_revno, old_revid = self.last_revision_info()
2206
if len(rev_history) == 0:
2207
revid = _mod_revision.NULL_REVISION
2209
revid = rev_history[-1]
2210
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2211
self._write_revision_history(rev_history)
2212
self._clear_cached_state()
2213
self._cache_revision_history(rev_history)
2214
for hook in Branch.hooks['set_rh']:
2215
hook(self, rev_history)
2216
if Branch.hooks['post_change_branch_tip']:
2217
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2219
def _synchronize_history(self, destination, revision_id):
2220
"""Synchronize last revision and revision history between branches.
2222
This version is most efficient when the destination is also a
2223
BzrBranch5, but works for BzrBranch6 as long as the revision
2224
history is the true lefthand parent history, and all of the revisions
2225
are in the destination's repository. If not, set_revision_history
2228
:param destination: The branch to copy the history into
2229
:param revision_id: The revision-id to truncate history at. May
2230
be None to copy complete history.
2232
if not isinstance(destination._format, BzrBranchFormat5):
2233
super(BzrBranch, self)._synchronize_history(
2234
destination, revision_id)
2236
if revision_id == _mod_revision.NULL_REVISION:
2239
new_history = self.revision_history()
2240
if revision_id is not None and new_history != []:
2242
new_history = new_history[:new_history.index(revision_id) + 1]
2244
rev = self.repository.get_revision(revision_id)
2245
new_history = rev.get_history(self.repository)[1:]
2246
destination.set_revision_history(new_history)
2249
def set_last_revision_info(self, revno, revision_id):
2250
"""Set the last revision of this branch.
2252
The caller is responsible for checking that the revno is correct
2253
for this revision id.
2255
It may be possible to set the branch last revision to an id not
2256
present in the repository. However, branches can also be
2257
configured to check constraints on history, in which case this may not
2260
revision_id = _mod_revision.ensure_null(revision_id)
2261
# this old format stores the full history, but this api doesn't
2262
# provide it, so we must generate, and might as well check it's
2264
history = self._lefthand_history(revision_id)
2265
if len(history) != revno:
2266
raise AssertionError('%d != %d' % (len(history), revno))
2267
self.set_revision_history(history)
2269
def _gen_revision_history(self):
2270
history = self._transport.get_bytes('revision-history').split('\n')
2271
if history[-1:] == ['']:
2272
# There shouldn't be a trailing newline, but just in case.
2277
def generate_revision_history(self, revision_id, last_rev=None,
2279
"""Create a new revision history that will finish with revision_id.
2281
:param revision_id: the new tip to use.
2282
:param last_rev: The previous last_revision. If not None, then this
2283
must be a ancestory of revision_id, or DivergedBranches is raised.
2284
:param other_branch: The other branch that DivergedBranches should
2285
raise with respect to.
2287
self.set_revision_history(self._lefthand_history(revision_id,
2288
last_rev, other_branch))
2290
def basis_tree(self):
2291
"""See Branch.basis_tree."""
2292
return self.repository.revision_tree(self.last_revision())
2294
def _get_parent_location(self):
2295
_locs = ['parent', 'pull', 'x-pull']
2298
return self._transport.get_bytes(l).strip('\n')
2299
except errors.NoSuchFile:
2303
def _basic_push(self, target, overwrite, stop_revision):
2304
"""Basic implementation of push without bound branches or hooks.
2306
Must be called with source read locked and target write locked.
2308
result = BranchPushResult()
2309
result.source_branch = self
2310
result.target_branch = target
2311
result.old_revno, result.old_revid = target.last_revision_info()
2312
self.update_references(target)
2313
if result.old_revid != self.last_revision():
2314
# We assume that during 'push' this repository is closer than
2316
graph = self.repository.get_graph(target.repository)
2317
target.update_revisions(self, stop_revision,
2318
overwrite=overwrite, graph=graph)
2319
if self._push_should_merge_tags():
2320
result.tag_conflicts = self.tags.merge_to(target.tags,
2322
result.new_revno, result.new_revid = target.last_revision_info()
2325
def get_stacked_on_url(self):
2326
raise errors.UnstackableBranchFormat(self._format, self.base)
2328
def set_push_location(self, location):
2329
"""See Branch.set_push_location."""
2330
self.get_config().set_user_option(
2331
'push_location', location,
2332
store=_mod_config.STORE_LOCATION_NORECURSE)
2334
def _set_parent_location(self, url):
2336
self._transport.delete('parent')
2338
self._transport.put_bytes('parent', url + '\n',
2339
mode=self.bzrdir._get_file_mode())
2342
class BzrBranch5(BzrBranch):
2343
"""A format 5 branch. This supports new features over plain branches.
2345
It has support for a master_branch which is the data for bound branches.
2348
def get_bound_location(self):
2350
return self._transport.get_bytes('bound')[:-1]
2351
except errors.NoSuchFile:
2355
def get_master_branch(self, possible_transports=None):
2356
"""Return the branch we are bound to.
2358
:return: Either a Branch, or None
2360
This could memoise the branch, but if thats done
2361
it must be revalidated on each new lock.
2362
So for now we just don't memoise it.
2363
# RBC 20060304 review this decision.
2365
bound_loc = self.get_bound_location()
2369
return Branch.open(bound_loc,
2370
possible_transports=possible_transports)
2371
except (errors.NotBranchError, errors.ConnectionError), e:
2372
raise errors.BoundBranchConnectionFailure(
2376
def set_bound_location(self, location):
2377
"""Set the target where this branch is bound to.
2379
:param location: URL to the target branch
2382
self._transport.put_bytes('bound', location+'\n',
2383
mode=self.bzrdir._get_file_mode())
2386
self._transport.delete('bound')
2387
except errors.NoSuchFile:
2392
def bind(self, other):
2393
"""Bind this branch to the branch other.
2395
This does not push or pull data between the branches, though it does
2396
check for divergence to raise an error when the branches are not
2397
either the same, or one a prefix of the other. That behaviour may not
2398
be useful, so that check may be removed in future.
2400
:param other: The branch to bind to
2403
# TODO: jam 20051230 Consider checking if the target is bound
2404
# It is debatable whether you should be able to bind to
2405
# a branch which is itself bound.
2406
# Committing is obviously forbidden,
2407
# but binding itself may not be.
2408
# Since we *have* to check at commit time, we don't
2409
# *need* to check here
2411
# we want to raise diverged if:
2412
# last_rev is not in the other_last_rev history, AND
2413
# other_last_rev is not in our history, and do it without pulling
2415
self.set_bound_location(other.base)
2419
"""If bound, unbind"""
2420
return self.set_bound_location(None)
2423
def update(self, possible_transports=None):
2424
"""Synchronise this branch with the master branch if any.
2426
:return: None or the last_revision that was pivoted out during the
2429
master = self.get_master_branch(possible_transports)
2430
if master is not None:
2431
old_tip = _mod_revision.ensure_null(self.last_revision())
2432
self.pull(master, overwrite=True)
2433
if self.repository.get_graph().is_ancestor(old_tip,
2434
_mod_revision.ensure_null(self.last_revision())):
2440
class BzrBranch8(BzrBranch5):
2441
"""A branch that stores tree-reference locations."""
2443
def _open_hook(self):
2444
if self._ignore_fallbacks:
2447
url = self.get_stacked_on_url()
2448
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2449
errors.UnstackableBranchFormat):
895
revs = self.revision_history()
896
if isinstance(revision, int):
899
# Mabye we should do this first, but we don't need it if revision == 0
901
revno = len(revs) + revision + 1
904
elif isinstance(revision, basestring):
905
for prefix, func in Branch.REVISION_NAMESPACES.iteritems():
906
if revision.startswith(prefix):
907
revno = func(self, revs, revision)
910
raise BzrError('No namespace registered for string: %r' % revision)
912
if revno is None or revno <= 0 or revno > len(revs):
913
raise BzrError("no such revision %s" % revision)
914
return revno, revs[revno-1]
916
def _namespace_revno(self, revs, revision):
917
"""Lookup a revision by revision number"""
918
assert revision.startswith('revno:')
920
return int(revision[6:])
923
REVISION_NAMESPACES['revno:'] = _namespace_revno
925
def _namespace_revid(self, revs, revision):
926
assert revision.startswith('revid:')
928
return revs.index(revision[6:]) + 1
931
REVISION_NAMESPACES['revid:'] = _namespace_revid
933
def _namespace_last(self, revs, revision):
934
assert revision.startswith('last:')
936
offset = int(revision[5:])
941
raise BzrError('You must supply a positive value for --revision last:XXX')
942
return len(revs) - offset + 1
943
REVISION_NAMESPACES['last:'] = _namespace_last
945
def _namespace_tag(self, revs, revision):
946
assert revision.startswith('tag:')
947
raise BzrError('tag: namespace registered, but not implemented.')
948
REVISION_NAMESPACES['tag:'] = _namespace_tag
950
def _namespace_date(self, revs, revision):
951
assert revision.startswith('date:')
953
# Spec for date revisions:
955
# value can be 'yesterday', 'today', 'tomorrow' or a YYYY-MM-DD string.
956
# it can also start with a '+/-/='. '+' says match the first
957
# entry after the given date. '-' is match the first entry before the date
958
# '=' is match the first entry after, but still on the given date.
960
# +2005-05-12 says find the first matching entry after May 12th, 2005 at 0:00
961
# -2005-05-12 says find the first matching entry before May 12th, 2005 at 0:00
962
# =2005-05-12 says find the first match after May 12th, 2005 at 0:00 but before
963
# May 13th, 2005 at 0:00
965
# So the proper way of saying 'give me all entries for today' is:
966
# -r {date:+today}:{date:-tomorrow}
967
# The default is '=' when not supplied
970
if val[:1] in ('+', '-', '='):
971
match_style = val[:1]
974
today = datetime.datetime.today().replace(hour=0,minute=0,second=0,microsecond=0)
975
if val.lower() == 'yesterday':
976
dt = today - datetime.timedelta(days=1)
977
elif val.lower() == 'today':
979
elif val.lower() == 'tomorrow':
980
dt = today + datetime.timedelta(days=1)
983
# This should be done outside the function to avoid recompiling it.
984
_date_re = re.compile(
985
r'(?P<date>(?P<year>\d\d\d\d)-(?P<month>\d\d)-(?P<day>\d\d))?'
987
r'(?P<time>(?P<hour>\d\d):(?P<minute>\d\d)(:(?P<second>\d\d))?)?'
989
m = _date_re.match(val)
990
if not m or (not m.group('date') and not m.group('time')):
991
raise BzrError('Invalid revision date %r' % revision)
994
year, month, day = int(m.group('year')), int(m.group('month')), int(m.group('day'))
996
year, month, day = today.year, today.month, today.day
998
hour = int(m.group('hour'))
999
minute = int(m.group('minute'))
1000
if m.group('second'):
1001
second = int(m.group('second'))
1005
hour, minute, second = 0,0,0
1007
dt = datetime.datetime(year=year, month=month, day=day,
1008
hour=hour, minute=minute, second=second)
1012
if match_style == '-':
1014
elif match_style == '=':
1015
last = dt + datetime.timedelta(days=1)
1018
for i in range(len(revs)-1, -1, -1):
1019
r = self.get_revision(revs[i])
1020
# TODO: Handle timezone.
1021
dt = datetime.datetime.fromtimestamp(r.timestamp)
1022
if first >= dt and (last is None or dt >= last):
1025
for i in range(len(revs)):
1026
r = self.get_revision(revs[i])
1027
# TODO: Handle timezone.
1028
dt = datetime.datetime.fromtimestamp(r.timestamp)
1029
if first <= dt and (last is None or dt <= last):
1031
REVISION_NAMESPACES['date:'] = _namespace_date
1033
def revision_tree(self, revision_id):
1034
"""Return Tree for a revision on this branch.
1036
`revision_id` may be None for the null revision, in which case
1037
an `EmptyTree` is returned."""
1038
# TODO: refactor this to use an existing revision object
1039
# so we don't need to read it in twice.
1040
if revision_id == None:
1043
inv = self.get_revision_inventory(revision_id)
1044
return RevisionTree(self.text_store, inv)
1047
def working_tree(self):
1048
"""Return a `Tree` for the working copy."""
1049
from workingtree import WorkingTree
1050
return WorkingTree(self.base, self.read_working_inventory())
1053
def basis_tree(self):
1054
"""Return `Tree` object for last revision.
1056
If there are no revisions yet, return an `EmptyTree`.
1058
r = self.last_patch()
1062
return RevisionTree(self.text_store, self.get_revision_inventory(r))
1066
def rename_one(self, from_rel, to_rel):
1069
This can change the directory or the filename or both.
1073
tree = self.working_tree()
1074
inv = tree.inventory
1075
if not tree.has_filename(from_rel):
1076
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1077
if tree.has_filename(to_rel):
1078
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1080
file_id = inv.path2id(from_rel)
1082
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1084
if inv.path2id(to_rel):
1085
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1087
to_dir, to_tail = os.path.split(to_rel)
1088
to_dir_id = inv.path2id(to_dir)
1089
if to_dir_id == None and to_dir != '':
1090
raise BzrError("can't determine destination directory id for %r" % to_dir)
1092
mutter("rename_one:")
1093
mutter(" file_id {%s}" % file_id)
1094
mutter(" from_rel %r" % from_rel)
1095
mutter(" to_rel %r" % to_rel)
1096
mutter(" to_dir %r" % to_dir)
1097
mutter(" to_dir_id {%s}" % to_dir_id)
1099
inv.rename(file_id, to_dir_id, to_tail)
1101
print "%s => %s" % (from_rel, to_rel)
1103
from_abs = self.abspath(from_rel)
1104
to_abs = self.abspath(to_rel)
1106
os.rename(from_abs, to_abs)
1108
raise BzrError("failed to rename %r to %r: %s"
1109
% (from_abs, to_abs, e[1]),
1110
["rename rolled back"])
1112
self._write_inventory(inv)
1117
def move(self, from_paths, to_name):
1120
to_name must exist as a versioned directory.
1122
If to_name exists and is a directory, the files are moved into
1123
it, keeping their old names. If it is a directory,
1125
Note that to_name is only the last component of the new name;
1126
this doesn't change the directory.
1130
## TODO: Option to move IDs only
1131
assert not isinstance(from_paths, basestring)
1132
tree = self.working_tree()
1133
inv = tree.inventory
1134
to_abs = self.abspath(to_name)
1135
if not isdir(to_abs):
1136
raise BzrError("destination %r is not a directory" % to_abs)
1137
if not tree.has_filename(to_name):
1138
raise BzrError("destination %r not in working directory" % to_abs)
1139
to_dir_id = inv.path2id(to_name)
1140
if to_dir_id == None and to_name != '':
1141
raise BzrError("destination %r is not a versioned directory" % to_name)
1142
to_dir_ie = inv[to_dir_id]
1143
if to_dir_ie.kind not in ('directory', 'root_directory'):
1144
raise BzrError("destination %r is not a directory" % to_abs)
1146
to_idpath = inv.get_idpath(to_dir_id)
1148
for f in from_paths:
1149
if not tree.has_filename(f):
1150
raise BzrError("%r does not exist in working tree" % f)
1151
f_id = inv.path2id(f)
1153
raise BzrError("%r is not versioned" % f)
1154
name_tail = splitpath(f)[-1]
1155
dest_path = appendpath(to_name, name_tail)
1156
if tree.has_filename(dest_path):
1157
raise BzrError("destination %r already exists" % dest_path)
1158
if f_id in to_idpath:
1159
raise BzrError("can't move %r to a subdirectory of itself" % f)
1161
# OK, so there's a race here, it's possible that someone will
1162
# create a file in this interval and then the rename might be
1163
# left half-done. But we should have caught most problems.
1165
for f in from_paths:
1166
name_tail = splitpath(f)[-1]
1167
dest_path = appendpath(to_name, name_tail)
1168
print "%s => %s" % (f, dest_path)
1169
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1171
os.rename(self.abspath(f), self.abspath(dest_path))
1173
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1174
["rename rolled back"])
1176
self._write_inventory(inv)
1181
def revert(self, filenames, old_tree=None, backups=True):
1182
"""Restore selected files to the versions from a previous tree.
1185
If true (default) backups are made of files before
1188
from bzrlib.errors import NotVersionedError, BzrError
1189
from bzrlib.atomicfile import AtomicFile
1190
from bzrlib.osutils import backup_file
1192
inv = self.read_working_inventory()
1193
if old_tree is None:
1194
old_tree = self.basis_tree()
1195
old_inv = old_tree.inventory
1198
for fn in filenames:
1199
file_id = inv.path2id(fn)
1201
raise NotVersionedError("not a versioned file", fn)
1202
if not old_inv.has_id(file_id):
1203
raise BzrError("file not present in old tree", fn, file_id)
1204
nids.append((fn, file_id))
1206
# TODO: Rename back if it was previously at a different location
1208
# TODO: If given a directory, restore the entire contents from
1209
# the previous version.
1211
# TODO: Make a backup to a temporary file.
1213
# TODO: If the file previously didn't exist, delete it?
1214
for fn, file_id in nids:
1217
f = AtomicFile(fn, 'wb')
1219
f.write(old_tree.get_file(file_id).read())
1225
def pending_merges(self):
1226
"""Return a list of pending merges.
1228
These are revisions that have been merged into the working
1229
directory but not yet committed.
1231
cfn = self.controlfilename('pending-merges')
1232
if not os.path.exists(cfn):
1235
for l in self.controlfile('pending-merges', 'r').readlines():
1236
p.append(l.rstrip('\n'))
1240
def add_pending_merge(self, revision_id):
1241
from bzrlib.revision import validate_revision_id
1243
validate_revision_id(revision_id)
1245
p = self.pending_merges()
1246
if revision_id in p:
2452
for hook in Branch.hooks['transform_fallback_location']:
2453
url = hook(self, url)
2455
hook_name = Branch.hooks.get_hook_name(hook)
2456
raise AssertionError(
2457
"'transform_fallback_location' hook %s returned "
2458
"None, not a URL." % hook_name)
2459
self._activate_fallback_location(url)
2461
def __init__(self, *args, **kwargs):
2462
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2463
super(BzrBranch8, self).__init__(*args, **kwargs)
2464
self._last_revision_info_cache = None
2465
self._reference_info = None
2467
def _clear_cached_state(self):
2468
super(BzrBranch8, self)._clear_cached_state()
2469
self._last_revision_info_cache = None
2470
self._reference_info = None
2472
def _last_revision_info(self):
2473
revision_string = self._transport.get_bytes('last-revision')
2474
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2475
revision_id = cache_utf8.get_cached_utf8(revision_id)
2477
return revno, revision_id
2479
def _write_last_revision_info(self, revno, revision_id):
2480
"""Simply write out the revision id, with no checks.
2482
Use set_last_revision_info to perform this safely.
2484
Does not update the revision_history cache.
2485
Intended to be called by set_last_revision_info and
2486
_write_revision_history.
2488
revision_id = _mod_revision.ensure_null(revision_id)
2489
out_string = '%d %s\n' % (revno, revision_id)
2490
self._transport.put_bytes('last-revision', out_string,
2491
mode=self.bzrdir._get_file_mode())
2494
def set_last_revision_info(self, revno, revision_id):
2495
revision_id = _mod_revision.ensure_null(revision_id)
2496
old_revno, old_revid = self.last_revision_info()
2497
if self._get_append_revisions_only():
2498
self._check_history_violation(revision_id)
2499
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2500
self._write_last_revision_info(revno, revision_id)
2501
self._clear_cached_state()
2502
self._last_revision_info_cache = revno, revision_id
2503
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2505
def _synchronize_history(self, destination, revision_id):
2506
"""Synchronize last revision and revision history between branches.
2508
:see: Branch._synchronize_history
2510
# XXX: The base Branch has a fast implementation of this method based
2511
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2512
# that uses set_revision_history. This class inherits from BzrBranch5,
2513
# but wants the fast implementation, so it calls
2514
# Branch._synchronize_history directly.
2515
Branch._synchronize_history(self, destination, revision_id)
2517
def _check_history_violation(self, revision_id):
2518
last_revision = _mod_revision.ensure_null(self.last_revision())
2519
if _mod_revision.is_null(last_revision):
1248
p.append(revision_id)
1249
self.set_pending_merges(p)
1252
def set_pending_merges(self, rev_list):
1253
from bzrlib.atomicfile import AtomicFile
2521
if last_revision not in self._lefthand_history(revision_id):
2522
raise errors.AppendRevisionsOnlyViolation(self.base)
2524
def _gen_revision_history(self):
2525
"""Generate the revision history from last revision
2527
last_revno, last_revision = self.last_revision_info()
2528
self._extend_partial_history(stop_index=last_revno-1)
2529
return list(reversed(self._partial_revision_history_cache))
2531
def _write_revision_history(self, history):
2532
"""Factored out of set_revision_history.
2534
This performs the actual writing to disk, with format-specific checks.
2535
It is intended to be called by BzrBranch5.set_revision_history.
2537
if len(history) == 0:
2538
last_revision = 'null:'
2540
if history != self._lefthand_history(history[-1]):
2541
raise errors.NotLefthandHistory(history)
2542
last_revision = history[-1]
2543
if self._get_append_revisions_only():
2544
self._check_history_violation(last_revision)
2545
self._write_last_revision_info(len(history), last_revision)
2548
def _set_parent_location(self, url):
2549
"""Set the parent branch"""
2550
self._set_config_location('parent_location', url, make_relative=True)
2553
def _get_parent_location(self):
2554
"""Set the parent branch"""
2555
return self._get_config_location('parent_location')
2558
def _set_all_reference_info(self, info_dict):
2559
"""Replace all reference info stored in a branch.
2561
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2564
writer = rio.RioWriter(s)
2565
for key, (tree_path, branch_location) in info_dict.iteritems():
2566
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2567
branch_location=branch_location)
2568
writer.write_stanza(stanza)
2569
self._transport.put_bytes('references', s.getvalue())
2570
self._reference_info = info_dict
2573
def _get_all_reference_info(self):
2574
"""Return all the reference info stored in a branch.
2576
:return: A dict of {file_id: (tree_path, branch_location)}
2578
if self._reference_info is not None:
2579
return self._reference_info
2580
rio_file = self._transport.get('references')
1256
f = AtomicFile(self.controlfilename('pending-merges'))
2582
stanzas = rio.read_stanzas(rio_file)
2583
info_dict = dict((s['file_id'], (s['tree_path'],
2584
s['branch_location'])) for s in stanzas)
1268
class ScratchBranch(Branch):
1269
"""Special test class: a branch that cleans up after itself.
1271
>>> b = ScratchBranch()
2587
self._reference_info = info_dict
2590
def set_reference_info(self, file_id, tree_path, branch_location):
2591
"""Set the branch location to use for a tree reference.
2593
:param file_id: The file-id of the tree reference.
2594
:param tree_path: The path of the tree reference in the tree.
2595
:param branch_location: The location of the branch to retrieve tree
2598
info_dict = self._get_all_reference_info()
2599
info_dict[file_id] = (tree_path, branch_location)
2600
if None in (tree_path, branch_location):
2601
if tree_path is not None:
2602
raise ValueError('tree_path must be None when branch_location'
2604
if branch_location is not None:
2605
raise ValueError('branch_location must be None when tree_path'
2607
del info_dict[file_id]
2608
self._set_all_reference_info(info_dict)
2610
def get_reference_info(self, file_id):
2611
"""Get the tree_path and branch_location for a tree reference.
2613
:return: a tuple of (tree_path, branch_location)
2615
return self._get_all_reference_info().get(file_id, (None, None))
2617
def reference_parent(self, file_id, path, possible_transports=None):
2618
"""Return the parent branch for a tree-reference file_id.
2620
:param file_id: The file_id of the tree reference
2621
:param path: The path of the file_id in the tree
2622
:return: A branch associated with the file_id
2624
branch_location = self.get_reference_info(file_id)[1]
2625
if branch_location is None:
2626
return Branch.reference_parent(self, file_id, path,
2627
possible_transports)
2628
branch_location = urlutils.join(self.base, branch_location)
2629
return Branch.open(branch_location,
2630
possible_transports=possible_transports)
2632
def set_push_location(self, location):
2633
"""See Branch.set_push_location."""
2634
self._set_config_location('push_location', location)
2636
def set_bound_location(self, location):
2637
"""See Branch.set_push_location."""
2639
config = self.get_config()
2640
if location is None:
2641
if config.get_user_option('bound') != 'True':
2644
config.set_user_option('bound', 'False', warn_masked=True)
2647
self._set_config_location('bound_location', location,
2649
config.set_user_option('bound', 'True', warn_masked=True)
2652
def _get_bound_location(self, bound):
2653
"""Return the bound location in the config file.
2655
Return None if the bound parameter does not match"""
2656
config = self.get_config()
2657
config_bound = (config.get_user_option('bound') == 'True')
2658
if config_bound != bound:
2660
return self._get_config_location('bound_location', config=config)
2662
def get_bound_location(self):
2663
"""See Branch.set_push_location."""
2664
return self._get_bound_location(True)
2666
def get_old_bound_location(self):
2667
"""See Branch.get_old_bound_location"""
2668
return self._get_bound_location(False)
2670
def get_stacked_on_url(self):
2671
# you can always ask for the URL; but you might not be able to use it
2672
# if the repo can't support stacking.
2673
## self._check_stackable_repo()
2674
stacked_url = self._get_config_location('stacked_on_location')
2675
if stacked_url is None:
2676
raise errors.NotStacked(self)
2679
def _get_append_revisions_only(self):
2680
value = self.get_config().get_user_option('append_revisions_only')
2681
return value == 'True'
2684
def generate_revision_history(self, revision_id, last_rev=None,
2686
"""See BzrBranch5.generate_revision_history"""
2687
history = self._lefthand_history(revision_id, last_rev, other_branch)
2688
revno = len(history)
2689
self.set_last_revision_info(revno, revision_id)
2692
def get_rev_id(self, revno, history=None):
2693
"""Find the revision id of the specified revno."""
2695
return _mod_revision.NULL_REVISION
2697
last_revno, last_revision_id = self.last_revision_info()
2698
if revno <= 0 or revno > last_revno:
2699
raise errors.NoSuchRevision(self, revno)
2701
if history is not None:
2702
return history[revno - 1]
2704
index = last_revno - revno
2705
if len(self._partial_revision_history_cache) <= index:
2706
self._extend_partial_history(stop_index=index)
2707
if len(self._partial_revision_history_cache) > index:
2708
return self._partial_revision_history_cache[index]
2710
raise errors.NoSuchRevision(self, revno)
2713
def revision_id_to_revno(self, revision_id):
2714
"""Given a revision id, return its revno"""
2715
if _mod_revision.is_null(revision_id):
2718
index = self._partial_revision_history_cache.index(revision_id)
2720
self._extend_partial_history(stop_revision=revision_id)
2721
index = len(self._partial_revision_history_cache) - 1
2722
if self._partial_revision_history_cache[index] != revision_id:
2723
raise errors.NoSuchRevision(self, revision_id)
2724
return self.revno() - index
2727
class BzrBranch7(BzrBranch8):
2728
"""A branch with support for a fallback repository."""
2730
def set_reference_info(self, file_id, tree_path, branch_location):
2731
Branch.set_reference_info(self, file_id, tree_path, branch_location)
2733
def get_reference_info(self, file_id):
2734
Branch.get_reference_info(self, file_id)
2736
def reference_parent(self, file_id, path, possible_transports=None):
2737
return Branch.reference_parent(self, file_id, path,
2738
possible_transports)
2741
class BzrBranch6(BzrBranch7):
2742
"""See BzrBranchFormat6 for the capabilities of this branch.
2744
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
1279
def __init__(self, files=[], dirs=[], base=None):
1280
"""Make a test branch.
1282
This creates a temporary directory and runs init-tree in it.
1284
If any files are listed, they are created in the working copy.
1286
from tempfile import mkdtemp
1291
Branch.__init__(self, base, init=init)
1293
os.mkdir(self.abspath(d))
1296
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
1301
>>> orig = ScratchBranch(files=["file1", "file2"])
1302
>>> clone = orig.clone()
1303
>>> os.path.samefile(orig.base, clone.base)
1305
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1308
from shutil import copytree
1309
from tempfile import mkdtemp
1312
copytree(self.base, base, symlinks=True)
1313
return ScratchBranch(base=base)
1319
"""Destroy the test branch, removing the scratch directory."""
1320
from shutil import rmtree
1323
mutter("delete ScratchBranch %s" % self.base)
1326
# Work around for shutil.rmtree failing on Windows when
1327
# readonly files are encountered
1328
mutter("hit exception in destroying ScratchBranch: %s" % e)
1329
for root, dirs, files in os.walk(self.base, topdown=False):
1331
os.chmod(os.path.join(root, name), 0700)
2748
def get_stacked_on_url(self):
2749
raise errors.UnstackableBranchFormat(self._format, self.base)
1337
2752
######################################################################
1341
def is_control_file(filename):
1342
## FIXME: better check
1343
filename = os.path.normpath(filename)
1344
while filename != '':
1345
head, tail = os.path.split(filename)
1346
## mutter('check %r for control file' % ((head, tail), ))
1347
if tail == bzrlib.BZRDIR:
1349
if filename == head:
1356
def gen_file_id(name):
1357
"""Return new file id.
1359
This should probably generate proper UUIDs, but for the moment we
1360
cope with just randomness because running uuidgen every time is
1363
from binascii import hexlify
1364
from time import time
1366
# get last component
1367
idx = name.rfind('/')
1369
name = name[idx+1 : ]
1370
idx = name.rfind('\\')
1372
name = name[idx+1 : ]
1374
# make it not a hidden file
1375
name = name.lstrip('.')
1377
# remove any wierd characters; we don't escape them but rather
1378
# just pull them out
1379
name = re.sub(r'[^\w.]', '', name)
1381
s = hexlify(rand_bytes(8))
1382
return '-'.join((name, compact_date(time()), s))
1386
"""Return a new tree-root file id."""
1387
return gen_file_id('TREE_ROOT')
2753
# results of operations
2756
class _Result(object):
2758
def _show_tag_conficts(self, to_file):
2759
if not getattr(self, 'tag_conflicts', None):
2761
to_file.write('Conflicting tags:\n')
2762
for name, value1, value2 in self.tag_conflicts:
2763
to_file.write(' %s\n' % (name, ))
2766
class PullResult(_Result):
2767
"""Result of a Branch.pull operation.
2769
:ivar old_revno: Revision number before pull.
2770
:ivar new_revno: Revision number after pull.
2771
:ivar old_revid: Tip revision id before pull.
2772
:ivar new_revid: Tip revision id after pull.
2773
:ivar source_branch: Source (local) branch object. (read locked)
2774
:ivar master_branch: Master branch of the target, or the target if no
2776
:ivar local_branch: target branch if there is a Master, else None
2777
:ivar target_branch: Target/destination branch object. (write locked)
2778
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2782
# DEPRECATED: pull used to return the change in revno
2783
return self.new_revno - self.old_revno
2785
def report(self, to_file):
2787
if self.old_revid == self.new_revid:
2788
to_file.write('No revisions to pull.\n')
2790
to_file.write('Now on revision %d.\n' % self.new_revno)
2791
self._show_tag_conficts(to_file)
2794
class BranchPushResult(_Result):
2795
"""Result of a Branch.push operation.
2797
:ivar old_revno: Revision number (eg 10) of the target before push.
2798
:ivar new_revno: Revision number (eg 12) of the target after push.
2799
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
2801
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
2803
:ivar source_branch: Source branch object that the push was from. This is
2804
read locked, and generally is a local (and thus low latency) branch.
2805
:ivar master_branch: If target is a bound branch, the master branch of
2806
target, or target itself. Always write locked.
2807
:ivar target_branch: The direct Branch where data is being sent (write
2809
:ivar local_branch: If the target is a bound branch this will be the
2810
target, otherwise it will be None.
2814
# DEPRECATED: push used to return the change in revno
2815
return self.new_revno - self.old_revno
2817
def report(self, to_file):
2818
"""Write a human-readable description of the result."""
2819
if self.old_revid == self.new_revid:
2820
note('No new revisions to push.')
2822
note('Pushed up to revision %d.' % self.new_revno)
2823
self._show_tag_conficts(to_file)
2826
class BranchCheckResult(object):
2827
"""Results of checking branch consistency.
2832
def __init__(self, branch):
2833
self.branch = branch
2836
def report_results(self, verbose):
2837
"""Report the check results via trace.note.
2839
:param verbose: Requests more detailed display of what was checked,
2842
note('checked branch %s format %s', self.branch.base,
2843
self.branch._format)
2844
for error in self.errors:
2845
note('found error:%s', error)
2848
class Converter5to6(object):
2849
"""Perform an in-place upgrade of format 5 to format 6"""
2851
def convert(self, branch):
2852
# Data for 5 and 6 can peacefully coexist.
2853
format = BzrBranchFormat6()
2854
new_branch = format.open(branch.bzrdir, _found=True)
2856
# Copy source data into target
2857
new_branch._write_last_revision_info(*branch.last_revision_info())
2858
new_branch.set_parent(branch.get_parent())
2859
new_branch.set_bound_location(branch.get_bound_location())
2860
new_branch.set_push_location(branch.get_push_location())
2862
# New branch has no tags by default
2863
new_branch.tags._set_tag_dict({})
2865
# Copying done; now update target format
2866
new_branch._transport.put_bytes('format',
2867
format.get_format_string(),
2868
mode=new_branch.bzrdir._get_file_mode())
2870
# Clean up old files
2871
new_branch._transport.delete('revision-history')
2873
branch.set_parent(None)
2874
except errors.NoSuchFile:
2876
branch.set_bound_location(None)
2879
class Converter6to7(object):
2880
"""Perform an in-place upgrade of format 6 to format 7"""
2882
def convert(self, branch):
2883
format = BzrBranchFormat7()
2884
branch._set_config_location('stacked_on_location', '')
2885
# update target format
2886
branch._transport.put_bytes('format', format.get_format_string())
2889
class Converter7to8(object):
2890
"""Perform an in-place upgrade of format 6 to format 7"""
2892
def convert(self, branch):
2893
format = BzrBranchFormat8()
2894
branch._transport.put_bytes('references', '')
2895
# update target format
2896
branch._transport.put_bytes('format', format.get_format_string())
2899
def _run_with_write_locked_target(target, callable, *args, **kwargs):
2900
"""Run ``callable(*args, **kwargs)``, write-locking target for the
2903
_run_with_write_locked_target will attempt to release the lock it acquires.
2905
If an exception is raised by callable, then that exception *will* be
2906
propagated, even if the unlock attempt raises its own error. Thus
2907
_run_with_write_locked_target should be preferred to simply doing::
2911
return callable(*args, **kwargs)
2916
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
2917
# should share code?
2920
result = callable(*args, **kwargs)
2922
exc_info = sys.exc_info()
2926
raise exc_info[0], exc_info[1], exc_info[2]
2932
class InterBranch(InterObject):
2933
"""This class represents operations taking place between two branches.
2935
Its instances have methods like pull() and push() and contain
2936
references to the source and target repositories these operations
2937
can be carried out on.
2941
"""The available optimised InterBranch types."""
2944
def _get_branch_formats_to_test():
2945
"""Return a tuple with the Branch formats to use when testing."""
2946
raise NotImplementedError(InterBranch._get_branch_formats_to_test)
2948
def pull(self, overwrite=False, stop_revision=None,
2949
possible_transports=None, local=False):
2950
"""Mirror source into target branch.
2952
The target branch is considered to be 'local', having low latency.
2954
:returns: PullResult instance
2956
raise NotImplementedError(self.pull)
2958
def update_revisions(self, stop_revision=None, overwrite=False,
2960
"""Pull in new perfect-fit revisions.
2962
:param stop_revision: Updated until the given revision
2963
:param overwrite: Always set the branch pointer, rather than checking
2964
to see if it is a proper descendant.
2965
:param graph: A Graph object that can be used to query history
2966
information. This can be None.
2969
raise NotImplementedError(self.update_revisions)
2971
def push(self, overwrite=False, stop_revision=None,
2972
_override_hook_source_branch=None):
2973
"""Mirror the source branch into the target branch.
2975
The source branch is considered to be 'local', having low latency.
2977
raise NotImplementedError(self.push)
2980
class GenericInterBranch(InterBranch):
2981
"""InterBranch implementation that uses public Branch functions.
2985
def _get_branch_formats_to_test():
2986
return BranchFormat._default_format, BranchFormat._default_format
2988
def update_revisions(self, stop_revision=None, overwrite=False,
2990
"""See InterBranch.update_revisions()."""
2991
self.source.lock_read()
2993
other_revno, other_last_revision = self.source.last_revision_info()
2994
stop_revno = None # unknown
2995
if stop_revision is None:
2996
stop_revision = other_last_revision
2997
if _mod_revision.is_null(stop_revision):
2998
# if there are no commits, we're done.
3000
stop_revno = other_revno
3002
# what's the current last revision, before we fetch [and change it
3004
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3005
# we fetch here so that we don't process data twice in the common
3006
# case of having something to pull, and so that the check for
3007
# already merged can operate on the just fetched graph, which will
3008
# be cached in memory.
3009
self.target.fetch(self.source, stop_revision)
3010
# Check to see if one is an ancestor of the other
3013
graph = self.target.repository.get_graph()
3014
if self.target._check_if_descendant_or_diverged(
3015
stop_revision, last_rev, graph, self.source):
3016
# stop_revision is a descendant of last_rev, but we aren't
3017
# overwriting, so we're done.
3019
if stop_revno is None:
3021
graph = self.target.repository.get_graph()
3022
this_revno, this_last_revision = \
3023
self.target.last_revision_info()
3024
stop_revno = graph.find_distance_to_null(stop_revision,
3025
[(other_last_revision, other_revno),
3026
(this_last_revision, this_revno)])
3027
self.target.set_last_revision_info(stop_revno, stop_revision)
3029
self.source.unlock()
3031
def pull(self, overwrite=False, stop_revision=None,
3032
possible_transports=None, _hook_master=None, run_hooks=True,
3033
_override_hook_target=None, local=False):
3036
:param _hook_master: Private parameter - set the branch to
3037
be supplied as the master to pull hooks.
3038
:param run_hooks: Private parameter - if false, this branch
3039
is being called because it's the master of the primary branch,
3040
so it should not run its hooks.
3041
:param _override_hook_target: Private parameter - set the branch to be
3042
supplied as the target_branch to pull hooks.
3043
:param local: Only update the local branch, and not the bound branch.
3045
# This type of branch can't be bound.
3047
raise errors.LocalRequiresBoundBranch()
3048
result = PullResult()
3049
result.source_branch = self.source
3050
if _override_hook_target is None:
3051
result.target_branch = self.target
3053
result.target_branch = _override_hook_target
3054
self.source.lock_read()
3056
# We assume that during 'pull' the target repository is closer than
3058
self.source.update_references(self.target)
3059
graph = self.target.repository.get_graph(self.source.repository)
3060
# TODO: Branch formats should have a flag that indicates
3061
# that revno's are expensive, and pull() should honor that flag.
3063
result.old_revno, result.old_revid = \
3064
self.target.last_revision_info()
3065
self.target.update_revisions(self.source, stop_revision,
3066
overwrite=overwrite, graph=graph)
3067
# TODO: The old revid should be specified when merging tags,
3068
# so a tags implementation that versions tags can only
3069
# pull in the most recent changes. -- JRV20090506
3070
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3072
result.new_revno, result.new_revid = self.target.last_revision_info()
3074
result.master_branch = _hook_master
3075
result.local_branch = result.target_branch
3077
result.master_branch = result.target_branch
3078
result.local_branch = None
3080
for hook in Branch.hooks['post_pull']:
3083
self.source.unlock()
3086
def push(self, overwrite=False, stop_revision=None,
3087
_override_hook_source_branch=None):
3088
"""See InterBranch.push.
3090
This is the basic concrete implementation of push()
3092
:param _override_hook_source_branch: If specified, run
3093
the hooks passing this Branch as the source, rather than self.
3094
This is for use of RemoteBranch, where push is delegated to the
3095
underlying vfs-based Branch.
3097
# TODO: Public option to disable running hooks - should be trivial but
3099
self.source.lock_read()
3101
return _run_with_write_locked_target(
3102
self.target, self._push_with_bound_branches, overwrite,
3104
_override_hook_source_branch=_override_hook_source_branch)
3106
self.source.unlock()
3108
def _push_with_bound_branches(self, overwrite, stop_revision,
3109
_override_hook_source_branch=None):
3110
"""Push from source into target, and into target's master if any.
3113
if _override_hook_source_branch:
3114
result.source_branch = _override_hook_source_branch
3115
for hook in Branch.hooks['post_push']:
3118
bound_location = self.target.get_bound_location()
3119
if bound_location and self.target.base != bound_location:
3120
# there is a master branch.
3122
# XXX: Why the second check? Is it even supported for a branch to
3123
# be bound to itself? -- mbp 20070507
3124
master_branch = self.target.get_master_branch()
3125
master_branch.lock_write()
3127
# push into the master from the source branch.
3128
self.source._basic_push(master_branch, overwrite, stop_revision)
3129
# and push into the target branch from the source. Note that we
3130
# push from the source branch again, because its considered the
3131
# highest bandwidth repository.
3132
result = self.source._basic_push(self.target, overwrite,
3134
result.master_branch = master_branch
3135
result.local_branch = self.target
3139
master_branch.unlock()
3142
result = self.source._basic_push(self.target, overwrite,
3144
# TODO: Why set master_branch and local_branch if there's no
3145
# binding? Maybe cleaner to just leave them unset? -- mbp
3147
result.master_branch = self.target
3148
result.local_branch = None
3153
def is_compatible(self, source, target):
3154
# GenericBranch uses the public API, so always compatible
3158
class InterToBranch5(GenericInterBranch):
3161
def _get_branch_formats_to_test():
3162
return BranchFormat._default_format, BzrBranchFormat5()
3164
def pull(self, overwrite=False, stop_revision=None,
3165
possible_transports=None, run_hooks=True,
3166
_override_hook_target=None, local=False):
3167
"""Pull from source into self, updating my master if any.
3169
:param run_hooks: Private parameter - if false, this branch
3170
is being called because it's the master of the primary branch,
3171
so it should not run its hooks.
3173
bound_location = self.target.get_bound_location()
3174
if local and not bound_location:
3175
raise errors.LocalRequiresBoundBranch()
3176
master_branch = None
3177
if not local and bound_location and self.source.base != bound_location:
3178
# not pulling from master, so we need to update master.
3179
master_branch = self.target.get_master_branch(possible_transports)
3180
master_branch.lock_write()
3183
# pull from source into master.
3184
master_branch.pull(self.source, overwrite, stop_revision,
3186
return super(InterToBranch5, self).pull(overwrite,
3187
stop_revision, _hook_master=master_branch,
3188
run_hooks=run_hooks,
3189
_override_hook_target=_override_hook_target)
3192
master_branch.unlock()
3195
InterBranch.register_optimiser(GenericInterBranch)
3196
InterBranch.register_optimiser(InterToBranch5)
added
removed
bzrlib/branch.py
