98
114
master.break_lock()
101
@deprecated_method(zero_eight)
102
def open_downlevel(base):
103
"""Open a branch which may be of an old format."""
104
return Branch.open(base, _unsupported=True)
107
def open(base, _unsupported=False):
117
def open(base, _unsupported=False, possible_transports=None):
108
118
"""Open the branch rooted at base.
110
120
For instance, if the branch is at URL/.bzr/branch,
111
121
Branch.open(URL) -> a Branch instance.
113
control = bzrdir.BzrDir.open(base, _unsupported)
114
return control.open_branch(_unsupported)
117
def open_containing(url):
123
control = bzrdir.BzrDir.open(base, _unsupported,
124
possible_transports=possible_transports)
125
return control.open_branch(_unsupported)
128
def open_from_transport(transport, _unsupported=False):
129
"""Open the branch rooted at transport"""
130
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
131
return control.open_branch(_unsupported)
134
def open_containing(url, possible_transports=None):
118
135
"""Open an existing branch which contains url.
120
137
This probes for a branch at url, and searches upwards from there.
122
139
Basically we keep looking up until we find the control directory or
123
140
run into the root. If there isn't one, raises NotBranchError.
124
If there is one and it is either an unrecognised format or an unsupported
141
If there is one and it is either an unrecognised format or an unsupported
125
142
format, UnknownFormatError or UnsupportedFormatError are raised.
126
143
If there is one, it is returned, along with the unused portion of url.
128
control, relpath = bzrdir.BzrDir.open_containing(url)
145
control, relpath = bzrdir.BzrDir.open_containing(url,
129
147
return control.open_branch(), relpath
132
@deprecated_function(zero_eight)
133
def initialize(base):
134
"""Create a new working tree and branch, rooted at 'base' (url)
136
NOTE: This will soon be deprecated in favour of creation
139
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
141
@deprecated_function(zero_eight)
142
def setup_caching(self, cache_root):
143
"""Subclasses that care about caching should override this, and set
144
up cached stores located under cache_root.
146
NOTE: This is unused.
149
def _push_should_merge_tags(self):
150
"""Should _basic_push merge this branch's tags into the target?
152
The default implementation returns False if this branch has no tags,
153
and True the rest of the time. Subclasses may override this.
155
return self.supports_tags() and self.tags.get_tag_dict()
150
157
def get_config(self):
151
return bzrlib.config.BranchConfig(self)
154
return self.get_config().get_nickname()
158
return BranchConfig(self)
160
def _get_tags_bytes(self):
161
"""Get the bytes of a serialised tags dict.
163
Note that not all branches support tags, nor do all use the same tags
164
logic: this method is specific to BasicTags. Other tag implementations
165
may use the same method name and behave differently, safely, because
166
of the double-dispatch via
167
format.make_tags->tags_instance->get_tags_dict.
169
:return: The bytes of the tags file.
170
:seealso: Branch._set_tags_bytes.
172
return self._transport.get_bytes('tags')
174
def _get_nick(self, local=False, possible_transports=None):
175
config = self.get_config()
176
# explicit overrides master, but don't look for master if local is True
177
if not local and not config.has_explicit_nickname():
179
master = self.get_master_branch(possible_transports)
180
if master is not None:
181
# return the master branch value
183
except errors.BzrError, e:
184
# Silently fall back to local implicit nick if the master is
186
mutter("Could not connect to bound branch, "
187
"falling back to local nick.\n " + str(e))
188
return config.get_nickname()
156
190
def _set_nick(self, nick):
157
self.get_config().set_user_option('nickname', nick)
191
self.get_config().set_user_option('nickname', nick, warn_masked=True)
159
193
nick = property(_get_nick, _set_nick)
161
195
def is_locked(self):
162
196
raise NotImplementedError(self.is_locked)
198
def _lefthand_history(self, revision_id, last_rev=None,
200
if 'evil' in debug.debug_flags:
201
mutter_callsite(4, "_lefthand_history scales with history.")
202
# stop_revision must be a descendant of last_revision
203
graph = self.repository.get_graph()
204
if last_rev is not None:
205
if not graph.is_ancestor(last_rev, revision_id):
206
# our previous tip is not merged into stop_revision
207
raise errors.DivergedBranches(self, other_branch)
208
# make a new revision history from the graph
209
parents_map = graph.get_parent_map([revision_id])
210
if revision_id not in parents_map:
211
raise errors.NoSuchRevision(self, revision_id)
212
current_rev_id = revision_id
214
check_not_reserved_id = _mod_revision.check_not_reserved_id
215
# Do not include ghosts or graph origin in revision_history
216
while (current_rev_id in parents_map and
217
len(parents_map[current_rev_id]) > 0):
218
check_not_reserved_id(current_rev_id)
219
new_history.append(current_rev_id)
220
current_rev_id = parents_map[current_rev_id][0]
221
parents_map = graph.get_parent_map([current_rev_id])
222
new_history.reverse()
164
225
def lock_write(self):
165
226
raise NotImplementedError(self.lock_write)
177
238
def get_physical_lock_status(self):
178
239
raise NotImplementedError(self.get_physical_lock_status)
180
def abspath(self, name):
181
"""Return absolute filename for something in the branch
183
XXX: Robert Collins 20051017 what is this used for? why is it a branch
184
method and not a tree method.
186
raise NotImplementedError(self.abspath)
242
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
243
"""Return the revision_id for a dotted revno.
245
:param revno: a tuple like (1,) or (1,1,2)
246
:param _cache_reverse: a private parameter enabling storage
247
of the reverse mapping in a top level cache. (This should
248
only be done in selective circumstances as we want to
249
avoid having the mapping cached multiple times.)
250
:return: the revision_id
251
:raises errors.NoSuchRevision: if the revno doesn't exist
253
rev_id = self._do_dotted_revno_to_revision_id(revno)
255
self._partial_revision_id_to_revno_cache[rev_id] = revno
258
def _do_dotted_revno_to_revision_id(self, revno):
259
"""Worker function for dotted_revno_to_revision_id.
261
Subclasses should override this if they wish to
262
provide a more efficient implementation.
265
return self.get_rev_id(revno[0])
266
revision_id_to_revno = self.get_revision_id_to_revno_map()
267
revision_ids = [revision_id for revision_id, this_revno
268
in revision_id_to_revno.iteritems()
269
if revno == this_revno]
270
if len(revision_ids) == 1:
271
return revision_ids[0]
273
revno_str = '.'.join(map(str, revno))
274
raise errors.NoSuchRevision(self, revno_str)
277
def revision_id_to_dotted_revno(self, revision_id):
278
"""Given a revision id, return its dotted revno.
280
:return: a tuple like (1,) or (400,1,3).
282
return self._do_revision_id_to_dotted_revno(revision_id)
284
def _do_revision_id_to_dotted_revno(self, revision_id):
285
"""Worker function for revision_id_to_revno."""
286
# Try the caches if they are loaded
287
result = self._partial_revision_id_to_revno_cache.get(revision_id)
288
if result is not None:
290
if self._revision_id_to_revno_cache:
291
result = self._revision_id_to_revno_cache.get(revision_id)
293
raise errors.NoSuchRevision(self, revision_id)
294
# Try the mainline as it's optimised
296
revno = self.revision_id_to_revno(revision_id)
298
except errors.NoSuchRevision:
299
# We need to load and use the full revno map after all
300
result = self.get_revision_id_to_revno_map().get(revision_id)
302
raise errors.NoSuchRevision(self, revision_id)
306
def get_revision_id_to_revno_map(self):
307
"""Return the revision_id => dotted revno map.
309
This will be regenerated on demand, but will be cached.
311
:return: A dictionary mapping revision_id => dotted revno.
312
This dictionary should not be modified by the caller.
314
if self._revision_id_to_revno_cache is not None:
315
mapping = self._revision_id_to_revno_cache
317
mapping = self._gen_revno_map()
318
self._cache_revision_id_to_revno(mapping)
319
# TODO: jam 20070417 Since this is being cached, should we be returning
321
# I would rather not, and instead just declare that users should not
322
# modify the return value.
325
def _gen_revno_map(self):
326
"""Create a new mapping from revision ids to dotted revnos.
328
Dotted revnos are generated based on the current tip in the revision
330
This is the worker function for get_revision_id_to_revno_map, which
331
just caches the return value.
333
:return: A dictionary mapping revision_id => dotted revno.
335
revision_id_to_revno = dict((rev_id, revno)
336
for rev_id, depth, revno, end_of_merge
337
in self.iter_merge_sorted_revisions())
338
return revision_id_to_revno
341
def iter_merge_sorted_revisions(self, start_revision_id=None,
342
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
343
"""Walk the revisions for a branch in merge sorted order.
345
Merge sorted order is the output from a merge-aware,
346
topological sort, i.e. all parents come before their
347
children going forward; the opposite for reverse.
349
:param start_revision_id: the revision_id to begin walking from.
350
If None, the branch tip is used.
351
:param stop_revision_id: the revision_id to terminate the walk
352
after. If None, the rest of history is included.
353
:param stop_rule: if stop_revision_id is not None, the precise rule
354
to use for termination:
355
* 'exclude' - leave the stop revision out of the result (default)
356
* 'include' - the stop revision is the last item in the result
357
* 'with-merges' - include the stop revision and all of its
358
merged revisions in the result
359
:param direction: either 'reverse' or 'forward':
360
* reverse means return the start_revision_id first, i.e.
361
start at the most recent revision and go backwards in history
362
* forward returns tuples in the opposite order to reverse.
363
Note in particular that forward does *not* do any intelligent
364
ordering w.r.t. depth as some clients of this API may like.
365
(If required, that ought to be done at higher layers.)
367
:return: an iterator over (revision_id, depth, revno, end_of_merge)
370
* revision_id: the unique id of the revision
371
* depth: How many levels of merging deep this node has been
373
* revno_sequence: This field provides a sequence of
374
revision numbers for all revisions. The format is:
375
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
376
branch that the revno is on. From left to right the REVNO numbers
377
are the sequence numbers within that branch of the revision.
378
* end_of_merge: When True the next node (earlier in history) is
379
part of a different merge.
381
# Note: depth and revno values are in the context of the branch so
382
# we need the full graph to get stable numbers, regardless of the
384
if self._merge_sorted_revisions_cache is None:
385
last_revision = self.last_revision()
386
graph = self.repository.get_graph()
387
parent_map = dict(((key, value) for key, value in
388
graph.iter_ancestry([last_revision]) if value is not None))
389
revision_graph = repository._strip_NULL_ghosts(parent_map)
390
revs = tsort.merge_sort(revision_graph, last_revision, None,
392
# Drop the sequence # before caching
393
self._merge_sorted_revisions_cache = [r[1:] for r in revs]
395
filtered = self._filter_merge_sorted_revisions(
396
self._merge_sorted_revisions_cache, start_revision_id,
397
stop_revision_id, stop_rule)
398
if direction == 'reverse':
400
if direction == 'forward':
401
return reversed(list(filtered))
403
raise ValueError('invalid direction %r' % direction)
405
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
406
start_revision_id, stop_revision_id, stop_rule):
407
"""Iterate over an inclusive range of sorted revisions."""
408
rev_iter = iter(merge_sorted_revisions)
409
if start_revision_id is not None:
410
for rev_id, depth, revno, end_of_merge in rev_iter:
411
if rev_id != start_revision_id:
414
# The decision to include the start or not
415
# depends on the stop_rule if a stop is provided
417
iter([(rev_id, depth, revno, end_of_merge)]),
420
if stop_revision_id is None:
421
for rev_id, depth, revno, end_of_merge in rev_iter:
422
yield rev_id, depth, revno, end_of_merge
423
elif stop_rule == 'exclude':
424
for rev_id, depth, revno, end_of_merge in rev_iter:
425
if rev_id == stop_revision_id:
427
yield rev_id, depth, revno, end_of_merge
428
elif stop_rule == 'include':
429
for rev_id, depth, revno, end_of_merge in rev_iter:
430
yield rev_id, depth, revno, end_of_merge
431
if rev_id == stop_revision_id:
433
elif stop_rule == 'with-merges':
434
stop_rev = self.repository.get_revision(stop_revision_id)
435
if stop_rev.parent_ids:
436
left_parent = stop_rev.parent_ids[0]
438
left_parent = _mod_revision.NULL_REVISION
439
for rev_id, depth, revno, end_of_merge in rev_iter:
440
if rev_id == left_parent:
442
yield rev_id, depth, revno, end_of_merge
444
raise ValueError('invalid stop_rule %r' % stop_rule)
446
def leave_lock_in_place(self):
447
"""Tell this branch object not to release the physical lock when this
450
If lock_write doesn't return a token, then this method is not supported.
452
self.control_files.leave_in_place()
454
def dont_leave_lock_in_place(self):
455
"""Tell this branch object to release the physical lock when this
456
object is unlocked, even if it didn't originally acquire it.
458
If lock_write doesn't return a token, then this method is not supported.
460
self.control_files.dont_leave_in_place()
188
462
def bind(self, other):
189
463
"""Bind the local branch the other branch.
272
540
The delta is relative to its mainline predecessor, or the
273
541
empty tree for revision 1.
275
assert isinstance(revno, int)
276
543
rh = self.revision_history()
277
544
if not (1 <= revno <= len(rh)):
278
raise InvalidRevisionNumber(revno)
545
raise errors.InvalidRevisionNumber(revno)
279
546
return self.repository.get_revision_delta(rh[revno-1])
281
def get_root_id(self):
282
"""Return the id of this branches root"""
283
raise NotImplementedError(self.get_root_id)
548
def get_stacked_on_url(self):
549
"""Get the URL this branch is stacked against.
551
:raises NotStacked: If the branch is not stacked.
552
:raises UnstackableBranchFormat: If the branch does not support
555
raise NotImplementedError(self.get_stacked_on_url)
285
557
def print_file(self, file, revision_id):
286
558
"""Print `file` to stdout."""
287
559
raise NotImplementedError(self.print_file)
289
def append_revision(self, *revision_ids):
290
raise NotImplementedError(self.append_revision)
292
561
def set_revision_history(self, rev_history):
293
562
raise NotImplementedError(self.set_revision_history)
564
def set_stacked_on_url(self, url):
565
"""Set the URL this branch is stacked against.
567
:raises UnstackableBranchFormat: If the branch does not support
569
:raises UnstackableRepositoryFormat: If the repository does not support
572
raise NotImplementedError(self.set_stacked_on_url)
574
def _set_tags_bytes(self, bytes):
575
"""Mirror method for _get_tags_bytes.
577
:seealso: Branch._get_tags_bytes.
579
return _run_with_write_locked_target(self, self._transport.put_bytes,
582
def _cache_revision_history(self, rev_history):
583
"""Set the cached revision history to rev_history.
585
The revision_history method will use this cache to avoid regenerating
586
the revision history.
588
This API is semi-public; it only for use by subclasses, all other code
589
should consider it to be private.
591
self._revision_history_cache = rev_history
593
def _cache_revision_id_to_revno(self, revision_id_to_revno):
594
"""Set the cached revision_id => revno map to revision_id_to_revno.
596
This API is semi-public; it only for use by subclasses, all other code
597
should consider it to be private.
599
self._revision_id_to_revno_cache = revision_id_to_revno
601
def _clear_cached_state(self):
602
"""Clear any cached data on this branch, e.g. cached revision history.
604
This means the next call to revision_history will need to call
605
_gen_revision_history.
607
This API is semi-public; it only for use by subclasses, all other code
608
should consider it to be private.
610
self._revision_history_cache = None
611
self._revision_id_to_revno_cache = None
612
self._last_revision_info_cache = None
613
self._merge_sorted_revisions_cache = None
615
def _gen_revision_history(self):
616
"""Return sequence of revision hashes on to this branch.
618
Unlike revision_history, this method always regenerates or rereads the
619
revision history, i.e. it does not cache the result, so repeated calls
622
Concrete subclasses should override this instead of revision_history so
623
that subclasses do not need to deal with caching logic.
625
This API is semi-public; it only for use by subclasses, all other code
626
should consider it to be private.
628
raise NotImplementedError(self._gen_revision_history)
295
631
def revision_history(self):
296
"""Return sequence of revision hashes on to this branch."""
297
raise NotImplementedError('revision_history is abstract')
632
"""Return sequence of revision ids on this branch.
634
This method will cache the revision history for as long as it is safe to
637
if 'evil' in debug.debug_flags:
638
mutter_callsite(3, "revision_history scales with history.")
639
if self._revision_history_cache is not None:
640
history = self._revision_history_cache
642
history = self._gen_revision_history()
643
self._cache_revision_history(history)
300
647
"""Return current revision number for this branch.
329
695
common_index = min(self_len, other_len) -1
330
696
if common_index >= 0 and \
331
697
self_history[common_index] != other_history[common_index]:
332
raise DivergedBranches(self, other)
698
raise errors.DivergedBranches(self, other)
334
700
if stop_revision is None:
335
701
stop_revision = other_len
337
assert isinstance(stop_revision, int)
338
703
if stop_revision > other_len:
339
704
raise errors.NoSuchRevision(self, stop_revision)
340
705
return other_history[self_len:stop_revision]
342
def update_revisions(self, other, stop_revision=None):
708
def update_revisions(self, other, stop_revision=None, overwrite=False,
343
710
"""Pull in new perfect-fit revisions.
345
712
:param other: Another Branch to pull from
346
713
:param stop_revision: Updated until the given revision
714
:param overwrite: Always set the branch pointer, rather than checking
715
to see if it is a proper descendant.
716
:param graph: A Graph object that can be used to query history
717
information. This can be None.
349
raise NotImplementedError(self.update_revisions)
720
return InterBranch.get(other, self).update_revisions(stop_revision,
723
def import_last_revision_info(self, source_repo, revno, revid):
724
"""Set the last revision info, importing from another repo if necessary.
726
This is used by the bound branch code to upload a revision to
727
the master branch first before updating the tip of the local branch.
729
:param source_repo: Source repository to optionally fetch from
730
:param revno: Revision number of the new tip
731
:param revid: Revision id of the new tip
733
if not self.repository.has_same_location(source_repo):
734
self.repository.fetch(source_repo, revision_id=revid)
735
self.set_last_revision_info(revno, revid)
351
737
def revision_id_to_revno(self, revision_id):
352
738
"""Given a revision id, return its revno"""
353
if revision_id is None:
739
if _mod_revision.is_null(revision_id):
355
741
history = self.revision_history()
357
743
return history.index(revision_id) + 1
358
744
except ValueError:
359
raise bzrlib.errors.NoSuchRevision(self, revision_id)
745
raise errors.NoSuchRevision(self, revision_id)
361
747
def get_rev_id(self, revno, history=None):
362
748
"""Find the revision id of the specified revno."""
750
return _mod_revision.NULL_REVISION
365
751
if history is None:
366
752
history = self.revision_history()
367
753
if revno <= 0 or revno > len(history):
368
raise bzrlib.errors.NoSuchRevision(self, revno)
754
raise errors.NoSuchRevision(self, revno)
369
755
return history[revno - 1]
371
def pull(self, source, overwrite=False, stop_revision=None):
757
def pull(self, source, overwrite=False, stop_revision=None,
758
possible_transports=None, _override_hook_target=None):
759
"""Mirror source into this branch.
761
This branch is considered to be 'local', having low latency.
763
:returns: PullResult instance
372
765
raise NotImplementedError(self.pull)
767
def push(self, target, overwrite=False, stop_revision=None):
768
"""Mirror this branch into target.
770
This branch is considered to be 'local', having low latency.
772
raise NotImplementedError(self.push)
374
774
def basis_tree(self):
375
775
"""Return `Tree` object for last revision."""
376
776
return self.repository.revision_tree(self.last_revision())
378
def rename_one(self, from_rel, to_rel):
381
This can change the directory or the filename or both.
383
raise NotImplementedError(self.rename_one)
385
def move(self, from_paths, to_name):
388
to_name must exist as a versioned directory.
390
If to_name exists and is a directory, the files are moved into
391
it, keeping their old names. If it is a directory,
393
Note that to_name is only the last component of the new name;
394
this doesn't change the directory.
396
This returns a list of (from_path, to_path) pairs for each
399
raise NotImplementedError(self.move)
401
778
def get_parent(self):
402
779
"""Return the parent location of the branch.
404
This is the default location for push/pull/missing. The usual
781
This is the default location for pull/missing. The usual
405
782
pattern is that the user can override it by specifying a
408
raise NotImplementedError(self.get_parent)
785
parent = self._get_parent_location()
788
# This is an old-format absolute path to a local branch
790
if parent.startswith('/'):
791
parent = urlutils.local_path_to_url(parent.decode('utf8'))
793
return urlutils.join(self.base[:-1], parent)
794
except errors.InvalidURLJoin, e:
795
raise errors.InaccessibleParent(parent, self.base)
797
def _get_parent_location(self):
798
raise NotImplementedError(self._get_parent_location)
800
def _set_config_location(self, name, url, config=None,
801
make_relative=False):
803
config = self.get_config()
807
url = urlutils.relative_url(self.base, url)
808
config.set_user_option(name, url, warn_masked=True)
810
def _get_config_location(self, name, config=None):
812
config = self.get_config()
813
location = config.get_user_option(name)
410
818
def get_submit_branch(self):
411
819
"""Return the submit location of the branch.
453
909
self.check_real_revno(revno)
455
911
def check_real_revno(self, revno):
457
913
Check whether a revno corresponds to a real revision.
458
914
Zero (the NULL revision) is considered invalid
460
916
if revno < 1 or revno > self.revno():
461
raise InvalidRevisionNumber(revno)
917
raise errors.InvalidRevisionNumber(revno)
464
def clone(self, *args, **kwargs):
920
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
465
921
"""Clone this branch into to_bzrdir preserving all semantic values.
923
Most API users will want 'create_clone_on_transport', which creates a
924
new bzrdir and branch on the fly.
467
926
revision_id: if not None, the revision history in the new branch will
468
927
be truncated to end with revision_id.
470
# for API compatibility, until 0.8 releases we provide the old api:
471
# def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
472
# after 0.8 releases, the *args and **kwargs should be changed:
473
# def clone(self, to_bzrdir, revision_id=None):
474
if (kwargs.get('to_location', None) or
475
kwargs.get('revision', None) or
476
kwargs.get('basis_branch', None) or
477
(len(args) and isinstance(args[0], basestring))):
478
# backwards compatibility api:
479
warn("Branch.clone() has been deprecated for BzrDir.clone() from"
480
" bzrlib 0.8.", DeprecationWarning, stacklevel=3)
483
basis_branch = args[2]
485
basis_branch = kwargs.get('basis_branch', None)
487
basis = basis_branch.bzrdir
492
revision_id = args[1]
494
revision_id = kwargs.get('revision', None)
499
# no default to raise if not provided.
500
url = kwargs.get('to_location')
501
return self.bzrdir.clone(url,
502
revision_id=revision_id,
503
basis=basis).open_branch()
505
# generate args by hand
507
revision_id = args[1]
509
revision_id = kwargs.get('revision_id', None)
513
# no default to raise if not provided.
514
to_bzrdir = kwargs.get('to_bzrdir')
515
result = self._format.initialize(to_bzrdir)
929
result = to_bzrdir.create_branch()
930
if repository_policy is not None:
931
repository_policy.configure_branch(result)
516
932
self.copy_content_into(result, revision_id=revision_id)
520
def sprout(self, to_bzrdir, revision_id=None):
936
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
521
937
"""Create a new line of development from the branch, into to_bzrdir.
939
to_bzrdir controls the branch format.
523
941
revision_id: if not None, the revision history in the new branch will
524
942
be truncated to end with revision_id.
526
result = self._format.initialize(to_bzrdir)
944
result = to_bzrdir.create_branch()
945
if repository_policy is not None:
946
repository_policy.configure_branch(result)
527
947
self.copy_content_into(result, revision_id=revision_id)
528
948
result.set_parent(self.bzrdir.root_transport.base)
951
def _synchronize_history(self, destination, revision_id):
952
"""Synchronize last revision and revision history between branches.
954
This version is most efficient when the destination is also a
955
BzrBranch6, but works for BzrBranch5, as long as the destination's
956
repository contains all the lefthand ancestors of the intended
957
last_revision. If not, set_last_revision_info will fail.
959
:param destination: The branch to copy the history into
960
:param revision_id: The revision-id to truncate history at. May
961
be None to copy complete history.
963
source_revno, source_revision_id = self.last_revision_info()
964
if revision_id is None:
965
revno, revision_id = source_revno, source_revision_id
966
elif source_revision_id == revision_id:
967
# we know the revno without needing to walk all of history
970
# To figure out the revno for a random revision, we need to build
971
# the revision history, and count its length.
972
# We don't care about the order, just how long it is.
973
# Alternatively, we could start at the current location, and count
974
# backwards. But there is no guarantee that we will find it since
975
# it may be a merged revision.
976
revno = len(list(self.repository.iter_reverse_revision_history(
978
destination.set_last_revision_info(revno, revision_id)
532
981
def copy_content_into(self, destination, revision_id=None):
533
982
"""Copy the content of self into destination.
584
1037
def _get_checkout_format(self):
585
1038
"""Return the most suitable metadir for a checkout of this branch.
586
Weaves are used if this branch's repostory uses weaves.
1039
Weaves are used if this branch's repository uses weaves.
588
1041
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
589
from bzrlib import repository
1042
from bzrlib.repofmt import weaverepo
590
1043
format = bzrdir.BzrDirMetaFormat1()
591
format.repository_format = repository.RepositoryFormat7()
1044
format.repository_format = weaverepo.RepositoryFormat7()
593
format = self.repository.bzrdir.cloning_metadir()
1046
format = self.repository.bzrdir.checkout_metadir()
1047
format.set_branch_format(self._format)
596
def create_checkout(self, to_location, revision_id=None,
1050
def create_clone_on_transport(self, to_transport, revision_id=None,
1052
"""Create a clone of this branch and its bzrdir.
1054
:param to_transport: The transport to clone onto.
1055
:param revision_id: The revision id to use as tip in the new branch.
1056
If None the tip is obtained from this branch.
1057
:param stacked_on: An optional URL to stack the clone on.
1059
# XXX: Fix the bzrdir API to allow getting the branch back from the
1060
# clone call. Or something. 20090224 RBC/spiv.
1061
dir_to = self.bzrdir.clone_on_transport(to_transport,
1062
revision_id=revision_id, stacked_on=stacked_on)
1063
return dir_to.open_branch()
1065
def create_checkout(self, to_location, revision_id=None,
1066
lightweight=False, accelerator_tree=None,
598
1068
"""Create a checkout of a branch.
600
1070
:param to_location: The url to produce the checkout at
601
1071
:param revision_id: The revision to check out
602
1072
:param lightweight: If True, produce a lightweight checkout, otherwise,
603
1073
produce a bound branch (heavyweight checkout)
1074
:param accelerator_tree: A tree which can be used for retrieving file
1075
contents more quickly than the revision tree, i.e. a workingtree.
1076
The revision tree will be used for cases where accelerator_tree's
1077
content is different.
1078
:param hardlink: If true, hard-link files from accelerator_tree,
604
1080
:return: The tree of the created checkout
606
1082
t = transport.get_transport(to_location)
609
except errors.FileExists:
612
checkout = bzrdir.BzrDirMetaFormat1().initialize_on_transport(t)
613
BranchReferenceFormat().initialize(checkout, self)
1085
format = self._get_checkout_format()
1086
checkout = format.initialize_on_transport(t)
1087
from_branch = BranchReferenceFormat().initialize(checkout, self)
615
1089
format = self._get_checkout_format()
616
1090
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
617
1091
to_location, force_new_tree=False, format=format)
618
1092
checkout = checkout_branch.bzrdir
619
1093
checkout_branch.bind(self)
620
if revision_id is not None:
621
rh = checkout_branch.revision_history()
622
new_rh = rh[:rh.index(revision_id) + 1]
623
checkout_branch.set_revision_history(new_rh)
624
return checkout.create_workingtree(revision_id)
1094
# pull up to the specified revision_id to set the initial
1095
# branch tip correctly, and seed it with history.
1096
checkout_branch.pull(self, stop_revision=revision_id)
1098
tree = checkout.create_workingtree(revision_id,
1099
from_branch=from_branch,
1100
accelerator_tree=accelerator_tree,
1102
basis_tree = tree.basis_tree()
1103
basis_tree.lock_read()
1105
for path, file_id in basis_tree.iter_references():
1106
reference_parent = self.reference_parent(file_id, path)
1107
reference_parent.create_checkout(tree.abspath(path),
1108
basis_tree.get_reference_revision(file_id, path),
1115
def reconcile(self, thorough=True):
1116
"""Make sure the data stored in this branch is consistent."""
1117
from bzrlib.reconcile import BranchReconciler
1118
reconciler = BranchReconciler(self, thorough=thorough)
1119
reconciler.reconcile()
1122
def reference_parent(self, file_id, path):
1123
"""Return the parent branch for a tree-reference file_id
1124
:param file_id: The file_id of the tree reference
1125
:param path: The path of the file_id in the tree
1126
:return: A branch associated with the file_id
1128
# FIXME should provide multiple branches, based on config
1129
return Branch.open(self.bzrdir.root_transport.clone(path).base)
1131
def supports_tags(self):
1132
return self._format.supports_tags()
1134
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1136
"""Ensure that revision_b is a descendant of revision_a.
1138
This is a helper function for update_revisions.
1140
:raises: DivergedBranches if revision_b has diverged from revision_a.
1141
:returns: True if revision_b is a descendant of revision_a.
1143
relation = self._revision_relations(revision_a, revision_b, graph)
1144
if relation == 'b_descends_from_a':
1146
elif relation == 'diverged':
1147
raise errors.DivergedBranches(self, other_branch)
1148
elif relation == 'a_descends_from_b':
1151
raise AssertionError("invalid relation: %r" % (relation,))
1153
def _revision_relations(self, revision_a, revision_b, graph):
1154
"""Determine the relationship between two revisions.
1156
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1158
heads = graph.heads([revision_a, revision_b])
1159
if heads == set([revision_b]):
1160
return 'b_descends_from_a'
1161
elif heads == set([revision_a, revision_b]):
1162
# These branches have diverged
1164
elif heads == set([revision_a]):
1165
return 'a_descends_from_b'
1167
raise AssertionError("invalid heads: %r" % (heads,))
627
1170
class BranchFormat(object):
655
1204
transport = a_bzrdir.get_branch_transport(None)
656
1205
format_string = transport.get("format").read()
657
1206
return klass._formats[format_string]
659
raise NotBranchError(path=transport.base)
1207
except errors.NoSuchFile:
1208
raise errors.NotBranchError(path=transport.base)
660
1209
except KeyError:
661
raise errors.UnknownFormatError(format=format_string)
1210
raise errors.UnknownFormatError(format=format_string, kind='branch')
664
1213
def get_default_format(klass):
665
1214
"""Return the current default format."""
666
1215
return klass._default_format
1217
def get_reference(self, a_bzrdir):
1218
"""Get the target reference of the branch in a_bzrdir.
1220
format probing must have been completed before calling
1221
this method - it is assumed that the format of the branch
1222
in a_bzrdir is correct.
1224
:param a_bzrdir: The bzrdir to get the branch data from.
1225
:return: None if the branch is not a reference branch.
1230
def set_reference(self, a_bzrdir, to_branch):
1231
"""Set the target reference of the branch in a_bzrdir.
1233
format probing must have been completed before calling
1234
this method - it is assumed that the format of the branch
1235
in a_bzrdir is correct.
1237
:param a_bzrdir: The bzrdir to set the branch reference for.
1238
:param to_branch: branch that the checkout is to reference
1240
raise NotImplementedError(self.set_reference)
668
1242
def get_format_string(self):
669
1243
"""Return the ASCII format string that identifies this format."""
670
1244
raise NotImplementedError(self.get_format_string)
672
1246
def get_format_description(self):
673
1247
"""Return the short format description for this format."""
674
raise NotImplementedError(self.get_format_string)
1248
raise NotImplementedError(self.get_format_description)
1250
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
1252
"""Initialize a branch in a bzrdir, with specified files
1254
:param a_bzrdir: The bzrdir to initialize the branch in
1255
:param utf8_files: The files to create as a list of
1256
(filename, content) tuples
1257
:param set_format: If True, set the format with
1258
self.get_format_string. (BzrBranch4 has its format set
1260
:return: a branch in this format
1262
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1263
branch_transport = a_bzrdir.get_branch_transport(self)
1265
'metadir': ('lock', lockdir.LockDir),
1266
'branch4': ('branch-lock', lockable_files.TransportLock),
1268
lock_name, lock_class = lock_map[lock_type]
1269
control_files = lockable_files.LockableFiles(branch_transport,
1270
lock_name, lock_class)
1271
control_files.create_lock()
1272
control_files.lock_write()
1274
utf8_files += [('format', self.get_format_string())]
1276
for (filename, content) in utf8_files:
1277
branch_transport.put_bytes(
1279
mode=a_bzrdir._get_file_mode())
1281
control_files.unlock()
1282
return self.open(a_bzrdir, _found=True)
676
1284
def initialize(self, a_bzrdir):
677
1285
"""Create a branch of this format in a_bzrdir."""
681
1289
"""Is this format supported?
683
1291
Supported formats can be initialized and opened.
684
Unsupported formats may not support initialization or committing or
1292
Unsupported formats may not support initialization or committing or
685
1293
some other features depending on the reason for not being supported.
689
def open(self, a_bzrdir, _found=False):
1297
def make_tags(self, branch):
1298
"""Create a tags object for branch.
1300
This method is on BranchFormat, because BranchFormats are reflected
1301
over the wire via network_name(), whereas full Branch instances require
1302
multiple VFS method calls to operate at all.
1304
The default implementation returns a disabled-tags instance.
1306
Note that it is normal for branch to be a RemoteBranch when using tags
1309
return DisabledTags(branch)
1311
def network_name(self):
1312
"""A simple byte string uniquely identifying this format for RPC calls.
1314
MetaDir branch formats use their disk format string to identify the
1315
repository over the wire. All in one formats such as bzr < 0.8, and
1316
foreign formats like svn/git and hg should use some marker which is
1317
unique and immutable.
1319
raise NotImplementedError(self.network_name)
1321
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
690
1322
"""Return the branch object for a_bzrdir
692
_found is a private parameter, do not use it. It is used to indicate
693
if format probing has already be done.
1324
:param a_bzrdir: A BzrDir that contains a branch.
1325
:param _found: a private parameter, do not use it. It is used to
1326
indicate if format probing has already be done.
1327
:param ignore_fallbacks: when set, no fallback branches will be opened
1328
(if there are any). Default is to open fallbacks.
695
1330
raise NotImplementedError(self.open)
698
1333
def register_format(klass, format):
1334
"""Register a metadir format."""
699
1335
klass._formats[format.get_format_string()] = format
1336
# Metadir formats have a network name of their format string, and get
1337
# registered as class factories.
1338
network_format_registry.register(format.get_format_string(), format.__class__)
702
1341
def set_default_format(klass, format):
703
1342
klass._default_format = format
1344
def supports_stacking(self):
1345
"""True if this format records a stacked-on branch."""
706
1349
def unregister_format(klass, format):
707
assert klass._formats[format.get_format_string()] is format
708
1350
del klass._formats[format.get_format_string()]
710
1352
def __str__(self):
711
return self.get_format_string().rstrip()
1353
return self.get_format_description().rstrip()
1355
def supports_tags(self):
1356
"""True if this format supports tags stored in the branch"""
1357
return False # by default
1360
class BranchHooks(Hooks):
1361
"""A dictionary mapping hook name to a list of callables for branch hooks.
1363
e.g. ['set_rh'] Is the list of items to be called when the
1364
set_revision_history function is invoked.
1368
"""Create the default hooks.
1370
These are all empty initially, because by default nothing should get
1373
Hooks.__init__(self)
1374
self.create_hook(HookPoint('set_rh',
1375
"Invoked whenever the revision history has been set via "
1376
"set_revision_history. The api signature is (branch, "
1377
"revision_history), and the branch will be write-locked. "
1378
"The set_rh hook can be expensive for bzr to trigger, a better "
1379
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1380
self.create_hook(HookPoint('open',
1381
"Called with the Branch object that has been opened after a "
1382
"branch is opened.", (1, 8), None))
1383
self.create_hook(HookPoint('post_push',
1384
"Called after a push operation completes. post_push is called "
1385
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1386
"bzr client.", (0, 15), None))
1387
self.create_hook(HookPoint('post_pull',
1388
"Called after a pull operation completes. post_pull is called "
1389
"with a bzrlib.branch.PullResult object and only runs in the "
1390
"bzr client.", (0, 15), None))
1391
self.create_hook(HookPoint('pre_commit',
1392
"Called after a commit is calculated but before it is is "
1393
"completed. pre_commit is called with (local, master, old_revno, "
1394
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1395
"). old_revid is NULL_REVISION for the first commit to a branch, "
1396
"tree_delta is a TreeDelta object describing changes from the "
1397
"basis revision. hooks MUST NOT modify this delta. "
1398
" future_tree is an in-memory tree obtained from "
1399
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1400
"tree.", (0,91), None))
1401
self.create_hook(HookPoint('post_commit',
1402
"Called in the bzr client after a commit has completed. "
1403
"post_commit is called with (local, master, old_revno, old_revid, "
1404
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1405
"commit to a branch.", (0, 15), None))
1406
self.create_hook(HookPoint('post_uncommit',
1407
"Called in the bzr client after an uncommit completes. "
1408
"post_uncommit is called with (local, master, old_revno, "
1409
"old_revid, new_revno, new_revid) where local is the local branch "
1410
"or None, master is the target branch, and an empty branch "
1411
"recieves new_revno of 0, new_revid of None.", (0, 15), None))
1412
self.create_hook(HookPoint('pre_change_branch_tip',
1413
"Called in bzr client and server before a change to the tip of a "
1414
"branch is made. pre_change_branch_tip is called with a "
1415
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1416
"commit, uncommit will all trigger this hook.", (1, 6), None))
1417
self.create_hook(HookPoint('post_change_branch_tip',
1418
"Called in bzr client and server after a change to the tip of a "
1419
"branch is made. post_change_branch_tip is called with a "
1420
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1421
"commit, uncommit will all trigger this hook.", (1, 4), None))
1422
self.create_hook(HookPoint('transform_fallback_location',
1423
"Called when a stacked branch is activating its fallback "
1424
"locations. transform_fallback_location is called with (branch, "
1425
"url), and should return a new url. Returning the same url "
1426
"allows it to be used as-is, returning a different one can be "
1427
"used to cause the branch to stack on a closer copy of that "
1428
"fallback_location. Note that the branch cannot have history "
1429
"accessing methods called on it during this hook because the "
1430
"fallback locations have not been activated. When there are "
1431
"multiple hooks installed for transform_fallback_location, "
1432
"all are called with the url returned from the previous hook."
1433
"The order is however undefined.", (1, 9), None))
1436
# install the default hooks into the Branch class.
1437
Branch.hooks = BranchHooks()
1440
class ChangeBranchTipParams(object):
1441
"""Object holding parameters passed to *_change_branch_tip hooks.
1443
There are 5 fields that hooks may wish to access:
1445
:ivar branch: the branch being changed
1446
:ivar old_revno: revision number before the change
1447
:ivar new_revno: revision number after the change
1448
:ivar old_revid: revision id before the change
1449
:ivar new_revid: revision id after the change
1451
The revid fields are strings. The revno fields are integers.
1454
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1455
"""Create a group of ChangeBranchTip parameters.
1457
:param branch: The branch being changed.
1458
:param old_revno: Revision number before the change.
1459
:param new_revno: Revision number after the change.
1460
:param old_revid: Tip revision id before the change.
1461
:param new_revid: Tip revision id after the change.
1463
self.branch = branch
1464
self.old_revno = old_revno
1465
self.new_revno = new_revno
1466
self.old_revid = old_revid
1467
self.new_revid = new_revid
1469
def __eq__(self, other):
1470
return self.__dict__ == other.__dict__
1473
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1474
self.__class__.__name__, self.branch,
1475
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
714
1478
class BzrBranchFormat4(BranchFormat):
783
1582
def get_format_description(self):
784
1583
"""See BranchFormat.get_format_description()."""
785
1584
return "Branch format 5"
787
1586
def initialize(self, a_bzrdir):
788
1587
"""Create a branch of this format in a_bzrdir."""
789
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
790
branch_transport = a_bzrdir.get_branch_transport(self)
791
1588
utf8_files = [('revision-history', ''),
792
1589
('branch-name', ''),
794
control_files = LockableFiles(branch_transport, 'lock', lockdir.LockDir)
795
control_files.create_lock()
796
control_files.lock_write()
797
control_files.put_utf8('format', self.get_format_string())
799
for file, content in utf8_files:
800
control_files.put_utf8(file, content)
802
control_files.unlock()
803
return self.open(a_bzrdir, _found=True, )
1591
return self._initialize_helper(a_bzrdir, utf8_files)
1593
def supports_tags(self):
1597
class BzrBranchFormat6(BranchFormatMetadir):
1598
"""Branch format with last-revision and tags.
1600
Unlike previous formats, this has no explicit revision history. Instead,
1601
this just stores the last-revision, and the left-hand history leading
1602
up to there is the history.
1604
This format was introduced in bzr 0.15
1605
and became the default in 0.91.
1608
def _branch_class(self):
1611
def get_format_string(self):
1612
"""See BranchFormat.get_format_string()."""
1613
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1615
def get_format_description(self):
1616
"""See BranchFormat.get_format_description()."""
1617
return "Branch format 6"
1619
def initialize(self, a_bzrdir):
1620
"""Create a branch of this format in a_bzrdir."""
1621
utf8_files = [('last-revision', '0 null:\n'),
1622
('branch.conf', ''),
1625
return self._initialize_helper(a_bzrdir, utf8_files)
1627
def make_tags(self, branch):
1628
"""See bzrlib.branch.BranchFormat.make_tags()."""
1629
return BasicTags(branch)
1633
class BzrBranchFormat7(BranchFormatMetadir):
1634
"""Branch format with last-revision, tags, and a stacked location pointer.
1636
The stacked location pointer is passed down to the repository and requires
1637
a repository format with supports_external_lookups = True.
1639
This format was introduced in bzr 1.6.
1642
def _branch_class(self):
1645
def get_format_string(self):
1646
"""See BranchFormat.get_format_string()."""
1647
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
1649
def get_format_description(self):
1650
"""See BranchFormat.get_format_description()."""
1651
return "Branch format 7"
1653
def initialize(self, a_bzrdir):
1654
"""Create a branch of this format in a_bzrdir."""
1655
utf8_files = [('last-revision', '0 null:\n'),
1656
('branch.conf', ''),
1659
return self._initialize_helper(a_bzrdir, utf8_files)
805
1661
def __init__(self):
806
super(BzrBranchFormat5, self).__init__()
807
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
809
def open(self, a_bzrdir, _found=False):
810
"""Return the branch object for a_bzrdir
812
_found is a private parameter, do not use it. It is used to indicate
813
if format probing has already be done.
816
format = BranchFormat.find_format(a_bzrdir)
817
assert format.__class__ == self.__class__
818
transport = a_bzrdir.get_branch_transport(None)
819
control_files = LockableFiles(transport, 'lock', lockdir.LockDir)
820
return BzrBranch5(_format=self,
821
_control_files=control_files,
823
_repository=a_bzrdir.find_repository())
826
return "Bazaar-NG Metadir branch format 5"
1662
super(BzrBranchFormat7, self).__init__()
1663
self._matchingbzrdir.repository_format = \
1664
RepositoryFormatKnitPack5RichRoot()
1666
def make_tags(self, branch):
1667
"""See bzrlib.branch.BranchFormat.make_tags()."""
1668
return BasicTags(branch)
1670
def supports_stacking(self):
829
1674
class BranchReferenceFormat(BranchFormat):
911
1798
Note that it's "local" in the context of the filesystem; it doesn't
912
1799
really matter if it's on an nfs/smb/afs/coda/... share, as long as
913
1800
it's writable, and can be accessed via the normal filesystem API.
1802
:ivar _transport: Transport for file operations on this branch's
1803
control files, typically pointing to the .bzr/branch directory.
1804
:ivar repository: Repository for this branch.
1805
:ivar base: The url of the base directory for this branch; the one
1806
containing the .bzr directory.
916
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
917
relax_version_check=DEPRECATED_PARAMETER, _format=None,
918
_control_files=None, a_bzrdir=None, _repository=None):
919
"""Create new branch object at a particular location.
921
transport -- A Transport object, defining how to access files.
923
init -- If True, create new control files in a previously
924
unversioned directory. If False, the branch must already
927
relax_version_check -- If true, the usual check for the branch
928
version is not applied. This is intended only for
929
upgrade/recovery type use; it's not guaranteed that
930
all operations will work on old format branches.
1809
def __init__(self, _format=None,
1810
_control_files=None, a_bzrdir=None, _repository=None,
1811
ignore_fallbacks=False):
1812
"""Create new branch object at a particular location."""
932
1813
if a_bzrdir is None:
933
self.bzrdir = bzrdir.BzrDir.open(transport.base)
1814
raise ValueError('a_bzrdir must be supplied')
935
1816
self.bzrdir = a_bzrdir
936
self._transport = self.bzrdir.transport.clone('..')
937
self._base = self._transport.base
1817
self._base = self.bzrdir.transport.clone('..').base
1818
# XXX: We should be able to just do
1819
# self.base = self.bzrdir.root_transport.base
1820
# but this does not quite work yet -- mbp 20080522
938
1821
self._format = _format
939
1822
if _control_files is None:
940
1823
raise ValueError('BzrBranch _control_files is None')
941
1824
self.control_files = _control_files
942
if deprecated_passed(init):
943
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
944
"deprecated as of bzr 0.8. Please use Branch.create().",
948
# this is slower than before deprecation, oh well never mind.
950
self._initialize(transport.base)
951
self._check_format(_format)
952
if deprecated_passed(relax_version_check):
953
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
954
"relax_version_check parameter is deprecated as of bzr 0.8. "
955
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
959
if (not relax_version_check
960
and not self._format.is_supported()):
961
raise errors.UnsupportedFormatError(format=fmt)
962
if deprecated_passed(transport):
963
warn("BzrBranch.__init__(transport=XXX...): The transport "
964
"parameter is deprecated as of bzr 0.8. "
965
"Please use Branch.open, or bzrdir.open_branch().",
1825
self._transport = _control_files._transport
968
1826
self.repository = _repository
1827
Branch.__init__(self)
970
1829
def __str__(self):
971
1830
return '%s(%r)' % (self.__class__.__name__, self.base)
1066
1881
"""See Branch.print_file."""
1067
1882
return self.repository.print_file(file, revision_id)
1070
def append_revision(self, *revision_ids):
1071
"""See Branch.append_revision."""
1072
for revision_id in revision_ids:
1073
mutter("add {%s} to revision-history" % revision_id)
1074
rev_history = self.revision_history()
1075
rev_history.extend(revision_ids)
1076
self.set_revision_history(rev_history)
1884
def _write_revision_history(self, history):
1885
"""Factored out of set_revision_history.
1887
This performs the actual writing to disk.
1888
It is intended to be called by BzrBranch5.set_revision_history."""
1889
self._transport.put_bytes(
1890
'revision-history', '\n'.join(history),
1891
mode=self.bzrdir._get_file_mode())
1078
1893
@needs_write_lock
1079
1894
def set_revision_history(self, rev_history):
1080
1895
"""See Branch.set_revision_history."""
1081
self.control_files.put_utf8(
1082
'revision-history', '\n'.join(rev_history))
1083
transaction = self.get_transaction()
1084
history = transaction.map.find_revision_history()
1085
if history is not None:
1086
# update the revision history in the identity map.
1087
history[:] = list(rev_history)
1088
# this call is disabled because revision_history is
1089
# not really an object yet, and the transaction is for objects.
1090
# transaction.register_dirty(history)
1092
transaction.map.add_revision_history(rev_history)
1093
# this call is disabled because revision_history is
1094
# not really an object yet, and the transaction is for objects.
1095
# transaction.register_clean(history)
1098
def revision_history(self):
1099
"""See Branch.revision_history."""
1100
transaction = self.get_transaction()
1101
history = transaction.map.find_revision_history()
1102
if history is not None:
1103
# mutter("cache hit for revision-history in %s", self)
1104
return list(history)
1105
decode_utf8 = cache_utf8.decode
1106
history = [decode_utf8(l.rstrip('\r\n')) for l in
1107
self.control_files.get('revision-history').readlines()]
1108
transaction.map.add_revision_history(history)
1109
# this call is disabled because revision_history is
1110
# not really an object yet, and the transaction is for objects.
1111
# transaction.register_clean(history, precious=True)
1112
return list(history)
1115
def generate_revision_history(self, revision_id, last_rev=None,
1896
if 'evil' in debug.debug_flags:
1897
mutter_callsite(3, "set_revision_history scales with history.")
1898
check_not_reserved_id = _mod_revision.check_not_reserved_id
1899
for rev_id in rev_history:
1900
check_not_reserved_id(rev_id)
1901
if Branch.hooks['post_change_branch_tip']:
1902
# Don't calculate the last_revision_info() if there are no hooks
1904
old_revno, old_revid = self.last_revision_info()
1905
if len(rev_history) == 0:
1906
revid = _mod_revision.NULL_REVISION
1908
revid = rev_history[-1]
1909
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
1910
self._write_revision_history(rev_history)
1911
self._clear_cached_state()
1912
self._cache_revision_history(rev_history)
1913
for hook in Branch.hooks['set_rh']:
1914
hook(self, rev_history)
1915
if Branch.hooks['post_change_branch_tip']:
1916
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1918
def _synchronize_history(self, destination, revision_id):
1919
"""Synchronize last revision and revision history between branches.
1921
This version is most efficient when the destination is also a
1922
BzrBranch5, but works for BzrBranch6 as long as the revision
1923
history is the true lefthand parent history, and all of the revisions
1924
are in the destination's repository. If not, set_revision_history
1927
:param destination: The branch to copy the history into
1928
:param revision_id: The revision-id to truncate history at. May
1929
be None to copy complete history.
1931
if not isinstance(destination._format, BzrBranchFormat5):
1932
super(BzrBranch, self)._synchronize_history(
1933
destination, revision_id)
1935
if revision_id == _mod_revision.NULL_REVISION:
1938
new_history = self.revision_history()
1939
if revision_id is not None and new_history != []:
1941
new_history = new_history[:new_history.index(revision_id) + 1]
1943
rev = self.repository.get_revision(revision_id)
1944
new_history = rev.get_history(self.repository)[1:]
1945
destination.set_revision_history(new_history)
1948
def set_last_revision_info(self, revno, revision_id):
1949
"""Set the last revision of this branch.
1951
The caller is responsible for checking that the revno is correct
1952
for this revision id.
1954
It may be possible to set the branch last revision to an id not
1955
present in the repository. However, branches can also be
1956
configured to check constraints on history, in which case this may not
1959
revision_id = _mod_revision.ensure_null(revision_id)
1960
# this old format stores the full history, but this api doesn't
1961
# provide it, so we must generate, and might as well check it's
1963
history = self._lefthand_history(revision_id)
1964
if len(history) != revno:
1965
raise AssertionError('%d != %d' % (len(history), revno))
1966
self.set_revision_history(history)
1968
def _gen_revision_history(self):
1969
history = self._transport.get_bytes('revision-history').split('\n')
1970
if history[-1:] == ['']:
1971
# There shouldn't be a trailing newline, but just in case.
1976
def generate_revision_history(self, revision_id, last_rev=None,
1116
1977
other_branch=None):
1117
1978
"""Create a new revision history that will finish with revision_id.
1119
1980
:param revision_id: the new tip to use.
1120
1981
:param last_rev: The previous last_revision. If not None, then this
1121
1982
must be a ancestory of revision_id, or DivergedBranches is raised.
1122
1983
:param other_branch: The other branch that DivergedBranches should
1123
1984
raise with respect to.
1125
# stop_revision must be a descendant of last_revision
1126
stop_graph = self.repository.get_revision_graph(revision_id)
1127
if last_rev is not None and last_rev not in stop_graph:
1128
# our previous tip is not merged into stop_revision
1129
raise errors.DivergedBranches(self, other_branch)
1130
# make a new revision history from the graph
1131
current_rev_id = revision_id
1133
while current_rev_id not in (None, revision.NULL_REVISION):
1134
new_history.append(current_rev_id)
1135
current_rev_id_parents = stop_graph[current_rev_id]
1137
current_rev_id = current_rev_id_parents[0]
1139
current_rev_id = None
1140
new_history.reverse()
1141
self.set_revision_history(new_history)
1144
def update_revisions(self, other, stop_revision=None):
1145
"""See Branch.update_revisions."""
1148
if stop_revision is None:
1149
stop_revision = other.last_revision()
1150
if stop_revision is None:
1151
# if there are no commits, we're done.
1153
# whats the current last revision, before we fetch [and change it
1155
last_rev = self.last_revision()
1156
# we fetch here regardless of whether we need to so that we pickup
1158
self.fetch(other, stop_revision)
1159
my_ancestry = self.repository.get_ancestry(last_rev)
1160
if stop_revision in my_ancestry:
1161
# last_revision is a descendant of stop_revision
1163
self.generate_revision_history(stop_revision, last_rev=last_rev,
1986
self.set_revision_history(self._lefthand_history(revision_id,
1987
last_rev, other_branch))
1168
1989
def basis_tree(self):
1169
1990
"""See Branch.basis_tree."""
1170
1991
return self.repository.revision_tree(self.last_revision())
1172
@deprecated_method(zero_eight)
1173
def working_tree(self):
1174
"""Create a Working tree object for this branch."""
1176
from bzrlib.transport.local import LocalTransport
1177
if (self.base.find('://') != -1 or
1178
not isinstance(self._transport, LocalTransport)):
1179
raise NoWorkingTree(self.base)
1180
return self.bzrdir.open_workingtree()
1182
1993
@needs_write_lock
1183
def pull(self, source, overwrite=False, stop_revision=None):
1184
"""See Branch.pull."""
1994
def pull(self, source, overwrite=False, stop_revision=None,
1995
_hook_master=None, run_hooks=True, possible_transports=None,
1996
_override_hook_target=None):
1999
:param _hook_master: Private parameter - set the branch to
2000
be supplied as the master to pull hooks.
2001
:param run_hooks: Private parameter - if false, this branch
2002
is being called because it's the master of the primary branch,
2003
so it should not run its hooks.
2004
:param _override_hook_target: Private parameter - set the branch to be
2005
supplied as the target_branch to pull hooks.
2007
result = PullResult()
2008
result.source_branch = source
2009
if _override_hook_target is None:
2010
result.target_branch = self
2012
result.target_branch = _override_hook_target
1185
2013
source.lock_read()
1187
old_count = len(self.revision_history())
1189
self.update_revisions(source,stop_revision)
1190
except DivergedBranches:
1194
self.set_revision_history(source.revision_history())
1195
new_count = len(self.revision_history())
1196
return new_count - old_count
2015
# We assume that during 'pull' the local repository is closer than
2017
graph = self.repository.get_graph(source.repository)
2018
result.old_revno, result.old_revid = self.last_revision_info()
2019
self.update_revisions(source, stop_revision, overwrite=overwrite,
2021
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
2022
result.new_revno, result.new_revid = self.last_revision_info()
2024
result.master_branch = _hook_master
2025
result.local_branch = result.target_branch
2027
result.master_branch = result.target_branch
2028
result.local_branch = None
2030
for hook in Branch.hooks['post_pull']:
1198
2033
source.unlock()
1200
def get_parent(self):
1201
"""See Branch.get_parent."""
2036
def _get_parent_location(self):
1203
2037
_locs = ['parent', 'pull', 'x-pull']
1204
assert self.base[-1] == '/'
1205
2038
for l in _locs:
1207
parent = self.control_files.get(l).read().strip('\n')
1210
# This is an old-format absolute path to a local branch
1211
# turn it into a url
1212
if parent.startswith('/'):
1213
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1215
return urlutils.join(self.base[:-1], parent)
1216
except errors.InvalidURLJoin, e:
1217
raise errors.InaccessibleParent(parent, self.base)
2040
return self._transport.get_bytes(l).strip('\n')
2041
except errors.NoSuchFile:
1220
def get_push_location(self):
1221
"""See Branch.get_push_location."""
1222
push_loc = self.get_config().get_user_option('push_location')
2046
def push(self, target, overwrite=False, stop_revision=None,
2047
_override_hook_source_branch=None):
2050
This is the basic concrete implementation of push()
2052
:param _override_hook_source_branch: If specified, run
2053
the hooks passing this Branch as the source, rather than self.
2054
This is for use of RemoteBranch, where push is delegated to the
2055
underlying vfs-based Branch.
2057
# TODO: Public option to disable running hooks - should be trivial but
2059
return _run_with_write_locked_target(
2060
target, self._push_with_bound_branches, target, overwrite,
2062
_override_hook_source_branch=_override_hook_source_branch)
2064
def _push_with_bound_branches(self, target, overwrite,
2066
_override_hook_source_branch=None):
2067
"""Push from self into target, and into target's master if any.
2069
This is on the base BzrBranch class even though it doesn't support
2070
bound branches because the *target* might be bound.
2073
if _override_hook_source_branch:
2074
result.source_branch = _override_hook_source_branch
2075
for hook in Branch.hooks['post_push']:
2078
bound_location = target.get_bound_location()
2079
if bound_location and target.base != bound_location:
2080
# there is a master branch.
2082
# XXX: Why the second check? Is it even supported for a branch to
2083
# be bound to itself? -- mbp 20070507
2084
master_branch = target.get_master_branch()
2085
master_branch.lock_write()
2087
# push into the master from this branch.
2088
self._basic_push(master_branch, overwrite, stop_revision)
2089
# and push into the target branch from this. Note that we push from
2090
# this branch again, because its considered the highest bandwidth
2092
result = self._basic_push(target, overwrite, stop_revision)
2093
result.master_branch = master_branch
2094
result.local_branch = target
2098
master_branch.unlock()
2101
result = self._basic_push(target, overwrite, stop_revision)
2102
# TODO: Why set master_branch and local_branch if there's no
2103
# binding? Maybe cleaner to just leave them unset? -- mbp
2105
result.master_branch = target
2106
result.local_branch = None
2110
def _basic_push(self, target, overwrite, stop_revision):
2111
"""Basic implementation of push without bound branches or hooks.
2113
Must be called with self read locked and target write locked.
2115
result = BranchPushResult()
2116
result.source_branch = self
2117
result.target_branch = target
2118
result.old_revno, result.old_revid = target.last_revision_info()
2119
if result.old_revid != self.last_revision():
2120
# We assume that during 'push' this repository is closer than
2122
graph = self.repository.get_graph(target.repository)
2123
target.update_revisions(self, stop_revision, overwrite=overwrite,
2125
if self._push_should_merge_tags():
2126
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
2127
result.new_revno, result.new_revid = target.last_revision_info()
2130
def get_stacked_on_url(self):
2131
raise errors.UnstackableBranchFormat(self._format, self.base)
1225
2133
def set_push_location(self, location):
1226
2134
"""See Branch.set_push_location."""
1227
self.get_config().set_user_option('push_location', location,
2135
self.get_config().set_user_option(
2136
'push_location', location,
2137
store=_mod_config.STORE_LOCATION_NORECURSE)
1230
2139
@needs_write_lock
1231
2140
def set_parent(self, url):
1233
2142
# TODO: Maybe delete old location files?
1234
2143
# URLs should never be unicode, even on the local fs,
1235
2144
# FIXUP this and get_parent in a future branch format bump:
1236
# read and rewrite the file, and have the new format code read
1237
# using .get not .get_utf8. RBC 20060125
1239
self.control_files._transport.delete('parent')
2145
# read and rewrite the file. RBC 20060125
1241
2147
if isinstance(url, unicode):
1243
2149
url = url.encode('ascii')
1244
2150
except UnicodeEncodeError:
1245
raise bzrlib.errors.InvalidURL(url,
2151
raise errors.InvalidURL(url,
1246
2152
"Urls must be 7-bit ascii, "
1247
2153
"use bzrlib.urlutils.escape")
1249
2154
url = urlutils.relative_url(self.base, url)
1250
self.control_files.put('parent', StringIO(url + '\n'))
1252
@deprecated_function(zero_nine)
1253
def tree_config(self):
1254
"""DEPRECATED; call get_config instead.
1255
TreeConfig has become part of BranchConfig."""
1256
return TreeConfig(self)
2155
self._set_parent_location(url)
2157
def _set_parent_location(self, url):
2159
self._transport.delete('parent')
2161
self._transport.put_bytes('parent', url + '\n',
2162
mode=self.bzrdir._get_file_mode())
2164
def set_stacked_on_url(self, url):
2165
raise errors.UnstackableBranchFormat(self._format, self.base)
1259
2168
class BzrBranch5(BzrBranch):
1260
"""A format 5 branch. This supports new features over plan branches.
2169
"""A format 5 branch. This supports new features over plain branches.
1262
2171
It has support for a master_branch which is the data for bound branches.
1270
super(BzrBranch5, self).__init__(_format=_format,
1271
_control_files=_control_files,
1273
_repository=_repository)
1275
2174
@needs_write_lock
1276
def pull(self, source, overwrite=False, stop_revision=None):
1277
"""Updates branch.pull to be bound branch aware."""
2175
def pull(self, source, overwrite=False, stop_revision=None,
2176
run_hooks=True, possible_transports=None,
2177
_override_hook_target=None):
2178
"""Pull from source into self, updating my master if any.
2180
:param run_hooks: Private parameter - if false, this branch
2181
is being called because it's the master of the primary branch,
2182
so it should not run its hooks.
1278
2184
bound_location = self.get_bound_location()
1279
if source.base != bound_location:
2185
master_branch = None
2186
if bound_location and source.base != bound_location:
1280
2187
# not pulling from master, so we need to update master.
1281
master_branch = self.get_master_branch()
1283
master_branch.pull(source)
1284
source = master_branch
1285
return super(BzrBranch5, self).pull(source, overwrite, stop_revision)
2188
master_branch = self.get_master_branch(possible_transports)
2189
master_branch.lock_write()
2192
# pull from source into master.
2193
master_branch.pull(source, overwrite, stop_revision,
2195
return super(BzrBranch5, self).pull(source, overwrite,
2196
stop_revision, _hook_master=master_branch,
2197
run_hooks=run_hooks,
2198
_override_hook_target=_override_hook_target)
2201
master_branch.unlock()
1287
2203
def get_bound_location(self):
1289
return self.control_files.get_utf8('bound').read()[:-1]
2205
return self._transport.get_bytes('bound')[:-1]
1290
2206
except errors.NoSuchFile:
1293
2209
@needs_read_lock
1294
def get_master_branch(self):
2210
def get_master_branch(self, possible_transports=None):
1295
2211
"""Return the branch we are bound to.
1297
2213
:return: Either a Branch, or None
1299
2215
This could memoise the branch, but if thats done
1376
2275
return self.set_bound_location(None)
1378
2277
@needs_write_lock
1380
"""Synchronise this branch with the master branch if any.
2278
def update(self, possible_transports=None):
2279
"""Synchronise this branch with the master branch if any.
1382
2281
:return: None or the last_revision that was pivoted out during the
1385
master = self.get_master_branch()
2284
master = self.get_master_branch(possible_transports)
1386
2285
if master is not None:
1387
old_tip = self.last_revision()
2286
old_tip = _mod_revision.ensure_null(self.last_revision())
1388
2287
self.pull(master, overwrite=True)
1389
if old_tip in self.repository.get_ancestry(self.last_revision()):
2288
if self.repository.get_graph().is_ancestor(old_tip,
2289
_mod_revision.ensure_null(self.last_revision())):
1395
class BranchTestProviderAdapter(object):
1396
"""A tool to generate a suite testing multiple branch formats at once.
1398
This is done by copying the test once for each transport and injecting
1399
the transport_server, transport_readonly_server, and branch_format
1400
classes into each copy. Each copy is also given a new id() to make it
1404
def __init__(self, transport_server, transport_readonly_server, formats):
1405
self._transport_server = transport_server
1406
self._transport_readonly_server = transport_readonly_server
1407
self._formats = formats
1409
def adapt(self, test):
1410
result = TestSuite()
1411
for branch_format, bzrdir_format in self._formats:
1412
new_test = deepcopy(test)
1413
new_test.transport_server = self._transport_server
1414
new_test.transport_readonly_server = self._transport_readonly_server
1415
new_test.bzrdir_format = bzrdir_format
1416
new_test.branch_format = branch_format
1417
def make_new_test_id():
1418
new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
1419
return lambda: new_id
1420
new_test.id = make_new_test_id()
1421
result.addTest(new_test)
2295
class BzrBranch7(BzrBranch5):
2296
"""A branch with support for a fallback repository."""
2298
def _get_fallback_repository(self, url):
2299
"""Get the repository we fallback to at url."""
2300
url = urlutils.join(self.base, url)
2301
a_bzrdir = bzrdir.BzrDir.open(url,
2302
possible_transports=[self._transport])
2303
return a_bzrdir.open_branch().repository
2305
def _activate_fallback_location(self, url):
2306
"""Activate the branch/repository from url as a fallback repository."""
2307
self.repository.add_fallback_repository(
2308
self._get_fallback_repository(url))
2310
def _open_hook(self):
2311
if self._ignore_fallbacks:
2314
url = self.get_stacked_on_url()
2315
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2316
errors.UnstackableBranchFormat):
2319
for hook in Branch.hooks['transform_fallback_location']:
2320
url = hook(self, url)
2322
hook_name = Branch.hooks.get_hook_name(hook)
2323
raise AssertionError(
2324
"'transform_fallback_location' hook %s returned "
2325
"None, not a URL." % hook_name)
2326
self._activate_fallback_location(url)
2328
def _check_stackable_repo(self):
2329
if not self.repository._format.supports_external_lookups:
2330
raise errors.UnstackableRepositoryFormat(self.repository._format,
2331
self.repository.base)
2333
def __init__(self, *args, **kwargs):
2334
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2335
super(BzrBranch7, self).__init__(*args, **kwargs)
2336
self._last_revision_info_cache = None
2337
self._partial_revision_history_cache = []
2339
def _clear_cached_state(self):
2340
super(BzrBranch7, self)._clear_cached_state()
2341
self._last_revision_info_cache = None
2342
self._partial_revision_history_cache = []
2344
def _last_revision_info(self):
2345
revision_string = self._transport.get_bytes('last-revision')
2346
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2347
revision_id = cache_utf8.get_cached_utf8(revision_id)
2349
return revno, revision_id
2351
def _write_last_revision_info(self, revno, revision_id):
2352
"""Simply write out the revision id, with no checks.
2354
Use set_last_revision_info to perform this safely.
2356
Does not update the revision_history cache.
2357
Intended to be called by set_last_revision_info and
2358
_write_revision_history.
2360
revision_id = _mod_revision.ensure_null(revision_id)
2361
out_string = '%d %s\n' % (revno, revision_id)
2362
self._transport.put_bytes('last-revision', out_string,
2363
mode=self.bzrdir._get_file_mode())
2366
def set_last_revision_info(self, revno, revision_id):
2367
revision_id = _mod_revision.ensure_null(revision_id)
2368
old_revno, old_revid = self.last_revision_info()
2369
if self._get_append_revisions_only():
2370
self._check_history_violation(revision_id)
2371
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2372
self._write_last_revision_info(revno, revision_id)
2373
self._clear_cached_state()
2374
self._last_revision_info_cache = revno, revision_id
2375
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2377
def _synchronize_history(self, destination, revision_id):
2378
"""Synchronize last revision and revision history between branches.
2380
:see: Branch._synchronize_history
2382
# XXX: The base Branch has a fast implementation of this method based
2383
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2384
# that uses set_revision_history. This class inherits from BzrBranch5,
2385
# but wants the fast implementation, so it calls
2386
# Branch._synchronize_history directly.
2387
Branch._synchronize_history(self, destination, revision_id)
2389
def _check_history_violation(self, revision_id):
2390
last_revision = _mod_revision.ensure_null(self.last_revision())
2391
if _mod_revision.is_null(last_revision):
2393
if last_revision not in self._lefthand_history(revision_id):
2394
raise errors.AppendRevisionsOnlyViolation(self.base)
2396
def _gen_revision_history(self):
2397
"""Generate the revision history from last revision
2399
last_revno, last_revision = self.last_revision_info()
2400
self._extend_partial_history(stop_index=last_revno-1)
2401
return list(reversed(self._partial_revision_history_cache))
2403
def _extend_partial_history(self, stop_index=None, stop_revision=None):
2404
"""Extend the partial history to include a given index
2406
If a stop_index is supplied, stop when that index has been reached.
2407
If a stop_revision is supplied, stop when that revision is
2408
encountered. Otherwise, stop when the beginning of history is
2411
:param stop_index: The index which should be present. When it is
2412
present, history extension will stop.
2413
:param revision_id: The revision id which should be present. When
2414
it is encountered, history extension will stop.
2416
repo = self.repository
2417
if len(self._partial_revision_history_cache) == 0:
2418
iterator = repo.iter_reverse_revision_history(self.last_revision())
2420
start_revision = self._partial_revision_history_cache[-1]
2421
iterator = repo.iter_reverse_revision_history(start_revision)
2422
#skip the last revision in the list
2423
next_revision = iterator.next()
2424
for revision_id in iterator:
2425
self._partial_revision_history_cache.append(revision_id)
2426
if (stop_index is not None and
2427
len(self._partial_revision_history_cache) > stop_index):
2429
if revision_id == stop_revision:
2432
def _write_revision_history(self, history):
2433
"""Factored out of set_revision_history.
2435
This performs the actual writing to disk, with format-specific checks.
2436
It is intended to be called by BzrBranch5.set_revision_history.
2438
if len(history) == 0:
2439
last_revision = 'null:'
2441
if history != self._lefthand_history(history[-1]):
2442
raise errors.NotLefthandHistory(history)
2443
last_revision = history[-1]
2444
if self._get_append_revisions_only():
2445
self._check_history_violation(last_revision)
2446
self._write_last_revision_info(len(history), last_revision)
2449
def _set_parent_location(self, url):
2450
"""Set the parent branch"""
2451
self._set_config_location('parent_location', url, make_relative=True)
2454
def _get_parent_location(self):
2455
"""Set the parent branch"""
2456
return self._get_config_location('parent_location')
2458
def set_push_location(self, location):
2459
"""See Branch.set_push_location."""
2460
self._set_config_location('push_location', location)
2462
def set_bound_location(self, location):
2463
"""See Branch.set_push_location."""
2465
config = self.get_config()
2466
if location is None:
2467
if config.get_user_option('bound') != 'True':
2470
config.set_user_option('bound', 'False', warn_masked=True)
2473
self._set_config_location('bound_location', location,
2475
config.set_user_option('bound', 'True', warn_masked=True)
2478
def _get_bound_location(self, bound):
2479
"""Return the bound location in the config file.
2481
Return None if the bound parameter does not match"""
2482
config = self.get_config()
2483
config_bound = (config.get_user_option('bound') == 'True')
2484
if config_bound != bound:
2486
return self._get_config_location('bound_location', config=config)
2488
def get_bound_location(self):
2489
"""See Branch.set_push_location."""
2490
return self._get_bound_location(True)
2492
def get_old_bound_location(self):
2493
"""See Branch.get_old_bound_location"""
2494
return self._get_bound_location(False)
2496
def get_stacked_on_url(self):
2497
# you can always ask for the URL; but you might not be able to use it
2498
# if the repo can't support stacking.
2499
## self._check_stackable_repo()
2500
stacked_url = self._get_config_location('stacked_on_location')
2501
if stacked_url is None:
2502
raise errors.NotStacked(self)
2505
def set_append_revisions_only(self, enabled):
2510
self.get_config().set_user_option('append_revisions_only', value,
2513
def set_stacked_on_url(self, url):
2514
self._check_stackable_repo()
2517
old_url = self.get_stacked_on_url()
2518
except (errors.NotStacked, errors.UnstackableBranchFormat,
2519
errors.UnstackableRepositoryFormat):
2522
# repositories don't offer an interface to remove fallback
2523
# repositories today; take the conceptually simpler option and just
2525
self.repository = self.bzrdir.find_repository()
2526
# for every revision reference the branch has, ensure it is pulled
2528
source_repository = self._get_fallback_repository(old_url)
2529
for revision_id in chain([self.last_revision()],
2530
self.tags.get_reverse_tag_dict()):
2531
self.repository.fetch(source_repository, revision_id,
2534
self._activate_fallback_location(url)
2535
# write this out after the repository is stacked to avoid setting a
2536
# stacked config that doesn't work.
2537
self._set_config_location('stacked_on_location', url)
2539
def _get_append_revisions_only(self):
2540
value = self.get_config().get_user_option('append_revisions_only')
2541
return value == 'True'
2544
def generate_revision_history(self, revision_id, last_rev=None,
2546
"""See BzrBranch5.generate_revision_history"""
2547
history = self._lefthand_history(revision_id, last_rev, other_branch)
2548
revno = len(history)
2549
self.set_last_revision_info(revno, revision_id)
2552
def get_rev_id(self, revno, history=None):
2553
"""Find the revision id of the specified revno."""
2555
return _mod_revision.NULL_REVISION
2557
last_revno, last_revision_id = self.last_revision_info()
2558
if revno <= 0 or revno > last_revno:
2559
raise errors.NoSuchRevision(self, revno)
2561
if history is not None:
2562
return history[revno - 1]
2564
index = last_revno - revno
2565
if len(self._partial_revision_history_cache) <= index:
2566
self._extend_partial_history(stop_index=index)
2567
if len(self._partial_revision_history_cache) > index:
2568
return self._partial_revision_history_cache[index]
2570
raise errors.NoSuchRevision(self, revno)
2573
def revision_id_to_revno(self, revision_id):
2574
"""Given a revision id, return its revno"""
2575
if _mod_revision.is_null(revision_id):
2578
index = self._partial_revision_history_cache.index(revision_id)
2580
self._extend_partial_history(stop_revision=revision_id)
2581
index = len(self._partial_revision_history_cache) - 1
2582
if self._partial_revision_history_cache[index] != revision_id:
2583
raise errors.NoSuchRevision(self, revision_id)
2584
return self.revno() - index
2587
class BzrBranch6(BzrBranch7):
2588
"""See BzrBranchFormat6 for the capabilities of this branch.
2590
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2594
def get_stacked_on_url(self):
2595
raise errors.UnstackableBranchFormat(self._format, self.base)
2597
def set_stacked_on_url(self, url):
2598
raise errors.UnstackableBranchFormat(self._format, self.base)
2601
######################################################################
2602
# results of operations
2605
class _Result(object):
2607
def _show_tag_conficts(self, to_file):
2608
if not getattr(self, 'tag_conflicts', None):
2610
to_file.write('Conflicting tags:\n')
2611
for name, value1, value2 in self.tag_conflicts:
2612
to_file.write(' %s\n' % (name, ))
2615
class PullResult(_Result):
2616
"""Result of a Branch.pull operation.
2618
:ivar old_revno: Revision number before pull.
2619
:ivar new_revno: Revision number after pull.
2620
:ivar old_revid: Tip revision id before pull.
2621
:ivar new_revid: Tip revision id after pull.
2622
:ivar source_branch: Source (local) branch object. (read locked)
2623
:ivar master_branch: Master branch of the target, or the target if no
2625
:ivar local_branch: target branch if there is a Master, else None
2626
:ivar target_branch: Target/destination branch object. (write locked)
2627
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2631
# DEPRECATED: pull used to return the change in revno
2632
return self.new_revno - self.old_revno
2634
def report(self, to_file):
2636
if self.old_revid == self.new_revid:
2637
to_file.write('No revisions to pull.\n')
2639
to_file.write('Now on revision %d.\n' % self.new_revno)
2640
self._show_tag_conficts(to_file)
2643
class BranchPushResult(_Result):
2644
"""Result of a Branch.push operation.
2646
:ivar old_revno: Revision number (eg 10) of the target before push.
2647
:ivar new_revno: Revision number (eg 12) of the target after push.
2648
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
2650
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
2652
:ivar source_branch: Source branch object that the push was from. This is
2653
read locked, and generally is a local (and thus low latency) branch.
2654
:ivar master_branch: If target is a bound branch, the master branch of
2655
target, or target itself. Always write locked.
2656
:ivar target_branch: The direct Branch where data is being sent (write
2658
:ivar local_branch: If the target is a bound branch this will be the
2659
target, otherwise it will be None.
2663
# DEPRECATED: push used to return the change in revno
2664
return self.new_revno - self.old_revno
2666
def report(self, to_file):
2667
"""Write a human-readable description of the result."""
2668
if self.old_revid == self.new_revid:
2669
note('No new revisions to push.')
2671
note('Pushed up to revision %d.' % self.new_revno)
2672
self._show_tag_conficts(to_file)
1425
2675
class BranchCheckResult(object):
1442
2692
self.branch._format)
1445
######################################################################
1449
@deprecated_function(zero_eight)
1450
def is_control_file(*args, **kwargs):
1451
"""See bzrlib.workingtree.is_control_file."""
1452
return bzrlib.workingtree.is_control_file(*args, **kwargs)
2695
class Converter5to6(object):
2696
"""Perform an in-place upgrade of format 5 to format 6"""
2698
def convert(self, branch):
2699
# Data for 5 and 6 can peacefully coexist.
2700
format = BzrBranchFormat6()
2701
new_branch = format.open(branch.bzrdir, _found=True)
2703
# Copy source data into target
2704
new_branch._write_last_revision_info(*branch.last_revision_info())
2705
new_branch.set_parent(branch.get_parent())
2706
new_branch.set_bound_location(branch.get_bound_location())
2707
new_branch.set_push_location(branch.get_push_location())
2709
# New branch has no tags by default
2710
new_branch.tags._set_tag_dict({})
2712
# Copying done; now update target format
2713
new_branch._transport.put_bytes('format',
2714
format.get_format_string(),
2715
mode=new_branch.bzrdir._get_file_mode())
2717
# Clean up old files
2718
new_branch._transport.delete('revision-history')
2720
branch.set_parent(None)
2721
except errors.NoSuchFile:
2723
branch.set_bound_location(None)
2726
class Converter6to7(object):
2727
"""Perform an in-place upgrade of format 6 to format 7"""
2729
def convert(self, branch):
2730
format = BzrBranchFormat7()
2731
branch._set_config_location('stacked_on_location', '')
2732
# update target format
2733
branch._transport.put_bytes('format', format.get_format_string())
2737
def _run_with_write_locked_target(target, callable, *args, **kwargs):
2738
"""Run ``callable(*args, **kwargs)``, write-locking target for the
2741
_run_with_write_locked_target will attempt to release the lock it acquires.
2743
If an exception is raised by callable, then that exception *will* be
2744
propagated, even if the unlock attempt raises its own error. Thus
2745
_run_with_write_locked_target should be preferred to simply doing::
2749
return callable(*args, **kwargs)
2754
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
2755
# should share code?
2758
result = callable(*args, **kwargs)
2760
exc_info = sys.exc_info()
2764
raise exc_info[0], exc_info[1], exc_info[2]
2770
class InterBranch(InterObject):
2771
"""This class represents operations taking place between two branches.
2773
Its instances have methods like pull() and push() and contain
2774
references to the source and target repositories these operations
2775
can be carried out on.
2779
"""The available optimised InterBranch types."""
2782
def _get_branch_formats_to_test():
2783
"""Return a tuple with the Branch formats to use when testing."""
2784
raise NotImplementedError(self._get_branch_formats_to_test)
2786
def update_revisions(self, stop_revision=None, overwrite=False,
2788
"""Pull in new perfect-fit revisions.
2790
:param stop_revision: Updated until the given revision
2791
:param overwrite: Always set the branch pointer, rather than checking
2792
to see if it is a proper descendant.
2793
:param graph: A Graph object that can be used to query history
2794
information. This can be None.
2797
raise NotImplementedError(self.update_revisions)
2800
class GenericInterBranch(InterBranch):
2801
"""InterBranch implementation that uses public Branch functions.
2805
def _get_branch_formats_to_test():
2806
return BranchFormat._default_format, BranchFormat._default_format
2808
def update_revisions(self, stop_revision=None, overwrite=False,
2810
"""See InterBranch.update_revisions()."""
2811
self.source.lock_read()
2813
other_revno, other_last_revision = self.source.last_revision_info()
2814
stop_revno = None # unknown
2815
if stop_revision is None:
2816
stop_revision = other_last_revision
2817
if _mod_revision.is_null(stop_revision):
2818
# if there are no commits, we're done.
2820
stop_revno = other_revno
2822
# what's the current last revision, before we fetch [and change it
2824
last_rev = _mod_revision.ensure_null(self.target.last_revision())
2825
# we fetch here so that we don't process data twice in the common
2826
# case of having something to pull, and so that the check for
2827
# already merged can operate on the just fetched graph, which will
2828
# be cached in memory.
2829
self.target.fetch(self.source, stop_revision)
2830
# Check to see if one is an ancestor of the other
2833
graph = self.target.repository.get_graph()
2834
if self.target._check_if_descendant_or_diverged(
2835
stop_revision, last_rev, graph, self.source):
2836
# stop_revision is a descendant of last_rev, but we aren't
2837
# overwriting, so we're done.
2839
if stop_revno is None:
2841
graph = self.target.repository.get_graph()
2842
this_revno, this_last_revision = \
2843
self.target.last_revision_info()
2844
stop_revno = graph.find_distance_to_null(stop_revision,
2845
[(other_last_revision, other_revno),
2846
(this_last_revision, this_revno)])
2847
self.target.set_last_revision_info(stop_revno, stop_revision)
2849
self.source.unlock()
2852
def is_compatible(self, source, target):
2853
# GenericBranch uses the public API, so always compatible
2857
InterBranch.register_optimiser(GenericInterBranch)
added
removed
bzrlib/branch.py
