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, is_quiet
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 NULL_REVISION."""
440
return self.last_revision_info()[1]
442
def last_revision_info(self):
443
"""Return information about the last revision.
445
:return: A tuple (revno, last_revision_id).
447
rh = self.revision_history()
450
return (revno, rh[-1])
452
return (0, _mod_revision.NULL_REVISION)
454
def missing_revisions(self, other, stop_revision=None):
455
"""Return a list of new revisions that would perfectly fit.
457
If self and other have not diverged, return a list of the revisions
458
present in other, but missing from self.
460
self_history = self.revision_history()
461
self_len = len(self_history)
462
other_history = other.revision_history()
463
other_len = len(other_history)
464
common_index = min(self_len, other_len) -1
465
if common_index >= 0 and \
466
self_history[common_index] != other_history[common_index]:
467
raise DivergedBranches(self, other)
469
if stop_revision is None:
470
stop_revision = other_len
472
assert isinstance(stop_revision, int)
473
if stop_revision > other_len:
474
raise errors.NoSuchRevision(self, stop_revision)
475
return other_history[self_len:stop_revision]
477
def update_revisions(self, other, stop_revision=None):
478
"""Pull in new perfect-fit revisions.
480
:param other: Another Branch to pull from
481
:param stop_revision: Updated until the given revision
484
raise NotImplementedError(self.update_revisions)
486
def revision_id_to_revno(self, revision_id):
487
"""Given a revision id, return its revno"""
488
if _mod_revision.is_null(revision_id):
490
history = self.revision_history()
492
return history.index(revision_id) + 1
494
raise errors.NoSuchRevision(self, revision_id)
496
def get_rev_id(self, revno, history=None):
497
"""Find the revision id of the specified revno."""
499
return _mod_revision.NULL_REVISION
501
history = self.revision_history()
502
if revno <= 0 or revno > len(history):
503
raise errors.NoSuchRevision(self, revno)
504
return history[revno - 1]
506
def pull(self, source, overwrite=False, stop_revision=None,
507
possible_transports=None):
508
"""Mirror source into this branch.
510
This branch is considered to be 'local', having low latency.
512
:returns: PullResult instance
514
raise NotImplementedError(self.pull)
516
def push(self, target, overwrite=False, stop_revision=None):
517
"""Mirror this branch into target.
519
This branch is considered to be 'local', having low latency.
521
raise NotImplementedError(self.push)
523
def basis_tree(self):
524
"""Return `Tree` object for last revision."""
525
return self.repository.revision_tree(self.last_revision())
527
def rename_one(self, from_rel, to_rel):
530
This can change the directory or the filename or both.
532
raise NotImplementedError(self.rename_one)
534
def move(self, from_paths, to_name):
537
to_name must exist as a versioned directory.
539
If to_name exists and is a directory, the files are moved into
540
it, keeping their old names. If it is a directory,
542
Note that to_name is only the last component of the new name;
543
this doesn't change the directory.
545
This returns a list of (from_path, to_path) pairs for each
548
raise NotImplementedError(self.move)
550
def get_parent(self):
551
"""Return the parent location of the branch.
553
This is the default location for push/pull/missing. The usual
554
pattern is that the user can override it by specifying a
557
raise NotImplementedError(self.get_parent)
559
def _set_config_location(self, name, url, config=None,
560
make_relative=False):
562
config = self.get_config()
566
url = urlutils.relative_url(self.base, url)
567
config.set_user_option(name, url, warn_masked=True)
569
def _get_config_location(self, name, config=None):
571
config = self.get_config()
572
location = config.get_user_option(name)
577
def get_submit_branch(self):
578
"""Return the submit location of the branch.
580
This is the default location for bundle. The usual
581
pattern is that the user can override it by specifying a
584
return self.get_config().get_user_option('submit_branch')
586
def set_submit_branch(self, location):
587
"""Return the submit location of the branch.
589
This is the default location for bundle. The usual
590
pattern is that the user can override it by specifying a
593
self.get_config().set_user_option('submit_branch', location,
596
def get_public_branch(self):
597
"""Return the public location of the branch.
599
This is is used by merge directives.
601
return self._get_config_location('public_branch')
603
def set_public_branch(self, location):
604
"""Return the submit location of the branch.
606
This is the default location for bundle. The usual
607
pattern is that the user can override it by specifying a
610
self._set_config_location('public_branch', location)
612
def get_push_location(self):
613
"""Return the None or the location to push this branch to."""
614
push_loc = self.get_config().get_user_option('push_location')
617
def set_push_location(self, location):
618
"""Set a new push location for this branch."""
619
raise NotImplementedError(self.set_push_location)
621
def set_parent(self, url):
622
raise NotImplementedError(self.set_parent)
626
"""Synchronise this branch with the master branch if any.
628
:return: None or the last_revision pivoted out during the update.
632
def check_revno(self, revno):
634
Check whether a revno corresponds to any revision.
635
Zero (the NULL revision) is considered valid.
638
self.check_real_revno(revno)
640
def check_real_revno(self, revno):
642
Check whether a revno corresponds to a real revision.
643
Zero (the NULL revision) is considered invalid
645
if revno < 1 or revno > self.revno():
646
raise InvalidRevisionNumber(revno)
649
def clone(self, to_bzrdir, revision_id=None):
650
"""Clone this branch into to_bzrdir preserving all semantic values.
652
revision_id: if not None, the revision history in the new branch will
653
be truncated to end with revision_id.
655
result = self._format.initialize(to_bzrdir)
656
self.copy_content_into(result, revision_id=revision_id)
660
def sprout(self, to_bzrdir, revision_id=None):
661
"""Create a new line of development from the branch, into to_bzrdir.
663
revision_id: if not None, the revision history in the new branch will
664
be truncated to end with revision_id.
666
result = self._format.initialize(to_bzrdir)
667
self.copy_content_into(result, revision_id=revision_id)
668
result.set_parent(self.bzrdir.root_transport.base)
671
def _synchronize_history(self, destination, revision_id):
672
"""Synchronize last revision and revision history between branches.
674
This version is most efficient when the destination is also a
675
BzrBranch5, but works for BzrBranch6 as long as the revision
676
history is the true lefthand parent history, and all of the revisions
677
are in the destination's repository. If not, set_revision_history
680
:param destination: The branch to copy the history into
681
:param revision_id: The revision-id to truncate history at. May
682
be None to copy complete history.
684
if revision_id == _mod_revision.NULL_REVISION:
686
new_history = self.revision_history()
687
if revision_id is not None and new_history != []:
689
new_history = new_history[:new_history.index(revision_id) + 1]
691
rev = self.repository.get_revision(revision_id)
692
new_history = rev.get_history(self.repository)[1:]
693
destination.set_revision_history(new_history)
696
def copy_content_into(self, destination, revision_id=None):
697
"""Copy the content of self into destination.
699
revision_id: if not None, the revision history in the new branch will
700
be truncated to end with revision_id.
702
self._synchronize_history(destination, revision_id)
704
parent = self.get_parent()
705
except errors.InaccessibleParent, e:
706
mutter('parent was not accessible to copy: %s', e)
709
destination.set_parent(parent)
710
self.tags.merge_to(destination.tags)
714
"""Check consistency of the branch.
716
In particular this checks that revisions given in the revision-history
717
do actually match up in the revision graph, and that they're all
718
present in the repository.
720
Callers will typically also want to check the repository.
722
:return: A BranchCheckResult.
724
mainline_parent_id = None
725
for revision_id in self.revision_history():
727
revision = self.repository.get_revision(revision_id)
728
except errors.NoSuchRevision, e:
729
raise errors.BzrCheckError("mainline revision {%s} not in repository"
731
# In general the first entry on the revision history has no parents.
732
# But it's not illegal for it to have parents listed; this can happen
733
# in imports from Arch when the parents weren't reachable.
734
if mainline_parent_id is not None:
735
if mainline_parent_id not in revision.parent_ids:
736
raise errors.BzrCheckError("previous revision {%s} not listed among "
738
% (mainline_parent_id, revision_id))
739
mainline_parent_id = revision_id
740
return BranchCheckResult(self)
742
def _get_checkout_format(self):
743
"""Return the most suitable metadir for a checkout of this branch.
744
Weaves are used if this branch's repository uses weaves.
746
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
747
from bzrlib.repofmt import weaverepo
748
format = bzrdir.BzrDirMetaFormat1()
749
format.repository_format = weaverepo.RepositoryFormat7()
751
format = self.repository.bzrdir.checkout_metadir()
752
format.set_branch_format(self._format)
755
def create_checkout(self, to_location, revision_id=None,
756
lightweight=False, accelerator_tree=None):
757
"""Create a checkout of a branch.
759
:param to_location: The url to produce the checkout at
760
:param revision_id: The revision to check out
761
:param lightweight: If True, produce a lightweight checkout, otherwise,
762
produce a bound branch (heavyweight checkout)
763
:param accelerator_tree: A tree which can be used for retrieving file
764
contents more quickly than the revision tree, i.e. a workingtree.
765
The revision tree will be used for cases where accelerator_tree's
766
content is different.
767
:return: The tree of the created checkout
769
t = transport.get_transport(to_location)
772
format = self._get_checkout_format()
773
checkout = format.initialize_on_transport(t)
774
from_branch = BranchReferenceFormat().initialize(checkout, self)
776
format = self._get_checkout_format()
777
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
778
to_location, force_new_tree=False, format=format)
779
checkout = checkout_branch.bzrdir
780
checkout_branch.bind(self)
781
# pull up to the specified revision_id to set the initial
782
# branch tip correctly, and seed it with history.
783
checkout_branch.pull(self, stop_revision=revision_id)
785
tree = checkout.create_workingtree(revision_id,
786
from_branch=from_branch,
787
accelerator_tree=accelerator_tree)
788
basis_tree = tree.basis_tree()
789
basis_tree.lock_read()
791
for path, file_id in basis_tree.iter_references():
792
reference_parent = self.reference_parent(file_id, path)
793
reference_parent.create_checkout(tree.abspath(path),
794
basis_tree.get_reference_revision(file_id, path),
800
def reference_parent(self, file_id, path):
801
"""Return the parent branch for a tree-reference file_id
802
:param file_id: The file_id of the tree reference
803
:param path: The path of the file_id in the tree
804
:return: A branch associated with the file_id
806
# FIXME should provide multiple branches, based on config
807
return Branch.open(self.bzrdir.root_transport.clone(path).base)
809
def supports_tags(self):
810
return self._format.supports_tags()
813
class BranchFormat(object):
814
"""An encapsulation of the initialization and open routines for a format.
816
Formats provide three things:
817
* An initialization routine,
821
Formats are placed in an dict by their format string for reference
822
during branch opening. Its not required that these be instances, they
823
can be classes themselves with class methods - it simply depends on
824
whether state is needed for a given format or not.
826
Once a format is deprecated, just deprecate the initialize and open
827
methods on the format class. Do not deprecate the object, as the
828
object will be created every time regardless.
831
_default_format = None
832
"""The default format used for new branches."""
835
"""The known formats."""
837
def __eq__(self, other):
838
return self.__class__ is other.__class__
840
def __ne__(self, other):
841
return not (self == other)
844
def find_format(klass, a_bzrdir):
845
"""Return the format for the branch object in a_bzrdir."""
847
transport = a_bzrdir.get_branch_transport(None)
848
format_string = transport.get("format").read()
849
return klass._formats[format_string]
851
raise NotBranchError(path=transport.base)
853
raise errors.UnknownFormatError(format=format_string)
856
def get_default_format(klass):
857
"""Return the current default format."""
858
return klass._default_format
860
def get_reference(self, a_bzrdir):
861
"""Get the target reference of the branch in a_bzrdir.
863
format probing must have been completed before calling
864
this method - it is assumed that the format of the branch
865
in a_bzrdir is correct.
867
:param a_bzrdir: The bzrdir to get the branch data from.
868
:return: None if the branch is not a reference branch.
873
def set_reference(self, a_bzrdir, to_branch):
874
"""Set the target reference of the branch in a_bzrdir.
876
format probing must have been completed before calling
877
this method - it is assumed that the format of the branch
878
in a_bzrdir is correct.
880
:param a_bzrdir: The bzrdir to set the branch reference for.
881
:param to_branch: branch that the checkout is to reference
883
raise NotImplementedError(self.set_reference)
885
def get_format_string(self):
886
"""Return the ASCII format string that identifies this format."""
887
raise NotImplementedError(self.get_format_string)
889
def get_format_description(self):
890
"""Return the short format description for this format."""
891
raise NotImplementedError(self.get_format_description)
893
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
895
"""Initialize a branch in a bzrdir, with specified files
897
:param a_bzrdir: The bzrdir to initialize the branch in
898
:param utf8_files: The files to create as a list of
899
(filename, content) tuples
900
:param set_format: If True, set the format with
901
self.get_format_string. (BzrBranch4 has its format set
903
:return: a branch in this format
905
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
906
branch_transport = a_bzrdir.get_branch_transport(self)
908
'metadir': ('lock', lockdir.LockDir),
909
'branch4': ('branch-lock', lockable_files.TransportLock),
911
lock_name, lock_class = lock_map[lock_type]
912
control_files = lockable_files.LockableFiles(branch_transport,
913
lock_name, lock_class)
914
control_files.create_lock()
915
control_files.lock_write()
917
control_files.put_utf8('format', self.get_format_string())
919
for file, content in utf8_files:
920
control_files.put_utf8(file, content)
922
control_files.unlock()
923
return self.open(a_bzrdir, _found=True)
925
def initialize(self, a_bzrdir):
926
"""Create a branch of this format in a_bzrdir."""
927
raise NotImplementedError(self.initialize)
929
def is_supported(self):
930
"""Is this format supported?
932
Supported formats can be initialized and opened.
933
Unsupported formats may not support initialization or committing or
934
some other features depending on the reason for not being supported.
938
def open(self, a_bzrdir, _found=False):
939
"""Return the branch object for a_bzrdir
941
_found is a private parameter, do not use it. It is used to indicate
942
if format probing has already be done.
944
raise NotImplementedError(self.open)
947
def register_format(klass, format):
948
klass._formats[format.get_format_string()] = format
951
def set_default_format(klass, format):
952
klass._default_format = format
955
def unregister_format(klass, format):
956
assert klass._formats[format.get_format_string()] is format
957
del klass._formats[format.get_format_string()]
960
return self.get_format_string().rstrip()
962
def supports_tags(self):
963
"""True if this format supports tags stored in the branch"""
964
return False # by default
966
# XXX: Probably doesn't really belong here -- mbp 20070212
967
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
969
branch_transport = a_bzrdir.get_branch_transport(self)
970
control_files = lockable_files.LockableFiles(branch_transport,
971
lock_filename, lock_class)
972
control_files.create_lock()
973
control_files.lock_write()
975
for filename, content in utf8_files:
976
control_files.put_utf8(filename, content)
978
control_files.unlock()
981
class BranchHooks(Hooks):
982
"""A dictionary mapping hook name to a list of callables for branch hooks.
984
e.g. ['set_rh'] Is the list of items to be called when the
985
set_revision_history function is invoked.
989
"""Create the default hooks.
991
These are all empty initially, because by default nothing should get
995
# Introduced in 0.15:
996
# invoked whenever the revision history has been set
997
# with set_revision_history. The api signature is
998
# (branch, revision_history), and the branch will
1001
# invoked after a push operation completes.
1002
# the api signature is
1004
# containing the members
1005
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1006
# where local is the local target branch or None, master is the target
1007
# master branch, and the rest should be self explanatory. The source
1008
# is read locked and the target branches write locked. Source will
1009
# be the local low-latency branch.
1010
self['post_push'] = []
1011
# invoked after a pull operation completes.
1012
# the api signature is
1014
# containing the members
1015
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1016
# where local is the local branch or None, master is the target
1017
# master branch, and the rest should be self explanatory. The source
1018
# is read locked and the target branches write locked. The local
1019
# branch is the low-latency branch.
1020
self['post_pull'] = []
1021
# invoked before a commit operation takes place.
1022
# the api signature is
1023
# (local, master, old_revno, old_revid, future_revno, future_revid,
1024
# tree_delta, future_tree).
1025
# old_revid is NULL_REVISION for the first commit to a branch
1026
# tree_delta is a TreeDelta object describing changes from the basis
1027
# revision, hooks MUST NOT modify this delta
1028
# future_tree is an in-memory tree obtained from
1029
# CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
1030
self['pre_commit'] = []
1031
# invoked after a commit operation completes.
1032
# the api signature is
1033
# (local, master, old_revno, old_revid, new_revno, new_revid)
1034
# old_revid is NULL_REVISION for the first commit to a branch.
1035
self['post_commit'] = []
1036
# invoked after a uncommit operation completes.
1037
# the api signature is
1038
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1039
# local is the local branch or None, master is the target branch,
1040
# and an empty branch recieves new_revno of 0, new_revid of None.
1041
self['post_uncommit'] = []
1044
# install the default hooks into the Branch class.
1045
Branch.hooks = BranchHooks()
1048
class BzrBranchFormat4(BranchFormat):
1049
"""Bzr branch format 4.
1052
- a revision-history file.
1053
- a branch-lock lock file [ to be shared with the bzrdir ]
1056
def get_format_description(self):
1057
"""See BranchFormat.get_format_description()."""
1058
return "Branch format 4"
1060
def initialize(self, a_bzrdir):
1061
"""Create a branch of this format in a_bzrdir."""
1062
utf8_files = [('revision-history', ''),
1063
('branch-name', ''),
1065
return self._initialize_helper(a_bzrdir, utf8_files,
1066
lock_type='branch4', set_format=False)
1069
super(BzrBranchFormat4, self).__init__()
1070
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1072
def open(self, a_bzrdir, _found=False):
1073
"""Return the branch object for a_bzrdir
1075
_found is a private parameter, do not use it. It is used to indicate
1076
if format probing has already be done.
1079
# we are being called directly and must probe.
1080
raise NotImplementedError
1081
return BzrBranch(_format=self,
1082
_control_files=a_bzrdir._control_files,
1084
_repository=a_bzrdir.open_repository())
1087
return "Bazaar-NG branch format 4"
1090
class BzrBranchFormat5(BranchFormat):
1091
"""Bzr branch format 5.
1094
- a revision-history file.
1096
- a lock dir guarding the branch itself
1097
- all of this stored in a branch/ subdirectory
1098
- works with shared repositories.
1100
This format is new in bzr 0.8.
1103
def get_format_string(self):
1104
"""See BranchFormat.get_format_string()."""
1105
return "Bazaar-NG branch format 5\n"
1107
def get_format_description(self):
1108
"""See BranchFormat.get_format_description()."""
1109
return "Branch format 5"
1111
def initialize(self, a_bzrdir):
1112
"""Create a branch of this format in a_bzrdir."""
1113
utf8_files = [('revision-history', ''),
1114
('branch-name', ''),
1116
return self._initialize_helper(a_bzrdir, utf8_files)
1119
super(BzrBranchFormat5, self).__init__()
1120
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1122
def open(self, a_bzrdir, _found=False):
1123
"""Return the branch object for a_bzrdir
1125
_found is a private parameter, do not use it. It is used to indicate
1126
if format probing has already be done.
1129
format = BranchFormat.find_format(a_bzrdir)
1130
assert format.__class__ == self.__class__
1132
transport = a_bzrdir.get_branch_transport(None)
1133
control_files = lockable_files.LockableFiles(transport, 'lock',
1135
return BzrBranch5(_format=self,
1136
_control_files=control_files,
1138
_repository=a_bzrdir.find_repository())
1140
raise NotBranchError(path=transport.base)
1143
class BzrBranchFormat6(BzrBranchFormat5):
1144
"""Branch format with last-revision and tags.
1146
Unlike previous formats, this has no explicit revision history. Instead,
1147
this just stores the last-revision, and the left-hand history leading
1148
up to there is the history.
1150
This format was introduced in bzr 0.15
1151
and became the default in 0.91.
1154
def get_format_string(self):
1155
"""See BranchFormat.get_format_string()."""
1156
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1158
def get_format_description(self):
1159
"""See BranchFormat.get_format_description()."""
1160
return "Branch format 6"
1162
def initialize(self, a_bzrdir):
1163
"""Create a branch of this format in a_bzrdir."""
1164
utf8_files = [('last-revision', '0 null:\n'),
1165
('branch.conf', ''),
1168
return self._initialize_helper(a_bzrdir, utf8_files)
1170
def open(self, a_bzrdir, _found=False):
1171
"""Return the branch object for a_bzrdir
1173
_found is a private parameter, do not use it. It is used to indicate
1174
if format probing has already be done.
1177
format = BranchFormat.find_format(a_bzrdir)
1178
assert format.__class__ == self.__class__
1179
transport = a_bzrdir.get_branch_transport(None)
1180
control_files = lockable_files.LockableFiles(transport, 'lock',
1182
return BzrBranch6(_format=self,
1183
_control_files=control_files,
1185
_repository=a_bzrdir.find_repository())
1187
def supports_tags(self):
1191
class BranchReferenceFormat(BranchFormat):
1192
"""Bzr branch reference format.
1194
Branch references are used in implementing checkouts, they
1195
act as an alias to the real branch which is at some other url.
1202
def get_format_string(self):
1203
"""See BranchFormat.get_format_string()."""
1204
return "Bazaar-NG Branch Reference Format 1\n"
1206
def get_format_description(self):
1207
"""See BranchFormat.get_format_description()."""
1208
return "Checkout reference format 1"
1210
def get_reference(self, a_bzrdir):
1211
"""See BranchFormat.get_reference()."""
1212
transport = a_bzrdir.get_branch_transport(None)
1213
return transport.get('location').read()
1215
def set_reference(self, a_bzrdir, to_branch):
1216
"""See BranchFormat.set_reference()."""
1217
transport = a_bzrdir.get_branch_transport(None)
1218
location = transport.put_bytes('location', to_branch.base)
1220
def initialize(self, a_bzrdir, target_branch=None):
1221
"""Create a branch of this format in a_bzrdir."""
1222
if target_branch is None:
1223
# this format does not implement branch itself, thus the implicit
1224
# creation contract must see it as uninitializable
1225
raise errors.UninitializableFormat(self)
1226
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1227
branch_transport = a_bzrdir.get_branch_transport(self)
1228
branch_transport.put_bytes('location',
1229
target_branch.bzrdir.root_transport.base)
1230
branch_transport.put_bytes('format', self.get_format_string())
1232
a_bzrdir, _found=True,
1233
possible_transports=[target_branch.bzrdir.root_transport])
1236
super(BranchReferenceFormat, self).__init__()
1237
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1239
def _make_reference_clone_function(format, a_branch):
1240
"""Create a clone() routine for a branch dynamically."""
1241
def clone(to_bzrdir, revision_id=None):
1242
"""See Branch.clone()."""
1243
return format.initialize(to_bzrdir, a_branch)
1244
# cannot obey revision_id limits when cloning a reference ...
1245
# FIXME RBC 20060210 either nuke revision_id for clone, or
1246
# emit some sort of warning/error to the caller ?!
1249
def open(self, a_bzrdir, _found=False, location=None,
1250
possible_transports=None):
1251
"""Return the branch that the branch reference in a_bzrdir points at.
1253
_found is a private parameter, do not use it. It is used to indicate
1254
if format probing has already be done.
1257
format = BranchFormat.find_format(a_bzrdir)
1258
assert format.__class__ == self.__class__
1259
if location is None:
1260
location = self.get_reference(a_bzrdir)
1261
real_bzrdir = bzrdir.BzrDir.open(
1262
location, possible_transports=possible_transports)
1263
result = real_bzrdir.open_branch()
1264
# this changes the behaviour of result.clone to create a new reference
1265
# rather than a copy of the content of the branch.
1266
# I did not use a proxy object because that needs much more extensive
1267
# testing, and we are only changing one behaviour at the moment.
1268
# If we decide to alter more behaviours - i.e. the implicit nickname
1269
# then this should be refactored to introduce a tested proxy branch
1270
# and a subclass of that for use in overriding clone() and ....
1272
result.clone = self._make_reference_clone_function(result)
1276
# formats which have no format string are not discoverable
1277
# and not independently creatable, so are not registered.
1278
__format5 = BzrBranchFormat5()
1279
__format6 = BzrBranchFormat6()
1280
BranchFormat.register_format(__format5)
1281
BranchFormat.register_format(BranchReferenceFormat())
1282
BranchFormat.register_format(__format6)
1283
BranchFormat.set_default_format(__format6)
1284
_legacy_formats = [BzrBranchFormat4(),
1287
class BzrBranch(Branch):
1288
"""A branch stored in the actual filesystem.
1290
Note that it's "local" in the context of the filesystem; it doesn't
1291
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1292
it's writable, and can be accessed via the normal filesystem API.
1295
def __init__(self, _format=None,
1296
_control_files=None, a_bzrdir=None, _repository=None):
1297
"""Create new branch object at a particular location."""
1298
Branch.__init__(self)
1299
if a_bzrdir is None:
1300
raise ValueError('a_bzrdir must be supplied')
1302
self.bzrdir = a_bzrdir
1303
# self._transport used to point to the directory containing the
1304
# control directory, but was not used - now it's just the transport
1305
# for the branch control files. mbp 20070212
1306
self._base = self.bzrdir.transport.clone('..').base
1307
self._format = _format
1308
if _control_files is None:
1309
raise ValueError('BzrBranch _control_files is None')
1310
self.control_files = _control_files
1311
self._transport = _control_files._transport
1312
self.repository = _repository
1315
return '%s(%r)' % (self.__class__.__name__, self.base)
1319
def _get_base(self):
1320
"""Returns the directory containing the control directory."""
1323
base = property(_get_base, doc="The URL for the root of this branch.")
1325
def abspath(self, name):
1326
"""See Branch.abspath."""
1327
return self.control_files._transport.abspath(name)
1330
@deprecated_method(zero_sixteen)
1332
def get_root_id(self):
1333
"""See Branch.get_root_id."""
1334
tree = self.repository.revision_tree(self.last_revision())
1335
return tree.get_root_id()
1337
def is_locked(self):
1338
return self.control_files.is_locked()
1340
def lock_write(self, token=None):
1341
repo_token = self.repository.lock_write()
1343
token = self.control_files.lock_write(token=token)
1345
self.repository.unlock()
1349
def lock_read(self):
1350
self.repository.lock_read()
1352
self.control_files.lock_read()
1354
self.repository.unlock()
1358
# TODO: test for failed two phase locks. This is known broken.
1360
self.control_files.unlock()
1362
self.repository.unlock()
1363
if not self.control_files.is_locked():
1364
# we just released the lock
1365
self._clear_cached_state()
1367
def peek_lock_mode(self):
1368
if self.control_files._lock_count == 0:
1371
return self.control_files._lock_mode
1373
def get_physical_lock_status(self):
1374
return self.control_files.get_physical_lock_status()
1377
def print_file(self, file, revision_id):
1378
"""See Branch.print_file."""
1379
return self.repository.print_file(file, revision_id)
1381
def _write_revision_history(self, history):
1382
"""Factored out of set_revision_history.
1384
This performs the actual writing to disk.
1385
It is intended to be called by BzrBranch5.set_revision_history."""
1386
self.control_files.put_bytes(
1387
'revision-history', '\n'.join(history))
1390
def set_revision_history(self, rev_history):
1391
"""See Branch.set_revision_history."""
1392
if 'evil' in debug.debug_flags:
1393
mutter_callsite(3, "set_revision_history scales with history.")
1394
self._clear_cached_state()
1395
self._write_revision_history(rev_history)
1396
self._cache_revision_history(rev_history)
1397
for hook in Branch.hooks['set_rh']:
1398
hook(self, rev_history)
1401
def set_last_revision_info(self, revno, revision_id):
1402
"""Set the last revision of this branch.
1404
The caller is responsible for checking that the revno is correct
1405
for this revision id.
1407
It may be possible to set the branch last revision to an id not
1408
present in the repository. However, branches can also be
1409
configured to check constraints on history, in which case this may not
1412
history = self._lefthand_history(revision_id)
1413
assert len(history) == revno, '%d != %d' % (len(history), revno)
1414
self.set_revision_history(history)
1416
def _gen_revision_history(self):
1417
history = self.control_files.get('revision-history').read().split('\n')
1418
if history[-1:] == ['']:
1419
# There shouldn't be a trailing newline, but just in case.
1423
def _lefthand_history(self, revision_id, last_rev=None,
1425
if 'evil' in debug.debug_flags:
1426
mutter_callsite(4, "_lefthand_history scales with history.")
1427
# stop_revision must be a descendant of last_revision
1428
stop_graph = self.repository.get_revision_graph(revision_id)
1429
if (last_rev is not None and last_rev != _mod_revision.NULL_REVISION
1430
and last_rev not in stop_graph):
1431
# our previous tip is not merged into stop_revision
1432
raise errors.DivergedBranches(self, other_branch)
1433
# make a new revision history from the graph
1434
current_rev_id = revision_id
1436
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1437
new_history.append(current_rev_id)
1438
current_rev_id_parents = stop_graph[current_rev_id]
1440
current_rev_id = current_rev_id_parents[0]
1442
current_rev_id = None
1443
new_history.reverse()
1447
def generate_revision_history(self, revision_id, last_rev=None,
1449
"""Create a new revision history that will finish with revision_id.
1451
:param revision_id: the new tip to use.
1452
:param last_rev: The previous last_revision. If not None, then this
1453
must be a ancestory of revision_id, or DivergedBranches is raised.
1454
:param other_branch: The other branch that DivergedBranches should
1455
raise with respect to.
1457
self.set_revision_history(self._lefthand_history(revision_id,
1458
last_rev, other_branch))
1461
def update_revisions(self, other, stop_revision=None, overwrite=False):
1462
"""See Branch.update_revisions."""
1465
other_last_revno, other_last_revision = other.last_revision_info()
1466
if stop_revision is None:
1467
stop_revision = other_last_revision
1468
if _mod_revision.is_null(stop_revision):
1469
# if there are no commits, we're done.
1471
# whats the current last revision, before we fetch [and change it
1473
last_rev = _mod_revision.ensure_null(self.last_revision())
1474
# we fetch here so that we don't process data twice in the common
1475
# case of having something to pull, and so that the check for
1476
# already merged can operate on the just fetched graph, which will
1477
# be cached in memory.
1478
self.fetch(other, stop_revision)
1479
# Check to see if one is an ancestor of the other
1481
heads = self.repository.get_graph().heads([stop_revision,
1483
if heads == set([last_rev]):
1484
# The current revision is a decendent of the target,
1487
elif heads == set([stop_revision, last_rev]):
1488
# These branches have diverged
1489
raise errors.DivergedBranches(self, other)
1490
assert heads == set([stop_revision])
1491
if other_last_revision == stop_revision:
1492
self.set_last_revision_info(other_last_revno,
1493
other_last_revision)
1495
# TODO: jam 2007-11-29 Is there a way to determine the
1496
# revno without searching all of history??
1498
self.generate_revision_history(stop_revision)
1500
self.generate_revision_history(stop_revision,
1501
last_rev=last_rev, other_branch=other)
1505
def basis_tree(self):
1506
"""See Branch.basis_tree."""
1507
return self.repository.revision_tree(self.last_revision())
1510
def pull(self, source, overwrite=False, stop_revision=None,
1511
_hook_master=None, run_hooks=True, possible_transports=None):
1514
:param _hook_master: Private parameter - set the branch to
1515
be supplied as the master to push hooks.
1516
:param run_hooks: Private parameter - if false, this branch
1517
is being called because it's the master of the primary branch,
1518
so it should not run its hooks.
1520
result = PullResult()
1521
result.source_branch = source
1522
result.target_branch = self
1525
result.old_revno, result.old_revid = self.last_revision_info()
1526
self.update_revisions(source, stop_revision, overwrite=overwrite)
1527
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
1528
result.new_revno, result.new_revid = self.last_revision_info()
1530
result.master_branch = _hook_master
1531
result.local_branch = self
1533
result.master_branch = self
1534
result.local_branch = None
1536
for hook in Branch.hooks['post_pull']:
1542
def _get_parent_location(self):
1543
_locs = ['parent', 'pull', 'x-pull']
1546
return self.control_files.get(l).read().strip('\n')
1552
def push(self, target, overwrite=False, stop_revision=None,
1553
_override_hook_source_branch=None):
1556
This is the basic concrete implementation of push()
1558
:param _override_hook_source_branch: If specified, run
1559
the hooks passing this Branch as the source, rather than self.
1560
This is for use of RemoteBranch, where push is delegated to the
1561
underlying vfs-based Branch.
1563
# TODO: Public option to disable running hooks - should be trivial but
1567
result = self._push_with_bound_branches(target, overwrite,
1569
_override_hook_source_branch=_override_hook_source_branch)
1574
def _push_with_bound_branches(self, target, overwrite,
1576
_override_hook_source_branch=None):
1577
"""Push from self into target, and into target's master if any.
1579
This is on the base BzrBranch class even though it doesn't support
1580
bound branches because the *target* might be bound.
1583
if _override_hook_source_branch:
1584
result.source_branch = _override_hook_source_branch
1585
for hook in Branch.hooks['post_push']:
1588
bound_location = target.get_bound_location()
1589
if bound_location and target.base != bound_location:
1590
# there is a master branch.
1592
# XXX: Why the second check? Is it even supported for a branch to
1593
# be bound to itself? -- mbp 20070507
1594
master_branch = target.get_master_branch()
1595
master_branch.lock_write()
1597
# push into the master from this branch.
1598
self._basic_push(master_branch, overwrite, stop_revision)
1599
# and push into the target branch from this. Note that we push from
1600
# this branch again, because its considered the highest bandwidth
1602
result = self._basic_push(target, overwrite, stop_revision)
1603
result.master_branch = master_branch
1604
result.local_branch = target
1608
master_branch.unlock()
1611
result = self._basic_push(target, overwrite, stop_revision)
1612
# TODO: Why set master_branch and local_branch if there's no
1613
# binding? Maybe cleaner to just leave them unset? -- mbp
1615
result.master_branch = target
1616
result.local_branch = None
1620
def _basic_push(self, target, overwrite, stop_revision):
1621
"""Basic implementation of push without bound branches or hooks.
1623
Must be called with self read locked and target write locked.
1625
result = PushResult()
1626
result.source_branch = self
1627
result.target_branch = target
1628
result.old_revno, result.old_revid = target.last_revision_info()
1630
target.update_revisions(self, stop_revision)
1631
except DivergedBranches:
1635
target.set_revision_history(self.revision_history())
1636
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
1637
result.new_revno, result.new_revid = target.last_revision_info()
1640
def get_parent(self):
1641
"""See Branch.get_parent."""
1643
assert self.base[-1] == '/'
1644
parent = self._get_parent_location()
1647
# This is an old-format absolute path to a local branch
1648
# turn it into a url
1649
if parent.startswith('/'):
1650
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1652
return urlutils.join(self.base[:-1], parent)
1653
except errors.InvalidURLJoin, e:
1654
raise errors.InaccessibleParent(parent, self.base)
1656
def set_push_location(self, location):
1657
"""See Branch.set_push_location."""
1658
self.get_config().set_user_option(
1659
'push_location', location,
1660
store=_mod_config.STORE_LOCATION_NORECURSE)
1663
def set_parent(self, url):
1664
"""See Branch.set_parent."""
1665
# TODO: Maybe delete old location files?
1666
# URLs should never be unicode, even on the local fs,
1667
# FIXUP this and get_parent in a future branch format bump:
1668
# read and rewrite the file, and have the new format code read
1669
# using .get not .get_utf8. RBC 20060125
1671
if isinstance(url, unicode):
1673
url = url.encode('ascii')
1674
except UnicodeEncodeError:
1675
raise errors.InvalidURL(url,
1676
"Urls must be 7-bit ascii, "
1677
"use bzrlib.urlutils.escape")
1678
url = urlutils.relative_url(self.base, url)
1679
self._set_parent_location(url)
1681
def _set_parent_location(self, url):
1683
self.control_files._transport.delete('parent')
1685
assert isinstance(url, str)
1686
self.control_files.put_bytes('parent', url + '\n')
1689
class BzrBranch5(BzrBranch):
1690
"""A format 5 branch. This supports new features over plain branches.
1692
It has support for a master_branch which is the data for bound branches.
1700
super(BzrBranch5, self).__init__(_format=_format,
1701
_control_files=_control_files,
1703
_repository=_repository)
1706
def pull(self, source, overwrite=False, stop_revision=None,
1707
run_hooks=True, possible_transports=None):
1708
"""Pull from source into self, updating my master if any.
1710
:param run_hooks: Private parameter - if false, this branch
1711
is being called because it's the master of the primary branch,
1712
so it should not run its hooks.
1714
bound_location = self.get_bound_location()
1715
master_branch = None
1716
if bound_location and source.base != bound_location:
1717
# not pulling from master, so we need to update master.
1718
master_branch = self.get_master_branch(possible_transports)
1719
master_branch.lock_write()
1722
# pull from source into master.
1723
master_branch.pull(source, overwrite, stop_revision,
1725
return super(BzrBranch5, self).pull(source, overwrite,
1726
stop_revision, _hook_master=master_branch,
1727
run_hooks=run_hooks)
1730
master_branch.unlock()
1732
def get_bound_location(self):
1734
return self.control_files.get_utf8('bound').read()[:-1]
1735
except errors.NoSuchFile:
1739
def get_master_branch(self, possible_transports=None):
1740
"""Return the branch we are bound to.
1742
:return: Either a Branch, or None
1744
This could memoise the branch, but if thats done
1745
it must be revalidated on each new lock.
1746
So for now we just don't memoise it.
1747
# RBC 20060304 review this decision.
1749
bound_loc = self.get_bound_location()
1753
return Branch.open(bound_loc,
1754
possible_transports=possible_transports)
1755
except (errors.NotBranchError, errors.ConnectionError), e:
1756
raise errors.BoundBranchConnectionFailure(
1760
def set_bound_location(self, location):
1761
"""Set the target where this branch is bound to.
1763
:param location: URL to the target branch
1766
self.control_files.put_utf8('bound', location+'\n')
1769
self.control_files._transport.delete('bound')
1775
def bind(self, other):
1776
"""Bind this branch to the branch other.
1778
This does not push or pull data between the branches, though it does
1779
check for divergence to raise an error when the branches are not
1780
either the same, or one a prefix of the other. That behaviour may not
1781
be useful, so that check may be removed in future.
1783
:param other: The branch to bind to
1786
# TODO: jam 20051230 Consider checking if the target is bound
1787
# It is debatable whether you should be able to bind to
1788
# a branch which is itself bound.
1789
# Committing is obviously forbidden,
1790
# but binding itself may not be.
1791
# Since we *have* to check at commit time, we don't
1792
# *need* to check here
1794
# we want to raise diverged if:
1795
# last_rev is not in the other_last_rev history, AND
1796
# other_last_rev is not in our history, and do it without pulling
1798
self.set_bound_location(other.base)
1802
"""If bound, unbind"""
1803
return self.set_bound_location(None)
1806
def update(self, possible_transports=None):
1807
"""Synchronise this branch with the master branch if any.
1809
:return: None or the last_revision that was pivoted out during the
1812
master = self.get_master_branch(possible_transports)
1813
if master is not None:
1814
old_tip = _mod_revision.ensure_null(self.last_revision())
1815
self.pull(master, overwrite=True)
1816
if self.repository.get_graph().is_ancestor(old_tip,
1817
_mod_revision.ensure_null(self.last_revision())):
1823
class BzrBranch6(BzrBranch5):
1826
def last_revision_info(self):
1827
revision_string = self.control_files.get('last-revision').read()
1828
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1829
revision_id = cache_utf8.get_cached_utf8(revision_id)
1831
return revno, revision_id
1833
def _write_last_revision_info(self, revno, revision_id):
1834
"""Simply write out the revision id, with no checks.
1836
Use set_last_revision_info to perform this safely.
1838
Does not update the revision_history cache.
1839
Intended to be called by set_last_revision_info and
1840
_write_revision_history.
1842
if revision_id is None:
1843
revision_id = 'null:'
1844
out_string = '%d %s\n' % (revno, revision_id)
1845
self.control_files.put_bytes('last-revision', out_string)
1848
def set_last_revision_info(self, revno, revision_id):
1849
if self._get_append_revisions_only():
1850
self._check_history_violation(revision_id)
1851
self._write_last_revision_info(revno, revision_id)
1852
self._clear_cached_state()
1854
def _check_history_violation(self, revision_id):
1855
last_revision = _mod_revision.ensure_null(self.last_revision())
1856
if _mod_revision.is_null(last_revision):
1858
if last_revision not in self._lefthand_history(revision_id):
1859
raise errors.AppendRevisionsOnlyViolation(self.base)
1861
def _gen_revision_history(self):
1862
"""Generate the revision history from last revision
1864
history = list(self.repository.iter_reverse_revision_history(
1865
self.last_revision()))
1869
def _write_revision_history(self, history):
1870
"""Factored out of set_revision_history.
1872
This performs the actual writing to disk, with format-specific checks.
1873
It is intended to be called by BzrBranch5.set_revision_history.
1875
if len(history) == 0:
1876
last_revision = 'null:'
1878
if history != self._lefthand_history(history[-1]):
1879
raise errors.NotLefthandHistory(history)
1880
last_revision = history[-1]
1881
if self._get_append_revisions_only():
1882
self._check_history_violation(last_revision)
1883
self._write_last_revision_info(len(history), last_revision)
1886
def _set_parent_location(self, url):
1887
"""Set the parent branch"""
1888
self._set_config_location('parent_location', url, make_relative=True)
1891
def _get_parent_location(self):
1892
"""Set the parent branch"""
1893
return self._get_config_location('parent_location')
1895
def set_push_location(self, location):
1896
"""See Branch.set_push_location."""
1897
self._set_config_location('push_location', location)
1899
def set_bound_location(self, location):
1900
"""See Branch.set_push_location."""
1902
config = self.get_config()
1903
if location is None:
1904
if config.get_user_option('bound') != 'True':
1907
config.set_user_option('bound', 'False', warn_masked=True)
1910
self._set_config_location('bound_location', location,
1912
config.set_user_option('bound', 'True', warn_masked=True)
1915
def _get_bound_location(self, bound):
1916
"""Return the bound location in the config file.
1918
Return None if the bound parameter does not match"""
1919
config = self.get_config()
1920
config_bound = (config.get_user_option('bound') == 'True')
1921
if config_bound != bound:
1923
return self._get_config_location('bound_location', config=config)
1925
def get_bound_location(self):
1926
"""See Branch.set_push_location."""
1927
return self._get_bound_location(True)
1929
def get_old_bound_location(self):
1930
"""See Branch.get_old_bound_location"""
1931
return self._get_bound_location(False)
1933
def set_append_revisions_only(self, enabled):
1938
self.get_config().set_user_option('append_revisions_only', value,
1941
def _get_append_revisions_only(self):
1942
value = self.get_config().get_user_option('append_revisions_only')
1943
return value == 'True'
1945
def _synchronize_history(self, destination, revision_id):
1946
"""Synchronize last revision and revision history between branches.
1948
This version is most efficient when the destination is also a
1949
BzrBranch6, but works for BzrBranch5, as long as the destination's
1950
repository contains all the lefthand ancestors of the intended
1951
last_revision. If not, set_last_revision_info will fail.
1953
:param destination: The branch to copy the history into
1954
:param revision_id: The revision-id to truncate history at. May
1955
be None to copy complete history.
1957
source_revno, source_revision_id = self.last_revision_info()
1958
if revision_id is None:
1959
revno, revision_id = source_revno, source_revision_id
1960
elif source_revision_id == revision_id:
1961
# we know the revno without needing to walk all of history
1962
revno = source_revno
1964
# To figure out the revno for a random revision, we need to build
1965
# the revision history, and count its length.
1966
# We don't care about the order, just how long it is.
1967
# Alternatively, we could start at the current location, and count
1968
# backwards. But there is no guarantee that we will find it since
1969
# it may be a merged revision.
1970
revno = len(list(self.repository.iter_reverse_revision_history(
1972
destination.set_last_revision_info(revno, revision_id)
1974
def _make_tags(self):
1975
return BasicTags(self)
1978
######################################################################
1979
# results of operations
1982
class _Result(object):
1984
def _show_tag_conficts(self, to_file):
1985
if not getattr(self, 'tag_conflicts', None):
1987
to_file.write('Conflicting tags:\n')
1988
for name, value1, value2 in self.tag_conflicts:
1989
to_file.write(' %s\n' % (name, ))
1992
class PullResult(_Result):
1993
"""Result of a Branch.pull operation.
1995
:ivar old_revno: Revision number before pull.
1996
:ivar new_revno: Revision number after pull.
1997
:ivar old_revid: Tip revision id before pull.
1998
:ivar new_revid: Tip revision id after pull.
1999
:ivar source_branch: Source (local) branch object.
2000
:ivar master_branch: Master branch of the target, or None.
2001
:ivar target_branch: Target/destination branch object.
2005
# DEPRECATED: pull used to return the change in revno
2006
return self.new_revno - self.old_revno
2008
def report(self, to_file):
2010
if self.old_revid == self.new_revid:
2011
to_file.write('No revisions to pull.\n')
2013
to_file.write('Now on revision %d.\n' % self.new_revno)
2014
self._show_tag_conficts(to_file)
2017
class PushResult(_Result):
2018
"""Result of a Branch.push operation.
2020
:ivar old_revno: Revision number before push.
2021
:ivar new_revno: Revision number after push.
2022
:ivar old_revid: Tip revision id before push.
2023
:ivar new_revid: Tip revision id after push.
2024
:ivar source_branch: Source branch object.
2025
:ivar master_branch: Master branch of the target, or None.
2026
:ivar target_branch: Target/destination branch object.
2030
# DEPRECATED: push used to return the change in revno
2031
return self.new_revno - self.old_revno
2033
def report(self, to_file):
2034
"""Write a human-readable description of the result."""
2035
if self.old_revid == self.new_revid:
2036
to_file.write('No new revisions to push.\n')
2038
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2039
self._show_tag_conficts(to_file)
2042
class BranchCheckResult(object):
2043
"""Results of checking branch consistency.
2048
def __init__(self, branch):
2049
self.branch = branch
2051
def report_results(self, verbose):
2052
"""Report the check results via trace.note.
2054
:param verbose: Requests more detailed display of what was checked,
2057
note('checked branch %s format %s',
2059
self.branch._format)
2062
class Converter5to6(object):
2063
"""Perform an in-place upgrade of format 5 to format 6"""
2065
def convert(self, branch):
2066
# Data for 5 and 6 can peacefully coexist.
2067
format = BzrBranchFormat6()
2068
new_branch = format.open(branch.bzrdir, _found=True)
2070
# Copy source data into target
2071
new_branch.set_last_revision_info(*branch.last_revision_info())
2072
new_branch.set_parent(branch.get_parent())
2073
new_branch.set_bound_location(branch.get_bound_location())
2074
new_branch.set_push_location(branch.get_push_location())
2076
# New branch has no tags by default
2077
new_branch.tags._set_tag_dict({})
2079
# Copying done; now update target format
2080
new_branch.control_files.put_utf8('format',
2081
format.get_format_string())
2083
# Clean up old files
2084
new_branch.control_files._transport.delete('revision-history')
2086
branch.set_parent(None)
2089
branch.set_bound_location(None)
added
removed
bzrlib/branch.py
