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):
105
"""Activate the branch/repository from url as a fallback repository."""
106
repo = self._get_fallback_repository(url)
107
self.repository.add_fallback_repository(repo)
109
def break_lock(self):
110
"""Break a lock if one is present from another instance.
112
Uses the ui factory to ask for confirmation if the lock may be from
115
This will probe the repository for its lock as well.
117
self.control_files.break_lock()
118
self.repository.break_lock()
119
master = self.get_master_branch()
120
if master is not None:
123
def _check_stackable_repo(self):
124
if not self.repository._format.supports_external_lookups:
125
raise errors.UnstackableRepositoryFormat(self.repository._format,
126
self.repository.base)
129
def open(base, _unsupported=False, possible_transports=None):
130
"""Open the branch rooted at base.
132
For instance, if the branch is at URL/.bzr/branch,
133
Branch.open(URL) -> a Branch instance.
135
control = bzrdir.BzrDir.open(base, _unsupported,
136
possible_transports=possible_transports)
137
return control.open_branch(_unsupported)
140
def open_from_transport(transport, _unsupported=False):
141
"""Open the branch rooted at transport"""
142
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
143
return control.open_branch(_unsupported)
146
def open_containing(url, possible_transports=None):
147
"""Open an existing branch which contains url.
149
This probes for a branch at url, and searches upwards from there.
151
Basically we keep looking up until we find the control directory or
152
run into the root. If there isn't one, raises NotBranchError.
153
If there is one and it is either an unrecognised format or an unsupported
154
format, UnknownFormatError or UnsupportedFormatError are raised.
155
If there is one, it is returned, along with the unused portion of url.
157
control, relpath = bzrdir.BzrDir.open_containing(url,
159
return control.open_branch(), relpath
161
def _push_should_merge_tags(self):
162
"""Should _basic_push merge this branch's tags into the target?
164
The default implementation returns False if this branch has no tags,
165
and True the rest of the time. Subclasses may override this.
167
return self.supports_tags() and self.tags.get_tag_dict()
169
def get_config(self):
170
return BranchConfig(self)
172
def _get_config(self):
173
"""Get the concrete config for just the config in this branch.
175
This is not intended for client use; see Branch.get_config for the
180
:return: An object supporting get_option and set_option.
182
raise NotImplementedError(self._get_config)
184
def _get_fallback_repository(self, url):
185
"""Get the repository we fallback to at url."""
186
url = urlutils.join(self.base, url)
187
a_bzrdir = bzrdir.BzrDir.open(url,
188
possible_transports=[self.bzrdir.root_transport])
189
return a_bzrdir.open_branch().repository
191
def _get_tags_bytes(self):
192
"""Get the bytes of a serialised tags dict.
194
Note that not all branches support tags, nor do all use the same tags
195
logic: this method is specific to BasicTags. Other tag implementations
196
may use the same method name and behave differently, safely, because
197
of the double-dispatch via
198
format.make_tags->tags_instance->get_tags_dict.
200
:return: The bytes of the tags file.
201
:seealso: Branch._set_tags_bytes.
203
return self._transport.get_bytes('tags')
205
def _get_nick(self, local=False, possible_transports=None):
206
config = self.get_config()
207
# explicit overrides master, but don't look for master if local is True
208
if not local and not config.has_explicit_nickname():
210
master = self.get_master_branch(possible_transports)
211
if master is not None:
212
# return the master branch value
214
except errors.BzrError, e:
215
# Silently fall back to local implicit nick if the master is
217
mutter("Could not connect to bound branch, "
218
"falling back to local nick.\n " + str(e))
219
return config.get_nickname()
221
def _set_nick(self, nick):
222
self.get_config().set_user_option('nickname', nick, warn_masked=True)
224
nick = property(_get_nick, _set_nick)
227
raise NotImplementedError(self.is_locked)
229
def _lefthand_history(self, revision_id, last_rev=None,
231
if 'evil' in debug.debug_flags:
232
mutter_callsite(4, "_lefthand_history scales with history.")
233
# stop_revision must be a descendant of last_revision
234
graph = self.repository.get_graph()
235
if last_rev is not None:
236
if not graph.is_ancestor(last_rev, revision_id):
237
# our previous tip is not merged into stop_revision
238
raise errors.DivergedBranches(self, other_branch)
239
# make a new revision history from the graph
240
parents_map = graph.get_parent_map([revision_id])
241
if revision_id not in parents_map:
242
raise errors.NoSuchRevision(self, revision_id)
243
current_rev_id = revision_id
245
check_not_reserved_id = _mod_revision.check_not_reserved_id
246
# Do not include ghosts or graph origin in revision_history
247
while (current_rev_id in parents_map and
248
len(parents_map[current_rev_id]) > 0):
249
check_not_reserved_id(current_rev_id)
250
new_history.append(current_rev_id)
251
current_rev_id = parents_map[current_rev_id][0]
252
parents_map = graph.get_parent_map([current_rev_id])
253
new_history.reverse()
212
256
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'
257
raise NotImplementedError(self.lock_write)
228
259
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'
260
raise NotImplementedError(self.lock_read)
242
262
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
263
raise NotImplementedError(self.unlock)
265
def peek_lock_mode(self):
266
"""Return lock mode for the Branch: 'r', 'w' or None"""
267
raise NotImplementedError(self.peek_lock_mode)
269
def get_physical_lock_status(self):
270
raise NotImplementedError(self.get_physical_lock_status)
273
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
274
"""Return the revision_id for a dotted revno.
276
:param revno: a tuple like (1,) or (1,1,2)
277
:param _cache_reverse: a private parameter enabling storage
278
of the reverse mapping in a top level cache. (This should
279
only be done in selective circumstances as we want to
280
avoid having the mapping cached multiple times.)
281
:return: the revision_id
282
:raises errors.NoSuchRevision: if the revno doesn't exist
284
rev_id = self._do_dotted_revno_to_revision_id(revno)
286
self._partial_revision_id_to_revno_cache[rev_id] = revno
289
def _do_dotted_revno_to_revision_id(self, revno):
290
"""Worker function for dotted_revno_to_revision_id.
292
Subclasses should override this if they wish to
293
provide a more efficient implementation.
296
return self.get_rev_id(revno[0])
297
revision_id_to_revno = self.get_revision_id_to_revno_map()
298
revision_ids = [revision_id for revision_id, this_revno
299
in revision_id_to_revno.iteritems()
300
if revno == this_revno]
301
if len(revision_ids) == 1:
302
return revision_ids[0]
304
revno_str = '.'.join(map(str, revno))
305
raise errors.NoSuchRevision(self, revno_str)
308
def revision_id_to_dotted_revno(self, revision_id):
309
"""Given a revision id, return its dotted revno.
311
:return: a tuple like (1,) or (400,1,3).
313
return self._do_revision_id_to_dotted_revno(revision_id)
315
def _do_revision_id_to_dotted_revno(self, revision_id):
316
"""Worker function for revision_id_to_revno."""
317
# Try the caches if they are loaded
318
result = self._partial_revision_id_to_revno_cache.get(revision_id)
319
if result is not None:
321
if self._revision_id_to_revno_cache:
322
result = self._revision_id_to_revno_cache.get(revision_id)
324
raise errors.NoSuchRevision(self, revision_id)
325
# Try the mainline as it's optimised
327
revno = self.revision_id_to_revno(revision_id)
329
except errors.NoSuchRevision:
330
# We need to load and use the full revno map after all
331
result = self.get_revision_id_to_revno_map().get(revision_id)
333
raise errors.NoSuchRevision(self, revision_id)
337
def get_revision_id_to_revno_map(self):
338
"""Return the revision_id => dotted revno map.
340
This will be regenerated on demand, but will be cached.
342
:return: A dictionary mapping revision_id => dotted revno.
343
This dictionary should not be modified by the caller.
345
if self._revision_id_to_revno_cache is not None:
346
mapping = self._revision_id_to_revno_cache
348
mapping = self._gen_revno_map()
349
self._cache_revision_id_to_revno(mapping)
350
# TODO: jam 20070417 Since this is being cached, should we be returning
352
# I would rather not, and instead just declare that users should not
353
# modify the return value.
356
def _gen_revno_map(self):
357
"""Create a new mapping from revision ids to dotted revnos.
359
Dotted revnos are generated based on the current tip in the revision
361
This is the worker function for get_revision_id_to_revno_map, which
362
just caches the return value.
364
:return: A dictionary mapping revision_id => dotted revno.
366
revision_id_to_revno = dict((rev_id, revno)
367
for rev_id, depth, revno, end_of_merge
368
in self.iter_merge_sorted_revisions())
369
return revision_id_to_revno
372
def iter_merge_sorted_revisions(self, start_revision_id=None,
373
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
374
"""Walk the revisions for a branch in merge sorted order.
376
Merge sorted order is the output from a merge-aware,
377
topological sort, i.e. all parents come before their
378
children going forward; the opposite for reverse.
380
:param start_revision_id: the revision_id to begin walking from.
381
If None, the branch tip is used.
382
:param stop_revision_id: the revision_id to terminate the walk
383
after. If None, the rest of history is included.
384
:param stop_rule: if stop_revision_id is not None, the precise rule
385
to use for termination:
386
* 'exclude' - leave the stop revision out of the result (default)
387
* 'include' - the stop revision is the last item in the result
388
* 'with-merges' - include the stop revision and all of its
389
merged revisions in the result
390
:param direction: either 'reverse' or 'forward':
391
* reverse means return the start_revision_id first, i.e.
392
start at the most recent revision and go backwards in history
393
* forward returns tuples in the opposite order to reverse.
394
Note in particular that forward does *not* do any intelligent
395
ordering w.r.t. depth as some clients of this API may like.
396
(If required, that ought to be done at higher layers.)
398
:return: an iterator over (revision_id, depth, revno, end_of_merge)
401
* revision_id: the unique id of the revision
402
* depth: How many levels of merging deep this node has been
404
* revno_sequence: This field provides a sequence of
405
revision numbers for all revisions. The format is:
406
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
407
branch that the revno is on. From left to right the REVNO numbers
408
are the sequence numbers within that branch of the revision.
409
* end_of_merge: When True the next node (earlier in history) is
410
part of a different merge.
412
# Note: depth and revno values are in the context of the branch so
413
# we need the full graph to get stable numbers, regardless of the
415
if self._merge_sorted_revisions_cache is None:
416
last_revision = self.last_revision()
417
graph = self.repository.get_graph()
418
parent_map = dict(((key, value) for key, value in
419
graph.iter_ancestry([last_revision]) if value is not None))
420
revision_graph = repository._strip_NULL_ghosts(parent_map)
421
revs = tsort.merge_sort(revision_graph, last_revision, None,
423
# Drop the sequence # before caching
424
self._merge_sorted_revisions_cache = [r[1:] for r in revs]
426
filtered = self._filter_merge_sorted_revisions(
427
self._merge_sorted_revisions_cache, start_revision_id,
428
stop_revision_id, stop_rule)
429
if direction == 'reverse':
431
if direction == 'forward':
432
return reversed(list(filtered))
434
raise ValueError('invalid direction %r' % direction)
436
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
437
start_revision_id, stop_revision_id, stop_rule):
438
"""Iterate over an inclusive range of sorted revisions."""
439
rev_iter = iter(merge_sorted_revisions)
440
if start_revision_id is not None:
441
for rev_id, depth, revno, end_of_merge in rev_iter:
442
if rev_id != start_revision_id:
445
# The decision to include the start or not
446
# depends on the stop_rule if a stop is provided
448
iter([(rev_id, depth, revno, end_of_merge)]),
451
if stop_revision_id is None:
452
for rev_id, depth, revno, end_of_merge in rev_iter:
453
yield rev_id, depth, revno, end_of_merge
454
elif stop_rule == 'exclude':
455
for rev_id, depth, revno, end_of_merge in rev_iter:
456
if rev_id == stop_revision_id:
458
yield rev_id, depth, revno, end_of_merge
459
elif stop_rule == 'include':
460
for rev_id, depth, revno, end_of_merge in rev_iter:
461
yield rev_id, depth, revno, end_of_merge
462
if rev_id == stop_revision_id:
464
elif stop_rule == 'with-merges':
465
stop_rev = self.repository.get_revision(stop_revision_id)
466
if stop_rev.parent_ids:
467
left_parent = stop_rev.parent_ids[0]
469
left_parent = _mod_revision.NULL_REVISION
470
for rev_id, depth, revno, end_of_merge in rev_iter:
471
if rev_id == left_parent:
473
yield rev_id, depth, revno, end_of_merge
475
raise ValueError('invalid stop_rule %r' % stop_rule)
477
def leave_lock_in_place(self):
478
"""Tell this branch object not to release the physical lock when this
481
If lock_write doesn't return a token, then this method is not supported.
483
self.control_files.leave_in_place()
485
def dont_leave_lock_in_place(self):
486
"""Tell this branch object to release the physical lock when this
487
object is unlocked, even if it didn't originally acquire it.
489
If lock_write doesn't return a token, then this method is not supported.
491
self.control_files.dont_leave_in_place()
493
def bind(self, other):
494
"""Bind the local branch the other branch.
496
:param other: The branch to bind to
499
raise errors.UpgradeRequired(self.base)
501
def set_reference_info(self, file_id, tree_path, branch_location):
502
"""Set the branch location to use for a tree reference."""
503
raise errors.UnsupportedOperation(self.set_reference_info, self)
505
def get_reference_info(self, file_id):
506
"""Get the tree_path and branch_location for a tree reference."""
507
raise errors.UnsupportedOperation(self.get_reference_info, self)
510
def fetch(self, from_branch, last_revision=None, pb=None):
511
"""Copy revisions from from_branch into this branch.
513
:param from_branch: Where to copy from.
514
:param last_revision: What revision to stop at (None for at the end
516
:param pb: An optional progress bar to use.
519
if self.base == from_branch.base:
522
symbol_versioning.warn(
523
symbol_versioning.deprecated_in((1, 14, 0))
524
% "pb parameter to fetch()")
525
from_branch.lock_read()
527
if last_revision is None:
528
last_revision = from_branch.last_revision()
529
last_revision = _mod_revision.ensure_null(last_revision)
530
return self.repository.fetch(from_branch.repository,
531
revision_id=last_revision,
536
def get_bound_location(self):
537
"""Return the URL of the branch we are bound to.
539
Older format branches cannot bind, please be sure to use a metadir
544
def get_old_bound_location(self):
545
"""Return the URL of the branch we used to be bound to
547
raise errors.UpgradeRequired(self.base)
549
def get_commit_builder(self, parents, config=None, timestamp=None,
550
timezone=None, committer=None, revprops=None,
552
"""Obtain a CommitBuilder for this branch.
554
:param parents: Revision ids of the parents of the new revision.
555
:param config: Optional configuration to use.
556
:param timestamp: Optional timestamp recorded for commit.
557
:param timezone: Optional timezone for timestamp.
558
:param committer: Optional committer to set for commit.
559
:param revprops: Optional dictionary of revision properties.
560
:param revision_id: Optional revision id.
564
config = self.get_config()
566
return self.repository.get_commit_builder(self, parents, config,
567
timestamp, timezone, committer, revprops, revision_id)
569
def get_master_branch(self, possible_transports=None):
570
"""Return the branch we are bound to.
572
:return: Either a Branch, or None
617
576
def get_revision_delta(self, revno):
618
577
"""Return the delta for one revision.
789
782
common_index = min(self_len, other_len) -1
790
783
if common_index >= 0 and \
791
784
self_history[common_index] != other_history[common_index]:
792
raise DivergedBranches(self, other)
785
raise errors.DivergedBranches(self, other)
794
787
if stop_revision is None:
795
788
stop_revision = other_len
796
elif stop_revision > other_len:
797
raise NoSuchRevision(self, stop_revision)
790
if stop_revision > other_len:
791
raise errors.NoSuchRevision(self, stop_revision)
799
792
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)
795
def update_revisions(self, other, stop_revision=None, overwrite=False,
797
"""Pull in new perfect-fit revisions.
799
:param other: Another Branch to pull from
800
:param stop_revision: Updated until the given revision
801
:param overwrite: Always set the branch pointer, rather than checking
802
to see if it is a proper descendant.
803
:param graph: A Graph object that can be used to query history
804
information. This can be None.
807
return InterBranch.get(other, self).update_revisions(stop_revision,
810
def import_last_revision_info(self, source_repo, revno, revid):
811
"""Set the last revision info, importing from another repo if necessary.
813
This is used by the bound branch code to upload a revision to
814
the master branch first before updating the tip of the local branch.
816
:param source_repo: Source repository to optionally fetch from
817
:param revno: Revision number of the new tip
818
:param revid: Revision id of the new tip
820
if not self.repository.has_same_location(source_repo):
821
self.repository.fetch(source_repo, revision_id=revid)
822
self.set_last_revision_info(revno, revid)
824
def revision_id_to_revno(self, revision_id):
825
"""Given a revision id, return its revno"""
826
if _mod_revision.is_null(revision_id):
828
history = self.revision_history()
830
return history.index(revision_id) + 1
893
831
except ValueError:
832
raise errors.NoSuchRevision(self, revision_id)
834
def get_rev_id(self, revno, history=None):
835
"""Find the revision id of the specified revno."""
837
return _mod_revision.NULL_REVISION
839
history = self.revision_history()
840
if revno <= 0 or revno > len(history):
841
raise errors.NoSuchRevision(self, revno)
842
return history[revno - 1]
845
def pull(self, source, overwrite=False, stop_revision=None,
846
possible_transports=None, *args, **kwargs):
847
"""Mirror source into this branch.
849
This branch is considered to be 'local', having low latency.
851
:returns: PullResult instance
853
return InterBranch.get(source, self).pull(overwrite=overwrite,
854
stop_revision=stop_revision,
855
possible_transports=possible_transports, *args, **kwargs)
857
def push(self, target, overwrite=False, stop_revision=None, *args,
859
"""Mirror this branch into target.
861
This branch is considered to be 'local', having low latency.
863
return InterBranch.get(self, target).push(overwrite, stop_revision,
866
def lossy_push(self, target, stop_revision=None):
867
"""Push deltas into another branch.
869
:note: This does not, like push, retain the revision ids from
870
the source branch and will, rather than adding bzr-specific
871
metadata, push only those semantics of the revision that can be
872
natively represented by this branch' VCS.
874
:param target: Target branch
875
:param stop_revision: Revision to push, defaults to last revision.
876
:return: BranchPushResult with an extra member revidmap:
877
A dictionary mapping revision ids from the target branch
878
to new revision ids in the target branch, for each
879
revision that was pushed.
881
inter = InterBranch.get(self, target)
882
lossy_push = getattr(inter, "lossy_push", None)
883
if lossy_push is None:
884
raise errors.LossyPushToSameVCS(self, target)
885
return lossy_push(stop_revision)
887
def basis_tree(self):
888
"""Return `Tree` object for last revision."""
889
return self.repository.revision_tree(self.last_revision())
891
def get_parent(self):
892
"""Return the parent location of the branch.
894
This is the default location for pull/missing. The usual
895
pattern is that the user can override it by specifying a
898
parent = self._get_parent_location()
901
# This is an old-format absolute path to a local branch
903
if parent.startswith('/'):
904
parent = urlutils.local_path_to_url(parent.decode('utf8'))
906
return urlutils.join(self.base[:-1], parent)
907
except errors.InvalidURLJoin, e:
908
raise errors.InaccessibleParent(parent, self.base)
910
def _get_parent_location(self):
911
raise NotImplementedError(self._get_parent_location)
913
def _set_config_location(self, name, url, config=None,
914
make_relative=False):
916
config = self.get_config()
920
url = urlutils.relative_url(self.base, url)
921
config.set_user_option(name, url, warn_masked=True)
923
def _get_config_location(self, name, config=None):
925
config = self.get_config()
926
location = config.get_user_option(name)
931
def get_child_submit_format(self):
932
"""Return the preferred format of submissions to this branch."""
933
return self.get_config().get_user_option("child_submit_format")
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
1089
graph = self.repository.get_graph()
1091
revno = graph.find_distance_to_null(revision_id,
1092
[(source_revision_id, source_revno)])
1093
except errors.GhostRevisionsHaveNoRevno:
1094
# Default to 1, if we can't find anything else
1096
destination.set_last_revision_info(revno, revision_id)
1099
def copy_content_into(self, destination, revision_id=None):
1100
"""Copy the content of self into destination.
1102
revision_id: if not None, the revision history in the new branch will
1103
be truncated to end with revision_id.
1105
self.update_references(destination)
1106
self._synchronize_history(destination, revision_id)
1108
parent = self.get_parent()
1109
except errors.InaccessibleParent, e:
1110
mutter('parent was not accessible to copy: %s', e)
1113
destination.set_parent(parent)
1114
if self._push_should_merge_tags():
1115
self.tags.merge_to(destination.tags)
1117
def update_references(self, target):
1118
if not getattr(self._format, 'supports_reference_locations', False):
1120
reference_dict = self._get_all_reference_info()
1121
if len(reference_dict) == 0:
1123
old_base = self.base
1124
new_base = target.base
1125
target_reference_dict = target._get_all_reference_info()
1126
for file_id, (tree_path, branch_location) in (
1127
reference_dict.items()):
1128
branch_location = urlutils.rebase_url(branch_location,
1130
target_reference_dict.setdefault(
1131
file_id, (tree_path, branch_location))
1132
target._set_all_reference_info(target_reference_dict)
1136
"""Check consistency of the branch.
1138
In particular this checks that revisions given in the revision-history
1139
do actually match up in the revision graph, and that they're all
1140
present in the repository.
1142
Callers will typically also want to check the repository.
1144
:return: A BranchCheckResult.
1146
ret = BranchCheckResult(self)
1147
mainline_parent_id = None
1148
last_revno, last_revision_id = self.last_revision_info()
1149
real_rev_history = []
1151
for revid in self.repository.iter_reverse_revision_history(
1153
real_rev_history.append(revid)
1154
except errors.RevisionNotPresent:
1155
ret.ghosts_in_mainline = True
1157
ret.ghosts_in_mainline = False
1158
real_rev_history.reverse()
1159
if len(real_rev_history) != last_revno:
1160
raise errors.BzrCheckError('revno does not match len(mainline)'
1161
' %s != %s' % (last_revno, len(real_rev_history)))
1162
# TODO: We should probably also check that real_rev_history actually
1163
# matches self.revision_history()
1164
for revision_id in real_rev_history:
1166
revision = self.repository.get_revision(revision_id)
1167
except errors.NoSuchRevision, e:
1168
raise errors.BzrCheckError("mainline revision {%s} not in repository"
1170
# In general the first entry on the revision history has no parents.
1171
# But it's not illegal for it to have parents listed; this can happen
1172
# in imports from Arch when the parents weren't reachable.
1173
if mainline_parent_id is not None:
1174
if mainline_parent_id not in revision.parent_ids:
1175
raise errors.BzrCheckError("previous revision {%s} not listed among "
1177
% (mainline_parent_id, revision_id))
1178
mainline_parent_id = revision_id
1181
def _get_checkout_format(self):
1182
"""Return the most suitable metadir for a checkout of this branch.
1183
Weaves are used if this branch's repository uses weaves.
1185
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1186
from bzrlib.repofmt import weaverepo
1187
format = bzrdir.BzrDirMetaFormat1()
1188
format.repository_format = weaverepo.RepositoryFormat7()
1190
format = self.repository.bzrdir.checkout_metadir()
1191
format.set_branch_format(self._format)
1194
def create_clone_on_transport(self, to_transport, revision_id=None,
1195
stacked_on=None, create_prefix=False, use_existing_dir=False):
1196
"""Create a clone of this branch and its bzrdir.
1198
:param to_transport: The transport to clone onto.
1199
:param revision_id: The revision id to use as tip in the new branch.
1200
If None the tip is obtained from this branch.
1201
:param stacked_on: An optional URL to stack the clone on.
1202
:param create_prefix: Create any missing directories leading up to
1204
:param use_existing_dir: Use an existing directory if one exists.
1206
# XXX: Fix the bzrdir API to allow getting the branch back from the
1207
# clone call. Or something. 20090224 RBC/spiv.
1208
if revision_id is None:
1209
revision_id = self.last_revision()
1211
dir_to = self.bzrdir.clone_on_transport(to_transport,
1212
revision_id=revision_id, stacked_on=stacked_on,
1213
create_prefix=create_prefix, use_existing_dir=use_existing_dir)
1214
except errors.FileExists:
1215
if not use_existing_dir:
1217
except errors.NoSuchFile:
1218
if not create_prefix:
1220
return dir_to.open_branch()
1222
def create_checkout(self, to_location, revision_id=None,
1223
lightweight=False, accelerator_tree=None,
1225
"""Create a checkout of a branch.
1227
:param to_location: The url to produce the checkout at
1228
:param revision_id: The revision to check out
1229
:param lightweight: If True, produce a lightweight checkout, otherwise,
1230
produce a bound branch (heavyweight checkout)
1231
:param accelerator_tree: A tree which can be used for retrieving file
1232
contents more quickly than the revision tree, i.e. a workingtree.
1233
The revision tree will be used for cases where accelerator_tree's
1234
content is different.
1235
:param hardlink: If true, hard-link files from accelerator_tree,
1237
:return: The tree of the created checkout
1239
t = transport.get_transport(to_location)
1242
format = self._get_checkout_format()
1243
checkout = format.initialize_on_transport(t)
1244
from_branch = BranchReferenceFormat().initialize(checkout, self)
1246
format = self._get_checkout_format()
1247
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1248
to_location, force_new_tree=False, format=format)
1249
checkout = checkout_branch.bzrdir
1250
checkout_branch.bind(self)
1251
# pull up to the specified revision_id to set the initial
1252
# branch tip correctly, and seed it with history.
1253
checkout_branch.pull(self, stop_revision=revision_id)
1255
tree = checkout.create_workingtree(revision_id,
1256
from_branch=from_branch,
1257
accelerator_tree=accelerator_tree,
1259
basis_tree = tree.basis_tree()
1260
basis_tree.lock_read()
1262
for path, file_id in basis_tree.iter_references():
1263
reference_parent = self.reference_parent(file_id, path)
1264
reference_parent.create_checkout(tree.abspath(path),
1265
basis_tree.get_reference_revision(file_id, path),
1272
def reconcile(self, thorough=True):
1273
"""Make sure the data stored in this branch is consistent."""
1274
from bzrlib.reconcile import BranchReconciler
1275
reconciler = BranchReconciler(self, thorough=thorough)
1276
reconciler.reconcile()
1279
def reference_parent(self, file_id, path, possible_transports=None):
1280
"""Return the parent branch for a tree-reference file_id
1281
:param file_id: The file_id of the tree reference
1282
:param path: The path of the file_id in the tree
1283
:return: A branch associated with the file_id
1285
# FIXME should provide multiple branches, based on config
1286
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1287
possible_transports=possible_transports)
1289
def supports_tags(self):
1290
return self._format.supports_tags()
1292
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1294
"""Ensure that revision_b is a descendant of revision_a.
1296
This is a helper function for update_revisions.
1298
:raises: DivergedBranches if revision_b has diverged from revision_a.
1299
:returns: True if revision_b is a descendant of revision_a.
1301
relation = self._revision_relations(revision_a, revision_b, graph)
1302
if relation == 'b_descends_from_a':
1304
elif relation == 'diverged':
1305
raise errors.DivergedBranches(self, other_branch)
1306
elif relation == 'a_descends_from_b':
1309
raise AssertionError("invalid relation: %r" % (relation,))
1311
def _revision_relations(self, revision_a, revision_b, graph):
1312
"""Determine the relationship between two revisions.
1314
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1316
heads = graph.heads([revision_a, revision_b])
1317
if heads == set([revision_b]):
1318
return 'b_descends_from_a'
1319
elif heads == set([revision_a, revision_b]):
1320
# These branches have diverged
1322
elif heads == set([revision_a]):
1323
return 'a_descends_from_b'
1325
raise AssertionError("invalid heads: %r" % (heads,))
1328
class BranchFormat(object):
1329
"""An encapsulation of the initialization and open routines for a format.
1331
Formats provide three things:
1332
* An initialization routine,
1336
Formats are placed in an dict by their format string for reference
1337
during branch opening. Its not required that these be instances, they
1338
can be classes themselves with class methods - it simply depends on
1339
whether state is needed for a given format or not.
1341
Once a format is deprecated, just deprecate the initialize and open
1342
methods on the format class. Do not deprecate the object, as the
1343
object will be created every time regardless.
1346
_default_format = None
1347
"""The default format used for new branches."""
1350
"""The known formats."""
1352
def __eq__(self, other):
1353
return self.__class__ is other.__class__
1355
def __ne__(self, other):
1356
return not (self == other)
1359
def find_format(klass, a_bzrdir):
1360
"""Return the format for the branch object in a_bzrdir."""
1362
transport = a_bzrdir.get_branch_transport(None)
1363
format_string = transport.get("format").read()
1364
return klass._formats[format_string]
1365
except errors.NoSuchFile:
1366
raise errors.NotBranchError(path=transport.base)
1368
raise errors.UnknownFormatError(format=format_string, kind='branch')
1371
def get_default_format(klass):
1372
"""Return the current default format."""
1373
return klass._default_format
1375
def get_reference(self, a_bzrdir):
1376
"""Get the target reference of the branch in a_bzrdir.
1378
format probing must have been completed before calling
1379
this method - it is assumed that the format of the branch
1380
in a_bzrdir is correct.
1382
:param a_bzrdir: The bzrdir to get the branch data from.
1383
:return: None if the branch is not a reference branch.
1388
def set_reference(self, a_bzrdir, to_branch):
1389
"""Set the target reference of the branch in a_bzrdir.
1391
format probing must have been completed before calling
1392
this method - it is assumed that the format of the branch
1393
in a_bzrdir is correct.
1395
:param a_bzrdir: The bzrdir to set the branch reference for.
1396
:param to_branch: branch that the checkout is to reference
1398
raise NotImplementedError(self.set_reference)
1400
def get_format_string(self):
1401
"""Return the ASCII format string that identifies this format."""
1402
raise NotImplementedError(self.get_format_string)
1404
def get_format_description(self):
1405
"""Return the short format description for this format."""
1406
raise NotImplementedError(self.get_format_description)
1408
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
1410
"""Initialize a branch in a bzrdir, with specified files
1412
:param a_bzrdir: The bzrdir to initialize the branch in
1413
:param utf8_files: The files to create as a list of
1414
(filename, content) tuples
1415
:param set_format: If True, set the format with
1416
self.get_format_string. (BzrBranch4 has its format set
1418
:return: a branch in this format
1420
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1421
branch_transport = a_bzrdir.get_branch_transport(self)
1423
'metadir': ('lock', lockdir.LockDir),
1424
'branch4': ('branch-lock', lockable_files.TransportLock),
1426
lock_name, lock_class = lock_map[lock_type]
1427
control_files = lockable_files.LockableFiles(branch_transport,
1428
lock_name, lock_class)
1429
control_files.create_lock()
1431
control_files.lock_write()
1432
except errors.LockContention:
1433
if lock_type != 'branch4':
1439
utf8_files += [('format', self.get_format_string())]
1441
for (filename, content) in utf8_files:
1442
branch_transport.put_bytes(
1444
mode=a_bzrdir._get_file_mode())
1447
control_files.unlock()
1448
return self.open(a_bzrdir, _found=True)
1450
def initialize(self, a_bzrdir):
1451
"""Create a branch of this format in a_bzrdir."""
1452
raise NotImplementedError(self.initialize)
1454
def is_supported(self):
1455
"""Is this format supported?
1457
Supported formats can be initialized and opened.
1458
Unsupported formats may not support initialization or committing or
1459
some other features depending on the reason for not being supported.
1463
def make_tags(self, branch):
1464
"""Create a tags object for branch.
1466
This method is on BranchFormat, because BranchFormats are reflected
1467
over the wire via network_name(), whereas full Branch instances require
1468
multiple VFS method calls to operate at all.
1470
The default implementation returns a disabled-tags instance.
1472
Note that it is normal for branch to be a RemoteBranch when using tags
1475
return DisabledTags(branch)
1477
def network_name(self):
1478
"""A simple byte string uniquely identifying this format for RPC calls.
1480
MetaDir branch formats use their disk format string to identify the
1481
repository over the wire. All in one formats such as bzr < 0.8, and
1482
foreign formats like svn/git and hg should use some marker which is
1483
unique and immutable.
1485
raise NotImplementedError(self.network_name)
1487
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1488
"""Return the branch object for a_bzrdir
1490
:param a_bzrdir: A BzrDir that contains a branch.
1491
:param _found: a private parameter, do not use it. It is used to
1492
indicate if format probing has already be done.
1493
:param ignore_fallbacks: when set, no fallback branches will be opened
1494
(if there are any). Default is to open fallbacks.
1496
raise NotImplementedError(self.open)
1499
def register_format(klass, format):
1500
"""Register a metadir format."""
1501
klass._formats[format.get_format_string()] = format
1502
# Metadir formats have a network name of their format string, and get
1503
# registered as class factories.
1504
network_format_registry.register(format.get_format_string(), format.__class__)
1507
def set_default_format(klass, format):
1508
klass._default_format = format
1510
def supports_stacking(self):
1511
"""True if this format records a stacked-on branch."""
1515
def unregister_format(klass, format):
1516
del klass._formats[format.get_format_string()]
1519
return self.get_format_description().rstrip()
1521
def supports_tags(self):
1522
"""True if this format supports tags stored in the branch"""
1523
return False # by default
1526
class BranchHooks(Hooks):
1527
"""A dictionary mapping hook name to a list of callables for branch hooks.
1529
e.g. ['set_rh'] Is the list of items to be called when the
1530
set_revision_history function is invoked.
1534
"""Create the default hooks.
1536
These are all empty initially, because by default nothing should get
1539
Hooks.__init__(self)
1540
self.create_hook(HookPoint('set_rh',
1541
"Invoked whenever the revision history has been set via "
1542
"set_revision_history. The api signature is (branch, "
1543
"revision_history), and the branch will be write-locked. "
1544
"The set_rh hook can be expensive for bzr to trigger, a better "
1545
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1546
self.create_hook(HookPoint('open',
1547
"Called with the Branch object that has been opened after a "
1548
"branch is opened.", (1, 8), None))
1549
self.create_hook(HookPoint('post_push',
1550
"Called after a push operation completes. post_push is called "
1551
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1552
"bzr client.", (0, 15), None))
1553
self.create_hook(HookPoint('post_pull',
1554
"Called after a pull operation completes. post_pull is called "
1555
"with a bzrlib.branch.PullResult object and only runs in the "
1556
"bzr client.", (0, 15), None))
1557
self.create_hook(HookPoint('pre_commit',
1558
"Called after a commit is calculated but before it is is "
1559
"completed. pre_commit is called with (local, master, old_revno, "
1560
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1561
"). old_revid is NULL_REVISION for the first commit to a branch, "
1562
"tree_delta is a TreeDelta object describing changes from the "
1563
"basis revision. hooks MUST NOT modify this delta. "
1564
" future_tree is an in-memory tree obtained from "
1565
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1566
"tree.", (0,91), None))
1567
self.create_hook(HookPoint('post_commit',
1568
"Called in the bzr client after a commit has completed. "
1569
"post_commit is called with (local, master, old_revno, old_revid, "
1570
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1571
"commit to a branch.", (0, 15), None))
1572
self.create_hook(HookPoint('post_uncommit',
1573
"Called in the bzr client after an uncommit completes. "
1574
"post_uncommit is called with (local, master, old_revno, "
1575
"old_revid, new_revno, new_revid) where local is the local branch "
1576
"or None, master is the target branch, and an empty branch "
1577
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1578
self.create_hook(HookPoint('pre_change_branch_tip',
1579
"Called in bzr client and server before a change to the tip of a "
1580
"branch is made. pre_change_branch_tip is called with a "
1581
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1582
"commit, uncommit will all trigger this hook.", (1, 6), None))
1583
self.create_hook(HookPoint('post_change_branch_tip',
1584
"Called in bzr client and server after a change to the tip of a "
1585
"branch is made. post_change_branch_tip is called with a "
1586
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1587
"commit, uncommit will all trigger this hook.", (1, 4), None))
1588
self.create_hook(HookPoint('transform_fallback_location',
1589
"Called when a stacked branch is activating its fallback "
1590
"locations. transform_fallback_location is called with (branch, "
1591
"url), and should return a new url. Returning the same url "
1592
"allows it to be used as-is, returning a different one can be "
1593
"used to cause the branch to stack on a closer copy of that "
1594
"fallback_location. Note that the branch cannot have history "
1595
"accessing methods called on it during this hook because the "
1596
"fallback locations have not been activated. When there are "
1597
"multiple hooks installed for transform_fallback_location, "
1598
"all are called with the url returned from the previous hook."
1599
"The order is however undefined.", (1, 9), None))
1602
# install the default hooks into the Branch class.
1603
Branch.hooks = BranchHooks()
1606
class ChangeBranchTipParams(object):
1607
"""Object holding parameters passed to *_change_branch_tip hooks.
1609
There are 5 fields that hooks may wish to access:
1611
:ivar branch: the branch being changed
1612
:ivar old_revno: revision number before the change
1613
:ivar new_revno: revision number after the change
1614
:ivar old_revid: revision id before the change
1615
:ivar new_revid: revision id after the change
1617
The revid fields are strings. The revno fields are integers.
1620
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1621
"""Create a group of ChangeBranchTip parameters.
1623
:param branch: The branch being changed.
1624
:param old_revno: Revision number before the change.
1625
:param new_revno: Revision number after the change.
1626
:param old_revid: Tip revision id before the change.
1627
:param new_revid: Tip revision id after the change.
1629
self.branch = branch
1630
self.old_revno = old_revno
1631
self.new_revno = new_revno
1632
self.old_revid = old_revid
1633
self.new_revid = new_revid
1635
def __eq__(self, other):
1636
return self.__dict__ == other.__dict__
1639
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1640
self.__class__.__name__, self.branch,
1641
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1644
class BzrBranchFormat4(BranchFormat):
1645
"""Bzr branch format 4.
1648
- a revision-history file.
1649
- a branch-lock lock file [ to be shared with the bzrdir ]
1652
def get_format_description(self):
1653
"""See BranchFormat.get_format_description()."""
1654
return "Branch format 4"
1656
def initialize(self, a_bzrdir):
1657
"""Create a branch of this format in a_bzrdir."""
1658
utf8_files = [('revision-history', ''),
1659
('branch-name', ''),
1661
return self._initialize_helper(a_bzrdir, utf8_files,
1662
lock_type='branch4', set_format=False)
1665
super(BzrBranchFormat4, self).__init__()
1666
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1668
def network_name(self):
1669
"""The network name for this format is the control dirs disk label."""
1670
return self._matchingbzrdir.get_format_string()
1672
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1673
"""See BranchFormat.open()."""
1675
# we are being called directly and must probe.
1676
raise NotImplementedError
1677
return BzrBranch(_format=self,
1678
_control_files=a_bzrdir._control_files,
1680
_repository=a_bzrdir.open_repository())
1683
return "Bazaar-NG branch format 4"
1686
class BranchFormatMetadir(BranchFormat):
1687
"""Common logic for meta-dir based branch formats."""
1689
def _branch_class(self):
1690
"""What class to instantiate on open calls."""
1691
raise NotImplementedError(self._branch_class)
1693
def network_name(self):
1694
"""A simple byte string uniquely identifying this format for RPC calls.
1696
Metadir branch formats use their format string.
1698
return self.get_format_string()
1700
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1701
"""See BranchFormat.open()."""
1703
format = BranchFormat.find_format(a_bzrdir)
1704
if format.__class__ != self.__class__:
1705
raise AssertionError("wrong format %r found for %r" %
1708
transport = a_bzrdir.get_branch_transport(None)
1709
control_files = lockable_files.LockableFiles(transport, 'lock',
1711
return self._branch_class()(_format=self,
1712
_control_files=control_files,
1714
_repository=a_bzrdir.find_repository(),
1715
ignore_fallbacks=ignore_fallbacks)
1716
except errors.NoSuchFile:
1717
raise errors.NotBranchError(path=transport.base)
1720
super(BranchFormatMetadir, self).__init__()
1721
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1722
self._matchingbzrdir.set_branch_format(self)
1724
def supports_tags(self):
1728
class BzrBranchFormat5(BranchFormatMetadir):
1729
"""Bzr branch format 5.
1732
- a revision-history file.
1734
- a lock dir guarding the branch itself
1735
- all of this stored in a branch/ subdirectory
1736
- works with shared repositories.
1738
This format is new in bzr 0.8.
1741
def _branch_class(self):
1744
def get_format_string(self):
1745
"""See BranchFormat.get_format_string()."""
1746
return "Bazaar-NG branch format 5\n"
1748
def get_format_description(self):
1749
"""See BranchFormat.get_format_description()."""
1750
return "Branch format 5"
1752
def initialize(self, a_bzrdir):
1753
"""Create a branch of this format in a_bzrdir."""
1754
utf8_files = [('revision-history', ''),
1755
('branch-name', ''),
1757
return self._initialize_helper(a_bzrdir, utf8_files)
1759
def supports_tags(self):
1763
class BzrBranchFormat6(BranchFormatMetadir):
1764
"""Branch format with last-revision and tags.
1766
Unlike previous formats, this has no explicit revision history. Instead,
1767
this just stores the last-revision, and the left-hand history leading
1768
up to there is the history.
1770
This format was introduced in bzr 0.15
1771
and became the default in 0.91.
1774
def _branch_class(self):
1777
def get_format_string(self):
1778
"""See BranchFormat.get_format_string()."""
1779
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1781
def get_format_description(self):
1782
"""See BranchFormat.get_format_description()."""
1783
return "Branch format 6"
1785
def initialize(self, a_bzrdir):
1786
"""Create a branch of this format in a_bzrdir."""
1787
utf8_files = [('last-revision', '0 null:\n'),
1788
('branch.conf', ''),
1791
return self._initialize_helper(a_bzrdir, utf8_files)
1793
def make_tags(self, branch):
1794
"""See bzrlib.branch.BranchFormat.make_tags()."""
1795
return BasicTags(branch)
1799
class BzrBranchFormat8(BranchFormatMetadir):
1800
"""Metadir format supporting storing locations of subtree branches."""
1802
def _branch_class(self):
1805
def get_format_string(self):
1806
"""See BranchFormat.get_format_string()."""
1807
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
1809
def get_format_description(self):
1810
"""See BranchFormat.get_format_description()."""
1811
return "Branch format 8"
1813
def initialize(self, a_bzrdir):
1814
"""Create a branch of this format in a_bzrdir."""
1815
utf8_files = [('last-revision', '0 null:\n'),
1816
('branch.conf', ''),
1820
return self._initialize_helper(a_bzrdir, utf8_files)
1823
super(BzrBranchFormat8, self).__init__()
1824
self._matchingbzrdir.repository_format = \
1825
RepositoryFormatKnitPack5RichRoot()
1827
def make_tags(self, branch):
1828
"""See bzrlib.branch.BranchFormat.make_tags()."""
1829
return BasicTags(branch)
1831
def supports_stacking(self):
1834
supports_reference_locations = True
1837
class BzrBranchFormat7(BzrBranchFormat8):
1838
"""Branch format with last-revision, tags, and a stacked location pointer.
1840
The stacked location pointer is passed down to the repository and requires
1841
a repository format with supports_external_lookups = True.
1843
This format was introduced in bzr 1.6.
1846
def initialize(self, a_bzrdir):
1847
"""Create a branch of this format in a_bzrdir."""
1848
utf8_files = [('last-revision', '0 null:\n'),
1849
('branch.conf', ''),
1852
return self._initialize_helper(a_bzrdir, utf8_files)
1854
def _branch_class(self):
1857
def get_format_string(self):
1858
"""See BranchFormat.get_format_string()."""
1859
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
1861
def get_format_description(self):
1862
"""See BranchFormat.get_format_description()."""
1863
return "Branch format 7"
1865
supports_reference_locations = False
1868
class BranchReferenceFormat(BranchFormat):
1869
"""Bzr branch reference format.
1871
Branch references are used in implementing checkouts, they
1872
act as an alias to the real branch which is at some other url.
1879
def get_format_string(self):
1880
"""See BranchFormat.get_format_string()."""
1881
return "Bazaar-NG Branch Reference Format 1\n"
1883
def get_format_description(self):
1884
"""See BranchFormat.get_format_description()."""
1885
return "Checkout reference format 1"
1887
def get_reference(self, a_bzrdir):
1888
"""See BranchFormat.get_reference()."""
1889
transport = a_bzrdir.get_branch_transport(None)
1890
return transport.get('location').read()
1892
def set_reference(self, a_bzrdir, to_branch):
1893
"""See BranchFormat.set_reference()."""
1894
transport = a_bzrdir.get_branch_transport(None)
1895
location = transport.put_bytes('location', to_branch.base)
1897
def initialize(self, a_bzrdir, target_branch=None):
1898
"""Create a branch of this format in a_bzrdir."""
1899
if target_branch is None:
1900
# this format does not implement branch itself, thus the implicit
1901
# creation contract must see it as uninitializable
1902
raise errors.UninitializableFormat(self)
1903
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1904
branch_transport = a_bzrdir.get_branch_transport(self)
1905
branch_transport.put_bytes('location',
1906
target_branch.bzrdir.root_transport.base)
1907
branch_transport.put_bytes('format', self.get_format_string())
1909
a_bzrdir, _found=True,
1910
possible_transports=[target_branch.bzrdir.root_transport])
1913
super(BranchReferenceFormat, self).__init__()
1914
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1915
self._matchingbzrdir.set_branch_format(self)
1917
def _make_reference_clone_function(format, a_branch):
1918
"""Create a clone() routine for a branch dynamically."""
1919
def clone(to_bzrdir, revision_id=None,
1920
repository_policy=None):
1921
"""See Branch.clone()."""
1922
return format.initialize(to_bzrdir, a_branch)
1923
# cannot obey revision_id limits when cloning a reference ...
1924
# FIXME RBC 20060210 either nuke revision_id for clone, or
1925
# emit some sort of warning/error to the caller ?!
1928
def open(self, a_bzrdir, _found=False, location=None,
1929
possible_transports=None, ignore_fallbacks=False):
1930
"""Return the branch that the branch reference in a_bzrdir points at.
1932
:param a_bzrdir: A BzrDir that contains a branch.
1933
:param _found: a private parameter, do not use it. It is used to
1934
indicate if format probing has already be done.
1935
:param ignore_fallbacks: when set, no fallback branches will be opened
1936
(if there are any). Default is to open fallbacks.
1937
:param location: The location of the referenced branch. If
1938
unspecified, this will be determined from the branch reference in
1940
:param possible_transports: An optional reusable transports list.
1943
format = BranchFormat.find_format(a_bzrdir)
1944
if format.__class__ != self.__class__:
1945
raise AssertionError("wrong format %r found for %r" %
1947
if location is None:
1948
location = self.get_reference(a_bzrdir)
1949
real_bzrdir = bzrdir.BzrDir.open(
1950
location, possible_transports=possible_transports)
1951
result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
1952
# this changes the behaviour of result.clone to create a new reference
1953
# rather than a copy of the content of the branch.
1954
# I did not use a proxy object because that needs much more extensive
1955
# testing, and we are only changing one behaviour at the moment.
1956
# If we decide to alter more behaviours - i.e. the implicit nickname
1957
# then this should be refactored to introduce a tested proxy branch
1958
# and a subclass of that for use in overriding clone() and ....
1960
result.clone = self._make_reference_clone_function(result)
1964
network_format_registry = registry.FormatRegistry()
1965
"""Registry of formats indexed by their network name.
1967
The network name for a branch format is an identifier that can be used when
1968
referring to formats with smart server operations. See
1969
BranchFormat.network_name() for more detail.
1973
# formats which have no format string are not discoverable
1974
# and not independently creatable, so are not registered.
1975
__format5 = BzrBranchFormat5()
1976
__format6 = BzrBranchFormat6()
1977
__format7 = BzrBranchFormat7()
1978
__format8 = BzrBranchFormat8()
1979
BranchFormat.register_format(__format5)
1980
BranchFormat.register_format(BranchReferenceFormat())
1981
BranchFormat.register_format(__format6)
1982
BranchFormat.register_format(__format7)
1983
BranchFormat.register_format(__format8)
1984
BranchFormat.set_default_format(__format6)
1985
_legacy_formats = [BzrBranchFormat4(),
1987
network_format_registry.register(
1988
_legacy_formats[0].network_name(), _legacy_formats[0].__class__)
1991
class BzrBranch(Branch):
1992
"""A branch stored in the actual filesystem.
1994
Note that it's "local" in the context of the filesystem; it doesn't
1995
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1996
it's writable, and can be accessed via the normal filesystem API.
1998
:ivar _transport: Transport for file operations on this branch's
1999
control files, typically pointing to the .bzr/branch directory.
2000
:ivar repository: Repository for this branch.
2001
:ivar base: The url of the base directory for this branch; the one
2002
containing the .bzr directory.
2005
def __init__(self, _format=None,
2006
_control_files=None, a_bzrdir=None, _repository=None,
2007
ignore_fallbacks=False):
2008
"""Create new branch object at a particular location."""
2009
if a_bzrdir is None:
2010
raise ValueError('a_bzrdir must be supplied')
2012
self.bzrdir = a_bzrdir
2013
self._base = self.bzrdir.transport.clone('..').base
2014
# XXX: We should be able to just do
2015
# self.base = self.bzrdir.root_transport.base
2016
# but this does not quite work yet -- mbp 20080522
2017
self._format = _format
2018
if _control_files is None:
2019
raise ValueError('BzrBranch _control_files is None')
2020
self.control_files = _control_files
2021
self._transport = _control_files._transport
2022
self.repository = _repository
2023
Branch.__init__(self)
2026
return '%s(%r)' % (self.__class__.__name__, self.base)
2030
def _get_base(self):
2031
"""Returns the directory containing the control directory."""
2034
base = property(_get_base, doc="The URL for the root of this branch.")
2036
def _get_config(self):
2037
return TransportConfig(self._transport, 'branch.conf')
2039
def is_locked(self):
2040
return self.control_files.is_locked()
2042
def lock_write(self, token=None):
2043
# All-in-one needs to always unlock/lock.
2044
repo_control = getattr(self.repository, 'control_files', None)
2045
if self.control_files == repo_control or not self.is_locked():
2046
self.repository.lock_write()
2051
return self.control_files.lock_write(token=token)
2054
self.repository.unlock()
2057
def lock_read(self):
2058
# All-in-one needs to always unlock/lock.
2059
repo_control = getattr(self.repository, 'control_files', None)
2060
if self.control_files == repo_control or not self.is_locked():
2061
self.repository.lock_read()
2066
self.control_files.lock_read()
2069
self.repository.unlock()
2074
self.control_files.unlock()
2076
# All-in-one needs to always unlock/lock.
2077
repo_control = getattr(self.repository, 'control_files', None)
2078
if (self.control_files == repo_control or
2079
not self.control_files.is_locked()):
2080
self.repository.unlock()
2081
if not self.control_files.is_locked():
2082
# we just released the lock
2083
self._clear_cached_state()
2085
def peek_lock_mode(self):
2086
if self.control_files._lock_count == 0:
2089
return self.control_files._lock_mode
2091
def get_physical_lock_status(self):
2092
return self.control_files.get_physical_lock_status()
2095
def print_file(self, file, revision_id):
2096
"""See Branch.print_file."""
2097
return self.repository.print_file(file, revision_id)
2099
def _write_revision_history(self, history):
2100
"""Factored out of set_revision_history.
2102
This performs the actual writing to disk.
2103
It is intended to be called by BzrBranch5.set_revision_history."""
2104
self._transport.put_bytes(
2105
'revision-history', '\n'.join(history),
2106
mode=self.bzrdir._get_file_mode())
2109
def set_revision_history(self, rev_history):
2110
"""See Branch.set_revision_history."""
2111
if 'evil' in debug.debug_flags:
2112
mutter_callsite(3, "set_revision_history scales with history.")
2113
check_not_reserved_id = _mod_revision.check_not_reserved_id
2114
for rev_id in rev_history:
2115
check_not_reserved_id(rev_id)
2116
if Branch.hooks['post_change_branch_tip']:
2117
# Don't calculate the last_revision_info() if there are no hooks
2119
old_revno, old_revid = self.last_revision_info()
2120
if len(rev_history) == 0:
2121
revid = _mod_revision.NULL_REVISION
2123
revid = rev_history[-1]
2124
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2125
self._write_revision_history(rev_history)
2126
self._clear_cached_state()
2127
self._cache_revision_history(rev_history)
2128
for hook in Branch.hooks['set_rh']:
2129
hook(self, rev_history)
2130
if Branch.hooks['post_change_branch_tip']:
2131
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2133
def _synchronize_history(self, destination, revision_id):
2134
"""Synchronize last revision and revision history between branches.
2136
This version is most efficient when the destination is also a
2137
BzrBranch5, but works for BzrBranch6 as long as the revision
2138
history is the true lefthand parent history, and all of the revisions
2139
are in the destination's repository. If not, set_revision_history
2142
:param destination: The branch to copy the history into
2143
:param revision_id: The revision-id to truncate history at. May
2144
be None to copy complete history.
2146
if not isinstance(destination._format, BzrBranchFormat5):
2147
super(BzrBranch, self)._synchronize_history(
2148
destination, revision_id)
2150
if revision_id == _mod_revision.NULL_REVISION:
2153
new_history = self.revision_history()
2154
if revision_id is not None and new_history != []:
2156
new_history = new_history[:new_history.index(revision_id) + 1]
2158
rev = self.repository.get_revision(revision_id)
2159
new_history = rev.get_history(self.repository)[1:]
2160
destination.set_revision_history(new_history)
2163
def set_last_revision_info(self, revno, revision_id):
2164
"""Set the last revision of this branch.
2166
The caller is responsible for checking that the revno is correct
2167
for this revision id.
2169
It may be possible to set the branch last revision to an id not
2170
present in the repository. However, branches can also be
2171
configured to check constraints on history, in which case this may not
2174
revision_id = _mod_revision.ensure_null(revision_id)
2175
# this old format stores the full history, but this api doesn't
2176
# provide it, so we must generate, and might as well check it's
2178
history = self._lefthand_history(revision_id)
2179
if len(history) != revno:
2180
raise AssertionError('%d != %d' % (len(history), revno))
2181
self.set_revision_history(history)
2183
def _gen_revision_history(self):
2184
history = self._transport.get_bytes('revision-history').split('\n')
2185
if history[-1:] == ['']:
2186
# There shouldn't be a trailing newline, but just in case.
2191
def generate_revision_history(self, revision_id, last_rev=None,
2193
"""Create a new revision history that will finish with revision_id.
2195
:param revision_id: the new tip to use.
2196
:param last_rev: The previous last_revision. If not None, then this
2197
must be a ancestory of revision_id, or DivergedBranches is raised.
2198
:param other_branch: The other branch that DivergedBranches should
2199
raise with respect to.
2201
self.set_revision_history(self._lefthand_history(revision_id,
2202
last_rev, other_branch))
2204
def basis_tree(self):
2205
"""See Branch.basis_tree."""
2206
return self.repository.revision_tree(self.last_revision())
2208
def _get_parent_location(self):
2209
_locs = ['parent', 'pull', 'x-pull']
2212
return self._transport.get_bytes(l).strip('\n')
2213
except errors.NoSuchFile:
2217
def _basic_push(self, target, overwrite, stop_revision):
2218
"""Basic implementation of push without bound branches or hooks.
2220
Must be called with source read locked and target write locked.
2222
result = BranchPushResult()
2223
result.source_branch = self
2224
result.target_branch = target
2225
result.old_revno, result.old_revid = target.last_revision_info()
2226
self.update_references(target)
2227
if result.old_revid != self.last_revision():
2228
# We assume that during 'push' this repository is closer than
2230
graph = self.repository.get_graph(target.repository)
2231
target.update_revisions(self, stop_revision,
2232
overwrite=overwrite, graph=graph)
2233
if self._push_should_merge_tags():
2234
result.tag_conflicts = self.tags.merge_to(target.tags,
2236
result.new_revno, result.new_revid = target.last_revision_info()
2239
def get_stacked_on_url(self):
2240
raise errors.UnstackableBranchFormat(self._format, self.base)
2242
def set_push_location(self, location):
2243
"""See Branch.set_push_location."""
2244
self.get_config().set_user_option(
2245
'push_location', location,
2246
store=_mod_config.STORE_LOCATION_NORECURSE)
2248
def _set_parent_location(self, url):
2250
self._transport.delete('parent')
2252
self._transport.put_bytes('parent', url + '\n',
2253
mode=self.bzrdir._get_file_mode())
2256
class BzrBranch5(BzrBranch):
2257
"""A format 5 branch. This supports new features over plain branches.
2259
It has support for a master_branch which is the data for bound branches.
2262
def get_bound_location(self):
2264
return self._transport.get_bytes('bound')[:-1]
2265
except errors.NoSuchFile:
2269
def get_master_branch(self, possible_transports=None):
2270
"""Return the branch we are bound to.
2272
:return: Either a Branch, or None
2274
This could memoise the branch, but if thats done
2275
it must be revalidated on each new lock.
2276
So for now we just don't memoise it.
2277
# RBC 20060304 review this decision.
2279
bound_loc = self.get_bound_location()
2283
return Branch.open(bound_loc,
2284
possible_transports=possible_transports)
2285
except (errors.NotBranchError, errors.ConnectionError), e:
2286
raise errors.BoundBranchConnectionFailure(
2290
def set_bound_location(self, location):
2291
"""Set the target where this branch is bound to.
2293
:param location: URL to the target branch
2296
self._transport.put_bytes('bound', location+'\n',
2297
mode=self.bzrdir._get_file_mode())
2300
self._transport.delete('bound')
2301
except errors.NoSuchFile:
2306
def bind(self, other):
2307
"""Bind this branch to the branch other.
2309
This does not push or pull data between the branches, though it does
2310
check for divergence to raise an error when the branches are not
2311
either the same, or one a prefix of the other. That behaviour may not
2312
be useful, so that check may be removed in future.
2314
:param other: The branch to bind to
2317
# TODO: jam 20051230 Consider checking if the target is bound
2318
# It is debatable whether you should be able to bind to
2319
# a branch which is itself bound.
2320
# Committing is obviously forbidden,
2321
# but binding itself may not be.
2322
# Since we *have* to check at commit time, we don't
2323
# *need* to check here
2325
# we want to raise diverged if:
2326
# last_rev is not in the other_last_rev history, AND
2327
# other_last_rev is not in our history, and do it without pulling
2329
self.set_bound_location(other.base)
2333
"""If bound, unbind"""
2334
return self.set_bound_location(None)
2337
def update(self, possible_transports=None):
2338
"""Synchronise this branch with the master branch if any.
2340
:return: None or the last_revision that was pivoted out during the
2343
master = self.get_master_branch(possible_transports)
2344
if master is not None:
2345
old_tip = _mod_revision.ensure_null(self.last_revision())
2346
self.pull(master, overwrite=True)
2347
if self.repository.get_graph().is_ancestor(old_tip,
2348
_mod_revision.ensure_null(self.last_revision())):
2354
class BzrBranch8(BzrBranch5):
2355
"""A branch that stores tree-reference locations."""
2357
def _open_hook(self):
2358
if self._ignore_fallbacks:
2361
url = self.get_stacked_on_url()
2362
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2363
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:
2366
for hook in Branch.hooks['transform_fallback_location']:
2367
url = hook(self, url)
2369
hook_name = Branch.hooks.get_hook_name(hook)
2370
raise AssertionError(
2371
"'transform_fallback_location' hook %s returned "
2372
"None, not a URL." % hook_name)
2373
self._activate_fallback_location(url)
2375
def __init__(self, *args, **kwargs):
2376
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2377
super(BzrBranch8, self).__init__(*args, **kwargs)
2378
self._last_revision_info_cache = None
2379
self._partial_revision_history_cache = []
2380
self._reference_info = None
2382
def _clear_cached_state(self):
2383
super(BzrBranch8, self)._clear_cached_state()
2384
self._last_revision_info_cache = None
2385
self._partial_revision_history_cache = []
2386
self._reference_info = None
2388
def _last_revision_info(self):
2389
revision_string = self._transport.get_bytes('last-revision')
2390
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2391
revision_id = cache_utf8.get_cached_utf8(revision_id)
2393
return revno, revision_id
2395
def _write_last_revision_info(self, revno, revision_id):
2396
"""Simply write out the revision id, with no checks.
2398
Use set_last_revision_info to perform this safely.
2400
Does not update the revision_history cache.
2401
Intended to be called by set_last_revision_info and
2402
_write_revision_history.
2404
revision_id = _mod_revision.ensure_null(revision_id)
2405
out_string = '%d %s\n' % (revno, revision_id)
2406
self._transport.put_bytes('last-revision', out_string,
2407
mode=self.bzrdir._get_file_mode())
2410
def set_last_revision_info(self, revno, revision_id):
2411
revision_id = _mod_revision.ensure_null(revision_id)
2412
old_revno, old_revid = self.last_revision_info()
2413
if self._get_append_revisions_only():
2414
self._check_history_violation(revision_id)
2415
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2416
self._write_last_revision_info(revno, revision_id)
2417
self._clear_cached_state()
2418
self._last_revision_info_cache = revno, revision_id
2419
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2421
def _synchronize_history(self, destination, revision_id):
2422
"""Synchronize last revision and revision history between branches.
2424
:see: Branch._synchronize_history
2426
# XXX: The base Branch has a fast implementation of this method based
2427
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2428
# that uses set_revision_history. This class inherits from BzrBranch5,
2429
# but wants the fast implementation, so it calls
2430
# Branch._synchronize_history directly.
2431
Branch._synchronize_history(self, destination, revision_id)
2433
def _check_history_violation(self, revision_id):
2434
last_revision = _mod_revision.ensure_null(self.last_revision())
2435
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
2437
if last_revision not in self._lefthand_history(revision_id):
2438
raise errors.AppendRevisionsOnlyViolation(self.base)
2440
def _gen_revision_history(self):
2441
"""Generate the revision history from last revision
2443
last_revno, last_revision = self.last_revision_info()
2444
self._extend_partial_history(stop_index=last_revno-1)
2445
return list(reversed(self._partial_revision_history_cache))
2447
def _extend_partial_history(self, stop_index=None, stop_revision=None):
2448
"""Extend the partial history to include a given index
2450
If a stop_index is supplied, stop when that index has been reached.
2451
If a stop_revision is supplied, stop when that revision is
2452
encountered. Otherwise, stop when the beginning of history is
2455
:param stop_index: The index which should be present. When it is
2456
present, history extension will stop.
2457
:param revision_id: The revision id which should be present. When
2458
it is encountered, history extension will stop.
2460
repo = self.repository
2461
if len(self._partial_revision_history_cache) == 0:
2462
iterator = repo.iter_reverse_revision_history(self.last_revision())
2464
start_revision = self._partial_revision_history_cache[-1]
2465
iterator = repo.iter_reverse_revision_history(start_revision)
2466
#skip the last revision in the list
2467
next_revision = iterator.next()
2468
for revision_id in iterator:
2469
self._partial_revision_history_cache.append(revision_id)
2470
if (stop_index is not None and
2471
len(self._partial_revision_history_cache) > stop_index):
2473
if revision_id == stop_revision:
2476
def _write_revision_history(self, history):
2477
"""Factored out of set_revision_history.
2479
This performs the actual writing to disk, with format-specific checks.
2480
It is intended to be called by BzrBranch5.set_revision_history.
2482
if len(history) == 0:
2483
last_revision = 'null:'
2485
if history != self._lefthand_history(history[-1]):
2486
raise errors.NotLefthandHistory(history)
2487
last_revision = history[-1]
2488
if self._get_append_revisions_only():
2489
self._check_history_violation(last_revision)
2490
self._write_last_revision_info(len(history), last_revision)
2493
def _set_parent_location(self, url):
2494
"""Set the parent branch"""
2495
self._set_config_location('parent_location', url, make_relative=True)
2498
def _get_parent_location(self):
2499
"""Set the parent branch"""
2500
return self._get_config_location('parent_location')
2503
def _set_all_reference_info(self, info_dict):
2504
"""Replace all reference info stored in a branch.
2506
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2509
writer = rio.RioWriter(s)
2510
for key, (tree_path, branch_location) in info_dict.iteritems():
2511
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2512
branch_location=branch_location)
2513
writer.write_stanza(stanza)
2514
self._transport.put_bytes('references', s.getvalue())
2515
self._reference_info = info_dict
2518
def _get_all_reference_info(self):
2519
"""Return all the reference info stored in a branch.
2521
:return: A dict of {file_id: (tree_path, branch_location)}
2523
if self._reference_info is not None:
2524
return self._reference_info
2525
rio_file = self._transport.get('references')
1256
f = AtomicFile(self.controlfilename('pending-merges'))
2527
stanzas = rio.read_stanzas(rio_file)
2528
info_dict = dict((s['file_id'], (s['tree_path'],
2529
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()
2532
self._reference_info = info_dict
2535
def set_reference_info(self, file_id, tree_path, branch_location):
2536
"""Set the branch location to use for a tree reference.
2538
:param file_id: The file-id of the tree reference.
2539
:param tree_path: The path of the tree reference in the tree.
2540
:param branch_location: The location of the branch to retrieve tree
2543
info_dict = self._get_all_reference_info()
2544
info_dict[file_id] = (tree_path, branch_location)
2545
if None in (tree_path, branch_location):
2546
if tree_path is not None:
2547
raise ValueError('tree_path must be None when branch_location'
2549
if branch_location is not None:
2550
raise ValueError('branch_location must be None when tree_path'
2552
del info_dict[file_id]
2553
self._set_all_reference_info(info_dict)
2555
def get_reference_info(self, file_id):
2556
"""Get the tree_path and branch_location for a tree reference.
2558
:return: a tuple of (tree_path, branch_location)
2560
return self._get_all_reference_info().get(file_id, (None, None))
2562
def reference_parent(self, file_id, path, possible_transports=None):
2563
"""Return the parent branch for a tree-reference file_id.
2565
:param file_id: The file_id of the tree reference
2566
:param path: The path of the file_id in the tree
2567
:return: A branch associated with the file_id
2569
branch_location = self.get_reference_info(file_id)[1]
2570
if branch_location is None:
2571
return Branch.reference_parent(self, file_id, path,
2572
possible_transports)
2573
branch_location = urlutils.join(self.base, branch_location)
2574
return Branch.open(branch_location,
2575
possible_transports=possible_transports)
2577
def set_push_location(self, location):
2578
"""See Branch.set_push_location."""
2579
self._set_config_location('push_location', location)
2581
def set_bound_location(self, location):
2582
"""See Branch.set_push_location."""
2584
config = self.get_config()
2585
if location is None:
2586
if config.get_user_option('bound') != 'True':
2589
config.set_user_option('bound', 'False', warn_masked=True)
2592
self._set_config_location('bound_location', location,
2594
config.set_user_option('bound', 'True', warn_masked=True)
2597
def _get_bound_location(self, bound):
2598
"""Return the bound location in the config file.
2600
Return None if the bound parameter does not match"""
2601
config = self.get_config()
2602
config_bound = (config.get_user_option('bound') == 'True')
2603
if config_bound != bound:
2605
return self._get_config_location('bound_location', config=config)
2607
def get_bound_location(self):
2608
"""See Branch.set_push_location."""
2609
return self._get_bound_location(True)
2611
def get_old_bound_location(self):
2612
"""See Branch.get_old_bound_location"""
2613
return self._get_bound_location(False)
2615
def get_stacked_on_url(self):
2616
# you can always ask for the URL; but you might not be able to use it
2617
# if the repo can't support stacking.
2618
## self._check_stackable_repo()
2619
stacked_url = self._get_config_location('stacked_on_location')
2620
if stacked_url is None:
2621
raise errors.NotStacked(self)
2624
def set_append_revisions_only(self, enabled):
2629
self.get_config().set_user_option('append_revisions_only', value,
2632
def _get_append_revisions_only(self):
2633
value = self.get_config().get_user_option('append_revisions_only')
2634
return value == 'True'
2637
def generate_revision_history(self, revision_id, last_rev=None,
2639
"""See BzrBranch5.generate_revision_history"""
2640
history = self._lefthand_history(revision_id, last_rev, other_branch)
2641
revno = len(history)
2642
self.set_last_revision_info(revno, revision_id)
2645
def get_rev_id(self, revno, history=None):
2646
"""Find the revision id of the specified revno."""
2648
return _mod_revision.NULL_REVISION
2650
last_revno, last_revision_id = self.last_revision_info()
2651
if revno <= 0 or revno > last_revno:
2652
raise errors.NoSuchRevision(self, revno)
2654
if history is not None:
2655
return history[revno - 1]
2657
index = last_revno - revno
2658
if len(self._partial_revision_history_cache) <= index:
2659
self._extend_partial_history(stop_index=index)
2660
if len(self._partial_revision_history_cache) > index:
2661
return self._partial_revision_history_cache[index]
2663
raise errors.NoSuchRevision(self, revno)
2666
def revision_id_to_revno(self, revision_id):
2667
"""Given a revision id, return its revno"""
2668
if _mod_revision.is_null(revision_id):
2671
index = self._partial_revision_history_cache.index(revision_id)
2673
self._extend_partial_history(stop_revision=revision_id)
2674
index = len(self._partial_revision_history_cache) - 1
2675
if self._partial_revision_history_cache[index] != revision_id:
2676
raise errors.NoSuchRevision(self, revision_id)
2677
return self.revno() - index
2680
class BzrBranch7(BzrBranch8):
2681
"""A branch with support for a fallback repository."""
2683
def set_reference_info(self, file_id, tree_path, branch_location):
2684
Branch.set_reference_info(self, file_id, tree_path, branch_location)
2686
def get_reference_info(self, file_id):
2687
Branch.get_reference_info(self, file_id)
2689
def reference_parent(self, file_id, path, possible_transports=None):
2690
return Branch.reference_parent(self, file_id, path,
2691
possible_transports)
2694
class BzrBranch6(BzrBranch7):
2695
"""See BzrBranchFormat6 for the capabilities of this branch.
2697
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)
2701
def get_stacked_on_url(self):
2702
raise errors.UnstackableBranchFormat(self._format, self.base)
1337
2705
######################################################################
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')
2706
# results of operations
2709
class _Result(object):
2711
def _show_tag_conficts(self, to_file):
2712
if not getattr(self, 'tag_conflicts', None):
2714
to_file.write('Conflicting tags:\n')
2715
for name, value1, value2 in self.tag_conflicts:
2716
to_file.write(' %s\n' % (name, ))
2719
class PullResult(_Result):
2720
"""Result of a Branch.pull operation.
2722
:ivar old_revno: Revision number before pull.
2723
:ivar new_revno: Revision number after pull.
2724
:ivar old_revid: Tip revision id before pull.
2725
:ivar new_revid: Tip revision id after pull.
2726
:ivar source_branch: Source (local) branch object. (read locked)
2727
:ivar master_branch: Master branch of the target, or the target if no
2729
:ivar local_branch: target branch if there is a Master, else None
2730
:ivar target_branch: Target/destination branch object. (write locked)
2731
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2735
# DEPRECATED: pull used to return the change in revno
2736
return self.new_revno - self.old_revno
2738
def report(self, to_file):
2740
if self.old_revid == self.new_revid:
2741
to_file.write('No revisions to pull.\n')
2743
to_file.write('Now on revision %d.\n' % self.new_revno)
2744
self._show_tag_conficts(to_file)
2747
class BranchPushResult(_Result):
2748
"""Result of a Branch.push operation.
2750
:ivar old_revno: Revision number (eg 10) of the target before push.
2751
:ivar new_revno: Revision number (eg 12) of the target after push.
2752
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
2754
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
2756
:ivar source_branch: Source branch object that the push was from. This is
2757
read locked, and generally is a local (and thus low latency) branch.
2758
:ivar master_branch: If target is a bound branch, the master branch of
2759
target, or target itself. Always write locked.
2760
:ivar target_branch: The direct Branch where data is being sent (write
2762
:ivar local_branch: If the target is a bound branch this will be the
2763
target, otherwise it will be None.
2767
# DEPRECATED: push used to return the change in revno
2768
return self.new_revno - self.old_revno
2770
def report(self, to_file):
2771
"""Write a human-readable description of the result."""
2772
if self.old_revid == self.new_revid:
2773
note('No new revisions to push.')
2775
note('Pushed up to revision %d.' % self.new_revno)
2776
self._show_tag_conficts(to_file)
2779
class BranchCheckResult(object):
2780
"""Results of checking branch consistency.
2785
def __init__(self, branch):
2786
self.branch = branch
2787
self.ghosts_in_mainline = False
2789
def report_results(self, verbose):
2790
"""Report the check results via trace.note.
2792
:param verbose: Requests more detailed display of what was checked,
2795
note('checked branch %s format %s',
2797
self.branch._format)
2798
if self.ghosts_in_mainline:
2799
note('branch contains ghosts in mainline')
2802
class Converter5to6(object):
2803
"""Perform an in-place upgrade of format 5 to format 6"""
2805
def convert(self, branch):
2806
# Data for 5 and 6 can peacefully coexist.
2807
format = BzrBranchFormat6()
2808
new_branch = format.open(branch.bzrdir, _found=True)
2810
# Copy source data into target
2811
new_branch._write_last_revision_info(*branch.last_revision_info())
2812
new_branch.set_parent(branch.get_parent())
2813
new_branch.set_bound_location(branch.get_bound_location())
2814
new_branch.set_push_location(branch.get_push_location())
2816
# New branch has no tags by default
2817
new_branch.tags._set_tag_dict({})
2819
# Copying done; now update target format
2820
new_branch._transport.put_bytes('format',
2821
format.get_format_string(),
2822
mode=new_branch.bzrdir._get_file_mode())
2824
# Clean up old files
2825
new_branch._transport.delete('revision-history')
2827
branch.set_parent(None)
2828
except errors.NoSuchFile:
2830
branch.set_bound_location(None)
2833
class Converter6to7(object):
2834
"""Perform an in-place upgrade of format 6 to format 7"""
2836
def convert(self, branch):
2837
format = BzrBranchFormat7()
2838
branch._set_config_location('stacked_on_location', '')
2839
# update target format
2840
branch._transport.put_bytes('format', format.get_format_string())
2843
class Converter7to8(object):
2844
"""Perform an in-place upgrade of format 6 to format 7"""
2846
def convert(self, branch):
2847
format = BzrBranchFormat8()
2848
branch._transport.put_bytes('references', '')
2849
# update target format
2850
branch._transport.put_bytes('format', format.get_format_string())
2853
def _run_with_write_locked_target(target, callable, *args, **kwargs):
2854
"""Run ``callable(*args, **kwargs)``, write-locking target for the
2857
_run_with_write_locked_target will attempt to release the lock it acquires.
2859
If an exception is raised by callable, then that exception *will* be
2860
propagated, even if the unlock attempt raises its own error. Thus
2861
_run_with_write_locked_target should be preferred to simply doing::
2865
return callable(*args, **kwargs)
2870
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
2871
# should share code?
2874
result = callable(*args, **kwargs)
2876
exc_info = sys.exc_info()
2880
raise exc_info[0], exc_info[1], exc_info[2]
2886
class InterBranch(InterObject):
2887
"""This class represents operations taking place between two branches.
2889
Its instances have methods like pull() and push() and contain
2890
references to the source and target repositories these operations
2891
can be carried out on.
2895
"""The available optimised InterBranch types."""
2898
def _get_branch_formats_to_test():
2899
"""Return a tuple with the Branch formats to use when testing."""
2900
raise NotImplementedError(self._get_branch_formats_to_test)
2902
def pull(self, overwrite=False, stop_revision=None,
2903
possible_transports=None, local=False):
2904
"""Mirror source into target branch.
2906
The target branch is considered to be 'local', having low latency.
2908
:returns: PullResult instance
2910
raise NotImplementedError(self.pull)
2912
def update_revisions(self, stop_revision=None, overwrite=False,
2914
"""Pull in new perfect-fit revisions.
2916
:param stop_revision: Updated until the given revision
2917
:param overwrite: Always set the branch pointer, rather than checking
2918
to see if it is a proper descendant.
2919
:param graph: A Graph object that can be used to query history
2920
information. This can be None.
2923
raise NotImplementedError(self.update_revisions)
2925
def push(self, overwrite=False, stop_revision=None,
2926
_override_hook_source_branch=None):
2927
"""Mirror the source branch into the target branch.
2929
The source branch is considered to be 'local', having low latency.
2931
raise NotImplementedError(self.push)
2934
class GenericInterBranch(InterBranch):
2935
"""InterBranch implementation that uses public Branch functions.
2939
def _get_branch_formats_to_test():
2940
return BranchFormat._default_format, BranchFormat._default_format
2942
def update_revisions(self, stop_revision=None, overwrite=False,
2944
"""See InterBranch.update_revisions()."""
2945
self.source.lock_read()
2947
other_revno, other_last_revision = self.source.last_revision_info()
2948
stop_revno = None # unknown
2949
if stop_revision is None:
2950
stop_revision = other_last_revision
2951
if _mod_revision.is_null(stop_revision):
2952
# if there are no commits, we're done.
2954
stop_revno = other_revno
2956
# what's the current last revision, before we fetch [and change it
2958
last_rev = _mod_revision.ensure_null(self.target.last_revision())
2959
# we fetch here so that we don't process data twice in the common
2960
# case of having something to pull, and so that the check for
2961
# already merged can operate on the just fetched graph, which will
2962
# be cached in memory.
2963
self.target.fetch(self.source, stop_revision)
2964
# Check to see if one is an ancestor of the other
2967
graph = self.target.repository.get_graph()
2968
if self.target._check_if_descendant_or_diverged(
2969
stop_revision, last_rev, graph, self.source):
2970
# stop_revision is a descendant of last_rev, but we aren't
2971
# overwriting, so we're done.
2973
if stop_revno is None:
2975
graph = self.target.repository.get_graph()
2976
this_revno, this_last_revision = \
2977
self.target.last_revision_info()
2978
stop_revno = graph.find_distance_to_null(stop_revision,
2979
[(other_last_revision, other_revno),
2980
(this_last_revision, this_revno)])
2981
self.target.set_last_revision_info(stop_revno, stop_revision)
2983
self.source.unlock()
2985
def pull(self, overwrite=False, stop_revision=None,
2986
possible_transports=None, _hook_master=None, run_hooks=True,
2987
_override_hook_target=None, local=False):
2990
:param _hook_master: Private parameter - set the branch to
2991
be supplied as the master to pull hooks.
2992
:param run_hooks: Private parameter - if false, this branch
2993
is being called because it's the master of the primary branch,
2994
so it should not run its hooks.
2995
:param _override_hook_target: Private parameter - set the branch to be
2996
supplied as the target_branch to pull hooks.
2997
:param local: Only update the local branch, and not the bound branch.
2999
# This type of branch can't be bound.
3001
raise errors.LocalRequiresBoundBranch()
3002
result = PullResult()
3003
result.source_branch = self.source
3004
if _override_hook_target is None:
3005
result.target_branch = self.target
3007
result.target_branch = _override_hook_target
3008
self.source.lock_read()
3010
# We assume that during 'pull' the target repository is closer than
3012
self.source.update_references(self.target)
3013
graph = self.target.repository.get_graph(self.source.repository)
3014
# TODO: Branch formats should have a flag that indicates
3015
# that revno's are expensive, and pull() should honor that flag.
3017
result.old_revno, result.old_revid = \
3018
self.target.last_revision_info()
3019
self.target.update_revisions(self.source, stop_revision,
3020
overwrite=overwrite, graph=graph)
3021
# TODO: The old revid should be specified when merging tags,
3022
# so a tags implementation that versions tags can only
3023
# pull in the most recent changes. -- JRV20090506
3024
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3026
result.new_revno, result.new_revid = self.target.last_revision_info()
3028
result.master_branch = _hook_master
3029
result.local_branch = result.target_branch
3031
result.master_branch = result.target_branch
3032
result.local_branch = None
3034
for hook in Branch.hooks['post_pull']:
3037
self.source.unlock()
3040
def push(self, overwrite=False, stop_revision=None,
3041
_override_hook_source_branch=None):
3042
"""See InterBranch.push.
3044
This is the basic concrete implementation of push()
3046
:param _override_hook_source_branch: If specified, run
3047
the hooks passing this Branch as the source, rather than self.
3048
This is for use of RemoteBranch, where push is delegated to the
3049
underlying vfs-based Branch.
3051
# TODO: Public option to disable running hooks - should be trivial but
3053
self.source.lock_read()
3055
return _run_with_write_locked_target(
3056
self.target, self._push_with_bound_branches, overwrite,
3058
_override_hook_source_branch=_override_hook_source_branch)
3060
self.source.unlock()
3063
def _push_with_bound_branches(self, overwrite, stop_revision,
3064
_override_hook_source_branch=None):
3065
"""Push from source into target, and into target's master if any.
3068
if _override_hook_source_branch:
3069
result.source_branch = _override_hook_source_branch
3070
for hook in Branch.hooks['post_push']:
3073
bound_location = self.target.get_bound_location()
3074
if bound_location and self.target.base != bound_location:
3075
# there is a master branch.
3077
# XXX: Why the second check? Is it even supported for a branch to
3078
# be bound to itself? -- mbp 20070507
3079
master_branch = self.target.get_master_branch()
3080
master_branch.lock_write()
3082
# push into the master from the source branch.
3083
self.source._basic_push(master_branch, overwrite, stop_revision)
3084
# and push into the target branch from the source. Note that we
3085
# push from the source branch again, because its considered the
3086
# highest bandwidth repository.
3087
result = self.source._basic_push(self.target, overwrite,
3089
result.master_branch = master_branch
3090
result.local_branch = self.target
3094
master_branch.unlock()
3097
result = self.source._basic_push(self.target, overwrite,
3099
# TODO: Why set master_branch and local_branch if there's no
3100
# binding? Maybe cleaner to just leave them unset? -- mbp
3102
result.master_branch = self.target
3103
result.local_branch = None
3108
def is_compatible(self, source, target):
3109
# GenericBranch uses the public API, so always compatible
3113
class InterToBranch5(GenericInterBranch):
3116
def _get_branch_formats_to_test():
3117
return BranchFormat._default_format, BzrBranchFormat5()
3119
def pull(self, overwrite=False, stop_revision=None,
3120
possible_transports=None, run_hooks=True,
3121
_override_hook_target=None, local=False):
3122
"""Pull from source into self, updating my master if any.
3124
:param run_hooks: Private parameter - if false, this branch
3125
is being called because it's the master of the primary branch,
3126
so it should not run its hooks.
3128
bound_location = self.target.get_bound_location()
3129
if local and not bound_location:
3130
raise errors.LocalRequiresBoundBranch()
3131
master_branch = None
3132
if not local and bound_location and self.source.base != bound_location:
3133
# not pulling from master, so we need to update master.
3134
master_branch = self.target.get_master_branch(possible_transports)
3135
master_branch.lock_write()
3138
# pull from source into master.
3139
master_branch.pull(self.source, overwrite, stop_revision,
3141
return super(InterToBranch5, self).pull(overwrite,
3142
stop_revision, _hook_master=master_branch,
3143
run_hooks=run_hooks,
3144
_override_hook_target=_override_hook_target)
3147
master_branch.unlock()
3150
InterBranch.register_optimiser(GenericInterBranch)
3151
InterBranch.register_optimiser(InterToBranch5)
added
removed
bzrlib/branch.py
