1
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
from bzrlib.lazy_import import lazy_import
19
lazy_import(globals(), """
23
config as _mod_config,
29
revision as _mod_revision,
35
from bzrlib.config import BranchConfig
36
from bzrlib.repofmt.pack_repo import RepositoryFormatPackDevelopment1Subtree
37
from bzrlib.tag import (
43
from bzrlib.decorators import needs_read_lock, needs_write_lock
44
from bzrlib.hooks import Hooks
45
from bzrlib.symbol_versioning import (
49
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
52
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
53
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
54
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
57
# TODO: Maybe include checks for common corruption of newlines, etc?
59
# TODO: Some operations like log might retrieve the same revisions
60
# repeatedly to calculate deltas. We could perhaps have a weakref
61
# cache in memory to make this faster. In general anything can be
62
# cached in memory between lock and unlock operations. .. nb thats
63
# what the transaction identity map provides
66
######################################################################
70
"""Branch holding a history of revisions.
73
Base directory/url of the branch.
75
hooks: An instance of BranchHooks.
77
# this is really an instance variable - FIXME move it there
81
# override this to set the strategy for storing tags
83
return DisabledTags(self)
85
def __init__(self, *ignored, **ignored_too):
86
self.tags = self._make_tags()
87
self._revision_history_cache = None
88
self._revision_id_to_revno_cache = None
91
"""Break a lock if one is present from another instance.
93
Uses the ui factory to ask for confirmation if the lock may be from
96
This will probe the repository for its lock as well.
98
self.control_files.break_lock()
99
self.repository.break_lock()
100
master = self.get_master_branch()
101
if master is not None:
105
def open(base, _unsupported=False, possible_transports=None):
106
"""Open the branch rooted at base.
108
For instance, if the branch is at URL/.bzr/branch,
109
Branch.open(URL) -> a Branch instance.
111
control = bzrdir.BzrDir.open(base, _unsupported,
112
possible_transports=possible_transports)
113
return control.open_branch(_unsupported)
116
def open_from_transport(transport, _unsupported=False):
117
"""Open the branch rooted at transport"""
118
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
119
return control.open_branch(_unsupported)
122
def open_containing(url, possible_transports=None):
123
"""Open an existing branch which contains url.
125
This probes for a branch at url, and searches upwards from there.
127
Basically we keep looking up until we find the control directory or
128
run into the root. If there isn't one, raises NotBranchError.
129
If there is one and it is either an unrecognised format or an unsupported
130
format, UnknownFormatError or UnsupportedFormatError are raised.
131
If there is one, it is returned, along with the unused portion of url.
133
control, relpath = bzrdir.BzrDir.open_containing(url,
135
return control.open_branch(), relpath
137
def get_config(self):
138
return BranchConfig(self)
141
return self.get_config().get_nickname()
143
def _set_nick(self, nick):
144
self.get_config().set_user_option('nickname', nick, warn_masked=True)
146
nick = property(_get_nick, _set_nick)
149
raise NotImplementedError(self.is_locked)
151
def lock_write(self):
152
raise NotImplementedError(self.lock_write)
155
raise NotImplementedError(self.lock_read)
158
raise NotImplementedError(self.unlock)
160
def peek_lock_mode(self):
161
"""Return lock mode for the Branch: 'r', 'w' or None"""
162
raise NotImplementedError(self.peek_lock_mode)
164
def get_physical_lock_status(self):
165
raise NotImplementedError(self.get_physical_lock_status)
168
def get_revision_id_to_revno_map(self):
169
"""Return the revision_id => dotted revno map.
171
This will be regenerated on demand, but will be cached.
173
:return: A dictionary mapping revision_id => dotted revno.
174
This dictionary should not be modified by the caller.
176
if self._revision_id_to_revno_cache is not None:
177
mapping = self._revision_id_to_revno_cache
179
mapping = self._gen_revno_map()
180
self._cache_revision_id_to_revno(mapping)
181
# TODO: jam 20070417 Since this is being cached, should we be returning
183
# I would rather not, and instead just declare that users should not
184
# modify the return value.
187
def _gen_revno_map(self):
188
"""Create a new mapping from revision ids to dotted revnos.
190
Dotted revnos are generated based on the current tip in the revision
192
This is the worker function for get_revision_id_to_revno_map, which
193
just caches the return value.
195
:return: A dictionary mapping revision_id => dotted revno.
197
last_revision = self.last_revision()
198
revision_graph = repository._old_get_graph(self.repository,
200
merge_sorted_revisions = tsort.merge_sort(
205
revision_id_to_revno = dict((rev_id, revno)
206
for seq_num, rev_id, depth, revno, end_of_merge
207
in merge_sorted_revisions)
208
return revision_id_to_revno
210
def leave_lock_in_place(self):
211
"""Tell this branch object not to release the physical lock when this
214
If lock_write doesn't return a token, then this method is not supported.
216
self.control_files.leave_in_place()
218
def dont_leave_lock_in_place(self):
219
"""Tell this branch object to release the physical lock when this
220
object is unlocked, even if it didn't originally acquire it.
222
If lock_write doesn't return a token, then this method is not supported.
224
self.control_files.dont_leave_in_place()
226
@deprecated_method(deprecated_in((0, 16, 0)))
227
def abspath(self, name):
228
"""Return absolute filename for something in the branch
230
XXX: Robert Collins 20051017 what is this used for? why is it a branch
231
method and not a tree method.
233
raise NotImplementedError(self.abspath)
235
def bind(self, other):
236
"""Bind the local branch the other branch.
238
:param other: The branch to bind to
241
raise errors.UpgradeRequired(self.base)
244
def fetch(self, from_branch, last_revision=None, pb=None):
245
"""Copy revisions from from_branch into this branch.
247
:param from_branch: Where to copy from.
248
:param last_revision: What revision to stop at (None for at the end
250
:param pb: An optional progress bar to use.
252
Returns the copied revision count and the failed revisions in a tuple:
255
if self.base == from_branch.base:
258
nested_pb = ui.ui_factory.nested_progress_bar()
263
from_branch.lock_read()
265
if last_revision is None:
266
pb.update('get source history')
267
last_revision = from_branch.last_revision()
268
last_revision = _mod_revision.ensure_null(last_revision)
269
return self.repository.fetch(from_branch.repository,
270
revision_id=last_revision,
273
if nested_pb is not None:
277
def get_bound_location(self):
278
"""Return the URL of the branch we are bound to.
280
Older format branches cannot bind, please be sure to use a metadir
285
def get_old_bound_location(self):
286
"""Return the URL of the branch we used to be bound to
288
raise errors.UpgradeRequired(self.base)
290
def get_commit_builder(self, parents, config=None, timestamp=None,
291
timezone=None, committer=None, revprops=None,
293
"""Obtain a CommitBuilder for this branch.
295
:param parents: Revision ids of the parents of the new revision.
296
:param config: Optional configuration to use.
297
:param timestamp: Optional timestamp recorded for commit.
298
:param timezone: Optional timezone for timestamp.
299
:param committer: Optional committer to set for commit.
300
:param revprops: Optional dictionary of revision properties.
301
:param revision_id: Optional revision id.
305
config = self.get_config()
307
return self.repository.get_commit_builder(self, parents, config,
308
timestamp, timezone, committer, revprops, revision_id)
310
def get_master_branch(self, possible_transports=None):
311
"""Return the branch we are bound to.
313
:return: Either a Branch, or None
317
def get_revision_delta(self, revno):
318
"""Return the delta for one revision.
320
The delta is relative to its mainline predecessor, or the
321
empty tree for revision 1.
323
rh = self.revision_history()
324
if not (1 <= revno <= len(rh)):
325
raise errors.InvalidRevisionNumber(revno)
326
return self.repository.get_revision_delta(rh[revno-1])
328
def print_file(self, file, revision_id):
329
"""Print `file` to stdout."""
330
raise NotImplementedError(self.print_file)
332
def set_revision_history(self, rev_history):
333
raise NotImplementedError(self.set_revision_history)
335
def _cache_revision_history(self, rev_history):
336
"""Set the cached revision history to rev_history.
338
The revision_history method will use this cache to avoid regenerating
339
the revision history.
341
This API is semi-public; it only for use by subclasses, all other code
342
should consider it to be private.
344
self._revision_history_cache = rev_history
346
def _cache_revision_id_to_revno(self, revision_id_to_revno):
347
"""Set the cached revision_id => revno map to revision_id_to_revno.
349
This API is semi-public; it only for use by subclasses, all other code
350
should consider it to be private.
352
self._revision_id_to_revno_cache = revision_id_to_revno
354
def _clear_cached_state(self):
355
"""Clear any cached data on this branch, e.g. cached revision history.
357
This means the next call to revision_history will need to call
358
_gen_revision_history.
360
This API is semi-public; it only for use by subclasses, all other code
361
should consider it to be private.
363
self._revision_history_cache = None
364
self._revision_id_to_revno_cache = None
366
def _gen_revision_history(self):
367
"""Return sequence of revision hashes on to this branch.
369
Unlike revision_history, this method always regenerates or rereads the
370
revision history, i.e. it does not cache the result, so repeated calls
373
Concrete subclasses should override this instead of revision_history so
374
that subclasses do not need to deal with caching logic.
376
This API is semi-public; it only for use by subclasses, all other code
377
should consider it to be private.
379
raise NotImplementedError(self._gen_revision_history)
382
def revision_history(self):
383
"""Return sequence of revision ids on this branch.
385
This method will cache the revision history for as long as it is safe to
388
if 'evil' in debug.debug_flags:
389
mutter_callsite(3, "revision_history scales with history.")
390
if self._revision_history_cache is not None:
391
history = self._revision_history_cache
393
history = self._gen_revision_history()
394
self._cache_revision_history(history)
398
"""Return current revision number for this branch.
400
That is equivalent to the number of revisions committed to
403
return self.last_revision_info()[0]
406
"""Older format branches cannot bind or unbind."""
407
raise errors.UpgradeRequired(self.base)
409
def set_append_revisions_only(self, enabled):
410
"""Older format branches are never restricted to append-only"""
411
raise errors.UpgradeRequired(self.base)
413
def last_revision(self):
414
"""Return last revision id, or NULL_REVISION."""
415
return self.last_revision_info()[1]
417
def last_revision_info(self):
418
"""Return information about the last revision.
420
:return: A tuple (revno, last_revision_id).
422
rh = self.revision_history()
425
return (revno, rh[-1])
427
return (0, _mod_revision.NULL_REVISION)
429
@deprecated_method(deprecated_in((1, 6, 0)))
430
def missing_revisions(self, other, stop_revision=None):
431
"""Return a list of new revisions that would perfectly fit.
433
If self and other have not diverged, return a list of the revisions
434
present in other, but missing from self.
436
self_history = self.revision_history()
437
self_len = len(self_history)
438
other_history = other.revision_history()
439
other_len = len(other_history)
440
common_index = min(self_len, other_len) -1
441
if common_index >= 0 and \
442
self_history[common_index] != other_history[common_index]:
443
raise errors.DivergedBranches(self, other)
445
if stop_revision is None:
446
stop_revision = other_len
448
if stop_revision > other_len:
449
raise errors.NoSuchRevision(self, stop_revision)
450
return other_history[self_len:stop_revision]
452
def update_revisions(self, other, stop_revision=None, overwrite=False,
454
"""Pull in new perfect-fit revisions.
456
:param other: Another Branch to pull from
457
:param stop_revision: Updated until the given revision
458
:param overwrite: Always set the branch pointer, rather than checking
459
to see if it is a proper descendant.
460
:param graph: A Graph object that can be used to query history
461
information. This can be None.
464
raise NotImplementedError(self.update_revisions)
466
def revision_id_to_revno(self, revision_id):
467
"""Given a revision id, return its revno"""
468
if _mod_revision.is_null(revision_id):
470
history = self.revision_history()
472
return history.index(revision_id) + 1
474
raise errors.NoSuchRevision(self, revision_id)
476
def get_rev_id(self, revno, history=None):
477
"""Find the revision id of the specified revno."""
479
return _mod_revision.NULL_REVISION
481
history = self.revision_history()
482
if revno <= 0 or revno > len(history):
483
raise errors.NoSuchRevision(self, revno)
484
return history[revno - 1]
486
def pull(self, source, overwrite=False, stop_revision=None,
487
possible_transports=None):
488
"""Mirror source into this branch.
490
This branch is considered to be 'local', having low latency.
492
:returns: PullResult instance
494
raise NotImplementedError(self.pull)
496
def push(self, target, overwrite=False, stop_revision=None):
497
"""Mirror this branch into target.
499
This branch is considered to be 'local', having low latency.
501
raise NotImplementedError(self.push)
503
def basis_tree(self):
504
"""Return `Tree` object for last revision."""
505
return self.repository.revision_tree(self.last_revision())
507
def rename_one(self, from_rel, to_rel):
510
This can change the directory or the filename or both.
512
raise NotImplementedError(self.rename_one)
514
def move(self, from_paths, to_name):
517
to_name must exist as a versioned directory.
519
If to_name exists and is a directory, the files are moved into
520
it, keeping their old names. If it is a directory,
522
Note that to_name is only the last component of the new name;
523
this doesn't change the directory.
525
This returns a list of (from_path, to_path) pairs for each
528
raise NotImplementedError(self.move)
530
def get_parent(self):
531
"""Return the parent location of the branch.
533
This is the default location for push/pull/missing. The usual
534
pattern is that the user can override it by specifying a
537
raise NotImplementedError(self.get_parent)
539
def _set_config_location(self, name, url, config=None,
540
make_relative=False):
542
config = self.get_config()
546
url = urlutils.relative_url(self.base, url)
547
config.set_user_option(name, url, warn_masked=True)
549
def _get_config_location(self, name, config=None):
551
config = self.get_config()
552
location = config.get_user_option(name)
557
def get_submit_branch(self):
558
"""Return the submit location of the branch.
560
This is the default location for bundle. The usual
561
pattern is that the user can override it by specifying a
564
return self.get_config().get_user_option('submit_branch')
566
def set_submit_branch(self, location):
567
"""Return the submit location of the branch.
569
This is the default location for bundle. The usual
570
pattern is that the user can override it by specifying a
573
self.get_config().set_user_option('submit_branch', location,
576
def get_public_branch(self):
577
"""Return the public location of the branch.
579
This is is used by merge directives.
581
return self._get_config_location('public_branch')
583
def set_public_branch(self, location):
584
"""Return the submit location of the branch.
586
This is the default location for bundle. The usual
587
pattern is that the user can override it by specifying a
590
self._set_config_location('public_branch', location)
592
def get_push_location(self):
593
"""Return the None or the location to push this branch to."""
594
push_loc = self.get_config().get_user_option('push_location')
597
def set_push_location(self, location):
598
"""Set a new push location for this branch."""
599
raise NotImplementedError(self.set_push_location)
601
def set_parent(self, url):
602
raise NotImplementedError(self.set_parent)
606
"""Synchronise this branch with the master branch if any.
608
:return: None or the last_revision pivoted out during the update.
612
def check_revno(self, revno):
614
Check whether a revno corresponds to any revision.
615
Zero (the NULL revision) is considered valid.
618
self.check_real_revno(revno)
620
def check_real_revno(self, revno):
622
Check whether a revno corresponds to a real revision.
623
Zero (the NULL revision) is considered invalid
625
if revno < 1 or revno > self.revno():
626
raise errors.InvalidRevisionNumber(revno)
629
def clone(self, to_bzrdir, revision_id=None):
630
"""Clone this branch into to_bzrdir preserving all semantic values.
632
revision_id: if not None, the revision history in the new branch will
633
be truncated to end with revision_id.
635
result = self._format.initialize(to_bzrdir)
636
self.copy_content_into(result, revision_id=revision_id)
640
def sprout(self, to_bzrdir, revision_id=None):
641
"""Create a new line of development from the branch, into to_bzrdir.
643
revision_id: if not None, the revision history in the new branch will
644
be truncated to end with revision_id.
646
result = self._format.initialize(to_bzrdir)
647
self.copy_content_into(result, revision_id=revision_id)
648
result.set_parent(self.bzrdir.root_transport.base)
651
def _synchronize_history(self, destination, revision_id):
652
"""Synchronize last revision and revision history between branches.
654
This version is most efficient when the destination is also a
655
BzrBranch5, but works for BzrBranch6 as long as the revision
656
history is the true lefthand parent history, and all of the revisions
657
are in the destination's repository. If not, set_revision_history
660
:param destination: The branch to copy the history into
661
:param revision_id: The revision-id to truncate history at. May
662
be None to copy complete history.
664
if revision_id == _mod_revision.NULL_REVISION:
666
new_history = self.revision_history()
667
if revision_id is not None and new_history != []:
669
new_history = new_history[:new_history.index(revision_id) + 1]
671
rev = self.repository.get_revision(revision_id)
672
new_history = rev.get_history(self.repository)[1:]
673
destination.set_revision_history(new_history)
676
def copy_content_into(self, destination, revision_id=None):
677
"""Copy the content of self into destination.
679
revision_id: if not None, the revision history in the new branch will
680
be truncated to end with revision_id.
682
self._synchronize_history(destination, revision_id)
684
parent = self.get_parent()
685
except errors.InaccessibleParent, e:
686
mutter('parent was not accessible to copy: %s', e)
689
destination.set_parent(parent)
690
self.tags.merge_to(destination.tags)
694
"""Check consistency of the branch.
696
In particular this checks that revisions given in the revision-history
697
do actually match up in the revision graph, and that they're all
698
present in the repository.
700
Callers will typically also want to check the repository.
702
:return: A BranchCheckResult.
704
mainline_parent_id = None
705
last_revno, last_revision_id = self.last_revision_info()
706
real_rev_history = list(self.repository.iter_reverse_revision_history(
708
real_rev_history.reverse()
709
if len(real_rev_history) != last_revno:
710
raise errors.BzrCheckError('revno does not match len(mainline)'
711
' %s != %s' % (last_revno, len(real_rev_history)))
712
# TODO: We should probably also check that real_rev_history actually
713
# matches self.revision_history()
714
for revision_id in real_rev_history:
716
revision = self.repository.get_revision(revision_id)
717
except errors.NoSuchRevision, e:
718
raise errors.BzrCheckError("mainline revision {%s} not in repository"
720
# In general the first entry on the revision history has no parents.
721
# But it's not illegal for it to have parents listed; this can happen
722
# in imports from Arch when the parents weren't reachable.
723
if mainline_parent_id is not None:
724
if mainline_parent_id not in revision.parent_ids:
725
raise errors.BzrCheckError("previous revision {%s} not listed among "
727
% (mainline_parent_id, revision_id))
728
mainline_parent_id = revision_id
729
return BranchCheckResult(self)
731
def _get_checkout_format(self):
732
"""Return the most suitable metadir for a checkout of this branch.
733
Weaves are used if this branch's repository uses weaves.
735
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
736
from bzrlib.repofmt import weaverepo
737
format = bzrdir.BzrDirMetaFormat1()
738
format.repository_format = weaverepo.RepositoryFormat7()
740
format = self.repository.bzrdir.checkout_metadir()
741
format.set_branch_format(self._format)
744
def create_checkout(self, to_location, revision_id=None,
745
lightweight=False, accelerator_tree=None,
747
"""Create a checkout of a branch.
749
:param to_location: The url to produce the checkout at
750
:param revision_id: The revision to check out
751
:param lightweight: If True, produce a lightweight checkout, otherwise,
752
produce a bound branch (heavyweight checkout)
753
:param accelerator_tree: A tree which can be used for retrieving file
754
contents more quickly than the revision tree, i.e. a workingtree.
755
The revision tree will be used for cases where accelerator_tree's
756
content is different.
757
:param hardlink: If true, hard-link files from accelerator_tree,
759
:return: The tree of the created checkout
761
t = transport.get_transport(to_location)
764
format = self._get_checkout_format()
765
checkout = format.initialize_on_transport(t)
766
from_branch = BranchReferenceFormat().initialize(checkout, self)
768
format = self._get_checkout_format()
769
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
770
to_location, force_new_tree=False, format=format)
771
checkout = checkout_branch.bzrdir
772
checkout_branch.bind(self)
773
# pull up to the specified revision_id to set the initial
774
# branch tip correctly, and seed it with history.
775
checkout_branch.pull(self, stop_revision=revision_id)
777
tree = checkout.create_workingtree(revision_id,
778
from_branch=from_branch,
779
accelerator_tree=accelerator_tree,
781
basis_tree = tree.basis_tree()
782
basis_tree.lock_read()
784
for path, file_id in basis_tree.iter_references():
785
reference_parent = self.reference_parent(file_id, path)
786
reference_parent.create_checkout(tree.abspath(path),
787
basis_tree.get_reference_revision(file_id, path),
794
def reconcile(self, thorough=True):
795
"""Make sure the data stored in this branch is consistent."""
796
from bzrlib.reconcile import BranchReconciler
797
reconciler = BranchReconciler(self, thorough=thorough)
798
reconciler.reconcile()
801
def reference_parent(self, file_id, path):
802
"""Return the parent branch for a tree-reference file_id
803
:param file_id: The file_id of the tree reference
804
:param path: The path of the file_id in the tree
805
:return: A branch associated with the file_id
807
# FIXME should provide multiple branches, based on config
808
return Branch.open(self.bzrdir.root_transport.clone(path).base)
810
def supports_tags(self):
811
return self._format.supports_tags()
814
class BranchFormat(object):
815
"""An encapsulation of the initialization and open routines for a format.
817
Formats provide three things:
818
* An initialization routine,
822
Formats are placed in an dict by their format string for reference
823
during branch opening. Its not required that these be instances, they
824
can be classes themselves with class methods - it simply depends on
825
whether state is needed for a given format or not.
827
Once a format is deprecated, just deprecate the initialize and open
828
methods on the format class. Do not deprecate the object, as the
829
object will be created every time regardless.
832
_default_format = None
833
"""The default format used for new branches."""
836
"""The known formats."""
838
def __eq__(self, other):
839
return self.__class__ is other.__class__
841
def __ne__(self, other):
842
return not (self == other)
845
def find_format(klass, a_bzrdir):
846
"""Return the format for the branch object in a_bzrdir."""
848
transport = a_bzrdir.get_branch_transport(None)
849
format_string = transport.get("format").read()
850
return klass._formats[format_string]
851
except errors.NoSuchFile:
852
raise errors.NotBranchError(path=transport.base)
854
raise errors.UnknownFormatError(format=format_string, kind='branch')
857
def get_default_format(klass):
858
"""Return the current default format."""
859
return klass._default_format
861
def get_reference(self, a_bzrdir):
862
"""Get the target reference of the branch in a_bzrdir.
864
format probing must have been completed before calling
865
this method - it is assumed that the format of the branch
866
in a_bzrdir is correct.
868
:param a_bzrdir: The bzrdir to get the branch data from.
869
:return: None if the branch is not a reference branch.
874
def set_reference(self, a_bzrdir, to_branch):
875
"""Set the target reference of the branch in a_bzrdir.
877
format probing must have been completed before calling
878
this method - it is assumed that the format of the branch
879
in a_bzrdir is correct.
881
:param a_bzrdir: The bzrdir to set the branch reference for.
882
:param to_branch: branch that the checkout is to reference
884
raise NotImplementedError(self.set_reference)
886
def get_format_string(self):
887
"""Return the ASCII format string that identifies this format."""
888
raise NotImplementedError(self.get_format_string)
890
def get_format_description(self):
891
"""Return the short format description for this format."""
892
raise NotImplementedError(self.get_format_description)
894
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
896
"""Initialize a branch in a bzrdir, with specified files
898
:param a_bzrdir: The bzrdir to initialize the branch in
899
:param utf8_files: The files to create as a list of
900
(filename, content) tuples
901
:param set_format: If True, set the format with
902
self.get_format_string. (BzrBranch4 has its format set
904
:return: a branch in this format
906
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
907
branch_transport = a_bzrdir.get_branch_transport(self)
909
'metadir': ('lock', lockdir.LockDir),
910
'branch4': ('branch-lock', lockable_files.TransportLock),
912
lock_name, lock_class = lock_map[lock_type]
913
control_files = lockable_files.LockableFiles(branch_transport,
914
lock_name, lock_class)
915
control_files.create_lock()
916
control_files.lock_write()
918
utf8_files += [('format', self.get_format_string())]
920
for (filename, content) in utf8_files:
921
branch_transport.put_bytes(
923
mode=control_files._file_mode)
925
control_files.unlock()
926
return self.open(a_bzrdir, _found=True)
928
def initialize(self, a_bzrdir):
929
"""Create a branch of this format in a_bzrdir."""
930
raise NotImplementedError(self.initialize)
932
def is_supported(self):
933
"""Is this format supported?
935
Supported formats can be initialized and opened.
936
Unsupported formats may not support initialization or committing or
937
some other features depending on the reason for not being supported.
941
def open(self, a_bzrdir, _found=False):
942
"""Return the branch object for a_bzrdir
944
_found is a private parameter, do not use it. It is used to indicate
945
if format probing has already be done.
947
raise NotImplementedError(self.open)
950
def register_format(klass, format):
951
klass._formats[format.get_format_string()] = format
954
def set_default_format(klass, format):
955
klass._default_format = format
958
def unregister_format(klass, format):
959
del klass._formats[format.get_format_string()]
962
return self.get_format_string().rstrip()
964
def supports_tags(self):
965
"""True if this format supports tags stored in the branch"""
966
return False # by default
969
class BranchHooks(Hooks):
970
"""A dictionary mapping hook name to a list of callables for branch hooks.
972
e.g. ['set_rh'] Is the list of items to be called when the
973
set_revision_history function is invoked.
977
"""Create the default hooks.
979
These are all empty initially, because by default nothing should get
983
# Introduced in 0.15:
984
# invoked whenever the revision history has been set
985
# with set_revision_history. The api signature is
986
# (branch, revision_history), and the branch will
989
# invoked after a push operation completes.
990
# the api signature is
992
# containing the members
993
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
994
# where local is the local target branch or None, master is the target
995
# master branch, and the rest should be self explanatory. The source
996
# is read locked and the target branches write locked. Source will
997
# be the local low-latency branch.
998
self['post_push'] = []
999
# invoked after a pull operation completes.
1000
# the api signature is
1002
# containing the members
1003
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1004
# where local is the local branch or None, master is the target
1005
# master branch, and the rest should be self explanatory. The source
1006
# is read locked and the target branches write locked. The local
1007
# branch is the low-latency branch.
1008
self['post_pull'] = []
1009
# invoked before a commit operation takes place.
1010
# the api signature is
1011
# (local, master, old_revno, old_revid, future_revno, future_revid,
1012
# tree_delta, future_tree).
1013
# old_revid is NULL_REVISION for the first commit to a branch
1014
# tree_delta is a TreeDelta object describing changes from the basis
1015
# revision, hooks MUST NOT modify this delta
1016
# future_tree is an in-memory tree obtained from
1017
# CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
1018
self['pre_commit'] = []
1019
# invoked after a commit operation completes.
1020
# the api signature is
1021
# (local, master, old_revno, old_revid, new_revno, new_revid)
1022
# old_revid is NULL_REVISION for the first commit to a branch.
1023
self['post_commit'] = []
1024
# invoked after a uncommit operation completes.
1025
# the api signature is
1026
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1027
# local is the local branch or None, master is the target branch,
1028
# and an empty branch recieves new_revno of 0, new_revid of None.
1029
self['post_uncommit'] = []
1031
# Invoked after the tip of a branch changes.
1032
# the api signature is
1033
# (params) where params is a ChangeBranchTipParams with the members
1034
# (branch, old_revno, new_revno, old_revid, new_revid)
1035
self['post_change_branch_tip'] = []
1038
# install the default hooks into the Branch class.
1039
Branch.hooks = BranchHooks()
1042
class ChangeBranchTipParams(object):
1043
"""Object holding parameters passed to *_change_branch_tip hooks.
1045
There are 5 fields that hooks may wish to access:
1047
:ivar branch: the branch being changed
1048
:ivar old_revno: revision number before the change
1049
:ivar new_revno: revision number after the change
1050
:ivar old_revid: revision id before the change
1051
:ivar new_revid: revision id after the change
1053
The revid fields are strings. The revno fields are integers.
1056
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1057
"""Create a group of ChangeBranchTip parameters.
1059
:param branch: The branch being changed.
1060
:param old_revno: Revision number before the change.
1061
:param new_revno: Revision number after the change.
1062
:param old_revid: Tip revision id before the change.
1063
:param new_revid: Tip revision id after the change.
1065
self.branch = branch
1066
self.old_revno = old_revno
1067
self.new_revno = new_revno
1068
self.old_revid = old_revid
1069
self.new_revid = new_revid
1072
class BzrBranchFormat4(BranchFormat):
1073
"""Bzr branch format 4.
1076
- a revision-history file.
1077
- a branch-lock lock file [ to be shared with the bzrdir ]
1080
def get_format_description(self):
1081
"""See BranchFormat.get_format_description()."""
1082
return "Branch format 4"
1084
def initialize(self, a_bzrdir):
1085
"""Create a branch of this format in a_bzrdir."""
1086
utf8_files = [('revision-history', ''),
1087
('branch-name', ''),
1089
return self._initialize_helper(a_bzrdir, utf8_files,
1090
lock_type='branch4', set_format=False)
1093
super(BzrBranchFormat4, self).__init__()
1094
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1096
def open(self, a_bzrdir, _found=False):
1097
"""Return the branch object for a_bzrdir
1099
_found is a private parameter, do not use it. It is used to indicate
1100
if format probing has already be done.
1103
# we are being called directly and must probe.
1104
raise NotImplementedError
1105
return BzrBranch(_format=self,
1106
_control_files=a_bzrdir._control_files,
1108
_repository=a_bzrdir.open_repository())
1111
return "Bazaar-NG branch format 4"
1114
class BzrBranchFormat5(BranchFormat):
1115
"""Bzr branch format 5.
1118
- a revision-history file.
1120
- a lock dir guarding the branch itself
1121
- all of this stored in a branch/ subdirectory
1122
- works with shared repositories.
1124
This format is new in bzr 0.8.
1127
def get_format_string(self):
1128
"""See BranchFormat.get_format_string()."""
1129
return "Bazaar-NG branch format 5\n"
1131
def get_format_description(self):
1132
"""See BranchFormat.get_format_description()."""
1133
return "Branch format 5"
1135
def initialize(self, a_bzrdir):
1136
"""Create a branch of this format in a_bzrdir."""
1137
utf8_files = [('revision-history', ''),
1138
('branch-name', ''),
1140
return self._initialize_helper(a_bzrdir, utf8_files)
1143
super(BzrBranchFormat5, self).__init__()
1144
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1146
def open(self, a_bzrdir, _found=False):
1147
"""Return the branch object for a_bzrdir
1149
_found is a private parameter, do not use it. It is used to indicate
1150
if format probing has already be done.
1153
format = BranchFormat.find_format(a_bzrdir)
1154
if format.__class__ != self.__class__:
1155
raise AssertionError("wrong format %r found for %r" %
1158
transport = a_bzrdir.get_branch_transport(None)
1159
control_files = lockable_files.LockableFiles(transport, 'lock',
1161
return BzrBranch5(_format=self,
1162
_control_files=control_files,
1164
_repository=a_bzrdir.find_repository())
1165
except errors.NoSuchFile:
1166
raise errors.NotBranchError(path=transport.base)
1169
class BzrBranchFormat6(BzrBranchFormat5):
1170
"""Branch format with last-revision and tags.
1172
Unlike previous formats, this has no explicit revision history. Instead,
1173
this just stores the last-revision, and the left-hand history leading
1174
up to there is the history.
1176
This format was introduced in bzr 0.15
1177
and became the default in 0.91.
1180
def get_format_string(self):
1181
"""See BranchFormat.get_format_string()."""
1182
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1184
def get_format_description(self):
1185
"""See BranchFormat.get_format_description()."""
1186
return "Branch format 6"
1188
def initialize(self, a_bzrdir):
1189
"""Create a branch of this format in a_bzrdir."""
1190
utf8_files = [('last-revision', '0 null:\n'),
1191
('branch.conf', ''),
1194
return self._initialize_helper(a_bzrdir, utf8_files)
1196
def open(self, a_bzrdir, _found=False):
1197
"""Return the branch object for a_bzrdir
1199
_found is a private parameter, do not use it. It is used to indicate
1200
if format probing has already be done.
1203
format = BranchFormat.find_format(a_bzrdir)
1204
if format.__class__ != self.__class__:
1205
raise AssertionError("wrong format %r found for %r" %
1207
transport = a_bzrdir.get_branch_transport(None)
1208
control_files = lockable_files.LockableFiles(transport, 'lock',
1210
return BzrBranch6(_format=self,
1211
_control_files=control_files,
1213
_repository=a_bzrdir.find_repository())
1215
def supports_tags(self):
1219
super(BzrBranchFormat6, self).__init__()
1220
self._matchingbzrdir.repository_format = \
1221
RepositoryFormatPackDevelopment1Subtree()
1224
class BranchReferenceFormat(BranchFormat):
1225
"""Bzr branch reference format.
1227
Branch references are used in implementing checkouts, they
1228
act as an alias to the real branch which is at some other url.
1235
def get_format_string(self):
1236
"""See BranchFormat.get_format_string()."""
1237
return "Bazaar-NG Branch Reference Format 1\n"
1239
def get_format_description(self):
1240
"""See BranchFormat.get_format_description()."""
1241
return "Checkout reference format 1"
1243
def get_reference(self, a_bzrdir):
1244
"""See BranchFormat.get_reference()."""
1245
transport = a_bzrdir.get_branch_transport(None)
1246
return transport.get('location').read()
1248
def set_reference(self, a_bzrdir, to_branch):
1249
"""See BranchFormat.set_reference()."""
1250
transport = a_bzrdir.get_branch_transport(None)
1251
location = transport.put_bytes('location', to_branch.base)
1253
def initialize(self, a_bzrdir, target_branch=None):
1254
"""Create a branch of this format in a_bzrdir."""
1255
if target_branch is None:
1256
# this format does not implement branch itself, thus the implicit
1257
# creation contract must see it as uninitializable
1258
raise errors.UninitializableFormat(self)
1259
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1260
branch_transport = a_bzrdir.get_branch_transport(self)
1261
branch_transport.put_bytes('location',
1262
target_branch.bzrdir.root_transport.base)
1263
branch_transport.put_bytes('format', self.get_format_string())
1265
a_bzrdir, _found=True,
1266
possible_transports=[target_branch.bzrdir.root_transport])
1269
super(BranchReferenceFormat, self).__init__()
1270
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1272
def _make_reference_clone_function(format, a_branch):
1273
"""Create a clone() routine for a branch dynamically."""
1274
def clone(to_bzrdir, revision_id=None):
1275
"""See Branch.clone()."""
1276
return format.initialize(to_bzrdir, a_branch)
1277
# cannot obey revision_id limits when cloning a reference ...
1278
# FIXME RBC 20060210 either nuke revision_id for clone, or
1279
# emit some sort of warning/error to the caller ?!
1282
def open(self, a_bzrdir, _found=False, location=None,
1283
possible_transports=None):
1284
"""Return the branch that the branch reference in a_bzrdir points at.
1286
_found is a private parameter, do not use it. It is used to indicate
1287
if format probing has already be done.
1290
format = BranchFormat.find_format(a_bzrdir)
1291
if format.__class__ != self.__class__:
1292
raise AssertionError("wrong format %r found for %r" %
1294
if location is None:
1295
location = self.get_reference(a_bzrdir)
1296
real_bzrdir = bzrdir.BzrDir.open(
1297
location, possible_transports=possible_transports)
1298
result = real_bzrdir.open_branch()
1299
# this changes the behaviour of result.clone to create a new reference
1300
# rather than a copy of the content of the branch.
1301
# I did not use a proxy object because that needs much more extensive
1302
# testing, and we are only changing one behaviour at the moment.
1303
# If we decide to alter more behaviours - i.e. the implicit nickname
1304
# then this should be refactored to introduce a tested proxy branch
1305
# and a subclass of that for use in overriding clone() and ....
1307
result.clone = self._make_reference_clone_function(result)
1311
# formats which have no format string are not discoverable
1312
# and not independently creatable, so are not registered.
1313
__format5 = BzrBranchFormat5()
1314
__format6 = BzrBranchFormat6()
1315
BranchFormat.register_format(__format5)
1316
BranchFormat.register_format(BranchReferenceFormat())
1317
BranchFormat.register_format(__format6)
1318
BranchFormat.set_default_format(__format6)
1319
_legacy_formats = [BzrBranchFormat4(),
1322
class BzrBranch(Branch):
1323
"""A branch stored in the actual filesystem.
1325
Note that it's "local" in the context of the filesystem; it doesn't
1326
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1327
it's writable, and can be accessed via the normal filesystem API.
1329
:ivar _transport: Transport for file operations on this branch's
1330
control files, typically pointing to the .bzr/branch directory.
1331
:ivar repository: Repository for this branch.
1332
:ivar base: The url of the base directory for this branch; the one
1333
containing the .bzr directory.
1336
def __init__(self, _format=None,
1337
_control_files=None, a_bzrdir=None, _repository=None):
1338
"""Create new branch object at a particular location."""
1339
Branch.__init__(self)
1340
if a_bzrdir is None:
1341
raise ValueError('a_bzrdir must be supplied')
1343
self.bzrdir = a_bzrdir
1344
self._base = self.bzrdir.transport.clone('..').base
1345
# XXX: We should be able to just do
1346
# self.base = self.bzrdir.root_transport.base
1347
# but this does not quite work yet -- mbp 20080522
1348
self._format = _format
1349
if _control_files is None:
1350
raise ValueError('BzrBranch _control_files is None')
1351
self.control_files = _control_files
1352
self._transport = _control_files._transport
1353
self.repository = _repository
1356
return '%s(%r)' % (self.__class__.__name__, self.base)
1360
def _get_base(self):
1361
"""Returns the directory containing the control directory."""
1364
base = property(_get_base, doc="The URL for the root of this branch.")
1366
@deprecated_method(deprecated_in((0, 16, 0)))
1367
def abspath(self, name):
1368
"""See Branch.abspath."""
1369
return self._transport.abspath(name)
1371
def is_locked(self):
1372
return self.control_files.is_locked()
1374
def lock_write(self, token=None):
1375
repo_token = self.repository.lock_write()
1377
token = self.control_files.lock_write(token=token)
1379
self.repository.unlock()
1383
def lock_read(self):
1384
self.repository.lock_read()
1386
self.control_files.lock_read()
1388
self.repository.unlock()
1392
# TODO: test for failed two phase locks. This is known broken.
1394
self.control_files.unlock()
1396
self.repository.unlock()
1397
if not self.control_files.is_locked():
1398
# we just released the lock
1399
self._clear_cached_state()
1401
def peek_lock_mode(self):
1402
if self.control_files._lock_count == 0:
1405
return self.control_files._lock_mode
1407
def get_physical_lock_status(self):
1408
return self.control_files.get_physical_lock_status()
1411
def print_file(self, file, revision_id):
1412
"""See Branch.print_file."""
1413
return self.repository.print_file(file, revision_id)
1415
def _write_revision_history(self, history):
1416
"""Factored out of set_revision_history.
1418
This performs the actual writing to disk.
1419
It is intended to be called by BzrBranch5.set_revision_history."""
1420
self._transport.put_bytes(
1421
'revision-history', '\n'.join(history),
1422
mode=self.control_files._file_mode)
1425
def set_revision_history(self, rev_history):
1426
"""See Branch.set_revision_history."""
1427
if 'evil' in debug.debug_flags:
1428
mutter_callsite(3, "set_revision_history scales with history.")
1429
self._write_revision_history(rev_history)
1430
self._clear_cached_state()
1431
self._cache_revision_history(rev_history)
1432
for hook in Branch.hooks['set_rh']:
1433
hook(self, rev_history)
1435
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1436
"""Run the post_change_branch_tip hooks."""
1437
hooks = Branch.hooks['post_change_branch_tip']
1440
new_revno, new_revid = self.last_revision_info()
1441
params = ChangeBranchTipParams(
1442
self, old_revno, new_revno, old_revid, new_revid)
1447
def set_last_revision_info(self, revno, revision_id):
1448
"""Set the last revision of this branch.
1450
The caller is responsible for checking that the revno is correct
1451
for this revision id.
1453
It may be possible to set the branch last revision to an id not
1454
present in the repository. However, branches can also be
1455
configured to check constraints on history, in which case this may not
1458
revision_id = _mod_revision.ensure_null(revision_id)
1459
old_revno, old_revid = self.last_revision_info()
1460
# this old format stores the full history, but this api doesn't
1461
# provide it, so we must generate, and might as well check it's
1463
history = self._lefthand_history(revision_id)
1464
if len(history) != revno:
1465
raise AssertionError('%d != %d' % (len(history), revno))
1466
self.set_revision_history(history)
1467
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1469
def _gen_revision_history(self):
1470
history = self._transport.get_bytes('revision-history').split('\n')
1471
if history[-1:] == ['']:
1472
# There shouldn't be a trailing newline, but just in case.
1476
def _lefthand_history(self, revision_id, last_rev=None,
1478
if 'evil' in debug.debug_flags:
1479
mutter_callsite(4, "_lefthand_history scales with history.")
1480
# stop_revision must be a descendant of last_revision
1481
graph = self.repository.get_graph()
1482
if last_rev is not None:
1483
if not graph.is_ancestor(last_rev, revision_id):
1484
# our previous tip is not merged into stop_revision
1485
raise errors.DivergedBranches(self, other_branch)
1486
# make a new revision history from the graph
1487
parents_map = graph.get_parent_map([revision_id])
1488
if revision_id not in parents_map:
1489
raise errors.NoSuchRevision(self, revision_id)
1490
current_rev_id = revision_id
1492
# Do not include ghosts or graph origin in revision_history
1493
while (current_rev_id in parents_map and
1494
len(parents_map[current_rev_id]) > 0):
1495
new_history.append(current_rev_id)
1496
current_rev_id = parents_map[current_rev_id][0]
1497
parents_map = graph.get_parent_map([current_rev_id])
1498
new_history.reverse()
1502
def generate_revision_history(self, revision_id, last_rev=None,
1504
"""Create a new revision history that will finish with revision_id.
1506
:param revision_id: the new tip to use.
1507
:param last_rev: The previous last_revision. If not None, then this
1508
must be a ancestory of revision_id, or DivergedBranches is raised.
1509
:param other_branch: The other branch that DivergedBranches should
1510
raise with respect to.
1512
self.set_revision_history(self._lefthand_history(revision_id,
1513
last_rev, other_branch))
1516
def update_revisions(self, other, stop_revision=None, overwrite=False,
1518
"""See Branch.update_revisions."""
1521
other_revno, other_last_revision = other.last_revision_info()
1522
stop_revno = None # unknown
1523
if stop_revision is None:
1524
stop_revision = other_last_revision
1525
if _mod_revision.is_null(stop_revision):
1526
# if there are no commits, we're done.
1528
stop_revno = other_revno
1530
# what's the current last revision, before we fetch [and change it
1532
last_rev = _mod_revision.ensure_null(self.last_revision())
1533
# we fetch here so that we don't process data twice in the common
1534
# case of having something to pull, and so that the check for
1535
# already merged can operate on the just fetched graph, which will
1536
# be cached in memory.
1537
self.fetch(other, stop_revision)
1538
# Check to see if one is an ancestor of the other
1541
graph = self.repository.get_graph()
1542
heads = graph.heads([stop_revision, last_rev])
1543
if heads == set([last_rev]):
1544
# The current revision is a decendent of the target,
1547
elif heads == set([stop_revision, last_rev]):
1548
# These branches have diverged
1549
raise errors.DivergedBranches(self, other)
1550
elif heads != set([stop_revision]):
1551
raise AssertionError("invalid heads: %r" % heads)
1552
if stop_revno is None:
1554
graph = self.repository.get_graph()
1555
this_revno, this_last_revision = self.last_revision_info()
1556
stop_revno = graph.find_distance_to_null(stop_revision,
1557
[(other_last_revision, other_revno),
1558
(this_last_revision, this_revno)])
1559
self.set_last_revision_info(stop_revno, stop_revision)
1563
def basis_tree(self):
1564
"""See Branch.basis_tree."""
1565
return self.repository.revision_tree(self.last_revision())
1568
def pull(self, source, overwrite=False, stop_revision=None,
1569
_hook_master=None, run_hooks=True, possible_transports=None):
1572
:param _hook_master: Private parameter - set the branch to
1573
be supplied as the master to push hooks.
1574
:param run_hooks: Private parameter - if false, this branch
1575
is being called because it's the master of the primary branch,
1576
so it should not run its hooks.
1578
result = PullResult()
1579
result.source_branch = source
1580
result.target_branch = self
1583
# We assume that during 'pull' the local repository is closer than
1585
graph = self.repository.get_graph(source.repository)
1586
result.old_revno, result.old_revid = self.last_revision_info()
1587
self.update_revisions(source, stop_revision, overwrite=overwrite,
1589
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
1590
result.new_revno, result.new_revid = self.last_revision_info()
1592
result.master_branch = _hook_master
1593
result.local_branch = self
1595
result.master_branch = self
1596
result.local_branch = None
1598
for hook in Branch.hooks['post_pull']:
1604
def _get_parent_location(self):
1605
_locs = ['parent', 'pull', 'x-pull']
1608
return self._transport.get_bytes(l).strip('\n')
1609
except errors.NoSuchFile:
1614
def push(self, target, overwrite=False, stop_revision=None,
1615
_override_hook_source_branch=None):
1618
This is the basic concrete implementation of push()
1620
:param _override_hook_source_branch: If specified, run
1621
the hooks passing this Branch as the source, rather than self.
1622
This is for use of RemoteBranch, where push is delegated to the
1623
underlying vfs-based Branch.
1625
# TODO: Public option to disable running hooks - should be trivial but
1629
result = self._push_with_bound_branches(target, overwrite,
1631
_override_hook_source_branch=_override_hook_source_branch)
1636
def _push_with_bound_branches(self, target, overwrite,
1638
_override_hook_source_branch=None):
1639
"""Push from self into target, and into target's master if any.
1641
This is on the base BzrBranch class even though it doesn't support
1642
bound branches because the *target* might be bound.
1645
if _override_hook_source_branch:
1646
result.source_branch = _override_hook_source_branch
1647
for hook in Branch.hooks['post_push']:
1650
bound_location = target.get_bound_location()
1651
if bound_location and target.base != bound_location:
1652
# there is a master branch.
1654
# XXX: Why the second check? Is it even supported for a branch to
1655
# be bound to itself? -- mbp 20070507
1656
master_branch = target.get_master_branch()
1657
master_branch.lock_write()
1659
# push into the master from this branch.
1660
self._basic_push(master_branch, overwrite, stop_revision)
1661
# and push into the target branch from this. Note that we push from
1662
# this branch again, because its considered the highest bandwidth
1664
result = self._basic_push(target, overwrite, stop_revision)
1665
result.master_branch = master_branch
1666
result.local_branch = target
1670
master_branch.unlock()
1673
result = self._basic_push(target, overwrite, stop_revision)
1674
# TODO: Why set master_branch and local_branch if there's no
1675
# binding? Maybe cleaner to just leave them unset? -- mbp
1677
result.master_branch = target
1678
result.local_branch = None
1682
def _basic_push(self, target, overwrite, stop_revision):
1683
"""Basic implementation of push without bound branches or hooks.
1685
Must be called with self read locked and target write locked.
1687
result = PushResult()
1688
result.source_branch = self
1689
result.target_branch = target
1690
result.old_revno, result.old_revid = target.last_revision_info()
1692
# We assume that during 'push' this repository is closer than
1694
graph = self.repository.get_graph(target.repository)
1695
target.update_revisions(self, stop_revision, overwrite=overwrite,
1697
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
1698
result.new_revno, result.new_revid = target.last_revision_info()
1701
def get_parent(self):
1702
"""See Branch.get_parent."""
1703
parent = self._get_parent_location()
1706
# This is an old-format absolute path to a local branch
1707
# turn it into a url
1708
if parent.startswith('/'):
1709
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1711
return urlutils.join(self.base[:-1], parent)
1712
except errors.InvalidURLJoin, e:
1713
raise errors.InaccessibleParent(parent, self.base)
1715
def set_push_location(self, location):
1716
"""See Branch.set_push_location."""
1717
self.get_config().set_user_option(
1718
'push_location', location,
1719
store=_mod_config.STORE_LOCATION_NORECURSE)
1722
def set_parent(self, url):
1723
"""See Branch.set_parent."""
1724
# TODO: Maybe delete old location files?
1725
# URLs should never be unicode, even on the local fs,
1726
# FIXUP this and get_parent in a future branch format bump:
1727
# read and rewrite the file. RBC 20060125
1729
if isinstance(url, unicode):
1731
url = url.encode('ascii')
1732
except UnicodeEncodeError:
1733
raise errors.InvalidURL(url,
1734
"Urls must be 7-bit ascii, "
1735
"use bzrlib.urlutils.escape")
1736
url = urlutils.relative_url(self.base, url)
1737
self._set_parent_location(url)
1739
def _set_parent_location(self, url):
1741
self._transport.delete('parent')
1743
self._transport.put_bytes('parent', url + '\n',
1744
mode=self.control_files._file_mode)
1747
class BzrBranch5(BzrBranch):
1748
"""A format 5 branch. This supports new features over plain branches.
1750
It has support for a master_branch which is the data for bound branches.
1758
super(BzrBranch5, self).__init__(_format=_format,
1759
_control_files=_control_files,
1761
_repository=_repository)
1764
def pull(self, source, overwrite=False, stop_revision=None,
1765
run_hooks=True, possible_transports=None):
1766
"""Pull from source into self, updating my master if any.
1768
:param run_hooks: Private parameter - if false, this branch
1769
is being called because it's the master of the primary branch,
1770
so it should not run its hooks.
1772
bound_location = self.get_bound_location()
1773
master_branch = None
1774
if bound_location and source.base != bound_location:
1775
# not pulling from master, so we need to update master.
1776
master_branch = self.get_master_branch(possible_transports)
1777
master_branch.lock_write()
1780
# pull from source into master.
1781
master_branch.pull(source, overwrite, stop_revision,
1783
return super(BzrBranch5, self).pull(source, overwrite,
1784
stop_revision, _hook_master=master_branch,
1785
run_hooks=run_hooks)
1788
master_branch.unlock()
1790
def get_bound_location(self):
1792
return self._transport.get_bytes('bound')[:-1]
1793
except errors.NoSuchFile:
1797
def get_master_branch(self, possible_transports=None):
1798
"""Return the branch we are bound to.
1800
:return: Either a Branch, or None
1802
This could memoise the branch, but if thats done
1803
it must be revalidated on each new lock.
1804
So for now we just don't memoise it.
1805
# RBC 20060304 review this decision.
1807
bound_loc = self.get_bound_location()
1811
return Branch.open(bound_loc,
1812
possible_transports=possible_transports)
1813
except (errors.NotBranchError, errors.ConnectionError), e:
1814
raise errors.BoundBranchConnectionFailure(
1818
def set_bound_location(self, location):
1819
"""Set the target where this branch is bound to.
1821
:param location: URL to the target branch
1824
self._transport.put_bytes('bound', location+'\n',
1825
mode=self.bzrdir._get_file_mode())
1828
self._transport.delete('bound')
1829
except errors.NoSuchFile:
1834
def bind(self, other):
1835
"""Bind this branch to the branch other.
1837
This does not push or pull data between the branches, though it does
1838
check for divergence to raise an error when the branches are not
1839
either the same, or one a prefix of the other. That behaviour may not
1840
be useful, so that check may be removed in future.
1842
:param other: The branch to bind to
1845
# TODO: jam 20051230 Consider checking if the target is bound
1846
# It is debatable whether you should be able to bind to
1847
# a branch which is itself bound.
1848
# Committing is obviously forbidden,
1849
# but binding itself may not be.
1850
# Since we *have* to check at commit time, we don't
1851
# *need* to check here
1853
# we want to raise diverged if:
1854
# last_rev is not in the other_last_rev history, AND
1855
# other_last_rev is not in our history, and do it without pulling
1857
self.set_bound_location(other.base)
1861
"""If bound, unbind"""
1862
return self.set_bound_location(None)
1865
def update(self, possible_transports=None):
1866
"""Synchronise this branch with the master branch if any.
1868
:return: None or the last_revision that was pivoted out during the
1871
master = self.get_master_branch(possible_transports)
1872
if master is not None:
1873
old_tip = _mod_revision.ensure_null(self.last_revision())
1874
self.pull(master, overwrite=True)
1875
if self.repository.get_graph().is_ancestor(old_tip,
1876
_mod_revision.ensure_null(self.last_revision())):
1882
class BzrBranch6(BzrBranch5):
1884
def __init__(self, *args, **kwargs):
1885
super(BzrBranch6, self).__init__(*args, **kwargs)
1886
self._last_revision_info_cache = None
1887
self._partial_revision_history_cache = []
1889
def _clear_cached_state(self):
1890
super(BzrBranch6, self)._clear_cached_state()
1891
self._last_revision_info_cache = None
1892
self._partial_revision_history_cache = []
1895
def last_revision_info(self):
1896
"""Return information about the last revision.
1898
:return: A tuple (revno, revision_id).
1900
if self._last_revision_info_cache is None:
1901
self._last_revision_info_cache = self._last_revision_info()
1902
return self._last_revision_info_cache
1904
def _last_revision_info(self):
1905
revision_string = self._transport.get_bytes('last-revision')
1906
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1907
revision_id = cache_utf8.get_cached_utf8(revision_id)
1909
return revno, revision_id
1911
def _write_last_revision_info(self, revno, revision_id):
1912
"""Simply write out the revision id, with no checks.
1914
Use set_last_revision_info to perform this safely.
1916
Does not update the revision_history cache.
1917
Intended to be called by set_last_revision_info and
1918
_write_revision_history.
1920
revision_id = _mod_revision.ensure_null(revision_id)
1921
out_string = '%d %s\n' % (revno, revision_id)
1922
self._transport.put_bytes('last-revision', out_string,
1923
mode=self.control_files._file_mode)
1926
def set_last_revision_info(self, revno, revision_id):
1927
revision_id = _mod_revision.ensure_null(revision_id)
1928
old_revno, old_revid = self.last_revision_info()
1929
if self._get_append_revisions_only():
1930
self._check_history_violation(revision_id)
1931
self._write_last_revision_info(revno, revision_id)
1932
self._clear_cached_state()
1933
self._last_revision_info_cache = revno, revision_id
1934
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1936
def _check_history_violation(self, revision_id):
1937
last_revision = _mod_revision.ensure_null(self.last_revision())
1938
if _mod_revision.is_null(last_revision):
1940
if last_revision not in self._lefthand_history(revision_id):
1941
raise errors.AppendRevisionsOnlyViolation(self.base)
1943
def _gen_revision_history(self):
1944
"""Generate the revision history from last revision
1946
self._extend_partial_history()
1947
return list(reversed(self._partial_revision_history_cache))
1949
def _extend_partial_history(self, stop_index=None, stop_revision=None):
1950
"""Extend the partial history to include a given index
1952
If a stop_index is supplied, stop when that index has been reached.
1953
If a stop_revision is supplied, stop when that revision is
1954
encountered. Otherwise, stop when the beginning of history is
1957
:param stop_index: The index which should be present. When it is
1958
present, history extension will stop.
1959
:param revision_id: The revision id which should be present. When
1960
it is encountered, history extension will stop.
1962
repo = self.repository
1963
if len(self._partial_revision_history_cache) == 0:
1964
iterator = repo.iter_reverse_revision_history(self.last_revision())
1966
start_revision = self._partial_revision_history_cache[-1]
1967
iterator = repo.iter_reverse_revision_history(start_revision)
1968
#skip the last revision in the list
1969
next_revision = iterator.next()
1970
for revision_id in iterator:
1971
self._partial_revision_history_cache.append(revision_id)
1972
if (stop_index is not None and
1973
len(self._partial_revision_history_cache) > stop_index):
1975
if revision_id == stop_revision:
1978
def _write_revision_history(self, history):
1979
"""Factored out of set_revision_history.
1981
This performs the actual writing to disk, with format-specific checks.
1982
It is intended to be called by BzrBranch5.set_revision_history.
1984
if len(history) == 0:
1985
last_revision = 'null:'
1987
if history != self._lefthand_history(history[-1]):
1988
raise errors.NotLefthandHistory(history)
1989
last_revision = history[-1]
1990
if self._get_append_revisions_only():
1991
self._check_history_violation(last_revision)
1992
self._write_last_revision_info(len(history), last_revision)
1995
def _set_parent_location(self, url):
1996
"""Set the parent branch"""
1997
self._set_config_location('parent_location', url, make_relative=True)
2000
def _get_parent_location(self):
2001
"""Set the parent branch"""
2002
return self._get_config_location('parent_location')
2004
def set_push_location(self, location):
2005
"""See Branch.set_push_location."""
2006
self._set_config_location('push_location', location)
2008
def set_bound_location(self, location):
2009
"""See Branch.set_push_location."""
2011
config = self.get_config()
2012
if location is None:
2013
if config.get_user_option('bound') != 'True':
2016
config.set_user_option('bound', 'False', warn_masked=True)
2019
self._set_config_location('bound_location', location,
2021
config.set_user_option('bound', 'True', warn_masked=True)
2024
def _get_bound_location(self, bound):
2025
"""Return the bound location in the config file.
2027
Return None if the bound parameter does not match"""
2028
config = self.get_config()
2029
config_bound = (config.get_user_option('bound') == 'True')
2030
if config_bound != bound:
2032
return self._get_config_location('bound_location', config=config)
2034
def get_bound_location(self):
2035
"""See Branch.set_push_location."""
2036
return self._get_bound_location(True)
2038
def get_old_bound_location(self):
2039
"""See Branch.get_old_bound_location"""
2040
return self._get_bound_location(False)
2042
def set_append_revisions_only(self, enabled):
2047
self.get_config().set_user_option('append_revisions_only', value,
2050
def _get_append_revisions_only(self):
2051
value = self.get_config().get_user_option('append_revisions_only')
2052
return value == 'True'
2054
def _synchronize_history(self, destination, revision_id):
2055
"""Synchronize last revision and revision history between branches.
2057
This version is most efficient when the destination is also a
2058
BzrBranch6, but works for BzrBranch5, as long as the destination's
2059
repository contains all the lefthand ancestors of the intended
2060
last_revision. If not, set_last_revision_info will fail.
2062
:param destination: The branch to copy the history into
2063
:param revision_id: The revision-id to truncate history at. May
2064
be None to copy complete history.
2066
source_revno, source_revision_id = self.last_revision_info()
2067
if revision_id is None:
2068
revno, revision_id = source_revno, source_revision_id
2069
elif source_revision_id == revision_id:
2070
# we know the revno without needing to walk all of history
2071
revno = source_revno
2073
# To figure out the revno for a random revision, we need to build
2074
# the revision history, and count its length.
2075
# We don't care about the order, just how long it is.
2076
# Alternatively, we could start at the current location, and count
2077
# backwards. But there is no guarantee that we will find it since
2078
# it may be a merged revision.
2079
revno = len(list(self.repository.iter_reverse_revision_history(
2081
destination.set_last_revision_info(revno, revision_id)
2083
def _make_tags(self):
2084
return BasicTags(self)
2087
def generate_revision_history(self, revision_id, last_rev=None,
2089
"""See BzrBranch5.generate_revision_history"""
2090
history = self._lefthand_history(revision_id, last_rev, other_branch)
2091
revno = len(history)
2092
self.set_last_revision_info(revno, revision_id)
2095
def get_rev_id(self, revno, history=None):
2096
"""Find the revision id of the specified revno."""
2098
return _mod_revision.NULL_REVISION
2100
last_revno, last_revision_id = self.last_revision_info()
2101
if revno <= 0 or revno > last_revno:
2102
raise errors.NoSuchRevision(self, revno)
2104
if history is not None:
2105
return history[revno - 1]
2107
index = last_revno - revno
2108
if len(self._partial_revision_history_cache) <= index:
2109
self._extend_partial_history(stop_index=index)
2110
if len(self._partial_revision_history_cache) > index:
2111
return self._partial_revision_history_cache[index]
2113
raise errors.NoSuchRevision(self, revno)
2116
def revision_id_to_revno(self, revision_id):
2117
"""Given a revision id, return its revno"""
2118
if _mod_revision.is_null(revision_id):
2121
index = self._partial_revision_history_cache.index(revision_id)
2123
self._extend_partial_history(stop_revision=revision_id)
2124
index = len(self._partial_revision_history_cache) - 1
2125
if self._partial_revision_history_cache[index] != revision_id:
2126
raise errors.NoSuchRevision(self, revision_id)
2127
return self.revno() - index
2130
######################################################################
2131
# results of operations
2134
class _Result(object):
2136
def _show_tag_conficts(self, to_file):
2137
if not getattr(self, 'tag_conflicts', None):
2139
to_file.write('Conflicting tags:\n')
2140
for name, value1, value2 in self.tag_conflicts:
2141
to_file.write(' %s\n' % (name, ))
2144
class PullResult(_Result):
2145
"""Result of a Branch.pull operation.
2147
:ivar old_revno: Revision number before pull.
2148
:ivar new_revno: Revision number after pull.
2149
:ivar old_revid: Tip revision id before pull.
2150
:ivar new_revid: Tip revision id after pull.
2151
:ivar source_branch: Source (local) branch object.
2152
:ivar master_branch: Master branch of the target, or None.
2153
:ivar target_branch: Target/destination branch object.
2157
# DEPRECATED: pull used to return the change in revno
2158
return self.new_revno - self.old_revno
2160
def report(self, to_file):
2162
if self.old_revid == self.new_revid:
2163
to_file.write('No revisions to pull.\n')
2165
to_file.write('Now on revision %d.\n' % self.new_revno)
2166
self._show_tag_conficts(to_file)
2169
class PushResult(_Result):
2170
"""Result of a Branch.push operation.
2172
:ivar old_revno: Revision number before push.
2173
:ivar new_revno: Revision number after push.
2174
:ivar old_revid: Tip revision id before push.
2175
:ivar new_revid: Tip revision id after push.
2176
:ivar source_branch: Source branch object.
2177
:ivar master_branch: Master branch of the target, or None.
2178
:ivar target_branch: Target/destination branch object.
2182
# DEPRECATED: push used to return the change in revno
2183
return self.new_revno - self.old_revno
2185
def report(self, to_file):
2186
"""Write a human-readable description of the result."""
2187
if self.old_revid == self.new_revid:
2188
to_file.write('No new revisions to push.\n')
2190
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2191
self._show_tag_conficts(to_file)
2194
class BranchCheckResult(object):
2195
"""Results of checking branch consistency.
2200
def __init__(self, branch):
2201
self.branch = branch
2203
def report_results(self, verbose):
2204
"""Report the check results via trace.note.
2206
:param verbose: Requests more detailed display of what was checked,
2209
note('checked branch %s format %s',
2211
self.branch._format)
2214
class Converter5to6(object):
2215
"""Perform an in-place upgrade of format 5 to format 6"""
2217
def convert(self, branch):
2218
# Data for 5 and 6 can peacefully coexist.
2219
format = BzrBranchFormat6()
2220
new_branch = format.open(branch.bzrdir, _found=True)
2222
# Copy source data into target
2223
new_branch._write_last_revision_info(*branch.last_revision_info())
2224
new_branch.set_parent(branch.get_parent())
2225
new_branch.set_bound_location(branch.get_bound_location())
2226
new_branch.set_push_location(branch.get_push_location())
2228
# New branch has no tags by default
2229
new_branch.tags._set_tag_dict({})
2231
# Copying done; now update target format
2232
new_branch._transport.put_bytes('format',
2233
format.get_format_string(),
2234
mode=new_branch.control_files._file_mode)
2236
# Clean up old files
2237
new_branch._transport.delete('revision-history')
2239
branch.set_parent(None)
2240
except errors.NoSuchFile:
2242
branch.set_bound_location(None)
added
removed
bzrlib/branch.py
