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,
63
from bzrlib.trace import mutter, note
66
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
67
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
68
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
71
# TODO: Maybe include checks for common corruption of newlines, etc?
73
# TODO: Some operations like log might retrieve the same revisions
74
# repeatedly to calculate deltas. We could perhaps have a weakref
75
# cache in memory to make this faster. In general anything can be
76
# cached in memory between lock and unlock operations. .. nb thats
77
# what the transaction identity map provides
80
######################################################################
84
"""Branch holding a history of revisions.
87
Base directory/url of the branch.
89
hooks: An instance of BranchHooks.
91
# this is really an instance variable - FIXME move it there
95
# override this to set the strategy for storing tags
97
return DisabledTags(self)
99
def __init__(self, *ignored, **ignored_too):
100
self.tags = self._make_tags()
101
self._revision_history_cache = None
102
self._revision_id_to_revno_cache = None
104
def break_lock(self):
105
"""Break a lock if one is present from another instance.
107
Uses the ui factory to ask for confirmation if the lock may be from
110
This will probe the repository for its lock as well.
112
self.control_files.break_lock()
113
self.repository.break_lock()
114
master = self.get_master_branch()
115
if master is not None:
119
@deprecated_method(zero_eight)
120
def open_downlevel(base):
121
"""Open a branch which may be of an old format."""
122
return Branch.open(base, _unsupported=True)
125
def open(base, _unsupported=False):
126
"""Open the branch rooted at base.
128
For instance, if the branch is at URL/.bzr/branch,
129
Branch.open(URL) -> a Branch instance.
131
control = bzrdir.BzrDir.open(base, _unsupported)
132
return control.open_branch(_unsupported)
135
def open_from_transport(transport, _unsupported=False):
136
"""Open the branch rooted at transport"""
137
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
138
return control.open_branch(_unsupported)
141
def open_containing(url, possible_transports=None):
142
"""Open an existing branch which contains url.
144
This probes for a branch at url, and searches upwards from there.
146
Basically we keep looking up until we find the control directory or
147
run into the root. If there isn't one, raises NotBranchError.
148
If there is one and it is either an unrecognised format or an unsupported
149
format, UnknownFormatError or UnsupportedFormatError are raised.
150
If there is one, it is returned, along with the unused portion of url.
152
control, relpath = bzrdir.BzrDir.open_containing(url,
154
return control.open_branch(), relpath
157
@deprecated_function(zero_eight)
158
def initialize(base):
159
"""Create a new working tree and branch, rooted at 'base' (url)
161
NOTE: This will soon be deprecated in favour of creation
164
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
166
@deprecated_function(zero_eight)
167
def setup_caching(self, cache_root):
168
"""Subclasses that care about caching should override this, and set
169
up cached stores located under cache_root.
171
NOTE: This is unused.
175
def get_config(self):
176
return BranchConfig(self)
179
return self.get_config().get_nickname()
181
def _set_nick(self, nick):
182
self.get_config().set_user_option('nickname', nick, warn_masked=True)
184
nick = property(_get_nick, _set_nick)
187
raise NotImplementedError(self.is_locked)
189
def lock_write(self):
190
raise NotImplementedError(self.lock_write)
193
raise NotImplementedError(self.lock_read)
196
raise NotImplementedError(self.unlock)
198
def peek_lock_mode(self):
199
"""Return lock mode for the Branch: 'r', 'w' or None"""
200
raise NotImplementedError(self.peek_lock_mode)
202
def get_physical_lock_status(self):
203
raise NotImplementedError(self.get_physical_lock_status)
206
def get_revision_id_to_revno_map(self):
207
"""Return the revision_id => dotted revno map.
209
This will be regenerated on demand, but will be cached.
211
:return: A dictionary mapping revision_id => dotted revno.
212
This dictionary should not be modified by the caller.
214
if self._revision_id_to_revno_cache is not None:
215
mapping = self._revision_id_to_revno_cache
217
mapping = self._gen_revno_map()
218
self._cache_revision_id_to_revno(mapping)
219
# TODO: jam 20070417 Since this is being cached, should we be returning
221
# I would rather not, and instead just declare that users should not
222
# modify the return value.
225
def _gen_revno_map(self):
226
"""Create a new mapping from revision ids to dotted revnos.
228
Dotted revnos are generated based on the current tip in the revision
230
This is the worker function for get_revision_id_to_revno_map, which
231
just caches the return value.
233
:return: A dictionary mapping revision_id => dotted revno.
235
last_revision = self.last_revision()
236
revision_graph = self.repository.get_revision_graph(last_revision)
237
merge_sorted_revisions = tsort.merge_sort(
242
revision_id_to_revno = dict((rev_id, revno)
243
for seq_num, rev_id, depth, revno, end_of_merge
244
in merge_sorted_revisions)
245
return revision_id_to_revno
247
def leave_lock_in_place(self):
248
"""Tell this branch object not to release the physical lock when this
251
If lock_write doesn't return a token, then this method is not supported.
253
self.control_files.leave_in_place()
255
def dont_leave_lock_in_place(self):
256
"""Tell this branch object to release the physical lock when this
257
object is unlocked, even if it didn't originally acquire it.
259
If lock_write doesn't return a token, then this method is not supported.
261
self.control_files.dont_leave_in_place()
263
def abspath(self, name):
264
"""Return absolute filename for something in the branch
266
XXX: Robert Collins 20051017 what is this used for? why is it a branch
267
method and not a tree method.
269
raise NotImplementedError(self.abspath)
271
def bind(self, other):
272
"""Bind the local branch the other branch.
274
:param other: The branch to bind to
277
raise errors.UpgradeRequired(self.base)
280
def fetch(self, from_branch, last_revision=None, pb=None):
281
"""Copy revisions from from_branch into this branch.
283
:param from_branch: Where to copy from.
284
:param last_revision: What revision to stop at (None for at the end
286
:param pb: An optional progress bar to use.
288
Returns the copied revision count and the failed revisions in a tuple:
291
if self.base == from_branch.base:
294
nested_pb = ui.ui_factory.nested_progress_bar()
299
from_branch.lock_read()
301
if last_revision is None:
302
pb.update('get source history')
303
last_revision = from_branch.last_revision()
304
if last_revision is None:
305
last_revision = _mod_revision.NULL_REVISION
306
return self.repository.fetch(from_branch.repository,
307
revision_id=last_revision,
310
if nested_pb is not None:
314
def get_bound_location(self):
315
"""Return the URL of the branch we are bound to.
317
Older format branches cannot bind, please be sure to use a metadir
322
def get_old_bound_location(self):
323
"""Return the URL of the branch we used to be bound to
325
raise errors.UpgradeRequired(self.base)
327
def get_commit_builder(self, parents, config=None, timestamp=None,
328
timezone=None, committer=None, revprops=None,
330
"""Obtain a CommitBuilder for this branch.
332
:param parents: Revision ids of the parents of the new revision.
333
:param config: Optional configuration to use.
334
:param timestamp: Optional timestamp recorded for commit.
335
:param timezone: Optional timezone for timestamp.
336
:param committer: Optional committer to set for commit.
337
:param revprops: Optional dictionary of revision properties.
338
:param revision_id: Optional revision id.
342
config = self.get_config()
344
return self.repository.get_commit_builder(self, parents, config,
345
timestamp, timezone, committer, revprops, revision_id)
347
def get_master_branch(self):
348
"""Return the branch we are bound to.
350
:return: Either a Branch, or None
354
def get_revision_delta(self, revno):
355
"""Return the delta for one revision.
357
The delta is relative to its mainline predecessor, or the
358
empty tree for revision 1.
360
assert isinstance(revno, int)
361
rh = self.revision_history()
362
if not (1 <= revno <= len(rh)):
363
raise InvalidRevisionNumber(revno)
364
return self.repository.get_revision_delta(rh[revno-1])
366
@deprecated_method(zero_sixteen)
367
def get_root_id(self):
368
"""Return the id of this branches root
370
Deprecated: branches don't have root ids-- trees do.
371
Use basis_tree().get_root_id() instead.
373
raise NotImplementedError(self.get_root_id)
375
def print_file(self, file, revision_id):
376
"""Print `file` to stdout."""
377
raise NotImplementedError(self.print_file)
379
def append_revision(self, *revision_ids):
380
raise NotImplementedError(self.append_revision)
382
def set_revision_history(self, rev_history):
383
raise NotImplementedError(self.set_revision_history)
385
def _cache_revision_history(self, rev_history):
386
"""Set the cached revision history to rev_history.
388
The revision_history method will use this cache to avoid regenerating
389
the revision history.
391
This API is semi-public; it only for use by subclasses, all other code
392
should consider it to be private.
394
self._revision_history_cache = rev_history
396
def _cache_revision_id_to_revno(self, revision_id_to_revno):
397
"""Set the cached revision_id => revno map to revision_id_to_revno.
399
This API is semi-public; it only for use by subclasses, all other code
400
should consider it to be private.
402
self._revision_id_to_revno_cache = revision_id_to_revno
404
def _clear_cached_state(self):
405
"""Clear any cached data on this branch, e.g. cached revision history.
407
This means the next call to revision_history will need to call
408
_gen_revision_history.
410
This API is semi-public; it only for use by subclasses, all other code
411
should consider it to be private.
413
self._revision_history_cache = None
414
self._revision_id_to_revno_cache = None
416
def _gen_revision_history(self):
417
"""Return sequence of revision hashes on to this branch.
419
Unlike revision_history, this method always regenerates or rereads the
420
revision history, i.e. it does not cache the result, so repeated calls
423
Concrete subclasses should override this instead of revision_history so
424
that subclasses do not need to deal with caching logic.
426
This API is semi-public; it only for use by subclasses, all other code
427
should consider it to be private.
429
raise NotImplementedError(self._gen_revision_history)
432
def revision_history(self):
433
"""Return sequence of revision hashes on to this branch.
435
This method will cache the revision history for as long as it is safe to
438
if self._revision_history_cache is not None:
439
history = self._revision_history_cache
441
history = self._gen_revision_history()
442
self._cache_revision_history(history)
446
"""Return current revision number for this branch.
448
That is equivalent to the number of revisions committed to
451
return len(self.revision_history())
454
"""Older format branches cannot bind or unbind."""
455
raise errors.UpgradeRequired(self.base)
457
def set_append_revisions_only(self, enabled):
458
"""Older format branches are never restricted to append-only"""
459
raise errors.UpgradeRequired(self.base)
461
def last_revision(self):
462
"""Return last revision id, or None"""
463
ph = self.revision_history()
469
def last_revision_info(self):
470
"""Return information about the last revision.
472
:return: A tuple (revno, last_revision_id).
474
rh = self.revision_history()
477
return (revno, rh[-1])
479
return (0, _mod_revision.NULL_REVISION)
481
def missing_revisions(self, other, stop_revision=None):
482
"""Return a list of new revisions that would perfectly fit.
484
If self and other have not diverged, return a list of the revisions
485
present in other, but missing from self.
487
self_history = self.revision_history()
488
self_len = len(self_history)
489
other_history = other.revision_history()
490
other_len = len(other_history)
491
common_index = min(self_len, other_len) -1
492
if common_index >= 0 and \
493
self_history[common_index] != other_history[common_index]:
494
raise DivergedBranches(self, other)
496
if stop_revision is None:
497
stop_revision = other_len
499
assert isinstance(stop_revision, int)
500
if stop_revision > other_len:
501
raise errors.NoSuchRevision(self, stop_revision)
502
return other_history[self_len:stop_revision]
504
def update_revisions(self, other, stop_revision=None):
505
"""Pull in new perfect-fit revisions.
507
:param other: Another Branch to pull from
508
:param stop_revision: Updated until the given revision
511
raise NotImplementedError(self.update_revisions)
513
def revision_id_to_revno(self, revision_id):
514
"""Given a revision id, return its revno"""
515
if revision_id is None:
517
revision_id = osutils.safe_revision_id(revision_id)
518
history = self.revision_history()
520
return history.index(revision_id) + 1
522
raise errors.NoSuchRevision(self, revision_id)
524
def get_rev_id(self, revno, history=None):
525
"""Find the revision id of the specified revno."""
529
history = self.revision_history()
530
if revno <= 0 or revno > len(history):
531
raise errors.NoSuchRevision(self, revno)
532
return history[revno - 1]
534
def pull(self, source, overwrite=False, stop_revision=None):
535
"""Mirror source into this branch.
537
This branch is considered to be 'local', having low latency.
539
:returns: PullResult instance
541
raise NotImplementedError(self.pull)
543
def push(self, target, overwrite=False, stop_revision=None):
544
"""Mirror this branch into target.
546
This branch is considered to be 'local', having low latency.
548
raise NotImplementedError(self.push)
550
def basis_tree(self):
551
"""Return `Tree` object for last revision."""
552
return self.repository.revision_tree(self.last_revision())
554
def rename_one(self, from_rel, to_rel):
557
This can change the directory or the filename or both.
559
raise NotImplementedError(self.rename_one)
561
def move(self, from_paths, to_name):
564
to_name must exist as a versioned directory.
566
If to_name exists and is a directory, the files are moved into
567
it, keeping their old names. If it is a directory,
569
Note that to_name is only the last component of the new name;
570
this doesn't change the directory.
572
This returns a list of (from_path, to_path) pairs for each
575
raise NotImplementedError(self.move)
577
def get_parent(self):
578
"""Return the parent location of the branch.
580
This is the default location for push/pull/missing. The usual
581
pattern is that the user can override it by specifying a
584
raise NotImplementedError(self.get_parent)
586
def _set_config_location(self, name, url, config=None,
587
make_relative=False):
589
config = self.get_config()
593
url = urlutils.relative_url(self.base, url)
594
config.set_user_option(name, url, warn_masked=True)
596
def _get_config_location(self, name, config=None):
598
config = self.get_config()
599
location = config.get_user_option(name)
604
def get_submit_branch(self):
605
"""Return the submit location of the branch.
607
This is the default location for bundle. The usual
608
pattern is that the user can override it by specifying a
611
return self.get_config().get_user_option('submit_branch')
613
def set_submit_branch(self, location):
614
"""Return the submit location of the branch.
616
This is the default location for bundle. The usual
617
pattern is that the user can override it by specifying a
620
self.get_config().set_user_option('submit_branch', location,
623
def get_public_branch(self):
624
"""Return the public location of the branch.
626
This is is used by merge directives.
628
return self._get_config_location('public_branch')
630
def set_public_branch(self, location):
631
"""Return the submit location of the branch.
633
This is the default location for bundle. The usual
634
pattern is that the user can override it by specifying a
637
self._set_config_location('public_branch', location)
639
def get_push_location(self):
640
"""Return the None or the location to push this branch to."""
641
push_loc = self.get_config().get_user_option('push_location')
644
def set_push_location(self, location):
645
"""Set a new push location for this branch."""
646
raise NotImplementedError(self.set_push_location)
648
def set_parent(self, url):
649
raise NotImplementedError(self.set_parent)
653
"""Synchronise this branch with the master branch if any.
655
:return: None or the last_revision pivoted out during the update.
659
def check_revno(self, revno):
661
Check whether a revno corresponds to any revision.
662
Zero (the NULL revision) is considered valid.
665
self.check_real_revno(revno)
667
def check_real_revno(self, revno):
669
Check whether a revno corresponds to a real revision.
670
Zero (the NULL revision) is considered invalid
672
if revno < 1 or revno > self.revno():
673
raise InvalidRevisionNumber(revno)
676
def clone(self, to_bzrdir, revision_id=None):
677
"""Clone this branch into to_bzrdir preserving all semantic values.
679
revision_id: if not None, the revision history in the new branch will
680
be truncated to end with revision_id.
682
result = self._format.initialize(to_bzrdir)
683
self.copy_content_into(result, revision_id=revision_id)
687
def sprout(self, to_bzrdir, revision_id=None):
688
"""Create a new line of development from the branch, into to_bzrdir.
690
revision_id: if not None, the revision history in the new branch will
691
be truncated to end with revision_id.
693
result = self._format.initialize(to_bzrdir)
694
self.copy_content_into(result, revision_id=revision_id)
695
result.set_parent(self.bzrdir.root_transport.base)
698
def _synchronize_history(self, destination, revision_id):
699
"""Synchronize last revision and revision history between branches.
701
This version is most efficient when the destination is also a
702
BzrBranch5, but works for BzrBranch6 as long as the revision
703
history is the true lefthand parent history, and all of the revisions
704
are in the destination's repository. If not, set_revision_history
707
:param destination: The branch to copy the history into
708
:param revision_id: The revision-id to truncate history at. May
709
be None to copy complete history.
711
new_history = self.revision_history()
712
if revision_id is not None:
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)
1368
def append_revision(self, *revision_ids):
1369
"""See Branch.append_revision."""
1370
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1371
for revision_id in revision_ids:
1372
_mod_revision.check_not_reserved_id(revision_id)
1373
mutter("add {%s} to revision-history" % revision_id)
1374
rev_history = self.revision_history()
1375
rev_history.extend(revision_ids)
1376
self.set_revision_history(rev_history)
1378
def _write_revision_history(self, history):
1379
"""Factored out of set_revision_history.
1381
This performs the actual writing to disk.
1382
It is intended to be called by BzrBranch5.set_revision_history."""
1383
self.control_files.put_bytes(
1384
'revision-history', '\n'.join(history))
1387
def set_revision_history(self, rev_history):
1388
"""See Branch.set_revision_history."""
1389
rev_history = [osutils.safe_revision_id(r) for r in rev_history]
1390
self._clear_cached_state()
1391
self._write_revision_history(rev_history)
1392
self._cache_revision_history(rev_history)
1393
for hook in Branch.hooks['set_rh']:
1394
hook(self, rev_history)
1397
def set_last_revision_info(self, revno, revision_id):
1398
revision_id = osutils.safe_revision_id(revision_id)
1399
history = self._lefthand_history(revision_id)
1400
assert len(history) == revno, '%d != %d' % (len(history), revno)
1401
self.set_revision_history(history)
1403
def _gen_revision_history(self):
1404
history = self.control_files.get('revision-history').read().split('\n')
1405
if history[-1:] == ['']:
1406
# There shouldn't be a trailing newline, but just in case.
1410
def _lefthand_history(self, revision_id, last_rev=None,
1412
# stop_revision must be a descendant of last_revision
1413
stop_graph = self.repository.get_revision_graph(revision_id)
1414
if last_rev is not None 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 = self.last_revision()
1460
# we fetch here regardless of whether we need to so that we pickup
1462
self.fetch(other, stop_revision)
1463
my_ancestry = self.repository.get_ancestry(last_rev,
1465
if stop_revision in my_ancestry:
1466
# last_revision is a descendant of stop_revision
1468
self.generate_revision_history(stop_revision, last_rev=last_rev,
1473
def basis_tree(self):
1474
"""See Branch.basis_tree."""
1475
return self.repository.revision_tree(self.last_revision())
1477
@deprecated_method(zero_eight)
1478
def working_tree(self):
1479
"""Create a Working tree object for this branch."""
1481
from bzrlib.transport.local import LocalTransport
1482
if (self.base.find('://') != -1 or
1483
not isinstance(self._transport, LocalTransport)):
1484
raise NoWorkingTree(self.base)
1485
return self.bzrdir.open_workingtree()
1488
def pull(self, source, overwrite=False, stop_revision=None,
1489
_hook_master=None, run_hooks=True):
1492
:param _hook_master: Private parameter - set the branch to
1493
be supplied as the master to push hooks.
1494
:param run_hooks: Private parameter - if false, this branch
1495
is being called because it's the master of the primary branch,
1496
so it should not run its hooks.
1498
result = PullResult()
1499
result.source_branch = source
1500
result.target_branch = self
1503
result.old_revno, result.old_revid = self.last_revision_info()
1505
self.update_revisions(source, stop_revision)
1506
except DivergedBranches:
1510
if stop_revision is None:
1511
stop_revision = source.last_revision()
1512
self.generate_revision_history(stop_revision)
1513
result.tag_conflicts = source.tags.merge_to(self.tags)
1514
result.new_revno, result.new_revid = self.last_revision_info()
1516
result.master_branch = _hook_master
1517
result.local_branch = self
1519
result.master_branch = self
1520
result.local_branch = None
1522
for hook in Branch.hooks['post_pull']:
1528
def _get_parent_location(self):
1529
_locs = ['parent', 'pull', 'x-pull']
1532
return self.control_files.get(l).read().strip('\n')
1538
def push(self, target, overwrite=False, stop_revision=None,
1539
_override_hook_source_branch=None):
1542
This is the basic concrete implementation of push()
1544
:param _override_hook_source_branch: If specified, run
1545
the hooks passing this Branch as the source, rather than self.
1546
This is for use of RemoteBranch, where push is delegated to the
1547
underlying vfs-based Branch.
1549
# TODO: Public option to disable running hooks - should be trivial but
1553
result = self._push_with_bound_branches(target, overwrite,
1555
_override_hook_source_branch=_override_hook_source_branch)
1560
def _push_with_bound_branches(self, target, overwrite,
1562
_override_hook_source_branch=None):
1563
"""Push from self into target, and into target's master if any.
1565
This is on the base BzrBranch class even though it doesn't support
1566
bound branches because the *target* might be bound.
1569
if _override_hook_source_branch:
1570
result.source_branch = _override_hook_source_branch
1571
for hook in Branch.hooks['post_push']:
1574
bound_location = target.get_bound_location()
1575
if bound_location and target.base != bound_location:
1576
# there is a master branch.
1578
# XXX: Why the second check? Is it even supported for a branch to
1579
# be bound to itself? -- mbp 20070507
1580
master_branch = target.get_master_branch()
1581
master_branch.lock_write()
1583
# push into the master from this branch.
1584
self._basic_push(master_branch, overwrite, stop_revision)
1585
# and push into the target branch from this. Note that we push from
1586
# this branch again, because its considered the highest bandwidth
1588
result = self._basic_push(target, overwrite, stop_revision)
1589
result.master_branch = master_branch
1590
result.local_branch = target
1594
master_branch.unlock()
1597
result = self._basic_push(target, overwrite, stop_revision)
1598
# TODO: Why set master_branch and local_branch if there's no
1599
# binding? Maybe cleaner to just leave them unset? -- mbp
1601
result.master_branch = target
1602
result.local_branch = None
1606
def _basic_push(self, target, overwrite, stop_revision):
1607
"""Basic implementation of push without bound branches or hooks.
1609
Must be called with self read locked and target write locked.
1611
result = PushResult()
1612
result.source_branch = self
1613
result.target_branch = target
1614
result.old_revno, result.old_revid = target.last_revision_info()
1616
target.update_revisions(self, stop_revision)
1617
except DivergedBranches:
1621
target.set_revision_history(self.revision_history())
1622
result.tag_conflicts = self.tags.merge_to(target.tags)
1623
result.new_revno, result.new_revid = target.last_revision_info()
1626
def get_parent(self):
1627
"""See Branch.get_parent."""
1629
assert self.base[-1] == '/'
1630
parent = self._get_parent_location()
1633
# This is an old-format absolute path to a local branch
1634
# turn it into a url
1635
if parent.startswith('/'):
1636
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1638
return urlutils.join(self.base[:-1], parent)
1639
except errors.InvalidURLJoin, e:
1640
raise errors.InaccessibleParent(parent, self.base)
1642
def set_push_location(self, location):
1643
"""See Branch.set_push_location."""
1644
self.get_config().set_user_option(
1645
'push_location', location,
1646
store=_mod_config.STORE_LOCATION_NORECURSE)
1649
def set_parent(self, url):
1650
"""See Branch.set_parent."""
1651
# TODO: Maybe delete old location files?
1652
# URLs should never be unicode, even on the local fs,
1653
# FIXUP this and get_parent in a future branch format bump:
1654
# read and rewrite the file, and have the new format code read
1655
# using .get not .get_utf8. RBC 20060125
1657
if isinstance(url, unicode):
1659
url = url.encode('ascii')
1660
except UnicodeEncodeError:
1661
raise errors.InvalidURL(url,
1662
"Urls must be 7-bit ascii, "
1663
"use bzrlib.urlutils.escape")
1664
url = urlutils.relative_url(self.base, url)
1665
self._set_parent_location(url)
1667
def _set_parent_location(self, url):
1669
self.control_files._transport.delete('parent')
1671
assert isinstance(url, str)
1672
self.control_files.put_bytes('parent', url + '\n')
1674
@deprecated_function(zero_nine)
1675
def tree_config(self):
1676
"""DEPRECATED; call get_config instead.
1677
TreeConfig has become part of BranchConfig."""
1678
return TreeConfig(self)
1681
class BzrBranch5(BzrBranch):
1682
"""A format 5 branch. This supports new features over plan branches.
1684
It has support for a master_branch which is the data for bound branches.
1692
super(BzrBranch5, self).__init__(_format=_format,
1693
_control_files=_control_files,
1695
_repository=_repository)
1698
def pull(self, source, overwrite=False, stop_revision=None,
1700
"""Pull from source into self, updating my master if any.
1702
:param run_hooks: Private parameter - if false, this branch
1703
is being called because it's the master of the primary branch,
1704
so it should not run its hooks.
1706
bound_location = self.get_bound_location()
1707
master_branch = None
1708
if bound_location and source.base != bound_location:
1709
# not pulling from master, so we need to update master.
1710
master_branch = self.get_master_branch()
1711
master_branch.lock_write()
1714
# pull from source into master.
1715
master_branch.pull(source, overwrite, stop_revision,
1717
return super(BzrBranch5, self).pull(source, overwrite,
1718
stop_revision, _hook_master=master_branch,
1719
run_hooks=run_hooks)
1722
master_branch.unlock()
1724
def get_bound_location(self):
1726
return self.control_files.get_utf8('bound').read()[:-1]
1727
except errors.NoSuchFile:
1731
def get_master_branch(self):
1732
"""Return the branch we are bound to.
1734
:return: Either a Branch, or None
1736
This could memoise the branch, but if thats done
1737
it must be revalidated on each new lock.
1738
So for now we just don't memoise it.
1739
# RBC 20060304 review this decision.
1741
bound_loc = self.get_bound_location()
1745
return Branch.open(bound_loc)
1746
except (errors.NotBranchError, errors.ConnectionError), e:
1747
raise errors.BoundBranchConnectionFailure(
1751
def set_bound_location(self, location):
1752
"""Set the target where this branch is bound to.
1754
:param location: URL to the target branch
1757
self.control_files.put_utf8('bound', location+'\n')
1760
self.control_files._transport.delete('bound')
1766
def bind(self, other):
1767
"""Bind this branch to the branch other.
1769
This does not push or pull data between the branches, though it does
1770
check for divergence to raise an error when the branches are not
1771
either the same, or one a prefix of the other. That behaviour may not
1772
be useful, so that check may be removed in future.
1774
:param other: The branch to bind to
1777
# TODO: jam 20051230 Consider checking if the target is bound
1778
# It is debatable whether you should be able to bind to
1779
# a branch which is itself bound.
1780
# Committing is obviously forbidden,
1781
# but binding itself may not be.
1782
# Since we *have* to check at commit time, we don't
1783
# *need* to check here
1785
# we want to raise diverged if:
1786
# last_rev is not in the other_last_rev history, AND
1787
# other_last_rev is not in our history, and do it without pulling
1789
last_rev = self.last_revision()
1790
if last_rev is not None:
1793
other_last_rev = other.last_revision()
1794
if other_last_rev is not None:
1795
# neither branch is new, we have to do some work to
1796
# ascertain diversion.
1797
remote_graph = other.repository.get_revision_graph(
1799
local_graph = self.repository.get_revision_graph(last_rev)
1800
if (last_rev not in remote_graph and
1801
other_last_rev not in local_graph):
1802
raise errors.DivergedBranches(self, other)
1805
self.set_bound_location(other.base)
1809
"""If bound, unbind"""
1810
return self.set_bound_location(None)
1814
"""Synchronise this branch with the master branch if any.
1816
:return: None or the last_revision that was pivoted out during the
1819
master = self.get_master_branch()
1820
if master is not None:
1821
old_tip = self.last_revision()
1822
self.pull(master, overwrite=True)
1823
if old_tip in self.repository.get_ancestry(self.last_revision(),
1830
class BzrBranchExperimental(BzrBranch5):
1831
"""Bzr experimental branch format
1834
- a revision-history file.
1836
- a lock dir guarding the branch itself
1837
- all of this stored in a branch/ subdirectory
1838
- works with shared repositories.
1839
- a tag dictionary in the branch
1841
This format is new in bzr 0.15, but shouldn't be used for real data,
1844
This class acts as it's own BranchFormat.
1847
_matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1850
def get_format_string(cls):
1851
"""See BranchFormat.get_format_string()."""
1852
return "Bazaar-NG branch format experimental\n"
1855
def get_format_description(cls):
1856
"""See BranchFormat.get_format_description()."""
1857
return "Experimental branch format"
1860
def get_reference(cls, a_bzrdir):
1861
"""Get the target reference of the branch in a_bzrdir.
1863
format probing must have been completed before calling
1864
this method - it is assumed that the format of the branch
1865
in a_bzrdir is correct.
1867
:param a_bzrdir: The bzrdir to get the branch data from.
1868
:return: None if the branch is not a reference branch.
1873
def _initialize_control_files(cls, a_bzrdir, utf8_files, lock_filename,
1875
branch_transport = a_bzrdir.get_branch_transport(cls)
1876
control_files = lockable_files.LockableFiles(branch_transport,
1877
lock_filename, lock_class)
1878
control_files.create_lock()
1879
control_files.lock_write()
1881
for filename, content in utf8_files:
1882
control_files.put_utf8(filename, content)
1884
control_files.unlock()
1887
def initialize(cls, a_bzrdir):
1888
"""Create a branch of this format in a_bzrdir."""
1889
utf8_files = [('format', cls.get_format_string()),
1890
('revision-history', ''),
1891
('branch-name', ''),
1894
cls._initialize_control_files(a_bzrdir, utf8_files,
1895
'lock', lockdir.LockDir)
1896
return cls.open(a_bzrdir, _found=True)
1899
def open(cls, a_bzrdir, _found=False):
1900
"""Return the branch object for a_bzrdir
1902
_found is a private parameter, do not use it. It is used to indicate
1903
if format probing has already be done.
1906
format = BranchFormat.find_format(a_bzrdir)
1907
assert format.__class__ == cls
1908
transport = a_bzrdir.get_branch_transport(None)
1909
control_files = lockable_files.LockableFiles(transport, 'lock',
1911
return cls(_format=cls,
1912
_control_files=control_files,
1914
_repository=a_bzrdir.find_repository())
1917
def is_supported(cls):
1920
def _make_tags(self):
1921
return BasicTags(self)
1924
def supports_tags(cls):
1928
BranchFormat.register_format(BzrBranchExperimental)
1931
class BzrBranch6(BzrBranch5):
1934
def last_revision_info(self):
1935
revision_string = self.control_files.get('last-revision').read()
1936
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1937
revision_id = cache_utf8.get_cached_utf8(revision_id)
1939
return revno, revision_id
1941
def last_revision(self):
1942
"""Return last revision id, or None"""
1943
revision_id = self.last_revision_info()[1]
1944
if revision_id == _mod_revision.NULL_REVISION:
1948
def _write_last_revision_info(self, revno, revision_id):
1949
"""Simply write out the revision id, with no checks.
1951
Use set_last_revision_info to perform this safely.
1953
Does not update the revision_history cache.
1954
Intended to be called by set_last_revision_info and
1955
_write_revision_history.
1957
if revision_id is None:
1958
revision_id = 'null:'
1959
out_string = '%d %s\n' % (revno, revision_id)
1960
self.control_files.put_bytes('last-revision', out_string)
1963
def set_last_revision_info(self, revno, revision_id):
1964
revision_id = osutils.safe_revision_id(revision_id)
1965
if self._get_append_revisions_only():
1966
self._check_history_violation(revision_id)
1967
self._write_last_revision_info(revno, revision_id)
1968
self._clear_cached_state()
1970
def _check_history_violation(self, revision_id):
1971
last_revision = self.last_revision()
1972
if last_revision is None:
1974
if last_revision not in self._lefthand_history(revision_id):
1975
raise errors.AppendRevisionsOnlyViolation(self.base)
1977
def _gen_revision_history(self):
1978
"""Generate the revision history from last revision
1980
history = list(self.repository.iter_reverse_revision_history(
1981
self.last_revision()))
1985
def _write_revision_history(self, history):
1986
"""Factored out of set_revision_history.
1988
This performs the actual writing to disk, with format-specific checks.
1989
It is intended to be called by BzrBranch5.set_revision_history.
1991
if len(history) == 0:
1992
last_revision = 'null:'
1994
if history != self._lefthand_history(history[-1]):
1995
raise errors.NotLefthandHistory(history)
1996
last_revision = history[-1]
1997
if self._get_append_revisions_only():
1998
self._check_history_violation(last_revision)
1999
self._write_last_revision_info(len(history), last_revision)
2002
def append_revision(self, *revision_ids):
2003
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
2004
if len(revision_ids) == 0:
2006
prev_revno, prev_revision = self.last_revision_info()
2007
for revision in self.repository.get_revisions(revision_ids):
2008
if prev_revision == _mod_revision.NULL_REVISION:
2009
if revision.parent_ids != []:
2010
raise errors.NotLeftParentDescendant(self, prev_revision,
2011
revision.revision_id)
2013
if revision.parent_ids[0] != prev_revision:
2014
raise errors.NotLeftParentDescendant(self, prev_revision,
2015
revision.revision_id)
2016
prev_revision = revision.revision_id
2017
self.set_last_revision_info(prev_revno + len(revision_ids),
2021
def _set_parent_location(self, url):
2022
"""Set the parent branch"""
2023
self._set_config_location('parent_location', url, make_relative=True)
2026
def _get_parent_location(self):
2027
"""Set the parent branch"""
2028
return self._get_config_location('parent_location')
2030
def set_push_location(self, location):
2031
"""See Branch.set_push_location."""
2032
self._set_config_location('push_location', location)
2034
def set_bound_location(self, location):
2035
"""See Branch.set_push_location."""
2037
config = self.get_config()
2038
if location is None:
2039
if config.get_user_option('bound') != 'True':
2042
config.set_user_option('bound', 'False', warn_masked=True)
2045
self._set_config_location('bound_location', location,
2047
config.set_user_option('bound', 'True', warn_masked=True)
2050
def _get_bound_location(self, bound):
2051
"""Return the bound location in the config file.
2053
Return None if the bound parameter does not match"""
2054
config = self.get_config()
2055
config_bound = (config.get_user_option('bound') == 'True')
2056
if config_bound != bound:
2058
return self._get_config_location('bound_location', config=config)
2060
def get_bound_location(self):
2061
"""See Branch.set_push_location."""
2062
return self._get_bound_location(True)
2064
def get_old_bound_location(self):
2065
"""See Branch.get_old_bound_location"""
2066
return self._get_bound_location(False)
2068
def set_append_revisions_only(self, enabled):
2073
self.get_config().set_user_option('append_revisions_only', value,
2076
def _get_append_revisions_only(self):
2077
value = self.get_config().get_user_option('append_revisions_only')
2078
return value == 'True'
2080
def _synchronize_history(self, destination, revision_id):
2081
"""Synchronize last revision and revision history between branches.
2083
This version is most efficient when the destination is also a
2084
BzrBranch6, but works for BzrBranch5, as long as the destination's
2085
repository contains all the lefthand ancestors of the intended
2086
last_revision. If not, set_last_revision_info will fail.
2088
:param destination: The branch to copy the history into
2089
:param revision_id: The revision-id to truncate history at. May
2090
be None to copy complete history.
2092
if revision_id is None:
2093
revno, revision_id = self.last_revision_info()
2095
# To figure out the revno for a random revision, we need to build
2096
# the revision history, and count its length.
2097
# We don't care about the order, just how long it is.
2098
# Alternatively, we could start at the current location, and count
2099
# backwards. But there is no guarantee that we will find it since
2100
# it may be a merged revision.
2101
revno = len(list(self.repository.iter_reverse_revision_history(
2103
destination.set_last_revision_info(revno, revision_id)
2105
def _make_tags(self):
2106
return BasicTags(self)
2109
######################################################################
2110
# results of operations
2113
class _Result(object):
2115
def _show_tag_conficts(self, to_file):
2116
if not getattr(self, 'tag_conflicts', None):
2118
to_file.write('Conflicting tags:\n')
2119
for name, value1, value2 in self.tag_conflicts:
2120
to_file.write(' %s\n' % (name, ))
2123
class PullResult(_Result):
2124
"""Result of a Branch.pull operation.
2126
:ivar old_revno: Revision number before pull.
2127
:ivar new_revno: Revision number after pull.
2128
:ivar old_revid: Tip revision id before pull.
2129
:ivar new_revid: Tip revision id after pull.
2130
:ivar source_branch: Source (local) branch object.
2131
:ivar master_branch: Master branch of the target, or None.
2132
:ivar target_branch: Target/destination branch object.
2136
# DEPRECATED: pull used to return the change in revno
2137
return self.new_revno - self.old_revno
2139
def report(self, to_file):
2140
if self.old_revid == self.new_revid:
2141
to_file.write('No revisions to pull.\n')
2143
to_file.write('Now on revision %d.\n' % self.new_revno)
2144
self._show_tag_conficts(to_file)
2147
class PushResult(_Result):
2148
"""Result of a Branch.push operation.
2150
:ivar old_revno: Revision number before push.
2151
:ivar new_revno: Revision number after push.
2152
:ivar old_revid: Tip revision id before push.
2153
:ivar new_revid: Tip revision id after push.
2154
:ivar source_branch: Source branch object.
2155
:ivar master_branch: Master branch of the target, or None.
2156
:ivar target_branch: Target/destination branch object.
2160
# DEPRECATED: push used to return the change in revno
2161
return self.new_revno - self.old_revno
2163
def report(self, to_file):
2164
"""Write a human-readable description of the result."""
2165
if self.old_revid == self.new_revid:
2166
to_file.write('No new revisions to push.\n')
2168
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2169
self._show_tag_conficts(to_file)
2172
class BranchCheckResult(object):
2173
"""Results of checking branch consistency.
2178
def __init__(self, branch):
2179
self.branch = branch
2181
def report_results(self, verbose):
2182
"""Report the check results via trace.note.
2184
:param verbose: Requests more detailed display of what was checked,
2187
note('checked branch %s format %s',
2189
self.branch._format)
2192
class Converter5to6(object):
2193
"""Perform an in-place upgrade of format 5 to format 6"""
2195
def convert(self, branch):
2196
# Data for 5 and 6 can peacefully coexist.
2197
format = BzrBranchFormat6()
2198
new_branch = format.open(branch.bzrdir, _found=True)
2200
# Copy source data into target
2201
new_branch.set_last_revision_info(*branch.last_revision_info())
2202
new_branch.set_parent(branch.get_parent())
2203
new_branch.set_bound_location(branch.get_bound_location())
2204
new_branch.set_push_location(branch.get_push_location())
2206
# New branch has no tags by default
2207
new_branch.tags._set_tag_dict({})
2209
# Copying done; now update target format
2210
new_branch.control_files.put_utf8('format',
2211
format.get_format_string())
2213
# Clean up old files
2214
new_branch.control_files._transport.delete('revision-history')
2216
branch.set_parent(None)
2219
branch.set_bound_location(None)
added
removed
bzrlib/branch.py
