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 cStringIO import StringIO
20
from bzrlib.lazy_import import lazy_import
21
lazy_import(globals(), """
22
from warnings import warn
28
config as _mod_config,
33
revision as _mod_revision,
40
from bzrlib.config import BranchConfig, TreeConfig
41
from bzrlib.lockable_files import LockableFiles, TransportLock
42
from bzrlib.tag import (
48
from bzrlib.decorators import needs_read_lock, needs_write_lock
49
from bzrlib.errors import (BzrError, BzrCheckError, DivergedBranches,
50
HistoryMissing, InvalidRevisionId,
51
InvalidRevisionNumber, LockError, NoSuchFile,
52
NoSuchRevision, NoWorkingTree, NotVersionedError,
53
NotBranchError, UninitializableFormat,
54
UnlistableStore, UnlistableBranch,
56
from bzrlib.hooks import Hooks
57
from bzrlib.symbol_versioning import (deprecated_function,
61
zero_eight, zero_nine, zero_sixteen,
64
from bzrlib.trace import mutter, note
67
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
68
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
69
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
72
# TODO: Maybe include checks for common corruption of newlines, etc?
74
# TODO: Some operations like log might retrieve the same revisions
75
# repeatedly to calculate deltas. We could perhaps have a weakref
76
# cache in memory to make this faster. In general anything can be
77
# cached in memory between lock and unlock operations. .. nb thats
78
# what the transaction identity map provides
81
######################################################################
85
"""Branch holding a history of revisions.
88
Base directory/url of the branch.
90
hooks: An instance of BranchHooks.
92
# this is really an instance variable - FIXME move it there
96
# override this to set the strategy for storing tags
98
return DisabledTags(self)
100
def __init__(self, *ignored, **ignored_too):
101
self.tags = self._make_tags()
102
self._revision_history_cache = None
103
self._revision_id_to_revno_cache = None
105
def break_lock(self):
106
"""Break a lock if one is present from another instance.
108
Uses the ui factory to ask for confirmation if the lock may be from
111
This will probe the repository for its lock as well.
113
self.control_files.break_lock()
114
self.repository.break_lock()
115
master = self.get_master_branch()
116
if master is not None:
120
@deprecated_method(zero_eight)
121
def open_downlevel(base):
122
"""Open a branch which may be of an old format."""
123
return Branch.open(base, _unsupported=True)
126
def open(base, _unsupported=False):
127
"""Open the branch rooted at base.
129
For instance, if the branch is at URL/.bzr/branch,
130
Branch.open(URL) -> a Branch instance.
132
control = bzrdir.BzrDir.open(base, _unsupported)
133
return control.open_branch(_unsupported)
136
def open_from_transport(transport, _unsupported=False):
137
"""Open the branch rooted at transport"""
138
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
139
return control.open_branch(_unsupported)
142
def open_containing(url, possible_transports=None):
143
"""Open an existing branch which contains url.
145
This probes for a branch at url, and searches upwards from there.
147
Basically we keep looking up until we find the control directory or
148
run into the root. If there isn't one, raises NotBranchError.
149
If there is one and it is either an unrecognised format or an unsupported
150
format, UnknownFormatError or UnsupportedFormatError are raised.
151
If there is one, it is returned, along with the unused portion of url.
153
control, relpath = bzrdir.BzrDir.open_containing(url,
155
return control.open_branch(), relpath
158
@deprecated_function(zero_eight)
159
def initialize(base):
160
"""Create a new working tree and branch, rooted at 'base' (url)
162
NOTE: This will soon be deprecated in favour of creation
165
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
167
@deprecated_function(zero_eight)
168
def setup_caching(self, cache_root):
169
"""Subclasses that care about caching should override this, and set
170
up cached stores located under cache_root.
172
NOTE: This is unused.
176
def get_config(self):
177
return BranchConfig(self)
180
return self.get_config().get_nickname()
182
def _set_nick(self, nick):
183
self.get_config().set_user_option('nickname', nick, warn_masked=True)
185
nick = property(_get_nick, _set_nick)
188
raise NotImplementedError(self.is_locked)
190
def lock_write(self):
191
raise NotImplementedError(self.lock_write)
194
raise NotImplementedError(self.lock_read)
197
raise NotImplementedError(self.unlock)
199
def peek_lock_mode(self):
200
"""Return lock mode for the Branch: 'r', 'w' or None"""
201
raise NotImplementedError(self.peek_lock_mode)
203
def get_physical_lock_status(self):
204
raise NotImplementedError(self.get_physical_lock_status)
207
def get_revision_id_to_revno_map(self):
208
"""Return the revision_id => dotted revno map.
210
This will be regenerated on demand, but will be cached.
212
:return: A dictionary mapping revision_id => dotted revno.
213
This dictionary should not be modified by the caller.
215
if self._revision_id_to_revno_cache is not None:
216
mapping = self._revision_id_to_revno_cache
218
mapping = self._gen_revno_map()
219
self._cache_revision_id_to_revno(mapping)
220
# TODO: jam 20070417 Since this is being cached, should we be returning
222
# I would rather not, and instead just declare that users should not
223
# modify the return value.
226
def _gen_revno_map(self):
227
"""Create a new mapping from revision ids to dotted revnos.
229
Dotted revnos are generated based on the current tip in the revision
231
This is the worker function for get_revision_id_to_revno_map, which
232
just caches the return value.
234
:return: A dictionary mapping revision_id => dotted revno.
236
last_revision = self.last_revision()
237
revision_graph = self.repository.get_revision_graph(last_revision)
238
merge_sorted_revisions = tsort.merge_sort(
243
revision_id_to_revno = dict((rev_id, revno)
244
for seq_num, rev_id, depth, revno, end_of_merge
245
in merge_sorted_revisions)
246
return revision_id_to_revno
248
def leave_lock_in_place(self):
249
"""Tell this branch object not to release the physical lock when this
252
If lock_write doesn't return a token, then this method is not supported.
254
self.control_files.leave_in_place()
256
def dont_leave_lock_in_place(self):
257
"""Tell this branch object to release the physical lock when this
258
object is unlocked, even if it didn't originally acquire it.
260
If lock_write doesn't return a token, then this method is not supported.
262
self.control_files.dont_leave_in_place()
264
def abspath(self, name):
265
"""Return absolute filename for something in the branch
267
XXX: Robert Collins 20051017 what is this used for? why is it a branch
268
method and not a tree method.
270
raise NotImplementedError(self.abspath)
272
def bind(self, other):
273
"""Bind the local branch the other branch.
275
:param other: The branch to bind to
278
raise errors.UpgradeRequired(self.base)
281
def fetch(self, from_branch, last_revision=None, pb=None):
282
"""Copy revisions from from_branch into this branch.
284
:param from_branch: Where to copy from.
285
:param last_revision: What revision to stop at (None for at the end
287
:param pb: An optional progress bar to use.
289
Returns the copied revision count and the failed revisions in a tuple:
292
if self.base == from_branch.base:
295
nested_pb = ui.ui_factory.nested_progress_bar()
300
from_branch.lock_read()
302
if last_revision is None:
303
pb.update('get source history')
304
last_revision = from_branch.last_revision()
305
if last_revision is None:
306
last_revision = _mod_revision.NULL_REVISION
307
return self.repository.fetch(from_branch.repository,
308
revision_id=last_revision,
311
if nested_pb is not None:
315
def get_bound_location(self):
316
"""Return the URL of the branch we are bound to.
318
Older format branches cannot bind, please be sure to use a metadir
323
def get_old_bound_location(self):
324
"""Return the URL of the branch we used to be bound to
326
raise errors.UpgradeRequired(self.base)
328
def get_commit_builder(self, parents, config=None, timestamp=None,
329
timezone=None, committer=None, revprops=None,
331
"""Obtain a CommitBuilder for this branch.
333
:param parents: Revision ids of the parents of the new revision.
334
:param config: Optional configuration to use.
335
:param timestamp: Optional timestamp recorded for commit.
336
:param timezone: Optional timezone for timestamp.
337
:param committer: Optional committer to set for commit.
338
:param revprops: Optional dictionary of revision properties.
339
:param revision_id: Optional revision id.
343
config = self.get_config()
345
return self.repository.get_commit_builder(self, parents, config,
346
timestamp, timezone, committer, revprops, revision_id)
348
def get_master_branch(self):
349
"""Return the branch we are bound to.
351
:return: Either a Branch, or None
355
def get_revision_delta(self, revno):
356
"""Return the delta for one revision.
358
The delta is relative to its mainline predecessor, or the
359
empty tree for revision 1.
361
assert isinstance(revno, int)
362
rh = self.revision_history()
363
if not (1 <= revno <= len(rh)):
364
raise InvalidRevisionNumber(revno)
365
return self.repository.get_revision_delta(rh[revno-1])
367
@deprecated_method(zero_sixteen)
368
def get_root_id(self):
369
"""Return the id of this branches root
371
Deprecated: branches don't have root ids-- trees do.
372
Use basis_tree().get_root_id() instead.
374
raise NotImplementedError(self.get_root_id)
376
def print_file(self, file, revision_id):
377
"""Print `file` to stdout."""
378
raise NotImplementedError(self.print_file)
380
def set_revision_history(self, rev_history):
381
raise NotImplementedError(self.set_revision_history)
383
def _cache_revision_history(self, rev_history):
384
"""Set the cached revision history to rev_history.
386
The revision_history method will use this cache to avoid regenerating
387
the revision history.
389
This API is semi-public; it only for use by subclasses, all other code
390
should consider it to be private.
392
self._revision_history_cache = rev_history
394
def _cache_revision_id_to_revno(self, revision_id_to_revno):
395
"""Set the cached revision_id => revno map to revision_id_to_revno.
397
This API is semi-public; it only for use by subclasses, all other code
398
should consider it to be private.
400
self._revision_id_to_revno_cache = revision_id_to_revno
402
def _clear_cached_state(self):
403
"""Clear any cached data on this branch, e.g. cached revision history.
405
This means the next call to revision_history will need to call
406
_gen_revision_history.
408
This API is semi-public; it only for use by subclasses, all other code
409
should consider it to be private.
411
self._revision_history_cache = None
412
self._revision_id_to_revno_cache = None
414
def _gen_revision_history(self):
415
"""Return sequence of revision hashes on to this branch.
417
Unlike revision_history, this method always regenerates or rereads the
418
revision history, i.e. it does not cache the result, so repeated calls
421
Concrete subclasses should override this instead of revision_history so
422
that subclasses do not need to deal with caching logic.
424
This API is semi-public; it only for use by subclasses, all other code
425
should consider it to be private.
427
raise NotImplementedError(self._gen_revision_history)
430
def revision_history(self):
431
"""Return sequence of revision hashes on to this branch.
433
This method will cache the revision history for as long as it is safe to
436
if self._revision_history_cache is not None:
437
history = self._revision_history_cache
439
history = self._gen_revision_history()
440
self._cache_revision_history(history)
444
"""Return current revision number for this branch.
446
That is equivalent to the number of revisions committed to
449
return len(self.revision_history())
452
"""Older format branches cannot bind or unbind."""
453
raise errors.UpgradeRequired(self.base)
455
def set_append_revisions_only(self, enabled):
456
"""Older format branches are never restricted to append-only"""
457
raise errors.UpgradeRequired(self.base)
459
def last_revision(self):
460
"""Return last revision id, or None"""
461
ph = self.revision_history()
467
def last_revision_info(self):
468
"""Return information about the last revision.
470
:return: A tuple (revno, last_revision_id).
472
rh = self.revision_history()
475
return (revno, rh[-1])
477
return (0, _mod_revision.NULL_REVISION)
479
def missing_revisions(self, other, stop_revision=None):
480
"""Return a list of new revisions that would perfectly fit.
482
If self and other have not diverged, return a list of the revisions
483
present in other, but missing from self.
485
self_history = self.revision_history()
486
self_len = len(self_history)
487
other_history = other.revision_history()
488
other_len = len(other_history)
489
common_index = min(self_len, other_len) -1
490
if common_index >= 0 and \
491
self_history[common_index] != other_history[common_index]:
492
raise DivergedBranches(self, other)
494
if stop_revision is None:
495
stop_revision = other_len
497
assert isinstance(stop_revision, int)
498
if stop_revision > other_len:
499
raise errors.NoSuchRevision(self, stop_revision)
500
return other_history[self_len:stop_revision]
502
def update_revisions(self, other, stop_revision=None):
503
"""Pull in new perfect-fit revisions.
505
:param other: Another Branch to pull from
506
:param stop_revision: Updated until the given revision
509
raise NotImplementedError(self.update_revisions)
511
def revision_id_to_revno(self, revision_id):
512
"""Given a revision id, return its revno"""
513
if _mod_revision.is_null(revision_id):
515
revision_id = osutils.safe_revision_id(revision_id)
516
history = self.revision_history()
518
return history.index(revision_id) + 1
520
raise errors.NoSuchRevision(self, revision_id)
522
def get_rev_id(self, revno, history=None):
523
"""Find the revision id of the specified revno."""
527
history = self.revision_history()
528
if revno <= 0 or revno > len(history):
529
raise errors.NoSuchRevision(self, revno)
530
return history[revno - 1]
532
def pull(self, source, overwrite=False, stop_revision=None):
533
"""Mirror source into this branch.
535
This branch is considered to be 'local', having low latency.
537
:returns: PullResult instance
539
raise NotImplementedError(self.pull)
541
def push(self, target, overwrite=False, stop_revision=None):
542
"""Mirror this branch into target.
544
This branch is considered to be 'local', having low latency.
546
raise NotImplementedError(self.push)
548
def basis_tree(self):
549
"""Return `Tree` object for last revision."""
550
return self.repository.revision_tree(self.last_revision())
552
def rename_one(self, from_rel, to_rel):
555
This can change the directory or the filename or both.
557
raise NotImplementedError(self.rename_one)
559
def move(self, from_paths, to_name):
562
to_name must exist as a versioned directory.
564
If to_name exists and is a directory, the files are moved into
565
it, keeping their old names. If it is a directory,
567
Note that to_name is only the last component of the new name;
568
this doesn't change the directory.
570
This returns a list of (from_path, to_path) pairs for each
573
raise NotImplementedError(self.move)
575
def get_parent(self):
576
"""Return the parent location of the branch.
578
This is the default location for push/pull/missing. The usual
579
pattern is that the user can override it by specifying a
582
raise NotImplementedError(self.get_parent)
584
def _set_config_location(self, name, url, config=None,
585
make_relative=False):
587
config = self.get_config()
591
url = urlutils.relative_url(self.base, url)
592
config.set_user_option(name, url, warn_masked=True)
594
def _get_config_location(self, name, config=None):
596
config = self.get_config()
597
location = config.get_user_option(name)
602
def get_submit_branch(self):
603
"""Return the submit location of the branch.
605
This is the default location for bundle. The usual
606
pattern is that the user can override it by specifying a
609
return self.get_config().get_user_option('submit_branch')
611
def set_submit_branch(self, location):
612
"""Return the submit location of the branch.
614
This is the default location for bundle. The usual
615
pattern is that the user can override it by specifying a
618
self.get_config().set_user_option('submit_branch', location,
621
def get_public_branch(self):
622
"""Return the public location of the branch.
624
This is is used by merge directives.
626
return self._get_config_location('public_branch')
628
def set_public_branch(self, location):
629
"""Return the submit location of the branch.
631
This is the default location for bundle. The usual
632
pattern is that the user can override it by specifying a
635
self._set_config_location('public_branch', location)
637
def get_push_location(self):
638
"""Return the None or the location to push this branch to."""
639
push_loc = self.get_config().get_user_option('push_location')
642
def set_push_location(self, location):
643
"""Set a new push location for this branch."""
644
raise NotImplementedError(self.set_push_location)
646
def set_parent(self, url):
647
raise NotImplementedError(self.set_parent)
651
"""Synchronise this branch with the master branch if any.
653
:return: None or the last_revision pivoted out during the update.
657
def check_revno(self, revno):
659
Check whether a revno corresponds to any revision.
660
Zero (the NULL revision) is considered valid.
663
self.check_real_revno(revno)
665
def check_real_revno(self, revno):
667
Check whether a revno corresponds to a real revision.
668
Zero (the NULL revision) is considered invalid
670
if revno < 1 or revno > self.revno():
671
raise InvalidRevisionNumber(revno)
674
def clone(self, to_bzrdir, revision_id=None):
675
"""Clone this branch into to_bzrdir preserving all semantic values.
677
revision_id: if not None, the revision history in the new branch will
678
be truncated to end with revision_id.
680
result = self._format.initialize(to_bzrdir)
681
self.copy_content_into(result, revision_id=revision_id)
685
def sprout(self, to_bzrdir, revision_id=None):
686
"""Create a new line of development from the branch, into to_bzrdir.
688
revision_id: if not None, the revision history in the new branch will
689
be truncated to end with revision_id.
691
result = self._format.initialize(to_bzrdir)
692
self.copy_content_into(result, revision_id=revision_id)
693
result.set_parent(self.bzrdir.root_transport.base)
696
def _synchronize_history(self, destination, revision_id):
697
"""Synchronize last revision and revision history between branches.
699
This version is most efficient when the destination is also a
700
BzrBranch5, but works for BzrBranch6 as long as the revision
701
history is the true lefthand parent history, and all of the revisions
702
are in the destination's repository. If not, set_revision_history
705
:param destination: The branch to copy the history into
706
:param revision_id: The revision-id to truncate history at. May
707
be None to copy complete history.
709
if revision_id == _mod_revision.NULL_REVISION:
711
new_history = self.revision_history()
712
if revision_id is not None and new_history != []:
713
revision_id = osutils.safe_revision_id(revision_id)
715
new_history = new_history[:new_history.index(revision_id) + 1]
717
rev = self.repository.get_revision(revision_id)
718
new_history = rev.get_history(self.repository)[1:]
719
destination.set_revision_history(new_history)
722
def copy_content_into(self, destination, revision_id=None):
723
"""Copy the content of self into destination.
725
revision_id: if not None, the revision history in the new branch will
726
be truncated to end with revision_id.
728
self._synchronize_history(destination, revision_id)
730
parent = self.get_parent()
731
except errors.InaccessibleParent, e:
732
mutter('parent was not accessible to copy: %s', e)
735
destination.set_parent(parent)
736
self.tags.merge_to(destination.tags)
740
"""Check consistency of the branch.
742
In particular this checks that revisions given in the revision-history
743
do actually match up in the revision graph, and that they're all
744
present in the repository.
746
Callers will typically also want to check the repository.
748
:return: A BranchCheckResult.
750
mainline_parent_id = None
751
for revision_id in self.revision_history():
753
revision = self.repository.get_revision(revision_id)
754
except errors.NoSuchRevision, e:
755
raise errors.BzrCheckError("mainline revision {%s} not in repository"
757
# In general the first entry on the revision history has no parents.
758
# But it's not illegal for it to have parents listed; this can happen
759
# in imports from Arch when the parents weren't reachable.
760
if mainline_parent_id is not None:
761
if mainline_parent_id not in revision.parent_ids:
762
raise errors.BzrCheckError("previous revision {%s} not listed among "
764
% (mainline_parent_id, revision_id))
765
mainline_parent_id = revision_id
766
return BranchCheckResult(self)
768
def _get_checkout_format(self):
769
"""Return the most suitable metadir for a checkout of this branch.
770
Weaves are used if this branch's repository uses weaves.
772
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
773
from bzrlib.repofmt import weaverepo
774
format = bzrdir.BzrDirMetaFormat1()
775
format.repository_format = weaverepo.RepositoryFormat7()
777
format = self.repository.bzrdir.checkout_metadir()
778
format.set_branch_format(self._format)
781
def create_checkout(self, to_location, revision_id=None,
783
"""Create a checkout of a branch.
785
:param to_location: The url to produce the checkout at
786
:param revision_id: The revision to check out
787
:param lightweight: If True, produce a lightweight checkout, otherwise,
788
produce a bound branch (heavyweight checkout)
789
:return: The tree of the created checkout
791
t = transport.get_transport(to_location)
794
format = self._get_checkout_format()
795
checkout = format.initialize_on_transport(t)
796
BranchReferenceFormat().initialize(checkout, self)
798
format = self._get_checkout_format()
799
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
800
to_location, force_new_tree=False, format=format)
801
checkout = checkout_branch.bzrdir
802
checkout_branch.bind(self)
803
# pull up to the specified revision_id to set the initial
804
# branch tip correctly, and seed it with history.
805
checkout_branch.pull(self, stop_revision=revision_id)
806
tree = checkout.create_workingtree(revision_id)
807
basis_tree = tree.basis_tree()
808
basis_tree.lock_read()
810
for path, file_id in basis_tree.iter_references():
811
reference_parent = self.reference_parent(file_id, path)
812
reference_parent.create_checkout(tree.abspath(path),
813
basis_tree.get_reference_revision(file_id, path),
819
def reference_parent(self, file_id, path):
820
"""Return the parent branch for a tree-reference file_id
821
:param file_id: The file_id of the tree reference
822
:param path: The path of the file_id in the tree
823
:return: A branch associated with the file_id
825
# FIXME should provide multiple branches, based on config
826
return Branch.open(self.bzrdir.root_transport.clone(path).base)
828
def supports_tags(self):
829
return self._format.supports_tags()
832
class BranchFormat(object):
833
"""An encapsulation of the initialization and open routines for a format.
835
Formats provide three things:
836
* An initialization routine,
840
Formats are placed in an dict by their format string for reference
841
during branch opening. Its not required that these be instances, they
842
can be classes themselves with class methods - it simply depends on
843
whether state is needed for a given format or not.
845
Once a format is deprecated, just deprecate the initialize and open
846
methods on the format class. Do not deprecate the object, as the
847
object will be created every time regardless.
850
_default_format = None
851
"""The default format used for new branches."""
854
"""The known formats."""
856
def __eq__(self, other):
857
return self.__class__ is other.__class__
859
def __ne__(self, other):
860
return not (self == other)
863
def find_format(klass, a_bzrdir):
864
"""Return the format for the branch object in a_bzrdir."""
866
transport = a_bzrdir.get_branch_transport(None)
867
format_string = transport.get("format").read()
868
return klass._formats[format_string]
870
raise NotBranchError(path=transport.base)
872
raise errors.UnknownFormatError(format=format_string)
875
def get_default_format(klass):
876
"""Return the current default format."""
877
return klass._default_format
879
def get_reference(self, a_bzrdir):
880
"""Get the target reference of the branch in a_bzrdir.
882
format probing must have been completed before calling
883
this method - it is assumed that the format of the branch
884
in a_bzrdir is correct.
886
:param a_bzrdir: The bzrdir to get the branch data from.
887
:return: None if the branch is not a reference branch.
891
def get_format_string(self):
892
"""Return the ASCII format string that identifies this format."""
893
raise NotImplementedError(self.get_format_string)
895
def get_format_description(self):
896
"""Return the short format description for this format."""
897
raise NotImplementedError(self.get_format_description)
899
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
901
"""Initialize a branch in a bzrdir, with specified files
903
:param a_bzrdir: The bzrdir to initialize the branch in
904
:param utf8_files: The files to create as a list of
905
(filename, content) tuples
906
:param set_format: If True, set the format with
907
self.get_format_string. (BzrBranch4 has its format set
909
:return: a branch in this format
911
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
912
branch_transport = a_bzrdir.get_branch_transport(self)
914
'metadir': ('lock', lockdir.LockDir),
915
'branch4': ('branch-lock', lockable_files.TransportLock),
917
lock_name, lock_class = lock_map[lock_type]
918
control_files = lockable_files.LockableFiles(branch_transport,
919
lock_name, lock_class)
920
control_files.create_lock()
921
control_files.lock_write()
923
control_files.put_utf8('format', self.get_format_string())
925
for file, content in utf8_files:
926
control_files.put_utf8(file, content)
928
control_files.unlock()
929
return self.open(a_bzrdir, _found=True)
931
def initialize(self, a_bzrdir):
932
"""Create a branch of this format in a_bzrdir."""
933
raise NotImplementedError(self.initialize)
935
def is_supported(self):
936
"""Is this format supported?
938
Supported formats can be initialized and opened.
939
Unsupported formats may not support initialization or committing or
940
some other features depending on the reason for not being supported.
944
def open(self, a_bzrdir, _found=False):
945
"""Return the branch object for a_bzrdir
947
_found is a private parameter, do not use it. It is used to indicate
948
if format probing has already be done.
950
raise NotImplementedError(self.open)
953
def register_format(klass, format):
954
klass._formats[format.get_format_string()] = format
957
def set_default_format(klass, format):
958
klass._default_format = format
961
def unregister_format(klass, format):
962
assert klass._formats[format.get_format_string()] is format
963
del klass._formats[format.get_format_string()]
966
return self.get_format_string().rstrip()
968
def supports_tags(self):
969
"""True if this format supports tags stored in the branch"""
970
return False # by default
972
# XXX: Probably doesn't really belong here -- mbp 20070212
973
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
975
branch_transport = a_bzrdir.get_branch_transport(self)
976
control_files = lockable_files.LockableFiles(branch_transport,
977
lock_filename, lock_class)
978
control_files.create_lock()
979
control_files.lock_write()
981
for filename, content in utf8_files:
982
control_files.put_utf8(filename, content)
984
control_files.unlock()
987
class BranchHooks(Hooks):
988
"""A dictionary mapping hook name to a list of callables for branch hooks.
990
e.g. ['set_rh'] Is the list of items to be called when the
991
set_revision_history function is invoked.
995
"""Create the default hooks.
997
These are all empty initially, because by default nothing should get
1000
Hooks.__init__(self)
1001
# Introduced in 0.15:
1002
# invoked whenever the revision history has been set
1003
# with set_revision_history. The api signature is
1004
# (branch, revision_history), and the branch will
1007
# invoked after a push operation completes.
1008
# the api signature is
1010
# containing the members
1011
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1012
# where local is the local target branch or None, master is the target
1013
# master branch, and the rest should be self explanatory. The source
1014
# is read locked and the target branches write locked. Source will
1015
# be the local low-latency branch.
1016
self['post_push'] = []
1017
# invoked after a pull operation completes.
1018
# the api signature is
1020
# containing the members
1021
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1022
# where local is the local branch or None, master is the target
1023
# master branch, and the rest should be self explanatory. The source
1024
# is read locked and the target branches write locked. The local
1025
# branch is the low-latency branch.
1026
self['post_pull'] = []
1027
# invoked after a commit operation completes.
1028
# the api signature is
1029
# (local, master, old_revno, old_revid, new_revno, new_revid)
1030
# old_revid is NULL_REVISION for the first commit to a branch.
1031
self['post_commit'] = []
1032
# invoked after a uncommit operation completes.
1033
# the api signature is
1034
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1035
# local is the local branch or None, master is the target branch,
1036
# and an empty branch recieves new_revno of 0, new_revid of None.
1037
self['post_uncommit'] = []
1040
# install the default hooks into the Branch class.
1041
Branch.hooks = BranchHooks()
1044
class BzrBranchFormat4(BranchFormat):
1045
"""Bzr branch format 4.
1048
- a revision-history file.
1049
- a branch-lock lock file [ to be shared with the bzrdir ]
1052
def get_format_description(self):
1053
"""See BranchFormat.get_format_description()."""
1054
return "Branch format 4"
1056
def initialize(self, a_bzrdir):
1057
"""Create a branch of this format in a_bzrdir."""
1058
utf8_files = [('revision-history', ''),
1059
('branch-name', ''),
1061
return self._initialize_helper(a_bzrdir, utf8_files,
1062
lock_type='branch4', set_format=False)
1065
super(BzrBranchFormat4, self).__init__()
1066
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1068
def open(self, a_bzrdir, _found=False):
1069
"""Return the branch object for a_bzrdir
1071
_found is a private parameter, do not use it. It is used to indicate
1072
if format probing has already be done.
1075
# we are being called directly and must probe.
1076
raise NotImplementedError
1077
return BzrBranch(_format=self,
1078
_control_files=a_bzrdir._control_files,
1080
_repository=a_bzrdir.open_repository())
1083
return "Bazaar-NG branch format 4"
1086
class BzrBranchFormat5(BranchFormat):
1087
"""Bzr branch format 5.
1090
- a revision-history file.
1092
- a lock dir guarding the branch itself
1093
- all of this stored in a branch/ subdirectory
1094
- works with shared repositories.
1096
This format is new in bzr 0.8.
1099
def get_format_string(self):
1100
"""See BranchFormat.get_format_string()."""
1101
return "Bazaar-NG branch format 5\n"
1103
def get_format_description(self):
1104
"""See BranchFormat.get_format_description()."""
1105
return "Branch format 5"
1107
def initialize(self, a_bzrdir):
1108
"""Create a branch of this format in a_bzrdir."""
1109
utf8_files = [('revision-history', ''),
1110
('branch-name', ''),
1112
return self._initialize_helper(a_bzrdir, utf8_files)
1115
super(BzrBranchFormat5, self).__init__()
1116
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1118
def open(self, a_bzrdir, _found=False):
1119
"""Return the branch object for a_bzrdir
1121
_found is a private parameter, do not use it. It is used to indicate
1122
if format probing has already be done.
1125
format = BranchFormat.find_format(a_bzrdir)
1126
assert format.__class__ == self.__class__
1128
transport = a_bzrdir.get_branch_transport(None)
1129
control_files = lockable_files.LockableFiles(transport, 'lock',
1131
return BzrBranch5(_format=self,
1132
_control_files=control_files,
1134
_repository=a_bzrdir.find_repository())
1136
raise NotBranchError(path=transport.base)
1139
class BzrBranchFormat6(BzrBranchFormat5):
1140
"""Branch format with last-revision
1142
Unlike previous formats, this has no explicit revision history. Instead,
1143
this just stores the last-revision, and the left-hand history leading
1144
up to there is the history.
1146
This format was introduced in bzr 0.15
1149
def get_format_string(self):
1150
"""See BranchFormat.get_format_string()."""
1151
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1153
def get_format_description(self):
1154
"""See BranchFormat.get_format_description()."""
1155
return "Branch format 6"
1157
def initialize(self, a_bzrdir):
1158
"""Create a branch of this format in a_bzrdir."""
1159
utf8_files = [('last-revision', '0 null:\n'),
1160
('branch-name', ''),
1161
('branch.conf', ''),
1164
return self._initialize_helper(a_bzrdir, utf8_files)
1166
def open(self, a_bzrdir, _found=False):
1167
"""Return the branch object for a_bzrdir
1169
_found is a private parameter, do not use it. It is used to indicate
1170
if format probing has already be done.
1173
format = BranchFormat.find_format(a_bzrdir)
1174
assert format.__class__ == self.__class__
1175
transport = a_bzrdir.get_branch_transport(None)
1176
control_files = lockable_files.LockableFiles(transport, 'lock',
1178
return BzrBranch6(_format=self,
1179
_control_files=control_files,
1181
_repository=a_bzrdir.find_repository())
1183
def supports_tags(self):
1187
class BranchReferenceFormat(BranchFormat):
1188
"""Bzr branch reference format.
1190
Branch references are used in implementing checkouts, they
1191
act as an alias to the real branch which is at some other url.
1198
def get_format_string(self):
1199
"""See BranchFormat.get_format_string()."""
1200
return "Bazaar-NG Branch Reference Format 1\n"
1202
def get_format_description(self):
1203
"""See BranchFormat.get_format_description()."""
1204
return "Checkout reference format 1"
1206
def get_reference(self, a_bzrdir):
1207
"""See BranchFormat.get_reference()."""
1208
transport = a_bzrdir.get_branch_transport(None)
1209
return transport.get('location').read()
1211
def initialize(self, a_bzrdir, target_branch=None):
1212
"""Create a branch of this format in a_bzrdir."""
1213
if target_branch is None:
1214
# this format does not implement branch itself, thus the implicit
1215
# creation contract must see it as uninitializable
1216
raise errors.UninitializableFormat(self)
1217
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1218
branch_transport = a_bzrdir.get_branch_transport(self)
1219
branch_transport.put_bytes('location',
1220
target_branch.bzrdir.root_transport.base)
1221
branch_transport.put_bytes('format', self.get_format_string())
1222
return self.open(a_bzrdir, _found=True)
1225
super(BranchReferenceFormat, self).__init__()
1226
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1228
def _make_reference_clone_function(format, a_branch):
1229
"""Create a clone() routine for a branch dynamically."""
1230
def clone(to_bzrdir, revision_id=None):
1231
"""See Branch.clone()."""
1232
return format.initialize(to_bzrdir, a_branch)
1233
# cannot obey revision_id limits when cloning a reference ...
1234
# FIXME RBC 20060210 either nuke revision_id for clone, or
1235
# emit some sort of warning/error to the caller ?!
1238
def open(self, a_bzrdir, _found=False, location=None):
1239
"""Return the branch that the branch reference in a_bzrdir points at.
1241
_found is a private parameter, do not use it. It is used to indicate
1242
if format probing has already be done.
1245
format = BranchFormat.find_format(a_bzrdir)
1246
assert format.__class__ == self.__class__
1247
if location is None:
1248
location = self.get_reference(a_bzrdir)
1249
real_bzrdir = bzrdir.BzrDir.open(location)
1250
result = real_bzrdir.open_branch()
1251
# this changes the behaviour of result.clone to create a new reference
1252
# rather than a copy of the content of the branch.
1253
# I did not use a proxy object because that needs much more extensive
1254
# testing, and we are only changing one behaviour at the moment.
1255
# If we decide to alter more behaviours - i.e. the implicit nickname
1256
# then this should be refactored to introduce a tested proxy branch
1257
# and a subclass of that for use in overriding clone() and ....
1259
result.clone = self._make_reference_clone_function(result)
1263
# formats which have no format string are not discoverable
1264
# and not independently creatable, so are not registered.
1265
__default_format = BzrBranchFormat5()
1266
BranchFormat.register_format(__default_format)
1267
BranchFormat.register_format(BranchReferenceFormat())
1268
BranchFormat.register_format(BzrBranchFormat6())
1269
BranchFormat.set_default_format(__default_format)
1270
_legacy_formats = [BzrBranchFormat4(),
1273
class BzrBranch(Branch):
1274
"""A branch stored in the actual filesystem.
1276
Note that it's "local" in the context of the filesystem; it doesn't
1277
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1278
it's writable, and can be accessed via the normal filesystem API.
1281
def __init__(self, _format=None,
1282
_control_files=None, a_bzrdir=None, _repository=None):
1283
"""Create new branch object at a particular location."""
1284
Branch.__init__(self)
1285
if a_bzrdir is None:
1286
raise ValueError('a_bzrdir must be supplied')
1288
self.bzrdir = a_bzrdir
1289
# self._transport used to point to the directory containing the
1290
# control directory, but was not used - now it's just the transport
1291
# for the branch control files. mbp 20070212
1292
self._base = self.bzrdir.transport.clone('..').base
1293
self._format = _format
1294
if _control_files is None:
1295
raise ValueError('BzrBranch _control_files is None')
1296
self.control_files = _control_files
1297
self._transport = _control_files._transport
1298
self.repository = _repository
1301
return '%s(%r)' % (self.__class__.__name__, self.base)
1305
def _get_base(self):
1306
"""Returns the directory containing the control directory."""
1309
base = property(_get_base, doc="The URL for the root of this branch.")
1311
def abspath(self, name):
1312
"""See Branch.abspath."""
1313
return self.control_files._transport.abspath(name)
1316
@deprecated_method(zero_sixteen)
1318
def get_root_id(self):
1319
"""See Branch.get_root_id."""
1320
tree = self.repository.revision_tree(self.last_revision())
1321
return tree.inventory.root.file_id
1323
def is_locked(self):
1324
return self.control_files.is_locked()
1326
def lock_write(self, token=None):
1327
repo_token = self.repository.lock_write()
1329
token = self.control_files.lock_write(token=token)
1331
self.repository.unlock()
1335
def lock_read(self):
1336
self.repository.lock_read()
1338
self.control_files.lock_read()
1340
self.repository.unlock()
1344
# TODO: test for failed two phase locks. This is known broken.
1346
self.control_files.unlock()
1348
self.repository.unlock()
1349
if not self.control_files.is_locked():
1350
# we just released the lock
1351
self._clear_cached_state()
1353
def peek_lock_mode(self):
1354
if self.control_files._lock_count == 0:
1357
return self.control_files._lock_mode
1359
def get_physical_lock_status(self):
1360
return self.control_files.get_physical_lock_status()
1363
def print_file(self, file, revision_id):
1364
"""See Branch.print_file."""
1365
return self.repository.print_file(file, revision_id)
1367
def _write_revision_history(self, history):
1368
"""Factored out of set_revision_history.
1370
This performs the actual writing to disk.
1371
It is intended to be called by BzrBranch5.set_revision_history."""
1372
self.control_files.put_bytes(
1373
'revision-history', '\n'.join(history))
1376
def set_revision_history(self, rev_history):
1377
"""See Branch.set_revision_history."""
1378
rev_history = [osutils.safe_revision_id(r) for r in rev_history]
1379
self._clear_cached_state()
1380
self._write_revision_history(rev_history)
1381
self._cache_revision_history(rev_history)
1382
for hook in Branch.hooks['set_rh']:
1383
hook(self, rev_history)
1386
def set_last_revision_info(self, revno, revision_id):
1387
"""Set the last revision of this branch.
1389
The caller is responsible for checking that the revno is correct
1390
for this revision id.
1392
It may be possible to set the branch last revision to an id not
1393
present in the repository. However, branches can also be
1394
configured to check constraints on history, in which case this may not
1397
revision_id = osutils.safe_revision_id(revision_id)
1398
history = self._lefthand_history(revision_id)
1399
assert len(history) == revno, '%d != %d' % (len(history), revno)
1400
self.set_revision_history(history)
1402
def _gen_revision_history(self):
1403
history = self.control_files.get('revision-history').read().split('\n')
1404
if history[-1:] == ['']:
1405
# There shouldn't be a trailing newline, but just in case.
1409
def _lefthand_history(self, revision_id, last_rev=None,
1411
# stop_revision must be a descendant of last_revision
1412
stop_graph = self.repository.get_revision_graph(revision_id)
1413
if (last_rev is not None and last_rev != _mod_revision.NULL_REVISION
1414
and last_rev not in stop_graph):
1415
# our previous tip is not merged into stop_revision
1416
raise errors.DivergedBranches(self, other_branch)
1417
# make a new revision history from the graph
1418
current_rev_id = revision_id
1420
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1421
new_history.append(current_rev_id)
1422
current_rev_id_parents = stop_graph[current_rev_id]
1424
current_rev_id = current_rev_id_parents[0]
1426
current_rev_id = None
1427
new_history.reverse()
1431
def generate_revision_history(self, revision_id, last_rev=None,
1433
"""Create a new revision history that will finish with revision_id.
1435
:param revision_id: the new tip to use.
1436
:param last_rev: The previous last_revision. If not None, then this
1437
must be a ancestory of revision_id, or DivergedBranches is raised.
1438
:param other_branch: The other branch that DivergedBranches should
1439
raise with respect to.
1441
revision_id = osutils.safe_revision_id(revision_id)
1442
self.set_revision_history(self._lefthand_history(revision_id,
1443
last_rev, other_branch))
1446
def update_revisions(self, other, stop_revision=None):
1447
"""See Branch.update_revisions."""
1450
if stop_revision is None:
1451
stop_revision = other.last_revision()
1452
if stop_revision is None:
1453
# if there are no commits, we're done.
1456
stop_revision = osutils.safe_revision_id(stop_revision)
1457
# whats the current last revision, before we fetch [and change it
1459
last_rev = _mod_revision.ensure_null(self.last_revision())
1460
# we fetch here regardless of whether we need to so that we pickup
1462
self.fetch(other, stop_revision)
1463
if self.repository.get_graph().is_ancestor(stop_revision,
1466
self.generate_revision_history(stop_revision, last_rev=last_rev,
1471
def basis_tree(self):
1472
"""See Branch.basis_tree."""
1473
return self.repository.revision_tree(self.last_revision())
1475
@deprecated_method(zero_eight)
1476
def working_tree(self):
1477
"""Create a Working tree object for this branch."""
1479
from bzrlib.transport.local import LocalTransport
1480
if (self.base.find('://') != -1 or
1481
not isinstance(self._transport, LocalTransport)):
1482
raise NoWorkingTree(self.base)
1483
return self.bzrdir.open_workingtree()
1486
def pull(self, source, overwrite=False, stop_revision=None,
1487
_hook_master=None, run_hooks=True):
1490
:param _hook_master: Private parameter - set the branch to
1491
be supplied as the master to push hooks.
1492
:param run_hooks: Private parameter - if false, this branch
1493
is being called because it's the master of the primary branch,
1494
so it should not run its hooks.
1496
result = PullResult()
1497
result.source_branch = source
1498
result.target_branch = self
1501
result.old_revno, result.old_revid = self.last_revision_info()
1503
self.update_revisions(source, stop_revision)
1504
except DivergedBranches:
1508
if stop_revision is None:
1509
stop_revision = source.last_revision()
1510
self.generate_revision_history(stop_revision)
1511
result.tag_conflicts = source.tags.merge_to(self.tags)
1512
result.new_revno, result.new_revid = self.last_revision_info()
1514
result.master_branch = _hook_master
1515
result.local_branch = self
1517
result.master_branch = self
1518
result.local_branch = None
1520
for hook in Branch.hooks['post_pull']:
1526
def _get_parent_location(self):
1527
_locs = ['parent', 'pull', 'x-pull']
1530
return self.control_files.get(l).read().strip('\n')
1536
def push(self, target, overwrite=False, stop_revision=None,
1537
_override_hook_source_branch=None):
1540
This is the basic concrete implementation of push()
1542
:param _override_hook_source_branch: If specified, run
1543
the hooks passing this Branch as the source, rather than self.
1544
This is for use of RemoteBranch, where push is delegated to the
1545
underlying vfs-based Branch.
1547
# TODO: Public option to disable running hooks - should be trivial but
1551
result = self._push_with_bound_branches(target, overwrite,
1553
_override_hook_source_branch=_override_hook_source_branch)
1558
def _push_with_bound_branches(self, target, overwrite,
1560
_override_hook_source_branch=None):
1561
"""Push from self into target, and into target's master if any.
1563
This is on the base BzrBranch class even though it doesn't support
1564
bound branches because the *target* might be bound.
1567
if _override_hook_source_branch:
1568
result.source_branch = _override_hook_source_branch
1569
for hook in Branch.hooks['post_push']:
1572
bound_location = target.get_bound_location()
1573
if bound_location and target.base != bound_location:
1574
# there is a master branch.
1576
# XXX: Why the second check? Is it even supported for a branch to
1577
# be bound to itself? -- mbp 20070507
1578
master_branch = target.get_master_branch()
1579
master_branch.lock_write()
1581
# push into the master from this branch.
1582
self._basic_push(master_branch, overwrite, stop_revision)
1583
# and push into the target branch from this. Note that we push from
1584
# this branch again, because its considered the highest bandwidth
1586
result = self._basic_push(target, overwrite, stop_revision)
1587
result.master_branch = master_branch
1588
result.local_branch = target
1592
master_branch.unlock()
1595
result = self._basic_push(target, overwrite, stop_revision)
1596
# TODO: Why set master_branch and local_branch if there's no
1597
# binding? Maybe cleaner to just leave them unset? -- mbp
1599
result.master_branch = target
1600
result.local_branch = None
1604
def _basic_push(self, target, overwrite, stop_revision):
1605
"""Basic implementation of push without bound branches or hooks.
1607
Must be called with self read locked and target write locked.
1609
result = PushResult()
1610
result.source_branch = self
1611
result.target_branch = target
1612
result.old_revno, result.old_revid = target.last_revision_info()
1614
target.update_revisions(self, stop_revision)
1615
except DivergedBranches:
1619
target.set_revision_history(self.revision_history())
1620
result.tag_conflicts = self.tags.merge_to(target.tags)
1621
result.new_revno, result.new_revid = target.last_revision_info()
1624
def get_parent(self):
1625
"""See Branch.get_parent."""
1627
assert self.base[-1] == '/'
1628
parent = self._get_parent_location()
1631
# This is an old-format absolute path to a local branch
1632
# turn it into a url
1633
if parent.startswith('/'):
1634
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1636
return urlutils.join(self.base[:-1], parent)
1637
except errors.InvalidURLJoin, e:
1638
raise errors.InaccessibleParent(parent, self.base)
1640
def set_push_location(self, location):
1641
"""See Branch.set_push_location."""
1642
self.get_config().set_user_option(
1643
'push_location', location,
1644
store=_mod_config.STORE_LOCATION_NORECURSE)
1647
def set_parent(self, url):
1648
"""See Branch.set_parent."""
1649
# TODO: Maybe delete old location files?
1650
# URLs should never be unicode, even on the local fs,
1651
# FIXUP this and get_parent in a future branch format bump:
1652
# read and rewrite the file, and have the new format code read
1653
# using .get not .get_utf8. RBC 20060125
1655
if isinstance(url, unicode):
1657
url = url.encode('ascii')
1658
except UnicodeEncodeError:
1659
raise errors.InvalidURL(url,
1660
"Urls must be 7-bit ascii, "
1661
"use bzrlib.urlutils.escape")
1662
url = urlutils.relative_url(self.base, url)
1663
self._set_parent_location(url)
1665
def _set_parent_location(self, url):
1667
self.control_files._transport.delete('parent')
1669
assert isinstance(url, str)
1670
self.control_files.put_bytes('parent', url + '\n')
1672
@deprecated_function(zero_nine)
1673
def tree_config(self):
1674
"""DEPRECATED; call get_config instead.
1675
TreeConfig has become part of BranchConfig."""
1676
return TreeConfig(self)
1679
class BzrBranch5(BzrBranch):
1680
"""A format 5 branch. This supports new features over plan branches.
1682
It has support for a master_branch which is the data for bound branches.
1690
super(BzrBranch5, self).__init__(_format=_format,
1691
_control_files=_control_files,
1693
_repository=_repository)
1696
def pull(self, source, overwrite=False, stop_revision=None,
1698
"""Pull from source into self, updating my master if any.
1700
:param run_hooks: Private parameter - if false, this branch
1701
is being called because it's the master of the primary branch,
1702
so it should not run its hooks.
1704
bound_location = self.get_bound_location()
1705
master_branch = None
1706
if bound_location and source.base != bound_location:
1707
# not pulling from master, so we need to update master.
1708
master_branch = self.get_master_branch()
1709
master_branch.lock_write()
1712
# pull from source into master.
1713
master_branch.pull(source, overwrite, stop_revision,
1715
return super(BzrBranch5, self).pull(source, overwrite,
1716
stop_revision, _hook_master=master_branch,
1717
run_hooks=run_hooks)
1720
master_branch.unlock()
1722
def get_bound_location(self):
1724
return self.control_files.get_utf8('bound').read()[:-1]
1725
except errors.NoSuchFile:
1729
def get_master_branch(self):
1730
"""Return the branch we are bound to.
1732
:return: Either a Branch, or None
1734
This could memoise the branch, but if thats done
1735
it must be revalidated on each new lock.
1736
So for now we just don't memoise it.
1737
# RBC 20060304 review this decision.
1739
bound_loc = self.get_bound_location()
1743
return Branch.open(bound_loc)
1744
except (errors.NotBranchError, errors.ConnectionError), e:
1745
raise errors.BoundBranchConnectionFailure(
1749
def set_bound_location(self, location):
1750
"""Set the target where this branch is bound to.
1752
:param location: URL to the target branch
1755
self.control_files.put_utf8('bound', location+'\n')
1758
self.control_files._transport.delete('bound')
1764
def bind(self, other):
1765
"""Bind this branch to the branch other.
1767
This does not push or pull data between the branches, though it does
1768
check for divergence to raise an error when the branches are not
1769
either the same, or one a prefix of the other. That behaviour may not
1770
be useful, so that check may be removed in future.
1772
:param other: The branch to bind to
1775
# TODO: jam 20051230 Consider checking if the target is bound
1776
# It is debatable whether you should be able to bind to
1777
# a branch which is itself bound.
1778
# Committing is obviously forbidden,
1779
# but binding itself may not be.
1780
# Since we *have* to check at commit time, we don't
1781
# *need* to check here
1783
# we want to raise diverged if:
1784
# last_rev is not in the other_last_rev history, AND
1785
# other_last_rev is not in our history, and do it without pulling
1787
last_rev = _mod_revision.ensure_null(self.last_revision())
1788
if last_rev != _mod_revision.NULL_REVISION:
1791
other_last_rev = other.last_revision()
1792
if not _mod_revision.is_null(other_last_rev):
1793
# neither branch is new, we have to do some work to
1794
# ascertain diversion.
1795
remote_graph = other.repository.get_revision_graph(
1797
local_graph = self.repository.get_revision_graph(last_rev)
1798
if (last_rev not in remote_graph and
1799
other_last_rev not in local_graph):
1800
raise errors.DivergedBranches(self, other)
1803
self.set_bound_location(other.base)
1807
"""If bound, unbind"""
1808
return self.set_bound_location(None)
1812
"""Synchronise this branch with the master branch if any.
1814
:return: None or the last_revision that was pivoted out during the
1817
master = self.get_master_branch()
1818
if master is not None:
1819
old_tip = _mod_revision.ensure_null(self.last_revision())
1820
self.pull(master, overwrite=True)
1821
if self.repository.get_graph().is_ancestor(old_tip,
1822
_mod_revision.ensure_null(self.last_revision())):
1828
class BzrBranchExperimental(BzrBranch5):
1829
"""Bzr experimental branch format
1832
- a revision-history file.
1834
- a lock dir guarding the branch itself
1835
- all of this stored in a branch/ subdirectory
1836
- works with shared repositories.
1837
- a tag dictionary in the branch
1839
This format is new in bzr 0.15, but shouldn't be used for real data,
1842
This class acts as it's own BranchFormat.
1845
_matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1848
def get_format_string(cls):
1849
"""See BranchFormat.get_format_string()."""
1850
return "Bazaar-NG branch format experimental\n"
1853
def get_format_description(cls):
1854
"""See BranchFormat.get_format_description()."""
1855
return "Experimental branch format"
1858
def get_reference(cls, a_bzrdir):
1859
"""Get the target reference of the branch in a_bzrdir.
1861
format probing must have been completed before calling
1862
this method - it is assumed that the format of the branch
1863
in a_bzrdir is correct.
1865
:param a_bzrdir: The bzrdir to get the branch data from.
1866
:return: None if the branch is not a reference branch.
1871
def _initialize_control_files(cls, a_bzrdir, utf8_files, lock_filename,
1873
branch_transport = a_bzrdir.get_branch_transport(cls)
1874
control_files = lockable_files.LockableFiles(branch_transport,
1875
lock_filename, lock_class)
1876
control_files.create_lock()
1877
control_files.lock_write()
1879
for filename, content in utf8_files:
1880
control_files.put_utf8(filename, content)
1882
control_files.unlock()
1885
def initialize(cls, a_bzrdir):
1886
"""Create a branch of this format in a_bzrdir."""
1887
utf8_files = [('format', cls.get_format_string()),
1888
('revision-history', ''),
1889
('branch-name', ''),
1892
cls._initialize_control_files(a_bzrdir, utf8_files,
1893
'lock', lockdir.LockDir)
1894
return cls.open(a_bzrdir, _found=True)
1897
def open(cls, a_bzrdir, _found=False):
1898
"""Return the branch object for a_bzrdir
1900
_found is a private parameter, do not use it. It is used to indicate
1901
if format probing has already be done.
1904
format = BranchFormat.find_format(a_bzrdir)
1905
assert format.__class__ == cls
1906
transport = a_bzrdir.get_branch_transport(None)
1907
control_files = lockable_files.LockableFiles(transport, 'lock',
1909
return cls(_format=cls,
1910
_control_files=control_files,
1912
_repository=a_bzrdir.find_repository())
1915
def is_supported(cls):
1918
def _make_tags(self):
1919
return BasicTags(self)
1922
def supports_tags(cls):
1926
BranchFormat.register_format(BzrBranchExperimental)
1929
class BzrBranch6(BzrBranch5):
1932
def last_revision_info(self):
1933
revision_string = self.control_files.get('last-revision').read()
1934
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1935
revision_id = cache_utf8.get_cached_utf8(revision_id)
1937
return revno, revision_id
1939
def last_revision(self):
1940
"""Return last revision id, or None"""
1941
revision_id = self.last_revision_info()[1]
1942
if revision_id == _mod_revision.NULL_REVISION:
1946
def _write_last_revision_info(self, revno, revision_id):
1947
"""Simply write out the revision id, with no checks.
1949
Use set_last_revision_info to perform this safely.
1951
Does not update the revision_history cache.
1952
Intended to be called by set_last_revision_info and
1953
_write_revision_history.
1955
if revision_id is None:
1956
revision_id = 'null:'
1957
out_string = '%d %s\n' % (revno, revision_id)
1958
self.control_files.put_bytes('last-revision', out_string)
1961
def set_last_revision_info(self, revno, revision_id):
1962
revision_id = osutils.safe_revision_id(revision_id)
1963
if self._get_append_revisions_only():
1964
self._check_history_violation(revision_id)
1965
self._write_last_revision_info(revno, revision_id)
1966
self._clear_cached_state()
1968
def _check_history_violation(self, revision_id):
1969
last_revision = _mod_revision.ensure_null(self.last_revision())
1970
if _mod_revision.is_null(last_revision):
1972
if last_revision not in self._lefthand_history(revision_id):
1973
raise errors.AppendRevisionsOnlyViolation(self.base)
1975
def _gen_revision_history(self):
1976
"""Generate the revision history from last revision
1978
history = list(self.repository.iter_reverse_revision_history(
1979
self.last_revision()))
1983
def _write_revision_history(self, history):
1984
"""Factored out of set_revision_history.
1986
This performs the actual writing to disk, with format-specific checks.
1987
It is intended to be called by BzrBranch5.set_revision_history.
1989
if len(history) == 0:
1990
last_revision = 'null:'
1992
if history != self._lefthand_history(history[-1]):
1993
raise errors.NotLefthandHistory(history)
1994
last_revision = history[-1]
1995
if self._get_append_revisions_only():
1996
self._check_history_violation(last_revision)
1997
self._write_last_revision_info(len(history), last_revision)
2000
def _set_parent_location(self, url):
2001
"""Set the parent branch"""
2002
self._set_config_location('parent_location', url, make_relative=True)
2005
def _get_parent_location(self):
2006
"""Set the parent branch"""
2007
return self._get_config_location('parent_location')
2009
def set_push_location(self, location):
2010
"""See Branch.set_push_location."""
2011
self._set_config_location('push_location', location)
2013
def set_bound_location(self, location):
2014
"""See Branch.set_push_location."""
2016
config = self.get_config()
2017
if location is None:
2018
if config.get_user_option('bound') != 'True':
2021
config.set_user_option('bound', 'False', warn_masked=True)
2024
self._set_config_location('bound_location', location,
2026
config.set_user_option('bound', 'True', warn_masked=True)
2029
def _get_bound_location(self, bound):
2030
"""Return the bound location in the config file.
2032
Return None if the bound parameter does not match"""
2033
config = self.get_config()
2034
config_bound = (config.get_user_option('bound') == 'True')
2035
if config_bound != bound:
2037
return self._get_config_location('bound_location', config=config)
2039
def get_bound_location(self):
2040
"""See Branch.set_push_location."""
2041
return self._get_bound_location(True)
2043
def get_old_bound_location(self):
2044
"""See Branch.get_old_bound_location"""
2045
return self._get_bound_location(False)
2047
def set_append_revisions_only(self, enabled):
2052
self.get_config().set_user_option('append_revisions_only', value,
2055
def _get_append_revisions_only(self):
2056
value = self.get_config().get_user_option('append_revisions_only')
2057
return value == 'True'
2059
def _synchronize_history(self, destination, revision_id):
2060
"""Synchronize last revision and revision history between branches.
2062
This version is most efficient when the destination is also a
2063
BzrBranch6, but works for BzrBranch5, as long as the destination's
2064
repository contains all the lefthand ancestors of the intended
2065
last_revision. If not, set_last_revision_info will fail.
2067
:param destination: The branch to copy the history into
2068
:param revision_id: The revision-id to truncate history at. May
2069
be None to copy complete history.
2071
source_revno, source_revision_id = self.last_revision_info()
2072
if revision_id is None:
2073
revno, revision_id = source_revno, source_revision_id
2074
elif source_revision_id == revision_id:
2075
# we know the revno without needing to walk all of history
2076
revno = source_revno
2078
# To figure out the revno for a random revision, we need to build
2079
# the revision history, and count its length.
2080
# We don't care about the order, just how long it is.
2081
# Alternatively, we could start at the current location, and count
2082
# backwards. But there is no guarantee that we will find it since
2083
# it may be a merged revision.
2084
revno = len(list(self.repository.iter_reverse_revision_history(
2086
destination.set_last_revision_info(revno, revision_id)
2088
def _make_tags(self):
2089
return BasicTags(self)
2092
######################################################################
2093
# results of operations
2096
class _Result(object):
2098
def _show_tag_conficts(self, to_file):
2099
if not getattr(self, 'tag_conflicts', None):
2101
to_file.write('Conflicting tags:\n')
2102
for name, value1, value2 in self.tag_conflicts:
2103
to_file.write(' %s\n' % (name, ))
2106
class PullResult(_Result):
2107
"""Result of a Branch.pull operation.
2109
:ivar old_revno: Revision number before pull.
2110
:ivar new_revno: Revision number after pull.
2111
:ivar old_revid: Tip revision id before pull.
2112
:ivar new_revid: Tip revision id after pull.
2113
:ivar source_branch: Source (local) branch object.
2114
:ivar master_branch: Master branch of the target, or None.
2115
:ivar target_branch: Target/destination branch object.
2119
# DEPRECATED: pull used to return the change in revno
2120
return self.new_revno - self.old_revno
2122
def report(self, to_file):
2123
if self.old_revid == self.new_revid:
2124
to_file.write('No revisions to pull.\n')
2126
to_file.write('Now on revision %d.\n' % self.new_revno)
2127
self._show_tag_conficts(to_file)
2130
class PushResult(_Result):
2131
"""Result of a Branch.push operation.
2133
:ivar old_revno: Revision number before push.
2134
:ivar new_revno: Revision number after push.
2135
:ivar old_revid: Tip revision id before push.
2136
:ivar new_revid: Tip revision id after push.
2137
:ivar source_branch: Source branch object.
2138
:ivar master_branch: Master branch of the target, or None.
2139
:ivar target_branch: Target/destination branch object.
2143
# DEPRECATED: push used to return the change in revno
2144
return self.new_revno - self.old_revno
2146
def report(self, to_file):
2147
"""Write a human-readable description of the result."""
2148
if self.old_revid == self.new_revid:
2149
to_file.write('No new revisions to push.\n')
2151
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2152
self._show_tag_conficts(to_file)
2155
class BranchCheckResult(object):
2156
"""Results of checking branch consistency.
2161
def __init__(self, branch):
2162
self.branch = branch
2164
def report_results(self, verbose):
2165
"""Report the check results via trace.note.
2167
:param verbose: Requests more detailed display of what was checked,
2170
note('checked branch %s format %s',
2172
self.branch._format)
2175
class Converter5to6(object):
2176
"""Perform an in-place upgrade of format 5 to format 6"""
2178
def convert(self, branch):
2179
# Data for 5 and 6 can peacefully coexist.
2180
format = BzrBranchFormat6()
2181
new_branch = format.open(branch.bzrdir, _found=True)
2183
# Copy source data into target
2184
new_branch.set_last_revision_info(*branch.last_revision_info())
2185
new_branch.set_parent(branch.get_parent())
2186
new_branch.set_bound_location(branch.get_bound_location())
2187
new_branch.set_push_location(branch.get_push_location())
2189
# New branch has no tags by default
2190
new_branch.tags._set_tag_dict({})
2192
# Copying done; now update target format
2193
new_branch.control_files.put_utf8('format',
2194
format.get_format_string())
2196
# Clean up old files
2197
new_branch.control_files._transport.delete('revision-history')
2199
branch.set_parent(None)
2202
branch.set_bound_location(None)
added
removed
bzrlib/branch.py
