1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
from bzrlib.lazy_import import lazy_import
19
lazy_import(globals(), """
23
config as _mod_config,
28
revision as _mod_revision,
34
from bzrlib.config import BranchConfig
35
from bzrlib.tag import (
41
from bzrlib.decorators import needs_read_lock, needs_write_lock
42
from bzrlib.hooks import Hooks
43
from bzrlib.symbol_versioning import (deprecated_method,
46
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
49
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
50
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
51
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
54
# TODO: Maybe include checks for common corruption of newlines, etc?
56
# TODO: Some operations like log might retrieve the same revisions
57
# repeatedly to calculate deltas. We could perhaps have a weakref
58
# cache in memory to make this faster. In general anything can be
59
# cached in memory between lock and unlock operations. .. nb thats
60
# what the transaction identity map provides
63
######################################################################
67
"""Branch holding a history of revisions.
70
Base directory/url of the branch.
72
hooks: An instance of BranchHooks.
74
# this is really an instance variable - FIXME move it there
78
# override this to set the strategy for storing tags
80
return DisabledTags(self)
82
def __init__(self, *ignored, **ignored_too):
83
self.tags = self._make_tags()
84
self._revision_history_cache = None
85
self._revision_id_to_revno_cache = None
88
"""Break a lock if one is present from another instance.
90
Uses the ui factory to ask for confirmation if the lock may be from
93
This will probe the repository for its lock as well.
95
self.control_files.break_lock()
96
self.repository.break_lock()
97
master = self.get_master_branch()
98
if master is not None:
102
def open(base, _unsupported=False, possible_transports=None):
103
"""Open the branch rooted at base.
105
For instance, if the branch is at URL/.bzr/branch,
106
Branch.open(URL) -> a Branch instance.
108
control = bzrdir.BzrDir.open(base, _unsupported,
109
possible_transports=possible_transports)
110
return control.open_branch(_unsupported)
113
def open_from_transport(transport, _unsupported=False):
114
"""Open the branch rooted at transport"""
115
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
116
return control.open_branch(_unsupported)
119
def open_containing(url, possible_transports=None):
120
"""Open an existing branch which contains url.
122
This probes for a branch at url, and searches upwards from there.
124
Basically we keep looking up until we find the control directory or
125
run into the root. If there isn't one, raises NotBranchError.
126
If there is one and it is either an unrecognised format or an unsupported
127
format, UnknownFormatError or UnsupportedFormatError are raised.
128
If there is one, it is returned, along with the unused portion of url.
130
control, relpath = bzrdir.BzrDir.open_containing(url,
132
return control.open_branch(), relpath
134
def get_config(self):
135
return BranchConfig(self)
138
return self.get_config().get_nickname()
140
def _set_nick(self, nick):
141
self.get_config().set_user_option('nickname', nick, warn_masked=True)
143
nick = property(_get_nick, _set_nick)
146
raise NotImplementedError(self.is_locked)
148
def lock_write(self):
149
raise NotImplementedError(self.lock_write)
152
raise NotImplementedError(self.lock_read)
155
raise NotImplementedError(self.unlock)
157
def peek_lock_mode(self):
158
"""Return lock mode for the Branch: 'r', 'w' or None"""
159
raise NotImplementedError(self.peek_lock_mode)
161
def get_physical_lock_status(self):
162
raise NotImplementedError(self.get_physical_lock_status)
165
def get_revision_id_to_revno_map(self):
166
"""Return the revision_id => dotted revno map.
168
This will be regenerated on demand, but will be cached.
170
:return: A dictionary mapping revision_id => dotted revno.
171
This dictionary should not be modified by the caller.
173
if self._revision_id_to_revno_cache is not None:
174
mapping = self._revision_id_to_revno_cache
176
mapping = self._gen_revno_map()
177
self._cache_revision_id_to_revno(mapping)
178
# TODO: jam 20070417 Since this is being cached, should we be returning
180
# I would rather not, and instead just declare that users should not
181
# modify the return value.
184
def _gen_revno_map(self):
185
"""Create a new mapping from revision ids to dotted revnos.
187
Dotted revnos are generated based on the current tip in the revision
189
This is the worker function for get_revision_id_to_revno_map, which
190
just caches the return value.
192
:return: A dictionary mapping revision_id => dotted revno.
194
last_revision = self.last_revision()
195
revision_graph = self.repository.get_revision_graph(last_revision)
196
merge_sorted_revisions = tsort.merge_sort(
201
revision_id_to_revno = dict((rev_id, revno)
202
for seq_num, rev_id, depth, revno, end_of_merge
203
in merge_sorted_revisions)
204
return revision_id_to_revno
206
def leave_lock_in_place(self):
207
"""Tell this branch object not to release the physical lock when this
210
If lock_write doesn't return a token, then this method is not supported.
212
self.control_files.leave_in_place()
214
def dont_leave_lock_in_place(self):
215
"""Tell this branch object to release the physical lock when this
216
object is unlocked, even if it didn't originally acquire it.
218
If lock_write doesn't return a token, then this method is not supported.
220
self.control_files.dont_leave_in_place()
222
def abspath(self, name):
223
"""Return absolute filename for something in the branch
225
XXX: Robert Collins 20051017 what is this used for? why is it a branch
226
method and not a tree method.
228
raise NotImplementedError(self.abspath)
230
def bind(self, other):
231
"""Bind the local branch the other branch.
233
:param other: The branch to bind to
236
raise errors.UpgradeRequired(self.base)
239
def fetch(self, from_branch, last_revision=None, pb=None):
240
"""Copy revisions from from_branch into this branch.
242
:param from_branch: Where to copy from.
243
:param last_revision: What revision to stop at (None for at the end
245
:param pb: An optional progress bar to use.
247
Returns the copied revision count and the failed revisions in a tuple:
250
if self.base == from_branch.base:
253
nested_pb = ui.ui_factory.nested_progress_bar()
258
from_branch.lock_read()
260
if last_revision is None:
261
pb.update('get source history')
262
last_revision = from_branch.last_revision()
263
if last_revision is None:
264
last_revision = _mod_revision.NULL_REVISION
265
return self.repository.fetch(from_branch.repository,
266
revision_id=last_revision,
269
if nested_pb is not None:
273
def get_bound_location(self):
274
"""Return the URL of the branch we are bound to.
276
Older format branches cannot bind, please be sure to use a metadir
281
def get_old_bound_location(self):
282
"""Return the URL of the branch we used to be bound to
284
raise errors.UpgradeRequired(self.base)
286
def get_commit_builder(self, parents, config=None, timestamp=None,
287
timezone=None, committer=None, revprops=None,
289
"""Obtain a CommitBuilder for this branch.
291
:param parents: Revision ids of the parents of the new revision.
292
:param config: Optional configuration to use.
293
:param timestamp: Optional timestamp recorded for commit.
294
:param timezone: Optional timezone for timestamp.
295
:param committer: Optional committer to set for commit.
296
:param revprops: Optional dictionary of revision properties.
297
:param revision_id: Optional revision id.
301
config = self.get_config()
303
return self.repository.get_commit_builder(self, parents, config,
304
timestamp, timezone, committer, revprops, revision_id)
306
def get_master_branch(self, possible_transports=None):
307
"""Return the branch we are bound to.
309
:return: Either a Branch, or None
313
def get_revision_delta(self, revno):
314
"""Return the delta for one revision.
316
The delta is relative to its mainline predecessor, or the
317
empty tree for revision 1.
319
assert isinstance(revno, int)
320
rh = self.revision_history()
321
if not (1 <= revno <= len(rh)):
322
raise errors.InvalidRevisionNumber(revno)
323
return self.repository.get_revision_delta(rh[revno-1])
325
@deprecated_method(zero_sixteen)
326
def get_root_id(self):
327
"""Return the id of this branches root
329
Deprecated: branches don't have root ids-- trees do.
330
Use basis_tree().get_root_id() instead.
332
raise NotImplementedError(self.get_root_id)
334
def print_file(self, file, revision_id):
335
"""Print `file` to stdout."""
336
raise NotImplementedError(self.print_file)
338
def set_revision_history(self, rev_history):
339
raise NotImplementedError(self.set_revision_history)
341
def _cache_revision_history(self, rev_history):
342
"""Set the cached revision history to rev_history.
344
The revision_history method will use this cache to avoid regenerating
345
the revision history.
347
This API is semi-public; it only for use by subclasses, all other code
348
should consider it to be private.
350
self._revision_history_cache = rev_history
352
def _cache_revision_id_to_revno(self, revision_id_to_revno):
353
"""Set the cached revision_id => revno map to revision_id_to_revno.
355
This API is semi-public; it only for use by subclasses, all other code
356
should consider it to be private.
358
self._revision_id_to_revno_cache = revision_id_to_revno
360
def _clear_cached_state(self):
361
"""Clear any cached data on this branch, e.g. cached revision history.
363
This means the next call to revision_history will need to call
364
_gen_revision_history.
366
This API is semi-public; it only for use by subclasses, all other code
367
should consider it to be private.
369
self._revision_history_cache = None
370
self._revision_id_to_revno_cache = None
372
def _gen_revision_history(self):
373
"""Return sequence of revision hashes on to this branch.
375
Unlike revision_history, this method always regenerates or rereads the
376
revision history, i.e. it does not cache the result, so repeated calls
379
Concrete subclasses should override this instead of revision_history so
380
that subclasses do not need to deal with caching logic.
382
This API is semi-public; it only for use by subclasses, all other code
383
should consider it to be private.
385
raise NotImplementedError(self._gen_revision_history)
388
def revision_history(self):
389
"""Return sequence of revision ids on this branch.
391
This method will cache the revision history for as long as it is safe to
394
if 'evil' in debug.debug_flags:
395
mutter_callsite(3, "revision_history scales with history.")
396
if self._revision_history_cache is not None:
397
history = self._revision_history_cache
399
history = self._gen_revision_history()
400
self._cache_revision_history(history)
404
"""Return current revision number for this branch.
406
That is equivalent to the number of revisions committed to
409
return self.last_revision_info()[0]
412
"""Older format branches cannot bind or unbind."""
413
raise errors.UpgradeRequired(self.base)
415
def set_append_revisions_only(self, enabled):
416
"""Older format branches are never restricted to append-only"""
417
raise errors.UpgradeRequired(self.base)
419
def last_revision(self):
420
"""Return last revision id, or NULL_REVISION."""
421
return self.last_revision_info()[1]
423
def last_revision_info(self):
424
"""Return information about the last revision.
426
:return: A tuple (revno, last_revision_id).
428
rh = self.revision_history()
431
return (revno, rh[-1])
433
return (0, _mod_revision.NULL_REVISION)
435
def missing_revisions(self, other, stop_revision=None):
436
"""Return a list of new revisions that would perfectly fit.
438
If self and other have not diverged, return a list of the revisions
439
present in other, but missing from self.
441
self_history = self.revision_history()
442
self_len = len(self_history)
443
other_history = other.revision_history()
444
other_len = len(other_history)
445
common_index = min(self_len, other_len) -1
446
if common_index >= 0 and \
447
self_history[common_index] != other_history[common_index]:
448
raise errors.DivergedBranches(self, other)
450
if stop_revision is None:
451
stop_revision = other_len
453
assert isinstance(stop_revision, int)
454
if stop_revision > other_len:
455
raise errors.NoSuchRevision(self, stop_revision)
456
return other_history[self_len:stop_revision]
458
def update_revisions(self, other, stop_revision=None):
459
"""Pull in new perfect-fit revisions.
461
:param other: Another Branch to pull from
462
:param stop_revision: Updated until the given revision
465
raise NotImplementedError(self.update_revisions)
467
def revision_id_to_revno(self, revision_id):
468
"""Given a revision id, return its revno"""
469
if _mod_revision.is_null(revision_id):
471
history = self.revision_history()
473
return history.index(revision_id) + 1
475
raise errors.NoSuchRevision(self, revision_id)
477
def get_rev_id(self, revno, history=None):
478
"""Find the revision id of the specified revno."""
480
return _mod_revision.NULL_REVISION
482
history = self.revision_history()
483
if revno <= 0 or revno > len(history):
484
raise errors.NoSuchRevision(self, revno)
485
return history[revno - 1]
487
def pull(self, source, overwrite=False, stop_revision=None,
488
possible_transports=None):
489
"""Mirror source into this branch.
491
This branch is considered to be 'local', having low latency.
493
:returns: PullResult instance
495
raise NotImplementedError(self.pull)
497
def push(self, target, overwrite=False, stop_revision=None):
498
"""Mirror this branch into target.
500
This branch is considered to be 'local', having low latency.
502
raise NotImplementedError(self.push)
504
def basis_tree(self):
505
"""Return `Tree` object for last revision."""
506
return self.repository.revision_tree(self.last_revision())
508
def rename_one(self, from_rel, to_rel):
511
This can change the directory or the filename or both.
513
raise NotImplementedError(self.rename_one)
515
def move(self, from_paths, to_name):
518
to_name must exist as a versioned directory.
520
If to_name exists and is a directory, the files are moved into
521
it, keeping their old names. If it is a directory,
523
Note that to_name is only the last component of the new name;
524
this doesn't change the directory.
526
This returns a list of (from_path, to_path) pairs for each
529
raise NotImplementedError(self.move)
531
def get_parent(self):
532
"""Return the parent location of the branch.
534
This is the default location for push/pull/missing. The usual
535
pattern is that the user can override it by specifying a
538
raise NotImplementedError(self.get_parent)
540
def _set_config_location(self, name, url, config=None,
541
make_relative=False):
543
config = self.get_config()
547
url = urlutils.relative_url(self.base, url)
548
config.set_user_option(name, url, warn_masked=True)
550
def _get_config_location(self, name, config=None):
552
config = self.get_config()
553
location = config.get_user_option(name)
558
def get_submit_branch(self):
559
"""Return the submit location of the branch.
561
This is the default location for bundle. The usual
562
pattern is that the user can override it by specifying a
565
return self.get_config().get_user_option('submit_branch')
567
def set_submit_branch(self, location):
568
"""Return the submit location of the branch.
570
This is the default location for bundle. The usual
571
pattern is that the user can override it by specifying a
574
self.get_config().set_user_option('submit_branch', location,
577
def get_public_branch(self):
578
"""Return the public location of the branch.
580
This is is used by merge directives.
582
return self._get_config_location('public_branch')
584
def set_public_branch(self, location):
585
"""Return the submit location of the branch.
587
This is the default location for bundle. The usual
588
pattern is that the user can override it by specifying a
591
self._set_config_location('public_branch', location)
593
def get_push_location(self):
594
"""Return the None or the location to push this branch to."""
595
push_loc = self.get_config().get_user_option('push_location')
598
def set_push_location(self, location):
599
"""Set a new push location for this branch."""
600
raise NotImplementedError(self.set_push_location)
602
def set_parent(self, url):
603
raise NotImplementedError(self.set_parent)
607
"""Synchronise this branch with the master branch if any.
609
:return: None or the last_revision pivoted out during the update.
613
def check_revno(self, revno):
615
Check whether a revno corresponds to any revision.
616
Zero (the NULL revision) is considered valid.
619
self.check_real_revno(revno)
621
def check_real_revno(self, revno):
623
Check whether a revno corresponds to a real revision.
624
Zero (the NULL revision) is considered invalid
626
if revno < 1 or revno > self.revno():
627
raise errors.InvalidRevisionNumber(revno)
630
def clone(self, to_bzrdir, revision_id=None):
631
"""Clone this branch into to_bzrdir preserving all semantic values.
633
revision_id: if not None, the revision history in the new branch will
634
be truncated to end with revision_id.
636
result = self._format.initialize(to_bzrdir)
637
self.copy_content_into(result, revision_id=revision_id)
641
def sprout(self, to_bzrdir, revision_id=None):
642
"""Create a new line of development from the branch, into to_bzrdir.
644
revision_id: if not None, the revision history in the new branch will
645
be truncated to end with revision_id.
647
result = self._format.initialize(to_bzrdir)
648
self.copy_content_into(result, revision_id=revision_id)
649
result.set_parent(self.bzrdir.root_transport.base)
652
def _synchronize_history(self, destination, revision_id):
653
"""Synchronize last revision and revision history between branches.
655
This version is most efficient when the destination is also a
656
BzrBranch5, but works for BzrBranch6 as long as the revision
657
history is the true lefthand parent history, and all of the revisions
658
are in the destination's repository. If not, set_revision_history
661
:param destination: The branch to copy the history into
662
:param revision_id: The revision-id to truncate history at. May
663
be None to copy complete history.
665
if revision_id == _mod_revision.NULL_REVISION:
667
new_history = self.revision_history()
668
if revision_id is not None and new_history != []:
670
new_history = new_history[:new_history.index(revision_id) + 1]
672
rev = self.repository.get_revision(revision_id)
673
new_history = rev.get_history(self.repository)[1:]
674
destination.set_revision_history(new_history)
677
def copy_content_into(self, destination, revision_id=None):
678
"""Copy the content of self into destination.
680
revision_id: if not None, the revision history in the new branch will
681
be truncated to end with revision_id.
683
self._synchronize_history(destination, revision_id)
685
parent = self.get_parent()
686
except errors.InaccessibleParent, e:
687
mutter('parent was not accessible to copy: %s', e)
690
destination.set_parent(parent)
691
self.tags.merge_to(destination.tags)
695
"""Check consistency of the branch.
697
In particular this checks that revisions given in the revision-history
698
do actually match up in the revision graph, and that they're all
699
present in the repository.
701
Callers will typically also want to check the repository.
703
:return: A BranchCheckResult.
705
mainline_parent_id = None
706
for revision_id in self.revision_history():
708
revision = self.repository.get_revision(revision_id)
709
except errors.NoSuchRevision, e:
710
raise errors.BzrCheckError("mainline revision {%s} not in repository"
712
# In general the first entry on the revision history has no parents.
713
# But it's not illegal for it to have parents listed; this can happen
714
# in imports from Arch when the parents weren't reachable.
715
if mainline_parent_id is not None:
716
if mainline_parent_id not in revision.parent_ids:
717
raise errors.BzrCheckError("previous revision {%s} not listed among "
719
% (mainline_parent_id, revision_id))
720
mainline_parent_id = revision_id
721
return BranchCheckResult(self)
723
def _get_checkout_format(self):
724
"""Return the most suitable metadir for a checkout of this branch.
725
Weaves are used if this branch's repository uses weaves.
727
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
728
from bzrlib.repofmt import weaverepo
729
format = bzrdir.BzrDirMetaFormat1()
730
format.repository_format = weaverepo.RepositoryFormat7()
732
format = self.repository.bzrdir.checkout_metadir()
733
format.set_branch_format(self._format)
736
def create_checkout(self, to_location, revision_id=None,
737
lightweight=False, accelerator_tree=None,
739
"""Create a checkout of a branch.
741
:param to_location: The url to produce the checkout at
742
:param revision_id: The revision to check out
743
:param lightweight: If True, produce a lightweight checkout, otherwise,
744
produce a bound branch (heavyweight checkout)
745
:param accelerator_tree: A tree which can be used for retrieving file
746
contents more quickly than the revision tree, i.e. a workingtree.
747
The revision tree will be used for cases where accelerator_tree's
748
content is different.
749
:param hardlink: If true, hard-link files from accelerator_tree,
751
:return: The tree of the created checkout
753
t = transport.get_transport(to_location)
756
format = self._get_checkout_format()
757
checkout = format.initialize_on_transport(t)
758
from_branch = BranchReferenceFormat().initialize(checkout, self)
760
format = self._get_checkout_format()
761
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
762
to_location, force_new_tree=False, format=format)
763
checkout = checkout_branch.bzrdir
764
checkout_branch.bind(self)
765
# pull up to the specified revision_id to set the initial
766
# branch tip correctly, and seed it with history.
767
checkout_branch.pull(self, stop_revision=revision_id)
769
tree = checkout.create_workingtree(revision_id,
770
from_branch=from_branch,
771
accelerator_tree=accelerator_tree,
773
basis_tree = tree.basis_tree()
774
basis_tree.lock_read()
776
for path, file_id in basis_tree.iter_references():
777
reference_parent = self.reference_parent(file_id, path)
778
reference_parent.create_checkout(tree.abspath(path),
779
basis_tree.get_reference_revision(file_id, path),
785
def reference_parent(self, file_id, path):
786
"""Return the parent branch for a tree-reference file_id
787
:param file_id: The file_id of the tree reference
788
:param path: The path of the file_id in the tree
789
:return: A branch associated with the file_id
791
# FIXME should provide multiple branches, based on config
792
return Branch.open(self.bzrdir.root_transport.clone(path).base)
794
def supports_tags(self):
795
return self._format.supports_tags()
798
class BranchFormat(object):
799
"""An encapsulation of the initialization and open routines for a format.
801
Formats provide three things:
802
* An initialization routine,
806
Formats are placed in an dict by their format string for reference
807
during branch opening. Its not required that these be instances, they
808
can be classes themselves with class methods - it simply depends on
809
whether state is needed for a given format or not.
811
Once a format is deprecated, just deprecate the initialize and open
812
methods on the format class. Do not deprecate the object, as the
813
object will be created every time regardless.
816
_default_format = None
817
"""The default format used for new branches."""
820
"""The known formats."""
822
def __eq__(self, other):
823
return self.__class__ is other.__class__
825
def __ne__(self, other):
826
return not (self == other)
829
def find_format(klass, a_bzrdir):
830
"""Return the format for the branch object in a_bzrdir."""
832
transport = a_bzrdir.get_branch_transport(None)
833
format_string = transport.get("format").read()
834
return klass._formats[format_string]
835
except errors.NoSuchFile:
836
raise errors.NotBranchError(path=transport.base)
838
raise errors.UnknownFormatError(format=format_string)
841
def get_default_format(klass):
842
"""Return the current default format."""
843
return klass._default_format
845
def get_reference(self, a_bzrdir):
846
"""Get the target reference of the branch in a_bzrdir.
848
format probing must have been completed before calling
849
this method - it is assumed that the format of the branch
850
in a_bzrdir is correct.
852
:param a_bzrdir: The bzrdir to get the branch data from.
853
:return: None if the branch is not a reference branch.
858
def set_reference(self, a_bzrdir, to_branch):
859
"""Set the target reference of the branch in a_bzrdir.
861
format probing must have been completed before calling
862
this method - it is assumed that the format of the branch
863
in a_bzrdir is correct.
865
:param a_bzrdir: The bzrdir to set the branch reference for.
866
:param to_branch: branch that the checkout is to reference
868
raise NotImplementedError(self.set_reference)
870
def get_format_string(self):
871
"""Return the ASCII format string that identifies this format."""
872
raise NotImplementedError(self.get_format_string)
874
def get_format_description(self):
875
"""Return the short format description for this format."""
876
raise NotImplementedError(self.get_format_description)
878
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
880
"""Initialize a branch in a bzrdir, with specified files
882
:param a_bzrdir: The bzrdir to initialize the branch in
883
:param utf8_files: The files to create as a list of
884
(filename, content) tuples
885
:param set_format: If True, set the format with
886
self.get_format_string. (BzrBranch4 has its format set
888
:return: a branch in this format
890
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
891
branch_transport = a_bzrdir.get_branch_transport(self)
893
'metadir': ('lock', lockdir.LockDir),
894
'branch4': ('branch-lock', lockable_files.TransportLock),
896
lock_name, lock_class = lock_map[lock_type]
897
control_files = lockable_files.LockableFiles(branch_transport,
898
lock_name, lock_class)
899
control_files.create_lock()
900
control_files.lock_write()
902
control_files.put_utf8('format', self.get_format_string())
904
for file, content in utf8_files:
905
control_files.put_utf8(file, content)
907
control_files.unlock()
908
return self.open(a_bzrdir, _found=True)
910
def initialize(self, a_bzrdir):
911
"""Create a branch of this format in a_bzrdir."""
912
raise NotImplementedError(self.initialize)
914
def is_supported(self):
915
"""Is this format supported?
917
Supported formats can be initialized and opened.
918
Unsupported formats may not support initialization or committing or
919
some other features depending on the reason for not being supported.
923
def open(self, a_bzrdir, _found=False):
924
"""Return the branch object for a_bzrdir
926
_found is a private parameter, do not use it. It is used to indicate
927
if format probing has already be done.
929
raise NotImplementedError(self.open)
932
def register_format(klass, format):
933
klass._formats[format.get_format_string()] = format
936
def set_default_format(klass, format):
937
klass._default_format = format
940
def unregister_format(klass, format):
941
assert klass._formats[format.get_format_string()] is format
942
del klass._formats[format.get_format_string()]
945
return self.get_format_string().rstrip()
947
def supports_tags(self):
948
"""True if this format supports tags stored in the branch"""
949
return False # by default
951
# XXX: Probably doesn't really belong here -- mbp 20070212
952
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
954
branch_transport = a_bzrdir.get_branch_transport(self)
955
control_files = lockable_files.LockableFiles(branch_transport,
956
lock_filename, lock_class)
957
control_files.create_lock()
958
control_files.lock_write()
960
for filename, content in utf8_files:
961
control_files.put_utf8(filename, content)
963
control_files.unlock()
966
class BranchHooks(Hooks):
967
"""A dictionary mapping hook name to a list of callables for branch hooks.
969
e.g. ['set_rh'] Is the list of items to be called when the
970
set_revision_history function is invoked.
974
"""Create the default hooks.
976
These are all empty initially, because by default nothing should get
980
# Introduced in 0.15:
981
# invoked whenever the revision history has been set
982
# with set_revision_history. The api signature is
983
# (branch, revision_history), and the branch will
986
# invoked after a push operation completes.
987
# the api signature is
989
# containing the members
990
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
991
# where local is the local target branch or None, master is the target
992
# master branch, and the rest should be self explanatory. The source
993
# is read locked and the target branches write locked. Source will
994
# be the local low-latency branch.
995
self['post_push'] = []
996
# invoked after a pull operation completes.
997
# the api signature is
999
# containing the members
1000
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1001
# where local is the local branch or None, master is the target
1002
# master branch, and the rest should be self explanatory. The source
1003
# is read locked and the target branches write locked. The local
1004
# branch is the low-latency branch.
1005
self['post_pull'] = []
1006
# invoked before a commit operation takes place.
1007
# the api signature is
1008
# (local, master, old_revno, old_revid, future_revno, future_revid,
1009
# tree_delta, future_tree).
1010
# old_revid is NULL_REVISION for the first commit to a branch
1011
# tree_delta is a TreeDelta object describing changes from the basis
1012
# revision, hooks MUST NOT modify this delta
1013
# future_tree is an in-memory tree obtained from
1014
# CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
1015
self['pre_commit'] = []
1016
# invoked after a commit operation completes.
1017
# the api signature is
1018
# (local, master, old_revno, old_revid, new_revno, new_revid)
1019
# old_revid is NULL_REVISION for the first commit to a branch.
1020
self['post_commit'] = []
1021
# invoked after a uncommit operation completes.
1022
# the api signature is
1023
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1024
# local is the local branch or None, master is the target branch,
1025
# and an empty branch recieves new_revno of 0, new_revid of None.
1026
self['post_uncommit'] = []
1029
# install the default hooks into the Branch class.
1030
Branch.hooks = BranchHooks()
1033
class BzrBranchFormat4(BranchFormat):
1034
"""Bzr branch format 4.
1037
- a revision-history file.
1038
- a branch-lock lock file [ to be shared with the bzrdir ]
1041
def get_format_description(self):
1042
"""See BranchFormat.get_format_description()."""
1043
return "Branch format 4"
1045
def initialize(self, a_bzrdir):
1046
"""Create a branch of this format in a_bzrdir."""
1047
utf8_files = [('revision-history', ''),
1048
('branch-name', ''),
1050
return self._initialize_helper(a_bzrdir, utf8_files,
1051
lock_type='branch4', set_format=False)
1054
super(BzrBranchFormat4, self).__init__()
1055
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1057
def open(self, a_bzrdir, _found=False):
1058
"""Return the branch object for a_bzrdir
1060
_found is a private parameter, do not use it. It is used to indicate
1061
if format probing has already be done.
1064
# we are being called directly and must probe.
1065
raise NotImplementedError
1066
return BzrBranch(_format=self,
1067
_control_files=a_bzrdir._control_files,
1069
_repository=a_bzrdir.open_repository())
1072
return "Bazaar-NG branch format 4"
1075
class BzrBranchFormat5(BranchFormat):
1076
"""Bzr branch format 5.
1079
- a revision-history file.
1081
- a lock dir guarding the branch itself
1082
- all of this stored in a branch/ subdirectory
1083
- works with shared repositories.
1085
This format is new in bzr 0.8.
1088
def get_format_string(self):
1089
"""See BranchFormat.get_format_string()."""
1090
return "Bazaar-NG branch format 5\n"
1092
def get_format_description(self):
1093
"""See BranchFormat.get_format_description()."""
1094
return "Branch format 5"
1096
def initialize(self, a_bzrdir):
1097
"""Create a branch of this format in a_bzrdir."""
1098
utf8_files = [('revision-history', ''),
1099
('branch-name', ''),
1101
return self._initialize_helper(a_bzrdir, utf8_files)
1104
super(BzrBranchFormat5, self).__init__()
1105
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1107
def open(self, a_bzrdir, _found=False):
1108
"""Return the branch object for a_bzrdir
1110
_found is a private parameter, do not use it. It is used to indicate
1111
if format probing has already be done.
1114
format = BranchFormat.find_format(a_bzrdir)
1115
assert format.__class__ == self.__class__
1117
transport = a_bzrdir.get_branch_transport(None)
1118
control_files = lockable_files.LockableFiles(transport, 'lock',
1120
return BzrBranch5(_format=self,
1121
_control_files=control_files,
1123
_repository=a_bzrdir.find_repository())
1124
except errors.NoSuchFile:
1125
raise errors.NotBranchError(path=transport.base)
1128
class BzrBranchFormat6(BzrBranchFormat5):
1129
"""Branch format with last-revision and tags.
1131
Unlike previous formats, this has no explicit revision history. Instead,
1132
this just stores the last-revision, and the left-hand history leading
1133
up to there is the history.
1135
This format was introduced in bzr 0.15
1136
and became the default in 0.91.
1139
def get_format_string(self):
1140
"""See BranchFormat.get_format_string()."""
1141
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1143
def get_format_description(self):
1144
"""See BranchFormat.get_format_description()."""
1145
return "Branch format 6"
1147
def initialize(self, a_bzrdir):
1148
"""Create a branch of this format in a_bzrdir."""
1149
utf8_files = [('last-revision', '0 null:\n'),
1150
('branch.conf', ''),
1153
return self._initialize_helper(a_bzrdir, utf8_files)
1155
def open(self, a_bzrdir, _found=False):
1156
"""Return the branch object for a_bzrdir
1158
_found is a private parameter, do not use it. It is used to indicate
1159
if format probing has already be done.
1162
format = BranchFormat.find_format(a_bzrdir)
1163
assert format.__class__ == self.__class__
1164
transport = a_bzrdir.get_branch_transport(None)
1165
control_files = lockable_files.LockableFiles(transport, 'lock',
1167
return BzrBranch6(_format=self,
1168
_control_files=control_files,
1170
_repository=a_bzrdir.find_repository())
1172
def supports_tags(self):
1176
class BranchReferenceFormat(BranchFormat):
1177
"""Bzr branch reference format.
1179
Branch references are used in implementing checkouts, they
1180
act as an alias to the real branch which is at some other url.
1187
def get_format_string(self):
1188
"""See BranchFormat.get_format_string()."""
1189
return "Bazaar-NG Branch Reference Format 1\n"
1191
def get_format_description(self):
1192
"""See BranchFormat.get_format_description()."""
1193
return "Checkout reference format 1"
1195
def get_reference(self, a_bzrdir):
1196
"""See BranchFormat.get_reference()."""
1197
transport = a_bzrdir.get_branch_transport(None)
1198
return transport.get('location').read()
1200
def set_reference(self, a_bzrdir, to_branch):
1201
"""See BranchFormat.set_reference()."""
1202
transport = a_bzrdir.get_branch_transport(None)
1203
location = transport.put_bytes('location', to_branch.base)
1205
def initialize(self, a_bzrdir, target_branch=None):
1206
"""Create a branch of this format in a_bzrdir."""
1207
if target_branch is None:
1208
# this format does not implement branch itself, thus the implicit
1209
# creation contract must see it as uninitializable
1210
raise errors.UninitializableFormat(self)
1211
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1212
branch_transport = a_bzrdir.get_branch_transport(self)
1213
branch_transport.put_bytes('location',
1214
target_branch.bzrdir.root_transport.base)
1215
branch_transport.put_bytes('format', self.get_format_string())
1217
a_bzrdir, _found=True,
1218
possible_transports=[target_branch.bzrdir.root_transport])
1221
super(BranchReferenceFormat, self).__init__()
1222
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1224
def _make_reference_clone_function(format, a_branch):
1225
"""Create a clone() routine for a branch dynamically."""
1226
def clone(to_bzrdir, revision_id=None):
1227
"""See Branch.clone()."""
1228
return format.initialize(to_bzrdir, a_branch)
1229
# cannot obey revision_id limits when cloning a reference ...
1230
# FIXME RBC 20060210 either nuke revision_id for clone, or
1231
# emit some sort of warning/error to the caller ?!
1234
def open(self, a_bzrdir, _found=False, location=None,
1235
possible_transports=None):
1236
"""Return the branch that the branch reference in a_bzrdir points at.
1238
_found is a private parameter, do not use it. It is used to indicate
1239
if format probing has already be done.
1242
format = BranchFormat.find_format(a_bzrdir)
1243
assert format.__class__ == self.__class__
1244
if location is None:
1245
location = self.get_reference(a_bzrdir)
1246
real_bzrdir = bzrdir.BzrDir.open(
1247
location, possible_transports=possible_transports)
1248
result = real_bzrdir.open_branch()
1249
# this changes the behaviour of result.clone to create a new reference
1250
# rather than a copy of the content of the branch.
1251
# I did not use a proxy object because that needs much more extensive
1252
# testing, and we are only changing one behaviour at the moment.
1253
# If we decide to alter more behaviours - i.e. the implicit nickname
1254
# then this should be refactored to introduce a tested proxy branch
1255
# and a subclass of that for use in overriding clone() and ....
1257
result.clone = self._make_reference_clone_function(result)
1261
# formats which have no format string are not discoverable
1262
# and not independently creatable, so are not registered.
1263
__format5 = BzrBranchFormat5()
1264
__format6 = BzrBranchFormat6()
1265
BranchFormat.register_format(__format5)
1266
BranchFormat.register_format(BranchReferenceFormat())
1267
BranchFormat.register_format(__format6)
1268
BranchFormat.set_default_format(__format6)
1269
_legacy_formats = [BzrBranchFormat4(),
1272
class BzrBranch(Branch):
1273
"""A branch stored in the actual filesystem.
1275
Note that it's "local" in the context of the filesystem; it doesn't
1276
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1277
it's writable, and can be accessed via the normal filesystem API.
1280
def __init__(self, _format=None,
1281
_control_files=None, a_bzrdir=None, _repository=None):
1282
"""Create new branch object at a particular location."""
1283
Branch.__init__(self)
1284
if a_bzrdir is None:
1285
raise ValueError('a_bzrdir must be supplied')
1287
self.bzrdir = a_bzrdir
1288
# self._transport used to point to the directory containing the
1289
# control directory, but was not used - now it's just the transport
1290
# for the branch control files. mbp 20070212
1291
self._base = self.bzrdir.transport.clone('..').base
1292
self._format = _format
1293
if _control_files is None:
1294
raise ValueError('BzrBranch _control_files is None')
1295
self.control_files = _control_files
1296
self._transport = _control_files._transport
1297
self.repository = _repository
1300
return '%s(%r)' % (self.__class__.__name__, self.base)
1304
def _get_base(self):
1305
"""Returns the directory containing the control directory."""
1308
base = property(_get_base, doc="The URL for the root of this branch.")
1310
def abspath(self, name):
1311
"""See Branch.abspath."""
1312
return self.control_files._transport.abspath(name)
1315
@deprecated_method(zero_sixteen)
1317
def get_root_id(self):
1318
"""See Branch.get_root_id."""
1319
tree = self.repository.revision_tree(self.last_revision())
1320
return tree.get_root_id()
1322
def is_locked(self):
1323
return self.control_files.is_locked()
1325
def lock_write(self, token=None):
1326
repo_token = self.repository.lock_write()
1328
token = self.control_files.lock_write(token=token)
1330
self.repository.unlock()
1334
def lock_read(self):
1335
self.repository.lock_read()
1337
self.control_files.lock_read()
1339
self.repository.unlock()
1343
# TODO: test for failed two phase locks. This is known broken.
1345
self.control_files.unlock()
1347
self.repository.unlock()
1348
if not self.control_files.is_locked():
1349
# we just released the lock
1350
self._clear_cached_state()
1352
def peek_lock_mode(self):
1353
if self.control_files._lock_count == 0:
1356
return self.control_files._lock_mode
1358
def get_physical_lock_status(self):
1359
return self.control_files.get_physical_lock_status()
1362
def print_file(self, file, revision_id):
1363
"""See Branch.print_file."""
1364
return self.repository.print_file(file, revision_id)
1366
def _write_revision_history(self, history):
1367
"""Factored out of set_revision_history.
1369
This performs the actual writing to disk.
1370
It is intended to be called by BzrBranch5.set_revision_history."""
1371
self.control_files.put_bytes(
1372
'revision-history', '\n'.join(history))
1375
def set_revision_history(self, rev_history):
1376
"""See Branch.set_revision_history."""
1377
if 'evil' in debug.debug_flags:
1378
mutter_callsite(3, "set_revision_history scales with history.")
1379
self._clear_cached_state()
1380
self._write_revision_history(rev_history)
1381
self._cache_revision_history(rev_history)
1382
for hook in Branch.hooks['set_rh']:
1383
hook(self, rev_history)
1386
def set_last_revision_info(self, revno, revision_id):
1387
"""Set the last revision of this branch.
1389
The caller is responsible for checking that the revno is correct
1390
for this revision id.
1392
It may be possible to set the branch last revision to an id not
1393
present in the repository. However, branches can also be
1394
configured to check constraints on history, in which case this may not
1397
history = self._lefthand_history(revision_id)
1398
assert len(history) == revno, '%d != %d' % (len(history), revno)
1399
self.set_revision_history(history)
1401
def _gen_revision_history(self):
1402
history = self.control_files.get('revision-history').read().split('\n')
1403
if history[-1:] == ['']:
1404
# There shouldn't be a trailing newline, but just in case.
1408
def _lefthand_history(self, revision_id, last_rev=None,
1410
if 'evil' in debug.debug_flags:
1411
mutter_callsite(4, "_lefthand_history scales with history.")
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 != _mod_revision.NULL_REVISION
1415
and last_rev not in stop_graph):
1416
# our previous tip is not merged into stop_revision
1417
raise errors.DivergedBranches(self, other_branch)
1418
# make a new revision history from the graph
1419
current_rev_id = revision_id
1421
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1422
new_history.append(current_rev_id)
1423
current_rev_id_parents = stop_graph[current_rev_id]
1425
current_rev_id = current_rev_id_parents[0]
1427
current_rev_id = None
1428
new_history.reverse()
1432
def generate_revision_history(self, revision_id, last_rev=None,
1434
"""Create a new revision history that will finish with revision_id.
1436
:param revision_id: the new tip to use.
1437
:param last_rev: The previous last_revision. If not None, then this
1438
must be a ancestory of revision_id, or DivergedBranches is raised.
1439
:param other_branch: The other branch that DivergedBranches should
1440
raise with respect to.
1442
self.set_revision_history(self._lefthand_history(revision_id,
1443
last_rev, other_branch))
1446
def update_revisions(self, other, stop_revision=None, overwrite=False):
1447
"""See Branch.update_revisions."""
1450
other_last_revno, other_last_revision = other.last_revision_info()
1451
if stop_revision is None:
1452
stop_revision = other_last_revision
1453
if _mod_revision.is_null(stop_revision):
1454
# if there are no commits, we're done.
1456
# whats the current last revision, before we fetch [and change it
1458
last_rev = _mod_revision.ensure_null(self.last_revision())
1459
# we fetch here so that we don't process data twice in the common
1460
# case of having something to pull, and so that the check for
1461
# already merged can operate on the just fetched graph, which will
1462
# be cached in memory.
1463
self.fetch(other, stop_revision)
1464
# Check to see if one is an ancestor of the other
1466
heads = self.repository.get_graph().heads([stop_revision,
1468
if heads == set([last_rev]):
1469
# The current revision is a decendent of the target,
1472
elif heads == set([stop_revision, last_rev]):
1473
# These branches have diverged
1474
raise errors.DivergedBranches(self, other)
1475
assert heads == set([stop_revision])
1476
if other_last_revision == stop_revision:
1477
self.set_last_revision_info(other_last_revno,
1478
other_last_revision)
1480
# TODO: jam 2007-11-29 Is there a way to determine the
1481
# revno without searching all of history??
1483
self.generate_revision_history(stop_revision)
1485
self.generate_revision_history(stop_revision,
1486
last_rev=last_rev, other_branch=other)
1490
def basis_tree(self):
1491
"""See Branch.basis_tree."""
1492
return self.repository.revision_tree(self.last_revision())
1495
def pull(self, source, overwrite=False, stop_revision=None,
1496
_hook_master=None, run_hooks=True, possible_transports=None):
1499
:param _hook_master: Private parameter - set the branch to
1500
be supplied as the master to push hooks.
1501
:param run_hooks: Private parameter - if false, this branch
1502
is being called because it's the master of the primary branch,
1503
so it should not run its hooks.
1505
result = PullResult()
1506
result.source_branch = source
1507
result.target_branch = self
1510
result.old_revno, result.old_revid = self.last_revision_info()
1511
self.update_revisions(source, stop_revision, overwrite=overwrite)
1512
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
1513
result.new_revno, result.new_revid = self.last_revision_info()
1515
result.master_branch = _hook_master
1516
result.local_branch = self
1518
result.master_branch = self
1519
result.local_branch = None
1521
for hook in Branch.hooks['post_pull']:
1527
def _get_parent_location(self):
1528
_locs = ['parent', 'pull', 'x-pull']
1531
return self.control_files.get(l).read().strip('\n')
1532
except errors.NoSuchFile:
1537
def push(self, target, overwrite=False, stop_revision=None,
1538
_override_hook_source_branch=None):
1541
This is the basic concrete implementation of push()
1543
:param _override_hook_source_branch: If specified, run
1544
the hooks passing this Branch as the source, rather than self.
1545
This is for use of RemoteBranch, where push is delegated to the
1546
underlying vfs-based Branch.
1548
# TODO: Public option to disable running hooks - should be trivial but
1552
result = self._push_with_bound_branches(target, overwrite,
1554
_override_hook_source_branch=_override_hook_source_branch)
1559
def _push_with_bound_branches(self, target, overwrite,
1561
_override_hook_source_branch=None):
1562
"""Push from self into target, and into target's master if any.
1564
This is on the base BzrBranch class even though it doesn't support
1565
bound branches because the *target* might be bound.
1568
if _override_hook_source_branch:
1569
result.source_branch = _override_hook_source_branch
1570
for hook in Branch.hooks['post_push']:
1573
bound_location = target.get_bound_location()
1574
if bound_location and target.base != bound_location:
1575
# there is a master branch.
1577
# XXX: Why the second check? Is it even supported for a branch to
1578
# be bound to itself? -- mbp 20070507
1579
master_branch = target.get_master_branch()
1580
master_branch.lock_write()
1582
# push into the master from this branch.
1583
self._basic_push(master_branch, overwrite, stop_revision)
1584
# and push into the target branch from this. Note that we push from
1585
# this branch again, because its considered the highest bandwidth
1587
result = self._basic_push(target, overwrite, stop_revision)
1588
result.master_branch = master_branch
1589
result.local_branch = target
1593
master_branch.unlock()
1596
result = self._basic_push(target, overwrite, stop_revision)
1597
# TODO: Why set master_branch and local_branch if there's no
1598
# binding? Maybe cleaner to just leave them unset? -- mbp
1600
result.master_branch = target
1601
result.local_branch = None
1605
def _basic_push(self, target, overwrite, stop_revision):
1606
"""Basic implementation of push without bound branches or hooks.
1608
Must be called with self read locked and target write locked.
1610
result = PushResult()
1611
result.source_branch = self
1612
result.target_branch = target
1613
result.old_revno, result.old_revid = target.last_revision_info()
1615
target.update_revisions(self, stop_revision)
1616
except errors.DivergedBranches:
1620
target.set_revision_history(self.revision_history())
1621
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
1622
result.new_revno, result.new_revid = target.last_revision_info()
1625
def get_parent(self):
1626
"""See Branch.get_parent."""
1628
assert self.base[-1] == '/'
1629
parent = self._get_parent_location()
1632
# This is an old-format absolute path to a local branch
1633
# turn it into a url
1634
if parent.startswith('/'):
1635
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1637
return urlutils.join(self.base[:-1], parent)
1638
except errors.InvalidURLJoin, e:
1639
raise errors.InaccessibleParent(parent, self.base)
1641
def set_push_location(self, location):
1642
"""See Branch.set_push_location."""
1643
self.get_config().set_user_option(
1644
'push_location', location,
1645
store=_mod_config.STORE_LOCATION_NORECURSE)
1648
def set_parent(self, url):
1649
"""See Branch.set_parent."""
1650
# TODO: Maybe delete old location files?
1651
# URLs should never be unicode, even on the local fs,
1652
# FIXUP this and get_parent in a future branch format bump:
1653
# read and rewrite the file, and have the new format code read
1654
# using .get not .get_utf8. RBC 20060125
1656
if isinstance(url, unicode):
1658
url = url.encode('ascii')
1659
except UnicodeEncodeError:
1660
raise errors.InvalidURL(url,
1661
"Urls must be 7-bit ascii, "
1662
"use bzrlib.urlutils.escape")
1663
url = urlutils.relative_url(self.base, url)
1664
self._set_parent_location(url)
1666
def _set_parent_location(self, url):
1668
self.control_files._transport.delete('parent')
1670
assert isinstance(url, str)
1671
self.control_files.put_bytes('parent', url + '\n')
1674
class BzrBranch5(BzrBranch):
1675
"""A format 5 branch. This supports new features over plain branches.
1677
It has support for a master_branch which is the data for bound branches.
1685
super(BzrBranch5, self).__init__(_format=_format,
1686
_control_files=_control_files,
1688
_repository=_repository)
1691
def pull(self, source, overwrite=False, stop_revision=None,
1692
run_hooks=True, possible_transports=None):
1693
"""Pull from source into self, updating my master if any.
1695
:param run_hooks: Private parameter - if false, this branch
1696
is being called because it's the master of the primary branch,
1697
so it should not run its hooks.
1699
bound_location = self.get_bound_location()
1700
master_branch = None
1701
if bound_location and source.base != bound_location:
1702
# not pulling from master, so we need to update master.
1703
master_branch = self.get_master_branch(possible_transports)
1704
master_branch.lock_write()
1707
# pull from source into master.
1708
master_branch.pull(source, overwrite, stop_revision,
1710
return super(BzrBranch5, self).pull(source, overwrite,
1711
stop_revision, _hook_master=master_branch,
1712
run_hooks=run_hooks)
1715
master_branch.unlock()
1717
def get_bound_location(self):
1719
return self.control_files.get_utf8('bound').read()[:-1]
1720
except errors.NoSuchFile:
1724
def get_master_branch(self, possible_transports=None):
1725
"""Return the branch we are bound to.
1727
:return: Either a Branch, or None
1729
This could memoise the branch, but if thats done
1730
it must be revalidated on each new lock.
1731
So for now we just don't memoise it.
1732
# RBC 20060304 review this decision.
1734
bound_loc = self.get_bound_location()
1738
return Branch.open(bound_loc,
1739
possible_transports=possible_transports)
1740
except (errors.NotBranchError, errors.ConnectionError), e:
1741
raise errors.BoundBranchConnectionFailure(
1745
def set_bound_location(self, location):
1746
"""Set the target where this branch is bound to.
1748
:param location: URL to the target branch
1751
self.control_files.put_utf8('bound', location+'\n')
1754
self.control_files._transport.delete('bound')
1755
except errors.NoSuchFile:
1760
def bind(self, other):
1761
"""Bind this branch to the branch other.
1763
This does not push or pull data between the branches, though it does
1764
check for divergence to raise an error when the branches are not
1765
either the same, or one a prefix of the other. That behaviour may not
1766
be useful, so that check may be removed in future.
1768
:param other: The branch to bind to
1771
# TODO: jam 20051230 Consider checking if the target is bound
1772
# It is debatable whether you should be able to bind to
1773
# a branch which is itself bound.
1774
# Committing is obviously forbidden,
1775
# but binding itself may not be.
1776
# Since we *have* to check at commit time, we don't
1777
# *need* to check here
1779
# we want to raise diverged if:
1780
# last_rev is not in the other_last_rev history, AND
1781
# other_last_rev is not in our history, and do it without pulling
1783
self.set_bound_location(other.base)
1787
"""If bound, unbind"""
1788
return self.set_bound_location(None)
1791
def update(self, possible_transports=None):
1792
"""Synchronise this branch with the master branch if any.
1794
:return: None or the last_revision that was pivoted out during the
1797
master = self.get_master_branch(possible_transports)
1798
if master is not None:
1799
old_tip = _mod_revision.ensure_null(self.last_revision())
1800
self.pull(master, overwrite=True)
1801
if self.repository.get_graph().is_ancestor(old_tip,
1802
_mod_revision.ensure_null(self.last_revision())):
1808
class BzrBranch6(BzrBranch5):
1811
def last_revision_info(self):
1812
revision_string = self.control_files.get('last-revision').read()
1813
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1814
revision_id = cache_utf8.get_cached_utf8(revision_id)
1816
return revno, revision_id
1818
def _write_last_revision_info(self, revno, revision_id):
1819
"""Simply write out the revision id, with no checks.
1821
Use set_last_revision_info to perform this safely.
1823
Does not update the revision_history cache.
1824
Intended to be called by set_last_revision_info and
1825
_write_revision_history.
1827
if revision_id is None:
1828
revision_id = 'null:'
1829
out_string = '%d %s\n' % (revno, revision_id)
1830
self.control_files.put_bytes('last-revision', out_string)
1833
def set_last_revision_info(self, revno, revision_id):
1834
if self._get_append_revisions_only():
1835
self._check_history_violation(revision_id)
1836
self._write_last_revision_info(revno, revision_id)
1837
self._clear_cached_state()
1839
def _check_history_violation(self, revision_id):
1840
last_revision = _mod_revision.ensure_null(self.last_revision())
1841
if _mod_revision.is_null(last_revision):
1843
if last_revision not in self._lefthand_history(revision_id):
1844
raise errors.AppendRevisionsOnlyViolation(self.base)
1846
def _gen_revision_history(self):
1847
"""Generate the revision history from last revision
1849
history = list(self.repository.iter_reverse_revision_history(
1850
self.last_revision()))
1854
def _write_revision_history(self, history):
1855
"""Factored out of set_revision_history.
1857
This performs the actual writing to disk, with format-specific checks.
1858
It is intended to be called by BzrBranch5.set_revision_history.
1860
if len(history) == 0:
1861
last_revision = 'null:'
1863
if history != self._lefthand_history(history[-1]):
1864
raise errors.NotLefthandHistory(history)
1865
last_revision = history[-1]
1866
if self._get_append_revisions_only():
1867
self._check_history_violation(last_revision)
1868
self._write_last_revision_info(len(history), last_revision)
1871
def _set_parent_location(self, url):
1872
"""Set the parent branch"""
1873
self._set_config_location('parent_location', url, make_relative=True)
1876
def _get_parent_location(self):
1877
"""Set the parent branch"""
1878
return self._get_config_location('parent_location')
1880
def set_push_location(self, location):
1881
"""See Branch.set_push_location."""
1882
self._set_config_location('push_location', location)
1884
def set_bound_location(self, location):
1885
"""See Branch.set_push_location."""
1887
config = self.get_config()
1888
if location is None:
1889
if config.get_user_option('bound') != 'True':
1892
config.set_user_option('bound', 'False', warn_masked=True)
1895
self._set_config_location('bound_location', location,
1897
config.set_user_option('bound', 'True', warn_masked=True)
1900
def _get_bound_location(self, bound):
1901
"""Return the bound location in the config file.
1903
Return None if the bound parameter does not match"""
1904
config = self.get_config()
1905
config_bound = (config.get_user_option('bound') == 'True')
1906
if config_bound != bound:
1908
return self._get_config_location('bound_location', config=config)
1910
def get_bound_location(self):
1911
"""See Branch.set_push_location."""
1912
return self._get_bound_location(True)
1914
def get_old_bound_location(self):
1915
"""See Branch.get_old_bound_location"""
1916
return self._get_bound_location(False)
1918
def set_append_revisions_only(self, enabled):
1923
self.get_config().set_user_option('append_revisions_only', value,
1926
def _get_append_revisions_only(self):
1927
value = self.get_config().get_user_option('append_revisions_only')
1928
return value == 'True'
1930
def _synchronize_history(self, destination, revision_id):
1931
"""Synchronize last revision and revision history between branches.
1933
This version is most efficient when the destination is also a
1934
BzrBranch6, but works for BzrBranch5, as long as the destination's
1935
repository contains all the lefthand ancestors of the intended
1936
last_revision. If not, set_last_revision_info will fail.
1938
:param destination: The branch to copy the history into
1939
:param revision_id: The revision-id to truncate history at. May
1940
be None to copy complete history.
1942
source_revno, source_revision_id = self.last_revision_info()
1943
if revision_id is None:
1944
revno, revision_id = source_revno, source_revision_id
1945
elif source_revision_id == revision_id:
1946
# we know the revno without needing to walk all of history
1947
revno = source_revno
1949
# To figure out the revno for a random revision, we need to build
1950
# the revision history, and count its length.
1951
# We don't care about the order, just how long it is.
1952
# Alternatively, we could start at the current location, and count
1953
# backwards. But there is no guarantee that we will find it since
1954
# it may be a merged revision.
1955
revno = len(list(self.repository.iter_reverse_revision_history(
1957
destination.set_last_revision_info(revno, revision_id)
1959
def _make_tags(self):
1960
return BasicTags(self)
1963
######################################################################
1964
# results of operations
1967
class _Result(object):
1969
def _show_tag_conficts(self, to_file):
1970
if not getattr(self, 'tag_conflicts', None):
1972
to_file.write('Conflicting tags:\n')
1973
for name, value1, value2 in self.tag_conflicts:
1974
to_file.write(' %s\n' % (name, ))
1977
class PullResult(_Result):
1978
"""Result of a Branch.pull operation.
1980
:ivar old_revno: Revision number before pull.
1981
:ivar new_revno: Revision number after pull.
1982
:ivar old_revid: Tip revision id before pull.
1983
:ivar new_revid: Tip revision id after pull.
1984
:ivar source_branch: Source (local) branch object.
1985
:ivar master_branch: Master branch of the target, or None.
1986
:ivar target_branch: Target/destination branch object.
1990
# DEPRECATED: pull used to return the change in revno
1991
return self.new_revno - self.old_revno
1993
def report(self, to_file):
1995
if self.old_revid == self.new_revid:
1996
to_file.write('No revisions to pull.\n')
1998
to_file.write('Now on revision %d.\n' % self.new_revno)
1999
self._show_tag_conficts(to_file)
2002
class PushResult(_Result):
2003
"""Result of a Branch.push operation.
2005
:ivar old_revno: Revision number before push.
2006
:ivar new_revno: Revision number after push.
2007
:ivar old_revid: Tip revision id before push.
2008
:ivar new_revid: Tip revision id after push.
2009
:ivar source_branch: Source branch object.
2010
:ivar master_branch: Master branch of the target, or None.
2011
:ivar target_branch: Target/destination branch object.
2015
# DEPRECATED: push used to return the change in revno
2016
return self.new_revno - self.old_revno
2018
def report(self, to_file):
2019
"""Write a human-readable description of the result."""
2020
if self.old_revid == self.new_revid:
2021
to_file.write('No new revisions to push.\n')
2023
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2024
self._show_tag_conficts(to_file)
2027
class BranchCheckResult(object):
2028
"""Results of checking branch consistency.
2033
def __init__(self, branch):
2034
self.branch = branch
2036
def report_results(self, verbose):
2037
"""Report the check results via trace.note.
2039
:param verbose: Requests more detailed display of what was checked,
2042
note('checked branch %s format %s',
2044
self.branch._format)
2047
class Converter5to6(object):
2048
"""Perform an in-place upgrade of format 5 to format 6"""
2050
def convert(self, branch):
2051
# Data for 5 and 6 can peacefully coexist.
2052
format = BzrBranchFormat6()
2053
new_branch = format.open(branch.bzrdir, _found=True)
2055
# Copy source data into target
2056
new_branch.set_last_revision_info(*branch.last_revision_info())
2057
new_branch.set_parent(branch.get_parent())
2058
new_branch.set_bound_location(branch.get_bound_location())
2059
new_branch.set_push_location(branch.get_push_location())
2061
# New branch has no tags by default
2062
new_branch.tags._set_tag_dict({})
2064
# Copying done; now update target format
2065
new_branch.control_files.put_utf8('format',
2066
format.get_format_string())
2068
# Clean up old files
2069
new_branch.control_files._transport.delete('revision-history')
2071
branch.set_parent(None)
2072
except errors.NoSuchFile:
2074
branch.set_bound_location(None)
added
removed
bzrlib/branch.py
