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 _mod_revision.is_null(revision_id):
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
if revision_id == _mod_revision.NULL_REVISION:
713
new_history = self.revision_history()
714
if revision_id is not None and new_history != []:
715
revision_id = osutils.safe_revision_id(revision_id)
717
new_history = new_history[:new_history.index(revision_id) + 1]
719
rev = self.repository.get_revision(revision_id)
720
new_history = rev.get_history(self.repository)[1:]
721
destination.set_revision_history(new_history)
724
def copy_content_into(self, destination, revision_id=None):
725
"""Copy the content of self into destination.
727
revision_id: if not None, the revision history in the new branch will
728
be truncated to end with revision_id.
730
self._synchronize_history(destination, revision_id)
732
parent = self.get_parent()
733
except errors.InaccessibleParent, e:
734
mutter('parent was not accessible to copy: %s', e)
737
destination.set_parent(parent)
738
self.tags.merge_to(destination.tags)
742
"""Check consistency of the branch.
744
In particular this checks that revisions given in the revision-history
745
do actually match up in the revision graph, and that they're all
746
present in the repository.
748
Callers will typically also want to check the repository.
750
:return: A BranchCheckResult.
752
mainline_parent_id = None
753
for revision_id in self.revision_history():
755
revision = self.repository.get_revision(revision_id)
756
except errors.NoSuchRevision, e:
757
raise errors.BzrCheckError("mainline revision {%s} not in repository"
759
# In general the first entry on the revision history has no parents.
760
# But it's not illegal for it to have parents listed; this can happen
761
# in imports from Arch when the parents weren't reachable.
762
if mainline_parent_id is not None:
763
if mainline_parent_id not in revision.parent_ids:
764
raise errors.BzrCheckError("previous revision {%s} not listed among "
766
% (mainline_parent_id, revision_id))
767
mainline_parent_id = revision_id
768
return BranchCheckResult(self)
770
def _get_checkout_format(self):
771
"""Return the most suitable metadir for a checkout of this branch.
772
Weaves are used if this branch's repository uses weaves.
774
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
775
from bzrlib.repofmt import weaverepo
776
format = bzrdir.BzrDirMetaFormat1()
777
format.repository_format = weaverepo.RepositoryFormat7()
779
format = self.repository.bzrdir.checkout_metadir()
780
format.set_branch_format(self._format)
783
def create_checkout(self, to_location, revision_id=None,
785
"""Create a checkout of a branch.
787
:param to_location: The url to produce the checkout at
788
:param revision_id: The revision to check out
789
:param lightweight: If True, produce a lightweight checkout, otherwise,
790
produce a bound branch (heavyweight checkout)
791
:return: The tree of the created checkout
793
t = transport.get_transport(to_location)
796
format = self._get_checkout_format()
797
checkout = format.initialize_on_transport(t)
798
BranchReferenceFormat().initialize(checkout, self)
800
format = self._get_checkout_format()
801
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
802
to_location, force_new_tree=False, format=format)
803
checkout = checkout_branch.bzrdir
804
checkout_branch.bind(self)
805
# pull up to the specified revision_id to set the initial
806
# branch tip correctly, and seed it with history.
807
checkout_branch.pull(self, stop_revision=revision_id)
808
tree = checkout.create_workingtree(revision_id)
809
basis_tree = tree.basis_tree()
810
basis_tree.lock_read()
812
for path, file_id in basis_tree.iter_references():
813
reference_parent = self.reference_parent(file_id, path)
814
reference_parent.create_checkout(tree.abspath(path),
815
basis_tree.get_reference_revision(file_id, path),
821
def reference_parent(self, file_id, path):
822
"""Return the parent branch for a tree-reference file_id
823
:param file_id: The file_id of the tree reference
824
:param path: The path of the file_id in the tree
825
:return: A branch associated with the file_id
827
# FIXME should provide multiple branches, based on config
828
return Branch.open(self.bzrdir.root_transport.clone(path).base)
830
def supports_tags(self):
831
return self._format.supports_tags()
834
class BranchFormat(object):
835
"""An encapsulation of the initialization and open routines for a format.
837
Formats provide three things:
838
* An initialization routine,
842
Formats are placed in an dict by their format string for reference
843
during branch opening. Its not required that these be instances, they
844
can be classes themselves with class methods - it simply depends on
845
whether state is needed for a given format or not.
847
Once a format is deprecated, just deprecate the initialize and open
848
methods on the format class. Do not deprecate the object, as the
849
object will be created every time regardless.
852
_default_format = None
853
"""The default format used for new branches."""
856
"""The known formats."""
858
def __eq__(self, other):
859
return self.__class__ is other.__class__
861
def __ne__(self, other):
862
return not (self == other)
865
def find_format(klass, a_bzrdir):
866
"""Return the format for the branch object in a_bzrdir."""
868
transport = a_bzrdir.get_branch_transport(None)
869
format_string = transport.get("format").read()
870
return klass._formats[format_string]
872
raise NotBranchError(path=transport.base)
874
raise errors.UnknownFormatError(format=format_string)
877
def get_default_format(klass):
878
"""Return the current default format."""
879
return klass._default_format
881
def get_reference(self, a_bzrdir):
882
"""Get the target reference of the branch in a_bzrdir.
884
format probing must have been completed before calling
885
this method - it is assumed that the format of the branch
886
in a_bzrdir is correct.
888
:param a_bzrdir: The bzrdir to get the branch data from.
889
:return: None if the branch is not a reference branch.
893
def get_format_string(self):
894
"""Return the ASCII format string that identifies this format."""
895
raise NotImplementedError(self.get_format_string)
897
def get_format_description(self):
898
"""Return the short format description for this format."""
899
raise NotImplementedError(self.get_format_description)
901
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
903
"""Initialize a branch in a bzrdir, with specified files
905
:param a_bzrdir: The bzrdir to initialize the branch in
906
:param utf8_files: The files to create as a list of
907
(filename, content) tuples
908
:param set_format: If True, set the format with
909
self.get_format_string. (BzrBranch4 has its format set
911
:return: a branch in this format
913
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
914
branch_transport = a_bzrdir.get_branch_transport(self)
916
'metadir': ('lock', lockdir.LockDir),
917
'branch4': ('branch-lock', lockable_files.TransportLock),
919
lock_name, lock_class = lock_map[lock_type]
920
control_files = lockable_files.LockableFiles(branch_transport,
921
lock_name, lock_class)
922
control_files.create_lock()
923
control_files.lock_write()
925
control_files.put_utf8('format', self.get_format_string())
927
for file, content in utf8_files:
928
control_files.put_utf8(file, content)
930
control_files.unlock()
931
return self.open(a_bzrdir, _found=True)
933
def initialize(self, a_bzrdir):
934
"""Create a branch of this format in a_bzrdir."""
935
raise NotImplementedError(self.initialize)
937
def is_supported(self):
938
"""Is this format supported?
940
Supported formats can be initialized and opened.
941
Unsupported formats may not support initialization or committing or
942
some other features depending on the reason for not being supported.
946
def open(self, a_bzrdir, _found=False):
947
"""Return the branch object for a_bzrdir
949
_found is a private parameter, do not use it. It is used to indicate
950
if format probing has already be done.
952
raise NotImplementedError(self.open)
955
def register_format(klass, format):
956
klass._formats[format.get_format_string()] = format
959
def set_default_format(klass, format):
960
klass._default_format = format
963
def unregister_format(klass, format):
964
assert klass._formats[format.get_format_string()] is format
965
del klass._formats[format.get_format_string()]
968
return self.get_format_string().rstrip()
970
def supports_tags(self):
971
"""True if this format supports tags stored in the branch"""
972
return False # by default
974
# XXX: Probably doesn't really belong here -- mbp 20070212
975
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
977
branch_transport = a_bzrdir.get_branch_transport(self)
978
control_files = lockable_files.LockableFiles(branch_transport,
979
lock_filename, lock_class)
980
control_files.create_lock()
981
control_files.lock_write()
983
for filename, content in utf8_files:
984
control_files.put_utf8(filename, content)
986
control_files.unlock()
989
class BranchHooks(Hooks):
990
"""A dictionary mapping hook name to a list of callables for branch hooks.
992
e.g. ['set_rh'] Is the list of items to be called when the
993
set_revision_history function is invoked.
997
"""Create the default hooks.
999
These are all empty initially, because by default nothing should get
1002
Hooks.__init__(self)
1003
# Introduced in 0.15:
1004
# invoked whenever the revision history has been set
1005
# with set_revision_history. The api signature is
1006
# (branch, revision_history), and the branch will
1009
# invoked after a push operation completes.
1010
# the api signature is
1012
# containing the members
1013
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1014
# where local is the local target branch or None, master is the target
1015
# master branch, and the rest should be self explanatory. The source
1016
# is read locked and the target branches write locked. Source will
1017
# be the local low-latency branch.
1018
self['post_push'] = []
1019
# invoked after a pull operation completes.
1020
# the api signature is
1022
# containing the members
1023
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1024
# where local is the local branch or None, master is the target
1025
# master branch, and the rest should be self explanatory. The source
1026
# is read locked and the target branches write locked. The local
1027
# branch is the low-latency branch.
1028
self['post_pull'] = []
1029
# invoked before a commit operation takes place.
1030
# the api signature is
1031
# (local, master, old_revno, old_revid, future_revno, future_revid,
1032
# affected_ids, future_revision_tree).
1033
# old_revid is NULL_REVISION for the first commit to a branch
1034
# affected_ids is a dictionary of (change_type, ids) pairs where ids
1035
# is a list of inventory entry ids and change_type is a string
1036
# describing the change (added, deleted, renamed, etc.)
1037
# future_revision_tree is an in-memory tree obtained from
1038
# CommitBuilder.revision_tree()
1039
self['pre_commit'] = []
1040
# invoked after a commit operation completes.
1041
# the api signature is
1042
# (local, master, old_revno, old_revid, new_revno, new_revid)
1043
# old_revid is NULL_REVISION for the first commit to a branch.
1044
self['post_commit'] = []
1045
# invoked after a uncommit operation completes.
1046
# the api signature is
1047
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1048
# local is the local branch or None, master is the target branch,
1049
# and an empty branch recieves new_revno of 0, new_revid of None.
1050
self['post_uncommit'] = []
1053
# install the default hooks into the Branch class.
1054
Branch.hooks = BranchHooks()
1057
class BzrBranchFormat4(BranchFormat):
1058
"""Bzr branch format 4.
1061
- a revision-history file.
1062
- a branch-lock lock file [ to be shared with the bzrdir ]
1065
def get_format_description(self):
1066
"""See BranchFormat.get_format_description()."""
1067
return "Branch format 4"
1069
def initialize(self, a_bzrdir):
1070
"""Create a branch of this format in a_bzrdir."""
1071
utf8_files = [('revision-history', ''),
1072
('branch-name', ''),
1074
return self._initialize_helper(a_bzrdir, utf8_files,
1075
lock_type='branch4', set_format=False)
1078
super(BzrBranchFormat4, self).__init__()
1079
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1081
def open(self, a_bzrdir, _found=False):
1082
"""Return the branch object for a_bzrdir
1084
_found is a private parameter, do not use it. It is used to indicate
1085
if format probing has already be done.
1088
# we are being called directly and must probe.
1089
raise NotImplementedError
1090
return BzrBranch(_format=self,
1091
_control_files=a_bzrdir._control_files,
1093
_repository=a_bzrdir.open_repository())
1096
return "Bazaar-NG branch format 4"
1099
class BzrBranchFormat5(BranchFormat):
1100
"""Bzr branch format 5.
1103
- a revision-history file.
1105
- a lock dir guarding the branch itself
1106
- all of this stored in a branch/ subdirectory
1107
- works with shared repositories.
1109
This format is new in bzr 0.8.
1112
def get_format_string(self):
1113
"""See BranchFormat.get_format_string()."""
1114
return "Bazaar-NG branch format 5\n"
1116
def get_format_description(self):
1117
"""See BranchFormat.get_format_description()."""
1118
return "Branch format 5"
1120
def initialize(self, a_bzrdir):
1121
"""Create a branch of this format in a_bzrdir."""
1122
utf8_files = [('revision-history', ''),
1123
('branch-name', ''),
1125
return self._initialize_helper(a_bzrdir, utf8_files)
1128
super(BzrBranchFormat5, self).__init__()
1129
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1131
def open(self, a_bzrdir, _found=False):
1132
"""Return the branch object for a_bzrdir
1134
_found is a private parameter, do not use it. It is used to indicate
1135
if format probing has already be done.
1138
format = BranchFormat.find_format(a_bzrdir)
1139
assert format.__class__ == self.__class__
1141
transport = a_bzrdir.get_branch_transport(None)
1142
control_files = lockable_files.LockableFiles(transport, 'lock',
1144
return BzrBranch5(_format=self,
1145
_control_files=control_files,
1147
_repository=a_bzrdir.find_repository())
1149
raise NotBranchError(path=transport.base)
1152
class BzrBranchFormat6(BzrBranchFormat5):
1153
"""Branch format with last-revision
1155
Unlike previous formats, this has no explicit revision history. Instead,
1156
this just stores the last-revision, and the left-hand history leading
1157
up to there is the history.
1159
This format was introduced in bzr 0.15
1162
def get_format_string(self):
1163
"""See BranchFormat.get_format_string()."""
1164
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1166
def get_format_description(self):
1167
"""See BranchFormat.get_format_description()."""
1168
return "Branch format 6"
1170
def initialize(self, a_bzrdir):
1171
"""Create a branch of this format in a_bzrdir."""
1172
utf8_files = [('last-revision', '0 null:\n'),
1173
('branch-name', ''),
1174
('branch.conf', ''),
1177
return self._initialize_helper(a_bzrdir, utf8_files)
1179
def open(self, a_bzrdir, _found=False):
1180
"""Return the branch object for a_bzrdir
1182
_found is a private parameter, do not use it. It is used to indicate
1183
if format probing has already be done.
1186
format = BranchFormat.find_format(a_bzrdir)
1187
assert format.__class__ == self.__class__
1188
transport = a_bzrdir.get_branch_transport(None)
1189
control_files = lockable_files.LockableFiles(transport, 'lock',
1191
return BzrBranch6(_format=self,
1192
_control_files=control_files,
1194
_repository=a_bzrdir.find_repository())
1196
def supports_tags(self):
1200
class BranchReferenceFormat(BranchFormat):
1201
"""Bzr branch reference format.
1203
Branch references are used in implementing checkouts, they
1204
act as an alias to the real branch which is at some other url.
1211
def get_format_string(self):
1212
"""See BranchFormat.get_format_string()."""
1213
return "Bazaar-NG Branch Reference Format 1\n"
1215
def get_format_description(self):
1216
"""See BranchFormat.get_format_description()."""
1217
return "Checkout reference format 1"
1219
def get_reference(self, a_bzrdir):
1220
"""See BranchFormat.get_reference()."""
1221
transport = a_bzrdir.get_branch_transport(None)
1222
return transport.get('location').read()
1224
def initialize(self, a_bzrdir, target_branch=None):
1225
"""Create a branch of this format in a_bzrdir."""
1226
if target_branch is None:
1227
# this format does not implement branch itself, thus the implicit
1228
# creation contract must see it as uninitializable
1229
raise errors.UninitializableFormat(self)
1230
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1231
branch_transport = a_bzrdir.get_branch_transport(self)
1232
branch_transport.put_bytes('location',
1233
target_branch.bzrdir.root_transport.base)
1234
branch_transport.put_bytes('format', self.get_format_string())
1235
return self.open(a_bzrdir, _found=True)
1238
super(BranchReferenceFormat, self).__init__()
1239
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1241
def _make_reference_clone_function(format, a_branch):
1242
"""Create a clone() routine for a branch dynamically."""
1243
def clone(to_bzrdir, revision_id=None):
1244
"""See Branch.clone()."""
1245
return format.initialize(to_bzrdir, a_branch)
1246
# cannot obey revision_id limits when cloning a reference ...
1247
# FIXME RBC 20060210 either nuke revision_id for clone, or
1248
# emit some sort of warning/error to the caller ?!
1251
def open(self, a_bzrdir, _found=False, location=None):
1252
"""Return the branch that the branch reference in a_bzrdir points at.
1254
_found is a private parameter, do not use it. It is used to indicate
1255
if format probing has already be done.
1258
format = BranchFormat.find_format(a_bzrdir)
1259
assert format.__class__ == self.__class__
1260
if location is None:
1261
location = self.get_reference(a_bzrdir)
1262
real_bzrdir = bzrdir.BzrDir.open(location)
1263
result = real_bzrdir.open_branch()
1264
# this changes the behaviour of result.clone to create a new reference
1265
# rather than a copy of the content of the branch.
1266
# I did not use a proxy object because that needs much more extensive
1267
# testing, and we are only changing one behaviour at the moment.
1268
# If we decide to alter more behaviours - i.e. the implicit nickname
1269
# then this should be refactored to introduce a tested proxy branch
1270
# and a subclass of that for use in overriding clone() and ....
1272
result.clone = self._make_reference_clone_function(result)
1276
# formats which have no format string are not discoverable
1277
# and not independently creatable, so are not registered.
1278
__default_format = BzrBranchFormat5()
1279
BranchFormat.register_format(__default_format)
1280
BranchFormat.register_format(BranchReferenceFormat())
1281
BranchFormat.register_format(BzrBranchFormat6())
1282
BranchFormat.set_default_format(__default_format)
1283
_legacy_formats = [BzrBranchFormat4(),
1286
class BzrBranch(Branch):
1287
"""A branch stored in the actual filesystem.
1289
Note that it's "local" in the context of the filesystem; it doesn't
1290
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1291
it's writable, and can be accessed via the normal filesystem API.
1294
def __init__(self, _format=None,
1295
_control_files=None, a_bzrdir=None, _repository=None):
1296
"""Create new branch object at a particular location."""
1297
Branch.__init__(self)
1298
if a_bzrdir is None:
1299
raise ValueError('a_bzrdir must be supplied')
1301
self.bzrdir = a_bzrdir
1302
# self._transport used to point to the directory containing the
1303
# control directory, but was not used - now it's just the transport
1304
# for the branch control files. mbp 20070212
1305
self._base = self.bzrdir.transport.clone('..').base
1306
self._format = _format
1307
if _control_files is None:
1308
raise ValueError('BzrBranch _control_files is None')
1309
self.control_files = _control_files
1310
self._transport = _control_files._transport
1311
self.repository = _repository
1314
return '%s(%r)' % (self.__class__.__name__, self.base)
1318
def _get_base(self):
1319
"""Returns the directory containing the control directory."""
1322
base = property(_get_base, doc="The URL for the root of this branch.")
1324
def abspath(self, name):
1325
"""See Branch.abspath."""
1326
return self.control_files._transport.abspath(name)
1329
@deprecated_method(zero_sixteen)
1331
def get_root_id(self):
1332
"""See Branch.get_root_id."""
1333
tree = self.repository.revision_tree(self.last_revision())
1334
return tree.inventory.root.file_id
1336
def is_locked(self):
1337
return self.control_files.is_locked()
1339
def lock_write(self, token=None):
1340
repo_token = self.repository.lock_write()
1342
token = self.control_files.lock_write(token=token)
1344
self.repository.unlock()
1348
def lock_read(self):
1349
self.repository.lock_read()
1351
self.control_files.lock_read()
1353
self.repository.unlock()
1357
# TODO: test for failed two phase locks. This is known broken.
1359
self.control_files.unlock()
1361
self.repository.unlock()
1362
if not self.control_files.is_locked():
1363
# we just released the lock
1364
self._clear_cached_state()
1366
def peek_lock_mode(self):
1367
if self.control_files._lock_count == 0:
1370
return self.control_files._lock_mode
1372
def get_physical_lock_status(self):
1373
return self.control_files.get_physical_lock_status()
1376
def print_file(self, file, revision_id):
1377
"""See Branch.print_file."""
1378
return self.repository.print_file(file, revision_id)
1381
def append_revision(self, *revision_ids):
1382
"""See Branch.append_revision."""
1383
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1384
for revision_id in revision_ids:
1385
_mod_revision.check_not_reserved_id(revision_id)
1386
mutter("add {%s} to revision-history" % revision_id)
1387
rev_history = self.revision_history()
1388
rev_history.extend(revision_ids)
1389
self.set_revision_history(rev_history)
1391
def _write_revision_history(self, history):
1392
"""Factored out of set_revision_history.
1394
This performs the actual writing to disk.
1395
It is intended to be called by BzrBranch5.set_revision_history."""
1396
self.control_files.put_bytes(
1397
'revision-history', '\n'.join(history))
1400
def set_revision_history(self, rev_history):
1401
"""See Branch.set_revision_history."""
1402
rev_history = [osutils.safe_revision_id(r) for r in rev_history]
1403
self._clear_cached_state()
1404
self._write_revision_history(rev_history)
1405
self._cache_revision_history(rev_history)
1406
for hook in Branch.hooks['set_rh']:
1407
hook(self, rev_history)
1410
def set_last_revision_info(self, revno, revision_id):
1411
revision_id = osutils.safe_revision_id(revision_id)
1412
history = self._lefthand_history(revision_id)
1413
assert len(history) == revno, '%d != %d' % (len(history), revno)
1414
self.set_revision_history(history)
1416
def _gen_revision_history(self):
1417
history = self.control_files.get('revision-history').read().split('\n')
1418
if history[-1:] == ['']:
1419
# There shouldn't be a trailing newline, but just in case.
1423
def _lefthand_history(self, revision_id, last_rev=None,
1425
# stop_revision must be a descendant of last_revision
1426
stop_graph = self.repository.get_revision_graph(revision_id)
1427
if (last_rev is not None and last_rev != _mod_revision.NULL_REVISION
1428
and last_rev not in stop_graph):
1429
# our previous tip is not merged into stop_revision
1430
raise errors.DivergedBranches(self, other_branch)
1431
# make a new revision history from the graph
1432
current_rev_id = revision_id
1434
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1435
new_history.append(current_rev_id)
1436
current_rev_id_parents = stop_graph[current_rev_id]
1438
current_rev_id = current_rev_id_parents[0]
1440
current_rev_id = None
1441
new_history.reverse()
1445
def generate_revision_history(self, revision_id, last_rev=None,
1447
"""Create a new revision history that will finish with revision_id.
1449
:param revision_id: the new tip to use.
1450
:param last_rev: The previous last_revision. If not None, then this
1451
must be a ancestory of revision_id, or DivergedBranches is raised.
1452
:param other_branch: The other branch that DivergedBranches should
1453
raise with respect to.
1455
revision_id = osutils.safe_revision_id(revision_id)
1456
self.set_revision_history(self._lefthand_history(revision_id,
1457
last_rev, other_branch))
1460
def update_revisions(self, other, stop_revision=None):
1461
"""See Branch.update_revisions."""
1464
if stop_revision is None:
1465
stop_revision = other.last_revision()
1466
if stop_revision is None:
1467
# if there are no commits, we're done.
1470
stop_revision = osutils.safe_revision_id(stop_revision)
1471
# whats the current last revision, before we fetch [and change it
1473
last_rev = _mod_revision.ensure_null(self.last_revision())
1474
# we fetch here regardless of whether we need to so that we pickup
1476
self.fetch(other, stop_revision)
1477
if self.repository.get_graph().is_ancestor(stop_revision,
1480
self.generate_revision_history(stop_revision, last_rev=last_rev,
1485
def basis_tree(self):
1486
"""See Branch.basis_tree."""
1487
return self.repository.revision_tree(self.last_revision())
1489
@deprecated_method(zero_eight)
1490
def working_tree(self):
1491
"""Create a Working tree object for this branch."""
1493
from bzrlib.transport.local import LocalTransport
1494
if (self.base.find('://') != -1 or
1495
not isinstance(self._transport, LocalTransport)):
1496
raise NoWorkingTree(self.base)
1497
return self.bzrdir.open_workingtree()
1500
def pull(self, source, overwrite=False, stop_revision=None,
1501
_hook_master=None, run_hooks=True):
1504
:param _hook_master: Private parameter - set the branch to
1505
be supplied as the master to push hooks.
1506
:param run_hooks: Private parameter - if false, this branch
1507
is being called because it's the master of the primary branch,
1508
so it should not run its hooks.
1510
result = PullResult()
1511
result.source_branch = source
1512
result.target_branch = self
1515
result.old_revno, result.old_revid = self.last_revision_info()
1517
self.update_revisions(source, stop_revision)
1518
except DivergedBranches:
1522
if stop_revision is None:
1523
stop_revision = source.last_revision()
1524
self.generate_revision_history(stop_revision)
1525
result.tag_conflicts = source.tags.merge_to(self.tags)
1526
result.new_revno, result.new_revid = self.last_revision_info()
1528
result.master_branch = _hook_master
1529
result.local_branch = self
1531
result.master_branch = self
1532
result.local_branch = None
1534
for hook in Branch.hooks['post_pull']:
1540
def _get_parent_location(self):
1541
_locs = ['parent', 'pull', 'x-pull']
1544
return self.control_files.get(l).read().strip('\n')
1550
def push(self, target, overwrite=False, stop_revision=None,
1551
_override_hook_source_branch=None):
1554
This is the basic concrete implementation of push()
1556
:param _override_hook_source_branch: If specified, run
1557
the hooks passing this Branch as the source, rather than self.
1558
This is for use of RemoteBranch, where push is delegated to the
1559
underlying vfs-based Branch.
1561
# TODO: Public option to disable running hooks - should be trivial but
1565
result = self._push_with_bound_branches(target, overwrite,
1567
_override_hook_source_branch=_override_hook_source_branch)
1572
def _push_with_bound_branches(self, target, overwrite,
1574
_override_hook_source_branch=None):
1575
"""Push from self into target, and into target's master if any.
1577
This is on the base BzrBranch class even though it doesn't support
1578
bound branches because the *target* might be bound.
1581
if _override_hook_source_branch:
1582
result.source_branch = _override_hook_source_branch
1583
for hook in Branch.hooks['post_push']:
1586
bound_location = target.get_bound_location()
1587
if bound_location and target.base != bound_location:
1588
# there is a master branch.
1590
# XXX: Why the second check? Is it even supported for a branch to
1591
# be bound to itself? -- mbp 20070507
1592
master_branch = target.get_master_branch()
1593
master_branch.lock_write()
1595
# push into the master from this branch.
1596
self._basic_push(master_branch, overwrite, stop_revision)
1597
# and push into the target branch from this. Note that we push from
1598
# this branch again, because its considered the highest bandwidth
1600
result = self._basic_push(target, overwrite, stop_revision)
1601
result.master_branch = master_branch
1602
result.local_branch = target
1606
master_branch.unlock()
1609
result = self._basic_push(target, overwrite, stop_revision)
1610
# TODO: Why set master_branch and local_branch if there's no
1611
# binding? Maybe cleaner to just leave them unset? -- mbp
1613
result.master_branch = target
1614
result.local_branch = None
1618
def _basic_push(self, target, overwrite, stop_revision):
1619
"""Basic implementation of push without bound branches or hooks.
1621
Must be called with self read locked and target write locked.
1623
result = PushResult()
1624
result.source_branch = self
1625
result.target_branch = target
1626
result.old_revno, result.old_revid = target.last_revision_info()
1628
target.update_revisions(self, stop_revision)
1629
except DivergedBranches:
1633
target.set_revision_history(self.revision_history())
1634
result.tag_conflicts = self.tags.merge_to(target.tags)
1635
result.new_revno, result.new_revid = target.last_revision_info()
1638
def get_parent(self):
1639
"""See Branch.get_parent."""
1641
assert self.base[-1] == '/'
1642
parent = self._get_parent_location()
1645
# This is an old-format absolute path to a local branch
1646
# turn it into a url
1647
if parent.startswith('/'):
1648
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1650
return urlutils.join(self.base[:-1], parent)
1651
except errors.InvalidURLJoin, e:
1652
raise errors.InaccessibleParent(parent, self.base)
1654
def set_push_location(self, location):
1655
"""See Branch.set_push_location."""
1656
self.get_config().set_user_option(
1657
'push_location', location,
1658
store=_mod_config.STORE_LOCATION_NORECURSE)
1661
def set_parent(self, url):
1662
"""See Branch.set_parent."""
1663
# TODO: Maybe delete old location files?
1664
# URLs should never be unicode, even on the local fs,
1665
# FIXUP this and get_parent in a future branch format bump:
1666
# read and rewrite the file, and have the new format code read
1667
# using .get not .get_utf8. RBC 20060125
1669
if isinstance(url, unicode):
1671
url = url.encode('ascii')
1672
except UnicodeEncodeError:
1673
raise errors.InvalidURL(url,
1674
"Urls must be 7-bit ascii, "
1675
"use bzrlib.urlutils.escape")
1676
url = urlutils.relative_url(self.base, url)
1677
self._set_parent_location(url)
1679
def _set_parent_location(self, url):
1681
self.control_files._transport.delete('parent')
1683
assert isinstance(url, str)
1684
self.control_files.put_bytes('parent', url + '\n')
1686
@deprecated_function(zero_nine)
1687
def tree_config(self):
1688
"""DEPRECATED; call get_config instead.
1689
TreeConfig has become part of BranchConfig."""
1690
return TreeConfig(self)
1693
class BzrBranch5(BzrBranch):
1694
"""A format 5 branch. This supports new features over plan branches.
1696
It has support for a master_branch which is the data for bound branches.
1704
super(BzrBranch5, self).__init__(_format=_format,
1705
_control_files=_control_files,
1707
_repository=_repository)
1710
def pull(self, source, overwrite=False, stop_revision=None,
1712
"""Pull from source into self, updating my master if any.
1714
:param run_hooks: Private parameter - if false, this branch
1715
is being called because it's the master of the primary branch,
1716
so it should not run its hooks.
1718
bound_location = self.get_bound_location()
1719
master_branch = None
1720
if bound_location and source.base != bound_location:
1721
# not pulling from master, so we need to update master.
1722
master_branch = self.get_master_branch()
1723
master_branch.lock_write()
1726
# pull from source into master.
1727
master_branch.pull(source, overwrite, stop_revision,
1729
return super(BzrBranch5, self).pull(source, overwrite,
1730
stop_revision, _hook_master=master_branch,
1731
run_hooks=run_hooks)
1734
master_branch.unlock()
1736
def get_bound_location(self):
1738
return self.control_files.get_utf8('bound').read()[:-1]
1739
except errors.NoSuchFile:
1743
def get_master_branch(self):
1744
"""Return the branch we are bound to.
1746
:return: Either a Branch, or None
1748
This could memoise the branch, but if thats done
1749
it must be revalidated on each new lock.
1750
So for now we just don't memoise it.
1751
# RBC 20060304 review this decision.
1753
bound_loc = self.get_bound_location()
1757
return Branch.open(bound_loc)
1758
except (errors.NotBranchError, errors.ConnectionError), e:
1759
raise errors.BoundBranchConnectionFailure(
1763
def set_bound_location(self, location):
1764
"""Set the target where this branch is bound to.
1766
:param location: URL to the target branch
1769
self.control_files.put_utf8('bound', location+'\n')
1772
self.control_files._transport.delete('bound')
1778
def bind(self, other):
1779
"""Bind this branch to the branch other.
1781
This does not push or pull data between the branches, though it does
1782
check for divergence to raise an error when the branches are not
1783
either the same, or one a prefix of the other. That behaviour may not
1784
be useful, so that check may be removed in future.
1786
:param other: The branch to bind to
1789
# TODO: jam 20051230 Consider checking if the target is bound
1790
# It is debatable whether you should be able to bind to
1791
# a branch which is itself bound.
1792
# Committing is obviously forbidden,
1793
# but binding itself may not be.
1794
# Since we *have* to check at commit time, we don't
1795
# *need* to check here
1797
# we want to raise diverged if:
1798
# last_rev is not in the other_last_rev history, AND
1799
# other_last_rev is not in our history, and do it without pulling
1801
last_rev = _mod_revision.ensure_null(self.last_revision())
1802
if last_rev != _mod_revision.NULL_REVISION:
1805
other_last_rev = other.last_revision()
1806
if not _mod_revision.is_null(other_last_rev):
1807
# neither branch is new, we have to do some work to
1808
# ascertain diversion.
1809
remote_graph = other.repository.get_revision_graph(
1811
local_graph = self.repository.get_revision_graph(last_rev)
1812
if (last_rev not in remote_graph and
1813
other_last_rev not in local_graph):
1814
raise errors.DivergedBranches(self, other)
1817
self.set_bound_location(other.base)
1821
"""If bound, unbind"""
1822
return self.set_bound_location(None)
1826
"""Synchronise this branch with the master branch if any.
1828
:return: None or the last_revision that was pivoted out during the
1831
master = self.get_master_branch()
1832
if master is not None:
1833
old_tip = _mod_revision.ensure_null(self.last_revision())
1834
self.pull(master, overwrite=True)
1835
if self.repository.get_graph().is_ancestor(old_tip,
1836
_mod_revision.ensure_null(self.last_revision())):
1842
class BzrBranchExperimental(BzrBranch5):
1843
"""Bzr experimental branch format
1846
- a revision-history file.
1848
- a lock dir guarding the branch itself
1849
- all of this stored in a branch/ subdirectory
1850
- works with shared repositories.
1851
- a tag dictionary in the branch
1853
This format is new in bzr 0.15, but shouldn't be used for real data,
1856
This class acts as it's own BranchFormat.
1859
_matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1862
def get_format_string(cls):
1863
"""See BranchFormat.get_format_string()."""
1864
return "Bazaar-NG branch format experimental\n"
1867
def get_format_description(cls):
1868
"""See BranchFormat.get_format_description()."""
1869
return "Experimental branch format"
1872
def get_reference(cls, a_bzrdir):
1873
"""Get the target reference of the branch in a_bzrdir.
1875
format probing must have been completed before calling
1876
this method - it is assumed that the format of the branch
1877
in a_bzrdir is correct.
1879
:param a_bzrdir: The bzrdir to get the branch data from.
1880
:return: None if the branch is not a reference branch.
1885
def _initialize_control_files(cls, a_bzrdir, utf8_files, lock_filename,
1887
branch_transport = a_bzrdir.get_branch_transport(cls)
1888
control_files = lockable_files.LockableFiles(branch_transport,
1889
lock_filename, lock_class)
1890
control_files.create_lock()
1891
control_files.lock_write()
1893
for filename, content in utf8_files:
1894
control_files.put_utf8(filename, content)
1896
control_files.unlock()
1899
def initialize(cls, a_bzrdir):
1900
"""Create a branch of this format in a_bzrdir."""
1901
utf8_files = [('format', cls.get_format_string()),
1902
('revision-history', ''),
1903
('branch-name', ''),
1906
cls._initialize_control_files(a_bzrdir, utf8_files,
1907
'lock', lockdir.LockDir)
1908
return cls.open(a_bzrdir, _found=True)
1911
def open(cls, a_bzrdir, _found=False):
1912
"""Return the branch object for a_bzrdir
1914
_found is a private parameter, do not use it. It is used to indicate
1915
if format probing has already be done.
1918
format = BranchFormat.find_format(a_bzrdir)
1919
assert format.__class__ == cls
1920
transport = a_bzrdir.get_branch_transport(None)
1921
control_files = lockable_files.LockableFiles(transport, 'lock',
1923
return cls(_format=cls,
1924
_control_files=control_files,
1926
_repository=a_bzrdir.find_repository())
1929
def is_supported(cls):
1932
def _make_tags(self):
1933
return BasicTags(self)
1936
def supports_tags(cls):
1940
BranchFormat.register_format(BzrBranchExperimental)
1943
class BzrBranch6(BzrBranch5):
1946
def last_revision_info(self):
1947
revision_string = self.control_files.get('last-revision').read()
1948
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1949
revision_id = cache_utf8.get_cached_utf8(revision_id)
1951
return revno, revision_id
1953
def last_revision(self):
1954
"""Return last revision id, or None"""
1955
revision_id = self.last_revision_info()[1]
1956
if revision_id == _mod_revision.NULL_REVISION:
1960
def _write_last_revision_info(self, revno, revision_id):
1961
"""Simply write out the revision id, with no checks.
1963
Use set_last_revision_info to perform this safely.
1965
Does not update the revision_history cache.
1966
Intended to be called by set_last_revision_info and
1967
_write_revision_history.
1969
if revision_id is None:
1970
revision_id = 'null:'
1971
out_string = '%d %s\n' % (revno, revision_id)
1972
self.control_files.put_bytes('last-revision', out_string)
1975
def set_last_revision_info(self, revno, revision_id):
1976
revision_id = osutils.safe_revision_id(revision_id)
1977
if self._get_append_revisions_only():
1978
self._check_history_violation(revision_id)
1979
self._write_last_revision_info(revno, revision_id)
1980
self._clear_cached_state()
1982
def _check_history_violation(self, revision_id):
1983
last_revision = _mod_revision.ensure_null(self.last_revision())
1984
if _mod_revision.is_null(last_revision):
1986
if last_revision not in self._lefthand_history(revision_id):
1987
raise errors.AppendRevisionsOnlyViolation(self.base)
1989
def _gen_revision_history(self):
1990
"""Generate the revision history from last revision
1992
history = list(self.repository.iter_reverse_revision_history(
1993
self.last_revision()))
1997
def _write_revision_history(self, history):
1998
"""Factored out of set_revision_history.
2000
This performs the actual writing to disk, with format-specific checks.
2001
It is intended to be called by BzrBranch5.set_revision_history.
2003
if len(history) == 0:
2004
last_revision = 'null:'
2006
if history != self._lefthand_history(history[-1]):
2007
raise errors.NotLefthandHistory(history)
2008
last_revision = history[-1]
2009
if self._get_append_revisions_only():
2010
self._check_history_violation(last_revision)
2011
self._write_last_revision_info(len(history), last_revision)
2014
def append_revision(self, *revision_ids):
2015
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
2016
if len(revision_ids) == 0:
2018
prev_revno, prev_revision = self.last_revision_info()
2019
for revision in self.repository.get_revisions(revision_ids):
2020
if prev_revision == _mod_revision.NULL_REVISION:
2021
if revision.parent_ids != []:
2022
raise errors.NotLeftParentDescendant(self, prev_revision,
2023
revision.revision_id)
2025
if revision.parent_ids[0] != prev_revision:
2026
raise errors.NotLeftParentDescendant(self, prev_revision,
2027
revision.revision_id)
2028
prev_revision = revision.revision_id
2029
self.set_last_revision_info(prev_revno + len(revision_ids),
2033
def _set_parent_location(self, url):
2034
"""Set the parent branch"""
2035
self._set_config_location('parent_location', url, make_relative=True)
2038
def _get_parent_location(self):
2039
"""Set the parent branch"""
2040
return self._get_config_location('parent_location')
2042
def set_push_location(self, location):
2043
"""See Branch.set_push_location."""
2044
self._set_config_location('push_location', location)
2046
def set_bound_location(self, location):
2047
"""See Branch.set_push_location."""
2049
config = self.get_config()
2050
if location is None:
2051
if config.get_user_option('bound') != 'True':
2054
config.set_user_option('bound', 'False', warn_masked=True)
2057
self._set_config_location('bound_location', location,
2059
config.set_user_option('bound', 'True', warn_masked=True)
2062
def _get_bound_location(self, bound):
2063
"""Return the bound location in the config file.
2065
Return None if the bound parameter does not match"""
2066
config = self.get_config()
2067
config_bound = (config.get_user_option('bound') == 'True')
2068
if config_bound != bound:
2070
return self._get_config_location('bound_location', config=config)
2072
def get_bound_location(self):
2073
"""See Branch.set_push_location."""
2074
return self._get_bound_location(True)
2076
def get_old_bound_location(self):
2077
"""See Branch.get_old_bound_location"""
2078
return self._get_bound_location(False)
2080
def set_append_revisions_only(self, enabled):
2085
self.get_config().set_user_option('append_revisions_only', value,
2088
def _get_append_revisions_only(self):
2089
value = self.get_config().get_user_option('append_revisions_only')
2090
return value == 'True'
2092
def _synchronize_history(self, destination, revision_id):
2093
"""Synchronize last revision and revision history between branches.
2095
This version is most efficient when the destination is also a
2096
BzrBranch6, but works for BzrBranch5, as long as the destination's
2097
repository contains all the lefthand ancestors of the intended
2098
last_revision. If not, set_last_revision_info will fail.
2100
:param destination: The branch to copy the history into
2101
:param revision_id: The revision-id to truncate history at. May
2102
be None to copy complete history.
2104
if revision_id is None:
2105
revno, revision_id = self.last_revision_info()
2107
# To figure out the revno for a random revision, we need to build
2108
# the revision history, and count its length.
2109
# We don't care about the order, just how long it is.
2110
# Alternatively, we could start at the current location, and count
2111
# backwards. But there is no guarantee that we will find it since
2112
# it may be a merged revision.
2113
revno = len(list(self.repository.iter_reverse_revision_history(
2115
destination.set_last_revision_info(revno, revision_id)
2117
def _make_tags(self):
2118
return BasicTags(self)
2121
######################################################################
2122
# results of operations
2125
class _Result(object):
2127
def _show_tag_conficts(self, to_file):
2128
if not getattr(self, 'tag_conflicts', None):
2130
to_file.write('Conflicting tags:\n')
2131
for name, value1, value2 in self.tag_conflicts:
2132
to_file.write(' %s\n' % (name, ))
2135
class PullResult(_Result):
2136
"""Result of a Branch.pull operation.
2138
:ivar old_revno: Revision number before pull.
2139
:ivar new_revno: Revision number after pull.
2140
:ivar old_revid: Tip revision id before pull.
2141
:ivar new_revid: Tip revision id after pull.
2142
:ivar source_branch: Source (local) branch object.
2143
:ivar master_branch: Master branch of the target, or None.
2144
:ivar target_branch: Target/destination branch object.
2148
# DEPRECATED: pull used to return the change in revno
2149
return self.new_revno - self.old_revno
2151
def report(self, to_file):
2152
if self.old_revid == self.new_revid:
2153
to_file.write('No revisions to pull.\n')
2155
to_file.write('Now on revision %d.\n' % self.new_revno)
2156
self._show_tag_conficts(to_file)
2159
class PushResult(_Result):
2160
"""Result of a Branch.push operation.
2162
:ivar old_revno: Revision number before push.
2163
:ivar new_revno: Revision number after push.
2164
:ivar old_revid: Tip revision id before push.
2165
:ivar new_revid: Tip revision id after push.
2166
:ivar source_branch: Source branch object.
2167
:ivar master_branch: Master branch of the target, or None.
2168
:ivar target_branch: Target/destination branch object.
2172
# DEPRECATED: push used to return the change in revno
2173
return self.new_revno - self.old_revno
2175
def report(self, to_file):
2176
"""Write a human-readable description of the result."""
2177
if self.old_revid == self.new_revid:
2178
to_file.write('No new revisions to push.\n')
2180
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2181
self._show_tag_conficts(to_file)
2184
class BranchCheckResult(object):
2185
"""Results of checking branch consistency.
2190
def __init__(self, branch):
2191
self.branch = branch
2193
def report_results(self, verbose):
2194
"""Report the check results via trace.note.
2196
:param verbose: Requests more detailed display of what was checked,
2199
note('checked branch %s format %s',
2201
self.branch._format)
2204
class Converter5to6(object):
2205
"""Perform an in-place upgrade of format 5 to format 6"""
2207
def convert(self, branch):
2208
# Data for 5 and 6 can peacefully coexist.
2209
format = BzrBranchFormat6()
2210
new_branch = format.open(branch.bzrdir, _found=True)
2212
# Copy source data into target
2213
new_branch.set_last_revision_info(*branch.last_revision_info())
2214
new_branch.set_parent(branch.get_parent())
2215
new_branch.set_bound_location(branch.get_bound_location())
2216
new_branch.set_push_location(branch.get_push_location())
2218
# New branch has no tags by default
2219
new_branch.tags._set_tag_dict({})
2221
# Copying done; now update target format
2222
new_branch.control_files.put_utf8('format',
2223
format.get_format_string())
2225
# Clean up old files
2226
new_branch.control_files._transport.delete('revision-history')
2228
branch.set_parent(None)
2231
branch.set_bound_location(None)
added
removed
bzrlib/branch.py
