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,
762
"""Create a checkout of a branch.
764
:param to_location: The url to produce the checkout at
765
:param revision_id: The revision to check out
766
:param lightweight: If True, produce a lightweight checkout, otherwise,
767
produce a bound branch (heavyweight checkout)
768
:param accelerator_tree: A tree which can be used for retrieving file
769
contents more quickly than the revision tree, i.e. a workingtree.
770
The revision tree will be used for cases where accelerator_tree's
771
content is different.
772
:param hardlink: If true, hard-link files from accelerator_tree,
774
:return: The tree of the created checkout
776
t = transport.get_transport(to_location)
779
format = self._get_checkout_format()
780
checkout = format.initialize_on_transport(t)
781
from_branch = BranchReferenceFormat().initialize(checkout, self)
783
format = self._get_checkout_format()
784
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
785
to_location, force_new_tree=False, format=format)
786
checkout = checkout_branch.bzrdir
787
checkout_branch.bind(self)
788
# pull up to the specified revision_id to set the initial
789
# branch tip correctly, and seed it with history.
790
checkout_branch.pull(self, stop_revision=revision_id)
792
tree = checkout.create_workingtree(revision_id,
793
from_branch=from_branch,
794
accelerator_tree=accelerator_tree,
796
basis_tree = tree.basis_tree()
797
basis_tree.lock_read()
799
for path, file_id in basis_tree.iter_references():
800
reference_parent = self.reference_parent(file_id, path)
801
reference_parent.create_checkout(tree.abspath(path),
802
basis_tree.get_reference_revision(file_id, path),
808
def reference_parent(self, file_id, path):
809
"""Return the parent branch for a tree-reference file_id
810
:param file_id: The file_id of the tree reference
811
:param path: The path of the file_id in the tree
812
:return: A branch associated with the file_id
814
# FIXME should provide multiple branches, based on config
815
return Branch.open(self.bzrdir.root_transport.clone(path).base)
817
def supports_tags(self):
818
return self._format.supports_tags()
821
class BranchFormat(object):
822
"""An encapsulation of the initialization and open routines for a format.
824
Formats provide three things:
825
* An initialization routine,
829
Formats are placed in an dict by their format string for reference
830
during branch opening. Its not required that these be instances, they
831
can be classes themselves with class methods - it simply depends on
832
whether state is needed for a given format or not.
834
Once a format is deprecated, just deprecate the initialize and open
835
methods on the format class. Do not deprecate the object, as the
836
object will be created every time regardless.
839
_default_format = None
840
"""The default format used for new branches."""
843
"""The known formats."""
845
def __eq__(self, other):
846
return self.__class__ is other.__class__
848
def __ne__(self, other):
849
return not (self == other)
852
def find_format(klass, a_bzrdir):
853
"""Return the format for the branch object in a_bzrdir."""
855
transport = a_bzrdir.get_branch_transport(None)
856
format_string = transport.get("format").read()
857
return klass._formats[format_string]
859
raise NotBranchError(path=transport.base)
861
raise errors.UnknownFormatError(format=format_string)
864
def get_default_format(klass):
865
"""Return the current default format."""
866
return klass._default_format
868
def get_reference(self, a_bzrdir):
869
"""Get the target reference of the branch in a_bzrdir.
871
format probing must have been completed before calling
872
this method - it is assumed that the format of the branch
873
in a_bzrdir is correct.
875
:param a_bzrdir: The bzrdir to get the branch data from.
876
:return: None if the branch is not a reference branch.
881
def set_reference(self, a_bzrdir, to_branch):
882
"""Set the target reference of the branch in a_bzrdir.
884
format probing must have been completed before calling
885
this method - it is assumed that the format of the branch
886
in a_bzrdir is correct.
888
:param a_bzrdir: The bzrdir to set the branch reference for.
889
:param to_branch: branch that the checkout is to reference
891
raise NotImplementedError(self.set_reference)
893
def get_format_string(self):
894
"""Return the ASCII format string that identifies this format."""
895
raise NotImplementedError(self.get_format_string)
897
def get_format_description(self):
898
"""Return the short format description for this format."""
899
raise NotImplementedError(self.get_format_description)
901
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
903
"""Initialize a branch in a bzrdir, with specified files
905
:param a_bzrdir: The bzrdir to initialize the branch in
906
:param utf8_files: The files to create as a list of
907
(filename, content) tuples
908
:param set_format: If True, set the format with
909
self.get_format_string. (BzrBranch4 has its format set
911
:return: a branch in this format
913
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
914
branch_transport = a_bzrdir.get_branch_transport(self)
916
'metadir': ('lock', lockdir.LockDir),
917
'branch4': ('branch-lock', lockable_files.TransportLock),
919
lock_name, lock_class = lock_map[lock_type]
920
control_files = lockable_files.LockableFiles(branch_transport,
921
lock_name, lock_class)
922
control_files.create_lock()
923
control_files.lock_write()
925
control_files.put_utf8('format', self.get_format_string())
927
for file, content in utf8_files:
928
control_files.put_utf8(file, content)
930
control_files.unlock()
931
return self.open(a_bzrdir, _found=True)
933
def initialize(self, a_bzrdir):
934
"""Create a branch of this format in a_bzrdir."""
935
raise NotImplementedError(self.initialize)
937
def is_supported(self):
938
"""Is this format supported?
940
Supported formats can be initialized and opened.
941
Unsupported formats may not support initialization or committing or
942
some other features depending on the reason for not being supported.
946
def open(self, a_bzrdir, _found=False):
947
"""Return the branch object for a_bzrdir
949
_found is a private parameter, do not use it. It is used to indicate
950
if format probing has already be done.
952
raise NotImplementedError(self.open)
955
def register_format(klass, format):
956
klass._formats[format.get_format_string()] = format
959
def set_default_format(klass, format):
960
klass._default_format = format
963
def unregister_format(klass, format):
964
assert klass._formats[format.get_format_string()] is format
965
del klass._formats[format.get_format_string()]
968
return self.get_format_string().rstrip()
970
def supports_tags(self):
971
"""True if this format supports tags stored in the branch"""
972
return False # by default
974
# XXX: Probably doesn't really belong here -- mbp 20070212
975
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
977
branch_transport = a_bzrdir.get_branch_transport(self)
978
control_files = lockable_files.LockableFiles(branch_transport,
979
lock_filename, lock_class)
980
control_files.create_lock()
981
control_files.lock_write()
983
for filename, content in utf8_files:
984
control_files.put_utf8(filename, content)
986
control_files.unlock()
989
class BranchHooks(Hooks):
990
"""A dictionary mapping hook name to a list of callables for branch hooks.
992
e.g. ['set_rh'] Is the list of items to be called when the
993
set_revision_history function is invoked.
997
"""Create the default hooks.
999
These are all empty initially, because by default nothing should get
1002
Hooks.__init__(self)
1003
# Introduced in 0.15:
1004
# invoked whenever the revision history has been set
1005
# with set_revision_history. The api signature is
1006
# (branch, revision_history), and the branch will
1009
# invoked after a push operation completes.
1010
# the api signature is
1012
# containing the members
1013
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1014
# where local is the local target branch or None, master is the target
1015
# master branch, and the rest should be self explanatory. The source
1016
# is read locked and the target branches write locked. Source will
1017
# be the local low-latency branch.
1018
self['post_push'] = []
1019
# invoked after a pull operation completes.
1020
# the api signature is
1022
# containing the members
1023
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1024
# where local is the local branch or None, master is the target
1025
# master branch, and the rest should be self explanatory. The source
1026
# is read locked and the target branches write locked. The local
1027
# branch is the low-latency branch.
1028
self['post_pull'] = []
1029
# invoked before a commit operation takes place.
1030
# the api signature is
1031
# (local, master, old_revno, old_revid, future_revno, future_revid,
1032
# tree_delta, future_tree).
1033
# old_revid is NULL_REVISION for the first commit to a branch
1034
# tree_delta is a TreeDelta object describing changes from the basis
1035
# revision, hooks MUST NOT modify this delta
1036
# future_tree is an in-memory tree obtained from
1037
# CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
1038
self['pre_commit'] = []
1039
# invoked after a commit operation completes.
1040
# the api signature is
1041
# (local, master, old_revno, old_revid, new_revno, new_revid)
1042
# old_revid is NULL_REVISION for the first commit to a branch.
1043
self['post_commit'] = []
1044
# invoked after a uncommit operation completes.
1045
# the api signature is
1046
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1047
# local is the local branch or None, master is the target branch,
1048
# and an empty branch recieves new_revno of 0, new_revid of None.
1049
self['post_uncommit'] = []
1052
# install the default hooks into the Branch class.
1053
Branch.hooks = BranchHooks()
1056
class BzrBranchFormat4(BranchFormat):
1057
"""Bzr branch format 4.
1060
- a revision-history file.
1061
- a branch-lock lock file [ to be shared with the bzrdir ]
1064
def get_format_description(self):
1065
"""See BranchFormat.get_format_description()."""
1066
return "Branch format 4"
1068
def initialize(self, a_bzrdir):
1069
"""Create a branch of this format in a_bzrdir."""
1070
utf8_files = [('revision-history', ''),
1071
('branch-name', ''),
1073
return self._initialize_helper(a_bzrdir, utf8_files,
1074
lock_type='branch4', set_format=False)
1077
super(BzrBranchFormat4, self).__init__()
1078
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1080
def open(self, a_bzrdir, _found=False):
1081
"""Return the branch object for a_bzrdir
1083
_found is a private parameter, do not use it. It is used to indicate
1084
if format probing has already be done.
1087
# we are being called directly and must probe.
1088
raise NotImplementedError
1089
return BzrBranch(_format=self,
1090
_control_files=a_bzrdir._control_files,
1092
_repository=a_bzrdir.open_repository())
1095
return "Bazaar-NG branch format 4"
1098
class BzrBranchFormat5(BranchFormat):
1099
"""Bzr branch format 5.
1102
- a revision-history file.
1104
- a lock dir guarding the branch itself
1105
- all of this stored in a branch/ subdirectory
1106
- works with shared repositories.
1108
This format is new in bzr 0.8.
1111
def get_format_string(self):
1112
"""See BranchFormat.get_format_string()."""
1113
return "Bazaar-NG branch format 5\n"
1115
def get_format_description(self):
1116
"""See BranchFormat.get_format_description()."""
1117
return "Branch format 5"
1119
def initialize(self, a_bzrdir):
1120
"""Create a branch of this format in a_bzrdir."""
1121
utf8_files = [('revision-history', ''),
1122
('branch-name', ''),
1124
return self._initialize_helper(a_bzrdir, utf8_files)
1127
super(BzrBranchFormat5, self).__init__()
1128
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1130
def open(self, a_bzrdir, _found=False):
1131
"""Return the branch object for a_bzrdir
1133
_found is a private parameter, do not use it. It is used to indicate
1134
if format probing has already be done.
1137
format = BranchFormat.find_format(a_bzrdir)
1138
assert format.__class__ == self.__class__
1140
transport = a_bzrdir.get_branch_transport(None)
1141
control_files = lockable_files.LockableFiles(transport, 'lock',
1143
return BzrBranch5(_format=self,
1144
_control_files=control_files,
1146
_repository=a_bzrdir.find_repository())
1148
raise NotBranchError(path=transport.base)
1151
class BzrBranchFormat6(BzrBranchFormat5):
1152
"""Branch format with last-revision and tags.
1154
Unlike previous formats, this has no explicit revision history. Instead,
1155
this just stores the last-revision, and the left-hand history leading
1156
up to there is the history.
1158
This format was introduced in bzr 0.15
1159
and became the default in 0.91.
1162
def get_format_string(self):
1163
"""See BranchFormat.get_format_string()."""
1164
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1166
def get_format_description(self):
1167
"""See BranchFormat.get_format_description()."""
1168
return "Branch format 6"
1170
def initialize(self, a_bzrdir):
1171
"""Create a branch of this format in a_bzrdir."""
1172
utf8_files = [('last-revision', '0 null:\n'),
1173
('branch.conf', ''),
1176
return self._initialize_helper(a_bzrdir, utf8_files)
1178
def open(self, a_bzrdir, _found=False):
1179
"""Return the branch object for a_bzrdir
1181
_found is a private parameter, do not use it. It is used to indicate
1182
if format probing has already be done.
1185
format = BranchFormat.find_format(a_bzrdir)
1186
assert format.__class__ == self.__class__
1187
transport = a_bzrdir.get_branch_transport(None)
1188
control_files = lockable_files.LockableFiles(transport, 'lock',
1190
return BzrBranch6(_format=self,
1191
_control_files=control_files,
1193
_repository=a_bzrdir.find_repository())
1195
def supports_tags(self):
1199
class BranchReferenceFormat(BranchFormat):
1200
"""Bzr branch reference format.
1202
Branch references are used in implementing checkouts, they
1203
act as an alias to the real branch which is at some other url.
1210
def get_format_string(self):
1211
"""See BranchFormat.get_format_string()."""
1212
return "Bazaar-NG Branch Reference Format 1\n"
1214
def get_format_description(self):
1215
"""See BranchFormat.get_format_description()."""
1216
return "Checkout reference format 1"
1218
def get_reference(self, a_bzrdir):
1219
"""See BranchFormat.get_reference()."""
1220
transport = a_bzrdir.get_branch_transport(None)
1221
return transport.get('location').read()
1223
def set_reference(self, a_bzrdir, to_branch):
1224
"""See BranchFormat.set_reference()."""
1225
transport = a_bzrdir.get_branch_transport(None)
1226
location = transport.put_bytes('location', to_branch.base)
1228
def initialize(self, a_bzrdir, target_branch=None):
1229
"""Create a branch of this format in a_bzrdir."""
1230
if target_branch is None:
1231
# this format does not implement branch itself, thus the implicit
1232
# creation contract must see it as uninitializable
1233
raise errors.UninitializableFormat(self)
1234
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1235
branch_transport = a_bzrdir.get_branch_transport(self)
1236
branch_transport.put_bytes('location',
1237
target_branch.bzrdir.root_transport.base)
1238
branch_transport.put_bytes('format', self.get_format_string())
1240
a_bzrdir, _found=True,
1241
possible_transports=[target_branch.bzrdir.root_transport])
1244
super(BranchReferenceFormat, self).__init__()
1245
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1247
def _make_reference_clone_function(format, a_branch):
1248
"""Create a clone() routine for a branch dynamically."""
1249
def clone(to_bzrdir, revision_id=None):
1250
"""See Branch.clone()."""
1251
return format.initialize(to_bzrdir, a_branch)
1252
# cannot obey revision_id limits when cloning a reference ...
1253
# FIXME RBC 20060210 either nuke revision_id for clone, or
1254
# emit some sort of warning/error to the caller ?!
1257
def open(self, a_bzrdir, _found=False, location=None,
1258
possible_transports=None):
1259
"""Return the branch that the branch reference in a_bzrdir points at.
1261
_found is a private parameter, do not use it. It is used to indicate
1262
if format probing has already be done.
1265
format = BranchFormat.find_format(a_bzrdir)
1266
assert format.__class__ == self.__class__
1267
if location is None:
1268
location = self.get_reference(a_bzrdir)
1269
real_bzrdir = bzrdir.BzrDir.open(
1270
location, possible_transports=possible_transports)
1271
result = real_bzrdir.open_branch()
1272
# this changes the behaviour of result.clone to create a new reference
1273
# rather than a copy of the content of the branch.
1274
# I did not use a proxy object because that needs much more extensive
1275
# testing, and we are only changing one behaviour at the moment.
1276
# If we decide to alter more behaviours - i.e. the implicit nickname
1277
# then this should be refactored to introduce a tested proxy branch
1278
# and a subclass of that for use in overriding clone() and ....
1280
result.clone = self._make_reference_clone_function(result)
1284
# formats which have no format string are not discoverable
1285
# and not independently creatable, so are not registered.
1286
__format5 = BzrBranchFormat5()
1287
__format6 = BzrBranchFormat6()
1288
BranchFormat.register_format(__format5)
1289
BranchFormat.register_format(BranchReferenceFormat())
1290
BranchFormat.register_format(__format6)
1291
BranchFormat.set_default_format(__format6)
1292
_legacy_formats = [BzrBranchFormat4(),
1295
class BzrBranch(Branch):
1296
"""A branch stored in the actual filesystem.
1298
Note that it's "local" in the context of the filesystem; it doesn't
1299
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1300
it's writable, and can be accessed via the normal filesystem API.
1303
def __init__(self, _format=None,
1304
_control_files=None, a_bzrdir=None, _repository=None):
1305
"""Create new branch object at a particular location."""
1306
Branch.__init__(self)
1307
if a_bzrdir is None:
1308
raise ValueError('a_bzrdir must be supplied')
1310
self.bzrdir = a_bzrdir
1311
# self._transport used to point to the directory containing the
1312
# control directory, but was not used - now it's just the transport
1313
# for the branch control files. mbp 20070212
1314
self._base = self.bzrdir.transport.clone('..').base
1315
self._format = _format
1316
if _control_files is None:
1317
raise ValueError('BzrBranch _control_files is None')
1318
self.control_files = _control_files
1319
self._transport = _control_files._transport
1320
self.repository = _repository
1323
return '%s(%r)' % (self.__class__.__name__, self.base)
1327
def _get_base(self):
1328
"""Returns the directory containing the control directory."""
1331
base = property(_get_base, doc="The URL for the root of this branch.")
1333
def abspath(self, name):
1334
"""See Branch.abspath."""
1335
return self.control_files._transport.abspath(name)
1338
@deprecated_method(zero_sixteen)
1340
def get_root_id(self):
1341
"""See Branch.get_root_id."""
1342
tree = self.repository.revision_tree(self.last_revision())
1343
return tree.get_root_id()
1345
def is_locked(self):
1346
return self.control_files.is_locked()
1348
def lock_write(self, token=None):
1349
repo_token = self.repository.lock_write()
1351
token = self.control_files.lock_write(token=token)
1353
self.repository.unlock()
1357
def lock_read(self):
1358
self.repository.lock_read()
1360
self.control_files.lock_read()
1362
self.repository.unlock()
1366
# TODO: test for failed two phase locks. This is known broken.
1368
self.control_files.unlock()
1370
self.repository.unlock()
1371
if not self.control_files.is_locked():
1372
# we just released the lock
1373
self._clear_cached_state()
1375
def peek_lock_mode(self):
1376
if self.control_files._lock_count == 0:
1379
return self.control_files._lock_mode
1381
def get_physical_lock_status(self):
1382
return self.control_files.get_physical_lock_status()
1385
def print_file(self, file, revision_id):
1386
"""See Branch.print_file."""
1387
return self.repository.print_file(file, revision_id)
1389
def _write_revision_history(self, history):
1390
"""Factored out of set_revision_history.
1392
This performs the actual writing to disk.
1393
It is intended to be called by BzrBranch5.set_revision_history."""
1394
self.control_files.put_bytes(
1395
'revision-history', '\n'.join(history))
1398
def set_revision_history(self, rev_history):
1399
"""See Branch.set_revision_history."""
1400
if 'evil' in debug.debug_flags:
1401
mutter_callsite(3, "set_revision_history scales with history.")
1402
self._clear_cached_state()
1403
self._write_revision_history(rev_history)
1404
self._cache_revision_history(rev_history)
1405
for hook in Branch.hooks['set_rh']:
1406
hook(self, rev_history)
1409
def set_last_revision_info(self, revno, revision_id):
1410
"""Set the last revision of this branch.
1412
The caller is responsible for checking that the revno is correct
1413
for this revision id.
1415
It may be possible to set the branch last revision to an id not
1416
present in the repository. However, branches can also be
1417
configured to check constraints on history, in which case this may not
1420
history = self._lefthand_history(revision_id)
1421
assert len(history) == revno, '%d != %d' % (len(history), revno)
1422
self.set_revision_history(history)
1424
def _gen_revision_history(self):
1425
history = self.control_files.get('revision-history').read().split('\n')
1426
if history[-1:] == ['']:
1427
# There shouldn't be a trailing newline, but just in case.
1431
def _lefthand_history(self, revision_id, last_rev=None,
1433
if 'evil' in debug.debug_flags:
1434
mutter_callsite(4, "_lefthand_history scales with history.")
1435
# stop_revision must be a descendant of last_revision
1436
stop_graph = self.repository.get_revision_graph(revision_id)
1437
if (last_rev is not None and last_rev != _mod_revision.NULL_REVISION
1438
and last_rev not in stop_graph):
1439
# our previous tip is not merged into stop_revision
1440
raise errors.DivergedBranches(self, other_branch)
1441
# make a new revision history from the graph
1442
current_rev_id = revision_id
1444
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1445
new_history.append(current_rev_id)
1446
current_rev_id_parents = stop_graph[current_rev_id]
1448
current_rev_id = current_rev_id_parents[0]
1450
current_rev_id = None
1451
new_history.reverse()
1455
def generate_revision_history(self, revision_id, last_rev=None,
1457
"""Create a new revision history that will finish with revision_id.
1459
:param revision_id: the new tip to use.
1460
:param last_rev: The previous last_revision. If not None, then this
1461
must be a ancestory of revision_id, or DivergedBranches is raised.
1462
:param other_branch: The other branch that DivergedBranches should
1463
raise with respect to.
1465
self.set_revision_history(self._lefthand_history(revision_id,
1466
last_rev, other_branch))
1469
def update_revisions(self, other, stop_revision=None, overwrite=False):
1470
"""See Branch.update_revisions."""
1473
other_last_revno, other_last_revision = other.last_revision_info()
1474
if stop_revision is None:
1475
stop_revision = other_last_revision
1476
if _mod_revision.is_null(stop_revision):
1477
# if there are no commits, we're done.
1479
# whats the current last revision, before we fetch [and change it
1481
last_rev = _mod_revision.ensure_null(self.last_revision())
1482
# we fetch here so that we don't process data twice in the common
1483
# case of having something to pull, and so that the check for
1484
# already merged can operate on the just fetched graph, which will
1485
# be cached in memory.
1486
self.fetch(other, stop_revision)
1487
# Check to see if one is an ancestor of the other
1489
heads = self.repository.get_graph().heads([stop_revision,
1491
if heads == set([last_rev]):
1492
# The current revision is a decendent of the target,
1495
elif heads == set([stop_revision, last_rev]):
1496
# These branches have diverged
1497
raise errors.DivergedBranches(self, other)
1498
assert heads == set([stop_revision])
1499
if other_last_revision == stop_revision:
1500
self.set_last_revision_info(other_last_revno,
1501
other_last_revision)
1503
# TODO: jam 2007-11-29 Is there a way to determine the
1504
# revno without searching all of history??
1506
self.generate_revision_history(stop_revision)
1508
self.generate_revision_history(stop_revision,
1509
last_rev=last_rev, other_branch=other)
1513
def basis_tree(self):
1514
"""See Branch.basis_tree."""
1515
return self.repository.revision_tree(self.last_revision())
1518
def pull(self, source, overwrite=False, stop_revision=None,
1519
_hook_master=None, run_hooks=True, possible_transports=None):
1522
:param _hook_master: Private parameter - set the branch to
1523
be supplied as the master to push hooks.
1524
:param run_hooks: Private parameter - if false, this branch
1525
is being called because it's the master of the primary branch,
1526
so it should not run its hooks.
1528
result = PullResult()
1529
result.source_branch = source
1530
result.target_branch = self
1533
result.old_revno, result.old_revid = self.last_revision_info()
1534
self.update_revisions(source, stop_revision, overwrite=overwrite)
1535
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
1536
result.new_revno, result.new_revid = self.last_revision_info()
1538
result.master_branch = _hook_master
1539
result.local_branch = self
1541
result.master_branch = self
1542
result.local_branch = None
1544
for hook in Branch.hooks['post_pull']:
1550
def _get_parent_location(self):
1551
_locs = ['parent', 'pull', 'x-pull']
1554
return self.control_files.get(l).read().strip('\n')
1560
def push(self, target, overwrite=False, stop_revision=None,
1561
_override_hook_source_branch=None):
1564
This is the basic concrete implementation of push()
1566
:param _override_hook_source_branch: If specified, run
1567
the hooks passing this Branch as the source, rather than self.
1568
This is for use of RemoteBranch, where push is delegated to the
1569
underlying vfs-based Branch.
1571
# TODO: Public option to disable running hooks - should be trivial but
1575
result = self._push_with_bound_branches(target, overwrite,
1577
_override_hook_source_branch=_override_hook_source_branch)
1582
def _push_with_bound_branches(self, target, overwrite,
1584
_override_hook_source_branch=None):
1585
"""Push from self into target, and into target's master if any.
1587
This is on the base BzrBranch class even though it doesn't support
1588
bound branches because the *target* might be bound.
1591
if _override_hook_source_branch:
1592
result.source_branch = _override_hook_source_branch
1593
for hook in Branch.hooks['post_push']:
1596
bound_location = target.get_bound_location()
1597
if bound_location and target.base != bound_location:
1598
# there is a master branch.
1600
# XXX: Why the second check? Is it even supported for a branch to
1601
# be bound to itself? -- mbp 20070507
1602
master_branch = target.get_master_branch()
1603
master_branch.lock_write()
1605
# push into the master from this branch.
1606
self._basic_push(master_branch, overwrite, stop_revision)
1607
# and push into the target branch from this. Note that we push from
1608
# this branch again, because its considered the highest bandwidth
1610
result = self._basic_push(target, overwrite, stop_revision)
1611
result.master_branch = master_branch
1612
result.local_branch = target
1616
master_branch.unlock()
1619
result = self._basic_push(target, overwrite, stop_revision)
1620
# TODO: Why set master_branch and local_branch if there's no
1621
# binding? Maybe cleaner to just leave them unset? -- mbp
1623
result.master_branch = target
1624
result.local_branch = None
1628
def _basic_push(self, target, overwrite, stop_revision):
1629
"""Basic implementation of push without bound branches or hooks.
1631
Must be called with self read locked and target write locked.
1633
result = PushResult()
1634
result.source_branch = self
1635
result.target_branch = target
1636
result.old_revno, result.old_revid = target.last_revision_info()
1638
target.update_revisions(self, stop_revision)
1639
except DivergedBranches:
1643
target.set_revision_history(self.revision_history())
1644
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
1645
result.new_revno, result.new_revid = target.last_revision_info()
1648
def get_parent(self):
1649
"""See Branch.get_parent."""
1651
assert self.base[-1] == '/'
1652
parent = self._get_parent_location()
1655
# This is an old-format absolute path to a local branch
1656
# turn it into a url
1657
if parent.startswith('/'):
1658
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1660
return urlutils.join(self.base[:-1], parent)
1661
except errors.InvalidURLJoin, e:
1662
raise errors.InaccessibleParent(parent, self.base)
1664
def set_push_location(self, location):
1665
"""See Branch.set_push_location."""
1666
self.get_config().set_user_option(
1667
'push_location', location,
1668
store=_mod_config.STORE_LOCATION_NORECURSE)
1671
def set_parent(self, url):
1672
"""See Branch.set_parent."""
1673
# TODO: Maybe delete old location files?
1674
# URLs should never be unicode, even on the local fs,
1675
# FIXUP this and get_parent in a future branch format bump:
1676
# read and rewrite the file, and have the new format code read
1677
# using .get not .get_utf8. RBC 20060125
1679
if isinstance(url, unicode):
1681
url = url.encode('ascii')
1682
except UnicodeEncodeError:
1683
raise errors.InvalidURL(url,
1684
"Urls must be 7-bit ascii, "
1685
"use bzrlib.urlutils.escape")
1686
url = urlutils.relative_url(self.base, url)
1687
self._set_parent_location(url)
1689
def _set_parent_location(self, url):
1691
self.control_files._transport.delete('parent')
1693
assert isinstance(url, str)
1694
self.control_files.put_bytes('parent', url + '\n')
1697
class BzrBranch5(BzrBranch):
1698
"""A format 5 branch. This supports new features over plain branches.
1700
It has support for a master_branch which is the data for bound branches.
1708
super(BzrBranch5, self).__init__(_format=_format,
1709
_control_files=_control_files,
1711
_repository=_repository)
1714
def pull(self, source, overwrite=False, stop_revision=None,
1715
run_hooks=True, possible_transports=None):
1716
"""Pull from source into self, updating my master if any.
1718
:param run_hooks: Private parameter - if false, this branch
1719
is being called because it's the master of the primary branch,
1720
so it should not run its hooks.
1722
bound_location = self.get_bound_location()
1723
master_branch = None
1724
if bound_location and source.base != bound_location:
1725
# not pulling from master, so we need to update master.
1726
master_branch = self.get_master_branch(possible_transports)
1727
master_branch.lock_write()
1730
# pull from source into master.
1731
master_branch.pull(source, overwrite, stop_revision,
1733
return super(BzrBranch5, self).pull(source, overwrite,
1734
stop_revision, _hook_master=master_branch,
1735
run_hooks=run_hooks)
1738
master_branch.unlock()
1740
def get_bound_location(self):
1742
return self.control_files.get_utf8('bound').read()[:-1]
1743
except errors.NoSuchFile:
1747
def get_master_branch(self, possible_transports=None):
1748
"""Return the branch we are bound to.
1750
:return: Either a Branch, or None
1752
This could memoise the branch, but if thats done
1753
it must be revalidated on each new lock.
1754
So for now we just don't memoise it.
1755
# RBC 20060304 review this decision.
1757
bound_loc = self.get_bound_location()
1761
return Branch.open(bound_loc,
1762
possible_transports=possible_transports)
1763
except (errors.NotBranchError, errors.ConnectionError), e:
1764
raise errors.BoundBranchConnectionFailure(
1768
def set_bound_location(self, location):
1769
"""Set the target where this branch is bound to.
1771
:param location: URL to the target branch
1774
self.control_files.put_utf8('bound', location+'\n')
1777
self.control_files._transport.delete('bound')
1783
def bind(self, other):
1784
"""Bind this branch to the branch other.
1786
This does not push or pull data between the branches, though it does
1787
check for divergence to raise an error when the branches are not
1788
either the same, or one a prefix of the other. That behaviour may not
1789
be useful, so that check may be removed in future.
1791
:param other: The branch to bind to
1794
# TODO: jam 20051230 Consider checking if the target is bound
1795
# It is debatable whether you should be able to bind to
1796
# a branch which is itself bound.
1797
# Committing is obviously forbidden,
1798
# but binding itself may not be.
1799
# Since we *have* to check at commit time, we don't
1800
# *need* to check here
1802
# we want to raise diverged if:
1803
# last_rev is not in the other_last_rev history, AND
1804
# other_last_rev is not in our history, and do it without pulling
1806
self.set_bound_location(other.base)
1810
"""If bound, unbind"""
1811
return self.set_bound_location(None)
1814
def update(self, possible_transports=None):
1815
"""Synchronise this branch with the master branch if any.
1817
:return: None or the last_revision that was pivoted out during the
1820
master = self.get_master_branch(possible_transports)
1821
if master is not None:
1822
old_tip = _mod_revision.ensure_null(self.last_revision())
1823
self.pull(master, overwrite=True)
1824
if self.repository.get_graph().is_ancestor(old_tip,
1825
_mod_revision.ensure_null(self.last_revision())):
1831
class BzrBranchExperimental(BzrBranch5):
1832
"""Bzr experimental branch format
1835
- a revision-history file.
1837
- a lock dir guarding the branch itself
1838
- all of this stored in a branch/ subdirectory
1839
- works with shared repositories.
1840
- a tag dictionary in the branch
1842
This format is new in bzr 0.15, but shouldn't be used for real data,
1845
This class acts as it's own BranchFormat.
1848
_matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1851
def get_format_string(cls):
1852
"""See BranchFormat.get_format_string()."""
1853
return "Bazaar-NG branch format experimental\n"
1856
def get_format_description(cls):
1857
"""See BranchFormat.get_format_description()."""
1858
return "Experimental branch format"
1861
def get_reference(cls, a_bzrdir):
1862
"""Get the target reference of the branch in a_bzrdir.
1864
format probing must have been completed before calling
1865
this method - it is assumed that the format of the branch
1866
in a_bzrdir is correct.
1868
:param a_bzrdir: The bzrdir to get the branch data from.
1869
:return: None if the branch is not a reference branch.
1874
def set_reference(self, a_bzrdir, to_branch):
1875
"""Set the target reference of the branch in a_bzrdir.
1877
format probing must have been completed before calling
1878
this method - it is assumed that the format of the branch
1879
in a_bzrdir is correct.
1881
:param a_bzrdir: The bzrdir to set the branch reference for.
1882
:param to_branch: branch that the checkout is to reference
1884
raise NotImplementedError(self.set_reference)
1887
def _initialize_control_files(cls, a_bzrdir, utf8_files, lock_filename,
1889
branch_transport = a_bzrdir.get_branch_transport(cls)
1890
control_files = lockable_files.LockableFiles(branch_transport,
1891
lock_filename, lock_class)
1892
control_files.create_lock()
1893
control_files.lock_write()
1895
for filename, content in utf8_files:
1896
control_files.put_utf8(filename, content)
1898
control_files.unlock()
1901
def initialize(cls, a_bzrdir):
1902
"""Create a branch of this format in a_bzrdir."""
1903
utf8_files = [('format', cls.get_format_string()),
1904
('revision-history', ''),
1905
('branch-name', ''),
1908
cls._initialize_control_files(a_bzrdir, utf8_files,
1909
'lock', lockdir.LockDir)
1910
return cls.open(a_bzrdir, _found=True)
1913
def open(cls, a_bzrdir, _found=False):
1914
"""Return the branch object for a_bzrdir
1916
_found is a private parameter, do not use it. It is used to indicate
1917
if format probing has already be done.
1920
format = BranchFormat.find_format(a_bzrdir)
1921
assert format.__class__ == cls
1922
transport = a_bzrdir.get_branch_transport(None)
1923
control_files = lockable_files.LockableFiles(transport, 'lock',
1925
return cls(_format=cls,
1926
_control_files=control_files,
1928
_repository=a_bzrdir.find_repository())
1931
def is_supported(cls):
1934
def _make_tags(self):
1935
return BasicTags(self)
1938
def supports_tags(cls):
1942
BranchFormat.register_format(BzrBranchExperimental)
1945
class BzrBranch6(BzrBranch5):
1948
def last_revision_info(self):
1949
revision_string = self.control_files.get('last-revision').read()
1950
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1951
revision_id = cache_utf8.get_cached_utf8(revision_id)
1953
return revno, revision_id
1955
def last_revision(self):
1956
"""Return last revision id, or None"""
1957
revision_id = self.last_revision_info()[1]
1960
def _write_last_revision_info(self, revno, revision_id):
1961
"""Simply write out the revision id, with no checks.
1963
Use set_last_revision_info to perform this safely.
1965
Does not update the revision_history cache.
1966
Intended to be called by set_last_revision_info and
1967
_write_revision_history.
1969
if revision_id is None:
1970
revision_id = 'null:'
1971
out_string = '%d %s\n' % (revno, revision_id)
1972
self.control_files.put_bytes('last-revision', out_string)
1975
def set_last_revision_info(self, revno, revision_id):
1976
if self._get_append_revisions_only():
1977
self._check_history_violation(revision_id)
1978
self._write_last_revision_info(revno, revision_id)
1979
self._clear_cached_state()
1981
def _check_history_violation(self, revision_id):
1982
last_revision = _mod_revision.ensure_null(self.last_revision())
1983
if _mod_revision.is_null(last_revision):
1985
if last_revision not in self._lefthand_history(revision_id):
1986
raise errors.AppendRevisionsOnlyViolation(self.base)
1988
def _gen_revision_history(self):
1989
"""Generate the revision history from last revision
1991
history = list(self.repository.iter_reverse_revision_history(
1992
self.last_revision()))
1996
def _write_revision_history(self, history):
1997
"""Factored out of set_revision_history.
1999
This performs the actual writing to disk, with format-specific checks.
2000
It is intended to be called by BzrBranch5.set_revision_history.
2002
if len(history) == 0:
2003
last_revision = 'null:'
2005
if history != self._lefthand_history(history[-1]):
2006
raise errors.NotLefthandHistory(history)
2007
last_revision = history[-1]
2008
if self._get_append_revisions_only():
2009
self._check_history_violation(last_revision)
2010
self._write_last_revision_info(len(history), last_revision)
2013
def _set_parent_location(self, url):
2014
"""Set the parent branch"""
2015
self._set_config_location('parent_location', url, make_relative=True)
2018
def _get_parent_location(self):
2019
"""Set the parent branch"""
2020
return self._get_config_location('parent_location')
2022
def set_push_location(self, location):
2023
"""See Branch.set_push_location."""
2024
self._set_config_location('push_location', location)
2026
def set_bound_location(self, location):
2027
"""See Branch.set_push_location."""
2029
config = self.get_config()
2030
if location is None:
2031
if config.get_user_option('bound') != 'True':
2034
config.set_user_option('bound', 'False', warn_masked=True)
2037
self._set_config_location('bound_location', location,
2039
config.set_user_option('bound', 'True', warn_masked=True)
2042
def _get_bound_location(self, bound):
2043
"""Return the bound location in the config file.
2045
Return None if the bound parameter does not match"""
2046
config = self.get_config()
2047
config_bound = (config.get_user_option('bound') == 'True')
2048
if config_bound != bound:
2050
return self._get_config_location('bound_location', config=config)
2052
def get_bound_location(self):
2053
"""See Branch.set_push_location."""
2054
return self._get_bound_location(True)
2056
def get_old_bound_location(self):
2057
"""See Branch.get_old_bound_location"""
2058
return self._get_bound_location(False)
2060
def set_append_revisions_only(self, enabled):
2065
self.get_config().set_user_option('append_revisions_only', value,
2068
def _get_append_revisions_only(self):
2069
value = self.get_config().get_user_option('append_revisions_only')
2070
return value == 'True'
2072
def _synchronize_history(self, destination, revision_id):
2073
"""Synchronize last revision and revision history between branches.
2075
This version is most efficient when the destination is also a
2076
BzrBranch6, but works for BzrBranch5, as long as the destination's
2077
repository contains all the lefthand ancestors of the intended
2078
last_revision. If not, set_last_revision_info will fail.
2080
:param destination: The branch to copy the history into
2081
:param revision_id: The revision-id to truncate history at. May
2082
be None to copy complete history.
2084
source_revno, source_revision_id = self.last_revision_info()
2085
if revision_id is None:
2086
revno, revision_id = source_revno, source_revision_id
2087
elif source_revision_id == revision_id:
2088
# we know the revno without needing to walk all of history
2089
revno = source_revno
2091
# To figure out the revno for a random revision, we need to build
2092
# the revision history, and count its length.
2093
# We don't care about the order, just how long it is.
2094
# Alternatively, we could start at the current location, and count
2095
# backwards. But there is no guarantee that we will find it since
2096
# it may be a merged revision.
2097
revno = len(list(self.repository.iter_reverse_revision_history(
2099
destination.set_last_revision_info(revno, revision_id)
2101
def _make_tags(self):
2102
return BasicTags(self)
2105
######################################################################
2106
# results of operations
2109
class _Result(object):
2111
def _show_tag_conficts(self, to_file):
2112
if not getattr(self, 'tag_conflicts', None):
2114
to_file.write('Conflicting tags:\n')
2115
for name, value1, value2 in self.tag_conflicts:
2116
to_file.write(' %s\n' % (name, ))
2119
class PullResult(_Result):
2120
"""Result of a Branch.pull operation.
2122
:ivar old_revno: Revision number before pull.
2123
:ivar new_revno: Revision number after pull.
2124
:ivar old_revid: Tip revision id before pull.
2125
:ivar new_revid: Tip revision id after pull.
2126
:ivar source_branch: Source (local) branch object.
2127
:ivar master_branch: Master branch of the target, or None.
2128
:ivar target_branch: Target/destination branch object.
2132
# DEPRECATED: pull used to return the change in revno
2133
return self.new_revno - self.old_revno
2135
def report(self, to_file):
2136
if self.old_revid == self.new_revid:
2137
to_file.write('No revisions to pull.\n')
2139
to_file.write('Now on revision %d.\n' % self.new_revno)
2140
self._show_tag_conficts(to_file)
2143
class PushResult(_Result):
2144
"""Result of a Branch.push operation.
2146
:ivar old_revno: Revision number before push.
2147
:ivar new_revno: Revision number after push.
2148
:ivar old_revid: Tip revision id before push.
2149
:ivar new_revid: Tip revision id after push.
2150
:ivar source_branch: Source branch object.
2151
:ivar master_branch: Master branch of the target, or None.
2152
:ivar target_branch: Target/destination branch object.
2156
# DEPRECATED: push used to return the change in revno
2157
return self.new_revno - self.old_revno
2159
def report(self, to_file):
2160
"""Write a human-readable description of the result."""
2161
if self.old_revid == self.new_revid:
2162
to_file.write('No new revisions to push.\n')
2164
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2165
self._show_tag_conficts(to_file)
2168
class BranchCheckResult(object):
2169
"""Results of checking branch consistency.
2174
def __init__(self, branch):
2175
self.branch = branch
2177
def report_results(self, verbose):
2178
"""Report the check results via trace.note.
2180
:param verbose: Requests more detailed display of what was checked,
2183
note('checked branch %s format %s',
2185
self.branch._format)
2188
class Converter5to6(object):
2189
"""Perform an in-place upgrade of format 5 to format 6"""
2191
def convert(self, branch):
2192
# Data for 5 and 6 can peacefully coexist.
2193
format = BzrBranchFormat6()
2194
new_branch = format.open(branch.bzrdir, _found=True)
2196
# Copy source data into target
2197
new_branch.set_last_revision_info(*branch.last_revision_info())
2198
new_branch.set_parent(branch.get_parent())
2199
new_branch.set_bound_location(branch.get_bound_location())
2200
new_branch.set_push_location(branch.get_push_location())
2202
# New branch has no tags by default
2203
new_branch.tags._set_tag_dict({})
2205
# Copying done; now update target format
2206
new_branch.control_files.put_utf8('format',
2207
format.get_format_string())
2209
# Clean up old files
2210
new_branch.control_files._transport.delete('revision-history')
2212
branch.set_parent(None)
2215
branch.set_bound_location(None)
added
removed
bzrlib/branch.py
