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,
34
revision as _mod_revision,
41
from bzrlib.config import BranchConfig, TreeConfig
42
from bzrlib.lockable_files import LockableFiles, TransportLock
43
from bzrlib.tag import (
49
from bzrlib.decorators import needs_read_lock, needs_write_lock
50
from bzrlib.errors import (BzrError, BzrCheckError, DivergedBranches,
51
HistoryMissing, InvalidRevisionId,
52
InvalidRevisionNumber, LockError, NoSuchFile,
53
NoSuchRevision, NotVersionedError,
54
NotBranchError, UninitializableFormat,
55
UnlistableStore, UnlistableBranch,
57
from bzrlib.hooks import Hooks
58
from bzrlib.symbol_versioning import (deprecated_function,
62
zero_eight, zero_nine, zero_sixteen,
65
from bzrlib.trace import mutter, mutter_callsite, note
68
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
69
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
70
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
73
# TODO: Maybe include checks for common corruption of newlines, etc?
75
# TODO: Some operations like log might retrieve the same revisions
76
# repeatedly to calculate deltas. We could perhaps have a weakref
77
# cache in memory to make this faster. In general anything can be
78
# cached in memory between lock and unlock operations. .. nb thats
79
# what the transaction identity map provides
82
######################################################################
86
"""Branch holding a history of revisions.
89
Base directory/url of the branch.
91
hooks: An instance of BranchHooks.
93
# this is really an instance variable - FIXME move it there
97
# override this to set the strategy for storing tags
99
return DisabledTags(self)
101
def __init__(self, *ignored, **ignored_too):
102
self.tags = self._make_tags()
103
self._revision_history_cache = None
104
self._revision_id_to_revno_cache = None
106
def break_lock(self):
107
"""Break a lock if one is present from another instance.
109
Uses the ui factory to ask for confirmation if the lock may be from
112
This will probe the repository for its lock as well.
114
self.control_files.break_lock()
115
self.repository.break_lock()
116
master = self.get_master_branch()
117
if master is not None:
121
def open(base, _unsupported=False, possible_transports=None):
122
"""Open the branch rooted at base.
124
For instance, if the branch is at URL/.bzr/branch,
125
Branch.open(URL) -> a Branch instance.
127
control = bzrdir.BzrDir.open(base, _unsupported,
128
possible_transports=possible_transports)
129
return control.open_branch(_unsupported)
132
def open_from_transport(transport, _unsupported=False):
133
"""Open the branch rooted at transport"""
134
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
135
return control.open_branch(_unsupported)
138
def open_containing(url, possible_transports=None):
139
"""Open an existing branch which contains url.
141
This probes for a branch at url, and searches upwards from there.
143
Basically we keep looking up until we find the control directory or
144
run into the root. If there isn't one, raises NotBranchError.
145
If there is one and it is either an unrecognised format or an unsupported
146
format, UnknownFormatError or UnsupportedFormatError are raised.
147
If there is one, it is returned, along with the unused portion of url.
149
control, relpath = bzrdir.BzrDir.open_containing(url,
151
return control.open_branch(), relpath
153
def get_config(self):
154
return BranchConfig(self)
157
return self.get_config().get_nickname()
159
def _set_nick(self, nick):
160
self.get_config().set_user_option('nickname', nick, warn_masked=True)
162
nick = property(_get_nick, _set_nick)
165
raise NotImplementedError(self.is_locked)
167
def lock_write(self):
168
raise NotImplementedError(self.lock_write)
171
raise NotImplementedError(self.lock_read)
174
raise NotImplementedError(self.unlock)
176
def peek_lock_mode(self):
177
"""Return lock mode for the Branch: 'r', 'w' or None"""
178
raise NotImplementedError(self.peek_lock_mode)
180
def get_physical_lock_status(self):
181
raise NotImplementedError(self.get_physical_lock_status)
184
def get_revision_id_to_revno_map(self):
185
"""Return the revision_id => dotted revno map.
187
This will be regenerated on demand, but will be cached.
189
:return: A dictionary mapping revision_id => dotted revno.
190
This dictionary should not be modified by the caller.
192
if self._revision_id_to_revno_cache is not None:
193
mapping = self._revision_id_to_revno_cache
195
mapping = self._gen_revno_map()
196
self._cache_revision_id_to_revno(mapping)
197
# TODO: jam 20070417 Since this is being cached, should we be returning
199
# I would rather not, and instead just declare that users should not
200
# modify the return value.
203
def _gen_revno_map(self):
204
"""Create a new mapping from revision ids to dotted revnos.
206
Dotted revnos are generated based on the current tip in the revision
208
This is the worker function for get_revision_id_to_revno_map, which
209
just caches the return value.
211
:return: A dictionary mapping revision_id => dotted revno.
213
last_revision = self.last_revision()
214
revision_graph = self.repository.get_revision_graph(last_revision)
215
merge_sorted_revisions = tsort.merge_sort(
220
revision_id_to_revno = dict((rev_id, revno)
221
for seq_num, rev_id, depth, revno, end_of_merge
222
in merge_sorted_revisions)
223
return revision_id_to_revno
225
def leave_lock_in_place(self):
226
"""Tell this branch object not to release the physical lock when this
229
If lock_write doesn't return a token, then this method is not supported.
231
self.control_files.leave_in_place()
233
def dont_leave_lock_in_place(self):
234
"""Tell this branch object to release the physical lock when this
235
object is unlocked, even if it didn't originally acquire it.
237
If lock_write doesn't return a token, then this method is not supported.
239
self.control_files.dont_leave_in_place()
241
def abspath(self, name):
242
"""Return absolute filename for something in the branch
244
XXX: Robert Collins 20051017 what is this used for? why is it a branch
245
method and not a tree method.
247
raise NotImplementedError(self.abspath)
249
def bind(self, other):
250
"""Bind the local branch the other branch.
252
:param other: The branch to bind to
255
raise errors.UpgradeRequired(self.base)
258
def fetch(self, from_branch, last_revision=None, pb=None):
259
"""Copy revisions from from_branch into this branch.
261
:param from_branch: Where to copy from.
262
:param last_revision: What revision to stop at (None for at the end
264
:param pb: An optional progress bar to use.
266
Returns the copied revision count and the failed revisions in a tuple:
269
if self.base == from_branch.base:
272
nested_pb = ui.ui_factory.nested_progress_bar()
277
from_branch.lock_read()
279
if last_revision is None:
280
pb.update('get source history')
281
last_revision = from_branch.last_revision()
282
if last_revision is None:
283
last_revision = _mod_revision.NULL_REVISION
284
return self.repository.fetch(from_branch.repository,
285
revision_id=last_revision,
288
if nested_pb is not None:
292
def get_bound_location(self):
293
"""Return the URL of the branch we are bound to.
295
Older format branches cannot bind, please be sure to use a metadir
300
def get_old_bound_location(self):
301
"""Return the URL of the branch we used to be bound to
303
raise errors.UpgradeRequired(self.base)
305
def get_commit_builder(self, parents, config=None, timestamp=None,
306
timezone=None, committer=None, revprops=None,
308
"""Obtain a CommitBuilder for this branch.
310
:param parents: Revision ids of the parents of the new revision.
311
:param config: Optional configuration to use.
312
:param timestamp: Optional timestamp recorded for commit.
313
:param timezone: Optional timezone for timestamp.
314
:param committer: Optional committer to set for commit.
315
:param revprops: Optional dictionary of revision properties.
316
:param revision_id: Optional revision id.
320
config = self.get_config()
322
return self.repository.get_commit_builder(self, parents, config,
323
timestamp, timezone, committer, revprops, revision_id)
325
def get_master_branch(self, possible_transports=None):
326
"""Return the branch we are bound to.
328
:return: Either a Branch, or None
332
def get_revision_delta(self, revno):
333
"""Return the delta for one revision.
335
The delta is relative to its mainline predecessor, or the
336
empty tree for revision 1.
338
assert isinstance(revno, int)
339
rh = self.revision_history()
340
if not (1 <= revno <= len(rh)):
341
raise InvalidRevisionNumber(revno)
342
return self.repository.get_revision_delta(rh[revno-1])
344
@deprecated_method(zero_sixteen)
345
def get_root_id(self):
346
"""Return the id of this branches root
348
Deprecated: branches don't have root ids-- trees do.
349
Use basis_tree().get_root_id() instead.
351
raise NotImplementedError(self.get_root_id)
353
def print_file(self, file, revision_id):
354
"""Print `file` to stdout."""
355
raise NotImplementedError(self.print_file)
357
def set_revision_history(self, rev_history):
358
raise NotImplementedError(self.set_revision_history)
360
def _cache_revision_history(self, rev_history):
361
"""Set the cached revision history to rev_history.
363
The revision_history method will use this cache to avoid regenerating
364
the 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 = rev_history
371
def _cache_revision_id_to_revno(self, revision_id_to_revno):
372
"""Set the cached revision_id => revno map to revision_id_to_revno.
374
This API is semi-public; it only for use by subclasses, all other code
375
should consider it to be private.
377
self._revision_id_to_revno_cache = revision_id_to_revno
379
def _clear_cached_state(self):
380
"""Clear any cached data on this branch, e.g. cached revision history.
382
This means the next call to revision_history will need to call
383
_gen_revision_history.
385
This API is semi-public; it only for use by subclasses, all other code
386
should consider it to be private.
388
self._revision_history_cache = None
389
self._revision_id_to_revno_cache = None
391
def _gen_revision_history(self):
392
"""Return sequence of revision hashes on to this branch.
394
Unlike revision_history, this method always regenerates or rereads the
395
revision history, i.e. it does not cache the result, so repeated calls
398
Concrete subclasses should override this instead of revision_history so
399
that subclasses do not need to deal with caching logic.
401
This API is semi-public; it only for use by subclasses, all other code
402
should consider it to be private.
404
raise NotImplementedError(self._gen_revision_history)
407
def revision_history(self):
408
"""Return sequence of revision ids on this branch.
410
This method will cache the revision history for as long as it is safe to
413
if 'evil' in debug.debug_flags:
414
mutter_callsite(3, "revision_history scales with history.")
415
if self._revision_history_cache is not None:
416
history = self._revision_history_cache
418
history = self._gen_revision_history()
419
self._cache_revision_history(history)
423
"""Return current revision number for this branch.
425
That is equivalent to the number of revisions committed to
428
return self.last_revision_info()[0]
431
"""Older format branches cannot bind or unbind."""
432
raise errors.UpgradeRequired(self.base)
434
def set_append_revisions_only(self, enabled):
435
"""Older format branches are never restricted to append-only"""
436
raise errors.UpgradeRequired(self.base)
438
def last_revision(self):
439
"""Return last revision id, or None"""
440
ph = self.revision_history()
444
return _mod_revision.NULL_REVISION
446
def last_revision_info(self):
447
"""Return information about the last revision.
449
:return: A tuple (revno, last_revision_id).
451
rh = self.revision_history()
454
return (revno, rh[-1])
456
return (0, _mod_revision.NULL_REVISION)
458
def missing_revisions(self, other, stop_revision=None):
459
"""Return a list of new revisions that would perfectly fit.
461
If self and other have not diverged, return a list of the revisions
462
present in other, but missing from self.
464
self_history = self.revision_history()
465
self_len = len(self_history)
466
other_history = other.revision_history()
467
other_len = len(other_history)
468
common_index = min(self_len, other_len) -1
469
if common_index >= 0 and \
470
self_history[common_index] != other_history[common_index]:
471
raise DivergedBranches(self, other)
473
if stop_revision is None:
474
stop_revision = other_len
476
assert isinstance(stop_revision, int)
477
if stop_revision > other_len:
478
raise errors.NoSuchRevision(self, stop_revision)
479
return other_history[self_len:stop_revision]
481
def update_revisions(self, other, stop_revision=None):
482
"""Pull in new perfect-fit revisions.
484
:param other: Another Branch to pull from
485
:param stop_revision: Updated until the given revision
488
raise NotImplementedError(self.update_revisions)
490
def revision_id_to_revno(self, revision_id):
491
"""Given a revision id, return its revno"""
492
if _mod_revision.is_null(revision_id):
494
history = self.revision_history()
496
return history.index(revision_id) + 1
498
raise errors.NoSuchRevision(self, revision_id)
500
def get_rev_id(self, revno, history=None):
501
"""Find the revision id of the specified revno."""
503
return _mod_revision.NULL_REVISION
505
history = self.revision_history()
506
if revno <= 0 or revno > len(history):
507
raise errors.NoSuchRevision(self, revno)
508
return history[revno - 1]
510
def pull(self, source, overwrite=False, stop_revision=None,
511
possible_transports=None):
512
"""Mirror source into this branch.
514
This branch is considered to be 'local', having low latency.
516
:returns: PullResult instance
518
raise NotImplementedError(self.pull)
520
def push(self, target, overwrite=False, stop_revision=None):
521
"""Mirror this branch into target.
523
This branch is considered to be 'local', having low latency.
525
raise NotImplementedError(self.push)
527
def basis_tree(self):
528
"""Return `Tree` object for last revision."""
529
return self.repository.revision_tree(self.last_revision())
531
def rename_one(self, from_rel, to_rel):
534
This can change the directory or the filename or both.
536
raise NotImplementedError(self.rename_one)
538
def move(self, from_paths, to_name):
541
to_name must exist as a versioned directory.
543
If to_name exists and is a directory, the files are moved into
544
it, keeping their old names. If it is a directory,
546
Note that to_name is only the last component of the new name;
547
this doesn't change the directory.
549
This returns a list of (from_path, to_path) pairs for each
552
raise NotImplementedError(self.move)
554
def get_parent(self):
555
"""Return the parent location of the branch.
557
This is the default location for push/pull/missing. The usual
558
pattern is that the user can override it by specifying a
561
raise NotImplementedError(self.get_parent)
563
def _set_config_location(self, name, url, config=None,
564
make_relative=False):
566
config = self.get_config()
570
url = urlutils.relative_url(self.base, url)
571
config.set_user_option(name, url, warn_masked=True)
573
def _get_config_location(self, name, config=None):
575
config = self.get_config()
576
location = config.get_user_option(name)
581
def get_submit_branch(self):
582
"""Return the submit location of the branch.
584
This is the default location for bundle. The usual
585
pattern is that the user can override it by specifying a
588
return self.get_config().get_user_option('submit_branch')
590
def set_submit_branch(self, location):
591
"""Return the submit location of the branch.
593
This is the default location for bundle. The usual
594
pattern is that the user can override it by specifying a
597
self.get_config().set_user_option('submit_branch', location,
600
def get_public_branch(self):
601
"""Return the public location of the branch.
603
This is is used by merge directives.
605
return self._get_config_location('public_branch')
607
def set_public_branch(self, location):
608
"""Return the submit location of the branch.
610
This is the default location for bundle. The usual
611
pattern is that the user can override it by specifying a
614
self._set_config_location('public_branch', location)
616
def get_push_location(self):
617
"""Return the None or the location to push this branch to."""
618
push_loc = self.get_config().get_user_option('push_location')
621
def set_push_location(self, location):
622
"""Set a new push location for this branch."""
623
raise NotImplementedError(self.set_push_location)
625
def set_parent(self, url):
626
raise NotImplementedError(self.set_parent)
630
"""Synchronise this branch with the master branch if any.
632
:return: None or the last_revision pivoted out during the update.
636
def check_revno(self, revno):
638
Check whether a revno corresponds to any revision.
639
Zero (the NULL revision) is considered valid.
642
self.check_real_revno(revno)
644
def check_real_revno(self, revno):
646
Check whether a revno corresponds to a real revision.
647
Zero (the NULL revision) is considered invalid
649
if revno < 1 or revno > self.revno():
650
raise InvalidRevisionNumber(revno)
653
def clone(self, to_bzrdir, revision_id=None):
654
"""Clone this branch into to_bzrdir preserving all semantic values.
656
revision_id: if not None, the revision history in the new branch will
657
be truncated to end with revision_id.
659
result = self._format.initialize(to_bzrdir)
660
self.copy_content_into(result, revision_id=revision_id)
664
def sprout(self, to_bzrdir, revision_id=None):
665
"""Create a new line of development from the branch, into to_bzrdir.
667
revision_id: if not None, the revision history in the new branch will
668
be truncated to end with revision_id.
670
result = self._format.initialize(to_bzrdir)
671
self.copy_content_into(result, revision_id=revision_id)
672
result.set_parent(self.bzrdir.root_transport.base)
675
def _synchronize_history(self, destination, revision_id):
676
"""Synchronize last revision and revision history between branches.
678
This version is most efficient when the destination is also a
679
BzrBranch5, but works for BzrBranch6 as long as the revision
680
history is the true lefthand parent history, and all of the revisions
681
are in the destination's repository. If not, set_revision_history
684
:param destination: The branch to copy the history into
685
:param revision_id: The revision-id to truncate history at. May
686
be None to copy complete history.
688
if revision_id == _mod_revision.NULL_REVISION:
690
new_history = self.revision_history()
691
if revision_id is not None and new_history != []:
693
new_history = new_history[:new_history.index(revision_id) + 1]
695
rev = self.repository.get_revision(revision_id)
696
new_history = rev.get_history(self.repository)[1:]
697
destination.set_revision_history(new_history)
700
def copy_content_into(self, destination, revision_id=None):
701
"""Copy the content of self into destination.
703
revision_id: if not None, the revision history in the new branch will
704
be truncated to end with revision_id.
706
self._synchronize_history(destination, revision_id)
708
parent = self.get_parent()
709
except errors.InaccessibleParent, e:
710
mutter('parent was not accessible to copy: %s', e)
713
destination.set_parent(parent)
714
self.tags.merge_to(destination.tags)
718
"""Check consistency of the branch.
720
In particular this checks that revisions given in the revision-history
721
do actually match up in the revision graph, and that they're all
722
present in the repository.
724
Callers will typically also want to check the repository.
726
:return: A BranchCheckResult.
728
mainline_parent_id = None
729
for revision_id in self.revision_history():
731
revision = self.repository.get_revision(revision_id)
732
except errors.NoSuchRevision, e:
733
raise errors.BzrCheckError("mainline revision {%s} not in repository"
735
# In general the first entry on the revision history has no parents.
736
# But it's not illegal for it to have parents listed; this can happen
737
# in imports from Arch when the parents weren't reachable.
738
if mainline_parent_id is not None:
739
if mainline_parent_id not in revision.parent_ids:
740
raise errors.BzrCheckError("previous revision {%s} not listed among "
742
% (mainline_parent_id, revision_id))
743
mainline_parent_id = revision_id
744
return BranchCheckResult(self)
746
def _get_checkout_format(self):
747
"""Return the most suitable metadir for a checkout of this branch.
748
Weaves are used if this branch's repository uses weaves.
750
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
751
from bzrlib.repofmt import weaverepo
752
format = bzrdir.BzrDirMetaFormat1()
753
format.repository_format = weaverepo.RepositoryFormat7()
755
format = self.repository.bzrdir.checkout_metadir()
756
format.set_branch_format(self._format)
759
def create_checkout(self, to_location, revision_id=None,
760
lightweight=False, accelerator_tree=None):
761
"""Create a checkout of a branch.
763
:param to_location: The url to produce the checkout at
764
:param revision_id: The revision to check out
765
:param lightweight: If True, produce a lightweight checkout, otherwise,
766
produce a bound branch (heavyweight checkout)
767
:param accelerator_tree: A tree which can be used for retrieving file
768
contents more quickly than the revision tree, i.e. a workingtree.
769
The revision tree will be used for cases where accelerator_tree's
770
content is different.
771
:return: The tree of the created checkout
773
t = transport.get_transport(to_location)
776
format = self._get_checkout_format()
777
checkout = format.initialize_on_transport(t)
778
from_branch = BranchReferenceFormat().initialize(checkout, self)
780
format = self._get_checkout_format()
781
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
782
to_location, force_new_tree=False, format=format)
783
checkout = checkout_branch.bzrdir
784
checkout_branch.bind(self)
785
# pull up to the specified revision_id to set the initial
786
# branch tip correctly, and seed it with history.
787
checkout_branch.pull(self, stop_revision=revision_id)
789
tree = checkout.create_workingtree(revision_id,
790
from_branch=from_branch,
791
accelerator_tree=accelerator_tree)
792
basis_tree = tree.basis_tree()
793
basis_tree.lock_read()
795
for path, file_id in basis_tree.iter_references():
796
reference_parent = self.reference_parent(file_id, path)
797
reference_parent.create_checkout(tree.abspath(path),
798
basis_tree.get_reference_revision(file_id, path),
804
def reference_parent(self, file_id, path):
805
"""Return the parent branch for a tree-reference file_id
806
:param file_id: The file_id of the tree reference
807
:param path: The path of the file_id in the tree
808
:return: A branch associated with the file_id
810
# FIXME should provide multiple branches, based on config
811
return Branch.open(self.bzrdir.root_transport.clone(path).base)
813
def supports_tags(self):
814
return self._format.supports_tags()
817
class BranchFormat(object):
818
"""An encapsulation of the initialization and open routines for a format.
820
Formats provide three things:
821
* An initialization routine,
825
Formats are placed in an dict by their format string for reference
826
during branch opening. Its not required that these be instances, they
827
can be classes themselves with class methods - it simply depends on
828
whether state is needed for a given format or not.
830
Once a format is deprecated, just deprecate the initialize and open
831
methods on the format class. Do not deprecate the object, as the
832
object will be created every time regardless.
835
_default_format = None
836
"""The default format used for new branches."""
839
"""The known formats."""
841
def __eq__(self, other):
842
return self.__class__ is other.__class__
844
def __ne__(self, other):
845
return not (self == other)
848
def find_format(klass, a_bzrdir):
849
"""Return the format for the branch object in a_bzrdir."""
851
transport = a_bzrdir.get_branch_transport(None)
852
format_string = transport.get("format").read()
853
return klass._formats[format_string]
855
raise NotBranchError(path=transport.base)
857
raise errors.UnknownFormatError(format=format_string)
860
def get_default_format(klass):
861
"""Return the current default format."""
862
return klass._default_format
864
def get_reference(self, a_bzrdir):
865
"""Get the target reference of the branch in a_bzrdir.
867
format probing must have been completed before calling
868
this method - it is assumed that the format of the branch
869
in a_bzrdir is correct.
871
:param a_bzrdir: The bzrdir to get the branch data from.
872
:return: None if the branch is not a reference branch.
877
def set_reference(self, a_bzrdir, to_branch):
878
"""Set the target reference of the branch in a_bzrdir.
880
format probing must have been completed before calling
881
this method - it is assumed that the format of the branch
882
in a_bzrdir is correct.
884
:param a_bzrdir: The bzrdir to set the branch reference for.
885
:param to_branch: branch that the checkout is to reference
887
raise NotImplementedError(self.set_reference)
889
def get_format_string(self):
890
"""Return the ASCII format string that identifies this format."""
891
raise NotImplementedError(self.get_format_string)
893
def get_format_description(self):
894
"""Return the short format description for this format."""
895
raise NotImplementedError(self.get_format_description)
897
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
899
"""Initialize a branch in a bzrdir, with specified files
901
:param a_bzrdir: The bzrdir to initialize the branch in
902
:param utf8_files: The files to create as a list of
903
(filename, content) tuples
904
:param set_format: If True, set the format with
905
self.get_format_string. (BzrBranch4 has its format set
907
:return: a branch in this format
909
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
910
branch_transport = a_bzrdir.get_branch_transport(self)
912
'metadir': ('lock', lockdir.LockDir),
913
'branch4': ('branch-lock', lockable_files.TransportLock),
915
lock_name, lock_class = lock_map[lock_type]
916
control_files = lockable_files.LockableFiles(branch_transport,
917
lock_name, lock_class)
918
control_files.create_lock()
919
control_files.lock_write()
921
control_files.put_utf8('format', self.get_format_string())
923
for file, content in utf8_files:
924
control_files.put_utf8(file, content)
926
control_files.unlock()
927
return self.open(a_bzrdir, _found=True)
929
def initialize(self, a_bzrdir):
930
"""Create a branch of this format in a_bzrdir."""
931
raise NotImplementedError(self.initialize)
933
def is_supported(self):
934
"""Is this format supported?
936
Supported formats can be initialized and opened.
937
Unsupported formats may not support initialization or committing or
938
some other features depending on the reason for not being supported.
942
def open(self, a_bzrdir, _found=False):
943
"""Return the branch object for a_bzrdir
945
_found is a private parameter, do not use it. It is used to indicate
946
if format probing has already be done.
948
raise NotImplementedError(self.open)
951
def register_format(klass, format):
952
klass._formats[format.get_format_string()] = format
955
def set_default_format(klass, format):
956
klass._default_format = format
959
def unregister_format(klass, format):
960
assert klass._formats[format.get_format_string()] is format
961
del klass._formats[format.get_format_string()]
964
return self.get_format_string().rstrip()
966
def supports_tags(self):
967
"""True if this format supports tags stored in the branch"""
968
return False # by default
970
# XXX: Probably doesn't really belong here -- mbp 20070212
971
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
973
branch_transport = a_bzrdir.get_branch_transport(self)
974
control_files = lockable_files.LockableFiles(branch_transport,
975
lock_filename, lock_class)
976
control_files.create_lock()
977
control_files.lock_write()
979
for filename, content in utf8_files:
980
control_files.put_utf8(filename, content)
982
control_files.unlock()
985
class BranchHooks(Hooks):
986
"""A dictionary mapping hook name to a list of callables for branch hooks.
988
e.g. ['set_rh'] Is the list of items to be called when the
989
set_revision_history function is invoked.
993
"""Create the default hooks.
995
These are all empty initially, because by default nothing should get
999
# Introduced in 0.15:
1000
# invoked whenever the revision history has been set
1001
# with set_revision_history. The api signature is
1002
# (branch, revision_history), and the branch will
1005
# invoked after a push operation completes.
1006
# the api signature is
1008
# containing the members
1009
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1010
# where local is the local target branch or None, master is the target
1011
# master branch, and the rest should be self explanatory. The source
1012
# is read locked and the target branches write locked. Source will
1013
# be the local low-latency branch.
1014
self['post_push'] = []
1015
# invoked after a pull operation completes.
1016
# the api signature is
1018
# containing the members
1019
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1020
# where local is the local branch or None, master is the target
1021
# master branch, and the rest should be self explanatory. The source
1022
# is read locked and the target branches write locked. The local
1023
# branch is the low-latency branch.
1024
self['post_pull'] = []
1025
# invoked before a commit operation takes place.
1026
# the api signature is
1027
# (local, master, old_revno, old_revid, future_revno, future_revid,
1028
# tree_delta, future_tree).
1029
# old_revid is NULL_REVISION for the first commit to a branch
1030
# tree_delta is a TreeDelta object describing changes from the basis
1031
# revision, hooks MUST NOT modify this delta
1032
# future_tree is an in-memory tree obtained from
1033
# CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
1034
self['pre_commit'] = []
1035
# invoked after a commit operation completes.
1036
# the api signature is
1037
# (local, master, old_revno, old_revid, new_revno, new_revid)
1038
# old_revid is NULL_REVISION for the first commit to a branch.
1039
self['post_commit'] = []
1040
# invoked after a uncommit operation completes.
1041
# the api signature is
1042
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1043
# local is the local branch or None, master is the target branch,
1044
# and an empty branch recieves new_revno of 0, new_revid of None.
1045
self['post_uncommit'] = []
1048
# install the default hooks into the Branch class.
1049
Branch.hooks = BranchHooks()
1052
class BzrBranchFormat4(BranchFormat):
1053
"""Bzr branch format 4.
1056
- a revision-history file.
1057
- a branch-lock lock file [ to be shared with the bzrdir ]
1060
def get_format_description(self):
1061
"""See BranchFormat.get_format_description()."""
1062
return "Branch format 4"
1064
def initialize(self, a_bzrdir):
1065
"""Create a branch of this format in a_bzrdir."""
1066
utf8_files = [('revision-history', ''),
1067
('branch-name', ''),
1069
return self._initialize_helper(a_bzrdir, utf8_files,
1070
lock_type='branch4', set_format=False)
1073
super(BzrBranchFormat4, self).__init__()
1074
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1076
def open(self, a_bzrdir, _found=False):
1077
"""Return the branch object for a_bzrdir
1079
_found is a private parameter, do not use it. It is used to indicate
1080
if format probing has already be done.
1083
# we are being called directly and must probe.
1084
raise NotImplementedError
1085
return BzrBranch(_format=self,
1086
_control_files=a_bzrdir._control_files,
1088
_repository=a_bzrdir.open_repository())
1091
return "Bazaar-NG branch format 4"
1094
class BzrBranchFormat5(BranchFormat):
1095
"""Bzr branch format 5.
1098
- a revision-history file.
1100
- a lock dir guarding the branch itself
1101
- all of this stored in a branch/ subdirectory
1102
- works with shared repositories.
1104
This format is new in bzr 0.8.
1107
def get_format_string(self):
1108
"""See BranchFormat.get_format_string()."""
1109
return "Bazaar-NG branch format 5\n"
1111
def get_format_description(self):
1112
"""See BranchFormat.get_format_description()."""
1113
return "Branch format 5"
1115
def initialize(self, a_bzrdir):
1116
"""Create a branch of this format in a_bzrdir."""
1117
utf8_files = [('revision-history', ''),
1118
('branch-name', ''),
1120
return self._initialize_helper(a_bzrdir, utf8_files)
1123
super(BzrBranchFormat5, self).__init__()
1124
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1126
def open(self, a_bzrdir, _found=False):
1127
"""Return the branch object for a_bzrdir
1129
_found is a private parameter, do not use it. It is used to indicate
1130
if format probing has already be done.
1133
format = BranchFormat.find_format(a_bzrdir)
1134
assert format.__class__ == self.__class__
1136
transport = a_bzrdir.get_branch_transport(None)
1137
control_files = lockable_files.LockableFiles(transport, 'lock',
1139
return BzrBranch5(_format=self,
1140
_control_files=control_files,
1142
_repository=a_bzrdir.find_repository())
1144
raise NotBranchError(path=transport.base)
1147
class BzrBranchFormat6(BzrBranchFormat5):
1148
"""Branch format with last-revision and tags.
1150
Unlike previous formats, this has no explicit revision history. Instead,
1151
this just stores the last-revision, and the left-hand history leading
1152
up to there is the history.
1154
This format was introduced in bzr 0.15
1155
and became the default in 0.91.
1158
def get_format_string(self):
1159
"""See BranchFormat.get_format_string()."""
1160
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1162
def get_format_description(self):
1163
"""See BranchFormat.get_format_description()."""
1164
return "Branch format 6"
1166
def initialize(self, a_bzrdir):
1167
"""Create a branch of this format in a_bzrdir."""
1168
utf8_files = [('last-revision', '0 null:\n'),
1169
('branch.conf', ''),
1172
return self._initialize_helper(a_bzrdir, utf8_files)
1174
def open(self, a_bzrdir, _found=False):
1175
"""Return the branch object for a_bzrdir
1177
_found is a private parameter, do not use it. It is used to indicate
1178
if format probing has already be done.
1181
format = BranchFormat.find_format(a_bzrdir)
1182
assert format.__class__ == self.__class__
1183
transport = a_bzrdir.get_branch_transport(None)
1184
control_files = lockable_files.LockableFiles(transport, 'lock',
1186
return BzrBranch6(_format=self,
1187
_control_files=control_files,
1189
_repository=a_bzrdir.find_repository())
1191
def supports_tags(self):
1195
class BranchReferenceFormat(BranchFormat):
1196
"""Bzr branch reference format.
1198
Branch references are used in implementing checkouts, they
1199
act as an alias to the real branch which is at some other url.
1206
def get_format_string(self):
1207
"""See BranchFormat.get_format_string()."""
1208
return "Bazaar-NG Branch Reference Format 1\n"
1210
def get_format_description(self):
1211
"""See BranchFormat.get_format_description()."""
1212
return "Checkout reference format 1"
1214
def get_reference(self, a_bzrdir):
1215
"""See BranchFormat.get_reference()."""
1216
transport = a_bzrdir.get_branch_transport(None)
1217
return transport.get('location').read()
1219
def set_reference(self, a_bzrdir, to_branch):
1220
"""See BranchFormat.set_reference()."""
1221
transport = a_bzrdir.get_branch_transport(None)
1222
location = transport.put_bytes('location', to_branch.base)
1224
def initialize(self, a_bzrdir, target_branch=None):
1225
"""Create a branch of this format in a_bzrdir."""
1226
if target_branch is None:
1227
# this format does not implement branch itself, thus the implicit
1228
# creation contract must see it as uninitializable
1229
raise errors.UninitializableFormat(self)
1230
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1231
branch_transport = a_bzrdir.get_branch_transport(self)
1232
branch_transport.put_bytes('location',
1233
target_branch.bzrdir.root_transport.base)
1234
branch_transport.put_bytes('format', self.get_format_string())
1236
a_bzrdir, _found=True,
1237
possible_transports=[target_branch.bzrdir.root_transport])
1240
super(BranchReferenceFormat, self).__init__()
1241
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1243
def _make_reference_clone_function(format, a_branch):
1244
"""Create a clone() routine for a branch dynamically."""
1245
def clone(to_bzrdir, revision_id=None):
1246
"""See Branch.clone()."""
1247
return format.initialize(to_bzrdir, a_branch)
1248
# cannot obey revision_id limits when cloning a reference ...
1249
# FIXME RBC 20060210 either nuke revision_id for clone, or
1250
# emit some sort of warning/error to the caller ?!
1253
def open(self, a_bzrdir, _found=False, location=None,
1254
possible_transports=None):
1255
"""Return the branch that the branch reference in a_bzrdir points at.
1257
_found is a private parameter, do not use it. It is used to indicate
1258
if format probing has already be done.
1261
format = BranchFormat.find_format(a_bzrdir)
1262
assert format.__class__ == self.__class__
1263
if location is None:
1264
location = self.get_reference(a_bzrdir)
1265
real_bzrdir = bzrdir.BzrDir.open(
1266
location, possible_transports=possible_transports)
1267
result = real_bzrdir.open_branch()
1268
# this changes the behaviour of result.clone to create a new reference
1269
# rather than a copy of the content of the branch.
1270
# I did not use a proxy object because that needs much more extensive
1271
# testing, and we are only changing one behaviour at the moment.
1272
# If we decide to alter more behaviours - i.e. the implicit nickname
1273
# then this should be refactored to introduce a tested proxy branch
1274
# and a subclass of that for use in overriding clone() and ....
1276
result.clone = self._make_reference_clone_function(result)
1280
# formats which have no format string are not discoverable
1281
# and not independently creatable, so are not registered.
1282
__format5 = BzrBranchFormat5()
1283
__format6 = BzrBranchFormat6()
1284
BranchFormat.register_format(__format5)
1285
BranchFormat.register_format(BranchReferenceFormat())
1286
BranchFormat.register_format(__format6)
1287
BranchFormat.set_default_format(__format6)
1288
_legacy_formats = [BzrBranchFormat4(),
1291
class BzrBranch(Branch):
1292
"""A branch stored in the actual filesystem.
1294
Note that it's "local" in the context of the filesystem; it doesn't
1295
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1296
it's writable, and can be accessed via the normal filesystem API.
1299
def __init__(self, _format=None,
1300
_control_files=None, a_bzrdir=None, _repository=None):
1301
"""Create new branch object at a particular location."""
1302
Branch.__init__(self)
1303
if a_bzrdir is None:
1304
raise ValueError('a_bzrdir must be supplied')
1306
self.bzrdir = a_bzrdir
1307
# self._transport used to point to the directory containing the
1308
# control directory, but was not used - now it's just the transport
1309
# for the branch control files. mbp 20070212
1310
self._base = self.bzrdir.transport.clone('..').base
1311
self._format = _format
1312
if _control_files is None:
1313
raise ValueError('BzrBranch _control_files is None')
1314
self.control_files = _control_files
1315
self._transport = _control_files._transport
1316
self.repository = _repository
1319
return '%s(%r)' % (self.__class__.__name__, self.base)
1323
def _get_base(self):
1324
"""Returns the directory containing the control directory."""
1327
base = property(_get_base, doc="The URL for the root of this branch.")
1329
def abspath(self, name):
1330
"""See Branch.abspath."""
1331
return self.control_files._transport.abspath(name)
1334
@deprecated_method(zero_sixteen)
1336
def get_root_id(self):
1337
"""See Branch.get_root_id."""
1338
tree = self.repository.revision_tree(self.last_revision())
1339
return tree.get_root_id()
1341
def is_locked(self):
1342
return self.control_files.is_locked()
1344
def lock_write(self, token=None):
1345
repo_token = self.repository.lock_write()
1347
token = self.control_files.lock_write(token=token)
1349
self.repository.unlock()
1353
def lock_read(self):
1354
self.repository.lock_read()
1356
self.control_files.lock_read()
1358
self.repository.unlock()
1362
# TODO: test for failed two phase locks. This is known broken.
1364
self.control_files.unlock()
1366
self.repository.unlock()
1367
if not self.control_files.is_locked():
1368
# we just released the lock
1369
self._clear_cached_state()
1371
def peek_lock_mode(self):
1372
if self.control_files._lock_count == 0:
1375
return self.control_files._lock_mode
1377
def get_physical_lock_status(self):
1378
return self.control_files.get_physical_lock_status()
1381
def print_file(self, file, revision_id):
1382
"""See Branch.print_file."""
1383
return self.repository.print_file(file, revision_id)
1385
def _write_revision_history(self, history):
1386
"""Factored out of set_revision_history.
1388
This performs the actual writing to disk.
1389
It is intended to be called by BzrBranch5.set_revision_history."""
1390
self.control_files.put_bytes(
1391
'revision-history', '\n'.join(history))
1394
def set_revision_history(self, rev_history):
1395
"""See Branch.set_revision_history."""
1396
if 'evil' in debug.debug_flags:
1397
mutter_callsite(3, "set_revision_history scales with history.")
1398
self._clear_cached_state()
1399
self._write_revision_history(rev_history)
1400
self._cache_revision_history(rev_history)
1401
for hook in Branch.hooks['set_rh']:
1402
hook(self, rev_history)
1405
def set_last_revision_info(self, revno, revision_id):
1406
"""Set the last revision of this branch.
1408
The caller is responsible for checking that the revno is correct
1409
for this revision id.
1411
It may be possible to set the branch last revision to an id not
1412
present in the repository. However, branches can also be
1413
configured to check constraints on history, in which case this may not
1416
history = self._lefthand_history(revision_id)
1417
assert len(history) == revno, '%d != %d' % (len(history), revno)
1418
self.set_revision_history(history)
1420
def _gen_revision_history(self):
1421
history = self.control_files.get('revision-history').read().split('\n')
1422
if history[-1:] == ['']:
1423
# There shouldn't be a trailing newline, but just in case.
1427
def _lefthand_history(self, revision_id, last_rev=None,
1429
if 'evil' in debug.debug_flags:
1430
mutter_callsite(4, "_lefthand_history scales with history.")
1431
# stop_revision must be a descendant of last_revision
1432
stop_graph = self.repository.get_revision_graph(revision_id)
1433
if (last_rev is not None and last_rev != _mod_revision.NULL_REVISION
1434
and last_rev not in stop_graph):
1435
# our previous tip is not merged into stop_revision
1436
raise errors.DivergedBranches(self, other_branch)
1437
# make a new revision history from the graph
1438
current_rev_id = revision_id
1440
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1441
new_history.append(current_rev_id)
1442
current_rev_id_parents = stop_graph[current_rev_id]
1444
current_rev_id = current_rev_id_parents[0]
1446
current_rev_id = None
1447
new_history.reverse()
1451
def generate_revision_history(self, revision_id, last_rev=None,
1453
"""Create a new revision history that will finish with revision_id.
1455
:param revision_id: the new tip to use.
1456
:param last_rev: The previous last_revision. If not None, then this
1457
must be a ancestory of revision_id, or DivergedBranches is raised.
1458
:param other_branch: The other branch that DivergedBranches should
1459
raise with respect to.
1461
self.set_revision_history(self._lefthand_history(revision_id,
1462
last_rev, other_branch))
1465
def update_revisions(self, other, stop_revision=None, overwrite=False):
1466
"""See Branch.update_revisions."""
1469
other_last_revno, other_last_revision = other.last_revision_info()
1470
if stop_revision is None:
1471
stop_revision = other_last_revision
1472
if _mod_revision.is_null(stop_revision):
1473
# if there are no commits, we're done.
1475
# whats the current last revision, before we fetch [and change it
1477
last_rev = _mod_revision.ensure_null(self.last_revision())
1478
# we fetch here so that we don't process data twice in the common
1479
# case of having something to pull, and so that the check for
1480
# already merged can operate on the just fetched graph, which will
1481
# be cached in memory.
1482
self.fetch(other, stop_revision)
1483
# Check to see if one is an ancestor of the other
1485
heads = self.repository.get_graph().heads([stop_revision,
1487
if heads == set([last_rev]):
1488
# The current revision is a decendent of the target,
1491
elif heads == set([stop_revision, last_rev]):
1492
# These branches have diverged
1493
raise errors.DivergedBranches(self, other)
1494
assert heads == set([stop_revision])
1495
if other_last_revision == stop_revision:
1496
self.set_last_revision_info(other_last_revno,
1497
other_last_revision)
1499
# TODO: jam 2007-11-29 Is there a way to determine the
1500
# revno without searching all of history??
1502
self.generate_revision_history(stop_revision)
1504
self.generate_revision_history(stop_revision,
1505
last_rev=last_rev, other_branch=other)
1509
def basis_tree(self):
1510
"""See Branch.basis_tree."""
1511
return self.repository.revision_tree(self.last_revision())
1514
def pull(self, source, overwrite=False, stop_revision=None,
1515
_hook_master=None, run_hooks=True, possible_transports=None):
1518
:param _hook_master: Private parameter - set the branch to
1519
be supplied as the master to push hooks.
1520
:param run_hooks: Private parameter - if false, this branch
1521
is being called because it's the master of the primary branch,
1522
so it should not run its hooks.
1524
result = PullResult()
1525
result.source_branch = source
1526
result.target_branch = self
1529
result.old_revno, result.old_revid = self.last_revision_info()
1530
self.update_revisions(source, stop_revision, overwrite=overwrite)
1531
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
1532
result.new_revno, result.new_revid = self.last_revision_info()
1534
result.master_branch = _hook_master
1535
result.local_branch = self
1537
result.master_branch = self
1538
result.local_branch = None
1540
for hook in Branch.hooks['post_pull']:
1546
def _get_parent_location(self):
1547
_locs = ['parent', 'pull', 'x-pull']
1550
return self.control_files.get(l).read().strip('\n')
1556
def push(self, target, overwrite=False, stop_revision=None,
1557
_override_hook_source_branch=None):
1560
This is the basic concrete implementation of push()
1562
:param _override_hook_source_branch: If specified, run
1563
the hooks passing this Branch as the source, rather than self.
1564
This is for use of RemoteBranch, where push is delegated to the
1565
underlying vfs-based Branch.
1567
# TODO: Public option to disable running hooks - should be trivial but
1571
result = self._push_with_bound_branches(target, overwrite,
1573
_override_hook_source_branch=_override_hook_source_branch)
1578
def _push_with_bound_branches(self, target, overwrite,
1580
_override_hook_source_branch=None):
1581
"""Push from self into target, and into target's master if any.
1583
This is on the base BzrBranch class even though it doesn't support
1584
bound branches because the *target* might be bound.
1587
if _override_hook_source_branch:
1588
result.source_branch = _override_hook_source_branch
1589
for hook in Branch.hooks['post_push']:
1592
bound_location = target.get_bound_location()
1593
if bound_location and target.base != bound_location:
1594
# there is a master branch.
1596
# XXX: Why the second check? Is it even supported for a branch to
1597
# be bound to itself? -- mbp 20070507
1598
master_branch = target.get_master_branch()
1599
master_branch.lock_write()
1601
# push into the master from this branch.
1602
self._basic_push(master_branch, overwrite, stop_revision)
1603
# and push into the target branch from this. Note that we push from
1604
# this branch again, because its considered the highest bandwidth
1606
result = self._basic_push(target, overwrite, stop_revision)
1607
result.master_branch = master_branch
1608
result.local_branch = target
1612
master_branch.unlock()
1615
result = self._basic_push(target, overwrite, stop_revision)
1616
# TODO: Why set master_branch and local_branch if there's no
1617
# binding? Maybe cleaner to just leave them unset? -- mbp
1619
result.master_branch = target
1620
result.local_branch = None
1624
def _basic_push(self, target, overwrite, stop_revision):
1625
"""Basic implementation of push without bound branches or hooks.
1627
Must be called with self read locked and target write locked.
1629
result = PushResult()
1630
result.source_branch = self
1631
result.target_branch = target
1632
result.old_revno, result.old_revid = target.last_revision_info()
1634
target.update_revisions(self, stop_revision)
1635
except DivergedBranches:
1639
target.set_revision_history(self.revision_history())
1640
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
1641
result.new_revno, result.new_revid = target.last_revision_info()
1644
def get_parent(self):
1645
"""See Branch.get_parent."""
1647
assert self.base[-1] == '/'
1648
parent = self._get_parent_location()
1651
# This is an old-format absolute path to a local branch
1652
# turn it into a url
1653
if parent.startswith('/'):
1654
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1656
return urlutils.join(self.base[:-1], parent)
1657
except errors.InvalidURLJoin, e:
1658
raise errors.InaccessibleParent(parent, self.base)
1660
def set_push_location(self, location):
1661
"""See Branch.set_push_location."""
1662
self.get_config().set_user_option(
1663
'push_location', location,
1664
store=_mod_config.STORE_LOCATION_NORECURSE)
1667
def set_parent(self, url):
1668
"""See Branch.set_parent."""
1669
# TODO: Maybe delete old location files?
1670
# URLs should never be unicode, even on the local fs,
1671
# FIXUP this and get_parent in a future branch format bump:
1672
# read and rewrite the file, and have the new format code read
1673
# using .get not .get_utf8. RBC 20060125
1675
if isinstance(url, unicode):
1677
url = url.encode('ascii')
1678
except UnicodeEncodeError:
1679
raise errors.InvalidURL(url,
1680
"Urls must be 7-bit ascii, "
1681
"use bzrlib.urlutils.escape")
1682
url = urlutils.relative_url(self.base, url)
1683
self._set_parent_location(url)
1685
def _set_parent_location(self, url):
1687
self.control_files._transport.delete('parent')
1689
assert isinstance(url, str)
1690
self.control_files.put_bytes('parent', url + '\n')
1693
class BzrBranch5(BzrBranch):
1694
"""A format 5 branch. This supports new features over plain branches.
1696
It has support for a master_branch which is the data for bound branches.
1704
super(BzrBranch5, self).__init__(_format=_format,
1705
_control_files=_control_files,
1707
_repository=_repository)
1710
def pull(self, source, overwrite=False, stop_revision=None,
1711
run_hooks=True, possible_transports=None):
1712
"""Pull from source into self, updating my master if any.
1714
:param run_hooks: Private parameter - if false, this branch
1715
is being called because it's the master of the primary branch,
1716
so it should not run its hooks.
1718
bound_location = self.get_bound_location()
1719
master_branch = None
1720
if bound_location and source.base != bound_location:
1721
# not pulling from master, so we need to update master.
1722
master_branch = self.get_master_branch(possible_transports)
1723
master_branch.lock_write()
1726
# pull from source into master.
1727
master_branch.pull(source, overwrite, stop_revision,
1729
return super(BzrBranch5, self).pull(source, overwrite,
1730
stop_revision, _hook_master=master_branch,
1731
run_hooks=run_hooks)
1734
master_branch.unlock()
1736
def get_bound_location(self):
1738
return self.control_files.get_utf8('bound').read()[:-1]
1739
except errors.NoSuchFile:
1743
def get_master_branch(self, possible_transports=None):
1744
"""Return the branch we are bound to.
1746
:return: Either a Branch, or None
1748
This could memoise the branch, but if thats done
1749
it must be revalidated on each new lock.
1750
So for now we just don't memoise it.
1751
# RBC 20060304 review this decision.
1753
bound_loc = self.get_bound_location()
1757
return Branch.open(bound_loc,
1758
possible_transports=possible_transports)
1759
except (errors.NotBranchError, errors.ConnectionError), e:
1760
raise errors.BoundBranchConnectionFailure(
1764
def set_bound_location(self, location):
1765
"""Set the target where this branch is bound to.
1767
:param location: URL to the target branch
1770
self.control_files.put_utf8('bound', location+'\n')
1773
self.control_files._transport.delete('bound')
1779
def bind(self, other):
1780
"""Bind this branch to the branch other.
1782
This does not push or pull data between the branches, though it does
1783
check for divergence to raise an error when the branches are not
1784
either the same, or one a prefix of the other. That behaviour may not
1785
be useful, so that check may be removed in future.
1787
:param other: The branch to bind to
1790
# TODO: jam 20051230 Consider checking if the target is bound
1791
# It is debatable whether you should be able to bind to
1792
# a branch which is itself bound.
1793
# Committing is obviously forbidden,
1794
# but binding itself may not be.
1795
# Since we *have* to check at commit time, we don't
1796
# *need* to check here
1798
# we want to raise diverged if:
1799
# last_rev is not in the other_last_rev history, AND
1800
# other_last_rev is not in our history, and do it without pulling
1802
self.set_bound_location(other.base)
1806
"""If bound, unbind"""
1807
return self.set_bound_location(None)
1810
def update(self, possible_transports=None):
1811
"""Synchronise this branch with the master branch if any.
1813
:return: None or the last_revision that was pivoted out during the
1816
master = self.get_master_branch(possible_transports)
1817
if master is not None:
1818
old_tip = _mod_revision.ensure_null(self.last_revision())
1819
self.pull(master, overwrite=True)
1820
if self.repository.get_graph().is_ancestor(old_tip,
1821
_mod_revision.ensure_null(self.last_revision())):
1827
class BzrBranchExperimental(BzrBranch5):
1828
"""Bzr experimental branch format
1831
- a revision-history file.
1833
- a lock dir guarding the branch itself
1834
- all of this stored in a branch/ subdirectory
1835
- works with shared repositories.
1836
- a tag dictionary in the branch
1838
This format is new in bzr 0.15, but shouldn't be used for real data,
1841
This class acts as it's own BranchFormat.
1844
_matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1847
def get_format_string(cls):
1848
"""See BranchFormat.get_format_string()."""
1849
return "Bazaar-NG branch format experimental\n"
1852
def get_format_description(cls):
1853
"""See BranchFormat.get_format_description()."""
1854
return "Experimental branch format"
1857
def get_reference(cls, a_bzrdir):
1858
"""Get the target reference of the branch in a_bzrdir.
1860
format probing must have been completed before calling
1861
this method - it is assumed that the format of the branch
1862
in a_bzrdir is correct.
1864
:param a_bzrdir: The bzrdir to get the branch data from.
1865
:return: None if the branch is not a reference branch.
1870
def set_reference(self, a_bzrdir, to_branch):
1871
"""Set the target reference of the branch in a_bzrdir.
1873
format probing must have been completed before calling
1874
this method - it is assumed that the format of the branch
1875
in a_bzrdir is correct.
1877
:param a_bzrdir: The bzrdir to set the branch reference for.
1878
:param to_branch: branch that the checkout is to reference
1880
raise NotImplementedError(self.set_reference)
1883
def _initialize_control_files(cls, a_bzrdir, utf8_files, lock_filename,
1885
branch_transport = a_bzrdir.get_branch_transport(cls)
1886
control_files = lockable_files.LockableFiles(branch_transport,
1887
lock_filename, lock_class)
1888
control_files.create_lock()
1889
control_files.lock_write()
1891
for filename, content in utf8_files:
1892
control_files.put_utf8(filename, content)
1894
control_files.unlock()
1897
def initialize(cls, a_bzrdir):
1898
"""Create a branch of this format in a_bzrdir."""
1899
utf8_files = [('format', cls.get_format_string()),
1900
('revision-history', ''),
1901
('branch-name', ''),
1904
cls._initialize_control_files(a_bzrdir, utf8_files,
1905
'lock', lockdir.LockDir)
1906
return cls.open(a_bzrdir, _found=True)
1909
def open(cls, a_bzrdir, _found=False):
1910
"""Return the branch object for a_bzrdir
1912
_found is a private parameter, do not use it. It is used to indicate
1913
if format probing has already be done.
1916
format = BranchFormat.find_format(a_bzrdir)
1917
assert format.__class__ == cls
1918
transport = a_bzrdir.get_branch_transport(None)
1919
control_files = lockable_files.LockableFiles(transport, 'lock',
1921
return cls(_format=cls,
1922
_control_files=control_files,
1924
_repository=a_bzrdir.find_repository())
1927
def is_supported(cls):
1930
def _make_tags(self):
1931
return BasicTags(self)
1934
def supports_tags(cls):
1938
BranchFormat.register_format(BzrBranchExperimental)
1941
class BzrBranch6(BzrBranch5):
1944
def last_revision_info(self):
1945
revision_string = self.control_files.get('last-revision').read()
1946
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1947
revision_id = cache_utf8.get_cached_utf8(revision_id)
1949
return revno, revision_id
1951
def last_revision(self):
1952
"""Return last revision id, or None"""
1953
revision_id = self.last_revision_info()[1]
1956
def _write_last_revision_info(self, revno, revision_id):
1957
"""Simply write out the revision id, with no checks.
1959
Use set_last_revision_info to perform this safely.
1961
Does not update the revision_history cache.
1962
Intended to be called by set_last_revision_info and
1963
_write_revision_history.
1965
if revision_id is None:
1966
revision_id = 'null:'
1967
out_string = '%d %s\n' % (revno, revision_id)
1968
self.control_files.put_bytes('last-revision', out_string)
1971
def set_last_revision_info(self, revno, revision_id):
1972
if self._get_append_revisions_only():
1973
self._check_history_violation(revision_id)
1974
self._write_last_revision_info(revno, revision_id)
1975
self._clear_cached_state()
1977
def _check_history_violation(self, revision_id):
1978
last_revision = _mod_revision.ensure_null(self.last_revision())
1979
if _mod_revision.is_null(last_revision):
1981
if last_revision not in self._lefthand_history(revision_id):
1982
raise errors.AppendRevisionsOnlyViolation(self.base)
1984
def _gen_revision_history(self):
1985
"""Generate the revision history from last revision
1987
history = list(self.repository.iter_reverse_revision_history(
1988
self.last_revision()))
1992
def _write_revision_history(self, history):
1993
"""Factored out of set_revision_history.
1995
This performs the actual writing to disk, with format-specific checks.
1996
It is intended to be called by BzrBranch5.set_revision_history.
1998
if len(history) == 0:
1999
last_revision = 'null:'
2001
if history != self._lefthand_history(history[-1]):
2002
raise errors.NotLefthandHistory(history)
2003
last_revision = history[-1]
2004
if self._get_append_revisions_only():
2005
self._check_history_violation(last_revision)
2006
self._write_last_revision_info(len(history), last_revision)
2009
def _set_parent_location(self, url):
2010
"""Set the parent branch"""
2011
self._set_config_location('parent_location', url, make_relative=True)
2014
def _get_parent_location(self):
2015
"""Set the parent branch"""
2016
return self._get_config_location('parent_location')
2018
def set_push_location(self, location):
2019
"""See Branch.set_push_location."""
2020
self._set_config_location('push_location', location)
2022
def set_bound_location(self, location):
2023
"""See Branch.set_push_location."""
2025
config = self.get_config()
2026
if location is None:
2027
if config.get_user_option('bound') != 'True':
2030
config.set_user_option('bound', 'False', warn_masked=True)
2033
self._set_config_location('bound_location', location,
2035
config.set_user_option('bound', 'True', warn_masked=True)
2038
def _get_bound_location(self, bound):
2039
"""Return the bound location in the config file.
2041
Return None if the bound parameter does not match"""
2042
config = self.get_config()
2043
config_bound = (config.get_user_option('bound') == 'True')
2044
if config_bound != bound:
2046
return self._get_config_location('bound_location', config=config)
2048
def get_bound_location(self):
2049
"""See Branch.set_push_location."""
2050
return self._get_bound_location(True)
2052
def get_old_bound_location(self):
2053
"""See Branch.get_old_bound_location"""
2054
return self._get_bound_location(False)
2056
def set_append_revisions_only(self, enabled):
2061
self.get_config().set_user_option('append_revisions_only', value,
2064
def _get_append_revisions_only(self):
2065
value = self.get_config().get_user_option('append_revisions_only')
2066
return value == 'True'
2068
def _synchronize_history(self, destination, revision_id):
2069
"""Synchronize last revision and revision history between branches.
2071
This version is most efficient when the destination is also a
2072
BzrBranch6, but works for BzrBranch5, as long as the destination's
2073
repository contains all the lefthand ancestors of the intended
2074
last_revision. If not, set_last_revision_info will fail.
2076
:param destination: The branch to copy the history into
2077
:param revision_id: The revision-id to truncate history at. May
2078
be None to copy complete history.
2080
source_revno, source_revision_id = self.last_revision_info()
2081
if revision_id is None:
2082
revno, revision_id = source_revno, source_revision_id
2083
elif source_revision_id == revision_id:
2084
# we know the revno without needing to walk all of history
2085
revno = source_revno
2087
# To figure out the revno for a random revision, we need to build
2088
# the revision history, and count its length.
2089
# We don't care about the order, just how long it is.
2090
# Alternatively, we could start at the current location, and count
2091
# backwards. But there is no guarantee that we will find it since
2092
# it may be a merged revision.
2093
revno = len(list(self.repository.iter_reverse_revision_history(
2095
destination.set_last_revision_info(revno, revision_id)
2097
def _make_tags(self):
2098
return BasicTags(self)
2101
######################################################################
2102
# results of operations
2105
class _Result(object):
2107
def _show_tag_conficts(self, to_file):
2108
if not getattr(self, 'tag_conflicts', None):
2110
to_file.write('Conflicting tags:\n')
2111
for name, value1, value2 in self.tag_conflicts:
2112
to_file.write(' %s\n' % (name, ))
2115
class PullResult(_Result):
2116
"""Result of a Branch.pull operation.
2118
:ivar old_revno: Revision number before pull.
2119
:ivar new_revno: Revision number after pull.
2120
:ivar old_revid: Tip revision id before pull.
2121
:ivar new_revid: Tip revision id after pull.
2122
:ivar source_branch: Source (local) branch object.
2123
:ivar master_branch: Master branch of the target, or None.
2124
:ivar target_branch: Target/destination branch object.
2128
# DEPRECATED: pull used to return the change in revno
2129
return self.new_revno - self.old_revno
2131
def report(self, to_file):
2132
if self.old_revid == self.new_revid:
2133
to_file.write('No revisions to pull.\n')
2135
to_file.write('Now on revision %d.\n' % self.new_revno)
2136
self._show_tag_conficts(to_file)
2139
class PushResult(_Result):
2140
"""Result of a Branch.push operation.
2142
:ivar old_revno: Revision number before push.
2143
:ivar new_revno: Revision number after push.
2144
:ivar old_revid: Tip revision id before push.
2145
:ivar new_revid: Tip revision id after push.
2146
:ivar source_branch: Source branch object.
2147
:ivar master_branch: Master branch of the target, or None.
2148
:ivar target_branch: Target/destination branch object.
2152
# DEPRECATED: push used to return the change in revno
2153
return self.new_revno - self.old_revno
2155
def report(self, to_file):
2156
"""Write a human-readable description of the result."""
2157
if self.old_revid == self.new_revid:
2158
to_file.write('No new revisions to push.\n')
2160
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2161
self._show_tag_conficts(to_file)
2164
class BranchCheckResult(object):
2165
"""Results of checking branch consistency.
2170
def __init__(self, branch):
2171
self.branch = branch
2173
def report_results(self, verbose):
2174
"""Report the check results via trace.note.
2176
:param verbose: Requests more detailed display of what was checked,
2179
note('checked branch %s format %s',
2181
self.branch._format)
2184
class Converter5to6(object):
2185
"""Perform an in-place upgrade of format 5 to format 6"""
2187
def convert(self, branch):
2188
# Data for 5 and 6 can peacefully coexist.
2189
format = BzrBranchFormat6()
2190
new_branch = format.open(branch.bzrdir, _found=True)
2192
# Copy source data into target
2193
new_branch.set_last_revision_info(*branch.last_revision_info())
2194
new_branch.set_parent(branch.get_parent())
2195
new_branch.set_bound_location(branch.get_bound_location())
2196
new_branch.set_push_location(branch.get_push_location())
2198
# New branch has no tags by default
2199
new_branch.tags._set_tag_dict({})
2201
# Copying done; now update target format
2202
new_branch.control_files.put_utf8('format',
2203
format.get_format_string())
2205
# Clean up old files
2206
new_branch.control_files._transport.delete('revision-history')
2208
branch.set_parent(None)
2211
branch.set_bound_location(None)
added
removed
bzrlib/branch.py
