137
76
"""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.
79
Base directory/url of the branch.
81
hooks: An instance of BranchHooks.
83
# 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)
87
def __init__(self, *ignored, **ignored_too):
88
self.tags = self._format.make_tags(self)
89
self._revision_history_cache = None
90
self._revision_id_to_revno_cache = None
91
self._partial_revision_id_to_revno_cache = {}
92
self._last_revision_info_cache = None
93
self._merge_sorted_revisions_cache = None
95
hooks = Branch.hooks['open']
100
"""Called by init to allow simpler extension of the base class."""
102
def _activate_fallback_location(self, url, lock_style):
103
"""Activate the branch/repository from url as a fallback repository."""
104
repo = self._get_fallback_repository(url)
105
if lock_style == 'write':
107
elif lock_style == 'read':
109
self.repository.add_fallback_repository(repo)
111
def break_lock(self):
112
"""Break a lock if one is present from another instance.
114
Uses the ui factory to ask for confirmation if the lock may be from
117
This will probe the repository for its lock as well.
119
self.control_files.break_lock()
120
self.repository.break_lock()
121
master = self.get_master_branch()
122
if master is not None:
125
def _check_stackable_repo(self):
126
if not self.repository._format.supports_external_lookups:
127
raise errors.UnstackableRepositoryFormat(self.repository._format,
128
self.repository.base)
131
def open(base, _unsupported=False, possible_transports=None):
132
"""Open the branch rooted at base.
134
For instance, if the branch is at URL/.bzr/branch,
135
Branch.open(URL) -> a Branch instance.
137
control = bzrdir.BzrDir.open(base, _unsupported,
138
possible_transports=possible_transports)
139
return control.open_branch(_unsupported)
142
def open_from_transport(transport, _unsupported=False):
143
"""Open the branch rooted at transport"""
144
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
145
return control.open_branch(_unsupported)
148
def open_containing(url, possible_transports=None):
149
"""Open an existing branch which contains url.
151
This probes for a branch at url, and searches upwards from there.
153
Basically we keep looking up until we find the control directory or
154
run into the root. If there isn't one, raises NotBranchError.
155
If there is one and it is either an unrecognised format or an unsupported
156
format, UnknownFormatError or UnsupportedFormatError are raised.
157
If there is one, it is returned, along with the unused portion of url.
159
control, relpath = bzrdir.BzrDir.open_containing(url,
161
return control.open_branch(), relpath
163
def _push_should_merge_tags(self):
164
"""Should _basic_push merge this branch's tags into the target?
166
The default implementation returns False if this branch has no tags,
167
and True the rest of the time. Subclasses may override this.
169
return self.supports_tags() and self.tags.get_tag_dict()
171
def get_config(self):
172
return BranchConfig(self)
174
def _get_config(self):
175
"""Get the concrete config for just the config in this branch.
177
This is not intended for client use; see Branch.get_config for the
182
:return: An object supporting get_option and set_option.
184
raise NotImplementedError(self._get_config)
186
def _get_fallback_repository(self, url):
187
"""Get the repository we fallback to at url."""
188
url = urlutils.join(self.base, url)
189
a_bzrdir = bzrdir.BzrDir.open(url,
190
possible_transports=[self.bzrdir.root_transport])
191
return a_bzrdir.open_branch().repository
193
def _get_tags_bytes(self):
194
"""Get the bytes of a serialised tags dict.
196
Note that not all branches support tags, nor do all use the same tags
197
logic: this method is specific to BasicTags. Other tag implementations
198
may use the same method name and behave differently, safely, because
199
of the double-dispatch via
200
format.make_tags->tags_instance->get_tags_dict.
202
:return: The bytes of the tags file.
203
:seealso: Branch._set_tags_bytes.
205
return self._transport.get_bytes('tags')
207
def _get_nick(self, local=False, possible_transports=None):
208
config = self.get_config()
209
# explicit overrides master, but don't look for master if local is True
210
if not local and not config.has_explicit_nickname():
212
master = self.get_master_branch(possible_transports)
213
if master is not None:
214
# return the master branch value
216
except errors.BzrError, e:
217
# Silently fall back to local implicit nick if the master is
219
mutter("Could not connect to bound branch, "
220
"falling back to local nick.\n " + str(e))
221
return config.get_nickname()
223
def _set_nick(self, nick):
224
self.get_config().set_user_option('nickname', nick, warn_masked=True)
226
nick = property(_get_nick, _set_nick)
229
raise NotImplementedError(self.is_locked)
231
def _lefthand_history(self, revision_id, last_rev=None,
233
if 'evil' in debug.debug_flags:
234
mutter_callsite(4, "_lefthand_history scales with history.")
235
# stop_revision must be a descendant of last_revision
236
graph = self.repository.get_graph()
237
if last_rev is not None:
238
if not graph.is_ancestor(last_rev, revision_id):
239
# our previous tip is not merged into stop_revision
240
raise errors.DivergedBranches(self, other_branch)
241
# make a new revision history from the graph
242
parents_map = graph.get_parent_map([revision_id])
243
if revision_id not in parents_map:
244
raise errors.NoSuchRevision(self, revision_id)
245
current_rev_id = revision_id
247
check_not_reserved_id = _mod_revision.check_not_reserved_id
248
# Do not include ghosts or graph origin in revision_history
249
while (current_rev_id in parents_map and
250
len(parents_map[current_rev_id]) > 0):
251
check_not_reserved_id(current_rev_id)
252
new_history.append(current_rev_id)
253
current_rev_id = parents_map[current_rev_id][0]
254
parents_map = graph.get_parent_map([current_rev_id])
255
new_history.reverse()
212
258
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'
259
raise NotImplementedError(self.lock_write)
228
261
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'
262
raise NotImplementedError(self.lock_read)
242
264
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
265
raise NotImplementedError(self.unlock)
267
def peek_lock_mode(self):
268
"""Return lock mode for the Branch: 'r', 'w' or None"""
269
raise NotImplementedError(self.peek_lock_mode)
271
def get_physical_lock_status(self):
272
raise NotImplementedError(self.get_physical_lock_status)
275
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
276
"""Return the revision_id for a dotted revno.
278
:param revno: a tuple like (1,) or (1,1,2)
279
:param _cache_reverse: a private parameter enabling storage
280
of the reverse mapping in a top level cache. (This should
281
only be done in selective circumstances as we want to
282
avoid having the mapping cached multiple times.)
283
:return: the revision_id
284
:raises errors.NoSuchRevision: if the revno doesn't exist
286
rev_id = self._do_dotted_revno_to_revision_id(revno)
288
self._partial_revision_id_to_revno_cache[rev_id] = revno
291
def _do_dotted_revno_to_revision_id(self, revno):
292
"""Worker function for dotted_revno_to_revision_id.
294
Subclasses should override this if they wish to
295
provide a more efficient implementation.
298
return self.get_rev_id(revno[0])
299
revision_id_to_revno = self.get_revision_id_to_revno_map()
300
revision_ids = [revision_id for revision_id, this_revno
301
in revision_id_to_revno.iteritems()
302
if revno == this_revno]
303
if len(revision_ids) == 1:
304
return revision_ids[0]
306
revno_str = '.'.join(map(str, revno))
307
raise errors.NoSuchRevision(self, revno_str)
310
def revision_id_to_dotted_revno(self, revision_id):
311
"""Given a revision id, return its dotted revno.
313
:return: a tuple like (1,) or (400,1,3).
315
return self._do_revision_id_to_dotted_revno(revision_id)
317
def _do_revision_id_to_dotted_revno(self, revision_id):
318
"""Worker function for revision_id_to_revno."""
319
# Try the caches if they are loaded
320
result = self._partial_revision_id_to_revno_cache.get(revision_id)
321
if result is not None:
323
if self._revision_id_to_revno_cache:
324
result = self._revision_id_to_revno_cache.get(revision_id)
326
raise errors.NoSuchRevision(self, revision_id)
327
# Try the mainline as it's optimised
329
revno = self.revision_id_to_revno(revision_id)
331
except errors.NoSuchRevision:
332
# We need to load and use the full revno map after all
333
result = self.get_revision_id_to_revno_map().get(revision_id)
335
raise errors.NoSuchRevision(self, revision_id)
339
def get_revision_id_to_revno_map(self):
340
"""Return the revision_id => dotted revno map.
342
This will be regenerated on demand, but will be cached.
344
:return: A dictionary mapping revision_id => dotted revno.
345
This dictionary should not be modified by the caller.
347
if self._revision_id_to_revno_cache is not None:
348
mapping = self._revision_id_to_revno_cache
350
mapping = self._gen_revno_map()
351
self._cache_revision_id_to_revno(mapping)
352
# TODO: jam 20070417 Since this is being cached, should we be returning
354
# I would rather not, and instead just declare that users should not
355
# modify the return value.
358
def _gen_revno_map(self):
359
"""Create a new mapping from revision ids to dotted revnos.
361
Dotted revnos are generated based on the current tip in the revision
363
This is the worker function for get_revision_id_to_revno_map, which
364
just caches the return value.
366
:return: A dictionary mapping revision_id => dotted revno.
368
revision_id_to_revno = dict((rev_id, revno)
369
for rev_id, depth, revno, end_of_merge
370
in self.iter_merge_sorted_revisions())
371
return revision_id_to_revno
374
def iter_merge_sorted_revisions(self, start_revision_id=None,
375
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
376
"""Walk the revisions for a branch in merge sorted order.
378
Merge sorted order is the output from a merge-aware,
379
topological sort, i.e. all parents come before their
380
children going forward; the opposite for reverse.
382
:param start_revision_id: the revision_id to begin walking from.
383
If None, the branch tip is used.
384
:param stop_revision_id: the revision_id to terminate the walk
385
after. If None, the rest of history is included.
386
:param stop_rule: if stop_revision_id is not None, the precise rule
387
to use for termination:
388
* 'exclude' - leave the stop revision out of the result (default)
389
* 'include' - the stop revision is the last item in the result
390
* 'with-merges' - include the stop revision and all of its
391
merged revisions in the result
392
:param direction: either 'reverse' or 'forward':
393
* reverse means return the start_revision_id first, i.e.
394
start at the most recent revision and go backwards in history
395
* forward returns tuples in the opposite order to reverse.
396
Note in particular that forward does *not* do any intelligent
397
ordering w.r.t. depth as some clients of this API may like.
398
(If required, that ought to be done at higher layers.)
400
:return: an iterator over (revision_id, depth, revno, end_of_merge)
403
* revision_id: the unique id of the revision
404
* depth: How many levels of merging deep this node has been
406
* revno_sequence: This field provides a sequence of
407
revision numbers for all revisions. The format is:
408
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
409
branch that the revno is on. From left to right the REVNO numbers
410
are the sequence numbers within that branch of the revision.
411
* end_of_merge: When True the next node (earlier in history) is
412
part of a different merge.
414
# Note: depth and revno values are in the context of the branch so
415
# we need the full graph to get stable numbers, regardless of the
417
if self._merge_sorted_revisions_cache is None:
418
last_revision = self.last_revision()
419
graph = self.repository.get_graph()
420
parent_map = dict(((key, value) for key, value in
421
graph.iter_ancestry([last_revision]) if value is not None))
422
revision_graph = repository._strip_NULL_ghosts(parent_map)
423
revs = tsort.merge_sort(revision_graph, last_revision, None,
425
# Drop the sequence # before caching
426
self._merge_sorted_revisions_cache = [r[1:] for r in revs]
428
filtered = self._filter_merge_sorted_revisions(
429
self._merge_sorted_revisions_cache, start_revision_id,
430
stop_revision_id, stop_rule)
431
if direction == 'reverse':
433
if direction == 'forward':
434
return reversed(list(filtered))
436
raise ValueError('invalid direction %r' % direction)
438
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
439
start_revision_id, stop_revision_id, stop_rule):
440
"""Iterate over an inclusive range of sorted revisions."""
441
rev_iter = iter(merge_sorted_revisions)
442
if start_revision_id is not None:
443
for rev_id, depth, revno, end_of_merge in rev_iter:
444
if rev_id != start_revision_id:
447
# The decision to include the start or not
448
# depends on the stop_rule if a stop is provided
450
iter([(rev_id, depth, revno, end_of_merge)]),
453
if stop_revision_id is None:
454
for rev_id, depth, revno, end_of_merge in rev_iter:
455
yield rev_id, depth, revno, end_of_merge
456
elif stop_rule == 'exclude':
457
for rev_id, depth, revno, end_of_merge in rev_iter:
458
if rev_id == stop_revision_id:
460
yield rev_id, depth, revno, end_of_merge
461
elif stop_rule == 'include':
462
for rev_id, depth, revno, end_of_merge in rev_iter:
463
yield rev_id, depth, revno, end_of_merge
464
if rev_id == stop_revision_id:
466
elif stop_rule == 'with-merges':
467
stop_rev = self.repository.get_revision(stop_revision_id)
468
if stop_rev.parent_ids:
469
left_parent = stop_rev.parent_ids[0]
471
left_parent = _mod_revision.NULL_REVISION
472
for rev_id, depth, revno, end_of_merge in rev_iter:
473
if rev_id == left_parent:
475
yield rev_id, depth, revno, end_of_merge
477
raise ValueError('invalid stop_rule %r' % stop_rule)
479
def leave_lock_in_place(self):
480
"""Tell this branch object not to release the physical lock when this
483
If lock_write doesn't return a token, then this method is not supported.
485
self.control_files.leave_in_place()
487
def dont_leave_lock_in_place(self):
488
"""Tell this branch object to release the physical lock when this
489
object is unlocked, even if it didn't originally acquire it.
491
If lock_write doesn't return a token, then this method is not supported.
493
self.control_files.dont_leave_in_place()
495
def bind(self, other):
496
"""Bind the local branch the other branch.
498
:param other: The branch to bind to
501
raise errors.UpgradeRequired(self.base)
504
def fetch(self, from_branch, last_revision=None, pb=None):
505
"""Copy revisions from from_branch into this branch.
507
:param from_branch: Where to copy from.
508
:param last_revision: What revision to stop at (None for at the end
510
:param pb: An optional progress bar to use.
513
if self.base == from_branch.base:
516
symbol_versioning.warn(
517
symbol_versioning.deprecated_in((1, 14, 0))
518
% "pb parameter to fetch()")
519
from_branch.lock_read()
521
if last_revision is None:
522
last_revision = from_branch.last_revision()
523
last_revision = _mod_revision.ensure_null(last_revision)
524
return self.repository.fetch(from_branch.repository,
525
revision_id=last_revision,
530
def get_bound_location(self):
531
"""Return the URL of the branch we are bound to.
533
Older format branches cannot bind, please be sure to use a metadir
538
def get_old_bound_location(self):
539
"""Return the URL of the branch we used to be bound to
541
raise errors.UpgradeRequired(self.base)
543
def get_commit_builder(self, parents, config=None, timestamp=None,
544
timezone=None, committer=None, revprops=None,
546
"""Obtain a CommitBuilder for this branch.
548
:param parents: Revision ids of the parents of the new revision.
549
:param config: Optional configuration to use.
550
:param timestamp: Optional timestamp recorded for commit.
551
:param timezone: Optional timezone for timestamp.
552
:param committer: Optional committer to set for commit.
553
:param revprops: Optional dictionary of revision properties.
554
:param revision_id: Optional revision id.
558
config = self.get_config()
560
return self.repository.get_commit_builder(self, parents, config,
561
timestamp, timezone, committer, revprops, revision_id)
563
def get_master_branch(self, possible_transports=None):
564
"""Return the branch we are bound to.
566
:return: Either a Branch, or None
617
570
def get_revision_delta(self, revno):
618
571
"""Return the delta for one revision.
789
776
common_index = min(self_len, other_len) -1
790
777
if common_index >= 0 and \
791
778
self_history[common_index] != other_history[common_index]:
792
raise DivergedBranches(self, other)
779
raise errors.DivergedBranches(self, other)
794
781
if stop_revision is None:
795
782
stop_revision = other_len
796
elif stop_revision > other_len:
797
raise NoSuchRevision(self, stop_revision)
784
if stop_revision > other_len:
785
raise errors.NoSuchRevision(self, stop_revision)
799
786
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)
789
def update_revisions(self, other, stop_revision=None, overwrite=False,
791
"""Pull in new perfect-fit revisions.
793
:param other: Another Branch to pull from
794
:param stop_revision: Updated until the given revision
795
:param overwrite: Always set the branch pointer, rather than checking
796
to see if it is a proper descendant.
797
:param graph: A Graph object that can be used to query history
798
information. This can be None.
801
return InterBranch.get(other, self).update_revisions(stop_revision,
804
def import_last_revision_info(self, source_repo, revno, revid):
805
"""Set the last revision info, importing from another repo if necessary.
807
This is used by the bound branch code to upload a revision to
808
the master branch first before updating the tip of the local branch.
810
:param source_repo: Source repository to optionally fetch from
811
:param revno: Revision number of the new tip
812
:param revid: Revision id of the new tip
814
if not self.repository.has_same_location(source_repo):
815
self.repository.fetch(source_repo, revision_id=revid)
816
self.set_last_revision_info(revno, revid)
818
def revision_id_to_revno(self, revision_id):
819
"""Given a revision id, return its revno"""
820
if _mod_revision.is_null(revision_id):
822
history = self.revision_history()
824
return history.index(revision_id) + 1
893
825
except ValueError:
826
raise errors.NoSuchRevision(self, revision_id)
828
def get_rev_id(self, revno, history=None):
829
"""Find the revision id of the specified revno."""
831
return _mod_revision.NULL_REVISION
833
history = self.revision_history()
834
if revno <= 0 or revno > len(history):
835
raise errors.NoSuchRevision(self, revno)
836
return history[revno - 1]
838
def pull(self, source, overwrite=False, stop_revision=None,
839
possible_transports=None, _override_hook_target=None):
840
"""Mirror source into this branch.
842
This branch is considered to be 'local', having low latency.
844
:returns: PullResult instance
846
raise NotImplementedError(self.pull)
848
def push(self, target, overwrite=False, stop_revision=None):
849
"""Mirror this branch into target.
851
This branch is considered to be 'local', having low latency.
853
raise NotImplementedError(self.push)
855
def basis_tree(self):
856
"""Return `Tree` object for last revision."""
857
return self.repository.revision_tree(self.last_revision())
859
def get_parent(self):
860
"""Return the parent location of the branch.
862
This is the default location for pull/missing. The usual
863
pattern is that the user can override it by specifying a
866
parent = self._get_parent_location()
869
# This is an old-format absolute path to a local branch
871
if parent.startswith('/'):
872
parent = urlutils.local_path_to_url(parent.decode('utf8'))
874
return urlutils.join(self.base[:-1], parent)
875
except errors.InvalidURLJoin, e:
876
raise errors.InaccessibleParent(parent, self.base)
878
def _get_parent_location(self):
879
raise NotImplementedError(self._get_parent_location)
881
def _set_config_location(self, name, url, config=None,
882
make_relative=False):
884
config = self.get_config()
888
url = urlutils.relative_url(self.base, url)
889
config.set_user_option(name, url, warn_masked=True)
891
def _get_config_location(self, name, config=None):
893
config = self.get_config()
894
location = config.get_user_option(name)
899
def get_submit_branch(self):
900
"""Return the submit location of the branch.
902
This is the default location for bundle. The usual
903
pattern is that the user can override it by specifying a
906
return self.get_config().get_user_option('submit_branch')
908
def set_submit_branch(self, location):
909
"""Return the submit location of the branch.
911
This is the default location for bundle. The usual
912
pattern is that the user can override it by specifying a
915
self.get_config().set_user_option('submit_branch', location,
918
def get_public_branch(self):
919
"""Return the public location of the branch.
921
This is used by merge directives.
923
return self._get_config_location('public_branch')
925
def set_public_branch(self, location):
926
"""Return the submit location of the branch.
928
This is the default location for bundle. The usual
929
pattern is that the user can override it by specifying a
932
self._set_config_location('public_branch', location)
934
def get_push_location(self):
935
"""Return the None or the location to push this branch to."""
936
push_loc = self.get_config().get_user_option('push_location')
939
def set_push_location(self, location):
940
"""Set a new push location for this branch."""
941
raise NotImplementedError(self.set_push_location)
943
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
944
"""Run the post_change_branch_tip hooks."""
945
hooks = Branch.hooks['post_change_branch_tip']
948
new_revno, new_revid = self.last_revision_info()
949
params = ChangeBranchTipParams(
950
self, old_revno, new_revno, old_revid, new_revid)
954
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
955
"""Run the pre_change_branch_tip hooks."""
956
hooks = Branch.hooks['pre_change_branch_tip']
959
old_revno, old_revid = self.last_revision_info()
960
params = ChangeBranchTipParams(
961
self, old_revno, new_revno, old_revid, new_revid)
965
except errors.TipChangeRejected:
968
exc_info = sys.exc_info()
969
hook_name = Branch.hooks.get_hook_name(hook)
970
raise errors.HookFailed(
971
'pre_change_branch_tip', hook_name, exc_info)
975
"""Synchronise this branch with the master branch if any.
977
:return: None or the last_revision pivoted out during the update.
981
def check_revno(self, revno):
983
Check whether a revno corresponds to any revision.
984
Zero (the NULL revision) is considered valid.
987
self.check_real_revno(revno)
989
def check_real_revno(self, revno):
991
Check whether a revno corresponds to a real revision.
992
Zero (the NULL revision) is considered invalid
994
if revno < 1 or revno > self.revno():
995
raise errors.InvalidRevisionNumber(revno)
998
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
999
"""Clone this branch into to_bzrdir preserving all semantic values.
1001
Most API users will want 'create_clone_on_transport', which creates a
1002
new bzrdir and branch on the fly.
1004
revision_id: if not None, the revision history in the new branch will
1005
be truncated to end with revision_id.
1007
result = to_bzrdir.create_branch()
1010
if repository_policy is not None:
1011
repository_policy.configure_branch(result)
1012
self.copy_content_into(result, revision_id=revision_id)
1018
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
1019
"""Create a new line of development from the branch, into to_bzrdir.
1021
to_bzrdir controls the branch format.
1023
revision_id: if not None, the revision history in the new branch will
1024
be truncated to end with revision_id.
1026
result = to_bzrdir.create_branch()
1029
if repository_policy is not None:
1030
repository_policy.configure_branch(result)
1031
self.copy_content_into(result, revision_id=revision_id)
1032
result.set_parent(self.bzrdir.root_transport.base)
1037
def _synchronize_history(self, destination, revision_id):
1038
"""Synchronize last revision and revision history between branches.
1040
This version is most efficient when the destination is also a
1041
BzrBranch6, but works for BzrBranch5, as long as the destination's
1042
repository contains all the lefthand ancestors of the intended
1043
last_revision. If not, set_last_revision_info will fail.
1045
:param destination: The branch to copy the history into
1046
:param revision_id: The revision-id to truncate history at. May
1047
be None to copy complete history.
1049
source_revno, source_revision_id = self.last_revision_info()
1050
if revision_id is None:
1051
revno, revision_id = source_revno, source_revision_id
1052
elif source_revision_id == revision_id:
1053
# we know the revno without needing to walk all of history
1054
revno = source_revno
1056
# To figure out the revno for a random revision, we need to build
1057
# the revision history, and count its length.
1058
# We don't care about the order, just how long it is.
1059
# Alternatively, we could start at the current location, and count
1060
# backwards. But there is no guarantee that we will find it since
1061
# it may be a merged revision.
1062
revno = len(list(self.repository.iter_reverse_revision_history(
1064
destination.set_last_revision_info(revno, revision_id)
1067
def copy_content_into(self, destination, revision_id=None):
1068
"""Copy the content of self into destination.
1070
revision_id: if not None, the revision history in the new branch will
1071
be truncated to end with revision_id.
1073
self._synchronize_history(destination, revision_id)
1075
parent = self.get_parent()
1076
except errors.InaccessibleParent, e:
1077
mutter('parent was not accessible to copy: %s', e)
1080
destination.set_parent(parent)
1081
if self._push_should_merge_tags():
1082
self.tags.merge_to(destination.tags)
1086
"""Check consistency of the branch.
1088
In particular this checks that revisions given in the revision-history
1089
do actually match up in the revision graph, and that they're all
1090
present in the repository.
1092
Callers will typically also want to check the repository.
1094
:return: A BranchCheckResult.
1096
mainline_parent_id = None
1097
last_revno, last_revision_id = self.last_revision_info()
1098
real_rev_history = list(self.repository.iter_reverse_revision_history(
1100
real_rev_history.reverse()
1101
if len(real_rev_history) != last_revno:
1102
raise errors.BzrCheckError('revno does not match len(mainline)'
1103
' %s != %s' % (last_revno, len(real_rev_history)))
1104
# TODO: We should probably also check that real_rev_history actually
1105
# matches self.revision_history()
1106
for revision_id in real_rev_history:
1108
revision = self.repository.get_revision(revision_id)
1109
except errors.NoSuchRevision, e:
1110
raise errors.BzrCheckError("mainline revision {%s} not in repository"
1112
# In general the first entry on the revision history has no parents.
1113
# But it's not illegal for it to have parents listed; this can happen
1114
# in imports from Arch when the parents weren't reachable.
1115
if mainline_parent_id is not None:
1116
if mainline_parent_id not in revision.parent_ids:
1117
raise errors.BzrCheckError("previous revision {%s} not listed among "
1119
% (mainline_parent_id, revision_id))
1120
mainline_parent_id = revision_id
1121
return BranchCheckResult(self)
1123
def _get_checkout_format(self):
1124
"""Return the most suitable metadir for a checkout of this branch.
1125
Weaves are used if this branch's repository uses weaves.
1127
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1128
from bzrlib.repofmt import weaverepo
1129
format = bzrdir.BzrDirMetaFormat1()
1130
format.repository_format = weaverepo.RepositoryFormat7()
1132
format = self.repository.bzrdir.checkout_metadir()
1133
format.set_branch_format(self._format)
1136
def create_clone_on_transport(self, to_transport, revision_id=None,
1138
"""Create a clone of this branch and its bzrdir.
1140
:param to_transport: The transport to clone onto.
1141
:param revision_id: The revision id to use as tip in the new branch.
1142
If None the tip is obtained from this branch.
1143
:param stacked_on: An optional URL to stack the clone on.
1145
# XXX: Fix the bzrdir API to allow getting the branch back from the
1146
# clone call. Or something. 20090224 RBC/spiv.
1147
dir_to = self.bzrdir.clone_on_transport(to_transport,
1148
revision_id=revision_id, stacked_on=stacked_on)
1149
return dir_to.open_branch()
1151
def create_checkout(self, to_location, revision_id=None,
1152
lightweight=False, accelerator_tree=None,
1154
"""Create a checkout of a branch.
1156
:param to_location: The url to produce the checkout at
1157
:param revision_id: The revision to check out
1158
:param lightweight: If True, produce a lightweight checkout, otherwise,
1159
produce a bound branch (heavyweight checkout)
1160
:param accelerator_tree: A tree which can be used for retrieving file
1161
contents more quickly than the revision tree, i.e. a workingtree.
1162
The revision tree will be used for cases where accelerator_tree's
1163
content is different.
1164
:param hardlink: If true, hard-link files from accelerator_tree,
1166
:return: The tree of the created checkout
1168
t = transport.get_transport(to_location)
1171
format = self._get_checkout_format()
1172
checkout = format.initialize_on_transport(t)
1173
from_branch = BranchReferenceFormat().initialize(checkout, self)
1175
format = self._get_checkout_format()
1176
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1177
to_location, force_new_tree=False, format=format)
1178
checkout = checkout_branch.bzrdir
1179
checkout_branch.bind(self)
1180
# pull up to the specified revision_id to set the initial
1181
# branch tip correctly, and seed it with history.
1182
checkout_branch.pull(self, stop_revision=revision_id)
1184
tree = checkout.create_workingtree(revision_id,
1185
from_branch=from_branch,
1186
accelerator_tree=accelerator_tree,
1188
basis_tree = tree.basis_tree()
1189
basis_tree.lock_read()
1191
for path, file_id in basis_tree.iter_references():
1192
reference_parent = self.reference_parent(file_id, path)
1193
reference_parent.create_checkout(tree.abspath(path),
1194
basis_tree.get_reference_revision(file_id, path),
1201
def reconcile(self, thorough=True):
1202
"""Make sure the data stored in this branch is consistent."""
1203
from bzrlib.reconcile import BranchReconciler
1204
reconciler = BranchReconciler(self, thorough=thorough)
1205
reconciler.reconcile()
1208
def reference_parent(self, file_id, path):
1209
"""Return the parent branch for a tree-reference file_id
1210
:param file_id: The file_id of the tree reference
1211
:param path: The path of the file_id in the tree
1212
:return: A branch associated with the file_id
1214
# FIXME should provide multiple branches, based on config
1215
return Branch.open(self.bzrdir.root_transport.clone(path).base)
1217
def supports_tags(self):
1218
return self._format.supports_tags()
1220
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1222
"""Ensure that revision_b is a descendant of revision_a.
1224
This is a helper function for update_revisions.
1226
:raises: DivergedBranches if revision_b has diverged from revision_a.
1227
:returns: True if revision_b is a descendant of revision_a.
1229
relation = self._revision_relations(revision_a, revision_b, graph)
1230
if relation == 'b_descends_from_a':
1232
elif relation == 'diverged':
1233
raise errors.DivergedBranches(self, other_branch)
1234
elif relation == 'a_descends_from_b':
1237
raise AssertionError("invalid relation: %r" % (relation,))
1239
def _revision_relations(self, revision_a, revision_b, graph):
1240
"""Determine the relationship between two revisions.
1242
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1244
heads = graph.heads([revision_a, revision_b])
1245
if heads == set([revision_b]):
1246
return 'b_descends_from_a'
1247
elif heads == set([revision_a, revision_b]):
1248
# These branches have diverged
1250
elif heads == set([revision_a]):
1251
return 'a_descends_from_b'
1253
raise AssertionError("invalid heads: %r" % (heads,))
1256
class BranchFormat(object):
1257
"""An encapsulation of the initialization and open routines for a format.
1259
Formats provide three things:
1260
* An initialization routine,
1264
Formats are placed in an dict by their format string for reference
1265
during branch opening. Its not required that these be instances, they
1266
can be classes themselves with class methods - it simply depends on
1267
whether state is needed for a given format or not.
1269
Once a format is deprecated, just deprecate the initialize and open
1270
methods on the format class. Do not deprecate the object, as the
1271
object will be created every time regardless.
1274
_default_format = None
1275
"""The default format used for new branches."""
1278
"""The known formats."""
1280
def __eq__(self, other):
1281
return self.__class__ is other.__class__
1283
def __ne__(self, other):
1284
return not (self == other)
1287
def find_format(klass, a_bzrdir):
1288
"""Return the format for the branch object in a_bzrdir."""
1290
transport = a_bzrdir.get_branch_transport(None)
1291
format_string = transport.get("format").read()
1292
return klass._formats[format_string]
1293
except errors.NoSuchFile:
1294
raise errors.NotBranchError(path=transport.base)
1296
raise errors.UnknownFormatError(format=format_string, kind='branch')
1299
def get_default_format(klass):
1300
"""Return the current default format."""
1301
return klass._default_format
1303
def get_reference(self, a_bzrdir):
1304
"""Get the target reference of the branch in a_bzrdir.
1306
format probing must have been completed before calling
1307
this method - it is assumed that the format of the branch
1308
in a_bzrdir is correct.
1310
:param a_bzrdir: The bzrdir to get the branch data from.
1311
:return: None if the branch is not a reference branch.
1316
def set_reference(self, a_bzrdir, to_branch):
1317
"""Set the target reference of the branch in a_bzrdir.
1319
format probing must have been completed before calling
1320
this method - it is assumed that the format of the branch
1321
in a_bzrdir is correct.
1323
:param a_bzrdir: The bzrdir to set the branch reference for.
1324
:param to_branch: branch that the checkout is to reference
1326
raise NotImplementedError(self.set_reference)
1328
def get_format_string(self):
1329
"""Return the ASCII format string that identifies this format."""
1330
raise NotImplementedError(self.get_format_string)
1332
def get_format_description(self):
1333
"""Return the short format description for this format."""
1334
raise NotImplementedError(self.get_format_description)
1336
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
1338
"""Initialize a branch in a bzrdir, with specified files
1340
:param a_bzrdir: The bzrdir to initialize the branch in
1341
:param utf8_files: The files to create as a list of
1342
(filename, content) tuples
1343
:param set_format: If True, set the format with
1344
self.get_format_string. (BzrBranch4 has its format set
1346
:return: a branch in this format
1348
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1349
branch_transport = a_bzrdir.get_branch_transport(self)
1351
'metadir': ('lock', lockdir.LockDir),
1352
'branch4': ('branch-lock', lockable_files.TransportLock),
1354
lock_name, lock_class = lock_map[lock_type]
1355
control_files = lockable_files.LockableFiles(branch_transport,
1356
lock_name, lock_class)
1357
control_files.create_lock()
1358
control_files.lock_write()
1360
utf8_files += [('format', self.get_format_string())]
1362
for (filename, content) in utf8_files:
1363
branch_transport.put_bytes(
1365
mode=a_bzrdir._get_file_mode())
1367
control_files.unlock()
1368
return self.open(a_bzrdir, _found=True)
1370
def initialize(self, a_bzrdir):
1371
"""Create a branch of this format in a_bzrdir."""
1372
raise NotImplementedError(self.initialize)
1374
def is_supported(self):
1375
"""Is this format supported?
1377
Supported formats can be initialized and opened.
1378
Unsupported formats may not support initialization or committing or
1379
some other features depending on the reason for not being supported.
1383
def make_tags(self, branch):
1384
"""Create a tags object for branch.
1386
This method is on BranchFormat, because BranchFormats are reflected
1387
over the wire via network_name(), whereas full Branch instances require
1388
multiple VFS method calls to operate at all.
1390
The default implementation returns a disabled-tags instance.
1392
Note that it is normal for branch to be a RemoteBranch when using tags
1395
return DisabledTags(branch)
1397
def network_name(self):
1398
"""A simple byte string uniquely identifying this format for RPC calls.
1400
MetaDir branch formats use their disk format string to identify the
1401
repository over the wire. All in one formats such as bzr < 0.8, and
1402
foreign formats like svn/git and hg should use some marker which is
1403
unique and immutable.
1405
raise NotImplementedError(self.network_name)
1407
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1408
"""Return the branch object for a_bzrdir
1410
:param a_bzrdir: A BzrDir that contains a branch.
1411
:param _found: a private parameter, do not use it. It is used to
1412
indicate if format probing has already be done.
1413
:param ignore_fallbacks: when set, no fallback branches will be opened
1414
(if there are any). Default is to open fallbacks.
1416
raise NotImplementedError(self.open)
1419
def register_format(klass, format):
1420
"""Register a metadir format."""
1421
klass._formats[format.get_format_string()] = format
1422
# Metadir formats have a network name of their format string, and get
1423
# registered as class factories.
1424
network_format_registry.register(format.get_format_string(), format.__class__)
1427
def set_default_format(klass, format):
1428
klass._default_format = format
1430
def supports_stacking(self):
1431
"""True if this format records a stacked-on branch."""
1435
def unregister_format(klass, format):
1436
del klass._formats[format.get_format_string()]
1439
return self.get_format_description().rstrip()
1441
def supports_tags(self):
1442
"""True if this format supports tags stored in the branch"""
1443
return False # by default
1446
class BranchHooks(Hooks):
1447
"""A dictionary mapping hook name to a list of callables for branch hooks.
1449
e.g. ['set_rh'] Is the list of items to be called when the
1450
set_revision_history function is invoked.
1454
"""Create the default hooks.
1456
These are all empty initially, because by default nothing should get
1459
Hooks.__init__(self)
1460
self.create_hook(HookPoint('set_rh',
1461
"Invoked whenever the revision history has been set via "
1462
"set_revision_history. The api signature is (branch, "
1463
"revision_history), and the branch will be write-locked. "
1464
"The set_rh hook can be expensive for bzr to trigger, a better "
1465
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1466
self.create_hook(HookPoint('open',
1467
"Called with the Branch object that has been opened after a "
1468
"branch is opened.", (1, 8), None))
1469
self.create_hook(HookPoint('post_push',
1470
"Called after a push operation completes. post_push is called "
1471
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1472
"bzr client.", (0, 15), None))
1473
self.create_hook(HookPoint('post_pull',
1474
"Called after a pull operation completes. post_pull is called "
1475
"with a bzrlib.branch.PullResult object and only runs in the "
1476
"bzr client.", (0, 15), None))
1477
self.create_hook(HookPoint('pre_commit',
1478
"Called after a commit is calculated but before it is is "
1479
"completed. pre_commit is called with (local, master, old_revno, "
1480
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1481
"). old_revid is NULL_REVISION for the first commit to a branch, "
1482
"tree_delta is a TreeDelta object describing changes from the "
1483
"basis revision. hooks MUST NOT modify this delta. "
1484
" future_tree is an in-memory tree obtained from "
1485
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1486
"tree.", (0,91), None))
1487
self.create_hook(HookPoint('post_commit',
1488
"Called in the bzr client after a commit has completed. "
1489
"post_commit is called with (local, master, old_revno, old_revid, "
1490
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1491
"commit to a branch.", (0, 15), None))
1492
self.create_hook(HookPoint('post_uncommit',
1493
"Called in the bzr client after an uncommit completes. "
1494
"post_uncommit is called with (local, master, old_revno, "
1495
"old_revid, new_revno, new_revid) where local is the local branch "
1496
"or None, master is the target branch, and an empty branch "
1497
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1498
self.create_hook(HookPoint('pre_change_branch_tip',
1499
"Called in bzr client and server before a change to the tip of a "
1500
"branch is made. pre_change_branch_tip is called with a "
1501
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1502
"commit, uncommit will all trigger this hook.", (1, 6), None))
1503
self.create_hook(HookPoint('post_change_branch_tip',
1504
"Called in bzr client and server after a change to the tip of a "
1505
"branch is made. post_change_branch_tip is called with a "
1506
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1507
"commit, uncommit will all trigger this hook.", (1, 4), None))
1508
self.create_hook(HookPoint('transform_fallback_location',
1509
"Called when a stacked branch is activating its fallback "
1510
"locations. transform_fallback_location is called with (branch, "
1511
"url), and should return a new url. Returning the same url "
1512
"allows it to be used as-is, returning a different one can be "
1513
"used to cause the branch to stack on a closer copy of that "
1514
"fallback_location. Note that the branch cannot have history "
1515
"accessing methods called on it during this hook because the "
1516
"fallback locations have not been activated. When there are "
1517
"multiple hooks installed for transform_fallback_location, "
1518
"all are called with the url returned from the previous hook."
1519
"The order is however undefined.", (1, 9), None))
1522
# install the default hooks into the Branch class.
1523
Branch.hooks = BranchHooks()
1526
class ChangeBranchTipParams(object):
1527
"""Object holding parameters passed to *_change_branch_tip hooks.
1529
There are 5 fields that hooks may wish to access:
1531
:ivar branch: the branch being changed
1532
:ivar old_revno: revision number before the change
1533
:ivar new_revno: revision number after the change
1534
:ivar old_revid: revision id before the change
1535
:ivar new_revid: revision id after the change
1537
The revid fields are strings. The revno fields are integers.
1540
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1541
"""Create a group of ChangeBranchTip parameters.
1543
:param branch: The branch being changed.
1544
:param old_revno: Revision number before the change.
1545
:param new_revno: Revision number after the change.
1546
:param old_revid: Tip revision id before the change.
1547
:param new_revid: Tip revision id after the change.
1549
self.branch = branch
1550
self.old_revno = old_revno
1551
self.new_revno = new_revno
1552
self.old_revid = old_revid
1553
self.new_revid = new_revid
1555
def __eq__(self, other):
1556
return self.__dict__ == other.__dict__
1559
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1560
self.__class__.__name__, self.branch,
1561
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1564
class BzrBranchFormat4(BranchFormat):
1565
"""Bzr branch format 4.
1568
- a revision-history file.
1569
- a branch-lock lock file [ to be shared with the bzrdir ]
1572
def get_format_description(self):
1573
"""See BranchFormat.get_format_description()."""
1574
return "Branch format 4"
1576
def initialize(self, a_bzrdir):
1577
"""Create a branch of this format in a_bzrdir."""
1578
utf8_files = [('revision-history', ''),
1579
('branch-name', ''),
1581
return self._initialize_helper(a_bzrdir, utf8_files,
1582
lock_type='branch4', set_format=False)
1585
super(BzrBranchFormat4, self).__init__()
1586
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1588
def network_name(self):
1589
"""The network name for this format is the control dirs disk label."""
1590
return self._matchingbzrdir.get_format_string()
1592
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1593
"""See BranchFormat.open()."""
1595
# we are being called directly and must probe.
1596
raise NotImplementedError
1597
return BzrBranch(_format=self,
1598
_control_files=a_bzrdir._control_files,
1600
_repository=a_bzrdir.open_repository())
1603
return "Bazaar-NG branch format 4"
1606
class BranchFormatMetadir(BranchFormat):
1607
"""Common logic for meta-dir based branch formats."""
1609
def _branch_class(self):
1610
"""What class to instantiate on open calls."""
1611
raise NotImplementedError(self._branch_class)
1613
def network_name(self):
1614
"""A simple byte string uniquely identifying this format for RPC calls.
1616
Metadir branch formats use their format string.
1618
return self.get_format_string()
1620
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1621
"""See BranchFormat.open()."""
1623
format = BranchFormat.find_format(a_bzrdir)
1624
if format.__class__ != self.__class__:
1625
raise AssertionError("wrong format %r found for %r" %
1628
transport = a_bzrdir.get_branch_transport(None)
1629
control_files = lockable_files.LockableFiles(transport, 'lock',
1631
return self._branch_class()(_format=self,
1632
_control_files=control_files,
1634
_repository=a_bzrdir.find_repository(),
1635
ignore_fallbacks=ignore_fallbacks)
1636
except errors.NoSuchFile:
1637
raise errors.NotBranchError(path=transport.base)
1640
super(BranchFormatMetadir, self).__init__()
1641
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1642
self._matchingbzrdir.set_branch_format(self)
1644
def supports_tags(self):
1648
class BzrBranchFormat5(BranchFormatMetadir):
1649
"""Bzr branch format 5.
1652
- a revision-history file.
1654
- a lock dir guarding the branch itself
1655
- all of this stored in a branch/ subdirectory
1656
- works with shared repositories.
1658
This format is new in bzr 0.8.
1661
def _branch_class(self):
1664
def get_format_string(self):
1665
"""See BranchFormat.get_format_string()."""
1666
return "Bazaar-NG branch format 5\n"
1668
def get_format_description(self):
1669
"""See BranchFormat.get_format_description()."""
1670
return "Branch format 5"
1672
def initialize(self, a_bzrdir):
1673
"""Create a branch of this format in a_bzrdir."""
1674
utf8_files = [('revision-history', ''),
1675
('branch-name', ''),
1677
return self._initialize_helper(a_bzrdir, utf8_files)
1679
def supports_tags(self):
1683
class BzrBranchFormat6(BranchFormatMetadir):
1684
"""Branch format with last-revision and tags.
1686
Unlike previous formats, this has no explicit revision history. Instead,
1687
this just stores the last-revision, and the left-hand history leading
1688
up to there is the history.
1690
This format was introduced in bzr 0.15
1691
and became the default in 0.91.
1694
def _branch_class(self):
1697
def get_format_string(self):
1698
"""See BranchFormat.get_format_string()."""
1699
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1701
def get_format_description(self):
1702
"""See BranchFormat.get_format_description()."""
1703
return "Branch format 6"
1705
def initialize(self, a_bzrdir):
1706
"""Create a branch of this format in a_bzrdir."""
1707
utf8_files = [('last-revision', '0 null:\n'),
1708
('branch.conf', ''),
1711
return self._initialize_helper(a_bzrdir, utf8_files)
1713
def make_tags(self, branch):
1714
"""See bzrlib.branch.BranchFormat.make_tags()."""
1715
return BasicTags(branch)
1719
class BzrBranchFormat7(BranchFormatMetadir):
1720
"""Branch format with last-revision, tags, and a stacked location pointer.
1722
The stacked location pointer is passed down to the repository and requires
1723
a repository format with supports_external_lookups = True.
1725
This format was introduced in bzr 1.6.
1728
def _branch_class(self):
1731
def get_format_string(self):
1732
"""See BranchFormat.get_format_string()."""
1733
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
1735
def get_format_description(self):
1736
"""See BranchFormat.get_format_description()."""
1737
return "Branch format 7"
1739
def initialize(self, a_bzrdir):
1740
"""Create a branch of this format in a_bzrdir."""
1741
utf8_files = [('last-revision', '0 null:\n'),
1742
('branch.conf', ''),
1745
return self._initialize_helper(a_bzrdir, utf8_files)
1748
super(BzrBranchFormat7, self).__init__()
1749
self._matchingbzrdir.repository_format = \
1750
RepositoryFormatKnitPack5RichRoot()
1752
def make_tags(self, branch):
1753
"""See bzrlib.branch.BranchFormat.make_tags()."""
1754
return BasicTags(branch)
1756
def supports_stacking(self):
1760
class BranchReferenceFormat(BranchFormat):
1761
"""Bzr branch reference format.
1763
Branch references are used in implementing checkouts, they
1764
act as an alias to the real branch which is at some other url.
1771
def get_format_string(self):
1772
"""See BranchFormat.get_format_string()."""
1773
return "Bazaar-NG Branch Reference Format 1\n"
1775
def get_format_description(self):
1776
"""See BranchFormat.get_format_description()."""
1777
return "Checkout reference format 1"
1779
def get_reference(self, a_bzrdir):
1780
"""See BranchFormat.get_reference()."""
1781
transport = a_bzrdir.get_branch_transport(None)
1782
return transport.get('location').read()
1784
def set_reference(self, a_bzrdir, to_branch):
1785
"""See BranchFormat.set_reference()."""
1786
transport = a_bzrdir.get_branch_transport(None)
1787
location = transport.put_bytes('location', to_branch.base)
1789
def initialize(self, a_bzrdir, target_branch=None):
1790
"""Create a branch of this format in a_bzrdir."""
1791
if target_branch is None:
1792
# this format does not implement branch itself, thus the implicit
1793
# creation contract must see it as uninitializable
1794
raise errors.UninitializableFormat(self)
1795
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1796
branch_transport = a_bzrdir.get_branch_transport(self)
1797
branch_transport.put_bytes('location',
1798
target_branch.bzrdir.root_transport.base)
1799
branch_transport.put_bytes('format', self.get_format_string())
1801
a_bzrdir, _found=True,
1802
possible_transports=[target_branch.bzrdir.root_transport])
1805
super(BranchReferenceFormat, self).__init__()
1806
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1807
self._matchingbzrdir.set_branch_format(self)
1809
def _make_reference_clone_function(format, a_branch):
1810
"""Create a clone() routine for a branch dynamically."""
1811
def clone(to_bzrdir, revision_id=None,
1812
repository_policy=None):
1813
"""See Branch.clone()."""
1814
return format.initialize(to_bzrdir, a_branch)
1815
# cannot obey revision_id limits when cloning a reference ...
1816
# FIXME RBC 20060210 either nuke revision_id for clone, or
1817
# emit some sort of warning/error to the caller ?!
1820
def open(self, a_bzrdir, _found=False, location=None,
1821
possible_transports=None, ignore_fallbacks=False):
1822
"""Return the branch that the branch reference in a_bzrdir points at.
1824
:param a_bzrdir: A BzrDir that contains a branch.
1825
:param _found: a private parameter, do not use it. It is used to
1826
indicate if format probing has already be done.
1827
:param ignore_fallbacks: when set, no fallback branches will be opened
1828
(if there are any). Default is to open fallbacks.
1829
:param location: The location of the referenced branch. If
1830
unspecified, this will be determined from the branch reference in
1832
:param possible_transports: An optional reusable transports list.
1835
format = BranchFormat.find_format(a_bzrdir)
1836
if format.__class__ != self.__class__:
1837
raise AssertionError("wrong format %r found for %r" %
1839
if location is None:
1840
location = self.get_reference(a_bzrdir)
1841
real_bzrdir = bzrdir.BzrDir.open(
1842
location, possible_transports=possible_transports)
1843
result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
1844
# this changes the behaviour of result.clone to create a new reference
1845
# rather than a copy of the content of the branch.
1846
# I did not use a proxy object because that needs much more extensive
1847
# testing, and we are only changing one behaviour at the moment.
1848
# If we decide to alter more behaviours - i.e. the implicit nickname
1849
# then this should be refactored to introduce a tested proxy branch
1850
# and a subclass of that for use in overriding clone() and ....
1852
result.clone = self._make_reference_clone_function(result)
1856
network_format_registry = registry.FormatRegistry()
1857
"""Registry of formats indexed by their network name.
1859
The network name for a branch format is an identifier that can be used when
1860
referring to formats with smart server operations. See
1861
BranchFormat.network_name() for more detail.
1865
# formats which have no format string are not discoverable
1866
# and not independently creatable, so are not registered.
1867
__format5 = BzrBranchFormat5()
1868
__format6 = BzrBranchFormat6()
1869
__format7 = BzrBranchFormat7()
1870
BranchFormat.register_format(__format5)
1871
BranchFormat.register_format(BranchReferenceFormat())
1872
BranchFormat.register_format(__format6)
1873
BranchFormat.register_format(__format7)
1874
BranchFormat.set_default_format(__format6)
1875
_legacy_formats = [BzrBranchFormat4(),
1877
network_format_registry.register(
1878
_legacy_formats[0].network_name(), _legacy_formats[0].__class__)
1881
class BzrBranch(Branch):
1882
"""A branch stored in the actual filesystem.
1884
Note that it's "local" in the context of the filesystem; it doesn't
1885
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1886
it's writable, and can be accessed via the normal filesystem API.
1888
:ivar _transport: Transport for file operations on this branch's
1889
control files, typically pointing to the .bzr/branch directory.
1890
:ivar repository: Repository for this branch.
1891
:ivar base: The url of the base directory for this branch; the one
1892
containing the .bzr directory.
1895
def __init__(self, _format=None,
1896
_control_files=None, a_bzrdir=None, _repository=None,
1897
ignore_fallbacks=False):
1898
"""Create new branch object at a particular location."""
1899
if a_bzrdir is None:
1900
raise ValueError('a_bzrdir must be supplied')
1902
self.bzrdir = a_bzrdir
1903
self._base = self.bzrdir.transport.clone('..').base
1904
# XXX: We should be able to just do
1905
# self.base = self.bzrdir.root_transport.base
1906
# but this does not quite work yet -- mbp 20080522
1907
self._format = _format
1908
if _control_files is None:
1909
raise ValueError('BzrBranch _control_files is None')
1910
self.control_files = _control_files
1911
self._transport = _control_files._transport
1912
self.repository = _repository
1913
Branch.__init__(self)
1916
return '%s(%r)' % (self.__class__.__name__, self.base)
1920
def _get_base(self):
1921
"""Returns the directory containing the control directory."""
1924
base = property(_get_base, doc="The URL for the root of this branch.")
1926
def _get_config(self):
1927
return TransportConfig(self._transport, 'branch.conf')
1929
def is_locked(self):
1930
return self.control_files.is_locked()
1932
def lock_write(self, token=None):
1933
# All-in-one needs to always unlock/lock.
1934
repo_control = getattr(self.repository, 'control_files', None)
1935
if self.control_files == repo_control or not self.is_locked():
1936
self.repository.lock_write()
1941
return self.control_files.lock_write(token=token)
1944
self.repository.unlock()
1947
def lock_read(self):
1948
# All-in-one needs to always unlock/lock.
1949
repo_control = getattr(self.repository, 'control_files', None)
1950
if self.control_files == repo_control or not self.is_locked():
1951
self.repository.lock_read()
1956
self.control_files.lock_read()
1959
self.repository.unlock()
1964
self.control_files.unlock()
1966
# All-in-one needs to always unlock/lock.
1967
repo_control = getattr(self.repository, 'control_files', None)
1968
if (self.control_files == repo_control or
1969
not self.control_files.is_locked()):
1970
self.repository.unlock()
1971
if not self.control_files.is_locked():
1972
# we just released the lock
1973
self._clear_cached_state()
1975
def peek_lock_mode(self):
1976
if self.control_files._lock_count == 0:
1979
return self.control_files._lock_mode
1981
def get_physical_lock_status(self):
1982
return self.control_files.get_physical_lock_status()
1985
def print_file(self, file, revision_id):
1986
"""See Branch.print_file."""
1987
return self.repository.print_file(file, revision_id)
1989
def _write_revision_history(self, history):
1990
"""Factored out of set_revision_history.
1992
This performs the actual writing to disk.
1993
It is intended to be called by BzrBranch5.set_revision_history."""
1994
self._transport.put_bytes(
1995
'revision-history', '\n'.join(history),
1996
mode=self.bzrdir._get_file_mode())
1999
def set_revision_history(self, rev_history):
2000
"""See Branch.set_revision_history."""
2001
if 'evil' in debug.debug_flags:
2002
mutter_callsite(3, "set_revision_history scales with history.")
2003
check_not_reserved_id = _mod_revision.check_not_reserved_id
2004
for rev_id in rev_history:
2005
check_not_reserved_id(rev_id)
2006
if Branch.hooks['post_change_branch_tip']:
2007
# Don't calculate the last_revision_info() if there are no hooks
2009
old_revno, old_revid = self.last_revision_info()
2010
if len(rev_history) == 0:
2011
revid = _mod_revision.NULL_REVISION
2013
revid = rev_history[-1]
2014
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2015
self._write_revision_history(rev_history)
2016
self._clear_cached_state()
2017
self._cache_revision_history(rev_history)
2018
for hook in Branch.hooks['set_rh']:
2019
hook(self, rev_history)
2020
if Branch.hooks['post_change_branch_tip']:
2021
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2023
def _synchronize_history(self, destination, revision_id):
2024
"""Synchronize last revision and revision history between branches.
2026
This version is most efficient when the destination is also a
2027
BzrBranch5, but works for BzrBranch6 as long as the revision
2028
history is the true lefthand parent history, and all of the revisions
2029
are in the destination's repository. If not, set_revision_history
2032
:param destination: The branch to copy the history into
2033
:param revision_id: The revision-id to truncate history at. May
2034
be None to copy complete history.
2036
if not isinstance(destination._format, BzrBranchFormat5):
2037
super(BzrBranch, self)._synchronize_history(
2038
destination, revision_id)
2040
if revision_id == _mod_revision.NULL_REVISION:
2043
new_history = self.revision_history()
2044
if revision_id is not None and new_history != []:
2046
new_history = new_history[:new_history.index(revision_id) + 1]
2048
rev = self.repository.get_revision(revision_id)
2049
new_history = rev.get_history(self.repository)[1:]
2050
destination.set_revision_history(new_history)
2053
def set_last_revision_info(self, revno, revision_id):
2054
"""Set the last revision of this branch.
2056
The caller is responsible for checking that the revno is correct
2057
for this revision id.
2059
It may be possible to set the branch last revision to an id not
2060
present in the repository. However, branches can also be
2061
configured to check constraints on history, in which case this may not
2064
revision_id = _mod_revision.ensure_null(revision_id)
2065
# this old format stores the full history, but this api doesn't
2066
# provide it, so we must generate, and might as well check it's
2068
history = self._lefthand_history(revision_id)
2069
if len(history) != revno:
2070
raise AssertionError('%d != %d' % (len(history), revno))
2071
self.set_revision_history(history)
2073
def _gen_revision_history(self):
2074
history = self._transport.get_bytes('revision-history').split('\n')
2075
if history[-1:] == ['']:
2076
# There shouldn't be a trailing newline, but just in case.
2081
def generate_revision_history(self, revision_id, last_rev=None,
2083
"""Create a new revision history that will finish with revision_id.
2085
:param revision_id: the new tip to use.
2086
:param last_rev: The previous last_revision. If not None, then this
2087
must be a ancestory of revision_id, or DivergedBranches is raised.
2088
:param other_branch: The other branch that DivergedBranches should
2089
raise with respect to.
2091
self.set_revision_history(self._lefthand_history(revision_id,
2092
last_rev, other_branch))
2094
def basis_tree(self):
2095
"""See Branch.basis_tree."""
2096
return self.repository.revision_tree(self.last_revision())
2099
def pull(self, source, overwrite=False, stop_revision=None,
2100
_hook_master=None, run_hooks=True, possible_transports=None,
2101
_override_hook_target=None):
2104
:param _hook_master: Private parameter - set the branch to
2105
be supplied as the master to pull hooks.
2106
:param run_hooks: Private parameter - if false, this branch
2107
is being called because it's the master of the primary branch,
2108
so it should not run its hooks.
2109
:param _override_hook_target: Private parameter - set the branch to be
2110
supplied as the target_branch to pull hooks.
2112
result = PullResult()
2113
result.source_branch = source
2114
if _override_hook_target is None:
2115
result.target_branch = self
2117
result.target_branch = _override_hook_target
2120
# We assume that during 'pull' the local repository is closer than
2122
graph = self.repository.get_graph(source.repository)
2123
result.old_revno, result.old_revid = self.last_revision_info()
2124
self.update_revisions(source, stop_revision, overwrite=overwrite,
2126
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
2127
result.new_revno, result.new_revid = self.last_revision_info()
2129
result.master_branch = _hook_master
2130
result.local_branch = result.target_branch
2132
result.master_branch = result.target_branch
2133
result.local_branch = None
2135
for hook in Branch.hooks['post_pull']:
2141
def _get_parent_location(self):
2142
_locs = ['parent', 'pull', 'x-pull']
2145
return self._transport.get_bytes(l).strip('\n')
2146
except errors.NoSuchFile:
2151
def push(self, target, overwrite=False, stop_revision=None,
2152
_override_hook_source_branch=None):
2155
This is the basic concrete implementation of push()
2157
:param _override_hook_source_branch: If specified, run
2158
the hooks passing this Branch as the source, rather than self.
2159
This is for use of RemoteBranch, where push is delegated to the
2160
underlying vfs-based Branch.
2162
# TODO: Public option to disable running hooks - should be trivial but
2164
return _run_with_write_locked_target(
2165
target, self._push_with_bound_branches, target, overwrite,
2167
_override_hook_source_branch=_override_hook_source_branch)
2169
def _push_with_bound_branches(self, target, overwrite,
2171
_override_hook_source_branch=None):
2172
"""Push from self into target, and into target's master if any.
2174
This is on the base BzrBranch class even though it doesn't support
2175
bound branches because the *target* might be bound.
2178
if _override_hook_source_branch:
2179
result.source_branch = _override_hook_source_branch
2180
for hook in Branch.hooks['post_push']:
2183
bound_location = target.get_bound_location()
2184
if bound_location and target.base != bound_location:
2185
# there is a master branch.
2187
# XXX: Why the second check? Is it even supported for a branch to
2188
# be bound to itself? -- mbp 20070507
2189
master_branch = target.get_master_branch()
2190
master_branch.lock_write()
2192
# push into the master from this branch.
2193
self._basic_push(master_branch, overwrite, stop_revision)
2194
# and push into the target branch from this. Note that we push from
2195
# this branch again, because its considered the highest bandwidth
2197
result = self._basic_push(target, overwrite, stop_revision)
2198
result.master_branch = master_branch
2199
result.local_branch = target
2203
master_branch.unlock()
2206
result = self._basic_push(target, overwrite, stop_revision)
2207
# TODO: Why set master_branch and local_branch if there's no
2208
# binding? Maybe cleaner to just leave them unset? -- mbp
2210
result.master_branch = target
2211
result.local_branch = None
2215
def _basic_push(self, target, overwrite, stop_revision):
2216
"""Basic implementation of push without bound branches or hooks.
2218
Must be called with self read locked and target write locked.
2220
result = BranchPushResult()
2221
result.source_branch = self
2222
result.target_branch = target
2223
result.old_revno, result.old_revid = target.last_revision_info()
2224
if result.old_revid != self.last_revision():
2225
# We assume that during 'push' this repository is closer than
2227
graph = self.repository.get_graph(target.repository)
2228
target.update_revisions(self, stop_revision, overwrite=overwrite,
2230
if self._push_should_merge_tags():
2231
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
2232
result.new_revno, result.new_revid = target.last_revision_info()
2235
def get_stacked_on_url(self):
2236
raise errors.UnstackableBranchFormat(self._format, self.base)
2238
def set_push_location(self, location):
2239
"""See Branch.set_push_location."""
2240
self.get_config().set_user_option(
2241
'push_location', location,
2242
store=_mod_config.STORE_LOCATION_NORECURSE)
2244
def _set_parent_location(self, url):
2246
self._transport.delete('parent')
2248
self._transport.put_bytes('parent', url + '\n',
2249
mode=self.bzrdir._get_file_mode())
2252
class BzrBranch5(BzrBranch):
2253
"""A format 5 branch. This supports new features over plain branches.
2255
It has support for a master_branch which is the data for bound branches.
2259
def pull(self, source, overwrite=False, stop_revision=None,
2260
run_hooks=True, possible_transports=None,
2261
_override_hook_target=None):
2262
"""Pull from source into self, updating my master if any.
2264
:param run_hooks: Private parameter - if false, this branch
2265
is being called because it's the master of the primary branch,
2266
so it should not run its hooks.
2268
bound_location = self.get_bound_location()
2269
master_branch = None
2270
if bound_location and source.base != bound_location:
2271
# not pulling from master, so we need to update master.
2272
master_branch = self.get_master_branch(possible_transports)
2273
master_branch.lock_write()
2276
# pull from source into master.
2277
master_branch.pull(source, overwrite, stop_revision,
2279
return super(BzrBranch5, self).pull(source, overwrite,
2280
stop_revision, _hook_master=master_branch,
2281
run_hooks=run_hooks,
2282
_override_hook_target=_override_hook_target)
2285
master_branch.unlock()
2287
def get_bound_location(self):
2289
return self._transport.get_bytes('bound')[:-1]
2290
except errors.NoSuchFile:
2294
def get_master_branch(self, possible_transports=None):
2295
"""Return the branch we are bound to.
2297
:return: Either a Branch, or None
2299
This could memoise the branch, but if thats done
2300
it must be revalidated on each new lock.
2301
So for now we just don't memoise it.
2302
# RBC 20060304 review this decision.
2304
bound_loc = self.get_bound_location()
2308
return Branch.open(bound_loc,
2309
possible_transports=possible_transports)
2310
except (errors.NotBranchError, errors.ConnectionError), e:
2311
raise errors.BoundBranchConnectionFailure(
2315
def set_bound_location(self, location):
2316
"""Set the target where this branch is bound to.
2318
:param location: URL to the target branch
2321
self._transport.put_bytes('bound', location+'\n',
2322
mode=self.bzrdir._get_file_mode())
2325
self._transport.delete('bound')
2326
except errors.NoSuchFile:
2331
def bind(self, other):
2332
"""Bind this branch to the branch other.
2334
This does not push or pull data between the branches, though it does
2335
check for divergence to raise an error when the branches are not
2336
either the same, or one a prefix of the other. That behaviour may not
2337
be useful, so that check may be removed in future.
2339
:param other: The branch to bind to
2342
# TODO: jam 20051230 Consider checking if the target is bound
2343
# It is debatable whether you should be able to bind to
2344
# a branch which is itself bound.
2345
# Committing is obviously forbidden,
2346
# but binding itself may not be.
2347
# Since we *have* to check at commit time, we don't
2348
# *need* to check here
2350
# we want to raise diverged if:
2351
# last_rev is not in the other_last_rev history, AND
2352
# other_last_rev is not in our history, and do it without pulling
2354
self.set_bound_location(other.base)
2358
"""If bound, unbind"""
2359
return self.set_bound_location(None)
2362
def update(self, possible_transports=None):
2363
"""Synchronise this branch with the master branch if any.
2365
:return: None or the last_revision that was pivoted out during the
2368
master = self.get_master_branch(possible_transports)
2369
if master is not None:
2370
old_tip = _mod_revision.ensure_null(self.last_revision())
2371
self.pull(master, overwrite=True)
2372
if self.repository.get_graph().is_ancestor(old_tip,
2373
_mod_revision.ensure_null(self.last_revision())):
2379
class BzrBranch7(BzrBranch5):
2380
"""A branch with support for a fallback repository."""
2382
def _open_hook(self):
2383
if self._ignore_fallbacks:
2386
url = self.get_stacked_on_url()
2387
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2388
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:
2391
for hook in Branch.hooks['transform_fallback_location']:
2392
url = hook(self, url)
2394
hook_name = Branch.hooks.get_hook_name(hook)
2395
raise AssertionError(
2396
"'transform_fallback_location' hook %s returned "
2397
"None, not a URL." % hook_name)
2398
self._activate_fallback_location(url, None)
2400
def __init__(self, *args, **kwargs):
2401
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2402
super(BzrBranch7, self).__init__(*args, **kwargs)
2403
self._last_revision_info_cache = None
2404
self._partial_revision_history_cache = []
2406
def _clear_cached_state(self):
2407
super(BzrBranch7, self)._clear_cached_state()
2408
self._last_revision_info_cache = None
2409
self._partial_revision_history_cache = []
2411
def _last_revision_info(self):
2412
revision_string = self._transport.get_bytes('last-revision')
2413
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2414
revision_id = cache_utf8.get_cached_utf8(revision_id)
2416
return revno, revision_id
2418
def _write_last_revision_info(self, revno, revision_id):
2419
"""Simply write out the revision id, with no checks.
2421
Use set_last_revision_info to perform this safely.
2423
Does not update the revision_history cache.
2424
Intended to be called by set_last_revision_info and
2425
_write_revision_history.
2427
revision_id = _mod_revision.ensure_null(revision_id)
2428
out_string = '%d %s\n' % (revno, revision_id)
2429
self._transport.put_bytes('last-revision', out_string,
2430
mode=self.bzrdir._get_file_mode())
2433
def set_last_revision_info(self, revno, revision_id):
2434
revision_id = _mod_revision.ensure_null(revision_id)
2435
old_revno, old_revid = self.last_revision_info()
2436
if self._get_append_revisions_only():
2437
self._check_history_violation(revision_id)
2438
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2439
self._write_last_revision_info(revno, revision_id)
2440
self._clear_cached_state()
2441
self._last_revision_info_cache = revno, revision_id
2442
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2444
def _synchronize_history(self, destination, revision_id):
2445
"""Synchronize last revision and revision history between branches.
2447
:see: Branch._synchronize_history
2449
# XXX: The base Branch has a fast implementation of this method based
2450
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2451
# that uses set_revision_history. This class inherits from BzrBranch5,
2452
# but wants the fast implementation, so it calls
2453
# Branch._synchronize_history directly.
2454
Branch._synchronize_history(self, destination, revision_id)
2456
def _check_history_violation(self, revision_id):
2457
last_revision = _mod_revision.ensure_null(self.last_revision())
2458
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
2460
if last_revision not in self._lefthand_history(revision_id):
2461
raise errors.AppendRevisionsOnlyViolation(self.base)
2463
def _gen_revision_history(self):
2464
"""Generate the revision history from last revision
2466
last_revno, last_revision = self.last_revision_info()
2467
self._extend_partial_history(stop_index=last_revno-1)
2468
return list(reversed(self._partial_revision_history_cache))
2470
def _extend_partial_history(self, stop_index=None, stop_revision=None):
2471
"""Extend the partial history to include a given index
2473
If a stop_index is supplied, stop when that index has been reached.
2474
If a stop_revision is supplied, stop when that revision is
2475
encountered. Otherwise, stop when the beginning of history is
2478
:param stop_index: The index which should be present. When it is
2479
present, history extension will stop.
2480
:param revision_id: The revision id which should be present. When
2481
it is encountered, history extension will stop.
2483
repo = self.repository
2484
if len(self._partial_revision_history_cache) == 0:
2485
iterator = repo.iter_reverse_revision_history(self.last_revision())
2487
start_revision = self._partial_revision_history_cache[-1]
2488
iterator = repo.iter_reverse_revision_history(start_revision)
2489
#skip the last revision in the list
2490
next_revision = iterator.next()
2491
for revision_id in iterator:
2492
self._partial_revision_history_cache.append(revision_id)
2493
if (stop_index is not None and
2494
len(self._partial_revision_history_cache) > stop_index):
2496
if revision_id == stop_revision:
2499
def _write_revision_history(self, history):
2500
"""Factored out of set_revision_history.
2502
This performs the actual writing to disk, with format-specific checks.
2503
It is intended to be called by BzrBranch5.set_revision_history.
2505
if len(history) == 0:
2506
last_revision = 'null:'
2508
if history != self._lefthand_history(history[-1]):
2509
raise errors.NotLefthandHistory(history)
2510
last_revision = history[-1]
2511
if self._get_append_revisions_only():
2512
self._check_history_violation(last_revision)
2513
self._write_last_revision_info(len(history), last_revision)
2516
def _set_parent_location(self, url):
2517
"""Set the parent branch"""
2518
self._set_config_location('parent_location', url, make_relative=True)
2521
def _get_parent_location(self):
2522
"""Set the parent branch"""
2523
return self._get_config_location('parent_location')
2525
def set_push_location(self, location):
2526
"""See Branch.set_push_location."""
2527
self._set_config_location('push_location', location)
2529
def set_bound_location(self, location):
2530
"""See Branch.set_push_location."""
2532
config = self.get_config()
2533
if location is None:
2534
if config.get_user_option('bound') != 'True':
2537
config.set_user_option('bound', 'False', warn_masked=True)
2540
self._set_config_location('bound_location', location,
2542
config.set_user_option('bound', 'True', warn_masked=True)
2545
def _get_bound_location(self, bound):
2546
"""Return the bound location in the config file.
2548
Return None if the bound parameter does not match"""
2549
config = self.get_config()
2550
config_bound = (config.get_user_option('bound') == 'True')
2551
if config_bound != bound:
2553
return self._get_config_location('bound_location', config=config)
2555
def get_bound_location(self):
2556
"""See Branch.set_push_location."""
2557
return self._get_bound_location(True)
2559
def get_old_bound_location(self):
2560
"""See Branch.get_old_bound_location"""
2561
return self._get_bound_location(False)
2563
def get_stacked_on_url(self):
2564
# you can always ask for the URL; but you might not be able to use it
2565
# if the repo can't support stacking.
2566
## self._check_stackable_repo()
2567
stacked_url = self._get_config_location('stacked_on_location')
2568
if stacked_url is None:
2569
raise errors.NotStacked(self)
2572
def set_append_revisions_only(self, enabled):
2577
self.get_config().set_user_option('append_revisions_only', value,
2580
def _get_append_revisions_only(self):
2581
value = self.get_config().get_user_option('append_revisions_only')
2582
return value == 'True'
2585
def generate_revision_history(self, revision_id, last_rev=None,
2587
"""See BzrBranch5.generate_revision_history"""
2588
history = self._lefthand_history(revision_id, last_rev, other_branch)
2589
revno = len(history)
2590
self.set_last_revision_info(revno, revision_id)
2593
def get_rev_id(self, revno, history=None):
2594
"""Find the revision id of the specified revno."""
2596
return _mod_revision.NULL_REVISION
2598
last_revno, last_revision_id = self.last_revision_info()
2599
if revno <= 0 or revno > last_revno:
2600
raise errors.NoSuchRevision(self, revno)
2602
if history is not None:
2603
return history[revno - 1]
2605
index = last_revno - revno
2606
if len(self._partial_revision_history_cache) <= index:
2607
self._extend_partial_history(stop_index=index)
2608
if len(self._partial_revision_history_cache) > index:
2609
return self._partial_revision_history_cache[index]
2611
raise errors.NoSuchRevision(self, revno)
2614
def revision_id_to_revno(self, revision_id):
2615
"""Given a revision id, return its revno"""
2616
if _mod_revision.is_null(revision_id):
1256
f = AtomicFile(self.controlfilename('pending-merges'))
1268
class ScratchBranch(Branch):
1269
"""Special test class: a branch that cleans up after itself.
1271
>>> b = ScratchBranch()
2619
index = self._partial_revision_history_cache.index(revision_id)
2621
self._extend_partial_history(stop_revision=revision_id)
2622
index = len(self._partial_revision_history_cache) - 1
2623
if self._partial_revision_history_cache[index] != revision_id:
2624
raise errors.NoSuchRevision(self, revision_id)
2625
return self.revno() - index
2628
class BzrBranch6(BzrBranch7):
2629
"""See BzrBranchFormat6 for the capabilities of this branch.
2631
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)
2635
def get_stacked_on_url(self):
2636
raise errors.UnstackableBranchFormat(self._format, self.base)
1337
2639
######################################################################
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')
2640
# results of operations
2643
class _Result(object):
2645
def _show_tag_conficts(self, to_file):
2646
if not getattr(self, 'tag_conflicts', None):
2648
to_file.write('Conflicting tags:\n')
2649
for name, value1, value2 in self.tag_conflicts:
2650
to_file.write(' %s\n' % (name, ))
2653
class PullResult(_Result):
2654
"""Result of a Branch.pull operation.
2656
:ivar old_revno: Revision number before pull.
2657
:ivar new_revno: Revision number after pull.
2658
:ivar old_revid: Tip revision id before pull.
2659
:ivar new_revid: Tip revision id after pull.
2660
:ivar source_branch: Source (local) branch object. (read locked)
2661
:ivar master_branch: Master branch of the target, or the target if no
2663
:ivar local_branch: target branch if there is a Master, else None
2664
:ivar target_branch: Target/destination branch object. (write locked)
2665
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2669
# DEPRECATED: pull used to return the change in revno
2670
return self.new_revno - self.old_revno
2672
def report(self, to_file):
2674
if self.old_revid == self.new_revid:
2675
to_file.write('No revisions to pull.\n')
2677
to_file.write('Now on revision %d.\n' % self.new_revno)
2678
self._show_tag_conficts(to_file)
2681
class BranchPushResult(_Result):
2682
"""Result of a Branch.push operation.
2684
:ivar old_revno: Revision number (eg 10) of the target before push.
2685
:ivar new_revno: Revision number (eg 12) of the target after push.
2686
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
2688
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
2690
:ivar source_branch: Source branch object that the push was from. This is
2691
read locked, and generally is a local (and thus low latency) branch.
2692
:ivar master_branch: If target is a bound branch, the master branch of
2693
target, or target itself. Always write locked.
2694
:ivar target_branch: The direct Branch where data is being sent (write
2696
:ivar local_branch: If the target is a bound branch this will be the
2697
target, otherwise it will be None.
2701
# DEPRECATED: push used to return the change in revno
2702
return self.new_revno - self.old_revno
2704
def report(self, to_file):
2705
"""Write a human-readable description of the result."""
2706
if self.old_revid == self.new_revid:
2707
note('No new revisions to push.')
2709
note('Pushed up to revision %d.' % self.new_revno)
2710
self._show_tag_conficts(to_file)
2713
class BranchCheckResult(object):
2714
"""Results of checking branch consistency.
2719
def __init__(self, branch):
2720
self.branch = branch
2722
def report_results(self, verbose):
2723
"""Report the check results via trace.note.
2725
:param verbose: Requests more detailed display of what was checked,
2728
note('checked branch %s format %s',
2730
self.branch._format)
2733
class Converter5to6(object):
2734
"""Perform an in-place upgrade of format 5 to format 6"""
2736
def convert(self, branch):
2737
# Data for 5 and 6 can peacefully coexist.
2738
format = BzrBranchFormat6()
2739
new_branch = format.open(branch.bzrdir, _found=True)
2741
# Copy source data into target
2742
new_branch._write_last_revision_info(*branch.last_revision_info())
2743
new_branch.set_parent(branch.get_parent())
2744
new_branch.set_bound_location(branch.get_bound_location())
2745
new_branch.set_push_location(branch.get_push_location())
2747
# New branch has no tags by default
2748
new_branch.tags._set_tag_dict({})
2750
# Copying done; now update target format
2751
new_branch._transport.put_bytes('format',
2752
format.get_format_string(),
2753
mode=new_branch.bzrdir._get_file_mode())
2755
# Clean up old files
2756
new_branch._transport.delete('revision-history')
2758
branch.set_parent(None)
2759
except errors.NoSuchFile:
2761
branch.set_bound_location(None)
2764
class Converter6to7(object):
2765
"""Perform an in-place upgrade of format 6 to format 7"""
2767
def convert(self, branch):
2768
format = BzrBranchFormat7()
2769
branch._set_config_location('stacked_on_location', '')
2770
# update target format
2771
branch._transport.put_bytes('format', format.get_format_string())
2775
def _run_with_write_locked_target(target, callable, *args, **kwargs):
2776
"""Run ``callable(*args, **kwargs)``, write-locking target for the
2779
_run_with_write_locked_target will attempt to release the lock it acquires.
2781
If an exception is raised by callable, then that exception *will* be
2782
propagated, even if the unlock attempt raises its own error. Thus
2783
_run_with_write_locked_target should be preferred to simply doing::
2787
return callable(*args, **kwargs)
2792
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
2793
# should share code?
2796
result = callable(*args, **kwargs)
2798
exc_info = sys.exc_info()
2802
raise exc_info[0], exc_info[1], exc_info[2]
2808
class InterBranch(InterObject):
2809
"""This class represents operations taking place between two branches.
2811
Its instances have methods like pull() and push() and contain
2812
references to the source and target repositories these operations
2813
can be carried out on.
2817
"""The available optimised InterBranch types."""
2820
def _get_branch_formats_to_test():
2821
"""Return a tuple with the Branch formats to use when testing."""
2822
raise NotImplementedError(self._get_branch_formats_to_test)
2824
def update_revisions(self, stop_revision=None, overwrite=False,
2826
"""Pull in new perfect-fit revisions.
2828
:param stop_revision: Updated until the given revision
2829
:param overwrite: Always set the branch pointer, rather than checking
2830
to see if it is a proper descendant.
2831
:param graph: A Graph object that can be used to query history
2832
information. This can be None.
2835
raise NotImplementedError(self.update_revisions)
2838
class GenericInterBranch(InterBranch):
2839
"""InterBranch implementation that uses public Branch functions.
2843
def _get_branch_formats_to_test():
2844
return BranchFormat._default_format, BranchFormat._default_format
2846
def update_revisions(self, stop_revision=None, overwrite=False,
2848
"""See InterBranch.update_revisions()."""
2849
self.source.lock_read()
2851
other_revno, other_last_revision = self.source.last_revision_info()
2852
stop_revno = None # unknown
2853
if stop_revision is None:
2854
stop_revision = other_last_revision
2855
if _mod_revision.is_null(stop_revision):
2856
# if there are no commits, we're done.
2858
stop_revno = other_revno
2860
# what's the current last revision, before we fetch [and change it
2862
last_rev = _mod_revision.ensure_null(self.target.last_revision())
2863
# we fetch here so that we don't process data twice in the common
2864
# case of having something to pull, and so that the check for
2865
# already merged can operate on the just fetched graph, which will
2866
# be cached in memory.
2867
self.target.fetch(self.source, stop_revision)
2868
# Check to see if one is an ancestor of the other
2871
graph = self.target.repository.get_graph()
2872
if self.target._check_if_descendant_or_diverged(
2873
stop_revision, last_rev, graph, self.source):
2874
# stop_revision is a descendant of last_rev, but we aren't
2875
# overwriting, so we're done.
2877
if stop_revno is None:
2879
graph = self.target.repository.get_graph()
2880
this_revno, this_last_revision = \
2881
self.target.last_revision_info()
2882
stop_revno = graph.find_distance_to_null(stop_revision,
2883
[(other_last_revision, other_revno),
2884
(this_last_revision, this_revno)])
2885
self.target.set_last_revision_info(stop_revno, stop_revision)
2887
self.source.unlock()
2890
def is_compatible(self, source, target):
2891
# GenericBranch uses the public API, so always compatible
2895
InterBranch.register_optimiser(GenericInterBranch)
added
removed
bzrlib/branch.py
