1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
from bzrlib.lazy_import import lazy_import
19
lazy_import(globals(), """
23
config as _mod_config,
29
revision as _mod_revision,
35
from bzrlib.config import BranchConfig
36
from bzrlib.tag import (
42
from bzrlib.decorators import needs_read_lock, needs_write_lock
43
from bzrlib.hooks import Hooks
44
from bzrlib.symbol_versioning import deprecated_in, deprecated_method
45
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
48
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
49
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
50
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
53
# TODO: Maybe include checks for common corruption of newlines, etc?
55
# TODO: Some operations like log might retrieve the same revisions
56
# repeatedly to calculate deltas. We could perhaps have a weakref
57
# cache in memory to make this faster. In general anything can be
58
# cached in memory between lock and unlock operations. .. nb thats
59
# what the transaction identity map provides
62
######################################################################
66
"""Branch holding a history of revisions.
69
Base directory/url of the branch.
71
hooks: An instance of BranchHooks.
73
# this is really an instance variable - FIXME move it there
77
# override this to set the strategy for storing tags
79
return DisabledTags(self)
81
def __init__(self, *ignored, **ignored_too):
82
self.tags = self._make_tags()
83
self._revision_history_cache = None
84
self._revision_id_to_revno_cache = None
87
"""Break a lock if one is present from another instance.
89
Uses the ui factory to ask for confirmation if the lock may be from
92
This will probe the repository for its lock as well.
94
self.control_files.break_lock()
95
self.repository.break_lock()
96
master = self.get_master_branch()
97
if master is not None:
101
def open(base, _unsupported=False, possible_transports=None):
102
"""Open the branch rooted at base.
104
For instance, if the branch is at URL/.bzr/branch,
105
Branch.open(URL) -> a Branch instance.
107
control = bzrdir.BzrDir.open(base, _unsupported,
108
possible_transports=possible_transports)
109
return control.open_branch(_unsupported)
112
def open_from_transport(transport, _unsupported=False):
113
"""Open the branch rooted at transport"""
114
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
115
return control.open_branch(_unsupported)
118
def open_containing(url, possible_transports=None):
119
"""Open an existing branch which contains url.
121
This probes for a branch at url, and searches upwards from there.
123
Basically we keep looking up until we find the control directory or
124
run into the root. If there isn't one, raises NotBranchError.
125
If there is one and it is either an unrecognised format or an unsupported
126
format, UnknownFormatError or UnsupportedFormatError are raised.
127
If there is one, it is returned, along with the unused portion of url.
129
control, relpath = bzrdir.BzrDir.open_containing(url,
131
return control.open_branch(), relpath
133
def get_config(self):
134
return BranchConfig(self)
137
return self.get_config().get_nickname()
139
def _set_nick(self, nick):
140
self.get_config().set_user_option('nickname', nick, warn_masked=True)
142
nick = property(_get_nick, _set_nick)
145
raise NotImplementedError(self.is_locked)
147
def lock_write(self):
148
raise NotImplementedError(self.lock_write)
151
raise NotImplementedError(self.lock_read)
154
raise NotImplementedError(self.unlock)
156
def peek_lock_mode(self):
157
"""Return lock mode for the Branch: 'r', 'w' or None"""
158
raise NotImplementedError(self.peek_lock_mode)
160
def get_physical_lock_status(self):
161
raise NotImplementedError(self.get_physical_lock_status)
164
def get_revision_id_to_revno_map(self):
165
"""Return the revision_id => dotted revno map.
167
This will be regenerated on demand, but will be cached.
169
:return: A dictionary mapping revision_id => dotted revno.
170
This dictionary should not be modified by the caller.
172
if self._revision_id_to_revno_cache is not None:
173
mapping = self._revision_id_to_revno_cache
175
mapping = self._gen_revno_map()
176
self._cache_revision_id_to_revno(mapping)
177
# TODO: jam 20070417 Since this is being cached, should we be returning
179
# I would rather not, and instead just declare that users should not
180
# modify the return value.
183
def _gen_revno_map(self):
184
"""Create a new mapping from revision ids to dotted revnos.
186
Dotted revnos are generated based on the current tip in the revision
188
This is the worker function for get_revision_id_to_revno_map, which
189
just caches the return value.
191
:return: A dictionary mapping revision_id => dotted revno.
193
last_revision = self.last_revision()
194
revision_graph = repository._old_get_graph(self.repository,
196
merge_sorted_revisions = tsort.merge_sort(
201
revision_id_to_revno = dict((rev_id, revno)
202
for seq_num, rev_id, depth, revno, end_of_merge
203
in merge_sorted_revisions)
204
return revision_id_to_revno
206
def leave_lock_in_place(self):
207
"""Tell this branch object not to release the physical lock when this
210
If lock_write doesn't return a token, then this method is not supported.
212
self.control_files.leave_in_place()
214
def dont_leave_lock_in_place(self):
215
"""Tell this branch object to release the physical lock when this
216
object is unlocked, even if it didn't originally acquire it.
218
If lock_write doesn't return a token, then this method is not supported.
220
self.control_files.dont_leave_in_place()
222
def abspath(self, name):
223
"""Return absolute filename for something in the branch
225
XXX: Robert Collins 20051017 what is this used for? why is it a branch
226
method and not a tree method.
228
raise NotImplementedError(self.abspath)
230
def bind(self, other):
231
"""Bind the local branch the other branch.
233
:param other: The branch to bind to
236
raise errors.UpgradeRequired(self.base)
239
def fetch(self, from_branch, last_revision=None, pb=None):
240
"""Copy revisions from from_branch into this branch.
242
:param from_branch: Where to copy from.
243
:param last_revision: What revision to stop at (None for at the end
245
:param pb: An optional progress bar to use.
247
Returns the copied revision count and the failed revisions in a tuple:
250
if self.base == from_branch.base:
253
nested_pb = ui.ui_factory.nested_progress_bar()
258
from_branch.lock_read()
260
if last_revision is None:
261
pb.update('get source history')
262
last_revision = from_branch.last_revision()
263
last_revision = _mod_revision.ensure_null(last_revision)
264
return self.repository.fetch(from_branch.repository,
265
revision_id=last_revision,
268
if nested_pb is not None:
272
def get_bound_location(self):
273
"""Return the URL of the branch we are bound to.
275
Older format branches cannot bind, please be sure to use a metadir
280
def get_old_bound_location(self):
281
"""Return the URL of the branch we used to be bound to
283
raise errors.UpgradeRequired(self.base)
285
def get_commit_builder(self, parents, config=None, timestamp=None,
286
timezone=None, committer=None, revprops=None,
288
"""Obtain a CommitBuilder for this branch.
290
:param parents: Revision ids of the parents of the new revision.
291
:param config: Optional configuration to use.
292
:param timestamp: Optional timestamp recorded for commit.
293
:param timezone: Optional timezone for timestamp.
294
:param committer: Optional committer to set for commit.
295
:param revprops: Optional dictionary of revision properties.
296
:param revision_id: Optional revision id.
300
config = self.get_config()
302
return self.repository.get_commit_builder(self, parents, config,
303
timestamp, timezone, committer, revprops, revision_id)
305
def get_master_branch(self, possible_transports=None):
306
"""Return the branch we are bound to.
308
:return: Either a Branch, or None
312
def get_revision_delta(self, revno):
313
"""Return the delta for one revision.
315
The delta is relative to its mainline predecessor, or the
316
empty tree for revision 1.
318
rh = self.revision_history()
319
if not (1 <= revno <= len(rh)):
320
raise errors.InvalidRevisionNumber(revno)
321
return self.repository.get_revision_delta(rh[revno-1])
323
def print_file(self, file, revision_id):
324
"""Print `file` to stdout."""
325
raise NotImplementedError(self.print_file)
327
def set_revision_history(self, rev_history):
328
raise NotImplementedError(self.set_revision_history)
330
def _cache_revision_history(self, rev_history):
331
"""Set the cached revision history to rev_history.
333
The revision_history method will use this cache to avoid regenerating
334
the revision history.
336
This API is semi-public; it only for use by subclasses, all other code
337
should consider it to be private.
339
self._revision_history_cache = rev_history
341
def _cache_revision_id_to_revno(self, revision_id_to_revno):
342
"""Set the cached revision_id => revno map to revision_id_to_revno.
344
This API is semi-public; it only for use by subclasses, all other code
345
should consider it to be private.
347
self._revision_id_to_revno_cache = revision_id_to_revno
349
def _clear_cached_state(self):
350
"""Clear any cached data on this branch, e.g. cached revision history.
352
This means the next call to revision_history will need to call
353
_gen_revision_history.
355
This API is semi-public; it only for use by subclasses, all other code
356
should consider it to be private.
358
self._revision_history_cache = None
359
self._revision_id_to_revno_cache = None
361
def _gen_revision_history(self):
362
"""Return sequence of revision hashes on to this branch.
364
Unlike revision_history, this method always regenerates or rereads the
365
revision history, i.e. it does not cache the result, so repeated calls
368
Concrete subclasses should override this instead of revision_history so
369
that subclasses do not need to deal with caching logic.
371
This API is semi-public; it only for use by subclasses, all other code
372
should consider it to be private.
374
raise NotImplementedError(self._gen_revision_history)
377
def revision_history(self):
378
"""Return sequence of revision ids on this branch.
380
This method will cache the revision history for as long as it is safe to
383
if 'evil' in debug.debug_flags:
384
mutter_callsite(3, "revision_history scales with history.")
385
if self._revision_history_cache is not None:
386
history = self._revision_history_cache
388
history = self._gen_revision_history()
389
self._cache_revision_history(history)
393
"""Return current revision number for this branch.
395
That is equivalent to the number of revisions committed to
398
return self.last_revision_info()[0]
401
"""Older format branches cannot bind or unbind."""
402
raise errors.UpgradeRequired(self.base)
404
def set_append_revisions_only(self, enabled):
405
"""Older format branches are never restricted to append-only"""
406
raise errors.UpgradeRequired(self.base)
408
def last_revision(self):
409
"""Return last revision id, or NULL_REVISION."""
410
return self.last_revision_info()[1]
412
def last_revision_info(self):
413
"""Return information about the last revision.
415
:return: A tuple (revno, last_revision_id).
417
rh = self.revision_history()
420
return (revno, rh[-1])
422
return (0, _mod_revision.NULL_REVISION)
424
@deprecated_method(deprecated_in((1, 6, 0)))
425
def missing_revisions(self, other, stop_revision=None):
426
"""Return a list of new revisions that would perfectly fit.
428
If self and other have not diverged, return a list of the revisions
429
present in other, but missing from self.
431
self_history = self.revision_history()
432
self_len = len(self_history)
433
other_history = other.revision_history()
434
other_len = len(other_history)
435
common_index = min(self_len, other_len) -1
436
if common_index >= 0 and \
437
self_history[common_index] != other_history[common_index]:
438
raise errors.DivergedBranches(self, other)
440
if stop_revision is None:
441
stop_revision = other_len
443
if stop_revision > other_len:
444
raise errors.NoSuchRevision(self, stop_revision)
445
return other_history[self_len:stop_revision]
447
def update_revisions(self, other, stop_revision=None):
448
"""Pull in new perfect-fit revisions.
450
:param other: Another Branch to pull from
451
:param stop_revision: Updated until the given revision
454
raise NotImplementedError(self.update_revisions)
456
def revision_id_to_revno(self, revision_id):
457
"""Given a revision id, return its revno"""
458
if _mod_revision.is_null(revision_id):
460
history = self.revision_history()
462
return history.index(revision_id) + 1
464
raise errors.NoSuchRevision(self, revision_id)
466
def get_rev_id(self, revno, history=None):
467
"""Find the revision id of the specified revno."""
469
return _mod_revision.NULL_REVISION
471
history = self.revision_history()
472
if revno <= 0 or revno > len(history):
473
raise errors.NoSuchRevision(self, revno)
474
return history[revno - 1]
476
def pull(self, source, overwrite=False, stop_revision=None,
477
possible_transports=None):
478
"""Mirror source into this branch.
480
This branch is considered to be 'local', having low latency.
482
:returns: PullResult instance
484
raise NotImplementedError(self.pull)
486
def push(self, target, overwrite=False, stop_revision=None):
487
"""Mirror this branch into target.
489
This branch is considered to be 'local', having low latency.
491
raise NotImplementedError(self.push)
493
def basis_tree(self):
494
"""Return `Tree` object for last revision."""
495
return self.repository.revision_tree(self.last_revision())
497
def rename_one(self, from_rel, to_rel):
500
This can change the directory or the filename or both.
502
raise NotImplementedError(self.rename_one)
504
def move(self, from_paths, to_name):
507
to_name must exist as a versioned directory.
509
If to_name exists and is a directory, the files are moved into
510
it, keeping their old names. If it is a directory,
512
Note that to_name is only the last component of the new name;
513
this doesn't change the directory.
515
This returns a list of (from_path, to_path) pairs for each
518
raise NotImplementedError(self.move)
520
def get_parent(self):
521
"""Return the parent location of the branch.
523
This is the default location for push/pull/missing. The usual
524
pattern is that the user can override it by specifying a
527
raise NotImplementedError(self.get_parent)
529
def _set_config_location(self, name, url, config=None,
530
make_relative=False):
532
config = self.get_config()
536
url = urlutils.relative_url(self.base, url)
537
config.set_user_option(name, url, warn_masked=True)
539
def _get_config_location(self, name, config=None):
541
config = self.get_config()
542
location = config.get_user_option(name)
547
def get_submit_branch(self):
548
"""Return the submit location of the branch.
550
This is the default location for bundle. The usual
551
pattern is that the user can override it by specifying a
554
return self.get_config().get_user_option('submit_branch')
556
def set_submit_branch(self, location):
557
"""Return the submit location of the branch.
559
This is the default location for bundle. The usual
560
pattern is that the user can override it by specifying a
563
self.get_config().set_user_option('submit_branch', location,
566
def get_public_branch(self):
567
"""Return the public location of the branch.
569
This is is used by merge directives.
571
return self._get_config_location('public_branch')
573
def set_public_branch(self, location):
574
"""Return the submit location of the branch.
576
This is the default location for bundle. The usual
577
pattern is that the user can override it by specifying a
580
self._set_config_location('public_branch', location)
582
def get_push_location(self):
583
"""Return the None or the location to push this branch to."""
584
push_loc = self.get_config().get_user_option('push_location')
587
def set_push_location(self, location):
588
"""Set a new push location for this branch."""
589
raise NotImplementedError(self.set_push_location)
591
def set_parent(self, url):
592
raise NotImplementedError(self.set_parent)
596
"""Synchronise this branch with the master branch if any.
598
:return: None or the last_revision pivoted out during the update.
602
def check_revno(self, revno):
604
Check whether a revno corresponds to any revision.
605
Zero (the NULL revision) is considered valid.
608
self.check_real_revno(revno)
610
def check_real_revno(self, revno):
612
Check whether a revno corresponds to a real revision.
613
Zero (the NULL revision) is considered invalid
615
if revno < 1 or revno > self.revno():
616
raise errors.InvalidRevisionNumber(revno)
619
def clone(self, to_bzrdir, revision_id=None):
620
"""Clone this branch into to_bzrdir preserving all semantic values.
622
revision_id: if not None, the revision history in the new branch will
623
be truncated to end with revision_id.
625
result = self._format.initialize(to_bzrdir)
626
self.copy_content_into(result, revision_id=revision_id)
630
def sprout(self, to_bzrdir, revision_id=None):
631
"""Create a new line of development from the branch, into to_bzrdir.
633
revision_id: if not None, the revision history in the new branch will
634
be truncated to end with revision_id.
636
result = self._format.initialize(to_bzrdir)
637
self.copy_content_into(result, revision_id=revision_id)
638
result.set_parent(self.bzrdir.root_transport.base)
641
def _synchronize_history(self, destination, revision_id):
642
"""Synchronize last revision and revision history between branches.
644
This version is most efficient when the destination is also a
645
BzrBranch5, but works for BzrBranch6 as long as the revision
646
history is the true lefthand parent history, and all of the revisions
647
are in the destination's repository. If not, set_revision_history
650
:param destination: The branch to copy the history into
651
:param revision_id: The revision-id to truncate history at. May
652
be None to copy complete history.
654
if revision_id == _mod_revision.NULL_REVISION:
656
new_history = self.revision_history()
657
if revision_id is not None and new_history != []:
659
new_history = new_history[:new_history.index(revision_id) + 1]
661
rev = self.repository.get_revision(revision_id)
662
new_history = rev.get_history(self.repository)[1:]
663
destination.set_revision_history(new_history)
666
def copy_content_into(self, destination, revision_id=None):
667
"""Copy the content of self into destination.
669
revision_id: if not None, the revision history in the new branch will
670
be truncated to end with revision_id.
672
self._synchronize_history(destination, revision_id)
674
parent = self.get_parent()
675
except errors.InaccessibleParent, e:
676
mutter('parent was not accessible to copy: %s', e)
679
destination.set_parent(parent)
680
self.tags.merge_to(destination.tags)
684
"""Check consistency of the branch.
686
In particular this checks that revisions given in the revision-history
687
do actually match up in the revision graph, and that they're all
688
present in the repository.
690
Callers will typically also want to check the repository.
692
:return: A BranchCheckResult.
694
mainline_parent_id = None
695
last_revno, last_revision_id = self.last_revision_info()
696
real_rev_history = list(self.repository.iter_reverse_revision_history(
698
real_rev_history.reverse()
699
if len(real_rev_history) != last_revno:
700
raise errors.BzrCheckError('revno does not match len(mainline)'
701
' %s != %s' % (last_revno, len(real_rev_history)))
702
# TODO: We should probably also check that real_rev_history actually
703
# matches self.revision_history()
704
for revision_id in real_rev_history:
706
revision = self.repository.get_revision(revision_id)
707
except errors.NoSuchRevision, e:
708
raise errors.BzrCheckError("mainline revision {%s} not in repository"
710
# In general the first entry on the revision history has no parents.
711
# But it's not illegal for it to have parents listed; this can happen
712
# in imports from Arch when the parents weren't reachable.
713
if mainline_parent_id is not None:
714
if mainline_parent_id not in revision.parent_ids:
715
raise errors.BzrCheckError("previous revision {%s} not listed among "
717
% (mainline_parent_id, revision_id))
718
mainline_parent_id = revision_id
719
return BranchCheckResult(self)
721
def _get_checkout_format(self):
722
"""Return the most suitable metadir for a checkout of this branch.
723
Weaves are used if this branch's repository uses weaves.
725
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
726
from bzrlib.repofmt import weaverepo
727
format = bzrdir.BzrDirMetaFormat1()
728
format.repository_format = weaverepo.RepositoryFormat7()
730
format = self.repository.bzrdir.checkout_metadir()
731
format.set_branch_format(self._format)
734
def create_checkout(self, to_location, revision_id=None,
735
lightweight=False, accelerator_tree=None,
737
"""Create a checkout of a branch.
739
:param to_location: The url to produce the checkout at
740
:param revision_id: The revision to check out
741
:param lightweight: If True, produce a lightweight checkout, otherwise,
742
produce a bound branch (heavyweight checkout)
743
:param accelerator_tree: A tree which can be used for retrieving file
744
contents more quickly than the revision tree, i.e. a workingtree.
745
The revision tree will be used for cases where accelerator_tree's
746
content is different.
747
:param hardlink: If true, hard-link files from accelerator_tree,
749
:return: The tree of the created checkout
751
t = transport.get_transport(to_location)
754
format = self._get_checkout_format()
755
checkout = format.initialize_on_transport(t)
756
from_branch = BranchReferenceFormat().initialize(checkout, self)
758
format = self._get_checkout_format()
759
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
760
to_location, force_new_tree=False, format=format)
761
checkout = checkout_branch.bzrdir
762
checkout_branch.bind(self)
763
# pull up to the specified revision_id to set the initial
764
# branch tip correctly, and seed it with history.
765
checkout_branch.pull(self, stop_revision=revision_id)
767
tree = checkout.create_workingtree(revision_id,
768
from_branch=from_branch,
769
accelerator_tree=accelerator_tree,
771
basis_tree = tree.basis_tree()
772
basis_tree.lock_read()
774
for path, file_id in basis_tree.iter_references():
775
reference_parent = self.reference_parent(file_id, path)
776
reference_parent.create_checkout(tree.abspath(path),
777
basis_tree.get_reference_revision(file_id, path),
784
def reconcile(self, thorough=True):
785
"""Make sure the data stored in this branch is consistent."""
786
from bzrlib.reconcile import BranchReconciler
787
reconciler = BranchReconciler(self, thorough=thorough)
788
reconciler.reconcile()
791
def reference_parent(self, file_id, path):
792
"""Return the parent branch for a tree-reference file_id
793
:param file_id: The file_id of the tree reference
794
:param path: The path of the file_id in the tree
795
:return: A branch associated with the file_id
797
# FIXME should provide multiple branches, based on config
798
return Branch.open(self.bzrdir.root_transport.clone(path).base)
800
def supports_tags(self):
801
return self._format.supports_tags()
804
class BranchFormat(object):
805
"""An encapsulation of the initialization and open routines for a format.
807
Formats provide three things:
808
* An initialization routine,
812
Formats are placed in an dict by their format string for reference
813
during branch opening. Its not required that these be instances, they
814
can be classes themselves with class methods - it simply depends on
815
whether state is needed for a given format or not.
817
Once a format is deprecated, just deprecate the initialize and open
818
methods on the format class. Do not deprecate the object, as the
819
object will be created every time regardless.
822
_default_format = None
823
"""The default format used for new branches."""
826
"""The known formats."""
828
def __eq__(self, other):
829
return self.__class__ is other.__class__
831
def __ne__(self, other):
832
return not (self == other)
835
def find_format(klass, a_bzrdir):
836
"""Return the format for the branch object in a_bzrdir."""
838
transport = a_bzrdir.get_branch_transport(None)
839
format_string = transport.get("format").read()
840
return klass._formats[format_string]
841
except errors.NoSuchFile:
842
raise errors.NotBranchError(path=transport.base)
844
raise errors.UnknownFormatError(format=format_string, kind='branch')
847
def get_default_format(klass):
848
"""Return the current default format."""
849
return klass._default_format
851
def get_reference(self, a_bzrdir):
852
"""Get the target reference of the branch in a_bzrdir.
854
format probing must have been completed before calling
855
this method - it is assumed that the format of the branch
856
in a_bzrdir is correct.
858
:param a_bzrdir: The bzrdir to get the branch data from.
859
:return: None if the branch is not a reference branch.
864
def set_reference(self, a_bzrdir, to_branch):
865
"""Set the target reference of the branch in a_bzrdir.
867
format probing must have been completed before calling
868
this method - it is assumed that the format of the branch
869
in a_bzrdir is correct.
871
:param a_bzrdir: The bzrdir to set the branch reference for.
872
:param to_branch: branch that the checkout is to reference
874
raise NotImplementedError(self.set_reference)
876
def get_format_string(self):
877
"""Return the ASCII format string that identifies this format."""
878
raise NotImplementedError(self.get_format_string)
880
def get_format_description(self):
881
"""Return the short format description for this format."""
882
raise NotImplementedError(self.get_format_description)
884
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
886
"""Initialize a branch in a bzrdir, with specified files
888
:param a_bzrdir: The bzrdir to initialize the branch in
889
:param utf8_files: The files to create as a list of
890
(filename, content) tuples
891
:param set_format: If True, set the format with
892
self.get_format_string. (BzrBranch4 has its format set
894
:return: a branch in this format
896
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
897
branch_transport = a_bzrdir.get_branch_transport(self)
899
'metadir': ('lock', lockdir.LockDir),
900
'branch4': ('branch-lock', lockable_files.TransportLock),
902
lock_name, lock_class = lock_map[lock_type]
903
control_files = lockable_files.LockableFiles(branch_transport,
904
lock_name, lock_class)
905
control_files.create_lock()
906
control_files.lock_write()
908
control_files.put_utf8('format', self.get_format_string())
910
for file, content in utf8_files:
911
control_files.put_utf8(file, content)
913
control_files.unlock()
914
return self.open(a_bzrdir, _found=True)
916
def initialize(self, a_bzrdir):
917
"""Create a branch of this format in a_bzrdir."""
918
raise NotImplementedError(self.initialize)
920
def is_supported(self):
921
"""Is this format supported?
923
Supported formats can be initialized and opened.
924
Unsupported formats may not support initialization or committing or
925
some other features depending on the reason for not being supported.
929
def open(self, a_bzrdir, _found=False):
930
"""Return the branch object for a_bzrdir
932
_found is a private parameter, do not use it. It is used to indicate
933
if format probing has already be done.
935
raise NotImplementedError(self.open)
938
def register_format(klass, format):
939
klass._formats[format.get_format_string()] = format
942
def set_default_format(klass, format):
943
klass._default_format = format
946
def unregister_format(klass, format):
947
del klass._formats[format.get_format_string()]
950
return self.get_format_string().rstrip()
952
def supports_tags(self):
953
"""True if this format supports tags stored in the branch"""
954
return False # by default
956
# XXX: Probably doesn't really belong here -- mbp 20070212
957
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
959
branch_transport = a_bzrdir.get_branch_transport(self)
960
control_files = lockable_files.LockableFiles(branch_transport,
961
lock_filename, lock_class)
962
control_files.create_lock()
963
control_files.lock_write()
965
for filename, content in utf8_files:
966
control_files.put_utf8(filename, content)
968
control_files.unlock()
971
class BranchHooks(Hooks):
972
"""A dictionary mapping hook name to a list of callables for branch hooks.
974
e.g. ['set_rh'] Is the list of items to be called when the
975
set_revision_history function is invoked.
979
"""Create the default hooks.
981
These are all empty initially, because by default nothing should get
985
# Introduced in 0.15:
986
# invoked whenever the revision history has been set
987
# with set_revision_history. The api signature is
988
# (branch, revision_history), and the branch will
991
# invoked after a push operation completes.
992
# the api signature is
994
# containing the members
995
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
996
# where local is the local target branch or None, master is the target
997
# master branch, and the rest should be self explanatory. The source
998
# is read locked and the target branches write locked. Source will
999
# be the local low-latency branch.
1000
self['post_push'] = []
1001
# invoked after a pull operation completes.
1002
# the api signature is
1004
# containing the members
1005
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1006
# where local is the local branch or None, master is the target
1007
# master branch, and the rest should be self explanatory. The source
1008
# is read locked and the target branches write locked. The local
1009
# branch is the low-latency branch.
1010
self['post_pull'] = []
1011
# invoked before a commit operation takes place.
1012
# the api signature is
1013
# (local, master, old_revno, old_revid, future_revno, future_revid,
1014
# tree_delta, future_tree).
1015
# old_revid is NULL_REVISION for the first commit to a branch
1016
# tree_delta is a TreeDelta object describing changes from the basis
1017
# revision, hooks MUST NOT modify this delta
1018
# future_tree is an in-memory tree obtained from
1019
# CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
1020
self['pre_commit'] = []
1021
# invoked after a commit operation completes.
1022
# the api signature is
1023
# (local, master, old_revno, old_revid, new_revno, new_revid)
1024
# old_revid is NULL_REVISION for the first commit to a branch.
1025
self['post_commit'] = []
1026
# invoked after a uncommit operation completes.
1027
# the api signature is
1028
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1029
# local is the local branch or None, master is the target branch,
1030
# and an empty branch recieves new_revno of 0, new_revid of None.
1031
self['post_uncommit'] = []
1033
# Invoked after the tip of a branch changes.
1034
# the api signature is
1035
# (params) where params is a ChangeBranchTipParams with the members
1036
# (branch, old_revno, new_revno, old_revid, new_revid)
1037
self['post_change_branch_tip'] = []
1040
# install the default hooks into the Branch class.
1041
Branch.hooks = BranchHooks()
1044
class ChangeBranchTipParams(object):
1045
"""Object holding parameters passed to *_change_branch_tip hooks.
1047
There are 5 fields that hooks may wish to access:
1049
:ivar branch: the branch being changed
1050
:ivar old_revno: revision number before the change
1051
:ivar new_revno: revision number after the change
1052
:ivar old_revid: revision id before the change
1053
:ivar new_revid: revision id after the change
1055
The revid fields are strings. The revno fields are integers.
1058
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1059
"""Create a group of ChangeBranchTip parameters.
1061
:param branch: The branch being changed.
1062
:param old_revno: Revision number before the change.
1063
:param new_revno: Revision number after the change.
1064
:param old_revid: Tip revision id before the change.
1065
:param new_revid: Tip revision id after the change.
1067
self.branch = branch
1068
self.old_revno = old_revno
1069
self.new_revno = new_revno
1070
self.old_revid = old_revid
1071
self.new_revid = new_revid
1074
class BzrBranchFormat4(BranchFormat):
1075
"""Bzr branch format 4.
1078
- a revision-history file.
1079
- a branch-lock lock file [ to be shared with the bzrdir ]
1082
def get_format_description(self):
1083
"""See BranchFormat.get_format_description()."""
1084
return "Branch format 4"
1086
def initialize(self, a_bzrdir):
1087
"""Create a branch of this format in a_bzrdir."""
1088
utf8_files = [('revision-history', ''),
1089
('branch-name', ''),
1091
return self._initialize_helper(a_bzrdir, utf8_files,
1092
lock_type='branch4', set_format=False)
1095
super(BzrBranchFormat4, self).__init__()
1096
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1098
def open(self, a_bzrdir, _found=False):
1099
"""Return the branch object for a_bzrdir
1101
_found is a private parameter, do not use it. It is used to indicate
1102
if format probing has already be done.
1105
# we are being called directly and must probe.
1106
raise NotImplementedError
1107
return BzrBranch(_format=self,
1108
_control_files=a_bzrdir._control_files,
1110
_repository=a_bzrdir.open_repository())
1113
return "Bazaar-NG branch format 4"
1116
class BzrBranchFormat5(BranchFormat):
1117
"""Bzr branch format 5.
1120
- a revision-history file.
1122
- a lock dir guarding the branch itself
1123
- all of this stored in a branch/ subdirectory
1124
- works with shared repositories.
1126
This format is new in bzr 0.8.
1129
def get_format_string(self):
1130
"""See BranchFormat.get_format_string()."""
1131
return "Bazaar-NG branch format 5\n"
1133
def get_format_description(self):
1134
"""See BranchFormat.get_format_description()."""
1135
return "Branch format 5"
1137
def initialize(self, a_bzrdir):
1138
"""Create a branch of this format in a_bzrdir."""
1139
utf8_files = [('revision-history', ''),
1140
('branch-name', ''),
1142
return self._initialize_helper(a_bzrdir, utf8_files)
1145
super(BzrBranchFormat5, self).__init__()
1146
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1148
def open(self, a_bzrdir, _found=False):
1149
"""Return the branch object for a_bzrdir
1151
_found is a private parameter, do not use it. It is used to indicate
1152
if format probing has already be done.
1155
format = BranchFormat.find_format(a_bzrdir)
1156
if format.__class__ != self.__class__:
1157
raise AssertionError("wrong format %r found for %r" %
1160
transport = a_bzrdir.get_branch_transport(None)
1161
control_files = lockable_files.LockableFiles(transport, 'lock',
1163
return BzrBranch5(_format=self,
1164
_control_files=control_files,
1166
_repository=a_bzrdir.find_repository())
1167
except errors.NoSuchFile:
1168
raise errors.NotBranchError(path=transport.base)
1171
class BzrBranchFormat6(BzrBranchFormat5):
1172
"""Branch format with last-revision and tags.
1174
Unlike previous formats, this has no explicit revision history. Instead,
1175
this just stores the last-revision, and the left-hand history leading
1176
up to there is the history.
1178
This format was introduced in bzr 0.15
1179
and became the default in 0.91.
1182
def get_format_string(self):
1183
"""See BranchFormat.get_format_string()."""
1184
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1186
def get_format_description(self):
1187
"""See BranchFormat.get_format_description()."""
1188
return "Branch format 6"
1190
def initialize(self, a_bzrdir):
1191
"""Create a branch of this format in a_bzrdir."""
1192
utf8_files = [('last-revision', '0 null:\n'),
1193
('branch.conf', ''),
1196
return self._initialize_helper(a_bzrdir, utf8_files)
1198
def open(self, a_bzrdir, _found=False):
1199
"""Return the branch object for a_bzrdir
1201
_found is a private parameter, do not use it. It is used to indicate
1202
if format probing has already be done.
1205
format = BranchFormat.find_format(a_bzrdir)
1206
if format.__class__ != self.__class__:
1207
raise AssertionError("wrong format %r found for %r" %
1209
transport = a_bzrdir.get_branch_transport(None)
1210
control_files = lockable_files.LockableFiles(transport, 'lock',
1212
return BzrBranch6(_format=self,
1213
_control_files=control_files,
1215
_repository=a_bzrdir.find_repository())
1217
def supports_tags(self):
1221
class BranchReferenceFormat(BranchFormat):
1222
"""Bzr branch reference format.
1224
Branch references are used in implementing checkouts, they
1225
act as an alias to the real branch which is at some other url.
1232
def get_format_string(self):
1233
"""See BranchFormat.get_format_string()."""
1234
return "Bazaar-NG Branch Reference Format 1\n"
1236
def get_format_description(self):
1237
"""See BranchFormat.get_format_description()."""
1238
return "Checkout reference format 1"
1240
def get_reference(self, a_bzrdir):
1241
"""See BranchFormat.get_reference()."""
1242
transport = a_bzrdir.get_branch_transport(None)
1243
return transport.get('location').read()
1245
def set_reference(self, a_bzrdir, to_branch):
1246
"""See BranchFormat.set_reference()."""
1247
transport = a_bzrdir.get_branch_transport(None)
1248
location = transport.put_bytes('location', to_branch.base)
1250
def initialize(self, a_bzrdir, target_branch=None):
1251
"""Create a branch of this format in a_bzrdir."""
1252
if target_branch is None:
1253
# this format does not implement branch itself, thus the implicit
1254
# creation contract must see it as uninitializable
1255
raise errors.UninitializableFormat(self)
1256
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1257
branch_transport = a_bzrdir.get_branch_transport(self)
1258
branch_transport.put_bytes('location',
1259
target_branch.bzrdir.root_transport.base)
1260
branch_transport.put_bytes('format', self.get_format_string())
1262
a_bzrdir, _found=True,
1263
possible_transports=[target_branch.bzrdir.root_transport])
1266
super(BranchReferenceFormat, self).__init__()
1267
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1269
def _make_reference_clone_function(format, a_branch):
1270
"""Create a clone() routine for a branch dynamically."""
1271
def clone(to_bzrdir, revision_id=None):
1272
"""See Branch.clone()."""
1273
return format.initialize(to_bzrdir, a_branch)
1274
# cannot obey revision_id limits when cloning a reference ...
1275
# FIXME RBC 20060210 either nuke revision_id for clone, or
1276
# emit some sort of warning/error to the caller ?!
1279
def open(self, a_bzrdir, _found=False, location=None,
1280
possible_transports=None):
1281
"""Return the branch that the branch reference in a_bzrdir points at.
1283
_found is a private parameter, do not use it. It is used to indicate
1284
if format probing has already be done.
1287
format = BranchFormat.find_format(a_bzrdir)
1288
if format.__class__ != self.__class__:
1289
raise AssertionError("wrong format %r found for %r" %
1291
if location is None:
1292
location = self.get_reference(a_bzrdir)
1293
real_bzrdir = bzrdir.BzrDir.open(
1294
location, possible_transports=possible_transports)
1295
result = real_bzrdir.open_branch()
1296
# this changes the behaviour of result.clone to create a new reference
1297
# rather than a copy of the content of the branch.
1298
# I did not use a proxy object because that needs much more extensive
1299
# testing, and we are only changing one behaviour at the moment.
1300
# If we decide to alter more behaviours - i.e. the implicit nickname
1301
# then this should be refactored to introduce a tested proxy branch
1302
# and a subclass of that for use in overriding clone() and ....
1304
result.clone = self._make_reference_clone_function(result)
1308
# formats which have no format string are not discoverable
1309
# and not independently creatable, so are not registered.
1310
__format5 = BzrBranchFormat5()
1311
__format6 = BzrBranchFormat6()
1312
BranchFormat.register_format(__format5)
1313
BranchFormat.register_format(BranchReferenceFormat())
1314
BranchFormat.register_format(__format6)
1315
BranchFormat.set_default_format(__format6)
1316
_legacy_formats = [BzrBranchFormat4(),
1319
class BzrBranch(Branch):
1320
"""A branch stored in the actual filesystem.
1322
Note that it's "local" in the context of the filesystem; it doesn't
1323
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1324
it's writable, and can be accessed via the normal filesystem API.
1327
def __init__(self, _format=None,
1328
_control_files=None, a_bzrdir=None, _repository=None):
1329
"""Create new branch object at a particular location."""
1330
Branch.__init__(self)
1331
if a_bzrdir is None:
1332
raise ValueError('a_bzrdir must be supplied')
1334
self.bzrdir = a_bzrdir
1335
# self._transport used to point to the directory containing the
1336
# control directory, but was not used - now it's just the transport
1337
# for the branch control files. mbp 20070212
1338
self._base = self.bzrdir.transport.clone('..').base
1339
self._format = _format
1340
if _control_files is None:
1341
raise ValueError('BzrBranch _control_files is None')
1342
self.control_files = _control_files
1343
self._transport = _control_files._transport
1344
self.repository = _repository
1347
return '%s(%r)' % (self.__class__.__name__, self.base)
1351
def _get_base(self):
1352
"""Returns the directory containing the control directory."""
1355
base = property(_get_base, doc="The URL for the root of this branch.")
1357
def abspath(self, name):
1358
"""See Branch.abspath."""
1359
return self.control_files._transport.abspath(name)
1361
def is_locked(self):
1362
return self.control_files.is_locked()
1364
def lock_write(self, token=None):
1365
repo_token = self.repository.lock_write()
1367
token = self.control_files.lock_write(token=token)
1369
self.repository.unlock()
1373
def lock_read(self):
1374
self.repository.lock_read()
1376
self.control_files.lock_read()
1378
self.repository.unlock()
1382
# TODO: test for failed two phase locks. This is known broken.
1384
self.control_files.unlock()
1386
self.repository.unlock()
1387
if not self.control_files.is_locked():
1388
# we just released the lock
1389
self._clear_cached_state()
1391
def peek_lock_mode(self):
1392
if self.control_files._lock_count == 0:
1395
return self.control_files._lock_mode
1397
def get_physical_lock_status(self):
1398
return self.control_files.get_physical_lock_status()
1401
def print_file(self, file, revision_id):
1402
"""See Branch.print_file."""
1403
return self.repository.print_file(file, revision_id)
1405
def _write_revision_history(self, history):
1406
"""Factored out of set_revision_history.
1408
This performs the actual writing to disk.
1409
It is intended to be called by BzrBranch5.set_revision_history."""
1410
self.control_files.put_bytes(
1411
'revision-history', '\n'.join(history))
1414
def set_revision_history(self, rev_history):
1415
"""See Branch.set_revision_history."""
1416
if 'evil' in debug.debug_flags:
1417
mutter_callsite(3, "set_revision_history scales with history.")
1418
self._write_revision_history(rev_history)
1419
self._clear_cached_state()
1420
self._cache_revision_history(rev_history)
1421
for hook in Branch.hooks['set_rh']:
1422
hook(self, rev_history)
1424
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1425
"""Run the post_change_branch_tip hooks."""
1426
hooks = Branch.hooks['post_change_branch_tip']
1429
new_revno, new_revid = self.last_revision_info()
1430
params = ChangeBranchTipParams(
1431
self, old_revno, new_revno, old_revid, new_revid)
1436
def set_last_revision_info(self, revno, revision_id):
1437
"""Set the last revision of this branch.
1439
The caller is responsible for checking that the revno is correct
1440
for this revision id.
1442
It may be possible to set the branch last revision to an id not
1443
present in the repository. However, branches can also be
1444
configured to check constraints on history, in which case this may not
1447
revision_id = _mod_revision.ensure_null(revision_id)
1448
old_revno, old_revid = self.last_revision_info()
1449
# this old format stores the full history, but this api doesn't
1450
# provide it, so we must generate, and might as well check it's
1452
history = self._lefthand_history(revision_id)
1453
if len(history) != revno:
1454
raise AssertionError('%d != %d' % (len(history), revno))
1455
self.set_revision_history(history)
1456
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1458
def _gen_revision_history(self):
1459
history = self.control_files.get('revision-history').read().split('\n')
1460
if history[-1:] == ['']:
1461
# There shouldn't be a trailing newline, but just in case.
1465
def _lefthand_history(self, revision_id, last_rev=None,
1467
if 'evil' in debug.debug_flags:
1468
mutter_callsite(4, "_lefthand_history scales with history.")
1469
# stop_revision must be a descendant of last_revision
1470
graph = self.repository.get_graph()
1471
if last_rev is not None:
1472
if not graph.is_ancestor(last_rev, revision_id):
1473
# our previous tip is not merged into stop_revision
1474
raise errors.DivergedBranches(self, other_branch)
1475
# make a new revision history from the graph
1476
parents_map = graph.get_parent_map([revision_id])
1477
if revision_id not in parents_map:
1478
raise errors.NoSuchRevision(self, revision_id)
1479
current_rev_id = revision_id
1481
# Do not include ghosts or graph origin in revision_history
1482
while (current_rev_id in parents_map and
1483
len(parents_map[current_rev_id]) > 0):
1484
new_history.append(current_rev_id)
1485
current_rev_id = parents_map[current_rev_id][0]
1486
parents_map = graph.get_parent_map([current_rev_id])
1487
new_history.reverse()
1491
def generate_revision_history(self, revision_id, last_rev=None,
1493
"""Create a new revision history that will finish with revision_id.
1495
:param revision_id: the new tip to use.
1496
:param last_rev: The previous last_revision. If not None, then this
1497
must be a ancestory of revision_id, or DivergedBranches is raised.
1498
:param other_branch: The other branch that DivergedBranches should
1499
raise with respect to.
1501
self.set_revision_history(self._lefthand_history(revision_id,
1502
last_rev, other_branch))
1505
def update_revisions(self, other, stop_revision=None, overwrite=False):
1506
"""See Branch.update_revisions."""
1509
other_last_revno, other_last_revision = other.last_revision_info()
1510
if stop_revision is None:
1511
stop_revision = other_last_revision
1512
if _mod_revision.is_null(stop_revision):
1513
# if there are no commits, we're done.
1515
# whats the current last revision, before we fetch [and change it
1517
last_rev = _mod_revision.ensure_null(self.last_revision())
1518
# we fetch here so that we don't process data twice in the common
1519
# case of having something to pull, and so that the check for
1520
# already merged can operate on the just fetched graph, which will
1521
# be cached in memory.
1522
self.fetch(other, stop_revision)
1523
# Check to see if one is an ancestor of the other
1525
heads = self.repository.get_graph().heads([stop_revision,
1527
if heads == set([last_rev]):
1528
# The current revision is a decendent of the target,
1531
elif heads == set([stop_revision, last_rev]):
1532
# These branches have diverged
1533
raise errors.DivergedBranches(self, other)
1534
elif heads != set([stop_revision]):
1535
raise AssertionError("invalid heads: %r" % heads)
1536
if other_last_revision == stop_revision:
1537
self.set_last_revision_info(other_last_revno,
1538
other_last_revision)
1540
# TODO: jam 2007-11-29 Is there a way to determine the
1541
# revno without searching all of history??
1543
self.generate_revision_history(stop_revision)
1545
self.generate_revision_history(stop_revision,
1546
last_rev=last_rev, other_branch=other)
1550
def basis_tree(self):
1551
"""See Branch.basis_tree."""
1552
return self.repository.revision_tree(self.last_revision())
1555
def pull(self, source, overwrite=False, stop_revision=None,
1556
_hook_master=None, run_hooks=True, possible_transports=None):
1559
:param _hook_master: Private parameter - set the branch to
1560
be supplied as the master to push hooks.
1561
:param run_hooks: Private parameter - if false, this branch
1562
is being called because it's the master of the primary branch,
1563
so it should not run its hooks.
1565
result = PullResult()
1566
result.source_branch = source
1567
result.target_branch = self
1570
result.old_revno, result.old_revid = self.last_revision_info()
1571
self.update_revisions(source, stop_revision, overwrite=overwrite)
1572
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
1573
result.new_revno, result.new_revid = self.last_revision_info()
1575
result.master_branch = _hook_master
1576
result.local_branch = self
1578
result.master_branch = self
1579
result.local_branch = None
1581
for hook in Branch.hooks['post_pull']:
1587
def _get_parent_location(self):
1588
_locs = ['parent', 'pull', 'x-pull']
1591
return self.control_files.get(l).read().strip('\n')
1592
except errors.NoSuchFile:
1597
def push(self, target, overwrite=False, stop_revision=None,
1598
_override_hook_source_branch=None):
1601
This is the basic concrete implementation of push()
1603
:param _override_hook_source_branch: If specified, run
1604
the hooks passing this Branch as the source, rather than self.
1605
This is for use of RemoteBranch, where push is delegated to the
1606
underlying vfs-based Branch.
1608
# TODO: Public option to disable running hooks - should be trivial but
1612
result = self._push_with_bound_branches(target, overwrite,
1614
_override_hook_source_branch=_override_hook_source_branch)
1619
def _push_with_bound_branches(self, target, overwrite,
1621
_override_hook_source_branch=None):
1622
"""Push from self into target, and into target's master if any.
1624
This is on the base BzrBranch class even though it doesn't support
1625
bound branches because the *target* might be bound.
1628
if _override_hook_source_branch:
1629
result.source_branch = _override_hook_source_branch
1630
for hook in Branch.hooks['post_push']:
1633
bound_location = target.get_bound_location()
1634
if bound_location and target.base != bound_location:
1635
# there is a master branch.
1637
# XXX: Why the second check? Is it even supported for a branch to
1638
# be bound to itself? -- mbp 20070507
1639
master_branch = target.get_master_branch()
1640
master_branch.lock_write()
1642
# push into the master from this branch.
1643
self._basic_push(master_branch, overwrite, stop_revision)
1644
# and push into the target branch from this. Note that we push from
1645
# this branch again, because its considered the highest bandwidth
1647
result = self._basic_push(target, overwrite, stop_revision)
1648
result.master_branch = master_branch
1649
result.local_branch = target
1653
master_branch.unlock()
1656
result = self._basic_push(target, overwrite, stop_revision)
1657
# TODO: Why set master_branch and local_branch if there's no
1658
# binding? Maybe cleaner to just leave them unset? -- mbp
1660
result.master_branch = target
1661
result.local_branch = None
1665
def _basic_push(self, target, overwrite, stop_revision):
1666
"""Basic implementation of push without bound branches or hooks.
1668
Must be called with self read locked and target write locked.
1670
result = PushResult()
1671
result.source_branch = self
1672
result.target_branch = target
1673
result.old_revno, result.old_revid = target.last_revision_info()
1675
target.update_revisions(self, stop_revision)
1676
except errors.DivergedBranches:
1680
target.set_revision_history(self.revision_history())
1681
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
1682
result.new_revno, result.new_revid = target.last_revision_info()
1685
def get_parent(self):
1686
"""See Branch.get_parent."""
1687
parent = self._get_parent_location()
1690
# This is an old-format absolute path to a local branch
1691
# turn it into a url
1692
if parent.startswith('/'):
1693
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1695
return urlutils.join(self.base[:-1], parent)
1696
except errors.InvalidURLJoin, e:
1697
raise errors.InaccessibleParent(parent, self.base)
1699
def set_push_location(self, location):
1700
"""See Branch.set_push_location."""
1701
self.get_config().set_user_option(
1702
'push_location', location,
1703
store=_mod_config.STORE_LOCATION_NORECURSE)
1706
def set_parent(self, url):
1707
"""See Branch.set_parent."""
1708
# TODO: Maybe delete old location files?
1709
# URLs should never be unicode, even on the local fs,
1710
# FIXUP this and get_parent in a future branch format bump:
1711
# read and rewrite the file. RBC 20060125
1713
if isinstance(url, unicode):
1715
url = url.encode('ascii')
1716
except UnicodeEncodeError:
1717
raise errors.InvalidURL(url,
1718
"Urls must be 7-bit ascii, "
1719
"use bzrlib.urlutils.escape")
1720
url = urlutils.relative_url(self.base, url)
1721
self._set_parent_location(url)
1723
def _set_parent_location(self, url):
1725
self.control_files._transport.delete('parent')
1727
self.control_files.put_bytes('parent', url + '\n')
1730
class BzrBranch5(BzrBranch):
1731
"""A format 5 branch. This supports new features over plain branches.
1733
It has support for a master_branch which is the data for bound branches.
1741
super(BzrBranch5, self).__init__(_format=_format,
1742
_control_files=_control_files,
1744
_repository=_repository)
1747
def pull(self, source, overwrite=False, stop_revision=None,
1748
run_hooks=True, possible_transports=None):
1749
"""Pull from source into self, updating my master if any.
1751
:param run_hooks: Private parameter - if false, this branch
1752
is being called because it's the master of the primary branch,
1753
so it should not run its hooks.
1755
bound_location = self.get_bound_location()
1756
master_branch = None
1757
if bound_location and source.base != bound_location:
1758
# not pulling from master, so we need to update master.
1759
master_branch = self.get_master_branch(possible_transports)
1760
master_branch.lock_write()
1763
# pull from source into master.
1764
master_branch.pull(source, overwrite, stop_revision,
1766
return super(BzrBranch5, self).pull(source, overwrite,
1767
stop_revision, _hook_master=master_branch,
1768
run_hooks=run_hooks)
1771
master_branch.unlock()
1773
def get_bound_location(self):
1775
return self._transport.get_bytes('bound')[:-1]
1776
except errors.NoSuchFile:
1780
def get_master_branch(self, possible_transports=None):
1781
"""Return the branch we are bound to.
1783
:return: Either a Branch, or None
1785
This could memoise the branch, but if thats done
1786
it must be revalidated on each new lock.
1787
So for now we just don't memoise it.
1788
# RBC 20060304 review this decision.
1790
bound_loc = self.get_bound_location()
1794
return Branch.open(bound_loc,
1795
possible_transports=possible_transports)
1796
except (errors.NotBranchError, errors.ConnectionError), e:
1797
raise errors.BoundBranchConnectionFailure(
1801
def set_bound_location(self, location):
1802
"""Set the target where this branch is bound to.
1804
:param location: URL to the target branch
1807
self.control_files.put_utf8('bound', location+'\n')
1810
self.control_files._transport.delete('bound')
1811
except errors.NoSuchFile:
1816
def bind(self, other):
1817
"""Bind this branch to the branch other.
1819
This does not push or pull data between the branches, though it does
1820
check for divergence to raise an error when the branches are not
1821
either the same, or one a prefix of the other. That behaviour may not
1822
be useful, so that check may be removed in future.
1824
:param other: The branch to bind to
1827
# TODO: jam 20051230 Consider checking if the target is bound
1828
# It is debatable whether you should be able to bind to
1829
# a branch which is itself bound.
1830
# Committing is obviously forbidden,
1831
# but binding itself may not be.
1832
# Since we *have* to check at commit time, we don't
1833
# *need* to check here
1835
# we want to raise diverged if:
1836
# last_rev is not in the other_last_rev history, AND
1837
# other_last_rev is not in our history, and do it without pulling
1839
self.set_bound_location(other.base)
1843
"""If bound, unbind"""
1844
return self.set_bound_location(None)
1847
def update(self, possible_transports=None):
1848
"""Synchronise this branch with the master branch if any.
1850
:return: None or the last_revision that was pivoted out during the
1853
master = self.get_master_branch(possible_transports)
1854
if master is not None:
1855
old_tip = _mod_revision.ensure_null(self.last_revision())
1856
self.pull(master, overwrite=True)
1857
if self.repository.get_graph().is_ancestor(old_tip,
1858
_mod_revision.ensure_null(self.last_revision())):
1864
class BzrBranch6(BzrBranch5):
1866
def __init__(self, *args, **kwargs):
1867
super(BzrBranch6, self).__init__(*args, **kwargs)
1868
self._last_revision_info_cache = None
1869
self._partial_revision_history_cache = []
1871
def _clear_cached_state(self):
1872
super(BzrBranch6, self)._clear_cached_state()
1873
self._last_revision_info_cache = None
1874
self._partial_revision_history_cache = []
1877
def last_revision_info(self):
1878
"""Return information about the last revision.
1880
:return: A tuple (revno, revision_id).
1882
if self._last_revision_info_cache is None:
1883
self._last_revision_info_cache = self._last_revision_info()
1884
return self._last_revision_info_cache
1886
def _last_revision_info(self):
1887
revision_string = self.control_files.get('last-revision').read()
1888
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1889
revision_id = cache_utf8.get_cached_utf8(revision_id)
1891
return revno, revision_id
1893
def _write_last_revision_info(self, revno, revision_id):
1894
"""Simply write out the revision id, with no checks.
1896
Use set_last_revision_info to perform this safely.
1898
Does not update the revision_history cache.
1899
Intended to be called by set_last_revision_info and
1900
_write_revision_history.
1902
revision_id = _mod_revision.ensure_null(revision_id)
1903
out_string = '%d %s\n' % (revno, revision_id)
1904
self.control_files.put_bytes('last-revision', out_string)
1907
def set_last_revision_info(self, revno, revision_id):
1908
revision_id = _mod_revision.ensure_null(revision_id)
1909
old_revno, old_revid = self.last_revision_info()
1910
if self._get_append_revisions_only():
1911
self._check_history_violation(revision_id)
1912
self._write_last_revision_info(revno, revision_id)
1913
self._clear_cached_state()
1914
self._last_revision_info_cache = revno, revision_id
1915
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1917
def _check_history_violation(self, revision_id):
1918
last_revision = _mod_revision.ensure_null(self.last_revision())
1919
if _mod_revision.is_null(last_revision):
1921
if last_revision not in self._lefthand_history(revision_id):
1922
raise errors.AppendRevisionsOnlyViolation(self.base)
1924
def _gen_revision_history(self):
1925
"""Generate the revision history from last revision
1927
self._extend_partial_history()
1928
return list(reversed(self._partial_revision_history_cache))
1930
def _extend_partial_history(self, stop_index=None, stop_revision=None):
1931
"""Extend the partial history to include a given index
1933
If a stop_index is supplied, stop when that index has been reached.
1934
If a stop_revision is supplied, stop when that revision is
1935
encountered. Otherwise, stop when the beginning of history is
1938
:param stop_index: The index which should be present. When it is
1939
present, history extension will stop.
1940
:param revision_id: The revision id which should be present. When
1941
it is encountered, history extension will stop.
1943
repo = self.repository
1944
if len(self._partial_revision_history_cache) == 0:
1945
iterator = repo.iter_reverse_revision_history(self.last_revision())
1947
start_revision = self._partial_revision_history_cache[-1]
1948
iterator = repo.iter_reverse_revision_history(start_revision)
1949
#skip the last revision in the list
1950
next_revision = iterator.next()
1951
for revision_id in iterator:
1952
self._partial_revision_history_cache.append(revision_id)
1953
if (stop_index is not None and
1954
len(self._partial_revision_history_cache) > stop_index):
1956
if revision_id == stop_revision:
1959
def _write_revision_history(self, history):
1960
"""Factored out of set_revision_history.
1962
This performs the actual writing to disk, with format-specific checks.
1963
It is intended to be called by BzrBranch5.set_revision_history.
1965
if len(history) == 0:
1966
last_revision = 'null:'
1968
if history != self._lefthand_history(history[-1]):
1969
raise errors.NotLefthandHistory(history)
1970
last_revision = history[-1]
1971
if self._get_append_revisions_only():
1972
self._check_history_violation(last_revision)
1973
self._write_last_revision_info(len(history), last_revision)
1976
def _set_parent_location(self, url):
1977
"""Set the parent branch"""
1978
self._set_config_location('parent_location', url, make_relative=True)
1981
def _get_parent_location(self):
1982
"""Set the parent branch"""
1983
return self._get_config_location('parent_location')
1985
def set_push_location(self, location):
1986
"""See Branch.set_push_location."""
1987
self._set_config_location('push_location', location)
1989
def set_bound_location(self, location):
1990
"""See Branch.set_push_location."""
1992
config = self.get_config()
1993
if location is None:
1994
if config.get_user_option('bound') != 'True':
1997
config.set_user_option('bound', 'False', warn_masked=True)
2000
self._set_config_location('bound_location', location,
2002
config.set_user_option('bound', 'True', warn_masked=True)
2005
def _get_bound_location(self, bound):
2006
"""Return the bound location in the config file.
2008
Return None if the bound parameter does not match"""
2009
config = self.get_config()
2010
config_bound = (config.get_user_option('bound') == 'True')
2011
if config_bound != bound:
2013
return self._get_config_location('bound_location', config=config)
2015
def get_bound_location(self):
2016
"""See Branch.set_push_location."""
2017
return self._get_bound_location(True)
2019
def get_old_bound_location(self):
2020
"""See Branch.get_old_bound_location"""
2021
return self._get_bound_location(False)
2023
def set_append_revisions_only(self, enabled):
2028
self.get_config().set_user_option('append_revisions_only', value,
2031
def _get_append_revisions_only(self):
2032
value = self.get_config().get_user_option('append_revisions_only')
2033
return value == 'True'
2035
def _synchronize_history(self, destination, revision_id):
2036
"""Synchronize last revision and revision history between branches.
2038
This version is most efficient when the destination is also a
2039
BzrBranch6, but works for BzrBranch5, as long as the destination's
2040
repository contains all the lefthand ancestors of the intended
2041
last_revision. If not, set_last_revision_info will fail.
2043
:param destination: The branch to copy the history into
2044
:param revision_id: The revision-id to truncate history at. May
2045
be None to copy complete history.
2047
source_revno, source_revision_id = self.last_revision_info()
2048
if revision_id is None:
2049
revno, revision_id = source_revno, source_revision_id
2050
elif source_revision_id == revision_id:
2051
# we know the revno without needing to walk all of history
2052
revno = source_revno
2054
# To figure out the revno for a random revision, we need to build
2055
# the revision history, and count its length.
2056
# We don't care about the order, just how long it is.
2057
# Alternatively, we could start at the current location, and count
2058
# backwards. But there is no guarantee that we will find it since
2059
# it may be a merged revision.
2060
revno = len(list(self.repository.iter_reverse_revision_history(
2062
destination.set_last_revision_info(revno, revision_id)
2064
def _make_tags(self):
2065
return BasicTags(self)
2068
def generate_revision_history(self, revision_id, last_rev=None,
2070
"""See BzrBranch5.generate_revision_history"""
2071
history = self._lefthand_history(revision_id, last_rev, other_branch)
2072
revno = len(history)
2073
self.set_last_revision_info(revno, revision_id)
2076
def get_rev_id(self, revno, history=None):
2077
"""Find the revision id of the specified revno."""
2079
return _mod_revision.NULL_REVISION
2081
last_revno, last_revision_id = self.last_revision_info()
2082
if revno <= 0 or revno > last_revno:
2083
raise errors.NoSuchRevision(self, revno)
2085
if history is not None:
2086
return history[revno - 1]
2088
index = last_revno - revno
2089
if len(self._partial_revision_history_cache) <= index:
2090
self._extend_partial_history(stop_index=index)
2091
if len(self._partial_revision_history_cache) > index:
2092
return self._partial_revision_history_cache[index]
2094
raise errors.NoSuchRevision(self, revno)
2097
def revision_id_to_revno(self, revision_id):
2098
"""Given a revision id, return its revno"""
2099
if _mod_revision.is_null(revision_id):
2102
index = self._partial_revision_history_cache.index(revision_id)
2104
self._extend_partial_history(stop_revision=revision_id)
2105
index = len(self._partial_revision_history_cache) - 1
2106
if self._partial_revision_history_cache[index] != revision_id:
2107
raise errors.NoSuchRevision(self, revision_id)
2108
return self.revno() - index
2111
######################################################################
2112
# results of operations
2115
class _Result(object):
2117
def _show_tag_conficts(self, to_file):
2118
if not getattr(self, 'tag_conflicts', None):
2120
to_file.write('Conflicting tags:\n')
2121
for name, value1, value2 in self.tag_conflicts:
2122
to_file.write(' %s\n' % (name, ))
2125
class PullResult(_Result):
2126
"""Result of a Branch.pull operation.
2128
:ivar old_revno: Revision number before pull.
2129
:ivar new_revno: Revision number after pull.
2130
:ivar old_revid: Tip revision id before pull.
2131
:ivar new_revid: Tip revision id after pull.
2132
:ivar source_branch: Source (local) branch object.
2133
:ivar master_branch: Master branch of the target, or None.
2134
:ivar target_branch: Target/destination branch object.
2138
# DEPRECATED: pull used to return the change in revno
2139
return self.new_revno - self.old_revno
2141
def report(self, to_file):
2143
if self.old_revid == self.new_revid:
2144
to_file.write('No revisions to pull.\n')
2146
to_file.write('Now on revision %d.\n' % self.new_revno)
2147
self._show_tag_conficts(to_file)
2150
class PushResult(_Result):
2151
"""Result of a Branch.push operation.
2153
:ivar old_revno: Revision number before push.
2154
:ivar new_revno: Revision number after push.
2155
:ivar old_revid: Tip revision id before push.
2156
:ivar new_revid: Tip revision id after push.
2157
:ivar source_branch: Source branch object.
2158
:ivar master_branch: Master branch of the target, or None.
2159
:ivar target_branch: Target/destination branch object.
2163
# DEPRECATED: push used to return the change in revno
2164
return self.new_revno - self.old_revno
2166
def report(self, to_file):
2167
"""Write a human-readable description of the result."""
2168
if self.old_revid == self.new_revid:
2169
to_file.write('No new revisions to push.\n')
2171
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2172
self._show_tag_conficts(to_file)
2175
class BranchCheckResult(object):
2176
"""Results of checking branch consistency.
2181
def __init__(self, branch):
2182
self.branch = branch
2184
def report_results(self, verbose):
2185
"""Report the check results via trace.note.
2187
:param verbose: Requests more detailed display of what was checked,
2190
note('checked branch %s format %s',
2192
self.branch._format)
2195
class Converter5to6(object):
2196
"""Perform an in-place upgrade of format 5 to format 6"""
2198
def convert(self, branch):
2199
# Data for 5 and 6 can peacefully coexist.
2200
format = BzrBranchFormat6()
2201
new_branch = format.open(branch.bzrdir, _found=True)
2203
# Copy source data into target
2204
new_branch._write_last_revision_info(*branch.last_revision_info())
2205
new_branch.set_parent(branch.get_parent())
2206
new_branch.set_bound_location(branch.get_bound_location())
2207
new_branch.set_push_location(branch.get_push_location())
2209
# New branch has no tags by default
2210
new_branch.tags._set_tag_dict({})
2212
# Copying done; now update target format
2213
new_branch.control_files.put_utf8('format',
2214
format.get_format_string())
2216
# Clean up old files
2217
new_branch.control_files._transport.delete('revision-history')
2219
branch.set_parent(None)
2220
except errors.NoSuchFile:
2222
branch.set_bound_location(None)
added
removed
bzrlib/branch.py
