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._last_revision_info_cache = None
95
self._merge_sorted_revisions_cache = None
97
hooks = Branch.hooks['open']
101
def _open_hook(self):
102
"""Called by init to allow simpler extension of the base class."""
104
def _activate_fallback_location(self, url, lock_style):
105
"""Activate the branch/repository from url as a fallback repository."""
106
repo = self._get_fallback_repository(url)
107
if lock_style == 'write':
109
elif lock_style == 'read':
111
self.repository.add_fallback_repository(repo)
113
def break_lock(self):
114
"""Break a lock if one is present from another instance.
116
Uses the ui factory to ask for confirmation if the lock may be from
119
This will probe the repository for its lock as well.
121
self.control_files.break_lock()
122
self.repository.break_lock()
123
master = self.get_master_branch()
124
if master is not None:
127
def _check_stackable_repo(self):
128
if not self.repository._format.supports_external_lookups:
129
raise errors.UnstackableRepositoryFormat(self.repository._format,
130
self.repository.base)
133
def open(base, _unsupported=False, possible_transports=None):
134
"""Open the branch rooted at base.
136
For instance, if the branch is at URL/.bzr/branch,
137
Branch.open(URL) -> a Branch instance.
139
control = bzrdir.BzrDir.open(base, _unsupported,
140
possible_transports=possible_transports)
141
return control.open_branch(_unsupported)
144
def open_from_transport(transport, _unsupported=False):
145
"""Open the branch rooted at transport"""
146
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
147
return control.open_branch(_unsupported)
150
def open_containing(url, possible_transports=None):
151
"""Open an existing branch which contains url.
153
This probes for a branch at url, and searches upwards from there.
155
Basically we keep looking up until we find the control directory or
156
run into the root. If there isn't one, raises NotBranchError.
157
If there is one and it is either an unrecognised format or an unsupported
158
format, UnknownFormatError or UnsupportedFormatError are raised.
159
If there is one, it is returned, along with the unused portion of url.
161
control, relpath = bzrdir.BzrDir.open_containing(url,
163
return control.open_branch(), relpath
165
def _push_should_merge_tags(self):
166
"""Should _basic_push merge this branch's tags into the target?
168
The default implementation returns False if this branch has no tags,
169
and True the rest of the time. Subclasses may override this.
171
return self.supports_tags() and self.tags.get_tag_dict()
173
def get_config(self):
174
return BranchConfig(self)
176
def _get_config(self):
177
"""Get the concrete config for just the config in this branch.
179
This is not intended for client use; see Branch.get_config for the
184
:return: An object supporting get_option and set_option.
186
raise NotImplementedError(self._get_config)
188
def _get_fallback_repository(self, url):
189
"""Get the repository we fallback to at url."""
190
url = urlutils.join(self.base, url)
191
a_bzrdir = bzrdir.BzrDir.open(url,
192
possible_transports=[self.bzrdir.root_transport])
193
return a_bzrdir.open_branch().repository
195
def _get_tags_bytes(self):
196
"""Get the bytes of a serialised tags dict.
198
Note that not all branches support tags, nor do all use the same tags
199
logic: this method is specific to BasicTags. Other tag implementations
200
may use the same method name and behave differently, safely, because
201
of the double-dispatch via
202
format.make_tags->tags_instance->get_tags_dict.
204
:return: The bytes of the tags file.
205
:seealso: Branch._set_tags_bytes.
207
return self._transport.get_bytes('tags')
209
def _get_nick(self, local=False, possible_transports=None):
210
config = self.get_config()
211
# explicit overrides master, but don't look for master if local is True
212
if not local and not config.has_explicit_nickname():
214
master = self.get_master_branch(possible_transports)
215
if master is not None:
216
# return the master branch value
218
except errors.BzrError, e:
219
# Silently fall back to local implicit nick if the master is
221
mutter("Could not connect to bound branch, "
222
"falling back to local nick.\n " + str(e))
223
return config.get_nickname()
225
def _set_nick(self, nick):
226
self.get_config().set_user_option('nickname', nick, warn_masked=True)
228
nick = property(_get_nick, _set_nick)
231
raise NotImplementedError(self.is_locked)
233
def _lefthand_history(self, revision_id, last_rev=None,
235
if 'evil' in debug.debug_flags:
236
mutter_callsite(4, "_lefthand_history scales with history.")
237
# stop_revision must be a descendant of last_revision
238
graph = self.repository.get_graph()
239
if last_rev is not None:
240
if not graph.is_ancestor(last_rev, revision_id):
241
# our previous tip is not merged into stop_revision
242
raise errors.DivergedBranches(self, other_branch)
243
# make a new revision history from the graph
244
parents_map = graph.get_parent_map([revision_id])
245
if revision_id not in parents_map:
246
raise errors.NoSuchRevision(self, revision_id)
247
current_rev_id = revision_id
249
check_not_reserved_id = _mod_revision.check_not_reserved_id
250
# Do not include ghosts or graph origin in revision_history
251
while (current_rev_id in parents_map and
252
len(parents_map[current_rev_id]) > 0):
253
check_not_reserved_id(current_rev_id)
254
new_history.append(current_rev_id)
255
current_rev_id = parents_map[current_rev_id][0]
256
parents_map = graph.get_parent_map([current_rev_id])
257
new_history.reverse()
212
260
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'
261
raise NotImplementedError(self.lock_write)
228
263
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'
264
raise NotImplementedError(self.lock_read)
242
266
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
267
raise NotImplementedError(self.unlock)
269
def peek_lock_mode(self):
270
"""Return lock mode for the Branch: 'r', 'w' or None"""
271
raise NotImplementedError(self.peek_lock_mode)
273
def get_physical_lock_status(self):
274
raise NotImplementedError(self.get_physical_lock_status)
277
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
278
"""Return the revision_id for a dotted revno.
280
:param revno: a tuple like (1,) or (1,1,2)
281
:param _cache_reverse: a private parameter enabling storage
282
of the reverse mapping in a top level cache. (This should
283
only be done in selective circumstances as we want to
284
avoid having the mapping cached multiple times.)
285
:return: the revision_id
286
:raises errors.NoSuchRevision: if the revno doesn't exist
288
rev_id = self._do_dotted_revno_to_revision_id(revno)
290
self._partial_revision_id_to_revno_cache[rev_id] = revno
293
def _do_dotted_revno_to_revision_id(self, revno):
294
"""Worker function for dotted_revno_to_revision_id.
296
Subclasses should override this if they wish to
297
provide a more efficient implementation.
300
return self.get_rev_id(revno[0])
301
revision_id_to_revno = self.get_revision_id_to_revno_map()
302
revision_ids = [revision_id for revision_id, this_revno
303
in revision_id_to_revno.iteritems()
304
if revno == this_revno]
305
if len(revision_ids) == 1:
306
return revision_ids[0]
308
revno_str = '.'.join(map(str, revno))
309
raise errors.NoSuchRevision(self, revno_str)
312
def revision_id_to_dotted_revno(self, revision_id):
313
"""Given a revision id, return its dotted revno.
315
:return: a tuple like (1,) or (400,1,3).
317
return self._do_revision_id_to_dotted_revno(revision_id)
319
def _do_revision_id_to_dotted_revno(self, revision_id):
320
"""Worker function for revision_id_to_revno."""
321
# Try the caches if they are loaded
322
result = self._partial_revision_id_to_revno_cache.get(revision_id)
323
if result is not None:
325
if self._revision_id_to_revno_cache:
326
result = self._revision_id_to_revno_cache.get(revision_id)
328
raise errors.NoSuchRevision(self, revision_id)
329
# Try the mainline as it's optimised
331
revno = self.revision_id_to_revno(revision_id)
333
except errors.NoSuchRevision:
334
# We need to load and use the full revno map after all
335
result = self.get_revision_id_to_revno_map().get(revision_id)
337
raise errors.NoSuchRevision(self, revision_id)
341
def get_revision_id_to_revno_map(self):
342
"""Return the revision_id => dotted revno map.
344
This will be regenerated on demand, but will be cached.
346
:return: A dictionary mapping revision_id => dotted revno.
347
This dictionary should not be modified by the caller.
349
if self._revision_id_to_revno_cache is not None:
350
mapping = self._revision_id_to_revno_cache
352
mapping = self._gen_revno_map()
353
self._cache_revision_id_to_revno(mapping)
354
# TODO: jam 20070417 Since this is being cached, should we be returning
356
# I would rather not, and instead just declare that users should not
357
# modify the return value.
360
def _gen_revno_map(self):
361
"""Create a new mapping from revision ids to dotted revnos.
363
Dotted revnos are generated based on the current tip in the revision
365
This is the worker function for get_revision_id_to_revno_map, which
366
just caches the return value.
368
:return: A dictionary mapping revision_id => dotted revno.
370
revision_id_to_revno = dict((rev_id, revno)
371
for rev_id, depth, revno, end_of_merge
372
in self.iter_merge_sorted_revisions())
373
return revision_id_to_revno
376
def iter_merge_sorted_revisions(self, start_revision_id=None,
377
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
378
"""Walk the revisions for a branch in merge sorted order.
380
Merge sorted order is the output from a merge-aware,
381
topological sort, i.e. all parents come before their
382
children going forward; the opposite for reverse.
384
:param start_revision_id: the revision_id to begin walking from.
385
If None, the branch tip is used.
386
:param stop_revision_id: the revision_id to terminate the walk
387
after. If None, the rest of history is included.
388
:param stop_rule: if stop_revision_id is not None, the precise rule
389
to use for termination:
390
* 'exclude' - leave the stop revision out of the result (default)
391
* 'include' - the stop revision is the last item in the result
392
* 'with-merges' - include the stop revision and all of its
393
merged revisions in the result
394
:param direction: either 'reverse' or 'forward':
395
* reverse means return the start_revision_id first, i.e.
396
start at the most recent revision and go backwards in history
397
* forward returns tuples in the opposite order to reverse.
398
Note in particular that forward does *not* do any intelligent
399
ordering w.r.t. depth as some clients of this API may like.
400
(If required, that ought to be done at higher layers.)
402
:return: an iterator over (revision_id, depth, revno, end_of_merge)
405
* revision_id: the unique id of the revision
406
* depth: How many levels of merging deep this node has been
408
* revno_sequence: This field provides a sequence of
409
revision numbers for all revisions. The format is:
410
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
411
branch that the revno is on. From left to right the REVNO numbers
412
are the sequence numbers within that branch of the revision.
413
* end_of_merge: When True the next node (earlier in history) is
414
part of a different merge.
416
# Note: depth and revno values are in the context of the branch so
417
# we need the full graph to get stable numbers, regardless of the
419
if self._merge_sorted_revisions_cache is None:
420
last_revision = self.last_revision()
421
graph = self.repository.get_graph()
422
parent_map = dict(((key, value) for key, value in
423
graph.iter_ancestry([last_revision]) if value is not None))
424
revision_graph = repository._strip_NULL_ghosts(parent_map)
425
revs = tsort.merge_sort(revision_graph, last_revision, None,
427
# Drop the sequence # before caching
428
self._merge_sorted_revisions_cache = [r[1:] for r in revs]
430
filtered = self._filter_merge_sorted_revisions(
431
self._merge_sorted_revisions_cache, start_revision_id,
432
stop_revision_id, stop_rule)
433
if direction == 'reverse':
435
if direction == 'forward':
436
return reversed(list(filtered))
438
raise ValueError('invalid direction %r' % direction)
440
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
441
start_revision_id, stop_revision_id, stop_rule):
442
"""Iterate over an inclusive range of sorted revisions."""
443
rev_iter = iter(merge_sorted_revisions)
444
if start_revision_id is not None:
445
for rev_id, depth, revno, end_of_merge in rev_iter:
446
if rev_id != start_revision_id:
449
# The decision to include the start or not
450
# depends on the stop_rule if a stop is provided
452
iter([(rev_id, depth, revno, end_of_merge)]),
455
if stop_revision_id is None:
456
for rev_id, depth, revno, end_of_merge in rev_iter:
457
yield rev_id, depth, revno, end_of_merge
458
elif stop_rule == 'exclude':
459
for rev_id, depth, revno, end_of_merge in rev_iter:
460
if rev_id == stop_revision_id:
462
yield rev_id, depth, revno, end_of_merge
463
elif stop_rule == 'include':
464
for rev_id, depth, revno, end_of_merge in rev_iter:
465
yield rev_id, depth, revno, end_of_merge
466
if rev_id == stop_revision_id:
468
elif stop_rule == 'with-merges':
469
stop_rev = self.repository.get_revision(stop_revision_id)
470
if stop_rev.parent_ids:
471
left_parent = stop_rev.parent_ids[0]
473
left_parent = _mod_revision.NULL_REVISION
474
for rev_id, depth, revno, end_of_merge in rev_iter:
475
if rev_id == left_parent:
477
yield rev_id, depth, revno, end_of_merge
479
raise ValueError('invalid stop_rule %r' % stop_rule)
481
def leave_lock_in_place(self):
482
"""Tell this branch object not to release the physical lock when this
485
If lock_write doesn't return a token, then this method is not supported.
487
self.control_files.leave_in_place()
489
def dont_leave_lock_in_place(self):
490
"""Tell this branch object to release the physical lock when this
491
object is unlocked, even if it didn't originally acquire it.
493
If lock_write doesn't return a token, then this method is not supported.
495
self.control_files.dont_leave_in_place()
497
def bind(self, other):
498
"""Bind the local branch the other branch.
500
:param other: The branch to bind to
503
raise errors.UpgradeRequired(self.base)
505
def set_reference_info(self, file_id, tree_path, branch_location):
506
"""Set the branch location to use for a tree reference."""
507
raise errors.UnsupportedOperation(self.set_reference_info, self)
509
def get_reference_info(self, file_id):
510
"""Get the tree_path and branch_location for a tree reference."""
511
raise errors.UnsupportedOperation(self.get_reference_info, self)
514
def fetch(self, from_branch, last_revision=None, pb=None):
515
"""Copy revisions from from_branch into this branch.
517
:param from_branch: Where to copy from.
518
:param last_revision: What revision to stop at (None for at the end
520
:param pb: An optional progress bar to use.
523
if self.base == from_branch.base:
526
symbol_versioning.warn(
527
symbol_versioning.deprecated_in((1, 14, 0))
528
% "pb parameter to fetch()")
529
from_branch.lock_read()
531
if last_revision is None:
532
last_revision = from_branch.last_revision()
533
last_revision = _mod_revision.ensure_null(last_revision)
534
return self.repository.fetch(from_branch.repository,
535
revision_id=last_revision,
540
def get_bound_location(self):
541
"""Return the URL of the branch we are bound to.
543
Older format branches cannot bind, please be sure to use a metadir
548
def get_old_bound_location(self):
549
"""Return the URL of the branch we used to be bound to
551
raise errors.UpgradeRequired(self.base)
553
def get_commit_builder(self, parents, config=None, timestamp=None,
554
timezone=None, committer=None, revprops=None,
556
"""Obtain a CommitBuilder for this branch.
558
:param parents: Revision ids of the parents of the new revision.
559
:param config: Optional configuration to use.
560
:param timestamp: Optional timestamp recorded for commit.
561
:param timezone: Optional timezone for timestamp.
562
:param committer: Optional committer to set for commit.
563
:param revprops: Optional dictionary of revision properties.
564
:param revision_id: Optional revision id.
568
config = self.get_config()
570
return self.repository.get_commit_builder(self, parents, config,
571
timestamp, timezone, committer, revprops, revision_id)
573
def get_master_branch(self, possible_transports=None):
574
"""Return the branch we are bound to.
576
:return: Either a Branch, or None
617
580
def get_revision_delta(self, revno):
618
581
"""Return the delta for one revision.
789
786
common_index = min(self_len, other_len) -1
790
787
if common_index >= 0 and \
791
788
self_history[common_index] != other_history[common_index]:
792
raise DivergedBranches(self, other)
789
raise errors.DivergedBranches(self, other)
794
791
if stop_revision is None:
795
792
stop_revision = other_len
796
elif stop_revision > other_len:
797
raise NoSuchRevision(self, stop_revision)
794
if stop_revision > other_len:
795
raise errors.NoSuchRevision(self, stop_revision)
799
796
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)
799
def update_revisions(self, other, stop_revision=None, overwrite=False,
801
"""Pull in new perfect-fit revisions.
803
:param other: Another Branch to pull from
804
:param stop_revision: Updated until the given revision
805
:param overwrite: Always set the branch pointer, rather than checking
806
to see if it is a proper descendant.
807
:param graph: A Graph object that can be used to query history
808
information. This can be None.
811
return InterBranch.get(other, self).update_revisions(stop_revision,
814
def import_last_revision_info(self, source_repo, revno, revid):
815
"""Set the last revision info, importing from another repo if necessary.
817
This is used by the bound branch code to upload a revision to
818
the master branch first before updating the tip of the local branch.
820
:param source_repo: Source repository to optionally fetch from
821
:param revno: Revision number of the new tip
822
:param revid: Revision id of the new tip
824
if not self.repository.has_same_location(source_repo):
825
self.repository.fetch(source_repo, revision_id=revid)
826
self.set_last_revision_info(revno, revid)
828
def revision_id_to_revno(self, revision_id):
829
"""Given a revision id, return its revno"""
830
if _mod_revision.is_null(revision_id):
832
history = self.revision_history()
834
return history.index(revision_id) + 1
893
835
except ValueError:
836
raise errors.NoSuchRevision(self, revision_id)
838
def get_rev_id(self, revno, history=None):
839
"""Find the revision id of the specified revno."""
841
return _mod_revision.NULL_REVISION
843
history = self.revision_history()
844
if revno <= 0 or revno > len(history):
845
raise errors.NoSuchRevision(self, revno)
846
return history[revno - 1]
849
def pull(self, source, overwrite=False, stop_revision=None,
850
possible_transports=None, *args, **kwargs):
851
"""Mirror source into this branch.
853
This branch is considered to be 'local', having low latency.
855
:returns: PullResult instance
857
return InterBranch.get(source, self).pull(overwrite=overwrite,
858
stop_revision=stop_revision,
859
possible_transports=possible_transports, *args, **kwargs)
861
def push(self, target, overwrite=False, stop_revision=None, *args,
863
"""Mirror this branch into target.
865
This branch is considered to be 'local', having low latency.
867
return InterBranch.get(self, target).push(overwrite, stop_revision,
870
def lossy_push(self, target, stop_revision=None):
871
"""Push deltas into another branch.
873
:note: This does not, like push, retain the revision ids from
874
the source branch and will, rather than adding bzr-specific
875
metadata, push only those semantics of the revision that can be
876
natively represented by this branch' VCS.
878
:param target: Target branch
879
:param stop_revision: Revision to push, defaults to last revision.
880
:return: BranchPushResult with an extra member revidmap:
881
A dictionary mapping revision ids from the target branch
882
to new revision ids in the target branch, for each
883
revision that was pushed.
885
inter = InterBranch.get(self, target)
886
lossy_push = getattr(inter, "lossy_push", None)
887
if lossy_push is None:
888
raise errors.LossyPushToSameVCS(self, target)
889
return lossy_push(stop_revision)
891
def basis_tree(self):
892
"""Return `Tree` object for last revision."""
893
return self.repository.revision_tree(self.last_revision())
895
def get_parent(self):
896
"""Return the parent location of the branch.
898
This is the default location for pull/missing. The usual
899
pattern is that the user can override it by specifying a
902
parent = self._get_parent_location()
905
# This is an old-format absolute path to a local branch
907
if parent.startswith('/'):
908
parent = urlutils.local_path_to_url(parent.decode('utf8'))
910
return urlutils.join(self.base[:-1], parent)
911
except errors.InvalidURLJoin, e:
912
raise errors.InaccessibleParent(parent, self.base)
914
def _get_parent_location(self):
915
raise NotImplementedError(self._get_parent_location)
917
def _set_config_location(self, name, url, config=None,
918
make_relative=False):
920
config = self.get_config()
924
url = urlutils.relative_url(self.base, url)
925
config.set_user_option(name, url, warn_masked=True)
927
def _get_config_location(self, name, config=None):
929
config = self.get_config()
930
location = config.get_user_option(name)
935
def get_submit_branch(self):
936
"""Return the submit location of the branch.
938
This is the default location for bundle. The usual
939
pattern is that the user can override it by specifying a
942
return self.get_config().get_user_option('submit_branch')
944
def set_submit_branch(self, location):
945
"""Return the submit location of the branch.
947
This is the default location for bundle. The usual
948
pattern is that the user can override it by specifying a
951
self.get_config().set_user_option('submit_branch', location,
954
def get_public_branch(self):
955
"""Return the public location of the branch.
957
This is used by merge directives.
959
return self._get_config_location('public_branch')
961
def set_public_branch(self, location):
962
"""Return the submit location of the branch.
964
This is the default location for bundle. The usual
965
pattern is that the user can override it by specifying a
968
self._set_config_location('public_branch', location)
970
def get_push_location(self):
971
"""Return the None or the location to push this branch to."""
972
push_loc = self.get_config().get_user_option('push_location')
975
def set_push_location(self, location):
976
"""Set a new push location for this branch."""
977
raise NotImplementedError(self.set_push_location)
979
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
980
"""Run the post_change_branch_tip hooks."""
981
hooks = Branch.hooks['post_change_branch_tip']
984
new_revno, new_revid = self.last_revision_info()
985
params = ChangeBranchTipParams(
986
self, old_revno, new_revno, old_revid, new_revid)
990
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
991
"""Run the pre_change_branch_tip hooks."""
992
hooks = Branch.hooks['pre_change_branch_tip']
995
old_revno, old_revid = self.last_revision_info()
996
params = ChangeBranchTipParams(
997
self, old_revno, new_revno, old_revid, new_revid)
1001
except errors.TipChangeRejected:
1004
exc_info = sys.exc_info()
1005
hook_name = Branch.hooks.get_hook_name(hook)
1006
raise errors.HookFailed(
1007
'pre_change_branch_tip', hook_name, exc_info)
1011
"""Synchronise this branch with the master branch if any.
1013
:return: None or the last_revision pivoted out during the update.
1017
def check_revno(self, revno):
1019
Check whether a revno corresponds to any revision.
1020
Zero (the NULL revision) is considered valid.
1023
self.check_real_revno(revno)
1025
def check_real_revno(self, revno):
1027
Check whether a revno corresponds to a real revision.
1028
Zero (the NULL revision) is considered invalid
1030
if revno < 1 or revno > self.revno():
1031
raise errors.InvalidRevisionNumber(revno)
1034
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
1035
"""Clone this branch into to_bzrdir preserving all semantic values.
1037
Most API users will want 'create_clone_on_transport', which creates a
1038
new bzrdir and branch on the fly.
1040
revision_id: if not None, the revision history in the new branch will
1041
be truncated to end with revision_id.
1043
result = to_bzrdir.create_branch()
1046
if repository_policy is not None:
1047
repository_policy.configure_branch(result)
1048
self.copy_content_into(result, revision_id=revision_id)
1054
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
1055
"""Create a new line of development from the branch, into to_bzrdir.
1057
to_bzrdir controls the branch format.
1059
revision_id: if not None, the revision history in the new branch will
1060
be truncated to end with revision_id.
1062
result = to_bzrdir.create_branch()
1065
if repository_policy is not None:
1066
repository_policy.configure_branch(result)
1067
self.copy_content_into(result, revision_id=revision_id)
1068
result.set_parent(self.bzrdir.root_transport.base)
1073
def _synchronize_history(self, destination, revision_id):
1074
"""Synchronize last revision and revision history between branches.
1076
This version is most efficient when the destination is also a
1077
BzrBranch6, but works for BzrBranch5, as long as the destination's
1078
repository contains all the lefthand ancestors of the intended
1079
last_revision. If not, set_last_revision_info will fail.
1081
:param destination: The branch to copy the history into
1082
:param revision_id: The revision-id to truncate history at. May
1083
be None to copy complete history.
1085
source_revno, source_revision_id = self.last_revision_info()
1086
if revision_id is None:
1087
revno, revision_id = source_revno, source_revision_id
1088
elif source_revision_id == revision_id:
1089
# we know the revno without needing to walk all of history
1090
revno = source_revno
1092
# To figure out the revno for a random revision, we need to build
1093
# the revision history, and count its length.
1094
# We don't care about the order, just how long it is.
1095
# Alternatively, we could start at the current location, and count
1096
# backwards. But there is no guarantee that we will find it since
1097
# it may be a merged revision.
1098
revno = len(list(self.repository.iter_reverse_revision_history(
1100
destination.set_last_revision_info(revno, revision_id)
1103
def copy_content_into(self, destination, revision_id=None):
1104
"""Copy the content of self into destination.
1106
revision_id: if not None, the revision history in the new branch will
1107
be truncated to end with revision_id.
1109
self.update_references(destination)
1110
self._synchronize_history(destination, revision_id)
1112
parent = self.get_parent()
1113
except errors.InaccessibleParent, e:
1114
mutter('parent was not accessible to copy: %s', e)
1117
destination.set_parent(parent)
1118
if self._push_should_merge_tags():
1119
self.tags.merge_to(destination.tags)
1121
def update_references(self, target):
1122
if not getattr(self._format, 'supports_reference_locations', False):
1124
reference_dict = self._get_all_reference_info()
1125
if len(reference_dict) == 0:
1127
old_base = self.base
1128
new_base = target.base
1129
target_reference_dict = target._get_all_reference_info()
1130
for file_id, (tree_path, branch_location) in (
1131
reference_dict.items()):
1132
branch_location = urlutils.rebase_url(branch_location,
1134
target_reference_dict.setdefault(
1135
file_id, (tree_path, branch_location))
1136
target._set_all_reference_info(target_reference_dict)
1140
"""Check consistency of the branch.
1142
In particular this checks that revisions given in the revision-history
1143
do actually match up in the revision graph, and that they're all
1144
present in the repository.
1146
Callers will typically also want to check the repository.
1148
:return: A BranchCheckResult.
1150
mainline_parent_id = None
1151
last_revno, last_revision_id = self.last_revision_info()
1152
real_rev_history = list(self.repository.iter_reverse_revision_history(
1154
real_rev_history.reverse()
1155
if len(real_rev_history) != last_revno:
1156
raise errors.BzrCheckError('revno does not match len(mainline)'
1157
' %s != %s' % (last_revno, len(real_rev_history)))
1158
# TODO: We should probably also check that real_rev_history actually
1159
# matches self.revision_history()
1160
for revision_id in real_rev_history:
1162
revision = self.repository.get_revision(revision_id)
1163
except errors.NoSuchRevision, e:
1164
raise errors.BzrCheckError("mainline revision {%s} not in repository"
1166
# In general the first entry on the revision history has no parents.
1167
# But it's not illegal for it to have parents listed; this can happen
1168
# in imports from Arch when the parents weren't reachable.
1169
if mainline_parent_id is not None:
1170
if mainline_parent_id not in revision.parent_ids:
1171
raise errors.BzrCheckError("previous revision {%s} not listed among "
1173
% (mainline_parent_id, revision_id))
1174
mainline_parent_id = revision_id
1175
return BranchCheckResult(self)
1177
def _get_checkout_format(self):
1178
"""Return the most suitable metadir for a checkout of this branch.
1179
Weaves are used if this branch's repository uses weaves.
1181
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1182
from bzrlib.repofmt import weaverepo
1183
format = bzrdir.BzrDirMetaFormat1()
1184
format.repository_format = weaverepo.RepositoryFormat7()
1186
format = self.repository.bzrdir.checkout_metadir()
1187
format.set_branch_format(self._format)
1190
def create_clone_on_transport(self, to_transport, revision_id=None,
1191
stacked_on=None, create_prefix=False, use_existing_dir=False):
1192
"""Create a clone of this branch and its bzrdir.
1194
:param to_transport: The transport to clone onto.
1195
:param revision_id: The revision id to use as tip in the new branch.
1196
If None the tip is obtained from this branch.
1197
:param stacked_on: An optional URL to stack the clone on.
1198
:param create_prefix: Create any missing directories leading up to
1200
:param use_existing_dir: Use an existing directory if one exists.
1202
# XXX: Fix the bzrdir API to allow getting the branch back from the
1203
# clone call. Or something. 20090224 RBC/spiv.
1204
if revision_id is None:
1205
revision_id = self.last_revision()
1207
dir_to = self.bzrdir.clone_on_transport(to_transport,
1208
revision_id=revision_id, stacked_on=stacked_on,
1209
create_prefix=create_prefix, use_existing_dir=use_existing_dir)
1210
except errors.FileExists:
1211
if not use_existing_dir:
1213
except errors.NoSuchFile:
1214
if not create_prefix:
1216
return dir_to.open_branch()
1218
def create_checkout(self, to_location, revision_id=None,
1219
lightweight=False, accelerator_tree=None,
1221
"""Create a checkout of a branch.
1223
:param to_location: The url to produce the checkout at
1224
:param revision_id: The revision to check out
1225
:param lightweight: If True, produce a lightweight checkout, otherwise,
1226
produce a bound branch (heavyweight checkout)
1227
:param accelerator_tree: A tree which can be used for retrieving file
1228
contents more quickly than the revision tree, i.e. a workingtree.
1229
The revision tree will be used for cases where accelerator_tree's
1230
content is different.
1231
:param hardlink: If true, hard-link files from accelerator_tree,
1233
:return: The tree of the created checkout
1235
t = transport.get_transport(to_location)
1238
format = self._get_checkout_format()
1239
checkout = format.initialize_on_transport(t)
1240
from_branch = BranchReferenceFormat().initialize(checkout, self)
1242
format = self._get_checkout_format()
1243
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1244
to_location, force_new_tree=False, format=format)
1245
checkout = checkout_branch.bzrdir
1246
checkout_branch.bind(self)
1247
# pull up to the specified revision_id to set the initial
1248
# branch tip correctly, and seed it with history.
1249
checkout_branch.pull(self, stop_revision=revision_id)
1251
tree = checkout.create_workingtree(revision_id,
1252
from_branch=from_branch,
1253
accelerator_tree=accelerator_tree,
1255
basis_tree = tree.basis_tree()
1256
basis_tree.lock_read()
1258
for path, file_id in basis_tree.iter_references():
1259
reference_parent = self.reference_parent(file_id, path)
1260
reference_parent.create_checkout(tree.abspath(path),
1261
basis_tree.get_reference_revision(file_id, path),
1268
def reconcile(self, thorough=True):
1269
"""Make sure the data stored in this branch is consistent."""
1270
from bzrlib.reconcile import BranchReconciler
1271
reconciler = BranchReconciler(self, thorough=thorough)
1272
reconciler.reconcile()
1275
def reference_parent(self, file_id, path, possible_transports=None):
1276
"""Return the parent branch for a tree-reference file_id
1277
:param file_id: The file_id of the tree reference
1278
:param path: The path of the file_id in the tree
1279
:return: A branch associated with the file_id
1281
# FIXME should provide multiple branches, based on config
1282
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1283
possible_transports=possible_transports)
1285
def supports_tags(self):
1286
return self._format.supports_tags()
1288
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1290
"""Ensure that revision_b is a descendant of revision_a.
1292
This is a helper function for update_revisions.
1294
:raises: DivergedBranches if revision_b has diverged from revision_a.
1295
:returns: True if revision_b is a descendant of revision_a.
1297
relation = self._revision_relations(revision_a, revision_b, graph)
1298
if relation == 'b_descends_from_a':
1300
elif relation == 'diverged':
1301
raise errors.DivergedBranches(self, other_branch)
1302
elif relation == 'a_descends_from_b':
1305
raise AssertionError("invalid relation: %r" % (relation,))
1307
def _revision_relations(self, revision_a, revision_b, graph):
1308
"""Determine the relationship between two revisions.
1310
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1312
heads = graph.heads([revision_a, revision_b])
1313
if heads == set([revision_b]):
1314
return 'b_descends_from_a'
1315
elif heads == set([revision_a, revision_b]):
1316
# These branches have diverged
1318
elif heads == set([revision_a]):
1319
return 'a_descends_from_b'
1321
raise AssertionError("invalid heads: %r" % (heads,))
1324
class BranchFormat(object):
1325
"""An encapsulation of the initialization and open routines for a format.
1327
Formats provide three things:
1328
* An initialization routine,
1332
Formats are placed in an dict by their format string for reference
1333
during branch opening. Its not required that these be instances, they
1334
can be classes themselves with class methods - it simply depends on
1335
whether state is needed for a given format or not.
1337
Once a format is deprecated, just deprecate the initialize and open
1338
methods on the format class. Do not deprecate the object, as the
1339
object will be created every time regardless.
1342
_default_format = None
1343
"""The default format used for new branches."""
1346
"""The known formats."""
1348
def __eq__(self, other):
1349
return self.__class__ is other.__class__
1351
def __ne__(self, other):
1352
return not (self == other)
1355
def find_format(klass, a_bzrdir):
1356
"""Return the format for the branch object in a_bzrdir."""
1358
transport = a_bzrdir.get_branch_transport(None)
1359
format_string = transport.get("format").read()
1360
return klass._formats[format_string]
1361
except errors.NoSuchFile:
1362
raise errors.NotBranchError(path=transport.base)
1364
raise errors.UnknownFormatError(format=format_string, kind='branch')
1367
def get_default_format(klass):
1368
"""Return the current default format."""
1369
return klass._default_format
1371
def get_reference(self, a_bzrdir):
1372
"""Get the target reference of the branch in a_bzrdir.
1374
format probing must have been completed before calling
1375
this method - it is assumed that the format of the branch
1376
in a_bzrdir is correct.
1378
:param a_bzrdir: The bzrdir to get the branch data from.
1379
:return: None if the branch is not a reference branch.
1384
def set_reference(self, a_bzrdir, to_branch):
1385
"""Set the target reference of the branch in a_bzrdir.
1387
format probing must have been completed before calling
1388
this method - it is assumed that the format of the branch
1389
in a_bzrdir is correct.
1391
:param a_bzrdir: The bzrdir to set the branch reference for.
1392
:param to_branch: branch that the checkout is to reference
1394
raise NotImplementedError(self.set_reference)
1396
def get_format_string(self):
1397
"""Return the ASCII format string that identifies this format."""
1398
raise NotImplementedError(self.get_format_string)
1400
def get_format_description(self):
1401
"""Return the short format description for this format."""
1402
raise NotImplementedError(self.get_format_description)
1404
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
1406
"""Initialize a branch in a bzrdir, with specified files
1408
:param a_bzrdir: The bzrdir to initialize the branch in
1409
:param utf8_files: The files to create as a list of
1410
(filename, content) tuples
1411
:param set_format: If True, set the format with
1412
self.get_format_string. (BzrBranch4 has its format set
1414
:return: a branch in this format
1416
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1417
branch_transport = a_bzrdir.get_branch_transport(self)
1419
'metadir': ('lock', lockdir.LockDir),
1420
'branch4': ('branch-lock', lockable_files.TransportLock),
1422
lock_name, lock_class = lock_map[lock_type]
1423
control_files = lockable_files.LockableFiles(branch_transport,
1424
lock_name, lock_class)
1425
control_files.create_lock()
1427
control_files.lock_write()
1428
except errors.LockContention:
1429
if lock_type != 'branch4':
1435
utf8_files += [('format', self.get_format_string())]
1437
for (filename, content) in utf8_files:
1438
branch_transport.put_bytes(
1440
mode=a_bzrdir._get_file_mode())
1443
control_files.unlock()
1444
return self.open(a_bzrdir, _found=True)
1446
def initialize(self, a_bzrdir):
1447
"""Create a branch of this format in a_bzrdir."""
1448
raise NotImplementedError(self.initialize)
1450
def is_supported(self):
1451
"""Is this format supported?
1453
Supported formats can be initialized and opened.
1454
Unsupported formats may not support initialization or committing or
1455
some other features depending on the reason for not being supported.
1459
def make_tags(self, branch):
1460
"""Create a tags object for branch.
1462
This method is on BranchFormat, because BranchFormats are reflected
1463
over the wire via network_name(), whereas full Branch instances require
1464
multiple VFS method calls to operate at all.
1466
The default implementation returns a disabled-tags instance.
1468
Note that it is normal for branch to be a RemoteBranch when using tags
1471
return DisabledTags(branch)
1473
def network_name(self):
1474
"""A simple byte string uniquely identifying this format for RPC calls.
1476
MetaDir branch formats use their disk format string to identify the
1477
repository over the wire. All in one formats such as bzr < 0.8, and
1478
foreign formats like svn/git and hg should use some marker which is
1479
unique and immutable.
1481
raise NotImplementedError(self.network_name)
1483
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1484
"""Return the branch object for a_bzrdir
1486
:param a_bzrdir: A BzrDir that contains a branch.
1487
:param _found: a private parameter, do not use it. It is used to
1488
indicate if format probing has already be done.
1489
:param ignore_fallbacks: when set, no fallback branches will be opened
1490
(if there are any). Default is to open fallbacks.
1492
raise NotImplementedError(self.open)
1495
def register_format(klass, format):
1496
"""Register a metadir format."""
1497
klass._formats[format.get_format_string()] = format
1498
# Metadir formats have a network name of their format string, and get
1499
# registered as class factories.
1500
network_format_registry.register(format.get_format_string(), format.__class__)
1503
def set_default_format(klass, format):
1504
klass._default_format = format
1506
def supports_stacking(self):
1507
"""True if this format records a stacked-on branch."""
1511
def unregister_format(klass, format):
1512
del klass._formats[format.get_format_string()]
1515
return self.get_format_description().rstrip()
1517
def supports_tags(self):
1518
"""True if this format supports tags stored in the branch"""
1519
return False # by default
1522
class BranchHooks(Hooks):
1523
"""A dictionary mapping hook name to a list of callables for branch hooks.
1525
e.g. ['set_rh'] Is the list of items to be called when the
1526
set_revision_history function is invoked.
1530
"""Create the default hooks.
1532
These are all empty initially, because by default nothing should get
1535
Hooks.__init__(self)
1536
self.create_hook(HookPoint('set_rh',
1537
"Invoked whenever the revision history has been set via "
1538
"set_revision_history. The api signature is (branch, "
1539
"revision_history), and the branch will be write-locked. "
1540
"The set_rh hook can be expensive for bzr to trigger, a better "
1541
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1542
self.create_hook(HookPoint('open',
1543
"Called with the Branch object that has been opened after a "
1544
"branch is opened.", (1, 8), None))
1545
self.create_hook(HookPoint('post_push',
1546
"Called after a push operation completes. post_push is called "
1547
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1548
"bzr client.", (0, 15), None))
1549
self.create_hook(HookPoint('post_pull',
1550
"Called after a pull operation completes. post_pull is called "
1551
"with a bzrlib.branch.PullResult object and only runs in the "
1552
"bzr client.", (0, 15), None))
1553
self.create_hook(HookPoint('pre_commit',
1554
"Called after a commit is calculated but before it is is "
1555
"completed. pre_commit is called with (local, master, old_revno, "
1556
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1557
"). old_revid is NULL_REVISION for the first commit to a branch, "
1558
"tree_delta is a TreeDelta object describing changes from the "
1559
"basis revision. hooks MUST NOT modify this delta. "
1560
" future_tree is an in-memory tree obtained from "
1561
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1562
"tree.", (0,91), None))
1563
self.create_hook(HookPoint('post_commit',
1564
"Called in the bzr client after a commit has completed. "
1565
"post_commit is called with (local, master, old_revno, old_revid, "
1566
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1567
"commit to a branch.", (0, 15), None))
1568
self.create_hook(HookPoint('post_uncommit',
1569
"Called in the bzr client after an uncommit completes. "
1570
"post_uncommit is called with (local, master, old_revno, "
1571
"old_revid, new_revno, new_revid) where local is the local branch "
1572
"or None, master is the target branch, and an empty branch "
1573
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1574
self.create_hook(HookPoint('pre_change_branch_tip',
1575
"Called in bzr client and server before a change to the tip of a "
1576
"branch is made. pre_change_branch_tip is called with a "
1577
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1578
"commit, uncommit will all trigger this hook.", (1, 6), None))
1579
self.create_hook(HookPoint('post_change_branch_tip',
1580
"Called in bzr client and server after a change to the tip of a "
1581
"branch is made. post_change_branch_tip is called with a "
1582
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1583
"commit, uncommit will all trigger this hook.", (1, 4), None))
1584
self.create_hook(HookPoint('transform_fallback_location',
1585
"Called when a stacked branch is activating its fallback "
1586
"locations. transform_fallback_location is called with (branch, "
1587
"url), and should return a new url. Returning the same url "
1588
"allows it to be used as-is, returning a different one can be "
1589
"used to cause the branch to stack on a closer copy of that "
1590
"fallback_location. Note that the branch cannot have history "
1591
"accessing methods called on it during this hook because the "
1592
"fallback locations have not been activated. When there are "
1593
"multiple hooks installed for transform_fallback_location, "
1594
"all are called with the url returned from the previous hook."
1595
"The order is however undefined.", (1, 9), None))
1598
# install the default hooks into the Branch class.
1599
Branch.hooks = BranchHooks()
1602
class ChangeBranchTipParams(object):
1603
"""Object holding parameters passed to *_change_branch_tip hooks.
1605
There are 5 fields that hooks may wish to access:
1607
:ivar branch: the branch being changed
1608
:ivar old_revno: revision number before the change
1609
:ivar new_revno: revision number after the change
1610
:ivar old_revid: revision id before the change
1611
:ivar new_revid: revision id after the change
1613
The revid fields are strings. The revno fields are integers.
1616
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1617
"""Create a group of ChangeBranchTip parameters.
1619
:param branch: The branch being changed.
1620
:param old_revno: Revision number before the change.
1621
:param new_revno: Revision number after the change.
1622
:param old_revid: Tip revision id before the change.
1623
:param new_revid: Tip revision id after the change.
1625
self.branch = branch
1626
self.old_revno = old_revno
1627
self.new_revno = new_revno
1628
self.old_revid = old_revid
1629
self.new_revid = new_revid
1631
def __eq__(self, other):
1632
return self.__dict__ == other.__dict__
1635
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1636
self.__class__.__name__, self.branch,
1637
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1640
class BzrBranchFormat4(BranchFormat):
1641
"""Bzr branch format 4.
1644
- a revision-history file.
1645
- a branch-lock lock file [ to be shared with the bzrdir ]
1648
def get_format_description(self):
1649
"""See BranchFormat.get_format_description()."""
1650
return "Branch format 4"
1652
def initialize(self, a_bzrdir):
1653
"""Create a branch of this format in a_bzrdir."""
1654
utf8_files = [('revision-history', ''),
1655
('branch-name', ''),
1657
return self._initialize_helper(a_bzrdir, utf8_files,
1658
lock_type='branch4', set_format=False)
1661
super(BzrBranchFormat4, self).__init__()
1662
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1664
def network_name(self):
1665
"""The network name for this format is the control dirs disk label."""
1666
return self._matchingbzrdir.get_format_string()
1668
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1669
"""See BranchFormat.open()."""
1671
# we are being called directly and must probe.
1672
raise NotImplementedError
1673
return BzrBranch(_format=self,
1674
_control_files=a_bzrdir._control_files,
1676
_repository=a_bzrdir.open_repository())
1679
return "Bazaar-NG branch format 4"
1682
class BranchFormatMetadir(BranchFormat):
1683
"""Common logic for meta-dir based branch formats."""
1685
def _branch_class(self):
1686
"""What class to instantiate on open calls."""
1687
raise NotImplementedError(self._branch_class)
1689
def network_name(self):
1690
"""A simple byte string uniquely identifying this format for RPC calls.
1692
Metadir branch formats use their format string.
1694
return self.get_format_string()
1696
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1697
"""See BranchFormat.open()."""
1699
format = BranchFormat.find_format(a_bzrdir)
1700
if format.__class__ != self.__class__:
1701
raise AssertionError("wrong format %r found for %r" %
1704
transport = a_bzrdir.get_branch_transport(None)
1705
control_files = lockable_files.LockableFiles(transport, 'lock',
1707
return self._branch_class()(_format=self,
1708
_control_files=control_files,
1710
_repository=a_bzrdir.find_repository(),
1711
ignore_fallbacks=ignore_fallbacks)
1712
except errors.NoSuchFile:
1713
raise errors.NotBranchError(path=transport.base)
1716
super(BranchFormatMetadir, self).__init__()
1717
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1718
self._matchingbzrdir.set_branch_format(self)
1720
def supports_tags(self):
1724
class BzrBranchFormat5(BranchFormatMetadir):
1725
"""Bzr branch format 5.
1728
- a revision-history file.
1730
- a lock dir guarding the branch itself
1731
- all of this stored in a branch/ subdirectory
1732
- works with shared repositories.
1734
This format is new in bzr 0.8.
1737
def _branch_class(self):
1740
def get_format_string(self):
1741
"""See BranchFormat.get_format_string()."""
1742
return "Bazaar-NG branch format 5\n"
1744
def get_format_description(self):
1745
"""See BranchFormat.get_format_description()."""
1746
return "Branch format 5"
1748
def initialize(self, a_bzrdir):
1749
"""Create a branch of this format in a_bzrdir."""
1750
utf8_files = [('revision-history', ''),
1751
('branch-name', ''),
1753
return self._initialize_helper(a_bzrdir, utf8_files)
1755
def supports_tags(self):
1759
class BzrBranchFormat6(BranchFormatMetadir):
1760
"""Branch format with last-revision and tags.
1762
Unlike previous formats, this has no explicit revision history. Instead,
1763
this just stores the last-revision, and the left-hand history leading
1764
up to there is the history.
1766
This format was introduced in bzr 0.15
1767
and became the default in 0.91.
1770
def _branch_class(self):
1773
def get_format_string(self):
1774
"""See BranchFormat.get_format_string()."""
1775
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1777
def get_format_description(self):
1778
"""See BranchFormat.get_format_description()."""
1779
return "Branch format 6"
1781
def initialize(self, a_bzrdir):
1782
"""Create a branch of this format in a_bzrdir."""
1783
utf8_files = [('last-revision', '0 null:\n'),
1784
('branch.conf', ''),
1787
return self._initialize_helper(a_bzrdir, utf8_files)
1789
def make_tags(self, branch):
1790
"""See bzrlib.branch.BranchFormat.make_tags()."""
1791
return BasicTags(branch)
1795
class BzrBranchFormat8(BranchFormatMetadir):
1796
"""Metadir format supporting storing locations of subtree branches."""
1798
def _branch_class(self):
1801
def get_format_string(self):
1802
"""See BranchFormat.get_format_string()."""
1803
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
1805
def get_format_description(self):
1806
"""See BranchFormat.get_format_description()."""
1807
return "Branch format 8"
1809
def initialize(self, a_bzrdir):
1810
"""Create a branch of this format in a_bzrdir."""
1811
utf8_files = [('last-revision', '0 null:\n'),
1812
('branch.conf', ''),
1816
return self._initialize_helper(a_bzrdir, utf8_files)
1819
super(BzrBranchFormat8, self).__init__()
1820
self._matchingbzrdir.repository_format = \
1821
RepositoryFormatKnitPack5RichRoot()
1823
def make_tags(self, branch):
1824
"""See bzrlib.branch.BranchFormat.make_tags()."""
1825
return BasicTags(branch)
1827
def supports_stacking(self):
1830
supports_reference_locations = True
1833
class BzrBranchFormat7(BzrBranchFormat8):
1834
"""Branch format with last-revision, tags, and a stacked location pointer.
1836
The stacked location pointer is passed down to the repository and requires
1837
a repository format with supports_external_lookups = True.
1839
This format was introduced in bzr 1.6.
1842
def initialize(self, a_bzrdir):
1843
"""Create a branch of this format in a_bzrdir."""
1844
utf8_files = [('last-revision', '0 null:\n'),
1845
('branch.conf', ''),
1848
return self._initialize_helper(a_bzrdir, utf8_files)
1850
def _branch_class(self):
1853
def get_format_string(self):
1854
"""See BranchFormat.get_format_string()."""
1855
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
1857
def get_format_description(self):
1858
"""See BranchFormat.get_format_description()."""
1859
return "Branch format 7"
1861
supports_reference_locations = False
1864
class BranchReferenceFormat(BranchFormat):
1865
"""Bzr branch reference format.
1867
Branch references are used in implementing checkouts, they
1868
act as an alias to the real branch which is at some other url.
1875
def get_format_string(self):
1876
"""See BranchFormat.get_format_string()."""
1877
return "Bazaar-NG Branch Reference Format 1\n"
1879
def get_format_description(self):
1880
"""See BranchFormat.get_format_description()."""
1881
return "Checkout reference format 1"
1883
def get_reference(self, a_bzrdir):
1884
"""See BranchFormat.get_reference()."""
1885
transport = a_bzrdir.get_branch_transport(None)
1886
return transport.get('location').read()
1888
def set_reference(self, a_bzrdir, to_branch):
1889
"""See BranchFormat.set_reference()."""
1890
transport = a_bzrdir.get_branch_transport(None)
1891
location = transport.put_bytes('location', to_branch.base)
1893
def initialize(self, a_bzrdir, target_branch=None):
1894
"""Create a branch of this format in a_bzrdir."""
1895
if target_branch is None:
1896
# this format does not implement branch itself, thus the implicit
1897
# creation contract must see it as uninitializable
1898
raise errors.UninitializableFormat(self)
1899
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1900
branch_transport = a_bzrdir.get_branch_transport(self)
1901
branch_transport.put_bytes('location',
1902
target_branch.bzrdir.root_transport.base)
1903
branch_transport.put_bytes('format', self.get_format_string())
1905
a_bzrdir, _found=True,
1906
possible_transports=[target_branch.bzrdir.root_transport])
1909
super(BranchReferenceFormat, self).__init__()
1910
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1911
self._matchingbzrdir.set_branch_format(self)
1913
def _make_reference_clone_function(format, a_branch):
1914
"""Create a clone() routine for a branch dynamically."""
1915
def clone(to_bzrdir, revision_id=None,
1916
repository_policy=None):
1917
"""See Branch.clone()."""
1918
return format.initialize(to_bzrdir, a_branch)
1919
# cannot obey revision_id limits when cloning a reference ...
1920
# FIXME RBC 20060210 either nuke revision_id for clone, or
1921
# emit some sort of warning/error to the caller ?!
1924
def open(self, a_bzrdir, _found=False, location=None,
1925
possible_transports=None, ignore_fallbacks=False):
1926
"""Return the branch that the branch reference in a_bzrdir points at.
1928
:param a_bzrdir: A BzrDir that contains a branch.
1929
:param _found: a private parameter, do not use it. It is used to
1930
indicate if format probing has already be done.
1931
:param ignore_fallbacks: when set, no fallback branches will be opened
1932
(if there are any). Default is to open fallbacks.
1933
:param location: The location of the referenced branch. If
1934
unspecified, this will be determined from the branch reference in
1936
:param possible_transports: An optional reusable transports list.
1939
format = BranchFormat.find_format(a_bzrdir)
1940
if format.__class__ != self.__class__:
1941
raise AssertionError("wrong format %r found for %r" %
1943
if location is None:
1944
location = self.get_reference(a_bzrdir)
1945
real_bzrdir = bzrdir.BzrDir.open(
1946
location, possible_transports=possible_transports)
1947
result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
1948
# this changes the behaviour of result.clone to create a new reference
1949
# rather than a copy of the content of the branch.
1950
# I did not use a proxy object because that needs much more extensive
1951
# testing, and we are only changing one behaviour at the moment.
1952
# If we decide to alter more behaviours - i.e. the implicit nickname
1953
# then this should be refactored to introduce a tested proxy branch
1954
# and a subclass of that for use in overriding clone() and ....
1956
result.clone = self._make_reference_clone_function(result)
1960
network_format_registry = registry.FormatRegistry()
1961
"""Registry of formats indexed by their network name.
1963
The network name for a branch format is an identifier that can be used when
1964
referring to formats with smart server operations. See
1965
BranchFormat.network_name() for more detail.
1969
# formats which have no format string are not discoverable
1970
# and not independently creatable, so are not registered.
1971
__format5 = BzrBranchFormat5()
1972
__format6 = BzrBranchFormat6()
1973
__format7 = BzrBranchFormat7()
1974
__format8 = BzrBranchFormat8()
1975
BranchFormat.register_format(__format5)
1976
BranchFormat.register_format(BranchReferenceFormat())
1977
BranchFormat.register_format(__format6)
1978
BranchFormat.register_format(__format7)
1979
BranchFormat.register_format(__format8)
1980
BranchFormat.set_default_format(__format6)
1981
_legacy_formats = [BzrBranchFormat4(),
1983
network_format_registry.register(
1984
_legacy_formats[0].network_name(), _legacy_formats[0].__class__)
1987
class BzrBranch(Branch):
1988
"""A branch stored in the actual filesystem.
1990
Note that it's "local" in the context of the filesystem; it doesn't
1991
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1992
it's writable, and can be accessed via the normal filesystem API.
1994
:ivar _transport: Transport for file operations on this branch's
1995
control files, typically pointing to the .bzr/branch directory.
1996
:ivar repository: Repository for this branch.
1997
:ivar base: The url of the base directory for this branch; the one
1998
containing the .bzr directory.
2001
def __init__(self, _format=None,
2002
_control_files=None, a_bzrdir=None, _repository=None,
2003
ignore_fallbacks=False):
2004
"""Create new branch object at a particular location."""
2005
if a_bzrdir is None:
2006
raise ValueError('a_bzrdir must be supplied')
2008
self.bzrdir = a_bzrdir
2009
self._base = self.bzrdir.transport.clone('..').base
2010
# XXX: We should be able to just do
2011
# self.base = self.bzrdir.root_transport.base
2012
# but this does not quite work yet -- mbp 20080522
2013
self._format = _format
2014
if _control_files is None:
2015
raise ValueError('BzrBranch _control_files is None')
2016
self.control_files = _control_files
2017
self._transport = _control_files._transport
2018
self.repository = _repository
2019
Branch.__init__(self)
2022
return '%s(%r)' % (self.__class__.__name__, self.base)
2026
def _get_base(self):
2027
"""Returns the directory containing the control directory."""
2030
base = property(_get_base, doc="The URL for the root of this branch.")
2032
def _get_config(self):
2033
return TransportConfig(self._transport, 'branch.conf')
2035
def is_locked(self):
2036
return self.control_files.is_locked()
2038
def lock_write(self, token=None):
2039
# All-in-one needs to always unlock/lock.
2040
repo_control = getattr(self.repository, 'control_files', None)
2041
if self.control_files == repo_control or not self.is_locked():
2042
self.repository.lock_write()
2047
return self.control_files.lock_write(token=token)
2050
self.repository.unlock()
2053
def lock_read(self):
2054
# All-in-one needs to always unlock/lock.
2055
repo_control = getattr(self.repository, 'control_files', None)
2056
if self.control_files == repo_control or not self.is_locked():
2057
self.repository.lock_read()
2062
self.control_files.lock_read()
2065
self.repository.unlock()
2070
self.control_files.unlock()
2072
# All-in-one needs to always unlock/lock.
2073
repo_control = getattr(self.repository, 'control_files', None)
2074
if (self.control_files == repo_control or
2075
not self.control_files.is_locked()):
2076
self.repository.unlock()
2077
if not self.control_files.is_locked():
2078
# we just released the lock
2079
self._clear_cached_state()
2081
def peek_lock_mode(self):
2082
if self.control_files._lock_count == 0:
2085
return self.control_files._lock_mode
2087
def get_physical_lock_status(self):
2088
return self.control_files.get_physical_lock_status()
2091
def print_file(self, file, revision_id):
2092
"""See Branch.print_file."""
2093
return self.repository.print_file(file, revision_id)
2095
def _write_revision_history(self, history):
2096
"""Factored out of set_revision_history.
2098
This performs the actual writing to disk.
2099
It is intended to be called by BzrBranch5.set_revision_history."""
2100
self._transport.put_bytes(
2101
'revision-history', '\n'.join(history),
2102
mode=self.bzrdir._get_file_mode())
2105
def set_revision_history(self, rev_history):
2106
"""See Branch.set_revision_history."""
2107
if 'evil' in debug.debug_flags:
2108
mutter_callsite(3, "set_revision_history scales with history.")
2109
check_not_reserved_id = _mod_revision.check_not_reserved_id
2110
for rev_id in rev_history:
2111
check_not_reserved_id(rev_id)
2112
if Branch.hooks['post_change_branch_tip']:
2113
# Don't calculate the last_revision_info() if there are no hooks
2115
old_revno, old_revid = self.last_revision_info()
2116
if len(rev_history) == 0:
2117
revid = _mod_revision.NULL_REVISION
2119
revid = rev_history[-1]
2120
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2121
self._write_revision_history(rev_history)
2122
self._clear_cached_state()
2123
self._cache_revision_history(rev_history)
2124
for hook in Branch.hooks['set_rh']:
2125
hook(self, rev_history)
2126
if Branch.hooks['post_change_branch_tip']:
2127
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2129
def _synchronize_history(self, destination, revision_id):
2130
"""Synchronize last revision and revision history between branches.
2132
This version is most efficient when the destination is also a
2133
BzrBranch5, but works for BzrBranch6 as long as the revision
2134
history is the true lefthand parent history, and all of the revisions
2135
are in the destination's repository. If not, set_revision_history
2138
:param destination: The branch to copy the history into
2139
:param revision_id: The revision-id to truncate history at. May
2140
be None to copy complete history.
2142
if not isinstance(destination._format, BzrBranchFormat5):
2143
super(BzrBranch, self)._synchronize_history(
2144
destination, revision_id)
2146
if revision_id == _mod_revision.NULL_REVISION:
2149
new_history = self.revision_history()
2150
if revision_id is not None and new_history != []:
2152
new_history = new_history[:new_history.index(revision_id) + 1]
2154
rev = self.repository.get_revision(revision_id)
2155
new_history = rev.get_history(self.repository)[1:]
2156
destination.set_revision_history(new_history)
2159
def set_last_revision_info(self, revno, revision_id):
2160
"""Set the last revision of this branch.
2162
The caller is responsible for checking that the revno is correct
2163
for this revision id.
2165
It may be possible to set the branch last revision to an id not
2166
present in the repository. However, branches can also be
2167
configured to check constraints on history, in which case this may not
2170
revision_id = _mod_revision.ensure_null(revision_id)
2171
# this old format stores the full history, but this api doesn't
2172
# provide it, so we must generate, and might as well check it's
2174
history = self._lefthand_history(revision_id)
2175
if len(history) != revno:
2176
raise AssertionError('%d != %d' % (len(history), revno))
2177
self.set_revision_history(history)
2179
def _gen_revision_history(self):
2180
history = self._transport.get_bytes('revision-history').split('\n')
2181
if history[-1:] == ['']:
2182
# There shouldn't be a trailing newline, but just in case.
2187
def generate_revision_history(self, revision_id, last_rev=None,
2189
"""Create a new revision history that will finish with revision_id.
2191
:param revision_id: the new tip to use.
2192
:param last_rev: The previous last_revision. If not None, then this
2193
must be a ancestory of revision_id, or DivergedBranches is raised.
2194
:param other_branch: The other branch that DivergedBranches should
2195
raise with respect to.
2197
self.set_revision_history(self._lefthand_history(revision_id,
2198
last_rev, other_branch))
2200
def basis_tree(self):
2201
"""See Branch.basis_tree."""
2202
return self.repository.revision_tree(self.last_revision())
2204
def _get_parent_location(self):
2205
_locs = ['parent', 'pull', 'x-pull']
2208
return self._transport.get_bytes(l).strip('\n')
2209
except errors.NoSuchFile:
2213
def _basic_push(self, target, overwrite, stop_revision):
2214
"""Basic implementation of push without bound branches or hooks.
2216
Must be called with source read locked and target write locked.
2218
result = BranchPushResult()
2219
result.source_branch = self
2220
result.target_branch = target
2221
result.old_revno, result.old_revid = target.last_revision_info()
2222
self.update_references(target)
2223
if result.old_revid != self.last_revision():
2224
# We assume that during 'push' this repository is closer than
2226
graph = self.repository.get_graph(target.repository)
2227
target.update_revisions(self, stop_revision,
2228
overwrite=overwrite, graph=graph)
2229
if self._push_should_merge_tags():
2230
result.tag_conflicts = self.tags.merge_to(target.tags,
2232
result.new_revno, result.new_revid = target.last_revision_info()
2235
def get_stacked_on_url(self):
2236
raise errors.UnstackableBranchFormat(self._format, self.base)
2238
def set_push_location(self, location):
2239
"""See Branch.set_push_location."""
2240
self.get_config().set_user_option(
2241
'push_location', location,
2242
store=_mod_config.STORE_LOCATION_NORECURSE)
2244
def _set_parent_location(self, url):
2246
self._transport.delete('parent')
2248
self._transport.put_bytes('parent', url + '\n',
2249
mode=self.bzrdir._get_file_mode())
2252
class BzrBranch5(BzrBranch):
2253
"""A format 5 branch. This supports new features over plain branches.
2255
It has support for a master_branch which is the data for bound branches.
2258
def get_bound_location(self):
2260
return self._transport.get_bytes('bound')[:-1]
2261
except errors.NoSuchFile:
2265
def get_master_branch(self, possible_transports=None):
2266
"""Return the branch we are bound to.
2268
:return: Either a Branch, or None
2270
This could memoise the branch, but if thats done
2271
it must be revalidated on each new lock.
2272
So for now we just don't memoise it.
2273
# RBC 20060304 review this decision.
2275
bound_loc = self.get_bound_location()
2279
return Branch.open(bound_loc,
2280
possible_transports=possible_transports)
2281
except (errors.NotBranchError, errors.ConnectionError), e:
2282
raise errors.BoundBranchConnectionFailure(
2286
def set_bound_location(self, location):
2287
"""Set the target where this branch is bound to.
2289
:param location: URL to the target branch
2292
self._transport.put_bytes('bound', location+'\n',
2293
mode=self.bzrdir._get_file_mode())
2296
self._transport.delete('bound')
2297
except errors.NoSuchFile:
2302
def bind(self, other):
2303
"""Bind this branch to the branch other.
2305
This does not push or pull data between the branches, though it does
2306
check for divergence to raise an error when the branches are not
2307
either the same, or one a prefix of the other. That behaviour may not
2308
be useful, so that check may be removed in future.
2310
:param other: The branch to bind to
2313
# TODO: jam 20051230 Consider checking if the target is bound
2314
# It is debatable whether you should be able to bind to
2315
# a branch which is itself bound.
2316
# Committing is obviously forbidden,
2317
# but binding itself may not be.
2318
# Since we *have* to check at commit time, we don't
2319
# *need* to check here
2321
# we want to raise diverged if:
2322
# last_rev is not in the other_last_rev history, AND
2323
# other_last_rev is not in our history, and do it without pulling
2325
self.set_bound_location(other.base)
2329
"""If bound, unbind"""
2330
return self.set_bound_location(None)
2333
def update(self, possible_transports=None):
2334
"""Synchronise this branch with the master branch if any.
2336
:return: None or the last_revision that was pivoted out during the
2339
master = self.get_master_branch(possible_transports)
2340
if master is not None:
2341
old_tip = _mod_revision.ensure_null(self.last_revision())
2342
self.pull(master, overwrite=True)
2343
if self.repository.get_graph().is_ancestor(old_tip,
2344
_mod_revision.ensure_null(self.last_revision())):
2350
class BzrBranch8(BzrBranch5):
2351
"""A branch that stores tree-reference locations."""
2353
def _open_hook(self):
2354
if self._ignore_fallbacks:
2357
url = self.get_stacked_on_url()
2358
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2359
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:
2362
for hook in Branch.hooks['transform_fallback_location']:
2363
url = hook(self, url)
2365
hook_name = Branch.hooks.get_hook_name(hook)
2366
raise AssertionError(
2367
"'transform_fallback_location' hook %s returned "
2368
"None, not a URL." % hook_name)
2369
self._activate_fallback_location(url, None)
2371
def __init__(self, *args, **kwargs):
2372
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2373
super(BzrBranch8, self).__init__(*args, **kwargs)
2374
self._last_revision_info_cache = None
2375
self._partial_revision_history_cache = []
2376
self._reference_info = None
2378
def _clear_cached_state(self):
2379
super(BzrBranch8, self)._clear_cached_state()
2380
self._last_revision_info_cache = None
2381
self._partial_revision_history_cache = []
2382
self._reference_info = None
2384
def _last_revision_info(self):
2385
revision_string = self._transport.get_bytes('last-revision')
2386
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2387
revision_id = cache_utf8.get_cached_utf8(revision_id)
2389
return revno, revision_id
2391
def _write_last_revision_info(self, revno, revision_id):
2392
"""Simply write out the revision id, with no checks.
2394
Use set_last_revision_info to perform this safely.
2396
Does not update the revision_history cache.
2397
Intended to be called by set_last_revision_info and
2398
_write_revision_history.
2400
revision_id = _mod_revision.ensure_null(revision_id)
2401
out_string = '%d %s\n' % (revno, revision_id)
2402
self._transport.put_bytes('last-revision', out_string,
2403
mode=self.bzrdir._get_file_mode())
2406
def set_last_revision_info(self, revno, revision_id):
2407
revision_id = _mod_revision.ensure_null(revision_id)
2408
old_revno, old_revid = self.last_revision_info()
2409
if self._get_append_revisions_only():
2410
self._check_history_violation(revision_id)
2411
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2412
self._write_last_revision_info(revno, revision_id)
2413
self._clear_cached_state()
2414
self._last_revision_info_cache = revno, revision_id
2415
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2417
def _synchronize_history(self, destination, revision_id):
2418
"""Synchronize last revision and revision history between branches.
2420
:see: Branch._synchronize_history
2422
# XXX: The base Branch has a fast implementation of this method based
2423
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2424
# that uses set_revision_history. This class inherits from BzrBranch5,
2425
# but wants the fast implementation, so it calls
2426
# Branch._synchronize_history directly.
2427
Branch._synchronize_history(self, destination, revision_id)
2429
def _check_history_violation(self, revision_id):
2430
last_revision = _mod_revision.ensure_null(self.last_revision())
2431
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
2433
if last_revision not in self._lefthand_history(revision_id):
2434
raise errors.AppendRevisionsOnlyViolation(self.base)
2436
def _gen_revision_history(self):
2437
"""Generate the revision history from last revision
2439
last_revno, last_revision = self.last_revision_info()
2440
self._extend_partial_history(stop_index=last_revno-1)
2441
return list(reversed(self._partial_revision_history_cache))
2443
def _extend_partial_history(self, stop_index=None, stop_revision=None):
2444
"""Extend the partial history to include a given index
2446
If a stop_index is supplied, stop when that index has been reached.
2447
If a stop_revision is supplied, stop when that revision is
2448
encountered. Otherwise, stop when the beginning of history is
2451
:param stop_index: The index which should be present. When it is
2452
present, history extension will stop.
2453
:param revision_id: The revision id which should be present. When
2454
it is encountered, history extension will stop.
2456
repo = self.repository
2457
if len(self._partial_revision_history_cache) == 0:
2458
iterator = repo.iter_reverse_revision_history(self.last_revision())
2460
start_revision = self._partial_revision_history_cache[-1]
2461
iterator = repo.iter_reverse_revision_history(start_revision)
2462
#skip the last revision in the list
2463
next_revision = iterator.next()
2464
for revision_id in iterator:
2465
self._partial_revision_history_cache.append(revision_id)
2466
if (stop_index is not None and
2467
len(self._partial_revision_history_cache) > stop_index):
2469
if revision_id == stop_revision:
2472
def _write_revision_history(self, history):
2473
"""Factored out of set_revision_history.
2475
This performs the actual writing to disk, with format-specific checks.
2476
It is intended to be called by BzrBranch5.set_revision_history.
2478
if len(history) == 0:
2479
last_revision = 'null:'
2481
if history != self._lefthand_history(history[-1]):
2482
raise errors.NotLefthandHistory(history)
2483
last_revision = history[-1]
2484
if self._get_append_revisions_only():
2485
self._check_history_violation(last_revision)
2486
self._write_last_revision_info(len(history), last_revision)
2489
def _set_parent_location(self, url):
2490
"""Set the parent branch"""
2491
self._set_config_location('parent_location', url, make_relative=True)
2494
def _get_parent_location(self):
2495
"""Set the parent branch"""
2496
return self._get_config_location('parent_location')
2499
def _set_all_reference_info(self, info_dict):
2500
"""Replace all reference info stored in a branch.
2502
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2505
writer = rio.RioWriter(s)
2506
for key, (tree_path, branch_location) in info_dict.iteritems():
2507
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2508
branch_location=branch_location)
2509
writer.write_stanza(stanza)
2510
self._transport.put_bytes('references', s.getvalue())
2511
self._reference_info = info_dict
2514
def _get_all_reference_info(self):
2515
"""Return all the reference info stored in a branch.
2517
:return: A dict of {file_id: (tree_path, branch_location)}
2519
if self._reference_info is not None:
2520
return self._reference_info
2521
rio_file = self._transport.get('references')
1256
f = AtomicFile(self.controlfilename('pending-merges'))
2523
stanzas = rio.read_stanzas(rio_file)
2524
info_dict = dict((s['file_id'], (s['tree_path'],
2525
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()
2528
self._reference_info = info_dict
2531
def set_reference_info(self, file_id, tree_path, branch_location):
2532
"""Set the branch location to use for a tree reference.
2534
:param file_id: The file-id of the tree reference.
2535
:param tree_path: The path of the tree reference in the tree.
2536
:param branch_location: The location of the branch to retrieve tree
2539
info_dict = self._get_all_reference_info()
2540
info_dict[file_id] = (tree_path, branch_location)
2541
if None in (tree_path, branch_location):
2542
if tree_path is not None:
2543
raise ValueError('tree_path must be None when branch_location'
2545
if branch_location is not None:
2546
raise ValueError('branch_location must be None when tree_path'
2548
del info_dict[file_id]
2549
self._set_all_reference_info(info_dict)
2551
def get_reference_info(self, file_id):
2552
"""Get the tree_path and branch_location for a tree reference.
2554
:return: a tuple of (tree_path, branch_location)
2556
return self._get_all_reference_info().get(file_id, (None, None))
2558
def reference_parent(self, file_id, path, possible_transports=None):
2559
"""Return the parent branch for a tree-reference file_id.
2561
:param file_id: The file_id of the tree reference
2562
:param path: The path of the file_id in the tree
2563
:return: A branch associated with the file_id
2565
branch_location = self.get_reference_info(file_id)[1]
2566
if branch_location is None:
2567
return Branch.reference_parent(self, file_id, path,
2568
possible_transports)
2569
branch_location = urlutils.join(self.base, branch_location)
2570
return Branch.open(branch_location,
2571
possible_transports=possible_transports)
2573
def set_push_location(self, location):
2574
"""See Branch.set_push_location."""
2575
self._set_config_location('push_location', location)
2577
def set_bound_location(self, location):
2578
"""See Branch.set_push_location."""
2580
config = self.get_config()
2581
if location is None:
2582
if config.get_user_option('bound') != 'True':
2585
config.set_user_option('bound', 'False', warn_masked=True)
2588
self._set_config_location('bound_location', location,
2590
config.set_user_option('bound', 'True', warn_masked=True)
2593
def _get_bound_location(self, bound):
2594
"""Return the bound location in the config file.
2596
Return None if the bound parameter does not match"""
2597
config = self.get_config()
2598
config_bound = (config.get_user_option('bound') == 'True')
2599
if config_bound != bound:
2601
return self._get_config_location('bound_location', config=config)
2603
def get_bound_location(self):
2604
"""See Branch.set_push_location."""
2605
return self._get_bound_location(True)
2607
def get_old_bound_location(self):
2608
"""See Branch.get_old_bound_location"""
2609
return self._get_bound_location(False)
2611
def get_stacked_on_url(self):
2612
# you can always ask for the URL; but you might not be able to use it
2613
# if the repo can't support stacking.
2614
## self._check_stackable_repo()
2615
stacked_url = self._get_config_location('stacked_on_location')
2616
if stacked_url is None:
2617
raise errors.NotStacked(self)
2620
def set_append_revisions_only(self, enabled):
2625
self.get_config().set_user_option('append_revisions_only', value,
2628
def _get_append_revisions_only(self):
2629
value = self.get_config().get_user_option('append_revisions_only')
2630
return value == 'True'
2633
def generate_revision_history(self, revision_id, last_rev=None,
2635
"""See BzrBranch5.generate_revision_history"""
2636
history = self._lefthand_history(revision_id, last_rev, other_branch)
2637
revno = len(history)
2638
self.set_last_revision_info(revno, revision_id)
2641
def get_rev_id(self, revno, history=None):
2642
"""Find the revision id of the specified revno."""
2644
return _mod_revision.NULL_REVISION
2646
last_revno, last_revision_id = self.last_revision_info()
2647
if revno <= 0 or revno > last_revno:
2648
raise errors.NoSuchRevision(self, revno)
2650
if history is not None:
2651
return history[revno - 1]
2653
index = last_revno - revno
2654
if len(self._partial_revision_history_cache) <= index:
2655
self._extend_partial_history(stop_index=index)
2656
if len(self._partial_revision_history_cache) > index:
2657
return self._partial_revision_history_cache[index]
2659
raise errors.NoSuchRevision(self, revno)
2662
def revision_id_to_revno(self, revision_id):
2663
"""Given a revision id, return its revno"""
2664
if _mod_revision.is_null(revision_id):
2667
index = self._partial_revision_history_cache.index(revision_id)
2669
self._extend_partial_history(stop_revision=revision_id)
2670
index = len(self._partial_revision_history_cache) - 1
2671
if self._partial_revision_history_cache[index] != revision_id:
2672
raise errors.NoSuchRevision(self, revision_id)
2673
return self.revno() - index
2676
class BzrBranch7(BzrBranch8):
2677
"""A branch with support for a fallback repository."""
2679
def set_reference_info(self, file_id, tree_path, branch_location):
2680
Branch.set_reference_info(self, file_id, tree_path, branch_location)
2682
def get_reference_info(self, file_id):
2683
Branch.get_reference_info(self, file_id)
2685
def reference_parent(self, file_id, path, possible_transports=None):
2686
return Branch.reference_parent(self, file_id, path,
2687
possible_transports)
2690
class BzrBranch6(BzrBranch7):
2691
"""See BzrBranchFormat6 for the capabilities of this branch.
2693
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)
2697
def get_stacked_on_url(self):
2698
raise errors.UnstackableBranchFormat(self._format, self.base)
1337
2701
######################################################################
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')
2702
# results of operations
2705
class _Result(object):
2707
def _show_tag_conficts(self, to_file):
2708
if not getattr(self, 'tag_conflicts', None):
2710
to_file.write('Conflicting tags:\n')
2711
for name, value1, value2 in self.tag_conflicts:
2712
to_file.write(' %s\n' % (name, ))
2715
class PullResult(_Result):
2716
"""Result of a Branch.pull operation.
2718
:ivar old_revno: Revision number before pull.
2719
:ivar new_revno: Revision number after pull.
2720
:ivar old_revid: Tip revision id before pull.
2721
:ivar new_revid: Tip revision id after pull.
2722
:ivar source_branch: Source (local) branch object. (read locked)
2723
:ivar master_branch: Master branch of the target, or the target if no
2725
:ivar local_branch: target branch if there is a Master, else None
2726
:ivar target_branch: Target/destination branch object. (write locked)
2727
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2731
# DEPRECATED: pull used to return the change in revno
2732
return self.new_revno - self.old_revno
2734
def report(self, to_file):
2736
if self.old_revid == self.new_revid:
2737
to_file.write('No revisions to pull.\n')
2739
to_file.write('Now on revision %d.\n' % self.new_revno)
2740
self._show_tag_conficts(to_file)
2743
class BranchPushResult(_Result):
2744
"""Result of a Branch.push operation.
2746
:ivar old_revno: Revision number (eg 10) of the target before push.
2747
:ivar new_revno: Revision number (eg 12) of the target after push.
2748
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
2750
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
2752
:ivar source_branch: Source branch object that the push was from. This is
2753
read locked, and generally is a local (and thus low latency) branch.
2754
:ivar master_branch: If target is a bound branch, the master branch of
2755
target, or target itself. Always write locked.
2756
:ivar target_branch: The direct Branch where data is being sent (write
2758
:ivar local_branch: If the target is a bound branch this will be the
2759
target, otherwise it will be None.
2763
# DEPRECATED: push used to return the change in revno
2764
return self.new_revno - self.old_revno
2766
def report(self, to_file):
2767
"""Write a human-readable description of the result."""
2768
if self.old_revid == self.new_revid:
2769
note('No new revisions to push.')
2771
note('Pushed up to revision %d.' % self.new_revno)
2772
self._show_tag_conficts(to_file)
2775
class BranchCheckResult(object):
2776
"""Results of checking branch consistency.
2781
def __init__(self, branch):
2782
self.branch = branch
2784
def report_results(self, verbose):
2785
"""Report the check results via trace.note.
2787
:param verbose: Requests more detailed display of what was checked,
2790
note('checked branch %s format %s',
2792
self.branch._format)
2795
class Converter5to6(object):
2796
"""Perform an in-place upgrade of format 5 to format 6"""
2798
def convert(self, branch):
2799
# Data for 5 and 6 can peacefully coexist.
2800
format = BzrBranchFormat6()
2801
new_branch = format.open(branch.bzrdir, _found=True)
2803
# Copy source data into target
2804
new_branch._write_last_revision_info(*branch.last_revision_info())
2805
new_branch.set_parent(branch.get_parent())
2806
new_branch.set_bound_location(branch.get_bound_location())
2807
new_branch.set_push_location(branch.get_push_location())
2809
# New branch has no tags by default
2810
new_branch.tags._set_tag_dict({})
2812
# Copying done; now update target format
2813
new_branch._transport.put_bytes('format',
2814
format.get_format_string(),
2815
mode=new_branch.bzrdir._get_file_mode())
2817
# Clean up old files
2818
new_branch._transport.delete('revision-history')
2820
branch.set_parent(None)
2821
except errors.NoSuchFile:
2823
branch.set_bound_location(None)
2826
class Converter6to7(object):
2827
"""Perform an in-place upgrade of format 6 to format 7"""
2829
def convert(self, branch):
2830
format = BzrBranchFormat7()
2831
branch._set_config_location('stacked_on_location', '')
2832
# update target format
2833
branch._transport.put_bytes('format', format.get_format_string())
2836
class Converter7to8(object):
2837
"""Perform an in-place upgrade of format 6 to format 7"""
2839
def convert(self, branch):
2840
format = BzrBranchFormat8()
2841
branch._transport.put_bytes('references', '')
2842
# update target format
2843
branch._transport.put_bytes('format', format.get_format_string())
2846
def _run_with_write_locked_target(target, callable, *args, **kwargs):
2847
"""Run ``callable(*args, **kwargs)``, write-locking target for the
2850
_run_with_write_locked_target will attempt to release the lock it acquires.
2852
If an exception is raised by callable, then that exception *will* be
2853
propagated, even if the unlock attempt raises its own error. Thus
2854
_run_with_write_locked_target should be preferred to simply doing::
2858
return callable(*args, **kwargs)
2863
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
2864
# should share code?
2867
result = callable(*args, **kwargs)
2869
exc_info = sys.exc_info()
2873
raise exc_info[0], exc_info[1], exc_info[2]
2879
class InterBranch(InterObject):
2880
"""This class represents operations taking place between two branches.
2882
Its instances have methods like pull() and push() and contain
2883
references to the source and target repositories these operations
2884
can be carried out on.
2888
"""The available optimised InterBranch types."""
2891
def _get_branch_formats_to_test():
2892
"""Return a tuple with the Branch formats to use when testing."""
2893
raise NotImplementedError(self._get_branch_formats_to_test)
2895
def pull(self, overwrite=False, stop_revision=None,
2896
possible_transports=None, local=False):
2897
"""Mirror source into target branch.
2899
The target branch is considered to be 'local', having low latency.
2901
:returns: PullResult instance
2903
raise NotImplementedError(self.pull)
2905
def update_revisions(self, stop_revision=None, overwrite=False,
2907
"""Pull in new perfect-fit revisions.
2909
:param stop_revision: Updated until the given revision
2910
:param overwrite: Always set the branch pointer, rather than checking
2911
to see if it is a proper descendant.
2912
:param graph: A Graph object that can be used to query history
2913
information. This can be None.
2916
raise NotImplementedError(self.update_revisions)
2918
def push(self, overwrite=False, stop_revision=None,
2919
_override_hook_source_branch=None):
2920
"""Mirror the source branch into the target branch.
2922
The source branch is considered to be 'local', having low latency.
2924
raise NotImplementedError(self.push)
2927
class GenericInterBranch(InterBranch):
2928
"""InterBranch implementation that uses public Branch functions.
2932
def _get_branch_formats_to_test():
2933
return BranchFormat._default_format, BranchFormat._default_format
2935
def update_revisions(self, stop_revision=None, overwrite=False,
2937
"""See InterBranch.update_revisions()."""
2938
self.source.lock_read()
2940
other_revno, other_last_revision = self.source.last_revision_info()
2941
stop_revno = None # unknown
2942
if stop_revision is None:
2943
stop_revision = other_last_revision
2944
if _mod_revision.is_null(stop_revision):
2945
# if there are no commits, we're done.
2947
stop_revno = other_revno
2949
# what's the current last revision, before we fetch [and change it
2951
last_rev = _mod_revision.ensure_null(self.target.last_revision())
2952
# we fetch here so that we don't process data twice in the common
2953
# case of having something to pull, and so that the check for
2954
# already merged can operate on the just fetched graph, which will
2955
# be cached in memory.
2956
self.target.fetch(self.source, stop_revision)
2957
# Check to see if one is an ancestor of the other
2960
graph = self.target.repository.get_graph()
2961
if self.target._check_if_descendant_or_diverged(
2962
stop_revision, last_rev, graph, self.source):
2963
# stop_revision is a descendant of last_rev, but we aren't
2964
# overwriting, so we're done.
2966
if stop_revno is None:
2968
graph = self.target.repository.get_graph()
2969
this_revno, this_last_revision = \
2970
self.target.last_revision_info()
2971
stop_revno = graph.find_distance_to_null(stop_revision,
2972
[(other_last_revision, other_revno),
2973
(this_last_revision, this_revno)])
2974
self.target.set_last_revision_info(stop_revno, stop_revision)
2976
self.source.unlock()
2978
def pull(self, overwrite=False, stop_revision=None,
2979
possible_transports=None, _hook_master=None, run_hooks=True,
2980
_override_hook_target=None, local=False):
2983
:param _hook_master: Private parameter - set the branch to
2984
be supplied as the master to pull hooks.
2985
:param run_hooks: Private parameter - if false, this branch
2986
is being called because it's the master of the primary branch,
2987
so it should not run its hooks.
2988
:param _override_hook_target: Private parameter - set the branch to be
2989
supplied as the target_branch to pull hooks.
2990
:param local: Only update the local branch, and not the bound branch.
2992
# This type of branch can't be bound.
2994
raise errors.LocalRequiresBoundBranch()
2995
result = PullResult()
2996
result.source_branch = self.source
2997
if _override_hook_target is None:
2998
result.target_branch = self.target
3000
result.target_branch = _override_hook_target
3001
self.source.lock_read()
3003
# We assume that during 'pull' the target repository is closer than
3005
self.source.update_references(self.target)
3006
graph = self.target.repository.get_graph(self.source.repository)
3007
# TODO: Branch formats should have a flag that indicates
3008
# that revno's are expensive, and pull() should honor that flag.
3010
result.old_revno, result.old_revid = \
3011
self.target.last_revision_info()
3012
self.target.update_revisions(self.source, stop_revision,
3013
overwrite=overwrite, graph=graph)
3014
# TODO: The old revid should be specified when merging tags,
3015
# so a tags implementation that versions tags can only
3016
# pull in the most recent changes. -- JRV20090506
3017
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3019
result.new_revno, result.new_revid = self.target.last_revision_info()
3021
result.master_branch = _hook_master
3022
result.local_branch = result.target_branch
3024
result.master_branch = result.target_branch
3025
result.local_branch = None
3027
for hook in Branch.hooks['post_pull']:
3030
self.source.unlock()
3033
def push(self, overwrite=False, stop_revision=None,
3034
_override_hook_source_branch=None):
3035
"""See InterBranch.push.
3037
This is the basic concrete implementation of push()
3039
:param _override_hook_source_branch: If specified, run
3040
the hooks passing this Branch as the source, rather than self.
3041
This is for use of RemoteBranch, where push is delegated to the
3042
underlying vfs-based Branch.
3044
# TODO: Public option to disable running hooks - should be trivial but
3046
self.source.lock_read()
3048
return _run_with_write_locked_target(
3049
self.target, self._push_with_bound_branches, overwrite,
3051
_override_hook_source_branch=_override_hook_source_branch)
3053
self.source.unlock()
3056
def _push_with_bound_branches(self, overwrite, stop_revision,
3057
_override_hook_source_branch=None):
3058
"""Push from source into target, and into target's master if any.
3061
if _override_hook_source_branch:
3062
result.source_branch = _override_hook_source_branch
3063
for hook in Branch.hooks['post_push']:
3066
bound_location = self.target.get_bound_location()
3067
if bound_location and self.target.base != bound_location:
3068
# there is a master branch.
3070
# XXX: Why the second check? Is it even supported for a branch to
3071
# be bound to itself? -- mbp 20070507
3072
master_branch = self.target.get_master_branch()
3073
master_branch.lock_write()
3075
# push into the master from the source branch.
3076
self.source._basic_push(master_branch, overwrite, stop_revision)
3077
# and push into the target branch from the source. Note that we
3078
# push from the source branch again, because its considered the
3079
# highest bandwidth repository.
3080
result = self.source._basic_push(self.target, overwrite,
3082
result.master_branch = master_branch
3083
result.local_branch = self.target
3087
master_branch.unlock()
3090
result = self.source._basic_push(self.target, overwrite,
3092
# TODO: Why set master_branch and local_branch if there's no
3093
# binding? Maybe cleaner to just leave them unset? -- mbp
3095
result.master_branch = self.target
3096
result.local_branch = None
3101
def is_compatible(self, source, target):
3102
# GenericBranch uses the public API, so always compatible
3106
class InterToBranch5(GenericInterBranch):
3109
def _get_branch_formats_to_test():
3110
return BranchFormat._default_format, BzrBranchFormat5()
3112
def pull(self, overwrite=False, stop_revision=None,
3113
possible_transports=None, run_hooks=True,
3114
_override_hook_target=None, local=False):
3115
"""Pull from source into self, updating my master if any.
3117
:param run_hooks: Private parameter - if false, this branch
3118
is being called because it's the master of the primary branch,
3119
so it should not run its hooks.
3121
bound_location = self.target.get_bound_location()
3122
if local and not bound_location:
3123
raise errors.LocalRequiresBoundBranch()
3124
master_branch = None
3125
if not local and bound_location and self.source.base != bound_location:
3126
# not pulling from master, so we need to update master.
3127
master_branch = self.target.get_master_branch(possible_transports)
3128
master_branch.lock_write()
3131
# pull from source into master.
3132
master_branch.pull(self.source, overwrite, stop_revision,
3134
return super(InterToBranch5, self).pull(overwrite,
3135
stop_revision, _hook_master=master_branch,
3136
run_hooks=run_hooks,
3137
_override_hook_target=_override_hook_target)
3140
master_branch.unlock()
3143
InterBranch.register_optimiser(GenericInterBranch)
3144
InterBranch.register_optimiser(InterToBranch5)
added
removed
bzrlib/branch.py
