98
87
Base directory/url of the branch.
89
hooks: An instance of BranchHooks.
91
# this is really an instance variable - FIXME move it there
95
# override this to set the strategy for storing tags
97
return DisabledTags(self)
102
99
def __init__(self, *ignored, **ignored_too):
103
raise NotImplementedError('The Branch class is abstract')
100
self.tags = self._make_tags()
101
self._revision_history_cache = None
102
self._revision_id_to_revno_cache = None
104
def break_lock(self):
105
"""Break a lock if one is present from another instance.
107
Uses the ui factory to ask for confirmation if the lock may be from
110
This will probe the repository for its lock as well.
112
self.control_files.break_lock()
113
self.repository.break_lock()
114
master = self.get_master_branch()
115
if master is not None:
119
@deprecated_method(zero_eight)
106
120
def open_downlevel(base):
107
"""Open a branch which may be of an old format.
109
Only local branches are supported."""
110
return BzrBranch(get_transport(base), relax_version_check=True)
114
"""Open an existing branch, rooted at 'base' (url)"""
115
t = get_transport(base)
116
mutter("trying to open %r with transport %r", base, t)
120
def open_containing(url):
121
"""Open a branch which may be of an old format."""
122
return Branch.open(base, _unsupported=True)
125
def open(base, _unsupported=False):
126
"""Open the branch rooted at base.
128
For instance, if the branch is at URL/.bzr/branch,
129
Branch.open(URL) -> a Branch instance.
131
control = bzrdir.BzrDir.open(base, _unsupported)
132
return control.open_branch(_unsupported)
135
def open_from_transport(transport, _unsupported=False):
136
"""Open the branch rooted at transport"""
137
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
138
return control.open_branch(_unsupported)
141
def open_containing(url, possible_transports=None):
121
142
"""Open an existing branch which contains url.
123
144
This probes for a branch at url, and searches upwards from there.
125
146
Basically we keep looking up until we find the control directory or
126
147
run into the root. If there isn't one, raises NotBranchError.
148
If there is one and it is either an unrecognised format or an unsupported
149
format, UnknownFormatError or UnsupportedFormatError are raised.
127
150
If there is one, it is returned, along with the unused portion of url.
129
t = get_transport(url)
132
return BzrBranch(t), t.relpath(url)
133
except NotBranchError, e:
134
mutter('not a branch in: %r %s', t.base, e)
135
new_t = t.clone('..')
136
if new_t.base == t.base:
137
# reached the root, whatever that may be
138
raise NotBranchError(path=url)
152
control, relpath = bzrdir.BzrDir.open_containing(url,
154
return control.open_branch(), relpath
157
@deprecated_function(zero_eight)
142
158
def initialize(base):
143
"""Create a new branch, rooted at 'base' (url)"""
144
t = get_transport(unicode(base))
145
return BzrBranch(t, init=True)
159
"""Create a new working tree and branch, rooted at 'base' (url)
161
NOTE: This will soon be deprecated in favour of creation
164
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
166
@deprecated_function(zero_eight)
147
167
def setup_caching(self, cache_root):
148
168
"""Subclasses that care about caching should override this, and set
149
169
up cached stores located under cache_root.
171
NOTE: This is unused.
151
self.cache_root = cache_root
175
def get_config(self):
176
return BranchConfig(self)
153
178
def _get_nick(self):
154
cfg = self.tree_config()
155
return cfg.get_option(u"nickname", default=self.base.split('/')[-1])
179
return self.get_config().get_nickname()
157
181
def _set_nick(self, nick):
158
cfg = self.tree_config()
159
cfg.set_option(nick, "nickname")
160
assert cfg.get_option("nickname") == nick
182
self.get_config().set_user_option('nickname', nick, warn_masked=True)
162
184
nick = property(_get_nick, _set_nick)
164
def push_stores(self, branch_to):
165
"""Copy the content of this branches store to branch_to."""
166
raise NotImplementedError('push_stores is abstract')
187
raise NotImplementedError(self.is_locked)
168
189
def lock_write(self):
169
raise NotImplementedError('lock_write is abstract')
190
raise NotImplementedError(self.lock_write)
171
192
def lock_read(self):
172
raise NotImplementedError('lock_read is abstract')
193
raise NotImplementedError(self.lock_read)
174
195
def unlock(self):
175
raise NotImplementedError('unlock is abstract')
196
raise NotImplementedError(self.unlock)
198
def peek_lock_mode(self):
199
"""Return lock mode for the Branch: 'r', 'w' or None"""
200
raise NotImplementedError(self.peek_lock_mode)
202
def get_physical_lock_status(self):
203
raise NotImplementedError(self.get_physical_lock_status)
206
def get_revision_id_to_revno_map(self):
207
"""Return the revision_id => dotted revno map.
209
This will be regenerated on demand, but will be cached.
211
:return: A dictionary mapping revision_id => dotted revno.
212
This dictionary should not be modified by the caller.
214
if self._revision_id_to_revno_cache is not None:
215
mapping = self._revision_id_to_revno_cache
217
mapping = self._gen_revno_map()
218
self._cache_revision_id_to_revno(mapping)
219
# TODO: jam 20070417 Since this is being cached, should we be returning
221
# I would rather not, and instead just declare that users should not
222
# modify the return value.
225
def _gen_revno_map(self):
226
"""Create a new mapping from revision ids to dotted revnos.
228
Dotted revnos are generated based on the current tip in the revision
230
This is the worker function for get_revision_id_to_revno_map, which
231
just caches the return value.
233
:return: A dictionary mapping revision_id => dotted revno.
235
last_revision = self.last_revision()
236
revision_graph = self.repository.get_revision_graph(last_revision)
237
merge_sorted_revisions = tsort.merge_sort(
242
revision_id_to_revno = dict((rev_id, revno)
243
for seq_num, rev_id, depth, revno, end_of_merge
244
in merge_sorted_revisions)
245
return revision_id_to_revno
247
def leave_lock_in_place(self):
248
"""Tell this branch object not to release the physical lock when this
251
If lock_write doesn't return a token, then this method is not supported.
253
self.control_files.leave_in_place()
255
def dont_leave_lock_in_place(self):
256
"""Tell this branch object to release the physical lock when this
257
object is unlocked, even if it didn't originally acquire it.
259
If lock_write doesn't return a token, then this method is not supported.
261
self.control_files.dont_leave_in_place()
177
263
def abspath(self, name):
178
264
"""Return absolute filename for something in the branch
362
672
if revno < 1 or revno > self.revno():
363
673
raise InvalidRevisionNumber(revno)
365
def sign_revision(self, revision_id, gpg_strategy):
366
raise NotImplementedError('sign_revision is abstract')
368
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
369
raise NotImplementedError('store_revision_signature is abstract')
371
def clone(self, to_location, revision=None, basis_branch=None, to_branch_type=None):
372
"""Copy this branch into the existing directory to_location.
374
Returns the newly created branch object.
377
If not None, only revisions up to this point will be copied.
378
The head of the new branch will be that revision. Must be a
381
to_location -- The destination directory; must either exist and be
382
empty, or not exist, in which case it is created.
385
A local branch to copy revisions from, related to this branch.
386
This is used when branching from a remote (slow) branch, and we have
387
a local branch that might contain some relevant revisions.
390
Branch type of destination branch
392
assert isinstance(to_location, basestring)
393
if not bzrlib.osutils.lexists(to_location):
394
os.mkdir(to_location)
395
if to_branch_type is None:
396
to_branch_type = BzrBranch
397
br_to = to_branch_type.initialize(to_location)
398
mutter("copy branch from %s to %s", self, br_to)
399
if basis_branch is not None:
400
basis_branch.push_stores(br_to)
401
br_to.working_tree().set_root_id(self.get_root_id())
403
revision = self.last_revision()
404
br_to.update_revisions(self, stop_revision=revision)
405
br_to.set_parent(self.base)
406
# circular import protection
407
from bzrlib.merge import build_working_dir
408
build_working_dir(to_location)
676
def clone(self, to_bzrdir, revision_id=None):
677
"""Clone this branch into to_bzrdir preserving all semantic values.
679
revision_id: if not None, the revision history in the new branch will
680
be truncated to end with revision_id.
682
result = self._format.initialize(to_bzrdir)
683
self.copy_content_into(result, revision_id=revision_id)
687
def sprout(self, to_bzrdir, revision_id=None):
688
"""Create a new line of development from the branch, into to_bzrdir.
690
revision_id: if not None, the revision history in the new branch will
691
be truncated to end with revision_id.
693
result = self._format.initialize(to_bzrdir)
694
self.copy_content_into(result, revision_id=revision_id)
695
result.set_parent(self.bzrdir.root_transport.base)
698
def _synchronize_history(self, destination, revision_id):
699
"""Synchronize last revision and revision history between branches.
701
This version is most efficient when the destination is also a
702
BzrBranch5, but works for BzrBranch6 as long as the revision
703
history is the true lefthand parent history, and all of the revisions
704
are in the destination's repository. If not, set_revision_history
707
:param destination: The branch to copy the history into
708
:param revision_id: The revision-id to truncate history at. May
709
be None to copy complete history.
711
if revision_id == _mod_revision.NULL_REVISION:
713
new_history = self.revision_history()
714
if revision_id is not None and new_history != []:
715
revision_id = osutils.safe_revision_id(revision_id)
717
new_history = new_history[:new_history.index(revision_id) + 1]
719
rev = self.repository.get_revision(revision_id)
720
new_history = rev.get_history(self.repository)[1:]
721
destination.set_revision_history(new_history)
724
def copy_content_into(self, destination, revision_id=None):
725
"""Copy the content of self into destination.
727
revision_id: if not None, the revision history in the new branch will
728
be truncated to end with revision_id.
730
self._synchronize_history(destination, revision_id)
732
parent = self.get_parent()
733
except errors.InaccessibleParent, e:
734
mutter('parent was not accessible to copy: %s', e)
737
destination.set_parent(parent)
738
self.tags.merge_to(destination.tags)
742
"""Check consistency of the branch.
744
In particular this checks that revisions given in the revision-history
745
do actually match up in the revision graph, and that they're all
746
present in the repository.
748
Callers will typically also want to check the repository.
750
:return: A BranchCheckResult.
752
mainline_parent_id = None
753
for revision_id in self.revision_history():
755
revision = self.repository.get_revision(revision_id)
756
except errors.NoSuchRevision, e:
757
raise errors.BzrCheckError("mainline revision {%s} not in repository"
759
# In general the first entry on the revision history has no parents.
760
# But it's not illegal for it to have parents listed; this can happen
761
# in imports from Arch when the parents weren't reachable.
762
if mainline_parent_id is not None:
763
if mainline_parent_id not in revision.parent_ids:
764
raise errors.BzrCheckError("previous revision {%s} not listed among "
766
% (mainline_parent_id, revision_id))
767
mainline_parent_id = revision_id
768
return BranchCheckResult(self)
770
def _get_checkout_format(self):
771
"""Return the most suitable metadir for a checkout of this branch.
772
Weaves are used if this branch's repository uses weaves.
774
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
775
from bzrlib.repofmt import weaverepo
776
format = bzrdir.BzrDirMetaFormat1()
777
format.repository_format = weaverepo.RepositoryFormat7()
779
format = self.repository.bzrdir.checkout_metadir()
780
format.set_branch_format(self._format)
783
def create_checkout(self, to_location, revision_id=None,
785
"""Create a checkout of a branch.
787
:param to_location: The url to produce the checkout at
788
:param revision_id: The revision to check out
789
:param lightweight: If True, produce a lightweight checkout, otherwise,
790
produce a bound branch (heavyweight checkout)
791
:return: The tree of the created checkout
793
t = transport.get_transport(to_location)
796
format = self._get_checkout_format()
797
checkout = format.initialize_on_transport(t)
798
BranchReferenceFormat().initialize(checkout, self)
800
format = self._get_checkout_format()
801
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
802
to_location, force_new_tree=False, format=format)
803
checkout = checkout_branch.bzrdir
804
checkout_branch.bind(self)
805
# pull up to the specified revision_id to set the initial
806
# branch tip correctly, and seed it with history.
807
checkout_branch.pull(self, stop_revision=revision_id)
808
tree = checkout.create_workingtree(revision_id)
809
basis_tree = tree.basis_tree()
810
basis_tree.lock_read()
812
for path, file_id in basis_tree.iter_references():
813
reference_parent = self.reference_parent(file_id, path)
814
reference_parent.create_checkout(tree.abspath(path),
815
basis_tree.get_reference_revision(file_id, path),
821
def reference_parent(self, file_id, path):
822
"""Return the parent branch for a tree-reference file_id
823
:param file_id: The file_id of the tree reference
824
:param path: The path of the file_id in the tree
825
:return: A branch associated with the file_id
827
# FIXME should provide multiple branches, based on config
828
return Branch.open(self.bzrdir.root_transport.clone(path).base)
830
def supports_tags(self):
831
return self._format.supports_tags()
834
class BranchFormat(object):
835
"""An encapsulation of the initialization and open routines for a format.
837
Formats provide three things:
838
* An initialization routine,
842
Formats are placed in an dict by their format string for reference
843
during branch opening. Its not required that these be instances, they
844
can be classes themselves with class methods - it simply depends on
845
whether state is needed for a given format or not.
847
Once a format is deprecated, just deprecate the initialize and open
848
methods on the format class. Do not deprecate the object, as the
849
object will be created every time regardless.
852
_default_format = None
853
"""The default format used for new branches."""
856
"""The known formats."""
858
def __eq__(self, other):
859
return self.__class__ is other.__class__
861
def __ne__(self, other):
862
return not (self == other)
865
def find_format(klass, a_bzrdir):
866
"""Return the format for the branch object in a_bzrdir."""
868
transport = a_bzrdir.get_branch_transport(None)
869
format_string = transport.get("format").read()
870
return klass._formats[format_string]
872
raise NotBranchError(path=transport.base)
874
raise errors.UnknownFormatError(format=format_string)
877
def get_default_format(klass):
878
"""Return the current default format."""
879
return klass._default_format
881
def get_reference(self, a_bzrdir):
882
"""Get the target reference of the branch in a_bzrdir.
884
format probing must have been completed before calling
885
this method - it is assumed that the format of the branch
886
in a_bzrdir is correct.
888
:param a_bzrdir: The bzrdir to get the branch data from.
889
:return: None if the branch is not a reference branch.
893
def get_format_string(self):
894
"""Return the ASCII format string that identifies this format."""
895
raise NotImplementedError(self.get_format_string)
897
def get_format_description(self):
898
"""Return the short format description for this format."""
899
raise NotImplementedError(self.get_format_description)
901
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
903
"""Initialize a branch in a bzrdir, with specified files
905
:param a_bzrdir: The bzrdir to initialize the branch in
906
:param utf8_files: The files to create as a list of
907
(filename, content) tuples
908
:param set_format: If True, set the format with
909
self.get_format_string. (BzrBranch4 has its format set
911
:return: a branch in this format
913
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
914
branch_transport = a_bzrdir.get_branch_transport(self)
916
'metadir': ('lock', lockdir.LockDir),
917
'branch4': ('branch-lock', lockable_files.TransportLock),
919
lock_name, lock_class = lock_map[lock_type]
920
control_files = lockable_files.LockableFiles(branch_transport,
921
lock_name, lock_class)
922
control_files.create_lock()
923
control_files.lock_write()
925
control_files.put_utf8('format', self.get_format_string())
927
for file, content in utf8_files:
928
control_files.put_utf8(file, content)
930
control_files.unlock()
931
return self.open(a_bzrdir, _found=True)
933
def initialize(self, a_bzrdir):
934
"""Create a branch of this format in a_bzrdir."""
935
raise NotImplementedError(self.initialize)
937
def is_supported(self):
938
"""Is this format supported?
940
Supported formats can be initialized and opened.
941
Unsupported formats may not support initialization or committing or
942
some other features depending on the reason for not being supported.
946
def open(self, a_bzrdir, _found=False):
947
"""Return the branch object for a_bzrdir
949
_found is a private parameter, do not use it. It is used to indicate
950
if format probing has already be done.
952
raise NotImplementedError(self.open)
955
def register_format(klass, format):
956
klass._formats[format.get_format_string()] = format
959
def set_default_format(klass, format):
960
klass._default_format = format
963
def unregister_format(klass, format):
964
assert klass._formats[format.get_format_string()] is format
965
del klass._formats[format.get_format_string()]
968
return self.get_format_string().rstrip()
970
def supports_tags(self):
971
"""True if this format supports tags stored in the branch"""
972
return False # by default
974
# XXX: Probably doesn't really belong here -- mbp 20070212
975
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
977
branch_transport = a_bzrdir.get_branch_transport(self)
978
control_files = lockable_files.LockableFiles(branch_transport,
979
lock_filename, lock_class)
980
control_files.create_lock()
981
control_files.lock_write()
983
for filename, content in utf8_files:
984
control_files.put_utf8(filename, content)
986
control_files.unlock()
989
class BranchHooks(Hooks):
990
"""A dictionary mapping hook name to a list of callables for branch hooks.
992
e.g. ['set_rh'] Is the list of items to be called when the
993
set_revision_history function is invoked.
997
"""Create the default hooks.
999
These are all empty initially, because by default nothing should get
1002
Hooks.__init__(self)
1003
# Introduced in 0.15:
1004
# invoked whenever the revision history has been set
1005
# with set_revision_history. The api signature is
1006
# (branch, revision_history), and the branch will
1009
# invoked after a push operation completes.
1010
# the api signature is
1012
# containing the members
1013
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1014
# where local is the local target branch or None, master is the target
1015
# master branch, and the rest should be self explanatory. The source
1016
# is read locked and the target branches write locked. Source will
1017
# be the local low-latency branch.
1018
self['post_push'] = []
1019
# invoked after a pull operation completes.
1020
# the api signature is
1022
# containing the members
1023
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1024
# where local is the local branch or None, master is the target
1025
# master branch, and the rest should be self explanatory. The source
1026
# is read locked and the target branches write locked. The local
1027
# branch is the low-latency branch.
1028
self['post_pull'] = []
1029
# invoked after a commit operation completes.
1030
# the api signature is
1031
# (local, master, old_revno, old_revid, new_revno, new_revid)
1032
# old_revid is NULL_REVISION for the first commit to a branch.
1033
self['post_commit'] = []
1034
# invoked after a uncommit operation completes.
1035
# the api signature is
1036
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1037
# local is the local branch or None, master is the target branch,
1038
# and an empty branch recieves new_revno of 0, new_revid of None.
1039
self['post_uncommit'] = []
1042
# install the default hooks into the Branch class.
1043
Branch.hooks = BranchHooks()
1046
class BzrBranchFormat4(BranchFormat):
1047
"""Bzr branch format 4.
1050
- a revision-history file.
1051
- a branch-lock lock file [ to be shared with the bzrdir ]
1054
def get_format_description(self):
1055
"""See BranchFormat.get_format_description()."""
1056
return "Branch format 4"
1058
def initialize(self, a_bzrdir):
1059
"""Create a branch of this format in a_bzrdir."""
1060
utf8_files = [('revision-history', ''),
1061
('branch-name', ''),
1063
return self._initialize_helper(a_bzrdir, utf8_files,
1064
lock_type='branch4', set_format=False)
1067
super(BzrBranchFormat4, self).__init__()
1068
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1070
def open(self, a_bzrdir, _found=False):
1071
"""Return the branch object for a_bzrdir
1073
_found is a private parameter, do not use it. It is used to indicate
1074
if format probing has already be done.
1077
# we are being called directly and must probe.
1078
raise NotImplementedError
1079
return BzrBranch(_format=self,
1080
_control_files=a_bzrdir._control_files,
1082
_repository=a_bzrdir.open_repository())
1085
return "Bazaar-NG branch format 4"
1088
class BzrBranchFormat5(BranchFormat):
1089
"""Bzr branch format 5.
1092
- a revision-history file.
1094
- a lock dir guarding the branch itself
1095
- all of this stored in a branch/ subdirectory
1096
- works with shared repositories.
1098
This format is new in bzr 0.8.
1101
def get_format_string(self):
1102
"""See BranchFormat.get_format_string()."""
1103
return "Bazaar-NG branch format 5\n"
1105
def get_format_description(self):
1106
"""See BranchFormat.get_format_description()."""
1107
return "Branch format 5"
1109
def initialize(self, a_bzrdir):
1110
"""Create a branch of this format in a_bzrdir."""
1111
utf8_files = [('revision-history', ''),
1112
('branch-name', ''),
1114
return self._initialize_helper(a_bzrdir, utf8_files)
1117
super(BzrBranchFormat5, self).__init__()
1118
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1120
def open(self, a_bzrdir, _found=False):
1121
"""Return the branch object for a_bzrdir
1123
_found is a private parameter, do not use it. It is used to indicate
1124
if format probing has already be done.
1127
format = BranchFormat.find_format(a_bzrdir)
1128
assert format.__class__ == self.__class__
1130
transport = a_bzrdir.get_branch_transport(None)
1131
control_files = lockable_files.LockableFiles(transport, 'lock',
1133
return BzrBranch5(_format=self,
1134
_control_files=control_files,
1136
_repository=a_bzrdir.find_repository())
1138
raise NotBranchError(path=transport.base)
1141
class BzrBranchFormat6(BzrBranchFormat5):
1142
"""Branch format with last-revision
1144
Unlike previous formats, this has no explicit revision history. Instead,
1145
this just stores the last-revision, and the left-hand history leading
1146
up to there is the history.
1148
This format was introduced in bzr 0.15
1151
def get_format_string(self):
1152
"""See BranchFormat.get_format_string()."""
1153
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1155
def get_format_description(self):
1156
"""See BranchFormat.get_format_description()."""
1157
return "Branch format 6"
1159
def initialize(self, a_bzrdir):
1160
"""Create a branch of this format in a_bzrdir."""
1161
utf8_files = [('last-revision', '0 null:\n'),
1162
('branch-name', ''),
1163
('branch.conf', ''),
1166
return self._initialize_helper(a_bzrdir, utf8_files)
1168
def open(self, a_bzrdir, _found=False):
1169
"""Return the branch object for a_bzrdir
1171
_found is a private parameter, do not use it. It is used to indicate
1172
if format probing has already be done.
1175
format = BranchFormat.find_format(a_bzrdir)
1176
assert format.__class__ == self.__class__
1177
transport = a_bzrdir.get_branch_transport(None)
1178
control_files = lockable_files.LockableFiles(transport, 'lock',
1180
return BzrBranch6(_format=self,
1181
_control_files=control_files,
1183
_repository=a_bzrdir.find_repository())
1185
def supports_tags(self):
1189
class BranchReferenceFormat(BranchFormat):
1190
"""Bzr branch reference format.
1192
Branch references are used in implementing checkouts, they
1193
act as an alias to the real branch which is at some other url.
1200
def get_format_string(self):
1201
"""See BranchFormat.get_format_string()."""
1202
return "Bazaar-NG Branch Reference Format 1\n"
1204
def get_format_description(self):
1205
"""See BranchFormat.get_format_description()."""
1206
return "Checkout reference format 1"
1208
def get_reference(self, a_bzrdir):
1209
"""See BranchFormat.get_reference()."""
1210
transport = a_bzrdir.get_branch_transport(None)
1211
return transport.get('location').read()
1213
def initialize(self, a_bzrdir, target_branch=None):
1214
"""Create a branch of this format in a_bzrdir."""
1215
if target_branch is None:
1216
# this format does not implement branch itself, thus the implicit
1217
# creation contract must see it as uninitializable
1218
raise errors.UninitializableFormat(self)
1219
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1220
branch_transport = a_bzrdir.get_branch_transport(self)
1221
branch_transport.put_bytes('location',
1222
target_branch.bzrdir.root_transport.base)
1223
branch_transport.put_bytes('format', self.get_format_string())
1224
return self.open(a_bzrdir, _found=True)
1227
super(BranchReferenceFormat, self).__init__()
1228
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1230
def _make_reference_clone_function(format, a_branch):
1231
"""Create a clone() routine for a branch dynamically."""
1232
def clone(to_bzrdir, revision_id=None):
1233
"""See Branch.clone()."""
1234
return format.initialize(to_bzrdir, a_branch)
1235
# cannot obey revision_id limits when cloning a reference ...
1236
# FIXME RBC 20060210 either nuke revision_id for clone, or
1237
# emit some sort of warning/error to the caller ?!
1240
def open(self, a_bzrdir, _found=False, location=None):
1241
"""Return the branch that the branch reference in a_bzrdir points at.
1243
_found is a private parameter, do not use it. It is used to indicate
1244
if format probing has already be done.
1247
format = BranchFormat.find_format(a_bzrdir)
1248
assert format.__class__ == self.__class__
1249
if location is None:
1250
location = self.get_reference(a_bzrdir)
1251
real_bzrdir = bzrdir.BzrDir.open(location)
1252
result = real_bzrdir.open_branch()
1253
# this changes the behaviour of result.clone to create a new reference
1254
# rather than a copy of the content of the branch.
1255
# I did not use a proxy object because that needs much more extensive
1256
# testing, and we are only changing one behaviour at the moment.
1257
# If we decide to alter more behaviours - i.e. the implicit nickname
1258
# then this should be refactored to introduce a tested proxy branch
1259
# and a subclass of that for use in overriding clone() and ....
1261
result.clone = self._make_reference_clone_function(result)
1265
# formats which have no format string are not discoverable
1266
# and not independently creatable, so are not registered.
1267
__default_format = BzrBranchFormat5()
1268
BranchFormat.register_format(__default_format)
1269
BranchFormat.register_format(BranchReferenceFormat())
1270
BranchFormat.register_format(BzrBranchFormat6())
1271
BranchFormat.set_default_format(__default_format)
1272
_legacy_formats = [BzrBranchFormat4(),
412
1275
class BzrBranch(Branch):
413
1276
"""A branch stored in the actual filesystem.
415
1278
Note that it's "local" in the context of the filesystem; it doesn't
416
1279
really matter if it's on an nfs/smb/afs/coda/... share, as long as
417
1280
it's writable, and can be accessed via the normal filesystem API.
420
# We actually expect this class to be somewhat short-lived; part of its
421
# purpose is to try to isolate what bits of the branch logic are tied to
422
# filesystem access, so that in a later step, we can extricate them to
423
# a separarte ("storage") class.
424
_inventory_weave = None
426
# Map some sort of prefix into a namespace
427
# stuff like "revno:10", "revid:", etc.
428
# This should match a prefix with a function which accepts
429
REVISION_NAMESPACES = {}
431
def push_stores(self, branch_to):
432
"""See Branch.push_stores."""
433
if (self._branch_format != branch_to._branch_format
434
or self._branch_format != 4):
435
from bzrlib.fetch import greedy_fetch
436
mutter("falling back to fetch logic to push between %s(%s) and %s(%s)",
437
self, self._branch_format, branch_to, branch_to._branch_format)
438
greedy_fetch(to_branch=branch_to, from_branch=self,
439
revision=self.last_revision())
442
store_pairs = ((self.text_store, branch_to.text_store),
443
(self.inventory_store, branch_to.inventory_store),
444
(self.revision_store, branch_to.revision_store))
446
for from_store, to_store in store_pairs:
447
copy_all(from_store, to_store)
448
except UnlistableStore:
449
raise UnlistableBranch(from_store)
451
def __init__(self, transport, init=False,
452
relax_version_check=False):
453
"""Create new branch object at a particular location.
455
transport -- A Transport object, defining how to access files.
457
init -- If True, create new control files in a previously
458
unversioned directory. If False, the branch must already
461
relax_version_check -- If true, the usual check for the branch
462
version is not applied. This is intended only for
463
upgrade/recovery type use; it's not guaranteed that
464
all operations will work on old format branches.
466
In the test suite, creation of new trees is tested using the
467
`ScratchBranch` class.
469
assert isinstance(transport, Transport), \
470
"%r is not a Transport" % transport
471
# TODO: jam 20060103 We create a clone of this transport at .bzr/
472
# and then we forget about it, should we keep a handle to it?
473
self._base = transport.base
474
self.control_files = LockableFiles(transport.clone(bzrlib.BZRDIR),
478
self._check_format(relax_version_check)
479
self.repository = Repository(transport, self._branch_format)
1283
def __init__(self, _format=None,
1284
_control_files=None, a_bzrdir=None, _repository=None):
1285
"""Create new branch object at a particular location."""
1286
Branch.__init__(self)
1287
if a_bzrdir is None:
1288
raise ValueError('a_bzrdir must be supplied')
1290
self.bzrdir = a_bzrdir
1291
# self._transport used to point to the directory containing the
1292
# control directory, but was not used - now it's just the transport
1293
# for the branch control files. mbp 20070212
1294
self._base = self.bzrdir.transport.clone('..').base
1295
self._format = _format
1296
if _control_files is None:
1297
raise ValueError('BzrBranch _control_files is None')
1298
self.control_files = _control_files
1299
self._transport = _control_files._transport
1300
self.repository = _repository
481
1302
def __str__(self):
482
1303
return '%s(%r)' % (self.__class__.__name__, self.base)
484
1305
__repr__ = __str__
487
# TODO: It might be best to do this somewhere else,
488
# but it is nice for a Branch object to automatically
489
# cache it's information.
490
# Alternatively, we could have the Transport objects cache requests
491
# See the earlier discussion about how major objects (like Branch)
492
# should never expect their __del__ function to run.
493
if hasattr(self, 'cache_root') and self.cache_root is not None:
495
shutil.rmtree(self.cache_root)
498
self.cache_root = None
500
1307
def _get_base(self):
1308
"""Returns the directory containing the control directory."""
501
1309
return self._base
503
1311
base = property(_get_base, doc="The URL for the root of this branch.")
505
def _finish_transaction(self):
506
"""Exit the current transaction."""
507
return self.control_files._finish_transaction()
509
def get_transaction(self):
510
"""Return the current active transaction.
512
If no transaction is active, this returns a passthrough object
513
for which all data is immediately flushed and no caching happens.
515
# this is an explicit function so that we can do tricky stuff
516
# when the storage in rev_storage is elsewhere.
517
# we probably need to hook the two 'lock a location' and
518
# 'have a transaction' together more delicately, so that
519
# we can have two locks (branch and storage) and one transaction
520
# ... and finishing the transaction unlocks both, but unlocking
521
# does not. - RBC 20051121
522
return self.control_files.get_transaction()
524
def _set_transaction(self, transaction):
525
"""Set a new active transaction."""
526
return self.control_files._set_transaction(transaction)
528
1313
def abspath(self, name):
529
1314
"""See Branch.abspath."""
530
1315
return self.control_files._transport.abspath(name)
532
def _make_control(self):
533
from bzrlib.inventory import Inventory
534
from bzrlib.weavefile import write_weave_v5
535
from bzrlib.weave import Weave
537
# Create an empty inventory
539
# if we want per-tree root ids then this is the place to set
540
# them; they're not needed for now and so ommitted for
542
bzrlib.xml5.serializer_v5.write_inventory(Inventory(), sio)
543
empty_inv = sio.getvalue()
545
bzrlib.weavefile.write_weave_v5(Weave(), sio)
546
empty_weave = sio.getvalue()
548
dirs = ['', 'revision-store', 'weaves']
550
"This is a Bazaar-NG control directory.\n"
551
"Do not change any files in this directory.\n"),
552
('branch-format', BZR_BRANCH_FORMAT_6),
553
('revision-history', ''),
556
('pending-merges', ''),
557
('inventory', empty_inv),
558
('inventory.weave', empty_weave),
559
('ancestry.weave', empty_weave)
561
cfe = self.control_files._escape
562
self.control_files._transport.mkdir_multi([cfe(d) for d in dirs],
563
mode=self.control_files._dir_mode)
564
self.control_files.lock_write()
566
for file, content in files:
567
self.control_files.put_utf8(file, content)
568
mutter('created control directory in ' + self.base)
570
self.control_files.unlock()
572
def _check_format(self, relax_version_check):
573
"""Check this branch format is supported.
575
The format level is stored, as an integer, in
576
self._branch_format for code that needs to check it later.
578
In the future, we might need different in-memory Branch
579
classes to support downlevel branches. But not yet.
582
fmt = self.control_files.controlfile('branch-format', 'r').read()
584
raise NotBranchError(path=self.base)
585
mutter("got branch format %r", fmt)
586
if fmt == BZR_BRANCH_FORMAT_6:
587
self._branch_format = 6
588
elif fmt == BZR_BRANCH_FORMAT_5:
589
self._branch_format = 5
590
elif fmt == BZR_BRANCH_FORMAT_4:
591
self._branch_format = 4
593
if (not relax_version_check
594
and self._branch_format not in (5, 6)):
595
raise errors.UnsupportedFormatError(
596
'sorry, branch format %r not supported' % fmt,
597
['use a different bzr version',
598
'or remove the .bzr directory'
599
' and "bzr init" again'])
1318
@deprecated_method(zero_sixteen)
601
1319
@needs_read_lock
602
1320
def get_root_id(self):
603
1321
"""See Branch.get_root_id."""
604
inv = self.repository.get_inventory(self.last_revision())
605
return inv.root.file_id
607
def lock_write(self):
608
# TODO: test for failed two phase locks. This is known broken.
609
self.control_files.lock_write()
610
self.repository.lock_write()
1322
tree = self.repository.revision_tree(self.last_revision())
1323
return tree.inventory.root.file_id
1325
def is_locked(self):
1326
return self.control_files.is_locked()
1328
def lock_write(self, token=None):
1329
repo_token = self.repository.lock_write()
1331
token = self.control_files.lock_write(token=token)
1333
self.repository.unlock()
612
1337
def lock_read(self):
613
# TODO: test for failed two phase locks. This is known broken.
614
self.control_files.lock_read()
615
1338
self.repository.lock_read()
1340
self.control_files.lock_read()
1342
self.repository.unlock()
617
1345
def unlock(self):
618
1346
# TODO: test for failed two phase locks. This is known broken.
619
self.repository.unlock()
620
self.control_files.unlock()
1348
self.control_files.unlock()
1350
self.repository.unlock()
1351
if not self.control_files.is_locked():
1352
# we just released the lock
1353
self._clear_cached_state()
1355
def peek_lock_mode(self):
1356
if self.control_files._lock_count == 0:
1359
return self.control_files._lock_mode
1361
def get_physical_lock_status(self):
1362
return self.control_files.get_physical_lock_status()
622
1364
@needs_read_lock
623
1365
def print_file(self, file, revision_id):
627
1369
@needs_write_lock
628
1370
def append_revision(self, *revision_ids):
629
1371
"""See Branch.append_revision."""
1372
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
630
1373
for revision_id in revision_ids:
1374
_mod_revision.check_not_reserved_id(revision_id)
631
1375
mutter("add {%s} to revision-history" % revision_id)
632
1376
rev_history = self.revision_history()
633
1377
rev_history.extend(revision_ids)
634
1378
self.set_revision_history(rev_history)
1380
def _write_revision_history(self, history):
1381
"""Factored out of set_revision_history.
1383
This performs the actual writing to disk.
1384
It is intended to be called by BzrBranch5.set_revision_history."""
1385
self.control_files.put_bytes(
1386
'revision-history', '\n'.join(history))
636
1388
@needs_write_lock
637
1389
def set_revision_history(self, rev_history):
638
1390
"""See Branch.set_revision_history."""
639
old_revision = self.last_revision()
640
new_revision = rev_history[-1]
641
self.control_files.put_utf8(
642
'revision-history', '\n'.join(rev_history))
644
# FIXME: RBC 20051207 this smells wrong, last_revision in the
645
# working tree may be != to last_revision in the branch - so
646
# why is this passing in the branches last_revision ?
647
self.working_tree().set_last_revision(new_revision, old_revision)
648
except NoWorkingTree:
649
mutter('Unable to set_last_revision without a working tree.')
651
def get_revision_delta(self, revno):
652
"""Return the delta for one revision.
654
The delta is relative to its mainline predecessor, or the
655
empty tree for revision 1.
1391
rev_history = [osutils.safe_revision_id(r) for r in rev_history]
1392
self._clear_cached_state()
1393
self._write_revision_history(rev_history)
1394
self._cache_revision_history(rev_history)
1395
for hook in Branch.hooks['set_rh']:
1396
hook(self, rev_history)
1399
def set_last_revision_info(self, revno, revision_id):
1400
revision_id = osutils.safe_revision_id(revision_id)
1401
history = self._lefthand_history(revision_id)
1402
assert len(history) == revno, '%d != %d' % (len(history), revno)
1403
self.set_revision_history(history)
1405
def _gen_revision_history(self):
1406
history = self.control_files.get('revision-history').read().split('\n')
1407
if history[-1:] == ['']:
1408
# There shouldn't be a trailing newline, but just in case.
1412
def _lefthand_history(self, revision_id, last_rev=None,
1414
# stop_revision must be a descendant of last_revision
1415
stop_graph = self.repository.get_revision_graph(revision_id)
1416
if (last_rev is not None and last_rev != _mod_revision.NULL_REVISION
1417
and last_rev not in stop_graph):
1418
# our previous tip is not merged into stop_revision
1419
raise errors.DivergedBranches(self, other_branch)
1420
# make a new revision history from the graph
1421
current_rev_id = revision_id
1423
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1424
new_history.append(current_rev_id)
1425
current_rev_id_parents = stop_graph[current_rev_id]
1427
current_rev_id = current_rev_id_parents[0]
1429
current_rev_id = None
1430
new_history.reverse()
1434
def generate_revision_history(self, revision_id, last_rev=None,
1436
"""Create a new revision history that will finish with revision_id.
1438
:param revision_id: the new tip to use.
1439
:param last_rev: The previous last_revision. If not None, then this
1440
must be a ancestory of revision_id, or DivergedBranches is raised.
1441
:param other_branch: The other branch that DivergedBranches should
1442
raise with respect to.
657
assert isinstance(revno, int)
658
rh = self.revision_history()
659
if not (1 <= revno <= len(rh)):
660
raise InvalidRevisionNumber(revno)
662
# revno is 1-based; list is 0-based
664
new_tree = self.repository.revision_tree(rh[revno-1])
666
old_tree = EmptyTree()
668
old_tree = self.repository.revision_tree(rh[revno-2])
669
return compare_trees(old_tree, new_tree)
672
def revision_history(self):
673
"""See Branch.revision_history."""
674
# FIXME are transactions bound to control files ? RBC 20051121
675
transaction = self.get_transaction()
676
history = transaction.map.find_revision_history()
677
if history is not None:
678
mutter("cache hit for revision-history in %s", self)
680
history = [l.rstrip('\r\n') for l in
681
self.control_files.controlfile('revision-history', 'r').readlines()]
682
transaction.map.add_revision_history(history)
683
# this call is disabled because revision_history is
684
# not really an object yet, and the transaction is for objects.
685
# transaction.register_clean(history, precious=True)
1444
revision_id = osutils.safe_revision_id(revision_id)
1445
self.set_revision_history(self._lefthand_history(revision_id,
1446
last_rev, other_branch))
688
1449
def update_revisions(self, other, stop_revision=None):
689
1450
"""See Branch.update_revisions."""
690
from bzrlib.fetch import greedy_fetch
691
if stop_revision is None:
692
stop_revision = other.last_revision()
693
### Should this be checking is_ancestor instead of revision_history?
694
if (stop_revision is not None and
695
stop_revision in self.revision_history()):
697
greedy_fetch(to_branch=self, from_branch=other,
698
revision=stop_revision)
699
pullable_revs = self.pullable_revisions(other, stop_revision)
700
if len(pullable_revs) > 0:
701
self.append_revision(*pullable_revs)
1453
if stop_revision is None:
1454
stop_revision = other.last_revision()
1455
if stop_revision is None:
1456
# if there are no commits, we're done.
1459
stop_revision = osutils.safe_revision_id(stop_revision)
1460
# whats the current last revision, before we fetch [and change it
1462
last_rev = _mod_revision.ensure_null(self.last_revision())
1463
# we fetch here regardless of whether we need to so that we pickup
1465
self.fetch(other, stop_revision)
1466
if self.repository.get_graph().is_ancestor(stop_revision,
1469
self.generate_revision_history(stop_revision, last_rev=last_rev,
703
def pullable_revisions(self, other, stop_revision):
704
"""See Branch.pullable_revisions."""
705
other_revno = other.revision_id_to_revno(stop_revision)
707
return self.missing_revisions(other, other_revno)
708
except DivergedBranches, e:
710
pullable_revs = get_intervening_revisions(self.last_revision(),
713
assert self.last_revision() not in pullable_revs
715
except bzrlib.errors.NotAncestor:
716
if is_ancestor(self.last_revision(), stop_revision, self):
721
1474
def basis_tree(self):
722
1475
"""See Branch.basis_tree."""
724
revision_id = self.revision_history()[-1]
725
# FIXME: This is an abstraction violation, the basis tree
726
# here as defined is on the working tree, the method should
727
# be too. The basis tree for a branch can be different than
728
# that for a working tree. RBC 20051207
729
xml = self.working_tree().read_basis_inventory(revision_id)
730
inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
731
return RevisionTree(self.repository, inv, revision_id)
732
except (IndexError, NoSuchFile, NoWorkingTree), e:
733
return self.repository.revision_tree(self.last_revision())
1476
return self.repository.revision_tree(self.last_revision())
1478
@deprecated_method(zero_eight)
735
1479
def working_tree(self):
736
"""See Branch.working_tree."""
737
from bzrlib.workingtree import WorkingTree
738
if self.base.find('://') != -1:
1480
"""Create a Working tree object for this branch."""
1482
from bzrlib.transport.local import LocalTransport
1483
if (self.base.find('://') != -1 or
1484
not isinstance(self._transport, LocalTransport)):
739
1485
raise NoWorkingTree(self.base)
740
return WorkingTree(self.base, branch=self)
1486
return self.bzrdir.open_workingtree()
742
1488
@needs_write_lock
743
def pull(self, source, overwrite=False):
744
"""See Branch.pull."""
1489
def pull(self, source, overwrite=False, stop_revision=None,
1490
_hook_master=None, run_hooks=True):
1493
:param _hook_master: Private parameter - set the branch to
1494
be supplied as the master to push hooks.
1495
:param run_hooks: Private parameter - if false, this branch
1496
is being called because it's the master of the primary branch,
1497
so it should not run its hooks.
1499
result = PullResult()
1500
result.source_branch = source
1501
result.target_branch = self
745
1502
source.lock_read()
747
old_count = len(self.revision_history())
1504
result.old_revno, result.old_revid = self.last_revision_info()
749
self.update_revisions(source)
1506
self.update_revisions(source, stop_revision)
750
1507
except DivergedBranches:
751
1508
if not overwrite:
754
self.set_revision_history(source.revision_history())
755
new_count = len(self.revision_history())
756
return new_count - old_count
1511
if stop_revision is None:
1512
stop_revision = source.last_revision()
1513
self.generate_revision_history(stop_revision)
1514
result.tag_conflicts = source.tags.merge_to(self.tags)
1515
result.new_revno, result.new_revid = self.last_revision_info()
1517
result.master_branch = _hook_master
1518
result.local_branch = self
1520
result.master_branch = self
1521
result.local_branch = None
1523
for hook in Branch.hooks['post_pull']:
760
def get_parent(self):
761
"""See Branch.get_parent."""
1529
def _get_parent_location(self):
763
1530
_locs = ['parent', 'pull', 'x-pull']
766
return self.control_files.controlfile(l, 'r').read().strip('\n')
1533
return self.control_files.get(l).read().strip('\n')
767
1534
except NoSuchFile:
771
def get_push_location(self):
772
"""See Branch.get_push_location."""
773
config = bzrlib.config.BranchConfig(self)
774
push_loc = config.get_user_option('push_location')
1539
def push(self, target, overwrite=False, stop_revision=None,
1540
_override_hook_source_branch=None):
1543
This is the basic concrete implementation of push()
1545
:param _override_hook_source_branch: If specified, run
1546
the hooks passing this Branch as the source, rather than self.
1547
This is for use of RemoteBranch, where push is delegated to the
1548
underlying vfs-based Branch.
1550
# TODO: Public option to disable running hooks - should be trivial but
1554
result = self._push_with_bound_branches(target, overwrite,
1556
_override_hook_source_branch=_override_hook_source_branch)
1561
def _push_with_bound_branches(self, target, overwrite,
1563
_override_hook_source_branch=None):
1564
"""Push from self into target, and into target's master if any.
1566
This is on the base BzrBranch class even though it doesn't support
1567
bound branches because the *target* might be bound.
1570
if _override_hook_source_branch:
1571
result.source_branch = _override_hook_source_branch
1572
for hook in Branch.hooks['post_push']:
1575
bound_location = target.get_bound_location()
1576
if bound_location and target.base != bound_location:
1577
# there is a master branch.
1579
# XXX: Why the second check? Is it even supported for a branch to
1580
# be bound to itself? -- mbp 20070507
1581
master_branch = target.get_master_branch()
1582
master_branch.lock_write()
1584
# push into the master from this branch.
1585
self._basic_push(master_branch, overwrite, stop_revision)
1586
# and push into the target branch from this. Note that we push from
1587
# this branch again, because its considered the highest bandwidth
1589
result = self._basic_push(target, overwrite, stop_revision)
1590
result.master_branch = master_branch
1591
result.local_branch = target
1595
master_branch.unlock()
1598
result = self._basic_push(target, overwrite, stop_revision)
1599
# TODO: Why set master_branch and local_branch if there's no
1600
# binding? Maybe cleaner to just leave them unset? -- mbp
1602
result.master_branch = target
1603
result.local_branch = None
1607
def _basic_push(self, target, overwrite, stop_revision):
1608
"""Basic implementation of push without bound branches or hooks.
1610
Must be called with self read locked and target write locked.
1612
result = PushResult()
1613
result.source_branch = self
1614
result.target_branch = target
1615
result.old_revno, result.old_revid = target.last_revision_info()
1617
target.update_revisions(self, stop_revision)
1618
except DivergedBranches:
1622
target.set_revision_history(self.revision_history())
1623
result.tag_conflicts = self.tags.merge_to(target.tags)
1624
result.new_revno, result.new_revid = target.last_revision_info()
1627
def get_parent(self):
1628
"""See Branch.get_parent."""
1630
assert self.base[-1] == '/'
1631
parent = self._get_parent_location()
1634
# This is an old-format absolute path to a local branch
1635
# turn it into a url
1636
if parent.startswith('/'):
1637
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1639
return urlutils.join(self.base[:-1], parent)
1640
except errors.InvalidURLJoin, e:
1641
raise errors.InaccessibleParent(parent, self.base)
777
1643
def set_push_location(self, location):
778
1644
"""See Branch.set_push_location."""
779
config = bzrlib.config.LocationConfig(self.base)
780
config.set_user_option('push_location', location)
1645
self.get_config().set_user_option(
1646
'push_location', location,
1647
store=_mod_config.STORE_LOCATION_NORECURSE)
782
1649
@needs_write_lock
783
1650
def set_parent(self, url):
784
1651
"""See Branch.set_parent."""
785
1652
# TODO: Maybe delete old location files?
786
from bzrlib.atomicfile import AtomicFile
787
f = AtomicFile(self.control_files.controlfilename('parent'))
1653
# URLs should never be unicode, even on the local fs,
1654
# FIXUP this and get_parent in a future branch format bump:
1655
# read and rewrite the file, and have the new format code read
1656
# using .get not .get_utf8. RBC 20060125
1658
if isinstance(url, unicode):
1660
url = url.encode('ascii')
1661
except UnicodeEncodeError:
1662
raise errors.InvalidURL(url,
1663
"Urls must be 7-bit ascii, "
1664
"use bzrlib.urlutils.escape")
1665
url = urlutils.relative_url(self.base, url)
1666
self._set_parent_location(url)
1668
def _set_parent_location(self, url):
1670
self.control_files._transport.delete('parent')
1672
assert isinstance(url, str)
1673
self.control_files.put_bytes('parent', url + '\n')
1675
@deprecated_function(zero_nine)
794
1676
def tree_config(self):
1677
"""DEPRECATED; call get_config instead.
1678
TreeConfig has become part of BranchConfig."""
795
1679
return TreeConfig(self)
797
def _get_truncated_history(self, revision_id):
798
history = self.revision_history()
799
if revision_id is None:
802
idx = history.index(revision_id)
804
raise InvalidRevisionId(revision_id=revision, branch=self)
805
return history[:idx+1]
1682
class BzrBranch5(BzrBranch):
1683
"""A format 5 branch. This supports new features over plan branches.
1685
It has support for a master_branch which is the data for bound branches.
1693
super(BzrBranch5, self).__init__(_format=_format,
1694
_control_files=_control_files,
1696
_repository=_repository)
1699
def pull(self, source, overwrite=False, stop_revision=None,
1701
"""Pull from source into self, updating my master if any.
1703
:param run_hooks: Private parameter - if false, this branch
1704
is being called because it's the master of the primary branch,
1705
so it should not run its hooks.
1707
bound_location = self.get_bound_location()
1708
master_branch = None
1709
if bound_location and source.base != bound_location:
1710
# not pulling from master, so we need to update master.
1711
master_branch = self.get_master_branch()
1712
master_branch.lock_write()
1715
# pull from source into master.
1716
master_branch.pull(source, overwrite, stop_revision,
1718
return super(BzrBranch5, self).pull(source, overwrite,
1719
stop_revision, _hook_master=master_branch,
1720
run_hooks=run_hooks)
1723
master_branch.unlock()
1725
def get_bound_location(self):
1727
return self.control_files.get_utf8('bound').read()[:-1]
1728
except errors.NoSuchFile:
807
1731
@needs_read_lock
808
def _clone_weave(self, to_location, revision=None, basis_branch=None):
809
assert isinstance(to_location, basestring)
810
if basis_branch is not None:
811
note("basis_branch is not supported for fast weave copy yet.")
813
history = self._get_truncated_history(revision)
814
if not bzrlib.osutils.lexists(to_location):
815
os.mkdir(to_location)
816
branch_to = Branch.initialize(to_location)
817
mutter("copy branch from %s to %s", self, branch_to)
818
branch_to.working_tree().set_root_id(self.get_root_id())
820
self.repository.copy(branch_to.repository)
1732
def get_master_branch(self):
1733
"""Return the branch we are bound to.
822
# must be done *after* history is copied across
823
# FIXME duplicate code with base .clone().
824
# .. would template method be useful here. RBC 20051207
825
branch_to.set_parent(self.base)
826
branch_to.append_revision(*history)
827
# circular import protection
828
from bzrlib.merge import build_working_dir
829
build_working_dir(to_location)
833
def clone(self, to_location, revision=None, basis_branch=None, to_branch_type=None):
834
if to_branch_type is None:
835
to_branch_type = BzrBranch
837
if to_branch_type == BzrBranch \
838
and self.repository.weave_store.listable() \
839
and self.repository.revision_store.listable():
840
return self._clone_weave(to_location, revision, basis_branch)
842
return Branch.clone(self, to_location, revision, basis_branch, to_branch_type)
845
class ScratchBranch(BzrBranch):
846
"""Special test class: a branch that cleans up after itself.
848
>>> b = ScratchBranch()
852
>>> b._transport.__del__()
857
def __init__(self, files=[], dirs=[], transport=None):
858
"""Make a test branch.
860
This creates a temporary directory and runs init-tree in it.
862
If any files are listed, they are created in the working copy.
864
if transport is None:
865
transport = bzrlib.transport.local.ScratchTransport()
866
super(ScratchBranch, self).__init__(transport, init=True)
1735
:return: Either a Branch, or None
1737
This could memoise the branch, but if thats done
1738
it must be revalidated on each new lock.
1739
So for now we just don't memoise it.
1740
# RBC 20060304 review this decision.
1742
bound_loc = self.get_bound_location()
1746
return Branch.open(bound_loc)
1747
except (errors.NotBranchError, errors.ConnectionError), e:
1748
raise errors.BoundBranchConnectionFailure(
1752
def set_bound_location(self, location):
1753
"""Set the target where this branch is bound to.
1755
:param location: URL to the target branch
1758
self.control_files.put_utf8('bound', location+'\n')
868
super(ScratchBranch, self).__init__(transport)
870
# BzrBranch creates a clone to .bzr and then forgets about the
871
# original transport. A ScratchTransport() deletes itself and
872
# everything underneath it when it goes away, so we need to
873
# grab a local copy to prevent that from happening
874
self._transport = transport
877
self._transport.mkdir(d)
880
self._transport.put(f, 'content of %s' % f)
884
>>> orig = ScratchBranch(files=["file1", "file2"])
885
>>> os.listdir(orig.base)
886
[u'.bzr', u'file1', u'file2']
887
>>> clone = orig.clone()
888
>>> if os.name != 'nt':
889
... os.path.samefile(orig.base, clone.base)
891
... orig.base == clone.base
894
>>> os.listdir(clone.base)
895
[u'.bzr', u'file1', u'file2']
897
from shutil import copytree
898
from bzrlib.osutils import mkdtemp
901
copytree(self.base, base, symlinks=True)
902
return ScratchBranch(
903
transport=bzrlib.transport.local.ScratchTransport(base))
906
######################################################################
910
def is_control_file(filename):
911
## FIXME: better check
912
filename = normpath(filename)
913
while filename != '':
914
head, tail = os.path.split(filename)
915
## mutter('check %r for control file' % ((head, tail), ))
916
if tail == bzrlib.BZRDIR:
1761
self.control_files._transport.delete('bound')
1767
def bind(self, other):
1768
"""Bind this branch to the branch other.
1770
This does not push or pull data between the branches, though it does
1771
check for divergence to raise an error when the branches are not
1772
either the same, or one a prefix of the other. That behaviour may not
1773
be useful, so that check may be removed in future.
1775
:param other: The branch to bind to
1778
# TODO: jam 20051230 Consider checking if the target is bound
1779
# It is debatable whether you should be able to bind to
1780
# a branch which is itself bound.
1781
# Committing is obviously forbidden,
1782
# but binding itself may not be.
1783
# Since we *have* to check at commit time, we don't
1784
# *need* to check here
1786
# we want to raise diverged if:
1787
# last_rev is not in the other_last_rev history, AND
1788
# other_last_rev is not in our history, and do it without pulling
1790
last_rev = _mod_revision.ensure_null(self.last_revision())
1791
if last_rev != _mod_revision.NULL_REVISION:
1794
other_last_rev = other.last_revision()
1795
if not _mod_revision.is_null(other_last_rev):
1796
# neither branch is new, we have to do some work to
1797
# ascertain diversion.
1798
remote_graph = other.repository.get_revision_graph(
1800
local_graph = self.repository.get_revision_graph(last_rev)
1801
if (last_rev not in remote_graph and
1802
other_last_rev not in local_graph):
1803
raise errors.DivergedBranches(self, other)
1806
self.set_bound_location(other.base)
1810
"""If bound, unbind"""
1811
return self.set_bound_location(None)
1815
"""Synchronise this branch with the master branch if any.
1817
:return: None or the last_revision that was pivoted out during the
1820
master = self.get_master_branch()
1821
if master is not None:
1822
old_tip = _mod_revision.ensure_null(self.last_revision())
1823
self.pull(master, overwrite=True)
1824
if self.repository.get_graph().is_ancestor(old_tip,
1825
_mod_revision.ensure_null(self.last_revision())):
1831
class BzrBranchExperimental(BzrBranch5):
1832
"""Bzr experimental branch format
1835
- a revision-history file.
1837
- a lock dir guarding the branch itself
1838
- all of this stored in a branch/ subdirectory
1839
- works with shared repositories.
1840
- a tag dictionary in the branch
1842
This format is new in bzr 0.15, but shouldn't be used for real data,
1845
This class acts as it's own BranchFormat.
1848
_matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1851
def get_format_string(cls):
1852
"""See BranchFormat.get_format_string()."""
1853
return "Bazaar-NG branch format experimental\n"
1856
def get_format_description(cls):
1857
"""See BranchFormat.get_format_description()."""
1858
return "Experimental branch format"
1861
def get_reference(cls, a_bzrdir):
1862
"""Get the target reference of the branch in a_bzrdir.
1864
format probing must have been completed before calling
1865
this method - it is assumed that the format of the branch
1866
in a_bzrdir is correct.
1868
:param a_bzrdir: The bzrdir to get the branch data from.
1869
:return: None if the branch is not a reference branch.
1874
def _initialize_control_files(cls, a_bzrdir, utf8_files, lock_filename,
1876
branch_transport = a_bzrdir.get_branch_transport(cls)
1877
control_files = lockable_files.LockableFiles(branch_transport,
1878
lock_filename, lock_class)
1879
control_files.create_lock()
1880
control_files.lock_write()
1882
for filename, content in utf8_files:
1883
control_files.put_utf8(filename, content)
1885
control_files.unlock()
1888
def initialize(cls, a_bzrdir):
1889
"""Create a branch of this format in a_bzrdir."""
1890
utf8_files = [('format', cls.get_format_string()),
1891
('revision-history', ''),
1892
('branch-name', ''),
1895
cls._initialize_control_files(a_bzrdir, utf8_files,
1896
'lock', lockdir.LockDir)
1897
return cls.open(a_bzrdir, _found=True)
1900
def open(cls, a_bzrdir, _found=False):
1901
"""Return the branch object for a_bzrdir
1903
_found is a private parameter, do not use it. It is used to indicate
1904
if format probing has already be done.
1907
format = BranchFormat.find_format(a_bzrdir)
1908
assert format.__class__ == cls
1909
transport = a_bzrdir.get_branch_transport(None)
1910
control_files = lockable_files.LockableFiles(transport, 'lock',
1912
return cls(_format=cls,
1913
_control_files=control_files,
1915
_repository=a_bzrdir.find_repository())
1918
def is_supported(cls):
1921
def _make_tags(self):
1922
return BasicTags(self)
1925
def supports_tags(cls):
1929
BranchFormat.register_format(BzrBranchExperimental)
1932
class BzrBranch6(BzrBranch5):
1935
def last_revision_info(self):
1936
revision_string = self.control_files.get('last-revision').read()
1937
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1938
revision_id = cache_utf8.get_cached_utf8(revision_id)
1940
return revno, revision_id
1942
def last_revision(self):
1943
"""Return last revision id, or None"""
1944
revision_id = self.last_revision_info()[1]
1945
if revision_id == _mod_revision.NULL_REVISION:
1949
def _write_last_revision_info(self, revno, revision_id):
1950
"""Simply write out the revision id, with no checks.
1952
Use set_last_revision_info to perform this safely.
1954
Does not update the revision_history cache.
1955
Intended to be called by set_last_revision_info and
1956
_write_revision_history.
1958
if revision_id is None:
1959
revision_id = 'null:'
1960
out_string = '%d %s\n' % (revno, revision_id)
1961
self.control_files.put_bytes('last-revision', out_string)
1964
def set_last_revision_info(self, revno, revision_id):
1965
revision_id = osutils.safe_revision_id(revision_id)
1966
if self._get_append_revisions_only():
1967
self._check_history_violation(revision_id)
1968
self._write_last_revision_info(revno, revision_id)
1969
self._clear_cached_state()
1971
def _check_history_violation(self, revision_id):
1972
last_revision = _mod_revision.ensure_null(self.last_revision())
1973
if _mod_revision.is_null(last_revision):
1975
if last_revision not in self._lefthand_history(revision_id):
1976
raise errors.AppendRevisionsOnlyViolation(self.base)
1978
def _gen_revision_history(self):
1979
"""Generate the revision history from last revision
1981
history = list(self.repository.iter_reverse_revision_history(
1982
self.last_revision()))
1986
def _write_revision_history(self, history):
1987
"""Factored out of set_revision_history.
1989
This performs the actual writing to disk, with format-specific checks.
1990
It is intended to be called by BzrBranch5.set_revision_history.
1992
if len(history) == 0:
1993
last_revision = 'null:'
1995
if history != self._lefthand_history(history[-1]):
1996
raise errors.NotLefthandHistory(history)
1997
last_revision = history[-1]
1998
if self._get_append_revisions_only():
1999
self._check_history_violation(last_revision)
2000
self._write_last_revision_info(len(history), last_revision)
2003
def append_revision(self, *revision_ids):
2004
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
2005
if len(revision_ids) == 0:
2007
prev_revno, prev_revision = self.last_revision_info()
2008
for revision in self.repository.get_revisions(revision_ids):
2009
if prev_revision == _mod_revision.NULL_REVISION:
2010
if revision.parent_ids != []:
2011
raise errors.NotLeftParentDescendant(self, prev_revision,
2012
revision.revision_id)
2014
if revision.parent_ids[0] != prev_revision:
2015
raise errors.NotLeftParentDescendant(self, prev_revision,
2016
revision.revision_id)
2017
prev_revision = revision.revision_id
2018
self.set_last_revision_info(prev_revno + len(revision_ids),
2022
def _set_parent_location(self, url):
2023
"""Set the parent branch"""
2024
self._set_config_location('parent_location', url, make_relative=True)
2027
def _get_parent_location(self):
2028
"""Set the parent branch"""
2029
return self._get_config_location('parent_location')
2031
def set_push_location(self, location):
2032
"""See Branch.set_push_location."""
2033
self._set_config_location('push_location', location)
2035
def set_bound_location(self, location):
2036
"""See Branch.set_push_location."""
2038
config = self.get_config()
2039
if location is None:
2040
if config.get_user_option('bound') != 'True':
2043
config.set_user_option('bound', 'False', warn_masked=True)
2046
self._set_config_location('bound_location', location,
2048
config.set_user_option('bound', 'True', warn_masked=True)
2051
def _get_bound_location(self, bound):
2052
"""Return the bound location in the config file.
2054
Return None if the bound parameter does not match"""
2055
config = self.get_config()
2056
config_bound = (config.get_user_option('bound') == 'True')
2057
if config_bound != bound:
2059
return self._get_config_location('bound_location', config=config)
2061
def get_bound_location(self):
2062
"""See Branch.set_push_location."""
2063
return self._get_bound_location(True)
2065
def get_old_bound_location(self):
2066
"""See Branch.get_old_bound_location"""
2067
return self._get_bound_location(False)
2069
def set_append_revisions_only(self, enabled):
2074
self.get_config().set_user_option('append_revisions_only', value,
2077
def _get_append_revisions_only(self):
2078
value = self.get_config().get_user_option('append_revisions_only')
2079
return value == 'True'
2081
def _synchronize_history(self, destination, revision_id):
2082
"""Synchronize last revision and revision history between branches.
2084
This version is most efficient when the destination is also a
2085
BzrBranch6, but works for BzrBranch5, as long as the destination's
2086
repository contains all the lefthand ancestors of the intended
2087
last_revision. If not, set_last_revision_info will fail.
2089
:param destination: The branch to copy the history into
2090
:param revision_id: The revision-id to truncate history at. May
2091
be None to copy complete history.
2093
if revision_id is None:
2094
revno, revision_id = self.last_revision_info()
2096
# To figure out the revno for a random revision, we need to build
2097
# the revision history, and count its length.
2098
# We don't care about the order, just how long it is.
2099
# Alternatively, we could start at the current location, and count
2100
# backwards. But there is no guarantee that we will find it since
2101
# it may be a merged revision.
2102
revno = len(list(self.repository.iter_reverse_revision_history(
2104
destination.set_last_revision_info(revno, revision_id)
2106
def _make_tags(self):
2107
return BasicTags(self)
2110
######################################################################
2111
# results of operations
2114
class _Result(object):
2116
def _show_tag_conficts(self, to_file):
2117
if not getattr(self, 'tag_conflicts', None):
2119
to_file.write('Conflicting tags:\n')
2120
for name, value1, value2 in self.tag_conflicts:
2121
to_file.write(' %s\n' % (name, ))
2124
class PullResult(_Result):
2125
"""Result of a Branch.pull operation.
2127
:ivar old_revno: Revision number before pull.
2128
:ivar new_revno: Revision number after pull.
2129
:ivar old_revid: Tip revision id before pull.
2130
:ivar new_revid: Tip revision id after pull.
2131
:ivar source_branch: Source (local) branch object.
2132
:ivar master_branch: Master branch of the target, or None.
2133
:ivar target_branch: Target/destination branch object.
2137
# DEPRECATED: pull used to return the change in revno
2138
return self.new_revno - self.old_revno
2140
def report(self, to_file):
2141
if self.old_revid == self.new_revid:
2142
to_file.write('No revisions to pull.\n')
2144
to_file.write('Now on revision %d.\n' % self.new_revno)
2145
self._show_tag_conficts(to_file)
2148
class PushResult(_Result):
2149
"""Result of a Branch.push operation.
2151
:ivar old_revno: Revision number before push.
2152
:ivar new_revno: Revision number after push.
2153
:ivar old_revid: Tip revision id before push.
2154
:ivar new_revid: Tip revision id after push.
2155
:ivar source_branch: Source branch object.
2156
:ivar master_branch: Master branch of the target, or None.
2157
:ivar target_branch: Target/destination branch object.
2161
# DEPRECATED: push used to return the change in revno
2162
return self.new_revno - self.old_revno
2164
def report(self, to_file):
2165
"""Write a human-readable description of the result."""
2166
if self.old_revid == self.new_revid:
2167
to_file.write('No new revisions to push.\n')
2169
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2170
self._show_tag_conficts(to_file)
2173
class BranchCheckResult(object):
2174
"""Results of checking branch consistency.
2179
def __init__(self, branch):
2180
self.branch = branch
2182
def report_results(self, verbose):
2183
"""Report the check results via trace.note.
2185
:param verbose: Requests more detailed display of what was checked,
2188
note('checked branch %s format %s',
2190
self.branch._format)
2193
class Converter5to6(object):
2194
"""Perform an in-place upgrade of format 5 to format 6"""
2196
def convert(self, branch):
2197
# Data for 5 and 6 can peacefully coexist.
2198
format = BzrBranchFormat6()
2199
new_branch = format.open(branch.bzrdir, _found=True)
2201
# Copy source data into target
2202
new_branch.set_last_revision_info(*branch.last_revision_info())
2203
new_branch.set_parent(branch.get_parent())
2204
new_branch.set_bound_location(branch.get_bound_location())
2205
new_branch.set_push_location(branch.get_push_location())
2207
# New branch has no tags by default
2208
new_branch.tags._set_tag_dict({})
2210
# Copying done; now update target format
2211
new_branch.control_files.put_utf8('format',
2212
format.get_format_string())
2214
# Clean up old files
2215
new_branch.control_files._transport.delete('revision-history')
2217
branch.set_parent(None)
2220
branch.set_bound_location(None)
added
removed
bzrlib/branch.py
