342
195
def get_physical_lock_status(self):
343
196
raise NotImplementedError(self.get_physical_lock_status)
345
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
346
"""Return the revision_id for a dotted revno.
348
:param revno: a tuple like (1,) or (1,1,2)
349
:param _cache_reverse: a private parameter enabling storage
350
of the reverse mapping in a top level cache. (This should
351
only be done in selective circumstances as we want to
352
avoid having the mapping cached multiple times.)
353
:return: the revision_id
354
:raises errors.NoSuchRevision: if the revno doesn't exist
356
with self.lock_read():
357
rev_id = self._do_dotted_revno_to_revision_id(revno)
359
self._partial_revision_id_to_revno_cache[rev_id] = revno
362
def _do_dotted_revno_to_revision_id(self, revno):
363
"""Worker function for dotted_revno_to_revision_id.
365
Subclasses should override this if they wish to
366
provide a more efficient implementation.
369
return self.get_rev_id(revno[0])
370
revision_id_to_revno = self.get_revision_id_to_revno_map()
371
revision_ids = [revision_id for revision_id, this_revno
372
in viewitems(revision_id_to_revno)
373
if revno == this_revno]
374
if len(revision_ids) == 1:
375
return revision_ids[0]
377
revno_str = '.'.join(map(str, revno))
378
raise errors.NoSuchRevision(self, revno_str)
380
def revision_id_to_dotted_revno(self, revision_id):
381
"""Given a revision id, return its dotted revno.
383
:return: a tuple like (1,) or (400,1,3).
385
with self.lock_read():
386
return self._do_revision_id_to_dotted_revno(revision_id)
388
def _do_revision_id_to_dotted_revno(self, revision_id):
389
"""Worker function for revision_id_to_revno."""
390
# Try the caches if they are loaded
391
result = self._partial_revision_id_to_revno_cache.get(revision_id)
392
if result is not None:
394
if self._revision_id_to_revno_cache:
395
result = self._revision_id_to_revno_cache.get(revision_id)
397
raise errors.NoSuchRevision(self, revision_id)
398
# Try the mainline as it's optimised
400
revno = self.revision_id_to_revno(revision_id)
402
except errors.NoSuchRevision:
403
# We need to load and use the full revno map after all
404
result = self.get_revision_id_to_revno_map().get(revision_id)
406
raise errors.NoSuchRevision(self, revision_id)
409
def get_revision_id_to_revno_map(self):
410
"""Return the revision_id => dotted revno map.
412
This will be regenerated on demand, but will be cached.
414
:return: A dictionary mapping revision_id => dotted revno.
415
This dictionary should not be modified by the caller.
417
if 'evil' in debug.debug_flags:
418
mutter_callsite(3, "get_revision_id_to_revno_map scales with ancestry.")
419
with self.lock_read():
420
if self._revision_id_to_revno_cache is not None:
421
mapping = self._revision_id_to_revno_cache
423
mapping = self._gen_revno_map()
424
self._cache_revision_id_to_revno(mapping)
425
# TODO: jam 20070417 Since this is being cached, should we be returning
427
# I would rather not, and instead just declare that users should not
428
# modify the return value.
431
def _gen_revno_map(self):
432
"""Create a new mapping from revision ids to dotted revnos.
434
Dotted revnos are generated based on the current tip in the revision
436
This is the worker function for get_revision_id_to_revno_map, which
437
just caches the return value.
439
:return: A dictionary mapping revision_id => dotted revno.
441
revision_id_to_revno = dict((rev_id, revno)
442
for rev_id, depth, revno, end_of_merge
443
in self.iter_merge_sorted_revisions())
444
return revision_id_to_revno
446
def iter_merge_sorted_revisions(self, start_revision_id=None,
447
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
448
"""Walk the revisions for a branch in merge sorted order.
450
Merge sorted order is the output from a merge-aware,
451
topological sort, i.e. all parents come before their
452
children going forward; the opposite for reverse.
454
:param start_revision_id: the revision_id to begin walking from.
455
If None, the branch tip is used.
456
:param stop_revision_id: the revision_id to terminate the walk
457
after. If None, the rest of history is included.
458
:param stop_rule: if stop_revision_id is not None, the precise rule
459
to use for termination:
461
* 'exclude' - leave the stop revision out of the result (default)
462
* 'include' - the stop revision is the last item in the result
463
* 'with-merges' - include the stop revision and all of its
464
merged revisions in the result
465
* 'with-merges-without-common-ancestry' - filter out revisions
466
that are in both ancestries
467
:param direction: either 'reverse' or 'forward':
469
* reverse means return the start_revision_id first, i.e.
470
start at the most recent revision and go backwards in history
471
* forward returns tuples in the opposite order to reverse.
472
Note in particular that forward does *not* do any intelligent
473
ordering w.r.t. depth as some clients of this API may like.
474
(If required, that ought to be done at higher layers.)
476
:return: an iterator over (revision_id, depth, revno, end_of_merge)
479
* revision_id: the unique id of the revision
480
* depth: How many levels of merging deep this node has been
482
* revno_sequence: This field provides a sequence of
483
revision numbers for all revisions. The format is:
484
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
485
branch that the revno is on. From left to right the REVNO numbers
486
are the sequence numbers within that branch of the revision.
487
* end_of_merge: When True the next node (earlier in history) is
488
part of a different merge.
490
with self.lock_read():
491
# Note: depth and revno values are in the context of the branch so
492
# we need the full graph to get stable numbers, regardless of the
494
if self._merge_sorted_revisions_cache is None:
495
last_revision = self.last_revision()
496
known_graph = self.repository.get_known_graph_ancestry(
498
self._merge_sorted_revisions_cache = known_graph.merge_sort(
500
filtered = self._filter_merge_sorted_revisions(
501
self._merge_sorted_revisions_cache, start_revision_id,
502
stop_revision_id, stop_rule)
503
# Make sure we don't return revisions that are not part of the
504
# start_revision_id ancestry.
505
filtered = self._filter_start_non_ancestors(filtered)
506
if direction == 'reverse':
508
if direction == 'forward':
509
return reversed(list(filtered))
511
raise ValueError('invalid direction %r' % direction)
513
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
514
start_revision_id, stop_revision_id, stop_rule):
515
"""Iterate over an inclusive range of sorted revisions."""
516
rev_iter = iter(merge_sorted_revisions)
517
if start_revision_id is not None:
518
for node in rev_iter:
520
if rev_id != start_revision_id:
523
# The decision to include the start or not
524
# depends on the stop_rule if a stop is provided
525
# so pop this node back into the iterator
526
rev_iter = itertools.chain(iter([node]), rev_iter)
528
if stop_revision_id is None:
530
for node in rev_iter:
532
yield (rev_id, node.merge_depth, node.revno,
534
elif stop_rule == 'exclude':
535
for node in rev_iter:
537
if rev_id == stop_revision_id:
539
yield (rev_id, node.merge_depth, node.revno,
541
elif stop_rule == 'include':
542
for node in rev_iter:
544
yield (rev_id, node.merge_depth, node.revno,
546
if rev_id == stop_revision_id:
548
elif stop_rule == 'with-merges-without-common-ancestry':
549
# We want to exclude all revisions that are already part of the
550
# stop_revision_id ancestry.
551
graph = self.repository.get_graph()
552
ancestors = graph.find_unique_ancestors(start_revision_id,
554
for node in rev_iter:
556
if rev_id not in ancestors:
558
yield (rev_id, node.merge_depth, node.revno,
560
elif stop_rule == 'with-merges':
561
stop_rev = self.repository.get_revision(stop_revision_id)
562
if stop_rev.parent_ids:
563
left_parent = stop_rev.parent_ids[0]
565
left_parent = _mod_revision.NULL_REVISION
566
# left_parent is the actual revision we want to stop logging at,
567
# since we want to show the merged revisions after the stop_rev too
568
reached_stop_revision_id = False
569
revision_id_whitelist = []
570
for node in rev_iter:
572
if rev_id == left_parent:
573
# reached the left parent after the stop_revision
575
if (not reached_stop_revision_id or
576
rev_id in revision_id_whitelist):
577
yield (rev_id, node.merge_depth, node.revno,
579
if reached_stop_revision_id or rev_id == stop_revision_id:
580
# only do the merged revs of rev_id from now on
581
rev = self.repository.get_revision(rev_id)
583
reached_stop_revision_id = True
584
revision_id_whitelist.extend(rev.parent_ids)
586
raise ValueError('invalid stop_rule %r' % stop_rule)
588
def _filter_start_non_ancestors(self, rev_iter):
589
# If we started from a dotted revno, we want to consider it as a tip
590
# and don't want to yield revisions that are not part of its
591
# ancestry. Given the order guaranteed by the merge sort, we will see
592
# uninteresting descendants of the first parent of our tip before the
595
first = next(rev_iter)
596
except StopIteration:
598
(rev_id, merge_depth, revno, end_of_merge) = first
601
# We start at a mainline revision so by definition, all others
602
# revisions in rev_iter are ancestors
603
for node in rev_iter:
608
pmap = self.repository.get_parent_map([rev_id])
609
parents = pmap.get(rev_id, [])
611
whitelist.update(parents)
613
# If there is no parents, there is nothing of interest left
615
# FIXME: It's hard to test this scenario here as this code is never
616
# called in that case. -- vila 20100322
619
for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
621
if rev_id in whitelist:
622
pmap = self.repository.get_parent_map([rev_id])
623
parents = pmap.get(rev_id, [])
624
whitelist.remove(rev_id)
625
whitelist.update(parents)
627
# We've reached the mainline, there is nothing left to
631
# A revision that is not part of the ancestry of our
634
yield (rev_id, merge_depth, revno, end_of_merge)
636
198
def leave_lock_in_place(self):
637
199
"""Tell this branch object not to release the physical lock when this
638
200
object is unlocked.
640
202
If lock_write doesn't return a token, then this method is not supported.
642
204
self.control_files.leave_in_place()
1185
606
self.check_real_revno(revno)
1187
608
def check_real_revno(self, revno):
1189
610
Check whether a revno corresponds to a real revision.
1190
611
Zero (the NULL revision) is considered invalid
1192
613
if revno < 1 or revno > self.revno():
1193
raise errors.InvalidRevisionNumber(revno)
1195
def clone(self, to_controldir, revision_id=None, repository_policy=None):
1196
"""Clone this branch into to_controldir preserving all semantic values.
1198
Most API users will want 'create_clone_on_transport', which creates a
1199
new bzrdir and branch on the fly.
1201
revision_id: if not None, the revision history in the new branch will
1202
be truncated to end with revision_id.
1204
result = to_controldir.create_branch()
1205
with self.lock_read(), result.lock_write():
1206
if repository_policy is not None:
1207
repository_policy.configure_branch(result)
1208
self.copy_content_into(result, revision_id=revision_id)
1211
def sprout(self, to_controldir, revision_id=None, repository_policy=None,
1212
repository=None, lossy=False):
1213
"""Create a new line of development from the branch, into to_controldir.
1215
to_controldir controls the branch format.
1217
revision_id: if not None, the revision history in the new branch will
1218
be truncated to end with revision_id.
1220
if (repository_policy is not None and
1221
repository_policy.requires_stacking()):
1222
to_controldir._format.require_stacking(_skip_repo=True)
1223
result = to_controldir.create_branch(repository=repository)
1225
raise errors.LossyPushToSameVCS(self, result)
1226
with self.lock_read(), result.lock_write():
1227
if repository_policy is not None:
1228
repository_policy.configure_branch(result)
1229
self.copy_content_into(result, revision_id=revision_id)
1230
master_url = self.get_bound_location()
1231
if master_url is None:
1232
result.set_parent(self.user_url)
1234
result.set_parent(master_url)
614
raise InvalidRevisionNumber(revno)
617
def clone(self, to_bzrdir, revision_id=None):
618
"""Clone this branch into to_bzrdir preserving all semantic values.
620
revision_id: if not None, the revision history in the new branch will
621
be truncated to end with revision_id.
623
result = self._format.initialize(to_bzrdir)
624
self.copy_content_into(result, revision_id=revision_id)
628
def sprout(self, to_bzrdir, revision_id=None):
629
"""Create a new line of development from the branch, into to_bzrdir.
631
revision_id: if not None, the revision history in the new branch will
632
be truncated to end with revision_id.
634
result = self._format.initialize(to_bzrdir)
635
self.copy_content_into(result, revision_id=revision_id)
636
result.set_parent(self.bzrdir.root_transport.base)
1237
639
def _synchronize_history(self, destination, revision_id):
1238
640
"""Synchronize last revision and revision history between branches.
1240
642
This version is most efficient when the destination is also a
1241
BzrBranch6, but works for BzrBranch5, as long as the destination's
1242
repository contains all the lefthand ancestors of the intended
1243
last_revision. If not, set_last_revision_info will fail.
643
BzrBranch5, but works for BzrBranch6 as long as the revision
644
history is the true lefthand parent history, and all of the revisions
645
are in the destination's repository. If not, set_revision_history
1245
648
:param destination: The branch to copy the history into
1246
649
:param revision_id: The revision-id to truncate history at. May
1247
650
be None to copy complete history.
1249
source_revno, source_revision_id = self.last_revision_info()
1250
if revision_id is None:
1251
revno, revision_id = source_revno, source_revision_id
1253
graph = self.repository.get_graph()
652
new_history = self.revision_history()
653
if revision_id is not None:
654
revision_id = osutils.safe_revision_id(revision_id)
1255
revno = graph.find_distance_to_null(revision_id,
1256
[(source_revision_id, source_revno)])
1257
except errors.GhostRevisionsHaveNoRevno:
1258
# Default to 1, if we can't find anything else
1260
destination.set_last_revision_info(revno, revision_id)
656
new_history = new_history[:new_history.index(revision_id) + 1]
658
rev = self.repository.get_revision(revision_id)
659
new_history = rev.get_history(self.repository)[1:]
660
destination.set_revision_history(new_history)
1262
663
def copy_content_into(self, destination, revision_id=None):
1263
664
"""Copy the content of self into destination.
1265
666
revision_id: if not None, the revision history in the new branch will
1266
667
be truncated to end with revision_id.
1268
return InterBranch.get(self, destination).copy_content_into(
1269
revision_id=revision_id)
1271
def update_references(self, target):
1272
if not getattr(self._format, 'supports_reference_locations', False):
1274
reference_dict = self._get_all_reference_info()
1275
if len(reference_dict) == 0:
1277
old_base = self.base
1278
new_base = target.base
1279
target_reference_dict = target._get_all_reference_info()
1280
for tree_path, (branch_location, file_id) in viewitems(reference_dict):
1281
branch_location = urlutils.rebase_url(branch_location,
1283
target_reference_dict.setdefault(
1284
tree_path, (branch_location, file_id))
1285
target._set_all_reference_info(target_reference_dict)
1287
def check(self, refs):
669
self._synchronize_history(destination, revision_id)
671
parent = self.get_parent()
672
except errors.InaccessibleParent, e:
673
mutter('parent was not accessible to copy: %s', e)
676
destination.set_parent(parent)
677
self.tags.merge_to(destination.tags)
1288
681
"""Check consistency of the branch.
1290
683
In particular this checks that revisions given in the revision-history
1291
do actually match up in the revision graph, and that they're all
684
do actually match up in the revision graph, and that they're all
1292
685
present in the repository.
1294
687
Callers will typically also want to check the repository.
1296
:param refs: Calculated refs for this branch as specified by
1297
branch._get_check_refs()
1298
689
:return: A BranchCheckResult.
1300
with self.lock_read():
1301
result = BranchCheckResult(self)
1302
last_revno, last_revision_id = self.last_revision_info()
1303
actual_revno = refs[('lefthand-distance', last_revision_id)]
1304
if actual_revno != last_revno:
1305
result.errors.append(errors.BzrCheckError(
1306
'revno does not match len(mainline) %s != %s' % (
1307
last_revno, actual_revno)))
1308
# TODO: We should probably also check that self.revision_history
1309
# matches the repository for older branch formats.
1310
# If looking for the code that cross-checks repository parents against
1311
# the Graph.iter_lefthand_ancestry output, that is now a repository
691
mainline_parent_id = None
692
for revision_id in self.revision_history():
694
revision = self.repository.get_revision(revision_id)
695
except errors.NoSuchRevision, e:
696
raise errors.BzrCheckError("mainline revision {%s} not in repository"
698
# In general the first entry on the revision history has no parents.
699
# But it's not illegal for it to have parents listed; this can happen
700
# in imports from Arch when the parents weren't reachable.
701
if mainline_parent_id is not None:
702
if mainline_parent_id not in revision.parent_ids:
703
raise errors.BzrCheckError("previous revision {%s} not listed among "
705
% (mainline_parent_id, revision_id))
706
mainline_parent_id = revision_id
707
return BranchCheckResult(self)
1315
def _get_checkout_format(self, lightweight=False):
709
def _get_checkout_format(self):
1316
710
"""Return the most suitable metadir for a checkout of this branch.
1317
711
Weaves are used if this branch's repository uses weaves.
1319
format = self.repository.controldir.checkout_metadir()
1320
format.set_branch_format(self._format)
713
from bzrlib.remote import RemoteBzrDir
714
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
715
from bzrlib.repofmt import weaverepo
716
format = bzrdir.BzrDirMetaFormat1()
717
format.repository_format = weaverepo.RepositoryFormat7()
718
elif isinstance(self.bzrdir, RemoteBzrDir):
719
format = bzrdir.BzrDirMetaFormat1()
721
format = self.repository.bzrdir.checkout_metadir()
722
format.set_branch_format(self._format)
1323
def create_clone_on_transport(self, to_transport, revision_id=None,
1324
stacked_on=None, create_prefix=False, use_existing_dir=False,
1326
"""Create a clone of this branch and its bzrdir.
1328
:param to_transport: The transport to clone onto.
1329
:param revision_id: The revision id to use as tip in the new branch.
1330
If None the tip is obtained from this branch.
1331
:param stacked_on: An optional URL to stack the clone on.
1332
:param create_prefix: Create any missing directories leading up to
1334
:param use_existing_dir: Use an existing directory if one exists.
1336
# XXX: Fix the bzrdir API to allow getting the branch back from the
1337
# clone call. Or something. 20090224 RBC/spiv.
1338
# XXX: Should this perhaps clone colocated branches as well,
1339
# rather than just the default branch? 20100319 JRV
1340
if revision_id is None:
1341
revision_id = self.last_revision()
1342
dir_to = self.controldir.clone_on_transport(to_transport,
1343
revision_id=revision_id, stacked_on=stacked_on,
1344
create_prefix=create_prefix, use_existing_dir=use_existing_dir,
1346
return dir_to.open_branch()
1348
725
def create_checkout(self, to_location, revision_id=None,
1349
lightweight=False, accelerator_tree=None,
1351
727
"""Create a checkout of a branch.
1353
729
:param to_location: The url to produce the checkout at
1354
730
:param revision_id: The revision to check out
1355
731
:param lightweight: If True, produce a lightweight checkout, otherwise,
1356
produce a bound branch (heavyweight checkout)
1357
:param accelerator_tree: A tree which can be used for retrieving file
1358
contents more quickly than the revision tree, i.e. a workingtree.
1359
The revision tree will be used for cases where accelerator_tree's
1360
content is different.
1361
:param hardlink: If true, hard-link files from accelerator_tree,
732
produce a bound branch (heavyweight checkout)
1363
733
:return: The tree of the created checkout
1365
735
t = transport.get_transport(to_location)
1367
format = self._get_checkout_format(lightweight=lightweight)
738
except errors.FileExists:
741
format = self._get_checkout_format()
1369
742
checkout = format.initialize_on_transport(t)
1370
except errors.AlreadyControlDirError:
1371
# It's fine if the control directory already exists,
1372
# as long as there is no existing branch and working tree.
1373
checkout = controldir.ControlDir.open_from_transport(t)
1375
checkout.open_branch()
1376
except errors.NotBranchError:
1379
raise errors.AlreadyControlDirError(t.base)
1380
if checkout.control_transport.base == self.controldir.control_transport.base:
1381
# When checking out to the same control directory,
1382
# always create a lightweight checkout
1386
from_branch = checkout.set_branch_reference(target_branch=self)
743
BranchReferenceFormat().initialize(checkout, self)
1388
policy = checkout.determine_repository_policy()
1389
repo = policy.acquire_repository()[0]
1390
checkout_branch = checkout.create_branch()
745
format = self._get_checkout_format()
746
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
747
to_location, force_new_tree=False, format=format)
748
checkout = checkout_branch.bzrdir
1391
749
checkout_branch.bind(self)
1392
# pull up to the specified revision_id to set the initial
750
# pull up to the specified revision_id to set the initial
1393
751
# branch tip correctly, and seed it with history.
1394
752
checkout_branch.pull(self, stop_revision=revision_id)
1396
tree = checkout.create_workingtree(revision_id,
1397
from_branch=from_branch,
1398
accelerator_tree=accelerator_tree,
753
tree = checkout.create_workingtree(revision_id)
1400
754
basis_tree = tree.basis_tree()
1401
with basis_tree.lock_read():
755
basis_tree.lock_read()
1402
757
for path, file_id in basis_tree.iter_references():
1403
reference_parent = self.reference_parent(path, file_id)
758
reference_parent = self.reference_parent(file_id, path)
1404
759
reference_parent.create_checkout(tree.abspath(path),
1405
basis_tree.get_reference_revision(path, file_id),
760
basis_tree.get_reference_revision(file_id, path),
1409
def reconcile(self, thorough=True):
1410
"""Make sure the data stored in this branch is consistent."""
1411
from breezy.reconcile import BranchReconciler
1412
with self.lock_write():
1413
reconciler = BranchReconciler(self, thorough=thorough)
1414
reconciler.reconcile()
1417
def reference_parent(self, path, file_id=None, possible_transports=None):
766
def reference_parent(self, file_id, path):
1418
767
"""Return the parent branch for a tree-reference file_id
768
:param file_id: The file_id of the tree reference
1420
769
:param path: The path of the file_id in the tree
1421
:param file_id: Optional file_id of the tree reference
1422
770
:return: A branch associated with the file_id
1424
772
# FIXME should provide multiple branches, based on config
1425
return Branch.open(self.controldir.root_transport.clone(path).base,
1426
possible_transports=possible_transports)
773
return Branch.open(self.bzrdir.root_transport.clone(path).base)
1428
775
def supports_tags(self):
1429
776
return self._format.supports_tags()
1431
def automatic_tag_name(self, revision_id):
1432
"""Try to automatically find the tag name for a revision.
1434
:param revision_id: Revision id of the revision.
1435
:return: A tag name or None if no tag name could be determined.
1437
for hook in Branch.hooks['automatic_tag_name']:
1438
ret = hook(self, revision_id)
1443
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1445
"""Ensure that revision_b is a descendant of revision_a.
1447
This is a helper function for update_revisions.
1449
:raises: DivergedBranches if revision_b has diverged from revision_a.
1450
:returns: True if revision_b is a descendant of revision_a.
1452
relation = self._revision_relations(revision_a, revision_b, graph)
1453
if relation == 'b_descends_from_a':
1455
elif relation == 'diverged':
1456
raise errors.DivergedBranches(self, other_branch)
1457
elif relation == 'a_descends_from_b':
1460
raise AssertionError("invalid relation: %r" % (relation,))
1462
def _revision_relations(self, revision_a, revision_b, graph):
1463
"""Determine the relationship between two revisions.
1465
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1467
heads = graph.heads([revision_a, revision_b])
1468
if heads == {revision_b}:
1469
return 'b_descends_from_a'
1470
elif heads == {revision_a, revision_b}:
1471
# These branches have diverged
1473
elif heads == {revision_a}:
1474
return 'a_descends_from_b'
1476
raise AssertionError("invalid heads: %r" % (heads,))
1478
def heads_to_fetch(self):
1479
"""Return the heads that must and that should be fetched to copy this
1480
branch into another repo.
1482
:returns: a 2-tuple of (must_fetch, if_present_fetch). must_fetch is a
1483
set of heads that must be fetched. if_present_fetch is a set of
1484
heads that must be fetched if present, but no error is necessary if
1485
they are not present.
1487
# For bzr native formats must_fetch is just the tip, and
1488
# if_present_fetch are the tags.
1489
must_fetch = {self.last_revision()}
1490
if_present_fetch = set()
1491
if self.get_config_stack().get('branch.fetch_tags'):
1493
if_present_fetch = set(self.tags.get_reverse_tag_dict())
1494
except errors.TagsNotSupported:
1496
must_fetch.discard(_mod_revision.NULL_REVISION)
1497
if_present_fetch.discard(_mod_revision.NULL_REVISION)
1498
return must_fetch, if_present_fetch
1500
def create_memorytree(self):
1501
"""Create a memory tree for this branch.
1503
:return: An in-memory MutableTree instance
1505
return memorytree.MemoryTree.create_on_branch(self)
1508
class BranchFormat(controldir.ControlComponentFormat):
779
class BranchFormat(object):
1509
780
"""An encapsulation of the initialization and open routines for a format.
1511
782
Formats provide three things:
1512
783
* An initialization routine,
1513
* a format description
1514
785
* an open routine.
1516
Formats are placed in an dict by their format string for reference
1517
during branch opening. It's not required that these be instances, they
1518
can be classes themselves with class methods - it simply depends on
787
Formats are placed in an dict by their format string for reference
788
during branch opening. Its not required that these be instances, they
789
can be classes themselves with class methods - it simply depends on
1519
790
whether state is needed for a given format or not.
1521
792
Once a format is deprecated, just deprecate the initialize and open
1522
methods on the format class. Do not deprecate the object, as the
793
methods on the format class. Do not deprecate the object, as the
1523
794
object will be created every time regardless.
1526
def __eq__(self, other):
1527
return self.__class__ is other.__class__
1529
def __ne__(self, other):
1530
return not (self == other)
1532
def get_reference(self, controldir, name=None):
1533
"""Get the target reference of the branch in controldir.
797
_default_format = None
798
"""The default format used for new branches."""
801
"""The known formats."""
804
def find_format(klass, a_bzrdir):
805
"""Return the format for the branch object in a_bzrdir."""
807
transport = a_bzrdir.get_branch_transport(None)
808
format_string = transport.get("format").read()
809
return klass._formats[format_string]
811
raise NotBranchError(path=transport.base)
813
raise errors.UnknownFormatError(format=format_string)
816
def get_default_format(klass):
817
"""Return the current default format."""
818
return klass._default_format
820
def get_reference(self, a_bzrdir):
821
"""Get the target reference of the branch in a_bzrdir.
1535
823
format probing must have been completed before calling
1536
824
this method - it is assumed that the format of the branch
1537
in controldir is correct.
825
in a_bzrdir is correct.
1539
:param controldir: The controldir to get the branch data from.
1540
:param name: Name of the colocated branch to fetch
827
:param a_bzrdir: The bzrdir to get the branch data from.
1541
828
:return: None if the branch is not a reference branch.
1546
def set_reference(self, controldir, name, to_branch):
1547
"""Set the target reference of the branch in controldir.
1549
format probing must have been completed before calling
1550
this method - it is assumed that the format of the branch
1551
in controldir is correct.
1553
:param controldir: The controldir to set the branch reference for.
1554
:param name: Name of colocated branch to set, None for default
1555
:param to_branch: branch that the checkout is to reference
1557
raise NotImplementedError(self.set_reference)
832
def get_format_string(self):
833
"""Return the ASCII format string that identifies this format."""
834
raise NotImplementedError(self.get_format_string)
1559
836
def get_format_description(self):
1560
837
"""Return the short format description for this format."""
1561
838
raise NotImplementedError(self.get_format_description)
1563
def _run_post_branch_init_hooks(self, controldir, name, branch):
1564
hooks = Branch.hooks['post_branch_init']
1567
params = BranchInitHookParams(self, controldir, name, branch)
1571
def initialize(self, controldir, name=None, repository=None,
1572
append_revisions_only=None):
1573
"""Create a branch of this format in controldir.
1575
:param name: Name of the colocated branch to create.
840
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
842
"""Initialize a branch in a bzrdir, with specified files
844
:param a_bzrdir: The bzrdir to initialize the branch in
845
:param utf8_files: The files to create as a list of
846
(filename, content) tuples
847
:param set_format: If True, set the format with
848
self.get_format_string. (BzrBranch4 has its format set
850
:return: a branch in this format
852
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
853
branch_transport = a_bzrdir.get_branch_transport(self)
855
'metadir': ('lock', lockdir.LockDir),
856
'branch4': ('branch-lock', lockable_files.TransportLock),
858
lock_name, lock_class = lock_map[lock_type]
859
control_files = lockable_files.LockableFiles(branch_transport,
860
lock_name, lock_class)
861
control_files.create_lock()
862
control_files.lock_write()
864
control_files.put_utf8('format', self.get_format_string())
866
for file, content in utf8_files:
867
control_files.put_utf8(file, content)
869
control_files.unlock()
870
return self.open(a_bzrdir, _found=True)
872
def initialize(self, a_bzrdir):
873
"""Create a branch of this format in a_bzrdir."""
1577
874
raise NotImplementedError(self.initialize)
1579
876
def is_supported(self):
1580
877
"""Is this format supported?
1582
879
Supported formats can be initialized and opened.
1583
Unsupported formats may not support initialization or committing or
880
Unsupported formats may not support initialization or committing or
1584
881
some other features depending on the reason for not being supported.
1588
def make_tags(self, branch):
1589
"""Create a tags object for branch.
1591
This method is on BranchFormat, because BranchFormats are reflected
1592
over the wire via network_name(), whereas full Branch instances require
1593
multiple VFS method calls to operate at all.
1595
The default implementation returns a disabled-tags instance.
1597
Note that it is normal for branch to be a RemoteBranch when using tags
1600
return _mod_tag.DisabledTags(branch)
1602
def network_name(self):
1603
"""A simple byte string uniquely identifying this format for RPC calls.
1605
MetaDir branch formats use their disk format string to identify the
1606
repository over the wire. All in one formats such as bzr < 0.8, and
1607
foreign formats like svn/git and hg should use some marker which is
1608
unique and immutable.
1610
raise NotImplementedError(self.network_name)
1612
def open(self, controldir, name=None, _found=False, ignore_fallbacks=False,
1613
found_repository=None, possible_transports=None):
1614
"""Return the branch object for controldir.
1616
:param controldir: A ControlDir that contains a branch.
1617
:param name: Name of colocated branch to open
1618
:param _found: a private parameter, do not use it. It is used to
1619
indicate if format probing has already be done.
1620
:param ignore_fallbacks: when set, no fallback branches will be opened
1621
(if there are any). Default is to open fallbacks.
885
def open(self, a_bzrdir, _found=False):
886
"""Return the branch object for a_bzrdir
888
_found is a private parameter, do not use it. It is used to indicate
889
if format probing has already be done.
1623
891
raise NotImplementedError(self.open)
1625
def supports_set_append_revisions_only(self):
1626
"""True if this format supports set_append_revisions_only."""
1629
def supports_stacking(self):
1630
"""True if this format records a stacked-on branch."""
1633
def supports_leaving_lock(self):
1634
"""True if this format supports leaving locks in place."""
1635
return False # by default
894
def register_format(klass, format):
895
klass._formats[format.get_format_string()] = format
898
def set_default_format(klass, format):
899
klass._default_format = format
902
def unregister_format(klass, format):
903
assert klass._formats[format.get_format_string()] is format
904
del klass._formats[format.get_format_string()]
1637
906
def __str__(self):
1638
return self.get_format_description().rstrip()
907
return self.get_format_string().rstrip()
1640
909
def supports_tags(self):
1641
910
"""True if this format supports tags stored in the branch"""
1642
911
return False # by default
1644
def tags_are_versioned(self):
1645
"""Whether the tag container for this branch versions tags."""
1648
def supports_tags_referencing_ghosts(self):
1649
"""True if tags can reference ghost revisions."""
1652
def supports_store_uncommitted(self):
1653
"""True if uncommitted changes can be stored in this branch."""
913
# XXX: Probably doesn't really belong here -- mbp 20070212
914
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
916
branch_transport = a_bzrdir.get_branch_transport(self)
917
control_files = lockable_files.LockableFiles(branch_transport,
918
lock_filename, lock_class)
919
control_files.create_lock()
920
control_files.lock_write()
922
for filename, content in utf8_files:
923
control_files.put_utf8(filename, content)
925
control_files.unlock()
1657
928
class BranchHooks(Hooks):
1658
929
"""A dictionary mapping hook name to a list of callables for branch hooks.
1660
e.g. ['post_push'] Is the list of items to be called when the
1661
push function is invoked.
931
e.g. ['set_rh'] Is the list of items to be called when the
932
set_revision_history function is invoked.
1664
935
def __init__(self):
1667
938
These are all empty initially, because by default nothing should get
1670
Hooks.__init__(self, "breezy.branch", "Branch.hooks")
1671
self.add_hook('open',
1672
"Called with the Branch object that has been opened after a "
1673
"branch is opened.", (1, 8))
1674
self.add_hook('post_push',
1675
"Called after a push operation completes. post_push is called "
1676
"with a breezy.branch.BranchPushResult object and only runs in the "
1677
"bzr client.", (0, 15))
1678
self.add_hook('post_pull',
1679
"Called after a pull operation completes. post_pull is called "
1680
"with a breezy.branch.PullResult object and only runs in the "
1681
"bzr client.", (0, 15))
1682
self.add_hook('pre_commit',
1683
"Called after a commit is calculated but before it is "
1684
"completed. pre_commit is called with (local, master, old_revno, "
1685
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1686
"). old_revid is NULL_REVISION for the first commit to a branch, "
1687
"tree_delta is a TreeDelta object describing changes from the "
1688
"basis revision. hooks MUST NOT modify this delta. "
1689
" future_tree is an in-memory tree obtained from "
1690
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1692
self.add_hook('post_commit',
1693
"Called in the bzr client after a commit has completed. "
1694
"post_commit is called with (local, master, old_revno, old_revid, "
1695
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1696
"commit to a branch.", (0, 15))
1697
self.add_hook('post_uncommit',
1698
"Called in the bzr client after an uncommit completes. "
1699
"post_uncommit is called with (local, master, old_revno, "
1700
"old_revid, new_revno, new_revid) where local is the local branch "
1701
"or None, master is the target branch, and an empty branch "
1702
"receives new_revno of 0, new_revid of None.", (0, 15))
1703
self.add_hook('pre_change_branch_tip',
1704
"Called in bzr client and server before a change to the tip of a "
1705
"branch is made. pre_change_branch_tip is called with a "
1706
"breezy.branch.ChangeBranchTipParams. Note that push, pull, "
1707
"commit, uncommit will all trigger this hook.", (1, 6))
1708
self.add_hook('post_change_branch_tip',
1709
"Called in bzr client and server after a change to the tip of a "
1710
"branch is made. post_change_branch_tip is called with a "
1711
"breezy.branch.ChangeBranchTipParams. Note that push, pull, "
1712
"commit, uncommit will all trigger this hook.", (1, 4))
1713
self.add_hook('transform_fallback_location',
1714
"Called when a stacked branch is activating its fallback "
1715
"locations. transform_fallback_location is called with (branch, "
1716
"url), and should return a new url. Returning the same url "
1717
"allows it to be used as-is, returning a different one can be "
1718
"used to cause the branch to stack on a closer copy of that "
1719
"fallback_location. Note that the branch cannot have history "
1720
"accessing methods called on it during this hook because the "
1721
"fallback locations have not been activated. When there are "
1722
"multiple hooks installed for transform_fallback_location, "
1723
"all are called with the url returned from the previous hook."
1724
"The order is however undefined.", (1, 9))
1725
self.add_hook('automatic_tag_name',
1726
"Called to determine an automatic tag name for a revision. "
1727
"automatic_tag_name is called with (branch, revision_id) and "
1728
"should return a tag name or None if no tag name could be "
1729
"determined. The first non-None tag name returned will be used.",
1731
self.add_hook('post_branch_init',
1732
"Called after new branch initialization completes. "
1733
"post_branch_init is called with a "
1734
"breezy.branch.BranchInitHookParams. "
1735
"Note that init, branch and checkout (both heavyweight and "
1736
"lightweight) will all trigger this hook.", (2, 2))
1737
self.add_hook('post_switch',
1738
"Called after a checkout switches branch. "
1739
"post_switch is called with a "
1740
"breezy.branch.SwitchHookParams.", (2, 2))
942
# Introduced in 0.15:
943
# invoked whenever the revision history has been set
944
# with set_revision_history. The api signature is
945
# (branch, revision_history), and the branch will
948
# invoked after a push operation completes.
949
# the api signature is
951
# containing the members
952
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
953
# where local is the local branch or None, master is the target
954
# master branch, and the rest should be self explanatory. The source
955
# is read locked and the target branches write locked. Source will
956
# be the local low-latency branch.
957
self['post_push'] = []
958
# invoked after a pull operation completes.
959
# the api signature is
961
# containing the members
962
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
963
# where local is the local branch or None, master is the target
964
# master branch, and the rest should be self explanatory. The source
965
# is read locked and the target branches write locked. The local
966
# branch is the low-latency branch.
967
self['post_pull'] = []
968
# invoked after a commit operation completes.
969
# the api signature is
970
# (local, master, old_revno, old_revid, new_revno, new_revid)
971
# old_revid is NULL_REVISION for the first commit to a branch.
972
self['post_commit'] = []
973
# invoked after a uncommit operation completes.
974
# the api signature is
975
# (local, master, old_revno, old_revid, new_revno, new_revid) where
976
# local is the local branch or None, master is the target branch,
977
# and an empty branch recieves new_revno of 0, new_revid of None.
978
self['post_uncommit'] = []
1744
981
# install the default hooks into the Branch class.
1745
982
Branch.hooks = BranchHooks()
1748
class ChangeBranchTipParams(object):
1749
"""Object holding parameters passed to `*_change_branch_tip` hooks.
1751
There are 5 fields that hooks may wish to access:
1753
:ivar branch: the branch being changed
1754
:ivar old_revno: revision number before the change
1755
:ivar new_revno: revision number after the change
1756
:ivar old_revid: revision id before the change
1757
:ivar new_revid: revision id after the change
1759
The revid fields are strings. The revno fields are integers.
1762
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1763
"""Create a group of ChangeBranchTip parameters.
1765
:param branch: The branch being changed.
1766
:param old_revno: Revision number before the change.
1767
:param new_revno: Revision number after the change.
1768
:param old_revid: Tip revision id before the change.
1769
:param new_revid: Tip revision id after the change.
1771
self.branch = branch
1772
self.old_revno = old_revno
1773
self.new_revno = new_revno
1774
self.old_revid = old_revid
1775
self.new_revid = new_revid
1777
def __eq__(self, other):
1778
return self.__dict__ == other.__dict__
1781
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1782
self.__class__.__name__, self.branch,
1783
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1786
class BranchInitHookParams(object):
1787
"""Object holding parameters passed to `*_branch_init` hooks.
1789
There are 4 fields that hooks may wish to access:
1791
:ivar format: the branch format
1792
:ivar bzrdir: the ControlDir where the branch will be/has been initialized
1793
:ivar name: name of colocated branch, if any (or None)
1794
:ivar branch: the branch created
1796
Note that for lightweight checkouts, the bzrdir and format fields refer to
1797
the checkout, hence they are different from the corresponding fields in
1798
branch, which refer to the original branch.
1801
def __init__(self, format, controldir, name, branch):
1802
"""Create a group of BranchInitHook parameters.
1804
:param format: the branch format
1805
:param controldir: the ControlDir where the branch will be/has been
1807
:param name: name of colocated branch, if any (or None)
1808
:param branch: the branch created
1810
Note that for lightweight checkouts, the bzrdir and format fields refer
1811
to the checkout, hence they are different from the corresponding fields
1812
in branch, which refer to the original branch.
1814
self.format = format
1815
self.controldir = controldir
1817
self.branch = branch
1819
def __eq__(self, other):
1820
return self.__dict__ == other.__dict__
1823
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1826
class SwitchHookParams(object):
1827
"""Object holding parameters passed to `*_switch` hooks.
1829
There are 4 fields that hooks may wish to access:
1831
:ivar control_dir: ControlDir of the checkout to change
1832
:ivar to_branch: branch that the checkout is to reference
1833
:ivar force: skip the check for local commits in a heavy checkout
1834
:ivar revision_id: revision ID to switch to (or None)
1837
def __init__(self, control_dir, to_branch, force, revision_id):
1838
"""Create a group of SwitchHook parameters.
1840
:param control_dir: ControlDir of the checkout to change
1841
:param to_branch: branch that the checkout is to reference
1842
:param force: skip the check for local commits in a heavy checkout
1843
:param revision_id: revision ID to switch to (or None)
1845
self.control_dir = control_dir
1846
self.to_branch = to_branch
1848
self.revision_id = revision_id
1850
def __eq__(self, other):
1851
return self.__dict__ == other.__dict__
1854
return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1855
self.control_dir, self.to_branch,
1859
class BranchFormatRegistry(controldir.ControlComponentFormatRegistry):
1860
"""Branch format registry."""
1862
def __init__(self, other_registry=None):
1863
super(BranchFormatRegistry, self).__init__(other_registry)
1864
self._default_format = None
1865
self._default_format_key = None
1867
def get_default(self):
1868
"""Return the current default format."""
1869
if (self._default_format_key is not None and
1870
self._default_format is None):
1871
self._default_format = self.get(self._default_format_key)
1872
return self._default_format
1874
def set_default(self, format):
1875
"""Set the default format."""
1876
self._default_format = format
1877
self._default_format_key = None
1879
def set_default_key(self, format_string):
1880
"""Set the default format by its format string."""
1881
self._default_format_key = format_string
1882
self._default_format = None
1885
network_format_registry = registry.FormatRegistry()
1886
"""Registry of formats indexed by their network name.
1888
The network name for a branch format is an identifier that can be used when
1889
referring to formats with smart server operations. See
1890
BranchFormat.network_name() for more detail.
1893
format_registry = BranchFormatRegistry(network_format_registry)
985
class BzrBranchFormat4(BranchFormat):
986
"""Bzr branch format 4.
989
- a revision-history file.
990
- a branch-lock lock file [ to be shared with the bzrdir ]
993
def get_format_description(self):
994
"""See BranchFormat.get_format_description()."""
995
return "Branch format 4"
997
def initialize(self, a_bzrdir):
998
"""Create a branch of this format in a_bzrdir."""
999
utf8_files = [('revision-history', ''),
1000
('branch-name', ''),
1002
return self._initialize_helper(a_bzrdir, utf8_files,
1003
lock_type='branch4', set_format=False)
1006
super(BzrBranchFormat4, self).__init__()
1007
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1009
def open(self, a_bzrdir, _found=False):
1010
"""Return the branch object for a_bzrdir
1012
_found is a private parameter, do not use it. It is used to indicate
1013
if format probing has already be done.
1016
# we are being called directly and must probe.
1017
raise NotImplementedError
1018
return BzrBranch(_format=self,
1019
_control_files=a_bzrdir._control_files,
1021
_repository=a_bzrdir.open_repository())
1024
return "Bazaar-NG branch format 4"
1027
class BzrBranchFormat5(BranchFormat):
1028
"""Bzr branch format 5.
1031
- a revision-history file.
1033
- a lock dir guarding the branch itself
1034
- all of this stored in a branch/ subdirectory
1035
- works with shared repositories.
1037
This format is new in bzr 0.8.
1040
def get_format_string(self):
1041
"""See BranchFormat.get_format_string()."""
1042
return "Bazaar-NG branch format 5\n"
1044
def get_format_description(self):
1045
"""See BranchFormat.get_format_description()."""
1046
return "Branch format 5"
1048
def initialize(self, a_bzrdir):
1049
"""Create a branch of this format in a_bzrdir."""
1050
utf8_files = [('revision-history', ''),
1051
('branch-name', ''),
1053
return self._initialize_helper(a_bzrdir, utf8_files)
1056
super(BzrBranchFormat5, self).__init__()
1057
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1059
def open(self, a_bzrdir, _found=False):
1060
"""Return the branch object for a_bzrdir
1062
_found is a private parameter, do not use it. It is used to indicate
1063
if format probing has already be done.
1066
format = BranchFormat.find_format(a_bzrdir)
1067
assert format.__class__ == self.__class__
1069
transport = a_bzrdir.get_branch_transport(None)
1070
control_files = lockable_files.LockableFiles(transport, 'lock',
1072
return BzrBranch5(_format=self,
1073
_control_files=control_files,
1075
_repository=a_bzrdir.find_repository())
1077
raise NotBranchError(path=transport.base)
1080
class BzrBranchFormat6(BzrBranchFormat5):
1081
"""Branch format with last-revision
1083
Unlike previous formats, this has no explicit revision history. Instead,
1084
this just stores the last-revision, and the left-hand history leading
1085
up to there is the history.
1087
This format was introduced in bzr 0.15
1090
def get_format_string(self):
1091
"""See BranchFormat.get_format_string()."""
1092
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1094
def get_format_description(self):
1095
"""See BranchFormat.get_format_description()."""
1096
return "Branch format 6"
1098
def initialize(self, a_bzrdir):
1099
"""Create a branch of this format in a_bzrdir."""
1100
utf8_files = [('last-revision', '0 null:\n'),
1101
('branch-name', ''),
1102
('branch.conf', ''),
1105
return self._initialize_helper(a_bzrdir, utf8_files)
1107
def open(self, a_bzrdir, _found=False):
1108
"""Return the branch object for a_bzrdir
1110
_found is a private parameter, do not use it. It is used to indicate
1111
if format probing has already be done.
1114
format = BranchFormat.find_format(a_bzrdir)
1115
assert format.__class__ == self.__class__
1116
transport = a_bzrdir.get_branch_transport(None)
1117
control_files = lockable_files.LockableFiles(transport, 'lock',
1119
return BzrBranch6(_format=self,
1120
_control_files=control_files,
1122
_repository=a_bzrdir.find_repository())
1124
def supports_tags(self):
1128
class BranchReferenceFormat(BranchFormat):
1129
"""Bzr branch reference format.
1131
Branch references are used in implementing checkouts, they
1132
act as an alias to the real branch which is at some other url.
1139
def get_format_string(self):
1140
"""See BranchFormat.get_format_string()."""
1141
return "Bazaar-NG Branch Reference Format 1\n"
1143
def get_format_description(self):
1144
"""See BranchFormat.get_format_description()."""
1145
return "Checkout reference format 1"
1147
def get_reference(self, a_bzrdir):
1148
"""See BranchFormat.get_reference()."""
1149
transport = a_bzrdir.get_branch_transport(None)
1150
return transport.get('location').read()
1152
def initialize(self, a_bzrdir, target_branch=None):
1153
"""Create a branch of this format in a_bzrdir."""
1154
if target_branch is None:
1155
# this format does not implement branch itself, thus the implicit
1156
# creation contract must see it as uninitializable
1157
raise errors.UninitializableFormat(self)
1158
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1159
branch_transport = a_bzrdir.get_branch_transport(self)
1160
branch_transport.put_bytes('location',
1161
target_branch.bzrdir.root_transport.base)
1162
branch_transport.put_bytes('format', self.get_format_string())
1163
return self.open(a_bzrdir, _found=True)
1166
super(BranchReferenceFormat, self).__init__()
1167
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1169
def _make_reference_clone_function(format, a_branch):
1170
"""Create a clone() routine for a branch dynamically."""
1171
def clone(to_bzrdir, revision_id=None):
1172
"""See Branch.clone()."""
1173
return format.initialize(to_bzrdir, a_branch)
1174
# cannot obey revision_id limits when cloning a reference ...
1175
# FIXME RBC 20060210 either nuke revision_id for clone, or
1176
# emit some sort of warning/error to the caller ?!
1179
def open(self, a_bzrdir, _found=False, location=None):
1180
"""Return the branch that the branch reference in a_bzrdir points at.
1182
_found is a private parameter, do not use it. It is used to indicate
1183
if format probing has already be done.
1186
format = BranchFormat.find_format(a_bzrdir)
1187
assert format.__class__ == self.__class__
1188
if location is None:
1189
location = self.get_reference(a_bzrdir)
1190
real_bzrdir = bzrdir.BzrDir.open(location)
1191
result = real_bzrdir.open_branch()
1192
# this changes the behaviour of result.clone to create a new reference
1193
# rather than a copy of the content of the branch.
1194
# I did not use a proxy object because that needs much more extensive
1195
# testing, and we are only changing one behaviour at the moment.
1196
# If we decide to alter more behaviours - i.e. the implicit nickname
1197
# then this should be refactored to introduce a tested proxy branch
1198
# and a subclass of that for use in overriding clone() and ....
1200
result.clone = self._make_reference_clone_function(result)
1896
1204
# formats which have no format string are not discoverable
1897
1205
# and not independently creatable, so are not registered.
1898
format_registry.register_lazy(
1899
b"Bazaar-NG branch format 5\n", "breezy.bzr.fullhistory",
1901
format_registry.register_lazy(
1902
b"Bazaar Branch Format 6 (bzr 0.15)\n",
1903
"breezy.bzr.branch", "BzrBranchFormat6")
1904
format_registry.register_lazy(
1905
b"Bazaar Branch Format 7 (needs bzr 1.6)\n",
1906
"breezy.bzr.branch", "BzrBranchFormat7")
1907
format_registry.register_lazy(
1908
b"Bazaar Branch Format 8 (needs bzr 1.15)\n",
1909
"breezy.bzr.branch", "BzrBranchFormat8")
1910
format_registry.register_lazy(
1911
b"Bazaar-NG Branch Reference Format 1\n",
1912
"breezy.bzr.branch", "BranchReferenceFormat")
1914
format_registry.set_default_key(b"Bazaar Branch Format 7 (needs bzr 1.6)\n")
1917
class BranchWriteLockResult(LogicalLockResult):
1918
"""The result of write locking a branch.
1920
:ivar token: The token obtained from the underlying branch lock, or
1922
:ivar unlock: A callable which will unlock the lock.
1926
return "BranchWriteLockResult(%r, %r)" % (self.unlock, self.token)
1206
__default_format = BzrBranchFormat5()
1207
BranchFormat.register_format(__default_format)
1208
BranchFormat.register_format(BranchReferenceFormat())
1209
BranchFormat.register_format(BzrBranchFormat6())
1210
BranchFormat.set_default_format(__default_format)
1211
_legacy_formats = [BzrBranchFormat4(),
1214
class BzrBranch(Branch):
1215
"""A branch stored in the actual filesystem.
1217
Note that it's "local" in the context of the filesystem; it doesn't
1218
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1219
it's writable, and can be accessed via the normal filesystem API.
1222
def __init__(self, _format=None,
1223
_control_files=None, a_bzrdir=None, _repository=None):
1224
"""Create new branch object at a particular location."""
1225
Branch.__init__(self)
1226
if a_bzrdir is None:
1227
raise ValueError('a_bzrdir must be supplied')
1229
self.bzrdir = a_bzrdir
1230
# self._transport used to point to the directory containing the
1231
# control directory, but was not used - now it's just the transport
1232
# for the branch control files. mbp 20070212
1233
self._base = self.bzrdir.transport.clone('..').base
1234
self._format = _format
1235
if _control_files is None:
1236
raise ValueError('BzrBranch _control_files is None')
1237
self.control_files = _control_files
1238
self._transport = _control_files._transport
1239
self.repository = _repository
1242
return '%s(%r)' % (self.__class__.__name__, self.base)
1246
def _get_base(self):
1247
"""Returns the directory containing the control directory."""
1250
base = property(_get_base, doc="The URL for the root of this branch.")
1252
def abspath(self, name):
1253
"""See Branch.abspath."""
1254
return self.control_files._transport.abspath(name)
1257
@deprecated_method(zero_sixteen)
1259
def get_root_id(self):
1260
"""See Branch.get_root_id."""
1261
tree = self.repository.revision_tree(self.last_revision())
1262
return tree.inventory.root.file_id
1264
def is_locked(self):
1265
return self.control_files.is_locked()
1267
def lock_write(self, tokens=None):
1268
if tokens is not None:
1269
branch_token, repo_token = tokens
1271
branch_token = repo_token = None
1272
repo_token = self.repository.lock_write(token=repo_token)
1274
branch_token = self.control_files.lock_write(token=branch_token)
1276
self.repository.unlock()
1279
tokens = (branch_token, repo_token)
1280
assert tokens == (None, None) or None not in tokens, (
1281
'Both branch and repository locks must return tokens, or else '
1282
'neither must return tokens. Got %r.' % (tokens,))
1283
if tokens == (None, None):
1288
def lock_read(self):
1289
self.repository.lock_read()
1291
self.control_files.lock_read()
1293
self.repository.unlock()
1297
# TODO: test for failed two phase locks. This is known broken.
1299
self.control_files.unlock()
1301
self.repository.unlock()
1302
if not self.control_files.is_locked():
1303
# we just released the lock
1304
self._clear_cached_state()
1306
def peek_lock_mode(self):
1307
if self.control_files._lock_count == 0:
1310
return self.control_files._lock_mode
1312
def get_physical_lock_status(self):
1313
return self.control_files.get_physical_lock_status()
1316
def print_file(self, file, revision_id):
1317
"""See Branch.print_file."""
1318
return self.repository.print_file(file, revision_id)
1321
def append_revision(self, *revision_ids):
1322
"""See Branch.append_revision."""
1323
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1324
for revision_id in revision_ids:
1325
_mod_revision.check_not_reserved_id(revision_id)
1326
mutter("add {%s} to revision-history" % revision_id)
1327
rev_history = self.revision_history()
1328
rev_history.extend(revision_ids)
1329
self.set_revision_history(rev_history)
1331
def _write_revision_history(self, history):
1332
"""Factored out of set_revision_history.
1334
This performs the actual writing to disk.
1335
It is intended to be called by BzrBranch5.set_revision_history."""
1336
self.control_files.put_bytes(
1337
'revision-history', '\n'.join(history))
1340
def set_revision_history(self, rev_history):
1341
"""See Branch.set_revision_history."""
1342
rev_history = [osutils.safe_revision_id(r) for r in rev_history]
1343
self._write_revision_history(rev_history)
1344
self._cache_revision_history(rev_history)
1345
for hook in Branch.hooks['set_rh']:
1346
hook(self, rev_history)
1349
def set_last_revision_info(self, revno, revision_id):
1350
revision_id = osutils.safe_revision_id(revision_id)
1351
history = self._lefthand_history(revision_id)
1352
assert len(history) == revno, '%d != %d' % (len(history), revno)
1353
self.set_revision_history(history)
1355
def _gen_revision_history(self):
1356
history = self.control_files.get('revision-history').read().split('\n')
1357
if history[-1:] == ['']:
1358
# There shouldn't be a trailing newline, but just in case.
1362
def _lefthand_history(self, revision_id, last_rev=None,
1364
# stop_revision must be a descendant of last_revision
1365
stop_graph = self.repository.get_revision_graph(revision_id)
1366
if last_rev is not None and last_rev not in stop_graph:
1367
# our previous tip is not merged into stop_revision
1368
raise errors.DivergedBranches(self, other_branch)
1369
# make a new revision history from the graph
1370
current_rev_id = revision_id
1372
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1373
new_history.append(current_rev_id)
1374
current_rev_id_parents = stop_graph[current_rev_id]
1376
current_rev_id = current_rev_id_parents[0]
1378
current_rev_id = None
1379
new_history.reverse()
1383
def generate_revision_history(self, revision_id, last_rev=None,
1385
"""Create a new revision history that will finish with revision_id.
1387
:param revision_id: the new tip to use.
1388
:param last_rev: The previous last_revision. If not None, then this
1389
must be a ancestory of revision_id, or DivergedBranches is raised.
1390
:param other_branch: The other branch that DivergedBranches should
1391
raise with respect to.
1393
revision_id = osutils.safe_revision_id(revision_id)
1394
self.set_revision_history(self._lefthand_history(revision_id,
1395
last_rev, other_branch))
1398
def update_revisions(self, other, stop_revision=None):
1399
"""See Branch.update_revisions."""
1402
if stop_revision is None:
1403
stop_revision = other.last_revision()
1404
if stop_revision is None:
1405
# if there are no commits, we're done.
1408
stop_revision = osutils.safe_revision_id(stop_revision)
1409
# whats the current last revision, before we fetch [and change it
1411
last_rev = self.last_revision()
1412
# we fetch here regardless of whether we need to so that we pickup
1414
self.fetch(other, stop_revision)
1415
my_ancestry = self.repository.get_ancestry(last_rev)
1416
if stop_revision in my_ancestry:
1417
# last_revision is a descendant of stop_revision
1419
self.generate_revision_history(stop_revision, last_rev=last_rev,
1424
def basis_tree(self):
1425
"""See Branch.basis_tree."""
1426
return self.repository.revision_tree(self.last_revision())
1428
@deprecated_method(zero_eight)
1429
def working_tree(self):
1430
"""Create a Working tree object for this branch."""
1432
from bzrlib.transport.local import LocalTransport
1433
if (self.base.find('://') != -1 or
1434
not isinstance(self._transport, LocalTransport)):
1435
raise NoWorkingTree(self.base)
1436
return self.bzrdir.open_workingtree()
1439
def pull(self, source, overwrite=False, stop_revision=None,
1440
_hook_master=None, _run_hooks=True):
1443
:param _hook_master: Private parameter - set the branch to
1444
be supplied as the master to push hooks.
1445
:param _run_hooks: Private parameter - allow disabling of
1446
hooks, used when pushing to a master branch.
1448
result = PullResult()
1449
result.source_branch = source
1450
result.target_branch = self
1453
result.old_revno, result.old_revid = self.last_revision_info()
1455
self.update_revisions(source, stop_revision)
1456
except DivergedBranches:
1460
if stop_revision is None:
1461
stop_revision = source.last_revision()
1462
self.generate_revision_history(stop_revision)
1463
result.tag_conflicts = source.tags.merge_to(self.tags)
1464
result.new_revno, result.new_revid = self.last_revision_info()
1466
result.master_branch = _hook_master
1467
result.local_branch = self
1469
result.master_branch = self
1470
result.local_branch = None
1472
for hook in Branch.hooks['post_pull']:
1478
def _get_parent_location(self):
1479
_locs = ['parent', 'pull', 'x-pull']
1482
return self.control_files.get(l).read().strip('\n')
1488
def push(self, target, overwrite=False, stop_revision=None,
1489
_hook_master=None, _run_hooks=True):
1492
:param _hook_master: Private parameter - set the branch to
1493
be supplied as the master to push hooks.
1494
:param _run_hooks: Private parameter - allow disabling of
1495
hooks, used when pushing to a master branch.
1497
result = PushResult()
1498
result.source_branch = self
1499
result.target_branch = target
1502
result.old_revno, result.old_revid = target.last_revision_info()
1504
target.update_revisions(self, stop_revision)
1505
except DivergedBranches:
1509
target.set_revision_history(self.revision_history())
1510
result.tag_conflicts = self.tags.merge_to(target.tags)
1511
result.new_revno, result.new_revid = target.last_revision_info()
1513
result.master_branch = _hook_master
1514
result.local_branch = target
1516
result.master_branch = target
1517
result.local_branch = None
1519
for hook in Branch.hooks['post_push']:
1525
def get_parent(self):
1526
"""See Branch.get_parent."""
1528
assert self.base[-1] == '/'
1529
parent = self._get_parent_location()
1532
# This is an old-format absolute path to a local branch
1533
# turn it into a url
1534
if parent.startswith('/'):
1535
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1537
return urlutils.join(self.base[:-1], parent)
1538
except errors.InvalidURLJoin, e:
1539
raise errors.InaccessibleParent(parent, self.base)
1541
def set_push_location(self, location):
1542
"""See Branch.set_push_location."""
1543
self.get_config().set_user_option(
1544
'push_location', location,
1545
store=_mod_config.STORE_LOCATION_NORECURSE)
1548
def set_parent(self, url):
1549
"""See Branch.set_parent."""
1550
# TODO: Maybe delete old location files?
1551
# URLs should never be unicode, even on the local fs,
1552
# FIXUP this and get_parent in a future branch format bump:
1553
# read and rewrite the file, and have the new format code read
1554
# using .get not .get_utf8. RBC 20060125
1556
if isinstance(url, unicode):
1558
url = url.encode('ascii')
1559
except UnicodeEncodeError:
1560
raise bzrlib.errors.InvalidURL(url,
1561
"Urls must be 7-bit ascii, "
1562
"use bzrlib.urlutils.escape")
1563
url = urlutils.relative_url(self.base, url)
1564
self._set_parent_location(url)
1566
def _set_parent_location(self, url):
1568
self.control_files._transport.delete('parent')
1570
assert isinstance(url, str)
1571
self.control_files.put_bytes('parent', url + '\n')
1573
@deprecated_function(zero_nine)
1574
def tree_config(self):
1575
"""DEPRECATED; call get_config instead.
1576
TreeConfig has become part of BranchConfig."""
1577
return TreeConfig(self)
1580
class BzrBranch5(BzrBranch):
1581
"""A format 5 branch. This supports new features over plan branches.
1583
It has support for a master_branch which is the data for bound branches.
1591
super(BzrBranch5, self).__init__(_format=_format,
1592
_control_files=_control_files,
1594
_repository=_repository)
1597
def pull(self, source, overwrite=False, stop_revision=None,
1599
"""Extends branch.pull to be bound branch aware.
1601
:param _run_hooks: Private parameter used to force hook running
1602
off during bound branch double-pushing.
1604
bound_location = self.get_bound_location()
1605
master_branch = None
1606
if bound_location and source.base != bound_location:
1607
# not pulling from master, so we need to update master.
1608
master_branch = self.get_master_branch()
1609
master_branch.lock_write()
1612
# pull from source into master.
1613
master_branch.pull(source, overwrite, stop_revision,
1615
return super(BzrBranch5, self).pull(source, overwrite,
1616
stop_revision, _hook_master=master_branch,
1617
_run_hooks=_run_hooks)
1620
master_branch.unlock()
1623
def push(self, target, overwrite=False, stop_revision=None):
1624
"""Updates branch.push to be bound branch aware."""
1625
bound_location = target.get_bound_location()
1626
master_branch = None
1627
if bound_location and target.base != bound_location:
1628
# not pushing to master, so we need to update master.
1629
master_branch = target.get_master_branch()
1630
master_branch.lock_write()
1633
# push into the master from this branch.
1634
super(BzrBranch5, self).push(master_branch, overwrite,
1635
stop_revision, _run_hooks=False)
1636
# and push into the target branch from this. Note that we push from
1637
# this branch again, because its considered the highest bandwidth
1639
return super(BzrBranch5, self).push(target, overwrite,
1640
stop_revision, _hook_master=master_branch)
1643
master_branch.unlock()
1645
def get_bound_location(self):
1647
return self.control_files.get_utf8('bound').read()[:-1]
1648
except errors.NoSuchFile:
1652
def get_master_branch(self):
1653
"""Return the branch we are bound to.
1655
:return: Either a Branch, or None
1657
This could memoise the branch, but if thats done
1658
it must be revalidated on each new lock.
1659
So for now we just don't memoise it.
1660
# RBC 20060304 review this decision.
1662
bound_loc = self.get_bound_location()
1666
return Branch.open(bound_loc)
1667
except (errors.NotBranchError, errors.ConnectionError), e:
1668
raise errors.BoundBranchConnectionFailure(
1672
def set_bound_location(self, location):
1673
"""Set the target where this branch is bound to.
1675
:param location: URL to the target branch
1678
self.control_files.put_utf8('bound', location+'\n')
1681
self.control_files._transport.delete('bound')
1687
def bind(self, other):
1688
"""Bind this branch to the branch other.
1690
This does not push or pull data between the branches, though it does
1691
check for divergence to raise an error when the branches are not
1692
either the same, or one a prefix of the other. That behaviour may not
1693
be useful, so that check may be removed in future.
1695
:param other: The branch to bind to
1698
# TODO: jam 20051230 Consider checking if the target is bound
1699
# It is debatable whether you should be able to bind to
1700
# a branch which is itself bound.
1701
# Committing is obviously forbidden,
1702
# but binding itself may not be.
1703
# Since we *have* to check at commit time, we don't
1704
# *need* to check here
1706
# we want to raise diverged if:
1707
# last_rev is not in the other_last_rev history, AND
1708
# other_last_rev is not in our history, and do it without pulling
1710
last_rev = self.last_revision()
1711
if last_rev is not None:
1714
other_last_rev = other.last_revision()
1715
if other_last_rev is not None:
1716
# neither branch is new, we have to do some work to
1717
# ascertain diversion.
1718
remote_graph = other.repository.get_revision_graph(
1720
local_graph = self.repository.get_revision_graph(last_rev)
1721
if (last_rev not in remote_graph and
1722
other_last_rev not in local_graph):
1723
raise errors.DivergedBranches(self, other)
1726
self.set_bound_location(other.base)
1730
"""If bound, unbind"""
1731
return self.set_bound_location(None)
1735
"""Synchronise this branch with the master branch if any.
1737
:return: None or the last_revision that was pivoted out during the
1740
master = self.get_master_branch()
1741
if master is not None:
1742
old_tip = self.last_revision()
1743
self.pull(master, overwrite=True)
1744
if old_tip in self.repository.get_ancestry(self.last_revision()):
1750
class BzrBranchExperimental(BzrBranch5):
1751
"""Bzr experimental branch format
1754
- a revision-history file.
1756
- a lock dir guarding the branch itself
1757
- all of this stored in a branch/ subdirectory
1758
- works with shared repositories.
1759
- a tag dictionary in the branch
1761
This format is new in bzr 0.15, but shouldn't be used for real data,
1764
This class acts as it's own BranchFormat.
1767
_matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1770
def get_format_string(cls):
1771
"""See BranchFormat.get_format_string()."""
1772
return "Bazaar-NG branch format experimental\n"
1775
def get_format_description(cls):
1776
"""See BranchFormat.get_format_description()."""
1777
return "Experimental branch format"
1780
def get_reference(cls, a_bzrdir):
1781
"""Get the target reference of the branch in a_bzrdir.
1783
format probing must have been completed before calling
1784
this method - it is assumed that the format of the branch
1785
in a_bzrdir is correct.
1787
:param a_bzrdir: The bzrdir to get the branch data from.
1788
:return: None if the branch is not a reference branch.
1793
def _initialize_control_files(cls, a_bzrdir, utf8_files, lock_filename,
1795
branch_transport = a_bzrdir.get_branch_transport(cls)
1796
control_files = lockable_files.LockableFiles(branch_transport,
1797
lock_filename, lock_class)
1798
control_files.create_lock()
1799
control_files.lock_write()
1801
for filename, content in utf8_files:
1802
control_files.put_utf8(filename, content)
1804
control_files.unlock()
1807
def initialize(cls, a_bzrdir):
1808
"""Create a branch of this format in a_bzrdir."""
1809
utf8_files = [('format', cls.get_format_string()),
1810
('revision-history', ''),
1811
('branch-name', ''),
1814
cls._initialize_control_files(a_bzrdir, utf8_files,
1815
'lock', lockdir.LockDir)
1816
return cls.open(a_bzrdir, _found=True)
1819
def open(cls, a_bzrdir, _found=False):
1820
"""Return the branch object for a_bzrdir
1822
_found is a private parameter, do not use it. It is used to indicate
1823
if format probing has already be done.
1826
format = BranchFormat.find_format(a_bzrdir)
1827
assert format.__class__ == cls
1828
transport = a_bzrdir.get_branch_transport(None)
1829
control_files = lockable_files.LockableFiles(transport, 'lock',
1831
return cls(_format=cls,
1832
_control_files=control_files,
1834
_repository=a_bzrdir.find_repository())
1837
def is_supported(cls):
1840
def _make_tags(self):
1841
return BasicTags(self)
1844
def supports_tags(cls):
1848
BranchFormat.register_format(BzrBranchExperimental)
1851
class BzrBranch6(BzrBranch5):
1854
def last_revision_info(self):
1855
revision_string = self.control_files.get('last-revision').read()
1856
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1857
revision_id = cache_utf8.get_cached_utf8(revision_id)
1859
return revno, revision_id
1861
def last_revision(self):
1862
"""Return last revision id, or None"""
1863
revision_id = self.last_revision_info()[1]
1864
if revision_id == _mod_revision.NULL_REVISION:
1868
def _write_last_revision_info(self, revno, revision_id):
1869
"""Simply write out the revision id, with no checks.
1871
Use set_last_revision_info to perform this safely.
1873
Does not update the revision_history cache.
1874
Intended to be called by set_last_revision_info and
1875
_write_revision_history.
1877
if revision_id is None:
1878
revision_id = 'null:'
1879
out_string = '%d %s\n' % (revno, revision_id)
1880
self.control_files.put_bytes('last-revision', out_string)
1883
def set_last_revision_info(self, revno, revision_id):
1884
revision_id = osutils.safe_revision_id(revision_id)
1885
if self._get_append_revisions_only():
1886
self._check_history_violation(revision_id)
1887
self._write_last_revision_info(revno, revision_id)
1888
self._clear_cached_state()
1890
def _check_history_violation(self, revision_id):
1891
last_revision = self.last_revision()
1892
if last_revision is None:
1894
if last_revision not in self._lefthand_history(revision_id):
1895
raise errors.AppendRevisionsOnlyViolation(self.base)
1897
def _gen_revision_history(self):
1898
"""Generate the revision history from last revision
1900
history = list(self.repository.iter_reverse_revision_history(
1901
self.last_revision()))
1905
def _write_revision_history(self, history):
1906
"""Factored out of set_revision_history.
1908
This performs the actual writing to disk, with format-specific checks.
1909
It is intended to be called by BzrBranch5.set_revision_history.
1911
if len(history) == 0:
1912
last_revision = 'null:'
1914
if history != self._lefthand_history(history[-1]):
1915
raise errors.NotLefthandHistory(history)
1916
last_revision = history[-1]
1917
if self._get_append_revisions_only():
1918
self._check_history_violation(last_revision)
1919
self._write_last_revision_info(len(history), last_revision)
1922
def append_revision(self, *revision_ids):
1923
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1924
if len(revision_ids) == 0:
1926
prev_revno, prev_revision = self.last_revision_info()
1927
for revision in self.repository.get_revisions(revision_ids):
1928
if prev_revision == _mod_revision.NULL_REVISION:
1929
if revision.parent_ids != []:
1930
raise errors.NotLeftParentDescendant(self, prev_revision,
1931
revision.revision_id)
1933
if revision.parent_ids[0] != prev_revision:
1934
raise errors.NotLeftParentDescendant(self, prev_revision,
1935
revision.revision_id)
1936
prev_revision = revision.revision_id
1937
self.set_last_revision_info(prev_revno + len(revision_ids),
1941
def _set_parent_location(self, url):
1942
"""Set the parent branch"""
1943
self._set_config_location('parent_location', url, make_relative=True)
1946
def _get_parent_location(self):
1947
"""Set the parent branch"""
1948
return self._get_config_location('parent_location')
1950
def set_push_location(self, location):
1951
"""See Branch.set_push_location."""
1952
self._set_config_location('push_location', location)
1954
def set_bound_location(self, location):
1955
"""See Branch.set_push_location."""
1957
config = self.get_config()
1958
if location is None:
1959
if config.get_user_option('bound') != 'True':
1962
config.set_user_option('bound', 'False')
1965
self._set_config_location('bound_location', location,
1967
config.set_user_option('bound', 'True')
1970
def _get_bound_location(self, bound):
1971
"""Return the bound location in the config file.
1973
Return None if the bound parameter does not match"""
1974
config = self.get_config()
1975
config_bound = (config.get_user_option('bound') == 'True')
1976
if config_bound != bound:
1978
return self._get_config_location('bound_location', config=config)
1980
def get_bound_location(self):
1981
"""See Branch.set_push_location."""
1982
return self._get_bound_location(True)
1984
def get_old_bound_location(self):
1985
"""See Branch.get_old_bound_location"""
1986
return self._get_bound_location(False)
1988
def set_append_revisions_only(self, enabled):
1993
self.get_config().set_user_option('append_revisions_only', value)
1995
def _get_append_revisions_only(self):
1996
value = self.get_config().get_user_option('append_revisions_only')
1997
return value == 'True'
1999
def _synchronize_history(self, destination, revision_id):
2000
"""Synchronize last revision and revision history between branches.
2002
This version is most efficient when the destination is also a
2003
BzrBranch6, but works for BzrBranch5, as long as the destination's
2004
repository contains all the lefthand ancestors of the intended
2005
last_revision. If not, set_last_revision_info will fail.
2007
:param destination: The branch to copy the history into
2008
:param revision_id: The revision-id to truncate history at. May
2009
be None to copy complete history.
2011
if revision_id is None:
2012
revno, revision_id = self.last_revision_info()
2014
revno = self.revision_id_to_revno(revision_id)
2015
destination.set_last_revision_info(revno, revision_id)
2017
def _make_tags(self):
2018
return BasicTags(self)
2021
class BranchTestProviderAdapter(object):
2022
"""A tool to generate a suite testing multiple branch formats at once.
2024
This is done by copying the test once for each transport and injecting
2025
the transport_server, transport_readonly_server, and branch_format
2026
classes into each copy. Each copy is also given a new id() to make it
2030
def __init__(self, transport_server, transport_readonly_server, formats,
2031
vfs_transport_factory=None):
2032
self._transport_server = transport_server
2033
self._transport_readonly_server = transport_readonly_server
2034
self._formats = formats
2036
def adapt(self, test):
2037
result = TestSuite()
2038
for branch_format, bzrdir_format in self._formats:
2039
new_test = deepcopy(test)
2040
new_test.transport_server = self._transport_server
2041
new_test.transport_readonly_server = self._transport_readonly_server
2042
new_test.bzrdir_format = bzrdir_format
2043
new_test.branch_format = branch_format
2044
def make_new_test_id():
2045
# the format can be either a class or an instance
2046
name = getattr(branch_format, '__name__',
2047
branch_format.__class__.__name__)
2048
new_id = "%s(%s)" % (new_test.id(), name)
2049
return lambda: new_id
2050
new_test.id = make_new_test_id()
2051
result.addTest(new_test)
1929
2055
######################################################################
2020
2124
def __init__(self, branch):
2021
2125
self.branch = branch
2024
2127
def report_results(self, verbose):
2025
2128
"""Report the check results via trace.note.
2027
2130
:param verbose: Requests more detailed display of what was checked,
2030
note(gettext('checked branch {0} format {1}').format(
2031
self.branch.user_url, self.branch._format))
2032
for error in self.errors:
2033
note(gettext('found error:%s'), error)
2036
class InterBranch(InterObject):
2037
"""This class represents operations taking place between two branches.
2039
Its instances have methods like pull() and push() and contain
2040
references to the source and target repositories these operations
2041
can be carried out on.
2045
"""The available optimised InterBranch types."""
2048
def _get_branch_formats_to_test(klass):
2049
"""Return an iterable of format tuples for testing.
2051
:return: An iterable of (from_format, to_format) to use when testing
2052
this InterBranch class. Each InterBranch class should define this
2055
raise NotImplementedError(klass._get_branch_formats_to_test)
2057
def pull(self, overwrite=False, stop_revision=None,
2058
possible_transports=None, local=False):
2059
"""Mirror source into target branch.
2061
The target branch is considered to be 'local', having low latency.
2063
:returns: PullResult instance
2065
raise NotImplementedError(self.pull)
2067
def push(self, overwrite=False, stop_revision=None, lossy=False,
2068
_override_hook_source_branch=None):
2069
"""Mirror the source branch into the target branch.
2071
The source branch is considered to be 'local', having low latency.
2073
raise NotImplementedError(self.push)
2075
def copy_content_into(self, revision_id=None):
2076
"""Copy the content of source into target
2078
revision_id: if not None, the revision history in the new branch will
2079
be truncated to end with revision_id.
2081
raise NotImplementedError(self.copy_content_into)
2083
def fetch(self, stop_revision=None, limit=None):
2086
:param stop_revision: Last revision to fetch
2087
:param limit: Optional rough limit of revisions to fetch
2089
raise NotImplementedError(self.fetch)
2092
def _fix_overwrite_type(overwrite):
2093
if isinstance(overwrite, bool):
2095
return ["history", "tags"]
2101
class GenericInterBranch(InterBranch):
2102
"""InterBranch implementation that uses public Branch functions."""
2105
def is_compatible(klass, source, target):
2106
# GenericBranch uses the public API, so always compatible
2110
def _get_branch_formats_to_test(klass):
2111
return [(format_registry.get_default(), format_registry.get_default())]
2114
def unwrap_format(klass, format):
2115
if isinstance(format, remote.RemoteBranchFormat):
2116
format._ensure_real()
2117
return format._custom_format
2120
def copy_content_into(self, revision_id=None):
2121
"""Copy the content of source into target
2123
revision_id: if not None, the revision history in the new branch will
2124
be truncated to end with revision_id.
2126
with self.source.lock_read(), self.target.lock_write():
2127
self.source.update_references(self.target)
2128
self.source._synchronize_history(self.target, revision_id)
2130
parent = self.source.get_parent()
2131
except errors.InaccessibleParent as e:
2132
mutter('parent was not accessible to copy: %s', str(e))
2135
self.target.set_parent(parent)
2136
if self.source._push_should_merge_tags():
2137
self.source.tags.merge_to(self.target.tags)
2139
def fetch(self, stop_revision=None, limit=None):
2140
if self.target.base == self.source.base:
2142
with self.source.lock_read(), self.target.lock_write():
2143
fetch_spec_factory = fetch.FetchSpecFactory()
2144
fetch_spec_factory.source_branch = self.source
2145
fetch_spec_factory.source_branch_stop_revision_id = stop_revision
2146
fetch_spec_factory.source_repo = self.source.repository
2147
fetch_spec_factory.target_repo = self.target.repository
2148
fetch_spec_factory.target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
2149
fetch_spec_factory.limit = limit
2150
fetch_spec = fetch_spec_factory.make_fetch_spec()
2151
return self.target.repository.fetch(
2152
self.source.repository,
2153
fetch_spec=fetch_spec)
2155
def _update_revisions(self, stop_revision=None, overwrite=False,
2157
with self.source.lock_read(), self.target.lock_write():
2158
other_revno, other_last_revision = self.source.last_revision_info()
2159
stop_revno = None # unknown
2160
if stop_revision is None:
2161
stop_revision = other_last_revision
2162
if _mod_revision.is_null(stop_revision):
2163
# if there are no commits, we're done.
2165
stop_revno = other_revno
2167
# what's the current last revision, before we fetch [and change it
2169
last_rev = _mod_revision.ensure_null(self.target.last_revision())
2170
# we fetch here so that we don't process data twice in the common
2171
# case of having something to pull, and so that the check for
2172
# already merged can operate on the just fetched graph, which will
2173
# be cached in memory.
2174
self.fetch(stop_revision=stop_revision)
2175
# Check to see if one is an ancestor of the other
2178
graph = self.target.repository.get_graph()
2179
if self.target._check_if_descendant_or_diverged(
2180
stop_revision, last_rev, graph, self.source):
2181
# stop_revision is a descendant of last_rev, but we aren't
2182
# overwriting, so we're done.
2184
if stop_revno is None:
2186
graph = self.target.repository.get_graph()
2187
this_revno, this_last_revision = \
2188
self.target.last_revision_info()
2189
stop_revno = graph.find_distance_to_null(stop_revision,
2190
[(other_last_revision, other_revno),
2191
(this_last_revision, this_revno)])
2192
self.target.set_last_revision_info(stop_revno, stop_revision)
2194
def pull(self, overwrite=False, stop_revision=None,
2195
possible_transports=None, run_hooks=True,
2196
_override_hook_target=None, local=False):
2197
"""Pull from source into self, updating my master if any.
2199
:param run_hooks: Private parameter - if false, this branch
2200
is being called because it's the master of the primary branch,
2201
so it should not run its hooks.
2203
with self.target.lock_write():
2204
bound_location = self.target.get_bound_location()
2205
if local and not bound_location:
2206
raise errors.LocalRequiresBoundBranch()
2207
master_branch = None
2208
source_is_master = False
2210
# bound_location comes from a config file, some care has to be
2211
# taken to relate it to source.user_url
2212
normalized = urlutils.normalize_url(bound_location)
2214
relpath = self.source.user_transport.relpath(normalized)
2215
source_is_master = (relpath == '')
2216
except (errors.PathNotChild, urlutils.InvalidURL):
2217
source_is_master = False
2218
if not local and bound_location and not source_is_master:
2219
# not pulling from master, so we need to update master.
2220
master_branch = self.target.get_master_branch(possible_transports)
2221
master_branch.lock_write()
2224
# pull from source into master.
2225
master_branch.pull(self.source, overwrite, stop_revision,
2227
return self._pull(overwrite,
2228
stop_revision, _hook_master=master_branch,
2229
run_hooks=run_hooks,
2230
_override_hook_target=_override_hook_target,
2231
merge_tags_to_master=not source_is_master)
2234
master_branch.unlock()
2236
def push(self, overwrite=False, stop_revision=None, lossy=False,
2237
_override_hook_source_branch=None):
2238
"""See InterBranch.push.
2240
This is the basic concrete implementation of push()
2242
:param _override_hook_source_branch: If specified, run the hooks
2243
passing this Branch as the source, rather than self. This is for
2244
use of RemoteBranch, where push is delegated to the underlying
2248
raise errors.LossyPushToSameVCS(self.source, self.target)
2249
# TODO: Public option to disable running hooks - should be trivial but
2252
if _override_hook_source_branch:
2253
result.source_branch = _override_hook_source_branch
2254
for hook in Branch.hooks['post_push']:
2257
with self.source.lock_read(), self.target.lock_write():
2258
bound_location = self.target.get_bound_location()
2259
if bound_location and self.target.base != bound_location:
2260
# there is a master branch.
2262
# XXX: Why the second check? Is it even supported for a branch to
2263
# be bound to itself? -- mbp 20070507
2264
master_branch = self.target.get_master_branch()
2265
with master_branch.lock_write():
2266
# push into the master from the source branch.
2267
master_inter = InterBranch.get(self.source, master_branch)
2268
master_inter._basic_push(overwrite, stop_revision)
2269
# and push into the target branch from the source. Note that
2270
# we push from the source branch again, because it's considered
2271
# the highest bandwidth repository.
2272
result = self._basic_push(overwrite, stop_revision)
2273
result.master_branch = master_branch
2274
result.local_branch = self.target
2277
master_branch = None
2279
result = self._basic_push(overwrite, stop_revision)
2280
# TODO: Why set master_branch and local_branch if there's no
2281
# binding? Maybe cleaner to just leave them unset? -- mbp
2283
result.master_branch = self.target
2284
result.local_branch = None
2288
def _basic_push(self, overwrite, stop_revision):
2289
"""Basic implementation of push without bound branches or hooks.
2291
Must be called with source read locked and target write locked.
2293
result = BranchPushResult()
2294
result.source_branch = self.source
2295
result.target_branch = self.target
2296
result.old_revno, result.old_revid = self.target.last_revision_info()
2297
self.source.update_references(self.target)
2298
overwrite = _fix_overwrite_type(overwrite)
2299
if result.old_revid != stop_revision:
2300
# We assume that during 'push' this repository is closer than
2302
graph = self.source.repository.get_graph(self.target.repository)
2303
self._update_revisions(stop_revision,
2304
overwrite=("history" in overwrite),
2306
if self.source._push_should_merge_tags():
2307
result.tag_updates, result.tag_conflicts = (
2308
self.source.tags.merge_to(
2309
self.target.tags, "tags" in overwrite))
2310
result.new_revno, result.new_revid = self.target.last_revision_info()
2313
def _pull(self, overwrite=False, stop_revision=None,
2314
possible_transports=None, _hook_master=None, run_hooks=True,
2315
_override_hook_target=None, local=False,
2316
merge_tags_to_master=True):
2319
This function is the core worker, used by GenericInterBranch.pull to
2320
avoid duplication when pulling source->master and source->local.
2322
:param _hook_master: Private parameter - set the branch to
2323
be supplied as the master to pull hooks.
2324
:param run_hooks: Private parameter - if false, this branch
2325
is being called because it's the master of the primary branch,
2326
so it should not run its hooks.
2327
is being called because it's the master of the primary branch,
2328
so it should not run its hooks.
2329
:param _override_hook_target: Private parameter - set the branch to be
2330
supplied as the target_branch to pull hooks.
2331
:param local: Only update the local branch, and not the bound branch.
2333
# This type of branch can't be bound.
2335
raise errors.LocalRequiresBoundBranch()
2336
result = PullResult()
2337
result.source_branch = self.source
2338
if _override_hook_target is None:
2339
result.target_branch = self.target
2341
result.target_branch = _override_hook_target
2342
with self.source.lock_read():
2343
# We assume that during 'pull' the target repository is closer than
2345
self.source.update_references(self.target)
2346
graph = self.target.repository.get_graph(self.source.repository)
2347
# TODO: Branch formats should have a flag that indicates
2348
# that revno's are expensive, and pull() should honor that flag.
2350
result.old_revno, result.old_revid = \
2351
self.target.last_revision_info()
2352
overwrite = _fix_overwrite_type(overwrite)
2353
self._update_revisions(stop_revision,
2354
overwrite=("history" in overwrite),
2356
# TODO: The old revid should be specified when merging tags,
2357
# so a tags implementation that versions tags can only
2358
# pull in the most recent changes. -- JRV20090506
2359
result.tag_updates, result.tag_conflicts = (
2360
self.source.tags.merge_to(self.target.tags,
2361
"tags" in overwrite,
2362
ignore_master=not merge_tags_to_master))
2363
result.new_revno, result.new_revid = self.target.last_revision_info()
2365
result.master_branch = _hook_master
2366
result.local_branch = result.target_branch
2368
result.master_branch = result.target_branch
2369
result.local_branch = None
2371
for hook in Branch.hooks['post_pull']:
2376
InterBranch.register_optimiser(GenericInterBranch)
2133
note('checked branch %s format %s',
2135
self.branch._format)
2138
class Converter5to6(object):
2139
"""Perform an in-place upgrade of format 5 to format 6"""
2141
def convert(self, branch):
2142
# Data for 5 and 6 can peacefully coexist.
2143
format = BzrBranchFormat6()
2144
new_branch = format.open(branch.bzrdir, _found=True)
2146
# Copy source data into target
2147
new_branch.set_last_revision_info(*branch.last_revision_info())
2148
new_branch.set_parent(branch.get_parent())
2149
new_branch.set_bound_location(branch.get_bound_location())
2150
new_branch.set_push_location(branch.get_push_location())
2152
# New branch has no tags by default
2153
new_branch.tags._set_tag_dict({})
2155
# Copying done; now update target format
2156
new_branch.control_files.put_utf8('format',
2157
format.get_format_string())
2159
# Clean up old files
2160
new_branch.control_files._transport.delete('revision-history')
2162
branch.set_parent(None)
2165
branch.set_bound_location(None)
added
removed
bzrlib/branch.py
