137
78
"""Branch holding a history of revisions.
140
Base directory of the branch.
146
If _lock_mode is true, a positive count of the number of times the
150
Lock object from bzrlib.lock.
81
Base directory/url of the branch.
83
hooks: An instance of BranchHooks.
85
# this is really an instance variable - FIXME move it there
157
# Map some sort of prefix into a namespace
158
# stuff like "revno:10", "revid:", etc.
159
# This should match a prefix with a function which accepts
160
REVISION_NAMESPACES = {}
162
def __init__(self, base, init=False, find_root=True):
163
"""Create new branch object at a particular location.
165
base -- Base directory for the branch.
167
init -- If True, create new control files in a previously
168
unversioned directory. If False, the branch must already
171
find_root -- If true and init is false, find the root of the
172
existing branch containing base.
174
In the test suite, creation of new trees is tested using the
175
`ScratchBranch` class.
177
from bzrlib.store import ImmutableStore
179
self.base = os.path.realpath(base)
182
self.base = find_branch_root(base)
184
self.base = os.path.realpath(base)
185
if not isdir(self.controlfilename('.')):
186
from errors import NotBranchError
187
raise NotBranchError("not a bzr branch: %s" % quotefn(base),
188
['use "bzr init" to initialize a new working tree',
189
'current bzr can only operate from top-of-tree'])
192
self.text_store = ImmutableStore(self.controlfilename('text-store'))
193
self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
194
self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
198
return '%s(%r)' % (self.__class__.__name__, self.base)
205
if self._lock_mode or self._lock:
206
from warnings import warn
207
warn("branch %r was not explicitly unlocked" % self)
89
def __init__(self, *ignored, **ignored_too):
90
self.tags = self._format.make_tags(self)
91
self._revision_history_cache = None
92
self._revision_id_to_revno_cache = None
93
self._partial_revision_id_to_revno_cache = {}
94
self._partial_revision_history_cache = []
95
self._last_revision_info_cache = None
96
self._merge_sorted_revisions_cache = None
98
hooks = Branch.hooks['open']
102
def _open_hook(self):
103
"""Called by init to allow simpler extension of the base class."""
105
def _activate_fallback_location(self, url):
106
"""Activate the branch/repository from url as a fallback repository."""
107
repo = self._get_fallback_repository(url)
108
self.repository.add_fallback_repository(repo)
110
def break_lock(self):
111
"""Break a lock if one is present from another instance.
113
Uses the ui factory to ask for confirmation if the lock may be from
116
This will probe the repository for its lock as well.
118
self.control_files.break_lock()
119
self.repository.break_lock()
120
master = self.get_master_branch()
121
if master is not None:
124
def _check_stackable_repo(self):
125
if not self.repository._format.supports_external_lookups:
126
raise errors.UnstackableRepositoryFormat(self.repository._format,
127
self.repository.base)
129
def _extend_partial_history(self, stop_index=None, stop_revision=None):
130
"""Extend the partial history to include a given index
132
If a stop_index is supplied, stop when that index has been reached.
133
If a stop_revision is supplied, stop when that revision is
134
encountered. Otherwise, stop when the beginning of history is
137
:param stop_index: The index which should be present. When it is
138
present, history extension will stop.
139
:param stop_revision: The revision id which should be present. When
140
it is encountered, history extension will stop.
142
if len(self._partial_revision_history_cache) == 0:
143
self._partial_revision_history_cache = [self.last_revision()]
144
repository._iter_for_revno(
145
self.repository, self._partial_revision_history_cache,
146
stop_index=stop_index, stop_revision=stop_revision)
147
if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
148
self._partial_revision_history_cache.pop()
151
def open(base, _unsupported=False, possible_transports=None):
152
"""Open the branch rooted at base.
154
For instance, if the branch is at URL/.bzr/branch,
155
Branch.open(URL) -> a Branch instance.
157
control = bzrdir.BzrDir.open(base, _unsupported,
158
possible_transports=possible_transports)
159
return control.open_branch(_unsupported)
162
def open_from_transport(transport, _unsupported=False):
163
"""Open the branch rooted at transport"""
164
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
165
return control.open_branch(_unsupported)
168
def open_containing(url, possible_transports=None):
169
"""Open an existing branch which contains url.
171
This probes for a branch at url, and searches upwards from there.
173
Basically we keep looking up until we find the control directory or
174
run into the root. If there isn't one, raises NotBranchError.
175
If there is one and it is either an unrecognised format or an unsupported
176
format, UnknownFormatError or UnsupportedFormatError are raised.
177
If there is one, it is returned, along with the unused portion of url.
179
control, relpath = bzrdir.BzrDir.open_containing(url,
181
return control.open_branch(), relpath
183
def _push_should_merge_tags(self):
184
"""Should _basic_push merge this branch's tags into the target?
186
The default implementation returns False if this branch has no tags,
187
and True the rest of the time. Subclasses may override this.
189
return self.supports_tags() and self.tags.get_tag_dict()
191
def get_config(self):
192
return BranchConfig(self)
194
def _get_config(self):
195
"""Get the concrete config for just the config in this branch.
197
This is not intended for client use; see Branch.get_config for the
202
:return: An object supporting get_option and set_option.
204
raise NotImplementedError(self._get_config)
206
def _get_fallback_repository(self, url):
207
"""Get the repository we fallback to at url."""
208
url = urlutils.join(self.base, url)
209
a_bzrdir = bzrdir.BzrDir.open(url,
210
possible_transports=[self.bzrdir.root_transport])
211
return a_bzrdir.open_branch().repository
213
def _get_tags_bytes(self):
214
"""Get the bytes of a serialised tags dict.
216
Note that not all branches support tags, nor do all use the same tags
217
logic: this method is specific to BasicTags. Other tag implementations
218
may use the same method name and behave differently, safely, because
219
of the double-dispatch via
220
format.make_tags->tags_instance->get_tags_dict.
222
:return: The bytes of the tags file.
223
:seealso: Branch._set_tags_bytes.
225
return self._transport.get_bytes('tags')
227
def _get_nick(self, local=False, possible_transports=None):
228
config = self.get_config()
229
# explicit overrides master, but don't look for master if local is True
230
if not local and not config.has_explicit_nickname():
232
master = self.get_master_branch(possible_transports)
233
if master is not None:
234
# return the master branch value
236
except errors.BzrError, e:
237
# Silently fall back to local implicit nick if the master is
239
mutter("Could not connect to bound branch, "
240
"falling back to local nick.\n " + str(e))
241
return config.get_nickname()
243
def _set_nick(self, nick):
244
self.get_config().set_user_option('nickname', nick, warn_masked=True)
246
nick = property(_get_nick, _set_nick)
249
raise NotImplementedError(self.is_locked)
251
def _lefthand_history(self, revision_id, last_rev=None,
253
if 'evil' in debug.debug_flags:
254
mutter_callsite(4, "_lefthand_history scales with history.")
255
# stop_revision must be a descendant of last_revision
256
graph = self.repository.get_graph()
257
if last_rev is not None:
258
if not graph.is_ancestor(last_rev, revision_id):
259
# our previous tip is not merged into stop_revision
260
raise errors.DivergedBranches(self, other_branch)
261
# make a new revision history from the graph
262
parents_map = graph.get_parent_map([revision_id])
263
if revision_id not in parents_map:
264
raise errors.NoSuchRevision(self, revision_id)
265
current_rev_id = revision_id
267
check_not_reserved_id = _mod_revision.check_not_reserved_id
268
# Do not include ghosts or graph origin in revision_history
269
while (current_rev_id in parents_map and
270
len(parents_map[current_rev_id]) > 0):
271
check_not_reserved_id(current_rev_id)
272
new_history.append(current_rev_id)
273
current_rev_id = parents_map[current_rev_id][0]
274
parents_map = graph.get_parent_map([current_rev_id])
275
new_history.reverse()
212
278
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'
279
raise NotImplementedError(self.lock_write)
228
281
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'
282
raise NotImplementedError(self.lock_read)
242
284
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
285
raise NotImplementedError(self.unlock)
287
def peek_lock_mode(self):
288
"""Return lock mode for the Branch: 'r', 'w' or None"""
289
raise NotImplementedError(self.peek_lock_mode)
291
def get_physical_lock_status(self):
292
raise NotImplementedError(self.get_physical_lock_status)
295
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
296
"""Return the revision_id for a dotted revno.
298
:param revno: a tuple like (1,) or (1,1,2)
299
:param _cache_reverse: a private parameter enabling storage
300
of the reverse mapping in a top level cache. (This should
301
only be done in selective circumstances as we want to
302
avoid having the mapping cached multiple times.)
303
:return: the revision_id
304
:raises errors.NoSuchRevision: if the revno doesn't exist
306
rev_id = self._do_dotted_revno_to_revision_id(revno)
308
self._partial_revision_id_to_revno_cache[rev_id] = revno
311
def _do_dotted_revno_to_revision_id(self, revno):
312
"""Worker function for dotted_revno_to_revision_id.
314
Subclasses should override this if they wish to
315
provide a more efficient implementation.
318
return self.get_rev_id(revno[0])
319
revision_id_to_revno = self.get_revision_id_to_revno_map()
320
revision_ids = [revision_id for revision_id, this_revno
321
in revision_id_to_revno.iteritems()
322
if revno == this_revno]
323
if len(revision_ids) == 1:
324
return revision_ids[0]
326
revno_str = '.'.join(map(str, revno))
327
raise errors.NoSuchRevision(self, revno_str)
330
def revision_id_to_dotted_revno(self, revision_id):
331
"""Given a revision id, return its dotted revno.
333
:return: a tuple like (1,) or (400,1,3).
335
return self._do_revision_id_to_dotted_revno(revision_id)
337
def _do_revision_id_to_dotted_revno(self, revision_id):
338
"""Worker function for revision_id_to_revno."""
339
# Try the caches if they are loaded
340
result = self._partial_revision_id_to_revno_cache.get(revision_id)
341
if result is not None:
343
if self._revision_id_to_revno_cache:
344
result = self._revision_id_to_revno_cache.get(revision_id)
346
raise errors.NoSuchRevision(self, revision_id)
347
# Try the mainline as it's optimised
349
revno = self.revision_id_to_revno(revision_id)
351
except errors.NoSuchRevision:
352
# We need to load and use the full revno map after all
353
result = self.get_revision_id_to_revno_map().get(revision_id)
355
raise errors.NoSuchRevision(self, revision_id)
359
def get_revision_id_to_revno_map(self):
360
"""Return the revision_id => dotted revno map.
362
This will be regenerated on demand, but will be cached.
364
:return: A dictionary mapping revision_id => dotted revno.
365
This dictionary should not be modified by the caller.
367
if self._revision_id_to_revno_cache is not None:
368
mapping = self._revision_id_to_revno_cache
370
mapping = self._gen_revno_map()
371
self._cache_revision_id_to_revno(mapping)
372
# TODO: jam 20070417 Since this is being cached, should we be returning
374
# I would rather not, and instead just declare that users should not
375
# modify the return value.
378
def _gen_revno_map(self):
379
"""Create a new mapping from revision ids to dotted revnos.
381
Dotted revnos are generated based on the current tip in the revision
383
This is the worker function for get_revision_id_to_revno_map, which
384
just caches the return value.
386
:return: A dictionary mapping revision_id => dotted revno.
388
revision_id_to_revno = dict((rev_id, revno)
389
for rev_id, depth, revno, end_of_merge
390
in self.iter_merge_sorted_revisions())
391
return revision_id_to_revno
394
def iter_merge_sorted_revisions(self, start_revision_id=None,
395
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
396
"""Walk the revisions for a branch in merge sorted order.
398
Merge sorted order is the output from a merge-aware,
399
topological sort, i.e. all parents come before their
400
children going forward; the opposite for reverse.
402
:param start_revision_id: the revision_id to begin walking from.
403
If None, the branch tip is used.
404
:param stop_revision_id: the revision_id to terminate the walk
405
after. If None, the rest of history is included.
406
:param stop_rule: if stop_revision_id is not None, the precise rule
407
to use for termination:
408
* 'exclude' - leave the stop revision out of the result (default)
409
* 'include' - the stop revision is the last item in the result
410
* 'with-merges' - include the stop revision and all of its
411
merged revisions in the result
412
:param direction: either 'reverse' or 'forward':
413
* reverse means return the start_revision_id first, i.e.
414
start at the most recent revision and go backwards in history
415
* forward returns tuples in the opposite order to reverse.
416
Note in particular that forward does *not* do any intelligent
417
ordering w.r.t. depth as some clients of this API may like.
418
(If required, that ought to be done at higher layers.)
420
:return: an iterator over (revision_id, depth, revno, end_of_merge)
423
* revision_id: the unique id of the revision
424
* depth: How many levels of merging deep this node has been
426
* revno_sequence: This field provides a sequence of
427
revision numbers for all revisions. The format is:
428
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
429
branch that the revno is on. From left to right the REVNO numbers
430
are the sequence numbers within that branch of the revision.
431
* end_of_merge: When True the next node (earlier in history) is
432
part of a different merge.
434
# Note: depth and revno values are in the context of the branch so
435
# we need the full graph to get stable numbers, regardless of the
437
if self._merge_sorted_revisions_cache is None:
438
last_revision = self.last_revision()
439
graph = self.repository.get_graph()
440
parent_map = dict(((key, value) for key, value in
441
graph.iter_ancestry([last_revision]) if value is not None))
442
revision_graph = repository._strip_NULL_ghosts(parent_map)
443
revs = tsort.merge_sort(revision_graph, last_revision, None,
445
# Drop the sequence # before caching
446
self._merge_sorted_revisions_cache = [r[1:] for r in revs]
448
filtered = self._filter_merge_sorted_revisions(
449
self._merge_sorted_revisions_cache, start_revision_id,
450
stop_revision_id, stop_rule)
451
if direction == 'reverse':
453
if direction == 'forward':
454
return reversed(list(filtered))
456
raise ValueError('invalid direction %r' % direction)
458
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
459
start_revision_id, stop_revision_id, stop_rule):
460
"""Iterate over an inclusive range of sorted revisions."""
461
rev_iter = iter(merge_sorted_revisions)
462
if start_revision_id is not None:
463
for rev_id, depth, revno, end_of_merge in rev_iter:
464
if rev_id != start_revision_id:
467
# The decision to include the start or not
468
# depends on the stop_rule if a stop is provided
470
iter([(rev_id, depth, revno, end_of_merge)]),
473
if stop_revision_id is None:
474
for rev_id, depth, revno, end_of_merge in rev_iter:
475
yield rev_id, depth, revno, end_of_merge
476
elif stop_rule == 'exclude':
477
for rev_id, depth, revno, end_of_merge in rev_iter:
478
if rev_id == stop_revision_id:
480
yield rev_id, depth, revno, end_of_merge
481
elif stop_rule == 'include':
482
for rev_id, depth, revno, end_of_merge in rev_iter:
483
yield rev_id, depth, revno, end_of_merge
484
if rev_id == stop_revision_id:
486
elif stop_rule == 'with-merges':
487
stop_rev = self.repository.get_revision(stop_revision_id)
488
if stop_rev.parent_ids:
489
left_parent = stop_rev.parent_ids[0]
491
left_parent = _mod_revision.NULL_REVISION
492
for rev_id, depth, revno, end_of_merge in rev_iter:
493
if rev_id == left_parent:
495
yield rev_id, depth, revno, end_of_merge
497
raise ValueError('invalid stop_rule %r' % stop_rule)
499
def leave_lock_in_place(self):
500
"""Tell this branch object not to release the physical lock when this
503
If lock_write doesn't return a token, then this method is not supported.
505
self.control_files.leave_in_place()
507
def dont_leave_lock_in_place(self):
508
"""Tell this branch object to release the physical lock when this
509
object is unlocked, even if it didn't originally acquire it.
511
If lock_write doesn't return a token, then this method is not supported.
513
self.control_files.dont_leave_in_place()
515
def bind(self, other):
516
"""Bind the local branch the other branch.
518
:param other: The branch to bind to
521
raise errors.UpgradeRequired(self.base)
523
def set_append_revisions_only(self, enabled):
524
if not self._format.supports_set_append_revisions_only():
525
raise errors.UpgradeRequired(self.base)
530
self.get_config().set_user_option('append_revisions_only', value,
533
def set_reference_info(self, file_id, tree_path, branch_location):
534
"""Set the branch location to use for a tree reference."""
535
raise errors.UnsupportedOperation(self.set_reference_info, self)
537
def get_reference_info(self, file_id):
538
"""Get the tree_path and branch_location for a tree reference."""
539
raise errors.UnsupportedOperation(self.get_reference_info, self)
542
def fetch(self, from_branch, last_revision=None, pb=None):
543
"""Copy revisions from from_branch into this branch.
545
:param from_branch: Where to copy from.
546
:param last_revision: What revision to stop at (None for at the end
548
:param pb: An optional progress bar to use.
551
if self.base == from_branch.base:
554
symbol_versioning.warn(
555
symbol_versioning.deprecated_in((1, 14, 0))
556
% "pb parameter to fetch()")
557
from_branch.lock_read()
559
if last_revision is None:
560
last_revision = from_branch.last_revision()
561
last_revision = _mod_revision.ensure_null(last_revision)
562
return self.repository.fetch(from_branch.repository,
563
revision_id=last_revision,
568
def get_bound_location(self):
569
"""Return the URL of the branch we are bound to.
571
Older format branches cannot bind, please be sure to use a metadir
576
def get_old_bound_location(self):
577
"""Return the URL of the branch we used to be bound to
579
raise errors.UpgradeRequired(self.base)
581
def get_commit_builder(self, parents, config=None, timestamp=None,
582
timezone=None, committer=None, revprops=None,
584
"""Obtain a CommitBuilder for this branch.
586
:param parents: Revision ids of the parents of the new revision.
587
:param config: Optional configuration to use.
588
:param timestamp: Optional timestamp recorded for commit.
589
:param timezone: Optional timezone for timestamp.
590
:param committer: Optional committer to set for commit.
591
:param revprops: Optional dictionary of revision properties.
592
:param revision_id: Optional revision id.
596
config = self.get_config()
598
return self.repository.get_commit_builder(self, parents, config,
599
timestamp, timezone, committer, revprops, revision_id)
601
def get_master_branch(self, possible_transports=None):
602
"""Return the branch we are bound to.
604
:return: Either a Branch, or None
617
608
def get_revision_delta(self, revno):
618
609
"""Return the delta for one revision.
789
812
common_index = min(self_len, other_len) -1
790
813
if common_index >= 0 and \
791
814
self_history[common_index] != other_history[common_index]:
792
raise DivergedBranches(self, other)
815
raise errors.DivergedBranches(self, other)
794
817
if stop_revision is None:
795
818
stop_revision = other_len
796
elif stop_revision > other_len:
797
raise NoSuchRevision(self, stop_revision)
820
if stop_revision > other_len:
821
raise errors.NoSuchRevision(self, stop_revision)
799
822
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)
825
def update_revisions(self, other, stop_revision=None, overwrite=False,
827
"""Pull in new perfect-fit revisions.
829
:param other: Another Branch to pull from
830
:param stop_revision: Updated until the given revision
831
:param overwrite: Always set the branch pointer, rather than checking
832
to see if it is a proper descendant.
833
:param graph: A Graph object that can be used to query history
834
information. This can be None.
837
return InterBranch.get(other, self).update_revisions(stop_revision,
840
def import_last_revision_info(self, source_repo, revno, revid):
841
"""Set the last revision info, importing from another repo if necessary.
843
This is used by the bound branch code to upload a revision to
844
the master branch first before updating the tip of the local branch.
846
:param source_repo: Source repository to optionally fetch from
847
:param revno: Revision number of the new tip
848
:param revid: Revision id of the new tip
850
if not self.repository.has_same_location(source_repo):
851
self.repository.fetch(source_repo, revision_id=revid)
852
self.set_last_revision_info(revno, revid)
854
def revision_id_to_revno(self, revision_id):
855
"""Given a revision id, return its revno"""
856
if _mod_revision.is_null(revision_id):
858
history = self.revision_history()
860
return history.index(revision_id) + 1
893
861
except ValueError:
862
raise errors.NoSuchRevision(self, revision_id)
865
def get_rev_id(self, revno, history=None):
866
"""Find the revision id of the specified revno."""
868
return _mod_revision.NULL_REVISION
869
last_revno, last_revid = self.last_revision_info()
870
if revno == last_revno:
872
if revno <= 0 or revno > last_revno:
873
raise errors.NoSuchRevision(self, revno)
874
distance_from_last = last_revno - revno
875
if len(self._partial_revision_history_cache) <= distance_from_last:
876
self._extend_partial_history(distance_from_last)
877
return self._partial_revision_history_cache[distance_from_last]
880
def pull(self, source, overwrite=False, stop_revision=None,
881
possible_transports=None, *args, **kwargs):
882
"""Mirror source into this branch.
884
This branch is considered to be 'local', having low latency.
886
:returns: PullResult instance
888
return InterBranch.get(source, self).pull(overwrite=overwrite,
889
stop_revision=stop_revision,
890
possible_transports=possible_transports, *args, **kwargs)
892
def push(self, target, overwrite=False, stop_revision=None, *args,
894
"""Mirror this branch into target.
896
This branch is considered to be 'local', having low latency.
898
return InterBranch.get(self, target).push(overwrite, stop_revision,
901
def lossy_push(self, target, stop_revision=None):
902
"""Push deltas into another branch.
904
:note: This does not, like push, retain the revision ids from
905
the source branch and will, rather than adding bzr-specific
906
metadata, push only those semantics of the revision that can be
907
natively represented by this branch' VCS.
909
:param target: Target branch
910
:param stop_revision: Revision to push, defaults to last revision.
911
:return: BranchPushResult with an extra member revidmap:
912
A dictionary mapping revision ids from the target branch
913
to new revision ids in the target branch, for each
914
revision that was pushed.
916
inter = InterBranch.get(self, target)
917
lossy_push = getattr(inter, "lossy_push", None)
918
if lossy_push is None:
919
raise errors.LossyPushToSameVCS(self, target)
920
return lossy_push(stop_revision)
922
def basis_tree(self):
923
"""Return `Tree` object for last revision."""
924
return self.repository.revision_tree(self.last_revision())
926
def get_parent(self):
927
"""Return the parent location of the branch.
929
This is the default location for pull/missing. The usual
930
pattern is that the user can override it by specifying a
933
parent = self._get_parent_location()
936
# This is an old-format absolute path to a local branch
938
if parent.startswith('/'):
939
parent = urlutils.local_path_to_url(parent.decode('utf8'))
941
return urlutils.join(self.base[:-1], parent)
942
except errors.InvalidURLJoin, e:
943
raise errors.InaccessibleParent(parent, self.base)
945
def _get_parent_location(self):
946
raise NotImplementedError(self._get_parent_location)
948
def _set_config_location(self, name, url, config=None,
949
make_relative=False):
951
config = self.get_config()
955
url = urlutils.relative_url(self.base, url)
956
config.set_user_option(name, url, warn_masked=True)
958
def _get_config_location(self, name, config=None):
960
config = self.get_config()
961
location = config.get_user_option(name)
966
def get_child_submit_format(self):
967
"""Return the preferred format of submissions to this branch."""
968
return self.get_config().get_user_option("child_submit_format")
970
def get_submit_branch(self):
971
"""Return the submit location of the branch.
973
This is the default location for bundle. The usual
974
pattern is that the user can override it by specifying a
977
return self.get_config().get_user_option('submit_branch')
979
def set_submit_branch(self, location):
980
"""Return the submit location of the branch.
982
This is the default location for bundle. The usual
983
pattern is that the user can override it by specifying a
986
self.get_config().set_user_option('submit_branch', location,
989
def get_public_branch(self):
990
"""Return the public location of the branch.
992
This is used by merge directives.
994
return self._get_config_location('public_branch')
996
def set_public_branch(self, location):
997
"""Return the submit location of the branch.
999
This is the default location for bundle. The usual
1000
pattern is that the user can override it by specifying a
1003
self._set_config_location('public_branch', location)
1005
def get_push_location(self):
1006
"""Return the None or the location to push this branch to."""
1007
push_loc = self.get_config().get_user_option('push_location')
1010
def set_push_location(self, location):
1011
"""Set a new push location for this branch."""
1012
raise NotImplementedError(self.set_push_location)
1014
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1015
"""Run the post_change_branch_tip hooks."""
1016
hooks = Branch.hooks['post_change_branch_tip']
1019
new_revno, new_revid = self.last_revision_info()
1020
params = ChangeBranchTipParams(
1021
self, old_revno, new_revno, old_revid, new_revid)
1025
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
1026
"""Run the pre_change_branch_tip hooks."""
1027
hooks = Branch.hooks['pre_change_branch_tip']
1030
old_revno, old_revid = self.last_revision_info()
1031
params = ChangeBranchTipParams(
1032
self, old_revno, new_revno, old_revid, new_revid)
1036
except errors.TipChangeRejected:
1039
exc_info = sys.exc_info()
1040
hook_name = Branch.hooks.get_hook_name(hook)
1041
raise errors.HookFailed(
1042
'pre_change_branch_tip', hook_name, exc_info)
1046
"""Synchronise this branch with the master branch if any.
1048
:return: None or the last_revision pivoted out during the update.
1052
def check_revno(self, revno):
1054
Check whether a revno corresponds to any revision.
1055
Zero (the NULL revision) is considered valid.
1058
self.check_real_revno(revno)
1060
def check_real_revno(self, revno):
1062
Check whether a revno corresponds to a real revision.
1063
Zero (the NULL revision) is considered invalid
1065
if revno < 1 or revno > self.revno():
1066
raise errors.InvalidRevisionNumber(revno)
1069
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
1070
"""Clone this branch into to_bzrdir preserving all semantic values.
1072
Most API users will want 'create_clone_on_transport', which creates a
1073
new bzrdir and branch on the fly.
1075
revision_id: if not None, the revision history in the new branch will
1076
be truncated to end with revision_id.
1078
result = to_bzrdir.create_branch()
1081
if repository_policy is not None:
1082
repository_policy.configure_branch(result)
1083
self.copy_content_into(result, revision_id=revision_id)
1089
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
1090
"""Create a new line of development from the branch, into to_bzrdir.
1092
to_bzrdir controls the branch format.
1094
revision_id: if not None, the revision history in the new branch will
1095
be truncated to end with revision_id.
1097
result = to_bzrdir.create_branch()
1100
if repository_policy is not None:
1101
repository_policy.configure_branch(result)
1102
self.copy_content_into(result, revision_id=revision_id)
1103
result.set_parent(self.bzrdir.root_transport.base)
1108
def _synchronize_history(self, destination, revision_id):
1109
"""Synchronize last revision and revision history between branches.
1111
This version is most efficient when the destination is also a
1112
BzrBranch6, but works for BzrBranch5, as long as the destination's
1113
repository contains all the lefthand ancestors of the intended
1114
last_revision. If not, set_last_revision_info will fail.
1116
:param destination: The branch to copy the history into
1117
:param revision_id: The revision-id to truncate history at. May
1118
be None to copy complete history.
1120
source_revno, source_revision_id = self.last_revision_info()
1121
if revision_id is None:
1122
revno, revision_id = source_revno, source_revision_id
1124
graph = self.repository.get_graph()
1126
revno = graph.find_distance_to_null(revision_id,
1127
[(source_revision_id, source_revno)])
1128
except errors.GhostRevisionsHaveNoRevno:
1129
# Default to 1, if we can't find anything else
1131
destination.set_last_revision_info(revno, revision_id)
1134
def copy_content_into(self, destination, revision_id=None):
1135
"""Copy the content of self into destination.
1137
revision_id: if not None, the revision history in the new branch will
1138
be truncated to end with revision_id.
1140
self.update_references(destination)
1141
self._synchronize_history(destination, revision_id)
1143
parent = self.get_parent()
1144
except errors.InaccessibleParent, e:
1145
mutter('parent was not accessible to copy: %s', e)
1148
destination.set_parent(parent)
1149
if self._push_should_merge_tags():
1150
self.tags.merge_to(destination.tags)
1152
def update_references(self, target):
1153
if not getattr(self._format, 'supports_reference_locations', False):
1155
reference_dict = self._get_all_reference_info()
1156
if len(reference_dict) == 0:
1158
old_base = self.base
1159
new_base = target.base
1160
target_reference_dict = target._get_all_reference_info()
1161
for file_id, (tree_path, branch_location) in (
1162
reference_dict.items()):
1163
branch_location = urlutils.rebase_url(branch_location,
1165
target_reference_dict.setdefault(
1166
file_id, (tree_path, branch_location))
1167
target._set_all_reference_info(target_reference_dict)
1171
"""Check consistency of the branch.
1173
In particular this checks that revisions given in the revision-history
1174
do actually match up in the revision graph, and that they're all
1175
present in the repository.
1177
Callers will typically also want to check the repository.
1179
:return: A BranchCheckResult.
1181
ret = BranchCheckResult(self)
1182
mainline_parent_id = None
1183
last_revno, last_revision_id = self.last_revision_info()
1184
real_rev_history = []
1186
for revid in self.repository.iter_reverse_revision_history(
1188
real_rev_history.append(revid)
1189
except errors.RevisionNotPresent:
1190
ret.ghosts_in_mainline = True
1192
ret.ghosts_in_mainline = False
1193
real_rev_history.reverse()
1194
if len(real_rev_history) != last_revno:
1195
raise errors.BzrCheckError('revno does not match len(mainline)'
1196
' %s != %s' % (last_revno, len(real_rev_history)))
1197
# TODO: We should probably also check that real_rev_history actually
1198
# matches self.revision_history()
1199
for revision_id in real_rev_history:
1201
revision = self.repository.get_revision(revision_id)
1202
except errors.NoSuchRevision, e:
1203
raise errors.BzrCheckError("mainline revision {%s} not in repository"
1205
# In general the first entry on the revision history has no parents.
1206
# But it's not illegal for it to have parents listed; this can happen
1207
# in imports from Arch when the parents weren't reachable.
1208
if mainline_parent_id is not None:
1209
if mainline_parent_id not in revision.parent_ids:
1210
raise errors.BzrCheckError("previous revision {%s} not listed among "
1212
% (mainline_parent_id, revision_id))
1213
mainline_parent_id = revision_id
1216
def _get_checkout_format(self):
1217
"""Return the most suitable metadir for a checkout of this branch.
1218
Weaves are used if this branch's repository uses weaves.
1220
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1221
from bzrlib.repofmt import weaverepo
1222
format = bzrdir.BzrDirMetaFormat1()
1223
format.repository_format = weaverepo.RepositoryFormat7()
1225
format = self.repository.bzrdir.checkout_metadir()
1226
format.set_branch_format(self._format)
1229
def create_clone_on_transport(self, to_transport, revision_id=None,
1230
stacked_on=None, create_prefix=False, use_existing_dir=False):
1231
"""Create a clone of this branch and its bzrdir.
1233
:param to_transport: The transport to clone onto.
1234
:param revision_id: The revision id to use as tip in the new branch.
1235
If None the tip is obtained from this branch.
1236
:param stacked_on: An optional URL to stack the clone on.
1237
:param create_prefix: Create any missing directories leading up to
1239
:param use_existing_dir: Use an existing directory if one exists.
1241
# XXX: Fix the bzrdir API to allow getting the branch back from the
1242
# clone call. Or something. 20090224 RBC/spiv.
1243
if revision_id is None:
1244
revision_id = self.last_revision()
1246
dir_to = self.bzrdir.clone_on_transport(to_transport,
1247
revision_id=revision_id, stacked_on=stacked_on,
1248
create_prefix=create_prefix, use_existing_dir=use_existing_dir)
1249
except errors.FileExists:
1250
if not use_existing_dir:
1252
except errors.NoSuchFile:
1253
if not create_prefix:
1255
return dir_to.open_branch()
1257
def create_checkout(self, to_location, revision_id=None,
1258
lightweight=False, accelerator_tree=None,
1260
"""Create a checkout of a branch.
1262
:param to_location: The url to produce the checkout at
1263
:param revision_id: The revision to check out
1264
:param lightweight: If True, produce a lightweight checkout, otherwise,
1265
produce a bound branch (heavyweight checkout)
1266
:param accelerator_tree: A tree which can be used for retrieving file
1267
contents more quickly than the revision tree, i.e. a workingtree.
1268
The revision tree will be used for cases where accelerator_tree's
1269
content is different.
1270
:param hardlink: If true, hard-link files from accelerator_tree,
1272
:return: The tree of the created checkout
1274
t = transport.get_transport(to_location)
1277
format = self._get_checkout_format()
1278
checkout = format.initialize_on_transport(t)
1279
from_branch = BranchReferenceFormat().initialize(checkout, self)
1281
format = self._get_checkout_format()
1282
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1283
to_location, force_new_tree=False, format=format)
1284
checkout = checkout_branch.bzrdir
1285
checkout_branch.bind(self)
1286
# pull up to the specified revision_id to set the initial
1287
# branch tip correctly, and seed it with history.
1288
checkout_branch.pull(self, stop_revision=revision_id)
1290
tree = checkout.create_workingtree(revision_id,
1291
from_branch=from_branch,
1292
accelerator_tree=accelerator_tree,
1294
basis_tree = tree.basis_tree()
1295
basis_tree.lock_read()
1297
for path, file_id in basis_tree.iter_references():
1298
reference_parent = self.reference_parent(file_id, path)
1299
reference_parent.create_checkout(tree.abspath(path),
1300
basis_tree.get_reference_revision(file_id, path),
1307
def reconcile(self, thorough=True):
1308
"""Make sure the data stored in this branch is consistent."""
1309
from bzrlib.reconcile import BranchReconciler
1310
reconciler = BranchReconciler(self, thorough=thorough)
1311
reconciler.reconcile()
1314
def reference_parent(self, file_id, path, possible_transports=None):
1315
"""Return the parent branch for a tree-reference file_id
1316
:param file_id: The file_id of the tree reference
1317
:param path: The path of the file_id in the tree
1318
:return: A branch associated with the file_id
1320
# FIXME should provide multiple branches, based on config
1321
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1322
possible_transports=possible_transports)
1324
def supports_tags(self):
1325
return self._format.supports_tags()
1327
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1329
"""Ensure that revision_b is a descendant of revision_a.
1331
This is a helper function for update_revisions.
1333
:raises: DivergedBranches if revision_b has diverged from revision_a.
1334
:returns: True if revision_b is a descendant of revision_a.
1336
relation = self._revision_relations(revision_a, revision_b, graph)
1337
if relation == 'b_descends_from_a':
1339
elif relation == 'diverged':
1340
raise errors.DivergedBranches(self, other_branch)
1341
elif relation == 'a_descends_from_b':
1344
raise AssertionError("invalid relation: %r" % (relation,))
1346
def _revision_relations(self, revision_a, revision_b, graph):
1347
"""Determine the relationship between two revisions.
1349
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1351
heads = graph.heads([revision_a, revision_b])
1352
if heads == set([revision_b]):
1353
return 'b_descends_from_a'
1354
elif heads == set([revision_a, revision_b]):
1355
# These branches have diverged
1357
elif heads == set([revision_a]):
1358
return 'a_descends_from_b'
1360
raise AssertionError("invalid heads: %r" % (heads,))
1363
class BranchFormat(object):
1364
"""An encapsulation of the initialization and open routines for a format.
1366
Formats provide three things:
1367
* An initialization routine,
1371
Formats are placed in an dict by their format string for reference
1372
during branch opening. Its not required that these be instances, they
1373
can be classes themselves with class methods - it simply depends on
1374
whether state is needed for a given format or not.
1376
Once a format is deprecated, just deprecate the initialize and open
1377
methods on the format class. Do not deprecate the object, as the
1378
object will be created every time regardless.
1381
_default_format = None
1382
"""The default format used for new branches."""
1385
"""The known formats."""
1387
can_set_append_revisions_only = True
1389
def __eq__(self, other):
1390
return self.__class__ is other.__class__
1392
def __ne__(self, other):
1393
return not (self == other)
1396
def find_format(klass, a_bzrdir):
1397
"""Return the format for the branch object in a_bzrdir."""
1399
transport = a_bzrdir.get_branch_transport(None)
1400
format_string = transport.get("format").read()
1401
return klass._formats[format_string]
1402
except errors.NoSuchFile:
1403
raise errors.NotBranchError(path=transport.base)
1405
raise errors.UnknownFormatError(format=format_string, kind='branch')
1408
def get_default_format(klass):
1409
"""Return the current default format."""
1410
return klass._default_format
1412
def get_reference(self, a_bzrdir):
1413
"""Get the target reference of the branch in a_bzrdir.
1415
format probing must have been completed before calling
1416
this method - it is assumed that the format of the branch
1417
in a_bzrdir is correct.
1419
:param a_bzrdir: The bzrdir to get the branch data from.
1420
:return: None if the branch is not a reference branch.
1425
def set_reference(self, a_bzrdir, to_branch):
1426
"""Set the target reference of the branch in a_bzrdir.
1428
format probing must have been completed before calling
1429
this method - it is assumed that the format of the branch
1430
in a_bzrdir is correct.
1432
:param a_bzrdir: The bzrdir to set the branch reference for.
1433
:param to_branch: branch that the checkout is to reference
1435
raise NotImplementedError(self.set_reference)
1437
def get_format_string(self):
1438
"""Return the ASCII format string that identifies this format."""
1439
raise NotImplementedError(self.get_format_string)
1441
def get_format_description(self):
1442
"""Return the short format description for this format."""
1443
raise NotImplementedError(self.get_format_description)
1445
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
1447
"""Initialize a branch in a bzrdir, with specified files
1449
:param a_bzrdir: The bzrdir to initialize the branch in
1450
:param utf8_files: The files to create as a list of
1451
(filename, content) tuples
1452
:param set_format: If True, set the format with
1453
self.get_format_string. (BzrBranch4 has its format set
1455
:return: a branch in this format
1457
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1458
branch_transport = a_bzrdir.get_branch_transport(self)
1460
'metadir': ('lock', lockdir.LockDir),
1461
'branch4': ('branch-lock', lockable_files.TransportLock),
1463
lock_name, lock_class = lock_map[lock_type]
1464
control_files = lockable_files.LockableFiles(branch_transport,
1465
lock_name, lock_class)
1466
control_files.create_lock()
1468
control_files.lock_write()
1469
except errors.LockContention:
1470
if lock_type != 'branch4':
1476
utf8_files += [('format', self.get_format_string())]
1478
for (filename, content) in utf8_files:
1479
branch_transport.put_bytes(
1481
mode=a_bzrdir._get_file_mode())
1484
control_files.unlock()
1485
return self.open(a_bzrdir, _found=True)
1487
def initialize(self, a_bzrdir):
1488
"""Create a branch of this format in a_bzrdir."""
1489
raise NotImplementedError(self.initialize)
1491
def is_supported(self):
1492
"""Is this format supported?
1494
Supported formats can be initialized and opened.
1495
Unsupported formats may not support initialization or committing or
1496
some other features depending on the reason for not being supported.
1500
def make_tags(self, branch):
1501
"""Create a tags object for branch.
1503
This method is on BranchFormat, because BranchFormats are reflected
1504
over the wire via network_name(), whereas full Branch instances require
1505
multiple VFS method calls to operate at all.
1507
The default implementation returns a disabled-tags instance.
1509
Note that it is normal for branch to be a RemoteBranch when using tags
1512
return DisabledTags(branch)
1514
def network_name(self):
1515
"""A simple byte string uniquely identifying this format for RPC calls.
1517
MetaDir branch formats use their disk format string to identify the
1518
repository over the wire. All in one formats such as bzr < 0.8, and
1519
foreign formats like svn/git and hg should use some marker which is
1520
unique and immutable.
1522
raise NotImplementedError(self.network_name)
1524
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1525
"""Return the branch object for a_bzrdir
1527
:param a_bzrdir: A BzrDir that contains a branch.
1528
:param _found: a private parameter, do not use it. It is used to
1529
indicate if format probing has already be done.
1530
:param ignore_fallbacks: when set, no fallback branches will be opened
1531
(if there are any). Default is to open fallbacks.
1533
raise NotImplementedError(self.open)
1536
def register_format(klass, format):
1537
"""Register a metadir format."""
1538
klass._formats[format.get_format_string()] = format
1539
# Metadir formats have a network name of their format string, and get
1540
# registered as class factories.
1541
network_format_registry.register(format.get_format_string(), format.__class__)
1544
def set_default_format(klass, format):
1545
klass._default_format = format
1547
def supports_set_append_revisions_only(self):
1548
"""True if this format supports set_append_revisions_only."""
1551
def supports_stacking(self):
1552
"""True if this format records a stacked-on branch."""
1556
def unregister_format(klass, format):
1557
del klass._formats[format.get_format_string()]
1560
return self.get_format_description().rstrip()
1562
def supports_tags(self):
1563
"""True if this format supports tags stored in the branch"""
1564
return False # by default
1567
class BranchHooks(Hooks):
1568
"""A dictionary mapping hook name to a list of callables for branch hooks.
1570
e.g. ['set_rh'] Is the list of items to be called when the
1571
set_revision_history function is invoked.
1575
"""Create the default hooks.
1577
These are all empty initially, because by default nothing should get
1580
Hooks.__init__(self)
1581
self.create_hook(HookPoint('set_rh',
1582
"Invoked whenever the revision history has been set via "
1583
"set_revision_history. The api signature is (branch, "
1584
"revision_history), and the branch will be write-locked. "
1585
"The set_rh hook can be expensive for bzr to trigger, a better "
1586
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1587
self.create_hook(HookPoint('open',
1588
"Called with the Branch object that has been opened after a "
1589
"branch is opened.", (1, 8), None))
1590
self.create_hook(HookPoint('post_push',
1591
"Called after a push operation completes. post_push is called "
1592
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1593
"bzr client.", (0, 15), None))
1594
self.create_hook(HookPoint('post_pull',
1595
"Called after a pull operation completes. post_pull is called "
1596
"with a bzrlib.branch.PullResult object and only runs in the "
1597
"bzr client.", (0, 15), None))
1598
self.create_hook(HookPoint('pre_commit',
1599
"Called after a commit is calculated but before it is is "
1600
"completed. pre_commit is called with (local, master, old_revno, "
1601
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1602
"). old_revid is NULL_REVISION for the first commit to a branch, "
1603
"tree_delta is a TreeDelta object describing changes from the "
1604
"basis revision. hooks MUST NOT modify this delta. "
1605
" future_tree is an in-memory tree obtained from "
1606
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1607
"tree.", (0,91), None))
1608
self.create_hook(HookPoint('post_commit',
1609
"Called in the bzr client after a commit has completed. "
1610
"post_commit is called with (local, master, old_revno, old_revid, "
1611
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1612
"commit to a branch.", (0, 15), None))
1613
self.create_hook(HookPoint('post_uncommit',
1614
"Called in the bzr client after an uncommit completes. "
1615
"post_uncommit is called with (local, master, old_revno, "
1616
"old_revid, new_revno, new_revid) where local is the local branch "
1617
"or None, master is the target branch, and an empty branch "
1618
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1619
self.create_hook(HookPoint('pre_change_branch_tip',
1620
"Called in bzr client and server before a change to the tip of a "
1621
"branch is made. pre_change_branch_tip is called with a "
1622
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1623
"commit, uncommit will all trigger this hook.", (1, 6), None))
1624
self.create_hook(HookPoint('post_change_branch_tip',
1625
"Called in bzr client and server after a change to the tip of a "
1626
"branch is made. post_change_branch_tip is called with a "
1627
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1628
"commit, uncommit will all trigger this hook.", (1, 4), None))
1629
self.create_hook(HookPoint('transform_fallback_location',
1630
"Called when a stacked branch is activating its fallback "
1631
"locations. transform_fallback_location is called with (branch, "
1632
"url), and should return a new url. Returning the same url "
1633
"allows it to be used as-is, returning a different one can be "
1634
"used to cause the branch to stack on a closer copy of that "
1635
"fallback_location. Note that the branch cannot have history "
1636
"accessing methods called on it during this hook because the "
1637
"fallback locations have not been activated. When there are "
1638
"multiple hooks installed for transform_fallback_location, "
1639
"all are called with the url returned from the previous hook."
1640
"The order is however undefined.", (1, 9), None))
1643
# install the default hooks into the Branch class.
1644
Branch.hooks = BranchHooks()
1647
class ChangeBranchTipParams(object):
1648
"""Object holding parameters passed to *_change_branch_tip hooks.
1650
There are 5 fields that hooks may wish to access:
1652
:ivar branch: the branch being changed
1653
:ivar old_revno: revision number before the change
1654
:ivar new_revno: revision number after the change
1655
:ivar old_revid: revision id before the change
1656
:ivar new_revid: revision id after the change
1658
The revid fields are strings. The revno fields are integers.
1661
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1662
"""Create a group of ChangeBranchTip parameters.
1664
:param branch: The branch being changed.
1665
:param old_revno: Revision number before the change.
1666
:param new_revno: Revision number after the change.
1667
:param old_revid: Tip revision id before the change.
1668
:param new_revid: Tip revision id after the change.
1670
self.branch = branch
1671
self.old_revno = old_revno
1672
self.new_revno = new_revno
1673
self.old_revid = old_revid
1674
self.new_revid = new_revid
1676
def __eq__(self, other):
1677
return self.__dict__ == other.__dict__
1680
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1681
self.__class__.__name__, self.branch,
1682
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1685
class BzrBranchFormat4(BranchFormat):
1686
"""Bzr branch format 4.
1689
- a revision-history file.
1690
- a branch-lock lock file [ to be shared with the bzrdir ]
1693
def get_format_description(self):
1694
"""See BranchFormat.get_format_description()."""
1695
return "Branch format 4"
1697
def initialize(self, a_bzrdir):
1698
"""Create a branch of this format in a_bzrdir."""
1699
utf8_files = [('revision-history', ''),
1700
('branch-name', ''),
1702
return self._initialize_helper(a_bzrdir, utf8_files,
1703
lock_type='branch4', set_format=False)
1706
super(BzrBranchFormat4, self).__init__()
1707
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1709
def network_name(self):
1710
"""The network name for this format is the control dirs disk label."""
1711
return self._matchingbzrdir.get_format_string()
1713
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1714
"""See BranchFormat.open()."""
1716
# we are being called directly and must probe.
1717
raise NotImplementedError
1718
return BzrBranch(_format=self,
1719
_control_files=a_bzrdir._control_files,
1721
_repository=a_bzrdir.open_repository())
1724
return "Bazaar-NG branch format 4"
1727
class BranchFormatMetadir(BranchFormat):
1728
"""Common logic for meta-dir based branch formats."""
1730
def _branch_class(self):
1731
"""What class to instantiate on open calls."""
1732
raise NotImplementedError(self._branch_class)
1734
def network_name(self):
1735
"""A simple byte string uniquely identifying this format for RPC calls.
1737
Metadir branch formats use their format string.
1739
return self.get_format_string()
1741
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1742
"""See BranchFormat.open()."""
1744
format = BranchFormat.find_format(a_bzrdir)
1745
if format.__class__ != self.__class__:
1746
raise AssertionError("wrong format %r found for %r" %
1749
transport = a_bzrdir.get_branch_transport(None)
1750
control_files = lockable_files.LockableFiles(transport, 'lock',
1752
return self._branch_class()(_format=self,
1753
_control_files=control_files,
1755
_repository=a_bzrdir.find_repository(),
1756
ignore_fallbacks=ignore_fallbacks)
1757
except errors.NoSuchFile:
1758
raise errors.NotBranchError(path=transport.base)
1761
super(BranchFormatMetadir, self).__init__()
1762
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1763
self._matchingbzrdir.set_branch_format(self)
1765
def supports_tags(self):
1769
class BzrBranchFormat5(BranchFormatMetadir):
1770
"""Bzr branch format 5.
1773
- a revision-history file.
1775
- a lock dir guarding the branch itself
1776
- all of this stored in a branch/ subdirectory
1777
- works with shared repositories.
1779
This format is new in bzr 0.8.
1782
def _branch_class(self):
1785
def get_format_string(self):
1786
"""See BranchFormat.get_format_string()."""
1787
return "Bazaar-NG branch format 5\n"
1789
def get_format_description(self):
1790
"""See BranchFormat.get_format_description()."""
1791
return "Branch format 5"
1793
def initialize(self, a_bzrdir):
1794
"""Create a branch of this format in a_bzrdir."""
1795
utf8_files = [('revision-history', ''),
1796
('branch-name', ''),
1798
return self._initialize_helper(a_bzrdir, utf8_files)
1800
def supports_tags(self):
1804
class BzrBranchFormat6(BranchFormatMetadir):
1805
"""Branch format with last-revision and tags.
1807
Unlike previous formats, this has no explicit revision history. Instead,
1808
this just stores the last-revision, and the left-hand history leading
1809
up to there is the history.
1811
This format was introduced in bzr 0.15
1812
and became the default in 0.91.
1815
def _branch_class(self):
1818
def get_format_string(self):
1819
"""See BranchFormat.get_format_string()."""
1820
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1822
def get_format_description(self):
1823
"""See BranchFormat.get_format_description()."""
1824
return "Branch format 6"
1826
def initialize(self, a_bzrdir):
1827
"""Create a branch of this format in a_bzrdir."""
1828
utf8_files = [('last-revision', '0 null:\n'),
1829
('branch.conf', ''),
1832
return self._initialize_helper(a_bzrdir, utf8_files)
1834
def make_tags(self, branch):
1835
"""See bzrlib.branch.BranchFormat.make_tags()."""
1836
return BasicTags(branch)
1838
def supports_set_append_revisions_only(self):
1842
class BzrBranchFormat8(BranchFormatMetadir):
1843
"""Metadir format supporting storing locations of subtree branches."""
1845
def _branch_class(self):
1848
def get_format_string(self):
1849
"""See BranchFormat.get_format_string()."""
1850
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
1852
def get_format_description(self):
1853
"""See BranchFormat.get_format_description()."""
1854
return "Branch format 8"
1856
def initialize(self, a_bzrdir):
1857
"""Create a branch of this format in a_bzrdir."""
1858
utf8_files = [('last-revision', '0 null:\n'),
1859
('branch.conf', ''),
1863
return self._initialize_helper(a_bzrdir, utf8_files)
1866
super(BzrBranchFormat8, self).__init__()
1867
self._matchingbzrdir.repository_format = \
1868
RepositoryFormatKnitPack5RichRoot()
1870
def make_tags(self, branch):
1871
"""See bzrlib.branch.BranchFormat.make_tags()."""
1872
return BasicTags(branch)
1874
def supports_set_append_revisions_only(self):
1877
def supports_stacking(self):
1880
supports_reference_locations = True
1883
class BzrBranchFormat7(BzrBranchFormat8):
1884
"""Branch format with last-revision, tags, and a stacked location pointer.
1886
The stacked location pointer is passed down to the repository and requires
1887
a repository format with supports_external_lookups = True.
1889
This format was introduced in bzr 1.6.
1892
def initialize(self, a_bzrdir):
1893
"""Create a branch of this format in a_bzrdir."""
1894
utf8_files = [('last-revision', '0 null:\n'),
1895
('branch.conf', ''),
1898
return self._initialize_helper(a_bzrdir, utf8_files)
1900
def _branch_class(self):
1903
def get_format_string(self):
1904
"""See BranchFormat.get_format_string()."""
1905
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
1907
def get_format_description(self):
1908
"""See BranchFormat.get_format_description()."""
1909
return "Branch format 7"
1911
def supports_set_append_revisions_only(self):
1914
supports_reference_locations = False
1917
class BranchReferenceFormat(BranchFormat):
1918
"""Bzr branch reference format.
1920
Branch references are used in implementing checkouts, they
1921
act as an alias to the real branch which is at some other url.
1928
def get_format_string(self):
1929
"""See BranchFormat.get_format_string()."""
1930
return "Bazaar-NG Branch Reference Format 1\n"
1932
def get_format_description(self):
1933
"""See BranchFormat.get_format_description()."""
1934
return "Checkout reference format 1"
1936
def get_reference(self, a_bzrdir):
1937
"""See BranchFormat.get_reference()."""
1938
transport = a_bzrdir.get_branch_transport(None)
1939
return transport.get('location').read()
1941
def set_reference(self, a_bzrdir, to_branch):
1942
"""See BranchFormat.set_reference()."""
1943
transport = a_bzrdir.get_branch_transport(None)
1944
location = transport.put_bytes('location', to_branch.base)
1946
def initialize(self, a_bzrdir, target_branch=None):
1947
"""Create a branch of this format in a_bzrdir."""
1948
if target_branch is None:
1949
# this format does not implement branch itself, thus the implicit
1950
# creation contract must see it as uninitializable
1951
raise errors.UninitializableFormat(self)
1952
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1953
branch_transport = a_bzrdir.get_branch_transport(self)
1954
branch_transport.put_bytes('location',
1955
target_branch.bzrdir.root_transport.base)
1956
branch_transport.put_bytes('format', self.get_format_string())
1958
a_bzrdir, _found=True,
1959
possible_transports=[target_branch.bzrdir.root_transport])
1962
super(BranchReferenceFormat, self).__init__()
1963
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1964
self._matchingbzrdir.set_branch_format(self)
1966
def _make_reference_clone_function(format, a_branch):
1967
"""Create a clone() routine for a branch dynamically."""
1968
def clone(to_bzrdir, revision_id=None,
1969
repository_policy=None):
1970
"""See Branch.clone()."""
1971
return format.initialize(to_bzrdir, a_branch)
1972
# cannot obey revision_id limits when cloning a reference ...
1973
# FIXME RBC 20060210 either nuke revision_id for clone, or
1974
# emit some sort of warning/error to the caller ?!
1977
def open(self, a_bzrdir, _found=False, location=None,
1978
possible_transports=None, ignore_fallbacks=False):
1979
"""Return the branch that the branch reference in a_bzrdir points at.
1981
:param a_bzrdir: A BzrDir that contains a branch.
1982
:param _found: a private parameter, do not use it. It is used to
1983
indicate if format probing has already be done.
1984
:param ignore_fallbacks: when set, no fallback branches will be opened
1985
(if there are any). Default is to open fallbacks.
1986
:param location: The location of the referenced branch. If
1987
unspecified, this will be determined from the branch reference in
1989
:param possible_transports: An optional reusable transports list.
1992
format = BranchFormat.find_format(a_bzrdir)
1993
if format.__class__ != self.__class__:
1994
raise AssertionError("wrong format %r found for %r" %
1996
if location is None:
1997
location = self.get_reference(a_bzrdir)
1998
real_bzrdir = bzrdir.BzrDir.open(
1999
location, possible_transports=possible_transports)
2000
result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
2001
# this changes the behaviour of result.clone to create a new reference
2002
# rather than a copy of the content of the branch.
2003
# I did not use a proxy object because that needs much more extensive
2004
# testing, and we are only changing one behaviour at the moment.
2005
# If we decide to alter more behaviours - i.e. the implicit nickname
2006
# then this should be refactored to introduce a tested proxy branch
2007
# and a subclass of that for use in overriding clone() and ....
2009
result.clone = self._make_reference_clone_function(result)
2013
network_format_registry = registry.FormatRegistry()
2014
"""Registry of formats indexed by their network name.
2016
The network name for a branch format is an identifier that can be used when
2017
referring to formats with smart server operations. See
2018
BranchFormat.network_name() for more detail.
2022
# formats which have no format string are not discoverable
2023
# and not independently creatable, so are not registered.
2024
__format5 = BzrBranchFormat5()
2025
__format6 = BzrBranchFormat6()
2026
__format7 = BzrBranchFormat7()
2027
__format8 = BzrBranchFormat8()
2028
BranchFormat.register_format(__format5)
2029
BranchFormat.register_format(BranchReferenceFormat())
2030
BranchFormat.register_format(__format6)
2031
BranchFormat.register_format(__format7)
2032
BranchFormat.register_format(__format8)
2033
BranchFormat.set_default_format(__format6)
2034
_legacy_formats = [BzrBranchFormat4(),
2036
network_format_registry.register(
2037
_legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2040
class BzrBranch(Branch):
2041
"""A branch stored in the actual filesystem.
2043
Note that it's "local" in the context of the filesystem; it doesn't
2044
really matter if it's on an nfs/smb/afs/coda/... share, as long as
2045
it's writable, and can be accessed via the normal filesystem API.
2047
:ivar _transport: Transport for file operations on this branch's
2048
control files, typically pointing to the .bzr/branch directory.
2049
:ivar repository: Repository for this branch.
2050
:ivar base: The url of the base directory for this branch; the one
2051
containing the .bzr directory.
2054
def __init__(self, _format=None,
2055
_control_files=None, a_bzrdir=None, _repository=None,
2056
ignore_fallbacks=False):
2057
"""Create new branch object at a particular location."""
2058
if a_bzrdir is None:
2059
raise ValueError('a_bzrdir must be supplied')
2061
self.bzrdir = a_bzrdir
2062
self._base = self.bzrdir.transport.clone('..').base
2063
# XXX: We should be able to just do
2064
# self.base = self.bzrdir.root_transport.base
2065
# but this does not quite work yet -- mbp 20080522
2066
self._format = _format
2067
if _control_files is None:
2068
raise ValueError('BzrBranch _control_files is None')
2069
self.control_files = _control_files
2070
self._transport = _control_files._transport
2071
self.repository = _repository
2072
Branch.__init__(self)
2075
return '%s(%r)' % (self.__class__.__name__, self.base)
2079
def _get_base(self):
2080
"""Returns the directory containing the control directory."""
2083
base = property(_get_base, doc="The URL for the root of this branch.")
2085
def _get_config(self):
2086
return TransportConfig(self._transport, 'branch.conf')
2088
def is_locked(self):
2089
return self.control_files.is_locked()
2091
def lock_write(self, token=None):
2092
# All-in-one needs to always unlock/lock.
2093
repo_control = getattr(self.repository, 'control_files', None)
2094
if self.control_files == repo_control or not self.is_locked():
2095
self.repository.lock_write()
2100
return self.control_files.lock_write(token=token)
2103
self.repository.unlock()
2106
def lock_read(self):
2107
# All-in-one needs to always unlock/lock.
2108
repo_control = getattr(self.repository, 'control_files', None)
2109
if self.control_files == repo_control or not self.is_locked():
2110
self.repository.lock_read()
2115
self.control_files.lock_read()
2118
self.repository.unlock()
2123
self.control_files.unlock()
2125
# All-in-one needs to always unlock/lock.
2126
repo_control = getattr(self.repository, 'control_files', None)
2127
if (self.control_files == repo_control or
2128
not self.control_files.is_locked()):
2129
self.repository.unlock()
2130
if not self.control_files.is_locked():
2131
# we just released the lock
2132
self._clear_cached_state()
2134
def peek_lock_mode(self):
2135
if self.control_files._lock_count == 0:
2138
return self.control_files._lock_mode
2140
def get_physical_lock_status(self):
2141
return self.control_files.get_physical_lock_status()
2144
def print_file(self, file, revision_id):
2145
"""See Branch.print_file."""
2146
return self.repository.print_file(file, revision_id)
2148
def _write_revision_history(self, history):
2149
"""Factored out of set_revision_history.
2151
This performs the actual writing to disk.
2152
It is intended to be called by BzrBranch5.set_revision_history."""
2153
self._transport.put_bytes(
2154
'revision-history', '\n'.join(history),
2155
mode=self.bzrdir._get_file_mode())
2158
def set_revision_history(self, rev_history):
2159
"""See Branch.set_revision_history."""
2160
if 'evil' in debug.debug_flags:
2161
mutter_callsite(3, "set_revision_history scales with history.")
2162
check_not_reserved_id = _mod_revision.check_not_reserved_id
2163
for rev_id in rev_history:
2164
check_not_reserved_id(rev_id)
2165
if Branch.hooks['post_change_branch_tip']:
2166
# Don't calculate the last_revision_info() if there are no hooks
2168
old_revno, old_revid = self.last_revision_info()
2169
if len(rev_history) == 0:
2170
revid = _mod_revision.NULL_REVISION
2172
revid = rev_history[-1]
2173
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2174
self._write_revision_history(rev_history)
2175
self._clear_cached_state()
2176
self._cache_revision_history(rev_history)
2177
for hook in Branch.hooks['set_rh']:
2178
hook(self, rev_history)
2179
if Branch.hooks['post_change_branch_tip']:
2180
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2182
def _synchronize_history(self, destination, revision_id):
2183
"""Synchronize last revision and revision history between branches.
2185
This version is most efficient when the destination is also a
2186
BzrBranch5, but works for BzrBranch6 as long as the revision
2187
history is the true lefthand parent history, and all of the revisions
2188
are in the destination's repository. If not, set_revision_history
2191
:param destination: The branch to copy the history into
2192
:param revision_id: The revision-id to truncate history at. May
2193
be None to copy complete history.
2195
if not isinstance(destination._format, BzrBranchFormat5):
2196
super(BzrBranch, self)._synchronize_history(
2197
destination, revision_id)
2199
if revision_id == _mod_revision.NULL_REVISION:
2202
new_history = self.revision_history()
2203
if revision_id is not None and new_history != []:
2205
new_history = new_history[:new_history.index(revision_id) + 1]
2207
rev = self.repository.get_revision(revision_id)
2208
new_history = rev.get_history(self.repository)[1:]
2209
destination.set_revision_history(new_history)
2212
def set_last_revision_info(self, revno, revision_id):
2213
"""Set the last revision of this branch.
2215
The caller is responsible for checking that the revno is correct
2216
for this revision id.
2218
It may be possible to set the branch last revision to an id not
2219
present in the repository. However, branches can also be
2220
configured to check constraints on history, in which case this may not
2223
revision_id = _mod_revision.ensure_null(revision_id)
2224
# this old format stores the full history, but this api doesn't
2225
# provide it, so we must generate, and might as well check it's
2227
history = self._lefthand_history(revision_id)
2228
if len(history) != revno:
2229
raise AssertionError('%d != %d' % (len(history), revno))
2230
self.set_revision_history(history)
2232
def _gen_revision_history(self):
2233
history = self._transport.get_bytes('revision-history').split('\n')
2234
if history[-1:] == ['']:
2235
# There shouldn't be a trailing newline, but just in case.
2240
def generate_revision_history(self, revision_id, last_rev=None,
2242
"""Create a new revision history that will finish with revision_id.
2244
:param revision_id: the new tip to use.
2245
:param last_rev: The previous last_revision. If not None, then this
2246
must be a ancestory of revision_id, or DivergedBranches is raised.
2247
:param other_branch: The other branch that DivergedBranches should
2248
raise with respect to.
2250
self.set_revision_history(self._lefthand_history(revision_id,
2251
last_rev, other_branch))
2253
def basis_tree(self):
2254
"""See Branch.basis_tree."""
2255
return self.repository.revision_tree(self.last_revision())
2257
def _get_parent_location(self):
2258
_locs = ['parent', 'pull', 'x-pull']
2261
return self._transport.get_bytes(l).strip('\n')
2262
except errors.NoSuchFile:
2266
def _basic_push(self, target, overwrite, stop_revision):
2267
"""Basic implementation of push without bound branches or hooks.
2269
Must be called with source read locked and target write locked.
2271
result = BranchPushResult()
2272
result.source_branch = self
2273
result.target_branch = target
2274
result.old_revno, result.old_revid = target.last_revision_info()
2275
self.update_references(target)
2276
if result.old_revid != self.last_revision():
2277
# We assume that during 'push' this repository is closer than
2279
graph = self.repository.get_graph(target.repository)
2280
target.update_revisions(self, stop_revision,
2281
overwrite=overwrite, graph=graph)
2282
if self._push_should_merge_tags():
2283
result.tag_conflicts = self.tags.merge_to(target.tags,
2285
result.new_revno, result.new_revid = target.last_revision_info()
2288
def get_stacked_on_url(self):
2289
raise errors.UnstackableBranchFormat(self._format, self.base)
2291
def set_push_location(self, location):
2292
"""See Branch.set_push_location."""
2293
self.get_config().set_user_option(
2294
'push_location', location,
2295
store=_mod_config.STORE_LOCATION_NORECURSE)
2297
def _set_parent_location(self, url):
2299
self._transport.delete('parent')
2301
self._transport.put_bytes('parent', url + '\n',
2302
mode=self.bzrdir._get_file_mode())
2305
class BzrBranch5(BzrBranch):
2306
"""A format 5 branch. This supports new features over plain branches.
2308
It has support for a master_branch which is the data for bound branches.
2311
def get_bound_location(self):
2313
return self._transport.get_bytes('bound')[:-1]
2314
except errors.NoSuchFile:
2318
def get_master_branch(self, possible_transports=None):
2319
"""Return the branch we are bound to.
2321
:return: Either a Branch, or None
2323
This could memoise the branch, but if thats done
2324
it must be revalidated on each new lock.
2325
So for now we just don't memoise it.
2326
# RBC 20060304 review this decision.
2328
bound_loc = self.get_bound_location()
2332
return Branch.open(bound_loc,
2333
possible_transports=possible_transports)
2334
except (errors.NotBranchError, errors.ConnectionError), e:
2335
raise errors.BoundBranchConnectionFailure(
2339
def set_bound_location(self, location):
2340
"""Set the target where this branch is bound to.
2342
:param location: URL to the target branch
2345
self._transport.put_bytes('bound', location+'\n',
2346
mode=self.bzrdir._get_file_mode())
2349
self._transport.delete('bound')
2350
except errors.NoSuchFile:
2355
def bind(self, other):
2356
"""Bind this branch to the branch other.
2358
This does not push or pull data between the branches, though it does
2359
check for divergence to raise an error when the branches are not
2360
either the same, or one a prefix of the other. That behaviour may not
2361
be useful, so that check may be removed in future.
2363
:param other: The branch to bind to
2366
# TODO: jam 20051230 Consider checking if the target is bound
2367
# It is debatable whether you should be able to bind to
2368
# a branch which is itself bound.
2369
# Committing is obviously forbidden,
2370
# but binding itself may not be.
2371
# Since we *have* to check at commit time, we don't
2372
# *need* to check here
2374
# we want to raise diverged if:
2375
# last_rev is not in the other_last_rev history, AND
2376
# other_last_rev is not in our history, and do it without pulling
2378
self.set_bound_location(other.base)
2382
"""If bound, unbind"""
2383
return self.set_bound_location(None)
2386
def update(self, possible_transports=None):
2387
"""Synchronise this branch with the master branch if any.
2389
:return: None or the last_revision that was pivoted out during the
2392
master = self.get_master_branch(possible_transports)
2393
if master is not None:
2394
old_tip = _mod_revision.ensure_null(self.last_revision())
2395
self.pull(master, overwrite=True)
2396
if self.repository.get_graph().is_ancestor(old_tip,
2397
_mod_revision.ensure_null(self.last_revision())):
2403
class BzrBranch8(BzrBranch5):
2404
"""A branch that stores tree-reference locations."""
2406
def _open_hook(self):
2407
if self._ignore_fallbacks:
2410
url = self.get_stacked_on_url()
2411
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2412
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:
2415
for hook in Branch.hooks['transform_fallback_location']:
2416
url = hook(self, url)
2418
hook_name = Branch.hooks.get_hook_name(hook)
2419
raise AssertionError(
2420
"'transform_fallback_location' hook %s returned "
2421
"None, not a URL." % hook_name)
2422
self._activate_fallback_location(url)
2424
def __init__(self, *args, **kwargs):
2425
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2426
super(BzrBranch8, self).__init__(*args, **kwargs)
2427
self._last_revision_info_cache = None
2428
self._reference_info = None
2430
def _clear_cached_state(self):
2431
super(BzrBranch8, self)._clear_cached_state()
2432
self._last_revision_info_cache = None
2433
self._reference_info = None
2435
def _last_revision_info(self):
2436
revision_string = self._transport.get_bytes('last-revision')
2437
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2438
revision_id = cache_utf8.get_cached_utf8(revision_id)
2440
return revno, revision_id
2442
def _write_last_revision_info(self, revno, revision_id):
2443
"""Simply write out the revision id, with no checks.
2445
Use set_last_revision_info to perform this safely.
2447
Does not update the revision_history cache.
2448
Intended to be called by set_last_revision_info and
2449
_write_revision_history.
2451
revision_id = _mod_revision.ensure_null(revision_id)
2452
out_string = '%d %s\n' % (revno, revision_id)
2453
self._transport.put_bytes('last-revision', out_string,
2454
mode=self.bzrdir._get_file_mode())
2457
def set_last_revision_info(self, revno, revision_id):
2458
revision_id = _mod_revision.ensure_null(revision_id)
2459
old_revno, old_revid = self.last_revision_info()
2460
if self._get_append_revisions_only():
2461
self._check_history_violation(revision_id)
2462
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2463
self._write_last_revision_info(revno, revision_id)
2464
self._clear_cached_state()
2465
self._last_revision_info_cache = revno, revision_id
2466
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2468
def _synchronize_history(self, destination, revision_id):
2469
"""Synchronize last revision and revision history between branches.
2471
:see: Branch._synchronize_history
2473
# XXX: The base Branch has a fast implementation of this method based
2474
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2475
# that uses set_revision_history. This class inherits from BzrBranch5,
2476
# but wants the fast implementation, so it calls
2477
# Branch._synchronize_history directly.
2478
Branch._synchronize_history(self, destination, revision_id)
2480
def _check_history_violation(self, revision_id):
2481
last_revision = _mod_revision.ensure_null(self.last_revision())
2482
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
2484
if last_revision not in self._lefthand_history(revision_id):
2485
raise errors.AppendRevisionsOnlyViolation(self.base)
2487
def _gen_revision_history(self):
2488
"""Generate the revision history from last revision
2490
last_revno, last_revision = self.last_revision_info()
2491
self._extend_partial_history(stop_index=last_revno-1)
2492
return list(reversed(self._partial_revision_history_cache))
2494
def _write_revision_history(self, history):
2495
"""Factored out of set_revision_history.
2497
This performs the actual writing to disk, with format-specific checks.
2498
It is intended to be called by BzrBranch5.set_revision_history.
2500
if len(history) == 0:
2501
last_revision = 'null:'
2503
if history != self._lefthand_history(history[-1]):
2504
raise errors.NotLefthandHistory(history)
2505
last_revision = history[-1]
2506
if self._get_append_revisions_only():
2507
self._check_history_violation(last_revision)
2508
self._write_last_revision_info(len(history), last_revision)
2511
def _set_parent_location(self, url):
2512
"""Set the parent branch"""
2513
self._set_config_location('parent_location', url, make_relative=True)
2516
def _get_parent_location(self):
2517
"""Set the parent branch"""
2518
return self._get_config_location('parent_location')
2521
def _set_all_reference_info(self, info_dict):
2522
"""Replace all reference info stored in a branch.
2524
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2527
writer = rio.RioWriter(s)
2528
for key, (tree_path, branch_location) in info_dict.iteritems():
2529
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2530
branch_location=branch_location)
2531
writer.write_stanza(stanza)
2532
self._transport.put_bytes('references', s.getvalue())
2533
self._reference_info = info_dict
2536
def _get_all_reference_info(self):
2537
"""Return all the reference info stored in a branch.
2539
:return: A dict of {file_id: (tree_path, branch_location)}
2541
if self._reference_info is not None:
2542
return self._reference_info
2543
rio_file = self._transport.get('references')
1256
f = AtomicFile(self.controlfilename('pending-merges'))
2545
stanzas = rio.read_stanzas(rio_file)
2546
info_dict = dict((s['file_id'], (s['tree_path'],
2547
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()
2550
self._reference_info = info_dict
2553
def set_reference_info(self, file_id, tree_path, branch_location):
2554
"""Set the branch location to use for a tree reference.
2556
:param file_id: The file-id of the tree reference.
2557
:param tree_path: The path of the tree reference in the tree.
2558
:param branch_location: The location of the branch to retrieve tree
2561
info_dict = self._get_all_reference_info()
2562
info_dict[file_id] = (tree_path, branch_location)
2563
if None in (tree_path, branch_location):
2564
if tree_path is not None:
2565
raise ValueError('tree_path must be None when branch_location'
2567
if branch_location is not None:
2568
raise ValueError('branch_location must be None when tree_path'
2570
del info_dict[file_id]
2571
self._set_all_reference_info(info_dict)
2573
def get_reference_info(self, file_id):
2574
"""Get the tree_path and branch_location for a tree reference.
2576
:return: a tuple of (tree_path, branch_location)
2578
return self._get_all_reference_info().get(file_id, (None, None))
2580
def reference_parent(self, file_id, path, possible_transports=None):
2581
"""Return the parent branch for a tree-reference file_id.
2583
:param file_id: The file_id of the tree reference
2584
:param path: The path of the file_id in the tree
2585
:return: A branch associated with the file_id
2587
branch_location = self.get_reference_info(file_id)[1]
2588
if branch_location is None:
2589
return Branch.reference_parent(self, file_id, path,
2590
possible_transports)
2591
branch_location = urlutils.join(self.base, branch_location)
2592
return Branch.open(branch_location,
2593
possible_transports=possible_transports)
2595
def set_push_location(self, location):
2596
"""See Branch.set_push_location."""
2597
self._set_config_location('push_location', location)
2599
def set_bound_location(self, location):
2600
"""See Branch.set_push_location."""
2602
config = self.get_config()
2603
if location is None:
2604
if config.get_user_option('bound') != 'True':
2607
config.set_user_option('bound', 'False', warn_masked=True)
2610
self._set_config_location('bound_location', location,
2612
config.set_user_option('bound', 'True', warn_masked=True)
2615
def _get_bound_location(self, bound):
2616
"""Return the bound location in the config file.
2618
Return None if the bound parameter does not match"""
2619
config = self.get_config()
2620
config_bound = (config.get_user_option('bound') == 'True')
2621
if config_bound != bound:
2623
return self._get_config_location('bound_location', config=config)
2625
def get_bound_location(self):
2626
"""See Branch.set_push_location."""
2627
return self._get_bound_location(True)
2629
def get_old_bound_location(self):
2630
"""See Branch.get_old_bound_location"""
2631
return self._get_bound_location(False)
2633
def get_stacked_on_url(self):
2634
# you can always ask for the URL; but you might not be able to use it
2635
# if the repo can't support stacking.
2636
## self._check_stackable_repo()
2637
stacked_url = self._get_config_location('stacked_on_location')
2638
if stacked_url is None:
2639
raise errors.NotStacked(self)
2642
def _get_append_revisions_only(self):
2643
value = self.get_config().get_user_option('append_revisions_only')
2644
return value == 'True'
2647
def generate_revision_history(self, revision_id, last_rev=None,
2649
"""See BzrBranch5.generate_revision_history"""
2650
history = self._lefthand_history(revision_id, last_rev, other_branch)
2651
revno = len(history)
2652
self.set_last_revision_info(revno, revision_id)
2655
def get_rev_id(self, revno, history=None):
2656
"""Find the revision id of the specified revno."""
2658
return _mod_revision.NULL_REVISION
2660
last_revno, last_revision_id = self.last_revision_info()
2661
if revno <= 0 or revno > last_revno:
2662
raise errors.NoSuchRevision(self, revno)
2664
if history is not None:
2665
return history[revno - 1]
2667
index = last_revno - revno
2668
if len(self._partial_revision_history_cache) <= index:
2669
self._extend_partial_history(stop_index=index)
2670
if len(self._partial_revision_history_cache) > index:
2671
return self._partial_revision_history_cache[index]
2673
raise errors.NoSuchRevision(self, revno)
2676
def revision_id_to_revno(self, revision_id):
2677
"""Given a revision id, return its revno"""
2678
if _mod_revision.is_null(revision_id):
2681
index = self._partial_revision_history_cache.index(revision_id)
2683
self._extend_partial_history(stop_revision=revision_id)
2684
index = len(self._partial_revision_history_cache) - 1
2685
if self._partial_revision_history_cache[index] != revision_id:
2686
raise errors.NoSuchRevision(self, revision_id)
2687
return self.revno() - index
2690
class BzrBranch7(BzrBranch8):
2691
"""A branch with support for a fallback repository."""
2693
def set_reference_info(self, file_id, tree_path, branch_location):
2694
Branch.set_reference_info(self, file_id, tree_path, branch_location)
2696
def get_reference_info(self, file_id):
2697
Branch.get_reference_info(self, file_id)
2699
def reference_parent(self, file_id, path, possible_transports=None):
2700
return Branch.reference_parent(self, file_id, path,
2701
possible_transports)
2704
class BzrBranch6(BzrBranch7):
2705
"""See BzrBranchFormat6 for the capabilities of this branch.
2707
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)
2711
def get_stacked_on_url(self):
2712
raise errors.UnstackableBranchFormat(self._format, self.base)
1337
2715
######################################################################
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')
2716
# results of operations
2719
class _Result(object):
2721
def _show_tag_conficts(self, to_file):
2722
if not getattr(self, 'tag_conflicts', None):
2724
to_file.write('Conflicting tags:\n')
2725
for name, value1, value2 in self.tag_conflicts:
2726
to_file.write(' %s\n' % (name, ))
2729
class PullResult(_Result):
2730
"""Result of a Branch.pull operation.
2732
:ivar old_revno: Revision number before pull.
2733
:ivar new_revno: Revision number after pull.
2734
:ivar old_revid: Tip revision id before pull.
2735
:ivar new_revid: Tip revision id after pull.
2736
:ivar source_branch: Source (local) branch object. (read locked)
2737
:ivar master_branch: Master branch of the target, or the target if no
2739
:ivar local_branch: target branch if there is a Master, else None
2740
:ivar target_branch: Target/destination branch object. (write locked)
2741
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2745
# DEPRECATED: pull used to return the change in revno
2746
return self.new_revno - self.old_revno
2748
def report(self, to_file):
2750
if self.old_revid == self.new_revid:
2751
to_file.write('No revisions to pull.\n')
2753
to_file.write('Now on revision %d.\n' % self.new_revno)
2754
self._show_tag_conficts(to_file)
2757
class BranchPushResult(_Result):
2758
"""Result of a Branch.push operation.
2760
:ivar old_revno: Revision number (eg 10) of the target before push.
2761
:ivar new_revno: Revision number (eg 12) of the target after push.
2762
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
2764
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
2766
:ivar source_branch: Source branch object that the push was from. This is
2767
read locked, and generally is a local (and thus low latency) branch.
2768
:ivar master_branch: If target is a bound branch, the master branch of
2769
target, or target itself. Always write locked.
2770
:ivar target_branch: The direct Branch where data is being sent (write
2772
:ivar local_branch: If the target is a bound branch this will be the
2773
target, otherwise it will be None.
2777
# DEPRECATED: push used to return the change in revno
2778
return self.new_revno - self.old_revno
2780
def report(self, to_file):
2781
"""Write a human-readable description of the result."""
2782
if self.old_revid == self.new_revid:
2783
note('No new revisions to push.')
2785
note('Pushed up to revision %d.' % self.new_revno)
2786
self._show_tag_conficts(to_file)
2789
class BranchCheckResult(object):
2790
"""Results of checking branch consistency.
2795
def __init__(self, branch):
2796
self.branch = branch
2797
self.ghosts_in_mainline = False
2799
def report_results(self, verbose):
2800
"""Report the check results via trace.note.
2802
:param verbose: Requests more detailed display of what was checked,
2805
note('checked branch %s format %s',
2807
self.branch._format)
2808
if self.ghosts_in_mainline:
2809
note('branch contains ghosts in mainline')
2812
class Converter5to6(object):
2813
"""Perform an in-place upgrade of format 5 to format 6"""
2815
def convert(self, branch):
2816
# Data for 5 and 6 can peacefully coexist.
2817
format = BzrBranchFormat6()
2818
new_branch = format.open(branch.bzrdir, _found=True)
2820
# Copy source data into target
2821
new_branch._write_last_revision_info(*branch.last_revision_info())
2822
new_branch.set_parent(branch.get_parent())
2823
new_branch.set_bound_location(branch.get_bound_location())
2824
new_branch.set_push_location(branch.get_push_location())
2826
# New branch has no tags by default
2827
new_branch.tags._set_tag_dict({})
2829
# Copying done; now update target format
2830
new_branch._transport.put_bytes('format',
2831
format.get_format_string(),
2832
mode=new_branch.bzrdir._get_file_mode())
2834
# Clean up old files
2835
new_branch._transport.delete('revision-history')
2837
branch.set_parent(None)
2838
except errors.NoSuchFile:
2840
branch.set_bound_location(None)
2843
class Converter6to7(object):
2844
"""Perform an in-place upgrade of format 6 to format 7"""
2846
def convert(self, branch):
2847
format = BzrBranchFormat7()
2848
branch._set_config_location('stacked_on_location', '')
2849
# update target format
2850
branch._transport.put_bytes('format', format.get_format_string())
2853
class Converter7to8(object):
2854
"""Perform an in-place upgrade of format 6 to format 7"""
2856
def convert(self, branch):
2857
format = BzrBranchFormat8()
2858
branch._transport.put_bytes('references', '')
2859
# update target format
2860
branch._transport.put_bytes('format', format.get_format_string())
2863
def _run_with_write_locked_target(target, callable, *args, **kwargs):
2864
"""Run ``callable(*args, **kwargs)``, write-locking target for the
2867
_run_with_write_locked_target will attempt to release the lock it acquires.
2869
If an exception is raised by callable, then that exception *will* be
2870
propagated, even if the unlock attempt raises its own error. Thus
2871
_run_with_write_locked_target should be preferred to simply doing::
2875
return callable(*args, **kwargs)
2880
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
2881
# should share code?
2884
result = callable(*args, **kwargs)
2886
exc_info = sys.exc_info()
2890
raise exc_info[0], exc_info[1], exc_info[2]
2896
class InterBranch(InterObject):
2897
"""This class represents operations taking place between two branches.
2899
Its instances have methods like pull() and push() and contain
2900
references to the source and target repositories these operations
2901
can be carried out on.
2905
"""The available optimised InterBranch types."""
2908
def _get_branch_formats_to_test():
2909
"""Return a tuple with the Branch formats to use when testing."""
2910
raise NotImplementedError(self._get_branch_formats_to_test)
2912
def pull(self, overwrite=False, stop_revision=None,
2913
possible_transports=None, local=False):
2914
"""Mirror source into target branch.
2916
The target branch is considered to be 'local', having low latency.
2918
:returns: PullResult instance
2920
raise NotImplementedError(self.pull)
2922
def update_revisions(self, stop_revision=None, overwrite=False,
2924
"""Pull in new perfect-fit revisions.
2926
:param stop_revision: Updated until the given revision
2927
:param overwrite: Always set the branch pointer, rather than checking
2928
to see if it is a proper descendant.
2929
:param graph: A Graph object that can be used to query history
2930
information. This can be None.
2933
raise NotImplementedError(self.update_revisions)
2935
def push(self, overwrite=False, stop_revision=None,
2936
_override_hook_source_branch=None):
2937
"""Mirror the source branch into the target branch.
2939
The source branch is considered to be 'local', having low latency.
2941
raise NotImplementedError(self.push)
2944
class GenericInterBranch(InterBranch):
2945
"""InterBranch implementation that uses public Branch functions.
2949
def _get_branch_formats_to_test():
2950
return BranchFormat._default_format, BranchFormat._default_format
2952
def update_revisions(self, stop_revision=None, overwrite=False,
2954
"""See InterBranch.update_revisions()."""
2955
self.source.lock_read()
2957
other_revno, other_last_revision = self.source.last_revision_info()
2958
stop_revno = None # unknown
2959
if stop_revision is None:
2960
stop_revision = other_last_revision
2961
if _mod_revision.is_null(stop_revision):
2962
# if there are no commits, we're done.
2964
stop_revno = other_revno
2966
# what's the current last revision, before we fetch [and change it
2968
last_rev = _mod_revision.ensure_null(self.target.last_revision())
2969
# we fetch here so that we don't process data twice in the common
2970
# case of having something to pull, and so that the check for
2971
# already merged can operate on the just fetched graph, which will
2972
# be cached in memory.
2973
self.target.fetch(self.source, stop_revision)
2974
# Check to see if one is an ancestor of the other
2977
graph = self.target.repository.get_graph()
2978
if self.target._check_if_descendant_or_diverged(
2979
stop_revision, last_rev, graph, self.source):
2980
# stop_revision is a descendant of last_rev, but we aren't
2981
# overwriting, so we're done.
2983
if stop_revno is None:
2985
graph = self.target.repository.get_graph()
2986
this_revno, this_last_revision = \
2987
self.target.last_revision_info()
2988
stop_revno = graph.find_distance_to_null(stop_revision,
2989
[(other_last_revision, other_revno),
2990
(this_last_revision, this_revno)])
2991
self.target.set_last_revision_info(stop_revno, stop_revision)
2993
self.source.unlock()
2995
def pull(self, overwrite=False, stop_revision=None,
2996
possible_transports=None, _hook_master=None, run_hooks=True,
2997
_override_hook_target=None, local=False):
3000
:param _hook_master: Private parameter - set the branch to
3001
be supplied as the master to pull hooks.
3002
:param run_hooks: Private parameter - if false, this branch
3003
is being called because it's the master of the primary branch,
3004
so it should not run its hooks.
3005
:param _override_hook_target: Private parameter - set the branch to be
3006
supplied as the target_branch to pull hooks.
3007
:param local: Only update the local branch, and not the bound branch.
3009
# This type of branch can't be bound.
3011
raise errors.LocalRequiresBoundBranch()
3012
result = PullResult()
3013
result.source_branch = self.source
3014
if _override_hook_target is None:
3015
result.target_branch = self.target
3017
result.target_branch = _override_hook_target
3018
self.source.lock_read()
3020
# We assume that during 'pull' the target repository is closer than
3022
self.source.update_references(self.target)
3023
graph = self.target.repository.get_graph(self.source.repository)
3024
# TODO: Branch formats should have a flag that indicates
3025
# that revno's are expensive, and pull() should honor that flag.
3027
result.old_revno, result.old_revid = \
3028
self.target.last_revision_info()
3029
self.target.update_revisions(self.source, stop_revision,
3030
overwrite=overwrite, graph=graph)
3031
# TODO: The old revid should be specified when merging tags,
3032
# so a tags implementation that versions tags can only
3033
# pull in the most recent changes. -- JRV20090506
3034
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3036
result.new_revno, result.new_revid = self.target.last_revision_info()
3038
result.master_branch = _hook_master
3039
result.local_branch = result.target_branch
3041
result.master_branch = result.target_branch
3042
result.local_branch = None
3044
for hook in Branch.hooks['post_pull']:
3047
self.source.unlock()
3050
def push(self, overwrite=False, stop_revision=None,
3051
_override_hook_source_branch=None):
3052
"""See InterBranch.push.
3054
This is the basic concrete implementation of push()
3056
:param _override_hook_source_branch: If specified, run
3057
the hooks passing this Branch as the source, rather than self.
3058
This is for use of RemoteBranch, where push is delegated to the
3059
underlying vfs-based Branch.
3061
# TODO: Public option to disable running hooks - should be trivial but
3063
self.source.lock_read()
3065
return _run_with_write_locked_target(
3066
self.target, self._push_with_bound_branches, overwrite,
3068
_override_hook_source_branch=_override_hook_source_branch)
3070
self.source.unlock()
3073
def _push_with_bound_branches(self, overwrite, stop_revision,
3074
_override_hook_source_branch=None):
3075
"""Push from source into target, and into target's master if any.
3078
if _override_hook_source_branch:
3079
result.source_branch = _override_hook_source_branch
3080
for hook in Branch.hooks['post_push']:
3083
bound_location = self.target.get_bound_location()
3084
if bound_location and self.target.base != bound_location:
3085
# there is a master branch.
3087
# XXX: Why the second check? Is it even supported for a branch to
3088
# be bound to itself? -- mbp 20070507
3089
master_branch = self.target.get_master_branch()
3090
master_branch.lock_write()
3092
# push into the master from the source branch.
3093
self.source._basic_push(master_branch, overwrite, stop_revision)
3094
# and push into the target branch from the source. Note that we
3095
# push from the source branch again, because its considered the
3096
# highest bandwidth repository.
3097
result = self.source._basic_push(self.target, overwrite,
3099
result.master_branch = master_branch
3100
result.local_branch = self.target
3104
master_branch.unlock()
3107
result = self.source._basic_push(self.target, overwrite,
3109
# TODO: Why set master_branch and local_branch if there's no
3110
# binding? Maybe cleaner to just leave them unset? -- mbp
3112
result.master_branch = self.target
3113
result.local_branch = None
3118
def is_compatible(self, source, target):
3119
# GenericBranch uses the public API, so always compatible
3123
class InterToBranch5(GenericInterBranch):
3126
def _get_branch_formats_to_test():
3127
return BranchFormat._default_format, BzrBranchFormat5()
3129
def pull(self, overwrite=False, stop_revision=None,
3130
possible_transports=None, run_hooks=True,
3131
_override_hook_target=None, local=False):
3132
"""Pull from source into self, updating my master if any.
3134
:param run_hooks: Private parameter - if false, this branch
3135
is being called because it's the master of the primary branch,
3136
so it should not run its hooks.
3138
bound_location = self.target.get_bound_location()
3139
if local and not bound_location:
3140
raise errors.LocalRequiresBoundBranch()
3141
master_branch = None
3142
if not local and bound_location and self.source.base != bound_location:
3143
# not pulling from master, so we need to update master.
3144
master_branch = self.target.get_master_branch(possible_transports)
3145
master_branch.lock_write()
3148
# pull from source into master.
3149
master_branch.pull(self.source, overwrite, stop_revision,
3151
return super(InterToBranch5, self).pull(overwrite,
3152
stop_revision, _hook_master=master_branch,
3153
run_hooks=run_hooks,
3154
_override_hook_target=_override_hook_target)
3157
master_branch.unlock()
3160
InterBranch.register_optimiser(GenericInterBranch)
3161
InterBranch.register_optimiser(InterToBranch5)
added
removed
bzrlib/branch.py
