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_containing(url):
136
"""Open an existing branch which contains url.
138
This probes for a branch at url, and searches upwards from there.
140
Basically we keep looking up until we find the control directory or
141
run into the root. If there isn't one, raises NotBranchError.
142
If there is one and it is either an unrecognised format or an unsupported
143
format, UnknownFormatError or UnsupportedFormatError are raised.
144
If there is one, it is returned, along with the unused portion of url.
146
control, relpath = bzrdir.BzrDir.open_containing(url)
147
return control.open_branch(), relpath
150
@deprecated_function(zero_eight)
151
def initialize(base):
152
"""Create a new working tree and branch, rooted at 'base' (url)
154
NOTE: This will soon be deprecated in favour of creation
157
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
159
@deprecated_function(zero_eight)
160
def setup_caching(self, cache_root):
161
"""Subclasses that care about caching should override this, and set
162
up cached stores located under cache_root.
164
NOTE: This is unused.
168
def get_config(self):
169
return BranchConfig(self)
172
return self.get_config().get_nickname()
174
def _set_nick(self, nick):
175
self.get_config().set_user_option('nickname', nick)
177
nick = property(_get_nick, _set_nick)
180
raise NotImplementedError(self.is_locked)
182
def lock_write(self):
183
raise NotImplementedError(self.lock_write)
186
raise NotImplementedError(self.lock_read)
189
raise NotImplementedError(self.unlock)
191
def peek_lock_mode(self):
192
"""Return lock mode for the Branch: 'r', 'w' or None"""
193
raise NotImplementedError(self.peek_lock_mode)
195
def get_physical_lock_status(self):
196
raise NotImplementedError(self.get_physical_lock_status)
199
def get_revision_id_to_revno_map(self):
200
"""Return the revision_id => dotted revno map.
202
This will be regenerated on demand, but will be cached.
204
:return: A dictionary mapping revision_id => dotted revno.
205
This dictionary should not be modified by the caller.
207
if self._revision_id_to_revno_cache is not None:
208
mapping = self._revision_id_to_revno_cache
210
mapping = self._gen_revno_map()
211
self._cache_revision_id_to_revno(mapping)
212
# TODO: jam 20070417 Since this is being cached, should we be returning
214
# I would rather not, and instead just declare that users should not
215
# modify the return value.
218
def _gen_revno_map(self):
219
"""Create a new mapping from revision ids to dotted revnos.
221
Dotted revnos are generated based on the current tip in the revision
223
This is the worker function for get_revision_id_to_revno_map, which
224
just caches the return value.
226
:return: A dictionary mapping revision_id => dotted revno.
228
last_revision = self.last_revision()
229
revision_graph = self.repository.get_revision_graph(last_revision)
230
merge_sorted_revisions = tsort.merge_sort(
235
revision_id_to_revno = dict((rev_id, revno)
236
for seq_num, rev_id, depth, revno, end_of_merge
237
in merge_sorted_revisions)
238
return revision_id_to_revno
240
def leave_lock_in_place(self):
241
"""Tell this branch object not to release the physical lock when this
244
If lock_write doesn't return a token, then this method is not supported.
246
self.control_files.leave_in_place()
248
def dont_leave_lock_in_place(self):
249
"""Tell this branch object to release the physical lock when this
250
object is unlocked, even if it didn't originally acquire it.
252
If lock_write doesn't return a token, then this method is not supported.
254
self.control_files.dont_leave_in_place()
256
def abspath(self, name):
257
"""Return absolute filename for something in the branch
259
XXX: Robert Collins 20051017 what is this used for? why is it a branch
260
method and not a tree method.
262
raise NotImplementedError(self.abspath)
264
def bind(self, other):
265
"""Bind the local branch the other branch.
267
:param other: The branch to bind to
270
raise errors.UpgradeRequired(self.base)
273
def fetch(self, from_branch, last_revision=None, pb=None):
274
"""Copy revisions from from_branch into this branch.
276
:param from_branch: Where to copy from.
277
:param last_revision: What revision to stop at (None for at the end
279
:param pb: An optional progress bar to use.
281
Returns the copied revision count and the failed revisions in a tuple:
284
if self.base == from_branch.base:
287
nested_pb = ui.ui_factory.nested_progress_bar()
292
from_branch.lock_read()
294
if last_revision is None:
295
pb.update('get source history')
296
last_revision = from_branch.last_revision()
297
if last_revision is None:
298
last_revision = _mod_revision.NULL_REVISION
299
return self.repository.fetch(from_branch.repository,
300
revision_id=last_revision,
303
if nested_pb is not None:
307
def get_bound_location(self):
308
"""Return the URL of the branch we are bound to.
310
Older format branches cannot bind, please be sure to use a metadir
315
def get_old_bound_location(self):
316
"""Return the URL of the branch we used to be bound to
318
raise errors.UpgradeRequired(self.base)
320
def get_commit_builder(self, parents, config=None, timestamp=None,
321
timezone=None, committer=None, revprops=None,
323
"""Obtain a CommitBuilder for this branch.
325
:param parents: Revision ids of the parents of the new revision.
326
:param config: Optional configuration to use.
327
:param timestamp: Optional timestamp recorded for commit.
328
:param timezone: Optional timezone for timestamp.
329
:param committer: Optional committer to set for commit.
330
:param revprops: Optional dictionary of revision properties.
331
:param revision_id: Optional revision id.
335
config = self.get_config()
337
return self.repository.get_commit_builder(self, parents, config,
338
timestamp, timezone, committer, revprops, revision_id)
340
def get_master_branch(self):
341
"""Return the branch we are bound to.
343
:return: Either a Branch, or None
347
def get_revision_delta(self, revno):
348
"""Return the delta for one revision.
350
The delta is relative to its mainline predecessor, or the
351
empty tree for revision 1.
353
assert isinstance(revno, int)
354
rh = self.revision_history()
355
if not (1 <= revno <= len(rh)):
356
raise InvalidRevisionNumber(revno)
357
return self.repository.get_revision_delta(rh[revno-1])
359
@deprecated_method(zero_sixteen)
360
def get_root_id(self):
361
"""Return the id of this branches root
363
Deprecated: branches don't have root ids-- trees do.
364
Use basis_tree().get_root_id() instead.
366
raise NotImplementedError(self.get_root_id)
368
def print_file(self, file, revision_id):
369
"""Print `file` to stdout."""
370
raise NotImplementedError(self.print_file)
372
def append_revision(self, *revision_ids):
373
raise NotImplementedError(self.append_revision)
375
def set_revision_history(self, rev_history):
376
raise NotImplementedError(self.set_revision_history)
378
def _cache_revision_history(self, rev_history):
379
"""Set the cached revision history to rev_history.
381
The revision_history method will use this cache to avoid regenerating
382
the revision history.
384
This API is semi-public; it only for use by subclasses, all other code
385
should consider it to be private.
387
self._revision_history_cache = rev_history
389
def _cache_revision_id_to_revno(self, revision_id_to_revno):
390
"""Set the cached revision_id => revno map to revision_id_to_revno.
392
This API is semi-public; it only for use by subclasses, all other code
393
should consider it to be private.
395
self._revision_id_to_revno_cache = revision_id_to_revno
397
def _clear_cached_state(self):
398
"""Clear any cached data on this branch, e.g. cached revision history.
400
This means the next call to revision_history will need to call
401
_gen_revision_history.
403
This API is semi-public; it only for use by subclasses, all other code
404
should consider it to be private.
406
self._revision_history_cache = None
407
self._revision_id_to_revno_cache = None
409
def _gen_revision_history(self):
410
"""Return sequence of revision hashes on to this branch.
412
Unlike revision_history, this method always regenerates or rereads the
413
revision history, i.e. it does not cache the result, so repeated calls
416
Concrete subclasses should override this instead of revision_history so
417
that subclasses do not need to deal with caching logic.
419
This API is semi-public; it only for use by subclasses, all other code
420
should consider it to be private.
422
raise NotImplementedError(self._gen_revision_history)
425
def revision_history(self):
426
"""Return sequence of revision hashes on to this branch.
428
This method will cache the revision history for as long as it is safe to
431
if self._revision_history_cache is not None:
432
history = self._revision_history_cache
434
history = self._gen_revision_history()
435
self._cache_revision_history(history)
439
"""Return current revision number for this branch.
441
That is equivalent to the number of revisions committed to
444
return len(self.revision_history())
447
"""Older format branches cannot bind or unbind."""
448
raise errors.UpgradeRequired(self.base)
450
def set_append_revisions_only(self, enabled):
451
"""Older format branches are never restricted to append-only"""
452
raise errors.UpgradeRequired(self.base)
454
def last_revision(self):
455
"""Return last revision id, or None"""
456
ph = self.revision_history()
462
def last_revision_info(self):
463
"""Return information about the last revision.
465
:return: A tuple (revno, last_revision_id).
467
rh = self.revision_history()
470
return (revno, rh[-1])
472
return (0, _mod_revision.NULL_REVISION)
474
def missing_revisions(self, other, stop_revision=None):
475
"""Return a list of new revisions that would perfectly fit.
477
If self and other have not diverged, return a list of the revisions
478
present in other, but missing from self.
480
self_history = self.revision_history()
481
self_len = len(self_history)
482
other_history = other.revision_history()
483
other_len = len(other_history)
484
common_index = min(self_len, other_len) -1
485
if common_index >= 0 and \
486
self_history[common_index] != other_history[common_index]:
487
raise DivergedBranches(self, other)
489
if stop_revision is None:
490
stop_revision = other_len
492
assert isinstance(stop_revision, int)
493
if stop_revision > other_len:
494
raise errors.NoSuchRevision(self, stop_revision)
495
return other_history[self_len:stop_revision]
497
def update_revisions(self, other, stop_revision=None):
498
"""Pull in new perfect-fit revisions.
500
:param other: Another Branch to pull from
501
:param stop_revision: Updated until the given revision
504
raise NotImplementedError(self.update_revisions)
506
def revision_id_to_revno(self, revision_id):
507
"""Given a revision id, return its revno"""
508
if revision_id is None:
510
revision_id = osutils.safe_revision_id(revision_id)
511
history = self.revision_history()
513
return history.index(revision_id) + 1
515
raise errors.NoSuchRevision(self, revision_id)
517
def get_rev_id(self, revno, history=None):
518
"""Find the revision id of the specified revno."""
522
history = self.revision_history()
523
if revno <= 0 or revno > len(history):
524
raise errors.NoSuchRevision(self, revno)
525
return history[revno - 1]
527
def pull(self, source, overwrite=False, stop_revision=None):
528
"""Mirror source into this branch.
530
This branch is considered to be 'local', having low latency.
532
:returns: PullResult instance
534
raise NotImplementedError(self.pull)
536
def push(self, target, overwrite=False, stop_revision=None):
537
"""Mirror this branch into target.
539
This branch is considered to be 'local', having low latency.
541
raise NotImplementedError(self.push)
543
def basis_tree(self):
544
"""Return `Tree` object for last revision."""
545
return self.repository.revision_tree(self.last_revision())
547
def rename_one(self, from_rel, to_rel):
550
This can change the directory or the filename or both.
552
raise NotImplementedError(self.rename_one)
554
def move(self, from_paths, to_name):
557
to_name must exist as a versioned directory.
559
If to_name exists and is a directory, the files are moved into
560
it, keeping their old names. If it is a directory,
562
Note that to_name is only the last component of the new name;
563
this doesn't change the directory.
565
This returns a list of (from_path, to_path) pairs for each
568
raise NotImplementedError(self.move)
570
def get_parent(self):
571
"""Return the parent location of the branch.
573
This is the default location for push/pull/missing. The usual
574
pattern is that the user can override it by specifying a
577
raise NotImplementedError(self.get_parent)
579
def _set_config_location(self, name, url, config=None,
580
make_relative=False):
582
config = self.get_config()
586
url = urlutils.relative_url(self.base, url)
587
config.set_user_option(name, url)
589
def _get_config_location(self, name, config=None):
591
config = self.get_config()
592
location = config.get_user_option(name)
597
def get_submit_branch(self):
598
"""Return the submit location of the branch.
600
This is the default location for bundle. The usual
601
pattern is that the user can override it by specifying a
604
return self.get_config().get_user_option('submit_branch')
606
def set_submit_branch(self, location):
607
"""Return the submit location of the branch.
609
This is the default location for bundle. The usual
610
pattern is that the user can override it by specifying a
613
self.get_config().set_user_option('submit_branch', location)
615
def get_public_branch(self):
616
"""Return the public location of the branch.
618
This is is used by merge directives.
620
return self._get_config_location('public_branch')
622
def set_public_branch(self, location):
623
"""Return the submit location of the branch.
625
This is the default location for bundle. The usual
626
pattern is that the user can override it by specifying a
629
self._set_config_location('public_branch', location)
631
def get_push_location(self):
632
"""Return the None or the location to push this branch to."""
633
push_loc = self.get_config().get_user_option('push_location')
636
def set_push_location(self, location):
637
"""Set a new push location for this branch."""
638
raise NotImplementedError(self.set_push_location)
640
def set_parent(self, url):
641
raise NotImplementedError(self.set_parent)
645
"""Synchronise this branch with the master branch if any.
647
:return: None or the last_revision pivoted out during the update.
651
def check_revno(self, revno):
653
Check whether a revno corresponds to any revision.
654
Zero (the NULL revision) is considered valid.
657
self.check_real_revno(revno)
659
def check_real_revno(self, revno):
661
Check whether a revno corresponds to a real revision.
662
Zero (the NULL revision) is considered invalid
664
if revno < 1 or revno > self.revno():
665
raise InvalidRevisionNumber(revno)
668
def clone(self, to_bzrdir, revision_id=None):
669
"""Clone this branch into to_bzrdir preserving all semantic values.
671
revision_id: if not None, the revision history in the new branch will
672
be truncated to end with revision_id.
674
result = self._format.initialize(to_bzrdir)
675
self.copy_content_into(result, revision_id=revision_id)
679
def sprout(self, to_bzrdir, revision_id=None):
680
"""Create a new line of development from the branch, into to_bzrdir.
682
revision_id: if not None, the revision history in the new branch will
683
be truncated to end with revision_id.
685
result = self._format.initialize(to_bzrdir)
686
self.copy_content_into(result, revision_id=revision_id)
687
result.set_parent(self.bzrdir.root_transport.base)
690
def _synchronize_history(self, destination, revision_id):
691
"""Synchronize last revision and revision history between branches.
693
This version is most efficient when the destination is also a
694
BzrBranch5, but works for BzrBranch6 as long as the revision
695
history is the true lefthand parent history, and all of the revisions
696
are in the destination's repository. If not, set_revision_history
699
:param destination: The branch to copy the history into
700
:param revision_id: The revision-id to truncate history at. May
701
be None to copy complete history.
703
new_history = self.revision_history()
704
if revision_id is not None:
705
revision_id = osutils.safe_revision_id(revision_id)
707
new_history = new_history[:new_history.index(revision_id) + 1]
709
rev = self.repository.get_revision(revision_id)
710
new_history = rev.get_history(self.repository)[1:]
711
destination.set_revision_history(new_history)
714
def copy_content_into(self, destination, revision_id=None):
715
"""Copy the content of self into destination.
717
revision_id: if not None, the revision history in the new branch will
718
be truncated to end with revision_id.
720
self._synchronize_history(destination, revision_id)
722
parent = self.get_parent()
723
except errors.InaccessibleParent, e:
724
mutter('parent was not accessible to copy: %s', e)
727
destination.set_parent(parent)
728
self.tags.merge_to(destination.tags)
732
"""Check consistency of the branch.
734
In particular this checks that revisions given in the revision-history
735
do actually match up in the revision graph, and that they're all
736
present in the repository.
738
Callers will typically also want to check the repository.
740
:return: A BranchCheckResult.
742
mainline_parent_id = None
743
for revision_id in self.revision_history():
745
revision = self.repository.get_revision(revision_id)
746
except errors.NoSuchRevision, e:
747
raise errors.BzrCheckError("mainline revision {%s} not in repository"
749
# In general the first entry on the revision history has no parents.
750
# But it's not illegal for it to have parents listed; this can happen
751
# in imports from Arch when the parents weren't reachable.
752
if mainline_parent_id is not None:
753
if mainline_parent_id not in revision.parent_ids:
754
raise errors.BzrCheckError("previous revision {%s} not listed among "
756
% (mainline_parent_id, revision_id))
757
mainline_parent_id = revision_id
758
return BranchCheckResult(self)
760
def _get_checkout_format(self):
761
"""Return the most suitable metadir for a checkout of this branch.
762
Weaves are used if this branch's repository uses weaves.
764
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
765
from bzrlib.repofmt import weaverepo
766
format = bzrdir.BzrDirMetaFormat1()
767
format.repository_format = weaverepo.RepositoryFormat7()
769
format = self.repository.bzrdir.checkout_metadir()
770
format.set_branch_format(self._format)
773
def create_checkout(self, to_location, revision_id=None,
775
"""Create a checkout of a branch.
777
:param to_location: The url to produce the checkout at
778
:param revision_id: The revision to check out
779
:param lightweight: If True, produce a lightweight checkout, otherwise,
780
produce a bound branch (heavyweight checkout)
781
:return: The tree of the created checkout
783
t = transport.get_transport(to_location)
786
format = self._get_checkout_format()
787
checkout = format.initialize_on_transport(t)
788
BranchReferenceFormat().initialize(checkout, self)
790
format = self._get_checkout_format()
791
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
792
to_location, force_new_tree=False, format=format)
793
checkout = checkout_branch.bzrdir
794
checkout_branch.bind(self)
795
# pull up to the specified revision_id to set the initial
796
# branch tip correctly, and seed it with history.
797
checkout_branch.pull(self, stop_revision=revision_id)
798
tree = checkout.create_workingtree(revision_id)
799
basis_tree = tree.basis_tree()
800
basis_tree.lock_read()
802
for path, file_id in basis_tree.iter_references():
803
reference_parent = self.reference_parent(file_id, path)
804
reference_parent.create_checkout(tree.abspath(path),
805
basis_tree.get_reference_revision(file_id, path),
811
def reference_parent(self, file_id, path):
812
"""Return the parent branch for a tree-reference file_id
813
:param file_id: The file_id of the tree reference
814
:param path: The path of the file_id in the tree
815
:return: A branch associated with the file_id
817
# FIXME should provide multiple branches, based on config
818
return Branch.open(self.bzrdir.root_transport.clone(path).base)
820
def supports_tags(self):
821
return self._format.supports_tags()
824
class BranchFormat(object):
825
"""An encapsulation of the initialization and open routines for a format.
827
Formats provide three things:
828
* An initialization routine,
832
Formats are placed in an dict by their format string for reference
833
during branch opening. Its not required that these be instances, they
834
can be classes themselves with class methods - it simply depends on
835
whether state is needed for a given format or not.
837
Once a format is deprecated, just deprecate the initialize and open
838
methods on the format class. Do not deprecate the object, as the
839
object will be created every time regardless.
842
_default_format = None
843
"""The default format used for new branches."""
846
"""The known formats."""
848
def __eq__(self, other):
849
return self.__class__ is other.__class__
851
def __ne__(self, other):
852
return not (self == other)
855
def find_format(klass, a_bzrdir):
856
"""Return the format for the branch object in a_bzrdir."""
858
transport = a_bzrdir.get_branch_transport(None)
859
format_string = transport.get("format").read()
860
return klass._formats[format_string]
862
raise NotBranchError(path=transport.base)
864
raise errors.UnknownFormatError(format=format_string)
867
def get_default_format(klass):
868
"""Return the current default format."""
869
return klass._default_format
871
def get_reference(self, a_bzrdir):
872
"""Get the target reference of the branch in a_bzrdir.
874
format probing must have been completed before calling
875
this method - it is assumed that the format of the branch
876
in a_bzrdir is correct.
878
:param a_bzrdir: The bzrdir to get the branch data from.
879
:return: None if the branch is not a reference branch.
883
def get_format_string(self):
884
"""Return the ASCII format string that identifies this format."""
885
raise NotImplementedError(self.get_format_string)
887
def get_format_description(self):
888
"""Return the short format description for this format."""
889
raise NotImplementedError(self.get_format_description)
891
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
893
"""Initialize a branch in a bzrdir, with specified files
895
:param a_bzrdir: The bzrdir to initialize the branch in
896
:param utf8_files: The files to create as a list of
897
(filename, content) tuples
898
:param set_format: If True, set the format with
899
self.get_format_string. (BzrBranch4 has its format set
901
:return: a branch in this format
903
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
904
branch_transport = a_bzrdir.get_branch_transport(self)
906
'metadir': ('lock', lockdir.LockDir),
907
'branch4': ('branch-lock', lockable_files.TransportLock),
909
lock_name, lock_class = lock_map[lock_type]
910
control_files = lockable_files.LockableFiles(branch_transport,
911
lock_name, lock_class)
912
control_files.create_lock()
913
control_files.lock_write()
915
control_files.put_utf8('format', self.get_format_string())
917
for file, content in utf8_files:
918
control_files.put_utf8(file, content)
920
control_files.unlock()
921
return self.open(a_bzrdir, _found=True)
923
def initialize(self, a_bzrdir):
924
"""Create a branch of this format in a_bzrdir."""
925
raise NotImplementedError(self.initialize)
927
def is_supported(self):
928
"""Is this format supported?
930
Supported formats can be initialized and opened.
931
Unsupported formats may not support initialization or committing or
932
some other features depending on the reason for not being supported.
936
def open(self, a_bzrdir, _found=False):
937
"""Return the branch object for a_bzrdir
939
_found is a private parameter, do not use it. It is used to indicate
940
if format probing has already be done.
942
raise NotImplementedError(self.open)
945
def register_format(klass, format):
946
klass._formats[format.get_format_string()] = format
949
def set_default_format(klass, format):
950
klass._default_format = format
953
def unregister_format(klass, format):
954
assert klass._formats[format.get_format_string()] is format
955
del klass._formats[format.get_format_string()]
958
return self.get_format_string().rstrip()
960
def supports_tags(self):
961
"""True if this format supports tags stored in the branch"""
962
return False # by default
964
# XXX: Probably doesn't really belong here -- mbp 20070212
965
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
967
branch_transport = a_bzrdir.get_branch_transport(self)
968
control_files = lockable_files.LockableFiles(branch_transport,
969
lock_filename, lock_class)
970
control_files.create_lock()
971
control_files.lock_write()
973
for filename, content in utf8_files:
974
control_files.put_utf8(filename, content)
976
control_files.unlock()
979
class BranchHooks(Hooks):
980
"""A dictionary mapping hook name to a list of callables for branch hooks.
982
e.g. ['set_rh'] Is the list of items to be called when the
983
set_revision_history function is invoked.
987
"""Create the default hooks.
989
These are all empty initially, because by default nothing should get
993
# Introduced in 0.15:
994
# invoked whenever the revision history has been set
995
# with set_revision_history. The api signature is
996
# (branch, revision_history), and the branch will
999
# invoked after a push operation completes.
1000
# the api signature is
1002
# containing the members
1003
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1004
# where local is the local target branch or None, master is the target
1005
# master branch, and the rest should be self explanatory. The source
1006
# is read locked and the target branches write locked. Source will
1007
# be the local low-latency branch.
1008
self['post_push'] = []
1009
# invoked after a pull 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 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. The local
1017
# branch is the low-latency branch.
1018
self['post_pull'] = []
1019
# invoked after a commit operation completes.
1020
# the api signature is
1021
# (local, master, old_revno, old_revid, new_revno, new_revid)
1022
# old_revid is NULL_REVISION for the first commit to a branch.
1023
self['post_commit'] = []
1024
# invoked after a uncommit operation completes.
1025
# the api signature is
1026
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1027
# local is the local branch or None, master is the target branch,
1028
# and an empty branch recieves new_revno of 0, new_revid of None.
1029
self['post_uncommit'] = []
1032
# install the default hooks into the Branch class.
1033
Branch.hooks = BranchHooks()
1036
class BzrBranchFormat4(BranchFormat):
1037
"""Bzr branch format 4.
1040
- a revision-history file.
1041
- a branch-lock lock file [ to be shared with the bzrdir ]
1044
def get_format_description(self):
1045
"""See BranchFormat.get_format_description()."""
1046
return "Branch format 4"
1048
def initialize(self, a_bzrdir):
1049
"""Create a branch of this format in a_bzrdir."""
1050
utf8_files = [('revision-history', ''),
1051
('branch-name', ''),
1053
return self._initialize_helper(a_bzrdir, utf8_files,
1054
lock_type='branch4', set_format=False)
1057
super(BzrBranchFormat4, self).__init__()
1058
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1060
def open(self, a_bzrdir, _found=False):
1061
"""Return the branch object for a_bzrdir
1063
_found is a private parameter, do not use it. It is used to indicate
1064
if format probing has already be done.
1067
# we are being called directly and must probe.
1068
raise NotImplementedError
1069
return BzrBranch(_format=self,
1070
_control_files=a_bzrdir._control_files,
1072
_repository=a_bzrdir.open_repository())
1075
return "Bazaar-NG branch format 4"
1078
class BzrBranchFormat5(BranchFormat):
1079
"""Bzr branch format 5.
1082
- a revision-history file.
1084
- a lock dir guarding the branch itself
1085
- all of this stored in a branch/ subdirectory
1086
- works with shared repositories.
1088
This format is new in bzr 0.8.
1091
def get_format_string(self):
1092
"""See BranchFormat.get_format_string()."""
1093
return "Bazaar-NG branch format 5\n"
1095
def get_format_description(self):
1096
"""See BranchFormat.get_format_description()."""
1097
return "Branch format 5"
1099
def initialize(self, a_bzrdir):
1100
"""Create a branch of this format in a_bzrdir."""
1101
utf8_files = [('revision-history', ''),
1102
('branch-name', ''),
1104
return self._initialize_helper(a_bzrdir, utf8_files)
1107
super(BzrBranchFormat5, self).__init__()
1108
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1110
def open(self, a_bzrdir, _found=False):
1111
"""Return the branch object for a_bzrdir
1113
_found is a private parameter, do not use it. It is used to indicate
1114
if format probing has already be done.
1117
format = BranchFormat.find_format(a_bzrdir)
1118
assert format.__class__ == self.__class__
1120
transport = a_bzrdir.get_branch_transport(None)
1121
control_files = lockable_files.LockableFiles(transport, 'lock',
1123
return BzrBranch5(_format=self,
1124
_control_files=control_files,
1126
_repository=a_bzrdir.find_repository())
1128
raise NotBranchError(path=transport.base)
1131
class BzrBranchFormat6(BzrBranchFormat5):
1132
"""Branch format with last-revision
1134
Unlike previous formats, this has no explicit revision history. Instead,
1135
this just stores the last-revision, and the left-hand history leading
1136
up to there is the history.
1138
This format was introduced in bzr 0.15
1141
def get_format_string(self):
1142
"""See BranchFormat.get_format_string()."""
1143
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1145
def get_format_description(self):
1146
"""See BranchFormat.get_format_description()."""
1147
return "Branch format 6"
1149
def initialize(self, a_bzrdir):
1150
"""Create a branch of this format in a_bzrdir."""
1151
utf8_files = [('last-revision', '0 null:\n'),
1152
('branch-name', ''),
1153
('branch.conf', ''),
1156
return self._initialize_helper(a_bzrdir, utf8_files)
1158
def open(self, a_bzrdir, _found=False):
1159
"""Return the branch object for a_bzrdir
1161
_found is a private parameter, do not use it. It is used to indicate
1162
if format probing has already be done.
1165
format = BranchFormat.find_format(a_bzrdir)
1166
assert format.__class__ == self.__class__
1167
transport = a_bzrdir.get_branch_transport(None)
1168
control_files = lockable_files.LockableFiles(transport, 'lock',
1170
return BzrBranch6(_format=self,
1171
_control_files=control_files,
1173
_repository=a_bzrdir.find_repository())
1175
def supports_tags(self):
1179
class BranchReferenceFormat(BranchFormat):
1180
"""Bzr branch reference format.
1182
Branch references are used in implementing checkouts, they
1183
act as an alias to the real branch which is at some other url.
1190
def get_format_string(self):
1191
"""See BranchFormat.get_format_string()."""
1192
return "Bazaar-NG Branch Reference Format 1\n"
1194
def get_format_description(self):
1195
"""See BranchFormat.get_format_description()."""
1196
return "Checkout reference format 1"
1198
def get_reference(self, a_bzrdir):
1199
"""See BranchFormat.get_reference()."""
1200
transport = a_bzrdir.get_branch_transport(None)
1201
return transport.get('location').read()
1203
def initialize(self, a_bzrdir, target_branch=None):
1204
"""Create a branch of this format in a_bzrdir."""
1205
if target_branch is None:
1206
# this format does not implement branch itself, thus the implicit
1207
# creation contract must see it as uninitializable
1208
raise errors.UninitializableFormat(self)
1209
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1210
branch_transport = a_bzrdir.get_branch_transport(self)
1211
branch_transport.put_bytes('location',
1212
target_branch.bzrdir.root_transport.base)
1213
branch_transport.put_bytes('format', self.get_format_string())
1214
return self.open(a_bzrdir, _found=True)
1217
super(BranchReferenceFormat, self).__init__()
1218
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1220
def _make_reference_clone_function(format, a_branch):
1221
"""Create a clone() routine for a branch dynamically."""
1222
def clone(to_bzrdir, revision_id=None):
1223
"""See Branch.clone()."""
1224
return format.initialize(to_bzrdir, a_branch)
1225
# cannot obey revision_id limits when cloning a reference ...
1226
# FIXME RBC 20060210 either nuke revision_id for clone, or
1227
# emit some sort of warning/error to the caller ?!
1230
def open(self, a_bzrdir, _found=False, location=None):
1231
"""Return the branch that the branch reference in a_bzrdir points at.
1233
_found is a private parameter, do not use it. It is used to indicate
1234
if format probing has already be done.
1237
format = BranchFormat.find_format(a_bzrdir)
1238
assert format.__class__ == self.__class__
1239
if location is None:
1240
location = self.get_reference(a_bzrdir)
1241
real_bzrdir = bzrdir.BzrDir.open(location)
1242
result = real_bzrdir.open_branch()
1243
# this changes the behaviour of result.clone to create a new reference
1244
# rather than a copy of the content of the branch.
1245
# I did not use a proxy object because that needs much more extensive
1246
# testing, and we are only changing one behaviour at the moment.
1247
# If we decide to alter more behaviours - i.e. the implicit nickname
1248
# then this should be refactored to introduce a tested proxy branch
1249
# and a subclass of that for use in overriding clone() and ....
1251
result.clone = self._make_reference_clone_function(result)
1255
# formats which have no format string are not discoverable
1256
# and not independently creatable, so are not registered.
1257
__default_format = BzrBranchFormat5()
1258
BranchFormat.register_format(__default_format)
1259
BranchFormat.register_format(BranchReferenceFormat())
1260
BranchFormat.register_format(BzrBranchFormat6())
1261
BranchFormat.set_default_format(__default_format)
1262
_legacy_formats = [BzrBranchFormat4(),
1265
class BzrBranch(Branch):
1266
"""A branch stored in the actual filesystem.
1268
Note that it's "local" in the context of the filesystem; it doesn't
1269
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1270
it's writable, and can be accessed via the normal filesystem API.
1273
def __init__(self, _format=None,
1274
_control_files=None, a_bzrdir=None, _repository=None):
1275
"""Create new branch object at a particular location."""
1276
Branch.__init__(self)
1277
if a_bzrdir is None:
1278
raise ValueError('a_bzrdir must be supplied')
1280
self.bzrdir = a_bzrdir
1281
# self._transport used to point to the directory containing the
1282
# control directory, but was not used - now it's just the transport
1283
# for the branch control files. mbp 20070212
1284
self._base = self.bzrdir.transport.clone('..').base
1285
self._format = _format
1286
if _control_files is None:
1287
raise ValueError('BzrBranch _control_files is None')
1288
self.control_files = _control_files
1289
self._transport = _control_files._transport
1290
self.repository = _repository
1293
return '%s(%r)' % (self.__class__.__name__, self.base)
1297
def _get_base(self):
1298
"""Returns the directory containing the control directory."""
1301
base = property(_get_base, doc="The URL for the root of this branch.")
1303
def abspath(self, name):
1304
"""See Branch.abspath."""
1305
return self.control_files._transport.abspath(name)
1308
@deprecated_method(zero_sixteen)
1310
def get_root_id(self):
1311
"""See Branch.get_root_id."""
1312
tree = self.repository.revision_tree(self.last_revision())
1313
return tree.inventory.root.file_id
1315
def is_locked(self):
1316
return self.control_files.is_locked()
1318
def lock_write(self, token=None):
1319
repo_token = self.repository.lock_write()
1321
token = self.control_files.lock_write(token=token)
1323
self.repository.unlock()
1327
def lock_read(self):
1328
self.repository.lock_read()
1330
self.control_files.lock_read()
1332
self.repository.unlock()
1336
# TODO: test for failed two phase locks. This is known broken.
1338
self.control_files.unlock()
1340
self.repository.unlock()
1341
if not self.control_files.is_locked():
1342
# we just released the lock
1343
self._clear_cached_state()
1345
def peek_lock_mode(self):
1346
if self.control_files._lock_count == 0:
1349
return self.control_files._lock_mode
1351
def get_physical_lock_status(self):
1352
return self.control_files.get_physical_lock_status()
1355
def print_file(self, file, revision_id):
1356
"""See Branch.print_file."""
1357
return self.repository.print_file(file, revision_id)
1360
def append_revision(self, *revision_ids):
1361
"""See Branch.append_revision."""
1362
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1363
for revision_id in revision_ids:
1364
_mod_revision.check_not_reserved_id(revision_id)
1365
mutter("add {%s} to revision-history" % revision_id)
1366
rev_history = self.revision_history()
1367
rev_history.extend(revision_ids)
1368
self.set_revision_history(rev_history)
1370
def _write_revision_history(self, history):
1371
"""Factored out of set_revision_history.
1373
This performs the actual writing to disk.
1374
It is intended to be called by BzrBranch5.set_revision_history."""
1375
self.control_files.put_bytes(
1376
'revision-history', '\n'.join(history))
1379
def set_revision_history(self, rev_history):
1380
"""See Branch.set_revision_history."""
1381
rev_history = [osutils.safe_revision_id(r) for r in rev_history]
1382
self._clear_cached_state()
1383
self._write_revision_history(rev_history)
1384
self._cache_revision_history(rev_history)
1385
for hook in Branch.hooks['set_rh']:
1386
hook(self, rev_history)
1389
def set_last_revision_info(self, revno, revision_id):
1390
revision_id = osutils.safe_revision_id(revision_id)
1391
history = self._lefthand_history(revision_id)
1392
assert len(history) == revno, '%d != %d' % (len(history), revno)
1393
self.set_revision_history(history)
1395
def _gen_revision_history(self):
1396
history = self.control_files.get('revision-history').read().split('\n')
1397
if history[-1:] == ['']:
1398
# There shouldn't be a trailing newline, but just in case.
1402
def _lefthand_history(self, revision_id, last_rev=None,
1404
# stop_revision must be a descendant of last_revision
1405
stop_graph = self.repository.get_revision_graph(revision_id)
1406
if last_rev is not None and last_rev not in stop_graph:
1407
# our previous tip is not merged into stop_revision
1408
raise errors.DivergedBranches(self, other_branch)
1409
# make a new revision history from the graph
1410
current_rev_id = revision_id
1412
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1413
new_history.append(current_rev_id)
1414
current_rev_id_parents = stop_graph[current_rev_id]
1416
current_rev_id = current_rev_id_parents[0]
1418
current_rev_id = None
1419
new_history.reverse()
1423
def generate_revision_history(self, revision_id, last_rev=None,
1425
"""Create a new revision history that will finish with revision_id.
1427
:param revision_id: the new tip to use.
1428
:param last_rev: The previous last_revision. If not None, then this
1429
must be a ancestory of revision_id, or DivergedBranches is raised.
1430
:param other_branch: The other branch that DivergedBranches should
1431
raise with respect to.
1433
revision_id = osutils.safe_revision_id(revision_id)
1434
self.set_revision_history(self._lefthand_history(revision_id,
1435
last_rev, other_branch))
1438
def update_revisions(self, other, stop_revision=None):
1439
"""See Branch.update_revisions."""
1442
if stop_revision is None:
1443
stop_revision = other.last_revision()
1444
if stop_revision is None:
1445
# if there are no commits, we're done.
1448
stop_revision = osutils.safe_revision_id(stop_revision)
1449
# whats the current last revision, before we fetch [and change it
1451
last_rev = self.last_revision()
1452
# we fetch here regardless of whether we need to so that we pickup
1454
self.fetch(other, stop_revision)
1455
my_ancestry = self.repository.get_ancestry(last_rev,
1457
if stop_revision in my_ancestry:
1458
# last_revision is a descendant of stop_revision
1460
self.generate_revision_history(stop_revision, last_rev=last_rev,
1465
def basis_tree(self):
1466
"""See Branch.basis_tree."""
1467
return self.repository.revision_tree(self.last_revision())
1469
@deprecated_method(zero_eight)
1470
def working_tree(self):
1471
"""Create a Working tree object for this branch."""
1473
from bzrlib.transport.local import LocalTransport
1474
if (self.base.find('://') != -1 or
1475
not isinstance(self._transport, LocalTransport)):
1476
raise NoWorkingTree(self.base)
1477
return self.bzrdir.open_workingtree()
1480
def pull(self, source, overwrite=False, stop_revision=None,
1481
_hook_master=None, run_hooks=True):
1484
:param _hook_master: Private parameter - set the branch to
1485
be supplied as the master to push hooks.
1486
:param run_hooks: Private parameter - if false, this branch
1487
is being called because it's the master of the primary branch,
1488
so it should not run its hooks.
1490
result = PullResult()
1491
result.source_branch = source
1492
result.target_branch = self
1495
result.old_revno, result.old_revid = self.last_revision_info()
1497
self.update_revisions(source, stop_revision)
1498
except DivergedBranches:
1502
if stop_revision is None:
1503
stop_revision = source.last_revision()
1504
self.generate_revision_history(stop_revision)
1505
result.tag_conflicts = source.tags.merge_to(self.tags)
1506
result.new_revno, result.new_revid = self.last_revision_info()
1508
result.master_branch = _hook_master
1509
result.local_branch = self
1511
result.master_branch = self
1512
result.local_branch = None
1514
for hook in Branch.hooks['post_pull']:
1520
def _get_parent_location(self):
1521
_locs = ['parent', 'pull', 'x-pull']
1524
return self.control_files.get(l).read().strip('\n')
1530
def push(self, target, overwrite=False, stop_revision=None,
1531
_override_hook_source_branch=None):
1534
This is the basic concrete implementation of push()
1536
:param _override_hook_source_branch: If specified, run
1537
the hooks passing this Branch as the source, rather than self.
1538
This is for use of RemoteBranch, where push is delegated to the
1539
underlying vfs-based Branch.
1541
# TODO: Public option to disable running hooks - should be trivial but
1545
result = self._push_with_bound_branches(target, overwrite,
1547
_override_hook_source_branch=_override_hook_source_branch)
1552
def _push_with_bound_branches(self, target, overwrite,
1554
_override_hook_source_branch=None):
1555
"""Push from self into target, and into target's master if any.
1557
This is on the base BzrBranch class even though it doesn't support
1558
bound branches because the *target* might be bound.
1561
if _override_hook_source_branch:
1562
result.source_branch = _override_hook_source_branch
1563
for hook in Branch.hooks['post_push']:
1566
bound_location = target.get_bound_location()
1567
if bound_location and target.base != bound_location:
1568
# there is a master branch.
1570
# XXX: Why the second check? Is it even supported for a branch to
1571
# be bound to itself? -- mbp 20070507
1572
master_branch = target.get_master_branch()
1573
master_branch.lock_write()
1575
# push into the master from this branch.
1576
self._basic_push(master_branch, overwrite, stop_revision)
1577
# and push into the target branch from this. Note that we push from
1578
# this branch again, because its considered the highest bandwidth
1580
result = self._basic_push(target, overwrite, stop_revision)
1581
result.master_branch = master_branch
1582
result.local_branch = target
1586
master_branch.unlock()
1589
result = self._basic_push(target, overwrite, stop_revision)
1590
# TODO: Why set master_branch and local_branch if there's no
1591
# binding? Maybe cleaner to just leave them unset? -- mbp
1593
result.master_branch = target
1594
result.local_branch = None
1598
def _basic_push(self, target, overwrite, stop_revision):
1599
"""Basic implementation of push without bound branches or hooks.
1601
Must be called with self read locked and target write locked.
1603
result = PushResult()
1604
result.source_branch = self
1605
result.target_branch = target
1606
result.old_revno, result.old_revid = target.last_revision_info()
1608
target.update_revisions(self, stop_revision)
1609
except DivergedBranches:
1613
target.set_revision_history(self.revision_history())
1614
result.tag_conflicts = self.tags.merge_to(target.tags)
1615
result.new_revno, result.new_revid = target.last_revision_info()
1618
def get_parent(self):
1619
"""See Branch.get_parent."""
1621
assert self.base[-1] == '/'
1622
parent = self._get_parent_location()
1625
# This is an old-format absolute path to a local branch
1626
# turn it into a url
1627
if parent.startswith('/'):
1628
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1630
return urlutils.join(self.base[:-1], parent)
1631
except errors.InvalidURLJoin, e:
1632
raise errors.InaccessibleParent(parent, self.base)
1634
def set_push_location(self, location):
1635
"""See Branch.set_push_location."""
1636
self.get_config().set_user_option(
1637
'push_location', location,
1638
store=_mod_config.STORE_LOCATION_NORECURSE)
1641
def set_parent(self, url):
1642
"""See Branch.set_parent."""
1643
# TODO: Maybe delete old location files?
1644
# URLs should never be unicode, even on the local fs,
1645
# FIXUP this and get_parent in a future branch format bump:
1646
# read and rewrite the file, and have the new format code read
1647
# using .get not .get_utf8. RBC 20060125
1649
if isinstance(url, unicode):
1651
url = url.encode('ascii')
1652
except UnicodeEncodeError:
1653
raise errors.InvalidURL(url,
1654
"Urls must be 7-bit ascii, "
1655
"use bzrlib.urlutils.escape")
1656
url = urlutils.relative_url(self.base, url)
1657
self._set_parent_location(url)
1659
def _set_parent_location(self, url):
1661
self.control_files._transport.delete('parent')
1663
assert isinstance(url, str)
1664
self.control_files.put_bytes('parent', url + '\n')
1666
@deprecated_function(zero_nine)
1667
def tree_config(self):
1668
"""DEPRECATED; call get_config instead.
1669
TreeConfig has become part of BranchConfig."""
1670
return TreeConfig(self)
1673
class BzrBranch5(BzrBranch):
1674
"""A format 5 branch. This supports new features over plan branches.
1676
It has support for a master_branch which is the data for bound branches.
1684
super(BzrBranch5, self).__init__(_format=_format,
1685
_control_files=_control_files,
1687
_repository=_repository)
1690
def pull(self, source, overwrite=False, stop_revision=None,
1692
"""Pull from source into self, updating my master if any.
1694
:param run_hooks: Private parameter - if false, this branch
1695
is being called because it's the master of the primary branch,
1696
so it should not run its hooks.
1698
bound_location = self.get_bound_location()
1699
master_branch = None
1700
if bound_location and source.base != bound_location:
1701
# not pulling from master, so we need to update master.
1702
master_branch = self.get_master_branch()
1703
master_branch.lock_write()
1706
# pull from source into master.
1707
master_branch.pull(source, overwrite, stop_revision,
1709
return super(BzrBranch5, self).pull(source, overwrite,
1710
stop_revision, _hook_master=master_branch,
1711
run_hooks=run_hooks)
1714
master_branch.unlock()
1716
def get_bound_location(self):
1718
return self.control_files.get_utf8('bound').read()[:-1]
1719
except errors.NoSuchFile:
1723
def get_master_branch(self):
1724
"""Return the branch we are bound to.
1726
:return: Either a Branch, or None
1728
This could memoise the branch, but if thats done
1729
it must be revalidated on each new lock.
1730
So for now we just don't memoise it.
1731
# RBC 20060304 review this decision.
1733
bound_loc = self.get_bound_location()
1737
return Branch.open(bound_loc)
1738
except (errors.NotBranchError, errors.ConnectionError), e:
1739
raise errors.BoundBranchConnectionFailure(
1743
def set_bound_location(self, location):
1744
"""Set the target where this branch is bound to.
1746
:param location: URL to the target branch
1749
self.control_files.put_utf8('bound', location+'\n')
1752
self.control_files._transport.delete('bound')
1758
def bind(self, other):
1759
"""Bind this branch to the branch other.
1761
This does not push or pull data between the branches, though it does
1762
check for divergence to raise an error when the branches are not
1763
either the same, or one a prefix of the other. That behaviour may not
1764
be useful, so that check may be removed in future.
1766
:param other: The branch to bind to
1769
# TODO: jam 20051230 Consider checking if the target is bound
1770
# It is debatable whether you should be able to bind to
1771
# a branch which is itself bound.
1772
# Committing is obviously forbidden,
1773
# but binding itself may not be.
1774
# Since we *have* to check at commit time, we don't
1775
# *need* to check here
1777
# we want to raise diverged if:
1778
# last_rev is not in the other_last_rev history, AND
1779
# other_last_rev is not in our history, and do it without pulling
1781
last_rev = self.last_revision()
1782
if last_rev is not None:
1785
other_last_rev = other.last_revision()
1786
if other_last_rev is not None:
1787
# neither branch is new, we have to do some work to
1788
# ascertain diversion.
1789
remote_graph = other.repository.get_revision_graph(
1791
local_graph = self.repository.get_revision_graph(last_rev)
1792
if (last_rev not in remote_graph and
1793
other_last_rev not in local_graph):
1794
raise errors.DivergedBranches(self, other)
1797
self.set_bound_location(other.base)
1801
"""If bound, unbind"""
1802
return self.set_bound_location(None)
1806
"""Synchronise this branch with the master branch if any.
1808
:return: None or the last_revision that was pivoted out during the
1811
master = self.get_master_branch()
1812
if master is not None:
1813
old_tip = self.last_revision()
1814
self.pull(master, overwrite=True)
1815
if old_tip in self.repository.get_ancestry(self.last_revision(),
1822
class BzrBranchExperimental(BzrBranch5):
1823
"""Bzr experimental branch format
1826
- a revision-history file.
1828
- a lock dir guarding the branch itself
1829
- all of this stored in a branch/ subdirectory
1830
- works with shared repositories.
1831
- a tag dictionary in the branch
1833
This format is new in bzr 0.15, but shouldn't be used for real data,
1836
This class acts as it's own BranchFormat.
1839
_matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1842
def get_format_string(cls):
1843
"""See BranchFormat.get_format_string()."""
1844
return "Bazaar-NG branch format experimental\n"
1847
def get_format_description(cls):
1848
"""See BranchFormat.get_format_description()."""
1849
return "Experimental branch format"
1852
def get_reference(cls, a_bzrdir):
1853
"""Get the target reference of the branch in a_bzrdir.
1855
format probing must have been completed before calling
1856
this method - it is assumed that the format of the branch
1857
in a_bzrdir is correct.
1859
:param a_bzrdir: The bzrdir to get the branch data from.
1860
:return: None if the branch is not a reference branch.
1865
def _initialize_control_files(cls, a_bzrdir, utf8_files, lock_filename,
1867
branch_transport = a_bzrdir.get_branch_transport(cls)
1868
control_files = lockable_files.LockableFiles(branch_transport,
1869
lock_filename, lock_class)
1870
control_files.create_lock()
1871
control_files.lock_write()
1873
for filename, content in utf8_files:
1874
control_files.put_utf8(filename, content)
1876
control_files.unlock()
1879
def initialize(cls, a_bzrdir):
1880
"""Create a branch of this format in a_bzrdir."""
1881
utf8_files = [('format', cls.get_format_string()),
1882
('revision-history', ''),
1883
('branch-name', ''),
1886
cls._initialize_control_files(a_bzrdir, utf8_files,
1887
'lock', lockdir.LockDir)
1888
return cls.open(a_bzrdir, _found=True)
1891
def open(cls, a_bzrdir, _found=False):
1892
"""Return the branch object for a_bzrdir
1894
_found is a private parameter, do not use it. It is used to indicate
1895
if format probing has already be done.
1898
format = BranchFormat.find_format(a_bzrdir)
1899
assert format.__class__ == cls
1900
transport = a_bzrdir.get_branch_transport(None)
1901
control_files = lockable_files.LockableFiles(transport, 'lock',
1903
return cls(_format=cls,
1904
_control_files=control_files,
1906
_repository=a_bzrdir.find_repository())
1909
def is_supported(cls):
1912
def _make_tags(self):
1913
return BasicTags(self)
1916
def supports_tags(cls):
1920
BranchFormat.register_format(BzrBranchExperimental)
1923
class BzrBranch6(BzrBranch5):
1926
def last_revision_info(self):
1927
revision_string = self.control_files.get('last-revision').read()
1928
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1929
revision_id = cache_utf8.get_cached_utf8(revision_id)
1931
return revno, revision_id
1933
def last_revision(self):
1934
"""Return last revision id, or None"""
1935
revision_id = self.last_revision_info()[1]
1936
if revision_id == _mod_revision.NULL_REVISION:
1940
def _write_last_revision_info(self, revno, revision_id):
1941
"""Simply write out the revision id, with no checks.
1943
Use set_last_revision_info to perform this safely.
1945
Does not update the revision_history cache.
1946
Intended to be called by set_last_revision_info and
1947
_write_revision_history.
1949
if revision_id is None:
1950
revision_id = 'null:'
1951
out_string = '%d %s\n' % (revno, revision_id)
1952
self.control_files.put_bytes('last-revision', out_string)
1955
def set_last_revision_info(self, revno, revision_id):
1956
revision_id = osutils.safe_revision_id(revision_id)
1957
if self._get_append_revisions_only():
1958
self._check_history_violation(revision_id)
1959
self._write_last_revision_info(revno, revision_id)
1960
self._clear_cached_state()
1962
def _check_history_violation(self, revision_id):
1963
last_revision = self.last_revision()
1964
if last_revision is None:
1966
if last_revision not in self._lefthand_history(revision_id):
1967
raise errors.AppendRevisionsOnlyViolation(self.base)
1969
def _gen_revision_history(self):
1970
"""Generate the revision history from last revision
1972
history = list(self.repository.iter_reverse_revision_history(
1973
self.last_revision()))
1977
def _write_revision_history(self, history):
1978
"""Factored out of set_revision_history.
1980
This performs the actual writing to disk, with format-specific checks.
1981
It is intended to be called by BzrBranch5.set_revision_history.
1983
if len(history) == 0:
1984
last_revision = 'null:'
1986
if history != self._lefthand_history(history[-1]):
1987
raise errors.NotLefthandHistory(history)
1988
last_revision = history[-1]
1989
if self._get_append_revisions_only():
1990
self._check_history_violation(last_revision)
1991
self._write_last_revision_info(len(history), last_revision)
1994
def append_revision(self, *revision_ids):
1995
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1996
if len(revision_ids) == 0:
1998
prev_revno, prev_revision = self.last_revision_info()
1999
for revision in self.repository.get_revisions(revision_ids):
2000
if prev_revision == _mod_revision.NULL_REVISION:
2001
if revision.parent_ids != []:
2002
raise errors.NotLeftParentDescendant(self, prev_revision,
2003
revision.revision_id)
2005
if revision.parent_ids[0] != prev_revision:
2006
raise errors.NotLeftParentDescendant(self, prev_revision,
2007
revision.revision_id)
2008
prev_revision = revision.revision_id
2009
self.set_last_revision_info(prev_revno + len(revision_ids),
2013
def _set_parent_location(self, url):
2014
"""Set the parent branch"""
2015
self._set_config_location('parent_location', url, make_relative=True)
2018
def _get_parent_location(self):
2019
"""Set the parent branch"""
2020
return self._get_config_location('parent_location')
2022
def set_push_location(self, location):
2023
"""See Branch.set_push_location."""
2024
self._set_config_location('push_location', location)
2026
def set_bound_location(self, location):
2027
"""See Branch.set_push_location."""
2029
config = self.get_config()
2030
if location is None:
2031
if config.get_user_option('bound') != 'True':
2034
config.set_user_option('bound', 'False')
2037
self._set_config_location('bound_location', location,
2039
config.set_user_option('bound', 'True')
2042
def _get_bound_location(self, bound):
2043
"""Return the bound location in the config file.
2045
Return None if the bound parameter does not match"""
2046
config = self.get_config()
2047
config_bound = (config.get_user_option('bound') == 'True')
2048
if config_bound != bound:
2050
return self._get_config_location('bound_location', config=config)
2052
def get_bound_location(self):
2053
"""See Branch.set_push_location."""
2054
return self._get_bound_location(True)
2056
def get_old_bound_location(self):
2057
"""See Branch.get_old_bound_location"""
2058
return self._get_bound_location(False)
2060
def set_append_revisions_only(self, enabled):
2065
self.get_config().set_user_option('append_revisions_only', value)
2067
def _get_append_revisions_only(self):
2068
value = self.get_config().get_user_option('append_revisions_only')
2069
return value == 'True'
2071
def _synchronize_history(self, destination, revision_id):
2072
"""Synchronize last revision and revision history between branches.
2074
This version is most efficient when the destination is also a
2075
BzrBranch6, but works for BzrBranch5, as long as the destination's
2076
repository contains all the lefthand ancestors of the intended
2077
last_revision. If not, set_last_revision_info will fail.
2079
:param destination: The branch to copy the history into
2080
:param revision_id: The revision-id to truncate history at. May
2081
be None to copy complete history.
2083
if revision_id is None:
2084
revno, revision_id = self.last_revision_info()
2086
# To figure out the revno for a random revision, we need to build
2087
# the revision history, and count its length.
2088
# We don't care about the order, just how long it is.
2089
# Alternatively, we could start at the current location, and count
2090
# backwards. But there is no guarantee that we will find it since
2091
# it may be a merged revision.
2092
revno = len(list(self.repository.iter_reverse_revision_history(
2094
destination.set_last_revision_info(revno, revision_id)
2096
def _make_tags(self):
2097
return BasicTags(self)
2100
######################################################################
2101
# results of operations
2104
class _Result(object):
2106
def _show_tag_conficts(self, to_file):
2107
if not getattr(self, 'tag_conflicts', None):
2109
to_file.write('Conflicting tags:\n')
2110
for name, value1, value2 in self.tag_conflicts:
2111
to_file.write(' %s\n' % (name, ))
2114
class PullResult(_Result):
2115
"""Result of a Branch.pull operation.
2117
:ivar old_revno: Revision number before pull.
2118
:ivar new_revno: Revision number after pull.
2119
:ivar old_revid: Tip revision id before pull.
2120
:ivar new_revid: Tip revision id after pull.
2121
:ivar source_branch: Source (local) branch object.
2122
:ivar master_branch: Master branch of the target, or None.
2123
:ivar target_branch: Target/destination branch object.
2127
# DEPRECATED: pull used to return the change in revno
2128
return self.new_revno - self.old_revno
2130
def report(self, to_file):
2131
if self.old_revid == self.new_revid:
2132
to_file.write('No revisions to pull.\n')
2134
to_file.write('Now on revision %d.\n' % self.new_revno)
2135
self._show_tag_conficts(to_file)
2138
class PushResult(_Result):
2139
"""Result of a Branch.push operation.
2141
:ivar old_revno: Revision number before push.
2142
:ivar new_revno: Revision number after push.
2143
:ivar old_revid: Tip revision id before push.
2144
:ivar new_revid: Tip revision id after push.
2145
:ivar source_branch: Source branch object.
2146
:ivar master_branch: Master branch of the target, or None.
2147
:ivar target_branch: Target/destination branch object.
2151
# DEPRECATED: push used to return the change in revno
2152
return self.new_revno - self.old_revno
2154
def report(self, to_file):
2155
"""Write a human-readable description of the result."""
2156
if self.old_revid == self.new_revid:
2157
to_file.write('No new revisions to push.\n')
2159
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2160
self._show_tag_conficts(to_file)
2163
class BranchCheckResult(object):
2164
"""Results of checking branch consistency.
2169
def __init__(self, branch):
2170
self.branch = branch
2172
def report_results(self, verbose):
2173
"""Report the check results via trace.note.
2175
:param verbose: Requests more detailed display of what was checked,
2178
note('checked branch %s format %s',
2180
self.branch._format)
2183
class Converter5to6(object):
2184
"""Perform an in-place upgrade of format 5 to format 6"""
2186
def convert(self, branch):
2187
# Data for 5 and 6 can peacefully coexist.
2188
format = BzrBranchFormat6()
2189
new_branch = format.open(branch.bzrdir, _found=True)
2191
# Copy source data into target
2192
new_branch.set_last_revision_info(*branch.last_revision_info())
2193
new_branch.set_parent(branch.get_parent())
2194
new_branch.set_bound_location(branch.get_bound_location())
2195
new_branch.set_push_location(branch.get_push_location())
2197
# New branch has no tags by default
2198
new_branch.tags._set_tag_dict({})
2200
# Copying done; now update target format
2201
new_branch.control_files.put_utf8('format',
2202
format.get_format_string())
2204
# Clean up old files
2205
new_branch.control_files._transport.delete('revision-history')
2207
branch.set_parent(None)
2210
branch.set_bound_location(None)
added
removed
bzrlib/branch.py
