137
79
"""Branch holding a history of revisions.
140
Base directory of the branch.
146
If _lock_mode is true, a positive count of the number of times the
150
Lock object from bzrlib.lock.
82
Base directory/url of the branch.
84
hooks: An instance of BranchHooks.
86
# this is really an instance variable - FIXME move it there
157
# Map some sort of prefix into a namespace
158
# stuff like "revno:10", "revid:", etc.
159
# This should match a prefix with a function which accepts
160
REVISION_NAMESPACES = {}
162
def __init__(self, base, init=False, find_root=True):
163
"""Create new branch object at a particular location.
165
base -- Base directory for the branch.
167
init -- If True, create new control files in a previously
168
unversioned directory. If False, the branch must already
171
find_root -- If true and init is false, find the root of the
172
existing branch containing base.
174
In the test suite, creation of new trees is tested using the
175
`ScratchBranch` class.
177
from bzrlib.store import ImmutableStore
179
self.base = os.path.realpath(base)
182
self.base = find_branch_root(base)
184
self.base = os.path.realpath(base)
185
if not isdir(self.controlfilename('.')):
186
from errors import NotBranchError
187
raise NotBranchError("not a bzr branch: %s" % quotefn(base),
188
['use "bzr init" to initialize a new working tree',
189
'current bzr can only operate from top-of-tree'])
192
self.text_store = ImmutableStore(self.controlfilename('text-store'))
193
self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
194
self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
198
return '%s(%r)' % (self.__class__.__name__, self.base)
205
if self._lock_mode or self._lock:
206
from warnings import warn
207
warn("branch %r was not explicitly unlocked" % self)
90
def __init__(self, *ignored, **ignored_too):
91
self.tags = self._format.make_tags(self)
92
self._revision_history_cache = None
93
self._revision_id_to_revno_cache = None
94
self._partial_revision_id_to_revno_cache = {}
95
self._partial_revision_history_cache = []
96
self._last_revision_info_cache = None
97
self._merge_sorted_revisions_cache = None
99
hooks = Branch.hooks['open']
103
def _open_hook(self):
104
"""Called by init to allow simpler extension of the base class."""
106
def _activate_fallback_location(self, url):
107
"""Activate the branch/repository from url as a fallback repository."""
108
repo = self._get_fallback_repository(url)
109
if repo.has_same_location(self.repository):
110
raise errors.UnstackableLocationError(self.base, url)
111
self.repository.add_fallback_repository(repo)
113
def break_lock(self):
114
"""Break a lock if one is present from another instance.
116
Uses the ui factory to ask for confirmation if the lock may be from
119
This will probe the repository for its lock as well.
121
self.control_files.break_lock()
122
self.repository.break_lock()
123
master = self.get_master_branch()
124
if master is not None:
127
def _check_stackable_repo(self):
128
if not self.repository._format.supports_external_lookups:
129
raise errors.UnstackableRepositoryFormat(self.repository._format,
130
self.repository.base)
132
def _extend_partial_history(self, stop_index=None, stop_revision=None):
133
"""Extend the partial history to include a given index
135
If a stop_index is supplied, stop when that index has been reached.
136
If a stop_revision is supplied, stop when that revision is
137
encountered. Otherwise, stop when the beginning of history is
140
:param stop_index: The index which should be present. When it is
141
present, history extension will stop.
142
:param stop_revision: The revision id which should be present. When
143
it is encountered, history extension will stop.
145
if len(self._partial_revision_history_cache) == 0:
146
self._partial_revision_history_cache = [self.last_revision()]
147
repository._iter_for_revno(
148
self.repository, self._partial_revision_history_cache,
149
stop_index=stop_index, stop_revision=stop_revision)
150
if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
151
self._partial_revision_history_cache.pop()
153
def _get_check_refs(self):
154
"""Get the references needed for check().
158
revid = self.last_revision()
159
return [('revision-existence', revid), ('lefthand-distance', revid)]
162
def open(base, _unsupported=False, possible_transports=None):
163
"""Open the branch rooted at base.
165
For instance, if the branch is at URL/.bzr/branch,
166
Branch.open(URL) -> a Branch instance.
168
control = bzrdir.BzrDir.open(base, _unsupported,
169
possible_transports=possible_transports)
170
return control.open_branch(unsupported=_unsupported)
173
def open_from_transport(transport, name=None, _unsupported=False):
174
"""Open the branch rooted at transport"""
175
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
176
return control.open_branch(name=name, unsupported=_unsupported)
179
def open_containing(url, possible_transports=None):
180
"""Open an existing branch which contains url.
182
This probes for a branch at url, and searches upwards from there.
184
Basically we keep looking up until we find the control directory or
185
run into the root. If there isn't one, raises NotBranchError.
186
If there is one and it is either an unrecognised format or an unsupported
187
format, UnknownFormatError or UnsupportedFormatError are raised.
188
If there is one, it is returned, along with the unused portion of url.
190
control, relpath = bzrdir.BzrDir.open_containing(url,
192
return control.open_branch(), relpath
194
def _push_should_merge_tags(self):
195
"""Should _basic_push merge this branch's tags into the target?
197
The default implementation returns False if this branch has no tags,
198
and True the rest of the time. Subclasses may override this.
200
return self.supports_tags() and self.tags.get_tag_dict()
202
def get_config(self):
203
return BranchConfig(self)
205
def _get_config(self):
206
"""Get the concrete config for just the config in this branch.
208
This is not intended for client use; see Branch.get_config for the
213
:return: An object supporting get_option and set_option.
215
raise NotImplementedError(self._get_config)
217
def _get_fallback_repository(self, url):
218
"""Get the repository we fallback to at url."""
219
url = urlutils.join(self.base, url)
220
a_branch = Branch.open(url,
221
possible_transports=[self.bzrdir.root_transport])
222
return a_branch.repository
224
def _get_tags_bytes(self):
225
"""Get the bytes of a serialised tags dict.
227
Note that not all branches support tags, nor do all use the same tags
228
logic: this method is specific to BasicTags. Other tag implementations
229
may use the same method name and behave differently, safely, because
230
of the double-dispatch via
231
format.make_tags->tags_instance->get_tags_dict.
233
:return: The bytes of the tags file.
234
:seealso: Branch._set_tags_bytes.
236
return self._transport.get_bytes('tags')
238
def _get_nick(self, local=False, possible_transports=None):
239
config = self.get_config()
240
# explicit overrides master, but don't look for master if local is True
241
if not local and not config.has_explicit_nickname():
243
master = self.get_master_branch(possible_transports)
244
if master is not None:
245
# return the master branch value
247
except errors.BzrError, e:
248
# Silently fall back to local implicit nick if the master is
250
mutter("Could not connect to bound branch, "
251
"falling back to local nick.\n " + str(e))
252
return config.get_nickname()
254
def _set_nick(self, nick):
255
self.get_config().set_user_option('nickname', nick, warn_masked=True)
257
nick = property(_get_nick, _set_nick)
260
raise NotImplementedError(self.is_locked)
262
def _lefthand_history(self, revision_id, last_rev=None,
264
if 'evil' in debug.debug_flags:
265
mutter_callsite(4, "_lefthand_history scales with history.")
266
# stop_revision must be a descendant of last_revision
267
graph = self.repository.get_graph()
268
if last_rev is not None:
269
if not graph.is_ancestor(last_rev, revision_id):
270
# our previous tip is not merged into stop_revision
271
raise errors.DivergedBranches(self, other_branch)
272
# make a new revision history from the graph
273
parents_map = graph.get_parent_map([revision_id])
274
if revision_id not in parents_map:
275
raise errors.NoSuchRevision(self, revision_id)
276
current_rev_id = revision_id
278
check_not_reserved_id = _mod_revision.check_not_reserved_id
279
# Do not include ghosts or graph origin in revision_history
280
while (current_rev_id in parents_map and
281
len(parents_map[current_rev_id]) > 0):
282
check_not_reserved_id(current_rev_id)
283
new_history.append(current_rev_id)
284
current_rev_id = parents_map[current_rev_id][0]
285
parents_map = graph.get_parent_map([current_rev_id])
286
new_history.reverse()
212
289
def lock_write(self):
214
if self._lock_mode != 'w':
215
from errors import LockError
216
raise LockError("can't upgrade to a write lock from %r" %
218
self._lock_count += 1
220
from bzrlib.lock import WriteLock
222
self._lock = WriteLock(self.controlfilename('branch-lock'))
223
self._lock_mode = 'w'
290
raise NotImplementedError(self.lock_write)
228
292
def lock_read(self):
230
assert self._lock_mode in ('r', 'w'), \
231
"invalid lock mode %r" % self._lock_mode
232
self._lock_count += 1
234
from bzrlib.lock import ReadLock
236
self._lock = ReadLock(self.controlfilename('branch-lock'))
237
self._lock_mode = 'r'
293
raise NotImplementedError(self.lock_read)
242
295
def unlock(self):
243
if not self._lock_mode:
244
from errors import LockError
245
raise LockError('branch %r is not locked' % (self))
247
if self._lock_count > 1:
248
self._lock_count -= 1
252
self._lock_mode = self._lock_count = None
255
def abspath(self, name):
256
"""Return absolute filename for something in the branch"""
257
return os.path.join(self.base, name)
260
def relpath(self, path):
261
"""Return path relative to this branch of something inside it.
263
Raises an error if path is not in this branch."""
264
return _relpath(self.base, path)
267
def controlfilename(self, file_or_path):
268
"""Return location relative to branch."""
269
if isinstance(file_or_path, basestring):
270
file_or_path = [file_or_path]
271
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
274
def controlfile(self, file_or_path, mode='r'):
275
"""Open a control file for this branch.
277
There are two classes of file in the control directory: text
278
and binary. binary files are untranslated byte streams. Text
279
control files are stored with Unix newlines and in UTF-8, even
280
if the platform or locale defaults are different.
282
Controlfiles should almost never be opened in write mode but
283
rather should be atomically copied and replaced using atomicfile.
286
fn = self.controlfilename(file_or_path)
288
if mode == 'rb' or mode == 'wb':
289
return file(fn, mode)
290
elif mode == 'r' or mode == 'w':
291
# open in binary mode anyhow so there's no newline translation;
292
# codecs uses line buffering by default; don't want that.
294
return codecs.open(fn, mode + 'b', 'utf-8',
297
raise BzrError("invalid controlfile mode %r" % mode)
301
def _make_control(self):
302
from bzrlib.inventory import Inventory
303
from bzrlib.xml import pack_xml
305
os.mkdir(self.controlfilename([]))
306
self.controlfile('README', 'w').write(
307
"This is a Bazaar-NG control directory.\n"
308
"Do not change any files in this directory.\n")
309
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
310
for d in ('text-store', 'inventory-store', 'revision-store'):
311
os.mkdir(self.controlfilename(d))
312
for f in ('revision-history', 'merged-patches',
313
'pending-merged-patches', 'branch-name',
316
self.controlfile(f, 'w').write('')
317
mutter('created control directory in ' + self.base)
319
pack_xml(Inventory(gen_root_id()), self.controlfile('inventory','w'))
322
def _check_format(self):
323
"""Check this branch format is supported.
325
The current tool only supports the current unstable format.
327
In the future, we might need different in-memory Branch
328
classes to support downlevel branches. But not yet.
330
# This ignores newlines so that we can open branches created
331
# on Windows from Linux and so on. I think it might be better
332
# to always make all internal files in unix format.
333
fmt = self.controlfile('branch-format', 'r').read()
334
fmt.replace('\r\n', '')
335
if fmt != BZR_BRANCH_FORMAT:
336
raise BzrError('sorry, branch format %r not supported' % fmt,
337
['use a different bzr version',
338
'or remove the .bzr directory and "bzr init" again'])
340
def get_root_id(self):
341
"""Return the id of this branches root"""
342
inv = self.read_working_inventory()
343
return inv.root.file_id
345
def set_root_id(self, file_id):
346
inv = self.read_working_inventory()
347
orig_root_id = inv.root.file_id
348
del inv._byid[inv.root.file_id]
349
inv.root.file_id = file_id
350
inv._byid[inv.root.file_id] = inv.root
353
if entry.parent_id in (None, orig_root_id):
354
entry.parent_id = inv.root.file_id
355
self._write_inventory(inv)
357
def read_working_inventory(self):
358
"""Read the working inventory."""
359
from bzrlib.inventory import Inventory
360
from bzrlib.xml import unpack_xml
361
from time import time
365
# ElementTree does its own conversion from UTF-8, so open in
367
inv = unpack_xml(Inventory,
368
self.controlfile('inventory', 'rb'))
369
mutter("loaded inventory of %d items in %f"
370
% (len(inv), time() - before))
376
def _write_inventory(self, inv):
377
"""Update the working inventory.
379
That is to say, the inventory describing changes underway, that
380
will be committed to the next revision.
382
from bzrlib.atomicfile import AtomicFile
383
from bzrlib.xml import pack_xml
387
f = AtomicFile(self.controlfilename('inventory'), 'wb')
396
mutter('wrote working inventory')
399
inventory = property(read_working_inventory, _write_inventory, None,
400
"""Inventory for the working copy.""")
403
def add(self, files, verbose=False, ids=None):
404
"""Make files versioned.
406
Note that the command line normally calls smart_add instead.
408
This puts the files in the Added state, so that they will be
409
recorded by the next commit.
412
List of paths to add, relative to the base of the tree.
415
If set, use these instead of automatically generated ids.
416
Must be the same length as the list of files, but may
417
contain None for ids that are to be autogenerated.
419
TODO: Perhaps have an option to add the ids even if the files do
422
TODO: Perhaps return the ids of the files? But then again it
423
is easy to retrieve them if they're needed.
425
TODO: Adding a directory should optionally recurse down and
426
add all non-ignored children. Perhaps do that in a
429
# TODO: Re-adding a file that is removed in the working copy
430
# should probably put it back with the previous ID.
431
if isinstance(files, basestring):
432
assert(ids is None or isinstance(ids, basestring))
438
ids = [None] * len(files)
440
assert(len(ids) == len(files))
444
inv = self.read_working_inventory()
445
for f,file_id in zip(files, ids):
446
if is_control_file(f):
447
raise BzrError("cannot add control file %s" % quotefn(f))
452
raise BzrError("cannot add top-level %r" % f)
454
fullpath = os.path.normpath(self.abspath(f))
457
kind = file_kind(fullpath)
459
# maybe something better?
460
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
462
if kind != 'file' and kind != 'directory':
463
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
466
file_id = gen_file_id(f)
467
inv.add_path(f, kind=kind, file_id=file_id)
470
print 'added', quotefn(f)
472
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
474
self._write_inventory(inv)
479
def print_file(self, file, revno):
480
"""Print `file` to stdout."""
483
tree = self.revision_tree(self.lookup_revision(revno))
484
# use inventory as it was in that revision
485
file_id = tree.inventory.path2id(file)
487
raise BzrError("%r is not present in revision %s" % (file, revno))
488
tree.print_file(file_id)
493
def remove(self, files, verbose=False):
494
"""Mark nominated files for removal from the inventory.
496
This does not remove their text. This does not run on
498
TODO: Refuse to remove modified files unless --force is given?
500
TODO: Do something useful with directories.
502
TODO: Should this remove the text or not? Tough call; not
503
removing may be useful and the user can just use use rm, and
504
is the opposite of add. Removing it is consistent with most
505
other tools. Maybe an option.
507
## TODO: Normalize names
508
## TODO: Remove nested loops; better scalability
509
if isinstance(files, basestring):
515
tree = self.working_tree()
518
# do this before any modifications
522
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
523
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
525
# having remove it, it must be either ignored or unknown
526
if tree.is_ignored(f):
530
show_status(new_status, inv[fid].kind, quotefn(f))
533
self._write_inventory(inv)
538
# FIXME: this doesn't need to be a branch method
539
def set_inventory(self, new_inventory_list):
540
from bzrlib.inventory import Inventory, InventoryEntry
541
inv = Inventory(self.get_root_id())
542
for path, file_id, parent, kind in new_inventory_list:
543
name = os.path.basename(path)
546
inv.add(InventoryEntry(file_id, name, kind, parent))
547
self._write_inventory(inv)
551
"""Return all unknown files.
553
These are files in the working directory that are not versioned or
554
control files or ignored.
556
>>> b = ScratchBranch(files=['foo', 'foo~'])
557
>>> list(b.unknowns())
560
>>> list(b.unknowns())
563
>>> list(b.unknowns())
566
return self.working_tree().unknowns()
569
def append_revision(self, *revision_ids):
570
from bzrlib.atomicfile import AtomicFile
572
for revision_id in revision_ids:
573
mutter("add {%s} to revision-history" % revision_id)
575
rev_history = self.revision_history()
576
rev_history.extend(revision_ids)
578
f = AtomicFile(self.controlfilename('revision-history'))
580
for rev_id in rev_history:
587
def get_revision_xml(self, revision_id):
588
"""Return XML file object for revision object."""
589
if not revision_id or not isinstance(revision_id, basestring):
590
raise InvalidRevisionId(revision_id)
595
return self.revision_store[revision_id]
597
raise bzrlib.errors.NoSuchRevision(revision_id)
602
def get_revision(self, revision_id):
603
"""Return the Revision object for a named revision"""
604
xml_file = self.get_revision_xml(revision_id)
607
r = unpack_xml(Revision, xml_file)
608
except SyntaxError, e:
609
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
613
assert r.revision_id == revision_id
296
raise NotImplementedError(self.unlock)
298
def peek_lock_mode(self):
299
"""Return lock mode for the Branch: 'r', 'w' or None"""
300
raise NotImplementedError(self.peek_lock_mode)
302
def get_physical_lock_status(self):
303
raise NotImplementedError(self.get_physical_lock_status)
306
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
307
"""Return the revision_id for a dotted revno.
309
:param revno: a tuple like (1,) or (1,1,2)
310
:param _cache_reverse: a private parameter enabling storage
311
of the reverse mapping in a top level cache. (This should
312
only be done in selective circumstances as we want to
313
avoid having the mapping cached multiple times.)
314
:return: the revision_id
315
:raises errors.NoSuchRevision: if the revno doesn't exist
317
rev_id = self._do_dotted_revno_to_revision_id(revno)
319
self._partial_revision_id_to_revno_cache[rev_id] = revno
322
def _do_dotted_revno_to_revision_id(self, revno):
323
"""Worker function for dotted_revno_to_revision_id.
325
Subclasses should override this if they wish to
326
provide a more efficient implementation.
329
return self.get_rev_id(revno[0])
330
revision_id_to_revno = self.get_revision_id_to_revno_map()
331
revision_ids = [revision_id for revision_id, this_revno
332
in revision_id_to_revno.iteritems()
333
if revno == this_revno]
334
if len(revision_ids) == 1:
335
return revision_ids[0]
337
revno_str = '.'.join(map(str, revno))
338
raise errors.NoSuchRevision(self, revno_str)
341
def revision_id_to_dotted_revno(self, revision_id):
342
"""Given a revision id, return its dotted revno.
344
:return: a tuple like (1,) or (400,1,3).
346
return self._do_revision_id_to_dotted_revno(revision_id)
348
def _do_revision_id_to_dotted_revno(self, revision_id):
349
"""Worker function for revision_id_to_revno."""
350
# Try the caches if they are loaded
351
result = self._partial_revision_id_to_revno_cache.get(revision_id)
352
if result is not None:
354
if self._revision_id_to_revno_cache:
355
result = self._revision_id_to_revno_cache.get(revision_id)
357
raise errors.NoSuchRevision(self, revision_id)
358
# Try the mainline as it's optimised
360
revno = self.revision_id_to_revno(revision_id)
362
except errors.NoSuchRevision:
363
# We need to load and use the full revno map after all
364
result = self.get_revision_id_to_revno_map().get(revision_id)
366
raise errors.NoSuchRevision(self, revision_id)
370
def get_revision_id_to_revno_map(self):
371
"""Return the revision_id => dotted revno map.
373
This will be regenerated on demand, but will be cached.
375
:return: A dictionary mapping revision_id => dotted revno.
376
This dictionary should not be modified by the caller.
378
if self._revision_id_to_revno_cache is not None:
379
mapping = self._revision_id_to_revno_cache
381
mapping = self._gen_revno_map()
382
self._cache_revision_id_to_revno(mapping)
383
# TODO: jam 20070417 Since this is being cached, should we be returning
385
# I would rather not, and instead just declare that users should not
386
# modify the return value.
389
def _gen_revno_map(self):
390
"""Create a new mapping from revision ids to dotted revnos.
392
Dotted revnos are generated based on the current tip in the revision
394
This is the worker function for get_revision_id_to_revno_map, which
395
just caches the return value.
397
:return: A dictionary mapping revision_id => dotted revno.
399
revision_id_to_revno = dict((rev_id, revno)
400
for rev_id, depth, revno, end_of_merge
401
in self.iter_merge_sorted_revisions())
402
return revision_id_to_revno
405
def iter_merge_sorted_revisions(self, start_revision_id=None,
406
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
407
"""Walk the revisions for a branch in merge sorted order.
409
Merge sorted order is the output from a merge-aware,
410
topological sort, i.e. all parents come before their
411
children going forward; the opposite for reverse.
413
:param start_revision_id: the revision_id to begin walking from.
414
If None, the branch tip is used.
415
:param stop_revision_id: the revision_id to terminate the walk
416
after. If None, the rest of history is included.
417
:param stop_rule: if stop_revision_id is not None, the precise rule
418
to use for termination:
419
* 'exclude' - leave the stop revision out of the result (default)
420
* 'include' - the stop revision is the last item in the result
421
* 'with-merges' - include the stop revision and all of its
422
merged revisions in the result
423
:param direction: either 'reverse' or 'forward':
424
* reverse means return the start_revision_id first, i.e.
425
start at the most recent revision and go backwards in history
426
* forward returns tuples in the opposite order to reverse.
427
Note in particular that forward does *not* do any intelligent
428
ordering w.r.t. depth as some clients of this API may like.
429
(If required, that ought to be done at higher layers.)
431
:return: an iterator over (revision_id, depth, revno, end_of_merge)
434
* revision_id: the unique id of the revision
435
* depth: How many levels of merging deep this node has been
437
* revno_sequence: This field provides a sequence of
438
revision numbers for all revisions. The format is:
439
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
440
branch that the revno is on. From left to right the REVNO numbers
441
are the sequence numbers within that branch of the revision.
442
* end_of_merge: When True the next node (earlier in history) is
443
part of a different merge.
445
# Note: depth and revno values are in the context of the branch so
446
# we need the full graph to get stable numbers, regardless of the
448
if self._merge_sorted_revisions_cache is None:
449
last_revision = self.last_revision()
450
last_key = (last_revision,)
451
known_graph = self.repository.revisions.get_known_graph_ancestry(
453
self._merge_sorted_revisions_cache = known_graph.merge_sort(
455
filtered = self._filter_merge_sorted_revisions(
456
self._merge_sorted_revisions_cache, start_revision_id,
457
stop_revision_id, stop_rule)
458
if direction == 'reverse':
460
if direction == 'forward':
461
return reversed(list(filtered))
463
raise ValueError('invalid direction %r' % direction)
465
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
466
start_revision_id, stop_revision_id, stop_rule):
467
"""Iterate over an inclusive range of sorted revisions."""
468
rev_iter = iter(merge_sorted_revisions)
469
if start_revision_id is not None:
470
for node in rev_iter:
471
rev_id = node.key[-1]
472
if rev_id != start_revision_id:
475
# The decision to include the start or not
476
# depends on the stop_rule if a stop is provided
477
# so pop this node back into the iterator
478
rev_iter = chain(iter([node]), rev_iter)
480
if stop_revision_id is None:
482
for node in rev_iter:
483
rev_id = node.key[-1]
484
yield (rev_id, node.merge_depth, node.revno,
486
elif stop_rule == 'exclude':
487
for node in rev_iter:
488
rev_id = node.key[-1]
489
if rev_id == stop_revision_id:
491
yield (rev_id, node.merge_depth, node.revno,
493
elif stop_rule == 'include':
494
for node in rev_iter:
495
rev_id = node.key[-1]
496
yield (rev_id, node.merge_depth, node.revno,
498
if rev_id == stop_revision_id:
500
elif stop_rule == 'with-merges':
501
stop_rev = self.repository.get_revision(stop_revision_id)
502
if stop_rev.parent_ids:
503
left_parent = stop_rev.parent_ids[0]
505
left_parent = _mod_revision.NULL_REVISION
506
# left_parent is the actual revision we want to stop logging at,
507
# since we want to show the merged revisions after the stop_rev too
508
reached_stop_revision_id = False
509
revision_id_whitelist = []
510
for node in rev_iter:
511
rev_id = node.key[-1]
512
if rev_id == left_parent:
513
# reached the left parent after the stop_revision
515
if (not reached_stop_revision_id or
516
rev_id in revision_id_whitelist):
517
yield (rev_id, node.merge_depth, node.revno,
519
if reached_stop_revision_id or rev_id == stop_revision_id:
520
# only do the merged revs of rev_id from now on
521
rev = self.repository.get_revision(rev_id)
523
reached_stop_revision_id = True
524
revision_id_whitelist.extend(rev.parent_ids)
526
raise ValueError('invalid stop_rule %r' % stop_rule)
528
def leave_lock_in_place(self):
529
"""Tell this branch object not to release the physical lock when this
532
If lock_write doesn't return a token, then this method is not supported.
534
self.control_files.leave_in_place()
536
def dont_leave_lock_in_place(self):
537
"""Tell this branch object to release the physical lock when this
538
object is unlocked, even if it didn't originally acquire it.
540
If lock_write doesn't return a token, then this method is not supported.
542
self.control_files.dont_leave_in_place()
544
def bind(self, other):
545
"""Bind the local branch the other branch.
547
:param other: The branch to bind to
550
raise errors.UpgradeRequired(self.base)
552
def set_append_revisions_only(self, enabled):
553
if not self._format.supports_set_append_revisions_only():
554
raise errors.UpgradeRequired(self.base)
559
self.get_config().set_user_option('append_revisions_only', value,
562
def set_reference_info(self, file_id, tree_path, branch_location):
563
"""Set the branch location to use for a tree reference."""
564
raise errors.UnsupportedOperation(self.set_reference_info, self)
566
def get_reference_info(self, file_id):
567
"""Get the tree_path and branch_location for a tree reference."""
568
raise errors.UnsupportedOperation(self.get_reference_info, self)
571
def fetch(self, from_branch, last_revision=None, pb=None):
572
"""Copy revisions from from_branch into this branch.
574
:param from_branch: Where to copy from.
575
:param last_revision: What revision to stop at (None for at the end
577
:param pb: An optional progress bar to use.
580
if self.base == from_branch.base:
583
symbol_versioning.warn(
584
symbol_versioning.deprecated_in((1, 14, 0))
585
% "pb parameter to fetch()")
586
from_branch.lock_read()
588
if last_revision is None:
589
last_revision = from_branch.last_revision()
590
last_revision = _mod_revision.ensure_null(last_revision)
591
return self.repository.fetch(from_branch.repository,
592
revision_id=last_revision,
597
def get_bound_location(self):
598
"""Return the URL of the branch we are bound to.
600
Older format branches cannot bind, please be sure to use a metadir
605
def get_old_bound_location(self):
606
"""Return the URL of the branch we used to be bound to
608
raise errors.UpgradeRequired(self.base)
610
def get_commit_builder(self, parents, config=None, timestamp=None,
611
timezone=None, committer=None, revprops=None,
613
"""Obtain a CommitBuilder for this branch.
615
:param parents: Revision ids of the parents of the new revision.
616
:param config: Optional configuration to use.
617
:param timestamp: Optional timestamp recorded for commit.
618
:param timezone: Optional timezone for timestamp.
619
:param committer: Optional committer to set for commit.
620
:param revprops: Optional dictionary of revision properties.
621
:param revision_id: Optional revision id.
625
config = self.get_config()
627
return self.repository.get_commit_builder(self, parents, config,
628
timestamp, timezone, committer, revprops, revision_id)
630
def get_master_branch(self, possible_transports=None):
631
"""Return the branch we are bound to.
633
:return: Either a Branch, or None
617
637
def get_revision_delta(self, revno):
618
638
"""Return the delta for one revision.
789
884
common_index = min(self_len, other_len) -1
790
885
if common_index >= 0 and \
791
886
self_history[common_index] != other_history[common_index]:
792
raise DivergedBranches(self, other)
887
raise errors.DivergedBranches(self, other)
794
889
if stop_revision is None:
795
890
stop_revision = other_len
796
elif stop_revision > other_len:
797
raise NoSuchRevision(self, stop_revision)
892
if stop_revision > other_len:
893
raise errors.NoSuchRevision(self, stop_revision)
799
894
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)
897
def update_revisions(self, other, stop_revision=None, overwrite=False,
899
"""Pull in new perfect-fit revisions.
901
:param other: Another Branch to pull from
902
:param stop_revision: Updated until the given revision
903
:param overwrite: Always set the branch pointer, rather than checking
904
to see if it is a proper descendant.
905
:param graph: A Graph object that can be used to query history
906
information. This can be None.
909
return InterBranch.get(other, self).update_revisions(stop_revision,
912
def import_last_revision_info(self, source_repo, revno, revid):
913
"""Set the last revision info, importing from another repo if necessary.
915
This is used by the bound branch code to upload a revision to
916
the master branch first before updating the tip of the local branch.
918
:param source_repo: Source repository to optionally fetch from
919
:param revno: Revision number of the new tip
920
:param revid: Revision id of the new tip
922
if not self.repository.has_same_location(source_repo):
923
self.repository.fetch(source_repo, revision_id=revid)
924
self.set_last_revision_info(revno, revid)
926
def revision_id_to_revno(self, revision_id):
927
"""Given a revision id, return its revno"""
928
if _mod_revision.is_null(revision_id):
930
history = self.revision_history()
932
return history.index(revision_id) + 1
893
933
except ValueError:
934
raise errors.NoSuchRevision(self, revision_id)
937
def get_rev_id(self, revno, history=None):
938
"""Find the revision id of the specified revno."""
940
return _mod_revision.NULL_REVISION
941
last_revno, last_revid = self.last_revision_info()
942
if revno == last_revno:
944
if revno <= 0 or revno > last_revno:
945
raise errors.NoSuchRevision(self, revno)
946
distance_from_last = last_revno - revno
947
if len(self._partial_revision_history_cache) <= distance_from_last:
948
self._extend_partial_history(distance_from_last)
949
return self._partial_revision_history_cache[distance_from_last]
952
def pull(self, source, overwrite=False, stop_revision=None,
953
possible_transports=None, *args, **kwargs):
954
"""Mirror source into this branch.
956
This branch is considered to be 'local', having low latency.
958
:returns: PullResult instance
960
return InterBranch.get(source, self).pull(overwrite=overwrite,
961
stop_revision=stop_revision,
962
possible_transports=possible_transports, *args, **kwargs)
964
def push(self, target, overwrite=False, stop_revision=None, *args,
966
"""Mirror this branch into target.
968
This branch is considered to be 'local', having low latency.
970
return InterBranch.get(self, target).push(overwrite, stop_revision,
973
def lossy_push(self, target, stop_revision=None):
974
"""Push deltas into another branch.
976
:note: This does not, like push, retain the revision ids from
977
the source branch and will, rather than adding bzr-specific
978
metadata, push only those semantics of the revision that can be
979
natively represented by this branch' VCS.
981
:param target: Target branch
982
:param stop_revision: Revision to push, defaults to last revision.
983
:return: BranchPushResult with an extra member revidmap:
984
A dictionary mapping revision ids from the target branch
985
to new revision ids in the target branch, for each
986
revision that was pushed.
988
inter = InterBranch.get(self, target)
989
lossy_push = getattr(inter, "lossy_push", None)
990
if lossy_push is None:
991
raise errors.LossyPushToSameVCS(self, target)
992
return lossy_push(stop_revision)
994
def basis_tree(self):
995
"""Return `Tree` object for last revision."""
996
return self.repository.revision_tree(self.last_revision())
998
def get_parent(self):
999
"""Return the parent location of the branch.
1001
This is the default location for pull/missing. The usual
1002
pattern is that the user can override it by specifying a
1005
parent = self._get_parent_location()
1008
# This is an old-format absolute path to a local branch
1009
# turn it into a url
1010
if parent.startswith('/'):
1011
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1013
return urlutils.join(self.base[:-1], parent)
1014
except errors.InvalidURLJoin, e:
1015
raise errors.InaccessibleParent(parent, self.base)
1017
def _get_parent_location(self):
1018
raise NotImplementedError(self._get_parent_location)
1020
def _set_config_location(self, name, url, config=None,
1021
make_relative=False):
1023
config = self.get_config()
1027
url = urlutils.relative_url(self.base, url)
1028
config.set_user_option(name, url, warn_masked=True)
1030
def _get_config_location(self, name, config=None):
1032
config = self.get_config()
1033
location = config.get_user_option(name)
1038
def get_child_submit_format(self):
1039
"""Return the preferred format of submissions to this branch."""
1040
return self.get_config().get_user_option("child_submit_format")
1042
def get_submit_branch(self):
1043
"""Return the submit location of the branch.
1045
This is the default location for bundle. The usual
1046
pattern is that the user can override it by specifying a
1049
return self.get_config().get_user_option('submit_branch')
1051
def set_submit_branch(self, location):
1052
"""Return the submit location of the branch.
1054
This is the default location for bundle. The usual
1055
pattern is that the user can override it by specifying a
1058
self.get_config().set_user_option('submit_branch', location,
1061
def get_public_branch(self):
1062
"""Return the public location of the branch.
1064
This is used by merge directives.
1066
return self._get_config_location('public_branch')
1068
def set_public_branch(self, location):
1069
"""Return the submit location of the branch.
1071
This is the default location for bundle. The usual
1072
pattern is that the user can override it by specifying a
1075
self._set_config_location('public_branch', location)
1077
def get_push_location(self):
1078
"""Return the None or the location to push this branch to."""
1079
push_loc = self.get_config().get_user_option('push_location')
1082
def set_push_location(self, location):
1083
"""Set a new push location for this branch."""
1084
raise NotImplementedError(self.set_push_location)
1086
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1087
"""Run the post_change_branch_tip hooks."""
1088
hooks = Branch.hooks['post_change_branch_tip']
1091
new_revno, new_revid = self.last_revision_info()
1092
params = ChangeBranchTipParams(
1093
self, old_revno, new_revno, old_revid, new_revid)
1097
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
1098
"""Run the pre_change_branch_tip hooks."""
1099
hooks = Branch.hooks['pre_change_branch_tip']
1102
old_revno, old_revid = self.last_revision_info()
1103
params = ChangeBranchTipParams(
1104
self, old_revno, new_revno, old_revid, new_revid)
1110
"""Synchronise this branch with the master branch if any.
1112
:return: None or the last_revision pivoted out during the update.
1116
def check_revno(self, revno):
1118
Check whether a revno corresponds to any revision.
1119
Zero (the NULL revision) is considered valid.
1122
self.check_real_revno(revno)
1124
def check_real_revno(self, revno):
1126
Check whether a revno corresponds to a real revision.
1127
Zero (the NULL revision) is considered invalid
1129
if revno < 1 or revno > self.revno():
1130
raise errors.InvalidRevisionNumber(revno)
1133
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
1134
"""Clone this branch into to_bzrdir preserving all semantic values.
1136
Most API users will want 'create_clone_on_transport', which creates a
1137
new bzrdir and branch on the fly.
1139
revision_id: if not None, the revision history in the new branch will
1140
be truncated to end with revision_id.
1142
result = to_bzrdir.create_branch()
1145
if repository_policy is not None:
1146
repository_policy.configure_branch(result)
1147
self.copy_content_into(result, revision_id=revision_id)
1153
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
1154
"""Create a new line of development from the branch, into to_bzrdir.
1156
to_bzrdir controls the branch format.
1158
revision_id: if not None, the revision history in the new branch will
1159
be truncated to end with revision_id.
1161
if (repository_policy is not None and
1162
repository_policy.requires_stacking()):
1163
to_bzrdir._format.require_stacking(_skip_repo=True)
1164
result = to_bzrdir.create_branch()
1167
if repository_policy is not None:
1168
repository_policy.configure_branch(result)
1169
self.copy_content_into(result, revision_id=revision_id)
1170
result.set_parent(self.bzrdir.root_transport.base)
1175
def _synchronize_history(self, destination, revision_id):
1176
"""Synchronize last revision and revision history between branches.
1178
This version is most efficient when the destination is also a
1179
BzrBranch6, but works for BzrBranch5, as long as the destination's
1180
repository contains all the lefthand ancestors of the intended
1181
last_revision. If not, set_last_revision_info will fail.
1183
:param destination: The branch to copy the history into
1184
:param revision_id: The revision-id to truncate history at. May
1185
be None to copy complete history.
1187
source_revno, source_revision_id = self.last_revision_info()
1188
if revision_id is None:
1189
revno, revision_id = source_revno, source_revision_id
1191
graph = self.repository.get_graph()
1193
revno = graph.find_distance_to_null(revision_id,
1194
[(source_revision_id, source_revno)])
1195
except errors.GhostRevisionsHaveNoRevno:
1196
# Default to 1, if we can't find anything else
1198
destination.set_last_revision_info(revno, revision_id)
1201
def copy_content_into(self, destination, revision_id=None):
1202
"""Copy the content of self into destination.
1204
revision_id: if not None, the revision history in the new branch will
1205
be truncated to end with revision_id.
1207
self.update_references(destination)
1208
self._synchronize_history(destination, revision_id)
1210
parent = self.get_parent()
1211
except errors.InaccessibleParent, e:
1212
mutter('parent was not accessible to copy: %s', e)
1215
destination.set_parent(parent)
1216
if self._push_should_merge_tags():
1217
self.tags.merge_to(destination.tags)
1219
def update_references(self, target):
1220
if not getattr(self._format, 'supports_reference_locations', False):
1222
reference_dict = self._get_all_reference_info()
1223
if len(reference_dict) == 0:
1225
old_base = self.base
1226
new_base = target.base
1227
target_reference_dict = target._get_all_reference_info()
1228
for file_id, (tree_path, branch_location) in (
1229
reference_dict.items()):
1230
branch_location = urlutils.rebase_url(branch_location,
1232
target_reference_dict.setdefault(
1233
file_id, (tree_path, branch_location))
1234
target._set_all_reference_info(target_reference_dict)
1237
def check(self, refs):
1238
"""Check consistency of the branch.
1240
In particular this checks that revisions given in the revision-history
1241
do actually match up in the revision graph, and that they're all
1242
present in the repository.
1244
Callers will typically also want to check the repository.
1246
:param refs: Calculated refs for this branch as specified by
1247
branch._get_check_refs()
1248
:return: A BranchCheckResult.
1250
result = BranchCheckResult(self)
1251
last_revno, last_revision_id = self.last_revision_info()
1252
actual_revno = refs[('lefthand-distance', last_revision_id)]
1253
if actual_revno != last_revno:
1254
result.errors.append(errors.BzrCheckError(
1255
'revno does not match len(mainline) %s != %s' % (
1256
last_revno, actual_revno)))
1257
# TODO: We should probably also check that self.revision_history
1258
# matches the repository for older branch formats.
1259
# If looking for the code that cross-checks repository parents against
1260
# the iter_reverse_revision_history output, that is now a repository
1264
def _get_checkout_format(self):
1265
"""Return the most suitable metadir for a checkout of this branch.
1266
Weaves are used if this branch's repository uses weaves.
1268
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1269
from bzrlib.repofmt import weaverepo
1270
format = bzrdir.BzrDirMetaFormat1()
1271
format.repository_format = weaverepo.RepositoryFormat7()
1273
format = self.repository.bzrdir.checkout_metadir()
1274
format.set_branch_format(self._format)
1277
def create_clone_on_transport(self, to_transport, revision_id=None,
1278
stacked_on=None, create_prefix=False, use_existing_dir=False):
1279
"""Create a clone of this branch and its bzrdir.
1281
:param to_transport: The transport to clone onto.
1282
:param revision_id: The revision id to use as tip in the new branch.
1283
If None the tip is obtained from this branch.
1284
:param stacked_on: An optional URL to stack the clone on.
1285
:param create_prefix: Create any missing directories leading up to
1287
:param use_existing_dir: Use an existing directory if one exists.
1289
# XXX: Fix the bzrdir API to allow getting the branch back from the
1290
# clone call. Or something. 20090224 RBC/spiv.
1291
if revision_id is None:
1292
revision_id = self.last_revision()
1293
dir_to = self.bzrdir.clone_on_transport(to_transport,
1294
revision_id=revision_id, stacked_on=stacked_on,
1295
create_prefix=create_prefix, use_existing_dir=use_existing_dir)
1296
return dir_to.open_branch()
1298
def create_checkout(self, to_location, revision_id=None,
1299
lightweight=False, accelerator_tree=None,
1301
"""Create a checkout of a branch.
1303
:param to_location: The url to produce the checkout at
1304
:param revision_id: The revision to check out
1305
:param lightweight: If True, produce a lightweight checkout, otherwise,
1306
produce a bound branch (heavyweight checkout)
1307
:param accelerator_tree: A tree which can be used for retrieving file
1308
contents more quickly than the revision tree, i.e. a workingtree.
1309
The revision tree will be used for cases where accelerator_tree's
1310
content is different.
1311
:param hardlink: If true, hard-link files from accelerator_tree,
1313
:return: The tree of the created checkout
1315
t = transport.get_transport(to_location)
1318
format = self._get_checkout_format()
1319
checkout = format.initialize_on_transport(t)
1320
from_branch = BranchReferenceFormat().initialize(checkout,
1323
format = self._get_checkout_format()
1324
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1325
to_location, force_new_tree=False, format=format)
1326
checkout = checkout_branch.bzrdir
1327
checkout_branch.bind(self)
1328
# pull up to the specified revision_id to set the initial
1329
# branch tip correctly, and seed it with history.
1330
checkout_branch.pull(self, stop_revision=revision_id)
1332
tree = checkout.create_workingtree(revision_id,
1333
from_branch=from_branch,
1334
accelerator_tree=accelerator_tree,
1336
basis_tree = tree.basis_tree()
1337
basis_tree.lock_read()
1339
for path, file_id in basis_tree.iter_references():
1340
reference_parent = self.reference_parent(file_id, path)
1341
reference_parent.create_checkout(tree.abspath(path),
1342
basis_tree.get_reference_revision(file_id, path),
1349
def reconcile(self, thorough=True):
1350
"""Make sure the data stored in this branch is consistent."""
1351
from bzrlib.reconcile import BranchReconciler
1352
reconciler = BranchReconciler(self, thorough=thorough)
1353
reconciler.reconcile()
1356
def reference_parent(self, file_id, path, possible_transports=None):
1357
"""Return the parent branch for a tree-reference file_id
1358
:param file_id: The file_id of the tree reference
1359
:param path: The path of the file_id in the tree
1360
:return: A branch associated with the file_id
1362
# FIXME should provide multiple branches, based on config
1363
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1364
possible_transports=possible_transports)
1366
def supports_tags(self):
1367
return self._format.supports_tags()
1369
def automatic_tag_name(self, revision_id):
1370
"""Try to automatically find the tag name for a revision.
1372
:param revision_id: Revision id of the revision.
1373
:return: A tag name or None if no tag name could be determined.
1375
for hook in Branch.hooks['automatic_tag_name']:
1376
ret = hook(self, revision_id)
1381
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1383
"""Ensure that revision_b is a descendant of revision_a.
1385
This is a helper function for update_revisions.
1387
:raises: DivergedBranches if revision_b has diverged from revision_a.
1388
:returns: True if revision_b is a descendant of revision_a.
1390
relation = self._revision_relations(revision_a, revision_b, graph)
1391
if relation == 'b_descends_from_a':
1393
elif relation == 'diverged':
1394
raise errors.DivergedBranches(self, other_branch)
1395
elif relation == 'a_descends_from_b':
1398
raise AssertionError("invalid relation: %r" % (relation,))
1400
def _revision_relations(self, revision_a, revision_b, graph):
1401
"""Determine the relationship between two revisions.
1403
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1405
heads = graph.heads([revision_a, revision_b])
1406
if heads == set([revision_b]):
1407
return 'b_descends_from_a'
1408
elif heads == set([revision_a, revision_b]):
1409
# These branches have diverged
1411
elif heads == set([revision_a]):
1412
return 'a_descends_from_b'
1414
raise AssertionError("invalid heads: %r" % (heads,))
1417
class BranchFormat(object):
1418
"""An encapsulation of the initialization and open routines for a format.
1420
Formats provide three things:
1421
* An initialization routine,
1425
Formats are placed in an dict by their format string for reference
1426
during branch opening. Its not required that these be instances, they
1427
can be classes themselves with class methods - it simply depends on
1428
whether state is needed for a given format or not.
1430
Once a format is deprecated, just deprecate the initialize and open
1431
methods on the format class. Do not deprecate the object, as the
1432
object will be created every time regardless.
1435
_default_format = None
1436
"""The default format used for new branches."""
1439
"""The known formats."""
1441
can_set_append_revisions_only = True
1443
def __eq__(self, other):
1444
return self.__class__ is other.__class__
1446
def __ne__(self, other):
1447
return not (self == other)
1450
def find_format(klass, a_bzrdir, name=None):
1451
"""Return the format for the branch object in a_bzrdir."""
1453
transport = a_bzrdir.get_branch_transport(None, name=name)
1454
format_string = transport.get_bytes("format")
1455
return klass._formats[format_string]
1456
except errors.NoSuchFile:
1457
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1459
raise errors.UnknownFormatError(format=format_string, kind='branch')
1462
def get_default_format(klass):
1463
"""Return the current default format."""
1464
return klass._default_format
1466
def get_reference(self, a_bzrdir):
1467
"""Get the target reference of the branch in a_bzrdir.
1469
format probing must have been completed before calling
1470
this method - it is assumed that the format of the branch
1471
in a_bzrdir is correct.
1473
:param a_bzrdir: The bzrdir to get the branch data from.
1474
:return: None if the branch is not a reference branch.
1479
def set_reference(self, a_bzrdir, to_branch):
1480
"""Set the target reference of the branch in a_bzrdir.
1482
format probing must have been completed before calling
1483
this method - it is assumed that the format of the branch
1484
in a_bzrdir is correct.
1486
:param a_bzrdir: The bzrdir to set the branch reference for.
1487
:param to_branch: branch that the checkout is to reference
1489
raise NotImplementedError(self.set_reference)
1491
def get_format_string(self):
1492
"""Return the ASCII format string that identifies this format."""
1493
raise NotImplementedError(self.get_format_string)
1495
def get_format_description(self):
1496
"""Return the short format description for this format."""
1497
raise NotImplementedError(self.get_format_description)
1499
def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1500
lock_type='metadir', set_format=True):
1501
"""Initialize a branch in a bzrdir, with specified files
1503
:param a_bzrdir: The bzrdir to initialize the branch in
1504
:param utf8_files: The files to create as a list of
1505
(filename, content) tuples
1506
:param name: Name of colocated branch to create, if any
1507
:param set_format: If True, set the format with
1508
self.get_format_string. (BzrBranch4 has its format set
1510
:return: a branch in this format
1512
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1513
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1515
'metadir': ('lock', lockdir.LockDir),
1516
'branch4': ('branch-lock', lockable_files.TransportLock),
1518
lock_name, lock_class = lock_map[lock_type]
1519
control_files = lockable_files.LockableFiles(branch_transport,
1520
lock_name, lock_class)
1521
control_files.create_lock()
1523
control_files.lock_write()
1524
except errors.LockContention:
1525
if lock_type != 'branch4':
1531
utf8_files += [('format', self.get_format_string())]
1533
for (filename, content) in utf8_files:
1534
branch_transport.put_bytes(
1536
mode=a_bzrdir._get_file_mode())
1539
control_files.unlock()
1540
return self.open(a_bzrdir, name, _found=True)
1542
def initialize(self, a_bzrdir, name=None):
1543
"""Create a branch of this format in a_bzrdir.
1545
:param name: Name of the colocated branch to create.
1547
raise NotImplementedError(self.initialize)
1549
def is_supported(self):
1550
"""Is this format supported?
1552
Supported formats can be initialized and opened.
1553
Unsupported formats may not support initialization or committing or
1554
some other features depending on the reason for not being supported.
1558
def make_tags(self, branch):
1559
"""Create a tags object for branch.
1561
This method is on BranchFormat, because BranchFormats are reflected
1562
over the wire via network_name(), whereas full Branch instances require
1563
multiple VFS method calls to operate at all.
1565
The default implementation returns a disabled-tags instance.
1567
Note that it is normal for branch to be a RemoteBranch when using tags
1570
return DisabledTags(branch)
1572
def network_name(self):
1573
"""A simple byte string uniquely identifying this format for RPC calls.
1575
MetaDir branch formats use their disk format string to identify the
1576
repository over the wire. All in one formats such as bzr < 0.8, and
1577
foreign formats like svn/git and hg should use some marker which is
1578
unique and immutable.
1580
raise NotImplementedError(self.network_name)
1582
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1583
"""Return the branch object for a_bzrdir
1585
:param a_bzrdir: A BzrDir that contains a branch.
1586
:param name: Name of colocated branch to open
1587
:param _found: a private parameter, do not use it. It is used to
1588
indicate if format probing has already be done.
1589
:param ignore_fallbacks: when set, no fallback branches will be opened
1590
(if there are any). Default is to open fallbacks.
1592
raise NotImplementedError(self.open)
1595
def register_format(klass, format):
1596
"""Register a metadir format."""
1597
klass._formats[format.get_format_string()] = format
1598
# Metadir formats have a network name of their format string, and get
1599
# registered as class factories.
1600
network_format_registry.register(format.get_format_string(), format.__class__)
1603
def set_default_format(klass, format):
1604
klass._default_format = format
1606
def supports_set_append_revisions_only(self):
1607
"""True if this format supports set_append_revisions_only."""
1610
def supports_stacking(self):
1611
"""True if this format records a stacked-on branch."""
1615
def unregister_format(klass, format):
1616
del klass._formats[format.get_format_string()]
1619
return self.get_format_description().rstrip()
1621
def supports_tags(self):
1622
"""True if this format supports tags stored in the branch"""
1623
return False # by default
1626
class BranchHooks(Hooks):
1627
"""A dictionary mapping hook name to a list of callables for branch hooks.
1629
e.g. ['set_rh'] Is the list of items to be called when the
1630
set_revision_history function is invoked.
1634
"""Create the default hooks.
1636
These are all empty initially, because by default nothing should get
1639
Hooks.__init__(self)
1640
self.create_hook(HookPoint('set_rh',
1641
"Invoked whenever the revision history has been set via "
1642
"set_revision_history. The api signature is (branch, "
1643
"revision_history), and the branch will be write-locked. "
1644
"The set_rh hook can be expensive for bzr to trigger, a better "
1645
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1646
self.create_hook(HookPoint('open',
1647
"Called with the Branch object that has been opened after a "
1648
"branch is opened.", (1, 8), None))
1649
self.create_hook(HookPoint('post_push',
1650
"Called after a push operation completes. post_push is called "
1651
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1652
"bzr client.", (0, 15), None))
1653
self.create_hook(HookPoint('post_pull',
1654
"Called after a pull operation completes. post_pull is called "
1655
"with a bzrlib.branch.PullResult object and only runs in the "
1656
"bzr client.", (0, 15), None))
1657
self.create_hook(HookPoint('pre_commit',
1658
"Called after a commit is calculated but before it is is "
1659
"completed. pre_commit is called with (local, master, old_revno, "
1660
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1661
"). old_revid is NULL_REVISION for the first commit to a branch, "
1662
"tree_delta is a TreeDelta object describing changes from the "
1663
"basis revision. hooks MUST NOT modify this delta. "
1664
" future_tree is an in-memory tree obtained from "
1665
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1666
"tree.", (0,91), None))
1667
self.create_hook(HookPoint('post_commit',
1668
"Called in the bzr client after a commit has completed. "
1669
"post_commit is called with (local, master, old_revno, old_revid, "
1670
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1671
"commit to a branch.", (0, 15), None))
1672
self.create_hook(HookPoint('post_uncommit',
1673
"Called in the bzr client after an uncommit completes. "
1674
"post_uncommit is called with (local, master, old_revno, "
1675
"old_revid, new_revno, new_revid) where local is the local branch "
1676
"or None, master is the target branch, and an empty branch "
1677
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1678
self.create_hook(HookPoint('pre_change_branch_tip',
1679
"Called in bzr client and server before a change to the tip of a "
1680
"branch is made. pre_change_branch_tip is called with a "
1681
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1682
"commit, uncommit will all trigger this hook.", (1, 6), None))
1683
self.create_hook(HookPoint('post_change_branch_tip',
1684
"Called in bzr client and server after a change to the tip of a "
1685
"branch is made. post_change_branch_tip is called with a "
1686
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1687
"commit, uncommit will all trigger this hook.", (1, 4), None))
1688
self.create_hook(HookPoint('transform_fallback_location',
1689
"Called when a stacked branch is activating its fallback "
1690
"locations. transform_fallback_location is called with (branch, "
1691
"url), and should return a new url. Returning the same url "
1692
"allows it to be used as-is, returning a different one can be "
1693
"used to cause the branch to stack on a closer copy of that "
1694
"fallback_location. Note that the branch cannot have history "
1695
"accessing methods called on it during this hook because the "
1696
"fallback locations have not been activated. When there are "
1697
"multiple hooks installed for transform_fallback_location, "
1698
"all are called with the url returned from the previous hook."
1699
"The order is however undefined.", (1, 9), None))
1700
self.create_hook(HookPoint('automatic_tag_name',
1701
"Called to determine an automatic tag name for a revision."
1702
"automatic_tag_name is called with (branch, revision_id) and "
1703
"should return a tag name or None if no tag name could be "
1704
"determined. The first non-None tag name returned will be used.",
1709
# install the default hooks into the Branch class.
1710
Branch.hooks = BranchHooks()
1713
class ChangeBranchTipParams(object):
1714
"""Object holding parameters passed to *_change_branch_tip hooks.
1716
There are 5 fields that hooks may wish to access:
1718
:ivar branch: the branch being changed
1719
:ivar old_revno: revision number before the change
1720
:ivar new_revno: revision number after the change
1721
:ivar old_revid: revision id before the change
1722
:ivar new_revid: revision id after the change
1724
The revid fields are strings. The revno fields are integers.
1727
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1728
"""Create a group of ChangeBranchTip parameters.
1730
:param branch: The branch being changed.
1731
:param old_revno: Revision number before the change.
1732
:param new_revno: Revision number after the change.
1733
:param old_revid: Tip revision id before the change.
1734
:param new_revid: Tip revision id after the change.
1736
self.branch = branch
1737
self.old_revno = old_revno
1738
self.new_revno = new_revno
1739
self.old_revid = old_revid
1740
self.new_revid = new_revid
1742
def __eq__(self, other):
1743
return self.__dict__ == other.__dict__
1746
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1747
self.__class__.__name__, self.branch,
1748
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1751
class BzrBranchFormat4(BranchFormat):
1752
"""Bzr branch format 4.
1755
- a revision-history file.
1756
- a branch-lock lock file [ to be shared with the bzrdir ]
1759
def get_format_description(self):
1760
"""See BranchFormat.get_format_description()."""
1761
return "Branch format 4"
1763
def initialize(self, a_bzrdir, name=None):
1764
"""Create a branch of this format in a_bzrdir."""
1765
utf8_files = [('revision-history', ''),
1766
('branch-name', ''),
1768
return self._initialize_helper(a_bzrdir, utf8_files, name=name,
1769
lock_type='branch4', set_format=False)
1772
super(BzrBranchFormat4, self).__init__()
1773
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1775
def network_name(self):
1776
"""The network name for this format is the control dirs disk label."""
1777
return self._matchingbzrdir.get_format_string()
1779
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1780
"""See BranchFormat.open()."""
1782
# we are being called directly and must probe.
1783
raise NotImplementedError
1784
return BzrBranch(_format=self,
1785
_control_files=a_bzrdir._control_files,
1788
_repository=a_bzrdir.open_repository())
1791
return "Bazaar-NG branch format 4"
1794
class BranchFormatMetadir(BranchFormat):
1795
"""Common logic for meta-dir based branch formats."""
1797
def _branch_class(self):
1798
"""What class to instantiate on open calls."""
1799
raise NotImplementedError(self._branch_class)
1801
def network_name(self):
1802
"""A simple byte string uniquely identifying this format for RPC calls.
1804
Metadir branch formats use their format string.
1806
return self.get_format_string()
1808
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1809
"""See BranchFormat.open()."""
1811
format = BranchFormat.find_format(a_bzrdir, name=name)
1812
if format.__class__ != self.__class__:
1813
raise AssertionError("wrong format %r found for %r" %
1816
transport = a_bzrdir.get_branch_transport(None, name=name)
1817
control_files = lockable_files.LockableFiles(transport, 'lock',
1819
return self._branch_class()(_format=self,
1820
_control_files=control_files,
1823
_repository=a_bzrdir.find_repository(),
1824
ignore_fallbacks=ignore_fallbacks)
1825
except errors.NoSuchFile:
1826
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1829
super(BranchFormatMetadir, self).__init__()
1830
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1831
self._matchingbzrdir.set_branch_format(self)
1833
def supports_tags(self):
1837
class BzrBranchFormat5(BranchFormatMetadir):
1838
"""Bzr branch format 5.
1841
- a revision-history file.
1843
- a lock dir guarding the branch itself
1844
- all of this stored in a branch/ subdirectory
1845
- works with shared repositories.
1847
This format is new in bzr 0.8.
1850
def _branch_class(self):
1853
def get_format_string(self):
1854
"""See BranchFormat.get_format_string()."""
1855
return "Bazaar-NG branch format 5\n"
1857
def get_format_description(self):
1858
"""See BranchFormat.get_format_description()."""
1859
return "Branch format 5"
1861
def initialize(self, a_bzrdir, name=None):
1862
"""Create a branch of this format in a_bzrdir."""
1863
utf8_files = [('revision-history', ''),
1864
('branch-name', ''),
1866
return self._initialize_helper(a_bzrdir, utf8_files, name)
1868
def supports_tags(self):
1872
class BzrBranchFormat6(BranchFormatMetadir):
1873
"""Branch format with last-revision and tags.
1875
Unlike previous formats, this has no explicit revision history. Instead,
1876
this just stores the last-revision, and the left-hand history leading
1877
up to there is the history.
1879
This format was introduced in bzr 0.15
1880
and became the default in 0.91.
1883
def _branch_class(self):
1886
def get_format_string(self):
1887
"""See BranchFormat.get_format_string()."""
1888
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1890
def get_format_description(self):
1891
"""See BranchFormat.get_format_description()."""
1892
return "Branch format 6"
1894
def initialize(self, a_bzrdir, name=None):
1895
"""Create a branch of this format in a_bzrdir."""
1896
utf8_files = [('last-revision', '0 null:\n'),
1897
('branch.conf', ''),
1900
return self._initialize_helper(a_bzrdir, utf8_files, name)
1902
def make_tags(self, branch):
1903
"""See bzrlib.branch.BranchFormat.make_tags()."""
1904
return BasicTags(branch)
1906
def supports_set_append_revisions_only(self):
1910
class BzrBranchFormat8(BranchFormatMetadir):
1911
"""Metadir format supporting storing locations of subtree branches."""
1913
def _branch_class(self):
1916
def get_format_string(self):
1917
"""See BranchFormat.get_format_string()."""
1918
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
1920
def get_format_description(self):
1921
"""See BranchFormat.get_format_description()."""
1922
return "Branch format 8"
1924
def initialize(self, a_bzrdir, name=None):
1925
"""Create a branch of this format in a_bzrdir."""
1926
utf8_files = [('last-revision', '0 null:\n'),
1927
('branch.conf', ''),
1931
return self._initialize_helper(a_bzrdir, utf8_files, name)
1934
super(BzrBranchFormat8, self).__init__()
1935
self._matchingbzrdir.repository_format = \
1936
RepositoryFormatKnitPack5RichRoot()
1938
def make_tags(self, branch):
1939
"""See bzrlib.branch.BranchFormat.make_tags()."""
1940
return BasicTags(branch)
1942
def supports_set_append_revisions_only(self):
1945
def supports_stacking(self):
1948
supports_reference_locations = True
1951
class BzrBranchFormat7(BzrBranchFormat8):
1952
"""Branch format with last-revision, tags, and a stacked location pointer.
1954
The stacked location pointer is passed down to the repository and requires
1955
a repository format with supports_external_lookups = True.
1957
This format was introduced in bzr 1.6.
1960
def initialize(self, a_bzrdir, name=None):
1961
"""Create a branch of this format in a_bzrdir."""
1962
utf8_files = [('last-revision', '0 null:\n'),
1963
('branch.conf', ''),
1966
return self._initialize_helper(a_bzrdir, utf8_files, name)
1968
def _branch_class(self):
1971
def get_format_string(self):
1972
"""See BranchFormat.get_format_string()."""
1973
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
1975
def get_format_description(self):
1976
"""See BranchFormat.get_format_description()."""
1977
return "Branch format 7"
1979
def supports_set_append_revisions_only(self):
1982
supports_reference_locations = False
1985
class BranchReferenceFormat(BranchFormat):
1986
"""Bzr branch reference format.
1988
Branch references are used in implementing checkouts, they
1989
act as an alias to the real branch which is at some other url.
1996
def get_format_string(self):
1997
"""See BranchFormat.get_format_string()."""
1998
return "Bazaar-NG Branch Reference Format 1\n"
2000
def get_format_description(self):
2001
"""See BranchFormat.get_format_description()."""
2002
return "Checkout reference format 1"
2004
def get_reference(self, a_bzrdir):
2005
"""See BranchFormat.get_reference()."""
2006
transport = a_bzrdir.get_branch_transport(None)
2007
return transport.get_bytes('location')
2009
def set_reference(self, a_bzrdir, to_branch):
2010
"""See BranchFormat.set_reference()."""
2011
transport = a_bzrdir.get_branch_transport(None)
2012
location = transport.put_bytes('location', to_branch.base)
2014
def initialize(self, a_bzrdir, name=None, target_branch=None):
2015
"""Create a branch of this format in a_bzrdir."""
2016
if target_branch is None:
2017
# this format does not implement branch itself, thus the implicit
2018
# creation contract must see it as uninitializable
2019
raise errors.UninitializableFormat(self)
2020
mutter('creating branch reference in %s', a_bzrdir.transport.base)
2021
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2022
branch_transport.put_bytes('location',
2023
target_branch.bzrdir.root_transport.base)
2024
branch_transport.put_bytes('format', self.get_format_string())
2026
a_bzrdir, name, _found=True,
2027
possible_transports=[target_branch.bzrdir.root_transport])
2030
super(BranchReferenceFormat, self).__init__()
2031
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2032
self._matchingbzrdir.set_branch_format(self)
2034
def _make_reference_clone_function(format, a_branch):
2035
"""Create a clone() routine for a branch dynamically."""
2036
def clone(to_bzrdir, revision_id=None,
2037
repository_policy=None):
2038
"""See Branch.clone()."""
2039
return format.initialize(to_bzrdir, target_branch=a_branch)
2040
# cannot obey revision_id limits when cloning a reference ...
2041
# FIXME RBC 20060210 either nuke revision_id for clone, or
2042
# emit some sort of warning/error to the caller ?!
2045
def open(self, a_bzrdir, name=None, _found=False, location=None,
2046
possible_transports=None, ignore_fallbacks=False):
2047
"""Return the branch that the branch reference in a_bzrdir points at.
2049
:param a_bzrdir: A BzrDir that contains a branch.
2050
:param name: Name of colocated branch to open, if any
2051
:param _found: a private parameter, do not use it. It is used to
2052
indicate if format probing has already be done.
2053
:param ignore_fallbacks: when set, no fallback branches will be opened
2054
(if there are any). Default is to open fallbacks.
2055
:param location: The location of the referenced branch. If
2056
unspecified, this will be determined from the branch reference in
2058
:param possible_transports: An optional reusable transports list.
2061
format = BranchFormat.find_format(a_bzrdir, name=name)
2062
if format.__class__ != self.__class__:
2063
raise AssertionError("wrong format %r found for %r" %
2065
if location is None:
2066
location = self.get_reference(a_bzrdir)
2067
real_bzrdir = bzrdir.BzrDir.open(
2068
location, possible_transports=possible_transports)
2069
result = real_bzrdir.open_branch(name=name,
2070
ignore_fallbacks=ignore_fallbacks)
2071
# this changes the behaviour of result.clone to create a new reference
2072
# rather than a copy of the content of the branch.
2073
# I did not use a proxy object because that needs much more extensive
2074
# testing, and we are only changing one behaviour at the moment.
2075
# If we decide to alter more behaviours - i.e. the implicit nickname
2076
# then this should be refactored to introduce a tested proxy branch
2077
# and a subclass of that for use in overriding clone() and ....
2079
result.clone = self._make_reference_clone_function(result)
2083
network_format_registry = registry.FormatRegistry()
2084
"""Registry of formats indexed by their network name.
2086
The network name for a branch format is an identifier that can be used when
2087
referring to formats with smart server operations. See
2088
BranchFormat.network_name() for more detail.
2092
# formats which have no format string are not discoverable
2093
# and not independently creatable, so are not registered.
2094
__format5 = BzrBranchFormat5()
2095
__format6 = BzrBranchFormat6()
2096
__format7 = BzrBranchFormat7()
2097
__format8 = BzrBranchFormat8()
2098
BranchFormat.register_format(__format5)
2099
BranchFormat.register_format(BranchReferenceFormat())
2100
BranchFormat.register_format(__format6)
2101
BranchFormat.register_format(__format7)
2102
BranchFormat.register_format(__format8)
2103
BranchFormat.set_default_format(__format7)
2104
_legacy_formats = [BzrBranchFormat4(),
2106
network_format_registry.register(
2107
_legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2110
class BzrBranch(Branch, _RelockDebugMixin):
2111
"""A branch stored in the actual filesystem.
2113
Note that it's "local" in the context of the filesystem; it doesn't
2114
really matter if it's on an nfs/smb/afs/coda/... share, as long as
2115
it's writable, and can be accessed via the normal filesystem API.
2117
:ivar _transport: Transport for file operations on this branch's
2118
control files, typically pointing to the .bzr/branch directory.
2119
:ivar repository: Repository for this branch.
2120
:ivar base: The url of the base directory for this branch; the one
2121
containing the .bzr directory.
2122
:ivar name: Optional colocated branch name as it exists in the control
2126
def __init__(self, _format=None,
2127
_control_files=None, a_bzrdir=None, name=None,
2128
_repository=None, ignore_fallbacks=False):
2129
"""Create new branch object at a particular location."""
2130
if a_bzrdir is None:
2131
raise ValueError('a_bzrdir must be supplied')
2133
self.bzrdir = a_bzrdir
2134
self._base = self.bzrdir.transport.clone('..').base
2136
# XXX: We should be able to just do
2137
# self.base = self.bzrdir.root_transport.base
2138
# but this does not quite work yet -- mbp 20080522
2139
self._format = _format
2140
if _control_files is None:
2141
raise ValueError('BzrBranch _control_files is None')
2142
self.control_files = _control_files
2143
self._transport = _control_files._transport
2144
self.repository = _repository
2145
Branch.__init__(self)
2148
if self.name is None:
2149
return '%s(%r)' % (self.__class__.__name__, self.base)
2151
return '%s(%r,%r)' % (self.__class__.__name__, self.base, self.name)
2155
def _get_base(self):
2156
"""Returns the directory containing the control directory."""
2159
base = property(_get_base, doc="The URL for the root of this branch.")
2161
def _get_config(self):
2162
return TransportConfig(self._transport, 'branch.conf')
2164
def is_locked(self):
2165
return self.control_files.is_locked()
2167
def lock_write(self, token=None):
2168
if not self.is_locked():
2169
self._note_lock('w')
2170
# All-in-one needs to always unlock/lock.
2171
repo_control = getattr(self.repository, 'control_files', None)
2172
if self.control_files == repo_control or not self.is_locked():
2173
self.repository._warn_if_deprecated(self)
2174
self.repository.lock_write()
2179
return self.control_files.lock_write(token=token)
2182
self.repository.unlock()
2185
def lock_read(self):
2186
if not self.is_locked():
2187
self._note_lock('r')
2188
# All-in-one needs to always unlock/lock.
2189
repo_control = getattr(self.repository, 'control_files', None)
2190
if self.control_files == repo_control or not self.is_locked():
2191
self.repository._warn_if_deprecated(self)
2192
self.repository.lock_read()
2197
self.control_files.lock_read()
2200
self.repository.unlock()
2203
@only_raises(errors.LockNotHeld, errors.LockBroken)
2206
self.control_files.unlock()
2208
# All-in-one needs to always unlock/lock.
2209
repo_control = getattr(self.repository, 'control_files', None)
2210
if (self.control_files == repo_control or
2211
not self.control_files.is_locked()):
2212
self.repository.unlock()
2213
if not self.control_files.is_locked():
2214
# we just released the lock
2215
self._clear_cached_state()
2217
def peek_lock_mode(self):
2218
if self.control_files._lock_count == 0:
2221
return self.control_files._lock_mode
2223
def get_physical_lock_status(self):
2224
return self.control_files.get_physical_lock_status()
2227
def print_file(self, file, revision_id):
2228
"""See Branch.print_file."""
2229
return self.repository.print_file(file, revision_id)
2231
def _write_revision_history(self, history):
2232
"""Factored out of set_revision_history.
2234
This performs the actual writing to disk.
2235
It is intended to be called by BzrBranch5.set_revision_history."""
2236
self._transport.put_bytes(
2237
'revision-history', '\n'.join(history),
2238
mode=self.bzrdir._get_file_mode())
2241
def set_revision_history(self, rev_history):
2242
"""See Branch.set_revision_history."""
2243
if 'evil' in debug.debug_flags:
2244
mutter_callsite(3, "set_revision_history scales with history.")
2245
check_not_reserved_id = _mod_revision.check_not_reserved_id
2246
for rev_id in rev_history:
2247
check_not_reserved_id(rev_id)
2248
if Branch.hooks['post_change_branch_tip']:
2249
# Don't calculate the last_revision_info() if there are no hooks
2251
old_revno, old_revid = self.last_revision_info()
2252
if len(rev_history) == 0:
2253
revid = _mod_revision.NULL_REVISION
2255
revid = rev_history[-1]
2256
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2257
self._write_revision_history(rev_history)
2258
self._clear_cached_state()
2259
self._cache_revision_history(rev_history)
2260
for hook in Branch.hooks['set_rh']:
2261
hook(self, rev_history)
2262
if Branch.hooks['post_change_branch_tip']:
2263
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2265
def _synchronize_history(self, destination, revision_id):
2266
"""Synchronize last revision and revision history between branches.
2268
This version is most efficient when the destination is also a
2269
BzrBranch5, but works for BzrBranch6 as long as the revision
2270
history is the true lefthand parent history, and all of the revisions
2271
are in the destination's repository. If not, set_revision_history
2274
:param destination: The branch to copy the history into
2275
:param revision_id: The revision-id to truncate history at. May
2276
be None to copy complete history.
2278
if not isinstance(destination._format, BzrBranchFormat5):
2279
super(BzrBranch, self)._synchronize_history(
2280
destination, revision_id)
2282
if revision_id == _mod_revision.NULL_REVISION:
2285
new_history = self.revision_history()
2286
if revision_id is not None and new_history != []:
2288
new_history = new_history[:new_history.index(revision_id) + 1]
2290
rev = self.repository.get_revision(revision_id)
2291
new_history = rev.get_history(self.repository)[1:]
2292
destination.set_revision_history(new_history)
2295
def set_last_revision_info(self, revno, revision_id):
2296
"""Set the last revision of this branch.
2298
The caller is responsible for checking that the revno is correct
2299
for this revision id.
2301
It may be possible to set the branch last revision to an id not
2302
present in the repository. However, branches can also be
2303
configured to check constraints on history, in which case this may not
2306
revision_id = _mod_revision.ensure_null(revision_id)
2307
# this old format stores the full history, but this api doesn't
2308
# provide it, so we must generate, and might as well check it's
2310
history = self._lefthand_history(revision_id)
2311
if len(history) != revno:
2312
raise AssertionError('%d != %d' % (len(history), revno))
2313
self.set_revision_history(history)
2315
def _gen_revision_history(self):
2316
history = self._transport.get_bytes('revision-history').split('\n')
2317
if history[-1:] == ['']:
2318
# There shouldn't be a trailing newline, but just in case.
2323
def generate_revision_history(self, revision_id, last_rev=None,
2325
"""Create a new revision history that will finish with revision_id.
2327
:param revision_id: the new tip to use.
2328
:param last_rev: The previous last_revision. If not None, then this
2329
must be a ancestory of revision_id, or DivergedBranches is raised.
2330
:param other_branch: The other branch that DivergedBranches should
2331
raise with respect to.
2333
self.set_revision_history(self._lefthand_history(revision_id,
2334
last_rev, other_branch))
2336
def basis_tree(self):
2337
"""See Branch.basis_tree."""
2338
return self.repository.revision_tree(self.last_revision())
2340
def _get_parent_location(self):
2341
_locs = ['parent', 'pull', 'x-pull']
2344
return self._transport.get_bytes(l).strip('\n')
2345
except errors.NoSuchFile:
2349
def _basic_push(self, target, overwrite, stop_revision):
2350
"""Basic implementation of push without bound branches or hooks.
2352
Must be called with source read locked and target write locked.
2354
result = BranchPushResult()
2355
result.source_branch = self
2356
result.target_branch = target
2357
result.old_revno, result.old_revid = target.last_revision_info()
2358
self.update_references(target)
2359
if result.old_revid != self.last_revision():
2360
# We assume that during 'push' this repository is closer than
2362
graph = self.repository.get_graph(target.repository)
2363
target.update_revisions(self, stop_revision,
2364
overwrite=overwrite, graph=graph)
2365
if self._push_should_merge_tags():
2366
result.tag_conflicts = self.tags.merge_to(target.tags,
2368
result.new_revno, result.new_revid = target.last_revision_info()
2371
def get_stacked_on_url(self):
2372
raise errors.UnstackableBranchFormat(self._format, self.base)
2374
def set_push_location(self, location):
2375
"""See Branch.set_push_location."""
2376
self.get_config().set_user_option(
2377
'push_location', location,
2378
store=_mod_config.STORE_LOCATION_NORECURSE)
2380
def _set_parent_location(self, url):
2382
self._transport.delete('parent')
2384
self._transport.put_bytes('parent', url + '\n',
2385
mode=self.bzrdir._get_file_mode())
2388
class BzrBranch5(BzrBranch):
2389
"""A format 5 branch. This supports new features over plain branches.
2391
It has support for a master_branch which is the data for bound branches.
2394
def get_bound_location(self):
2396
return self._transport.get_bytes('bound')[:-1]
2397
except errors.NoSuchFile:
2401
def get_master_branch(self, possible_transports=None):
2402
"""Return the branch we are bound to.
2404
:return: Either a Branch, or None
2406
This could memoise the branch, but if thats done
2407
it must be revalidated on each new lock.
2408
So for now we just don't memoise it.
2409
# RBC 20060304 review this decision.
2411
bound_loc = self.get_bound_location()
2415
return Branch.open(bound_loc,
2416
possible_transports=possible_transports)
2417
except (errors.NotBranchError, errors.ConnectionError), e:
2418
raise errors.BoundBranchConnectionFailure(
2422
def set_bound_location(self, location):
2423
"""Set the target where this branch is bound to.
2425
:param location: URL to the target branch
2428
self._transport.put_bytes('bound', location+'\n',
2429
mode=self.bzrdir._get_file_mode())
2432
self._transport.delete('bound')
2433
except errors.NoSuchFile:
2438
def bind(self, other):
2439
"""Bind this branch to the branch other.
2441
This does not push or pull data between the branches, though it does
2442
check for divergence to raise an error when the branches are not
2443
either the same, or one a prefix of the other. That behaviour may not
2444
be useful, so that check may be removed in future.
2446
:param other: The branch to bind to
2449
# TODO: jam 20051230 Consider checking if the target is bound
2450
# It is debatable whether you should be able to bind to
2451
# a branch which is itself bound.
2452
# Committing is obviously forbidden,
2453
# but binding itself may not be.
2454
# Since we *have* to check at commit time, we don't
2455
# *need* to check here
2457
# we want to raise diverged if:
2458
# last_rev is not in the other_last_rev history, AND
2459
# other_last_rev is not in our history, and do it without pulling
2461
self.set_bound_location(other.base)
2465
"""If bound, unbind"""
2466
return self.set_bound_location(None)
2469
def update(self, possible_transports=None):
2470
"""Synchronise this branch with the master branch if any.
2472
:return: None or the last_revision that was pivoted out during the
2475
master = self.get_master_branch(possible_transports)
2476
if master is not None:
2477
old_tip = _mod_revision.ensure_null(self.last_revision())
2478
self.pull(master, overwrite=True)
2479
if self.repository.get_graph().is_ancestor(old_tip,
2480
_mod_revision.ensure_null(self.last_revision())):
2486
class BzrBranch8(BzrBranch5):
2487
"""A branch that stores tree-reference locations."""
2489
def _open_hook(self):
2490
if self._ignore_fallbacks:
2493
url = self.get_stacked_on_url()
2494
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2495
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:
2498
for hook in Branch.hooks['transform_fallback_location']:
2499
url = hook(self, url)
2501
hook_name = Branch.hooks.get_hook_name(hook)
2502
raise AssertionError(
2503
"'transform_fallback_location' hook %s returned "
2504
"None, not a URL." % hook_name)
2505
self._activate_fallback_location(url)
2507
def __init__(self, *args, **kwargs):
2508
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2509
super(BzrBranch8, self).__init__(*args, **kwargs)
2510
self._last_revision_info_cache = None
2511
self._reference_info = None
2513
def _clear_cached_state(self):
2514
super(BzrBranch8, self)._clear_cached_state()
2515
self._last_revision_info_cache = None
2516
self._reference_info = None
2518
def _last_revision_info(self):
2519
revision_string = self._transport.get_bytes('last-revision')
2520
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2521
revision_id = cache_utf8.get_cached_utf8(revision_id)
2523
return revno, revision_id
2525
def _write_last_revision_info(self, revno, revision_id):
2526
"""Simply write out the revision id, with no checks.
2528
Use set_last_revision_info to perform this safely.
2530
Does not update the revision_history cache.
2531
Intended to be called by set_last_revision_info and
2532
_write_revision_history.
2534
revision_id = _mod_revision.ensure_null(revision_id)
2535
out_string = '%d %s\n' % (revno, revision_id)
2536
self._transport.put_bytes('last-revision', out_string,
2537
mode=self.bzrdir._get_file_mode())
2540
def set_last_revision_info(self, revno, revision_id):
2541
revision_id = _mod_revision.ensure_null(revision_id)
2542
old_revno, old_revid = self.last_revision_info()
2543
if self._get_append_revisions_only():
2544
self._check_history_violation(revision_id)
2545
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2546
self._write_last_revision_info(revno, revision_id)
2547
self._clear_cached_state()
2548
self._last_revision_info_cache = revno, revision_id
2549
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2551
def _synchronize_history(self, destination, revision_id):
2552
"""Synchronize last revision and revision history between branches.
2554
:see: Branch._synchronize_history
2556
# XXX: The base Branch has a fast implementation of this method based
2557
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2558
# that uses set_revision_history. This class inherits from BzrBranch5,
2559
# but wants the fast implementation, so it calls
2560
# Branch._synchronize_history directly.
2561
Branch._synchronize_history(self, destination, revision_id)
2563
def _check_history_violation(self, revision_id):
2564
last_revision = _mod_revision.ensure_null(self.last_revision())
2565
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
2567
if last_revision not in self._lefthand_history(revision_id):
2568
raise errors.AppendRevisionsOnlyViolation(self.base)
2570
def _gen_revision_history(self):
2571
"""Generate the revision history from last revision
2573
last_revno, last_revision = self.last_revision_info()
2574
self._extend_partial_history(stop_index=last_revno-1)
2575
return list(reversed(self._partial_revision_history_cache))
2577
def _write_revision_history(self, history):
2578
"""Factored out of set_revision_history.
2580
This performs the actual writing to disk, with format-specific checks.
2581
It is intended to be called by BzrBranch5.set_revision_history.
2583
if len(history) == 0:
2584
last_revision = 'null:'
2586
if history != self._lefthand_history(history[-1]):
2587
raise errors.NotLefthandHistory(history)
2588
last_revision = history[-1]
2589
if self._get_append_revisions_only():
2590
self._check_history_violation(last_revision)
2591
self._write_last_revision_info(len(history), last_revision)
2594
def _set_parent_location(self, url):
2595
"""Set the parent branch"""
2596
self._set_config_location('parent_location', url, make_relative=True)
2599
def _get_parent_location(self):
2600
"""Set the parent branch"""
2601
return self._get_config_location('parent_location')
2604
def _set_all_reference_info(self, info_dict):
2605
"""Replace all reference info stored in a branch.
2607
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2610
writer = rio.RioWriter(s)
2611
for key, (tree_path, branch_location) in info_dict.iteritems():
2612
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2613
branch_location=branch_location)
2614
writer.write_stanza(stanza)
2615
self._transport.put_bytes('references', s.getvalue())
2616
self._reference_info = info_dict
2619
def _get_all_reference_info(self):
2620
"""Return all the reference info stored in a branch.
2622
:return: A dict of {file_id: (tree_path, branch_location)}
2624
if self._reference_info is not None:
2625
return self._reference_info
2626
rio_file = self._transport.get('references')
1256
f = AtomicFile(self.controlfilename('pending-merges'))
2628
stanzas = rio.read_stanzas(rio_file)
2629
info_dict = dict((s['file_id'], (s['tree_path'],
2630
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()
2633
self._reference_info = info_dict
2636
def set_reference_info(self, file_id, tree_path, branch_location):
2637
"""Set the branch location to use for a tree reference.
2639
:param file_id: The file-id of the tree reference.
2640
:param tree_path: The path of the tree reference in the tree.
2641
:param branch_location: The location of the branch to retrieve tree
2644
info_dict = self._get_all_reference_info()
2645
info_dict[file_id] = (tree_path, branch_location)
2646
if None in (tree_path, branch_location):
2647
if tree_path is not None:
2648
raise ValueError('tree_path must be None when branch_location'
2650
if branch_location is not None:
2651
raise ValueError('branch_location must be None when tree_path'
2653
del info_dict[file_id]
2654
self._set_all_reference_info(info_dict)
2656
def get_reference_info(self, file_id):
2657
"""Get the tree_path and branch_location for a tree reference.
2659
:return: a tuple of (tree_path, branch_location)
2661
return self._get_all_reference_info().get(file_id, (None, None))
2663
def reference_parent(self, file_id, path, possible_transports=None):
2664
"""Return the parent branch for a tree-reference file_id.
2666
:param file_id: The file_id of the tree reference
2667
:param path: The path of the file_id in the tree
2668
:return: A branch associated with the file_id
2670
branch_location = self.get_reference_info(file_id)[1]
2671
if branch_location is None:
2672
return Branch.reference_parent(self, file_id, path,
2673
possible_transports)
2674
branch_location = urlutils.join(self.base, branch_location)
2675
return Branch.open(branch_location,
2676
possible_transports=possible_transports)
2678
def set_push_location(self, location):
2679
"""See Branch.set_push_location."""
2680
self._set_config_location('push_location', location)
2682
def set_bound_location(self, location):
2683
"""See Branch.set_push_location."""
2685
config = self.get_config()
2686
if location is None:
2687
if config.get_user_option('bound') != 'True':
2690
config.set_user_option('bound', 'False', warn_masked=True)
2693
self._set_config_location('bound_location', location,
2695
config.set_user_option('bound', 'True', warn_masked=True)
2698
def _get_bound_location(self, bound):
2699
"""Return the bound location in the config file.
2701
Return None if the bound parameter does not match"""
2702
config = self.get_config()
2703
config_bound = (config.get_user_option('bound') == 'True')
2704
if config_bound != bound:
2706
return self._get_config_location('bound_location', config=config)
2708
def get_bound_location(self):
2709
"""See Branch.set_push_location."""
2710
return self._get_bound_location(True)
2712
def get_old_bound_location(self):
2713
"""See Branch.get_old_bound_location"""
2714
return self._get_bound_location(False)
2716
def get_stacked_on_url(self):
2717
# you can always ask for the URL; but you might not be able to use it
2718
# if the repo can't support stacking.
2719
## self._check_stackable_repo()
2720
stacked_url = self._get_config_location('stacked_on_location')
2721
if stacked_url is None:
2722
raise errors.NotStacked(self)
2725
def _get_append_revisions_only(self):
2726
value = self.get_config().get_user_option('append_revisions_only')
2727
return value == 'True'
2730
def generate_revision_history(self, revision_id, last_rev=None,
2732
"""See BzrBranch5.generate_revision_history"""
2733
history = self._lefthand_history(revision_id, last_rev, other_branch)
2734
revno = len(history)
2735
self.set_last_revision_info(revno, revision_id)
2738
def get_rev_id(self, revno, history=None):
2739
"""Find the revision id of the specified revno."""
2741
return _mod_revision.NULL_REVISION
2743
last_revno, last_revision_id = self.last_revision_info()
2744
if revno <= 0 or revno > last_revno:
2745
raise errors.NoSuchRevision(self, revno)
2747
if history is not None:
2748
return history[revno - 1]
2750
index = last_revno - revno
2751
if len(self._partial_revision_history_cache) <= index:
2752
self._extend_partial_history(stop_index=index)
2753
if len(self._partial_revision_history_cache) > index:
2754
return self._partial_revision_history_cache[index]
2756
raise errors.NoSuchRevision(self, revno)
2759
def revision_id_to_revno(self, revision_id):
2760
"""Given a revision id, return its revno"""
2761
if _mod_revision.is_null(revision_id):
2764
index = self._partial_revision_history_cache.index(revision_id)
2766
self._extend_partial_history(stop_revision=revision_id)
2767
index = len(self._partial_revision_history_cache) - 1
2768
if self._partial_revision_history_cache[index] != revision_id:
2769
raise errors.NoSuchRevision(self, revision_id)
2770
return self.revno() - index
2773
class BzrBranch7(BzrBranch8):
2774
"""A branch with support for a fallback repository."""
2776
def set_reference_info(self, file_id, tree_path, branch_location):
2777
Branch.set_reference_info(self, file_id, tree_path, branch_location)
2779
def get_reference_info(self, file_id):
2780
Branch.get_reference_info(self, file_id)
2782
def reference_parent(self, file_id, path, possible_transports=None):
2783
return Branch.reference_parent(self, file_id, path,
2784
possible_transports)
2787
class BzrBranch6(BzrBranch7):
2788
"""See BzrBranchFormat6 for the capabilities of this branch.
2790
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)
2794
def get_stacked_on_url(self):
2795
raise errors.UnstackableBranchFormat(self._format, self.base)
1337
2798
######################################################################
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')
2799
# results of operations
2802
class _Result(object):
2804
def _show_tag_conficts(self, to_file):
2805
if not getattr(self, 'tag_conflicts', None):
2807
to_file.write('Conflicting tags:\n')
2808
for name, value1, value2 in self.tag_conflicts:
2809
to_file.write(' %s\n' % (name, ))
2812
class PullResult(_Result):
2813
"""Result of a Branch.pull operation.
2815
:ivar old_revno: Revision number before pull.
2816
:ivar new_revno: Revision number after pull.
2817
:ivar old_revid: Tip revision id before pull.
2818
:ivar new_revid: Tip revision id after pull.
2819
:ivar source_branch: Source (local) branch object. (read locked)
2820
:ivar master_branch: Master branch of the target, or the target if no
2822
:ivar local_branch: target branch if there is a Master, else None
2823
:ivar target_branch: Target/destination branch object. (write locked)
2824
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2828
# DEPRECATED: pull used to return the change in revno
2829
return self.new_revno - self.old_revno
2831
def report(self, to_file):
2833
if self.old_revid == self.new_revid:
2834
to_file.write('No revisions to pull.\n')
2836
to_file.write('Now on revision %d.\n' % self.new_revno)
2837
self._show_tag_conficts(to_file)
2840
class BranchPushResult(_Result):
2841
"""Result of a Branch.push operation.
2843
:ivar old_revno: Revision number (eg 10) of the target before push.
2844
:ivar new_revno: Revision number (eg 12) of the target after push.
2845
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
2847
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
2849
:ivar source_branch: Source branch object that the push was from. This is
2850
read locked, and generally is a local (and thus low latency) branch.
2851
:ivar master_branch: If target is a bound branch, the master branch of
2852
target, or target itself. Always write locked.
2853
:ivar target_branch: The direct Branch where data is being sent (write
2855
:ivar local_branch: If the target is a bound branch this will be the
2856
target, otherwise it will be None.
2860
# DEPRECATED: push used to return the change in revno
2861
return self.new_revno - self.old_revno
2863
def report(self, to_file):
2864
"""Write a human-readable description of the result."""
2865
if self.old_revid == self.new_revid:
2866
note('No new revisions to push.')
2868
note('Pushed up to revision %d.' % self.new_revno)
2869
self._show_tag_conficts(to_file)
2872
class BranchCheckResult(object):
2873
"""Results of checking branch consistency.
2878
def __init__(self, branch):
2879
self.branch = branch
2882
def report_results(self, verbose):
2883
"""Report the check results via trace.note.
2885
:param verbose: Requests more detailed display of what was checked,
2888
note('checked branch %s format %s', self.branch.base,
2889
self.branch._format)
2890
for error in self.errors:
2891
note('found error:%s', error)
2894
class Converter5to6(object):
2895
"""Perform an in-place upgrade of format 5 to format 6"""
2897
def convert(self, branch):
2898
# Data for 5 and 6 can peacefully coexist.
2899
format = BzrBranchFormat6()
2900
new_branch = format.open(branch.bzrdir, _found=True)
2902
# Copy source data into target
2903
new_branch._write_last_revision_info(*branch.last_revision_info())
2904
new_branch.set_parent(branch.get_parent())
2905
new_branch.set_bound_location(branch.get_bound_location())
2906
new_branch.set_push_location(branch.get_push_location())
2908
# New branch has no tags by default
2909
new_branch.tags._set_tag_dict({})
2911
# Copying done; now update target format
2912
new_branch._transport.put_bytes('format',
2913
format.get_format_string(),
2914
mode=new_branch.bzrdir._get_file_mode())
2916
# Clean up old files
2917
new_branch._transport.delete('revision-history')
2919
branch.set_parent(None)
2920
except errors.NoSuchFile:
2922
branch.set_bound_location(None)
2925
class Converter6to7(object):
2926
"""Perform an in-place upgrade of format 6 to format 7"""
2928
def convert(self, branch):
2929
format = BzrBranchFormat7()
2930
branch._set_config_location('stacked_on_location', '')
2931
# update target format
2932
branch._transport.put_bytes('format', format.get_format_string())
2935
class Converter7to8(object):
2936
"""Perform an in-place upgrade of format 6 to format 7"""
2938
def convert(self, branch):
2939
format = BzrBranchFormat8()
2940
branch._transport.put_bytes('references', '')
2941
# update target format
2942
branch._transport.put_bytes('format', format.get_format_string())
2945
def _run_with_write_locked_target(target, callable, *args, **kwargs):
2946
"""Run ``callable(*args, **kwargs)``, write-locking target for the
2949
_run_with_write_locked_target will attempt to release the lock it acquires.
2951
If an exception is raised by callable, then that exception *will* be
2952
propagated, even if the unlock attempt raises its own error. Thus
2953
_run_with_write_locked_target should be preferred to simply doing::
2957
return callable(*args, **kwargs)
2962
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
2963
# should share code?
2966
result = callable(*args, **kwargs)
2968
exc_info = sys.exc_info()
2972
raise exc_info[0], exc_info[1], exc_info[2]
2978
class InterBranch(InterObject):
2979
"""This class represents operations taking place between two branches.
2981
Its instances have methods like pull() and push() and contain
2982
references to the source and target repositories these operations
2983
can be carried out on.
2987
"""The available optimised InterBranch types."""
2990
def _get_branch_formats_to_test():
2991
"""Return a tuple with the Branch formats to use when testing."""
2992
raise NotImplementedError(InterBranch._get_branch_formats_to_test)
2994
def pull(self, overwrite=False, stop_revision=None,
2995
possible_transports=None, local=False):
2996
"""Mirror source into target branch.
2998
The target branch is considered to be 'local', having low latency.
3000
:returns: PullResult instance
3002
raise NotImplementedError(self.pull)
3004
def update_revisions(self, stop_revision=None, overwrite=False,
3006
"""Pull in new perfect-fit revisions.
3008
:param stop_revision: Updated until the given revision
3009
:param overwrite: Always set the branch pointer, rather than checking
3010
to see if it is a proper descendant.
3011
:param graph: A Graph object that can be used to query history
3012
information. This can be None.
3015
raise NotImplementedError(self.update_revisions)
3017
def push(self, overwrite=False, stop_revision=None,
3018
_override_hook_source_branch=None):
3019
"""Mirror the source branch into the target branch.
3021
The source branch is considered to be 'local', having low latency.
3023
raise NotImplementedError(self.push)
3026
class GenericInterBranch(InterBranch):
3027
"""InterBranch implementation that uses public Branch functions.
3031
def _get_branch_formats_to_test():
3032
return BranchFormat._default_format, BranchFormat._default_format
3034
def update_revisions(self, stop_revision=None, overwrite=False,
3036
"""See InterBranch.update_revisions()."""
3037
self.source.lock_read()
3039
other_revno, other_last_revision = self.source.last_revision_info()
3040
stop_revno = None # unknown
3041
if stop_revision is None:
3042
stop_revision = other_last_revision
3043
if _mod_revision.is_null(stop_revision):
3044
# if there are no commits, we're done.
3046
stop_revno = other_revno
3048
# what's the current last revision, before we fetch [and change it
3050
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3051
# we fetch here so that we don't process data twice in the common
3052
# case of having something to pull, and so that the check for
3053
# already merged can operate on the just fetched graph, which will
3054
# be cached in memory.
3055
self.target.fetch(self.source, stop_revision)
3056
# Check to see if one is an ancestor of the other
3059
graph = self.target.repository.get_graph()
3060
if self.target._check_if_descendant_or_diverged(
3061
stop_revision, last_rev, graph, self.source):
3062
# stop_revision is a descendant of last_rev, but we aren't
3063
# overwriting, so we're done.
3065
if stop_revno is None:
3067
graph = self.target.repository.get_graph()
3068
this_revno, this_last_revision = \
3069
self.target.last_revision_info()
3070
stop_revno = graph.find_distance_to_null(stop_revision,
3071
[(other_last_revision, other_revno),
3072
(this_last_revision, this_revno)])
3073
self.target.set_last_revision_info(stop_revno, stop_revision)
3075
self.source.unlock()
3077
def pull(self, overwrite=False, stop_revision=None,
3078
possible_transports=None, _hook_master=None, run_hooks=True,
3079
_override_hook_target=None, local=False):
3082
:param _hook_master: Private parameter - set the branch to
3083
be supplied as the master to pull hooks.
3084
:param run_hooks: Private parameter - if false, this branch
3085
is being called because it's the master of the primary branch,
3086
so it should not run its hooks.
3087
:param _override_hook_target: Private parameter - set the branch to be
3088
supplied as the target_branch to pull hooks.
3089
:param local: Only update the local branch, and not the bound branch.
3091
# This type of branch can't be bound.
3093
raise errors.LocalRequiresBoundBranch()
3094
result = PullResult()
3095
result.source_branch = self.source
3096
if _override_hook_target is None:
3097
result.target_branch = self.target
3099
result.target_branch = _override_hook_target
3100
self.source.lock_read()
3102
# We assume that during 'pull' the target repository is closer than
3104
self.source.update_references(self.target)
3105
graph = self.target.repository.get_graph(self.source.repository)
3106
# TODO: Branch formats should have a flag that indicates
3107
# that revno's are expensive, and pull() should honor that flag.
3109
result.old_revno, result.old_revid = \
3110
self.target.last_revision_info()
3111
self.target.update_revisions(self.source, stop_revision,
3112
overwrite=overwrite, graph=graph)
3113
# TODO: The old revid should be specified when merging tags,
3114
# so a tags implementation that versions tags can only
3115
# pull in the most recent changes. -- JRV20090506
3116
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3118
result.new_revno, result.new_revid = self.target.last_revision_info()
3120
result.master_branch = _hook_master
3121
result.local_branch = result.target_branch
3123
result.master_branch = result.target_branch
3124
result.local_branch = None
3126
for hook in Branch.hooks['post_pull']:
3129
self.source.unlock()
3132
def push(self, overwrite=False, stop_revision=None,
3133
_override_hook_source_branch=None):
3134
"""See InterBranch.push.
3136
This is the basic concrete implementation of push()
3138
:param _override_hook_source_branch: If specified, run
3139
the hooks passing this Branch as the source, rather than self.
3140
This is for use of RemoteBranch, where push is delegated to the
3141
underlying vfs-based Branch.
3143
# TODO: Public option to disable running hooks - should be trivial but
3145
self.source.lock_read()
3147
return _run_with_write_locked_target(
3148
self.target, self._push_with_bound_branches, overwrite,
3150
_override_hook_source_branch=_override_hook_source_branch)
3152
self.source.unlock()
3154
def _push_with_bound_branches(self, overwrite, stop_revision,
3155
_override_hook_source_branch=None):
3156
"""Push from source into target, and into target's master if any.
3159
if _override_hook_source_branch:
3160
result.source_branch = _override_hook_source_branch
3161
for hook in Branch.hooks['post_push']:
3164
bound_location = self.target.get_bound_location()
3165
if bound_location and self.target.base != bound_location:
3166
# there is a master branch.
3168
# XXX: Why the second check? Is it even supported for a branch to
3169
# be bound to itself? -- mbp 20070507
3170
master_branch = self.target.get_master_branch()
3171
master_branch.lock_write()
3173
# push into the master from the source branch.
3174
self.source._basic_push(master_branch, overwrite, stop_revision)
3175
# and push into the target branch from the source. Note that we
3176
# push from the source branch again, because its considered the
3177
# highest bandwidth repository.
3178
result = self.source._basic_push(self.target, overwrite,
3180
result.master_branch = master_branch
3181
result.local_branch = self.target
3185
master_branch.unlock()
3188
result = self.source._basic_push(self.target, overwrite,
3190
# TODO: Why set master_branch and local_branch if there's no
3191
# binding? Maybe cleaner to just leave them unset? -- mbp
3193
result.master_branch = self.target
3194
result.local_branch = None
3199
def is_compatible(self, source, target):
3200
# GenericBranch uses the public API, so always compatible
3204
class InterToBranch5(GenericInterBranch):
3207
def _get_branch_formats_to_test():
3208
return BranchFormat._default_format, BzrBranchFormat5()
3210
def pull(self, overwrite=False, stop_revision=None,
3211
possible_transports=None, run_hooks=True,
3212
_override_hook_target=None, local=False):
3213
"""Pull from source into self, updating my master if any.
3215
:param run_hooks: Private parameter - if false, this branch
3216
is being called because it's the master of the primary branch,
3217
so it should not run its hooks.
3219
bound_location = self.target.get_bound_location()
3220
if local and not bound_location:
3221
raise errors.LocalRequiresBoundBranch()
3222
master_branch = None
3223
if not local and bound_location and self.source.base != bound_location:
3224
# not pulling from master, so we need to update master.
3225
master_branch = self.target.get_master_branch(possible_transports)
3226
master_branch.lock_write()
3229
# pull from source into master.
3230
master_branch.pull(self.source, overwrite, stop_revision,
3232
return super(InterToBranch5, self).pull(overwrite,
3233
stop_revision, _hook_master=master_branch,
3234
run_hooks=run_hooks,
3235
_override_hook_target=_override_hook_target)
3238
master_branch.unlock()
3241
InterBranch.register_optimiser(GenericInterBranch)
3242
InterBranch.register_optimiser(InterToBranch5)
added
removed
bzrlib/branch.py
